/**
 * @file   ptpd_dep.h
 * @date   Tue Jul 20 16:18:39 2010
 * 
 * @brief  External definitions for inclusion elsewhere.
 * 
 * 
 */

#ifndef PTPD_DEP_H
#define PTPD_DEP_H

#include<stdlib.h>
#include<stdio.h>
#include<string.h>
#include<unistd.h>
#include<errno.h>
#include<signal.h>
#include<fcntl.h>
#include<sys/stat.h>
#include<time.h>
#include<sys/time.h>
#include<sys/timex.h>
#include<sys/socket.h>
#include<sys/select.h>
#include<sys/ioctl.h>
#include<arpa/inet.h>
#include<stdarg.h>
#include<syslog.h>
#include<limits.h>

/* system messages */
#define ERROR(x, ...)  message(LOG_ERR, x, ##__VA_ARGS__)
#define PERROR(x, ...) message(LOG_ERR, x ": %m\n", ##__VA_ARGS__)
#define NOTIFY(x, ...) message(LOG_NOTICE, x, ##__VA_ARGS__)
#define INFO(x, ...)   message(LOG_INFO, x, ##__VA_ARGS__)

/* debug messages */
#ifdef PTPD_DBGV
#define PTPD_DBG
#define DBGV(x, ...) message(LOG_DEBUG, x, ##__VA_ARGS__)
#else
#define DBGV(x, ...)
#endif

#ifdef PTPD_DBG
#define DBG(x, ...) message(LOG_DEBUG, x, ##__VA_ARGS__) 
#else
#define DBG(x, ...)
#endif

/* endian corrections */
#if defined(PTPD_MSBF)
#define shift8(x,y)   ( (x) << ((3-y)<<3) )
#define shift16(x,y)  ( (x) << ((1-y)<<4) )
#elif defined(PTPD_LSBF)
#define shift8(x,y)   ( (x) << ((y)<<3) )
#define shift16(x,y)  ( (x) << ((y)<<4) )
#endif

#define flip16(x) htons(x)
#define flip32(x) htonl(x)

/* i don't know any target platforms that do not have htons and htonl,
   but here are generic funtions just in case */
/*
#if defined(PTPD_MSBF)
#define flip16(x) (x)
#define flip32(x) (x)
#elif defined(PTPD_LSBF)
static inline Integer16 flip16(Integer16 x)
{
   return (((x) >> 8) & 0x00ff) | (((x) << 8) & 0xff00);
}

static inline Integer32 flip32(x)
{
  return (((x) >> 24) & 0x000000ff) | (((x) >> 8 ) & 0x0000ff00) |
         (((x) << 8 ) & 0x00ff0000) | (((x) << 24) & 0xff000000);
}
#endif
*/

/* bit array manipulation */
#define getFlag(x,y)  !!( *(UInteger8*)((x)+((y)<8?1:0)) &   (1<<((y)<8?(y):(y)-8)) )
#define setFlag(x,y)    ( *(UInteger8*)((x)+((y)<8?1:0)) |=   1<<((y)<8?(y):(y)-8)  )
#define clearFlag(x,y)  ( *(UInteger8*)((x)+((y)<8?1:0)) &= ~(1<<((y)<8?(y):(y)-8)) )


/* msg.c */
Boolean	msgPeek(void *, ssize_t);
void	msgUnpackHeader(void *, MsgHeader *);
void	msgUnpackSync(void *, MsgSync *);
void	msgUnpackDelayReq(void *, MsgDelayReq *);
void	msgUnpackFollowUp(void *, MsgFollowUp *);
void	msgUnpackDelayResp(void *, MsgDelayResp *);
void	msgUnpackManagement(void *, MsgManagement *);
UInteger8 msgUnloadManagement(void *, MsgManagement *, PtpClock *, RunTimeOpts *);
void	msgUnpackManagementPayload(void *buf, MsgManagement * manage);
void	msgPackHeader(void *, PtpClock *);
void	msgPackSync(void *, Boolean, TimeRepresentation *, PtpClock *);
void	msgPackDelayReq(void *, Boolean, TimeRepresentation *, PtpClock *);
void	msgPackFollowUp(void *, UInteger16, TimeRepresentation *, PtpClock *);
void	msgPackDelayResp(void *, MsgHeader *, TimeRepresentation *, PtpClock *);
UInteger16 msgPackManagement(void *, MsgManagement *, PtpClock *);
UInteger16 msgPackManagementResponse(void *, MsgHeader *, MsgManagement *, PtpClock *);

/* net.c */
/* linux API dependent */
Boolean	netInit(NetPath *, RunTimeOpts *, PtpClock *);
Boolean	netShutdown(NetPath *);
int	netSelect(TimeInternal *, NetPath *);
ssize_t	netRecvEvent(Octet *, TimeInternal *, NetPath *);
ssize_t	netRecvGeneral(Octet *, NetPath *);
ssize_t	netSendEvent(Octet *, UInteger16, NetPath *);
ssize_t	netSendGeneral(Octet *, UInteger16, NetPath *);

/* servo.c */
void	initClock(RunTimeOpts *, PtpClock *);
void 
updateDelay(TimeInternal *, TimeInternal *,
    one_way_delay_filter *, RunTimeOpts *, PtpClock *);
void 
updateOffset(TimeInternal *, TimeInternal *,
    offset_from_master_filter *, RunTimeOpts *, PtpClock *);
void	updateClock(RunTimeOpts *, PtpClock *);

/* startup.c */
/* unix API dependent */
int logToFile();
int recordToFile();
PtpClock *ptpdStartup(int, char **, Integer16 *, RunTimeOpts *);
void	ptpdShutdown(void);

/* sys.c */
char *translatePortState(PtpClock *ptpClock);
/* unix API dependent */
void	message(int priority, const char *format, ...);
void	displayStats(RunTimeOpts *, PtpClock *);
Boolean	nanoSleep(TimeInternal *);
void	getTime(TimeInternal *);
void	setTime(TimeInternal *);
UInteger16 getRand(UInteger32 *);
Boolean	adjFreq(Integer32);

/* timer.c */
void	initTimer(void);
void	timerUpdate(IntervalTimer *);
void	timerStop(UInteger16, IntervalTimer *);
void	timerStart(UInteger16, UInteger16, IntervalTimer *);
Boolean	timerExpired(UInteger16, IntervalTimer *);


#endif