From 8ecd79b03057f6766d64fb7bcfaf44df5ee8cb7f Mon Sep 17 00:00:00 2001
From: AJacquin <axel.c.e.jacquin@gmail.com>
Date: Sat, 2 Nov 2024 10:58:02 +0100
Subject: [PATCH] feat: make SpiBus signals names more flexible (#21)

* feat: make SpiBus signals names more flexible
* fix: regression-tests.yml run pipes
---
 .github/workflows/regression-tests.yml |  6 +++---
 README.md                              | 27 +++++++++++++++++++-------
 cocotbext/spi/spi.py                   |  9 +++------
 3 files changed, 26 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/regression-tests.yml b/.github/workflows/regression-tests.yml
index d8371b0..80f6684 100644
--- a/.github/workflows/regression-tests.yml
+++ b/.github/workflows/regression-tests.yml
@@ -20,10 +20,10 @@ jobs:
         python-version: ${{matrix.python-version}}
 
     - name: Install Icarus Verilog
-      run:
+      run: |
         sudo apt install -y --no-install-recommends iverilog
     - name: Install Python dependencies
-      run:
+      run: |
         python -m pip install --upgrade pip
         pip install tox tox-gh-actions
     - name: Test with tox
@@ -40,7 +40,7 @@ jobs:
           python-version: '3.10'
         uses: actions/setup-python@v4
       - name: Install pdm
-        run:
+        run: |
           python -m pip install --upgrade pip
           pip install pdm
       - name: Publish to PyPI
diff --git a/README.md b/README.md
index 0d0132d..d9d2407 100644
--- a/README.md
+++ b/README.md
@@ -13,16 +13,19 @@ SPI simulation framework for [cocotb](https://github.com/cocotb/cocotb).
 ## Installation
 
 Installation from pip (release version, stable):
+
 ```bash
 pip install cocotbext-spi
 ```
 
 Installation from git (latest development version, potentially unstable):
+
 ```bash
 pip install https://github.com/schang412/cocotbext-spi/archive/main.zip
 ```
 
 Installation for active development:
+
 ```bash
 git clone https://github.com/schang412/cocotbext-spi
 pip install -e cocotbext-spi
@@ -37,6 +40,7 @@ See the `tests` directory for complete testbenches using these modules.
 The SPI bus signals are bundled together into a `SpiBus` class.
 
 If the port instantiations look like:
+
 ```verilog
 module my_module(
     input  wire sclk, 
@@ -44,14 +48,17 @@ module my_module(
     output wire miso,
     input  wire cs,  // active-low
 )
+
 ```
 The `SpiBus` class can be created as:
+
 ```python
 from cocotbext.spi import SpiBus
 spi_bus = SpiBus.from_entity(dut)
 ```
 
 If there is some prefix, the `from_prefix` class method may be used:
+
 ```verilog
 module my_module(
     input  wire spi0_sclk, 
@@ -60,21 +67,24 @@ module my_module(
     input  wire spi0_cs,  // active-low
 )
 ```
+
 ```python
 spi_bus = SpiBus.from_prefix(dut, "spi0")
 ```
 
-If the chip select has been renamed for clarity:
+If some signals have been renamed for clarity:
+
 ```verilog
 module my_module(
-    input  wire spi0_sclk, 
-    input  wire spi0_mosi,
-    output wire spi0_miso,
-    input  wire spi0_ncs,  // active-low
+    input  wire spi0__sck,
+    input  wire spi0__mosi,
+    output wire spi0__miso,
+    input  wire spi0__ncs,  // active-low
 )
 ```
+
 ```python
-spi_bus = SpiBus.from_prefix(dut, "spi0", cs_name="ncs")
+spi_bus = SpiBus.from_prefix(dut, "spi0", bus_separator="__", sclk_name="sck", cs_name="ncs")
 ```
 
 ### SPI Config
@@ -82,6 +92,7 @@ spi_bus = SpiBus.from_prefix(dut, "spi0", cs_name="ncs")
 SPI Configuration parameters are bundled together into a `SpiConfig` class.
 
 To create the object simply call it like a class and pass in arguments:
+
 ```python
 from cocotbext.spi import SpiConfig
 
@@ -139,10 +150,12 @@ read_bytes = await spi_masetr.read()
 ```
 
 #### Constructor Parameters
+
 - `bus`: SpiBus
 - `config`: SpiConfig
 
 #### Methods
+
 - `write(data)`: send data (blocking)
 - `write_nowait(data)`: send data (non-blocking)
 - `read(count=-1)`: read count bytes from buffer, reading whole buffer by default (blocking)
@@ -187,6 +200,7 @@ spi_slave = SimpleSpiSlave(SpiBus.from_entity(dut))
 #### Implementation
 
 All SPI Slave Classes should:
+
 - inherit the SpiSlaveBase class
 - define `self._config` adjust the values for:
     - `word_width`
@@ -202,7 +216,6 @@ All SPI Slave Classes should:
         - `self.idle` is automatically set when `_transaction` returns
 - when implementing a method to read the class contents, make sure to await the `self.idle`, otherwise the data may not be up to date because the device is in the middle of a transaction.
 
-
 #### Simulated Devices
 
 This framework includes some SPI Slave devices built in. A list of supported devices can be found in `cocotbext/spi/devices` and are sorted by vendor.
diff --git a/cocotbext/spi/spi.py b/cocotbext/spi/spi.py
index 5211ba7..335805f 100644
--- a/cocotbext/spi/spi.py
+++ b/cocotbext/spi/spi.py
@@ -24,12 +24,9 @@
 
 
 class SpiBus(Bus):
-    _signals = ['sclk', 'mosi', 'miso', 'cs']
-
-    def __init__(self, entity=None, prefix=None, **kwargs):
-        cs_name = kwargs.pop('cs_name', 'cs')
-        signals = dict(zip(self._signals, self._signals[0:3] + [cs_name]))
-        super().__init__(entity, prefix, signals, optional_signals=[], **kwargs)
+    def __init__(self, entity=None, prefix=None, sclk_name='sclk', mosi_name='mosi', miso_name='miso', cs_name='cs', **kwargs):
+        signals = {'sclk': sclk_name, 'mosi': mosi_name, 'miso': miso_name, 'cs': cs_name}
+        super().__init__(entity, prefix, signals, **kwargs)
 
     @classmethod
     def from_entity(cls, entity, **kwargs):