Add generic stream classes
This commit is contained in:
Alex Forencich
389
cocotbext/axi/stream.py
Normal file
389
cocotbext/axi/stream.py
Normal file
@@ -0,0 +1,389 @@
|
||||
"""
|
||||
|
||||
Copyright (c) 2020 Alex Forencich
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
"""
|
||||
|
||||
import cocotb
|
||||
from cocotb.triggers import RisingEdge, ReadOnly, Event
|
||||
from cocotb.bus import Bus
|
||||
from cocotb.log import SimLog
|
||||
|
||||
from collections import deque
|
||||
|
||||
|
||||
class StreamTransaction(object):
|
||||
pass
|
||||
|
||||
|
||||
class StreamSource(object):
|
||||
|
||||
_signals = ["data", "valid", "ready"]
|
||||
_optional_signals = []
|
||||
|
||||
_signal_widths = {"valid": 1, "ready": 1}
|
||||
|
||||
_valid_signal = "valid"
|
||||
_ready_signal = "ready"
|
||||
|
||||
_transaction_obj = StreamTransaction
|
||||
|
||||
def __init__(self, entity, name, clock, reset=None, *args, **kwargs):
|
||||
self.log = SimLog("cocotb.%s.%s" % (entity._name, name))
|
||||
self.entity = entity
|
||||
self.clock = clock
|
||||
self.reset = reset
|
||||
self.bus = Bus(self.entity, name, self._signals, optional_signals=self._optional_signals, **kwargs)
|
||||
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
self.queue = deque()
|
||||
self.queue_sync = Event()
|
||||
|
||||
self.drive_obj = None
|
||||
self.drive_sync = Event()
|
||||
|
||||
self.ready = None
|
||||
self.valid = None
|
||||
|
||||
if hasattr(self.bus, self._ready_signal):
|
||||
self.ready = getattr(self.bus, self._ready_signal)
|
||||
|
||||
if hasattr(self.bus, self._valid_signal):
|
||||
self.valid = getattr(self.bus, self._valid_signal)
|
||||
self.valid.setimmediatevalue(0)
|
||||
|
||||
for sig in self._signals+self._optional_signals:
|
||||
if hasattr(self.bus, sig):
|
||||
if sig in self._signal_widths:
|
||||
assert len(getattr(self.bus, sig)) == self._signal_widths[sig]
|
||||
if sig not in (self._valid_signal, self._ready_signal):
|
||||
v = getattr(self.bus, sig).value
|
||||
v.binstr = 'x'*len(v)
|
||||
getattr(self.bus, sig).setimmediatevalue(v)
|
||||
|
||||
self.active = False
|
||||
self.pause = False
|
||||
|
||||
cocotb.fork(self._run_source())
|
||||
cocotb.fork(self._run())
|
||||
|
||||
async def drive(self, obj):
|
||||
if self.drive_obj is not None:
|
||||
self.drive_sync.clear()
|
||||
await self.drive_sync.wait()
|
||||
|
||||
self.drive_obj = obj
|
||||
|
||||
def send(self, obj):
|
||||
self.queue.append(obj)
|
||||
self.queue_sync.set()
|
||||
|
||||
def count(self):
|
||||
return len(self.queue)
|
||||
|
||||
def empty(self):
|
||||
return not self.queue
|
||||
|
||||
def idle(self):
|
||||
return self.empty() and not self.active
|
||||
|
||||
async def wait(self):
|
||||
while not self.idle():
|
||||
await RisingEdge(self.clock)
|
||||
|
||||
def clear(self):
|
||||
self.queue = deque()
|
||||
self.drive_obj = None
|
||||
self.drive_sync.set()
|
||||
|
||||
async def _run_source(self):
|
||||
while True:
|
||||
await ReadOnly()
|
||||
|
||||
# read handshake signals
|
||||
ready_sample = self.ready is None or self.ready.value
|
||||
valid_sample = self.valid is None or self.valid.value
|
||||
|
||||
if self.reset is not None and self.reset.value:
|
||||
await RisingEdge(self.clock)
|
||||
self.clear()
|
||||
if self.valid is not None:
|
||||
self.valid <= 0
|
||||
self.active = False
|
||||
continue
|
||||
|
||||
await RisingEdge(self.clock)
|
||||
|
||||
if (ready_sample and valid_sample) or (not valid_sample):
|
||||
if self.drive_obj:
|
||||
if not self.pause:
|
||||
self.bus.drive(self.drive_obj)
|
||||
self.drive_obj = None
|
||||
self.drive_sync.set()
|
||||
if self.valid is not None:
|
||||
self.valid <= 1
|
||||
self.active = True
|
||||
else:
|
||||
if self.valid is not None:
|
||||
self.valid <= 0
|
||||
self.active = False
|
||||
|
||||
async def _run(self):
|
||||
while True:
|
||||
while not self.queue:
|
||||
self.queue_sync.clear()
|
||||
await self.queue_sync.wait()
|
||||
|
||||
await self.drive(self.queue.popleft())
|
||||
|
||||
|
||||
class StreamSink(object):
|
||||
|
||||
_signals = ["data", "valid", "ready"]
|
||||
_optional_signals = []
|
||||
|
||||
_signal_widths = {"valid": 1, "ready": 1}
|
||||
|
||||
_valid_signal = "valid"
|
||||
_ready_signal = "ready"
|
||||
|
||||
_transaction_obj = StreamTransaction
|
||||
|
||||
def __init__(self, entity, name, clock, reset=None, *args, **kwargs):
|
||||
self.log = SimLog("cocotb.%s.%s" % (entity._name, name))
|
||||
self.entity = entity
|
||||
self.clock = clock
|
||||
self.reset = reset
|
||||
self.bus = Bus(self.entity, name, self._signals, optional_signals=self._optional_signals, **kwargs)
|
||||
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
if hasattr(self.bus, self._ready_signal):
|
||||
self.ready = getattr(self.bus, self._ready_signal)
|
||||
self.ready.setimmediatevalue(0)
|
||||
|
||||
if hasattr(self.bus, self._valid_signal):
|
||||
self.valid = getattr(self.bus, self._valid_signal)
|
||||
|
||||
for sig in self._signals+self._optional_signals:
|
||||
if hasattr(self.bus, sig):
|
||||
if sig in self._signal_widths:
|
||||
assert len(getattr(self.bus, sig)) == self._signal_widths[sig]
|
||||
|
||||
self.queue = deque()
|
||||
self.queue_sync = Event()
|
||||
|
||||
self.pause = False
|
||||
|
||||
cocotb.fork(self._run_sink())
|
||||
|
||||
def recv(self):
|
||||
if self.queue:
|
||||
return self.queue.popleft()
|
||||
return None
|
||||
|
||||
def count(self):
|
||||
return len(self.queue)
|
||||
|
||||
def empty(self):
|
||||
return not self.queue
|
||||
|
||||
async def wait(self, timeout=0, timeout_unit=None):
|
||||
if not self.empty():
|
||||
return
|
||||
self.queue_sync.clear()
|
||||
if timeout:
|
||||
await First(self.queue_sync.wait(), Timer(timeout, timeout_unit))
|
||||
else:
|
||||
await self.queue_sync.wait()
|
||||
|
||||
def clear(self):
|
||||
self.queue = deque()
|
||||
|
||||
def callback(self, obj):
|
||||
self.queue.append(obj)
|
||||
self.queue_sync.set()
|
||||
|
||||
async def _run_sink(self):
|
||||
while True:
|
||||
await ReadOnly()
|
||||
|
||||
# read handshake signals
|
||||
ready_sample = self.ready is None or self.ready.value
|
||||
valid_sample = self.valid is None or self.valid.value
|
||||
|
||||
if self.reset is not None and self.reset.value:
|
||||
await RisingEdge(self.clock)
|
||||
self.clear()
|
||||
if self.ready is not None:
|
||||
self.ready <= 0
|
||||
continue
|
||||
|
||||
if ready_sample and valid_sample:
|
||||
obj = self._transaction_obj()
|
||||
self.bus.sample(obj)
|
||||
self.callback(obj)
|
||||
|
||||
await RisingEdge(self.clock)
|
||||
if self.ready is not None:
|
||||
self.ready <= (not self.pause)
|
||||
|
||||
|
||||
class StreamMonitor(object):
|
||||
|
||||
_signals = ["data", "valid", "ready"]
|
||||
_optional_signals = []
|
||||
|
||||
_signal_widths = {"valid": 1, "ready": 1}
|
||||
|
||||
_valid_signal = "valid"
|
||||
_ready_signal = "ready"
|
||||
|
||||
_transaction_obj = StreamTransaction
|
||||
|
||||
def __init__(self, entity, name, clock, reset=None, *args, **kwargs):
|
||||
self.log = SimLog("cocotb.%s.%s" % (entity._name, name))
|
||||
self.entity = entity
|
||||
self.clock = clock
|
||||
self.reset = reset
|
||||
self.bus = Bus(self.entity, name, self._signals, optional_signals=self._optional_signals, **kwargs)
|
||||
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
if hasattr(self.bus, self._ready_signal):
|
||||
self.ready = getattr(self.bus, self._ready_signal)
|
||||
|
||||
if hasattr(self.bus, self._valid_signal):
|
||||
self.valid = getattr(self.bus, self._valid_signal)
|
||||
|
||||
for sig in self._signals+self._optional_signals:
|
||||
if hasattr(self.bus, sig):
|
||||
if sig in self._signal_widths:
|
||||
assert len(getattr(self.bus, sig)) == self._signal_widths[sig]
|
||||
|
||||
self.queue = deque()
|
||||
self.queue_sync = Event()
|
||||
|
||||
cocotb.fork(self._run_monitor())
|
||||
|
||||
def recv(self):
|
||||
if self.queue:
|
||||
return self.queue.popleft()
|
||||
return None
|
||||
|
||||
def count(self):
|
||||
return len(self.queue)
|
||||
|
||||
def empty(self):
|
||||
return not self.queue
|
||||
|
||||
async def wait(self, timeout=0, timeout_unit=None):
|
||||
if not self.empty():
|
||||
return
|
||||
self.queue_sync.clear()
|
||||
if timeout:
|
||||
await First(self.queue_sync.wait(), Timer(timeout, timeout_unit))
|
||||
else:
|
||||
await self.queue_sync.wait()
|
||||
|
||||
def clear(self):
|
||||
self.queue = deque()
|
||||
|
||||
def callback(self, obj):
|
||||
self.queue.append(obj)
|
||||
self.queue_sync.set()
|
||||
|
||||
async def _run_monitor(self):
|
||||
while True:
|
||||
await ReadOnly()
|
||||
|
||||
# read handshake signals
|
||||
ready_sample = self.ready is None or self.ready.value
|
||||
valid_sample = self.valid is None or self.valid.value
|
||||
|
||||
if self.reset is not None and self.reset.value:
|
||||
await RisingEdge(self.clock)
|
||||
self.clear()
|
||||
continue
|
||||
|
||||
if ready_sample and valid_sample:
|
||||
obj = self._transaction_obj()
|
||||
self.bus.sample(obj)
|
||||
self.callback(obj)
|
||||
|
||||
await RisingEdge(self.clock)
|
||||
|
||||
|
||||
def define_stream(name, signals, optional_signals=None, valid_signal=None, ready_signal=None, signal_widths=None):
|
||||
all_signals = signals.copy()
|
||||
|
||||
if optional_signals is None:
|
||||
optional_signals = []
|
||||
else:
|
||||
all_signals += optional_signals
|
||||
|
||||
if valid_signal is None:
|
||||
for s in all_signals:
|
||||
if s.lower().endswith('valid'):
|
||||
valid_signal = s
|
||||
if valid_signal not in all_signals:
|
||||
signals += valid_signal
|
||||
|
||||
if ready_signal is None:
|
||||
for s in all_signals:
|
||||
if s.lower().endswith('ready'):
|
||||
ready_signal = s
|
||||
else:
|
||||
if ready_signal not in all_signals:
|
||||
signals += ready_signal
|
||||
|
||||
if signal_widths is None:
|
||||
signal_widths = {}
|
||||
|
||||
if valid_signal not in signal_widths:
|
||||
signal_widths[valid_signal] = 1
|
||||
|
||||
if ready_signal not in signal_widths:
|
||||
signal_widths[ready_signal] = 1
|
||||
|
||||
filtered_signals = []
|
||||
|
||||
for s in all_signals:
|
||||
if s not in (ready_signal, valid_signal):
|
||||
filtered_signals.append(s)
|
||||
|
||||
transaction = type(name+"Transaction", (StreamTransaction,), {s: 0 for s in filtered_signals})
|
||||
|
||||
attrib = {}
|
||||
attrib['_signals'] = signals
|
||||
attrib['_optional_signals'] = optional_signals
|
||||
attrib['_signal_widths'] = signal_widths
|
||||
attrib['_ready_signal'] = ready_signal
|
||||
attrib['_valid_signal'] = valid_signal
|
||||
attrib['_transaction_obj'] = transaction
|
||||
|
||||
source = type(name+"Source", (StreamSource,), attrib)
|
||||
sink = type(name+"Sink", (StreamSink,), attrib)
|
||||
monitor = type(name+"Monitor", (StreamMonitor,), attrib)
|
||||
|
||||
return transaction, source, sink, monitor
|
||||
|
||||
Reference in New Issue
Block a user