1 /*
2 * Copyright (c) 2020 - 2024 Renesas Electronics Corporation and/or its affiliates
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6 
7 #ifndef FSP_COMMON_API_H
8 #define FSP_COMMON_API_H
9 
10 /***********************************************************************************************************************
11  * Includes
12  **********************************************************************************************************************/
13 #include <assert.h>
14 #include <stdint.h>
15 
16 /* Includes FSP version macros. */
17 #include "fsp_version.h"
18 
19 /*******************************************************************************************************************//**
20  * @ingroup RENESAS_COMMON
21  * @defgroup RENESAS_ERROR_CODES Common Error Codes
22  * All FSP modules share these common error codes.
23  * @{
24  **********************************************************************************************************************/
25 
26 /**********************************************************************************************************************
27  * Macro definitions
28  **********************************************************************************************************************/
29 
30 /** This macro is used to suppress compiler messages about a parameter not being used in a function. The nice thing
31  * about using this implementation is that it does not take any extra RAM or ROM. */
32 
33 #define FSP_PARAMETER_NOT_USED(p)    (void) ((p))
34 
35 /** Determine if a C++ compiler is being used.
36  * If so, ensure that standard C is used to process the API information.  */
37 #if defined(__cplusplus)
38  #define FSP_CPP_HEADER    extern "C" {
39  #define FSP_CPP_FOOTER    }
40 #else
41  #define FSP_CPP_HEADER
42  #define FSP_CPP_FOOTER
43 #endif
44 
45 /** FSP Header and Footer definitions */
46 #define FSP_HEADER             FSP_CPP_HEADER
47 #define FSP_FOOTER             FSP_CPP_FOOTER
48 
49 /** Macro to be used when argument to function is ignored since function call is NSC and the parameter is statically
50  *  defined on the Secure side. */
51 #define FSP_SECURE_ARGUMENT    (NULL)
52 
53 /**********************************************************************************************************************
54  * Typedef definitions
55  **********************************************************************************************************************/
56 
57 /** Common error codes */
58 typedef enum e_fsp_err
59 {
60     FSP_SUCCESS = 0,
61 
62     FSP_ERR_ASSERTION             = 1,                      ///< A critical assertion has failed
63     FSP_ERR_INVALID_POINTER       = 2,                      ///< Pointer points to invalid memory location
64     FSP_ERR_INVALID_ARGUMENT      = 3,                      ///< Invalid input parameter
65     FSP_ERR_INVALID_CHANNEL       = 4,                      ///< Selected channel does not exist
66     FSP_ERR_INVALID_MODE          = 5,                      ///< Unsupported or incorrect mode
67     FSP_ERR_UNSUPPORTED           = 6,                      ///< Selected mode not supported by this API
68     FSP_ERR_NOT_OPEN              = 7,                      ///< Requested channel is not configured or API not open
69     FSP_ERR_IN_USE                = 8,                      ///< Channel/peripheral is running/busy
70     FSP_ERR_OUT_OF_MEMORY         = 9,                      ///< Allocate more memory in the driver's cfg.h
71     FSP_ERR_HW_LOCKED             = 10,                     ///< Hardware is locked
72     FSP_ERR_IRQ_BSP_DISABLED      = 11,                     ///< IRQ not enabled in BSP
73     FSP_ERR_OVERFLOW              = 12,                     ///< Hardware overflow
74     FSP_ERR_UNDERFLOW             = 13,                     ///< Hardware underflow
75     FSP_ERR_ALREADY_OPEN          = 14,                     ///< Requested channel is already open in a different configuration
76     FSP_ERR_APPROXIMATION         = 15,                     ///< Could not set value to exact result
77     FSP_ERR_CLAMPED               = 16,                     ///< Value had to be limited for some reason
78     FSP_ERR_INVALID_RATE          = 17,                     ///< Selected rate could not be met
79     FSP_ERR_ABORTED               = 18,                     ///< An operation was aborted
80     FSP_ERR_NOT_ENABLED           = 19,                     ///< Requested operation is not enabled
81     FSP_ERR_TIMEOUT               = 20,                     ///< Timeout error
82     FSP_ERR_INVALID_BLOCKS        = 21,                     ///< Invalid number of blocks supplied
83     FSP_ERR_INVALID_ADDRESS       = 22,                     ///< Invalid address supplied
84     FSP_ERR_INVALID_SIZE          = 23,                     ///< Invalid size/length supplied for operation
85     FSP_ERR_WRITE_FAILED          = 24,                     ///< Write operation failed
86     FSP_ERR_ERASE_FAILED          = 25,                     ///< Erase operation failed
87     FSP_ERR_INVALID_CALL          = 26,                     ///< Invalid function call is made
88     FSP_ERR_INVALID_HW_CONDITION  = 27,                     ///< Detected hardware is in invalid condition
89     FSP_ERR_INVALID_FACTORY_FLASH = 28,                     ///< Factory flash is not available on this MCU
90     FSP_ERR_INVALID_STATE         = 30,                     ///< API or command not valid in the current state
91     FSP_ERR_NOT_ERASED            = 31,                     ///< Erase verification failed
92     FSP_ERR_SECTOR_RELEASE_FAILED = 32,                     ///< Sector release failed
93     FSP_ERR_NOT_INITIALIZED       = 33,                     ///< Required initialization not complete
94     FSP_ERR_NOT_FOUND             = 34,                     ///< The requested item could not be found
95     FSP_ERR_NO_CALLBACK_MEMORY    = 35,                     ///< Non-secure callback memory not provided for non-secure callback
96     FSP_ERR_BUFFER_EMPTY          = 36,                     ///< No data available in buffer
97 
98     /* Start of RTOS only error codes */
99     FSP_ERR_INTERNAL     = 100,                             ///< Internal error
100     FSP_ERR_WAIT_ABORTED = 101,                             ///< Wait aborted
101 
102     /* Start of UART specific */
103     FSP_ERR_FRAMING            = 200,                       ///< Framing error occurs
104     FSP_ERR_BREAK_DETECT       = 201,                       ///< Break signal detects
105     FSP_ERR_PARITY             = 202,                       ///< Parity error occurs
106     FSP_ERR_RXBUF_OVERFLOW     = 203,                       ///< Receive queue overflow
107     FSP_ERR_QUEUE_UNAVAILABLE  = 204,                       ///< Can't open s/w queue
108     FSP_ERR_INSUFFICIENT_SPACE = 205,                       ///< Not enough space in transmission circular buffer
109     FSP_ERR_INSUFFICIENT_DATA  = 206,                       ///< Not enough data in receive circular buffer
110 
111     /* Start of SPI specific */
112     FSP_ERR_TRANSFER_ABORTED = 300,                         ///< The data transfer was aborted.
113     FSP_ERR_MODE_FAULT       = 301,                         ///< Mode fault error.
114     FSP_ERR_READ_OVERFLOW    = 302,                         ///< Read overflow.
115     FSP_ERR_SPI_PARITY       = 303,                         ///< Parity error.
116     FSP_ERR_OVERRUN          = 304,                         ///< Overrun error.
117 
118     /* Start of CGC Specific */
119     FSP_ERR_CLOCK_INACTIVE        = 400,                    ///< Inactive clock specified as system clock.
120     FSP_ERR_CLOCK_ACTIVE          = 401,                    ///< Active clock source cannot be modified without stopping first.
121     FSP_ERR_NOT_STABILIZED        = 403,                    ///< Clock has not stabilized after its been turned on/off
122     FSP_ERR_PLL_SRC_INACTIVE      = 404,                    ///< PLL initialization attempted when PLL source is turned off
123     FSP_ERR_OSC_STOP_DET_ENABLED  = 405,                    ///< Illegal attempt to stop LOCO when Oscillation stop is enabled
124     FSP_ERR_OSC_STOP_DETECTED     = 406,                    ///< The Oscillation stop detection status flag is set
125     FSP_ERR_OSC_STOP_CLOCK_ACTIVE = 407,                    ///< Attempt to clear Oscillation Stop Detect Status with PLL/MAIN_OSC active
126     FSP_ERR_CLKOUT_EXCEEDED       = 408,                    ///< Output on target output clock pin exceeds maximum supported limit
127     FSP_ERR_USB_MODULE_ENABLED    = 409,                    ///< USB clock configure request with USB Module enabled
128     FSP_ERR_HARDWARE_TIMEOUT      = 410,                    ///< A register read or write timed out
129     FSP_ERR_LOW_VOLTAGE_MODE      = 411,                    ///< Invalid clock setting attempted in low voltage mode
130 
131     /* Start of FLASH Specific */
132     FSP_ERR_PE_FAILURE             = 500,                   ///< Unable to enter Programming mode.
133     FSP_ERR_CMD_LOCKED             = 501,                   ///< Peripheral in command locked state
134     FSP_ERR_FCLK                   = 502,                   ///< FCLK must be >= 4 MHz
135     FSP_ERR_INVALID_LINKED_ADDRESS = 503,                   ///< Function or data are linked at an invalid region of memory
136     FSP_ERR_BLANK_CHECK_FAILED     = 504,                   ///< Blank check operation failed
137 
138     /* Start of CAC Specific */
139     FSP_ERR_INVALID_CAC_REF_CLOCK = 600,                    ///< Measured clock rate < reference clock rate
140 
141     /* Start of GLCD Specific */
142     FSP_ERR_CLOCK_GENERATION           = 1000,              ///< Clock cannot be specified as system clock
143     FSP_ERR_INVALID_TIMING_SETTING     = 1001,              ///< Invalid timing parameter
144     FSP_ERR_INVALID_LAYER_SETTING      = 1002,              ///< Invalid layer parameter
145     FSP_ERR_INVALID_ALIGNMENT          = 1003,              ///< Invalid memory alignment found
146     FSP_ERR_INVALID_GAMMA_SETTING      = 1004,              ///< Invalid gamma correction parameter
147     FSP_ERR_INVALID_LAYER_FORMAT       = 1005,              ///< Invalid color format in layer
148     FSP_ERR_INVALID_UPDATE_TIMING      = 1006,              ///< Invalid timing for register update
149     FSP_ERR_INVALID_CLUT_ACCESS        = 1007,              ///< Invalid access to CLUT entry
150     FSP_ERR_INVALID_FADE_SETTING       = 1008,              ///< Invalid fade-in/fade-out setting
151     FSP_ERR_INVALID_BRIGHTNESS_SETTING = 1009,              ///< Invalid gamma correction parameter
152 
153     /* Start of JPEG Specific */
154     FSP_ERR_JPEG_ERR                                = 1100, ///< JPEG error
155     FSP_ERR_JPEG_SOI_NOT_DETECTED                   = 1101, ///< SOI not detected until EOI detected.
156     FSP_ERR_JPEG_SOF1_TO_SOFF_DETECTED              = 1102, ///< SOF1 to SOFF detected.
157     FSP_ERR_JPEG_UNSUPPORTED_PIXEL_FORMAT           = 1103, ///< Unprovided pixel format detected.
158     FSP_ERR_JPEG_SOF_ACCURACY_ERROR                 = 1104, ///< SOF accuracy error: other than 8 detected.
159     FSP_ERR_JPEG_DQT_ACCURACY_ERROR                 = 1105, ///< DQT accuracy error: other than 0 detected.
160     FSP_ERR_JPEG_COMPONENT_ERROR1                   = 1106, ///< Component error 1: the number of SOF0 header components detected is other than 1, 3, or 4.
161     FSP_ERR_JPEG_COMPONENT_ERROR2                   = 1107, ///< Component error 2: the number of components differs between SOF0 header and SOS.
162     FSP_ERR_JPEG_SOF0_DQT_DHT_NOT_DETECTED          = 1108, ///< SOF0, DQT, and DHT not detected when SOS detected.
163     FSP_ERR_JPEG_SOS_NOT_DETECTED                   = 1109, ///< SOS not detected: SOS not detected until EOI detected.
164     FSP_ERR_JPEG_EOI_NOT_DETECTED                   = 1110, ///< EOI not detected (default)
165     FSP_ERR_JPEG_RESTART_INTERVAL_DATA_NUMBER_ERROR = 1111, ///< Restart interval data number error detected.
166     FSP_ERR_JPEG_IMAGE_SIZE_ERROR                   = 1112, ///< Image size error detected.
167     FSP_ERR_JPEG_LAST_MCU_DATA_NUMBER_ERROR         = 1113, ///< Last MCU data number error detected.
168     FSP_ERR_JPEG_BLOCK_DATA_NUMBER_ERROR            = 1114, ///< Block data number error detected.
169     FSP_ERR_JPEG_BUFFERSIZE_NOT_ENOUGH              = 1115, ///< User provided buffer size not enough
170     FSP_ERR_JPEG_UNSUPPORTED_IMAGE_SIZE             = 1116, ///< JPEG Image size is not aligned with MCU
171 
172     /* Start of touch panel framework specific */
173     FSP_ERR_CALIBRATE_FAILED = 1200,                        ///< Calibration failed
174 
175     /* Start of IP specific */
176     FSP_ERR_IP_HARDWARE_NOT_PRESENT = 1400,                 ///< Requested IP does not exist on this device
177     FSP_ERR_IP_UNIT_NOT_PRESENT     = 1401,                 ///< Requested unit does not exist on this device
178     FSP_ERR_IP_CHANNEL_NOT_PRESENT  = 1402,                 ///< Requested channel does not exist on this device
179 
180     /* Start of USB specific */
181     FSP_ERR_USB_FAILED      = 1500,
182     FSP_ERR_USB_BUSY        = 1501,
183     FSP_ERR_USB_SIZE_SHORT  = 1502,
184     FSP_ERR_USB_SIZE_OVER   = 1503,
185     FSP_ERR_USB_NOT_OPEN    = 1504,
186     FSP_ERR_USB_NOT_SUSPEND = 1505,
187     FSP_ERR_USB_PARAMETER   = 1506,
188 
189     /* Start of Message framework specific */
190     FSP_ERR_NO_MORE_BUFFER           = 2000,         ///< No more buffer found in the memory block pool
191     FSP_ERR_ILLEGAL_BUFFER_ADDRESS   = 2001,         ///< Buffer address is out of block memory pool
192     FSP_ERR_INVALID_WORKBUFFER_SIZE  = 2002,         ///< Work buffer size is invalid
193     FSP_ERR_INVALID_MSG_BUFFER_SIZE  = 2003,         ///< Message buffer size is invalid
194     FSP_ERR_TOO_MANY_BUFFERS         = 2004,         ///< Number of buffer is too many
195     FSP_ERR_NO_SUBSCRIBER_FOUND      = 2005,         ///< No message subscriber found
196     FSP_ERR_MESSAGE_QUEUE_EMPTY      = 2006,         ///< No message found in the message queue
197     FSP_ERR_MESSAGE_QUEUE_FULL       = 2007,         ///< No room for new message in the message queue
198     FSP_ERR_ILLEGAL_SUBSCRIBER_LISTS = 2008,         ///< Message subscriber lists is illegal
199     FSP_ERR_BUFFER_RELEASED          = 2009,         ///< Buffer has been released
200 
201     /* Start of 2DG Driver specific */
202     FSP_ERR_D2D_ERROR_INIT      = 3000,              ///< D/AVE 2D has an error in the initialization
203     FSP_ERR_D2D_ERROR_DEINIT    = 3001,              ///< D/AVE 2D has an error in the initialization
204     FSP_ERR_D2D_ERROR_RENDERING = 3002,              ///< D/AVE 2D has an error in the rendering
205     FSP_ERR_D2D_ERROR_SIZE      = 3003,              ///< D/AVE 2D has an error in the rendering
206 
207     /* Start of ETHER Driver specific */
208     FSP_ERR_ETHER_ERROR_NO_DATA              = 4000, ///< No Data in Receive buffer.
209     FSP_ERR_ETHER_ERROR_LINK                 = 4001, ///< ETHERC/EDMAC has an error in the Auto-negotiation
210     FSP_ERR_ETHER_ERROR_MAGIC_PACKET_MODE    = 4002, ///< As a Magic Packet is being detected, and transmission/reception is not enabled
211     FSP_ERR_ETHER_ERROR_TRANSMIT_BUFFER_FULL = 4003, ///< Transmit buffer is not empty
212     FSP_ERR_ETHER_ERROR_FILTERING            = 4004, ///< Detect multicast frame when multicast frame filtering enable
213     FSP_ERR_ETHER_ERROR_PHY_COMMUNICATION    = 4005, ///< ETHERC/EDMAC has an error in the phy communication
214 
215     /* Start of ETHER_PHY Driver specific */
216     FSP_ERR_ETHER_PHY_ERROR_LINK = 5000,             ///< PHY is not link up.
217     FSP_ERR_ETHER_PHY_NOT_READY  = 5001,             ///< PHY has an error in the Auto-negotiation
218 
219     /* Start of BYTEQ library specific */
220     FSP_ERR_QUEUE_FULL  = 10000,                     ///< Queue is full, cannot queue another data
221     FSP_ERR_QUEUE_EMPTY = 10001,                     ///< Queue is empty, no data to dequeue
222 
223     /* Start of CTSU Driver specific */
224     FSP_ERR_CTSU_SCANNING          = 6000,           ///< Scanning.
225     FSP_ERR_CTSU_NOT_GET_DATA      = 6001,           ///< Not processed previous scan data.
226     FSP_ERR_CTSU_INCOMPLETE_TUNING = 6002,           ///< Incomplete initial offset tuning.
227 
228     /* Start of SDMMC specific */
229     FSP_ERR_CARD_INIT_FAILED     = 40000,            ///< SD card or eMMC device failed to initialize.
230     FSP_ERR_CARD_NOT_INSERTED    = 40001,            ///< SD card not installed.
231     FSP_ERR_DEVICE_BUSY          = 40002,            ///< Device is holding DAT0 low or another operation is ongoing.
232     FSP_ERR_CARD_NOT_INITIALIZED = 40004,            ///< SD card was removed.
233     FSP_ERR_CARD_WRITE_PROTECTED = 40005,            ///< Media is write protected.
234     FSP_ERR_TRANSFER_BUSY        = 40006,            ///< Transfer in progress.
235     FSP_ERR_RESPONSE             = 40007,            ///< Card did not respond or responded with an error.
236 
237     /* Start of FX_IO specific */
238     FSP_ERR_MEDIA_FORMAT_FAILED = 50000,             ///< Media format failed.
239     FSP_ERR_MEDIA_OPEN_FAILED   = 50001,             ///< Media open failed.
240 
241     /* Start of CAN specific */
242     FSP_ERR_CAN_DATA_UNAVAILABLE   = 60000,          ///< No data available.
243     FSP_ERR_CAN_MODE_SWITCH_FAILED = 60001,          ///< Switching operation modes failed.
244     FSP_ERR_CAN_INIT_FAILED        = 60002,          ///< Hardware initialization failed.
245     FSP_ERR_CAN_TRANSMIT_NOT_READY = 60003,          ///< Transmit in progress.
246     FSP_ERR_CAN_RECEIVE_MAILBOX    = 60004,          ///< Mailbox is setup as a receive mailbox.
247     FSP_ERR_CAN_TRANSMIT_MAILBOX   = 60005,          ///< Mailbox is setup as a transmit mailbox.
248     FSP_ERR_CAN_MESSAGE_LOST       = 60006,          ///< Receive message has been overwritten or overrun.
249 
250     /* Start of SF_WIFI Specific */
251     FSP_ERR_WIFI_CONFIG_FAILED   = 70000,            ///< WiFi module Configuration failed.
252     FSP_ERR_WIFI_INIT_FAILED     = 70001,            ///< WiFi module initialization failed.
253     FSP_ERR_WIFI_TRANSMIT_FAILED = 70002,            ///< Transmission failed
254     FSP_ERR_WIFI_INVALID_MODE    = 70003,            ///< API called when provisioned in client mode
255     FSP_ERR_WIFI_FAILED          = 70004,            ///< WiFi Failed.
256     FSP_ERR_WIFI_SCAN_COMPLETE   = 70005,            ///< Wifi scan has completed.
257 
258     /* Start of SF_CELLULAR Specific */
259     FSP_ERR_CELLULAR_CONFIG_FAILED       = 80000,    ///< Cellular module Configuration failed.
260     FSP_ERR_CELLULAR_INIT_FAILED         = 80001,    ///< Cellular module initialization failed.
261     FSP_ERR_CELLULAR_TRANSMIT_FAILED     = 80002,    ///< Transmission failed
262     FSP_ERR_CELLULAR_FW_UPTODATE         = 80003,    ///< Firmware is uptodate
263     FSP_ERR_CELLULAR_FW_UPGRADE_FAILED   = 80004,    ///< Firmware upgrade failed
264     FSP_ERR_CELLULAR_FAILED              = 80005,    ///< Cellular Failed.
265     FSP_ERR_CELLULAR_INVALID_STATE       = 80006,    ///< API Called in invalid state.
266     FSP_ERR_CELLULAR_REGISTRATION_FAILED = 80007,    ///< Cellular Network registration failed
267 
268     /* Start of SF_BLE specific */
269     FSP_ERR_BLE_FAILED              = 90001,         ///< BLE operation failed
270     FSP_ERR_BLE_INIT_FAILED         = 90002,         ///< BLE device initialization failed
271     FSP_ERR_BLE_CONFIG_FAILED       = 90003,         ///< BLE device configuration failed
272     FSP_ERR_BLE_PRF_ALREADY_ENABLED = 90004,         ///< BLE device Profile already enabled
273     FSP_ERR_BLE_PRF_NOT_ENABLED     = 90005,         ///< BLE device not enabled
274 
275     /* Start of SF_BLE_ABS specific */
276     FSP_ERR_BLE_ABS_INVALID_OPERATION = 91001,       ///< Invalid operation is executed.
277     FSP_ERR_BLE_ABS_NOT_FOUND         = 91002,       ///< Valid data or free space is not found.
278 
279     /* Start of Crypto specific (0x10000) @note Refer to sf_cryoto_err.h for Crypto error code. */
280     FSP_ERR_CRYPTO_CONTINUE              = 0x10000,  ///< Continue executing function
281     FSP_ERR_CRYPTO_SCE_RESOURCE_CONFLICT = 0x10001,  ///< Hardware resource busy
282     FSP_ERR_CRYPTO_SCE_FAIL              = 0x10002,  ///< Internal I/O buffer is not empty
283     FSP_ERR_CRYPTO_SCE_HRK_INVALID_INDEX = 0x10003,  ///< Invalid index
284     FSP_ERR_CRYPTO_SCE_RETRY             = 0x10004,  ///< Retry
285     FSP_ERR_CRYPTO_SCE_VERIFY_FAIL       = 0x10005,  ///< Verify is failed
286     FSP_ERR_CRYPTO_SCE_ALREADY_OPEN      = 0x10006,  ///< HW SCE module is already opened
287     FSP_ERR_CRYPTO_NOT_OPEN              = 0x10007,  ///< Hardware module is not initialized
288     FSP_ERR_CRYPTO_UNKNOWN               = 0x10008,  ///< Some unknown error occurred
289     FSP_ERR_CRYPTO_NULL_POINTER          = 0x10009,  ///< Null pointer input as a parameter
290     FSP_ERR_CRYPTO_NOT_IMPLEMENTED       = 0x1000a,  ///< Algorithm/size not implemented
291     FSP_ERR_CRYPTO_RNG_INVALID_PARAM     = 0x1000b,  ///< An invalid parameter is specified
292     FSP_ERR_CRYPTO_RNG_FATAL_ERROR       = 0x1000c,  ///< A fatal error occurred
293     FSP_ERR_CRYPTO_INVALID_SIZE          = 0x1000d,  ///< Size specified is invalid
294     FSP_ERR_CRYPTO_INVALID_STATE         = 0x1000e,  ///< Function used in an valid state
295     FSP_ERR_CRYPTO_ALREADY_OPEN          = 0x1000f,  ///< control block is already opened
296     FSP_ERR_CRYPTO_INSTALL_KEY_FAILED    = 0x10010,  ///< Specified input key is invalid.
297     FSP_ERR_CRYPTO_AUTHENTICATION_FAILED = 0x10011,  ///< Authentication failed
298     FSP_ERR_CRYPTO_SCE_KEY_SET_FAIL      = 0x10012,  ///< Failure to Init Cipher
299     FSP_ERR_CRYPTO_SCE_AUTHENTICATION    = 0x10013,
300 
301     /* Start of SF_CRYPTO specific */
302     FSP_ERR_CRYPTO_COMMON_NOT_OPENED      = 0x20000, ///< Crypto Framework Common is not opened
303     FSP_ERR_CRYPTO_HAL_ERROR              = 0x20001, ///< Cryoto HAL module returned an error
304     FSP_ERR_CRYPTO_KEY_BUF_NOT_ENOUGH     = 0x20002, ///< Key buffer size is not enough to generate a key
305     FSP_ERR_CRYPTO_BUF_OVERFLOW           = 0x20003, ///< Attempt to write data larger than what the buffer can hold
306     FSP_ERR_CRYPTO_INVALID_OPERATION_MODE = 0x20004, ///< Invalid operation mode.
307     FSP_ERR_MESSAGE_TOO_LONG              = 0x20005, ///< Message for RSA encryption is too long.
308     FSP_ERR_RSA_DECRYPTION_ERROR          = 0x20006, ///< RSA Decryption error.
309 
310     /** @note SF_CRYPTO APIs may return an error code starting from 0x10000 which is of Crypto module.
311      *        Refer to sf_cryoto_err.h for Crypto error codes.
312      */
313 
314     /* Start of Sensor specific */
315     FSP_ERR_SENSOR_INVALID_DATA             = 0x30000, ///< Data is invalid.
316     FSP_ERR_SENSOR_IN_STABILIZATION         = 0x30001, ///< Sensor is stabilizing.
317     FSP_ERR_SENSOR_MEASUREMENT_NOT_FINISHED = 0x30002, ///< Measurement is not finished.
318 
319     /* Start of COMMS specific */
320     FSP_ERR_COMMS_BUS_NOT_OPEN = 0x40000,              ///< Bus is not open.
321 } fsp_err_t;
322 
323 /** Common version structure */
324 typedef union st_fsp_version
325 {
326     /** Version id */
327     uint32_t version_id;
328 
329     /** Code version parameters */
330     struct
331     {
332         uint8_t code_version_minor;    ///< Code minor version
333         uint8_t code_version_major;    ///< Code major version
334         uint8_t api_version_minor;     ///< API minor version
335         uint8_t api_version_major;     ///< API major version
336     };
337 } fsp_version_t;
338 
339 /** @} */
340 
341 /***********************************************************************************************************************
342  * Function prototypes
343  **********************************************************************************************************************/
344 
345 #endif
346