BICR HAL

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

Macros
#define	NRF_BICR_HAS_LFOSC_LFXOCONFIG   1
	Symbol indicating whether BICR LFOSC.LFXOCONFIG register is present.
#define	NRF_BICR_HAS_HFXO_STARTUPTIME   1
	Symbol indicating whether BICR HFXO.STARTUPTIME register is present.
#define	NRF_BICR_HAS_HFXO_64M   1
	Symbol indicating whether BICR HFXO64M register is present.
#define	NRF_BICR_HAS_LFOSC_LFXOCONFIG_CRYSTAL   1
	Symbol indicating whether LFXOCONFIG Crystal mode is present.
#define	NRF_BICR_HAS_LFOSC_LFXOCONFIG_PIERCE   1
	Symbol indicating whether LFXOCONFIG Pierce mode is present.
#define	NRF_BICR_HAS_LFOSC_LFXOCONFIG_PIXO   1
	Symbol indicating whether LFXOCONFIG PIXO mode is present.
#define	NRF_BICR_HAS_LFOSC_LFXOCONFIG_DISABLED   1
	Symbol indicating whether LFXOCONFIG Disabled mode is present.
#define	NRF_BICR_LFOSC_STARTUP_TIME_UNCONFIGURED   BICR_LFOSC_LFXOCONFIG_TIME_Unconfigured
	LFOSC unconfigured startup time value.
#define	NRF_BICR_HFXO_STARTUP_TIME_UNCONFIGURED   BICR_HFXO64M_STARTUPTIME_TIME_Unconfigured
	HFXO unconfigured startup time value.

Enumerations
enum	nrf_bicr_lfosc_mode_t {   NRF_BICR_LFOSC_MODE_UNCONFIGURED = BICR_LFOSC_LFXOCONFIG_MODE_Unconfigured ,   NRF_BICR_LFOSC_MODE_CRYSTAL = BICR_LFOSC_LFXOCONFIG_MODE_Crystal ,   NRF_BICR_LFOSC_MODE_PIERCE = BICR_LFOSC_LFXOCONFIG_MODE_Pierce ,   NRF_BICR_LFOSC_MODE_PIXO = BICR_LFOSC_LFXOCONFIG_MODE_PIXO ,   NRF_BICR_LFOSC_MODE_EXTSINE = BICR_LFOSC_LFXOCONFIG_MODE_ExtSine ,   NRF_BICR_LFOSC_MODE_EXTSQUARE = BICR_LFOSC_LFXOCONFIG_MODE_ExtSquare ,   NRF_BICR_LFOSC_MODE_DISABLED = BICR_LFOSC_LFXOCONFIG_MODE_Disabled }
	LFOSC Mode. More...
enum	nrf_bicr_lfosc_accuracy_t {   NRF_BICR_LFOSC_ACCURACY_UNCONFIGURED = BICR_LFOSC_LFXOCONFIG_ACCURACY_Unconfigured ,   NRF_BICR_LFOSC_ACCURACY_20PPM = BICR_LFOSC_LFXOCONFIG_ACCURACY_20ppm ,   NRF_BICR_LFOSC_ACCURACY_30PPM = BICR_LFOSC_LFXOCONFIG_ACCURACY_30ppm ,   NRF_BICR_LFOSC_ACCURACY_50PPM = BICR_LFOSC_LFXOCONFIG_ACCURACY_50ppm ,   NRF_BICR_LFOSC_ACCURACY_75PPM = BICR_LFOSC_LFXOCONFIG_ACCURACY_75ppm ,   NRF_BICR_LFOSC_ACCURACY_100PPM = BICR_LFOSC_LFXOCONFIG_ACCURACY_100ppm ,   NRF_BICR_LFOSC_ACCURACY_150PPM = BICR_LFOSC_LFXOCONFIG_ACCURACY_150ppm ,   NRF_BICR_LFOSC_ACCURACY_250PPM = BICR_LFOSC_LFXOCONFIG_ACCURACY_250ppm ,   NRF_BICR_LFOSC_ACCURACY_500PPM = BICR_LFOSC_LFXOCONFIG_ACCURACY_500ppm }
	LFOSC Accuracy. More...

Functions
NRF_STATIC_INLINE uint16_t	nrf_bicr_lfosc_startup_time_ms_get (NRF_BICR_Type const *p_reg)
	Function for getting the LFOSC startup time in milliseconds.
NRF_STATIC_INLINE nrf_bicr_lfosc_mode_t	nrf_bicr_lfosc_mode_get (NRF_BICR_Type const *p_reg)
	Function for getting the LFOSC mode.
NRF_STATIC_INLINE nrf_bicr_lfosc_accuracy_t	nrf_bicr_lfosc_accuracy_get (NRF_BICR_Type const *p_reg)
	Function for getting the LFOSC accuracy.
NRF_STATIC_INLINE uint32_t	nrf_bicr_hfxo_startup_time_us_get (NRF_BICR_Type const *p_reg)
	Function for getting the HFXO startup time in microseconds.

Detailed Description

Hardware access layer (HAL) for getting data from the Board Information Configuration Registers (BICR).

Enumeration Type Documentation

nrf_bicr_lfosc_accuracy_t

enum nrf_bicr_lfosc_accuracy_t

LFOSC Accuracy.

Enumerator
NRF_BICR_LFOSC_ACCURACY_UNCONFIGURED	The accuracy is unconfigured.
NRF_BICR_LFOSC_ACCURACY_20PPM	LFXO crystal or external signal has an accuracy of 20 ppm.
NRF_BICR_LFOSC_ACCURACY_30PPM	LFXO crystal or external signal has an accuracy of 30 ppm.
NRF_BICR_LFOSC_ACCURACY_50PPM	LFXO crystal or external signal has an accuracy of 50 ppm.
NRF_BICR_LFOSC_ACCURACY_75PPM	LFXO crystal or external signal has an accuracy of 75 ppm.
NRF_BICR_LFOSC_ACCURACY_100PPM	LFXO crystal or external signal has an accuracy of 100 ppm.
NRF_BICR_LFOSC_ACCURACY_150PPM	LFXO crystal or external signal has an accuracy of 150 ppm.
NRF_BICR_LFOSC_ACCURACY_250PPM	LFXO crystal or external signal has an accuracy of 250 ppm.
NRF_BICR_LFOSC_ACCURACY_500PPM	LFXO crystal or external signal has an accuracy of 500 ppm.

nrf_bicr_lfosc_mode_t

enum nrf_bicr_lfosc_mode_t

LFOSC Mode.

Enumerator
NRF_BICR_LFOSC_MODE_UNCONFIGURED	The mode is unconfigured.
NRF_BICR_LFOSC_MODE_CRYSTAL	LFXO in external crystal oscillator mode.
NRF_BICR_LFOSC_MODE_PIERCE	LFXO in Pierce oscillator mode.
NRF_BICR_LFOSC_MODE_PIXO	LFXO in PIXO mode.
NRF_BICR_LFOSC_MODE_EXTSINE	LFXO in external sine wave mode.
NRF_BICR_LFOSC_MODE_EXTSQUARE	LFXO in external square wave mode.
NRF_BICR_LFOSC_MODE_DISABLED	LFXO is not to be used.

Function Documentation

nrf_bicr_hfxo_startup_time_us_get()

NRF_STATIC_INLINE uint32_t nrf_bicr_hfxo_startup_time_us_get

(

NRF_BICR_Type const *

p_reg

)

Function for getting the HFXO startup time in microseconds.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

HFXO startup time in microseconds, or NRF_BICR_HFXO_STARTUP_TIME_UNCONFIGURED if not configured.

nrf_bicr_lfosc_accuracy_get()

NRF_STATIC_INLINE nrf_bicr_lfosc_accuracy_t nrf_bicr_lfosc_accuracy_get

(

NRF_BICR_Type const *

p_reg

)

Function for getting the LFOSC accuracy.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

LFOSC accuracy.

nrf_bicr_lfosc_mode_get()

NRF_STATIC_INLINE nrf_bicr_lfosc_mode_t nrf_bicr_lfosc_mode_get

(

NRF_BICR_Type const *

p_reg

)

Function for getting the LFOSC mode.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

LFOSC mode.

nrf_bicr_lfosc_startup_time_ms_get()

NRF_STATIC_INLINE uint16_t nrf_bicr_lfosc_startup_time_ms_get

(

NRF_BICR_Type const *

p_reg

)

Function for getting the LFOSC startup time in milliseconds.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

LFOSC startup time in milliseconds, or NRF_BICR_LFOSC_STARTUP_TIME_UNCONFIGURED if not configured.