fw_filesystem.sh 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. #!/bin/bash
  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.
  7. set -e
  8. TEST_REQS_FW_SYSFS_FALLBACK="no"
  9. TEST_REQS_FW_SET_CUSTOM_PATH="yes"
  10. TEST_DIR=$(dirname $0)
  11. source $TEST_DIR/fw_lib.sh
  12. check_mods
  13. check_setup
  14. verify_reqs
  15. setup_tmp_file
  16. trap "test_finish" EXIT
  17. if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
  18. # Turn down the timeout so failures don't take so long.
  19. echo 1 >/sys/class/firmware/timeout
  20. fi
  21. if printf '\000' >"$DIR"/trigger_request 2> /dev/null; then
  22. echo "$0: empty filename should not succeed" >&2
  23. exit 1
  24. fi
  25. if [ ! -e "$DIR"/trigger_async_request ]; then
  26. echo "$0: empty filename: async trigger not present, ignoring test" >&2
  27. exit $ksft_skip
  28. else
  29. if printf '\000' >"$DIR"/trigger_async_request 2> /dev/null; then
  30. echo "$0: empty filename should not succeed (async)" >&2
  31. exit 1
  32. fi
  33. fi
  34. # Request a firmware that doesn't exist, it should fail.
  35. if echo -n "nope-$NAME" >"$DIR"/trigger_request 2> /dev/null; then
  36. echo "$0: firmware shouldn't have loaded" >&2
  37. exit 1
  38. fi
  39. if diff -q "$FW" /dev/test_firmware >/dev/null ; then
  40. echo "$0: firmware was not expected to match" >&2
  41. exit 1
  42. else
  43. if [ "$HAS_FW_LOADER_USER_HELPER" = "yes" ]; then
  44. echo "$0: timeout works"
  45. fi
  46. fi
  47. # This should succeed via kernel load or will fail after 1 second after
  48. # being handed over to the user helper, which won't find the fw either.
  49. if ! echo -n "$NAME" >"$DIR"/trigger_request ; then
  50. echo "$0: could not trigger request" >&2
  51. exit 1
  52. fi
  53. # Verify the contents are what we expect.
  54. if ! diff -q "$FW" /dev/test_firmware >/dev/null ; then
  55. echo "$0: firmware was not loaded" >&2
  56. exit 1
  57. else
  58. echo "$0: filesystem loading works"
  59. fi
  60. # Try the asynchronous version too
  61. if [ ! -e "$DIR"/trigger_async_request ]; then
  62. echo "$0: firmware loading: async trigger not present, ignoring test" >&2
  63. exit $ksft_skip
  64. else
  65. if ! echo -n "$NAME" >"$DIR"/trigger_async_request ; then
  66. echo "$0: could not trigger async request" >&2
  67. exit 1
  68. fi
  69. # Verify the contents are what we expect.
  70. if ! diff -q "$FW" /dev/test_firmware >/dev/null ; then
  71. echo "$0: firmware was not loaded (async)" >&2
  72. exit 1
  73. else
  74. echo "$0: async filesystem loading works"
  75. fi
  76. fi
  77. ### Batched requests tests
  78. test_config_present()
  79. {
  80. if [ ! -f $DIR/reset ]; then
  81. echo "Configuration triggers not present, ignoring test"
  82. exit $ksft_skip
  83. fi
  84. }
  85. # Defaults :
  86. #
  87. # send_uevent: 1
  88. # sync_direct: 0
  89. # name: test-firmware.bin
  90. # num_requests: 4
  91. config_reset()
  92. {
  93. echo 1 > $DIR/reset
  94. }
  95. release_all_firmware()
  96. {
  97. echo 1 > $DIR/release_all_firmware
  98. }
  99. config_set_name()
  100. {
  101. echo -n $1 > $DIR/config_name
  102. }
  103. config_set_sync_direct()
  104. {
  105. echo 1 > $DIR/config_sync_direct
  106. }
  107. config_unset_sync_direct()
  108. {
  109. echo 0 > $DIR/config_sync_direct
  110. }
  111. config_set_uevent()
  112. {
  113. echo 1 > $DIR/config_send_uevent
  114. }
  115. config_unset_uevent()
  116. {
  117. echo 0 > $DIR/config_send_uevent
  118. }
  119. config_trigger_sync()
  120. {
  121. echo -n 1 > $DIR/trigger_batched_requests 2>/dev/null
  122. }
  123. config_trigger_async()
  124. {
  125. echo -n 1 > $DIR/trigger_batched_requests_async 2> /dev/null
  126. }
  127. config_set_read_fw_idx()
  128. {
  129. echo -n $1 > $DIR/config_read_fw_idx 2> /dev/null
  130. }
  131. read_firmwares()
  132. {
  133. for i in $(seq 0 3); do
  134. config_set_read_fw_idx $i
  135. # Verify the contents are what we expect.
  136. # -Z required for now -- check for yourself, md5sum
  137. # on $FW and DIR/read_firmware will yield the same. Even
  138. # cmp agrees, so something is off.
  139. if ! diff -q -Z "$FW" $DIR/read_firmware 2>/dev/null ; then
  140. echo "request #$i: firmware was not loaded" >&2
  141. exit 1
  142. fi
  143. done
  144. }
  145. read_firmwares_expect_nofile()
  146. {
  147. for i in $(seq 0 3); do
  148. config_set_read_fw_idx $i
  149. # Ensures contents differ
  150. if diff -q -Z "$FW" $DIR/read_firmware 2>/dev/null ; then
  151. echo "request $i: file was not expected to match" >&2
  152. exit 1
  153. fi
  154. done
  155. }
  156. test_batched_request_firmware_nofile()
  157. {
  158. echo -n "Batched request_firmware() nofile try #$1: "
  159. config_reset
  160. config_set_name nope-test-firmware.bin
  161. config_trigger_sync
  162. read_firmwares_expect_nofile
  163. release_all_firmware
  164. echo "OK"
  165. }
  166. test_batched_request_firmware_direct_nofile()
  167. {
  168. echo -n "Batched request_firmware_direct() nofile try #$1: "
  169. config_reset
  170. config_set_name nope-test-firmware.bin
  171. config_set_sync_direct
  172. config_trigger_sync
  173. release_all_firmware
  174. echo "OK"
  175. }
  176. test_request_firmware_nowait_uevent_nofile()
  177. {
  178. echo -n "Batched request_firmware_nowait(uevent=true) nofile try #$1: "
  179. config_reset
  180. config_set_name nope-test-firmware.bin
  181. config_trigger_async
  182. release_all_firmware
  183. echo "OK"
  184. }
  185. test_wait_and_cancel_custom_load()
  186. {
  187. if [ "$HAS_FW_LOADER_USER_HELPER" != "yes" ]; then
  188. return
  189. fi
  190. local timeout=10
  191. name=$1
  192. while [ ! -e "$DIR"/"$name"/loading ]; do
  193. sleep 0.1
  194. timeout=$(( $timeout - 1 ))
  195. if [ "$timeout" -eq 0 ]; then
  196. echo "firmware interface never appeared:" >&2
  197. echo "$DIR/$name/loading" >&2
  198. exit 1
  199. fi
  200. done
  201. echo -1 >"$DIR"/"$name"/loading
  202. }
  203. test_request_firmware_nowait_custom_nofile()
  204. {
  205. echo -n "Batched request_firmware_nowait(uevent=false) nofile try #$1: "
  206. config_reset
  207. config_unset_uevent
  208. RANDOM_FILE_PATH=$(setup_random_file_fake)
  209. RANDOM_FILE="$(basename $RANDOM_FILE_PATH)"
  210. config_set_name $RANDOM_FILE
  211. config_trigger_async &
  212. test_wait_and_cancel_custom_load $RANDOM_FILE
  213. wait
  214. release_all_firmware
  215. echo "OK"
  216. }
  217. test_batched_request_firmware()
  218. {
  219. echo -n "Batched request_firmware() try #$1: "
  220. config_reset
  221. config_trigger_sync
  222. read_firmwares
  223. release_all_firmware
  224. echo "OK"
  225. }
  226. test_batched_request_firmware_direct()
  227. {
  228. echo -n "Batched request_firmware_direct() try #$1: "
  229. config_reset
  230. config_set_sync_direct
  231. config_trigger_sync
  232. release_all_firmware
  233. echo "OK"
  234. }
  235. test_request_firmware_nowait_uevent()
  236. {
  237. echo -n "Batched request_firmware_nowait(uevent=true) try #$1: "
  238. config_reset
  239. config_trigger_async
  240. release_all_firmware
  241. echo "OK"
  242. }
  243. test_request_firmware_nowait_custom()
  244. {
  245. echo -n "Batched request_firmware_nowait(uevent=false) try #$1: "
  246. config_reset
  247. config_unset_uevent
  248. RANDOM_FILE_PATH=$(setup_random_file)
  249. RANDOM_FILE="$(basename $RANDOM_FILE_PATH)"
  250. config_set_name $RANDOM_FILE
  251. config_trigger_async
  252. release_all_firmware
  253. echo "OK"
  254. }
  255. # Only continue if batched request triggers are present on the
  256. # test-firmware driver
  257. test_config_present
  258. # test with the file present
  259. echo
  260. echo "Testing with the file present..."
  261. for i in $(seq 1 5); do
  262. test_batched_request_firmware $i
  263. done
  264. for i in $(seq 1 5); do
  265. test_batched_request_firmware_direct $i
  266. done
  267. for i in $(seq 1 5); do
  268. test_request_firmware_nowait_uevent $i
  269. done
  270. for i in $(seq 1 5); do
  271. test_request_firmware_nowait_custom $i
  272. done
  273. # Test for file not found, errors are expected, the failure would be
  274. # a hung task, which would require a hard reset.
  275. echo
  276. echo "Testing with the file missing..."
  277. for i in $(seq 1 5); do
  278. test_batched_request_firmware_nofile $i
  279. done
  280. for i in $(seq 1 5); do
  281. test_batched_request_firmware_direct_nofile $i
  282. done
  283. for i in $(seq 1 5); do
  284. test_request_firmware_nowait_uevent_nofile $i
  285. done
  286. for i in $(seq 1 5); do
  287. test_request_firmware_nowait_custom_nofile $i
  288. done
  289. exit 0