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 | |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 8 | import logging, os, select, subprocess, sys, time, xmlrpclib |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 9 | from autotest_lib.client.bin import utils as client_utils |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 10 | from autotest_lib.client.common_lib import error |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 11 | from autotest_lib.server import utils |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 12 | |
J. Richard Barnette | 384056b | 2012-04-16 11:04:46 -0700 | [diff] [blame] | 13 | class Servo(object): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 14 | """Manages control of a Servo board. |
| 15 | |
| 16 | Servo is a board developed by hardware group to aide in the debug and |
| 17 | control of various partner devices. Servo's features include the simulation |
| 18 | of pressing the power button, closing the lid, and pressing Ctrl-d. This |
| 19 | class manages setting up and communicating with a servo demon (servod) |
| 20 | process. It provides both high-level functions for common servo tasks and |
| 21 | low-level functions for directly setting and reading gpios. |
| 22 | """ |
| 23 | |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 24 | # Power button press delays in seconds. |
J. Richard Barnette | d2e4cbd | 2012-06-29 12:18:40 -0700 | [diff] [blame^] | 25 | # |
| 26 | # TODO(jrbarnette): The EC specification says that 8.0 seconds |
| 27 | # should be enough for the long power press. However, on |
| 28 | # existing platforms (e.g. Alex), we need a bit more time. |
| 29 | # Being generous is the right thing to do for existing platforms, |
| 30 | # but if this code is to be used for qualification of new hardware, |
| 31 | # we should be less generous. |
| 32 | LONG_DELAY = 8.2 |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 33 | SHORT_DELAY = 0.1 |
| 34 | NORMAL_TRANSITION_DELAY = 1.2 |
Todd Broch | 31c8250 | 2011-08-29 08:14:39 -0700 | [diff] [blame] | 35 | # Maximum number of times to re-read power button on release. |
| 36 | RELEASE_RETRY_MAX = 5 |
Todd Broch | cf7c665 | 2012-02-24 13:03:59 -0800 | [diff] [blame] | 37 | GET_RETRY_MAX = 10 |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 38 | |
| 39 | # Delays to deal with computer transitions. |
| 40 | SLEEP_DELAY = 6 |
| 41 | BOOT_DELAY = 10 |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 42 | RECOVERY_BOOT_DELAY = 30 |
J. Richard Barnette | c5a77ad | 2012-04-25 08:19:00 -0700 | [diff] [blame] | 43 | RECOVERY_INSTALL_DELAY = 540 |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 44 | |
| 45 | # Servo-specific delays. |
| 46 | MAX_SERVO_STARTUP_DELAY = 10 |
| 47 | SERVO_SEND_SIGNAL_DELAY = 0.5 |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 48 | |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 49 | # Time between an usb disk plugged-in and detected in the system. |
| 50 | USB_DETECTION_DELAY = 10 |
| 51 | |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 52 | KEY_MATRIX = { |
| 53 | 'm1': {'ctrl_r': ['0', '0'], 'd': ['0', '1'], |
| 54 | 'enter': ['1', '0'], 'none': ['1', '1']}, |
| 55 | 'm2': {'ctrl': ['0', '0'], 'refresh': ['0', '1'], |
| 56 | 'unused': ['1', '0'], 'none': ['1', '1']} |
| 57 | } |
Chris Masone | 6a0680f | 2012-03-02 08:40:00 -0800 | [diff] [blame] | 58 | |
J. Richard Barnette | 67ccb87 | 2012-04-19 16:34:56 -0700 | [diff] [blame] | 59 | |
Chris Masone | 6a0680f | 2012-03-02 08:40:00 -0800 | [diff] [blame] | 60 | @staticmethod |
J. Richard Barnette | 67ccb87 | 2012-04-19 16:34:56 -0700 | [diff] [blame] | 61 | def _make_servo_hostname(hostname): |
| 62 | host_parts = hostname.split('.') |
| 63 | host_parts[0] = host_parts[0] + '-servo' |
| 64 | return '.'.join(host_parts) |
Chris Masone | 6a0680f | 2012-03-02 08:40:00 -0800 | [diff] [blame] | 65 | |
J. Richard Barnette | 67ccb87 | 2012-04-19 16:34:56 -0700 | [diff] [blame] | 66 | @staticmethod |
| 67 | def get_lab_servo(target_hostname): |
| 68 | """Instantiate a Servo for |target_hostname| in the lab. |
Chris Masone | 6a0680f | 2012-03-02 08:40:00 -0800 | [diff] [blame] | 69 | |
J. Richard Barnette | 67ccb87 | 2012-04-19 16:34:56 -0700 | [diff] [blame] | 70 | Assuming that |target_hostname| is a device in the CrOS test |
| 71 | lab, create and return a Servo object pointed at the servo |
| 72 | attached to that DUT. The servo in the test lab is assumed |
| 73 | to already have servod up and running on it. |
| 74 | |
| 75 | @param target_hostname: device whose servo we want to target. |
Chris Masone | 6a0680f | 2012-03-02 08:40:00 -0800 | [diff] [blame] | 76 | @return an appropriately configured Servo |
| 77 | """ |
J. Richard Barnette | 67ccb87 | 2012-04-19 16:34:56 -0700 | [diff] [blame] | 78 | servo_host = Servo._make_servo_hostname(target_hostname) |
| 79 | if utils.host_is_in_lab_zone(servo_host): |
| 80 | try: |
| 81 | return Servo(servo_host=servo_host) |
| 82 | except: |
| 83 | # TODO(jrbarnette): Long-term, if we can't get to |
| 84 | # a servo in the lab, we want to fail, so we should |
| 85 | # pass any exceptions along. Short-term, we're not |
| 86 | # ready to rely on servo, so we ignore failures. |
| 87 | pass |
| 88 | return None |
Chris Masone | 6a0680f | 2012-03-02 08:40:00 -0800 | [diff] [blame] | 89 | |
| 90 | |
J. Richard Barnette | 55fb806 | 2012-05-23 10:29:31 -0700 | [diff] [blame] | 91 | def __init__(self, servo_host='localhost', servo_port=9999, |
| 92 | cold_reset=False): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 93 | """Sets up the servo communication infrastructure. |
| 94 | |
J. Richard Barnette | 55fb806 | 2012-05-23 10:29:31 -0700 | [diff] [blame] | 95 | @param servo_host Name of the host where the servod process |
| 96 | is running. |
| 97 | @param servo_port Port the servod process is listening on. |
| 98 | @param cold_reset If True, cold reset device and boot during init, |
| 99 | otherwise perform init with device running. |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 100 | """ |
J. Richard Barnette | 384056b | 2012-04-16 11:04:46 -0700 | [diff] [blame] | 101 | self._server = None |
Todd Broch | 5fd6bc0 | 2011-07-20 15:53:37 -0700 | [diff] [blame] | 102 | |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 103 | self._do_cold_reset = cold_reset |
Todd Broch | f24d278 | 2011-08-19 10:55:41 -0700 | [diff] [blame] | 104 | self._connect_servod(servo_host, servo_port) |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 105 | |
| 106 | |
| 107 | def initialize_dut(self): |
| 108 | """Initializes a dut for testing purposes.""" |
| 109 | if self._do_cold_reset: |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 110 | self._init_seq_cold_reset_devmode() |
| 111 | else: |
| 112 | self._init_seq() |
| 113 | |
| 114 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 115 | def power_long_press(self): |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 116 | """Simulate a long power button press.""" |
| 117 | self.power_key(Servo.LONG_DELAY) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 118 | |
| 119 | |
| 120 | def power_normal_press(self): |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 121 | """Simulate a normal power button press.""" |
| 122 | self.power_key() |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 123 | |
| 124 | |
| 125 | def power_short_press(self): |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 126 | """Simulate a short power button press.""" |
| 127 | self.power_key(Servo.SHORT_DELAY) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 128 | |
| 129 | |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 130 | def power_key(self, secs=NORMAL_TRANSITION_DELAY): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 131 | """Simulate a power button press. |
| 132 | |
| 133 | Args: |
| 134 | secs: Time in seconds to simulate the keypress. |
| 135 | """ |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 136 | self.set_nocheck('pwr_button', 'press') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 137 | time.sleep(secs) |
Todd Broch | 31c8250 | 2011-08-29 08:14:39 -0700 | [diff] [blame] | 138 | self.set_nocheck('pwr_button', 'release') |
| 139 | # TODO(tbroch) Different systems have different release times on the |
| 140 | # power button that this loop addresses. Longer term we may want to |
| 141 | # make this delay platform specific. |
| 142 | retry = 1 |
| 143 | while True: |
| 144 | value = self.get('pwr_button') |
| 145 | if value == 'release' or retry > Servo.RELEASE_RETRY_MAX: |
| 146 | break |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 147 | logging.info('Waiting for pwr_button to release, retry %d.', retry) |
Todd Broch | 31c8250 | 2011-08-29 08:14:39 -0700 | [diff] [blame] | 148 | retry += 1 |
| 149 | time.sleep(Servo.SHORT_DELAY) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 150 | |
| 151 | |
| 152 | def lid_open(self): |
| 153 | """Simulate opening the lid.""" |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 154 | self.set_nocheck('lid_open', 'yes') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 155 | |
| 156 | |
| 157 | def lid_close(self): |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 158 | """Simulate closing the lid. |
| 159 | |
| 160 | Waits 6 seconds to ensure the device is fully asleep before returning. |
| 161 | """ |
| 162 | self.set_nocheck('lid_open', 'no') |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 163 | time.sleep(Servo.SLEEP_DELAY) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 164 | |
| 165 | |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 166 | def _press_and_release_keys(self, m1, m2, |
| 167 | press_secs=SERVO_SEND_SIGNAL_DELAY): |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 168 | """Simulate button presses.""" |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 169 | # set keys to none |
| 170 | (m2_a1, m2_a0) = self.KEY_MATRIX['m2']['none'] |
| 171 | (m1_a1, m1_a0) = self.KEY_MATRIX['m1']['none'] |
| 172 | self.set_nocheck('kbd_m2_a0', m2_a0) |
| 173 | self.set_nocheck('kbd_m2_a1', m2_a1) |
| 174 | self.set_nocheck('kbd_m1_a0', m1_a0) |
| 175 | self.set_nocheck('kbd_m1_a1', m1_a1) |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 176 | |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 177 | (m2_a1, m2_a0) = self.KEY_MATRIX['m2'][m2] |
| 178 | (m1_a1, m1_a0) = self.KEY_MATRIX['m1'][m1] |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 179 | self.set_nocheck('kbd_en', 'on') |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 180 | self.set_nocheck('kbd_m2_a0', m2_a0) |
| 181 | self.set_nocheck('kbd_m2_a1', m2_a1) |
| 182 | self.set_nocheck('kbd_m1_a0', m1_a0) |
| 183 | self.set_nocheck('kbd_m1_a1', m1_a1) |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 184 | time.sleep(press_secs) |
| 185 | self.set_nocheck('kbd_en', 'off') |
| 186 | |
| 187 | |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 188 | def ctrl_d(self): |
| 189 | """Simulate Ctrl-d simultaneous button presses.""" |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 190 | self._press_and_release_keys('d', 'ctrl') |
| 191 | |
| 192 | |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 193 | def ctrl_enter(self): |
| 194 | """Simulate Ctrl-enter simultaneous button presses.""" |
| 195 | self._press_and_release_keys('enter', 'ctrl') |
| 196 | |
| 197 | |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 198 | def d_key(self): |
| 199 | """Simulate Enter key button press.""" |
| 200 | self._press_and_release_keys('d', 'none') |
| 201 | |
| 202 | |
| 203 | def ctrl_key(self): |
| 204 | """Simulate Enter key button press.""" |
| 205 | self._press_and_release_keys('none', 'ctrl') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 206 | |
| 207 | |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 208 | def enter_key(self): |
| 209 | """Simulate Enter key button press.""" |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 210 | self._press_and_release_keys('enter', 'none') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 211 | |
| 212 | |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 213 | def refresh_key(self): |
| 214 | """Simulate Refresh key (F3) button press.""" |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 215 | self._press_and_release_keys('none', 'refresh') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 216 | |
| 217 | |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 218 | def imaginary_key(self): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 219 | """Simulate imaginary key button press. |
| 220 | |
| 221 | Maps to a key that doesn't physically exist. |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 222 | """ |
Todd Broch | 9dfc3a8 | 2011-11-01 08:09:28 -0700 | [diff] [blame] | 223 | self._press_and_release_keys('none', 'unused') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 224 | |
| 225 | |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 226 | def enable_recovery_mode(self): |
| 227 | """Enable recovery mode on device.""" |
| 228 | self.set('rec_mode', 'on') |
| 229 | |
| 230 | |
| 231 | def disable_recovery_mode(self): |
| 232 | """Disable recovery mode on device.""" |
| 233 | self.set('rec_mode', 'off') |
| 234 | |
| 235 | |
| 236 | def enable_development_mode(self): |
| 237 | """Enable development mode on device.""" |
| 238 | self.set('dev_mode', 'on') |
| 239 | |
| 240 | |
| 241 | def disable_development_mode(self): |
| 242 | """Disable development mode on device.""" |
| 243 | self.set('dev_mode', 'off') |
| 244 | |
Chris Sosa | 8ee1d59 | 2011-08-14 16:50:31 -0700 | [diff] [blame] | 245 | def enable_usb_hub(self, host=False): |
Craig Harrison | 86b1a57 | 2011-08-12 11:26:52 -0700 | [diff] [blame] | 246 | """Enable Servo's USB/ethernet hub. |
| 247 | |
Chris Sosa | 8ee1d59 | 2011-08-14 16:50:31 -0700 | [diff] [blame] | 248 | This is equivalent to plugging in the USB devices attached to Servo to |
| 249 | the host (if |host| is True) or dut (if |host| is False). |
| 250 | For host=False, requires that the USB out on the servo board is |
| 251 | connected to a USB in port on the target device. Servo's USB ports are |
| 252 | labeled DUT_HUB_USB1 and DUT_HUB_USB2. Servo's ethernet port is also |
| 253 | connected to this hub. Servo's USB port DUT_HUB_IN is the output of the |
| 254 | hub. |
Craig Harrison | 86b1a57 | 2011-08-12 11:26:52 -0700 | [diff] [blame] | 255 | """ |
| 256 | self.set('dut_hub_pwren', 'on') |
Chris Sosa | 8ee1d59 | 2011-08-14 16:50:31 -0700 | [diff] [blame] | 257 | if host: |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 258 | self.set('usb_mux_oe1', 'on') |
| 259 | self.set('usb_mux_sel1', 'servo_sees_usbkey') |
Chris Sosa | 8ee1d59 | 2011-08-14 16:50:31 -0700 | [diff] [blame] | 260 | else: |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 261 | self.set('dut_hub_sel', 'dut_sees_hub') |
Chris Sosa | 8ee1d59 | 2011-08-14 16:50:31 -0700 | [diff] [blame] | 262 | |
Craig Harrison | 86b1a57 | 2011-08-12 11:26:52 -0700 | [diff] [blame] | 263 | self.set('dut_hub_on', 'yes') |
| 264 | |
| 265 | |
| 266 | def disable_usb_hub(self): |
| 267 | """Disable Servo's USB/ethernet hub. |
| 268 | |
| 269 | This is equivalent to unplugging the USB devices attached to Servo. |
| 270 | """ |
| 271 | self.set('dut_hub_on', 'no') |
| 272 | |
| 273 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 274 | def boot_devmode(self): |
| 275 | """Boot a dev-mode device that is powered off.""" |
Tom Wai-Hong Tam | 2386910 | 2012-01-17 15:41:30 +0800 | [diff] [blame] | 276 | self.power_short_press() |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 277 | self.pass_devmode() |
| 278 | |
| 279 | |
| 280 | def pass_devmode(self): |
| 281 | """Pass through boot screens in dev-mode.""" |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 282 | time.sleep(Servo.BOOT_DELAY) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 283 | self.ctrl_d() |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 284 | time.sleep(Servo.BOOT_DELAY) |
Craig Harrison | 4899726 | 2011-06-27 14:31:10 -0700 | [diff] [blame] | 285 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 286 | |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 287 | def cold_reset(self): |
| 288 | """Perform a cold reset of the EC. |
| 289 | |
Chris Sosa | 8ee1d59 | 2011-08-14 16:50:31 -0700 | [diff] [blame] | 290 | Has the side effect of shutting off the device. Device is guaranteed |
| 291 | to be off at the end of this call. |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 292 | """ |
| 293 | self.set('cold_reset', 'on') |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 294 | time.sleep(Servo.SERVO_SEND_SIGNAL_DELAY) |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 295 | |
| 296 | |
| 297 | def warm_reset(self): |
| 298 | """Perform a warm reset of the device. |
| 299 | |
| 300 | Has the side effect of restarting the device. |
| 301 | """ |
| 302 | self.set('warm_reset', 'on') |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 303 | time.sleep(Servo.SERVO_SEND_SIGNAL_DELAY) |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 304 | self.set('warm_reset', 'off') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 305 | |
| 306 | |
| 307 | def get(self, gpio_name): |
| 308 | """Get the value of a gpio from Servod.""" |
| 309 | assert gpio_name |
| 310 | return self._server.get(gpio_name) |
| 311 | |
| 312 | |
| 313 | def set(self, gpio_name, gpio_value): |
| 314 | """Set and check the value of a gpio using Servod.""" |
Chrome Bot | 9a1137d | 2011-07-19 14:35:00 -0700 | [diff] [blame] | 315 | self.set_nocheck(gpio_name, gpio_value) |
Todd Broch | cf7c665 | 2012-02-24 13:03:59 -0800 | [diff] [blame] | 316 | retry_count = Servo.GET_RETRY_MAX |
| 317 | while gpio_value != self.get(gpio_name) and retry_count: |
| 318 | logging.warn("%s != %s, retry %d", gpio_name, gpio_value, |
| 319 | retry_count) |
| 320 | retry_count -= 1 |
| 321 | time.sleep(Servo.SHORT_DELAY) |
| 322 | if not retry_count: |
| 323 | assert gpio_value == self.get(gpio_name), \ |
| 324 | 'Servo failed to set %s to %s' % (gpio_name, gpio_value) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 325 | |
| 326 | |
| 327 | def set_nocheck(self, gpio_name, gpio_value): |
| 328 | """Set the value of a gpio using Servod.""" |
| 329 | assert gpio_name and gpio_value |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 330 | logging.info('Setting %s to %s', gpio_name, gpio_value) |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 331 | self._server.set(gpio_name, gpio_value) |
| 332 | |
| 333 | |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 334 | # TODO(waihong) It may fail if multiple servo's are connected to the same |
| 335 | # host. Should look for a better way, like the USB serial name, to identify |
| 336 | # the USB device. |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 337 | # TODO(sbasi) Remove this code from autoserv once firmware tests have been |
| 338 | # updated. |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 339 | def probe_host_usb_dev(self): |
| 340 | """Probe the USB disk device plugged-in the servo from the host side. |
| 341 | |
| 342 | It tries to switch the USB mux to make the host unable to see the |
| 343 | USB disk and compares the result difference. |
| 344 | |
| 345 | This only works if the servo is attached to the local host. |
| 346 | |
| 347 | Returns: |
| 348 | A string of USB disk path, like '/dev/sdb', or None if not existed. |
| 349 | """ |
| 350 | cmd = 'ls /dev/sd[a-z]' |
| 351 | original_value = self.get('usb_mux_sel1') |
| 352 | |
| 353 | # Make the host unable to see the USB disk. |
| 354 | if original_value != 'dut_sees_usbkey': |
| 355 | self.set('usb_mux_sel1', 'dut_sees_usbkey') |
| 356 | time.sleep(self.USB_DETECTION_DELAY) |
| 357 | no_usb_set = set(utils.system_output(cmd, ignore_status=True).split()) |
| 358 | |
| 359 | # Make the host able to see the USB disk. |
| 360 | self.set('usb_mux_sel1', 'servo_sees_usbkey') |
| 361 | time.sleep(self.USB_DETECTION_DELAY) |
| 362 | has_usb_set = set(utils.system_output(cmd, ignore_status=True).split()) |
| 363 | |
| 364 | # Back to its original value. |
| 365 | if original_value != 'servo_sees_usbkey': |
| 366 | self.set('usb_mux_sel1', original_value) |
| 367 | time.sleep(self.USB_DETECTION_DELAY) |
| 368 | |
| 369 | diff_set = has_usb_set - no_usb_set |
| 370 | if len(diff_set) == 1: |
| 371 | return diff_set.pop() |
| 372 | else: |
| 373 | return None |
| 374 | |
| 375 | |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 376 | def install_recovery_image(self, image_path=None, |
| 377 | wait_timeout=RECOVERY_INSTALL_DELAY, |
| 378 | make_image_noninteractive=False, |
| 379 | host=None): |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 380 | """Install the recovery image specied by the path onto the DUT. |
| 381 | |
| 382 | This method uses google recovery mode to install a recovery image |
| 383 | 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] | 384 | board specified by the usb_dev. If no image path is specified |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 385 | we use the recovery image already on the usb image. |
| 386 | |
| 387 | Args: |
| 388 | image_path: Path on the host to the recovery image. |
Gilad Arnold | 9df73de | 2012-03-14 09:35:08 -0700 | [diff] [blame] | 389 | wait_timeout: How long to wait for completion; default is |
| 390 | determined by a constant. |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 391 | make_image_noninteractive: Make the recovery image noninteractive, |
| 392 | therefore the DUT will reboot |
| 393 | automatically after installation. |
| 394 | host: Host object for the DUT that the installation process is |
| 395 | running on. If provided, will wait to see if the host is back |
| 396 | up after starting recovery mode. |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 397 | """ |
Gilad Arnold | 9df73de | 2012-03-14 09:35:08 -0700 | [diff] [blame] | 398 | # Turn the device off. This should happen before USB key detection, to |
| 399 | # prevent a recovery destined DUT from sensing the USB key due to the |
| 400 | # autodetection procedure. |
| 401 | self.power_long_press() |
| 402 | |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 403 | # Set up Servo's usb mux. |
| 404 | self.set('prtctl4_pwren', 'on') |
| 405 | self.enable_usb_hub(host=True) |
Tom Wai-Hong Tam | a07115e | 2012-01-09 12:27:01 +0800 | [diff] [blame] | 406 | if image_path: |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 407 | logging.info('Searching for usb device') |
| 408 | if not self._server.download_image_to_usb(image_path): |
| 409 | logging.error('Failed to transfer requested image to USB. ' |
| 410 | 'Please take a look at Servo Logs.') |
| 411 | raise error.AutotestError('Download image to usb failed.') |
| 412 | if make_image_noninteractive: |
| 413 | logging.info('Making image noninteractive') |
| 414 | if not self._server.make_image_noninteractive(): |
| 415 | logging.error('Failed to make image noninteractive. ' |
| 416 | 'Please take a look at Servo Logs.') |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 417 | |
| 418 | # Boot in recovery mode. |
| 419 | try: |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 420 | self.enable_recovery_mode() |
Tom Wai-Hong Tam | 2386910 | 2012-01-17 15:41:30 +0800 | [diff] [blame] | 421 | self.power_short_press() |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 422 | time.sleep(Servo.RECOVERY_BOOT_DELAY) |
Tom Wai-Hong Tam | 922ed05 | 2012-01-09 12:27:52 +0800 | [diff] [blame] | 423 | self.set('usb_mux_sel1', 'dut_sees_usbkey') |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 424 | self.disable_recovery_mode() |
| 425 | |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 426 | if host: |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 427 | logging.info('Running the recovery process on the DUT. ' |
Simran Basi | 741b5d4 | 2012-05-18 11:27:15 -0700 | [diff] [blame] | 428 | 'Will wait up to %d seconds for recovery to ' |
| 429 | 'complete.', wait_timeout) |
| 430 | start_time = time.time() |
| 431 | # Wait for the host to come up. |
| 432 | if host.wait_up(timeout=wait_timeout): |
| 433 | logging.info('Recovery process completed successfully in ' |
| 434 | '%d seconds.', time.time() - start_time) |
| 435 | else: |
| 436 | logger.error('Host failed to come back up in the allotted ' |
| 437 | 'time: %d seconds.', wait_timeout) |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 438 | logging.info('Removing the usb key from the DUT.') |
| 439 | self.disable_usb_hub() |
Jon Salz | c88e5b6 | 2011-11-30 14:38:54 +0800 | [diff] [blame] | 440 | except: |
| 441 | # In case anything went wrong we want to make sure to do a clean |
| 442 | # reset. |
| 443 | self.disable_recovery_mode() |
| 444 | self.warm_reset() |
| 445 | raise |
| 446 | |
| 447 | |
Craig Harrison | 6b36b12 | 2011-06-28 17:58:43 -0700 | [diff] [blame] | 448 | def _init_seq_cold_reset_devmode(self): |
| 449 | """Cold reset, init device, and boot in dev-mode.""" |
| 450 | self.cold_reset() |
| 451 | self._init_seq() |
| 452 | self.set('dev_mode', 'on') |
| 453 | self.boot_devmode() |
| 454 | |
| 455 | |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 456 | def _init_seq(self): |
| 457 | """Initiate starting state for servo.""" |
Todd Broch | 9753bd4 | 2012-03-21 10:15:08 -0700 | [diff] [blame] | 458 | # TODO(tbroch) This is only a servo V1 control. Need to add ability in |
| 459 | # servod to easily identify version so I can make this conditional not |
| 460 | # try and fail quietly |
| 461 | try: |
| 462 | self.set('tx_dir', 'input') |
| 463 | except: |
| 464 | logging.warning("Failed to set tx_dir. This is ok if not servo V1") |
| 465 | |
| 466 | |
Todd Broch | 6ec2943 | 2011-12-19 14:32:02 -0800 | [diff] [blame] | 467 | # TODO(tbroch) Investigate method to determine DUT's type so we can |
| 468 | # conditionally set lid if applicable |
| 469 | self.set_nocheck('lid_open', 'yes') |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 470 | self.set('rec_mode', 'off') |
| 471 | |
| 472 | |
Todd Broch | f24d278 | 2011-08-19 10:55:41 -0700 | [diff] [blame] | 473 | def _connect_servod(self, servo_host, servo_port): |
Craig Harrison | 2b6c6fc | 2011-06-23 10:34:02 -0700 | [diff] [blame] | 474 | """Connect to the Servod process with XMLRPC. |
| 475 | |
| 476 | Args: |
| 477 | servo_port: Port the Servod process is listening on. |
| 478 | """ |
Todd Broch | f24d278 | 2011-08-19 10:55:41 -0700 | [diff] [blame] | 479 | remote = 'http://%s:%s' % (servo_host, servo_port) |
Todd Broch | 96d83aa | 2011-08-29 14:37:38 -0700 | [diff] [blame] | 480 | self._server = xmlrpclib.ServerProxy(remote) |
Todd Broch | f24d278 | 2011-08-19 10:55:41 -0700 | [diff] [blame] | 481 | try: |
| 482 | self._server.echo("ping-test") |
Todd Broch | 96d83aa | 2011-08-29 14:37:38 -0700 | [diff] [blame] | 483 | except: |
| 484 | logging.error('Connection to servod failed') |
Todd Broch | f24d278 | 2011-08-19 10:55:41 -0700 | [diff] [blame] | 485 | raise |