# 时钟树

[English]

ESP32-H4 的时钟子系统用于从一系列根时钟中提取并分配系统/模块时钟。时钟树驱动程序负责维护系统时钟的基本功能，并管理模块时钟间的复杂关系。

本文档首先介绍了根时钟和模块时钟，随后介绍了可供用户调用的时钟树 API，调用这些 API，可以监测模块时钟的运行状态。

## 简介

本节列出了 ESP32-H4 支持的根时钟和模块时钟的定义，这些定义通常用于驱动程序配置，有助于为外设选择合适的时钟源。

### 根时钟

根时钟会产生可靠的时钟信号，经各种门、复用器、分频器或倍频器传递，这些时钟信号最终成为 CPU 内核、Wi-Fi、蓝牙、RTC 及外设等功能模块的时钟源。

ESP32-H4 的根时钟列在 `soc_root_clk_t` 中：

> - 内部 20 MHz RC 振荡器 (RC_FAST)

>   > 此 RC 振荡器可产生约 20 MHz 的时钟信号输出，标识为 `RC_FAST_CLK`。

>   > 在运行时，通过校准，可以计算 `RC_FAST_CLK` 的实际频率。

> - 外部 32 MHz 晶振 (XTAL)

> - 内部 600 kHz RC 振荡器 (RC_SLOW)

>   > 此 RC 振荡器产生约 600 kHz 的时钟信号输出，标识为 `RC_SLOW_CLK`。在运行时，通过校准，可以计算该时钟信号的实际频率。

> - 外部 32 kHz 晶振 - 可选 (XTAL32K)

>   > `XTAL32K_CLK` 的时钟源可以是连接到 `XTAL_32K_P` 和 `XTAL_32K_N` 管脚的 32 kHz 晶振，也可以是外部电路生成的 32 kHZ 时钟信号。如果使用外部电路生成的时钟信号，该信号必须连接到 `XTAL_32K_P` 管脚。

>   > 通过校准，可以计算 `XTAL32K_CLK` 的实际频率。

> - 外部慢速时钟 - 可选 (OSC_SLOW)

>   > 将外部电路生成的时钟信号连接到 GPIO5，可作为 `RTC_SLOW_CLK` 的时钟源。通过校准，可以计算该时钟信号的实际频率。

与晶振产生的信号相比，从 RC 振荡器电路产生的信号通常精度较低，且容易受环境影响。因此，ESP32-H4 为 `RTC_SLOW_CLK` 提供了几种时钟源选项，可以根据对系统时间精度和对功耗的要求选择。更多详情，请参阅 RTC 定时器时钟源。

### 模块时钟

ESP32-H4 的可用模块时钟在 `soc_module_clk_t` 中列出，每个模块时钟都有其唯一 ID。查阅文档中的枚举值，即可获取各模块时钟的详细信息。

## 使用 API

时钟树驱动程序提供了一个一体化接口，可以获取模块时钟的频率，即 `esp_clk_tree_src_get_freq_hz()`。通过该函数，你可以在任何时刻，通过提供时钟名称 `soc_module_clk_t` 和指定返回频率值的精度级别 `esp_clk_tree_src_freq_precision_t`，获取时钟频率。

## API 参考

### Header File

- components/soc/esp32h4/include/soc/clk_tree_defs.h

- This header file can be included with:

  >     #include "soc/clk_tree_defs.h"

### Macros

SOC_EXT_OSC_SLOW_GPIO_NUM

SOC_CLK_RC_FAST_FREQ_APPROX

  Approximate RC_FAST_CLK frequency in Hz

SOC_CLK_RC_SLOW_FREQ_APPROX

  Approximate RC_SLOW_CLK frequency in Hz

SOC_CLK_XTAL32K_FREQ_APPROX

  Approximate XTAL32K_CLK frequency in Hz

SOC_CLK_OSC_SLOW_FREQ_APPROX

  Approximate OSC_SLOW_CLK (external slow clock) frequency in Hz

SOC_GPTIMER_CLKS

  Array initializer for all supported clock sources of GPTimer.

  The following code can be used to iterate all possible clocks:

      soc_periph_gptimer_clk_src_t gptimer_clks[] = (soc_periph_gptimer_clk_src_t)SOC_GPTIMER_CLKS;
      for (size_t i = 0; i< sizeof(gptimer_clks) / sizeof(gptimer_clks[0]); i++) {
          soc_periph_gptimer_clk_src_t clk = gptimer_clks[i];
      // Test GPTimer with the clock `clk`
      }

SOC_RMT_CLKS

  Array initializer for all supported clock sources of RMT.

SOC_PCNT_CLKS

  Array initializer for all supported clock sources of PCNT.

SOC_TEMP_SENSOR_CLKS

  Array initializer for all supported clock sources of Temperature Sensor.

SOC_UART_CLKS

  Array initializer for all supported clock sources of UART.

SOC_SPI_CLKS

  Array initializer for all supported clock sources of SPI.

SOC_MWDT_CLKS

  Array initializer for all supported clock sources of MWDT.

SOC_FLASH_CLKS

  Array initializer for all supported clock sources of FLASH MSPI controller.

SOC_I2C_CLKS

  Array initializer for all supported clock sources of I2C.

SOC_LEDC_CLKS

  Array initializer for all supported clock sources of LEDC.

SOC_LEDC_CLK_STRS

SOC_MCPWM_TIMER_CLKS

  Array initializer for all supported clock sources of MCPWM Timer.

SOC_MCPWM_CAPTURE_CLKS

  Array initializer for all supported clock sources of MCPWM Capture Timer.

SOC_MCPWM_CARRIER_CLKS

  Array initializer for all supported clock sources of MCPWM Carrier.

SOC_I2S_CLKS

  Array initializer for all supported clock sources of I2S.

SOC_SDM_CLKS

  Array initializer for all supported clock sources of SDM.

SOC_GLITCH_FILTER_CLKS

  Array initializer for all supported clock sources of Glitch Filter.

SOC_ANA_CMPR_CLKS

  Array initializer for all supported clock sources of Analog Comparator.

SOC_TWAI_CLKS

  Array initializer for all supported clock sources of TWAI.

SOC_PARLIO_CLKS

  Array initializer for all supported clock sources of PARLIO.

SOC_ADC_DIGI_CLKS

  Array initializer for all supported clock sources of ADC digital controller.

### Type Definitions

typedef int soc_periph_etm_clk_src_t

  Type of ETM clock source.

### Enumerations

enum soc_root_clk_t

  Root clock.

  Values:

  enumerator SOC_ROOT_CLK_INT_RC_FAST

    Internal 20MHz RC oscillator

  enumerator SOC_ROOT_CLK_INT_RC_SLOW

    Internal 600kHz RC oscillator

  enumerator SOC_ROOT_CLK_EXT_XTAL

    External 32MHz crystal

  enumerator SOC_ROOT_CLK_EXT_XTAL32K

    External 32kHz crystal

  enumerator SOC_ROOT_CLK_EXT_OSC_SLOW

    External slow clock signal at pin5

enum soc_root_clk_circuit_t

  ROOT clock circuit, which requires explicitly enabling the targeting circuit to use.

  Values:

  enumerator SOC_ROOT_CIRCUIT_CLK_BBPLL

    BBPLL_CLK is the output of the PLL generator circuit

  enumerator SOC_ROOT_CIRCUIT_CLK_XTAL_X2

    XTAL_X2_CLK is the output of the XTAL_X2 generator circuit

enum soc_cpu_clk_src_t

  CPU_CLK mux inputs, which are the supported clock sources for the CPU_CLK.

  备注

  Enum values are matched with the register field values on purpose

  Values:

  enumerator SOC_CPU_CLK_SRC_XTAL

    Select XTAL_CLK as CPU_CLK source

  enumerator SOC_CPU_CLK_SRC_RC_FAST

    Select RC_FAST_CLK as CPU_CLK source

  enumerator SOC_CPU_CLK_SRC_XTAL_X2

    Select XTAL_X2_CLK as CPU_CLK source (XTAL_X2_CLK is the other output of 32MHz crystal oscillator frequency multiplier, 64MHz)

  enumerator SOC_CPU_CLK_SRC_PLL

    Select PLL_CLK as CPU_CLK source (PLL_CLK is the output of 32MHz crystal oscillator frequency multiplier, 96MHz)

  enumerator SOC_CPU_CLK_SRC_INVALID

    Invalid CPU_CLK source

enum soc_rtc_slow_clk_src_t

  RTC_SLOW_CLK mux inputs, which are the supported clock sources for the RTC_SLOW_CLK.

  备注

  Enum values are matched with the register field values on purpose

  Values:

  enumerator SOC_RTC_SLOW_CLK_SRC_RC_SLOW_D4

    Select RC_SLOW_D4_CLK as RTC_SLOW_CLK source

  enumerator SOC_RTC_SLOW_CLK_SRC_XTAL32K

    Select XTAL32K_CLK as RTC_SLOW_CLK source

  enumerator SOC_RTC_SLOW_CLK_SRC_OSC_SLOW

    Select OSC_SLOW_CLK (external slow clock) as RTC_SLOW_CLK source

  enumerator SOC_RTC_SLOW_CLK_SRC_INVALID

    Invalid RTC_SLOW_CLK source

  enumerator SOC_RTC_SLOW_CLK_SRC_DEFAULT

    RC_SLOW_D4_CLK is the default clock source for RTC_SLOW_CLK

enum soc_rtc_fast_clk_src_t

  RTC_FAST_CLK mux inputs, which are the supported clock sources for the RTC_FAST_CLK.

  备注

  Enum values are matched with the register field values on purpose

  Values:

  enumerator SOC_RTC_FAST_CLK_SRC_RC_FAST

    Select RC_FAST_CLK as RTC_FAST_CLK source

  enumerator SOC_RTC_FAST_CLK_SRC_XTAL_D2

    Select XTAL_D2_CLK as RTC_FAST_CLK source

  enumerator SOC_RTC_FAST_CLK_SRC_XTAL_DIV

    Alias name for `SOC_RTC_FAST_CLK_SRC_XTAL_D2`

  enumerator SOC_RTC_FAST_CLK_SRC_INVALID

    Invalid RTC_FAST_CLK source

  enumerator SOC_RTC_FAST_CLK_SRC_DEFAULT

    XTAL_D2_CLK is the default clock source for RTC_FAST_CLK

enum soc_xtal_freq_t

  Possible main XTAL frequency options on the target.

  备注

  Enum values equal to the frequency value in MHz

  备注

  Not all frequency values listed here are supported in IDF. Please check SOC_XTAL_SUPPORT_XXX in soc_caps.h for the supported ones.

  Values:

  enumerator SOC_XTAL_FREQ_32M

    32MHz XTAL

enum soc_module_clk_t

  Supported clock sources for modules (CPU, peripherals, RTC, etc.)

  备注

  enum starts from 1, to save 0 for special purpose

  Values:

  enumerator SOC_MOD_CLK_CPU

    CPU_CLK can be sourced from XTAL, PLL, RC_FAST, or XTAL_X2 by configuring soc_cpu_clk_src_t

  enumerator SOC_MOD_CLK_RTC_FAST

    RTC_FAST_CLK can be sourced from XTAL_D2 or RC_FAST by configuring soc_rtc_fast_clk_src_t

  enumerator SOC_MOD_CLK_RTC_SLOW

    RTC_SLOW_CLK can be sourced from RC_SLOW_D4, XTAL32K, or OSC_SLOW by configuring soc_rtc_slow_clk_src_t

  enumerator SOC_MOD_CLK_XTAL_X2_F32M

    XTAL_X2_F32M_CLK is derived from XTAL_X2 (clock gating + fixed divider of 2), it has a fixed frequency of 32MHz

  enumerator SOC_MOD_CLK_PLL_F48M

    PLL_F48M_CLK is derived from PLL (clock gating + fixed divider of 2), it has a fixed frequency of 48MHz

  enumerator SOC_MOD_CLK_XTAL_X2_F64M

    XTAL_X2_F64M_CLK is derived from XTAL_X2 (clock gating), it has a fixed frequency of 64MHz

  enumerator SOC_MOD_CLK_PLL_F96M

    PLL_F96M_CLK is derived from PLL (clock gating), it has a fixed frequency of 96MHz

  enumerator SOC_MOD_CLK_XTAL32K

    XTAL32K_CLK comes from the external 32kHz crystal, passing a clock gating to the peripherals

  enumerator SOC_MOD_CLK_RC_FAST

    RC_FAST_CLK comes from the internal 20MHz rc oscillator, passing a clock gating to the peripherals

  enumerator SOC_MOD_CLK_XTAL

    XTAL_CLK comes from the external 32MHz crystal

  enumerator SOC_MOD_CLK_INVALID

    Indication of the end of the available module clock sources

enum soc_periph_systimer_clk_src_t

  Type of SYSTIMER clock source.

  Values:

  enumerator SYSTIMER_CLK_SRC_XTAL

    SYSTIMER source clock is XTAL

  enumerator SYSTIMER_CLK_SRC_RC_FAST

    SYSTIMER source clock is RC_FAST

  enumerator SYSTIMER_CLK_SRC_DEFAULT

    SYSTIMER source clock default choice is XTAL

enum soc_periph_gptimer_clk_src_t

  Type of GPTimer clock source.

  Values:

  enumerator GPTIMER_CLK_SRC_PLL_F48M

    Select PLL_F48M as the source clock

  enumerator GPTIMER_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator GPTIMER_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator GPTIMER_CLK_SRC_DEFAULT

    Select PLL_F48M as the default choice

enum soc_periph_rmt_clk_src_t

  Type of RMT clock source.

  Values:

  enumerator RMT_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator RMT_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator RMT_CLK_SRC_DEFAULT

    Select XTAL as the default choice

enum soc_periph_pcnt_clk_src_t

  Type of PCNT clock source.

  Values:

  enumerator PCNT_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator PCNT_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator PCNT_CLK_SRC_DEFAULT

    Select XTAL as the default choice

enum soc_periph_temperature_sensor_clk_src_t

  Type of Temp Sensor clock source.

  Values:

  enumerator TEMPERATURE_SENSOR_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator TEMPERATURE_SENSOR_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator TEMPERATURE_SENSOR_CLK_SRC_DEFAULT

    Select XTAL as the default choice

enum soc_periph_uart_clk_src_legacy_t

  Type of UART clock source, reserved for the legacy UART driver.

  Values:

  enumerator UART_SCLK_PLL_F48M

    UART source clock is PLL_F48M

  enumerator UART_SCLK_RTC

    UART source clock is RC_FAST

  enumerator UART_SCLK_XTAL

    UART source clock is XTAL

  enumerator UART_SCLK_DEFAULT

    UART source clock default choice is PLL_F48M

enum soc_periph_spi_clk_src_t

  Type of SPI clock source.

  Values:

  enumerator SPI_CLK_SRC_DEFAULT

    Select PLL_F48M as SPI source clock

  enumerator SPI_CLK_SRC_XTAL

    Select XTAL as SPI source clock

  enumerator SPI_CLK_SRC_PLL_F48M

    Select PLL_48M as SPI source clock

  enumerator SPI_CLK_SRC_RC_FAST

    Select RC_FAST as SPI source clock

enum soc_periph_mwdt_clk_src_t

  MWDT clock source.

  Values:

  enumerator MWDT_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator MWDT_CLK_SRC_PLL_F48M

    Select PLL fixed 48MHz as the source clock

  enumerator MWDT_CLK_SRC_RC_FAST

    Select RTC fast as the source clock

  enumerator MWDT_CLK_SRC_DEFAULT

    Select XTAL as the default clock choice

enum soc_periph_flash_clk_src_t

  FLASH MSPI controller clock source.

  Values:

  enumerator FLASH_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator FLASH_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator FLASH_CLK_SRC_REF_F64M

    Select XTAL_X2_F64M as the source clock

  enumerator FLASH_CLK_SRC_PLL_F48M

    Select PLL_F48M as the source clock

  enumerator FLASH_CLK_SRC_DEFAULT

    Select XTAL_X2_F64M as the default clock choice

  enumerator FLASH_CLK_SRC_ROM_DEFAULT

    Select XTAL as ROM default clock source

enum soc_clkout_sig_id_t

  Clock output signal ID.

  Values:

  enumerator CLKOUT_SIG_MODEM_8M

    8MHz clock for modem (clk8M)

  enumerator CLKOUT_SIG_MODEM_16M

    16MHz clock for modem (clk16)

  enumerator CLKOUT_SIG_MODEM_32M

    32MHz clock for modem (clk32)

  enumerator CLKOUT_SIG_XTAL

    32MHz main crystal oscillator clock

  enumerator CLKOUT_SIG_RTC_FAST

    16MHz RTC fast clock from LP system

  enumerator CLKOUT_SIG_TIMERGROUP0

    32MHz timergroup0 function clock (default is xtal)

  enumerator CLKOUT_SIG_I2S_APB

    32MHz I2S APB clock

  enumerator CLKOUT_SIG_CPU

    32MHz CPU debug mode clock

  enumerator CLKOUT_SIG_AHB

    32MHz REGDMA AHB clock

  enumerator CLKOUT_SIG_XTAL32K

    32KHz external crystal clock

  enumerator CLKOUT_SIG_EXT32K

    32KHz external slow clock input

  enumerator CLKOUT_SIG_RC_FAST

    8MHz FOSC clock (RTC fast clock)

  enumerator CLKOUT_SIG_RC_SLOW

    600KHz SOSC clock (RTC slow clock)

  enumerator CLKOUT_SIG_INVALID

enum soc_clk_freq_calculation_src_t

  Clock frequency calculation source selection.

  Values:

  enumerator CLK_CAL_RTC_SLOW

    Select to calculate frequency of RTC_SLOW_CLK

  enumerator CLK_CAL_RC_SLOW

    Select to calculate frequency of RC_SLOW_CLK

  enumerator CLK_CAL_32K_XTAL

    Select to calculate frequency of XTAL32K_CLK

  enumerator CLK_CAL_32K_OSC_SLOW

    Select to calculate frequency of OSC_SLOW_CLK (external slow clock)

  enumerator CLK_CAL_RC_FAST

    Select to calculate frequency of RC_FAST_CLK

  enumerator CLK_CAL_CPU

    Select to calculate frequency of CPU_CLK

  enumerator CLK_CAL_AHB

    Select to calculate frequency of AHB_CLK

  enumerator CLK_CAL_APB

    Select to calculate frequency of APB_CLK

  enumerator CLK_CAL_SEC

    Select to calculate frequency of SEC_CLK

  enumerator CLK_CAL_MSPI

    Select to calculate frequency of MSPI_CLK

  enumerator CLK_CAL_IOMUX

    Select to calculate frequency of IOMUX_CLK

  enumerator CLK_CAL_PARLIO_RX

    Select to calculate frequency of PARLIO_RX_CLK

  enumerator CLK_CAL_PARLIO_TX

    Select to calculate frequency of PARLIO_TX_CLK

  enumerator CLK_CAL_GPSPI3_MST

    Select to calculate frequency of GPSPI3_MST_CLK

  enumerator CLK_CAL_GPSPI2_MST

    Select to calculate frequency of GPSPI2_MST_CLK

  enumerator CLK_CAL_EXT_IO

    Select to calculate frequency of an external clock from an IO

enum soc_periph_i2c_clk_src_t

  Type of I2C clock source.

  Values:

  enumerator I2C_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator I2C_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator I2C_CLK_SRC_DEFAULT

    Select XTAL as the default clock choice

enum soc_periph_ledc_clk_src_legacy_t

  Type of LEDC clock source, reserved for the legacy LEDC driver.

  Values:

  enumerator LEDC_AUTO_CLK

    LEDC source clock will be automatically selected based on the giving resolution and duty parameter when init the timer

  enumerator LEDC_USE_PLL_DIV_CLK

    Select PLL_F96M clock as the source clock

  enumerator LEDC_USE_RC_FAST_CLK

    Select RC_FAST as the source clock

  enumerator LEDC_USE_XTAL_CLK

    Select XTAL as the source clock

enum soc_periph_mcpwm_timer_clk_src_t

  Type of MCPWM timer clock source.

  Values:

  enumerator MCPWM_TIMER_CLK_SRC_PLL96M

    Select PLL_F96M as the source clock

  enumerator MCPWM_TIMER_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator MCPWM_TIMER_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator MCPWM_TIMER_CLK_SRC_DEFAULT

    Select PLL_F96M as the default clock choice

enum soc_periph_mcpwm_capture_clk_src_t

  Type of MCPWM capture clock source.

  Values:

  enumerator MCPWM_CAPTURE_CLK_SRC_PLL96M

    Select PLL_F96M as the source clock

  enumerator MCPWM_CAPTURE_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator MCPWM_CAPTURE_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator MCPWM_CAPTURE_CLK_SRC_DEFAULT

    Select PLL_F96M as the default clock choice

enum soc_periph_mcpwm_carrier_clk_src_t

  Type of MCPWM carrier clock source.

  Values:

  enumerator MCPWM_CARRIER_CLK_SRC_PLL96M

    Select PLL_F96M as the source clock

  enumerator MCPWM_CARRIER_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator MCPWM_CARRIER_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator MCPWM_CARRIER_CLK_SRC_DEFAULT

    Select PLL_F96M as the default clock choice

enum soc_periph_i2s_clk_src_t

  I2S clock source enum.

  Values:

  enumerator I2S_CLK_SRC_DEFAULT

    Select PLL_F96M as the default source clock

  enumerator I2S_CLK_SRC_PLL_96M

    Select PLL_F96M as the source clock

  enumerator I2S_CLK_SRC_XTAL_X2

    Select XTAL_X2_F64M as the source clock

  enumerator I2S_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator I2S_CLK_SRC_EXTERNAL

    Select external clock as source clock

enum soc_periph_sdm_clk_src_t

  Sigma Delta Modulator clock source.

  Values:

  enumerator SDM_CLK_SRC_XTAL

    Select XTAL clock as the source clock

  enumerator SDM_CLK_SRC_PLL_F48M

    Select PLL_F48M clock as the source clock

  enumerator SDM_CLK_SRC_DEFAULT

    Select PLL_F48M clock as the default clock choice

enum soc_periph_glitch_filter_clk_src_t

  Glitch filter clock source.

  Values:

  enumerator GLITCH_FILTER_CLK_SRC_XTAL

    Select XTAL clock as the source clock

  enumerator GLITCH_FILTER_CLK_SRC_PLL_F48M

    Select PLL_F48M clock as the source clock

  enumerator GLITCH_FILTER_CLK_SRC_DEFAULT

    Select PLL_F48M clock as the default clock choice

enum soc_periph_ana_cmpr_clk_src_t

  Type of Analog Comparator clock source.

  Values:

  enumerator ANA_CMPR_CLK_SRC_XTAL

    Select XTAL clock as the source clock

  enumerator ANA_CMPR_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator ANA_CMPR_CLK_SRC_PLL_F48M

    Select PLL_F48M as the source clock

  enumerator ANA_CMPR_CLK_SRC_DEFAULT

    Select PLL_F48M as the default clock choice

enum soc_periph_twai_clk_src_t

  TWAI clock source.

  Values:

  enumerator TWAI_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator TWAI_CLK_SRC_PLL_F96M

    Select PLL_96M as the source clock

  enumerator TWAI_CLK_SRC_DEFAULT

    Select PLL_96M as the default clock choice

enum soc_periph_parlio_clk_src_t

  PARLIO clock source.

  Values:

  enumerator PARLIO_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator PARLIO_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator PARLIO_CLK_SRC_PLL_F96M

    Select PLL_F96M as the source clock

  enumerator PARLIO_CLK_SRC_EXTERNAL

    Select EXTERNAL clock as the source clock

  enumerator PARLIO_CLK_SRC_DEFAULT

    Select PLL_F96M as the default clock choice

enum soc_periph_adc_digi_clk_src_t

  ADC digital controller clock source.

  Values:

  enumerator ADC_DIGI_CLK_SRC_XTAL

    Select XTAL as the source clock

  enumerator ADC_DIGI_CLK_SRC_RC_FAST

    Select RC_FAST as the source clock

  enumerator ADC_DIGI_CLK_SRC_DEFAULT

    Select XTAL as the default clock choice

### Header File

- components/esp_hw_support/include/esp_clk_tree.h

- This header file can be included with:

  >     #include "esp_clk_tree.h"

### Functions

esp_err_t esp_clk_tree_src_get_freq_hz(soc_module_clk_t clk_src, esp_clk_tree_src_freq_precision_t precision, uint32_t *freq_value)

  Get frequency of module clock source.

  参数:

    - clk_src -- [in] Clock source available to modules, in soc_module_clk_t

    - precision -- [in] Degree of precision, one of esp_clk_tree_src_freq_precision_t values This arg only applies to the clock sources that their frequencies can vary: SOC_MOD_CLK_RTC_FAST, SOC_MOD_CLK_RTC_SLOW, SOC_MOD_CLK_RC_FAST, SOC_MOD_CLK_RC_FAST_D256, SOC_MOD_CLK_XTAL32K For other clock sources, this field is ignored.

    - freq_value -- [out] Frequency of the clock source, in Hz

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_FAIL Calibration failed

esp_err_t esp_clk_tree_src_set_freq_hz(soc_module_clk_t clk_src, uint32_t expt_freq_value, uint32_t *ret_freq_value)

  Set frequency of module clock source.

  参数:

    - clk_src -- [in] Clock source available to modules, in soc_module_clk_t

    - expt_freq_value -- [in] Expected frequency of the clock source, in Hz

    - ret_freq_value -- [out] Real frequency of the clock source, in Hz

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_ERR_NOT_SUPPORTED Unsupported clock source

### Enumerations

enum esp_clk_tree_src_freq_precision_t

  Degree of precision of frequency value to be returned by esp_clk_tree_src_get_freq_hz()

  Values:

  enumerator ESP_CLK_TREE_SRC_FREQ_PRECISION_CACHED
  enumerator ESP_CLK_TREE_SRC_FREQ_PRECISION_APPROX
  enumerator ESP_CLK_TREE_SRC_FREQ_PRECISION_EXACT
  enumerator ESP_CLK_TREE_SRC_FREQ_PRECISION_INVALID

此文档对您有帮助吗？

- 反馈已收到，谢谢！
- 如果您有其他意见，欢迎填写乐鑫文档反馈表。

- 我们重视您的反馈。
- 您可以填写乐鑫文档反馈表告诉我们如何改进该文档。