RL-ARM User's Guide

Errors

The RL-CAN library routines return one of the following error constants to indicate status.

  • CAN_OK
    Indicates the function completed successfully without error.
  • CAN_NOT_IMPLEMENTED_ERROR
    Indicates the function is not implemented.
  • CAN_MEM_POOL_INIT_ERROR
    Indicates that the memory pool used for software message buffers did not initialize successfully.
  • CAN_BAUDRATE_ERROR
    Indicates that the communication speed was incorrectly initialized.
  • CAN_TX_BUSY_ERROR
    Indicates that the transmit hardware is busy.
  • CAN_OBJECTS_FULL_ERROR
    Indicates that no more transmit or receive objects may be defined.
  • CAN_ALLOC_MEM_ERROR
    Indicates there is no available memory in the CAN memory pool.
  • CAN_DEALLOC_MEM_ERROR
    Indicates that the memory used by the transmitted or received message was not correctly deallocated.
  • CAN_TIMEOUT_ERROR
    Indicates that the timeout expired before a message was transmitted.
  • CAN_UNEXIST_CTRL_ERROR
    Indicates that the requested CAN controller does not exist.
  • CAN_UNEXIST_CH_ERROR
    Indicates that the requested CAN channel does not exist.

If the function completes successfully and without error, CAN_OK is returned.

Note

  • CAN error codes are defined as an enumerated CAN_ERROR type in RTX_CAN.h.