[mirror_edk2.git] / MdePkg / Library / UefiDebugLibConOut / DebugLib.c

/** @file\r
  UEFI Debug Library that sends messages to the Console Output Device in the EFI System Table.\r
\r
  Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
  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
\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
\r
#include <Uefi.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugPrintErrorLevelLib.h>\r
\r
//\r
// Define the maximum debug and assert message length that this library supports \r
//\r
#define MAX_DEBUG_MESSAGE_LENGTH  0x100\r
\r
/**\r
  Prints a debug message to the debug output device if the specified error level is enabled.\r
\r
  If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function \r
  GetDebugPrintErrorLevel (), then print the message specified by Format and the \r
  associated variable argument list to the debug output device.\r
\r
  If Format is NULL, then ASSERT().\r
\r
  @param  ErrorLevel  The error level of the debug message.\r
  @param  Format      Format string for the debug message to print.\r
  @param  ...         A variable argument list whose contents are accessed \r
                      based on the format string specified by Format.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugPrint (\r
  IN  UINTN        ErrorLevel,\r
  IN  CONST CHAR8  *Format,\r
  ...\r
  )\r
{\r
  CHAR16   Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
  VA_LIST  Marker;\r
\r
  //\r
  // If Format is NULL, then ASSERT().\r
  //\r
  ASSERT (Format != NULL);\r
\r
  //\r
  // Check driver debug mask value and global mask\r
  //\r
  if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {\r
    return;\r
  }\r
\r
  //\r
  // Convert the DEBUG() message to a Unicode String\r
  //\r
  VA_START (Marker, Format);\r
  UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH,  Format, Marker);\r
  VA_END (Marker);\r
\r
\r
  //\r
  // Send the print string to the Console Output device\r
  //\r
  if ((gST != NULL) && (gST->ConOut != NULL)) {\r
    gST->ConOut->OutputString (gST->ConOut, Buffer);\r
  }\r
}\r
\r
\r
/**\r
  Prints an assert message containing a filename, line number, and description.  \r
  This may be followed by a breakpoint or a dead loop.\r
\r
  Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
  to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
  PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
  DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
  CpuDeadLoop() is called.  If neither of these bits are set, then this function \r
  returns immediately after the message is printed to the debug output device.\r
  DebugAssert() must actively prevent recursion.  If DebugAssert() is called while\r
  processing another DebugAssert(), then DebugAssert() must return immediately.\r
\r
  If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
  If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
\r
  @param  FileName     The pointer to the name of the source file that generated \r
                       the assert condition.\r
  @param  LineNumber   The line number in the source file that generated the \r
                       assert condition\r
  @param  Description  The pointer to the description of the assert condition.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugAssert (\r
  IN CONST CHAR8  *FileName,\r
  IN UINTN        LineNumber,\r
  IN CONST CHAR8  *Description\r
  )\r
{\r
  CHAR16  Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
\r
  //\r
  // Generate the ASSERT() message in Unicode format\r
  //\r
  UnicodeSPrintAsciiFormat (\r
    Buffer, \r
    sizeof (Buffer), \r
    "ASSERT [%a] %a(%d): %a\n",\r
    gEfiCallerBaseName,\r
    FileName, \r
    LineNumber, \r
    Description\r
    );\r
    \r
  //\r
  // Send the print string to the Console Output device\r
  //\r
  if ((gST != NULL) && (gST->ConOut != NULL)) {\r
    gST->ConOut->OutputString (gST->ConOut, Buffer);\r
  }\r
\r
  //\r
  // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
  //\r
  if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
    CpuBreakpoint ();\r
  } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
    CpuDeadLoop ();\r
  }\r
}\r
\r
\r
/**\r
  Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
\r
  This function fills Length bytes of Buffer with the value specified by \r
  PcdDebugClearMemoryValue, and returns Buffer.\r
\r
  If Buffer is NULL, then ASSERT().\r
  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
\r
  @param   Buffer  The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
  @param   Length  The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
  @return  Buffer  The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
EFIAPI\r
DebugClearMemory (\r
  OUT VOID  *Buffer,\r
  IN UINTN  Length\r
  )\r
{\r
  //\r
  // If Buffer is NULL, then ASSERT().\r
  //\r
  ASSERT (Buffer != NULL);\r
\r
  //\r
  // SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
  //\r
  return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
}\r
\r
\r
/**\r
  Returns TRUE if ASSERT() macros are enabled.\r
\r
  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugAssertEnabled (\r
  VOID\r
  )\r
{\r
  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
}\r
\r
\r
/**  \r
  Returns TRUE if DEBUG() macros are enabled.\r
\r
  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugPrintEnabled (\r
  VOID\r
  )\r
{\r
  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
}\r
\r
\r
/**  \r
  Returns TRUE if DEBUG_CODE() macros are enabled.\r
\r
  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugCodeEnabled (\r
  VOID\r
  )\r
{\r
  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
}\r
\r
\r
/**  \r
  Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
\r
  This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugClearMemoryEnabled (\r
  VOID\r
  )\r
{\r
  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
}\r
\r
/**\r
  Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
\r
  This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
\r
  @retval  TRUE    Current ErrorLevel is supported.\r
  @retval  FALSE   Current ErrorLevel is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugPrintLevelEnabled (\r
  IN  CONST UINTN        ErrorLevel\r
  )\r
{\r
  return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);\r
}\r
Commit	Line	Data
	1	/** @file\r
	2	UEFI Debug Library that sends messages to the Console Output Device in the EFI System Table.\r
	3	\r
	4	Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php. \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
	13	**/\r
	14	\r
	15	#include <Uefi.h>\r
	16	\r
	17	#include <Library/DebugLib.h>\r
	18	#include <Library/UefiBootServicesTableLib.h>\r
	19	#include <Library/PrintLib.h>\r
	20	#include <Library/PcdLib.h>\r
	21	#include <Library/BaseLib.h>\r
	22	#include <Library/BaseMemoryLib.h>\r
	23	#include <Library/DebugPrintErrorLevelLib.h>\r
	24	\r
	25	//\r
	26	// Define the maximum debug and assert message length that this library supports \r
	27	//\r
	28	#define MAX_DEBUG_MESSAGE_LENGTH 0x100\r
	29	\r
	30	/**\r
	31	Prints a debug message to the debug output device if the specified error level is enabled.\r
	32	\r
	33	If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function \r
	34	GetDebugPrintErrorLevel (), then print the message specified by Format and the \r
	35	associated variable argument list to the debug output device.\r
	36	\r
	37	If Format is NULL, then ASSERT().\r
	38	\r
	39	@param ErrorLevel The error level of the debug message.\r
	40	@param Format Format string for the debug message to print.\r
	41	@param ... A variable argument list whose contents are accessed \r
	42	based on the format string specified by Format.\r
	43	\r
	44	**/\r
	45	VOID\r
	46	EFIAPI\r
	47	DebugPrint (\r
	48	IN UINTN ErrorLevel,\r
	49	IN CONST CHAR8 *Format,\r
	50	...\r
	51	)\r
	52	{\r
	53	CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
	54	VA_LIST Marker;\r
	55	\r
	56	//\r
	57	// If Format is NULL, then ASSERT().\r
	58	//\r
	59	ASSERT (Format != NULL);\r
	60	\r
	61	//\r
	62	// Check driver debug mask value and global mask\r
	63	//\r
	64	if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {\r
	65	return;\r
	66	}\r
	67	\r
	68	//\r
	69	// Convert the DEBUG() message to a Unicode String\r
	70	//\r
	71	VA_START (Marker, Format);\r
	72	UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, Marker);\r
	73	VA_END (Marker);\r
	74	\r
	75	\r
	76	//\r
	77	// Send the print string to the Console Output device\r
	78	//\r
	79	if ((gST != NULL) && (gST->ConOut != NULL)) {\r
	80	gST->ConOut->OutputString (gST->ConOut, Buffer);\r
	81	}\r
	82	}\r
	83	\r
	84	\r
	85	/**\r
	86	Prints an assert message containing a filename, line number, and description. \r
	87	This may be followed by a breakpoint or a dead loop.\r
	88	\r
	89	Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
	90	to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
	91	PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
	92	DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
	93	CpuDeadLoop() is called. If neither of these bits are set, then this function \r
	94	returns immediately after the message is printed to the debug output device.\r
	95	DebugAssert() must actively prevent recursion. If DebugAssert() is called while\r
	96	processing another DebugAssert(), then DebugAssert() must return immediately.\r
	97	\r
	98	If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
	99	If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
	100	\r
	101	@param FileName The pointer to the name of the source file that generated \r
	102	the assert condition.\r
	103	@param LineNumber The line number in the source file that generated the \r
	104	assert condition\r
	105	@param Description The pointer to the description of the assert condition.\r
	106	\r
	107	**/\r
	108	VOID\r
	109	EFIAPI\r
	110	DebugAssert (\r
	111	IN CONST CHAR8 *FileName,\r
	112	IN UINTN LineNumber,\r
	113	IN CONST CHAR8 *Description\r
	114	)\r
	115	{\r
	116	CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
	117	\r
	118	//\r
	119	// Generate the ASSERT() message in Unicode format\r
	120	//\r
	121	UnicodeSPrintAsciiFormat (\r
	122	Buffer, \r
	123	sizeof (Buffer), \r
	124	"ASSERT [%a] %a(%d): %a\n",\r
	125	gEfiCallerBaseName,\r
	126	FileName, \r
	127	LineNumber, \r
	128	Description\r
	129	);\r
	130	\r
	131	//\r
	132	// Send the print string to the Console Output device\r
	133	//\r
	134	if ((gST != NULL) && (gST->ConOut != NULL)) {\r
	135	gST->ConOut->OutputString (gST->ConOut, Buffer);\r
	136	}\r
	137	\r
	138	//\r
	139	// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
	140	//\r
	141	if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
	142	CpuBreakpoint ();\r
	143	} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
	144	CpuDeadLoop ();\r
	145	}\r
	146	}\r
	147	\r
	148	\r
	149	/**\r
	150	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
	151	\r
	152	This function fills Length bytes of Buffer with the value specified by \r
	153	PcdDebugClearMemoryValue, and returns Buffer.\r
	154	\r
	155	If Buffer is NULL, then ASSERT().\r
	156	If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
	157	\r
	158	@param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
	159	@param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
	160	\r
	161	@return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
	162	\r
	163	**/\r
	164	VOID *\r
	165	EFIAPI\r
	166	DebugClearMemory (\r
	167	OUT VOID *Buffer,\r
	168	IN UINTN Length\r
	169	)\r
	170	{\r
	171	//\r
	172	// If Buffer is NULL, then ASSERT().\r
	173	//\r
	174	ASSERT (Buffer != NULL);\r
	175	\r
	176	//\r
	177	// SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
	178	//\r
	179	return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
	180	}\r
	181	\r
	182	\r
	183	/**\r
	184	Returns TRUE if ASSERT() macros are enabled.\r
	185	\r
	186	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
	187	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	188	\r
	189	@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
	190	@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
	191	\r
	192	**/\r
	193	BOOLEAN\r
	194	EFIAPI\r
	195	DebugAssertEnabled (\r
	196	VOID\r
	197	)\r
	198	{\r
	199	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
	200	}\r
	201	\r
	202	\r
	203	/** \r
	204	Returns TRUE if DEBUG() macros are enabled.\r
	205	\r
	206	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
	207	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	208	\r
	209	@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
	210	@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
	211	\r
	212	**/\r
	213	BOOLEAN\r
	214	EFIAPI\r
	215	DebugPrintEnabled (\r
	216	VOID\r
	217	)\r
	218	{\r
	219	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
	220	}\r
	221	\r
	222	\r
	223	/** \r
	224	Returns TRUE if DEBUG_CODE() macros are enabled.\r
	225	\r
	226	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
	227	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	228	\r
	229	@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
	230	@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
	231	\r
	232	**/\r
	233	BOOLEAN\r
	234	EFIAPI\r
	235	DebugCodeEnabled (\r
	236	VOID\r
	237	)\r
	238	{\r
	239	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
	240	}\r
	241	\r
	242	\r
	243	/** \r
	244	Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
	245	\r
	246	This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
	247	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	248	\r
	249	@retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
	250	@retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
	251	\r
	252	**/\r
	253	BOOLEAN\r
	254	EFIAPI\r
	255	DebugClearMemoryEnabled (\r
	256	VOID\r
	257	)\r
	258	{\r
	259	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
	260	}\r
	261	\r
	262	/**\r
	263	Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
	264	\r
	265	This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
	266	\r
	267	@retval TRUE Current ErrorLevel is supported.\r
	268	@retval FALSE Current ErrorLevel is not supported.\r
	269	\r
	270	**/\r
	271	BOOLEAN\r
	272	EFIAPI\r
	273	DebugPrintLevelEnabled (\r
	274	IN CONST UINTN ErrorLevel\r
	275	)\r
	276	{\r
	277	return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);\r
	278	}\r