收发EtherCAT帧——ecx_inframe函数

ecx_inframe

非阻塞接收。

每个帧都存到对应index的buffer里。

若某帧之前已经存到buffer里，则该函数不调用ec_recvpkt，而是直接从buffer index恢复。

若请求的index不在buffer中，则该函数调用ec_recvpkt，来得到index对应的帧。

一共有3个选项

——1. 没有读帧，退出

——2. 读帧，但不对应于请求的index，存入buffer，退出

——3. 读帧，对应于index，存入buffer，在buffer status里设置complete flag，退出

入参1：port结构体

入参2：请求的帧的index

入参3：stack号，0代表primary，1代表secondary

出参：workcounter

int ecx_inframe(ecx_portt *port, int idx, int stacknumber)

先看

ec_bufT *rxbuf;

/** definition for frame buffers */
typedef uint8 ec_bufT[EC_BUFSIZE];//ec_bufT是uint8数组（元素个数为EC_BUFSIZE）/** standard frame buffer size in bytes */
#define EC_BUFSIZE         EC_MAXECATFRAME/** maximum EtherCAT frame length in bytes */
#define EC_MAXECATFRAME    1518

因此ec_bufT是uint8数组（元素个数为1518）

因此rxbuf是指向uint8数组（元素个数为1518） 的指针。

/** pointer structure to Tx and Rx stacks */
typedef struct
{/** socket connection used */int         *sock;/** tx buffer */ec_bufT     (*txbuf)[EC_MAXBUF];/** tx buffer lengths */int         (*txbuflength)[EC_MAXBUF];/** temporary receive buffer */ec_bufT     *tempbuf;         //tempbuf是指向uint8数组（元素个数1518）的指针/** rx buffers */ec_bufT   (*rxbuf)[EC_MAXBUF];//rxbuf是数组（元素个数16），数组里元素是指向ec_bufT的指针/** rx buffer status fields */int         (*rxbufstat)[EC_MAXBUF];/** received MAC source address (middle word) */int         (*rxsa)[EC_MAXBUF];
} ec_stackT;

ec_stackT *stack;

rxbuf是指针数组（元素个数16）。 

rxbuf = &(*stack->rxbuf)[idx];

如此看来rxbuf这个uint8数组的指针就定位到了idx序号的位置。

该函数首先判断请求接收的index是否已经放入到buffer中。idx首先需要是合法的，即需要小于16，至于为啥是这个数，以及这个数是啥意思我也不知道。猜测可能是该主站代码可以带动16个从站节点。其次需要这个idx对应的buffer的状态是Received, but not consumed。

  /* check if requested index is already in buffer ? */if ((idx < EC_MAXBUF) && ((*stack->rxbufstat)[idx] == EC_BUF_RCVD)){l = (*rxbuf)[0] + ((uint16)((*rxbuf)[1] & 0x0f) << 8);/* return WKC */rval = ((*rxbuf)[l] + ((uint16)(*rxbuf)[l + 1] << 8));/* mark as completed */(*stack->rxbufstat)[idx] = EC_BUF_COMPLETE;}

/** number of frame buffers per channel (tx, rx1 rx2) */
#define EC_MAXBUF          16

/** Possible buffer states */
typedef enum
{/** Empty */EC_BUF_EMPTY        = 0x00,/** Allocated, but not filled */EC_BUF_ALLOC        = 0x01,/** Transmitted */EC_BUF_TX           = 0x02,/** Received, but not consumed */EC_BUF_RCVD         = 0x03,/** Cycle completed */EC_BUF_COMPLETE     = 0x04
} ec_bufstate;

插一嘴，其实如何快速读C语言的声明，数据类型定义什么的，最好还是参考一下《征服C指针 【日】前桥和弥》P105~P142，该书整个第三章都可以参考。以后我会详细写一篇这方面的文章。

这个1518正好可以对应上EtherCAT报文的最大值1518

之后是计算workcounter，具体咋算的暂时没看懂

    l = (*rxbuf)[0] + ((uint16)((*rxbuf)[1] & 0x0f) << 8);/* return WKC */rval = ((*rxbuf)[l] + ((uint16)(*rxbuf)[l + 1] << 8));

然后将这个idx序号的buffer的状态更改为Cycle completed

    /* mark as completed */(*stack->rxbufstat)[idx] = EC_BUF_COMPLETE;

之后看else（idx大于等于16或者是idx序号对应的buffer的状态不是Received but not consumed）

调用ecx_recvpkt，非阻塞读buffer，帧可读的话ecx_recvpkt返回大于0的数，满足if条件，进入if

先将函数返回值设为EC_OTHERFRAME

/** return value unknown frame received */
#define EC_OTHERFRAME      -2

之后看

ehp =(ec_etherheadert*)(stack->tempbuf);

ehp是结构体指针，指向这个结构体

/** ethernet header definition */
PACKED_BEGIN
typedef struct PACKED
{/** destination MAC */uint16  da0,da1,da2;/** source MAC */uint16  sa0,sa1,sa2;/** ethernet type */uint16  etype;
} ec_etherheadert;
PACKED_END

先检查帧类型是否是EtherCAT帧，很简单只要看帧类型字段是否是0x88A4即可。

之后检查Datagram Header（其实看协议的帧结构，可以发现这里应该是EtherCAT header + Datagram Header）

/** EtherCAT datagram header definition */
PACKED_BEGIN
typedef struct PACKED
{/** length of EtherCAT datagram */uint16  elength;/** EtherCAT command, see ec_cmdtype */uint8   command;/** index, used in SOEM for Tx to Rx recombination */uint8   index;/** ADP */uint16  ADP;/** ADO */uint16  ADO;/** length of data portion in datagram */uint16  dlength;/** interrupt, currently unused */uint16  irpt;
} ec_comt;
PACKED_END

利用ecp这个结构体指针来访问Datagram Header里的各个元素，得到了EtherCAT datagram的长度和index序号。

接下来看刚刚得到的index序号和请求的index序号是否一致。

若一致将buffer去掉Ethernet Header后放入buffer，然后返回workcounter，然后将buffer的状态标记为Cycle completed，然后将源节点的MAC地址的中间那个字（中间的16位）记下来。

若不一致则继续看，判断是否这个idx号小于16且已经被发送给某个从节点了，如果不是的话就见鬼了（strange things happened），如果idx号小与16且已经发给某个从节点，将buffer去掉Ethernet Header后放入buffer，然后标记buffer的状态为Received, but not consumed，将源节点的MAC地址的中间那个字（中间的16位）记下来。

最后的最后，返回Workcounter值。