Re: [edk2-devel] [plaforms/devel-riscv-v2 PATCHv2 10/14] U500Pkg/Library: Library instances of U500 platform library

["Abner Chang" <abner.chang@hpe.com>]

> -----Original Message-----
> From: Chang, Abner (HPS SW/FW Technologist)
> Sent: Thursday, October 17, 2019 10:21 AM
> To: devel@edk2.groups.io; leif.lindholm@linaro.org; Chen, Gilbert
> <gilbert.chen@hpe.com>
> Cc: Palmer Dabbelt <palmer@sifive.com>
> Subject: RE: [edk2-devel] [plaforms/devel-riscv-v2 PATCHv2 10/14]
> U500Pkg/Library: Library instances of U500 platform library
> 
> 
> 
> > -----Original Message-----
> > From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> > Leif Lindholm
> > Sent: Friday, October 4, 2019 12:32 AM
> > To: devel@edk2.groups.io; Chen, Gilbert <gilbert.chen@hpe.com>
> > Cc: Palmer Dabbelt <palmer@sifive.com>
> > Subject: Re: [edk2-devel] [plaforms/devel-riscv-v2 PATCHv2 10/14]
> > U500Pkg/Library: Library instances of U500 platform library
> >
> > On Thu, Sep 19, 2019 at 11:51:27AM +0800, Gilbert Chen wrote:
> > > OpneSbiPlatformLib
> > > - In order to reduce the dependencies with RISC-V OpenSBI project
> > > (https://github.com/riscv/opensbi) and less burdens to EDK2 build
> > > process, the implementation of RISC-V EDK2 platform is leverage
> > > platform source code from OpenSBI code tree. The "platform.c"
> > >  under OpenSbiPlatformLib is cloned from RISC-V OpenSBI code tree
> > > (in
> > > EDK2 RiscVPkg) and built based on EDK2 build environment.
> > >
> > > PeiCoreInfoHobLib
> > > - This is the library to create RISC-V core characteristics for
> > > building  up RISC-V related SMBIOS records to support the unified
> > > boot loader  and OS image.
> > >
> > > - RiscVPlatformTimerLib
> > > This is U500 platform timer library which has the platform-specific
> > > timer implementation.
> > >
> > > - SerialPortLib
> > > U500 serial port platform library
> >
> > Please split this up into the 4 logical commits.
> > And add the specific header files with those commits.
> >
> > > Signed-off-by: Gilbert Chen <gilbert.chen@hpe.com>
> > > ---
> > >  .../OpenSbiPlatformLib/OpenSbiPlatformLib.inf      |  47 ++++
> > >  .../U500Pkg/Library/OpenSbiPlatformLib/platform.c  | 214
> > ++++++++++++++++++
> > >  .../Library/PeiCoreInfoHobLib/CoreInfoHob.c        | 195
> > +++++++++++++++++
> > >  .../PeiCoreInfoHobLib/PeiCoreInfoHobLib.inf        |  58 +++++
> > >  .../RiscVPlatformTimerLib/RiscVPlatformTimerLib.S  |  48 ++++
> > >  .../RiscVPlatformTimerLib.inf                      |  39 ++++
> > >  .../U500Pkg/Library/SerialIoLib/SerialIoLib.inf    |  31 +++
> > >  .../U500Pkg/Library/SerialIoLib/SerialPortLib.c    | 241
> > +++++++++++++++++++++
> > >  .../Library/SerialIoLib/U500SerialPortLib.uni      |  16 ++
> > >  9 files changed, 889 insertions(+)
> > >  create mode 100644
> > >
> >
> Platform/RiscV/SiFive/U500Pkg/Library/OpenSbiPlatformLib/OpenSbiPlatfo
> > > rmLib.inf  create mode 100644
> > > Platform/RiscV/SiFive/U500Pkg/Library/OpenSbiPlatformLib/platform.c
> > >  create mode 100644
> > > Platform/RiscV/SiFive/U500Pkg/Library/PeiCoreInfoHobLib/CoreInfoHob.
> > > c
> > >  create mode 100644
> > >
> >
> Platform/RiscV/SiFive/U500Pkg/Library/PeiCoreInfoHobLib/PeiCoreInfoHob
> > > Lib.inf  create mode 100644
> > > Platform/RiscV/SiFive/U500Pkg/Library/RiscVPlatformTimerLib/RiscVPla
> > > tf
> > > ormTimerLib.S  create mode 100644
> > > Platform/RiscV/SiFive/U500Pkg/Library/RiscVPlatformTimerLib/RiscVPla
> > > tf
> > > ormTimerLib.inf  create mode 100644
> > > Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/SerialIoLib.inf
> > >  create mode 100644
> > > Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/SerialPortLib.c
> > >  create mode 100644
> > > Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/U500SerialPortLib.
> > > un
> > > i
> > >
> > > diff --git
> > >
> >
> a/Platform/RiscV/SiFive/U500Pkg/Library/OpenSbiPlatformLib/OpenSbiPlat
> > > formLib.inf
> > >
> >
> b/Platform/RiscV/SiFive/U500Pkg/Library/OpenSbiPlatformLib/OpenSbiPlat
> > > formLib.inf
> > > new file mode 100644
> > > index 00000000..473386d2
> > > --- /dev/null
> > > +++
> > b/Platform/RiscV/SiFive/U500Pkg/Library/OpenSbiPlatformLib/OpenSbi
> > > +++ PlatformLib.inf
> > > @@ -0,0 +1,47 @@
> > > +## @file
> > > +#  RISC-V OpenSbi Platform Library
> > > +#  This is the the required library which provides platform
> >
> > Please don't use the word required. (If it wasn't, why would you
> > include it at
> > all?)
> >
> > > +#  level opensbi functions follow RISC-V opensbi implementation.
> > > +#
> > > +#  Copyright (c) 2019, Hewlett Packard Enterprise Development LP.
> > > +All rights reserved.<BR> # #  SPDX-License-Identifier:
> > > +BSD-2-Clause-Patent # ##
> > > +
> > > +[Defines]
> > > +  INF_VERSION                    = 0x00010005
> >
> > Please bump specification version.
> >
> > > +  BASE_NAME                      = OpenSbiPlatformLib
> > > +  FILE_GUID                      = 9424ED54-EBDA-4FB5-8FF6-8291B07BB151
> > > +  MODULE_TYPE                    = SEC
> > > +  VERSION_STRING                 = 1.0
> > > +  LIBRARY_CLASS                  = OpenSbiPlatformLib
> >
> > Seeing this, I have a bit of a feeling that this Opensbi isn't being
> > consistently
> > treated/named:
> > - In edk2, we have RiscVPkg/Library/RiscVOpensbiLib which implements
> >   class RiscVOpensbiLib.
> > - Here, we have U500Pkg/Library/OpenSbiPlatformLib implementing the
> >   class OpenSbiPlatformLib.
> > - *Logically*, what we have is
> >   Platform/RiscV/Universal/Sec/SecMain.inf which depends on the
> >   OpensbiLib which depends on the OpenSbiPlatformLib.
> >   - However, there is no OpenSbiPlatformLib in edk2, which is very
> >     unfortunate because that does not let us build edk2/RiscVPkg in
> >     isolation (like we can with all the other packages in edk2).
> Will name it as Opensbi.
> >
> > Here is my preferred solution for untangling this:
> > 1) Standardise on OpenSbi or Opensbi. Opensbi follows the pattern we
> >    already use for Openssl, so would be my preference.
> > 2) Standardise on RiscVOpensbi or Opensbi - both for filenames and
> >    LibararyClasses. Either is fine, the former is less likely to clash
> >    with other imported projects in the future (but I would estimate
> >    this risk as *very* low to begin with).
> > 3) Implement a (RiscV)OpensbiPlatformLibNull in edk2/RiscVPkg/Library,
> I will have OpensbiPlatformLibNull  in RiscVPlatformPkg/Library
> 
> >    containing only what is required to build/link
> >    RiscVPkg/Library/(RiscV)OpensbiLib/.
> >    3.5) Map that to OpensbiPlatformLib in RiscVPkg/RiscVPkg.dsc.
> >    3.6) Add a depedency on OpensbiPlatformLib to
> >         (RiscV)OpensbiLib.inf
> >    3.7) Drop the dependency on OpensbiPlatformLib from
> >         Platform/RiscV/Universal/Sec/SecMain.inf
> Above work for me
I changed my mind. Due to SecMain is moved to RiscVPlatformPkg in edk2 and requires both RiscVOpensbiPlatformLib and RiscVOpensbLiib, SecMain.inf still has dependency with these two libs.
> >
> > (That might read like a lot of work, but really it's a 5 minute job
> > and if we untangle this now, this won't cascade over umpteen
> > platforms.)
> 
> 
> >
> > > +
> > > +#
> > > +# The following information is for reference only and not required
> > > +by the
> > build tools.
> > > +#
> > > +#  VALID_ARCHITECTURES           = RISCV64 EBC
> >
> > Drop EBC.
> >
> > > +#
> > > +
> > > +[Sources]
> > > +  platform.c
> >
> > Please rename as Platform.c.
> >
> > > +
> > > +[Packages]
> > > +  MdePkg/MdePkg.dec
> > > +  MdeModulePkg/MdeModulePkg.dec
> > > +  RiscVPkg/RiscVPkg.dec
> > > +  Platform/RiscV/RiscVPlatformPkg.dec
> >
> > Please sort files alphabetically.
> >
> > > +
> > > +[LibraryClasses]
> > > +  BaseLib
> > > +  DebugLib
> > > +  BaseMemoryLib
> > > +  PcdLib
> > > +  DebugAgentLib
> > > +  RiscVCpuLib
> > > +  PrintLib
> >
> > Please sort LibraryClasses alphabetically.
> >
> > > +
> > > +[FixedPcd]
> > > +  gUefiRiscVPlatformPkgTokenSpaceGuid.PcdHartCount
> > > +  gUefiRiscVPlatformPkgTokenSpaceGuid.PcdOpenSbiStackSize
> > > +  gUefiRiscVPlatformPkgTokenSpaceGuid.PcdBootHartId
> >
> > Please sort Pcds alphabetically.
> >
> > > diff --git
> > > a/Platform/RiscV/SiFive/U500Pkg/Library/OpenSbiPlatformLib/platform.
> > > c
> > > b/Platform/RiscV/SiFive/U500Pkg/Library/OpenSbiPlatformLib/platform.
> > > c
> > > new file mode 100644
> > > index 00000000..4dca75f2
> > > --- /dev/null
> > > +++ b/Platform/RiscV/SiFive/U500Pkg/Library/OpenSbiPlatformLib/platf
> > > +++ or
> > > +++ m.c
> > > @@ -0,0 +1,214 @@
> > > +/*
> > > + * SPDX-License-Identifier: BSD-2-Clause
> > > + *
> > > + * Copyright (c) 2019, Hewlett Packard Enterprise Development LP.
> > > +All rights reserved.<BR>
> > > + * Copyright (c) 2019 Western Digital Corporation or its affiliates.
> > > + *
> > > + * Authors:
> > > + *   Atish Patra <atish.patra@wdc.com>
> >
> > Please change commit Author instead.
> >
> > Please point out that this is the platform-specific portion of
> > OpensbiLib. With that, I'm OK with it not following EDK2 coding style.
> > *However*, it needs to follow OpenSBI coding style, and it currently
> > doesn't - 3-space indentation follows nothing.
> >
> > From what I see, OpenSBI follows Linux coding style. So please update
> > to that, throughout this file. *if* you untabify it (8 spaces/tab)
> > before submission, our tools will complain less, so do consider that.
> >
> > > + */
> > > +
> > > +#include <libfdt.h>
> > > +#include <fdt.h>
> > > +#include <sbi/riscv_encoding.h>
> > > +#include <sbi/sbi_const.h>
> > > +#include <sbi/sbi_hart.h>
> > > +#include <sbi/sbi_console.h>
> > > +#include <sbi/sbi_platform.h>
> > > +#include <sbi/riscv_io.h>
> > > +#include <sbi_utils/irqchip/plic.h> #include
> > > +<sbi_utils/serial/sifive-uart.h> #include <sbi_utils/sys/clint.h>
> > > +
> > > +
> > > +#define U500_HART_COUNT         FixedPcdGet32(PcdHartCount)
> > > +#define U500_HART_STACK_SIZE   FixedPcdGet32(PcdOpenSbiStackSize)
> > > +#define U500_BOOT_HART_ID       FixedPcdGet32(PcdBootHartId)
> > > +
> > > +#define U500_SYS_CLK         100000000
> > > +
> > > +#define U500_CLINT_ADDR         0x2000000
> > > +
> > > +#define U500_PLIC_ADDR            0xc000000
> > > +#define U500_PLIC_NUM_SOURCES      0x35
> > > +#define U500_PLIC_NUM_PRIORITIES   7
> > > +
> > > +#define U500_UART_ADDR            0x54000000
> > > +
> > > +#define U500_UART_BAUDRATE         115200
> > > +
> > > +/**
> > > + * The U500 SoC has 8 HARTs but HART ID 0 doesn't have S mode.
> > > + * HARTs 1 is selected as boot HART  */ #ifndef
> > > +U500_ENABLED_HART_MASK
> > > +#define U500_ENABLED_HART_MASK   (1 << U500_BOOT_HART_ID)
> > > +#endif
> > > +
> > > +#define U500_HARTID_DISABLED   ~(U500_ENABLED_HART_MASK)
> > > +
> > > +/* PRCI clock related macros */
> > > +//TODO: Do we need a separate driver for this ?
> >
> > Well, do we?
> >
> > > +#define U500_PRCI_BASE_ADDR         0x10000000
> > > +#define U500_PRCI_CLKMUXSTATUSREG   0x002C
> > > +#define U500_PRCI_CLKMUX_STATUS_TLCLKSEL   (0x1 << 1)
> >
> > Please adjust right-column alignment through the defines above.
> >
> > > +
> > > +static void U500_modify_dt(void *fdt) {
> > > +   u32 i, size;
> >
> >
> > > +   int chosen_offset, err;
> > > +   int cpu_offset;
> > > +   char cpu_node[32] = "";
> > > +   const char *mmu_type;
> > > +
> > > +   for (i = 0; i < U500_HART_COUNT; i++) {
> > > +      sbi_sprintf(cpu_node, "/cpus/cpu@%d", i);
> > > +      cpu_offset = fdt_path_offset(fdt, cpu_node);
> > > +      mmu_type = fdt_getprop(fdt, cpu_offset, "mmu-type", NULL);
> > > +      if (mmu_type && (!strcmp(mmu_type, "riscv,sv39") ||
> > > +          !strcmp(mmu_type,"riscv,sv48")))
> > > +         continue;
> > > +      else
> > > +         fdt_setprop_string(fdt, cpu_offset, "status", "masked");
> > > +      memset(cpu_node, 0, sizeof(cpu_node));
> > > +   }
> > > +   size = fdt_totalsize(fdt);
> > > +   err = fdt_open_into(fdt, fdt, size + 256);
> > > +   if (err < 0)
> > > +      sbi_printf("Device Tree can't be expanded to accmodate new
> > > + node");
> > > +
> > > +   chosen_offset = fdt_path_offset(fdt, "/chosen");
> > > +   fdt_setprop_string(fdt, chosen_offset, "stdout-path",
> > > +            "/soc/serial@10010000:115200");
> > > +
> > > +   plic_fdt_fixup(fdt, "riscv,plic0"); }
> > > +
> > > +static int U500_final_init(bool cold_boot) {
> > > +   void *fdt;
> > > +
> > > +   if (!cold_boot)
> > > +      return 0;
> > > +
> > > +   fdt = sbi_scratch_thishart_arg1_ptr();
> > > +   U500_modify_dt(fdt);
> > > +
> > > +   return 0;
> > > +}
> > > +
> > > +static u32 U500_pmp_region_count(u32 hartid) {
> > > +   return 1;
> > > +}
> > > +
> > > +static int U500_pmp_region_info(u32 hartid, u32 index,
> > > +             ulong *prot, ulong *addr, ulong *log2size) {
> > > +   int ret = 0;
> > > +
> > > +   switch (index) {
> > > +   case 0:
> > > +      *prot = PMP_R | PMP_W | PMP_X;
> > > +      *addr = 0;
> > > +      *log2size = __riscv_xlen;
> > > +      break;
> > > +   default:
> > > +      ret = -1;
> > > +      break;
> > > +   };
> > > +
> > > +   return ret;
> > > +}
> > > +
> > > +static int U500_console_init(void)
> > > +{
> > > +   unsigned long peri_in_freq;
> > > +
> > > +   peri_in_freq = U500_SYS_CLK/2;
> > > +   return sifive_uart_init(U500_UART_ADDR, peri_in_freq,
> > > +U500_UART_BAUDRATE); }
> > > +
> > > +static int U500_irqchip_init(bool cold_boot) {
> > > +   int rc;
> > > +   u32 hartid = sbi_current_hartid();
> > > +
> > > +   if (cold_boot) {
> > > +      rc = plic_cold_irqchip_init(U500_PLIC_ADDR,
> > > +                   U500_PLIC_NUM_SOURCES,
> > > +                   U500_HART_COUNT);
> > > +      if (rc)
> > > +         return rc;
> > > +   }
> > > +
> > > +   return plic_warm_irqchip_init(hartid,
> > > +         (hartid) ? (2 * hartid - 1) : 0,
> > > +         (hartid) ? (2 * hartid) : -1); }
> > > +
> > > +static int U500_ipi_init(bool cold_boot) {
> > > +   int rc;
> > > +
> > > +   if (cold_boot) {
> > > +      rc = clint_cold_ipi_init(U500_CLINT_ADDR,
> > > +                U500_HART_COUNT);
> > > +      if (rc)
> > > +         return rc;
> > > +
> > > +   }
> > > +
> > > +   return clint_warm_ipi_init();
> > > +}
> > > +
> > > +static int U500_timer_init(bool cold_boot) {
> > > +   int rc;
> > > +
> > > +   if (cold_boot) {
> > > +      rc = clint_cold_timer_init(U500_CLINT_ADDR,
> > > +                  U500_HART_COUNT);
> > > +      if (rc)
> > > +         return rc;
> > > +   }
> > > +
> > > +   return clint_warm_timer_init();
> > > +}
> > > +
> > > +static int U500_system_down(u32 type) {
> > > +   /* For now nothing to do. */
> > > +   return 0;
> > > +}
> > > +
> > > +const struct sbi_platform_operations platform_ops = {
> > > +   .pmp_region_count = U500_pmp_region_count,
> > > +   .pmp_region_info = U500_pmp_region_info,
> > > +   .final_init = U500_final_init,
> > > +   .console_putc = sifive_uart_putc,
> > > +   .console_getc = sifive_uart_getc,
> > > +   .console_init = U500_console_init,
> > > +   .irqchip_init = U500_irqchip_init,
> > > +   .ipi_send = clint_ipi_send,
> > > +   .ipi_sync = clint_ipi_sync,
> > > +   .ipi_clear = clint_ipi_clear,
> > > +   .ipi_init = U500_ipi_init,
> > > +   .timer_value = clint_timer_value,
> > > +   .timer_event_stop = clint_timer_event_stop,
> > > +   .timer_event_start = clint_timer_event_start,
> > > +   .timer_init = U500_timer_init,
> > > +   .system_reboot = U500_system_down,
> > > +   .system_shutdown = U500_system_down };
> > > +
> > > +const struct sbi_platform platform = {
> > > +   .opensbi_version   = OPENSBI_VERSION,                  // The OpenSBI
> > version this platform table is built bassed on.
> > > +   .platform_version   = SBI_PLATFORM_VERSION(0x0001, 0x0000),   //
> SBI
> > Platform version 1.0
> > > +   .name               = "SiFive Freedom U500",
> > > +   .features      = SBI_PLATFORM_DEFAULT_FEATURES,
> > > +   .hart_count      = U500_HART_COUNT,
> > > +   .hart_stack_size   = U500_HART_STACK_SIZE,
> > > +   .disabled_hart_mask   = U500_HARTID_DISABLED,
> > > +   .platform_ops_addr   = (unsigned long)&platform_ops
> > > +};
> > > diff --git
> > >
> a/Platform/RiscV/SiFive/U500Pkg/Library/PeiCoreInfoHobLib/CoreInfoHob.
> > > c
> > >
> b/Platform/RiscV/SiFive/U500Pkg/Library/PeiCoreInfoHobLib/CoreInfoHob.
> > > c
> > > new file mode 100644
> > > index 00000000..bfb97351
> > > --- /dev/null
> > > +++
> > b/Platform/RiscV/SiFive/U500Pkg/Library/PeiCoreInfoHobLib/CoreInfo
> > > +++ Hob.c
> > > @@ -0,0 +1,195 @@
> > > +/**@file
> > > +  Build up platform processor information.
> > > +
> > > +  Copyright (c) 2019, Hewlett Packard Enterprise Development LP.
> > > + All rights reserved.<BR>
> > > +
> > > +  SPDX-License-Identifier: BSD-2-Clause-Patent
> > > +
> > > +**/
> > > +
> > > +//
> > > +// The package level header files this module uses // #include
> > > +<PiPei.h>
> > > +
> > > +//
> > > +// The Library classes this module consumes // #include
> > > +<Library/DebugLib.h> #include <Library/HobLib.h> #include
> > > +<Library/BaseMemoryLib.h>
> > > +
> > > +#include <SmbiosProcessorSpecificData.h> #include
> > > +<ProcessorSpecificDataHob.h> #include <SiFiveU5MCCoreplex.h>
> > #include
> > > +<Library/SiFiveE51.h> #include <Library/SiFiveU54.h>
> >
> > Please sort includes alphabetically.
> >
> > > +
> > > +/**
> > > +  Build up processor-specific HOB for U5MC Coreplex
> > > +
> > > +  @param  UniqueId      Unique ID of this U5MC Coreplex processor
> > > +
> > > +  @return EFI_SUCCESS     The PEIM initialized successfully.
> > > +
> > > +**/
> > > +EFI_STATUS
> > > +EFIAPI
> > > +CreateU5MCCoreplexProcessorSpecificDataHob (
> > > +  IN UINTN UniqueId
> > > +  )
> > > +{
> > > +  EFI_STATUS Status;
> > > +  UINT32 HartIdNumber;
> > > +  RISC_V_PROCESSOR_SPECIFIC_DATA_HOB *GuidHobData;
> > > +  EFI_GUID *ParentCoreGuid;
> > > +  BOOLEAN MCSupport;
> > > +
> > > +  DEBUG ((DEBUG_INFO, "Building U5 Coreplex processor information
> > > + HOB\n"));
> > > +
> > > +  HartIdNumber = 0;
> > > +  ParentCoreGuid = PcdGetPtr(PcdSiFiveU5MCCoreplexGuid);
> > > +  MCSupport = PcdGetBool (PcdE5MCSupported);  if (MCSupport ==
> > > + TRUE) {
> > > +    Status = CreateE51CoreProcessorSpecificDataHob (ParentCoreGuid,
> > UniqueId, HartIdNumber, FALSE, &GuidHobData);
> > > +    if (EFI_ERROR (Status)) {
> > > +      DEBUG ((DEBUG_ERROR, "Faile to build U5MC processor
> > > + informatino
> > HOB\n"));
> > > +      ASSERT (FALSE);
> > > +    }
> > > +    HartIdNumber ++;
> > > +    DEBUG ((DEBUG_INFO, "Support E5 Monitor core on U500 platform,
> > > + HOB at address 0x%x\n", GuidHobData));
> >
> > Hmm, OK, this was why you had the different LibraryClasses?
> > I still don't think it should be a separate libraryclass per CPU. If
> > possible, I would prefer MonitorCoreInfoLib and ApplicationCoreInfoLib.
> >
> > > +  }
> > > +  for (; HartIdNumber < (FixedPcdGet32 (PcdNumberofU5Cores) +
> > (UINT32)MCSupport); HartIdNumber ++) {
> > > +    Status = CreateU54CoreProcessorSpecificDataHob (ParentCoreGuid,
> > > + UniqueId, HartIdNumber, (HartIdNumber == FixedPcdGet32
> > > + (PcdBootHartId))? TRUE: FALSE, &GuidHobData);
> >
> > Nesting that ternary saves you nothing other than typing, and not much
> > of that. Please use a temporary variable instead:
> >
> >    BOOL IsBootHart;
> >    IsBootHart = HartIdNumber == FixedPcdGet32 (PcdBootHartId)) ? TRUE :
> > FALSE
> >    /* Also, always spaces around ? and : for ternaries. */
> >    /* No, don't actually include this comment. */
> >    Status = CreateU54CoreProcessorSpecificDataHob (ParentCoreGuid,
> > UniqueId,
> >               HartIdNumber, IsBootHart, &GuidHobData);
> >
> > > +    if (EFI_ERROR (Status)) {
> > > +      DEBUG ((DEBUG_ERROR, "Faile to build U5MC processor
> > > + informatino
> > HOB\n"));
> > > +      ASSERT (FALSE);
> > > +    }
> > > +    DEBUG ((DEBUG_INFO, "Support U5 application core on U500
> > > + platform, HOB Data at address 0x%x\n", GuidHobData));  }  DEBUG
> > > + ((DEBUG_INFO, "Support %d U5 application cores on U500
> > > + platform\n", HartIdNumber - (UINT32)MCSupport));
> >
> > Please wrap those DEBUG lines. Not the strings, just the arguments.
> >
> > > +
> > > +  if (HartIdNumber != FixedPcdGet32 (PcdHartCount)) {
> > > +    DEBUG ((DEBUG_ERROR, "Improper core settings...\n"));
> > > +    DEBUG ((DEBUG_ERROR, "    PcdHartCount\n"));
> > > +    DEBUG ((DEBUG_ERROR, "    PcdNumberofU5Cores\n"));
> > > +    DEBUG ((DEBUG_ERROR, "    PcdE5MCSupported\n\n"));
> > > +    ASSERT (FALSE);
> > > +  }
> > > +  return Status;
> > > +}
> > > +
> > > +/**
> > > +  Function to build processor related SMBIOS information. RISC-V
> > > +SMBIOS DXE driver collect
> > > +  this information and build SMBIOS Type4 and Type7 record.
> > > +
> > > +  @param  ProcessorUid    Unique ID of pysical processor which owns this
> > core.
> > > +  @param  SmbiosHobPtr    Pointer to receive
> > RISC_V_PROCESSOR_SMBIOS_DATA_HOB. The pointers
> > > +                          maintained in this structure is only
> > > + valid before memory is
> > discovered.
> > > +                          Access to those pointers after memory is
> > > + installed will cause
> > unexpected issues.
> > > +
> > > +  @return EFI_SUCCESS     The PEIM initialized successfully.
> > > +
> > > +**/
> > > +EFI_STATUS
> > > +EFIAPI
> > > +CreateU5MCProcessorSmbiosDataHob (
> > > +  IN UINTN     ProcessorUid,
> > > +  OUT RISC_V_PROCESSOR_SMBIOS_DATA_HOB **SmbiosHobPtr
> > > +  )
> > > +{
> > > +  EFI_GUID *GuidPtr;
> > > +  RISC_V_PROCESSOR_TYPE4_DATA_HOB ProcessorDataHob;
> > > +  RISC_V_PROCESSOR_TYPE7_DATA_HOB L2CacheDataHob;
> > > +  RISC_V_PROCESSOR_SMBIOS_DATA_HOB SmbiosDataHob;
> > > +  RISC_V_PROCESSOR_TYPE4_DATA_HOB *ProcessorDataHobPtr;
> > > +  RISC_V_PROCESSOR_TYPE7_DATA_HOB *L2CacheDataHobPtr;
> > > +  RISC_V_PROCESSOR_SMBIOS_DATA_HOB *SmbiosDataHobPtr;
> > > +
> > > +  DEBUG ((DEBUG_INFO, "%a: Entry\n", __FUNCTION__));
> > > +
> > > +  if (SmbiosHobPtr == NULL) {
> > > +    return EFI_INVALID_PARAMETER;
> > > +  }
> > > +
> > > +  //
> > > +  // Build up SMBIOS type 7 L2 cache record.
> > > +  //
> > > +  ZeroMem((VOID *)&L2CacheDataHob, sizeof
> > > + (RISC_V_PROCESSOR_TYPE7_DATA_HOB));
> > > +  L2CacheDataHob.PrcessorGuid = *((EFI_GUID *)PcdGetPtr
> > > + (PcdSiFiveU5MCCoreplexGuid));  L2CacheDataHob.ProcessorUid =
> > > + ProcessorUid;  L2CacheDataHob.SmbiosType7Cache.SocketDesignation
> =
> > > + TO_BE_FILLED_BY_VENDOR;
> > L2CacheDataHob.SmbiosType7Cache.CacheConfiguration =
> > RISC_V_CACHE_CONFIGURATION_CACHE_LEVEL_2 | \
> > > +      RISC_V_CACHE_CONFIGURATION_LOCATION_EXTERNAL | \
> > > +      RISC_V_CACHE_CONFIGURATION_ENABLED | \
> > > +      RISC_V_CACHE_CONFIGURATION_MODE_UNKNOWN;
> > > +  L2CacheDataHob.SmbiosType7Cache.MaximumCacheSize =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > + L2CacheDataHob.SmbiosType7Cache.InstalledSize =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > + L2CacheDataHob.SmbiosType7Cache.SupportedSRAMType.Unknown =
> 1;
> > > + L2CacheDataHob.SmbiosType7Cache.CurrentSRAMType.Unknown = 1;
> > > + L2CacheDataHob.SmbiosType7Cache.CacheSpeed =
> > TO_BE_FILLED_BY_VENDOR;
> > > + L2CacheDataHob.SmbiosType7Cache.ErrorCorrectionType =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > + L2CacheDataHob.SmbiosType7Cache.SystemCacheType =
> > CacheTypeUnified;
> > > + L2CacheDataHob.SmbiosType7Cache.Associativity =
> > > + TO_BE_FILLED_BY_VENDOR;  GuidPtr = (EFI_GUID *)PcdGetPtr
> > > + (PcdProcessorSmbiosType7GuidHobGuid);
> > > +  L2CacheDataHobPtr = (RISC_V_PROCESSOR_TYPE7_DATA_HOB
> > > + *)BuildGuidDataHob (GuidPtr, (VOID *)&L2CacheDataHob, sizeof
> > > + (RISC_V_PROCESSOR_TYPE7_DATA_HOB));
> >
> > Please wrap long line.
> >
> > > +  if (L2CacheDataHobPtr == NULL) {
> > > +    DEBUG ((DEBUG_ERROR, "Fail to create GUID HOB of SiFive U5 MC
> > > + Coreplex L2 cache RISC_V_PROCESSOR_TYPE7_DATA_HOB.\n"));
> >
> > Please wrap long line. (That format string is longer than 80
> > characters on its own, consider shortening it.)
> >
> > > +    ASSERT (FALSE);
> > > +  }
> > > +
> > > +  //
> > > +  // Build up SMBIOS type 4 record.
> > > +  //
> > > +  ZeroMem((VOID *)&ProcessorDataHob, sizeof
> > > + (RISC_V_PROCESSOR_TYPE4_DATA_HOB));
> > > +  ProcessorDataHob.PrcessorGuid = *((EFI_GUID *)PcdGetPtr
> > > + (PcdSiFiveU5MCCoreplexGuid));  ProcessorDataHob.ProcessorUid =
> > > + ProcessorUid;  ProcessorDataHob.SmbiosType4Processor.Socket =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > + ProcessorDataHob.SmbiosType4Processor.ProcessorType =
> > > + CentralProcessor;
> > > + ProcessorDataHob.SmbiosType4Processor.ProcessorFamily =
> > > + ProcessorFamilyIndicatorFamily2;
> > > + ProcessorDataHob.SmbiosType4Processor.ProcessorManufacture =
> > > + TO_BE_FILLED_BY_VENDOR;  SetMem ((VOID
> > > + *)&ProcessorDataHob.SmbiosType4Processor.ProcessorId, sizeof
> > > + (PROCESSOR_ID_DATA), TO_BE_FILLED_BY_CODE);
> >
> > Please wrap long line.
> >
> > > +  ProcessorDataHob.SmbiosType4Processor.ProcessorVersion =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > +
> >
> ProcessorDataHob.SmbiosType4Processor.Voltage.ProcessorVoltageCapabi
> > > + lity3_3V = 1;  ProcessorDataHob.SmbiosType4Processor.ExternalClock
> > > + = TO_BE_FILLED_BY_VENDOR;
> > > + ProcessorDataHob.SmbiosType4Processor.MaxSpeed =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > + ProcessorDataHob.SmbiosType4Processor.CurrentSpeed =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > + ProcessorDataHob.SmbiosType4Processor.Status =
> > TO_BE_FILLED_BY_CODE;
> > > + ProcessorDataHob.SmbiosType4Processor.ProcessorUpgrade =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > + ProcessorDataHob.SmbiosType4Processor.L1CacheHandle =
> > > + TO_BE_FILLED_BY_RISC_V_SMBIOS_DXE_DRIVER;
> > > +  ProcessorDataHob.SmbiosType4Processor.L2CacheHandle =
> > > + TO_BE_FILLED_BY_RISC_V_SMBIOS_DXE_DRIVER;
> > > +  ProcessorDataHob.SmbiosType4Processor.L3CacheHandle = 0xffff;
> > > + ProcessorDataHob.SmbiosType4Processor.SerialNumber =
> > > + TO_BE_FILLED_BY_CODE;
> > > + ProcessorDataHob.SmbiosType4Processor.AssetTag =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > + ProcessorDataHob.SmbiosType4Processor.PartNumber =
> > > + TO_BE_FILLED_BY_VENDOR;
> > > + ProcessorDataHob.SmbiosType4Processor.CoreCount =
> > > + (UINT8)FixedPcdGet32 (PcdNumberofU5Cores) + (UINT8)PcdGetBool
> > > + (PcdE5MCSupported);
> > > + ProcessorDataHob.SmbiosType4Processor.EnabledCoreCount =
> > > + (UINT8)FixedPcdGet32 (PcdNumberofU5Cores) + (UINT8)PcdGetBool
> > > + (PcdE5MCSupported);
> > > + ProcessorDataHob.SmbiosType4Processor.ThreadCount =
> > > + (UINT8)FixedPcdGet32 (PcdNumberofU5Cores) + (UINT8)PcdGetBool
> > > + (PcdE5MCSupported);
> >
> > Please wrap long lines.
> > There are several more cases in this file, I'll stop pointing them
> > out, but the general rule is no longer than 80. PatchCheck.py is a bit lax on
> this.
> >
> > > +  ProcessorDataHob.SmbiosType4Processor.ProcessorCharacteristics =
> > > + (UINT16)(1 << 2); // 64-bit capable
> > > +  ProcessorDataHob.SmbiosType4Processor.ProcessorFamily2 =
> > > + ProcessorFamilyRiscVRV64;
> > > +  ProcessorDataHob.SmbiosType4Processor.CoreCount2 = 0;
> > > +  ProcessorDataHob.SmbiosType4Processor.EnabledCoreCount2 = 0;
> > > +  ProcessorDataHob.SmbiosType4Processor.ThreadCount2 = 0;  GuidPtr
> > > + = (EFI_GUID *)PcdGetPtr (PcdProcessorSmbiosType4GuidHobGuid);
> > > +  ProcessorDataHobPtr = (RISC_V_PROCESSOR_TYPE4_DATA_HOB
> > > + *)BuildGuidDataHob (GuidPtr, (VOID *)&ProcessorDataHob, sizeof
> > > + (RISC_V_PROCESSOR_TYPE4_DATA_HOB));
> > > +  if (ProcessorDataHobPtr == NULL) {
> > > +    DEBUG ((DEBUG_ERROR, "Fail to create GUID HOB of SiFive U5MC
> > Coreplex RISC_V_PROCESSOR_TYPE4_DATA_HOB.\n"));
> > > +    ASSERT (FALSE);
> > > +  }
> > > +
> > > +  ZeroMem((VOID *)&SmbiosDataHob, sizeof
> > > +(RISC_V_PROCESSOR_SMBIOS_DATA_HOB));
> > > +  SmbiosDataHob.Processor = ProcessorDataHobPtr;
> > > +  SmbiosDataHob.L1InstCache = NULL;
> > > +  SmbiosDataHob.L1DataCache = NULL;
> > > +  SmbiosDataHob.L2Cache = L2CacheDataHobPtr;
> > > +  SmbiosDataHob.L3Cache = NULL;
> > > +  GuidPtr = (EFI_GUID *)PcdGetPtr (PcdProcessorSmbiosGuidHobGuid);
> > > +  SmbiosDataHobPtr = (RISC_V_PROCESSOR_SMBIOS_DATA_HOB
> > > +*)BuildGuidDataHob (GuidPtr, (VOID *)&SmbiosDataHob, sizeof
> > > +(RISC_V_PROCESSOR_SMBIOS_DATA_HOB));
> > > +  if (SmbiosDataHobPtr == NULL) {
> > > +    DEBUG ((DEBUG_ERROR, "Fail to create GUID HOB of SiFive U5MC
> > Coreplex RISC_V_PROCESSOR_SMBIOS_DATA_HOB.\n"));
> > > +    ASSERT (FALSE);
> > > +  }
> > > +  *SmbiosHobPtr = SmbiosDataHobPtr;
> > > +  DEBUG ((DEBUG_INFO, "%a: Exit\n", __FUNCTION__));
> > > +  return EFI_SUCCESS;
> > > +}
> > > diff --git
> > >
> >
> a/Platform/RiscV/SiFive/U500Pkg/Library/PeiCoreInfoHobLib/PeiCoreInfoH
> > > obLib.inf
> > >
> >
> b/Platform/RiscV/SiFive/U500Pkg/Library/PeiCoreInfoHobLib/PeiCoreInfoH
> > > obLib.inf
> > > new file mode 100644
> > > index 00000000..915021f9
> > > --- /dev/null
> > > +++ b/Platform/RiscV/SiFive/U500Pkg/Library/PeiCoreInfoHobLib/PeiCor
> > > +++ eI
> > > +++ nfoHobLib.inf
> > > @@ -0,0 +1,58 @@
> > > +## @file
> > > +#  Library instance to create core information HOB # #  Copyright
> > > +(c) 2019, Hewlett Packard Enterprise Development LP. All rights
> > > +reserved.<BR> # #  SPDX-License-Identifier: BSD-2-Clause-Patent #
> > > +##
> > > +
> > > +[Defines]
> > > +  INF_VERSION                    = 0x00010005
> >
> > Please bump specification version.
> >
> > > +  BASE_NAME                      = SiliconSiFiveU5MCCoreplexInfoLib
> > > +  FILE_GUID                      = 4E397A71-5164-4E69-9884-70CBE2740AAB
> > > +  MODULE_TYPE                    = PEIM
> > > +  VERSION_STRING                 = 1.0
> > > +  LIBRARY_CLASS                  = SiliconSiFiveU5MCCoreplexInfoLib
> > > +
> > > +#
> > > +# The following information is for reference only and not required
> > > +by the
> > build tools.
> > > +#
> > > +#  VALID_ARCHITECTURES           = RISCV
> > > +#
> > > +
> > > +[Sources]
> > > + CoreInfoHob.c
> > > +
> > > +[Packages]
> > > +  MdePkg/MdePkg.dec
> > > +  MdeModulePkg/MdeModulePkg.dec
> > > +  Platform/RiscV/RiscVPlatformPkg.dec
> > > +  Platform/RiscV/SiFive/U500Pkg/U500.dec
> > > +  Silicon/SiFive/SiFive.dec
> > > +  RiscVPkg/RiscVPkg.dec
> >
> > Please sort alphabetically.
> >
> > > +
> > > +[LibraryClasses]
> > > +  BaseLib
> > > +  PcdLib
> > > +  MemoryAllocationLib
> > > +  PrintLib
> > > +  SiliconSiFiveE51CoreInfoLib
> > > +  SiliconSiFiveU54CoreInfoLib
> >
> > Please sort alphabetically.
> >
> > > +
> > > +[Guids]
> > > +  gUefiRiscVPlatformU500PkgTokenSpaceGuid
> >
> > I'm reasonably sure you don't need to declare the TokenSpaceGuid in
> > order to access the Pcds.
> >
> > > +
> > > +[Ppis]
> > > +
> > > +[FixedPcd]
> > > +  gUefiRiscVPkgTokenSpaceGuid.PcdProcessorSmbiosGuidHobGuid
> > > +
> gUefiRiscVPkgTokenSpaceGuid.PcdProcessorSmbiosType4GuidHobGuid
> > > +
> gUefiRiscVPkgTokenSpaceGuid.PcdProcessorSmbiosType7GuidHobGuid
> > > +  gEfiSiFiveSiliconSpaceGuid.PcdSiFiveU54CoreGuid
> > > +  gEfiSiFiveSiliconSpaceGuid.PcdSiFiveE51CoreGuid
> > > +  gEfiSiFiveSiliconSpaceGuid.PcdSiFiveU5MCCoreplexGuid
> > > +  gUefiRiscVPlatformU500PkgTokenSpaceGuid.PcdNumberofU5Cores
> > > +  gUefiRiscVPlatformU500PkgTokenSpaceGuid.PcdE5MCSupported
> > > +  gUefiRiscVPlatformPkgTokenSpaceGuid.PcdHartCount
> > > +  gUefiRiscVPlatformPkgTokenSpaceGuid.PcdBootHartId
> >
> > Please sort alphabetically.
> >
> > > diff --git
> > > a/Platform/RiscV/SiFive/U500Pkg/Library/RiscVPlatformTimerLib/RiscVP
> > > la
> > > tformTimerLib.S
> > > b/Platform/RiscV/SiFive/U500Pkg/Library/RiscVPlatformTimerLib/RiscVP
> > > la
> > > tformTimerLib.S
> > > new file mode 100644
> > > index 00000000..bb4aafb9
> > > --- /dev/null
> > > +++ b/Platform/RiscV/SiFive/U500Pkg/Library/RiscVPlatformTimerLib/Ri
> > > +++ sc
> > > +++ VPlatformTimerLib.S
> > > @@ -0,0 +1,48 @@
> > > +//-----------------------------------------------------------------
> > > +--
> > > +-----------
> > > +//
> > > +// SiFive U500 Timer CSR functions.
> > > +//
> > > +// Copyright (c) 2019, Hewlett Packard Enterprise Development LP.
> > > +All rights reserved.<BR> // // SPDX-License-Identifier:
> > > +BSD-2-Clause-Patent //
> > > +//-----------------------------------------------------------------
> > > +--
> > > +-----------
> > > +#include <Base.h>
> > > +#include <RiscV.h>
> > > +#include <U500Clint.h>
> > > +
> > > +.data
> > > +
> > > +.text
> > > +.align 3
> > > +
> > > +.global ASM_PFX(RiscVReadMachineTimer) .global
> > > +ASM_PFX(RiscVSetMachineTimerCmp) .global
> > > +ASM_PFX(RiscVReadMachineTimerCmp)
> > > +
> > > +//
> > > +// Read machine timer CSR.
> > > +// @retval a0 : 64-bit machine timer.
> > > +//
> > > +ASM_PFX (RiscVReadMachineTimer):
> > > +    li t1, CLINT_REG_MTIME
> > > +    ld a0, (t1)
> > > +    ret
> > > +
> > > +//
> > > +// Set machine timer compare CSR.
> > > +// @param a0 : UINT64
> > > +//
> > > +ASM_PFX (RiscVSetMachineTimerCmp):
> > > +    li t1, CLINT_REG_MTIMECMP0
> > > +    sd a0, (t1)
> > > +    ret
> > > +
> > > +//
> > > +// Read machine timer compare CSR.
> > > +// @param a0 : UINT64
> > > +//
> > > +ASM_PFX (RiscVReadMachineTimerCmp):
> > > +    li t1, CLINT_REG_MTIMECMP0
> > > +    ld a0, (t1)
> > > +    ret
> > > diff --git
> > > a/Platform/RiscV/SiFive/U500Pkg/Library/RiscVPlatformTimerLib/RiscVP
> > > la
> > > tformTimerLib.inf
> > > b/Platform/RiscV/SiFive/U500Pkg/Library/RiscVPlatformTimerLib/RiscVP
> > > la
> > > tformTimerLib.inf
> > > new file mode 100644
> > > index 00000000..62771b68
> > > --- /dev/null
> > > +++ b/Platform/RiscV/SiFive/U500Pkg/Library/RiscVPlatformTimerLib/Ri
> > > +++ sc
> > > +++ VPlatformTimerLib.inf
> > > @@ -0,0 +1,39 @@
> > > +## @file
> > > +# RISC-V CPU lib to override timer mechanism for U500 platform.
> > > +#
> > > +# Copyright (c) 2019, Hewlett Packard Enterprise Development LP.
> > > +All rights reserved.<BR> # Copyright (c) 2007 - 2010, Intel Corporation.
> > > +All rights reserved.<BR> # # SPDX-License-Identifier:
> > > +BSD-2-Clause-Patent # ##
> > > +
> > > +[Defines]
> > > +  INF_VERSION                    = 0x00010005
> >
> > Please bump specification version.
> >
> > > +  BASE_NAME                      = RiscVPlatformTimerLib
> > > +  FILE_GUID                      = AFA75BBD-DE9D-4E77-BD88-1EA401BE931D
> > > +  MODULE_TYPE                    = BASE
> > > +  VERSION_STRING                 = 1.0
> > > +  LIBRARY_CLASS                  = RiscVPlatformTimerLib
> > > +
> > > +#
> > > +# The following information is for reference only and not required
> > > +by the
> > build tools.
> > > +#
> > > +#  VALID_ARCHITECTURES           = RISCV32 RISCV64
> > > +#
> > > +
> > > +[Sources]
> > > +
> > > +[Sources.RISCV32]
> > > +  RiscVPlatformTimerLib.s
> > > +
> >
> > Please drop RISCV32 for now.
> >
> > > +[Sources.RISCV64]
> > > +  RiscVPlatformTimerLib.s
> > > +
> > > +[Packages]
> > > +  MdePkg/MdePkg.dec
> > > +  MdeModulePkg/MdeModulePkg.dec
> > > +  RiscVPkg/RiscVPkg.dec
> > > +  Platform/RiscV/SiFive/U500Pkg/U500.dec
> >
> > Please sort alphabetically.
> >
> > > +
> > > +
> > > diff --git
> > > a/Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/SerialIoLib.inf
> > > b/Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/SerialIoLib.inf
> > > new file mode 100644
> > > index 00000000..85af1fbd
> > > --- /dev/null
> > > +++ b/Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/SerialIoLib.
> > > +++ in
> > > +++ f
> > > @@ -0,0 +1,31 @@
> > > +## @file
> > > +#   Library instance for SerialIo library class
> > > +#
> > > +#  Copyright (c) 2019, Hewlett Packard Enterprise Development LP.
> > > +All rights reserved.<BR> #  Copyright (c) 2006 - 2014, Intel Corporation.
> > > +All rights reserved.<BR> # #  SPDX-License-Identifier:
> > > +BSD-2-Clause-Patent # ##
> > > +
> > > +[Defines]
> > > +  INF_VERSION                    = 0x00010005
> >
> > Please bump specification version.
> >
> > > +  BASE_NAME                      = U500SerialPortLib
> > > +  MODULE_UNI_FILE                = U500SerialPortLib.uni
> > > +  FILE_GUID                      = FCC4FD2B-2FF6-4FFA-B363-7C1111E5DCE9
> > > +  MODULE_TYPE                    = BASE
> > > +  VERSION_STRING                 = 1.0
> > > +  LIBRARY_CLASS                  = SerialPortLib
> > > +
> > > +[Packages]
> > > +  MdePkg/MdePkg.dec
> > > +  RiscVPkg/RiscVPkg.dec
> > > +  Platform/RiscV/RiscVPlatformPkg.dec
> >
> > Please sort alphabetically.
> >
> > > +
> > > +[LibraryClasses]
> > > +  BaseLib
> > > +  IoLib
> > > +  RiscVOpensbiLib
> > > +
> > > +[Sources]
> > > +  SerialPortLib.c
> > > diff --git
> > > a/Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/SerialPortLib.c
> > > b/Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/SerialPortLib.c
> > > new file mode 100644
> > > index 00000000..e51bf9c1
> > > --- /dev/null
> > > +++ b/Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/SerialPortLib.
> > > +++ c
> > > @@ -0,0 +1,241 @@
> > > +/** @file
> > > +  UART Serial Port library functions
> > > +
> > > +  Copyright (c) 2019, Hewlett Packard Enterprise Development LP.
> > > + All rights reserved.<BR>  Copyright (c) 2006 - 2016, Intel Corporation.
> > > + All rights reserved.<BR>
> > > +
> > > +  SPDX-License-Identifier: BSD-2-Clause-Patent
> > > +
> > > +**/
> > > +
> > > +#include <Base.h>
> > > +#include <Library/IoLib.h>
> > > +#include <Library/SerialPortLib.h>
> > > +#include <sbi_utils/serial/sifive-uart.h>
> > > +
> > > +#define REG32(p, i) ((p)[(i) >> 2])
> >
> > Please use the IoLib functions instead.
> >
> > > +
> > > +//---------------------------------------------
> > > +// UART Register Offsets
> > > +//---------------------------------------------
> > > +
> > > +#define UART_REG_IP     0x14
> > > +  #define UART_IP_RXWM 0x02
> >
> > Please drop indentation at start of line.
> >
> > > +
> > > +//---------------------------------------------
> > > +// UART Settings
> > > +//---------------------------------------------
> > > +
> > > +#define U500_UART_ADDR      0x54000000
> > > +#define U500_UART_BAUDRATE  115200
> > > +#define U500_SYS_CLK        100000000
> > > +
> > > +/**
> > > +  Initialize the serial device hardware.
> > > +
> > > +  If no initialization is required, then return RETURN_SUCCESS.
> > > +  If the serial device was successfuly initialized, then return
> > RETURN_SUCCESS.
> > > +  If the serial device could not be initialized, then return
> > RETURN_DEVICE_ERROR.
> > > +
> > > +  @retval RETURN_SUCCESS        The serial device was initialized.
> > > +  @retval RETURN_DEVICE_ERROR   The serail device could not be
> > initialized.
> > > +
> > > +**/
> > > +RETURN_STATUS
> > > +EFIAPI
> > > +SerialPortInitialize (
> > > +  VOID
> > > +  )
> > > +{
> > > +  if (sifive_uart_init (U500_UART_ADDR, U500_SYS_CLK/2,
> > U500_UART_BAUDRATE) != 0) {
> > > +      return EFI_DEVICE_ERROR;
> >
> > Indentation is only 2 spaces.
> >
> > > +  }
> > > +  return RETURN_SUCCESS;
> > > +}
> > > +
> > > +/**
> > > +  Write data from buffer to serial device.
> > > +
> > > +  Writes NumberOfBytes data bytes from Buffer to the serial device.
> > > +  The number of bytes actually written to the serial device is returned.
> > > +  If the return value is less than NumberOfBytes, then the write
> > > + operation
> > failed.
> > > +
> > > +  If Buffer is NULL, then ASSERT().
> > > +
> > > +  If NumberOfBytes is zero, then return 0.
> > > +
> > > +  @param  Buffer           Pointer to the data buffer to be written.
> > > +  @param  NumberOfBytes    Number of bytes to written to the serial
> > device.
> > > +
> > > +  @retval 0                NumberOfBytes is 0.
> > > +  @retval >0               The number of bytes written to the serial device.
> > > +                           If this value is less than
> > > + NumberOfBytes, then the write
> > operation failed.
> > > +
> > > +**/
> > > +UINTN
> > > +EFIAPI
> > > +SerialPortWrite (
> > > +  IN UINT8     *Buffer,
> > > +  IN UINTN     NumberOfBytes
> > > +  )
> > > +{
> > > +  UINTN i;
> >
> > I
> >
> > > +
> > > +  if (Buffer == NULL) {
> > > +    return 0;
> > > +  }
> > > +
> > > +  for(i=0; i < NumberOfBytes; i++) {
> >
> >      for (I = 0; I < NumberOfBytes; I++) {
> >
> > > +    sifive_uart_putc (Buffer[i]);
> > > +  }
> > > +
> > > +  return i;
> > > +}
> > > +
> > > +
> > > +/**
> > > +  Reads data from a serial device into a buffer.
> > > +
> > > +  @param  Buffer           Pointer to the data buffer to store the data read
> > from the serial device.
> > > +  @param  NumberOfBytes    Number of bytes to read from the serial
> > device.
> > > +
> > > +  @retval 0                NumberOfBytes is 0.
> > > +  @retval >0               The number of bytes read from the serial device.
> > > +                           If this value is less than
> > > + NumberOfBytes, then the read
> > operation failed.
> > > +
> > > +**/
> > > +UINTN
> > > +EFIAPI
> > > +SerialPortRead (
> > > +  OUT UINT8     *Buffer,
> > > +  IN  UINTN     NumberOfBytes
> > > +  )
> > > +{
> > > +  UINTN i;
> >
> > I
> >
> > > +
> > > +  if (NULL == Buffer) {
> > > +    return 0;
> > > +  }
> > > +
> > > +  for(i=0; i < NumberOfBytes; i++) {
> >
> >      for (I = 0; I < NumberOfBytes; I++) {
> >
> > > +    Buffer[i] = (UINT8)sifive_uart_getc ();  }
> > > +
> > > +  return i;
> > > +}
> > > +
> > > +/**
> > > +  Polls a serial device to see if there is any data waiting to be read.
> > > +
> > > +  Polls aserial device to see if there is any data waiting to be read.
> > > +  If there is data waiting to be read from the serial device, then
> > > + TRUE is
> > returned.
> > > +  If there is no data waiting to be read from the serial device,
> > > + then FALSE is
> > returned.
> > > +
> > > +  @retval TRUE             Data is waiting to be read from the serial device.
> > > +  @retval FALSE            There is no data waiting to be read from the serial
> > device.
> > > +
> > > +**/
> > > +BOOLEAN
> > > +EFIAPI
> > > +SerialPortPoll (
> > > +  VOID
> > > +  )
> > > +{
> > > +  static volatile UINT32 * const uart = (void *)(U500_UART_ADDR);
> >
> > Please use IoLib functions instead.
> >
> > > +  UINT32 ip;
> >
> > IP
> >
> > > +
> > > +  ip = REG32(uart, UART_REG_IP);
> > > +  if(ip & UART_IP_RXWM) {
> >
> > Space before (
> >
> > > +    return TRUE;
> > > +  }
> > > +  else {
> >
> > } else {
> >
> > /
> >     Leif
> >
> > > +    return FALSE;
> > > +  }
> > > +}
> > > +
> > > +/**
> > > +  Sets the control bits on a serial device.
> > > +
> > > +  @param Control                Sets the bits of Control that are settable.
> > > +
> > > +  @retval RETURN_SUCCESS        The new control bits were set on the
> > serial device.
> > > +  @retval RETURN_UNSUPPORTED    The serial device does not support
> > this operation.
> > > +  @retval RETURN_DEVICE_ERROR   The serial device is not functioning
> > correctly.
> > > +
> > > +**/
> > > +RETURN_STATUS
> > > +EFIAPI
> > > +SerialPortSetControl (
> > > +  IN UINT32 Control
> > > +  )
> > > +{
> > > +
> > > +  return RETURN_SUCCESS;
> > > +}
> > > +
> > > +/**
> > > +  Retrieve the status of the control bits on a serial device.
> > > +
> > > +  @param Control                A pointer to return the current control signals
> > from the serial device.
> > > +
> > > +  @retval RETURN_SUCCESS        The control bits were read from the
> serial
> > device.
> > > +  @retval RETURN_UNSUPPORTED    The serial device does not support
> > this operation.
> > > +  @retval RETURN_DEVICE_ERROR   The serial device is not functioning
> > correctly.
> > > +
> > > +**/
> > > +RETURN_STATUS
> > > +EFIAPI
> > > +SerialPortGetControl (
> > > +  OUT UINT32 *Control
> > > +  )
> > > +{
> > > +  *Control = 0;
> > > +  return RETURN_SUCCESS;
> > > +}
> > > +
> > > +/**
> > > +  Sets the baud rate, receive FIFO depth, transmit/receice time
> > > +out, parity,
> > > +  data bits, and stop bits on a serial device.
> > > +
> > > +  @param BaudRate           The requested baud rate. A BaudRate value of
> 0
> > will use the
> > > +                            device's default interface speed.
> > > +                            On output, the value actually set.
> > > +  @param ReveiveFifoDepth   The requested depth of the FIFO on the
> > receive side of the
> > > +                            serial interface. A ReceiveFifoDepth value of 0 will use
> > > +                            the device's default FIFO depth.
> > > +                            On output, the value actually set.
> > > +  @param Timeout            The requested time out for a single character in
> > microseconds.
> > > +                            This timeout applies to both the
> > > + transmit and receive side of
> > the
> > > +                            interface. A Timeout value of 0 will
> > > + use the device's default
> > time
> > > +                            out value.
> > > +                            On output, the value actually set.
> > > +  @param Parity             The type of parity to use on this serial device. A
> > Parity value of
> > > +                            DefaultParity will use the device's default parity value.
> > > +                            On output, the value actually set.
> > > +  @param DataBits           The number of data bits to use on the serial
> > device. A DataBits
> > > +                            vaule of 0 will use the device's default data bit setting.
> > > +                            On output, the value actually set.
> > > +  @param StopBits           The number of stop bits to use on this serial
> > device. A StopBits
> > > +                            value of DefaultStopBits will use the
> > > + device's default
> > number of
> > > +                            stop bits.
> > > +                            On output, the value actually set.
> > > +
> > > +  @retval RETURN_SUCCESS            The new attributes were set on the
> > serial device.
> > > +  @retval RETURN_UNSUPPORTED        The serial device does not
> support
> > this operation.
> > > +  @retval RETURN_INVALID_PARAMETER  One or more of the attributes
> > has an unsupported value.
> > > +  @retval RETURN_DEVICE_ERROR       The serial device is not functioning
> > correctly.
> > > +
> > > +**/
> > > +RETURN_STATUS
> > > +EFIAPI
> > > +SerialPortSetAttributes (
> > > +  IN OUT UINT64             *BaudRate,
> > > +  IN OUT UINT32             *ReceiveFifoDepth,
> > > +  IN OUT UINT32             *Timeout,
> > > +  IN OUT EFI_PARITY_TYPE    *Parity,
> > > +  IN OUT UINT8              *DataBits,
> > > +  IN OUT EFI_STOP_BITS_TYPE *StopBits
> > > +  )
> > > +{
> > > +  return RETURN_SUCCESS;
> > > +}
> > > diff --git
> > > a/Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/U500SerialPortLib.
> > > uni
> > > b/Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/U500SerialPortLib.
> > > uni
> > > new file mode 100644
> > > index 00000000..49163bd8
> > > --- /dev/null
> > > +++ b/Platform/RiscV/SiFive/U500Pkg/Library/SerialIoLib/U500SerialPo
> > > +++ rt
> > > +++ Lib.uni
> > > @@ -0,0 +1,16 @@
> > > +// /** @file
> > > +// Library instance for SerialIo library class // // Library
> > > +instance for SerialIO library class.
> > > +//
> > > +// Copyright (c) 2006 - 2014, Intel Corporation. All rights
> > > +reserved.<BR> // // SPDX-License-Identifier: BSD-2-Clause-Patent //
> > > +// **/
> > > +
> > > +
> > > +#string STR_MODULE_ABSTRACT             #language en-US "Library
> instance
> > for SerialIO library class"
> > > +
> > > +#string STR_MODULE_DESCRIPTION          #language en-US "Library
> > instance for SerialIO library class."
> > > +
> > > --
> > > 2.12.0.windows.1
> > >
> > >
> > >
> > >
> >
> >