Chapter 2. API Reference
• custom - (optional and can be enabled by CONFIG_EFUSE_CUSTOM_TABLE) contains eFuse fields that are
used by the user in their application. C-source generation should be done manually when changing this file and
running idf.py efuse-custom-table.
Description CSV file
The CSV file contains a description of the eFuse fields. In the simple case, one field has one line of description. Table
header:
# field_name, efuse_block(EFUSE_BLK0..EFUSE_BLK10), bit_start(0..255), bit_
,→count(1..256), comment
Individual params in CSV file the following meanings:
field_name Name of field. The prefix ESP_EFUSE_ will be added to the name, and this field name will be available
in the code. This name will be used to access the fields. The name must be unique for all fields. If the line has
an empty name, then this line is combined with the previous field. This allows you to set an arbitrary order of
bits in the field, and expand the field as well (see MAC_FACTORY field in the common table). The field_name
supports structured format using . to show that the field belongs to another field (see WR_DIS and RD_DIS
in the common table).
efuse_block Block number. It determines where the eFuse bits will be placed for this field. Available
EFUSE_BLK0..EFUSE_BLK10.
bit_start Start bit number (0..255). The bit_start field can be omitted. In this case, it will be set to bit_start +
bit_count from the previous record, if it has the same efuse_block. Otherwise (if efuse_block is different, or
this is the first entry), an error will be generated.
bit_count The number of bits to use in this field (1..-). This parameter can not be omitted. This field also may be
MAX_BLK_LEN in this case, the field length will have the maximum block length.
comment This param is using for comment field, it also move to C-header file. The comment field can be omitted.
If a non-sequential bit order is required to describe a field, then the field description in the following lines should
be continued without specifying a name, this will indicate that it belongs to one field. For example two fields
MAC_FACTORY and MAC_FACTORY_CRC:
# Factory MAC address #
#######################
MAC_FACTORY, EFUSE_BLK0, 72, 8, Factory MAC addr [0]
, EFUSE_BLK0, 64, 8, Factory MAC addr [1]
, EFUSE_BLK0, 56, 8, Factory MAC addr [2]
, EFUSE_BLK0, 48, 8, Factory MAC addr [3]
, EFUSE_BLK0, 40, 8, Factory MAC addr [4]
, EFUSE_BLK0, 32, 8, Factory MAC addr [5]
MAC_FACTORY_CRC, EFUSE_BLK0, 80, 8, CRC8 for factory MAC address
This field will available in code as ESP_EFUSE_MAC_FACTORY and ESP_EFUSE_MAC_FACTORY_CRC.
Structured efuse fields
WR_DIS, EFUSE_BLK0, 0, 32, Write protection
WR_DIS.RD_DIS, EFUSE_BLK0, 0, 1, Write protection for␣
,→RD_DIS
WR_DIS.FIELD_1, EFUSE_BLK0, 1, 1, Write protection for␣
,→FIELD_1
WR_DIS.FIELD_2, EFUSE_BLK0, 2, 4, Write protection for␣
,→FIELD_2 (includes B1 and B2)
WR_DIS.FIELD_2.B1, EFUSE_BLK0, 2, 2, Write protection for␣
,→FIELD_2.B1
WR_DIS.FIELD_2.B2, EFUSE_BLK0, 4, 2, Write protection for␣
,→FIELD_2.B2
(continues on next page)
Espressif Systems 806
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General