MdeModulePkg/Include/Ppi/FlashMap.h

   1 /** @file
   2
   3   FlashMap PPI abstracts access to FlashMap information.
   4
   5 Copyright (c) 2006 - 2008, Intel Corporation
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _PEI_FLASH_MAP_PPI_H_
  17 #define _PEI_FLASH_MAP_PPI_H_
  18
  19 #include <Guid/FlashMapHob.h>
  20
  21 #define PEI_FLASH_MAP_PPI_GUID \
  22   { 0xf34c2fa0, 0xde88, 0x4270, {0x84, 0x14, 0x96, 0x12, 0x22, 0xf4, 0x52, 0x1c } }
  23
  24 typedef struct _PEI_FLASH_MAP_PPI PEI_FLASH_MAP_PPI;
  25
  26 //
  27 // Functions
  28 //
  29 /**
  30   Get flash region information.
  31
  32   @param  PeiServices      An indirect pointer to the PEI Services Table published by the PEI Foundation.
  33   @param  This             Pointer to the FlashMap PPI instance
  34   @param  AreaType         Flash Area Type
  35   @param  AreaTypeGuid     Pointer to Guid for Flash Area Type
  36   @param  NumEntries       Pointer to the number of entries for the total flash area.
  37   @param  Entries          Pointer to the entry list.
  38
  39   @retval EFI_SUCESS       Get flash area information successfully.
  40   @retval EFI_NOT_FOUND    No flash area information is found.
  41 **/
  42 typedef
  43 EFI_STATUS
  44 (EFIAPI *PEI_GET_FLASH_AREA_INFO) (
  45   IN  EFI_PEI_SERVICES            **PeiServices,
  46   IN  PEI_FLASH_MAP_PPI            *This,
  47   IN  EFI_FLASH_AREA_TYPE         AreaType,
  48   IN  EFI_GUID                    *AreaTypeGuid,
  49   OUT UINT32                      *NumEntries,
  50   OUT EFI_FLASH_SUBAREA_ENTRY     **Entries
  51   );
  52
  53
  54 struct _PEI_FLASH_MAP_PPI {
  55   PEI_GET_FLASH_AREA_INFO GetAreaInfo;
  56 };
  57
  58 extern EFI_GUID gPeiFlashMapPpiGuid;
  59
  60 #endif