[mirror_edk2.git] / MdePkg / Library / BaseDebugLibSerialPort / 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 <Base.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
  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
  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
  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 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 the DEBUG() macro is 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 the 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 the 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
0eeb6d1f	16	#include <Base.h>\r
859b72fa A	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
7bc232b2 LG	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
eceb3a4c	42	@param ... The variable argument list.\r
7bc232b2 LG	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	CHAR8 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
	64	if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {\r
	65	return;\r
	66	}\r
	67	\r
	68	//\r
	69	// Convert the DEBUG() message to an ASCII String\r
	70	//\r
	71	VA_START (Marker, Format);\r
	72	AsciiVSPrint (Buffer, sizeof (Buffer), Format, Marker);\r
	73	VA_END (Marker);\r
	74	\r
	75	//\r
	76	// Send the print string to a Serial Port \r
	77	//\r
	78	SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(Buffer));\r
	79	}\r
	80	\r
	81	\r
	82	/**\r
7bc232b2 LG	83	Prints an assert message containing a filename, line number, and description. \r
	84	This may be followed by a breakpoint or a dead loop.\r
	85	\r
	86	Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" \r
	87	to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
	88	PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
	89	DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
	90	CpuDeadLoop() is called. If neither of these bits are set, then this function \r
	91	returns immediately after the message is printed to the debug output device.\r
	92	DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while\r
	93	processing another DebugAssert(), then DebugAssert() must return immediately.\r
	94	\r
	95	If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
	96	\r
	97	If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
	98	\r
	99	@param FileName Pointer to the name of the source file that generated the assert condition.\r
	100	@param LineNumber The line number in the source file that generated the assert condition\r
	101	@param Description Pointer to the description of the assert condition.\r
	102	\r
	103	**/\r
	104	VOID\r
	105	EFIAPI\r
	106	DebugAssert (\r
	107	IN CONST CHAR8 *FileName,\r
	108	IN UINTN LineNumber,\r
	109	IN CONST CHAR8 *Description\r
	110	)\r
	111	{\r
	112	CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
	113	\r
	114	//\r
	115	// Generate the ASSERT() message in Unicode format\r
	116	//\r
	117	AsciiSPrint (Buffer, sizeof (Buffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);\r
	118	\r
	119	//\r
	120	// Send the print string to the Console Output device\r
	121	//\r
	122	SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(Buffer));\r
	123	\r
	124	//\r
	125	// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
	126	//\r
	127	if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
	128	CpuBreakpoint ();\r
	129	} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
	130	CpuDeadLoop ();\r
	131	}\r
	132	}\r
	133	\r
	134	\r
	135	/**\r
7bc232b2 LG	136	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
	137	\r
	138	This function fills Length bytes of Buffer with the value specified by \r
	139	PcdDebugClearMemoryValue, and returns Buffer.\r
	140	\r
	141	If Buffer is NULL, then ASSERT().\r
	142	\r
cc4e0485	143	If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
7bc232b2	144	\r
eceb3a4c	145	@param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
7bc232b2 LG	146	@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
7bc232b2 LG	147	\r
ad400b07	148	@return Buffer filled with PcdDebugClearMemoryValue.\r
7bc232b2 LG	149	\r
	150	**/\r
	151	VOID *\r
	152	EFIAPI\r
	153	DebugClearMemory (\r
	154	OUT VOID *Buffer,\r
	155	IN UINTN Length\r
	156	)\r
	157	{\r
	158	//\r
	159	// If Buffer is NULL, then ASSERT().\r
	160	//\r
	161	ASSERT (Buffer != NULL);\r
	162	\r
	163	//\r
	164	// SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
	165	//\r
	166	return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
	167	}\r
	168	\r
	169	\r
	170	/**\r
7bc232b2 LG	171	Returns TRUE if ASSERT() macros are enabled.\r
	172	\r
	173	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
	174	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	175	\r
	176	@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
	177	@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
	178	\r
	179	**/\r
	180	BOOLEAN\r
	181	EFIAPI\r
	182	DebugAssertEnabled (\r
	183	VOID\r
	184	)\r
	185	{\r
	186	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
	187	}\r
	188	\r
	189	\r
	190	/**\r
ad400b07	191	Returns TRUE if the DEBUG() macro is enabled.\r
7bc232b2 LG	192	\r
	193	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
	194	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	195	\r
	196	@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
	197	@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
	198	\r
	199	**/\r
	200	BOOLEAN\r
	201	EFIAPI\r
	202	DebugPrintEnabled (\r
	203	VOID\r
	204	)\r
	205	{\r
	206	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
	207	}\r
	208	\r
	209	\r
	210	/**\r
ad400b07	211	Returns TRUE if the DEBUG_CODE() macros are enabled.\r
7bc232b2 LG	212	\r
	213	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
	214	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	215	\r
	216	@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
	217	@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
	218	\r
	219	**/\r
	220	BOOLEAN\r
	221	EFIAPI\r
	222	DebugCodeEnabled (\r
	223	VOID\r
	224	)\r
	225	{\r
	226	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
	227	}\r
	228	\r
	229	\r
	230	/**\r
ad400b07	231	Returns TRUE if the DEBUG_CLEAR_MEMORY() macro is enabled.\r
7bc232b2	232	\r
eceb3a4c	233	This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
7bc232b2 LG	234	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
7bc232b2 LG	235	\r
eceb3a4c LG	236	@retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
eceb3a4c LG	237	@retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
7bc232b2 LG	238	\r
	239	**/\r
	240	BOOLEAN\r
	241	EFIAPI\r
	242	DebugClearMemoryEnabled (\r
	243	VOID\r
	244	)\r
	245	{\r
	246	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
	247	}\r