[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 - 2011, 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
    MAX_DEBUG_MESSAGE_LENGTH, \r
    "ASSERT %a(%d): %a\n", \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
Commit	Line	Data
e386b444	1	/** @file\r
eceb3a4c	2	UEFI Debug Library that sends messages to the Console Output Device in the EFI System Table.\r
e386b444	3	\r
2891fc8b	4	Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
19388d29	5	This program and the accompanying materials \r
e386b444	6	are licensed and made available under the terms and conditions of the BSD License \r
e386b444	7	which accompanies this distribution. The full text of the license may be found at \r
2fc59a00	8	http://opensource.org/licenses/bsd-license.php. \r
e386b444	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
c7d265a9	15	#include <Uefi.h>\r
c892d846	16	\r
c7d265a9	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
2891fc8b	23	#include <Library/DebugPrintErrorLevelLib.h>\r
c7d265a9	24	\r
e386b444	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
e386b444	30	/**\r
e386b444	31	Prints a debug message to the debug output device if the specified error level is enabled.\r
e386b444	32	\r
2891fc8b	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
e386b444	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
58380e9c	41	@param ... A variable argument list whose contents are accessed \r
285010e7	42	based on the format string specified by Format.\r
e386b444	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
2891fc8b	64	if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {\r
e386b444	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
7c6d32a5	72	UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, Marker);\r
e386b444	73	VA_END (Marker);\r
e386b444	74	\r
457cfbae	75	\r
e386b444	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
e386b444	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
3e5c3238	89	Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
e386b444	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
3e5c3238	95	DebugAssert() must actively prevent recursion. If DebugAssert() is called while\r
e386b444	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
e386b444	99	If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
e386b444	100	\r
58380e9c	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
2fc59a00	105	@param Description The pointer to the description of the assert condition.\r
e386b444	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
7c6d32a5	121	UnicodeSPrintAsciiFormat (\r
	122	Buffer, \r
	123	MAX_DEBUG_MESSAGE_LENGTH, \r
	124	"ASSERT %a(%d): %a\n", \r
	125	FileName, \r
	126	LineNumber, \r
	127	Description\r
	128	);\r
	129	\r
e386b444	130	//\r
	131	// Send the print string to the Console Output device\r
	132	//\r
	133	if ((gST != NULL) && (gST->ConOut != NULL)) {\r
	134	gST->ConOut->OutputString (gST->ConOut, Buffer);\r
	135	}\r
	136	\r
	137	//\r
	138	// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
	139	//\r
	140	if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
	141	CpuBreakpoint ();\r
	142	} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
	143	CpuDeadLoop ();\r
	144	}\r
	145	}\r
	146	\r
	147	\r
	148	/**\r
e386b444	149	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
	150	\r
	151	This function fills Length bytes of Buffer with the value specified by \r
	152	PcdDebugClearMemoryValue, and returns Buffer.\r
	153	\r
	154	If Buffer is NULL, then ASSERT().\r
4ef55dfc	155	If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
e386b444	156	\r
2fc59a00	157	@param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
2fc59a00	158	@param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
e386b444	159	\r
2fc59a00	160	@return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
e386b444	161	\r
	162	**/\r
	163	VOID *\r
	164	EFIAPI\r
	165	DebugClearMemory (\r
	166	OUT VOID *Buffer,\r
	167	IN UINTN Length\r
	168	)\r
	169	{\r
	170	//\r
	171	// If Buffer is NULL, then ASSERT().\r
	172	//\r
	173	ASSERT (Buffer != NULL);\r
	174	\r
	175	//\r
	176	// SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
	177	//\r
	178	return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
	179	}\r
	180	\r
	181	\r
	182	/**\r
e386b444	183	Returns TRUE if ASSERT() macros are enabled.\r
	184	\r
	185	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
	186	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	187	\r
	188	@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
	189	@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
	190	\r
	191	**/\r
	192	BOOLEAN\r
	193	EFIAPI\r
	194	DebugAssertEnabled (\r
	195	VOID\r
	196	)\r
	197	{\r
	198	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
	199	}\r
	200	\r
	201	\r
3e5c3238	202	/** \r
3e5c3238	203	Returns TRUE if DEBUG() macros are enabled.\r
e386b444	204	\r
	205	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
	206	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	207	\r
	208	@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
	209	@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
	210	\r
	211	**/\r
	212	BOOLEAN\r
	213	EFIAPI\r
	214	DebugPrintEnabled (\r
	215	VOID\r
	216	)\r
	217	{\r
	218	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
	219	}\r
	220	\r
	221	\r
3e5c3238	222	/** \r
3e5c3238	223	Returns TRUE if DEBUG_CODE() macros are enabled.\r
e386b444	224	\r
	225	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
	226	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	227	\r
	228	@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
	229	@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
	230	\r
	231	**/\r
	232	BOOLEAN\r
	233	EFIAPI\r
	234	DebugCodeEnabled (\r
	235	VOID\r
	236	)\r
	237	{\r
	238	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
	239	}\r
	240	\r
	241	\r
3e5c3238	242	/** \r
3e5c3238	243	Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
e386b444	244	\r
eceb3a4c	245	This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
e386b444	246	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
e386b444	247	\r
eceb3a4c LG	248	@retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
eceb3a4c LG	249	@retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
e386b444	250	\r
	251	**/\r
	252	BOOLEAN\r
	253	EFIAPI\r
	254	DebugClearMemoryEnabled (\r
	255	VOID\r
	256	)\r
	257	{\r
	258	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
	259	}\r