Merge pull request #7 from LongSoft/master

Update with upstream

LICENSE.md

@@ -0,0 +1,23 @@
+Copyright (c) 2015, Nikolaj Schlej
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

UEFIPatch/uefipatch_main.cpp

@@ -31,7 +31,7 @@ int main(int argc, char *argv[])
         result = w.patchFromFile(a.arguments().at(1));
     }
     else {
-        std::cout << "UEFIPatch 0.3.5 - UEFI image file patching utility" << std::endl << std::endl <<
+        std::cout << "UEFIPatch 0.3.9 - UEFI image file patching utility" << std::endl << std::endl <<
             "Usage: UEFIPatch image_file" << std::endl << std::endl <<
             "Patches will be read from patches.txt file\n";
         return ERR_SUCCESS;

basetypes.h

@@ -85,6 +85,8 @@ typedef unsigned int UINTN;
 #define ERR_INVALID_SYMBOL                  40
 #define ERR_NOTHING_TO_PATCH                41
 #define ERR_DEPEX_PARSE_FAILED              42
+#define ERR_TRUNCATED_IMAGE                 43
+#define ERR_BAD_RELOCATION_ENTRY            44
 #define ERR_NOT_IMPLEMENTED                 0xFF
 
 // UDK porting definitions

descriptor.h

@@ -17,11 +17,11 @@ WITHWARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "basetypes.h"
 
 // Make sure we use right packing rules
-#pragma pack(push,1)
+#pragma pack(push, 1)
 
 // Flash descriptor header
 typedef struct _FLASH_DESCRIPTOR_HEADER {
-    UINT8 FfVector[16];            // Must be 16 0xFFs
+    UINT8  FfVector[16];           // Must be 16 0xFFs
     UINT32 Signature;              // 0x0FF0A55A
 } FLASH_DESCRIPTOR_HEADER;
 
@@ -34,37 +34,41 @@ typedef struct _FLASH_DESCRIPTOR_HEADER {
 // Descriptor map
 // Base fields are storing bits [11:4] of actual base addresses, all other bits are 0
 typedef struct _FLASH_DESCRIPTOR_MAP {
-    UINT8  ComponentBase;           // 0x03 on most machines
-    UINT8  NumberOfFlashChips;      // Zero-based number of flash chips installed on board
-    UINT8  RegionBase;              // 0x04 on most machines
-    UINT8  NumberOfRegions;         // Zero-based number of flash regions (descriptor is always included)
-    UINT8  MasterBase;              // 0x06 on most machines
-    UINT8  NumberOfMasters;         // Zero-based number of flash masters
-    UINT8  PchStrapsBase;           // 0x10 on most machines
-    UINT8  NumberOfPchStraps;       // One-based number of UINT32s to read as PCH Straps, min=0, max=255 (1 Kb)
-    UINT8  ProcStrapsBase;          // 0x20 on most machines
-    UINT8  NumberOfProcStraps;      // Number of PROC straps to be read, can be 0 or 1
-    UINT8  IccTableBase;            // 0x21 on most machines
-    UINT8  NumberOfIccTableEntries; // 0x00 on most machines
-    UINT8  DmiTableBase;            // 0x25 on most machines
-    UINT8  NumberOfDmiTableEntries; // 0x00 on most machines
-    UINT16 ReservedZero;            // Still unknown, zeros in all descriptors I have seen
+    // FLMAP0
+    UINT32 ComponentBase : 8;           
+    UINT32 NumberOfFlashChips : 2;      // Zero-based number of flash chips installed on board
+    UINT32 : 6;
+    UINT32 RegionBase : 8;
+    UINT32 NumberOfRegions : 3;         // Reserved in v2 descriptor
+    UINT32 : 5;
+    // FLMAP 1
+    UINT32 MasterBase : 8;              
+    UINT32 NumberOfMasters : 2;         // Zero-based number of flash masters
+    UINT32 : 6;
+    UINT32 PchStrapsBase : 8;           
+    UINT32 NumberOfPchStraps : 8;       // One-based number of UINT32s to read as PCH straps, min=0, max=255 (1 Kb)
+    // FLMAP 2
+    UINT32 ProcStrapsBase : 8;          
+    UINT32 NumberOfProcStraps : 8;      // One-based number of UINT32s to read as processor straps, min=0, max=255 (1 Kb)
+    UINT32: 16;
 } FLASH_DESCRIPTOR_MAP;
 
+#define FLASH_DESCRIPTOR_MAX_BASE 0xE0
+
 // Component section
 // Flash parameters DWORD structure
 typedef struct _FLASH_PARAMETERS {
-    UINT8 FirstChipDensity : 3;
-    UINT8 SecondChipDensity : 3;
-    UINT8 ReservedZero0 : 2;  // Still unknown, zeros in all descriptors I have seen
-    UINT8 ReservedZero1 : 8;  // Still unknown, zeros in all descriptors I have seen
-    UINT8 ReservedZero2 : 4;  // Still unknown, zeros in all descriptors I have seen
+    UINT8 FirstChipDensity : 4;
+    UINT8 SecondChipDensity : 4;
+    UINT8 : 8;
+    UINT8 : 1;
+    UINT8 ReadClockFrequency : 3; // Hardcoded value of 20 Mhz (000b) in v1 descriptors and 17 Mhz (110b) in v2 ones
     UINT8 FastReadEnabled : 1;
-    UINT8 FastReadFreqency : 3;
-    UINT8 FlashReadStatusFrequency : 3;
+    UINT8 FastReadFrequency : 3;
     UINT8 FlashWriteFrequency : 3;
+    UINT8 FlashReadStatusFrequency : 3;
     UINT8 DualOutputFastReadSupported : 1;
-    UINT8 ReservedZero3 : 1;  // Still unknown, zero in all descriptors I have seen
+    UINT8 : 1;
 } FLASH_PARAMETERS;
 
 // Flash densities
@@ -74,11 +78,16 @@ typedef struct _FLASH_PARAMETERS {
 #define FLASH_DENSITY_4MB     0x03
 #define FLASH_DENSITY_8MB     0x04
 #define FLASH_DENSITY_16MB    0x05
+#define FLASH_DENSITY_32MB    0x06
+#define FLASH_DENSITY_64MB    0x07
+#define FLASH_DENSITY_UNUSED  0x0F
 
 // Flash frequencies
-#define FLASH_FREQUENCY_20MHZ  0x00
-#define FLASH_FREQUENCY_33MHZ  0x01
-#define FLASH_FREQUENCY_50MHZ  0x04
+#define FLASH_FREQUENCY_20MHZ       0x00
+#define FLASH_FREQUENCY_33MHZ       0x01
+#define FLASH_FREQUENCY_48MHZ       0x02
+#define FLASH_FREQUENCY_50MHZ_30MHZ 0x04
+#define FLASH_FREQUENCY_17MHZ       0x06
 
 // Component section structure
 typedef struct _FLASH_DESCRIPTOR_COMPONENT_SECTION {
@@ -87,52 +96,82 @@ typedef struct _FLASH_DESCRIPTOR_COMPONENT_SECTION {
     UINT8            InvalidInstruction1;  //
     UINT8            InvalidInstruction2;  //
     UINT8            InvalidInstruction3;  //
-    UINT16           PartitionBoundary;    // Upper 16 bit of partition boundary address. Default is 0x0000, which makes the boundary to be 0x00001000
-    UINT16           ReservedZero;         // Still unknown, zero in all descriptors I have seen
 } FLASH_DESCRIPTOR_COMPONENT_SECTION;
 
+// Component section structure
+typedef struct _FLASH_DESCRIPTOR_COMPONENT_SECTION_V2 {
+    FLASH_PARAMETERS FlashParameters;
+    UINT8            InvalidInstruction0;  // Instructions for SPI chip, that must not be executed, like FLASH ERASE
+    UINT8            InvalidInstruction1;  //
+    UINT8            InvalidInstruction2;  //
+    UINT8            InvalidInstruction3;  //
+    UINT8            InvalidInstruction4;  //
+    UINT8            InvalidInstruction5;  //
+    UINT8            InvalidInstruction6;  //
+    UINT8            InvalidInstruction7;  //
+} FLASH_DESCRIPTOR_COMPONENT_SECTION_V2;
+
 // Region section
 // All base and limit register are storing upper part of actual UINT32 base and limit
 // If limit is zero - region is not present
 typedef struct _FLASH_DESCRIPTOR_REGION_SECTION {
-    UINT16 ReservedZero;                  // Still unknown, zero in all descriptors I have seen
-    UINT16 FlashBlockEraseSize;           // Size of block erased by single BLOCK ERASE command
-    UINT16 BiosBase;
-    UINT16 BiosLimit;
-    UINT16 MeBase;
-    UINT16 MeLimit;
-    UINT16 GbeBase;
-    UINT16 GbeLimit;
-    UINT16 PdrBase;
-    UINT16 PdrLimit;
+    UINT16 DescriptorBase;             // Descriptor
+    UINT16 DescriptorLimit;            //
+    UINT16 BiosBase;                   // BIOS
+    UINT16 BiosLimit;                  //
+    UINT16 MeBase;                     // ME
+    UINT16 MeLimit;                    //
+    UINT16 GbeBase;                    // GbE
+    UINT16 GbeLimit;                   //
+    UINT16 PdrBase;                    // PDR
+    UINT16 PdrLimit;                   //
+    UINT16 Region5Base;                // Reserved region
+    UINT16 Region5Limit;               //
+    UINT16 Region6Base;                // Reserved region
+    UINT16 Region6Limit;               //
+    UINT16 Region7Base;                // Reserved region
+    UINT16 Region7Limit;               //
+    UINT16 EcBase;                     // EC
+    UINT16 EcLimit;                    //
 } FLASH_DESCRIPTOR_REGION_SECTION;
 
-// Flash block erase sizes
-#define FLASH_BLOCK_ERASE_SIZE_4KB  0x0000
-#define FLASH_BLOCK_ERASE_SIZE_8KB  0x0001
-#define FLASH_BLOCK_ERASE_SIZE_64KB 0x000F
-
 // Master section
 typedef struct _FLASH_DESCRIPTOR_MASTER_SECTION {
     UINT16 BiosId;
-    UINT8 BiosRead;
-    UINT8 BiosWrite;
+    UINT8  BiosRead;
+    UINT8  BiosWrite;
     UINT16 MeId;
-    UINT8 MeRead;
-    UINT8 MeWrite;
+    UINT8  MeRead;
+    UINT8  MeWrite;
     UINT16 GbeId;
-    UINT8 GbeRead;
-    UINT8 GbeWrite;
+    UINT8  GbeRead;
+    UINT8  GbeWrite;
 } FLASH_DESCRIPTOR_MASTER_SECTION;
 
+// Master section v2 (Skylake+)
+typedef struct _FLASH_DESCRIPTOR_MASTER_SECTION_V2 {
+    UINT32 : 8;
+    UINT32 BiosRead : 12;
+    UINT32 BiosWrite : 12;
+    UINT32 : 8;
+    UINT32 MeRead : 12;
+    UINT32 MeWrite : 12;
+    UINT32 : 8;
+    UINT32 GbeRead : 12;
+    UINT32 GbeWrite : 12;
+    UINT32 :32;
+    UINT32 : 8;
+    UINT32 EcRead : 12;
+    UINT32 EcWrite : 12;
+} FLASH_DESCRIPTOR_MASTER_SECTION_V2;
+
 // Region access bits in master section
 #define FLASH_DESCRIPTOR_REGION_ACCESS_DESC 0x01
 #define FLASH_DESCRIPTOR_REGION_ACCESS_BIOS 0x02
 #define FLASH_DESCRIPTOR_REGION_ACCESS_ME   0x04
 #define FLASH_DESCRIPTOR_REGION_ACCESS_GBE  0x08
 #define FLASH_DESCRIPTOR_REGION_ACCESS_PDR  0x10
-
-//!TODO: Describe PCH and PROC straps sections, as well as ICC and DMI tables
+#define FLASH_DESCRIPTOR_REGION_ACCESS_EC   0x20
 
 // Base address of descriptor upper map
 #define FLASH_DESCRIPTOR_UPPER_MAP_BASE 0x0EFC
@@ -155,7 +194,7 @@ typedef struct _VSCC_TABLE_ENTRY {
 
 // Base address and size of OEM section
 #define FLASH_DESCRIPTOR_OEM_SECTION_BASE 0x0F00
-#define FLASH_DESCRIPTOR_OEM_SECTION_SIZE 0xFF
+#define FLASH_DESCRIPTOR_OEM_SECTION_SIZE 0x100
 
 // Restore previous packing rules
 #pragma pack(pop)

ffs.cpp

@@ -155,7 +155,7 @@ UINT32 sizeOfSectionHeader(const EFI_COMMON_SECTION_HEADER* header)
     if (!header)
         return 0;
 
-    bool extended = false;
+    const bool extended = false;
     /*if (uint24ToUint32(header->Size) == EFI_SECTION2_IS_USED) {
         extended = true;
     }*/

ffs.h

@@ -32,7 +32,7 @@ extern QString sectionTypeToQString(const UINT8 type);
 //*****************************************************************************
 // EFI Capsule
 //*****************************************************************************
-// Capsule header
+// Standard EFI Capsule header
 typedef struct _EFI_CAPSULE_HEADER {
     EFI_GUID  CapsuleGuid;
     UINT32    HeaderSize;
@@ -49,16 +49,32 @@ typedef struct _EFI_CAPSULE_HEADER {
 const QByteArray EFI_CAPSULE_GUID
 ("\xBD\x86\x66\x3B\x76\x0D\x30\x40\xB7\x0E\xB5\x51\x9E\x2F\xC5\xA0", 16);
 
+// Intel capsule GUID
+const QByteArray INTEL_CAPSULE_GUID
+("\xB9\x82\x91\x53\xB5\xAB\x91\x43\xB6\x9A\xE3\xA9\x43\xF7\x2F\xCC", 16);
+
+// Toshiba EFI Capsule header
+typedef struct _TOSHIBA_CAPSULE_HEADER {
+    EFI_GUID  CapsuleGuid;
+    UINT32    HeaderSize;
+    UINT32    FullSize;
+    UINT32    Flags;
+} TOSHIBA_CAPSULE_HEADER;
+
+// Toshiba capsule GUID
+const QByteArray TOSHIBA_CAPSULE_GUID
+("\x62\x70\xE0\x3B\x51\x1D\xD2\x45\x83\x2B\xF0\x93\x25\x7E\xD4\x61", 16);
+
 // AMI Aptio extended capsule header
 typedef struct _APTIO_CAPSULE_HEADER {
     EFI_CAPSULE_HEADER    CapsuleHeader;
-    UINT16                RomImageOffset;	// offset in bytes from the beginning of the capsule header to the start of
+    UINT16                RomImageOffset;   // offset in bytes from the beginning of the capsule header to the start of
     // the capsule volume
     //!TODO: Enable certificate and ROM layout reading
-    //UINT16                RomLayoutOffset;	// offset to the table of the module descriptors in the capsule's volume
+    //UINT16                RomLayoutOffset;    // offset to the table of the module descriptors in the capsule's volume
     // that are included in the signature calculation
     //FW_CERTIFICATE      FWCert;
-    //ROM_AREA			  RomAreaMap[1];
+    //ROM_AREA            RomAreaMap[1];
 } APTIO_CAPSULE_HEADER;
 
 // AMI Aptio signed extended capsule GUID
@@ -93,7 +109,7 @@ typedef struct _EFI_FIRMWARE_VOLUME_HEADER {
     UINT16                 ExtHeaderOffset;  //Reserved in Revision 1
     UINT8                  Reserved;
     UINT8                  Revision;
-    //EFI_FV_BLOCK_MAP_ENTRY FvBlockMap[1];
+    //EFI_FV_BLOCK_MAP_ENTRY FvBlockMap[2];
 } EFI_FIRMWARE_VOLUME_HEADER;
 
 // Standard file system GUIDs
@@ -252,8 +268,8 @@ extern UINT16 calculateChecksum16(const UINT16* buffer, UINT32 bufferSize);
 // Integrity check
 typedef union {
     struct {
-        UINT8	Header;
-        UINT8	File;
+        UINT8   Header;
+        UINT8   File;
     } Checksum;
     UINT16 TailReference;   // Revision 1
     UINT16 Checksum16;      // Revision 2