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 | |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 8 | import os |
| 9 | |
Vic Yang | 3a7cf60 | 2012-11-07 17:28:39 +0800 | [diff] [blame] | 10 | import logging, re, time, xmlrpclib |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 11 | |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 12 | from autotest_lib.client.common_lib import error |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 13 | from autotest_lib.server.cros.servo import power_state_controller |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 14 | from autotest_lib.server.cros.servo import firmware_programmer |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 15 | |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 16 | |
J. Richard Barnette | 384056b | 2012-04-16 11:04:46 -0700 | [diff] [blame] | 17 | class Servo(object): |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 18 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 19 | """Manages control of a Servo board. |
| 20 | |
| 21 | Servo is a board developed by hardware group to aide in the debug and |
| 22 | control of various partner devices. Servo's features include the simulation |
| 23 | of pressing the power button, closing the lid, and pressing Ctrl-d. This |
| 24 | class manages setting up and communicating with a servo demon (servod) |
| 25 | process. It provides both high-level functions for common servo tasks and |
| 26 | low-level functions for directly setting and reading gpios. |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 27 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 28 | """ |
| 29 | |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 30 | # Power button press delays in seconds. |
J. Richard Barnette | d2e4cbd | 2012-06-29 12:18:40 -0700 | [diff] [blame] | 31 | # |
J. Richard Barnette | 5383f07 | 2012-07-26 17:35:40 -0700 | [diff] [blame] | 32 | # The EC specification says that 8.0 seconds should be enough |
| 33 | # for the long power press. However, some platforms need a bit |
| 34 | # more time. Empirical testing has found these requirements: |
| 35 | # Alex: 8.2 seconds |
| 36 | # ZGB: 8.5 seconds |
| 37 | # The actual value is set to the largest known necessary value. |
| 38 | # |
| 39 | # TODO(jrbarnette) Being generous is the right thing to do for |
| 40 | # existing platforms, but if this code is to be used for |
| 41 | # qualification of new hardware, we should be less generous. |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 42 | SHORT_DELAY = 0.1 |
J. Richard Barnette | 5383f07 | 2012-07-26 17:35:40 -0700 | [diff] [blame] | 43 | |
Todd Broch | 31c8250 | 2011-08-29 08:14:39 -0700 | [diff] [blame] | 44 | # Maximum number of times to re-read power button on release. |
Todd Broch | cf7c665 | 2012-02-24 13:03:59 -0800 | [diff] [blame] | 45 | GET_RETRY_MAX = 10 |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 46 | |
J. Richard Barnette | 5383f07 | 2012-07-26 17:35:40 -0700 | [diff] [blame] | 47 | # Delays to deal with DUT state transitions. |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 48 | SLEEP_DELAY = 6 |
| 49 | BOOT_DELAY = 10 |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 50 | |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 51 | # Default minimum time interval between 'press' and 'release' |
| 52 | # keyboard events. |
Vic Yang | 0aca1c2 | 2012-11-19 18:33:56 -0800 | [diff] [blame] | 53 | SERVO_KEY_PRESS_DELAY = 0.1 |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 54 | |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 55 | # Time between an usb disk plugged-in and detected in the system. |
| 56 | USB_DETECTION_DELAY = 10 |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 57 | # Time to keep USB power off before and after USB mux direction is changed |
| 58 | USB_POWEROFF_DELAY = 2 |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 59 | |
Simran Basi | b7850bb | 2013-07-24 12:33:42 -0700 | [diff] [blame] | 60 | # Time to wait before timing out on servo initialization. |
| 61 | INIT_TIMEOUT_SECS = 10 |
Simran Basi | 5933134 | 2013-07-12 12:06:29 -0700 | [diff] [blame] | 62 | |
J. Richard Barnette | 67ccb87 | 2012-04-19 16:34:56 -0700 | [diff] [blame] | 63 | |
Ricky Liang | 0dd379c | 2014-04-23 16:29:08 +0800 | [diff] [blame] | 64 | def __init__(self, servo_host, servo_serial=None): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 65 | """Sets up the servo communication infrastructure. |
| 66 | |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 67 | @param servo_host: A ServoHost object representing |
| 68 | the host running servod. |
Ricky Liang | 0dd379c | 2014-04-23 16:29:08 +0800 | [diff] [blame] | 69 | @param servo_serial: Serial number of the servo board. |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 70 | """ |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 71 | # TODO(fdeng): crbug.com/298379 |
| 72 | # We should move servo_host object out of servo object |
| 73 | # to minimize the dependencies on the rest of Autotest. |
| 74 | self._servo_host = servo_host |
Ricky Liang | 0dd379c | 2014-04-23 16:29:08 +0800 | [diff] [blame] | 75 | self._servo_serial = servo_serial |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 76 | self._server = servo_host.get_servod_server_proxy() |
J. Richard Barnette | 75136b3 | 2013-03-26 13:38:44 -0700 | [diff] [blame] | 77 | self._power_state = ( |
J. Richard Barnette | 4b6af0d | 2014-06-05 09:57:20 -0700 | [diff] [blame^] | 78 | power_state_controller.create_controller(self)) |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 79 | |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 80 | # a string, showing what interface (host or dut) the USB device is |
| 81 | # connected to. |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 82 | self._usb_state = None |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 83 | self.set('dut_hub_pwren', 'on') |
| 84 | self.set('usb_mux_oe1', 'on') |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 85 | self.switch_usbkey('off') |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 86 | |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 87 | # Initialize firmware programmer |
Yusuf Mohsinally | 6a83757 | 2014-03-10 14:35:45 -0700 | [diff] [blame] | 88 | if self.get_version() == "servo_v2": |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 89 | self._programmer = firmware_programmer.ProgrammerV2(self) |
| 90 | else: |
Ilja H. Friedel | 04be2bd | 2014-05-07 21:29:59 -0700 | [diff] [blame] | 91 | logging.warning("No firmware programmer for servo version: %s", |
Yusuf Mohsinally | 6a83757 | 2014-03-10 14:35:45 -0700 | [diff] [blame] | 92 | self.get_version()) |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 93 | |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 94 | |
Ricky Liang | 0dd379c | 2014-04-23 16:29:08 +0800 | [diff] [blame] | 95 | @property |
| 96 | def servo_serial(self): |
| 97 | """Returns the serial number of the servo board.""" |
| 98 | return self._servo_serial |
| 99 | |
| 100 | |
Tom Wai-Hong Tam | 22ee0e5 | 2013-04-03 13:36:39 +0800 | [diff] [blame] | 101 | def get_power_state_controller(self): |
J. Richard Barnette | 75136b3 | 2013-03-26 13:38:44 -0700 | [diff] [blame] | 102 | """Return the power state controller for this Servo. |
| 103 | |
| 104 | The power state controller provides board-independent |
| 105 | interfaces for reset, power-on, power-off operations. |
| 106 | |
| 107 | """ |
| 108 | return self._power_state |
| 109 | |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 110 | |
J. Richard Barnette | b613397 | 2012-07-19 17:13:55 -0700 | [diff] [blame] | 111 | def initialize_dut(self, cold_reset=False): |
| 112 | """Initializes a dut for testing purposes. |
| 113 | |
| 114 | This sets various servo signals back to default values |
| 115 | appropriate for the target board. By default, if the DUT |
| 116 | is already on, it stays on. If the DUT is powered off |
| 117 | before initialization, its state afterward is unspecified. |
| 118 | |
J. Richard Barnette | b613397 | 2012-07-19 17:13:55 -0700 | [diff] [blame] | 119 | Rationale: Basic initialization of servo sets the lid open, |
| 120 | when there is a lid. This operation won't affect powered on |
| 121 | units; however, setting the lid open may power on a unit |
J. Richard Barnette | 75136b3 | 2013-03-26 13:38:44 -0700 | [diff] [blame] | 122 | that's off, depending on the board type and previous state |
| 123 | of the device. |
| 124 | |
J. Richard Barnette | 4b6af0d | 2014-06-05 09:57:20 -0700 | [diff] [blame^] | 125 | If `cold_reset` is a true value, the DUT and its EC will be |
| 126 | reset, and the DUT rebooted in normal mode. |
J. Richard Barnette | b613397 | 2012-07-19 17:13:55 -0700 | [diff] [blame] | 127 | |
| 128 | @param cold_reset If True, cold reset the device after |
| 129 | initialization. |
| 130 | """ |
| 131 | self._server.hwinit() |
| 132 | if cold_reset: |
J. Richard Barnette | 4b6af0d | 2014-06-05 09:57:20 -0700 | [diff] [blame^] | 133 | self._power_state.reset() |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 134 | |
| 135 | |
Tom Wai-Hong Tam | 1c86c7a | 2012-10-22 10:08:24 +0800 | [diff] [blame] | 136 | def is_localhost(self): |
| 137 | """Is the servod hosted locally? |
| 138 | |
| 139 | Returns: |
| 140 | True if local hosted; otherwise, False. |
| 141 | """ |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 142 | return self._servo_host.is_localhost() |
Tom Wai-Hong Tam | 1c86c7a | 2012-10-22 10:08:24 +0800 | [diff] [blame] | 143 | |
| 144 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 145 | def power_long_press(self): |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 146 | """Simulate a long power button press.""" |
J. Richard Barnette | f12bff2 | 2012-07-18 14:41:06 -0700 | [diff] [blame] | 147 | # After a long power press, the EC may ignore the next power |
| 148 | # button press (at least on Alex). To guarantee that this |
| 149 | # won't happen, we need to allow the EC one second to |
| 150 | # collect itself. |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 151 | self._server.power_long_press() |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 152 | |
| 153 | |
| 154 | def power_normal_press(self): |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 155 | """Simulate a normal power button press.""" |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 156 | self._server.power_normal_press() |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 157 | |
| 158 | |
| 159 | def power_short_press(self): |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 160 | """Simulate a short power button press.""" |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 161 | self._server.power_short_press() |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 162 | |
| 163 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 164 | def power_key(self, press_secs=''): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 165 | """Simulate a power button press. |
| 166 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 167 | @param press_secs : Str. Time to press key. |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 168 | """ |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 169 | self._server.power_key(press_secs) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 170 | |
| 171 | |
| 172 | def lid_open(self): |
| 173 | """Simulate opening the lid.""" |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 174 | self.set_nocheck('lid_open', 'yes') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 175 | |
| 176 | |
| 177 | def lid_close(self): |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 178 | """Simulate closing the lid. |
| 179 | |
| 180 | Waits 6 seconds to ensure the device is fully asleep before returning. |
| 181 | """ |
| 182 | self.set_nocheck('lid_open', 'no') |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 183 | time.sleep(Servo.SLEEP_DELAY) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 184 | |
| 185 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 186 | def ctrl_d(self, press_secs=''): |
| 187 | """Simulate Ctrl-d simultaneous button presses. |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 188 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 189 | @param press_secs : Str. Time to press key. |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 190 | """ |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 191 | self._server.ctrl_d(press_secs) |
Gediminas Ramanauskas | 9da80f2 | 2012-11-14 12:59:43 -0800 | [diff] [blame] | 192 | |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 193 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 194 | def ctrl_u(self): |
| 195 | """Simulate Ctrl-u simultaneous button presses. |
| 196 | |
| 197 | @param press_secs : Str. Time to press key. |
| 198 | """ |
| 199 | self._server.ctrl_u() |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 200 | |
| 201 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 202 | def ctrl_enter(self, press_secs=''): |
| 203 | """Simulate Ctrl-enter simultaneous button presses. |
| 204 | |
| 205 | @param press_secs : Str. Time to press key. |
| 206 | """ |
| 207 | self._server.ctrl_enter(press_secs) |
Gediminas Ramanauskas | 3297d4f | 2012-09-10 15:30:10 -0700 | [diff] [blame] | 208 | |
| 209 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 210 | def d_key(self, press_secs=''): |
| 211 | """Simulate Enter key button press. |
| 212 | |
| 213 | @param press_secs : Str. Time to press key. |
| 214 | """ |
| 215 | self._server.d_key(press_secs) |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 216 | |
| 217 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 218 | def ctrl_key(self, press_secs=''): |
| 219 | """Simulate Enter key button press. |
| 220 | |
| 221 | @param press_secs : Str. Time to press key. |
| 222 | """ |
| 223 | self._server.ctrl_key(press_secs) |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 224 | |
| 225 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 226 | def enter_key(self, press_secs=''): |
| 227 | """Simulate Enter key button press. |
| 228 | |
| 229 | @param press_secs : Str. Time to press key. |
| 230 | """ |
| 231 | self._server.enter_key(press_secs) |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 232 | |
| 233 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 234 | def refresh_key(self, press_secs=''): |
| 235 | """Simulate Refresh key (F3) button press. |
| 236 | |
| 237 | @param press_secs : Str. Time to press key. |
| 238 | """ |
| 239 | self._server.refresh_key(press_secs) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 240 | |
| 241 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 242 | def ctrl_refresh_key(self, press_secs=''): |
Tom Wai-Hong Tam | 9e61e66 | 2012-08-01 15:10:07 +0800 | [diff] [blame] | 243 | """Simulate Ctrl and Refresh (F3) simultaneous press. |
| 244 | |
| 245 | This key combination is an alternative of Space key. |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 246 | |
| 247 | @param press_secs : Str. Time to press key. |
Tom Wai-Hong Tam | 9e61e66 | 2012-08-01 15:10:07 +0800 | [diff] [blame] | 248 | """ |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 249 | self._server.ctrl_refresh_key(press_secs) |
Tom Wai-Hong Tam | 9e61e66 | 2012-08-01 15:10:07 +0800 | [diff] [blame] | 250 | |
| 251 | |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 252 | def imaginary_key(self, press_secs=''): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 253 | """Simulate imaginary key button press. |
| 254 | |
| 255 | Maps to a key that doesn't physically exist. |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 256 | |
| 257 | @param press_secs : Str. Time to press key. |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 258 | """ |
Yusuf Mohsinally | 103441a | 2014-01-14 15:25:44 -0800 | [diff] [blame] | 259 | self._server.imaginary_key(press_secs) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 260 | |
| 261 | |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 262 | def enable_recovery_mode(self): |
| 263 | """Enable recovery mode on device.""" |
| 264 | self.set('rec_mode', 'on') |
| 265 | |
| 266 | |
Gediminas Ramanauskas | ba352ad | 2012-11-09 09:43:32 -0800 | [diff] [blame] | 267 | def custom_recovery_mode(self): |
| 268 | """Custom key combination to enter recovery mode.""" |
| 269 | self._press_keys('rec_mode') |
| 270 | self.power_normal_press() |
| 271 | time.sleep(self.SERVO_KEY_PRESS_DELAY) |
| 272 | self.set_nocheck('kbd_en', 'off') |
| 273 | |
| 274 | |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 275 | def disable_recovery_mode(self): |
| 276 | """Disable recovery mode on device.""" |
| 277 | self.set('rec_mode', 'off') |
| 278 | |
| 279 | |
| 280 | def enable_development_mode(self): |
| 281 | """Enable development mode on device.""" |
| 282 | self.set('dev_mode', 'on') |
| 283 | |
| 284 | |
| 285 | def disable_development_mode(self): |
| 286 | """Disable development mode on device.""" |
| 287 | self.set('dev_mode', 'off') |
| 288 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 289 | def boot_devmode(self): |
| 290 | """Boot a dev-mode device that is powered off.""" |
Tom Wai-Hong Tam | 2386910 | 2012-01-17 15:41:30 +0800 | [diff] [blame] | 291 | self.power_short_press() |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 292 | self.pass_devmode() |
| 293 | |
| 294 | |
| 295 | def pass_devmode(self): |
| 296 | """Pass through boot screens in dev-mode.""" |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 297 | time.sleep(Servo.BOOT_DELAY) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 298 | self.ctrl_d() |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 299 | time.sleep(Servo.BOOT_DELAY) |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 300 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 301 | |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 302 | def get_version(self): |
| 303 | """Get the version of servod board. |
| 304 | |
| 305 | """ |
| 306 | return self._server.get_version() |
| 307 | |
| 308 | |
| 309 | def get_board(self): |
| 310 | """Get the board connected to servod. |
| 311 | |
| 312 | """ |
| 313 | return self._server.get_board() |
| 314 | |
| 315 | |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 316 | def _get_xmlrpclib_exception(self, xmlexc): |
| 317 | """Get meaningful exception string from xmlrpc. |
| 318 | |
| 319 | Args: |
| 320 | xmlexc: xmlrpclib.Fault object |
| 321 | |
| 322 | xmlrpclib.Fault.faultString has the following format: |
| 323 | |
| 324 | <type 'exception type'>:'actual error message' |
| 325 | |
| 326 | Parse and return the real exception from the servod side instead of the |
| 327 | less meaningful one like, |
| 328 | <Fault 1: "<type 'exceptions.AttributeError'>:'tca6416' object has no |
| 329 | attribute 'hw_driver'"> |
| 330 | |
| 331 | Returns: |
| 332 | string of underlying exception raised in servod. |
| 333 | """ |
| 334 | return re.sub('^.*>:', '', xmlexc.faultString) |
| 335 | |
| 336 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 337 | def get(self, gpio_name): |
| 338 | """Get the value of a gpio from Servod.""" |
| 339 | assert gpio_name |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 340 | try: |
Simran Basi | 1cbc5f2 | 2013-07-17 14:23:58 -0700 | [diff] [blame] | 341 | return self._server.get(gpio_name) |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 342 | except xmlrpclib.Fault as e: |
| 343 | err_msg = "Getting '%s' :: %s" % \ |
| 344 | (gpio_name, self._get_xmlrpclib_exception(e)) |
| 345 | raise error.TestFail(err_msg) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 346 | |
| 347 | |
| 348 | def set(self, gpio_name, gpio_value): |
| 349 | """Set and check the value of a gpio using Servod.""" |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 350 | self.set_nocheck(gpio_name, gpio_value) |
Todd Broch | cf7c665 | 2012-02-24 13:03:59 -0800 | [diff] [blame] | 351 | retry_count = Servo.GET_RETRY_MAX |
| 352 | while gpio_value != self.get(gpio_name) and retry_count: |
Ilja H. Friedel | 04be2bd | 2014-05-07 21:29:59 -0700 | [diff] [blame] | 353 | logging.warning("%s != %s, retry %d", gpio_name, gpio_value, |
Todd Broch | cf7c665 | 2012-02-24 13:03:59 -0800 | [diff] [blame] | 354 | retry_count) |
| 355 | retry_count -= 1 |
| 356 | time.sleep(Servo.SHORT_DELAY) |
| 357 | if not retry_count: |
| 358 | assert gpio_value == self.get(gpio_name), \ |
| 359 | 'Servo failed to set %s to %s' % (gpio_name, gpio_value) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 360 | |
| 361 | |
| 362 | def set_nocheck(self, gpio_name, gpio_value): |
| 363 | """Set the value of a gpio using Servod.""" |
| 364 | assert gpio_name and gpio_value |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 365 | logging.info('Setting %s to %s', gpio_name, gpio_value) |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 366 | try: |
Simran Basi | 1cbc5f2 | 2013-07-17 14:23:58 -0700 | [diff] [blame] | 367 | self._server.set(gpio_name, gpio_value) |
Todd Broch | efe72cb | 2012-07-11 19:58:53 -0700 | [diff] [blame] | 368 | except xmlrpclib.Fault as e: |
| 369 | err_msg = "Setting '%s' to '%s' :: %s" % \ |
| 370 | (gpio_name, gpio_value, self._get_xmlrpclib_exception(e)) |
| 371 | raise error.TestFail(err_msg) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 372 | |
| 373 | |
Tom Wai-Hong Tam | 92569bb | 2013-03-26 14:25:10 +0800 | [diff] [blame] | 374 | def set_get_all(self, controls): |
| 375 | """Set &| get one or more control values. |
| 376 | |
| 377 | @param controls: list of strings, controls to set &| get. |
| 378 | |
| 379 | @raise: error.TestError in case error occurs setting/getting values. |
| 380 | """ |
| 381 | rv = [] |
| 382 | try: |
Vic Yang | cad9acb | 2013-05-21 14:02:05 +0800 | [diff] [blame] | 383 | logging.info('Set/get all: %s', str(controls)) |
Tom Wai-Hong Tam | 92569bb | 2013-03-26 14:25:10 +0800 | [diff] [blame] | 384 | rv = self._server.set_get_all(controls) |
| 385 | except xmlrpclib.Fault as e: |
| 386 | # TODO(waihong): Remove the following backward compatibility when |
| 387 | # the new versions of hdctools are deployed. |
| 388 | if 'not supported' in str(e): |
| 389 | logging.warning('The servod is too old that set_get_all ' |
| 390 | 'not supported. Use set and get instead.') |
| 391 | for control in controls: |
| 392 | if ':' in control: |
| 393 | (name, value) = control.split(':') |
| 394 | if name == 'sleep': |
| 395 | time.sleep(float(value)) |
| 396 | else: |
| 397 | self.set_nocheck(name, value) |
| 398 | rv.append(True) |
| 399 | else: |
| 400 | rv.append(self.get(name)) |
| 401 | else: |
| 402 | err_msg = "Problem with '%s' :: %s" % \ |
| 403 | (controls, self._get_xmlrpclib_exception(e)) |
| 404 | raise error.TestFail(err_msg) |
| 405 | return rv |
| 406 | |
| 407 | |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 408 | # TODO(waihong) It may fail if multiple servo's are connected to the same |
| 409 | # host. Should look for a better way, like the USB serial name, to identify |
| 410 | # the USB device. |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 411 | # TODO(sbasi) Remove this code from autoserv once firmware tests have been |
| 412 | # updated. |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 413 | def probe_host_usb_dev(self): |
| 414 | """Probe the USB disk device plugged-in the servo from the host side. |
| 415 | |
| 416 | It tries to switch the USB mux to make the host unable to see the |
| 417 | USB disk and compares the result difference. |
| 418 | |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 419 | Returns: |
| 420 | A string of USB disk path, like '/dev/sdb', or None if not existed. |
| 421 | """ |
| 422 | cmd = 'ls /dev/sd[a-z]' |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 423 | original_value = self.get_usbkey_direction() |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 424 | |
| 425 | # Make the host unable to see the USB disk. |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 426 | self.switch_usbkey('off') |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 427 | no_usb_set = set(self.system_output(cmd, ignore_status=True).split()) |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 428 | |
| 429 | # Make the host able to see the USB disk. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 430 | self.switch_usbkey('host') |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 431 | has_usb_set = set(self.system_output(cmd, ignore_status=True).split()) |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 432 | |
| 433 | # Back to its original value. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 434 | if original_value != self.get_usbkey_direction(): |
| 435 | self.switch_usbkey(original_value) |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 436 | |
| 437 | diff_set = has_usb_set - no_usb_set |
| 438 | if len(diff_set) == 1: |
| 439 | return diff_set.pop() |
| 440 | else: |
| 441 | return None |
| 442 | |
| 443 | |
J. Richard Barnette | 69929a5 | 2013-03-15 13:22:11 -0700 | [diff] [blame] | 444 | def recovery_supported(self): |
| 445 | """Return whether servo-based recovery should work. |
| 446 | |
| 447 | Use of `image_to_servo_usb()` and `install_recovery_image()` |
| 448 | relies on DUT-board specific behaviors, and is not supported |
| 449 | for all types of board. Return whether these two operations |
| 450 | are expected to succeed for the current DUT. |
| 451 | |
| 452 | @return `True` iff the recovery related methods are supported |
| 453 | for this servo and DUT. |
| 454 | |
| 455 | """ |
J. Richard Barnette | 75136b3 | 2013-03-26 13:38:44 -0700 | [diff] [blame] | 456 | return self._power_state.recovery_supported() |
J. Richard Barnette | 69929a5 | 2013-03-15 13:22:11 -0700 | [diff] [blame] | 457 | |
| 458 | |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 459 | def image_to_servo_usb(self, image_path=None, |
| 460 | make_image_noninteractive=False): |
| 461 | """Install an image to the USB key plugged into the servo. |
| 462 | |
| 463 | This method may copy any image to the servo USB key including a |
| 464 | recovery image or a test image. These images are frequently used |
| 465 | for test purposes such as restoring a corrupted image or conducting |
| 466 | an upgrade of ec/fw/kernel as part of a test of a specific image part. |
| 467 | |
| 468 | Args: |
| 469 | image_path: Path on the host to the recovery image. |
| 470 | make_image_noninteractive: Make the recovery image noninteractive, |
| 471 | therefore the DUT will reboot |
| 472 | automatically after installation. |
| 473 | """ |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 474 | # We're about to start plugging/unplugging the USB key. We |
| 475 | # don't know the state of the DUT, or what it might choose |
| 476 | # to do to the device after hotplug. To avoid surprises, |
| 477 | # force the DUT to be off. |
| 478 | self._server.hwinit() |
| 479 | self._power_state.power_off() |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 480 | |
| 481 | # Set up Servo's usb mux. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 482 | self.switch_usbkey('host') |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 483 | if image_path: |
Tom Wai-Hong Tam | 42f136d | 2012-10-26 11:11:23 +0800 | [diff] [blame] | 484 | logging.info('Searching for usb device and copying image to it. ' |
| 485 | 'Please wait a few minutes...') |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 486 | if not self._server.download_image_to_usb(image_path): |
| 487 | logging.error('Failed to transfer requested image to USB. ' |
| 488 | 'Please take a look at Servo Logs.') |
| 489 | raise error.AutotestError('Download image to usb failed.') |
| 490 | if make_image_noninteractive: |
| 491 | logging.info('Making image noninteractive') |
| 492 | if not self._server.make_image_noninteractive(): |
| 493 | logging.error('Failed to make image noninteractive. ' |
| 494 | 'Please take a look at Servo Logs.') |
| 495 | |
| 496 | |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 497 | def install_recovery_image(self, image_path=None, |
J. Richard Barnette | b6de7e3 | 2013-02-14 13:28:04 -0800 | [diff] [blame] | 498 | make_image_noninteractive=False): |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 499 | """Install the recovery image specied by the path onto the DUT. |
| 500 | |
| 501 | This method uses google recovery mode to install a recovery image |
| 502 | 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] | 503 | board specified by the usb_dev. If no image path is specified |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 504 | we use the recovery image already on the usb image. |
| 505 | |
| 506 | Args: |
| 507 | image_path: Path on the host to the recovery image. |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 508 | make_image_noninteractive: Make the recovery image noninteractive, |
| 509 | therefore the DUT will reboot |
| 510 | automatically after installation. |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 511 | """ |
Mike Truty | 49153d8 | 2012-08-21 22:27:30 -0500 | [diff] [blame] | 512 | self.image_to_servo_usb(image_path, make_image_noninteractive) |
J. Richard Barnette | 4b6af0d | 2014-06-05 09:57:20 -0700 | [diff] [blame^] | 513 | self._power_state.power_on(rec_mode=self._power_state.REC_ON) |
J. Richard Barnette | 41320ee | 2013-03-11 13:00:13 -0700 | [diff] [blame] | 514 | self.switch_usbkey('dut') |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 515 | |
| 516 | |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 517 | def _scp_image(self, image_path): |
| 518 | """Copy image to the servo host. |
| 519 | |
| 520 | When programming a firmware image on the DUT, the image must be |
| 521 | located on the host to which the servo device is connected. Sometimes |
| 522 | servo is controlled by a remote host, in this case the image needs to |
| 523 | be transferred to the remote host. |
| 524 | |
| 525 | @param image_path: a string, name of the firmware image file to be |
| 526 | transferred. |
| 527 | @return: a string, full path name of the copied file on the remote. |
| 528 | """ |
| 529 | |
| 530 | dest_path = os.path.join('/tmp', os.path.basename(image_path)) |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 531 | self._servo_host.send_file(image_path, dest_path) |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 532 | return dest_path |
| 533 | |
| 534 | |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 535 | def system(self, command, timeout=None): |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 536 | """Execute the passed in command on the servod host.""" |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 537 | logging.info('Will execute on servo host: %s', command) |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 538 | self._servo_host.run(command, timeout=timeout) |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 539 | |
| 540 | |
| 541 | def system_output(self, command, timeout=None, |
| 542 | ignore_status=False, args=()): |
| 543 | """Execute the passed in command on the servod host, return stdout. |
| 544 | |
| 545 | @param command, a string, the command to execute |
| 546 | @param timeout, an int, max number of seconds to wait til command |
| 547 | execution completes |
| 548 | @ignore_status, a Boolean, if true - ignore command's nonzero exit |
| 549 | status, otherwise an exception will be thrown |
| 550 | @param args, a tuple of strings, each becoming a separate command line |
| 551 | parameter for the command |
| 552 | @return: command's stdout as a string. |
| 553 | """ |
Vadim Bendebury | 89ec24e | 2012-12-17 12:54:18 -0800 | [diff] [blame] | 554 | logging.info('Will execute and collect output on servo host: %s %s', |
| 555 | command, ' '.join("'%s'" % x for x in args)) |
Fang Deng | 5d518f4 | 2013-08-02 14:04:32 -0700 | [diff] [blame] | 556 | return self._servo_host.run(command, timeout=timeout, |
| 557 | ignore_status=ignore_status, |
| 558 | args=args).stdout.strip() |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 559 | |
| 560 | |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 561 | def program_bios(self, image): |
| 562 | """Program bios on DUT with given image. |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 563 | |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 564 | @param image: a string, file name of the BIOS image to program |
| 565 | on the DUT. |
| 566 | |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 567 | """ |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 568 | if not self.is_localhost(): |
| 569 | image = self._scp_image(image) |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 570 | self._programmer.program_bios(image) |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 571 | |
| 572 | |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 573 | def program_ec(self, image): |
| 574 | """Program ec on DUT with given image. |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 575 | |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 576 | @param image: a string, file name of the EC image to program |
| 577 | on the DUT. |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 578 | |
Vadim Bendebury | 1a7ec63 | 2013-02-17 16:22:09 -0800 | [diff] [blame] | 579 | """ |
Vadim Bendebury | b80ba59 | 2012-12-07 15:02:34 -0800 | [diff] [blame] | 580 | if not self.is_localhost(): |
| 581 | image = self._scp_image(image) |
Yusuf Mohsinally | 6c078ae | 2013-11-21 11:06:42 -0800 | [diff] [blame] | 582 | self._programmer.program_ec(image) |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 583 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 584 | |
| 585 | def _switch_usbkey_power(self, power_state, detection_delay=False): |
| 586 | """Switch usbkey power. |
| 587 | |
| 588 | This function switches usbkey power by setting the value of |
| 589 | 'prtctl4_pwren'. If the power is already in the |
| 590 | requested state, this function simply returns. |
| 591 | |
| 592 | @param power_state: A string, 'on' or 'off'. |
| 593 | @param detection_delay: A boolean value, if True, sleep |
| 594 | for |USB_DETECTION_DELAY| after switching |
| 595 | the power on. |
| 596 | """ |
| 597 | self.set('prtctl4_pwren', power_state) |
| 598 | if power_state == 'off': |
| 599 | time.sleep(self.USB_POWEROFF_DELAY) |
| 600 | elif detection_delay: |
| 601 | time.sleep(self.USB_DETECTION_DELAY) |
| 602 | |
| 603 | |
| 604 | def switch_usbkey(self, usb_state): |
| 605 | """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] | 606 | |
| 607 | This function switches the servo multiplexer to provide electrical |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 608 | connection between the USB port J3 and either host or DUT side. It |
| 609 | can also be used to turn the USB port off. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 610 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 611 | Switching to 'dut' or 'host' is accompanied by powercycling |
| 612 | of the USB stick, because it sometimes gets wedged if the mux |
| 613 | is switched while the stick power is on. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 614 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 615 | @param usb_state: A string, one of 'dut', 'host', or 'off'. |
| 616 | 'dut' and 'host' indicate which side the |
| 617 | USB flash device is required to be connected to. |
| 618 | 'off' indicates turning the USB port off. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 619 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 620 | @raise: error.TestError in case the parameter is not 'dut' |
| 621 | 'host', or 'off'. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 622 | """ |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 623 | if self.get_usbkey_direction() == usb_state: |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 624 | return |
| 625 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 626 | if usb_state == 'off': |
| 627 | self._switch_usbkey_power('off') |
| 628 | self._usb_state = usb_state |
| 629 | return |
| 630 | elif usb_state == 'host': |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 631 | mux_direction = 'servo_sees_usbkey' |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 632 | elif usb_state == 'dut': |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 633 | mux_direction = 'dut_sees_usbkey' |
| 634 | else: |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 635 | raise error.TestError('Unknown USB state request: %s' % usb_state) |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 636 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 637 | self._switch_usbkey_power('off') |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 638 | self.set('usb_mux_sel1', mux_direction) |
| 639 | time.sleep(self.USB_POWEROFF_DELAY) |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 640 | self._switch_usbkey_power('on', usb_state == 'host') |
| 641 | self._usb_state = usb_state |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 642 | |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 643 | |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 644 | def get_usbkey_direction(self): |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 645 | """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] | 646 | |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 647 | @return: A string, one of 'dut', 'host', or 'off'. |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 648 | """ |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 649 | if not self._usb_state: |
| 650 | if self.get('prtctl4_pwren') == 'off': |
| 651 | self._usb_state = 'off' |
| 652 | elif self.get('usb_mux_sel1').startswith('dut'): |
| 653 | self._usb_state = 'dut' |
Vadim Bendebury | e7bd936 | 2012-12-19 14:35:20 -0800 | [diff] [blame] | 654 | else: |
Fang Deng | afb8814 | 2013-05-30 17:44:31 -0700 | [diff] [blame] | 655 | self._usb_state = 'host' |
| 656 | return self._usb_state |