From d0e38f5a9fa847b664a9662a813151378ab63cee Mon Sep 17 00:00:00 2001 From: "radim.karnis" Date: Thu, 26 May 2022 16:07:54 +0200 Subject: [PATCH] mkdfu.py: Support setting flash parameters --- tools/cmake/dfu.cmake | 1 + tools/mkdfu.py | 67 +++++++++++++++++++++++++++++++-- tools/test_mkdfu/1/dfu.bin | Bin 10256 -> 10256 bytes tools/test_mkdfu/2/dfu.bin | Bin 10256 -> 10256 bytes tools/test_mkdfu/test_mkdfu.py | 7 +++- 5 files changed, 70 insertions(+), 5 deletions(-) diff --git a/tools/cmake/dfu.cmake b/tools/cmake/dfu.cmake index 45f7470e77..e1a13cd064 100644 --- a/tools/cmake/dfu.cmake +++ b/tools/cmake/dfu.cmake @@ -25,6 +25,7 @@ function(__add_dfu_targets) -o "${CMAKE_CURRENT_BINARY_DIR}/dfu.bin" --json "${CMAKE_CURRENT_BINARY_DIR}/flasher_args.json" --pid "${dfu_pid}" + --flash-size "${CONFIG_ESPTOOLPY_FLASHSIZE}" DEPENDS gen_project_binary bootloader VERBATIM USES_TERMINAL) diff --git a/tools/mkdfu.py b/tools/mkdfu.py index 980cf278ba..d643de1140 100755 --- a/tools/mkdfu.py +++ b/tools/mkdfu.py @@ -114,6 +114,26 @@ ESPRESSIF_VID = 12346 # This CRC32 gets added after DFUSUFFIX_STRUCT DFUCRC_STRUCT = b' int """ Calculate CRC32/JAMCRC of data, with an optional initial value """ @@ -127,6 +147,17 @@ def pad_bytes(b, multiple, padding=b'\x00'): # type: (bytes, int, bytes) -> byt return b + padding * (padded_len - len(b)) +def flash_size_bytes(size): # type: (str) -> int + """ + Given a flash size passed in args.flash_size + (ie 4MB), return the size in bytes. + """ + try: + return int(size.rstrip('MB'), 10) * 1024 * 1024 + except ValueError: + raise argparse.ArgumentTypeError('Unknown size {}'.format(size)) + + class EspDfuWriter(object): def __init__(self, dest_file, pid, part_size): # type: (typing.BinaryIO, int, int) -> None self.dest = dest_file @@ -135,6 +166,29 @@ class EspDfuWriter(object): self.entries = [] # type: typing.List[bytes] self.index = [] # type: typing.List[DFUInfo] + def add_flash_params_file(self, flash_size): # type: (str) -> None + """ + Add a file containing flash chip parameters + + Corresponds to the "flashchip" data structure that the ROM + has in RAM. + + See flash_set_parameters() in esptool.py for more info + """ + flash_params = FlashParamsData( + ishspi=0, + legacy=0, + deviceId=0, # ignored + chip_size=flash_size_bytes(flash_size), # flash size in bytes + block_size=64 * 1024, + sector_size=4 * 1024, + page_size=256, + status_mask=0xffff, + ) + data = struct.pack(FLASH_PARAMS_STRUCT, *flash_params) + flags = DFU_INFO_FLAG_PARAM | DFU_INFO_FLAG_NOERASE | DFU_INFO_FLAG_IGNORE_MD5 + self._add_cpio_flash_entry(FLASH_PARAMS_FILE, 0, data, flags) + def add_file(self, flash_addr, path): # type: (int, str) -> None """ Add file to be written into flash at given address @@ -177,14 +231,14 @@ class EspDfuWriter(object): self.dest.write(out_data) def _add_cpio_flash_entry( - self, filename, flash_addr, data - ): # type: (str, int, bytes) -> None + self, filename, flash_addr, data, flags=0 + ): # type: (str, int, bytes, int) -> None md5 = hashlib.md5() md5.update(data) self.index.append( DFUInfo( address=flash_addr, - flags=0, + flags=flags, name=filename.encode('utf-8'), md5=md5.digest(), ) @@ -207,6 +261,8 @@ class EspDfuWriter(object): def action_write(args): # type: (typing.Mapping[str, typing.Any]) -> None writer = EspDfuWriter(args['output_file'], args['pid'], args['part_size']) + print('Adding flash chip parameters file with flash_size = {}'.format(args['flash_size'])) + writer.add_flash_params_file(args['flash_size']) for addr, f in args['files']: print('Adding {} at {:#x}'.format(f, addr)) writer.add_file(addr, f) @@ -239,6 +295,10 @@ def main(): write_parser.add_argument('files', metavar='
', help='Add at
', nargs='*') + write_parser.add_argument('-fs', '--flash-size', + help='SPI Flash size in MegaBytes (1MB, 2MB, 4MB, 8MB, 16MB, 32MB, 64MB, 128MB)', + choices=['1MB', '2MB', '4MB', '8MB', '16MB', '32MB', '64MB', '128MB'], + default='2MB') args = parser.parse_args() @@ -272,6 +332,7 @@ def main(): 'files': files, 'pid': args.pid, 'part_size': args.part_size, + 'flash_size': args.flash_size, } {'write': action_write diff --git a/tools/test_mkdfu/1/dfu.bin b/tools/test_mkdfu/1/dfu.bin index cc28754f382510ff037315c285e00f82388e353e..9c306c7229c21777841ef505372ff582480908d7 100644 GIT binary patch delta 146 zcmbObFd<-q4WrrQgNzyzQzgV17#L(27#PxW5{on93lfVGbBpy-5=$mdG!U4=X2Fzy zGlT8Snx4p69)dj^Yn&OG42&ipWK_2?G&Fz$be#-nz=45*fsuhh07Cu$&%iLjdh>op PPt{2pJSVz`T J%btp*!2l0zCs+Ug delta 54 zcmbObFd<;_0wx>Aq{)HI8WU5c*%=rZ7?LvcCNE^Roh-w+Wbz#*&CQ)m<*Ji6F#njO L!NYP$TuTN3*=-S6 diff --git a/tools/test_mkdfu/test_mkdfu.py b/tools/test_mkdfu/test_mkdfu.py index 0646148518..40bf04a4cc 100755 --- a/tools/test_mkdfu/test_mkdfu.py +++ b/tools/test_mkdfu/test_mkdfu.py @@ -45,7 +45,8 @@ class TestMkDFU(unittest.TestCase): self.addCleanup(os.unlink, f_out.name) args = [mkdfu_path, 'write', '-o', f_out.name, - '--pid', '2'] + '--pid', '2', + '--flash-size', '4MB'] if part_size: args += ['--part-size', str(part_size)] if json_input: @@ -55,6 +56,8 @@ class TestMkDFU(unittest.TestCase): p = pexpect.spawn(sys.executable, args, timeout=10, encoding='utf-8') self.addCleanup(p.terminate, force=True) + p.expect_exact('Adding flash chip parameters file with flash_size = 4MB') + for addr, f_path in sorted(file_args, key=lambda e: e[0]): p.expect_exact('Adding {} at {}'.format(f_path, hex(addr))) @@ -114,7 +117,7 @@ class TestSplit(TestMkDFU): tests with images prepared in the "2" subdirectory "2/dfu.bin" was prepared with: - mkdfu.py write --part-size 5 --pid 2 -o 2/dfu.bin 0 bin + mkdfu.py write --part-size 5 --pid 2 --flash-size 4MB -o 2/dfu.bin 0 bin where the content of "bin" is b"\xce" * 10 ''' def test_split(self):