| | 1 | /** @file\r |
| | 2 | Generic BDS library defines general interfaces for a BDS driver, including:\r |
| | 3 | 1) BDS boot policy interface.\r |
| | 4 | 2) BDS boot device connect interface.\r |
| | 5 | 3) BDS Misc interfaces for mainting boot variable, ouput string.\r |
| | 6 | \r |
| | 7 | Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>\r |
| | 8 | This program and the accompanying materials are licensed and made available under \r |
| | 9 | the terms and conditions of the BSD License that accompanies this distribution. \r |
| | 10 | The full text of the license may be found at\r |
| | 11 | http://opensource.org/licenses/bsd-license.php. \r |
| | 12 | \r |
| | 13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
| | 14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
| | 15 | \r |
| | 16 | **/\r |
| | 17 | \r |
| | 18 | #ifndef _GENERIC_BDS_LIB_H_\r |
| | 19 | #define _GENERIC_BDS_LIB_H_\r |
| | 20 | \r |
| | 21 | #include <Protocol/UserManager.h>\r |
| | 22 | \r |
| | 23 | ///\r |
| | 24 | /// Constants which are variable names used to access variables.\r |
| | 25 | ///\r |
| | 26 | #define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"\r |
| | 27 | \r |
| | 28 | ///\r |
| | 29 | /// Data structures and defines.\r |
| | 30 | ///\r |
| | 31 | #define FRONT_PAGE_QUESTION_ID 0x0000\r |
| | 32 | #define FRONT_PAGE_DATA_WIDTH 0x01\r |
| | 33 | \r |
| | 34 | ///\r |
| | 35 | /// ConnectType\r |
| | 36 | ///\r |
| | 37 | #define CONSOLE_OUT 0x00000001\r |
| | 38 | #define STD_ERROR 0x00000002\r |
| | 39 | #define CONSOLE_IN 0x00000004\r |
| | 40 | #define CONSOLE_ALL (CONSOLE_OUT | CONSOLE_IN | STD_ERROR)\r |
| | 41 | \r |
| | 42 | ///\r |
| | 43 | /// Load Option Attributes\r |
| | 44 | ///\r |
| | 45 | #define LOAD_OPTION_ACTIVE 0x00000001\r |
| | 46 | #define LOAD_OPTION_FORCE_RECONNECT 0x00000002\r |
| | 47 | \r |
| | 48 | #define LOAD_OPTION_HIDDEN 0x00000008\r |
| | 49 | #define LOAD_OPTION_CATEGORY 0x00001F00\r |
| | 50 | \r |
| | 51 | #define LOAD_OPTION_CATEGORY_BOOT 0x00000000\r |
| | 52 | #define LOAD_OPTION_CATEGORY_APP 0x00000100\r |
| | 53 | \r |
| | 54 | #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001\r |
| | 55 | #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002\r |
| | 56 | \r |
| | 57 | #define IS_LOAD_OPTION_TYPE(_c, _Mask) (BOOLEAN) (((_c) & (_Mask)) != 0)\r |
| | 58 | \r |
| | 59 | ///\r |
| | 60 | /// Define the maximum characters that will be accepted.\r |
| | 61 | ///\r |
| | 62 | #define MAX_CHAR 480\r |
| | 63 | #define MAX_CHAR_SIZE (MAX_CHAR * 2)\r |
| | 64 | \r |
| | 65 | ///\r |
| | 66 | /// Define maximum characters for boot option variable "BootXXXX".\r |
| | 67 | ///\r |
| | 68 | #define BOOT_OPTION_MAX_CHAR 10\r |
| | 69 | \r |
| | 70 | //\r |
| | 71 | // This data structure is the part of BDS_CONNECT_ENTRY\r |
| | 72 | //\r |
| | 73 | #define BDS_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('B', 'd', 'C', 'O')\r |
| | 74 | \r |
| | 75 | typedef struct {\r |
| | 76 | \r |
| | 77 | UINTN Signature;\r |
| | 78 | LIST_ENTRY Link;\r |
| | 79 | \r |
| | 80 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r |
| | 81 | \r |
| | 82 | CHAR16 *OptionName;\r |
| | 83 | UINTN OptionNumber;\r |
| | 84 | UINT16 BootCurrent;\r |
| | 85 | UINT32 Attribute;\r |
| | 86 | CHAR16 *Description;\r |
| | 87 | VOID *LoadOptions;\r |
| | 88 | UINT32 LoadOptionsSize;\r |
| | 89 | CHAR16 *StatusString;\r |
| | 90 | \r |
| | 91 | } BDS_COMMON_OPTION;\r |
| | 92 | \r |
| | 93 | typedef struct {\r |
| | 94 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r |
| | 95 | UINTN ConnectType;\r |
| | 96 | } BDS_CONSOLE_CONNECT_ENTRY;\r |
| | 97 | \r |
| | 98 | //\r |
| | 99 | // Bds boot related lib functions\r |
| | 100 | //\r |
| | 101 | /**\r |
| | 102 | Boot from the UEFI spec defined "BootNext" variable.\r |
| | 103 | \r |
| | 104 | **/\r |
| | 105 | VOID\r |
| | 106 | EFIAPI\r |
| | 107 | BdsLibBootNext (\r |
| | 108 | VOID\r |
| | 109 | );\r |
| | 110 | \r |
| | 111 | /**\r |
| | 112 | Process the boot option according to the UEFI specification. The legacy boot option device path includes BBS_DEVICE_PATH.\r |
| | 113 | \r |
| | 114 | @param Option The boot option to be processed.\r |
| | 115 | @param DevicePath The device path describing where to load the\r |
| | 116 | boot image or the legcy BBS device path to boot\r |
| | 117 | the legacy OS.\r |
| | 118 | @param ExitDataSize The size of exit data.\r |
| | 119 | @param ExitData Data returned when Boot image failed.\r |
| | 120 | \r |
| | 121 | @retval EFI_SUCCESS Boot from the input boot option succeeded.\r |
| | 122 | @retval EFI_NOT_FOUND The Device Path is not found in the system.\r |
| | 123 | \r |
| | 124 | **/\r |
| | 125 | EFI_STATUS\r |
| | 126 | EFIAPI\r |
| | 127 | BdsLibBootViaBootOption (\r |
| | 128 | IN BDS_COMMON_OPTION * Option,\r |
| | 129 | IN EFI_DEVICE_PATH_PROTOCOL * DevicePath,\r |
| | 130 | OUT UINTN *ExitDataSize,\r |
| | 131 | OUT CHAR16 **ExitData OPTIONAL\r |
| | 132 | );\r |
| | 133 | \r |
| | 134 | \r |
| | 135 | /**\r |
| | 136 | This function will enumerate all possible boot devices in the system, and\r |
| | 137 | automatically create boot options for Network, Shell, Removable BlockIo, \r |
| | 138 | and Non-BlockIo Simplefile devices. \r |
| | 139 | \r |
| | 140 | BDS separates EFI boot options into six types:\r |
| | 141 | 1. Network - The boot option points to the SimpleNetworkProtocol device. \r |
| | 142 | Bds will try to automatically create this type of boot option during enumeration.\r |
| | 143 | 2. Shell - The boot option points to internal flash shell. \r |
| | 144 | Bds will try to automatically create this type of boot option during enumeration.\r |
| | 145 | 3. Removable BlockIo - The boot option points to a removable media\r |
| | 146 | device, such as a USB flash drive or DVD drive.\r |
| | 147 | These devices should contain a *removable* blockIo\r |
| | 148 | protocol in their device handle.\r |
| | 149 | Bds will try to automatically create this type boot option \r |
| | 150 | when enumerate.\r |
| | 151 | 4. Fixed BlockIo - The boot option points to a Fixed blockIo device, \r |
| | 152 | such as a hard disk.\r |
| | 153 | These devices should contain a *fixed* blockIo\r |
| | 154 | protocol in their device handle.\r |
| | 155 | BDS will skip fixed blockIo devices, and not\r |
| | 156 | automatically create boot option for them. But BDS \r |
| | 157 | will help to delete those fixed blockIo boot options, \r |
| | 158 | whose description rules conflict with other auto-created\r |
| | 159 | boot options.\r |
| | 160 | 5. Non-BlockIo Simplefile - The boot option points to a device whose handle \r |
| | 161 | has SimpleFileSystem Protocol, but has no blockio\r |
| | 162 | protocol. These devices do not offer blockIo\r |
| | 163 | protocol, but BDS still can get the \r |
| | 164 | \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem\r |
| | 165 | Protocol.\r |
| | 166 | 6. File - The boot option points to a file. These boot options are usually \r |
| | 167 | created by the user, either manually or with an OS loader. BDS will not delete or modify\r |
| | 168 | these boot options. \r |
| | 169 | \r |
| | 170 | This function will enumerate all possible boot devices in the system, and\r |
| | 171 | automatically create boot options for Network, Shell, Removable BlockIo, \r |
| | 172 | and Non-BlockIo Simplefile devices.\r |
| | 173 | It will execute once every boot.\r |
| | 174 | \r |
| | 175 | @param BdsBootOptionList The header of the linked list that indexed all\r |
| | 176 | current boot options.\r |
| | 177 | \r |
| | 178 | @retval EFI_SUCCESS Finished all the boot device enumerations and \r |
| | 179 | created the boot option based on the boot device.\r |
| | 180 | \r |
| | 181 | @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create \r |
| | 182 | the boot option list.\r |
| | 183 | **/\r |
| | 184 | EFI_STATUS\r |
| | 185 | EFIAPI\r |
| | 186 | BdsLibEnumerateAllBootOption (\r |
| | 187 | IN OUT LIST_ENTRY *BdsBootOptionList\r |
| | 188 | );\r |
| | 189 | \r |
| | 190 | /**\r |
| | 191 | Build the boot option with the handle parsed in.\r |
| | 192 | \r |
| | 193 | @param Handle The handle representing the device path for which \r |
| | 194 | to create a boot option.\r |
| | 195 | @param BdsBootOptionList The header of the link list that indexed all\r |
| | 196 | current boot options.\r |
| | 197 | @param String The description of the boot option.\r |
| | 198 | \r |
| | 199 | **/\r |
| | 200 | VOID\r |
| | 201 | EFIAPI\r |
| | 202 | BdsLibBuildOptionFromHandle (\r |
| | 203 | IN EFI_HANDLE Handle,\r |
| | 204 | IN LIST_ENTRY *BdsBootOptionList,\r |
| | 205 | IN CHAR16 *String\r |
| | 206 | );\r |
| | 207 | \r |
| | 208 | \r |
| | 209 | /**\r |
| | 210 | Build the on flash shell boot option with the handle parsed in.\r |
| | 211 | \r |
| | 212 | @param Handle The handle which present the device path to create\r |
| | 213 | the on flash shell boot option.\r |
| | 214 | @param BdsBootOptionList The header of the link list that indexed all\r |
| | 215 | current boot options.\r |
| | 216 | \r |
| | 217 | **/\r |
| | 218 | VOID\r |
| | 219 | EFIAPI\r |
| | 220 | BdsLibBuildOptionFromShell (\r |
| | 221 | IN EFI_HANDLE Handle,\r |
| | 222 | IN OUT LIST_ENTRY *BdsBootOptionList\r |
| | 223 | );\r |
| | 224 | \r |
| | 225 | //\r |
| | 226 | // Bds misc lib functions\r |
| | 227 | //\r |
| | 228 | /**\r |
| | 229 | Get boot mode by looking up the configuration table and parsing the HOB list.\r |
| | 230 | \r |
| | 231 | @param BootMode The boot mode from PEI handoff HOB.\r |
| | 232 | \r |
| | 233 | @retval EFI_SUCCESS Successfully got boot mode.\r |
| | 234 | \r |
| | 235 | **/\r |
| | 236 | EFI_STATUS\r |
| | 237 | EFIAPI\r |
| | 238 | BdsLibGetBootMode (\r |
| | 239 | OUT EFI_BOOT_MODE *BootMode\r |
| | 240 | );\r |
| | 241 | \r |
| | 242 | \r |
| | 243 | /**\r |
| | 244 | The function will go through the driver option link list, and then load and start\r |
| | 245 | every driver to which the driver option device path points.\r |
| | 246 | \r |
| | 247 | @param BdsDriverLists The header of the current driver option link list.\r |
| | 248 | \r |
| | 249 | **/\r |
| | 250 | VOID\r |
| | 251 | EFIAPI\r |
| | 252 | BdsLibLoadDrivers (\r |
| | 253 | IN LIST_ENTRY *BdsDriverLists\r |
| | 254 | );\r |
| | 255 | \r |
| | 256 | \r |
| | 257 | /**\r |
| | 258 | This function processes BootOrder or DriverOrder variables, by calling\r |
| | 259 | \r |
| | 260 | BdsLibVariableToOption () for each UINT16 in the variables.\r |
| | 261 | \r |
| | 262 | @param BdsCommonOptionList The header of the option list base on the variable\r |
| | 263 | VariableName.\r |
| | 264 | @param VariableName An EFI Variable name indicate the BootOrder or\r |
| | 265 | DriverOrder.\r |
| | 266 | \r |
| | 267 | @retval EFI_SUCCESS Successfully created the boot option or driver option\r |
| | 268 | list.\r |
| | 269 | @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or the driver option list.\r |
| | 270 | **/\r |
| | 271 | EFI_STATUS\r |
| | 272 | EFIAPI\r |
| | 273 | BdsLibBuildOptionFromVar (\r |
| | 274 | IN LIST_ENTRY *BdsCommonOptionList,\r |
| | 275 | IN CHAR16 *VariableName\r |
| | 276 | );\r |
| | 277 | \r |
| | 278 | /**\r |
| | 279 | This function reads the EFI variable (VendorGuid/Name) and returns a dynamically allocated\r |
| | 280 | buffer and the size of the buffer. If it fails, return NULL.\r |
| | 281 | \r |
| | 282 | @param Name The string part of the EFI variable name.\r |
| | 283 | @param VendorGuid The GUID part of the EFI variable name.\r |
| | 284 | @param VariableSize Returns the size of the EFI variable that was read.\r |
| | 285 | \r |
| | 286 | @return Dynamically allocated memory that contains a copy \r |
| | 287 | of the EFI variable. The caller is responsible for \r |
| | 288 | freeing the buffer.\r |
| | 289 | @retval NULL The variable was not read.\r |
| | 290 | \r |
| | 291 | **/\r |
| | 292 | VOID *\r |
| | 293 | EFIAPI\r |
| | 294 | BdsLibGetVariableAndSize (\r |
| | 295 | IN CHAR16 *Name,\r |
| | 296 | IN EFI_GUID *VendorGuid,\r |
| | 297 | OUT UINTN *VariableSize\r |
| | 298 | );\r |
| | 299 | \r |
| | 300 | \r |
| | 301 | /**\r |
| | 302 | This function prints a series of strings.\r |
| | 303 | \r |
| | 304 | @param ConOut A pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.\r |
| | 305 | @param ... A variable argument list containing a series of\r |
| | 306 | strings, the last string must be NULL.\r |
| | 307 | \r |
| | 308 | @retval EFI_SUCCESS Successfully printed out the string using ConOut.\r |
| | 309 | @retval EFI_STATUS Return the status of the ConOut->OutputString ().\r |
| | 310 | \r |
| | 311 | **/\r |
| | 312 | EFI_STATUS\r |
| | 313 | EFIAPI\r |
| | 314 | BdsLibOutputStrings (\r |
| | 315 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut,\r |
| | 316 | ...\r |
| | 317 | );\r |
| | 318 | \r |
| | 319 | /**\r |
| | 320 | Build the boot#### or driver#### option from the VariableName. The\r |
| | 321 | build boot#### or driver#### will also be linked to BdsCommonOptionList.\r |
| | 322 | \r |
| | 323 | @param BdsCommonOptionList The header of the boot#### or driver#### option\r |
| | 324 | link list.\r |
| | 325 | @param VariableName EFI Variable name, indicates if it is boot#### or\r |
| | 326 | driver####.\r |
| | 327 | \r |
| | 328 | @retval BDS_COMMON_OPTION The option that was created.\r |
| | 329 | @retval NULL Failed to get the new option.\r |
| | 330 | \r |
| | 331 | **/\r |
| | 332 | BDS_COMMON_OPTION *\r |
| | 333 | EFIAPI\r |
| | 334 | BdsLibVariableToOption (\r |
| | 335 | IN OUT LIST_ENTRY *BdsCommonOptionList,\r |
| | 336 | IN CHAR16 *VariableName\r |
| | 337 | );\r |
| | 338 | \r |
| | 339 | /**\r |
| | 340 | This function registers the new boot#### or driver#### option based on\r |
| | 341 | the VariableName. The new registered boot#### or driver#### will be linked\r |
| | 342 | to BdsOptionList and also update to the VariableName. After the boot#### or\r |
| | 343 | driver#### updated, the BootOrder or DriverOrder will also be updated.\r |
| | 344 | \r |
| | 345 | @param BdsOptionList The header of the boot#### or driver#### link list.\r |
| | 346 | @param DevicePath The device path that the boot#### or driver####\r |
| | 347 | option present.\r |
| | 348 | @param String The description of the boot#### or driver####.\r |
| | 349 | @param VariableName Indicate if the boot#### or driver#### option.\r |
| | 350 | \r |
| | 351 | @retval EFI_SUCCESS The boot#### or driver#### have been successfully\r |
| | 352 | registered.\r |
| | 353 | @retval EFI_STATUS Return the status of gRT->SetVariable ().\r |
| | 354 | \r |
| | 355 | **/\r |
| | 356 | EFI_STATUS\r |
| | 357 | EFIAPI\r |
| | 358 | BdsLibRegisterNewOption (\r |
| | 359 | IN LIST_ENTRY *BdsOptionList,\r |
| | 360 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r |
| | 361 | IN CHAR16 *String,\r |
| | 362 | IN CHAR16 *VariableName\r |
| | 363 | );\r |
| | 364 | \r |
| | 365 | //\r |
| | 366 | // Bds connect and disconnect driver lib funcions\r |
| | 367 | //\r |
| | 368 | /**\r |
| | 369 | This function connects all system drivers with the corresponding controllers. \r |
| | 370 | \r |
| | 371 | **/\r |
| | 372 | VOID\r |
| | 373 | EFIAPI\r |
| | 374 | BdsLibConnectAllDriversToAllControllers (\r |
| | 375 | VOID\r |
| | 376 | );\r |
| | 377 | \r |
| | 378 | /**\r |
| | 379 | This function connects all system drivers to controllers.\r |
| | 380 | \r |
| | 381 | **/\r |
| | 382 | VOID\r |
| | 383 | EFIAPI\r |
| | 384 | BdsLibConnectAll (\r |
| | 385 | VOID\r |
| | 386 | );\r |
| | 387 | \r |
| | 388 | /**\r |
| | 389 | This function will create all handles associate with every device\r |
| | 390 | path node. If the handle associate with one device path node can not\r |
| | 391 | be created successfully, then still give chance to do the dispatch,\r |
| | 392 | which load the missing drivers if possible.\r |
| | 393 | \r |
| | 394 | @param DevicePathToConnect The device path to be connected. Can be\r |
| | 395 | a multi-instance device path.\r |
| | 396 | \r |
| | 397 | @retval EFI_SUCCESS All handles associates with every device path node\r |
| | 398 | were created.\r |
| | 399 | @retval EFI_OUT_OF_RESOURCES Not enough resources to create new handles.\r |
| | 400 | @retval EFI_NOT_FOUND At least one handle could not be created.\r |
| | 401 | \r |
| | 402 | **/\r |
| | 403 | EFI_STATUS\r |
| | 404 | EFIAPI\r |
| | 405 | BdsLibConnectDevicePath (\r |
| | 406 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePathToConnect\r |
| | 407 | );\r |
| | 408 | \r |
| | 409 | /**\r |
| | 410 | This function will connect all current system handles recursively. \r |
| | 411 | gBS->ConnectController() service is invoked for each handle exist in system handler buffer. \r |
| | 412 | If the handle is bus type handler, all childrens also will be connected recursively by gBS->ConnectController().\r |
| | 413 | \r |
| | 414 | @retval EFI_SUCCESS All handles and child handles have been\r |
| | 415 | connected. \r |
| | 416 | @retval EFI_STATUS Return the status of gBS->LocateHandleBuffer().\r |
| | 417 | **/\r |
| | 418 | EFI_STATUS\r |
| | 419 | EFIAPI\r |
| | 420 | BdsLibConnectAllEfi (\r |
| | 421 | VOID\r |
| | 422 | );\r |
| | 423 | \r |
| | 424 | /**\r |
| | 425 | This function will disconnect all current system handles. \r |
| | 426 | gBS->DisconnectController() is invoked for each handle exists in system handle buffer. \r |
| | 427 | If handle is a bus type handle, all childrens also are disconnected recursively by gBS->DisconnectController().\r |
| | 428 | \r |
| | 429 | @retval EFI_SUCCESS All handles have been disconnected.\r |
| | 430 | @retval EFI_STATUS Error status returned by of gBS->LocateHandleBuffer().\r |
| | 431 | \r |
| | 432 | **/\r |
| | 433 | EFI_STATUS\r |
| | 434 | EFIAPI\r |
| | 435 | BdsLibDisconnectAllEfi (\r |
| | 436 | VOID\r |
| | 437 | );\r |
| | 438 | \r |
| | 439 | //\r |
| | 440 | // Bds console related lib functions\r |
| | 441 | //\r |
| | 442 | /**\r |
| | 443 | This function will search every simpletxt device in the current system,\r |
| | 444 | and make every simpletxt device a potential console device.\r |
| | 445 | \r |
| | 446 | **/\r |
| | 447 | VOID\r |
| | 448 | EFIAPI\r |
| | 449 | BdsLibConnectAllConsoles (\r |
| | 450 | VOID\r |
| | 451 | );\r |
| | 452 | \r |
| | 453 | \r |
| | 454 | /**\r |
| | 455 | This function will connect console device based on the console\r |
| | 456 | device variable ConIn, ConOut and ErrOut.\r |
| | 457 | \r |
| | 458 | @retval EFI_SUCCESS At least one of the ConIn and ConOut devices have\r |
| | 459 | been connected.\r |
| | 460 | @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable ().\r |
| | 461 | \r |
| | 462 | **/\r |
| | 463 | EFI_STATUS\r |
| | 464 | EFIAPI\r |
| | 465 | BdsLibConnectAllDefaultConsoles (\r |
| | 466 | VOID\r |
| | 467 | );\r |
| | 468 | \r |
| | 469 | \r |
| | 470 | /**\r |
| | 471 | This function will connect console device except ConIn base on the console\r |
| | 472 | device variable ConOut and ErrOut.\r |
| | 473 | \r |
| | 474 | @retval EFI_SUCCESS At least one of the ConOut device have\r |
| | 475 | been connected success.\r |
| | 476 | @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable ().\r |
| | 477 | \r |
| | 478 | **/\r |
| | 479 | EFI_STATUS\r |
| | 480 | EFIAPI\r |
| | 481 | BdsLibConnectAllDefaultConsolesWithOutConIn (\r |
| | 482 | VOID\r |
| | 483 | );\r |
| | 484 | \r |
| | 485 | \r |
| | 486 | /**\r |
| | 487 | This function updates the console variable based on ConVarName. It can\r |
| | 488 | add or remove one specific console device path from the variable\r |
| | 489 | \r |
| | 490 | @param ConVarName The console-related variable name: ConIn, ConOut,\r |
| | 491 | ErrOut.\r |
| | 492 | @param CustomizedConDevicePath The console device path to be added to\r |
| | 493 | the console variable ConVarName. Cannot be multi-instance.\r |
| | 494 | @param ExclusiveDevicePath The console device path to be removed\r |
| | 495 | from the console variable ConVarName. Cannot be multi-instance.\r |
| | 496 | \r |
| | 497 | @retval EFI_UNSUPPORTED The added device path is the same as a removed one.\r |
| | 498 | @retval EFI_SUCCESS Successfully added or removed the device path from the\r |
| | 499 | console variable.\r |
| | 500 | \r |
| | 501 | **/\r |
| | 502 | EFI_STATUS\r |
| | 503 | EFIAPI\r |
| | 504 | BdsLibUpdateConsoleVariable (\r |
| | 505 | IN CHAR16 *ConVarName,\r |
| | 506 | IN EFI_DEVICE_PATH_PROTOCOL *CustomizedConDevicePath,\r |
| | 507 | IN EFI_DEVICE_PATH_PROTOCOL *ExclusiveDevicePath\r |
| | 508 | );\r |
| | 509 | \r |
| | 510 | /**\r |
| | 511 | Connect the console device base on the variable ConVarName, if\r |
| | 512 | device path of the ConVarName is multi-instance device path and\r |
| | 513 | anyone of the instances is connected success, then this function\r |
| | 514 | will return success.\r |
| | 515 | If the handle associate with one device path node can not\r |
| | 516 | be created successfully, then still give chance to do the dispatch,\r |
| | 517 | which load the missing drivers if possible.\r |
| | 518 | \r |
| | 519 | @param ConVarName Console related variable name, ConIn, ConOut,\r |
| | 520 | ErrOut.\r |
| | 521 | \r |
| | 522 | @retval EFI_NOT_FOUND There is not any console devices connected\r |
| | 523 | success\r |
| | 524 | @retval EFI_SUCCESS Success connect any one instance of the console\r |
| | 525 | device path base on the variable ConVarName.\r |
| | 526 | \r |
| | 527 | **/\r |
| | 528 | EFI_STATUS\r |
| | 529 | EFIAPI\r |
| | 530 | BdsLibConnectConsoleVariable (\r |
| | 531 | IN CHAR16 *ConVarName\r |
| | 532 | );\r |
| | 533 | \r |
| | 534 | //\r |
| | 535 | // Bds device path related lib functions\r |
| | 536 | //\r |
| | 537 | /**\r |
| | 538 | Delete the instance in Multi that overlaps with Single. \r |
| | 539 | \r |
| | 540 | @param Multi A pointer to a multi-instance device path data\r |
| | 541 | structure.\r |
| | 542 | @param Single A pointer to a single-instance device path data\r |
| | 543 | structure.\r |
| | 544 | \r |
| | 545 | @return This function removes the device path instances in Multi that overlap\r |
| | 546 | Single, and returns the resulting device path. If there is no\r |
| | 547 | remaining device path as a result, this function will return NULL.\r |
| | 548 | \r |
| | 549 | **/\r |
| | 550 | EFI_DEVICE_PATH_PROTOCOL *\r |
| | 551 | EFIAPI\r |
| | 552 | BdsLibDelPartMatchInstance (\r |
| | 553 | IN EFI_DEVICE_PATH_PROTOCOL *Multi,\r |
| | 554 | IN EFI_DEVICE_PATH_PROTOCOL *Single\r |
| | 555 | );\r |
| | 556 | \r |
| | 557 | /**\r |
| | 558 | This function compares a device path data structure to that of all the nodes of a\r |
| | 559 | second device path instance.\r |
| | 560 | \r |
| | 561 | @param Multi A pointer to a multi-instance device path data\r |
| | 562 | structure.\r |
| | 563 | @param Single A pointer to a single-instance device path data\r |
| | 564 | structure.\r |
| | 565 | \r |
| | 566 | @retval TRUE If the Single device path is contained within a \r |
| | 567 | Multi device path.\r |
| | 568 | @retval FALSE The Single device path is not contained within a \r |
| | 569 | Multi device path.\r |
| | 570 | \r |
| | 571 | **/\r |
| | 572 | BOOLEAN\r |
| | 573 | EFIAPI\r |
| | 574 | BdsLibMatchDevicePaths (\r |
| | 575 | IN EFI_DEVICE_PATH_PROTOCOL *Multi,\r |
| | 576 | IN EFI_DEVICE_PATH_PROTOCOL *Single\r |
| | 577 | );\r |
| | 578 | \r |
| | 579 | /**\r |
| | 580 | This function converts an input device structure to a Unicode string.\r |
| | 581 | \r |
| | 582 | @param DevPath A pointer to the device path structure.\r |
| | 583 | \r |
| | 584 | @return A newly allocated Unicode string that represents the device path.\r |
| | 585 | \r |
| | 586 | **/\r |
| | 587 | CHAR16 *\r |
| | 588 | EFIAPI\r |
| | 589 | DevicePathToStr (\r |
| | 590 | IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r |
| | 591 | );\r |
| | 592 | \r |
| | 593 | //\r |
| | 594 | // Internal definitions\r |
| | 595 | //\r |
| | 596 | typedef struct {\r |
| | 597 | CHAR16 *Str;\r |
| | 598 | UINTN Len;\r |
| | 599 | UINTN Maxlen;\r |
| | 600 | } POOL_PRINT;\r |
| | 601 | \r |
| | 602 | typedef\r |
| | 603 | VOID\r |
| | 604 | (*DEV_PATH_FUNCTION) (\r |
| | 605 | IN OUT POOL_PRINT *Str,\r |
| | 606 | IN VOID *DevPath\r |
| | 607 | );\r |
| | 608 | \r |
| | 609 | typedef struct {\r |
| | 610 | UINT8 Type;\r |
| | 611 | UINT8 SubType;\r |
| | 612 | DEV_PATH_FUNCTION Function;\r |
| | 613 | } DEVICE_PATH_STRING_TABLE;\r |
| | 614 | \r |
| | 615 | typedef struct {\r |
| | 616 | EFI_DEVICE_PATH_PROTOCOL Header;\r |
| | 617 | EFI_GUID Guid;\r |
| | 618 | UINT8 VendorDefinedData[1];\r |
| | 619 | } VENDOR_DEVICE_PATH_WITH_DATA;\r |
| | 620 | \r |
| | 621 | typedef struct {\r |
| | 622 | EFI_DEVICE_PATH_PROTOCOL Header;\r |
| | 623 | UINT16 NetworkProtocol;\r |
| | 624 | UINT16 LoginOption;\r |
| | 625 | UINT64 Lun;\r |
| | 626 | UINT16 TargetPortalGroupTag;\r |
| | 627 | CHAR16 TargetName[1];\r |
| | 628 | } ISCSI_DEVICE_PATH_WITH_NAME;\r |
| | 629 | \r |
| | 630 | //\r |
| | 631 | // BBS support macros and functions\r |
| | 632 | //\r |
| | 633 | \r |
| | 634 | #if defined(MDE_CPU_IA32) || defined(MDE_CPU_X64)\r |
| | 635 | #define REFRESH_LEGACY_BOOT_OPTIONS \\r |
| | 636 | BdsDeleteAllInvalidLegacyBootOptions ();\\r |
| | 637 | BdsAddNonExistingLegacyBootOptions (); \\r |
| | 638 | BdsUpdateLegacyDevOrder ()\r |
| | 639 | #else\r |
| | 640 | #define REFRESH_LEGACY_BOOT_OPTIONS\r |
| | 641 | #endif\r |
| | 642 | \r |
| | 643 | /**\r |
| | 644 | Delete all the invalid legacy boot options.\r |
| | 645 | \r |
| | 646 | @retval EFI_SUCCESS All invalid legacy boot options are deleted.\r |
| | 647 | @retval EFI_OUT_OF_RESOURCES Failed to allocate necessary memory.\r |
| | 648 | @retval EFI_NOT_FOUND Failed to retrieve variable of boot order.\r |
| | 649 | \r |
| | 650 | **/\r |
| | 651 | EFI_STATUS\r |
| | 652 | EFIAPI\r |
| | 653 | BdsDeleteAllInvalidLegacyBootOptions (\r |
| | 654 | VOID\r |
| | 655 | );\r |
| | 656 | \r |
| | 657 | /**\r |
| | 658 | Add the legacy boot options from BBS table if they do not exist.\r |
| | 659 | \r |
| | 660 | @retval EFI_SUCCESS The boot options were added successfully, \r |
| | 661 | or they are already in boot options.\r |
| | 662 | @retval EFI_NOT_FOUND No legacy boot options is found.\r |
| | 663 | @retval EFI_OUT_OF_RESOURCE No enough memory.\r |
| | 664 | @return Other value LegacyBoot options are not added.\r |
| | 665 | **/\r |
| | 666 | EFI_STATUS\r |
| | 667 | EFIAPI\r |
| | 668 | BdsAddNonExistingLegacyBootOptions (\r |
| | 669 | VOID\r |
| | 670 | );\r |
| | 671 | \r |
| | 672 | /**\r |
| | 673 | Add the legacy boot devices from BBS table into \r |
| | 674 | the legacy device boot order.\r |
| | 675 | \r |
| | 676 | @retval EFI_SUCCESS The boot devices were added successfully.\r |
| | 677 | @retval EFI_NOT_FOUND The legacy boot devices are not found.\r |
| | 678 | @retval EFI_OUT_OF_RESOURCES Memory or storage is not enough.\r |
| | 679 | @retval EFI_DEVICE_ERROR Failed to add the legacy device boot order into EFI variable\r |
| | 680 | because of a hardware error.\r |
| | 681 | **/\r |
| | 682 | EFI_STATUS\r |
| | 683 | EFIAPI\r |
| | 684 | BdsUpdateLegacyDevOrder (\r |
| | 685 | VOID\r |
| | 686 | );\r |
| | 687 | \r |
| | 688 | /**\r |
| | 689 | Refresh the boot priority for BBS entries based on boot option entry and boot order.\r |
| | 690 | \r |
| | 691 | @param Entry The boot option is to be checked for a refreshed BBS table.\r |
| | 692 | \r |
| | 693 | @retval EFI_SUCCESS The boot priority for BBS entries refreshed successfully.\r |
| | 694 | @retval EFI_NOT_FOUND BBS entries can't be found.\r |
| | 695 | @retval EFI_OUT_OF_RESOURCES Failed to get the legacy device boot order.\r |
| | 696 | **/\r |
| | 697 | EFI_STATUS\r |
| | 698 | EFIAPI\r |
| | 699 | BdsRefreshBbsTableForBoot (\r |
| | 700 | IN BDS_COMMON_OPTION *Entry\r |
| | 701 | );\r |
| | 702 | \r |
| | 703 | /**\r |
| | 704 | Delete the Boot Option from EFI Variable. The Boot Order Arrray\r |
| | 705 | is also updated.\r |
| | 706 | \r |
| | 707 | @param OptionNumber The number of Boot options wanting to be deleted.\r |
| | 708 | @param BootOrder The Boot Order array.\r |
| | 709 | @param BootOrderSize The size of the Boot Order Array.\r |
| | 710 | \r |
| | 711 | @retval EFI_SUCCESS The Boot Option Variable was found and removed.\r |
| | 712 | @retval EFI_UNSUPPORTED The Boot Option Variable store was inaccessible.\r |
| | 713 | @retval EFI_NOT_FOUND The Boot Option Variable was not found.\r |
| | 714 | **/\r |
| | 715 | EFI_STATUS\r |
| | 716 | EFIAPI\r |
| | 717 | BdsDeleteBootOption (\r |
| | 718 | IN UINTN OptionNumber,\r |
| | 719 | IN OUT UINT16 *BootOrder,\r |
| | 720 | IN OUT UINTN *BootOrderSize\r |
| | 721 | );\r |
| | 722 | \r |
| | 723 | //\r |
| | 724 | //The interface functions related to the Setup Browser Reset Reminder feature\r |
| | 725 | //\r |
| | 726 | /**\r |
| | 727 | Enable the setup browser reset reminder feature.\r |
| | 728 | This routine is used in a platform tip. If the platform policy needs the feature, use the routine to enable it.\r |
| | 729 | \r |
| | 730 | **/\r |
| | 731 | VOID\r |
| | 732 | EFIAPI\r |
| | 733 | EnableResetReminderFeature (\r |
| | 734 | VOID\r |
| | 735 | );\r |
| | 736 | \r |
| | 737 | /**\r |
| | 738 | Disable the setup browser reset reminder feature.\r |
| | 739 | This routine is used in a platform tip. If the platform policy does not want the feature, use the routine to disable it.\r |
| | 740 | \r |
| | 741 | **/\r |
| | 742 | VOID\r |
| | 743 | EFIAPI\r |
| | 744 | DisableResetReminderFeature (\r |
| | 745 | VOID\r |
| | 746 | );\r |
| | 747 | \r |
| | 748 | /**\r |
| | 749 | Record the info that a reset is required.\r |
| | 750 | A module boolean variable is used to record whether a reset is required.\r |
| | 751 | \r |
| | 752 | **/\r |
| | 753 | VOID\r |
| | 754 | EFIAPI\r |
| | 755 | EnableResetRequired (\r |
| | 756 | VOID\r |
| | 757 | );\r |
| | 758 | \r |
| | 759 | \r |
| | 760 | /**\r |
| | 761 | Record the info that no reset is required.\r |
| | 762 | A module boolean variable is used to record whether a reset is required.\r |
| | 763 | \r |
| | 764 | **/\r |
| | 765 | VOID\r |
| | 766 | EFIAPI\r |
| | 767 | DisableResetRequired (\r |
| | 768 | VOID\r |
| | 769 | );\r |
| | 770 | \r |
| | 771 | /**\r |
| | 772 | Check whether platform policy enables the reset reminder feature. The default is enabled.\r |
| | 773 | \r |
| | 774 | **/\r |
| | 775 | BOOLEAN\r |
| | 776 | EFIAPI\r |
| | 777 | IsResetReminderFeatureEnable (\r |
| | 778 | VOID\r |
| | 779 | );\r |
| | 780 | \r |
| | 781 | /**\r |
| | 782 | Check if the user changed any option setting that needs a system reset to be effective.\r |
| | 783 | \r |
| | 784 | **/\r |
| | 785 | BOOLEAN\r |
| | 786 | EFIAPI\r |
| | 787 | IsResetRequired (\r |
| | 788 | VOID\r |
| | 789 | );\r |
| | 790 | \r |
| | 791 | /**\r |
| | 792 | Check whether a reset is needed, and finish the reset reminder feature.\r |
| | 793 | If a reset is needed, pop up a menu to notice user, and finish the feature\r |
| | 794 | according to the user selection.\r |
| | 795 | \r |
| | 796 | **/\r |
| | 797 | VOID\r |
| | 798 | EFIAPI\r |
| | 799 | SetupResetReminder (\r |
| | 800 | VOID\r |
| | 801 | );\r |
| | 802 | \r |
| | 803 | \r |
| | 804 | ///\r |
| | 805 | /// Define the boot type with which to classify the boot option type.\r |
| | 806 | /// Different boot option types could have different boot behaviors.\r |
| | 807 | /// Use their device path node (Type + SubType) as the type value.\r |
| | 808 | /// The boot type here can be added according to requirements.\r |
| | 809 | ///\r |
| | 810 | \r |
| | 811 | ///\r |
| | 812 | /// ACPI boot type. For ACPI devices, using sub-types to distinguish devices is not allowed, so hardcode their values.\r |
| | 813 | ///\r |
| | 814 | #define BDS_EFI_ACPI_FLOPPY_BOOT 0x0201\r |
| | 815 | ///\r |
| | 816 | /// Message boot type\r |
| | 817 | /// If a device path of boot option only points to a message node, the boot option is a message boot type.\r |
| | 818 | ///\r |
| | 819 | #define BDS_EFI_MESSAGE_ATAPI_BOOT 0x0301 // Type 03; Sub-Type 01\r |
| | 820 | #define BDS_EFI_MESSAGE_SCSI_BOOT 0x0302 // Type 03; Sub-Type 02\r |
| | 821 | #define BDS_EFI_MESSAGE_USB_DEVICE_BOOT 0x0305 // Type 03; Sub-Type 05\r |
| | 822 | #define BDS_EFI_MESSAGE_SATA_BOOT 0x0312 // Type 03; Sub-Type 18\r |
| | 823 | #define BDS_EFI_MESSAGE_MAC_BOOT 0x030b // Type 03; Sub-Type 11\r |
| | 824 | #define BDS_EFI_MESSAGE_MISC_BOOT 0x03FF\r |
| | 825 | \r |
| | 826 | ///\r |
| | 827 | /// Media boot type\r |
| | 828 | /// If a device path of boot option contains a media node, the boot option is media boot type.\r |
| | 829 | ///\r |
| | 830 | #define BDS_EFI_MEDIA_HD_BOOT 0x0401 // Type 04; Sub-Type 01\r |
| | 831 | #define BDS_EFI_MEDIA_CDROM_BOOT 0x0402 // Type 04; Sub-Type 02\r |
| | 832 | ///\r |
| | 833 | /// BBS boot type\r |
| | 834 | /// If a device path of boot option contains a BBS node, the boot option is BBS boot type.\r |
| | 835 | ///\r |
| | 836 | #define BDS_LEGACY_BBS_BOOT 0x0501 // Type 05; Sub-Type 01\r |
| | 837 | \r |
| | 838 | #define BDS_EFI_UNSUPPORT 0xFFFF\r |
| | 839 | \r |
| | 840 | /**\r |
| | 841 | Check whether an instance in BlockIoDevicePath has the same partition node as the HardDriveDevicePath device path.\r |
| | 842 | \r |
| | 843 | @param BlockIoDevicePath Multi device path instances to check.\r |
| | 844 | @param HardDriveDevicePath A device path starting with a hard drive media\r |
| | 845 | device path.\r |
| | 846 | \r |
| | 847 | @retval TRUE There is a matched device path instance.\r |
| | 848 | @retval FALSE There is no matched device path instance.\r |
| | 849 | \r |
| | 850 | **/\r |
| | 851 | BOOLEAN\r |
| | 852 | EFIAPI\r |
| | 853 | MatchPartitionDevicePathNode (\r |
| | 854 | IN EFI_DEVICE_PATH_PROTOCOL *BlockIoDevicePath,\r |
| | 855 | IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath\r |
| | 856 | );\r |
| | 857 | \r |
| | 858 | \r |
| | 859 | /**\r |
| | 860 | Expand a device path that starts with a hard drive media device path node to be a\r |
| | 861 | full device path that includes the full hardware path to the device. This function enables the device to boot. \r |
| | 862 | To avoid requiring a connect on every boot, the front match is saved in a variable (the part point\r |
| | 863 | to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ).\r |
| | 864 | All successful history device paths\r |
| | 865 | that point to the front part of the partition node will be saved.\r |
| | 866 | \r |
| | 867 | @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard\r |
| | 868 | drive media device path.\r |
| | 869 | @return A Pointer to the full device path, or NULL if a valid Hard Drive devic path\r |
| | 870 | cannot be found.\r |
| | 871 | \r |
| | 872 | **/\r |
| | 873 | EFI_DEVICE_PATH_PROTOCOL *\r |
| | 874 | EFIAPI\r |
| | 875 | BdsExpandPartitionPartialDevicePathToFull (\r |
| | 876 | IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath\r |
| | 877 | );\r |
| | 878 | \r |
| | 879 | /**\r |
| | 880 | Return the bootable media handle.\r |
| | 881 | First, check whether the device is connected.\r |
| | 882 | Second, check whether the device path points to a device that supports SimpleFileSystemProtocol.\r |
| | 883 | Third, detect the the default boot file in the Media, and return the removable Media handle.\r |
| | 884 | \r |
| | 885 | @param DevicePath The Device Path to a bootable device.\r |
| | 886 | \r |
| | 887 | @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.\r |
| | 888 | \r |
| | 889 | **/\r |
| | 890 | EFI_HANDLE\r |
| | 891 | EFIAPI\r |
| | 892 | BdsLibGetBootableHandle (\r |
| | 893 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r |
| | 894 | );\r |
| | 895 | \r |
| | 896 | \r |
| | 897 | /**\r |
| | 898 | Checks whether the Device path in a boot option points to a valid bootable device, and if the device\r |
| | 899 | is ready to boot now.\r |
| | 900 | \r |
| | 901 | @param DevPath The Device path in a boot option.\r |
| | 902 | @param CheckMedia If true, check whether the device is ready to boot now.\r |
| | 903 | \r |
| | 904 | @retval TRUE The Device path is valid.\r |
| | 905 | @retval FALSE The Device path is invalid.\r |
| | 906 | \r |
| | 907 | **/\r |
| | 908 | BOOLEAN\r |
| | 909 | EFIAPI\r |
| | 910 | BdsLibIsValidEFIBootOptDevicePath (\r |
| | 911 | IN EFI_DEVICE_PATH_PROTOCOL *DevPath,\r |
| | 912 | IN BOOLEAN CheckMedia\r |
| | 913 | );\r |
| | 914 | \r |
| | 915 | /**\r |
| | 916 | Checks whether the Device path in a boot option points to a valid bootable device, and if the device\r |
| | 917 | is ready to boot now.\r |
| | 918 | If Description is not NULL and the device path points to a fixed BlockIo\r |
| | 919 | device, this function checks whether the description conflicts with other auto-created\r |
| | 920 | boot options.\r |
| | 921 | \r |
| | 922 | @param DevPath The Device path in a boot option.\r |
| | 923 | @param CheckMedia If true, checks if the device is ready to boot now.\r |
| | 924 | @param Description The description of a boot option.\r |
| | 925 | \r |
| | 926 | @retval TRUE The Device path is valid.\r |
| | 927 | @retval FALSE The Device path is invalid.\r |
| | 928 | \r |
| | 929 | **/\r |
| | 930 | BOOLEAN\r |
| | 931 | EFIAPI\r |
| | 932 | BdsLibIsValidEFIBootOptDevicePathExt (\r |
| | 933 | IN EFI_DEVICE_PATH_PROTOCOL *DevPath,\r |
| | 934 | IN BOOLEAN CheckMedia,\r |
| | 935 | IN CHAR16 *Description\r |
| | 936 | );\r |
| | 937 | \r |
| | 938 | /**\r |
| | 939 | For a bootable Device path, return its boot type.\r |
| | 940 | \r |
| | 941 | @param DevicePath The bootable device Path to check.\r |
| | 942 | \r |
| | 943 | @retval BDS_EFI_MEDIA_HD_BOOT The given device path contains MEDIA_DEVICE_PATH type device path node,\r |
| | 944 | whose subtype is MEDIA_HARDDRIVE_DP. \r |
| | 945 | @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node, \r |
| | 946 | whose subtype is MEDIA_CDROM_DP. \r |
| | 947 | @retval BDS_EFI_ACPI_FLOPPY_BOOT A given device path contains ACPI_DEVICE_PATH type device path node, \r |
| | 948 | whose HID is floppy device. \r |
| | 949 | @retval BDS_EFI_MESSAGE_ATAPI_BOOT A given device path contains MESSAGING_DEVICE_PATH type device path node, \r |
| | 950 | and its last device path node's subtype is MSG_ATAPI_DP. \r |
| | 951 | @retval BDS_EFI_MESSAGE_SCSI_BOOT A given device path contains MESSAGING_DEVICE_PATH type device path node,\r |
| | 952 | and its last device path node's subtype is MSG_SCSI_DP. \r |
| | 953 | @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT A given device path contains MESSAGING_DEVICE_PATH type device path node, \r |
| | 954 | and its last device path node's subtype is MSG_USB_DP.\r |
| | 955 | @retval BDS_EFI_MESSAGE_MISC_BOOT The device path does not contain any media device path node, and \r |
| | 956 | its last device path node points to a message device path node. \r |
| | 957 | @retval BDS_LEGACY_BBS_BOOT A given device path contains BBS_DEVICE_PATH type device path node. \r |
| | 958 | @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path does not point to a media and message device. \r |
| | 959 | \r |
| | 960 | **/\r |
| | 961 | UINT32\r |
| | 962 | EFIAPI\r |
| | 963 | BdsGetBootTypeFromDevicePath (\r |
| | 964 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r |
| | 965 | );\r |
| | 966 | \r |
| | 967 | \r |
| | 968 | /**\r |
| | 969 | This routine registers a function to adjust the different types of memory page numbers\r |
| | 970 | just before booting, and saves the updated info into the variable for the next boot to use.\r |
| | 971 | \r |
| | 972 | **/\r |
| | 973 | VOID\r |
| | 974 | EFIAPI\r |
| | 975 | BdsLibSaveMemoryTypeInformation (\r |
| | 976 | VOID\r |
| | 977 | );\r |
| | 978 | \r |
| | 979 | /**\r |
| | 980 | Identify a user and, if authenticated, returns the current user profile handle.\r |
| | 981 | \r |
| | 982 | @param[out] User Points to the user profile handle.\r |
| | 983 | \r |
| | 984 | @retval EFI_SUCCESS The user is successfully identified, or user identification\r |
| | 985 | is not supported.\r |
| | 986 | @retval EFI_ACCESS_DENIED The user was not successfully identified.\r |
| | 987 | \r |
| | 988 | **/\r |
| | 989 | EFI_STATUS\r |
| | 990 | EFIAPI\r |
| | 991 | BdsLibUserIdentify (\r |
| | 992 | OUT EFI_USER_PROFILE_HANDLE *User\r |
| | 993 | ); \r |
| | 994 | \r |
| | 995 | /**\r |
| | 996 | This function checks if a Fv file device path is valid, according to a file GUID. If it is invalid,\r |
| | 997 | it tries to return the valid device path.\r |
| | 998 | FV address maybe changes for memory layout adjust from time to time, use this function\r |
| | 999 | could promise the Fv file device path is right.\r |
| | 1000 | \r |
| | 1001 | @param DevicePath On input, the Fv file device path to check. On\r |
| | 1002 | output, the updated valid Fv file device path\r |
| | 1003 | @param FileGuid the Fv file GUID.\r |
| | 1004 | \r |
| | 1005 | @retval EFI_INVALID_PARAMETER The input DevicePath or FileGuid is invalid.\r |
| | 1006 | @retval EFI_UNSUPPORTED The input DevicePath does not contain an Fv file\r |
| | 1007 | GUID at all.\r |
| | 1008 | @retval EFI_ALREADY_STARTED The input DevicePath has pointed to the Fv file and is\r |
| | 1009 | valid.\r |
| | 1010 | @retval EFI_SUCCESS Successfully updated the invalid DevicePath\r |
| | 1011 | and returned the updated device path in DevicePath.\r |
| | 1012 | \r |
| | 1013 | **/\r |
| | 1014 | EFI_STATUS\r |
| | 1015 | EFIAPI\r |
| | 1016 | BdsLibUpdateFvFileDevicePath (\r |
| | 1017 | IN OUT EFI_DEVICE_PATH_PROTOCOL ** DevicePath,\r |
| | 1018 | IN EFI_GUID *FileGuid\r |
| | 1019 | );\r |
| | 1020 | \r |
| | 1021 | \r |
| | 1022 | /**\r |
| | 1023 | Connect the specific USB device that matches the RemainingDevicePath,\r |
| | 1024 | and whose bus is determined by Host Controller (Uhci or Ehci).\r |
| | 1025 | \r |
| | 1026 | @param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci\r |
| | 1027 | (0xFF).\r |
| | 1028 | @param RemainingDevicePath A short-form device path that starts with the first\r |
| | 1029 | element being a USB WWID or a USB Class device\r |
| | 1030 | path.\r |
| | 1031 | \r |
| | 1032 | @retval EFI_SUCCESS The specific Usb device is connected successfully.\r |
| | 1033 | @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF) \r |
| | 1034 | or RemainingDevicePath is not the USB class device path.\r |
| | 1035 | @retval EFI_NOT_FOUND The device specified by device path is not found.\r |
| | 1036 | \r |
| | 1037 | **/\r |
| | 1038 | EFI_STATUS\r |
| | 1039 | EFIAPI\r |
| | 1040 | BdsLibConnectUsbDevByShortFormDP(\r |
| | 1041 | IN UINT8 HostControllerPI,\r |
| | 1042 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r |
| | 1043 | );\r |
| | 1044 | \r |
| | 1045 | \r |
| | 1046 | //\r |
| | 1047 | // The implementation of this function is provided by Platform code.\r |
| | 1048 | //\r |
| | 1049 | /**\r |
| | 1050 | Convert Vendor device path to a device name.\r |
| | 1051 | \r |
| | 1052 | @param Str The buffer storing device name.\r |
| | 1053 | @param DevPath The pointer to vendor device path.\r |
| | 1054 | \r |
| | 1055 | **/\r |
| | 1056 | VOID\r |
| | 1057 | DevPathVendor (\r |
| | 1058 | IN OUT POOL_PRINT *Str,\r |
| | 1059 | IN VOID *DevPath\r |
| | 1060 | );\r |
| | 1061 | \r |
| | 1062 | /**\r |
| | 1063 | Concatenates a formatted unicode string to an allocated pool.\r |
| | 1064 | The caller must free the resulting buffer.\r |
| | 1065 | \r |
| | 1066 | @param Str Tracks the allocated pool, size in use, and amount of pool allocated.\r |
| | 1067 | @param Fmt The format string.\r |
| | 1068 | @param ... The data will be printed.\r |
| | 1069 | \r |
| | 1070 | @return Allocated buffer with the formatted string printed in it.\r |
| | 1071 | The caller must free the allocated buffer.\r |
| | 1072 | The buffer allocation is not packed.\r |
| | 1073 | \r |
| | 1074 | **/\r |
| | 1075 | CHAR16 *\r |
| | 1076 | EFIAPI\r |
| | 1077 | CatPrint (\r |
| | 1078 | IN OUT POOL_PRINT *Str,\r |
| | 1079 | IN CHAR16 *Fmt,\r |
| | 1080 | ...\r |
| | 1081 | );\r |
| | 1082 | \r |
| | 1083 | /**\r |
| | 1084 | Use SystemTable ConOut to stop video based Simple Text Out consoles from going\r |
| | 1085 | to the video device. Put up LogoFile on every video device that is a console.\r |
| | 1086 | \r |
| | 1087 | @param[in] LogoFile The file name of logo to display on the center of the screen.\r |
| | 1088 | \r |
| | 1089 | @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.\r |
| | 1090 | @retval EFI_UNSUPPORTED Logo not found.\r |
| | 1091 | \r |
| | 1092 | **/\r |
| | 1093 | EFI_STATUS\r |
| | 1094 | EFIAPI\r |
| | 1095 | EnableQuietBoot (\r |
| | 1096 | IN EFI_GUID *LogoFile\r |
| | 1097 | );\r |
| | 1098 | \r |
| | 1099 | \r |
| | 1100 | /**\r |
| | 1101 | Use SystemTable ConOut to turn on video based Simple Text Out consoles. The \r |
| | 1102 | Simple Text Out screens will now be synced up with all non-video output devices.\r |
| | 1103 | \r |
| | 1104 | @retval EFI_SUCCESS UGA devices are back in text mode and synced up.\r |
| | 1105 | \r |
| | 1106 | **/\r |
| | 1107 | EFI_STATUS\r |
| | 1108 | EFIAPI\r |
| | 1109 | DisableQuietBoot (\r |
| | 1110 | VOID\r |
| | 1111 | );\r |
| | 1112 | \r |
| | 1113 | #endif\r |
| | 1114 | \r |
projects / mirror_edk2.git / blame_incremental