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        return Spawn([self.config.build_dir + '/u-boot'])
43
44    def kill(self, sig):
45        '''Send a specific Unix signal to the sandbox process.
46
47        Args:
48            sig: The Unix signal to send to the process.
49
50        Returns:
51            Nothing.
52        '''
53
54        self.ensure_spawned()
55        self.log.action('kill %d' % sig)
56        self.p.kill(sig)
57
58    def validate_exited(self):
59        '''Determine whether the sandbox process has exited.
60
61        If required, this function waits a reasonable time for the process to
62        exit.
63
64        Args:
65            None.
66
67        Returns:
68            Boolean indicating whether the process has exited.
69        '''
70
71        p = self.p
72        self.p = None
73        for i in xrange(100):
74            ret = not p.isalive()
75            if ret:
76                break
77            time.sleep(0.1)
78        p.close()
79        return ret
80