Re: [PATCH v2 2/2] ArmVirtPkg: switch to new PL011UartLib implementation

[Laszlo Ersek <lersek@redhat.com>]

On 11/16/17 18:47, Ard Biesheuvel wrote:
> Switch to the new, cleaned up PL011UartLib implementation so we will
> be able to remove the old one.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> ---
>  ArmVirtPkg/ArmVirt.dsc.inc                                            | 2 +-
>  ArmVirtPkg/Library/FdtPL011SerialPortLib/EarlyFdtPL011SerialPortLib.c | 5 ++---
>  ArmVirtPkg/Library/FdtPL011SerialPortLib/FdtPL011SerialPortLib.c      | 5 ++---
>  3 files changed, 5 insertions(+), 7 deletions(-)
> 
> diff --git a/ArmVirtPkg/ArmVirt.dsc.inc b/ArmVirtPkg/ArmVirt.dsc.inc
> index c92a69281ae4..50eb8675d1c0 100644
> --- a/ArmVirtPkg/ArmVirt.dsc.inc
> +++ b/ArmVirtPkg/ArmVirt.dsc.inc
> @@ -106,7 +106,7 @@ [LibraryClasses.common]
>    RealTimeClockLib|ArmPlatformPkg/Library/PL031RealTimeClockLib/PL031RealTimeClockLib.inf
>    TimeBaseLib|EmbeddedPkg/Library/TimeBaseLib/TimeBaseLib.inf
>    # ARM PL011 UART Driver
> -  PL011UartLib|ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.inf
> +  PL011UartLib|ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.inf
>    SerialPortLib|ArmVirtPkg/Library/FdtPL011SerialPortLib/FdtPL011SerialPortLib.inf
>  
>    #
> diff --git a/ArmVirtPkg/Library/FdtPL011SerialPortLib/EarlyFdtPL011SerialPortLib.c b/ArmVirtPkg/Library/FdtPL011SerialPortLib/EarlyFdtPL011SerialPortLib.c
> index e28750f3b4c4..d9fd0ef98359 100644
> --- a/ArmVirtPkg/Library/FdtPL011SerialPortLib/EarlyFdtPL011SerialPortLib.c
> +++ b/ArmVirtPkg/Library/FdtPL011SerialPortLib/EarlyFdtPL011SerialPortLib.c
> @@ -16,14 +16,13 @@
>  
>  **/
>  
> -#include <Base.h>
> +#include <Uefi.h>
>  
>  #include <Library/PcdLib.h>
> +#include <Library/PL011UartLib.h>
>  #include <Library/SerialPortLib.h>
>  #include <libfdt.h>
>  
> -#include <Drivers/PL011Uart.h>
> -
>  RETURN_STATUS
>  EFIAPI
>  SerialPortInitialize (
> diff --git a/ArmVirtPkg/Library/FdtPL011SerialPortLib/FdtPL011SerialPortLib.c b/ArmVirtPkg/Library/FdtPL011SerialPortLib/FdtPL011SerialPortLib.c
> index 05d3547fda91..c161dd6349d3 100644
> --- a/ArmVirtPkg/Library/FdtPL011SerialPortLib/FdtPL011SerialPortLib.c
> +++ b/ArmVirtPkg/Library/FdtPL011SerialPortLib/FdtPL011SerialPortLib.c
> @@ -17,9 +17,10 @@
>  
>  **/
>  
> -#include <Base.h>
> +#include <Uefi.h>
>  
>  #include <Library/PcdLib.h>
> +#include <Library/PL011UartLib.h>
>  #include <Library/SerialPortLib.h>
>  #include <Pi/PiBootMode.h>
>  #include <Uefi/UefiBaseType.h>
> @@ -28,8 +29,6 @@
>  #include <Library/HobLib.h>
>  #include <Guid/EarlyPL011BaseAddress.h>
>  
> -#include <Drivers/PL011Uart.h>
> -
>  STATIC UINTN mSerialBaseAddress;
>  
>  RETURN_STATUS
> 

Awesome idea!

One comment: can you please check whether, if you replace

#include <Uefi.h>

with

#include <Uefi/UefiBaseType.h>

then stuff will still build?

Both SerialPortLib instances are BASE, so we should not include <Uefi.h>
(in particular <Uefi/UefiSpec.h> included by it).

If it works, then:

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

If it doesn't work, then I think we should figure out why not; it could
be a sign of some layering violation, which would be nice to document at
least in the commit message.

Thanks
Laszlo