nrfx 4.5.0
Loading...
Searching...
No Matches
HFCLK driver

HFCLK clock driver. More...

Macros

#define NRFX_CLOCK_HFCLK_EVT_HFCLK_STARTED   NRFX_BITMASK_TO_BITPOS(NRF_CLOCK_INT_HF_STARTED_MASK)
 HFCLK clock event.

Typedefs

typedef void(* nrfx_clock_hfclk_event_handler_t) (void)
 HFCLK event handler.

Functions

int nrfx_clock_hfclk_init (nrfx_clock_hfclk_event_handler_t event_handler)
 Function for initializing the HFCLK driver.
bool nrfx_clock_hfclk_init_check (void)
 Function for checking if the HFCLK driver is initialized.
void nrfx_clock_hfclk_uninit (void)
 Function for uninitializing the HFCLK driver.
void nrfx_clock_hfclk_start (void)
 Function for starting the HFCLK clock.
void nrfx_clock_hfclk_stop (void)
 Function for stopping the HFCLK clock.
NRFX_STATIC_INLINE bool nrfx_clock_hfclk_running_check (nrf_clock_hfclk_t *p_clk_src)
 Function for checking the HFCLK clock state.
void nrfx_clock_hfclk_irq_handler (void)
 HFCLK interrupt handler.

Detailed Description

HFCLK clock driver.

Function Documentation

◆ nrfx_clock_hfclk_init()

int nrfx_clock_hfclk_init ( nrfx_clock_hfclk_event_handler_t event_handler)

Function for initializing the HFCLK driver.

After initialization, the HFCLK driver is in power off state (clock is not started).

Parameters
[in]event_handlerEvent handler provided by the user. If not provided, driver works in blocking mode.
Return values
0The procedure is successful.
-EALREADYThe driver is already initialized.

◆ nrfx_clock_hfclk_init_check()

bool nrfx_clock_hfclk_init_check ( void )

Function for checking if the HFCLK driver is initialized.

Return values
trueDriver is already initialized.
falseDriver is not initialized.

◆ nrfx_clock_hfclk_running_check()

NRFX_STATIC_INLINE bool nrfx_clock_hfclk_running_check ( nrf_clock_hfclk_t * p_clk_src)

Function for checking the HFCLK clock state.

Parameters
[out]p_clk_srcPointer to a clock source that is running.
Return values
trueThe HFCLK clock is running.
falseThe HFCLK clock is not running.