Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 1 | /* |
| 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 Utzig | 1a2e41a | 2017-11-17 12:13:09 -0200 | [diff] [blame] | 27 | #include "bootutil/bootutil_log.h" |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 28 | #include "zcbor_encode.h" |
Fabio Utzig | 1a2e41a | 2017-11-17 12:13:09 -0200 | [diff] [blame] | 29 | |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 30 | #ifdef __ZEPHYR__ |
Dominik Ermel | 1eedec3 | 2021-12-16 12:55:02 +0000 | [diff] [blame] | 31 | #include <sys/reboot.h> |
Andrzej Puzdrowski | f1d189c | 2019-12-12 09:34:11 +0100 | [diff] [blame] | 32 | #include <sys/byteorder.h> |
| 33 | #include <sys/__assert.h> |
Peter Bigot | 54c1e3f | 2020-01-25 05:50:12 -0600 | [diff] [blame] | 34 | #include <drivers/flash.h> |
Andrzej Puzdrowski | f1d189c | 2019-12-12 09:34:11 +0100 | [diff] [blame] | 35 | #include <sys/crc.h> |
| 36 | #include <sys/base64.h> |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 37 | #else |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 38 | #include <bsp/bsp.h> |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 39 | #include <hal/hal_system.h> |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 40 | #include <os/endian.h> |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 41 | #include <os/os_cputime.h> |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 42 | #include <crc/crc16.h> |
| 43 | #include <base64/base64.h> |
Andrzej Puzdrowski | 386b592 | 2018-04-06 19:26:24 +0200 | [diff] [blame] | 44 | #endif /* __ZEPHYR__ */ |
| 45 | |
Andrzej Puzdrowski | b788c71 | 2018-04-12 12:42:49 +0200 | [diff] [blame] | 46 | #include <flash_map_backend/flash_map_backend.h> |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 47 | #include <hal/hal_flash.h> |
| 48 | #include <os/os.h> |
| 49 | #include <os/os_malloc.h> |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 50 | |
| 51 | #include <bootutil/image.h> |
Andrzej Puzdrowski | f48de7a | 2020-10-19 09:42:02 +0200 | [diff] [blame] | 52 | #include <bootutil/bootutil.h> |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 53 | |
| 54 | #include "boot_serial/boot_serial.h" |
| 55 | #include "boot_serial_priv.h" |
| 56 | |
Dominik Ermel | 3d4e55d | 2021-07-09 11:14:10 +0000 | [diff] [blame] | 57 | #ifdef MCUBOOT_ERASE_PROGRESSIVELY |
Andrzej Puzdrowski | c2e30cf | 2018-07-20 16:19:09 +0200 | [diff] [blame] | 58 | #include "bootutil_priv.h" |
| 59 | #endif |
| 60 | |
Wouter Cappelle | 953a761 | 2021-05-03 16:53:05 +0200 | [diff] [blame] | 61 | #ifdef MCUBOOT_ENC_IMAGES |
| 62 | #include "single_loader.h" |
| 63 | #endif |
| 64 | |
Øyvind Rønningstad | f42a820 | 2019-12-13 03:27:54 +0100 | [diff] [blame] | 65 | #include "serial_recovery_cbor.h" |
Andrzej Puzdrowski | 4f9c730 | 2021-07-16 17:34:43 +0200 | [diff] [blame] | 66 | #include "bootutil/boot_hooks.h" |
Øyvind Rønningstad | f42a820 | 2019-12-13 03:27:54 +0100 | [diff] [blame] | 67 | |
Carlos Falgueras García | a4b4b0f | 2021-06-22 10:00:22 +0200 | [diff] [blame] | 68 | BOOT_LOG_MODULE_DECLARE(mcuboot); |
Emanuele Di Santo | 9f1933d | 2018-11-20 10:59:59 +0100 | [diff] [blame] | 69 | |
Marko Kiiskila | 149b457 | 2018-06-06 14:18:54 +0300 | [diff] [blame] | 70 | #define BOOT_SERIAL_INPUT_MAX 512 |
Andrzej Puzdrowski | c9ac5cc | 2021-11-19 11:58:05 +0100 | [diff] [blame] | 71 | #define BOOT_SERIAL_OUT_MAX (128 * BOOT_IMAGE_NUMBER) |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 72 | |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 73 | #ifdef __ZEPHYR__ |
Carles Cufi | 0165be8 | 2018-03-26 17:43:51 +0200 | [diff] [blame] | 74 | /* base64 lib encodes data to null-terminated string */ |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 75 | #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 Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 82 | #endif |
Emanuele Di Santo | 9f1933d | 2018-11-20 10:59:59 +0100 | [diff] [blame] | 83 | |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 84 | #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 Kiiskila | 149b457 | 2018-06-06 14:18:54 +0300 | [diff] [blame] | 90 | static char in_buf[BOOT_SERIAL_INPUT_MAX + 1]; |
| 91 | static char dec_buf[BOOT_SERIAL_INPUT_MAX + 1]; |
Marko Kiiskila | 8b1ce3a | 2018-06-14 13:20:46 -0700 | [diff] [blame] | 92 | const struct boot_uart_funcs *boot_uf; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 93 | static uint32_t curr_off; |
| 94 | static uint32_t img_size; |
| 95 | static struct nmgr_hdr *bs_hdr; |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 96 | static bool bs_entry; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 97 | |
| 98 | static char bs_obuf[BOOT_SERIAL_OUT_MAX]; |
| 99 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 100 | static void boot_serial_output(void); |
| 101 | |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 102 | static zcbor_state_t cbor_state[2]; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 103 | |
Dominik Ermel | 4c0f6c1 | 2022-03-04 15:47:37 +0000 | [diff] [blame] | 104 | void reset_cbor_state(void) |
| 105 | { |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 106 | zcbor_new_encode_state(cbor_state, 2, (uint8_t *)bs_obuf, |
| 107 | (size_t)bs_obuf + sizeof(bs_obuf), 0); |
Dominik Ermel | 4c0f6c1 | 2022-03-04 15:47:37 +0000 | [diff] [blame] | 108 | } |
| 109 | |
Dominik Ermel | 3d51e43 | 2021-06-25 17:29:50 +0000 | [diff] [blame] | 110 | /** |
Dominik Ermel | bd69c3d | 2021-07-28 11:27:31 +0000 | [diff] [blame] | 111 | * Function that processes MGMT_GROUP_ID_PERUSER mcumgr group and may be |
| 112 | * used to process any groups that have not been processed by generic boot |
| 113 | * serial implementation. |
Dominik Ermel | 3d51e43 | 2021-06-25 17:29:50 +0000 | [diff] [blame] | 114 | * |
| 115 | * @param[in] hdr -- the decoded header of mcumgr message; |
| 116 | * @param[in] buffer -- buffer with first mcumgr message; |
| 117 | * @param[in] len -- length of of data in buffer; |
| 118 | * @param[out] *cs -- object with encoded response. |
| 119 | * |
| 120 | * @return 0 on success; non-0 error code otherwise. |
| 121 | */ |
| 122 | extern int bs_peruser_system_specific(const struct nmgr_hdr *hdr, |
| 123 | const char *buffer, |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 124 | int len, zcbor_state_t *cs); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 125 | |
| 126 | /* |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 127 | * Convert version into string without use of snprintf(). |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 128 | */ |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 129 | static int |
| 130 | u32toa(char *tgt, uint32_t val) |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 131 | { |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 132 | char *dst; |
| 133 | uint32_t d = 1; |
| 134 | uint32_t dgt; |
| 135 | int n = 0; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 136 | |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 137 | dst = tgt; |
| 138 | while (val / d >= 10) { |
| 139 | d *= 10; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 140 | } |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 141 | while (d) { |
| 142 | dgt = val / d; |
| 143 | val %= d; |
| 144 | d /= 10; |
| 145 | if (n || dgt > 0 || d == 0) { |
| 146 | *dst++ = dgt + '0'; |
| 147 | ++n; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 148 | } |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 149 | } |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 150 | *dst = '\0'; |
| 151 | |
| 152 | return dst - tgt; |
| 153 | } |
| 154 | |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 155 | #define zcbor_tstr_put_lit_cast(state, string) \ |
| 156 | zcbor_tstr_encode_ptr(state, (uint8_t *)string, sizeof(string) - 1) |
| 157 | |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 158 | /* |
| 159 | * dst has to be able to fit "255.255.65535.4294967295" (25 characters). |
| 160 | */ |
| 161 | static void |
| 162 | bs_list_img_ver(char *dst, int maxlen, struct image_version *ver) |
| 163 | { |
| 164 | int off; |
| 165 | |
| 166 | off = u32toa(dst, ver->iv_major); |
| 167 | dst[off++] = '.'; |
| 168 | off += u32toa(dst + off, ver->iv_minor); |
| 169 | dst[off++] = '.'; |
| 170 | off += u32toa(dst + off, ver->iv_revision); |
| 171 | dst[off++] = '.'; |
| 172 | off += u32toa(dst + off, ver->iv_build_num); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 173 | } |
| 174 | |
| 175 | /* |
| 176 | * List images. |
| 177 | */ |
| 178 | static void |
| 179 | bs_list(char *buf, int len) |
| 180 | { |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 181 | struct image_header hdr; |
| 182 | uint8_t tmpbuf[64]; |
Øyvind Rønningstad | 9f4aefd | 2021-03-08 21:11:25 +0100 | [diff] [blame] | 183 | uint32_t slot, area_id; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 184 | const struct flash_area *fap; |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 185 | uint8_t image_index; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 186 | |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 187 | zcbor_map_start_encode(cbor_state, 1); |
| 188 | zcbor_tstr_put_lit_cast(cbor_state, "images"); |
| 189 | zcbor_list_start_encode(cbor_state, 5); |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 190 | image_index = 0; |
| 191 | IMAGES_ITER(image_index) { |
| 192 | for (slot = 0; slot < 2; slot++) { |
| 193 | area_id = flash_area_id_from_multi_image_slot(image_index, slot); |
| 194 | if (flash_area_open(area_id, &fap)) { |
| 195 | continue; |
| 196 | } |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 197 | |
Andrzej Puzdrowski | 4f9c730 | 2021-07-16 17:34:43 +0200 | [diff] [blame] | 198 | int rc = BOOT_HOOK_CALL(boot_read_image_header_hook, |
| 199 | BOOT_HOOK_REGULAR, image_index, slot, &hdr); |
| 200 | if (rc == BOOT_HOOK_REGULAR) |
| 201 | { |
| 202 | flash_area_read(fap, 0, &hdr, sizeof(hdr)); |
| 203 | } |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 204 | |
Andrzej Puzdrowski | 4f9c730 | 2021-07-16 17:34:43 +0200 | [diff] [blame] | 205 | fih_int fih_rc = FIH_FAILURE; |
| 206 | |
| 207 | if (hdr.ih_magic == IMAGE_MAGIC) |
| 208 | { |
| 209 | BOOT_HOOK_CALL_FIH(boot_image_check_hook, |
| 210 | fih_int_encode(BOOT_HOOK_REGULAR), |
| 211 | fih_rc, image_index, slot); |
| 212 | if (fih_eq(fih_rc, BOOT_HOOK_REGULAR)) |
| 213 | { |
Wouter Cappelle | 953a761 | 2021-05-03 16:53:05 +0200 | [diff] [blame] | 214 | #ifdef MCUBOOT_ENC_IMAGES |
| 215 | if (slot == 0 && IS_ENCRYPTED(&hdr)) { |
| 216 | /* Clear the encrypted flag we didn't supply a key |
| 217 | * This flag could be set if there was a decryption in place |
| 218 | * performed before. We will try to validate the image without |
| 219 | * decryption by clearing the flag in the heder. If |
| 220 | * still encrypted the validation will fail. |
| 221 | */ |
| 222 | hdr.ih_flags &= ~(ENCRYPTIONFLAGS); |
| 223 | } |
| 224 | #endif |
Andrzej Puzdrowski | 4f9c730 | 2021-07-16 17:34:43 +0200 | [diff] [blame] | 225 | FIH_CALL(bootutil_img_validate, fih_rc, NULL, 0, &hdr, fap, tmpbuf, sizeof(tmpbuf), |
| 226 | NULL, 0, NULL); |
| 227 | } |
| 228 | } |
| 229 | |
| 230 | flash_area_close(fap); |
| 231 | |
| 232 | if (fih_not_eq(fih_rc, FIH_SUCCESS)) { |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 233 | continue; |
| 234 | } |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 235 | |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 236 | zcbor_map_start_encode(cbor_state, 20); |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 237 | |
| 238 | #if (BOOT_IMAGE_NUMBER > 1) |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 239 | zcbor_tstr_put_lit_cast(cbor_state, "image"); |
| 240 | zcbor_uint32_put(cbor_state, image_index); |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 241 | #endif |
| 242 | |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 243 | zcbor_tstr_put_lit_cast(cbor_state, "slot"); |
| 244 | zcbor_uint32_put(cbor_state, slot); |
| 245 | zcbor_tstr_put_lit_cast(cbor_state, "version"); |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 246 | |
| 247 | bs_list_img_ver((char *)tmpbuf, sizeof(tmpbuf), &hdr.ih_ver); |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 248 | zcbor_tstr_encode_ptr(cbor_state, tmpbuf, strlen((char *)tmpbuf)); |
| 249 | zcbor_map_end_encode(cbor_state, 20); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 250 | } |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 251 | } |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 252 | zcbor_list_end_encode(cbor_state, 5); |
| 253 | zcbor_map_end_encode(cbor_state, 1); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 254 | boot_serial_output(); |
| 255 | } |
| 256 | |
| 257 | /* |
| 258 | * Image upload request. |
| 259 | */ |
| 260 | static void |
| 261 | bs_upload(char *buf, int len) |
| 262 | { |
Øyvind Rønningstad | f42a820 | 2019-12-13 03:27:54 +0100 | [diff] [blame] | 263 | const uint8_t *img_data = NULL; |
Øyvind Rønningstad | 9f4aefd | 2021-03-08 21:11:25 +0100 | [diff] [blame] | 264 | long long int off = UINT64_MAX; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 265 | size_t img_blen = 0; |
Fabio Utzig | 30f6b2a | 2018-03-29 16:18:53 -0300 | [diff] [blame] | 266 | uint8_t rem_bytes; |
Øyvind Rønningstad | 9f4aefd | 2021-03-08 21:11:25 +0100 | [diff] [blame] | 267 | long long int data_len = UINT64_MAX; |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 268 | int img_num; |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 269 | size_t slen; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 270 | const struct flash_area *fap = NULL; |
| 271 | int rc; |
Dominik Ermel | 3d4e55d | 2021-07-09 11:14:10 +0000 | [diff] [blame] | 272 | #ifdef MCUBOOT_ERASE_PROGRESSIVELY |
Emanuele Di Santo | 205c8c6 | 2018-07-20 11:42:31 +0200 | [diff] [blame] | 273 | static off_t off_last = -1; |
| 274 | struct flash_sector sector; |
| 275 | #endif |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 276 | |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 277 | img_num = 0; |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 278 | |
| 279 | /* |
| 280 | * Expected data format. |
| 281 | * { |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 282 | * "image":<image number in a multi-image set (OPTIONAL)> |
| 283 | * "data":<image data> |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 284 | * "len":<image len> |
| 285 | * "off":<current offset of image data> |
| 286 | * } |
| 287 | */ |
| 288 | |
Øyvind Rønningstad | 212a35b | 2021-05-07 21:06:48 +0200 | [diff] [blame] | 289 | struct Upload upload; |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 290 | size_t decoded_len; |
| 291 | uint_fast8_t result = cbor_decode_Upload((const uint8_t *)buf, len, &upload, &decoded_len); |
Øyvind Rønningstad | 212a35b | 2021-05-07 21:06:48 +0200 | [diff] [blame] | 292 | |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 293 | if ((result != ZCBOR_SUCCESS) || (len != decoded_len)) { |
Øyvind Rønningstad | f42a820 | 2019-12-13 03:27:54 +0100 | [diff] [blame] | 294 | goto out_invalid_data; |
| 295 | } |
Dominik Ermel | 470e2f3 | 2020-01-10 13:28:48 +0000 | [diff] [blame] | 296 | |
Øyvind Rønningstad | f42a820 | 2019-12-13 03:27:54 +0100 | [diff] [blame] | 297 | for (int i = 0; i < upload._Upload_members_count; i++) { |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 298 | struct Member_ *member = &upload._Upload_members[i]._Upload_members; |
Øyvind Rønningstad | f42a820 | 2019-12-13 03:27:54 +0100 | [diff] [blame] | 299 | switch(member->_Member_choice) { |
| 300 | case _Member_image: |
| 301 | img_num = member->_Member_image; |
| 302 | break; |
| 303 | case _Member_data: |
| 304 | img_data = member->_Member_data.value; |
| 305 | slen = member->_Member_data.len; |
| 306 | img_blen = slen; |
| 307 | break; |
| 308 | case _Member_len: |
| 309 | data_len = member->_Member_len; |
| 310 | break; |
| 311 | case _Member_off: |
| 312 | off = member->_Member_off; |
| 313 | break; |
| 314 | case _Member_sha: |
| 315 | default: |
| 316 | /* Nothing to do. */ |
| 317 | break; |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 318 | } |
| 319 | } |
Øyvind Rønningstad | f42a820 | 2019-12-13 03:27:54 +0100 | [diff] [blame] | 320 | |
Øyvind Rønningstad | 9f4aefd | 2021-03-08 21:11:25 +0100 | [diff] [blame] | 321 | if (off == UINT64_MAX || img_data == NULL) { |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 322 | /* |
| 323 | * Offset must be set in every block. |
| 324 | */ |
| 325 | goto out_invalid_data; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 326 | } |
| 327 | |
Dominik Ermel | 48decca | 2021-07-09 10:23:58 +0000 | [diff] [blame] | 328 | #if !defined(MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD) |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 329 | rc = flash_area_open(flash_area_id_from_multi_image_slot(img_num, 0), &fap); |
Dominik Ermel | 48decca | 2021-07-09 10:23:58 +0000 | [diff] [blame] | 330 | #else |
| 331 | rc = flash_area_open(flash_area_id_from_direct_image(img_num), &fap); |
| 332 | #endif |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 333 | if (rc) { |
| 334 | rc = MGMT_ERR_EINVAL; |
| 335 | goto out; |
| 336 | } |
| 337 | |
| 338 | if (off == 0) { |
| 339 | curr_off = 0; |
Dominik Ermel | 260ae09 | 2021-04-23 05:38:45 +0000 | [diff] [blame] | 340 | if (data_len > flash_area_get_size(fap)) { |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 341 | goto out_invalid_data; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 342 | } |
Wouter Cappelle | bb7a39d | 2021-05-03 16:44:44 +0200 | [diff] [blame] | 343 | #if defined(MCUBOOT_VALIDATE_PRIMARY_SLOT_ONCE) |
| 344 | /* We are using swap state at end of flash area to store validation |
| 345 | * result. Make sure the user cannot write it from an image to skip validation. |
| 346 | */ |
| 347 | if (data_len > (flash_area_get_size(fap) - BOOT_MAGIC_SZ)) { |
| 348 | goto out_invalid_data; |
| 349 | } |
| 350 | #endif |
Dominik Ermel | 3d4e55d | 2021-07-09 11:14:10 +0000 | [diff] [blame] | 351 | #ifndef MCUBOOT_ERASE_PROGRESSIVELY |
Dominik Ermel | 260ae09 | 2021-04-23 05:38:45 +0000 | [diff] [blame] | 352 | rc = flash_area_erase(fap, 0, flash_area_get_size(fap)); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 353 | if (rc) { |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 354 | goto out_invalid_data; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 355 | } |
Emanuele Di Santo | 205c8c6 | 2018-07-20 11:42:31 +0200 | [diff] [blame] | 356 | #endif |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 357 | img_size = data_len; |
| 358 | } |
| 359 | if (off != curr_off) { |
| 360 | rc = 0; |
| 361 | goto out; |
| 362 | } |
Andrzej Puzdrowski | f48de7a | 2020-10-19 09:42:02 +0200 | [diff] [blame] | 363 | |
| 364 | if (curr_off + img_blen > img_size) { |
| 365 | rc = MGMT_ERR_EINVAL; |
| 366 | goto out; |
| 367 | } |
| 368 | |
| 369 | rem_bytes = img_blen % flash_area_align(fap); |
| 370 | |
| 371 | if ((curr_off + img_blen < img_size) && rem_bytes) { |
| 372 | img_blen -= rem_bytes; |
| 373 | rem_bytes = 0; |
Fabio Utzig | 30f6b2a | 2018-03-29 16:18:53 -0300 | [diff] [blame] | 374 | } |
Emanuele Di Santo | 205c8c6 | 2018-07-20 11:42:31 +0200 | [diff] [blame] | 375 | |
Dominik Ermel | 3d4e55d | 2021-07-09 11:14:10 +0000 | [diff] [blame] | 376 | #ifdef MCUBOOT_ERASE_PROGRESSIVELY |
Emanuele Di Santo | 205c8c6 | 2018-07-20 11:42:31 +0200 | [diff] [blame] | 377 | rc = flash_area_sector_from_off(curr_off + img_blen, §or); |
| 378 | if (rc) { |
| 379 | BOOT_LOG_ERR("Unable to determine flash sector size"); |
| 380 | goto out; |
| 381 | } |
Dominik Ermel | 260ae09 | 2021-04-23 05:38:45 +0000 | [diff] [blame] | 382 | if (off_last != flash_sector_get_off(§or)) { |
| 383 | off_last = flash_sector_get_off(§or); |
| 384 | BOOT_LOG_INF("Erasing sector at offset 0x%x", flash_sector_get_off(§or)); |
| 385 | rc = flash_area_erase(fap, flash_sector_get_off(§or), |
| 386 | flash_sector_get_size(§or)); |
Emanuele Di Santo | 205c8c6 | 2018-07-20 11:42:31 +0200 | [diff] [blame] | 387 | if (rc) { |
| 388 | BOOT_LOG_ERR("Error %d while erasing sector", rc); |
| 389 | goto out; |
| 390 | } |
| 391 | } |
| 392 | #endif |
| 393 | |
| 394 | BOOT_LOG_INF("Writing at 0x%x until 0x%x", curr_off, curr_off + img_blen); |
Andrzej Puzdrowski | f48de7a | 2020-10-19 09:42:02 +0200 | [diff] [blame] | 395 | if (rem_bytes) { |
| 396 | /* the last chunk of the image might be unaligned */ |
| 397 | uint8_t wbs_aligned[BOOT_MAX_ALIGN]; |
| 398 | size_t w_size = img_blen - rem_bytes; |
| 399 | |
| 400 | if (w_size) { |
| 401 | rc = flash_area_write(fap, curr_off, img_data, w_size); |
| 402 | if (rc) { |
| 403 | goto out_invalid_data; |
| 404 | } |
| 405 | curr_off += w_size; |
| 406 | img_blen -= w_size; |
| 407 | img_data += w_size; |
| 408 | } |
| 409 | |
| 410 | if (img_blen) { |
| 411 | memcpy(wbs_aligned, img_data, rem_bytes); |
| 412 | memset(wbs_aligned + rem_bytes, flash_area_erased_val(fap), |
| 413 | sizeof(wbs_aligned) - rem_bytes); |
| 414 | rc = flash_area_write(fap, curr_off, wbs_aligned, flash_area_align(fap)); |
| 415 | } |
| 416 | |
| 417 | } else { |
| 418 | rc = flash_area_write(fap, curr_off, img_data, img_blen); |
| 419 | } |
| 420 | |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 421 | if (rc == 0) { |
| 422 | curr_off += img_blen; |
Andrzej Puzdrowski | c2e30cf | 2018-07-20 16:19:09 +0200 | [diff] [blame] | 423 | if (curr_off == img_size) { |
Andrzej Puzdrowski | 4f9c730 | 2021-07-16 17:34:43 +0200 | [diff] [blame] | 424 | #ifdef MCUBOOT_ERASE_PROGRESSIVELY |
Andrzej Puzdrowski | c2e30cf | 2018-07-20 16:19:09 +0200 | [diff] [blame] | 425 | /* get the last sector offset */ |
| 426 | rc = flash_area_sector_from_off(boot_status_off(fap), §or); |
| 427 | if (rc) { |
| 428 | BOOT_LOG_ERR("Unable to determine flash sector of" |
| 429 | "the image trailer"); |
| 430 | goto out; |
| 431 | } |
| 432 | /* Assure that sector for image trailer was erased. */ |
| 433 | /* Check whether it was erased during previous upload. */ |
Dominik Ermel | 260ae09 | 2021-04-23 05:38:45 +0000 | [diff] [blame] | 434 | if (off_last < flash_sector_get_off(§or)) { |
| 435 | BOOT_LOG_INF("Erasing sector at offset 0x%x", |
| 436 | flash_sector_get_off(§or)); |
| 437 | rc = flash_area_erase(fap, flash_sector_get_off(§or), |
| 438 | flash_sector_get_size(§or)); |
Andrzej Puzdrowski | c2e30cf | 2018-07-20 16:19:09 +0200 | [diff] [blame] | 439 | if (rc) { |
| 440 | BOOT_LOG_ERR("Error %d while erasing sector", rc); |
| 441 | goto out; |
| 442 | } |
| 443 | } |
Andrzej Puzdrowski | c2e30cf | 2018-07-20 16:19:09 +0200 | [diff] [blame] | 444 | #endif |
Andrzej Puzdrowski | 4f9c730 | 2021-07-16 17:34:43 +0200 | [diff] [blame] | 445 | rc = BOOT_HOOK_CALL(boot_serial_uploaded_hook, 0, img_num, fap, |
| 446 | img_size); |
| 447 | if (rc) { |
| 448 | BOOT_LOG_ERR("Error %d post upload hook", rc); |
| 449 | goto out; |
| 450 | } |
| 451 | } |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 452 | } else { |
| 453 | out_invalid_data: |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 454 | rc = MGMT_ERR_EINVAL; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 455 | } |
Emanuele Di Santo | 205c8c6 | 2018-07-20 11:42:31 +0200 | [diff] [blame] | 456 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 457 | out: |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 458 | BOOT_LOG_INF("RX: 0x%x", rc); |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 459 | zcbor_map_start_encode(cbor_state, 10); |
| 460 | zcbor_tstr_put_lit_cast(cbor_state, "rc"); |
| 461 | zcbor_uint32_put(cbor_state, rc); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 462 | if (rc == 0) { |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 463 | zcbor_tstr_put_lit_cast(cbor_state, "off"); |
| 464 | zcbor_uint32_put(cbor_state, curr_off); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 465 | } |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 466 | zcbor_map_end_encode(cbor_state, 10); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 467 | |
| 468 | boot_serial_output(); |
| 469 | flash_area_close(fap); |
Wouter Cappelle | 953a761 | 2021-05-03 16:53:05 +0200 | [diff] [blame] | 470 | |
| 471 | #ifdef MCUBOOT_ENC_IMAGES |
| 472 | if (curr_off == img_size) { |
| 473 | /* Last sector received, now start a decryption on the image if it is encrypted*/ |
| 474 | rc = boot_handle_enc_fw(); |
| 475 | } |
| 476 | #endif //#ifdef MCUBOOT_ENC_IMAGES |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 477 | } |
| 478 | |
Dominik Ermel | 4c0f6c1 | 2022-03-04 15:47:37 +0000 | [diff] [blame] | 479 | /* |
| 480 | * Send rc code only. |
| 481 | */ |
| 482 | static void |
| 483 | bs_rc_rsp(int rc_code) |
| 484 | { |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 485 | zcbor_map_start_encode(cbor_state, 10); |
| 486 | zcbor_tstr_put_lit_cast(cbor_state, "rc"); |
| 487 | zcbor_uint32_put(cbor_state, rc_code); |
| 488 | zcbor_map_end_encode(cbor_state, 10); |
Dominik Ermel | 4c0f6c1 | 2022-03-04 15:47:37 +0000 | [diff] [blame] | 489 | boot_serial_output(); |
| 490 | } |
| 491 | |
| 492 | |
Wouter Cappelle | e3ff175 | 2021-05-03 16:36:22 +0200 | [diff] [blame] | 493 | #ifdef MCUBOOT_BOOT_MGMT_ECHO |
| 494 | static bool |
| 495 | decode_echo(cbor_state_t *state, cbor_string_type_t *result) |
| 496 | { |
| 497 | size_t bsstrdecoded; |
| 498 | int ret; |
| 499 | |
| 500 | if (!map_start_decode(state)) { |
| 501 | return false; |
| 502 | } |
| 503 | ret = multi_decode(2, 2, &bsstrdecoded, (void *)tstrx_decode, state, result, sizeof(cbor_string_type_t)); |
| 504 | map_end_decode(state); |
| 505 | return ret; |
| 506 | } |
| 507 | |
| 508 | |
| 509 | static void |
| 510 | bs_echo(char *buf, int len) |
| 511 | { |
| 512 | size_t bsstrdecoded; |
| 513 | cbor_string_type_t str[2]; |
| 514 | |
| 515 | if (entry_function((const uint8_t *)buf, len, str, &bsstrdecoded, (void *)decode_echo, 1, 2)) { |
| 516 | map_start_encode(&cbor_state, 10); |
| 517 | tstrx_put(&cbor_state, "r"); |
Dominik Ermel | 4c0f6c1 | 2022-03-04 15:47:37 +0000 | [diff] [blame] | 518 | if (tstrx_encode(&cbor_state, &str[1]) && map_end_encode(&cbor_state, 10)) { |
| 519 | boot_serial_output(); |
| 520 | } else { |
| 521 | reset_cbor_state(); |
| 522 | bs_rc_rsp(MGMT_ERR_ENOMEM); |
| 523 | } |
Wouter Cappelle | e3ff175 | 2021-05-03 16:36:22 +0200 | [diff] [blame] | 524 | } |
| 525 | } |
| 526 | #endif |
| 527 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 528 | /* |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 529 | * Reset, and (presumably) boot to newly uploaded image. Flush console |
| 530 | * before restarting. |
| 531 | */ |
Andrzej Puzdrowski | 268cdd0 | 2018-04-10 12:57:54 +0200 | [diff] [blame] | 532 | static void |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 533 | bs_reset(char *buf, int len) |
| 534 | { |
Dominik Ermel | c9dc224 | 2021-07-28 17:08:23 +0000 | [diff] [blame] | 535 | bs_rc_rsp(0); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 536 | |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 537 | #ifdef __ZEPHYR__ |
Andrzej Puzdrowski | 0cf0dbd | 2021-05-14 11:55:57 +0200 | [diff] [blame] | 538 | #ifdef CONFIG_MULTITHREADING |
Carles Cufi | 7e7b4ad | 2020-03-30 19:12:02 +0200 | [diff] [blame] | 539 | k_sleep(K_MSEC(250)); |
Andrzej Puzdrowski | 0cf0dbd | 2021-05-14 11:55:57 +0200 | [diff] [blame] | 540 | #else |
| 541 | k_busy_wait(250000); |
| 542 | #endif |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 543 | sys_reboot(SYS_REBOOT_COLD); |
| 544 | #else |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 545 | os_cputime_delay_usecs(250000); |
| 546 | hal_system_reset(); |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 547 | #endif |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 548 | } |
| 549 | |
| 550 | /* |
| 551 | * Parse incoming line of input from console. |
| 552 | * Expect newtmgr protocol with serial transport. |
| 553 | */ |
| 554 | void |
| 555 | boot_serial_input(char *buf, int len) |
| 556 | { |
| 557 | struct nmgr_hdr *hdr; |
| 558 | |
| 559 | hdr = (struct nmgr_hdr *)buf; |
| 560 | if (len < sizeof(*hdr) || |
| 561 | (hdr->nh_op != NMGR_OP_READ && hdr->nh_op != NMGR_OP_WRITE) || |
| 562 | (ntohs(hdr->nh_len) < len - sizeof(*hdr))) { |
| 563 | return; |
| 564 | } |
| 565 | bs_hdr = hdr; |
| 566 | hdr->nh_group = ntohs(hdr->nh_group); |
| 567 | |
| 568 | buf += sizeof(*hdr); |
| 569 | len -= sizeof(*hdr); |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 570 | |
Dominik Ermel | 4c0f6c1 | 2022-03-04 15:47:37 +0000 | [diff] [blame] | 571 | reset_cbor_state(); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 572 | |
| 573 | /* |
| 574 | * Limited support for commands. |
| 575 | */ |
| 576 | if (hdr->nh_group == MGMT_GROUP_ID_IMAGE) { |
| 577 | switch (hdr->nh_id) { |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 578 | case IMGMGR_NMGR_ID_STATE: |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 579 | bs_list(buf, len); |
| 580 | break; |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 581 | case IMGMGR_NMGR_ID_UPLOAD: |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 582 | bs_upload(buf, len); |
| 583 | break; |
| 584 | default: |
Dominik Ermel | c9dc224 | 2021-07-28 17:08:23 +0000 | [diff] [blame] | 585 | bs_rc_rsp(MGMT_ERR_ENOTSUP); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 586 | break; |
| 587 | } |
| 588 | } else if (hdr->nh_group == MGMT_GROUP_ID_DEFAULT) { |
| 589 | switch (hdr->nh_id) { |
Wouter Cappelle | e3ff175 | 2021-05-03 16:36:22 +0200 | [diff] [blame] | 590 | case NMGR_ID_ECHO: |
| 591 | #ifdef MCUBOOT_BOOT_MGMT_ECHO |
| 592 | bs_echo(buf, len); |
| 593 | #endif |
| 594 | break; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 595 | case NMGR_ID_CONS_ECHO_CTRL: |
Dominik Ermel | c9dc224 | 2021-07-28 17:08:23 +0000 | [diff] [blame] | 596 | bs_rc_rsp(0); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 597 | break; |
| 598 | case NMGR_ID_RESET: |
| 599 | bs_reset(buf, len); |
| 600 | break; |
| 601 | default: |
Dominik Ermel | c9dc224 | 2021-07-28 17:08:23 +0000 | [diff] [blame] | 602 | bs_rc_rsp(MGMT_ERR_ENOTSUP); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 603 | break; |
| 604 | } |
Dominik Ermel | bd69c3d | 2021-07-28 11:27:31 +0000 | [diff] [blame] | 605 | } else if (MCUBOOT_PERUSER_MGMT_GROUP_ENABLED == 1) { |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 606 | if (bs_peruser_system_specific(hdr, buf, len, cbor_state) == 0) { |
Dominik Ermel | 3d51e43 | 2021-06-25 17:29:50 +0000 | [diff] [blame] | 607 | boot_serial_output(); |
| 608 | } |
Dominik Ermel | c9dc224 | 2021-07-28 17:08:23 +0000 | [diff] [blame] | 609 | } else { |
| 610 | bs_rc_rsp(MGMT_ERR_ENOTSUP); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 611 | } |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 612 | #ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU |
| 613 | bs_entry = true; |
| 614 | #endif |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 615 | } |
| 616 | |
| 617 | static void |
| 618 | boot_serial_output(void) |
| 619 | { |
| 620 | char *data; |
| 621 | int len; |
| 622 | uint16_t crc; |
| 623 | uint16_t totlen; |
| 624 | char pkt_start[2] = { SHELL_NLIP_PKT_START1, SHELL_NLIP_PKT_START2 }; |
Dominik Ermel | 5ff8958 | 2022-03-03 17:09:07 +0000 | [diff] [blame] | 625 | char buf[BOOT_SERIAL_OUT_MAX + sizeof(*bs_hdr) + sizeof(crc) + sizeof(totlen)]; |
| 626 | char encoded_buf[BASE64_ENCODE_SIZE(sizeof(buf))]; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 627 | |
| 628 | data = bs_obuf; |
Øyvind Rønningstad | a7d34ca | 2022-02-28 13:47:57 +0100 | [diff] [blame] | 629 | len = (uint32_t)cbor_state->payload_mut - (uint32_t)bs_obuf; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 630 | |
| 631 | bs_hdr->nh_op++; |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 632 | bs_hdr->nh_flags = 0; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 633 | bs_hdr->nh_len = htons(len); |
| 634 | bs_hdr->nh_group = htons(bs_hdr->nh_group); |
| 635 | |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 636 | #ifdef __ZEPHYR__ |
Carles Cufi | b9192a4 | 2022-02-10 11:41:57 +0100 | [diff] [blame] | 637 | crc = crc16_itu_t(CRC16_INITIAL_CRC, (uint8_t *)bs_hdr, sizeof(*bs_hdr)); |
| 638 | crc = crc16_itu_t(crc, data, len); |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 639 | #else |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 640 | crc = crc16_ccitt(CRC16_INITIAL_CRC, bs_hdr, sizeof(*bs_hdr)); |
| 641 | crc = crc16_ccitt(crc, data, len); |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 642 | #endif |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 643 | crc = htons(crc); |
| 644 | |
Marko Kiiskila | 149b457 | 2018-06-06 14:18:54 +0300 | [diff] [blame] | 645 | boot_uf->write(pkt_start, sizeof(pkt_start)); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 646 | |
| 647 | totlen = len + sizeof(*bs_hdr) + sizeof(crc); |
| 648 | totlen = htons(totlen); |
| 649 | |
| 650 | memcpy(buf, &totlen, sizeof(totlen)); |
| 651 | totlen = sizeof(totlen); |
| 652 | memcpy(&buf[totlen], bs_hdr, sizeof(*bs_hdr)); |
| 653 | totlen += sizeof(*bs_hdr); |
| 654 | memcpy(&buf[totlen], data, len); |
| 655 | totlen += len; |
| 656 | memcpy(&buf[totlen], &crc, sizeof(crc)); |
| 657 | totlen += sizeof(crc); |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 658 | #ifdef __ZEPHYR__ |
| 659 | size_t enc_len; |
Carles Cufi | 0165be8 | 2018-03-26 17:43:51 +0200 | [diff] [blame] | 660 | base64_encode(encoded_buf, sizeof(encoded_buf), &enc_len, buf, totlen); |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 661 | totlen = enc_len; |
| 662 | #else |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 663 | totlen = base64_encode(buf, totlen, encoded_buf, 1); |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 664 | #endif |
Marko Kiiskila | 149b457 | 2018-06-06 14:18:54 +0300 | [diff] [blame] | 665 | boot_uf->write(encoded_buf, totlen); |
| 666 | boot_uf->write("\n\r", 2); |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 667 | BOOT_LOG_INF("TX"); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 668 | } |
| 669 | |
| 670 | /* |
| 671 | * Returns 1 if full packet has been received. |
| 672 | */ |
| 673 | static int |
| 674 | boot_serial_in_dec(char *in, int inlen, char *out, int *out_off, int maxout) |
| 675 | { |
| 676 | int rc; |
| 677 | uint16_t crc; |
| 678 | uint16_t len; |
Marko Kiiskila | e5aeee4 | 2018-12-21 15:00:16 +0200 | [diff] [blame] | 679 | |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 680 | #ifdef __ZEPHYR__ |
| 681 | int err; |
Andrzej Puzdrowski | ec1e4d1 | 2018-06-18 14:36:14 +0200 | [diff] [blame] | 682 | err = base64_decode( &out[*out_off], maxout - *out_off, &rc, in, inlen - 2); |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 683 | if (err) { |
| 684 | return -1; |
| 685 | } |
| 686 | #else |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 687 | if (*out_off + base64_decode_len(in) >= maxout) { |
| 688 | return -1; |
| 689 | } |
| 690 | rc = base64_decode(in, &out[*out_off]); |
| 691 | if (rc < 0) { |
| 692 | return -1; |
| 693 | } |
Andrzej Puzdrowski | 8e96b83 | 2017-09-08 16:49:14 +0200 | [diff] [blame] | 694 | #endif |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 695 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 696 | *out_off += rc; |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 697 | if (*out_off <= sizeof(uint16_t)) { |
| 698 | return 0; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 699 | } |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 700 | |
| 701 | len = ntohs(*(uint16_t *)out); |
| 702 | if (len != *out_off - sizeof(uint16_t)) { |
| 703 | return 0; |
| 704 | } |
| 705 | |
| 706 | if (len > *out_off - sizeof(uint16_t)) { |
| 707 | len = *out_off - sizeof(uint16_t); |
| 708 | } |
| 709 | |
| 710 | out += sizeof(uint16_t); |
| 711 | #ifdef __ZEPHYR__ |
Carles Cufi | b9192a4 | 2022-02-10 11:41:57 +0100 | [diff] [blame] | 712 | crc = crc16_itu_t(CRC16_INITIAL_CRC, out, len); |
Fabio Utzig | 6f49c27 | 2019-08-23 11:42:58 -0300 | [diff] [blame] | 713 | #else |
| 714 | crc = crc16_ccitt(CRC16_INITIAL_CRC, out, len); |
| 715 | #endif |
| 716 | if (crc || len <= sizeof(crc)) { |
| 717 | return 0; |
| 718 | } |
| 719 | *out_off -= sizeof(crc); |
| 720 | out[*out_off] = '\0'; |
| 721 | |
| 722 | return 1; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 723 | } |
| 724 | |
| 725 | /* |
| 726 | * Task which waits reading console, expecting to get image over |
| 727 | * serial port. |
| 728 | */ |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 729 | static void |
| 730 | boot_serial_read_console(const struct boot_uart_funcs *f,int timeout_in_ms) |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 731 | { |
| 732 | int rc; |
| 733 | int off; |
David Brown | 57f0df3 | 2020-05-12 08:39:21 -0600 | [diff] [blame] | 734 | int dec_off = 0; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 735 | int full_line; |
Marko Kiiskila | 149b457 | 2018-06-06 14:18:54 +0300 | [diff] [blame] | 736 | int max_input; |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 737 | int elapsed_in_ms = 0; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 738 | |
Marko Kiiskila | 149b457 | 2018-06-06 14:18:54 +0300 | [diff] [blame] | 739 | boot_uf = f; |
Marko Kiiskila | 149b457 | 2018-06-06 14:18:54 +0300 | [diff] [blame] | 740 | max_input = sizeof(in_buf); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 741 | |
| 742 | off = 0; |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 743 | while (timeout_in_ms > 0 || bs_entry) { |
Andrzej Puzdrowski | aea38eb | 2021-06-11 12:28:59 +0200 | [diff] [blame] | 744 | MCUBOOT_CPU_IDLE(); |
Hein Wessels | 56d28f0 | 2021-11-19 08:42:08 +0100 | [diff] [blame] | 745 | MCUBOOT_WATCHDOG_FEED(); |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 746 | #ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU |
| 747 | uint32_t start = k_uptime_get_32(); |
| 748 | #endif |
Andrzej Puzdrowski | ec1e4d1 | 2018-06-18 14:36:14 +0200 | [diff] [blame] | 749 | rc = f->read(in_buf + off, sizeof(in_buf) - off, &full_line); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 750 | if (rc <= 0 && !full_line) { |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 751 | goto check_timeout; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 752 | } |
| 753 | off += rc; |
| 754 | if (!full_line) { |
Marko Kiiskila | ce50ab0 | 2018-06-06 11:33:33 +0300 | [diff] [blame] | 755 | if (off == max_input) { |
| 756 | /* |
| 757 | * Full line, no newline yet. Reset the input buffer. |
| 758 | */ |
| 759 | off = 0; |
| 760 | } |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 761 | goto check_timeout; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 762 | } |
Andrzej Puzdrowski | ec1e4d1 | 2018-06-18 14:36:14 +0200 | [diff] [blame] | 763 | if (in_buf[0] == SHELL_NLIP_PKT_START1 && |
| 764 | in_buf[1] == SHELL_NLIP_PKT_START2) { |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 765 | dec_off = 0; |
Andrzej Puzdrowski | ec1e4d1 | 2018-06-18 14:36:14 +0200 | [diff] [blame] | 766 | rc = boot_serial_in_dec(&in_buf[2], off - 2, dec_buf, &dec_off, max_input); |
| 767 | } else if (in_buf[0] == SHELL_NLIP_DATA_START1 && |
| 768 | in_buf[1] == SHELL_NLIP_DATA_START2) { |
| 769 | rc = boot_serial_in_dec(&in_buf[2], off - 2, dec_buf, &dec_off, max_input); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 770 | } |
Andrzej Puzdrowski | ec1e4d1 | 2018-06-18 14:36:14 +0200 | [diff] [blame] | 771 | |
| 772 | /* serve errors: out of decode memory, or bad encoding */ |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 773 | if (rc == 1) { |
Andrzej Puzdrowski | ec1e4d1 | 2018-06-18 14:36:14 +0200 | [diff] [blame] | 774 | boot_serial_input(&dec_buf[2], dec_off - 2); |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 775 | } |
| 776 | off = 0; |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 777 | check_timeout: |
| 778 | /* Subtract elapsed time */ |
| 779 | #ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU |
| 780 | elapsed_in_ms = (k_uptime_get_32() - start); |
| 781 | #endif |
| 782 | timeout_in_ms -= elapsed_in_ms; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 783 | } |
| 784 | } |
Wouter Cappelle | e3822f8 | 2022-01-19 15:39:43 +0100 | [diff] [blame] | 785 | |
| 786 | /* |
| 787 | * Task which waits reading console, expecting to get image over |
| 788 | * serial port. |
| 789 | */ |
| 790 | void |
| 791 | boot_serial_start(const struct boot_uart_funcs *f) |
| 792 | { |
| 793 | bs_entry = true; |
| 794 | boot_serial_read_console(f,0); |
| 795 | } |
| 796 | |
| 797 | #ifdef MCUBOOT_SERIAL_WAIT_FOR_DFU |
| 798 | /* |
| 799 | * Task which waits reading console for a certain amount of timeout. |
| 800 | * If within this timeout no mcumgr command is received, the function is |
| 801 | * returning, else the serial boot is never exited |
| 802 | */ |
| 803 | void |
| 804 | boot_serial_check_start(const struct boot_uart_funcs *f, int timeout_in_ms) |
| 805 | { |
| 806 | bs_entry = false; |
| 807 | boot_serial_read_console(f,timeout_in_ms); |
| 808 | } |
| 809 | #endif |