ptp_messages.h

Go to the documentation of this file.

/*
 * ptp_messages.h
 *
 *  Date: 19/06/2014
 *  Author: Fernando Biazi Nascimento
 *  Copyright © 2014 Fernando Biazi Nascimento. All rights reserved.
 *
 *  License of use and copy on file license.txt
 *
 */

#ifndef PTP_MESSAGES_H
#define PTP_MESSAGES_H

/*
 * ======== Includes ========
 */

#include "ptp_clock.h"

/*
 * ======== Doxygen ========
 */
/*
 * ======== Constants ========
 */

/*
 * ======== Macros ========
 */

/*
 * ======== Types ========
 */

typedef enum ptp_msgType {

  PTP_MSGTYPE_SYNC = 0x0,
  PTP_MSGTYPE_DELAY_REQ = 0x1,
  PTP_MSGTYPE_PDELAY_REQ = 0x2,
  PTP_MSGTYPE_PDELAY_RESP = 0x3,
  // 4 - 7: Reserved
  PTP_MSGTYPE_FOLLOW_UP = 0x8,
  PTP_MSGTYPE_DELAY_RESP = 0x9,
  PTP_MSGTYPE_PDELAY_RESP_FOLLOW_UP = 0xA,
  PTP_MSGTYPE_ANNOUNCE = 0xB,
  PTP_MSGTYPE_SIGNALING = 0xC,
  PTP_MSGTYPE_MANAGEMENT = 0xD
// E - F: Reserved
} ptp_msgType; // Enum8

/*
 * ======== Global Variables ========
 */

/*
 * ======== Global Functions ========
 */

// Message Parts
void ptp_MsgHeaderSnd(ptp_uinteger16 sourcePortNumber, ptp_msgType msgType,
    ptp_uinteger16 messageLength, ptp_uinteger8 domainNumber,
    ptp_boolean unicast, ptp_integer64 correctionField,
    ptp_uinteger16 sequenceId);
// Not useful right now, but left for possible future use
//void ptp_MsgHeaderRcv(void *pBuf);
//void ptp_MsgSuffixZeroSnd();
//void ptp_MsgSuffixZeroRcv(void *pBuf);
void ptp_MsgSyncSnd();
void ptp_MsgSyncRcv(ptp_octet *pBuf);
void ptp_MsgDelayReqSnd();
void ptp_MsgDelayReqRcv(ptp_octet *pBuf);
ptp_uinteger8 ptp_MsgPdelayReqSnd(ptp_uinteger8 portNumber);
void ptp_MsgPdelayReqCheck();
void ptp_MsgPdelayReqRcv(ptp_octet *pBuf, PTP_TimeStamp *t2,
    ptp_uinteger8 portNumber);
ptp_uinteger8 ptp_MsgPdelayRespSnd();
void ptp_MsgPdelayRespRcv(ptp_octet *pBuf, PTP_TimeStamp *t4,
    ptp_uinteger8 portNumber);
ptp_uinteger8 ptp_MsgAnnounceSnd();
void ptp_MsgAnnounceRcv(ptp_octet *pBuf, ptp_uinteger8 portNumber);
void ptp_MsgFollowUpSnd();
void ptp_MsgFollowUpRcv(ptp_octet *pBuf);
void ptp_MsgDelayRespSnd();
void ptp_MsgDelayRespRcv(ptp_octet *pBuf);
void ptp_MsgPdelayRespFollowUpSnd();
void ptp_MsgPdelayRespFollowUpRcv(ptp_octet *pBuf);
void ptp_MsgManagementSnd();
void ptp_MsgManagementRcv(ptp_octet *pBuf);
void ptp_MsgSignalingSnd();
void ptp_MsgSignalingRcv(ptp_octet *pBuf);
#endif /* PTP_MESSAGES_H */