1. cleanup to refine the doxgen comment.

2. remove unused macro EFI_VARIABLE_READ_ONLY, which is not define by PeiCIS spec.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8782 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
eric_tian 2009-07-07 07:04:59 +00:00
parent af6f4f4b27
commit 7c6b044003
1 changed files with 6 additions and 12 deletions

View File

@ -1,5 +1,6 @@
/** @file /** @file
This file declares Read-only Variable Service PPI This file declares Read-only Variable Service PPI, which is required PPI by framework spec.
These services provide a lightweight, read-only variant of the full EFI variable services. The These services provide a lightweight, read-only variant of the full EFI variable services. The
reason that these services are read-only is to reduce the complexity of flash management. Also, reason that these services are read-only is to reduce the complexity of flash management. Also,
some implementation of the PEI may use the same physical flash part for variable and PEIM some implementation of the PEI may use the same physical flash part for variable and PEIM
@ -15,12 +16,6 @@
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: ReadOnlyVariable.h
@par Revision Reference:
This PPI is defined in PEI CIS
Version 0.91.
**/ **/
#ifndef __PEI_READ_ONLY_VARIABLE_PPI_H__ #ifndef __PEI_READ_ONLY_VARIABLE_PPI_H__
@ -41,7 +36,6 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI;
#define EFI_VARIABLE_NON_VOLATILE 0x00000001 #define EFI_VARIABLE_NON_VOLATILE 0x00000001
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004 #define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
#define EFI_VARIABLE_READ_ONLY 0x00000008
/** /**
Get Variable value by Name and GUID pair Get Variable value by Name and GUID pair
@ -105,10 +99,10 @@ EFI_STATUS
IN OUT EFI_GUID *VendorGuid IN OUT EFI_GUID *VendorGuid
); );
/** ///
This PPI provides a lightweight, read-only variant of the full EFI /// This PPI provides a lightweight, read-only variant of the full EFI
variable services. /// variable services.
**/ ///
struct _EFI_PEI_READ_ONLY_VARIABLE_PPI { struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {
EFI_PEI_GET_VARIABLE PeiGetVariable; ///< A service to ascertain a given variable name. EFI_PEI_GET_VARIABLE PeiGetVariable; ///< A service to ascertain a given variable name.
EFI_PEI_GET_NEXT_VARIABLE_NAME PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable EFI_PEI_GET_NEXT_VARIABLE_NAME PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable