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
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
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