MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c

   1 /** @file
   2   Provide generic extract guided section functions for PEI phase.
   3
   4   Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include <PiPei.h>
  16
  17 #include <Library/DebugLib.h>
  18 #include <Library/PcdLib.h>
  19 #include <Library/BaseMemoryLib.h>
  20 #include <Library/HobLib.h>
  21 #include <Library/ExtractGuidedSectionLib.h>
  22
  23 #define PEI_EXTRACT_HANDLER_INFO_SIGNATURE SIGNATURE_32 ('P', 'E', 'H', 'I')
  24
  25 typedef struct {
  26   UINT32                                  Signature;
  27   UINT32                                  NumberOfExtractHandler;
  28   GUID                                    *ExtractHandlerGuidTable;
  29   EXTRACT_GUIDED_SECTION_DECODE_HANDLER   *ExtractDecodeHandlerTable;
  30   EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *ExtractGetInfoHandlerTable;
  31 } PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO;
  32
  33 /**
  34   Build guid hob for the global memory to store the registered guid and Handler list.
  35   If GuidHob exists, HandlerInfo will be directly got from Guid hob data.
  36
  37   @param[in, out]  InfoPointer   Pointer to pei handler info structure.
  38
  39   @retval  RETURN_SUCCESS            Build Guid hob for the global memory space to store guid and function tables.
  40   @retval  RETURN_OUT_OF_RESOURCES   No enough memory to allocated.
  41 **/
  42 RETURN_STATUS
  43 PeiGetExtractGuidedSectionHandlerInfo (
  44   IN OUT PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO **InfoPointer
  45   )
  46 {
  47   PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
  48   EFI_PEI_HOB_POINTERS                    Hob;
  49
  50   //
  51   // First try to get handler info from guid hob specified by CallerId.
  52   //
  53   Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GetHobList ());
  54   while (Hob.Raw != NULL) {
  55     if (CompareGuid (&(Hob.Guid->Name), &gEfiCallerIdGuid)) {
  56       HandlerInfo = (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *) GET_GUID_HOB_DATA (Hob.Guid);
  57       if (HandlerInfo->Signature == PEI_EXTRACT_HANDLER_INFO_SIGNATURE) {
  58         //
  59         // Update Table Pointer when hob start address is changed.
  60         //
  61         if (HandlerInfo->ExtractHandlerGuidTable != (GUID *) (HandlerInfo + 1)) {
  62           HandlerInfo->ExtractHandlerGuidTable    = (GUID *) (HandlerInfo + 1);
  63           HandlerInfo->ExtractDecodeHandlerTable  = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) (
  64                                                       (UINT8 *)HandlerInfo->ExtractHandlerGuidTable +
  65                                                       PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID)
  66                                                      );
  67           HandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) (
  68                                                       (UINT8 *)HandlerInfo->ExtractDecodeHandlerTable +
  69                                                       PcdGet32 (PcdMaximumGuidedExtractHandler) *
  70                                                       sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER)
  71                                                      );
  72         }
  73         //
  74         // Return HandlerInfo pointer.
  75         //
  76         *InfoPointer = HandlerInfo;
  77         return EFI_SUCCESS;
  78       }
  79     }
  80     Hob.Raw = GET_NEXT_HOB (Hob);
  81     Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, Hob.Raw);
  82   }
  83
  84   //
  85   // If Guid Hob is not found, Build CallerId Guid hob to store Handler Info
  86   //
  87   HandlerInfo = BuildGuidHob (
  88                  &gEfiCallerIdGuid,
  89                  sizeof (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO) +
  90                  PcdGet32 (PcdMaximumGuidedExtractHandler) *
  91                  (sizeof (GUID) + sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER) + sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER))
  92                 );
  93   if (HandlerInfo == NULL) {
  94     //
  95     // No enough resource to build guid hob.
  96     //
  97     *InfoPointer = NULL;
  98     return EFI_OUT_OF_RESOURCES;
  99   }
 100   //
 101   // Init HandlerInfo structure
 102   //
 103   HandlerInfo->Signature = PEI_EXTRACT_HANDLER_INFO_SIGNATURE;
 104   HandlerInfo->NumberOfExtractHandler     = 0;
 105   HandlerInfo->ExtractHandlerGuidTable    = (GUID *) (HandlerInfo + 1);
 106   HandlerInfo->ExtractDecodeHandlerTable  = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) (
 107                                               (UINT8 *)HandlerInfo->ExtractHandlerGuidTable +
 108                                               PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID)
 109                                              );
 110   HandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) (
 111                                               (UINT8 *)HandlerInfo->ExtractDecodeHandlerTable +
 112                                               PcdGet32 (PcdMaximumGuidedExtractHandler) *
 113                                               sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER)
 114                                              );
 115   //
 116   // return the created HandlerInfo.
 117   //
 118   *InfoPointer = HandlerInfo;
 119   return EFI_SUCCESS;
 120 }
 121
 122 /**
 123   Retrieve the list GUIDs that have been registered through ExtractGuidedSectionRegisterHandlers().
 124
 125   Sets ExtractHandlerGuidTable so it points at a callee allocated array of registered GUIDs.
 126   The total number of GUIDs in the array are returned. Since the array of GUIDs is callee allocated
 127   and caller must treat this array of GUIDs as read-only data.
 128   If ExtractHandlerGuidTable is NULL, then ASSERT().
 129
 130   @param[out]  ExtractHandlerGuidTable  A pointer to the array of GUIDs that have been registered through
 131                                         ExtractGuidedSectionRegisterHandlers().
 132
 133   @return the number of the supported extract guided Handler.
 134
 135 **/
 136 UINTN
 137 EFIAPI
 138 ExtractGuidedSectionGetGuidList (
 139   OUT  GUID  **ExtractHandlerGuidTable
 140   )
 141 {
 142   EFI_STATUS Status;
 143   PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
 144
 145   ASSERT (ExtractHandlerGuidTable != NULL);
 146
 147   //
 148   // Get all registered handler information
 149   //
 150   Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);
 151   if (EFI_ERROR (Status)) {
 152     *ExtractHandlerGuidTable = NULL;
 153     return 0;
 154   }
 155
 156   //
 157   // Get GuidTable and Table Number
 158   //
 159   *ExtractHandlerGuidTable = HandlerInfo->ExtractHandlerGuidTable;
 160   return HandlerInfo->NumberOfExtractHandler;
 161 }
 162
 163 /**
 164   Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER
 165   for a specific GUID section type.
 166
 167   Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid.
 168   If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.
 169   If there are not enough resources available to register the handlers  then RETURN_OUT_OF_RESOURCES is returned.
 170
 171   If SectionGuid is NULL, then ASSERT().
 172   If GetInfoHandler is NULL, then ASSERT().
 173   If DecodeHandler is NULL, then ASSERT().
 174
 175   @param[in]  SectionGuid    A pointer to the GUID associated with the the handlers
 176                              of the GUIDed section type being registered.
 177   @param[in]  GetInfoHandler Pointer to a function that examines a GUIDed section and returns the
 178                              size of the decoded buffer and the size of an optional scratch buffer
 179                              required to actually decode the data in a GUIDed section.
 180   @param[in]  DecodeHandler  Pointer to a function that decodes a GUIDed section into a caller
 181                              allocated output buffer.
 182
 183   @retval  RETURN_SUCCESS           The handlers were registered.
 184   @retval  RETURN_OUT_OF_RESOURCES  There are not enough resources available to register the handlers.
 185
 186 **/
 187 RETURN_STATUS
 188 EFIAPI
 189 ExtractGuidedSectionRegisterHandlers (
 190   IN CONST  GUID                                     *SectionGuid,
 191   IN        EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER  GetInfoHandler,
 192   IN        EXTRACT_GUIDED_SECTION_DECODE_HANDLER    DecodeHandler
 193   )
 194 {
 195   EFI_STATUS Status;
 196   UINT32     Index;
 197   PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
 198
 199   //
 200   // Check input paramter
 201   //
 202   ASSERT (SectionGuid != NULL);
 203   ASSERT (GetInfoHandler != NULL);
 204   ASSERT (DecodeHandler != NULL);
 205
 206
 207
 208   //
 209   // Get the registered handler information
 210   //
 211   Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);
 212   if (EFI_ERROR (Status)) {
 213     return Status;
 214   }
 215
 216   //
 217   // Search the match registered GetInfo handler for the input guided section.
 218   //
 219   for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {
 220     if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, SectionGuid)) {
 221       //
 222       // If the guided handler has been registered before, only update its handler.
 223       //
 224       HandlerInfo->ExtractDecodeHandlerTable [Index] = DecodeHandler;
 225       HandlerInfo->ExtractGetInfoHandlerTable [Index] = GetInfoHandler;
 226       return RETURN_SUCCESS;
 227     }
 228   }
 229
 230   //
 231   // Check the global table is enough to contain new Handler.
 232   //
 233   if (HandlerInfo->NumberOfExtractHandler >= PcdGet32 (PcdMaximumGuidedExtractHandler)) {
 234     return RETURN_OUT_OF_RESOURCES;
 235   }
 236
 237   //
 238   // Register new Handler and guid value.
 239   //
 240   CopyGuid (HandlerInfo->ExtractHandlerGuidTable + HandlerInfo->NumberOfExtractHandler, SectionGuid);
 241   HandlerInfo->ExtractDecodeHandlerTable [HandlerInfo->NumberOfExtractHandler] = DecodeHandler;
 242   HandlerInfo->ExtractGetInfoHandlerTable [HandlerInfo->NumberOfExtractHandler++] = GetInfoHandler;
 243
 244   return RETURN_SUCCESS;
 245 }
 246
 247 /**
 248   Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type
 249   EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().
 250   The selected handler is used to retrieve and return the size of the decoded buffer and the size of an
 251   optional scratch buffer required to actually decode the data in a GUIDed section.
 252
 253   Examines a GUIDed section specified by InputSection.
 254   If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
 255   then RETURN_UNSUPPORTED is returned.
 256   If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler
 257   of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
 258   is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of
 259   type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.
 260
 261   If InputSection is NULL, then ASSERT().
 262   If OutputBufferSize is NULL, then ASSERT().
 263   If ScratchBufferSize is NULL, then ASSERT().
 264   If SectionAttribute is NULL, then ASSERT().
 265
 266   @param[in]  InputSection       A pointer to a GUIDed section of an FFS formatted file.
 267   @param[out] OutputBufferSize   A pointer to the size, in bytes, of an output buffer required if the buffer
 268                                  specified by InputSection were decoded.
 269   @param[out] ScratchBufferSize  A pointer to the size, in bytes, required as scratch space if the buffer specified by
 270                                  InputSection were decoded.
 271   @param[out] SectionAttribute   A pointer to the attributes of the GUIDed section.  See the Attributes field of
 272                                  EFI_GUID_DEFINED_SECTION in the PI Specification.
 273
 274   @retval  RETURN_SUCCESS      Get the required information successfully.
 275   @retval  RETURN_UNSUPPORTED  The GUID from the section specified by InputSection does not match any of
 276                                the GUIDs registered with ExtractGuidedSectionRegisterHandlers().
 277   @retval  Others              The return status from the handler associated with the GUID retrieved from
 278                                the section specified by InputSection.
 279
 280 **/
 281 RETURN_STATUS
 282 EFIAPI
 283 ExtractGuidedSectionGetInfo (
 284   IN  CONST VOID    *InputSection,
 285   OUT       UINT32  *OutputBufferSize,
 286   OUT       UINT32  *ScratchBufferSize,
 287   OUT       UINT16  *SectionAttribute
 288   )
 289 {
 290   UINT32 Index;
 291   EFI_STATUS Status;
 292   PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
 293
 294   //
 295   // Check input paramter
 296   //
 297   ASSERT (InputSection != NULL);
 298   ASSERT (OutputBufferSize != NULL);
 299   ASSERT (ScratchBufferSize != NULL);
 300   ASSERT (SectionAttribute != NULL);
 301
 302   //
 303   // Get all registered handler information.
 304   //
 305   Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);
 306   if (EFI_ERROR (Status)) {
 307     return Status;
 308   }
 309
 310   //
 311   // Search the match registered GetInfo handler for the input guided section.
 312   //
 313   for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {
 314     if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {
 315       //
 316       // Call the match handler to get info for the input section data.
 317       //
 318       return HandlerInfo->ExtractGetInfoHandlerTable [Index] (
 319                 InputSection,
 320                 OutputBufferSize,
 321                 ScratchBufferSize,
 322                 SectionAttribute
 323               );
 324     }
 325   }
 326
 327   //
 328   // Not found, the input guided section is not supported.
 329   //
 330   return RETURN_UNSUPPORTED;
 331 }
 332
 333 /**
 334   Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type
 335   EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().
 336   The selected handler is used to decode the data in a GUIDed section and return the result in a caller
 337   allocated output buffer.
 338
 339   Decodes the GUIDed section specified by InputSection.
 340   If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
 341   then RETURN_UNSUPPORTED is returned.
 342   If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler
 343   of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
 344   is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this
 345   decode operation is returned in AuthenticationStatus.  If the decoded buffer is identical to the data in InputSection,
 346   then OutputBuffer is set to point at the data in InputSection.  Otherwise, the decoded data will be placed in caller
 347   allocated buffer specified by OutputBuffer.    This function is responsible for computing the  EFI_AUTH_STATUS_PLATFORM_OVERRIDE
 348   bit of in AuthenticationStatus.  The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned.
 349
 350   If InputSection is NULL, then ASSERT().
 351   If OutputBuffer is NULL, then ASSERT().
 352   If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().
 353   If AuthenticationStatus is NULL, then ASSERT().
 354
 355   @param[in]  InputSection   A pointer to a GUIDed section of an FFS formatted file.
 356   @param[out] OutputBuffer   A pointer to a buffer that contains the result of a decode operation.
 357   @param[in]  ScratchBuffer  A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation.
 358   @param[out] AuthenticationStatus
 359                              A pointer to the authentication status of the decoded output buffer. See the definition
 360                              of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI
 361                              Specification.
 362
 363   @retval  RETURN_SUCCESS           The buffer specified by InputSection was decoded.
 364   @retval  RETURN_UNSUPPORTED       The section specified by InputSection does not match the GUID this handler supports.
 365   @retval  RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded.
 366
 367 **/
 368 RETURN_STATUS
 369 EFIAPI
 370 ExtractGuidedSectionDecode (
 371   IN  CONST VOID    *InputSection,
 372   OUT       VOID    **OutputBuffer,
 373   IN        VOID    *ScratchBuffer,        OPTIONAL
 374   OUT       UINT32  *AuthenticationStatus
 375   )
 376 {
 377   UINT32     Index;
 378   EFI_STATUS Status;
 379   PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;
 380
 381   //
 382   // Check input parameter
 383   //
 384   ASSERT (InputSection != NULL);
 385   ASSERT (OutputBuffer != NULL);
 386   ASSERT (AuthenticationStatus != NULL);
 387
 388   //
 389   // Get all registered handler information.
 390   //
 391   Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);
 392   if (EFI_ERROR (Status)) {
 393     return Status;
 394   }
 395
 396   //
 397   // Search the match registered Extract handler for the input guided section.
 398   //
 399   for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {
 400     if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {
 401       //
 402       // Call the match handler to extract raw data for the input guided section.
 403       //
 404       return HandlerInfo->ExtractDecodeHandlerTable [Index] (
 405                 InputSection,
 406                 OutputBuffer,
 407                 ScratchBuffer,
 408                 AuthenticationStatus
 409               );
 410     }
 411   }
 412
 413   //
 414   // Not found, the input guided section is not supported.
 415   //
 416   return RETURN_UNSUPPORTED;
 417 }