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
34,148 Commits 20 Branches 148 Tags 384 MiB
73de93d55e
Commit Graph

143 Commits

Author SHA1 Message Date
Matus Fabo
1c6edff560 add: data classes for parsing NVS binary data 
add: functions to print formatted NVS data
add: color support via ANSI escape sequences
add: documentation
 2022-09-20 14:02:23 +00:00
Martin Gaňo
30dd0fbf30 fatfsparse.py: enable automatic WL detection 2022-09-15 10:51:48 +00:00
Martin Gaňo
72acbeb921 fatfsparse.py: enable automatic detection of lfn 2022-09-08 10:53:04 +02:00
Mahavir Jain
d35b076a30
docs: nvs: prior flash erase note for device generated nvs_keys partition 2022-09-01 18:41:37 +05:30
Jakob Hasse
1ab3e64cee doc (nvs): added note about maximum possible namespaces 2022-08-24 15:42:27 +02:00
Shang Zhou
ea26e6a635 docs: Update CN version for MR19453 2022-08-15 16:14:14 +08:00
Marius Vikhammer
26dc5fe188 docs: update storage and sleep docs for C2 2022-08-15 07:04:28 +00:00
Martin Gaňo
a542e9424c fatfsparse.py/docs: Added missing cmd parameter to the docs 2022-07-29 15:29:23 +02:00
Martin Gaňo
58b1c140d7 fatfsgen.py: add description of the parameter PRESERVE_TIME 2022-07-20 13:06:57 +02:00
intern
4866e91398 docs: update nvs encryption cn trans 2022-07-18 14:40:56 +08:00
Cao Sen Miao
d9b4b82edc spi_flash: Modify documentations 2022-07-01 10:59:34 +08:00
Martin Gaňo
0f160c8f11 fatfs: enable long file names for fatfsparse.py 2022-06-09 15:51:03 +02:00
Dai Zi Yan
e94435df22 Merge branch 'docs/update_idf_monitor' into 'master' 
docs: update CN translation for idf-monitor.rst

Closes DOC-3082

See merge request espressif/esp-idf!18248
 2022-06-06 15:45:24 +08:00
Jiang Jiang Jian
6bde276a7a Merge branch 'docs/update-fatfsgen-encoding' into 'master' 
Removed misleading sentence about fatfs lfn encoding

Closes IDF-5174

See merge request espressif/esp-idf!18324
 2022-05-31 10:24:29 +08:00
Jakob Hasse
97c149f73d Merge branch 'refactor/nvs_iterator_api' into 'master' 
NVS: New interface for iterator functions

Closes IDFGH-6149

See merge request espressif/esp-idf!18081
 2022-05-31 07:47:26 +08:00
Martin Gaňo
59ba6999ae Removed misleading sentence about fatfs lfn encoding 
Closes IDF-5174

Related to IDF-4795
 2022-05-30 15:33:58 +02:00
daiziyan
59453d0e78 docs: update CN translation for idf-monitor.rst 2022-05-30 20:55:37 +08:00
Ivan Grokhotkov
87ec752bda Merge branch 'docs/fix_nvs_encryption_docs' into 'master' 
doc (nvs_flash): improved NVS partition flash documentation

Closes IDFGH-6549

See merge request espressif/esp-idf!18004
 2022-05-30 16:13:12 +08:00
Jakob Hasse
ad184e979a refactor (nvs)!: New interface for iterator functions 
Closes https://github.com/espressif/esp-idf/issues/7826

* nvs_entry_find(), nvs_entry_next() and nvs_entry_info()
  return error codes now
* nvs_entry_find() and nvs_entry_next() access/modify iterator via
  parameters, instead of returning an new iterator.

Added appropriate documentation in Chinese and English
 2022-05-30 09:28:42 +08:00
Shang Zhou
4ad048f05f Merge branch 'docs/update_cn_translation_of_16452_and_16658' into 'master' 
docs: updated CN translation for !16452 and !16658

Closes DOC-2828 and DOC-2827

See merge request espressif/esp-idf!18007
 2022-05-20 03:57:52 +08:00
Shang Zhou
ed1bf1d056 docs: updated CN translation for !16452 and !16658 2022-05-20 03:57:51 +08:00
mofeifei
4d0724984c docs: update cn trans for fatfs.rst 2022-05-17 11:36:03 +08:00
Martin Gaňo
005af75da3 Added FATFS partition parser 2022-05-16 14:32:17 +02:00
Jakob Hasse
dd3c5c3cbb doc (nvs_flash): improved NVS partition flash documentation 
Closes https://github.com/espressif/esp-idf/issues/8196
 2022-05-16 14:13:43 +08:00
Matus Fabo
24268d47a2 change: renamed FATFS convenience mounting functions 
change: renamed every instance of these functions
add: deprecation notice with old functions
change: CC0 licence to CC0-1.0 in fatfsgen_example_main.c
 2022-04-11 08:44:40 +00:00
Adam Múdry
36db6a6681 spiffs: Add esp_spiffs_check() function 
esp_spiffs_check() exposes SPIFFS_check() functionality to the user
 2022-04-08 19:40:56 +00:00
Marius Vikhammer
a6543f0d21 docs: fix broken references to misc API functions and types. 2022-03-27 16:46:57 +08:00
Martin Gaňo
fea2b5b64e fatfsgen.py: enabled long names support 
Closes https://github.com/espressif/esp-idf/issues/8171
 2022-03-11 11:20:31 +01:00
Cao Sen Miao
a0bd06af54 spi_flash: Add documents for flash optional features 2022-03-09 18:49:34 +08:00
daiziyan
6b8420e877 docs: updated CN translation for using-debugger, windows-setup, resources and index 2022-02-25 10:44:22 +00:00
Shang Zhou
33a00cf197 docs: Updated CN translation for index files in api-guides and api-reference 2022-02-23 14:48:26 +08:00
Martin Gaňo
f3425dea96 fatfsgen.py: enabled automatic detection of the FATFS type for FAT12 and FAT16 2022-02-07 17:22:58 +01:00
Armando
49658faaf0 doc: add flash suspend feature to iram usage doc 2022-01-24 12:59:29 +08:00
David Čermák
c45d34aea2 Merge branch 'bugfix/lwipopts_cleanup' into 'master' 
lw-IP: Cleanup of config options and flags

Closes IDF-3594

See merge request espressif/esp-idf!15248
 2022-01-17 06:46:27 +00:00
Cao Sen Miao
5bf739aef3 spi_flash: Add hint for explaining erase yield 2022-01-17 09:52:54 +08:00
David Cermak
10dc8543c5 vfs/lwip: Fix docs on select() referencing wrong config 
CONFIG_LWIP_USE_ONLY_LWIP_SELECT was deprecated long time ago and removed (~ in v4.x).
Used CONFIG_VFS_SUPPORT_SELECT instead (and reverted the logic as this
is ON by default and needs to be explicitly turned off for socket only
select)
 2022-01-14 16:41:38 +01:00
daiziyan
20374161a6 docs: Updated CN translation for esp-ble-mesh, wifi, spi_flash and fata-errors; And keep line number consistency for en/index and versions 2022-01-07 16:05:16 +08:00
daiziyan
a98212015f docs:update CN transalation for get-started section and sdmmc 2021-12-21 18:43:56 +08:00
daiziyan
c82881eaee docs: update CN translation for vfs and nvs_flash 2021-12-10 17:02:47 +08:00
daiziyan
c34ccb1bdf docs: update CN translation for fatfs.rst 2021-12-02 11:47:06 +08:00
Martin Gano
7460deeae8 support for wear levelling in fatfs partition generator 
Closes https://github.com/espressif/esp-idf/issues/5785
 2021-11-29 16:57:47 +01: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
Martin Gano
3c4034d36e support for generating FATFS on a host 2021-11-03 13:06:11 +01:00
Armando
d41da2792a doc: add flash and psram configuration doc in programming guide 2021-10-26 11:49:36 +08:00
Shang Zhou
3ffc5f0c67 docs:update CN translation for API reference storage(fatfs and index) 2021-10-15 18:59:22 +08:00
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
Matus Fabo
9b3070105f Add: references to issues 
JIRA IDF-3776
 2021-10-07 16:52:08 +02:00
Matus Fabo
3a150558a7 Fix: grammar correction 
IDF-3776
 2021-10-07 19:37:09 +08:00
Matus Fabo
3aad3fd38f Fix: grammatical & aesthetic changes 
JIRA IDF-3776
 2021-10-05 15:37:49 +02:00
Matus Fabo
f9d6cb7099 add: spiffs issues documentation 
Issues documented:
 - SPIFFS is unable to utilize 100% of partition space
 - Long time between write function calls
 - Memory leaks when deleting file

JIRA IDF-3776
 2021-09-29 14:24:10 +02:00
Ivan Grokhotkov
19a75177a8 docs: fix syntax errors in only:: blocks 2021-09-07 14:00:53 +08:00
Ivan Grokhotkov
6cf25ce43f Merge branch 'doc/size_opt_vfs' into 'master' 
docs: describe code size optimizations possible in VFS component

See merge request espressif/esp-idf!14783
 2021-08-23 07:32:14 +00:00
Ivan Grokhotkov
a005e9bfbc docs: move VFS documentation into the component directory 
These files were added into the component directory back when we
didn't have the documentation directory, and weren't moved once the
documentation directory was created.
 2021-08-23 07:02:19 +02:00
Matus Fabo
17319a220f add: reference to long filenames option 
fix: bad link syntax
fix: reference to fastseek config option

Closes https://github.com/espressif/esp-idf/issues/6138
 2021-08-20 14:29:25 +02:00
Cao Sen Miao
fecf27e54c spi_flash: add support for 32Mbit address GD flash, for GD25Q256 2021-07-02 17:13:51 +08:00
Michael (XIAO Xufeng)
26585b4b4b esp_flash: support override default chip driver list 2021-04-26 16:05:42 +08:00
Jiacheng Guo
40035edcac vfs: add doc links 2021-04-15 15:19:00 +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
daiziyan
540e9c57e4 docs:update CN translation for spiffs and touch_pad 2021-03-31 20:08:22 +08:00
Angus Gratton
492b061cbc doc: update the memory types and startup docs 2021-03-31 09:37:28 +11:00
Cao Sen Miao
c54ea54d98 spi_flash: make suspend off by default and add more information for using suspend 2021-03-26 13:57:14 +08:00
Marius Vikhammer
6334b5e56f docs: update api-reference chapters for C3 
Checked and updated the following chapters:
 * api-reference/network
 * api-reference/protocols
 * api-reference/provisioning
 * api-reference/storage
 * api-reference/peripherals/ds
 * api-reference/peripherals/hmac
 * api-reference/peripherals/secure_element
 2021-03-01 14:58:08 +08:00
Michael (XIAO Xufeng)
476fdcba68 spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND 2021-02-24 20:20:18 +08:00
Jakob Hasse
916f02164e [doc]: NVS documentation updates 
* Move nvs flash README to common doc directory
* correct markup of functions and types in text
  from old README
* Better comment of nvs_get_used_entry_count()
* Mention C++ example in API reference
* Used target instead of hard code ESP32
* Note that strings can only span one page
* Reflect that item types have been moved
* Some clarification about nvs_commit()
* Improved reference to the ESP Partition API
* fixed little mistake in documenting-code.rst
* Change of nvs_open_from_part() to
  nvs_open_from_partition() reflected in docs
* Corrected documentation of
  NVSHandle::get_string(), NVSHandle::get_blob()
  and NVSHandle::get_item_size().

* Closes DOC-165
* Closes IDF-1563
* Closes IDF-859
* Closes https://github.com/espressif/esp-idf/issues/6123
 2021-02-08 09:31:23 +08:00
Felipe Neves
ac6ce5ddbd docs: added some fast-seek documentation to the fatfs.rst 2020-11-06 13:18:16 -03:00
Angus Gratton
d76bf19ffd docs: Explain custom partition types/subtypes in more detail 
Including how to use with C++ (closes https://github.com/espressif/esp-idf/pull/1832)
 2020-04-02 10:00:17 +11:00
Angus Gratton
99cdddeb63 docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-18 10:34:11 +11:00
Michael (XIAO Xufeng)
067f3d21c9 sdspi, vfs_fat: allow sharing SPI bus among devices, and mounting multiple SD cards 2020-02-12 15:16:08 +08:00
Angus Gratton
11fac8637a docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
Marius Vikhammer
9352899d69 doc: Update English pages with generic target name 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
morris
f2cb6bd4b6 doc: fix broken example links 2020-01-21 12:11:24 +08:00
Michael (XIAO Xufeng)
087c8f6065 essl: new component to communicate with esp serial slave devices 2019-12-03 22:58:41 +08:00
Wang Fang
412a766a2a Add Chinese transaltion to sdmmc in storage folder 
The translation should be first reviewed by technical reviewer Xiao Xufeng and then by Carrie

The translation for the other documents in storage folder can be found in MR5613, MR5620 and MR5737.
 2019-09-18 13:28:16 +08:00
Wang Fang
758abe6e01 Add Chinese translation for the rst documents in storage folder, including: 
1. docs/zh_CN/api-reference/storage/fatfs.rst
2. docs/zh_CN/api-reference/storage/index.rst
3. docs/zh_CN/api-reference/storage/sdmmc.rst
4. docs/zh_CN/api-reference/storage/spiffs.rst
5. docs/zh_CN/api-reference/storage/wear-levelling.rst
 2019-09-06 19:12:36 +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
Michael (XIAO Xufeng)
d6bd24ca67 esp_flash: add initialization interface for SPI devices 2019-06-27 13:27:27 +08:00
Ivan Grokhotkov
e181a40c9f fatfs: separate IDF-specific files from the original FatFS code 
This is a breaking change: applications which used diskio.h to
call ff_diskio_register, will now need to include diskio_impl.h.
Including diskio.h will include the original diskio.h header from
FatFS library.
 2019-06-25 23:05:16 +08:00
Angus Gratton
934a1a3223 Merge branch 'feature/add_ability_to_specify_spiffsgen_dependencies' into 'master' 
Add ability to specify dependencies for spiffsgen

See merge request idf/esp-idf!4933
 2019-06-21 13:27:35 +08:00
Renz Christian Bagaporo
c65038fd74 spiffs,make: change spiffsgen build API 2019-06-21 10:58:40 +08:00
Michael (XIAO Xufeng)
37cb673cd7 esp_flash: update the document to the latest API 2019-06-20 11:50:23 +08:00
Kirill Chalov
4faf2de035 Doc/review api ref storage 2019-06-17 14:23:52 +08:00
Renz Christian Bagaporo
fa21b5f33b spiffs: move spiffsgen example with other storage related examples 2019-04-26 22:37:41 +08:00
Renz Christian Bagaporo
db95996453 docs: Add documentation for spiffsgen 2019-03-27 09:09:47 +08:00
Angus Gratton
8721173109 doc: Replace :envvar: config links with :ref: 2018-09-19 17:27:48 +10:00
Ivan Grokhotkov
da34e3eb68 sdmmc: document eMMC support, host features 2018-08-30 13:14:26 +08:00
Shivani Tipnis
35205d8513 Add files and docs for mass mfg 2018-07-20 10:41:11 +05:30
Angus Gratton
a67d5d89e0 Replace all DOS line endings with Unix 
Command run was:
git ls-tree -r HEAD --name-only | xargs dos2unix
 2018-07-12 19:10:37 +08:00
Sagar Bijwe
fd7b794e81 FATFS support without wear levelling 
This change allows readonly FATFS to be mounted without wear levelling
support. This will provide the customers a simple way to mount FATFS images
generated on host and flashed onto the chip during factory provisioning.
Since NVS encryption is not supported yet and NVS entry size is limited,
the change will provide an easy alternative for securing the provisioning data
by just marking FATFS parition as encrypted.
 2018-06-16 16:02:35 +08:00
michael
3ba8461928 doc: fix the level inconsistent issue in Kconfig document 2018-06-05 10:36:18 +00:00
Amit Sheth
aa357a32bc nvs_flash: Add binary creation support for NVS partition. 
Ideally suited for generating a binary externally, containing key-value pairs specific
to device manufacturers. Utility allows creation of a binary, compatible
with NVS structure, which can be separately flashed onto a new
partition. This helps device manufacturers set different values for
different devices, e.g. serial numbers, but using a single firmaware
image.
 2018-04-23 00:27:29 +05:30
Ivan Grokhotkov
e148c2a12c docs: update SDMMC and SDSPI documentation 
- Split SDMMC page into pages about SDMMC/SDSPI hosts and a page about
   the protocol layer.
- Use autogenerated API reference instead of manually generated one.
- Add information about SDIO APIs.
 2018-04-11 11:07:13 +08:00
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