blob: e8c2fe27a70f9d1de2418a76939cd5484127d044 [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ønningstada7d34ca2022-02-28 13:47:57 +010028#include "zcbor_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"
Dominik Ermel88bd5672022-06-07 15:17:06 +000066#include "serial_recovery_echo.h"
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +020067#include "bootutil/boot_hooks.h"
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +010068
Carlos Falgueras Garcíaa4b4b0f2021-06-22 10:00:22 +020069BOOT_LOG_MODULE_DECLARE(mcuboot);
Emanuele Di Santo9f1933d2018-11-20 10:59:59 +010070
Marko Kiiskila149b4572018-06-06 14:18:54 +030071#define BOOT_SERIAL_INPUT_MAX 512
Andrzej Puzdrowskic9ac5cc2021-11-19 11:58:05 +010072#define BOOT_SERIAL_OUT_MAX (128 * BOOT_IMAGE_NUMBER)
Christopher Collins92ea77f2016-12-12 15:59:26 -080073
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020074#ifdef __ZEPHYR__
Carles Cufi0165be82018-03-26 17:43:51 +020075/* base64 lib encodes data to null-terminated string */
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020076#define BASE64_ENCODE_SIZE(in_size) ((((((in_size) - 1) / 3) * 4) + 4) + 1)
77
78#define CRC16_INITIAL_CRC 0 /* what to seed crc16 with */
79#define CRC_CITT_POLYMINAL 0x1021
80
81#define ntohs(x) sys_be16_to_cpu(x)
82#define htons(x) sys_cpu_to_be16(x)
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020083#endif
Emanuele Di Santo9f1933d2018-11-20 10:59:59 +010084
Fabio Utzig6f49c272019-08-23 11:42:58 -030085#if (BOOT_IMAGE_NUMBER > 1)
86#define IMAGES_ITER(x) for ((x) = 0; (x) < BOOT_IMAGE_NUMBER; ++(x))
87#else
88#define IMAGES_ITER(x)
89#endif
90
Marko Kiiskila149b4572018-06-06 14:18:54 +030091static char in_buf[BOOT_SERIAL_INPUT_MAX + 1];
92static char dec_buf[BOOT_SERIAL_INPUT_MAX + 1];
Marko Kiiskila8b1ce3a2018-06-14 13:20:46 -070093const struct boot_uart_funcs *boot_uf;
Christopher Collins92ea77f2016-12-12 15:59:26 -080094static uint32_t curr_off;
95static uint32_t img_size;
96static struct nmgr_hdr *bs_hdr;
Wouter Cappellee3822f82022-01-19 15:39:43 +010097static bool bs_entry;
Christopher Collins92ea77f2016-12-12 15:59:26 -080098
99static char bs_obuf[BOOT_SERIAL_OUT_MAX];
100
Christopher Collins92ea77f2016-12-12 15:59:26 -0800101static void boot_serial_output(void);
102
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100103static zcbor_state_t cbor_state[2];
Christopher Collins92ea77f2016-12-12 15:59:26 -0800104
Dominik Ermel4c0f6c12022-03-04 15:47:37 +0000105void reset_cbor_state(void)
106{
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100107 zcbor_new_encode_state(cbor_state, 2, (uint8_t *)bs_obuf,
108 (size_t)bs_obuf + sizeof(bs_obuf), 0);
Dominik Ermel4c0f6c12022-03-04 15:47:37 +0000109}
110
Dominik Ermel3d51e432021-06-25 17:29:50 +0000111/**
Dominik Ermelbd69c3d2021-07-28 11:27:31 +0000112 * Function that processes MGMT_GROUP_ID_PERUSER mcumgr group and may be
113 * used to process any groups that have not been processed by generic boot
114 * serial implementation.
Dominik Ermel3d51e432021-06-25 17:29:50 +0000115 *
116 * @param[in] hdr -- the decoded header of mcumgr message;
117 * @param[in] buffer -- buffer with first mcumgr message;
118 * @param[in] len -- length of of data in buffer;
119 * @param[out] *cs -- object with encoded response.
120 *
121 * @return 0 on success; non-0 error code otherwise.
122 */
123extern int bs_peruser_system_specific(const struct nmgr_hdr *hdr,
124 const char *buffer,
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100125 int len, zcbor_state_t *cs);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800126
127/*
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300128 * Convert version into string without use of snprintf().
Christopher Collins92ea77f2016-12-12 15:59:26 -0800129 */
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300130static int
131u32toa(char *tgt, uint32_t val)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800132{
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300133 char *dst;
134 uint32_t d = 1;
135 uint32_t dgt;
136 int n = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800137
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300138 dst = tgt;
139 while (val / d >= 10) {
140 d *= 10;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800141 }
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300142 while (d) {
143 dgt = val / d;
144 val %= d;
145 d /= 10;
146 if (n || dgt > 0 || d == 0) {
147 *dst++ = dgt + '0';
148 ++n;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800149 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800150 }
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300151 *dst = '\0';
152
153 return dst - tgt;
154}
155
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100156#define zcbor_tstr_put_lit_cast(state, string) \
157 zcbor_tstr_encode_ptr(state, (uint8_t *)string, sizeof(string) - 1)
158
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300159/*
160 * dst has to be able to fit "255.255.65535.4294967295" (25 characters).
161 */
162static void
163bs_list_img_ver(char *dst, int maxlen, struct image_version *ver)
164{
165 int off;
166
167 off = u32toa(dst, ver->iv_major);
168 dst[off++] = '.';
169 off += u32toa(dst + off, ver->iv_minor);
170 dst[off++] = '.';
171 off += u32toa(dst + off, ver->iv_revision);
172 dst[off++] = '.';
173 off += u32toa(dst + off, ver->iv_build_num);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800174}
175
176/*
177 * List images.
178 */
179static void
180bs_list(char *buf, int len)
181{
Christopher Collins92ea77f2016-12-12 15:59:26 -0800182 struct image_header hdr;
183 uint8_t tmpbuf[64];
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100184 uint32_t slot, area_id;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800185 const struct flash_area *fap;
Fabio Utzig6f49c272019-08-23 11:42:58 -0300186 uint8_t image_index;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800187
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100188 zcbor_map_start_encode(cbor_state, 1);
189 zcbor_tstr_put_lit_cast(cbor_state, "images");
190 zcbor_list_start_encode(cbor_state, 5);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300191 image_index = 0;
192 IMAGES_ITER(image_index) {
193 for (slot = 0; slot < 2; slot++) {
194 area_id = flash_area_id_from_multi_image_slot(image_index, slot);
195 if (flash_area_open(area_id, &fap)) {
196 continue;
197 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800198
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200199 int rc = BOOT_HOOK_CALL(boot_read_image_header_hook,
200 BOOT_HOOK_REGULAR, image_index, slot, &hdr);
201 if (rc == BOOT_HOOK_REGULAR)
202 {
203 flash_area_read(fap, 0, &hdr, sizeof(hdr));
204 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800205
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200206 fih_int fih_rc = FIH_FAILURE;
207
208 if (hdr.ih_magic == IMAGE_MAGIC)
209 {
210 BOOT_HOOK_CALL_FIH(boot_image_check_hook,
211 fih_int_encode(BOOT_HOOK_REGULAR),
212 fih_rc, image_index, slot);
213 if (fih_eq(fih_rc, BOOT_HOOK_REGULAR))
214 {
Wouter Cappelle953a7612021-05-03 16:53:05 +0200215#ifdef MCUBOOT_ENC_IMAGES
216 if (slot == 0 && IS_ENCRYPTED(&hdr)) {
217 /* Clear the encrypted flag we didn't supply a key
218 * This flag could be set if there was a decryption in place
219 * performed before. We will try to validate the image without
220 * decryption by clearing the flag in the heder. If
221 * still encrypted the validation will fail.
222 */
223 hdr.ih_flags &= ~(ENCRYPTIONFLAGS);
224 }
225#endif
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200226 FIH_CALL(bootutil_img_validate, fih_rc, NULL, 0, &hdr, fap, tmpbuf, sizeof(tmpbuf),
227 NULL, 0, NULL);
228 }
229 }
230
231 flash_area_close(fap);
232
233 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
Fabio Utzig6f49c272019-08-23 11:42:58 -0300234 continue;
235 }
Fabio Utzig6f49c272019-08-23 11:42:58 -0300236
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100237 zcbor_map_start_encode(cbor_state, 20);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300238
239#if (BOOT_IMAGE_NUMBER > 1)
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100240 zcbor_tstr_put_lit_cast(cbor_state, "image");
241 zcbor_uint32_put(cbor_state, image_index);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300242#endif
243
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100244 zcbor_tstr_put_lit_cast(cbor_state, "slot");
245 zcbor_uint32_put(cbor_state, slot);
246 zcbor_tstr_put_lit_cast(cbor_state, "version");
Fabio Utzig6f49c272019-08-23 11:42:58 -0300247
248 bs_list_img_ver((char *)tmpbuf, sizeof(tmpbuf), &hdr.ih_ver);
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100249 zcbor_tstr_encode_ptr(cbor_state, tmpbuf, strlen((char *)tmpbuf));
250 zcbor_map_end_encode(cbor_state, 20);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800251 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800252 }
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100253 zcbor_list_end_encode(cbor_state, 5);
254 zcbor_map_end_encode(cbor_state, 1);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800255 boot_serial_output();
256}
257
258/*
259 * Image upload request.
260 */
261static void
262bs_upload(char *buf, int len)
263{
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100264 const uint8_t *img_data = NULL;
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100265 long long int off = UINT64_MAX;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800266 size_t img_blen = 0;
Fabio Utzig30f6b2a2018-03-29 16:18:53 -0300267 uint8_t rem_bytes;
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100268 long long int data_len = UINT64_MAX;
Fabio Utzig6f49c272019-08-23 11:42:58 -0300269 int img_num;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300270 size_t slen;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800271 const struct flash_area *fap = NULL;
272 int rc;
Dominik Ermel3d4e55d2021-07-09 11:14:10 +0000273#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200274 static off_t off_last = -1;
275 struct flash_sector sector;
276#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800277
Fabio Utzig6f49c272019-08-23 11:42:58 -0300278 img_num = 0;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300279
280 /*
281 * Expected data format.
282 * {
Fabio Utzig6f49c272019-08-23 11:42:58 -0300283 * "image":<image number in a multi-image set (OPTIONAL)>
284 * "data":<image data>
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300285 * "len":<image len>
286 * "off":<current offset of image data>
287 * }
288 */
289
Øyvind Rønningstad212a35b2021-05-07 21:06:48 +0200290 struct Upload upload;
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100291 size_t decoded_len;
292 uint_fast8_t result = cbor_decode_Upload((const uint8_t *)buf, len, &upload, &decoded_len);
Øyvind Rønningstad212a35b2021-05-07 21:06:48 +0200293
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100294 if ((result != ZCBOR_SUCCESS) || (len != decoded_len)) {
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100295 goto out_invalid_data;
296 }
Dominik Ermel470e2f32020-01-10 13:28:48 +0000297
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100298 for (int i = 0; i < upload._Upload_members_count; i++) {
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100299 struct Member_ *member = &upload._Upload_members[i]._Upload_members;
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100300 switch(member->_Member_choice) {
301 case _Member_image:
302 img_num = member->_Member_image;
303 break;
304 case _Member_data:
305 img_data = member->_Member_data.value;
306 slen = member->_Member_data.len;
307 img_blen = slen;
308 break;
309 case _Member_len:
310 data_len = member->_Member_len;
311 break;
312 case _Member_off:
313 off = member->_Member_off;
314 break;
315 case _Member_sha:
316 default:
317 /* Nothing to do. */
318 break;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300319 }
320 }
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100321
Øyvind Rønningstad9f4aefd2021-03-08 21:11:25 +0100322 if (off == UINT64_MAX || img_data == NULL) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300323 /*
324 * Offset must be set in every block.
325 */
326 goto out_invalid_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800327 }
328
Dominik Ermel48decca2021-07-09 10:23:58 +0000329#if !defined(MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD)
Fabio Utzig6f49c272019-08-23 11:42:58 -0300330 rc = flash_area_open(flash_area_id_from_multi_image_slot(img_num, 0), &fap);
Dominik Ermel48decca2021-07-09 10:23:58 +0000331#else
332 rc = flash_area_open(flash_area_id_from_direct_image(img_num), &fap);
333#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800334 if (rc) {
335 rc = MGMT_ERR_EINVAL;
336 goto out;
337 }
338
339 if (off == 0) {
340 curr_off = 0;
Dominik Ermel260ae092021-04-23 05:38:45 +0000341 if (data_len > flash_area_get_size(fap)) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300342 goto out_invalid_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800343 }
Wouter Cappellebb7a39d2021-05-03 16:44:44 +0200344#if defined(MCUBOOT_VALIDATE_PRIMARY_SLOT_ONCE)
345 /* We are using swap state at end of flash area to store validation
346 * result. Make sure the user cannot write it from an image to skip validation.
347 */
348 if (data_len > (flash_area_get_size(fap) - BOOT_MAGIC_SZ)) {
349 goto out_invalid_data;
350 }
351#endif
Dominik Ermel3d4e55d2021-07-09 11:14:10 +0000352#ifndef MCUBOOT_ERASE_PROGRESSIVELY
Dominik Ermel260ae092021-04-23 05:38:45 +0000353 rc = flash_area_erase(fap, 0, flash_area_get_size(fap));
Christopher Collins92ea77f2016-12-12 15:59:26 -0800354 if (rc) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300355 goto out_invalid_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800356 }
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200357#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800358 img_size = data_len;
359 }
360 if (off != curr_off) {
361 rc = 0;
362 goto out;
363 }
Andrzej Puzdrowskif48de7a2020-10-19 09:42:02 +0200364
365 if (curr_off + img_blen > img_size) {
366 rc = MGMT_ERR_EINVAL;
367 goto out;
368 }
369
370 rem_bytes = img_blen % flash_area_align(fap);
371
372 if ((curr_off + img_blen < img_size) && rem_bytes) {
373 img_blen -= rem_bytes;
374 rem_bytes = 0;
Fabio Utzig30f6b2a2018-03-29 16:18:53 -0300375 }
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200376
Dominik Ermel3d4e55d2021-07-09 11:14:10 +0000377#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200378 rc = flash_area_sector_from_off(curr_off + img_blen, &sector);
379 if (rc) {
380 BOOT_LOG_ERR("Unable to determine flash sector size");
381 goto out;
382 }
Dominik Ermel260ae092021-04-23 05:38:45 +0000383 if (off_last != flash_sector_get_off(&sector)) {
384 off_last = flash_sector_get_off(&sector);
385 BOOT_LOG_INF("Erasing sector at offset 0x%x", flash_sector_get_off(&sector));
386 rc = flash_area_erase(fap, flash_sector_get_off(&sector),
387 flash_sector_get_size(&sector));
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200388 if (rc) {
389 BOOT_LOG_ERR("Error %d while erasing sector", rc);
390 goto out;
391 }
392 }
393#endif
394
395 BOOT_LOG_INF("Writing at 0x%x until 0x%x", curr_off, curr_off + img_blen);
Andrzej Puzdrowskif48de7a2020-10-19 09:42:02 +0200396 if (rem_bytes) {
397 /* the last chunk of the image might be unaligned */
398 uint8_t wbs_aligned[BOOT_MAX_ALIGN];
399 size_t w_size = img_blen - rem_bytes;
400
401 if (w_size) {
402 rc = flash_area_write(fap, curr_off, img_data, w_size);
403 if (rc) {
404 goto out_invalid_data;
405 }
406 curr_off += w_size;
407 img_blen -= w_size;
408 img_data += w_size;
409 }
410
411 if (img_blen) {
412 memcpy(wbs_aligned, img_data, rem_bytes);
413 memset(wbs_aligned + rem_bytes, flash_area_erased_val(fap),
414 sizeof(wbs_aligned) - rem_bytes);
415 rc = flash_area_write(fap, curr_off, wbs_aligned, flash_area_align(fap));
416 }
417
418 } else {
419 rc = flash_area_write(fap, curr_off, img_data, img_blen);
420 }
421
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300422 if (rc == 0) {
423 curr_off += img_blen;
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200424 if (curr_off == img_size) {
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200425#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200426 /* get the last sector offset */
427 rc = flash_area_sector_from_off(boot_status_off(fap), &sector);
428 if (rc) {
429 BOOT_LOG_ERR("Unable to determine flash sector of"
430 "the image trailer");
431 goto out;
432 }
433 /* Assure that sector for image trailer was erased. */
434 /* Check whether it was erased during previous upload. */
Dominik Ermel260ae092021-04-23 05:38:45 +0000435 if (off_last < flash_sector_get_off(&sector)) {
436 BOOT_LOG_INF("Erasing sector at offset 0x%x",
437 flash_sector_get_off(&sector));
438 rc = flash_area_erase(fap, flash_sector_get_off(&sector),
439 flash_sector_get_size(&sector));
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200440 if (rc) {
441 BOOT_LOG_ERR("Error %d while erasing sector", rc);
442 goto out;
443 }
444 }
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200445#endif
Andrzej Puzdrowski4f9c7302021-07-16 17:34:43 +0200446 rc = BOOT_HOOK_CALL(boot_serial_uploaded_hook, 0, img_num, fap,
447 img_size);
448 if (rc) {
449 BOOT_LOG_ERR("Error %d post upload hook", rc);
450 goto out;
451 }
452 }
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300453 } else {
454 out_invalid_data:
Christopher Collins92ea77f2016-12-12 15:59:26 -0800455 rc = MGMT_ERR_EINVAL;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800456 }
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200457
Christopher Collins92ea77f2016-12-12 15:59:26 -0800458out:
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200459 BOOT_LOG_INF("RX: 0x%x", rc);
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100460 zcbor_map_start_encode(cbor_state, 10);
461 zcbor_tstr_put_lit_cast(cbor_state, "rc");
462 zcbor_uint32_put(cbor_state, rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800463 if (rc == 0) {
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100464 zcbor_tstr_put_lit_cast(cbor_state, "off");
465 zcbor_uint32_put(cbor_state, curr_off);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800466 }
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100467 zcbor_map_end_encode(cbor_state, 10);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800468
469 boot_serial_output();
470 flash_area_close(fap);
Wouter Cappelle953a7612021-05-03 16:53:05 +0200471
472#ifdef MCUBOOT_ENC_IMAGES
473 if (curr_off == img_size) {
474 /* Last sector received, now start a decryption on the image if it is encrypted*/
475 rc = boot_handle_enc_fw();
476 }
477#endif //#ifdef MCUBOOT_ENC_IMAGES
Christopher Collins92ea77f2016-12-12 15:59:26 -0800478}
479
Dominik Ermel4c0f6c12022-03-04 15:47:37 +0000480/*
481 * Send rc code only.
482 */
483static void
484bs_rc_rsp(int rc_code)
485{
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100486 zcbor_map_start_encode(cbor_state, 10);
487 zcbor_tstr_put_lit_cast(cbor_state, "rc");
488 zcbor_uint32_put(cbor_state, rc_code);
489 zcbor_map_end_encode(cbor_state, 10);
Dominik Ermel4c0f6c12022-03-04 15:47:37 +0000490 boot_serial_output();
491}
492
493
Wouter Cappellee3ff1752021-05-03 16:36:22 +0200494#ifdef MCUBOOT_BOOT_MGMT_ECHO
Wouter Cappellee3ff1752021-05-03 16:36:22 +0200495static void
496bs_echo(char *buf, int len)
497{
Dominik Ermel88bd5672022-06-07 15:17:06 +0000498 struct Echo echo = { 0 };
499 size_t decoded_len;
500 uint32_t rc = MGMT_ERR_EINVAL;
501 uint_fast8_t result = cbor_decode_Echo((const uint8_t *)buf, len, &echo, &decoded_len);
Wouter Cappellee3ff1752021-05-03 16:36:22 +0200502
Dominik Ermel88bd5672022-06-07 15:17:06 +0000503 if ((result != ZCBOR_SUCCESS) || (len != decoded_len)) {
504 goto out;
Wouter Cappellee3ff1752021-05-03 16:36:22 +0200505 }
Dominik Ermel88bd5672022-06-07 15:17:06 +0000506
507 if (echo._Echo_d.value == NULL) {
508 goto out;
509 }
510
511 zcbor_map_start_encode(cbor_state, 10);
512 zcbor_tstr_put_term(cbor_state, "r");
513 if (zcbor_tstr_encode(cbor_state, &echo._Echo_d) && zcbor_map_end_encode(cbor_state, 10)) {
514 boot_serial_output();
515 return;
516 } else {
517 rc = MGMT_ERR_ENOMEM;
518 }
519
520out:
521 reset_cbor_state();
522 bs_rc_rsp(rc);
Wouter Cappellee3ff1752021-05-03 16:36:22 +0200523}
524#endif
525
Christopher Collins92ea77f2016-12-12 15:59:26 -0800526/*
Christopher Collins92ea77f2016-12-12 15:59:26 -0800527 * Reset, and (presumably) boot to newly uploaded image. Flush console
528 * before restarting.
529 */
Andrzej Puzdrowski268cdd02018-04-10 12:57:54 +0200530static void
Christopher Collins92ea77f2016-12-12 15:59:26 -0800531bs_reset(char *buf, int len)
532{
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000533 bs_rc_rsp(0);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800534
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200535#ifdef __ZEPHYR__
Andrzej Puzdrowski0cf0dbd2021-05-14 11:55:57 +0200536#ifdef CONFIG_MULTITHREADING
Carles Cufi7e7b4ad2020-03-30 19:12:02 +0200537 k_sleep(K_MSEC(250));
Andrzej Puzdrowski0cf0dbd2021-05-14 11:55:57 +0200538#else
539 k_busy_wait(250000);
540#endif
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200541 sys_reboot(SYS_REBOOT_COLD);
542#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800543 os_cputime_delay_usecs(250000);
544 hal_system_reset();
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200545#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800546}
547
548/*
549 * Parse incoming line of input from console.
550 * Expect newtmgr protocol with serial transport.
551 */
552void
553boot_serial_input(char *buf, int len)
554{
555 struct nmgr_hdr *hdr;
556
557 hdr = (struct nmgr_hdr *)buf;
558 if (len < sizeof(*hdr) ||
559 (hdr->nh_op != NMGR_OP_READ && hdr->nh_op != NMGR_OP_WRITE) ||
560 (ntohs(hdr->nh_len) < len - sizeof(*hdr))) {
561 return;
562 }
563 bs_hdr = hdr;
564 hdr->nh_group = ntohs(hdr->nh_group);
565
566 buf += sizeof(*hdr);
567 len -= sizeof(*hdr);
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300568
Dominik Ermel4c0f6c12022-03-04 15:47:37 +0000569 reset_cbor_state();
Christopher Collins92ea77f2016-12-12 15:59:26 -0800570
571 /*
572 * Limited support for commands.
573 */
574 if (hdr->nh_group == MGMT_GROUP_ID_IMAGE) {
575 switch (hdr->nh_id) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300576 case IMGMGR_NMGR_ID_STATE:
Christopher Collins92ea77f2016-12-12 15:59:26 -0800577 bs_list(buf, len);
578 break;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300579 case IMGMGR_NMGR_ID_UPLOAD:
Christopher Collins92ea77f2016-12-12 15:59:26 -0800580 bs_upload(buf, len);
581 break;
582 default:
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000583 bs_rc_rsp(MGMT_ERR_ENOTSUP);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800584 break;
585 }
586 } else if (hdr->nh_group == MGMT_GROUP_ID_DEFAULT) {
587 switch (hdr->nh_id) {
Wouter Cappellee3ff1752021-05-03 16:36:22 +0200588 case NMGR_ID_ECHO:
589#ifdef MCUBOOT_BOOT_MGMT_ECHO
590 bs_echo(buf, len);
591#endif
592 break;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800593 case NMGR_ID_CONS_ECHO_CTRL:
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000594 bs_rc_rsp(0);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800595 break;
596 case NMGR_ID_RESET:
597 bs_reset(buf, len);
598 break;
599 default:
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000600 bs_rc_rsp(MGMT_ERR_ENOTSUP);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800601 break;
602 }
Dominik Ermelbd69c3d2021-07-28 11:27:31 +0000603 } else if (MCUBOOT_PERUSER_MGMT_GROUP_ENABLED == 1) {
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100604 if (bs_peruser_system_specific(hdr, buf, len, cbor_state) == 0) {
Dominik Ermel3d51e432021-06-25 17:29:50 +0000605 boot_serial_output();
606 }
Dominik Ermelc9dc2242021-07-28 17:08:23 +0000607 } else {
608 bs_rc_rsp(MGMT_ERR_ENOTSUP);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800609 }
Wouter Cappellee3822f82022-01-19 15:39:43 +0100610#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
611 bs_entry = true;
612#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800613}
614
615static void
616boot_serial_output(void)
617{
618 char *data;
619 int len;
620 uint16_t crc;
621 uint16_t totlen;
622 char pkt_start[2] = { SHELL_NLIP_PKT_START1, SHELL_NLIP_PKT_START2 };
Dominik Ermel5ff89582022-03-03 17:09:07 +0000623 char buf[BOOT_SERIAL_OUT_MAX + sizeof(*bs_hdr) + sizeof(crc) + sizeof(totlen)];
624 char encoded_buf[BASE64_ENCODE_SIZE(sizeof(buf))];
Christopher Collins92ea77f2016-12-12 15:59:26 -0800625
626 data = bs_obuf;
Øyvind Rønningstada7d34ca2022-02-28 13:47:57 +0100627 len = (uint32_t)cbor_state->payload_mut - (uint32_t)bs_obuf;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800628
629 bs_hdr->nh_op++;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300630 bs_hdr->nh_flags = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800631 bs_hdr->nh_len = htons(len);
632 bs_hdr->nh_group = htons(bs_hdr->nh_group);
633
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200634#ifdef __ZEPHYR__
Carles Cufib9192a42022-02-10 11:41:57 +0100635 crc = crc16_itu_t(CRC16_INITIAL_CRC, (uint8_t *)bs_hdr, sizeof(*bs_hdr));
636 crc = crc16_itu_t(crc, data, len);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200637#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800638 crc = crc16_ccitt(CRC16_INITIAL_CRC, bs_hdr, sizeof(*bs_hdr));
639 crc = crc16_ccitt(crc, data, len);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200640#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800641 crc = htons(crc);
642
Marko Kiiskila149b4572018-06-06 14:18:54 +0300643 boot_uf->write(pkt_start, sizeof(pkt_start));
Christopher Collins92ea77f2016-12-12 15:59:26 -0800644
645 totlen = len + sizeof(*bs_hdr) + sizeof(crc);
646 totlen = htons(totlen);
647
648 memcpy(buf, &totlen, sizeof(totlen));
649 totlen = sizeof(totlen);
650 memcpy(&buf[totlen], bs_hdr, sizeof(*bs_hdr));
651 totlen += sizeof(*bs_hdr);
652 memcpy(&buf[totlen], data, len);
653 totlen += len;
654 memcpy(&buf[totlen], &crc, sizeof(crc));
655 totlen += sizeof(crc);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200656#ifdef __ZEPHYR__
657 size_t enc_len;
Carles Cufi0165be82018-03-26 17:43:51 +0200658 base64_encode(encoded_buf, sizeof(encoded_buf), &enc_len, buf, totlen);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200659 totlen = enc_len;
660#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800661 totlen = base64_encode(buf, totlen, encoded_buf, 1);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200662#endif
Marko Kiiskila149b4572018-06-06 14:18:54 +0300663 boot_uf->write(encoded_buf, totlen);
664 boot_uf->write("\n\r", 2);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200665 BOOT_LOG_INF("TX");
Christopher Collins92ea77f2016-12-12 15:59:26 -0800666}
667
668/*
669 * Returns 1 if full packet has been received.
670 */
671static int
672boot_serial_in_dec(char *in, int inlen, char *out, int *out_off, int maxout)
673{
674 int rc;
675 uint16_t crc;
676 uint16_t len;
Marko Kiiskilae5aeee42018-12-21 15:00:16 +0200677
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200678#ifdef __ZEPHYR__
679 int err;
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200680 err = base64_decode( &out[*out_off], maxout - *out_off, &rc, in, inlen - 2);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200681 if (err) {
682 return -1;
683 }
684#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800685 if (*out_off + base64_decode_len(in) >= maxout) {
686 return -1;
687 }
688 rc = base64_decode(in, &out[*out_off]);
689 if (rc < 0) {
690 return -1;
691 }
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200692#endif
Fabio Utzig6f49c272019-08-23 11:42:58 -0300693
Christopher Collins92ea77f2016-12-12 15:59:26 -0800694 *out_off += rc;
Fabio Utzig6f49c272019-08-23 11:42:58 -0300695 if (*out_off <= sizeof(uint16_t)) {
696 return 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800697 }
Fabio Utzig6f49c272019-08-23 11:42:58 -0300698
699 len = ntohs(*(uint16_t *)out);
700 if (len != *out_off - sizeof(uint16_t)) {
701 return 0;
702 }
703
704 if (len > *out_off - sizeof(uint16_t)) {
705 len = *out_off - sizeof(uint16_t);
706 }
707
708 out += sizeof(uint16_t);
709#ifdef __ZEPHYR__
Carles Cufib9192a42022-02-10 11:41:57 +0100710 crc = crc16_itu_t(CRC16_INITIAL_CRC, out, len);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300711#else
712 crc = crc16_ccitt(CRC16_INITIAL_CRC, out, len);
713#endif
714 if (crc || len <= sizeof(crc)) {
715 return 0;
716 }
717 *out_off -= sizeof(crc);
718 out[*out_off] = '\0';
719
720 return 1;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800721}
722
723/*
724 * Task which waits reading console, expecting to get image over
725 * serial port.
726 */
Wouter Cappellee3822f82022-01-19 15:39:43 +0100727static void
728boot_serial_read_console(const struct boot_uart_funcs *f,int timeout_in_ms)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800729{
730 int rc;
731 int off;
David Brown57f0df32020-05-12 08:39:21 -0600732 int dec_off = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800733 int full_line;
Marko Kiiskila149b4572018-06-06 14:18:54 +0300734 int max_input;
Wouter Cappellee3822f82022-01-19 15:39:43 +0100735 int elapsed_in_ms = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800736
Marko Kiiskila149b4572018-06-06 14:18:54 +0300737 boot_uf = f;
Marko Kiiskila149b4572018-06-06 14:18:54 +0300738 max_input = sizeof(in_buf);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800739
740 off = 0;
Wouter Cappellee3822f82022-01-19 15:39:43 +0100741 while (timeout_in_ms > 0 || bs_entry) {
Andrzej Puzdrowskiaea38eb2021-06-11 12:28:59 +0200742 MCUBOOT_CPU_IDLE();
Hein Wessels56d28f02021-11-19 08:42:08 +0100743 MCUBOOT_WATCHDOG_FEED();
Wouter Cappellee3822f82022-01-19 15:39:43 +0100744#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
745 uint32_t start = k_uptime_get_32();
746#endif
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200747 rc = f->read(in_buf + off, sizeof(in_buf) - off, &full_line);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800748 if (rc <= 0 && !full_line) {
Wouter Cappellee3822f82022-01-19 15:39:43 +0100749 goto check_timeout;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800750 }
751 off += rc;
752 if (!full_line) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300753 if (off == max_input) {
754 /*
755 * Full line, no newline yet. Reset the input buffer.
756 */
757 off = 0;
758 }
Wouter Cappellee3822f82022-01-19 15:39:43 +0100759 goto check_timeout;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800760 }
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200761 if (in_buf[0] == SHELL_NLIP_PKT_START1 &&
762 in_buf[1] == SHELL_NLIP_PKT_START2) {
Christopher Collins92ea77f2016-12-12 15:59:26 -0800763 dec_off = 0;
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200764 rc = boot_serial_in_dec(&in_buf[2], off - 2, dec_buf, &dec_off, max_input);
765 } else if (in_buf[0] == SHELL_NLIP_DATA_START1 &&
766 in_buf[1] == SHELL_NLIP_DATA_START2) {
767 rc = boot_serial_in_dec(&in_buf[2], off - 2, dec_buf, &dec_off, max_input);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800768 }
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200769
770 /* serve errors: out of decode memory, or bad encoding */
Christopher Collins92ea77f2016-12-12 15:59:26 -0800771 if (rc == 1) {
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200772 boot_serial_input(&dec_buf[2], dec_off - 2);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800773 }
774 off = 0;
Wouter Cappellee3822f82022-01-19 15:39:43 +0100775check_timeout:
776 /* Subtract elapsed time */
777#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
778 elapsed_in_ms = (k_uptime_get_32() - start);
779#endif
780 timeout_in_ms -= elapsed_in_ms;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800781 }
782}
Wouter Cappellee3822f82022-01-19 15:39:43 +0100783
784/*
785 * Task which waits reading console, expecting to get image over
786 * serial port.
787 */
788void
789boot_serial_start(const struct boot_uart_funcs *f)
790{
791 bs_entry = true;
792 boot_serial_read_console(f,0);
793}
794
795#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
796/*
797 * Task which waits reading console for a certain amount of timeout.
798 * If within this timeout no mcumgr command is received, the function is
799 * returning, else the serial boot is never exited
800 */
801void
802boot_serial_check_start(const struct boot_uart_funcs *f, int timeout_in_ms)
803{
804 bs_entry = false;
805 boot_serial_read_console(f,timeout_in_ms);
806}
807#endif