FreeRTOS: Common I/O
AWS IoT Common I/O library
Return to main page ↑
iot_efuse.h File Reference

File for the APIs of efuse called by application layer. More...

Go to the source code of this file.

Macros

#define IOT_EFUSE_SUCCESS   ( 0 )
 
#define IOT_EFUSE_INVALID_VALUE   ( 1 )
 
#define IOT_EFUSE_READ_FAIL   ( 2 )
 
#define IOT_EFUSE_WRITE_FAIL   ( 3 )
 
#define IOT_EFUSE_CLOSE_FAIL   ( 4 )
 
#define IOT_EFUSE_FUNCTION_NOT_SUPPORTED   ( 5 )
 
#define IOT_EFUSE_ERROR   ( 6 )
 

Typedefs

typedef struct IotEfuseDescriptor * IotEfuseHandle_t
 IotEfuseHandle_t is the handle type returned by calling iot_efuse_open(). This is initialized in open and returned to caller. The caller must pass this pointer to the rest of APIs.
 

Functions

IotEfuseHandle_t iot_efuse_open (void)
 iot_efuse_open is used to Initialize things needed to access efuse. More...
 
int32_t iot_efuse_close (IotEfuseHandle_t const pxEfuseHandle)
 iot_efuse_close is used to de Initialize things needed to disable efuse access. More...
 
int32_t iot_efuse_read_32bit_word (IotEfuseHandle_t const pxEfuseHandle, uint32_t ulIndex, uint32_t *ulValue)
 Read 32-bit efuse word from specified index. More...
 
int32_t iot_efuse_write_32bit_word (IotEfuseHandle_t const pxEfuseHandle, uint32_t ulIndex, uint32_t ulValue)
 Write 32-bit value to the 32-bit efuse word at specified index. More...
 
int32_t iot_efuse_read_16bit_word (IotEfuseHandle_t const pxEfuseHandle, uint32_t ulIndex, uint16_t *ulValue)
 Read 16-bit efuse word from specified index. More...
 
int32_t iot_efuse_write_16bit_word (IotEfuseHandle_t const pxEfuseHandle, uint32_t ulIndex, uint16_t value)
 Write 16-bit value to the 16-bit efuse word at specified index. More...
 

Detailed Description

File for the APIs of efuse called by application layer.