RA Flexible Software Package Documentation  Release v4.1.0

 
Common Error Codes

Detailed Description

All FSP modules share these common error codes.

Macros

#define FSP_PARAMETER_NOT_USED(p)
 
#define FSP_CPP_HEADER
 
#define FSP_HEADER
 
#define FSP_SECURE_ARGUMENT
 

Enumerations

enum  fsp_err_t
 

Macro Definition Documentation

◆ FSP_PARAMETER_NOT_USED

#define FSP_PARAMETER_NOT_USED (   p)

This macro is used to suppress compiler messages about a parameter not being used in a function. The nice thing about using this implementation is that it does not take any extra RAM or ROM.

◆ FSP_CPP_HEADER

#define FSP_CPP_HEADER

Determine if a C++ compiler is being used. If so, ensure that standard C is used to process the API information.

◆ FSP_HEADER

#define FSP_HEADER

FSP Header and Footer definitions

◆ FSP_SECURE_ARGUMENT

#define FSP_SECURE_ARGUMENT

Macro to be used when argument to function is ignored since function call is NSC and the parameter is statically defined on the Secure side.

Enumeration Type Documentation

◆ fsp_err_t

enum fsp_err_t

Common error codes

Enumerator
FSP_ERR_ASSERTION 

A critical assertion has failed.

FSP_ERR_INVALID_POINTER 

Pointer points to invalid memory location.

FSP_ERR_INVALID_ARGUMENT 

Invalid input parameter.

FSP_ERR_INVALID_CHANNEL 

Selected channel does not exist.

FSP_ERR_INVALID_MODE 

Unsupported or incorrect mode.

FSP_ERR_UNSUPPORTED 

Selected mode not supported by this API.

FSP_ERR_NOT_OPEN 

Requested channel is not configured or API not open.

FSP_ERR_IN_USE 

Channel/peripheral is running/busy.

FSP_ERR_OUT_OF_MEMORY 

Allocate more memory in the driver's cfg.h.

FSP_ERR_HW_LOCKED 

Hardware is locked.

FSP_ERR_IRQ_BSP_DISABLED 

IRQ not enabled in BSP.

FSP_ERR_OVERFLOW 

Hardware overflow.

FSP_ERR_UNDERFLOW 

Hardware underflow.

FSP_ERR_ALREADY_OPEN 

Requested channel is already open in a different configuration.

FSP_ERR_APPROXIMATION 

Could not set value to exact result.

FSP_ERR_CLAMPED 

Value had to be limited for some reason.

FSP_ERR_INVALID_RATE 

Selected rate could not be met.

FSP_ERR_ABORTED 

An operation was aborted.

FSP_ERR_NOT_ENABLED 

Requested operation is not enabled.

FSP_ERR_TIMEOUT 

Timeout error.

FSP_ERR_INVALID_BLOCKS 

Invalid number of blocks supplied.

FSP_ERR_INVALID_ADDRESS 

Invalid address supplied.

FSP_ERR_INVALID_SIZE 

Invalid size/length supplied for operation.

FSP_ERR_WRITE_FAILED 

Write operation failed.

FSP_ERR_ERASE_FAILED 

Erase operation failed.

FSP_ERR_INVALID_CALL 

Invalid function call is made.

FSP_ERR_INVALID_HW_CONDITION 

Detected hardware is in invalid condition.

FSP_ERR_INVALID_FACTORY_FLASH 

Factory flash is not available on this MCU.

FSP_ERR_INVALID_STATE 

API or command not valid in the current state.

FSP_ERR_NOT_ERASED 

Erase verification failed.

FSP_ERR_SECTOR_RELEASE_FAILED 

Sector release failed.

FSP_ERR_NOT_INITIALIZED 

Required initialization not complete.

FSP_ERR_NOT_FOUND 

The requested item could not be found.

FSP_ERR_NO_CALLBACK_MEMORY 

Non-secure callback memory not provided for non-secure callback.

FSP_ERR_BUFFER_EMPTY 

No data available in buffer.

FSP_ERR_INVALID_DATA 

Accuracy of data is not guaranteed.

FSP_ERR_INTERNAL 

Internal error.

FSP_ERR_WAIT_ABORTED 

Wait aborted.

FSP_ERR_FRAMING 

Framing error occurs.

FSP_ERR_BREAK_DETECT 

Break signal detects.

FSP_ERR_PARITY 

Parity error occurs.

FSP_ERR_RXBUF_OVERFLOW 

Receive queue overflow.

FSP_ERR_QUEUE_UNAVAILABLE 

Can't open s/w queue.

FSP_ERR_INSUFFICIENT_SPACE 

Not enough space in transmission circular buffer.

FSP_ERR_INSUFFICIENT_DATA 

Not enough data in receive circular buffer.

FSP_ERR_TRANSFER_ABORTED 

The data transfer was aborted.

FSP_ERR_MODE_FAULT 

Mode fault error.

FSP_ERR_READ_OVERFLOW 

Read overflow.

FSP_ERR_SPI_PARITY 

Parity error.

FSP_ERR_OVERRUN 

Overrun error.

FSP_ERR_CLOCK_INACTIVE 

Inactive clock specified as system clock.

FSP_ERR_CLOCK_ACTIVE 

Active clock source cannot be modified without stopping first.

FSP_ERR_NOT_STABILIZED 

Clock has not stabilized after its been turned on/off.

FSP_ERR_PLL_SRC_INACTIVE 

PLL initialization attempted when PLL source is turned off.

FSP_ERR_OSC_STOP_DET_ENABLED 

Illegal attempt to stop LOCO when Oscillation stop is enabled.

FSP_ERR_OSC_STOP_DETECTED 

The Oscillation stop detection status flag is set.

FSP_ERR_OSC_STOP_CLOCK_ACTIVE 

Attempt to clear Oscillation Stop Detect Status with PLL/MAIN_OSC active.

FSP_ERR_CLKOUT_EXCEEDED 

Output on target output clock pin exceeds maximum supported limit.

FSP_ERR_USB_MODULE_ENABLED 

USB clock configure request with USB Module enabled.

FSP_ERR_HARDWARE_TIMEOUT 

A register read or write timed out.

FSP_ERR_LOW_VOLTAGE_MODE 

Invalid clock setting attempted in low voltage mode.

FSP_ERR_PE_FAILURE 

Unable to enter Programming mode.

FSP_ERR_CMD_LOCKED 

Peripheral in command locked state.

FSP_ERR_FCLK 

FCLK must be >= 4 MHz.

FSP_ERR_INVALID_LINKED_ADDRESS 

Function or data are linked at an invalid region of memory.

FSP_ERR_BLANK_CHECK_FAILED 

Blank check operation failed.

FSP_ERR_INVALID_CAC_REF_CLOCK 

Measured clock rate < reference clock rate.

FSP_ERR_INVALID_RESULT 

The result of one or more calculations was +/- infinity.

FSP_ERR_CLOCK_GENERATION 

Clock cannot be specified as system clock.

FSP_ERR_INVALID_TIMING_SETTING 

Invalid timing parameter.

FSP_ERR_INVALID_LAYER_SETTING 

Invalid layer parameter.

FSP_ERR_INVALID_ALIGNMENT 

Invalid memory alignment found.

FSP_ERR_INVALID_GAMMA_SETTING 

Invalid gamma correction parameter.

FSP_ERR_INVALID_LAYER_FORMAT 

Invalid color format in layer.

FSP_ERR_INVALID_UPDATE_TIMING 

Invalid timing for register update.

FSP_ERR_INVALID_CLUT_ACCESS 

Invalid access to CLUT entry.

FSP_ERR_INVALID_FADE_SETTING 

Invalid fade-in/fade-out setting.

FSP_ERR_INVALID_BRIGHTNESS_SETTING 

Invalid gamma correction parameter.

FSP_ERR_JPEG_ERR 

JPEG error.

FSP_ERR_JPEG_SOI_NOT_DETECTED 

SOI not detected until EOI detected.

FSP_ERR_JPEG_SOF1_TO_SOFF_DETECTED 

SOF1 to SOFF detected.

FSP_ERR_JPEG_UNSUPPORTED_PIXEL_FORMAT 

Unprovided pixel format detected.

FSP_ERR_JPEG_SOF_ACCURACY_ERROR 

SOF accuracy error: other than 8 detected.

FSP_ERR_JPEG_DQT_ACCURACY_ERROR 

DQT accuracy error: other than 0 detected.

FSP_ERR_JPEG_COMPONENT_ERROR1 

Component error 1: the number of SOF0 header components detected is other than 1, 3, or 4.

FSP_ERR_JPEG_COMPONENT_ERROR2 

Component error 2: the number of components differs between SOF0 header and SOS.

FSP_ERR_JPEG_SOF0_DQT_DHT_NOT_DETECTED 

SOF0, DQT, and DHT not detected when SOS detected.

FSP_ERR_JPEG_SOS_NOT_DETECTED 

SOS not detected: SOS not detected until EOI detected.

FSP_ERR_JPEG_EOI_NOT_DETECTED 

EOI not detected (default)

FSP_ERR_JPEG_RESTART_INTERVAL_DATA_NUMBER_ERROR 

Restart interval data number error detected.

FSP_ERR_JPEG_IMAGE_SIZE_ERROR 

Image size error detected.

FSP_ERR_JPEG_LAST_MCU_DATA_NUMBER_ERROR 

Last MCU data number error detected.

FSP_ERR_JPEG_BLOCK_DATA_NUMBER_ERROR 

Block data number error detected.

FSP_ERR_JPEG_BUFFERSIZE_NOT_ENOUGH 

User provided buffer size not enough.

FSP_ERR_JPEG_UNSUPPORTED_IMAGE_SIZE 

JPEG Image size is not aligned with MCU.

FSP_ERR_CALIBRATE_FAILED 

Calibration failed.

FSP_ERR_IIRFA_ECC_1BIT 

1-bit ECC error detected

FSP_ERR_IIRFA_ECC_2BIT 

2-bit ECC error detected

FSP_ERR_IP_HARDWARE_NOT_PRESENT 

Requested IP does not exist on this device.

FSP_ERR_IP_UNIT_NOT_PRESENT 

Requested unit does not exist on this device.

FSP_ERR_IP_CHANNEL_NOT_PRESENT 

Requested channel does not exist on this device.

FSP_ERR_NO_MORE_BUFFER 

No more buffer found in the memory block pool.

FSP_ERR_ILLEGAL_BUFFER_ADDRESS 

Buffer address is out of block memory pool.

FSP_ERR_INVALID_WORKBUFFER_SIZE 

Work buffer size is invalid.

FSP_ERR_INVALID_MSG_BUFFER_SIZE 

Message buffer size is invalid.

FSP_ERR_TOO_MANY_BUFFERS 

Number of buffer is too many.

FSP_ERR_NO_SUBSCRIBER_FOUND 

No message subscriber found.

FSP_ERR_MESSAGE_QUEUE_EMPTY 

No message found in the message queue.

FSP_ERR_MESSAGE_QUEUE_FULL 

No room for new message in the message queue.

FSP_ERR_ILLEGAL_SUBSCRIBER_LISTS 

Message subscriber lists is illegal.

FSP_ERR_BUFFER_RELEASED 

Buffer has been released.

FSP_ERR_D2D_ERROR_INIT 

D/AVE 2D has an error in the initialization.

FSP_ERR_D2D_ERROR_DEINIT 

D/AVE 2D has an error in the initialization.

FSP_ERR_D2D_ERROR_RENDERING 

D/AVE 2D has an error in the rendering.

FSP_ERR_D2D_ERROR_SIZE 

D/AVE 2D has an error in the rendering.

FSP_ERR_ETHER_ERROR_NO_DATA 

No Data in Receive buffer.

FSP_ERR_ETHER_ERROR_LINK 

ETHERC/EDMAC has an error in the Auto-negotiation.

FSP_ERR_ETHER_ERROR_MAGIC_PACKET_MODE 

As a Magic Packet is being detected, and transmission/reception is not enabled.

FSP_ERR_ETHER_ERROR_TRANSMIT_BUFFER_FULL 

Transmit buffer is not empty.

FSP_ERR_ETHER_ERROR_FILTERING 

Detect multicast frame when multicast frame filtering enable.

FSP_ERR_ETHER_ERROR_PHY_COMMUNICATION 

ETHERC/EDMAC has an error in the phy communication.

FSP_ERR_ETHER_RECEIVE_BUFFER_ACTIVE 

Receive buffer is active.

FSP_ERR_ETHER_PHY_ERROR_LINK 

PHY is not link up.

FSP_ERR_ETHER_PHY_NOT_READY 

PHY has an error in the Auto-negotiation.

FSP_ERR_QUEUE_FULL 

Queue is full, cannot queue another data.

FSP_ERR_QUEUE_EMPTY 

Queue is empty, no data to dequeue.

FSP_ERR_CTSU_SCANNING 

Scanning.

FSP_ERR_CTSU_NOT_GET_DATA 

Not processed previous scan data.

FSP_ERR_CTSU_INCOMPLETE_TUNING 

Incomplete initial offset tuning.

FSP_ERR_CTSU_DIAG_NOT_YET 

Diagnosis of data collected no yet.

FSP_ERR_CTSU_DIAG_LDO_OVER_VOLTAGE 

Diagnosis of LDO over voltage failed.

FSP_ERR_CTSU_DIAG_CCO_HIGH 

Diagnosis of CCO into 19.2uA failed.

FSP_ERR_CTSU_DIAG_CCO_LOW 

Diagnosis of CCO into 2.4uA failed.

FSP_ERR_CTSU_DIAG_SSCG 

Diagnosis of SSCG frequency failed.

FSP_ERR_CTSU_DIAG_DAC 

Diagnosis of non-touch count value failed.

FSP_ERR_CTSU_DIAG_OUTPUT_VOLTAGE 

Diagnosis of LDO output voltage failed.

FSP_ERR_CTSU_DIAG_OVER_VOLTAGE 

Diagnosis of over voltage detection circuit failed.

FSP_ERR_CTSU_DIAG_OVER_CURRENT 

Diagnosis of over current detection circuit failed.

FSP_ERR_CTSU_DIAG_LOAD_RESISTANCE 

Diagnosis of LDO internal resistance value failed.

FSP_ERR_CTSU_DIAG_CURRENT_SOURCE 

Diagnosis of Current source value failed.

FSP_ERR_CTSU_DIAG_SENSCLK_GAIN 

Diagnosis of SENSCLK frequency gain failed.

FSP_ERR_CTSU_DIAG_SUCLK_GAIN 

Diagnosis of SUCLK frequency gain failed.

FSP_ERR_CTSU_DIAG_CLOCK_RECOVERY 

Diagnosis of SUCLK clock recovery function failed.

FSP_ERR_CTSU_DIAG_CFC_GAIN 

Diagnosis of CFC oscillator gain failed.

FSP_ERR_CARD_INIT_FAILED 

SD card or eMMC device failed to initialize.

FSP_ERR_CARD_NOT_INSERTED 

SD card not installed.

FSP_ERR_DEVICE_BUSY 

Device is holding DAT0 low or another operation is ongoing.

FSP_ERR_CARD_NOT_INITIALIZED 

SD card was removed.

FSP_ERR_CARD_WRITE_PROTECTED 

Media is write protected.

FSP_ERR_TRANSFER_BUSY 

Transfer in progress.

FSP_ERR_RESPONSE 

Card did not respond or responded with an error.

FSP_ERR_MEDIA_FORMAT_FAILED 

Media format failed.

FSP_ERR_MEDIA_OPEN_FAILED 

Media open failed.

FSP_ERR_CAN_DATA_UNAVAILABLE 

No data available.

FSP_ERR_CAN_MODE_SWITCH_FAILED 

Switching operation modes failed.

FSP_ERR_CAN_INIT_FAILED 

Hardware initialization failed.

FSP_ERR_CAN_TRANSMIT_NOT_READY 

Transmit in progress.

FSP_ERR_CAN_RECEIVE_MAILBOX 

Mailbox is setup as a receive mailbox.

FSP_ERR_CAN_TRANSMIT_MAILBOX 

Mailbox is setup as a transmit mailbox.

FSP_ERR_CAN_MESSAGE_LOST 

Receive message has been overwritten or overrun.

FSP_ERR_CAN_TRANSMIT_FIFO_FULL 

Transmit FIFO is full.

FSP_ERR_WIFI_CONFIG_FAILED 

WiFi module Configuration failed.

FSP_ERR_WIFI_INIT_FAILED 

WiFi module initialization failed.

FSP_ERR_WIFI_TRANSMIT_FAILED 

Transmission failed.

FSP_ERR_WIFI_INVALID_MODE 

API called when provisioned in client mode.

FSP_ERR_WIFI_FAILED 

WiFi Failed.

FSP_ERR_WIFI_SCAN_COMPLETE 

Wifi scan has completed.

FSP_ERR_WIFI_AP_NOT_CONNECTED 

WiFi module is not connected to access point.

FSP_ERR_CELLULAR_CONFIG_FAILED 

Cellular module Configuration failed.

FSP_ERR_CELLULAR_INIT_FAILED 

Cellular module initialization failed.

FSP_ERR_CELLULAR_TRANSMIT_FAILED 

Transmission failed.

FSP_ERR_CELLULAR_FW_UPTODATE 

Firmware is uptodate.

FSP_ERR_CELLULAR_FW_UPGRADE_FAILED 

Firmware upgrade failed.

FSP_ERR_CELLULAR_FAILED 

Cellular Failed.

FSP_ERR_CELLULAR_INVALID_STATE 

API Called in invalid state.

FSP_ERR_CELLULAR_REGISTRATION_FAILED 

Cellular Network registration failed.

FSP_ERR_BLE_FAILED 

BLE operation failed.

FSP_ERR_BLE_INIT_FAILED 

BLE device initialization failed.

FSP_ERR_BLE_CONFIG_FAILED 

BLE device configuration failed.

FSP_ERR_BLE_PRF_ALREADY_ENABLED 

BLE device Profile already enabled.

FSP_ERR_BLE_PRF_NOT_ENABLED 

BLE device not enabled.

FSP_ERR_BLE_ABS_INVALID_OPERATION 

Invalid operation is executed.

FSP_ERR_BLE_ABS_NOT_FOUND 

Valid data or free space is not found.

FSP_ERR_CRYPTO_CONTINUE 

Continue executing function.

FSP_ERR_CRYPTO_SCE_RESOURCE_CONFLICT 

Hardware resource busy.

FSP_ERR_CRYPTO_SCE_FAIL 

Internal I/O buffer is not empty.

FSP_ERR_CRYPTO_SCE_HRK_INVALID_INDEX 

Invalid index.

FSP_ERR_CRYPTO_SCE_RETRY 

Retry.

FSP_ERR_CRYPTO_SCE_VERIFY_FAIL 

Verify is failed.

FSP_ERR_CRYPTO_SCE_ALREADY_OPEN 

HW SCE module is already opened.

FSP_ERR_CRYPTO_NOT_OPEN 

Hardware module is not initialized.

FSP_ERR_CRYPTO_UNKNOWN 

Some unknown error occurred.

FSP_ERR_CRYPTO_NULL_POINTER 

Null pointer input as a parameter.

FSP_ERR_CRYPTO_NOT_IMPLEMENTED 

Algorithm/size not implemented.

FSP_ERR_CRYPTO_RNG_INVALID_PARAM 

An invalid parameter is specified.

FSP_ERR_CRYPTO_RNG_FATAL_ERROR 

A fatal error occurred.

FSP_ERR_CRYPTO_INVALID_SIZE 

Size specified is invalid.

FSP_ERR_CRYPTO_INVALID_STATE 

Function used in an valid state.

FSP_ERR_CRYPTO_ALREADY_OPEN 

control block is already opened

FSP_ERR_CRYPTO_INSTALL_KEY_FAILED 

Specified input key is invalid.

FSP_ERR_CRYPTO_AUTHENTICATION_FAILED 

Authentication failed.

FSP_ERR_CRYPTO_SCE_KEY_SET_FAIL 

Failure to Init Cipher.

FSP_ERR_CRYPTO_SCE_AUTHENTICATION 

Authentication failed.

FSP_ERR_CRYPTO_SCE_PARAMETER 

Input date is illegal.

FSP_ERR_CRYPTO_SCE_PROHIBIT_FUNCTION 

An invalid function call occurred.

FSP_ERR_CRYPTO_COMMON_NOT_OPENED 

Crypto Framework Common is not opened.

FSP_ERR_CRYPTO_HAL_ERROR 

Cryoto HAL module returned an error.

FSP_ERR_CRYPTO_KEY_BUF_NOT_ENOUGH 

Key buffer size is not enough to generate a key.

FSP_ERR_CRYPTO_BUF_OVERFLOW 

Attempt to write data larger than what the buffer can hold.

FSP_ERR_CRYPTO_INVALID_OPERATION_MODE 

Invalid operation mode.

FSP_ERR_MESSAGE_TOO_LONG 

Message for RSA encryption is too long.

FSP_ERR_RSA_DECRYPTION_ERROR 

RSA Decryption error.

FSP_ERR_SENSOR_INVALID_DATA 

Data is invalid.

Note
SF_CRYPTO APIs may return an error code starting from 0x10000 which is of Crypto module. Refer to sf_cryoto_err.h for Crypto error codes.
FSP_ERR_SENSOR_IN_STABILIZATION 

Sensor is stabilizing.

FSP_ERR_SENSOR_MEASUREMENT_NOT_FINISHED 

Measurement is not finished.

FSP_ERR_COMMS_BUS_NOT_OPEN 

Bus is not open.