alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'bugfix/mkdfu_flash_parameters' into 'master'

Browse Source 
mkdfu.py: Support setting flash parameters

Closes IDF-4820

See merge request espressif/esp-idf!18269
This commit is contained in:
Roland Dobai 2022-05-28 03:22:10 +08:00
commit bdcb6715b5
5 changed files with 70 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
tools/cmake/dfu.cmake
View File

@ -29,6 +29,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)

67
tools/mkdfu.py
View File

@ -103,6 +103,26 @@ ESPRESSIF_VID = 12346
# This CRC32 gets added after DFUSUFFIX_STRUCT
DFUCRC_STRUCT = b'<I'
# Flash chip parameters file related things
FlashParamsData = namedtuple(
'FlashParamsData',
[
'ishspi',
'legacy',
'deviceId',
'chip_size',
'block_size',
'sector_size',
'page_size',
'status_mask',
],
)
FLASH_PARAMS_STRUCT = b'<IIIIIIII'
FLASH_PARAMS_FILE = 'flash_params.dat'
DFU_INFO_FLAG_PARAM = (1 << 2)
DFU_INFO_FLAG_NOERASE = (1 << 3)
DFU_INFO_FLAG_IGNORE_MD5 = (1 << 4)
def dfu_crc(data, crc=0): # type: (bytes, int) -> int
""" Calculate CRC32/JAMCRC of data, with an optional initial value """
@ -116,6 +136,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
@ -124,6 +155,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
@ -166,14 +220,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(),
)
@ -196,6 +250,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)
@ -228,6 +284,10 @@ def main(): # type: () -> None
write_parser.add_argument('files',
metavar='<address> <file>', help='Add <file> at <address>',
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()
@ -261,6 +321,7 @@ def main(): # type: () -> None
'files': files,
'pid': args.pid,
'part_size': args.part_size,
'flash_size': args.flash_size,
}
{'write': action_write

BIN
tools/test_mkdfu/1/dfu.bin
View File

Binary file not shown.

BIN
tools/test_mkdfu/2/dfu.bin
View File

Binary file not shown.

7
tools/test_mkdfu/test_mkdfu.py
View File

@ -34,7 +34,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:
@ -44,6 +45,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)))
@ -103,7 +106,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):