Lines Matching +full:firmware +full:- +full:name
1 // SPDX-License-Identifier: GPL-2.0-only
3 * This module provides an interface to trigger and test firmware loading.
5 * It is designed to be used for basic evaluation of the firmware loading
6 * subsystem (for example when validating firmware verification). It lacks
8 * unless explicitly requested by name.
17 #include <linux/firmware.h>
31 #define TEST_FIRMWARE_NAME "test-firmware.bin"
36 static const struct firmware *test_firmware;
42 const struct firmware *fw;
43 const char *name; member
50 * test_config - represents configuration for the test for different triggers
52 * @name: the name of the firmware file to look for
64 * @read_fw_idx: index of thread from which we want to read firmware results
74 * information passed today on error is the fact that no firmware was
75 * found so we can only assume -ENOENT on async calls if the firmware is
83 * -EINVAL: invalid parameters or request
84 * -ENOENT: files not found
88 * -ENOMEM: memory pressure on system
89 * -ENODEV: out of number of devices to test
90 * -EINVAL: an unexpected error has occurred
95 char *name; member
111 int (*req_firmware)(const struct firmware **fw, const char *name,
125 test_firmware->data, in test_fw_misc_read()
126 test_firmware->size); in test_fw_misc_read()
141 if (!test_fw_config->reqs) in __test_release_all_firmware()
144 for (i = 0; i < test_fw_config->num_requests; i++) { in __test_release_all_firmware()
145 req = &test_fw_config->reqs[i]; in __test_release_all_firmware()
146 if (req->fw) in __test_release_all_firmware()
147 release_firmware(req->fw); in __test_release_all_firmware()
150 vfree(test_fw_config->reqs); in __test_release_all_firmware()
151 test_fw_config->reqs = NULL; in __test_release_all_firmware()
165 kfree_const(test_fw_config->name); in __test_firmware_config_free()
166 test_fw_config->name = NULL; in __test_firmware_config_free()
174 static int __kstrncpy(char **dst, const char *name, size_t count, gfp_t gfp) in __kstrncpy() argument
176 *dst = kstrndup(name, count, gfp); in __kstrncpy()
178 return -ENOSPC; in __kstrncpy()
186 ret = __kstrncpy(&test_fw_config->name, TEST_FIRMWARE_NAME, in __test_firmware_config_init()
191 test_fw_config->num_requests = TEST_FIRMWARE_NUM_REQS; in __test_firmware_config_init()
192 test_fw_config->send_uevent = true; in __test_firmware_config_init()
193 test_fw_config->into_buf = false; in __test_firmware_config_init()
194 test_fw_config->buf_size = TEST_FIRMWARE_BUF_SIZE; in __test_firmware_config_init()
195 test_fw_config->file_offset = 0; in __test_firmware_config_init()
196 test_fw_config->partial = false; in __test_firmware_config_init()
197 test_fw_config->sync_direct = false; in __test_firmware_config_init()
198 test_fw_config->req_firmware = request_firmware; in __test_firmware_config_init()
199 test_fw_config->test_result = 0; in __test_firmware_config_init()
200 test_fw_config->reqs = NULL; in __test_firmware_config_init()
221 ret = -ENOMEM; in reset_store()
245 len += scnprintf(buf, PAGE_SIZE - len, in config_show()
249 if (test_fw_config->name) in config_show()
250 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
251 "name:\t%s\n", in config_show()
252 test_fw_config->name); in config_show()
254 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
255 "name:\tEMTPY\n"); in config_show()
257 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
258 "num_requests:\t%u\n", test_fw_config->num_requests); in config_show()
260 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
262 test_fw_config->send_uevent ? in config_show()
265 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
267 test_fw_config->into_buf ? "true" : "false"); in config_show()
268 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
269 "buf_size:\t%zu\n", test_fw_config->buf_size); in config_show()
270 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
271 "file_offset:\t%zu\n", test_fw_config->file_offset); in config_show()
272 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
274 test_fw_config->partial ? "true" : "false"); in config_show()
275 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
277 test_fw_config->sync_direct ? "true" : "false"); in config_show()
278 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
279 "read_fw_idx:\t%u\n", test_fw_config->read_fw_idx); in config_show()
294 kfree_const(test_fw_config->name); in config_name_store()
295 ret = __kstrncpy(&test_fw_config->name, buf, count, GFP_KERNEL); in config_name_store()
323 ret = -EINVAL; in test_dev_config_update_bool()
391 return config_test_show_str(buf, test_fw_config->name); in config_name_show()
402 if (test_fw_config->reqs) { in config_num_requests_store()
404 rc = -EINVAL; in config_num_requests_store()
411 &test_fw_config->num_requests); in config_num_requests_store()
421 return test_dev_config_show_u8(buf, test_fw_config->num_requests); in config_num_requests_show()
431 &test_fw_config->into_buf); in config_into_buf_store()
438 return test_dev_config_show_bool(buf, test_fw_config->into_buf); in config_into_buf_show()
449 if (test_fw_config->reqs) { in config_buf_size_store()
451 rc = -EINVAL; in config_buf_size_store()
458 &test_fw_config->buf_size); in config_buf_size_store()
468 return test_dev_config_show_size_t(buf, test_fw_config->buf_size); in config_buf_size_show()
479 if (test_fw_config->reqs) { in config_file_offset_store()
481 rc = -EINVAL; in config_file_offset_store()
488 &test_fw_config->file_offset); in config_file_offset_store()
498 return test_dev_config_show_size_t(buf, test_fw_config->file_offset); in config_file_offset_show()
508 &test_fw_config->partial); in config_partial_store()
515 return test_dev_config_show_bool(buf, test_fw_config->partial); in config_partial_show()
524 &test_fw_config->sync_direct); in config_sync_direct_store()
527 test_fw_config->req_firmware = test_fw_config->sync_direct ? in config_sync_direct_store()
537 return test_dev_config_show_bool(buf, test_fw_config->sync_direct); in config_sync_direct_show()
546 &test_fw_config->send_uevent); in config_send_uevent_store()
553 return test_dev_config_show_bool(buf, test_fw_config->send_uevent); in config_send_uevent_show()
562 &test_fw_config->read_fw_idx); in config_read_fw_idx_store()
569 return test_dev_config_show_u8(buf, test_fw_config->read_fw_idx); in config_read_fw_idx_show()
579 char *name; in trigger_request_store() local
581 name = kstrndup(buf, count, GFP_KERNEL); in trigger_request_store()
582 if (!name) in trigger_request_store()
583 return -ENOSPC; in trigger_request_store()
585 pr_info("loading '%s'\n", name); in trigger_request_store()
590 rc = request_firmware(&test_firmware, name, dev); in trigger_request_store()
592 pr_info("load of '%s' failed: %d\n", name, rc); in trigger_request_store()
595 pr_info("loaded: %zu\n", test_firmware->size); in trigger_request_store()
601 kfree(name); in trigger_request_store()
622 const struct firmware *firmware = NULL; in trigger_request_platform_store() local
624 char *name; in trigger_request_platform_store() local
627 name = kstrndup(buf, count, GFP_KERNEL); in trigger_request_platform_store()
628 if (!name) in trigger_request_platform_store()
629 return -ENOSPC; in trigger_request_platform_store()
631 pr_info("inserting test platform fw '%s'\n", name); in trigger_request_platform_store()
632 efi_embedded_fw.name = name; in trigger_request_platform_store()
639 pr_info("loading '%s'\n", name); in trigger_request_platform_store()
640 rc = firmware_request_platform(&firmware, name, dev); in trigger_request_platform_store()
642 pr_info("load of '%s' failed: %d\n", name, rc); in trigger_request_platform_store()
645 if (firmware->size != sizeof(test_data) || in trigger_request_platform_store()
646 memcmp(firmware->data, test_data, sizeof(test_data)) != 0) { in trigger_request_platform_store()
647 pr_info("firmware contents mismatch for '%s'\n", name); in trigger_request_platform_store()
648 rc = -EINVAL; in trigger_request_platform_store()
651 pr_info("loaded: %zu\n", firmware->size); in trigger_request_platform_store()
656 release_firmware(firmware); in trigger_request_platform_store()
658 kfree(name); in trigger_request_platform_store()
667 static void trigger_async_request_cb(const struct firmware *fw, void *context) in trigger_async_request_cb()
678 char *name; in trigger_async_request_store() local
680 name = kstrndup(buf, count, GFP_KERNEL); in trigger_async_request_store()
681 if (!name) in trigger_async_request_store()
682 return -ENOSPC; in trigger_async_request_store()
684 pr_info("loading '%s'\n", name); in trigger_async_request_store()
689 rc = request_firmware_nowait(THIS_MODULE, 1, name, dev, GFP_KERNEL, in trigger_async_request_store()
692 pr_info("async load of '%s' failed: %d\n", name, rc); in trigger_async_request_store()
693 kfree(name); in trigger_async_request_store()
696 /* Free 'name' ASAP, to test for race conditions */ in trigger_async_request_store()
697 kfree(name); in trigger_async_request_store()
702 pr_info("loaded: %zu\n", test_firmware->size); in trigger_async_request_store()
705 pr_err("failed to async load firmware\n"); in trigger_async_request_store()
706 rc = -ENOMEM; in trigger_async_request_store()
721 char *name; in trigger_custom_fallback_store() local
723 name = kstrndup(buf, count, GFP_KERNEL); in trigger_custom_fallback_store()
724 if (!name) in trigger_custom_fallback_store()
725 return -ENOSPC; in trigger_custom_fallback_store()
727 pr_info("loading '%s' using custom fallback mechanism\n", name); in trigger_custom_fallback_store()
732 rc = request_firmware_nowait(THIS_MODULE, FW_ACTION_NOUEVENT, name, in trigger_custom_fallback_store()
736 pr_info("async load of '%s' failed: %d\n", name, rc); in trigger_custom_fallback_store()
737 kfree(name); in trigger_custom_fallback_store()
740 /* Free 'name' ASAP, to test for race conditions */ in trigger_custom_fallback_store()
741 kfree(name); in trigger_custom_fallback_store()
746 pr_info("loaded: %zu\n", test_firmware->size); in trigger_custom_fallback_store()
749 pr_err("failed to async load firmware\n"); in trigger_custom_fallback_store()
750 rc = -ENODEV; in trigger_custom_fallback_store()
765 test_fw_config->test_result = -EINVAL; in test_fw_run_batch_request()
766 return -EINVAL; in test_fw_run_batch_request()
769 if (test_fw_config->into_buf) { in test_fw_run_batch_request()
774 return -ENOSPC; in test_fw_run_batch_request()
776 if (test_fw_config->partial) in test_fw_run_batch_request()
777 req->rc = request_partial_firmware_into_buf in test_fw_run_batch_request()
778 (&req->fw, in test_fw_run_batch_request()
779 req->name, in test_fw_run_batch_request()
780 req->dev, in test_fw_run_batch_request()
782 test_fw_config->buf_size, in test_fw_run_batch_request()
783 test_fw_config->file_offset); in test_fw_run_batch_request()
785 req->rc = request_firmware_into_buf in test_fw_run_batch_request()
786 (&req->fw, in test_fw_run_batch_request()
787 req->name, in test_fw_run_batch_request()
788 req->dev, in test_fw_run_batch_request()
790 test_fw_config->buf_size); in test_fw_run_batch_request()
791 if (!req->fw) in test_fw_run_batch_request()
794 req->rc = test_fw_config->req_firmware(&req->fw, in test_fw_run_batch_request()
795 req->name, in test_fw_run_batch_request()
796 req->dev); in test_fw_run_batch_request()
799 if (req->rc) { in test_fw_run_batch_request()
801 req->idx, req->rc); in test_fw_run_batch_request()
802 if (!test_fw_config->test_result) in test_fw_run_batch_request()
803 test_fw_config->test_result = req->rc; in test_fw_run_batch_request()
804 } else if (req->fw) { in test_fw_run_batch_request()
805 req->sent = true; in test_fw_run_batch_request()
807 req->idx, req->fw->size); in test_fw_run_batch_request()
809 complete(&req->completion); in test_fw_run_batch_request()
811 req->task = NULL; in test_fw_run_batch_request()
820 * multiple cards are used and firmware loading happens outside of probe.
832 test_fw_config->reqs = in trigger_batched_requests_store()
834 test_fw_config->num_requests, 2)); in trigger_batched_requests_store()
835 if (!test_fw_config->reqs) { in trigger_batched_requests_store()
836 rc = -ENOMEM; in trigger_batched_requests_store()
840 pr_info("batched sync firmware loading '%s' %u times\n", in trigger_batched_requests_store()
841 test_fw_config->name, test_fw_config->num_requests); in trigger_batched_requests_store()
843 for (i = 0; i < test_fw_config->num_requests; i++) { in trigger_batched_requests_store()
844 req = &test_fw_config->reqs[i]; in trigger_batched_requests_store()
845 req->fw = NULL; in trigger_batched_requests_store()
846 req->idx = i; in trigger_batched_requests_store()
847 req->name = test_fw_config->name; in trigger_batched_requests_store()
848 req->dev = dev; in trigger_batched_requests_store()
849 init_completion(&req->completion); in trigger_batched_requests_store()
850 req->task = kthread_run(test_fw_run_batch_request, req, in trigger_batched_requests_store()
851 "%s-%u", KBUILD_MODNAME, req->idx); in trigger_batched_requests_store()
852 if (!req->task || IS_ERR(req->task)) { in trigger_batched_requests_store()
853 pr_err("Setting up thread %u failed\n", req->idx); in trigger_batched_requests_store()
854 req->task = NULL; in trigger_batched_requests_store()
855 rc = -ENOMEM; in trigger_batched_requests_store()
866 * then we might miss on an opportunity of having a successful firmware in trigger_batched_requests_store()
871 for (i = 0; i < test_fw_config->num_requests; i++) { in trigger_batched_requests_store()
872 req = &test_fw_config->reqs[i]; in trigger_batched_requests_store()
873 if (req->task || req->sent) in trigger_batched_requests_store()
874 wait_for_completion(&req->completion); in trigger_batched_requests_store()
879 test_fw_config->test_result = rc; in trigger_batched_requests_store()
891 static void trigger_batched_cb(const struct firmware *fw, void *context) in trigger_batched_cb()
896 test_fw_config->test_result = -EINVAL; in trigger_batched_cb()
901 if (!req->idx) in trigger_batched_cb()
904 req->fw = fw; in trigger_batched_cb()
907 * Unfortunately the firmware API gives us nothing other than a null FW in trigger_batched_cb()
908 * if the firmware was not found on async requests. Best we can do is in trigger_batched_cb()
909 * just assume -ENOENT. A better API would pass the actual return in trigger_batched_cb()
912 if (!fw && !test_fw_config->test_result) in trigger_batched_cb()
913 test_fw_config->test_result = -ENOENT; in trigger_batched_cb()
915 complete(&req->completion); in trigger_batched_cb()
930 test_fw_config->reqs = in trigger_batched_requests_async_store()
932 test_fw_config->num_requests, 2)); in trigger_batched_requests_async_store()
933 if (!test_fw_config->reqs) { in trigger_batched_requests_async_store()
934 rc = -ENOMEM; in trigger_batched_requests_async_store()
939 test_fw_config->name, test_fw_config->num_requests); in trigger_batched_requests_async_store()
941 send_uevent = test_fw_config->send_uevent ? FW_ACTION_UEVENT : in trigger_batched_requests_async_store()
944 for (i = 0; i < test_fw_config->num_requests; i++) { in trigger_batched_requests_async_store()
945 req = &test_fw_config->reqs[i]; in trigger_batched_requests_async_store()
946 req->name = test_fw_config->name; in trigger_batched_requests_async_store()
947 req->fw = NULL; in trigger_batched_requests_async_store()
948 req->idx = i; in trigger_batched_requests_async_store()
949 init_completion(&req->completion); in trigger_batched_requests_async_store()
951 req->name, in trigger_batched_requests_async_store()
957 req->rc = rc; in trigger_batched_requests_async_store()
960 req->sent = true; in trigger_batched_requests_async_store()
971 * then we might miss on an opportunity of having a successful firmware in trigger_batched_requests_async_store()
975 for (i = 0; i < test_fw_config->num_requests; i++) { in trigger_batched_requests_async_store()
976 req = &test_fw_config->reqs[i]; in trigger_batched_requests_async_store()
977 if (req->sent) in trigger_batched_requests_async_store()
978 wait_for_completion(&req->completion); in trigger_batched_requests_async_store()
983 test_fw_config->test_result = rc; in trigger_batched_requests_async_store()
996 return test_dev_config_show_int(buf, test_fw_config->test_result); in test_result_show()
1019 idx = test_fw_config->read_fw_idx; in read_firmware_show()
1020 if (idx >= test_fw_config->num_requests) { in read_firmware_show()
1021 rc = -ERANGE; in read_firmware_show()
1025 if (!test_fw_config->reqs) { in read_firmware_show()
1026 rc = -EINVAL; in read_firmware_show()
1030 req = &test_fw_config->reqs[idx]; in read_firmware_show()
1031 if (!req->fw) { in read_firmware_show()
1032 pr_err("#%u: failed to async load firmware\n", idx); in read_firmware_show()
1033 rc = -ENOENT; in read_firmware_show()
1037 pr_info("#%u: loaded %zu\n", idx, req->fw->size); in read_firmware_show()
1039 if (req->fw->size > PAGE_SIZE) { in read_firmware_show()
1040 pr_err("Testing interface must use PAGE_SIZE firmware for now\n"); in read_firmware_show()
1041 rc = -EINVAL; in read_firmware_show()
1044 memcpy(buf, req->fw->data, req->fw->size); in read_firmware_show()
1046 rc = req->fw->size; in read_firmware_show()
1054 #define TEST_FW_DEV_ATTR(name) &dev_attr_##name.attr argument
1070 /* These don't use the config at all - they could be ported! */
1092 .name = "test_firmware",
1103 return -ENOMEM; in test_firmware_init()
1108 pr_err("could not init firmware test config: %d\n", rc); in test_firmware_init()