public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [PATCH 15/15] [platforms/devel-riscv-v2]: U500Pkg: Update Readme.md
@ 2019-09-05  1:25 Gilbert Chen
  0 siblings, 0 replies; only message in thread
From: Gilbert Chen @ 2019-09-05  1:25 UTC (permalink / raw)
  To: devel@edk2.groups.io

Update Readme.md follow sample platform readme guidance.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Gilbert Chen <gilbert.chen@hpe.com>
---
 Platform/RiscV/SiFive/U500Pkg/Readme.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/Platform/RiscV/SiFive/U500Pkg/Readme.md b/Platform/RiscV/SiFive/U500Pkg/Readme.md
index 3aaaf77..5197bdb 100644
--- a/Platform/RiscV/SiFive/U500Pkg/Readme.md
+++ b/Platform/RiscV/SiFive/U500Pkg/Readme.md
@@ -7,6 +7,38 @@ This is a sample RISC-V EDK2 platform package used agaist SiFive Freedom U500 VC
 <br>
 This package provides librareis and modules which are SiFive U500 platform implementation-specific and incorporate with common RISC-V packages mentioned above.

+## Download the sources
+```
+git clone https://github.com/tianocore/edk2-staging.git
+# Checkout RISC-V-V2 branch
+git clone https://github.com/tianocore/edk2-platforms.git
+# Checkout devel-riscv-v2 branch
+git clone https://github.com/tianocore/edk2-non-osi.git
+```
+
+## Platform Owners
+Chang, Abner <abner.chang@hpe.com><br>
+Chen, Gilbert <gilbert.chen@hpe.com>
+
+## Platform Status
+Currently the binary built from U500Pkg can boot SiFive Freedom U500 VC707 FPGA to EFI shell with console in/out enabled.
+
+## Linux Build Instructions
+You can build the RISC-V platform using below script, <br>
+`build -a RISCV64 -p Platform/RiscV/SiFive/U500Pkg/U500.dsc -t GCCRISCV`
+
+## Supported Operating Systems
+Only support to boot to EFI Shell so far
+
+## Known Issues and Limitations
+Only RISC-V RV64 is verified on this platform.
+
+## Related Materials
+- [RISC-V OpenSbi](https://github.com/riscv/opensbi)<br>
+- [SiFive U500 VC707 FPGA Getting Started Guide](https://sifive.cdn.prismic.io/sifive%2Fc248fabc-5e44-4412-b1c3-6bb6aac73a2c_sifive-u500-vc707-gettingstarted-v0.2.pdf)<br>
+- [SiFive RISC-V Core Document](https://www.sifive.com/documentation)
+
+## U500 Platform Libraries and Drivers
 ### OpneSbiPlatformLib
 In order to reduce the dependencies with RISC-V OpenSBI project (https://github.com/riscv/opensbi) and less burdens to EDK2 build process, the implementation of RISC-V EDK2 platform is leverage platform source code from OpenSBI code tree. The "platform.c" under OpenSbiPlatformLib  is cloned from RISC-V OpenSBI code tree (in EDK2 RiscVPkg) and built based on EDK2 build environment.

--
2.7.4


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2019-09-05  1:25 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-09-05  1:25 [PATCH 15/15] [platforms/devel-riscv-v2]: U500Pkg: Update Readme.md Gilbert Chen

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox