Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  * Copyright 2016-2020 Broadcom Limited. All rights reserved.
0004  *
0005  *          Name: mpi2_image.h
0006  * Description: Contains definitions for firmware and other component images
0007  * Creation Date: 04/02/2018
0008  *       Version: 02.06.04
0009  *
0010  *
0011  * Version History
0012  * ---------------
0013  *
0014  * Date      Version   Description
0015  * --------  --------  ------------------------------------------------------
0016  * 08-01-18  02.06.00  Initial version for MPI 2.6.5.
0017  * 08-14-18  02.06.01  Corrected define for MPI26_IMAGE_HEADER_SIGNATURE0_MPI26
0018  * 08-28-18  02.06.02  Added MPI2_EXT_IMAGE_TYPE_RDE
0019  * 09-07-18  02.06.03  Added MPI26_EVENT_PCIE_TOPO_PI_16_LANES
0020  * 12-17-18  02.06.04  Addd MPI2_EXT_IMAGE_TYPE_PBLP
0021  *          Shorten some defines to be compatible with DOS
0022  * 06-24-19  02.06.05  Whitespace adjustments to help with identifier
0023  *          checking tool.
0024  * 10-02-19  02.06.06  Added MPI26_IMAGE_HEADER_SIG1_COREDUMP
0025  *                     Added MPI2_FLASH_REGION_COREDUMP
0026  */
0027 #ifndef MPI2_IMAGE_H
0028 #define MPI2_IMAGE_H
0029 
0030 
0031 /*FW Image Header */
0032 typedef struct _MPI2_FW_IMAGE_HEADER {
0033     U32 Signature;      /*0x00 */
0034     U32 Signature0;     /*0x04 */
0035     U32 Signature1;     /*0x08 */
0036     U32 Signature2;     /*0x0C */
0037     MPI2_VERSION_UNION MPIVersion;  /*0x10 */
0038     MPI2_VERSION_UNION FWVersion;   /*0x14 */
0039     MPI2_VERSION_UNION NVDATAVersion;   /*0x18 */
0040     MPI2_VERSION_UNION PackageVersion;  /*0x1C */
0041     U16 VendorID;       /*0x20 */
0042     U16 ProductID;      /*0x22 */
0043     U16 ProtocolFlags;  /*0x24 */
0044     U16 Reserved26;     /*0x26 */
0045     U32 IOCCapabilities;    /*0x28 */
0046     U32 ImageSize;      /*0x2C */
0047     U32 NextImageHeaderOffset;  /*0x30 */
0048     U32 Checksum;       /*0x34 */
0049     U32 Reserved38;     /*0x38 */
0050     U32 Reserved3C;     /*0x3C */
0051     U32 Reserved40;     /*0x40 */
0052     U32 Reserved44;     /*0x44 */
0053     U32 Reserved48;     /*0x48 */
0054     U32 Reserved4C;     /*0x4C */
0055     U32 Reserved50;     /*0x50 */
0056     U32 Reserved54;     /*0x54 */
0057     U32 Reserved58;     /*0x58 */
0058     U32 Reserved5C;     /*0x5C */
0059     U32 BootFlags;      /*0x60 */
0060     U32 FirmwareVersionNameWhat;    /*0x64 */
0061     U8 FirmwareVersionName[32]; /*0x68 */
0062     U32 VendorNameWhat; /*0x88 */
0063     U8 VendorName[32];  /*0x8C */
0064     U32 PackageNameWhat;    /*0x88 */
0065     U8 PackageName[32]; /*0x8C */
0066     U32 ReservedD0;     /*0xD0 */
0067     U32 ReservedD4;     /*0xD4 */
0068     U32 ReservedD8;     /*0xD8 */
0069     U32 ReservedDC;     /*0xDC */
0070     U32 ReservedE0;     /*0xE0 */
0071     U32 ReservedE4;     /*0xE4 */
0072     U32 ReservedE8;     /*0xE8 */
0073     U32 ReservedEC;     /*0xEC */
0074     U32 ReservedF0;     /*0xF0 */
0075     U32 ReservedF4;     /*0xF4 */
0076     U32 ReservedF8;     /*0xF8 */
0077     U32 ReservedFC;     /*0xFC */
0078 } MPI2_FW_IMAGE_HEADER, *PTR_MPI2_FW_IMAGE_HEADER,
0079     Mpi2FWImageHeader_t, *pMpi2FWImageHeader_t;
0080 
0081 /*Signature field */
0082 #define MPI2_FW_HEADER_SIGNATURE_OFFSET         (0x00)
0083 #define MPI2_FW_HEADER_SIGNATURE_MASK           (0xFF000000)
0084 #define MPI2_FW_HEADER_SIGNATURE                (0xEA000000)
0085 #define MPI26_FW_HEADER_SIGNATURE               (0xEB000000)
0086 
0087 /*Signature0 field */
0088 #define MPI2_FW_HEADER_SIGNATURE0_OFFSET        (0x04)
0089 #define MPI2_FW_HEADER_SIGNATURE0               (0x5AFAA55A)
0090 /*Last byte is defined by architecture */
0091 #define MPI26_FW_HEADER_SIGNATURE0_BASE         (0x5AEAA500)
0092 #define MPI26_FW_HEADER_SIGNATURE0_ARC_0        (0x5A)
0093 #define MPI26_FW_HEADER_SIGNATURE0_ARC_1        (0x00)
0094 #define MPI26_FW_HEADER_SIGNATURE0_ARC_2        (0x01)
0095 /*legacy (0x5AEAA55A) */
0096 #define MPI26_FW_HEADER_SIGNATURE0_ARC_3        (0x02)
0097 #define MPI26_FW_HEADER_SIGNATURE0 \
0098     (MPI26_FW_HEADER_SIGNATURE0_BASE+MPI26_FW_HEADER_SIGNATURE0_ARC_0)
0099 #define MPI26_FW_HEADER_SIGNATURE0_3516 \
0100     (MPI26_FW_HEADER_SIGNATURE0_BASE+MPI26_FW_HEADER_SIGNATURE0_ARC_1)
0101 #define MPI26_FW_HEADER_SIGNATURE0_4008 \
0102     (MPI26_FW_HEADER_SIGNATURE0_BASE+MPI26_FW_HEADER_SIGNATURE0_ARC_3)
0103 
0104 /*Signature1 field */
0105 #define MPI2_FW_HEADER_SIGNATURE1_OFFSET        (0x08)
0106 #define MPI2_FW_HEADER_SIGNATURE1               (0xA55AFAA5)
0107 #define MPI26_FW_HEADER_SIGNATURE1              (0xA55AEAA5)
0108 
0109 /*Signature2 field */
0110 #define MPI2_FW_HEADER_SIGNATURE2_OFFSET        (0x0C)
0111 #define MPI2_FW_HEADER_SIGNATURE2               (0x5AA55AFA)
0112 #define MPI26_FW_HEADER_SIGNATURE2              (0x5AA55AEA)
0113 
0114 /*defines for using the ProductID field */
0115 #define MPI2_FW_HEADER_PID_TYPE_MASK            (0xF000)
0116 #define MPI2_FW_HEADER_PID_TYPE_SAS             (0x2000)
0117 
0118 #define MPI2_FW_HEADER_PID_PROD_MASK                    (0x0F00)
0119 #define MPI2_FW_HEADER_PID_PROD_A                       (0x0000)
0120 #define MPI2_FW_HEADER_PID_PROD_TARGET_INITIATOR_SCSI   (0x0200)
0121 #define MPI2_FW_HEADER_PID_PROD_IR_SCSI                 (0x0700)
0122 
0123 #define MPI2_FW_HEADER_PID_FAMILY_MASK          (0x00FF)
0124 /*SAS ProductID Family bits */
0125 #define MPI2_FW_HEADER_PID_FAMILY_2108_SAS      (0x0013)
0126 #define MPI2_FW_HEADER_PID_FAMILY_2208_SAS      (0x0014)
0127 #define MPI25_FW_HEADER_PID_FAMILY_3108_SAS     (0x0021)
0128 #define MPI26_FW_HEADER_PID_FAMILY_3324_SAS     (0x0028)
0129 #define MPI26_FW_HEADER_PID_FAMILY_3516_SAS     (0x0031)
0130 
0131 /*use MPI2_IOCFACTS_PROTOCOL_ defines for ProtocolFlags field */
0132 
0133 /*use MPI2_IOCFACTS_CAPABILITY_ defines for IOCCapabilities field */
0134 
0135 #define MPI2_FW_HEADER_IMAGESIZE_OFFSET         (0x2C)
0136 #define MPI2_FW_HEADER_NEXTIMAGE_OFFSET         (0x30)
0137 
0138 #define MPI26_FW_HEADER_BOOTFLAGS_OFFSET          (0x60)
0139 #define MPI2_FW_HEADER_BOOTFLAGS_ISSI32M_FLAG     (0x00000001)
0140 #define MPI2_FW_HEADER_BOOTFLAGS_W25Q256JW_FLAG   (0x00000002)
0141 /*This image has a auto-discovery version of SPI */
0142 #define MPI2_FW_HEADER_BOOTFLAGS_AUTO_SPI_FLAG    (0x00000004)
0143 
0144 
0145 #define MPI2_FW_HEADER_VERNMHWAT_OFFSET         (0x64)
0146 
0147 #define MPI2_FW_HEADER_WHAT_SIGNATURE           (0x29232840)
0148 
0149 #define MPI2_FW_HEADER_SIZE                     (0x100)
0150 
0151 
0152 /****************************************************************************
0153  *              Component Image Format and related defines                  *
0154  ****************************************************************************/
0155 
0156 /*Maximum number of Hash Exclusion entries in a Component Image Header */
0157 #define MPI26_COMP_IMG_HDR_NUM_HASH_EXCL        (4)
0158 
0159 /*Hash Exclusion Format */
0160 typedef struct _MPI26_HASH_EXCLUSION_FORMAT {
0161     U32 Offset;        /*0x00 */
0162     U32 Size;          /*0x04 */
0163 } MPI26_HASH_EXCLUSION_FORMAT,
0164     *PTR_MPI26_HASH_EXCLUSION_FORMAT,
0165     Mpi26HashSxclusionFormat_t,
0166     *pMpi26HashExclusionFormat_t;
0167 
0168 /*FW Image Header */
0169 typedef struct _MPI26_COMPONENT_IMAGE_HEADER {
0170     U32 Signature0;                 /*0x00 */
0171     U32 LoadAddress;                /*0x04 */
0172     U32 DataSize;                   /*0x08 */
0173     U32 StartAddress;               /*0x0C */
0174     U32 Signature1;                 /*0x10 */
0175     U32 FlashOffset;                /*0x14 */
0176     U32 FlashSize;                  /*0x18 */
0177     U32 VersionStringOffset;            /*0x1C */
0178     U32 BuildDateStringOffset;          /*0x20 */
0179     U32 BuildTimeStringOffset;          /*0x24 */
0180     U32 EnvironmentVariableOffset;          /*0x28 */
0181     U32 ApplicationSpecific;            /*0x2C */
0182     U32 Signature2;                 /*0x30 */
0183     U32 HeaderSize;                 /*0x34 */
0184     U32 Crc;                    /*0x38 */
0185     U8 NotFlashImage;               /*0x3C */
0186     U8 Compressed;                  /*0x3D */
0187     U16 Reserved3E;                 /*0x3E */
0188     U32 SecondaryFlashOffset;           /*0x40 */
0189     U32 Reserved44;                 /*0x44 */
0190     U32 Reserved48;                 /*0x48 */
0191     MPI2_VERSION_UNION RMCInterfaceVersion;     /*0x4C */
0192     MPI2_VERSION_UNION Reserved50;          /*0x50 */
0193     MPI2_VERSION_UNION FWVersion;           /*0x54 */
0194     MPI2_VERSION_UNION NvdataVersion;       /*0x58 */
0195     MPI26_HASH_EXCLUSION_FORMAT
0196     HashExclusion[MPI26_COMP_IMG_HDR_NUM_HASH_EXCL];/*0x5C */
0197     U32 NextImageHeaderOffset;          /*0x7C */
0198     U32 Reserved80[32];             /*0x80 -- 0xFC */
0199 } MPI26_COMPONENT_IMAGE_HEADER,
0200     *PTR_MPI26_COMPONENT_IMAGE_HEADER,
0201     Mpi26ComponentImageHeader_t,
0202     *pMpi26ComponentImageHeader_t;
0203 
0204 
0205 /**** Definitions for Signature0 field ****/
0206 #define MPI26_IMAGE_HEADER_SIGNATURE0_MPI26                     (0xEB000042)
0207 
0208 /**** Definitions for Signature1 field ****/
0209 #define MPI26_IMAGE_HEADER_SIG1_APPLICATION              (0x20505041)
0210 #define MPI26_IMAGE_HEADER_SIG1_CBB                      (0x20424243)
0211 #define MPI26_IMAGE_HEADER_SIG1_MFG                      (0x2047464D)
0212 #define MPI26_IMAGE_HEADER_SIG1_BIOS                     (0x534F4942)
0213 #define MPI26_IMAGE_HEADER_SIG1_HIIM                     (0x4D494948)
0214 #define MPI26_IMAGE_HEADER_SIG1_HIIA                     (0x41494948)
0215 #define MPI26_IMAGE_HEADER_SIG1_CPLD                     (0x444C5043)
0216 #define MPI26_IMAGE_HEADER_SIG1_SPD                      (0x20445053)
0217 #define MPI26_IMAGE_HEADER_SIG1_NVDATA                   (0x5444564E)
0218 #define MPI26_IMAGE_HEADER_SIG1_GAS_GAUGE                (0x20534147)
0219 #define MPI26_IMAGE_HEADER_SIG1_PBLP                     (0x504C4250)
0220 /* little-endian "DUMP" */
0221 #define MPI26_IMAGE_HEADER_SIG1_COREDUMP                 (0x504D5544)
0222 
0223 /**** Definitions for Signature2 field ****/
0224 #define MPI26_IMAGE_HEADER_SIGNATURE2_VALUE                    (0x50584546)
0225 
0226 /**** Offsets for Image Header Fields ****/
0227 #define MPI26_IMAGE_HEADER_SIGNATURE0_OFFSET                   (0x00)
0228 #define MPI26_IMAGE_HEADER_LOAD_ADDRESS_OFFSET                 (0x04)
0229 #define MPI26_IMAGE_HEADER_DATA_SIZE_OFFSET                    (0x08)
0230 #define MPI26_IMAGE_HEADER_START_ADDRESS_OFFSET                (0x0C)
0231 #define MPI26_IMAGE_HEADER_SIGNATURE1_OFFSET                   (0x10)
0232 #define MPI26_IMAGE_HEADER_FLASH_OFFSET_OFFSET                 (0x14)
0233 #define MPI26_IMAGE_HEADER_FLASH_SIZE_OFFSET                   (0x18)
0234 #define MPI26_IMAGE_HEADER_VERSION_STRING_OFFSET_OFFSET        (0x1C)
0235 #define MPI26_IMAGE_HEADER_BUILD_DATE_STRING_OFFSET_OFFSET     (0x20)
0236 #define MPI26_IMAGE_HEADER_BUILD_TIME_OFFSET_OFFSET            (0x24)
0237 #define MPI26_IMAGE_HEADER_ENVIROMENT_VAR_OFFSET_OFFSET        (0x28)
0238 #define MPI26_IMAGE_HEADER_APPLICATION_SPECIFIC_OFFSET         (0x2C)
0239 #define MPI26_IMAGE_HEADER_SIGNATURE2_OFFSET                   (0x30)
0240 #define MPI26_IMAGE_HEADER_HEADER_SIZE_OFFSET                  (0x34)
0241 #define MPI26_IMAGE_HEADER_CRC_OFFSET                          (0x38)
0242 #define MPI26_IMAGE_HEADER_NOT_FLASH_IMAGE_OFFSET              (0x3C)
0243 #define MPI26_IMAGE_HEADER_COMPRESSED_OFFSET                   (0x3D)
0244 #define MPI26_IMAGE_HEADER_SECONDARY_FLASH_OFFSET_OFFSET       (0x40)
0245 #define MPI26_IMAGE_HEADER_RMC_INTERFACE_VER_OFFSET            (0x4C)
0246 #define MPI26_IMAGE_HEADER_COMPONENT_IMAGE_VER_OFFSET          (0x54)
0247 #define MPI26_IMAGE_HEADER_HASH_EXCLUSION_OFFSET               (0x5C)
0248 #define MPI26_IMAGE_HEADER_NEXT_IMAGE_HEADER_OFFSET_OFFSET     (0x7C)
0249 
0250 
0251 #define MPI26_IMAGE_HEADER_SIZE                                (0x100)
0252 
0253 
0254 /*Extended Image Header */
0255 typedef struct _MPI2_EXT_IMAGE_HEADER {
0256     U8 ImageType;       /*0x00 */
0257     U8 Reserved1;       /*0x01 */
0258     U16 Reserved2;      /*0x02 */
0259     U32 Checksum;       /*0x04 */
0260     U32 ImageSize;      /*0x08 */
0261     U32 NextImageHeaderOffset;  /*0x0C */
0262     U32 PackageVersion; /*0x10 */
0263     U32 Reserved3;      /*0x14 */
0264     U32 Reserved4;      /*0x18 */
0265     U32 Reserved5;      /*0x1C */
0266     U8 IdentifyString[32];  /*0x20 */
0267 } MPI2_EXT_IMAGE_HEADER, *PTR_MPI2_EXT_IMAGE_HEADER,
0268     Mpi2ExtImageHeader_t, *pMpi2ExtImageHeader_t;
0269 
0270 /*useful offsets */
0271 #define MPI2_EXT_IMAGE_IMAGETYPE_OFFSET         (0x00)
0272 #define MPI2_EXT_IMAGE_IMAGESIZE_OFFSET         (0x08)
0273 #define MPI2_EXT_IMAGE_NEXTIMAGE_OFFSET         (0x0C)
0274 #define MPI2_EXT_IMAGE_PACKAGEVERSION_OFFSET   (0x10)
0275 
0276 #define MPI2_EXT_IMAGE_HEADER_SIZE              (0x40)
0277 
0278 /*defines for the ImageType field */
0279 #define MPI2_EXT_IMAGE_TYPE_UNSPECIFIED             (0x00)
0280 #define MPI2_EXT_IMAGE_TYPE_FW                      (0x01)
0281 #define MPI2_EXT_IMAGE_TYPE_NVDATA                  (0x03)
0282 #define MPI2_EXT_IMAGE_TYPE_BOOTLOADER              (0x04)
0283 #define MPI2_EXT_IMAGE_TYPE_INITIALIZATION          (0x05)
0284 #define MPI2_EXT_IMAGE_TYPE_FLASH_LAYOUT            (0x06)
0285 #define MPI2_EXT_IMAGE_TYPE_SUPPORTED_DEVICES       (0x07)
0286 #define MPI2_EXT_IMAGE_TYPE_MEGARAID                (0x08)
0287 #define MPI2_EXT_IMAGE_TYPE_ENCRYPTED_HASH          (0x09)
0288 #define MPI2_EXT_IMAGE_TYPE_RDE                     (0x0A)
0289 #define MPI2_EXT_IMAGE_TYPE_PBLP                    (0x0B)
0290 #define MPI2_EXT_IMAGE_TYPE_MIN_PRODUCT_SPECIFIC    (0x80)
0291 #define MPI2_EXT_IMAGE_TYPE_MAX_PRODUCT_SPECIFIC    (0xFF)
0292 
0293 #define MPI2_EXT_IMAGE_TYPE_MAX (MPI2_EXT_IMAGE_TYPE_MAX_PRODUCT_SPECIFIC)
0294 
0295 /*FLASH Layout Extended Image Data */
0296 
0297 /*
0298  *Host code (drivers, BIOS, utilities, etc.) should leave this define set to
0299  *one and check RegionsPerLayout at runtime.
0300  */
0301 #ifndef MPI2_FLASH_NUMBER_OF_REGIONS
0302 #define MPI2_FLASH_NUMBER_OF_REGIONS        (1)
0303 #endif
0304 
0305 /*
0306  *Host code (drivers, BIOS, utilities, etc.) should leave this define set to
0307  *one and check NumberOfLayouts at runtime.
0308  */
0309 #ifndef MPI2_FLASH_NUMBER_OF_LAYOUTS
0310 #define MPI2_FLASH_NUMBER_OF_LAYOUTS        (1)
0311 #endif
0312 
0313 typedef struct _MPI2_FLASH_REGION {
0314     U8 RegionType;      /*0x00 */
0315     U8 Reserved1;       /*0x01 */
0316     U16 Reserved2;      /*0x02 */
0317     U32 RegionOffset;   /*0x04 */
0318     U32 RegionSize;     /*0x08 */
0319     U32 Reserved3;      /*0x0C */
0320 } MPI2_FLASH_REGION, *PTR_MPI2_FLASH_REGION,
0321     Mpi2FlashRegion_t, *pMpi2FlashRegion_t;
0322 
0323 typedef struct _MPI2_FLASH_LAYOUT {
0324     U32 FlashSize;      /*0x00 */
0325     U32 Reserved1;      /*0x04 */
0326     U32 Reserved2;      /*0x08 */
0327     U32 Reserved3;      /*0x0C */
0328     MPI2_FLASH_REGION Region[MPI2_FLASH_NUMBER_OF_REGIONS]; /*0x10 */
0329 } MPI2_FLASH_LAYOUT, *PTR_MPI2_FLASH_LAYOUT,
0330     Mpi2FlashLayout_t, *pMpi2FlashLayout_t;
0331 
0332 typedef struct _MPI2_FLASH_LAYOUT_DATA {
0333     U8 ImageRevision;   /*0x00 */
0334     U8 Reserved1;       /*0x01 */
0335     U8 SizeOfRegion;    /*0x02 */
0336     U8 Reserved2;       /*0x03 */
0337     U16 NumberOfLayouts;    /*0x04 */
0338     U16 RegionsPerLayout;   /*0x06 */
0339     U16 MinimumSectorAlignment; /*0x08 */
0340     U16 Reserved3;      /*0x0A */
0341     U32 Reserved4;      /*0x0C */
0342     MPI2_FLASH_LAYOUT Layout[MPI2_FLASH_NUMBER_OF_LAYOUTS]; /*0x10 */
0343 } MPI2_FLASH_LAYOUT_DATA, *PTR_MPI2_FLASH_LAYOUT_DATA,
0344     Mpi2FlashLayoutData_t, *pMpi2FlashLayoutData_t;
0345 
0346 /*defines for the RegionType field */
0347 #define MPI2_FLASH_REGION_UNUSED                (0x00)
0348 #define MPI2_FLASH_REGION_FIRMWARE              (0x01)
0349 #define MPI2_FLASH_REGION_BIOS                  (0x02)
0350 #define MPI2_FLASH_REGION_NVDATA                (0x03)
0351 #define MPI2_FLASH_REGION_FIRMWARE_BACKUP       (0x05)
0352 #define MPI2_FLASH_REGION_MFG_INFORMATION       (0x06)
0353 #define MPI2_FLASH_REGION_CONFIG_1              (0x07)
0354 #define MPI2_FLASH_REGION_CONFIG_2              (0x08)
0355 #define MPI2_FLASH_REGION_MEGARAID              (0x09)
0356 #define MPI2_FLASH_REGION_COMMON_BOOT_BLOCK     (0x0A)
0357 #define MPI2_FLASH_REGION_INIT (MPI2_FLASH_REGION_COMMON_BOOT_BLOCK)
0358 #define MPI2_FLASH_REGION_CBB_BACKUP            (0x0D)
0359 #define MPI2_FLASH_REGION_SBR                   (0x0E)
0360 #define MPI2_FLASH_REGION_SBR_BACKUP            (0x0F)
0361 #define MPI2_FLASH_REGION_HIIM                  (0x10)
0362 #define MPI2_FLASH_REGION_HIIA                  (0x11)
0363 #define MPI2_FLASH_REGION_CTLR                  (0x12)
0364 #define MPI2_FLASH_REGION_IMR_FIRMWARE          (0x13)
0365 #define MPI2_FLASH_REGION_MR_NVDATA             (0x14)
0366 #define MPI2_FLASH_REGION_CPLD                  (0x15)
0367 #define MPI2_FLASH_REGION_PSOC                  (0x16)
0368 #define MPI2_FLASH_REGION_COREDUMP              (0x17)
0369 
0370 /*ImageRevision */
0371 #define MPI2_FLASH_LAYOUT_IMAGE_REVISION        (0x00)
0372 
0373 /*Supported Devices Extended Image Data */
0374 
0375 /*
0376  *Host code (drivers, BIOS, utilities, etc.) should leave this define set to
0377  *one and check NumberOfDevices at runtime.
0378  */
0379 #ifndef MPI2_SUPPORTED_DEVICES_IMAGE_NUM_DEVICES
0380 #define MPI2_SUPPORTED_DEVICES_IMAGE_NUM_DEVICES    (1)
0381 #endif
0382 
0383 typedef struct _MPI2_SUPPORTED_DEVICE {
0384     U16 DeviceID;       /*0x00 */
0385     U16 VendorID;       /*0x02 */
0386     U16 DeviceIDMask;   /*0x04 */
0387     U16 Reserved1;      /*0x06 */
0388     U8 LowPCIRev;       /*0x08 */
0389     U8 HighPCIRev;      /*0x09 */
0390     U16 Reserved2;      /*0x0A */
0391     U32 Reserved3;      /*0x0C */
0392 } MPI2_SUPPORTED_DEVICE, *PTR_MPI2_SUPPORTED_DEVICE,
0393     Mpi2SupportedDevice_t, *pMpi2SupportedDevice_t;
0394 
0395 typedef struct _MPI2_SUPPORTED_DEVICES_DATA {
0396     U8 ImageRevision;   /*0x00 */
0397     U8 Reserved1;       /*0x01 */
0398     U8 NumberOfDevices; /*0x02 */
0399     U8 Reserved2;       /*0x03 */
0400     U32 Reserved3;      /*0x04 */
0401     MPI2_SUPPORTED_DEVICE
0402     SupportedDevice[MPI2_SUPPORTED_DEVICES_IMAGE_NUM_DEVICES];/*0x08 */
0403 } MPI2_SUPPORTED_DEVICES_DATA, *PTR_MPI2_SUPPORTED_DEVICES_DATA,
0404     Mpi2SupportedDevicesData_t, *pMpi2SupportedDevicesData_t;
0405 
0406 /*ImageRevision */
0407 #define MPI2_SUPPORTED_DEVICES_IMAGE_REVISION   (0x00)
0408 
0409 /*Init Extended Image Data */
0410 
0411 typedef struct _MPI2_INIT_IMAGE_FOOTER {
0412     U32 BootFlags;      /*0x00 */
0413     U32 ImageSize;      /*0x04 */
0414     U32 Signature0;     /*0x08 */
0415     U32 Signature1;     /*0x0C */
0416     U32 Signature2;     /*0x10 */
0417     U32 ResetVector;    /*0x14 */
0418 } MPI2_INIT_IMAGE_FOOTER, *PTR_MPI2_INIT_IMAGE_FOOTER,
0419     Mpi2InitImageFooter_t, *pMpi2InitImageFooter_t;
0420 
0421 /*defines for the BootFlags field */
0422 #define MPI2_INIT_IMAGE_BOOTFLAGS_OFFSET        (0x00)
0423 
0424 /*defines for the ImageSize field */
0425 #define MPI2_INIT_IMAGE_IMAGESIZE_OFFSET        (0x04)
0426 
0427 /*defines for the Signature0 field */
0428 #define MPI2_INIT_IMAGE_SIGNATURE0_OFFSET       (0x08)
0429 #define MPI2_INIT_IMAGE_SIGNATURE0              (0x5AA55AEA)
0430 
0431 /*defines for the Signature1 field */
0432 #define MPI2_INIT_IMAGE_SIGNATURE1_OFFSET       (0x0C)
0433 #define MPI2_INIT_IMAGE_SIGNATURE1              (0xA55AEAA5)
0434 
0435 /*defines for the Signature2 field */
0436 #define MPI2_INIT_IMAGE_SIGNATURE2_OFFSET       (0x10)
0437 #define MPI2_INIT_IMAGE_SIGNATURE2              (0x5AEAA55A)
0438 
0439 /*Signature fields as individual bytes */
0440 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_0        (0xEA)
0441 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_1        (0x5A)
0442 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_2        (0xA5)
0443 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_3        (0x5A)
0444 
0445 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_4        (0xA5)
0446 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_5        (0xEA)
0447 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_6        (0x5A)
0448 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_7        (0xA5)
0449 
0450 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_8        (0x5A)
0451 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_9        (0xA5)
0452 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_A        (0xEA)
0453 #define MPI2_INIT_IMAGE_SIGNATURE_BYTE_B        (0x5A)
0454 
0455 /*defines for the ResetVector field */
0456 #define MPI2_INIT_IMAGE_RESETVECTOR_OFFSET      (0x14)
0457 
0458 
0459 /* Encrypted Hash Extended Image Data */
0460 
0461 typedef struct _MPI25_ENCRYPTED_HASH_ENTRY {
0462     U8      HashImageType;      /*0x00 */
0463     U8      HashAlgorithm;      /*0x01 */
0464     U8      EncryptionAlgorithm;    /*0x02 */
0465     U8      Reserved1;      /*0x03 */
0466     U32     Reserved2;      /*0x04 */
0467     U32     EncryptedHash[1];   /*0x08 */ /* variable length */
0468 } MPI25_ENCRYPTED_HASH_ENTRY, *PTR_MPI25_ENCRYPTED_HASH_ENTRY,
0469 Mpi25EncryptedHashEntry_t, *pMpi25EncryptedHashEntry_t;
0470 
0471 /* values for HashImageType */
0472 #define MPI25_HASH_IMAGE_TYPE_UNUSED            (0x00)
0473 #define MPI25_HASH_IMAGE_TYPE_FIRMWARE          (0x01)
0474 #define MPI25_HASH_IMAGE_TYPE_BIOS              (0x02)
0475 
0476 #define MPI26_HASH_IMAGE_TYPE_UNUSED            (0x00)
0477 #define MPI26_HASH_IMAGE_TYPE_FIRMWARE          (0x01)
0478 #define MPI26_HASH_IMAGE_TYPE_BIOS              (0x02)
0479 #define MPI26_HASH_IMAGE_TYPE_KEY_HASH          (0x03)
0480 
0481 /* values for HashAlgorithm */
0482 #define MPI25_HASH_ALGORITHM_UNUSED             (0x00)
0483 #define MPI25_HASH_ALGORITHM_SHA256             (0x01)
0484 
0485 #define MPI26_HASH_ALGORITHM_VER_MASK       (0xE0)
0486 #define MPI26_HASH_ALGORITHM_VER_NONE       (0x00)
0487 #define MPI26_HASH_ALGORITHM_VER_SHA1       (0x20)
0488 #define MPI26_HASH_ALGORITHM_VER_SHA2       (0x40)
0489 #define MPI26_HASH_ALGORITHM_VER_SHA3       (0x60)
0490 #define MPI26_HASH_ALGORITHM_SIZE_MASK      (0x1F)
0491 #define MPI26_HASH_ALGORITHM_SIZE_256           (0x01)
0492 #define MPI26_HASH_ALGORITHM_SIZE_512           (0x02)
0493 
0494 
0495 /* values for EncryptionAlgorithm */
0496 #define MPI25_ENCRYPTION_ALG_UNUSED             (0x00)
0497 #define MPI25_ENCRYPTION_ALG_RSA256             (0x01)
0498 
0499 #define MPI26_ENCRYPTION_ALG_UNUSED             (0x00)
0500 #define MPI26_ENCRYPTION_ALG_RSA256             (0x01)
0501 #define MPI26_ENCRYPTION_ALG_RSA512             (0x02)
0502 #define MPI26_ENCRYPTION_ALG_RSA1024            (0x03)
0503 #define MPI26_ENCRYPTION_ALG_RSA2048            (0x04)
0504 #define MPI26_ENCRYPTION_ALG_RSA4096            (0x05)
0505 
0506 typedef struct _MPI25_ENCRYPTED_HASH_DATA {
0507     U8              ImageVersion;       /*0x00 */
0508     U8              NumHash;        /*0x01 */
0509     U16             Reserved1;      /*0x02 */
0510     U32             Reserved2;      /*0x04 */
0511     MPI25_ENCRYPTED_HASH_ENTRY  EncryptedHashEntry[1];  /*0x08 */
0512 } MPI25_ENCRYPTED_HASH_DATA, *PTR_MPI25_ENCRYPTED_HASH_DATA,
0513 Mpi25EncryptedHashData_t, *pMpi25EncryptedHashData_t;
0514 
0515 
0516 #endif /* MPI2_IMAGE_H */