twister: Allow baud rates other than 115200

Fixes zephyrproject-rtos#38046
Document the changes in twister.rst
Add baud rate to debug message in twister
Add baud parameter to twister's add_device function
Set the twister baud rate from input parameters
Use 115200 as the default baud rate if not specified
Add baud to the hwmap-schema.yaml file
Add --device-serial-baud to twister arguments
Fix compliance issues
Fix mistake in parameter name from device-baud to device-serial-baud
Refactoring of the code in orded to simplify the logic
   and clear multiple definitions of the default baud rate.

Signed-off-by: Maciej Perkowski <Maciej.Perkowski@nordicsemi.no>
Signed-off-by: Dennis Ruffer <daruffer@gmail.com>

Author: DRuffer

doc/guides/test/twister.rst

@@ -41,8 +41,8 @@ To run the script in the local tree, follow the steps below:
         $ source zephyr-env.sh
         $ ./scripts/twister
 
-If you have a system with a large number of cores, you can build and run
-all possible tests using the following options:
+If you have a system with a large number of cores and plenty of free storage space,
+you can build and run all possible tests using the following options:
 
 ::
 
@@ -512,21 +512,24 @@ Executing tests on a single device
 To use this feature on a single connected device, run twister with
 the following new options::
 
-	scripts/twister --device-testing --device-serial /dev/ttyACM0 -p \
-	frdm_k64f  -T tests/kernel
+	scripts/twister --device-testing --device-serial /dev/ttyACM0 \
+	--device-serial-baud 9600 -p frdm_k64f  -T tests/kernel
 
 The ``--device-serial`` option denotes the serial device the board is connected to.
 This needs to be accessible by the user running twister. You can run this on
 only one board at a time, specified using the ``--platform`` option.
 
+The ``--device-serial-baud`` option is only needed if your device does not run at
+115200 baud.
+
 
 Executing tests on multiple devices
 ===================================
 
 To build and execute tests on multiple devices connected to the host PC, a
 hardware map needs to be created with all connected devices and their
-details such as the serial device and their IDs if available. Run the following
-command to produce the hardware map::
+details such as the serial device, baud and their IDs if available.
+Run the following command to produce the hardware map::
 
     ./scripts/twister --generate-hardware-map map.yml
 
@@ -558,12 +561,16 @@ this example we are using a reel_board and an nrf52840dk_nrf52840::
     product: DAPLink CMSIS-DAP
     runner: pyocd
     serial: /dev/cu.usbmodem146114202
+    baud: '9600'
   - connected: true
     id: 000683759358
     platform: nrf52840dk_nrf52840
     product: J-Link
     runner: nrfjprog
     serial: /dev/cu.usbmodem0006837593581
+    baud: '9600'
+
+The baud entry is only needed if not running at 115200.
 
 If the map file already exists, then new entries are added and existing entries
 will be updated. This way you can use one single master hardware map and update

scripts/pylib/twister/twisterlib.py

@@ -733,7 +733,7 @@ def handle(self):
         else:
             serial_device = hardware.serial
 
-        logger.debug("Using serial device {}".format(serial_device))
+        logger.debug("Using serial device {} @ {} baud".format(serial_device, hardware.serial_baud))
 
         if (self.suite.west_flash is not None) or runner:
             command = ["west", "flash", "--skip-rebuild", "-d", self.build_dir]
@@ -790,7 +790,7 @@ def handle(self):
         try:
             ser = serial.Serial(
                 serial_device,
-                baudrate=115200,
+                baudrate=hardware.serial_baud,
                 parity=serial.PARITY_NONE,
                 stopbits=serial.STOPBITS_ONE,
                 bytesize=serial.EIGHTBITS,
@@ -3926,10 +3926,12 @@ def _generate(self, outdir, coveragelog):
                                ["-o", os.path.join(subdir, "index.html")],
                                stdout=coveragelog)
 
+
 class DUT(object):
     def __init__(self,
                  id=None,
                  serial=None,
+                 serial_baud=None,
                  platform=None,
                  product=None,
                  serial_pty=None,
@@ -3940,6 +3942,9 @@ def __init__(self,
                  runner=None):
 
         self.serial = serial
+        self.serial_baud = 115200
+        if serial_baud:
+            self.serial_baud = serial_baud
         self.platform = platform
         self.serial_pty = serial_pty
         self._counter = Value("i", 0)
@@ -4031,8 +4036,8 @@ def __init__(self):
         self.detected = []
         self.duts = []
 
-    def add_device(self, serial, platform, pre_script, is_pty):
-        device = DUT(platform=platform, connected=True, pre_script=pre_script)
+    def add_device(self, serial, platform, pre_script, is_pty, baud=None):
+        device = DUT(platform=platform, connected=True, pre_script=pre_script, serial_baud=baud)
 
         if is_pty:
             device.serial_pty = serial
@@ -4052,13 +4057,15 @@ def load(self, map_file):
             id = dut.get('id')
             runner = dut.get('runner')
             serial = dut.get('serial')
+            baud = dut.get('baud', None)
             product = dut.get('product')
             fixtures = dut.get('fixtures', [])
             new_dut = DUT(platform=platform,
                           product=product,
                           runner=runner,
                           id=id,
                           serial=serial,
+                          serial_baud=baud,
                           connected=serial is not None,
                           pre_script=pre_script,
                           post_script=post_script,

scripts/schemas/twister/hwmap-schema.yaml

@@ -30,6 +30,9 @@ sequence:
       "serial":
         type: str
         required: false
+      "baud":
+        type: int
+        required: false
       "post_script":
         type: str
         required: false

scripts/twister

@@ -214,7 +214,7 @@ logger.setLevel(logging.DEBUG)
 def size_report(sc):
     logger.info(sc.filename)
     logger.info("SECTION NAME             VMA        LMA     SIZE  HEX SZ TYPE")
-    for i in range(len(sc.sections)):
+    for i in enumerate(sc.sections):
         v = sc.sections[i]
 
         logger.info("%-17s 0x%08x 0x%08x %8d 0x%05x %-7s" %
@@ -621,6 +621,10 @@ structure in the main Zephyr tree: boards/<arch>/<board_name>/""")
         "-X", "--fixture", action="append", default=[],
         help="Specify a fixture that a board might support")
 
+    parser.add_argument(
+        "--device-serial-baud", action="store", default=None,
+        help="Serial device baud rate (default 115200)")
+
     serial = parser.add_mutually_exclusive_group()
     serial.add_argument("--device-serial",
                         help="""Serial device for accessing the board
@@ -925,9 +929,11 @@ def main():
             if options.platform and len(options.platform) == 1:
                 if options.device_serial:
                     hwm.add_device(options.device_serial,
-                                                 options.platform[0],
-                                                 options.pre_script,
-                                                 False)
+                                   options.platform[0],
+                                   options.pre_script,
+                                   False,
+                                   baud=options.device_serial_baud
+                                   )
                 else:
                     hwm.add_device(options.device_serial_pty,
                                                  options.platform[0],