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
7c7edab328
esp-idf/docs/api/storage/spi_flash.rst

66 lines
1.8 KiB
ReStructuredText
Raw Normal View History

Updated relative paths to included documents
2017-01-16 17:08:35 -05:00
.. include:: ../../../components/spi_flash/README.rst
docs: fix broken links, formatting, add SPI flash and partition APIs
2016-11-16 08:33:04 -05:00
API Reference
-------------
Header Files
^^^^^^^^^^^^
docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests.
2017-01-19 03:16:06 -05:00
* :component_file:`spi_flash/include/esp_spi_flash.h`
* :component_file:`spi_flash/include/esp_partition.h`
flash encryption/secure boot: Restructure documentation Also add steps to disable flash encryption, as some people seem to accidentally enable it. Explicitly mark the flash encryption and secure boot as "READ DOCS FIRST" in menuconfig.
2017-02-13 20:48:28 -05:00
* :component_file:`bootloader_support/include/esp_flash_encrypt.h`
docs: fix broken links, formatting, add SPI flash and partition APIs
2016-11-16 08:33:04 -05:00
Macros
^^^^^^
.. doxygendefine:: ESP_ERR_FLASH_BASE
.. doxygendefine:: ESP_ERR_FLASH_OP_FAIL
.. doxygendefine:: ESP_ERR_FLASH_OP_TIMEOUT
.. doxygendefine:: SPI_FLASH_SEC_SIZE
spi_flash: Move FLASH_PAGE_SIZE constant into esp_spi_flash.h
2017-01-05 19:24:24 -05:00
.. doxygendefine:: SPI_FLASH_MMU_PAGE_SIZE
docs: fix broken links, formatting, add SPI flash and partition APIs
2016-11-16 08:33:04 -05:00
.. 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
docs: spi_flash: Add flash encryption ops, remove boilerplate
2017-01-05 19:17:29 -05:00
.. doxygenfunction:: spi_flash_write_encrypted
docs: fix broken links, formatting, add SPI flash and partition APIs
2016-11-16 08:33:04 -05:00
.. doxygenfunction:: spi_flash_read
docs: spi_flash: Add flash encryption ops, remove boilerplate
2017-01-05 19:17:29 -05:00
.. doxygenfunction:: spi_flash_read_encrypted
docs: fix broken links, formatting, add SPI flash and partition APIs
2016-11-16 08:33:04 -05:00
.. 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
docs: spi_flash: Add flash encryption ops, remove boilerplate
2017-01-05 19:17:29 -05:00
.. doxygenfunction:: esp_flash_encryption_enabled
docs: fix broken links, formatting, add SPI flash and partition APIs
2016-11-16 08:33:04 -05:00
Reference in New Issue Copy Permalink