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
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
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
Marius Vikhammer
0c17973d54
docs: add rf calibration docs for S2 and C3
2021-05-26 10:09:50 +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
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
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
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
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
chenjianxing
c66b1aeda7
update esp32c3 iperf config
2021-04-27 14:41:08 +08:00
Jakob Hasse
68393c41c4
doc: linux host test documentation
2021-04-23 09:27:35 +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
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
Roland Dobai
a2cf1a7d38
docs: Update JTAG debugging guides for ESP32-C3
2021-04-13 12:48:50 +02:00
Eli
9ec19163ed
docs: jtag debugging: add macOS 10.15 FTDI details
...
Merges https://github.com/espressif/esp-idf/pull/5949
2021-04-12 09:15:08 +02:00
Marius Vikhammer
0633ee3e18
docs: fix doxygen compile warnings for doxygen 1.9.1
...
Newer versions of doxygen will give warnings for comments in
INPUT lists
Delete all comment lines to fix these warnings, our folder structure
stil gives an OK overview of what we are including
2021-04-09 11:57:03 +08:00
Michael (XIAO Xufeng)
925dacd7fb
Merge branch 'bugfix/remove_HSPI_macro_on_c3' into 'master'
...
spi: remove HSPI macros on esp32c3 and esp32s3
Closes IDF-2535
See merge request espressif/esp-idf!12637
2021-04-08 09:33:18 +00:00
Armando
9b9ea71ff9
spi: remove HSPI macro on esp32c3 and esp32s3
2021-04-06 13:42:49 +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
Renz Bagaporo
bbc599493e
esp32: move common fragment definitions
2021-03-31 19:17:33 +08:00
Angus Gratton
793771e744
Merge branch 'feature/esp_error_check_return' into 'master'
...
esp_common: add generic check macros
Closes IDF-2271
See merge request espressif/esp-idf!12602
2021-03-31 07:08:27 +00: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
Angus Gratton
2e98a5d796
docs: split the 'general notes' page into two
2021-03-29 16:32:54 +11:00
Krzysztof Budzynski
15c3a42dcf
Merge branch 'doc/update_CN_translation_for_API_guides_and_Contribute' into 'master'
...
update CN translation for api-guides and contribute
See merge request espressif/esp-idf!12662
2021-03-23 08:05:28 +00:00
daiziyan
abb89b9a9c
docs: update CN translation for app_trace,linker-script-generation and add-ons-reference.rst
2021-03-23 11:24:23 +08:00
Dai Zi Yan
85a016dbf6
api-guides: updated CN translation for unit-tests, jtag-debugging/index, and jtag-debugging/using-debugger
2021-03-15 13:01:15 +08:00
Shu Chen
6792024add
esp_common: add generic check macros
...
Add four check maros:
* ESP_RETURN_ON_ERROR()
* ESP_GOTO_ON_ERROR()
* ESP_RETURN_ON_FALSE()
* ESP_GOTO_ON_FALSE()
Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-11 17:38:22 +08:00
daiziyan
123e540b2f
update CN translation based on reviewers' comments
2021-03-09 10:28:52 +11:00
daiziyan
8c7fd31984
api-guides: update CN translation for build-system and build-system-legacy,and fix line break in the EN version
2021-03-09 10:28:52 +11:00
Angus Gratton
a0eb455ec3
Merge branch 'refactor/misc_move_from_esp_common' into 'master'
...
Movements from esp_common
Closes IDF-1947
See merge request espressif/esp-idf!9692
2021-02-24 23:16:52 +00:00
Renz Bagaporo
f2561f6360
docs: update list of common component requirements
2021-02-24 12:16:37 +08:00
Omar Chebib
33deabb3ab
doc: update "Fatal Errors" chapter for ESP32C3 board
2021-02-23 14:54:26 +08:00
Marius Vikhammer
8c729fb55b
docs: fix broken ref in external-ram.rst
2021-02-20 12:37:59 +08:00
Marius Vikhammer
548fd02d10
docs: initial update of programming guide for C3
...
Updates "front page" content, get-started, and api-guides with C3 content
Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
daiziyan
3d2d0e2247
update CN translation for ulp-risc-v partition-table tips-and-quirks and idf-monitor for api-guides
2021-01-28 19:42:54 +08:00
Krzysztof Budzynski
1faff89ff6
Merge branch 'feature/update_jtag_translation' into 'master'
...
doc: update JTAG translation
Closes IDF-2069
See merge request espressif/esp-idf!12107
2021-01-27 10:37:10 +08:00
Wang Fang
7df1cad1d6
docs: This MR does the following updates:
...
1. Provided more information regarding I2S_COMM_FORMAT_STAND_PCM_SHORT and I2S_COMM_FORMAT_STAND_PCM_LONG
2. Added --output flag for partition table read instructions
3. Reordered the header files for esp-ble-mesh
4. Reordered the setup instructions for Ubuntu and CentOS
2021-01-25 11:10:08 +00:00
morris
9788721de6
doc: update JTAG translation
2021-01-25 18:59:19 +08:00
Ivan Grokhotkov
76acc8ddde
Merge branch 'feature/win_inst_embedded_python' into 'master'
...
tools: support for embedded Python
Closes IDF-322
See merge request espressif/esp-idf!11682
2021-01-18 16:54:47 +08:00
Juraj Michálek
1427b3a6d8
tools: support for embedded python
2021-01-18 08:10:56 +01:00
daiziyan
2e3367b97e
update api-guides/build-system.rst to keep EN and CN in sync
2021-01-13 19:23:30 +08:00
Dai Zi Yan
694dd2767a
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section
2021-01-08 17:49:09 +08:00
Marius Vikhammer
7fe16bae25
tools: merge C3 changes into master
2020-12-30 07:04:12 +08:00
Ivan Grokhotkov
de798541dc
tools: use riscv32-esp-elf toolchain for ESP32-S2 RISC-V ULP
...
riscv32-esp-elf toolchain (used for ESP32-C3) can also be used for
ESP32-S2 RISC-V ULP coprocessor.
This removes the riscv-none-embed-gcc toolchain which was originally
used for the ULP, and updates the docs and CMake files to use
riscv32-esp-elf.
Some flags are cleaned up and workarounds removed from CMake toolchain
file.
2020-12-29 19:19:18 +00:00
Marius Vikhammer
da947d736f
Docs: Add C3 support to build_docs
2020-12-28 12:25:03 +08:00
Ivan Grokhotkov
11ae1dcebe
docs: fatal errors: mention another reason for LoadStoreError
2020-12-02 11:58:56 +01:00
Hao Ning
720e228dde
add a chinese translation for wifi driver
...
add the first part translated by joy
add the last part translated by huizi
solved some formatting issues and typos in en text
add updated cn translation based on peer review comments
updated based on technical review comments
add links to api functions
solve pipeline errors
convert line endings in cn file
solve some build errors
reedit a table
2020-11-20 10:33:04 +08:00
Angus Gratton
66fb5a29bb
Whitespace: Automated whitespace fixes (large commit)
...
Apply the pre-commit hook whitespace fixes to all files in the repo.
(Line endings, blank lines at end of file, trailing whitespace)
2020-11-11 07:36:35 +00:00
Mahavir Jain
20af94ff53
Coredump config option rename throughout IDF
2020-09-30 20:22:27 +05:30
Krzysztof Budzynski
068690e604
Merge branch 'docs/fix_formatting_issues_in_idf_monitor' into 'master'
...
docs: fix formatting issues in api-guides
Closes DOC-489, DOC-406, and DOC-487
See merge request espressif/esp-idf!10459
2020-09-24 15:30:33 +08:00
Wang Fang
00a99cfb9d
docs: fix formatting issues in api-guides
2020-09-24 15:30:28 +08:00
Angus Gratton
50e79e6763
Merge branch 'feature/switch_to_kconfiglib_package' into 'master'
...
tools: Use kconfiglib from package
Closes IDF-989
See merge request espressif/esp-idf!10535
2020-09-24 12:27:31 +08:00
Roland Dobai
883cbc416e
tools: Use kconfiglib from package
2020-09-22 11:29:30 +02:00
morris
9fa06719fa
global: enable build uinit test for esp32-s3
2020-09-22 15:15:03 +08:00
Lu Chang Jie
cd3cf630a5
Test: merge ble mesh node and provioner in console
2020-08-21 11:01:37 +08:00
He Hui Zi
dfa59e3d22
docs: translate api-guides/ulp-risc-v from EN to CN
2020-08-13 19:44:46 +08:00
Angus Gratton
a2dc60b254
Merge branch 'feature/secure_boot_esp32s2' into 'master'
...
Feature/secure boot esp32s2
See merge request espressif/esp-idf!8254
2020-07-28 16:39:34 +08:00
Supreet Deshpande
33979a9361
Docs: Secure boot v2 support for ESP32-S2
2020-07-27 00:01:10 +00:00
morris
e6a94e982c
docs: translate idf.py debug target
2020-07-24 15:59:11 +02:00
Ivan Grokhotkov
a3eb4d85d4
docs: jtag-debugging: update Chinese version
2020-07-24 15:58:59 +02:00
Ivan Grokhotkov
4ff2750d9f
docs: add placeholders for {esp32,esp32s2}.inc in JTAG debugging guide
2020-07-24 15:54:47 +02:00
Ivan Grokhotkov
962ea8b9f2
docs: repurpose WROVER-KIT debugging guide for Kaluga-1
2020-07-24 15:54:47 +02:00
Felipe Neves
b6dba84323
ulp: added support to building code for riscv ULP coprocessor
2020-07-15 15:28:49 -03:00
Ivan Grokhotkov
5985c07ab7
docs: add section about USB CDC console
2020-06-26 15:38:49 +02:00
Wang Fang
256571a4f4
fix the formatting issues described in DOC-257
2020-06-24 02:47:12 +00:00
Darian Leung
e61bbbcb61
Add HAL and LL documentation
...
This commit adds docuemntation regarding Hardware
Abstraction in ESP-IDF.
2020-06-04 15:02:49 +08:00
Marius Vikhammer
67ea59d605
docs: fix check_docs not working for multiple builders
...
When building docs with multiple builders the warning logs are now checked after
each run. Solves the issue where the logs would be overwritten by next builder before checking.
Closes IDF-1659
2020-05-29 20:10:18 +08:00
Krzysztof Budzynski
95ed99671b
Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master'
...
espcoredump: apply documentation changes in core_dump.rst file
See merge request espressif/esp-idf!5697
2020-05-28 02:25:47 +08:00
Alex Lisitsyn
e649a4f017
espcoredump: apply temporary documentation changes in core_dump.rst file
...
added picture to describe bin and elf format of core dump
added link to core_dump_internals.rst file from main one
added the diagram to describe logic structure of core dump modules and dependencies
2020-05-28 02:25:46 +08:00
Island
fbf2088fc8
Merge branch 'example/ble_mesh_structural_adjust' into 'master'
...
Example/ble mesh structural adjustment
Closes BLEMESH-200
See merge request espressif/esp-idf!8719
2020-05-21 15:11:23 +08:00
lly
88eb4a0820
ble_mesh: Rename the folders ble_mesh_fast_prov_* to fast_prov_*
2020-05-20 11:33:46 +00:00
Marius Vikhammer
fbb54184ef
doc: add generation of tags from sdkconfig and x_caps.h headers
...
Also updates the way we handle exclude_patterns to use the new tags
Closes IDF-1484
2020-05-13 07:09:01 +00:00
Alexey Gerenkov
b441df7cf1
docs: Fixes OpenOCD debug level option
2020-05-07 16:02:13 +03:00
Angus Gratton
f9552baf97
Merge branch 'feature/dfu_build_flash_s2' into 'master'
...
Add build system support for programming ESP32-S2 using DFU utils
Closes IDF-579
See merge request espressif/esp-idf!8294
2020-05-04 14:57:51 +08:00
Krzysztof Budzynski
39c5db4c38
Merge branch 'bugfix/make_docs_ldgen' into 'master'
...
docs: remove quotes in ldgen documentation for adding fragment file
See merge request espressif/esp-idf!8501
2020-05-04 03:22:59 +08:00
Roland Dobai
ab9f714248
Add build system support for programming ESP32-S2 using DFU utils
2020-04-30 07:59:18 +02:00
Renz Bagaporo
da91172616
docs: remove quotes in ldgen documentation for adding fragment file
...
Closes https://github.com/espressif/esp-idf/issues/5142
2020-04-27 15:22:38 +08:00
lly
2f6a4140fa
doc: Fix some ble mesh description
2020-04-26 06:22:33 +00:00
Angus Gratton
4358f3b573
doc: Add warnings about using JTAG debugging with hardware security features
...
This is related to the following issues but is not a fix, just documentation of a workaround until we can
improve the support:
https://github.com/espressif/esp-idf/issues/4878
https://github.com/espressif/esp-idf/issues/4734
2020-04-01 17:36:08 +11:00
liying
572ef008a9
Provide translation for the updates in 7637 and 8095, and correct a format issue in documenting-code
2020-03-29 16:50:40 +00:00
Wang Ning
168a623a07
Add translation for linker script generation
2020-03-26 00:48:58 +08:00
Wang Ning
3784d499af
Add translation for ota tool and partation tool
2020-03-25 21:44:33 +08:00
Ivan Grokhotkov
35560cb538
Merge branch 'doc/fix_example_links' into 'master'
...
doc: Fix invalid links
Closes DOC-67 and DOC-69
See merge request espressif/esp-idf!8065
2020-03-23 21:17:20 +08:00
Angus Gratton
52d888a68b
docs: Fix broken URLs & permanent redirects
2020-03-23 18:11:23 +11:00
Anton Maklakov
8046df875e
docs: Fixup format of a command line to build unit tests
2020-03-19 19:28:46 +07:00
Angus Gratton
207914a13a
Merge branch 'refactor/common_code_panic_handler' into 'master'
...
Panic handling common code refactor
See merge request espressif/esp-idf!7489
2020-03-19 11:23:57 +08:00
Natasha
ee0ae607da
Add translation for mesh document under api guide
2020-03-17 01:02:36 +08:00
Ivan Grokhotkov
b497819667
docs: update esp32s2 summary page
...
- Refer to the toolchain links on IDF Tools page
- Update the wording around v4.1/v4.2 releases
- Remove the section about 3 different versions (of S2-beta)
- Add link to the list of features maintained externally
2020-03-16 14:40:37 +11:00
Renz Christian Bagaporo
20cfc2ecdd
docs: update docs with panic handler changes
2020-03-10 19:56:24 +08:00
morris
46ea7d815d
parttool: don't print target name
2020-03-09 15:05:04 +08:00
Marius Vikhammer
9b56892bfe
doc: fix broken .. only:: in JTAG guide
...
Added note about .. only:: limitations to guide
2020-03-03 15:30:37 +08:00
Mahavir Jain
5f897fd33c
Merge branch 'feat/secure_boot_v2_v41' into 'master'
...
feat/secure_boot_v2: Adding secure boot v2 support to ESP32-ECO3
Closes IDF-799
See merge request espressif/esp-idf!6778
2020-02-27 18:54:08 +08:00
lly
7cd08b5824
ble_mesh: Miscellaneous modifications
...
1. Add an API to set Provisioner static oob value
2. Add an API to deinit BLE Mesh stack
3. Add an API to set Provisioner unicast address
4. Add an API to provision devices with fixed address
5. Add an API to store node composition data
6. Add an API to get node with device uuid
7. Add an API to get node with unicast address
8. Add an API to delete node with device uuid
9. Add an API to delete node with unicast address
10. Add an API for Provisioner to update local AppKey
11. Add an API for Provisioner to update local NetKey
12. Support Provisioner persistent functionality
13. Fix Provisioner entering IV Update procedure
14. Fix an issue which may cause client failing to send msg
15. Use bt_mesh.flags to indicate device role
16. Remove several useless macros
17. Callback RSSI of received mesh provisioning packets
18. Modify the Provisioner disable function
19. Change some log level from debug to info
20. Add parameters to Provisioner bind AppKey completion event
21. Fix node ignoring relay messages issue
22. Support using a specific partition for BLE Mesh
23. Fix compile warning when proxy related macros are disabled
24. Clean up BLE Mesh stack included header files
25. NULL can be input if client message needs no parameters
26. Fix compile warning when BT log is disabled
27. Initilize BLE Mesh stack local variables
28. Support using PSRAM for BLE Mesh mutex, queue and task
29. Add a menuconfig option to enable using memory from PSRAM
30. Clean up sdkconfig.defaults of BLE Mesh examples
2020-02-26 17:37:44 +08:00
Supreet Deshpande
073ba0a608
feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3
2020-02-25 01:28:22 +05:30
Angus Gratton
3b498a0576
Merge branch 'bugfix/confserver_hex_types' into 'master'
...
confserver: Standardize and document the handling of hex values
See merge request espressif/esp-idf!7437
2020-02-20 14:48:15 +08:00
Ivan Grokhotkov
75d0f38108
Merge branch 'doc/unit_test_multiple_targets' into 'master'
...
doc: add multi-target rules for writing unit tests
See merge request espressif/esp-idf!7438
2020-02-18 23:30:02 +08:00
Angus Gratton
e95ba301d8
Merge branch 'bugfix/use_quotes_in_embedding_ulp_apps' into 'master'
...
ulp: use quotes when specifying files for embedding ulp binaries
See merge request espressif/esp-idf!7606
2020-02-18 09:15:50 +08:00
Renz Christian Bagaporo
bb639bb91d
ulp: use quotes when specifying files for embedding ulp binaries
2020-02-18 00:12:56 +00:00