| 45a20a7f |
1 | /*++\r |
| 2 | \r |
| 3 | Copyright (c) 2006 - 2007, Intel Corporation\r |
| 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 | BdsLib.h\r |
| 15 | \r |
| 16 | Abstract:\r |
| 17 | \r |
| 18 | BDS library definition, include the file and data structure\r |
| 19 | \r |
| 20 | --*/\r |
| 21 | \r |
| 22 | #ifndef _BDS_LIB_H_\r |
| 23 | #define _BDS_LIB_H_\r |
| 24 | \r |
| af162ac5 |
25 | #include <Protocol/SimpleTextOut.h>\r |
| 8e5b17b2 |
26 | #include <Protocol/FrameworkHii.h>\r |
| af162ac5 |
27 | \r |
| 45a20a7f |
28 | extern EFI_HANDLE mBdsImageHandle;\r |
| 29 | \r |
| 30 | //\r |
| 31 | // Constants which are variable names used to access variables\r |
| 32 | //\r |
| 33 | #define VarLegacyDevOrder L"LegacyDevOrder"\r |
| 34 | \r |
| 35 | //\r |
| 36 | // Data structures and defines\r |
| 37 | //\r |
| 38 | #define FRONT_PAGE_QUESTION_ID 0x0000\r |
| 39 | #define FRONT_PAGE_DATA_WIDTH 0x01\r |
| 40 | \r |
| 41 | //\r |
| 42 | // ConnectType\r |
| 43 | //\r |
| 44 | #define CONSOLE_OUT 0x00000001\r |
| 45 | #define STD_ERROR 0x00000002\r |
| 46 | #define CONSOLE_IN 0x00000004\r |
| 47 | #define CONSOLE_ALL (CONSOLE_OUT | CONSOLE_IN | STD_ERROR)\r |
| 48 | \r |
| 49 | //\r |
| 50 | // Load Option Attributes defined in EFI Specification\r |
| 51 | //\r |
| 45a20a7f |
52 | #define IS_LOAD_OPTION_TYPE(_c, _Mask) (BOOLEAN) (((_c) & (_Mask)) != 0)\r |
| 53 | \r |
| 54 | //\r |
| 55 | // Define Maxmim characters that will be accepted\r |
| 56 | //\r |
| 57 | #define MAX_CHAR 480\r |
| 58 | #define MAX_CHAR_SIZE (MAX_CHAR * 2)\r |
| 59 | \r |
| 60 | #define MIN_ALIGNMENT_SIZE 4\r |
| 61 | #define ALIGN_SIZE(a) ((a % MIN_ALIGNMENT_SIZE) ? MIN_ALIGNMENT_SIZE - (a % MIN_ALIGNMENT_SIZE) : 0)\r |
| 62 | \r |
| 63 | //\r |
| 64 | // Define maximum characters for boot option variable "BootXXXX"\r |
| 65 | //\r |
| 66 | #define BOOT_OPTION_MAX_CHAR 10\r |
| 67 | \r |
| 68 | //\r |
| 69 | // This data structure is the part of BDS_CONNECT_ENTRY that we can hard code.\r |
| 70 | //\r |
| 71 | #define BDS_LOAD_OPTION_SIGNATURE EFI_SIGNATURE_32 ('B', 'd', 'C', 'O')\r |
| 72 | \r |
| 73 | typedef struct {\r |
| 74 | \r |
| 75 | UINTN Signature;\r |
| 76 | LIST_ENTRY Link;\r |
| 77 | \r |
| 78 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r |
| 79 | \r |
| 80 | CHAR16 *OptionName;\r |
| 81 | UINTN OptionNumber;\r |
| 82 | UINT16 BootCurrent;\r |
| 83 | UINT32 Attribute;\r |
| 84 | CHAR16 *Description;\r |
| 85 | VOID *LoadOptions;\r |
| 86 | UINT32 LoadOptionsSize;\r |
| 87 | \r |
| 88 | } BDS_COMMON_OPTION;\r |
| 89 | \r |
| 90 | typedef struct {\r |
| 91 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r |
| 92 | UINTN ConnectType;\r |
| 93 | } BDS_CONSOLE_CONNECT_ENTRY;\r |
| 94 | \r |
| 95 | //\r |
| 96 | // Lib Functions\r |
| 97 | //\r |
| 98 | \r |
| 99 | //\r |
| 100 | // Bds boot relate lib functions\r |
| 101 | //\r |
| 102 | EFI_STATUS\r |
| 103 | BdsLibUpdateBootOrderList (\r |
| 104 | IN LIST_ENTRY *BdsOptionList,\r |
| 105 | IN CHAR16 *VariableName\r |
| 106 | );\r |
| 107 | \r |
| 108 | VOID\r |
| 109 | BdsLibBootNext (\r |
| 110 | VOID\r |
| 111 | );\r |
| 112 | \r |
| 113 | EFI_STATUS\r |
| 114 | BdsLibBootViaBootOption (\r |
| 115 | IN BDS_COMMON_OPTION * Option,\r |
| 116 | IN EFI_DEVICE_PATH_PROTOCOL * DevicePath,\r |
| 117 | OUT UINTN *ExitDataSize,\r |
| 118 | OUT CHAR16 **ExitData OPTIONAL\r |
| 119 | );\r |
| 120 | \r |
| 121 | EFI_STATUS\r |
| 122 | BdsLibEnumerateAllBootOption (\r |
| 123 | IN OUT LIST_ENTRY *BdsBootOptionList\r |
| 124 | );\r |
| 125 | \r |
| 126 | VOID\r |
| 127 | BdsLibBuildOptionFromHandle (\r |
| 128 | IN EFI_HANDLE Handle,\r |
| 129 | IN LIST_ENTRY *BdsBootOptionList\r |
| 130 | );\r |
| 131 | \r |
| 132 | VOID\r |
| 133 | BdsLibBuildOptionFromShell (\r |
| 134 | IN EFI_HANDLE Handle,\r |
| 135 | IN LIST_ENTRY *BdsBootOptionList\r |
| 136 | );\r |
| 137 | \r |
| 138 | //\r |
| 139 | // Bds misc lib functions\r |
| 140 | //\r |
| 141 | UINT16\r |
| 142 | BdsLibGetTimeout (\r |
| 143 | VOID\r |
| 144 | );\r |
| 145 | \r |
| 146 | VOID\r |
| 147 | BdsLibLoadDrivers (\r |
| 148 | IN LIST_ENTRY *BdsDriverLists\r |
| 149 | );\r |
| 150 | \r |
| 151 | EFI_STATUS\r |
| 152 | BdsLibBuildOptionFromVar (\r |
| 153 | IN LIST_ENTRY *BdsCommonOptionList,\r |
| 154 | IN CHAR16 *VariableName\r |
| 155 | );\r |
| 156 | \r |
| 157 | VOID *\r |
| 158 | BdsLibGetVariableAndSize (\r |
| 159 | IN CHAR16 *Name,\r |
| 160 | IN EFI_GUID *VendorGuid,\r |
| 161 | OUT UINTN *VariableSize\r |
| 162 | );\r |
| 163 | \r |
| 164 | EFI_STATUS\r |
| 165 | BdsLibOutputStrings (\r |
| 0847a641 |
166 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut,\r |
| 45a20a7f |
167 | ...\r |
| 168 | );\r |
| 169 | \r |
| 170 | BDS_COMMON_OPTION *\r |
| 171 | BdsLibVariableToOption (\r |
| 172 | IN OUT LIST_ENTRY *BdsCommonOptionList,\r |
| 173 | IN CHAR16 *VariableName\r |
| 174 | );\r |
| 175 | \r |
| 176 | EFI_STATUS\r |
| 177 | BdsLibRegisterNewOption (\r |
| 178 | IN LIST_ENTRY *BdsOptionList,\r |
| 179 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r |
| 180 | IN CHAR16 *String,\r |
| 181 | IN CHAR16 *VariableName\r |
| 182 | );\r |
| 183 | \r |
| 184 | //\r |
| 185 | // Bds connect or disconnect driver lib funcion\r |
| 186 | //\r |
| 187 | VOID\r |
| 188 | BdsLibConnectAllDriversToAllControllers (\r |
| 189 | VOID\r |
| 190 | );\r |
| 191 | \r |
| 192 | VOID\r |
| 193 | BdsLibConnectAll (\r |
| 194 | VOID\r |
| 195 | );\r |
| 196 | \r |
| 197 | EFI_STATUS\r |
| 198 | BdsLibConnectDevicePath (\r |
| 199 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePathToConnect\r |
| 200 | );\r |
| 201 | \r |
| 202 | EFI_STATUS\r |
| 203 | BdsLibConnectAllEfi (\r |
| 204 | VOID\r |
| 205 | );\r |
| 206 | \r |
| 207 | EFI_STATUS\r |
| 208 | BdsLibDisconnectAllEfi (\r |
| 209 | VOID\r |
| 210 | );\r |
| 211 | \r |
| 212 | //\r |
| 213 | // Bds console relate lib functions\r |
| 214 | //\r |
| 215 | VOID\r |
| 216 | BdsLibConnectAllConsoles (\r |
| 217 | VOID\r |
| 218 | );\r |
| 219 | \r |
| 220 | EFI_STATUS\r |
| 221 | BdsLibConnectAllDefaultConsoles (\r |
| 222 | VOID\r |
| 223 | );\r |
| 224 | \r |
| 225 | EFI_STATUS\r |
| 226 | BdsLibUpdateConsoleVariable (\r |
| 227 | IN CHAR16 *ConVarName,\r |
| 228 | IN EFI_DEVICE_PATH_PROTOCOL *CustomizedConDevicePath,\r |
| 229 | IN EFI_DEVICE_PATH_PROTOCOL *ExclusiveDevicePath\r |
| 230 | );\r |
| 231 | \r |
| 232 | EFI_STATUS\r |
| 233 | BdsLibConnectConsoleVariable (\r |
| 234 | IN CHAR16 *ConVarName\r |
| 235 | );\r |
| 236 | \r |
| 237 | //\r |
| 238 | // Bds device path relate lib functions\r |
| 239 | //\r |
| 240 | EFI_DEVICE_PATH_PROTOCOL *\r |
| 241 | BdsLibUnpackDevicePath (\r |
| 242 | IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r |
| 243 | );\r |
| 244 | \r |
| 245 | VOID\r |
| 246 | BdsLibSafeFreePool (\r |
| 247 | IN VOID *Buffer\r |
| 248 | );\r |
| 249 | \r |
| 250 | EFI_DEVICE_PATH_PROTOCOL *\r |
| 251 | BdsLibDelPartMatchInstance (\r |
| 252 | IN EFI_DEVICE_PATH_PROTOCOL *Multi,\r |
| 253 | IN EFI_DEVICE_PATH_PROTOCOL *Single\r |
| 254 | );\r |
| 255 | \r |
| 256 | BOOLEAN\r |
| 257 | BdsLibMatchDevicePaths (\r |
| 258 | IN EFI_DEVICE_PATH_PROTOCOL *Multi,\r |
| 259 | IN EFI_DEVICE_PATH_PROTOCOL *Single\r |
| 260 | );\r |
| 261 | \r |
| 262 | CHAR16 *\r |
| 263 | DevicePathToStr (\r |
| 264 | EFI_DEVICE_PATH_PROTOCOL *DevPath\r |
| 265 | );\r |
| 266 | \r |
| 267 | VOID *\r |
| 268 | EfiLibGetVariable (\r |
| 269 | IN CHAR16 *Name,\r |
| 270 | IN EFI_GUID *VendorGuid\r |
| 271 | );\r |
| 272 | \r |
| 273 | //\r |
| 274 | // Internal definitions\r |
| 275 | //\r |
| 276 | typedef struct {\r |
| 277 | CHAR16 *str;\r |
| 278 | UINTN len;\r |
| 279 | UINTN maxlen;\r |
| 280 | } POOL_PRINT;\r |
| 281 | \r |
| 282 | typedef struct {\r |
| 283 | UINT8 Type;\r |
| 284 | UINT8 SubType;\r |
| 285 | VOID (*Function) (POOL_PRINT *, VOID *);\r |
| 286 | } DEVICE_PATH_STRING_TABLE;\r |
| 287 | \r |
| 288 | //\r |
| 289 | // Internal functions\r |
| 290 | //\r |
| 291 | EFI_STATUS\r |
| 292 | BdsBootByDiskSignatureAndPartition (\r |
| 293 | IN BDS_COMMON_OPTION * Option,\r |
| 294 | IN HARDDRIVE_DEVICE_PATH * HardDriveDevicePath,\r |
| 295 | IN UINT32 LoadOptionsSize,\r |
| 296 | IN VOID *LoadOptions,\r |
| 297 | OUT UINTN *ExitDataSize,\r |
| 298 | OUT CHAR16 **ExitData OPTIONAL\r |
| 299 | );\r |
| 300 | \r |
| 301 | //\r |
| 302 | // Notes: EFI 64 shadow all option rom\r |
| 303 | //\r |
| 304 | #if defined (MDE_CPU_IPF)\r |
| 305 | #define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();\r |
| 306 | VOID\r |
| 307 | ShadowAllOptionRom();\r |
| 308 | #else\r |
| 309 | #define EFI64_SHADOW_ALL_LEGACY_ROM()\r |
| 310 | #endif\r |
| 311 | \r |
| 312 | //\r |
| 313 | // BBS support macros and functions\r |
| 314 | //\r |
| 315 | #if defined (MDE_CPU_IA32)\r |
| 316 | #define REFRESH_LEGACY_BOOT_OPTIONS \\r |
| 317 | BdsDeleteAllInvalidLegacyBootOptions ();\\r |
| 318 | BdsAddNonExistingLegacyBootOptions (); \\r |
| 319 | BdsUpdateLegacyDevOrder ()\r |
| 320 | #else\r |
| 321 | #define REFRESH_LEGACY_BOOT_OPTIONS\r |
| 322 | #endif\r |
| 323 | \r |
| 324 | EFI_STATUS\r |
| 325 | BdsDeleteAllInvalidLegacyBootOptions (\r |
| 326 | VOID\r |
| 327 | );\r |
| 328 | \r |
| 329 | EFI_STATUS\r |
| 330 | BdsAddNonExistingLegacyBootOptions (\r |
| 331 | VOID\r |
| 332 | );\r |
| 333 | \r |
| 334 | EFI_STATUS\r |
| 335 | BdsUpdateLegacyDevOrder (\r |
| 336 | VOID\r |
| 337 | );\r |
| 338 | \r |
| 339 | EFI_STATUS\r |
| 340 | BdsRefreshBbsTableForBoot (\r |
| 341 | IN BDS_COMMON_OPTION *Entry\r |
| 342 | );\r |
| 343 | \r |
| 344 | EFI_STATUS\r |
| 345 | BdsDeleteBootOption (\r |
| 346 | IN UINTN OptionNumber,\r |
| 347 | IN OUT UINT16 *BootOrder,\r |
| 348 | IN OUT UINTN *BootOrderSize\r |
| 349 | );\r |
| 350 | \r |
| 351 | //\r |
| 352 | //The interface functions relate with Setup Browser Reset Reminder feature\r |
| 353 | //\r |
| 354 | VOID\r |
| 355 | EnableResetReminderFeature (\r |
| 356 | VOID\r |
| 357 | );\r |
| 358 | \r |
| 359 | VOID\r |
| 360 | DisableResetReminderFeature (\r |
| 361 | VOID\r |
| 362 | );\r |
| 363 | \r |
| 364 | VOID\r |
| 365 | EnableResetRequired (\r |
| 366 | VOID\r |
| 367 | );\r |
| 368 | \r |
| 369 | VOID\r |
| 370 | DisableResetRequired (\r |
| 371 | VOID\r |
| 372 | );\r |
| 373 | \r |
| 374 | BOOLEAN\r |
| 375 | IsResetReminderFeatureEnable (\r |
| 376 | VOID\r |
| 377 | );\r |
| 378 | \r |
| 379 | BOOLEAN\r |
| 380 | IsResetRequired (\r |
| 381 | VOID\r |
| 382 | );\r |
| 383 | \r |
| 384 | VOID\r |
| 385 | SetupResetReminder (\r |
| 386 | VOID\r |
| 387 | );\r |
| 388 | \r |
| 389 | EFI_STATUS\r |
| 390 | BdsLibGetHiiHandles (\r |
| 391 | IN EFI_HII_PROTOCOL *Hii,\r |
| 392 | IN OUT UINT16 *HandleBufferLength,\r |
| 5fd5fcd3 |
393 | OUT FRAMEWORK_EFI_HII_HANDLE **HiiHandles\r |
| 45a20a7f |
394 | );\r |
| 395 | \r |
| 396 | #endif // _BDS_LIB_H_\r |
projects / mirror_edk2.git / blame