diff options
Diffstat (limited to 'MdeModulePkg/Universal/DebugServicePei')
4 files changed, 204 insertions, 204 deletions
diff --git a/MdeModulePkg/Universal/DebugServicePei/DebugService.h b/MdeModulePkg/Universal/DebugServicePei/DebugService.h index 7fe75655eb..31561e7d80 100644 --- a/MdeModulePkg/Universal/DebugServicePei/DebugService.h +++ b/MdeModulePkg/Universal/DebugServicePei/DebugService.h @@ -1,51 +1,51 @@ -/** @file
- Header file of Debug services instances.
-
- Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
-
- SPDX-License-Identifier: BSD-2-Clause-Patent
-
-**/
-
-#ifndef __DEBUG_SERVICE_H__
-#define __DEBUG_SERVICE_H__
-
-#include <Ppi/Debug.h>
-
-/**
- Print a debug message to debug output device if the specified error level
- is enabled.
-
- @param[in] ErrorLevel The error level of the debug message.
- @param[in] Format Format string for the debug message to print.
- @param[in] Marker BASE_LIST marker for the variable argument list.
-
-**/
-VOID
-EFIAPI
-PeiDebugBPrint (
- IN UINTN ErrorLevel,
- IN CONST CHAR8 *Format,
- IN BASE_LIST Marker
- );
-
-/**
- Prints an assert message containing a filename, line number, and description.
- This may be followed by a breakpoint or a dead loop.
-
- @param[in] FileName The pointer to the name of the source file that
- generated the assert condition.
- @param[in] LineNumber The line number in the source file that generated
- the assert condition
- @param[in] Description The pointer to the description of the assert condition.
-
-**/
-VOID
-EFIAPI
-PeiDebugAssert (
- IN CONST CHAR8 *FileName,
- IN UINTN LineNumber,
- IN CONST CHAR8 *Description
- );
-
-#endif
+/** @file + Header file of Debug services instances. + + Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> + + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __DEBUG_SERVICE_H__ +#define __DEBUG_SERVICE_H__ + +#include <Ppi/Debug.h> + +/** + Print a debug message to debug output device if the specified error level + is enabled. + + @param[in] ErrorLevel The error level of the debug message. + @param[in] Format Format string for the debug message to print. + @param[in] Marker BASE_LIST marker for the variable argument list. + +**/ +VOID +EFIAPI +PeiDebugBPrint ( + IN UINTN ErrorLevel, + IN CONST CHAR8 *Format, + IN BASE_LIST Marker + ); + +/** + Prints an assert message containing a filename, line number, and description. + This may be followed by a breakpoint or a dead loop. + + @param[in] FileName The pointer to the name of the source file that + generated the assert condition. + @param[in] LineNumber The line number in the source file that generated + the assert condition + @param[in] Description The pointer to the description of the assert condition. + +**/ +VOID +EFIAPI +PeiDebugAssert ( + IN CONST CHAR8 *FileName, + IN UINTN LineNumber, + IN CONST CHAR8 *Description + ); + +#endif diff --git a/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.c b/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.c index b3407279c8..0102e11a5b 100644 --- a/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.c +++ b/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.c @@ -1,93 +1,93 @@ -/** @file
- This driver installs gEdkiiDebugPpiGuid PPI to provide
- debug services for PEIMs.
-
- Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
-
- SPDX-License-Identifier: BSD-2-Clause-Patent
-
-**/
-
-#include <Uefi/UefiBaseType.h>
-#include <Library/PeimEntryPoint.h>
-#include <Library/PeiServicesLib.h>
-#include <Library/DebugLib.h>
-
-#include <Ppi/Debug.h>
-
-#include "DebugService.h"
-
-EDKII_DEBUG_PPI mDebugPpi = {
- PeiDebugBPrint,
- PeiDebugAssert
-};
-
-EFI_PEI_PPI_DESCRIPTOR mDebugServicePpi = {
- (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
- &gEdkiiDebugPpiGuid,
- (VOID *)&mDebugPpi
-};
-
-/**
- Print a debug message to debug output device if the specified error level
- is enabled.
-
- @param[in] ErrorLevel The error level of the debug message.
- @param[in] Format Format string for the debug message to print.
- @param[in] Marker BASE_LIST marker for the variable argument list.
-
-**/
-VOID
-EFIAPI
-PeiDebugBPrint (
- IN UINTN ErrorLevel,
- IN CONST CHAR8 *Format,
- IN BASE_LIST Marker
- )
-{
- DebugBPrint (ErrorLevel, Format, Marker);
-}
-
-/**
- Print an assert message containing a filename, line number, and description.
- This may be followed by a breakpoint or a dead loop.
-
- @param[in] FileName The pointer to the name of the source file that
- generated the assert condition.
- @param[in] LineNumber The line number in the source file that generated
- the assert condition
- @param[in] Description The pointer to the description of the assert condition.
-
-**/
-VOID
-EFIAPI
-PeiDebugAssert (
- IN CONST CHAR8 *FileName,
- IN UINTN LineNumber,
- IN CONST CHAR8 *Description
- )
-{
- DebugAssert (FileName, LineNumber, Description);
-}
-
-/**
- Entry point of Debug Service PEIM
-
- This funciton installs EDKII DEBUG PPI
-
- @param FileHandle Handle of the file being invoked.
- @param PeiServices Describes the list of possible PEI Services.
-
- @retval EFI_SUCESS The entry point of Debug Service PEIM executes successfully.
- @retval Others Some error occurs during the execution of this function.
-
-**/
-EFI_STATUS
-EFIAPI
-DebugSerivceInitialize (
- IN EFI_PEI_FILE_HANDLE FileHandle,
- IN CONST EFI_PEI_SERVICES **PeiServices
- )
-{
- return PeiServicesInstallPpi (&mDebugServicePpi);
-}
+/** @file + This driver installs gEdkiiDebugPpiGuid PPI to provide + debug services for PEIMs. + + Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> + + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include <Uefi/UefiBaseType.h> +#include <Library/PeimEntryPoint.h> +#include <Library/PeiServicesLib.h> +#include <Library/DebugLib.h> + +#include <Ppi/Debug.h> + +#include "DebugService.h" + +EDKII_DEBUG_PPI mDebugPpi = { + PeiDebugBPrint, + PeiDebugAssert +}; + +EFI_PEI_PPI_DESCRIPTOR mDebugServicePpi = { + (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST), + &gEdkiiDebugPpiGuid, + (VOID *)&mDebugPpi +}; + +/** + Print a debug message to debug output device if the specified error level + is enabled. + + @param[in] ErrorLevel The error level of the debug message. + @param[in] Format Format string for the debug message to print. + @param[in] Marker BASE_LIST marker for the variable argument list. + +**/ +VOID +EFIAPI +PeiDebugBPrint ( + IN UINTN ErrorLevel, + IN CONST CHAR8 *Format, + IN BASE_LIST Marker + ) +{ + DebugBPrint (ErrorLevel, Format, Marker); +} + +/** + Print an assert message containing a filename, line number, and description. + This may be followed by a breakpoint or a dead loop. + + @param[in] FileName The pointer to the name of the source file that + generated the assert condition. + @param[in] LineNumber The line number in the source file that generated + the assert condition + @param[in] Description The pointer to the description of the assert condition. + +**/ +VOID +EFIAPI +PeiDebugAssert ( + IN CONST CHAR8 *FileName, + IN UINTN LineNumber, + IN CONST CHAR8 *Description + ) +{ + DebugAssert (FileName, LineNumber, Description); +} + +/** + Entry point of Debug Service PEIM + + This funciton installs EDKII DEBUG PPI + + @param FileHandle Handle of the file being invoked. + @param PeiServices Describes the list of possible PEI Services. + + @retval EFI_SUCESS The entry point of Debug Service PEIM executes successfully. + @retval Others Some error occurs during the execution of this function. + +**/ +EFI_STATUS +EFIAPI +DebugSerivceInitialize ( + IN EFI_PEI_FILE_HANDLE FileHandle, + IN CONST EFI_PEI_SERVICES **PeiServices + ) +{ + return PeiServicesInstallPpi (&mDebugServicePpi); +} diff --git a/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.inf b/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.inf index eb76af0343..0f7a3bf506 100644 --- a/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.inf +++ b/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.inf @@ -1,46 +1,46 @@ -## @file
-# Debug services for PEI phase
-#
-# This module installs gEdkiiDebugPpiGuid PPI to provide
-# debug services for PEIMs.
-#
-# Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
-#
-# SPDX-License-Identifier: BSD-2-Clause-Patent
-#
-##
-[Defines]
- INF_VERSION = 0x00010005
- BASE_NAME = DebugServicePei
- MODULE_UNI_FILE = DebugServicePei.uni
- FILE_GUID = B73F81B9-1DFC-487C-824C-0509EE2B0128
- MODULE_TYPE = PEIM
- VERSION_STRING = 1.0
-
- ENTRY_POINT = DebugSerivceInitialize
-
-#
-# The following information is for reference only and not required by the build tools.
-#
-# VALID_ARCHITECTURES = IA32 X64 EBC
-#
-
-[Sources]
- DebugServicePei.c
- DebugService.h
-
-[Packages]
- MdePkg/MdePkg.dec
- MdeModulePkg/MdeModulePkg.dec
-
-[LibraryClasses]
- PeimEntryPoint
- PeiServicesLib
- DebugLib
-
-[Ppis]
- gEdkiiDebugPpiGuid ## PRODUCE
-
-[Depex]
- TRUE
-
+## @file +# Debug services for PEI phase +# +# This module installs gEdkiiDebugPpiGuid PPI to provide +# debug services for PEIMs. +# +# Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> +# +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = DebugServicePei + MODULE_UNI_FILE = DebugServicePei.uni + FILE_GUID = B73F81B9-1DFC-487C-824C-0509EE2B0128 + MODULE_TYPE = PEIM + VERSION_STRING = 1.0 + + ENTRY_POINT = DebugSerivceInitialize + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# + +[Sources] + DebugServicePei.c + DebugService.h + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[LibraryClasses] + PeimEntryPoint + PeiServicesLib + DebugLib + +[Ppis] + gEdkiiDebugPpiGuid ## PRODUCE + +[Depex] + TRUE + diff --git a/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.uni b/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.uni index 8fbd4069ed..6b4a23bc60 100644 --- a/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.uni +++ b/MdeModulePkg/Universal/DebugServicePei/DebugServicePei.uni @@ -1,14 +1,14 @@ -///** @file
-// This driver installs gEdkiiDebugPpiGuid PPI to provide
-// debug services for PEIMs.
-//
-// Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
-//
-// SPDX-License-Identifier: BSD-2-Clause-Patent
-//
-//**/
-
-#string STR_MODULE_ABSTRACT #language en-US "Provide debug services at PEI phase."
-
-#string STR_MODULE_DESCRIPTION #language en-US "It produces gEdkiiDebugPpiGuid to print message to debug output device"
-
+///** @file +// This driver installs gEdkiiDebugPpiGuid PPI to provide +// debug services for PEIMs. +// +// Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> +// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +//**/ + +#string STR_MODULE_ABSTRACT #language en-US "Provide debug services at PEI phase." + +#string STR_MODULE_DESCRIPTION #language en-US "It produces gEdkiiDebugPpiGuid to print message to debug output device" + |
