IntelFrameworkModulePkg/Universal/SectionExtractionDxe/SectionExtraction.h

   1 /**@file
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   SectionExtraction.c
  15
  16 Abstract:
  17
  18   Section Extraction Protocol implementation.
  19
  20   Stream database is implemented as a linked list of section streams,
  21   where each stream contains a linked list of children, which may be leaves or
  22   encapsulations.
  23
  24   Children that are encapsulations generate new stream entries
  25   when they are created.  Streams can also be created by calls to
  26   SEP->OpenSectionStream().
  27
  28   The database is only created far enough to return the requested data from
  29   any given stream, or to determine that the requested data is not found.
  30
  31   If a GUIDed encapsulation is encountered, there are three possiblilites.
  32
  33   1) A support protocol is found, in which the stream is simply processed with
  34      the support protocol.
  35
  36   2) A support protocol is not found, but the data is available to be read
  37      without processing.  In this case, the database is built up through the
  38      recursions to return the data, and a RPN event is set that will enable
  39      the stream in question to be refreshed if and when the required section
  40      extraction protocol is published.This insures the AuthenticationStatus
  41      does not become stale in the cache.
  42
  43   3) A support protocol is not found, and the data is not available to be read
  44      without it.  This results in EFI_PROTOCOL_ERROR.
  45
  46 **/
  47
  48 #ifndef _SECION_EXTRACTION_H_
  49 #define _SECION_EXTRACTION_H_
  50
  51 #include <FrameworkDxe.h>
  52
  53 #include <Protocol/SectionExtraction.h>
  54
  55 #include <Library/BaseLib.h>
  56 #include <Library/DebugLib.h>
  57 #include <Library/UefiLib.h>
  58 #include <Library/UefiBootServicesTableLib.h>
  59 #include <Library/MemoryAllocationLib.h>
  60 #include <Library/BaseMemoryLib.h>
  61 #include <Protocol/Decompress.h>
  62 #include <Protocol/GuidedSectionExtraction.h>
  63
  64 #endif  // _SECTION_EXTRACTION_H_