\r
Copyright (c) 2019, NVIDIA Corporation. All rights reserved.\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under\r
-the terms and conditions of the BSD License that accompanies this distribution.\r
-The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php.\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
/// Unicode String Table\r
///\r
typedef struct {\r
- CHAR8 *Language;\r
- CHAR16 *UnicodeString;\r
+ CHAR8 *Language;\r
+ CHAR16 *UnicodeString;\r
} EFI_UNICODE_STRING_TABLE;\r
\r
///\r
/// EFI Lock\r
///\r
typedef struct {\r
- EFI_TPL Tpl;\r
- EFI_TPL OwnerTpl;\r
- EFI_LOCK_STATE Lock;\r
+ EFI_TPL Tpl;\r
+ EFI_TPL OwnerTpl;\r
+ EFI_LOCK_STATE Lock;\r
} EFI_LOCK;\r
\r
/**\r
by Microseconds.\r
\r
**/\r
-#define EFI_TIMER_PERIOD_MICROSECONDS(Microseconds) MultU64x32((UINT64)(Microseconds), 10)\r
+#define EFI_TIMER_PERIOD_MICROSECONDS(Microseconds) MultU64x32((UINT64)(Microseconds), 10)\r
\r
/**\r
Macro that returns the number of 100 ns units for a specified number of milliseconds.\r
by Milliseconds.\r
\r
**/\r
-#define EFI_TIMER_PERIOD_MILLISECONDS(Milliseconds) MultU64x32((UINT64)(Milliseconds), 10000)\r
+#define EFI_TIMER_PERIOD_MILLISECONDS(Milliseconds) MultU64x32((UINT64)(Milliseconds), 10000)\r
\r
/**\r
Macro that returns the number of 100 ns units for a specified number of seconds.\r
by Seconds.\r
\r
**/\r
-#define EFI_TIMER_PERIOD_SECONDS(Seconds) MultU64x32((UINT64)(Seconds), 10000000)\r
+#define EFI_TIMER_PERIOD_SECONDS(Seconds) MultU64x32((UINT64)(Seconds), 10000000)\r
\r
/**\r
Macro that returns the a pointer to the next EFI_MEMORY_DESCRIPTOR in an array\r
**/\r
EFI_EVENT\r
EFIAPI\r
-EfiCreateProtocolNotifyEvent(\r
+EfiCreateProtocolNotifyEvent (\r
IN EFI_GUID *ProtocolGuid,\r
IN EFI_TPL NotifyTpl,\r
IN EFI_EVENT_NOTIFY NotifyFunction,\r
- IN VOID *NotifyContext, OPTIONAL\r
+ IN VOID *NotifyContext OPTIONAL,\r
OUT VOID **Registration\r
);\r
\r
IN CONST EFI_GUID *Name,\r
IN EFI_TPL NotifyTpl,\r
IN EFI_EVENT_NOTIFY NotifyFunction,\r
- IN CONST VOID *NotifyContext, OPTIONAL\r
+ IN CONST VOID *NotifyContext OPTIONAL,\r
OUT VOID *Registration OPTIONAL\r
);\r
\r
EFI_STATUS\r
EFIAPI\r
EfiEventGroupSignal (\r
- IN CONST EFI_GUID *EventGroup\r
+ IN CONST EFI_GUID *EventGroup\r
);\r
\r
/**\r
VOID\r
EFIAPI\r
EfiEventEmptyFunction (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
);\r
\r
/**\r
EFIAPI\r
EfiInitializeLock (\r
IN OUT EFI_LOCK *Lock,\r
- IN EFI_TPL Priority\r
+ IN EFI_TPL Priority\r
);\r
\r
/**\r
#define EFI_INITIALIZE_LOCK_VARIABLE(Priority) \\r
{Priority, TPL_APPLICATION, EfiLockReleased }\r
\r
-\r
/**\r
Macro that calls DebugAssert() if an EFI_LOCK structure is not in the locked state.\r
\r
@param LockParameter A pointer to the lock to acquire.\r
\r
**/\r
-#if !defined(MDEPKG_NDEBUG)\r
- #define ASSERT_LOCKED(LockParameter) \\r
+#if !defined (MDEPKG_NDEBUG)\r
+#define ASSERT_LOCKED(LockParameter) \\r
do { \\r
if (DebugAssertEnabled ()) { \\r
ASSERT (LockParameter != NULL); \\r
} \\r
} while (FALSE)\r
#else\r
- #define ASSERT_LOCKED(LockParameter)\r
+#define ASSERT_LOCKED(LockParameter)\r
#endif\r
\r
-\r
/**\r
Acquires ownership of a lock.\r
\r
EFI_STATUS\r
EFIAPI\r
EfiTestManagedDevice (\r
- IN CONST EFI_HANDLE ControllerHandle,\r
- IN CONST EFI_HANDLE DriverBindingHandle,\r
- IN CONST EFI_GUID *ProtocolGuid\r
+ IN CONST EFI_HANDLE ControllerHandle,\r
+ IN CONST EFI_HANDLE DriverBindingHandle,\r
+ IN CONST EFI_GUID *ProtocolGuid\r
);\r
\r
/**\r
EFI_STATUS\r
EFIAPI\r
EfiTestChildHandle (\r
- IN CONST EFI_HANDLE ControllerHandle,\r
- IN CONST EFI_HANDLE ChildHandle,\r
- IN CONST EFI_GUID *ProtocolGuid\r
+ IN CONST EFI_HANDLE ControllerHandle,\r
+ IN CONST EFI_HANDLE ChildHandle,\r
+ IN CONST EFI_GUID *ProtocolGuid\r
+ );\r
+\r
+/**\r
+ This function checks the supported languages list for a target language,\r
+ This only supports RFC 4646 Languages.\r
+\r
+ @param SupportedLanguages The supported languages\r
+ @param TargetLanguage The target language\r
+\r
+ @retval Returns EFI_SUCCESS if the language is supported,\r
+ EFI_UNSUPPORTED otherwise\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+IsLanguageSupported (\r
+ IN CONST CHAR8 *SupportedLanguages,\r
+ IN CONST CHAR8 *TargetLanguage\r
);\r
\r
/**\r
IN EFI_UNICODE_STRING_TABLE *UnicodeStringTable\r
);\r
\r
-#ifndef DISABLE_NEW_DEPRECATED_INTERFACES\r
-\r
-/**\r
- [ATTENTION] This function will be deprecated for security reason.\r
-\r
- Returns a pointer to an allocated buffer that contains the contents of a\r
- variable retrieved through the UEFI Runtime Service GetVariable(). The\r
- returned buffer is allocated using AllocatePool(). The caller is responsible\r
- for freeing this buffer with FreePool().\r
-\r
- If Name is NULL, then ASSERT().\r
- If Guid is NULL, then ASSERT().\r
-\r
- @param[in] Name The pointer to a Null-terminated Unicode string.\r
- @param[in] Guid The pointer to an EFI_GUID structure.\r
-\r
- @retval NULL The variable could not be retrieved.\r
- @retval NULL There are not enough resources available for the variable contents.\r
- @retval Other A pointer to allocated buffer containing the variable contents.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-GetVariable (\r
- IN CONST CHAR16 *Name,\r
- IN CONST EFI_GUID *Guid\r
- );\r
-\r
-/**\r
- [ATTENTION] This function will be deprecated for security reason.\r
-\r
- Returns a pointer to an allocated buffer that contains the contents of a\r
- variable retrieved through the UEFI Runtime Service GetVariable(). This\r
- function always uses the EFI_GLOBAL_VARIABLE GUID to retrieve variables.\r
- The returned buffer is allocated using AllocatePool(). The caller is\r
- responsible for freeing this buffer with FreePool().\r
-\r
- If Name is NULL, then ASSERT().\r
-\r
- @param[in] Name The pointer to a Null-terminated Unicode string.\r
-\r
- @retval NULL The variable could not be retrieved.\r
- @retval NULL There are not enough resources available for the variable contents.\r
- @retval Other A pointer to allocated buffer containing the variable contents.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-GetEfiGlobalVariable (\r
- IN CONST CHAR16 *Name\r
- );\r
-#endif\r
-\r
-\r
/**\r
Returns the status whether get the variable success. The function retrieves\r
variable through the UEFI Runtime Service GetVariable(). The\r
EFI_STATUS\r
EFIAPI\r
GetEfiGlobalVariable2 (\r
- IN CONST CHAR16 *Name,\r
- OUT VOID **Value,\r
- OUT UINTN *Size OPTIONAL\r
+ IN CONST CHAR16 *Name,\r
+ OUT VOID **Value,\r
+ OUT UINTN *Size OPTIONAL\r
);\r
\r
/** Return the attributes of the variable.\r
**/\r
EFI_STATUS\r
EFIAPI\r
-GetVariable3(\r
- IN CONST CHAR16 *Name,\r
- IN CONST EFI_GUID *Guid,\r
- OUT VOID **Value,\r
- OUT UINTN *Size OPTIONAL,\r
- OUT UINT32 *Attr OPTIONAL\r
+GetVariable3 (\r
+ IN CONST CHAR16 *Name,\r
+ IN CONST EFI_GUID *Guid,\r
+ OUT VOID **Value,\r
+ OUT UINTN *Size OPTIONAL,\r
+ OUT UINT32 *Attr OPTIONAL\r
);\r
\r
/**\r
EFIAPI\r
CreatePopUp (\r
IN UINTN Attribute,\r
- OUT EFI_INPUT_KEY *Key, OPTIONAL\r
+ OUT EFI_INPUT_KEY *Key OPTIONAL,\r
...\r
);\r
\r
//\r
// Functions that abstract early Framework contamination of UEFI.\r
//\r
+\r
/**\r
Create, Signal, and Close the Ready to Boot event using EfiSignalEventReadyToBoot().\r
\r
EFIAPI\r
EfiCreateEventLegacyBootEx (\r
IN EFI_TPL NotifyTpl,\r
- IN EFI_EVENT_NOTIFY NotifyFunction, OPTIONAL\r
- IN VOID *NotifyContext, OPTIONAL\r
+ IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,\r
+ IN VOID *NotifyContext OPTIONAL,\r
OUT EFI_EVENT *LegacyBootEvent\r
);\r
\r
EFIAPI\r
EfiCreateEventReadyToBootEx (\r
IN EFI_TPL NotifyTpl,\r
- IN EFI_EVENT_NOTIFY NotifyFunction, OPTIONAL\r
- IN VOID *NotifyContext, OPTIONAL\r
+ IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,\r
+ IN VOID *NotifyContext OPTIONAL,\r
OUT EFI_EVENT *ReadyToBootEvent\r
);\r
\r
...\r
);\r
\r
-\r
/**\r
Prints a formatted Unicode string to a graphics console device specified by\r
ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.\r
UINTN\r
EFIAPI\r
PrintXY (\r
- IN UINTN PointX,\r
- IN UINTN PointY,\r
- IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround, OPTIONAL\r
- IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround, OPTIONAL\r
- IN CONST CHAR16 *Format,\r
+ IN UINTN PointX,\r
+ IN UINTN PointY,\r
+ IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround OPTIONAL,\r
+ IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround OPTIONAL,\r
+ IN CONST CHAR16 *Format,\r
...\r
);\r
\r
UINTN\r
EFIAPI\r
AsciiPrintXY (\r
- IN UINTN PointX,\r
- IN UINTN PointY,\r
- IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround, OPTIONAL\r
- IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround, OPTIONAL\r
- IN CONST CHAR8 *Format,\r
+ IN UINTN PointX,\r
+ IN UINTN PointY,\r
+ IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround OPTIONAL,\r
+ IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround OPTIONAL,\r
+ IN CONST CHAR8 *Format,\r
...\r
);\r
\r
-\r
/**\r
Installs and completes the initialization of a Driver Binding Protocol instance.\r
\r
IN EFI_HANDLE DriverBindingHandle\r
);\r
\r
-\r
/**\r
Uninstalls a Driver Binding Protocol instance.\r
\r
IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding\r
);\r
\r
-\r
/**\r
Installs and completes the initialization of a Driver Binding Protocol instance and\r
optionally installs the Component Name, Driver Configuration and Driver Diagnostics Protocols.\r
IN CONST EFI_SYSTEM_TABLE *SystemTable,\r
IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
IN EFI_HANDLE DriverBindingHandle,\r
- IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL\r
- IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration, OPTIONAL\r
+ IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r
+ IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration OPTIONAL,\r
IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL\r
);\r
\r
-\r
/**\r
Uninstalls a Driver Binding Protocol instance and optionally uninstalls the\r
Component Name, Driver Configuration and Driver Diagnostics Protocols.\r
EFIAPI\r
EfiLibUninstallAllDriverProtocols (\r
IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
- IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL\r
- IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration, OPTIONAL\r
+ IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r
+ IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration OPTIONAL,\r
IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL\r
);\r
\r
-\r
/**\r
Installs Driver Binding Protocol with optional Component Name and Component Name 2 Protocols.\r
\r
EFI_STATUS\r
EFIAPI\r
EfiLibInstallDriverBindingComponentName2 (\r
- IN CONST EFI_HANDLE ImageHandle,\r
- IN CONST EFI_SYSTEM_TABLE *SystemTable,\r
- IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
- IN EFI_HANDLE DriverBindingHandle,\r
- IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL\r
- IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL\r
+ IN CONST EFI_HANDLE ImageHandle,\r
+ IN CONST EFI_SYSTEM_TABLE *SystemTable,\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
+ IN EFI_HANDLE DriverBindingHandle,\r
+ IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r
+ IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL\r
);\r
\r
-\r
/**\r
Uninstalls Driver Binding Protocol with optional Component Name and Component Name 2 Protocols.\r
\r
EFI_STATUS\r
EFIAPI\r
EfiLibUninstallDriverBindingComponentName2 (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
- IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL\r
- IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
+ IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r
+ IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL\r
);\r
\r
-\r
/**\r
Installs Driver Binding Protocol with optional Component Name, Component Name 2, Driver\r
Configuration, Driver Configuration 2, Driver Diagnostics, and Driver Diagnostics 2 Protocols.\r
EFI_STATUS\r
EFIAPI\r
EfiLibInstallAllDriverProtocols2 (\r
- IN CONST EFI_HANDLE ImageHandle,\r
- IN CONST EFI_SYSTEM_TABLE *SystemTable,\r
- IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
- IN EFI_HANDLE DriverBindingHandle,\r
- IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL\r
- IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2, OPTIONAL\r
- IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration, OPTIONAL\r
- IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL *DriverConfiguration2, OPTIONAL\r
- IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics, OPTIONAL\r
- IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL\r
+ IN CONST EFI_HANDLE ImageHandle,\r
+ IN CONST EFI_SYSTEM_TABLE *SystemTable,\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
+ IN EFI_HANDLE DriverBindingHandle,\r
+ IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r
+ IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL,\r
+ IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration OPTIONAL,\r
+ IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL *DriverConfiguration2 OPTIONAL,\r
+ IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL,\r
+ IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL\r
);\r
\r
-\r
/**\r
Uninstalls Driver Binding Protocol with optional Component Name, Component Name 2, Driver\r
Configuration, Driver Configuration 2, Driver Diagnostics, and Driver Diagnostics 2 Protocols.\r
EFI_STATUS\r
EFIAPI\r
EfiLibUninstallAllDriverProtocols2 (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
- IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL\r
- IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2, OPTIONAL\r
- IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration, OPTIONAL\r
- IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL *DriverConfiguration2, OPTIONAL\r
- IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics, OPTIONAL\r
- IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
+ IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName OPTIONAL,\r
+ IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL,\r
+ IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration OPTIONAL,\r
+ IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL *DriverConfiguration2 OPTIONAL,\r
+ IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL,\r
+ IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL\r
);\r
\r
-\r
/**\r
Appends a formatted Unicode string to a Null-terminated Unicode string\r
\r
@return Null-terminated Unicode string is that is the formatted\r
string appended to String.\r
**/\r
-CHAR16*\r
+CHAR16 *\r
EFIAPI\r
CatVSPrint (\r
- IN CHAR16 *String, OPTIONAL\r
+ IN CHAR16 *String OPTIONAL,\r
IN CONST CHAR16 *FormatString,\r
IN VA_LIST Marker\r
);\r
CHAR16 *\r
EFIAPI\r
CatSPrint (\r
- IN CHAR16 *String, OPTIONAL\r
+ IN CHAR16 *String OPTIONAL,\r
IN CONST CHAR16 *FormatString,\r
...\r
);\r
EFI_ACPI_COMMON_HEADER *\r
EFIAPI\r
EfiLocateNextAcpiTable (\r
- IN UINT32 Signature,\r
- IN EFI_ACPI_COMMON_HEADER *PreviousTable OPTIONAL\r
+ IN UINT32 Signature,\r
+ IN EFI_ACPI_COMMON_HEADER *PreviousTable OPTIONAL\r
);\r
\r
/**\r
EFI_ACPI_COMMON_HEADER *\r
EFIAPI\r
EfiLocateFirstAcpiTable (\r
- IN UINT32 Signature\r
+ IN UINT32 Signature\r
);\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff