Commit Graph

2455 Commits

Author SHA1 Message Date
Angus Gratton
dc6b950257 doc: Add performance guides for execuion speed, binary size, RAM usage
Closes https://github.com/espressif/esp-idf/issues/7007
Closes https://github.com/espressif/esp-idf/issues/6715
Closes https://github.com/espressif/esp-idf/issues/3781
Closes https://github.com/espressif/esp-idf/issues/2566
2021-06-03 13:55:34 +10:00
Angus Gratton
c49c915bcc Merge branch 'feature/allow_efuses_be_nested_in_efuse_table' into 'master'
efuse: Adds support describe structures of efuses in efuse_table

Closes IDF-3200

See merge request espressif/esp-idf!13643
2021-06-01 06:31:20 +00:00
Marius Vikhammer
c7ead8cd73 docs: document contained an invalid character which couldnt be rendered in the PDF 2021-06-01 09:34:52 +08:00
Krzysztof Budzynski
c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master'
remove modules and boards section

Closes DOC-45 and DOC-355

See merge request espressif/esp-idf!12846
2021-05-31 11:12:51 +00:00
Krzysztof Budzynski
997170ede1 Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master'
docs: introduce new rules for formatting documents

See merge request espressif/esp-idf!13642
2021-05-31 10:07:19 +00:00
KonstantinKondrashov
29f853633d efuse: Adds support structure of efuses in efuse_table
Supported a new format of efuse description using '.' in the name.
It means that RD_DIS.KEYx belongs to the range of the RD_DIS name.
RD_DIS,                           EFUSE_BLK0,   32,    7,     Read protection
    RD_DIS.KEY0,                  EFUSE_BLK0,   32,    1,     Read protection for EFUSE_BLK4.
    RD_DIS.KEY1,                  EFUSE_BLK0,   33,    1,     Read protection for EFUSE_BLK5.
2021-05-31 08:42:57 +00:00
Hao Ning
fc0eba4101 remove modules and boards section
doc: add redirections

docs: rebase master and add redirect links

docs: delete invalid links labeled in modules-and-boards

docs:installed pre-commit config

docs:retry

docs: separate links of modules and boards

docs: removed original files and added one more redirection

docs:deleted invalid links in jtag-debugging

docs:replaced old links in jtag-debugging

docs:fixd pipeline failures
2021-05-31 16:19:15 +08:00
Simon Marchi
e627704a87 docs: Fix adapted / adopted typo
Merges https://github.com/espressif/esp-idf/pull/6327
2021-05-31 13:29:21 +08:00
daiziyan
8149eda0a9 docs: introduce new rules for writing documents 2021-05-31 10:56:18 +08:00
pedro.minatel
03cb5f8af8 Merge conflict fixed
Fixed the scale image on click to enlarge
2021-05-28 15:16:02 +01:00
Michael (XIAO Xufeng)
dd0c1c7d95 Merge branch 'bugfix/delete_i2c_cmd_mux_semaphore_more_cleanly' into 'master'
dreiver/i2c: delete i2c cmd_mux semaphore more cleanly

Closes IDFGH-5062

See merge request espressif/esp-idf!13399
2021-05-28 07:56:34 +00:00
Wang Ning
86a7d4c483 docs/update_strapping_pins_in_c3_devkit_user_guides 2021-05-28 03:56:22 +00:00
laokaiyao
b807f2a666 driver/i2c: add notes to i2c deleteing function 2021-05-27 12:43:22 +08:00
Marius Vikhammer
0c17973d54 docs: add rf calibration docs for S2 and C3 2021-05-26 10:09:50 +08:00
Krzysztof Budzynski
99e7aa1700 Merge branch 'docs/update_chip_comparsion_table' into 'master'
docs:translate chip series comparison table and update adc_types.h

Closes DOC-1278

See merge request espressif/esp-idf!13596
2021-05-25 10:44:01 +00:00
Wang Fang
71141a326d docs: clarified esp32 timer clk source, updated the flash encryption table and esptrace doc 2021-05-24 03:46:40 +00:00
Angus Gratton
e928d57663 Merge branch 'doc/include_bootloader_random' into 'master'
docs: Add RNG functions to API reference

See merge request espressif/esp-idf!13519
2021-05-20 09:14:55 +00:00
Angus Gratton
5c812742c6 docs: Add description for Linux getrandom() function 2021-05-20 17:08:17 +10:00
daiziyan
611ecc619b docs:translate chip series comparison table and update adc_types.h 2021-05-19 16:25:27 +08:00
Ivan Grokhotkov
38d902f544 Merge branch 'feature/gdbstubs_rt' into 'master'
Extension of GDBStub component for handling GDB by serial port at runtime.

See merge request espressif/esp-idf!10312
2021-05-18 17:14:51 +00:00
Krzysztof Budzynski
0bd357b2f1 Merge branch 'doc/delete_rom_comsole' into 'master'
DOC: Remove ROM console

See merge request espressif/esp-idf!13362
2021-05-18 10:10:56 +00:00
Wang Ning
19a407ed1a doc/remove_romconsole_since_it_is_no_longer_supported_from_ESP32_ECO3 2021-05-18 07:51:56 +00:00
Angus Gratton
e14edecf5f docs: Add random number generation to the API Reference System section 2021-05-18 16:05:42 +10:00
Angus Gratton
ede477ea65 paritition_table: Verify the partition table md5sum when loading the app
Additionally, always enable the partition MD5 check if flash encryption is on in
Release mode. This ensures the partition table ciphertext has not been modified
(CVE-2021-27926).

The exception is pre-V3.1 ESP-IDF bootloaders and partition tables, which
don't have support for the MD5 entry.
2021-05-18 01:32:59 +00:00
Angus Gratton
b7ad39f694 Merge branch 'bugfix/pthread_docs' into 'master'
Fix and improve pthread docs, create pthread example

Closes IDF-731 and IDFGH-5085

See merge request espressif/esp-idf!13314
2021-05-14 01:19:02 +00:00
Angus Gratton
a6dea64106 pthread: Add support for PTHREAD_COND_INITIALIZER
Includes unit test for condition variables in C (previous test was C++ only)
2021-05-14 10:03:11 +10:00
Angus Gratton
e6d15a0975 docs: Rename esp_pthread docs to pthread, expand details of supported APIs
- Move the code that was in the document out to an example
2021-05-14 10:03:11 +10:00
Dmitry
00a7ecb5a3 Code cleanup. Bugfix after rebase with master. Formating. 2021-05-13 15:03:40 +03:00
Krzysztof Budzynski
cc22768863 Merge branch 'docs/remove_c3_not_updated_warning' into 'master'
docs: remove front page C3 docs not updated warning

See merge request espressif/esp-idf!13442
2021-05-13 02:25:38 +00:00
Marius Vikhammer
fd477fa60e docs: remove front page C3 docs not updated warning 2021-05-13 09:58:20 +08:00
Dmitry
7bb91f912c gdbstub component 2021-05-11 15:55:39 +03:00
Roland Dobai
c68781c269 docs: Generate JTAG debugging guide based on feature instead of chip
It is better to check feature SOC_USB_SERIAL_JTAG_SUPPORTED which will
support other chip targets beside ESP32-C3.
2021-05-11 11:01:53 +02:00
Roland Dobai
826e9674d8 docs: Suggest how to use JTAG for ESP32-C3 on Windows 2021-05-11 11:01:53 +02:00
Mahavir Jain
74f9ce437f Merge branch 'bugfix/prov_docs_sample_code' into 'master'
docs: Change ESP_ERR_CHECK to ESP_ERROR_CHECK in provisioning examples

Closes IDFGH-5222 and IDFGH-5221

See merge request espressif/esp-idf!13491
2021-05-11 03:14:06 +00:00
David Čermák
2e4d5d8765 Merge branch 'feature/add_eth_lost_ip_event' into 'master'
event: Add IP_EVENT_ETH_LOST_IP event

Closes IDFGH-5198

See merge request espressif/esp-idf!13466
2021-05-10 07:27:16 +00:00
Alex Henrie
22964d2065 docs: Change ESP_ERR_CHECK to ESP_ERROR_CHECK in provisioning examples
Closes IDFGH-5222
Closes IDFGH-5221
Closes https://github.com/espressif/esp-idf/pull/6995
Closes https://github.com/espressif/esp-idf/issues/6994
2021-05-09 16:18:50 +05:30
David Cermak
c4870f4d9e esp_netif/wifi: Add API to destroy default wifi-netif for sta/ap
Partially addresses https://github.com/espressif/esp-idf/issues/6950
2021-05-07 11:56:41 +00:00
yuanjm
922992b519 event: Add IP_EVENT_ETH_LOST_IP event
Closes https://github.com/espressif/esp-idf/issues/6971
2021-05-07 11:36:13 +08:00
Cao Sen Miao
8e3a4c2351 doc: update gpio api guide reference on c3 2021-05-06 14:19:18 +08:00
Angus Gratton
ca89608f22 Merge branch 'feature/doc_fast_build' into 'master'
docs: add fast build feature and activate it in CI

See merge request espressif/esp-idf!13352
2021-05-06 03:56:56 +00:00
Marius Vikhammer
41b3043cb4 Add warning to docs output if fastbuild 2021-05-06 09:17:41 +08:00
a2800276
bef80909a8 Typo pthread doc: create->get
I believe that:

    esp_create_default_pthread_config

is a typo (no such function exists), the intention was almost certainly to use:

     esp_pthread_get_default_config

Closes https://github.com/espressif/esp-idf/pull/6869/
2021-05-04 17:30:17 +10:00
Michael (XIAO Xufeng)
1f95403596 Merge branch 'feature/emmc_doc_ut_4bit_sdr' into 'master'
sdmmc_host: add unit tests and improve documents about using eMMC in 4-line SDR mode

See merge request espressif/esp-idf!13334
2021-05-02 13:58:13 +00:00
Krzysztof Budzynski
b455299bb0 Merge branch 'feature/add_link_to_c3_page' into 'master'
docs: Add a link to ESP32-C3 page for developers on espressif.com

See merge request espressif/esp-idf!12349
2021-04-30 06:12:23 +00:00
Krzysztof Budzynski
bd5b14fd81 Merge branch 'bugfix/uart_api_reference_examples' into 'master'
docs: Update type of uart_num in UART API Reference examples

See merge request espressif/esp-idf!13385
2021-04-30 06:08:46 +00:00
Michael (XIAO Xufeng)
859f7e3664 Merge branch 'feature/support_eon_flash_qaud_mode_esp_flash' into 'master'
esp_flash: support override default chip driver list

Closes IDF-2907

See merge request espressif/esp-idf!12565
2021-04-29 04:03:56 +00:00
Krzysztof
7b9b489968 docs: Update type of uart_num in UART API Reference examples 2021-04-28 13:11:41 +02:00
pedro.minatel
a6798eac98 Added LEDC basic PWM example
Changes on the ledc_init function
Review on the README, docs and example functions
Added how to set freq and duty on README
Fix on the ledc.rst docs in the App Example
Added new example reference in the Chinese docs
2021-04-28 11:11:07 +01:00
Krzysztof
34a16c9d93 docs: Add a link to ESP32-C3 page for developers on espressif.com 2021-04-28 10:42:09 +02:00
Jeroen Domburg
644f430a31 Merge branch 'feature/esp32c3_usbjtagserial_console' into 'master'
USB serial/jtag controller: Add vfs (logging/printf), panic handler, gdb support.

See merge request espressif/esp-idf!12925
2021-04-28 08:38:31 +00:00
Jeroen Domburg
2c75f63f89 * ets_delay_us(1) has too much overhead; change logic
* Fix MR comments
2021-04-28 16:38:24 +08:00
Marius Vikhammer
89179dc286 docs: add fast build feature and activate it in CI
Adds feature for skipping include of doxygen headers into sphinx build
when env variable is set.

Builds incomplete docs (no function API documention)
but speeds up building (20min to 1<min).

Add this fast build as the default way of building docs in CI on
non protected branches.
2021-04-28 16:32:35 +08:00
Jiang Jiang Jian
3c0801584a Merge branch 'bugfix/update_esp32c3_docs' into 'master'
Bugfix/update esp32c3 wifi driver docs

See merge request espressif/esp-idf!13274
2021-04-28 07:40:20 +00:00
Krzysztof Budzynski
edb8ef9f2f Merge branch 'doc/add_support_for_external_redirects' into 'master'
Docs: Add support for redirects to external URL

See merge request espressif/esp-idf!13364
2021-04-28 05:58:04 +00:00
Ivan Grokhotkov
f86a6db1f2 Merge branch 'feature/espcoredump_py_riscv_support' into 'master'
feature: espcoredump py riscv support

Closes IDF-2638 and IDF-2715

See merge request espressif/esp-idf!12259
2021-04-27 09:26:52 +00:00
Darian Leung
50fe1eea15 doc: Add support for redirects to external URL
This commit adds support for redirections to external URLs in the html_redirects.py extension
2021-04-27 17:01:24 +08:00
chenjianxing
c66b1aeda7 update esp32c3 iperf config 2021-04-27 14:41:08 +08:00
Marius Vikhammer
e8b7d2ca08 docs: add warning for outdated versions 2021-04-27 09:02:11 +08:00
Fu Hanxi
74269eb6b8 docs(coredump): update coredump documentation 2021-04-26 20:44:23 +08:00
Michael (XIAO Xufeng)
26585b4b4b esp_flash: support override default chip driver list 2021-04-26 16:05:42 +08:00
Ivan Grokhotkov
e77a91df7f Merge branch 'doc/ulp_st_bits' into 'master'
ulp: update ST instruction description (Github PR)

Closes IDFGH-3224

See merge request espressif/esp-idf!13159
2021-04-26 07:15:15 +00:00
Michael (XIAO Xufeng)
02970813b8 sdmmc_host: add unit tests and improve documents about using eMMC in 4-line SDR mode 2021-04-25 18:34:37 +08:00
Michael (XIAO Xufeng)
5997fcd45d Merge branch 'feature/update_adc_programming_guide_on_c3' into 'master'
adc: update esp32c3 programming guide

Closes IDF-2333

See merge request espressif/esp-idf!12563
2021-04-23 12:52:07 +00:00
Brian Alberto Ignacio Reyes
b630c45d91 docs: Fix vscode extension setup links 2021-04-23 20:45:24 +08:00
Angus Gratton
2f70a76572 Merge branch 'bugfix/mac_addr_target_support' into 'master'
system: Restructure MAC address support documentation

See merge request espressif/esp-idf!13298
2021-04-23 10:56:42 +00:00
Ivan Grokhotkov
ea7d020f20 Merge branch 'feature/ubsan' into 'master'
system: add option to enable undefined behavior sanitizer (UBSAN)

Closes IDF-166 and IDF-1824

See merge request espressif/esp-idf!11318
2021-04-23 09:27:42 +00:00
Ivan Grokhotkov
9522034144 Merge branch 'doc/linux_host_testing' into 'master'
Doc: Linux host test documentation

See merge request espressif/esp-idf!11857
2021-04-23 09:08:42 +00:00
Angus Gratton
c3101fff88 Merge branch 'docs/add_pre-commit_uninstall' into 'master'
Add line to documentation how to uninstall pre-commit.

See merge request espressif/esp-idf!13205
2021-04-23 08:09:36 +00:00
Krzysztof Budzynski
632b5c40e6 Revert "Merge branch 'doc/use_sphinx_reredirect_extension' into 'master'"
This reverts merge request !13293
2021-04-23 13:44:40 +08:00
Krzysztof Budzynski
3e94dce15e Merge branch 'doc/use_sphinx_reredirect_extension' into 'master'
Doc: Sphinx uses the sphinx-reredirect extension

See merge request espressif/esp-idf!13293
2021-04-23 05:13:37 +00:00
Krzysztof Budzynski
dc37ac812a Merge branch 'doc/style_guide_headers' into 'master'
docs: style guide: add note about header guards and include file order

See merge request espressif/esp-idf!13129
2021-04-23 04:00:28 +00:00
Michael (XIAO Xufeng)
fdb8736a95 Merge branch 'feature/spi_slave_hd_segment_example' into 'master'
spi_slave_halfduplex: add an example for segment mode

Closes IDF-1699

See merge request espressif/esp-idf!10043
2021-04-23 03:23:25 +00:00
Jakob Hasse
68393c41c4 doc: linux host test documentation 2021-04-23 09:27:35 +08:00
Ivan Grokhotkov
9069f70db3 system: add option to enable undefined behavior sanitizer (UBSAN)
Closes https://github.com/espressif/esp-idf/issues/1574
2021-04-22 23:33:45 +02:00
Darian Leung
2be772af1c Sphinx uses reredirect extension
This commit removes the custom HTML rediiect extension and uses
the sphinx-reredirect extension instead. The sphinx-reredirect
extension allows for redirection to external links as well as
support for wildcards.
2021-04-23 00:02:30 +08:00
Krzysztof Budzynski
58424ccebf Merge branch 'bugfix/doc_jtag_c3' into 'master'
docs: Update JTAG debugging guides for ESP32-C3

Closes IDF-2133

See merge request espressif/esp-idf!13102
2021-04-22 11:58:34 +00:00
Armando
6930d6aa1e spi_slave_hd: add segment mode example 2021-04-22 19:24:59 +08:00
Krzysztof Budzynski
2f8ccd5e3b Merge branch 'docs/update_CN_trans_buildsystem' into 'master'
update CN translation for build-system and linker-script-generation

See merge request espressif/esp-idf!13168
2021-04-22 08:08:38 +00:00
Dai Zi Yan
e91861253f docs:updated CN tranlation for build-system, ulp, unit-tests, idf-monitor and linker-script-generation 2021-04-22 16:08:31 +08:00
Dai Zi Yan
4aa52da0c1 update CN translation for I2C 2021-04-22 16:05:01 +08:00
Angus Gratton
7cb83c8787 system doc: Re-structure description of MAC addresses, especially on newer chip targets
Includes a note about calculating the Ethernet MAC on platforms with no built-in
Ethernet, and removes documentation for esp_efuse_mac_get_custom() on targets
other than ESP32
2021-04-22 16:08:55 +10:00
Armando
3177130256 adc: add adc programming guide on c3 2021-04-21 10:40:55 +08:00
Dmitry
aebf688153 Add line to documentation how to uninstall pre-commit. 2021-04-20 03:53:54 +00:00
Ivan Grokhotkov
6a3971344b docs: style guide: add note about header guards and include file order 2021-04-19 16:32:58 +02:00
Angus Gratton
209a6cc855 Merge branch 'bugfix/check_partitions_fit' into 'master'
cmake partition_table: Check binaries fit in partition spaces at build time

Closes IDF-1539 and IDFGH-2503

See merge request espressif/esp-idf!9330
2021-04-19 07:33:36 +00:00
Ivan Grokhotkov
fa72ef6bd8 Merge branch 'feature/add-eventfd' into 'master'
vfs: add eventfd support

See merge request espressif/esp-idf!12573
2021-04-16 10:33:06 +00:00
Angus Gratton
6f6b4c3983 cmake partition_table: Check binaries fit in partition spaces at build time
- Bootloader is checked not to overlap partition table
- Apps are checked not to overlap any app partition regions

Supported for CMake build system only.

Closes https://github.com/espressif/esp-idf/pull/612
Closes https://github.com/espressif/esp-idf/issues/5043
Probable fix for https://github.com/espressif/esp-idf/issues/5456
2021-04-16 16:40:47 +10:00
Michael (XIAO Xufeng)
cf457d412a Merge branch 'feature/update_spi_programming_guide_on_c3' into 'master'
spi: update esp32c3 programming guide

Closes IDF-2343

See merge request espressif/esp-idf!12490
2021-04-16 04:22:57 +00:00
boarchuz
7e7c044afa update ulp st doc
Merges https://github.com/espressif/esp-idf/pull/5222
2021-04-15 16:16:11 +02:00
Armando
370fedf967 spi_master: enable spi speed test on c3 and update the programming guide
accordingly
2021-04-15 21:20:19 +08:00
Armando
9aa9939406 spi: update esp32c3 programming guide 2021-04-15 21:20:19 +08:00
Jiacheng Guo
40035edcac vfs: add doc links 2021-04-15 15:19:00 +08:00
Omar Chebib
bb9aa806f7 panic: handlers can now be placed in flash
By unchecking "Place panic handler code in IRAM" in the menuconfig,
the panic handlers will be placed in flash. Of course, flash cache must
be activated when entering panic handlers.
2021-04-15 11:58:46 +08:00
Krzysztof Budzynski
d14661eaa3 Merge branch 'docs/programming_guide_c3_update_twai' into 'master'
Update TWAI driver docs and registers for esp32c3

Closes IDF-2349

See merge request espressif/esp-idf!12935
2021-04-15 02:35:28 +00:00
Ivan Grokhotkov
bf49917233 Merge branch 'doc/macos_ftdi_jtag' into 'master'
docs: jtag debugging: add macOS 10.15 FTDI details (Github PR)

Closes IDFGH-4078

See merge request espressif/esp-idf!13104
2021-04-14 11:36:12 +00:00
Angus Gratton
b63c6785a9 Merge branch 'doc/bootloader_app_compatibility' into 'master'
doc: Add notes about bootloader compatibility

Closes IDF-902

See merge request espressif/esp-idf!13024
2021-04-14 07:15:47 +00:00
Darian Leung
7087f80b1e Update TWAI driver docs and registers for esp32c3
This commit updates the documentation and register struct
of the TWAI driver for the ESP32-C3. Note that the register
fields for ESP32-S3 have also been updated.
2021-04-14 15:00:07 +08:00
Roland Dobai
a2cf1a7d38 docs: Update JTAG debugging guides for ESP32-C3 2021-04-13 12:48:50 +02:00
Krzysztof Budzynski
48d91e96e2 Merge branch 'feature/add_c3_trm_link' into 'master'
docs: add C3 TRM links

Closes IDF-2561

See merge request espressif/esp-idf!13073
2021-04-13 05:29:30 +00:00
Angus Gratton
7f9cfc17be doc: Add notes about bootloader compatibility 2021-04-13 13:38:27 +10:00