Hardware access layer for managing Power Management Integrated Circuit Controller (PMICC). More...

Data Structures
struct	nrf_pmicc_status_t
	PMICC status. More...

Macros
#define	NRF_PMICC_SOURCES_COUNT PMICC_EVENTS_CURRABOVE_MaxCount
	Symbol specifying the number of available sources.

Enumerations
enum	nrf_pmicc_event_t { NRF_PMICC_EVENT_FPWMRDYHI = offsetof(NRF_PMICC_Type, EVENTS_FPWMRDYHI) , NRF_PMICC_EVENT_FPWMRDYLO = offsetof(NRF_PMICC_Type, EVENTS_FPWMRDYLO) , NRF_PMICC_EVENT_CURRABOVE_0 = offsetof(NRF_PMICC_Type, EVENTS_CURRABOVE[0]) , NRF_PMICC_EVENT_CURRABOVE_1 = offsetof(NRF_PMICC_Type, EVENTS_CURRABOVE[1]) , NRF_PMICC_EVENT_CURRABOVE_2 = offsetof(NRF_PMICC_Type, EVENTS_CURRABOVE[2]) , NRF_PMICC_EVENT_CURRBELOW_0 = offsetof(NRF_PMICC_Type, EVENTS_CURRBELOW[0]) , NRF_PMICC_EVENT_CURRBELOW_1 = offsetof(NRF_PMICC_Type, EVENTS_CURRBELOW[1]) , NRF_PMICC_EVENT_CURRBELOW_2 = offsetof(NRF_PMICC_Type, EVENTS_CURRBELOW[2]) }
	PMICC events. More...

enum	nrf_pmicc_fpwmrdy_t { NRF_PMICC_FPWMRDY_LOW = PMICC_STATUS_FPWMRDY_ZERO , NRF_PMICC_FPWMRDY_HIGH = PMICC_STATUS_FPWMRDY_ONE }
	PMICC Pulse-width modulation mode signal (fPwmRdy) states. More...

enum	nrf_pmicc_fsmstate_t { NRF_PMICC_FSMSTATE_DISABLED = PMICC_STATUS_FSMSTATE_DISABLED , NRF_PMICC_FSMSTATE_ULP = PMICC_STATUS_FSMSTATE_ULP , NRF_PMICC_FSMSTATE_PGDREQ = PMICC_STATUS_FSMSTATE_PGDREQ , NRF_PMICC_FSMSTATE_BODHPREQ = PMICC_STATUS_FSMSTATE_BODHPREQ , NRF_PMICC_FSMSTATE_HV = PMICC_STATUS_FSMSTATE_HV , NRF_PMICC_FSMSTATE_PWMREQ = PMICC_STATUS_FSMSTATE_PWMREQ , NRF_PMICC_FSMSTATE_PWM = PMICC_STATUS_FSMSTATE_PWM , NRF_PMICC_FSMSTATE_BODULPREQ = PMICC_STATUS_FSMSTATE_BODULPREQ }
	PMICC state machine states. More...

Functions
NRF_STATIC_INLINE uint32_t	nrf_pmicc_event_address_get (NRF_PMICC_Type const *p_reg, nrf_pmicc_event_t event)
	Function for getting the address of the specified event.

NRF_STATIC_INLINE nrf_pmicc_event_t	nrf_pmicc_currabove_event_get (uint8_t source)
	Function for getting the event associated with current consumption being above the threshold for the specified source.

NRF_STATIC_INLINE nrf_pmicc_event_t	nrf_pmicc_currbelow_event_get (uint8_t source)
	Function for getting the event associated with current consumption being below the threshold for the specified source.

NRF_STATIC_INLINE void	nrf_pmicc_event_clear (NRF_PMICC_Type *p_reg, nrf_pmicc_event_t event)
	Function for clearing the specified event.

NRF_STATIC_INLINE bool	nrf_pmicc_event_check (NRF_PMICC_Type const *p_reg, nrf_pmicc_event_t event)
	Function for checking the state of the specified event.

NRF_STATIC_INLINE void	nrf_pmicc_status_get (NRF_PMICC_Type const p_reg, nrf_pmicc_status_t p_status)
	Function for getting PMICC status.

NRF_STATIC_INLINE uint8_t	nrf_pmicc_ithreshold_get (NRF_PMICC_Type const *p_reg)
	Function for getting the PMICC current threshold.

NRF_STATIC_INLINE void	nrf_pmicc_ithreshold_set (NRF_PMICC_Type *p_reg, uint8_t value)
	Function for setting the PMICC current threshold.

Detailed Description

Hardware access layer for managing Power Management Integrated Circuit Controller (PMICC).

Enumeration Type Documentation

◆ nrf_pmicc_event_t

enum nrf_pmicc_event_t

PMICC events.

Enumerator
NRF_PMICC_EVENT_FPWMRDYHI	PMICC FPWMRDYHI event generated. *‍/.
NRF_PMICC_EVENT_FPWMRDYLO	PMICC FPWMRDYLO event generated. *‍/.
NRF_PMICC_EVENT_CURRABOVE_0	PMICC CURRABOVE[0] event generated. *‍/.
NRF_PMICC_EVENT_CURRABOVE_1	PMICC CURRABOVE[0] event generated. *‍/.
NRF_PMICC_EVENT_CURRABOVE_2	PMICC CURRABOVE[0] event generated. *‍/.
NRF_PMICC_EVENT_CURRBELOW_0	PMICC CURRBELOW[0] event generated. *‍/.
NRF_PMICC_EVENT_CURRBELOW_1	PMICC CURRBELOW[0] event generated. *‍/.
NRF_PMICC_EVENT_CURRBELOW_2	PMICC CURRBELOW[0] event generated. *‍/.

◆ nrf_pmicc_fpwmrdy_t

enum nrf_pmicc_fpwmrdy_t

PMICC Pulse-width modulation mode signal (fPwmRdy) states.

Enumerator
NRF_PMICC_FPWMRDY_LOW	fPwmRdy low state.
NRF_PMICC_FPWMRDY_HIGH	fPwmRdy high state.

◆ nrf_pmicc_fsmstate_t

enum nrf_pmicc_fsmstate_t

PMICC state machine states.

Enumerator
NRF_PMICC_FSMSTATE_DISABLED	PMICC has been disabled.
NRF_PMICC_FSMSTATE_ULP	ULP or HV_REQ state.
NRF_PMICC_FSMSTATE_PGDREQ	PGD_REQ state.
NRF_PMICC_FSMSTATE_BODHPREQ	BOD_HP_REQ state.
NRF_PMICC_FSMSTATE_HV	HV state.
NRF_PMICC_FSMSTATE_PWMREQ	PWM_REQ state.
NRF_PMICC_FSMSTATE_PWM	PWM state.
NRF_PMICC_FSMSTATE_BODULPREQ	BOD_ULP_REQ state.

Function Documentation

◆ nrf_pmicc_currabove_event_get()

NRF_STATIC_INLINE nrf_pmicc_event_t nrf_pmicc_currabove_event_get ( uint8_t source )

Function for getting the event associated with current consumption being above the threshold for the specified source.

Parameters

[in] source Source of the event.

Returns: Retrieved current consumption above threshold event.

◆ nrf_pmicc_currbelow_event_get()

NRF_STATIC_INLINE nrf_pmicc_event_t nrf_pmicc_currbelow_event_get ( uint8_t source )

Function for getting the event associated with current consumption being below the threshold for the specified source.

Parameters

[in] source Source of the event.

Returns: Retrieved current consumption below threshold event.

◆ nrf_pmicc_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_pmicc_event_address_get	(	NRF_PMICC_Type const *	p_reg,
		nrf_pmicc_event_t	event
	)

Function for getting the address of the specified event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	PMICC event.

Returns: Address of the specified event register.

◆ nrf_pmicc_event_check()

NRF_STATIC_INLINE bool nrf_pmicc_event_check	(	NRF_PMICC_Type const *	p_reg,
		nrf_pmicc_event_t	event
	)

Function for checking the state of the specified event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event to be checked.

Return values

true	The event has been generated.
false	The event has not been generated.

◆ nrf_pmicc_event_clear()

NRF_STATIC_INLINE void nrf_pmicc_event_clear	(	NRF_PMICC_Type *	p_reg,
		nrf_pmicc_event_t	event
	)

Function for clearing the specified event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event to be cleared.

◆ nrf_pmicc_ithreshold_get()

NRF_STATIC_INLINE uint8_t nrf_pmicc_ithreshold_get ( NRF_PMICC_Type const * p_reg )

Function for getting the PMICC current threshold.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Returns: Current threshold.

◆ nrf_pmicc_ithreshold_set()

NRF_STATIC_INLINE void nrf_pmicc_ithreshold_set	(	NRF_PMICC_Type *	p_reg,
		uint8_t	value
	)

Function for setting the PMICC current threshold.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	value	Value to set as current threshold.

◆ nrf_pmicc_status_get()

NRF_STATIC_INLINE void nrf_pmicc_status_get	(	NRF_PMICC_Type const *	p_reg,
		nrf_pmicc_status_t *	p_status
	)

Function for getting PMICC status.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[out]	p_status	Pointer to the structure to be filled with PMICC status.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ nrf_pmicc_event_t

◆ nrf_pmicc_fpwmrdy_t

◆ nrf_pmicc_fsmstate_t

Function Documentation

◆ nrf_pmicc_currabove_event_get()

◆ nrf_pmicc_currbelow_event_get()

◆ nrf_pmicc_event_address_get()

◆ nrf_pmicc_event_check()

◆ nrf_pmicc_event_clear()

◆ nrf_pmicc_ithreshold_get()

◆ nrf_pmicc_ithreshold_set()

◆ nrf_pmicc_status_get()