]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | *\r | |
3 | * Copyright (c) 2011-2014, ARM Limited. All rights reserved.\r | |
4 | *\r | |
5 | * 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 | **/\r | |
14 | \r | |
15 | #ifndef _BDSINTERNAL_H_\r | |
16 | #define _BDSINTERNAL_H_\r | |
17 | \r | |
18 | #include <PiDxe.h>\r | |
19 | #include <Library/BaseMemoryLib.h>\r | |
20 | #include <Library/BdsLib.h>\r | |
21 | #include <Library/DebugLib.h>\r | |
22 | #include <Library/DevicePathLib.h>\r | |
23 | #include <Library/UefiLib.h>\r | |
24 | #include <Library/PrintLib.h>\r | |
25 | #include <Library/PcdLib.h>\r | |
26 | #include <Library/MemoryAllocationLib.h>\r | |
27 | #include <Library/UefiBootServicesTableLib.h>\r | |
28 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
29 | \r | |
30 | #include <Protocol/DevicePathFromText.h>\r | |
31 | #include <Protocol/DevicePathToText.h>\r | |
32 | \r | |
33 | #include <Guid/GlobalVariable.h>\r | |
34 | \r | |
35 | #define BOOT_DEVICE_DESCRIPTION_MAX 100\r | |
36 | #define BOOT_DEVICE_FILEPATH_MAX 100\r | |
37 | #define BOOT_DEVICE_OPTION_MAX 300\r | |
38 | #define BOOT_DEVICE_ADDRESS_MAX (sizeof(L"0x0000000000000000"))\r | |
39 | \r | |
40 | #define ARM_BDS_OPTIONAL_DATA_SIGNATURE SIGNATURE_32('a', 'b', 'o', 'd')\r | |
41 | \r | |
42 | #define IS_ARM_BDS_BOOTENTRY(ptr) \\r | |
43 | (((ptr)->OptionalData != NULL) && \\r | |
44 | (ReadUnaligned32 ((CONST UINT32*)&((ARM_BDS_LOADER_OPTIONAL_DATA*)((ptr)->OptionalData))->Header.Signature) \\r | |
45 | == ARM_BDS_OPTIONAL_DATA_SIGNATURE))\r | |
46 | \r | |
47 | #define UPDATE_BOOT_ENTRY L"Update entry: "\r | |
48 | #define DELETE_BOOT_ENTRY L"Delete entry: "\r | |
49 | \r | |
50 | typedef enum {\r | |
51 | BDS_LOADER_EFI_APPLICATION = 0,\r | |
52 | BDS_LOADER_KERNEL_LINUX_ATAG,\r | |
53 | BDS_LOADER_KERNEL_LINUX_FDT,\r | |
54 | } ARM_BDS_LOADER_TYPE;\r | |
55 | \r | |
56 | typedef struct {\r | |
57 | UINT16 CmdLineSize;\r | |
58 | UINT16 InitrdSize;\r | |
59 | \r | |
60 | // These following fields have variable length and are packed:\r | |
61 | //CHAR8 *CmdLine;\r | |
62 | //EFI_DEVICE_PATH_PROTOCOL *InitrdPathList;\r | |
63 | } ARM_BDS_LINUX_ARGUMENTS;\r | |
64 | \r | |
65 | typedef union {\r | |
66 | ARM_BDS_LINUX_ARGUMENTS LinuxArguments;\r | |
67 | } ARM_BDS_LOADER_ARGUMENTS;\r | |
68 | \r | |
69 | typedef struct {\r | |
70 | UINT32 Signature;\r | |
71 | ARM_BDS_LOADER_TYPE LoaderType;\r | |
72 | } ARM_BDS_LOADER_OPTIONAL_DATA_HEADER;\r | |
73 | \r | |
74 | typedef struct {\r | |
75 | ARM_BDS_LOADER_OPTIONAL_DATA_HEADER Header;\r | |
76 | ARM_BDS_LOADER_ARGUMENTS Arguments;\r | |
77 | } ARM_BDS_LOADER_OPTIONAL_DATA;\r | |
78 | \r | |
79 | typedef struct {\r | |
80 | LIST_ENTRY Link;\r | |
81 | BDS_LOAD_OPTION* BdsLoadOption;\r | |
82 | } BDS_LOAD_OPTION_ENTRY;\r | |
83 | \r | |
84 | typedef enum {\r | |
85 | BDS_DEVICE_FILESYSTEM = 0,\r | |
86 | BDS_DEVICE_MEMMAP,\r | |
87 | BDS_DEVICE_PXE,\r | |
88 | BDS_DEVICE_TFTP,\r | |
89 | BDS_DEVICE_MAX\r | |
90 | } BDS_SUPPORTED_DEVICE_TYPE;\r | |
91 | \r | |
92 | typedef struct {\r | |
93 | LIST_ENTRY Link;\r | |
94 | CHAR16 Description[BOOT_DEVICE_DESCRIPTION_MAX];\r | |
95 | EFI_DEVICE_PATH_PROTOCOL* DevicePathProtocol;\r | |
96 | struct _BDS_LOAD_OPTION_SUPPORT* Support;\r | |
97 | } BDS_SUPPORTED_DEVICE;\r | |
98 | \r | |
99 | #define SUPPORTED_BOOT_DEVICE_FROM_LINK(a) BASE_CR(a, BDS_SUPPORTED_DEVICE, Link)\r | |
100 | \r | |
101 | typedef struct _BDS_LOAD_OPTION_SUPPORT {\r | |
102 | BDS_SUPPORTED_DEVICE_TYPE Type;\r | |
103 | EFI_STATUS (*ListDevices)(IN OUT LIST_ENTRY* BdsLoadOptionList);\r | |
104 | BOOLEAN (*IsSupported)(IN EFI_DEVICE_PATH *DevicePath);\r | |
105 | EFI_STATUS (*CreateDevicePathNode)(IN CHAR16* FileName, OUT EFI_DEVICE_PATH_PROTOCOL **DevicePathNodes, OUT BOOLEAN *RequestBootType);\r | |
106 | EFI_STATUS (*UpdateDevicePathNode)(IN EFI_DEVICE_PATH *OldDevicePath, IN CHAR16* FileName, OUT EFI_DEVICE_PATH_PROTOCOL** NewDevicePath, OUT BOOLEAN *RequestBootType);\r | |
107 | } BDS_LOAD_OPTION_SUPPORT;\r | |
108 | \r | |
109 | #define LOAD_OPTION_ENTRY_FROM_LINK(a) BASE_CR(a, BDS_LOAD_OPTION_ENTRY, Link)\r | |
110 | #define LOAD_OPTION_FROM_LINK(a) ((BDS_LOAD_OPTION_ENTRY*)BASE_CR(a, BDS_LOAD_OPTION_ENTRY, Link))->BdsLoadOption\r | |
111 | \r | |
112 | EFI_STATUS\r | |
113 | BootDeviceListSupportedInit (\r | |
114 | IN OUT LIST_ENTRY *SupportedDeviceList\r | |
115 | );\r | |
116 | \r | |
117 | EFI_STATUS\r | |
118 | BootDeviceListSupportedFree (\r | |
119 | IN LIST_ENTRY *SupportedDeviceList,\r | |
120 | IN BDS_SUPPORTED_DEVICE *Except\r | |
121 | );\r | |
122 | \r | |
123 | EFI_STATUS\r | |
124 | BootDeviceGetDeviceSupport (\r | |
125 | IN EFI_DEVICE_PATH *DevicePath,\r | |
126 | OUT BDS_LOAD_OPTION_SUPPORT **DeviceSupport\r | |
127 | );\r | |
128 | \r | |
129 | EFI_STATUS\r | |
130 | GetHIInputStr (\r | |
131 | IN OUT CHAR16 *CmdLine,\r | |
132 | IN UINTN MaxCmdLine\r | |
133 | );\r | |
134 | \r | |
135 | EFI_STATUS\r | |
136 | EditHIInputStr (\r | |
137 | IN OUT CHAR16 *CmdLine,\r | |
138 | IN UINTN MaxCmdLine\r | |
139 | );\r | |
140 | \r | |
141 | EFI_STATUS\r | |
142 | GetHIInputAscii (\r | |
143 | IN OUT CHAR8 *CmdLine,\r | |
144 | IN UINTN MaxCmdLine\r | |
145 | );\r | |
146 | \r | |
147 | EFI_STATUS\r | |
148 | EditHIInputAscii (\r | |
149 | IN OUT CHAR8 *CmdLine,\r | |
150 | IN UINTN MaxCmdLine\r | |
151 | );\r | |
152 | \r | |
153 | EFI_STATUS\r | |
154 | GetHIInputInteger (\r | |
155 | IN OUT UINTN *Integer\r | |
156 | );\r | |
157 | \r | |
158 | EFI_STATUS\r | |
159 | GetHIInputIP (\r | |
160 | OUT EFI_IP_ADDRESS *Ip\r | |
161 | );\r | |
162 | \r | |
163 | EFI_STATUS\r | |
164 | GetHIInputBoolean (\r | |
165 | OUT BOOLEAN *Value\r | |
166 | );\r | |
167 | \r | |
168 | BOOLEAN\r | |
169 | HasFilePathEfiExtension (\r | |
170 | IN CHAR16* FilePath\r | |
171 | );\r | |
172 | \r | |
173 | EFI_DEVICE_PATH*\r | |
174 | GetLastDevicePathNode (\r | |
175 | IN EFI_DEVICE_PATH* DevicePath\r | |
176 | );\r | |
177 | \r | |
178 | EFI_STATUS\r | |
179 | BdsStartBootOption (\r | |
180 | IN CHAR16* BootOption\r | |
181 | );\r | |
182 | \r | |
183 | UINTN\r | |
184 | GetUnalignedDevicePathSize (\r | |
185 | IN EFI_DEVICE_PATH* DevicePath\r | |
186 | );\r | |
187 | \r | |
188 | EFI_DEVICE_PATH*\r | |
189 | GetAlignedDevicePath (\r | |
190 | IN EFI_DEVICE_PATH* DevicePath\r | |
191 | );\r | |
192 | \r | |
193 | EFI_STATUS\r | |
194 | GenerateDeviceDescriptionName (\r | |
195 | IN EFI_HANDLE Handle,\r | |
196 | IN OUT CHAR16* Description\r | |
197 | );\r | |
198 | \r | |
199 | EFI_STATUS\r | |
200 | BootOptionList (\r | |
201 | IN OUT LIST_ENTRY *BootOptionList\r | |
202 | );\r | |
203 | \r | |
204 | EFI_STATUS\r | |
205 | BootOptionParseLoadOption (\r | |
206 | IN EFI_LOAD_OPTION EfiLoadOption,\r | |
207 | IN UINTN EfiLoadOptionSize,\r | |
208 | OUT BDS_LOAD_OPTION **BdsLoadOption\r | |
209 | );\r | |
210 | \r | |
211 | EFI_STATUS\r | |
212 | BootOptionStart (\r | |
213 | IN BDS_LOAD_OPTION *BootOption\r | |
214 | );\r | |
215 | \r | |
216 | EFI_STATUS\r | |
217 | BootOptionCreate (\r | |
218 | IN UINT32 Attributes,\r | |
219 | IN CHAR16* BootDescription,\r | |
220 | IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r | |
221 | IN ARM_BDS_LOADER_TYPE BootType,\r | |
222 | IN UINT8* OptionalData,\r | |
223 | IN UINTN OptionalDataSize,\r | |
224 | OUT BDS_LOAD_OPTION** BdsLoadOption\r | |
225 | );\r | |
226 | \r | |
227 | EFI_STATUS\r | |
228 | BootOptionUpdate (\r | |
229 | IN BDS_LOAD_OPTION* BdsLoadOption,\r | |
230 | IN UINT32 Attributes,\r | |
231 | IN CHAR16* BootDescription,\r | |
232 | IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r | |
233 | IN ARM_BDS_LOADER_TYPE BootType,\r | |
234 | IN UINT8* OptionalData,\r | |
235 | IN UINTN OptionalDataSize\r | |
236 | );\r | |
237 | \r | |
238 | EFI_STATUS\r | |
239 | BootOptionDelete (\r | |
240 | IN BDS_LOAD_OPTION *BootOption\r | |
241 | );\r | |
242 | \r | |
243 | EFI_STATUS\r | |
244 | BootDeviceGetType (\r | |
245 | IN EFI_DEVICE_PATH* DevicePath,\r | |
246 | OUT ARM_BDS_LOADER_TYPE *BootType,\r | |
247 | OUT UINT32 *Attributes\r | |
248 | );\r | |
249 | \r | |
250 | EFI_STATUS\r | |
251 | BootMenuMain (\r | |
252 | VOID\r | |
253 | );\r | |
254 | \r | |
255 | BOOLEAN\r | |
256 | IsUnicodeString (\r | |
257 | IN VOID* String\r | |
258 | );\r | |
259 | \r | |
260 | /*\r | |
261 | * Try to detect if the given string is an ASCII or Unicode string\r | |
262 | *\r | |
263 | * There are actually few limitation to this function but it is mainly to give\r | |
264 | * a user friendly output.\r | |
265 | *\r | |
266 | * Some limitations:\r | |
267 | * - it only supports unicode string that use ASCII character (< 0x100)\r | |
268 | * - single character ASCII strings are interpreted as Unicode string\r | |
269 | * - string cannot be longer than 2 x BOOT_DEVICE_OPTION_MAX (600 bytes)\r | |
270 | *\r | |
271 | * @param String Buffer that might contain a Unicode or Ascii string\r | |
272 | * @param IsUnicode If not NULL this boolean value returns if the string is an\r | |
273 | * ASCII or Unicode string.\r | |
274 | */\r | |
275 | BOOLEAN\r | |
276 | IsPrintableString (\r | |
277 | IN VOID* String,\r | |
278 | OUT BOOLEAN *IsUnicode\r | |
279 | );\r | |
280 | \r | |
281 | #endif /* _BDSINTERNAL_H_ */\r |