diff options
| author | Nathaniel Graff <nathaniel.graff@sifive.com> | 2019-02-15 09:34:18 -0800 |
|---|---|---|
| committer | Nathaniel Graff <nathaniel.graff@sifive.com> | 2019-02-15 09:34:18 -0800 |
| commit | 1caeb4eec588c471b33120142593dee66517d77a (patch) | |
| tree | 8e214cbc600efc09faef4ea749d8a58d442463ed /doc/sphinx | |
| parent | 5d713aebb10998e6269e0c3dc690828cc0edc472 (diff) | |
Add more documentation to user guide
Also adds mention of example-spi to SDK contents
Signed-off-by: Nathaniel Graff <nathaniel.graff@sifive.com>
Diffstat (limited to 'doc/sphinx')
| -rw-r--r-- | doc/sphinx/contents.rst | 4 | ||||
| -rw-r--r-- | doc/sphinx/userguide/buildingcoreip.rst | 2 | ||||
| -rw-r--r-- | doc/sphinx/userguide/buildingdevboard.rst | 19 |
3 files changed, 25 insertions, 0 deletions
diff --git a/doc/sphinx/contents.rst b/doc/sphinx/contents.rst index b207a56..e7a7613 100644 --- a/doc/sphinx/contents.rst +++ b/doc/sphinx/contents.rst @@ -22,6 +22,7 @@ Freedom E SDK comes packaged with the following board support packages under the - SiFive CoreIP Arty FPGA Evaluation targets + - coreip-e24-arty - coreip-e31-arty - coreip-s51-arty @@ -107,3 +108,6 @@ The example programs can be found under the ``software/`` directory. - Demonstrates how to configure a Physical Memory Protection (PMP) region +- example-spi + + - Demonstrates how to use the SPI API to transfer bytes to a peripheral diff --git a/doc/sphinx/userguide/buildingcoreip.rst b/doc/sphinx/userguide/buildingcoreip.rst index a6f1dae..5af29fb 100644 --- a/doc/sphinx/userguide/buildingcoreip.rst +++ b/doc/sphinx/userguide/buildingcoreip.rst @@ -23,6 +23,8 @@ Core IP target, you would instead run the command 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 BSP=mee [PROGRAM=hello] [TARGET=coreip-e31] clean diff --git a/doc/sphinx/userguide/buildingdevboard.rst b/doc/sphinx/userguide/buildingdevboard.rst index 4b5822b..b276d51 100644 --- a/doc/sphinx/userguide/buildingdevboard.rst +++ b/doc/sphinx/userguide/buildingdevboard.rst @@ -23,6 +23,13 @@ Arty FPGA Evaluation target, you would instead run the command Uploading to the Target Board ----------------------------- +Uploading a program to the target development or FPGA board depends on having both +the RISC-V GNU Toolchain and RISC-V OpenOCD installed on your development system. +See :doc:`installing` for more information on installing OpenOCD. + +With the toolchain and OpenOCD installed, uploading a program is as simple as plugging +the development board into your computer and running the following command: + .. code-block:: bash make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] upload @@ -30,6 +37,16 @@ Uploading to the Target Board Debugging a Target Program -------------------------- +Debugging a program on a target development or FPGA board depends on having both +the RISC-V GNU Toolchain and RISC-V OpenOCD installed on your development system. +See :doc:`installing` for more information on installing OpenOCD. + +Debugging with Freedom E SDK also assumes that the program has already been uploaded to +the target board. + +With the toolchain and OpenOCD installed, debugging a program is as simple as plugging +the development board into your computer and running the following command: + .. code-block:: bash make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] debug @@ -37,6 +54,8 @@ Debugging a Target Program 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 BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] clean |