Skip to content

Commit

Permalink
documentation for rocket chip as target
Browse files Browse the repository at this point in the history
  • Loading branch information
debs-sifive authored and jeremybennett committed Jan 29, 2019
1 parent 3b51d43 commit 7dcb91d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ Jeremy Bennett, Mary Bennett, Simon Davidmann, Neel Gala, Radek Hajek, Lee Moore
[cols="<1,<2,<3,<4",options="header,pagewidth",]
|================================================================================
| _Revision_ | _Date_ | _Author_ | _Modification_
| 1.13 Draft | 29 January 2019 |
Deborah Soung |

Added documentation on how to use Rocket Chip generated cores as targets.
| 1.12 Draft | 22 November 2018 |
Simon Davidmann |

Expand Down Expand Up @@ -349,6 +353,16 @@ tbd
=== Berkeley Spike ISA simulator
For spike the file `riscv-target/spike/compliance_io.h` has the trace macros defined as empty. The Makefile fragment in `riscv-target/spike/device/rv32i` has the spike run command for the RV32I device.

=== Rocket Chip emulators
Additional environment variables:

* `ROCKET_DIR`: Specifies link:https://github.com/freechipsproject/rocket-chip[Rocket Chip] directory. Required.
* `ROCKET_CONFIG`: Specifies Rocket Chip link:https://github.com/freechipsproject/rocket-chip/blob/master/src/main/scala/system/Configs.scala[configuration]. **Usually** defaults to `DefaultConfig` or `DefaultRV32Config`, unless the aforementioned configurations do not support a test suite's ISA extensions (for example, in the case of `rv32ud`).

Before running the compliance test, make sure that the correct emulator is built, following the link:https://github.com/freechipsproject/rocket-chip#emulator[instructions in the Rocket Chip repository].

**Note**: Rocket Chip's `DefaultRV32Config` is currently failing the following tests — link:https://github.com/riscv/riscv-compliance/issues/31[rv32i/I-MISALIGN_JMP-01.S], link:https://github.com/riscv/riscv-compliance/issues/32[rv32mi/breakpoint.S], link:https://github.com/riscv/riscv-compliance/issues/33[rv32si/ma_fetch.S].

=== SiFive Freedom Unleashed 540 board (tbd)

tbd
Expand Down

0 comments on commit 7dcb91d

Please sign in to comment.