David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [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 |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 9 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 10 | http://www.apache.org/licenses/LICENSE-2.0 |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 11 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 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 | |
| 20 | # Boot Loader |
| 21 | |
| 22 | ## Summary |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 23 | |
Fabio Utzig | ac83496 | 2017-07-20 13:20:48 -0300 | [diff] [blame] | 24 | mcuboot comprises two packages: |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 25 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 26 | * The bootutil library (boot/bootutil) |
| 27 | * The boot application (each port has its own at boot/<port>) |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 28 | |
| 29 | The bootutil library performs most of the functions of a boot loader. In |
| 30 | particular, the piece that is missing is the final step of actually jumping to |
| 31 | the main image. This last step is instead implemented by the boot application. |
| 32 | Boot loader functionality is separated in this manner to enable unit testing of |
| 33 | the boot loader. A library can be unit tested, but an application can't. |
| 34 | Therefore, functionality is delegated to the bootutil library when possible. |
| 35 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 36 | ## Limitations |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 37 | |
| 38 | The boot loader currently only supports images with the following |
| 39 | characteristics: |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 40 | * Built to run from flash. |
| 41 | * Built to run from a fixed location (i.e., not position-independent). |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 42 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 43 | ## Image Format |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 44 | |
| 45 | The following definitions describe the image format. |
| 46 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 47 | ``` c |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 48 | #define IMAGE_MAGIC 0x96f3b83d |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 49 | |
| 50 | #define IMAGE_HEADER_SIZE 32 |
| 51 | |
| 52 | struct image_version { |
| 53 | uint8_t iv_major; |
| 54 | uint8_t iv_minor; |
| 55 | uint16_t iv_revision; |
| 56 | uint32_t iv_build_num; |
| 57 | }; |
| 58 | |
| 59 | /** Image header. All fields are in little endian byte order. */ |
| 60 | struct image_header { |
| 61 | uint32_t ih_magic; |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 62 | uint32_t ih_load_addr; |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 63 | uint16_t ih_hdr_size; /* Size of image header (bytes). */ |
| 64 | uint16_t _pad2; |
| 65 | uint32_t ih_img_size; /* Does not include header. */ |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 66 | uint32_t ih_flags; /* IMAGE_F_[...]. */ |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 67 | struct image_version ih_ver; |
| 68 | uint32_t _pad3; |
| 69 | }; |
| 70 | |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 71 | /** Image TLV header. All fields in little endian. */ |
| 72 | struct image_tlv_info { |
| 73 | uint16_t it_magic; |
| 74 | uint16_t it_tlv_tot; /* size of TLV area (including tlv_info header) */ |
| 75 | }; |
| 76 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 77 | /** Image trailer TLV format. All fields in little endian. */ |
| 78 | struct image_tlv { |
| 79 | uint8_t it_type; /* IMAGE_TLV_[...]. */ |
| 80 | uint8_t _pad; |
Marti Bolivar | 49b2917 | 2017-08-04 14:50:51 -0400 | [diff] [blame] | 81 | uint16_t it_len; /* Data length (not including TLV header). */ |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 82 | }; |
| 83 | |
| 84 | /* |
| 85 | * Image header flags. |
| 86 | */ |
Marti Bolivar | 7c057e9 | 2017-08-04 14:46:39 -0400 | [diff] [blame] | 87 | #define IMAGE_F_PIC 0x00000001 /* Not supported. */ |
Marti Bolivar | 7c057e9 | 2017-08-04 14:46:39 -0400 | [diff] [blame] | 88 | #define IMAGE_F_NON_BOOTABLE 0x00000010 /* Split image app. */ |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 89 | #define IMAGE_F_RAM_LOAD 0x00000020 |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 90 | |
| 91 | /* |
| 92 | * Image trailer TLV types. |
| 93 | */ |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 94 | #define IMAGE_TLV_KEYHASH 0x01 /* hash of the public key */ |
David Brown | 27648b8 | 2017-08-31 10:40:29 -0600 | [diff] [blame] | 95 | #define IMAGE_TLV_SHA256 0x10 /* SHA256 of image hdr and body */ |
Marko Kiiskila | 8dd56f3 | 2017-08-22 21:40:49 -0700 | [diff] [blame] | 96 | #define IMAGE_TLV_RSA2048_PSS 0x20 /* RSA2048 of hash output */ |
David Brown | 27648b8 | 2017-08-31 10:40:29 -0600 | [diff] [blame] | 97 | #define IMAGE_TLV_ECDSA224 0x21 /* ECDSA of hash output */ |
| 98 | #define IMAGE_TLV_ECDSA256 0x22 /* ECDSA of hash output */ |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 99 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 100 | |
| 101 | Optional type-length-value records (TLVs) containing image metadata are placed |
| 102 | after the end of the image. |
| 103 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 104 | The `ih_hdr_size` field indicates the length of the header, and therefore the |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 105 | offset of the image itself. This field provides for backwards compatibility in |
| 106 | case of changes to the format of the image header. |
| 107 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 108 | ## Flash Map |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 109 | |
Fabio Utzig | ac83496 | 2017-07-20 13:20:48 -0300 | [diff] [blame] | 110 | A device's flash is partitioned according to its _flash map_. At a high |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 111 | level, the flash map maps numeric IDs to _flash areas_. A flash area is a |
| 112 | region of disk with the following properties: |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 113 | 1. An area can be fully erased without affecting any other areas. |
| 114 | 2. A write to one area does not restrict writes to other areas. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 115 | |
Marti Bolivar | 4e64d56 | 2017-08-04 14:53:33 -0400 | [diff] [blame] | 116 | The boot loader uses the following flash area IDs: |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 117 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 118 | ``` c |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 119 | #define FLASH_AREA_BOOTLOADER 0 |
| 120 | #define FLASH_AREA_IMAGE_0 1 |
| 121 | #define FLASH_AREA_IMAGE_1 2 |
| 122 | #define FLASH_AREA_IMAGE_SCRATCH 3 |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 123 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 124 | |
Marti Bolivar | 4e64d56 | 2017-08-04 14:53:33 -0400 | [diff] [blame] | 125 | The bootloader area contains the bootloader image itself. The other areas are |
| 126 | described in subsequent sections. |
| 127 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 128 | ## Image Slots |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 129 | |
| 130 | A portion of the flash memory is partitioned into two image slots: a primary |
| 131 | slot (0) and a secondary slot (1). The boot loader will only run an image from |
| 132 | the primary slot, so images must be built such that they can run from that |
| 133 | fixed location in flash. If the boot loader needs to run the image resident in |
Marti Bolivar | a91674f | 2017-08-04 14:56:08 -0400 | [diff] [blame] | 134 | the secondary slot, it must copy its contents into the primary slot before doing |
| 135 | so, either by swapping the two images or by overwriting the contents of the |
| 136 | primary slot. The bootloader supports either swap- or overwrite-based image |
| 137 | upgrades, but must be configured at build time to choose one of these two |
| 138 | strategies. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 139 | |
| 140 | In addition to the two image slots, the boot loader requires a scratch area to |
| 141 | allow for reliable image swapping. |
| 142 | |
Marti Bolivar | a91674f | 2017-08-04 14:56:08 -0400 | [diff] [blame] | 143 | The overwrite upgrade strategy is substantially simpler to implement than the |
| 144 | image swapping strategy, especially since the bootloader must work properly |
| 145 | even when it is reset during the middle of an image swap. For this reason, the |
| 146 | rest of the document describes its behavior when configured to swap images |
| 147 | during an upgrade. |
| 148 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 149 | ## Boot Swap Types |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 150 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 151 | When the device first boots under normal circumstances, there is an up-to-date |
| 152 | firmware image in slot 0, which mcuboot can validate and then chain-load. In |
| 153 | this case, no image swaps are necessary. During device upgrades, however, new |
| 154 | candidate images are present in slot 1, which mcuboot must swap into slot 0 |
| 155 | before booting as discussed above. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 156 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 157 | Upgrading an old image with a new one by swapping can be a two-step process. In |
| 158 | this process, mcuboot performs a "test" swap of image data in flash and boots |
| 159 | the new image. The new image can then update the contents of flash at runtime |
| 160 | to mark itself "OK", and mcuboot will then still choose to run it during the |
| 161 | next boot. When this happens, the swap is made "permanent". If this doesn't |
| 162 | happen, mcuboot will perform a "revert" swap during the next boot by swapping |
| 163 | the images back into their original locations, and attempting to boot the old |
| 164 | image. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 165 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 166 | Depending on the use case, the first swap can also be made permanent directly. |
| 167 | In this case, mcuboot will never attempt to revert the images on the next reset. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 168 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 169 | Test swaps are supported to provide a rollback mechanism to prevent devices |
| 170 | from becoming "bricked" by bad firmware. If the device crashes immediately |
| 171 | upon booting a new (bad) image, mcuboot will revert to the old (working) image |
| 172 | at the next device reset, rather than booting the bad image again. This allows |
| 173 | device firmware to make test swaps permanent only after performing a self-test |
| 174 | routine. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 175 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 176 | On startup, mcuboot inspects the contents of flash to decide which of these |
| 177 | "swap types" to perform; this decision determines how it proceeds. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 178 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 179 | The possible swap types, and their meanings, are: |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 180 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 181 | - `BOOT_SWAP_TYPE_NONE`: The "usual" or "no upgrade" case; attempt to boot the |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 182 | contents of slot 0. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 183 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 184 | - `BOOT_SWAP_TYPE_TEST`: Boot the contents of slot 1 by swapping images. Unless |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 185 | the swap is made permanent, revert back on the next boot. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 186 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 187 | - `BOOT_SWAP_TYPE_PERM`: Permanently swap images, and boot the upgraded image |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 188 | firmware. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 189 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 190 | - `BOOT_SWAP_TYPE_REVERT`: A previous test swap was not made permanent; swap back |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 191 | to the old image whose data are now in slot 1. If the old image marks itself |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 192 | "OK" when it boots, the next boot will have swap type `BOOT_SWAP_TYPE_NONE`. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 193 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 194 | - `BOOT_SWAP_TYPE_FAIL`: Swap failed because image to be run is not valid. |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 195 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 196 | - `BOOT_SWAP_TYPE_PANIC`: Swapping encountered an unrecoverable error. |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 197 | |
| 198 | The "swap type" is a high-level representation of the outcome of the |
| 199 | boot. Subsequent sections describe how mcuboot determines the swap type from |
| 200 | the bit-level contents of flash. |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 201 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 202 | ## Image Trailer |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 203 | |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 204 | For the bootloader to be able to determine the current state and what actions |
Marti Bolivar | 4281803 | 2017-08-04 15:45:01 -0400 | [diff] [blame] | 205 | should be taken during the current boot operation, it uses metadata stored in |
| 206 | the image flash areas. While swapping, some of this metadata is temporarily |
| 207 | copied into and out of the scratch area. |
| 208 | |
| 209 | This metadata is located at the end of the image flash areas, and is called an |
| 210 | image trailer. An image trailer has the following structure: |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 211 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 212 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 213 | 0 1 2 3 |
| 214 | 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 |
| 215 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 216 | ~ ~ |
| 217 | ~ Swap status (128 * min-write-size * 3) ~ |
| 218 | ~ ~ |
| 219 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 220 | | Swap size | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 221 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 222 | | 0xff padding (4 octets) | |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 223 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 224 | | Copy done | 0xff padding (7 octets) ~ |
| 225 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 226 | | Image OK | 0xff padding (7 octets) ~ |
| 227 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 228 | ~ MAGIC (16 octets) ~ |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 229 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 230 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 231 | |
Marti Bolivar | 4281803 | 2017-08-04 15:45:01 -0400 | [diff] [blame] | 232 | The offset immediately following such a record represents the start of the next |
| 233 | flash area. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 234 | |
| 235 | Note: "min-write-size" is a property of the flash hardware. If the hardware |
| 236 | allows individual bytes to be written at arbitrary addresses, then |
| 237 | min-write-size is 1. If the hardware only allows writes at even addresses, |
| 238 | then min-write-size is 2, and so on. |
| 239 | |
Marti Bolivar | 1dcb685 | 2017-08-04 15:59:32 -0400 | [diff] [blame] | 240 | An image trailer contains the following fields: |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 241 | |
Marti Bolivar | 1dcb685 | 2017-08-04 15:59:32 -0400 | [diff] [blame] | 242 | 1. Swap status: A series of records which records the progress of an image |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 243 | swap. To swap entire images, data are swapped between the two image areas one |
| 244 | or more sectors at a time, like this: |
Marti Bolivar | 1dcb685 | 2017-08-04 15:59:32 -0400 | [diff] [blame] | 245 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 246 | - sector data in slot 0 is copied into scratch, then erased |
| 247 | - sector data in slot 1 is copied into slot 0, then erased |
| 248 | - sector data in scratch is copied into slot 1 |
Marti Bolivar | 1dcb685 | 2017-08-04 15:59:32 -0400 | [diff] [blame] | 249 | |
| 250 | As it swaps images, the bootloader updates the swap status field in a way that |
| 251 | allows it to compute how far this swap operation has progressed for each |
| 252 | sector. The swap status field can thus used to resume a swap operation if the |
| 253 | bootloader is halted while a swap operation is ongoing and later reset. The |
| 254 | factor of 128 is the maximum number of sectors mcuboot supports for each image; |
| 255 | its value is a bootloader design decision. The factor of min-write-sz is due to |
| 256 | the behavior of flash hardware. The factor of 3 is explained below. |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 257 | |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 258 | 2. Swap size: When beginning a new swap operation, the total size that needs |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 259 | to be swapped (based on the slot with largest image + tlvs) is written to this |
| 260 | location for easier recovery in case of a reset while performing the swap. |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 261 | |
| 262 | 3. Copy done: A single byte indicating whether the image in this slot is |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 263 | complete (0x01=done; 0xff=not done). |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 264 | |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 265 | 4. Image OK: A single byte indicating whether the image in this slot has been |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 266 | confirmed as good by the user (0x01=confirmed; 0xff=not confirmed). |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 267 | |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 268 | 5. MAGIC: The following 16 bytes, written in host-byte-order: |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 269 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 270 | ``` c |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 271 | const uint32_t boot_img_magic[4] = { |
| 272 | 0xf395c277, |
| 273 | 0x7fefd260, |
| 274 | 0x0f505235, |
| 275 | 0x8079b62c, |
| 276 | }; |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 277 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 278 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 279 | ## IMAGE TRAILERS |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 280 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 281 | At startup, the boot loader determines the boot swap type by inspecting the |
| 282 | image trailers. When using the term "image trailers" what is meant is the |
| 283 | aggregate information provided by both image slot's trailers. |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 284 | |
| 285 | The image trailers records are structured around the limitations imposed by flash |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 286 | hardware. As a consequence, they do not have a very intuitive design, and it |
| 287 | is difficult to get a sense of the state of the device just by looking at the |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 288 | image trailers. It is better to map all the possible trailer states to the swap |
| 289 | types described above via a set of tables. These tables are reproduced below. |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 290 | |
| 291 | Note: An important caveat about the tables described below is that they must |
| 292 | be evaluated in the order presented here. Lower state numbers must have a |
| 293 | higher priority when testing the image trailers. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 294 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 295 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 296 | State I |
| 297 | | slot-0 | slot-1 | |
| 298 | -----------------+--------+--------| |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 299 | magic | Any | Good | |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 300 | image-ok | Any | Unset | |
Fabio Utzig | f9d4428 | 2017-07-20 15:05:13 -0300 | [diff] [blame] | 301 | copy-done | Any | Any | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 302 | -----------------+--------+--------' |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 303 | result: BOOT_SWAP_TYPE_TEST | |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 304 | -----------------------------------' |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 305 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 306 | |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 307 | State II |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 308 | | slot-0 | slot-1 | |
| 309 | -----------------+--------+--------| |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 310 | magic | Any | Good | |
| 311 | image-ok | Any | 0x01 | |
Fabio Utzig | f9d4428 | 2017-07-20 15:05:13 -0300 | [diff] [blame] | 312 | copy-done | Any | Any | |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 313 | -----------------+--------+--------' |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 314 | result: BOOT_SWAP_TYPE_PERM | |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 315 | -----------------------------------' |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 316 | |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 317 | |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 318 | State III |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 319 | | slot-0 | slot-1 | |
| 320 | -----------------+--------+--------| |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 321 | magic | Good | Unset | |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 322 | image-ok | 0xff | Any | |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 323 | copy-done | 0x01 | Any | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 324 | -----------------+--------+--------' |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 325 | result: BOOT_SWAP_TYPE_REVERT | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 326 | -----------------------------------' |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 327 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 328 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 329 | Any of the above three states results in mcuboot attempting to swap images. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 330 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 331 | Otherwise, mcuboot does not attempt to swap images, resulting in one of the |
| 332 | other three swap types, as illustrated by State IV. |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 333 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 334 | ``` |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 335 | State IV |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 336 | | slot-0 | slot-1 | |
| 337 | -----------------+--------+--------| |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 338 | magic | Any | Any | |
| 339 | image-ok | Any | Any | |
Fabio Utzig | f9d4428 | 2017-07-20 15:05:13 -0300 | [diff] [blame] | 340 | copy-done | Any | Any | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 341 | -----------------+--------+--------' |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 342 | result: BOOT_SWAP_TYPE_NONE, | |
| 343 | BOOT_SWAP_TYPE_FAIL, or | |
| 344 | BOOT_SWAP_TYPE_PANIC | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 345 | -----------------------------------' |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 346 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 347 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 348 | In State IV, when no errors occur, mcuboot will attempt to boot the contents of |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 349 | slot 0 directly, and the result is `BOOT_SWAP_TYPE_NONE`. If the image in slot 0 |
| 350 | is not valid, the result is `BOOT_SWAP_TYPE_FAIL`. If a fatal error occurs during |
| 351 | boot, the result is `BOOT_SWAP_TYPE_PANIC`. If the result is either |
| 352 | `BOOT_SWAP_TYPE_FAIL` or `BOOT_SWAP_TYPE_PANIC`, mcuboot hangs rather than booting |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 353 | an invalid or compromised image. |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 354 | |
Marti Bolivar | 048d8d8 | 2017-08-04 17:14:24 -0400 | [diff] [blame] | 355 | Note: An important caveat to the above is the result when a swap is requested |
| 356 | and the image in slot 1 fails to validate, due to a hashing or signing |
| 357 | error. This state behaves as State IV with the extra action of marking |
| 358 | the image in slot 0 as "OK", to prevent further attempts to swap. |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 359 | |
| 360 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 361 | ## High-Level Operation |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 362 | |
| 363 | With the terms defined, we can now explore the boot loader's operation. First, |
| 364 | a high-level overview of the boot process is presented. Then, the following |
| 365 | sections describe each step of the process in more detail. |
| 366 | |
| 367 | Procedure: |
| 368 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 369 | 1. Inspect swap status region; is an interrupted swap being resumed? |
| 370 | Yes: Complete the partial swap operation; skip to step 3. |
| 371 | No: Proceed to step 2. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 372 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 373 | 2. Inspect image trailers; is a swap requested? |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 374 | Yes. |
| 375 | 1. Is the requested image valid (integrity and security check)? |
| 376 | Yes. |
| 377 | a. Perform swap operation. |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 378 | b. Persist completion of swap procedure to image trailers. |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 379 | c. Proceed to step 3. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 380 | No. |
| 381 | a. Erase invalid image. |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 382 | b. Persist failure of swap procedure to image trailers. |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 383 | c. Proceed to step 3. |
| 384 | No: Proceed to step 3. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 385 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 386 | 3. Boot into image in slot 0. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 387 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 388 | ## Image Swapping |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 389 | |
| 390 | The boot loader swaps the contents of the two image slots for two reasons: |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 391 | * User has issued a "set pending" operation; the image in slot-1 should be |
| 392 | run once (state II) or repeatedly (state III), depending on whether a |
| 393 | permanent swap was specified. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 394 | * Test image rebooted without being confirmed; the boot loader should |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 395 | revert to the original image currently in slot-1 (state IV). |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 396 | |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 397 | If the image trailers indicates that the image in the secondary slot should be |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 398 | run, the boot loader needs to copy it to the primary slot. The image currently |
| 399 | in the primary slot also needs to be retained in flash so that it can be used |
| 400 | later. Furthermore, both images need to be recoverable if the boot loader |
| 401 | resets in the middle of the swap operation. The two images are swapped |
| 402 | according to the following procedure: |
| 403 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 404 | <!-- Markdown doesn't do nested numbered lists. It will do nested |
| 405 | bulletted lists, so maybe that is better. --> |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 406 | 1. Determine how many flash sectors each image slot consists of. This |
| 407 | number must be the same for both slots. |
| 408 | 2. Iterate the list of sector indices in descending order (i.e., starting |
| 409 | with the greatest index); current element = "index". |
| 410 | b. Erase scratch area. |
| 411 | c. Copy slot0[index] to scratch area. |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 412 | - If these are the last sectors (i.e., first swap being perfomed), |
| 413 | copy the full sector *except* the image trailer. |
| 414 | - Else, copy entire sector contents. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 415 | d. Write updated swap status (i). |
| 416 | |
| 417 | e. Erase slot1[index] |
| 418 | f. Copy slot0[index] to slot1[index] |
| 419 | - If these are the last sectors (i.e., first swap being perfomed), |
| 420 | copy the full sector *except* the image trailer. |
| 421 | - Else, copy entire sector contents. |
| 422 | g. Write updated swap status (ii). |
| 423 | |
| 424 | h. Erase slot0[index]. |
| 425 | i. Copy scratch area slot0[index]. |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 426 | - If these are the last sectors (i.e., first swap being perfomed), |
| 427 | copy the full sector *except* the image trailer. |
| 428 | - Else, copy entire sector contents. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 429 | j. Write updated swap status (iii). |
| 430 | |
| 431 | 3. Persist completion of swap procedure to slot 0 image trailer. |
| 432 | |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 433 | The additional caveats in step 2f are necessary so that the slot 1 image |
| 434 | trailer can be written by the user at a later time. With the image trailer |
| 435 | unwritten, the user can test the image in slot 1 (i.e., transition to state |
| 436 | II). |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 437 | |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 438 | Note1: If the sector being copied is the last sector, then swap status is |
| 439 | temporarily maintained on scratch for the duration of this operation, always |
| 440 | using slot0's area otherwise. |
| 441 | |
| 442 | Note2: The bootloader tries to copy only used sectors (based on largest image |
| 443 | installed on any of the slots), minimizing the amount of sectors copied and |
| 444 | reducing the amount of time required for a swap operation. |
| 445 | |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 446 | The particulars of step 3 vary depending on whether an image is being tested, |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 447 | permanently used, reverted or a validation failure of slot 1 happened when a |
| 448 | swap was requested: |
| 449 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 450 | * test: |
| 451 | o Write slot0.copy_done = 1 |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 452 | (swap caused the following values to be written: |
| 453 | slot0.magic = BOOT_MAGIC |
| 454 | slot0.image_ok = Unset) |
Christopher Collins | fd7eb5c | 2016-12-21 13:46:08 -0800 | [diff] [blame] | 455 | |
| 456 | * permanent: |
| 457 | o Write slot0.copy_done = 1 |
| 458 | (swap caused the following values to be written: |
| 459 | slot0.magic = BOOT_MAGIC |
| 460 | slot0.image_ok = 0x01) |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 461 | |
| 462 | * revert: |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 463 | o Write slot0.copy_done = 1 |
| 464 | o Write slot0.image_ok = 1 |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 465 | (swap caused the following values to be written: |
| 466 | slot0.magic = BOOT_MAGIC) |
| 467 | |
| 468 | * failure to validate slot 1: |
| 469 | o Write slot0.image_ok = 1 |
| 470 | |
| 471 | After completing the operations as described above the image in slot 0 should |
| 472 | be booted. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 473 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 474 | ## Swap Status |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 475 | |
| 476 | The swap status region allows the boot loader to recover in case it restarts in |
| 477 | the middle of an image swap operation. The swap status region consists of a |
| 478 | series of single-byte records. These records are written independently, and |
| 479 | therefore must be padded according to the minimum write size imposed by the |
| 480 | flash hardware. In the below figure, a min-write-size of 1 is assumed for |
| 481 | simplicity. The structure of the swap status region is illustrated below. In |
| 482 | this figure, a min-write-size of 1 is assumed for simplicity. |
| 483 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 484 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 485 | 0 1 2 3 |
| 486 | 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 |
| 487 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 488 | |sec127,state 0 |sec127,state 1 |sec127,state 2 |sec126,state 0 | |
| 489 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 490 | |sec126,state 1 |sec126,state 2 |sec125,state 0 |sec125,state 1 | |
| 491 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 492 | |sec125,state 2 | | |
| 493 | +-+-+-+-+-+-+-+-+ + |
| 494 | ~ ~ |
| 495 | ~ [Records for indices 124 through 1 ~ |
| 496 | ~ ~ |
| 497 | ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 498 | ~ |sec000,state 0 |sec000,state 1 |sec000,state 2 | |
| 499 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 500 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 501 | |
| 502 | The above is probably not helpful at all; here is a description in English. |
| 503 | |
| 504 | Each image slot is partitioned into a sequence of flash sectors. If we were to |
| 505 | enumerate the sectors in a single slot, starting at 0, we would have a list of |
| 506 | sector indices. Since there are two image slots, each sector index would |
| 507 | correspond to a pair of sectors. For example, sector index 0 corresponds to |
| 508 | the first sector in slot 0 and the first sector in slot 1. Furthermore, we |
| 509 | impose a limit of 128 indices. If an image slot consists of more than 128 |
| 510 | sectors, the flash layout is not compatible with this boot loader. Finally, |
| 511 | reverse the list of indices such that the list starts with index 127 and ends |
| 512 | with 0. The swap status region is a representation of this reversed list. |
| 513 | |
| 514 | During a swap operation, each sector index transitions through four separate |
| 515 | states: |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 516 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 517 | 0. slot 0: image 0, slot 1: image 1, scratch: N/A |
| 518 | 1. slot 0: image 0, slot 1: N/A, scratch: image 1 (1->s, erase 1) |
| 519 | 2. slot 0: N/A, slot 1: image 0, scratch: image 1 (0->1, erase 0) |
| 520 | 3. slot 0: image 1, slot 1: image 0, scratch: N/A (s->0) |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 521 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 522 | |
| 523 | Each time a sector index transitions to a new state, the boot loader writes a |
| 524 | record to the swap status region. Logically, the boot loader only needs one |
| 525 | record per sector index to keep track of the current swap state. However, due |
| 526 | to limitations imposed by flash hardware, a record cannot be overwritten when |
| 527 | an index's state changes. To solve this problem, the boot loader uses three |
| 528 | records per sector index rather than just one. |
| 529 | |
| 530 | Each sector-state pair is represented as a set of three records. The record |
| 531 | values map to the above four states as follows |
| 532 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 533 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 534 | | rec0 | rec1 | rec2 |
| 535 | --------+------+------+------ |
| 536 | state 0 | 0xff | 0xff | 0xff |
| 537 | state 1 | 0x01 | 0xff | 0xff |
| 538 | state 2 | 0x01 | 0x02 | 0xff |
| 539 | state 3 | 0x01 | 0x02 | 0x03 |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 540 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 541 | |
| 542 | The swap status region can accommodate 128 sector indices. Hence, the size of |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 543 | the region, in bytes, is `128 * min-write-size * 3`. The number 128 is chosen |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 544 | somewhat arbitrarily and will likely be made configurable. The only |
| 545 | requirement for the index count is that is is great enough to account for a |
| 546 | maximum-sized image (i.e., at least as great as the total sector count in an |
| 547 | image slot). If a device's image slots use less than 128 sectors, the first |
| 548 | record that gets written will be somewhere in the middle of the region. For |
| 549 | example, if a slot uses 64 sectors, the first sector index that gets swapped is |
| 550 | 63, which corresponds to the exact halfway point within the region. |
| 551 | |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 552 | Note: since the scratch area only ever needs to record swapping of the last |
| 553 | sector, it uses at most min-write-size * 3 bytes for its own status area. |
| 554 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 555 | ## Reset Recovery |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 556 | |
| 557 | If the boot loader resets in the middle of a swap operation, the two images may |
| 558 | be discontiguous in flash. Bootutil recovers from this condition by using the |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 559 | image trailers to determine how the image parts are distributed in flash. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 560 | |
| 561 | The first step is determine where the relevant swap status region is located. |
| 562 | Because this region is embedded within the image slots, its location in flash |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 563 | changes during a swap operation. The below set of tables map image trailers |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 564 | contents to swap status location. In these tables, the "source" field |
| 565 | indicates where the swap status region is located. |
| 566 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 567 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 568 | | slot-0 | scratch | |
| 569 | ----------+------------+------------| |
| 570 | magic | Good | Any | |
| 571 | copy-done | 0x01 | N/A | |
| 572 | ----------+------------+------------' |
| 573 | source: none | |
| 574 | ------------------------------------' |
Marti Bolivar | 49b2917 | 2017-08-04 14:50:51 -0400 | [diff] [blame] | 575 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 576 | | slot-0 | scratch | |
| 577 | ----------+------------+------------| |
| 578 | magic | Good | Any | |
| 579 | copy-done | 0xff | N/A | |
| 580 | ----------+------------+------------' |
| 581 | source: slot 0 | |
| 582 | ------------------------------------' |
Marti Bolivar | 49b2917 | 2017-08-04 14:50:51 -0400 | [diff] [blame] | 583 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 584 | | slot-0 | scratch | |
| 585 | ----------+------------+------------| |
| 586 | magic | Any | Good | |
| 587 | copy-done | Any | N/A | |
| 588 | ----------+------------+------------' |
| 589 | source: scratch | |
| 590 | ------------------------------------' |
Marti Bolivar | 49b2917 | 2017-08-04 14:50:51 -0400 | [diff] [blame] | 591 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 592 | | slot-0 | scratch | |
| 593 | ----------+------------+------------| |
| 594 | magic | Unset | Any | |
| 595 | copy-done | 0xff | N/A | |
| 596 | ----------+------------+------------| |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 597 | source: slot 0 | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 598 | ------------------------------------+------------------------------+ |
| 599 | This represents one of two cases: | |
| 600 | o No swaps ever (no status to read, so no harm in checking). | |
| 601 | o Mid-revert; status in slot 0. | |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 602 | For this reason we assume slot 0 as source, to trigger a check | |
| 603 | of the status area and find out if there was swapping under way. | |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 604 | -------------------------------------------------------------------' |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 605 | ``` |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 606 | |
| 607 | If the swap status region indicates that the images are not contiguous, |
| 608 | bootutil completes the swap operation that was in progress when the system was |
| 609 | reset. In other words, it applies the procedure defined in the previous |
| 610 | section, moving image 1 into slot 0 and image 0 into slot 1. If the boot |
| 611 | status file indicates that an image part is present in the scratch area, this |
| 612 | part is copied into the correct location by starting at step e or step h in the |
| 613 | area-swap procedure, depending on whether the part belongs to image 0 or image |
| 614 | 1. |
| 615 | |
| 616 | After the swap operation has been completed, the boot loader proceeds as though |
| 617 | it had just been started. |
| 618 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 619 | ## Integrity Check |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 620 | |
| 621 | An image is checked for integrity immediately before it gets copied into the |
Fabio Utzig | 5bd4e58 | 2017-07-20 08:55:38 -0300 | [diff] [blame] | 622 | primary slot. If the boot loader doesn't perform an image swap, then it can |
| 623 | perform an optional integrity check of the image in slot0 if |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 624 | `MCUBOOT_VALIDATE_SLOT0` is set, otherwise it doesn't perform an integrity check. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 625 | |
| 626 | During the integrity check, the boot loader verifies the following aspects of |
| 627 | an image: |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 628 | * 32-bit magic number must be correct (0x96f3b83d). |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 629 | * Image must contain an `image_tlv_info` struct, identified by its magic |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 630 | (0x6907) exactly following the firmware (hdr_size + img_size). |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 631 | * Image must contain a SHA256 TLV. |
Fabio Utzig | 86fe4b2 | 2017-07-28 18:56:29 -0300 | [diff] [blame] | 632 | * Calculated SHA256 must match SHA256 TLV contents. |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 633 | * Image *may* contain a signature TLV. If it does, it must also have a |
| 634 | KEYHASH TLV with the hash of the key that was used to sign. The list of |
| 635 | keys will then be iterated over looking for the matching key, which then |
| 636 | will then be used to verify the image contents. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 637 | |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 638 | ## Security |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 639 | |
| 640 | As indicated above, the final step of the integrity check is signature |
| 641 | verification. The boot loader can have one or more public keys embedded in it |
| 642 | at build time. During signature verification, the boot loader verifies that an |
Fabio Utzig | ea422c2 | 2017-09-11 11:02:47 -0300 | [diff] [blame] | 643 | image was signed with a private key that corresponds to the embedded keyhash |
| 644 | TLV. |
Christopher Collins | 92ea77f | 2016-12-12 15:59:26 -0800 | [diff] [blame] | 645 | |
| 646 | For information on embedding public keys in the boot loader, as well as |
David Brown | 17e20d1 | 2017-09-12 11:53:20 -0600 | [diff] [blame^] | 647 | producing signed images, see: [signed_images]({% link signed_images.md |
| 648 | %}). |