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