Merge pull request #3 from Thomasb81/fix

AHBBus improvement - Included an option to map bus signals to a custom dict

README.md

@@ -124,6 +124,46 @@ class AHBBus(Bus):
 
 * hexokay
 
+##### Signal customization for your design
+To customize signals name to your design `signals` and `optional_signals` dictionnary can be provide. 
+```python
+AHBBus.from_prefix(
+    dut, 
+    prefix = "slave_driver",
+    signals = {
+        "haddr" : "haddr",
+        "hsize" : "hsize",
+        "htrans" : "htrans",
+        "hwdata" : "hwdata",
+        "hrdata" : "hrdata",
+        "hwrite" : "hwrite",
+        "hready" : "hreadyout",
+        "hresp" : "hresp"
+    }
+,
+    optional_signals = {
+        "hsel" : "hsel",
+        "hready_in" : "hready"
+    }
+)
+```
+
+#### Mandatory vs optional AHB signals
+
+1. AHB Master signals
+
+##### 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
+
+* hburst
+
 ### 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.

cocotbext/ahb/ahb_bus.py

@@ -20,10 +20,24 @@ class AHBBus(Bus):
 
     def __init__(self, entity: SimHandleBase = None,
                  prefix: str = None, **kwargs: Any) -> None:
-        super().__init__(entity, prefix, self._signals,
-                         optional_signals=self._optional_signals, **kwargs)
+
+        name = prefix if prefix is not None else entity._name + '_ahb_bus'
+
+        #Handle default signals or signals overrided at an upper level
+        if "signals" not in kwargs:
+            kwargs["signals"] = self._signals
+        else:
+            entity._log.info(f"AHB ({name}) master use provided signals mapping")
+
+        #Handle default optional_signals or optional_signals overrided at an upper level
+        if "optional_signals" not in kwargs:
+            kwargs["optional_signals"] = self._signals
+        else:
+            entity._log.info(f"AHB ({name}) master use provided optional_signals mapping")
+
+        super().__init__(entity, prefix, **kwargs)
         self.entity = entity
-        self.name = prefix if prefix is not None else entity._name + '_ahb_bus'
+        self.name = name
         self._data_width = len(self.hwdata)
         self._addr_width = len(self.haddr)