]>
Commit | Line | Data |
---|---|---|
067ed98a RN |
1 | /** @file\r |
2 | Load option library functions which relate with creating and processing load options.\r | |
3 | \r | |
809e2bbf | 4 | Copyright (c) 2011 - 2017, Intel Corporation. All rights reserved.<BR>\r |
3dc5c1ae | 5 | (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>\r |
067ed98a RN |
6 | This program and the accompanying materials\r |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #include "InternalBm.h"\r | |
17 | \r | |
18 | GLOBAL_REMOVE_IF_UNREFERENCED\r | |
19 | CHAR16 *mBmLoadOptionName[] = {\r | |
20 | L"Driver",\r | |
21 | L"SysPrep",\r | |
780e05ca RN |
22 | L"Boot",\r |
23 | L"PlatformRecovery"\r | |
067ed98a RN |
24 | };\r |
25 | \r | |
26 | GLOBAL_REMOVE_IF_UNREFERENCED\r | |
27 | CHAR16 *mBmLoadOptionOrderName[] = {\r | |
28 | EFI_DRIVER_ORDER_VARIABLE_NAME,\r | |
29 | EFI_SYS_PREP_ORDER_VARIABLE_NAME,\r | |
780e05ca RN |
30 | EFI_BOOT_ORDER_VARIABLE_NAME,\r |
31 | NULL // PlatformRecovery#### doesn't have associated *Order variable\r | |
067ed98a RN |
32 | };\r |
33 | \r | |
34 | /**\r | |
35 | Call Visitor function for each variable in variable storage.\r | |
36 | \r | |
37 | @param Visitor Visitor function.\r | |
38 | @param Context The context passed to Visitor function.\r | |
39 | **/\r | |
40 | VOID\r | |
41 | BmForEachVariable (\r | |
d95ff8e8 | 42 | BM_VARIABLE_VISITOR Visitor,\r |
067ed98a RN |
43 | VOID *Context\r |
44 | )\r | |
45 | {\r | |
46 | EFI_STATUS Status;\r | |
47 | CHAR16 *Name;\r | |
48 | EFI_GUID Guid;\r | |
49 | UINTN NameSize;\r | |
50 | UINTN NewNameSize;\r | |
51 | \r | |
52 | NameSize = sizeof (CHAR16);\r | |
53 | Name = AllocateZeroPool (NameSize);\r | |
54 | ASSERT (Name != NULL);\r | |
55 | while (TRUE) {\r | |
56 | NewNameSize = NameSize;\r | |
57 | Status = gRT->GetNextVariableName (&NewNameSize, Name, &Guid);\r | |
58 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
59 | Name = ReallocatePool (NameSize, NewNameSize, Name);\r | |
60 | ASSERT (Name != NULL);\r | |
61 | Status = gRT->GetNextVariableName (&NewNameSize, Name, &Guid);\r | |
62 | NameSize = NewNameSize;\r | |
63 | }\r | |
64 | \r | |
65 | if (Status == EFI_NOT_FOUND) {\r | |
66 | break;\r | |
67 | }\r | |
68 | ASSERT_EFI_ERROR (Status);\r | |
69 | \r | |
70 | Visitor (Name, &Guid, Context);\r | |
71 | }\r | |
72 | \r | |
73 | FreePool (Name);\r | |
74 | }\r | |
75 | \r | |
76 | /**\r | |
77 | Get the Option Number that wasn't used.\r | |
78 | \r | |
79 | @param LoadOptionType The load option type.\r | |
80 | @param FreeOptionNumber Return the minimal free option number.\r | |
81 | \r | |
82 | @retval EFI_SUCCESS The option number is found and will be returned.\r | |
83 | @retval EFI_OUT_OF_RESOURCES There is no free option number that can be used.\r | |
84 | @retval EFI_INVALID_PARAMETER FreeOptionNumber is NULL\r | |
85 | \r | |
86 | **/\r | |
87 | EFI_STATUS\r | |
88 | BmGetFreeOptionNumber (\r | |
89 | IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType,\r | |
90 | OUT UINT16 *FreeOptionNumber\r | |
91 | )\r | |
92 | {\r | |
93 | \r | |
94 | UINTN OptionNumber;\r | |
95 | UINTN Index;\r | |
96 | UINT16 *OptionOrder;\r | |
97 | UINTN OptionOrderSize;\r | |
98 | UINT16 *BootNext;\r | |
99 | \r | |
100 | ASSERT (FreeOptionNumber != NULL);\r | |
101 | ASSERT (LoadOptionType == LoadOptionTypeDriver || \r | |
102 | LoadOptionType == LoadOptionTypeBoot ||\r | |
103 | LoadOptionType == LoadOptionTypeSysPrep);\r | |
104 | \r | |
105 | GetEfiGlobalVariable2 (mBmLoadOptionOrderName[LoadOptionType], (VOID **) &OptionOrder, &OptionOrderSize);\r | |
eef53857 RN |
106 | ASSERT ((OptionOrder != NULL && OptionOrderSize != 0) || (OptionOrder == NULL && OptionOrderSize == 0));\r |
107 | \r | |
067ed98a RN |
108 | BootNext = NULL;\r |
109 | if (LoadOptionType == LoadOptionTypeBoot) {\r | |
110 | GetEfiGlobalVariable2 (L"BootNext", (VOID**) &BootNext, NULL);\r | |
111 | }\r | |
112 | \r | |
113 | for (OptionNumber = 0; \r | |
114 | OptionNumber < OptionOrderSize / sizeof (UINT16)\r | |
115 | + ((BootNext != NULL) ? 1 : 0); \r | |
116 | OptionNumber++\r | |
117 | ) {\r | |
118 | //\r | |
119 | // Search in OptionOrder whether the OptionNumber exists\r | |
120 | //\r | |
121 | for (Index = 0; Index < OptionOrderSize / sizeof (UINT16); Index++) {\r | |
122 | if (OptionNumber == OptionOrder[Index]) {\r | |
123 | break;\r | |
124 | }\r | |
125 | }\r | |
126 | \r | |
127 | //\r | |
128 | // We didn't find it in the ****Order array and it doesn't equal to BootNext \r | |
129 | // Otherwise, OptionNumber equals to OptionOrderSize / sizeof (UINT16) + 1\r | |
130 | //\r | |
131 | if ((Index == OptionOrderSize / sizeof (UINT16)) && \r | |
132 | ((BootNext == NULL) || (OptionNumber != *BootNext))\r | |
133 | ) {\r | |
134 | break;\r | |
135 | }\r | |
136 | }\r | |
137 | if (OptionOrder != NULL) {\r | |
138 | FreePool (OptionOrder);\r | |
139 | }\r | |
140 | \r | |
141 | if (BootNext != NULL) {\r | |
142 | FreePool (BootNext);\r | |
143 | }\r | |
144 | \r | |
145 | //\r | |
146 | // When BootOrder & BootNext conver all numbers in the range [0 ... 0xffff],\r | |
147 | // OptionNumber equals to 0x10000 which is not valid.\r | |
148 | //\r | |
149 | ASSERT (OptionNumber <= 0x10000);\r | |
150 | if (OptionNumber == 0x10000) {\r | |
151 | return EFI_OUT_OF_RESOURCES;\r | |
152 | } else {\r | |
153 | *FreeOptionNumber = (UINT16) OptionNumber;\r | |
154 | return EFI_SUCCESS;\r | |
155 | }\r | |
156 | }\r | |
157 | \r | |
158 | /**\r | |
780e05ca RN |
159 | Create the Boot####, Driver####, SysPrep####, PlatformRecovery#### variable\r |
160 | from the load option.\r | |
161 | \r | |
067ed98a RN |
162 | @param LoadOption Pointer to the load option.\r |
163 | \r | |
164 | @retval EFI_SUCCESS The variable was created.\r | |
165 | @retval Others Error status returned by RT->SetVariable.\r | |
166 | **/\r | |
167 | EFI_STATUS\r | |
168 | EFIAPI\r | |
169 | EfiBootManagerLoadOptionToVariable (\r | |
170 | IN CONST EFI_BOOT_MANAGER_LOAD_OPTION *Option\r | |
171 | )\r | |
172 | {\r | |
780e05ca | 173 | EFI_STATUS Status;\r |
067ed98a RN |
174 | UINTN VariableSize;\r |
175 | UINT8 *Variable;\r | |
176 | UINT8 *Ptr;\r | |
177 | CHAR16 OptionName[BM_OPTION_NAME_LEN];\r | |
178 | CHAR16 *Description;\r | |
179 | CHAR16 NullChar;\r | |
780e05ca | 180 | EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock;\r |
067ed98a RN |
181 | UINT32 VariableAttributes;\r |
182 | \r | |
183 | if ((Option->OptionNumber == LoadOptionNumberUnassigned) ||\r | |
184 | (Option->FilePath == NULL) ||\r | |
185 | ((UINT32) Option->OptionType >= LoadOptionTypeMax)\r | |
186 | ) {\r | |
187 | return EFI_INVALID_PARAMETER;\r | |
188 | }\r | |
189 | \r | |
190 | //\r | |
191 | // Convert NULL description to empty description\r | |
192 | //\r | |
193 | NullChar = L'\0';\r | |
194 | Description = Option->Description;\r | |
195 | if (Description == NULL) {\r | |
196 | Description = &NullChar;\r | |
197 | }\r | |
198 | \r | |
199 | /*\r | |
200 | UINT32 Attributes;\r | |
201 | UINT16 FilePathListLength;\r | |
202 | CHAR16 Description[];\r | |
203 | EFI_DEVICE_PATH_PROTOCOL FilePathList[];\r | |
204 | UINT8 OptionalData[];\r | |
205 | TODO: FilePathList[] IS:\r | |
206 | A packed array of UEFI device paths. The first element of the \r | |
207 | array is a device path that describes the device and location of the \r | |
208 | Image for this load option. The FilePathList[0] is specific \r | |
209 | to the device type. Other device paths may optionally exist in the \r | |
210 | FilePathList, but their usage is OSV specific. Each element \r | |
211 | in the array is variable length, and ends at the device path end \r | |
212 | structure.\r | |
213 | */\r | |
214 | VariableSize = sizeof (Option->Attributes)\r | |
215 | + sizeof (UINT16)\r | |
216 | + StrSize (Description)\r | |
217 | + GetDevicePathSize (Option->FilePath)\r | |
218 | + Option->OptionalDataSize;\r | |
219 | \r | |
220 | Variable = AllocatePool (VariableSize);\r | |
221 | ASSERT (Variable != NULL);\r | |
222 | \r | |
223 | Ptr = Variable;\r | |
224 | WriteUnaligned32 ((UINT32 *) Ptr, Option->Attributes);\r | |
225 | Ptr += sizeof (Option->Attributes);\r | |
226 | \r | |
227 | WriteUnaligned16 ((UINT16 *) Ptr, (UINT16) GetDevicePathSize (Option->FilePath));\r | |
228 | Ptr += sizeof (UINT16);\r | |
229 | \r | |
230 | CopyMem (Ptr, Description, StrSize (Description));\r | |
231 | Ptr += StrSize (Description);\r | |
232 | \r | |
233 | CopyMem (Ptr, Option->FilePath, GetDevicePathSize (Option->FilePath));\r | |
234 | Ptr += GetDevicePathSize (Option->FilePath);\r | |
235 | \r | |
236 | CopyMem (Ptr, Option->OptionalData, Option->OptionalDataSize);\r | |
237 | \r | |
238 | UnicodeSPrint (OptionName, sizeof (OptionName), L"%s%04x", mBmLoadOptionName[Option->OptionType], Option->OptionNumber);\r | |
239 | \r | |
240 | VariableAttributes = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE;\r | |
780e05ca RN |
241 | if (Option->OptionType == LoadOptionTypePlatformRecovery) {\r |
242 | //\r | |
243 | // Lock the PlatformRecovery####\r | |
244 | //\r | |
245 | Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **) &VariableLock);\r | |
246 | if (!EFI_ERROR (Status)) {\r | |
247 | Status = VariableLock->RequestToLock (VariableLock, OptionName, &gEfiGlobalVariableGuid);\r | |
248 | ASSERT_EFI_ERROR (Status);\r | |
249 | }\r | |
250 | VariableAttributes = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS;\r | |
251 | }\r | |
067ed98a RN |
252 | \r |
253 | return gRT->SetVariable (\r | |
254 | OptionName,\r | |
255 | &gEfiGlobalVariableGuid,\r | |
256 | VariableAttributes,\r | |
257 | VariableSize,\r | |
258 | Variable\r | |
259 | );\r | |
260 | }\r | |
261 | \r | |
262 | /**\r | |
263 | Update order variable .\r | |
264 | \r | |
265 | @param OptionOrderName Order variable name which need to be updated.\r | |
266 | @param OptionNumber Option number for the new option.\r | |
267 | @param Position Position of the new load option to put in the ****Order variable.\r | |
268 | \r | |
269 | @retval EFI_SUCCESS The boot#### or driver#### have been successfully registered.\r | |
270 | @retval EFI_ALREADY_STARTED The option number of Option is being used already.\r | |
271 | @retval EFI_STATUS Return the status of gRT->SetVariable ().\r | |
272 | \r | |
273 | **/\r | |
274 | EFI_STATUS\r | |
275 | BmAddOptionNumberToOrderVariable (\r | |
276 | IN CHAR16 *OptionOrderName,\r | |
277 | IN UINT16 OptionNumber,\r | |
278 | IN UINTN Position\r | |
279 | )\r | |
280 | {\r | |
281 | EFI_STATUS Status;\r | |
282 | UINTN Index;\r | |
283 | UINT16 *OptionOrder;\r | |
284 | UINT16 *NewOptionOrder;\r | |
285 | UINTN OptionOrderSize;\r | |
286 | //\r | |
287 | // Update the option order variable\r | |
288 | //\r | |
289 | GetEfiGlobalVariable2 (OptionOrderName, (VOID **) &OptionOrder, &OptionOrderSize);\r | |
eef53857 | 290 | ASSERT ((OptionOrder != NULL && OptionOrderSize != 0) || (OptionOrder == NULL && OptionOrderSize == 0));\r |
067ed98a RN |
291 | \r |
292 | Status = EFI_SUCCESS;\r | |
293 | for (Index = 0; Index < OptionOrderSize / sizeof (UINT16); Index++) {\r | |
294 | if (OptionOrder[Index] == OptionNumber) {\r | |
295 | Status = EFI_ALREADY_STARTED;\r | |
296 | break;\r | |
297 | }\r | |
298 | }\r | |
299 | \r | |
300 | if (!EFI_ERROR (Status)) {\r | |
301 | Position = MIN (Position, OptionOrderSize / sizeof (UINT16));\r | |
302 | \r | |
303 | NewOptionOrder = AllocatePool (OptionOrderSize + sizeof (UINT16));\r | |
304 | ASSERT (NewOptionOrder != NULL);\r | |
305 | if (OptionOrderSize != 0) {\r | |
306 | CopyMem (NewOptionOrder, OptionOrder, Position * sizeof (UINT16));\r | |
307 | CopyMem (&NewOptionOrder[Position + 1], &OptionOrder[Position], OptionOrderSize - Position * sizeof (UINT16));\r | |
308 | }\r | |
309 | NewOptionOrder[Position] = OptionNumber;\r | |
310 | \r | |
311 | Status = gRT->SetVariable (\r | |
312 | OptionOrderName,\r | |
313 | &gEfiGlobalVariableGuid,\r | |
314 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r | |
315 | OptionOrderSize + sizeof (UINT16),\r | |
316 | NewOptionOrder\r | |
317 | );\r | |
318 | FreePool (NewOptionOrder);\r | |
319 | }\r | |
320 | \r | |
321 | if (OptionOrder != NULL) {\r | |
322 | FreePool (OptionOrder);\r | |
323 | }\r | |
324 | \r | |
325 | return Status;\r | |
326 | }\r | |
327 | \r | |
328 | /**\r | |
329 | This function will register the new Boot####, Driver#### or SysPrep#### option.\r | |
330 | After the *#### is updated, the *Order will also be updated.\r | |
331 | \r | |
332 | @param Option Pointer to load option to add.\r | |
333 | @param Position Position of the new load option to put in the ****Order variable.\r | |
334 | \r | |
335 | @retval EFI_SUCCESS The *#### have been successfully registered.\r | |
336 | @retval EFI_INVALID_PARAMETER The option number exceeds 0xFFFF.\r | |
337 | @retval EFI_ALREADY_STARTED The option number of Option is being used already.\r | |
338 | Note: this API only adds new load option, no replacement support.\r | |
339 | @retval EFI_OUT_OF_RESOURCES There is no free option number that can be used when the\r | |
340 | option number specified in the Option is LoadOptionNumberUnassigned.\r | |
341 | @retval EFI_STATUS Return the status of gRT->SetVariable ().\r | |
342 | \r | |
343 | **/\r | |
344 | EFI_STATUS\r | |
345 | EFIAPI\r | |
346 | EfiBootManagerAddLoadOptionVariable (\r | |
347 | IN EFI_BOOT_MANAGER_LOAD_OPTION *Option,\r | |
348 | IN UINTN Position\r | |
349 | )\r | |
350 | {\r | |
351 | EFI_STATUS Status;\r | |
352 | UINT16 OptionNumber;\r | |
353 | \r | |
354 | if (Option == NULL) {\r | |
355 | return EFI_INVALID_PARAMETER;\r | |
356 | }\r | |
357 | \r | |
358 | if (Option->OptionType != LoadOptionTypeDriver && \r | |
359 | Option->OptionType != LoadOptionTypeSysPrep &&\r | |
360 | Option->OptionType != LoadOptionTypeBoot\r | |
361 | ) {\r | |
362 | return EFI_INVALID_PARAMETER;\r | |
363 | }\r | |
364 | \r | |
365 | //\r | |
366 | // Get the free option number if the option number is unassigned\r | |
367 | //\r | |
368 | if (Option->OptionNumber == LoadOptionNumberUnassigned) {\r | |
369 | Status = BmGetFreeOptionNumber (Option->OptionType, &OptionNumber);\r | |
370 | if (EFI_ERROR (Status)) {\r | |
371 | return Status;\r | |
372 | }\r | |
373 | Option->OptionNumber = OptionNumber;\r | |
374 | }\r | |
375 | \r | |
376 | if (Option->OptionNumber >= LoadOptionNumberMax) {\r | |
377 | return EFI_INVALID_PARAMETER;\r | |
378 | }\r | |
379 | \r | |
380 | Status = BmAddOptionNumberToOrderVariable (mBmLoadOptionOrderName[Option->OptionType], (UINT16) Option->OptionNumber, Position);\r | |
381 | if (!EFI_ERROR (Status)) {\r | |
382 | //\r | |
383 | // Save the Boot#### or Driver#### variable\r | |
384 | //\r | |
385 | Status = EfiBootManagerLoadOptionToVariable (Option);\r | |
386 | if (EFI_ERROR (Status)) {\r | |
387 | //\r | |
388 | // Remove the #### from *Order variable when the Driver####/SysPrep####/Boot#### cannot be saved.\r | |
389 | //\r | |
390 | EfiBootManagerDeleteLoadOptionVariable (Option->OptionNumber, Option->OptionType);\r | |
391 | }\r | |
392 | }\r | |
393 | \r | |
394 | return Status;\r | |
395 | }\r | |
396 | \r | |
397 | /**\r | |
398 | Sort the load option. The DriverOrder or BootOrder will be re-created to \r | |
399 | reflect the new order.\r | |
400 | \r | |
401 | @param OptionType Load option type\r | |
402 | @param CompareFunction The comparator\r | |
403 | **/\r | |
404 | VOID\r | |
405 | EFIAPI\r | |
406 | EfiBootManagerSortLoadOptionVariable (\r | |
407 | EFI_BOOT_MANAGER_LOAD_OPTION_TYPE OptionType,\r | |
408 | SORT_COMPARE CompareFunction\r | |
409 | )\r | |
410 | {\r | |
411 | EFI_STATUS Status;\r | |
412 | EFI_BOOT_MANAGER_LOAD_OPTION *LoadOption;\r | |
413 | UINTN LoadOptionCount;\r | |
414 | UINTN Index;\r | |
415 | UINT16 *OptionOrder;\r | |
416 | \r | |
417 | LoadOption = EfiBootManagerGetLoadOptions (&LoadOptionCount, OptionType);\r | |
418 | \r | |
419 | //\r | |
420 | // Insertion sort algorithm\r | |
421 | //\r | |
422 | PerformQuickSort (\r | |
423 | LoadOption,\r | |
424 | LoadOptionCount,\r | |
425 | sizeof (EFI_BOOT_MANAGER_LOAD_OPTION),\r | |
426 | CompareFunction\r | |
427 | );\r | |
428 | \r | |
429 | //\r | |
430 | // Create new ****Order variable\r | |
431 | //\r | |
432 | OptionOrder = AllocatePool (LoadOptionCount * sizeof (UINT16));\r | |
433 | ASSERT (OptionOrder != NULL);\r | |
434 | for (Index = 0; Index < LoadOptionCount; Index++) {\r | |
435 | OptionOrder[Index] = (UINT16) LoadOption[Index].OptionNumber;\r | |
436 | }\r | |
437 | \r | |
438 | Status = gRT->SetVariable (\r | |
439 | mBmLoadOptionOrderName[OptionType],\r | |
440 | &gEfiGlobalVariableGuid,\r | |
441 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r | |
442 | LoadOptionCount * sizeof (UINT16),\r | |
443 | OptionOrder\r | |
444 | );\r | |
445 | //\r | |
446 | // Changing the *Order content without increasing its size with current variable implementation shouldn't fail.\r | |
447 | //\r | |
448 | ASSERT_EFI_ERROR (Status);\r | |
449 | \r | |
450 | FreePool (OptionOrder);\r | |
451 | EfiBootManagerFreeLoadOptions (LoadOption, LoadOptionCount);\r | |
452 | }\r | |
453 | \r | |
454 | /**\r | |
455 | Initialize a load option.\r | |
456 | \r | |
457 | @param Option Pointer to the load option to be initialized.\r | |
458 | @param OptionNumber Option number of the load option.\r | |
459 | @param OptionType Type of the load option.\r | |
460 | @param Attributes Attributes of the load option.\r | |
461 | @param Description Description of the load option.\r | |
462 | @param FilePath Device path of the load option.\r | |
463 | @param OptionalData Optional data of the load option.\r | |
464 | @param OptionalDataSize Size of the optional data of the load option.\r | |
465 | \r | |
466 | @retval EFI_SUCCESS The load option was initialized successfully.\r | |
467 | @retval EFI_INVALID_PARAMETER Option, Description or FilePath is NULL.\r | |
468 | **/\r | |
469 | EFI_STATUS\r | |
470 | EFIAPI\r | |
471 | EfiBootManagerInitializeLoadOption (\r | |
472 | IN OUT EFI_BOOT_MANAGER_LOAD_OPTION *Option,\r | |
473 | IN UINTN OptionNumber,\r | |
474 | IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE OptionType,\r | |
475 | IN UINT32 Attributes,\r | |
476 | IN CHAR16 *Description,\r | |
477 | IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r | |
478 | IN UINT8 *OptionalData, OPTIONAL\r | |
479 | IN UINT32 OptionalDataSize\r | |
480 | )\r | |
481 | {\r | |
482 | if ((Option == NULL) || (Description == NULL) || (FilePath == NULL)) {\r | |
483 | return EFI_INVALID_PARAMETER;\r | |
484 | }\r | |
485 | \r | |
486 | if (((OptionalData != NULL) && (OptionalDataSize == 0)) ||\r | |
487 | ((OptionalData == NULL) && (OptionalDataSize != 0))) {\r | |
488 | return EFI_INVALID_PARAMETER;\r | |
489 | }\r | |
490 | \r | |
491 | if ((UINT32) OptionType >= LoadOptionTypeMax) {\r | |
492 | return EFI_INVALID_PARAMETER;\r | |
493 | }\r | |
494 | \r | |
495 | ZeroMem (Option, sizeof (EFI_BOOT_MANAGER_LOAD_OPTION));\r | |
496 | Option->OptionNumber = OptionNumber;\r | |
497 | Option->OptionType = OptionType;\r | |
498 | Option->Attributes = Attributes;\r | |
499 | Option->Description = AllocateCopyPool (StrSize (Description), Description);\r | |
500 | Option->FilePath = DuplicateDevicePath (FilePath);\r | |
501 | if (OptionalData != NULL) {\r | |
502 | Option->OptionalData = AllocateCopyPool (OptionalDataSize, OptionalData);\r | |
503 | Option->OptionalDataSize = OptionalDataSize;\r | |
504 | }\r | |
505 | \r | |
506 | return EFI_SUCCESS;\r | |
507 | }\r | |
508 | \r | |
509 | \r | |
510 | /**\r | |
511 | Return the index of the load option in the load option array.\r | |
512 | \r | |
513 | The function consider two load options are equal when the \r | |
514 | OptionType, Attributes, Description, FilePath and OptionalData are equal.\r | |
515 | \r | |
516 | @param Key Pointer to the load option to be found.\r | |
517 | @param Array Pointer to the array of load options to be found.\r | |
518 | @param Count Number of entries in the Array.\r | |
519 | \r | |
520 | @retval -1 Key wasn't found in the Array.\r | |
521 | @retval 0 ~ Count-1 The index of the Key in the Array.\r | |
522 | **/\r | |
523 | INTN\r | |
5d3a9896 SW |
524 | EFIAPI\r |
525 | EfiBootManagerFindLoadOption (\r | |
067ed98a RN |
526 | IN CONST EFI_BOOT_MANAGER_LOAD_OPTION *Key,\r |
527 | IN CONST EFI_BOOT_MANAGER_LOAD_OPTION *Array,\r | |
528 | IN UINTN Count\r | |
529 | )\r | |
530 | {\r | |
531 | UINTN Index;\r | |
532 | \r | |
533 | for (Index = 0; Index < Count; Index++) {\r | |
534 | if ((Key->OptionType == Array[Index].OptionType) &&\r | |
535 | (Key->Attributes == Array[Index].Attributes) &&\r | |
536 | (StrCmp (Key->Description, Array[Index].Description) == 0) &&\r | |
537 | (CompareMem (Key->FilePath, Array[Index].FilePath, GetDevicePathSize (Key->FilePath)) == 0) &&\r | |
538 | (Key->OptionalDataSize == Array[Index].OptionalDataSize) &&\r | |
539 | (CompareMem (Key->OptionalData, Array[Index].OptionalData, Key->OptionalDataSize) == 0)) {\r | |
540 | return (INTN) Index;\r | |
541 | }\r | |
542 | }\r | |
543 | \r | |
544 | return -1;\r | |
545 | }\r | |
546 | \r | |
547 | /**\r | |
548 | Delete the load option.\r | |
549 | \r | |
550 | @param OptionNumber Indicate the option number of load option\r | |
551 | @param OptionType Indicate the type of load option\r | |
552 | \r | |
553 | @retval EFI_INVALID_PARAMETER OptionType or OptionNumber is invalid.\r | |
554 | @retval EFI_NOT_FOUND The load option cannot be found\r | |
555 | @retval EFI_SUCCESS The load option was deleted\r | |
556 | @retval others Status of RT->SetVariable()\r | |
557 | **/\r | |
558 | EFI_STATUS\r | |
559 | EFIAPI\r | |
560 | EfiBootManagerDeleteLoadOptionVariable (\r | |
561 | IN UINTN OptionNumber,\r | |
562 | IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE OptionType\r | |
563 | )\r | |
564 | {\r | |
565 | UINT16 *OptionOrder;\r | |
566 | UINTN OptionOrderSize;\r | |
067ed98a | 567 | UINTN Index;\r |
780e05ca | 568 | CHAR16 OptionName[BM_OPTION_NAME_LEN];\r |
067ed98a RN |
569 | \r |
570 | if (((UINT32) OptionType >= LoadOptionTypeMax) || (OptionNumber >= LoadOptionNumberMax)) {\r | |
571 | return EFI_INVALID_PARAMETER;\r | |
572 | }\r | |
573 | \r | |
067ed98a RN |
574 | if (OptionType == LoadOptionTypeDriver || OptionType == LoadOptionTypeSysPrep || OptionType == LoadOptionTypeBoot) {\r |
575 | //\r | |
2e26862c RN |
576 | // If the associated *Order exists, firstly remove the reference in *Order for\r |
577 | // Driver####, SysPrep#### and Boot####.\r | |
067ed98a | 578 | //\r |
833a8349 | 579 | GetEfiGlobalVariable2 (mBmLoadOptionOrderName[OptionType], (VOID **) &OptionOrder, &OptionOrderSize);\r |
eef53857 RN |
580 | ASSERT ((OptionOrder != NULL && OptionOrderSize != 0) || (OptionOrder == NULL && OptionOrderSize == 0));\r |
581 | \r | |
067ed98a RN |
582 | for (Index = 0; Index < OptionOrderSize / sizeof (UINT16); Index++) {\r |
583 | if (OptionOrder[Index] == OptionNumber) {\r | |
584 | OptionOrderSize -= sizeof (UINT16);\r | |
585 | CopyMem (&OptionOrder[Index], &OptionOrder[Index + 1], OptionOrderSize - Index * sizeof (UINT16));\r | |
2e26862c RN |
586 | gRT->SetVariable (\r |
587 | mBmLoadOptionOrderName[OptionType],\r | |
588 | &gEfiGlobalVariableGuid,\r | |
589 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r | |
590 | OptionOrderSize,\r | |
591 | OptionOrder\r | |
592 | );\r | |
067ed98a RN |
593 | break;\r |
594 | }\r | |
595 | }\r | |
596 | if (OptionOrder != NULL) {\r | |
597 | FreePool (OptionOrder);\r | |
598 | }\r | |
599 | }\r | |
600 | \r | |
2e26862c RN |
601 | //\r |
602 | // Remove the Driver####, SysPrep####, Boot#### or PlatformRecovery#### itself.\r | |
603 | //\r | |
604 | UnicodeSPrint (OptionName, sizeof (OptionName), L"%s%04x", mBmLoadOptionName[OptionType], OptionNumber);\r | |
605 | return gRT->SetVariable (\r | |
606 | OptionName,\r | |
607 | &gEfiGlobalVariableGuid,\r | |
608 | 0,\r | |
609 | 0,\r | |
610 | NULL\r | |
611 | );\r | |
067ed98a RN |
612 | }\r |
613 | \r | |
067ed98a RN |
614 | /**\r |
615 | Returns the size of a device path in bytes.\r | |
616 | \r | |
617 | This function returns the size, in bytes, of the device path data structure \r | |
618 | specified by DevicePath including the end of device path node. If DevicePath \r | |
619 | is NULL, then 0 is returned. If the length of the device path is bigger than\r | |
620 | MaxSize, also return 0 to indicate this is an invalidate device path.\r | |
621 | \r | |
622 | @param DevicePath A pointer to a device path data structure.\r | |
623 | @param MaxSize Max valid device path size. If big than this size, \r | |
624 | return error.\r | |
625 | \r | |
626 | @retval 0 An invalid device path.\r | |
627 | @retval Others The size of a device path in bytes.\r | |
628 | \r | |
629 | **/\r | |
630 | UINTN\r | |
631 | BmGetDevicePathSizeEx (\r | |
632 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
633 | IN UINTN MaxSize\r | |
634 | )\r | |
635 | {\r | |
636 | UINTN Size;\r | |
637 | UINTN NodeSize;\r | |
638 | \r | |
639 | if (DevicePath == NULL) {\r | |
640 | return 0;\r | |
641 | }\r | |
642 | \r | |
643 | //\r | |
644 | // Search for the end of the device path structure\r | |
645 | //\r | |
646 | Size = 0;\r | |
647 | while (!IsDevicePathEnd (DevicePath)) {\r | |
648 | NodeSize = DevicePathNodeLength (DevicePath);\r | |
649 | if (NodeSize == 0) {\r | |
650 | return 0;\r | |
651 | }\r | |
652 | Size += NodeSize;\r | |
653 | if (Size > MaxSize) {\r | |
654 | return 0;\r | |
655 | }\r | |
656 | DevicePath = NextDevicePathNode (DevicePath);\r | |
657 | }\r | |
658 | Size += DevicePathNodeLength (DevicePath);\r | |
659 | if (Size > MaxSize) {\r | |
660 | return 0;\r | |
661 | }\r | |
662 | \r | |
663 | return Size;\r | |
664 | }\r | |
665 | \r | |
666 | /**\r | |
667 | Returns the length of a Null-terminated Unicode string. If the length is \r | |
668 | bigger than MaxStringLen, return length 0 to indicate that this is an \r | |
669 | invalidate string.\r | |
670 | \r | |
671 | This function returns the number of Unicode characters in the Null-terminated\r | |
672 | Unicode string specified by String. \r | |
673 | \r | |
674 | If String is NULL, then ASSERT().\r | |
675 | If String is not aligned on a 16-bit boundary, then ASSERT().\r | |
676 | \r | |
677 | @param String A pointer to a Null-terminated Unicode string.\r | |
678 | @param MaxStringLen Max string len in this string.\r | |
679 | \r | |
680 | @retval 0 An invalid string.\r | |
681 | @retval Others The length of String.\r | |
682 | \r | |
683 | **/\r | |
684 | UINTN\r | |
685 | BmStrSizeEx (\r | |
686 | IN CONST CHAR16 *String,\r | |
687 | IN UINTN MaxStringLen\r | |
688 | )\r | |
689 | {\r | |
690 | UINTN Length;\r | |
691 | \r | |
692 | ASSERT (String != NULL && MaxStringLen != 0);\r | |
693 | ASSERT (((UINTN) String & BIT0) == 0);\r | |
694 | \r | |
695 | for (Length = 0; *String != L'\0' && MaxStringLen != Length; String++, Length+=2);\r | |
696 | \r | |
697 | if (*String != L'\0' && MaxStringLen == Length) {\r | |
698 | return 0;\r | |
699 | }\r | |
700 | \r | |
701 | return Length + 2;\r | |
702 | }\r | |
703 | \r | |
704 | /**\r | |
780e05ca RN |
705 | Validate the Boot####, Driver####, SysPrep#### and PlatformRecovery####\r |
706 | variable (VendorGuid/Name)\r | |
067ed98a RN |
707 | \r |
708 | @param Variable The variable data.\r | |
709 | @param VariableSize The variable size.\r | |
710 | \r | |
711 | @retval TRUE The variable data is correct.\r | |
712 | @retval FALSE The variable data is corrupted.\r | |
713 | \r | |
714 | **/\r | |
715 | BOOLEAN \r | |
716 | BmValidateOption (\r | |
717 | UINT8 *Variable,\r | |
718 | UINTN VariableSize\r | |
719 | )\r | |
720 | {\r | |
721 | UINT16 FilePathSize;\r | |
722 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
723 | UINTN DescriptionSize;\r | |
724 | \r | |
725 | if (VariableSize <= sizeof (UINT16) + sizeof (UINT32)) {\r | |
726 | return FALSE;\r | |
727 | }\r | |
728 | \r | |
729 | //\r | |
730 | // Skip the option attribute\r | |
731 | //\r | |
732 | Variable += sizeof (UINT32);\r | |
733 | \r | |
734 | //\r | |
735 | // Get the option's device path size\r | |
736 | //\r | |
737 | FilePathSize = ReadUnaligned16 ((UINT16 *) Variable);\r | |
738 | Variable += sizeof (UINT16);\r | |
739 | \r | |
740 | //\r | |
741 | // Get the option's description string size\r | |
742 | //\r | |
743 | DescriptionSize = BmStrSizeEx ((CHAR16 *) Variable, VariableSize - sizeof (UINT16) - sizeof (UINT32));\r | |
744 | Variable += DescriptionSize;\r | |
745 | \r | |
746 | //\r | |
747 | // Get the option's device path\r | |
748 | //\r | |
749 | DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) Variable;\r | |
750 | \r | |
751 | //\r | |
752 | // Validation boot option variable.\r | |
753 | //\r | |
754 | if ((FilePathSize == 0) || (DescriptionSize == 0)) {\r | |
755 | return FALSE;\r | |
756 | }\r | |
757 | \r | |
758 | if (sizeof (UINT32) + sizeof (UINT16) + DescriptionSize + FilePathSize > VariableSize) {\r | |
759 | return FALSE;\r | |
760 | }\r | |
761 | \r | |
762 | return (BOOLEAN) (BmGetDevicePathSizeEx (DevicePath, FilePathSize) != 0);\r | |
763 | }\r | |
764 | \r | |
765 | /**\r | |
766 | Check whether the VariableName is a valid load option variable name\r | |
767 | and return the load option type and option number.\r | |
768 | \r | |
769 | @param VariableName The name of the load option variable.\r | |
770 | @param OptionType Return the load option type.\r | |
771 | @param OptionNumber Return the load option number.\r | |
772 | \r | |
773 | @retval TRUE The variable name is valid; The load option type and\r | |
774 | load option number is returned.\r | |
775 | @retval FALSE The variable name is NOT valid.\r | |
776 | **/\r | |
777 | BOOLEAN\r | |
3dc5c1ae TP |
778 | EFIAPI\r |
779 | EfiBootManagerIsValidLoadOptionVariableName (\r | |
067ed98a | 780 | IN CHAR16 *VariableName,\r |
3dc5c1ae TP |
781 | OUT EFI_BOOT_MANAGER_LOAD_OPTION_TYPE *OptionType OPTIONAL,\r |
782 | OUT UINT16 *OptionNumber OPTIONAL\r | |
067ed98a RN |
783 | )\r |
784 | {\r | |
785 | UINTN VariableNameLen;\r | |
786 | UINTN Index;\r | |
787 | UINTN Uint;\r | |
788 | \r | |
3dc5c1ae TP |
789 | if (VariableName == NULL) {\r |
790 | return FALSE;\r | |
791 | }\r | |
792 | \r | |
067ed98a RN |
793 | VariableNameLen = StrLen (VariableName);\r |
794 | \r | |
795 | if (VariableNameLen <= 4) {\r | |
796 | return FALSE;\r | |
797 | }\r | |
798 | \r | |
f0209935 | 799 | for (Index = 0; Index < ARRAY_SIZE (mBmLoadOptionName); Index++) {\r |
067ed98a RN |
800 | if ((VariableNameLen - 4 == StrLen (mBmLoadOptionName[Index])) &&\r |
801 | (StrnCmp (VariableName, mBmLoadOptionName[Index], VariableNameLen - 4) == 0)\r | |
802 | ) {\r | |
803 | break;\r | |
804 | }\r | |
805 | }\r | |
806 | \r | |
f0209935 | 807 | if (Index == ARRAY_SIZE (mBmLoadOptionName)) {\r |
067ed98a RN |
808 | return FALSE;\r |
809 | }\r | |
810 | \r | |
3dc5c1ae TP |
811 | if (OptionType != NULL) {\r |
812 | *OptionType = (EFI_BOOT_MANAGER_LOAD_OPTION_TYPE) Index;\r | |
813 | }\r | |
814 | \r | |
815 | if (OptionNumber != NULL) {\r | |
816 | *OptionNumber = 0;\r | |
817 | for (Index = VariableNameLen - 4; Index < VariableNameLen; Index++) {\r | |
818 | Uint = BmCharToUint (VariableName[Index]);\r | |
819 | if (Uint == -1) {\r | |
820 | break;\r | |
821 | } else {\r | |
822 | *OptionNumber = (UINT16) Uint + *OptionNumber * 0x10;\r | |
823 | }\r | |
067ed98a RN |
824 | }\r |
825 | }\r | |
826 | \r | |
827 | return (BOOLEAN) (Index == VariableNameLen);\r | |
828 | }\r | |
829 | \r | |
830 | /**\r | |
831 | Build the Boot#### or Driver#### option from the VariableName.\r | |
832 | \r | |
833 | @param VariableName Variable name of the load option\r | |
834 | @param VendorGuid Variable GUID of the load option\r | |
835 | @param Option Return the load option.\r | |
836 | \r | |
837 | @retval EFI_SUCCESS Get the option just been created\r | |
838 | @retval EFI_NOT_FOUND Failed to get the new option\r | |
839 | \r | |
840 | **/\r | |
841 | EFI_STATUS\r | |
842 | EFIAPI\r | |
843 | EfiBootManagerVariableToLoadOptionEx (\r | |
844 | IN CHAR16 *VariableName,\r | |
845 | IN EFI_GUID *VendorGuid,\r | |
846 | IN OUT EFI_BOOT_MANAGER_LOAD_OPTION *Option \r | |
847 | )\r | |
848 | {\r | |
849 | EFI_STATUS Status;\r | |
850 | UINT32 Attribute;\r | |
851 | UINT16 FilePathSize;\r | |
852 | UINT8 *Variable;\r | |
853 | UINT8 *VariablePtr;\r | |
854 | UINTN VariableSize;\r | |
855 | EFI_DEVICE_PATH_PROTOCOL *FilePath;\r | |
856 | UINT8 *OptionalData;\r | |
857 | UINT32 OptionalDataSize;\r | |
858 | CHAR16 *Description;\r | |
859 | EFI_BOOT_MANAGER_LOAD_OPTION_TYPE OptionType;\r | |
860 | UINT16 OptionNumber;\r | |
861 | \r | |
862 | if ((VariableName == NULL) || (Option == NULL)) {\r | |
863 | return EFI_INVALID_PARAMETER;\r | |
864 | }\r | |
865 | \r | |
3dc5c1ae | 866 | if (!EfiBootManagerIsValidLoadOptionVariableName (VariableName, &OptionType, &OptionNumber)) {\r |
067ed98a RN |
867 | return EFI_INVALID_PARAMETER;\r |
868 | }\r | |
869 | \r | |
870 | //\r | |
871 | // Read the variable\r | |
872 | //\r | |
873 | GetVariable2 (VariableName, VendorGuid, (VOID **) &Variable, &VariableSize);\r | |
874 | if (Variable == NULL) {\r | |
875 | return EFI_NOT_FOUND;\r | |
876 | }\r | |
877 | \r | |
878 | //\r | |
879 | // Validate *#### variable data.\r | |
880 | //\r | |
881 | if (!BmValidateOption(Variable, VariableSize)) {\r | |
882 | FreePool (Variable);\r | |
883 | return EFI_INVALID_PARAMETER;\r | |
884 | }\r | |
885 | \r | |
886 | //\r | |
887 | // Get the option attribute\r | |
888 | //\r | |
889 | VariablePtr = Variable;\r | |
890 | Attribute = ReadUnaligned32 ((UINT32 *) VariablePtr);\r | |
891 | VariablePtr += sizeof (UINT32);\r | |
892 | \r | |
893 | //\r | |
894 | // Get the option's device path size\r | |
895 | //\r | |
896 | FilePathSize = ReadUnaligned16 ((UINT16 *) VariablePtr);\r | |
897 | VariablePtr += sizeof (UINT16);\r | |
898 | \r | |
899 | //\r | |
900 | // Get the option's description string\r | |
901 | //\r | |
902 | Description = (CHAR16 *) VariablePtr;\r | |
903 | \r | |
904 | //\r | |
905 | // Get the option's description string size\r | |
906 | //\r | |
907 | VariablePtr += StrSize ((CHAR16 *) VariablePtr);\r | |
908 | \r | |
909 | //\r | |
910 | // Get the option's device path\r | |
911 | //\r | |
912 | FilePath = (EFI_DEVICE_PATH_PROTOCOL *) VariablePtr;\r | |
913 | VariablePtr += FilePathSize;\r | |
914 | \r | |
809e2bbf | 915 | OptionalDataSize = (UINT32) (VariableSize - ((UINTN) VariablePtr - (UINTN) Variable));\r |
067ed98a RN |
916 | if (OptionalDataSize == 0) {\r |
917 | OptionalData = NULL;\r | |
918 | } else {\r | |
919 | OptionalData = VariablePtr;\r | |
920 | }\r | |
921 | \r | |
922 | Status = EfiBootManagerInitializeLoadOption (\r | |
923 | Option,\r | |
924 | OptionNumber,\r | |
925 | OptionType,\r | |
926 | Attribute,\r | |
927 | Description,\r | |
928 | FilePath,\r | |
929 | OptionalData,\r | |
930 | OptionalDataSize\r | |
931 | );\r | |
932 | ASSERT_EFI_ERROR (Status);\r | |
933 | \r | |
934 | CopyGuid (&Option->VendorGuid, VendorGuid);\r | |
935 | \r | |
936 | FreePool (Variable);\r | |
937 | return Status;\r | |
938 | }\r | |
939 | \r | |
940 | /**\r | |
941 | Build the Boot#### or Driver#### option from the VariableName.\r | |
942 | \r | |
943 | @param VariableName EFI Variable name indicate if it is Boot#### or Driver####\r | |
944 | @param Option Return the Boot#### or Driver#### option.\r | |
945 | \r | |
946 | @retval EFI_SUCCESS Get the option just been created\r | |
947 | @retval EFI_NOT_FOUND Failed to get the new option\r | |
948 | **/\r | |
949 | EFI_STATUS\r | |
950 | EFIAPI\r | |
951 | EfiBootManagerVariableToLoadOption (\r | |
952 | IN CHAR16 *VariableName,\r | |
953 | IN OUT EFI_BOOT_MANAGER_LOAD_OPTION *Option\r | |
954 | )\r | |
955 | {\r | |
956 | return EfiBootManagerVariableToLoadOptionEx (VariableName, &gEfiGlobalVariableGuid, Option);\r | |
957 | }\r | |
958 | \r | |
780e05ca RN |
959 | typedef struct {\r |
960 | EFI_BOOT_MANAGER_LOAD_OPTION_TYPE OptionType;\r | |
961 | EFI_GUID *Guid;\r | |
962 | EFI_BOOT_MANAGER_LOAD_OPTION *Options;\r | |
963 | UINTN OptionCount;\r | |
964 | } BM_COLLECT_LOAD_OPTIONS_PARAM;\r | |
965 | \r | |
966 | /**\r | |
967 | Visitor function to collect the Platform Recovery load options or OS Recovery\r | |
968 | load options from NV storage.\r | |
969 | \r | |
970 | @param Name Variable name.\r | |
971 | @param Guid Variable GUID.\r | |
972 | @param Context The same context passed to BmForEachVariable.\r | |
973 | **/\r | |
974 | VOID\r | |
975 | BmCollectLoadOptions (\r | |
976 | IN CHAR16 *Name,\r | |
977 | IN EFI_GUID *Guid,\r | |
978 | IN VOID *Context\r | |
979 | )\r | |
980 | {\r | |
981 | EFI_STATUS Status;\r | |
982 | EFI_BOOT_MANAGER_LOAD_OPTION_TYPE OptionType;\r | |
983 | UINT16 OptionNumber;\r | |
984 | EFI_BOOT_MANAGER_LOAD_OPTION Option;\r | |
985 | UINTN Index;\r | |
986 | BM_COLLECT_LOAD_OPTIONS_PARAM *Param;\r | |
987 | \r | |
988 | Param = (BM_COLLECT_LOAD_OPTIONS_PARAM *) Context;\r | |
989 | \r | |
990 | if (CompareGuid (Guid, Param->Guid) && (\r | |
991 | Param->OptionType == LoadOptionTypePlatformRecovery &&\r | |
3dc5c1ae | 992 | EfiBootManagerIsValidLoadOptionVariableName (Name, &OptionType, &OptionNumber) &&\r |
780e05ca RN |
993 | OptionType == LoadOptionTypePlatformRecovery\r |
994 | )) {\r | |
995 | Status = EfiBootManagerVariableToLoadOptionEx (Name, Guid, &Option);\r | |
996 | if (!EFI_ERROR (Status)) {\r | |
997 | for (Index = 0; Index < Param->OptionCount; Index++) {\r | |
998 | if (Param->Options[Index].OptionNumber > Option.OptionNumber) {\r | |
999 | break;\r | |
1000 | }\r | |
1001 | }\r | |
1002 | Param->Options = ReallocatePool (\r | |
1003 | Param->OptionCount * sizeof (EFI_BOOT_MANAGER_LOAD_OPTION),\r | |
1004 | (Param->OptionCount + 1) * sizeof (EFI_BOOT_MANAGER_LOAD_OPTION),\r | |
1005 | Param->Options\r | |
1006 | );\r | |
1007 | ASSERT (Param->Options != NULL);\r | |
1008 | CopyMem (&Param->Options[Index + 1], &Param->Options[Index], (Param->OptionCount - Index) * sizeof (EFI_BOOT_MANAGER_LOAD_OPTION));\r | |
1009 | CopyMem (&Param->Options[Index], &Option, sizeof (EFI_BOOT_MANAGER_LOAD_OPTION));\r | |
1010 | Param->OptionCount++;\r | |
1011 | }\r | |
1012 | }\r | |
1013 | }\r | |
1014 | \r | |
067ed98a RN |
1015 | /**\r |
1016 | Returns an array of load options based on the EFI variable\r | |
1017 | L"BootOrder"/L"DriverOrder" and the L"Boot####"/L"Driver####" variables impled by it.\r | |
1018 | #### is the hex value of the UINT16 in each BootOrder/DriverOrder entry. \r | |
1019 | \r | |
1020 | @param LoadOptionCount Returns number of entries in the array.\r | |
1021 | @param LoadOptionType The type of the load option.\r | |
1022 | \r | |
1023 | @retval NULL No load options exist.\r | |
1024 | @retval !NULL Array of load option entries.\r | |
1025 | \r | |
1026 | **/\r | |
1027 | EFI_BOOT_MANAGER_LOAD_OPTION *\r | |
1028 | EFIAPI\r | |
1029 | EfiBootManagerGetLoadOptions (\r | |
1030 | OUT UINTN *OptionCount,\r | |
1031 | IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType\r | |
1032 | )\r | |
1033 | {\r | |
780e05ca RN |
1034 | EFI_STATUS Status;\r |
1035 | UINT16 *OptionOrder;\r | |
1036 | UINTN OptionOrderSize;\r | |
1037 | UINTN Index;\r | |
1038 | UINTN OptionIndex;\r | |
1039 | EFI_BOOT_MANAGER_LOAD_OPTION *Options;\r | |
1040 | CHAR16 OptionName[BM_OPTION_NAME_LEN];\r | |
1041 | UINT16 OptionNumber;\r | |
1042 | BM_COLLECT_LOAD_OPTIONS_PARAM Param;\r | |
067ed98a RN |
1043 | \r |
1044 | *OptionCount = 0;\r | |
780e05ca | 1045 | Options = NULL;\r |
067ed98a RN |
1046 | \r |
1047 | if (LoadOptionType == LoadOptionTypeDriver || LoadOptionType == LoadOptionTypeSysPrep || LoadOptionType == LoadOptionTypeBoot) {\r | |
1048 | //\r | |
1049 | // Read the BootOrder, or DriverOrder variable.\r | |
1050 | //\r | |
1051 | GetEfiGlobalVariable2 (mBmLoadOptionOrderName[LoadOptionType], (VOID **) &OptionOrder, &OptionOrderSize);\r | |
1052 | if (OptionOrder == NULL) {\r | |
1053 | return NULL;\r | |
1054 | }\r | |
1055 | \r | |
1056 | *OptionCount = OptionOrderSize / sizeof (UINT16);\r | |
1057 | \r | |
1058 | Options = AllocatePool (*OptionCount * sizeof (EFI_BOOT_MANAGER_LOAD_OPTION));\r | |
1059 | ASSERT (Options != NULL);\r | |
1060 | \r | |
1061 | OptionIndex = 0;\r | |
1062 | for (Index = 0; Index < *OptionCount; Index++) {\r | |
1063 | OptionNumber = OptionOrder[Index];\r | |
1064 | UnicodeSPrint (OptionName, sizeof (OptionName), L"%s%04x", mBmLoadOptionName[LoadOptionType], OptionNumber);\r | |
1065 | \r | |
1066 | Status = EfiBootManagerVariableToLoadOption (OptionName, &Options[OptionIndex]);\r | |
1067 | if (EFI_ERROR (Status)) {\r | |
1068 | DEBUG ((EFI_D_INFO, "[Bds] %s doesn't exist - Update ****Order variable to remove the reference!!", OptionName));\r | |
1069 | EfiBootManagerDeleteLoadOptionVariable (OptionNumber, LoadOptionType);\r | |
1070 | } else {\r | |
1071 | ASSERT (Options[OptionIndex].OptionNumber == OptionNumber);\r | |
1072 | OptionIndex++;\r | |
1073 | }\r | |
1074 | }\r | |
1075 | \r | |
1076 | if (OptionOrder != NULL) {\r | |
1077 | FreePool (OptionOrder);\r | |
1078 | }\r | |
1079 | \r | |
1080 | if (OptionIndex < *OptionCount) {\r | |
1081 | Options = ReallocatePool (*OptionCount * sizeof (EFI_BOOT_MANAGER_LOAD_OPTION), OptionIndex * sizeof (EFI_BOOT_MANAGER_LOAD_OPTION), Options);\r | |
1082 | ASSERT (Options != NULL);\r | |
1083 | *OptionCount = OptionIndex;\r | |
1084 | }\r | |
1085 | \r | |
780e05ca RN |
1086 | } else if (LoadOptionType == LoadOptionTypePlatformRecovery) {\r |
1087 | Param.OptionType = LoadOptionTypePlatformRecovery;\r | |
1088 | Param.Options = NULL;\r | |
1089 | Param.OptionCount = 0;\r | |
1090 | Param.Guid = &gEfiGlobalVariableGuid;\r | |
1091 | \r | |
1092 | BmForEachVariable (BmCollectLoadOptions, (VOID *) &Param);\r | |
1093 | \r | |
1094 | *OptionCount = Param.OptionCount;\r | |
1095 | Options = Param.Options;\r | |
067ed98a RN |
1096 | }\r |
1097 | \r | |
1098 | return Options;\r | |
1099 | }\r | |
1100 | \r | |
1101 | /**\r | |
1102 | Free an EFI_BOOT_MANGER_LOAD_OPTION entry that was allocate by the library.\r | |
1103 | \r | |
1104 | @param LoadOption Pointer to boot option to Free.\r | |
1105 | \r | |
1106 | @return EFI_SUCCESS BootOption was freed \r | |
1107 | @return EFI_NOT_FOUND BootOption == NULL \r | |
1108 | \r | |
1109 | **/\r | |
1110 | EFI_STATUS\r | |
1111 | EFIAPI\r | |
1112 | EfiBootManagerFreeLoadOption (\r | |
1113 | IN EFI_BOOT_MANAGER_LOAD_OPTION *LoadOption\r | |
1114 | )\r | |
1115 | {\r | |
1116 | if (LoadOption == NULL) {\r | |
1117 | return EFI_NOT_FOUND;\r | |
1118 | }\r | |
1119 | \r | |
1120 | if (LoadOption->Description != NULL) {\r | |
1121 | FreePool (LoadOption->Description);\r | |
1122 | }\r | |
1123 | if (LoadOption->FilePath != NULL) {\r | |
1124 | FreePool (LoadOption->FilePath);\r | |
1125 | }\r | |
1126 | if (LoadOption->OptionalData != NULL) {\r | |
1127 | FreePool (LoadOption->OptionalData);\r | |
1128 | }\r | |
1129 | \r | |
1130 | return EFI_SUCCESS;\r | |
1131 | }\r | |
1132 | \r | |
1133 | /**\r | |
1134 | Free an EFI_BOOT_MANGER_LOAD_OPTION array that was allocated by \r | |
1135 | EfiBootManagerGetLoadOptions().\r | |
1136 | \r | |
1137 | @param Option Pointer to boot option array to free.\r | |
1138 | @param OptionCount Number of array entries in BootOption\r | |
1139 | \r | |
1140 | @return EFI_SUCCESS BootOption was freed \r | |
1141 | @return EFI_NOT_FOUND BootOption == NULL \r | |
1142 | \r | |
1143 | **/\r | |
1144 | EFI_STATUS\r | |
1145 | EFIAPI\r | |
1146 | EfiBootManagerFreeLoadOptions (\r | |
1147 | IN EFI_BOOT_MANAGER_LOAD_OPTION *Option,\r | |
1148 | IN UINTN OptionCount\r | |
1149 | )\r | |
1150 | {\r | |
1151 | UINTN Index;\r | |
1152 | \r | |
1153 | if (Option == NULL) {\r | |
1154 | return EFI_NOT_FOUND;\r | |
1155 | }\r | |
1156 | \r | |
1157 | for (Index = 0;Index < OptionCount; Index++) {\r | |
1158 | EfiBootManagerFreeLoadOption (&Option[Index]);\r | |
1159 | }\r | |
1160 | \r | |
1161 | FreePool (Option);\r | |
1162 | \r | |
1163 | return EFI_SUCCESS;\r | |
1164 | }\r | |
1165 | \r | |
1166 | /**\r | |
1167 | Return whether the PE header of the load option is valid or not.\r | |
1168 | \r | |
1169 | @param[in] Type The load option type.\r | |
1170 | @param[in] FileBuffer The PE file buffer of the load option.\r | |
1171 | @param[in] FileSize The size of the load option file.\r | |
1172 | \r | |
1173 | @retval TRUE The PE header of the load option is valid.\r | |
1174 | @retval FALSE The PE header of the load option is not valid.\r | |
1175 | **/\r | |
1176 | BOOLEAN\r | |
1177 | BmIsLoadOptionPeHeaderValid (\r | |
1178 | IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE Type,\r | |
1179 | IN VOID *FileBuffer,\r | |
1180 | IN UINTN FileSize\r | |
1181 | )\r | |
1182 | {\r | |
1183 | EFI_IMAGE_DOS_HEADER *DosHeader;\r | |
1184 | EFI_IMAGE_OPTIONAL_HEADER_UNION *PeHeader;\r | |
1185 | EFI_IMAGE_OPTIONAL_HEADER32 *OptionalHeader;\r | |
1186 | UINT16 Subsystem;\r | |
1187 | \r | |
1188 | if (FileBuffer == NULL || FileSize == 0) {\r | |
1189 | return FALSE;\r | |
1190 | }\r | |
1191 | \r | |
1192 | //\r | |
1193 | // Read dos header\r | |
1194 | //\r | |
1195 | DosHeader = (EFI_IMAGE_DOS_HEADER *) FileBuffer;\r | |
1196 | if (FileSize >= sizeof (EFI_IMAGE_DOS_HEADER) &&\r | |
1197 | FileSize > DosHeader->e_lfanew && DosHeader->e_magic == EFI_IMAGE_DOS_SIGNATURE\r | |
1198 | ) {\r | |
1199 | //\r | |
1200 | // Read and check PE signature\r | |
1201 | //\r | |
1202 | PeHeader = (EFI_IMAGE_OPTIONAL_HEADER_UNION *) ((UINT8 *) FileBuffer + DosHeader->e_lfanew);\r | |
1203 | if (FileSize >= DosHeader->e_lfanew + sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION) &&\r | |
1204 | PeHeader->Pe32.Signature == EFI_IMAGE_NT_SIGNATURE\r | |
1205 | ) {\r | |
1206 | //\r | |
1207 | // Check PE32 or PE32+ magic, and machine type\r | |
1208 | //\r | |
1209 | OptionalHeader = (EFI_IMAGE_OPTIONAL_HEADER32 *) &PeHeader->Pe32.OptionalHeader;\r | |
1210 | if ((OptionalHeader->Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC || \r | |
1211 | OptionalHeader->Magic == EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC) &&\r | |
1212 | EFI_IMAGE_MACHINE_TYPE_SUPPORTED (PeHeader->Pe32.FileHeader.Machine)\r | |
1213 | ) {\r | |
1214 | //\r | |
1215 | // Check the Subsystem:\r | |
1216 | // Driver#### must be of type BootServiceDriver or RuntimeDriver\r | |
1217 | // SysPrep####, Boot####, OsRecovery####, PlatformRecovery#### must be of type Application\r | |
1218 | //\r | |
1219 | Subsystem = OptionalHeader->Subsystem;\r | |
1220 | if ((Type == LoadOptionTypeDriver && Subsystem == EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER) ||\r | |
1221 | (Type == LoadOptionTypeDriver && Subsystem == EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER) ||\r | |
1222 | (Type == LoadOptionTypeSysPrep && Subsystem == EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION) ||\r | |
780e05ca RN |
1223 | (Type == LoadOptionTypeBoot && Subsystem == EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION) ||\r |
1224 | (Type == LoadOptionTypePlatformRecovery && Subsystem == EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION)\r | |
067ed98a RN |
1225 | ) {\r |
1226 | return TRUE;\r | |
1227 | }\r | |
1228 | }\r | |
1229 | }\r | |
1230 | }\r | |
1231 | \r | |
1232 | return FALSE;\r | |
1233 | }\r | |
1234 | \r | |
1235 | /**\r | |
1236 | Process (load and execute) the load option.\r | |
1237 | \r | |
1238 | @param LoadOption Pointer to the load option.\r | |
1239 | \r | |
1240 | @retval EFI_INVALID_PARAMETER The load option type is invalid, \r | |
1241 | or the load option file path doesn't point to a valid file.\r | |
1242 | @retval EFI_UNSUPPORTED The load option type is of LoadOptionTypeBoot.\r | |
1243 | @retval EFI_SUCCESS The load option is inactive, or successfully loaded and executed.\r | |
1244 | **/\r | |
1245 | EFI_STATUS\r | |
1246 | EFIAPI\r | |
1247 | EfiBootManagerProcessLoadOption (\r | |
1248 | IN EFI_BOOT_MANAGER_LOAD_OPTION *LoadOption\r | |
1249 | )\r | |
1250 | {\r | |
1251 | EFI_STATUS Status;\r | |
1252 | EFI_DEVICE_PATH_PROTOCOL *FilePath;\r | |
1253 | EFI_HANDLE ImageHandle;\r | |
1254 | EFI_LOADED_IMAGE_PROTOCOL *ImageInfo;\r | |
1255 | VOID *FileBuffer;\r | |
1256 | UINTN FileSize;\r | |
1257 | \r | |
1258 | if ((UINT32) LoadOption->OptionType >= LoadOptionTypeMax) {\r | |
1259 | return EFI_INVALID_PARAMETER;\r | |
1260 | }\r | |
1261 | \r | |
1262 | if (LoadOption->OptionType == LoadOptionTypeBoot) {\r | |
1263 | return EFI_UNSUPPORTED;\r | |
1264 | }\r | |
1265 | \r | |
1266 | //\r | |
1267 | // If a load option is not marked as LOAD_OPTION_ACTIVE,\r | |
1268 | // the boot manager will not automatically load the option.\r | |
1269 | //\r | |
1270 | if ((LoadOption->Attributes & LOAD_OPTION_ACTIVE) == 0) {\r | |
1271 | return EFI_SUCCESS;\r | |
1272 | }\r | |
1273 | \r | |
1274 | Status = EFI_INVALID_PARAMETER;\r | |
1275 | \r | |
1276 | //\r | |
1277 | // Load and start the load option.\r | |
1278 | //\r | |
1279 | DEBUG ((\r | |
3fc46b79 RN |
1280 | DEBUG_INFO | DEBUG_LOAD, "Process %s%04x (%s) ...\n",\r |
1281 | mBmLoadOptionName[LoadOption->OptionType], LoadOption->OptionNumber,\r | |
1282 | LoadOption->Description\r | |
067ed98a RN |
1283 | ));\r |
1284 | ImageHandle = NULL;\r | |
4ed2440d | 1285 | FileBuffer = EfiBootManagerGetLoadOptionBuffer (LoadOption->FilePath, &FilePath, &FileSize);\r |
067ed98a RN |
1286 | DEBUG_CODE (\r |
1287 | if (FileBuffer != NULL && CompareMem (LoadOption->FilePath, FilePath, GetDevicePathSize (FilePath)) != 0) {\r | |
1288 | DEBUG ((EFI_D_INFO, "[Bds] DevicePath expand: "));\r | |
1289 | BmPrintDp (LoadOption->FilePath);\r | |
1290 | DEBUG ((EFI_D_INFO, " -> "));\r | |
1291 | BmPrintDp (FilePath);\r | |
1292 | DEBUG ((EFI_D_INFO, "\n"));\r | |
1293 | }\r | |
1294 | );\r | |
1295 | if (BmIsLoadOptionPeHeaderValid (LoadOption->OptionType, FileBuffer, FileSize)) {\r | |
1296 | Status = gBS->LoadImage (\r | |
1297 | FALSE,\r | |
1298 | gImageHandle,\r | |
1299 | FilePath,\r | |
1300 | FileBuffer,\r | |
1301 | FileSize,\r | |
1302 | &ImageHandle\r | |
1303 | );\r | |
1304 | }\r | |
1305 | if (FilePath != NULL) {\r | |
1306 | FreePool (FilePath);\r | |
1307 | }\r | |
1308 | if (FileBuffer != NULL) {\r | |
1309 | FreePool (FileBuffer);\r | |
1310 | }\r | |
1311 | \r | |
1312 | if (!EFI_ERROR (Status)) {\r | |
1313 | Status = gBS->HandleProtocol (ImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &ImageInfo);\r | |
1314 | ASSERT_EFI_ERROR (Status);\r | |
1315 | \r | |
1316 | ImageInfo->LoadOptionsSize = LoadOption->OptionalDataSize;\r | |
1317 | ImageInfo->LoadOptions = LoadOption->OptionalData;\r | |
1318 | //\r | |
1319 | // Before calling the image, enable the Watchdog Timer for the 5-minute period\r | |
1320 | //\r | |
1321 | gBS->SetWatchdogTimer (5 * 60, 0, 0, NULL);\r | |
1322 | \r | |
1323 | LoadOption->Status = gBS->StartImage (ImageHandle, &LoadOption->ExitDataSize, &LoadOption->ExitData);\r | |
1324 | DEBUG ((\r | |
3fc46b79 | 1325 | DEBUG_INFO | DEBUG_LOAD, "%s%04x Return Status = %r\n",\r |
067ed98a RN |
1326 | mBmLoadOptionName[LoadOption->OptionType], LoadOption->OptionNumber, LoadOption->Status\r |
1327 | ));\r | |
1328 | \r | |
1329 | //\r | |
1330 | // Clear the Watchdog Timer after the image returns\r | |
1331 | //\r | |
1332 | gBS->SetWatchdogTimer (0, 0, 0, NULL);\r | |
1333 | }\r | |
1334 | \r | |
1335 | return Status;\r | |
1336 | }\r |