docs: spi_flash: Add flash encryption ops, remove boilerplate

This commit is contained in:
Angus Gratton
2017-01-06 11:17:29 +11:00
committed by Ivan Grokhotkov
parent adc590ff69
commit 14aa1d1b3e
3 changed files with 21 additions and 15 deletions
+4 -7
View File
@@ -1,12 +1,5 @@
.. include:: ../../../components/spi_flash/README.rst
Application Example
-------------------
`Instructions`_
.. _Instructions: ../template.html
API Reference
-------------
@@ -15,6 +8,7 @@ Header Files
* :component_file:`spi_flash/include/esp_spi_flash.h`
* :component_file:`spi_flash/include/esp_partition.h`
* :component_file:`esp32/include/esp_flash_encrypt.h`
Macros
^^^^^^
@@ -51,7 +45,9 @@ Functions
.. doxygenfunction:: spi_flash_erase_sector
.. doxygenfunction:: spi_flash_erase_range
.. doxygenfunction:: spi_flash_write
.. doxygenfunction:: spi_flash_write_encrypted
.. doxygenfunction:: spi_flash_read
.. doxygenfunction:: spi_flash_read_encrypted
.. doxygenfunction:: spi_flash_mmap
.. doxygenfunction:: spi_flash_munmap
.. doxygenfunction:: spi_flash_mmap_dump
@@ -64,4 +60,5 @@ Functions
.. doxygenfunction:: esp_partition_write
.. doxygenfunction:: esp_partition_erase_range
.. doxygenfunction:: esp_partition_mmap
.. doxygenfunction:: esp_flash_encryption_enabled