Merge pull request NordicSemiconductor#78 from wbober/thread

Add support for Thread DFU

Author: bencefr

README.md

@@ -13,6 +13,7 @@ This application and its library offer the following features:
 * Cryptographic key generation, management and storage
 * Bootloader DFU settings generation and display
 * Device Firmware Update procedure over Bluetooth Low Energy
+* Device Firmware Update procedure over Thread
 
 ## License
 
@@ -41,7 +42,7 @@ This will also retrieve and install all additional required packages.
 
 **Note**: Please refer to the [pc-ble-driver-py PyPI installation note on Windows](https://github.com/NordicSemiconductor/pc-ble-driver-py#installing-from-pypi) if you are running nrfutil on this operating system.
 
-**Note**: To use the `dfu ble` option you will need to set up your boards to be able to communicate with your computer.  You can find additional information here: [Hardware setup](https://github.com/NordicSemiconductor/pc-ble-driver/blob/master/Installation.md#hardware-setup).
+**Note**: To use the `dfu ble` or `dfu thread` option you will need to set up your boards to be able to communicate with your computer.  You can find additional information here: [Hardware setup](https://github.com/NordicSemiconductor/pc-ble-driver/blob/master/Installation.md#hardware-setup).
 
 ## Downloading precompiled Windows executable
 
@@ -99,11 +100,11 @@ pyinstaller /full/path/to/nrfutil.spec
 
 **Note**: Please refer to the [pc-ble-driver-py PyPI installation note on Windows](https://github.com/NordicSemiconductor/pc-ble-driver-py#installing-from-pypi) if you are running nrfutil on this operating system.
 
-**Note**: To use the `dfu ble` option you will need to set up your boards to be able to communicate with your computer.  You can find additional information here: [Hardware setup](https://github.com/NordicSemiconductor/pc-ble-driver/blob/master/Installation.md#hardware-setup). 
+**Note**: To use the `dfu ble` or `dfu thread` option you will need to set up your boards to be able to communicate with your computer.  You can find additional information here: [Hardware setup](https://github.com/NordicSemiconductor/pc-ble-driver/blob/master/Installation.md#hardware-setup). 
 
 ## Usage
 
-To get info on usage of nrfutil:  
+To get info on usage of nrfutil:
 ```
 nrfutil --help
 ```
@@ -144,6 +145,8 @@ SoftDevice            | FWID (sd-req)
 `s132_nrf52_4.0.2`    | 0x98
 `s132_nrf52_4.0.3`    | 0x99
 
+**Note**: The Thread stack doesn't use a SoftDevice but --sd-req option is required for compatibility reasons. You can provide any value for the option as it is ignored during DFU.
+
 Not all combinations of Bootloader, SoftDevice and Application are possible when generating a package. The table below summarizes the support for different combinations.
 
 The following conventions are used on the table:
@@ -169,7 +172,7 @@ nrfutil pkg display package.zip
 ```
 
 #### dfu
-This set of commands allow you to perform an actual firmware update over a serial or BLE connection.
+This set of commands allow you to perform an actual firmware update over a serial, BLE, or Thread connection.
 
 ##### ble
 Perform a full DFU procedure over a BLE connection. This command takes several options that you can list using:
@@ -182,6 +185,19 @@ nrfutil dfu ble -ic NRF52 -pkg app_dfu_package.zip -p COM3 -n "MyDevice" -f
 ```
 The `-f` option instructs nrfutil to actually program the board connected to COM3 with the connectivity software required to operate as a serialized SoftDevice. Use with caution as this will overwrite the contents of the IC's flash memory.
 
+##### Thread
+**Note**: DFU over Thread is experimental
+
+Perform a full DFU procedure over a Thread. This command takes several options that you can list using:
+```
+nrfutil dfu thread --help
+```
+Below is an example of the execution of a DFU procedure on all devices in a Thread network using a file generated above and a connectivity IC connected to COM3.
+```
+nrfutil dfu ble -pkg app_dfu_package.zip -p COM3 -f
+```
+The `-f` option instructs nrfutil to actually program the board connected to COM3 with the connectivity software required to operate as a network co-processor (NCP). Use with caution as this will overwrite the contents of the IC's flash memory.
+
 ##### serial
 Perform a full DFU procedure over a serial (UART) line. This command takes several options that you can list using:
 ```

nordicsemi/__main__.py

@@ -34,6 +34,9 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
+import ipaddress
+import signal
+from nordicsemi.thread.dfu_server import ThreadDfuServer
 
 """nrfutil command line tool."""
 import os
@@ -110,6 +113,11 @@ def int_as_text_to_int(value):
     except ValueError:
         raise NordicSemiException('%s is not a valid integer' % value)
 
+def pause():
+    try:
+        raw_input()
+    except (KeyboardInterrupt, EOFError):
+        pass
 
 class BasedIntOrNoneParamType(click.ParamType):
     name = 'Integer'
@@ -547,7 +555,7 @@ def update_progress(progress=0):
     if global_bar:
         global_bar.update(progress)
 
-@cli.group(short_help='Perform a Device Firmware Update over a BLE or serial transport.')
+@cli.group(short_help='Perform a Device Firmware Update over, BLE, Thread, or serial transport.')
 def dfu():
     """
     This set of commands supports Device Firmware Upgrade procedures over both BLE and serial transports.
@@ -598,7 +606,7 @@ def serial(package, port, flow_control, packet_receipt_notification, baud_rate):
     serial_backend.register_events_callback(DfuEvent.PROGRESS_EVENT, update_progress)
     dfu = Dfu(zip_file_path = package, dfu_transport = serial_backend)
 
-    if logger.getEffectiveLevel() > logging.INFO: 
+    if logger.getEffectiveLevel() > logging.INFO:
         with click.progressbar(length=dfu.dfu_get_total_size()) as bar:
             global global_bar
             global_bar = bar
@@ -607,7 +615,7 @@ def serial(package, port, flow_control, packet_receipt_notification, baud_rate):
         dfu.dfu_send_images()
 
     click.echo("Device programmed.")
-    
+
 
 def enumerate_ports():
     descs   = BLEDriver.enum_serial_ports()
@@ -620,6 +628,13 @@ def enumerate_ports():
     index = click.prompt('Enter your choice: ', type=click.IntRange(0, len(descs)))
     return descs[index].port
 
+def get_port_by_snr(snr):
+    serial_ports = BLEDriver.enum_serial_ports()
+    try:
+        serial_port = [d.port for d in serial_ports if d.serial_number.lstrip('0') == snr][0]
+    except IndexError:
+        raise NordicSemiException('board not found')
+    return serial_port
 
 @dfu.command(short_help="Update the firmware on a device over a BLE connection.")
 @click.option('-pkg', '--package',
@@ -697,6 +712,118 @@ def convert_version_string_to_int(s):
     js = [10000, 100, 1]
     return sum([js[i] * int(numbers[i]) for i in range(3)])
 
+@dfu.command(short_help="Update the firmware on a device over a Thread connection.")
+@click.option('-pkg', '--package',
+              help='Filename of the DFU package.',
+              type=click.Path(exists=True, resolve_path=True, file_okay=True, dir_okay=False),
+              required=True)
+@click.option('-p', '--port',
+              help='Serial port COM port to which the NCP is connected.',
+              type=click.STRING)
+@click.option('-a', '--address',
+              help='Device IPv6 address. If address is not specified then perform DFU'
+                   + 'on all capable devices.',
+              type=click.STRING)
+@click.option('-sp', '--server_port',
+              help='UDP port to which the DFU server binds. If not specified the 5683 is used.',
+              type=click.INT,
+              default=5683)
+@click.option('--prefix',
+              help='URI prefix used added to DFU resources. Defaults to ''dfu''.',
+              type=click.STRING,
+              default='dfu')
+@click.option('--panid',
+              help='802.15.4 PAN ID. If not specified then 1234 is used as PAN ID.',
+              type=click.INT)
+@click.option('--channel',
+              help='802.15.4 Channel. If not specified then channel 11 is used.',
+              type=click.INT)
+@click.option('-snr', '--jlink_snr',
+              help='Jlink serial number.',
+              type=click.STRING)
+@click.option('-f', '--flash_connectivity',
+              help='Flash connectivity firmware automatically. Default: disabled.',
+              type=click.BOOL,
+              is_flag=True)
+@click.option('-s', '--sim',
+              help='Use software NCP and connect to the OT simulator.',
+              type=click.BOOL,
+              is_flag=True)
+def thread(package, port, address, server_port, prefix, panid, channel, jlink_snr, flash_connectivity, sim):
+    ble_driver_init('NRF52')
+    from nordicsemi.thread import tncp
+    from nordicsemi.thread.dfu_thread import create_dfu_server
+    from nordicsemi.thread.tncp import NCPTransport
+    from nordicsemi.thread.ncp_flasher import NCPFlasher
+
+    """Perform a Device Firmware Update on a device with a bootloader that supports Thread DFU."""
+    if address is None:
+        address = ipaddress.ip_address(u"ff03::1")
+        click.echo("Address not specified. Using ff03::1 (all Thread nodes)")
+    else:
+        try:
+            address = ipaddress.ip_address(address)
+        except:
+            click.echo("Invalid IPv6 address")
+            return
+
+    if (not sim):
+        if port is None and jlink_snr is None:
+            click.echo("Please specify serial port or Jlink serial number.")
+            return
+
+        elif port is None:
+            port = get_port_by_snr(jlink_snr)
+            if port is None:
+                click.echo("\nNo Segger USB CDC ports found, please connect your board.")
+                return
+
+        stream_descriptor = 'u:' + port
+        logger.info("Using connectivity board at serial port: {}".format(port))
+    else:
+        stream_descriptor = 'p:' + Flasher.which('ot-ncp') + ' 30'
+        logger.info("Using ot-ncp binary: {}".format(stream_descriptor))
+
+    if flash_connectivity:
+        flasher = NCPFlasher(serial_port=port, snr = jlink_snr)
+        if flasher.fw_check():
+            click.echo("Board already flashed with connectivity firmware.")
+        else:
+            click.echo("Flashing connectivity firmware...")
+            flasher.fw_flash()
+            click.echo("Connectivity firmware flashed.")
+
+        flasher.reset()
+
+        # Delay is required because NCP needs time to initialize.
+        time.sleep(1.0)
+
+    config = tncp.NCPTransport.get_default_config()
+    if (panid):
+        config[tncp.NCPTransport.CFG_KEY_PANID] = panid
+    if (channel):
+        config[tncp.NCPTransport.CFG_KEY_CHANNEL] = channel
+    if (flash_connectivity):
+        config[tncp.NCPTransport.CFG_KEY_RESET] = False
+
+    transport = NCPTransport(server_port, stream_descriptor, config)
+    dfu = create_dfu_server(transport, package, prefix)
+
+    try:
+        sighandler = lambda signum, frame : dfu.stop
+        signal.signal(signal.SIGINT, sighandler)
+        signal.signal(signal.SIGTERM, sighandler)
+
+        dfu.start()
+        dfu.trigger(address, 3)
+        click.echo("Press <ENTER> terminate")
+        pause()
+        click.echo("Terminating")
+
+    except Exception as e:
+        logger.exception(e)
+    finally:
+        dfu.stop()
 
 if __name__ == '__main__':
     cli()

nordicsemi/thread/__init__.py

@@ -0,0 +1,43 @@
+#
+# Copyright (c) 2016 Nordic Semiconductor ASA
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+#   1. Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+#   2. Redistributions in binary form must reproduce the above copyright notice, this
+#   list of conditions and the following disclaimer in the documentation and/or
+#   other materials provided with the distribution.
+#
+#   3. Neither the name of Nordic Semiconductor ASA nor the names of other
+#   contributors to this software may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+#
+#   4. This software must only be used in or with a processor manufactured by Nordic
+#   Semiconductor ASA, or in or with a processor manufactured by a third party that
+#   is used in combination with a processor manufactured by Nordic Semiconductor.
+#
+#   5. Any software provided in binary or object form under this license must not be
+#   reverse engineered, decompiled, modified and/or disassembled.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+"""Package marker file."""
+
+import sys
+from os.path import dirname
+
+sys.path.append(dirname(__file__))