1# Copyright (c) 2015 Stephen Warren
2# Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
3#
4# SPDX-License-Identifier: GPL-2.0
5
6# Logic to interact with the sandbox port of U-Boot, running as a sub-process.
7
8import time
9from u_boot_spawn import Spawn
10from u_boot_console_base import ConsoleBase
11
12class ConsoleSandbox(ConsoleBase):
13    """Represents a connection to a sandbox U-Boot console, executed as a sub-
14    process."""
15
16    def __init__(self, log, config):
17        """Initialize a U-Boot console connection.
18
19        Args:
20            log: A multiplexed_log.Logfile instance.
21            config: A "configuration" object as defined in conftest.py.
22
23        Returns:
24            Nothing.
25        """
26
27        super(ConsoleSandbox, self).__init__(log, config, max_fifo_fill=1024)
28
29    def get_spawn(self):
30        """Connect to a fresh U-Boot instance.
31
32        A new sandbox process is created, so that U-Boot begins running from
33        scratch.
34
35        Args:
36            None.
37
38        Returns:
39            A u_boot_spawn.Spawn object that is attached to U-Boot.
40        """
41
42        cmd = [
43            self.config.build_dir + '/u-boot',
44            '-d',
45            self.config.build_dir + '/arch/sandbox/dts/test.dtb'
46        ]
47        return Spawn(cmd, cwd=self.config.source_dir)
48
49    def kill(self, sig):
50        """Send a specific Unix signal to the sandbox process.
51
52        Args:
53            sig: The Unix signal to send to the process.
54
55        Returns:
56            Nothing.
57        """
58
59        self.log.action('kill %d' % sig)
60        self.p.kill(sig)
61
62    def validate_exited(self):
63        """Determine whether the sandbox process has exited.
64
65        If required, this function waits a reasonable time for the process to
66        exit.
67
68        Args:
69            None.
70
71        Returns:
72            Boolean indicating whether the process has exited.
73        """
74
75        p = self.p
76        self.p = None
77        for i in xrange(100):
78            ret = not p.isalive()
79            if ret:
80                break
81            time.sleep(0.1)
82        p.close()
83        return ret
84