OS virtual address space. All pointer values are different for a virtual \r
mapping than from the normal physical mapping at boot services time.\r
\r
-Copyright (c) 2006 - 2010 Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2010, 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
+http://opensource.org/licenses/bsd-license.php.\r
\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
Set AtRuntime flag as TRUE after ExitBootServices.\r
\r
- @param[in] Event The Event that is being processed\r
- @param[in] Context Event Context\r
+ @param[in] Event The Event that is being processed.\r
+ @param[in] Context The Event Context.\r
\r
**/\r
VOID\r
Call the passed in Child Notify event and convert any pointers in\r
lib to virtual mode.\r
\r
- @param[in] Event The Event that is being processed\r
- @param[in] Context Event Context\r
+ @param[in] Event The Event that is being processed.\r
+ @param[in] Context The Event Context.\r
**/\r
VOID\r
EFIAPI\r
@param[in] ImageHandle The firmware allocated handle for the EFI image.\r
@param[in] SystemTable A pointer to the EFI System Table.\r
\r
- @retval EFI_SUCCESS Shutdown the Runtime Driver Lib successfully\r
- @retval EFI_UNSUPPORTED Runtime Driver lib was not initialized at all\r
+ @retval EFI_SUCCESS The Runtime Driver Lib shutdown successfully.\r
+ @retval EFI_UNSUPPORTED Runtime Driver lib was not initialized.\r
**/\r
EFI_STATUS\r
EFIAPI\r
@param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()\r
function description.\r
\r
- @retval EFI_SUCCESS The alarm settings were returned.\r
+ @retval EFI_SUCCESS The alarm settings were returned.\r
@retval EFI_INVALID_PARAMETER Enabled is NULL.\r
@retval EFI_INVALID_PARAMETER Pending is NULL.\r
@retval EFI_INVALID_PARAMETER Time is NULL.\r
Variables are stored by the firmware and may maintain their values across power cycles. Each vendor\r
may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.\r
\r
- @param VariableName the name of the vendor's variable, it's a\r
- Null-Terminated Unicode String\r
+ @param VariableName The name of the vendor's variable; it's a Null-Terminated \r
+ Unicode String\r
@param VendorGuid Unify identifier for vendor.\r
- @param Attributes Point to memory location to return the attributes of variable. If the point\r
+ @param Attributes Points to a memory location to return the attributes of variable. If the point\r
is NULL, the parameter would be ignored.\r
@param DataSize The size in bytes of Data-Buffer.\r
- @param Data Point to the content of the variable.\r
+ @param Data Points to the content of the variable.\r
\r
@retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r
defined by the Attributes.\r
32-bit value is nonvolatile and is increased by 1 whenever the system resets or whenever the low\r
32-bit count (returned by GetNextMonoticCount()) overflows.\r
\r
- @param HighCount Pointer to returned value.\r
+ @param HighCount The pointer to returned value.\r
\r
@retval EFI_SUCCESS The next high monotonic count was returned.\r
@retval EFI_DEVICE_ERROR The device is not functioning properly.\r
CapsuleHeaderArray must be the same capsules as the\r
ScatterGatherList. The CapsuleHeaderArray must\r
have the capsules in the same order as the ScatterGatherList.\r
- @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r
+ @param CapsuleCount The number of pointers to EFI_CAPSULE_HEADER in\r
CaspuleHeaderArray.\r
@param ScatterGatherList Physical pointer to a set of\r
EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the\r
@param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r
being passed into update capsule. The capsules are assumed to\r
stored in contiguous virtual memory.\r
- @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r
+ @param CapsuleCount The number of pointers to EFI_CAPSULE_HEADER in\r
CaspuleHeaderArray.\r
@param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can\r
support as an argument to UpdateCapsule() via\r
Undefined on input.\r
@param ResetType Returns the type of reset required for the capsule update.\r
\r
- @retval EFI_SUCCESS Valid answer returned.\r
+ @retval EFI_SUCCESS A valid answer was returned.\r
@retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r
@retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and\r
MaximumCapsuleSize and ResetType are undefined.\r
@param MaximumVariableSize Returns the maximum size of the individual EFI\r
variables associated with the attributes specified.\r
\r
- @retval EFI_SUCCESS Valid answer returned.\r
+ @retval EFI_SUCCESS A valid answer was returned.\r
@retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.\r
@retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r
MaximumVariableStorageSize,\r
projects / mirror_edk2.git / blobdiff