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

/** @file\r
  Base Debug library instance base on Serial Port library.\r
  It uses PrintLib to send debug messages to serial port device.\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
#include <PiDxe.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/SerialPortLib.h>\r
\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  ...         The variable argument list.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugPrint (\r
  IN  UINTN        ErrorLevel,\r
  IN  CONST CHAR8  *Format,\r
  ...\r
  )\r
{\r
  CHAR8    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 an ASCII String\r
  //\r
  VA_START (Marker, Format);\r
  AsciiVSPrint (Buffer, sizeof (Buffer), Format, Marker);\r
  VA_END (Marker);\r
\r
  //\r
  // Send the print string to a Serial Port \r
  //\r
  SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(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 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
  CHAR8  Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
\r
  //\r
  // Generate the ASSERT() message in Unicode format\r
  //\r
  AsciiSPrint (Buffer, sizeof (Buffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);\r
\r
  //\r
  // Send the print string to the Console Output device\r
  //\r
  SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(Buffer));\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 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
  \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
7bc232b2	1	/** @file\r
eceb3a4c LG	2	Base Debug library instance base on Serial Port library.\r
eceb3a4c LG	3	It uses PrintLib to send debug messages to serial port device.\r
7bc232b2	4	\r
eceb3a4c	5	Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
7bc232b2 LG	6	All rights reserved. This program and the accompanying materials \r
	7	are licensed and made available under the terms and conditions of the BSD License \r
	8	which accompanies this distribution. The full text of the license may be found at \r
	9	http://opensource.org/licenses/bsd-license.php \r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	13	\r
	14	**/\r
	15	\r
859b72fa A	16	#include <PiDxe.h>\r
	17	#include <Library/DebugLib.h>\r
	18	#include <Library/BaseLib.h>\r
	19	#include <Library/PrintLib.h>\r
	20	#include <Library/PcdLib.h>\r
	21	#include <Library/BaseMemoryLib.h>\r
	22	#include <Library/SerialPortLib.h>\r
	23	\r
7bc232b2 LG	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
	32	\r
	33	Prints a debug message to the debug output device if the specified error level is enabled.\r
	34	\r
	35	If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print \r
	36	the message specified by Format and the associated variable argument list to \r
	37	the debug output device.\r
	38	\r
	39	If Format is NULL, then ASSERT().\r
	40	\r
	41	@param ErrorLevel The error level of the debug message.\r
	42	@param Format Format string for the debug message to print.\r
eceb3a4c	43	@param ... The variable argument list.\r
7bc232b2 LG	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	CHAR8 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 an ASCII String\r
	71	//\r
	72	VA_START (Marker, Format);\r
	73	AsciiVSPrint (Buffer, sizeof (Buffer), Format, Marker);\r
	74	VA_END (Marker);\r
	75	\r
	76	//\r
	77	// Send the print string to a Serial Port \r
	78	//\r
	79	SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(Buffer));\r
	80	}\r
	81	\r
	82	\r
	83	/**\r
	84	\r
	85	Prints an assert message containing a filename, line number, and description. \r
	86	This may be followed by a breakpoint or a dead loop.\r
	87	\r
	88	Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" \r
	89	to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
	90	PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
	91	DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
	92	CpuDeadLoop() is called. If neither of these bits are set, then this function \r
	93	returns immediately after the message is printed to the debug output device.\r
	94	DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while\r
	95	processing another DebugAssert(), then DebugAssert() must return immediately.\r
	96	\r
	97	If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
	98	\r
	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	CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
115	\r
116	//\r
117	// Generate the ASSERT() message in Unicode format\r
118	//\r
119	AsciiSPrint (Buffer, sizeof (Buffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);\r
120	\r
121	//\r
122	// Send the print string to the Console Output device\r
123	//\r
124	SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(Buffer));\r
125	\r
126	//\r
127	// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
128	//\r
129	if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
130	CpuBreakpoint ();\r
131	} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
132	CpuDeadLoop ();\r
133	}\r
134	}\r
135	\r
136	\r
137	/**\r
138	\r
139	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
140	\r
141	This function fills Length bytes of Buffer with the value specified by \r
142	PcdDebugClearMemoryValue, and returns Buffer.\r
143	\r
144	If Buffer is NULL, then ASSERT().\r
145	\r
146	If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT(). \r
147	\r
eceb3a4c	148	@param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
7bc232b2 LG	149	@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
7bc232b2 LG	150	\r
eceb3a4c	151	@return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
7bc232b2 LG	152	\r
	153	**/\r
	154	VOID *\r
	155	EFIAPI\r
	156	DebugClearMemory (\r
	157	OUT VOID *Buffer,\r
	158	IN UINTN Length\r
	159	)\r
	160	{\r
	161	//\r
	162	// If Buffer is NULL, then ASSERT().\r
	163	//\r
	164	ASSERT (Buffer != NULL);\r
	165	\r
	166	//\r
	167	// SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
	168	//\r
	169	return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
	170	}\r
	171	\r
	172	\r
	173	/**\r
	174	\r
	175	Returns TRUE if ASSERT() macros are enabled.\r
	176	\r
	177	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
	178	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	179	\r
	180	@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
	181	@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
	182	\r
	183	**/\r
	184	BOOLEAN\r
	185	EFIAPI\r
	186	DebugAssertEnabled (\r
	187	VOID\r
	188	)\r
	189	{\r
	190	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
	191	}\r
	192	\r
	193	\r
	194	/**\r
	195	\r
	196	Returns TRUE if DEBUG()macros are enabled.\r
	197	\r
	198	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
	199	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	200	\r
	201	@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
	202	@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
	203	\r
	204	**/\r
	205	BOOLEAN\r
	206	EFIAPI\r
	207	DebugPrintEnabled (\r
	208	VOID\r
	209	)\r
	210	{\r
	211	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
	212	}\r
	213	\r
	214	\r
	215	/**\r
216	\r
217	Returns TRUE if DEBUG_CODE()macros are enabled.\r
218	\r
219	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
220	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
221	\r
222	@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
223	@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
224	\r
225	**/\r
226	BOOLEAN\r
227	EFIAPI\r
228	DebugCodeEnabled (\r
229	VOID\r
230	)\r
231	{\r
232	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
233	}\r
234	\r
235	\r
236	/**\r
237	\r
238	Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
239	\r
eceb3a4c	240	This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
7bc232b2 LG	241	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
7bc232b2 LG	242	\r
eceb3a4c LG	243	@retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
eceb3a4c LG	244	@retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
7bc232b2 LG	245	\r
	246	**/\r
	247	BOOLEAN\r
	248	EFIAPI\r
	249	DebugClearMemoryEnabled (\r
	250	VOID\r
	251	)\r
	252	{\r
	253	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
	254	}\r