Re: [edk2-devel] [Bug 2321] Add FitGen feature to support uCode Capsule Update

["Chen, Kenji" <kenji.chen@intel.com>]

[-- Attachment #1: Type: text/plain, Size: 3835 bytes --]

Newer version. 

Add -L/-l for Microcode slot mode.

Hi Vincent, Pls follow this to change the usage in postbuild.bat when generating BIOS image.

Thanks, Kenji.
-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Chen, Kenji
Sent: Wednesday, November 13, 2019 9:43 AM
To: Gao, Liming <liming.gao@intel.com>; Ke, VincentX <vincentx.ke@intel.com>
Cc: 'devel@edk2.groups.io' <devel@edk2.groups.io>
Subject: Re: [edk2-devel] [Bug 2321] Add FitGen feature to support uCode Capsule Update

Sure. Added the comment and help message. Will update BZ.

-----Original Message-----
From: Gao, Liming <liming.gao@intel.com>
Sent: Wednesday, November 13, 2019 8:48 AM
To: Chen, Kenji <kenji.chen@intel.com>; Ke, VincentX <vincentx.ke@intel.com>
Cc: 'devel@edk2.groups.io' <devel@edk2.groups.io>
Subject: RE: [edk2-devel] [Bug 2321] Add FitGen feature to support uCode Capsule Update

Kenji:
  This patch adds -S option for Slotsize. Please update FitGen tool help message to list this new option. 
  And, you also need to update BZ https://bugzilla.tianocore.org/show_bug.cgi?id=2321 for this change. 
  Based on current description in BZ, I don't know why need to add -S option.  

Thanks
Liming
>-----Original Message-----
>From: Chen, Kenji
>Sent: Wednesday, November 13, 2019 8:01 AM
>To: Gao, Liming <liming.gao@intel.com>; Ke, VincentX 
><vincentx.ke@intel.com>
>Cc: 'devel@edk2.groups.io' <devel@edk2.groups.io>
>Subject: RE: [edk2-devel] [Bug 2321] Add FitGen feature to support 
>uCode Capsule Update
>
>Updating the correct one.
>+ Vincent to confirm the patch.
>
>Thanks, Kenji.
>-----Original Message-----
>From: Gao, Liming <liming.gao@intel.com>
>Sent: Tuesday, November 12, 2019 11:43 PM
>To: Chen, Kenji <kenji.chen@intel.com>
>Subject: RE: [edk2-devel] [Bug 2321] Add FitGen feature to support 
>uCode Capsule Update
>
>Here is edk2platform git repo
>https://github.com/tianocore/edk2-platforms
>
>> -----Original Message-----
>> From: Gao, Liming
>> Sent: Tuesday, November 12, 2019 11:42 PM
>> To: Chen, Kenji <kenji.chen@intel.com>
>> Subject: RE: [edk2-devel] [Bug 2321] Add FitGen feature to support 
>> uCode
>Capsule Update
>>
>> Can you update the patch base on edk2-
>platforms\Silicon\Intel\Tools\FitGen source?
>>
>> > -----Original Message-----
>> > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of 
>> > Chen,
>Kenji
>> > Sent: Friday, November 8, 2019 4:49 PM
>> > To: 'devel@edk2.groups.io' <devel@edk2.groups.io>
>> > Subject: Re: [edk2-devel] [Bug 2321] Add FitGen feature to support 
>> > uCode
>Capsule Update
>> >
>> > Having problems in git send-email. Send it by outlook.
>> >
>> > -----Original Message-----
>> > From: bugzilla-daemon@bugzilla.tianocore.org <bugzilla-
>daemon@bugzilla.tianocore.org>
>> > Sent: Monday, November 4, 2019 10:14 AM
>> > To: Chen, Kenji <kenji.chen@intel.com>
>> > Subject: [Bug 2321] Add FitGen feature to support uCode Capsule 
>> > Update
>> >
>> > https://bugzilla.tianocore.org/show_bug.cgi?id=2321
>> >
>> > Liming Gao <liming.gao@intel.com> changed:
>> >
>> >            What    |Removed                     |Added
>> > ----------------------------------------------------------------------------
>> >              Status|UNCONFIRMED                 |CONFIRMED
>> >                  CC|                            |liming.gao@intel.com
>> >            Assignee|michael.d.kinney@intel.com  |kenji.chen@intel.com
>> >      Ever confirmed|0                           |1
>> >
>> > --- Comment #1 from Liming Gao <liming.gao@intel.com> --- Kenji is
>working on the patch.
>> >
>> > --
>> > You are receiving this mail because:
>> > You are the assignee for the bug.
>> > You reported the bug.
>> >
>> > 
>
>






[-- Attachment #2: 0001-FitGen-Add-FitGen-feature-to-support-uCode-Capsule-U_20191113_1.patch --]
[-- Type: application/octet-stream, Size: 9272 bytes --]

From 7eb886ff13b52d726847e4c26b1b52b5b639aadc Mon Sep 17 00:00:00 2001
From: Kenji Chen <kenji.chen@intel.com>
Date: Tue, 5 Nov 2019 11:01:32 +0800
Subject: [PATCH] FitGen: Add FitGen feature to support uCode Capsule Update

Add slot mode handling with a header array.

Change-Id: Icee955a8cb4456ceb233e7a068fa7db733464626
Signed-off-by: Kenji Chen <kenji.chen@intel.com>
---
 Silicon/Intel/Tools/FitGen/FitGen.c | 94 +++++++++++++++++++++++++++++++------
 1 file changed, 79 insertions(+), 15 deletions(-)

diff --git a/Silicon/Intel/Tools/FitGen/FitGen.c b/Silicon/Intel/Tools/FitGen/FitGen.c
index faf98800..dc760f02 100644
--- a/Silicon/Intel/Tools/FitGen/FitGen.c
+++ b/Silicon/Intel/Tools/FitGen/FitGen.c
@@ -316,7 +316,8 @@ Returns:
           "\t[-NA]\n"
           "\t[-CLEAR]\n"
           "\t[-I <BiosInfoGuid>]\n"
-          "\t[-S <StartupAcmAddress StartupAcmSize>|<StartupAcmGuid>] [-V <StartupAcmVersion>]\n"
+          "\t[-S <MicrocodeSlotSize>]\n"
+          "\t[-A <StartupAcmAddress StartupAcmSize>|<StartupAcmGuid>] [-V <StartupAcmVersion>]\n"
           "\t[-B <BiosModuleAddress BiosModuleSize>] [-B ...] [-V <BiosModuleVersion>]\n"
           "\t[-M <MicrocodeAddress MicrocodeSize>] [-M ...]|[-U <MicrocodeFv MicrocodeBase>|<MicrocodeRegionOffset MicrocodeRegionSize>|<MicrocodeGuid>] [-V <MicrocodeVersion>]\n"
           "\t[-O RecordType <RecordDataAddress RecordDataSize>|<RESERVE RecordDataSize>|<RecordDataGuid>|<RecordBinFile> [-V <RecordVersion>]] [-O ... [-V ...]]\n"
@@ -340,6 +341,7 @@ Returns:
   printf ("\tMicrocodeRegionOffset  - Offset of Microcode region in input FD image.\n");
   printf ("\tMicrocodeRegionSize    - Size of Microcode region in input FD image.\n");
   printf ("\tMicrocodeGuid          - Guid of Microcode Module.\n");
+  printf ("\tMicrocodeSlotSize      - Occupied region size of each Microcode binary.\n");
   printf ("\t-NA                    - No 0x800 aligned Microcode requirement. No -NA means Microcode is 0x800 aligned.\n");
   printf ("\tRecordType             - FIT entry record type. User should ensure it is ordered.\n");
   printf ("\tRecordDataAddress      - FIT entry record data address.\n");
@@ -765,6 +767,7 @@ Returns:
 {
   EFI_GUID  Guid;
   INTN      Index;
+  UINTN     MicrocodeIndex;
   UINT8     *FileBuffer;
   UINT32    FileSize;
   UINT32    Type;
@@ -774,8 +777,10 @@ Returns:
   UINT32    MicrocodeBase;
   UINT32    MicrocodeSize;
   UINT8     *MicrocodeBuffer;
+  UINT8     *MicrocodeBufferEnd;
   UINT32    MicrocodeRegionOffset;
   UINT32    MicrocodeRegionSize;
+  UINT32    SlotSize;
   STATUS    Status;
   EFI_FIRMWARE_VOLUME_HEADER  *FvHeader;
   UINTN                       FitEntryNumber;
@@ -783,6 +788,7 @@ Returns:
   BIOS_INFO_HEADER            *BiosInfo;
   BIOS_INFO_STRUCT            *BiosInfoStruct;
   UINTN                       BiosInfoIndex;
+  UINT32                      AlignmentByte;
 
   //
   // Init index
@@ -900,7 +906,22 @@ Returns:
   }
 
   //
-  // 0.5 BiosInfo
+  // 0.5 SlotSize
+  //
+  if ((Index + 1 >= argc) ||
+      ((strcmp (argv[Index], "-S") != 0) &&
+       (strcmp (argv[Index], "-s") != 0)) ) {
+    //
+    // Bypass
+    //
+    SlotSize = 0;
+  } else {
+    SlotSize = xtoi (argv[Index + 1]);
+    Index += 2;
+  }
+
+  //
+  // 0.6 BiosInfo
   //
   if ((Index + 1 >= argc) ||
       ((strcmp (argv[Index], "-I") != 0) &&
@@ -998,6 +1019,7 @@ Returns:
 
             MicrocodeFileBuffer = FLASH_TO_MEMORY (MicrocodeRegionOffset, FdBuffer, FdSize);
             MicrocodeFileSize = MicrocodeRegionSize;
+            MicrocodeBufferEnd = MicrocodeFileBuffer + MicrocodeFileSize;
             MicrocodeBase = MicrocodeRegionOffset;
 
             FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)MicrocodeFileBuffer;
@@ -1007,13 +1029,26 @@ Returns:
             } else {
               MicrocodeBuffer = MicrocodeFileBuffer;
             }
+
+            AlignmentByte = 1;
+            AlignmentByte = AlignmentByte << ((FvHeader->Attributes&0x000F0000) >> 16);
+
+            ///
+            /// Make MicrocodeBuffer address to alignment.
+            ///
+            if ((UINT32)MicrocodeBuffer % AlignmentByte != 0) {
+              MicrocodeBuffer = (UINT8 *)((UINT32)MicrocodeBuffer &~(AlignmentByte - 1));
+              MicrocodeBuffer += AlignmentByte;
+            }
+
             while ((UINT32)(MicrocodeBuffer - MicrocodeFileBuffer) < MicrocodeFileSize) {
-              if (*(UINT32 *)(MicrocodeBuffer) != 0x1) { // HeaderVersion
-                break;
-              }
-              if (*(UINT32 *)(MicrocodeBuffer + 20) != 0x1) { // LoaderVersion
-                break;
+              if (*(UINT32 *)(MicrocodeBuffer) != 0x1 ||
+                  *(UINT32 *)(MicrocodeBuffer + 20) != 0x1
+                 ) { // HeaderVersion
+                MicrocodeBuffer += 1024;
+                continue;
               }
+
               if (*(UINT32 *)(MicrocodeBuffer + 28) == 0) { // DataSize
                 MicrocodeSize = 2048;
               } else {
@@ -1036,12 +1071,41 @@ Returns:
               }
               gFitTableContext.Microcode[gFitTableContext.MicrocodeNumber].Type = FIT_TABLE_TYPE_MICROCODE;
               gFitTableContext.Microcode[gFitTableContext.MicrocodeNumber].Address = MicrocodeBase + ((UINT32) (UINTN) MicrocodeBuffer - (UINT32) (UINTN) MicrocodeFileBuffer);
-              gFitTableContext.Microcode[gFitTableContext.MicrocodeNumber].Size = MicrocodeSize;
+              //
+              // No longer use.
+              //
+              //gFitTableContext.Microcode[gFitTableContext.MicrocodeNumber].Size = MicrocodeSize;
               gFitTableContext.MicrocodeNumber++;
               gFitTableContext.FitEntryNumber++;
 
               MicrocodeBuffer += MicrocodeSize;
             }
+
+            if (SlotSize != 0) {
+              ///
+              /// Check whether each uCode is alignment with SlotSize bytes.
+              ///
+              for (MicrocodeIndex = 1; MicrocodeIndex < (INTN)gFitTableContext.MicrocodeNumber; MicrocodeIndex++) {
+                if (gFitTableContext.Microcode[MicrocodeIndex].Address - gFitTableContext.Microcode[MicrocodeIndex - 1].Address != SlotSize) {
+                  printf ("uCode must be follow SlotSize(%lu) alignment.\n", SlotSize);
+                  ASSERT (FALSE);
+                }
+              }
+
+              ///
+              /// Assume the empty space follows the uCode array.
+              ///
+              MicrocodeBuffer = (UINT8 *)(gFitTableContext.Microcode[gFitTableContext.MicrocodeNumber - 1].Address - MicrocodeBase + MicrocodeFileBuffer);
+              MicrocodeBuffer += SlotSize;
+              while (MicrocodeBuffer + SlotSize <= MicrocodeBufferEnd) {
+                gFitTableContext.Microcode[gFitTableContext.MicrocodeNumber].Type = FIT_TABLE_TYPE_MICROCODE;
+                gFitTableContext.Microcode[gFitTableContext.MicrocodeNumber].Address = MicrocodeBase + ((UINT32) (UINTN) MicrocodeBuffer - (UINT32) (UINTN) MicrocodeFileBuffer);
+                gFitTableContext.MicrocodeNumber++;
+                gFitTableContext.FitEntryNumber++;
+
+                MicrocodeBuffer += SlotSize;
+              }
+            }
           }
           break;
         case FIT_TABLE_TYPE_TPM_POLICY:
@@ -1091,20 +1155,20 @@ Returns:
   //
   do {
     if ((Index + 1 >= argc) ||
-        ((strcmp (argv[Index], "-S") != 0) &&
-         (strcmp (argv[Index], "-s") != 0)) ) {
+        ((strcmp (argv[Index], "-A") != 0) &&
+         (strcmp (argv[Index], "-a") != 0)) ) {
       if (BiosInfoExist && (gFitTableContext.StartupAcm.Type == FIT_TABLE_TYPE_STARTUP_ACM)) {
         break;
       }
-//      Error (NULL, 0, 0, "-S Parameter incorrect, expect -S!", NULL);
+//      Error (NULL, 0, 0, "-A Parameter incorrect, expect -A!", NULL);
 //      return 0;
-      printf ("-S not found. WARNING!\n");
+      printf ("-A not found. WARNING!\n");
       break;
     }
     if (IsGuidData (argv[Index + 1], &Guid)) {
       FileBuffer = FindFileFromFvByGuid (FdBuffer, FdSize, &Guid, &FileSize);
       if (FileBuffer == NULL) {
-        Error (NULL, 0, 0, "-S Parameter incorrect, GUID not found!", "%s", argv[Index + 1]);
+        Error (NULL, 0, 0, "-A Parameter incorrect, GUID not found!", "%s", argv[Index + 1]);
         // not found
         return 0;
       }
@@ -1112,7 +1176,7 @@ Returns:
       Index += 2;
     } else {
       if (Index + 2 >= argc) {
-        Error (NULL, 0, 0, "-S Parameter incorrect, expect Address Size!", NULL);
+        Error (NULL, 0, 0, "-A Parameter incorrect, expect Address Size!", NULL);
         return 0;
       }
       FileBuffer = (UINT8 *) (UINTN) xtoi (argv[Index + 1]);
@@ -1120,7 +1184,7 @@ Returns:
       Index += 3;
     }
     if (gFitTableContext.StartupAcm.Type != 0) {
-      Error (NULL, 0, 0, "-S Parameter incorrect, Duplicated StartupAcm!", NULL);
+      Error (NULL, 0, 0, "-A Parameter incorrect, Duplicated StartupAcm!", NULL);
       return 0;
     }
     gFitTableContext.StartupAcm.Type = FIT_TABLE_TYPE_STARTUP_ACM;
-- 
2.16.2.windows.1