CEI-x30 Application Programmer’s Interface

Error and Status Code Definitions

The following return status values are used by the CEI-x30 API routines.  They are defined in the C header file CDEV_API.H and are used in the following context.

C Constant

Value

Constant Definition

ARS_FAILURE

    -1

Requested operation failed

ARS_NODATA

     0

No data was detected or received

ARS_NORMAL

     1

Normal successful completion

ARS_GOTDATA

     4

Data was received

ARS_BAD_MESSAGE

     5

Previous reception of an invalid ARINC 429 message was detected

ARS_RX_BUFFER_OVERRUN

     6

Receive buffer overrun detected

ARS_INVHARCMD

1002

An invalid channel configuration attribute was detected in the supplied configuration file.

ARS_INVHARVAL

1003

Invalid configuration value specified for the attribute provided

ARS_XMITOVRFLO

1004

Transmit buffer overflow

ARS_INVBOARD

1005

Invalid board argument or the specified board has no open session

ARS_NOSYNC

1006

Transmit buffer flush failed

ARS_BADLOAD

1007

Firmware download procedure failed

 

ARS_MEMWRERR

1013

SRAM memory test  write/read/verify error

 

ARS_INVARG

1019

General invalid argument value provided to the function

 

ARS_DRIVERFAIL

1021

Device driver open session failure

 

ARS_WINRTFAIL

1022

Legacy device driver open session failure

 

ARS_CHAN_TIMEOUT

1023

Channel timeout encountered in a receive function having a built-in delay

 

ARS_NO_HW_SUPRT

1024

This function is not supported by the specified board

 

ARS_BAD_STATIC

1027

Register write/read/verify failure during initialization

 

ARS_HW_CONSISTENCY

1029

Device is not programmed for Enhanced Firmware operations

 

ARS_HW_DETECT

1030

Session opened but a supported CEI-x30 board was not detected

 

ARS_WRAP_DATA_FAIL

1031

Initiated BIT wrap test data read-back fail

 

ARS_WRAP_FLUSH_FAIL

1035

Initiated  BIT cannot execute external wrap test due to unknown external data reception

 

ARS_WRAP_DROP_FAIL

1036

Initiated BIT wrap test data not received

 

ARS_INT_ISR

1037

Driver failed to install or uninstall API interrupt support

 

ARS_BOARD_MUTEX

1038

API routine failed to acquire or release a board lock mechanism

 

ARS_NO_OS_SUPPORT

1041

There is no operating system support for the requested feature

 

ARS_NO_INT_SUPPORT

1043

Interrupt handling not supported for this board

 

ARS_NO_INT_ENABLED

1044

Interrupt handling not enabled for this board

 

ARS_ERR_SH_MEM_OBJ

1050

API failed to allocate a shared object (semaphore or mutex)

 

ARS_ERR_SH_MEM_MAP

1051

API failed to allocate a shared memory region (multi-process)

 

ARS_FW_NOT_SUPPORTED

1052

The firmware installed on the CEI-x30 board is incompatible with the API

 

ARS_RX_BIT_CMD_ERROR

1100

Receiver BIT command register write/read/verify failure

 

ARS_RX_BIT_CHnn_ERROR

1101-1132

Receive Channel “nn” (01-32) BIT failure detected