| | 1 | /** @file\r |
| | 2 | Provides library functions for common UEFI operations. Only available to DXE\r |
| | 3 | and UEFI module types.\r |
| | 4 | \r |
| | 5 | The UEFI Library provides functions and macros that simplify the development of\r |
| | 6 | UEFI Drivers and UEFI Applications. These functions and macros help manage EFI\r |
| | 7 | events, build simple locks utilizing EFI Task Priority Levels (TPLs), install\r |
| | 8 | EFI Driver Model related protocols, manage Unicode string tables for UEFI Drivers,\r |
| | 9 | and print messages on the console output and standard error devices.\r |
| | 10 | \r |
| | 11 | Note that a reserved macro named MDEPKG_NDEBUG is introduced for the intention\r |
| | 12 | of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is\r |
| | 13 | defined, then debug and assert related macros wrapped by it are the NULL implementations.\r |
| | 14 | \r |
| | 15 | Copyright (c) 2019, NVIDIA Corporation. All rights reserved.\r |
| | 16 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| | 17 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| | 18 | \r |
| | 19 | **/\r |
| | 20 | \r |
| | 21 | #ifndef __UEFI_LIB_H__\r |
| | 22 | #define __UEFI_LIB_H__\r |
| | 23 | \r |
| | 24 | #include <IndustryStandard/Acpi.h>\r |
| | 25 | \r |
| | 26 | #include <Protocol/DriverBinding.h>\r |
| | 27 | #include <Protocol/DriverConfiguration.h>\r |
| | 28 | #include <Protocol/ComponentName.h>\r |
| | 29 | #include <Protocol/ComponentName2.h>\r |
| | 30 | #include <Protocol/DriverDiagnostics.h>\r |
| | 31 | #include <Protocol/DriverDiagnostics2.h>\r |
| | 32 | #include <Protocol/GraphicsOutput.h>\r |
| | 33 | #include <Protocol/DevicePath.h>\r |
| | 34 | #include <Protocol/SimpleFileSystem.h>\r |
| | 35 | \r |
| | 36 | #include <Library/BaseLib.h>\r |
| | 37 | \r |
| | 38 | ///\r |
| | 39 | /// Unicode String Table\r |
| | 40 | ///\r |
| | 41 | typedef struct {\r |
| | 42 | CHAR8 *Language;\r |
| | 43 | CHAR16 *UnicodeString;\r |
| | 44 | } EFI_UNICODE_STRING_TABLE;\r |
| | 45 | \r |
| | 46 | ///\r |
| | 47 | /// EFI Lock Status\r |
| | 48 | ///\r |
| | 49 | typedef enum {\r |
| | 50 | EfiLockUninitialized = 0,\r |
| | 51 | EfiLockReleased = 1,\r |
| | 52 | EfiLockAcquired = 2\r |
| | 53 | } EFI_LOCK_STATE;\r |
| | 54 | \r |
| | 55 | ///\r |
| | 56 | /// EFI Lock\r |
| | 57 | ///\r |
| | 58 | typedef struct {\r |
| | 59 | EFI_TPL Tpl;\r |
| | 60 | EFI_TPL OwnerTpl;\r |
| | 61 | EFI_LOCK_STATE Lock;\r |
| | 62 | } EFI_LOCK;\r |
| | 63 | \r |
| | 64 | /**\r |
| | 65 | Macro that returns the number of 100 ns units for a specified number of microseconds.\r |
| | 66 | This is useful for managing EFI timer events.\r |
| | 67 | \r |
| | 68 | @param Microseconds The number of microseconds.\r |
| | 69 | \r |
| | 70 | @return The number of 100 ns units equivalent to the number of microseconds specified\r |
| | 71 | by Microseconds.\r |
| | 72 | \r |
| | 73 | **/\r |
| | 74 | #define EFI_TIMER_PERIOD_MICROSECONDS(Microseconds) MultU64x32((UINT64)(Microseconds), 10)\r |
| | 75 | \r |
| | 76 | /**\r |
| | 77 | Macro that returns the number of 100 ns units for a specified number of milliseconds.\r |
| | 78 | This is useful for managing EFI timer events.\r |
| | 79 | \r |
| | 80 | @param Milliseconds The number of milliseconds.\r |
| | 81 | \r |
| | 82 | @return The number of 100 ns units equivalent to the number of milliseconds specified\r |
| | 83 | by Milliseconds.\r |
| | 84 | \r |
| | 85 | **/\r |
| | 86 | #define EFI_TIMER_PERIOD_MILLISECONDS(Milliseconds) MultU64x32((UINT64)(Milliseconds), 10000)\r |
| | 87 | \r |
| | 88 | /**\r |
| | 89 | Macro that returns the number of 100 ns units for a specified number of seconds.\r |
| | 90 | This is useful for managing EFI timer events.\r |
| | 91 | \r |
| | 92 | @param Seconds The number of seconds.\r |
| | 93 | \r |
| | 94 | @return The number of 100 ns units equivalent to the number of seconds specified\r |
| | 95 | by Seconds.\r |
| | 96 | \r |
| | 97 | **/\r |
| | 98 | #define EFI_TIMER_PERIOD_SECONDS(Seconds) MultU64x32((UINT64)(Seconds), 10000000)\r |
| | 99 | \r |
| | 100 | /**\r |
| | 101 | Macro that returns the a pointer to the next EFI_MEMORY_DESCRIPTOR in an array\r |
| | 102 | returned from GetMemoryMap().\r |
| | 103 | \r |
| | 104 | @param MemoryDescriptor A pointer to an EFI_MEMORY_DESCRIPTOR.\r |
| | 105 | \r |
| | 106 | @param Size The size, in bytes, of the current EFI_MEMORY_DESCRIPTOR.\r |
| | 107 | \r |
| | 108 | @return A pointer to the next EFI_MEMORY_DESCRIPTOR.\r |
| | 109 | \r |
| | 110 | **/\r |
| | 111 | #define NEXT_MEMORY_DESCRIPTOR(MemoryDescriptor, Size) \\r |
| | 112 | ((EFI_MEMORY_DESCRIPTOR *)((UINT8 *)(MemoryDescriptor) + (Size)))\r |
| | 113 | \r |
| | 114 | /**\r |
| | 115 | Retrieves a pointer to the system configuration table from the EFI System Table\r |
| | 116 | based on a specified GUID.\r |
| | 117 | \r |
| | 118 | This function searches the list of configuration tables stored in the EFI System Table\r |
| | 119 | for a table with a GUID that matches TableGuid. If a match is found, then a pointer to\r |
| | 120 | the configuration table is returned in Table, and EFI_SUCCESS is returned. If a matching GUID\r |
| | 121 | is not found, then EFI_NOT_FOUND is returned.\r |
| | 122 | If TableGuid is NULL, then ASSERT().\r |
| | 123 | If Table is NULL, then ASSERT().\r |
| | 124 | \r |
| | 125 | @param TableGuid The pointer to table's GUID type..\r |
| | 126 | @param Table The pointer to the table associated with TableGuid in the EFI System Table.\r |
| | 127 | \r |
| | 128 | @retval EFI_SUCCESS A configuration table matching TableGuid was found.\r |
| | 129 | @retval EFI_NOT_FOUND A configuration table matching TableGuid could not be found.\r |
| | 130 | \r |
| | 131 | **/\r |
| | 132 | EFI_STATUS\r |
| | 133 | EFIAPI\r |
| | 134 | EfiGetSystemConfigurationTable (\r |
| | 135 | IN EFI_GUID *TableGuid,\r |
| | 136 | OUT VOID **Table\r |
| | 137 | );\r |
| | 138 | \r |
| | 139 | /**\r |
| | 140 | Creates and returns a notification event and registers that event with all the protocol\r |
| | 141 | instances specified by ProtocolGuid.\r |
| | 142 | \r |
| | 143 | This function causes the notification function to be executed for every protocol of type\r |
| | 144 | ProtocolGuid instance that exists in the system when this function is invoked. If there are\r |
| | 145 | no instances of ProtocolGuid in the handle database at the time this function is invoked,\r |
| | 146 | then the notification function is still executed one time. In addition, every time a protocol\r |
| | 147 | of type ProtocolGuid instance is installed or reinstalled, the notification function is also\r |
| | 148 | executed. This function returns the notification event that was created.\r |
| | 149 | If ProtocolGuid is NULL, then ASSERT().\r |
| | 150 | If NotifyTpl is not a legal TPL value, then ASSERT().\r |
| | 151 | If NotifyFunction is NULL, then ASSERT().\r |
| | 152 | If Registration is NULL, then ASSERT().\r |
| | 153 | \r |
| | 154 | \r |
| | 155 | @param ProtocolGuid Supplies GUID of the protocol upon whose installation the event is fired.\r |
| | 156 | @param NotifyTpl Supplies the task priority level of the event notifications.\r |
| | 157 | @param NotifyFunction Supplies the function to notify when the event is signaled.\r |
| | 158 | @param NotifyContext The context parameter to pass to NotifyFunction.\r |
| | 159 | @param Registration A pointer to a memory location to receive the registration value.\r |
| | 160 | This value is passed to LocateHandle() to obtain new handles that\r |
| | 161 | have been added that support the ProtocolGuid-specified protocol.\r |
| | 162 | \r |
| | 163 | @return The notification event that was created.\r |
| | 164 | \r |
| | 165 | **/\r |
| | 166 | EFI_EVENT\r |
| | 167 | EFIAPI\r |
| | 168 | EfiCreateProtocolNotifyEvent (\r |
| | 169 | IN EFI_GUID *ProtocolGuid,\r |
| | 170 | IN EFI_TPL NotifyTpl,\r |
| | 171 | IN EFI_EVENT_NOTIFY NotifyFunction,\r |
| | 172 | IN VOID *NotifyContext OPTIONAL,\r |
| | 173 | OUT VOID **Registration\r |
| | 174 | );\r |
| | 175 | \r |
| | 176 | /**\r |
| | 177 | Creates a named event that can be signaled with EfiNamedEventSignal().\r |
| | 178 | \r |
| | 179 | This function creates an event using NotifyTpl, NoifyFunction, and NotifyContext.\r |
| | 180 | This event is signaled with EfiNamedEventSignal(). This provides the ability for one or more\r |
| | 181 | listeners on the same event named by the GUID specified by Name.\r |
| | 182 | If Name is NULL, then ASSERT().\r |
| | 183 | If NotifyTpl is not a legal TPL value, then ASSERT().\r |
| | 184 | If NotifyFunction is NULL, then ASSERT().\r |
| | 185 | \r |
| | 186 | @param Name Supplies GUID name of the event.\r |
| | 187 | @param NotifyTpl Supplies the task priority level of the event notifications.\r |
| | 188 | @param NotifyFunction Supplies the function to notify when the event is signaled.\r |
| | 189 | @param NotifyContext The context parameter to pass to NotifyFunction.\r |
| | 190 | @param Registration A pointer to a memory location to receive the registration value.\r |
| | 191 | \r |
| | 192 | @retval EFI_SUCCESS A named event was created.\r |
| | 193 | @retval EFI_OUT_OF_RESOURCES There are not enough resources to create the named event.\r |
| | 194 | \r |
| | 195 | **/\r |
| | 196 | EFI_STATUS\r |
| | 197 | EFIAPI\r |
| | 198 | EfiNamedEventListen (\r |
| | 199 | IN CONST EFI_GUID *Name,\r |
| | 200 | IN EFI_TPL NotifyTpl,\r |
| | 201 | IN EFI_EVENT_NOTIFY NotifyFunction,\r |
| | 202 | IN CONST VOID *NotifyContext OPTIONAL,\r |
| | 203 | OUT VOID *Registration OPTIONAL\r |
| | 204 | );\r |
| | 205 | \r |
| | 206 | /**\r |
| | 207 | Signals a named event created with EfiNamedEventListen().\r |
| | 208 | \r |
| | 209 | This function signals the named event specified by Name. The named event must have been\r |
| | 210 | created with EfiNamedEventListen().\r |
| | 211 | If Name is NULL, then ASSERT().\r |
| | 212 | \r |
| | 213 | @param Name Supplies the GUID name of the event.\r |
| | 214 | \r |
| | 215 | @retval EFI_SUCCESS A named event was signaled.\r |
| | 216 | @retval EFI_OUT_OF_RESOURCES There are not enough resources to signal the named event.\r |
| | 217 | \r |
| | 218 | **/\r |
| | 219 | EFI_STATUS\r |
| | 220 | EFIAPI\r |
| | 221 | EfiNamedEventSignal (\r |
| | 222 | IN CONST EFI_GUID *Name\r |
| | 223 | );\r |
| | 224 | \r |
| | 225 | /**\r |
| | 226 | Signals an event group by placing a new event in the group temporarily and\r |
| | 227 | signaling it.\r |
| | 228 | \r |
| | 229 | @param[in] EventGroup Supplies the unique identifier of the event\r |
| | 230 | group to signal.\r |
| | 231 | \r |
| | 232 | @retval EFI_SUCCESS The event group was signaled successfully.\r |
| | 233 | @retval EFI_INVALID_PARAMETER EventGroup is NULL.\r |
| | 234 | @return Error codes that report problems about event\r |
| | 235 | creation or signaling.\r |
| | 236 | **/\r |
| | 237 | EFI_STATUS\r |
| | 238 | EFIAPI\r |
| | 239 | EfiEventGroupSignal (\r |
| | 240 | IN CONST EFI_GUID *EventGroup\r |
| | 241 | );\r |
| | 242 | \r |
| | 243 | /**\r |
| | 244 | An empty function that can be used as NotifyFunction parameter of\r |
| | 245 | CreateEvent() or CreateEventEx().\r |
| | 246 | \r |
| | 247 | @param Event Event whose notification function is being invoked.\r |
| | 248 | @param Context The pointer to the notification function's context,\r |
| | 249 | which is implementation-dependent.\r |
| | 250 | \r |
| | 251 | **/\r |
| | 252 | VOID\r |
| | 253 | EFIAPI\r |
| | 254 | EfiEventEmptyFunction (\r |
| | 255 | IN EFI_EVENT Event,\r |
| | 256 | IN VOID *Context\r |
| | 257 | );\r |
| | 258 | \r |
| | 259 | /**\r |
| | 260 | Returns the current TPL.\r |
| | 261 | \r |
| | 262 | This function returns the current TPL. There is no EFI service to directly\r |
| | 263 | retrieve the current TPL. Instead, the RaiseTPL() function is used to raise\r |
| | 264 | the TPL to TPL_HIGH_LEVEL. This will return the current TPL. The TPL level\r |
| | 265 | can then immediately be restored back to the current TPL level with a call\r |
| | 266 | to RestoreTPL().\r |
| | 267 | \r |
| | 268 | @return The current TPL.\r |
| | 269 | \r |
| | 270 | **/\r |
| | 271 | EFI_TPL\r |
| | 272 | EFIAPI\r |
| | 273 | EfiGetCurrentTpl (\r |
| | 274 | VOID\r |
| | 275 | );\r |
| | 276 | \r |
| | 277 | /**\r |
| | 278 | Initializes a basic mutual exclusion lock.\r |
| | 279 | \r |
| | 280 | This function initializes a basic mutual exclusion lock to the released state\r |
| | 281 | and returns the lock. Each lock provides mutual exclusion access at its task\r |
| | 282 | priority level. Since there is no preemption or multiprocessor support in EFI,\r |
| | 283 | acquiring the lock only consists of raising to the locks TPL.\r |
| | 284 | If Lock is NULL, then ASSERT().\r |
| | 285 | If Priority is not a valid TPL value, then ASSERT().\r |
| | 286 | \r |
| | 287 | @param Lock A pointer to the lock data structure to initialize.\r |
| | 288 | @param Priority The EFI TPL associated with the lock.\r |
| | 289 | \r |
| | 290 | @return The lock.\r |
| | 291 | \r |
| | 292 | **/\r |
| | 293 | EFI_LOCK *\r |
| | 294 | EFIAPI\r |
| | 295 | EfiInitializeLock (\r |
| | 296 | IN OUT EFI_LOCK *Lock,\r |
| | 297 | IN EFI_TPL Priority\r |
| | 298 | );\r |
| | 299 | \r |
| | 300 | /**\r |
| | 301 | Initializes a basic mutual exclusion lock.\r |
| | 302 | \r |
| | 303 | This macro initializes the contents of a basic mutual exclusion lock to the\r |
| | 304 | released state. Each lock provides mutual exclusion access at its task\r |
| | 305 | priority level. Since there is no preemption or multiprocessor support in EFI,\r |
| | 306 | acquiring the lock only consists of raising to the locks TPL.\r |
| | 307 | \r |
| | 308 | @param Priority The task priority level of the lock.\r |
| | 309 | \r |
| | 310 | @return The lock.\r |
| | 311 | \r |
| | 312 | **/\r |
| | 313 | #define EFI_INITIALIZE_LOCK_VARIABLE(Priority) \\r |
| | 314 | {Priority, TPL_APPLICATION, EfiLockReleased }\r |
| | 315 | \r |
| | 316 | /**\r |
| | 317 | Macro that calls DebugAssert() if an EFI_LOCK structure is not in the locked state.\r |
| | 318 | \r |
| | 319 | If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED\r |
| | 320 | bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_LOCK\r |
| | 321 | structure specified by Lock. If Lock is not in the locked state, then\r |
| | 322 | DebugAssert() is called passing in the source filename, source line number,\r |
| | 323 | and Lock.\r |
| | 324 | \r |
| | 325 | If Lock is NULL, then ASSERT().\r |
| | 326 | \r |
| | 327 | @param LockParameter A pointer to the lock to acquire.\r |
| | 328 | \r |
| | 329 | **/\r |
| | 330 | #if !defined (MDEPKG_NDEBUG)\r |
| | 331 | #define ASSERT_LOCKED(LockParameter) \\r |
| | 332 | do { \\r |
| | 333 | if (DebugAssertEnabled ()) { \\r |
| | 334 | ASSERT (LockParameter != NULL); \\r |
| | 335 | if ((LockParameter)->Lock != EfiLockAcquired) { \\r |
| | 336 | _ASSERT (LockParameter not locked); \\r |
| | 337 | } \\r |
| | 338 | } \\r |
| | 339 | } while (FALSE)\r |
| | 340 | #else\r |
| | 341 | #define ASSERT_LOCKED(LockParameter)\r |
| | 342 | #endif\r |
| | 343 | \r |
| | 344 | /**\r |
| | 345 | Acquires ownership of a lock.\r |
| | 346 | \r |
| | 347 | This function raises the system's current task priority level to the task\r |
| | 348 | priority level of the mutual exclusion lock. Then, it places the lock in the\r |
| | 349 | acquired state.\r |
| | 350 | If Lock is NULL, then ASSERT().\r |
| | 351 | If Lock is not initialized, then ASSERT().\r |
| | 352 | If Lock is already in the acquired state, then ASSERT().\r |
| | 353 | \r |
| | 354 | @param Lock A pointer to the lock to acquire.\r |
| | 355 | \r |
| | 356 | **/\r |
| | 357 | VOID\r |
| | 358 | EFIAPI\r |
| | 359 | EfiAcquireLock (\r |
| | 360 | IN EFI_LOCK *Lock\r |
| | 361 | );\r |
| | 362 | \r |
| | 363 | /**\r |
| | 364 | Acquires ownership of a lock.\r |
| | 365 | \r |
| | 366 | This function raises the system's current task priority level to the task priority\r |
| | 367 | level of the mutual exclusion lock. Then, it attempts to place the lock in the acquired state.\r |
| | 368 | If the lock is already in the acquired state, then EFI_ACCESS_DENIED is returned.\r |
| | 369 | Otherwise, EFI_SUCCESS is returned.\r |
| | 370 | If Lock is NULL, then ASSERT().\r |
| | 371 | If Lock is not initialized, then ASSERT().\r |
| | 372 | \r |
| | 373 | @param Lock A pointer to the lock to acquire.\r |
| | 374 | \r |
| | 375 | @retval EFI_SUCCESS The lock was acquired.\r |
| | 376 | @retval EFI_ACCESS_DENIED The lock could not be acquired because it is already owned.\r |
| | 377 | \r |
| | 378 | **/\r |
| | 379 | EFI_STATUS\r |
| | 380 | EFIAPI\r |
| | 381 | EfiAcquireLockOrFail (\r |
| | 382 | IN EFI_LOCK *Lock\r |
| | 383 | );\r |
| | 384 | \r |
| | 385 | /**\r |
| | 386 | Releases ownership of a lock.\r |
| | 387 | \r |
| | 388 | This function transitions a mutual exclusion lock from the acquired state to\r |
| | 389 | the released state, and restores the system's task priority level to its\r |
| | 390 | previous level.\r |
| | 391 | If Lock is NULL, then ASSERT().\r |
| | 392 | If Lock is not initialized, then ASSERT().\r |
| | 393 | If Lock is already in the released state, then ASSERT().\r |
| | 394 | \r |
| | 395 | @param Lock A pointer to the lock to release.\r |
| | 396 | \r |
| | 397 | **/\r |
| | 398 | VOID\r |
| | 399 | EFIAPI\r |
| | 400 | EfiReleaseLock (\r |
| | 401 | IN EFI_LOCK *Lock\r |
| | 402 | );\r |
| | 403 | \r |
| | 404 | /**\r |
| | 405 | Tests whether a controller handle is being managed by a specific driver.\r |
| | 406 | \r |
| | 407 | This function tests whether the driver specified by DriverBindingHandle is\r |
| | 408 | currently managing the controller specified by ControllerHandle. This test\r |
| | 409 | is performed by evaluating if the the protocol specified by ProtocolGuid is\r |
| | 410 | present on ControllerHandle and is was opened by DriverBindingHandle with an\r |
| | 411 | attribute of EFI_OPEN_PROTOCOL_BY_DRIVER.\r |
| | 412 | If ProtocolGuid is NULL, then ASSERT().\r |
| | 413 | \r |
| | 414 | @param ControllerHandle A handle for a controller to test.\r |
| | 415 | @param DriverBindingHandle Specifies the driver binding handle for the\r |
| | 416 | driver.\r |
| | 417 | @param ProtocolGuid Specifies the protocol that the driver specified\r |
| | 418 | by DriverBindingHandle opens in its Start()\r |
| | 419 | function.\r |
| | 420 | \r |
| | 421 | @retval EFI_SUCCESS ControllerHandle is managed by the driver\r |
| | 422 | specified by DriverBindingHandle.\r |
| | 423 | @retval EFI_UNSUPPORTED ControllerHandle is not managed by the driver\r |
| | 424 | specified by DriverBindingHandle.\r |
| | 425 | \r |
| | 426 | **/\r |
| | 427 | EFI_STATUS\r |
| | 428 | EFIAPI\r |
| | 429 | EfiTestManagedDevice (\r |
| | 430 | IN CONST EFI_HANDLE ControllerHandle,\r |
| | 431 | IN CONST EFI_HANDLE DriverBindingHandle,\r |
| | 432 | IN CONST EFI_GUID *ProtocolGuid\r |
| | 433 | );\r |
| | 434 | \r |
| | 435 | /**\r |
| | 436 | Tests whether a child handle is a child device of the controller.\r |
| | 437 | \r |
| | 438 | This function tests whether ChildHandle is one of the children of\r |
| | 439 | ControllerHandle. This test is performed by checking to see if the protocol\r |
| | 440 | specified by ProtocolGuid is present on ControllerHandle and opened by\r |
| | 441 | ChildHandle with an attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r |
| | 442 | If ProtocolGuid is NULL, then ASSERT().\r |
| | 443 | \r |
| | 444 | @param ControllerHandle A handle for a (parent) controller to test.\r |
| | 445 | @param ChildHandle A child handle to test.\r |
| | 446 | @param ProtocolGuid Supplies the protocol that the child controller\r |
| | 447 | opens on its parent controller.\r |
| | 448 | \r |
| | 449 | @retval EFI_SUCCESS ChildHandle is a child of the ControllerHandle.\r |
| | 450 | @retval EFI_UNSUPPORTED ChildHandle is not a child of the\r |
| | 451 | ControllerHandle.\r |
| | 452 | \r |
| | 453 | **/\r |
| | 454 | EFI_STATUS\r |
| | 455 | EFIAPI\r |
| | 456 | EfiTestChildHandle (\r |
| | 457 | IN CONST EFI_HANDLE ControllerHandle,\r |
| | 458 | IN CONST EFI_HANDLE ChildHandle,\r |
| | 459 | IN CONST EFI_GUID *ProtocolGuid\r |
| | 460 | );\r |
| | 461 | \r |
| | 462 | /**\r |
| | 463 | This function checks the supported languages list for a target language,\r |
| | 464 | This only supports RFC 4646 Languages.\r |
| | 465 | \r |
| | 466 | @param SupportedLanguages The supported languages\r |
| | 467 | @param TargetLanguage The target language\r |
| | 468 | \r |
| | 469 | @retval Returns EFI_SUCCESS if the language is supported,\r |
| | 470 | EFI_UNSUPPORTED otherwise\r |
| | 471 | \r |
| | 472 | **/\r |
| | 473 | EFI_STATUS\r |
| | 474 | EFIAPI\r |
| | 475 | IsLanguageSupported (\r |
| | 476 | IN CONST CHAR8 *SupportedLanguages,\r |
| | 477 | IN CONST CHAR8 *TargetLanguage\r |
| | 478 | );\r |
| | 479 | \r |
| | 480 | /**\r |
| | 481 | This function looks up a Unicode string in UnicodeStringTable.\r |
| | 482 | \r |
| | 483 | If Language is a member of SupportedLanguages and a Unicode string is found in\r |
| | 484 | UnicodeStringTable that matches the language code specified by Language, then it\r |
| | 485 | is returned in UnicodeString.\r |
| | 486 | \r |
| | 487 | @param Language A pointer to the ISO 639-2 language code for the\r |
| | 488 | Unicode string to look up and return.\r |
| | 489 | @param SupportedLanguages A pointer to the set of ISO 639-2 language codes\r |
| | 490 | that the Unicode string table supports. Language\r |
| | 491 | must be a member of this set.\r |
| | 492 | @param UnicodeStringTable A pointer to the table of Unicode strings.\r |
| | 493 | @param UnicodeString A pointer to the Unicode string from UnicodeStringTable\r |
| | 494 | that matches the language specified by Language.\r |
| | 495 | \r |
| | 496 | @retval EFI_SUCCESS The Unicode string that matches the language\r |
| | 497 | specified by Language was found\r |
| | 498 | in the table of Unicode strings UnicodeStringTable,\r |
| | 499 | and it was returned in UnicodeString.\r |
| | 500 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
| | 501 | @retval EFI_INVALID_PARAMETER UnicodeString is NULL.\r |
| | 502 | @retval EFI_UNSUPPORTED SupportedLanguages is NULL.\r |
| | 503 | @retval EFI_UNSUPPORTED UnicodeStringTable is NULL.\r |
| | 504 | @retval EFI_UNSUPPORTED The language specified by Language is not a\r |
| | 505 | member of SupportedLanguages.\r |
| | 506 | @retval EFI_UNSUPPORTED The language specified by Language is not\r |
| | 507 | supported by UnicodeStringTable.\r |
| | 508 | \r |
| | 509 | **/\r |
| | 510 | EFI_STATUS\r |
| | 511 | EFIAPI\r |
| | 512 | LookupUnicodeString (\r |
| | 513 | IN CONST CHAR8 *Language,\r |
| | 514 | IN CONST CHAR8 *SupportedLanguages,\r |
| | 515 | IN CONST EFI_UNICODE_STRING_TABLE *UnicodeStringTable,\r |
| | 516 | OUT CHAR16 **UnicodeString\r |
| | 517 | );\r |
| | 518 | \r |
| | 519 | /**\r |
| | 520 | This function looks up a Unicode string in UnicodeStringTable.\r |
| | 521 | \r |
| | 522 | If Language is a member of SupportedLanguages and a Unicode string is found in\r |
| | 523 | UnicodeStringTable that matches the language code specified by Language, then\r |
| | 524 | it is returned in UnicodeString.\r |
| | 525 | \r |
| | 526 | @param Language A pointer to an ASCII string containing the ISO 639-2 or the\r |
| | 527 | RFC 4646 language code for the Unicode string to look up and\r |
| | 528 | return. If Iso639Language is TRUE, then this ASCII string is\r |
| | 529 | not assumed to be Null-terminated, and only the first three\r |
| | 530 | characters are used. If Iso639Language is FALSE, then this ASCII\r |
| | 531 | string must be Null-terminated.\r |
| | 532 | @param SupportedLanguages A pointer to a Null-terminated ASCII string that contains a\r |
| | 533 | set of ISO 639-2 or RFC 4646 language codes that the Unicode\r |
| | 534 | string table supports. Language must be a member of this set.\r |
| | 535 | If Iso639Language is TRUE, then this string contains one or more\r |
| | 536 | ISO 639-2 language codes with no separator characters. If Iso639Language\r |
| | 537 | is FALSE, then is string contains one or more RFC 4646 language\r |
| | 538 | codes separated by ';'.\r |
| | 539 | @param UnicodeStringTable A pointer to the table of Unicode strings. Type EFI_UNICODE_STRING_TABLE\r |
| | 540 | is defined in "Related Definitions".\r |
| | 541 | @param UnicodeString A pointer to the Null-terminated Unicode string from UnicodeStringTable\r |
| | 542 | that matches the language specified by Language.\r |
| | 543 | @param Iso639Language Specifies the supported language code format. If it is TRUE, then\r |
| | 544 | Language and SupportedLanguages follow ISO 639-2 language code format.\r |
| | 545 | Otherwise, they follow the RFC 4646 language code format.\r |
| | 546 | \r |
| | 547 | \r |
| | 548 | @retval EFI_SUCCESS The Unicode string that matches the language specified by Language\r |
| | 549 | was found in the table of Unicode strings UnicodeStringTable, and\r |
| | 550 | it was returned in UnicodeString.\r |
| | 551 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
| | 552 | @retval EFI_INVALID_PARAMETER UnicodeString is NULL.\r |
| | 553 | @retval EFI_UNSUPPORTED SupportedLanguages is NULL.\r |
| | 554 | @retval EFI_UNSUPPORTED UnicodeStringTable is NULL.\r |
| | 555 | @retval EFI_UNSUPPORTED The language specified by Language is not a member of SupportedLanguages.\r |
| | 556 | @retval EFI_UNSUPPORTED The language specified by Language is not supported by UnicodeStringTable.\r |
| | 557 | \r |
| | 558 | **/\r |
| | 559 | EFI_STATUS\r |
| | 560 | EFIAPI\r |
| | 561 | LookupUnicodeString2 (\r |
| | 562 | IN CONST CHAR8 *Language,\r |
| | 563 | IN CONST CHAR8 *SupportedLanguages,\r |
| | 564 | IN CONST EFI_UNICODE_STRING_TABLE *UnicodeStringTable,\r |
| | 565 | OUT CHAR16 **UnicodeString,\r |
| | 566 | IN BOOLEAN Iso639Language\r |
| | 567 | );\r |
| | 568 | \r |
| | 569 | /**\r |
| | 570 | This function adds a Unicode string to UnicodeStringTable.\r |
| | 571 | \r |
| | 572 | If Language is a member of SupportedLanguages then UnicodeString is added to\r |
| | 573 | UnicodeStringTable. New buffers are allocated for both Language and\r |
| | 574 | UnicodeString. The contents of Language and UnicodeString are copied into\r |
| | 575 | these new buffers. These buffers are automatically freed when\r |
| | 576 | FreeUnicodeStringTable() is called.\r |
| | 577 | \r |
| | 578 | @param Language A pointer to the ISO 639-2 language code for the Unicode\r |
| | 579 | string to add.\r |
| | 580 | @param SupportedLanguages A pointer to the set of ISO 639-2 language codes\r |
| | 581 | that the Unicode string table supports.\r |
| | 582 | Language must be a member of this set.\r |
| | 583 | @param UnicodeStringTable A pointer to the table of Unicode strings.\r |
| | 584 | @param UnicodeString A pointer to the Unicode string to add.\r |
| | 585 | \r |
| | 586 | @retval EFI_SUCCESS The Unicode string that matches the language\r |
| | 587 | specified by Language was found in the table of\r |
| | 588 | Unicode strings UnicodeStringTable, and it was\r |
| | 589 | returned in UnicodeString.\r |
| | 590 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
| | 591 | @retval EFI_INVALID_PARAMETER UnicodeString is NULL.\r |
| | 592 | @retval EFI_INVALID_PARAMETER UnicodeString is an empty string.\r |
| | 593 | @retval EFI_UNSUPPORTED SupportedLanguages is NULL.\r |
| | 594 | @retval EFI_ALREADY_STARTED A Unicode string with language Language is\r |
| | 595 | already present in UnicodeStringTable.\r |
| | 596 | @retval EFI_OUT_OF_RESOURCES There is not enough memory to add another\r |
| | 597 | Unicode string to UnicodeStringTable.\r |
| | 598 | @retval EFI_UNSUPPORTED The language specified by Language is not a\r |
| | 599 | member of SupportedLanguages.\r |
| | 600 | \r |
| | 601 | **/\r |
| | 602 | EFI_STATUS\r |
| | 603 | EFIAPI\r |
| | 604 | AddUnicodeString (\r |
| | 605 | IN CONST CHAR8 *Language,\r |
| | 606 | IN CONST CHAR8 *SupportedLanguages,\r |
| | 607 | IN OUT EFI_UNICODE_STRING_TABLE **UnicodeStringTable,\r |
| | 608 | IN CONST CHAR16 *UnicodeString\r |
| | 609 | );\r |
| | 610 | \r |
| | 611 | /**\r |
| | 612 | This function adds the Null-terminated Unicode string specified by UnicodeString\r |
| | 613 | to UnicodeStringTable.\r |
| | 614 | \r |
| | 615 | If Language is a member of SupportedLanguages then UnicodeString is added to\r |
| | 616 | UnicodeStringTable. New buffers are allocated for both Language and UnicodeString.\r |
| | 617 | The contents of Language and UnicodeString are copied into these new buffers.\r |
| | 618 | These buffers are automatically freed when EfiLibFreeUnicodeStringTable() is called.\r |
| | 619 | \r |
| | 620 | @param Language A pointer to an ASCII string containing the ISO 639-2 or\r |
| | 621 | the RFC 4646 language code for the Unicode string to add.\r |
| | 622 | If Iso639Language is TRUE, then this ASCII string is not\r |
| | 623 | assumed to be Null-terminated, and only the first three\r |
| | 624 | chacters are used. If Iso639Language is FALSE, then this\r |
| | 625 | ASCII string must be Null-terminated.\r |
| | 626 | @param SupportedLanguages A pointer to a Null-terminated ASCII string that contains\r |
| | 627 | a set of ISO 639-2 or RFC 4646 language codes that the Unicode\r |
| | 628 | string table supports. Language must be a member of this set.\r |
| | 629 | If Iso639Language is TRUE, then this string contains one or more\r |
| | 630 | ISO 639-2 language codes with no separator characters.\r |
| | 631 | If Iso639Language is FALSE, then is string contains one or more\r |
| | 632 | RFC 4646 language codes separated by ';'.\r |
| | 633 | @param UnicodeStringTable A pointer to the table of Unicode strings. Type EFI_UNICODE_STRING_TABLE\r |
| | 634 | is defined in "Related Definitions".\r |
| | 635 | @param UnicodeString A pointer to the Unicode string to add.\r |
| | 636 | @param Iso639Language Specifies the supported language code format. If it is TRUE,\r |
| | 637 | then Language and SupportedLanguages follow ISO 639-2 language code format.\r |
| | 638 | Otherwise, they follow RFC 4646 language code format.\r |
| | 639 | \r |
| | 640 | @retval EFI_SUCCESS The Unicode string that matches the language specified by\r |
| | 641 | Language was found in the table of Unicode strings UnicodeStringTable,\r |
| | 642 | and it was returned in UnicodeString.\r |
| | 643 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
| | 644 | @retval EFI_INVALID_PARAMETER UnicodeString is NULL.\r |
| | 645 | @retval EFI_INVALID_PARAMETER UnicodeString is an empty string.\r |
| | 646 | @retval EFI_UNSUPPORTED SupportedLanguages is NULL.\r |
| | 647 | @retval EFI_ALREADY_STARTED A Unicode string with language Language is already present in\r |
| | 648 | UnicodeStringTable.\r |
| | 649 | @retval EFI_OUT_OF_RESOURCES There is not enough memory to add another Unicode string UnicodeStringTable.\r |
| | 650 | @retval EFI_UNSUPPORTED The language specified by Language is not a member of SupportedLanguages.\r |
| | 651 | \r |
| | 652 | **/\r |
| | 653 | EFI_STATUS\r |
| | 654 | EFIAPI\r |
| | 655 | AddUnicodeString2 (\r |
| | 656 | IN CONST CHAR8 *Language,\r |
| | 657 | IN CONST CHAR8 *SupportedLanguages,\r |
| | 658 | IN OUT EFI_UNICODE_STRING_TABLE **UnicodeStringTable,\r |
| | 659 | IN CONST CHAR16 *UnicodeString,\r |
| | 660 | IN BOOLEAN Iso639Language\r |
| | 661 | );\r |
| | 662 | \r |
| | 663 | /**\r |
| | 664 | This function frees the table of Unicode strings in UnicodeStringTable.\r |
| | 665 | \r |
| | 666 | If UnicodeStringTable is NULL, then EFI_SUCCESS is returned.\r |
| | 667 | Otherwise, each language code, and each Unicode string in the Unicode string\r |
| | 668 | table are freed, and EFI_SUCCESS is returned.\r |
| | 669 | \r |
| | 670 | @param UnicodeStringTable A pointer to the table of Unicode strings.\r |
| | 671 | \r |
| | 672 | @retval EFI_SUCCESS The Unicode string table was freed.\r |
| | 673 | \r |
| | 674 | **/\r |
| | 675 | EFI_STATUS\r |
| | 676 | EFIAPI\r |
| | 677 | FreeUnicodeStringTable (\r |
| | 678 | IN EFI_UNICODE_STRING_TABLE *UnicodeStringTable\r |
| | 679 | );\r |
| | 680 | \r |
| | 681 | /**\r |
| | 682 | Returns the status whether get the variable success. The function retrieves\r |
| | 683 | variable through the UEFI Runtime Service GetVariable(). The\r |
| | 684 | returned buffer is allocated using AllocatePool(). The caller is responsible\r |
| | 685 | for freeing this buffer with FreePool().\r |
| | 686 | \r |
| | 687 | If Name is NULL, then ASSERT().\r |
| | 688 | If Guid is NULL, then ASSERT().\r |
| | 689 | If Value is NULL, then ASSERT().\r |
| | 690 | \r |
| | 691 | @param[in] Name The pointer to a Null-terminated Unicode string.\r |
| | 692 | @param[in] Guid The pointer to an EFI_GUID structure\r |
| | 693 | @param[out] Value The buffer point saved the variable info.\r |
| | 694 | @param[out] Size The buffer size of the variable.\r |
| | 695 | \r |
| | 696 | @retval EFI_OUT_OF_RESOURCES Allocate buffer failed.\r |
| | 697 | @retval EFI_SUCCESS Find the specified variable.\r |
| | 698 | @retval Others Errors Return errors from call to gRT->GetVariable.\r |
| | 699 | \r |
| | 700 | **/\r |
| | 701 | EFI_STATUS\r |
| | 702 | EFIAPI\r |
| | 703 | GetVariable2 (\r |
| | 704 | IN CONST CHAR16 *Name,\r |
| | 705 | IN CONST EFI_GUID *Guid,\r |
| | 706 | OUT VOID **Value,\r |
| | 707 | OUT UINTN *Size OPTIONAL\r |
| | 708 | );\r |
| | 709 | \r |
| | 710 | /**\r |
| | 711 | Returns a pointer to an allocated buffer that contains the contents of a\r |
| | 712 | variable retrieved through the UEFI Runtime Service GetVariable(). This\r |
| | 713 | function always uses the EFI_GLOBAL_VARIABLE GUID to retrieve variables.\r |
| | 714 | The returned buffer is allocated using AllocatePool(). The caller is\r |
| | 715 | responsible for freeing this buffer with FreePool().\r |
| | 716 | \r |
| | 717 | If Name is NULL, then ASSERT().\r |
| | 718 | If Value is NULL, then ASSERT().\r |
| | 719 | \r |
| | 720 | @param[in] Name The pointer to a Null-terminated Unicode string.\r |
| | 721 | @param[out] Value The buffer point saved the variable info.\r |
| | 722 | @param[out] Size The buffer size of the variable.\r |
| | 723 | \r |
| | 724 | @retval EFI_OUT_OF_RESOURCES Allocate buffer failed.\r |
| | 725 | @retval EFI_SUCCESS Find the specified variable.\r |
| | 726 | @retval Others Errors Return errors from call to gRT->GetVariable.\r |
| | 727 | \r |
| | 728 | **/\r |
| | 729 | EFI_STATUS\r |
| | 730 | EFIAPI\r |
| | 731 | GetEfiGlobalVariable2 (\r |
| | 732 | IN CONST CHAR16 *Name,\r |
| | 733 | OUT VOID **Value,\r |
| | 734 | OUT UINTN *Size OPTIONAL\r |
| | 735 | );\r |
| | 736 | \r |
| | 737 | /** Return the attributes of the variable.\r |
| | 738 | \r |
| | 739 | Returns the status whether get the variable success. The function retrieves\r |
| | 740 | variable through the UEFI Runtime Service GetVariable(). The\r |
| | 741 | returned buffer is allocated using AllocatePool(). The caller is responsible\r |
| | 742 | for freeing this buffer with FreePool(). The attributes are returned if\r |
| | 743 | the caller provides a valid Attribute parameter.\r |
| | 744 | \r |
| | 745 | If Name is NULL, then ASSERT().\r |
| | 746 | If Guid is NULL, then ASSERT().\r |
| | 747 | If Value is NULL, then ASSERT().\r |
| | 748 | \r |
| | 749 | @param[in] Name The pointer to a Null-terminated Unicode string.\r |
| | 750 | @param[in] Guid The pointer to an EFI_GUID structure\r |
| | 751 | @param[out] Value The buffer point saved the variable info.\r |
| | 752 | @param[out] Size The buffer size of the variable.\r |
| | 753 | @param[out] Attr The pointer to the variable attributes as found in var store\r |
| | 754 | \r |
| | 755 | @retval EFI_OUT_OF_RESOURCES Allocate buffer failed.\r |
| | 756 | @retval EFI_SUCCESS Find the specified variable.\r |
| | 757 | @retval Others Errors Return errors from call to gRT->GetVariable.\r |
| | 758 | \r |
| | 759 | **/\r |
| | 760 | EFI_STATUS\r |
| | 761 | EFIAPI\r |
| | 762 | GetVariable3 (\r |
| | 763 | IN CONST CHAR16 *Name,\r |
| | 764 | IN CONST EFI_GUID *Guid,\r |
| | 765 | OUT VOID **Value,\r |
| | 766 | OUT UINTN *Size OPTIONAL,\r |
| | 767 | OUT UINT32 *Attr OPTIONAL\r |
| | 768 | );\r |
| | 769 | \r |
| | 770 | /**\r |
| | 771 | Returns a pointer to an allocated buffer that contains the best matching language\r |
| | 772 | from a set of supported languages.\r |
| | 773 | \r |
| | 774 | This function supports both ISO 639-2 and RFC 4646 language codes, but language\r |
| | 775 | code types may not be mixed in a single call to this function. The language\r |
| | 776 | code returned is allocated using AllocatePool(). The caller is responsible for\r |
| | 777 | freeing the allocated buffer using FreePool(). This function supports a variable\r |
| | 778 | argument list that allows the caller to pass in a prioritized list of language\r |
| | 779 | codes to test against all the language codes in SupportedLanguages.\r |
| | 780 | \r |
| | 781 | If SupportedLanguages is NULL, then ASSERT().\r |
| | 782 | \r |
| | 783 | @param[in] SupportedLanguages A pointer to a Null-terminated ASCII string that\r |
| | 784 | contains a set of language codes in the format\r |
| | 785 | specified by Iso639Language.\r |
| | 786 | @param[in] Iso639Language If not zero, then all language codes are assumed to be\r |
| | 787 | in ISO 639-2 format. If zero, then all language\r |
| | 788 | codes are assumed to be in RFC 4646 language format\r |
| | 789 | @param[in] ... A variable argument list that contains pointers to\r |
| | 790 | Null-terminated ASCII strings that contain one or more\r |
| | 791 | language codes in the format specified by Iso639Language.\r |
| | 792 | The first language code from each of these language\r |
| | 793 | code lists is used to determine if it is an exact or\r |
| | 794 | close match to any of the language codes in\r |
| | 795 | SupportedLanguages. Close matches only apply to RFC 4646\r |
| | 796 | language codes, and the matching algorithm from RFC 4647\r |
| | 797 | is used to determine if a close match is present. If\r |
| | 798 | an exact or close match is found, then the matching\r |
| | 799 | language code from SupportedLanguages is returned. If\r |
| | 800 | no matches are found, then the next variable argument\r |
| | 801 | parameter is evaluated. The variable argument list\r |
| | 802 | is terminated by a NULL.\r |
| | 803 | \r |
| | 804 | @retval NULL The best matching language could not be found in SupportedLanguages.\r |
| | 805 | @retval NULL There are not enough resources available to return the best matching\r |
| | 806 | language.\r |
| | 807 | @retval Other A pointer to a Null-terminated ASCII string that is the best matching\r |
| | 808 | language in SupportedLanguages.\r |
| | 809 | \r |
| | 810 | **/\r |
| | 811 | CHAR8 *\r |
| | 812 | EFIAPI\r |
| | 813 | GetBestLanguage (\r |
| | 814 | IN CONST CHAR8 *SupportedLanguages,\r |
| | 815 | IN UINTN Iso639Language,\r |
| | 816 | ...\r |
| | 817 | );\r |
| | 818 | \r |
| | 819 | /**\r |
| | 820 | Draws a dialog box to the console output device specified by\r |
| | 821 | ConOut defined in the EFI_SYSTEM_TABLE and waits for a keystroke\r |
| | 822 | from the console input device specified by ConIn defined in the\r |
| | 823 | EFI_SYSTEM_TABLE.\r |
| | 824 | \r |
| | 825 | If there are no strings in the variable argument list, then ASSERT().\r |
| | 826 | If all the strings in the variable argument list are empty, then ASSERT().\r |
| | 827 | \r |
| | 828 | @param[in] Attribute Specifies the foreground and background color of the popup.\r |
| | 829 | @param[out] Key A pointer to the EFI_KEY value of the key that was\r |
| | 830 | pressed. This is an optional parameter that may be NULL.\r |
| | 831 | If it is NULL then no wait for a keypress will be performed.\r |
| | 832 | @param[in] ... The variable argument list that contains pointers to Null-\r |
| | 833 | terminated Unicode strings to display in the dialog box.\r |
| | 834 | The variable argument list is terminated by a NULL.\r |
| | 835 | \r |
| | 836 | **/\r |
| | 837 | VOID\r |
| | 838 | EFIAPI\r |
| | 839 | CreatePopUp (\r |
| | 840 | IN UINTN Attribute,\r |
| | 841 | OUT EFI_INPUT_KEY *Key OPTIONAL,\r |
| | 842 | ...\r |
| | 843 | );\r |
| | 844 | \r |
| | 845 | /**\r |
| | 846 | Retrieves the width of a Unicode character.\r |
| | 847 | \r |
| | 848 | This function computes and returns the width of the Unicode character specified\r |
| | 849 | by UnicodeChar.\r |
| | 850 | \r |
| | 851 | @param UnicodeChar A Unicode character.\r |
| | 852 | \r |
| | 853 | @retval 0 The width if UnicodeChar could not be determined.\r |
| | 854 | @retval 1 UnicodeChar is a narrow glyph.\r |
| | 855 | @retval 2 UnicodeChar is a wide glyph.\r |
| | 856 | \r |
| | 857 | **/\r |
| | 858 | UINTN\r |
| | 859 | EFIAPI\r |
| | 860 | GetGlyphWidth (\r |
| | 861 | IN CHAR16 UnicodeChar\r |
| | 862 | );\r |
| | 863 | \r |
| | 864 | /**\r |
| | 865 | Computes the display length of a Null-terminated Unicode String.\r |
| | 866 | \r |
| | 867 | This function computes and returns the display length of the Null-terminated Unicode\r |
| | 868 | string specified by String. If String is NULL then 0 is returned. If any of the widths\r |
| | 869 | of the Unicode characters in String can not be determined, then 0 is returned. The display\r |
| | 870 | width of String can be computed by summing the display widths of each Unicode character\r |
| | 871 | in String. Unicode characters that are narrow glyphs have a width of 1, and Unicode\r |
| | 872 | characters that are width glyphs have a width of 2.\r |
| | 873 | If String is not aligned on a 16-bit boundary, then ASSERT().\r |
| | 874 | \r |
| | 875 | @param String A pointer to a Null-terminated Unicode string.\r |
| | 876 | \r |
| | 877 | @return The display length of the Null-terminated Unicode string specified by String.\r |
| | 878 | \r |
| | 879 | **/\r |
| | 880 | UINTN\r |
| | 881 | EFIAPI\r |
| | 882 | UnicodeStringDisplayLength (\r |
| | 883 | IN CONST CHAR16 *String\r |
| | 884 | );\r |
| | 885 | \r |
| | 886 | //\r |
| | 887 | // Functions that abstract early Framework contamination of UEFI.\r |
| | 888 | //\r |
| | 889 | \r |
| | 890 | /**\r |
| | 891 | Create, Signal, and Close the Ready to Boot event using EfiSignalEventReadyToBoot().\r |
| | 892 | \r |
| | 893 | This function abstracts the signaling of the Ready to Boot Event. The Framework moved\r |
| | 894 | from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller\r |
| | 895 | from how this event is created to prevent to code form having to change with the\r |
| | 896 | version of the specification supported.\r |
| | 897 | \r |
| | 898 | **/\r |
| | 899 | VOID\r |
| | 900 | EFIAPI\r |
| | 901 | EfiSignalEventReadyToBoot (\r |
| | 902 | VOID\r |
| | 903 | );\r |
| | 904 | \r |
| | 905 | /**\r |
| | 906 | Create, Signal, and Close the Ready to Boot event using EfiSignalEventLegacyBoot().\r |
| | 907 | \r |
| | 908 | This function abstracts the signaling of the Legacy Boot Event. The Framework moved from\r |
| | 909 | a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from how\r |
| | 910 | this event is created to prevent to code form having to change with the version of the\r |
| | 911 | specification supported.\r |
| | 912 | \r |
| | 913 | **/\r |
| | 914 | VOID\r |
| | 915 | EFIAPI\r |
| | 916 | EfiSignalEventLegacyBoot (\r |
| | 917 | VOID\r |
| | 918 | );\r |
| | 919 | \r |
| | 920 | /**\r |
| | 921 | Creates an EFI event in the Legacy Boot Event Group.\r |
| | 922 | \r |
| | 923 | Prior to UEFI 2.0 this was done via a non blessed UEFI extensions and this library\r |
| | 924 | abstracts the implementation mechanism of this event from the caller. This function\r |
| | 925 | abstracts the creation of the Legacy Boot Event. The Framework moved from a proprietary\r |
| | 926 | to UEFI 2.0 based mechanism. This library abstracts the caller from how this event\r |
| | 927 | is created to prevent to code form having to change with the version of the\r |
| | 928 | specification supported.\r |
| | 929 | If LegacyBootEvent is NULL, then ASSERT().\r |
| | 930 | \r |
| | 931 | @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r |
| | 932 | \r |
| | 933 | @retval EFI_SUCCESS The event was created.\r |
| | 934 | @retval Other The event was not created.\r |
| | 935 | \r |
| | 936 | **/\r |
| | 937 | EFI_STATUS\r |
| | 938 | EFIAPI\r |
| | 939 | EfiCreateEventLegacyBoot (\r |
| | 940 | OUT EFI_EVENT *LegacyBootEvent\r |
| | 941 | );\r |
| | 942 | \r |
| | 943 | /**\r |
| | 944 | Create an EFI event in the Legacy Boot Event Group and allows\r |
| | 945 | the caller to specify a notification function.\r |
| | 946 | \r |
| | 947 | This function abstracts the creation of the Legacy Boot Event.\r |
| | 948 | The Framework moved from a proprietary to UEFI 2.0 based mechanism.\r |
| | 949 | This library abstracts the caller from how this event is created to prevent\r |
| | 950 | to code form having to change with the version of the specification supported.\r |
| | 951 | If LegacyBootEvent is NULL, then ASSERT().\r |
| | 952 | \r |
| | 953 | @param NotifyTpl The task priority level of the event.\r |
| | 954 | @param NotifyFunction The notification function to call when the event is signaled.\r |
| | 955 | @param NotifyContext The content to pass to NotifyFunction when the event is signaled.\r |
| | 956 | @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r |
| | 957 | \r |
| | 958 | @retval EFI_SUCCESS The event was created.\r |
| | 959 | @retval Other The event was not created.\r |
| | 960 | \r |
| | 961 | **/\r |
| | 962 | EFI_STATUS\r |
| | 963 | EFIAPI\r |
| | 964 | EfiCreateEventLegacyBootEx (\r |
| | 965 | IN EFI_TPL NotifyTpl,\r |
| | 966 | IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,\r |
| | 967 | IN VOID *NotifyContext OPTIONAL,\r |
| | 968 | OUT EFI_EVENT *LegacyBootEvent\r |
| | 969 | );\r |
| | 970 | \r |
| | 971 | /**\r |
| | 972 | Create an EFI event in the Ready To Boot Event Group.\r |
| | 973 | \r |
| | 974 | Prior to UEFI 2.0 this was done via a non-standard UEFI extension, and this library\r |
| | 975 | abstracts the implementation mechanism of this event from the caller.\r |
| | 976 | This function abstracts the creation of the Ready to Boot Event. The Framework\r |
| | 977 | moved from a proprietary to UEFI 2.0-based mechanism. This library abstracts\r |
| | 978 | the caller from how this event is created to prevent the code form having to\r |
| | 979 | change with the version of the specification supported.\r |
| | 980 | If ReadyToBootEvent is NULL, then ASSERT().\r |
| | 981 | \r |
| | 982 | @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r |
| | 983 | \r |
| | 984 | @retval EFI_SUCCESS The event was created.\r |
| | 985 | @retval Other The event was not created.\r |
| | 986 | \r |
| | 987 | **/\r |
| | 988 | EFI_STATUS\r |
| | 989 | EFIAPI\r |
| | 990 | EfiCreateEventReadyToBoot (\r |
| | 991 | OUT EFI_EVENT *ReadyToBootEvent\r |
| | 992 | );\r |
| | 993 | \r |
| | 994 | /**\r |
| | 995 | Create an EFI event in the Ready To Boot Event Group and allows\r |
| | 996 | the caller to specify a notification function.\r |
| | 997 | \r |
| | 998 | This function abstracts the creation of the Ready to Boot Event.\r |
| | 999 | The Framework moved from a proprietary to UEFI 2.0 based mechanism.\r |
| | 1000 | This library abstracts the caller from how this event is created to prevent\r |
| | 1001 | to code form having to change with the version of the specification supported.\r |
| | 1002 | If ReadyToBootEvent is NULL, then ASSERT().\r |
| | 1003 | \r |
| | 1004 | @param NotifyTpl The task priority level of the event.\r |
| | 1005 | @param NotifyFunction The notification function to call when the event is signaled.\r |
| | 1006 | @param NotifyContext The content to pass to NotifyFunction when the event is signaled.\r |
| | 1007 | @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r |
| | 1008 | \r |
| | 1009 | @retval EFI_SUCCESS The event was created.\r |
| | 1010 | @retval Other The event was not created.\r |
| | 1011 | \r |
| | 1012 | **/\r |
| | 1013 | EFI_STATUS\r |
| | 1014 | EFIAPI\r |
| | 1015 | EfiCreateEventReadyToBootEx (\r |
| | 1016 | IN EFI_TPL NotifyTpl,\r |
| | 1017 | IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,\r |
| | 1018 | IN VOID *NotifyContext OPTIONAL,\r |
| | 1019 | OUT EFI_EVENT *ReadyToBootEvent\r |
| | 1020 | );\r |
| | 1021 | \r |
| | 1022 | /**\r |
| | 1023 | Initialize a Firmware Volume (FV) Media Device Path node.\r |
| | 1024 | \r |
| | 1025 | The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification.\r |
| | 1026 | This library function abstracts initializing a device path node.\r |
| | 1027 | Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device\r |
| | 1028 | path changed in the DXE CIS version 0.92 in a non back ward compatible way to\r |
| | 1029 | not conflict with the UEFI 2.0 specification. This function abstracts the\r |
| | 1030 | differences from the caller.\r |
| | 1031 | If FvDevicePathNode is NULL, then ASSERT().\r |
| | 1032 | If NameGuid is NULL, then ASSERT().\r |
| | 1033 | \r |
| | 1034 | @param FvDevicePathNode The pointer to a FV device path node to initialize\r |
| | 1035 | @param NameGuid FV file name to use in FvDevicePathNode\r |
| | 1036 | \r |
| | 1037 | **/\r |
| | 1038 | VOID\r |
| | 1039 | EFIAPI\r |
| | 1040 | EfiInitializeFwVolDevicepathNode (\r |
| | 1041 | IN OUT MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode,\r |
| | 1042 | IN CONST EFI_GUID *NameGuid\r |
| | 1043 | );\r |
| | 1044 | \r |
| | 1045 | /**\r |
| | 1046 | Check to see if the Firmware Volume (FV) Media Device Path is valid\r |
| | 1047 | \r |
| | 1048 | The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification.\r |
| | 1049 | This library function abstracts validating a device path node.\r |
| | 1050 | Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid.\r |
| | 1051 | If it is valid, then return the GUID file name from the device path node. Otherwise,\r |
| | 1052 | return NULL. This device path changed in the DXE CIS version 0.92 in a non backward\r |
| | 1053 | compatible way to not conflict with the UEFI 2.0 specification. This function abstracts\r |
| | 1054 | the differences from the caller.\r |
| | 1055 | If FvDevicePathNode is NULL, then ASSERT().\r |
| | 1056 | \r |
| | 1057 | @param FvDevicePathNode The pointer to FV device path to check.\r |
| | 1058 | \r |
| | 1059 | @retval NULL FvDevicePathNode is not valid.\r |
| | 1060 | @retval Other FvDevicePathNode is valid and pointer to NameGuid was returned.\r |
| | 1061 | \r |
| | 1062 | **/\r |
| | 1063 | EFI_GUID *\r |
| | 1064 | EFIAPI\r |
| | 1065 | EfiGetNameGuidFromFwVolDevicePathNode (\r |
| | 1066 | IN CONST MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode\r |
| | 1067 | );\r |
| | 1068 | \r |
| | 1069 | /**\r |
| | 1070 | Prints a formatted Unicode string to the console output device specified by\r |
| | 1071 | ConOut defined in the EFI_SYSTEM_TABLE.\r |
| | 1072 | \r |
| | 1073 | This function prints a formatted Unicode string to the console output device\r |
| | 1074 | specified by ConOut in EFI_SYSTEM_TABLE and returns the number of Unicode\r |
| | 1075 | characters that printed to ConOut. If the length of the formatted Unicode\r |
| | 1076 | string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r |
| | 1077 | PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r |
| | 1078 | If Format is NULL, then ASSERT().\r |
| | 1079 | If Format is not aligned on a 16-bit boundary, then ASSERT().\r |
| | 1080 | If gST->ConOut is NULL, then ASSERT().\r |
| | 1081 | \r |
| | 1082 | @param Format A null-terminated Unicode format string.\r |
| | 1083 | @param ... The variable argument list whose contents are accessed based\r |
| | 1084 | on the format string specified by Format.\r |
| | 1085 | \r |
| | 1086 | @return Number of Unicode characters printed to ConOut.\r |
| | 1087 | \r |
| | 1088 | **/\r |
| | 1089 | UINTN\r |
| | 1090 | EFIAPI\r |
| | 1091 | Print (\r |
| | 1092 | IN CONST CHAR16 *Format,\r |
| | 1093 | ...\r |
| | 1094 | );\r |
| | 1095 | \r |
| | 1096 | /**\r |
| | 1097 | Prints a formatted Unicode string to the console output device specified by\r |
| | 1098 | StdErr defined in the EFI_SYSTEM_TABLE.\r |
| | 1099 | \r |
| | 1100 | This function prints a formatted Unicode string to the console output device\r |
| | 1101 | specified by StdErr in EFI_SYSTEM_TABLE and returns the number of Unicode\r |
| | 1102 | characters that printed to StdErr. If the length of the formatted Unicode\r |
| | 1103 | string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r |
| | 1104 | PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r |
| | 1105 | If Format is NULL, then ASSERT().\r |
| | 1106 | If Format is not aligned on a 16-bit boundary, then ASSERT().\r |
| | 1107 | If gST->StdErr is NULL, then ASSERT().\r |
| | 1108 | \r |
| | 1109 | @param Format A null-terminated Unicode format string.\r |
| | 1110 | @param ... The variable argument list whose contents are accessed based\r |
| | 1111 | on the format string specified by Format.\r |
| | 1112 | \r |
| | 1113 | @return Number of Unicode characters printed to StdErr.\r |
| | 1114 | \r |
| | 1115 | **/\r |
| | 1116 | UINTN\r |
| | 1117 | EFIAPI\r |
| | 1118 | ErrorPrint (\r |
| | 1119 | IN CONST CHAR16 *Format,\r |
| | 1120 | ...\r |
| | 1121 | );\r |
| | 1122 | \r |
| | 1123 | /**\r |
| | 1124 | Prints a formatted ASCII string to the console output device specified by\r |
| | 1125 | ConOut defined in the EFI_SYSTEM_TABLE.\r |
| | 1126 | \r |
| | 1127 | This function prints a formatted ASCII string to the console output device\r |
| | 1128 | specified by ConOut in EFI_SYSTEM_TABLE and returns the number of ASCII\r |
| | 1129 | characters that printed to ConOut. If the length of the formatted ASCII\r |
| | 1130 | string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r |
| | 1131 | PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r |
| | 1132 | If Format is NULL, then ASSERT().\r |
| | 1133 | If gST->ConOut is NULL, then ASSERT().\r |
| | 1134 | \r |
| | 1135 | @param Format A null-terminated ASCII format string.\r |
| | 1136 | @param ... The variable argument list whose contents are accessed based\r |
| | 1137 | on the format string specified by Format.\r |
| | 1138 | \r |
| | 1139 | @return Number of ASCII characters printed to ConOut.\r |
| | 1140 | \r |
| | 1141 | **/\r |
| | 1142 | UINTN\r |
| | 1143 | EFIAPI\r |
| | 1144 | AsciiPrint (\r |
| | 1145 | IN CONST CHAR8 *Format,\r |
| | 1146 | ...\r |
| | 1147 | );\r |
| | 1148 | \r |
| | 1149 | /**\r |
| | 1150 | Prints a formatted ASCII string to the console output device specified by\r |
| | 1151 | StdErr defined in the EFI_SYSTEM_TABLE.\r |
| | 1152 | \r |
| | 1153 | This function prints a formatted ASCII string to the console output device\r |
| | 1154 | specified by StdErr in EFI_SYSTEM_TABLE and returns the number of ASCII\r |
| | 1155 | characters that printed to StdErr. If the length of the formatted ASCII\r |
| | 1156 | string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r |
| | 1157 | PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r |
| | 1158 | If Format is NULL, then ASSERT().\r |
| | 1159 | If gST->StdErr is NULL, then ASSERT().\r |
| | 1160 | \r |
| | 1161 | @param Format A null-terminated ASCII format string.\r |
| | 1162 | @param ... The variable argument list whose contents are accessed based\r |
| | 1163 | on the format string specified by Format.\r |
| | 1164 | \r |
| | 1165 | @return Number of ASCII characters printed to ConErr.\r |
| | 1166 | \r |
| | 1167 | **/\r |
| | 1168 | UINTN\r |
| | 1169 | EFIAPI\r |
| | 1170 | AsciiErrorPrint (\r |
| | 1171 | IN CONST CHAR8 *Format,\r |
| | 1172 | ...\r |
| | 1173 | );\r |
| | 1174 | \r |
| | 1175 | /**\r |
| | 1176 | Prints a formatted Unicode string to a graphics console device specified by\r |
| | 1177 | ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.\r |
| | 1178 | \r |
| | 1179 | This function prints a formatted Unicode string to the graphics console device\r |
| | 1180 | specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of\r |
| | 1181 | Unicode characters displayed, not including partial characters that may be clipped\r |
| | 1182 | by the right edge of the display. If the length of the formatted Unicode string is\r |
| | 1183 | greater than PcdUefiLibMaxPrintBufferSize, then at most the first\r |
| | 1184 | PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL\r |
| | 1185 | is used to convert the string to a bitmap using the glyphs registered with the\r |
| | 1186 | HII database. No wrapping is performed, so any portions of the string the fall\r |
| | 1187 | outside the active display region will not be displayed.\r |
| | 1188 | \r |
| | 1189 | If a graphics console device is not associated with the ConsoleOutputHandle\r |
| | 1190 | defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.\r |
| | 1191 | If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no\r |
| | 1192 | string is printed, and 0 is returned.\r |
| | 1193 | If Format is NULL, then ASSERT().\r |
| | 1194 | If Format is not aligned on a 16-bit boundary, then ASSERT().\r |
| | 1195 | If gST->ConsoleOutputHandle is NULL, then ASSERT().\r |
| | 1196 | \r |
| | 1197 | @param PointX X coordinate to print the string.\r |
| | 1198 | @param PointY Y coordinate to print the string.\r |
| | 1199 | @param ForeGround The foreground color of the string being printed. This is\r |
| | 1200 | an optional parameter that may be NULL. If it is NULL,\r |
| | 1201 | then the foreground color of the current ConOut device\r |
| | 1202 | in the EFI_SYSTEM_TABLE is used.\r |
| | 1203 | @param BackGround The background color of the string being printed. This is\r |
| | 1204 | an optional parameter that may be NULL. If it is NULL,\r |
| | 1205 | then the background color of the current ConOut device\r |
| | 1206 | in the EFI_SYSTEM_TABLE is used.\r |
| | 1207 | @param Format A null-terminated Unicode format string. See Print Library\r |
| | 1208 | for the supported format string syntax.\r |
| | 1209 | @param ... Variable argument list whose contents are accessed based on\r |
| | 1210 | the format string specified by Format.\r |
| | 1211 | \r |
| | 1212 | @return The number of Unicode characters printed.\r |
| | 1213 | \r |
| | 1214 | **/\r |
| | 1215 | UINTN\r |
| | 1216 | EFIAPI\r |
| | 1217 | PrintXY (\r |
| | 1218 | IN UINTN PointX,\r |
| | 1219 | IN UINTN PointY,\r |
| | 1220 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround OPTIONAL,\r |
| | 1221 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround OPTIONAL,\r |
| | 1222 | IN CONST CHAR16 *Format,\r |
| | 1223 | ...\r |
| | 1224 | );\r |
| | 1225 | \r |
| | 1226 | /**\r |
| | 1227 | Prints a formatted ASCII string to a graphics console device specified by\r |
| | 1228 | ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.\r |
| | 1229 | \r |
| | 1230 | This function prints a formatted ASCII string to the graphics console device\r |
| | 1231 | specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of\r |
| | 1232 | ASCII characters displayed, not including partial characters that may be clipped\r |
| | 1233 | by the right edge of the display. If the length of the formatted ASCII string is\r |
| | 1234 | greater than PcdUefiLibMaxPrintBufferSize, then at most the first\r |
| | 1235 | PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL\r |
| | 1236 | is used to convert the string to a bitmap using the glyphs registered with the\r |
| | 1237 | HII database. No wrapping is performed, so any portions of the string the fall\r |
| | 1238 | outside the active display region will not be displayed.\r |
| | 1239 | \r |
| | 1240 | If a graphics console device is not associated with the ConsoleOutputHandle\r |
| | 1241 | defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.\r |
| | 1242 | If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no\r |
| | 1243 | string is printed, and 0 is returned.\r |
| | 1244 | If Format is NULL, then ASSERT().\r |
| | 1245 | If gST->ConsoleOutputHandle is NULL, then ASSERT().\r |
| | 1246 | \r |
| | 1247 | @param PointX X coordinate to print the string.\r |
| | 1248 | @param PointY Y coordinate to print the string.\r |
| | 1249 | @param ForeGround The foreground color of the string being printed. This is\r |
| | 1250 | an optional parameter that may be NULL. If it is NULL,\r |
| | 1251 | then the foreground color of the current ConOut device\r |
| | 1252 | in the EFI_SYSTEM_TABLE is used.\r |
| | 1253 | @param BackGround The background color of the string being printed. This is\r |
| | 1254 | an optional parameter that may be NULL. If it is NULL,\r |
| | 1255 | then the background color of the current ConOut device\r |
| | 1256 | in the EFI_SYSTEM_TABLE is used.\r |
| | 1257 | @param Format A null-terminated ASCII format string. See Print Library\r |
| | 1258 | for the supported format string syntax.\r |
| | 1259 | @param ... The variable argument list whose contents are accessed based on\r |
| | 1260 | the format string specified by Format.\r |
| | 1261 | \r |
| | 1262 | @return The number of ASCII characters printed.\r |
| | 1263 | \r |
| | 1264 | **/\r |
| | 1265 | UINTN\r |
| | 1266 | EFIAPI\r |
| | 1267 | AsciiPrintXY (\r |
| | 1268 | IN UINTN PointX,\r |
| | 1269 | IN UINTN PointY,\r |
| | 1270 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround OPTIONAL,\r |
| | 1271 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround OPTIONAL,\r |
| | 1272 | IN CONST CHAR8 *Format,\r |
| | 1273 | ...\r |
| | 1274 | );\r |
| | 1275 | \r |
| | 1276 | /**\r |
| | 1277 | Installs and completes the initialization of a Driver Binding Protocol instance.\r |
| | 1278 | \r |
| | 1279 | Installs the Driver Binding Protocol specified by DriverBinding onto the handle\r |
| | 1280 | specified by DriverBindingHandle. If DriverBindingHandle is NULL, then DriverBinding\r |
| | 1281 | is installed onto a newly created handle. DriverBindingHandle is typically the same\r |
| | 1282 | as the driver's ImageHandle, but it can be different if the driver produces multiple\r |
| | 1283 | Driver Binding Protocols.\r |
| | 1284 | If DriverBinding is NULL, then ASSERT().\r |
| | 1285 | If DriverBinding can not be installed onto a handle, then ASSERT().\r |
| | 1286 | \r |
| | 1287 | @param ImageHandle The image handle of the driver.\r |
| | 1288 | @param SystemTable The EFI System Table that was passed to the driver's entry point.\r |
| | 1289 | @param DriverBinding A Driver Binding Protocol instance that this driver is producing.\r |
| | 1290 | @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this\r |
| | 1291 | parameter is NULL, then a new handle is created.\r |
| | 1292 | \r |
| | 1293 | @retval EFI_SUCCESS The protocol installation completed successfully.\r |
| | 1294 | @retval EFI_OUT_OF_RESOURCES There was not enough system resources to install the protocol.\r |
| | 1295 | @retval Others Status from gBS->InstallMultipleProtocolInterfaces().\r |
| | 1296 | \r |
| | 1297 | **/\r |
| | 1298 | EFI_STATUS\r |
| | 1299 | EFIAPI\r |
| | 1300 | EfiLibInstallDriverBinding (\r |
| | 1301 | IN CONST EFI_HANDLE ImageHandle,\r |
| | 1302 | IN CONST EFI_SYSTEM_TABLE *SystemTable,\r |
| | 1303 | IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r |
| | 1304 | IN EFI_HANDLE DriverBindingHandle\r |
| | 1305 | );\r |
| | 1306 | \r |
| | 1307 | /**\r |
| | 1308 | Uninstalls a Driver Binding Protocol instance.\r |
| | 1309 | \r |
| | 1310 | If DriverBinding is NULL, then ASSERT().\r |
| | 1311 | If DriverBinding can not be uninstalled, then ASSERT().\r |
| | 1312 | \r |
| | 1313 | @param DriverBinding A Driver Binding Protocol instance that this driver produced.\r |
| | 1314 | \r |
| | 1315 | @retval EFI_SUCCESS The protocol uninstallation successfully completed.\r |
| | 1316 | @retval Others Status from gBS->UninstallMultipleProtocolInterfaces().\r |
| | 1317 | \r |
| | 1318 | **/\r |
| | 1319 | EFI_STATUS\r |
| | 1320 | EFIAPI\r |
| | 1321 | EfiLibUninstallDriverBinding (\r |
| | 1322 | IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding\r |
| | 1323 | );\r |
| | 1324 | \r |
| | 1325 | /**\r |
| | 1326 | Installs and completes the initialization of a Driver Binding Protocol instance and\r |
| | 1327 | optionally installs the Component Name, Driver Configuration and Driver Diagnostics Protocols.\r |
| | 1328 | \r |
| | 1329 | Initializes a driver by installing the Driver Binding Protocol together with the\r |
| | 1330 | optional Component Name, optional Driver Configure and optional Driver Diagnostic\r |
| | 1331 | Protocols onto the driver's DriverBindingHandle. If DriverBindingHandle is NULL,\r |
| | 1332 | then the protocols are installed onto a newly created handle. DriverBindingHandle\r |
| | 1333 | is typically the same as the driver's ImageHandle, but it can be different if the\r |
| | 1334 | driver produces multiple Driver Binding Protocols.\r |
| | 1335 | If DriverBinding is NULL, then ASSERT().\r |
| | 1336 | If the installation fails, then ASSERT().\r |
| | 1337 | \r |
| | 1338 | @param ImageHandle The image handle of the driver.\r |
| | 1339 | @param SystemTable The EFI System Table that was passed to the driver's entry point.\r |
| | 1340 | @param DriverBinding A Driver Binding Protocol instance that this driver is producing.\r |
| | 1341 | @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this\r |
| | 1342 | parameter is NULL, then a new handle is created.\r |
| | 1343 | @param ComponentName A Component Name Protocol instance that this driver is producing.\r |
| | 1344 | @param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.\r |
| | 1345 | @param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.\r |
| | 1346 | \r |
| | 1347 | @retval EFI_SUCCESS The protocol installation completed successfully.\r |
| | 1348 | @retval EFI_OUT_OF_RESOURCES There was not enough memory in the pool to install all the protocols.\r |
| | 1349 | \r |
| | 1350 | **/\r |
| | 1351 | EFI_STATUS\r |
| | 1352 | EFIAPI\r |
| | 1353 | EfiLibInstallAllDriverProtocols (\r |
| | 1354 | IN CONST EFI_HANDLE ImageHandle,\r |
| | 1355 | IN CONST EFI_SYSTEM_TABLE *SystemTable,\r |
| | 1356 | IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r |
| | 1357 | IN EFI_HANDLE DriverBindingHandle,\r |
| | 1358 | IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r |
| | 1359 | IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration OPTIONAL,\r |
| | 1360 | IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL\r |
| | 1361 | );\r |
| | 1362 | \r |
| | 1363 | /**\r |
| | 1364 | Uninstalls a Driver Binding Protocol instance and optionally uninstalls the\r |
| | 1365 | Component Name, Driver Configuration and Driver Diagnostics Protocols.\r |
| | 1366 | \r |
| | 1367 | If DriverBinding is NULL, then ASSERT().\r |
| | 1368 | If the uninstallation fails, then ASSERT().\r |
| | 1369 | \r |
| | 1370 | @param DriverBinding A Driver Binding Protocol instance that this driver produced.\r |
| | 1371 | @param ComponentName A Component Name Protocol instance that this driver produced.\r |
| | 1372 | @param DriverConfiguration A Driver Configuration Protocol instance that this driver produced.\r |
| | 1373 | @param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver produced.\r |
| | 1374 | \r |
| | 1375 | @retval EFI_SUCCESS The protocol uninstallation successfully completed.\r |
| | 1376 | @retval Others Status from gBS->UninstallMultipleProtocolInterfaces().\r |
| | 1377 | \r |
| | 1378 | **/\r |
| | 1379 | EFI_STATUS\r |
| | 1380 | EFIAPI\r |
| | 1381 | EfiLibUninstallAllDriverProtocols (\r |
| | 1382 | IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r |
| | 1383 | IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r |
| | 1384 | IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration OPTIONAL,\r |
| | 1385 | IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL\r |
| | 1386 | );\r |
| | 1387 | \r |
| | 1388 | /**\r |
| | 1389 | Installs Driver Binding Protocol with optional Component Name and Component Name 2 Protocols.\r |
| | 1390 | \r |
| | 1391 | Initializes a driver by installing the Driver Binding Protocol together with the\r |
| | 1392 | optional Component Name and optional Component Name 2 protocols onto the driver's\r |
| | 1393 | DriverBindingHandle. If DriverBindingHandle is NULL, then the protocols are installed\r |
| | 1394 | onto a newly created handle. DriverBindingHandle is typically the same as the driver's\r |
| | 1395 | ImageHandle, but it can be different if the driver produces multiple Driver Binding Protocols.\r |
| | 1396 | If DriverBinding is NULL, then ASSERT().\r |
| | 1397 | If the installation fails, then ASSERT().\r |
| | 1398 | \r |
| | 1399 | @param ImageHandle The image handle of the driver.\r |
| | 1400 | @param SystemTable The EFI System Table that was passed to the driver's entry point.\r |
| | 1401 | @param DriverBinding A Driver Binding Protocol instance that this driver is producing.\r |
| | 1402 | @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this\r |
| | 1403 | parameter is NULL, then a new handle is created.\r |
| | 1404 | @param ComponentName A Component Name Protocol instance that this driver is producing.\r |
| | 1405 | @param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.\r |
| | 1406 | \r |
| | 1407 | @retval EFI_SUCCESS The protocol installation completed successfully.\r |
| | 1408 | @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r |
| | 1409 | \r |
| | 1410 | **/\r |
| | 1411 | EFI_STATUS\r |
| | 1412 | EFIAPI\r |
| | 1413 | EfiLibInstallDriverBindingComponentName2 (\r |
| | 1414 | IN CONST EFI_HANDLE ImageHandle,\r |
| | 1415 | IN CONST EFI_SYSTEM_TABLE *SystemTable,\r |
| | 1416 | IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r |
| | 1417 | IN EFI_HANDLE DriverBindingHandle,\r |
| | 1418 | IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r |
| | 1419 | IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL\r |
| | 1420 | );\r |
| | 1421 | \r |
| | 1422 | /**\r |
| | 1423 | Uninstalls Driver Binding Protocol with optional Component Name and Component Name 2 Protocols.\r |
| | 1424 | \r |
| | 1425 | If DriverBinding is NULL, then ASSERT().\r |
| | 1426 | If the uninstallation fails, then ASSERT().\r |
| | 1427 | \r |
| | 1428 | @param DriverBinding A Driver Binding Protocol instance that this driver produced.\r |
| | 1429 | @param ComponentName A Component Name Protocol instance that this driver produced.\r |
| | 1430 | @param ComponentName2 A Component Name 2 Protocol instance that this driver produced.\r |
| | 1431 | \r |
| | 1432 | @retval EFI_SUCCESS The protocol installation successfully completed.\r |
| | 1433 | @retval Others Status from gBS->UninstallMultipleProtocolInterfaces().\r |
| | 1434 | \r |
| | 1435 | **/\r |
| | 1436 | EFI_STATUS\r |
| | 1437 | EFIAPI\r |
| | 1438 | EfiLibUninstallDriverBindingComponentName2 (\r |
| | 1439 | IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r |
| | 1440 | IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r |
| | 1441 | IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL\r |
| | 1442 | );\r |
| | 1443 | \r |
| | 1444 | /**\r |
| | 1445 | Installs Driver Binding Protocol with optional Component Name, Component Name 2, Driver\r |
| | 1446 | Configuration, Driver Configuration 2, Driver Diagnostics, and Driver Diagnostics 2 Protocols.\r |
| | 1447 | \r |
| | 1448 | Initializes a driver by installing the Driver Binding Protocol together with the optional\r |
| | 1449 | Component Name, optional Component Name 2, optional Driver Configuration, optional Driver Configuration 2,\r |
| | 1450 | optional Driver Diagnostic, and optional Driver Diagnostic 2 Protocols onto the driver's DriverBindingHandle.\r |
| | 1451 | DriverBindingHandle is typically the same as the driver's ImageHandle, but it can be different if the driver\r |
| | 1452 | produces multiple Driver Binding Protocols.\r |
| | 1453 | If DriverBinding is NULL, then ASSERT().\r |
| | 1454 | If the installation fails, then ASSERT().\r |
| | 1455 | \r |
| | 1456 | \r |
| | 1457 | @param ImageHandle The image handle of the driver.\r |
| | 1458 | @param SystemTable The EFI System Table that was passed to the driver's entry point.\r |
| | 1459 | @param DriverBinding A Driver Binding Protocol instance that this driver is producing.\r |
| | 1460 | @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this\r |
| | 1461 | parameter is NULL, then a new handle is created.\r |
| | 1462 | @param ComponentName A Component Name Protocol instance that this driver is producing.\r |
| | 1463 | @param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.\r |
| | 1464 | @param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.\r |
| | 1465 | @param DriverConfiguration2 A Driver Configuration Protocol 2 instance that this driver is producing.\r |
| | 1466 | @param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.\r |
| | 1467 | @param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver is producing.\r |
| | 1468 | \r |
| | 1469 | @retval EFI_SUCCESS The protocol installation completed successfully.\r |
| | 1470 | @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r |
| | 1471 | \r |
| | 1472 | **/\r |
| | 1473 | EFI_STATUS\r |
| | 1474 | EFIAPI\r |
| | 1475 | EfiLibInstallAllDriverProtocols2 (\r |
| | 1476 | IN CONST EFI_HANDLE ImageHandle,\r |
| | 1477 | IN CONST EFI_SYSTEM_TABLE *SystemTable,\r |
| | 1478 | IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r |
| | 1479 | IN EFI_HANDLE DriverBindingHandle,\r |
| | 1480 | IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r |
| | 1481 | IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL,\r |
| | 1482 | IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration OPTIONAL,\r |
| | 1483 | IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL *DriverConfiguration2 OPTIONAL,\r |
| | 1484 | IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL,\r |
| | 1485 | IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL\r |
| | 1486 | );\r |
| | 1487 | \r |
| | 1488 | /**\r |
| | 1489 | Uninstalls Driver Binding Protocol with optional Component Name, Component Name 2, Driver\r |
| | 1490 | Configuration, Driver Configuration 2, Driver Diagnostics, and Driver Diagnostics 2 Protocols.\r |
| | 1491 | \r |
| | 1492 | If DriverBinding is NULL, then ASSERT().\r |
| | 1493 | If the installation fails, then ASSERT().\r |
| | 1494 | \r |
| | 1495 | \r |
| | 1496 | @param DriverBinding A Driver Binding Protocol instance that this driver produced.\r |
| | 1497 | @param ComponentName A Component Name Protocol instance that this driver produced.\r |
| | 1498 | @param ComponentName2 A Component Name 2 Protocol instance that this driver produced.\r |
| | 1499 | @param DriverConfiguration A Driver Configuration Protocol instance that this driver produced.\r |
| | 1500 | @param DriverConfiguration2 A Driver Configuration Protocol 2 instance that this driver produced.\r |
| | 1501 | @param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver produced.\r |
| | 1502 | @param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver produced.\r |
| | 1503 | \r |
| | 1504 | @retval EFI_SUCCESS The protocol uninstallation successfully completed.\r |
| | 1505 | @retval Others Status from gBS->UninstallMultipleProtocolInterfaces().\r |
| | 1506 | \r |
| | 1507 | **/\r |
| | 1508 | EFI_STATUS\r |
| | 1509 | EFIAPI\r |
| | 1510 | EfiLibUninstallAllDriverProtocols2 (\r |
| | 1511 | IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r |
| | 1512 | IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r |
| | 1513 | IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL,\r |
| | 1514 | IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration OPTIONAL,\r |
| | 1515 | IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL *DriverConfiguration2 OPTIONAL,\r |
| | 1516 | IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL,\r |
| | 1517 | IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL\r |
| | 1518 | );\r |
| | 1519 | \r |
| | 1520 | /**\r |
| | 1521 | Appends a formatted Unicode string to a Null-terminated Unicode string\r |
| | 1522 | \r |
| | 1523 | This function appends a formatted Unicode string to the Null-terminated\r |
| | 1524 | Unicode string specified by String. String is optional and may be NULL.\r |
| | 1525 | Storage for the formatted Unicode string returned is allocated using\r |
| | 1526 | AllocatePool(). The pointer to the appended string is returned. The caller\r |
| | 1527 | is responsible for freeing the returned string.\r |
| | 1528 | \r |
| | 1529 | If String is not NULL and not aligned on a 16-bit boundary, then ASSERT().\r |
| | 1530 | If FormatString is NULL, then ASSERT().\r |
| | 1531 | If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r |
| | 1532 | \r |
| | 1533 | @param[in] String A Null-terminated Unicode string.\r |
| | 1534 | @param[in] FormatString A Null-terminated Unicode format string.\r |
| | 1535 | @param[in] Marker VA_LIST marker for the variable argument list.\r |
| | 1536 | \r |
| | 1537 | @retval NULL There was not enough available memory.\r |
| | 1538 | @return Null-terminated Unicode string is that is the formatted\r |
| | 1539 | string appended to String.\r |
| | 1540 | **/\r |
| | 1541 | CHAR16 *\r |
| | 1542 | EFIAPI\r |
| | 1543 | CatVSPrint (\r |
| | 1544 | IN CHAR16 *String OPTIONAL,\r |
| | 1545 | IN CONST CHAR16 *FormatString,\r |
| | 1546 | IN VA_LIST Marker\r |
| | 1547 | );\r |
| | 1548 | \r |
| | 1549 | /**\r |
| | 1550 | Appends a formatted Unicode string to a Null-terminated Unicode string\r |
| | 1551 | \r |
| | 1552 | This function appends a formatted Unicode string to the Null-terminated\r |
| | 1553 | Unicode string specified by String. String is optional and may be NULL.\r |
| | 1554 | Storage for the formatted Unicode string returned is allocated using\r |
| | 1555 | AllocatePool(). The pointer to the appended string is returned. The caller\r |
| | 1556 | is responsible for freeing the returned string.\r |
| | 1557 | \r |
| | 1558 | If String is not NULL and not aligned on a 16-bit boundary, then ASSERT().\r |
| | 1559 | If FormatString is NULL, then ASSERT().\r |
| | 1560 | If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r |
| | 1561 | \r |
| | 1562 | @param[in] String A Null-terminated Unicode string.\r |
| | 1563 | @param[in] FormatString A Null-terminated Unicode format string.\r |
| | 1564 | @param[in] ... The variable argument list whose contents are\r |
| | 1565 | accessed based on the format string specified by\r |
| | 1566 | FormatString.\r |
| | 1567 | \r |
| | 1568 | @retval NULL There was not enough available memory.\r |
| | 1569 | @return Null-terminated Unicode string is that is the formatted\r |
| | 1570 | string appended to String.\r |
| | 1571 | **/\r |
| | 1572 | CHAR16 *\r |
| | 1573 | EFIAPI\r |
| | 1574 | CatSPrint (\r |
| | 1575 | IN CHAR16 *String OPTIONAL,\r |
| | 1576 | IN CONST CHAR16 *FormatString,\r |
| | 1577 | ...\r |
| | 1578 | );\r |
| | 1579 | \r |
| | 1580 | /**\r |
| | 1581 | Returns an array of protocol instance that matches the given protocol.\r |
| | 1582 | \r |
| | 1583 | @param[in] Protocol Provides the protocol to search for.\r |
| | 1584 | @param[out] NoProtocols The number of protocols returned in Buffer.\r |
| | 1585 | @param[out] Buffer A pointer to the buffer to return the requested\r |
| | 1586 | array of protocol instances that match Protocol.\r |
| | 1587 | The returned buffer is allocated using\r |
| | 1588 | EFI_BOOT_SERVICES.AllocatePool(). The caller is\r |
| | 1589 | responsible for freeing this buffer with\r |
| | 1590 | EFI_BOOT_SERVICES.FreePool().\r |
| | 1591 | \r |
| | 1592 | @retval EFI_SUCCESS The array of protocols was returned in Buffer,\r |
| | 1593 | and the number of protocols in Buffer was\r |
| | 1594 | returned in NoProtocols.\r |
| | 1595 | @retval EFI_NOT_FOUND No protocols found.\r |
| | 1596 | @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the\r |
| | 1597 | matching results.\r |
| | 1598 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
| | 1599 | @retval EFI_INVALID_PARAMETER NoProtocols is NULL.\r |
| | 1600 | @retval EFI_INVALID_PARAMETER Buffer is NULL.\r |
| | 1601 | \r |
| | 1602 | **/\r |
| | 1603 | EFI_STATUS\r |
| | 1604 | EFIAPI\r |
| | 1605 | EfiLocateProtocolBuffer (\r |
| | 1606 | IN EFI_GUID *Protocol,\r |
| | 1607 | OUT UINTN *NoProtocols,\r |
| | 1608 | OUT VOID ***Buffer\r |
| | 1609 | );\r |
| | 1610 | \r |
| | 1611 | /**\r |
| | 1612 | Open or create a file or directory, possibly creating the chain of\r |
| | 1613 | directories leading up to the directory.\r |
| | 1614 | \r |
| | 1615 | EfiOpenFileByDevicePath() first locates EFI_SIMPLE_FILE_SYSTEM_PROTOCOL on\r |
| | 1616 | FilePath, and opens the root directory of that filesystem with\r |
| | 1617 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL.OpenVolume().\r |
| | 1618 | \r |
| | 1619 | On the remaining device path, the longest initial sequence of\r |
| | 1620 | FILEPATH_DEVICE_PATH nodes is node-wise traversed with\r |
| | 1621 | EFI_FILE_PROTOCOL.Open().\r |
| | 1622 | \r |
| | 1623 | (As a consequence, if OpenMode includes EFI_FILE_MODE_CREATE, and Attributes\r |
| | 1624 | includes EFI_FILE_DIRECTORY, and each FILEPATH_DEVICE_PATH specifies a single\r |
| | 1625 | pathname component, then EfiOpenFileByDevicePath() ensures that the specified\r |
| | 1626 | series of subdirectories exist on return.)\r |
| | 1627 | \r |
| | 1628 | The EFI_FILE_PROTOCOL identified by the last FILEPATH_DEVICE_PATH node is\r |
| | 1629 | output to the caller; intermediate EFI_FILE_PROTOCOL instances are closed. If\r |
| | 1630 | there are no FILEPATH_DEVICE_PATH nodes past the node that identifies the\r |
| | 1631 | filesystem, then the EFI_FILE_PROTOCOL of the root directory of the\r |
| | 1632 | filesystem is output to the caller. If a device path node that is different\r |
| | 1633 | from FILEPATH_DEVICE_PATH is encountered relative to the filesystem, the\r |
| | 1634 | traversal is stopped with an error, and a NULL EFI_FILE_PROTOCOL is output.\r |
| | 1635 | \r |
| | 1636 | @param[in,out] FilePath On input, the device path to the file or directory\r |
| | 1637 | to open or create. The caller is responsible for\r |
| | 1638 | ensuring that the device path pointed-to by FilePath\r |
| | 1639 | is well-formed. On output, FilePath points one past\r |
| | 1640 | the last node in the original device path that has\r |
| | 1641 | been successfully processed. FilePath is set on\r |
| | 1642 | output even if EfiOpenFileByDevicePath() returns an\r |
| | 1643 | error.\r |
| | 1644 | \r |
| | 1645 | @param[out] File On error, File is set to NULL. On success, File is\r |
| | 1646 | set to the EFI_FILE_PROTOCOL of the root directory\r |
| | 1647 | of the filesystem, if there are no\r |
| | 1648 | FILEPATH_DEVICE_PATH nodes in FilePath; otherwise,\r |
| | 1649 | File is set to the EFI_FILE_PROTOCOL identified by\r |
| | 1650 | the last node in FilePath.\r |
| | 1651 | \r |
| | 1652 | @param[in] OpenMode The OpenMode parameter to pass to\r |
| | 1653 | EFI_FILE_PROTOCOL.Open().\r |
| | 1654 | \r |
| | 1655 | @param[in] Attributes The Attributes parameter to pass to\r |
| | 1656 | EFI_FILE_PROTOCOL.Open().\r |
| | 1657 | \r |
| | 1658 | @retval EFI_SUCCESS The file or directory has been opened or\r |
| | 1659 | created.\r |
| | 1660 | \r |
| | 1661 | @retval EFI_INVALID_PARAMETER FilePath is NULL; or File is NULL; or FilePath\r |
| | 1662 | contains a device path node, past the node\r |
| | 1663 | that identifies\r |
| | 1664 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, that is not a\r |
| | 1665 | FILEPATH_DEVICE_PATH node.\r |
| | 1666 | \r |
| | 1667 | @retval EFI_OUT_OF_RESOURCES Memory allocation failed.\r |
| | 1668 | \r |
| | 1669 | @return Error codes propagated from the\r |
| | 1670 | LocateDevicePath() and OpenProtocol() boot\r |
| | 1671 | services, and from the\r |
| | 1672 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL.OpenVolume()\r |
| | 1673 | and EFI_FILE_PROTOCOL.Open() member functions.\r |
| | 1674 | **/\r |
| | 1675 | EFI_STATUS\r |
| | 1676 | EFIAPI\r |
| | 1677 | EfiOpenFileByDevicePath (\r |
| | 1678 | IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,\r |
| | 1679 | OUT EFI_FILE_PROTOCOL **File,\r |
| | 1680 | IN UINT64 OpenMode,\r |
| | 1681 | IN UINT64 Attributes\r |
| | 1682 | );\r |
| | 1683 | \r |
| | 1684 | /**\r |
| | 1685 | This function locates next ACPI table in XSDT/RSDT based on Signature and\r |
| | 1686 | previous returned Table.\r |
| | 1687 | \r |
| | 1688 | If PreviousTable is NULL:\r |
| | 1689 | This function will locate the first ACPI table in XSDT/RSDT based on\r |
| | 1690 | Signature in gEfiAcpi20TableGuid system configuration table first, and then\r |
| | 1691 | gEfiAcpi10TableGuid system configuration table.\r |
| | 1692 | This function will locate in XSDT first, and then RSDT.\r |
| | 1693 | For DSDT, this function will locate XDsdt in FADT first, and then Dsdt in\r |
| | 1694 | FADT.\r |
| | 1695 | For FACS, this function will locate XFirmwareCtrl in FADT first, and then\r |
| | 1696 | FirmwareCtrl in FADT.\r |
| | 1697 | \r |
| | 1698 | If PreviousTable is not NULL:\r |
| | 1699 | 1. If it could be located in XSDT in gEfiAcpi20TableGuid system configuration\r |
| | 1700 | table, then this function will just locate next table in XSDT in\r |
| | 1701 | gEfiAcpi20TableGuid system configuration table.\r |
| | 1702 | 2. If it could be located in RSDT in gEfiAcpi20TableGuid system configuration\r |
| | 1703 | table, then this function will just locate next table in RSDT in\r |
| | 1704 | gEfiAcpi20TableGuid system configuration table.\r |
| | 1705 | 3. If it could be located in RSDT in gEfiAcpi10TableGuid system configuration\r |
| | 1706 | table, then this function will just locate next table in RSDT in\r |
| | 1707 | gEfiAcpi10TableGuid system configuration table.\r |
| | 1708 | \r |
| | 1709 | It's not supported that PreviousTable is not NULL but PreviousTable->Signature\r |
| | 1710 | is not same with Signature, NULL will be returned.\r |
| | 1711 | \r |
| | 1712 | @param Signature ACPI table signature.\r |
| | 1713 | @param PreviousTable Pointer to previous returned table to locate next\r |
| | 1714 | table, or NULL to locate first table.\r |
| | 1715 | \r |
| | 1716 | @return Next ACPI table or NULL if not found.\r |
| | 1717 | \r |
| | 1718 | **/\r |
| | 1719 | EFI_ACPI_COMMON_HEADER *\r |
| | 1720 | EFIAPI\r |
| | 1721 | EfiLocateNextAcpiTable (\r |
| | 1722 | IN UINT32 Signature,\r |
| | 1723 | IN EFI_ACPI_COMMON_HEADER *PreviousTable OPTIONAL\r |
| | 1724 | );\r |
| | 1725 | \r |
| | 1726 | /**\r |
| | 1727 | This function locates first ACPI table in XSDT/RSDT based on Signature.\r |
| | 1728 | \r |
| | 1729 | This function will locate the first ACPI table in XSDT/RSDT based on\r |
| | 1730 | Signature in gEfiAcpi20TableGuid system configuration table first, and then\r |
| | 1731 | gEfiAcpi10TableGuid system configuration table.\r |
| | 1732 | This function will locate in XSDT first, and then RSDT.\r |
| | 1733 | For DSDT, this function will locate XDsdt in FADT first, and then Dsdt in\r |
| | 1734 | FADT.\r |
| | 1735 | For FACS, this function will locate XFirmwareCtrl in FADT first, and then\r |
| | 1736 | FirmwareCtrl in FADT.\r |
| | 1737 | \r |
| | 1738 | @param Signature ACPI table signature.\r |
| | 1739 | \r |
| | 1740 | @return First ACPI table or NULL if not found.\r |
| | 1741 | \r |
| | 1742 | **/\r |
| | 1743 | EFI_ACPI_COMMON_HEADER *\r |
| | 1744 | EFIAPI\r |
| | 1745 | EfiLocateFirstAcpiTable (\r |
| | 1746 | IN UINT32 Signature\r |
| | 1747 | );\r |
| | 1748 | \r |
| | 1749 | #endif\r |
projects / mirror_edk2.git / blame_incremental