blob: ec068fc4a4a0686aaa4b5bb0ad59fb333d1db9e9 [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"
Roman Okhrimenko977b3752022-03-31 14:40:48 +030028#include "cbor_encode.h"
Fabio Utzig1a2e41a2017-11-17 12:13:09 -020029
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020030#ifdef __ZEPHYR__
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +030031#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
Roman Okhrimenko977b3752022-03-31 14:40:48 +030057#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +020058#include "bootutil_priv.h"
59#endif
60
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +030061#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"
Roman Okhrimenko977b3752022-03-31 14:40:48 +030066#include "bootutil/boot_hooks.h"
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +010067
Roman Okhrimenko977b3752022-03-31 14:40:48 +030068BOOT_LOG_MODULE_DECLARE(mcuboot);
69
Marko Kiiskila149b4572018-06-06 14:18:54 +030070#define BOOT_SERIAL_INPUT_MAX 512
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +030071#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;
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +030096static 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
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300102static 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
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300107/**
108 * Function that processes MGMT_GROUP_ID_PERUSER mcumgr group and may be
109 * used to process any groups that have not been processed by generic boot
110 * serial implementation.
111 *
112 * @param[in] hdr -- the decoded header of mcumgr message;
113 * @param[in] buffer -- buffer with first mcumgr message;
114 * @param[in] len -- length of of data in buffer;
115 * @param[out] *cs -- object with encoded response.
116 *
117 * @return 0 on success; non-0 error code otherwise.
118 */
119extern int bs_peruser_system_specific(const struct nmgr_hdr *hdr,
120 const char *buffer,
121 int len, cbor_state_t *cs);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800122
123/*
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300124 * Convert version into string without use of snprintf().
Christopher Collins92ea77f2016-12-12 15:59:26 -0800125 */
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300126static int
127u32toa(char *tgt, uint32_t val)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800128{
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300129 char *dst;
130 uint32_t d = 1;
131 uint32_t dgt;
132 int n = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800133
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300134 dst = tgt;
135 while (val / d >= 10) {
136 d *= 10;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800137 }
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300138 while (d) {
139 dgt = val / d;
140 val %= d;
141 d /= 10;
142 if (n || dgt > 0 || d == 0) {
143 *dst++ = dgt + '0';
144 ++n;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800145 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800146 }
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300147 *dst = '\0';
148
149 return dst - tgt;
150}
151
152/*
153 * dst has to be able to fit "255.255.65535.4294967295" (25 characters).
154 */
155static void
156bs_list_img_ver(char *dst, int maxlen, struct image_version *ver)
157{
158 int off;
159
160 off = u32toa(dst, ver->iv_major);
161 dst[off++] = '.';
162 off += u32toa(dst + off, ver->iv_minor);
163 dst[off++] = '.';
164 off += u32toa(dst + off, ver->iv_revision);
165 dst[off++] = '.';
166 off += u32toa(dst + off, ver->iv_build_num);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800167}
168
169/*
170 * List images.
171 */
172static void
173bs_list(char *buf, int len)
174{
Christopher Collins92ea77f2016-12-12 15:59:26 -0800175 struct image_header hdr;
176 uint8_t tmpbuf[64];
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300177 uint32_t slot, area_id;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800178 const struct flash_area *fap;
Fabio Utzig6f49c272019-08-23 11:42:58 -0300179 uint8_t image_index;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800180
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300181 map_start_encode(&cbor_state, 1);
182 tstrx_put(&cbor_state, "images");
183 list_start_encode(&cbor_state, 5);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300184 image_index = 0;
185 IMAGES_ITER(image_index) {
186 for (slot = 0; slot < 2; slot++) {
187 area_id = flash_area_id_from_multi_image_slot(image_index, slot);
188 if (flash_area_open(area_id, &fap)) {
189 continue;
190 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800191
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300192 int rc = BOOT_HOOK_CALL(boot_read_image_header_hook,
193 BOOT_HOOK_REGULAR, image_index, slot, &hdr);
194 if (rc == BOOT_HOOK_REGULAR)
195 {
196 flash_area_read(fap, 0, &hdr, sizeof(hdr));
Fabio Utzig6f49c272019-08-23 11:42:58 -0300197 }
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300198
199 fih_int fih_rc = FIH_FAILURE;
200
201 if (hdr.ih_magic == IMAGE_MAGIC)
202 {
203 BOOT_HOOK_CALL_FIH(boot_image_check_hook,
204 fih_int_encode(BOOT_HOOK_REGULAR),
205 fih_rc, image_index, slot);
206 if (fih_eq(fih_rc, BOOT_HOOK_REGULAR))
207 {
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300208#ifdef MCUBOOT_ENC_IMAGES
209 if (slot == 0 && IS_ENCRYPTED(&hdr)) {
210 /* Clear the encrypted flag we didn't supply a key
211 * This flag could be set if there was a decryption in place
212 * performed before. We will try to validate the image without
213 * decryption by clearing the flag in the heder. If
214 * still encrypted the validation will fail.
215 */
216 hdr.ih_flags &= ~(ENCRYPTIONFLAGS);
217 }
218#endif
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300219 FIH_CALL(bootutil_img_validate, fih_rc, NULL, 0, &hdr, fap, tmpbuf, sizeof(tmpbuf),
220 NULL, 0, NULL);
221 }
222 }
223
Christopher Collins92ea77f2016-12-12 15:59:26 -0800224 flash_area_close(fap);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300225
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300226 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
227 continue;
228 }
229
230 map_start_encode(&cbor_state, 20);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300231
232#if (BOOT_IMAGE_NUMBER > 1)
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300233 tstrx_put(&cbor_state, "image");
234 uintx32_put(&cbor_state, image_index);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300235#endif
236
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300237 tstrx_put(&cbor_state, "slot");
238 uintx32_put(&cbor_state, slot);
239 tstrx_put(&cbor_state, "version");
Fabio Utzig6f49c272019-08-23 11:42:58 -0300240
241 bs_list_img_ver((char *)tmpbuf, sizeof(tmpbuf), &hdr.ih_ver);
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300242 tstrx_put_term(&cbor_state, (char *)tmpbuf);
243 map_end_encode(&cbor_state, 20);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800244 }
Christopher Collins92ea77f2016-12-12 15:59:26 -0800245 }
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300246 list_end_encode(&cbor_state, 5);
247 map_end_encode(&cbor_state, 1);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800248 boot_serial_output();
249}
250
251/*
252 * Image upload request.
253 */
254static void
255bs_upload(char *buf, int len)
256{
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100257 const uint8_t *img_data = NULL;
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300258 long long int off = UINT64_MAX;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800259 size_t img_blen = 0;
Fabio Utzig30f6b2a2018-03-29 16:18:53 -0300260 uint8_t rem_bytes;
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300261 long long int data_len = UINT64_MAX;
Fabio Utzig6f49c272019-08-23 11:42:58 -0300262 int img_num;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300263 size_t slen;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800264 const struct flash_area *fap = NULL;
265 int rc;
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300266#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200267 static off_t off_last = -1;
268 struct flash_sector sector;
269#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800270
Fabio Utzig6f49c272019-08-23 11:42:58 -0300271 img_num = 0;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300272
273 /*
274 * Expected data format.
275 * {
Fabio Utzig6f49c272019-08-23 11:42:58 -0300276 * "image":<image number in a multi-image set (OPTIONAL)>
277 * "data":<image data>
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300278 * "len":<image len>
279 * "off":<current offset of image data>
280 * }
281 */
282
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300283 struct Upload upload;
284 uint32_t decoded_len;
285 bool result = cbor_decode_Upload((const uint8_t *)buf, len, &upload, &decoded_len);
286
287 if (!result || (len != decoded_len)) {
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100288 goto out_invalid_data;
289 }
Dominik Ermel470e2f32020-01-10 13:28:48 +0000290
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100291 for (int i = 0; i < upload._Upload_members_count; i++) {
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300292 struct Member_ *member = &upload._Upload_members[i];
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100293 switch(member->_Member_choice) {
294 case _Member_image:
295 img_num = member->_Member_image;
296 break;
297 case _Member_data:
298 img_data = member->_Member_data.value;
299 slen = member->_Member_data.len;
300 img_blen = slen;
301 break;
302 case _Member_len:
303 data_len = member->_Member_len;
304 break;
305 case _Member_off:
306 off = member->_Member_off;
307 break;
308 case _Member_sha:
309 default:
310 /* Nothing to do. */
311 break;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300312 }
313 }
Øyvind Rønningstadf42a8202019-12-13 03:27:54 +0100314
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300315 if (off == UINT64_MAX || img_data == NULL) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300316 /*
317 * Offset must be set in every block.
318 */
319 goto out_invalid_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800320 }
321
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300322#if !defined(MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD)
Fabio Utzig6f49c272019-08-23 11:42:58 -0300323 rc = flash_area_open(flash_area_id_from_multi_image_slot(img_num, 0), &fap);
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300324#else
325 rc = flash_area_open(flash_area_id_from_direct_image(img_num), &fap);
326#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800327 if (rc) {
328 rc = MGMT_ERR_EINVAL;
329 goto out;
330 }
331
332 if (off == 0) {
333 curr_off = 0;
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300334 if (data_len > flash_area_get_size(fap)) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300335 goto out_invalid_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800336 }
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300337#if defined(MCUBOOT_VALIDATE_PRIMARY_SLOT_ONCE)
338 /* We are using swap state at end of flash area to store validation
339 * result. Make sure the user cannot write it from an image to skip validation.
340 */
341 if (data_len > (flash_area_get_size(fap) - BOOT_MAGIC_SZ)) {
342 goto out_invalid_data;
343 }
344#endif
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300345#ifndef MCUBOOT_ERASE_PROGRESSIVELY
346 rc = flash_area_erase(fap, 0, flash_area_get_size(fap));
Christopher Collins92ea77f2016-12-12 15:59:26 -0800347 if (rc) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300348 goto out_invalid_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800349 }
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200350#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800351 img_size = data_len;
352 }
353 if (off != curr_off) {
354 rc = 0;
355 goto out;
356 }
Andrzej Puzdrowskif48de7a2020-10-19 09:42:02 +0200357
358 if (curr_off + img_blen > img_size) {
359 rc = MGMT_ERR_EINVAL;
360 goto out;
361 }
362
363 rem_bytes = img_blen % flash_area_align(fap);
364
365 if ((curr_off + img_blen < img_size) && rem_bytes) {
366 img_blen -= rem_bytes;
367 rem_bytes = 0;
Fabio Utzig30f6b2a2018-03-29 16:18:53 -0300368 }
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200369
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300370#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200371 rc = flash_area_sector_from_off(curr_off + img_blen, &sector);
372 if (rc) {
373 BOOT_LOG_ERR("Unable to determine flash sector size");
374 goto out;
375 }
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300376 if (off_last != flash_sector_get_off(&sector)) {
377 off_last = flash_sector_get_off(&sector);
378 BOOT_LOG_INF("Erasing sector at offset 0x%x", flash_sector_get_off(&sector));
379 rc = flash_area_erase(fap, flash_sector_get_off(&sector),
380 flash_sector_get_size(&sector));
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200381 if (rc) {
382 BOOT_LOG_ERR("Error %d while erasing sector", rc);
383 goto out;
384 }
385 }
386#endif
387
388 BOOT_LOG_INF("Writing at 0x%x until 0x%x", curr_off, curr_off + img_blen);
Andrzej Puzdrowskif48de7a2020-10-19 09:42:02 +0200389 if (rem_bytes) {
390 /* the last chunk of the image might be unaligned */
391 uint8_t wbs_aligned[BOOT_MAX_ALIGN];
392 size_t w_size = img_blen - rem_bytes;
393
394 if (w_size) {
395 rc = flash_area_write(fap, curr_off, img_data, w_size);
396 if (rc) {
397 goto out_invalid_data;
398 }
399 curr_off += w_size;
400 img_blen -= w_size;
401 img_data += w_size;
402 }
403
404 if (img_blen) {
405 memcpy(wbs_aligned, img_data, rem_bytes);
406 memset(wbs_aligned + rem_bytes, flash_area_erased_val(fap),
407 sizeof(wbs_aligned) - rem_bytes);
408 rc = flash_area_write(fap, curr_off, wbs_aligned, flash_area_align(fap));
409 }
410
411 } else {
412 rc = flash_area_write(fap, curr_off, img_data, img_blen);
413 }
414
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300415 if (rc == 0) {
416 curr_off += img_blen;
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200417 if (curr_off == img_size) {
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300418#ifdef MCUBOOT_ERASE_PROGRESSIVELY
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200419 /* get the last sector offset */
420 rc = flash_area_sector_from_off(boot_status_off(fap), &sector);
421 if (rc) {
422 BOOT_LOG_ERR("Unable to determine flash sector of"
423 "the image trailer");
424 goto out;
425 }
426 /* Assure that sector for image trailer was erased. */
427 /* Check whether it was erased during previous upload. */
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300428 if (off_last < flash_sector_get_off(&sector)) {
429 BOOT_LOG_INF("Erasing sector at offset 0x%x",
430 flash_sector_get_off(&sector));
431 rc = flash_area_erase(fap, flash_sector_get_off(&sector),
432 flash_sector_get_size(&sector));
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200433 if (rc) {
434 BOOT_LOG_ERR("Error %d while erasing sector", rc);
435 goto out;
436 }
437 }
Andrzej Puzdrowskic2e30cf2018-07-20 16:19:09 +0200438#endif
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300439 rc = BOOT_HOOK_CALL(boot_serial_uploaded_hook, 0, img_num, fap,
440 img_size);
441 if (rc) {
442 BOOT_LOG_ERR("Error %d post upload hook", rc);
443 goto out;
444 }
445 }
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300446 } else {
447 out_invalid_data:
Christopher Collins92ea77f2016-12-12 15:59:26 -0800448 rc = MGMT_ERR_EINVAL;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800449 }
Emanuele Di Santo205c8c62018-07-20 11:42:31 +0200450
Christopher Collins92ea77f2016-12-12 15:59:26 -0800451out:
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200452 BOOT_LOG_INF("RX: 0x%x", rc);
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300453 map_start_encode(&cbor_state, 10);
454 tstrx_put(&cbor_state, "rc");
455 uintx32_put(&cbor_state, rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800456 if (rc == 0) {
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300457 tstrx_put(&cbor_state, "off");
458 uintx32_put(&cbor_state, curr_off);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800459 }
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300460 map_end_encode(&cbor_state, 10);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800461
462 boot_serial_output();
463 flash_area_close(fap);
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300464
465#ifdef MCUBOOT_ENC_IMAGES
466 if (curr_off == img_size) {
467 /* Last sector received, now start a decryption on the image if it is encrypted*/
468 rc = boot_handle_enc_fw();
469 }
470#endif //#ifdef MCUBOOT_ENC_IMAGES
Christopher Collins92ea77f2016-12-12 15:59:26 -0800471}
472
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300473#ifdef MCUBOOT_BOOT_MGMT_ECHO
474static bool
475decode_echo(cbor_state_t *state, cbor_string_type_t *result)
476{
477 size_t bsstrdecoded;
478 int ret;
479
480 if (!map_start_decode(state)) {
481 return false;
482 }
483 ret = multi_decode(2, 2, &bsstrdecoded, (void *)tstrx_decode, state, result, sizeof(cbor_string_type_t));
484 map_end_decode(state);
485 return ret;
486}
487
488
489static void
490bs_echo(char *buf, int len)
491{
492 size_t bsstrdecoded;
493 cbor_string_type_t str[2];
494
495 if (entry_function((const uint8_t *)buf, len, str, &bsstrdecoded, (void *)decode_echo, 1, 2)) {
496 map_start_encode(&cbor_state, 10);
497 tstrx_put(&cbor_state, "r");
498 tstrx_encode(&cbor_state, &str[1]);
499 map_end_encode(&cbor_state, 10);
500 boot_serial_output();
501 }
502}
503#endif
504
Christopher Collins92ea77f2016-12-12 15:59:26 -0800505/*
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300506 * Send rc code only.
Christopher Collins92ea77f2016-12-12 15:59:26 -0800507 */
508static void
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300509bs_rc_rsp(int rc_code)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800510{
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300511 map_start_encode(&cbor_state, 10);
512 tstrx_put(&cbor_state, "rc");
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300513 uintx32_put(&cbor_state, rc_code);
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300514 map_end_encode(&cbor_state, 10);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800515 boot_serial_output();
516}
517
518/*
519 * Reset, and (presumably) boot to newly uploaded image. Flush console
520 * before restarting.
521 */
Andrzej Puzdrowski268cdd02018-04-10 12:57:54 +0200522static void
Christopher Collins92ea77f2016-12-12 15:59:26 -0800523bs_reset(char *buf, int len)
524{
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300525 bs_rc_rsp(0);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800526
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200527#ifdef __ZEPHYR__
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300528#ifdef CONFIG_MULTITHREADING
Carles Cufi7e7b4ad2020-03-30 19:12:02 +0200529 k_sleep(K_MSEC(250));
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300530#else
531 k_busy_wait(250000);
532#endif
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200533 sys_reboot(SYS_REBOOT_COLD);
534#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800535 os_cputime_delay_usecs(250000);
536 hal_system_reset();
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200537#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800538}
539
540/*
541 * Parse incoming line of input from console.
542 * Expect newtmgr protocol with serial transport.
543 */
544void
545boot_serial_input(char *buf, int len)
546{
547 struct nmgr_hdr *hdr;
548
549 hdr = (struct nmgr_hdr *)buf;
550 if (len < sizeof(*hdr) ||
551 (hdr->nh_op != NMGR_OP_READ && hdr->nh_op != NMGR_OP_WRITE) ||
552 (ntohs(hdr->nh_len) < len - sizeof(*hdr))) {
553 return;
554 }
555 bs_hdr = hdr;
556 hdr->nh_group = ntohs(hdr->nh_group);
557
558 buf += sizeof(*hdr);
559 len -= sizeof(*hdr);
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300560
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300561 cbor_state.payload_mut = (uint8_t *)bs_obuf;
562 cbor_state.payload_end = (const uint8_t *)bs_obuf
563 + sizeof(bs_obuf);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800564
565 /*
566 * Limited support for commands.
567 */
568 if (hdr->nh_group == MGMT_GROUP_ID_IMAGE) {
569 switch (hdr->nh_id) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300570 case IMGMGR_NMGR_ID_STATE:
Christopher Collins92ea77f2016-12-12 15:59:26 -0800571 bs_list(buf, len);
572 break;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300573 case IMGMGR_NMGR_ID_UPLOAD:
Christopher Collins92ea77f2016-12-12 15:59:26 -0800574 bs_upload(buf, len);
575 break;
576 default:
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300577 bs_rc_rsp(MGMT_ERR_ENOTSUP);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800578 break;
579 }
580 } else if (hdr->nh_group == MGMT_GROUP_ID_DEFAULT) {
581 switch (hdr->nh_id) {
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300582 case NMGR_ID_ECHO:
583#ifdef MCUBOOT_BOOT_MGMT_ECHO
584 bs_echo(buf, len);
585#endif
586 break;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800587 case NMGR_ID_CONS_ECHO_CTRL:
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300588 bs_rc_rsp(0);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800589 break;
590 case NMGR_ID_RESET:
591 bs_reset(buf, len);
592 break;
593 default:
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300594 bs_rc_rsp(MGMT_ERR_ENOTSUP);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800595 break;
596 }
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300597 } else if (MCUBOOT_PERUSER_MGMT_GROUP_ENABLED == 1) {
598 if (bs_peruser_system_specific(hdr, buf, len, &cbor_state) == 0) {
599 boot_serial_output();
600 }
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300601 } else {
602 bs_rc_rsp(MGMT_ERR_ENOTSUP);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800603 }
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300604#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
605 bs_entry = true;
606#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800607}
608
609static void
610boot_serial_output(void)
611{
612 char *data;
613 int len;
614 uint16_t crc;
615 uint16_t totlen;
616 char pkt_start[2] = { SHELL_NLIP_PKT_START1, SHELL_NLIP_PKT_START2 };
617 char buf[BOOT_SERIAL_OUT_MAX];
618 char encoded_buf[BASE64_ENCODE_SIZE(BOOT_SERIAL_OUT_MAX)];
619
620 data = bs_obuf;
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300621 len = (uint32_t)cbor_state.payload_mut - (uint32_t)bs_obuf;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800622
623 bs_hdr->nh_op++;
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300624 bs_hdr->nh_flags = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800625 bs_hdr->nh_len = htons(len);
626 bs_hdr->nh_group = htons(bs_hdr->nh_group);
627
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200628#ifdef __ZEPHYR__
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300629 crc = crc16_itu_t(CRC16_INITIAL_CRC, (uint8_t *)bs_hdr, sizeof(*bs_hdr));
630 crc = crc16_itu_t(crc, data, len);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200631#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800632 crc = crc16_ccitt(CRC16_INITIAL_CRC, bs_hdr, sizeof(*bs_hdr));
633 crc = crc16_ccitt(crc, data, len);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200634#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800635 crc = htons(crc);
636
Marko Kiiskila149b4572018-06-06 14:18:54 +0300637 boot_uf->write(pkt_start, sizeof(pkt_start));
Christopher Collins92ea77f2016-12-12 15:59:26 -0800638
639 totlen = len + sizeof(*bs_hdr) + sizeof(crc);
640 totlen = htons(totlen);
641
642 memcpy(buf, &totlen, sizeof(totlen));
643 totlen = sizeof(totlen);
644 memcpy(&buf[totlen], bs_hdr, sizeof(*bs_hdr));
645 totlen += sizeof(*bs_hdr);
646 memcpy(&buf[totlen], data, len);
647 totlen += len;
648 memcpy(&buf[totlen], &crc, sizeof(crc));
649 totlen += sizeof(crc);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200650#ifdef __ZEPHYR__
651 size_t enc_len;
Carles Cufi0165be82018-03-26 17:43:51 +0200652 base64_encode(encoded_buf, sizeof(encoded_buf), &enc_len, buf, totlen);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200653 totlen = enc_len;
654#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800655 totlen = base64_encode(buf, totlen, encoded_buf, 1);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200656#endif
Marko Kiiskila149b4572018-06-06 14:18:54 +0300657 boot_uf->write(encoded_buf, totlen);
658 boot_uf->write("\n\r", 2);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200659 BOOT_LOG_INF("TX");
Christopher Collins92ea77f2016-12-12 15:59:26 -0800660}
661
662/*
663 * Returns 1 if full packet has been received.
664 */
665static int
666boot_serial_in_dec(char *in, int inlen, char *out, int *out_off, int maxout)
667{
668 int rc;
669 uint16_t crc;
670 uint16_t len;
Marko Kiiskilae5aeee42018-12-21 15:00:16 +0200671
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200672#ifdef __ZEPHYR__
673 int err;
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200674 err = base64_decode( &out[*out_off], maxout - *out_off, &rc, in, inlen - 2);
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200675 if (err) {
676 return -1;
677 }
678#else
Christopher Collins92ea77f2016-12-12 15:59:26 -0800679 if (*out_off + base64_decode_len(in) >= maxout) {
680 return -1;
681 }
682 rc = base64_decode(in, &out[*out_off]);
683 if (rc < 0) {
684 return -1;
685 }
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +0200686#endif
Fabio Utzig6f49c272019-08-23 11:42:58 -0300687
Christopher Collins92ea77f2016-12-12 15:59:26 -0800688 *out_off += rc;
Fabio Utzig6f49c272019-08-23 11:42:58 -0300689 if (*out_off <= sizeof(uint16_t)) {
690 return 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800691 }
Fabio Utzig6f49c272019-08-23 11:42:58 -0300692
693 len = ntohs(*(uint16_t *)out);
694 if (len != *out_off - sizeof(uint16_t)) {
695 return 0;
696 }
697
698 if (len > *out_off - sizeof(uint16_t)) {
699 len = *out_off - sizeof(uint16_t);
700 }
701
702 out += sizeof(uint16_t);
703#ifdef __ZEPHYR__
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300704 crc = crc16_itu_t(CRC16_INITIAL_CRC, out, len);
Fabio Utzig6f49c272019-08-23 11:42:58 -0300705#else
706 crc = crc16_ccitt(CRC16_INITIAL_CRC, out, len);
707#endif
708 if (crc || len <= sizeof(crc)) {
709 return 0;
710 }
711 *out_off -= sizeof(crc);
712 out[*out_off] = '\0';
713
714 return 1;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800715}
716
717/*
718 * Task which waits reading console, expecting to get image over
719 * serial port.
720 */
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300721static void
722boot_serial_read_console(const struct boot_uart_funcs *f,int timeout_in_ms)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800723{
724 int rc;
725 int off;
David Brown57f0df32020-05-12 08:39:21 -0600726 int dec_off = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800727 int full_line;
Marko Kiiskila149b4572018-06-06 14:18:54 +0300728 int max_input;
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300729 int elapsed_in_ms = 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800730
Marko Kiiskila149b4572018-06-06 14:18:54 +0300731 boot_uf = f;
Marko Kiiskila149b4572018-06-06 14:18:54 +0300732 max_input = sizeof(in_buf);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800733
734 off = 0;
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300735 while (timeout_in_ms > 0 || bs_entry) {
Roman Okhrimenko977b3752022-03-31 14:40:48 +0300736 MCUBOOT_CPU_IDLE();
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300737 MCUBOOT_WATCHDOG_FEED();
738#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
739 uint32_t start = k_uptime_get_32();
740#endif
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200741 rc = f->read(in_buf + off, sizeof(in_buf) - off, &full_line);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800742 if (rc <= 0 && !full_line) {
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300743 goto check_timeout;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800744 }
745 off += rc;
746 if (!full_line) {
Marko Kiiskilace50ab02018-06-06 11:33:33 +0300747 if (off == max_input) {
748 /*
749 * Full line, no newline yet. Reset the input buffer.
750 */
751 off = 0;
752 }
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300753 goto check_timeout;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800754 }
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200755 if (in_buf[0] == SHELL_NLIP_PKT_START1 &&
756 in_buf[1] == SHELL_NLIP_PKT_START2) {
Christopher Collins92ea77f2016-12-12 15:59:26 -0800757 dec_off = 0;
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200758 rc = boot_serial_in_dec(&in_buf[2], off - 2, dec_buf, &dec_off, max_input);
759 } else if (in_buf[0] == SHELL_NLIP_DATA_START1 &&
760 in_buf[1] == SHELL_NLIP_DATA_START2) {
761 rc = boot_serial_in_dec(&in_buf[2], off - 2, dec_buf, &dec_off, max_input);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800762 }
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200763
764 /* serve errors: out of decode memory, or bad encoding */
Christopher Collins92ea77f2016-12-12 15:59:26 -0800765 if (rc == 1) {
Andrzej Puzdrowskiec1e4d12018-06-18 14:36:14 +0200766 boot_serial_input(&dec_buf[2], dec_off - 2);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800767 }
768 off = 0;
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300769check_timeout:
770 /* Subtract elapsed time */
771#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
772 elapsed_in_ms = (k_uptime_get_32() - start);
773#endif
774 timeout_in_ms -= elapsed_in_ms;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800775 }
776}
Roman Okhrimenkodc0ca082023-06-21 20:49:51 +0300777
778/*
779 * Task which waits reading console, expecting to get image over
780 * serial port.
781 */
782void
783boot_serial_start(const struct boot_uart_funcs *f)
784{
785 bs_entry = true;
786 boot_serial_read_console(f,0);
787}
788
789#ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU
790/*
791 * Task which waits reading console for a certain amount of timeout.
792 * If within this timeout no mcumgr command is received, the function is
793 * returning, else the serial boot is never exited
794 */
795void
796boot_serial_check_start(const struct boot_uart_funcs *f, int timeout_in_ms)
797{
798 bs_entry = false;
799 boot_serial_read_console(f,timeout_in_ms);
800}
801#endif