alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
30,694 Commits 20 Branches 148 Tags 384 MiB
4985caa38f
Commit Graph

411 Commits

Author SHA1 Message Date
Dai Zi Yan
1ca83a5bc9 Update CN trans for timers.rst and ota.rst 2021-11-23 07:16:11 +00:00
Cao Sen Miao
4ae714c43c docs: update using usb_serial_jtag documents 2021-11-23 14:12:13 +08:00
KonstantinKondrashov
209702d055 esp_ipc: Update documentation and API descriptions 
This commit updates the documentation and API descriptions of
the esp_ipc and esp_ipc_isr features.
 2021-11-18 21:34:50 +08:00
daiziyan
0ff2776b1e docs: update CN translation for ota.rst and console.rst 2021-11-16 19:23:09 +08:00
Omar Chebib
9d5923a13e IPC: Move ipc sources to esp_system 
IPC shall be put back into esp_system as it is an 'OS additions'.
 2021-11-11 10:30:01 +08:00
Roland Dobai
9c1d4f5b54 Build & config: Remove the "make" build system 
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
 2021-11-10 09:53:53 +01:00
Mahavir Jain
89466c649e docs: freertos: add note about tick hooks placement requirement 
Closes https://github.com/espressif/esp-idf/issues/7740
Closes IDFGH-6056
 2021-10-27 14:01:56 +05:30
Mahavir Jain
cc284f1d87 docs: ota: fix note about security version efuse size 2021-10-25 14:40:43 +05:30
Marek Fiala
ff18a96f7d tools: replace _ with - in idf.py 
Closes https://github.com/espressif/esp-idf/issues/5126
 2021-10-13 17:30:38 +08:00
fuzhibo
057b9d61b5 driver(touch): support touch sensor for esp32s3 platform 2021-10-08 10:39:46 +08:00
Wu Zheng Hui
85651b4791 efuse: remove DIS_RTC_RAM_BOOT efuse bit 2021-09-18 14:58:43 +08:00
Marius Vikhammer
4869b3cd4a WDT: Add support for XTAL32K Watchdog timer 2021-09-02 09:09:00 +08:00
intern
45925c28fd docs: update translation for jtag-debugging/index.rst and power_management.rst 2021-08-26 12:21:19 +08:00
Konstantin Kondrashov
f00c204fbc Merge branch 'feature/adds_custom_mac_address' into 'master' 
efuse: Add CUSTOM_MAC address for ESP32-C3/-S2/-S3/-H2

Closes IDF-1326

See merge request espressif/esp-idf!14417
 2021-08-04 06:35:29 +00:00
Konstantin Kondrashov
4972605b16 esp_common: Add API for IPC to run small pieces of code on the other CPU, in the context of the level 4 interrupt 2021-08-03 14:35:29 +08:00
KonstantinKondrashov
40c360a096 efuse: Add CUSTOM_MAC address for ESP32-C3/-S2/-S3/-H2 2021-08-02 14:43:27 +05:00
Michael (XIAO Xufeng)
18bee2380a Merge branch 'refactor/usb_device_driver' into 'master' 
tiny_usb: support on esp32-s3

Closes IDF-3234

See merge request espressif/esp-idf!14293
 2021-07-26 16:21:55 +00:00
morris
2218204aa7 doc: update tinyusb document to support esp32s3 
1. Renamed SOC_USB_SUPPORTED to SOC_USB_OTG_SUPPORTED for the reason of
   another USB related peripheral: USB_JTAG_SERIAL
2. correct related document
 2021-07-22 10:43:10 +08:00
KonstantinKondrashov
b8dd163149 efuse: Fix len of SOFT_DIS_JTAG for esp32c3 and esp32h2 2021-07-21 12:10:09 +05:00
morris
d9819bc7ae gdma: set transfer ability 2021-07-16 14:47:09 +08:00
Omar Chebib
0fd74a43c8 console: re-use the available REPL console API and improve linenoise 
Console example doesn't duplicate code in `console` component.
Linenoise has been improved: it now has a parametrized command line
length. It is now possible to paste data efficiently to the console.
Note: this can only be done if the cursor is at the end of the line.

Closes https://github.com/espressif/esp-idf/issues/7057
 2021-07-15 11:37:11 +08:00
Angus Gratton
a413cbd784 Merge branch 'feature/esp_timer_with_skip_unhandled_events_does_not_wake_up' into 'master' 
esp_timer: A timer with skip_unhandled_events won't wake up in light sleep mode

See merge request espressif/esp-idf!13219
 2021-06-29 08:10:51 +00:00
Alexey Gerenkov
821869d98d apptrace: Refactors apptrace for better support various tracing HW 2021-06-24 13:16:13 +03:00
Angus Gratton
dc6750ebf4 Merge branch 'bugfix/pthread_cond_wait_timeout' into 'master' 
pthread: Fix pthread_cond_timedwait returning early from timeout

Closes IDFGH-5119 and IDF-1055

See merge request espressif/esp-idf!13658
 2021-06-23 09:26:54 +00:00
Mahavir Jain
772a17bb3a docs/en: update heap debugging guide for tracing on RISC-V architecture 2021-06-22 14:14:10 +08:00
Angus Gratton
262107691a pthread: Fix pthread_cond_timedwait returning early from timeout 
The reason timeouts would sometimes happen before the abstime deadline was due
to rounding errors converting the timeout to milliseconds, and also because
vTaskDelay(1) only delays until the next tick which is less than one full tick
period.

Closes https://github.com/espressif/esp-idf/issues/6901
 2021-06-22 08:26:08 +08:00
KonstantinKondrashov
f9ad16bb66 esp_timer: Timers with skip_unhandled_events option won't wake up system from light sleep 2021-06-19 12:45:17 +08:00
Krzysztof Budzynski
a2b61abd0b Merge branch 'docs/add_how_to_debug_when_ota_fail' into 'master' 
Add a Flowchart about Debugging OTA Failure

See merge request espressif/esp-idf!13817
 2021-06-17 02:58:52 +00:00
Konstantin Kondrashov
f339b3fc96 efuse(esp32): Deprecate esp_efuse_burn_new_values() & esp_efuse_write_random_key() 
These functions were used only for esp32 in secure_boot and flash encryption.
Use idf efuse APIs instead of efuse regs.
 2021-06-17 07:21:36 +08:00
Wang Ning
2c31ac24c1 docs/add_how_to_debug_ota_failure_to_api_references 2021-06-16 19:28:01 +08:00
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
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
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
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
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
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
Angus Gratton
492b061cbc doc: update the memory types and startup docs 2021-03-31 09:37:28 +11:00
Angus Gratton
1dfa0e0aa1 Merge branch 'feature/vdd_sdio_pd_configurable' into 'master' 
system: add VDD_SDIO power domain configuration for light sleep

Closes IDFGH-2893

See merge request espressif/esp-idf!12481
 2021-03-26 08:23:41 +00:00
Krzysztof Budzynski
1953af4fb2 Merge branch 'doc/c3_system_api' into 'master' 
docs: update system api reference chapters for C3

Closes IDF-2327 and IDF-2320

See merge request espressif/esp-idf!12730
 2021-03-24 10:28:19 +00:00
Omar Chebib
49f5fb5112 esp_system: add VDD_SDIO power domain configuration to documentation 
Add a warning in `sleep_modes` doc page to explain how to keep
VDD_SDIO power domain ON.
 2021-03-24 12:04:57 +08:00
Roman Alexeev
7d07efb7b5 Fixed a missed last argument (void *__arg) for pthread_create 
Closes https://github.com/espressif/esp-idf/pull/6479
Close IDFGH-4666
 2021-03-23 17:35:35 +05:30
KonstantinKondrashov
aa1338bf23 wdt: Fix timeout and RTC_SLOW_CLK 
RTC_SLOW_CLK
ESP32:    150kHz
ESP32-S2:  90kHz
ESP32-S3: 150kHz
ESP32-C3: 150kHz
 2021-03-19 00:15:18 +08:00
Marius Vikhammer
91439e3818 docs: updated system api-reference chapters for C3 2021-03-15 18:51:12 +08:00
Angus Gratton
fd164b82b6 Merge branch 'refactor/move_from_xtensa' into 'master' 
Movements from xtensa

Closes IDF-2164

See merge request espressif/esp-idf!10556
 2021-03-11 00:24:25 +00:00
Angus Gratton
4f406d7a35 Merge branch 'bugfix/read_ota_partition_required_output_arg' into 'master' 
otatool: Fixes read_ota_partition cmd, required output arg

Closes IDFGH-4756

See merge request espressif/esp-idf!12601
 2021-03-09 06:29:34 +00:00
Angus Gratton
70e13752ae Merge branch 'feature/rtc_time_get' into 'master' 
rtc: Clean up for S2,S3,C3

Closes IDF-2569

See merge request espressif/esp-idf!12336
 2021-03-05 01:16:15 +00:00
KonstantinKondrashov
b7155a161b otatool: Fixes read_ota_partition cmd, required output arg 
Closes: https://github.com/espressif/esp-idf/issues/6559
 2021-03-04 06:02:54 +00:00
Shubham Kulkarni
7f8541ff47 esp_https_ota: Add support for partial image download 
Fix issue where binary_file_length field is greater than original image length
 2021-03-01 14:00:27 +00:00
KonstantinKondrashov
b31bf01484 rtc: Clean up for S2,S3,C3 2021-03-01 16:51:15 +08:00
Renz Bagaporo
0f03f450ff esp_hw_support: create esp_cpu 
Create a esp_cpu header that contains CPU-related functions and
utilities.
 2021-02-26 13:34:29 +08: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
Angus Gratton
84b33b9dba Merge branch 'feature/update_efuse_doc' into 'master' 
doc/efuse: Adds efuse doc for ESP32-C3

Closes IDF-2328

See merge request espressif/esp-idf!12365
 2021-02-24 22:30:18 +00:00
Renz Bagaporo
813044c6db docs, ci: update docs and ci with movements from esp_common 2021-02-24 12:16:37 +08:00
Angus Gratton
fb1488abba Merge branch 'feature/esp_timer_isr_dispatch_method_restore' into 'master' 
esp timer: Add ISR dispatch method

Closes IDF-1172 and IDF-1173

See merge request espressif/esp-idf!11572
 2021-02-23 06:21:14 +00:00
KonstantinKondrashov
5a5f5ad031 doc/efuse: Adds efuse doc for ESP32-C3 2021-02-22 15:51:45 +08:00
KonstantinKondrashov
aa581aba0f doc/ulp(esp32c3): Excludes ulp and some RTC features from ESP32C3 doc 2021-02-10 18:15:04 +08:00
KonstantinKondrashov
63d4911cdb esp_timer: Add ESP_TIMER_ISR dispatch method 
Using own spinlock for each list (TASK and ISR disp method)
Reduced the dependency of ISR on the TASK dispatch method
 2021-02-08 19:10:11 +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
Krzysztof Budzynski
5ca85248e3 Merge branch 'docs/update_docs_based_on_several_customer_feedbacks' into 'master' 
docs: update documents based on doc-881, doc-856, doc-902, and doc-943

See merge request espressif/esp-idf!12118
 2021-01-26 16:18:13 +08:00
kirill.chalov
f634c59289 Add hypertargets to all TRM references 2021-01-26 05:51:52 +00:00
Wang Fang
4c31cf9804 docs: Update FreeRTOS version, add tips to set up instructions for Windows 2021-01-26 03:46:25 +00:00
zwj
7c1c669799 component/bt: add BLE v5.0 feature for bluedroid host 2021-01-15 17:55:12 +08:00
David Čermák
76f6dd6214 lwip: Moved default SNTP API to esp_sntp.h 
and make sntp.h in port folders of lwip component obsoleted
 2021-01-13 10:28:34 +08:00
Ivan Grokhotkov
7f3b16a99d freertos: always enable static allocation 
to use it for newlib locks
 2020-12-29 16:18:04 +01:00
Marius Vikhammer
da947d736f Docs: Add C3 support to build_docs 2020-12-28 12:25:03 +08:00
KonstantinKondrashov
aa96c9a4d8 esp_timer: Add an option to skip unhandled events for periodic timers 
- Added an option to skip unhandled events for periodic timers. Useful for light sleep.
- Added doc about this case
- Added Test a latency between a call of callback and real event (14-16us). and UT to check skip_unhandled_events.
- Fixed for esp_timer_dump() if name of timer is NULL
- Refactored timer_process_alarm()
- Added the delete function after using in UTs
 2020-12-09 17:19:19 +08:00
morris
1be923acb4 rmt: rename always_on to aware_dfs 2020-11-05 19:00:55 +08:00
Angus Gratton
8a70b1cdc9 ci freertos: Add test configs for some of the optional FreeRTOS 10 configurations 
Also unit tests for the legacy hook functions.
 2020-10-21 14:04:01 +11:00
Krzysztof Budzynski
114e4c220f Merge branch 'doc/power_management_esp32s2' into 'master' 
docs: describe power management logic for ESP32-S2, fix translation

See merge request espressif/esp-idf!10525
 2020-10-16 05:38:28 +08:00
Ivan Grokhotkov
840efc2f54 docs: describe power management logic for ESP32-S2, fix translation 2020-10-14 09:05:10 +02:00
Felipe Neves
f3783ba258 app_trace/sysview: fixed freertos tracing calling plus sync apptrace component with the master branch version 
docs: remove reference to backported features in freertos 10 api-reference.
 2020-10-13 23:52:03 +00:00
Felipe Neves
a3c90bf59a freertos: merged freertos 10 kernel files into IDF 
freertos/port: update the port files and split into xtensa and riscv ports

freertos: separated cpu files from rest of the kernel sources

freertos/port_xtensa: separated private include files into a folder

freertos/tasks: added task create pinned to core function do not break current IDF API

freertos/tasks: mimiced task create pinned function into tasks.c to do not break the IDF API.

freertos: freertos component now compiling

freertos: freertos component now building

freertos: moved critical sections outside from FR kernel section to portable section

portmacro_xtensa: add void indentifier on functions that take no arguments

freertos: fix critical sections implementation to match with their function prototype

freertos: add cmake changes of freertos into make

freertos: remove portDONT_DISCARD attribute from switch context function, it was breaking the docs building.

freertos: fix conflicitng types of vApplicationSleep function

license: update the license of freertos

freertos: Doxygen comments refactored to render them correctly on docs

freertos: added new functions of freertos into the documentation

freertos: added message buffers and stream buffers to documentation

sysview: update freertos system view to the compatible with version 10

freertos: fixed event group  documentation rendering

freertos:  update static task structure to match the actual tcb size

freertos: removed backported test functions

freertos/smp: brought SMP code to  FreeRTOS 10 port

freertos/portmacro: added missing crosscore interrupt for yielding tasks

freertos: replaced soft-critical sections with hard-critical sections used by SMP

freertos: placed muxes inside of kernel objects

freertos: replaced original FR critical sections with SMP enabled spinlocks critical sections

freertos: moved xtensa port files to a separated folder

freertos: added multiple instance of global variables required to SMP

freertos: added SMP modifications on specific tasks module functions

freertos: added TLS deletion function to task module

freertos/tls: initialize TLS deletion callback to avoid crashing when calling task delete

freertos: modified vTaskDelete to do not erase current task that runs on other core

freertos: reverted taskhandle and timerhandle as void* type

freertos: fixed de-referencing void pointer to get run time counter

freertos: fix system view trace enter macro arguments

freertos: Replaced soft critical sections with spinlocks on event_groups

freertos: fixed tick function to avoid calling tick hooks twice

freertos: Nofity give checking per CPU if schedule is suspended

freertos: added mpu release on TCB deletion

freertos: Added SMP changes when deleting a TCB on idle task

freertos/license: update freertos license in COPYRIGHT.rst

freertos: unicore configurations can use task create pinned to core, it will be always pinned to core 0

freertos/portmacro: added cpu_hal_get_core_id() function instead of inline assembly

freertos/xtensa:  update xtensa specific files used in master branch

newlib/locks: revert the preemption checking in lock acquisition and release

ref_clock: fix initial state of ref_clock interrupt handler

freertos: added missing critical sections and yielding checkings

freertos: remove magic numbers in vTaskDelete

freertos: added missing critical section in prvIsQueueEmpty
 2020-10-13 23:52:03 +00:00
Krzysztof Budzynski
e0261f18ce Merge branch 'feature/add_esp_rom_printf_to_api_reference' into 'master' 
docs: Add esp_rom_printf to API Reference

Closes DOC-454

See merge request espressif/esp-idf!10251
 2020-10-09 04:06:10 +08:00
Wang Fang
a50966cf7a docs: update the description for RTC Clock Sources for esp32 and esp32s2 2020-09-23 17:13:19 +08:00
morris
a3cc43485f async memcpy: support async memcopy on esp32s2/s3 
Added async memory copy API:
on esp32-s2, the implementation is based on CP_DMA
on esp32-s3, the implementation is based on GDMA
 2020-09-16 21:30:54 +08:00
Krzysztof Budzynski
d9202304cd Merge branch 'docs/update_freertos_additions_EN' into 'master' 
docs: add more information on how to return an item to the ring buffer

See merge request espressif/esp-idf!10125
 2020-09-11 14:32:40 +08:00
He Hui Zi
874876cbf9 docs: add more information on how to return an item to the ring buffer 2020-09-11 14:32:39 +08:00
Krzysztof
db0c6d7921 docs: Add esp_rom_printf to API Reference 2020-09-10 22:55:43 +08:00
yiying
0e6803c7b2 docs: remove chapter numbers and make them common to both targets 2020-08-28 14:04:06 +00:00
r0mpage
5d71968bab Fix typo 
Merges https://github.com/espressif/esp-idf/pull/5628
 2020-08-28 14:04:06 +00:00
Wang Fang
ee135b8e28 Add a note to specify that two calls to RingbufferReceive are required in wrap mode 2020-08-10 18:25:51 +08:00
morris
b30bd7a2ef esp32s2: add CP_DMA driver 2020-08-04 15:28:32 +08:00
Yi Ying
755aee4178 add a note about ESP-IDF FreeRTOS version 2020-07-27 14:40:47 +08:00
Felipe Neves
a700035a85 test/shared_stack_printf: improved printf with shared stack function test 2020-07-14 12:56:02 +00:00
Felipe Neves
938a73756c esp_common/shared_stack: modifed the stack switch procedure to a simpler way 
esp_common/shared_stack: refactored the implemenation of shared stack function (still not working properly)

esp_expression_with_stack: refactored the shared stack function calling mechanism and updated the documentation
 2020-07-14 12:56:02 +00:00
morris
29f8aecfc0 console_repl: change config structure to support different devices 2020-07-02 07:39:46 +00:00
Darian Leung
97721d469c TWAI: Add ESP32-S2 support 
This commit adds TWAI driver support for the
ESP32-S2. The following features were added:

- Expanded BRP support
- Expanded CLKOUT Divider Support
- Updated example READMEs
 2020-06-30 16:56:03 +08:00
Andrei Gramakov
d0f995c067 doc: added a component-specific property description for FreeRTOS: ORIG_INCLUDE_PATH 2020-06-01 15:49:52 +02:00
Ivan Grokhotkov
b0f448a972 Merge branch 'feature/console_no_empty_lines' into 'master' 
console: allow not returning empty lines (Github PR)

Closes IDFGH-2869

See merge request espressif/esp-idf!8232
 2020-05-05 16:12:50 +08:00
Felipe Neves
6f5e43e26a heap: added alloc failed hook and configuration options 
heap/test: added alloc failed hook tests

docs: added alloc failed hook documentation

heap: add function to register allocation failed hook

docs: allocation failed hook docs improvements
 2020-05-04 10:58:38 -03:00
Ivan Grokhotkov
ece41b04e3 console: make empty line behavior run-time configurable 2020-04-29 23:44:46 +02:00
Angus Gratton
b18ce2f686 doc: Add configuration information about INT & Task WDTs 2020-04-15 17:30:05 +10:00
morris
279e8dd6c2 add Ethernet doc 2020-03-26 11:04:55 +00:00
Wang Ning
3784d499af Add translation for ota tool and partation tool 2020-03-25 21:44:33 +08:00
Angus Gratton
b4d97a8076 Merge branch 'feature/add_heap_info_per_task_example' into 'master' 
Add Task Heap Tracking example

See merge request espressif/esp-idf!7750
 2020-03-23 14:07:00 +08:00
Shubham Kulkarni
6e09056c25 example: Add Heap Task Tracking example 2020-03-19 15:07:41 +05:30
Angus Gratton
a9854f7085 Merge branch 'feature/rmt_clock_support_ref_tick' into 'master' 
rmt: support ref tick && refactor unit test && re-enable unit test on ESP32-S2

Closes IDFGH-1715

See merge request espressif/esp-idf!7614
 2020-03-06 15:03:52 +08:00
morris
0e4d82bc55 rmt: support REF_TICK as channel clock source 
Closes https://github.com/espressif/esp-idf/pull/3952
 2020-03-03 20:14:46 +08:00
Marius Vikhammer
c26a765a37 doc: remove uncessary .. only:: dirs 
Removed some only directives that are no longer needed with include being processed correctly
 2020-03-03 11:37:42 +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
Rusty Eddy
a81d231791 Added semi-colon to esp_event_loop_create(...) 
Title sums it up.

Merges https://github.com/espressif/esp-idf/pull/4711
 2020-02-18 12:30:38 +01:00
Mooli Tayer
311983eb55 Fix typo 
Merges https://github.com/espressif/esp-idf/pull/4752
 2020-02-18 12:30:29 +01:00
Angus Gratton
99cdddeb63 docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-18 10:34:11 +11:00
suda-morris
75cadc2e41 console: simplify examples 
1. simplify console examples
2. add "quit" command
3. support console command overwrite
4. add API reference
 2020-02-07 20:15:06 +08:00
Angus Gratton
50324b505d docs: Note that the idf target formatting filters don't work on "included" documents 2020-02-07 16:37:45 +11:00
Angus Gratton
11fac8637a docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
Marius Vikhammer
268816649c Replace all TRM urls will generic template variable and remove duplicate sections 
All references to TRM had the section duplicated for both targets using .. only:: , replaced these with a generic template url
 2020-02-07 16:37:45 +11:00
Marius Vikhammer
d56ea52ea1 doc: EN doc update and fixed warnings 2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69 doc: Update English pages with generic target name 2020-02-07 16:37:43 +11:00
Angus Gratton
9399f04da0 docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs 2020-02-07 16:37:43 +11:00
Angus Gratton
37d5e2fba6 docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs 2020-02-07 16:37:43 +11:00
Angus Gratton
e6211c7864 docs: add new top-level docs builder that builds docs for a single chip 2020-02-07 16:37:43 +11:00
Konstantin Kondrashov
739eb05bb9 esp32: add implementation of esp_timer based on TG0 LAC timer 
Closes: IDF-979
 2020-02-06 14:00:18 +08:00
KonstantinKondrashov
b49a657448 build: Add CONFIG_APP_PROJECT_VER to set the project version from Kconfig 2020-01-15 11:02:27 +00:00
morris
e1f9b283bc esp32s2: mac addr allocation 2020-01-14 15:19:38 +08:00
KonstantinKondrashov
c23549c04f docs: Add System time chapter and for sntp a description about using CONFIG_LWIP_SNTP_UPDATE_DELAY option 
Closes: https://github.com/espressif/esp-idf/issues/4386
Closes: IDFGH-2237
Closes: IDF-1199
 2020-01-10 14:49:07 +11:00
Felipe Neves
e5e8ee8912 docs: fix esp_pthread example syntax error 2020-01-03 11:21:35 -03:00
Felipe Neves
785abfeb82 docs: update esp_expresstion_with_stack code snippet to check shared stack and mutex allocation. 2019-12-20 13:30:30 -03:00
Felipe Neves
f0e82311a5 esp_expression_with_stack: fix wrong top of stack calculation plus documentation update 2019-12-20 13:23:47 -03:00
Felipe Neves
8bfb8e885e docs: update on expression with stack api usage regard the stack setup. 2019-12-20 13:18:13 -03:00
Felipe Neves
dfea4196a2 docs: added esp-expression-with-stack on documentation 2019-12-20 13:18:13 -03:00
Alexey Gerenkov
884717fb2f apptrace: Adds support for converting SystemView traces to JSON format 2019-12-04 18:04:07 +03:00
morris
57ef88a91f ethernet: add pm lock 2019-12-03 16:10:20 +08:00
Ivan Grokhotkov
477e66103c Merge branch 'feature/esp32s2beta_apptrace_port' into 'master' 
esp32s2: Adds apptrace support

Closes IDF-510 and IDF-1032

See merge request espressif/esp-idf!5610
 2019-11-22 05:33:35 +08:00
Renz Christian Bagaporo
df26ab13e2 test_utils: implement performance timer 2019-11-18 10:29:01 +08:00
Alexey Gerenkov
30ff7198b8 apptrace: Renames Kconfig options 2019-11-13 15:24:01 +03:00
Angus Gratton
ffdb57e04d Merge branch 'bugfix/http_client_message_complete_callback_invocation' into 'master' 
Fix issue in http client regarding `message_complete` callback invocation

Closes IDFGH-2040

See merge request espressif/esp-idf!6413
 2019-11-05 12:02:10 +08:00
Angus Gratton
8b48a8e72e Merge branch 'feature/efuse_example' into 'master' 
examples: Add an example efuse API usage and the group writing mode

Closes IDF-773

See merge request espressif/esp-idf!5810
 2019-11-05 10:13:21 +08:00
Angus Gratton
c5ef1cae04 Merge branch 'feature/perfmon' into 'master' 
Performance monitor component

See merge request espressif/esp-idf!4705
 2019-11-04 18:25:14 +08:00
Matt Phillips
a51fe89778 Update OTA Documentation to clarify grammar. 
The sentence about CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE was worded strangely.
I updated it to better explain the functionality.

Closes https://github.com/espressif/esp-idf/pull/4228
 2019-11-04 12:15:19 +05:30
KonstantinKondrashov
cf762d91c2 efuse: Add the batch writing mode 
This mode should be used when burning several efuses at one time.
 2019-10-30 15:43:40 +08:00
Angus Gratton
5db1f5fdfb docs: Add ESP-IDF support period policy 2019-10-18 18:25:20 +11:00
michael
37fdcc1eb5 esp_ringbuf: add documents for SendAcquire and SendComplete 2019-10-11 15:44:27 +08:00
Dmitry
a0730fec2a Performance monitor component. The component contains APIs, example and 
documentation.
 2019-08-23 11:20:12 +03:00
Darian Leung
75adefe437 docs: Alphbetically sort toctree 
This commit sorts the entries of variuos toctrees
alphabetically. Indentation was also fixed. The order
of some toctrees were not modified if the existing
order had some form of suggested reading order.
 2019-08-13 16:04:12 +08:00
Angus Gratton
0f27c38855 docs: Add notes about thread safety and using heap from ISRs 
Closes https://github.com/espressif/esp-idf/issues/3768
 2019-07-12 11:09:00 +10:00
Angus Gratton
222146845c docs: Make CMake build system default, mark GNU Make as legacy option 
All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used
 2019-07-09 14:32:26 +10:00
Angus Gratton
47bbb107a8 build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10:00
wangmengyang
50af558df9 update pm document with changes in bluetooth that supports automatic light sleep in case that external 32.768KHz crystal is used as the sleep clock 
If bluetooth modem sleep is enabled and "External 32kHz crystal" is used as bluetooth sleep clock, the power management lock "ESP_PM_NO_LIGHT_SLEEP" in bluetooth is released for the periods of time when Bluetooth enters modem sleep. In this case automatic light sleep is allowed.
 2019-07-04 07:14:02 +00:00
Angus Gratton
e6d229d301 Merge branch 'feature/ringbuffer_static_allocation' into 'master' 
Ringbuffers: Add static allocation, refactor, and update API reference

Closes IDFGH-639 and IDFGH-902

See merge request idf/esp-idf!4426
 2019-06-27 13:20:01 +08:00
Wang Fang
32954e5f90 Add Chinese translation to api-reference/system/power-management.rst 
1. Add translation to docs/zh_CN/api-reference/system/power_management.rst
2. Add a link to docs/en/api-reference/system/power_management.rst
 2019-06-26 20:42:56 +08:00
Darian Leung
8a597b865f esp_ringbuf: Add static allocation, refactor, and update API reference 
This commit updates does the following:
    - xRingbufferCreateStatic() added to allow ringbuffers via to be statically
      allocated. Docs and unit tests update accordingly. Closes #3064

    - Fix doc typos, closes #3248. Updated API reference regarding to mention
      item size limits of no-split buffers when calling
      xRingbufferGetCurFreeSize() or xRingbufferGetMaxItemSize(), closes #3117.

    - Remove the following deprecated types/functions for v4.0
        - xRingbufferIsNextItemWrapped()
        - xRingbufferAddToQueueSetWrite()
        - xRingbufferRemoveFromQueueSetWrite()
 2019-06-26 16:04:38 +08:00
Angus Gratton
5cb71b5213 Merge branch 'feature/add_doc_about_app_desc_t' into 'master' 
docs: Add description about the app image

Closes IDF-597

See merge request idf/esp-idf!4912
 2019-06-24 18:40:02 +08:00
Konstantin Kondrashov
12a7d39ed6 docs: Add description 2019-06-24 12:33:33 +08:00
Angus Gratton
78b7b137ad Merge branch 'feature/otatool_parttool_python_api' into 'master' 
otatool, parttool Python API

See merge request idf/esp-idf!5077
 2019-06-13 10:31:29 +08:00
Angus Gratton
eac356ef4a Merge branch 'feature/idf_version_header' into 'master' 
esp_common: add esp_idf_version.h header to define IDF version

Closes IDF-253

See merge request idf/esp-idf!4596
 2019-06-13 09:41:35 +08:00
Renz Christian Bagaporo
1de627e68a app_update: implement Python API for otatool 2019-06-11 13:17:14 +08:00
Kirill Chalov
588f059159 Doc/review power management 2019-05-29 12:59:52 +08:00
Roland Dobai
1ad2283641 Rename Kconfig options (components/bootloader) 2019-05-21 09:32:55 +02:00
Roland Dobai
0ae53691ba Rename Kconfig options (components/esp32) 2019-05-21 09:09:01 +02:00
Roland Dobai
bf626f2aba Rename Kconfig options (components/esp_event) 2019-05-21 09:09:01 +02:00
Ivan Grokhotkov
6ca07eca68 esp_common: add version definitions in code and build system 
Closes https://github.com/espressif/esp-idf/issues/2482
Closes IDF-253
 2019-05-20 13:14:56 +08:00
Ivan Grokhotkov
0bca9d20d8 Merge branch 'feature/esp_event_loop_library_compat_base' into 'master' 
Implement Wi-Fi, Ethernet, IP event handling based on esp_event library

Closes IDF-37 and IDF-267

See merge request idf/esp-idf!3635
 2019-04-12 13:54:18 +08:00
Kirill Chalov
a01ec59f74 Review log.rst and index.rst files in api-reference/system 2019-04-11 15:33:38 +08:00
Ivan Grokhotkov
6890ea09cd docs: add event handling API guide 2019-04-11 12:04:58 +08:00
Angus Gratton
8e91677701 Merge branch 'bugfix/bootloader_flash_crypt_cnt_ff' into 'master' 
flash encryption: reduce FLASH_CRYPT_CNT bit width to 7 bits

See merge request idf/esp-idf!4642
 2019-04-09 08:10:06 +08:00
Angus Gratton
4b4cd7fb51 efuse/flash encryption: Reduce FLASH_CRYPT_CNT to a 7 bit efuse field 
8th bit is not used by hardware.

As reported https://esp32.com/viewtopic.php?f=2&t=7800&p=40895#p40894
 2019-04-03 14:07:20 +11:00
Alexey Gerenkov
d2db2ef03c docs: Adds host-based heap tracing description 2019-04-01 19:31:45 +03:00
Ivan Grokhotkov
106dc05903 Merge branch 'feature/specify_includes_belonging_esp32' into 'master' 
move esp32 chip specific includes to esp32/xxx.h

See merge request idf/esp-idf!4534
 2019-03-21 18:34:08 +08:00
raldone01
fc880e2429 Fixed a small spelling mistake 
Merges https://github.com/espressif/esp-idf/pull/3089
 2019-03-21 15:08:11 +08:00
morris
956c25dedd move esp32 chip specific includes to esp32/xxx.h 2019-03-18 17:14:05 +08:00
Sachin Parekh
4de5ae7468 PM: I2S and I2C added in the Power Management docs 
Signed-off-by: Sachin Parekh <sachin.parekh@espressif.com>
 2019-03-18 08:21:21 +00:00
Kirill Chalov
49cca9288f Update IDF getting started sections for make and cmake as well as IDF monitor… 2019-03-14 00:10:26 +08:00
Angus Gratton
af1ea9b1b9 efuse: When Virtual eFuses are enabled, seed the virtual values as part of startup code 2019-03-11 15:20:40 +11:00
krzychb
88b153fcf7 Fixed fancy quotes 2019-03-05 19:21:50 +01:00
krzychb
e243ee972d Updated documentation concerning 'PROJECT_VER' and 'PROJECT_NAME'. 
Closes https://github.com/espressif/esp-idf/issues/3115.
 2019-03-05 19:21:50 +01:00
Konstantin Kondrashov
509e1264b9 efuse: Fix to pass CI tests 2019-02-28 07:31:29 +00:00
Konstantin Kondrashov
1d7b901aeb efuse: Add MAX_BLK_LEN define for changing len of field 
Added docs, improved efuse_table_gen.py, and minor fixes

Checking the generated files for compliance with the coding scheme.
 2019-02-28 07:31:29 +00:00
Konstantin Kondrashov
95b6273c7c efuse: Fix docs and script 2019-02-28 07:31:29 +00:00
Konstantin Kondrashov
b8141f3ad8 efuse: Fix make/cmake build systems and docs 2019-02-28 07:31:29 +00:00
Konstantin Kondrashov
ba903e7618 docs: Add efuse 2019-02-28 07:31:29 +00:00
Konstantin Kondrashov
e916cf52a3 bootloader: Add support of anti-rollback 
Added:
* set a secure version in app/bootloader.
* description anti-rollback to ota part
* emulate the secure_version write and read operations
* efuse_em partition.
* a description about a rollback for native_ota_example.

Closes: TW26335
 2019-02-14 18:51:43 +08:00
Renz Christian Bagaporo
e9a765d0fd docs: add notes on handler dispatch order 2019-01-30 20:59:47 +08:00
Konstantin Kondrashov
dde1fd9b94 bootloader: Add support flags for rollback app 
Added
* Set actual ota_seq if both ota are init or incorrect.
* Description of rollback
* UT tests

Closes TW15459
 2018-12-11 11:54:21 +08:00
morris
8b7b5821c7 example: add nmea0183 parser example 
Add NMEA0183 Parser example to illustrate how to use uart event driver together with esp event library to get GPS information.
 2018-12-07 10:57:34 +08:00
Ivan Grokhotkov
37975c186d Merge branch 'feature/pthread_name_affinity_config' into 'master' 
pthread: make affinity and task name configurable

See merge request idf/esp-idf!3878
 2018-12-05 13:46:05 +08:00
Konstantin Kondrashov
3b9cb25fe1 esp32: Add firmware version to app 
Added a new structure esp_app_desc_t. It has info about firmware:
version, secure_version, project_name, time/date build and IDF version.
Added the ability to add a custom structure with a description of the firmware.

The esp_app_desc_t is located in fixed place in start of ROM secotor. It is located after structures esp_image_header_t and esp_image_segment_header_t.

app_version is filed from PROJECT_VER variable (if set in custom make file) or PROJECT_PATH/version.txt or git repo (git describe).

Add API to get app_desc from partition.
 2018-12-03 16:52:04 +08:00
Angus Gratton
a3a1cc080e docs: Add some more explanation about heap, memory types 2018-11-30 12:29:38 +11:00
Per Malmberg
71f57931bd #2743 - Implemented ability to core affinity and thread name for pthreads and thus also for std::thread. 2018-11-28 20:43:09 +01:00
Angus Gratton
a51d5706f6 Merge branch 'bugfix/minor_doc_fixes' into 'master' 
Documentation fixes

See merge request idf/esp-idf!3529
 2018-10-31 13:23:58 +08:00
Renz Christian Bagaporo
5a83347bec event: Implement event loop library 2018-10-26 13:14:19 +08:00
Ivan Grokhotkov
5a3c0d8adf esp_timer: document limitations on timeout/period 
Closes https://github.com/espressif/esp-idf/issues/2572
Closes https://github.com/espressif/esp-idf/issues/2350
 2018-10-26 12:42:38 +08:00
Jeroen Domburg
81e35a142a Spiram: Add option to reserve MMU banks; add himem API to make use of those banks 2018-10-15 14:32:58 +08:00
Angus Gratton
8721173109 doc: Replace :envvar: config links with :ref: 2018-09-19 17:27:48 +10:00
Mahavir Jain
ff81dc16e0 freertos: cleanup tick/idle hook functionality 
If CONFIG_FREERTOS_LEGACY_HOOKS is kept enabled then defining
idle/tick hooks will be applications responsibility as was the
case earlier.

Signed-off-by: Mahavir Jain <mahavir@espressif.com>
 2018-09-17 17:05:17 +05:30
Angus Gratton
f9bed53ea2 Merge branch 'feature/task_wdt_add_timestamp' into 'master' 
esp32/task_wdt: Add timestamp to message isr_twdt

See merge request idf/esp-idf!3053
 2018-09-10 16:31:20 +08:00
Ivan Grokhotkov
6fbf585703 docs/sleep: mention new wakeup sources, use generated API reference 2018-09-06 15:42:34 +08:00
Ivan Grokhotkov
97b2281c49 Merge branch 'bugfix/can_driver_multiple_bugs' into 'master' 
CAN: Add pm_lock, fix gpio bug, update docs

See merge request idf/esp-idf!3138
 2018-09-04 20:34:06 +08:00
Konstantin Kondrashov
4fc84306a2 esp32/task_wdt: Add esp_task_wdt_isr_user_handler function 
Added esp_task_wdt_isr_user_handler function to receive twdt events in
the user code.

Closes https://github.com/espressif/esp-idf/issues/2270
 2018-09-03 14:31:20 +08:00
Darian Leung
dc3fa14a26 CAN: Add pm_lock, fix gpio bug, update docs 
This commit does the following

- Add power management lock to CAN driver so that APB frequency does not change
whilst CAN driver is in use
- Fix incorrect flag in can_transmit()
- Refactor can_driver_install() and can_driver_uninstall() so that critical sections
are shorter
- Fix CAN gpio configuration bug on RX pin. Closes #2302
- Add docs about multiple ID configuration and fix example links
 2018-09-01 02:46:05 +08:00
Jitin George
458b167f1a docs/en/security: Add documentation for signed apps without hardware secure boot feature 2018-08-29 17:05:34 +08:00
Ivan Grokhotkov
90f5456dba Merge branch 'feature/rtc_cpu_freq_config' into 'master' 
soc/rtc: Refactoring, support CPU frequencies lower than XTAL

See merge request idf/esp-idf!2856
 2018-08-22 11:32:08 +08:00
Ivan Grokhotkov
e3d76d13b4 docs: update power management section on esp_pm_configure 2018-08-21 13:02:46 +08:00
Ivan Grokhotkov
8403adf4e0 docs: add API reference section for esp_system.h 2018-08-20 16:49:20 +08:00
Angus Gratton
383a3f788d Merge branch 'doc/heap_tracing' into 'master' 
heap docs: Fix some bad links & errors in the heap docs

See merge request idf/esp-idf!2942
 2018-08-10 16:46:52 +08:00
Angus Gratton
c9cbc6b30c heap docs: Fix some bad links & errors in the heap docs 
Also add a note about printf() sometimes causing on-demand allocations.
 2018-08-10 15:54:58 +10:00
Jitin George
1fecdc3891 esp_https_ota: Add support for HTTPS based ota feature 2018-08-03 16:47:07 +05:30
Ivan Grokhotkov
10c2cddddf sleep: fix flushing UARTs when entering deep sleep 
Since 94250e42a0, UART output is suspended when entering sleep mode
(deep or light sleep). This makes sense for light sleep, where sleep
normally takes small amount of time, and flushing the UART would add
a lot of latency. But this breaks existing behaviour for deep sleep,
where UART output was previously sent out before entering sleep mode.

Closes https://github.com/espressif/esp-idf/issues/2145
 2018-07-04 12:11:25 +08:00
Ivan Grokhotkov
d9f8311b9d docs: add error codes reference 2018-06-15 15:49:24 +08:00
Angus Gratton
59ab2136e8 Merge branch 'doc/kconfig_item' into 'master' 
doc: fix the level inconsistent issue in Kconfig document

See merge request idf/esp-idf!2460
 2018-06-14 12:51:50 +08:00
Ivan Grokhotkov
2f5cd89833 examples: add esp_timer example 2018-06-07 11:59:36 +08:00
michael
3ba8461928 doc: fix the level inconsistent issue in Kconfig document 2018-06-05 10:36:18 +00:00
Angus Gratton
21e085d235 Merge branch 'feature/xRingBufferCanRead_pr1672' into 'master' 
freeRTOS/Re-factor ring buffers and add xRingbufferCanRead, xRingbufferCanWrite

See merge request idf/esp-idf!2214
 2018-05-23 15:09:40 +08:00
Darian Leung
4bfa30967f freeRTOS/Re-factor ring buffers 
This fixes multiple bugs with ring buffers and re-factors the code. The public
API has not changed, however the underlying implementation have various private
functions have been changed. The following behavioral changes have been made

-   Size of ring buffers for No-Split/Allow-Split buffers will not be rounded
    up to the nearest 32-bit aligned size. This was done to simplify the
    implementation

-   Item size for No-Split/Allow-Split buffers will also be rounded up to the
    nearest 32-bit aligned size.

The following bugs have been fixed

-   In copyItemToRingbufAllowSplit(), when copying an item where the aligned
    size is smaller than the remaining length, the function does not consider
    the case where the true size of the item is less than 4 bytes.

-   The copy functions will automatically wrap around the write pointers when
    the remaining length of the buffer is not large enough to fit a header, but
    does not consider if wrapping around will cause an overlap with the read
    pointer. This will make a full buffer be mistaken for an empty buffer

closes #1711
-   xRingbufferSend() can get stuck in a infinite loop when the size of the
    free memory is larger than the needed_size, but too small to fit in the ring
    buffer due to alignment and extra overhead of wrapping around.

closes #1846
-   Fixed documentation with ring buffer queue set API

-   Adding and removing from queue set does not consider the case where the
    read/write semaphores actually hold a value.

The following functions have been deprecated
    - xRingbufferIsNextItemWrapped() due to lack of thread safety
    - xRingbufferAddToQueueSetWrite() and xRingbufferRemoveFromQueueSetWrite()
    as adding the queue sets only work under receive operations.

The following functions have been added
    - xRingbufferReceiveSplit() and xRingbufferReceiveSplitFromISR() as a thread
    safe way to receive from allow-split buffers
    - vRingbufferGetInfo()

Documentation for ring buffers has also been added.
 2018-05-21 01:04:58 +00:00
Ivan Grokhotkov
45d3b1f4b1 docs: update information about automatic light sleep 2018-05-18 03:14:46 +00:00
Daniel Miller
9acebb08fe doc: spelling 
Merges https://github.com/espressif/esp-idf/pull/1800
 2018-04-09 12:28:21 +10:00
Ivan Grokhotkov
139d49894c Merge branch 'feature/deactivate_wakeup_trigger' into 'master' 
esp32: Add deactivation of wake up trigger for different sources

See merge request idf/esp-idf!2079
 2018-04-03 15:19:10 +08:00
Kedar Sovani
7a0cab0a5b pthread: Allow configuration of priority and stacksize 
The expected usage is:
  esp_pthread_set_cfg(cfg);
  pthread_create()

If the inherit flag is set, then all subsequent threads forked by this
thread will also inherit this configuration. This avoids having to
change/prefix this for each and every pthread_create() call.
 2018-03-20 18:06:32 +05:30
krzychb
097adc3a33 Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available 2018-03-13 21:57:08 +01:00