X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FPpi%2FReadOnlyVariable.h;h=67c6477020e8fb9cb2650c4146fe2ef42911a2a6;hp=d99de161a73da905f9d6367ddb70d48b6fa0bb7b;hb=1c2f052de2064a0f973aa27767516dfbd90b4fbd;hpb=22be261ccf878f9d9835fd3ba5ef1f8628d08256 diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h index d99de161a7..67c6477020 100644 --- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h +++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h @@ -1,20 +1,20 @@ /** @file - This file declares Read-only Variable Service PPI, which is required PPI by framework spec. + This file declares the Read-only Variable Service PPI, which is required by the framework spec. 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, some implementation of the PEI may use the same physical flash part for variable and PEIM - storage; as such, a write command to certain technologies would alter the contents of the entire part, - thus making the in situ PEIM execution not follow the required flow. + storage. As such, a write command to certain technologies would alter the contents of the entire part, + making the PEIM execution in the original position not follow the required flow. - Copyright (c) 2006 - 2009, 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 - http://opensource.org/licenses/bsd-license.php +Copyright (c) 2006 - 2018, 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 that accompanies this distribution. +The full text of the license may be found at +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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is defined in PEI CIS @@ -32,23 +32,24 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI; /// -/// Variable attributes +/// Variable attributes. ///@{ #define EFI_VARIABLE_NON_VOLATILE 0x00000001 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002 #define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004 - /** - /// Inconsistent with specification here: - /// In Framework Spec, PeiCis0.91, neither the macro or its value is defined. - /// Keeping this inconsistancy for backward compatibility. - **/ +/// +/// Inconsistent with specification here: +/// In Framework Spec, PeiCis0.91, neither the macro or its value is defined. +/// Keeping this inconsistancy for backward compatibility. +/// #define EFI_VARIABLE_READ_ONLY 0x00000008 ///@} /** - Get Variable value by Name and GUID pair + Get Variable value by Name and GUID pair. - @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. + @param[in] PeiServices An indirect pointer to the PEI Services Table published + by the PEI Foundation. @param[in] VariableName A NULL-terminated Unicode string that is the name of the vendor's variable. @param[in] VendorGuid A unique identifier for the vendor. @param[out] Attributes This OPTIONAL parameter may be either NULL or @@ -79,24 +80,27 @@ EFI_STATUS /** This function can be called multiple times to retrieve the VariableName and VendorGuid of all variables currently available in the system. On each call - to GetNextVariableName() the previous results are passed into the interface, + to GetNextVariableName(), the previous results are passed into the interface, and on output the interface returns the next variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND is returned. - @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. + @param[in] PeiServices An indirect pointer to the PEI Services Table + published by the PEI Foundation. @param[in] VariableNameSize The size of the VariableName buffer. @param[in] VariableName On input, supplies the last VariableName that was - returned by GetNextVariableName(). On output, returns the Null-terminated - Unicode string of the current variable. + returned by GetNextVariableName(). On output, + returns the Null-terminated Unicode string of the + current variable. @param[in] VendorGuid On input, supplies the last VendorGuid that was - returned by GetNextVariableName(). On output, returns the VendorGuid - of the current variable. + returned by GetNextVariableName(). On output, + returns the VendorGuid of the current variable. @retval EFI_SUCCESS The function completed successfully. @retval EFI_NOT_FOUND The next variable was not found. @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result. @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. - @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error. + @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to + a hardware error. **/ typedef @@ -110,19 +114,19 @@ EFI_STATUS /// /// This PPI provides a lightweight, read-only variant of the full EFI -/// variable services. +/// variable services. /// struct _EFI_PEI_READ_ONLY_VARIABLE_PPI { - /// - /// Inconsistent with specification here: + /// + /// Inconsistent with specification here: /// In Framework Spec, PeiCis0.91, the field is named as GetVariable and GetNextVariableName. - /// Keeping this inconsistance is for backward compatibility. - /// + /// Keeping this inconsistancy for backward compatibility. + /// 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 }; extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid; -#endif /* __PEI_READ_ONLY_VARIABLE_PPI_H__ */ +#endif /* __PEI_READ_ONLY_VARIABLE_PPI_H__ */