Version
Appendix A
Errors and Events
Introduction
NMS GR303 Library Errors
Alphabetical Error Summary
Numerical Error Summary
NMS GR303 Library Channel Callback Events
Alphabetical Channel Callback Event Summary
Numerical Channel Callback Event Summary
NMS V5 Library Errors
Alphabetical Error Summary
Numerical Error Summary
NMS V5 Library Channel Callback Events
Alphabetical Channel Callback Event Summary
Numerical Channel Callback Event Summary
Introduction
This appendix provides a summary of NMS GR303 and NMS V5 library error codes. The error codes for each library are presented in two tables:
Alphabetical, by error code name, including a description of the problem and a possible solution.
Numerical, by hexadecimal value, decimal value, and error name.
In addition, the appendix provides a summary of the event messages that can be returned by NMS GR303 and NMS V5 library callback functions. These events are also organized in alphabetical and numerical order
NMS GR303 Library Errors
The following sections describe NMS GR303 Library error messages.
Alphabetical Error Summary
The following table provides an alphabetical list of GR303 library errors.
Error Name
Hex
Decimal
Description
NMSGR303_ALREADY_INITIALIZED
0x02
2
The NMS GR303 is Library already initialized.
NMSGR303_FAILED_LOAD_LIB
0x03
3
Failed to load the NMS GR303 library
NMSGR303_INTERNAL_FAILURE
0x05
5
Operation failed. Refer to the trace log file for more information.
NMSGR303_INVALID_CHANNEL
0x08
8
The specified HDLC channel is not provisioned on this interface.
NMSGR303_INVALID_E1
0x09
9
Invalid DS1 location.
NMSGR303_INVALID_INTERFACE_ID
0x07
7
The interface ID is not valid.
NMSGR303_INVALID_PARMS
0x01
1
Invalid parameters.
NMSGR303_INVALID_STATE
0x0c
12
Invalid state for request.
NMSGR303_NO_MEMORY
0x04
4
Failed to allocate host memory
NMSGR303_NOT_INITIALIZED
0x06
6
The NMS GR303 library is not initialized.
NMSGR303_OUTOFRESOURCE
0x0a
10
No more resources are available
NMSGR303_SUCCESS
0x00
0
Success.
Numerical Error Summary
The following table provides a list of NMS GR303 library errors in numerical order.
Hex
Decimal
Error Name
0x00
0
NMSGR303_SUCCESS
0x01
1
NMSGR303_INVALID_PARMS
0x02
2
NMSGR303_ALREADY_INITIALIZED
0x03
3
NMSGR303_FAILED_LOAD_LIB
0x04
4
NMSGR303_NO_MEMORY
0x05
5
NMSGR303_INTERNAL_FAILURE
0x06
6
NMSGR303_NOT_INITIALIZED
0x07
7
NMSGR303_INVALID_INTERFACE_ID
0x08
8
NMSGR303_INVALID_CHANNEL
0x09
9
NMSGR303_INVALID_DS1
0x0a
10
NMSGR303_OUTOFRESOURCE
0x0c
12
NMSGR303_INVALID_STATE
NMS GR303 Library Channel Callback Events
The following sections describe NMS GR303 library channel callback events.
Alphabetical Channel Callback Event Summary
The following table provides an alphabetical list of GR303 library channel callback events.
Callback Event
Hex
Dec
Description
NMSGR303_EVENT_RX_ABORT
0x4
4
The HDLC received an ABORT sequence, no data is available
(no buffer is attached).
NMSGR303_EVENT_RX_BUFFER_
OVERFLOW
0x7
7
An internal HDLC receive buffer overflow occurred. The HDLC received a frame of invalid length, no data is available (no buffer is attached).
NMSGR303_EVENT_RX_CRC_ERROR
0x5
5
The HDLC received a bad CRC for the receive frame, and no data is available (no buffer is attached).
NMSGR303_EVENT_RX_ERROR
0x2
2
An internal HDLC RX error occurred, and no data is available (no buffer is attached).
NMSGR303_EVENT_RX_FIFO_OVERRUN
0x3
3
HDLC receive fifo overrun, no data is available (no buffer is attached).
NMSGR303_EVENT_RX_MAX_LENGTH_
VIOLATION
0x8
8
Not supported
NMSGR303_EVENT_RX_NON_ALIGNED_
OCTET
0x6
6
The HDLC received a non-aligned frame. No data is available (no buffer is attached).
NMSGR303_EVENT_RX_SUCCESS
0x1
1
A new HDLC frame was received and is available inside
databuffer
.
NMSGR303_EVENT_TX_ERROR
0xA
10
Internal HDLC transmit error occurred (no buffer is attached)
NMSGR303_EVENT_TX_FIFO_OVERRUN
0xC
12
HDLC TX fifo overrun (no buffer is attached).
NMSGR303_EVENT_TX_FIFO_UNDERRUN
0xB
11
HDLC TX fifo underrun (no buffer is attached)
NMSGR303_EVENT_TX_QUEUE_FULL
0xD
13
HDLC TX internal send queue is full (no buffer is attached). This error indicates an abnormal send rate.
NMSGR303_EVENT_TX_SUCCESS
0x9
9
The frame was transmitted successfully (no buffer is attached)
Numerical Channel Callback Event Summary
The following table provides a numerical list of GR303 library channel callback events.
Hex
Dec
Callback Event
0x4
4
NMSGR303_EVENT_RX_ABORT
0x7
7
NMSGR303_EVENT_RX_BUFFER_OVERFLOW
0x5
5
NMSGR303_EVENT_RX_CRC_ERROR
0x2
2
NMSGR303_EVENT_RX_ERROR
0x3
3
NMSGR303_EVENT_RX_FIFO_OVERRUN
0x8
8
NMSGR303_EVENT_RX_MAX_LENGTH_VIOLATION
0x6
6
NMSGR303_EVENT_RX_NON_ALIGNED_OCTET
0x1
1
NMSGR303_EVENT_RX_SUCCESS
0xA
10
NMSGR303_EVENT_TX_ERROR
0xC
12
NMSGR303_EVENT_TX_FIFO_OVERRUN
0xB
11
NMSGR303_EVENT_TX_FIFO_UNDERRUN
0xD
13
NMSGR303_EVENT_TX_QUEUE_FULL
0x9
9
NMSGR303_EVENT_TX_SUCCESS
NMS V5 Library Errors
The following sections describe NMS V5 Library error messages.
Alphabetical Error Summary
The following table provides an alphabetical list of V5 library errors.
Error Name
Hex
Decimal
Description
NMSV5_ALREADY_INITIALIZED
0x02
2
The NMS V5 is Library already initialized.
NMSV5_FAILED_LOAD_LIB
0x03
3
Failed to load the NMS V5 library
NMSV5_INTERNAL_FAILURE
0x05
5
Operation failed. Refer to the trace log file for more information.
NMSV5_INVALID_CHANNEL
0x08
8
Invalid channel location.
NMSV5_INVALID_E1
0x09
9
Invalid E1 location.
NMSV5_INVALID_INTERFACE_ID
0x07
7
The interface ID is not valid.
NMSV5_INVALID_PARMS
0x01
1
Invalid parameters.
NMSV5_INVALID_STATE
0x0c
12
Invalid state for request.
NMSV5_NO_MEMORY
0x04
4
Failed to allocate host memory.
NMSV5_NO_STANDBY
0x0d
13
No standby variant is defined.
NMSV5_NOT_INITIALIZED
0x06
6
The NMS V5 library is not initialized.
NMSV5_OUTOFRESOURCE
0x0a
10
No more resources are available
NMSV5_SUCCESS
0x00
0
Success.
Numerical Error Summary
The following table provides a list of NMS V5 library errors in numerical order.
Hex
Decimal
Error Name
0x00
0
NMSV5_SUCCESS
0x01
1
NMSV5_INVALID_PARMS
0x02
2
NMSV5_ALREADY_INITIALIZED
0x03
3
NMSV5_FAILED_LOAD_LIB
0x04
4
NMSV5_NO_MEMORY
0x05
5
NMSV5_INTERNAL_FAILURE
0x06
6
NMSV5_NOT_INITIALIZED
0x07
7
NMSV5_INVALID_INTERFACE_ID
0x08
8
NMSV5_INVALID_CHANNEL
0x09
9
NMSV5_INVALID_E1
0x0a
10
NMSV5_OUTOFRESOURCE
0x0c
12
NMSV5_INVALID_STATE
0x0d
13
NMSV5_NO_STANDBY
NMS V5 Library Channel Callback Events
The following sections describe NMS V5 Library V5 library channel callback events.
Alphabetical Channel Callback Event Summary
The following table provides an alphabetical list of V5 library channel callback events.
Event
Hex
Dec
Description
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_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.
NMSV5_EVENT_RX_ABORT
0x4
4
HDLC receive ABORT sequence. No data is available and no buffer is returned.
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_NON_ALIGNED_
OCTET
0x6
6
The HDLC receive non-aligned frame. 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.
NMSV5_EVENT_RX_MAX_LENGTH_
VIOLATION
0x8
8
Not supported.
NMSV5_EVENT_RX_NO_7E_FLAG
0x9
9
Not supported.
NMSV5_EVENT_TX_SUCCESS
0xA
10
Internal HDLC transmit error occurred. No buffer is returned.
NMSV5_EVENT_TX_ERROR
0xB
11
HDLC transmit fifo underrun. No buffer is returned.
NMSV5_EVENT_TX_FIFO_UNDERRUN
0xC
12
HDLC transmit fifo overrun. No buffer is returned.
NMSV5_EVENT_TX_FIFO_OVERRUN
0xD
13
HDLC transmit send queue is full. Under normal conditions this should never occur. No buffer is returned.
NMSV5_EVENT_TX_QUEUE_FULL
0xE
14
A new HDLC frame was received and is available inside
databuffer
.
datasize is
set to the frame size.
Numerical Channel Callback Event Summary
The following table provides a numerical list of V5 library channel callback events.
Hex
Dec
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
0x8
8
NMSV5_EVENT_RX_MAX_LENGTH_VIOLATION
0x9
9
NMSV5_EVENT_RX_NO_7E_FLAG
0xA
10
NMSV5_EVENT_TX_SUCCESS
0xB
11
NMSV5_EVENT_TX_ERROR
0xC
12
NMSV5_EVENT_TX_FIFO_UNDERRUN
0xD
13
NMSV5_EVENT_TX_FIFO_OVERRUN
0xE
14
NMSV5_EVENT_TX_QUEUE_FULL
Version
Want to send us feedback on our documentation? Email:
Tech_Pubs@nmss.com
Copyright © 2001, NMS Communications Corporation. All rights reserved.
Version
Version