From 473641bd3450a74df595281e053c83ab01601ea3 Mon Sep 17 00:00:00 2001 From: Nathaniel Graff Date: Fri, 21 Jun 2019 13:51:05 -0700 Subject: Update docs for contents of SDK Remove mention of the coreip, add QEMU targets Signed-off-by: Nathaniel Graff --- README.md | 28 +++++---------------------- doc/sphinx/contents.rst | 32 ++++++++----------------------- doc/sphinx/userguide/buildingcoreip.rst | 32 ------------------------------- doc/sphinx/userguide/buildingdevboard.rst | 4 ++-- 4 files changed, 15 insertions(+), 81 deletions(-) delete mode 100644 doc/sphinx/userguide/buildingcoreip.rst diff --git a/README.md b/README.md index 65ba13b..0cfa5c8 100644 --- a/README.md +++ b/README.md @@ -29,34 +29,16 @@ operating systems to RISC-V. - Supported Targets: - [SiFive HiFive 1](https://www.sifive.com/boards/hifive1) - sifive-hifive1 - - SiFive HiFive 1 Rev B + - [SiFive HiFive 1 Rev B](https://www.sifive.com/boards/hifive1-rev-b) - sifive-hifive1-revb - [SiFive HiFive Unleashed](https://www.sifive.com/boards/hifive-unleashed) - sifive-hifive-unleashed - [SiFive Freedom E310 Arty](https://github.com/sifive/freedom) - freedom-e310-arty - - SiFive CoreIP RTL - - coreip-e20-rtl - - coreip-e21-rtl - - coreip-e24-rtl - - coreip-e31-rtl - - coreip-e34-rtl - - coreip-s51-rtl - - coreip-s54-rtl - - coreip-e76-rtl - - coreip-s76-rtl - - coreip-u54-rtl - - coreip-u54mc-rtl - - SiFive CoreIP Arty FPGA Evaluation targets - - coreip-e20-arty - - coreip-e21-arty - - coreip-e24-arty - - coreip-e31-arty - - coreip-e34-arty - - coreip-s51-arty - - coreip-s54-arty - - coreip-e76-arty - - coreip-s76-arty + - [QEMU Emulation of the SiFive E31](https://github.com/sifive/riscv-qemu/tree/riscv-qemu-3.1) + - qemu-sifive-e31 + - [QEMU Emulation of the SiFive S51](https://github.com/sifive/riscv-qemu/tree/riscv-qemu-3.1) + - qemu-sifive-s51 - The board support files for the Freedom Metal library are located entirely within a single target directory in `bsp//`. For example, the HiFive 1 board support files for Freedom Metal are entirely within `bsp/sifive-hifive1/` diff --git a/doc/sphinx/contents.rst b/doc/sphinx/contents.rst index 3a20bad..e20777f 100644 --- a/doc/sphinx/contents.rst +++ b/doc/sphinx/contents.rst @@ -11,7 +11,7 @@ Freedom E SDK comes packaged with the following board support packages under the - sifive-hifive1 -- SiFive HiFive 1 Rev B +- `SiFive HiFive 1 Rev B `_ - sifive-hifive1-revb @@ -23,29 +23,13 @@ Freedom E SDK comes packaged with the following board support packages under the - freedom-e310-arty -- SiFive CoreIP RTL - - - coreip-e20-rtl - - coreip-e21-rtl - - coreip-e24-rtl - - coreip-e31-rtl - - coreip-s51-rtl - - coreip-s54-rtl - - coreip-e76-rtl - - coreip-s76-rtl - - coreip-u54-rtl - - coreip-u54mc-rtl - -- SiFive CoreIP Arty FPGA Evaluation targets - - - coreip-e20-arty - - coreip-e21-arty - - coreip-e24-arty - - coreip-e31-arty - - coreip-s51-arty - - coreip-s54-arty - - coreip-e76-arty - - coreip-s76-arty +- `QEMU Emulation of the SiFive E31 `_ + + - qemu-sifive-e31 + +- `QEMU Emulation of the SiFive S51 `_ + + - qemu-sifive-s51 The board support files for the Freedom Metal library are located entirely within a single target directory in ``bsp//``. For example, the HiFive 1 diff --git a/doc/sphinx/userguide/buildingcoreip.rst b/doc/sphinx/userguide/buildingcoreip.rst deleted file mode 100644 index 7fd821e..0000000 --- a/doc/sphinx/userguide/buildingcoreip.rst +++ /dev/null @@ -1,32 +0,0 @@ -Building for SiFive CoreIP -========================== - -Building an Example -------------------- - -To compile a bare-metal RISC-V program: - -.. code-block:: bash - - make [PROGRAM=hello] [TARGET=coreip-e31-rtl] [CONFIGURATION=debug] software - -The square brackets in the above command indicate optional parameters for the -Make invocation. As you can see, the default values of these parameters tell -the build script to build the ``hello`` example for the ``coreip-e31`` target -with the ``debug`` build configuration. If, for example, you wished to build -the ``timer-interrupt`` example for the S51 Core IP target with the ``release`` -configuration, you would instead run the command - -.. code-block:: bash - - make PROGRAM=timer-interrupt TARGET=coreip-s51-rtl CONFIGURATION=release software - -Cleaning a Target Program Build Directory ------------------------------------------ - -The ``clean`` target can be used to restore a target program's directory to a clean state. - -.. code-block:: bash - - make [PROGRAM=hello] [TARGET=coreip-e31-rtl] [CONFIGURATION=debug] clean - diff --git a/doc/sphinx/userguide/buildingdevboard.rst b/doc/sphinx/userguide/buildingdevboard.rst index d972b3a..5d46943 100644 --- a/doc/sphinx/userguide/buildingdevboard.rst +++ b/doc/sphinx/userguide/buildingdevboard.rst @@ -14,12 +14,12 @@ The square brackets in the above command indicate optional parameters for the Make invocation. As you can see, the default values of these parameters tell the build script to build the ``hello`` example for the ``sifive-hifive1`` target using the ``debug`` build configuration. If, for example, you wished to build -the ``timer-interrupt`` example for the S51 Arty FPGA Evaluation target using +the ``timer-interrupt`` example for the Freedom E310 Arty FPGA Evaluation target using the ``release`` build configuration, you would instead run the command .. code-block:: bash - make PROGRAM=timer-interrupt TARGET=coreip-s51-arty CONFIGURATION=release software + make PROGRAM=timer-interrupt TARGET=freedom-e310-arty CONFIGURATION=release software Uploading to the Target Board ----------------------------- -- cgit v1.2.1-18-gbd029