runners: bossac: Add speed argument

The current stty command uses a hard code value of 1200.  This is not
compliant with SAM-BA specs and may create compatibility problems.  Add
an optional speed argument with 115200 as default value following SAM-BA
specifications.  All boards that needs a different speed should define
board_runner_args(bossac "--speed=<value>") with value as required
speed.

Signed-off-by: Gerson Fernando Budke <nandojve@gmail.com>

Author: nandojve

scripts/west_commands/runners/bossac.py

@@ -11,16 +11,18 @@
 from runners.core import ZephyrBinaryRunner, RunnerCaps, BuildConfiguration
 
 DEFAULT_BOSSAC_PORT = '/dev/ttyACM0'
+DEFAULT_BOSSAC_SPEED = '115200'
 
 
 class BossacBinaryRunner(ZephyrBinaryRunner):
     '''Runner front-end for bossac.'''
 
     def __init__(self, cfg, bossac='bossac', port=DEFAULT_BOSSAC_PORT,
-                 offset=None):
+                 speed=DEFAULT_BOSSAC_SPEED, offset=None):
         super().__init__(cfg)
         self.bossac = bossac
         self.port = port
+        self.speed = speed
         self.offset = offset
 
     @classmethod
@@ -39,8 +41,12 @@ def do_add_parser(cls, parser):
                             help='start erase/write/read/verify operation '
                                  'at flash OFFSET; OFFSET must be aligned '
                                  ' to a flash page boundary')
-        parser.add_argument('--bossac-port', default='/dev/ttyACM0',
-                            help='serial port to use, default is /dev/ttyACM0')
+        parser.add_argument('--bossac-port', default=DEFAULT_BOSSAC_PORT,
+                            help='serial port to use, default is ' +
+                            DEFAULT_BOSSAC_PORT)
+        parser.add_argument('--speed', default=DEFAULT_BOSSAC_SPEED,
+                            help='serial port speed to use, default is ' +
+                            DEFAULT_BOSSAC_SPEED)
 
     @classmethod
     def get_flash_offset(cls, cfg):
@@ -58,7 +64,8 @@ def do_create(cls, cfg, args):
         if offset is None:
             offset = cls.get_flash_offset(cfg)
         return BossacBinaryRunner(cfg, bossac=args.bossac,
-                                  port=args.bossac_port, offset=offset)
+                                  port=args.bossac_port, speed=args.speed,
+                                  offset=offset)
 
     def read_help(self):
         """Run bossac --help and return the output as a list of lines"""
@@ -110,9 +117,9 @@ def do_run(self, command, **kwargs):
 
         if platform.system() == 'Linux':
             self.require('stty')
-            cmd_stty = ['stty', '-F', self.port, 'raw', 'ispeed', '1200',
-                        'ospeed', '1200', 'cs8', '-cstopb', 'ignpar', 'eol', '255',
-                        'eof', '255']
+            cmd_stty = ['stty', '-F', self.port, 'raw', 'ispeed', self.speed,
+                        'ospeed', self.speed, 'cs8', '-cstopb', 'ignpar',
+                        'eol', '255', 'eof', '255']
             self.check_call(cmd_stty)
 
         cmd_flash = [self.bossac, '-p', self.port, '-R', '-e', '-w', '-v',

scripts/west_commands/tests/test_bossac.py

@@ -16,27 +16,39 @@
     pytest.skip("skipping Linux-only bossac tests", allow_module_level=True)
 
 TEST_BOSSAC_PORT = 'test-bossac-serial'
+TEST_BOSSAC_SPEED = '1200'
 TEST_OFFSET = 1234
 TEST_FLASH_ADDRESS = 5678
 
 EXPECTED_COMMANDS = [
-    ['stty', '-F', TEST_BOSSAC_PORT, 'raw', 'ispeed', '1200', 'ospeed', '1200',
-     'cs8', '-cstopb', 'ignpar', 'eol', '255', 'eof', '255'],
+    ['stty', '-F', TEST_BOSSAC_PORT, 'raw', 'ispeed', '115200',
+     'ospeed', '115200', 'cs8', '-cstopb', 'ignpar', 'eol', '255',
+     'eof', '255'],
+    ['bossac', '-p', TEST_BOSSAC_PORT, '-R', '-e', '-w', '-v',
+     '-b', RC_KERNEL_BIN],
+]
+
+EXPECTED_COMMANDS_WITH_SPEED = [
+    ['stty', '-F', TEST_BOSSAC_PORT, 'raw', 'ispeed', TEST_BOSSAC_SPEED,
+     'ospeed', TEST_BOSSAC_SPEED, 'cs8', '-cstopb', 'ignpar', 'eol', '255',
+     'eof', '255'],
     ['bossac', '-p', TEST_BOSSAC_PORT, '-R', '-e', '-w', '-v',
      '-b', RC_KERNEL_BIN],
 ]
 
 EXPECTED_COMMANDS_WITH_OFFSET = [
-    ['stty', '-F', TEST_BOSSAC_PORT, 'raw', 'ispeed', '1200', 'ospeed', '1200',
-     'cs8', '-cstopb', 'ignpar', 'eol', '255', 'eof', '255'],
+    ['stty', '-F', TEST_BOSSAC_PORT, 'raw', 'ispeed', '115200',
+     'ospeed', '115200', 'cs8', '-cstopb', 'ignpar', 'eol', '255',
+     'eof', '255'],
     ['bossac', '-p', TEST_BOSSAC_PORT, '-R', '-e', '-w', '-v',
      '-b', RC_KERNEL_BIN, '-o', str(TEST_OFFSET)],
 ]
 
 EXPECTED_COMMANDS_WITH_FLASH_ADDRESS = [
     [
-        'stty', '-F', TEST_BOSSAC_PORT, 'raw', 'ispeed', '1200', 'ospeed',
-        '1200', 'cs8', '-cstopb', 'ignpar', 'eol', '255', 'eof', '255'
+        'stty', '-F', TEST_BOSSAC_PORT, 'raw', 'ispeed', '115200',
+        'ospeed', '115200', 'cs8', '-cstopb', 'ignpar', 'eol', '255',
+        'eof', '255'
     ],
     [
         'bossac',
@@ -67,6 +79,7 @@ def test_bossac_init(cc, req, supports, runner_config):
     runner.run('flash')
     assert cc.call_args_list == [call(x) for x in EXPECTED_COMMANDS_WITH_OFFSET]
 
+
 @patch('runners.bossac.BossacBinaryRunner.supports', return_value=True)
 @patch('runners.core.BuildConfiguration._init')
 @patch('runners.bossac.BossacBinaryRunner.get_flash_offset',
@@ -84,6 +97,25 @@ def test_bossac_create(cc, req, gfa, bcfg, supports, runner_config):
     assert cc.call_args_list == [call(x) for x in EXPECTED_COMMANDS]
 
 
+@patch('runners.bossac.BossacBinaryRunner.supports', return_value=True)
+@patch('runners.core.BuildConfiguration._init')
+@patch('runners.bossac.BossacBinaryRunner.get_flash_offset',
+       return_value=None)
+@patch('runners.core.ZephyrBinaryRunner.require', side_effect=require_patch)
+@patch('runners.core.ZephyrBinaryRunner.check_call')
+def test_bossac_create_with_speed(cc, req, gfa, bcfg, supports,
+                                  runner_config):
+    '''Test commands using a runner created from command line parameters.'''
+    args = ['--bossac-port', str(TEST_BOSSAC_PORT),
+            '--speed', str(TEST_BOSSAC_SPEED)]
+    parser = argparse.ArgumentParser()
+    BossacBinaryRunner.add_parser(parser)
+    arg_namespace = parser.parse_args(args)
+    runner = BossacBinaryRunner.create(runner_config, arg_namespace)
+    runner.run('flash')
+    assert cc.call_args_list == [call(x) for x in EXPECTED_COMMANDS_WITH_SPEED]
+
+
 @patch('runners.bossac.BossacBinaryRunner.supports', return_value=True)
 @patch('runners.core.BuildConfiguration._init')
 @patch('runners.bossac.BossacBinaryRunner.get_flash_offset',