]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | This file declares Read-only Variable Service PPI\r | |
3 | \r | |
4 | Copyright (c) 2006, Intel Corporation \r | |
5 | All rights reserved. This program and the accompanying materials \r | |
6 | are licensed and made available under the terms and conditions of the BSD License \r | |
7 | which accompanies this distribution. The full text of the license may be found at \r | |
8 | http://opensource.org/licenses/bsd-license.php \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
12 | \r | |
13 | Module Name: ReadOnlyVariable.h\r | |
14 | \r | |
15 | @par Revision Reference:\r | |
16 | This PPI is defined in PEI CIS\r | |
17 | Version 0.91.\r | |
18 | \r | |
19 | **/\r | |
20 | \r | |
21 | #ifndef __PEI_READ_ONLY_VARIABLE_PPI_H__\r | |
22 | #define __PEI_READ_ONLY_VARIABLE_PPI_H__\r | |
23 | \r | |
24 | #define EFI_PEI_READ_ONLY_VARIABLE_ACCESS_PPI_GUID \\r | |
25 | { \\r | |
26 | 0x3cdc90c6, 0x13fb, 0x4a75, {0x9e, 0x79, 0x59, 0xe9, 0xdd, 0x78, 0xb9, 0xfa } \\r | |
27 | }\r | |
28 | \r | |
29 | typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI;\r | |
30 | \r | |
31 | //\r | |
32 | // Variable attributes\r | |
33 | //\r | |
34 | #define EFI_VARIABLE_NON_VOLATILE 0x00000001\r | |
35 | #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002\r | |
36 | #define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004\r | |
37 | #define EFI_VARIABLE_READ_ONLY 0x00000008\r | |
38 | \r | |
39 | /**\r | |
40 | Get Variable value by Name and GUID pair\r | |
41 | \r | |
0647c9ad | 42 | @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r |
511710d6 | 43 | @param VariableName A NULL-terminated Unicode string that is the name of the vendor's variable.\r |
0647c9ad LG |
44 | @param VendorGuid A unique identifier for the vendor.\r |
45 | @param Attributes If not NULL, a pointer to the memory location to return\r | |
46 | the attributes bitmask for the variable.\r | |
47 | @param DataSize On input, the size in bytes of the return Data buffer.\r | |
48 | On output, the size of data returned in Data.\r | |
49 | @param Data The buffer to return the contents of the variable.\r | |
50 | \r | |
51 | @retval EFI_SUCCESS The function completed successfully.\r | |
52 | @retval EFI_NOT_FOUND The variable was not found.\r | |
53 | @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.\r | |
878ddf1f | 54 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r |
0647c9ad | 55 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r |
878ddf1f | 56 | \r |
57 | **/\r | |
58 | typedef\r | |
59 | EFI_STATUS\r | |
60 | (EFIAPI *EFI_PEI_GET_VARIABLE) (\r | |
61 | IN EFI_PEI_SERVICES **PeiServices,\r | |
62 | IN CHAR16 *VariableName,\r | |
63 | IN EFI_GUID *VendorGuid,\r | |
64 | OUT UINT32 *Attributes OPTIONAL,\r | |
65 | IN OUT UINTN *DataSize,\r | |
66 | OUT VOID *Data\r | |
67 | );\r | |
68 | \r | |
69 | /**\r | |
70 | This function can be called multiple times to retrieve the VariableName \r | |
71 | and VendorGuid of all variables currently available in the system. On each call \r | |
72 | to GetNextVariableName() the previous results are passed into the interface, \r | |
73 | and on output the interface returns the next variable name data. When the \r | |
74 | entire variable list has been returned, the error EFI_NOT_FOUND is returned.\r | |
75 | \r | |
0647c9ad | 76 | @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r |
878ddf1f | 77 | @param VariableNameSize The size of the VariableName buffer.\r |
0647c9ad LG |
78 | @param VariableName On input, supplies the last VariableName that was\r |
79 | returned by GetNextVariableName(). On output, returns the Null-terminated\r | |
80 | Unicode string of the current variable.\r | |
81 | @param VendorGuid On input, supplies the last VendorGuid that was\r | |
82 | returned by GetNextVariableName(). On output, returns the VendorGuid\r | |
83 | of the current variable.\r | |
84 | \r | |
85 | @retval EFI_SUCCESS The function completed successfully.\r | |
86 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
87 | @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r | |
878ddf1f | 88 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r |
0647c9ad | 89 | @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.\r |
878ddf1f | 90 | \r |
91 | **/\r | |
92 | typedef\r | |
93 | EFI_STATUS\r | |
94 | (EFIAPI *EFI_PEI_GET_NEXT_VARIABLE_NAME) (\r | |
95 | IN EFI_PEI_SERVICES **PeiServices,\r | |
96 | IN OUT UINTN *VariableNameSize,\r | |
97 | IN OUT CHAR16 *VariableName,\r | |
98 | IN OUT EFI_GUID *VendorGuid\r | |
99 | );\r | |
100 | \r | |
101 | /**\r | |
102 | @par Ppi Description:\r | |
103 | This PPI provides a lightweight, read-only variant of the full EFI \r | |
104 | variable services. \r | |
105 | \r | |
106 | @param GetVariable\r | |
107 | A service to ascertain a given variable name.\r | |
108 | \r | |
109 | @param GetNextVariableName\r | |
110 | A service to ascertain a variable based upon a given, known variable\r | |
111 | \r | |
112 | **/\r | |
113 | struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {\r | |
114 | EFI_PEI_GET_VARIABLE PeiGetVariable;\r | |
115 | EFI_PEI_GET_NEXT_VARIABLE_NAME PeiGetNextVariableName;\r | |
116 | };\r | |
117 | \r | |
118 | extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;\r | |
119 | \r | |
120 | #endif\r |