Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Switch to a better buildroot mirror
- CI frees up space in the runner before building a toolchain
- Update documentation
- Enhance Cheshire's documentation for better workflow integration with Ara

## 3.0.0 - 2023-09-08

Expand Down
25 changes: 23 additions & 2 deletions cheshire/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,33 @@ Ara can be synthesized on a VCU128 FPGA and boot Linux through the Cheshire SoC.

Our entry point is to generate a custom `add_sources.vcu128.tcl` file with specific Ara targets, copy this file into the Cheshire directory, and then use the default Cheshire compile flow, which will use our provided TCL file

## Requirements
From Cheshire's [web documentation](https://pulp-platform.github.io/cheshire/gs/#dependencies), ensure you have the next dependencies:

- GNU make >= 3.82
- CMake >= 3.24.0
- Python >= 3.11
- Bender >= 0.27.1
- RISCV GCC >= 11.2.0

> [!TIP]
> Check [Bender](https://github.com/pulp-platform/bender) repository to install it

For Python dependencies, it is highly recommended to create a virtual environment and install all packages listed in `requirements.txt`

```bash
python3 -m venv .venv
source .venv/bin/activate

pip install -r requirements.txt
```

## How to Use

Ara should be instantiated as a submodule of Cheshire. This means that the Ara repo should be downloaded through `bender checkout` from the Cheshire directory. Then, Ara's path can be retrived using `bender path ara`.
Ara should be instantiated as a submodule of Cheshire. This means that the Ara repo should be downloaded through `bender checkout` from the Cheshire directory, more specifically, the `mp/ara-pulp-v2` branch, which includes the CVA6 connected to the Ara. Then, Ara's path can be retrived using `bender path ara`.

```bash
git clone git@github.com:pulp-platform/cheshire.git
git clone --branch=mp/ara-pulp-v2 https://github.com/pulp-platform/cheshire.git
cd cheshire
git checkout ${COMMIT}
bender checkout
Expand Down
28 changes: 28 additions & 0 deletions cheshire/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# University Institute of Applied Microelectronics
# https://www.iuma.ulpgc.es/
# Author: Jorge López Viera
# This file includes the Python's dependencies for
# both the Cheshire and Ara

requests
hjson
mako
pyyaml
tabulate
yapf
mkdocs
mkdocs-material
markdown-grid-tables
tclint==0.4.2
flatdict>=4.1.0
setuptools<81
peakrdl>=1.5.0
peakrdl-rawheader>=0.2.3
dataclasses
gitpython
jsonref
jsonschema
yamlfmt
numpy
matplotlib
scikit-learn