RiscwatchEngine

Protocol engine for the RISCwatch hardware debug protocol.

Repository Components

riscwatchengine/
├── README.md
├── pyproject.toml
├── config/
│   ├── requirements.txt
│   └── ...
├── examples/
│   └── ...
├── scripts/
│   ├── rwdecoder.py
│   └── ...
├── src/
│   └── riscwatch_engine
│       ├── engine/
│       │   ├── bdm.py
│       │   ├── generator.py
│       │   ├── interfaces.py
│       │   ├── jtag.py
│       │   ├── registers.py
│       │   ├── timer.py
│       │   └── util.py
│       ├── hl/
│       │   ├── abi.py
│       │   └── highlevel.py
│       └── py.typed
└── tests/
    └── ...

Hover over a component name for more information

Initial setup

1. Set up a python virtual environment (venv)

   sudo apt install python3.10-venv
   python3.10 -m venv venv
   source venv/bin/activate
   pip install -e '.[dev]'

Generate and Install a Wheel Package

1. Generate package locally

   source .venv/bin/activate
   pip wheel .   # Creates riscwatch_engine-1.0.0-py3-none-any.whl

Running Linters, Type-Checking, and Tests Locally

1. Linting (yapf+isort)

   tox run -e lint

2. Reformat All

   tox run -e format

3. Type-Checking (mypy)

   tox run -e type

4. Tests (pytest)

   tox run -e py310  # or other version if such an env exists for tox to find

5. Run All Checks

   tox run -e lint,type,py310