espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-13 17:44:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: added clk_tree definitions to doc

Browse Source
This commit is contained in:
morris
2022-04-24 15:12:14 +08:00
committed by songruojing
parent a5b09cf015
commit b26cd91537
10 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/soc/esp32/include/soc/clk_tree_defs.h
View File

@@ -9,7 +9,7 @@
extern "C" { extern "C" {
#endif #endif
/** /*
************************* ESP32 Root Clock Source **************************** ************************* ESP32 Root Clock Source ****************************
* 1) Internal 8MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * 1) Internal 8MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description)
* *

2
components/soc/esp32c2/include/soc/clk_tree_defs.h
View File

@@ -9,7 +9,7 @@
extern "C" { extern "C" {
#endif #endif
/** /*
************************ ESP32C2 Root Clock Source *************************** ************************ ESP32C2 Root Clock Source ***************************
* 1) Internal 20MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * 1) Internal 20MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description)
* *

2
components/soc/esp32c3/include/soc/clk_tree_defs.h
View File

@@ -9,7 +9,7 @@
extern "C" { extern "C" {
#endif #endif
/** /*
************************* ESP32C3 Root Clock Source **************************** ************************* ESP32C3 Root Clock Source ****************************
* 1) Internal 20MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * 1) Internal 20MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description)
* *

2
components/soc/esp32h2/include/soc/clk_tree_defs.h
View File

@@ -9,7 +9,7 @@
extern "C" { extern "C" {
#endif #endif
/** /*
************************ ESP32H2 Root Clock Source *************************** ************************ ESP32H2 Root Clock Source ***************************
* 1) Internal 8MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * 1) Internal 8MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description)
* *

2
components/soc/esp32s2/include/soc/clk_tree_defs.h
View File

@@ -9,7 +9,7 @@
extern "C" { extern "C" {
#endif #endif
/** /*
************************* ESP32S2 Root Clock Source **************************** ************************* ESP32S2 Root Clock Source ****************************
* 1) Internal 8MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * 1) Internal 8MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description)
* *

2
components/soc/esp32s3/include/soc/clk_tree_defs.h
View File

@@ -9,7 +9,7 @@
extern "C" { extern "C" {
#endif #endif
/** /*
************************* ESP32S3 Root Clock Source **************************** ************************* ESP32S3 Root Clock Source ****************************
* 1) Internal 20MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description) * 1) Internal 20MHz RC Oscillator: RC_FAST (usually referred as FOSC or CK8M/CLK8M in TRM and reg. description)
* *

9
docs/en/api-reference/peripherals/clk_tree.rst Normal file
View File

@@ -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

1
docs/en/api-reference/peripherals/index.rst
View File

@@ -7,6 +7,7 @@ Peripherals API
:maxdepth: 1 :maxdepth: 1
adc adc
clk_tree
:SOC_DAC_SUPPORTED: dac :SOC_DAC_SUPPORTED: dac
gpio gpio
gptimer gptimer

1
docs/zh_CN/api-reference/peripherals/clk_tree.rst Normal file
View File

@@ -0,0 +1 @@
.. include:: ../../../en/api-reference/peripherals/clk_tree.rst

1
docs/zh_CN/api-reference/peripherals/index.rst
View File

@@ -7,6 +7,7 @@
:maxdepth: 1 :maxdepth: 1
adc adc
clk_tree
:SOC_DAC_SUPPORTED: dac :SOC_DAC_SUPPORTED: dac
gpio gpio
gptimer gptimer