]>
Commit | Line | Data |
---|---|---|
93e3992d | 1 | /*++\r |
2 | \r | |
d1d249a7 | 3 | Copyright (c) 2004 - 2008, Intel Corporation \r |
93e3992d | 4 | All rights reserved. This program and the accompanying materials \r |
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 | GenericBdsLib.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Generic BDS library definition, include the file and data structure\r | |
19 | \r | |
20 | --*/\r | |
21 | \r | |
22 | #ifndef _GENERIC_BDS_LIB_H_\r | |
23 | #define _GENERIC_BDS_LIB_H_\r | |
24 | \r | |
93e3992d | 25 | #include <PiDxe.h>\r |
26 | #include <Protocol/HiiDatabase.h>\r | |
27 | #include <IndustryStandard/PeImage.h>\r | |
28 | \r | |
29 | \r | |
30 | extern EFI_HANDLE mBdsImageHandle;\r | |
31 | \r | |
32 | //\r | |
33 | // Constants which are variable names used to access variables\r | |
34 | //\r | |
35 | #define VarLegacyDevOrder L"LegacyDevOrder"\r | |
36 | \r | |
37 | //\r | |
38 | // Data structures and defines\r | |
39 | //\r | |
40 | #define FRONT_PAGE_QUESTION_ID 0x0000\r | |
41 | #define FRONT_PAGE_DATA_WIDTH 0x01\r | |
42 | \r | |
43 | //\r | |
44 | // ConnectType\r | |
45 | //\r | |
46 | #define CONSOLE_OUT 0x00000001\r | |
47 | #define STD_ERROR 0x00000002\r | |
48 | #define CONSOLE_IN 0x00000004\r | |
49 | #define CONSOLE_ALL (CONSOLE_OUT | CONSOLE_IN | STD_ERROR)\r | |
50 | \r | |
51 | //\r | |
52 | // Load Option Attributes defined in EFI Specification\r | |
53 | //\r | |
54 | #define LOAD_OPTION_ACTIVE 0x00000001\r | |
55 | #define LOAD_OPTION_FORCE_RECONNECT 0x00000002\r | |
56 | \r | |
93e3992d | 57 | #define LOAD_OPTION_HIDDEN 0x00000008\r |
58 | #define LOAD_OPTION_CATEGORY 0x00001F00\r | |
59 | \r | |
60 | #define LOAD_OPTION_CATEGORY_BOOT 0x00000000\r | |
61 | #define LOAD_OPTION_CATEGORY_APP 0x00000100\r | |
62 | \r | |
63 | #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001\r | |
64 | #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002\r | |
93e3992d | 65 | \r |
66 | #define IS_LOAD_OPTION_TYPE(_c, _Mask) (BOOLEAN) (((_c) & (_Mask)) != 0)\r | |
67 | \r | |
68 | //\r | |
69 | // Define Maxmim characters that will be accepted\r | |
70 | //\r | |
71 | #define MAX_CHAR 480\r | |
72 | #define MAX_CHAR_SIZE (MAX_CHAR * 2)\r | |
73 | \r | |
74 | #define MIN_ALIGNMENT_SIZE 4\r | |
75 | #define ALIGN_SIZE(a) ((a % MIN_ALIGNMENT_SIZE) ? MIN_ALIGNMENT_SIZE - (a % MIN_ALIGNMENT_SIZE) : 0)\r | |
76 | \r | |
77 | //\r | |
78 | // Define maximum characters for boot option variable "BootXXXX"\r | |
79 | //\r | |
80 | #define BOOT_OPTION_MAX_CHAR 10\r | |
81 | \r | |
82 | //\r | |
83 | // This data structure is the part of BDS_CONNECT_ENTRY that we can hard code.\r | |
84 | //\r | |
85 | #define BDS_LOAD_OPTION_SIGNATURE EFI_SIGNATURE_32 ('B', 'd', 'C', 'O')\r | |
86 | \r | |
87 | typedef struct {\r | |
88 | \r | |
89 | UINTN Signature;\r | |
90 | LIST_ENTRY Link;\r | |
91 | \r | |
92 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
93 | \r | |
94 | CHAR16 *OptionName;\r | |
95 | UINTN OptionNumber;\r | |
96 | UINT16 BootCurrent;\r | |
97 | UINT32 Attribute;\r | |
98 | CHAR16 *Description;\r | |
99 | VOID *LoadOptions;\r | |
100 | UINT32 LoadOptionsSize;\r | |
101 | CHAR16 *StatusString;\r | |
102 | \r | |
103 | } BDS_COMMON_OPTION;\r | |
104 | \r | |
105 | typedef struct {\r | |
106 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
107 | UINTN ConnectType;\r | |
108 | } BDS_CONSOLE_CONNECT_ENTRY;\r | |
109 | \r | |
110 | //\r | |
111 | // Lib Functions\r | |
112 | //\r | |
113 | \r | |
114 | //\r | |
115 | // Bds boot relate lib functions\r | |
116 | //\r | |
117 | EFI_STATUS\r | |
118 | BdsLibUpdateBootOrderList (\r | |
119 | IN LIST_ENTRY *BdsOptionList,\r | |
120 | IN CHAR16 *VariableName\r | |
121 | );\r | |
122 | \r | |
123 | VOID\r | |
124 | BdsLibBootNext (\r | |
125 | VOID\r | |
126 | );\r | |
127 | \r | |
128 | EFI_STATUS\r | |
129 | BdsLibBootViaBootOption (\r | |
130 | IN BDS_COMMON_OPTION * Option,\r | |
131 | IN EFI_DEVICE_PATH_PROTOCOL * DevicePath,\r | |
132 | OUT UINTN *ExitDataSize,\r | |
133 | OUT CHAR16 **ExitData OPTIONAL\r | |
134 | );\r | |
135 | \r | |
136 | EFI_STATUS\r | |
137 | BdsLibEnumerateAllBootOption (\r | |
138 | IN OUT LIST_ENTRY *BdsBootOptionList\r | |
139 | );\r | |
140 | \r | |
141 | VOID\r | |
142 | BdsLibBuildOptionFromHandle (\r | |
143 | IN EFI_HANDLE Handle,\r | |
144 | IN LIST_ENTRY *BdsBootOptionList,\r | |
145 | IN CHAR16 *String\r | |
146 | );\r | |
147 | \r | |
148 | VOID\r | |
149 | BdsLibBuildOptionFromShell (\r | |
150 | IN EFI_HANDLE Handle,\r | |
151 | IN LIST_ENTRY *BdsBootOptionList\r | |
152 | );\r | |
153 | \r | |
154 | //\r | |
155 | // Bds misc lib functions\r | |
156 | //\r | |
157 | UINT16\r | |
158 | BdsLibGetTimeout (\r | |
159 | VOID\r | |
160 | );\r | |
161 | \r | |
162 | EFI_STATUS\r | |
163 | BdsLibGetBootMode (\r | |
164 | OUT EFI_BOOT_MODE *BootMode\r | |
165 | );\r | |
166 | \r | |
167 | VOID\r | |
168 | BdsLibLoadDrivers (\r | |
169 | IN LIST_ENTRY *BdsDriverLists\r | |
170 | );\r | |
171 | \r | |
172 | EFI_STATUS\r | |
173 | BdsLibBuildOptionFromVar (\r | |
174 | IN LIST_ENTRY *BdsCommonOptionList,\r | |
175 | IN CHAR16 *VariableName\r | |
176 | );\r | |
177 | \r | |
178 | VOID *\r | |
179 | BdsLibGetVariableAndSize (\r | |
180 | IN CHAR16 *Name,\r | |
181 | IN EFI_GUID *VendorGuid,\r | |
182 | OUT UINTN *VariableSize\r | |
183 | );\r | |
184 | \r | |
185 | EFI_STATUS\r | |
186 | BdsLibOutputStrings (\r | |
187 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut,\r | |
188 | ...\r | |
189 | );\r | |
190 | \r | |
191 | BDS_COMMON_OPTION *\r | |
192 | BdsLibVariableToOption (\r | |
193 | IN OUT LIST_ENTRY *BdsCommonOptionList,\r | |
194 | IN CHAR16 *VariableName\r | |
195 | );\r | |
196 | \r | |
197 | EFI_STATUS\r | |
198 | BdsLibRegisterNewOption (\r | |
199 | IN LIST_ENTRY *BdsOptionList,\r | |
200 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
201 | IN CHAR16 *String,\r | |
202 | IN CHAR16 *VariableName\r | |
203 | );\r | |
204 | \r | |
205 | //\r | |
206 | // Bds connect or disconnect driver lib funcion\r | |
207 | //\r | |
208 | VOID\r | |
209 | BdsLibConnectAllDriversToAllControllers (\r | |
210 | VOID\r | |
211 | );\r | |
212 | \r | |
213 | VOID\r | |
214 | BdsLibConnectAll (\r | |
215 | VOID\r | |
216 | );\r | |
217 | \r | |
218 | EFI_STATUS\r | |
219 | BdsLibConnectDevicePath (\r | |
220 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePathToConnect\r | |
221 | );\r | |
222 | \r | |
223 | EFI_STATUS\r | |
224 | BdsLibConnectAllEfi (\r | |
225 | VOID\r | |
226 | );\r | |
227 | \r | |
228 | EFI_STATUS\r | |
229 | BdsLibDisconnectAllEfi (\r | |
230 | VOID\r | |
231 | );\r | |
232 | \r | |
233 | //\r | |
234 | // Bds console relate lib functions\r | |
235 | //\r | |
236 | VOID\r | |
237 | BdsLibConnectAllConsoles (\r | |
238 | VOID\r | |
239 | );\r | |
240 | \r | |
241 | EFI_STATUS\r | |
242 | BdsLibConnectAllDefaultConsoles (\r | |
243 | VOID\r | |
244 | );\r | |
245 | \r | |
246 | EFI_STATUS\r | |
247 | BdsLibUpdateConsoleVariable (\r | |
248 | IN CHAR16 *ConVarName,\r | |
249 | IN EFI_DEVICE_PATH_PROTOCOL *CustomizedConDevicePath,\r | |
250 | IN EFI_DEVICE_PATH_PROTOCOL *ExclusiveDevicePath\r | |
251 | );\r | |
252 | \r | |
253 | EFI_STATUS\r | |
254 | BdsLibConnectConsoleVariable (\r | |
255 | IN CHAR16 *ConVarName\r | |
256 | );\r | |
257 | \r | |
258 | //\r | |
259 | // Bds device path relate lib functions\r | |
260 | //\r | |
261 | EFI_DEVICE_PATH_PROTOCOL *\r | |
262 | BdsLibUnpackDevicePath (\r | |
263 | IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r | |
264 | );\r | |
265 | \r | |
266 | EFI_DEVICE_PATH_PROTOCOL *\r | |
267 | BdsLibDelPartMatchInstance (\r | |
268 | IN EFI_DEVICE_PATH_PROTOCOL *Multi,\r | |
269 | IN EFI_DEVICE_PATH_PROTOCOL *Single\r | |
270 | );\r | |
271 | \r | |
272 | BOOLEAN\r | |
273 | BdsLibMatchDevicePaths (\r | |
274 | IN EFI_DEVICE_PATH_PROTOCOL *Multi,\r | |
275 | IN EFI_DEVICE_PATH_PROTOCOL *Single\r | |
276 | );\r | |
277 | \r | |
278 | CHAR16 *\r | |
279 | DevicePathToStr (\r | |
280 | EFI_DEVICE_PATH_PROTOCOL *DevPath\r | |
281 | );\r | |
282 | \r | |
283 | VOID *\r | |
284 | EfiLibGetVariable (\r | |
285 | IN CHAR16 *Name,\r | |
286 | IN EFI_GUID *VendorGuid\r | |
287 | );\r | |
288 | \r | |
289 | //\r | |
290 | // Internal definitions\r | |
291 | //\r | |
292 | typedef struct {\r | |
293 | CHAR16 *str;\r | |
294 | UINTN len;\r | |
295 | UINTN maxlen;\r | |
296 | } POOL_PRINT;\r | |
297 | \r | |
298 | typedef struct {\r | |
299 | UINT8 Type;\r | |
300 | UINT8 SubType;\r | |
301 | VOID (*Function) (POOL_PRINT *, VOID *);\r | |
302 | } DEVICE_PATH_STRING_TABLE;\r | |
303 | \r | |
304 | extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid;\r | |
305 | \r | |
306 | typedef struct {\r | |
307 | EFI_DEVICE_PATH_PROTOCOL Header;\r | |
308 | EFI_GUID Guid;\r | |
309 | UINT8 VendorDefinedData[1];\r | |
310 | } VENDOR_DEVICE_PATH_WITH_DATA;\r | |
311 | \r | |
93e3992d | 312 | \r |
313 | extern EFI_GUID mEfiDevicePathMessagingSASGuid;\r | |
314 | \r | |
315 | typedef struct {\r | |
316 | EFI_DEVICE_PATH_PROTOCOL Header;\r | |
317 | UINT16 NetworkProtocol;\r | |
318 | UINT16 LoginOption;\r | |
319 | UINT64 Lun;\r | |
320 | UINT16 TargetPortalGroupTag;\r | |
321 | CHAR16 iSCSITargetName[1];\r | |
322 | } ISCSI_DEVICE_PATH_WITH_NAME;\r | |
323 | \r | |
93e3992d | 324 | \r |
325 | //\r | |
326 | // Internal functions\r | |
327 | //\r | |
328 | EFI_STATUS\r | |
329 | BdsBootByDiskSignatureAndPartition (\r | |
330 | IN BDS_COMMON_OPTION * Option,\r | |
331 | IN HARDDRIVE_DEVICE_PATH * HardDriveDevicePath,\r | |
332 | IN UINT32 LoadOptionsSize,\r | |
333 | IN VOID *LoadOptions,\r | |
334 | OUT UINTN *ExitDataSize,\r | |
335 | OUT CHAR16 **ExitData OPTIONAL\r | |
336 | );\r | |
337 | \r | |
338 | //\r | |
339 | // Notes: EFI 64 shadow all option rom\r | |
340 | //\r | |
341 | #if defined (MDE_CPU_IPF)\r | |
342 | #define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();\r | |
343 | VOID\r | |
344 | ShadowAllOptionRom();\r | |
345 | #else\r | |
346 | #define EFI64_SHADOW_ALL_LEGACY_ROM()\r | |
347 | #endif\r | |
348 | \r | |
349 | //\r | |
350 | // BBS support macros and functions\r | |
351 | //\r | |
352 | \r | |
353 | #if defined(MDE_CPU_IA32) || defined(MDE_CPU_X64)\r | |
354 | #define REFRESH_LEGACY_BOOT_OPTIONS \\r | |
355 | BdsDeleteAllInvalidLegacyBootOptions ();\\r | |
356 | BdsAddNonExistingLegacyBootOptions (); \\r | |
357 | BdsUpdateLegacyDevOrder ()\r | |
358 | #else\r | |
359 | #define REFRESH_LEGACY_BOOT_OPTIONS\r | |
360 | #endif\r | |
361 | \r | |
362 | EFI_STATUS\r | |
363 | BdsDeleteAllInvalidLegacyBootOptions (\r | |
364 | VOID\r | |
365 | );\r | |
366 | \r | |
367 | EFI_STATUS\r | |
368 | BdsAddNonExistingLegacyBootOptions (\r | |
369 | VOID\r | |
370 | );\r | |
371 | \r | |
372 | EFI_STATUS\r | |
373 | BdsUpdateLegacyDevOrder (\r | |
374 | VOID\r | |
375 | );\r | |
376 | \r | |
377 | EFI_STATUS\r | |
378 | BdsRefreshBbsTableForBoot (\r | |
379 | IN BDS_COMMON_OPTION *Entry\r | |
380 | );\r | |
381 | \r | |
382 | EFI_STATUS\r | |
383 | BdsDeleteBootOption (\r | |
384 | IN UINTN OptionNumber,\r | |
385 | IN OUT UINT16 *BootOrder,\r | |
386 | IN OUT UINTN *BootOrderSize\r | |
387 | );\r | |
388 | \r | |
389 | //\r | |
390 | //The interface functions relate with Setup Browser Reset Reminder feature\r | |
391 | //\r | |
392 | VOID\r | |
393 | EnableResetReminderFeature (\r | |
394 | VOID\r | |
395 | );\r | |
396 | \r | |
397 | VOID\r | |
398 | DisableResetReminderFeature (\r | |
399 | VOID\r | |
400 | );\r | |
401 | \r | |
402 | VOID\r | |
403 | EnableResetRequired (\r | |
404 | VOID\r | |
405 | );\r | |
406 | \r | |
407 | VOID\r | |
408 | DisableResetRequired (\r | |
409 | VOID\r | |
410 | );\r | |
411 | \r | |
412 | BOOLEAN\r | |
413 | IsResetReminderFeatureEnable (\r | |
414 | VOID\r | |
415 | );\r | |
416 | \r | |
417 | BOOLEAN\r | |
418 | IsResetRequired (\r | |
419 | VOID\r | |
420 | );\r | |
421 | \r | |
422 | VOID\r | |
423 | SetupResetReminder (\r | |
424 | VOID\r | |
425 | );\r | |
426 | \r | |
427 | EFI_STATUS\r | |
428 | BdsLibGetImageHeader (\r | |
429 | IN EFI_HANDLE Device,\r | |
430 | IN CHAR16 *FileName,\r | |
431 | OUT EFI_IMAGE_DOS_HEADER *DosHeader,\r | |
432 | OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr\r | |
433 | )\r | |
434 | ;\r | |
435 | \r | |
436 | EFI_STATUS\r | |
437 | BdsLibGetHiiHandles (\r | |
93e3992d | 438 | IN EFI_HII_DATABASE_PROTOCOL *HiiDatabase,\r |
93e3992d | 439 | IN OUT UINT16 *HandleBufferLength,\r |
440 | OUT EFI_HII_HANDLE **HiiHandleBuffer\r | |
441 | );\r | |
442 | \r | |
443 | //\r | |
444 | // Define the boot type which to classify the boot option type\r | |
445 | // Different boot option type could have different boot behavior\r | |
446 | // Use their device path node (Type + SubType) as type value\r | |
447 | // The boot type here can be added according to requirement\r | |
448 | //\r | |
449 | //\r | |
450 | // ACPI boot type. For ACPI device, cannot use sub-type to distinguish device, so hardcode their value\r | |
451 | //\r | |
452 | #define BDS_EFI_ACPI_FLOPPY_BOOT 0x0201\r | |
453 | //\r | |
454 | // Message boot type\r | |
455 | // If a device path of boot option only point to a message node, the boot option is message boot type\r | |
456 | //\r | |
457 | #define BDS_EFI_MESSAGE_ATAPI_BOOT 0x0301 // Type 03; Sub-Type 01\r | |
458 | #define BDS_EFI_MESSAGE_SCSI_BOOT 0x0302 // Type 03; Sub-Type 02\r | |
459 | #define BDS_EFI_MESSAGE_USB_DEVICE_BOOT 0x0305 // Type 03; Sub-Type 05\r | |
460 | #define BDS_EFI_MESSAGE_MISC_BOOT 0x03FF\r | |
461 | //\r | |
462 | // Media boot type\r | |
463 | // If a device path of boot option contain a media node, the boot option is media boot type\r | |
464 | //\r | |
465 | #define BDS_EFI_MEDIA_HD_BOOT 0x0401 // Type 04; Sub-Type 01\r | |
466 | #define BDS_EFI_MEDIA_CDROM_BOOT 0x0402 // Type 04; Sub-Type 02\r | |
467 | //\r | |
468 | // BBS boot type\r | |
469 | // If a device path of boot option contain a BBS node, the boot option is BBS boot type\r | |
470 | //\r | |
471 | #define BDS_LEGACY_BBS_BOOT 0x0501 // Type 05; Sub-Type 01\r | |
472 | \r | |
473 | #define BDS_EFI_UNSUPPORT 0xFFFF\r | |
474 | \r | |
475 | //\r | |
476 | // USB host controller Programming Interface.\r | |
477 | //\r | |
478 | #define PCI_CLASSC_PI_UHCI 0x00\r | |
479 | #define PCI_CLASSC_PI_EHCI 0x20\r | |
480 | \r | |
481 | BOOLEAN\r | |
482 | MatchPartitionDevicePathNode (\r | |
483 | IN EFI_DEVICE_PATH_PROTOCOL *BlockIoDevicePath,\r | |
484 | IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath\r | |
485 | );\r | |
486 | \r | |
487 | EFI_DEVICE_PATH_PROTOCOL *\r | |
488 | BdsExpandPartitionPartialDevicePathToFull (\r | |
489 | IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath\r | |
490 | );\r | |
491 | \r | |
492 | EFI_HANDLE\r | |
493 | BdsLibGetBootableHandle (\r | |
494 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
495 | );\r | |
496 | \r | |
497 | BOOLEAN\r | |
498 | BdsLibIsValidEFIBootOptDevicePath (\r | |
499 | IN EFI_DEVICE_PATH_PROTOCOL *DevPath,\r | |
500 | IN BOOLEAN CheckMedia\r | |
501 | );\r | |
502 | \r | |
503 | UINT32\r | |
504 | BdsGetBootTypeFromDevicePath (\r | |
505 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
506 | );\r | |
507 | \r | |
508 | VOID\r | |
509 | EFIAPI\r | |
510 | BdsLibSaveMemoryTypeInformation (\r | |
511 | VOID \r | |
512 | );\r | |
513 | \r | |
514 | EFI_STATUS\r | |
515 | EFIAPI\r | |
516 | BdsLibUpdateFvFileDevicePath (\r | |
517 | IN OUT EFI_DEVICE_PATH_PROTOCOL ** DevicePath,\r | |
518 | IN EFI_GUID *FileGuid\r | |
519 | );\r | |
520 | \r | |
521 | EFI_STATUS\r | |
522 | BdsLibConnectUsbDevByShortFormDP (\r | |
25ca163d | 523 | IN UINT8 HostControllerPI,\r |
93e3992d | 524 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r |
525 | );\r | |
526 | \r | |
527 | EFI_TPL\r | |
528 | BdsLibGetCurrentTpl (\r | |
529 | VOID\r | |
530 | );\r | |
531 | \r | |
532 | //\r | |
533 | // The implementation of this function is provided by Platform code.\r | |
534 | //\r | |
535 | VOID\r | |
536 | DevPathVendor (\r | |
537 | IN OUT POOL_PRINT *Str,\r | |
538 | IN VOID *DevPath\r | |
539 | )\r | |
540 | ;\r | |
541 | \r | |
542 | CHAR16 *\r | |
543 | CatPrint (\r | |
544 | IN OUT POOL_PRINT *Str,\r | |
545 | IN CHAR16 *fmt,\r | |
546 | ...\r | |
547 | )\r | |
548 | ;\r | |
d1d249a7 | 549 | #endif\r |
550 | \r |