1 # Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
3 # SPDX-License-Identifier: GPL-2.0
5 # Test U-Boot's "dfu" command. The test starts DFU in U-Boot, waits for USB
6 # device enumeration on the host, executes dfu-util multiple times to test
7 # various transfer sizes, many of which trigger USB driver edge cases, and
8 # finally aborts the "dfu" command in U-Boot.
16 Note: This test relies on:
18 a) boardenv_* to contain configuration values to define which USB ports are
19 available for testing. Without this, this test will be automatically skipped.
22 env__usb_dev_ports = (
25 "host_usb_dev_node": "/dev/usbdev-p2371-2180",
26 # This parameter is optional /if/ you only have a single board
27 # attached to your host at a time.
28 "host_usb_port_path": "3-13",
35 "alt_info": "/dfu_test.bin ext4 0 1;/dfu_dummy.bin ext4 0 1",
36 "cmd_params": "mmc 0",
39 b) udev rules to set permissions on devices nodes, so that sudo is not
40 required. For example:
42 ACTION=="add", SUBSYSTEM=="block", SUBSYSTEMS=="usb", KERNELS=="3-13", MODE:="666"
44 (You may wish to change the group ID instead of setting the permissions wide
45 open. All that matters is that the user ID running the test can access the
49 # The set of file sizes to test. These values trigger various edge-cases such
50 # as one less than, equal to, and one greater than typical USB max packet
51 # sizes, and similar boundary conditions.
70 first_usb_dev_port = None
72 @pytest.mark.buildconfigspec('cmd_dfu')
73 def test_dfu(u_boot_console, env__usb_dev_port, env__dfu_config):
74 """Test the "dfu" command; the host system must be able to enumerate a USB
75 device when "dfu" is running, various DFU transfers are tested, and the
76 USB device must disappear when "dfu" is aborted.
79 u_boot_console: A U-Boot console connection.
80 env__usb_dev_port: The single USB device-mode port specification on
81 which to run the test. See the file-level comment above for
82 details of the format.
83 env__dfu_config: The single DFU (memory region) configuration on which
84 to run the test. See the file-level comment above for details
92 """Start U-Boot's dfu shell command.
94 This also waits for the host-side USB enumeration process to complete.
103 fh = u_boot_utils.attempt_to_open_file(
104 env__usb_dev_port['host_usb_dev_node'])
107 raise Exception('USB device present before dfu command invoked')
109 u_boot_console.log.action(
110 'Starting long-running U-Boot dfu shell command')
112 cmd = 'setenv dfu_alt_info "%s"' % env__dfu_config['alt_info']
113 u_boot_console.run_command(cmd)
115 cmd = 'dfu 0 ' + env__dfu_config['cmd_params']
116 u_boot_console.run_command(cmd, wait_for_prompt=False)
117 u_boot_console.log.action('Waiting for DFU USB device to appear')
118 fh = u_boot_utils.wait_until_open_succeeds(
119 env__usb_dev_port['host_usb_dev_node'])
122 def stop_dfu(ignore_errors):
123 """Stop U-Boot's dfu shell command from executing.
125 This also waits for the host-side USB de-enumeration process to
129 ignore_errors: Ignore any errors. This is useful if an error has
130 already been detected, and the code is performing best-effort
131 cleanup. In this case, we do not want to mask the original
132 error by "honoring" any new errors.
139 u_boot_console.log.action(
140 'Stopping long-running U-Boot dfu shell command')
141 u_boot_console.ctrlc()
142 u_boot_console.log.action(
143 'Waiting for DFU USB device to disappear')
144 u_boot_utils.wait_until_file_open_fails(
145 env__usb_dev_port['host_usb_dev_node'], ignore_errors)
147 if not ignore_errors:
150 def run_dfu_util(alt_setting, fn, up_dn_load_arg):
151 """Invoke dfu-util on the host.
154 alt_setting: The DFU "alternate setting" identifier to interact
156 fn: The host-side file name to transfer.
157 up_dn_load_arg: '-U' or '-D' depending on whether a DFU upload or
158 download operation should be performed.
164 cmd = ['dfu-util', '-a', str(alt_setting), up_dn_load_arg, fn]
165 if 'host_usb_port_path' in env__usb_dev_port:
166 cmd += ['-p', env__usb_dev_port['host_usb_port_path']]
167 u_boot_utils.run_and_log(u_boot_console, cmd)
168 u_boot_console.wait_for('Ctrl+C to exit ...')
170 def dfu_write(alt_setting, fn):
171 """Write a file to the target board using DFU.
174 alt_setting: The DFU "alternate setting" identifier to interact
176 fn: The host-side file name to transfer.
182 run_dfu_util(alt_setting, fn, '-D')
184 def dfu_read(alt_setting, fn):
185 """Read a file from the target board using DFU.
188 alt_setting: The DFU "alternate setting" identifier to interact
190 fn: The host-side file name to transfer.
196 # dfu-util fails reads/uploads if the host file already exists
197 if os.path.exists(fn):
199 run_dfu_util(alt_setting, fn, '-U')
201 def dfu_write_read_check(size):
202 """Test DFU transfers of a specific size of data
204 This function first writes data to the board then reads it back and
205 compares the written and read back data. Measures are taken to avoid
206 certain types of false positives.
209 size: The data size to test.
215 test_f = u_boot_utils.PersistentRandomFile(u_boot_console,
216 'dfu_%d.bin' % size, size)
217 readback_fn = u_boot_console.config.result_dir + '/dfu_readback.bin'
219 u_boot_console.log.action('Writing test data to DFU primary ' +
221 dfu_write(0, test_f.abs_fn)
223 u_boot_console.log.action('Writing dummy data to DFU secondary ' +
224 'altsetting to clear DFU buffers')
225 dfu_write(1, dummy_f.abs_fn)
227 u_boot_console.log.action('Reading DFU primary altsetting for ' +
229 dfu_read(0, readback_fn)
231 u_boot_console.log.action('Comparing written and read data')
232 written_hash = test_f.content_hash
233 read_back_hash = u_boot_utils.md5sum_file(readback_fn, size)
234 assert(written_hash == read_back_hash)
236 # This test may be executed against multiple USB ports. The test takes a
237 # long time, so we don't want to do the whole thing each time. Instead,
238 # execute the full test on the first USB port, and perform a very limited
239 # test on other ports. In the limited case, we solely validate that the
240 # host PC can enumerate the U-Boot USB device.
241 global first_usb_dev_port
242 if not first_usb_dev_port:
243 first_usb_dev_port = env__usb_dev_port
244 if env__usb_dev_port == first_usb_dev_port:
249 dummy_f = u_boot_utils.PersistentRandomFile(u_boot_console,
250 'dfu_dummy.bin', 1024)
252 ignore_cleanup_errors = True
256 u_boot_console.log.action(
257 'Overwriting DFU primary altsetting with dummy data')
258 dfu_write(0, dummy_f.abs_fn)
261 with u_boot_console.log.section("Data size %d" % size):
262 dfu_write_read_check(size)
263 # Make the status of each sub-test obvious. If the test didn't
264 # pass, an exception was thrown so this code isn't executed.
265 u_boot_console.log.status_pass('OK')
266 ignore_cleanup_errors = False
268 stop_dfu(ignore_cleanup_errors)