J. Richard Barnette | 384056b | 2012-04-16 11:04:46 -0700 | [diff] [blame] | 1 | # Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 2 | # Use of this source code is governed by a BSD-style license that can be |
| 3 | # found in the LICENSE file. |
| 4 | # |
| 5 | # Expects to be run in an environment with sudo and no interactive password |
| 6 | # prompt, such as within the Chromium OS development chroot. |
| 7 | |
Congbin Guo | a1f9cba | 2018-07-03 11:36:59 -0700 | [diff] [blame] | 8 | import ast |
| 9 | import logging |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 10 | import os |
Congbin Guo | a1f9cba | 2018-07-03 11:36:59 -0700 | [diff] [blame] | 11 | import re |
| 12 | import time |
| 13 | import xmlrpclib |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 14 | |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 15 | from autotest_lib.client.common_lib import error |
Ricky Liang | c31aab3 | 2014-07-03 16:23:29 +0800 | [diff] [blame] | 16 | from autotest_lib.server.cros.servo import firmware_programmer |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 17 | |
Kevin Cheng | a22c4a8 | 2016-10-07 14:13:25 -0700 | [diff] [blame] | 18 | # Time to wait when probing for a usb device, it takes on avg 17 seconds |
| 19 | # to do a full probe. |
| 20 | _USB_PROBE_TIMEOUT = 40 |
| 21 | |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 22 | |
J. Richard Barnette | 0c9c588 | 2014-06-11 15:27:05 -0700 | [diff] [blame] | 23 | class _PowerStateController(object): |
| 24 | |
| 25 | """Class to provide board-specific power operations. |
| 26 | |
| 27 | This class is responsible for "power on" and "power off" |
| 28 | operations that can operate without making assumptions in |
| 29 | advance about board state. It offers an interface that |
| 30 | abstracts out the different sequences required for different |
| 31 | board types. |
| 32 | |
| 33 | """ |
| 34 | |
| 35 | # Constants acceptable to be passed for the `rec_mode` parameter |
| 36 | # to power_on(). |
| 37 | # |
| 38 | # REC_ON: Boot the DUT in recovery mode, i.e. boot from USB or |
| 39 | # SD card. |
| 40 | # REC_OFF: Boot in normal mode, i.e. boot from internal storage. |
| 41 | |
| 42 | REC_ON = 'rec' |
| 43 | REC_OFF = 'on' |
Shelley Chen | 6593862 | 2018-05-16 07:45:54 -0700 | [diff] [blame] | 44 | REC_ON_FORCE_MRC = 'rec_force_mrc' |
J. Richard Barnette | 0c9c588 | 2014-06-11 15:27:05 -0700 | [diff] [blame] | 45 | |
| 46 | # Delay in seconds needed between asserting and de-asserting |
| 47 | # warm reset. |
| 48 | _RESET_HOLD_TIME = 0.5 |
| 49 | |
| 50 | def __init__(self, servo): |
| 51 | """Initialize the power state control. |
| 52 | |
| 53 | @param servo Servo object providing the underlying `set` and `get` |
| 54 | methods for the target controls. |
| 55 | |
| 56 | """ |
| 57 | self._servo = servo |
| 58 | |
| 59 | def reset(self): |
| 60 | """Force the DUT to reset. |
| 61 | |
| 62 | The DUT is guaranteed to be on at the end of this call, |
| 63 | regardless of its previous state, provided that there is |
| 64 | working OS software. This also guarantees that the EC has |
| 65 | been restarted. |
| 66 | |
| 67 | """ |
| 68 | self._servo.set_nocheck('power_state', 'reset') |
| 69 | |
| 70 | def warm_reset(self): |
| 71 | """Apply warm reset to the DUT. |
| 72 | |
| 73 | This asserts, then de-asserts the 'warm_reset' signal. |
| 74 | Generally, this causes the board to restart. |
| 75 | |
| 76 | """ |
| 77 | self._servo.set_get_all(['warm_reset:on', |
| 78 | 'sleep:%.4f' % self._RESET_HOLD_TIME, |
| 79 | 'warm_reset:off']) |
| 80 | |
J. Richard Barnette | 0c9c588 | 2014-06-11 15:27:05 -0700 | [diff] [blame] | 81 | def power_off(self): |
| 82 | """Force the DUT to power off. |
| 83 | |
| 84 | The DUT is guaranteed to be off at the end of this call, |
| 85 | regardless of its previous state, provided that there is |
| 86 | working EC and boot firmware. There is no requirement for |
| 87 | working OS software. |
| 88 | |
| 89 | """ |
| 90 | self._servo.set_nocheck('power_state', 'off') |
| 91 | |
| 92 | def power_on(self, rec_mode=REC_OFF): |
| 93 | """Force the DUT to power on. |
| 94 | |
| 95 | Prior to calling this function, the DUT must be powered off, |
| 96 | e.g. with a call to `power_off()`. |
| 97 | |
| 98 | At power on, recovery mode is set as specified by the |
| 99 | corresponding argument. When booting with recovery mode on, it |
| 100 | is the caller's responsibility to unplug/plug in a bootable |
| 101 | external storage device. |
| 102 | |
| 103 | If the DUT requires a delay after powering on but before |
| 104 | processing inputs such as USB stick insertion, the delay is |
| 105 | handled by this method; the caller is not responsible for such |
| 106 | delays. |
| 107 | |
| 108 | @param rec_mode Setting of recovery mode to be applied at |
| 109 | power on. default: REC_OFF aka 'off' |
| 110 | |
| 111 | """ |
| 112 | self._servo.set_nocheck('power_state', rec_mode) |
| 113 | |
| 114 | |
Congbin Guo | a1f9cba | 2018-07-03 11:36:59 -0700 | [diff] [blame] | 115 | class _Uart(object): |
| 116 | """Class to capture CPU/EC UART streams.""" |
| 117 | def __init__(self, servo): |
| 118 | self._servo = servo |
| 119 | self._streams = [] |
| 120 | |
| 121 | def start_capture(self): |
| 122 | """Start capturing Uart streams.""" |
| 123 | logging.debug('Start capturing CPU/EC UART.') |
| 124 | self._servo.set('cpu_uart_capture', 'on') |
| 125 | self._streams.append(('cpu_uart_stream', 'cpu_uart.log')) |
| 126 | try: |
| 127 | self._servo.set('ec_uart_capture', 'on') |
| 128 | self._streams.append(('ec_uart_stream', 'ec_uart.log')) |
| 129 | except error.TestFail as err: |
| 130 | if 'No control named' in str(err): |
| 131 | logging.debug('The servod is too old that ec_uart_capture not ' |
| 132 | 'supported.') |
| 133 | |
| 134 | def dump(self, output_dir): |
| 135 | """Dump UART streams to log files accordingly. |
| 136 | |
| 137 | @param output_dir: A string of output directory name. |
| 138 | """ |
| 139 | for stream, logfile in self._streams: |
| 140 | logfile_fullname = os.path.join(output_dir, logfile) |
| 141 | try: |
| 142 | content = self._servo.get(stream) |
| 143 | except Exception as err: |
| 144 | logging.warn('Failed to get UART log for %s: %s', stream, err) |
| 145 | continue |
| 146 | |
| 147 | # The UART stream may contain non-printable characters, and servo |
| 148 | # returns it in string representation. We use `ast.leteral_eval` |
| 149 | # to revert it back. |
| 150 | with open(logfile_fullname, 'a') as fd: |
| 151 | fd.write(ast.literal_eval(content)) |
| 152 | |
| 153 | def stop_capture(self): |
| 154 | """Stop capturing UART streams.""" |
| 155 | logging.debug('Stop capturing CPU/EC UART.') |
| 156 | for uart in ('cpu_uart_capture', 'ec_uart_capture'): |
| 157 | try: |
| 158 | self._servo.set(uart, 'off') |
| 159 | except error.TestFail as err: |
| 160 | if 'No control named' in str(err): |
| 161 | logging.debug('The servod is too old that %s not ' |
| 162 | 'supported.', uart) |
| 163 | except Exception as err: |
| 164 | logging.warn('Failed to stop UART logging for %s: %s', uart, |
| 165 | err) |
| 166 | |
| 167 | |
J. Richard Barnette | 384056b | 2012-04-16 11:04:46 -0700 | [diff] [blame] | 168 | class Servo(object): |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 169 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 170 | """Manages control of a Servo board. |
| 171 | |
| 172 | Servo is a board developed by hardware group to aide in the debug and |
| 173 | control of various partner devices. Servo's features include the simulation |
| 174 | of pressing the power button, closing the lid, and pressing Ctrl-d. This |
| 175 | class manages setting up and communicating with a servo demon (servod) |
| 176 | process. It provides both high-level functions for common servo tasks and |
| 177 | low-level functions for directly setting and reading gpios. |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 178 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 179 | """ |
| 180 | |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 181 | # Power button press delays in seconds. |
J. Richard Barnette | d2e4cbd | 2012-06-29 12:18:40 -0700 | [diff] [blame] | 182 | # |
J. Richard Barnette | 5383f07 | 2012-07-26 17:35:40 -0700 | [diff] [blame] | 183 | # The EC specification says that 8.0 seconds should be enough |
| 184 | # for the long power press. However, some platforms need a bit |
| 185 | # more time. Empirical testing has found these requirements: |
| 186 | # Alex: 8.2 seconds |
| 187 | # ZGB: 8.5 seconds |
| 188 | # The actual value is set to the largest known necessary value. |
| 189 | # |
| 190 | # TODO(jrbarnette) Being generous is the right thing to do for |
| 191 | # existing platforms, but if this code is to be used for |
| 192 | # qualification of new hardware, we should be less generous. |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 193 | SHORT_DELAY = 0.1 |
J. Richard Barnette | 5383f07 | 2012-07-26 17:35:40 -0700 | [diff] [blame] | 194 | |
Todd Broch | 31c8250 | 2011-08-29 08:14:39 -0700 | [diff] [blame] | 195 | # Maximum number of times to re-read power button on release. |
Todd Broch | cf7c665 | 2012-02-24 13:03:59 -0800 | [diff] [blame] | 196 | GET_RETRY_MAX = 10 |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 197 | |
J. Richard Barnette | 5383f07 | 2012-07-26 17:35:40 -0700 | [diff] [blame] | 198 | # Delays to deal with DUT state transitions. |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 199 | SLEEP_DELAY = 6 |
| 200 | BOOT_DELAY = 10 |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 201 | |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 202 | # Default minimum time interval between 'press' and 'release' |
| 203 | # keyboard events. |
Vic Yang | 0aca1c2 | 2012-11-19 18:33:56 -0800 | [diff] [blame] | 204 | SERVO_KEY_PRESS_DELAY = 0.1 |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 205 | |
Tom Wai-Hong Tam | 93b5c09 | 2015-05-14 02:50:43 +0800 | [diff] [blame] | 206 | # Time to toggle recovery switch on and off. |
| 207 | REC_TOGGLE_DELAY = 0.1 |
| 208 | |
Tom Wai-Hong Tam | f9ded09 | 2015-05-20 05:37:22 +0800 | [diff] [blame] | 209 | # Time to toggle development switch on and off. |
| 210 | DEV_TOGGLE_DELAY = 0.1 |
| 211 | |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 212 | # Time between an usb disk plugged-in and detected in the system. |
| 213 | USB_DETECTION_DELAY = 10 |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 214 | # Time to keep USB power off before and after USB mux direction is changed |
| 215 | USB_POWEROFF_DELAY = 2 |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 216 | |
Simran Basi | b7850bb | 2013-07-24 12:33:42 -0700 | [diff] [blame] | 217 | # Time to wait before timing out on servo initialization. |
| 218 | INIT_TIMEOUT_SECS = 10 |
Simran Basi | 5933134 | 2013-07-12 12:06:29 -0700 | [diff] [blame] | 219 | |
J. Richard Barnette | 67ccb87 | 2012-04-19 16:34:56 -0700 | [diff] [blame] | 220 | |
Ricky Liang | 0dd379c | 2014-04-23 16:29:08 +0800 | [diff] [blame] | 221 | def __init__(self, servo_host, servo_serial=None): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 222 | """Sets up the servo communication infrastructure. |
| 223 | |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 224 | @param servo_host: A ServoHost object representing |
| 225 | the host running servod. |
Ricky Liang | 0dd379c | 2014-04-23 16:29:08 +0800 | [diff] [blame] | 226 | @param servo_serial: Serial number of the servo board. |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 227 | """ |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 228 | # TODO(fdeng): crbug.com/298379 |
| 229 | # We should move servo_host object out of servo object |
| 230 | # to minimize the dependencies on the rest of Autotest. |
| 231 | self._servo_host = servo_host |
Ricky Liang | 0dd379c | 2014-04-23 16:29:08 +0800 | [diff] [blame] | 232 | self._servo_serial = servo_serial |
Richard Barnette | 180efe6 | 2016-12-02 23:20:44 +0000 | [diff] [blame] | 233 | self._server = servo_host.get_servod_server_proxy() |
J. Richard Barnette | 0c9c588 | 2014-06-11 15:27:05 -0700 | [diff] [blame] | 234 | self._power_state = _PowerStateController(self) |
Congbin Guo | a1f9cba | 2018-07-03 11:36:59 -0700 | [diff] [blame] | 235 | self._uart = _Uart(self) |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 236 | self._usb_state = None |
J. Richard Barnette | 8f19b39 | 2014-08-11 14:05:39 -0700 | [diff] [blame] | 237 | self._programmer = None |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 238 | |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 239 | |
Ricky Liang | 0dd379c | 2014-04-23 16:29:08 +0800 | [diff] [blame] | 240 | @property |
| 241 | def servo_serial(self): |
| 242 | """Returns the serial number of the servo board.""" |
| 243 | return self._servo_serial |
| 244 | |
| 245 | |
Tom Wai-Hong Tam | 22ee0e5 | 2013-04-03 13:36:39 +0800 | [diff] [blame] | 246 | def get_power_state_controller(self): |
J. Richard Barnette | 75136b3 | 2013-03-26 13:38:44 -0700 | [diff] [blame] | 247 | """Return the power state controller for this Servo. |
| 248 | |
| 249 | The power state controller provides board-independent |
| 250 | interfaces for reset, power-on, power-off operations. |
| 251 | |
| 252 | """ |
| 253 | return self._power_state |
| 254 | |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 255 | |
J. Richard Barnette | b613397 | 2012-07-19 17:13:55 -0700 | [diff] [blame] | 256 | def initialize_dut(self, cold_reset=False): |
| 257 | """Initializes a dut for testing purposes. |
| 258 | |
| 259 | This sets various servo signals back to default values |
| 260 | appropriate for the target board. By default, if the DUT |
| 261 | is already on, it stays on. If the DUT is powered off |
| 262 | before initialization, its state afterward is unspecified. |
| 263 | |
J. Richard Barnette | b613397 | 2012-07-19 17:13:55 -0700 | [diff] [blame] | 264 | Rationale: Basic initialization of servo sets the lid open, |
| 265 | when there is a lid. This operation won't affect powered on |
| 266 | units; however, setting the lid open may power on a unit |
J. Richard Barnette | 75136b3 | 2013-03-26 13:38:44 -0700 | [diff] [blame] | 267 | that's off, depending on the board type and previous state |
| 268 | of the device. |
| 269 | |
J. Richard Barnette | 4b6af0d | 2014-06-05 09:57:20 -0700 | [diff] [blame] | 270 | If `cold_reset` is a true value, the DUT and its EC will be |
| 271 | reset, and the DUT rebooted in normal mode. |
J. Richard Barnette | b613397 | 2012-07-19 17:13:55 -0700 | [diff] [blame] | 272 | |
| 273 | @param cold_reset If True, cold reset the device after |
| 274 | initialization. |
| 275 | """ |
| 276 | self._server.hwinit() |
J. Richard Barnette | 8f19b39 | 2014-08-11 14:05:39 -0700 | [diff] [blame] | 277 | self.set('usb_mux_oe1', 'on') |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 278 | self._usb_state = None |
J. Richard Barnette | 8f19b39 | 2014-08-11 14:05:39 -0700 | [diff] [blame] | 279 | self.switch_usbkey('off') |
Congbin Guo | a1f9cba | 2018-07-03 11:36:59 -0700 | [diff] [blame] | 280 | self._uart.start_capture() |
J. Richard Barnette | b613397 | 2012-07-19 17:13:55 -0700 | [diff] [blame] | 281 | if cold_reset: |
J. Richard Barnette | 4b6af0d | 2014-06-05 09:57:20 -0700 | [diff] [blame] | 282 | self._power_state.reset() |
J. Richard Barnette | 1777f5d | 2014-09-03 15:18:19 -0700 | [diff] [blame] | 283 | logging.debug('Servo initialized, version is %s', |
| 284 | self._server.get_version()) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 285 | |
| 286 | |
Tom Wai-Hong Tam | 1c86c7a | 2012-10-22 10:08:24 +0800 | [diff] [blame] | 287 | def is_localhost(self): |
| 288 | """Is the servod hosted locally? |
| 289 | |
| 290 | Returns: |
| 291 | True if local hosted; otherwise, False. |
| 292 | """ |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 293 | return self._servo_host.is_localhost() |
Tom Wai-Hong Tam | 1c86c7a | 2012-10-22 10:08:24 +0800 | [diff] [blame] | 294 | |
| 295 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 296 | def power_long_press(self): |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 297 | """Simulate a long power button press.""" |
J. Richard Barnette | f12bff2 | 2012-07-18 14:41:06 -0700 | [diff] [blame] | 298 | # After a long power press, the EC may ignore the next power |
| 299 | # button press (at least on Alex). To guarantee that this |
| 300 | # won't happen, we need to allow the EC one second to |
| 301 | # collect itself. |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 302 | self._server.power_long_press() |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 303 | |
| 304 | |
| 305 | def power_normal_press(self): |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 306 | """Simulate a normal power button press.""" |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 307 | self._server.power_normal_press() |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 308 | |
| 309 | |
| 310 | def power_short_press(self): |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 311 | """Simulate a short power button press.""" |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 312 | self._server.power_short_press() |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 313 | |
| 314 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 315 | def power_key(self, press_secs=''): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 316 | """Simulate a power button press. |
| 317 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 318 | @param press_secs : Str. Time to press key. |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 319 | """ |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 320 | self._server.power_key(press_secs) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 321 | |
| 322 | |
| 323 | def lid_open(self): |
Yuli Huang | 7b82dcf | 2015-05-13 17:58:52 +0800 | [diff] [blame] | 324 | """Simulate opening the lid and raise exception if all attempts fail""" |
| 325 | self.set('lid_open', 'yes') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 326 | |
| 327 | |
| 328 | def lid_close(self): |
Yuli Huang | 7b82dcf | 2015-05-13 17:58:52 +0800 | [diff] [blame] | 329 | """Simulate closing the lid and raise exception if all attempts fail |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 330 | |
| 331 | Waits 6 seconds to ensure the device is fully asleep before returning. |
| 332 | """ |
Yuli Huang | 7b82dcf | 2015-05-13 17:58:52 +0800 | [diff] [blame] | 333 | self.set('lid_open', 'no') |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 334 | time.sleep(Servo.SLEEP_DELAY) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 335 | |
Shelley Chen | c26575a | 2015-09-18 10:56:16 -0700 | [diff] [blame] | 336 | def volume_up(self, timeout=300): |
Kevin Cheng | e448a8b | 2016-09-09 10:18:11 -0700 | [diff] [blame] | 337 | """Simulate pushing the volume down button. |
| 338 | |
| 339 | @param timeout: Timeout for setting the volume. |
| 340 | """ |
Shelley Chen | c26575a | 2015-09-18 10:56:16 -0700 | [diff] [blame] | 341 | self.set_get_all(['volume_up:yes', |
| 342 | 'sleep:%.4f' % self.SERVO_KEY_PRESS_DELAY, |
| 343 | 'volume_up:no']) |
| 344 | # we need to wait for commands to take effect before moving on |
| 345 | time_left = float(timeout) |
| 346 | while time_left > 0.0: |
| 347 | value = self.get('volume_up') |
| 348 | if value == 'no': |
| 349 | return |
| 350 | time.sleep(self.SHORT_DELAY) |
| 351 | time_left = time_left - self.SHORT_DELAY |
| 352 | raise error.TestFail("Failed setting volume_up to no") |
| 353 | |
| 354 | def volume_down(self, timeout=300): |
Kevin Cheng | e448a8b | 2016-09-09 10:18:11 -0700 | [diff] [blame] | 355 | """Simulate pushing the volume down button. |
| 356 | |
| 357 | @param timeout: Timeout for setting the volume. |
| 358 | """ |
Shelley Chen | c26575a | 2015-09-18 10:56:16 -0700 | [diff] [blame] | 359 | self.set_get_all(['volume_down:yes', |
| 360 | 'sleep:%.4f' % self.SERVO_KEY_PRESS_DELAY, |
| 361 | 'volume_down:no']) |
| 362 | # we need to wait for commands to take effect before moving on |
| 363 | time_left = float(timeout) |
| 364 | while time_left > 0.0: |
| 365 | value = self.get('volume_down') |
| 366 | if value == 'no': |
| 367 | return |
| 368 | time.sleep(self.SHORT_DELAY) |
| 369 | time_left = time_left - self.SHORT_DELAY |
| 370 | raise error.TestFail("Failed setting volume_down to no") |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 371 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 372 | def ctrl_d(self, press_secs=''): |
| 373 | """Simulate Ctrl-d simultaneous button presses. |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 374 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 375 | @param press_secs : Str. Time to press key. |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 376 | """ |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 377 | self._server.ctrl_d(press_secs) |
Gediminas Ramanauskas | 9da80f2 | 2012-11-14 12:59:43 -0800 | [diff] [blame] | 378 | |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 379 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 380 | def ctrl_u(self): |
| 381 | """Simulate Ctrl-u simultaneous button presses. |
| 382 | |
| 383 | @param press_secs : Str. Time to press key. |
| 384 | """ |
| 385 | self._server.ctrl_u() |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 386 | |
| 387 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 388 | def ctrl_enter(self, press_secs=''): |
| 389 | """Simulate Ctrl-enter simultaneous button presses. |
| 390 | |
| 391 | @param press_secs : Str. Time to press key. |
| 392 | """ |
| 393 | self._server.ctrl_enter(press_secs) |
Gediminas Ramanauskas | 3297d4f | 2012-09-10 15:30:10 -0700 | [diff] [blame] | 394 | |
| 395 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 396 | def d_key(self, press_secs=''): |
| 397 | """Simulate Enter key button press. |
| 398 | |
| 399 | @param press_secs : Str. Time to press key. |
| 400 | """ |
| 401 | self._server.d_key(press_secs) |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 402 | |
| 403 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 404 | def ctrl_key(self, press_secs=''): |
| 405 | """Simulate Enter key button press. |
| 406 | |
| 407 | @param press_secs : Str. Time to press key. |
| 408 | """ |
| 409 | self._server.ctrl_key(press_secs) |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 410 | |
| 411 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 412 | def enter_key(self, press_secs=''): |
| 413 | """Simulate Enter key button press. |
| 414 | |
| 415 | @param press_secs : Str. Time to press key. |
| 416 | """ |
| 417 | self._server.enter_key(press_secs) |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 418 | |
| 419 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 420 | def refresh_key(self, press_secs=''): |
| 421 | """Simulate Refresh key (F3) button press. |
| 422 | |
| 423 | @param press_secs : Str. Time to press key. |
| 424 | """ |
| 425 | self._server.refresh_key(press_secs) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 426 | |
| 427 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 428 | def ctrl_refresh_key(self, press_secs=''): |
Tom Wai-Hong Tam | 9e61e66 | 2012-08-01 15:10:07 +0800 | [diff] [blame] | 429 | """Simulate Ctrl and Refresh (F3) simultaneous press. |
| 430 | |
| 431 | This key combination is an alternative of Space key. |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 432 | |
| 433 | @param press_secs : Str. Time to press key. |
Tom Wai-Hong Tam | 9e61e66 | 2012-08-01 15:10:07 +0800 | [diff] [blame] | 434 | """ |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 435 | self._server.ctrl_refresh_key(press_secs) |
Tom Wai-Hong Tam | 9e61e66 | 2012-08-01 15:10:07 +0800 | [diff] [blame] | 436 | |
| 437 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 438 | def imaginary_key(self, press_secs=''): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 439 | """Simulate imaginary key button press. |
| 440 | |
| 441 | Maps to a key that doesn't physically exist. |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 442 | |
| 443 | @param press_secs : Str. Time to press key. |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 444 | """ |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 445 | self._server.imaginary_key(press_secs) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 446 | |
| 447 | |
Vincent Palatin | e7dc928 | 2016-07-14 11:31:58 +0200 | [diff] [blame] | 448 | def sysrq_x(self, press_secs=''): |
| 449 | """Simulate Alt VolumeUp X simulataneous press. |
| 450 | |
| 451 | This key combination is the kernel system request (sysrq) X. |
| 452 | |
| 453 | @param press_secs : Str. Time to press key. |
| 454 | """ |
| 455 | self._server.sysrq_x(press_secs) |
| 456 | |
| 457 | |
Tom Wai-Hong Tam | 93b5c09 | 2015-05-14 02:50:43 +0800 | [diff] [blame] | 458 | def toggle_recovery_switch(self): |
| 459 | """Toggle recovery switch on and off.""" |
| 460 | self.enable_recovery_mode() |
| 461 | time.sleep(self.REC_TOGGLE_DELAY) |
| 462 | self.disable_recovery_mode() |
| 463 | |
| 464 | |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 465 | def enable_recovery_mode(self): |
| 466 | """Enable recovery mode on device.""" |
| 467 | self.set('rec_mode', 'on') |
| 468 | |
| 469 | |
| 470 | def disable_recovery_mode(self): |
| 471 | """Disable recovery mode on device.""" |
| 472 | self.set('rec_mode', 'off') |
| 473 | |
| 474 | |
Tom Wai-Hong Tam | f9ded09 | 2015-05-20 05:37:22 +0800 | [diff] [blame] | 475 | def toggle_development_switch(self): |
| 476 | """Toggle development switch on and off.""" |
| 477 | self.enable_development_mode() |
| 478 | time.sleep(self.DEV_TOGGLE_DELAY) |
| 479 | self.disable_development_mode() |
| 480 | |
| 481 | |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 482 | def enable_development_mode(self): |
| 483 | """Enable development mode on device.""" |
| 484 | self.set('dev_mode', 'on') |
| 485 | |
| 486 | |
| 487 | def disable_development_mode(self): |
| 488 | """Disable development mode on device.""" |
| 489 | self.set('dev_mode', 'off') |
| 490 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 491 | def boot_devmode(self): |
| 492 | """Boot a dev-mode device that is powered off.""" |
Tom Wai-Hong Tam | 2386910 | 2012-01-17 15:41:30 +0800 | [diff] [blame] | 493 | self.power_short_press() |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 494 | self.pass_devmode() |
| 495 | |
| 496 | |
| 497 | def pass_devmode(self): |
| 498 | """Pass through boot screens in dev-mode.""" |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 499 | time.sleep(Servo.BOOT_DELAY) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 500 | self.ctrl_d() |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 501 | time.sleep(Servo.BOOT_DELAY) |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 502 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 503 | |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 504 | def get_board(self): |
Wai-Hong Tam | 0f90400 | 2017-09-19 15:52:22 -0700 | [diff] [blame] | 505 | """Get the board connected to servod.""" |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 506 | return self._server.get_board() |
| 507 | |
| 508 | |
Wai-Hong Tam | 0f90400 | 2017-09-19 15:52:22 -0700 | [diff] [blame] | 509 | def get_base_board(self): |
| 510 | """Get the board of the base connected to servod.""" |
Wai-Hong Tam | 7f6169e | 2017-09-29 09:23:48 -0700 | [diff] [blame] | 511 | try: |
| 512 | return self._server.get_base_board() |
| 513 | except xmlrpclib.Fault as e: |
| 514 | # TODO(waihong): Remove the following compatibility check when |
| 515 | # the new versions of hdctools are deployed. |
| 516 | if 'not supported' in str(e): |
| 517 | logging.warning('The servod is too old that get_base_board ' |
| 518 | 'not supported.') |
| 519 | return '' |
| 520 | raise |
Wai-Hong Tam | 0f90400 | 2017-09-19 15:52:22 -0700 | [diff] [blame] | 521 | |
| 522 | |
Wai-Hong Tam | cc399ee | 2017-12-08 12:43:28 -0800 | [diff] [blame] | 523 | def get_ec_active_copy(self): |
| 524 | """Get the active copy of the EC image.""" |
| 525 | return self.get('ec_active_copy') |
| 526 | |
| 527 | |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 528 | def _get_xmlrpclib_exception(self, xmlexc): |
| 529 | """Get meaningful exception string from xmlrpc. |
| 530 | |
| 531 | Args: |
| 532 | xmlexc: xmlrpclib.Fault object |
| 533 | |
| 534 | xmlrpclib.Fault.faultString has the following format: |
| 535 | |
| 536 | <type 'exception type'>:'actual error message' |
| 537 | |
| 538 | Parse and return the real exception from the servod side instead of the |
| 539 | less meaningful one like, |
| 540 | <Fault 1: "<type 'exceptions.AttributeError'>:'tca6416' object has no |
| 541 | attribute 'hw_driver'"> |
| 542 | |
| 543 | Returns: |
| 544 | string of underlying exception raised in servod. |
| 545 | """ |
| 546 | return re.sub('^.*>:', '', xmlexc.faultString) |
| 547 | |
| 548 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 549 | def get(self, gpio_name): |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 550 | """Get the value of a gpio from Servod. |
| 551 | |
| 552 | @param gpio_name Name of the gpio. |
| 553 | """ |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 554 | assert gpio_name |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 555 | try: |
Simran Basi | 1cbc5f2 | 2013-07-17 14:23:58 -0700 | [diff] [blame] | 556 | return self._server.get(gpio_name) |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 557 | except xmlrpclib.Fault as e: |
| 558 | err_msg = "Getting '%s' :: %s" % \ |
| 559 | (gpio_name, self._get_xmlrpclib_exception(e)) |
| 560 | raise error.TestFail(err_msg) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 561 | |
| 562 | |
| 563 | def set(self, gpio_name, gpio_value): |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 564 | """Set and check the value of a gpio using Servod. |
| 565 | |
| 566 | @param gpio_name Name of the gpio. |
| 567 | @param gpio_value New setting for the gpio. |
| 568 | """ |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 569 | self.set_nocheck(gpio_name, gpio_value) |
Todd Broch | cf7c665 | 2012-02-24 13:03:59 -0800 | [diff] [blame] | 570 | retry_count = Servo.GET_RETRY_MAX |
| 571 | while gpio_value != self.get(gpio_name) and retry_count: |
Ilja H. Friedel | 04be2bd | 2014-05-07 21:29:59 -0700 | [diff] [blame] | 572 | logging.warning("%s != %s, retry %d", gpio_name, gpio_value, |
Todd Broch | cf7c665 | 2012-02-24 13:03:59 -0800 | [diff] [blame] | 573 | retry_count) |
| 574 | retry_count -= 1 |
| 575 | time.sleep(Servo.SHORT_DELAY) |
| 576 | if not retry_count: |
| 577 | assert gpio_value == self.get(gpio_name), \ |
| 578 | 'Servo failed to set %s to %s' % (gpio_name, gpio_value) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 579 | |
| 580 | |
| 581 | def set_nocheck(self, gpio_name, gpio_value): |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 582 | """Set the value of a gpio using Servod. |
| 583 | |
| 584 | @param gpio_name Name of the gpio. |
| 585 | @param gpio_value New setting for the gpio. |
| 586 | """ |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 587 | assert gpio_name and gpio_value |
Mary Ruthven | 2f72e2a | 2018-05-01 17:12:58 -0700 | [diff] [blame] | 588 | logging.info('Setting %s to %r', gpio_name, gpio_value) |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 589 | try: |
Simran Basi | 1cbc5f2 | 2013-07-17 14:23:58 -0700 | [diff] [blame] | 590 | self._server.set(gpio_name, gpio_value) |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 591 | except xmlrpclib.Fault as e: |
Mary Ruthven | 73d3a35 | 2018-05-10 15:35:20 -0700 | [diff] [blame] | 592 | err_msg = "Setting '%s' to %r :: %s" % \ |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 593 | (gpio_name, gpio_value, self._get_xmlrpclib_exception(e)) |
| 594 | raise error.TestFail(err_msg) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 595 | |
| 596 | |
Tom Wai-Hong Tam | 92569bb | 2013-03-26 14:25:10 +0800 | [diff] [blame] | 597 | def set_get_all(self, controls): |
| 598 | """Set &| get one or more control values. |
| 599 | |
| 600 | @param controls: list of strings, controls to set &| get. |
| 601 | |
| 602 | @raise: error.TestError in case error occurs setting/getting values. |
| 603 | """ |
| 604 | rv = [] |
| 605 | try: |
Vic Yang | cad9acb | 2013-05-21 14:02:05 +0800 | [diff] [blame] | 606 | logging.info('Set/get all: %s', str(controls)) |
Tom Wai-Hong Tam | 92569bb | 2013-03-26 14:25:10 +0800 | [diff] [blame] | 607 | rv = self._server.set_get_all(controls) |
| 608 | except xmlrpclib.Fault as e: |
| 609 | # TODO(waihong): Remove the following backward compatibility when |
| 610 | # the new versions of hdctools are deployed. |
| 611 | if 'not supported' in str(e): |
| 612 | logging.warning('The servod is too old that set_get_all ' |
| 613 | 'not supported. Use set and get instead.') |
| 614 | for control in controls: |
| 615 | if ':' in control: |
| 616 | (name, value) = control.split(':') |
| 617 | if name == 'sleep': |
| 618 | time.sleep(float(value)) |
| 619 | else: |
| 620 | self.set_nocheck(name, value) |
| 621 | rv.append(True) |
| 622 | else: |
| 623 | rv.append(self.get(name)) |
| 624 | else: |
| 625 | err_msg = "Problem with '%s' :: %s" % \ |
| 626 | (controls, self._get_xmlrpclib_exception(e)) |
| 627 | raise error.TestFail(err_msg) |
| 628 | return rv |
| 629 | |
| 630 | |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 631 | # TODO(waihong) It may fail if multiple servo's are connected to the same |
| 632 | # host. Should look for a better way, like the USB serial name, to identify |
| 633 | # the USB device. |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 634 | # TODO(sbasi) Remove this code from autoserv once firmware tests have been |
| 635 | # updated. |
Kevin Cheng | a22c4a8 | 2016-10-07 14:13:25 -0700 | [diff] [blame] | 636 | def probe_host_usb_dev(self, timeout=_USB_PROBE_TIMEOUT): |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 637 | """Probe the USB disk device plugged-in the servo from the host side. |
| 638 | |
Kevin Cheng | eb06fe7 | 2016-08-22 15:26:32 -0700 | [diff] [blame] | 639 | It uses servod to discover if there is a usb device attached to it. |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 640 | |
Kevin Cheng | a22c4a8 | 2016-10-07 14:13:25 -0700 | [diff] [blame] | 641 | @param timeout The timeout period when probing for the usb host device. |
| 642 | |
| 643 | @return: String of USB disk path (e.g. '/dev/sdb') or None. |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 644 | """ |
Ruben Rodriguez Buchillon | 9a4bfc3 | 2018-10-16 20:46:25 +0800 | [diff] [blame] | 645 | # Set up Servo's usb mux. |
| 646 | self.switch_usbkey('host') |
Kevin Cheng | a22c4a8 | 2016-10-07 14:13:25 -0700 | [diff] [blame] | 647 | return self._server.probe_host_usb_dev(timeout) or None |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 648 | |
| 649 | |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 650 | def image_to_servo_usb(self, image_path=None, |
| 651 | make_image_noninteractive=False): |
| 652 | """Install an image to the USB key plugged into the servo. |
| 653 | |
| 654 | This method may copy any image to the servo USB key including a |
| 655 | recovery image or a test image. These images are frequently used |
| 656 | for test purposes such as restoring a corrupted image or conducting |
| 657 | an upgrade of ec/fw/kernel as part of a test of a specific image part. |
| 658 | |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 659 | @param image_path Path on the host to the recovery image. |
| 660 | @param make_image_noninteractive Make the recovery image |
| 661 | noninteractive, therefore the DUT |
| 662 | will reboot automatically after |
| 663 | installation. |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 664 | """ |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 665 | # We're about to start plugging/unplugging the USB key. We |
| 666 | # don't know the state of the DUT, or what it might choose |
| 667 | # to do to the device after hotplug. To avoid surprises, |
| 668 | # force the DUT to be off. |
| 669 | self._server.hwinit() |
| 670 | self._power_state.power_off() |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 671 | |
| 672 | # Set up Servo's usb mux. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 673 | self.switch_usbkey('host') |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 674 | if image_path: |
Tom Wai-Hong Tam | 42f136d | 2012-10-26 11:11:23 +0800 | [diff] [blame] | 675 | logging.info('Searching for usb device and copying image to it. ' |
| 676 | 'Please wait a few minutes...') |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 677 | if not self._server.download_image_to_usb(image_path): |
| 678 | logging.error('Failed to transfer requested image to USB. ' |
| 679 | 'Please take a look at Servo Logs.') |
| 680 | raise error.AutotestError('Download image to usb failed.') |
| 681 | if make_image_noninteractive: |
| 682 | logging.info('Making image noninteractive') |
| 683 | if not self._server.make_image_noninteractive(): |
| 684 | logging.error('Failed to make image noninteractive. ' |
| 685 | 'Please take a look at Servo Logs.') |
| 686 | |
Kalin Stoyanov | b3c11f3 | 2018-05-11 09:02:00 -0700 | [diff] [blame] | 687 | def boot_in_recovery_mode(self): |
| 688 | """Boot host DUT in recovery mode.""" |
| 689 | self._power_state.power_on(rec_mode=self._power_state.REC_ON) |
| 690 | self.switch_usbkey('dut') |
| 691 | |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 692 | |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 693 | def install_recovery_image(self, image_path=None, |
J. Richard Barnette | b6de7e3 | 2013-02-14 13:28:04 -0800 | [diff] [blame] | 694 | make_image_noninteractive=False): |
Dan Shi | c67f133 | 2016-04-06 12:38:06 -0700 | [diff] [blame] | 695 | """Install the recovery image specified by the path onto the DUT. |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 696 | |
| 697 | This method uses google recovery mode to install a recovery image |
| 698 | onto a DUT through the use of a USB stick that is mounted on a servo |
Tom Wai-Hong Tam | a07115e | 2012-01-09 12:27:01 +0800 | [diff] [blame] | 699 | board specified by the usb_dev. If no image path is specified |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 700 | we use the recovery image already on the usb image. |
| 701 | |
Dan Shi | c67f133 | 2016-04-06 12:38:06 -0700 | [diff] [blame] | 702 | @param image_path: Path on the host to the recovery image. |
| 703 | @param make_image_noninteractive: Make the recovery image |
| 704 | noninteractive, therefore the DUT will reboot automatically |
| 705 | after installation. |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 706 | """ |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 707 | self.image_to_servo_usb(image_path, make_image_noninteractive) |
Kalin Stoyanov | b3c11f3 | 2018-05-11 09:02:00 -0700 | [diff] [blame] | 708 | self.boot_in_recovery_mode() |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 709 | |
| 710 | |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 711 | def _scp_image(self, image_path): |
| 712 | """Copy image to the servo host. |
| 713 | |
| 714 | When programming a firmware image on the DUT, the image must be |
| 715 | located on the host to which the servo device is connected. Sometimes |
| 716 | servo is controlled by a remote host, in this case the image needs to |
| 717 | be transferred to the remote host. |
| 718 | |
| 719 | @param image_path: a string, name of the firmware image file to be |
| 720 | transferred. |
| 721 | @return: a string, full path name of the copied file on the remote. |
| 722 | """ |
| 723 | |
| 724 | dest_path = os.path.join('/tmp', os.path.basename(image_path)) |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 725 | self._servo_host.send_file(image_path, dest_path) |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 726 | return dest_path |
| 727 | |
| 728 | |
Dan Shi | fecdaf4 | 2015-07-28 10:17:26 -0700 | [diff] [blame] | 729 | def system(self, command, timeout=3600): |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 730 | """Execute the passed in command on the servod host. |
| 731 | |
| 732 | @param command Command to be executed. |
Dan Shi | fecdaf4 | 2015-07-28 10:17:26 -0700 | [diff] [blame] | 733 | @param timeout Maximum number of seconds of runtime allowed. Default to |
| 734 | 1 hour. |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 735 | """ |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 736 | logging.info('Will execute on servo host: %s', command) |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 737 | self._servo_host.run(command, timeout=timeout) |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 738 | |
| 739 | |
Dan Shi | fecdaf4 | 2015-07-28 10:17:26 -0700 | [diff] [blame] | 740 | def system_output(self, command, timeout=3600, |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 741 | ignore_status=False, args=()): |
| 742 | """Execute the passed in command on the servod host, return stdout. |
| 743 | |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 744 | @param command a string, the command to execute |
| 745 | @param timeout an int, max number of seconds to wait til command |
Dan Shi | fecdaf4 | 2015-07-28 10:17:26 -0700 | [diff] [blame] | 746 | execution completes. Default to 1 hour. |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 747 | @param ignore_status a Boolean, if true - ignore command's nonzero exit |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 748 | status, otherwise an exception will be thrown |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 749 | @param args a tuple of strings, each becoming a separate command line |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 750 | parameter for the command |
J. Richard Barnette | cdd1edf | 2015-07-24 11:39:46 -0700 | [diff] [blame] | 751 | @return command's stdout as a string. |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 752 | """ |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 753 | return self._servo_host.run(command, timeout=timeout, |
| 754 | ignore_status=ignore_status, |
| 755 | args=args).stdout.strip() |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 756 | |
| 757 | |
Dan Shi | a5fef05 | 2015-05-18 23:28:47 -0700 | [diff] [blame] | 758 | def get_servo_version(self): |
| 759 | """Get the version of the servo, e.g., servo_v2 or servo_v3. |
| 760 | |
| 761 | @return: The version of the servo. |
| 762 | |
| 763 | """ |
| 764 | return self._server.get_version() |
| 765 | |
| 766 | |
Tom Wai-Hong Tam | 4ac7898 | 2016-01-08 02:34:37 +0800 | [diff] [blame] | 767 | def _initialize_programmer(self, rw_only=False): |
| 768 | """Initialize the firmware programmer. |
| 769 | |
| 770 | @param rw_only: True to initialize a programmer which only |
| 771 | programs the RW portions. |
| 772 | """ |
J. Richard Barnette | 8f19b39 | 2014-08-11 14:05:39 -0700 | [diff] [blame] | 773 | if self._programmer: |
| 774 | return |
| 775 | # Initialize firmware programmer |
Dan Shi | a5fef05 | 2015-05-18 23:28:47 -0700 | [diff] [blame] | 776 | servo_version = self.get_servo_version() |
Dan Shi | 9cb0eec | 2014-06-03 09:04:50 -0700 | [diff] [blame] | 777 | if servo_version.startswith('servo_v2'): |
J. Richard Barnette | 8f19b39 | 2014-08-11 14:05:39 -0700 | [diff] [blame] | 778 | self._programmer = firmware_programmer.ProgrammerV2(self) |
Wai-Hong Tam | c36c4d2 | 2016-09-09 10:39:45 -0700 | [diff] [blame] | 779 | self._programmer_rw = firmware_programmer.ProgrammerV2RwOnly(self) |
Kevin Cheng | df2e29f | 2016-09-09 02:31:22 -0700 | [diff] [blame] | 780 | # Both servo v3 and v4 use the same programming methods so just leverage |
| 781 | # ProgrammerV3 for servo v4 as well. |
| 782 | elif (servo_version.startswith('servo_v3') or |
| 783 | servo_version.startswith('servo_v4')): |
Dan Shi | a5fef05 | 2015-05-18 23:28:47 -0700 | [diff] [blame] | 784 | self._programmer = firmware_programmer.ProgrammerV3(self) |
Tom Wai-Hong Tam | 4ac7898 | 2016-01-08 02:34:37 +0800 | [diff] [blame] | 785 | self._programmer_rw = firmware_programmer.ProgrammerV3RwOnly(self) |
J. Richard Barnette | 8f19b39 | 2014-08-11 14:05:39 -0700 | [diff] [blame] | 786 | else: |
| 787 | raise error.TestError( |
| 788 | 'No firmware programmer for servo version: %s' % |
| 789 | servo_version) |
| 790 | |
| 791 | |
Tom Wai-Hong Tam | 4ac7898 | 2016-01-08 02:34:37 +0800 | [diff] [blame] | 792 | def program_bios(self, image, rw_only=False): |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 793 | """Program bios on DUT with given image. |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 794 | |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 795 | @param image: a string, file name of the BIOS image to program |
| 796 | on the DUT. |
Tom Wai-Hong Tam | 4ac7898 | 2016-01-08 02:34:37 +0800 | [diff] [blame] | 797 | @param rw_only: True to only program the RW portion of BIOS. |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 798 | |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 799 | """ |
J. Richard Barnette | 8f19b39 | 2014-08-11 14:05:39 -0700 | [diff] [blame] | 800 | self._initialize_programmer() |
Ricky Liang | c31aab3 | 2014-07-03 16:23:29 +0800 | [diff] [blame] | 801 | if not self.is_localhost(): |
| 802 | image = self._scp_image(image) |
Tom Wai-Hong Tam | 4ac7898 | 2016-01-08 02:34:37 +0800 | [diff] [blame] | 803 | if rw_only: |
| 804 | self._programmer_rw.program_bios(image) |
| 805 | else: |
| 806 | self._programmer.program_bios(image) |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 807 | |
| 808 | |
Tom Wai-Hong Tam | 4ac7898 | 2016-01-08 02:34:37 +0800 | [diff] [blame] | 809 | def program_ec(self, image, rw_only=False): |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 810 | """Program ec on DUT with given image. |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 811 | |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 812 | @param image: a string, file name of the EC image to program |
| 813 | on the DUT. |
Tom Wai-Hong Tam | 4ac7898 | 2016-01-08 02:34:37 +0800 | [diff] [blame] | 814 | @param rw_only: True to only program the RW portion of EC. |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 815 | |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 816 | """ |
J. Richard Barnette | 8f19b39 | 2014-08-11 14:05:39 -0700 | [diff] [blame] | 817 | self._initialize_programmer() |
Ricky Liang | c31aab3 | 2014-07-03 16:23:29 +0800 | [diff] [blame] | 818 | if not self.is_localhost(): |
| 819 | image = self._scp_image(image) |
Tom Wai-Hong Tam | 4ac7898 | 2016-01-08 02:34:37 +0800 | [diff] [blame] | 820 | if rw_only: |
| 821 | self._programmer_rw.program_ec(image) |
| 822 | else: |
| 823 | self._programmer.program_ec(image) |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 824 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 825 | |
| 826 | def _switch_usbkey_power(self, power_state, detection_delay=False): |
| 827 | """Switch usbkey power. |
| 828 | |
| 829 | This function switches usbkey power by setting the value of |
| 830 | 'prtctl4_pwren'. If the power is already in the |
| 831 | requested state, this function simply returns. |
| 832 | |
| 833 | @param power_state: A string, 'on' or 'off'. |
| 834 | @param detection_delay: A boolean value, if True, sleep |
| 835 | for |USB_DETECTION_DELAY| after switching |
| 836 | the power on. |
| 837 | """ |
Kevin Cheng | a22c4a8 | 2016-10-07 14:13:25 -0700 | [diff] [blame] | 838 | # TODO(kevcheng): Forgive me for this terrible hack. This is just to |
| 839 | # handle beaglebones that haven't yet updated and have the |
| 840 | # safe_switch_usbkey_power RPC. I'll remove this once all beaglebones |
| 841 | # have been updated and also think about a better way to handle |
| 842 | # situations like this. |
| 843 | try: |
| 844 | self._server.safe_switch_usbkey_power(power_state) |
| 845 | except Exception: |
| 846 | self.set('prtctl4_pwren', power_state) |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 847 | if power_state == 'off': |
| 848 | time.sleep(self.USB_POWEROFF_DELAY) |
| 849 | elif detection_delay: |
| 850 | time.sleep(self.USB_DETECTION_DELAY) |
| 851 | |
| 852 | |
| 853 | def switch_usbkey(self, usb_state): |
| 854 | """Connect USB flash stick to either host or DUT, or turn USB port off. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 855 | |
| 856 | This function switches the servo multiplexer to provide electrical |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 857 | connection between the USB port J3 and either host or DUT side. It |
| 858 | can also be used to turn the USB port off. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 859 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 860 | Switching to 'dut' or 'host' is accompanied by powercycling |
| 861 | of the USB stick, because it sometimes gets wedged if the mux |
| 862 | is switched while the stick power is on. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 863 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 864 | @param usb_state: A string, one of 'dut', 'host', or 'off'. |
| 865 | 'dut' and 'host' indicate which side the |
| 866 | USB flash device is required to be connected to. |
| 867 | 'off' indicates turning the USB port off. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 868 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 869 | @raise: error.TestError in case the parameter is not 'dut' |
| 870 | 'host', or 'off'. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 871 | """ |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 872 | if self.get_usbkey_direction() == usb_state: |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 873 | return |
| 874 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 875 | if usb_state == 'off': |
Dan Shi | a5fef05 | 2015-05-18 23:28:47 -0700 | [diff] [blame] | 876 | self._switch_usbkey_power('off') |
| 877 | self._usb_state = usb_state |
| 878 | return |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 879 | elif usb_state == 'host': |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 880 | mux_direction = 'servo_sees_usbkey' |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 881 | elif usb_state == 'dut': |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 882 | mux_direction = 'dut_sees_usbkey' |
| 883 | else: |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 884 | raise error.TestError('Unknown USB state request: %s' % usb_state) |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 885 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 886 | self._switch_usbkey_power('off') |
Kevin Cheng | a22c4a8 | 2016-10-07 14:13:25 -0700 | [diff] [blame] | 887 | # TODO(kevcheng): Forgive me for this terrible hack. This is just to |
| 888 | # handle beaglebones that haven't yet updated and have the |
| 889 | # safe_switch_usbkey RPC. I'll remove this once all beaglebones have |
| 890 | # been updated and also think about a better way to handle situations |
| 891 | # like this. |
| 892 | try: |
| 893 | self._server.safe_switch_usbkey(mux_direction) |
| 894 | except Exception: |
| 895 | self.set('usb_mux_sel1', mux_direction) |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 896 | time.sleep(self.USB_POWEROFF_DELAY) |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 897 | self._switch_usbkey_power('on', usb_state == 'host') |
| 898 | self._usb_state = usb_state |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 899 | |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 900 | |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 901 | def get_usbkey_direction(self): |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 902 | """Get which side USB is connected to or 'off' if usb power is off. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 903 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 904 | @return: A string, one of 'dut', 'host', or 'off'. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 905 | """ |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 906 | if not self._usb_state: |
| 907 | if self.get('prtctl4_pwren') == 'off': |
| 908 | self._usb_state = 'off' |
| 909 | elif self.get('usb_mux_sel1').startswith('dut'): |
| 910 | self._usb_state = 'dut' |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 911 | else: |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 912 | self._usb_state = 'host' |
| 913 | return self._usb_state |
Congbin Guo | a1f9cba | 2018-07-03 11:36:59 -0700 | [diff] [blame] | 914 | |
| 915 | |
Wai-Hong Tam | 6037726 | 2018-03-01 10:55:39 -0800 | [diff] [blame^] | 916 | def set_servo_v4_role(self, role): |
| 917 | """Set the power role of servo v4, either 'src' or 'snk'. |
| 918 | |
| 919 | It does nothing if not a servo v4. |
| 920 | |
| 921 | @param role: Power role for DUT port on servo v4, either 'src' or 'snk'. |
| 922 | """ |
| 923 | servo_version = self.get_servo_version() |
| 924 | if servo_version.startswith('servo_v4'): |
| 925 | value = self.get('servo_v4_role') |
| 926 | if value != role: |
| 927 | self.set_nocheck('servo_v4_role', role) |
| 928 | else: |
| 929 | logging.debug('Already in the role: %s.', role) |
| 930 | else: |
| 931 | logging.debug('Not a servo v4, unable to set role to %s.', role) |
| 932 | |
| 933 | |
Congbin Guo | a1f9cba | 2018-07-03 11:36:59 -0700 | [diff] [blame] | 934 | def dump_uart_streams(self, output_dir): |
| 935 | """Get buffered UART streams and append to log files. |
| 936 | |
| 937 | @param output_dir: A string of directory name to save log files. |
| 938 | """ |
| 939 | if self._uart: |
| 940 | self._uart.dump(output_dir) |
| 941 | |
| 942 | |
| 943 | def close(self): |
| 944 | """Close the servo object.""" |
| 945 | if self._uart: |
| 946 | self._uart.stop_capture() |
| 947 | self._uart = None |