1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
from __future__ import annotations
import sys
import asyncio
import logging
if sys.version_info[:2] < (3, 11):
from async_timeout import timeout as asyncio_timeout # pragma: no cover
else:
from asyncio import timeout as asyncio_timeout # pragma: no cover
import zigpy_znp.types as t
import zigpy_znp.commands as c
from zigpy_znp.api import ZNP
from zigpy_znp.config import CONFIG_SCHEMA
from zigpy_znp.tools.common import ClosableFileType, setup_parser
from zigpy_znp.tools.nvram_reset import nvram_reset
LOGGER = logging.getLogger(__name__)
def compute_crc16(data: bytes) -> int:
poly = 0x1021
crc = 0x0000
for byte in data:
for _ in range(8):
msb = 1 if (crc & 0x8000) else 0
crc <<= 1
crc &= 0xFFFF
if byte & 0x80:
crc |= 0x0001
if msb:
crc ^= poly
byte <<= 1
return crc
def get_firmware_crcs(firmware: bytes) -> tuple[int, int]:
# There is room for *two* CRCs in the firmware file: the expected and the computed
firmware_without_crcs = (
firmware[: c.ubl.IMAGE_CRC_OFFSET]
+ firmware[c.ubl.IMAGE_CRC_OFFSET + 4 :]
+ b"\x00\x00"
)
# We only use the first one. The second one is written by the bootloader into flash.
real_crc = int.from_bytes(
firmware[c.ubl.IMAGE_CRC_OFFSET : c.ubl.IMAGE_CRC_OFFSET + 2], "little"
)
return real_crc, compute_crc16(firmware_without_crcs)
async def write_firmware(znp: ZNP, firmware: bytes, reset_nvram: bool):
if len(firmware) != c.ubl.IMAGE_SIZE:
raise ValueError(
f"Firmware is the wrong size."
f" Expected {c.ubl.IMAGE_SIZE}, got {len(firmware)}"
)
expected_crc, computed_crc = get_firmware_crcs(firmware)
if expected_crc != computed_crc:
raise ValueError(
f"Firmware CRC is incorrect."
f" Expected 0x{expected_crc:04X}, got 0x{computed_crc:04X}"
)
try:
async with asyncio_timeout(5):
handshake_rsp = await znp.request_callback_rsp(
request=c.UBL.HandshakeReq.Req(),
callback=c.UBL.HandshakeRsp.Callback(partial=True),
)
except asyncio.TimeoutError:
raise RuntimeError(
"Did not receive a bootloader handshake response!"
" Make sure your adapter has just been plugged in and"
" nothing else has had a chance to communicate with it. Alternatively, "
" press the button furthest from the USB port. The LED should turn red."
)
if handshake_rsp.Status != c.ubl.BootloaderStatus.SUCCESS:
raise RuntimeError(f"Bad bootloader handshake response: {handshake_rsp}")
# All reads and writes are this size
buffer_size = handshake_rsp.BufferSize
for offset in range(0, c.ubl.IMAGE_SIZE, buffer_size):
address = offset // c.ubl.FLASH_WORD_SIZE
LOGGER.info("Write progress: %0.2f%%", (100.0 * offset) / c.ubl.IMAGE_SIZE)
write_rsp = await znp.request_callback_rsp(
request=c.UBL.WriteReq.Req(
FlashWordAddr=address,
Data=t.TrailingBytes(firmware[offset : offset + buffer_size]),
),
callback=c.UBL.WriteRsp.Callback(partial=True),
)
assert write_rsp.Status == c.ubl.BootloaderStatus.SUCCESS
# Now we have to read it all back
for offset in range(0, c.ubl.IMAGE_SIZE, buffer_size):
address = offset // c.ubl.FLASH_WORD_SIZE
LOGGER.info(
"Verification progress: %0.2f%%", (100.0 * offset) / c.ubl.IMAGE_SIZE
)
read_rsp = await znp.request_callback_rsp(
request=c.UBL.ReadReq.Req(
FlashWordAddr=address,
),
callback=c.UBL.ReadRsp.Callback(partial=True),
)
assert read_rsp.Status == c.ubl.BootloaderStatus.SUCCESS
assert read_rsp.FlashWordAddr == address
assert read_rsp.Data == firmware[offset : offset + buffer_size]
# This seems to cause the bootloader to compute and verify the CRC
enable_rsp = await znp.request_callback_rsp(
request=c.UBL.EnableReq.Req(),
callback=c.UBL.EnableRsp.Callback(partial=True),
)
assert enable_rsp.Status == c.ubl.BootloaderStatus.SUCCESS
if reset_nvram:
LOGGER.info("Success! Waiting for a few seconds to leave the bootloader...")
await asyncio.sleep(5)
await nvram_reset(znp)
else:
LOGGER.info("Unplug your adapter to leave bootloader mode!")
async def main(argv):
parser = setup_parser("Write firmware to a radio")
parser.add_argument(
"--input",
"-i",
type=ClosableFileType("rb"),
help="Input .bin file",
required=True,
)
parser.add_argument(
"--reset",
"-r",
action="store_true",
help="Resets the device's NVRAM after upgrade",
default=False,
)
args = parser.parse_args(argv)
with args.input as f:
firmware = f.read()
znp = ZNP(
CONFIG_SCHEMA(
{"znp_config": {"skip_bootloader": False}, "device": {"path": args.serial}}
)
)
# The bootloader handshake must be the very first command
await znp.connect(test_port=False)
await write_firmware(znp=znp, firmware=firmware, reset_nvram=args.reset)
await znp.disconnect()
if __name__ == "__main__":
asyncio.run(main(sys.argv[1:])) # pragma: no cover
|
