Commit Graph

573 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
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
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
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
laokaiyao
b807f2a666 driver/i2c: add notes to i2c deleteing function 2021-05-27 12:43:22 +08: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
5c812742c6 docs: Add description for Linux getrandom() function 2021-05-20 17:08:17 +10: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
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
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
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
Cao Sen Miao
8e3a4c2351 doc: update gpio api guide reference on c3 2021-05-06 14:19:18 +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
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
Krzysztof
7b9b489968 docs: Update type of uart_num in UART API Reference examples 2021-04-28 13:11:41 +02:00
Michael (XIAO Xufeng)
26585b4b4b esp_flash: support override default chip driver list 2021-04-26 16:05:42 +08: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
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
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
Armando
6930d6aa1e spi_slave_hd: add segment mode example 2021-04-22 19:24:59 +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
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
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
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
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
morris
75dfd970b4 dac: added DAC support macro
Remove DAC support on ESP32-S3
2021-04-12 12:04:46 +08:00
Krzysztof Budzynski
cb7de3659a Merge branch 'bugfix/fix_timergroup_doc_unparsed_variable' into 'master'
doc: fix uninterpreted variables in timer.rst

Closes IDF-3064

See merge request espressif/esp-idf!13047
2021-04-12 00:38:53 +00:00
Michael (XIAO Xufeng)
cb179fe105 Merge branch 'doc/update_i2c_on_esp32c3' into 'master'
i2c: update api reference and example pin definition

Closes IDF-2746 and IDF-2336

See merge request espressif/esp-idf!12407
2021-04-11 17:57:30 +00:00
Renz Bagaporo
c112bd8b57 esp_system: move intr_alloc 2021-04-07 17:53:37 +08:00
morris
4980a764fe doc: fix uninterpreted variables in timer.rst 2021-04-07 13:49:57 +08:00
Cao Sen Miao
372584d1de i2c: update api reference and example pin defination 2021-04-06 13:47:02 +08:00
Angus Gratton
94ac251091 Merge branch 'doc/general_notes' into 'master'
doc: Update docs about startup sequence and memory types

Closes IDF-2321, IDF-2409, and IDFGH-1540

See merge request espressif/esp-idf!12636
2021-04-05 23:51:25 +00:00
Krzysztof Budzynski
7702060967 Merge branch 'docs/update_CN_trans_spiffs_touchpad' into 'master'
docs:update CN translation for spiffs and touch_pad

See merge request espressif/esp-idf!12914
2021-04-02 09:29:18 +00:00
daiziyan
540e9c57e4 docs:update CN translation for spiffs and touch_pad 2021-03-31 20:08:22 +08:00
Angus Gratton
bd7591b848 Merge branch 'doc/guide_uart_esp32c3' into 'master'
doc: update programming guide to include ESP32-C3 updates

Closes IDF-2350

See merge request espressif/esp-idf!12926
2021-03-31 02:52:36 +00:00
Angus Gratton
492b061cbc doc: update the memory types and startup docs 2021-03-31 09:37:28 +11:00
Wang Fang
c303333f52 docs: Correct uart default pin names and provid more information about ESP-Prog board 2021-03-29 14:04:13 +08:00