selftests/firmware/fw_lib.sh

0001 #!/bin/bash
0002 # SPDX-License-Identifier: GPL-2.0
0003
0004 # Library of helpers for test scripts.
0005 set -e
0006
0007 DIR=/sys/devices/virtual/misc/test_firmware
0008
0009 PROC_CONFIG="/proc/config.gz"
0010 TEST_DIR=$(dirname $0)
0011
0012 # We need to load a different file to test request_firmware_into_buf
0013 # I believe the issue is firmware loaded cached vs. non-cached
0014 # with same filename is bungled.
0015 # To reproduce rename this to test-firmware.bin
0016 TEST_FIRMWARE_INTO_BUF_FILENAME=test-firmware-into-buf.bin
0017
0018 # Kselftest framework requirement - SKIP code is 4.
0019 ksft_skip=4
0020
0021 print_reqs_exit()
0022 {
0023         echo "You must have the following enabled in your kernel:" >&2
0024         cat $TEST_DIR/config >&2
0025         exit $ksft_skip
0026 }
0027
0028 test_modprobe()
0029 {
0030         if [ ! -d $DIR ]; then
0031                 print_reqs_exit
0032         fi
0033 }
0034
0035 check_mods()
0036 {
0037         local uid=$(id -u)
0038         if [ $uid -ne 0 ]; then
0039                 echo "skip all tests: must be run as root" >&2
0040                 exit $ksft_skip
0041         fi
0042
0043         trap "test_modprobe" EXIT
0044         if [ ! -d $DIR ]; then
0045                 modprobe test_firmware
0046         fi
0047         if [ ! -f $PROC_CONFIG ]; then
0048                 if modprobe configs 2>/dev/null; then
0049                         echo "Loaded configs module"
0050                         if [ ! -f $PROC_CONFIG ]; then
0051                                 echo "You must have the following enabled in your kernel:" >&2
0052                                 cat $TEST_DIR/config >&2
0053                                 echo "Resorting to old heuristics" >&2
0054                         fi
0055                 else
0056                         echo "Failed to load configs module, using old heuristics" >&2
0057                 fi
0058         fi
0059 }
0060
0061 check_setup()
0062 {
0063         HAS_FW_LOADER_USER_HELPER="$(kconfig_has CONFIG_FW_LOADER_USER_HELPER=y)"
0064         HAS_FW_LOADER_USER_HELPER_FALLBACK="$(kconfig_has CONFIG_FW_LOADER_USER_HELPER_FALLBACK=y)"
0065         HAS_FW_LOADER_COMPRESS_XZ="$(kconfig_has CONFIG_FW_LOADER_COMPRESS_XZ=y)"
0066         HAS_FW_LOADER_COMPRESS_ZSTD="$(kconfig_has CONFIG_FW_LOADER_COMPRESS_ZSTD=y)"
0067         HAS_FW_UPLOAD="$(kconfig_has CONFIG_FW_UPLOAD=y)"
0068         PROC_FW_IGNORE_SYSFS_FALLBACK="0"
0069         PROC_FW_FORCE_SYSFS_FALLBACK="0"
0070
0071         if [ -z $PROC_SYS_DIR ]; then
0072                 PROC_SYS_DIR="/proc/sys/kernel"
0073         fi
0074
0075         FW_PROC="${PROC_SYS_DIR}/firmware_config"
0076         FW_FORCE_SYSFS_FALLBACK="$FW_PROC/force_sysfs_fallback"
0077         FW_IGNORE_SYSFS_FALLBACK="$FW_PROC/ignore_sysfs_fallback"
0078
0079         if [ -f $FW_FORCE_SYSFS_FALLBACK ]; then
0080                 PROC_FW_FORCE_SYSFS_FALLBACK="$(cat $FW_FORCE_SYSFS_FALLBACK)"
0081         fi
0082
0083         if [ -f $FW_IGNORE_SYSFS_FALLBACK ]; then
0084                 PROC_FW_IGNORE_SYSFS_FALLBACK="$(cat $FW_IGNORE_SYSFS_FALLBACK)"
0085         fi
0086
0087         if [ "$PROC_FW_FORCE_SYSFS_FALLBACK" = "1" ]; then
0088                 HAS_FW_LOADER_USER_HELPER="yes"
0089                 HAS_FW_LOADER_USER_HELPER_FALLBACK="yes"
0090         fi
0091
0092         if [ "$PROC_FW_IGNORE_SYSFS_FALLBACK" = "1" ]; then
0093                 HAS_FW_LOADER_USER_HELPER_FALLBACK="no"
0094                 HAS_FW_LOADER_USER_HELPER="no"
0095         fi
0096
0097         if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
0098                OLD_TIMEOUT="$(cat /sys/class/firmware/timeout)"
0099         fi
0100
0101         OLD_FWPATH="$(cat /sys/module/firmware_class/parameters/path)"
0102
0103         if [ "$HAS_FW_LOADER_COMPRESS_XZ" = "yes" ]; then
0104                 if ! which xz 2> /dev/null > /dev/null; then
0105                         HAS_FW_LOADER_COMPRESS_XZ=""
0106                 fi
0107         fi
0108         if [ "$HAS_FW_LOADER_COMPRESS_ZSTD" = "yes" ]; then
0109                 if ! which zstd 2> /dev/null > /dev/null; then
0110                         HAS_FW_LOADER_COMPRESS_ZSTD=""
0111                 fi
0112         fi
0113 }
0114
0115 verify_reqs()
0116 {
0117         if [ "$TEST_REQS_FW_SYSFS_FALLBACK" = "yes" ]; then
0118                 if [ ! "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
0119                         echo "usermode helper disabled so ignoring test"
0120                         exit 0
0121                 fi
0122         fi
0123         if [ "$TEST_REQS_FW_UPLOAD" = "yes" ]; then
0124                 if [ ! "$HAS_FW_UPLOAD" = "yes" ]; then
0125                         echo "firmware upload disabled so ignoring test"
0126                         exit 0
0127                 fi
0128         fi
0129 }
0130
0131 setup_tmp_file()
0132 {
0133         FWPATH=$(mktemp -d)
0134         FW="$FWPATH/test-firmware.bin"
0135         echo "ABCD0123" >"$FW"
0136         FW_INTO_BUF="$FWPATH/$TEST_FIRMWARE_INTO_BUF_FILENAME"
0137         echo "EFGH4567" >"$FW_INTO_BUF"
0138         NAME=$(basename "$FW")
0139         if [ "$TEST_REQS_FW_SET_CUSTOM_PATH" = "yes" ]; then
0140                 echo -n "$FWPATH" >/sys/module/firmware_class/parameters/path
0141         fi
0142 }
0143
0144 __setup_random_file()
0145 {
0146         RANDOM_FILE_PATH="$(mktemp -p $FWPATH)"
0147         # mktemp says dry-run -n is unsafe, so...
0148         if [[ "$1" = "fake" ]]; then
0149                 rm -rf $RANDOM_FILE_PATH
0150                 sync
0151         else
0152                 echo "ABCD0123" >"$RANDOM_FILE_PATH"
0153         fi
0154         echo $RANDOM_FILE_PATH
0155 }
0156
0157 setup_random_file()
0158 {
0159         echo $(__setup_random_file)
0160 }
0161
0162 setup_random_file_fake()
0163 {
0164         echo $(__setup_random_file fake)
0165 }
0166
0167 proc_set_force_sysfs_fallback()
0168 {
0169         if [ -f $FW_FORCE_SYSFS_FALLBACK ]; then
0170                 echo -n $1 > $FW_FORCE_SYSFS_FALLBACK
0171                 check_setup
0172         fi
0173 }
0174
0175 proc_set_ignore_sysfs_fallback()
0176 {
0177         if [ -f $FW_IGNORE_SYSFS_FALLBACK ]; then
0178                 echo -n $1 > $FW_IGNORE_SYSFS_FALLBACK
0179                 check_setup
0180         fi
0181 }
0182
0183 proc_restore_defaults()
0184 {
0185         proc_set_force_sysfs_fallback 0
0186         proc_set_ignore_sysfs_fallback 0
0187 }
0188
0189 test_finish()
0190 {
0191         if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
0192                 echo "$OLD_TIMEOUT" >/sys/class/firmware/timeout
0193         fi
0194         if [ "$TEST_REQS_FW_SET_CUSTOM_PATH" = "yes" ]; then
0195                 if [ "$OLD_FWPATH" = "" ]; then
0196                         # A zero-length write won't work; write a null byte
0197                         printf '\000' >/sys/module/firmware_class/parameters/path
0198                 else
0199                         echo -n "$OLD_FWPATH" >/sys/module/firmware_class/parameters/path
0200                 fi
0201         fi
0202         if [ -f $FW ]; then
0203                 rm -f "$FW"
0204         fi
0205         if [ -f $FW_INTO_BUF ]; then
0206                 rm -f "$FW_INTO_BUF"
0207         fi
0208         if [ -d $FWPATH ]; then
0209                 rm -rf "$FWPATH"
0210         fi
0211         proc_restore_defaults
0212 }
0213
0214 kconfig_has()
0215 {
0216         if [ -f $PROC_CONFIG ]; then
0217                 if zgrep -q $1 $PROC_CONFIG 2>/dev/null; then
0218                         echo "yes"
0219                 else
0220                         echo "no"
0221                 fi
0222         else
0223                 # We currently don't have easy heuristics to infer this
0224                 # so best we can do is just try to use the kernel assuming
0225                 # you had enabled it. This matches the old behaviour.
0226                 if [ "$1" = "CONFIG_FW_LOADER_USER_HELPER_FALLBACK=y" ]; then
0227                         echo "yes"
0228                 elif [ "$1" = "CONFIG_FW_LOADER_USER_HELPER=y" ]; then
0229                         if [ -d /sys/class/firmware/ ]; then
0230                                 echo yes
0231                         else
0232                                 echo no
0233                         fi
0234                 fi
0235         fi
0236 }