driver: add BCUResetDriver to support bcu tool

doc/configuration.rst

@@ -128,6 +128,27 @@ Arguments:
 Used by:
   - `SerialDriver`_
 
+USBResetPort
++++++++++++++
+Describes the resource required to use the `bcu <https://github.com/nxp-imx/bcu#readme>`_ tool.
+
+.. code-block:: yaml
+
+   USBResetPort:
+     board: 'imx8dxlevk'
+     match:
+        'sys_name': '2-1.3.3'
+
+Arguments:
+  - board (str): is the board type and can be retrieved with ``bcu lsboard``
+  - match (dict): key and value pairs for a udev match, see `udev Matching`_ ;
+    we need the sys_name as the path of the board serial - it can be retrieved
+    with ``bcu lsftdi`` command or from ``dmesg`` of the workstation after
+    you unplug/plug the board serial cable
+
+Used by:
+  - `BCUResetDriver`_
+
 Power Ports
 ~~~~~~~~~~~
 
@@ -1684,6 +1705,38 @@ Arguments:
   - password (str): optional, password to use for access to the shell
   - login_timeout (int, default=60): timeout for access to the shell
 
+BCUResetDriver
+~~~~~~~~~~~~~~
+BCUResetDriver is the driver that calls  `bcu <https://github.com/nxp-imx/bcu#readme>`_ tool. It runs the following command on the exporter:
+
+.. code-block::
+
+   bcu reset <mode> -board=USBResetPort.board \
+                    -id=USBResetPort.path \
+                    -delay=BCUResetDriver.delay
+
+Binds to:
+  port:
+    - `USBResetPort`_
+
+Implements:
+  - :any:`BootCfgProtocol`
+  - :any:`ResetProtocol`
+
+.. code-block:: yaml
+
+   BCUResetDriver:
+     qspi_cfg: 'spi'
+
+Arguments:
+  - delay (int, default=1000): time in ms before bcu reset
+  - emmc_cfg (str, default="emmc"): boot mode for emmc
+  - sd_cfg (str, default="sd"): boot mode for sd
+  - usb_cfg (str, default="usb"): boot mode for usb serial download
+  - qspi_cfg (str, default=""): boot mode for spi
+
+To find out boot modes for a specific board use ``bcu lsbootmode -board=<board>``
+
 ExternalConsoleDriver
 ~~~~~~~~~~~~~~~~~~~~~
 An ExternalConsoleDriver implements the `ConsoleProtocol` on top of a command

examples/bcu/bcu_example.py

@@ -0,0 +1,36 @@
+import pytest
+
+
+@pytest.fixture()
+def switchcfg(target):
+    # bcu tool needs to be installed on workstation
+    return target.get_driver('BCUResetDriver')
+
+@pytest.fixture()
+def shell(target):
+    s = target.get_driver('ShellDriver')
+    #in case board remained booted from a different test
+    target.deactivate(s)
+    return s
+
+@pytest.mark.lg_feature("SDcard")
+def test_boot_from_sdcard(target, switchcfg, shell):
+    # Note that you need a bootable image already on sd
+    switchcfg.sd()
+    try:
+        target.activate(shell)
+    except:
+        assert False, "Board failed to boot"
+    stdout, stderr, returncode = shell.run('dmesg | grep root=/dev/mmcblk1')
+    assert returncode == 0, "Board booted from wrong environment"
+
+def test_boot_from_emmc(target, switchcfg, shell):
+    # Note that you need a bootable image already on emmc
+    switchcfg.emmc()
+    try:
+        target.activate(shell)
+    except:
+        assert False, "Board failed to boot"
+    stdout, stderr, returncode = shell.run('dmesg | grep root=/dev/mmcblk0')
+    assert returncode == 0, "Board booted from wrong environment"
+

examples/bcu/local.yaml

@@ -0,0 +1,20 @@
+features:
+  - SDcard
+targets:
+  main:
+    resources:
+      RawSerialPort:
+        port: "/dev/ttyUSB2"
+      USBResetPort:
+        board: 'imx8dxlevk'
+        match:
+            'sys_name': '3-11.3'
+    drivers:
+      SerialDriver: {}
+      BCUResetDriver:
+        qspi_cfg: 'spi'
+      ShellDriver:
+        prompt: 'root@[\w-]+:[^ ]+ '
+        login_prompt: ' login: '
+        username: 'root'
+        login_timeout: 180

labgrid/driver/resetdriver.py

@@ -3,9 +3,12 @@
 import attr
 
 from ..factory import target_factory
-from ..protocol import DigitalOutputProtocol, ResetProtocol
+from ..protocol import DigitalOutputProtocol, ResetProtocol, BootCfgProtocol
+from ..resource.remote import NetworkUSBResetPort
+from ..resource.udev import USBResetPort
 from ..step import step
 from .common import Driver
+from ..util.helper import processwrapper
 
 @target_factory.reg_driver
 @attr.s(eq=False)
@@ -24,3 +27,61 @@ def reset(self):
         self.output.set(True)
         time.sleep(self.delay)
         self.output.set(False)
+
+@target_factory.reg_driver
+@attr.s(eq=False)
+class BCUResetDriver(Driver, ResetProtocol, BootCfgProtocol):
+    """BCUResetDriver - Driver using https://github.com/NXPmicro/bcu and board
+    serial port as USBResetPort to reset the target into different states"""
+
+    bindings = {
+       "port": {USBResetPort, NetworkUSBResetPort}, 
+    }
+
+    delay = attr.ib(default=1000, validator=attr.validators.instance_of(int))
+    emmc_cfg = attr.ib(default="emmc", validator=attr.validators.instance_of(str))
+    sd_cfg = attr.ib(default="sd", validator=attr.validators.instance_of(str))
+    usb_cfg = attr.ib(default="usb", validator=attr.validators.instance_of(str))
+    qspi_cfg = attr.ib(default="", validator=attr.validators.instance_of(str))
+
+    def __attrs_post_init__(self):
+        super().__attrs_post_init__()
+        self.tool = 'bcu'
+
+    @Driver.check_active
+    @step()
+    def reset(self, mode=""):
+        cmd = self.port.command_prefix + [
+            self.tool,
+            "reset", mode,
+            "-board={}".format(self.port.board),
+            "-id={}".format(self.port.path),
+            "-delay={}".format(str(self.delay)),
+        ]
+        try:
+            print(str(processwrapper.check_output(cmd).decode()))
+        except subprocess.CalledProcessError as e:
+            raise  
+
+    @Driver.check_active
+    @step()
+    def sd(self):
+        self.reset(self.sd_cfg)
+
+    @Driver.check_active
+    @step()
+    def emmc(self):
+        self.reset(self.emmc_cfg)
+
+    @Driver.check_active
+    @step()
+    def usb(self):
+        self.reset(self.usb_cfg)
+
+    @Driver.check_active
+    @step()
+    def qspi(self):
+        if not self.qspi_cfg:
+            print("QSPI mode is not set, board is reseting in current mode")
+        self.reset(self.qspi_cfg)
+

labgrid/protocol/__init__.py

@@ -3,6 +3,7 @@
 from .consoleprotocol import ConsoleProtocol
 from .linuxbootprotocol import LinuxBootProtocol
 from .powerprotocol import PowerProtocol
+from .bootcfgprotocol import BootCfgProtocol
 from .filetransferprotocol import FileTransferProtocol
 from .infoprotocol import InfoProtocol
 from .digitaloutputprotocol import DigitalOutputProtocol

labgrid/protocol/bootcfgprotocol.py

@@ -0,0 +1,20 @@
+import abc
+
+
+class BootCfgProtocol(abc.ABC):
+    @abc.abstractmethod
+    def usb(self):
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def sd(self):
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def emmc(self):
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def qspi(self):
+        raise NotImplementedError
+

labgrid/remote/exporter.py

@@ -500,6 +500,25 @@ def __attrs_post_init__(self):
         super().__attrs_post_init__()
         self.data['cls'] = f"Remote{self.cls}".replace("Network", "")
 
+@attr.s(eq=False)
+class USBResetPortExport(USBGenericExport):
+    """ResourceExport for ports used by bcu"""
+
+    def __attrs_post_init__(self):
+        super().__attrs_post_init__()
+
+    def _get_params(self):
+        """Helper function to return parameters"""
+        return {
+            'host': self.host,
+            'busnum': self.local.busnum,
+            'devnum': self.local.devnum,
+            'path': self.local.path,
+            'vendor_id': self.local.vendor_id,
+            'model_id': self.local.model_id,
+            'board': self.local.board,
+        }
+
 exports["AndroidFastboot"] = USBGenericExport
 exports["AndroidUSBFastboot"] = USBGenericRemoteExport
 exports["DFUDevice"] = USBGenericExport
@@ -512,6 +531,7 @@ def __attrs_post_init__(self):
 exports["USBSDMuxDevice"] = USBSDMuxExport
 exports["USBSDWireDevice"] = USBSDWireExport
 exports["USBDebugger"] = USBGenericExport
+exports["USBResetPort"] = USBResetPortExport
 
 exports["USBMassStorage"] = USBGenericExport
 exports["USBVideo"] = USBGenericExport

labgrid/resource/remote.py

@@ -411,3 +411,15 @@ class RemoteNFSProvider(RemoteBaseProvider):
 @attr.s(eq=False)
 class RemoteHTTPProvider(RemoteBaseProvider):
     pass
+
+
+@target_factory.reg_resource
+@attr.s(eq=False)
+class NetworkUSBResetPort(RemoteUSBResource):
+    board = attr.ib(
+        default=None,
+        validator=attr.validators.instance_of(str)
+    )
+    def __attrs_post_init__(self):
+        self.timeout = 10.0
+        super().__attrs_post_init__()

labgrid/resource/udev.py

@@ -708,3 +708,15 @@ def filter_match(self, device):
             return False
 
         return super().filter_match(device)
+
+@target_factory.reg_resource
+@attr.s(cmp=False)
+class USBResetPort(USBResource):
+    """The USBResetPort is the board serial cable (not the interface),
+    it is identified via usb using udev and it accepts any vendor/product id
+
+    Args:
+        board (str): mandatory arg to declare a board type recognized by bcu
+    """
+
+    board = attr.ib(default=None, validator=attr.validators.instance_of(str))