nai.h

Go to the documentation of this file.

 
typedef enum nai_status
{
   NAI_SUCCESS = 0,
   NAI_ERROR_INVALID_VALUE = -1,
   NAI_ERROR_INVALID_MODE = -2,
   NAI_ERROR_INVALID_SIZE = -3,
   NAI_ERROR_INVALID_TYPECODE = -4,
   NAI_ERROR_INVALID_ADDRESS = -5,
   NAI_ERROR_INVALID_ADDRBOUND = -6,
   NAI_ERROR_INVALID_COMMAND = -7,
   NAI_ERROR_NOT_FOUND = -8,
   NAI_ERROR_TIMEOUT = -9,
   NAI_ERROR_COMM_ERROR = -10,
   NAI_ERROR_LOCK_FAILED = -11,
   NAI_ERROR_INVALID_WIDTH = -12,
   NAI_ERROR_INVALID_CARD = -13,
   NAI_ERROR_INVALID_MODULE = -14,
   NAI_ERROR_INVALID_CHANNEL = -15,
   NAI_ERROR_OPEN_FAILED = -16,
   NAI_ERROR_INVALID_MESSAGE = -17,
   NAI_ERROR_MESSAGE_MISMATCH = -18,
   NAI_ERROR_OVERFLOW = -19,
   NAI_ERROR_NOT_MASTER = -20,
   NAI_ERROR_DISCONNECTED = -21,
   NAI_ERROR_IN_USE = -22,
   NAI_ERROR_FULL = -23,
   NAI_ERROR_EMPTY = -24,
   NAI_ERROR_NOT_READY = -25,
   NAI_ERROR_CONNECTION_LOST = -26,
   NAI_ERROR_NOT_OPEN = -27,
   NAI_ERROR_PARITY = -28,
   NAI_ERROR_FRAMING = -29,
   NAI_ERROR_FRAMING_PARITY = -30,
   NAI_ERROR_NO_MESSAGE = -31,
   NAI_ERROR_WATCHDOG = -32,
   NAI_ERROR_BUS_TIMEOUT = -33,
   NAI_ERROR_INVALID_RANGE = -34,
   NAI_ERROR_WRONG_DEVICE = -35,
   NAI_ERROR_BUS_READ_ERR = -36,
   NAI_ERROR_BUS_WRITE_ERR = -37,
   NAI_ERROR_MORE_DATA = -38,
   NAI_ERROR_INVALID_ENCODER_RES = -39,
   NAI_ERROR_INVALID_COMMUTATION_POLES = -40,
   NAI_ERROR_INVALID_RATIO = -41,
   NAI_ERROR_INVALID_IO_PARAM = -42,
   NAI_ERROR_BIT_FAILED = -43,
   NAI_ERROR_VME_ADDR_TRANSLATION = -44,
   NAI_ERROR_BSP_VME_TABLE = -45,
   NAI_ERROR_INT_CONNECT_FAILED = -46,
   NAI_ERROR_INT_DISCONNECT_FAILED = -47,
   NAI_ERROR_1553_MESSAGE_ERROR = -48,
   NAI_ERROR_1553_DATA_WRAPAROUND_ERROR = -49,
   NAI_ERROR_PERMISSION_DENIED = -50,   
   NAI_ERROR_UNLOCK_FAILED = -51,
   NAI_ERROR_PROTOCOL_FUNCTION_MISMATCH = -52,
   NAI_ERROR_FUNCTION_SPECIFIC_ERROR = -53,
 
   NAI_ERROR_NOT_SUPPORTED = -100,
   NAI_ERROR_UNKNOWN = -1000,
   NAI_ERROR_UNKNOWN_VALUE = -1001,
 
   /* Gen4 Error codes */
   NAI_ERROR_ETHER_GENERAL_GEN4                       = -0x8000, /* Error- General */
   NAI_ERROR_ETHER_INVALID_MSG_PREAMBLE_GEN4          = -0x8001, /* Error- Invalid Msg Preamble */
   NAI_ERROR_ETHER_INVALID_MSG_SEQ_NUM_GEN4           = -0x8002, /* Error- Invalid Msg Sequence Number */
   NAI_ERROR_ETHER_INVALID_MSG_TYPECODE_GEN4          = -0x8003, /* Error- Invalid Msg Typecode */
   NAI_ERROR_ETHER_INVALID_MSG_LENGTH_GEN4            = -0x8004, /* Error- Invalid Msg Length */
   NAI_ERROR_ETHER_INVALID_MSG_POSTAMBLE_GEN4         = -0x8005, /* Error- Invalid Msg Postamble*/
   NAI_ERROR_ETHER_INVALID_PAYLOAD_SIZE_GEN4          = -0x8006, /* Error- Invalid Payload Size */
   NAI_ERROR_ETHER_COMMAND_NOT_IMPLEMENTED_GEN4       = -0x8007, /* Error- Command not implemented */
   NAI_ERROR_ETHER_INVALID_CONFIG_TYPECODE_GEN4       = -0x8010, /* Error- Invalid Config Typecode*/
   NAI_ERROR_ETHER_INVALID_OPERATION_TYPECODE_GEN4    = -0x8011, /* Error- Invalid Operation Typecode*/
   NAI_ERROR_ETHER_INVALID_MB_INFOTYPE_GEN4           = -0x8012, /* Error- Invalid MB InfoType*/
   NAI_ERROR_ETHER_INVALID_MOD_INFOTYPE_GEN4          = -0x8013, /* Error- Invalid Module InfoType*/
   NAI_ERROR_ETHER_INVALID_MOD_ID_GEN4                = -0x8014, /* Error- Invalid Module ID */
   NAI_ERROR_ETHER_OPENING_EEPROM_GEN4                = -0x8015, /* Error Opening EEPROM */
   NAI_ERROR_ETHER_READING_EEPROM_GEN4                = -0x8016, /* Error Reading EEPROM */
   NAI_ERROR_ETHER_WRITING_EEPROM_GEN4                = -0x8017, /* Error Writing EEPROM */
   NAI_ERROR_ETHER_INVALID_PAYLOAD_LENGTH_GEN4        = -0x8018, /* Error- Invalid Payload Length */
   NAI_ERROR_ETHER_INFOTYPE_READONLY_GEN4             = -0x8019, /* Error- InfoType Read Only */
   NAI_ERROR_ETHER_READING_MOD_INFO_GEN4              = -0x801A, /* Error Reading Module Info */
   NAI_ERROR_ETHER_WRITING_MOD_INFO_GEN4              = -0x801B, /* Error Writing Module Info */
   NAI_ERROR_ETHER_INVALID_MOD_SLOT_NUM_GEN4          = -0x801C, /* Error- Invalid Module Slot Number */
   NAI_ERROR_ETHER_FILE_NOT_RECEIVED_GEN4             = -0x8020, /* Error- Did not receive file */
   NAI_ERROR_ETHER_EXTRACTING_FILE_GEN4               = -0x8021, /* Error Extracting Contents */
   NAI_ERROR_ETHER_FFMAPFILE_NOT_FOUND_GEN4           = -0x8022, /* Error- FFMapFile not found */
   NAI_ERROR_ETHER_FFMAPFILE_INVALID_ENTRY_GEN4       = -0x8023, /* Error- FFMapFile Invalid enr */
   NAI_ERROR_ETHER_FLASHFILE_NOT_FOUND_GEN4           = -0x8024, /* Error- FlashFile not found */
   NAI_ERROR_ETHER_FLASHFILE_LENGTH_MISMATCH_GEN4     = -0x8025, /* Error- FlashFile Length mismatch */
   NAI_ERROR_ETHER_FLASHFILE_CHECKSUM_MISMATCH_GEN4   = -0x8026, /* Error- FlashFile Checksum mismatch*/
   NAI_ERROR_ETHER_FLASHFILE_WRITING_TO_FLASH_GEN4    = -0x8027, /* Error- FlashFile writing to flash*/
   NAI_ERROR_ETHER_EXEMODE_MUST_BE_IN_CFG_MODE_GEN4   = -0x8030, /* Error- Execution Mode must be in config mode */
   NAI_ERROR_ETHER_EXEMODE_MUST_BE_IN_OP_MODE_GEN4    = -0x8031, /* Error- Execution Mode must be in operation mode */
   NAI_ERROR_ETHER_MODULE_LINK_DOWN_GEN4              = -0x8032, /* Error- Module link down */
 
   NAI_ERROR_ETHER_INVALID_BLOCK_ID_GEN4              = -0x8100, /* Error- Invalid Block ID */
   NAI_ERROR_ETHER_INVALID_TDR_ID_GEN4                = -0x8101, /* Error- Invalid TDR ID */
   NAI_ERROR_ETHER_INVALID_IDR_ID_GEN4                = -0x8102, /* Error- Invalid IDR ID */
   NAI_ERROR_ETHER_INVALID_REG_COUNT_GEN4             = -0x8103, /* Error- Invalid Register Count */
   NAI_ERROR_ETHER_BLOCK_NOT_CONFIGURED_GEN4          = -0x8104, /* Error- Block Not Configured */
   NAI_ERROR_ETHER_TDR_NOT_CONFIGURED_GEN4            = -0x8105, /* Error- TDR Not Configured */
   NAI_ERROR_ETHER_IDR_NOT_CONFIGURED_GEN4            = -0x8106, /* Error- IDR Not Configured */
 
   /* SERDES Errors codes */
   NAI_ERROR_SERDES_WRONG_SLOT_NUM                    = -0x8201, /* Error - wrong slot number */
   NAI_ERROR_SERDES_INVALID_SLOT_ID                   = -0x8202, /* Error - invalid slot ID */
   NAI_ERROR_SERDES_UNEXPECTED_PAYLOAD_COUNT          = -0x8203, /* Error - unexpected payload count */
   NAI_ERROR_SERDES_MODULE_NOT_FOUND                  = -0x8204, /* Error - module not found */
   NAI_ERROR_SERDES_MIS_ALIGNED_BYTE_ENABLE           = -0x8205, /* Error - mis-aligned byte enabled */
   NAI_ERROR_SERDES_INVALID_PARAMETER_VALUE           = -0x8206, /* Error - invalid parameter value */
   NAI_ERROR_SERDES_SYSTEM_NOT_READY                  = -0x8207, /* Error - system not ready */
   NAI_ERROR_SERDES_MODULE_NOT_READY                  = -0x8208, /* Error - module not ready */
   NAI_ERROR_SERDES_UNABLE_TO_ALLOCATE_MEMORY         = -0x8209, /* Error - unable to allocate memory */
   NAI_ERROR_SERDES_COMMAND_NOT_RECOGNIZED            = -0x820A, /* Error - command not recognized */
   NAI_ERROR_SERDES_TX_FIFO_NOT_EMPTY_TIMEOUT         = -0x820B, /* Error - TX FIFO not empty timeout */
   NAI_ERROR_SERDES_RX_FIFO_PKT_NOT_READY_TIMEOUT     = -0x820C, /* Error - RX FIFO Packet not ready timeout */
   NAI_ERROR_SERDES_DETECT_MODULES_TIMEOUT            = -0x820D, /* Error - detect module timeout */
   NAI_ERROR_SERDES_I2C_DEVICE_NOT_FOUND              = -0x820E, /* Error - I2C device not found */
   NAI_ERROR_SERDES_UNABLE_TO_LOCK_MUTEX              = -0x820F, /* Error - unable to lock mutex */
   NAI_ERROR_SERDES_UNABLE_TO_UNLOCK_MUTEX            = -0x8210, /* Error - unable to unlock mutex */
 
} nai_status_t;
enum nai_intf
{
   NAI_INTF_VME     = 0x00,
   NAI_INTF_ETHER   = 0x01,
   NAI_INTF_PCI     = 0x02,
   NAI_INTF_PROC    = 0x03,
   NAI_INTF_I2C     = 0x08,
   NAI_INTF_ONBOARD = 0xFF
};
typedef uint8_t nai_intf_t;
enum nai_maskreg_op
{
   NAI_MASKREG_OP_CLEAR    = 0x0000,
   NAI_MASKREG_OP_SET      = 0x0001,
   NAI_MASKREG_OP_TOGGLE   = 0x0002
};
typedef uint32_t nai_maskreg_op_t;