Merge pull request #104 from mbolivar/design-doc-fixups

Design doc fixups
mcu-tools · Aug 10, 2017 · 9521a38 · 9521a38
2 parents d9072bc + 048d8d8
commit 9521a38
Show file tree

Hide file tree

Showing 3 changed files with 138 additions and 147 deletions.
diff --git a/boot/bootutil/include/bootutil/bootutil.h b/boot/bootutil/include/bootutil/bootutil.h
@@ -6,7 +6,7 @@
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
- * 
+ *
  *  http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
@@ -26,13 +26,13 @@
 extern "C" {
 #endif
 
-/** Just boot whatever is in slot 0. */
+/** Attempt to boot the contents of slot 0. */
 #define BOOT_SWAP_TYPE_NONE     1
 
 /** Swap to slot 1.  Absent a confirm command, revert back on next boot. */
 #define BOOT_SWAP_TYPE_TEST     2
 
-/** Swap to slot 1 permanently. */
+/** Swap to slot 1, and permanently switch to booting its contents. */
 #define BOOT_SWAP_TYPE_PERM     3
 
 /** Swap back to alternate slot.  A confirm changes this state to NONE. */

diff --git a/boot/bootutil/include/bootutil/image.h b/boot/bootutil/include/bootutil/image.h
@@ -36,13 +36,13 @@ struct flash_area;
 /*
  * Image header flags.
  */
-#define IMAGE_F_PIC                   0x00000001 /* Not currently supported. */
-#define IMAGE_F_SHA256                0x00000002 /* Image contains hash TLV */
-#define IMAGE_F_PKCS15_RSA2048_SHA256 0x00000004 /* PKCS15 w/RSA and SHA */
-#define IMAGE_F_ECDSA224_SHA256       0x00000008 /* ECDSA224 over SHA256 */
-#define IMAGE_F_NON_BOOTABLE          0x00000010 /* Split image app. */
-#define IMAGE_F_ECDSA256_SHA256       0x00000020 /* ECDSA256 over SHA256 */
-#define IMAGE_F_PKCS1_PSS_RSA2048_SHA256 0x0000040 /* PKCS1 PSS */
+#define IMAGE_F_PIC                      0x00000001 /* Not supported. */
+#define IMAGE_F_SHA256                   0x00000002 /* Hash TLV is present */
+#define IMAGE_F_PKCS15_RSA2048_SHA256    0x00000004 /* PKCS15 w/RSA and SHA */
+#define IMAGE_F_ECDSA224_SHA256          0x00000008 /* ECDSA224 over SHA256 */
+#define IMAGE_F_NON_BOOTABLE             0x00000010 /* Split image app. */
+#define IMAGE_F_ECDSA256_SHA256          0x00000020 /* ECDSA256 over SHA256 */
+#define IMAGE_F_PKCS1_PSS_RSA2048_SHA256 0x00000040 /* PKCS1 PSS */
 
 /*
  * ECSDA224 is with NIST P-224