XO driver

XO clock driver. More...

Typedefs
typedef void(*	nrfx_clock_xo_event_handler_t) (nrfx_clock_xo_event_type_t event)
	XO clock event handler.

Enumerations
enum	nrfx_clock_xo_event_type_t { NRFX_CLOCK_XO_EVT_HFCLK_STARTED = NRFX_BITMASK_TO_BITPOS(NRF_CLOCK_INT_HF_STARTED_MASK) }
	XO clock events. More...

Functions
int	nrfx_clock_xo_init (nrfx_clock_xo_event_handler_t event_handler)
	Function for initializing the XO driver.
void	nrfx_clock_xo_uninit (void)
	Function for uninitializing the XO driver.
bool	nrfx_clock_xo_init_check (void)
	Function for checking if the XO driver is initialized.
void	nrfx_clock_xo_start (void)
	Function for starting the XO clock.
void	nrfx_clock_xo_stop (void)
	Function for stopping the XO clock.
NRFX_STATIC_INLINE bool	nrfx_clock_xo_running_check (nrf_clock_hfclk_t *p_clk_src)
	Function for checking the XO clock state.
void	nrfx_clock_xo_irq_handler (void)
	XO interrupt handler.

Detailed Description

XO clock driver.

Typedef Documentation

nrfx_clock_xo_event_handler_t

typedef void(* nrfx_clock_xo_event_handler_t) (nrfx_clock_xo_event_type_t event)

XO clock event handler.

Parameters

[in]

event

Event.

Enumeration Type Documentation

nrfx_clock_xo_event_type_t

enum nrfx_clock_xo_event_type_t

XO clock events.

Enumerator
NRFX_CLOCK_XO_EVT_HFCLK_STARTED	XO has been started.

Function Documentation

nrfx_clock_xo_init()

int nrfx_clock_xo_init

(

nrfx_clock_xo_event_handler_t

event_handler

)

Function for initializing the XO driver.

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

Parameters

[in]

event_handler

Event handler provided by the user. If not provided, driver works in blocking mode.

Return values

0	The procedure is successful.
-EALREADY	The driver is already initialized.

nrfx_clock_xo_init_check()

bool nrfx_clock_xo_init_check

(

void

)

Function for checking if the XO driver is initialized.

Return values

true	Driver is already initialized.
false	Driver is not initialized.

nrfx_clock_xo_running_check()

NRFX_STATIC_INLINE bool nrfx_clock_xo_running_check

(

nrf_clock_hfclk_t *

p_clk_src

)

Function for checking the XO clock state.

Parameters

[out]

p_clk_src

Pointer to a clock source that is running.

Return values

true	The XO clock is running.
false	The XO clock is not running.