/** @file\r
Internal header file for Extended SAL variable service module.\r
\r
-Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
+Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
#define AUTHVAR_KEYDB_NAME_SIZE 38\r
\r
///\r
-/// The maximum size of the public key database, restricted by maximum individal EFI \r
+/// The maximum size of the public key database, restricted by maximum individal EFI\r
/// varible size, and excluding the variable header and name size.\r
///\r
#define MAX_KEYDB_SIZE (FixedPcdGet32 (PcdMaxVariableSize) - sizeof (AUTHENTICATED_VARIABLE_HEADER) - AUTHVAR_KEYDB_NAME_SIZE)\r
\r
This function implements EsalGetVariable function of Extended SAL Variable Services Class.\r
It is equivalent in functionality to the EFI Runtime Service GetVariable().\r
- \r
+\r
@param[in] VariableName A Null-terminated Unicode string that is the name of\r
the vendor's variable.\r
@param[in] VendorGuid A unique identifier for the vendor.\r
- @param[out] Attributes If not NULL, a pointer to the memory location to return the \r
+ @param[out] Attributes If not NULL, a pointer to the memory location to return the\r
attributes bitmask for the variable.\r
@param[in, out] DataSize Size of Data found. If size is less than the\r
data, this value contains the required size.\r
- @param[out] Data On input, the size in bytes of the return Data buffer. \r
+ @param[out] Data On input, the size in bytes of the return Data buffer.\r
On output, the size of data returned in Data.\r
@param[in] VirtualMode Current calling mode for this function.\r
@param[in] Global Context of this Extended SAL Variable Services Class call.\r
\r
- @retval EFI_SUCCESS The function completed successfully. \r
+ @retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NOT_FOUND The variable was not found.\r
- @retval EFI_BUFFER_TOO_SMALL DataSize is too small for the result. DataSize has \r
+ @retval EFI_BUFFER_TOO_SMALL DataSize is too small for the result. DataSize has\r
been updated with the size needed to complete the request.\r
@retval EFI_INVALID_PARAMETER VariableName is NULL.\r
@retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r
\r
This function implements EsalGetNextVariableName function of Extended SAL Variable Services Class.\r
It is equivalent in functionality to the EFI Runtime Service GetNextVariableName().\r
- \r
+\r
@param[in, out] VariableNameSize Size of the variable\r
@param[in, out] VariableName On input, supplies the last VariableName that was returned by GetNextVariableName().\r
On output, returns the Null-terminated Unicode string of the current variable.\r
@param[in, out] VendorGuid On input, supplies the last VendorGuid that was returned by GetNextVariableName().\r
- On output, returns the VendorGuid of the current variable. \r
+ On output, returns the VendorGuid of the current variable.\r
@param[in] VirtualMode Current calling mode for this function.\r
@param[in] Global Context of this Extended SAL Variable Services Class call.\r
\r
- @retval EFI_SUCCESS The function completed successfully. \r
+ @retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NOT_FOUND The next variable was not found.\r
- @retval EFI_BUFFER_TOO_SMALL VariableNameSize is too small for the result. \r
+ @retval EFI_BUFFER_TOO_SMALL VariableNameSize is too small for the result.\r
VariableNameSize has been updated with the size needed to complete the request.\r
@retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r
@retval EFI_INVALID_PARAMETER VariableName is NULL.\r
\r
This function implements EsalSetVariable function of Extended SAL Variable Services Class.\r
It is equivalent in functionality to the EFI Runtime Service SetVariable().\r
- \r
+\r
@param[in] VariableName A Null-terminated Unicode string that is the name of the vendor's\r
- variable. Each VariableName is unique for each \r
- VendorGuid. VariableName must contain 1 or more \r
- Unicode characters. If VariableName is an empty Unicode \r
+ variable. Each VariableName is unique for each\r
+ VendorGuid. VariableName must contain 1 or more\r
+ Unicode characters. If VariableName is an empty Unicode\r
string, then EFI_INVALID_PARAMETER is returned.\r
@param[in] VendorGuid A unique identifier for the vendor.\r
@param[in] Attributes Attributes bitmask to set for the variable.\r
@param[in] VirtualMode Current calling mode for this function.\r
@param[in] Global Context of this Extended SAL Variable Services Class call.\r
\r
- @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as \r
+ @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r
defined by the Attributes.\r
- @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the \r
+ @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the\r
DataSize exceeds the maximum allowed.\r
@retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.\r
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r
\r
@param[in] Attributes Attributes bitmask to specify the type of variables\r
on which to return information.\r
- @param[out] MaximumVariableStorageSize On output the maximum size of the storage space available for \r
- the EFI variables associated with the attributes specified. \r
- @param[out] RemainingVariableStorageSize Returns the remaining size of the storage space available for EFI \r
+ @param[out] MaximumVariableStorageSize On output the maximum size of the storage space available for\r
+ the EFI variables associated with the attributes specified.\r
+ @param[out] RemainingVariableStorageSize Returns the remaining size of the storage space available for EFI\r
variables associated with the attributes specified.\r
- @param[out] MaximumVariableSize Returns the maximum size of an individual EFI variable \r
+ @param[out] MaximumVariableSize Returns the maximum size of an individual EFI variable\r
associated with the attributes specified.\r
@param[in] VirtualMode Current calling mode for this function\r
@param[in] Global Context of this Extended SAL Variable Services Class call\r
\r
@retval EFI_SUCCESS Valid answer returned.\r
@retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.\r
- @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the \r
- MaximumVariableStorageSize, RemainingVariableStorageSize, \r
+ @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r
+ MaximumVariableStorageSize, RemainingVariableStorageSize,\r
MaximumVariableSize are undefined.\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- Update the variable region with Variable information. These are the same \r
+ Update the variable region with Variable information. These are the same\r
arguments as the EFI Variable services.\r
\r
@param[in] VariableName Name of variable.\r
@param[in] DataSize Size of data. 0 means delete.\r
@param[in] Attributes Attributes of the variable.\r
@param[in] KeyIndex Index of associated public key.\r
- @param[in] MonotonicCount Value of associated monotonic count. \r
+ @param[in] MonotonicCount Value of associated monotonic count.\r
@param[in] VirtualMode Current calling mode for this function.\r
@param[in] Global Context of this Extended SAL Variable Services Class call.\r
@param[in] Variable The variable information which is used to keep track of variable usage.\r
IN EFI_GUID *VendorGuid,\r
IN VOID *Data,\r
IN UINTN DataSize,\r
- IN UINT32 Attributes OPTIONAL, \r
+ IN UINT32 Attributes OPTIONAL,\r
IN UINT32 KeyIndex OPTIONAL,\r
IN UINT64 MonotonicCount OPTIONAL,\r
IN BOOLEAN VirtualMode,\r
projects / mirror_edk2.git / blobdiff