IntelFrameworkModulePkg/Universal/SectionExtractionDxe/SectionExtraction.h

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