diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 721024583..11ec9aec4 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -96,7 +96,7 @@ Conventional Commits Ruff """" -``esptool.py`` is `PEP8 `_ compliant and enforces this style guide. For compliancy checking, we use `ruff `_. +``esptool.py`` is `PEP8 `_ compliant and enforces this style guide. For compliance checking, we use `ruff `_. ``Ruff`` also auto-format files in the same style as previously used ``black``. @@ -131,7 +131,7 @@ The following tests run automatically by GitHub Actions for each Pull Request. Y * ``test_mergebin.py`` tests the ``merge_bin`` command * ``test_modules.py`` tests the modules used by ``esptool.py`` for regressions * ``test_espsecure.py`` tests ``espsecure.py`` functionality -* ``test_espsecure_hsm.py`` tests support of extarnal HSM signing in ``espsecure.py``. These tests require additional prerequisites, see ``SoftHSM2 setup`` in the `tests workflow definition `_ for more information. +* ``test_espsecure_hsm.py`` tests support of external HSM signing in ``espsecure.py``. These tests require additional prerequisites, see ``SoftHSM2 setup`` in the `tests workflow definition `_ for more information. The following tests are not run automatically by GitHub Actions, because they need real connected hardware. Therefore, they need to be run locally in a command line: diff --git a/docs/en/advanced-topics/serial-protocol.rst b/docs/en/advanced-topics/serial-protocol.rst index 90b0b9932..48c85eec9 100644 --- a/docs/en/advanced-topics/serial-protocol.rst +++ b/docs/en/advanced-topics/serial-protocol.rst @@ -265,7 +265,7 @@ Supported by stub loader only ROM loaders will not recognise these commands. +------------+-------------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------+----------+ -| Byte | Name | Descripton | Input | Output | +| Byte | Name | Description | Input | Output | +============+===================+===================================+=========================================================================================================================+==========+ | ``0xd0`` | ERASE_FLASH | Erase entire flash chip | | | +------------+-------------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------+----------+ diff --git a/docs/en/espefuse/burn-key-cmd.rst b/docs/en/espefuse/burn-key-cmd.rst index 92922519e..c6a7714c2 100644 --- a/docs/en/espefuse/burn-key-cmd.rst +++ b/docs/en/espefuse/burn-key-cmd.rst @@ -42,14 +42,14 @@ Optional arguments: .. only:: esp32 - {IDF_TARGET_NAME} supportes keys: + {IDF_TARGET_NAME} supports keys: * Secure boot key. Use ``secure_boot_v1`` or ``secure_boot_v2`` as block name. The key is placed in BLOCK2. * Flash encryption key. Use ``flash_encryption`` as block name. The key is placed in BLOCK1. Keys for ``flash_encryption`` and ``secure_boot_v1`` will be burned as read and write protected. The hardware will still have access to them. These keys are burned in reversed byte order. - Key for ``secure_boot_v2`` will be burned only as write protected. The key must be readable because the software need acces to it. + Key for ``secure_boot_v2`` will be burned only as write protected. The key must be readable because the software need access to it. .. warning:: @@ -57,7 +57,7 @@ Optional arguments: .. only:: not esp32 and not esp32c2 - {IDF_TARGET_NAME} supportes eFuse key purposes. This means that each eFuse block has a special eFuse field that indicates which key is in the eFuse block. During the burn operation this eFuse key purpose is burned as well with write protection (the ``--no-write-protect`` flag has no effect on this field). The {IDF_TARGET_NAME} chip supports the following key purposes: + {IDF_TARGET_NAME} supports eFuse key purposes. This means that each eFuse block has a special eFuse field that indicates which key is in the eFuse block. During the burn operation this eFuse key purpose is burned as well with write protection (the ``--no-write-protect`` flag has no effect on this field). The {IDF_TARGET_NAME} chip supports the following key purposes: .. list:: diff --git a/docs/en/espefuse/read-write-protections-cmd.rst b/docs/en/espefuse/read-write-protections-cmd.rst index 3ae6f740e..e1611e538 100644 --- a/docs/en/espefuse/read-write-protections-cmd.rst +++ b/docs/en/espefuse/read-write-protections-cmd.rst @@ -10,7 +10,7 @@ There are two commands (to get the correct list of eFuse fields that can be prot Positional arguments: -- eFuse name. It can recieve a list of eFuse names (like EFUSE_NAME1 EFUSE_NAME2 etc.). +- eFuse name. It can receive a list of eFuse names (like EFUSE_NAME1 EFUSE_NAME2 etc.). Read protection prevents software from reading eFuse fields, only hardware can access such eFuses. Such eFuses are read as zero and the data is marked as ``??`` in this tool. diff --git a/docs/en/esptool/advanced-commands.rst b/docs/en/esptool/advanced-commands.rst index d19309497..caa54c5e4 100644 --- a/docs/en/esptool/advanced-commands.rst +++ b/docs/en/esptool/advanced-commands.rst @@ -94,7 +94,7 @@ The ``--bytes`` argument determines how many status register bytes are read. .. note:: - Not all flash chips support all of these comands. Consult the specific flash chip datasheet for details. + Not all flash chips support all of these commands. Consult the specific flash chip datasheet for details. .. _write-flash-status: diff --git a/docs/en/installation.rst b/docs/en/installation.rst index 4fcfc1ea2..3a3828b8c 100644 --- a/docs/en/installation.rst +++ b/docs/en/installation.rst @@ -63,7 +63,7 @@ As a Component If ``esptool.py`` is installed as a component of a development framework (e.g. `ESP-IDF `_, `Arduino `_, or `PlatformIO `_), it is advised to follow the update guide of used framework for instructions and not to update the tool directly. -If updating directly is unavoidable, make sure you update to a compatible version by staying on the same MAJOR version number (explaned in the :ref:`versions` article). For instance, if your currently installed ``esptool.py`` is ``v3.3.1``, only update to ``v3.*.*``. You risk introducing incompatible changes by updating to ``v4.*.*`` or higher. +If updating directly is unavoidable, make sure you update to a compatible version by staying on the same MAJOR version number (explained in the :ref:`versions` article). For instance, if your currently installed ``esptool.py`` is ``v3.3.1``, only update to ``v3.*.*``. You risk introducing incompatible changes by updating to ``v4.*.*`` or higher. :: diff --git a/esp_rfc2217_server.py b/esp_rfc2217_server.py index cf83a183b..7beaa610b 100755 --- a/esp_rfc2217_server.py +++ b/esp_rfc2217_server.py @@ -9,7 +9,7 @@ # This is a modified version of rfc2217_server.py provided by the pyserial package # (pythonhosted.org/pyserial/examples.html#single-port-tcp-ip-serial-bridge-rfc-2217). # It uses a custom PortManager to properly apply the RTS & DTR signals -# for reseting ESP chips. +# for resetting ESP chips. # # Run the following command on the server side to make # connection between /dev/ttyUSB1 and TCP port 4000: diff --git a/espefuse/efuse/base_fields.py b/espefuse/efuse/base_fields.py index 13ce90b2c..4cecd09d2 100644 --- a/espefuse/efuse/base_fields.py +++ b/espefuse/efuse/base_fields.py @@ -317,7 +317,7 @@ def check_wr_data(self): if rd_chunk == wr_chunk: print( "wr_chunk == rd_chunk. " - "Countinue with empty chunk." + "Continue with empty chunk." ) wr_data[i : i + 6 * 8 :].set(0) else: @@ -736,7 +736,7 @@ def check_new_value(self, bitarray_new_value): else: if self.name not in ["WR_DIS", "RD_DIS"]: # WR_DIS, RD_DIS fields can have already set bits. - # Do not neeed to check below condition for them. + # Do not need to check below condition for them. if bitarray_new_value | bitarray_old_value != bitarray_new_value: error_msg = "\tNew value contains some bits that cannot be cleared " error_msg += "(value will be {})".format( diff --git a/espefuse/efuse_defs/esp32c6.yaml b/espefuse/efuse_defs/esp32c6.yaml index 7afb4871e..db8be540b 100644 --- a/espefuse/efuse_defs/esp32c6.yaml +++ b/espefuse/efuse_defs/esp32c6.yaml @@ -14,8 +14,8 @@ EFUSES: SOFT_DIS_JTAG : {show: y, blk : 0, word: 1, pos: 16, len : 3, start : 48, type : 'uint:3', wr_dis : 31, rd_dis: null, alt : '', dict : '', desc: 'Represents whether JTAG is disabled in soft way. Odd number: disabled. Even number: enabled', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[18:16]', bloc: 'B6[2:0]'} DIS_PAD_JTAG : {show: y, blk : 0, word: 1, pos: 19, len : 1, start : 51, type : bool, wr_dis : 2, rd_dis: null, alt : '', dict : '', desc: 'Represents whether JTAG is disabled in the hard way(permanently). 1: disabled. 0: enabled', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[19]', bloc: 'B6[3]'} DIS_DOWNLOAD_MANUAL_ENCRYPT : {show: y, blk : 0, word: 1, pos: 20, len : 1, start : 52, type : bool, wr_dis : 2, rd_dis: null, alt : '', dict : '', desc: 'Represents whether flash encrypt function is disabled or enabled(except in SPI boot mode). 1: disabled. 0: enabled', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[20]', bloc: 'B6[4]'} - USB_DREFH : {show: n, blk : 0, word: 1, pos: 21, len : 2, start : 53, type : 'uint:2', wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: Represents the single-end input threhold vrefh; 1.76 V to 2 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[22:21]', bloc: 'B6[6:5]'} - USB_DREFL : {show: n, blk : 0, word: 1, pos: 23, len : 2, start : 55, type : 'uint:2', wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: Represents the single-end input threhold vrefl; 1.76 V to 2 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[24:23]', bloc: 'B6[7],B7[0]'} + USB_DREFH : {show: n, blk : 0, word: 1, pos: 21, len : 2, start : 53, type : 'uint:2', wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: Represents the single-end input threshold vrefh; 1.76 V to 2 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[22:21]', bloc: 'B6[6:5]'} + USB_DREFL : {show: n, blk : 0, word: 1, pos: 23, len : 2, start : 55, type : 'uint:2', wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: Represents the single-end input threshold vrefl; 1.76 V to 2 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[24:23]', bloc: 'B6[7],B7[0]'} USB_EXCHG_PINS : {show: y, blk : 0, word: 1, pos: 25, len : 1, start : 57, type : bool, wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: 'Represents whether the D+ and D- pins is exchanged. 1: exchanged. 0: not exchanged', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[25]', bloc: 'B7[1]'} VDD_SPI_AS_GPIO : {show: y, blk : 0, word: 1, pos: 26, len : 1, start : 58, type : bool, wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: 'Represents whether vdd spi pin is functioned as gpio. 1: functioned. 0: not functioned', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[26]', bloc: 'B7[2]'} RPT4_RESERVED0_2 : {show: n, blk : 0, word: 1, pos: 27, len : 2, start : 59, type : 'uint:2', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: Reserved, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[28:27]', bloc: 'B7[4:3]'} diff --git a/espefuse/efuse_defs/esp32h2.yaml b/espefuse/efuse_defs/esp32h2.yaml index 7e2b246fc..7dddf5108 100644 --- a/espefuse/efuse_defs/esp32h2.yaml +++ b/espefuse/efuse_defs/esp32h2.yaml @@ -14,8 +14,8 @@ EFUSES: SOFT_DIS_JTAG : {show: y, blk : 0, word: 1, pos: 16, len : 3, start : 48, type : 'uint:3', wr_dis : 31, rd_dis: null, alt : '', dict : '', desc: 'Represents whether JTAG is disabled in soft way. Odd number: disabled. Even number: enabled', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[18:16]', bloc: 'B6[2:0]'} DIS_PAD_JTAG : {show: y, blk : 0, word: 1, pos: 19, len : 1, start : 51, type : bool, wr_dis : 2, rd_dis: null, alt : '', dict : '', desc: 'Represents whether JTAG is disabled in the hard way(permanently). 1: disabled. 0: enabled', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[19]', bloc: 'B6[3]'} DIS_DOWNLOAD_MANUAL_ENCRYPT : {show: y, blk : 0, word: 1, pos: 20, len : 1, start : 52, type : bool, wr_dis : 2, rd_dis: null, alt : '', dict : '', desc: 'Represents whether flash encrypt function is disabled or enabled(except in SPI boot mode). 1: disabled. 0: enabled', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[20]', bloc: 'B6[4]'} - USB_DREFH : {show: n, blk : 0, word: 1, pos: 21, len : 2, start : 53, type : 'uint:2', wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: Represents the single-end input threhold vrefh; 1.76 V to 2 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[22:21]', bloc: 'B6[6:5]'} - USB_DREFL : {show: n, blk : 0, word: 1, pos: 23, len : 2, start : 55, type : 'uint:2', wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: Represents the single-end input threhold vrefl; 1.76 V to 2 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[24:23]', bloc: 'B6[7],B7[0]'} + USB_DREFH : {show: n, blk : 0, word: 1, pos: 21, len : 2, start : 53, type : 'uint:2', wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: Represents the single-end input threshold vrefh; 1.76 V to 2 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[22:21]', bloc: 'B6[6:5]'} + USB_DREFL : {show: n, blk : 0, word: 1, pos: 23, len : 2, start : 55, type : 'uint:2', wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: Represents the single-end input threshold vrefl; 1.76 V to 2 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[24:23]', bloc: 'B6[7],B7[0]'} USB_EXCHG_PINS : {show: y, blk : 0, word: 1, pos: 25, len : 1, start : 57, type : bool, wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: 'Represents whether the D+ and D- pins is exchanged. 1: exchanged. 0: not exchanged', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[25]', bloc: 'B7[1]'} VDD_SPI_AS_GPIO : {show: y, blk : 0, word: 1, pos: 26, len : 1, start : 58, type : bool, wr_dis : 30, rd_dis: null, alt : '', dict : '', desc: 'Represents whether vdd spi pin is functioned as gpio. 1: functioned. 0: not functioned', rloc: 'EFUSE_RD_REPEAT_DATA0_REG[26]', bloc: 'B7[2]'} RPT4_RESERVED0_2 : {show: n, blk : 0, word: 1, pos: 27, len : 2, start : 59, type : 'uint:2', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: Reserved, rloc: 'EFUSE_RD_REPEAT_DATA0_REG[28:27]', bloc: 'B7[4:3]'} diff --git a/espefuse/efuse_defs/esp32p4.yaml b/espefuse/efuse_defs/esp32p4.yaml index 93d8288df..419e86fd4 100644 --- a/espefuse/efuse_defs/esp32p4.yaml +++ b/espefuse/efuse_defs/esp32p4.yaml @@ -63,8 +63,8 @@ EFUSES: PXA0_TIEH_SEL_2 : {show: y, blk : 0, word: 5, pos : 4, len : 2, start: 164, type : 'uint:2', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: TBD, rloc: 'EFUSE_RD_REPEAT_DATA4_REG[5:4]', bloc: 'B20[5:4]'} PXA0_TIEH_SEL_3 : {show: y, blk : 0, word: 5, pos : 6, len : 2, start: 166, type : 'uint:2', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: TBD, rloc: 'EFUSE_RD_REPEAT_DATA4_REG[7:6]', bloc: 'B20[7:6]'} KM_DISABLE_DEPLOY_MODE : {show: y, blk : 0, word: 5, pos : 8, len : 4, start: 168, type : 'uint:4', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: TBD, rloc: 'EFUSE_RD_REPEAT_DATA4_REG[11:8]', bloc: 'B21[3:0]'} - USB_DEVICE_DREFL : {show: n, blk : 0, word: 5, pos: 12, len : 2, start: 172, type : 'uint:2', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: Represents the usb device single-end input low threhold; 0.8 V to 1.04 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA4_REG[13:12]', bloc: 'B21[5:4]'} - USB_OTG11_DREFL : {show: n, blk : 0, word: 5, pos: 14, len : 2, start: 174, type : 'uint:2', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: Represents the usb otg11 single-end input low threhold; 0.8 V to 1.04 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA4_REG[15:14]', bloc: 'B21[7:6]'} + USB_DEVICE_DREFL : {show: n, blk : 0, word: 5, pos: 12, len : 2, start: 172, type : 'uint:2', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: Represents the usb device single-end input low threshold; 0.8 V to 1.04 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA4_REG[13:12]', bloc: 'B21[5:4]'} + USB_OTG11_DREFL : {show: n, blk : 0, word: 5, pos: 14, len : 2, start: 174, type : 'uint:2', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: Represents the usb otg11 single-end input low threshold; 0.8 V to 1.04 V with step of 80 mV, rloc: 'EFUSE_RD_REPEAT_DATA4_REG[15:14]', bloc: 'B21[7:6]'} RESERVE_0_176 : {show: n, blk : 0, word: 5, pos: 16, len : 2, start: 176, type : 'uint:2', wr_dis: null, rd_dis: null, alt : '', dict : '', desc: Reserved; it was created by set_missed_fields_in_regs func, rloc: 'EFUSE_RD_REPEAT_DATA4_REG[17:16]', bloc: 'B22[1:0]'} HP_PWR_SRC_SEL : {show: y, blk : 0, word: 5, pos: 18, len : 1, start: 178, type : bool, wr_dis: null, rd_dis: null, alt : '', dict : '', desc: 'HP system power source select. 0:LDO. 1: DCDC', rloc: 'EFUSE_RD_REPEAT_DATA4_REG[18]', bloc: 'B22[2]'} DCDC_VSET_EN : {show: y, blk : 0, word: 5, pos: 19, len : 1, start: 179, type : bool, wr_dis: null, rd_dis: null, alt : '', dict : '', desc: Select dcdc vset use efuse_dcdc_vset, rloc: 'EFUSE_RD_REPEAT_DATA4_REG[19]', bloc: 'B22[3]'} diff --git a/esptool/__init__.py b/esptool/__init__.py index 021ce08f5..556847b0c 100644 --- a/esptool/__init__.py +++ b/esptool/__init__.py @@ -475,7 +475,7 @@ def add_spi_flash_subparsers( parser_elf2image.add_argument( "--use_segments", help="If set, ELF segments will be used instead of ELF sections " - "to genereate the image.", + "to generate the image.", action="store_true", ) parser_elf2image.add_argument( diff --git a/esptool/cmds.py b/esptool/cmds.py index 09a97c4bd..beee92f79 100644 --- a/esptool/cmds.py +++ b/esptool/cmds.py @@ -1275,7 +1275,7 @@ def get_security_info(esp, args): hard_dis_jtag = get_security_flag_status("HARD_DIS_JTAG", flags) soft_dis_jtag = get_security_flag_status("SOFT_DIS_JTAG", flags) if hard_dis_jtag: - print("JTAG: Permenantly Disabled") + print("JTAG: Permanently Disabled") elif soft_dis_jtag: print("JTAG: Software Access Disabled") if get_security_flag_status("DIS_USB", flags): diff --git a/esptool/loader.py b/esptool/loader.py index 3a03b0f5a..55a941299 100644 --- a/esptool/loader.py +++ b/esptool/loader.py @@ -201,7 +201,7 @@ class ESPLoader(object): ESP_WRITE_REG = 0x09 ESP_READ_REG = 0x0A - # Some comands supported by ESP32 and later chips ROM bootloader (or -8266 w/ stub) + # Some commands supported by ESP32 and later chips ROM bootloader (or -8266 w/ stub) ESP_SPI_SET_PARAMS = 0x0B ESP_SPI_ATTACH = 0x0D ESP_READ_FLASH_SLOW = 0x0E # ROM only, much slower than the stub flash read @@ -509,7 +509,7 @@ def sync(self): # ROM bootloaders send some non-zero "val" response. The flasher stub sends 0. # If we receive 0 then it probably indicates that the chip wasn't or couldn't be - # reseted properly and esptool is talking to the flasher stub. + # reset properly and esptool is talking to the flasher stub. self.sync_stub_detected = val == 0 for _ in range(7): diff --git a/esptool/targets/esp32.py b/esptool/targets/esp32.py index 09804eaec..cd839da1a 100644 --- a/esptool/targets/esp32.py +++ b/esptool/targets/esp32.py @@ -124,7 +124,7 @@ def is_flash_encryption_key_valid(self): # When ESP32 has not generated AES/encryption key in BLOCK1, # the contents will be readable and 0. # If the flash encryption is enabled it is expected to have a valid - # non-zero key. We break out on first occurance of non-zero value + # non-zero key. We break out on first occurrence of non-zero value key_word = [0] * 7 for i in range(len(key_word)): key_word[i] = self.read_efuse(14 + i) diff --git a/esptool/targets/esp32c2.py b/esptool/targets/esp32c2.py index edfc3b1c0..3f59eb5d0 100644 --- a/esptool/targets/esp32c2.py +++ b/esptool/targets/esp32c2.py @@ -146,7 +146,7 @@ def is_flash_encryption_key_valid(self): # When chip has not generated AES/encryption key in BLOCK3, # the contents will be readable and 0. # If the flash encryption is enabled it is expected to have a valid - # non-zero key. We break out on first occurance of non-zero value + # non-zero key. We break out on first occurrence of non-zero value key_word = [0] * 7 if key_len_256 else [0] * 3 for i in range(len(key_word)): key_word[i] = self.read_reg(self.EFUSE_BLOCK_KEY0_REG + i * 4) diff --git a/flasher_stub/Makefile b/flasher_stub/Makefile index 63312020b..1d78f4d0c 100644 --- a/flasher_stub/Makefile +++ b/flasher_stub/Makefile @@ -31,7 +31,7 @@ -include local.mk # Prefix for each cross compiler (can include a directory path) -# These can be overriden via environment variables or on the make command line +# These can be overridden via environment variables or on the make command line CROSS_8266 ?= xtensa-lx106-elf- CROSS_32 ?= xtensa-esp32-elf- CROSS_32S2 ?= xtensa-esp32s2-elf- diff --git a/flasher_stub/include/miniz.h b/flasher_stub/include/miniz.h index 65e96640e..bf1554a06 100644 --- a/flasher_stub/include/miniz.h +++ b/flasher_stub/include/miniz.h @@ -618,7 +618,7 @@ enum /* flags: The max match finder probes (default is 128) logically OR'd against the above flags. Higher probes are slower but improve compression. */ /* On return: */ /* Function returns a pointer to the compressed data, or NULL on failure. */ -/* *pOut_len will be set to the compressed data's size, which could be larger than src_buf_len on uncompressible data. */ +/* *pOut_len will be set to the compressed data's size, which could be larger than src_buf_len on incompressible data. */ /* The caller must free() the returned block when it's no longer needed. */ void *tdefl_compress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags); @@ -786,7 +786,7 @@ enum /* pSrc_buf, src_buf_len: Pointer and size of the Deflate or zlib source data to decompress. */ /* On return: */ /* Function returns a pointer to the decompressed data, or NULL on failure. */ -/* *pOut_len will be set to the decompressed data's size, which could be larger than src_buf_len on uncompressible data. */ +/* *pOut_len will be set to the decompressed data's size, which could be larger than src_buf_len on incompressible data. */ /* The caller must call mz_free() on the returned block when it's no longer needed. */ void *tinfl_decompress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags); @@ -1310,7 +1310,7 @@ mz_bool mz_zip_writer_add_from_zip_reader(mz_zip_archive *pZip, mz_zip_archive * /* An archive must be manually finalized by calling this function for it to be valid. */ mz_bool mz_zip_writer_finalize_archive(mz_zip_archive *pZip); -/* Finalizes a heap archive, returning a poiner to the heap block and its size. */ +/* Finalizes a heap archive, returning a pointer to the heap block and its size. */ /* The heap block will be allocated using the mz_zip_archive's alloc/realloc callbacks. */ mz_bool mz_zip_writer_finalize_heap_archive(mz_zip_archive *pZip, void **ppBuf, size_t *pSize); diff --git a/flasher_stub/include/soc_support.h b/flasher_stub/include/soc_support.h index 38627368c..eed774bdc 100644 --- a/flasher_stub/include/soc_support.h +++ b/flasher_stub/include/soc_support.h @@ -358,7 +358,7 @@ #define DR_REG_INTERRUPT_MATRIX_BASE 0x500D6000 #define INTERRUPT_CORE0_USB_INTR_MAP_REG (DR_REG_INTERRUPT_MATRIX_BASE + 0x58) /* USB-JTAG-Serial, CORE0_USB_DEVICE_INT_MAP_REG */ -#define CLIC_EXT_INTR_NUM_OFFSET 16 /* For CLIC first 16 intrrupts are reserved as internal */ +#define CLIC_EXT_INTR_NUM_OFFSET 16 /* For CLIC first 16 interrupts are reserved as internal */ #define ETS_USB_INUM 17 /* arbitrary level 1 level interrupt */ #endif diff --git a/flasher_stub/stub_flasher.c b/flasher_stub/stub_flasher.c index 967bff5ec..445e42567 100644 --- a/flasher_stub/stub_flasher.c +++ b/flasher_stub/stub_flasher.c @@ -37,7 +37,7 @@ typedef struct { } uart_buf_t; static volatile uart_buf_t ub; -/* esptool protcol "checksum" is XOR of 0xef and each byte of +/* esptool protocol "checksum" is XOR of 0xef and each byte of data payload. */ static uint8_t calculate_checksum(uint8_t *buf, int length) { @@ -492,7 +492,7 @@ void stub_main() stub_io_init(&stub_handle_rx_byte); /* Configure default SPI flash functionality. - Can be overriden later by esptool.py. */ + Can be overridden later by esptool.py. */ #ifdef ESP8266 SelectSpiFunction(); spi_flash_attach(); diff --git a/test/elf2image/esp32-too-many-sections/Makefile b/test/elf2image/esp32-too-many-sections/Makefile index 33ae71c80..c724f907f 100644 --- a/test/elf2image/esp32-too-many-sections/Makefile +++ b/test/elf2image/esp32-too-many-sections/Makefile @@ -52,7 +52,7 @@ all: $(BIN) $(BIN): $(OBJ) $(CC) -o $@ $^ $(LDFLAGS) -# By default, make uses sh as script langage, use bash to generate the C file +# By default, make uses sh as script language, use bash to generate the C file $(SRC): SHELL:=$(BASH) $(SRC): @$(generate_c_code) diff --git a/test/images/ram_helloworld/source/Makefile b/test/images/ram_helloworld/source/Makefile index 2d7eca65a..672da257e 100644 --- a/test/images/ram_helloworld/source/Makefile +++ b/test/images/ram_helloworld/source/Makefile @@ -1,7 +1,7 @@ # Makefile to compile the helloworld app for esptool tests # Prefix for each cross compiler (can include a directory path) -# These can be overriden via environment variables or on the make command line +# These can be overridden via environment variables or on the make command line CROSS_8266 ?= xtensa-lx106-elf- CROSS_32 ?= xtensa-esp32-elf- CROSS_32S2 ?= xtensa-esp32s2-elf- diff --git a/test/test_espefuse.py b/test/test_espefuse.py index 04e259132..2f1a6a65e 100755 --- a/test/test_espefuse.py +++ b/test/test_espefuse.py @@ -522,7 +522,7 @@ def test_set_flash_voltage_off2(self): ) -@pytest.mark.skipif(arg_chip != "esp32c3", reason="Not necessary fo all chips") +@pytest.mark.skipif(arg_chip != "esp32c3", reason="Not necessary for all chips") class TestValueArgForBurnEfuseCommands(EfuseTestCase): def test_efuse_is_bool_given_none(self): self.espefuse_py("burn_efuse SECURE_BOOT_KEY_REVOKE0") @@ -998,7 +998,7 @@ def test_burn_key_512bit(self): reason="512 bit keys are only supported on ESP32-S2, S3, and P4", ) def test_burn_key_512bit_non_consecutive_blocks(self): - # Burn efuses seperately to test different kinds + # Burn efuses separately to test different kinds # of "key used" detection criteria self.espefuse_py( f"burn_key \ @@ -1779,7 +1779,7 @@ def test_2_secure_boot_v1(self): class TestExecuteScriptsCommands(EfuseTestCase): @classmethod def setup_class(self): - # Save the current working directory to be resotred later + # Save the current working directory to be restored later self.stored_dir = os.getcwd() @classmethod diff --git a/test/test_esptool.py b/test/test_esptool.py index 7b251ef9f..78cab4360 100755 --- a/test/test_esptool.py +++ b/test/test_esptool.py @@ -137,7 +137,7 @@ def run_esptool(self, args, baud=None, chip=None, port=None, preload=True): """ Run esptool with the specified arguments. --chip, --port and --baud are filled in automatically from the command line. - (These can be overriden with their respective params.) + (These can be overridden with their respective params.) Additional args passed in args parameter as a string. @@ -221,7 +221,7 @@ def run_esptool_error(self, args, baud=None): def setup_class(self): print() print(50 * "*") - # Save the current working directory to be resotred later + # Save the current working directory to be restored later self.stored_dir = os.getcwd() os.chdir(TEST_DIR) @@ -457,7 +457,7 @@ def test_last_bytes_of_32M_flash(self): image_size = 1024 offset = flash_size - image_size self.run_esptool("write_flash {} images/one_kb.bin".format(hex(offset))) - # Some of the functons cannot handle 32-bit addresses - i.e. addresses accessing + # Some of the functions cannot handle 32-bit addresses - i.e. addresses accessing # the higher 16MB will manipulate with the lower 16MB flash area. offset2 = offset & 0xFFFFFF self.run_esptool("write_flash {} images/one_kb_all_ef.bin".format(hex(offset2))) @@ -469,7 +469,7 @@ def test_last_bytes_of_32M_flash(self): def test_write_larger_area_to_32M_flash(self): offset = 18 * 1024 * 1024 self.run_esptool("write_flash {} images/one_mb.bin".format(hex(offset))) - # Some of the functons cannot handle 32-bit addresses - i.e. addresses accessing + # Some of the functions cannot handle 32-bit addresses - i.e. addresses accessing # the higher 16MB will manipulate with the lower 16MB flash area. offset2 = offset & 0xFFFFFF self.run_esptool("write_flash {} images/one_kb_all_ef.bin".format(hex(offset2))) @@ -1424,7 +1424,7 @@ def test_load_config_file(self): output = self.run_esptool("version") assert f"Loaded custom configuration from {config_file_path}" not in output - # Correct header, but options are unparseable + # Correct header, but options are unparsable faulty_config = "[esptool]\n" "connect_attempts = 5\n" "connect_attempts = 9\n" with self.ConfigFile(config_file_path, faulty_config): output = self.run_esptool("version") @@ -1435,10 +1435,12 @@ def test_load_config_file(self): ) # Correct header, unknown option (or a typo) - faulty_config = "[esptool]\n" "connect_attempts = 9\n" "timout = 2\n" "bits = 2" + faulty_config = ( + "[esptool]\n" "connect_attempts = 9\n" "timoout = 2\n" "bits = 2" + ) with self.ConfigFile(config_file_path, faulty_config): output = self.run_esptool("version") - assert "Ignoring unknown config file options: bits, timout" in output + assert "Ignoring unknown config file options: bits, timoout" in output # Test other config files (setup.cfg, tox.ini) are loaded config_file_path = os.path.join(os.getcwd(), "tox.ini") diff --git a/test/test_imagegen.py b/test/test_imagegen.py index 9756e3fc9..9ca354260 100755 --- a/test/test_imagegen.py +++ b/test/test_imagegen.py @@ -41,7 +41,7 @@ def segment_matches_section(segment, section): class BaseTestCase: @classmethod def setup_class(self): - # Save the current working directory to be resotred later + # Save the current working directory to be restored later self.stored_dir = os.getcwd() os.chdir(TEST_DIR) @@ -415,7 +415,7 @@ class TestELFSHA256(BaseTestCase): 0xffffffff, 0xffffffff, 0xffffffff, 0xffffffff, 0xffffffff}, }; - This leaves zeroes only for the fiels of SHA-256 and the test will fail + This leaves zeroes only for the fields of SHA-256 and the test will fail if the placement of zeroes are tested at the wrong place. 00000000: e907 0020 780f 0840 ee00 0000 0000 0000 ... x..@........ diff --git a/test/test_merge_bin.py b/test/test_merge_bin.py index 1369223fd..c4f97673b 100755 --- a/test/test_merge_bin.py +++ b/test/test_merge_bin.py @@ -247,7 +247,7 @@ def test_merge_bin2hex(self): data_len = int(b"0x" + line[1:3], 16) # : + len + addr + type + data + checksum assert len(line) == 1 + 2 + 4 + 2 + data_len * 2 + 2 - # last line is allways :00000001FF + # last line is always :00000001FF assert lines[-1] == b":00000001FF" # convert back and verify the result against the source bin file with tempfile.NamedTemporaryFile(suffix=".hex", delete=False) as hex: diff --git a/test/test_uf2_ids.py b/test/test_uf2_ids.py index f50a0e4ca..1919013f7 100644 --- a/test/test_uf2_ids.py +++ b/test/test_uf2_ids.py @@ -41,7 +41,7 @@ def test_check_uf2family_ids(uf2_json): def test_check_uf2(uf2_json): """Check if all non-beta chip definition has UF2 family id in esptool - and also in Miscrosoft repo + and also in Microsoft repo """ # remove beta chip definitions esptool_chips = set(