]> git.proxmox.com Git - mirror_edk2.git/blame - OvmfPkg/Library/PlatformBdsLib/QemuBootOrder.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
OvmfPkg: QemuBootOrder: lower the required number of OFW nodes to 2
[mirror_edk2.git] / OvmfPkg / Library / PlatformBdsLib / QemuBootOrder.c
CommitLineData
2cd086a6 1/** @file\r
2 Rewrite the BootOrder NvVar based on QEMU's "bootorder" fw_cfg file.\r
3\r
4 Copyright (C) 2012, Red Hat, Inc.\r
5\r
6 This program and the accompanying materials are licensed and made available\r
7 under the terms and conditions of the BSD License which accompanies this\r
8 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, WITHOUT\r
12 WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13**/\r
14\r
15#include <Library/QemuFwCfgLib.h>\r
16#include <Library/DebugLib.h>\r
17#include <Library/MemoryAllocationLib.h>\r
18#include <Library/GenericBdsLib.h>\r
19#include <Library/UefiBootServicesTableLib.h>\r
20#include <Library/UefiRuntimeServicesTableLib.h>\r
21#include <Library/BaseLib.h>\r
22#include <Library/PrintLib.h>\r
23#include <Protocol/DevicePathToText.h>\r
24#include <Guid/GlobalVariable.h>\r
25\r
26\r
27/**\r
28 OpenFirmware to UEFI device path translation output buffer size in CHAR16's.\r
29**/\r
30#define TRANSLATION_OUTPUT_SIZE 0x100\r
31\r
32\r
33/**\r
ec01afdb 34 Numbers of nodes in OpenFirmware device paths that are required and examined.\r
2cd086a6 35**/\r
ec01afdb 36#define REQUIRED_OFW_NODES 2\r
37#define EXAMINED_OFW_NODES 4\r
2cd086a6 38\r
39\r
40/**\r
41 Simple character classification routines, corresponding to POSIX class names\r
42 and ASCII encoding.\r
43**/\r
44STATIC\r
45BOOLEAN\r
46IsAlnum (\r
47 IN CHAR8 Chr\r
48 )\r
49{\r
50 return (('0' <= Chr && Chr <= '9') ||\r
51 ('A' <= Chr && Chr <= 'Z') ||\r
52 ('a' <= Chr && Chr <= 'z')\r
53 );\r
54}\r
55\r
56\r
57STATIC\r
58BOOLEAN\r
59IsDriverNamePunct (\r
60 IN CHAR8 Chr\r
61 )\r
62{\r
63 return (Chr == ',' || Chr == '.' || Chr == '_' ||\r
64 Chr == '+' || Chr == '-'\r
65 );\r
66}\r
67\r
68\r
69STATIC\r
70BOOLEAN\r
71IsPrintNotDelim (\r
72 IN CHAR8 Chr\r
73 )\r
74{\r
75 return (32 <= Chr && Chr <= 126 &&\r
76 Chr != '/' && Chr != '@' && Chr != ':');\r
77}\r
78\r
79\r
80/**\r
81 Utility types and functions.\r
82**/\r
83typedef struct {\r
84 CONST CHAR8 *Ptr; // not necessarily NUL-terminated\r
85 UINTN Len; // number of non-NUL characters\r
86} SUBSTRING;\r
87\r
88\r
89/**\r
90\r
91 Check if Substring and String have identical contents.\r
92\r
93 The function relies on the restriction that a SUBSTRING cannot have embedded\r
94 NULs either.\r
95\r
96 @param[in] Substring The SUBSTRING input to the comparison.\r
97\r
98 @param[in] String The ASCII string input to the comparison.\r
99\r
100\r
101 @return Whether the inputs have identical contents.\r
102\r
103**/\r
104STATIC\r
105BOOLEAN\r
106SubstringEq (\r
107 IN SUBSTRING Substring,\r
108 IN CONST CHAR8 *String\r
109 )\r
110{\r
111 UINTN Pos;\r
112 CONST CHAR8 *Chr;\r
113\r
114 Pos = 0;\r
115 Chr = String;\r
116\r
117 while (Pos < Substring.Len && Substring.Ptr[Pos] == *Chr) {\r
118 ++Pos;\r
119 ++Chr;\r
120 }\r
121\r
dccf7678 122 return (BOOLEAN)(Pos == Substring.Len && *Chr == '\0');\r
2cd086a6 123}\r
124\r
125\r
126/**\r
127\r
128 Parse a comma-separated list of hexadecimal integers into the elements of an\r
129 UINT32 array.\r
130\r
131 Whitespace, "0x" prefixes, leading or trailing commas, sequences of commas,\r
132 or an empty string are not allowed; they are rejected.\r
133\r
134 The function relies on ASCII encoding.\r
135\r
136 @param[in] UnitAddress The substring to parse.\r
137\r
138 @param[out] Result The array, allocated by the caller, to receive\r
139 the parsed values. This parameter may be NULL if\r
140 NumResults is zero on input.\r
141\r
142 @param[in out] NumResults On input, the number of elements allocated for\r
143 Result. On output, the number of elements it has\r
144 taken (or would have taken) to parse the string\r
145 fully.\r
146\r
147\r
148 @retval RETURN_SUCCESS UnitAddress has been fully parsed.\r
149 NumResults is set to the number of parsed\r
150 values; the corresponding elements have\r
151 been set in Result. The rest of Result's\r
152 elements are unchanged.\r
153\r
154 @retval RETURN_BUFFER_TOO_SMALL UnitAddress has been fully parsed.\r
155 NumResults is set to the number of parsed\r
156 values, but elements have been stored only\r
157 up to the input value of NumResults, which\r
158 is less than what has been parsed.\r
159\r
160 @retval RETURN_INVALID_PARAMETER Parse error. The contents of Results is\r
161 indeterminate. NumResults has not been\r
162 changed.\r
163\r
164**/\r
165STATIC\r
166RETURN_STATUS\r
167ParseUnitAddressHexList (\r
168 IN SUBSTRING UnitAddress,\r
169 OUT UINT32 *Result,\r
170 IN OUT UINTN *NumResults\r
171 )\r
172{\r
173 UINTN Entry; // number of entry currently being parsed\r
174 UINT32 EntryVal; // value being constructed for current entry\r
175 CHAR8 PrevChr; // UnitAddress character previously checked\r
176 UINTN Pos; // current position within UnitAddress\r
177 RETURN_STATUS Status;\r
178\r
179 Entry = 0;\r
180 EntryVal = 0;\r
181 PrevChr = ',';\r
182\r
183 for (Pos = 0; Pos < UnitAddress.Len; ++Pos) {\r
184 CHAR8 Chr;\r
185 INT8 Val;\r
186\r
187 Chr = UnitAddress.Ptr[Pos];\r
188 Val = ('a' <= Chr && Chr <= 'f') ? (Chr - 'a' + 10) :\r
189 ('A' <= Chr && Chr <= 'F') ? (Chr - 'A' + 10) :\r
190 ('0' <= Chr && Chr <= '9') ? (Chr - '0' ) :\r
191 -1;\r
192\r
193 if (Val >= 0) {\r
194 if (EntryVal > 0xFFFFFFF) {\r
195 return RETURN_INVALID_PARAMETER;\r
196 }\r
197 EntryVal = (EntryVal << 4) | Val;\r
198 } else if (Chr == ',') {\r
199 if (PrevChr == ',') {\r
200 return RETURN_INVALID_PARAMETER;\r
201 }\r
202 if (Entry < *NumResults) {\r
203 Result[Entry] = EntryVal;\r
204 }\r
205 ++Entry;\r
206 EntryVal = 0;\r
207 } else {\r
208 return RETURN_INVALID_PARAMETER;\r
209 }\r
210\r
211 PrevChr = Chr;\r
212 }\r
213\r
214 if (PrevChr == ',') {\r
215 return RETURN_INVALID_PARAMETER;\r
216 }\r
217 if (Entry < *NumResults) {\r
218 Result[Entry] = EntryVal;\r
219 Status = RETURN_SUCCESS;\r
220 } else {\r
221 Status = RETURN_BUFFER_TOO_SMALL;\r
222 }\r
223 ++Entry;\r
224\r
225 *NumResults = Entry;\r
226 return Status;\r
227}\r
228\r
229\r
230/**\r
231 A simple array of Boot Option ID's.\r
232**/\r
233typedef struct {\r
234 UINT16 *Data;\r
235 UINTN Allocated;\r
236 UINTN Produced;\r
237} BOOT_ORDER;\r
238\r
239\r
240/**\r
241\r
242 Append BootOptionId to BootOrder, reallocating the latter if needed.\r
243\r
244 @param[in out] BootOrder The structure pointing to the array and holding\r
245 allocation and usage counters.\r
246\r
247 @param[in] BootOptionId The value to append to the array.\r
248\r
249\r
250 @retval RETURN_SUCCESS BootOptionId appended.\r
251\r
252 @retval RETURN_OUT_OF_RESOURCES Memory reallocation failed.\r
253\r
254**/\r
255STATIC\r
256RETURN_STATUS\r
257BootOrderAppend (\r
258 IN OUT BOOT_ORDER *BootOrder,\r
259 IN UINT16 BootOptionId\r
260 )\r
261{\r
262 if (BootOrder->Produced == BootOrder->Allocated) {\r
263 UINTN AllocatedNew;\r
264 UINT16 *DataNew;\r
265\r
266 ASSERT (BootOrder->Allocated > 0);\r
267 AllocatedNew = BootOrder->Allocated * 2;\r
268 DataNew = ReallocatePool (\r
269 BootOrder->Allocated * sizeof (*BootOrder->Data),\r
270 AllocatedNew * sizeof (*DataNew),\r
271 BootOrder->Data\r
272 );\r
273 if (DataNew == NULL) {\r
274 return RETURN_OUT_OF_RESOURCES;\r
275 }\r
276 BootOrder->Allocated = AllocatedNew;\r
277 BootOrder->Data = DataNew;\r
278 }\r
279\r
280 BootOrder->Data[BootOrder->Produced++] = BootOptionId;\r
281 return RETURN_SUCCESS;\r
282}\r
283\r
284\r
285/**\r
286 OpenFirmware device path node\r
287**/\r
288typedef struct {\r
289 SUBSTRING DriverName;\r
290 SUBSTRING UnitAddress;\r
291 SUBSTRING DeviceArguments;\r
292} OFW_NODE;\r
293\r
294\r
295/**\r
296\r
297 Parse an OpenFirmware device path node into the caller-allocated OFW_NODE\r
298 structure, and advance in the input string.\r
299\r
300 The node format is mostly parsed after IEEE 1275-1994, 3.2.1.1 "Node names"\r
301 (a leading slash is expected and not returned):\r
302\r
303 /driver-name@unit-address[:device-arguments][<LF>]\r
304\r
305 A single trailing <LF> character is consumed but not returned. A trailing\r
306 <LF> or NUL character terminates the device path.\r
307\r
308 The function relies on ASCII encoding.\r
309\r
310 @param[in out] Ptr Address of the pointer pointing to the start of the\r
311 node string. After successful parsing *Ptr is set to\r
312 the byte immediately following the consumed\r
313 characters. On error it points to the byte that\r
314 caused the error. The input string is never modified.\r
315\r
316 @param[out] OfwNode The members of this structure point into the input\r
317 string, designating components of the node.\r
318 Separators are never included. If "device-arguments"\r
319 is missing, then DeviceArguments.Ptr is set to NULL.\r
320 All components that are present have nonzero length.\r
321\r
322 If the call doesn't succeed, the contents of this\r
323 structure is indeterminate.\r
324\r
325 @param[out] IsFinal In case of successul parsing, this parameter signals\r
326 whether the node just parsed is the final node in the\r
327 device path. The call after a final node will attempt\r
328 to start parsing the next path. If the call doesn't\r
329 succeed, then this parameter is not changed.\r
330\r
331\r
332 @retval RETURN_SUCCESS Parsing successful.\r
333\r
334 @retval RETURN_NOT_FOUND Parsing terminated. *Ptr was (and is)\r
335 pointing to an empty string.\r
336\r
337 @retval RETURN_INVALID_PARAMETER Parse error.\r
338\r
339**/\r
340STATIC\r
341RETURN_STATUS\r
342ParseOfwNode (\r
343 IN OUT CONST CHAR8 **Ptr,\r
344 OUT OFW_NODE *OfwNode,\r
345 OUT BOOLEAN *IsFinal\r
346 )\r
347{\r
348 //\r
349 // A leading slash is expected. End of string is tolerated.\r
350 //\r
351 switch (**Ptr) {\r
352 case '\0':\r
353 return RETURN_NOT_FOUND;\r
354\r
355 case '/':\r
356 ++*Ptr;\r
357 break;\r
358\r
359 default:\r
360 return RETURN_INVALID_PARAMETER;\r
361 }\r
362\r
363 //\r
364 // driver-name\r
365 //\r
366 OfwNode->DriverName.Ptr = *Ptr;\r
367 OfwNode->DriverName.Len = 0;\r
368 while (OfwNode->DriverName.Len < 32 &&\r
369 (IsAlnum (**Ptr) || IsDriverNamePunct (**Ptr))\r
370 ) {\r
371 ++*Ptr;\r
372 ++OfwNode->DriverName.Len;\r
373 }\r
374\r
375 if (OfwNode->DriverName.Len == 0 || OfwNode->DriverName.Len == 32) {\r
376 return RETURN_INVALID_PARAMETER;\r
377 }\r
378\r
379\r
380 //\r
381 // unit-address\r
382 //\r
383 if (**Ptr != '@') {\r
384 return RETURN_INVALID_PARAMETER;\r
385 }\r
386 ++*Ptr;\r
387\r
388 OfwNode->UnitAddress.Ptr = *Ptr;\r
389 OfwNode->UnitAddress.Len = 0;\r
390 while (IsPrintNotDelim (**Ptr)) {\r
391 ++*Ptr;\r
392 ++OfwNode->UnitAddress.Len;\r
393 }\r
394\r
395 if (OfwNode->UnitAddress.Len == 0) {\r
396 return RETURN_INVALID_PARAMETER;\r
397 }\r
398\r
399\r
400 //\r
401 // device-arguments, may be omitted\r
402 //\r
403 OfwNode->DeviceArguments.Len = 0;\r
404 if (**Ptr == ':') {\r
405 ++*Ptr;\r
406 OfwNode->DeviceArguments.Ptr = *Ptr;\r
407\r
408 while (IsPrintNotDelim (**Ptr)) {\r
409 ++*Ptr;\r
410 ++OfwNode->DeviceArguments.Len;\r
411 }\r
412\r
413 if (OfwNode->DeviceArguments.Len == 0) {\r
414 return RETURN_INVALID_PARAMETER;\r
415 }\r
416 }\r
417 else {\r
418 OfwNode->DeviceArguments.Ptr = NULL;\r
419 }\r
420\r
421 switch (**Ptr) {\r
422 case '\n':\r
423 ++*Ptr;\r
424 //\r
425 // fall through\r
426 //\r
427\r
428 case '\0':\r
429 *IsFinal = TRUE;\r
430 break;\r
431\r
432 case '/':\r
433 *IsFinal = FALSE;\r
434 break;\r
435\r
436 default:\r
437 return RETURN_INVALID_PARAMETER;\r
438 }\r
439\r
440 DEBUG ((\r
441 DEBUG_VERBOSE,\r
442 "%a: DriverName=\"%.*a\" UnitAddress=\"%.*a\" DeviceArguments=\"%.*a\"\n",\r
443 __FUNCTION__,\r
444 OfwNode->DriverName.Len, OfwNode->DriverName.Ptr,\r
445 OfwNode->UnitAddress.Len, OfwNode->UnitAddress.Ptr,\r
446 OfwNode->DeviceArguments.Len,\r
447 OfwNode->DeviceArguments.Ptr == NULL ? "" : OfwNode->DeviceArguments.Ptr\r
448 ));\r
449 return RETURN_SUCCESS;\r
450}\r
451\r
452\r
453/**\r
454\r
455 Translate an array of OpenFirmware device nodes to a UEFI device path\r
456 fragment.\r
457\r
458 @param[in] OfwNode Array of OpenFirmware device nodes to\r
459 translate, constituting the beginning of an\r
460 OpenFirmware device path.\r
461\r
462 @param[in] NumNodes Number of elements in OfwNode.\r
463\r
464 @param[out] Translated Destination array receiving the UEFI path\r
465 fragment, allocated by the caller. If the\r
466 return value differs from RETURN_SUCCESS, its\r
467 contents is indeterminate.\r
468\r
469 @param[in out] TranslatedSize On input, the number of CHAR16's in\r
470 Translated. On RETURN_SUCCESS this parameter\r
471 is assigned the number of non-NUL CHAR16's\r
472 written to Translated. In case of other return\r
473 values, TranslatedSize is indeterminate.\r
474\r
475\r
476 @retval RETURN_SUCCESS Translation successful.\r
477\r
478 @retval RETURN_BUFFER_TOO_SMALL The translation does not fit into the number\r
479 of bytes provided.\r
480\r
481 @retval RETURN_UNSUPPORTED The array of OpenFirmware device nodes can't\r
482 be translated in the current implementation.\r
483\r
484**/\r
485STATIC\r
486RETURN_STATUS\r
487TranslateOfwNodes (\r
488 IN CONST OFW_NODE *OfwNode,\r
489 IN UINTN NumNodes,\r
490 OUT CHAR16 *Translated,\r
491 IN OUT UINTN *TranslatedSize\r
492 )\r
493{\r
494 UINT32 PciDevFun[2];\r
495 UINTN NumEntries;\r
496 UINTN Written;\r
497\r
498 //\r
499 // Get PCI device and optional PCI function. Assume a single PCI root.\r
500 //\r
ec01afdb 501 if (NumNodes < REQUIRED_OFW_NODES ||\r
2cd086a6 502 !SubstringEq (OfwNode[0].DriverName, "pci")\r
503 ) {\r
504 return RETURN_UNSUPPORTED;\r
505 }\r
506 PciDevFun[1] = 0;\r
507 NumEntries = sizeof (PciDevFun) / sizeof (PciDevFun[0]);\r
508 if (ParseUnitAddressHexList (\r
509 OfwNode[1].UnitAddress,\r
510 PciDevFun,\r
511 &NumEntries\r
512 ) != RETURN_SUCCESS\r
513 ) {\r
514 return RETURN_UNSUPPORTED;\r
515 }\r
516\r
ec01afdb 517 if (NumNodes >= 4 &&\r
518 SubstringEq (OfwNode[1].DriverName, "ide") &&\r
2cd086a6 519 SubstringEq (OfwNode[2].DriverName, "drive") &&\r
520 SubstringEq (OfwNode[3].DriverName, "disk")\r
521 ) {\r
522 //\r
523 // OpenFirmware device path (IDE disk, IDE CD-ROM):\r
524 //\r
525 // /pci@i0cf8/ide@1,1/drive@0/disk@0\r
526 // ^ ^ ^ ^ ^\r
527 // | | | | master or slave\r
528 // | | | primary or secondary\r
529 // | PCI slot & function holding IDE controller\r
530 // PCI root at system bus port, PIO\r
531 //\r
532 // UEFI device path:\r
533 //\r
534 // PciRoot(0x0)/Pci(0x1,0x1)/Ata(Primary,Master,0x0)\r
535 // ^\r
536 // fixed LUN\r
537 //\r
538 UINT32 Secondary;\r
539 UINT32 Slave;\r
540\r
541 NumEntries = 1;\r
542 if (ParseUnitAddressHexList (\r
543 OfwNode[2].UnitAddress,\r
544 &Secondary,\r
545 &NumEntries\r
546 ) != RETURN_SUCCESS ||\r
547 Secondary > 1 ||\r
548 ParseUnitAddressHexList (\r
549 OfwNode[3].UnitAddress,\r
550 &Slave,\r
551 &NumEntries // reuse after previous single-element call\r
552 ) != RETURN_SUCCESS ||\r
553 Slave > 1\r
554 ) {\r
555 return RETURN_UNSUPPORTED;\r
556 }\r
557\r
558 Written = UnicodeSPrintAsciiFormat (\r
559 Translated,\r
560 *TranslatedSize * sizeof (*Translated), // BufferSize in bytes\r
561 "PciRoot(0x0)/Pci(0x%x,0x%x)/Ata(%a,%a,0x0)",\r
562 PciDevFun[0],\r
563 PciDevFun[1],\r
564 Secondary ? "Secondary" : "Primary",\r
565 Slave ? "Slave" : "Master"\r
566 );\r
ec01afdb 567 } else if (NumNodes >= 4 &&\r
568 SubstringEq (OfwNode[1].DriverName, "isa") &&\r
2cd086a6 569 SubstringEq (OfwNode[2].DriverName, "fdc") &&\r
570 SubstringEq (OfwNode[3].DriverName, "floppy")\r
571 ) {\r
572 //\r
573 // OpenFirmware device path (floppy disk):\r
574 //\r
575 // /pci@i0cf8/isa@1/fdc@03f0/floppy@0\r
576 // ^ ^ ^ ^\r
577 // | | | A: or B:\r
578 // | | ISA controller io-port (hex)\r
579 // | PCI slot holding ISA controller\r
580 // PCI root at system bus port, PIO\r
581 //\r
582 // UEFI device path:\r
583 //\r
584 // PciRoot(0x0)/Pci(0x1,0x0)/Floppy(0x0)\r
585 // ^\r
586 // ACPI UID\r
587 //\r
588 UINT32 AcpiUid;\r
589\r
590 NumEntries = 1;\r
591 if (ParseUnitAddressHexList (\r
592 OfwNode[3].UnitAddress,\r
593 &AcpiUid,\r
594 &NumEntries\r
595 ) != RETURN_SUCCESS ||\r
596 AcpiUid > 1\r
597 ) {\r
598 return RETURN_UNSUPPORTED;\r
599 }\r
600\r
601 Written = UnicodeSPrintAsciiFormat (\r
602 Translated,\r
603 *TranslatedSize * sizeof (*Translated), // BufferSize in bytes\r
604 "PciRoot(0x0)/Pci(0x%x,0x%x)/Floppy(0x%x)",\r
605 PciDevFun[0],\r
606 PciDevFun[1],\r
607 AcpiUid\r
608 );\r
cdde6ddf 609 } else {\r
610 return RETURN_UNSUPPORTED;\r
611 }\r
2cd086a6 612\r
613 //\r
614 // There's no way to differentiate between "completely used up without\r
615 // truncation" and "truncated", so treat the former as the latter, and return\r
616 // success only for "some room left unused".\r
617 //\r
618 if (Written + 1 < *TranslatedSize) {\r
619 *TranslatedSize = Written;\r
620 return RETURN_SUCCESS;\r
621 }\r
622\r
623 return RETURN_BUFFER_TOO_SMALL;\r
624}\r
625\r
626\r
627/**\r
628\r
629 Translate an OpenFirmware device path fragment to a UEFI device path\r
630 fragment, and advance in the input string.\r
631\r
632 @param[in out] Ptr Address of the pointer pointing to the start\r
633 of the path string. After successful\r
634 translation (RETURN_SUCCESS) or at least\r
635 successful parsing (RETURN_UNSUPPORTED,\r
636 RETURN_BUFFER_TOO_SMALL), *Ptr is set to the\r
637 byte immediately following the consumed\r
638 characters. In other error cases, it points to\r
639 the byte that caused the error.\r
640\r
641 @param[out] Translated Destination array receiving the UEFI path\r
642 fragment, allocated by the caller. If the\r
643 return value differs from RETURN_SUCCESS, its\r
644 contents is indeterminate.\r
645\r
646 @param[in out] TranslatedSize On input, the number of CHAR16's in\r
647 Translated. On RETURN_SUCCESS this parameter\r
648 is assigned the number of non-NUL CHAR16's\r
649 written to Translated. In case of other return\r
650 values, TranslatedSize is indeterminate.\r
651\r
652\r
653 @retval RETURN_SUCCESS Translation successful.\r
654\r
655 @retval RETURN_BUFFER_TOO_SMALL The OpenFirmware device path was parsed\r
656 successfully, but its translation did not\r
657 fit into the number of bytes provided.\r
658 Further calls to this function are\r
659 possible.\r
660\r
661 @retval RETURN_UNSUPPORTED The OpenFirmware device path was parsed\r
662 successfully, but it can't be translated in\r
663 the current implementation. Further calls\r
664 to this function are possible.\r
665\r
666 @retval RETURN_NOT_FOUND Translation terminated, *Ptr was (and is)\r
667 pointing to an empty string.\r
668\r
669 @retval RETURN_INVALID_PARAMETER Parse error. This is a permanent error.\r
670\r
671**/\r
672STATIC\r
673RETURN_STATUS\r
674TranslateOfwPath (\r
675 IN OUT CONST CHAR8 **Ptr,\r
676 OUT CHAR16 *Translated,\r
677 IN OUT UINTN *TranslatedSize\r
678 )\r
679{\r
680 UINTN NumNodes;\r
681 RETURN_STATUS Status;\r
ec01afdb 682 OFW_NODE Node[EXAMINED_OFW_NODES];\r
2cd086a6 683 BOOLEAN IsFinal;\r
684 OFW_NODE Skip;\r
685\r
686 NumNodes = 0;\r
687 Status = ParseOfwNode (Ptr, &Node[NumNodes], &IsFinal);\r
688\r
689 if (Status == RETURN_NOT_FOUND) {\r
690 DEBUG ((DEBUG_VERBOSE, "%a: no more nodes\n", __FUNCTION__));\r
691 return RETURN_NOT_FOUND;\r
692 }\r
693\r
694 while (Status == RETURN_SUCCESS && !IsFinal) {\r
695 ++NumNodes;\r
696 Status = ParseOfwNode (\r
697 Ptr,\r
ec01afdb 698 (NumNodes < EXAMINED_OFW_NODES) ? &Node[NumNodes] : &Skip,\r
2cd086a6 699 &IsFinal\r
700 );\r
701 }\r
702\r
703 switch (Status) {\r
704 case RETURN_SUCCESS:\r
705 ++NumNodes;\r
706 break;\r
707\r
708 case RETURN_INVALID_PARAMETER:\r
709 DEBUG ((DEBUG_VERBOSE, "%a: parse error\n", __FUNCTION__));\r
710 return RETURN_INVALID_PARAMETER;\r
711\r
712 default:\r
713 ASSERT (0);\r
714 }\r
715\r
716 Status = TranslateOfwNodes (\r
717 Node,\r
ec01afdb 718 NumNodes < EXAMINED_OFW_NODES ? NumNodes : EXAMINED_OFW_NODES,\r
2cd086a6 719 Translated,\r
720 TranslatedSize);\r
721 switch (Status) {\r
722 case RETURN_SUCCESS:\r
723 DEBUG ((DEBUG_VERBOSE, "%a: success: \"%s\"\n", __FUNCTION__, Translated));\r
724 break;\r
725\r
726 case RETURN_BUFFER_TOO_SMALL:\r
727 DEBUG ((DEBUG_VERBOSE, "%a: buffer too small\n", __FUNCTION__));\r
728 break;\r
729\r
730 case RETURN_UNSUPPORTED:\r
731 DEBUG ((DEBUG_VERBOSE, "%a: unsupported\n", __FUNCTION__));\r
732 break;\r
733\r
734 default:\r
735 ASSERT (0);\r
736 }\r
737 return Status;\r
738}\r
739\r
740\r
741/**\r
742\r
743 Convert the UEFI DevicePath to full text representation with DevPathToText,\r
744 then match the UEFI device path fragment in Translated against it.\r
745\r
746 @param[in] Translated UEFI device path fragment, translated from\r
747 OpenFirmware format, to search for.\r
748\r
749 @param[in] TranslatedLength The length of Translated in CHAR16's.\r
750\r
751 @param[in] DevicePath Boot option device path whose textual rendering\r
752 to search in.\r
753\r
754 @param[in] DevPathToText Binary-to-text conversion protocol for DevicePath.\r
755\r
756\r
757 @retval TRUE If Translated was found at the beginning of DevicePath after\r
758 converting the latter to text.\r
759\r
760 @retval FALSE If DevicePath was NULL, or it could not be converted, or there\r
761 was no match.\r
762\r
763**/\r
764STATIC\r
765BOOLEAN\r
766Match (\r
767 IN CONST CHAR16 *Translated,\r
768 IN UINTN TranslatedLength,\r
769 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
770 IN CONST EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevPathToText\r
771 )\r
772{\r
773 CHAR16 *Converted;\r
774 BOOLEAN Result;\r
775\r
776 Converted = DevPathToText->ConvertDevicePathToText (\r
777 DevicePath,\r
778 FALSE, // DisplayOnly\r
779 FALSE // AllowShortcuts\r
780 );\r
781 if (Converted == NULL) {\r
782 return FALSE;\r
783 }\r
784\r
785 //\r
786 // Is Translated a prefix of Converted?\r
787 //\r
dccf7678 788 Result = (BOOLEAN)(StrnCmp (Converted, Translated, TranslatedLength) == 0);\r
2cd086a6 789 DEBUG ((\r
790 DEBUG_VERBOSE,\r
791 "%a: against \"%s\": %a\n",\r
792 __FUNCTION__,\r
793 Converted,\r
794 Result ? "match" : "no match"\r
795 ));\r
796 FreePool (Converted);\r
797 return Result;\r
798}\r
799\r
800\r
801/**\r
802\r
803 Set the boot order based on configuration retrieved from QEMU.\r
804\r
805 Attempt to retrieve the "bootorder" fw_cfg file from QEMU. Translate the\r
806 OpenFirmware device paths therein to UEFI device path fragments. Match the\r
807 translated fragments against BootOptionList, and rewrite the BootOrder NvVar\r
808 so that it corresponds to the order described in fw_cfg.\r
809\r
810 @param[in] BootOptionList A boot option list, created with\r
811 BdsLibEnumerateAllBootOption ().\r
812\r
813\r
814 @retval RETURN_SUCCESS BootOrder NvVar rewritten.\r
815\r
816 @retval RETURN_UNSUPPORTED QEMU's fw_cfg is not supported.\r
817\r
818 @retval RETURN_NOT_FOUND Empty or nonexistent "bootorder" fw_cfg\r
819 file, or no match found between the\r
820 "bootorder" fw_cfg file and BootOptionList.\r
821\r
822 @retval RETURN_INVALID_PARAMETER Parse error in the "bootorder" fw_cfg file.\r
823\r
824 @retval RETURN_OUT_OF_RESOURCES Memory allocation failed.\r
825\r
826 @return Values returned by gBS->LocateProtocol ()\r
827 or gRT->SetVariable ().\r
828\r
829**/\r
830RETURN_STATUS\r
831SetBootOrderFromQemu (\r
832 IN CONST LIST_ENTRY *BootOptionList\r
833 )\r
834{\r
835 RETURN_STATUS Status;\r
836\r
837 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevPathToText;\r
838\r
839 FIRMWARE_CONFIG_ITEM FwCfgItem;\r
840 UINTN FwCfgSize;\r
841 CHAR8 *FwCfg;\r
842 CONST CHAR8 *FwCfgPtr;\r
843\r
844 BOOT_ORDER BootOrder;\r
845\r
846 UINTN TranslatedSize;\r
847 CHAR16 Translated[TRANSLATION_OUTPUT_SIZE];\r
848\r
849 Status = gBS->LocateProtocol (\r
850 &gEfiDevicePathToTextProtocolGuid,\r
851 NULL, // optional registration key\r
852 (VOID **) &DevPathToText\r
853 );\r
854 if (Status != EFI_SUCCESS) {\r
855 return Status;\r
856 }\r
857\r
858 Status = QemuFwCfgFindFile ("bootorder", &FwCfgItem, &FwCfgSize);\r
859 if (Status != RETURN_SUCCESS) {\r
860 return Status;\r
861 }\r
862\r
863 if (FwCfgSize == 0) {\r
864 return RETURN_NOT_FOUND;\r
865 }\r
866\r
867 FwCfg = AllocatePool (FwCfgSize);\r
868 if (FwCfg == NULL) {\r
869 return RETURN_OUT_OF_RESOURCES;\r
870 }\r
871\r
872 QemuFwCfgSelectItem (FwCfgItem);\r
873 QemuFwCfgReadBytes (FwCfgSize, FwCfg);\r
874 if (FwCfg[FwCfgSize - 1] != '\0') {\r
875 Status = RETURN_INVALID_PARAMETER;\r
876 goto ErrorFreeFwCfg;\r
877 }\r
878\r
879 DEBUG ((DEBUG_VERBOSE, "%a: FwCfg:\n", __FUNCTION__));\r
880 DEBUG ((DEBUG_VERBOSE, "%a\n", FwCfg));\r
881 DEBUG ((DEBUG_VERBOSE, "%a: FwCfg: <end>\n", __FUNCTION__));\r
882 FwCfgPtr = FwCfg;\r
883\r
884 BootOrder.Produced = 0;\r
885 BootOrder.Allocated = 1;\r
886 BootOrder.Data = AllocatePool (\r
887 BootOrder.Allocated * sizeof (*BootOrder.Data)\r
888 );\r
889 if (BootOrder.Data == NULL) {\r
890 Status = RETURN_OUT_OF_RESOURCES;\r
891 goto ErrorFreeFwCfg;\r
892 }\r
893\r
894 //\r
895 // translate each OpenFirmware path\r
896 //\r
897 TranslatedSize = sizeof (Translated) / sizeof (Translated[0]);\r
898 Status = TranslateOfwPath (&FwCfgPtr, Translated, &TranslatedSize);\r
899 while (Status == RETURN_SUCCESS ||\r
900 Status == RETURN_UNSUPPORTED ||\r
901 Status == RETURN_BUFFER_TOO_SMALL) {\r
902 if (Status == RETURN_SUCCESS) {\r
903 CONST LIST_ENTRY *Link;\r
904\r
905 //\r
906 // match translated OpenFirmware path against all enumerated boot options\r
907 //\r
908 for (Link = BootOptionList->ForwardLink; Link != BootOptionList;\r
909 Link = Link->ForwardLink) {\r
910 CONST BDS_COMMON_OPTION *BootOption;\r
911\r
912 BootOption = CR (\r
913 Link,\r
914 BDS_COMMON_OPTION,\r
915 Link,\r
916 BDS_LOAD_OPTION_SIGNATURE\r
917 );\r
918 if (IS_LOAD_OPTION_TYPE (BootOption->Attribute, LOAD_OPTION_ACTIVE) &&\r
919 Match (\r
920 Translated,\r
921 TranslatedSize, // contains length, not size, in CHAR16's here\r
922 BootOption->DevicePath,\r
923 DevPathToText\r
924 )\r
925 ) {\r
926 //\r
927 // match found, store ID and continue with next OpenFirmware path\r
928 //\r
929 Status = BootOrderAppend (&BootOrder, BootOption->BootCurrent);\r
930 if (Status != RETURN_SUCCESS) {\r
931 goto ErrorFreeBootOrder;\r
932 }\r
933 break;\r
934 }\r
935 } // scanned all enumerated boot options\r
936 } // translation successful\r
937\r
938 TranslatedSize = sizeof (Translated) / sizeof (Translated[0]);\r
939 Status = TranslateOfwPath (&FwCfgPtr, Translated, &TranslatedSize);\r
940 } // scanning of OpenFirmware paths done\r
941\r
942 if (Status == RETURN_NOT_FOUND && BootOrder.Produced > 0) {\r
943 //\r
944 // No more OpenFirmware paths, some matches found: rewrite BootOrder NvVar.\r
945 // See Table 10 in the UEFI Spec 2.3.1 with Errata C for the required\r
946 // attributes.\r
947 //\r
948 Status = gRT->SetVariable (\r
949 L"BootOrder",\r
950 &gEfiGlobalVariableGuid,\r
951 EFI_VARIABLE_NON_VOLATILE |\r
952 EFI_VARIABLE_BOOTSERVICE_ACCESS |\r
953 EFI_VARIABLE_RUNTIME_ACCESS,\r
954 BootOrder.Produced * sizeof (*BootOrder.Data),\r
955 BootOrder.Data\r
956 );\r
957 DEBUG ((\r
958 DEBUG_INFO,\r
959 "%a: setting BootOrder: %a\n",\r
960 __FUNCTION__,\r
961 Status == EFI_SUCCESS ? "success" : "error"\r
962 ));\r
963 }\r
964\r
965ErrorFreeBootOrder:\r
966 FreePool (BootOrder.Data);\r
967\r
968ErrorFreeFwCfg:\r
969 FreePool (FwCfg);\r
970\r
971 return Status;\r
972}\r
EFI Development Kit II mirror for PVE