Added additional comments describing the new libraries functionality …

…better and renamed BasePanicLib to BasePanicLibSerialPort
microsoft · Sep 29, 2023 · 335fa66 · 335fa66
1 parent 0c1eadd
commit 335fa66
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 16 deletions.
diff --git a/MdePkg/Include/Library/PanicLib.h b/MdePkg/Include/Library/PanicLib.h
@@ -1,7 +1,10 @@
 /** @file
-  Provides services to print panic messages to a debug output device.
+  Provides an API that can be used to halt boot during a critical error and
+  leave a message describing what went wrong.  This should be used for unrecoverable
+  errors in boot that usually occur in early in boot.
 
 Copyright (c) Microsoft Corporation.
+SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
 
@@ -18,9 +21,9 @@ Copyright (c) Microsoft Corporation.
   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
 
-  @param  FileName     The pointer to the name of the source file that generated the panic condition.
-  @param  LineNumber   The line number in the source file that generated the panic condition
-  @param  Description  The pointer to the description of the panic condition.
+  @param[in]  FileName     The pointer to the name of the source file that generated the panic condition.
+  @param[in]  LineNumber   The line number in the source file that generated the panic condition
+  @param[in]  Description  The pointer to the description of the panic condition.
 
 **/
 VOID
@@ -35,16 +38,19 @@ PanicReport (
 // Source file line number.
 // Default is use the to compiler provided __LINE__ macro value. The __LINE__
 // mapping can be overriden by predefining PANIC_LINE_NUMBER
+
 //
 // Defining PANIC_LINE_NUMBER to a fixed value is useful when comparing builds
 // across source code formatting changes that may add/remove lines in a source
 // file.
 //
-#ifdef PANIC_LINE_NUMBER
-#else
+#ifndef PANIC_LINE_NUMBER
 #define PANIC_LINE_NUMBER  __LINE__
 #endif
 
+// File name being printed out.
+// Default is the compiler provided __FILE__ macro value. You can overwrite this
+// by defining __FILE_NAME__
 #if defined (__clang__) && defined (__FILE_NAME__)
 #define _PANIC(Message)  PanicReport (__FILE_NAME__, PANIC_LINE_NUMBER, Message)
 #else

diff --git a/MdePkg/Library/BasePanicLibNull/BasePanicLibNull.inf b/MdePkg/Library/BasePanicLibNull/BasePanicLibNull.inf
@@ -2,13 +2,13 @@
 #  Panic Library with empty functions.
 #
 #  Copyright (c) Microsoft Corporation.
+#  SPDX-License-Identifier: BSD-2-Clause-Patent
 #
 ##
 
 [Defines]
   INF_VERSION                    = 0x00010005
   BASE_NAME                      = BasePanicLibNull
-  MODULE_UNI_FILE                = BasePanicLibNull.uni
   FILE_GUID                      = 0A097ABB-3869-4CF8-B5C0-AE798F135C46
   MODULE_TYPE                    = BASE
   VERSION_STRING                 = 1.0

diff --git a/MdePkg/Library/BasePanicLibNull/PanicLib.c b/MdePkg/Library/BasePanicLibNull/PanicLib.c
@@ -2,17 +2,13 @@
   Base Panic Library with empty functions.
 
   Copyright (c) Microsoft Corporation.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
 
 #include <Base.h>
 #include <Library/PanicLib.h>
 
-//
-// Define the maximum panic message length that this library supports
-//
-#define MAX_PANIC_MESSAGE_LENGTH  0x100
-
 /**
   This would usually print a panic message containing a filename, line number,
   and description.  For the NULL implementation nothing is done when panicking.

diff --git a/MdePkg/Library/BasePanicLib/BasePanicLib.inf → ...cLibSerialPort/BasePanicLibSerialPort.inf b/MdePkg/Library/BasePanicLib/BasePanicLib.inf → ...cLibSerialPort/BasePanicLibSerialPort.inf
@@ -2,13 +2,13 @@
 #  Panic Library.
 #
 #  Copyright (c) Microsoft Corporation.
+#  SPDX-License-Identifier: BSD-2-Clause-Patent
 #
 ##
 
 [Defines]
   INF_VERSION                    = 0x00010005
-  BASE_NAME                      = BasePanicLib
-  MODULE_UNI_FILE                = BasePanicLib.uni
+  BASE_NAME                      = BasePanicLibSerialPort
   FILE_GUID                      = DF456972-AF4A-4F3A-B33C-DD31368BF490
   MODULE_TYPE                    = BASE
   VERSION_STRING                 = 1.0

diff --git a/MdePkg/Library/BasePanicLib/PanicLib.c → ...Library/BasePanicLibSerialPort/PanicLib.c b/MdePkg/Library/BasePanicLib/PanicLib.c → ...Library/BasePanicLibSerialPort/PanicLib.c
@@ -1,7 +1,8 @@
 /** @file
-  Base Panic Library.
+  Base Serial Port Panic Library.
 
   Copyright (c) Microsoft Corporation.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
 
@@ -41,6 +42,14 @@ PanicReport (
 {
   CHAR8  Buffer[MAX_PANIC_MESSAGE_LENGTH];
 
+  if (FileName == NULL) {
+    FileName = "(NULL) Filename";
+  }
+
+  if (Description == NULL) {
+    Description = "(NULL) Description";
+  }
+
   //
   // Generate the PANIC message in ASCII format
   //

diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc
@@ -68,7 +68,7 @@
   MdePkg/Library/PciSegmentLibSegmentInfo/DxeRuntimePciSegmentLibSegmentInfo.inf
   MdePkg/Library/BaseS3PciSegmentLib/BaseS3PciSegmentLib.inf
   MdePkg/Library/BaseArmTrngLibNull/BaseArmTrngLibNull.inf
-  MdePkg/Library/BasePanicLib/BasePanicLib.inf  # MU_CHANGE
+  MdePkg/Library/BasePanicLibSerialPort/BasePanicLibSerialPort.inf  # MU_CHANGE
   MdePkg/Library/BasePanicLibNull/BasePanicLibNull.inf  # MU_CHANGE
   MdePkg/Library/BasePeCoffGetEntryPointLib/BasePeCoffGetEntryPointLib.inf
   MdePkg/Library/BasePeCoffLib/BasePeCoffLib.inf