tools/testing/selftests/firmware/fw_filesystem.sh

   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.
   6 set -e
   7
   8 modprobe test_firmware
   9
  10 DIR=/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.
  15 HAS_FW_LOADER_USER_HELPER=$(if [ -d /sys/class/firmware/ ]; then echo yes; else echo no; fi)
  16
  17 if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
  18         OLD_TIMEOUT=$(cat /sys/class/firmware/timeout)
  19 fi
  20
  21 OLD_FWPATH=$(cat /sys/module/firmware_class/parameters/path)
  22
  23 FWPATH=$(mktemp -d)
  24 FW="$FWPATH/test-firmware.bin"
  25
  26 test_finish()
  27 {
  28         if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
  29                 echo "$OLD_TIMEOUT" >/sys/class/firmware/timeout
  30         fi
  31         if [ "$OLD_FWPATH" = "" ]; then
  32                 # A zero-length write won't work; write a null byte
  33                 printf '\000' >/sys/module/firmware_class/parameters/path
  34         else
  35                 echo -n "$OLD_FWPATH" >/sys/module/firmware_class/parameters/path
  36         fi
  37         rm -f "$FW"
  38         rmdir "$FWPATH"
  39 }
  40
  41 trap "test_finish" EXIT
  42
  43 if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
  44         # Turn down the timeout so failures don't take so long.
  45         echo 1 >/sys/class/firmware/timeout
  46 fi
  47
  48 # Set the kernel search path.
  49 echo -n "$FWPATH" >/sys/module/firmware_class/parameters/path
  50
  51 # This is an unlikely real-world firmware content. :)
  52 echo "ABCD0123" >"$FW"
  53
  54 NAME=$(basename "$FW")
  55
  56 if printf '\000' >"$DIR"/trigger_request 2> /dev/null; then
  57         echo "$0: empty filename should not succeed" >&2
  58         exit 1
  59 fi
  60
  61 if printf '\000' >"$DIR"/trigger_async_request 2> /dev/null; then
  62         echo "$0: empty filename should not succeed (async)" >&2
  63         exit 1
  64 fi
  65
  66 # Request a firmware that doesn't exist, it should fail.
  67 if echo -n "nope-$NAME" >"$DIR"/trigger_request 2> /dev/null; then
  68         echo "$0: firmware shouldn't have loaded" >&2
  69         exit 1
  70 fi
  71 if diff -q "$FW" /dev/test_firmware >/dev/null ; then
  72         echo "$0: firmware was not expected to match" >&2
  73         exit 1
  74 else
  75         if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
  76                 echo "$0: timeout works"
  77         fi
  78 fi
  79
  80 # This should succeed via kernel load or will fail after 1 second after
  81 # being handed over to the user helper, which won't find the fw either.
  82 if ! echo -n "$NAME" >"$DIR"/trigger_request ; then
  83         echo "$0: could not trigger request" >&2
  84         exit 1
  85 fi
  86
  87 # Verify the contents are what we expect.
  88 if ! diff -q "$FW" /dev/test_firmware >/dev/null ; then
  89         echo "$0: firmware was not loaded" >&2
  90         exit 1
  91 else
  92         echo "$0: filesystem loading works"
  93 fi
  94
  95 # Try the asynchronous version too
  96 if ! echo -n "$NAME" >"$DIR"/trigger_async_request ; then
  97         echo "$0: could not trigger async request" >&2
  98         exit 1
  99 fi
 100
 101 # Verify the contents are what we expect.
 102 if ! diff -q "$FW" /dev/test_firmware >/dev/null ; then
 103         echo "$0: firmware was not loaded (async)" >&2
 104         exit 1
 105 else
 106         echo "$0: async filesystem loading works"
 107 fi
 108
 109 exit 0