From 4ba3d24288ebb88c6c25ecbebe7ee95010c41d86 Mon Sep 17 00:00:00 2001 From: Nathaniel Graff <nathaniel.graff@sifive.com> Date: Thu, 7 Mar 2019 09:32:00 -0800 Subject: Update docs to remove legacy Signed-off-by: Nathaniel Graff <nathaniel.graff@sifive.com> --- doc/sphinx/userguide/benchmarking.rst | 55 ------------------------------- doc/sphinx/userguide/buildingcoreip.rst | 6 ++-- doc/sphinx/userguide/buildingdevboard.rst | 10 +++--- doc/sphinx/userguide/standalone.rst | 2 +- 4 files changed, 9 insertions(+), 64 deletions(-) delete mode 100644 doc/sphinx/userguide/benchmarking.rst (limited to 'doc/sphinx/userguide') diff --git a/doc/sphinx/userguide/benchmarking.rst b/doc/sphinx/userguide/benchmarking.rst deleted file mode 100644 index b308adb..0000000 --- a/doc/sphinx/userguide/benchmarking.rst +++ /dev/null @@ -1,55 +0,0 @@ -Benchmarking -============ - -The Dhrystone and CoreMark benchmarks are still only supported by the Legacy -Freedom E SDK. When we port the benchmarks to Freedom Metal, we will update -this section to describe the updated build steps. - -Dhrystone ---------- - -After setting up the software and debug toolchains, you can build and -execute everyone's favorite benchmark as follows: - -- Compile the benchmark with the command ``make software TARGET=freedom-e300-hifive1 PROGRAM=dhrystone LINK_TARGET=dhrystone``. Note that a slightly different linker file is used for Dhrystone which stores read only data in DTIM instead of external flash. -- Run on the HiFive1 board with the command ``make upload TARGET=freedom-e300-hifive1 PROGRAM=dhrystone``. - This will take a few minutes. Sample output is provided below. -- Compute DMIPS by dividing the Dhrystones per Second result by 1757, which - was the VAX 11/780's performance. In the example below, 729927 / 1757 = - 415 DMIPS. -- Compute DMIPS/MHz by dividing by the clock rate: in the example below, - 415 / 268 = 1.55 DMIPS/MHz. - -.. code-block:: none - - core freq at 268694323 Hz - - Dhrystone Benchmark, Version 2.1 (Language: C) - - <snip> - - Microseconds for one run through Dhrystone: 1.3 - Dhrystones per Second: 729927.0 - -CoreMark --------- - -We cannot distribute the CoreMark benchmark, but following are instructions -to download and run the benchmark on the HiFive1 board: - -- Download CoreMark from EEMBC's web site and extract the archive from - `<http://www.eembc.org/coremark/download.php>`_. -- Copy the following files from the extracted archive into the - ``software/coremark`` directory in this repository: - - - ``core_list_join.c`` - - ``core_main.c`` - - ``coremark.h`` - - ``core_matrix.c`` - - ``core_state.c`` - - ``core_util.c`` - -- Compile the benchmark with the command ``make software PROGRAM=coremark``. -- Run on the HiFive1 board with the command ``make upload PROGRAM=coremark``. -- Divide the reported Iterations/Sec by the reported core frequency in MHz to - obtain a CoreMarks/MHz value. diff --git a/doc/sphinx/userguide/buildingcoreip.rst b/doc/sphinx/userguide/buildingcoreip.rst index 5af29fb..7479931 100644 --- a/doc/sphinx/userguide/buildingcoreip.rst +++ b/doc/sphinx/userguide/buildingcoreip.rst @@ -8,7 +8,7 @@ To compile a bare-metal RISC-V program: .. code-block:: bash - make BSP=mee [PROGRAM=hello] [TARGET=coreip-e31] software + make [PROGRAM=hello] [TARGET=coreip-e31] 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 @@ -18,7 +18,7 @@ Core IP target, you would instead run the command .. code-block:: bash - make BSP=mee PROGRAM=timer-interrupt TARGET=coreip-s51 software + make PROGRAM=timer-interrupt TARGET=coreip-s51 software Cleaning a Target Program Build Directory ----------------------------------------- @@ -27,5 +27,5 @@ The ``clean`` target can be used to restore a target program's directory to a cl .. code-block:: bash - make BSP=mee [PROGRAM=hello] [TARGET=coreip-e31] clean + make [PROGRAM=hello] [TARGET=coreip-e31] clean diff --git a/doc/sphinx/userguide/buildingdevboard.rst b/doc/sphinx/userguide/buildingdevboard.rst index b276d51..a5d364d 100644 --- a/doc/sphinx/userguide/buildingdevboard.rst +++ b/doc/sphinx/userguide/buildingdevboard.rst @@ -8,7 +8,7 @@ To compile a bare-metal RISC-V program: .. code-block:: bash - make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] software + make [PROGRAM=hello] [TARGET=sifive-hifive1] 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 @@ -18,7 +18,7 @@ Arty FPGA Evaluation target, you would instead run the command .. code-block:: bash - make BSP=mee PROGRAM=timer-interrupt TARGET=coreip-s51-arty software + make PROGRAM=timer-interrupt TARGET=coreip-s51-arty software Uploading to the Target Board ----------------------------- @@ -32,7 +32,7 @@ the development board into your computer and running the following command: .. code-block:: bash - make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] upload + make [PROGRAM=hello] [TARGET=sifive-hifive1] upload Debugging a Target Program -------------------------- @@ -49,7 +49,7 @@ the development board into your computer and running the following command: .. code-block:: bash - make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] debug + make [PROGRAM=hello] [TARGET=sifive-hifive1] debug Cleaning a Target Program Build Directory ----------------------------------------- @@ -58,5 +58,5 @@ The ``clean`` target can be used to restore a target program's directory to a cl .. code-block:: bash - make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] clean + make [PROGRAM=hello] [TARGET=sifive-hifive1] clean diff --git a/doc/sphinx/userguide/standalone.rst b/doc/sphinx/userguide/standalone.rst index 61214d2..ee31362 100644 --- a/doc/sphinx/userguide/standalone.rst +++ b/doc/sphinx/userguide/standalone.rst @@ -15,5 +15,5 @@ be included in the generated project as a pre-built archive. .. code-block:: bash - make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] [INCLUDE_METAL_SOURCES=1] STANDALONE_DEST=/path/to/desired/location standalone + make [PROGRAM=hello] [TARGET=sifive-hifive1] [INCLUDE_METAL_SOURCES=1] STANDALONE_DEST=/path/to/desired/location standalone -- cgit v1.2.3