1.2.5.2.8 TCPIP_MAC_EVENT Enumeration

C

typedef enum {
TCPIP_MAC_EV_NONE = 0x0000,
TCPIP_MAC_EV_RX_PKTPEND = 0x0001,
TCPIP_MAC_EV_RX_OVFLOW = 0x0002,
TCPIP_MAC_EV_RX_BUFNA = 0x0004,
TCPIP_MAC_EV_RX_ACT = 0x0008,
TCPIP_MAC_EV_RX_DONE = 0x0010,
TCPIP_MAC_EV_RX_FWMARK = 0x0020,
TCPIP_MAC_EV_RX_EWMARK = 0x0040,
TCPIP_MAC_EV_RX_BUSERR = 0x0080,
TCPIP_MAC_EV_TX_DONE = 0x0100,
TCPIP_MAC_EV_TX_ABORT = 0x0200,
TCPIP_MAC_EV_TX_BUSERR = 0x0400,
TCPIP_MAC_EV_CONN_ESTABLISHED = 0x0800,
TCPIP_MAC_EV_CONN_LOST = 0x1000,
TCPIP_MAC_EV_RX_ALL = (TCPIP_MAC_EV_RX_PKTPEND|TCPIP_MAC_EV_RX_OVFLOW| TCPIP_MAC_EV_RX_BUFNA|TCPIP_MAC_EV_RX_ACT| TCPIP_MAC_EV_RX_DONE|TCPIP_MAC_EV_RX_FWMARK| TCPIP_MAC_EV_RX_EWMARK|TCPIP_MAC_EV_RX_BUSERR),
TCPIP_MAC_EV_TX_ALL = (TCPIP_MAC_EV_TX_DONE|TCPIP_MAC_EV_TX_ABORT|TCPIP_MAC_EV_TX_BUSERR),
TCPIP_MAC_EV_RXTX_ERRORS = (TCPIP_MAC_EV_RX_OVFLOW|TCPIP_MAC_EV_RX_BUFNA| TCPIP_MAC_EV_RX_BUSERR|TCPIP_MAC_EV_TX_ABORT| TCPIP_MAC_EV_TX_BUSERR),
TCPIP_MAC_EV_CONN_ALL = (TCPIP_MAC_EV_CONN_ESTABLISHED|TCPIP_MAC_EV_CONN_LOST)
} TCPIP_MAC_EVENT;

Description

TCP/IP MAC Event.

TCP/IP MAC Events Codes.

This enumeration defines all the possible events that can be reported by the MAC to the stack.

Depending on the type of the hardware Ethernet/Wi-Fi interface, etc., not all events are possible.

Members

MembersDescription
TCPIP_MAC_EV_NONE = 0x0000no event.
TCPIP_MAC_EV_RX_PKTPEND = 0x0001RX triggered events: A receive packet is pending.
TCPIP_MAC_EV_RX_OVFLOW = 0x0002RX triggered events: RX FIFO overflow (system level latency, no descriptors, etc.).
TCPIP_MAC_EV_RX_BUFNA = 0x0004RX triggered events: no RX descriptor available to receive a new packet.
TCPIP_MAC_EV_RX_ACT = 0x0008RX triggered events: There's RX data available.
TCPIP_MAC_EV_RX_DONE = 0x0010RX triggered events: A packet was successfully received.
TCPIP_MAC_EV_RX_FWMARK = 0x0020RX triggered events: the number of received packets is greater than or equal to than the RX Full Watermark.
TCPIP_MAC_EV_RX_EWMARK = 0x0040RX triggered events: the number of received packets is less than or equal to than the RX Empty Watermark.
TCPIP_MAC_EV_RX_BUSERR = 0x0080RX triggered events: a bus error encountered during an RX transfer.
TCPIP_MAC_EV_TX_DONE = 0x0100TX triggered events: A packet was transmitted and its status is available.
TCPIP_MAC_EV_TX_ABORT = 0x0200TX triggered events: a TX packet was aborted by the MAC (jumbo/system underrun/excessive defer/late collision/excessive collisions).
TCPIP_MAC_EV_TX_BUSERR = 0x0400TX triggered events: a bus error encountered during a TX transfer.
TCPIP_MAC_EV_CONN_ESTABLISHED = 0x0800Connection triggered events: Connection established.
TCPIP_MAC_EV_CONN_LOST = 0x1000Connection triggered events: Connection lost.
TCPIP_MAC_EV_RX_ALL = (TCPIP_MAC_EV_RX_PKTPEND|TCPIP_MAC_EV_RX_OVFLOW| TCPIP_MAC_EV_RX_BUFNA|TCPIP_MAC_EV_RX_ACT| TCPIP_MAC_EV_RX_DONE|TCPIP_MAC_EV_RX_FWMARK| TCPIP_MAC_EV_RX_EWMARK|TCPIP_MAC_EV_RX_BUSERR)Useful Masks: all RX related events.
TCPIP_MAC_EV_TX_ALL = (TCPIP_MAC_EV_TX_DONE|TCPIP_MAC_EV_TX_ABORT|TCPIP_MAC_EV_TX_BUSERR)Useful Masks: all TX related events.
TCPIP_MAC_EV_RXTX_ERRORS = (TCPIP_MAC_EV_RX_OVFLOW|TCPIP_MAC_EV_RX_BUFNA| TCPIP_MAC_EV_RX_BUSERR|TCPIP_MAC_EV_TX_ABORT| TCPIP_MAC_EV_TX_BUSERR)Abnormal traffic/system events: Action should be taken accordingly by the stack (or the stack user).
TCPIP_MAC_EV_CONN_ALL = (TCPIP_MAC_EV_CONN_ESTABLISHED|TCPIP_MAC_EV_CONN_LOST)Mask of all Connection related events.

Remarks

None.