/**
 * @file   constants.h
 * @date   Wed Jun 23 10:02:39 2010
 * 
 * @brief  All of the defined constants for the daemon.
 * 
 * 
 */

#ifndef CONSTANTS_H
#define CONSTANTS_H

/* implementation specific constants */
#define MANUFACTURER_ID \
  "PTPD;1.2\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"

#define DEFAULT_SYNC_INTERVAL        1
#define DEFAULT_UTC_OFFSET           0
#define DEFAULT_CLOCK_VARIANCE       (-4000)
#define DEFAULT_CLOCK_STRATUM        4
#define DEFAULT_INBOUND_LATENCY      0	/* in nsec */
#define DEFAULT_OUTBOUND_LATENCY     0	/* in nsec */
#define DEFAULT_NO_RESET_CLOCK       FALSE
#define DEFAULT_AP                   10
#define DEFAULT_AI                   1000
#define DEFAULT_DELAY_S              6
#define DEFAULT_MAX_FOREIGN_RECORDS  5

/* features, only change to refelect changes in implementation */
#define CLOCK_FOLLOWUP    TRUE
#define INITIALIZABLE     TRUE
#define BURST_ENABLED     FALSE
#define EXTERNAL_TIMING   FALSE
#define BOUNDARY_CLOCK    FALSE
#define NUMBER_PORTS      1
#define VERSION_PTP       1
#define VERSION_NETWORK   1

/* spec defined constants  */
#define DEFAULT_PTP_DOMAIN_NAME      "_DFLT\0\0\0\0\0\0\0\0\0\0\0"
#define ALTERNATE_PTP_DOMAIN1_NAME   "_ALT1\0\0\0\0\0\0\0\0\0\0\0"
#define ALTERNATE_PTP_DOMAIN2_NAME   "_ALT2\0\0\0\0\0\0\0\0\0\0\0"
#define ALTERNATE_PTP_DOMAIN3_NAME   "_ALT3\0\0\0\0\0\0\0\0\0\0\0"

#define IDENTIFIER_ATOM   "ATOM"
#define IDENTIFIER_GPS    "GPS\0"
#define IDENTIFIER_NTP    "NTP\0"
#define IDENTIFIER_HAND   "HAND"
#define IDENTIFIER_INIT   "INIT"
#define IDENTIFIER_DFLT   "DFLT"

/* ptp constants */
#define PTP_UUID_LENGTH                     6
#define PTP_CODE_STRING_LENGTH              4
#define PTP_SUBDOMAIN_NAME_LENGTH           16
#define PTP_MAX_MANAGEMENT_PAYLOAD_SIZE     90
/* no support for intervals less than one */
#define PTP_SYNC_INTERVAL_TIMEOUT(x)        (1<<((x)<0?1:(x)))
#define PTP_SYNC_RECEIPT_TIMEOUT(x)         (10*(1<<((x)<0?0:(x))))
#define PTP_DELAY_REQ_INTERVAL              30
#define PTP_FOREIGN_MASTER_THRESHOLD        2
#define PTP_FOREIGN_MASTER_TIME_WINDOW(x)   (4*(1<<((x)<0?0:(x))))
#define PTP_RANDOMIZING_SLOTS               18
#define PTP_LOG_VARIANCE_THRESHOLD          256
#define PTP_LOG_VARIANCE_HYSTERESIS         128
/* used in spec but not named */
#define MANUFACTURER_ID_LENGTH              48

/* ptp data enums */
enum {
	PTP_CLOSED = 0, PTP_ETHER, PTP_FFBUS = 4,
	PTP_PROFIBUS, PTP_LON, PTP_DNET,
	PTP_SDS, PTP_CONTROLNET, PTP_CANOPEN,
	PTP_IEEE1394 = 243, PTP_IEEE802_11A, PTP_IEEE_WIRELESS,
	PTP_INFINIBAND, PTP_BLUETOOTH, PTP_IEEE802_15_1,
	PTP_IEEE1451_2, PTP_IEEE1451_5, PTP_USB,
	PTP_ISA, PTP_PCI, PTP_VXI, PTP_DEFAULT
};

enum {
	PTP_INITIALIZING = 0, PTP_FAULTY, PTP_DISABLED,
	PTP_LISTENING, PTP_PRE_MASTER, PTP_MASTER,
	PTP_PASSIVE, PTP_UNCALIBRATED, PTP_SLAVE
};

enum {
	PTP_SYNC_MESSAGE = 0, PTP_DELAY_REQ_MESSAGE, PTP_FOLLOWUP_MESSAGE,
	PTP_DELAY_RESP_MESSAGE, PTP_MANAGEMENT_MESSAGE,
	PTP_SYNC_MESSAGE_BURST, PTP_DELAY_REQ_MESSAGE_BURST
};

enum {
	PTP_LI_61 = 0, PTP_LI_59, PTP_BOUNDARY_CLOCK,
	PTP_ASSIST, PTP_EXT_SYNC, PARENT_STATS, PTP_SYNC_BURST
};

enum {
	PTP_MM_NULL = 0, PTP_MM_OBTAIN_IDENTITY, PTP_MM_CLOCK_IDENTITY,
	PTP_MM_INITIALIZE_CLOCK, PTP_MM_SET_SUBDOMAIN,
	PTP_MM_CLEAR_DESIGNATED_PREFERRED_MASTER,
	PTP_MM_SET_DESIGNATED_PREFERRED_MASTER,
	PTP_MM_GET_DEFAULT_DATA_SET, PTP_MM_DEFAULT_DATA_SET,
	PTP_MM_UPDATE_DEFAULT_DATA_SET, PTP_MM_GET_CURRENT_DATA_SET,
	PTP_MM_CURRENT_DATA_SET, PTP_MM_GET_PARENT_DATA_SET,
	PTP_MM_PARENT_DATA_SET, PTP_MM_GET_PORT_DATA_SET,
	PTP_MM_PORT_DATA_SET, PTP_MM_GET_GLOBAL_TIME_DATA_SET,
	PTP_MM_GLOBAL_TIME_DATA_SET, PTP_MM_UPDATE_GLOBAL_TIME_PROPERTIES,
	PTP_MM_GOTO_FAULTY_STATE, PTP_MM_GET_FOREIGN_DATA_SET,
	PTP_MM_FOREIGN_DATA_SET, PTP_MM_SET_SYNC_INTERVAL,
	PTP_MM_DISABLE_PORT, PTP_MM_ENABLE_PORT,
	PTP_MM_DISABLE_BURST, PTP_MM_ENABLE_BURST, PTP_MM_SET_TIME
};

/* enum used by this implementation */
enum {
	SYNC_RECEIPT_TIMER = 0, SYNC_INTERVAL_TIMER, QUALIFICATION_TIMER,
	TIMER_ARRAY_SIZE		/* these two are non-spec */
};

#endif