diff options
| author | Prashanth Mundkur <prashanth.mundkur@gmail.com> | 2019-01-22 10:27:07 -0800 |
|---|---|---|
| committer | Prashanth Mundkur <prashanth.mundkur@gmail.com> | 2019-01-22 10:27:22 -0800 |
| commit | 96315109c65958c28246fb78eb55e6c5d6c0c296 (patch) | |
| tree | fbf2ffa3bdfceccc96579c83893eb31375e82a15 /doc/ReadingGuide.md | |
| parent | 86319c9398d5e10d9def426020f7cd0e83bd701b (diff) | |
| download | sail-riscv-96315109c65958c28246fb78eb55e6c5d6c0c296.zip sail-riscv-96315109c65958c28246fb78eb55e6c5d6c0c296.tar.gz sail-riscv-96315109c65958c28246fb78eb55e6c5d6c0c296.tar.bz2 | |
Add an initial draft of an extending guide.
Diffstat (limited to 'doc/ReadingGuide.md')
| -rw-r--r-- | doc/ReadingGuide.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/ReadingGuide.md b/doc/ReadingGuide.md index f5e365b..d60186e 100644 --- a/doc/ReadingGuide.md +++ b/doc/ReadingGuide.md @@ -8,7 +8,9 @@ manual](https://github.com/rems-project/sail/blob/sail2/manual.pdf) handy. The model contains the following Sail modules in the `model` directory: - `prelude.sail` contains useful Sail library functions. This file - should be referred to as needed. + should be referred to as needed. The lowest level memory access + primitives are defined in this file, and are typically implemented + by the various Sail backends. - `riscv_types.sail` contains some basic RISC-V definitions. This file should be read first, since it provides basic definitions that @@ -69,3 +71,6 @@ The model contains the following Sail modules in the `model` directory: - `riscv_analysis.sail` is used in the formal operational RVWMO memory model. + +Note that the files above are listed in dependency order, i.e. files +earlier in the order do not depend on later files. |