FILE
mpi30_image.h
File preview with syntax highlighting.
linux-6.19.14/drivers/scsi/mpi3mr/mpi/mpi30_image.h
1/* SPDX-License-Identifier: GPL-2.0-or-later */ 2/* 3 * Copyright 2018-2023 Broadcom Inc. All rights reserved. 4 */ 5#ifndef MPI30_IMAGE_H 6#define MPI30_IMAGE_H 1 7struct mpi3_comp_image_version { 8 __le16 build_num; 9 __le16 customer_id; 10 u8 phase_minor; 11 u8 phase_major; 12 u8 gen_minor; 13 u8 gen_major; 14}; 15 16struct mpi3_hash_exclusion_format { 17 __le32 offset; 18 __le32 size; 19}; 20 21#define MPI3_IMAGE_HASH_EXCUSION_NUM (4) 22struct mpi3_component_image_header { 23 __le32 signature0; 24 __le32 load_address; 25 __le32 data_size; 26 __le32 start_offset; 27 __le32 signature1; 28 __le32 flash_offset; 29 __le32 image_size; 30 __le32 version_string_offset; 31 __le32 build_date_string_offset; 32 __le32 build_time_string_offset; 33 __le32 environment_variable_offset; 34 __le32 application_specific; 35 __le32 signature2; 36 __le32 header_size; 37 __le32 crc; 38 __le32 flags; 39 __le32 secondary_flash_offset; 40 __le32 etp_offset; 41 __le32 etp_size; 42 union mpi3_version_union rmc_interface_version; 43 union mpi3_version_union etp_interface_version; 44 struct mpi3_comp_image_version component_image_version; 45 struct mpi3_hash_exclusion_format hash_exclusion[MPI3_IMAGE_HASH_EXCUSION_NUM]; 46 __le32 next_image_header_offset; 47 union mpi3_version_union security_version; 48 __le32 reserved84[31]; 49}; 50 51#define MPI3_IMAGE_HEADER_SIGNATURE0_MPI3 (0xeb00003e) 52#define MPI3_IMAGE_HEADER_LOAD_ADDRESS_INVALID (0x00000000) 53#define MPI3_IMAGE_HEADER_SIGNATURE1_APPLICATION (0x20505041) 54#define MPI3_IMAGE_HEADER_SIGNATURE1_FIRST_MUTABLE (0x20434d46) 55#define MPI3_IMAGE_HEADER_SIGNATURE1_BSP (0x20505342) 56#define MPI3_IMAGE_HEADER_SIGNATURE1_ROM_BIOS (0x534f4942) 57#define MPI3_IMAGE_HEADER_SIGNATURE1_HII_X64 (0x4d494948) 58#define MPI3_IMAGE_HEADER_SIGNATURE1_HII_ARM (0x41494948) 59#define MPI3_IMAGE_HEADER_SIGNATURE1_CPLD (0x444c5043) 60#define MPI3_IMAGE_HEADER_SIGNATURE1_SPD (0x20445053) 61#define MPI3_IMAGE_HEADER_SIGNATURE1_GAS_GAUGE (0x20534147) 62#define MPI3_IMAGE_HEADER_SIGNATURE1_PBLP (0x504c4250) 63#define MPI3_IMAGE_HEADER_SIGNATURE1_MANIFEST (0x464e414d) 64#define MPI3_IMAGE_HEADER_SIGNATURE1_OEM (0x204d454f) 65#define MPI3_IMAGE_HEADER_SIGNATURE1_RMC (0x20434d52) 66#define MPI3_IMAGE_HEADER_SIGNATURE1_SMM (0x204d4d53) 67#define MPI3_IMAGE_HEADER_SIGNATURE1_PSW (0x20575350) 68#define MPI3_IMAGE_HEADER_SIGNATURE2_VALUE (0x50584546) 69#define MPI3_IMAGE_HEADER_FLAGS_SIGNED_UEFI_MASK (0x00000300) 70#define MPI3_IMAGE_HEADER_FLAGS_SIGNED_UEFI_SHIFT (8) 71#define MPI3_IMAGE_HEADER_FLAGS_CERT_CHAIN_FORMAT_MASK (0x000000c0) 72#define MPI3_IMAGE_HEADER_FLAGS_CERT_CHAIN_FORMAT_SHIFT (6) 73#define MPI3_IMAGE_HEADER_FLAGS_DEVICE_KEY_BASIS_MASK (0x00000030) 74#define MPI3_IMAGE_HEADER_FLAGS_DEVICE_KEY_BASIS_SHIFT (4) 75#define MPI3_IMAGE_HEADER_FLAGS_DEVICE_KEY_BASIS_CDI (0x00000000) 76#define MPI3_IMAGE_HEADER_FLAGS_DEVICE_KEY_BASIS_DI (0x00000010) 77#define MPI3_IMAGE_HEADER_FLAGS_SIGNED_NVDATA (0x00000008) 78#define MPI3_IMAGE_HEADER_FLAGS_REQUIRES_ACTIVATION (0x00000004) 79#define MPI3_IMAGE_HEADER_FLAGS_COMPRESSED (0x00000002) 80#define MPI3_IMAGE_HEADER_FLAGS_FLASH (0x00000001) 81#define MPI3_IMAGE_HEADER_SIGNATURE0_OFFSET (0x00) 82#define MPI3_IMAGE_HEADER_LOAD_ADDRESS_OFFSET (0x04) 83#define MPI3_IMAGE_HEADER_DATA_SIZE_OFFSET (0x08) 84#define MPI3_IMAGE_HEADER_START_OFFSET_OFFSET (0x0c) 85#define MPI3_IMAGE_HEADER_SIGNATURE1_OFFSET (0x10) 86#define MPI3_IMAGE_HEADER_FLASH_OFFSET_OFFSET (0x14) 87#define MPI3_IMAGE_HEADER_FLASH_SIZE_OFFSET (0x18) 88#define MPI3_IMAGE_HEADER_VERSION_STRING_OFFSET_OFFSET (0x1c) 89#define MPI3_IMAGE_HEADER_BUILD_DATE_STRING_OFFSET_OFFSET (0x20) 90#define MPI3_IMAGE_HEADER_BUILD_TIME_OFFSET_OFFSET (0x24) 91#define MPI3_IMAGE_HEADER_ENVIROMENT_VAR_OFFSET_OFFSET (0x28) 92#define MPI3_IMAGE_HEADER_APPLICATION_SPECIFIC_OFFSET (0x2c) 93#define MPI3_IMAGE_HEADER_SIGNATURE2_OFFSET (0x30) 94#define MPI3_IMAGE_HEADER_HEADER_SIZE_OFFSET (0x34) 95#define MPI3_IMAGE_HEADER_CRC_OFFSET (0x38) 96#define MPI3_IMAGE_HEADER_FLAGS_OFFSET (0x3c) 97#define MPI3_IMAGE_HEADER_SECONDARY_FLASH_OFFSET_OFFSET (0x40) 98#define MPI3_IMAGE_HEADER_ETP_OFFSET_OFFSET (0x44) 99#define MPI3_IMAGE_HEADER_ETP_SIZE_OFFSET (0x48) 100#define MPI3_IMAGE_HEADER_RMC_INTERFACE_VER_OFFSET (0x4c) 101#define MPI3_IMAGE_HEADER_ETP_INTERFACE_VER_OFFSET (0x50) 102#define MPI3_IMAGE_HEADER_COMPONENT_IMAGE_VER_OFFSET (0x54) 103#define MPI3_IMAGE_HEADER_HASH_EXCLUSION_OFFSET (0x5c) 104#define MPI3_IMAGE_HEADER_NEXT_IMAGE_HEADER_OFFSET_OFFSET (0x7c) 105#define MPI3_IMAGE_HEADER_SIZE (0x100) 106#ifndef MPI3_CI_MANIFEST_MPI_MAX 107#define MPI3_CI_MANIFEST_MPI_MAX (1) 108#endif 109struct mpi3_ci_manifest_mpi_comp_image_ref { 110 __le32 signature1; 111 __le32 reserved04[3]; 112 struct mpi3_comp_image_version component_image_version; 113 __le32 component_image_version_string_offset; 114 __le32 crc; 115}; 116 117struct mpi3_ci_manifest_mpi { 118 u8 manifest_type; 119 u8 reserved01[3]; 120 __le32 reserved04[3]; 121 u8 num_image_references; 122 u8 release_level; 123 __le16 reserved12; 124 __le16 reserved14; 125 __le16 flags; 126 __le32 reserved18[2]; 127 __le16 vendor_id; 128 __le16 device_id; 129 __le16 subsystem_vendor_id; 130 __le16 subsystem_id; 131 __le32 reserved28[2]; 132 union mpi3_version_union package_security_version; 133 __le32 reserved34; 134 struct mpi3_comp_image_version package_version; 135 __le32 package_version_string_offset; 136 __le32 package_build_date_string_offset; 137 __le32 package_build_time_string_offset; 138 __le32 reserved4c; 139 __le32 diag_authorization_identifier[16]; 140 struct mpi3_ci_manifest_mpi_comp_image_ref component_image_ref[MPI3_CI_MANIFEST_MPI_MAX]; 141}; 142 143#define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_DEV (0x00) 144#define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_PREALPHA (0x10) 145#define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_ALPHA (0x20) 146#define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_BETA (0x30) 147#define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_RC (0x40) 148#define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_GCA (0x50) 149#define MPI3_CI_MANIFEST_MPI_RELEASE_LEVEL_POINT (0x60) 150#define MPI3_CI_MANIFEST_MPI_FLAGS_DIAG_AUTHORIZATION (0x01) 151#define MPI3_CI_MANIFEST_MPI_SUBSYSTEMID_IGNORED (0xffff) 152#define MPI3_CI_MANIFEST_MPI_PKG_VER_STR_OFF_UNSPECIFIED (0x00000000) 153#define MPI3_CI_MANIFEST_MPI_PKG_BUILD_DATE_STR_OFF_UNSPECIFIED (0x00000000) 154#define MPI3_CI_MANIFEST_MPI_PKG_BUILD_TIME_STR_OFF_UNSPECIFIED (0x00000000) 155union mpi3_ci_manifest { 156 struct mpi3_ci_manifest_mpi mpi; 157 __le32 dword[1]; 158}; 159 160#define MPI3_CI_MANIFEST_TYPE_MPI (0x00) 161struct mpi3_extended_image_header { 162 u8 image_type; 163 u8 reserved01[3]; 164 __le32 checksum; 165 __le32 image_size; 166 __le32 next_image_header_offset; 167 __le32 reserved10[4]; 168 __le32 identify_string[8]; 169}; 170 171#define MPI3_EXT_IMAGE_IMAGETYPE_OFFSET (0x00) 172#define MPI3_EXT_IMAGE_IMAGESIZE_OFFSET (0x08) 173#define MPI3_EXT_IMAGE_NEXTIMAGE_OFFSET (0x0c) 174#define MPI3_EXT_IMAGE_HEADER_SIZE (0x40) 175#define MPI3_EXT_IMAGE_TYPE_UNSPECIFIED (0x00) 176#define MPI3_EXT_IMAGE_TYPE_NVDATA (0x03) 177#define MPI3_EXT_IMAGE_TYPE_SUPPORTED_DEVICES (0x07) 178#define MPI3_EXT_IMAGE_TYPE_ENCRYPTED_HASH (0x09) 179#define MPI3_EXT_IMAGE_TYPE_RDE (0x0a) 180#define MPI3_EXT_IMAGE_TYPE_AUXILIARY_PROCESSOR (0x0b) 181#define MPI3_EXT_IMAGE_TYPE_MIN_PRODUCT_SPECIFIC (0x80) 182#define MPI3_EXT_IMAGE_TYPE_MAX_PRODUCT_SPECIFIC (0xff) 183struct mpi3_supported_device { 184 __le16 device_id; 185 __le16 vendor_id; 186 __le16 device_id_mask; 187 __le16 reserved06; 188 u8 low_pci_rev; 189 u8 high_pci_rev; 190 __le16 reserved0a; 191 __le32 reserved0c; 192}; 193 194#ifndef MPI3_SUPPORTED_DEVICE_MAX 195#define MPI3_SUPPORTED_DEVICE_MAX (1) 196#endif 197struct mpi3_supported_devices_data { 198 u8 image_version; 199 u8 reserved01; 200 u8 num_devices; 201 u8 reserved03; 202 __le32 reserved04; 203 struct mpi3_supported_device supported_device[MPI3_SUPPORTED_DEVICE_MAX]; 204}; 205 206#ifndef MPI3_PUBLIC_KEY_MAX 207#define MPI3_PUBLIC_KEY_MAX (1) 208#endif 209struct mpi3_encrypted_hash_entry { 210 u8 hash_image_type; 211 u8 hash_algorithm; 212 u8 encryption_algorithm; 213 u8 flags; 214 __le16 public_key_size; 215 __le16 signature_size; 216 __le32 public_key[MPI3_PUBLIC_KEY_MAX]; 217}; 218#define MPI3_HASH_IMAGE_TYPE_KEY_WITH_HASH (0x03) 219#define MPI3_HASH_IMAGE_TYPE_KEY_WITH_HASH_1_OF_2 (0x04) 220#define MPI3_HASH_IMAGE_TYPE_KEY_WITH_HASH_2_OF_2 (0x05) 221#define MPI3_HASH_ALGORITHM_VERSION_MASK (0xe0) 222#define MPI3_HASH_ALGORITHM_VERSION_SHIFT (5) 223#define MPI3_HASH_ALGORITHM_VERSION_NONE (0x00) 224#define MPI3_HASH_ALGORITHM_VERSION_SHA1 (0x20) 225#define MPI3_HASH_ALGORITHM_VERSION_SHA2 (0x40) 226#define MPI3_HASH_ALGORITHM_VERSION_SHA3 (0x60) 227#define MPI3_HASH_ALGORITHM_SIZE_MASK (0x1f) 228#define MPI3_HASH_ALGORITHM_SIZE_SHIFT (0) 229#define MPI3_HASH_ALGORITHM_SIZE_UNUSED (0x00) 230#define MPI3_HASH_ALGORITHM_SIZE_SHA256 (0x01) 231#define MPI3_HASH_ALGORITHM_SIZE_SHA512 (0x02) 232#define MPI3_HASH_ALGORITHM_SIZE_SHA384 (0x03) 233#define MPI3_ENCRYPTION_ALGORITHM_UNUSED (0x00) 234#define MPI3_ENCRYPTION_ALGORITHM_RSA256 (0x01) 235#define MPI3_ENCRYPTION_ALGORITHM_RSA512 (0x02) 236#define MPI3_ENCRYPTION_ALGORITHM_RSA1024 (0x03) 237#define MPI3_ENCRYPTION_ALGORITHM_RSA2048 (0x04) 238#define MPI3_ENCRYPTION_ALGORITHM_RSA4096 (0x05) 239#define MPI3_ENCRYPTION_ALGORITHM_RSA3072 (0x06) 240 241/* hierarchical signature system (hss) */ 242#define MPI3_ENCRYPTION_ALGORITHM_ML_DSA_87 (0x0b) 243#define MPI3_ENCRYPTION_ALGORITHM_ML_DSA_65 (0x0c) 244#define MPI3_ENCRYPTION_ALGORITHM_ML_DSA_44 (0x0d) 245#define MPI3_ENCRYPTED_HASH_ENTRY_FLAGS_PAIRED_KEY_MASK (0x0f) 246#define MPI3_ENCRYPTED_HASH_ENTRY_FLAGS_PAIRED_KEY_SHIFT (0) 247 248#ifndef MPI3_ENCRYPTED_HASH_ENTRY_MAX 249#define MPI3_ENCRYPTED_HASH_ENTRY_MAX (1) 250#endif 251struct mpi3_encrypted_hash_data { 252 u8 image_version; 253 u8 num_hash; 254 __le16 reserved02; 255 __le32 reserved04; 256 struct mpi3_encrypted_hash_entry encrypted_hash_entry[MPI3_ENCRYPTED_HASH_ENTRY_MAX]; 257}; 258 259#ifndef MPI3_AUX_PROC_DATA_MAX 260#define MPI3_AUX_PROC_DATA_MAX (1) 261#endif 262struct mpi3_aux_processor_data { 263 u8 boot_method; 264 u8 num_load_addr; 265 u8 reserved02; 266 u8 type; 267 __le32 version; 268 __le32 load_address[8]; 269 __le32 reserved28[22]; 270 __le32 aux_processor_data[MPI3_AUX_PROC_DATA_MAX]; 271}; 272 273#define MPI3_AUX_PROC_DATA_OFFSET (0x80) 274#define MPI3_AUXPROCESSOR_BOOT_METHOD_MO_MSG (0x00) 275#define MPI3_AUXPROCESSOR_BOOT_METHOD_MO_DOORBELL (0x01) 276#define MPI3_AUXPROCESSOR_BOOT_METHOD_COMPONENT (0x02) 277#define MPI3_AUXPROCESSOR_TYPE_ARM_A15 (0x00) 278#define MPI3_AUXPROCESSOR_TYPE_ARM_M0 (0x01) 279#define MPI3_AUXPROCESSOR_TYPE_ARM_R4 (0x02) 280#endif
~/
Read-only file preview.