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