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