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

/** @file\r
  UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.\r
\r
  Copyright (c) 2006 - 2008, 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
\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
\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
/**\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 PcdDebugPrintErrorLevel, then print \r
  the message specified by Format and the associated variable argument list to \r
  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  ...         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 & PcdGet32(PcdDebugPrintErrorLevel)) == 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
  // Send the print string to the Standard Error device\r
  //\r
  if ((gST != NULL) && (gST->StdErr != NULL)) {\r
    gST->StdErr->OutputString (gST->StdErr, 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     Pointer to the name of the source file that generated the assert condition.\r
  @param  LineNumber   The line number in the source file that generated the assert condition\r
  @param  Description  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 Standard Error device\r
  //\r
  if ((gST != NULL) && (gST->StdErr != NULL)) {\r
    gST->StdErr->OutputString (gST->StdErr, 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  Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
  @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
  @return  Buffer  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 Lib that sends messages to the Standard Error Device in the EFI System Table.\r
e386b444	3	\r
19388d29 HT	4	Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
19388d29 HT	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
	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
c892d846	15	\r
c7d265a9	16	#include <Uefi.h>\r
c892d846	17	\r
c7d265a9	18	#include <Library/DebugLib.h>\r
	19	#include <Library/UefiBootServicesTableLib.h>\r
	20	#include <Library/PrintLib.h>\r
	21	#include <Library/PcdLib.h>\r
	22	#include <Library/BaseLib.h>\r
	23	#include <Library/BaseMemoryLib.h>\r
e386b444	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	/**\r
e386b444	32	Prints a debug message to the debug output device if the specified error level is enabled.\r
	33	\r
	34	If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print \r
	35	the message specified by Format and the associated variable argument list to \r
	36	the debug output device.\r
	37	\r
	38	If Format is NULL, then ASSERT().\r
	39	\r
	40	@param ErrorLevel The error level of the debug message.\r
	41	@param Format Format string for the debug message to print.\r
285010e7	42	@param ... Variable argument list whose contents are accessed \r
285010e7	43	based on the format string specified by Format.\r
e386b444	44	\r
	45	**/\r
	46	VOID\r
	47	EFIAPI\r
	48	DebugPrint (\r
	49	IN UINTN ErrorLevel,\r
	50	IN CONST CHAR8 *Format,\r
	51	...\r
	52	)\r
	53	{\r
	54	CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
	55	VA_LIST Marker;\r
	56	\r
	57	//\r
	58	// If Format is NULL, then ASSERT().\r
	59	//\r
	60	ASSERT (Format != NULL);\r
	61	\r
	62	//\r
	63	// Check driver debug mask value and global mask\r
	64	//\r
	65	if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {\r
	66	return;\r
	67	}\r
	68	\r
	69	//\r
	70	// Convert the DEBUG() message to a Unicode String\r
	71	//\r
	72	VA_START (Marker, Format);\r
6cff95cd	73	UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, Marker);\r
e386b444	74	VA_END (Marker);\r
	75	\r
	76	//\r
	77	// Send the print string to the Standard Error device\r
	78	//\r
	79	if ((gST != NULL) && (gST->StdErr != NULL)) {\r
	80	gST->StdErr->OutputString (gST->StdErr, 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
	100	\r
	101	@param FileName Pointer to the name of the source file that generated the assert condition.\r
	102	@param LineNumber The line number in the source file that generated the assert condition\r
	103	@param Description Pointer to the description of the assert condition.\r
	104	\r
	105	**/\r
	106	VOID\r
	107	EFIAPI\r
	108	DebugAssert (\r
	109	IN CONST CHAR8 *FileName,\r
	110	IN UINTN LineNumber,\r
	111	IN CONST CHAR8 *Description\r
	112	)\r
	113	{\r
	114	CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
	115	\r
	116	//\r
	117	// Generate the ASSERT() message in Unicode format\r
	118	//\r
6cff95cd	119	UnicodeSPrintAsciiFormat (\r
	120	Buffer, \r
	121	MAX_DEBUG_MESSAGE_LENGTH,\r
	122	"ASSERT %a(%d): %a\n", \r
	123	FileName, \r
	124	LineNumber, \r
	125	Description\r
	126	);\r
	127	\r
e386b444	128	//\r
	129	// Send the print string to the Standard Error device\r
	130	//\r
	131	if ((gST != NULL) && (gST->StdErr != NULL)) {\r
	132	gST->StdErr->OutputString (gST->StdErr, Buffer);\r
	133	}\r
	134	\r
	135	//\r
	136	// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
	137	//\r
	138	if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
	139	CpuBreakpoint ();\r
	140	} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
	141	CpuDeadLoop ();\r
	142	}\r
	143	}\r
	144	\r
	145	\r
	146	/**\r
e386b444	147	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
	148	\r
	149	This function fills Length bytes of Buffer with the value specified by \r
	150	PcdDebugClearMemoryValue, and returns Buffer.\r
	151	\r
	152	If Buffer is NULL, then ASSERT().\r
4ef55dfc	153	If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
e386b444	154	\r
3e5c3238	155	@param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
e386b444	156	@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
e386b444	157	\r
eceb3a4c	158	@return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
e386b444	159	\r
	160	**/\r
	161	VOID *\r
	162	EFIAPI\r
	163	DebugClearMemory (\r
	164	OUT VOID *Buffer,\r
	165	IN UINTN Length\r
	166	)\r
	167	{\r
	168	//\r
	169	// If Buffer is NULL, then ASSERT().\r
	170	//\r
	171	ASSERT (Buffer != NULL);\r
	172	\r
	173	//\r
	174	// SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
	175	//\r
	176	return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
	177	}\r
	178	\r
	179	\r
	180	/**\r
e386b444	181	Returns TRUE if ASSERT() macros are enabled.\r
	182	\r
	183	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
	184	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	185	\r
	186	@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
	187	@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
	188	\r
	189	**/\r
	190	BOOLEAN\r
	191	EFIAPI\r
	192	DebugAssertEnabled (\r
	193	VOID\r
	194	)\r
	195	{\r
	196	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
	197	}\r
	198	\r
	199	\r
3e5c3238	200	/** \r
3e5c3238	201	Returns TRUE if DEBUG() macros are enabled.\r
e386b444	202	\r
	203	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
	204	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	205	\r
	206	@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
	207	@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
	208	\r
	209	**/\r
	210	BOOLEAN\r
	211	EFIAPI\r
	212	DebugPrintEnabled (\r
	213	VOID\r
	214	)\r
	215	{\r
	216	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
	217	}\r
	218	\r
	219	\r
3e5c3238	220	/** \r
3e5c3238	221	Returns TRUE if DEBUG_CODE() macros are enabled.\r
e386b444	222	\r
	223	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
	224	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	225	\r
	226	@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
	227	@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
	228	\r
	229	**/\r
	230	BOOLEAN\r
	231	EFIAPI\r
	232	DebugCodeEnabled (\r
	233	VOID\r
	234	)\r
	235	{\r
	236	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
	237	}\r
	238	\r
	239	\r
3e5c3238	240	/** \r
3e5c3238	241	Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
e386b444	242	\r
eceb3a4c	243	This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
e386b444	244	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
e386b444	245	\r
eceb3a4c LG	246	@retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
eceb3a4c LG	247	@retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
e386b444	248	\r
	249	**/\r
	250	BOOLEAN\r
	251	EFIAPI\r
	252	DebugClearMemoryEnabled (\r
	253	VOID\r
	254	)\r
	255	{\r
	256	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
	257	}\r