Merge pull request #959 from alegsan/topic/ok/android-net-fastboot

driver: fastbootdriver: support fastboot over network

Author: Emantor

doc/configuration.rst

@@ -605,13 +605,15 @@ NetworkRKUSBLoader
 ~~~~~~~~~~~~~~~~~~~
 A NetworkRKUSBLoader describes an `RKUSBLoader`_ available on a remote computer.
 
-AndroidFastboot
-~~~~~~~~~~~~~~~
-An AndroidFastboot resource describes a USB device in the fastboot state.
+AndroidUSBFastboot
+~~~~~~~~~~~~~~~~~~
+An AndroidUSBFastboot resource describes a USB device in the fastboot state.
+Previously, this resource was named AndroidFastboot and this name still
+supported for backwards compatibility.
 
 .. code-block:: yaml
 
-   AndroidFastboot:
+   AndroidUSBFastboot:
      match:
        ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
 
@@ -625,6 +627,25 @@ Arguments:
 Used by:
   - `AndroidFastbootDriver`_
 
+AndroidNetFastboot
+~~~~~~~~~~~~~~~~~~
+An AndroidNetFastboot resource describes a network device in fastboot state.
+
+.. code-block:: yaml
+
+   AndroidNetFastboot:
+     address: "192.168.23.42"
+
+Arguments:
+  - address (str): ip address of the fastboot device
+  - port (int, default=5554): udp/tcp fastboot port that is used in the
+    device. (e.g. Barebox uses port 5554)
+  - protocol (str, default="udp"): which protocol should be used when issuing
+    fastboot commands. (Barebox supports currently only the udp protocol)
+
+Used by:
+  - `AndroidFastbootDriver`_
+
 DFUDevice
 ~~~~~~~~~
 A DFUDevice resource describes a USB device in DFU (Device Firmware Upgrade)
@@ -1159,7 +1180,7 @@ The initial matching and monitoring for udev events is handled by the
 :any:`UdevManager` class.
 This manager is automatically created when a resource derived from
 :any:`USBResource` (such as :any:`USBSerialPort`, :any:`IMXUSBLoader` or
-:any:`AndroidFastboot`) is instantiated.
+:any:`AndroidUSBFastboot`) is instantiated.
 
 To identify the kernel device which corresponds to a configured `USBResource`,
 each existing (and subsequently added) kernel device is matched against the
@@ -1205,15 +1226,15 @@ device's parents instead of directly to itself.
 This is necessary for the `USBSerialPort` because we actually want to find the
 ``ttyUSB?`` device below the USB serial converter device.
 
-Matching an Android Fastboot Device
-+++++++++++++++++++++++++++++++++++
+Matching an Android USB Fastboot Device
++++++++++++++++++++++++++++++++++++++++
 
 In this case, we want to match the USB device on that port directly, so we
 don't use a parent match.
 
 .. code-block:: yaml
 
-  AndroidFastboot:
+  AndroidUSBFastboot:
     match:
       sys_name: '1-1.2.3'
 
@@ -1548,12 +1569,13 @@ Arguments:
 
 AndroidFastbootDriver
 ~~~~~~~~~~~~~~~~~~~~~
-An AndroidFastbootDriver allows the upload of images to a device in the USB
-fastboot state.
+An AndroidFastbootDriver allows the upload of images to a device in the USB or
+network fastboot state.
 
 Binds to:
   fastboot:
-    - `AndroidFastboot`_
+    - `AndroidUSBFastboot`_
+    - `AndroidNetFastboot`_
 
 Implements:
   - None (yet)

doc/overview.rst

@@ -33,7 +33,7 @@ Resources
 `Resources` are passive and only store the information to access the
 corresponding part of the `Target`.
 Typical examples of resources are :any:`RawSerialPort`, :any:`NetworkPowerPort`
-and :any:`AndroidFastboot`.
+and :any:`AndroidUSBFastboot`.
 
 An important type of `Resources` are :any:`ManagedResources <ManagedResource>`.
 While normal `Resources` are always considered available for use and have fixed
@@ -44,7 +44,7 @@ They can appear/disappear at runtime and have different properties each time
 they are discovered.
 The most common examples of `ManagedResources` are the various USB resources
 discovered using udev, such as :any:`USBSerialPort`, :any:`IMXUSBLoader` or
-:any:`AndroidFastboot`.
+:any:`AndroidUSBFastboot`.
 
 Drivers and Protocols
 ~~~~~~~~~~~~~~~~~~~~~
@@ -112,7 +112,7 @@ A realistic sequence of activation might look like this:
   :any:`IMXUSBLoader` resource to be available)
 - load the bootloader (:any:`BootstrapProtocol.load`)
 - activate the :any:`AndroidFastbootDriver` driver on the target (this will
-  wait for the :any:`AndroidFastboot` resource to be available)
+  wait for the :any:`AndroidUSBFastboot` resource to be available)
 - boot the kernel (:any:`AndroidFastbootDriver.boot`)
 - activate the :any:`ShellDriver` driver on the target (this will wait for the
   :any:`USBSerialPort` resource to be available and log in)
@@ -347,7 +347,7 @@ For resource types which do not have an existing, network-transparent protocol
 the mapping done by the exporter.
 
 For generic USB resources, the exporter for example maps a
-:any:`AndroidFastboot` resource to a :any:`NetworkAndroidFastboot` resource and
+:any:`AndroidUSBFastboot` resource to a :any:`RemoteAndroidUSBFastboot` resource and
 adds a hostname property which needs to be used by the client to connect to the
 exporter.
 To avoid the need for additional remote access protocols and authentication,

labgrid/driver/fastbootdriver.py

@@ -7,13 +7,17 @@
 from ..exceptions import InvalidConfigError
 from ..util.managedfile import ManagedFile
 from ..util.helper import processwrapper
+from ..resource.udev import AndroidUSBFastboot
+from ..resource.fastboot import AndroidNetFastboot
+from ..resource.remote import RemoteAndroidUSBFastboot, RemoteAndroidNetFastboot
 
 
 @target_factory.reg_driver
 @attr.s(eq=False)
 class AndroidFastbootDriver(Driver):
     bindings = {
-        "fastboot": {"AndroidFastboot", "NetworkAndroidFastboot"},
+        "fastboot": {AndroidUSBFastboot, RemoteAndroidUSBFastboot,
+                     AndroidNetFastboot, RemoteAndroidNetFastboot},
     }
 
     boot_image = attr.ib(
@@ -38,10 +42,12 @@ def __attrs_post_init__(self):
             self.tool = 'fastboot'
 
     def _get_fastboot_prefix(self):
-        prefix = self.fastboot.command_prefix+[
-            self.tool,
-            "-s", f"usb:{self.fastboot.path}",
-        ]
+        if isinstance(self.fastboot, (AndroidUSBFastboot, RemoteAndroidUSBFastboot)):
+            option = f"usb:{self.fastboot.path}"
+        else:
+            option = f"{self.fastboot.protocol}:{self.fastboot.address}:{self.fastboot.port}"
+
+        prefix = self.fastboot.command_prefix + [ self.tool, "-s", option ]
 
         if self.sparse_size is not None:
             prefix += ["-S", self.sparse_size]

labgrid/remote/exporter.py

@@ -491,7 +491,14 @@ def _get_params(self):
         p['devnode'] = self.local.devnode
         return p
 
+@attr.s(eq=False)
+class USBGenericRemoteExport(USBGenericExport):
+    def __attrs_post_init__(self):
+        super().__attrs_post_init__()
+        self.data['cls'] = f"Remote{self.cls}".replace("Network", "")
+
 exports["AndroidFastboot"] = USBGenericExport
+exports["AndroidUSBFastboot"] = USBGenericRemoteExport
 exports["DFUDevice"] = USBGenericExport
 exports["IMXUSBLoader"] = USBGenericExport
 exports["MXSUSBLoader"] = USBGenericExport
@@ -669,6 +676,21 @@ def _get_params(self):
 
 exports["LXAIOBusPIO"] = LXAIOBusNodeExport
 
+@attr.s(eq=False)
+class AndroidNetFastbootExport(ResourceExport):
+    def __attrs_post_init__(self):
+        super().__attrs_post_init__()
+        local_cls_name = self.cls
+        self.data['cls'] = f"Remote{self.cls}"
+        from ..resource import fastboot
+        local_cls = getattr(fastboot, local_cls_name)
+        self.local = local_cls(target=None, name=None, **self.local_params)
+
+    def _get_params(self):
+        """Helper function to return parameters"""
+        return {'host' : self.host, **self.local_params}
+
+exports["AndroidNetFastboot"] = AndroidNetFastbootExport
 
 class ExporterSession(ApplicationSession):
     def onConnect(self):

labgrid/resource/fastboot.py

@@ -0,0 +1,11 @@
+import attr
+
+from ..factory import target_factory
+from .common import Resource
+
+@target_factory.reg_resource
+@attr.s(eq=False)
+class AndroidNetFastboot(Resource):
+    address = attr.ib(validator=attr.validators.instance_of(str))
+    port = attr.ib(default=5554, validator=attr.validators.instance_of(int))
+    protocol = attr.ib(default="udp", validator=attr.validators.instance_of(str))

labgrid/resource/remote.py

@@ -113,12 +113,30 @@ class RemoteUSBResource(NetworkResource, ManagedResource):
 
 @target_factory.reg_resource
 @attr.s(eq=False)
-class NetworkAndroidFastboot(RemoteUSBResource):
+class RemoteAndroidUSBFastboot(RemoteUSBResource):
     def __attrs_post_init__(self):
         self.timeout = 10.0
         super().__attrs_post_init__()
 
 
+@target_factory.reg_resource
+@attr.s(eq=False)
+class NetworkAndroidFastboot(RemoteAndroidUSBFastboot):
+    def __attrs_post_init__(self):
+        import warnings
+        warnings.warn("NetworkAndroidFastboot is deprecated, use RemoteAndroidUSBFastboot instead",
+                      DeprecationWarning)
+        super().__attrs_post_init__()
+
+
+@target_factory.reg_resource
+@attr.s(eq=False)
+class RemoteAndroidNetFastboot(NetworkResource):
+    address = attr.ib(validator=attr.validators.instance_of(str))
+    port = attr.ib(default=5554, validator=attr.validators.instance_of(int))
+    protocol = attr.ib(default="udp", validator=attr.validators.instance_of(str))
+
+
 @target_factory.reg_resource
 @attr.s(eq=False)
 class NetworkDFUDevice(RemoteUSBResource):

labgrid/resource/suggest.py

@@ -10,7 +10,7 @@
     USBTMC,
     USBVideo,
     IMXUSBLoader,
-    AndroidFastboot,
+    AndroidUSBFastboot,
     DFUDevice,
     USBSDMuxDevice,
     USBSDWireDevice,
@@ -42,7 +42,7 @@ def __init__(self, args):
         self.resources.append(USBTMC(**args))
         self.resources.append(USBVideo(**args))
         self.resources.append(IMXUSBLoader(**args))
-        self.resources.append(AndroidFastboot(**args))
+        self.resources.append(AndroidUSBFastboot(**args))
         self.resources.append(DFUDevice(**args))
         self.resources.append(USBMassStorage(**args))
         self.resources.append(USBSDMuxDevice(**args))

labgrid/resource/udev.py

@@ -312,7 +312,7 @@ def filter_match(self, device):
 
 @target_factory.reg_resource
 @attr.s(eq=False)
-class AndroidFastboot(USBResource):
+class AndroidUSBFastboot(USBResource):
     usb_vendor_id = attr.ib(default='1d6b', validator=attr.validators.instance_of(str))
     usb_product_id = attr.ib(default='0104', validator=attr.validators.instance_of(str))
     def filter_match(self, device):
@@ -322,6 +322,14 @@ def filter_match(self, device):
             return False
         return super().filter_match(device)
 
+@target_factory.reg_resource
+@attr.s(eq=False)
+class AndroidFastboot(AndroidUSBFastboot):
+    def __attrs_post_init__(self):
+        warnings.warn("AndroidFastboot is deprecated, use AndroidUSBFastboot instead",
+                      DeprecationWarning)
+        super().__attrs_post_init__()
+
 @target_factory.reg_resource
 @attr.s(eq=False)
 class DFUDevice(USBResource):

tests/test_environment.py

@@ -88,7 +88,7 @@ def test_create_named_resources(self, tmpdir):
         targets:
           test1:
             resources:
-            - AndroidFastboot:
+            - AndroidUSBFastboot:
                 name: "fastboot"
                 match: {}
             - RawSerialPort:
@@ -106,7 +106,7 @@ def test_create_named_drivers(self, tmpdir):
         targets:
           test1:
             resources:
-            - AndroidFastboot:
+            - AndroidUSBFastboot:
                 name: "fastboot"
                 match: {}
             - RawSerialPort: