Re: [PATCH 1/2] BoardModulePkg: Add SerialPortTerminalLib

["Heng Luo" <heng.luo@intel.com>]

Hi Eric,
Chaganty, Rangasai V <rangasai.v.chaganty@intel.com> suggest to move it to Features\Intel\Debugging, do you agree?

Thanks,
heng

> -----Original Message-----
> From: Dong, Eric <eric.dong@intel.com>
> Sent: Thursday, October 22, 2020 9:23 AM
> To: Luo, Heng <heng.luo@intel.com>; devel@edk2.groups.io
> Cc: Chiu, Chasel <chasel.chiu@intel.com>; Desimone, Nathaniel L
> <nathaniel.l.desimone@intel.com>
> Subject: RE: [PATCH 1/2] BoardModulePkg: Add SerialPortTerminalLib
> 
> Hi Heng,
> 
> Seems like it is a common feature not related to board scope, I think
> Features folder is a better place to hold it.
> 
> Thanks,
> Eric
> 
> -----Original Message-----
> From: Luo, Heng <heng.luo@intel.com>
> Sent: Tuesday, October 20, 2020 10:22 AM
> To: devel@edk2.groups.io
> Cc: Dong, Eric <eric.dong@intel.com>; Chiu, Chasel <chasel.chiu@intel.com>;
> Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>
> Subject: [PATCH 1/2] BoardModulePkg: Add SerialPortTerminalLib
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3014
> 
> Add the serial port terminal library to get console redirect after the shell is
> loaded.
> 
> Cc: Eric Dong <eric.dong@intel.com>
> Cc: Chasel Chiu <chasel.chiu@intel.com>
> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
> 
> Signed-off-by: Heng Luo <heng.luo@intel.com>
> ---
> 
> Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/SerialPortTer
> minalLib.c   | 93
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> +++++++++++++++++++++++++++++
> 
> Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/SerialPortTer
> minalLib.h   | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
> 
> Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/SerialPortTer
> minalLib.inf | 35 +++++++++++++++++++++++++++++++++++
>  3 files changed, 177 insertions(+)
> 
> diff --git
> a/Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/SerialPortT
> erminalLib.c
> b/Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/SerialPortT
> erminalLib.c
> new file mode 100644
> index 0000000000..36c0e7110f
> --- /dev/null
> +++ b/Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/Serial
> +++ PortTerminalLib.c
> @@ -0,0 +1,93 @@
> +/** @file
> 
> +  Main file for NULL named library for Serial Port Deviceboard controller
> librarr.
> 
> +
> 
> +  INTEL CONFIDENTIAL
> 
> +  Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
> 
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> +
> 
> +**/
> 
> +
> 
> +#include "SerialPortTerminalLib.h"
> 
> +
> 
> +GLOBAL_REMOVE_IF_UNREFERENCED SERIAL_DEVICE_PATH
> mSerialDevicePath = {
> 
> +  {
> 
> +    {
> 
> +      HARDWARE_DEVICE_PATH,
> 
> +      HW_VENDOR_DP,
> 
> +      {
> 
> +        (UINT8) sizeof (VENDOR_DEVICE_PATH),
> 
> +        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
> 
> +      }
> 
> +    },
> 
> +    EDKII_SERIAL_PORT_LIB_VENDOR_GUID
> 
> +  },
> 
> +  {
> 
> +    {
> 
> +      MESSAGING_DEVICE_PATH,
> 
> +      MSG_UART_DP,
> 
> +      {
> 
> +        (UINT8) sizeof (UART_DEVICE_PATH),
> 
> +        (UINT8) ((sizeof (UART_DEVICE_PATH)) >> 8)
> 
> +      }
> 
> +    },
> 
> +    0,                  // Reserved
> 
> +    115200,             // BaudRate
> 
> +    8,                  // DataBits
> 
> +    1,                  // Parity
> 
> +    1                   // StopBits
> 
> +  },
> 
> +  {
> 
> +    {
> 
> +      MESSAGING_DEVICE_PATH,
> 
> +      MSG_VENDOR_DP,
> 
> +      {
> 
> +        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
> 
> +        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8),
> 
> +      }
> 
> +    },
> 
> +    DEVICE_PATH_MESSAGING_PC_ANSI
> 
> +  },
> 
> +  gEndEntire
> 
> +};
> 
> +
> 
> +/**
> 
> +  Updates the ConOut, ConIn, ErrOut variables with the serial terminal
> + device path
> 
> +  @param                        none
> 
> +  @retval                       none
> 
> +**/
> 
> +VOID
> 
> +AddSerialTerminal (
> 
> +  VOID
> 
> +  )
> 
> +{
> 
> +  DEBUG ((DEBUG_INFO, "[AddSerialPortTerminal]\n"));
> 
> +
> 
> +  //
> 
> +  // Append Serial Terminal into "ConIn"
> 
> +  //
> 
> +  EfiBootManagerUpdateConsoleVariable (ConOut,
> + (EFI_DEVICE_PATH_PROTOCOL *) &mSerialDevicePath, NULL);
> 
> +  EfiBootManagerUpdateConsoleVariable (ConIn,
> (EFI_DEVICE_PATH_PROTOCOL
> + *) &mSerialDevicePath, NULL);
> 
> +  EfiBootManagerUpdateConsoleVariable (ErrOut,
> + (EFI_DEVICE_PATH_PROTOCOL *) &mSerialDevicePath, NULL);
> 
> +}
> 
> +
> 
> +
> 
> +/**
> 
> +  Constructor for the Serial Port Device controller library.
> 
> +
> 
> +  @param ImageHandle    the image handle of the process
> 
> +  @param SystemTable    the EFI System Table pointer
> 
> +
> 
> +  @retval EFI_SUCCESS        the shell command handlers were installed
> sucessfully
> 
> +  @retval EFI_UNSUPPORTED    the shell level required was not found.
> 
> +**/
> 
> +EFI_STATUS
> 
> +EFIAPI
> 
> +SerialPortTerminalLibConstructor (
> 
> +  IN EFI_HANDLE        ImageHandle,
> 
> +  IN EFI_SYSTEM_TABLE  *SystemTable
> 
> +  )
> 
> +{
> 
> +  AddSerialTerminal();
> 
> +
> 
> +  return EFI_SUCCESS;
> 
> +}
> 
> diff --git
> a/Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/SerialPortT
> erminalLib.h
> b/Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/SerialPortT
> erminalLib.h
> new file mode 100644
> index 0000000000..afb3eb2cb3
> --- /dev/null
> +++ b/Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/Serial
> +++ PortTerminalLib.h
> @@ -0,0 +1,49 @@
> +/** @file
> 
> +  Header file for NULL named library for Ps2 keyboard controller library.
> 
> +
> 
> +  INTEL CONFIDENTIAL
> 
> +  Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
> 
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> +
> 
> +**/
> 
> +
> 
> +#ifndef _PS2_KBC_LIB_H
> 
> +#define _PS2_KBC_LIB_H
> 
> +
> 
> +#include <Uefi.h>
> 
> +#include <Guid/SerialPortLibVendor.h>
> 
> +#include <Library/UefiLib.h>
> 
> +#include <Library/DevicePathLib.h>
> 
> +#include <Library/DebugLib.h>
> 
> +#include <Library/UefiBootManagerLib.h>
> 
> +
> 
> +//
> 
> +// Below is the platform console device path
> 
> +//
> 
> +typedef struct {
> 
> +  VENDOR_DEVICE_PATH        Guid;
> 
> +  UART_DEVICE_PATH          Uart;
> 
> +  VENDOR_DEVICE_PATH        TerminalType;
> 
> +  EFI_DEVICE_PATH_PROTOCOL  End;
> 
> +} SERIAL_DEVICE_PATH;
> 
> +
> 
> +#define gPciRootBridge \
> 
> +  { \
> 
> +    { \
> 
> +      ACPI_DEVICE_PATH, \
> 
> +      ACPI_DP, \
> 
> +      { \
> 
> +        (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), \
> 
> +        (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) \
> 
> +      }, \
> 
> +    }, \
> 
> +    EISA_PNP_ID (0x0A03), \
> 
> +    0 \
> 
> +  }
> 
> +
> 
> +#define gEndEntire \
> 
> +  { \
> 
> +    END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, {
> + END_DEVICE_PATH_LENGTH, 0 } \
> 
> +  }
> 
> +
> 
> +#endif
> 
> diff --git
> a/Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/SerialPortT
> erminalLib.inf
> b/Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/SerialPortT
> erminalLib.inf
> new file mode 100644
> index 0000000000..4f63d1626f
> --- /dev/null
> +++ b/Platform/Intel/BoardModulePkg/Library/SerialPortTerminalLib/Serial
> +++ PortTerminalLib.inf
> @@ -0,0 +1,35 @@
> +## @file
> 
> +# Component information file for Serial Port Terminal Redirection
> +Library
> 
> +#
> 
> +# INTEL CONFIDENTIAL
> 
> +# Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
> 
> +#
> 
> +# SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> +#
> 
> +##
> 
> +[Defines]
> 
> +  INF_VERSION                    = 0x00010006
> 
> +  BASE_NAME                      = SerialPortTerminalLib
> 
> +  FILE_GUID                      = E12BFA46-95F2-4ADC-9774-7E38DE78741E
> 
> +  MODULE_TYPE                    = UEFI_DRIVER
> 
> +  VERSION_STRING                 = 1.2
> 
> +  LIBRARY_CLASS                  = NULL|UEFI_DRIVER
> 
> +  CONSTRUCTOR                    = SerialPortTerminalLibConstructor
> 
> +
> 
> +[Packages]
> 
> +  MdePkg/MdePkg.dec
> 
> +  MdeModulePkg/MdeModulePkg.dec
> 
> +  BoardModulePkg/BoardModulePkg.dec
> 
> +
> 
> +[Sources]
> 
> +  SerialPortTerminalLib.c
> 
> +  SerialPortTerminalLib.h
> 
> +
> 
> +[LibraryClasses]
> 
> +  DevicePathLib
> 
> +  DebugLib
> 
> +  UefiDriverEntryPoint
> 
> +  UefiBootManagerLib
> 
> +  UefiLib
> 
> +
> 
> +[Pcd]
> 
> --
> 2.24.0.windows.2