587 lines
20 KiB
Python
587 lines
20 KiB
Python
"""
|
|
|
|
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 logging
|
|
from typing import NamedTuple
|
|
|
|
import cocotb
|
|
from cocotb.queue import Queue
|
|
from cocotb.triggers import Event
|
|
|
|
from .version import __version__
|
|
from .constants import AxiProt, AxiResp
|
|
from .axil_channels import AxiLiteAWSource, AxiLiteWSource, AxiLiteBSink, AxiLiteARSource, AxiLiteRSink
|
|
from .address_space import Region
|
|
from .reset import Reset
|
|
|
|
|
|
# AXI lite master write helper objects
|
|
class AxiLiteWriteCmd(NamedTuple):
|
|
address: int
|
|
data: bytes
|
|
prot: AxiProt
|
|
event: Event
|
|
|
|
|
|
class AxiLiteWriteRespCmd(NamedTuple):
|
|
address: int
|
|
length: int
|
|
cycles: int
|
|
prot: AxiProt
|
|
event: Event
|
|
|
|
|
|
class AxiLiteWriteResp(NamedTuple):
|
|
address: int
|
|
length: int
|
|
resp: AxiResp
|
|
|
|
|
|
# AXI lite master read helper objects
|
|
class AxiLiteReadCmd(NamedTuple):
|
|
address: int
|
|
length: int
|
|
prot: AxiProt
|
|
event: Event
|
|
|
|
|
|
class AxiLiteReadRespCmd(NamedTuple):
|
|
address: int
|
|
length: int
|
|
cycles: int
|
|
prot: AxiProt
|
|
event: Event
|
|
|
|
|
|
class AxiLiteReadResp(NamedTuple):
|
|
address: int
|
|
data: bytes
|
|
resp: AxiResp
|
|
|
|
def __bytes__(self):
|
|
return self.data
|
|
|
|
|
|
class AxiLiteMasterWrite(Region, Reset):
|
|
def __init__(self, bus, clock, reset=None, reset_active_level=True, **kwargs):
|
|
self.bus = bus
|
|
self.clock = clock
|
|
self.reset = reset
|
|
self.log = logging.getLogger(f"cocotb.{bus.aw._entity._name}.{bus.aw._name}")
|
|
|
|
self.log.info("AXI lite master (write)")
|
|
self.log.info("cocotbext-axi version %s", __version__)
|
|
self.log.info("Copyright (c) 2020 Alex Forencich")
|
|
self.log.info("https://github.com/alexforencich/cocotbext-axi")
|
|
|
|
self.aw_channel = AxiLiteAWSource(bus.aw, clock, reset, reset_active_level)
|
|
self.aw_channel.queue_occupancy_limit = 2
|
|
self.w_channel = AxiLiteWSource(bus.w, clock, reset, reset_active_level)
|
|
self.w_channel.queue_occupancy_limit = 2
|
|
self.b_channel = AxiLiteBSink(bus.b, clock, reset, reset_active_level)
|
|
self.b_channel.queue_occupancy_limit = 2
|
|
|
|
self.write_command_queue = Queue()
|
|
self.write_command_queue.queue_occupancy_limit = 2
|
|
self.current_write_command = None
|
|
|
|
self.int_write_resp_command_queue = Queue()
|
|
self.current_write_resp_command = None
|
|
|
|
self.in_flight_operations = 0
|
|
self._idle = Event()
|
|
self._idle.set()
|
|
|
|
self.address_width = len(self.aw_channel.bus.awaddr)
|
|
self.width = len(self.w_channel.bus.wdata)
|
|
self.byte_size = 8
|
|
self.byte_lanes = self.width // self.byte_size
|
|
self.strb_mask = 2**self.byte_lanes-1
|
|
|
|
self.awprot_present = hasattr(self.bus.aw, "awprot")
|
|
self.wstrb_present = hasattr(self.bus.w, "wstrb")
|
|
|
|
super().__init__(2**self.address_width, **kwargs)
|
|
|
|
self.log.info("AXI lite master configuration:")
|
|
self.log.info(" Address width: %d bits", self.address_width)
|
|
self.log.info(" Byte size: %d bits", self.byte_size)
|
|
self.log.info(" Data width: %d bits (%d bytes)", self.width, self.byte_lanes)
|
|
|
|
self.log.info("AXI lite master signals:")
|
|
for bus in (self.bus.aw, self.bus.w, self.bus.b):
|
|
for sig in sorted(list(set().union(bus._signals, bus._optional_signals))):
|
|
if hasattr(bus, sig):
|
|
self.log.info(" %s width: %d bits", sig, len(getattr(bus, sig)))
|
|
else:
|
|
self.log.info(" %s: not present", sig)
|
|
|
|
if self.wstrb_present:
|
|
assert self.byte_lanes == len(self.w_channel.bus.wstrb)
|
|
assert self.byte_lanes * self.byte_size == self.width
|
|
|
|
self._process_write_cr = None
|
|
self._process_write_resp_cr = None
|
|
|
|
self._init_reset(reset, reset_active_level)
|
|
|
|
def init_write(self, address, data, prot=AxiProt.NONSECURE, event=None):
|
|
if event is None:
|
|
event = Event()
|
|
|
|
if not isinstance(event, Event):
|
|
raise ValueError("Expected event object")
|
|
|
|
if address < 0 or address >= 2**self.address_width:
|
|
raise ValueError("Address out of range")
|
|
|
|
if isinstance(data, int):
|
|
raise ValueError("Expected bytes or bytearray for data")
|
|
|
|
if not self.awprot_present and prot != AxiProt.NONSECURE:
|
|
raise ValueError("awprot sideband signal value specified, but signal is not connected")
|
|
|
|
data = bytes(data)
|
|
|
|
cocotb.start_soon(self._write_wrapper(address, bytes(data), prot, event))
|
|
|
|
return event
|
|
|
|
def idle(self):
|
|
return not self.in_flight_operations
|
|
|
|
async def wait(self):
|
|
while not self.idle():
|
|
await self._idle.wait()
|
|
|
|
async def write(self, address, data, prot=AxiProt.NONSECURE):
|
|
if address < 0 or address >= 2**self.address_width:
|
|
raise ValueError("Address out of range")
|
|
|
|
if isinstance(data, int):
|
|
raise ValueError("Expected bytes or bytearray for data")
|
|
|
|
if not self.awprot_present and prot != AxiProt.NONSECURE:
|
|
raise ValueError("awprot sideband signal value specified, but signal is not connected")
|
|
|
|
event = Event()
|
|
data = bytes(data)
|
|
|
|
self.in_flight_operations += 1
|
|
self._idle.clear()
|
|
|
|
await self.write_command_queue.put(AxiLiteWriteCmd(address, data, prot, event))
|
|
await event.wait()
|
|
return event.data
|
|
|
|
async def _write_wrapper(self, address, data, prot, event):
|
|
event.set(await self.write(address, data, prot))
|
|
|
|
def _handle_reset(self, state):
|
|
if state:
|
|
self.log.info("Reset asserted")
|
|
if self._process_write_cr is not None:
|
|
self._process_write_cr.kill()
|
|
self._process_write_cr = None
|
|
if self._process_write_resp_cr is not None:
|
|
self._process_write_resp_cr.kill()
|
|
self._process_write_resp_cr = None
|
|
|
|
self.aw_channel.clear()
|
|
self.w_channel.clear()
|
|
self.b_channel.clear()
|
|
|
|
def flush_cmd(cmd):
|
|
self.log.warning("Flushed write operation during reset: %s", cmd)
|
|
if cmd.event:
|
|
cmd.event.set(None)
|
|
|
|
while not self.write_command_queue.empty():
|
|
cmd = self.write_command_queue.get_nowait()
|
|
flush_cmd(cmd)
|
|
|
|
if self.current_write_command:
|
|
cmd = self.current_write_command
|
|
self.current_write_command = None
|
|
flush_cmd(cmd)
|
|
|
|
while not self.int_write_resp_command_queue.empty():
|
|
cmd = self.int_write_resp_command_queue.get_nowait()
|
|
flush_cmd(cmd)
|
|
|
|
if self.current_write_resp_command:
|
|
cmd = self.current_write_resp_command
|
|
self.current_write_resp_command = None
|
|
flush_cmd(cmd)
|
|
|
|
self.in_flight_operations = 0
|
|
self._idle.set()
|
|
else:
|
|
self.log.info("Reset de-asserted")
|
|
if self._process_write_cr is None:
|
|
self._process_write_cr = cocotb.start_soon(self._process_write())
|
|
if self._process_write_resp_cr is None:
|
|
self._process_write_resp_cr = cocotb.start_soon(self._process_write_resp())
|
|
|
|
async def _process_write(self):
|
|
while True:
|
|
cmd = await self.write_command_queue.get()
|
|
self.current_write_command = cmd
|
|
|
|
word_addr = (cmd.address // self.byte_lanes) * self.byte_lanes
|
|
|
|
start_offset = cmd.address % self.byte_lanes
|
|
end_offset = ((cmd.address + len(cmd.data) - 1) % self.byte_lanes) + 1
|
|
|
|
strb_start = (self.strb_mask << start_offset) & self.strb_mask
|
|
strb_end = self.strb_mask >> (self.byte_lanes - end_offset)
|
|
|
|
cycles = (len(cmd.data) + (cmd.address % self.byte_lanes) + self.byte_lanes-1) // self.byte_lanes
|
|
|
|
resp_cmd = AxiLiteWriteRespCmd(cmd.address, len(cmd.data), cycles, cmd.prot, cmd.event)
|
|
await self.int_write_resp_command_queue.put(resp_cmd)
|
|
|
|
offset = 0
|
|
|
|
if self.log.isEnabledFor(logging.INFO):
|
|
self.log.info("Write start addr: 0x%08x prot: %s data: %s",
|
|
cmd.address, cmd.prot, ' '.join((f'{c:02x}' for c in cmd.data)))
|
|
|
|
for k in range(cycles):
|
|
start = 0
|
|
stop = self.byte_lanes
|
|
strb = self.strb_mask
|
|
|
|
if k == 0:
|
|
start = start_offset
|
|
strb &= strb_start
|
|
if k == cycles-1:
|
|
stop = end_offset
|
|
strb &= strb_end
|
|
|
|
val = 0
|
|
for j in range(start, stop):
|
|
val |= cmd.data[offset] << j*8
|
|
offset += 1
|
|
|
|
aw = self.aw_channel._transaction_obj()
|
|
aw.awaddr = word_addr + k*self.byte_lanes
|
|
aw.awprot = cmd.prot
|
|
|
|
if not self.wstrb_present and strb != self.strb_mask:
|
|
self.log.warning("Partial operation requested with wstrb not connected, write will be zero-padded (0x%x != 0x%x)", strb, self.strb_mask)
|
|
|
|
w = self.w_channel._transaction_obj()
|
|
w.wdata = val
|
|
w.wstrb = strb
|
|
|
|
await self.aw_channel.send(aw)
|
|
await self.w_channel.send(w)
|
|
|
|
self.current_write_command = None
|
|
|
|
async def _process_write_resp(self):
|
|
while True:
|
|
cmd = await self.int_write_resp_command_queue.get()
|
|
self.current_write_resp_command = cmd
|
|
|
|
resp = AxiResp.OKAY
|
|
|
|
for k in range(cmd.cycles):
|
|
b = await self.b_channel.recv()
|
|
|
|
cycle_resp = AxiResp(int(getattr(b, 'bresp', AxiResp.OKAY)))
|
|
|
|
if cycle_resp != AxiResp.OKAY:
|
|
resp = cycle_resp
|
|
|
|
self.log.info("Write complete addr: 0x%08x prot: %s resp: %s length: %d",
|
|
cmd.address, cmd.prot, resp, cmd.length)
|
|
|
|
write_resp = AxiLiteWriteResp(cmd.address, cmd.length, resp)
|
|
|
|
cmd.event.set(write_resp)
|
|
|
|
self.current_write_resp_command = None
|
|
|
|
self.in_flight_operations -= 1
|
|
|
|
if self.in_flight_operations == 0:
|
|
self._idle.set()
|
|
|
|
|
|
class AxiLiteMasterRead(Region, Reset):
|
|
def __init__(self, bus, clock, reset=None, reset_active_level=True, **kwargs):
|
|
self.bus = bus
|
|
self.clock = clock
|
|
self.reset = reset
|
|
self.log = logging.getLogger(f"cocotb.{bus.ar._entity._name}.{bus.ar._name}")
|
|
|
|
self.log.info("AXI lite master (read)")
|
|
self.log.info("cocotbext-axi version %s", __version__)
|
|
self.log.info("Copyright (c) 2020 Alex Forencich")
|
|
self.log.info("https://github.com/alexforencich/cocotbext-axi")
|
|
|
|
self.ar_channel = AxiLiteARSource(bus.ar, clock, reset, reset_active_level)
|
|
self.ar_channel.queue_occupancy_limit = 2
|
|
self.r_channel = AxiLiteRSink(bus.r, clock, reset, reset_active_level)
|
|
self.r_channel.queue_occupancy_limit = 2
|
|
|
|
self.read_command_queue = Queue()
|
|
self.read_command_queue.queue_occupancy_limit = 2
|
|
self.current_read_command = None
|
|
|
|
self.int_read_resp_command_queue = Queue()
|
|
self.current_read_resp_command = None
|
|
|
|
self.in_flight_operations = 0
|
|
self._idle = Event()
|
|
self._idle.set()
|
|
|
|
self.address_width = len(self.ar_channel.bus.araddr)
|
|
self.width = len(self.r_channel.bus.rdata)
|
|
self.byte_size = 8
|
|
self.byte_lanes = self.width // self.byte_size
|
|
|
|
self.arprot_present = hasattr(self.bus.ar, "arprot")
|
|
|
|
super().__init__(2**self.address_width, **kwargs)
|
|
|
|
self.log.info("AXI lite master configuration:")
|
|
self.log.info(" Address width: %d bits", self.address_width)
|
|
self.log.info(" Byte size: %d bits", self.byte_size)
|
|
self.log.info(" Data width: %d bits (%d bytes)", self.width, self.byte_lanes)
|
|
|
|
self.log.info("AXI lite master signals:")
|
|
for bus in (self.bus.ar, self.bus.r):
|
|
for sig in sorted(list(set().union(bus._signals, bus._optional_signals))):
|
|
if hasattr(bus, sig):
|
|
self.log.info(" %s width: %d bits", sig, len(getattr(bus, sig)))
|
|
else:
|
|
self.log.info(" %s: not present", sig)
|
|
|
|
assert self.byte_lanes * self.byte_size == self.width
|
|
|
|
self._process_read_cr = None
|
|
self._process_read_resp_cr = None
|
|
|
|
self._init_reset(reset, reset_active_level)
|
|
|
|
def init_read(self, address, length, prot=AxiProt.NONSECURE, event=None):
|
|
if event is None:
|
|
event = Event()
|
|
|
|
if not isinstance(event, Event):
|
|
raise ValueError("Expected event object")
|
|
|
|
if address < 0 or address >= 2**self.address_width:
|
|
raise ValueError("Address out of range")
|
|
|
|
if not self.arprot_present and prot != AxiProt.NONSECURE:
|
|
raise ValueError("arprot sideband signal value specified, but signal is not connected")
|
|
|
|
cocotb.start_soon(self._read_wrapper(address, length, prot, event))
|
|
|
|
return event
|
|
|
|
def idle(self):
|
|
return not self.in_flight_operations
|
|
|
|
async def wait(self):
|
|
while not self.idle():
|
|
await self._idle.wait()
|
|
|
|
async def read(self, address, length, prot=AxiProt.NONSECURE):
|
|
if address < 0 or address >= 2**self.address_width:
|
|
raise ValueError("Address out of range")
|
|
|
|
if not self.arprot_present and prot != AxiProt.NONSECURE:
|
|
raise ValueError("arprot sideband signal value specified, but signal is not connected")
|
|
|
|
event = Event()
|
|
|
|
self.in_flight_operations += 1
|
|
self._idle.clear()
|
|
|
|
await self.read_command_queue.put(AxiLiteReadCmd(address, length, prot, event))
|
|
|
|
await event.wait()
|
|
return event.data
|
|
|
|
async def _read_wrapper(self, address, length, prot, event):
|
|
event.set(await self.read(address, length, prot))
|
|
|
|
def _handle_reset(self, state):
|
|
if state:
|
|
self.log.info("Reset asserted")
|
|
if self._process_read_cr is not None:
|
|
self._process_read_cr.kill()
|
|
self._process_read_cr = None
|
|
if self._process_read_resp_cr is not None:
|
|
self._process_read_resp_cr.kill()
|
|
self._process_read_resp_cr = None
|
|
|
|
self.ar_channel.clear()
|
|
self.r_channel.clear()
|
|
|
|
def flush_cmd(cmd):
|
|
self.log.warning("Flushed read operation during reset: %s", cmd)
|
|
if cmd.event:
|
|
cmd.event.set(None)
|
|
|
|
while not self.read_command_queue.empty():
|
|
cmd = self.read_command_queue.get_nowait()
|
|
flush_cmd(cmd)
|
|
|
|
if self.current_read_command:
|
|
cmd = self.current_read_command
|
|
self.current_read_command = None
|
|
flush_cmd(cmd)
|
|
|
|
while not self.int_read_resp_command_queue.empty():
|
|
cmd = self.int_read_resp_command_queue.get_nowait()
|
|
flush_cmd(cmd)
|
|
|
|
if self.current_read_resp_command:
|
|
cmd = self.current_read_resp_command
|
|
self.current_read_resp_command = None
|
|
flush_cmd(cmd)
|
|
|
|
self.in_flight_operations = 0
|
|
self._idle.set()
|
|
else:
|
|
self.log.info("Reset de-asserted")
|
|
if self._process_read_cr is None:
|
|
self._process_read_cr = cocotb.start_soon(self._process_read())
|
|
if self._process_read_resp_cr is None:
|
|
self._process_read_resp_cr = cocotb.start_soon(self._process_read_resp())
|
|
|
|
async def _process_read(self):
|
|
while True:
|
|
cmd = await self.read_command_queue.get()
|
|
self.current_read_command = cmd
|
|
|
|
word_addr = (cmd.address // self.byte_lanes) * self.byte_lanes
|
|
|
|
cycles = (cmd.length + self.byte_lanes-1 + (cmd.address % self.byte_lanes)) // self.byte_lanes
|
|
|
|
resp_cmd = AxiLiteReadRespCmd(cmd.address, cmd.length, cycles, cmd.prot, cmd.event)
|
|
await self.int_read_resp_command_queue.put(resp_cmd)
|
|
|
|
self.log.info("Read start addr: 0x%08x prot: %s length: %d",
|
|
cmd.address, cmd.prot, cmd.length)
|
|
|
|
for k in range(cycles):
|
|
ar = self.ar_channel._transaction_obj()
|
|
ar.araddr = word_addr + k*self.byte_lanes
|
|
ar.arprot = cmd.prot
|
|
|
|
await self.ar_channel.send(ar)
|
|
|
|
self.current_read_command = None
|
|
|
|
async def _process_read_resp(self):
|
|
while True:
|
|
cmd = await self.int_read_resp_command_queue.get()
|
|
self.current_read_resp_command = cmd
|
|
|
|
start_offset = cmd.address % self.byte_lanes
|
|
end_offset = ((cmd.address + cmd.length - 1) % self.byte_lanes) + 1
|
|
|
|
data = bytearray()
|
|
|
|
resp = AxiResp.OKAY
|
|
|
|
for k in range(cmd.cycles):
|
|
r = await self.r_channel.recv()
|
|
|
|
cycle_data = int(r.rdata)
|
|
cycle_resp = AxiResp(int(getattr(r, 'rresp', AxiResp.OKAY)))
|
|
|
|
if cycle_resp != AxiResp.OKAY:
|
|
resp = cycle_resp
|
|
|
|
start = 0
|
|
stop = self.byte_lanes
|
|
|
|
if k == 0:
|
|
start = start_offset
|
|
if k == cmd.cycles-1:
|
|
stop = end_offset
|
|
|
|
for j in range(start, stop):
|
|
data.extend(bytearray([(cycle_data >> j*8) & 0xff]))
|
|
|
|
if self.log.isEnabledFor(logging.INFO):
|
|
self.log.info("Read complete addr: 0x%08x prot: %s resp: %s data: %s",
|
|
cmd.address, cmd.prot, resp, ' '.join((f'{c:02x}' for c in data)))
|
|
|
|
read_resp = AxiLiteReadResp(cmd.address, bytes(data), resp)
|
|
|
|
cmd.event.set(read_resp)
|
|
|
|
self.current_read_resp_command = None
|
|
|
|
self.in_flight_operations -= 1
|
|
|
|
if self.in_flight_operations == 0:
|
|
self._idle.set()
|
|
|
|
|
|
class AxiLiteMaster(Region):
|
|
def __init__(self, bus, clock, reset=None, reset_active_level=True, **kwargs):
|
|
self.write_if = None
|
|
self.read_if = None
|
|
|
|
self.write_if = AxiLiteMasterWrite(bus.write, clock, reset, reset_active_level, **kwargs)
|
|
self.read_if = AxiLiteMasterRead(bus.read, clock, reset, reset_active_level, **kwargs)
|
|
|
|
super().__init__(max(self.write_if.size, self.read_if.size), **kwargs)
|
|
|
|
def init_read(self, address, length, prot=AxiProt.NONSECURE, event=None):
|
|
return self.read_if.init_read(address, length, prot, event)
|
|
|
|
def init_write(self, address, data, prot=AxiProt.NONSECURE, event=None):
|
|
return self.write_if.init_write(address, data, prot, event)
|
|
|
|
def idle(self):
|
|
return (not self.read_if or self.read_if.idle()) and (not self.write_if or self.write_if.idle())
|
|
|
|
async def wait(self):
|
|
while not self.idle():
|
|
await self.write_if.wait()
|
|
await self.read_if.wait()
|
|
|
|
async def wait_read(self):
|
|
await self.read_if.wait()
|
|
|
|
async def wait_write(self):
|
|
await self.write_if.wait()
|
|
|
|
async def read(self, address, length, prot=AxiProt.NONSECURE):
|
|
return await self.read_if.read(address, length, prot)
|
|
|
|
async def write(self, address, data, prot=AxiProt.NONSECURE):
|
|
return await self.write_if.write(address, data, prot)
|