From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f51.google.com (mail-pj1-f51.google.com [209.85.216.51]) by mx.groups.io with SMTP id smtpd.web11.37011.1681283763138729258 for ; Wed, 12 Apr 2023 00:16:03 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="signature has expired" header.i=@ventanamicro.com header.s=google header.b=JoYV9du6; spf=pass (domain: ventanamicro.com, ip: 209.85.216.51, mailfrom: sunilvl@ventanamicro.com) Received: by mail-pj1-f51.google.com with SMTP id j8so8989687pjy.4 for ; Wed, 12 Apr 2023 00:16:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ventanamicro.com; s=google; t=1681283762; x=1683875762; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=6FWNVAB6J2Gb0EPhuTTlGaZdQwaiYYhR9iJ7RTAaRvk=; b=JoYV9du66GxY56/NVfM8yivknyOCZNDH7AvoRxrkYdu9PO0nVRvo0PAj1NvQmMkUFW VtnBOGmo2dviq8DGjzT/gfYBhLfoTqG+5bhHhb0N1A6T7F/yD8VwvuvGwUB+qwhgpZwN w8LbLdHlYQrrCJ3A/x+7HAQkK9SWQc7qeiE+4YjtpoVYgKDvCZFgOmCIKi70m0v1gYOo DPUTGSRL7F3DLBmNWxDgmSW31qpogH1ct0c6vWjQNrXtl/zvZVXX8koq3Rr4gxm5LxaV LQci0SlgEx/tZeZEbAUq0+qJYjO8GApb4669iPCjxtasC5wQG2fzTFrBAuWPpF+Q9o7d 8NAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1681283762; x=1683875762; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=6FWNVAB6J2Gb0EPhuTTlGaZdQwaiYYhR9iJ7RTAaRvk=; b=hmlsgIdETI+/eyW9mNIAHJxGlRa+rj+PpWisr5h+Bm0NlWuFdoRUDocQbu+nfGY7f9 EOdi7T4VbWe+qQ1cJJFPYxrNl8vQHlXLtK4QCpG34JUCyUZdHw0xi4gwGUOFplskz0jE VEtLsKZg7hI4lppb02h/rV09jSrVCPk9FYfLkoF/YhEnT+XFp1wuT/OaCvPK7YDgmbIU yIPcI3rwA90w+LkgoKSjLCyjFKzZdhTqIfpvUitlenUgHR/MMrJpcD3CaGw8x+KbIE// y+yLo6IzwXnIW8PeClwL8EmrRrDbLVkprXUh3/xss+wPBADd5ohHeIUA0xpx1Gem3rtq JtNg== X-Gm-Message-State: AAQBX9ebEpvTkZ+z77ASh/7U2mhhjmrsGpQ69nsfje1OhUUW0EiC/xRu ga5p9x2Be1hQB7dRpSOyxQvjlQ== X-Google-Smtp-Source: AKy350aXnbOJ3bSjIz05+yx0Tim6/OElaUvZJAXWjS1+W/Wk3jJuqBHoRH9HjAVTfFVcM5YXQ61+fg== X-Received: by 2002:a17:90a:6a88:b0:244:a3b8:ea9f with SMTP id u8-20020a17090a6a8800b00244a3b8ea9fmr1319219pjj.25.1681283762500; Wed, 12 Apr 2023 00:16:02 -0700 (PDT) Return-Path: Received: from sunil-laptop ([106.51.83.242]) by smtp.gmail.com with ESMTPSA id r17-20020a17090aa09100b0022be36be19asm758726pjp.53.2023.04.12.00.16.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 12 Apr 2023 00:16:02 -0700 (PDT) Date: Wed, 12 Apr 2023 12:45:56 +0530 From: "Sunil V L" To: Andrei Warkentin Cc: devel@edk2.groups.io, Daniel Schaefer , Michael D Kinney , Liming Gao , Zhiguang Liu , Gerd Hoffmann Subject: Re: [PATCH v7 2/3] MdePkg: add SBI-based SerialPortLib for RISC-V Message-ID: References: <20230407214425.4360-1-andrei.warkentin@intel.com> <20230407214425.4360-3-andrei.warkentin@intel.com> MIME-Version: 1.0 In-Reply-To: <20230407214425.4360-3-andrei.warkentin@intel.com> Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Thanks, Andrei. Just one nit comment below. Otherwise, LGTM. Reviewed-by: Sunil V L On Fri, Apr 07, 2023 at 04:44:24PM -0500, Andrei Warkentin wrote: > These are implementations of SerialPortLib using SBI console services. > - BaseSerialPortLibRiscVSbiLib is appropriate for SEC/PEI (XIP) environments > - BaseSerialPortLibRiscVSbiLibRam is appropriate for PrePI/DXE environments > > Tested with: > - Qemu RiscVVirt (non-DBCN case, backed by UART) > - TinyEMU + RiscVVirt (non-DBCN case, HTIF) > - TinyEMU + RiscVVirt (DBCN case, HTIF) > > Cc: Daniel Schaefer > Cc: Sunil V L > Cc: Michael D Kinney > Cc: Liming Gao > Cc: Zhiguang Liu > Acked-by: Gerd Hoffmann > Signed-off-by: Andrei Warkentin > --- > MdePkg/MdePkg.dsc | 2 + > MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.inf | 41 +++ > MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRam.inf | 38 +++ > MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.h | 41 +++ > MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.c | 208 ++++++++++++++ > MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRam.c | 289 ++++++++++++++++++++ > MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.c | 132 +++++++++ > MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.uni | 16 ++ > 8 files changed, 767 insertions(+) > > diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc > index 0ac7618b4623..a810ad0d147d 100644 > --- a/MdePkg/MdePkg.dsc > +++ b/MdePkg/MdePkg.dsc > @@ -192,5 +192,7 @@ [Components.ARM, Components.AARCH64] > > [Components.RISCV64] > MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.inf > + MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.inf > + MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRam.inf > > [BuildOptions] > diff --git a/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.inf b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.inf > new file mode 100644 > index 000000000000..2340ac6bfe67 > --- /dev/null > +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.inf > @@ -0,0 +1,41 @@ > +## @file > +# Serial Port Library backed by SBI console. > +# > +# Meant for SEC and PEI (XIP) environments. > +# > +# Due to limitations of SBI console interface and XIP environments > +# (on use of globals), this library instance does not implement reading > +# and polling the serial port. See PrePiDxeSerialPortLibRiscVSbiRam.inf > +# for the full-featured variant meant for PrePi and DXE environments. > +# > +# Copyright (c) 2023, Intel Corporation. All rights reserved.
> +# > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +# > +# > +## > + > +[Defines] > + INF_VERSION = 0x0001001B > + BASE_NAME = BaseSerialPortLibRiscVSbiLib > + MODULE_UNI_FILE = BaseSerialPortLibRiscVSbiLib.uni > + FILE_GUID = 639fad38-4bfd-4eb9-9f09-e97c7947d480 > + MODULE_TYPE = BASE > + VERSION_STRING = 1.0 > + LIBRARY_CLASS = SerialPortLib | SEC PEI_CORE PEIM > + > + > +# > +# VALID_ARCHITECTURES = RISCV64 > +# > + > +[Sources] > + BaseSerialPortLibRiscVSbiLib.c > + Common.c > + Common.h > + > +[Packages] > + MdePkg/MdePkg.dec > + > +[LibraryClasses] > + RiscVSbiLib > diff --git a/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRam.inf b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRam.inf > new file mode 100644 > index 000000000000..d09573ca5b36 > --- /dev/null > +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRam.inf > @@ -0,0 +1,38 @@ > +## @file > +# Serial Port Library backed by SBI console. > +# > +# Meant for PrePi and DXE environments (where globals are allowed). See > +# BaseSerialPortLibRiscVSbiLib.inf for a reduced variant appropriate > +# for SEC and PEI (XIP) environments. > +# > +# Copyright (c) 2023, Intel Corporation. All rights reserved.
> +# > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +# > +# > +## > + > +[Defines] > + INF_VERSION = 0x0001001B > + BASE_NAME = BaseSerialPortLibRiscVSbiLibRam > + MODULE_UNI_FILE = BaseSerialPortLibRiscVSbiLib.uni > + FILE_GUID = 872af743-ab56-45b4-a065-602567f4820c > + MODULE_TYPE = BASE > + VERSION_STRING = 1.0 > + LIBRARY_CLASS = SerialPortLib | SEC DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER UEFI_DRIVER UEFI_APPLICATION > + > + > +# > +# VALID_ARCHITECTURES = RISCV64 > +# > + > +[Sources] > + BaseSerialPortLibRiscVSbiLibRam.c > + Common.c > + Common.h > + > +[Packages] > + MdePkg/MdePkg.dec > + > +[LibraryClasses] > + RiscVSbiLib > diff --git a/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.h b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.h > new file mode 100644 > index 000000000000..98c1a5d3865e > --- /dev/null > +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.h > @@ -0,0 +1,41 @@ > +/** @file > + Serial Port Library backed by SBI console. > + > + Common functionality shared by PrePiDxeSerialPortLibRiscVSbi and > + PrePiDxeSerialPortLibRiscVSbiRam implementations. > + > + Copyright (c) 2023, Intel Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#ifndef SERIAL_PORT_SBI_COMMON_H_ > +#define SERIAL_PORT_SBI_COMMON_H_ > + > +#include > +#include > +#include > + > +BOOLEAN > +SbiImplementsDbcn ( > + VOID > + ); > + > +BOOLEAN > +SbiImplementsLegacyPutchar ( > + VOID > + ); > + > +UINTN > +SbiLegacyPutchar ( > + IN UINT8 *Buffer, > + IN UINTN NumberOfBytes > + ); > + > +UINTN > +SbiDbcnWrite ( > + IN UINT8 *Buffer, > + IN UINTN NumberOfBytes > + ); > + > +#endif /* SERIAL_PORT_SBI_COMMON_H_ */ > diff --git a/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.c b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.c > new file mode 100644 > index 000000000000..f4f2959cf8cc > --- /dev/null > +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.c > @@ -0,0 +1,208 @@ > +/** @file > + Serial Port Library backed by SBI console. > + > + Meant for SEC and PEI (XIP) environments. > + > + Due to limitations of SBI console interface and XIP environments > + (on use of globals), this library instance does not implement reading > + and polling the serial port. See BaseSerialPortLibRiscVSbiLibRam.c for > + the full-featured variant meant for PrePi and DXE environments. > + > + Copyright (c) 2023, Intel Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#include "Common.h" > + > +/** > + Initialize the serial device hardware. > + > + If no initialization is required, then return RETURN_SUCCESS. > + If the serial device was successfully 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 serial device could not be initialized. > + > +**/ > +RETURN_STATUS > +EFIAPI > +SerialPortInitialize ( > + VOID > + ) > +{ > + 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 NumberOfBytes is zero, then return 0. > + > + @param Buffer The pointer to the data buffer to be written. > + @param NumberOfBytes The 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 > + ) > +{ > + if (NumberOfBytes == 0) { > + return 0; > + } > + > + if (SbiImplementsDbcn ()) { > + return SbiDbcnWrite (Buffer, NumberOfBytes); > + } > + > + if (SbiImplementsLegacyPutchar ()) { > + return SbiLegacyPutchar (Buffer, NumberOfBytes); > + } > + > + /* > + * Neither DBCN or legacy extension were present. > + */ > + return 0; > +} > + > +/** > + Read data from serial device and save the datas in buffer. > + > + Reads NumberOfBytes data bytes from a serial device into the buffer > + specified by Buffer. The number of bytes actually read is returned. > + If the return value is less than NumberOfBytes, then the rest operation failed. > + If NumberOfBytes is zero, then return 0. > + > + @param Buffer The pointer to the data buffer to store the data read from the serial device. > + @param NumberOfBytes The number of bytes which will be read. > + > + @retval 0 Read data failed; No data is to be read. > + @retval >0 The actual number of bytes read from serial device. > + > +**/ > +UINTN > +EFIAPI > +SerialPortRead ( > + OUT UINT8 *Buffer, > + IN UINTN NumberOfBytes > + ) > +{ > + return 0; > +} > + > +/** > + Polls a serial device to see if there is any data waiting to be read. > + > + Polls a serial 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 > + ) > +{ > + 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/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRam.c b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRam.c > new file mode 100644 > index 000000000000..fafba87b7cd1 > --- /dev/null > +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRam.c > @@ -0,0 +1,289 @@ > +/** @file > + Serial Port Library backed by SBI console. > + > + Meant for PrePi and DXE environments (where globals are allowed). See > + BaseSerialPortLibRiscVSbiLib.c for a reduced variant appropriate for > + SEC and PEI (XIP) environments. > + > + Copyright (c) 2023, Intel Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#include > +#include > +#include > +#include "Common.h" > + > +STATIC BOOLEAN mHaveDbcn = FALSE; > +STATIC BOOLEAN mHaveLegacyPutchar = FALSE; > +STATIC BOOLEAN mHaveLegacyGetchar = FALSE; > +STATIC INT64 mLastGetChar = -1; > + > +/** > + Return whether the legacy console getchar extension is implemented. > + > + @retval TRUE Extension is implemented. > + @retval FALSE Extension is not implemented. > + > +**/ > +STATIC > +BOOLEAN > +SbiImplementsLegacyGetchar ( > + VOID > + ) > +{ > + SBI_RET Ret; > + > + Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_PROBE_EXT, 1, SBI_EXT_0_1_CONSOLE_GETCHAR); > + if ((TranslateError (Ret.Error) == EFI_SUCCESS) && > + (Ret.Value != 0)) > + { > + return TRUE; > + } > + > + return FALSE; > +} > + > +/** > + Initialize the serial device hardware. > + > + If no initialization is required, then return RETURN_SUCCESS. > + If the serial device was successfully 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 serial device could not be initialized. > + > +**/ > +RETURN_STATUS > +EFIAPI > +SerialPortInitialize ( > + VOID > + ) > +{ > + if (SbiImplementsDbcn ()) { > + mHaveDbcn = TRUE; > + return RETURN_SUCCESS; > + } > + > + if (SbiImplementsLegacyPutchar ()) { > + mHaveLegacyPutchar = TRUE; > + } > + > + if (SbiImplementsLegacyGetchar ()) { > + mHaveLegacyGetchar = TRUE; > + } > + > + return (mHaveLegacyGetchar && mHaveLegacyPutchar) ? > + RETURN_SUCCESS : > + RETURN_DEVICE_ERROR; > +} > + > +/** > + 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 NumberOfBytes is zero, then return 0. > + > + @param Buffer The pointer to the data buffer to be written. > + @param NumberOfBytes The 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 > + ) > +{ > + if (NumberOfBytes == 0) { > + return 0; > + } > + > + if (mHaveDbcn) { > + return SbiDbcnWrite (Buffer, NumberOfBytes); > + } else if (mHaveLegacyPutchar) { > + return SbiLegacyPutchar (Buffer, NumberOfBytes); > + } > + > + /* > + * Neither DBCN or legacy extension were present. > + */ > + return 0; > +} > + > +/** > + Read data from serial device and save the datas in buffer. > + > + Reads NumberOfBytes data bytes from a serial device into the buffer > + specified by Buffer. The number of bytes actually read is returned. > + If the return value is less than NumberOfBytes, then the rest operation failed. > + If NumberOfBytes is zero, then return 0. > + > + @param Buffer The pointer to the data buffer to store the data read from the serial device. > + @param NumberOfBytes The number of bytes which will be read. > + > + @retval 0 Read data failed; No data is to be read. > + @retval >0 The actual number of bytes read from serial device. > + > +**/ > +UINTN > +EFIAPI > +SerialPortRead ( > + OUT UINT8 *Buffer, > + IN UINTN NumberOfBytes > + ) > +{ > + UINTN Index; > + > + Index = 0; > + while ((Index < NumberOfBytes) && SerialPortPoll ()) { > + Buffer[Index++] = (UINT8)mLastGetChar; > + mLastGetChar = -1; > + } > + > + return Index; > +} > + > +/** > + Polls a serial device to see if there is any data waiting to be read. > + > + Polls a serial 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 > + ) > +{ > + /* > + * Careful. OpenSBI with HTIF console will return -1 followed by -2 > + * if there is no character received. So just check for values >= 0. > + */ > + > + if (mLastGetChar >= 0) { > + return TRUE; > + } > + > + if (mHaveDbcn) { > + UINT8 Buffer; > + SBI_RET Ret; > + > + Ret = SbiCall ( > + SBI_EXT_DBCN, > + SBI_EXT_DBCN_READ, > + 3, > + 1, > + ((UINTN)&Buffer), > + 0 > + ); > + if ((TranslateError (Ret.Error) == EFI_SUCCESS) && > + (Ret.Value == 1)) > + { > + mLastGetChar = Buffer; > + } > + } else if (mHaveLegacyGetchar) { > + mLastGetChar = (INT64)SbiCall (SBI_EXT_0_1_CONSOLE_GETCHAR, 0, 0).Error; > + } > + > + return mLastGetChar >= 0; > +} > + > +/** > + 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/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.c b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.c > new file mode 100644 > index 000000000000..4926ac675b62 > --- /dev/null > +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.c > @@ -0,0 +1,132 @@ > +/** @file > + Serial Port Library backed by SBI console. > + > + Common functionality shared by PrePiDxeSerialPortLibRiscVSbi and > + PrePiDxeSerialPortLibRiscVSbiRam implementations. > + > + Copyright (c) 2023, Intel Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#include "Common.h" > + > +/** > + Return whether the DBCN extension is implemented. > + > + @retval TRUE Extension is implemented. > + @retval FALSE Extension is not implemented. > + > +**/ > +BOOLEAN > +SbiImplementsDbcn ( > + VOID > + ) > +{ > + SBI_RET Ret; > + > + Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_PROBE_EXT, 1, SBI_EXT_DBCN); > + if ((TranslateError (Ret.Error) == EFI_SUCCESS) && > + (Ret.Value != 0)) > + { > + return TRUE; > + } > + > + return FALSE; > +} > + > +/** > + Return whether the legacy console putchar extension is implemented. > + > + @retval TRUE Extension is implemented. > + @retval FALSE Extension is not implemented. > + > +**/ > +BOOLEAN > +SbiImplementsLegacyPutchar ( > + VOID > + ) > +{ > + SBI_RET Ret; > + > + Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_PROBE_EXT, 1, SBI_EXT_0_1_CONSOLE_PUTCHAR); > + if ((TranslateError (Ret.Error) == EFI_SUCCESS) && > + (Ret.Value != 0)) > + { > + return TRUE; > + } > + > + return FALSE; > +} > + > +/** > + Write data from buffer to console via SBI legacy putchar extension. > + > + The number of bytes actually written to the SBI console is returned. > + If the return value is less than NumberOfBytes, then the write operation failed. > + > + @param Buffer The pointer to the data buffer to be written. > + @param NumberOfBytes The number of bytes to written to the serial device. > + > + @retval >=0 The number of bytes written to the serial device. > + If this value is less than NumberOfBytes, then the > + write operation failed. > + > +**/ > +UINTN > +SbiLegacyPutchar ( > + IN UINT8 *Buffer, > + IN UINTN NumberOfBytes > + ) > +{ > + SBI_RET Ret; > + UINTN Index; > + > + for (Index = 0; Index < NumberOfBytes; Index++) { > + Ret = SbiCall (SBI_EXT_0_1_CONSOLE_PUTCHAR, 0, 1, Buffer[Index]); > + if ((INT64)Ret.Error < 0) { > + break; > + } > + } > + > + return Index; > +} > + > +/** > + Write data from buffer to console via SBI DBCN. > + > + The number of bytes actually written to the SBI console is returned. > + If the return value is less than NumberOfBytes, then the write operation failed. > + > + @param Buffer The pointer to the data buffer to be written. > + @param NumberOfBytes The number of bytes to written to the serial device. > + > + @retval >=0 The number of bytes written to the serial device. > + If this value is less than NumberOfBytes, then the > + write operation failed. > + > +**/ > +UINTN > +SbiDbcnWrite ( > + IN UINT8 *Buffer, > + IN UINTN NumberOfBytes > + ) > +{ > + SBI_RET Ret; > + > + Ret = SbiCall ( > + SBI_EXT_DBCN, > + SBI_EXT_DBCN_WRITE, > + 3, > + NumberOfBytes, > + ((UINTN)Buffer), > + 0 > + ); > + > + /* > + * May do partial writes. Don't bother decoding > + * Ret.Error as we're only interested in number of > + * bytes written to console. > + */ > + return Ret.Value; > +} > diff --git a/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.uni b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.uni > new file mode 100644 > index 000000000000..7b22caa5a090 > --- /dev/null > +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.uni > @@ -0,0 +1,16 @@ > +// /** @file > +// Serial Port Library backed by SBI console. > +// > +// Serial Port Library backed by SBI console. Duplicate sentence.