MPSL Clock interface

Data Structures
struct	mpsl_clock_lfclk_cfg_t
	Type representing LFCLK oscillator source. More...
struct	mpsl_clock_lfclk_ctrl_source_t
	Type representing LFCLK clock handling external API that is expected by MPSL to be delivered on init. More...
struct	mpsl_clock_hfclk_ctrl_source_t
	Type representing HFCLK clock handling external API that is expected by MPSL to be delivered on init. More...

Macros
#define	MPSL_RECOMMENDED_RC_CTIV   16
	Recommended RC clock calibration timer interval.
#define	MPSL_RECOMMENDED_RC_TEMP_CTIV   2
	Recommended RC clock calibration timer interval for temperature changes.
#define	MPSL_DEFAULT_CLOCK_ACCURACY_PPM   250
	Default LF clock accuracy in parts per million (ppm).
#define	MPSL_WORST_CLOCK_ACCURACY_PPM   500
	Worst LF clock accuracy allowed by the BLUETOOTH CORE SPECIFICATION Version 6.0 | Vol 6, Part B 4.2.2 Sleep clock accuracy in parts per million (ppm).
#define	MPSL_DEFAULT_SKIP_WAIT_LFCLK_STARTED   false
	MPSL waits for low frequency clock to start by default.

Typedefs
typedef void(*	mpsl_clock_hfclk_callback_t) (void)
	High frequency clock callback.
typedef void(*	mpsl_clock_hfclk_request_callback_t) (mpsl_clock_evt_type_t evt_type)
	High frequency clock callback.

Enumerations
enum	MPSL_CLOCK_LF_SRC { MPSL_CLOCK_LF_SRC_RC = 0 , MPSL_CLOCK_LF_SRC_XTAL = 1 , MPSL_CLOCK_LF_SRC_SYNTH = 2 }
	Low frequency clock source. More...
enum	mpsl_clock_hfclk_latency_config_t { MPSL_CLOCK_HF_LATENCY_BEST = 396 , MPSL_CLOCK_HF_LATENCY_TYPICAL = 854 , MPSL_CLOCK_HF_LATENCY_WORST_CASE = 1400 }
enum	mpsl_clock_hfclk_src_t { MPSL_CLOCK_HF_SRC_XO = 0 , MPSL_CLOCK_HF_SRC_MAX = 2 }
	Supported high frequency clock sources. More...
enum	mpsl_clock_evt_type_t { MPSL_CLOCK_EVT_HFCLK_STARTED = 0 , MPSL_CLOCK_EVT_MAX = 3 }
	Event types returned by the hfclk callback handler. More...

Functions
int32_t	mpsl_clock_hfclk_request (mpsl_clock_hfclk_callback_t hfclk_started_callback)
	Request the high frequency crystal oscillator.
int32_t	mpsl_clock_hfclk_release (void)
	Releases the high frequency crystal oscillator.
int32_t	mpsl_clock_hfclk_is_running (uint32_t *p_is_running)
	Checks if the high frequency crystal oscillator is running.
int32_t	mpsl_clock_hfclk_latency_set (uint16_t hfclk_rampup_time_us)
	Informs MPSL about the actual ramp-up time of the high-frequency crystal oscillator.
void	mpsl_clock_task_trigger_on_rtc_start_set (uint32_t task_address)
	Trigger a task upon start of the RTC.
int32_t	mpsl_clock_hfclk_src_request (mpsl_clock_hfclk_src_t src, mpsl_clock_hfclk_request_callback_t hfclk_started_callback)
	Request a high frequency clock with a given source.
int32_t	mpsl_clock_hfclk_src_release (mpsl_clock_hfclk_src_t src)
	Releases a high frequency clock for a given source.
int32_t	mpsl_clock_hfclk_src_is_running (mpsl_clock_hfclk_src_t src, uint32_t *p_is_running)
	Checks if the high frequency clock for a given source is running.
int32_t	mpsl_clock_ctrl_source_register (const mpsl_clock_lfclk_ctrl_source_t *p_lfclk_ctrl_source, const mpsl_clock_hfclk_ctrl_source_t *p_hfclk_ctrl_source)
	Register an external clock driver.
int32_t	mpsl_clock_ctrl_source_unregister (void)
	Unregisters external clock driver from MPSL.

Detailed Description

The MPSL clock interface provides APIs for controlling the clocks.