alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-12-10 18:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add support for building H2 docs

Browse Source
This commit is contained in:
Marius Vikhammer
2023-01-06 15:25:58 +08:00
parent a786676d8d
commit 7100b7d1ff
27 changed files with 699 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/en/api-reference/peripherals/gpio/esp32h2.inc Normal file
View File

@@ -0,0 +1,30 @@
.. This file gets included from other .rst files in this folder.
.. It contains target-specific snippets.
.. Comments and '---' lines act as delimiters.
..
.. This is necessary mainly because RST doesn't support substitutions
.. (defined in RST, not in Python) inside code blocks. If that is ever implemented,
.. These code blocks can be moved back to the main .rst files, with target-specific
.. file names being replaced by substitutions.
.. gpio-summary
The {IDF_TARGET_NAME} chip features X physical GPIO pins (GPIOX ~ GPIOX). Each pin can be used as a general-purpose I/O, or to be connected to an internal peripheral signal. Through GPIO matrix and IO MUX, peripheral input signals can be from any IO pins, and peripheral output signals can be routed to any IO pins. Together these modules provide highly configurable I/O. For more details, see *{IDF_TARGET_NAME} Technical Reference Manual* > *IO MUX and GPIO Matrix (GPIO, IO_MUX)* [`PDF <{IDF_TARGET_TRM_EN_URL}#iomuxgpio>`__].
The table below provides more information on pin usage, and please note the comments in the table for GPIOs with restrictions.
.. list-table::
:header-rows: 1
:widths: 8 12 12 20
* - GPIO
- Analog Function
- LP GPIO
- Comments
* - GPIO0
-
-
-
---

6
docs/en/api-reference/peripherals/gptimer.rst
View File

@@ -25,7 +25,7 @@ The following sections of this document cover the typical steps to install and o
- :ref:`gptimer-register-event-callbacks` - covers how to hook user specific code to the alarm event callback function.
- :ref:`enable-and-disable-timer` - covers how to enable and disable the timer.
- :ref:`start-and-stop-timer` - shows some typical use cases that start the timer with different alarm behavior.
:SOC_TIMER_SUPPORT_ETM: - :ref:`gptimer-etm-event-and-task` - describes what the events and tasks can be connected to the ETM channel.
:SOC_ETM_SUPPORTED and SOC_TIMER_SUPPORT_ETM: - :ref:`gptimer-etm-event-and-task` - describes what the events and tasks can be connected to the ETM channel.
- :ref:`gptimer-power-management` - describes how different source clock selections can affect power consumption.
- :ref:`gptimer-iram-safe` - describes tips on how to make the timer interrupt and IO control functions work better along with a disabled cache.
- :ref:`gptimer-thread-safety` - lists which APIs are guaranteed to be thread safe by the driver.
@@ -260,7 +260,7 @@ Alarm value can be updated dynamically inside the ISR handler callback, by chang
ESP_ERROR_CHECK(gptimer_start(gptimer, &alarm_config));
.. only:: SOC_TIMER_SUPPORT_ETM
.. only:: SOC_ETM_SUPPORTED and SOC_TIMER_SUPPORT_ETM
.. _gptimer-etm-event-and-task:
@@ -273,7 +273,7 @@ Alarm value can be updated dynamically inside the ISR handler callback, by chang
.. _gptimer-power-management:
.. only:: not SOC_TIMER_SUPPORT_ETM
.. only:: not SOC_ETM_SUPPORTED or not SOC_TIMER_SUPPORT_ETM
.. _gptimer-power-management: