summaryrefslogtreecommitdiff
path: root/docs/platform/platform.md
diff options
context:
space:
mode:
authorKarsten Merker <merker@debian.org>2019-05-05 13:33:25 +0300
committerAnup Patel <anup@brainfault.org>2019-05-06 08:35:33 +0300
commit0d33a981ec19181c7f6448f90599f31dfd082994 (patch)
tree88be71dfc792b975e2dbe9d731415e7e91b76e3d /docs/platform/platform.md
parent3bb2d25f448f4f5dd7d143617bc6eccf34f809e6 (diff)
downloadopensbi-0d33a981ec19181c7f6448f90599f31dfd082994.tar.xz
docs: miscellaneous documentation fixes and updates
- fix some broken hyperlinks - add additional hyperlinks to references to external documents - reformat some paragraphs to keep lines under 80 characters - unify the enumeration style between different parts of the documentation - fix spelling/grammar mistakes - extend the copyright notice in README.md to be the same as the one in COPYING.BSD Signed-off-by: Karsten Merker <merker@debian.org> Reviewed-by: Atish Patra <atish.patra@wdc.com>
Diffstat (limited to 'docs/platform/platform.md')
-rw-r--r--docs/platform/platform.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/platform/platform.md b/docs/platform/platform.md
index 12efa81..2235b6a 100644
--- a/docs/platform/platform.md
+++ b/docs/platform/platform.md
@@ -1,11 +1,12 @@
OpenSBI Supported Platforms
===========================
-OpenSBI currently supports the following virtual and hardware platforms.
+OpenSBI currently supports the following virtual and hardware platforms:
-* **QEMU RISC-V Virt Machine**: Platform support for QEMU *virt* virtual RISC-V
- machine. This virtual machine is intended for RISC-V software development and
- test. More details on this platform can be found in the file *[qemu_virt.md]*.
+* **QEMU RISC-V Virt Machine**: Platform support for the QEMU *virt* virtual
+ RISC-V machine. This virtual machine is intended for RISC-V software
+ development and tests. More details on this platform can be found in the
+ file *[qemu_virt.md]*.
* **QEMU SiFive Unleashed Machine**: Platform support for the *sifive_u* QEMU
virtual RISC-V machine. This is an emulation machine of the HiFive Unleashed
@@ -18,13 +19,14 @@ OpenSBI currently supports the following virtual and hardware platforms.
*[sifive_fu540.md]*.
* **Kendryte K210 SoC**: Platform support for the Kendryte K210 SoC used on
- boards such as the Kendryte KD233 and Sipeed MAIX Dock boards.
+ boards such as the Kendryte KD233 or the Sipeed MAIX Dock.
The code for these supported platforms can be used as example to implement
support for other platforms. The *platform/template* directory also provides
template files for implementing support for a new platform. The *object.mk*,
-*config.mk* and *platform.c* template files provides enough comments to facilitate
-the implementation.
+*config.mk* and *platform.c* template files provides enough comments to
+facilitate the implementation.
[qemu_virt.md]: qemu_virt.md
[qemu_sifive_u.md]: qemu_sifive_u.md
+[sifive_fu540.md]: sifive_fu540.md