AVL-AXI - Apheleia Verification Library AMBA AXI Verification Component

AVL-AXI has been developed by experienced, industry professional verification engineers to provide a simple,
extensible verification component for the AMBA AXI Bus
developed in Python and the AVL library.

AVL is built on the CocoTB framework, but aims to combine the best elements of
UVM in a more engineer friendly and efficient way.

CocoTB 2.0

AVL-AXI supports CocoTB2.0 https://docs.cocotb.org/en/development/upgrade-2.0.html.

To upgrade follow the instructions given on the link above.

Protocol Features

For full details see the docs. A few of the cache extensions are not supported in the initial release, but the bus features
including most sidebands are supported.

If you are interested contact avl@projectapheleia.net to discuss.

Of the advanced features full support of exclusives and atomic operation are provided in the Subordinate memory model.

Component Features

• Majority of protocol features supported
• Simple RTL interface to interact with HDL and define parameter and configuration options
• Manager sequence, sequencer and driver with easy to control rate limiter and wakeup control
  • Support for pipelined sequence based on control, data or response acknowledge
• Subordinate driver with vanilla, random and memory response patterns (including exclusive and atomic operation support) and rate limiter
• Maximum outstanding transaction and maximum outstanding bytes suppport
• Parallel and independent read and write channels with support for early write data
• Monitor with configurable callbacks for control, data and response phases
• Bandwidth monitor generating bus activity plots over user defined windows during simulation
• Functional coverage including performance measurements
• Searchable trace file generation
• Narrow-transfer lane steering

📦 Installation

Using pip

# Standard build
pip install avl-axi

# Development build
pip install avl-axi[dev]

Install from Source

git clone https://github.com/projectapheleia/avl-axi.git
cd avl

# Standard build
pip install .

# Development build
pip install .[dev]

Alternatively if you want to create a virtual environment rather than install globally a script is provided. This will install, with edit privileges to local virtual environment.

This script assumes you have Graphviz and appropriate simulator installed, so all examples and documentation will build out of the box.

git clone https://github.com/projectapheleia/avl-axi.git
cd avl-axi
source avl-axi.sh

📖 Documentation

In order to build the documentation you must have installed the development build.

Build from Source

cd doc
make html
<browser> build/html/index.html

🏃 Examples

In order to run all the examples you must have installed the development build.

To run all examples:

cd examples

# To run
make -j 8 sim

# To clean
make -j 8 clean

To run an individual example:

cd examples/THE EXAMPLE YOU WANT

# To run
make sim

# To clean
make clean

The examples use the CocoTB Makefile and default to Verilator with all waveforms generated. This can be modified using the standard CocoTB build system.

🧹 Code Style & Linting

This project uses Ruff for linting and formatting.

Check code for issues:

ruff check .

Automatically fix common issues:

ruff check . --fix

📧 Contact

• Email: avl@projectapheleia.net
• GitHub: projectapheleia