Skip to content

P
PPSi
Commit 8fd51f2b authored by Aurelio Colosimo's avatar Aurelio Colosimo
Browse files
Options

add new files in wr ext: wr_constants.h, wr_msg.c, wr_msg.h

parent 99552b90
Hide whitespace changes
Inline Side-by-side
Showing with 432 additions and 0 deletions
proto-ext-whiterabbit/wr_constants.h 0 → 100644
View file @ 8fd51f2b
/*
* Aurelio Colosimo for CERN, 2011 -- GNU LGPL v2.1 or later
* Based on ptp-noposix
*/
/** \name White Rabbit staff
Here comes all the constants needed in White Rabbit extension
.*/
/**\{*/
/*White Rabbit staff*/
/*
* if this defined, WR uses new implementation of timeouts (not using interrupt)
*/
//#define IRQ_LESS_TIMER
#define WR_NODE 0x80
#define WR_IS_CALIBRATED 0x04
#define WR_IS_WR_MODE 0x08
#define WR_NODE_MODE 0x03
# define WR_TLV_TYPE 0x2004
#define WR_MASTER_PRIORITY1 6
#define WR_DEFAULT_CAL_PERIOD 3000 //[us]
#define WR_DEFAULT_CAL_PATTERN 0x3E0 //1111100000
#define WR_DEFAULT_CAL_PATTERN_LEN 0xA //10 bits
#define WR_DEFAULT_STATE_TIMEOUT_MS 300 //[ms]
#define WR_DEFAULT_STATE_REPEAT 3
#define WR_DEFAULT_INIT_REPEAT 3
/*White Rabbit package Size*/
#define WR_ANNOUNCE_TLV_LENGTH 0x0A
#define WR_ANNOUNCE_LENGTH (PP_ANNOUNCE_LENGTH + WR_ANNOUNCE_TLV_LENGTH + 4)
#define WR_MANAGEMENT_TLV_LENGTH 6
#define WR_MANAGEMENT_LENGTH (MANAGEMENT_LENGTH + WR_MANAGEMENT_TLV_LENGTH)
/* memory footprint tweak for WRPC */
#ifdef WRPC_EXTRA_SLIM
#define MAX_PORT_NUMBER 1
#else
#define MAX_PORT_NUMBER 16
#endif
#define MIN_PORT_NUMBER 1
#define WR_PORT_NUMBER 10
#define WR_SLAVE_CLOCK_CLASS 248
#define WR_MASTER_CLOCK_CLASS 5
#define WR_MASTER_ONLY_CLOCK_CLASS 70
///// new staff for WRPTPv2
#define TLV_TYPE_ORG_EXTENSION 0x0003 //organization specific
#define WR_PRIORITY1 64
#define WR_TLV_ORGANIZATION_ID 0x080030
#define WR_TLV_MAGIC_NUMBER 0xDEAD
#define WR_TLV_WR_VERSION_NUMBER 0x01
#define WR_SIGNALING_MSG_BASE_LENGTH 48 //=length( header ) + lenght( targetPortId ) + length (tlvType) + lenght(lenghtField)
// 34 + 10 + 2 + 2
#define WR_DEFAULT_PHY_CALIBRATION_REQUIRED FALSE
#define SEND_CALIBRATION_PATTERN 0X0001
#define NOT_SEND_CALIBRATION_PATTERN 0X0000
/**
* \brief Indicates if a port is configured as White Rabbit, and what kind (master/slave) [White Rabbit]
*/
/*White Rabbit node */
enum{
NON_WR = 0x0,
WR_S_ONLY = 0x2,
WR_M_ONLY = 0x1,
WR_M_AND_S = 0x3,
WR_MODE_AUTO= 0x4, // only for ptpx - not in the spec
};
/**
* \brief Indicate current White Rabbit mode of a given port (non wr/wr master/wr slave) [White Rabbit]
*/
/*White Rabbit node */
enum{
WR_SLAVE = 2,
WR_MASTER = 1,
};
/**
* \brief Values of Management Actions (extended for WR), see table 38 [White Rabbit]
*/
enum{
GET,
SET,
RESPONSE,
COMMAND,
ACKNOWLEDGE,
WR_CMD, //White Rabbit
};
/**
* \brief WR PTP states (new, single FSM) [White Rabbit]
*/
enum {
WRS_PRESENT = 0, WRS_S_LOCK, WRS_M_LOCK, WRS_LOCKED,
WRS_CALIBRATION, WRS_CALIBRATED, WRS_RESP_CALIB_REQ ,WRS_WR_LINK_ON,
/*
each WR main state (except IDLE) has an associated timetout
we use state names to manage timeouts as well
*/
WR_TIMER_ARRAY_SIZE, //number of states which has timeouts
WRS_IDLE,
/* here are substates*/
WRS_S_LOCK_1,
WRS_S_LOCK_2,
WRS_CALIBRATION_1,
WRS_CALIBRATION_2,
WRS_CALIBRATION_3,
WRS_CALIBRATION_4,
WRS_CALIBRATION_5,
WRS_CALIBRATION_6,
WRS_CALIBRATION_7,
WRS_CALIBRATION_8,
WRS_RESP_CALIB_REQ_1,
WRS_RESP_CALIB_REQ_2,
WRS_RESP_CALIB_REQ_3,
};
/**
* \brief White Rabbit commands (for new implementation, single FSM), see table 38 [White Rabbit]
*/
enum{
NULL_WR_TLV = 0x0000,
SLAVE_PRESENT = 0x1000,
LOCK,
LOCKED,
CALIBRATE,
CALIBRATED,
WR_MODE_ON,
ANN_SUFIX = 0x2000,
};
/**
* \brief White Rabbit slave port's role
*/
enum{
NON_SLAVE = 0x0,
PRIMARY_SLAVE ,
SECONDARY_SLAVE ,
};
/**
* \brief White Rabbit data initialization mode
*/
enum{
INIT,
RE_INIT,
};
proto-ext-whiterabbit/wr_msg.c 0 → 100644
View file @ 8fd51f2b
/*
* Aurelio Colosimo for CERN, 2011 -- GNU LGPL v2.1 or later
* Based on ptp-noposix
*/
#include <ppsi/ppsi.h>
#include <ppsi/diag.h>
#include "wr_constants.h"
/*
* WR way to handle little/big endianess
* FIXME: check whether htons would be ok
*/
/* put 16 bit word in big endianess (from little endianess) */
static inline void put_be16(void *ptr, UInteger16 x)
{
*(unsigned char *)(ptr++) = (x >> 8) & 0xff;
*(unsigned char *)(ptr++) = (x) & 0xff;
}
/* put 32 bit word in big endianess (from little endianess) */
static inline void put_be32(void *ptr, UInteger32 x)
{
*(unsigned char *)(ptr++) = (x >> 24) & 0xff;
*(unsigned char *)(ptr++) = (x >> 16) & 0xff;
*(unsigned char *)(ptr++) = (x >> 8) & 0xff;
*(unsigned char *)(ptr++) = (x) & 0xff;
}
/* gets 32 bit word from big endianess (to little endianess) */
static inline UInteger32 get_be32(void *ptr)
{
UInteger32 res = 0x0;
res = res | ((*(unsigned char *)(ptr++) << 24) & 0xFF000000);
res = res | ((*(unsigned char *)(ptr++) << 16) & 0x00FF0000);
res = res | ((*(unsigned char *)(ptr++) << 8 ) & 0x0000FF00);
res = res | ((*(unsigned char *)(ptr++) << 0 ) & 0x000000FF);
return res;
}
/* gets 16 bit word from big endianess (to little endianess) */
static inline UInteger16 get_be16(void *ptr)
{
UInteger16 res = 0x0;
res = res | ((*(unsigned char *)(ptr++) << 8 ) & 0xFF00);
res = res | ((*(unsigned char *)(ptr++) << 0 ) & 0x000FF);
return res;
}
/* Pack White rabbit message in the suffix of PTP announce message */
void msg_pack_announce_wr_tlv(struct pp_instance *ppi)
{
void *buf;
UInteger16 wr_flags = 0;
/* Change length */
buf = ppi->buf_out;
*(UInteger16 *)(buf + 2) = htons(WR_ANNOUNCE_LENGTH);
*(UInteger16*)(buf + 64) = htons(TLV_TYPE_ORG_EXTENSION);
*(UInteger16*)(buf + 66) = htons(WR_ANNOUNCE_TLV_LENGTH);
// CERN's OUI: WR_TLV_ORGANIZATION_ID, how to flip bits?
*(UInteger16*)(buf + 68) = htons((WR_TLV_ORGANIZATION_ID >> 8));
*(UInteger16*)(buf + 70) = htons((0xFFFF & (WR_TLV_ORGANIZATION_ID << 8
| WR_TLV_MAGIC_NUMBER >> 8)));
*(UInteger16*)(buf + 72) = htons((0xFFFF & (WR_TLV_MAGIC_NUMBER << 8
| WR_TLV_WR_VERSION_NUMBER)));
//wrMessageId
*(UInteger16*)(buf + 74) = htons(ANN_SUFIX);
wr_flags = wr_flags | DSPOR(ppi)->wrConfig;
if (DSPOR(ppi)->calibrated)
wr_flags = WR_IS_CALIBRATED | wr_flags;
if (DSPOR(ppi)->wrModeOn)
wr_flags = WR_IS_WR_MODE | wr_flags;
*(UInteger16*)(buf + 76) = htons(wr_flags);
}
void msg_unpack_announce_wr_tlv(void *buf, MsgAnnounce *ann)
{
UInteger16 tlv_type;
UInteger32 tlv_organizationID;
UInteger16 tlv_magicNumber;
UInteger16 tlv_versionNumber;
UInteger16 tlv_wrMessageID;
tlv_type = (UInteger16)get_be16(buf+64);
tlv_organizationID = htons(*(UInteger16*)(buf+68)) << 8;
tlv_organizationID = htons(*(UInteger16*)(buf+70)) >> 8
| tlv_organizationID;
tlv_magicNumber = 0xFF00 & (htons(*(UInteger16*)(buf+70)) << 8);
tlv_magicNumber = htons(*(UInteger16*)(buf+72)) >> 8
| tlv_magicNumber;
tlv_versionNumber = 0xFF & htons(*(UInteger16*)(buf+72));
tlv_wrMessageID = htons(*(UInteger16*)(buf+74));
if (tlv_type == TLV_TYPE_ORG_EXTENSION &&
tlv_organizationID == WR_TLV_ORGANIZATION_ID &&
tlv_magicNumber == WR_TLV_MAGIC_NUMBER &&
tlv_versionNumber == WR_TLV_WR_VERSION_NUMBER &&
tlv_wrMessageID == ANN_SUFIX) {
ann->wrFlags = (UInteger16)get_be16(buf+76);
}
}
/* White Rabbit: packing WR Signaling messages*/
int msg_pack_wrsig(struct pp_instance *ppi, Enumeration16 wr_msg_id)
{
void *buf;
if ((DSPOR(ppi)->wrMode == NON_WR) || (wr_msg_id == ANN_SUFIX)) {
PP_PRINTF("BUG: Trying to send invalid wr_msg mode=%d id=%d",
DSPOR(ppi)->wrMode, wr_msg_id);
return 0;
}
buf = ppi->buf_out;
/* Changes in header */
*(char*)(buf+0) = *(char*)(buf+0) & 0xF0; /* RAZ messageType */
*(char*)(buf+0) = *(char*)(buf+0) | 0x0C; /* Table 19 -> signaling */
*(UInteger8*)(buf+32) = 0x05; //Table 23 -> all other
/* target portIdentity */
pp_memcpy((buf+34),DSPAR(ppi)->parentPortIdentity.clockIdentity,
PP_CLOCK_IDENTITY_LENGTH);
put_be16(buf + 42,DSPAR(ppi)->parentPortIdentity.portNumber);
/* WR TLV */
*(UInteger16*)(buf+44) = htons(TLV_TYPE_ORG_EXTENSION);
/* leave lenght free */
*(UInteger16*)(buf+48) = htons((WR_TLV_ORGANIZATION_ID >> 8));
*(UInteger16*)(buf+50) = htons((0xFFFF &
(WR_TLV_ORGANIZATION_ID << 8 | WR_TLV_MAGIC_NUMBER >> 8)));
*(UInteger16*)(buf+52) = htons((0xFFFF &
(WR_TLV_MAGIC_NUMBER << 8 | WR_TLV_WR_VERSION_NUMBER)));
/* wrMessageId */
*(UInteger16*)(buf+54) = htons(wr_msg_id);
UInteger16 len = 0;
switch (wr_msg_id) {
case CALIBRATE:
if(DSPOR(ppi)->calibrated) {
put_be16(buf+56, (DSPOR(ppi)->calRetry << 8 | 0x0000));
}
else {
put_be16(buf+56, (DSPOR(ppi)->calRetry << 8 | 0x0001));
}
put_be32(buf+58, DSPOR(ppi)->calPeriod);
len = 20;
break;
case CALIBRATED: /* new fsm */
/* delta TX */
put_be32(buf+56, DSPOR(ppi)->deltaTx.scaledPicoseconds.msb);
put_be32(buf+60, DSPOR(ppi)->deltaTx.scaledPicoseconds.lsb);
/* delta RX */
put_be32(buf+64, DSPOR(ppi)->deltaRx.scaledPicoseconds.msb);
put_be32(buf+68, DSPOR(ppi)->deltaRx.scaledPicoseconds.lsb);
len = 24;
break;
default:
/* only WR TLV "header" and wrMessageID */
len = 8;
break;
}
/* header len */
put_be16(buf + 2, WR_SIGNALING_MSG_BASE_LENGTH + len);
/* TLV len */
*(Integer16*)(buf+46) = htons(len);
/* FIXME diagnostic */
return (WR_SIGNALING_MSG_BASE_LENGTH + len);
}
/* White Rabbit: unpacking wr signaling messages */
void msg_unpack_wrsig(struct pp_instance *ppi, void *buf,
MsgSignaling *wrsig_msg, Enumeration16 *wr_msg_id)
{
UInteger16 tlv_type;
UInteger32 tlv_organizationID;
UInteger16 tlv_magicNumber;
UInteger16 tlv_versionNumber;
UInteger16 len = (UInteger16)get_be16(buf+2);
pp_memcpy(wrsig_msg->targetPortIdentity.clockIdentity,(buf+34),
PP_CLOCK_IDENTITY_LENGTH);
wrsig_msg->targetPortIdentity.portNumber = (UInteger16)get_be16(buf+42);
tlv_type = (UInteger16)get_be16(buf+44);
tlv_organizationID = htons(*(UInteger16*)(buf+48)) << 8;
tlv_organizationID = htons(*(UInteger16*)(buf+50)) >> 8
| tlv_organizationID;
tlv_magicNumber = 0xFF00 & (htons(*(UInteger16*)(buf+50)) << 8);
tlv_magicNumber = htons(*(UInteger16*)(buf+52)) >> 8
| tlv_magicNumber;
tlv_versionNumber = 0xFF & htons(*(UInteger16*)(buf+52));
if (tlv_type != TLV_TYPE_ORG_EXTENSION) {
PP_PRINTF("handle Signaling msg, failed, This is not "
"organization extension TLV = 0x%x\n", tlv_type);
return;
}
if (tlv_organizationID != WR_TLV_ORGANIZATION_ID) {
PP_PRINTF("handle Signaling msg, failed, not CERN's "
"OUI = 0x%x\n", tlv_organizationID);
return;
}
if(tlv_magicNumber != WR_TLV_MAGIC_NUMBER) {
PP_PRINTF("handle Signaling msg, failed, "
"not White Rabbit magic number = 0x%x\n", tlv_magicNumber);
return;
}
if(tlv_versionNumber != WR_TLV_WR_VERSION_NUMBER ) {
PP_PRINTF("handle Signaling msg, failed, not supported "
"version number = 0x%x\n", tlv_versionNumber);
return;
}
if (wr_msg_id)
*wr_msg_id = htons(*(UInteger16*)(buf+54));
switch (*wr_msg_id) {
case CALIBRATE:
DSPOR(ppi)->otherNodeCalSendPattern = 0x00FF & get_be16(buf+56);
DSPOR(ppi)->otherNodeCalRetry = 0x00FF & (get_be16(buf+56) >> 8);
DSPOR(ppi)->otherNodeCalPeriod = get_be32(buf+58);
break;
case CALIBRATED:
/* delta TX */
DSPOR(ppi)->otherNodeDeltaTx.scaledPicoseconds.msb =
get_be32(buf+56);
DSPOR(ppi)->otherNodeDeltaTx.scaledPicoseconds.lsb =
get_be32(buf+60);
/* delta RX */
DSPOR(ppi)->otherNodeDeltaRx.scaledPicoseconds.msb =
get_be32(buf+64);
DSPOR(ppi)->otherNodeDeltaRx.scaledPicoseconds.lsb =
get_be32(buf+68);
break;
default:
/* no data */
break;
}
/* FIXME diagnostic */
}
proto-ext-whiterabbit/wr_msg.h 0 → 100644
View file @ 8fd51f2b
/*
* Aurelio Colosimo for CERN, 2011 -- GNU LGPL v2.1 or later
* Based on ptp-noposix
*/
/* Pack White rabbit message in the suffix of PTP announce message */
void msg_pack_announce_wr_tlv(struct pp_instance *ppi);
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