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

XO24M peripheral driver. More...

Macros

#define NRFX_CLOCK_XO24M_EVT_HFCLK24M_STARTED   NRFX_BITMASK_TO_BITPOS(NRF_CLOCK_INT_HFCLK24M_STARTED_MASK)
 XO24M event.
 

Typedefs

typedef void(* nrfx_clock_xo24m_event_handler_t) (void)
 XO24M event handler.
 

Functions

int nrfx_clock_xo24m_init (nrfx_clock_xo24m_event_handler_t event_handler)
 Function for initializing internal structures in the nrfx_clock_xo24m module.
 
void nrfx_clock_xo24m_uninit (void)
 Function for uninitializing the xo24m module.
 
bool nrfx_clock_xo24m_init_check (void)
 Function for checking if the xo24m driver is initialized.
 
void nrfx_clock_xo24m_start (void)
 Function for starting the xo24m clock.
 
void nrfx_clock_xo24m_stop (void)
 Function for stopping the xo24m clock.
 
NRFX_STATIC_INLINE bool nrfx_clock_xo24m_running_check (void)
 Function for checking the specified clock domain state.
 
void nrfx_clock_xo24m_irq_handler (void)
 Function for handling xo24m interrupts.
 

Detailed Description

XO24M peripheral driver.

Macro Definition Documentation

◆ NRFX_CLOCK_XO24M_EVT_HFCLK24M_STARTED

#define NRFX_CLOCK_XO24M_EVT_HFCLK24M_STARTED   NRFX_BITMASK_TO_BITPOS(NRF_CLOCK_INT_HFCLK24M_STARTED_MASK)

XO24M event.

HFCLK24M has been started.

Function Documentation

◆ nrfx_clock_xo24m_init()

int nrfx_clock_xo24m_init ( nrfx_clock_xo24m_event_handler_t event_handler)

Function for initializing internal structures in the nrfx_clock_xo24m module.

After initialization, the module is in power off state (clocks are 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_xo24m_init_check()

bool nrfx_clock_xo24m_init_check ( void )

Function for checking if the xo24m driver is initialized.

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

◆ nrfx_clock_xo24m_running_check()

NRFX_STATIC_INLINE bool nrfx_clock_xo24m_running_check ( void )

Function for checking the specified clock domain state.

XTAL source is assumed for domains with multiple sources.

Return values
trueThe xo24m is running.
falseThe xo24m is not running.