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
51 * test_config - represents configuration for the test for different triggers
53 * @name: the name of the firmware file to look for
65 * @read_fw_idx: index of thread from which we want to read firmware results
75 * information passed today on error is the fact that no firmware was
76 * found so we can only assume -ENOENT on async calls if the firmware is
84 * -EINVAL: invalid parameters or request
85 * -ENOENT: files not found
89 * -ENOMEM: memory pressure on system
90 * -ENODEV: out of number of devices to test
91 * -EINVAL: an unexpected error has occurred
96 char *name; member
112 int (*req_firmware)(const struct firmware **fw, const char *name,
126 test_firmware->data, in test_fw_misc_read()
127 test_firmware->size); in test_fw_misc_read()
142 if (!test_fw_config->reqs) in __test_release_all_firmware()
145 for (i = 0; i < test_fw_config->num_requests; i++) { in __test_release_all_firmware()
146 req = &test_fw_config->reqs[i]; in __test_release_all_firmware()
147 if (req->fw) { in __test_release_all_firmware()
148 if (req->fw_buf) { in __test_release_all_firmware()
149 kfree_const(req->fw_buf); in __test_release_all_firmware()
150 req->fw_buf = NULL; in __test_release_all_firmware()
152 release_firmware(req->fw); in __test_release_all_firmware()
153 req->fw = NULL; in __test_release_all_firmware()
157 vfree(test_fw_config->reqs); in __test_release_all_firmware()
158 test_fw_config->reqs = NULL; in __test_release_all_firmware()
172 kfree_const(test_fw_config->name); in __test_firmware_config_free()
173 test_fw_config->name = NULL; in __test_firmware_config_free()
181 static int __kstrncpy(char **dst, const char *name, size_t count, gfp_t gfp) in __kstrncpy() argument
183 *dst = kstrndup(name, count, gfp); in __kstrncpy()
185 return -ENOSPC; in __kstrncpy()
193 ret = __kstrncpy(&test_fw_config->name, TEST_FIRMWARE_NAME, in __test_firmware_config_init()
198 test_fw_config->num_requests = TEST_FIRMWARE_NUM_REQS; in __test_firmware_config_init()
199 test_fw_config->send_uevent = true; in __test_firmware_config_init()
200 test_fw_config->into_buf = false; in __test_firmware_config_init()
201 test_fw_config->buf_size = TEST_FIRMWARE_BUF_SIZE; in __test_firmware_config_init()
202 test_fw_config->file_offset = 0; in __test_firmware_config_init()
203 test_fw_config->partial = false; in __test_firmware_config_init()
204 test_fw_config->sync_direct = false; in __test_firmware_config_init()
205 test_fw_config->req_firmware = request_firmware; in __test_firmware_config_init()
206 test_fw_config->test_result = 0; in __test_firmware_config_init()
207 test_fw_config->reqs = NULL; in __test_firmware_config_init()
228 ret = -ENOMEM; in reset_store()
252 len += scnprintf(buf, PAGE_SIZE - len, in config_show()
256 if (test_fw_config->name) in config_show()
257 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
258 "name:\t%s\n", in config_show()
259 test_fw_config->name); in config_show()
261 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
262 "name:\tEMTPY\n"); in config_show()
264 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
265 "num_requests:\t%u\n", test_fw_config->num_requests); in config_show()
267 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
269 test_fw_config->send_uevent ? in config_show()
272 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
274 test_fw_config->into_buf ? "true" : "false"); in config_show()
275 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
276 "buf_size:\t%zu\n", test_fw_config->buf_size); in config_show()
277 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
278 "file_offset:\t%zu\n", test_fw_config->file_offset); in config_show()
279 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
281 test_fw_config->partial ? "true" : "false"); in config_show()
282 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
284 test_fw_config->sync_direct ? "true" : "false"); in config_show()
285 len += scnprintf(buf + len, PAGE_SIZE - len, in config_show()
286 "read_fw_idx:\t%u\n", test_fw_config->read_fw_idx); in config_show()
301 kfree_const(test_fw_config->name); in config_name_store()
302 ret = __kstrncpy(&test_fw_config->name, buf, count, GFP_KERNEL); in config_name_store()
330 ret = -EINVAL; in test_dev_config_update_bool()
382 return -EINVAL; in test_dev_config_update_u8()
401 return config_test_show_str(buf, test_fw_config->name); in config_name_show()
412 if (test_fw_config->reqs) { in config_num_requests_store()
414 rc = -EINVAL; in config_num_requests_store()
421 &test_fw_config->num_requests); in config_num_requests_store()
431 return test_dev_config_show_u8(buf, test_fw_config->num_requests); in config_num_requests_show()
441 &test_fw_config->into_buf); in config_into_buf_store()
448 return test_dev_config_show_bool(buf, test_fw_config->into_buf); in config_into_buf_show()
459 if (test_fw_config->reqs) { in config_buf_size_store()
461 rc = -EINVAL; in config_buf_size_store()
468 &test_fw_config->buf_size); in config_buf_size_store()
478 return test_dev_config_show_size_t(buf, test_fw_config->buf_size); in config_buf_size_show()
489 if (test_fw_config->reqs) { in config_file_offset_store()
491 rc = -EINVAL; in config_file_offset_store()
498 &test_fw_config->file_offset); in config_file_offset_store()
508 return test_dev_config_show_size_t(buf, test_fw_config->file_offset); in config_file_offset_show()
518 &test_fw_config->partial); in config_partial_store()
525 return test_dev_config_show_bool(buf, test_fw_config->partial); in config_partial_show()
534 &test_fw_config->sync_direct); in config_sync_direct_store()
537 test_fw_config->req_firmware = test_fw_config->sync_direct ? in config_sync_direct_store()
547 return test_dev_config_show_bool(buf, test_fw_config->sync_direct); in config_sync_direct_show()
556 &test_fw_config->send_uevent); in config_send_uevent_store()
563 return test_dev_config_show_bool(buf, test_fw_config->send_uevent); in config_send_uevent_show()
572 &test_fw_config->read_fw_idx); in config_read_fw_idx_store()
579 return test_dev_config_show_u8(buf, test_fw_config->read_fw_idx); in config_read_fw_idx_show()
589 char *name; in trigger_request_store() local
591 name = kstrndup(buf, count, GFP_KERNEL); in trigger_request_store()
592 if (!name) in trigger_request_store()
593 return -ENOSPC; in trigger_request_store()
595 pr_info("loading '%s'\n", name); in trigger_request_store()
599 if (test_fw_config->reqs) in trigger_request_store()
602 rc = request_firmware(&test_firmware, name, dev); in trigger_request_store()
604 pr_info("load of '%s' failed: %d\n", name, rc); in trigger_request_store()
607 pr_info("loaded: %zu\n", test_firmware->size); in trigger_request_store()
613 kfree(name); in trigger_request_store()
634 const struct firmware *firmware = NULL; in trigger_request_platform_store() local
636 char *name; in trigger_request_platform_store() local
639 name = kstrndup(buf, count, GFP_KERNEL); in trigger_request_platform_store()
640 if (!name) in trigger_request_platform_store()
641 return -ENOSPC; in trigger_request_platform_store()
643 pr_info("inserting test platform fw '%s'\n", name); in trigger_request_platform_store()
644 efi_embedded_fw.name = name; in trigger_request_platform_store()
651 pr_info("loading '%s'\n", name); in trigger_request_platform_store()
652 rc = firmware_request_platform(&firmware, name, dev); in trigger_request_platform_store()
654 pr_info("load of '%s' failed: %d\n", name, rc); in trigger_request_platform_store()
657 if (firmware->size != sizeof(test_data) || in trigger_request_platform_store()
658 memcmp(firmware->data, test_data, sizeof(test_data)) != 0) { in trigger_request_platform_store()
659 pr_info("firmware contents mismatch for '%s'\n", name); in trigger_request_platform_store()
660 rc = -EINVAL; in trigger_request_platform_store()
663 pr_info("loaded: %zu\n", firmware->size); in trigger_request_platform_store()
668 release_firmware(firmware); in trigger_request_platform_store()
670 kfree(name); in trigger_request_platform_store()
679 static void trigger_async_request_cb(const struct firmware *fw, void *context) in trigger_async_request_cb()
690 char *name; in trigger_async_request_store() local
692 name = kstrndup(buf, count, GFP_KERNEL); in trigger_async_request_store()
693 if (!name) in trigger_async_request_store()
694 return -ENOSPC; in trigger_async_request_store()
696 pr_info("loading '%s'\n", name); in trigger_async_request_store()
701 if (test_fw_config->reqs) in trigger_async_request_store()
703 rc = request_firmware_nowait(THIS_MODULE, 1, name, dev, GFP_KERNEL, in trigger_async_request_store()
706 pr_info("async load of '%s' failed: %d\n", name, rc); in trigger_async_request_store()
707 kfree(name); in trigger_async_request_store()
710 /* Free 'name' ASAP, to test for race conditions */ in trigger_async_request_store()
711 kfree(name); in trigger_async_request_store()
716 pr_info("loaded: %zu\n", test_firmware->size); in trigger_async_request_store()
719 pr_err("failed to async load firmware\n"); in trigger_async_request_store()
720 rc = -ENOMEM; in trigger_async_request_store()
735 char *name; in trigger_custom_fallback_store() local
737 name = kstrndup(buf, count, GFP_KERNEL); in trigger_custom_fallback_store()
738 if (!name) in trigger_custom_fallback_store()
739 return -ENOSPC; in trigger_custom_fallback_store()
741 pr_info("loading '%s' using custom fallback mechanism\n", name); in trigger_custom_fallback_store()
745 if (test_fw_config->reqs) in trigger_custom_fallback_store()
748 rc = request_firmware_nowait(THIS_MODULE, FW_ACTION_NOHOTPLUG, name, in trigger_custom_fallback_store()
752 pr_info("async load of '%s' failed: %d\n", name, rc); in trigger_custom_fallback_store()
753 kfree(name); in trigger_custom_fallback_store()
756 /* Free 'name' ASAP, to test for race conditions */ in trigger_custom_fallback_store()
757 kfree(name); in trigger_custom_fallback_store()
762 pr_info("loaded: %zu\n", test_firmware->size); in trigger_custom_fallback_store()
765 pr_err("failed to async load firmware\n"); in trigger_custom_fallback_store()
766 rc = -ENODEV; in trigger_custom_fallback_store()
781 test_fw_config->test_result = -EINVAL; in test_fw_run_batch_request()
782 return -EINVAL; in test_fw_run_batch_request()
785 if (test_fw_config->into_buf) { in test_fw_run_batch_request()
790 return -ENOSPC; in test_fw_run_batch_request()
792 if (test_fw_config->partial) in test_fw_run_batch_request()
793 req->rc = request_partial_firmware_into_buf in test_fw_run_batch_request()
794 (&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()
798 test_fw_config->buf_size, in test_fw_run_batch_request()
799 test_fw_config->file_offset); in test_fw_run_batch_request()
801 req->rc = request_firmware_into_buf in test_fw_run_batch_request()
802 (&req->fw, in test_fw_run_batch_request()
803 req->name, in test_fw_run_batch_request()
804 req->dev, in test_fw_run_batch_request()
806 test_fw_config->buf_size); in test_fw_run_batch_request()
807 if (!req->fw) in test_fw_run_batch_request()
810 req->fw_buf = test_buf; in test_fw_run_batch_request()
812 req->rc = test_fw_config->req_firmware(&req->fw, in test_fw_run_batch_request()
813 req->name, in test_fw_run_batch_request()
814 req->dev); in test_fw_run_batch_request()
817 if (req->rc) { in test_fw_run_batch_request()
819 req->idx, req->rc); in test_fw_run_batch_request()
820 if (!test_fw_config->test_result) in test_fw_run_batch_request()
821 test_fw_config->test_result = req->rc; in test_fw_run_batch_request()
822 } else if (req->fw) { in test_fw_run_batch_request()
823 req->sent = true; in test_fw_run_batch_request()
825 req->idx, req->fw->size); in test_fw_run_batch_request()
827 complete(&req->completion); in test_fw_run_batch_request()
829 req->task = NULL; in test_fw_run_batch_request()
838 * multiple cards are used and firmware loading happens outside of probe.
850 test_fw_config->reqs = in trigger_batched_requests_store()
852 test_fw_config->num_requests, 2)); in trigger_batched_requests_store()
853 if (!test_fw_config->reqs) { in trigger_batched_requests_store()
854 rc = -ENOMEM; in trigger_batched_requests_store()
858 pr_info("batched sync firmware loading '%s' %u times\n", in trigger_batched_requests_store()
859 test_fw_config->name, test_fw_config->num_requests); in trigger_batched_requests_store()
861 for (i = 0; i < test_fw_config->num_requests; i++) { in trigger_batched_requests_store()
862 req = &test_fw_config->reqs[i]; in trigger_batched_requests_store()
863 req->fw = NULL; in trigger_batched_requests_store()
864 req->idx = i; in trigger_batched_requests_store()
865 req->name = test_fw_config->name; in trigger_batched_requests_store()
866 req->fw_buf = NULL; in trigger_batched_requests_store()
867 req->dev = dev; in trigger_batched_requests_store()
868 init_completion(&req->completion); in trigger_batched_requests_store()
869 req->task = kthread_run(test_fw_run_batch_request, req, in trigger_batched_requests_store()
870 "%s-%u", KBUILD_MODNAME, req->idx); in trigger_batched_requests_store()
871 if (!req->task || IS_ERR(req->task)) { in trigger_batched_requests_store()
872 pr_err("Setting up thread %u failed\n", req->idx); in trigger_batched_requests_store()
873 req->task = NULL; in trigger_batched_requests_store()
874 rc = -ENOMEM; in trigger_batched_requests_store()
885 * then we might miss on an opportunity of having a successful firmware in trigger_batched_requests_store()
890 for (i = 0; i < test_fw_config->num_requests; i++) { in trigger_batched_requests_store()
891 req = &test_fw_config->reqs[i]; in trigger_batched_requests_store()
892 if (req->task || req->sent) in trigger_batched_requests_store()
893 wait_for_completion(&req->completion); in trigger_batched_requests_store()
898 test_fw_config->test_result = rc; in trigger_batched_requests_store()
910 static void trigger_batched_cb(const struct firmware *fw, void *context) in trigger_batched_cb()
915 test_fw_config->test_result = -EINVAL; in trigger_batched_cb()
920 if (!req->idx) in trigger_batched_cb()
923 req->fw = fw; in trigger_batched_cb()
926 * Unfortunately the firmware API gives us nothing other than a null FW in trigger_batched_cb()
927 * if the firmware was not found on async requests. Best we can do is in trigger_batched_cb()
928 * just assume -ENOENT. A better API would pass the actual return in trigger_batched_cb()
931 if (!fw && !test_fw_config->test_result) in trigger_batched_cb()
932 test_fw_config->test_result = -ENOENT; in trigger_batched_cb()
934 complete(&req->completion); in trigger_batched_cb()
949 test_fw_config->reqs = in trigger_batched_requests_async_store()
951 test_fw_config->num_requests, 2)); in trigger_batched_requests_async_store()
952 if (!test_fw_config->reqs) { in trigger_batched_requests_async_store()
953 rc = -ENOMEM; in trigger_batched_requests_async_store()
958 test_fw_config->name, test_fw_config->num_requests); in trigger_batched_requests_async_store()
960 send_uevent = test_fw_config->send_uevent ? FW_ACTION_HOTPLUG : in trigger_batched_requests_async_store()
963 for (i = 0; i < test_fw_config->num_requests; i++) { in trigger_batched_requests_async_store()
964 req = &test_fw_config->reqs[i]; in trigger_batched_requests_async_store()
965 req->name = test_fw_config->name; in trigger_batched_requests_async_store()
966 req->fw_buf = NULL; in trigger_batched_requests_async_store()
967 req->fw = NULL; in trigger_batched_requests_async_store()
968 req->idx = i; in trigger_batched_requests_async_store()
969 init_completion(&req->completion); in trigger_batched_requests_async_store()
971 req->name, in trigger_batched_requests_async_store()
977 req->rc = rc; in trigger_batched_requests_async_store()
980 req->sent = true; in trigger_batched_requests_async_store()
991 * then we might miss on an opportunity of having a successful firmware in trigger_batched_requests_async_store()
995 for (i = 0; i < test_fw_config->num_requests; i++) { in trigger_batched_requests_async_store()
996 req = &test_fw_config->reqs[i]; in trigger_batched_requests_async_store()
997 if (req->sent) in trigger_batched_requests_async_store()
998 wait_for_completion(&req->completion); in trigger_batched_requests_async_store()
1003 test_fw_config->test_result = rc; in trigger_batched_requests_async_store()
1016 return test_dev_config_show_int(buf, test_fw_config->test_result); in test_result_show()
1039 idx = test_fw_config->read_fw_idx; in read_firmware_show()
1040 if (idx >= test_fw_config->num_requests) { in read_firmware_show()
1041 rc = -ERANGE; in read_firmware_show()
1045 if (!test_fw_config->reqs) { in read_firmware_show()
1046 rc = -EINVAL; in read_firmware_show()
1050 req = &test_fw_config->reqs[idx]; in read_firmware_show()
1051 if (!req->fw) { in read_firmware_show()
1052 pr_err("#%u: failed to async load firmware\n", idx); in read_firmware_show()
1053 rc = -ENOENT; in read_firmware_show()
1057 pr_info("#%u: loaded %zu\n", idx, req->fw->size); in read_firmware_show()
1059 if (req->fw->size > PAGE_SIZE) { in read_firmware_show()
1060 pr_err("Testing interface must use PAGE_SIZE firmware for now\n"); in read_firmware_show()
1061 rc = -EINVAL; in read_firmware_show()
1064 memcpy(buf, req->fw->data, req->fw->size); in read_firmware_show()
1066 rc = req->fw->size; in read_firmware_show()
1074 #define TEST_FW_DEV_ATTR(name) &dev_attr_##name.attr argument
1090 /* These don't use the config at all - they could be ported! */
1112 .name = "test_firmware",
1123 return -ENOMEM; in test_firmware_init()
1128 pr_err("could not init firmware test config: %d\n", rc); in test_firmware_init()