[edk2,edk2-platforms,1/2] Platform, Silicon: use DxeRuntimeDebugLibSerialPort for runtime DXE drivers

Message ID 20180224142515.461-1-ard.biesheuvel@linaro.org
State New
Headers show
Series
  • [edk2,edk2-platforms,1/2] Platform, Silicon: use DxeRuntimeDebugLibSerialPort for runtime DXE drivers
Related show

Commit Message

Ard Biesheuvel Feb. 24, 2018, 2:25 p.m.
Commit 4bf95a9f361e ("MdeModulePkg/ResetSystemRuntimeDxe: Add more
debug message") broke the DEBUG build for all platforms that rely on
MMIO mapped UART devices, since it introduces a DEBUG() print that
may trigger at runtime, at which such UART devices are usually not
mapped, resulting in an OS crash.

Given that this mostly only affects ARM and AARCH64, it is not unlikely
that similar inadvertent breakage will occur again in the future, so
let's fix this once and for all by switching affected platforms to the
new DxeRuntimeDebugLibSerialPort DebugLib implementation that takes care
not to touch the UART hardware after ExitBootServices().

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

---
 Platform/AMD/OverdriveBoard/OverdriveBoard.dsc               | 3 +++
 Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc                 | 3 +++
 Platform/LeMaker/CelloBoard/CelloBoard.dsc                   | 3 +++
 Platform/Socionext/DeveloperBox/DeveloperBox.dsc             | 3 +++
 Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc | 3 +++
 Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc  | 3 +++
 Silicon/Hisilicon/Hisilicon.dsc.inc                          | 3 +++
 Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc                | 3 +++
 8 files changed, 24 insertions(+)

-- 
2.11.0

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Comments

Laszlo Ersek Feb. 26, 2018, 2:50 p.m. | #1
On 02/24/18 15:25, Ard Biesheuvel wrote:
> Commit 4bf95a9f361e ("MdeModulePkg/ResetSystemRuntimeDxe: Add more

> debug message") broke the DEBUG build for all platforms that rely on

> MMIO mapped UART devices, since it introduces a DEBUG() print that

> may trigger at runtime, at which such UART devices are usually not

> mapped, resulting in an OS crash.

> 

> Given that this mostly only affects ARM and AARCH64, it is not unlikely

> that similar inadvertent breakage will occur again in the future, so

> let's fix this once and for all by switching affected platforms to the

> new DxeRuntimeDebugLibSerialPort DebugLib implementation that takes care

> not to touch the UART hardware after ExitBootServices().

> 

> Contributed-under: TianoCore Contribution Agreement 1.1

> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

> ---

>  Platform/AMD/OverdriveBoard/OverdriveBoard.dsc               | 3 +++

>  Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc                 | 3 +++

>  Platform/LeMaker/CelloBoard/CelloBoard.dsc                   | 3 +++

>  Platform/Socionext/DeveloperBox/DeveloperBox.dsc             | 3 +++

>  Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc | 3 +++

>  Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc  | 3 +++

>  Silicon/Hisilicon/Hisilicon.dsc.inc                          | 3 +++

>  Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc                | 3 +++

>  8 files changed, 24 insertions(+)

> 

> diff --git a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

> index 7d85b78642da..348828e18d44 100644

> --- a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

> +++ b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

> @@ -227,6 +227,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.common.UEFI_APPLICATION]

>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

> diff --git a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

> index b026ce3a420a..7cb47937329e 100644

> --- a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

> +++ b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

> @@ -227,6 +227,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>  !if $(SECURE_BOOT_ENABLE) == TRUE

>    BaseCryptLib|CryptoPkg/Library/BaseCryptLib/RuntimeCryptLib.inf

>  !endif

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.ARM, LibraryClasses.AARCH64]

>    #

> diff --git a/Platform/LeMaker/CelloBoard/CelloBoard.dsc b/Platform/LeMaker/CelloBoard/CelloBoard.dsc

> index 2468583c0daa..569e444f6b26 100644

> --- a/Platform/LeMaker/CelloBoard/CelloBoard.dsc

> +++ b/Platform/LeMaker/CelloBoard/CelloBoard.dsc

> @@ -211,6 +211,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.common.UEFI_APPLICATION]

>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

> diff --git a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

> index 8450d7800e43..925ce36d278b 100644

> --- a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

> +++ b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

> @@ -208,6 +208,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

>    ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf

>    BaseMemoryLib|MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  ################################################################################

>  #

> diff --git a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

> index 45ab2afc4069..2d5a94ed1dab 100644

> --- a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

> +++ b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

> @@ -203,6 +203,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

>    ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  ################################################################################

>  #

> diff --git a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

> index f0a7e9794153..3f4c7c8a3eef 100644

> --- a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

> +++ b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

> @@ -217,6 +217,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.common.UEFI_APPLICATION]

>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

> diff --git a/Silicon/Hisilicon/Hisilicon.dsc.inc b/Silicon/Hisilicon/Hisilicon.dsc.inc

> index 9050f29be381..b196322a20e2 100644

> --- a/Silicon/Hisilicon/Hisilicon.dsc.inc

> +++ b/Silicon/Hisilicon/Hisilicon.dsc.inc

> @@ -213,6 +213,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>  !ifndef CONFIG_NO_DEBUGLIB

>    DebugLib|IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf

>  !endif

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.AARCH64]

>    ArmGenericTimerCounterLib|ArmPkg/Library/ArmGenericTimerPhyCounterLib/ArmGenericTimerPhyCounterLib.inf

> diff --git a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

> index ef70b5216727..535cc3ff4c19 100644

> --- a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

> +++ b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

> @@ -184,6 +184,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.ARM, LibraryClasses.AARCH64]

>    #

> 


I'm not overly familiar with edk2-platforms, but the patches look sane.

Series
Reviewed-by: Laszlo Ersek <lersek@redhat.com>


Thanks
Laszlo
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
gary guo Feb. 27, 2018, 1:50 a.m. | #2
Hi Ard,

Sorry for the late of seeing this patch. I have one question: why don't we
implement a runtime serial port lib, which will switch UART base address in
virtual address map change? I think this will be useful when we want to debug
runtime driver in OS stage. And if we have a runtime version of SerialPortLib,
then we don't need a runtime version of DebugLib which just disable touching
serial port.

Thanks,

Heyi


On Sat, Feb 24, 2018 at 02:25:14PM +0000, Ard Biesheuvel wrote:
> Commit 4bf95a9f361e ("MdeModulePkg/ResetSystemRuntimeDxe: Add more

> debug message") broke the DEBUG build for all platforms that rely on

> MMIO mapped UART devices, since it introduces a DEBUG() print that

> may trigger at runtime, at which such UART devices are usually not

> mapped, resulting in an OS crash.

> 

> Given that this mostly only affects ARM and AARCH64, it is not unlikely

> that similar inadvertent breakage will occur again in the future, so

> let's fix this once and for all by switching affected platforms to the

> new DxeRuntimeDebugLibSerialPort DebugLib implementation that takes care

> not to touch the UART hardware after ExitBootServices().

> 

> Contributed-under: TianoCore Contribution Agreement 1.1

> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

> ---

>  Platform/AMD/OverdriveBoard/OverdriveBoard.dsc               | 3 +++

>  Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc                 | 3 +++

>  Platform/LeMaker/CelloBoard/CelloBoard.dsc                   | 3 +++

>  Platform/Socionext/DeveloperBox/DeveloperBox.dsc             | 3 +++

>  Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc | 3 +++

>  Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc  | 3 +++

>  Silicon/Hisilicon/Hisilicon.dsc.inc                          | 3 +++

>  Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc                | 3 +++

>  8 files changed, 24 insertions(+)

> 

> diff --git a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

> index 7d85b78642da..348828e18d44 100644

> --- a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

> +++ b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

> @@ -227,6 +227,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.common.UEFI_APPLICATION]

>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

> diff --git a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

> index b026ce3a420a..7cb47937329e 100644

> --- a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

> +++ b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

> @@ -227,6 +227,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>  !if $(SECURE_BOOT_ENABLE) == TRUE

>    BaseCryptLib|CryptoPkg/Library/BaseCryptLib/RuntimeCryptLib.inf

>  !endif

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.ARM, LibraryClasses.AARCH64]

>    #

> diff --git a/Platform/LeMaker/CelloBoard/CelloBoard.dsc b/Platform/LeMaker/CelloBoard/CelloBoard.dsc

> index 2468583c0daa..569e444f6b26 100644

> --- a/Platform/LeMaker/CelloBoard/CelloBoard.dsc

> +++ b/Platform/LeMaker/CelloBoard/CelloBoard.dsc

> @@ -211,6 +211,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.common.UEFI_APPLICATION]

>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

> diff --git a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

> index 8450d7800e43..925ce36d278b 100644

> --- a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

> +++ b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

> @@ -208,6 +208,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

>    ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf

>    BaseMemoryLib|MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  ################################################################################

>  #

> diff --git a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

> index 45ab2afc4069..2d5a94ed1dab 100644

> --- a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

> +++ b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

> @@ -203,6 +203,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

>    ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  ################################################################################

>  #

> diff --git a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

> index f0a7e9794153..3f4c7c8a3eef 100644

> --- a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

> +++ b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

> @@ -217,6 +217,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.common.UEFI_APPLICATION]

>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

> diff --git a/Silicon/Hisilicon/Hisilicon.dsc.inc b/Silicon/Hisilicon/Hisilicon.dsc.inc

> index 9050f29be381..b196322a20e2 100644

> --- a/Silicon/Hisilicon/Hisilicon.dsc.inc

> +++ b/Silicon/Hisilicon/Hisilicon.dsc.inc

> @@ -213,6 +213,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>  !ifndef CONFIG_NO_DEBUGLIB

>    DebugLib|IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf

>  !endif

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.AARCH64]

>    ArmGenericTimerCounterLib|ArmPkg/Library/ArmGenericTimerPhyCounterLib/ArmGenericTimerPhyCounterLib.inf

> diff --git a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

> index ef70b5216727..535cc3ff4c19 100644

> --- a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

> +++ b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

> @@ -184,6 +184,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.ARM, LibraryClasses.AARCH64]

>    #

> -- 

> 2.11.0

> 

> _______________________________________________

> edk2-devel mailing list

> edk2-devel@lists.01.org

> https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Feb. 27, 2018, 9:23 a.m. | #3
On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:
> Hi Ard,

>

> Sorry for the late of seeing this patch. I have one question: why don't we

> implement a runtime serial port lib, which will switch UART base address in

> virtual address map change? I think this will be useful when we want to debug

> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

> then we don't need a runtime version of DebugLib which just disable touching

> serial port.

>


Well, only if the serial port is not exposed to the OS as well. The
Linux PL011 driver is especially easy to confuse, and having both the
firmware and the OS control it at the same time is likely to cause
problems.

However, I do agree that having the ability to assign a UART to DEBUG
at runtime is useful, and so I do intend to create a runtime version
of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can
be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER
modules.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Leif Lindholm Feb. 27, 2018, 10:39 a.m. | #4
On Sat, Feb 24, 2018 at 02:25:14PM +0000, Ard Biesheuvel wrote:
> Commit 4bf95a9f361e ("MdeModulePkg/ResetSystemRuntimeDxe: Add more

> debug message") broke the DEBUG build for all platforms that rely on

> MMIO mapped UART devices, since it introduces a DEBUG() print that

> may trigger at runtime, at which such UART devices are usually not

> mapped, resulting in an OS crash.

> 

> Given that this mostly only affects ARM and AARCH64, it is not unlikely

> that similar inadvertent breakage will occur again in the future, so

> let's fix this once and for all by switching affected platforms to the

> new DxeRuntimeDebugLibSerialPort DebugLib implementation that takes care

> not to touch the UART hardware after ExitBootServices().

> 

> Contributed-under: TianoCore Contribution Agreement 1.1

> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>


For the series (pending DxeRuntimeDebugLibSerialPort hitting edk2):
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>


> ---

>  Platform/AMD/OverdriveBoard/OverdriveBoard.dsc               | 3 +++

>  Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc                 | 3 +++

>  Platform/LeMaker/CelloBoard/CelloBoard.dsc                   | 3 +++

>  Platform/Socionext/DeveloperBox/DeveloperBox.dsc             | 3 +++

>  Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc | 3 +++

>  Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc  | 3 +++

>  Silicon/Hisilicon/Hisilicon.dsc.inc                          | 3 +++

>  Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc                | 3 +++

>  8 files changed, 24 insertions(+)

> 

> diff --git a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

> index 7d85b78642da..348828e18d44 100644

> --- a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

> +++ b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

> @@ -227,6 +227,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.common.UEFI_APPLICATION]

>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

> diff --git a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

> index b026ce3a420a..7cb47937329e 100644

> --- a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

> +++ b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

> @@ -227,6 +227,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>  !if $(SECURE_BOOT_ENABLE) == TRUE

>    BaseCryptLib|CryptoPkg/Library/BaseCryptLib/RuntimeCryptLib.inf

>  !endif

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.ARM, LibraryClasses.AARCH64]

>    #

> diff --git a/Platform/LeMaker/CelloBoard/CelloBoard.dsc b/Platform/LeMaker/CelloBoard/CelloBoard.dsc

> index 2468583c0daa..569e444f6b26 100644

> --- a/Platform/LeMaker/CelloBoard/CelloBoard.dsc

> +++ b/Platform/LeMaker/CelloBoard/CelloBoard.dsc

> @@ -211,6 +211,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.common.UEFI_APPLICATION]

>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

> diff --git a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

> index 8450d7800e43..925ce36d278b 100644

> --- a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

> +++ b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

> @@ -208,6 +208,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

>    ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf

>    BaseMemoryLib|MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  ################################################################################

>  #

> diff --git a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

> index 45ab2afc4069..2d5a94ed1dab 100644

> --- a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

> +++ b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

> @@ -203,6 +203,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

>    ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  ################################################################################

>  #

> diff --git a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

> index f0a7e9794153..3f4c7c8a3eef 100644

> --- a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

> +++ b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

> @@ -217,6 +217,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.common.UEFI_APPLICATION]

>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

> diff --git a/Silicon/Hisilicon/Hisilicon.dsc.inc b/Silicon/Hisilicon/Hisilicon.dsc.inc

> index 9050f29be381..b196322a20e2 100644

> --- a/Silicon/Hisilicon/Hisilicon.dsc.inc

> +++ b/Silicon/Hisilicon/Hisilicon.dsc.inc

> @@ -213,6 +213,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>  !ifndef CONFIG_NO_DEBUGLIB

>    DebugLib|IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf

>  !endif

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.AARCH64]

>    ArmGenericTimerCounterLib|ArmPkg/Library/ArmGenericTimerPhyCounterLib/ArmGenericTimerPhyCounterLib.inf

> diff --git a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

> index ef70b5216727..535cc3ff4c19 100644

> --- a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

> +++ b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

> @@ -184,6 +184,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

> +!if $(TARGET) != RELEASE

> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

> +!endif

>  

>  [LibraryClasses.ARM, LibraryClasses.AARCH64]

>    #

> -- 

> 2.11.0

> 

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Laszlo Ersek Feb. 27, 2018, 10:43 a.m. | #5
On 02/27/18 10:23, Ard Biesheuvel wrote:
> On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:

>> Hi Ard,

>>

>> Sorry for the late of seeing this patch. I have one question: why don't we

>> implement a runtime serial port lib, which will switch UART base address in

>> virtual address map change? I think this will be useful when we want to debug

>> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

>> then we don't need a runtime version of DebugLib which just disable touching

>> serial port.

>>

> 

> Well, only if the serial port is not exposed to the OS as well. The

> Linux PL011 driver is especially easy to confuse, and having both the

> firmware and the OS control it at the same time is likely to cause

> problems.

> 

> However, I do agree that having the ability to assign a UART to DEBUG

> at runtime is useful, and so I do intend to create a runtime version

> of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can

> be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER

> modules.

> 


Converting the PL011 base address from phys to virt can be done in the
library instance, yes (and then every runtime driver module linked
against this library instance will individually convert the address for
its own use). The messier aspect is getting the PL011 base address into
the UEFI memmap, marked as MMIO / RUNTIME, so that the OS assign a
virtual mapping to it in the first place.

The flash drivers generally do this with AddMemorySpace /
SetMemorySpaceAttributes.

(Side point: while I agree that those are good APIs to invoke, I think
they should also call AllocateMemorySpace right after; otherwise a
"stray" AllocateMemorySpace elsewhere could allocate a chunk out of the
middle of what the flash driver *thinks* it owns.)

The question is where this pair (or triplet) of GCD APIs should be called:

- In a platform DXE driver? Perhaps.

- In the DebugLib instance constructor / destructor? That could result
in some ugly reference counting -- you might want to keep the PL011 area
registered in GCD as long as *at least one* such runtime driver is loaded.

This is different from the flash driver because the flash driver is the
sole runtime DXE (or SMM) driver that accesses & owns the flash MMIO
range. With the PL011 register block, that's not the case; all runtime
drivers that produce debug messages own it co-operatively.

Thanks
Laszlo
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Feb. 27, 2018, 10:45 a.m. | #6
On 27 February 2018 at 10:39, Leif Lindholm <leif.lindholm@linaro.org> wrote:
> On Sat, Feb 24, 2018 at 02:25:14PM +0000, Ard Biesheuvel wrote:

>> Commit 4bf95a9f361e ("MdeModulePkg/ResetSystemRuntimeDxe: Add more

>> debug message") broke the DEBUG build for all platforms that rely on

>> MMIO mapped UART devices, since it introduces a DEBUG() print that

>> may trigger at runtime, at which such UART devices are usually not

>> mapped, resulting in an OS crash.

>>

>> Given that this mostly only affects ARM and AARCH64, it is not unlikely

>> that similar inadvertent breakage will occur again in the future, so

>> let's fix this once and for all by switching affected platforms to the

>> new DxeRuntimeDebugLibSerialPort DebugLib implementation that takes care

>> not to touch the UART hardware after ExitBootServices().

>>

>> Contributed-under: TianoCore Contribution Agreement 1.1

>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>

> For the series (pending DxeRuntimeDebugLibSerialPort hitting edk2):

> Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>

>


That's already in so I pushed this as d8e4d4565841..dbf93a0a853a

Thanks

>> ---

>>  Platform/AMD/OverdriveBoard/OverdriveBoard.dsc               | 3 +++

>>  Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc                 | 3 +++

>>  Platform/LeMaker/CelloBoard/CelloBoard.dsc                   | 3 +++

>>  Platform/Socionext/DeveloperBox/DeveloperBox.dsc             | 3 +++

>>  Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc | 3 +++

>>  Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc  | 3 +++

>>  Silicon/Hisilicon/Hisilicon.dsc.inc                          | 3 +++

>>  Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc                | 3 +++

>>  8 files changed, 24 insertions(+)

>>

>> diff --git a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

>> index 7d85b78642da..348828e18d44 100644

>> --- a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

>> +++ b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc

>> @@ -227,6 +227,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

>> +!if $(TARGET) != RELEASE

>> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

>> +!endif

>>

>>  [LibraryClasses.common.UEFI_APPLICATION]

>>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

>> diff --git a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

>> index b026ce3a420a..7cb47937329e 100644

>> --- a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

>> +++ b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc

>> @@ -227,6 +227,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>>  !if $(SECURE_BOOT_ENABLE) == TRUE

>>    BaseCryptLib|CryptoPkg/Library/BaseCryptLib/RuntimeCryptLib.inf

>>  !endif

>> +!if $(TARGET) != RELEASE

>> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

>> +!endif

>>

>>  [LibraryClasses.ARM, LibraryClasses.AARCH64]

>>    #

>> diff --git a/Platform/LeMaker/CelloBoard/CelloBoard.dsc b/Platform/LeMaker/CelloBoard/CelloBoard.dsc

>> index 2468583c0daa..569e444f6b26 100644

>> --- a/Platform/LeMaker/CelloBoard/CelloBoard.dsc

>> +++ b/Platform/LeMaker/CelloBoard/CelloBoard.dsc

>> @@ -211,6 +211,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>>    ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf

>>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

>> +!if $(TARGET) != RELEASE

>> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

>> +!endif

>>

>>  [LibraryClasses.common.UEFI_APPLICATION]

>>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

>> diff --git a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

>> index 8450d7800e43..925ce36d278b 100644

>> --- a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

>> +++ b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc

>> @@ -208,6 +208,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

>>    ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf

>>    BaseMemoryLib|MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf

>> +!if $(TARGET) != RELEASE

>> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

>> +!endif

>>

>>  ################################################################################

>>  #

>> diff --git a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

>> index 45ab2afc4069..2d5a94ed1dab 100644

>> --- a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

>> +++ b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc

>> @@ -203,6 +203,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf

>>    ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf

>> +!if $(TARGET) != RELEASE

>> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

>> +!endif

>>

>>  ################################################################################

>>  #

>> diff --git a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

>> index f0a7e9794153..3f4c7c8a3eef 100644

>> --- a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

>> +++ b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc

>> @@ -217,6 +217,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>>    ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf

>>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

>> +!if $(TARGET) != RELEASE

>> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

>> +!endif

>>

>>  [LibraryClasses.common.UEFI_APPLICATION]

>>    UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf

>> diff --git a/Silicon/Hisilicon/Hisilicon.dsc.inc b/Silicon/Hisilicon/Hisilicon.dsc.inc

>> index 9050f29be381..b196322a20e2 100644

>> --- a/Silicon/Hisilicon/Hisilicon.dsc.inc

>> +++ b/Silicon/Hisilicon/Hisilicon.dsc.inc

>> @@ -213,6 +213,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>>  !ifndef CONFIG_NO_DEBUGLIB

>>    DebugLib|IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf

>>  !endif

>> +!if $(TARGET) != RELEASE

>> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

>> +!endif

>>

>>  [LibraryClasses.AARCH64]

>>    ArmGenericTimerCounterLib|ArmPkg/Library/ArmGenericTimerPhyCounterLib/ArmGenericTimerPhyCounterLib.inf

>> diff --git a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

>> index ef70b5216727..535cc3ff4c19 100644

>> --- a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

>> +++ b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc

>> @@ -184,6 +184,9 @@ [LibraryClasses.common.DXE_RUNTIME_DRIVER]

>>    HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

>>    MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

>>    CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf

>> +!if $(TARGET) != RELEASE

>> +  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf

>> +!endif

>>

>>  [LibraryClasses.ARM, LibraryClasses.AARCH64]

>>    #

>> --

>> 2.11.0

>>

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
gary guo Feb. 27, 2018, 11:30 a.m. | #7
On Tue, Feb 27, 2018 at 11:43:35AM +0100, Laszlo Ersek wrote:
> On 02/27/18 10:23, Ard Biesheuvel wrote:

> > On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:

> >> Hi Ard,

> >>

> >> Sorry for the late of seeing this patch. I have one question: why don't we

> >> implement a runtime serial port lib, which will switch UART base address in

> >> virtual address map change? I think this will be useful when we want to debug

> >> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

> >> then we don't need a runtime version of DebugLib which just disable touching

> >> serial port.

> >>

> > 

> > Well, only if the serial port is not exposed to the OS as well. The

> > Linux PL011 driver is especially easy to confuse, and having both the

> > firmware and the OS control it at the same time is likely to cause

> > problems.

> > 

> > However, I do agree that having the ability to assign a UART to DEBUG

> > at runtime is useful, and so I do intend to create a runtime version

> > of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can

> > be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER

> > modules.

> > 

> 

> Converting the PL011 base address from phys to virt can be done in the

> library instance, yes (and then every runtime driver module linked

> against this library instance will individually convert the address for

> its own use). The messier aspect is getting the PL011 base address into

> the UEFI memmap, marked as MMIO / RUNTIME, so that the OS assign a

> virtual mapping to it in the first place.

> 

> The flash drivers generally do this with AddMemorySpace /

> SetMemorySpaceAttributes.

> 

> (Side point: while I agree that those are good APIs to invoke, I think

> they should also call AllocateMemorySpace right after; otherwise a

> "stray" AllocateMemorySpace elsewhere could allocate a chunk out of the

> middle of what the flash driver *thinks* it owns.)

> 

> The question is where this pair (or triplet) of GCD APIs should be called:

> 

> - In a platform DXE driver? Perhaps.

> 

> - In the DebugLib instance constructor / destructor? That could result

> in some ugly reference counting -- you might want to keep the PL011 area

> registered in GCD as long as *at least one* such runtime driver is loaded.

> 

> This is different from the flash driver because the flash driver is the

> sole runtime DXE (or SMM) driver that accesses & owns the flash MMIO

> range. With the PL011 register block, that's not the case; all runtime

> drivers that produce debug messages own it co-operatively.


On our platforms, we actually use
IntelFrameworkModulePkg/PeiDxeDebugLibReportStatusCode,
MdeModulePkg/RuntimeDxeReportStatusCodeLib and
IntelFrameworkModulePkg/StatusCodeRuntimeDxe as the whole DebugLib call chain
for runtime drivers. Is StatusCodeRuntimeDxe a good place for GCD manipulation?
But I've no idea on how to distinguish the code between ARM and X86, for X86
uses port IO for serial port access.

Regards,

Heyi

> 

> Thanks

> Laszlo

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Feb. 27, 2018, 2:21 p.m. | #8
On 27 February 2018 at 10:43, Laszlo Ersek <lersek@redhat.com> wrote:
> On 02/27/18 10:23, Ard Biesheuvel wrote:

>> On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:

>>> Hi Ard,

>>>

>>> Sorry for the late of seeing this patch. I have one question: why don't we

>>> implement a runtime serial port lib, which will switch UART base address in

>>> virtual address map change? I think this will be useful when we want to debug

>>> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

>>> then we don't need a runtime version of DebugLib which just disable touching

>>> serial port.

>>>

>>

>> Well, only if the serial port is not exposed to the OS as well. The

>> Linux PL011 driver is especially easy to confuse, and having both the

>> firmware and the OS control it at the same time is likely to cause

>> problems.

>>

>> However, I do agree that having the ability to assign a UART to DEBUG

>> at runtime is useful, and so I do intend to create a runtime version

>> of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can

>> be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER

>> modules.

>>

>

> Converting the PL011 base address from phys to virt can be done in the

> library instance, yes (and then every runtime driver module linked

> against this library instance will individually convert the address for

> its own use). The messier aspect is getting the PL011 base address into

> the UEFI memmap, marked as MMIO / RUNTIME, so that the OS assign a

> virtual mapping to it in the first place.

>

> The flash drivers generally do this with AddMemorySpace /

> SetMemorySpaceAttributes.

>

> (Side point: while I agree that those are good APIs to invoke, I think

> they should also call AllocateMemorySpace right after; otherwise a

> "stray" AllocateMemorySpace elsewhere could allocate a chunk out of the

> middle of what the flash driver *thinks* it owns.)

>

> The question is where this pair (or triplet) of GCD APIs should be called:

>

> - In a platform DXE driver? Perhaps.

>

> - In the DebugLib instance constructor / destructor? That could result

> in some ugly reference counting -- you might want to keep the PL011 area

> registered in GCD as long as *at least one* such runtime driver is loaded.

>

> This is different from the flash driver because the flash driver is the

> sole runtime DXE (or SMM) driver that accesses & owns the flash MMIO

> range. With the PL011 register block, that's not the case; all runtime

> drivers that produce debug messages own it co-operatively.

>


Given that this SerialPortLib will be of the DXE_RUNTIME_DRIVER type
anyway, couldn't we base it on a generic RuntimeUart protocol that we
can depex on in the library, and produce in a separate [singleton]
runtime DXE driver, which takes care of the UART initialization as
well as the GCD memory space handling?

In fact, we could modify DxeRuntimeDebugLibSerialPort to attach to
this protocol if it exists at EndOfDxe, and either do nothing at
runtime (as it does currently) or produce UART output via the protocol
if it exists.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Laszlo Ersek Feb. 27, 2018, 3:59 p.m. | #9
On 02/27/18 12:30, Guo Heyi wrote:
> On Tue, Feb 27, 2018 at 11:43:35AM +0100, Laszlo Ersek wrote:

>> On 02/27/18 10:23, Ard Biesheuvel wrote:

>>> On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:

>>>> Hi Ard,

>>>>

>>>> Sorry for the late of seeing this patch. I have one question: why don't we

>>>> implement a runtime serial port lib, which will switch UART base address in

>>>> virtual address map change? I think this will be useful when we want to debug

>>>> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

>>>> then we don't need a runtime version of DebugLib which just disable touching

>>>> serial port.

>>>>

>>>

>>> Well, only if the serial port is not exposed to the OS as well. The

>>> Linux PL011 driver is especially easy to confuse, and having both the

>>> firmware and the OS control it at the same time is likely to cause

>>> problems.

>>>

>>> However, I do agree that having the ability to assign a UART to DEBUG

>>> at runtime is useful, and so I do intend to create a runtime version

>>> of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can

>>> be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER

>>> modules.

>>>

>>

>> Converting the PL011 base address from phys to virt can be done in the

>> library instance, yes (and then every runtime driver module linked

>> against this library instance will individually convert the address for

>> its own use). The messier aspect is getting the PL011 base address into

>> the UEFI memmap, marked as MMIO / RUNTIME, so that the OS assign a

>> virtual mapping to it in the first place.

>>

>> The flash drivers generally do this with AddMemorySpace /

>> SetMemorySpaceAttributes.

>>

>> (Side point: while I agree that those are good APIs to invoke, I think

>> they should also call AllocateMemorySpace right after; otherwise a

>> "stray" AllocateMemorySpace elsewhere could allocate a chunk out of the

>> middle of what the flash driver *thinks* it owns.)

>>

>> The question is where this pair (or triplet) of GCD APIs should be called:

>>

>> - In a platform DXE driver? Perhaps.

>>

>> - In the DebugLib instance constructor / destructor? That could result

>> in some ugly reference counting -- you might want to keep the PL011 area

>> registered in GCD as long as *at least one* such runtime driver is loaded.

>>

>> This is different from the flash driver because the flash driver is the

>> sole runtime DXE (or SMM) driver that accesses & owns the flash MMIO

>> range. With the PL011 register block, that's not the case; all runtime

>> drivers that produce debug messages own it co-operatively.

> 

> On our platforms, we actually use

> IntelFrameworkModulePkg/PeiDxeDebugLibReportStatusCode,

> MdeModulePkg/RuntimeDxeReportStatusCodeLib and

> IntelFrameworkModulePkg/StatusCodeRuntimeDxe as the whole DebugLib call chain

> for runtime drivers. Is StatusCodeRuntimeDxe a good place for GCD manipulation?


Sure; if DebugLib (and the library instances below it) don't directly
access hardware, but make calls to some shared code -- i.e. into another
runtime DXE driver via a protocol interface originally looked up /
stashed at boot time, and then converted to a virtual address --, then
only that runtime DXE driver needs to manage the GCD map.

> But I've no idea on how to distinguish the code between ARM and X86, for X86

> uses port IO for serial port access.


If you can ascertain that the lib instance linked into
StatusCodeRuntimeDxe (a) is not used by any other module, and (b)
performs the hardware access, then you could push the GCD management
into that lib instance. Or else, you could write a plug-in lib instance
and hook that with NULL resolution into the driver.

But, I guess, at this point it's simplest to modify PlatformPei or
PlatformDxe to add that entry to GCD in advance, regardless of the
actual number of runtime DXE drivers that will rely on the mapping.

Laszlo
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Laszlo Ersek Feb. 27, 2018, 4:09 p.m. | #10
On 02/27/18 15:21, Ard Biesheuvel wrote:
> On 27 February 2018 at 10:43, Laszlo Ersek <lersek@redhat.com> wrote:

>> On 02/27/18 10:23, Ard Biesheuvel wrote:

>>> On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:

>>>> Hi Ard,

>>>>

>>>> Sorry for the late of seeing this patch. I have one question: why don't we

>>>> implement a runtime serial port lib, which will switch UART base address in

>>>> virtual address map change? I think this will be useful when we want to debug

>>>> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

>>>> then we don't need a runtime version of DebugLib which just disable touching

>>>> serial port.

>>>>

>>>

>>> Well, only if the serial port is not exposed to the OS as well. The

>>> Linux PL011 driver is especially easy to confuse, and having both the

>>> firmware and the OS control it at the same time is likely to cause

>>> problems.

>>>

>>> However, I do agree that having the ability to assign a UART to DEBUG

>>> at runtime is useful, and so I do intend to create a runtime version

>>> of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can

>>> be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER

>>> modules.

>>>

>>

>> Converting the PL011 base address from phys to virt can be done in the

>> library instance, yes (and then every runtime driver module linked

>> against this library instance will individually convert the address for

>> its own use). The messier aspect is getting the PL011 base address into

>> the UEFI memmap, marked as MMIO / RUNTIME, so that the OS assign a

>> virtual mapping to it in the first place.

>>

>> The flash drivers generally do this with AddMemorySpace /

>> SetMemorySpaceAttributes.

>>

>> (Side point: while I agree that those are good APIs to invoke, I think

>> they should also call AllocateMemorySpace right after; otherwise a

>> "stray" AllocateMemorySpace elsewhere could allocate a chunk out of the

>> middle of what the flash driver *thinks* it owns.)

>>

>> The question is where this pair (or triplet) of GCD APIs should be called:

>>

>> - In a platform DXE driver? Perhaps.

>>

>> - In the DebugLib instance constructor / destructor? That could result

>> in some ugly reference counting -- you might want to keep the PL011 area

>> registered in GCD as long as *at least one* such runtime driver is loaded.

>>

>> This is different from the flash driver because the flash driver is the

>> sole runtime DXE (or SMM) driver that accesses & owns the flash MMIO

>> range. With the PL011 register block, that's not the case; all runtime

>> drivers that produce debug messages own it co-operatively.

>>

> 

> Given that this SerialPortLib will be of the DXE_RUNTIME_DRIVER type

> anyway, couldn't we base it on a generic RuntimeUart protocol that we

> can depex on in the library, and produce in a separate [singleton]

> runtime DXE driver, which takes care of the UART initialization as

> well as the GCD memory space handling?


Yes, that should totally work.

> In fact, we could modify DxeRuntimeDebugLibSerialPort to attach to

> this protocol if it exists at EndOfDxe, and either do nothing at

> runtime (as it does currently) or produce UART output via the protocol

> if it exists.


This is a good idea IMO. What about the following: since you'd have to
register an event notification function for EndOfDxe, why not register a
protocol notify directly for the runtime UART protocol?

Thanks,
Laszlo
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Feb. 27, 2018, 4:10 p.m. | #11
On 27 February 2018 at 16:09, Laszlo Ersek <lersek@redhat.com> wrote:
> On 02/27/18 15:21, Ard Biesheuvel wrote:

>> On 27 February 2018 at 10:43, Laszlo Ersek <lersek@redhat.com> wrote:

>>> On 02/27/18 10:23, Ard Biesheuvel wrote:

>>>> On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:

>>>>> Hi Ard,

>>>>>

>>>>> Sorry for the late of seeing this patch. I have one question: why don't we

>>>>> implement a runtime serial port lib, which will switch UART base address in

>>>>> virtual address map change? I think this will be useful when we want to debug

>>>>> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

>>>>> then we don't need a runtime version of DebugLib which just disable touching

>>>>> serial port.

>>>>>

>>>>

>>>> Well, only if the serial port is not exposed to the OS as well. The

>>>> Linux PL011 driver is especially easy to confuse, and having both the

>>>> firmware and the OS control it at the same time is likely to cause

>>>> problems.

>>>>

>>>> However, I do agree that having the ability to assign a UART to DEBUG

>>>> at runtime is useful, and so I do intend to create a runtime version

>>>> of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can

>>>> be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER

>>>> modules.

>>>>

>>>

>>> Converting the PL011 base address from phys to virt can be done in the

>>> library instance, yes (and then every runtime driver module linked

>>> against this library instance will individually convert the address for

>>> its own use). The messier aspect is getting the PL011 base address into

>>> the UEFI memmap, marked as MMIO / RUNTIME, so that the OS assign a

>>> virtual mapping to it in the first place.

>>>

>>> The flash drivers generally do this with AddMemorySpace /

>>> SetMemorySpaceAttributes.

>>>

>>> (Side point: while I agree that those are good APIs to invoke, I think

>>> they should also call AllocateMemorySpace right after; otherwise a

>>> "stray" AllocateMemorySpace elsewhere could allocate a chunk out of the

>>> middle of what the flash driver *thinks* it owns.)

>>>

>>> The question is where this pair (or triplet) of GCD APIs should be called:

>>>

>>> - In a platform DXE driver? Perhaps.

>>>

>>> - In the DebugLib instance constructor / destructor? That could result

>>> in some ugly reference counting -- you might want to keep the PL011 area

>>> registered in GCD as long as *at least one* such runtime driver is loaded.

>>>

>>> This is different from the flash driver because the flash driver is the

>>> sole runtime DXE (or SMM) driver that accesses & owns the flash MMIO

>>> range. With the PL011 register block, that's not the case; all runtime

>>> drivers that produce debug messages own it co-operatively.

>>>

>>

>> Given that this SerialPortLib will be of the DXE_RUNTIME_DRIVER type

>> anyway, couldn't we base it on a generic RuntimeUart protocol that we

>> can depex on in the library, and produce in a separate [singleton]

>> runtime DXE driver, which takes care of the UART initialization as

>> well as the GCD memory space handling?

>

> Yes, that should totally work.

>

>> In fact, we could modify DxeRuntimeDebugLibSerialPort to attach to

>> this protocol if it exists at EndOfDxe, and either do nothing at

>> runtime (as it does currently) or produce UART output via the protocol

>> if it exists.

>

> This is a good idea IMO. What about the following: since you'd have to

> register an event notification function for EndOfDxe, why not register a

> protocol notify directly for the runtime UART protocol?

>


Even better.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Feb. 27, 2018, 5:33 p.m. | #12
On 27 February 2018 at 16:10, Ard Biesheuvel <ard.biesheuvel@linaro.org> wrote:
> On 27 February 2018 at 16:09, Laszlo Ersek <lersek@redhat.com> wrote:

>> On 02/27/18 15:21, Ard Biesheuvel wrote:

>>> On 27 February 2018 at 10:43, Laszlo Ersek <lersek@redhat.com> wrote:

>>>> On 02/27/18 10:23, Ard Biesheuvel wrote:

>>>>> On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:

>>>>>> Hi Ard,

>>>>>>

>>>>>> Sorry for the late of seeing this patch. I have one question: why don't we

>>>>>> implement a runtime serial port lib, which will switch UART base address in

>>>>>> virtual address map change? I think this will be useful when we want to debug

>>>>>> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

>>>>>> then we don't need a runtime version of DebugLib which just disable touching

>>>>>> serial port.

>>>>>>

>>>>>

>>>>> Well, only if the serial port is not exposed to the OS as well. The

>>>>> Linux PL011 driver is especially easy to confuse, and having both the

>>>>> firmware and the OS control it at the same time is likely to cause

>>>>> problems.

>>>>>

>>>>> However, I do agree that having the ability to assign a UART to DEBUG

>>>>> at runtime is useful, and so I do intend to create a runtime version

>>>>> of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can

>>>>> be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER

>>>>> modules.

>>>>>

>>>>

>>>> Converting the PL011 base address from phys to virt can be done in the

>>>> library instance, yes (and then every runtime driver module linked

>>>> against this library instance will individually convert the address for

>>>> its own use). The messier aspect is getting the PL011 base address into

>>>> the UEFI memmap, marked as MMIO / RUNTIME, so that the OS assign a

>>>> virtual mapping to it in the first place.

>>>>

>>>> The flash drivers generally do this with AddMemorySpace /

>>>> SetMemorySpaceAttributes.

>>>>

>>>> (Side point: while I agree that those are good APIs to invoke, I think

>>>> they should also call AllocateMemorySpace right after; otherwise a

>>>> "stray" AllocateMemorySpace elsewhere could allocate a chunk out of the

>>>> middle of what the flash driver *thinks* it owns.)

>>>>

>>>> The question is where this pair (or triplet) of GCD APIs should be called:

>>>>

>>>> - In a platform DXE driver? Perhaps.

>>>>

>>>> - In the DebugLib instance constructor / destructor? That could result

>>>> in some ugly reference counting -- you might want to keep the PL011 area

>>>> registered in GCD as long as *at least one* such runtime driver is loaded.

>>>>

>>>> This is different from the flash driver because the flash driver is the

>>>> sole runtime DXE (or SMM) driver that accesses & owns the flash MMIO

>>>> range. With the PL011 register block, that's not the case; all runtime

>>>> drivers that produce debug messages own it co-operatively.

>>>>

>>>

>>> Given that this SerialPortLib will be of the DXE_RUNTIME_DRIVER type

>>> anyway, couldn't we base it on a generic RuntimeUart protocol that we

>>> can depex on in the library, and produce in a separate [singleton]

>>> runtime DXE driver, which takes care of the UART initialization as

>>> well as the GCD memory space handling?

>>

>> Yes, that should totally work.

>>

>>> In fact, we could modify DxeRuntimeDebugLibSerialPort to attach to

>>> this protocol if it exists at EndOfDxe, and either do nothing at

>>> runtime (as it does currently) or produce UART output via the protocol

>>> if it exists.

>>

>> This is a good idea IMO. What about the following: since you'd have to

>> register an event notification function for EndOfDxe, why not register a

>> protocol notify directly for the runtime UART protocol?

>>


What I also like about this approach is that it defers the decision
whether to enable the DEBUG UART at OS runtime from compile time to
runtime [where 'runtime' is a tad overloaded here]

IOW, you can use a variable, PCD or simply do 'load
fs0:\UartRuntimeDxe.efi' from the Shell to promote a 'runtime silent'
DEBUG build to one that produces DEBUG output while running under the
OS.

I guess the only problem is that DxeRuntimeDebugLibSerialPort lives in
MdePkg, and so any extensions to it involving protocols require an ECR
against the PI spec first.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Laszlo Ersek Feb. 27, 2018, 5:47 p.m. | #13
On 02/27/18 18:33, Ard Biesheuvel wrote:
> On 27 February 2018 at 16:10, Ard Biesheuvel <ard.biesheuvel@linaro.org> wrote:

>> On 27 February 2018 at 16:09, Laszlo Ersek <lersek@redhat.com> wrote:

>>> On 02/27/18 15:21, Ard Biesheuvel wrote:

>>>> On 27 February 2018 at 10:43, Laszlo Ersek <lersek@redhat.com> wrote:

>>>>> On 02/27/18 10:23, Ard Biesheuvel wrote:

>>>>>> On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:

>>>>>>> Hi Ard,

>>>>>>>

>>>>>>> Sorry for the late of seeing this patch. I have one question: why don't we

>>>>>>> implement a runtime serial port lib, which will switch UART base address in

>>>>>>> virtual address map change? I think this will be useful when we want to debug

>>>>>>> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

>>>>>>> then we don't need a runtime version of DebugLib which just disable touching

>>>>>>> serial port.

>>>>>>>

>>>>>>

>>>>>> Well, only if the serial port is not exposed to the OS as well. The

>>>>>> Linux PL011 driver is especially easy to confuse, and having both the

>>>>>> firmware and the OS control it at the same time is likely to cause

>>>>>> problems.

>>>>>>

>>>>>> However, I do agree that having the ability to assign a UART to DEBUG

>>>>>> at runtime is useful, and so I do intend to create a runtime version

>>>>>> of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can

>>>>>> be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER

>>>>>> modules.

>>>>>>

>>>>>

>>>>> Converting the PL011 base address from phys to virt can be done in the

>>>>> library instance, yes (and then every runtime driver module linked

>>>>> against this library instance will individually convert the address for

>>>>> its own use). The messier aspect is getting the PL011 base address into

>>>>> the UEFI memmap, marked as MMIO / RUNTIME, so that the OS assign a

>>>>> virtual mapping to it in the first place.

>>>>>

>>>>> The flash drivers generally do this with AddMemorySpace /

>>>>> SetMemorySpaceAttributes.

>>>>>

>>>>> (Side point: while I agree that those are good APIs to invoke, I think

>>>>> they should also call AllocateMemorySpace right after; otherwise a

>>>>> "stray" AllocateMemorySpace elsewhere could allocate a chunk out of the

>>>>> middle of what the flash driver *thinks* it owns.)

>>>>>

>>>>> The question is where this pair (or triplet) of GCD APIs should be called:

>>>>>

>>>>> - In a platform DXE driver? Perhaps.

>>>>>

>>>>> - In the DebugLib instance constructor / destructor? That could result

>>>>> in some ugly reference counting -- you might want to keep the PL011 area

>>>>> registered in GCD as long as *at least one* such runtime driver is loaded.

>>>>>

>>>>> This is different from the flash driver because the flash driver is the

>>>>> sole runtime DXE (or SMM) driver that accesses & owns the flash MMIO

>>>>> range. With the PL011 register block, that's not the case; all runtime

>>>>> drivers that produce debug messages own it co-operatively.

>>>>>

>>>>

>>>> Given that this SerialPortLib will be of the DXE_RUNTIME_DRIVER type

>>>> anyway, couldn't we base it on a generic RuntimeUart protocol that we

>>>> can depex on in the library, and produce in a separate [singleton]

>>>> runtime DXE driver, which takes care of the UART initialization as

>>>> well as the GCD memory space handling?

>>>

>>> Yes, that should totally work.

>>>

>>>> In fact, we could modify DxeRuntimeDebugLibSerialPort to attach to

>>>> this protocol if it exists at EndOfDxe, and either do nothing at

>>>> runtime (as it does currently) or produce UART output via the protocol

>>>> if it exists.

>>>

>>> This is a good idea IMO. What about the following: since you'd have to

>>> register an event notification function for EndOfDxe, why not register a

>>> protocol notify directly for the runtime UART protocol?

>>>

> 

> What I also like about this approach is that it defers the decision

> whether to enable the DEBUG UART at OS runtime from compile time to

> runtime [where 'runtime' is a tad overloaded here]

> 

> IOW, you can use a variable, PCD or simply do 'load

> fs0:\UartRuntimeDxe.efi' from the Shell to promote a 'runtime silent'

> DEBUG build to one that produces DEBUG output while running under the

> OS.

> 

> I guess the only problem is that DxeRuntimeDebugLibSerialPort lives in

> MdePkg, and so any extensions to it involving protocols require an ECR

> against the PI spec first.

> 


This is a brand new library instance, not many platform DSCs use it just
yet. Can we simply move it to MdeModulePkg? Do we see any downsides to
not offering the lib instance in MdePkg?

Thanks
Laszlo
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Feb. 27, 2018, 5:55 p.m. | #14
On 27 February 2018 at 17:47, Laszlo Ersek <lersek@redhat.com> wrote:
> On 02/27/18 18:33, Ard Biesheuvel wrote:

>> On 27 February 2018 at 16:10, Ard Biesheuvel <ard.biesheuvel@linaro.org> wrote:

>>> On 27 February 2018 at 16:09, Laszlo Ersek <lersek@redhat.com> wrote:

>>>> On 02/27/18 15:21, Ard Biesheuvel wrote:

>>>>> On 27 February 2018 at 10:43, Laszlo Ersek <lersek@redhat.com> wrote:

>>>>>> On 02/27/18 10:23, Ard Biesheuvel wrote:

>>>>>>> On 27 February 2018 at 01:50, Guo Heyi <heyi.guo@linaro.org> wrote:

>>>>>>>> Hi Ard,

>>>>>>>>

>>>>>>>> Sorry for the late of seeing this patch. I have one question: why don't we

>>>>>>>> implement a runtime serial port lib, which will switch UART base address in

>>>>>>>> virtual address map change? I think this will be useful when we want to debug

>>>>>>>> runtime driver in OS stage. And if we have a runtime version of SerialPortLib,

>>>>>>>> then we don't need a runtime version of DebugLib which just disable touching

>>>>>>>> serial port.

>>>>>>>>

>>>>>>>

>>>>>>> Well, only if the serial port is not exposed to the OS as well. The

>>>>>>> Linux PL011 driver is especially easy to confuse, and having both the

>>>>>>> firmware and the OS control it at the same time is likely to cause

>>>>>>> problems.

>>>>>>>

>>>>>>> However, I do agree that having the ability to assign a UART to DEBUG

>>>>>>> at runtime is useful, and so I do intend to create a runtime version

>>>>>>> of the PL011 library, in which case DxeRuntimeDebugLibSerialPort can

>>>>>>> be replaced with BaseDebugLibSerialPort for DXE_RUNTIME_DRIVER

>>>>>>> modules.

>>>>>>>

>>>>>>

>>>>>> Converting the PL011 base address from phys to virt can be done in the

>>>>>> library instance, yes (and then every runtime driver module linked

>>>>>> against this library instance will individually convert the address for

>>>>>> its own use). The messier aspect is getting the PL011 base address into

>>>>>> the UEFI memmap, marked as MMIO / RUNTIME, so that the OS assign a

>>>>>> virtual mapping to it in the first place.

>>>>>>

>>>>>> The flash drivers generally do this with AddMemorySpace /

>>>>>> SetMemorySpaceAttributes.

>>>>>>

>>>>>> (Side point: while I agree that those are good APIs to invoke, I think

>>>>>> they should also call AllocateMemorySpace right after; otherwise a

>>>>>> "stray" AllocateMemorySpace elsewhere could allocate a chunk out of the

>>>>>> middle of what the flash driver *thinks* it owns.)

>>>>>>

>>>>>> The question is where this pair (or triplet) of GCD APIs should be called:

>>>>>>

>>>>>> - In a platform DXE driver? Perhaps.

>>>>>>

>>>>>> - In the DebugLib instance constructor / destructor? That could result

>>>>>> in some ugly reference counting -- you might want to keep the PL011 area

>>>>>> registered in GCD as long as *at least one* such runtime driver is loaded.

>>>>>>

>>>>>> This is different from the flash driver because the flash driver is the

>>>>>> sole runtime DXE (or SMM) driver that accesses & owns the flash MMIO

>>>>>> range. With the PL011 register block, that's not the case; all runtime

>>>>>> drivers that produce debug messages own it co-operatively.

>>>>>>

>>>>>

>>>>> Given that this SerialPortLib will be of the DXE_RUNTIME_DRIVER type

>>>>> anyway, couldn't we base it on a generic RuntimeUart protocol that we

>>>>> can depex on in the library, and produce in a separate [singleton]

>>>>> runtime DXE driver, which takes care of the UART initialization as

>>>>> well as the GCD memory space handling?

>>>>

>>>> Yes, that should totally work.

>>>>

>>>>> In fact, we could modify DxeRuntimeDebugLibSerialPort to attach to

>>>>> this protocol if it exists at EndOfDxe, and either do nothing at

>>>>> runtime (as it does currently) or produce UART output via the protocol

>>>>> if it exists.

>>>>

>>>> This is a good idea IMO. What about the following: since you'd have to

>>>> register an event notification function for EndOfDxe, why not register a

>>>> protocol notify directly for the runtime UART protocol?

>>>>

>>

>> What I also like about this approach is that it defers the decision

>> whether to enable the DEBUG UART at OS runtime from compile time to

>> runtime [where 'runtime' is a tad overloaded here]

>>

>> IOW, you can use a variable, PCD or simply do 'load

>> fs0:\UartRuntimeDxe.efi' from the Shell to promote a 'runtime silent'

>> DEBUG build to one that produces DEBUG output while running under the

>> OS.

>>

>> I guess the only problem is that DxeRuntimeDebugLibSerialPort lives in

>> MdePkg, and so any extensions to it involving protocols require an ECR

>> against the PI spec first.

>>

>

> This is a brand new library instance, not many platform DSCs use it just

> yet. Can we simply move it to MdeModulePkg? Do we see any downsides to

> not offering the lib instance in MdePkg?

>


Good point. I think that should be fine
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Patch

diff --git a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc
index 7d85b78642da..348828e18d44 100644
--- a/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc
+++ b/Platform/AMD/OverdriveBoard/OverdriveBoard.dsc
@@ -227,6 +227,9 @@  [LibraryClasses.common.DXE_RUNTIME_DRIVER]
   HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf
   MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf
   CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf
+!if $(TARGET) != RELEASE
+  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf
+!endif
 
 [LibraryClasses.common.UEFI_APPLICATION]
   UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
diff --git a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc
index b026ce3a420a..7cb47937329e 100644
--- a/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc
+++ b/Platform/ARM/VExpressPkg/ArmVExpress.dsc.inc
@@ -227,6 +227,9 @@  [LibraryClasses.common.DXE_RUNTIME_DRIVER]
 !if $(SECURE_BOOT_ENABLE) == TRUE
   BaseCryptLib|CryptoPkg/Library/BaseCryptLib/RuntimeCryptLib.inf
 !endif
+!if $(TARGET) != RELEASE
+  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf
+!endif
 
 [LibraryClasses.ARM, LibraryClasses.AARCH64]
   #
diff --git a/Platform/LeMaker/CelloBoard/CelloBoard.dsc b/Platform/LeMaker/CelloBoard/CelloBoard.dsc
index 2468583c0daa..569e444f6b26 100644
--- a/Platform/LeMaker/CelloBoard/CelloBoard.dsc
+++ b/Platform/LeMaker/CelloBoard/CelloBoard.dsc
@@ -211,6 +211,9 @@  [LibraryClasses.common.DXE_RUNTIME_DRIVER]
   MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf
   ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
   CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf
+!if $(TARGET) != RELEASE
+  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf
+!endif
 
 [LibraryClasses.common.UEFI_APPLICATION]
   UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
diff --git a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc
index 8450d7800e43..925ce36d278b 100644
--- a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc
+++ b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc
@@ -208,6 +208,9 @@  [LibraryClasses.common.DXE_RUNTIME_DRIVER]
   CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf
   ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf
   BaseMemoryLib|MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf
+!if $(TARGET) != RELEASE
+  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf
+!endif
 
 ################################################################################
 #
diff --git a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc
index 45ab2afc4069..2d5a94ed1dab 100644
--- a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc
+++ b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc
@@ -203,6 +203,9 @@  [LibraryClasses.common.DXE_RUNTIME_DRIVER]
   HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf
   CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf
   ResetSystemLib|ArmPkg/Library/ArmSmcPsciResetSystemLib/ArmSmcPsciResetSystemLib.inf
+!if $(TARGET) != RELEASE
+  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf
+!endif
 
 ################################################################################
 #
diff --git a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc
index f0a7e9794153..3f4c7c8a3eef 100644
--- a/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc
+++ b/Platform/SoftIron/Overdrive1000Board/Overdrive1000Board.dsc
@@ -217,6 +217,9 @@  [LibraryClasses.common.DXE_RUNTIME_DRIVER]
   MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf
   ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
   CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf
+!if $(TARGET) != RELEASE
+  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf
+!endif
 
 [LibraryClasses.common.UEFI_APPLICATION]
   UefiDecompressLib|IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
diff --git a/Silicon/Hisilicon/Hisilicon.dsc.inc b/Silicon/Hisilicon/Hisilicon.dsc.inc
index 9050f29be381..b196322a20e2 100644
--- a/Silicon/Hisilicon/Hisilicon.dsc.inc
+++ b/Silicon/Hisilicon/Hisilicon.dsc.inc
@@ -213,6 +213,9 @@  [LibraryClasses.common.DXE_RUNTIME_DRIVER]
 !ifndef CONFIG_NO_DEBUGLIB
   DebugLib|IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf
 !endif
+!if $(TARGET) != RELEASE
+  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf
+!endif
 
 [LibraryClasses.AARCH64]
   ArmGenericTimerCounterLib|ArmPkg/Library/ArmGenericTimerPhyCounterLib/ArmGenericTimerPhyCounterLib.inf
diff --git a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc
index ef70b5216727..535cc3ff4c19 100644
--- a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc
+++ b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc
@@ -184,6 +184,9 @@  [LibraryClasses.common.DXE_RUNTIME_DRIVER]
   HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf
   MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf
   CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf
+!if $(TARGET) != RELEASE
+  DebugLib|MdePkg/Library/DxeRuntimeDebugLibSerialPort/DxeRuntimeDebugLibSerialPort.inf
+!endif
 
 [LibraryClasses.ARM, LibraryClasses.AARCH64]
   #