From nobody Sun Feb 8 18:28:24 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+102721+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+102721+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1680903911; cv=none; d=zohomail.com; s=zohoarc; b=Q05Dk4C7r/xYNhB9ztxEs0+VS1nlCWzWFhskOQqmI1Y20Qyl+bnGG8TfJf9xZdjsTcz6ai2Jfl37P7+0C1iTt3LJc56yWv2u6iVd2fiikRMlx7Ufx3Eji9YC2oijhvWy9jrYvsaN5WWRjbXIHopsRE3LxknfGWg80rRzfzMSe28= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1680903911; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=XiOIgz/FDz2n2OI+8CvEzd2d22L+KF1K/Q8825TLdLY=; b=gH3+PN3syWvlY7hpwhHLb5Pbs1AgUXOmWCCQwCxjDKtt7umIcYIem6kpzqwoPu2bEeMDT8iPxcZXLHWm7NALMxPgwoMD9FtCf7Xm5Ih3DiDekagErIYr3zEzx+ADdH7bfAn7prP7xmkqDqZd9SixFDfVRkRkFm/bRf4ZWvlRy8k= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+102721+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1680903911443808.528897737007; Fri, 7 Apr 2023 14:45:11 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id rfrIYY1788612xdbP5wpfjnt; Fri, 07 Apr 2023 14:45:11 -0700 X-Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mx.groups.io with SMTP id smtpd.web11.2113.1680903909265821357 for ; Fri, 07 Apr 2023 14:45:09 -0700 X-IronPort-AV: E=McAfee;i="6600,9927,10673"; a="343081070" X-IronPort-AV: E=Sophos;i="5.98,328,1673942400"; d="scan'208";a="343081070" X-Received: from orsmga008.jf.intel.com ([10.7.209.65]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 07 Apr 2023 14:44:35 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10673"; a="717964757" X-IronPort-AV: E=Sophos;i="5.98,328,1673942400"; d="scan'208";a="717964757" X-Received: from jsilva4x-mobl.amr.corp.intel.com (HELO awarkent-mobl1.amr.corp.intel.com) ([10.212.106.145]) by orsmga008-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 07 Apr 2023 14:44:34 -0700 From: "Andrei Warkentin" To: devel@edk2.groups.io Cc: Andrei Warkentin , Daniel Schaefer , Sunil V L , Michael D Kinney , Liming Gao , Zhiguang Liu , Gerd Hoffmann Subject: [edk2-devel] [PATCH v7 2/3] MdePkg: add SBI-based SerialPortLib for RISC-V Date: Fri, 7 Apr 2023 16:44:24 -0500 Message-Id: <20230407214425.4360-3-andrei.warkentin@intel.com> In-Reply-To: <20230407214425.4360-1-andrei.warkentin@intel.com> References: <20230407214425.4360-1-andrei.warkentin@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,andrei.warkentin@intel.com X-Gm-Message-State: pRB7fy0XqawV2OGWnvZ0Cc1xx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1680903911; bh=3h7Xb90AUYXehRC6D0m40Ib/bxv5DQPBxmoEnWDNp7I=; h=Cc:Date:From:Reply-To:Subject:To; b=TlFX0P3/DeF4DLzlo9X1jV3nlWKmyUaYQGshJ+vBe2v85drs+6AIIKOikqnT3415EUZ 9shv5HwYYi/VEUJy0XVobV8YMIVZ0rv92k7efVy2UXi61Npd1LRTxh7XsSmPIHGCMW9dC 6tfmwoltye7JpGkyBjN5pZseZjGczyEodkA= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1680903913617100015 Content-Type: text/plain; charset="utf-8" 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 Reviewed-by: Sunil V L --- MdePkg/MdePkg.dsc = | 2 + MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.i= nf | 41 +++ MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRa= m.inf | 38 +++ MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.h = | 41 +++ MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.c= | 208 ++++++++++++++ MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLibRa= m.c | 289 ++++++++++++++++++++ MdePkg/Library/BaseSerialPortLibRiscVSbiLib/Common.c = | 132 +++++++++ MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib.u= ni | 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] =20 [Components.RISCV64] MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.inf + MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib= .inf + MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbiLib= Ram.inf =20 [BuildOptions] diff --git a/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibR= iscVSbiLib.inf b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPort= LibRiscVSbiLib.inf new file mode 100644 index 000000000000..2340ac6bfe67 --- /dev/null +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbi= Lib.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 =3D 0x0001001B + BASE_NAME =3D BaseSerialPortLibRiscVSbiLib + MODULE_UNI_FILE =3D BaseSerialPortLibRiscVSbiLib.uni + FILE_GUID =3D 639fad38-4bfd-4eb9-9f09-e97c7947d480 + MODULE_TYPE =3D BASE + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D SerialPortLib | SEC PEI_CORE PEIM + + +# +# VALID_ARCHITECTURES =3D RISCV64 +# + +[Sources] + BaseSerialPortLibRiscVSbiLib.c + Common.c + Common.h + +[Packages] + MdePkg/MdePkg.dec + +[LibraryClasses] + RiscVSbiLib diff --git a/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibR= iscVSbiLibRam.inf b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialP= ortLibRiscVSbiLibRam.inf new file mode 100644 index 000000000000..d09573ca5b36 --- /dev/null +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbi= LibRam.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 =3D 0x0001001B + BASE_NAME =3D BaseSerialPortLibRiscVSbiLibRam + MODULE_UNI_FILE =3D BaseSerialPortLibRiscVSbiLib.uni + FILE_GUID =3D 872af743-ab56-45b4-a065-602567f4820c + MODULE_TYPE =3D BASE + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D SerialPortLib | SEC DXE_CORE DXE_DRIV= ER DXE_RUNTIME_DRIVER UEFI_DRIVER UEFI_APPLICATION + + +# +# VALID_ARCHITECTURES =3D 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/BaseSerialPortLibR= iscVSbiLib.c b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLi= bRiscVSbiLib.c new file mode 100644 index 000000000000..f4f2959cf8cc --- /dev/null +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbi= Lib.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_SU= CCESS. + 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 de= vice. + + @retval 0 NumberOfBytes is 0. + @retval >0 The number of bytes written to the serial devic= e. + If this value is less than NumberOfBytes, then = the write operation failed. + +**/ +UINTN +EFIAPI +SerialPortWrite ( + IN UINT8 *Buffer, + IN UINTN NumberOfBytes + ) +{ + if (NumberOfBytes =3D=3D 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 dat= a 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 dev= ice. + +**/ +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 FALS= E is returned. + + @retval TRUE Data is waiting to be read from the serial devi= ce. + @retval FALSE There is no data waiting to be read from the se= rial 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 seria= l device. + @retval RETURN_UNSUPPORTED The serial device does not support this op= eration. + @retval RETURN_DEVICE_ERROR The serial device is not functioning corre= ctly. + +**/ +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 si= gnals 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 op= eration. + @retval RETURN_DEVICE_ERROR The serial device is not functioning corre= ctly. + +**/ +RETURN_STATUS +EFIAPI +SerialPortGetControl ( + OUT UINT32 *Control + ) +{ + *Control =3D 0; + return RETURN_SUCCESS; +} + +/** + Sets the baud rate, receive FIFO depth, transmit/receice time out, parit= y, + 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 d= evice's default time + out value. + On output, the value actually set. + @param Parity The type of parity to use on this serial devic= e. A Parity value of + DefaultParity will use the device's default pa= rity value. + On output, the value actually set. + @param DataBits The number of data bits to use on the serial d= evice. 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 ser= ial device. + @retval RETURN_UNSUPPORTED The serial device does not support thi= s operation. + @retval RETURN_INVALID_PARAMETER One or more of the attributes has an u= nsupported value. + @retval RETURN_DEVICE_ERROR The serial device is not functioning c= orrectly. + +**/ +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/BaseSerialPortLibR= iscVSbiLibRam.c b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPor= tLibRiscVSbiLibRam.c new file mode 100644 index 000000000000..fafba87b7cd1 --- /dev/null +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbi= LibRam.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 =3D FALSE; +STATIC BOOLEAN mHaveLegacyPutchar =3D FALSE; +STATIC BOOLEAN mHaveLegacyGetchar =3D FALSE; +STATIC INT64 mLastGetChar =3D -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 =3D SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_PROBE_EXT, 1, SBI_EXT_0_1_CO= NSOLE_GETCHAR); + if ((TranslateError (Ret.Error) =3D=3D EFI_SUCCESS) && + (Ret.Value !=3D 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_SU= CCESS. + 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 =3D TRUE; + return RETURN_SUCCESS; + } + + if (SbiImplementsLegacyPutchar ()) { + mHaveLegacyPutchar =3D TRUE; + } + + if (SbiImplementsLegacyGetchar ()) { + mHaveLegacyGetchar =3D 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 de= vice. + + @retval 0 NumberOfBytes is 0. + @retval >0 The number of bytes written to the serial devic= e. + If this value is less than NumberOfBytes, then = the write operation failed. + +**/ +UINTN +EFIAPI +SerialPortWrite ( + IN UINT8 *Buffer, + IN UINTN NumberOfBytes + ) +{ + if (NumberOfBytes =3D=3D 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 dat= a 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 dev= ice. + +**/ +UINTN +EFIAPI +SerialPortRead ( + OUT UINT8 *Buffer, + IN UINTN NumberOfBytes + ) +{ + UINTN Index; + + Index =3D 0; + while ((Index < NumberOfBytes) && SerialPortPoll ()) { + Buffer[Index++] =3D (UINT8)mLastGetChar; + mLastGetChar =3D -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 FALS= E is returned. + + @retval TRUE Data is waiting to be read from the serial devi= ce. + @retval FALSE There is no data waiting to be read from the se= rial 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 >=3D 0. + */ + + if (mLastGetChar >=3D 0) { + return TRUE; + } + + if (mHaveDbcn) { + UINT8 Buffer; + SBI_RET Ret; + + Ret =3D SbiCall ( + SBI_EXT_DBCN, + SBI_EXT_DBCN_READ, + 3, + 1, + ((UINTN)&Buffer), + 0 + ); + if ((TranslateError (Ret.Error) =3D=3D EFI_SUCCESS) && + (Ret.Value =3D=3D 1)) + { + mLastGetChar =3D Buffer; + } + } else if (mHaveLegacyGetchar) { + mLastGetChar =3D (INT64)SbiCall (SBI_EXT_0_1_CONSOLE_GETCHAR, 0, 0).Er= ror; + } + + return mLastGetChar >=3D 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 seria= l device. + @retval RETURN_UNSUPPORTED The serial device does not support this op= eration. + @retval RETURN_DEVICE_ERROR The serial device is not functioning corre= ctly. + +**/ +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 si= gnals 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 op= eration. + @retval RETURN_DEVICE_ERROR The serial device is not functioning corre= ctly. + +**/ +RETURN_STATUS +EFIAPI +SerialPortGetControl ( + OUT UINT32 *Control + ) +{ + *Control =3D 0; + return RETURN_SUCCESS; +} + +/** + Sets the baud rate, receive FIFO depth, transmit/receice time out, parit= y, + 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 d= evice's default time + out value. + On output, the value actually set. + @param Parity The type of parity to use on this serial devic= e. A Parity value of + DefaultParity will use the device's default pa= rity value. + On output, the value actually set. + @param DataBits The number of data bits to use on the serial d= evice. 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 ser= ial device. + @retval RETURN_UNSUPPORTED The serial device does not support thi= s operation. + @retval RETURN_INVALID_PARAMETER One or more of the attributes has an u= nsupported value. + @retval RETURN_DEVICE_ERROR The serial device is not functioning c= orrectly. + +**/ +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 =3D SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_PROBE_EXT, 1, SBI_EXT_DBCN); + if ((TranslateError (Ret.Error) =3D=3D EFI_SUCCESS) && + (Ret.Value !=3D 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 =3D SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_PROBE_EXT, 1, SBI_EXT_0_1_CO= NSOLE_PUTCHAR); + if ((TranslateError (Ret.Error) =3D=3D EFI_SUCCESS) && + (Ret.Value !=3D 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 de= vice. + + @retval >=3D0 The number of bytes written to the serial dev= ice. + 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 =3D 0; Index < NumberOfBytes; Index++) { + Ret =3D 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 de= vice. + + @retval >=3D0 The number of bytes written to the serial dev= ice. + If this value is less than NumberOfBytes, then = the + write operation failed. + +**/ +UINTN +SbiDbcnWrite ( + IN UINT8 *Buffer, + IN UINTN NumberOfBytes + ) +{ + SBI_RET Ret; + + Ret =3D 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/BaseSerialPortLibR= iscVSbiLib.uni b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPort= LibRiscVSbiLib.uni new file mode 100644 index 000000000000..7b22caa5a090 --- /dev/null +++ b/MdePkg/Library/BaseSerialPortLibRiscVSbiLib/BaseSerialPortLibRiscVSbi= Lib.uni @@ -0,0 +1,16 @@ +// /** @file +// Serial Port Library backed by SBI console. +// +// Serial Port Library backed by SBI console. +// +// Copyright (c) 2023, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Serial Port Libra= ry backed by SBI console" + +#string STR_MODULE_DESCRIPTION #language en-US "Serial Port Libra= ry backed by SBI console." + --=20 2.25.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#102721): https://edk2.groups.io/g/devel/message/102721 Mute This Topic: https://groups.io/mt/98133913/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-