audk/ArmVirtPkg/Library/DebugLibFdtPL011Uart/DxeRuntimeDebugLibFdtPL011U...

## @file
# DebugLib instance that produces debug output directly via PL011UartLib.
#
# If there are at least two PL011 UARTs in the device tree, and the /chosen
# node's "stdout-path" property references one PL011 UART, then both raw
# SerialPortLib IO, and -- via SerialDxe -- UEFI console IO, will occur on that
# UART; and this DebugLib instance will produce output on a *different* UART.
#
# This instance is suitable for DXE_RUNTIME_DRIVER modules. When exiting boot
# services, UART access is stopped.
#
# Copyright (C) Red Hat
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
##

[Defines]
  INF_VERSION    = 1.27
  BASE_NAME      = DxeRuntimeDebugLibFdtPL011Uart
  FILE_GUID      = 8A6E0972-81B5-4FF4-BB24-A07748415947
  MODULE_TYPE    = DXE_RUNTIME_DRIVER
  VERSION_STRING = 1.0
  LIBRARY_CLASS  = DebugLib|DXE_RUNTIME_DRIVER
  CONSTRUCTOR    = DxeRuntimeDebugLibFdtPL011UartConstructor
  DESTRUCTOR     = DxeRuntimeDebugLibFdtPL011UartDestructor

[Sources]
  DebugLib.c
  Ram.c
  Ram.h
  Runtime.c
  Write.h

[Packages]
  ArmPlatformPkg/ArmPlatformPkg.dec
  ArmVirtPkg/ArmVirtPkg.dec
  MdePkg/MdePkg.dec

[LibraryClasses]
  BaseLib
  BaseMemoryLib
  DebugPrintErrorLevelLib
  HobLib                  # Ram.c
  PL011UartLib
  PcdLib
  PrintLib

[Pcd]
  gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue
  gEfiMdePkgTokenSpaceGuid.PcdDebugPropertyMask
  gEfiMdePkgTokenSpaceGuid.PcdFixedDebugPrintErrorLevel

[FixedPcd]
  gArmPlatformTokenSpaceGuid.PL011UartClkInHz
  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate
  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultDataBits
  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultParity
  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits

[Guids]
  gEarlyPL011BaseAddressGuid # Ram.c
ArmVirtPkg: introduce DebugLibFdtPL011Uart DXE Runtime instance Introduce three new DebugLib instances, forked from MdePkg/Library/BaseDebugLibSerialPort. All three instances rely on PL011UartLib rather than SerialPortLib so that they can customize the PL011 UART that the debug messages are written to. All three instances direct the debug output to the first such PL011 UART that differs from the one specified in the Device Tree's /chosen node's "stdout-path" property. From these, DxeRuntimeDebugLibFdtPL011Uart is identical to DebugLibFdtPL011UartRam, with the addition that UART access is permanently disabled when the containing DXE_RUNTIME_DRIVER module is notified about exiting boot services. The contexts in which these DebugLib instances run are identical to those in which the corresponding SerialPortLib instances run. The particular original dependency chain is DxeRuntimeDebugLibSerialPort (DXE_RUNTIME_DRIVER) FdtPL011SerialPortLib gEarlyPL011BaseAddressGuid HobLib PL011UartLib and the new dependency chain is DxeRuntimeDebugLibFdtPL011Uart (DXE_RUNTIME_DRIVER) gEarlyPL011BaseAddressGuid HobLib PL011UartLib The ArmVirtPkg DSC files will be switched to the new library instances in a separate patch. This patch is worth viewing with "git show --find-copies-harder". Cc: Ard Biesheuvel <ardb+tianocore@kernel.org> Cc: Gerd Hoffmann <kraxel@redhat.com> Cc: Leif Lindholm <quic_llindhol@quicinc.com> Cc: Sami Mujawar <sami.mujawar@arm.com> Signed-off-by: Laszlo Ersek <lersek@redhat.com> Message-Id: <20231008153912.175941-9-lersek@redhat.com> Acked-by: Ard Biesheuvel <ardb@kernel.org> Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=4577 [lersek@redhat.com: add TianoCore BZ reference] 2023-10-08 17:39:11 +02:00			`## @file`
			`# DebugLib instance that produces debug output directly via PL011UartLib.`
			`#`
			`# If there are at least two PL011 UARTs in the device tree, and the /chosen`
			`# node's "stdout-path" property references one PL011 UART, then both raw`
			`# SerialPortLib IO, and -- via SerialDxe -- UEFI console IO, will occur on that`
			`# UART; and this DebugLib instance will produce output on a different UART.`
			`#`
			`# This instance is suitable for DXE_RUNTIME_DRIVER modules. When exiting boot`
			`# services, UART access is stopped.`
			`#`
			`# Copyright (C) Red Hat`
			`#`
			`# SPDX-License-Identifier: BSD-2-Clause-Patent`
			`##`

			`[Defines]`
			`INF_VERSION = 1.27`
			`BASE_NAME = DxeRuntimeDebugLibFdtPL011Uart`
			`FILE_GUID = 8A6E0972-81B5-4FF4-BB24-A07748415947`
			`MODULE_TYPE = DXE_RUNTIME_DRIVER`
			`VERSION_STRING = 1.0`
			`LIBRARY_CLASS = DebugLib\|DXE_RUNTIME_DRIVER`
			`CONSTRUCTOR = DxeRuntimeDebugLibFdtPL011UartConstructor`
			`DESTRUCTOR = DxeRuntimeDebugLibFdtPL011UartDestructor`

			`[Sources]`
			`DebugLib.c`
			`Ram.c`
			`Ram.h`
			`Runtime.c`
			`Write.h`

			`[Packages]`
			`ArmPlatformPkg/ArmPlatformPkg.dec`
			`ArmVirtPkg/ArmVirtPkg.dec`
			`MdePkg/MdePkg.dec`

			`[LibraryClasses]`
			`BaseLib`
			`BaseMemoryLib`
			`DebugPrintErrorLevelLib`
			`HobLib # Ram.c`
			`PL011UartLib`
			`PcdLib`
			`PrintLib`

			`[Pcd]`
			`gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue`
			`gEfiMdePkgTokenSpaceGuid.PcdDebugPropertyMask`
			`gEfiMdePkgTokenSpaceGuid.PcdFixedDebugPrintErrorLevel`

			`[FixedPcd]`
			`gArmPlatformTokenSpaceGuid.PL011UartClkInHz`
			`gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate`
			`gEfiMdePkgTokenSpaceGuid.PcdUartDefaultDataBits`
			`gEfiMdePkgTokenSpaceGuid.PcdUartDefaultParity`
			`gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits`

			`[Guids]`
			`gEarlyPL011BaseAddressGuid # Ram.c`