EFI Driver Model related protocols, manage Unicode string tables for UEFI Drivers, \r
and print messages on the console output and standard error devices.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+ Note that a reserved macro named MDEPKG_NDEBUG is introduced for the intention\r
+ of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is\r
+ defined, then debug and assert related macros wrapped by it are the NULL implementations.\r
+\r
+Copyright (c) 2006 - 2010, 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
\r
/**\r
Macro that returns the number of 100 ns units for a specified number of microseconds.\r
- Useful for managing EFI timer events.\r
+ This is useful for managing EFI timer events.\r
\r
- @param Microseconds Number of microseonds.\r
+ @param Microseconds The number of microseconds.\r
\r
@return The number of 100 ns units equivalent to the number of microseconds specified\r
by Microseconds.\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 milliseoconds.\r
- Useful for managing EFI timer events.\r
+ Macro that returns the number of 100 ns units for a specified number of milliseconds.\r
+ This is useful for managing EFI timer events.\r
\r
- @param Milliseconds Number of milliseconds.\r
+ @param Milliseconds The number of milliseconds.\r
\r
@return The number of 100 ns units equivalent to the number of milliseconds specified\r
by Milliseconds.\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 seoconds.\r
- Useful for managing EFI timer events.\r
+ Macro that returns the number of 100 ns units for a specified number of seconds.\r
+ This is useful for managing EFI timer events.\r
\r
- @param Seconds Number of seconds.\r
+ @param Seconds The number of seconds.\r
\r
@return The number of 100 ns units equivalent to the number of seconds specified\r
by Seconds.\r
based on a specified GUID.\r
\r
This function searches the list of configuration tables stored in the EFI System Table\r
- for a table with a GUID that matches TableGuid. If a match is found, then a pointer to\r
- the configuration table is returned in Table., and EFI_SUCCESS is returned. If a matching GUID\r
+ for a table with a GUID that matches TableGuid. If a match is found, then a pointer to\r
+ the configuration table is returned in Table, and EFI_SUCCESS is returned. If a matching GUID\r
is not found, then EFI_NOT_FOUND is returned.\r
If TableGuid is NULL, then ASSERT().\r
If Table is NULL, then ASSERT().\r
\r
- @param TableGuid Pointer to table's GUID type..\r
- @param Table Pointer to the table associated with TableGuid in the EFI System Table.\r
+ @param TableGuid The pointer to table's GUID type..\r
+ @param Table The pointer to the table associated with TableGuid in the EFI System Table.\r
\r
@retval EFI_SUCCESS A configuration table matching TableGuid was found.\r
@retval EFI_NOT_FOUND A configuration table matching TableGuid could not be found.\r
@param Registration A pointer to a memory location to receive the registration value.\r
\r
@retval EFI_SUCCESS A named event was created.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resource to create the named event.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources to create the named event.\r
\r
**/\r
EFI_STATUS\r
created with EfiNamedEventListen().\r
If Name is NULL, then ASSERT().\r
\r
- @param Name Supplies GUID name of the event.\r
+ @param Name Supplies the GUID name of the event.\r
\r
@retval EFI_SUCCESS A named event was signaled.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resource to signal the named event.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources to signal the named event.\r
\r
**/\r
EFI_STATUS\r
If Priority is not a valid TPL value, then ASSERT().\r
\r
@param Lock A pointer to the lock data structure to initialize.\r
- @param Priority EFI TPL associated with the lock.\r
+ @param Priority The EFI TPL associated with the lock.\r
\r
@return The lock.\r
\r
/**\r
Macro that calls DebugAssert() if an EFI_LOCK structure is not in the locked state.\r
\r
- If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, \r
- then this macro evaluates the EFI_LOCK structure specified by Lock. If Lock \r
- is not in the locked state, then DebugAssert() is called passing in the source \r
- filename, source line number, and Lock.\r
+ If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED \r
+ bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_LOCK \r
+ structure specified by Lock. If Lock is not in the locked state, then\r
+ DebugAssert() is called passing in the source filename, source line number, \r
+ and Lock.\r
+\r
If Lock is NULL, then ASSERT().\r
\r
@param LockParameter A pointer to the lock to acquire.\r
\r
**/\r
-#define ASSERT_LOCKED(LockParameter) \\r
- do { \\r
- if (DebugAssertEnabled ()) { \\r
- ASSERT (LockParameter != NULL); \\r
- if ((LockParameter)->Lock != EfiLockAcquired) { \\r
- _ASSERT (LockParameter not locked); \\r
- } \\r
- } \\r
- } while (FALSE)\r
+#if !defined(MDEPKG_NDEBUG) \r
+ #define ASSERT_LOCKED(LockParameter) \\r
+ do { \\r
+ if (DebugAssertEnabled ()) { \\r
+ ASSERT (LockParameter != NULL); \\r
+ if ((LockParameter)->Lock != EfiLockAcquired) { \\r
+ _ASSERT (LockParameter not locked); \\r
+ } \\r
+ } \\r
+ } while (FALSE)\r
+#else\r
+ #define ASSERT_LOCKED(LockParameter)\r
+#endif\r
\r
\r
/**\r
function.\r
\r
@retval EFI_SUCCESS ControllerHandle is managed by the driver\r
- specifed by DriverBindingHandle.\r
+ specified by DriverBindingHandle.\r
@retval EFI_UNSUPPORTED ControllerHandle is not managed by the driver\r
- specifed by DriverBindingHandle.\r
+ specified by DriverBindingHandle.\r
\r
**/\r
EFI_STATUS\r
\r
@retval EFI_SUCCESS The Unicode string that matches the language \r
specified by Language was found\r
- in the table of Unicoide strings UnicodeStringTable, \r
+ in the table of Unicode strings UnicodeStringTable, \r
and it was returned in UnicodeString.\r
@retval EFI_INVALID_PARAMETER Language is NULL.\r
@retval EFI_INVALID_PARAMETER UnicodeString is NULL.\r
RFC 4646 language code for the Unicode string to look up and\r
return. If Iso639Language is TRUE, then this ASCII string is\r
not assumed to be Null-terminated, and only the first three\r
- chacters are used. If Iso639Language is FALSE, then this ASCII\r
+ characters are used. If Iso639Language is FALSE, then this ASCII\r
string must be Null-terminated. \r
@param SupportedLanguages A pointer to a Null-terminated ASCII string that contains a\r
set of ISO 639-2 or RFC 4646 language codes that the Unicode\r
that matches the language specified by Language.\r
@param Iso639Language Specifies the supported language code format. If it is TRUE, then\r
Language and SupportedLanguages follow ISO 639-2 language code format.\r
- Otherwise, they follow RFC 4646 language code format.\r
+ Otherwise, they follow the RFC 4646 language code format.\r
\r
\r
@retval EFI_SUCCESS The Unicode string that matches the language specified by Language\r
If Name is NULL, then ASSERT().\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Name Pointer to a Null-terminated Unicode string.\r
- @param[in] Guid Pointer to an EFI_GUID structure\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
\r
If Name is NULL, then ASSERT().\r
\r
- @param[in] Name Pointer to a Null-terminated Unicode string.\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
...\r
);\r
\r
+/**\r
+ Draws a dialog box to the console output device specified by \r
+ ConOut defined in the EFI_SYSTEM_TABLE and waits for a keystroke\r
+ from the console input device specified by ConIn defined in the \r
+ EFI_SYSTEM_TABLE.\r
+\r
+ If there are no strings in the variable argument list, then ASSERT().\r
+ If all the strings in the variable argument list are empty, then ASSERT().\r
+\r
+ @param[in] Attribute Specifies the foreground and background color of the popup.\r
+ @param[out] Key A pointer to the EFI_KEY value of the key that was \r
+ pressed. This is an optional parameter that may be NULL.\r
+ If it is NULL then no wait for a keypress will be performed.\r
+ @param[in] ... The variable argument list that contains pointers to Null-\r
+ terminated Unicode strings to display in the dialog box. \r
+ The variable argument list is terminated by a NULL.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+CreatePopUp (\r
+ IN UINTN Attribute, \r
+ OUT EFI_INPUT_KEY *Key, OPTIONAL\r
+ ...\r
+ );\r
\r
/**\r
Retrieves the width of a Unicode character.\r
\r
@param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
- @retval EFI_SUCCESS Event was created.\r
- @retval Other Event was not created.\r
+ @retval EFI_SUCCESS The event was created.\r
+ @retval Other The event was not created.\r
\r
**/\r
EFI_STATUS\r
@param NotifyContext The content to pass to NotifyFunction when the event is signaled.\r
@param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
- @retval EFI_SUCCESS Event was created.\r
- @retval Other Event was not created.\r
+ @retval EFI_SUCCESS The event was created.\r
+ @retval Other The event was not created.\r
\r
**/\r
EFI_STATUS\r
\r
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
- @retval EFI_SUCCESS Event was created.\r
- @retval Other Event was not created.\r
+ @retval EFI_SUCCESS The event was created.\r
+ @retval Other The event was not created.\r
\r
**/\r
EFI_STATUS\r
@param NotifyContext The content to pass to NotifyFunction when the event is signaled.\r
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
- @retval EFI_SUCCESS Event was created.\r
- @retval Other Event was not created.\r
+ @retval EFI_SUCCESS The event was created.\r
+ @retval Other The event was not created.\r
\r
**/\r
EFI_STATUS\r
If FvDevicePathNode is NULL, then ASSERT().\r
If NameGuid is NULL, then ASSERT().\r
\r
- @param FvDevicePathNode Pointer to a FV device path node to initialize\r
+ @param FvDevicePathNode The pointer to a FV device path node to initialize\r
@param NameGuid FV file name to use in FvDevicePathNode\r
\r
**/\r
This library function abstracts validating a device path node.\r
Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid. \r
If it is valid, then return the GUID file name from the device path node. Otherwise, \r
- return NULL. This device path changed in the DXE CIS version 0.92 in a non back ward \r
+ return NULL. This device path changed in the DXE CIS version 0.92 in a non backward \r
compatible way to not conflict with the UEFI 2.0 specification. This function abstracts \r
the differences from the caller.\r
If FvDevicePathNode is NULL, then ASSERT().\r
\r
- @param FvDevicePathNode Pointer to FV device path to check.\r
+ @param FvDevicePathNode The pointer to FV device path to check.\r
\r
@retval NULL FvDevicePathNode is not valid.\r
@retval Other FvDevicePathNode is valid and pointer to NameGuid was returned.\r
If Format is NULL, then ASSERT().\r
If Format is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- @param Format Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based \r
+ @param Format A null-terminated Unicode format string.\r
+ @param ... The variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
@return Number of Unicode characters printed to ConOut.\r
If Format is NULL, then ASSERT().\r
If Format is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- @param Format Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based \r
+ @param Format A null-terminated Unicode format string.\r
+ @param ... The variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
@return Number of Unicode characters printed to StdErr.\r
PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r
If Format is NULL, then ASSERT().\r
\r
- @param Format Null-terminated ASCII format string.\r
- @param ... Variable argument list whose contents are accessed based \r
+ @param Format A null-terminated ASCII format string.\r
+ @param ... The variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
@return Number of ASCII characters printed to ConOut.\r
PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r
If Format is NULL, then ASSERT().\r
\r
- @param Format Null-terminated ASCII format string.\r
- @param ... Variable argument list whose contents are accessed based \r
+ @param Format A null-terminated ASCII format string.\r
+ @param ... The variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
@return Number of ASCII characters printed to ConErr.\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
\r
This function prints a formatted Unicode string to the graphics console device \r
specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of \r
- Unicode characters printed. If the length of the formatted Unicode string is\r
- greater than PcdUefiLibMaxPrintBufferSize, then only the first \r
+ Unicode characters displayed, not including partial characters that may be clipped \r
+ by the right edge of the display. If the length of the formatted Unicode string is\r
+ greater than PcdUefiLibMaxPrintBufferSize, then at most the first \r
PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL\r
is used to convert the string to a bitmap using the glyphs registered with the \r
HII database. No wrapping is performed, so any portions of the string the fall\r
If Format is NULL, then ASSERT().\r
If Format is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- @param X X coordinate to print the string.\r
- @param Y Y coordinate to print the string.\r
- @param ForeGround The forground color of the string being printed. This is\r
+ @param PointX X coordinate to print the string.\r
+ @param PointY Y coordinate to print the string.\r
+ @param ForeGround The foreground color of the string being printed. This is\r
an optional parameter that may be NULL. If it is NULL,\r
then the foreground color of the current ConOut device\r
in the EFI_SYSTEM_TABLE is used.\r
an optional parameter that may be NULL. If it is NULL, \r
then the background color of the current ConOut device\r
in the EFI_SYSTEM_TABLE is used.\r
- @param Format Null-terminated Unicode format string. See Print Library \r
+ @param Format A null-terminated Unicode format string. See Print Library \r
for the supported format string syntax.\r
@param ... Variable argument list whose contents are accessed based on \r
the format string specified by Format. \r
UINTN\r
EFIAPI\r
PrintXY (\r
- IN UINTN X,\r
- IN UINTN Y,\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
This function prints a formatted ASCII string to the graphics console device \r
specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of \r
- ASCII characters printed. If the length of the formatted ASCII string is\r
- greater than PcdUefiLibMaxPrintBufferSize, then only the first \r
+ ASCII characters displayed, not including partial characters that may be clipped \r
+ by the right edge of the display. If the length of the formatted ASCII string is\r
+ greater than PcdUefiLibMaxPrintBufferSize, then at most the first \r
PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL\r
is used to convert the string to a bitmap using the glyphs registered with the \r
HII database. No wrapping is performed, so any portions of the string the fall\r
string is printed, and 0 is returned.\r
If Format is NULL, then ASSERT().\r
\r
- @param X X coordinate to print the string.\r
- @param Y Y coordinate to print the string.\r
- @param ForeGround The forground color of the string being printed. This is\r
+ @param PointX X coordinate to print the string.\r
+ @param PointY Y coordinate to print the string.\r
+ @param ForeGround The foreground color of the string being printed. This is\r
an optional parameter that may be NULL. If it is NULL,\r
then the foreground color of the current ConOut device\r
in the EFI_SYSTEM_TABLE is used.\r
an optional parameter that may be NULL. If it is NULL, \r
then the background color of the current ConOut device\r
in the EFI_SYSTEM_TABLE is used.\r
- @param Format Null-terminated ASCII format string. See Print Library \r
+ @param Format A null-terminated ASCII format string. See Print Library \r
for the supported format string syntax.\r
- @param ... Variable argument list whose contents are accessed based on \r
+ @param ... The variable argument list whose contents are accessed based on \r
the format string specified by Format. \r
\r
@return The number of ASCII characters printed.\r
UINTN\r
EFIAPI\r
AsciiPrintXY (\r
- IN UINTN X,\r
- IN UINTN Y,\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
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this\r
parameter is NULL, then a new handle is created.\r
\r
- @retval EFI_SUCCESS The protocol installation is completed successfully.\r
+ @retval EFI_SUCCESS The protocol installation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES There was not enough system resources to install the protocol.\r
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().\r
\r
Initializes a driver by installing the Driver Binding Protocol together with the\r
optional Component Name, optional Driver Configure and optional Driver Diagnostic\r
Protocols onto the driver's DriverBindingHandle. If DriverBindingHandle is NULL,\r
- then the protocols are installed onto a newly created handle. DriverBindingHandle\r
+ then the protocols are installed onto a newly created handle. DriverBindingHandle\r
is typically the same as the driver's ImageHandle, but it can be different if the\r
driver produces multiple Driver Binding Protocols. \r
If DriverBinding is NULL, then ASSERT(). \r
@param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.\r
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.\r
\r
- @retval EFI_SUCCESS The protocol installation is completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r
+ @retval EFI_SUCCESS The protocol installation completed successfully.\r
+ @retval EFI_OUT_OF_RESOURCES There was not enough memory in the pool to install all the protocols.\r
\r
**/\r
EFI_STATUS\r
@param ComponentName A Component Name Protocol instance that this driver is producing.\r
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.\r
\r
- @retval EFI_SUCCESS The protocol installation is completed successfully.\r
+ @retval EFI_SUCCESS The protocol installation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r
\r
**/\r
@param ImageHandle The image handle of the driver.\r
@param SystemTable The EFI System Table that was passed to the driver's entry point.\r
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.\r
- @param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this\r
+ @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this\r
parameter is NULL, then a new handle is created.\r
@param ComponentName A Component Name Protocol instance that this driver is producing.\r
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.\r
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.\r
@param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver is producing.\r
\r
- @retval EFI_SUCCESS The protocol installation is completed successfully.\r
+ @retval EFI_SUCCESS The protocol installation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r
\r
**/\r
projects / mirror_edk2.git / blobdiff