nrfx 4.5.0
Loading...
Searching...
No Matches
Macros | Functions
FICR HAL
Drivers » ICR

Hardware access layer (HAL) for getting data from the Factory Information Configuration Registers (FICR). More...

Macros

#define NRF_FICR_HAS_CODE_PAGE_SIZE   1
 Symbol indicating whether FICR CODEPAGESIZE register is present.
 
#define NRF_FICR_HAS_INFO_CODE_PAGE_SIZE   1
 Symbol indicating whether FICR INFO.CODEPAGESIZE register is present.
 
#define NRF_FICR_HAS_CODE_SIZE   1
 Symbol indicating whether FICR CODESIZE register is present.
 
#define NRF_FICR_HAS_INFO_CODE_SIZE   1
 Symbol indicating whether FICR INFO.CODESIZE register is present.
 
#define NRF_FICR_HAS_DEVICE_ID   1
 Symbol indicating whether FICR DEVICEID[n] registers are present.
 
#define NRF_FICR_HAS_INFO_DEVICE_ID   1
 Symbol indicating whether FICR INFO.DEVICEID[n] registers are present.
 
#define NRF_FICR_HAS_NFC_TAGHEADER   1
 Symbol indicating whether FICR NFC.TAGHEADERn registers are present.
 
#define NRF_FICR_HAS_NFC_TAGHEADER_ARRAY   1
 Symbol indicating whether FICR NFC registers have tagheader array layout.
 
#define NRF_FICR_HAS_DEVICE_ADDR   1
 Symbol indicating whether FICR DEVICEADDR[n] registers are present.
 
#define NRF_FICR_HAS_BLE_ADDR   1
 Symbol indicating whether FICR BLE.ADDR[n] registers are present.
 
#define NRF_FICR_HAS_ER   1
 Symbol indicating whether FICR ER[n] registers are present.
 
#define NRF_FICR_HAS_BLE_ER   1
 Symbol indicating whether FICR BLE.ER[n] registers are present.
 
#define NRF_FICR_HAS_IR   1
 Symbol indicating whether FICR IR[n] registers are present.
 
#define NRF_FICR_HAS_BLE_IR   1
 Symbol indicating whether FICR BLE.IR[n] registers are present.
 
#define NRF_FICR_HAS_GLOBAL_COMP_REFTRIM   1
 Symbol indicating whether FICR GLOBAL.COMP.REFTRIM register is present.
 
#define NRF_FICR_HAS_GLOBAL_SAADC_CAL   1
 Symbol indicating whether FICR GLOBAL.SAADC.CAL register is present.
 
#define NRF_FICR_HAS_GLOBAL_SAADC_CALREF   1
 Symbol indicating whether FICR GLOBAL.SAADC.CALREF register is present.
 
#define NRF_FICR_HAS_GLOBAL_SAADC_LINCALCOEFF   1
 Symbol indicating whether FICR GLOBAL.SAADC.LINCALCOEFF register is present.
 
#define NRF_FICR_HAS_HSFLL_TRIM_VSUP   1
 Symbol indicating whether FICR HSFLL.TRIM.VSUP register for the current domain is present.
 
#define NRF_FICR_HAS_HSFLL_TRIM_COARSE   1
 Symbol indicating whether FICR HSFLL.TRIM.COARSE register for the current domain is present.
 
#define NRF_FICR_HAS_HSFLL_TRIM_FINE   1
 Symbol indicating whether FICR HSFLL.TRIM.FINE register for the current domain is present.
 
#define NRF_FICR_HAS_HSFLL_TRIM_TCOEF   1
 Symbol indicating whether FICR HSFLL.TRIM.TCOEF register for the current domain is present.
 

Functions

NRF_STATIC_INLINE uint32_t nrf_ficr_codepagesize_get (NRF_FICR_Type const *p_reg)
 Function for getting the size of the code memory page.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_codesize_get (NRF_FICR_Type const *p_reg)
 Function for getting the size of the code memory rendered as number of pages.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_deviceid_get (NRF_FICR_Type const *p_reg, uint32_t reg_id)
 Function for getting the unique device identifier.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_nfc_tagheader_get (NRF_FICR_Type const *p_reg, uint32_t tagheader_id)
 Function for getting the default header values for the NFC tag.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_deviceaddr_get (NRF_FICR_Type const *p_reg, uint32_t reg_id)
 Function for getting the unique device address.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_er_get (NRF_FICR_Type const *p_reg, uint32_t reg_id)
 Function for getting the unique encryption root.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_ir_get (NRF_FICR_Type const *p_reg, uint32_t reg_id)
 Function for getting the unique identity root.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_global_comp_reftrim_get (NRF_FICR_Type const *p_reg)
 Function for getting the reftrim value for comparator.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_global_saadc_cal_get (NRF_FICR_Type const *p_reg, uint32_t reg_id)
 Function for getting the calibration value of a given index for SAADC.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_global_saadc_calref_get (NRF_FICR_Type const *p_reg)
 Function for getting the reference calibration value for SAADC.
 
NRF_STATIC_INLINE uint32_t nrf_ficr_global_saadc_lincalcoeff_get (NRF_FICR_Type const *p_reg, uint8_t reg_id)
 Function for getting the linear calibration coefficient of a given index for SAADC.
 
NRF_STATIC_INLINE uint8_t nrf_ficr_hsfll_trim_vsup_get (NRF_FICR_Type const *p_reg)
 Function for getting the VSUP trim value for HSFLL for the current domain.
 
NRF_STATIC_INLINE uint16_t nrf_ficr_hsfll_trim_coarse_get (NRF_FICR_Type const *p_reg, uint8_t trim_index)
 Function for getting the COARSE trim value for HSFLL for the current domain.
 
NRF_STATIC_INLINE uint16_t nrf_ficr_hsfll_trim_fine_get (NRF_FICR_Type const *p_reg, uint8_t trim_index)
 Function for getting the FINE trim value for HSFLL for the current domain.
 
NRF_STATIC_INLINE uint8_t nrf_ficr_hsfll_trim_tcoef_get (NRF_FICR_Type const *p_reg)
 Function for getting the temperature coefficient trim value for HSFLL for the current domain.
 

Detailed Description

Hardware access layer (HAL) for getting data from the Factory Information Configuration Registers (FICR).

Function Documentation

◆ nrf_ficr_codepagesize_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_codepagesize_get ( NRF_FICR_Type const * p_reg)

Function for getting the size of the code memory page.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Code memory page size in bytes.

◆ nrf_ficr_codesize_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_codesize_get ( NRF_FICR_Type const * p_reg)

Function for getting the size of the code memory rendered as number of pages.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Code memory size rendered as number of pages.

◆ nrf_ficr_deviceaddr_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_deviceaddr_get ( NRF_FICR_Type const * p_reg,
uint32_t reg_id )

Function for getting the unique device address.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]reg_idRegister index.
Returns
Unique device address.

◆ nrf_ficr_deviceid_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_deviceid_get ( NRF_FICR_Type const * p_reg,
uint32_t reg_id )

Function for getting the unique device identifier.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]reg_idRegister index.
Returns
Unique device identifier.

◆ nrf_ficr_er_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_er_get ( NRF_FICR_Type const * p_reg,
uint32_t reg_id )

Function for getting the unique encryption root.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]reg_idRegister index.
Returns
Unique encryption root.

◆ nrf_ficr_global_comp_reftrim_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_global_comp_reftrim_get ( NRF_FICR_Type const * p_reg)

Function for getting the reftrim value for comparator.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Retrim value for comparator.

◆ nrf_ficr_global_saadc_cal_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_global_saadc_cal_get ( NRF_FICR_Type const * p_reg,
uint32_t reg_id )

Function for getting the calibration value of a given index for SAADC.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]reg_idRegister index.
Returns
Calibration value.

◆ nrf_ficr_global_saadc_calref_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_global_saadc_calref_get ( NRF_FICR_Type const * p_reg)

Function for getting the reference calibration value for SAADC.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Reference calibration value.

◆ nrf_ficr_global_saadc_lincalcoeff_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_global_saadc_lincalcoeff_get ( NRF_FICR_Type const * p_reg,
uint8_t reg_id )

Function for getting the linear calibration coefficient of a given index for SAADC.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]reg_idRegister index.
Returns
Linear calibration coefficient.

◆ nrf_ficr_hsfll_trim_coarse_get()

NRF_STATIC_INLINE uint16_t nrf_ficr_hsfll_trim_coarse_get ( NRF_FICR_Type const * p_reg,
uint8_t trim_index )

Function for getting the COARSE trim value for HSFLL for the current domain.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]trim_indexIndex of the COARSE trim value.
Returns
COARSE trim value for HSFLL.

◆ nrf_ficr_hsfll_trim_fine_get()

NRF_STATIC_INLINE uint16_t nrf_ficr_hsfll_trim_fine_get ( NRF_FICR_Type const * p_reg,
uint8_t trim_index )

Function for getting the FINE trim value for HSFLL for the current domain.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]trim_indexIndex of the FINE trim value.
Returns
FINE trim value for HSFLL.

◆ nrf_ficr_hsfll_trim_tcoef_get()

NRF_STATIC_INLINE uint8_t nrf_ficr_hsfll_trim_tcoef_get ( NRF_FICR_Type const * p_reg)

Function for getting the temperature coefficient trim value for HSFLL for the current domain.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Temperature coefficient trim value for HSFLL.

◆ nrf_ficr_hsfll_trim_vsup_get()

NRF_STATIC_INLINE uint8_t nrf_ficr_hsfll_trim_vsup_get ( NRF_FICR_Type const * p_reg)

Function for getting the VSUP trim value for HSFLL for the current domain.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
VSUP trim value for HSFLL.

◆ nrf_ficr_ir_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_ir_get ( NRF_FICR_Type const * p_reg,
uint32_t reg_id )

Function for getting the unique identity root.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]reg_idRegister index.
Returns
Unique identity root.

◆ nrf_ficr_nfc_tagheader_get()

NRF_STATIC_INLINE uint32_t nrf_ficr_nfc_tagheader_get ( NRF_FICR_Type const * p_reg,
uint32_t tagheader_id )

Function for getting the default header values for the NFC tag.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]tagheader_idTag header index.
Returns
The default header value of the NFC tag for the specified header index.