Yusuf Mohsinally | f466422 | 2013-08-14 12:59:16 -0700 | [diff] [blame] | 1 | # Copyright (c) 2013 The Chromium OS Authors. All rights reserved. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -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 | |
Yusuf Mohsinally | f466422 | 2013-08-14 12:59:16 -0700 | [diff] [blame] | 5 | """Code to provide functions for FAFT tests. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 6 | |
Yusuf Mohsinally | f466422 | 2013-08-14 12:59:16 -0700 | [diff] [blame] | 7 | These can be exposed via a xmlrpci server running on the DUT. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 8 | """ |
| 9 | |
danny chan | 6dc580a | 2015-08-08 00:14:02 +0000 | [diff] [blame] | 10 | import functools, os, shutil, tempfile |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 11 | |
Yusuf Mohsinally | cd108da | 2013-08-12 14:06:12 -0700 | [diff] [blame] | 12 | import common |
Tom Wai-Hong Tam | 533eed7 | 2015-07-31 07:37:27 +0800 | [diff] [blame^] | 13 | from autotest_lib.client.cros.faft.utils import (cgpt_handler, |
Yusuf Mohsinally | cd108da | 2013-08-12 14:06:12 -0700 | [diff] [blame] | 14 | chromeos_interface, |
David Sodman | 3ad5164 | 2015-01-22 11:15:33 -0800 | [diff] [blame] | 15 | firmware_check_keys, |
Yusuf Mohsinally | cd108da | 2013-08-12 14:06:12 -0700 | [diff] [blame] | 16 | firmware_updater, |
| 17 | flashrom_handler, |
| 18 | kernel_handler, |
Vic (Chun-Ju) Yang | 4edbc07 | 2014-02-11 14:40:57 +0800 | [diff] [blame] | 19 | rootfs_handler, |
Yusuf Mohsinally | cd108da | 2013-08-12 14:06:12 -0700 | [diff] [blame] | 20 | saft_flashrom_util, |
| 21 | tpm_handler, |
| 22 | ) |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 23 | |
| 24 | |
Tom Wai-Hong Tam | 0e680af | 2011-10-26 14:32:55 +0800 | [diff] [blame] | 25 | def allow_multiple_section_input(image_operator): |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 26 | """Decorate a method to support multiple sections. |
| 27 | |
| 28 | @param image_operator: Method accepting one section as its argument. |
| 29 | """ |
Tom Wai-Hong Tam | 0e680af | 2011-10-26 14:32:55 +0800 | [diff] [blame] | 30 | @functools.wraps(image_operator) |
| 31 | def wrapper(self, section): |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 32 | """Wrapper method to support multiple sections. |
| 33 | |
| 34 | @param section: A list of sections of just a section. |
| 35 | """ |
Tom Wai-Hong Tam | 0e680af | 2011-10-26 14:32:55 +0800 | [diff] [blame] | 36 | if type(section) in (tuple, list): |
| 37 | for sec in section: |
| 38 | image_operator(self, sec) |
| 39 | else: |
| 40 | image_operator(self, section) |
| 41 | return wrapper |
| 42 | |
| 43 | |
Vic Yang | 13d22ec | 2012-06-18 15:12:47 +0800 | [diff] [blame] | 44 | class LazyFlashromHandlerProxy: |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 45 | """Proxy of FlashromHandler for lazy initialization.""" |
Vic Yang | 13d22ec | 2012-06-18 15:12:47 +0800 | [diff] [blame] | 46 | _loaded = False |
| 47 | _obj = None |
| 48 | |
| 49 | def __init__(self, *args, **kargs): |
| 50 | self._args = args |
| 51 | self._kargs = kargs |
| 52 | |
| 53 | def _load(self): |
| 54 | self._obj = flashrom_handler.FlashromHandler() |
| 55 | self._obj.init(*self._args, **self._kargs) |
| 56 | self._obj.new_image() |
| 57 | self._loaded = True |
| 58 | |
| 59 | def __getattr__(self, name): |
| 60 | if not self._loaded: |
| 61 | self._load() |
| 62 | return getattr(self._obj, name) |
| 63 | |
Tom Wai-Hong Tam | c1c4deb | 2012-07-26 14:28:11 +0800 | [diff] [blame] | 64 | def reload(self): |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 65 | """Reload the FlashromHandler class.""" |
Tom Wai-Hong Tam | c1c4deb | 2012-07-26 14:28:11 +0800 | [diff] [blame] | 66 | self._loaded = False |
| 67 | |
Vic Yang | 13d22ec | 2012-06-18 15:12:47 +0800 | [diff] [blame] | 68 | |
Yusuf Mohsinally | f466422 | 2013-08-14 12:59:16 -0700 | [diff] [blame] | 69 | class RPCFunctions(object): |
| 70 | """A class which aggregates some useful functions for firmware testing. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 71 | |
| 72 | This class can be exposed via a XMLRPC server such that its functions can |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 73 | be accessed remotely. Method naming should fit the naming rule |
| 74 | '_[categories]_[method_name]' where categories contains system, ec, bios, |
| 75 | kernel, cgpt, tpm, updater, etc. Methods should be called by |
| 76 | 'FAFTClient.[categories].[method_name]', because _dispatch will rename |
| 77 | this name to '_[categories]_[method_name]'. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 78 | |
| 79 | Attributes: |
| 80 | _chromeos_interface: An object to encapsulate OS services functions. |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 81 | _bios_handler: An object to automate BIOS flashrom testing. |
| 82 | _ec_handler: An object to automate EC flashrom testing. |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 83 | _ec_image: An object to automate EC image for autest. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 84 | _kernel_handler: An object to provide kernel related actions. |
Tom Wai-Hong Tam | 48ae221 | 2013-06-26 10:37:40 +0800 | [diff] [blame] | 85 | _log_file: Path of the log file. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 86 | _tpm_handler: An object to control TPM device. |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 87 | _updater: An object to update firmware. |
ctchang | c7e55ea | 2012-08-09 16:19:14 +0800 | [diff] [blame] | 88 | _temp_path: Path of a temp directory. |
| 89 | _keys_path: Path of a directory, keys/, in temp directory. |
| 90 | _work_path: Path of a directory, work/, in temp directory. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 91 | """ |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 92 | def __init__(self): |
| 93 | """Initialize the data attributes of this class.""" |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 94 | # TODO(waihong): Move the explicit object.init() methods to the |
| 95 | # objects' constructors (ChromeOSInterface, FlashromHandler, |
| 96 | # KernelHandler, and TpmHandler). |
danny chan | 6dc580a | 2015-08-08 00:14:02 +0000 | [diff] [blame] | 97 | self._chromeos_interface = chromeos_interface.ChromeOSInterface(False) |
Tom Wai-Hong Tam | 4895883 | 2011-12-30 10:16:57 +0800 | [diff] [blame] | 98 | # We keep the state of FAFT test in a permanent directory over reboots. |
Tom Wai-Hong Tam | 07278c2 | 2012-02-08 16:53:00 +0800 | [diff] [blame] | 99 | state_dir = '/var/tmp/faft' |
Tom Wai-Hong Tam | 6db59cb | 2015-07-21 08:11:23 +0800 | [diff] [blame] | 100 | self._log_file = os.path.join(state_dir, 'faft_client.log') |
danny chan | 6dc580a | 2015-08-08 00:14:02 +0000 | [diff] [blame] | 101 | self._chromeos_interface.init(state_dir, log_file=self._log_file) |
| 102 | os.chdir(state_dir) |
Tom Wai-Hong Tam | 6db59cb | 2015-07-21 08:11:23 +0800 | [diff] [blame] | 103 | |
Vic Yang | 13d22ec | 2012-06-18 15:12:47 +0800 | [diff] [blame] | 104 | self._bios_handler = LazyFlashromHandlerProxy( |
| 105 | saft_flashrom_util, |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 106 | self._chromeos_interface, |
| 107 | None, |
| 108 | '/usr/share/vboot/devkeys', |
| 109 | 'bios') |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 110 | |
Todd Broch | f2b1d01 | 2012-06-14 12:55:21 -0700 | [diff] [blame] | 111 | self._ec_handler = None |
| 112 | if not os.system("mosys ec info"): |
Vic Yang | 13d22ec | 2012-06-18 15:12:47 +0800 | [diff] [blame] | 113 | self._ec_handler = LazyFlashromHandlerProxy( |
| 114 | saft_flashrom_util, |
Todd Broch | f2b1d01 | 2012-06-14 12:55:21 -0700 | [diff] [blame] | 115 | self._chromeos_interface, |
Vic Yang | 13d22ec | 2012-06-18 15:12:47 +0800 | [diff] [blame] | 116 | 'ec_root_key.vpubk', |
Todd Broch | f2b1d01 | 2012-06-14 12:55:21 -0700 | [diff] [blame] | 117 | '/usr/share/vboot/devkeys', |
| 118 | 'ec') |
Todd Broch | f2b1d01 | 2012-06-14 12:55:21 -0700 | [diff] [blame] | 119 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 120 | self._ec_image = None |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 121 | |
| 122 | self._kernel_handler = kernel_handler.KernelHandler() |
Tom Wai-Hong Tam | 07278c2 | 2012-02-08 16:53:00 +0800 | [diff] [blame] | 123 | # TODO(waihong): The dev_key_path is a new argument. We do that in |
| 124 | # order not to break the old image and still be able to run. |
| 125 | try: |
| 126 | self._kernel_handler.init(self._chromeos_interface, |
ctchang | d60030f | 2012-08-29 15:39:56 +0800 | [diff] [blame] | 127 | dev_key_path='/usr/share/vboot/devkeys', |
| 128 | internal_disk=True) |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 129 | except TypeError: |
Tom Wai-Hong Tam | 07278c2 | 2012-02-08 16:53:00 +0800 | [diff] [blame] | 130 | # Copy the key to the current working directory. |
| 131 | shutil.copy('/usr/share/vboot/devkeys/kernel_data_key.vbprivk', '.') |
ctchang | d60030f | 2012-08-29 15:39:56 +0800 | [diff] [blame] | 132 | self._kernel_handler.init(self._chromeos_interface, |
| 133 | internal_disk=True) |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 134 | |
| 135 | self._tpm_handler = tpm_handler.TpmHandler() |
| 136 | self._tpm_handler.init(self._chromeos_interface) |
| 137 | |
Vic (Chun-Ju) Yang | 9393284 | 2014-02-07 20:01:28 +0800 | [diff] [blame] | 138 | self._cgpt_handler = cgpt_handler.CgptHandler(self._chromeos_interface) |
Tom Wai-Hong Tam | 4895883 | 2011-12-30 10:16:57 +0800 | [diff] [blame] | 139 | |
Vic (Chun-Ju) Yang | 4edbc07 | 2014-02-11 14:40:57 +0800 | [diff] [blame] | 140 | self._rootfs_handler = rootfs_handler.RootfsHandler() |
| 141 | self._rootfs_handler.init(self._chromeos_interface) |
| 142 | |
Yusuf Mohsinally | cd108da | 2013-08-12 14:06:12 -0700 | [diff] [blame] | 143 | self._updater = firmware_updater.FirmwareUpdater(self._chromeos_interface) |
David Sodman | 3ad5164 | 2015-01-22 11:15:33 -0800 | [diff] [blame] | 144 | self._check_keys = firmware_check_keys.firmwareCheckKeys() |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 145 | |
ctchang | c7e55ea | 2012-08-09 16:19:14 +0800 | [diff] [blame] | 146 | # Initialize temporary directory path |
| 147 | self._temp_path = '/var/tmp/faft/autest' |
| 148 | self._keys_path = os.path.join(self._temp_path, 'keys') |
| 149 | self._work_path = os.path.join(self._temp_path, 'work') |
| 150 | |
Tom Wai-Hong Tam | e8f291a | 2011-12-08 22:03:53 +0800 | [diff] [blame] | 151 | def _dispatch(self, method, params): |
| 152 | """This _dispatch method handles string conversion especially. |
| 153 | |
| 154 | Since we turn off allow_dotted_names option. So any string conversion, |
| 155 | like str(FAFTClient.method), i.e. FAFTClient.method.__str__, failed |
| 156 | via XML RPC call. |
| 157 | """ |
| 158 | is_str = method.endswith('.__str__') |
| 159 | if is_str: |
| 160 | method = method.rsplit('.', 1)[0] |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 161 | |
| 162 | categories = ('system', 'bios', 'ec', 'kernel', |
Vic (Chun-Ju) Yang | 4edbc07 | 2014-02-11 14:40:57 +0800 | [diff] [blame] | 163 | 'tpm', 'cgpt', 'updater', 'rootfs') |
Tom Wai-Hong Tam | e8f291a | 2011-12-08 22:03:53 +0800 | [diff] [blame] | 164 | try: |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 165 | if method.split('.', 1)[0] in categories: |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 166 | func = getattr(self, '_%s_%s' % (method.split('.', 1)[0], |
| 167 | method.split('.', 1)[1])) |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 168 | else: |
| 169 | func = getattr(self, method) |
Tom Wai-Hong Tam | e8f291a | 2011-12-08 22:03:53 +0800 | [diff] [blame] | 170 | except AttributeError: |
| 171 | raise Exception('method "%s" is not supported' % method) |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 172 | |
| 173 | if is_str: |
| 174 | return str(func) |
Tom Wai-Hong Tam | e8f291a | 2011-12-08 22:03:53 +0800 | [diff] [blame] | 175 | else: |
danny chan | 6dc580a | 2015-08-08 00:14:02 +0000 | [diff] [blame] | 176 | self._chromeos_interface.log('Dispatching method %s with args %s' % |
| 177 | (str(func), str(params))) |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 178 | return func(*params) |
Tom Wai-Hong Tam | e8f291a | 2011-12-08 22:03:53 +0800 | [diff] [blame] | 179 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 180 | def _system_is_available(self): |
Tom Wai-Hong Tam | bea57b3 | 2011-09-02 18:27:47 +0800 | [diff] [blame] | 181 | """Function for polling the RPC server availability. |
| 182 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 183 | @return: Always True. |
Tom Wai-Hong Tam | bea57b3 | 2011-09-02 18:27:47 +0800 | [diff] [blame] | 184 | """ |
| 185 | return True |
| 186 | |
Tom Wai-Hong Tam | 48ae221 | 2013-06-26 10:37:40 +0800 | [diff] [blame] | 187 | def _system_dump_log(self, remove_log=False): |
| 188 | """Dump the log file. |
| 189 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 190 | @param remove_log: Remove the log file after dump. |
| 191 | @return: String of the log file content. |
Tom Wai-Hong Tam | 48ae221 | 2013-06-26 10:37:40 +0800 | [diff] [blame] | 192 | """ |
| 193 | log = open(self._log_file).read() |
| 194 | if remove_log: |
| 195 | os.remove(self._log_file) |
| 196 | return log |
| 197 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 198 | def _system_run_shell_command(self, command): |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 199 | """Run shell command. |
| 200 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 201 | @param command: A shell command to be run. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 202 | """ |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 203 | self._chromeos_interface.run_shell_command(command) |
| 204 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 205 | def _system_run_shell_command_get_output(self, command): |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 206 | """Run shell command and get its console output. |
| 207 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 208 | @param command: A shell command to be run. |
| 209 | @return: A list of strings stripped of the newline characters. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 210 | """ |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 211 | return self._chromeos_interface.run_shell_command_get_output(command) |
| 212 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 213 | def _system_software_reboot(self): |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 214 | """Request software reboot.""" |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 215 | self._chromeos_interface.run_shell_command('reboot') |
| 216 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 217 | def _system_get_platform_name(self): |
Tom Wai-Hong Tam | 678ab15 | 2011-12-14 15:27:24 +0800 | [diff] [blame] | 218 | """Get the platform name of the current system. |
| 219 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 220 | @return: A string of the platform name. |
Tom Wai-Hong Tam | 678ab15 | 2011-12-14 15:27:24 +0800 | [diff] [blame] | 221 | """ |
Vic Yang | 2bbb867 | 2012-11-12 12:14:53 +0800 | [diff] [blame] | 222 | # 'mosys platform name' sometimes fails. Let's get the verbose output. |
| 223 | lines = self._chromeos_interface.run_shell_command_get_output( |
| 224 | '(mosys -vvv platform name 2>&1) || echo Failed') |
| 225 | if lines[-1].strip() == 'Failed': |
| 226 | raise Exception('Failed getting platform name: ' + '\n'.join(lines)) |
| 227 | return lines[-1] |
Tom Wai-Hong Tam | 678ab15 | 2011-12-14 15:27:24 +0800 | [diff] [blame] | 228 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 229 | def _system_get_crossystem_value(self, key): |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 230 | """Get crossystem value of the requested key. |
| 231 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 232 | @param key: A crossystem key. |
| 233 | @return: A string of the requested crossystem value. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 234 | """ |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 235 | return self._chromeos_interface.run_shell_command_get_output( |
| 236 | 'crossystem %s' % key)[0] |
| 237 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 238 | def _system_get_root_dev(self): |
Tom Wai-Hong Tam | cfda61f | 2011-11-02 17:41:01 +0800 | [diff] [blame] | 239 | """Get the name of root device without partition number. |
| 240 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 241 | @return: A string of the root device without partition number. |
Tom Wai-Hong Tam | cfda61f | 2011-11-02 17:41:01 +0800 | [diff] [blame] | 242 | """ |
Tom Wai-Hong Tam | cfda61f | 2011-11-02 17:41:01 +0800 | [diff] [blame] | 243 | return self._chromeos_interface.get_root_dev() |
| 244 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 245 | def _system_get_root_part(self): |
Tom Wai-Hong Tam | cfda61f | 2011-11-02 17:41:01 +0800 | [diff] [blame] | 246 | """Get the name of root device with partition number. |
| 247 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 248 | @return: A string of the root device with partition number. |
Tom Wai-Hong Tam | cfda61f | 2011-11-02 17:41:01 +0800 | [diff] [blame] | 249 | """ |
Tom Wai-Hong Tam | cfda61f | 2011-11-02 17:41:01 +0800 | [diff] [blame] | 250 | return self._chromeos_interface.get_root_part() |
| 251 | |
Shelley Chen | 3edea98 | 2014-12-30 14:54:21 -0800 | [diff] [blame] | 252 | def _system_set_try_fw_b(self, count=1): |
| 253 | """Set 'Try Frimware B' flag in crossystem. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 254 | |
Shelley Chen | 3edea98 | 2014-12-30 14:54:21 -0800 | [diff] [blame] | 255 | @param count: # times to try booting into FW B |
| 256 | """ |
| 257 | self._chromeos_interface.cs.fwb_tries = count |
| 258 | |
| 259 | def _system_set_fw_try_next(self, next, count=0): |
| 260 | """Set fw_try_next to A or B |
| 261 | |
| 262 | @param next: Next FW to reboot to (A or B) |
| 263 | @param count: # of times to try booting into FW <next> |
| 264 | """ |
Daisuke Nojiri | 57c0598 | 2014-06-25 15:28:35 -0700 | [diff] [blame] | 265 | self._chromeos_interface.cs.fw_try_next = next |
Shelley Chen | 3edea98 | 2014-12-30 14:54:21 -0800 | [diff] [blame] | 266 | if count: |
| 267 | self._chromeos_interface.cs.fw_try_count = count |
Daisuke Nojiri | 57c0598 | 2014-06-25 15:28:35 -0700 | [diff] [blame] | 268 | |
| 269 | def _system_get_fw_vboot2(self): |
| 270 | """Get fw_vboot2""" |
Tom Wai-Hong Tam | 94886f9 | 2014-07-10 07:01:43 +0800 | [diff] [blame] | 271 | try: |
| 272 | return self._chromeos_interface.cs.fw_vboot2 == '1' |
| 273 | except chromeos_interface.ChromeOSInterfaceError: |
| 274 | return False |
Daisuke Nojiri | 57c0598 | 2014-06-25 15:28:35 -0700 | [diff] [blame] | 275 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 276 | def _system_request_recovery_boot(self): |
Tom Wai-Hong Tam | 76c7507 | 2011-10-25 18:00:12 +0800 | [diff] [blame] | 277 | """Request running in recovery mode on the restart.""" |
Tom Wai-Hong Tam | 76c7507 | 2011-10-25 18:00:12 +0800 | [diff] [blame] | 278 | self._chromeos_interface.cs.request_recovery() |
| 279 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 280 | def _system_get_dev_boot_usb(self): |
Tom Wai-Hong Tam | 0a7b2be | 2012-10-15 16:44:12 +0800 | [diff] [blame] | 281 | """Get dev_boot_usb value which controls developer mode boot from USB. |
| 282 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 283 | @return: True if enable, False if disable. |
Tom Wai-Hong Tam | 0a7b2be | 2012-10-15 16:44:12 +0800 | [diff] [blame] | 284 | """ |
Tom Wai-Hong Tam | 0a7b2be | 2012-10-15 16:44:12 +0800 | [diff] [blame] | 285 | return self._chromeos_interface.cs.dev_boot_usb == '1' |
| 286 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 287 | def _system_set_dev_boot_usb(self, value): |
Tom Wai-Hong Tam | 0a7b2be | 2012-10-15 16:44:12 +0800 | [diff] [blame] | 288 | """Set dev_boot_usb value which controls developer mode boot from USB. |
| 289 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 290 | @param value: True to enable, False to disable. |
Tom Wai-Hong Tam | 0a7b2be | 2012-10-15 16:44:12 +0800 | [diff] [blame] | 291 | """ |
Tom Wai-Hong Tam | 0a7b2be | 2012-10-15 16:44:12 +0800 | [diff] [blame] | 292 | self._chromeos_interface.cs.dev_boot_usb = 1 if value else 0 |
| 293 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 294 | def _system_is_removable_device_boot(self): |
| 295 | """Check the current boot device is removable. |
| 296 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 297 | @return: True: if a removable device boots. |
| 298 | False: if a non-removable device boots. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 299 | """ |
| 300 | root_part = self._chromeos_interface.get_root_part() |
| 301 | return self._chromeos_interface.is_removable_device(root_part) |
| 302 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 303 | def _system_create_temp_dir(self, prefix='backup_'): |
| 304 | """Create a temporary directory and return the path.""" |
| 305 | return tempfile.mkdtemp(prefix=prefix) |
| 306 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 307 | def _bios_reload(self): |
| 308 | """Reload the firmware image that may be changed.""" |
| 309 | self._bios_handler.reload() |
| 310 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 311 | def _bios_get_gbb_flags(self): |
Tom Wai-Hong Tam | 8c9eed6 | 2011-12-28 15:05:05 +0800 | [diff] [blame] | 312 | """Get the GBB flags. |
| 313 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 314 | @return: An integer of the GBB flags. |
Tom Wai-Hong Tam | 8c9eed6 | 2011-12-28 15:05:05 +0800 | [diff] [blame] | 315 | """ |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 316 | return self._bios_handler.get_gbb_flags() |
Tom Wai-Hong Tam | 8c9eed6 | 2011-12-28 15:05:05 +0800 | [diff] [blame] | 317 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 318 | def _bios_get_preamble_flags(self, section): |
Tom Wai-Hong Tam | 81f7000 | 2011-12-13 12:29:46 +0800 | [diff] [blame] | 319 | """Get the preamble flags of a firmware section. |
| 320 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 321 | @param section: A firmware section, either 'a' or 'b'. |
| 322 | @return: An integer of the preamble flags. |
Tom Wai-Hong Tam | 81f7000 | 2011-12-13 12:29:46 +0800 | [diff] [blame] | 323 | """ |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 324 | return self._bios_handler.get_section_flags(section) |
| 325 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 326 | def _bios_set_preamble_flags(self, section, flags): |
Vic Yang | 91b73cf | 2012-07-31 17:18:11 +0800 | [diff] [blame] | 327 | """Set the preamble flags of a firmware section. |
| 328 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 329 | @param section: A firmware section, either 'a' or 'b'. |
| 330 | @param flags: An integer of preamble flags. |
Vic Yang | 91b73cf | 2012-07-31 17:18:11 +0800 | [diff] [blame] | 331 | """ |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 332 | version = self._bios_get_version(section) |
Vic Yang | 91b73cf | 2012-07-31 17:18:11 +0800 | [diff] [blame] | 333 | self._bios_handler.set_section_version(section, version, flags, |
| 334 | write_through=True) |
| 335 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 336 | def _bios_get_body_sha(self, section): |
Tom Wai-Hong Tam | 4e10b9f | 2012-09-06 16:23:02 +0800 | [diff] [blame] | 337 | """Get SHA1 hash of BIOS RW firmware section. |
| 338 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 339 | @param section: A firmware section, either 'a' or 'b'. |
| 340 | @param flags: An integer of preamble flags. |
Tom Wai-Hong Tam | 4e10b9f | 2012-09-06 16:23:02 +0800 | [diff] [blame] | 341 | """ |
| 342 | return self._bios_handler.get_section_sha(section) |
| 343 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 344 | def _bios_get_sig_sha(self, section): |
ctchang | 38ae492 | 2012-09-03 17:01:16 +0800 | [diff] [blame] | 345 | """Get SHA1 hash of firmware vblock in section.""" |
| 346 | return self._bios_handler.get_section_sig_sha(section) |
| 347 | |
Tom Wai-Hong Tam | 0e680af | 2011-10-26 14:32:55 +0800 | [diff] [blame] | 348 | @allow_multiple_section_input |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 349 | def _bios_corrupt_sig(self, section): |
Tom Wai-Hong Tam | 9aea821 | 2011-12-12 15:08:45 +0800 | [diff] [blame] | 350 | """Corrupt the requested firmware section signature. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 351 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 352 | @param section: A firmware section, either 'a' or 'b'. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 353 | """ |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 354 | self._bios_handler.corrupt_firmware(section) |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 355 | |
Tom Wai-Hong Tam | 0e680af | 2011-10-26 14:32:55 +0800 | [diff] [blame] | 356 | @allow_multiple_section_input |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 357 | def _bios_restore_sig(self, section): |
Tom Wai-Hong Tam | 9aea821 | 2011-12-12 15:08:45 +0800 | [diff] [blame] | 358 | """Restore the previously corrupted firmware section signature. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 359 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 360 | @param section: A firmware section, either 'a' or 'b'. |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 361 | """ |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 362 | self._bios_handler.restore_firmware(section) |
Tom Wai-Hong Tam | b8a58ef | 2011-10-11 23:53:10 -0700 | [diff] [blame] | 363 | |
Tom Wai-Hong Tam | cfda61f | 2011-11-02 17:41:01 +0800 | [diff] [blame] | 364 | @allow_multiple_section_input |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 365 | def _bios_corrupt_body(self, section): |
| 366 | """Corrupt the requested firmware section body. |
| 367 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 368 | @param section: A firmware section, either 'a' or 'b'. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 369 | """ |
| 370 | self._bios_handler.corrupt_firmware_body(section) |
| 371 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 372 | @allow_multiple_section_input |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 373 | def _bios_restore_body(self, section): |
Tom Wai-Hong Tam | 81f7000 | 2011-12-13 12:29:46 +0800 | [diff] [blame] | 374 | """Restore the previously corrupted firmware section body. |
| 375 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 376 | @param section: A firmware section, either 'a' or 'b'. |
Tom Wai-Hong Tam | 81f7000 | 2011-12-13 12:29:46 +0800 | [diff] [blame] | 377 | """ |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 378 | self._bios_handler.restore_firmware_body(section) |
Tom Wai-Hong Tam | 81f7000 | 2011-12-13 12:29:46 +0800 | [diff] [blame] | 379 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 380 | def __bios_modify_version(self, section, delta): |
Tom Wai-Hong Tam | 46d03b1 | 2012-02-08 12:02:17 +0800 | [diff] [blame] | 381 | """Modify firmware version for the requested section, by adding delta. |
| 382 | |
| 383 | The passed in delta, a positive or a negative number, is added to the |
| 384 | original firmware version. |
| 385 | """ |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 386 | original_version = self._bios_get_version(section) |
Tom Wai-Hong Tam | 46d03b1 | 2012-02-08 12:02:17 +0800 | [diff] [blame] | 387 | new_version = original_version + delta |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 388 | flags = self._bios_handler.get_section_flags(section) |
danny chan | 6dc580a | 2015-08-08 00:14:02 +0000 | [diff] [blame] | 389 | self._chromeos_interface.log( |
| 390 | 'Setting firmware section %s version from %d to %d' % ( |
| 391 | section, original_version, new_version)) |
Vic Yang | 59cac9c | 2012-05-21 15:28:42 +0800 | [diff] [blame] | 392 | self._bios_handler.set_section_version(section, new_version, flags, |
| 393 | write_through=True) |
Tom Wai-Hong Tam | 46d03b1 | 2012-02-08 12:02:17 +0800 | [diff] [blame] | 394 | |
| 395 | @allow_multiple_section_input |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 396 | def _bios_move_version_backward(self, section): |
Tom Wai-Hong Tam | 46d03b1 | 2012-02-08 12:02:17 +0800 | [diff] [blame] | 397 | """Decrement firmware version for the requested section.""" |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 398 | self.__bios_modify_version(section, -1) |
Tom Wai-Hong Tam | 46d03b1 | 2012-02-08 12:02:17 +0800 | [diff] [blame] | 399 | |
Tom Wai-Hong Tam | 46d03b1 | 2012-02-08 12:02:17 +0800 | [diff] [blame] | 400 | @allow_multiple_section_input |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 401 | def _bios_move_version_forward(self, section): |
Tom Wai-Hong Tam | 46d03b1 | 2012-02-08 12:02:17 +0800 | [diff] [blame] | 402 | """Increase firmware version for the requested section.""" |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 403 | self.__bios_modify_version(section, 1) |
Tom Wai-Hong Tam | 46d03b1 | 2012-02-08 12:02:17 +0800 | [diff] [blame] | 404 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 405 | def _bios_get_version(self, section): |
| 406 | """Retrieve firmware version of a section.""" |
| 407 | return self._bios_handler.get_section_version(section) |
| 408 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 409 | def _bios_get_datakey_version(self, section): |
ctchang | c7e55ea | 2012-08-09 16:19:14 +0800 | [diff] [blame] | 410 | """Return firmware data key version.""" |
| 411 | return self._bios_handler.get_section_datakey_version(section) |
| 412 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 413 | def _bios_get_kernel_subkey_version(self, section): |
ctchang | c7e55ea | 2012-08-09 16:19:14 +0800 | [diff] [blame] | 414 | """Return kernel subkey version.""" |
| 415 | return self._bios_handler.get_section_kernel_subkey_version(section) |
Tom Wai-Hong Tam | 46d03b1 | 2012-02-08 12:02:17 +0800 | [diff] [blame] | 416 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 417 | def _bios_setup_EC_image(self, ec_path): |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 418 | """Setup the new EC image for later update. |
| 419 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 420 | @param ec_path: The path of the EC image to be updated. |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 421 | """ |
| 422 | self._ec_image = flashrom_handler.FlashromHandler() |
| 423 | self._ec_image.init(saft_flashrom_util, |
| 424 | self._chromeos_interface, |
| 425 | 'ec_root_key.vpubk', |
| 426 | '/usr/share/vboot/devkeys', |
| 427 | 'ec') |
| 428 | self._ec_image.new_image(ec_path) |
| 429 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 430 | def _bios_get_EC_image_sha(self): |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 431 | """Get SHA1 hash of RW firmware section of the EC autest image.""" |
| 432 | return self._ec_image.get_section_sha('rw') |
| 433 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 434 | def _bios_update_EC_from_image(self, section, flags): |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 435 | """Update EC via software sync design. |
| 436 | |
| 437 | It copys the RW section from the EC image, which is loaded by calling |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 438 | bios_setup_EC_image(), to the EC area of the specified RW section on the |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 439 | current AP firmware. |
| 440 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 441 | @param section: A firmware section on current BIOS, either 'a' or 'b'. |
| 442 | @param flags: An integer of preamble flags. |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 443 | """ |
| 444 | blob = self._ec_image.get_section_body('rw') |
| 445 | self._bios_handler.set_section_ecbin(section, blob, |
| 446 | write_through=True) |
Chun-ting Chang | 708a276 | 2012-12-10 12:25:13 +0800 | [diff] [blame] | 447 | self._bios_set_preamble_flags(section, flags) |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 448 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 449 | def _bios_dump_whole(self, bios_path): |
Tom Wai-Hong Tam | b63bc74 | 2012-08-30 20:41:30 +0800 | [diff] [blame] | 450 | """Dump the current BIOS firmware to a file, specified by bios_path. |
| 451 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 452 | @param bios_path: The path of the BIOS image to be written. |
Tom Wai-Hong Tam | b63bc74 | 2012-08-30 20:41:30 +0800 | [diff] [blame] | 453 | """ |
| 454 | self._bios_handler.dump_whole(bios_path) |
| 455 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 456 | def _bios_dump_rw(self, dir_path): |
ctchang | 38ae492 | 2012-09-03 17:01:16 +0800 | [diff] [blame] | 457 | """Dump the current BIOS firmware RW to dir_path. |
| 458 | |
| 459 | VBOOTA, VBOOTB, FVMAIN, FVMAINB need to be dumped. |
| 460 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 461 | @param dir_path: The path of directory which contains files to be |
| 462 | written. |
ctchang | 38ae492 | 2012-09-03 17:01:16 +0800 | [diff] [blame] | 463 | """ |
| 464 | if not os.path.isdir(dir_path): |
| 465 | raise Exception("%s doesn't exist" % dir_path) |
| 466 | |
| 467 | VBOOTA_blob = self._bios_handler.get_section_sig('a') |
| 468 | VBOOTB_blob = self._bios_handler.get_section_sig('b') |
| 469 | FVMAIN_blob = self._bios_handler.get_section_body('a') |
| 470 | FVMAINB_blob = self._bios_handler.get_section_body('b') |
| 471 | |
| 472 | open(os.path.join(dir_path, 'VBOOTA'), 'w').write(VBOOTA_blob) |
| 473 | open(os.path.join(dir_path, 'VBOOTB'), 'w').write(VBOOTB_blob) |
| 474 | open(os.path.join(dir_path, 'FVMAIN'), 'w').write(FVMAIN_blob) |
| 475 | open(os.path.join(dir_path, 'FVMAINB'), 'w').write(FVMAINB_blob) |
| 476 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 477 | def _bios_write_whole(self, bios_path): |
Tom Wai-Hong Tam | b63bc74 | 2012-08-30 20:41:30 +0800 | [diff] [blame] | 478 | """Write the firmware from bios_path to the current system. |
| 479 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 480 | @param bios_path: The path of the source BIOS image. |
Tom Wai-Hong Tam | b63bc74 | 2012-08-30 20:41:30 +0800 | [diff] [blame] | 481 | """ |
| 482 | self._bios_handler.new_image(bios_path) |
| 483 | self._bios_handler.write_whole() |
| 484 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 485 | def _bios_write_rw(self, dir_path): |
ctchang | 38ae492 | 2012-09-03 17:01:16 +0800 | [diff] [blame] | 486 | """Write the firmware RW from dir_path to the current system. |
| 487 | |
| 488 | VBOOTA, VBOOTB, FVMAIN, FVMAINB need to be written. |
| 489 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 490 | @param dir_path: The path of directory which contains the source files. |
ctchang | 38ae492 | 2012-09-03 17:01:16 +0800 | [diff] [blame] | 491 | """ |
| 492 | if not os.path.exists(os.path.join(dir_path, 'VBOOTA')) or \ |
| 493 | not os.path.exists(os.path.join(dir_path, 'VBOOTB')) or \ |
| 494 | not os.path.exists(os.path.join(dir_path, 'FVMAIN')) or \ |
| 495 | not os.path.exists(os.path.join(dir_path, 'FVMAINB')): |
| 496 | raise Exception("Source firmware file(s) doesn't exist.") |
| 497 | |
| 498 | VBOOTA_blob = open(os.path.join(dir_path, 'VBOOTA'), 'rb').read() |
| 499 | VBOOTB_blob = open(os.path.join(dir_path, 'VBOOTB'), 'rb').read() |
| 500 | FVMAIN_blob = open(os.path.join(dir_path, 'FVMAIN'), 'rb').read() |
| 501 | FVMAINB_blob = open(os.path.join(dir_path, 'FVMAINB'), 'rb').read() |
| 502 | |
| 503 | self._bios_handler.set_section_sig('a', VBOOTA_blob, |
| 504 | write_through=True) |
| 505 | self._bios_handler.set_section_sig('b', VBOOTB_blob, |
| 506 | write_through=True) |
| 507 | self._bios_handler.set_section_body('a', FVMAIN_blob, |
| 508 | write_through=True) |
| 509 | self._bios_handler.set_section_body('b', FVMAINB_blob, |
| 510 | write_through=True) |
| 511 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 512 | def _ec_get_version(self): |
| 513 | """Get EC version via mosys. |
| 514 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 515 | @return: A string of the EC version. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 516 | """ |
| 517 | return self._chromeos_interface.run_shell_command_get_output( |
| 518 | 'mosys ec info | sed "s/.*| //"')[0] |
| 519 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 520 | def _ec_get_firmware_sha(self): |
| 521 | """Get SHA1 hash of EC RW firmware section.""" |
| 522 | return self._ec_handler.get_section_sha('rw') |
| 523 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 524 | @allow_multiple_section_input |
| 525 | def _ec_corrupt_sig(self, section): |
| 526 | """Corrupt the requested EC section signature. |
| 527 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 528 | @param section: A EC section, either 'a' or 'b'. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 529 | """ |
| 530 | self._ec_handler.corrupt_firmware(section, corrupt_all=True) |
| 531 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 532 | @allow_multiple_section_input |
| 533 | def _ec_restore_sig(self, section): |
| 534 | """Restore the previously corrupted EC section signature. |
| 535 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 536 | @param section: An EC section, either 'a' or 'b'. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 537 | """ |
| 538 | self._ec_handler.restore_firmware(section, restore_all=True) |
| 539 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 540 | @allow_multiple_section_input |
| 541 | def _ec_corrupt_body(self, section): |
| 542 | """Corrupt the requested EC section body. |
| 543 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 544 | @param section: An EC section, either 'a' or 'b'. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 545 | """ |
| 546 | self._ec_handler.corrupt_firmware_body(section, corrupt_all=True) |
| 547 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 548 | @allow_multiple_section_input |
| 549 | def _ec_restore_body(self, section): |
| 550 | """Restore the previously corrupted EC section body. |
| 551 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 552 | @param section: An EC section, either 'a' or 'b'. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 553 | """ |
| 554 | self._ec_handler.restore_firmware_body(section, restore_all=True) |
| 555 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 556 | def _ec_dump_firmware(self, ec_path): |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 557 | """Dump the current EC firmware to a file, specified by ec_path. |
| 558 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 559 | @param ec_path: The path of the EC image to be written. |
Tom Wai-Hong Tam | 23870e0 | 2012-08-24 16:15:34 +0800 | [diff] [blame] | 560 | """ |
| 561 | self._ec_handler.dump_whole(ec_path) |
| 562 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 563 | def _ec_set_write_protect(self, enable): |
Tom Wai-Hong Tam | 44204b3 | 2012-11-20 13:55:40 +0800 | [diff] [blame] | 564 | """Enable write protect of the EC flash chip. |
| 565 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 566 | @param enable: True if activating EC write protect. Otherwise, False. |
Tom Wai-Hong Tam | 44204b3 | 2012-11-20 13:55:40 +0800 | [diff] [blame] | 567 | """ |
Tom Wai-Hong Tam | 44204b3 | 2012-11-20 13:55:40 +0800 | [diff] [blame] | 568 | if enable: |
| 569 | self._ec_handler.enable_write_protect() |
| 570 | else: |
| 571 | self._ec_handler.disable_write_protect() |
| 572 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 573 | @allow_multiple_section_input |
| 574 | def _kernel_corrupt_sig(self, section): |
| 575 | """Corrupt the requested kernel section. |
| 576 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 577 | @param section: A kernel section, either 'a' or 'b'. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 578 | """ |
| 579 | self._kernel_handler.corrupt_kernel(section) |
| 580 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 581 | @allow_multiple_section_input |
| 582 | def _kernel_restore_sig(self, section): |
| 583 | """Restore the requested kernel section (previously corrupted). |
| 584 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 585 | @param section: A kernel section, either 'a' or 'b'. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 586 | """ |
| 587 | self._kernel_handler.restore_kernel(section) |
| 588 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 589 | def __kernel_modify_version(self, section, delta): |
| 590 | """Modify kernel version for the requested section, by adding delta. |
| 591 | |
| 592 | The passed in delta, a positive or a negative number, is added to the |
| 593 | original kernel version. |
| 594 | """ |
| 595 | original_version = self._kernel_handler.get_version(section) |
| 596 | new_version = original_version + delta |
danny chan | 6dc580a | 2015-08-08 00:14:02 +0000 | [diff] [blame] | 597 | self._chromeos_interface.log( |
| 598 | 'Setting kernel section %s version from %d to %d' % ( |
| 599 | section, original_version, new_version)) |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 600 | self._kernel_handler.set_version(section, new_version) |
| 601 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 602 | @allow_multiple_section_input |
| 603 | def _kernel_move_version_backward(self, section): |
| 604 | """Decrement kernel version for the requested section.""" |
| 605 | self.__kernel_modify_version(section, -1) |
| 606 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 607 | @allow_multiple_section_input |
| 608 | def _kernel_move_version_forward(self, section): |
| 609 | """Increase kernel version for the requested section.""" |
| 610 | self.__kernel_modify_version(section, 1) |
| 611 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 612 | def _kernel_get_version(self, section): |
| 613 | """Return kernel version.""" |
| 614 | return self._kernel_handler.get_version(section) |
| 615 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 616 | def _kernel_get_datakey_version(self, section): |
| 617 | """Return kernel datakey version.""" |
| 618 | return self._kernel_handler.get_datakey_version(section) |
| 619 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 620 | def _kernel_diff_a_b(self): |
| 621 | """Compare kernel A with B. |
| 622 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 623 | @return: True: if kernel A is different with B. |
| 624 | False: if kernel A is the same as B. |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 625 | """ |
| 626 | rootdev = self._chromeos_interface.get_root_dev() |
Vic (Chun-Ju) Yang | a1eff6b | 2014-01-28 16:34:03 +0800 | [diff] [blame] | 627 | kernel_a = self._chromeos_interface.join_part(rootdev, '2') |
| 628 | kernel_b = self._chromeos_interface.join_part(rootdev, '4') |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 629 | |
| 630 | # The signature (some kind of hash) for the kernel body is stored in |
| 631 | # the beginning. So compare the first 64KB (including header, preamble, |
| 632 | # and signature) should be enough to check them identical. |
| 633 | header_a = self._chromeos_interface.read_partition(kernel_a, 0x10000) |
| 634 | header_b = self._chromeos_interface.read_partition(kernel_b, 0x10000) |
| 635 | |
| 636 | return header_a != header_b |
| 637 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 638 | def _kernel_resign_with_keys(self, section, key_path=None): |
| 639 | """Resign kernel with temporary key.""" |
| 640 | self._kernel_handler.resign_kernel(section, key_path) |
| 641 | |
Vic (Chun-Ju) Yang | 33ef9e0 | 2014-02-07 14:30:19 +0800 | [diff] [blame] | 642 | def _kernel_dump(self, section, kernel_path): |
| 643 | """Dump the specified kernel to a file. |
| 644 | |
| 645 | @param section: The kernel to dump. May be A or B. |
| 646 | @param kernel_path: The path to the kernel image to be written. |
| 647 | """ |
| 648 | self._kernel_handler.dump_kernel(section, kernel_path) |
| 649 | |
| 650 | def _kernel_write(self, section, kernel_path): |
| 651 | """Write a kernel image to the specified section. |
| 652 | |
| 653 | @param section: The kernel to dump. May be A or B. |
| 654 | @param kernel_path: The path to the kernel image. |
| 655 | """ |
| 656 | self._kernel_handler.write_kernel(section, kernel_path) |
| 657 | |
| 658 | def _kernel_get_sha(self, section): |
| 659 | """Return the SHA1 hash of the specified kernel section.""" |
| 660 | return self._kernel_handler.get_sha(section) |
| 661 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 662 | def _tpm_get_firmware_version(self): |
| 663 | """Retrieve tpm firmware body version.""" |
| 664 | return self._tpm_handler.get_fw_version() |
| 665 | |
Tom Wai-Hong Tam | c1a569f | 2012-12-04 15:07:25 +0800 | [diff] [blame] | 666 | def _tpm_get_firmware_datakey_version(self): |
| 667 | """Retrieve tpm firmware data key version.""" |
| 668 | return self._tpm_handler.get_fw_body_version() |
| 669 | |
Vic (Chun-Ju) Yang | 9393284 | 2014-02-07 20:01:28 +0800 | [diff] [blame] | 670 | def _cgpt_get_attributes(self): |
| 671 | """Get kernel attributes.""" |
| 672 | rootdev = self._system_get_root_dev() |
| 673 | self._cgpt_handler.read_device_info(rootdev) |
| 674 | return {'A': self._cgpt_handler.get_partition(rootdev, 'KERN-A'), |
| 675 | 'B': self._cgpt_handler.get_partition(rootdev, 'KERN-B')} |
| 676 | |
| 677 | def _cgpt_set_attributes(self, attributes): |
| 678 | """Set kernel attributes.""" |
| 679 | rootdev = self._system_get_root_dev() |
| 680 | allowed = ['priority', 'tries', 'successful'] |
| 681 | for p in ('A', 'B'): |
| 682 | if p not in attributes: |
| 683 | continue |
| 684 | attr = dict() |
| 685 | for k in allowed: |
| 686 | if k in attributes[p]: |
| 687 | attr[k] = attributes[p][k] |
| 688 | if attr: |
| 689 | self._cgpt_handler.set_partition(rootdev, 'KERN-%s' % p, attr) |
| 690 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 691 | def _updater_setup(self, shellball=None): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 692 | """Setup the updater. |
| 693 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 694 | @param shellball: Path of provided shellball. Use default shellball |
| 695 | if None, |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 696 | """ |
| 697 | self._updater.setup(self._chromeos_interface, shellball) |
| 698 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 699 | def _updater_cleanup(self): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 700 | self._updater.cleanup_temp_dir() |
| 701 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 702 | def _updater_get_fwid(self): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 703 | """Retrieve shellball's fwid. |
| 704 | |
| 705 | This method should be called after updater_setup. |
| 706 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 707 | @return: Shellball's fwid. |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 708 | """ |
| 709 | return self._updater.retrieve_fwid() |
| 710 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 711 | def _updater_resign_firmware(self, version): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 712 | """Resign firmware with version. |
| 713 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 714 | @param version: new version number. |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 715 | """ |
| 716 | self._updater.resign_firmware(version) |
| 717 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 718 | def _updater_repack_shellball(self, append): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 719 | """Repack shellball with new fwid. |
| 720 | |
Tom Wai-Hong Tam | 144202a | 2013-07-18 13:59:29 +0800 | [diff] [blame] | 721 | @param append: use for new fwid naming. |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 722 | """ |
| 723 | self._updater.repack_shellball(append) |
| 724 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 725 | def _updater_run_autoupdate(self, append): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 726 | """Run chromeos-firmwareupdate with autoupdate mode.""" |
| 727 | options = ['--noupdate_ec', '--nocheck_rw_compatible'] |
| 728 | self._updater.run_firmwareupdate(mode='autoupdate', |
| 729 | updater_append=append, |
| 730 | options=options) |
| 731 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 732 | def _updater_run_factory_install(self): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 733 | """Run chromeos-firmwareupdate with factory_install mode.""" |
| 734 | options = ['--noupdate_ec'] |
| 735 | self._updater.run_firmwareupdate(mode='factory_install', |
| 736 | options=options) |
| 737 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 738 | def _updater_run_bootok(self, append): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 739 | """Run chromeos-firmwareupdate with bootok mode.""" |
| 740 | self._updater.run_firmwareupdate(mode='bootok', |
| 741 | updater_append=append) |
| 742 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 743 | def _updater_run_recovery(self): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 744 | """Run chromeos-firmwareupdate with recovery mode.""" |
| 745 | options = ['--noupdate_ec', '--nocheck_rw_compatible'] |
| 746 | self._updater.run_firmwareupdate(mode='recovery', |
| 747 | options=options) |
| 748 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 749 | def _updater_get_temp_path(self): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 750 | """Get updater's temp directory path.""" |
| 751 | return self._updater.get_temp_path() |
| 752 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 753 | def _updater_get_keys_path(self): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 754 | """Get updater's keys directory path.""" |
| 755 | return self._updater.get_keys_path() |
| 756 | |
Chun-ting Chang | d43aa9b | 2012-11-16 10:12:05 +0800 | [diff] [blame] | 757 | def _updater_get_work_path(self): |
Chun-ting Chang | cf924e9 | 2012-10-29 13:49:01 +0800 | [diff] [blame] | 758 | """Get updater's work directory path.""" |
| 759 | return self._updater.get_work_path() |
| 760 | |
Vic (Chun-Ju) Yang | 4edbc07 | 2014-02-11 14:40:57 +0800 | [diff] [blame] | 761 | def _rootfs_verify_rootfs(self, section): |
| 762 | """Verifies the integrity of the root FS. |
| 763 | |
| 764 | @param section: The rootfs to verify. May be A or B. |
| 765 | """ |
| 766 | return self._rootfs_handler.verify_rootfs(section) |
| 767 | |
David Sodman | 3ad5164 | 2015-01-22 11:15:33 -0800 | [diff] [blame] | 768 | def _system_check_keys(self, expected_sequence): |
| 769 | """Check the keys sequence was as expected. |
| 770 | |
| 771 | @param expected_sequence: A list of expected key sequences. |
| 772 | """ |
| 773 | return self._check_keys.check_keys(expected_sequence) |
| 774 | |
Tom Wai-Hong Tam | bea57b3 | 2011-09-02 18:27:47 +0800 | [diff] [blame] | 775 | def cleanup(self): |
| 776 | """Cleanup for the RPC server. Currently nothing.""" |
| 777 | pass |