1 /* 2 * Copyright (c) 2017-2019, STMicroelectronics - All Rights Reserved 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef BOOT_API_H 8 #define BOOT_API_H 9 10 #include <stdint.h> 11 #include <stdio.h> 12 13 /* 14 * Possible value of boot context field 'auth_status' 15 */ 16 /* No authentication done */ 17 #define BOOT_API_CTX_AUTH_NO 0x0U 18 /* Authentication done and failed */ 19 #define BOOT_API_CTX_AUTH_FAILED 0x1U 20 /* Authentication done and succeeded */ 21 #define BOOT_API_CTX_AUTH_SUCCESS 0x2U 22 23 /* 24 * Possible value of boot context field 'boot_interface_sel' 25 */ 26 27 /* Value of field 'boot_interface_sel' when no boot occurred */ 28 #define BOOT_API_CTX_BOOT_INTERFACE_SEL_NO 0x0U 29 30 /* Boot occurred on SD */ 31 #define BOOT_API_CTX_BOOT_INTERFACE_SEL_FLASH_SD 0x1U 32 33 /* Boot occurred on EMMC */ 34 #define BOOT_API_CTX_BOOT_INTERFACE_SEL_FLASH_EMMC 0x2U 35 36 /* Boot occurred on FMC */ 37 #define BOOT_API_CTX_BOOT_INTERFACE_SEL_FLASH_NAND_FMC 0x3U 38 39 /* Boot occurred on QSPI NOR */ 40 #define BOOT_API_CTX_BOOT_INTERFACE_SEL_FLASH_NOR_QSPI 0x4U 41 42 /* Boot occurred on QSPI NAND */ 43 #define BOOT_API_CTX_BOOT_INTERFACE_SEL_FLASH_NAND_QSPI 0x7U 44 45 /** 46 * @brief Possible value of boot context field 'EmmcXferStatus' 47 */ 48 /* 49 * Possible value of boot context field 'emmc_xfer_status' 50 */ 51 #define BOOT_API_CTX_EMMC_XFER_STATUS_NOT_STARTED 0x0U 52 #define BOOT_API_CTX_EMMC_XFER_STATUS_DATAEND_DETECTED 0x1U 53 #define BOOT_API_CTX_EMMC_XFER_STATUS_XFER_OVERALL_TIMEOUT_DETECTED 0x2U 54 #define BOOT_API_CTX_EMMC_XFER_STATUS_XFER_DATA_TIMEOUT 0x3U 55 56 /* 57 * Possible value of boot context field 'emmc_error_status' 58 */ 59 #define BOOT_API_CTX_EMMC_ERROR_STATUS_NONE 0x0U 60 #define BOOT_API_CTX_EMMC_ERROR_STATUS_CMD_TIMEOUT 0x1U 61 #define BOOT_API_CTX_EMMC_ERROR_STATUS_ACK_TIMEOUT 0x2U 62 #define BOOT_API_CTX_EMMC_ERROR_STATUS_DATA_CRC_FAIL 0x3U 63 #define BOOT_API_CTX_EMMC_ERROR_STATUS_NOT_ENOUGH_BOOT_DATA_RX 0x4U 64 #define BOOT_API_CTX_EMMC_ERROR_STATUS_HEADER_NOT_FOUND 0x5U 65 #define BOOT_API_CTX_EMMC_ERROR_STATUS_HEADER_SIZE_ZERO 0x6U 66 #define BOOT_API_CTX_EMMC_ERROR_STATUS_IMAGE_NOT_COMPLETE 0x7U 67 68 /* Image Header related definitions */ 69 70 /* Definition of header version */ 71 #define BOOT_API_HEADER_VERSION 0x00010000U 72 73 /* 74 * Magic number used to detect header in memory 75 * Its value must be 'S' 'T' 'M' 0x32, i.e 0x324D5453 as field 76 * 'bootapi_image_header_t.magic' 77 * This identifies the start of a boot image. 78 */ 79 #define BOOT_API_IMAGE_HEADER_MAGIC_NB 0x324D5453U 80 81 /* Definitions related to Authentication used in image header structure */ 82 #define BOOT_API_ECDSA_PUB_KEY_LEN_IN_BYTES 64 83 #define BOOT_API_ECDSA_SIGNATURE_LEN_IN_BYTES 64 84 #define BOOT_API_SHA256_DIGEST_SIZE_IN_BYTES 32 85 86 /* Possible values of the field 'boot_api_image_header_t.ecc_algo_type' */ 87 #define BOOT_API_ECDSA_ALGO_TYPE_P256NIST 1 88 #define BOOT_API_ECDSA_ALGO_TYPE_BRAINPOOL256 2 89 90 /* 91 * Cores secure magic numbers 92 * Constant to be stored in bakcup register 93 * BOOT_API_MAGIC_NUMBER_TAMP_BCK_REG_IDX 94 */ 95 #define BOOT_API_A7_CORE0_MAGIC_NUMBER 0xCA7FACE0U 96 #define BOOT_API_A7_CORE1_MAGIC_NUMBER 0xCA7FACE1U 97 98 /* 99 * TAMP_BCK4R register index 100 * This register is used to write a Magic Number in order to restart 101 * Cortex A7 Core 1 and make it execute @ branch address from TAMP_BCK5R 102 */ 103 #define BOOT_API_CORE1_MAGIC_NUMBER_TAMP_BCK_REG_IDX 4U 104 105 /* 106 * TAMP_BCK5R register index 107 * This register is used to contain the branch address of 108 * Cortex A7 Core 1 when restarted by a TAMP_BCK4R magic number writing 109 */ 110 #define BOOT_API_CORE1_BRANCH_ADDRESS_TAMP_BCK_REG_IDX 5U 111 112 /* 113 * Possible value of boot context field 'hse_clock_value_in_hz' 114 */ 115 #define BOOT_API_CTX_HSE_CLOCK_VALUE_UNDEFINED 0U 116 #define BOOT_API_CTX_HSE_CLOCK_VALUE_24_MHZ 24000000U 117 #define BOOT_API_CTX_HSE_CLOCK_VALUE_25_MHZ 25000000U 118 #define BOOT_API_CTX_HSE_CLOCK_VALUE_26_MHZ 26000000U 119 120 /* 121 * Possible value of boot context field 'boot_partition_used_toboot' 122 */ 123 #define BOOT_API_CTX_BOOT_PARTITION_UNDEFINED 0U 124 125 /* Used FSBL1 to boot */ 126 #define BOOT_API_CTX_BOOT_PARTITION_FSBL1 1U 127 128 /* Used FSBL2 to boot */ 129 #define BOOT_API_CTX_BOOT_PARTITION_FSBL2 2U 130 131 /* OTP_CFG0 */ 132 #define BOOT_API_OTP_MODE_WORD_NB 0 133 /* Closed = OTP_CFG0[6] */ 134 #define BOOT_API_OTP_MODE_CLOSED_BIT_POS 6 135 136 #define BOOT_API_RETURN_OK 0x77U 137 138 /* 139 * Boot Context related definitions 140 */ 141 142 /* 143 * Boot core boot configuration structure 144 * Specifies all items of the cold boot configuration 145 * Memory and peripheral part. 146 */ 147 typedef struct { 148 /* 149 * Boot interface used to boot : take values from defines 150 * BOOT_API_CTX_BOOT_INTERFACE_SEL_XXX above 151 */ 152 uint16_t boot_interface_selected; 153 uint16_t boot_interface_instance; 154 uint32_t reserved1[13]; 155 uint32_t otp_afmux_values[3]; 156 uint32_t reserved[5]; 157 uint32_t auth_status; 158 159 /* 160 * Pointers to bootROM External Secure Services 161 * - ECDSA check key 162 * - ECDSA verify signature 163 * - ECDSA verify signature and go 164 */ 165 uint32_t (*bootrom_ecdsa_check_key)(uint8_t *pubkey_in, 166 uint8_t *pubkey_out); 167 uint32_t (*bootrom_ecdsa_verify_signature)(uint8_t *hash_in, 168 uint8_t *pubkey_in, 169 uint8_t *signature, 170 uint32_t ecc_algo); 171 uint32_t (*bootrom_ecdsa_verify_and_go)(uint8_t *hash_in, 172 uint8_t *pub_key_in, 173 uint8_t *signature, 174 uint32_t ecc_algo, 175 uint32_t *entry_in); 176 177 /* 178 * Information specific to an SD boot 179 * Updated each time an SD boot is at least attempted, 180 * even if not successful 181 * Note : This is useful to understand why an SD boot failed 182 * in particular 183 */ 184 uint32_t sd_err_internal_timeout_cnt; 185 uint32_t sd_err_dcrc_fail_cnt; 186 uint32_t sd_err_dtimeout_cnt; 187 uint32_t sd_err_ctimeout_cnt; 188 uint32_t sd_err_ccrc_fail_cnt; 189 uint32_t sd_overall_retry_cnt; 190 /* 191 * Information specific to an eMMC boot 192 * Updated each time an eMMC boot is at least attempted, 193 * even if not successful 194 * Note : This is useful to understand why an eMMC boot failed 195 * in particular 196 */ 197 uint32_t emmc_xfer_status; 198 uint32_t emmc_error_status; 199 uint32_t emmc_nbbytes_rxcopied_tosysram_download_area; 200 uint32_t hse_clock_value_in_hz; 201 /* 202 * Boot partition : 203 * ie FSBL partition on which the boot was successful 204 */ 205 uint32_t boot_partition_used_toboot; 206 207 } __packed boot_api_context_t; 208 209 /* 210 * Image Header related definitions 211 */ 212 213 /* 214 * Structure used to define the common Header format used for FSBL, xloader, 215 * ... and in particular used by bootROM for FSBL header readout. 216 * FSBL header size is 256 Bytes = 0x100 217 */ 218 typedef struct { 219 /* BOOT_API_IMAGE_HEADER_MAGIC_NB */ 220 uint32_t magic; 221 uint8_t image_signature[BOOT_API_ECDSA_SIGNATURE_LEN_IN_BYTES]; 222 /* 223 * Checksum of payload 224 * 32-bit sum all all payload bytes considered as 8 bit unigned numbers, 225 * discarding any overflow bits. 226 * Use to check UART/USB downloaded image integrity when signature 227 * is not used (i.e bit 0 : 'No_sig_check' = 1 in option flags) 228 */ 229 uint32_t payload_checksum; 230 /* Image header version : should have value BOOT_API_HEADER_VERSION */ 231 uint32_t header_version; 232 /* Image length in bytes */ 233 uint32_t image_length; 234 /* 235 * Image Entry point address : should be in the SYSRAM area 236 * and at least within the download area range 237 */ 238 uint32_t image_entry_point; 239 /* Reserved */ 240 uint32_t reserved1; 241 /* 242 * Image load address : not used by bootROM but to be consistent 243 * with header format for other packages (xloader, ...) 244 */ 245 uint32_t load_address; 246 /* Reserved */ 247 uint32_t reserved2; 248 /* Image version to be compared by bootROM with monotonic 249 * counter value in OTP_CFG4 prior executing the downloaded image 250 */ 251 uint32_t image_version; 252 /* 253 * Option flags: 254 * Bit 0 : No signature check request : 'No_sig_check' 255 * value 1 : for No signature check request 256 * value 0 : No request to bypass the signature check 257 * Note : No signature check is never allowed on a Secured chip 258 */ 259 uint32_t option_flags; 260 /* 261 * Type of ECC algorithm to use : 262 * value 1 : for P-256 NIST algorithm 263 * value 2 : for Brainpool 256 algorithm 264 * See definitions 'BOOT_API_ECDSA_ALGO_TYPE_XXX' above. 265 */ 266 uint32_t ecc_algo_type; 267 /* 268 * OEM ECC Public Key (aka Root pubk) provided in header on 512 bits. 269 * The SHA-256 hash of the OEM ECC pubk must match the one stored 270 * in OTP cells. 271 */ 272 uint8_t ecc_pubk[BOOT_API_ECDSA_PUB_KEY_LEN_IN_BYTES]; 273 /* Pad up to 256 byte total size */ 274 uint8_t pad[83]; 275 /* Add binary type information */ 276 uint8_t binary_type; 277 } __packed boot_api_image_header_t; 278 279 #endif /* BOOT_API_H */ 280