Skip to content

Commit

Permalink
Merge branch 'feature/doc_adds_note_about_pre_burn_efuse_at_factory' …
Browse files Browse the repository at this point in the history
…into 'master'

doc: Adds note about pre-burned eFuses for Blocks with a coding scheme

See merge request espressif/esp-idf!17026
  • Loading branch information
zikalino committed Feb 4, 2022
2 parents 2fe5001 + 0f3cd98 commit 93106c9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/en/api-reference/system/efuse.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
eFuse Manager
=============

{IDF_TARGET_CODING_SCHEMES:default="Reed-Solomon", esp32="3/4 or Repeat"}


Introduction
------------
Expand Down Expand Up @@ -215,6 +217,12 @@ Supported coding scheme

To write some fields into one block, or different blocks in one time, you need to use ``the batch writing mode``. Firstly set this mode through :cpp:func:`esp_efuse_batch_write_begin` function then write some fields as usual using the ``esp_efuse_write_...`` functions. At the end to burn them, call the :cpp:func:`esp_efuse_batch_write_commit` function. It burns prepared data to the eFuse blocks and disables the ``batch recording mode``.

.. note::

If there is already pre-written data in the eFuse block using the ``{IDF_TARGET_CODING_SCHEMES}`` encoding scheme, then it is not possible to write anything extra (even if the required bits are empty) without breaking the previous encoding data. This encoding data will be overwritten with new encoding data and completely destroyed (however, the payload eFuses are not damaged). It can be related to: CUSTOM_MAC, SPI_PAD_CONFIG_HD, SPI_PAD_CONFIG_CS, etc. Please contact Espressif to order the required pre-burnt eFuses.

FOR TESTING ONLY (NOT RECOMMENDED): You can ignore or suppress errors that violate encoding scheme data in order to burn the necessary bits in the eFuse block.

eFuse API
---------

Expand Down

0 comments on commit 93106c9

Please sign in to comment.