[mirror_edk2.git] / ArmPkg / Library / SemiHostingDebugLib / DebugLib.c

/** @file\r
  UEFI Debug Library that uses PrintLib to send messages to STDERR.\r
\r
  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
  Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include <Uefi.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/SemihostLib.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
// VA_LIST can not initialize to NULL for all compiler, so we use this to\r
// indicate a null VA_LIST\r
//\r
VA_LIST     mVaListNull;\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
\r
**/\r
VOID\r
EFIAPI\r
DebugPrint (\r
  IN  UINTN        ErrorLevel,\r
  IN  CONST CHAR8  *Format,\r
  ...\r
  )\r
{\r
  VA_LIST         Marker;\r
\r
  VA_START (Marker, Format);\r
  DebugVPrint (ErrorLevel, Format, Marker);\r
  VA_END (Marker);\r
}\r
\r
\r
/**\r
  Prints a debug message to the debug output device if the specified\r
  error level is enabled base on Null-terminated format string and a\r
  VA_LIST argument list or a BASE_LIST argument list.\r
\r
  If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r
  GetDebugPrintErrorLevel (), then print the message specified by Format and\r
  the 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  VaListMarker    VA_LIST marker for the variable argument list.\r
  @param  BaseListMarker  BASE_LIST marker for the variable argument list.\r
\r
**/\r
VOID\r
DebugPrintMarker (\r
  IN  UINTN         ErrorLevel,\r
  IN  CONST CHAR8   *Format,\r
  IN  VA_LIST       VaListMarker,\r
  IN  BASE_LIST     BaseListMarker\r
  )\r
{\r
  CHAR8    AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];\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
  if (BaseListMarker == NULL) {\r
    AsciiVSPrint (AsciiBuffer, sizeof (AsciiBuffer), Format, VaListMarker);\r
  } else {\r
    AsciiBSPrint (AsciiBuffer, sizeof (AsciiBuffer), Format, BaseListMarker);\r
  }\r
\r
  SemihostWriteString (AsciiBuffer);\r
}\r
\r
\r
/**\r
  Prints a debug message to the debug output device if the specified\r
  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\r
  the 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  VaListMarker  VA_LIST marker for the variable argument list.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugVPrint (\r
  IN  UINTN         ErrorLevel,\r
  IN  CONST CHAR8   *Format,\r
  IN  VA_LIST       VaListMarker\r
  )\r
{\r
  DebugPrintMarker (ErrorLevel, Format, VaListMarker, NULL);\r
}\r
\r
\r
/**\r
  Prints a debug message to the debug output device if the specified\r
  error level is enabled.\r
  This function use BASE_LIST which would provide a more compatible\r
  service than VA_LIST.\r
\r
  If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r
  GetDebugPrintErrorLevel (), then print the message specified by Format and\r
  the 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  BaseListMarker  BASE_LIST marker for the variable argument list.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugBPrint (\r
  IN  UINTN         ErrorLevel,\r
  IN  CONST CHAR8   *Format,\r
  IN  BASE_LIST     BaseListMarker\r
  )\r
{\r
  DebugPrintMarker (ErrorLevel, Format, mVaListNull, BaseListMarker);\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
  PcdDebugPropertyMask is set then CpuBreakpoint() is called. Otherwise, if\r
  DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugPropertyMask 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
\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
  CHAR8   AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];\r
\r
  //\r
  // Generate the ASSERT() message in Unicode format\r
  //\r
  AsciiSPrint (AsciiBuffer, sizeof (AsciiBuffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);\r
\r
  SemihostWriteString (AsciiBuffer);\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\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 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
  PcdDebugPropertyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask 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
  PcdDebugPropertyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask 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
  PcdDebugPropertyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask 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_DEBUG_CLEAR_MEMORY_ENABLED bit of\r
  PcdDebugPropertyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask 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
2ef2b01e A	1	/** @file\r
	2	UEFI Debug Library that uses PrintLib to send messages to STDERR.\r
	3	\r
92c0bbd1	4	Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
d6ebcab7	5	Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
4059386c	6	SPDX-License-Identifier: BSD-2-Clause-Patent\r
2ef2b01e A	7	\r
	8	**/\r
	9	\r
	10	\r
	11	#include <Uefi.h>\r
	12	#include <Library/DebugLib.h>\r
	13	#include <Library/PrintLib.h>\r
	14	#include <Library/PcdLib.h>\r
	15	#include <Library/BaseLib.h>\r
	16	#include <Library/BaseMemoryLib.h>\r
	17	#include <Library/SemihostLib.h>\r
	18	\r
	19	//\r
3402aac7	20	// Define the maximum debug and assert message length that this library supports\r
2ef2b01e A	21	//\r
	22	#define MAX_DEBUG_MESSAGE_LENGTH 0x100\r
	23	\r
92c0bbd1 BB	24	//\r
	25	// VA_LIST can not initialize to NULL for all compiler, so we use this to\r
	26	// indicate a null VA_LIST\r
	27	//\r
	28	VA_LIST mVaListNull;\r
	29	\r
2ef2b01e A	30	/**\r
	31	\r
	32	Prints a debug message to the debug output device if the specified error level is enabled.\r
	33	\r
3402aac7 RC	34	If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print\r
3402aac7 RC	35	the message specified by Format and the associated variable argument list to\r
2ef2b01e A	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
	42	\r
	43	**/\r
	44	VOID\r
	45	EFIAPI\r
	46	DebugPrint (\r
	47	IN UINTN ErrorLevel,\r
	48	IN CONST CHAR8 *Format,\r
	49	...\r
	50	)\r
92c0bbd1 BB	51	{\r
	52	VA_LIST Marker;\r
	53	\r
	54	VA_START (Marker, Format);\r
	55	DebugVPrint (ErrorLevel, Format, Marker);\r
	56	VA_END (Marker);\r
	57	}\r
	58	\r
	59	\r
	60	/**\r
	61	Prints a debug message to the debug output device if the specified\r
	62	error level is enabled base on Null-terminated format string and a\r
	63	VA_LIST argument list or a BASE_LIST argument list.\r
	64	\r
	65	If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r
	66	GetDebugPrintErrorLevel (), then print the message specified by Format and\r
	67	the associated variable argument list to the debug output device.\r
	68	\r
	69	If Format is NULL, then ASSERT().\r
	70	\r
	71	@param ErrorLevel The error level of the debug message.\r
	72	@param Format Format string for the debug message to print.\r
	73	@param VaListMarker VA_LIST marker for the variable argument list.\r
	74	@param BaseListMarker BASE_LIST marker for the variable argument list.\r
	75	\r
	76	**/\r
	77	VOID\r
	78	DebugPrintMarker (\r
	79	IN UINTN ErrorLevel,\r
	80	IN CONST CHAR8 *Format,\r
	81	IN VA_LIST VaListMarker,\r
	82	IN BASE_LIST BaseListMarker\r
	83	)\r
2ef2b01e A	84	{\r
2ef2b01e A	85	CHAR8 AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];\r
2ef2b01e A	86	\r
	87	//\r
	88	// If Format is NULL, then ASSERT().\r
	89	//\r
	90	ASSERT (Format != NULL);\r
	91	\r
	92	//\r
	93	// Check driver debug mask value and global mask\r
	94	//\r
	95	if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {\r
	96	return;\r
	97	}\r
	98	\r
	99	//\r
	100	// Convert the DEBUG() message to a Unicode String\r
	101	//\r
92c0bbd1 BB	102	if (BaseListMarker == NULL) {\r
	103	AsciiVSPrint (AsciiBuffer, sizeof (AsciiBuffer), Format, VaListMarker);\r
	104	} else {\r
	105	AsciiBSPrint (AsciiBuffer, sizeof (AsciiBuffer), Format, BaseListMarker);\r
	106	}\r
2ef2b01e A	107	\r
	108	SemihostWriteString (AsciiBuffer);\r
	109	}\r
	110	\r
	111	\r
92c0bbd1 BB	112	/**\r
	113	Prints a debug message to the debug output device if the specified\r
	114	error level is enabled.\r
	115	\r
	116	If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r
	117	GetDebugPrintErrorLevel (), then print the message specified by Format and\r
	118	the associated variable argument list to the debug output device.\r
	119	\r
	120	If Format is NULL, then ASSERT().\r
	121	\r
	122	@param ErrorLevel The error level of the debug message.\r
	123	@param Format Format string for the debug message to print.\r
	124	@param VaListMarker VA_LIST marker for the variable argument list.\r
	125	\r
	126	**/\r
	127	VOID\r
	128	EFIAPI\r
	129	DebugVPrint (\r
	130	IN UINTN ErrorLevel,\r
	131	IN CONST CHAR8 *Format,\r
	132	IN VA_LIST VaListMarker\r
	133	)\r
	134	{\r
	135	DebugPrintMarker (ErrorLevel, Format, VaListMarker, NULL);\r
	136	}\r
	137	\r
	138	\r
	139	/**\r
	140	Prints a debug message to the debug output device if the specified\r
	141	error level is enabled.\r
	142	This function use BASE_LIST which would provide a more compatible\r
	143	service than VA_LIST.\r
	144	\r
	145	If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r
	146	GetDebugPrintErrorLevel (), then print the message specified by Format and\r
	147	the associated variable argument list to the debug output device.\r
	148	\r
	149	If Format is NULL, then ASSERT().\r
	150	\r
	151	@param ErrorLevel The error level of the debug message.\r
	152	@param Format Format string for the debug message to print.\r
	153	@param BaseListMarker BASE_LIST marker for the variable argument list.\r
	154	\r
	155	**/\r
	156	VOID\r
	157	EFIAPI\r
	158	DebugBPrint (\r
	159	IN UINTN ErrorLevel,\r
	160	IN CONST CHAR8 *Format,\r
	161	IN BASE_LIST BaseListMarker\r
	162	)\r
	163	{\r
	164	DebugPrintMarker (ErrorLevel, Format, mVaListNull, BaseListMarker);\r
	165	}\r
	166	\r
	167	\r
2ef2b01e A	168	/**\r
2ef2b01e A	169	\r
3402aac7	170	Prints an assert message containing a filename, line number, and description.\r
2ef2b01e A	171	This may be followed by a breakpoint or a dead loop.\r
2ef2b01e A	172	\r
3402aac7 RC	173	Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
3402aac7 RC	174	to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of\r
ff5fef14 AC	175	PcdDebugPropertyMask is set then CpuBreakpoint() is called. Otherwise, if\r
ff5fef14 AC	176	DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugPropertyMask is set then\r
3402aac7	177	CpuDeadLoop() is called. If neither of these bits are set, then this function\r
2ef2b01e	178	returns immediately after the message is printed to the debug output device.\r
ff5fef14	179	DebugAssert() must actively prevent recursion. If DebugAssert() is called while\r
2ef2b01e A	180	processing another DebugAssert(), then DebugAssert() must return immediately.\r
	181	\r
	182	If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
	183	\r
	184	If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
	185	\r
	186	@param FileName Pointer to the name of the source file that generated the assert condition.\r
	187	@param LineNumber The line number in the source file that generated the assert condition\r
	188	@param Description Pointer to the description of the assert condition.\r
	189	\r
	190	**/\r
	191	VOID\r
	192	EFIAPI\r
	193	DebugAssert (\r
	194	IN CONST CHAR8 *FileName,\r
	195	IN UINTN LineNumber,\r
	196	IN CONST CHAR8 *Description\r
	197	)\r
	198	{\r
	199	CHAR8 AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];\r
	200	\r
	201	//\r
	202	// Generate the ASSERT() message in Unicode format\r
	203	//\r
	204	AsciiSPrint (AsciiBuffer, sizeof (AsciiBuffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);\r
	205	\r
	206	SemihostWriteString (AsciiBuffer);\r
	207	\r
	208	//\r
	209	// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
	210	//\r
	211	if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
	212	CpuBreakpoint ();\r
	213	} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
	214	CpuDeadLoop ();\r
	215	}\r
	216	}\r
	217	\r
	218	\r
	219	/**\r
	220	\r
	221	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
	222	\r
3402aac7	223	This function fills Length bytes of Buffer with the value specified by\r
2ef2b01e A	224	PcdDebugClearMemoryValue, and returns Buffer.\r
	225	\r
	226	If Buffer is NULL, then ASSERT().\r
	227	\r
3402aac7	228	If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().\r
2ef2b01e A	229	\r
2ef2b01e A	230	@param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
3402aac7	231	@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.\r
2ef2b01e A	232	\r
	233	@return Buffer\r
	234	\r
	235	**/\r
	236	VOID *\r
	237	EFIAPI\r
	238	DebugClearMemory (\r
	239	OUT VOID *Buffer,\r
	240	IN UINTN Length\r
	241	)\r
	242	{\r
	243	//\r
	244	// If Buffer is NULL, then ASSERT().\r
	245	//\r
	246	ASSERT (Buffer != NULL);\r
	247	\r
	248	//\r
ff5fef14	249	// SetMem() checks for the ASSERT() condition on Length and returns Buffer\r
2ef2b01e A	250	//\r
	251	return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
	252	}\r
	253	\r
	254	\r
	255	/**\r
3402aac7	256	\r
2ef2b01e A	257	Returns TRUE if ASSERT() macros are enabled.\r
2ef2b01e A	258	\r
3402aac7	259	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of\r
ff5fef14	260	PcdDebugPropertyMask is set. Otherwise FALSE is returned.\r
2ef2b01e	261	\r
ff5fef14 AC	262	@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask is set.\r
ff5fef14 AC	263	@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask is clear.\r
2ef2b01e A	264	\r
	265	**/\r
	266	BOOLEAN\r
	267	EFIAPI\r
	268	DebugAssertEnabled (\r
	269	VOID\r
	270	)\r
	271	{\r
	272	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
	273	}\r
	274	\r
	275	\r
	276	/**\r
3402aac7	277	\r
2ef2b01e A	278	Returns TRUE if DEBUG()macros are enabled.\r
2ef2b01e A	279	\r
3402aac7	280	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of\r
ff5fef14	281	PcdDebugPropertyMask is set. Otherwise FALSE is returned.\r
2ef2b01e	282	\r
ff5fef14 AC	283	@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is set.\r
ff5fef14 AC	284	@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is clear.\r
2ef2b01e A	285	\r
	286	**/\r
	287	BOOLEAN\r
	288	EFIAPI\r
	289	DebugPrintEnabled (\r
	290	VOID\r
	291	)\r
	292	{\r
	293	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
	294	}\r
	295	\r
	296	\r
	297	/**\r
3402aac7	298	\r
2ef2b01e A	299	Returns TRUE if DEBUG_CODE()macros are enabled.\r
2ef2b01e A	300	\r
3402aac7	301	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of\r
ff5fef14	302	PcdDebugPropertyMask is set. Otherwise FALSE is returned.\r
2ef2b01e	303	\r
ff5fef14 AC	304	@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is set.\r
ff5fef14 AC	305	@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is clear.\r
2ef2b01e A	306	\r
	307	**/\r
	308	BOOLEAN\r
	309	EFIAPI\r
	310	DebugCodeEnabled (\r
	311	VOID\r
	312	)\r
	313	{\r
	314	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
	315	}\r
	316	\r
	317	\r
	318	/**\r
3402aac7	319	\r
2ef2b01e A	320	Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
2ef2b01e A	321	\r
3402aac7	322	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of\r
ff5fef14	323	PcdDebugPropertyMask is set. Otherwise FALSE is returned.\r
2ef2b01e	324	\r
ff5fef14 AC	325	@retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is set.\r
ff5fef14 AC	326	@retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is clear.\r
2ef2b01e A	327	\r
	328	**/\r
	329	BOOLEAN\r
	330	EFIAPI\r
	331	DebugClearMemoryEnabled (\r
	332	VOID\r
	333	)\r
	334	{\r
	335	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
	336	}\r