hal_efuse.h File Reference

Header file containing functions prototypes of eFuse HAL library. More...

#include "hal_def.h"
#include "ll_efuse.h"

Go to the source code of this file.

Classes

struct  _efuse_handle
 eFuse handle Structure definition More...
 
struct  _hal_efuse_callback
 HAL_EFUSE Callback function definition. More...
 

Macros

#define HAL_EFUSE_ERROR_NONE   ((uint32_t)0x00000000)
 
#define HAL_EFUSE_ERROR_TIMEOUT   ((uint32_t)0x00000001)
 
#define HAL_EFUSE_ERROR_INVALID_PARAM   ((uint32_t)0x00000002)
 
#define EFUSE_FLAG_INIT_CHECK_DONE   LL_EFUSE_INIT_CHECK_DONE
 
#define EFUSE_FLAG_INIT_CHECK_SUCCESS   LL_EFUSE_INIT_CHECK_SUCCESS
 
#define EFUSE_FLAG_WRITE_DONE   LL_EFUSE_WRITE_DONE
 
#define EFUSE_LAYOUT_UID_FAB   (0x00)
 
#define EFUSE_LAYOUT_UID_YEAR   (0x03)
 
#define EFUSE_LAYOUT_UID_MON   (0x04)
 
#define EFUSE_LAYOUT_UID_LOT_ID   (0x05)
 
#define EFUSE_LAYOUT_UID_WAFER_ID   (0x0D)
 
#define EFUSE_LAYOUT_UID_WAFER_X   (0x0E)
 
#define EFUSE_LAYOUT_UID_WAFER_Y   (0x0F)
 
#define EFUSE_LAYOUT_FLASH_SE_ADDR1   (0x10)
 
#define EFUSE_LAYOUT_FLASH_SE_ADDR2   (0x14)
 
#define EFUSE_LAYOUT_USER_START   (0x18)
 
#define EFUSE_LAYOUT_USER_END   (0x1F)
 
#define __HAL_EFUSE_ENABLE_PGENB(__HANDLE__)   ll_efuse_enable_pgenb((__HANDLE__)->p_instance)
 Enable the eFuse PGENB. More...
 
#define __HAL_EFUSE_DISABLE_PGENB(__HANDLE__)   ll_efuse_disable_pgenb((__HANDLE__)->p_instance)
 Disable the eFuse PGENB. More...
 
#define __HAL_EFUSE_GET_FLAG(__HANDLE__, __FLAG__)   ((READ_BITS((__HANDLE__)->p_instance->STAT, (__FLAG__)) != 0) ? SET : RESET)
 Check whether the specified eFuse flag is set or not. More...
 

Typedefs

typedef struct _efuse_handle efuse_handle_t
 eFuse handle Structure definition More...
 
typedef struct _hal_efuse_callback hal_efuse_callback_t
 HAL_EFUSE Callback function definition. More...
 

Enumerations

enum  hal_efuse_state_t {
  HAL_EFUSE_STATE_RESET = 0x00,
  HAL_EFUSE_STATE_READY = 0x01,
  HAL_EFUSE_STATE_BUSY = 0x02,
  HAL_EFUSE_STATE_ERROR = 0x04
}
 HAL eFuse State Enumerations definition. More...
 

Functions

hal_status_t hal_efuse_init (efuse_handle_t *p_efuse)
 Initialize the eFuse according to the specified parameters in the efuse_init_t and initialize the associated handle. More...
 
hal_status_t hal_efuse_deinit (efuse_handle_t *p_efuse)
 De-initialize the eFuse peripheral. More...
 
void hal_efuse_msp_init (efuse_handle_t *p_efuse)
 Initialize the eFuse MSP. More...
 
void hal_efuse_msp_deinit (efuse_handle_t *p_efuse)
 De-initialize the eFuse MSP. More...
 
hal_status_t hal_efuse_write (efuse_handle_t *p_efuse, uint32_t word_offset, const uint32_t *p_data, uint32_t nword)
 Write the eFuse memory data. More...
 
hal_status_t hal_efuse_read (efuse_handle_t *p_efuse, uint32_t word_offset, uint32_t *p_data, uint32_t nword)
 Read the eFuse memory data. More...
 
hal_status_t hal_efuse_initial_value_check (efuse_handle_t *p_efuse)
 Check the eFuse memory with 0, if memory are all 0, return HAL_OK, then return HAL_ERROR. More...
 

Detailed Description

Header file containing functions prototypes of eFuse HAL library.

Author
BLE Driver Team
Attention
#####Copyright (c) 2019 GOODIX All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file hal_efuse.h.