blob: a11284fe95e7315438444337c37798cc4a464c73 [file] [log] [blame]
Christopher Collins92ea77f2016-12-12 15:59:26 -08001/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19#include <assert.h>
20#include <stddef.h>
21#include <inttypes.h>
22#include <ctype.h>
23#include <stdio.h>
24
25#include "sysflash/sysflash.h"
26
Fabio Utzig1a2e41a2017-11-17 12:13:09 -020027#include "bootutil/bootutil_log.h"
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +010028#include "cbor_encode.h"
Fabio Utzig1a2e41a2017-11-17 12:13:09 -020029
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020030#ifdef __ZEPHYR__
Dominik Ermel1eedec32021-12-16 12:55:02 +000031#include <sys/reboot.h>
Andrzej Puzdrowskif1d189c2019-12-12 09:34:11 +010032#include <sys/byteorder.h>
33#include <sys/__assert.h>
Peter Bigot54c1e3f2020-01-25 05:50:12 -060034#include <drivers/flash.h>
Andrzej Puzdrowskif1d189c2019-12-12 09:34:11 +010035#include <sys/crc.h>
36#include <sys/base64.h>
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020037#else
Christopher Collins92ea77f2016-12-12 15:59:26 -080038#include <bsp/bsp.h>
Christopher Collins92ea77f2016-12-12 15:59:26 -080039#include <hal/hal_system.h>
Christopher Collins92ea77f2016-12-12 15:59:26 -080040#include <os/endian.h>
Christopher Collins92ea77f2016-12-12 15:59:26 -080041#include <os/os_cputime.h>
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020042#include <crc/crc16.h>
43#include <base64/base64.h>
Andrzej Puzdrowski386b5922018-04-06 19:26:24 +020044#endif /* __ZEPHYR__ */
45
Andrzej Puzdrowskib788c712018-04-12 12:42:49 +020046#include <flash_map_backend/flash_map_backend.h>
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020047#include <hal/hal_flash.h>
48#include <os/os.h>
49#include <os/os_malloc.h>
Christopher Collins92ea77f2016-12-12 15:59:26 -080050
51#include <bootutil/image.h>
Andrzej Puzdrowskif48de7a2020-10-19 09:42:02 +020052#include <bootutil/bootutil.h>
Christopher Collins92ea77f2016-12-12 15:59:26 -080053
54#include "boot_serial/boot_serial.h"
55#include "boot_serial_priv.h"
56
Dominik Ermel3d4e55d2021-07-09 11:14:10 +000057#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +020058#include "bootutil_priv.h"
59#endif
60
Wouter Cappelle953a7612021-05-03 16:53:05 +020061#ifdef MCUBOOT_ENC_IMAGES
62#include "single_loader.h"
63#endif
64
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +010065#include "serial_recovery_cbor.h"
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +020066#include "bootutil/boot_hooks.h"
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +010067
Carlos Falgueras Garcíaa4b4b0f2021-06-22 10:00:22 +020068BOOT_LOG_MODULE_DECLARE(mcuboot);
Emanuele Di Santo9f1933d2018-11-20 10:59:59 +010069
Marko Kiiskila149b4572018-06-06 14:18:54 +030070#define BOOT_SERIAL_INPUT_MAX 512
Andrzej Puzdrowskic9ac5cc2021-11-19 11:58:05 +010071#define BOOT_SERIAL_OUT_MAX (128 * BOOT_IMAGE_NUMBER)
Christopher Collins92ea77f2016-12-12 15:59:26 -080072
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020073#ifdef __ZEPHYR__
Carles Cufi0165be82018-03-26 17:43:51 +020074/* base64 lib encodes data to null-terminated string */
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020075#define BASE64_ENCODE_SIZE(in_size) ((((((in_size) - 1) / 3) * 4) + 4) + 1)
76
77#define CRC16_INITIAL_CRC 0 /* what to seed crc16 with */
78#define CRC_CITT_POLYMINAL 0x1021
79
80#define ntohs(x) sys_be16_to_cpu(x)
81#define htons(x) sys_cpu_to_be16(x)
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020082#endif
Emanuele Di Santo9f1933d2018-11-20 10:59:59 +010083
Fabio Utzig6f49c272019-08-23 11:42:58 -030084#if (BOOT_IMAGE_NUMBER > 1)
85#define IMAGES_ITER(x) for ((x) = 0; (x) < BOOT_IMAGE_NUMBER; ++(x))
86#else
87#define IMAGES_ITER(x)
88#endif
89
Marko Kiiskila149b4572018-06-06 14:18:54 +030090static char in_buf[BOOT_SERIAL_INPUT_MAX + 1];
91static char dec_buf[BOOT_SERIAL_INPUT_MAX + 1];
Marko Kiiskila8b1ce3a2018-06-14 13:20:46 -070092const struct boot_uart_funcs *boot_uf;
Christopher Collins92ea77f2016-12-12 15:59:26 -080093static uint32_t curr_off;
94static uint32_t img_size;
95static struct nmgr_hdr *bs_hdr;
Wouter Cappellee3822f82022-01-19 15:39:43 +010096static bool bs_entry;
Christopher Collins92ea77f2016-12-12 15:59:26 -080097
98static char bs_obuf[BOOT_SERIAL_OUT_MAX];
99
Christopher Collins92ea77f2016-12-12 15:59:26 -0800100static void boot_serial_output(void);
101
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100102static cbor_state_backups_t dummy_backups;
103static cbor_state_t cbor_state = {
104 .backups = &dummy_backups
Christopher Collins92ea77f2016-12-12 15:59:26 -0800105};
Christopher Collins92ea77f2016-12-12 15:59:26 -0800106
Dominik Ermel4c0f6c12022-03-04 15:47:37 +0000107void reset_cbor_state(void)
108{
109 cbor_state.payload_mut = (uint8_t *)bs_obuf;
110 cbor_state.payload_end = (const uint8_t *)bs_obuf
111 + sizeof(bs_obuf);
112 cbor_state.elem_count = 0;
113}
114
Dominik Ermel3d51e432021-06-25 17:29:50 +0000115/**
Dominik Ermelbd69c3d2021-07-28 11:27:31 +0000116 * Function that processes MGMT_GROUP_ID_PERUSER mcumgr group and may be
117 * used to process any groups that have not been processed by generic boot
118 * serial implementation.
Dominik Ermel3d51e432021-06-25 17:29:50 +0000119 *
120 * @param[in] hdr -- the decoded header of mcumgr message;
121 * @param[in] buffer -- buffer with first mcumgr message;
122 * @param[in] len -- length of of data in buffer;
123 * @param[out] *cs -- object with encoded response.
124 *
125 * @return 0 on success; non-0 error code otherwise.
126 */
127extern int bs_peruser_system_specific(const struct nmgr_hdr *hdr,
128 const char *buffer,
129 int len, cbor_state_t *cs);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800130
131/*
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300132 * Convert version into string without use of snprintf().
Christopher Collins92ea77f2016-12-12 15:59:26 -0800133 */
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300134static int
135u32toa(char *tgt, uint32_t val)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800136{
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300137 char *dst;
138 uint32_t d = 1;
139 uint32_t dgt;
140 int n = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800141
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300142 dst = tgt;
143 while (val / d >= 10) {
144 d *= 10;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800145 }
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300146 while (d) {
147 dgt = val / d;
148 val %= d;
149 d /= 10;
150 if (n || dgt > 0 || d == 0) {
151 *dst++ = dgt + '0';
152 ++n;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800153 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800154 }
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300155 *dst = '\0';
156
157 return dst - tgt;
158}
159
160/*
161 * dst has to be able to fit "255.255.65535.4294967295" (25 characters).
162 */
163static void
164bs_list_img_ver(char *dst, int maxlen, struct image_version *ver)
165{
166 int off;
167
168 off = u32toa(dst, ver->iv_major);
169 dst[off++] = '.';
170 off += u32toa(dst + off, ver->iv_minor);
171 dst[off++] = '.';
172 off += u32toa(dst + off, ver->iv_revision);
173 dst[off++] = '.';
174 off += u32toa(dst + off, ver->iv_build_num);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800175}
176
177/*
178 * List images.
179 */
180static void
181bs_list(char *buf, int len)
182{
Christopher Collins92ea77f2016-12-12 15:59:26 -0800183 struct image_header hdr;
184 uint8_t tmpbuf[64];
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100185 uint32_t slot, area_id;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800186 const struct flash_area *fap;
Fabio Utzig6f49c272019-08-23 11:42:58 -0300187 uint8_t image_index;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800188
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100189 map_start_encode(&cbor_state, 1);
190 tstrx_put(&cbor_state, "images");
191 list_start_encode(&cbor_state, 5);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300192 image_index = 0;
193 IMAGES_ITER(image_index) {
194 for (slot = 0; slot < 2; slot++) {
195 area_id = flash_area_id_from_multi_image_slot(image_index, slot);
196 if (flash_area_open(area_id, &fap)) {
197 continue;
198 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800199
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200200 int rc = BOOT_HOOK_CALL(boot_read_image_header_hook,
201 BOOT_HOOK_REGULAR, image_index, slot, &hdr);
202 if (rc == BOOT_HOOK_REGULAR)
203 {
204 flash_area_read(fap, 0, &hdr, sizeof(hdr));
205 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800206
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200207 fih_int fih_rc = FIH_FAILURE;
208
209 if (hdr.ih_magic == IMAGE_MAGIC)
210 {
211 BOOT_HOOK_CALL_FIH(boot_image_check_hook,
212 fih_int_encode(BOOT_HOOK_REGULAR),
213 fih_rc, image_index, slot);
214 if (fih_eq(fih_rc, BOOT_HOOK_REGULAR))
215 {
Wouter Cappelle953a7612021-05-03 16:53:05 +0200216#ifdef MCUBOOT_ENC_IMAGES
217 if (slot == 0 && IS_ENCRYPTED(&hdr)) {
218 /* Clear the encrypted flag we didn't supply a key
219 * This flag could be set if there was a decryption in place
220 * performed before. We will try to validate the image without
221 * decryption by clearing the flag in the heder. If
222 * still encrypted the validation will fail.
223 */
224 hdr.ih_flags &= ~(ENCRYPTIONFLAGS);
225 }
226#endif
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200227 FIH_CALL(bootutil_img_validate, fih_rc, NULL, 0, &hdr, fap, tmpbuf, sizeof(tmpbuf),
228 NULL, 0, NULL);
229 }
230 }
231
232 flash_area_close(fap);
233
234 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
Fabio Utzig6f49c272019-08-23 11:42:58 -0300235 continue;
236 }
Fabio Utzig6f49c272019-08-23 11:42:58 -0300237
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100238 map_start_encode(&cbor_state, 20);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300239
240#if (BOOT_IMAGE_NUMBER > 1)
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100241 tstrx_put(&cbor_state, "image");
242 uintx32_put(&cbor_state, image_index);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300243#endif
244
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100245 tstrx_put(&cbor_state, "slot");
246 uintx32_put(&cbor_state, slot);
247 tstrx_put(&cbor_state, "version");
Fabio Utzig6f49c272019-08-23 11:42:58 -0300248
249 bs_list_img_ver((char *)tmpbuf, sizeof(tmpbuf), &hdr.ih_ver);
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100250 tstrx_put_term(&cbor_state, (char *)tmpbuf);
251 map_end_encode(&cbor_state, 20);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800252 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800253 }
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100254 list_end_encode(&cbor_state, 5);
255 map_end_encode(&cbor_state, 1);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800256 boot_serial_output();
257}
258
259/*
260 * Image upload request.
261 */
262static void
263bs_upload(char *buf, int len)
264{
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100265 const uint8_t *img_data = NULL;
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100266 long long int off = UINT64_MAX;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800267 size_t img_blen = 0;
Fabio Utzig30f6b2a2018-03-29 16:18:53 -0300268 uint8_t rem_bytes;
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100269 long long int data_len = UINT64_MAX;
Fabio Utzig6f49c272019-08-23 11:42:58 -0300270 int img_num;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300271 size_t slen;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800272 const struct flash_area *fap = NULL;
273 int rc;
Dominik Ermel3d4e55d2021-07-09 11:14:10 +0000274#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200275 static off_t off_last = -1;
276 struct flash_sector sector;
277#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800278
Fabio Utzig6f49c272019-08-23 11:42:58 -0300279 img_num = 0;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300280
281 /*
282 * Expected data format.
283 * {
Fabio Utzig6f49c272019-08-23 11:42:58 -0300284 * "image":<image number in a multi-image set (OPTIONAL)>
285 * "data":<image data>
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300286 * "len":<image len>
287 * "off":<current offset of image data>
288 * }
289 */
290
Øyvind Rønningstad212a35b2021-05-07 21:06:48 +0200291 struct Upload upload;
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100292 uint32_t decoded_len;
Øyvind Rønningstad212a35b2021-05-07 21:06:48 +0200293 bool result = cbor_decode_Upload((const uint8_t *)buf, len, &upload, &decoded_len);
294
295 if (!result || (len != decoded_len)) {
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100296 goto out_invalid_data;
297 }
Dominik Ermel470e2f32020-01-10 13:28:48 +0000298
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100299 for (int i = 0; i < upload._Upload_members_count; i++) {
Øyvind Rønningstad212a35b2021-05-07 21:06:48 +0200300 struct Member_ *member = &upload._Upload_members[i];
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100301 switch(member->_Member_choice) {
302 case _Member_image:
303 img_num = member->_Member_image;
304 break;
305 case _Member_data:
306 img_data = member->_Member_data.value;
307 slen = member->_Member_data.len;
308 img_blen = slen;
309 break;
310 case _Member_len:
311 data_len = member->_Member_len;
312 break;
313 case _Member_off:
314 off = member->_Member_off;
315 break;
316 case _Member_sha:
317 default:
318 /* Nothing to do. */
319 break;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300320 }
321 }
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100322
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100323 if (off == UINT64_MAX || img_data == NULL) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300324 /*
325 * Offset must be set in every block.
326 */
327 goto out_invalid_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800328 }
329
Dominik Ermel48decca2021-07-09 10:23:58 +0000330#if !defined(MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD)
Fabio Utzig6f49c272019-08-23 11:42:58 -0300331 rc = flash_area_open(flash_area_id_from_multi_image_slot(img_num, 0), &fap);
Dominik Ermel48decca2021-07-09 10:23:58 +0000332#else
333 rc = flash_area_open(flash_area_id_from_direct_image(img_num), &fap);
334#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800335 if (rc) {
336 rc = MGMT_ERR_EINVAL;
337 goto out;
338 }
339
340 if (off == 0) {
341 curr_off = 0;
Dominik Ermel260ae092021-04-23 05:38:45 +0000342 if (data_len > flash_area_get_size(fap)) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300343 goto out_invalid_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800344 }
Wouter Cappellebb7a39d2021-05-03 16:44:44 +0200345#if defined(MCUBOOT_VALIDATE_PRIMARY_SLOT_ONCE)
346 /* We are using swap state at end of flash area to store validation
347 * result. Make sure the user cannot write it from an image to skip validation.
348 */
349 if (data_len > (flash_area_get_size(fap) - BOOT_MAGIC_SZ)) {
350 goto out_invalid_data;
351 }
352#endif
Dominik Ermel3d4e55d2021-07-09 11:14:10 +0000353#ifndef MCUBOOT_ERASE_PROGRESSIVELY
Dominik Ermel260ae092021-04-23 05:38:45 +0000354 rc = flash_area_erase(fap, 0, flash_area_get_size(fap));
Christopher Collins92ea77f2016-12-12 15:59:26 -0800355 if (rc) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300356 goto out_invalid_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800357 }
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200358#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800359 img_size = data_len;
360 }
361 if (off != curr_off) {
362 rc = 0;
363 goto out;
364 }
Andrzej Puzdrowskif48de7a2020-10-19 09:42:02 +0200365
366 if (curr_off + img_blen > img_size) {
367 rc = MGMT_ERR_EINVAL;
368 goto out;
369 }
370
371 rem_bytes = img_blen % flash_area_align(fap);
372
373 if ((curr_off + img_blen < img_size) && rem_bytes) {
374 img_blen -= rem_bytes;
375 rem_bytes = 0;
Fabio Utzig30f6b2a2018-03-29 16:18:53 -0300376 }
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200377
Dominik Ermel3d4e55d2021-07-09 11:14:10 +0000378#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200379 rc = flash_area_sector_from_off(curr_off + img_blen, &sector);
380 if (rc) {
381 BOOT_LOG_ERR("Unable to determine flash sector size");
382 goto out;
383 }
Dominik Ermel260ae092021-04-23 05:38:45 +0000384 if (off_last != flash_sector_get_off(&sector)) {
385 off_last = flash_sector_get_off(&sector);
386 BOOT_LOG_INF("Erasing sector at offset 0x%x", flash_sector_get_off(&sector));
387 rc = flash_area_erase(fap, flash_sector_get_off(&sector),
388 flash_sector_get_size(&sector));
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200389 if (rc) {
390 BOOT_LOG_ERR("Error %d while erasing sector", rc);
391 goto out;
392 }
393 }
394#endif
395
396 BOOT_LOG_INF("Writing at 0x%x until 0x%x", curr_off, curr_off + img_blen);
Andrzej Puzdrowskif48de7a2020-10-19 09:42:02 +0200397 if (rem_bytes) {
398 /* the last chunk of the image might be unaligned */
399 uint8_t wbs_aligned[BOOT_MAX_ALIGN];
400 size_t w_size = img_blen - rem_bytes;
401
402 if (w_size) {
403 rc = flash_area_write(fap, curr_off, img_data, w_size);
404 if (rc) {
405 goto out_invalid_data;
406 }
407 curr_off += w_size;
408 img_blen -= w_size;
409 img_data += w_size;
410 }
411
412 if (img_blen) {
413 memcpy(wbs_aligned, img_data, rem_bytes);
414 memset(wbs_aligned + rem_bytes, flash_area_erased_val(fap),
415 sizeof(wbs_aligned) - rem_bytes);
416 rc = flash_area_write(fap, curr_off, wbs_aligned, flash_area_align(fap));
417 }
418
419 } else {
420 rc = flash_area_write(fap, curr_off, img_data, img_blen);
421 }
422
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300423 if (rc == 0) {
424 curr_off += img_blen;
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200425 if (curr_off == img_size) {
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200426#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200427 /* get the last sector offset */
428 rc = flash_area_sector_from_off(boot_status_off(fap), &sector);
429 if (rc) {
430 BOOT_LOG_ERR("Unable to determine flash sector of"
431 "the image trailer");
432 goto out;
433 }
434 /* Assure that sector for image trailer was erased. */
435 /* Check whether it was erased during previous upload. */
Dominik Ermel260ae092021-04-23 05:38:45 +0000436 if (off_last < flash_sector_get_off(&sector)) {
437 BOOT_LOG_INF("Erasing sector at offset 0x%x",
438 flash_sector_get_off(&sector));
439 rc = flash_area_erase(fap, flash_sector_get_off(&sector),
440 flash_sector_get_size(&sector));
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200441 if (rc) {
442 BOOT_LOG_ERR("Error %d while erasing sector", rc);
443 goto out;
444 }
445 }
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200446#endif
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200447 rc = BOOT_HOOK_CALL(boot_serial_uploaded_hook, 0, img_num, fap,
448 img_size);
449 if (rc) {
450 BOOT_LOG_ERR("Error %d post upload hook", rc);
451 goto out;
452 }
453 }
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300454 } else {
455 out_invalid_data:
Christopher Collins92ea77f2016-12-12 15:59:26 -0800456 rc = MGMT_ERR_EINVAL;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800457 }
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200458
Christopher Collins92ea77f2016-12-12 15:59:26 -0800459out:
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200460 BOOT_LOG_INF("RX: 0x%x", rc);
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100461 map_start_encode(&cbor_state, 10);
462 tstrx_put(&cbor_state, "rc");
463 uintx32_put(&cbor_state, rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800464 if (rc == 0) {
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100465 tstrx_put(&cbor_state, "off");
466 uintx32_put(&cbor_state, curr_off);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800467 }
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100468 map_end_encode(&cbor_state, 10);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800469
470 boot_serial_output();
471 flash_area_close(fap);
Wouter Cappelle953a7612021-05-03 16:53:05 +0200472
473#ifdef MCUBOOT_ENC_IMAGES
474 if (curr_off == img_size) {
475 /* Last sector received, now start a decryption on the image if it is encrypted*/
476 rc = boot_handle_enc_fw();
477 }
478#endif //#ifdef MCUBOOT_ENC_IMAGES
Christopher Collins92ea77f2016-12-12 15:59:26 -0800479}
480
Dominik Ermel4c0f6c12022-03-04 15:47:37 +0000481/*
482 * Send rc code only.
483 */
484static void
485bs_rc_rsp(int rc_code)
486{
487 map_start_encode(&cbor_state, 10);
488 tstrx_put(&cbor_state, "rc");
489 uintx32_put(&cbor_state, rc_code);
490 map_end_encode(&cbor_state, 10);
491 boot_serial_output();
492}
493
494
Wouter Cappellee3ff1752021-05-03 16:36:22 +0200495#ifdef MCUBOOT_BOOT_MGMT_ECHO
496static bool
497decode_echo(cbor_state_t *state, cbor_string_type_t *result)
498{
499 size_t bsstrdecoded;
500 int ret;
501
502 if (!map_start_decode(state)) {
503 return false;
504 }
505 ret = multi_decode(2, 2, &bsstrdecoded, (void *)tstrx_decode, state, result, sizeof(cbor_string_type_t));
506 map_end_decode(state);
507 return ret;
508}
509
510
511static void
512bs_echo(char *buf, int len)
513{
514 size_t bsstrdecoded;
515 cbor_string_type_t str[2];
516
517 if (entry_function((const uint8_t *)buf, len, str, &bsstrdecoded, (void *)decode_echo, 1, 2)) {
518 map_start_encode(&cbor_state, 10);
519 tstrx_put(&cbor_state, "r");
Dominik Ermel4c0f6c12022-03-04 15:47:37 +0000520 if (tstrx_encode(&cbor_state, &str[1]) && map_end_encode(&cbor_state, 10)) {
521 boot_serial_output();
522 } else {
523 reset_cbor_state();
524 bs_rc_rsp(MGMT_ERR_ENOMEM);
525 }
Wouter Cappellee3ff1752021-05-03 16:36:22 +0200526 }
527}
528#endif
529
Christopher Collins92ea77f2016-12-12 15:59:26 -0800530/*
Christopher Collins92ea77f2016-12-12 15:59:26 -0800531 * Reset, and (presumably) boot to newly uploaded image. Flush console
532 * before restarting.
533 */
Andrzej Puzdrowski268cdd02018-04-10 12:57:54 +0200534static void
Christopher Collins92ea77f2016-12-12 15:59:26 -0800535bs_reset(char *buf, int len)
536{
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000537 bs_rc_rsp(0);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800538
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200539#ifdef __ZEPHYR__
Andrzej Puzdrowski0cf0dbd2021-05-14 11:55:57 +0200540#ifdef CONFIG_MULTITHREADING
Carles Cufi7e7b4ad2020-03-30 19:12:02 +0200541 k_sleep(K_MSEC(250));
Andrzej Puzdrowski0cf0dbd2021-05-14 11:55:57 +0200542#else
543 k_busy_wait(250000);
544#endif
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200545 sys_reboot(SYS_REBOOT_COLD);
546#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800547 os_cputime_delay_usecs(250000);
548 hal_system_reset();
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200549#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800550}
551
552/*
553 * Parse incoming line of input from console.
554 * Expect newtmgr protocol with serial transport.
555 */
556void
557boot_serial_input(char *buf, int len)
558{
559 struct nmgr_hdr *hdr;
560
561 hdr = (struct nmgr_hdr *)buf;
562 if (len < sizeof(*hdr) ||
563 (hdr->nh_op != NMGR_OP_READ && hdr->nh_op != NMGR_OP_WRITE) ||
564 (ntohs(hdr->nh_len) < len - sizeof(*hdr))) {
565 return;
566 }
567 bs_hdr = hdr;
568 hdr->nh_group = ntohs(hdr->nh_group);
569
570 buf += sizeof(*hdr);
571 len -= sizeof(*hdr);
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300572
Dominik Ermel4c0f6c12022-03-04 15:47:37 +0000573 reset_cbor_state();
Christopher Collins92ea77f2016-12-12 15:59:26 -0800574
575 /*
576 * Limited support for commands.
577 */
578 if (hdr->nh_group == MGMT_GROUP_ID_IMAGE) {
579 switch (hdr->nh_id) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300580 case IMGMGR_NMGR_ID_STATE:
Christopher Collins92ea77f2016-12-12 15:59:26 -0800581 bs_list(buf, len);
582 break;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300583 case IMGMGR_NMGR_ID_UPLOAD:
Christopher Collins92ea77f2016-12-12 15:59:26 -0800584 bs_upload(buf, len);
585 break;
586 default:
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000587 bs_rc_rsp(MGMT_ERR_ENOTSUP);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800588 break;
589 }
590 } else if (hdr->nh_group == MGMT_GROUP_ID_DEFAULT) {
591 switch (hdr->nh_id) {
Wouter Cappellee3ff1752021-05-03 16:36:22 +0200592 case NMGR_ID_ECHO:
593#ifdef MCUBOOT_BOOT_MGMT_ECHO
594 bs_echo(buf, len);
595#endif
596 break;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800597 case NMGR_ID_CONS_ECHO_CTRL:
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000598 bs_rc_rsp(0);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800599 break;
600 case NMGR_ID_RESET:
601 bs_reset(buf, len);
602 break;
603 default:
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000604 bs_rc_rsp(MGMT_ERR_ENOTSUP);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800605 break;
606 }
Dominik Ermelbd69c3d2021-07-28 11:27:31 +0000607 } else if (MCUBOOT_PERUSER_MGMT_GROUP_ENABLED == 1) {
Dominik Ermel3d51e432021-06-25 17:29:50 +0000608 if (bs_peruser_system_specific(hdr, buf, len, &cbor_state) == 0) {
609 boot_serial_output();
610 }
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000611 } else {
612 bs_rc_rsp(MGMT_ERR_ENOTSUP);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800613 }
Wouter Cappellee3822f82022-01-19 15:39:43 +0100614#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
615 bs_entry = true;
616#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800617}
618
619static void
620boot_serial_output(void)
621{
622 char *data;
623 int len;
624 uint16_t crc;
625 uint16_t totlen;
626 char pkt_start[2] = { SHELL_NLIP_PKT_START1, SHELL_NLIP_PKT_START2 };
Dominik Ermel5ff89582022-03-03 17:09:07 +0000627 char buf[BOOT_SERIAL_OUT_MAX + sizeof(*bs_hdr) + sizeof(crc) + sizeof(totlen)];
628 char encoded_buf[BASE64_ENCODE_SIZE(sizeof(buf))];
Christopher Collins92ea77f2016-12-12 15:59:26 -0800629
630 data = bs_obuf;
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100631 len = (uint32_t)cbor_state.payload_mut - (uint32_t)bs_obuf;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800632
633 bs_hdr->nh_op++;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300634 bs_hdr->nh_flags = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800635 bs_hdr->nh_len = htons(len);
636 bs_hdr->nh_group = htons(bs_hdr->nh_group);
637
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200638#ifdef __ZEPHYR__
Carles Cufib9192a42022-02-10 11:41:57 +0100639 crc = crc16_itu_t(CRC16_INITIAL_CRC, (uint8_t *)bs_hdr, sizeof(*bs_hdr));
640 crc = crc16_itu_t(crc, data, len);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200641#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800642 crc = crc16_ccitt(CRC16_INITIAL_CRC, bs_hdr, sizeof(*bs_hdr));
643 crc = crc16_ccitt(crc, data, len);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200644#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800645 crc = htons(crc);
646
Marko Kiiskila149b4572018-06-06 14:18:54 +0300647 boot_uf->write(pkt_start, sizeof(pkt_start));
Christopher Collins92ea77f2016-12-12 15:59:26 -0800648
649 totlen = len + sizeof(*bs_hdr) + sizeof(crc);
650 totlen = htons(totlen);
651
652 memcpy(buf, &totlen, sizeof(totlen));
653 totlen = sizeof(totlen);
654 memcpy(&buf[totlen], bs_hdr, sizeof(*bs_hdr));
655 totlen += sizeof(*bs_hdr);
656 memcpy(&buf[totlen], data, len);
657 totlen += len;
658 memcpy(&buf[totlen], &crc, sizeof(crc));
659 totlen += sizeof(crc);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200660#ifdef __ZEPHYR__
661 size_t enc_len;
Carles Cufi0165be82018-03-26 17:43:51 +0200662 base64_encode(encoded_buf, sizeof(encoded_buf), &enc_len, buf, totlen);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200663 totlen = enc_len;
664#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800665 totlen = base64_encode(buf, totlen, encoded_buf, 1);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200666#endif
Marko Kiiskila149b4572018-06-06 14:18:54 +0300667 boot_uf->write(encoded_buf, totlen);
668 boot_uf->write("\n\r", 2);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200669 BOOT_LOG_INF("TX");
Christopher Collins92ea77f2016-12-12 15:59:26 -0800670}
671
672/*
673 * Returns 1 if full packet has been received.
674 */
675static int
676boot_serial_in_dec(char *in, int inlen, char *out, int *out_off, int maxout)
677{
678 int rc;
679 uint16_t crc;
680 uint16_t len;
Marko Kiiskilae5aeee42018-12-21 15:00:16 +0200681
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200682#ifdef __ZEPHYR__
683 int err;
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200684 err = base64_decode( &out[*out_off], maxout - *out_off, &rc, in, inlen - 2);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200685 if (err) {
686 return -1;
687 }
688#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800689 if (*out_off + base64_decode_len(in) >= maxout) {
690 return -1;
691 }
692 rc = base64_decode(in, &out[*out_off]);
693 if (rc < 0) {
694 return -1;
695 }
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200696#endif
Fabio Utzig6f49c272019-08-23 11:42:58 -0300697
Christopher Collins92ea77f2016-12-12 15:59:26 -0800698 *out_off += rc;
Fabio Utzig6f49c272019-08-23 11:42:58 -0300699 if (*out_off <= sizeof(uint16_t)) {
700 return 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800701 }
Fabio Utzig6f49c272019-08-23 11:42:58 -0300702
703 len = ntohs(*(uint16_t *)out);
704 if (len != *out_off - sizeof(uint16_t)) {
705 return 0;
706 }
707
708 if (len > *out_off - sizeof(uint16_t)) {
709 len = *out_off - sizeof(uint16_t);
710 }
711
712 out += sizeof(uint16_t);
713#ifdef __ZEPHYR__
Carles Cufib9192a42022-02-10 11:41:57 +0100714 crc = crc16_itu_t(CRC16_INITIAL_CRC, out, len);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300715#else
716 crc = crc16_ccitt(CRC16_INITIAL_CRC, out, len);
717#endif
718 if (crc || len <= sizeof(crc)) {
719 return 0;
720 }
721 *out_off -= sizeof(crc);
722 out[*out_off] = '\0';
723
724 return 1;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800725}
726
727/*
728 * Task which waits reading console, expecting to get image over
729 * serial port.
730 */
Wouter Cappellee3822f82022-01-19 15:39:43 +0100731static void
732boot_serial_read_console(const struct boot_uart_funcs *f,int timeout_in_ms)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800733{
734 int rc;
735 int off;
David Brown57f0df32020-05-12 08:39:21 -0600736 int dec_off = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800737 int full_line;
Marko Kiiskila149b4572018-06-06 14:18:54 +0300738 int max_input;
Wouter Cappellee3822f82022-01-19 15:39:43 +0100739 int elapsed_in_ms = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800740
Marko Kiiskila149b4572018-06-06 14:18:54 +0300741 boot_uf = f;
Marko Kiiskila149b4572018-06-06 14:18:54 +0300742 max_input = sizeof(in_buf);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800743
744 off = 0;
Wouter Cappellee3822f82022-01-19 15:39:43 +0100745 while (timeout_in_ms > 0 || bs_entry) {
Andrzej Puzdrowskiaea38eb2021-06-11 12:28:59 +0200746 MCUBOOT_CPU_IDLE();
Hein Wessels56d28f02021-11-19 08:42:08 +0100747 MCUBOOT_WATCHDOG_FEED();
Wouter Cappellee3822f82022-01-19 15:39:43 +0100748#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
749 uint32_t start = k_uptime_get_32();
750#endif
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200751 rc = f->read(in_buf + off, sizeof(in_buf) - off, &full_line);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800752 if (rc <= 0 && !full_line) {
Wouter Cappellee3822f82022-01-19 15:39:43 +0100753 goto check_timeout;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800754 }
755 off += rc;
756 if (!full_line) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300757 if (off == max_input) {
758 /*
759 * Full line, no newline yet. Reset the input buffer.
760 */
761 off = 0;
762 }
Wouter Cappellee3822f82022-01-19 15:39:43 +0100763 goto check_timeout;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800764 }
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200765 if (in_buf[0] == SHELL_NLIP_PKT_START1 &&
766 in_buf[1] == SHELL_NLIP_PKT_START2) {
Christopher Collins92ea77f2016-12-12 15:59:26 -0800767 dec_off = 0;
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200768 rc = boot_serial_in_dec(&in_buf[2], off - 2, dec_buf, &dec_off, max_input);
769 } else if (in_buf[0] == SHELL_NLIP_DATA_START1 &&
770 in_buf[1] == SHELL_NLIP_DATA_START2) {
771 rc = boot_serial_in_dec(&in_buf[2], off - 2, dec_buf, &dec_off, max_input);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800772 }
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200773
774 /* serve errors: out of decode memory, or bad encoding */
Christopher Collins92ea77f2016-12-12 15:59:26 -0800775 if (rc == 1) {
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200776 boot_serial_input(&dec_buf[2], dec_off - 2);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800777 }
778 off = 0;
Wouter Cappellee3822f82022-01-19 15:39:43 +0100779check_timeout:
780 /* Subtract elapsed time */
781#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
782 elapsed_in_ms = (k_uptime_get_32() - start);
783#endif
784 timeout_in_ms -= elapsed_in_ms;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800785 }
786}
Wouter Cappellee3822f82022-01-19 15:39:43 +0100787
788/*
789 * Task which waits reading console, expecting to get image over
790 * serial port.
791 */
792void
793boot_serial_start(const struct boot_uart_funcs *f)
794{
795 bs_entry = true;
796 boot_serial_read_console(f,0);
797}
798
799#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
800/*
801 * Task which waits reading console for a certain amount of timeout.
802 * If within this timeout no mcumgr command is received, the function is
803 * returning, else the serial boot is never exited
804 */
805void
806boot_serial_check_start(const struct boot_uart_funcs *f, int timeout_in_ms)
807{
808 bs_entry = false;
809 boot_serial_read_console(f,timeout_in_ms);
810}
811#endif