Improved readme

Signed-off-by: Anderson Ignacio <anderson@aignacio.com>
aignacio · Oct 29, 2023 · 35cd3b9 · 35cd3b9
1 parent 546b8a4
commit 35cd3b9
Show file tree

Hide file tree

Showing 3 changed files with 258 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,20 @@
-# Cocotb AHB bus driver
-
 [![Lint](https://github.com/aignacio/cocotbext-ahb/actions/workflows/lint.yaml/badge.svg)](https://github.com/aignacio/cocotbext-ahb/actions/workflows/lint.yaml) 
 [![Regression Tests](https://github.com/aignacio/cocotbext-ahb/actions/workflows/test.yaml/badge.svg)](https://github.com/aignacio/cocotbext-ahb/actions/workflows/test.yaml) [![codecov](https://codecov.io/gh/aignacio/cocotbext-ahb/graph/badge.svg?token=RHYCK6SSCC)](https://codecov.io/gh/aignacio/cocotbext-ahb) 
 [![Downloads](https://static.pepy.tech/badge/cocotbext-ahb)](https://pepy.tech/project/cocotbext-ahb)
 
-## Introduction
+# Cocotb AHB bus driver
+
+## Table of Contents
+* [Introduction](#intro)
+* [Installation](#install)
+* [Classes and usage example](#classes)
+* [License](#lic)
+
+## <a name="intro"></a> Introduction
 
 This repository contains AHB drivers (AHB and AHB Lite) and a monitor for [cocotb](https://github.com/cocotb/cocotb).
 
-## Installation
+## <a name="install"></a> Installation
 
 Installation from pip (release version, stable):
 ```bash
@@ -28,31 +34,39 @@ Once the container is up and running, to run the tests through [nox](https://nox
 $ nox -l # See the available build options
 $ nox -s run-3.xx # Replace xx by a python version you want to test
 ```
-The command above will take some time to complete (depends on your machine cfg) because it will run all the tests and its variants, generating waveforms in each `run_dir/*` folder. If you want to run a specific test, to the following:
+The command above will take some time to complete (depends on your machine cfg) because it will run all the tests and its variants, generating waveforms in each `run_dir/*` folder. At the end of the test run, you can open the waveforms for each test in this format using gtkwave:
+```bash
+gtkwave run_dir/sim_build_icarus_(TEST_NAME)/ahb_template.fst  docs_utils/template.gtkw
+```
+
+Running specific tests:
 ```bash
 $ nox -s run-3.10 -- -k "test_ahb_monitor_slave" # Runs on python 3.10, the test_ahb_monitor_slave
 ```
 For the list of test, please check the [`tests/`](tests/) directory.
 
-## Documentation and usage examples
+## <a name="classes"></a> Classes and usage example
 
-The AHB extension is composed by master and slaves, essentially, the following available classes are:
+This AHB extension is composed by master, slaves and a single monitor. Thus, the following available classes are:
 
 * **AHB Master** - WIP for burst support, base class AHB Lite Master
 * **AHB Lite Master** - Perform AHB transactions in non-/pipeline mode
 * **AHB Slave** - WIP for burst support, base class AHB Lite Slave
 * **AHB Lite Slave** - Support any type of AHB transaction but burst with back-pressure option and configurable default value 
+* **AHB Monitor** - Basic monitor to check AHB transactions 
 
-All the different master/slaves and also the monitor requires an **AHBBus** object to be passed to their constructors. This AHBBus defines the pin interface with the dut, some IOs are mandatory but others are optional. In order to create an AHBBus object, here are the two ways.
+### AHB Bus
+
+All the different master/slaves and also the monitor requires an **AHBBus** object to be passed to their constructors. This AHBBus object will map each of the AHB I/F pins the dut, some IOs are mandatory but others are optional. In order to create an AHBBus object, here are the two ways.
 
 With a prefix:
 ```python
 # In case your DUT has some prefix for the AHB I/F
 # For instance if all AHB signals are following this convention:
-# - slave_haddr
-# - slave_hsel
+# - test_haddr
+# - test_hsel
 # - ...
-AHBBus.from_prefix(dut, "slave")
+AHBBus.from_prefix(dut, "test")
 ```
 
 Without a prefix:
@@ -65,7 +79,7 @@ Without a prefix:
 AHBBus.from_entity(dut)
 ```
 
-For reference, down below is the class header of AHB Bus. More arguments cani also be passed as this extends from cocotb-bus base class.
+For reference, down below is the class header of [AHB Bus](cocotbext/ahb/ahb_bus.py). More arguments can also be passed as this extends from [cocotb-bus](https://github.com/cocotb/cocotb-bus) base class.
 ```python
 class AHBBus(Bus):
     _signals = ["haddr", "hsize", "htrans", "hwdata",
@@ -75,36 +89,256 @@ class AHBBus(Bus):
                          "hexcl", "hmaster", "hexokay", "hsel", "hready_in"]
 ```
 
-### Mandatory vs optional AHB signals
+#### Mandatory vs optional AHB signals
 
 1. AHB Master signals
 
-#### Mandatory:
+##### Mandatory
 
 * haddr - Indicates AHB txn address 
 * hsize - Indicates AHB txn size
 * htrans - Indicates AHB txn type
 * hwdata - Indicates AHB data to be written
 * hwrite - Indicates type of AHB txn
 
-#### Optional
+##### Optional
 
 * hburst
 * hmastlock
 * hprot
 * hnonsec
 * hexcl
 * hmaster
-* hexokay
 * hsel 
 * hready_in
 
 2. AHB Slave signals 
 
-#### Mandatory:
+##### Mandatory
 
 * hresp - Indicates AHB txn response type
 * hrdata - Indicates AHB txn read data
 * hready - Indicates AHB slave availability
 
-The basic example of its usage is demonstrated below within the tests that are available.
+##### Optional
+
+* hexokay
+
+### AHB Master
+
+Both AHB Master [WIP] and AHB Lite Master classes have the same constructor arguments. Within the arguments, it is required to pass the AHB Bus object, the clock and reset DUT pins. As optional args, a timeout value in clock cycles (per AHB txn), the default value of the master driven IOs and the name of the object.
+```python
+class AHBLiteMaster:
+    def __init__(
+        self,
+        bus: AHBBus,
+        clock: str,
+        reset: str,
+        timeout: int = 100,
+        def_val: Union[int, str] = "Z",
+        name: str = "ahb_lite",
+        **kwargs,
+    ):
+```
+
+Its methods are composed by **read()**, **write()** and **custom()**. 
+
+#### Write
+
+For writes, the arguments are listed here:
+
+```python
+    async def write(
+        self,
+        address: Union[int, Sequence[int]],
+        value: Union[int, Sequence[int]],
+        size: Optional[Union[int, Sequence[int]]] = None,
+        pip: Optional[bool] = False,
+    ) -> Sequence[dict]:
+```
+
+**Arguments**
+* address - Single or a list of integer addresses to be written
+* value - Single or a list of integer values to be written
+* Optional[size] - Integer number of bytes to be written (for instance, in 32-bit bus, 1, 2 or 4 bytes), default is the max bus size
+* Optional[pip] - Define if the address/data phase will overlap in a pipeline manner or not, default non-pipelined 
+
+**Return**
+* Sequence[dict] - Once all transactions are dispatched and their responses are received, the function returns a list of dict with [AHBResp](cocotbext/ahb/ahb_types.py) responses along with the data.
+
+*Note*: address, value and size have to match their length if provided.
+
+#### Read
+
+For reads, the arguments are listed here:
+
+```python
+    async def read(
+        self,
+        address: Union[int, Sequence[int]],
+        size: Optional[Union[int, Sequence[int]]] = None,
+        pip: Optional[bool] = False,
+    ) -> Sequence[dict]:
+```
+
+**Arguments**
+* address - Single or a list of integer addresses to be read from
+* Optional[size] - Integer number of bytes to be read (for instance, in 32-bit bus, 1, 2 or 4 bytes), default is the max bus size
+* Optional[pip] - Define if the address/data phase will overlap in a pipeline manner or not, default non-pipelined 
+
+**Return**
+* Sequence[dict] - Once all transactions are dispatched and their responses are received, the function returns a list of dict with [AHBResp](cocotbext/ahb/ahb_types.py) responses along with the data.
+
+*Note*: address and size have to match their length if provided.
+
+#### Custom
+
+A third method provides flexibility in case the user wants to perform read or writes together like back-to-back operations such as WAR or RAW. For this, the arguments are listed here:
+
+```python
+    async def custom(
+        self,
+        address: Union[int, Sequence[int]],
+        value: Union[int, Sequence[int]],
+        mode: Union[int, Sequence[int]],
+        size: Optional[Union[int, Sequence[int]]] = None,
+        pip: Optional[bool]
+    ) -> Sequence[dict]:
+```
+
+**Arguments**
+* address - Single or a list of integer addresses to be written to or read from
+* value - Single or a list of integer addresses to be written to or read from
+* mode - Single or a list of operation types - 0 (Read) or 1 (Write)
+* Optional[size] - Integer number of bytes to be written/read (for instance, in 32-bit bus, 1, 2 or 4 bytes), default is the max bus size
+* Optional[pip] - Define if the address/data phase will overlap in a pipeline manner or not, default non-pipelined 
+
+**Return**
+* Sequence[dict] - Once all transactions are dispatched and their responses are received, the function returns a list of dict with [AHBResp](cocotbext/ahb/ahb_types.py) responses along with the data.
+
+*Note*: address, value, mode and size have to match their length if provided.
+
+### AHB Slave
+
+Both AHB Slave [WIP] and AHB Lite Slave classes have the same constructor arguments. Within the arguments, it is required to pass the AHB Bus object, the clock and reset DUT pins. As optional arg, the default value of the slave driven IOs, a generator function to force back-pressure and the name of the object.
+
+```python
+class AHBLiteSlave:
+    def __init__(
+        self,
+        bus: AHBBus,
+        clock: str,
+        reset: str,
+        def_val: Union[int, str] = "Z",
+        bp: Generator[int, None, None] = None,
+        name: str = "ahb_lite",
+        **kwargs,
+    ):
+```
+
+The AHB slaves will not provide any specific data (always zero) or unexpected response, they serve as a basic slave just to check its connectivity while testing AHB Master and as a base class for the AHB Lite Slave RAM. The back-pressure feature is a way to force the slave to demonstrated unavailability while the master issue AHB transactions. The generator needs to return bool type values where bool True indicates slave available and bool False indicate slave unavailable. 
+
+#### AHB Lite Slave RAM 
+
+The AHB Lite Slave RAM is a basic memory slave that can receive reads and write like a normal memory-mapped device. The only difference between the normal slave vs this one is the fact that as part of its constructor, a new argument **mem_size** is listed. This argument defines a memory size in bytes for the AHB slave. The only limitation for now, is the fact that all memory addresses have to be aligned to the data bus width, i.e for 32-bit slaves, address[1:0] == 2'b00.
+
+```python
+class AHBLiteSlaveRAM(AHBLiteSlave):
+    def __init__(
+        self,
+        bus: AHBBus,
+        clock: str,
+        reset: str,
+        def_val: Union[int, str] = "Z",
+        bp: Generator[int, None, None] = None,
+        name: str = "ahb_lite_ram",
+        mem_size: int = 1024,
+        **kwargs,
+    ):
+```
+
+Thank you [@alexforencich](https://github.com/alexforencich/cocotbext-axi) for your work on the memory classes that were leveraged in this project.
+
+### AHB Monitor
+
+A basic AHB monitor was also developed, the idea is to ensure that basic protocol assumptions are respected throughout assertions, its constructor arguments are very similar to the previous discussed classes. For now, only two aspects are checked through this monitor, the first one ensure the master does not change its address phase transaction qualifier once a transaction is issued and the slave is not available. The second property checks that an AHB error response coming from the slave is following the 2-cycle response defined in the AMBA spec.
+
+```python
+class AHBMonitor:
+    def __init__(
+        self,
+        bus: AHBBus,
+        clock: str,
+        reset: str,
+        name: str = "ahb_monitor",
+        **kwargs,
+    ):
+```
+
+### Example
+
+A basic example of this extension usage is demonstrated below and also within the [tests folder](test/) that are available.
+
+```python
+import cocotb
+import os
+import random
+import math
+
+from const import cfg
+from cocotb_test.simulator import run
+from cocotb.triggers import ClockCycles
+from cocotb.clock import Clock
+from cocotbext.ahb import AHBBus, AHBLiteMaster, AHBLiteSlaveRAM, AHBResp, AHBMonitor
+
+def rnd_val(bit: int = 0, zero: bool = True):
+    if zero is True:
+        return random.randint(0, (2**bit) - 1)
+    else:
+        return random.randint(1, (2**bit) - 1)
+
+
+def pick_random_value(input_list):
+    if input_list:
+        return random.choice(input_list)
+    else:
+        return None  # Return None if the list is empty
+
+async def run_test(dut):
+    data_width = 32
+    mem_size_kib = 16
+    N = 1000
+
+    # Map the bus monitor to the I/F slave_h* I/F
+    ahb_lite_mon = AHBMonitor(
+        AHBBus.from_prefix(dut, "slave"), dut.hclk, dut.hresetn
+    )
+
+    # Create an AHB Lite Slave RAM connected to the master I/F
+    ahb_lite_sram = AHBLiteSlaveRAM(
+        AHBBus.from_prefix(dut, "master"),
+        dut.hclk,
+        dut.hresetn,
+        def_val=0,
+        bp=bp_fn,
+        mem_size=mem_size_kib * 1024,
+    )
+
+    # Create an AHB Lite Master connected to the slave I/F
+    ahb_lite_master = AHBLiteMaster(
+        AHBBus.from_prefix(dut, "slave"), dut.hclk, dut.hresetn, def_val="Z"
+    )
+
+    # Create a lit of non-repeated addresses spaces by 8 from 0->2*current RAM size
+    address = random.sample(range(0, 2 * mem_size_kib * 1024, 8), N)
+    value = [rnd_val(data_width) for _ in range(N)]
+    size = [pick_random_value([1, 2, 4]) for _ in range(N)]
+
+    # Perform the writes and reads
+    resp = await ahb_lite_master.write(address, value, size, pip=pip_mode)
+    resp = await ahb_lite_master.read(address, size, pip=pip_mode)
+
+```
+
+## <a name="lic"></a> License
+cocotbext-ahb is licensed under the permissive MIT license.Please refer to the [LICENSE](LICENSE) file for details.
diff --git a/cocotbext/ahb/ahb_master.py b/cocotbext/ahb/ahb_master.py
@@ -4,7 +4,7 @@
 # License           : MIT license <Check LICENSE>
 # Author            : Anderson I. da Silva (aignacio) <anderson@aignacio.com>
 # Date              : 08.10.2023
-# Last Modified Date: 27.10.2023
+# Last Modified Date: 29.10.2023
 
 import cocotb
 import logging
@@ -15,7 +15,7 @@
 from .version import __version__
 
 from cocotb.triggers import RisingEdge
-from typing import Optional, Sequence, Union
+from typing import Optional, Sequence, Union, List
 from cocotb.types import LogicArray
 from cocotb.binary import BinaryValue
 
@@ -211,7 +211,7 @@ async def write(
         value: Union[int, Sequence[int]],
         size: Optional[Union[int, Sequence[int]]] = None,
         pip: Optional[bool] = False,
-    ) -> Sequence[AHBResp]:
+    ) -> Sequence[dict]:
         """Write data in the AHB bus."""
 
         if not isinstance(address, list):
@@ -269,7 +269,7 @@ async def read(
         address: Union[int, Sequence[int]],
         size: Optional[Union[int, Sequence[int]]] = None,
         pip: Optional[bool] = False,
-    ) -> Sequence[AHBResp]:
+    ) -> Sequence[dict]:
         """Read data from the AHB bus."""
 
         if not isinstance(address, list):
@@ -320,7 +320,7 @@ async def custom(
         mode: Union[int, Sequence[int]],
         size: Optional[Union[int, Sequence[int]]] = None,
         pip: Optional[bool] = True,
-    ) -> Sequence[AHBResp]:
+    ) -> Sequence[dict]:
         """Back-to-Back operation"""
 
         if len(address) != len(value):

diff --git a/cocotbext/ahb/version.py b/cocotbext/ahb/version.py
@@ -1 +1 @@
-__version__ = "0.1.0"
+__version__ = "0.1.1"