2 # SPDX-License-Identifier: GPL-2.0
3 # This validates that the kernel will load firmware out of its list of
4 # firmware locations on disk. Since the user helper does similar work,
5 # we reset the custom load directory to a location the user helper doesn't
6 # know so we can be sure we're not accidentally testing the user helper.
9 TEST_REQS_FW_SYSFS_FALLBACK="no"
10 TEST_REQS_FW_SET_CUSTOM_PATH="yes"
11 TEST_DIR=$(dirname $0)
12 source $TEST_DIR/fw_lib.sh
19 trap "test_finish" EXIT
21 if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
22 # Turn down the timeout so failures don't take so long.
23 echo 1 >/sys/class/firmware/timeout
26 if printf '\000' >"$DIR"/trigger_request 2> /dev/null; then
27 echo "$0: empty filename should not succeed" >&2
31 if [ ! -e "$DIR"/trigger_async_request ]; then
32 echo "$0: empty filename: async trigger not present, ignoring test" >&2
35 if printf '\000' >"$DIR"/trigger_async_request 2> /dev/null; then
36 echo "$0: empty filename should not succeed (async)" >&2
41 # Request a firmware that doesn't exist, it should fail.
42 if echo -n "nope-$NAME" >"$DIR"/trigger_request 2> /dev/null; then
43 echo "$0: firmware shouldn't have loaded" >&2
46 if diff -q "$FW" /dev/test_firmware >/dev/null ; then
47 echo "$0: firmware was not expected to match" >&2
50 if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
51 echo "$0: timeout works"
55 # This should succeed via kernel load or will fail after 1 second after
56 # being handed over to the user helper, which won't find the fw either.
57 if ! echo -n "$NAME" >"$DIR"/trigger_request ; then
58 echo "$0: could not trigger request" >&2
62 # Verify the contents are what we expect.
63 if ! diff -q "$FW" /dev/test_firmware >/dev/null ; then
64 echo "$0: firmware was not loaded" >&2
67 echo "$0: filesystem loading works"
70 # Try the asynchronous version too
71 if [ ! -e "$DIR"/trigger_async_request ]; then
72 echo "$0: firmware loading: async trigger not present, ignoring test" >&2
75 if ! echo -n "$NAME" >"$DIR"/trigger_async_request ; then
76 echo "$0: could not trigger async request" >&2
80 # Verify the contents are what we expect.
81 if ! diff -q "$FW" /dev/test_firmware >/dev/null ; then
82 echo "$0: firmware was not loaded (async)" >&2
85 echo "$0: async filesystem loading works"
89 ### Batched requests tests
92 if [ ! -f $DIR/reset ]; then
93 echo "Configuration triggers not present, ignoring test"
102 # name: test-firmware.bin
109 release_all_firmware()
111 echo 1 > $DIR/release_all_firmware
116 echo -n $1 > $DIR/config_name
119 config_set_sync_direct()
121 echo 1 > $DIR/config_sync_direct
124 config_unset_sync_direct()
126 echo 0 > $DIR/config_sync_direct
131 echo 1 > $DIR/config_send_uevent
134 config_unset_uevent()
136 echo 0 > $DIR/config_send_uevent
139 config_trigger_sync()
141 echo -n 1 > $DIR/trigger_batched_requests 2>/dev/null
144 config_trigger_async()
146 echo -n 1 > $DIR/trigger_batched_requests_async 2> /dev/null
149 config_set_read_fw_idx()
151 echo -n $1 > $DIR/config_read_fw_idx 2> /dev/null
156 for i in $(seq 0 3); do
157 config_set_read_fw_idx $i
158 # Verify the contents are what we expect.
159 # -Z required for now -- check for yourself, md5sum
160 # on $FW and DIR/read_firmware will yield the same. Even
161 # cmp agrees, so something is off.
162 if ! diff -q -Z "$FW" $DIR/read_firmware 2>/dev/null ; then
163 echo "request #$i: firmware was not loaded" >&2
169 read_firmwares_expect_nofile()
171 for i in $(seq 0 3); do
172 config_set_read_fw_idx $i
173 # Ensures contents differ
174 if diff -q -Z "$FW" $DIR/read_firmware 2>/dev/null ; then
175 echo "request $i: file was not expected to match" >&2
181 test_batched_request_firmware_nofile()
183 echo -n "Batched request_firmware() nofile try #$1: "
185 config_set_name nope-test-firmware.bin
187 read_firmwares_expect_nofile
192 test_batched_request_firmware_direct_nofile()
194 echo -n "Batched request_firmware_direct() nofile try #$1: "
196 config_set_name nope-test-firmware.bin
197 config_set_sync_direct
203 test_request_firmware_nowait_uevent_nofile()
205 echo -n "Batched request_firmware_nowait(uevent=true) nofile try #$1: "
207 config_set_name nope-test-firmware.bin
213 test_wait_and_cancel_custom_load()
215 if [ "$HAS_FW_LOADER_USER_HELPER" != "yes" ]; then
220 while [ ! -e "$DIR"/"$name"/loading ]; do
222 timeout=$(( $timeout - 1 ))
223 if [ "$timeout" -eq 0 ]; then
224 echo "firmware interface never appeared:" >&2
225 echo "$DIR/$name/loading" >&2
229 echo -1 >"$DIR"/"$name"/loading
232 test_request_firmware_nowait_custom_nofile()
234 echo -n "Batched request_firmware_nowait(uevent=false) nofile try #$1: "
237 RANDOM_FILE_PATH=$(setup_random_file_fake)
238 RANDOM_FILE="$(basename $RANDOM_FILE_PATH)"
239 config_set_name $RANDOM_FILE
240 config_trigger_async &
241 test_wait_and_cancel_custom_load $RANDOM_FILE
247 test_batched_request_firmware()
249 echo -n "Batched request_firmware() try #$1: "
257 test_batched_request_firmware_direct()
259 echo -n "Batched request_firmware_direct() try #$1: "
261 config_set_sync_direct
267 test_request_firmware_nowait_uevent()
269 echo -n "Batched request_firmware_nowait(uevent=true) try #$1: "
276 test_request_firmware_nowait_custom()
278 echo -n "Batched request_firmware_nowait(uevent=false) try #$1: "
281 RANDOM_FILE_PATH=$(setup_random_file)
282 RANDOM_FILE="$(basename $RANDOM_FILE_PATH)"
283 config_set_name $RANDOM_FILE
289 # Only continue if batched request triggers are present on the
290 # test-firmware driver
293 # test with the file present
295 echo "Testing with the file present..."
296 for i in $(seq 1 5); do
297 test_batched_request_firmware $i
300 for i in $(seq 1 5); do
301 test_batched_request_firmware_direct $i
304 for i in $(seq 1 5); do
305 test_request_firmware_nowait_uevent $i
308 for i in $(seq 1 5); do
309 test_request_firmware_nowait_custom $i
312 # Test for file not found, errors are expected, the failure would be
313 # a hung task, which would require a hard reset.
315 echo "Testing with the file missing..."
316 for i in $(seq 1 5); do
317 test_batched_request_firmware_nofile $i
320 for i in $(seq 1 5); do
321 test_batched_request_firmware_direct_nofile $i
324 for i in $(seq 1 5); do
325 test_request_firmware_nowait_uevent_nofile $i
328 for i in $(seq 1 5); do
329 test_request_firmware_nowait_custom_nofile $i