Skip to content

Commit 1e72b10

Browse files
committed
docs(build): add support for building H21 docs
1 parent 4c5e1a0 commit 1e72b10

26 files changed

+803
-8
lines changed

.gitlab/ci/docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ check_docs_lang_sync:
9494
parallel:
9595
matrix:
9696
- DOCLANG: ["en", "zh_CN"]
97-
DOCTGT: ["esp32", "esp32s2", "esp32s3", "esp32c3", "esp32c2", "esp32c6", "esp32c61", "esp32c5","esp32h2", "esp32p4"]
97+
DOCTGT: ["esp32", "esp32s2", "esp32s3", "esp32c3", "esp32c2", "esp32c6", "esp32c61", "esp32c5","esp32h2", "esp32h21", "esp32p4"]
9898

9999
check_docs_gh_links:
100100
image: $ESP_IDF_DOC_ENV_IMAGE
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
choice ESP32H21_UNIVERSAL_MAC_ADDRESSES
2+
bool "Number of universally administered (by IEEE) MAC address"
3+
default ESP32H21_UNIVERSAL_MAC_ADDRESSES_TWO
4+
help
5+
Configure the number of universally administered (by IEEE) MAC addresses.
6+
During initialization, MAC addresses for each network interface are generated or derived from a
7+
single base MAC address.
8+
9+
config ESP32H21_UNIVERSAL_MAC_ADDRESSES_TWO
10+
bool "Two"
11+
select ESP_MAC_UNIVERSAL_MAC_ADDRESSES_TWO
12+
select ESP_MAC_ADDR_UNIVERSE_IEEE802154
13+
select ESP_MAC_ADDR_UNIVERSE_BT
14+
endchoice
15+
16+
config ESP32H21_UNIVERSAL_MAC_ADDRESSES
17+
int
18+
default 2 if ESP32H21_UNIVERSAL_MAC_ADDRESSES_TWO

components/soc/esp32h21/include/soc/Kconfig.soc_caps.in

+4-4
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,10 @@ config SOC_ANA_CMPR_INTR_SHARE_WITH_GPIO
259259
bool
260260
default y
261261

262+
config SOC_LEDC_CHANNEL_NUM
263+
int
264+
default 6
265+
262266
config SOC_MPI_MEM_BLOCKS_NUM
263267
int
264268
default 4
@@ -327,10 +331,6 @@ config SOC_SPI_SUPPORT_CONTINUOUS_TRANS
327331
bool
328332
default y
329333

330-
config SOC_SPI_SUPPORT_SLAVE_HD_VER2
331-
bool
332-
default y
333-
334334
config SOC_SPI_SUPPORT_CLK_XTAL
335335
bool
336336
default y
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/*
2+
* SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
#pragma once

components/soc/esp32h21/include/soc/soc_caps.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@
279279
/*-------------------------- LEDC CAPS ---------------------------------------*/
280280
// #define SOC_LEDC_SUPPORT_PLL_DIV_CLOCK (1)
281281
// #define SOC_LEDC_SUPPORT_XTAL_CLOCK (1)
282-
// #define SOC_LEDC_CHANNEL_NUM (6)
282+
#define SOC_LEDC_CHANNEL_NUM (6) // Check, todo IDF-11568
283283
// #define SOC_LEDC_TIMER_BIT_WIDTH (20)
284284
// #define SOC_LEDC_SUPPORT_FADE_STOP (1)
285285
// #define SOC_LEDC_GAMMA_CURVE_FADE_SUPPORTED (1)
@@ -384,7 +384,7 @@
384384
#define SOC_SPI_SLAVE_SUPPORT_SEG_TRANS 1
385385
#define SOC_SPI_SUPPORT_CD_SIG 1
386386
#define SOC_SPI_SUPPORT_CONTINUOUS_TRANS 1
387-
#define SOC_SPI_SUPPORT_SLAVE_HD_VER2 1
387+
// #define SOC_SPI_SUPPORT_SLAVE_HD_VER2 1 // TODO IDF-11587
388388
#define SOC_SPI_SUPPORT_CLK_XTAL 1
389389
#define SOC_SPI_SUPPORT_CLK_PLL_F48M 1
390390
#define SOC_SPI_SUPPORT_CLK_RC_FAST 1

docs/conf_common.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,8 @@
169169
SDM_DOCS = ['api-reference/peripherals/sdm.rst']
170170

171171
I2C_DOCS = ['api-reference/peripherals/i2c.rst',
172-
'api-reference/peripherals/lcd/i2c_lcd.rst']
172+
'api-reference/peripherals/lcd/i2c_lcd.rst',
173+
'api-reference/peripherals/i2c_slave_v1.rst']
173174

174175
SPI_DOCS = ['api-reference/peripherals/spi_master.rst',
175176
'api-reference/peripherals/spi_slave.rst',

docs/docs_not_updated/esp32h21.txt

+296
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,296 @@
1+
index.rst
2+
api-guides/openthread.rst
3+
api-guides/index.rst
4+
api-guides/c.rst
5+
api-guides/reproducible-builds.rst
6+
api-guides/core_dump_internals.rst
7+
api-guides/error-handling.rst
8+
api-guides/wifi-expansion.rst
9+
api-guides/deep-sleep-stub.rst
10+
api-guides/performance/index.rst
11+
api-guides/performance/ram-usage.rst
12+
api-guides/performance/speed.rst
13+
api-guides/performance/size.rst
14+
api-guides/app_trace.rst
15+
api-guides/esp-wifi-mesh.rst
16+
api-guides/startup.rst
17+
api-guides/usb-serial-jtag-console.rst
18+
api-guides/build-system.rst
19+
api-guides/thread-local-storage.rst
20+
api-guides/memory-types.rst
21+
api-guides/cplusplus.rst
22+
api-guides/core_dump.rst
23+
api-guides/lwip.rst
24+
api-guides/hardware-abstraction.rst
25+
api-guides/host-apps.rst
26+
api-guides/esp-ble-mesh/ble-mesh-faq.rst
27+
api-guides/esp-ble-mesh/ble-mesh-feature-list.rst
28+
api-guides/esp-ble-mesh/ble-mesh-index.rst
29+
api-guides/esp-ble-mesh/ble-mesh-terminology.rst
30+
api-guides/esp-ble-mesh/ble-mesh-architecture.rst
31+
api-guides/phy.rst
32+
api-guides/stdio.rst
33+
api-guides/flash_psram_config.rst
34+
api-guides/classic-bt/index.rst
35+
api-guides/classic-bt/overview.rst
36+
api-guides/unit-tests.rst
37+
api-guides/external-ram.rst
38+
api-guides/low-power-mode/index.rst
39+
api-guides/low-power-mode/low-power-mode-wifi.rst
40+
api-guides/low-power-mode/low-power-mode-soc.rst
41+
api-guides/general-notes.rst
42+
api-guides/wifi.rst
43+
api-guides/ble/index.rst
44+
api-guides/ble/overview.rst
45+
api-guides/ble/get-started/ble-device-discovery.rst
46+
api-guides/ble/get-started/ble-introduction.rst
47+
api-guides/ble/get-started/ble-data-exchange.rst
48+
api-guides/ble/get-started/ble-connection.rst
49+
api-guides/ble/host-feature-support-status.rst
50+
api-guides/ble/ble-qualification.rst
51+
api-guides/ble/blufi.rst
52+
api-guides/ble/ble-feature-support-status.rst
53+
api-guides/file-system-considerations.rst
54+
api-guides/jtag-debugging/index.rst
55+
api-guides/jtag-debugging/building-openocd-macos.rst
56+
api-guides/jtag-debugging/debugging-examples.rst
57+
api-guides/jtag-debugging/building-openocd-windows.rst
58+
api-guides/jtag-debugging/configure-ft2232h-jtag.rst
59+
api-guides/jtag-debugging/configure-other-jtag.rst
60+
api-guides/jtag-debugging/using-debugger.rst
61+
api-guides/jtag-debugging/building-openocd-linux.rst
62+
api-guides/jtag-debugging/tips-and-quirks.rst
63+
api-guides/jtag-debugging/configure-builtin-jtag.rst
64+
api-guides/bootloader.rst
65+
api-guides/hlinterrupts.rst
66+
api-guides/kconfig/index.rst
67+
api-guides/kconfig/project-configuration-guide.rst
68+
api-guides/kconfig/component-configuration-guide.rst
69+
api-guides/kconfig/configuration_structure.rst
70+
api-guides/inc/linux-host-requirements.rst
71+
api-guides/fatal-errors.rst
72+
api-guides/wifi-security.rst
73+
api-guides/RF_calibration.rst
74+
api-guides/usb-otg-console.rst
75+
api-guides/partition-tables.rst
76+
api-guides/linker-script-generation.rst
77+
api-guides/current-consumption-measurement-modules.rst
78+
api-guides/coexist.rst
79+
api-guides/wireshark-user-guide.rst
80+
api-guides/code-quality/index.rst
81+
api-guides/code-quality/static-analyzer.rst
82+
api-guides/dfu.rst
83+
about.rst
84+
get-started/index.rst
85+
get-started/flashing-troubleshooting.rst
86+
get-started/windows-setup.rst
87+
get-started/establish-serial-connection.rst
88+
get-started/windows-start-project.rst
89+
get-started/start-project.rst
90+
get-started/linux-macos-start-project.rst
91+
get-started/linux-macos-setup.rst
92+
get-started/windows-setup-update.rst
93+
hw-reference/index.rst
94+
api-reference/index.rst
95+
api-reference/network/index.rst
96+
api-reference/network/esp_eth.rst
97+
api-reference/network/esp-wifi-mesh.rst
98+
api-reference/network/esp_smartconfig.rst
99+
api-reference/network/esp_wifi.rst
100+
api-reference/network/esp_netif_programming.rst
101+
api-reference/network/esp_dpp.rst
102+
api-reference/network/esp_nan.rst
103+
api-reference/network/esp_now.rst
104+
api-reference/network/esp_netif_driver.rst
105+
api-reference/network/esp_netif.rst
106+
api-reference/network/esp_openthread.rst
107+
api-reference/provisioning/index.rst
108+
api-reference/provisioning/provisioning.rst
109+
api-reference/provisioning/protocomm.rst
110+
api-reference/provisioning/wifi_provisioning.rst
111+
api-reference/template.rst
112+
api-reference/kconfig-reference.rst
113+
api-reference/protocols/index.rst
114+
api-reference/protocols/esp_crt_bundle.rst
115+
api-reference/protocols/mdns.rst
116+
api-reference/protocols/asio.rst
117+
api-reference/protocols/mbedtls.rst
118+
api-reference/protocols/modbus.rst
119+
api-reference/protocols/icmp_echo.rst
120+
api-reference/protocols/esp_serial_slave_link.rst
121+
api-reference/protocols/esp_sdio_slave_protocol.rst
122+
api-reference/protocols/esp_https_server.rst
123+
api-reference/protocols/esp_local_ctrl.rst
124+
api-reference/protocols/esp_tls.rst
125+
api-reference/protocols/esp_spi_slave_protocol.rst
126+
api-reference/protocols/esp_http_client.rst
127+
api-reference/protocols/mqtt.rst
128+
api-reference/protocols/esp_http_server.rst
129+
api-reference/storage/mass_mfg.rst
130+
api-reference/storage/index.rst
131+
api-reference/storage/sdmmc.rst
132+
api-reference/storage/nvs_bootloader.rst
133+
api-reference/storage/wear-levelling.rst
134+
api-reference/storage/nvs_partition_gen.rst
135+
api-reference/storage/spiffs.rst
136+
api-reference/storage/nvs_flash.rst
137+
api-reference/storage/vfs.rst
138+
api-reference/storage/nvs_partition_parse.rst
139+
api-reference/storage/storage-security.rst
140+
api-reference/storage/fatfs.rst
141+
api-reference/storage/fatfsgen.rst
142+
api-reference/storage/nvs_encryption.rst
143+
api-reference/storage/partition.rst
144+
api-reference/error-codes.rst
145+
api-reference/bluetooth/index.rst
146+
api-reference/bluetooth/esp_gatts.rst
147+
api-reference/bluetooth/esp_hf_ag.rst
148+
api-reference/bluetooth/esp_gattc.rst
149+
api-reference/bluetooth/bt_le.rst
150+
api-reference/bluetooth/controller_vhci.rst
151+
api-reference/bluetooth/esp_spp.rst
152+
api-reference/bluetooth/esp_sdp.rst
153+
api-reference/bluetooth/esp_blufi.rst
154+
api-reference/bluetooth/bt_common.rst
155+
api-reference/bluetooth/esp_hf_client.rst
156+
api-reference/bluetooth/esp_hidh.rst
157+
api-reference/bluetooth/esp_gap_ble.rst
158+
api-reference/bluetooth/esp_avrc.rst
159+
api-reference/bluetooth/esp_gatt_defs.rst
160+
api-reference/bluetooth/nimble/index.rst
161+
api-reference/bluetooth/esp_bt_main.rst
162+
api-reference/bluetooth/esp_bt_device.rst
163+
api-reference/bluetooth/esp-ble-mesh.rst
164+
api-reference/bluetooth/esp_hidd.rst
165+
api-reference/bluetooth/esp_bt_defs.rst
166+
api-reference/bluetooth/esp_l2cap_bt.rst
167+
api-reference/bluetooth/esp_gap_bt.rst
168+
api-reference/bluetooth/classic_bt.rst
169+
api-reference/bluetooth/esp_a2dp.rst
170+
api-reference/bluetooth/esp_hf_defs.rst
171+
api-reference/peripherals/cap_touch_sens.rst
172+
api-reference/peripherals/index.rst
173+
api-reference/peripherals/rmt.rst
174+
api-reference/peripherals/ds.rst
175+
api-reference/peripherals/gptimer.rst
176+
api-reference/peripherals/sdio_slave.rst
177+
api-reference/peripherals/bitscrambler.rst
178+
api-reference/peripherals/temp_sensor.rst
179+
api-reference/peripherals/usb_device.rst
180+
api-reference/peripherals/i2c.rst
181+
api-reference/peripherals/jpeg.rst
182+
api-reference/peripherals/mcpwm.rst
183+
api-reference/peripherals/usb_host.rst
184+
api-reference/peripherals/clk_tree.rst
185+
api-reference/peripherals/camera_driver.rst
186+
api-reference/peripherals/touch_element.rst
187+
api-reference/peripherals/spi_master.rst
188+
api-reference/peripherals/adc_oneshot.rst
189+
api-reference/peripherals/twai.rst
190+
api-reference/peripherals/etm.rst
191+
api-reference/peripherals/sdspi_share.rst
192+
api-reference/peripherals/ana_cmpr.rst
193+
api-reference/peripherals/i2c_slave_v1.rst
194+
api-reference/peripherals/adc_continuous.rst
195+
api-reference/peripherals/hmac.rst
196+
api-reference/peripherals/uart.rst
197+
api-reference/peripherals/sdspi_host.rst
198+
api-reference/peripherals/spi_slave_hd.rst
199+
api-reference/peripherals/vad.rst
200+
api-reference/peripherals/i2s.rst
201+
api-reference/peripherals/isp.rst
202+
api-reference/peripherals/usb_host/usb_host_notes_usbh.rst
203+
api-reference/peripherals/usb_host/usb_host_notes_ext_hub.rst
204+
api-reference/peripherals/usb_host/usb_host_notes_arch.rst
205+
api-reference/peripherals/usb_host/usb_host_notes_index.rst
206+
api-reference/peripherals/usb_host/usb_host_notes_ext_port.rst
207+
api-reference/peripherals/usb_host/usb_host_notes_design.rst
208+
api-reference/peripherals/usb_host/usb_host_notes_enum.rst
209+
api-reference/peripherals/usb_host/usb_host_notes_dwc_otg.rst
210+
api-reference/peripherals/dedic_gpio.rst
211+
api-reference/peripherals/sd_pullup_requirements.rst
212+
api-reference/peripherals/parlio.rst
213+
api-reference/peripherals/adc_calibration.rst
214+
api-reference/peripherals/lp_i2s.rst
215+
api-reference/peripherals/ecdsa.rst
216+
api-reference/peripherals/gpio.rst
217+
api-reference/peripherals/dac.rst
218+
api-reference/peripherals/spi_slave.rst
219+
api-reference/peripherals/spi_flash/index.rst
220+
api-reference/peripherals/spi_flash/spi_flash_concurrency.rst
221+
api-reference/peripherals/spi_flash/spi_flash_override_driver.rst
222+
api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst
223+
api-reference/peripherals/spi_flash/spi_flash_idf_vs_rom.rst
224+
api-reference/peripherals/sdm.rst
225+
api-reference/peripherals/sdmmc_host.rst
226+
api-reference/peripherals/lcd/i80_lcd.rst
227+
api-reference/peripherals/lcd/index.rst
228+
api-reference/peripherals/lcd/dsi_lcd.rst
229+
api-reference/peripherals/lcd/i2c_lcd.rst
230+
api-reference/peripherals/lcd/spi_lcd.rst
231+
api-reference/peripherals/lcd/rgb_lcd.rst
232+
api-reference/peripherals/lcd/parl_lcd.rst
233+
api-reference/peripherals/pcnt.rst
234+
api-reference/peripherals/spi_features.rst
235+
api-reference/peripherals/ppa.rst
236+
api-reference/peripherals/ldo_regulator.rst
237+
api-reference/peripherals/ledc.rst
238+
api-reference/system/index.rst
239+
api-reference/system/freertos_idf.rst
240+
api-reference/system/misc_system_api.rst
241+
api-reference/system/chip_revision.rst
242+
api-reference/system/random.rst
243+
api-reference/system/soc_caps.rst
244+
api-reference/system/app_trace.rst
245+
api-reference/system/esp_function_with_shared_stack.rst
246+
api-reference/system/log.rst
247+
api-reference/system/mm_sync.rst
248+
api-reference/system/app_image_format.rst
249+
api-reference/system/ulp_macros.rst
250+
api-reference/system/ulp.rst
251+
api-reference/system/bootloader_image_format.rst
252+
api-reference/system/mm.rst
253+
api-reference/system/esp_https_ota.rst
254+
api-reference/system/perfmon.rst
255+
api-reference/system/wdts.rst
256+
api-reference/system/sleep_modes.rst
257+
api-reference/system/system_time.rst
258+
api-reference/system/himem.rst
259+
api-reference/system/async_memcpy.rst
260+
api-reference/system/console.rst
261+
api-reference/system/internal-unstable.rst
262+
api-reference/system/ulp_instruction_set.rst
263+
api-reference/system/ipc.rst
264+
api-reference/system/ota.rst
265+
api-reference/system/esp_event.rst
266+
api-reference/system/pthread.rst
267+
api-reference/system/esp_timer.rst
268+
api-reference/system/heap_debug.rst
269+
api-reference/system/efuse.rst
270+
api-reference/system/inc/power_management_esp32h21.rst
271+
api-reference/system/inc/show-efuse-table_ESP32-H21.rst
272+
api-reference/system/inc/espefuse_summary_ESP32-H21.rst
273+
api-reference/system/inc/espefuse_summary_ESP32-H21_dump.rst
274+
api-reference/system/inc/revisions_ESP32-H21.rst
275+
api-reference/system/esp_err.rst
276+
api-reference/system/freertos.rst
277+
api-reference/system/freertos_additions.rst
278+
api-reference/system/ulp-lp-core.rst
279+
api-reference/system/power_management.rst
280+
api-reference/system/ulp-risc-v.rst
281+
api-reference/system/mem_alloc.rst
282+
api-reference/system/intr_alloc.rst
283+
api-reference/api-conventions.rst
284+
security/index.rst
285+
security/flash-encryption.rst
286+
security/secure-boot-v1.rst
287+
security/security.rst
288+
security/security-features-enablement-workflows.rst
289+
security/secure-boot-v2.rst
290+
security/vulnerabilities.rst
291+
security/tee/index.rst
292+
security/tee/tee-advanced.rst
293+
security/tee/tee-sec-storage.rst
294+
security/tee/tee-ota.rst
295+
security/tee/tee.rst
296+
security/tee/tee-attestation.rst

docs/doxygen/Doxyfile_esp32h21

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
INPUT += \

0 commit comments

Comments
 (0)