diff --git a/components/soc/esp32/include/soc/clk_tree_defs.h b/components/soc/esp32/include/soc/clk_tree_defs.h index b1e149012e..ac26e6a3e0 100644 --- a/components/soc/esp32/include/soc/clk_tree_defs.h +++ b/components/soc/esp32/include/soc/clk_tree_defs.h @@ -9,7 +9,7 @@ extern "C" { #endif -/** +/* ************************* ESP32 Root Clock Source **************************** * 1) Internal 8MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * diff --git a/components/soc/esp32c2/include/soc/clk_tree_defs.h b/components/soc/esp32c2/include/soc/clk_tree_defs.h index fe9f684513..71f12d83f0 100644 --- a/components/soc/esp32c2/include/soc/clk_tree_defs.h +++ b/components/soc/esp32c2/include/soc/clk_tree_defs.h @@ -9,7 +9,7 @@ extern "C" { #endif -/** +/* ************************ ESP32C2 Root Clock Source *************************** * 1) Internal 20MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * diff --git a/components/soc/esp32c3/include/soc/clk_tree_defs.h b/components/soc/esp32c3/include/soc/clk_tree_defs.h index 48a9fbc5f4..7f91d861e7 100644 --- a/components/soc/esp32c3/include/soc/clk_tree_defs.h +++ b/components/soc/esp32c3/include/soc/clk_tree_defs.h @@ -9,7 +9,7 @@ extern "C" { #endif -/** +/* ************************* ESP32C3 Root Clock Source **************************** * 1) Internal 20MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * diff --git a/components/soc/esp32h2/include/soc/clk_tree_defs.h b/components/soc/esp32h2/include/soc/clk_tree_defs.h index b981cec8b2..b53e87767c 100644 --- a/components/soc/esp32h2/include/soc/clk_tree_defs.h +++ b/components/soc/esp32h2/include/soc/clk_tree_defs.h @@ -9,7 +9,7 @@ extern "C" { #endif -/** +/* ************************ ESP32H2 Root Clock Source *************************** * 1) Internal 8MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * diff --git a/components/soc/esp32s2/include/soc/clk_tree_defs.h b/components/soc/esp32s2/include/soc/clk_tree_defs.h index 4d63a2f008..5fc3aba962 100644 --- a/components/soc/esp32s2/include/soc/clk_tree_defs.h +++ b/components/soc/esp32s2/include/soc/clk_tree_defs.h @@ -9,7 +9,7 @@ extern "C" { #endif -/** +/* ************************* ESP32S2 Root Clock Source **************************** * 1) Internal 8MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * diff --git a/components/soc/esp32s3/include/soc/clk_tree_defs.h b/components/soc/esp32s3/include/soc/clk_tree_defs.h index 90478bfc3e..d2ecad3792 100644 --- a/components/soc/esp32s3/include/soc/clk_tree_defs.h +++ b/components/soc/esp32s3/include/soc/clk_tree_defs.h @@ -9,7 +9,7 @@ extern "C" { #endif -/** +/* ************************* ESP32S3 Root Clock Source **************************** * 1) Internal 20MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * diff --git a/docs/en/api-reference/peripherals/clk_tree.rst b/docs/en/api-reference/peripherals/clk_tree.rst new file mode 100644 index 0000000000..f99ea69fa5 --- /dev/null +++ b/docs/en/api-reference/peripherals/clk_tree.rst @@ -0,0 +1,9 @@ +Clock Tree +========== + +Clock Source Definitions +------------------------ + +This section lists definitions of the {IDF_TARGET_NAME}'s supported root clocks and module clocks. These definitions are commonly used in the driver configuration, to help user select a proper source clock for the peripheral. + +.. include-build-file:: inc/clk_tree_defs.inc diff --git a/docs/en/api-reference/peripherals/index.rst b/docs/en/api-reference/peripherals/index.rst index e000edcfe9..5274eaf295 100644 --- a/docs/en/api-reference/peripherals/index.rst +++ b/docs/en/api-reference/peripherals/index.rst @@ -7,6 +7,7 @@ Peripherals API :maxdepth: 1 adc + clk_tree :SOC_DAC_SUPPORTED: dac gpio gptimer diff --git a/docs/zh_CN/api-reference/peripherals/clk_tree.rst b/docs/zh_CN/api-reference/peripherals/clk_tree.rst new file mode 100644 index 0000000000..ab20a668ac --- /dev/null +++ b/docs/zh_CN/api-reference/peripherals/clk_tree.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/peripherals/clk_tree.rst diff --git a/docs/zh_CN/api-reference/peripherals/index.rst b/docs/zh_CN/api-reference/peripherals/index.rst index 463e28eb35..c189070375 100644 --- a/docs/zh_CN/api-reference/peripherals/index.rst +++ b/docs/zh_CN/api-reference/peripherals/index.rst @@ -7,6 +7,7 @@ :maxdepth: 1 adc + clk_tree :SOC_DAC_SUPPORTED: dac gpio gptimer