From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pg1-f173.google.com (mail-pg1-f173.google.com [209.85.215.173]) by mx.groups.io with SMTP id smtpd.web12.1903.1662484127100852548 for ; Tue, 06 Sep 2022 10:08:47 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@ventanamicro.com header.s=google header.b=ZkU2dwmQ; spf=pass (domain: ventanamicro.com, ip: 209.85.215.173, mailfrom: sunilvl@ventanamicro.com) Received: by mail-pg1-f173.google.com with SMTP id c24so11176384pgg.11 for ; Tue, 06 Sep 2022 10:08:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ventanamicro.com; s=google; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date; bh=Ban72htzPwlpyQn4fbGjE2GhCT7nTKcSsBAtp3cskxs=; b=ZkU2dwmQnRQhuYq0IRNmr27kBSbZVdk8O6wSJIeycrwdbzQL4oZLiZVyFSyOuiXDDo etm7ty+7zcFooTG9i73M63u/G2mEADgdwfbEQmSPbnaI/SnYTOVnyCfbRbv6O+xPl5Qy iHGtl4sPK+aWBLBWGbxxRQEOMixFTTUuMNO5uuWRT4XeQSKlKa5NGB/u4uKEdej4O7zw MLFSCBhwlnwgaaa+a3Lm/NhSogt8Xx96SeflaSH06mm5fLZRx8+fCzW3eKSygogK/BYM WejcFVv9PxVEmJNowUFNv7tE+7DOQXZJwOfavtiAsSLFtXdtDEAB53kR+H9maL8gJXsE koKg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date; bh=Ban72htzPwlpyQn4fbGjE2GhCT7nTKcSsBAtp3cskxs=; b=0EbR3pCmMQjKNsRAzC1PgwNlfiU620OjjWLqQCah5OuvvMaCNAPKdxIvaDlZ8tTwwX MQnSn/nbz5K3RKrFuJtuA651twZgzkJVwN8jbWsXdNMrpvvKJr0VJENcoc+7kNnIO6qc dCMXLOV0zjZ3e+ED3BNApM46kdqCt9cD1JaOzfpZFJp6vd8Nk8z+hUtC+nNKcdi+HXL1 y+IYdO8pG+BAxBY3CY+KcEatUYYKqzSLDztBb5jzGIQUQXNOJs/hvET2tvhFQhz1Pl3U N63U6RN2PuTLJe6M+JE02/Rye34HfkWhV5WKudLgE7KqG7iuK8BDZGL/4mQe3Gnlc/Yf rgsQ== X-Gm-Message-State: ACgBeo3p9oGIWpI7aD0eZzM81dOka/ZZ1Z9YrIRyBw1Vzbllke0JRFgk dw7QeZcvOWBx9ujCy+MvXkp6JaspYwD5Ihiw X-Google-Smtp-Source: AA6agR6SldJ4M4aBnYUtwBsdUgXR/628jGn6MSTFCfTRO/HAdv2npnvvMsUOQOGvMNdJK+Dsv6Sn6g== X-Received: by 2002:aa7:8b44:0:b0:537:a35d:3c11 with SMTP id i4-20020aa78b44000000b00537a35d3c11mr55546044pfd.76.1662484125868; Tue, 06 Sep 2022 10:08:45 -0700 (PDT) Return-Path: Received: from localhost.localdomain ([49.206.11.92]) by smtp.gmail.com with ESMTPSA id b17-20020a170903229100b00176be258f41sm3806567plh.91.2022.09.06.10.08.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Sep 2022 10:08:45 -0700 (PDT) From: "Sunil V L" To: devel@edk2.groups.io Cc: Jian J Wang , Liming Gao , Eric Dong , Ray Ni , Rahul Kumar , Debkumar De , Catharine West , Daniel Schaefer , Abner Chang , Leif Lindholm , Ard Biesheuvel , Heinrich Schuchardt , Anup Patel , Sunil V L Subject: [RFC PATCH 00/17] Refactor and add RISC-V support in edk2 repo Date: Tue, 6 Sep 2022 22:38:20 +0530 Message-Id: <20220906170837.491525-1-sunilvl@ventanamicro.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit RISC-V ProcessorPkg and PlatformPkg were added in edk2-platforms repo. But the recommendation was they should be added in edk2 repo itself leveraging common packages as much as possible. This series tries to create RISC-V specific modules and libraries under standard packages. The approach taken here is to do this in multiple phases. In the first phase, the proposal adds support in edk2 repo without disturbing the edk2-platforms repo. So, existing platforms will continue to build in same way. Only qemu virt machine which is being supported as part of this series will make use of the refactored modules from edk2 repo. In the second phase, plan is to use newly added edk2 packages as much as possible in edk2-platforms and remove the redundant code from edk2-platforms repo. Generic platforms will NOT have integrated OpenSBI library in EDK2. EDK2 should be booted only in S-mode by a separate M-mode firmware on generic platforms. This doesn't exclude the vendors to have the option of having M-mode functionality in EDK2 itself, but they need to be special platforms and should be using edk2-platforms. The reasons to take this design choice are, 1) The expectation that EDK2 always starts in M-mode would not work in case of virtualization like KVM guests. 2) opensbi as M-mode firmware is one of the implementation of SBI specification. It may be the only one open source implementation as of today. But EDk2 should be able to boot with any M-mode firmware. 3) Integrating opensbi in edk2 is not trivial. opensbi repo is frequently changing and it is not possible to upgrade this in edk2 so frequently. Failing to upgrade, edk2 will be left behind other firmware solutions in terms of functionality. Also, there will be duplicate of efforts both in opensbi and edk2. 4) By making EDK2 as a payload of a previous stage M-mode firmware, the design gets simplified in a great way. There is no need to handle multiple CPUs entering EDK2, no wrapper libraries required etc. 5) This allows to follow the RISC-V S-mode calling convention which passes BootHartId and the DTB to S-Mode. EDk2 can parse the DTB instead of hardcoding many platform specific details in PCD variables. In few places, a separate INF file is created (ex: UefiCpuPkg/SecCore/SecCoreRiscV.inf) since there is not much to leverage the code and may not suit to other architectures. But happy to do which is the correct thing to do. At high level the changes are spread in 3 main modules. 1) UefiCpuPkg - Added new SEC(SecCore) for RISC-V - Refactored and added RISC-V support in DxeCpuExceptionHandlerLib - Refactored and added RISC-V support in CpuDxe - Added PCD variable for RISC-V similar to existing PcdCpuCoreCrystalClockFrequency 2) MdePkg - Added RISC-V register definition headers - Added definition of RISCV_EFI_BOOT_PROTOCOL GUID and header file - BaseLib - enhanced to add interfaces to access the SSCRATCH register - Added ArchTimerLib which can be leveraged by other architectures if needed. - Added RiscVSbiLib specific to RISC-V to make SBI calls to M-mode firmware. - Added ResetSystemLib which can be leveraged by other architectures. - Added PlatformPeiLib which can be leveraged by other architectures. 3)MdeModulePkg - Added PCD variables for RISC-V - Added PlatformPei PEIM which can be leveraged by other architectures. - Added TimerDxe module which can be leveraged by other architectures. RISC-V virt needs following packages from ARM. Need feedback whether they can be moved to a common location. Current RISC-V virt model DSC file include them directly. - ArmVirtPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf - ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf - ArmVirtPkg/PlatformHasAcpiDtDxe/PlatformHasAcpiDtDxe.inf - ArmVirtPkg/Library/NorFlashQemuLib/NorFlashQemuLib.inf I have not run CI/CD. Only CheckPatch is run and RISC-V build is tested. Once we get consensus on the proposal, we can run additional tests required. These changes are available at https://github.com/vlsunil/edk2/tree/virt_refactor_smode_v1 The RISC-V virt machine support is added in edk2-platforms and changes are available in below branch. https://github.com/vlsunil/edk2-platforms/tree/virt_refactor_smode_v1 The chnges are tested on qemu but it needs an additional patch series. https://lists.gnu.org/archive/html/qemu-devel/2022-09/msg00838.html 2) Build EDK2 for RISC-V export WORKSPACE=`pwd` export GCC5_RISCV64_PREFIX=riscv64-linux-gnu- export PACKAGES_PATH=$WORKSPACE/edk2:$WORKSPACE/edk2-platforms export EDK_TOOLS_PATH=$WORKSPACE/edk2/BaseTools source edk2/edksetup.sh make -C edk2/BaseTools clean make -C edk2/BaseTools make -C edk2/BaseTools/Source/C source edk2/edksetup.sh BaseTools build -a RISCV64 -p Platform/Qemu/RiscVVirt/RiscVVirt.dsc -t GCC5 3)Make the EDK2 image size to match with what qemu flash expects truncate -s 32M Build/RiscVVirt/DEBUG_GCC5/FV/RISCV_VIRT.fd 4) Run a) Boot to EFI shell (no -kernel / -initrd option) qemu-system-riscv64 -nographic -drive file=Build/RiscVVirt/DEBUG_GCC5/FV/RISCV_VIRT.fd,if=pflash,format=raw,unit=1 -machine virt -M 2G b) With -kernel, -initrd and -pflash qemu-system-riscv64 -nographic -drive file=Build/RiscVVirt/DEBUG_GCC5/FV/RISCV_VIRT.fd,if=pflash,format=raw,unit=1 -machine virt -M 2G -kernel arch/riscv/boot/Image.gz -initrd rootfs.cpio Sunil V L (17): MdePkg/Register: Add register definition header files for RISC-V MdePkg/MdePkg.dec: Add RISCV_EFI_BOOT_PROTOCOL GUID MdePkg/Protocol: Add RiscVBootProtocol.h MdeModulePkg/MdeModulePkg.dec: Add PCD variables for RISC-V UefiCpuPkg.dec: Add PCD variable for RISC-V MdePkg/BaseLib: RISC-V: Add generic CPU related functions MdePkg: Add ArchTimerLib library MdePkg: Add RiscVSbiLib Library for RISC-V UefiCpuPkg/DxeCpuExceptionHandlerLib: Refactor to add other architectures UefiCpuPkg: Add RISC-V support in DxeCpuExceptionHandlerLib MdePkg/Library: Add ResetSystemLib library UefiCpuPkg/SecCore: Add SEC startup code for RISC-V MdePkg: Add PlatformPeiLib library MdeModulePkg/Universal: Add PlatformPei module for RISC-V UefiCpuPkg/CpuDxe: Refactor to allow other CPU architectures UefiCpuPkg/CpuDxe: Add RISC-V support in CpuDxe module MdeModulePkg/Universal: Add TimerDxe module MdeModulePkg/MdeModulePkg.dec | 13 + .../Universal/PlatformPei/PlatformPei.inf | 65 ++ .../Universal/PlatformPei/RiscV64/Fv.c | 83 ++ .../Universal/PlatformPei/RiscV64/MemDetect.c | 179 ++++ .../Universal/PlatformPei/RiscV64/Platform.c | 372 ++++++++ .../Universal/PlatformPei/RiscV64/Platform.h | 97 +++ .../Universal/TimerDxe/RiscV64/Timer.c | 293 +++++++ .../Universal/TimerDxe/RiscV64/Timer.h | 174 ++++ MdeModulePkg/Universal/TimerDxe/Timer.uni | 15 + MdeModulePkg/Universal/TimerDxe/TimerDxe.inf | 52 ++ .../Universal/TimerDxe/TimerExtra.uni | 13 + MdePkg/Include/Library/BaseLib.h | 10 + MdePkg/Include/Library/PlatformPeiLib.h | 15 + MdePkg/Include/Library/RiscVSbiLib.h | 129 +++ MdePkg/Include/Protocol/RiscVBootProtocol.h | 35 + MdePkg/Include/Register/RiscV64/RiscVAsm.h | 104 +++ MdePkg/Include/Register/RiscV64/RiscVConst.h | 46 + .../Include/Register/RiscV64/RiscVEncoding.h | 129 +++ MdePkg/Include/Register/RiscV64/RiscVImpl.h | 24 + MdePkg/Library/ArchTimerLib/ArchTimerLib.inf | 40 + MdePkg/Library/ArchTimerLib/ArchTimerLib.uni | 14 + .../ArchTimerLib/RiscV64/CpuTimerLib.c | 299 +++++++ MdePkg/Library/BaseLib/BaseLib.inf | 1 + MdePkg/Library/BaseLib/RiscV64/CpuGen.S | 33 + .../Library/PlatformPeiLib/PlatformPeiLib.inf | 40 + .../PlatformPeiLib/RiscV64/PlatformPeiLib.c | 68 ++ .../Library/ResetSystemLib/ResetSystemLib.inf | 35 + .../ResetSystemLib/RiscV64/ResetSystemLib.c | 128 +++ MdePkg/Library/RiscVSbiLib/RiscVSbiLib.c | 228 +++++ MdePkg/Library/RiscVSbiLib/RiscVSbiLib.inf | 28 + MdePkg/MdePkg.dec | 6 + UefiCpuPkg/CpuDxe/CpuDxe.inf | 28 +- UefiCpuPkg/CpuDxe/RiscV64/CpuDxe.c | 337 ++++++++ UefiCpuPkg/CpuDxe/RiscV64/CpuDxe.h | 200 +++++ .../DxeCpuExceptionHandlerLib.inf | 13 +- .../RiscV64/CpuExceptionHandlerLib.c | 136 +++ .../RiscV64/CpuExceptionHandlerLib.h | 112 +++ .../RiscV64/SupervisorTrapHandler.S | 105 +++ UefiCpuPkg/SecCore/RiscV64/SecEntry.S | 23 + UefiCpuPkg/SecCore/RiscV64/SecMain.c | 796 ++++++++++++++++++ UefiCpuPkg/SecCore/RiscV64/SecMain.h | 63 ++ UefiCpuPkg/SecCore/SecCoreRiscV.inf | 59 ++ UefiCpuPkg/UefiCpuPkg.dec | 3 + 43 files changed, 4634 insertions(+), 9 deletions(-) create mode 100644 MdeModulePkg/Universal/PlatformPei/PlatformPei.inf create mode 100644 MdeModulePkg/Universal/PlatformPei/RiscV64/Fv.c create mode 100644 MdeModulePkg/Universal/PlatformPei/RiscV64/MemDetect.c create mode 100644 MdeModulePkg/Universal/PlatformPei/RiscV64/Platform.c create mode 100644 MdeModulePkg/Universal/PlatformPei/RiscV64/Platform.h create mode 100644 MdeModulePkg/Universal/TimerDxe/RiscV64/Timer.c create mode 100644 MdeModulePkg/Universal/TimerDxe/RiscV64/Timer.h create mode 100644 MdeModulePkg/Universal/TimerDxe/Timer.uni create mode 100644 MdeModulePkg/Universal/TimerDxe/TimerDxe.inf create mode 100644 MdeModulePkg/Universal/TimerDxe/TimerExtra.uni create mode 100644 MdePkg/Include/Library/PlatformPeiLib.h create mode 100644 MdePkg/Include/Library/RiscVSbiLib.h create mode 100644 MdePkg/Include/Protocol/RiscVBootProtocol.h create mode 100644 MdePkg/Include/Register/RiscV64/RiscVAsm.h create mode 100644 MdePkg/Include/Register/RiscV64/RiscVConst.h create mode 100644 MdePkg/Include/Register/RiscV64/RiscVEncoding.h create mode 100644 MdePkg/Include/Register/RiscV64/RiscVImpl.h create mode 100644 MdePkg/Library/ArchTimerLib/ArchTimerLib.inf create mode 100644 MdePkg/Library/ArchTimerLib/ArchTimerLib.uni create mode 100644 MdePkg/Library/ArchTimerLib/RiscV64/CpuTimerLib.c create mode 100644 MdePkg/Library/BaseLib/RiscV64/CpuGen.S create mode 100644 MdePkg/Library/PlatformPeiLib/PlatformPeiLib.inf create mode 100644 MdePkg/Library/PlatformPeiLib/RiscV64/PlatformPeiLib.c create mode 100644 MdePkg/Library/ResetSystemLib/ResetSystemLib.inf create mode 100644 MdePkg/Library/ResetSystemLib/RiscV64/ResetSystemLib.c create mode 100644 MdePkg/Library/RiscVSbiLib/RiscVSbiLib.c create mode 100644 MdePkg/Library/RiscVSbiLib/RiscVSbiLib.inf create mode 100644 UefiCpuPkg/CpuDxe/RiscV64/CpuDxe.c create mode 100644 UefiCpuPkg/CpuDxe/RiscV64/CpuDxe.h create mode 100644 UefiCpuPkg/Library/CpuExceptionHandlerLib/RiscV64/CpuExceptionHandlerLib.c create mode 100644 UefiCpuPkg/Library/CpuExceptionHandlerLib/RiscV64/CpuExceptionHandlerLib.h create mode 100644 UefiCpuPkg/Library/CpuExceptionHandlerLib/RiscV64/SupervisorTrapHandler.S create mode 100644 UefiCpuPkg/SecCore/RiscV64/SecEntry.S create mode 100644 UefiCpuPkg/SecCore/RiscV64/SecMain.c create mode 100644 UefiCpuPkg/SecCore/RiscV64/SecMain.h create mode 100644 UefiCpuPkg/SecCore/SecCoreRiscV.inf -- 2.25.1