SZSPTP ez430-RF2480 1.0

ZigBee Sensor Network with synchronized time and time-stamped measurements.
ptp_util.h
Go to the documentation of this file.
1 /*
2  * ptp_util.h
3  *
4  * Date: 19/06/2014
5  * Author: Fernando Biazi Nascimento
6  * Copyright © 2014 Fernando Biazi Nascimento. All rights reserved.
7  *
8  * License of use and copy on file license.txt
9  *
10  */
11 
21 #ifndef PTP_UTIL_H
22 #define PTP_UTIL_H
23 
24 /*
25  * ======== Includes ========
26  */
27 
28 #include "ptp_types.h"
29 #include "ptp_clock.h"
30 
31 /*
32  * ======== Doxygen ========
33  */
34 
45 /*
46  * ======== Constants ========
47  */
48 
49 /*
50  * ======== Macros ========
51  */
52 
53 /*
54  * ======== Types ========
55  */
56 
57 /*
58  * ======== Global Variables ========
59  */
60 
61 /*
62  * ======== Global Functions ========
63  */
64 
66 
67 void ptp_getCurrentTime(PTP_TimeStamp *result);
68 void ptp_adjTime(PTP_TimeStamp *t1, PTP_TimeStamp *t2, ptp_uinteger8 portIndex);
70 
72 
74 
76 
78  ptp_boolean *byTopology, PTP_announceDS *E1, PTP_announceDS *E2,
82 
83 void ptp_storeForeignMaster(ptp_octet *pBuf, ptp_uinteger8 portNumber);
84 
86 ptp_uinteger8 ptp_snd(ptp_uinteger8 len, void *pBuf);
87 void ptp_endFrame();
94 
96 
104 
105 void ptp_rcvOctets(ptp_uinteger8 len, ptp_octet *source, ptp_octet *dest);
106 
107 void ptp_copyOctets(ptp_uinteger8 len, ptp_octet *source, ptp_octet *dest);
108 
113 #endif /* PTP_UTIL_H */
ptp_uinteger64 ptp_rcvUInt64(ptp_octet *pBuf)
Receive unsigned 64 bits integer.
Definition: ptp_util.c:1116
unsigned char ptp_boolean
Definition: ptp_types.h:68
ptp_uinteger8 ptp_sndInt64(ptp_integer64 *p)
Send 64 bits integer.
Definition: ptp_util.c:1017
ptp_uinteger8 ptp_startFrame(ptp_uinteger16 destination, ptp_uinteger8 len)
Start Frame.
Definition: ptp_util.c:889
ptp_uinteger8 ptp_sndUInt32(ptp_uinteger32 *p)
Send unsigned 32 bits integer.
Definition: ptp_util.c:958
ptp_uinteger8 ptp_rcvUInt8(ptp_octet *pBuf)
Receive unsigned 8 bits integer.
Definition: ptp_util.c:1030
ptp_uinteger8 ptp_snd(ptp_uinteger8 len, void *pBuf)
Send data.
Definition: ptp_util.c:906
ptp_uinteger8 ptp_sndUInt16(ptp_uinteger16 v)
Send unsigned 16 bits integer.
Definition: ptp_util.c:944
void ptp_rcvOctets(ptp_uinteger8 len, ptp_octet *source, ptp_octet *dest)
Receive octets.
Definition: ptp_util.c:1162
ptp_integer8 ptp_dataSetComparisonDE(ptp_boolean *Dbetter, ptp_clock *D, PTP_announceDS *E, ptp_uinteger8 i)
Data set comparison self clock/announce message.
Definition: ptp_util.c:677
ptp_uinteger8 ptp_sndUInt8(ptp_uinteger8 v)
Send unsigned 8 bits integer.
Definition: ptp_util.c:930
ptp_uinteger8 ptp_sndUInt48(ptp_uinteger48 *p)
Send unsigned 48 bits integer.
Definition: ptp_util.c:972
PTP clock structure.
Definition: ptp_clock.h:65
unsigned long long ptp_uinteger64
Definition: ptp_types.h:125
ptp_integer8 ptp_clockIdentityCompare(ptp_clockIdentity A, ptp_clockIdentity B)
Clock identity compare.
Definition: ptp_util.c:201
void ptp_adjTime(PTP_TimeStamp *t1, PTP_TimeStamp *t2, ptp_uinteger8 portIndex)
Adjust the clock.
Definition: ptp_util.c:118
long long ptp_integer64
Definition: ptp_types.h:120
void ptp_copyOctets(ptp_uinteger8 len, ptp_octet *source, ptp_octet *dest)
Copy octets.
Definition: ptp_util.c:1177
unsigned long ptp_uinteger32
Definition: ptp_types.h:110
ptp_clockIdentity * ptp_getClockIdentity()
Get clock identity.
Definition: ptp_util.c:85
void ptp_state_decision_event()
State decision event.
Definition: ptp_util.c:248
signed char ptp_integer8
Definition: ptp_types.h:85
void ptp_storeForeignMaster(ptp_octet *pBuf, ptp_uinteger8 portNumber)
Store foreign master.
Definition: ptp_util.c:833
ptp_octet ptp_clockIdentity[8]
Definition: ptp_types.h:322
unsigned char ptp_uinteger8
Definition: ptp_types.h:90
unsigned long long ptp_uinteger48
Definition: ptp_types.h:115
void ptp_portsSetListening()
Ports set listening.
Definition: ptp_util.c:224
ptp_uinteger8 ptp_sndUInt64(ptp_uinteger64 *p)
Send unsigned 64 bits integer.
Definition: ptp_util.c:1003
ptp_integer64 ptp_timeDiff(PTP_TimeStamp *t1, PTP_TimeStamp *t2)
Time difference.
Definition: ptp_util.c:187
void ptp_rcvUInt48sc(ptp_octet *pBuf, PTP_SecondsCount *p)
Receive seconds count value.
Definition: ptp_util.c:1098
void ptp_getCurrentTime(PTP_TimeStamp *result)
Get cuttent time.
Definition: ptp_util.c:104
char ptp_octet
Definition: ptp_types.h:137
ptp_integer64 ptp_rcvInt64(ptp_octet *pBuf)
Receive 64 bits integer.
Definition: ptp_util.c:1138
ptp_uinteger8 ptp_sndUInt48sc(PTP_SecondsCount *p)
Send a seconds count value.
Definition: ptp_util.c:986
ptp_uinteger48 ptp_rcvUInt48(ptp_octet *pBuf)
Receive unsigned 48 bits integer.
Definition: ptp_util.c:1077
PTP data types specifications.
ptp_integer8 ptp_dataSetComparisonEE(ptp_uinteger8 *iBetter, ptp_boolean *byTopology, PTP_announceDS *E1, PTP_announceDS *E2, ptp_uinteger8 i1, ptp_uinteger8 i2)
Data set comparison.
Definition: ptp_util.c:501
PTP clock object for synchronization.
ptp_uinteger16 ptp_rcvUInt16(ptp_octet *pBuf)
Receive unsigned 16 bits integer.
Definition: ptp_util.c:1043
unsigned short ptp_uinteger16
Definition: ptp_types.h:100
ptp_uinteger32 ptp_rcvUInt32(ptp_octet *pBuf)
Receive unsigned 32 bits integer.
Definition: ptp_util.c:1059
void ptp_endFrame()
End frame.
Definition: ptp_util.c:916