NMS V5 library channel callback events

This topic provides an alphabetical and numerical summary of the event messages that can be returned by NMS V5 library callback functions.

Alphabetical channel callback event summary

Callback event

Hex

Decimal

Description

NMSV5_EVENT_RX_ABORT

0x4

4

HDLC receive ABORT sequence. No data is available and no buffer is returned.

NMSV5_EVENT_RX_BUFFER_
OVERFLOW

0x7

7

An internal HDLC receive buffer overflow occurred. No data is available and no buffer is returned.

Not supported for CG 6100C or CG 6500C boards.

NMSV5_EVENT_RX_CRC_ERROR

0x5

5

HDLC detected a bad CRC for a frame. No data is available and no buffer is returned.

NMSV5_EVENT_RX_ERROR

0x2

2

An internal HDLC receive error occurred. No data is available and no buffer is returned.

NMSV5_EVENT_RX_FIFO_OVERRUN

0x3

3

HDLC receive FIFO overrun. No data is available and no buffer is returned.

Not supported for CG 6100C or CG 6500C boards.

NMSV5_EVENT_RX_NON_ALIGNED_
OCTET

0x6

6

The HDLC channel received a non-aligned frame. No data is available and no buffer is returned.

Not supported for CG 6100C or CG 6500C boards.

NMSV5_EVENT_RX_NO_7E_FLAG

0x8

8

Not supported.

NMSV5_EVENT_RX_SUCCESS

0x1

1

A new HDLC frame was received and is available inside databuffer. datasize is set to the frame size.

NMSV5_EVENT_TX_ERROR

0x09

9

Internal HDLC transmit error occurred. No buffer is returned.

NMSV5_EVENT_TX_FIFO_OVERRUN

0x0B

11

HDLC transmit FIFO overrun. No buffer is returned.

Not supported for CG 6100C or CG 6500C boards.

NMSV5_EVENT_TX_FIFO_UNDERRUN

0x0A

10

HDLC transmit FIFO underrun. No buffer is returned.

Not supported for CG 6100C or CG 6500C boards.

NMSV5_EVENT_TX_QUEUE_FULL

0x0C

12

HDLC transmit send queue is full. Under normal conditions this should never occur. No buffer is returned.


Numerical channel callback event summary

Hex

Decimal

Callback event

0x1

1

NMSV5_EVENT_RX_SUCCESS

0x2

2

NMSV5_EVENT_RX_ERROR

0x3

3

NMSV5_EVENT_RX_FIFO_OVERRUN

0x4

4

NMSV5_EVENT_RX_ABORT

0x5

5

NMSV5_EVENT_RX_CRC_ERROR

0x6

6

NMSV5_EVENT_RX_NON_ALIGNED_OCTET

0x7

7

NMSV5_EVENT_RX_BUFFER_OVERFLOW

0x9

8

NMSV5_EVENT_RX_NO_7E_FLAG

0xB

9

NMSV5_EVENT_TX_ERROR

0xC

10

NMSV5_EVENT_TX_FIFO_UNDERRUN

0xD

11

NMSV5_EVENT_TX_FIFO_OVERRUN

0xE

12

NMSV5_EVENT_TX_QUEUE_FULL