1#!/bin/sh
2# This validates that the kernel will load firmware out of its list of
3# firmware locations on disk. Since the user helper does similar work,
4# we reset the custom load directory to a location the user helper doesn't
5# know so we can be sure we're not accidentally testing the user helper.
6set -e
7
8modprobe test_firmware
9
10DIR=/sys/devices/virtual/misc/test_firmware
11
12# CONFIG_FW_LOADER_USER_HELPER has a sysfs class under /sys/class/firmware/
13# These days no one enables CONFIG_FW_LOADER_USER_HELPER so check for that
14# as an indicator for CONFIG_FW_LOADER_USER_HELPER.
15HAS_FW_LOADER_USER_HELPER=$(if [ -d /sys/class/firmware/ ]; then echo yes; else echo no; fi)
16
17if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
18	OLD_TIMEOUT=$(cat /sys/class/firmware/timeout)
19fi
20
21OLD_FWPATH=$(cat /sys/module/firmware_class/parameters/path)
22
23FWPATH=$(mktemp -d)
24FW="$FWPATH/test-firmware.bin"
25
26test_finish()
27{
28	if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
29		echo "$OLD_TIMEOUT" >/sys/class/firmware/timeout
30	fi
31	echo -n "$OLD_PATH" >/sys/module/firmware_class/parameters/path
32	rm -f "$FW"
33	rmdir "$FWPATH"
34}
35
36trap "test_finish" EXIT
37
38if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
39	# Turn down the timeout so failures don't take so long.
40	echo 1 >/sys/class/firmware/timeout
41fi
42
43# Set the kernel search path.
44echo -n "$FWPATH" >/sys/module/firmware_class/parameters/path
45
46# This is an unlikely real-world firmware content. :)
47echo "ABCD0123" >"$FW"
48
49NAME=$(basename "$FW")
50
51# Request a firmware that doesn't exist, it should fail.
52echo -n "nope-$NAME" >"$DIR"/trigger_request
53if diff -q "$FW" /dev/test_firmware >/dev/null ; then
54	echo "$0: firmware was not expected to match" >&2
55	exit 1
56else
57	if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
58		echo "$0: timeout works"
59	fi
60fi
61
62# This should succeed via kernel load or will fail after 1 second after
63# being handed over to the user helper, which won't find the fw either.
64if ! echo -n "$NAME" >"$DIR"/trigger_request ; then
65	echo "$0: could not trigger request" >&2
66	exit 1
67fi
68
69# Verify the contents are what we expect.
70if ! diff -q "$FW" /dev/test_firmware >/dev/null ; then
71	echo "$0: firmware was not loaded" >&2
72	exit 1
73else
74	echo "$0: filesystem loading works"
75fi
76
77exit 0
78