From: "Sunil V L" <sunilvl@ventanamicro.com>
To: devel@edk2.groups.io
Cc: Jian J Wang <jian.j.wang@intel.com>,
Liming Gao <gaoliming@byosoft.com.cn>,
Eric Dong <eric.dong@intel.com>, Ray Ni <ray.ni@intel.com>,
Rahul Kumar <rahul1.kumar@intel.com>,
Debkumar De <debkumar.de@intel.com>,
Catharine West <catharine.west@intel.com>,
Daniel Schaefer <git@danielschaefer.me>,
Abner Chang <Abner.Chang@amd.com>,
Leif Lindholm <quic_llindhol@quicinc.com>,
Ard Biesheuvel <ardb@kernel.org>,
Heinrich Schuchardt <heinrich.schuchardt@canonical.com>,
Anup Patel <apatel@ventanamicro.com>,
Sunil V L <sunilvl@ventanamicro.com>
Subject: [RFC PATCH 00/17] Refactor and add RISC-V support in edk2 repo
Date: Tue, 6 Sep 2022 22:38:20 +0530 [thread overview]
Message-ID: <20220906170837.491525-1-sunilvl@ventanamicro.com> (raw)
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
next reply other threads:[~2022-09-06 17:08 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-06 17:08 Sunil V L [this message]
2022-09-06 17:08 ` [RFC PATCH 01/17] MdePkg/Register: Add register definition header files for RISC-V Sunil V L
2022-09-06 17:08 ` [RFC PATCH 02/17] MdePkg/MdePkg.dec: Add RISCV_EFI_BOOT_PROTOCOL GUID Sunil V L
2022-09-06 17:08 ` [RFC PATCH 03/17] MdePkg/Protocol: Add RiscVBootProtocol.h Sunil V L
2022-09-06 17:08 ` [RFC PATCH 04/17] MdeModulePkg/MdeModulePkg.dec: Add PCD variables for RISC-V Sunil V L
2022-09-06 17:08 ` [RFC PATCH 05/17] UefiCpuPkg.dec: Add PCD variable " Sunil V L
2022-09-06 17:08 ` [RFC PATCH 06/17] MdePkg/BaseLib: RISC-V: Add generic CPU related functions Sunil V L
2022-09-06 17:08 ` [RFC PATCH 07/17] MdePkg: Add ArchTimerLib library Sunil V L
2022-09-06 17:08 ` [RFC PATCH 08/17] MdePkg: Add RiscVSbiLib Library for RISC-V Sunil V L
2022-09-06 17:08 ` [RFC PATCH 09/17] UefiCpuPkg/DxeCpuExceptionHandlerLib: Refactor to add other architectures Sunil V L
2022-09-06 17:08 ` [RFC PATCH 10/17] UefiCpuPkg: Add RISC-V support in DxeCpuExceptionHandlerLib Sunil V L
2022-09-06 17:08 ` [RFC PATCH 11/17] MdePkg/Library: Add ResetSystemLib library Sunil V L
2022-09-06 17:08 ` [RFC PATCH 12/17] UefiCpuPkg/SecCore: Add SEC startup code for RISC-V Sunil V L
2022-09-06 17:08 ` [RFC PATCH 13/17] MdePkg: Add PlatformPeiLib library Sunil V L
2022-09-06 17:08 ` [RFC PATCH 14/17] MdeModulePkg/Universal: Add PlatformPei module for RISC-V Sunil V L
2022-09-06 17:08 ` [RFC PATCH 15/17] UefiCpuPkg/CpuDxe: Refactor to allow other CPU architectures Sunil V L
2022-09-06 17:08 ` [RFC PATCH 16/17] UefiCpuPkg/CpuDxe: Add RISC-V support in CpuDxe module Sunil V L
2022-09-07 9:32 ` Chang, Abner
2022-09-07 11:22 ` Sunil V L
2022-09-07 12:46 ` Chang, Abner
2022-09-08 10:53 ` Sunil V L
2022-09-08 12:02 ` Chang, Abner
2022-09-06 17:08 ` [RFC PATCH 17/17] MdeModulePkg/Universal: Add TimerDxe module Sunil V L
2022-09-07 5:54 ` [edk2-devel] [RFC PATCH 00/17] Refactor and add RISC-V support in edk2 repo Gerd Hoffmann
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220906170837.491525-1-sunilvl@ventanamicro.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox