1# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5import logging
6
7from autotest_lib.client.common_lib import error
8from autotest_lib.server.cros.faft.firmware_test import FirmwareTest
9
10
11class firmware_DevBootUSB(FirmwareTest):
12    """
13    Servo based Ctrl-U developer USB boot test.
14
15    This test requires a USB disk plugged-in, which contains a Chrome OS test
16    image (built by "build_image test"). On runtime, this test first switches
17    DUT to developer mode. When dev_boot_usb=0, pressing Ctrl-U on developer
18    screen should not boot the USB disk. When dev_boot_usb=1, pressing Ctrl-U
19    should boot the USB disk.
20    """
21    version = 1
22    NEEDS_SERVO_USB = True
23
24    def initialize(self, host, cmdline_args, ec_wp=None):
25        """Initialize the test"""
26        super(firmware_DevBootUSB, self).initialize(host, cmdline_args,
27                                                    ec_wp=ec_wp)
28        self.switcher.setup_mode('dev')
29        # Use the USB key for Ctrl-U dev boot, not recovery.
30        self.setup_usbkey(usbkey=True, host=False, used_for_recovery=False)
31
32        self.original_dev_boot_usb = self.faft_client.system.get_dev_boot_usb()
33        logging.info('Original dev_boot_usb value: %s',
34                     str(self.original_dev_boot_usb))
35
36    def cleanup(self):
37        """Cleanup the test"""
38        try:
39            self.ensure_dev_internal_boot(self.original_dev_boot_usb)
40        except Exception as e:
41            logging.error("Caught exception: %s", str(e))
42        super(firmware_DevBootUSB, self).cleanup()
43
44    def run_once(self):
45        """Main test logic"""
46        if (self.faft_config.has_keyboard and
47                not self.check_ec_capability(['keyboard'])):
48            raise error.TestNAError("TEST IT MANUALLY! This test can't be "
49                                    "automated on non-Chrome-EC devices.")
50
51        logging.info("Expected developer mode, set dev_boot_usb to 0.")
52        self.check_state((self.checkers.dev_boot_usb_checker, False))
53        self.faft_client.system.set_dev_boot_usb(0)
54        self.switcher.mode_aware_reboot()
55
56        logging.info("Expected internal disk boot, set dev_boot_usb to 1.")
57        self.check_state((self.checkers.dev_boot_usb_checker,
58                          False,
59                          "Not internal disk boot, dev_boot_usb misbehaved"))
60        self.faft_client.system.set_dev_boot_usb(1)
61        self.switcher.simple_reboot()
62        self.switcher.bypass_dev_boot_usb()
63        self.switcher.wait_for_client()
64
65        logging.info("Expected USB boot, set dev_boot_usb to the original.")
66        self.check_state((self.checkers.dev_boot_usb_checker, (True, True),
67                          'Device not booted from USB image properly.'))
68        self.faft_client.system.set_dev_boot_usb(self.original_dev_boot_usb)
69        self.switcher.mode_aware_reboot()
70
71        logging.info("Check and done.")
72        self.check_state((self.checkers.dev_boot_usb_checker, False))
73