diff options
author | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-10 09:35:04 +0000 |
---|---|---|
committer | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-10 09:35:04 +0000 |
commit | 1794e50605b0e4185c003db3d9d4149c38610aa7 (patch) | |
tree | 285a04102d7f0f825b6aa884d60ff0d60fe64fb9 /MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h | |
parent | fd6f5e52b14e61fd19430cb0dcc5c0f76a5c8fbe (diff) | |
download | edk2-platforms-1794e50605b0e4185c003db3d9d4149c38610aa7.tar.xz |
code scrub update
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6980 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h')
-rw-r--r-- | MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h | 144 |
1 files changed, 135 insertions, 9 deletions
diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h index 1688bf1b23..4120506735 100644 --- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h +++ b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h @@ -14,12 +14,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/
-#ifndef _VARIABLE_H
-#define _VARIABLE_H
-
-//
-// Statements that include other header files
-//
+#ifndef _VARIABLE_H_
+#define _VARIABLE_H_
#include <Uefi.h>
@@ -76,11 +72,24 @@ typedef struct { UINT32 FvbInstance;
} ESAL_VARIABLE_GLOBAL;
+///
+/// Don't use module globals after the SetVirtualAddress map is signaled
+///
extern ESAL_VARIABLE_GLOBAL *mVariableModuleGlobal;
-//
-// Functions
-//
+/**
+ Initializes variable store area for non-volatile and volatile variable.
+
+ This function allocates and initializes memory space for global context of ESAL
+ variable service and variable store area for non-volatile and volatile variable.
+
+ @param ImageHandle The Image handle of this driver.
+ @param SystemTable The pointer of EFI_SYSTEM_TABLE.
+
+ @retval EFI_SUCCESS Function successfully executed.
+ @retval EFI_OUT_OF_RESOURCES Fail to allocate enough memory resource.
+
+**/
EFI_STATUS
EFIAPI
VariableCommonInitialize (
@@ -88,6 +97,20 @@ VariableCommonInitialize ( IN EFI_SYSTEM_TABLE *SystemTable
);
+/**
+ Entry point of EmuVariable service module.
+
+ This function is the entry point of EmuVariable service module.
+ It registers all interfaces of Variable Services, initializes
+ variable store for non-volatile and volatile variables, and registers
+ notification function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
+
+ @param ImageHandle The Image handle of this driver.
+ @param SystemTable The pointer of EFI_SYSTEM_TABLE.
+
+ @retval EFI_SUCCESS Variable service successfully initialized.
+
+**/
EFI_STATUS
EFIAPI
VariableServiceInitialize (
@@ -95,6 +118,16 @@ VariableServiceInitialize ( IN EFI_SYSTEM_TABLE *SystemTable
);
+/**
+ Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
+
+ This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
+ It convers pointer to new virtual address.
+
+ @param Event Event whose notification function is being invoked.
+ @param Context Pointer to the notification function's context.
+
+**/
VOID
EFIAPI
VariableClassAddressChangeEvent (
@@ -102,6 +135,28 @@ VariableClassAddressChangeEvent ( IN VOID *Context
);
+/**
+ This code finds variable in storage blocks (Volatile or Non-Volatile).
+
+ @param VariableName A Null-terminated Unicode string that is the name of
+ the vendor's variable.
+ @param VendorGuid A unique identifier for the vendor.
+ @param Attributes If not NULL, a pointer to the memory location to return the
+ attributes bitmask for the variable.
+ @param DataSize Size of Data found. If size is less than the
+ data, this value contains the required size.
+ @param Data On input, the size in bytes of the return Data buffer.
+ On output, the size of data returned in Data.
+ @param Global Pointer to VARIABLE_GLOBAL structure
+ @param Instance Instance of the Firmware Volume.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL DataSize is too small for the result. DataSize has
+ been updated with the size needed to complete the request.
+ @retval EFI_INVALID_PARAMETER VariableName or VendorGuid or DataSize is NULL.
+
+**/
EFI_STATUS
EFIAPI
GetVariable (
@@ -114,6 +169,25 @@ GetVariable ( IN UINT32 Instance
);
+/**
+
+ This code finds the next available variable.
+
+ @param VariableNameSize Size of the variable.
+ @param VariableName On input, supplies the last VariableName that was returned by GetNextVariableName().
+ On output, returns the Null-terminated Unicode string of the current variable.
+ @param VendorGuid On input, supplies the last VendorGuid that was returned by GetNextVariableName().
+ On output, returns the VendorGuid of the current variable.
+ @param Global Pointer to VARIABLE_GLOBAL structure.
+ @param Instance Instance of the Firmware Volume.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The next variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL VariableNameSize is too small for the result.
+ VariableNameSize has been updated with the size needed to complete the request.
+ @retval EFI_INVALID_PARAMETER VariableNameSize or VariableName or VendorGuid is NULL.
+
+**/
EFI_STATUS
EFIAPI
GetNextVariableName (
@@ -124,6 +198,36 @@ GetNextVariableName ( IN UINT32 Instance
);
+/**
+
+ This code sets variable in storage blocks (Volatile or Non-Volatile).
+
+ @param VariableName A Null-terminated Unicode string that is the name of the vendor's
+ variable. Each VariableName is unique for each
+ VendorGuid. VariableName must contain 1 or more
+ Unicode characters. If VariableName is an empty Unicode
+ string, then EFI_INVALID_PARAMETER is returned.
+ @param VendorGuid A unique identifier for the vendor
+ @param Attributes Attributes bitmask to set for the variable
+ @param DataSize The size in bytes of the Data buffer. A size of zero causes the
+ variable to be deleted.
+ @param Data The contents for the variable
+ @param Global Pointer to VARIABLE_GLOBAL structure
+ @param VolatileOffset The offset of last volatile variable
+ @param NonVolatileOffset The offset of last non-volatile variable
+ @param Instance Instance of the Firmware Volume.
+
+ @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
+ defined by the Attributes.
+ @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
+ DataSize exceeds the maximum allowed, or VariableName is an empty
+ Unicode string, or VendorGuid is NULL.
+ @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
+ @retval EFI_WRITE_PROTECTED The variable in question is read-only or cannot be deleted.
+ @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
+
+**/
EFI_STATUS
EFIAPI
SetVariable (
@@ -138,6 +242,28 @@ SetVariable ( IN UINT32 Instance
);
+/**
+
+ This code returns information about the EFI variables.
+
+ @param Attributes Attributes bitmask to specify the type of variables
+ on which to return information.
+ @param MaximumVariableStorageSize On output the maximum size of the storage space available for
+ the EFI variables associated with the attributes specified.
+ @param RemainingVariableStorageSize Returns the remaining size of the storage space available for EFI
+ variables associated with the attributes specified.
+ @param MaximumVariableSize Returns the maximum size of an individual EFI variable
+ associated with the attributes specified.
+ @param Global Pointer to VARIABLE_GLOBAL structure.
+ @param Instance Instance of the Firmware Volume.
+
+ @retval EFI_SUCCESS Valid answer returned.
+ @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
+ @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
+ MaximumVariableStorageSize, RemainingVariableStorageSize,
+ MaximumVariableSize are undefined.
+
+**/
EFI_STATUS
EFIAPI
QueryVariableInfo (
|