test: fix pylint error in u_boot_console_exec_attach.py
[platform/kernel/u-boot.git] / test / py / u_boot_console_exec_attach.py
1 # SPDX-License-Identifier: GPL-2.0
2 # Copyright (c) 2015 Stephen Warren
3 # Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
4
5 """
6 Logic to interact with U-Boot running on real hardware, typically via a
7 physical serial port.
8 """
9
10 import sys
11 from u_boot_spawn import Spawn
12 from u_boot_console_base import ConsoleBase
13
14 class ConsoleExecAttach(ConsoleBase):
15     """Represents a physical connection to a U-Boot console, typically via a
16     serial port. This implementation executes a sub-process to attach to the
17     console, expecting that the stdin/out of the sub-process will be forwarded
18     to/from the physical hardware. This approach isolates the test infra-
19     structure from the user-/installation-specific details of how to
20     communicate with, and the identity of, serial ports etc."""
21
22     def __init__(self, log, config):
23         """Initialize a U-Boot console connection.
24
25         Args:
26             log: A multiplexed_log.Logfile instance.
27             config: A "configuration" object as defined in conftest.py.
28
29         Returns:
30             Nothing.
31         """
32
33         # The max_fifo_fill value might need tweaking per-board/-SoC?
34         # 1 would be safe anywhere, but is very slow (a pexpect issue?).
35         # 16 is a common FIFO size.
36         # HW flow control would mean this could be infinite.
37         super(ConsoleExecAttach, self).__init__(log, config, max_fifo_fill=16)
38
39         with self.log.section('flash'):
40             self.log.action('Flashing U-Boot')
41             cmd = ['u-boot-test-flash', config.board_type, config.board_identity]
42             runner = self.log.get_runner(cmd[0], sys.stdout)
43             runner.run(cmd)
44             runner.close()
45             self.log.status_pass('OK')
46
47     def get_spawn(self):
48         """Connect to a fresh U-Boot instance.
49
50         The target board is reset, so that U-Boot begins running from scratch.
51
52         Args:
53             None.
54
55         Returns:
56             A u_boot_spawn.Spawn object that is attached to U-Boot.
57         """
58
59         args = [self.config.board_type, self.config.board_identity]
60         s = Spawn(['u-boot-test-console'] + args)
61
62         try:
63             self.log.action('Resetting board')
64             cmd = ['u-boot-test-reset'] + args
65             runner = self.log.get_runner(cmd[0], sys.stdout)
66             runner.run(cmd)
67             runner.close()
68         except:
69             s.close()
70             raise
71
72         return s