Commit Graph

16 Commits

Author SHA1 Message Date
Jack
811c64c17c docs(esp_hw_support): fix IEEE 802.15.4 spelling and EUI-64 byte-range notation
Correct "802.154" to "802.15.4" and change the EUI-64 derivation notation
from base_mac[0:3]/base_mac[3:6] to the inclusive base_mac[0:2]/base_mac[3:5]
in the esp32h2/esp32h21/esp32h4 Kconfig.mac help text and the EN/zh_CN
misc_system_api docs.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-08 15:13:52 +08:00
Jack
e3bc260178 docs(esp_hw_support): document one-universal-MAC scheme and esp32s31 Four-option constraint
Add help text to the esp32h2/esp32h21/esp32h4 Kconfig.mac explaining
that these chips only consume one universally administered MAC address:
the IEEE 802.154 EUI-64 is derived from the base MAC and MAC_EXT, and
Bluetooth reuses the base MAC as-is (no BT offset, since there is no
Wi-Fi).

Add a matching 1-MAC derivation table and note to misc_system_api.rst
(EN and zh_CN) under a new `.. only:: esp32h2 or esp32h21 or esp32h4`
block, and exclude these targets from the generic 4/2 table.

Add an esp32s31-only note stating that the "Four" option may only be
used with a customer-provided custom base MAC range, since ESP32-S31
only provides two universally administered MAC addresses in eFuse.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-06 19:00:01 +08:00
Konstantin Kondrashov
658fbfcb0e Merge branch 'doc/mac_doc_update_esp32p4' into 'master'
fix(doc): Update MAC-address related documentation for ESP32-P4

Closes IDFGH-17141

See merge request espressif/esp-idf!45933
2026-03-11 03:31:14 +02:00
Krzysztof
8ad2be7980 docs(debugging): Add debug helpers API reference 2026-03-09 11:06:22 +08:00
Konstantin Kondrashov
690256b982 fix(doc): Update MAC-address related documentation for ESP32-P4
Closes https://github.com/espressif/esp-idf/issues/18159
2026-03-06 14:28:32 +02:00
Marius Vikhammer
034f677563 docs(misc): update system docs for new chips 2025-03-20 09:01:11 +08:00
Linda
e5019c9da0 docs: update application examples related to system 2024-08-16 16:16:58 +08:00
Marius Vikhammer
ac3915f092 docs(esp32p4): update misc docs for esp32p4 2023-12-09 09:09:55 +08:00
Cai Xin Ying
03c15adc94 docs: update format issues for EN and CN files under api-reference/system and... 2023-08-03 11:32:07 +08:00
Mahavir Jain
0970fc7e0d docs: fix reference to custom mac address API 2023-05-15 11:30:24 +05:30
daiziyan
9ba9dc04b0 docs: updated flash-encryption, startup, memory-types and misc_system_api 2023-03-07 18:06:52 +08:00
Sudeep Mohanty
371fe114bc docs: Updated chip independednt api-reference chapters for c6 and h2 2023-02-03 15:00:27 +01:00
Mo Fei Fei
689c2f46e2 Docs: update CN trans for sleep_modes.rst, misc_system_api.rst, migration_guides/peripherals.rst 2022-12-20 10:35:49 +08:00
KonstantinKondrashov
244cf14ea8 esp_hw_support: Adds APIs to define user own MAC addresses without generation from the base MAC address
Closes https://github.com/espressif/esp-idf/pull/7261
Closes https://github.com/espressif/esp-idf/issues/9531
2022-11-16 19:23:10 +08:00
Laukik Hase
ae932c8c4e docs: Added migration guide for app_update
- Deprecated functions and alternatives
2022-08-17 10:59:31 +05:30
mofeifei
3a35ed7cfa docs:change system.rst name 2022-04-20 13:11:02 +08:00