1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
/* SPDX-License-Identifier: GPL-2.0-or-later */ /* * Copyright 2018-2026 Broadcom Inc. All rights reserved. */ #ifndef MPI30_IMAGE_H #define MPI30_IMAGE_H 1 struct mpi3_comp_image_version { __le16 build_num; __le16 customer_id; u8 phase_minor; u8 phase_major; u8 gen_minor; u8 gen_major; }; struct mpi3_hash_exclusion_format { __le32 offset; __le32 size; }; #define MPI3_IMAGE_HASH_EXCUSION_NUM (4) struct mpi3_component_image_header { __le32 signature0; __le32 load_address; __le32 data_size; __le32 start_offset; __le32 signature1; __le32 flash_offset; __le32 image_size; __le32 version_string_offset; __le32 build_date_string_offset; __le32 build_time_string_offset; __le32 environment_variable_offset; __le32 application_specific; __le32 signature2; __le32 header_size; __le32 crc; __le32 flags; __le32 secondary_flash_offset; __le32 etp_offset; __le32 etp_size; union mpi3_version_union rmc_interface_version; union mpi3_version_union etp_interface_version; struct mpi3_comp_image_version component_image_version; struct mpi3_hash_exclusion_format hash_exclusion[MPI3_IMAGE_HASH_EXCUSION_NUM]; __le32 next_image_header_offset; union mpi3_version_union security_version; __le32 reserved84[31]; }; #define MPI3_IMAGE_HEADER_SIGNATURE0_MPI3 (0xeb00003e) #define MPI3_IMAGE_HEADER_LOAD_ADDRESS_INVALID (0x00000000) #define MPI3_IMAGE_HEADER_SIGNATURE1_APPLICATION (0x20505041) #define MPI3_IMAGE_HEADER_SIGNATURE1_FIRST_MUTABLE (0x20434d46) #define MPI3_IMAGE_HEADER_SIGNATURE1_BSP (0x20505342) #define MPI3_IMAGE_HEADER_SIGNATURE1_ROM_BIOS (0x534f4942) #define MPI3_IMAGE_HEADER_SIGNATURE1_HII_X64 (0x4d494948) #define MPI3_IMAGE_HEADER_SIGNATURE1_HII_ARM (0x41494948) #define MPI3_IMAGE_HEADER_SIGNATURE1_CPLD (0x444c5043) #define MPI3_IMAGE_HEADER_SIGNATURE1_SPD (0x20445053) #define MPI3_IMAGE_HEADER_SIGNATURE1_GAS_GAUGE (0x20534147) #define MPI3_IMAGE_HEADER_SIGNATURE1_PBLP (0x504c4250) #define MPI3_IMAGE_HEADER_SIGNATURE1_MANIFEST (0x464e414d) #define MPI3_IMAGE_HEADER_SIGNATURE1_OEM (0x204d454f) #define MPI3_IMAGE_HEADER_SIGNATURE1_RMC (0x20434d52) #define MPI3_IMAGE_HEADER_SIGNATURE1_SMM (0x204d4d53) #define MPI3_IMAGE_HEADER_SIGNATURE1_PSW (0x20575350) #define MPI3_IMAGE_HEADER_SIGNATURE2_VALUE (0x50584546) #define MPI3_IMAGE_HEADER_FLAGS_SIGNED_UEFI_MASK (0x00000300) #define MPI3_IMAGE_HEADER_FLAGS_SIGNED_UEFI_SHIFT (8) #define MPI3_IMAGE_HEADER_FLAGS_CERT_CHAIN_FORMAT_MASK (0x000000c0) #define MPI3_IMAGE_HEADER_FLAGS_CERT_CHAIN_FORMAT_SHIFT (6) #define MPI3_IMAGE_HEADER_FLAGS_DEVICE_KEY_BASIS_MASK (0x00000030) #define MPI3_IMAGE_HEADER_FLAGS_DEVICE_KEY_BASIS_SHIFT (4) #define MPI3_IMAGE_HEADER_FLAGS_DEVICE_KEY_BASIS_CDI (0x00000000) #define MPI3_IMAGE_HEADER_FLAGS_DEVICE_KEY_BASIS_DI (0x00000010) #define MPI3_IMAGE_HEADER_FLAGS_SIGNED_NVDATA (0x00000008) #define MPI3_IMAGE_HEADER_FLAGS_REQUIRES_ACTIVATION (0x00000004) #define MPI3_IMAGE_HEADER_FLAGS_COMPRESSED (0x00000002) #define MPI3_IMAGE_HEADER_FLAGS_FLASH (0x00000001) #define MPI3_IMAGE_HEADER_SIGNATURE0_OFFSET (0x00) #define MPI3_IMAGE_HEADER_LOAD_ADDRESS_OFFSET (0x04) #define MPI3_IMAGE_HEADER_DATA_SIZE_OFFSET (0x08) #define MPI3_IMAGE_HEADER_START_OFFSET_OFFSET (0x0c) #define MPI3_IMAGE_HEADER_SIGNATURE1_OFFSET (0x10) #define MPI3_IMAGE_HEADER_FLASH_OFFSET_OFFSET (0x14) #define MPI3_IMAGE_HEADER_FLASH_SIZE_OFFSET (0x18) #define MPI3_IMAGE_HEADER_VERSION_STRING_OFFSET_OFFSET (0x1c) #define MPI3_IMAGE_HEADER_BUILD_DATE_STRING_OFFSET_OFFSET (0x20) #define MPI3_IMAGE_HEADER_BUILD_TIME_OFFSET_OFFSET (0x24) #define MPI3_IMAGE_HEADER_ENVIROMENT_VAR_OFFSET_OFFSET (0x28) #define MPI3_IMAGE_HEADER_APPLICATION_SPECIFIC_OFFSET (0x2c) #define MPI3_IMAGE_HEADER_SIGNATURE2_OFFSET (0x30) #define MPI3_IMAGE_HEADER_HEADER_SIZE_OFFSET (0x34) #define MPI3_IMAGE_HEADER_CRC_OFFSET (0x38) #define MPI3_IMAGE_HEADER_FLAGS_OFFSET (0x3c) #define MPI3_IMAGE_HEADER_SECONDARY_FLASH_OFFSET_OFFSET (0x40) #define MPI3_IMAGE_HEADER_ETP_OFFSET_OFFSET (0x44) #define MPI3_IMAGE_HEADER_ETP_SIZE_OFFSET (0x48) #define MPI3_IMAGE_HEADER_RMC_INTERFACE_VER_OFFSET (0x4c) #define MPI3_IMAGE_HEADER_ETP_INTERFACE_VER_OFFSET (0x50) #define MPI3_IMAGE_HEADER_COMPONENT_IMAGE_VER_OFFSET (0x54) #define MPI3_IMAGE_HEADER_HASH_EXCLUSION_OFFSET (0x5c) #define MPI3_IMAGE_HEADER_NEXT_IMAGE_HEADER_OFFSET_OFFSET (0x7c) #define MPI3_IMAGE_HEADER_SIZE (0x100) #ifndef MPI3_CI_MANIFEST_MPI_MAX #define MPI3_CI_MANIFEST_MPI_MAX (1) #endif struct mpi3_ci_manifest_mpi_comp_image_ref { __le32 signature1; __le32 reserved04[3]; struct mpi3_comp_image_version component_image_version; __le32 component_image_version_string_offset; __le32 crc; }; struct mpi3_ci_manifest_mpi { u8 manifest_type; u8 reserved01[3]; __le32 reserved04[3]; u8 num_image_references; u8 release_level; __le16 reserved12; __le16 reserved14; __le16 flags; __le32 reserved18[2]; __le16 vendor_id; __le16 device_id; __le16 subsystem_vendor_id; __le16 subsystem_id; __le32 reserved28[2]; union mpi3_version_union package_security_version; __le32 reserved34; struct mpi3_comp_image_version package_version; __le32 package_version_string_offset; __le32 package_build_date_string_offset; __le32 package_build_time_string_offset; __le32 diag_authorization_key_offset; __le32 diag_authorization_identifier[16]; struct mpi3_ci_manifest_mpi_comp_image_ref component_image_ref[MPI3_CI_MANIFEST_MPI_MAX]; }; #define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_DEV (0x00) #define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_PREALPHA (0x10) #define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_ALPHA (0x20) #define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_BETA (0x30) #define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_RC (0x40) #define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_GCA (0x50) #define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_POINT (0x60) #define MPI3_CI_MANIFEST_MPI_FLAGS_DIAG_AUTHORIZATION (0x01) #define MPI3_CI_MANIFEST_MPI_FLAGS_DIAG_AUTH_ANCHOR_MASK (0x06) #define MPI3_CI_MANIFEST_MPI_FLAGS_DIAG_AUTH_ANCHOR_SHIFT (1) #define MPI3_CI_MANIFEST_MPI_FLAGS_DIAG_AUTH_ANCHOR_IDENTIFIER (0x00) #define MPI3_CI_MANIFEST_MPI_FLAGS_DIAG_AUTH_ANCHOR_KEY_OFFSET (0x02) #define MPI3_CI_MANIFEST_MPI_SUBSYSTEMID_IGNORED (0xffff) #define MPI3_CI_MANIFEST_MPI_PKG_VER_STR_OFF_UNSPECIFIED (0x00000000) #define MPI3_CI_MANIFEST_MPI_PKG_BUILD_DATE_STR_OFF_UNSPECIFIED (0x00000000) #define MPI3_CI_MANIFEST_MPI_PKG_BUILD_TIME_STR_OFF_UNSPECIFIED (0x00000000) struct mpi3_sb_manifest_ci_digest { __le32 signature1; __le32 reserved04[2]; u8 hash_algorithm; u8 reserved09[3]; struct mpi3_comp_image_version component_image_version; __le32 component_image_version_string_offset; __le32 digest[16]; }; struct mpi3_sb_manifest_ci_ref_element { u8 num_ci_digests; u8 reserved01[3]; struct mpi3_sb_manifest_ci_digest ci_digest[]; }; struct mpi3_sb_manifest_embedded_key_element { __le32 reserved00[3]; u8 key_algorithm; u8 flags; __le16 public_key_size; __le32 start_tag; __le32 public_key[]; }; #define MPI3_SB_MANIFEST_EMBEDDED_KEY_FLAGS_KEYINDEX_MASK (0x03) #define MPI3_SB_MANIFEST_EMBEDDED_KEY_FLAGS_KEYINDEX_STRT (0x00) #define MPI3_SB_MANIFEST_EMBEDDED_KEY_FLAGS_KEYINDEX_K2GO (0x01) #define MPI3_SB_MANIFEST_EMBEDDED_KEY_STARTTAG_STRT (0x54525453) #define MPI3_SB_MANIFEST_EMBEDDED_KEY_STARTTAG_K2GO (0x4f47324b) #define MPI3_SB_MANIFEST_EMBEDDED_KEY_ENDTAG_STOP (0x504f5453) #define MPI3_SB_MANIFEST_EMBEDDED_KEY_ENDTAG_K2ST (0x5453324b) struct mpi3_sb_manifest_diag_key_element { __le32 reserved00[3]; u8 key_algorithm; u8 flags; __le16 public_key_size; __le32 public_key[]; }; #define MPI3_SB_MANIFEST_DIAG_KEY_FLAGS_KEYINDEX_MASK (0x03) #define MPI3_SB_MANIFEST_DIAG_KEY_FLAGS_KEYSELECT_FW_KEY (0x04) union mpi3_sb_manifest_element_data { struct mpi3_sb_manifest_ci_ref_element ci_ref; struct mpi3_sb_manifest_embedded_key_element embed_key; struct mpi3_sb_manifest_diag_key_element diag_key; __le32 dword; }; struct mpi3_sb_manifest_element { u8 manifest_element_form; u8 reserved01[3]; union mpi3_sb_manifest_element_data form_specific[]; }; #define MPI3_SB_MANIFEST_ELEMENT_FORM_CI_REFS (0x01) #define MPI3_SB_MANIFEST_ELEMENT_FORM_EMBED_KEY (0x02) #define MPI3_SB_MANIFEST_ELEMENT_FORM_DIAG_KEY (0x03) struct mpi3_sb_manifest_mpi { u8 manifest_type; u8 reserved01[3]; __le32 reserved04[3]; u8 reserved10; u8 release_level; __le16 reserved12; __le16 reserved14; __le16 flags; __le32 reserved18[2]; __le16 vendor_id; __le16 device_id; __le16 subsystem_vendor_id; __le16 subsystem_id; __le32 reserved28[2]; union mpi3_version_union package_security_version; __le32 reserved34; struct mpi3_comp_image_version package_version; __le32 package_version_string_offset; __le32 package_build_date_string_offset; __le32 package_build_time_string_offset; __le32 component_image_references_offset; __le32 embedded_key0offset; __le32 embedded_key1offset; __le32 diag_authorization_key_offset; __le32 reserved5c[9]; struct mpi3_sb_manifest_element manifest_elements[]; }; union mpi3_ci_manifest { struct mpi3_ci_manifest_mpi mpi; struct mpi3_sb_manifest_mpi sb_mpi; __le32 dword[1]; }; #define MPI3_SB_MANIFEST_APU_IMMEDIATE_DEFER_APU_ENABLE (0x01) #define MPI3_CI_MANIFEST_TYPE_MPI (0x00) #define MPI3_CI_MANIFEST_TYPE_SB (0x01) struct mpi3_extended_image_header { u8 image_type; u8 reserved01[3]; __le32 checksum; __le32 image_size; __le32 next_image_header_offset; __le32 reserved10[4]; __le32 identify_string[8]; }; #define MPI3_EXT_IMAGE_IMAGETYPE_OFFSET (0x00) #define MPI3_EXT_IMAGE_IMAGESIZE_OFFSET (0x08) #define MPI3_EXT_IMAGE_NEXTIMAGE_OFFSET (0x0c) #define MPI3_EXT_IMAGE_HEADER_SIZE (0x40) #define MPI3_EXT_IMAGE_TYPE_UNSPECIFIED (0x00) #define MPI3_EXT_IMAGE_TYPE_NVDATA (0x03) #define MPI3_EXT_IMAGE_TYPE_SUPPORTED_DEVICES (0x07) #define MPI3_EXT_IMAGE_TYPE_ENCRYPTED_HASH (0x09) #define MPI3_EXT_IMAGE_TYPE_RDE (0x0a) #define MPI3_EXT_IMAGE_TYPE_AUXILIARY_PROCESSOR (0x0b) #define MPI3_EXT_IMAGE_TYPE_MIN_PRODUCT_SPECIFIC (0x80) #define MPI3_EXT_IMAGE_TYPE_MAX_PRODUCT_SPECIFIC (0xff) struct mpi3_supported_device { __le16 device_id; __le16 vendor_id; __le16 device_id_mask; __le16 reserved06; u8 low_pci_rev; u8 high_pci_rev; __le16 reserved0a; __le32 reserved0c; }; #ifndef MPI3_SUPPORTED_DEVICE_MAX #define MPI3_SUPPORTED_DEVICE_MAX (1) #endif struct mpi3_supported_devices_data { u8 image_version; u8 reserved01; u8 num_devices; u8 reserved03; __le32 reserved04; struct mpi3_supported_device supported_device[MPI3_SUPPORTED_DEVICE_MAX]; }; #ifndef MPI3_PUBLIC_KEY_MAX #define MPI3_PUBLIC_KEY_MAX (1) #endif struct mpi3_encrypted_hash_entry { u8 hash_image_type; u8 hash_algorithm; u8 encryption_algorithm; u8 flags; __le16 public_key_size; __le16 signature_size; __le32 public_key[MPI3_PUBLIC_KEY_MAX]; }; #define MPI3_HASH_IMAGE_TYPE_KEY_WITH_HASH (0x03) #define MPI3_HASH_IMAGE_TYPE_KEY_WITH_HASH_1_OF_2 (0x04) #define MPI3_HASH_IMAGE_TYPE_KEY_WITH_HASH_2_OF_2 (0x05) #define MPI3_HASH_ALGORITHM_VERSION_MASK (0xe0) #define MPI3_HASH_ALGORITHM_VERSION_SHIFT (5) #define MPI3_HASH_ALGORITHM_VERSION_NONE (0x00) #define MPI3_HASH_ALGORITHM_VERSION_SHA1 (0x20) #define MPI3_HASH_ALGORITHM_VERSION_SHA2 (0x40) #define MPI3_HASH_ALGORITHM_VERSION_SHA3 (0x60) #define MPI3_HASH_ALGORITHM_SIZE_MASK (0x1f) #define MPI3_HASH_ALGORITHM_SIZE_SHIFT (0) #define MPI3_HASH_ALGORITHM_SIZE_UNUSED (0x00) #define MPI3_HASH_ALGORITHM_SIZE_SHA256 (0x01) #define MPI3_HASH_ALGORITHM_SIZE_SHA512 (0x02) #define MPI3_HASH_ALGORITHM_SIZE_SHA384 (0x03) #define MPI3_ENCRYPTION_ALGORITHM_UNUSED (0x00) #define MPI3_ENCRYPTION_ALGORITHM_RSA256 (0x01) #define MPI3_ENCRYPTION_ALGORITHM_RSA512 (0x02) #define MPI3_ENCRYPTION_ALGORITHM_RSA1024 (0x03) #define MPI3_ENCRYPTION_ALGORITHM_RSA2048 (0x04) #define MPI3_ENCRYPTION_ALGORITHM_RSA4096 (0x05) #define MPI3_ENCRYPTION_ALGORITHM_RSA3072 (0x06) /* hierarchical signature system (hss) */ #define MPI3_ENCRYPTION_ALGORITHM_ML_DSA_87 (0x0b) #define MPI3_ENCRYPTION_ALGORITHM_ML_DSA_65 (0x0c) #define MPI3_ENCRYPTION_ALGORITHM_ML_DSA_44 (0x0d) #define MPI3_ENCRYPTED_HASH_ENTRY_FLAGS_PAIRED_KEY_MASK (0x0f) #define MPI3_ENCRYPTED_HASH_ENTRY_FLAGS_PAIRED_KEY_SHIFT (0) #ifndef MPI3_ENCRYPTED_HASH_ENTRY_MAX #define MPI3_ENCRYPTED_HASH_ENTRY_MAX (1) #endif struct mpi3_encrypted_hash_data { u8 image_version; u8 num_hash; __le16 reserved02; __le32 reserved04; struct mpi3_encrypted_hash_entry encrypted_hash_entry[MPI3_ENCRYPTED_HASH_ENTRY_MAX]; }; #ifndef MPI3_AUX_PROC_DATA_MAX #define MPI3_AUX_PROC_DATA_MAX (1) #endif struct mpi3_aux_processor_data { u8 boot_method; u8 num_load_addr; u8 reserved02; u8 type; __le32 version; __le32 load_address[8]; __le32 reserved28[22]; __le32 aux_processor_data[MPI3_AUX_PROC_DATA_MAX]; }; #define MPI3_AUX_PROC_DATA_OFFSET (0x80) #define MPI3_AUXPROCESSOR_BOOT_METHOD_MO_MSG (0x00) #define MPI3_AUXPROCESSOR_BOOT_METHOD_MO_DOORBELL (0x01) #define MPI3_AUXPROCESSOR_BOOT_METHOD_COMPONENT (0x02) #define MPI3_AUXPROCESSOR_TYPE_ARM_A15 (0x00) #define MPI3_AUXPROCESSOR_TYPE_ARM_M0 (0x01) #define MPI3_AUXPROCESSOR_TYPE_ARM_R4 (0x02) #endif