diff options
| author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-09 07:07:50 +0000 |
|---|---|---|
| committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-09 07:07:50 +0000 |
| commit | 504214c4870e9183418014634268ce630eb5332a (patch) | |
| tree | ca283f3d1317f33f0f83e87b92b9e82a4a6f2f10 /MdeModulePkg/Include/Ppi | |
| parent | 6cc9ca322cdfe8417274e3659437750ee833fb54 (diff) | |
| download | edk2-platforms-504214c4870e9183418014634268ce630eb5332a.tar.xz | |
Add comments and DoxyGen format for these files.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5028 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include/Ppi')
| -rw-r--r-- | MdeModulePkg/Include/Ppi/FlashMap.h | 32 |
1 files changed, 19 insertions, 13 deletions
diff --git a/MdeModulePkg/Include/Ppi/FlashMap.h b/MdeModulePkg/Include/Ppi/FlashMap.h index a2ab3388be..f562f888ad 100644 --- a/MdeModulePkg/Include/Ppi/FlashMap.h +++ b/MdeModulePkg/Include/Ppi/FlashMap.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006, Intel Corporation
+ FlashMap PPI abstracts access to FlashMap information.
+
+Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -9,17 +11,7 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-Module Name:
-
- FlashMap.h
-
-Abstract:
-
- FlashMap PPI defined in Tiano
-
- This code abstracts FlashMap access
-
---*/
+**/
#ifndef _PEI_FLASH_MAP_PPI_H_
#define _PEI_FLASH_MAP_PPI_H_
@@ -30,9 +22,23 @@ Abstract: { 0xf34c2fa0, 0xde88, 0x4270, {0x84, 0x14, 0x96, 0x12, 0x22, 0xf4, 0x52, 0x1c } }
typedef struct _PEI_FLASH_MAP_PPI PEI_FLASH_MAP_PPI;
+
//
// Functions
//
+/**
+ Get flash region information.
+
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to the FlashMap PPI instance
+ @param AreaType Flash Area Type
+ @param AreaTypeGuid Pointer to Guid for Flash Area Type
+ @param NumEntries Pointer to the number of entries for the total flash area.
+ @param Entries Pointer to the entry list.
+
+ @retval EFI_SUCESS Get flash area information successfully.
+ @retval EFI_NOT_FOUND No flash area information is found.
+**/
typedef
EFI_STATUS
(EFIAPI *PEI_GET_FLASH_AREA_INFO) (
|