import subprocess
import re
import time
import logging
import attr
from ..factory import target_factory
from ..step import step
from .common import Driver
from .exception import ExecutionError
from ..util import Timeout
from ..util.helper import processwrapper
from ..util.managedfile import ManagedFile
[docs]@target_factory.reg_driver
@attr.s(eq=False)
class QuartusHPSDriver(Driver):
bindings = {
"interface": {"AlteraUSBBlaster", "NetworkAlteraUSBBlaster"},
}
image = attr.ib(
default=None,
validator=attr.validators.optional(attr.validators.instance_of(str))
)
[docs] def __attrs_post_init__(self):
super().__attrs_post_init__()
self.logger = logging.getLogger(f"{self}({self.target})")
# FIXME make sure we always have an environment or config
if self.target.env:
self.tool = self.target.env.config.get_tool('quartus_hps')
self.jtag_tool = self.target.env.config.get_tool('jtagconfig')
else:
self.tool = 'quartus_hps'
self.jtag_tool = 'jtagconfig'
def _get_cable_number(self):
"""
Returns the JTAG cable number with an intact JTAG chain for the USB path of the device.
In case a matching JTAG cable is found, but its chain is broken, keep retrying for a
while.
"""
timeout = Timeout(10.0)
while not timeout.expired:
cmd = self.interface.command_prefix + [self.jtag_tool]
jtagconfig_process = subprocess.Popen(
cmd,
stdout=subprocess.PIPE
)
stdout, _ = jtagconfig_process.communicate()
regex = rf".*(\d+)\) .* \[{re.escape(self.interface.path)}]\n(.*)\n"
jtag_mapping = re.search(regex, stdout.decode("utf-8"), re.MULTILINE)
if jtag_mapping is None:
raise ExecutionError(
f"Could not get cable number for USB path {self.interface.path}"
)
cable_number, first_chain = jtag_mapping.groups()
try:
jtag_id, _ = first_chain.split(sep=" ", maxsplit=1)
int(jtag_id, 16)
except ValueError:
self.logger.warning("jtagconfig: %s", first_chain.strip())
time.sleep(0.5)
continue
return int(cable_number)
raise ExecutionError("Timeout while waiting for intact JTAG chain")
[docs] @Driver.check_active
@step(args=['filename', 'address'])
def flash(self, filename=None, address=0x0):
if filename is None and self.image is not None:
filename = self.target.env.config.get_image_path(self.image)
mf = ManagedFile(filename, self.interface)
mf.sync_to_resource()
assert isinstance(address, int)
cable_number = self._get_cable_number()
cmd = self.interface.command_prefix + [self.tool]
cmd += [
f"--cable={cable_number}",
f"--addr=0x{address:X}",
f"--operation=P {mf.get_remote_path()}",
]
processwrapper.check_output(cmd)
[docs] @Driver.check_active
@step(args=['address', 'size'])
def erase(self, address=None, size=None):
cable_number = self._get_cable_number()
cmd = self.interface.command_prefix + [self.tool]
cmd += [
f"--cable={cable_number}",
"--operation=E",
]
if address:
cmd += [f"--addr=0x{address:X}"]
if size:
cmd += [f"--size=0x{size:X}"]
processwrapper.check_output(cmd)