feat(espefuse): Rename all commands to use dashes and add tests for deprecated commands

Author: peterdragun

docs/en/espefuse/adc-info-cmd.rst

@@ -3,24 +3,24 @@
 Adc Info
 ========
 
-The ``espefuse.py adc_info`` command displays information about ADC calibration data stored in eFuse.
+The ``espefuse.py adc-info`` command displays information about ADC calibration data stored in eFuse.
 
 .. only:: esp32
 
     .. code-block:: none
 
-        > espefuse.py adc_info
+        > espefuse.py adc-info
 
-        === Run "adc_info" command ===
+        === Run "adc-info" command ===
         ADC VRef calibration: 1121mV
 
 .. only:: esp32c3 or esp32s2 or esp32s3
 
     .. code-block:: none
 
-        > espefuse.py adc_info
+        > espefuse.py adc-info
 
-        === Run "adc_info" command ===
+        === Run "adc-info" command ===
         Temperature Sensor Calibration = -2.1C
 
         ADC1 readings stored in efuse BLOCK2:
@@ -47,9 +47,9 @@ The ``espefuse.py adc_info`` command displays information about ADC calibration
 
     .. code-block:: none
 
-        > espefuse.py adc_info
+        > espefuse.py adc-info
 
-        === Run "adc_info" command ===
+        === Run "adc-info" command ===
             RF_REF_I_BIAS_CONFIG:        0
             LDO_VOL_BIAS_CONFIG_LOW:     0
             LDO_VOL_BIAS_CONFIG_HIGH:    0

docs/en/espefuse/burn-bit-cmd.rst

@@ -3,7 +3,7 @@
 Burn Bit
 ========
 
-The ``espefuse.py burn_bit`` command burns bits in eFuse blocks by bit number. This is useful when the fields are not represented in the eFuse table.
+The ``espefuse.py burn-bit`` command burns bits in eFuse blocks by bit number. This is useful when the fields are not represented in the eFuse table.
 
 Positional arguments:
 
@@ -21,9 +21,9 @@ Burning bits to BLOCK2:
 
 .. code-block:: none
 
-    > espefuse.py burn_bit BLOCK2 15 16 17 18 19 20
+    > espefuse.py burn-bit BLOCK2 15 16 17 18 19 20
 
-    === Run "burn_bit" command ===
+    === Run "burn-bit" command ===
     bit_number:   [255]........................................................[0]
     BLOCK2    : 0x00000000000000000000000000000000000000000000000000000000001f8000
     BLOCK2          (secure_boot_v1 s) [2 ] regs_to_write: 001f8000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
@@ -44,17 +44,17 @@ Burning in Multiple Blocks
 
 .. code-block:: none
 
-    > espefuse.py --virt burn_bit BLOCK2 15 16 17 18 19 20 \
-                         burn_bit BLOCK3 15 16 17 18 19 20
+    > espefuse.py --virt burn-bit BLOCK2 15 16 17 18 19 20 \
+                         burn-bit BLOCK3 15 16 17 18 19 20
 
-    === Run "burn_bit" command ===
+    === Run "burn-bit" command ===
     bit_number:   [255]........................................................[0]
     BLOCK2    : 0x00000000000000000000000000000000000000000000000000000000001f8000
     BLOCK2          (secure_boot_v1 s) [2 ] regs_to_write: 001f8000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
 
     Batch mode is enabled, the burn will be done at the end of the command.
 
-    === Run "burn_bit" command ===
+    === Run "burn-bit" command ===
     bit_number:   [255]........................................................[0]
     BLOCK3    : 0x00000000000000000000000000000000000000000000000000000000001f8000
     BLOCK3          (                ) [3 ] regs_to_write: 001f8000 00000000 00000000 00000000 00000000 00000000 00000000 00000000

docs/en/espefuse/burn-block-data-cmd.rst

@@ -3,7 +3,7 @@
 Burn Block Data
 ===============
 
-The ``espefuse.py burn_block_data`` command allows writing arbitrary data (non-key data) from a file into an eFuse block, for software use.
+The ``espefuse.py burn-block-data`` command allows writing arbitrary data (non-key data) from a file into an eFuse block, for software use.
 
 This command is available in ``espefuse.py`` v2.6 and newer.
 
@@ -23,9 +23,9 @@ Optional arguments:
 
 .. code-block:: none
 
-    > espefuse.py -p PORT burn_block_data --offset 6 BLOCK3 device_id.bin
+    > espefuse.py -p PORT burn-block-data --offset 6 BLOCK3 device_id.bin
 
-    === Run "burn_block_data" command ===
+    === Run "burn-block-data" command ===
     [03] BLOCK3               size=32 bytes, offset=06 - > [00 00 00 00 00 00 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 00 00 00 00 00 00 00 00 00 00].
 
     Check all blocks for burn...
@@ -56,4 +56,4 @@ Peculiarities
     = 00 00 00 00 00 00 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 00 00 00 00 00 00 00 00 00 00 R/W
 
 2. Part of the eFuse block can be written at a time. The ``--offset`` argument allows writing to a byte offset inside the eFuse block itself.
-3. This command is not suitable for writing key data which will be used by flash encryption or secure boot hardware, use ``burn_key`` for this.
+3. This command is not suitable for writing key data which will be used by flash encryption or secure boot hardware, use ``burn-key`` for this.

docs/en/espefuse/burn-custom-mac-cmd.rst

@@ -3,7 +3,7 @@
 Burn Custom Mac
 ===============
 
-The ``espefuse.py burn_custom_mac`` command burns a 48-bit Custom MAC Address.
+The ``espefuse.py burn-custom-mac`` command burns a 48-bit Custom MAC Address.
 
 Positional arguments:
 
@@ -25,9 +25,9 @@ If ``CUSTOM_MAC`` is placed in an eFuse block with a coding scheme and already h
 
     .. code-block:: none
 
-        > espefuse.py  burn_custom_mac 48:63:92:15:72:16
+        > espefuse.py burn-custom-mac 48:63:92:15:72:16
 
-        === Run "burn_custom_mac" command ===
+        === Run "burn-custom-mac" command ===
             - 'MAC_VERSION' (Version of the MAC field) 0x00 -> 0x1
             - 'CUSTOM_MAC' (Custom MAC) 0x000000000000 -> 0x167215926348
             - 'CUSTOM_MAC_CRC' (CRC of custom MAC) 0x00 -> 0x75
@@ -63,9 +63,9 @@ If ``CUSTOM_MAC`` is placed in an eFuse block with a coding scheme and already h
 
     .. code-block:: none
 
-        > espefuse.py burn_custom_mac 48:63:92:15:72:16
+        > espefuse.py burn-custom-mac 48:63:92:15:72:16
 
-        === Run "burn_custom_mac" command ===
+        === Run "burn-custom-mac" command ===
             - 'CUSTOM_MAC' (Custom MAC addr) 0x000000000000 -> 0x167215926348
 
         Check all blocks for burn...
@@ -97,9 +97,9 @@ If ``CUSTOM_MAC`` is placed in an eFuse block with a coding scheme and already h
 
     .. code-block:: none
 
-        > espefuse.py burn_custom_mac 48:63:92:15:72:16
+        > espefuse.py burn-custom-mac 48:63:92:15:72:16
 
-        === Run "burn_custom_mac" command ===
+        === Run "burn-custom-mac" command ===
             - 'CUSTOM_MAC' (Custom MAC Address) 0x000000000000 -> 0x167215926348
 
         Check all blocks for burn...

docs/en/espefuse/burn-efuse-cmd.rst

@@ -3,7 +3,7 @@
 Burn eFuse
 ==========
 
-The ``espefuse.py burn_efuse`` command burns eFuses. The arguments to ``burn_efuse`` are eFuse names (as shown in summary output) and new values.
+The ``espefuse.py burn-efuse`` command burns eFuses. The arguments to ``burn-efuse`` are eFuse names (as shown in summary output) and new values.
 
 Positional arguments:
 
@@ -16,15 +16,15 @@ Optional arguments:
 
 It can be list of eFuse names and values (like EFUSE_NAME1 1 EFUSE_NAME2 7 EFUSE_NAME3 10 etc.).
 
-New values can be a numeric value in decimal or hex (with "0x" prefix). eFuse bits can only be burned from 0 to 1, attempting to set any back to 0 will have no effect. Most eFuses have a limited bit width (many are only 1-bit flags). Longer eFuses (MAC addresses, keys) can be set with this command, but it's better to use a specific command (``burn_custom_mac``, ``burn_key``) for a specific field.
+New values can be a numeric value in decimal or hex (with "0x" prefix). eFuse bits can only be burned from 0 to 1, attempting to set any back to 0 will have no effect. Most eFuses have a limited bit width (many are only 1-bit flags). Longer eFuses (MAC addresses, keys) can be set with this command, but it's better to use a specific command (``burn-custom-mac``, ``burn-key``) for a specific field.
 
 This command supports simultaneous burning of multiple eFuses, it doesn't matter if they are from different eFuse blocks or not. The format is the same as for burning just one eFuse, just list the eFuse name and value pairs, see the example below.
 
 .. code-block:: none
 
-    > espefuse.py --port /dev/ttyUSB0 burn_efuse   DIS_USB_JTAG 1   VDD_SPI_AS_GPIO 1
+    > espefuse.py --port /dev/ttyUSB0 burn-efuse   DIS_USB_JTAG 1   VDD_SPI_AS_GPIO 1
 
-    === Run "burn_efuse" command ===
+    === Run "burn-efuse" command ===
     The efuses to burn:
     from BLOCK0
         - DIS_USB_JTAG
@@ -102,4 +102,4 @@ For example:
 
     SPI_PAD_CONFIG_CS0     Override SD_CMD pad (GPIO11/SPICS0)               = 32 R/W (0x1e)
 
-If using the ``burn_efuse`` command to configure these pins, always specify the actual GPIO number you wish to set.
+If using the ``burn-efuse`` command to configure these pins, always specify the actual GPIO number you wish to set.

docs/en/espefuse/burn-key-cmd.rst

@@ -3,7 +3,7 @@
 Burn Key
 ========
 
-The ``espefuse.py burn_key`` command burns keys to eFuse blocks:
+The ``espefuse.py burn-key`` command burns keys to eFuse blocks:
 
 .. list::
 
@@ -78,7 +78,7 @@ Optional arguments:
 
 .. only:: esp32h2
 
-    {IDF_TARGET_NAME} has the ECDSA accelerator for signature purposes and supports private keys based on the NIST192p or NIST256p curve. These two commands below can be used to generate such keys (``PEM`` file). The ``burn_key`` command with the ``ECDSA_KEY`` purpose takes the ``PEM`` file and writes the private key into a eFuse block. The key is written to the block in reverse byte order.
+    {IDF_TARGET_NAME} has the ECDSA accelerator for signature purposes and supports private keys based on the NIST192p or NIST256p curve. These two commands below can be used to generate such keys (``PEM`` file). The ``burn-key`` command with the ``ECDSA_KEY`` purpose takes the ``PEM`` file and writes the private key into a eFuse block. The key is written to the block in reverse byte order.
 
     For NIST192p, the private key is 192 bits long, so 8 padding bytes ("0x00") are added.
 
@@ -146,7 +146,7 @@ By default, when an encryption key block is burned it is also read and write pro
 
 .. code-block:: none
 
-    espefuse.py burn_key secure_boot_v1 secure_boot_key_v1.bin
+    espefuse.py burn-key secure_boot_v1 secure_boot_key_v1.bin
 
 .. only:: esp32
 
@@ -166,9 +166,9 @@ Usage
 
     .. code-block:: none
 
-        > espefuse.py burn_key flash_encryption  256bit_fe_key.bin
+        > espefuse.py burn-key flash_encryption  256bit_fe_key.bin
 
-        === Run "burn_key" command ===
+        === Run "burn-key" command ===
         Sensitive data will be hidden (see --show-sensitive-info)
         Burn keys to blocks:
         - BLOCK1 -> [?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ??]
@@ -209,9 +209,9 @@ Usage
 
     .. code-block:: none
 
-        > espefuse.py burn_key flash_encryption  256bit_fe_key.bin --no-protect-key
+        > espefuse.py burn-key flash_encryption  256bit_fe_key.bin --no-protect-key
 
-        === Run "burn_key" command ===
+        === Run "burn-key" command ===
         Sensitive data will be hidden (see --show-sensitive-info)
         Burn keys to blocks:
         - BLOCK1 -> [?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ??]
@@ -256,9 +256,9 @@ Usage
 
     .. code-block:: none
 
-        > espefuse.py burn_key BLOCK_KEY0 ~/esp/tests/efuse/512bits_0.bin  XTS_AES_256_KEY --no-read-protect
+        > espefuse.py burn-key BLOCK_KEY0 ~/esp/tests/efuse/512bits_0.bin  XTS_AES_256_KEY --no-read-protect
 
-        === Run "burn_key" command ===
+        === Run "burn-key" command ===
         Sensitive data will be hidden (see --show-sensitive-info)
         Burn keys to blocks:
         - BLOCK_KEY0 -> [?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ??]
@@ -309,10 +309,10 @@ Usage
     .. code-block:: none
 
         > espefuse.py -c esp32c2  \
-                                burn_key_digest secure_images/ecdsa256_secure_boot_signing_key_v2.pem \
-                                burn_key BLOCK_KEY0 images/efuse/128bit_key.bin XTS_AES_128_KEY_DERIVED_FROM_128_EFUSE_BITS
+                                burn-key-digest secure_images/ecdsa256_secure_boot_signing_key_v2.pem \
+                                burn-key BLOCK_KEY0 images/efuse/128bit_key.bin XTS_AES_128_KEY_DERIVED_FROM_128_EFUSE_BITS
 
-        === Run "burn_key_digest" command ===
+        === Run "burn-key-digest" command ===
         Sensitive data will be hidden (see --show-sensitive-info)
         Burn keys to blocks:
         - BLOCK_KEY0_HI_128 -> [?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ??]
@@ -321,7 +321,7 @@ Usage
 
         Batch mode is enabled, the burn will be done at the end of the command.
 
-        === Run "burn_key" command ===
+        === Run "burn-key" command ===
         Sensitive data will be hidden (see --show-sensitive-info)
         Burn keys to blocks:
         - BLOCK_KEY0_LOW_128 -> [?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ??]

docs/en/espefuse/burn-key-digest-cmd.rst

@@ -1,9 +1,9 @@
 .. _burn-key-digest-cmd:
 
-Burn key Digest
+Burn Key Digest
 ===============
 
-The ``espefuse.py burn_key_digest`` command parses a RSA public key and burns the digest to eFuse block for use with `Secure Boot V2 <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/security/secure-boot-v2.html#signature-block-format>`_.
+The ``espefuse.py burn-key-digest`` command parses a RSA public key and burns the digest to eFuse block for use with `Secure Boot V2 <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/security/secure-boot-v2.html#signature-block-format>`_.
 
 Positional arguments:
 
@@ -44,9 +44,9 @@ Usage
 
     .. code-block:: none
 
-        > espefuse.py burn_key_digest secure_boot_key_v2_0.pem
+        > espefuse.py burn-key-digest secure_boot_key_v2_0.pem
 
-        === Run "burn_key_digest" command ===
+        === Run "burn-key-digest" command ===
         Sensitive data will be hidden (see --show-sensitive-info)
         - BLOCK2 -> [?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ??]
         Disabling write to efuse BLOCK2...
@@ -75,9 +75,9 @@ Usage
 
     .. code-block:: none
 
-        > espefuse.py burn_key_digest secure_boot_v2_ecdsa192.pem
+        > espefuse.py burn-key-digest secure_boot_v2_ecdsa192.pem
 
-        === Run "burn_key_digest" command ===
+        === Run "burn-key-digest" command ===
         Sensitive data will be hidden (see --show-sensitive-info)
         Burn keys to blocks:
         - BLOCK_KEY0_HI_128 -> [?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ??]
@@ -114,12 +114,12 @@ Usage
 
     .. code-block:: none
 
-        > espefuse.py burn_key_digest \
+        > espefuse.py burn-key-digest \
                     BLOCK_KEY0 ~/esp/tests/efuse/secure_boot_key_v2_0.pem  SECURE_BOOT_DIGEST0  \
                     BLOCK_KEY1 ~/esp/tests/efuse/secure_boot_key_v2_1.pem  SECURE_BOOT_DIGEST1  \
                     BLOCK_KEY2 ~/esp/tests/efuse/secure_boot_key_v2_2.pem  SECURE_BOOT_DIGEST2
 
-        === Run "burn_key_digest" command ===
+        === Run "burn-key-digest" command ===
         Sensitive data will be hidden (see --show-sensitive-info)
         Burn keys to blocks:
         - BLOCK_KEY0 -> [?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ?? ??]

docs/en/espefuse/check-error-cmd.rst

@@ -3,7 +3,7 @@
 Check Error
 ===========
 
-The ``espefuse.py check_error`` command checks eFuse errors. It triggers several reads to force the eFuse controller to reload eFuses and update status registers. This command can be run after burn operations to make sure that there is not errors.
+The ``espefuse.py check-error`` command checks eFuse errors. It triggers several reads to force the eFuse controller to reload eFuses and update status registers. This command can be run after burn operations to make sure that there is not errors.
 
 Optional argument:
 
@@ -31,7 +31,7 @@ Checks the status registers of eFuse blocks and throws an error if there is an e
 
 .. code-block:: none
 
-    > espefuse.py check_error
+    > espefuse.py check-error
 
     Error(s) in BLOCK1 [ERRORS:0 FAIL:1]
     Error(s) in BLOCK2 [ERRORS:1 FAIL:1]
@@ -41,7 +41,7 @@ Checks the status registers of eFuse blocks and throws an error if there is an e
     EFUSE_RD_RS_ERR0_REG        0x00008990
     EFUSE_RD_RS_ERR1_REG        0x00000000
 
-    === Run "check_error" command ===
+    === Run "check-error" command ===
     Error(s) in BLOCK1 [ERRORS:0 FAIL:1]
     Error(s) in BLOCK2 [ERRORS:1 FAIL:1]
     Error(s) in BLOCK3 [ERRORS:1 FAIL:1]
@@ -56,7 +56,7 @@ Repairs encoding errors in eFuse blocks, if possible.
 
 .. code-block:: none
 
-    > espefuse.py check_error --recovery
+    > espefuse.py check-error --recovery
 
     Error(s) in BLOCK1 [ERRORS:0 FAIL:1]
     Error(s) in BLOCK2 [ERRORS:1 FAIL:1]
@@ -66,7 +66,7 @@ Repairs encoding errors in eFuse blocks, if possible.
     EFUSE_RD_RS_ERR0_REG        0x00008990
     EFUSE_RD_RS_ERR1_REG        0x00000000
 
-    === Run "check_error" command ===
+    === Run "check-error" command ===
     Error(s) in BLOCK1 [ERRORS:0 FAIL:1]
     Error(s) in BLOCK2 [ERRORS:1 FAIL:1]
     Error(s) in BLOCK3 [ERRORS:1 FAIL:1]