Skip to content

P
PPSi
Commit d341232c authored by Alessandro Rubini's avatar Alessandro Rubini Committed by Aurelio Colosimo
Browse files
Options

include: checkpatch changes (and tabify 1588 structures) 

This only applies checkpatch stuff, but I took the freedom to
add tabs to the stuctures in ieee1588_types.h, to make them more
readable.
Signed-off-by: Alessandro Rubini's avatarAlessandro Rubini <rubini@gnudd.com>
parent 8ee159a4
Hide whitespace changes
Inline Side-by-side
Showing with 140 additions and 146 deletions
include/pptp/constants.h
View file @ d341232c
......@@ -35,11 +35,11 @@
#define PP_DEFAULT_MAX_FOREIGN_RECORDS 5
#define PP_DEFAULT_PARENTS_STATS 0
#define PP_TIMER_PDELAYREQ_INTERVAL 0
#define PP_TIMER_DELAYREQ_INTERVAL 1
#define PP_TIMER_PDELAYREQ_INTERVAL 0
#define PP_TIMER_DELAYREQ_INTERVAL 1
#define PP_TIMER_SYNC_INTERVAL 2
#define PP_TIMER_ANNOUNCE_RECEIPT 3
#define PP_TIMER_ANNOUNCE_INTERVAL 4
#define PP_TIMER_ANNOUNCE_RECEIPT 3
#define PP_TIMER_ANNOUNCE_INTERVAL 4
#define PP_TIMER_ARRAY_SIZE 5
#define PP_TWO_STEP_FLAG 2
......@@ -66,7 +66,7 @@
#define PP_FLAG_FIELD_LENGTH 2
#define PP_PACKET_SIZE 300
#define PP_EVENT_PORT 319
#define PP_GENERAL_PORT 320
#define PP_GENERAL_PORT 320
#define PP_DEFAULT_DOMAIN_ADDRESS "224.0.1.129"
#define PP_PEER_DOMAIN_ADDRESS "224.0.0.107"
#define PP_MM_STARTING_BOUNDARY_HOPS 0x7fff
......
include/pptp/diag.h
View file @ d341232c
......@@ -18,11 +18,11 @@ extern void pp_diag_error(struct pp_instance *ppi, int err);
extern void pp_diag_error_str2(struct pp_instance *ppi, char *s1, char *s2);
extern void pp_diag_fatal(struct pp_instance *ppi, char *s1, char *s2);
extern void pp_diag_printf(struct pp_instance *ppi, char *fmt, ...)
__attribute__((format(printf,2,3)));
__attribute__((format(printf, 2, 3)));
/* Our printf, that is implemented internally */
extern int pp_printf(const char *fmt, ...)
__attribute__((format(printf,1,2)));
__attribute__((format(printf, 1, 2)));
extern int pp_vsprintf(char *buf, const char *, va_list)
__attribute__ ((format (printf, 2, 0)));
......
include/pptp/ieee1588_types.h
View file @ d341232c
......@@ -8,7 +8,6 @@
#include <stdint.h>
typedef enum {FALSE=0, TRUE} Boolean; /* FIXME really needed? */
typedef uint8_t Octet;
typedef int8_t Integer8;
......@@ -29,94 +28,94 @@ typedef uint8_t Nibble;
/* FIXME: each struct must be aligned for lower memory usage */
typedef struct {
uint32_t lsb;
uint16_t msb;
uint32_t lsb;
uint16_t msb;
} UInteger48;
typedef struct {
uint32_t lsb;
int32_t msb;
uint32_t lsb;
int32_t msb;
} Integer64;
typedef struct {
Integer64 scaledNanoseconds;
Integer64 scaledNanoseconds;
} TimeInterval;
typedef struct {
UInteger48 secondsField;
UInteger32 nanosecondsField;
UInteger48 secondsField;
UInteger32 nanosecondsField;
} Timestamp;
typedef struct {
Integer32 seconds;
Integer32 nanoseconds;
Integer32 seconds;
Integer32 nanoseconds;
} TimeInternal;
typedef Octet ClockIdentity[PP_CLOCK_IDENTITY_LENGTH];
typedef Octet ClockIdentity[PP_CLOCK_IDENTITY_LENGTH];
typedef struct {
ClockIdentity clockIdentity;
UInteger16 portNumber;
ClockIdentity clockIdentity;
UInteger16 portNumber;
} PortIdentity;
typedef struct {
Enumeration16 networkProtocol;
UInteger16 adressLength;
Octet* adressField;
Enumeration16 networkProtocol;
UInteger16 adressLength;
Octet *adressField;
} PortAdress;
typedef struct {
UInteger8 clockClass;
Enumeration8 clockAccuracy;
UInteger16 offsetScaledLogVariance;
UInteger8 clockClass;
Enumeration8 clockAccuracy;
UInteger16 offsetScaledLogVariance;
} ClockQuality;
typedef struct {
Enumeration16 tlvType;
UInteger16 lengthField;
Octet* valueField;
Enumeration16 tlvType;
UInteger16 lengthField;
Octet *valueField;
} TLV;
typedef struct {
UInteger8 lengthField;
Octet* textField;
UInteger8 lengthField;
Octet *textField;
} PTPText;
typedef struct {
UInteger16 faultRecordLength;
Timestamp faultTime;
Enumeration8 severityCode;
PTPText faultName;
PTPText faultValue;
PTPText faultDescription;
UInteger16 faultRecordLength;
Timestamp faultTime;
Enumeration8 severityCode;
PTPText faultName;
PTPText faultValue;
PTPText faultDescription;
} FaultRecord;
/* Common Message header (table 18, page 124) */
typedef struct {
Nibble transportSpecific;
Enumeration4 messageType;
UInteger4 versionPTP;
UInteger16 messageLength;
UInteger8 domainNumber;
Octet flagField[2];
Integer64 correctionfield;
PortIdentity sourcePortIdentity;
UInteger16 sequenceId;
UInteger8 controlField;
Integer8 logMessageInterval;
Nibble transportSpecific;
Enumeration4 messageType;
UInteger4 versionPTP;
UInteger16 messageLength;
UInteger8 domainNumber;
Octet flagField[2];
Integer64 correctionfield;
PortIdentity sourcePortIdentity;
UInteger16 sequenceId;
UInteger8 controlField;
Integer8 logMessageInterval;
} MsgHeader;
/* Announce Message (table 25, page 129) */
typedef struct {
Timestamp originTimestamp;
Integer16 currentUtcOffset;
UInteger8 grandmasterPriority1;
ClockQuality grandmasterClockQuality;
UInteger8 grandmasterPriority2;
ClockIdentity grandmasterIdentity;
UInteger16 stepsRemoved;
Enumeration8 timeSource;
Timestamp originTimestamp;
Integer16 currentUtcOffset;
UInteger8 grandmasterPriority1;
ClockQuality grandmasterClockQuality;
UInteger8 grandmasterPriority2;
ClockIdentity grandmasterIdentity;
UInteger16 stepsRemoved;
Enumeration8 timeSource;
} MsgAnnounce;
/* Sync Message (table 26, page 129) */
......@@ -126,52 +125,52 @@ typedef struct {
/* DelayReq Message (table 26, page 129) */
typedef struct {
Timestamp originTimestamp;
Timestamp originTimestamp;
} MsgDelayReq;
/* DelayResp Message (table 27, page 130) */
typedef struct {
Timestamp preciseOriginTimestamp;
Timestamp preciseOriginTimestamp;
} MsgFollowUp;
/* DelayResp Message (table 28, page 130) */
typedef struct {
Timestamp receiveTimestamp;
PortIdentity requestingPortIdentity;
Timestamp receiveTimestamp;
PortIdentity requestingPortIdentity;
} MsgDelayResp;
/* PdelayReq Message (table 29, page 131) */
typedef struct {
Timestamp originTimestamp;
Timestamp originTimestamp;
} MsgPDelayReq;
/* PdelayResp Message (table 30, page 131) */
typedef struct {
Timestamp requestReceiptTimestamp;
PortIdentity requestingPortIdentity;
Timestamp requestReceiptTimestamp;
PortIdentity requestingPortIdentity;
} MsgPDelayResp;
/* PdelayRespFollowUp Message (table 31, page 132) */
typedef struct {
Timestamp responseOriginTimestamp;
PortIdentity requestingPortIdentity;
Timestamp responseOriginTimestamp;
PortIdentity requestingPortIdentity;
} MsgPDelayRespFollowUp;
/* Signaling Message (table 33, page 133) */
typedef struct {
PortIdentity targetPortIdentity;
char* tlv;
PortIdentity targetPortIdentity;
char *tlv;
} MsgSignaling;
/* Management Message (table 37, page 137) */
typedef struct {
PortIdentity targetPortIdentity;
UInteger8 startingBoundaryHops;
UInteger8 boundaryHops;
Enumeration4 actionField;
char* tlv;
PortIdentity targetPortIdentity;
UInteger8 startingBoundaryHops;
UInteger8 boundaryHops;
Enumeration4 actionField;
char *tlv;
} MsgManagement;
......@@ -179,72 +178,72 @@ typedef struct {
/* Default Data Set */
typedef struct {
/* Static */
Boolean twoStepFlag;
ClockIdentity clockIdentity;
UInteger16 numberPorts;
Boolean twoStepFlag;
ClockIdentity clockIdentity;
UInteger16 numberPorts;
/* Dynamic */
ClockQuality clockQuality;
ClockQuality clockQuality;
/* Configurable */
UInteger8 priority1;
UInteger8 priority2;
UInteger8 domainNumber;
Boolean slaveOnly;
UInteger8 priority1;
UInteger8 priority2;
UInteger8 domainNumber;
Boolean slaveOnly;
} DSDefault;
/* Current Data Set */
typedef struct {
/* Dynamic */
UInteger16 stepsRemoved;
TimeInternal offsetFromMaster;
TimeInternal meanPathDelay;
UInteger16 stepsRemoved;
TimeInternal offsetFromMaster;
TimeInternal meanPathDelay;
} DSCurrent;
/* Parent Data Set */
typedef struct {
/* Dynamic */
PortIdentity parentPortIdentity;
Boolean parentStats;
UInteger16 observedParentOffsetScaledLogVariance;
Integer32 observedParentClockPhaseChangeRate;
ClockIdentity grandmasterIdentity;
ClockQuality grandmasterClockQuality;
UInteger8 grandmasterPriority1;
UInteger8 grandmasterPriority2;
PortIdentity parentPortIdentity;
Boolean parentStats;
UInteger16 observedParentOffsetScaledLogVariance;
Integer32 observedParentClockPhaseChangeRate;
ClockIdentity grandmasterIdentity;
ClockQuality grandmasterClockQuality;
UInteger8 grandmasterPriority1;
UInteger8 grandmasterPriority2;
} DSParent;
/* Port Data set */
typedef struct {
/* Static */
PortIdentity portIdentity;
PortIdentity portIdentity;
/* Dynamic */
Enumeration8 portState;
Integer8 logMinDelayReqInterval;
TimeInternal peerMeanPathDelay;
Enumeration8 portState;
Integer8 logMinDelayReqInterval;
TimeInternal peerMeanPathDelay;
/* Configurable */
Integer8 logAnnounceInterval;
UInteger8 announceReceiptTimeout;
Integer8 logSyncInterval;
Enumeration8 delayMechanism;
Integer8 logMinPdelayReqInterval;
UInteger4 versionNumber;
Integer8 logAnnounceInterval;
UInteger8 announceReceiptTimeout;
Integer8 logSyncInterval;
Enumeration8 delayMechanism;
Integer8 logMinPdelayReqInterval;
UInteger4 versionNumber;
} DSPort;
/* Time Properties Data Set */
typedef struct {
/* Dynamic */
Integer16 currentUtcOffset;
Boolean currentUtcOffsetValid;
Boolean leap59;
Boolean leap61;
Boolean timeTraceable;
Boolean frequencyTraceable;
Boolean ptpTimescale;
Enumeration8 timeSource;
Integer16 currentUtcOffset;
Boolean currentUtcOffsetValid;
Boolean leap59;
Boolean leap61;
Boolean timeTraceable;
Boolean frequencyTraceable;
Boolean ptpTimescale;
Enumeration8 timeSource;
} DSTimeProperties;
/* Enumeration States (table 8, page 73) */
enum pp_std_states {
PPS_END_OF_TABLE = 0,
PPS_END_OF_TABLE = 0,
PPS_INITIALIZING,
PPS_FAULTY,
PPS_DISABLED,
......@@ -257,11 +256,11 @@ enum pp_std_states {
};
enum pp_std_messages {
PPM_SYNC = 0x0,
PPM_SYNC = 0x0,
PPM_DELAY_REQ,
PPM_PDELAY_REQ,
PPM_PDELAY_RESP,
PPM_FOLLOW_UP = 0x8,
PPM_FOLLOW_UP = 0x8,
PPM_DELAY_RESP,
PPM_PDELAY_RESP_FOLLOW_UP,
PPM_ANNOUNCE,
......@@ -271,7 +270,7 @@ enum pp_std_messages {
/* Enumeration Domain Number (table 2, page 41) */
enum ENDomainNumber {
DFLT_DOMAIN_NUMBER = 0,
DFLT_DOMAIN_NUMBER = 0,
ALT1_DOMAIN_NUMBER,
ALT2_DOMAIN_NUMBER,
ALT3_DOMAIN_NUMBER
......@@ -279,7 +278,7 @@ enum ENDomainNumber {
/* Enumeration Network Protocol (table 3, page 46) */
enum ENNetworkProtocol {
UDP_IPV4 = 1,
UDP_IPV4 = 1,
UDP_IPV6,
IEE_802_3,
DeviceNet,
......@@ -288,22 +287,22 @@ enum ENNetworkProtocol {
};
/* Enumeration Time Source (table 7, page 57) */
enum ENTimeSource{
ATOMIC_CLOCK = 0x10,
GPS = 0x20,
TERRESTRIAL_RADIO = 0x30,
PTP = 0x40,
NTP = 0x50,
HAND_SET = 0x60,
OTHER = 0x90,
INTERNAL_OSCILLATOR = 0xA0
enum ENTimeSource {
ATOMIC_CLOCK = 0x10,
GPS = 0x20,
TERRESTRIAL_RADIO = 0x30,
PTP = 0x40,
NTP = 0x50,
HAND_SET = 0x60,
OTHER = 0x90,
INTERNAL_OSCILLATOR = 0xA0
};
/* Enumeration Delay mechanism (table 9, page 74) */
enum ENDelayMechanism {
E2E = 1,
P2P = 2,
DELAY_DISABLED = 0xFE
E2E = 1,
P2P = 2,
DELAY_DISABLED = 0xFE
};
#endif /* __PPTP_IEEE_1588_TYPES_H__ */
include/pptp/pptp.h
View file @ d341232c
......@@ -50,14 +50,12 @@ struct pp_runtime_opts {
* char *file; [PP_PATH_MAX]
*/
};
extern struct pp_runtime_opts default_rt_opts; /* preinitialized
* with default values */
extern struct pp_runtime_opts default_rt_opts; /* preinited with defaults */
/*
* Communication channel
*/
struct pp_channel
{
struct pp_channel {
union {
int fd; /* Posix wants fid descriptor */
void *custom; /* Other archs want other stuff */
......@@ -71,8 +69,7 @@ struct pp_channel
/*
* Foreign master record. Used to manage Foreign masters
*/
struct pp_frgn_master
{
struct pp_frgn_master {
PortIdentity port_identity;
UInteger16 ann_messages;
......@@ -84,8 +81,7 @@ struct pp_frgn_master
/*
* Timer
*/
struct pp_timer
{
struct pp_timer {
uint32_t start;
uint32_t interval;
};
......@@ -93,8 +89,7 @@ struct pp_timer
/*
* Net Path
*/
struct pp_net_path
{
struct pp_net_path {
struct pp_channel evt_ch;
struct pp_channel gen_ch;
Integer32 ucast_addr;
......@@ -167,16 +162,16 @@ struct pp_instance {
waiting_for_follow:1;
};
#define DSDEF(x) x->defaultDS
#define DSCUR(x) x->currentDS
#define DSPAR(x) x->parentDS
#define DSPOR(x) x->portDS
#define DSPRO(x) x->timePropertiesDS
#define DSDEF(x) ((x)->defaultDS)
#define DSCUR(x) ((x)->currentDS)
#define DSPAR(x) ((x)->parentDS)
#define DSPOR(x) ((x)->portDS)
#define DSPRO(x) ((x)->timePropertiesDS)
/* The channel for an instance must be created and possibly destroyed. */
extern int pp_open_instance(struct pp_instance *ppi,
struct pp_runtime_opts *rt_opts);
struct pp_runtime_opts *rt_opts);
extern int pp_close_instance(struct pp_instance *ppi);
......@@ -190,7 +185,7 @@ extern int pp_send_packet(struct pp_instance *ppi, void *pkt, int len);
/* Timers */
extern int pp_timer_init(struct pp_instance *ppi); /* initializes timer common
structure */
structure */
extern int pp_timer_start(uint32_t interval, struct pp_timer *tm);
extern int pp_timer_stop(struct pp_timer *tm);
extern int pp_timer_expired(struct pp_timer *tm); /* returns 1 when expired */
......@@ -234,7 +229,7 @@ extern void msg_pack_pdelay_resp(void *buf, MsgHeader *hdr,
Timestamp *req_rec_tstamp, struct pp_instance *ppi);
extern void msg_unpack_pdelay_resp(void *buf, MsgPDelayResp *presp);
extern void msg_pack_pdelay_resp_followup(void *buf, MsgHeader *hdr,
Timestamp *resp_orig_tstamp, struct pp_instance* ppi);
Timestamp *resp_orig_tstamp, struct pp_instance *ppi);
extern void msg_unpack_pdelay_resp_followup(void *buf,
MsgPDelayRespFollowUp *presp_follow);
......@@ -271,8 +266,8 @@ typedef int pp_action(struct pp_instance *ppi, uint8_t *packet, int plen);
/* Standard state-machine functions */
extern pp_action pp_initializing, pp_faulty, pp_disabled, pp_listening,
pp_pre_master, pp_master, pp_passive, pp_uncalibrated,
pp_slave;
pp_pre_master, pp_master, pp_passive, pp_uncalibrated,
pp_slave;
/* The engine */
extern int pp_state_machine(struct pp_instance *ppi, uint8_t *packet, int plen);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment