From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f52.google.com (mail-pj1-f52.google.com [209.85.216.52]) by mx.groups.io with SMTP id smtpd.web11.15810.1675348530460024137 for ; Thu, 02 Feb 2023 06:35:30 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@ventanamicro.com header.s=google header.b=cmIIYHzw; spf=pass (domain: ventanamicro.com, ip: 209.85.216.52, mailfrom: sunilvl@ventanamicro.com) Received: by mail-pj1-f52.google.com with SMTP id j5so2065514pjn.5 for ; Thu, 02 Feb 2023 06:35:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ventanamicro.com; s=google; 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=oZMFb4mdZy9ww1QbLahTzuxe0lZGzkZFAm+hKbqwExQ=; b=cmIIYHzwPRu1NaBnVD9MuJDte/fcDgqvBoJpFDUGpQw1p53i1ODQXdM8EeVmAfycrs atDDwmXM0roBUeCv1YLhTOvv/j0/0jVznC5HYeww0b5vJPllIMXIxT45KO5DpS5qca24 V82wxghoxhAbXCk8jGc5xpYqUldRrNk1tHOz/uW5UB2XhSL1wb7tKohW7MLZYRL+rnTC X8PMaAb2gi5RGOIeD7htqmBKIyBZR490UoCCJm4BZYT1CKalTjYT3I/kOSfwAbhwuTAN n06DcyJwCWiohfM/dosm48iALv6zqntw4QOT8ehOW9vh/6Q9nYhVpnXlG5PdEj2fAnU8 /DHA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; 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=oZMFb4mdZy9ww1QbLahTzuxe0lZGzkZFAm+hKbqwExQ=; b=KonhBBkLe2upFyh5/Q9earZV7KcpERcgWc7s8vzBujuSG/W2MZj8IA4DxwNB4Tw1TQ l/zb1HmUQQ0GBxVqKVgDyW0FTi6J2WiQemOSYDzpL9jja0k/4DA5uLH3+w8bO841VaXU 938KvCwH5+QjgiHKkyc+f6vDIEWVghKYdEFOqDbdl33176MqXjOEcTcvFcDa7jHuA4vC uFVVLAyBtvxFMsISWrisRV745D6WmHX9gFIirQgUx/5ZjmgrKuvHoY+bzQv4vyZ5FGVl H1L/yrzeg70+vwy1DbxxECELteIChGjYB1JgqNcWZrqU+ZWtvlZeixrYNn6i/bQGmJzU TmTA== X-Gm-Message-State: AO0yUKUQ8AMvcu6ymZA9gtKg3KcxB/BWK30GiiZ3OS6mk5qGLWaNJU5i fgvWbs9vOV9HpMdhUFV1dW6pIQ== X-Google-Smtp-Source: AK7set/pTY5BXSpswHscUD0thzPjLuetqJwLTS8MFJqj5EHK6DhBo45j+vjUxz1a3lAlmWx8GNr4Dg== X-Received: by 2002:a17:903:18b:b0:198:b3df:c753 with SMTP id z11-20020a170903018b00b00198b3dfc753mr6504513plg.45.1675348529721; Thu, 02 Feb 2023 06:35:29 -0800 (PST) Return-Path: Received: from sunil-laptop ([49.206.14.226]) by smtp.gmail.com with ESMTPSA id c11-20020a170902d48b00b001960706141fsm9981822plg.149.2023.02.02.06.35.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 02 Feb 2023 06:35:28 -0800 (PST) Date: Thu, 2 Feb 2023 20:05:22 +0530 From: "Sunil V L" To: Michael D Kinney Cc: Michael D Kinney , Liming Gao , Zhiguang Liu , Abner Chang , devel@edk2.groups.io Subject: Re: [edk2-devel] [edk2-staging/RiscV64QemuVirt PATCH V7 03/20] MdePkg: Add BaseRiscVSbiLib Library for RISC-V Message-ID: References: <20230128191807.2080547-1-sunilvl@ventanamicro.com> <173E8F254E9BED62.27165@groups.io> MIME-Version: 1.0 In-Reply-To: <173E8F254E9BED62.27165@groups.io> Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Hi Mike, I know you are pretty busy. But I need your help. As we discussed in the tianocore design meeting last year and as per your recommendation (https://edk2.groups.io/g/devel/message/85481), these changes in MdePkg are done. Abner has helped to review from RISC-V perspective. If you could ACK these patches from MdePkg structure/policy perspective atleast, it will be very helpful. Thanks! Sunil On Sun, Jan 29, 2023 at 12:47:50AM +0530, Sunil V L via groups.io wrote: > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4076 > > This library is required to make SBI ecalls from the S-mode EDK2. > This is mostly copied from > edk2-platforms/Silicon/RISC-V/ProcessorPkg/Library/RiscVEdk2SbiLib > > Cc: Michael D Kinney > Cc: Liming Gao > Cc: Zhiguang Liu > Signed-off-by: Sunil V L > Acked-by: Abner Chang > --- > MdePkg/MdePkg.dec | 4 + > MdePkg/MdePkg.dsc | 3 + > MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.inf | 25 +++ > MdePkg/Include/Library/BaseRiscVSbiLib.h | 127 +++++++++++ > MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.c | 227 ++++++++++++++++++++ > 5 files changed, 386 insertions(+) > > diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec > index 3d08f20d15b0..ca2e4dcf815c 100644 > --- a/MdePkg/MdePkg.dec > +++ b/MdePkg/MdePkg.dec > @@ -316,6 +316,10 @@ [LibraryClasses.IA32, LibraryClasses.X64] > ## @libraryclass Provides function to support TDX processing. > TdxLib|Include/Library/TdxLib.h > > +[LibraryClasses.RISCV64] > + ## @libraryclass Provides function to make ecalls to SBI > + BaseRiscVSbiLib|Include/Library/BaseRiscVSbiLib.h > + > [Guids] > # > # GUID defined in UEFI2.1/UEFI2.0/EFI1.1 > diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc > index 32a852dc466e..0ac7618b4623 100644 > --- a/MdePkg/MdePkg.dsc > +++ b/MdePkg/MdePkg.dsc > @@ -190,4 +190,7 @@ [Components.ARM, Components.AARCH64] > MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsicArmVirt.inf > MdePkg/Library/BaseStackCheckLib/BaseStackCheckLib.inf > > +[Components.RISCV64] > + MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.inf > + > [BuildOptions] > diff --git a/MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.inf b/MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.inf > new file mode 100644 > index 000000000000..d03132bf01c1 > --- /dev/null > +++ b/MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.inf > @@ -0,0 +1,25 @@ > +## @file > +# RISC-V Library to call SBI ecalls > +# > +# Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.
> +# > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +# > +## > + > +[Defines] > + INF_VERSION = 0x0001001b > + BASE_NAME = BaseRiscVSbiLib > + FILE_GUID = D742CF3D-E600-4009-8FB5-318073008508 > + MODULE_TYPE = BASE > + VERSION_STRING = 1.0 > + LIBRARY_CLASS = RiscVSbiLib > + > +[Sources] > + BaseRiscVSbiLib.c > + > +[Packages] > + MdePkg/MdePkg.dec > + > +[LibraryClasses] > + BaseLib > diff --git a/MdePkg/Include/Library/BaseRiscVSbiLib.h b/MdePkg/Include/Library/BaseRiscVSbiLib.h > new file mode 100644 > index 000000000000..3a3cbfb879f1 > --- /dev/null > +++ b/MdePkg/Include/Library/BaseRiscVSbiLib.h > @@ -0,0 +1,127 @@ > +/** @file > + Library to call the RISC-V SBI ecalls > + > + Copyright (c) 2021-2022, Hewlett Packard Development LP. All rights reserved.
> + > + SPDX-License-Identifier: BSD-2-Clause-Patent > + > + @par Glossary: > + - Hart - Hardware Thread, similar to a CPU core > + > + Currently, EDK2 needs to call SBI only to set the time and to do system reset. > + > +**/ > + > +#ifndef RISCV_SBI_LIB_H_ > +#define RISCV_SBI_LIB_H_ > + > +#include > + > +/* SBI Extension IDs */ > +#define SBI_EXT_TIME 0x54494D45 > +#define SBI_EXT_SRST 0x53525354 > + > +/* SBI function IDs for TIME extension*/ > +#define SBI_EXT_TIME_SET_TIMER 0x0 > + > +/* SBI function IDs for SRST extension */ > +#define SBI_EXT_SRST_RESET 0x0 > + > +#define SBI_SRST_RESET_TYPE_SHUTDOWN 0x0 > +#define SBI_SRST_RESET_TYPE_COLD_REBOOT 0x1 > +#define SBI_SRST_RESET_TYPE_WARM_REBOOT 0x2 > + > +#define SBI_SRST_RESET_REASON_NONE 0x0 > +#define SBI_SRST_RESET_REASON_SYSFAIL 0x1 > + > +/* SBI return error codes */ > +#define SBI_SUCCESS 0 > +#define SBI_ERR_FAILED -1 > +#define SBI_ERR_NOT_SUPPORTED -2 > +#define SBI_ERR_INVALID_PARAM -3 > +#define SBI_ERR_DENIED -4 > +#define SBI_ERR_INVALID_ADDRESS -5 > +#define SBI_ERR_ALREADY_AVAILABLE -6 > +#define SBI_ERR_ALREADY_STARTED -7 > +#define SBI_ERR_ALREADY_STOPPED -8 > + > +#define SBI_LAST_ERR SBI_ERR_ALREADY_STOPPED > + > +typedef struct { > + UINT64 BootHartId; > + VOID *PeiServiceTable; // PEI Service table > + VOID *PrePiHobList; // Pre PI Hob List > + UINT64 FlattenedDeviceTree; // Pointer to Flattened Device tree > +} EFI_RISCV_FIRMWARE_CONTEXT; > + > +// > +// EDK2 OpenSBI firmware extension return status. > +// > +typedef struct { > + UINTN Error; ///< SBI status code > + UINTN Value; ///< Value returned > +} SBI_RET; > + > +VOID > +EFIAPI > +SbiSetTimer ( > + IN UINT64 Time > + ); > + > +EFI_STATUS > +EFIAPI > +SbiSystemReset ( > + IN UINTN ResetType, > + IN UINTN ResetReason > + ); > + > +/** > + Get firmware context of the calling hart. > + > + @param[out] FirmwareContext The firmware context pointer. > +**/ > +VOID > +EFIAPI > +GetFirmwareContext ( > + OUT EFI_RISCV_FIRMWARE_CONTEXT **FirmwareContext > + ); > + > +/** > + Set firmware context of the calling hart. > + > + @param[in] FirmwareContext The firmware context pointer. > +**/ > +VOID > +EFIAPI > +SetFirmwareContext ( > + IN EFI_RISCV_FIRMWARE_CONTEXT *FirmwareContext > + ); > + > +/** > + Get pointer to OpenSBI Firmware Context > + > + Get the pointer of firmware context. > + > + @param FirmwareContextPtr Pointer to retrieve pointer to the > + Firmware Context. > +**/ > +VOID > +EFIAPI > +GetFirmwareContextPointer ( > + IN OUT EFI_RISCV_FIRMWARE_CONTEXT **FirmwareContextPtr > + ); > + > +/** > + Set pointer to OpenSBI Firmware Context > + > + Set the pointer of firmware context. > + > + @param FirmwareContextPtr Pointer to Firmware Context. > +**/ > +VOID > +EFIAPI > +SetFirmwareContextPointer ( > + IN EFI_RISCV_FIRMWARE_CONTEXT *FirmwareContextPtr > + ); > + > +#endif > diff --git a/MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.c b/MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.c > new file mode 100644 > index 000000000000..15222a528753 > --- /dev/null > +++ b/MdePkg/Library/BaseRiscVSbiLib/BaseRiscVSbiLib.c > @@ -0,0 +1,227 @@ > +/** @file > + Instance of the SBI ecall library. > + > + It allows calling an SBI function via an ecall from S-Mode. > + > + Copyright (c) 2021-2022, Hewlett Packard Development LP. All rights reserved.
> + > + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#include > +#include > +#include > +#include > + > +// > +// Maximum arguments for SBI ecall > +#define SBI_CALL_MAX_ARGS 6 > + > +/** > + Call SBI call using ecall instruction. > + > + Asserts when NumArgs exceeds SBI_CALL_MAX_ARGS. > + > + @param[in] ExtId SBI extension ID. > + @param[in] FuncId SBI function ID. > + @param[in] NumArgs Number of arguments to pass to the ecall. > + @param[in] ... Argument list for the ecall. > + > + @retval Returns SBI_RET structure with value and error code. > + > +**/ > +STATIC > +SBI_RET > +EFIAPI > +SbiCall ( > + IN UINTN ExtId, > + IN UINTN FuncId, > + IN UINTN NumArgs, > + ... > + ) > +{ > + UINTN I; > + SBI_RET Ret; > + UINTN Args[SBI_CALL_MAX_ARGS]; > + VA_LIST ArgList; > + > + VA_START (ArgList, NumArgs); > + > + if (NumArgs > SBI_CALL_MAX_ARGS) { > + Ret.Error = SBI_ERR_INVALID_PARAM; > + Ret.Value = -1; > + return Ret; > + } > + > + for (I = 0; I < SBI_CALL_MAX_ARGS; I++) { > + if (I < NumArgs) { > + Args[I] = VA_ARG (ArgList, UINTN); > + } else { > + // Default to 0 for all arguments that are not given > + Args[I] = 0; > + } > + } > + > + VA_END (ArgList); > + > + register UINTN a0 asm ("a0") = Args[0]; > + register UINTN a1 asm ("a1") = Args[1]; > + register UINTN a2 asm ("a2") = Args[2]; > + register UINTN a3 asm ("a3") = Args[3]; > + register UINTN a4 asm ("a4") = Args[4]; > + register UINTN a5 asm ("a5") = Args[5]; > + register UINTN a6 asm ("a6") = (UINTN)(FuncId); > + register UINTN a7 asm ("a7") = (UINTN)(ExtId); > + > + asm volatile ("ecall" \ > + : "+r" (a0), "+r" (a1) \ > + : "r" (a2), "r" (a3), "r" (a4), "r" (a5), "r" (a6), "r" (a7) \ > + : "memory"); \ > + Ret.Error = a0; > + Ret.Value = a1; > + return Ret; > +} > + > +/** > + Translate SBI error code to EFI status. > + > + @param[in] SbiError SBI error code > + @retval EFI_STATUS > +**/ > +STATIC > +EFI_STATUS > +EFIAPI > +TranslateError ( > + IN UINTN SbiError > + ) > +{ > + switch (SbiError) { > + case SBI_SUCCESS: > + return EFI_SUCCESS; > + case SBI_ERR_FAILED: > + return EFI_DEVICE_ERROR; > + break; > + case SBI_ERR_NOT_SUPPORTED: > + return EFI_UNSUPPORTED; > + break; > + case SBI_ERR_INVALID_PARAM: > + return EFI_INVALID_PARAMETER; > + break; > + case SBI_ERR_DENIED: > + return EFI_ACCESS_DENIED; > + break; > + case SBI_ERR_INVALID_ADDRESS: > + return EFI_LOAD_ERROR; > + break; > + case SBI_ERR_ALREADY_AVAILABLE: > + return EFI_ALREADY_STARTED; > + break; > + default: > + // > + // Reaches here only if SBI has defined a new error type > + // > + ASSERT (FALSE); > + return EFI_UNSUPPORTED; > + break; > + } > +} > + > +/** > + Clear pending timer interrupt bit and set timer for next event after Time. > + > + To clear the timer without scheduling a timer event, set Time to a > + practically infinite value or mask the timer interrupt by clearing sie.STIE. > + > + @param[in] Time The time offset to the next scheduled timer interrupt. > +**/ > +VOID > +EFIAPI > +SbiSetTimer ( > + IN UINT64 Time > + ) > +{ > + SbiCall (SBI_EXT_TIME, SBI_EXT_TIME_SET_TIMER, 1, Time); > +} > + > +EFI_STATUS > +EFIAPI > +SbiSystemReset ( > + IN UINTN ResetType, > + IN UINTN ResetReason > + ) > +{ > + SBI_RET Ret; > + > + Ret = SbiCall ( > + SBI_EXT_SRST, > + SBI_EXT_SRST_RESET, > + 2, > + ResetType, > + ResetReason > + ); > + > + return TranslateError (Ret.Error); > +} > + > +/** > + Get firmware context of the calling hart. > + > + @param[out] FirmwareContext The firmware context pointer. > + @retval EFI_SUCCESS The operation succeeds. > +**/ > +VOID > +EFIAPI > +GetFirmwareContext ( > + OUT EFI_RISCV_FIRMWARE_CONTEXT **FirmwareContext > + ) > +{ > + *FirmwareContext = (EFI_RISCV_FIRMWARE_CONTEXT *)RiscVGetSupervisorScratch (); > +} > + > +/** > + Set firmware context of the calling hart. > + > + @param[in] FirmwareContext The firmware context pointer. > +**/ > +VOID > +EFIAPI > +SetFirmwareContext ( > + IN EFI_RISCV_FIRMWARE_CONTEXT *FirmwareContext > + ) > +{ > + RiscVSetSupervisorScratch ((UINT64)FirmwareContext); > +} > + > +/** > + Get pointer to OpenSBI Firmware Context > + > + Get the pointer of firmware context through OpenSBI FW Extension SBI. > + > + @param FirmwareContextPtr Pointer to retrieve pointer to the > + Firmware Context. > +**/ > +VOID > +EFIAPI > +GetFirmwareContextPointer ( > + IN OUT EFI_RISCV_FIRMWARE_CONTEXT **FirmwareContextPtr > + ) > +{ > + GetFirmwareContext (FirmwareContextPtr); > +} > + > +/** > + Set the pointer to OpenSBI Firmware Context > + > + Set the pointer of firmware context through OpenSBI FW Extension SBI. > + > + @param FirmwareContextPtr Pointer to Firmware Context. > +**/ > +VOID > +EFIAPI > +SetFirmwareContextPointer ( > + IN EFI_RISCV_FIRMWARE_CONTEXT *FirmwareContextPtr > + ) > +{ > + SetFirmwareContext (FirmwareContextPtr); > +} > -- > 2.38.0 > > > > > >