Merge pull request #933 from Bastian-Krause/bst/dfu

Introduce DFUDevice, DFUDriver

Author: jluebbe

CHANGES.rst

@@ -23,6 +23,9 @@ New Features in 0.5.0
   which expects ``boot_secret`` without new line with new ``boot_secret_nolf``
   boolean config option.
 - labgrid-client add-match/add-named-match check for duplicate matches
+- `DFUDriver` has been added to communicate with a `DFUDevice`, a device in DFU
+  (Device Firmware Upgrade) mode.
+- ``labgrid-client dfu`` added to allow communcation with devices in DFU mode.
 
 Bug fixes in 0.5.0
 ~~~~~~~~~~~~~~~~~~

doc/configuration.rst

@@ -625,6 +625,23 @@ Arguments:
 Used by:
   - `AndroidFastbootDriver`_
 
+DFUDevice
+~~~~~~~~~
+A DFUDevice resource describes a USB device in DFU (Device Firmware Upgrade)
+mode.
+
+.. code-block:: yaml
+
+   DFUDevice:
+     match:
+       ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
+
+Arguments:
+  - match (dict): key and value pairs for a udev match, see `udev Matching`_
+
+Used by:
+  - `DFUDriver`_
+
 USBNetworkInterface
 ~~~~~~~~~~~~~~~~~~~~
 A USBNetworkInterface resource describes a USB network adapter (such as
@@ -1556,6 +1573,25 @@ Arguments:
     same as the fastboot default, which is computed after querying the target's
     ``max-download-size`` variable.
 
+DFUDriver
+~~~~~~~~~
+A DFUDriver allows the download of images to a device in DFU (Device Firmware
+Upgrade) mode.
+
+Binds to:
+  dfu:
+    - `DFUDevice`_
+
+Implements:
+  - None (yet)
+
+.. code-block:: yaml
+
+   DFUDriver: {}
+
+Arguments:
+  - None
+
 OpenOCDDriver
 ~~~~~~~~~~~~~
 An OpenOCDDriver controls OpenOCD to bootstrap a target with a bootloader.

labgrid/driver/__init__.py

@@ -7,6 +7,7 @@
 from .externalconsoledriver import ExternalConsoleDriver
 from .exception import CleanUpError, ExecutionError
 from .fastbootdriver import AndroidFastbootDriver
+from .dfudriver import DFUDriver
 from .openocddriver import OpenOCDDriver
 from .quartushpsdriver import QuartusHPSDriver
 from .flashromdriver import FlashromDriver

labgrid/driver/dfudriver.py

@@ -0,0 +1,60 @@
+# pylint: disable=no-member
+import attr
+
+from ..factory import target_factory
+from ..step import step
+from .common import Driver
+from ..util.managedfile import ManagedFile
+from ..util.helper import processwrapper
+
+
+@target_factory.reg_driver
+@attr.s(eq=False)
+class DFUDriver(Driver):
+    bindings = {
+        "dfu": {"DFUDevice", "NetworkDFUDevice"},
+    }
+
+    def __attrs_post_init__(self):
+        super().__attrs_post_init__()
+        # FIXME make sure we always have an environment or config
+        if self.target.env:
+            self.tool = self.target.env.config.get_tool('dfu-util') or 'dfu-util'
+        else:
+            self.tool = 'dfu-util'
+
+    def _get_dfu_prefix(self):
+        return self.dfu.command_prefix + [
+            self.tool,
+            "-p", self.dfu.path,
+        ]
+
+    def on_activate(self):
+        pass
+
+    def on_deactivate(self):
+        pass
+
+    @Driver.check_active
+    @step(args=['altsetting', 'filename'])
+    def download(self, altsetting, filename):
+        mf = ManagedFile(filename, self.dfu)
+        mf.sync_to_resource()
+
+        processwrapper.check_output(
+            self._get_dfu_prefix() + ['--alt', str(altsetting), '--download', mf.get_remote_path()],
+            print_on_silent_log=True
+        )
+
+    @step()
+    def detach(self, altsetting):
+        processwrapper.check_output(
+            self._get_dfu_prefix() + ['--alt', str(altsetting), '--detach']
+        )
+
+    @step()
+    def list(self):
+        processwrapper.check_output(
+            self._get_dfu_prefix() + ['--list'],
+            print_on_silent_log=True
+        )

labgrid/remote/client.py

@@ -913,6 +913,25 @@ async def console(self, place, target):
             await asyncio.sleep(1.0)
     console.needs_target = True
 
+    def dfu(self):
+        place = self.get_acquired_place()
+        target = self._get_target(place)
+        if self.args.action == 'download' and not self.args.filename:
+            raise UserError('not enough arguments for dfu download')
+        from ..driver.dfudriver import DFUDriver
+        try:
+            drv = target.get_driver(DFUDriver)
+        except NoDriverFoundError:
+            drv = DFUDriver(target, name=None)
+        drv.dfu.timeout = self.args.wait
+        target.activate(drv)
+        if self.args.action == 'download':
+            drv.download(self.args.altsetting, os.path.abspath(self.args.filename))
+        if self.args.action == 'detach':
+            drv.detach(self.args.altsetting)
+        if self.args.action == 'list':
+            drv.list()
+
     def fastboot(self):
         place = self.get_acquired_place()
         args = self.args.fastboot_args
@@ -1697,6 +1716,15 @@ def main():
     subparser.add_argument('--logfile', metavar="FILE", help="Log output to FILE", default=None)
     subparser.set_defaults(func=ClientSession.console)
 
+    subparser = subparsers.add_parser('dfu',
+                                      help="communicate with device in DFU mode")
+    subparser.add_argument('action', choices=['download', 'detach', 'list'], help='action')
+    subparser.add_argument('altsetting', help='altsetting name or number (download, detach only)',
+                           nargs='?')
+    subparser.add_argument('filename', help='file to write into device (download only)', nargs='?')
+    subparser.add_argument('--wait', type=float, default=10.0)
+    subparser.set_defaults(func=ClientSession.dfu)
+
     subparser = subparsers.add_parser('fastboot',
                                       help="run fastboot")
     subparser.add_argument('fastboot_args', metavar='ARG', nargs=argparse.REMAINDER,

labgrid/remote/exporter.py

@@ -492,6 +492,7 @@ def _get_params(self):
         return p
 
 exports["AndroidFastboot"] = USBGenericExport
+exports["DFUDevice"] = USBGenericExport
 exports["IMXUSBLoader"] = USBGenericExport
 exports["MXSUSBLoader"] = USBGenericExport
 exports["RKUSBLoader"] = USBGenericExport

labgrid/resource/remote.py

@@ -119,6 +119,14 @@ def __attrs_post_init__(self):
         super().__attrs_post_init__()
 
 
+@target_factory.reg_resource
+@attr.s(eq=False)
+class NetworkDFUDevice(RemoteUSBResource):
+    def __attrs_post_init__(self):
+        self.timeout = 10.0
+        super().__attrs_post_init__()
+
+
 @target_factory.reg_resource
 @attr.s(eq=False)
 class NetworkIMXUSBLoader(RemoteUSBResource):

labgrid/resource/suggest.py

@@ -11,6 +11,7 @@
     USBVideo,
     IMXUSBLoader,
     AndroidFastboot,
+    DFUDevice,
     USBSDMuxDevice,
     USBSDWireDevice,
     AlteraUSBBlaster,
@@ -41,6 +42,7 @@ def __init__(self, args):
         self.resources.append(USBVideo(**args))
         self.resources.append(IMXUSBLoader(**args))
         self.resources.append(AndroidFastboot(**args))
+        self.resources.append(DFUDevice(**args))
         self.resources.append(USBMassStorage(**args))
         self.resources.append(USBSDMuxDevice(**args))
         self.resources.append(USBSDWireDevice(**args))

labgrid/resource/udev.py

@@ -322,6 +322,15 @@ def filter_match(self, device):
             return False
         return super().filter_match(device)
 
+@target_factory.reg_resource
+@attr.s(eq=False)
+class DFUDevice(USBResource):
+    def filter_match(self, device):
+        if ':fe0102:' not in device.properties.get('ID_USB_INTERFACES', ''):
+            return False
+
+        return super().filter_match(device)
+
 @target_factory.reg_resource
 @attr.s(eq=False)
 class USBNetworkInterface(USBResource, NetworkInterface):

man/labgrid-client.1

@@ -174,6 +174,8 @@ not at all.
 .sp
 \fBconsole (con)\fP               Connect to the console
 .sp
+\fBdfu\fP arg                     Run dfu commands
+.sp
 \fBfastboot\fP arg                Run fastboot with argument
 .sp
 \fBflashscript\fP script arg      Run arbitrary script with arguments to flash device