summaryrefslogtreecommitdiff
path: root/third_party/ptpd-1.1.0/src/datatypes.h
blob: 1f0e21e19d48057544f294905a774a25c5d66fcc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
/**
 * @file   datatypes.h
 * @date   Wed Jun 23 09:37:14 2010
 *
 * @brief  All of the datatypes used by the daemon.
 *
 *
 */


#ifndef DATATYPES_H
#define DATATYPES_H

#include <stdio.h>

typedef struct {
    UInteger32 seconds;
    Integer32 nanoseconds;
}    TimeRepresentation;

typedef struct {
    Integer32 seconds;
    Integer32 nanoseconds;
}    TimeInternal;

typedef struct {
    Integer32 interval;
    Integer32 left;
    Boolean    expire;
}    IntervalTimer;

/* Message header */
typedef struct {
    UInteger16 versionPTP;
    UInteger16 versionNetwork;
    Octet    subdomain[PTP_SUBDOMAIN_NAME_LENGTH];
    UInteger8 messageType;
    UInteger8 sourceCommunicationTechnology;
    Octet    sourceUuid[PTP_UUID_LENGTH];
    UInteger16 sourcePortId;
    UInteger16 sequenceId;
    UInteger8 control;
    Octet    flags[2];

}    MsgHeader;

/* Sync or Delay_Req message */
typedef struct {
    TimeRepresentation originTimestamp;
    UInteger16 epochNumber;
    Integer16 currentUTCOffset;
    UInteger8 grandmasterCommunicationTechnology;
    Octet    grandmasterClockUuid[PTP_UUID_LENGTH];
    UInteger16 grandmasterPortId;
    UInteger16 grandmasterSequenceId;
    UInteger8 grandmasterClockStratum;
    Octet    grandmasterClockIdentifier[PTP_CODE_STRING_LENGTH];
    Integer16 grandmasterClockVariance;
    Boolean    grandmasterPreferred;
    Boolean    grandmasterIsBoundaryClock;
    Integer8 syncInterval;
    Integer16 localClockVariance;
    UInteger16 localStepsRemoved;
    UInteger8 localClockStratum;
    Octet    localClockIdentifer[PTP_CODE_STRING_LENGTH];
    UInteger8 parentCommunicationTechnology;
    Octet    parentUuid[PTP_UUID_LENGTH];
    UInteger16 parentPortField;
    Integer16 estimatedMasterVariance;
    Integer32 estimatedMasterDrift;
    Boolean    utcReasonable;

}    MsgSync;

typedef MsgSync MsgDelayReq;

/* Follow_Up message */
typedef struct {
    UInteger16 associatedSequenceId;
    TimeRepresentation preciseOriginTimestamp;

}    MsgFollowUp;

/* Delay_Resp message */
typedef struct {
    TimeRepresentation delayReceiptTimestamp;
    UInteger8 requestingSourceCommunicationTechnology;
    Octet    requestingSourceUuid[PTP_UUID_LENGTH];
    UInteger16 requestingSourcePortId;
    UInteger16 requestingSourceSequenceId;

}    MsgDelayResp;

/* Management message */
typedef union {
    struct ClockIdentity {
        UInteger8 clockCommunicationTechnology;
        Octet    clockUuidField[PTP_UUID_LENGTH];
        UInteger16 clockPortField;
        Octet    manufacturerIdentity[MANUFACTURER_ID_LENGTH];
    }    clockIdentity;

    struct DefaultData {
        UInteger8 clockCommunicationTechnology;
        Octet    clockUuidField[PTP_UUID_LENGTH];
        UInteger16 clockPortField;
        UInteger8 clockStratum;
        Octet    clockIdentifier[PTP_CODE_STRING_LENGTH];
        Integer16 clockVariance;
        Boolean    clockFollowupCapable;
        Boolean    preferred;
        Boolean    initializable;
        Boolean    externalTiming;
        Boolean    isBoundaryClock;
        Integer8 syncInterval;
        Octet    subdomainName[PTP_SUBDOMAIN_NAME_LENGTH];
        UInteger16 numberPorts;
        UInteger16 numberForeignRecords;
    }    defaultData;

    struct Current {
        UInteger16 stepsRemoved;
        TimeRepresentation offsetFromMaster;
        TimeRepresentation oneWayDelay;
    }    current;

    struct Parent {
        UInteger8 parentCommunicationTechnology;
        Octet    parentUuid[PTP_UUID_LENGTH];
        UInteger16 parentPortId;
        UInteger16 parentLastSyncSequenceNumber;
        Boolean    parentFollowupCapable;
        Boolean    parentExternalTiming;
        Integer16 parentVariance;
        Boolean    parentStats;
        Integer16 observedVariance;
        Integer32 observedDrift;
        Boolean    utcReasonable;
        UInteger8 grandmasterCommunicationTechnology;
        Octet    grandmasterUuidField[PTP_UUID_LENGTH];
        UInteger16 grandmasterPortIdField;
        UInteger8 grandmasterStratum;
        Octet    grandmasterIdentifier[PTP_CODE_STRING_LENGTH];
        Integer16 grandmasterVariance;
        Boolean    grandmasterPreferred;
        Boolean    grandmasterIsBoundaryClock;
        UInteger16 grandmasterSequenceNumber;
    }    parent;

    struct Port {
        UInteger16 returnedPortNumber;
        UInteger8 portState;
        UInteger16 lastSyncEventSequenceNumber;
        UInteger16 lastGeneralEventSequenceNumber;
        UInteger8 portCommunicationTechnology;
        Octet    portUuidField[PTP_UUID_LENGTH];
        UInteger16 portIdField;
        Boolean    burstEnabled;
        UInteger8 subdomainAddressOctets;
        UInteger8 eventPortAddressOctets;
        UInteger8 generalPortAddressOctets;
        Octet    subdomainAddress[SUBDOMAIN_ADDRESS_LENGTH];
        Octet    eventPortAddress[PORT_ADDRESS_LENGTH];
        Octet    generalPortAddress[PORT_ADDRESS_LENGTH];
    }    port;

    struct GlobalTime {
        TimeRepresentation localTime;
        Integer16 currentUtcOffset;
        Boolean    leap59;
        Boolean    leap61;
        UInteger16 epochNumber;
    }    globalTime;

    struct Foreign {
        UInteger16 returnedPortNumber;
        UInteger16 returnedRecordNumber;
        UInteger8 foreignMasterCommunicationTechnology;
        Octet    foreignMasterUuid[PTP_UUID_LENGTH];
        UInteger16 foreignMasterPortId;
        UInteger16 foreignMasterSyncs;
    }    foreign;

}    MsgManagementPayload;

typedef struct {
    UInteger8 targetCommunicationTechnology;
    Octet    targetUuid[PTP_UUID_LENGTH];
    UInteger16 targetPortId;
    Integer16 startingBoundaryHops;
    Integer16 boundaryHops;
    UInteger8 managementMessageKey;
    UInteger16 parameterLength;
    UInteger16 recordKey;

    MsgManagementPayload payload;
}    MsgManagement;

typedef struct {
    UInteger8 foreign_master_communication_technology;
    Octet    foreign_master_uuid[PTP_UUID_LENGTH];
    UInteger16 foreign_master_port_id;
    UInteger16 foreign_master_syncs;

    MsgHeader header;
    MsgSync    sync;
}    ForeignMasterRecord;

/* main program data structure */
typedef struct {
    /* Default data set */
    UInteger8 clock_communication_technology;
    Octet    clock_uuid_field[PTP_UUID_LENGTH];
    UInteger16 clock_port_id_field;
    UInteger8 clock_stratum;
    Octet    clock_identifier[PTP_CODE_STRING_LENGTH];
    Integer16 clock_variance;
    Boolean    clock_followup_capable;
    Boolean    preferred;
    Boolean    initializable;
    Boolean    external_timing;
    Boolean    is_boundary_clock;
    Integer8 sync_interval;
    Octet    subdomain_name[PTP_SUBDOMAIN_NAME_LENGTH];
    UInteger16 number_ports;
    UInteger16 number_foreign_records;

    /* Current data set */
    UInteger16 steps_removed;
    TimeInternal offset_from_master;
    TimeInternal one_way_delay;

    /* Parent data set */
    UInteger8 parent_communication_technology;
    Octet    parent_uuid[PTP_UUID_LENGTH];
    UInteger16 parent_port_id;
    UInteger16 parent_last_sync_sequence_number;
    Boolean    parent_followup_capable;
    Boolean    parent_external_timing;
    Integer16 parent_variance;
    Boolean    parent_stats;
    Integer16 observed_variance;
    Integer32 observed_drift;
    Boolean    utc_reasonable;
    UInteger8 grandmaster_communication_technology;
    Octet    grandmaster_uuid_field[PTP_UUID_LENGTH];
    UInteger16 grandmaster_port_id_field;
    UInteger8 grandmaster_stratum;
    Octet    grandmaster_identifier[PTP_CODE_STRING_LENGTH];
    Integer16 grandmaster_variance;
    Boolean    grandmaster_preferred;
    Boolean    grandmaster_is_boundary_clock;
    UInteger16 grandmaster_sequence_number;

    /* Global time properties data set */
    Integer16 current_utc_offset;
    Boolean    leap_59;
    Boolean    leap_61;
    UInteger16 epoch_number;

    /* Port configuration data set */
    UInteger8 port_state;
    UInteger16 last_sync_event_sequence_number;
    UInteger16 last_general_event_sequence_number;
    Octet    subdomain_address[SUBDOMAIN_ADDRESS_LENGTH];
    Octet    event_port_address[PORT_ADDRESS_LENGTH];
    Octet    general_port_address[PORT_ADDRESS_LENGTH];
    UInteger8 port_communication_technology;
    Octet    port_uuid_field[PTP_UUID_LENGTH];
    UInteger16 port_id_field;
    Boolean    burst_enabled;

    /* Foreign master data set */
    ForeignMasterRecord *foreign;

    /* Other things we need for the protocol */
    Boolean    halfEpoch;

    Integer16 max_foreign_records;
    Integer16 foreign_record_i;
    Integer16 foreign_record_best;
    Boolean    record_update;
    UInteger32 random_seed;

    MsgHeader msgTmpHeader;

    union {
        MsgSync    sync;
        MsgFollowUp follow;
        MsgDelayReq req;
        MsgDelayResp resp;
        MsgManagement manage;
    }    msgTmp;

    Octet    msgObuf[PACKET_SIZE];
    Octet    msgIbuf[PACKET_SIZE];

    TimeInternal master_to_slave_delay;
    TimeInternal slave_to_master_delay;

    TimeInternal delay_req_receive_time;
    TimeInternal delay_req_send_time;
    TimeInternal sync_receive_time;

    UInteger16 Q;
    UInteger16 R;

    Boolean    sentDelayReq;
    UInteger16 sentDelayReqSequenceId;
    Boolean    waitingForFollow;

    offset_from_master_filter ofm_filt;
    one_way_delay_filter owd_filt;

    Boolean    message_activity;

    IntervalTimer itimer[TIMER_ARRAY_SIZE];

    NetPath    netPath;

}    PtpClock;

/* program options set at run-time */
typedef struct {
    Integer8 syncInterval;
    Octet    subdomainName[PTP_SUBDOMAIN_NAME_LENGTH];
    Octet    clockIdentifier[PTP_CODE_STRING_LENGTH];
    UInteger32 clockVariance;
    UInteger8 clockStratum;
    Boolean    clockPreferred;
    Integer16 currentUtcOffset;
    UInteger16 epochNumber;
    Octet    ifaceName[IFACE_NAME_LENGTH];
    Boolean    noResetClock;
    Integer32 maxReset; /* Maximum number of nanoseconds to reset */
    Integer32 maxDelay; /* Maximum number of nanoseconds of delay */
    Boolean    noAdjust;
    Boolean    displayStats;
    Boolean    csvStats;
    Octet    unicastAddress[NET_ADDRESS_LENGTH];
    Integer16 ap, ai;
    Integer16 s;
    TimeInternal inboundLatency, outboundLatency;
    Integer16 max_foreign_records;
    Boolean    slaveOnly;
    Boolean    probe;
    UInteger8 probe_management_key;
    UInteger16 probe_record_key;
    Boolean    halfEpoch;
#ifndef NO_FILE_SYSTEM
    char file[PATH_MAX];
#endif
    int logFd;
    Boolean useSysLog;
    int ttl;
#ifndef NO_FILE_SYSTEM
    char recordFile[PATH_MAX];
    FILE *recordFP;
#endif
}    RunTimeOpts;

#endif