129a1c00cSLuis R. Rodriguez#!/bin/bash 229a1c00cSLuis R. Rodriguez# SPDX-License-Identifier: GPL-2.0 329a1c00cSLuis R. Rodriguez 429a1c00cSLuis R. Rodriguez# Library of helpers for test scripts. 529a1c00cSLuis R. Rodriguezset -e 629a1c00cSLuis R. Rodriguez 729a1c00cSLuis R. RodriguezDIR=/sys/devices/virtual/misc/test_firmware 829a1c00cSLuis R. Rodriguez 929a1c00cSLuis R. RodriguezPROC_CONFIG="/proc/config.gz" 1029a1c00cSLuis R. RodriguezTEST_DIR=$(dirname $0) 1129a1c00cSLuis R. Rodriguez 1217980459SScott Branden# We need to load a different file to test request_firmware_into_buf 1317980459SScott Branden# I believe the issue is firmware loaded cached vs. non-cached 1417980459SScott Branden# with same filename is bungled. 1517980459SScott Branden# To reproduce rename this to test-firmware.bin 1617980459SScott BrandenTEST_FIRMWARE_INTO_BUF_FILENAME=test-firmware-into-buf.bin 1717980459SScott Branden 18a6a9be92SShuah Khan (Samsung OSG)# Kselftest framework requirement - SKIP code is 4. 19a6a9be92SShuah Khan (Samsung OSG)ksft_skip=4 20a6a9be92SShuah Khan (Samsung OSG) 2129a1c00cSLuis R. Rodriguezprint_reqs_exit() 2229a1c00cSLuis R. Rodriguez{ 2329a1c00cSLuis R. Rodriguez echo "You must have the following enabled in your kernel:" >&2 2429a1c00cSLuis R. Rodriguez cat $TEST_DIR/config >&2 25a6a9be92SShuah Khan (Samsung OSG) exit $ksft_skip 2629a1c00cSLuis R. Rodriguez} 2729a1c00cSLuis R. Rodriguez 2829a1c00cSLuis R. Rodrigueztest_modprobe() 2929a1c00cSLuis R. Rodriguez{ 3029a1c00cSLuis R. Rodriguez if [ ! -d $DIR ]; then 3129a1c00cSLuis R. Rodriguez print_reqs_exit 3229a1c00cSLuis R. Rodriguez fi 3329a1c00cSLuis R. Rodriguez} 3429a1c00cSLuis R. Rodriguez 3529a1c00cSLuis R. Rodriguezcheck_mods() 3629a1c00cSLuis R. Rodriguez{ 37c65e4153SShuah Khan local uid=$(id -u) 38c65e4153SShuah Khan if [ $uid -ne 0 ]; then 39c65e4153SShuah Khan echo "skip all tests: must be run as root" >&2 40c65e4153SShuah Khan exit $ksft_skip 41c65e4153SShuah Khan fi 42c65e4153SShuah Khan 4329a1c00cSLuis R. Rodriguez trap "test_modprobe" EXIT 4429a1c00cSLuis R. Rodriguez if [ ! -d $DIR ]; then 4529a1c00cSLuis R. Rodriguez modprobe test_firmware 4629a1c00cSLuis R. Rodriguez fi 4729a1c00cSLuis R. Rodriguez if [ ! -f $PROC_CONFIG ]; then 4829a1c00cSLuis R. Rodriguez if modprobe configs 2>/dev/null; then 4929a1c00cSLuis R. Rodriguez echo "Loaded configs module" 5029a1c00cSLuis R. Rodriguez if [ ! -f $PROC_CONFIG ]; then 5129a1c00cSLuis R. Rodriguez echo "You must have the following enabled in your kernel:" >&2 5229a1c00cSLuis R. Rodriguez cat $TEST_DIR/config >&2 5329a1c00cSLuis R. Rodriguez echo "Resorting to old heuristics" >&2 5429a1c00cSLuis R. Rodriguez fi 5529a1c00cSLuis R. Rodriguez else 5629a1c00cSLuis R. Rodriguez echo "Failed to load configs module, using old heuristics" >&2 5729a1c00cSLuis R. Rodriguez fi 5829a1c00cSLuis R. Rodriguez fi 5929a1c00cSLuis R. Rodriguez} 60ef557787SLuis R. Rodriguez 61f5a61451SLuis R. Rodriguezcheck_setup() 62f5a61451SLuis R. Rodriguez{ 63f5a61451SLuis R. Rodriguez HAS_FW_LOADER_USER_HELPER="$(kconfig_has CONFIG_FW_LOADER_USER_HELPER=y)" 64f5a61451SLuis R. Rodriguez HAS_FW_LOADER_USER_HELPER_FALLBACK="$(kconfig_has CONFIG_FW_LOADER_USER_HELPER_FALLBACK=y)" 65108ae07cSTakashi Iwai HAS_FW_LOADER_COMPRESS="$(kconfig_has CONFIG_FW_LOADER_COMPRESS=y)" 66b3cf21faSLuis R. Rodriguez PROC_FW_IGNORE_SYSFS_FALLBACK="0" 67b3cf21faSLuis R. Rodriguez PROC_FW_FORCE_SYSFS_FALLBACK="0" 68b3cf21faSLuis R. Rodriguez 69b3cf21faSLuis R. Rodriguez if [ -z $PROC_SYS_DIR ]; then 70b3cf21faSLuis R. Rodriguez PROC_SYS_DIR="/proc/sys/kernel" 71b3cf21faSLuis R. Rodriguez fi 72b3cf21faSLuis R. Rodriguez 73b3cf21faSLuis R. Rodriguez FW_PROC="${PROC_SYS_DIR}/firmware_config" 74b3cf21faSLuis R. Rodriguez FW_FORCE_SYSFS_FALLBACK="$FW_PROC/force_sysfs_fallback" 75b3cf21faSLuis R. Rodriguez FW_IGNORE_SYSFS_FALLBACK="$FW_PROC/ignore_sysfs_fallback" 76b3cf21faSLuis R. Rodriguez 77b3cf21faSLuis R. Rodriguez if [ -f $FW_FORCE_SYSFS_FALLBACK ]; then 78b3cf21faSLuis R. Rodriguez PROC_FW_FORCE_SYSFS_FALLBACK="$(cat $FW_FORCE_SYSFS_FALLBACK)" 79b3cf21faSLuis R. Rodriguez fi 80b3cf21faSLuis R. Rodriguez 81b3cf21faSLuis R. Rodriguez if [ -f $FW_IGNORE_SYSFS_FALLBACK ]; then 82b3cf21faSLuis R. Rodriguez PROC_FW_IGNORE_SYSFS_FALLBACK="$(cat $FW_IGNORE_SYSFS_FALLBACK)" 83b3cf21faSLuis R. Rodriguez fi 84b3cf21faSLuis R. Rodriguez 85b3cf21faSLuis R. Rodriguez if [ "$PROC_FW_FORCE_SYSFS_FALLBACK" = "1" ]; then 86b3cf21faSLuis R. Rodriguez HAS_FW_LOADER_USER_HELPER="yes" 87b3cf21faSLuis R. Rodriguez HAS_FW_LOADER_USER_HELPER_FALLBACK="yes" 88b3cf21faSLuis R. Rodriguez fi 89b3cf21faSLuis R. Rodriguez 90b3cf21faSLuis R. Rodriguez if [ "$PROC_FW_IGNORE_SYSFS_FALLBACK" = "1" ]; then 91b3cf21faSLuis R. Rodriguez HAS_FW_LOADER_USER_HELPER_FALLBACK="no" 92b3cf21faSLuis R. Rodriguez HAS_FW_LOADER_USER_HELPER="no" 93b3cf21faSLuis R. Rodriguez fi 94f5a61451SLuis R. Rodriguez 95f5a61451SLuis R. Rodriguez if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then 96f5a61451SLuis R. Rodriguez OLD_TIMEOUT="$(cat /sys/class/firmware/timeout)" 97f5a61451SLuis R. Rodriguez fi 98f5a61451SLuis R. Rodriguez 99f5a61451SLuis R. Rodriguez OLD_FWPATH="$(cat /sys/module/firmware_class/parameters/path)" 100108ae07cSTakashi Iwai 101108ae07cSTakashi Iwai if [ "$HAS_FW_LOADER_COMPRESS" = "yes" ]; then 102108ae07cSTakashi Iwai if ! which xz 2> /dev/null > /dev/null; then 103108ae07cSTakashi Iwai HAS_FW_LOADER_COMPRESS="" 104108ae07cSTakashi Iwai fi 105108ae07cSTakashi Iwai fi 106f5a61451SLuis R. Rodriguez} 107f5a61451SLuis R. Rodriguez 108f5a61451SLuis R. Rodriguezverify_reqs() 109f5a61451SLuis R. Rodriguez{ 110f5a61451SLuis R. Rodriguez if [ "$TEST_REQS_FW_SYSFS_FALLBACK" = "yes" ]; then 111f5a61451SLuis R. Rodriguez if [ ! "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then 112f5a61451SLuis R. Rodriguez echo "usermode helper disabled so ignoring test" 113344c0152SLuis Chamberlain exit 0 114f5a61451SLuis R. Rodriguez fi 115f5a61451SLuis R. Rodriguez fi 116f5a61451SLuis R. Rodriguez} 117f5a61451SLuis R. Rodriguez 118f5a61451SLuis R. Rodriguezsetup_tmp_file() 119f5a61451SLuis R. Rodriguez{ 120f5a61451SLuis R. Rodriguez FWPATH=$(mktemp -d) 121f5a61451SLuis R. Rodriguez FW="$FWPATH/test-firmware.bin" 122f5a61451SLuis R. Rodriguez echo "ABCD0123" >"$FW" 12317980459SScott Branden FW_INTO_BUF="$FWPATH/$TEST_FIRMWARE_INTO_BUF_FILENAME" 12417980459SScott Branden echo "EFGH4567" >"$FW_INTO_BUF" 125f5a61451SLuis R. Rodriguez NAME=$(basename "$FW") 126f5a61451SLuis R. Rodriguez if [ "$TEST_REQS_FW_SET_CUSTOM_PATH" = "yes" ]; then 127f5a61451SLuis R. Rodriguez echo -n "$FWPATH" >/sys/module/firmware_class/parameters/path 128f5a61451SLuis R. Rodriguez fi 129f5a61451SLuis R. Rodriguez} 130f5a61451SLuis R. Rodriguez 1319952db75SLuis R. Rodriguez__setup_random_file() 1329952db75SLuis R. Rodriguez{ 1339952db75SLuis R. Rodriguez RANDOM_FILE_PATH="$(mktemp -p $FWPATH)" 1349952db75SLuis R. Rodriguez # mktemp says dry-run -n is unsafe, so... 1359952db75SLuis R. Rodriguez if [[ "$1" = "fake" ]]; then 1369952db75SLuis R. Rodriguez rm -rf $RANDOM_FILE_PATH 1379952db75SLuis R. Rodriguez sync 1389952db75SLuis R. Rodriguez else 1399952db75SLuis R. Rodriguez echo "ABCD0123" >"$RANDOM_FILE_PATH" 1409952db75SLuis R. Rodriguez fi 1419952db75SLuis R. Rodriguez echo $RANDOM_FILE_PATH 1429952db75SLuis R. Rodriguez} 1439952db75SLuis R. Rodriguez 1449952db75SLuis R. Rodriguezsetup_random_file() 1459952db75SLuis R. Rodriguez{ 1469952db75SLuis R. Rodriguez echo $(__setup_random_file) 1479952db75SLuis R. Rodriguez} 1489952db75SLuis R. Rodriguez 1499952db75SLuis R. Rodriguezsetup_random_file_fake() 1509952db75SLuis R. Rodriguez{ 1519952db75SLuis R. Rodriguez echo $(__setup_random_file fake) 1529952db75SLuis R. Rodriguez} 1539952db75SLuis R. Rodriguez 154b3cf21faSLuis R. Rodriguezproc_set_force_sysfs_fallback() 155b3cf21faSLuis R. Rodriguez{ 156b3cf21faSLuis R. Rodriguez if [ -f $FW_FORCE_SYSFS_FALLBACK ]; then 157b3cf21faSLuis R. Rodriguez echo -n $1 > $FW_FORCE_SYSFS_FALLBACK 158b3cf21faSLuis R. Rodriguez check_setup 159b3cf21faSLuis R. Rodriguez fi 160b3cf21faSLuis R. Rodriguez} 161b3cf21faSLuis R. Rodriguez 162b3cf21faSLuis R. Rodriguezproc_set_ignore_sysfs_fallback() 163b3cf21faSLuis R. Rodriguez{ 164b3cf21faSLuis R. Rodriguez if [ -f $FW_IGNORE_SYSFS_FALLBACK ]; then 165b3cf21faSLuis R. Rodriguez echo -n $1 > $FW_IGNORE_SYSFS_FALLBACK 166b3cf21faSLuis R. Rodriguez check_setup 167b3cf21faSLuis R. Rodriguez fi 168b3cf21faSLuis R. Rodriguez} 169b3cf21faSLuis R. Rodriguez 170b3cf21faSLuis R. Rodriguezproc_restore_defaults() 171b3cf21faSLuis R. Rodriguez{ 172b3cf21faSLuis R. Rodriguez proc_set_force_sysfs_fallback 0 173b3cf21faSLuis R. Rodriguez proc_set_ignore_sysfs_fallback 0 174b3cf21faSLuis R. Rodriguez} 175b3cf21faSLuis R. Rodriguez 176f5a61451SLuis R. Rodrigueztest_finish() 177f5a61451SLuis R. Rodriguez{ 178f5a61451SLuis R. Rodriguez if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then 179f5a61451SLuis R. Rodriguez echo "$OLD_TIMEOUT" >/sys/class/firmware/timeout 180f5a61451SLuis R. Rodriguez fi 181f5a61451SLuis R. Rodriguez if [ "$TEST_REQS_FW_SET_CUSTOM_PATH" = "yes" ]; then 182e5384092SBen Hutchings if [ "$OLD_FWPATH" = "" ]; then 183e5384092SBen Hutchings # A zero-length write won't work; write a null byte 184e5384092SBen Hutchings printf '\000' >/sys/module/firmware_class/parameters/path 185e5384092SBen Hutchings else 186f5a61451SLuis R. Rodriguez echo -n "$OLD_FWPATH" >/sys/module/firmware_class/parameters/path 187f5a61451SLuis R. Rodriguez fi 188e5384092SBen Hutchings fi 189f5a61451SLuis R. Rodriguez if [ -f $FW ]; then 190f5a61451SLuis R. Rodriguez rm -f "$FW" 191f5a61451SLuis R. Rodriguez fi 19217980459SScott Branden if [ -f $FW_INTO_BUF ]; then 19317980459SScott Branden rm -f "$FW_INTO_BUF" 19417980459SScott Branden fi 195f5a61451SLuis R. Rodriguez if [ -d $FWPATH ]; then 196f5a61451SLuis R. Rodriguez rm -rf "$FWPATH" 197f5a61451SLuis R. Rodriguez fi 198b3cf21faSLuis R. Rodriguez proc_restore_defaults 199f5a61451SLuis R. Rodriguez} 200f5a61451SLuis R. Rodriguez 201ef557787SLuis R. Rodriguezkconfig_has() 202ef557787SLuis R. Rodriguez{ 203ef557787SLuis R. Rodriguez if [ -f $PROC_CONFIG ]; then 204ef557787SLuis R. Rodriguez if zgrep -q $1 $PROC_CONFIG 2>/dev/null; then 205ef557787SLuis R. Rodriguez echo "yes" 206ef557787SLuis R. Rodriguez else 207ef557787SLuis R. Rodriguez echo "no" 208ef557787SLuis R. Rodriguez fi 209ef557787SLuis R. Rodriguez else 210ef557787SLuis R. Rodriguez # We currently don't have easy heuristics to infer this 211ef557787SLuis R. Rodriguez # so best we can do is just try to use the kernel assuming 212ef557787SLuis R. Rodriguez # you had enabled it. This matches the old behaviour. 213ef557787SLuis R. Rodriguez if [ "$1" = "CONFIG_FW_LOADER_USER_HELPER_FALLBACK=y" ]; then 214ef557787SLuis R. Rodriguez echo "yes" 215ef557787SLuis R. Rodriguez elif [ "$1" = "CONFIG_FW_LOADER_USER_HELPER=y" ]; then 216ef557787SLuis R. Rodriguez if [ -d /sys/class/firmware/ ]; then 217ef557787SLuis R. Rodriguez echo yes 218ef557787SLuis R. Rodriguez else 219ef557787SLuis R. Rodriguez echo no 220ef557787SLuis R. Rodriguez fi 221ef557787SLuis R. Rodriguez fi 222ef557787SLuis R. Rodriguez fi 223ef557787SLuis R. Rodriguez} 224