mpsl_clock.h

Go to the documentation of this file.

/*
 * Copyright (c) Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef MPSL_CLOCK_H__
#define MPSL_CLOCK_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include "nrfx.h"
#include "nrf_errno.h"
#if !defined (NRF54H_SERIES)
#include "hal/nrf_clock.h"
#endif /* !NRF54H20_XXAA */
 
enum MPSL_CLOCK_LF_SRC
{
    MPSL_CLOCK_LF_SRC_RC             = 0, 
    MPSL_CLOCK_LF_SRC_XTAL           = 1, 
    MPSL_CLOCK_LF_SRC_SYNTH          = 2, 
#if defined(NRF52_SERIES)
    MPSL_CLOCK_LF_SRC_EXT_LOW_SWING  = 3, 
    MPSL_CLOCK_LF_SRC_EXT_FULL_SWING = 4, 
#endif
};
 
#define MPSL_RECOMMENDED_RC_CTIV        16
 
#define MPSL_RECOMMENDED_RC_TEMP_CTIV   2
 
#define MPSL_DEFAULT_CLOCK_ACCURACY_PPM  250
 
#define MPSL_WORST_CLOCK_ACCURACY_PPM  500
 
#define MPSL_DEFAULT_SKIP_WAIT_LFCLK_STARTED false
 
typedef struct
{
  uint8_t source;
 
  uint8_t rc_ctiv;
 
  uint8_t rc_temp_ctiv;
 
  uint16_t accuracy_ppm;
 
  bool skip_wait_lfclk_started;
} mpsl_clock_lfclk_cfg_t;
 
/* @brief Available options for informing MPSL of the true high-frequency oscillator ramp-up time, in microseconds. */
typedef enum
{
  MPSL_CLOCK_HF_LATENCY_BEST = 396,
  MPSL_CLOCK_HF_LATENCY_TYPICAL = 854,
  MPSL_CLOCK_HF_LATENCY_WORST_CASE = 1400,
} mpsl_clock_hfclk_latency_config_t;
 
typedef enum {
  MPSL_CLOCK_HF_SRC_XO = 0,
#if defined(NRF_CLOCK_HAS_HFCLK24M) && NRF_CLOCK_HAS_HFCLK24M
  MPSL_CLOCK_HF_SRC_HFCLK24M = 1, 
#endif /* NRF_CLOCK_HAS_HFCLK24M */
  MPSL_CLOCK_HF_SRC_MAX = 2,
} mpsl_clock_hfclk_src_t;
 
typedef enum
{
  MPSL_CLOCK_EVT_HFCLK_STARTED = 0,
#if defined(NRF_CLOCK_HAS_HFCLK24M) && NRF_CLOCK_HAS_HFCLK24M
  MPSL_CLOCK_EVT_HFCLK24M_STARTED = 1,
#endif /* NRF_CLOCK_HAS_HFCLK24M */
#if defined(NRF_CLOCK_HAS_XO_TUNE) && NRF_CLOCK_HAS_XO_TUNE
  MPSL_CLOCK_EVT_XO_TUNED = 2, 
#endif /* NRF_CLOCK_HAS_XO_TUNE */
  MPSL_CLOCK_EVT_MAX = 3,
} mpsl_clock_evt_type_t;
 
typedef void (*mpsl_clock_hfclk_callback_t)(void);
 
__attribute__((deprecated))
int32_t mpsl_clock_hfclk_request(mpsl_clock_hfclk_callback_t hfclk_started_callback);
 
__attribute__((deprecated))
int32_t mpsl_clock_hfclk_release(void);
 
__attribute__((deprecated))
int32_t mpsl_clock_hfclk_is_running(uint32_t * p_is_running);
 
int32_t mpsl_clock_hfclk_latency_set(uint16_t hfclk_rampup_time_us);
 
void mpsl_clock_task_trigger_on_rtc_start_set(uint32_t task_address);
 
typedef void (*mpsl_clock_hfclk_request_callback_t)(mpsl_clock_evt_type_t evt_type);
 
int32_t mpsl_clock_hfclk_src_request(mpsl_clock_hfclk_src_t src, mpsl_clock_hfclk_request_callback_t hfclk_started_callback);
 
int32_t mpsl_clock_hfclk_src_release(mpsl_clock_hfclk_src_t src);
 
int32_t mpsl_clock_hfclk_src_is_running(mpsl_clock_hfclk_src_t src, uint32_t * p_is_running);
 
typedef struct
{
  int32_t (*lfclk_wait)(void);
 
  void (*lfclk_calibration_start)(void);
 
  bool (*lfclk_calibration_is_enabled)(void);
 
  int32_t (*lfclk_request)(void);
 
  int32_t (*lfclk_release)(void);
 
  uint16_t accuracy_ppm;
 
  bool skip_wait_lfclk_started;
} mpsl_clock_lfclk_ctrl_source_t;
 
typedef struct
{
  void (*hfclk_request)(void);
 
  void (*hfclk_release)(void);
 
  bool (*hfclk_is_running)(void);
 
  uint16_t startup_time_us;
} mpsl_clock_hfclk_ctrl_source_t;
 
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);
 
int32_t mpsl_clock_ctrl_source_unregister(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // MPSL_CLOCK_H__