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 "nrf.h"
#include "nrf_errno.h"
 
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_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 void (*mpsl_clock_hfclk_callback_t)(void);
 
int32_t mpsl_clock_hfclk_request(mpsl_clock_hfclk_callback_t hfclk_started_callback);
 
int32_t mpsl_clock_hfclk_release(void);
 
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);
 
#ifdef __cplusplus
}
#endif
 
#endif // MPSL_CLOCK_H__