1 # Copyright (c) 2015 Stephen Warren
2 # Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
4 # SPDX-License-Identifier: GPL-2.0
6 # Common logic to interact with U-Boot via the console. This class provides
7 # the interface that tests use to execute U-Boot shell commands and wait for
8 # their results. Sub-classes exist to perform board-type-specific setup
9 # operations, such as spawning a sub-process for Sandbox, or attaching to the
10 # serial console of real hardware.
12 import multiplexed_log
19 # Regexes for text we expect U-Boot to send to the console.
20 pattern_u_boot_spl_signon = re.compile('(U-Boot SPL \\d{4}\\.\\d{2}[^\r\n]*\\))')
21 pattern_u_boot_main_signon = re.compile('(U-Boot \\d{4}\\.\\d{2}[^\r\n]*\\))')
22 pattern_stop_autoboot_prompt = re.compile('Hit any key to stop autoboot: ')
23 pattern_unknown_command = re.compile('Unknown command \'.*\' - try \'help\'')
24 pattern_error_notification = re.compile('## Error: ')
25 pattern_error_please_reset = re.compile('### ERROR ### Please RESET the board ###')
31 ('spl_signon', pattern_u_boot_spl_signon),
32 ('main_signon', pattern_u_boot_main_signon),
33 ('stop_autoboot_prompt', pattern_stop_autoboot_prompt),
34 ('unknown_command', pattern_unknown_command),
35 ('error_notification', pattern_error_notification),
36 ('error_please_reset', pattern_error_please_reset),
39 class ConsoleDisableCheck(object):
40 """Context manager (for Python's with statement) that temporarily disables
41 the specified console output error check. This is useful when deliberately
42 executing a command that is known to trigger one of the error checks, in
43 order to test that the error condition is actually raised. This class is
44 used internally by ConsoleBase::disable_check(); it is not intended for
47 def __init__(self, console, check_type):
48 self.console = console
49 self.check_type = check_type
52 self.console.disable_check_count[self.check_type] += 1
53 self.console.eval_bad_patterns()
55 def __exit__(self, extype, value, traceback):
56 self.console.disable_check_count[self.check_type] -= 1
57 self.console.eval_bad_patterns()
59 class ConsoleSetupTimeout(object):
60 """Context manager (for Python's with statement) that temporarily sets up
61 timeout for specific command. This is useful when execution time is greater
64 def __init__(self, console, timeout):
66 self.orig_timeout = self.p.timeout
67 self.p.timeout = timeout
72 def __exit__(self, extype, value, traceback):
73 self.p.timeout = self.orig_timeout
75 class ConsoleBase(object):
76 """The interface through which test functions interact with the U-Boot
77 console. This primarily involves executing shell commands, capturing their
78 results, and checking for common error conditions. Some common utilities
79 are also provided too."""
81 def __init__(self, log, config, max_fifo_fill):
82 """Initialize a U-Boot console connection.
84 Can only usefully be called by sub-classes.
87 log: A mulptiplex_log.Logfile object, to which the U-Boot output
89 config: A configuration data structure, as built by conftest.py.
90 max_fifo_fill: The maximum number of characters to send to U-Boot
91 command-line before waiting for U-Boot to echo the characters
92 back. For UART-based HW without HW flow control, this value
93 should be set less than the UART RX FIFO size to avoid
94 overflow, assuming that U-Boot can't keep up with full-rate
95 traffic at the baud rate.
103 self.max_fifo_fill = max_fifo_fill
105 self.logstream = self.log.get_stream('console', sys.stdout)
107 # Array slice removes leading/trailing quotes
108 self.prompt = self.config.buildconfig['config_sys_prompt'][1:-1]
109 self.prompt_escaped = re.escape(self.prompt)
111 self.disable_check_count = {pat[PAT_ID]: 0 for pat in bad_pattern_defs}
112 self.eval_bad_patterns()
114 self.at_prompt = False
115 self.at_prompt_logevt = None
117 def eval_bad_patterns(self):
118 self.bad_patterns = [pat[PAT_RE] for pat in bad_pattern_defs \
119 if self.disable_check_count[pat[PAT_ID]] == 0]
120 self.bad_pattern_ids = [pat[PAT_ID] for pat in bad_pattern_defs \
121 if self.disable_check_count[pat[PAT_ID]] == 0]
124 """Terminate the connection to the U-Boot console.
126 This function is only useful once all interaction with U-Boot is
127 complete. Once this function is called, data cannot be sent to or
128 received from U-Boot.
139 self.logstream.close()
141 def run_command(self, cmd, wait_for_echo=True, send_nl=True,
142 wait_for_prompt=True):
143 """Execute a command via the U-Boot console.
145 The command is always sent to U-Boot.
147 U-Boot echoes any command back to its output, and this function
148 typically waits for that to occur. The wait can be disabled by setting
149 wait_for_echo=False, which is useful e.g. when sending CTRL-C to
150 interrupt a long-running command such as "ums".
152 Command execution is typically triggered by sending a newline
153 character. This can be disabled by setting send_nl=False, which is
154 also useful when sending CTRL-C.
156 This function typically waits for the command to finish executing, and
157 returns the console output that it generated. This can be disabled by
158 setting wait_for_prompt=False, which is useful when invoking a long-
159 running command such as "ums".
162 cmd: The command to send.
163 wait_for_each: Boolean indicating whether to wait for U-Boot to
164 echo the command text back to its output.
165 send_nl: Boolean indicating whether to send a newline character
166 after the command string.
167 wait_for_prompt: Boolean indicating whether to wait for the
168 command prompt to be sent by U-Boot. This typically occurs
169 immediately after the command has been executed.
172 If wait_for_prompt == False:
175 The output from U-Boot during command execution. In other
176 words, the text U-Boot emitted between the point it echod the
177 command string and emitted the subsequent command prompts.
180 if self.at_prompt and \
181 self.at_prompt_logevt != self.logstream.logfile.cur_evt:
182 self.logstream.write(self.prompt, implicit=True)
185 self.at_prompt = False
189 # Limit max outstanding data, so UART FIFOs don't overflow
190 chunk = cmd[:self.max_fifo_fill]
191 cmd = cmd[self.max_fifo_fill:]
193 if not wait_for_echo:
195 chunk = re.escape(chunk)
196 chunk = chunk.replace('\\\n', '[\r\n]')
197 m = self.p.expect([chunk] + self.bad_patterns)
199 self.at_prompt = False
200 raise Exception('Bad pattern found on console: ' +
201 self.bad_pattern_ids[m - 1])
202 if not wait_for_prompt:
204 m = self.p.expect([self.prompt_escaped] + self.bad_patterns)
206 self.at_prompt = False
207 raise Exception('Bad pattern found on console: ' +
208 self.bad_pattern_ids[m - 1])
209 self.at_prompt = True
210 self.at_prompt_logevt = self.logstream.logfile.cur_evt
211 # Only strip \r\n; space/TAB might be significant if testing
213 return self.p.before.strip('\r\n')
214 except Exception as ex:
215 self.log.error(str(ex))
220 """Send a CTRL-C character to U-Boot.
222 This is useful in order to stop execution of long-running synchronous
223 commands such as "ums".
232 self.log.action('Sending Ctrl-C')
233 self.run_command(chr(3), wait_for_echo=False, send_nl=False)
235 def wait_for(self, text):
236 """Wait for a pattern to be emitted by U-Boot.
238 This is useful when a long-running command such as "dfu" is executing,
239 and it periodically emits some text that should show up at a specific
240 location in the log file.
243 text: The text to wait for; either a string (containing raw text,
244 not a regular expression) or an re object.
250 if type(text) == type(''):
251 text = re.escape(text)
252 m = self.p.expect([text] + self.bad_patterns)
254 raise Exception('Bad pattern found on console: ' +
255 self.bad_pattern_ids[m - 1])
257 def drain_console(self):
258 """Read from and log the U-Boot console for a short time.
260 U-Boot's console output is only logged when the test code actively
261 waits for U-Boot to emit specific data. There are cases where tests
262 can fail without doing this. For example, if a test asks U-Boot to
263 enable USB device mode, then polls until a host-side device node
264 exists. In such a case, it is useful to log U-Boot's console output
265 in case U-Boot printed clues as to why the host-side even did not
266 occur. This function will do that.
275 # If we are already not connected to U-Boot, there's nothing to drain.
276 # This should only happen when a previous call to run_command() or
277 # wait_for() failed (and hence the output has already been logged), or
278 # the system is shutting down.
282 orig_timeout = self.p.timeout
284 # Drain the log for a relatively short time.
285 self.p.timeout = 1000
286 # Wait for something U-Boot will likely never send. This will
287 # cause the console output to be read and logged.
288 self.p.expect(['This should never match U-Boot output'])
289 except u_boot_spawn.Timeout:
292 self.p.timeout = orig_timeout
294 def ensure_spawned(self):
295 """Ensure a connection to a correctly running U-Boot instance.
297 This may require spawning a new Sandbox process or resetting target
298 hardware, as defined by the implementation sub-class.
300 This is an internal function and should not be called directly.
312 self.log.start_section('Starting U-Boot')
313 self.at_prompt = False
314 self.p = self.get_spawn()
315 # Real targets can take a long time to scroll large amounts of
316 # text if LCD is enabled. This value may need tweaking in the
317 # future, possibly per-test to be optimal. This works for 'help'
318 # on board 'seaboard'.
319 if not self.config.gdbserver:
320 self.p.timeout = 30000
321 self.p.logfile_read = self.logstream
322 bcfg = self.config.buildconfig
323 config_spl = bcfg.get('config_spl', 'n') == 'y'
324 config_spl_serial_support = bcfg.get('config_spl_serial_support',
326 env_spl_skipped = self.config.env.get('env__spl_skipped',
328 if config_spl and config_spl_serial_support and not env_spl_skipped:
329 m = self.p.expect([pattern_u_boot_spl_signon] +
332 raise Exception('Bad pattern found on console: ' +
333 self.bad_pattern_ids[m - 1])
334 m = self.p.expect([pattern_u_boot_main_signon] + self.bad_patterns)
336 raise Exception('Bad pattern found on console: ' +
337 self.bad_pattern_ids[m - 1])
338 self.u_boot_version_string = self.p.after
340 m = self.p.expect([self.prompt_escaped,
341 pattern_stop_autoboot_prompt] + self.bad_patterns)
347 raise Exception('Bad pattern found on console: ' +
348 self.bad_pattern_ids[m - 2])
349 self.at_prompt = True
350 self.at_prompt_logevt = self.logstream.logfile.cur_evt
351 except Exception as ex:
352 self.log.error(str(ex))
356 self.log.end_section('Starting U-Boot')
358 def cleanup_spawn(self):
359 """Shut down all interaction with the U-Boot instance.
361 This is used when an error is detected prior to re-establishing a
362 connection with a fresh U-Boot instance.
364 This is an internal function and should not be called directly.
380 def validate_version_string_in_text(self, text):
381 """Assert that a command's output includes the U-Boot signon message.
383 This is primarily useful for validating the "version" command without
384 duplicating the signon text regex in a test function.
387 text: The command output text to check.
390 Nothing. An exception is raised if the validation fails.
393 assert(self.u_boot_version_string in text)
395 def disable_check(self, check_type):
396 """Temporarily disable an error check of U-Boot's output.
398 Create a new context manager (for use with the "with" statement) which
399 temporarily disables a particular console output error check.
402 check_type: The type of error-check to disable. Valid values may
403 be found in self.disable_check_count above.
406 A context manager object.
409 return ConsoleDisableCheck(self, check_type)
411 def temporary_timeout(self, timeout):
412 """Temporarily set up different timeout for commands.
414 Create a new context manager (for use with the "with" statement) which
415 temporarily change timeout.
418 timeout: Time in milliseconds.
421 A context manager object.
424 return ConsoleSetupTimeout(self, timeout)