mirror of
https://github.com/espressif/esp-idf.git
synced 2026-05-19 23:45:28 +02:00
docs: fix broken links, formatting, add SPI flash and partition APIs
This commit is contained in:
@@ -3,7 +3,10 @@
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions <http://esp-idf.readthedocs.io/en/latest/api/template.html>`_
|
||||
Two examples are provided in ESP-IDF examples directory:
|
||||
|
||||
- `07_nvs_rw_value <https://github.com/espressif/esp-idf/tree/master/examples/07_nvs_rw_value>`_ demostrates how to read and write integer values
|
||||
- `08_nvs_rw_blob <https://github.com/espressif/esp-idf/tree/master/examples/08_nvs_rw_blob>`_ demostrates how to read and write variable length binary values
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
.. include:: ../../components/spi_flash/README.rst
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: template.html
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
Header Files
|
||||
^^^^^^^^^^^^
|
||||
|
||||
* `spi_flash/include/esp_spi_flash.h <https://github.com/espressif/esp-idf/blob/master/components/spi_flash/include/esp_spi_flash.h>`_
|
||||
* `spi_flash/include/esp_partition.h <https://github.com/espressif/esp-idf/blob/master/components/spi_flash/include/esp_partition.h>`_
|
||||
|
||||
Macros
|
||||
^^^^^^
|
||||
|
||||
.. doxygendefine:: ESP_ERR_FLASH_BASE
|
||||
.. doxygendefine:: ESP_ERR_FLASH_OP_FAIL
|
||||
.. doxygendefine:: ESP_ERR_FLASH_OP_TIMEOUT
|
||||
.. doxygendefine:: SPI_FLASH_SEC_SIZE
|
||||
.. doxygendefine:: ESP_PARTITION_SUBTYPE_OTA
|
||||
|
||||
Type Definitions
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. doxygentypedef:: spi_flash_mmap_handle_t
|
||||
.. doxygentypedef:: esp_partition_iterator_t
|
||||
|
||||
Enumerations
|
||||
^^^^^^^^^^^^
|
||||
|
||||
.. doxygenenum:: spi_flash_mmap_memory_t
|
||||
.. doxygenenum:: esp_partition_type_t
|
||||
.. doxygenenum:: esp_partition_subtype_t
|
||||
|
||||
Structures
|
||||
^^^^^^^^^^
|
||||
|
||||
.. doxygenstruct:: esp_partition_t
|
||||
|
||||
Functions
|
||||
^^^^^^^^^
|
||||
|
||||
.. doxygenfunction:: spi_flash_init
|
||||
.. doxygenfunction:: spi_flash_get_chip_size
|
||||
.. doxygenfunction:: spi_flash_erase_sector
|
||||
.. doxygenfunction:: spi_flash_erase_range
|
||||
.. doxygenfunction:: spi_flash_write
|
||||
.. doxygenfunction:: spi_flash_read
|
||||
.. doxygenfunction:: spi_flash_mmap
|
||||
.. doxygenfunction:: spi_flash_munmap
|
||||
.. doxygenfunction:: spi_flash_mmap_dump
|
||||
.. doxygenfunction:: esp_partition_find
|
||||
.. doxygenfunction:: esp_partition_find_first
|
||||
.. doxygenfunction:: esp_partition_get
|
||||
.. doxygenfunction:: esp_partition_next
|
||||
.. doxygenfunction:: esp_partition_iterator_release
|
||||
.. doxygenfunction:: esp_partition_read
|
||||
.. doxygenfunction:: esp_partition_write
|
||||
.. doxygenfunction:: esp_partition_erase_range
|
||||
.. doxygenfunction:: esp_partition_mmap
|
||||
|
||||
Reference in New Issue
Block a user