iot_efuse.h

Go to the documentation of this file.

/*
 * FreeRTOS Common IO V1.0.0
 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef _IOT_EFUSE_H_
#define _IOT_EFUSE_H_

#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 )      
struct                      IotEfuseDescriptor;

typedef struct IotEfuseDescriptor * IotEfuseHandle_t;

IotEfuseHandle_t iot_efuse_open( void );

int32_t iot_efuse_close( IotEfuseHandle_t const pxEfuseHandle );

int32_t iot_efuse_read_32bit_word( IotEfuseHandle_t const pxEfuseHandle,
                                   uint32_t ulIndex,
                                   uint32_t * ulValue );

int32_t iot_efuse_write_32bit_word( IotEfuseHandle_t const pxEfuseHandle,
                                    uint32_t ulIndex,
                                    uint32_t ulValue );

int32_t iot_efuse_read_16bit_word( IotEfuseHandle_t const pxEfuseHandle,
                                   uint32_t ulIndex,
                                   uint16_t * ulValue );

int32_t iot_efuse_write_16bit_word( IotEfuseHandle_t const pxEfuseHandle,
                                    uint32_t ulIndex,
                                    uint16_t value );

/* end of group iot_efuse */

#endif /* ifndef _IOT_EFUSE_H_ */