]>
Commit | Line | Data |
---|---|---|
9071550e | 1 | /*++\r |
2 | \r | |
b1f700a8 HT |
3 | Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r |
4 | This program and the accompanying materials \r | |
9071550e | 5 | are licensed and made available under the terms and conditions of the BSD License \r |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | FSVariable.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | --*/\r | |
19 | \r | |
20 | #ifndef _FS_VARIABLE_H\r | |
21 | #define _FS_VARIABLE_H\r | |
22 | \r | |
23 | //\r | |
24 | // Statements that include other header files\r | |
25 | //\r | |
26 | #include <PiDxe.h>\r | |
27 | \r | |
28 | #include <Library/BaseLib.h>\r | |
29 | #include <Library/PcdLib.h>\r | |
30 | #include <Library/BaseMemoryLib.h>\r | |
d7f79118 | 31 | #include <Library/MemoryAllocationLib.h>\r |
9071550e | 32 | #include <Library/UefiBootServicesTableLib.h>\r |
33 | #include <Library/UefiRuntimeLib.h>\r | |
34 | #include <Library/DebugLib.h>\r | |
35 | #include <Library/UefiLib.h>\r | |
36 | #include <Library/HobLib.h>\r | |
37 | #include <Library/DxeServicesTableLib.h>\r | |
38 | #include <Library/DevicePathLib.h>\r | |
39 | \r | |
40 | #include <Guid/HobList.h>\r | |
41 | #include <Guid/FlashMapHob.h>\r | |
3709c4cd | 42 | #include <Guid/VariableFormat.h>\r |
a24b4043 | 43 | #include <Guid/GlobalVariable.h>\r |
9071550e | 44 | #include <Protocol/Variable.h>\r |
45 | #include <Protocol/VariableWrite.h>\r | |
46 | #include <Protocol/SimpleFileSystem.h>\r | |
47 | #include <Protocol/BlockIo.h>\r | |
48 | \r | |
49 | \r | |
50 | #include "EfiFlashMap.h"\r | |
9071550e | 51 | #include "VariableStorage.h"\r |
52 | \r | |
a24b4043 | 53 | #define VOLATILE_VARIABLE_STORE_SIZE FixedPcdGet32(PcdVariableStoreSize)\r |
54 | #define VARIABLE_SCRATCH_SIZE MAX(FixedPcdGet32(PcdMaxVariableSize), FixedPcdGet32(PcdMaxHardwareErrorVariableSize))\r | |
9071550e | 55 | #define VARIABLE_RECLAIM_THRESHOLD (1024)\r |
a24b4043 | 56 | ///\r |
57 | /// The size of a 3 character ISO639 language code.\r | |
58 | ///\r | |
59 | #define ISO_639_2_ENTRY_SIZE 3\r | |
9071550e | 60 | \r |
9071550e | 61 | #define GET_VARIABLE_NAME_PTR(a) (CHAR16 *) ((UINTN) (a) + sizeof (VARIABLE_HEADER))\r |
62 | \r | |
63 | typedef enum {\r | |
64 | Physical,\r | |
65 | Virtual\r | |
66 | } VARIABLE_POINTER_TYPE;\r | |
67 | \r | |
68 | typedef enum {\r | |
69 | NonVolatile,\r | |
70 | Volatile,\r | |
71 | MaxType\r | |
72 | } VARIABLE_STORAGE_TYPE;\r | |
73 | \r | |
74 | typedef struct {\r | |
75 | VARIABLE_HEADER *CurrPtr;\r | |
76 | VARIABLE_HEADER *EndPtr;\r | |
77 | VARIABLE_HEADER *StartPtr;\r | |
78 | VARIABLE_STORAGE_TYPE Type;\r | |
79 | } VARIABLE_POINTER_TRACK;\r | |
80 | \r | |
81 | #define VARIABLE_MEMBER_OFFSET(Member, StartOffset) \\r | |
82 | ( sizeof (VARIABLE_STORE_HEADER) + (StartOffset) + \\r | |
83 | (UINTN) ((UINT8 *) &((VARIABLE_HEADER*) 0)->Member - (UINT8 *) &((VARIABLE_HEADER*) 0)->StartId) \\r | |
84 | )\r | |
85 | \r | |
86 | \r | |
87 | typedef struct {\r | |
88 | EFI_EVENT_NOTIFY GoVirtualChildEvent[MaxType];\r | |
89 | VARIABLE_STORAGE *VariableStore[MaxType]; // Instance of VariableStorage\r | |
90 | VOID *VariableBase[MaxType]; // Start address of variable storage\r | |
91 | UINTN LastVariableOffset[MaxType]; // The position to write new variable to (index from VariableBase)\r | |
92 | VOID *Scratch; // Buffer used during reclaim\r | |
a24b4043 | 93 | UINTN CommonVariableTotalSize;\r |
94 | UINTN HwErrVariableTotalSize;\r | |
d7f79118 RN |
95 | CHAR8 *PlatformLangCodes;\r |
96 | CHAR8 *LangCodes;\r | |
97 | CHAR8 *PlatformLang;\r | |
98 | CHAR8 Lang[ISO_639_2_ENTRY_SIZE + 1];\r | |
9071550e | 99 | } VARIABLE_GLOBAL;\r |
100 | \r | |
101 | //\r | |
102 | // Functions\r | |
103 | //\r | |
104 | \r | |
105 | EFI_STATUS\r | |
106 | EFIAPI\r | |
107 | VariableServiceInitialize (\r | |
108 | IN EFI_HANDLE ImageHandle,\r | |
109 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
ed66e1bc | 110 | );\r |
9071550e | 111 | \r |
112 | VOID\r | |
113 | EFIAPI\r | |
114 | VariableClassAddressChangeEvent (\r | |
115 | IN EFI_EVENT Event,\r | |
116 | IN VOID *Context\r | |
ed66e1bc | 117 | );\r |
9071550e | 118 | \r |
119 | EFI_STATUS\r | |
120 | EFIAPI\r | |
3ffa0f1f | 121 | DuetGetVariable (\r |
9071550e | 122 | IN CHAR16 *VariableName,\r |
123 | IN EFI_GUID *VendorGuid,\r | |
124 | OUT UINT32 *Attributes OPTIONAL,\r | |
125 | IN OUT UINTN *DataSize,\r | |
126 | OUT VOID *Data\r | |
ed66e1bc | 127 | );\r |
9071550e | 128 | \r |
129 | EFI_STATUS\r | |
130 | EFIAPI\r | |
131 | GetNextVariableName (\r | |
132 | IN OUT UINTN *VariableNameSize,\r | |
133 | IN OUT CHAR16 *VariableName,\r | |
134 | IN OUT EFI_GUID *VendorGuid\r | |
ed66e1bc | 135 | );\r |
9071550e | 136 | \r |
137 | EFI_STATUS\r | |
138 | EFIAPI\r | |
139 | SetVariable (\r | |
140 | IN CHAR16 *VariableName,\r | |
141 | IN EFI_GUID *VendorGuid,\r | |
142 | IN UINT32 Attributes,\r | |
143 | IN UINTN DataSize,\r | |
144 | IN VOID *Data\r | |
ed66e1bc | 145 | );\r |
9071550e | 146 | \r |
9071550e | 147 | EFI_STATUS\r |
148 | EFIAPI\r | |
149 | QueryVariableInfo (\r | |
150 | IN UINT32 Attributes,\r | |
151 | OUT UINT64 *MaximumVariableStorageSize,\r | |
152 | OUT UINT64 *RemainingVariableStorageSize,\r | |
153 | OUT UINT64 *MaximumVariableSize\r | |
ed66e1bc | 154 | );\r |
9071550e | 155 | \r |
156 | #endif\r |