xref: /linux-6.15/lib/test_firmware.c (revision 09c434b8)
1*09c434b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
20a8adf58SKees Cook /*
30a8adf58SKees Cook  * This module provides an interface to trigger and test firmware loading.
40a8adf58SKees Cook  *
50a8adf58SKees Cook  * It is designed to be used for basic evaluation of the firmware loading
60a8adf58SKees Cook  * subsystem (for example when validating firmware verification). It lacks
70a8adf58SKees Cook  * any extra dependencies, and will not normally be loaded by the system
80a8adf58SKees Cook  * unless explicitly requested by name.
90a8adf58SKees Cook  */
100a8adf58SKees Cook 
110a8adf58SKees Cook #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
120a8adf58SKees Cook 
130a8adf58SKees Cook #include <linux/init.h>
140a8adf58SKees Cook #include <linux/module.h>
150a8adf58SKees Cook #include <linux/printk.h>
16eb910947SBrian Norris #include <linux/completion.h>
170a8adf58SKees Cook #include <linux/firmware.h>
180a8adf58SKees Cook #include <linux/device.h>
190a8adf58SKees Cook #include <linux/fs.h>
200a8adf58SKees Cook #include <linux/miscdevice.h>
210a8adf58SKees Cook #include <linux/slab.h>
220a8adf58SKees Cook #include <linux/uaccess.h>
23c92316bfSLuis R. Rodriguez #include <linux/delay.h>
24c92316bfSLuis R. Rodriguez #include <linux/kthread.h>
25514c6032SRandy Dunlap #include <linux/vmalloc.h>
26c92316bfSLuis R. Rodriguez 
27c92316bfSLuis R. Rodriguez #define TEST_FIRMWARE_NAME	"test-firmware.bin"
28c92316bfSLuis R. Rodriguez #define TEST_FIRMWARE_NUM_REQS	4
290a8adf58SKees Cook 
300a8adf58SKees Cook static DEFINE_MUTEX(test_fw_mutex);
310a8adf58SKees Cook static const struct firmware *test_firmware;
320a8adf58SKees Cook 
33c92316bfSLuis R. Rodriguez struct test_batched_req {
34c92316bfSLuis R. Rodriguez 	u8 idx;
35c92316bfSLuis R. Rodriguez 	int rc;
36c92316bfSLuis R. Rodriguez 	bool sent;
37c92316bfSLuis R. Rodriguez 	const struct firmware *fw;
38c92316bfSLuis R. Rodriguez 	const char *name;
39c92316bfSLuis R. Rodriguez 	struct completion completion;
40c92316bfSLuis R. Rodriguez 	struct task_struct *task;
41c92316bfSLuis R. Rodriguez 	struct device *dev;
42c92316bfSLuis R. Rodriguez };
43c92316bfSLuis R. Rodriguez 
44c92316bfSLuis R. Rodriguez /**
45c92316bfSLuis R. Rodriguez  * test_config - represents configuration for the test for different triggers
46c92316bfSLuis R. Rodriguez  *
47c92316bfSLuis R. Rodriguez  * @name: the name of the firmware file to look for
48c92316bfSLuis R. Rodriguez  * @sync_direct: when the sync trigger is used if this is true
49c92316bfSLuis R. Rodriguez  *	request_firmware_direct() will be used instead.
50c92316bfSLuis R. Rodriguez  * @send_uevent: whether or not to send a uevent for async requests
51c92316bfSLuis R. Rodriguez  * @num_requests: number of requests to try per test case. This is trigger
52c92316bfSLuis R. Rodriguez  *	specific.
53c92316bfSLuis R. Rodriguez  * @reqs: stores all requests information
54c92316bfSLuis R. Rodriguez  * @read_fw_idx: index of thread from which we want to read firmware results
55c92316bfSLuis R. Rodriguez  *	from through the read_fw trigger.
56c92316bfSLuis R. Rodriguez  * @test_result: a test may use this to collect the result from the call
57c92316bfSLuis R. Rodriguez  *	of the request_firmware*() calls used in their tests. In order of
58c92316bfSLuis R. Rodriguez  *	priority we always keep first any setup error. If no setup errors were
59c92316bfSLuis R. Rodriguez  *	found then we move on to the first error encountered while running the
60c92316bfSLuis R. Rodriguez  *	API. Note that for async calls this typically will be a successful
61c92316bfSLuis R. Rodriguez  *	result (0) unless of course you've used bogus parameters, or the system
62c92316bfSLuis R. Rodriguez  *	is out of memory.  In the async case the callback is expected to do a
63c92316bfSLuis R. Rodriguez  *	bit more homework to figure out what happened, unfortunately the only
64c92316bfSLuis R. Rodriguez  *	information passed today on error is the fact that no firmware was
65c92316bfSLuis R. Rodriguez  *	found so we can only assume -ENOENT on async calls if the firmware is
66c92316bfSLuis R. Rodriguez  *	NULL.
67c92316bfSLuis R. Rodriguez  *
68c92316bfSLuis R. Rodriguez  *	Errors you can expect:
69c92316bfSLuis R. Rodriguez  *
70c92316bfSLuis R. Rodriguez  *	API specific:
71c92316bfSLuis R. Rodriguez  *
72c92316bfSLuis R. Rodriguez  *	0:		success for sync, for async it means request was sent
73c92316bfSLuis R. Rodriguez  *	-EINVAL:	invalid parameters or request
74c92316bfSLuis R. Rodriguez  *	-ENOENT:	files not found
75c92316bfSLuis R. Rodriguez  *
76c92316bfSLuis R. Rodriguez  *	System environment:
77c92316bfSLuis R. Rodriguez  *
78c92316bfSLuis R. Rodriguez  *	-ENOMEM:	memory pressure on system
79c92316bfSLuis R. Rodriguez  *	-ENODEV:	out of number of devices to test
80c92316bfSLuis R. Rodriguez  *	-EINVAL:	an unexpected error has occurred
81c92316bfSLuis R. Rodriguez  * @req_firmware: if @sync_direct is true this is set to
82c92316bfSLuis R. Rodriguez  *	request_firmware_direct(), otherwise request_firmware()
83c92316bfSLuis R. Rodriguez  */
84c92316bfSLuis R. Rodriguez struct test_config {
85c92316bfSLuis R. Rodriguez 	char *name;
86c92316bfSLuis R. Rodriguez 	bool sync_direct;
87c92316bfSLuis R. Rodriguez 	bool send_uevent;
88c92316bfSLuis R. Rodriguez 	u8 num_requests;
89c92316bfSLuis R. Rodriguez 	u8 read_fw_idx;
90c92316bfSLuis R. Rodriguez 
91c92316bfSLuis R. Rodriguez 	/*
92c92316bfSLuis R. Rodriguez 	 * These below don't belong her but we'll move them once we create
93c92316bfSLuis R. Rodriguez 	 * a struct fw_test_device and stuff the misc_dev under there later.
94c92316bfSLuis R. Rodriguez 	 */
95c92316bfSLuis R. Rodriguez 	struct test_batched_req *reqs;
96c92316bfSLuis R. Rodriguez 	int test_result;
97c92316bfSLuis R. Rodriguez 	int (*req_firmware)(const struct firmware **fw, const char *name,
98c92316bfSLuis R. Rodriguez 			    struct device *device);
99c92316bfSLuis R. Rodriguez };
100c92316bfSLuis R. Rodriguez 
10176f8ab1bSWei Yongjun static struct test_config *test_fw_config;
102c92316bfSLuis R. Rodriguez 
1030a8adf58SKees Cook static ssize_t test_fw_misc_read(struct file *f, char __user *buf,
1040a8adf58SKees Cook 				 size_t size, loff_t *offset)
1050a8adf58SKees Cook {
1060a8adf58SKees Cook 	ssize_t rc = 0;
1070a8adf58SKees Cook 
1080a8adf58SKees Cook 	mutex_lock(&test_fw_mutex);
1090a8adf58SKees Cook 	if (test_firmware)
1100a8adf58SKees Cook 		rc = simple_read_from_buffer(buf, size, offset,
1110a8adf58SKees Cook 					     test_firmware->data,
1120a8adf58SKees Cook 					     test_firmware->size);
1130a8adf58SKees Cook 	mutex_unlock(&test_fw_mutex);
1140a8adf58SKees Cook 	return rc;
1150a8adf58SKees Cook }
1160a8adf58SKees Cook 
1170a8adf58SKees Cook static const struct file_operations test_fw_fops = {
1180a8adf58SKees Cook 	.owner          = THIS_MODULE,
1190a8adf58SKees Cook 	.read           = test_fw_misc_read,
1200a8adf58SKees Cook };
1210a8adf58SKees Cook 
122c92316bfSLuis R. Rodriguez static void __test_release_all_firmware(void)
123c92316bfSLuis R. Rodriguez {
124c92316bfSLuis R. Rodriguez 	struct test_batched_req *req;
125c92316bfSLuis R. Rodriguez 	u8 i;
126c92316bfSLuis R. Rodriguez 
127c92316bfSLuis R. Rodriguez 	if (!test_fw_config->reqs)
128c92316bfSLuis R. Rodriguez 		return;
129c92316bfSLuis R. Rodriguez 
130c92316bfSLuis R. Rodriguez 	for (i = 0; i < test_fw_config->num_requests; i++) {
131c92316bfSLuis R. Rodriguez 		req = &test_fw_config->reqs[i];
132c92316bfSLuis R. Rodriguez 		if (req->fw)
133c92316bfSLuis R. Rodriguez 			release_firmware(req->fw);
134c92316bfSLuis R. Rodriguez 	}
135c92316bfSLuis R. Rodriguez 
136c92316bfSLuis R. Rodriguez 	vfree(test_fw_config->reqs);
137c92316bfSLuis R. Rodriguez 	test_fw_config->reqs = NULL;
138c92316bfSLuis R. Rodriguez }
139c92316bfSLuis R. Rodriguez 
140c92316bfSLuis R. Rodriguez static void test_release_all_firmware(void)
141c92316bfSLuis R. Rodriguez {
142c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
143c92316bfSLuis R. Rodriguez 	__test_release_all_firmware();
144c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
145c92316bfSLuis R. Rodriguez }
146c92316bfSLuis R. Rodriguez 
147c92316bfSLuis R. Rodriguez 
148c92316bfSLuis R. Rodriguez static void __test_firmware_config_free(void)
149c92316bfSLuis R. Rodriguez {
150c92316bfSLuis R. Rodriguez 	__test_release_all_firmware();
151c92316bfSLuis R. Rodriguez 	kfree_const(test_fw_config->name);
152c92316bfSLuis R. Rodriguez 	test_fw_config->name = NULL;
153c92316bfSLuis R. Rodriguez }
154c92316bfSLuis R. Rodriguez 
155c92316bfSLuis R. Rodriguez /*
156c92316bfSLuis R. Rodriguez  * XXX: move to kstrncpy() once merged.
157c92316bfSLuis R. Rodriguez  *
158c92316bfSLuis R. Rodriguez  * Users should use kfree_const() when freeing these.
159c92316bfSLuis R. Rodriguez  */
160c92316bfSLuis R. Rodriguez static int __kstrncpy(char **dst, const char *name, size_t count, gfp_t gfp)
161c92316bfSLuis R. Rodriguez {
162c92316bfSLuis R. Rodriguez 	*dst = kstrndup(name, count, gfp);
163c92316bfSLuis R. Rodriguez 	if (!*dst)
164c92316bfSLuis R. Rodriguez 		return -ENOSPC;
165c92316bfSLuis R. Rodriguez 	return count;
166c92316bfSLuis R. Rodriguez }
167c92316bfSLuis R. Rodriguez 
168c92316bfSLuis R. Rodriguez static int __test_firmware_config_init(void)
169c92316bfSLuis R. Rodriguez {
170c92316bfSLuis R. Rodriguez 	int ret;
171c92316bfSLuis R. Rodriguez 
172c92316bfSLuis R. Rodriguez 	ret = __kstrncpy(&test_fw_config->name, TEST_FIRMWARE_NAME,
173c92316bfSLuis R. Rodriguez 			 strlen(TEST_FIRMWARE_NAME), GFP_KERNEL);
174c92316bfSLuis R. Rodriguez 	if (ret < 0)
175c92316bfSLuis R. Rodriguez 		goto out;
176c92316bfSLuis R. Rodriguez 
177c92316bfSLuis R. Rodriguez 	test_fw_config->num_requests = TEST_FIRMWARE_NUM_REQS;
178c92316bfSLuis R. Rodriguez 	test_fw_config->send_uevent = true;
179c92316bfSLuis R. Rodriguez 	test_fw_config->sync_direct = false;
180c92316bfSLuis R. Rodriguez 	test_fw_config->req_firmware = request_firmware;
181c92316bfSLuis R. Rodriguez 	test_fw_config->test_result = 0;
182c92316bfSLuis R. Rodriguez 	test_fw_config->reqs = NULL;
183c92316bfSLuis R. Rodriguez 
184c92316bfSLuis R. Rodriguez 	return 0;
185c92316bfSLuis R. Rodriguez 
186c92316bfSLuis R. Rodriguez out:
187c92316bfSLuis R. Rodriguez 	__test_firmware_config_free();
188c92316bfSLuis R. Rodriguez 	return ret;
189c92316bfSLuis R. Rodriguez }
190c92316bfSLuis R. Rodriguez 
191c92316bfSLuis R. Rodriguez static ssize_t reset_store(struct device *dev,
192c92316bfSLuis R. Rodriguez 			   struct device_attribute *attr,
193c92316bfSLuis R. Rodriguez 			   const char *buf, size_t count)
194c92316bfSLuis R. Rodriguez {
195c92316bfSLuis R. Rodriguez 	int ret;
196c92316bfSLuis R. Rodriguez 
197c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
198c92316bfSLuis R. Rodriguez 
199c92316bfSLuis R. Rodriguez 	__test_firmware_config_free();
200c92316bfSLuis R. Rodriguez 
201c92316bfSLuis R. Rodriguez 	ret = __test_firmware_config_init();
202c92316bfSLuis R. Rodriguez 	if (ret < 0) {
203c92316bfSLuis R. Rodriguez 		ret = -ENOMEM;
204c92316bfSLuis R. Rodriguez 		pr_err("could not alloc settings for config trigger: %d\n",
205c92316bfSLuis R. Rodriguez 		       ret);
206c92316bfSLuis R. Rodriguez 		goto out;
207c92316bfSLuis R. Rodriguez 	}
208c92316bfSLuis R. Rodriguez 
209c92316bfSLuis R. Rodriguez 	pr_info("reset\n");
210c92316bfSLuis R. Rodriguez 	ret = count;
211c92316bfSLuis R. Rodriguez 
212c92316bfSLuis R. Rodriguez out:
213c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
214c92316bfSLuis R. Rodriguez 
215c92316bfSLuis R. Rodriguez 	return ret;
216c92316bfSLuis R. Rodriguez }
217c92316bfSLuis R. Rodriguez static DEVICE_ATTR_WO(reset);
218c92316bfSLuis R. Rodriguez 
219c92316bfSLuis R. Rodriguez static ssize_t config_show(struct device *dev,
220c92316bfSLuis R. Rodriguez 			   struct device_attribute *attr,
221c92316bfSLuis R. Rodriguez 			   char *buf)
222c92316bfSLuis R. Rodriguez {
223c92316bfSLuis R. Rodriguez 	int len = 0;
224c92316bfSLuis R. Rodriguez 
225c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
226c92316bfSLuis R. Rodriguez 
227c92316bfSLuis R. Rodriguez 	len += snprintf(buf, PAGE_SIZE,
228c92316bfSLuis R. Rodriguez 			"Custom trigger configuration for: %s\n",
229c92316bfSLuis R. Rodriguez 			dev_name(dev));
230c92316bfSLuis R. Rodriguez 
231c92316bfSLuis R. Rodriguez 	if (test_fw_config->name)
232c92316bfSLuis R. Rodriguez 		len += snprintf(buf+len, PAGE_SIZE,
233c92316bfSLuis R. Rodriguez 				"name:\t%s\n",
234c92316bfSLuis R. Rodriguez 				test_fw_config->name);
235c92316bfSLuis R. Rodriguez 	else
236c92316bfSLuis R. Rodriguez 		len += snprintf(buf+len, PAGE_SIZE,
237c92316bfSLuis R. Rodriguez 				"name:\tEMTPY\n");
238c92316bfSLuis R. Rodriguez 
239c92316bfSLuis R. Rodriguez 	len += snprintf(buf+len, PAGE_SIZE,
240c92316bfSLuis R. Rodriguez 			"num_requests:\t%u\n", test_fw_config->num_requests);
241c92316bfSLuis R. Rodriguez 
242c92316bfSLuis R. Rodriguez 	len += snprintf(buf+len, PAGE_SIZE,
243c92316bfSLuis R. Rodriguez 			"send_uevent:\t\t%s\n",
244c92316bfSLuis R. Rodriguez 			test_fw_config->send_uevent ?
245c92316bfSLuis R. Rodriguez 			"FW_ACTION_HOTPLUG" :
246c92316bfSLuis R. Rodriguez 			"FW_ACTION_NOHOTPLUG");
247c92316bfSLuis R. Rodriguez 	len += snprintf(buf+len, PAGE_SIZE,
248c92316bfSLuis R. Rodriguez 			"sync_direct:\t\t%s\n",
249c92316bfSLuis R. Rodriguez 			test_fw_config->sync_direct ? "true" : "false");
250c92316bfSLuis R. Rodriguez 	len += snprintf(buf+len, PAGE_SIZE,
251c92316bfSLuis R. Rodriguez 			"read_fw_idx:\t%u\n", test_fw_config->read_fw_idx);
252c92316bfSLuis R. Rodriguez 
253c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
254c92316bfSLuis R. Rodriguez 
255c92316bfSLuis R. Rodriguez 	return len;
256c92316bfSLuis R. Rodriguez }
257c92316bfSLuis R. Rodriguez static DEVICE_ATTR_RO(config);
258c92316bfSLuis R. Rodriguez 
259c92316bfSLuis R. Rodriguez static ssize_t config_name_store(struct device *dev,
260c92316bfSLuis R. Rodriguez 				 struct device_attribute *attr,
261c92316bfSLuis R. Rodriguez 				 const char *buf, size_t count)
262c92316bfSLuis R. Rodriguez {
263c92316bfSLuis R. Rodriguez 	int ret;
264c92316bfSLuis R. Rodriguez 
265c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
266c92316bfSLuis R. Rodriguez 	kfree_const(test_fw_config->name);
267c92316bfSLuis R. Rodriguez 	ret = __kstrncpy(&test_fw_config->name, buf, count, GFP_KERNEL);
268c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
269c92316bfSLuis R. Rodriguez 
270c92316bfSLuis R. Rodriguez 	return ret;
271c92316bfSLuis R. Rodriguez }
272c92316bfSLuis R. Rodriguez 
273c92316bfSLuis R. Rodriguez /*
274c92316bfSLuis R. Rodriguez  * As per sysfs_kf_seq_show() the buf is max PAGE_SIZE.
275c92316bfSLuis R. Rodriguez  */
276c92316bfSLuis R. Rodriguez static ssize_t config_test_show_str(char *dst,
277c92316bfSLuis R. Rodriguez 				    char *src)
278c92316bfSLuis R. Rodriguez {
279c92316bfSLuis R. Rodriguez 	int len;
280c92316bfSLuis R. Rodriguez 
281c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
282c92316bfSLuis R. Rodriguez 	len = snprintf(dst, PAGE_SIZE, "%s\n", src);
283c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
284c92316bfSLuis R. Rodriguez 
285c92316bfSLuis R. Rodriguez 	return len;
286c92316bfSLuis R. Rodriguez }
287c92316bfSLuis R. Rodriguez 
288c92316bfSLuis R. Rodriguez static int test_dev_config_update_bool(const char *buf, size_t size,
289c92316bfSLuis R. Rodriguez 				       bool *cfg)
290c92316bfSLuis R. Rodriguez {
291c92316bfSLuis R. Rodriguez 	int ret;
292c92316bfSLuis R. Rodriguez 
293c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
294c92316bfSLuis R. Rodriguez 	if (strtobool(buf, cfg) < 0)
295c92316bfSLuis R. Rodriguez 		ret = -EINVAL;
296c92316bfSLuis R. Rodriguez 	else
297c92316bfSLuis R. Rodriguez 		ret = size;
298c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
299c92316bfSLuis R. Rodriguez 
300c92316bfSLuis R. Rodriguez 	return ret;
301c92316bfSLuis R. Rodriguez }
302c92316bfSLuis R. Rodriguez 
303c92316bfSLuis R. Rodriguez static ssize_t
304c92316bfSLuis R. Rodriguez test_dev_config_show_bool(char *buf,
305c92316bfSLuis R. Rodriguez 			  bool config)
306c92316bfSLuis R. Rodriguez {
307c92316bfSLuis R. Rodriguez 	bool val;
308c92316bfSLuis R. Rodriguez 
309c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
310c92316bfSLuis R. Rodriguez 	val = config;
311c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
312c92316bfSLuis R. Rodriguez 
313c92316bfSLuis R. Rodriguez 	return snprintf(buf, PAGE_SIZE, "%d\n", val);
314c92316bfSLuis R. Rodriguez }
315c92316bfSLuis R. Rodriguez 
316c92316bfSLuis R. Rodriguez static ssize_t test_dev_config_show_int(char *buf, int cfg)
317c92316bfSLuis R. Rodriguez {
318c92316bfSLuis R. Rodriguez 	int val;
319c92316bfSLuis R. Rodriguez 
320c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
321c92316bfSLuis R. Rodriguez 	val = cfg;
322c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
323c92316bfSLuis R. Rodriguez 
324c92316bfSLuis R. Rodriguez 	return snprintf(buf, PAGE_SIZE, "%d\n", val);
325c92316bfSLuis R. Rodriguez }
326c92316bfSLuis R. Rodriguez 
327c92316bfSLuis R. Rodriguez static int test_dev_config_update_u8(const char *buf, size_t size, u8 *cfg)
328c92316bfSLuis R. Rodriguez {
329c92316bfSLuis R. Rodriguez 	int ret;
330c92316bfSLuis R. Rodriguez 	long new;
331c92316bfSLuis R. Rodriguez 
332c92316bfSLuis R. Rodriguez 	ret = kstrtol(buf, 10, &new);
333c92316bfSLuis R. Rodriguez 	if (ret)
334c92316bfSLuis R. Rodriguez 		return ret;
335c92316bfSLuis R. Rodriguez 
336c92316bfSLuis R. Rodriguez 	if (new > U8_MAX)
337c92316bfSLuis R. Rodriguez 		return -EINVAL;
338c92316bfSLuis R. Rodriguez 
339c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
340c92316bfSLuis R. Rodriguez 	*(u8 *)cfg = new;
341c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
342c92316bfSLuis R. Rodriguez 
343c92316bfSLuis R. Rodriguez 	/* Always return full write size even if we didn't consume all */
344c92316bfSLuis R. Rodriguez 	return size;
345c92316bfSLuis R. Rodriguez }
346c92316bfSLuis R. Rodriguez 
347c92316bfSLuis R. Rodriguez static ssize_t test_dev_config_show_u8(char *buf, u8 cfg)
348c92316bfSLuis R. Rodriguez {
349c92316bfSLuis R. Rodriguez 	u8 val;
350c92316bfSLuis R. Rodriguez 
351c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
352c92316bfSLuis R. Rodriguez 	val = cfg;
353c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
354c92316bfSLuis R. Rodriguez 
355c92316bfSLuis R. Rodriguez 	return snprintf(buf, PAGE_SIZE, "%u\n", val);
356c92316bfSLuis R. Rodriguez }
357c92316bfSLuis R. Rodriguez 
358c92316bfSLuis R. Rodriguez static ssize_t config_name_show(struct device *dev,
359c92316bfSLuis R. Rodriguez 				struct device_attribute *attr,
360c92316bfSLuis R. Rodriguez 				char *buf)
361c92316bfSLuis R. Rodriguez {
362c92316bfSLuis R. Rodriguez 	return config_test_show_str(buf, test_fw_config->name);
363c92316bfSLuis R. Rodriguez }
364b6b996b6SJoe Perches static DEVICE_ATTR_RW(config_name);
365c92316bfSLuis R. Rodriguez 
366c92316bfSLuis R. Rodriguez static ssize_t config_num_requests_store(struct device *dev,
367c92316bfSLuis R. Rodriguez 					 struct device_attribute *attr,
368c92316bfSLuis R. Rodriguez 					 const char *buf, size_t count)
369c92316bfSLuis R. Rodriguez {
370c92316bfSLuis R. Rodriguez 	int rc;
371c92316bfSLuis R. Rodriguez 
372c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
373c92316bfSLuis R. Rodriguez 	if (test_fw_config->reqs) {
374c92316bfSLuis R. Rodriguez 		pr_err("Must call release_all_firmware prior to changing config\n");
375c92316bfSLuis R. Rodriguez 		rc = -EINVAL;
376a5e19233SWei Yongjun 		mutex_unlock(&test_fw_mutex);
377c92316bfSLuis R. Rodriguez 		goto out;
378c92316bfSLuis R. Rodriguez 	}
379c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
380c92316bfSLuis R. Rodriguez 
381c92316bfSLuis R. Rodriguez 	rc = test_dev_config_update_u8(buf, count,
382c92316bfSLuis R. Rodriguez 				       &test_fw_config->num_requests);
383c92316bfSLuis R. Rodriguez 
384c92316bfSLuis R. Rodriguez out:
385c92316bfSLuis R. Rodriguez 	return rc;
386c92316bfSLuis R. Rodriguez }
387c92316bfSLuis R. Rodriguez 
388c92316bfSLuis R. Rodriguez static ssize_t config_num_requests_show(struct device *dev,
389c92316bfSLuis R. Rodriguez 					struct device_attribute *attr,
390c92316bfSLuis R. Rodriguez 					char *buf)
391c92316bfSLuis R. Rodriguez {
392c92316bfSLuis R. Rodriguez 	return test_dev_config_show_u8(buf, test_fw_config->num_requests);
393c92316bfSLuis R. Rodriguez }
394b6b996b6SJoe Perches static DEVICE_ATTR_RW(config_num_requests);
395c92316bfSLuis R. Rodriguez 
396c92316bfSLuis R. Rodriguez static ssize_t config_sync_direct_store(struct device *dev,
397c92316bfSLuis R. Rodriguez 					struct device_attribute *attr,
398c92316bfSLuis R. Rodriguez 					const char *buf, size_t count)
399c92316bfSLuis R. Rodriguez {
400c92316bfSLuis R. Rodriguez 	int rc = test_dev_config_update_bool(buf, count,
401c92316bfSLuis R. Rodriguez 					     &test_fw_config->sync_direct);
402c92316bfSLuis R. Rodriguez 
403c92316bfSLuis R. Rodriguez 	if (rc == count)
404c92316bfSLuis R. Rodriguez 		test_fw_config->req_firmware = test_fw_config->sync_direct ?
405c92316bfSLuis R. Rodriguez 				       request_firmware_direct :
406c92316bfSLuis R. Rodriguez 				       request_firmware;
407c92316bfSLuis R. Rodriguez 	return rc;
408c92316bfSLuis R. Rodriguez }
409c92316bfSLuis R. Rodriguez 
410c92316bfSLuis R. Rodriguez static ssize_t config_sync_direct_show(struct device *dev,
411c92316bfSLuis R. Rodriguez 				       struct device_attribute *attr,
412c92316bfSLuis R. Rodriguez 				       char *buf)
413c92316bfSLuis R. Rodriguez {
414c92316bfSLuis R. Rodriguez 	return test_dev_config_show_bool(buf, test_fw_config->sync_direct);
415c92316bfSLuis R. Rodriguez }
416b6b996b6SJoe Perches static DEVICE_ATTR_RW(config_sync_direct);
417c92316bfSLuis R. Rodriguez 
418c92316bfSLuis R. Rodriguez static ssize_t config_send_uevent_store(struct device *dev,
419c92316bfSLuis R. Rodriguez 					struct device_attribute *attr,
420c92316bfSLuis R. Rodriguez 					const char *buf, size_t count)
421c92316bfSLuis R. Rodriguez {
422c92316bfSLuis R. Rodriguez 	return test_dev_config_update_bool(buf, count,
423c92316bfSLuis R. Rodriguez 					   &test_fw_config->send_uevent);
424c92316bfSLuis R. Rodriguez }
425c92316bfSLuis R. Rodriguez 
426c92316bfSLuis R. Rodriguez static ssize_t config_send_uevent_show(struct device *dev,
427c92316bfSLuis R. Rodriguez 				       struct device_attribute *attr,
428c92316bfSLuis R. Rodriguez 				       char *buf)
429c92316bfSLuis R. Rodriguez {
430c92316bfSLuis R. Rodriguez 	return test_dev_config_show_bool(buf, test_fw_config->send_uevent);
431c92316bfSLuis R. Rodriguez }
432b6b996b6SJoe Perches static DEVICE_ATTR_RW(config_send_uevent);
433c92316bfSLuis R. Rodriguez 
434c92316bfSLuis R. Rodriguez static ssize_t config_read_fw_idx_store(struct device *dev,
435c92316bfSLuis R. Rodriguez 					struct device_attribute *attr,
436c92316bfSLuis R. Rodriguez 					const char *buf, size_t count)
437c92316bfSLuis R. Rodriguez {
438c92316bfSLuis R. Rodriguez 	return test_dev_config_update_u8(buf, count,
439c92316bfSLuis R. Rodriguez 					 &test_fw_config->read_fw_idx);
440c92316bfSLuis R. Rodriguez }
441c92316bfSLuis R. Rodriguez 
442c92316bfSLuis R. Rodriguez static ssize_t config_read_fw_idx_show(struct device *dev,
443c92316bfSLuis R. Rodriguez 				       struct device_attribute *attr,
444c92316bfSLuis R. Rodriguez 				       char *buf)
445c92316bfSLuis R. Rodriguez {
446c92316bfSLuis R. Rodriguez 	return test_dev_config_show_u8(buf, test_fw_config->read_fw_idx);
447c92316bfSLuis R. Rodriguez }
448b6b996b6SJoe Perches static DEVICE_ATTR_RW(config_read_fw_idx);
449c92316bfSLuis R. Rodriguez 
450c92316bfSLuis R. Rodriguez 
4510a8adf58SKees Cook static ssize_t trigger_request_store(struct device *dev,
4520a8adf58SKees Cook 				     struct device_attribute *attr,
4530a8adf58SKees Cook 				     const char *buf, size_t count)
4540a8adf58SKees Cook {
4550a8adf58SKees Cook 	int rc;
4560a8adf58SKees Cook 	char *name;
4570a8adf58SKees Cook 
458be4a1326SBrian Norris 	name = kstrndup(buf, count, GFP_KERNEL);
4590a8adf58SKees Cook 	if (!name)
4600a8adf58SKees Cook 		return -ENOSPC;
4610a8adf58SKees Cook 
4620a8adf58SKees Cook 	pr_info("loading '%s'\n", name);
4630a8adf58SKees Cook 
4640a8adf58SKees Cook 	mutex_lock(&test_fw_mutex);
4650a8adf58SKees Cook 	release_firmware(test_firmware);
4660a8adf58SKees Cook 	test_firmware = NULL;
4670a8adf58SKees Cook 	rc = request_firmware(&test_firmware, name, dev);
46847e0bbb7SBrian Norris 	if (rc) {
4690a8adf58SKees Cook 		pr_info("load of '%s' failed: %d\n", name, rc);
47047e0bbb7SBrian Norris 		goto out;
47147e0bbb7SBrian Norris 	}
47247e0bbb7SBrian Norris 	pr_info("loaded: %zu\n", test_firmware->size);
47347e0bbb7SBrian Norris 	rc = count;
47447e0bbb7SBrian Norris 
47547e0bbb7SBrian Norris out:
4760a8adf58SKees Cook 	mutex_unlock(&test_fw_mutex);
4770a8adf58SKees Cook 
4780a8adf58SKees Cook 	kfree(name);
4790a8adf58SKees Cook 
48047e0bbb7SBrian Norris 	return rc;
4810a8adf58SKees Cook }
4820a8adf58SKees Cook static DEVICE_ATTR_WO(trigger_request);
4830a8adf58SKees Cook 
484eb910947SBrian Norris static DECLARE_COMPLETION(async_fw_done);
485eb910947SBrian Norris 
486eb910947SBrian Norris static void trigger_async_request_cb(const struct firmware *fw, void *context)
487eb910947SBrian Norris {
488eb910947SBrian Norris 	test_firmware = fw;
489eb910947SBrian Norris 	complete(&async_fw_done);
490eb910947SBrian Norris }
491eb910947SBrian Norris 
492eb910947SBrian Norris static ssize_t trigger_async_request_store(struct device *dev,
493eb910947SBrian Norris 					   struct device_attribute *attr,
494eb910947SBrian Norris 					   const char *buf, size_t count)
495eb910947SBrian Norris {
496eb910947SBrian Norris 	int rc;
497eb910947SBrian Norris 	char *name;
498eb910947SBrian Norris 
499eb910947SBrian Norris 	name = kstrndup(buf, count, GFP_KERNEL);
500eb910947SBrian Norris 	if (!name)
501eb910947SBrian Norris 		return -ENOSPC;
502eb910947SBrian Norris 
503eb910947SBrian Norris 	pr_info("loading '%s'\n", name);
504eb910947SBrian Norris 
505eb910947SBrian Norris 	mutex_lock(&test_fw_mutex);
506eb910947SBrian Norris 	release_firmware(test_firmware);
507eb910947SBrian Norris 	test_firmware = NULL;
508eb910947SBrian Norris 	rc = request_firmware_nowait(THIS_MODULE, 1, name, dev, GFP_KERNEL,
509eb910947SBrian Norris 				     NULL, trigger_async_request_cb);
510eb910947SBrian Norris 	if (rc) {
511eb910947SBrian Norris 		pr_info("async load of '%s' failed: %d\n", name, rc);
512eb910947SBrian Norris 		kfree(name);
513eb910947SBrian Norris 		goto out;
514eb910947SBrian Norris 	}
515eb910947SBrian Norris 	/* Free 'name' ASAP, to test for race conditions */
516eb910947SBrian Norris 	kfree(name);
517eb910947SBrian Norris 
518eb910947SBrian Norris 	wait_for_completion(&async_fw_done);
519eb910947SBrian Norris 
520eb910947SBrian Norris 	if (test_firmware) {
521eb910947SBrian Norris 		pr_info("loaded: %zu\n", test_firmware->size);
522eb910947SBrian Norris 		rc = count;
523eb910947SBrian Norris 	} else {
524eb910947SBrian Norris 		pr_err("failed to async load firmware\n");
525eb910947SBrian Norris 		rc = -ENODEV;
526eb910947SBrian Norris 	}
527eb910947SBrian Norris 
528eb910947SBrian Norris out:
529eb910947SBrian Norris 	mutex_unlock(&test_fw_mutex);
530eb910947SBrian Norris 
531eb910947SBrian Norris 	return rc;
532eb910947SBrian Norris }
533eb910947SBrian Norris static DEVICE_ATTR_WO(trigger_async_request);
534eb910947SBrian Norris 
535061132d2SLuis R. Rodriguez static ssize_t trigger_custom_fallback_store(struct device *dev,
536061132d2SLuis R. Rodriguez 					     struct device_attribute *attr,
537061132d2SLuis R. Rodriguez 					     const char *buf, size_t count)
538061132d2SLuis R. Rodriguez {
539061132d2SLuis R. Rodriguez 	int rc;
540061132d2SLuis R. Rodriguez 	char *name;
541061132d2SLuis R. Rodriguez 
542061132d2SLuis R. Rodriguez 	name = kstrndup(buf, count, GFP_KERNEL);
543061132d2SLuis R. Rodriguez 	if (!name)
544061132d2SLuis R. Rodriguez 		return -ENOSPC;
545061132d2SLuis R. Rodriguez 
546061132d2SLuis R. Rodriguez 	pr_info("loading '%s' using custom fallback mechanism\n", name);
547061132d2SLuis R. Rodriguez 
548061132d2SLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
549061132d2SLuis R. Rodriguez 	release_firmware(test_firmware);
550061132d2SLuis R. Rodriguez 	test_firmware = NULL;
551061132d2SLuis R. Rodriguez 	rc = request_firmware_nowait(THIS_MODULE, FW_ACTION_NOHOTPLUG, name,
552061132d2SLuis R. Rodriguez 				     dev, GFP_KERNEL, NULL,
553061132d2SLuis R. Rodriguez 				     trigger_async_request_cb);
554061132d2SLuis R. Rodriguez 	if (rc) {
555061132d2SLuis R. Rodriguez 		pr_info("async load of '%s' failed: %d\n", name, rc);
556061132d2SLuis R. Rodriguez 		kfree(name);
557061132d2SLuis R. Rodriguez 		goto out;
558061132d2SLuis R. Rodriguez 	}
559061132d2SLuis R. Rodriguez 	/* Free 'name' ASAP, to test for race conditions */
560061132d2SLuis R. Rodriguez 	kfree(name);
561061132d2SLuis R. Rodriguez 
562061132d2SLuis R. Rodriguez 	wait_for_completion(&async_fw_done);
563061132d2SLuis R. Rodriguez 
564061132d2SLuis R. Rodriguez 	if (test_firmware) {
565061132d2SLuis R. Rodriguez 		pr_info("loaded: %zu\n", test_firmware->size);
566061132d2SLuis R. Rodriguez 		rc = count;
567061132d2SLuis R. Rodriguez 	} else {
568061132d2SLuis R. Rodriguez 		pr_err("failed to async load firmware\n");
569061132d2SLuis R. Rodriguez 		rc = -ENODEV;
570061132d2SLuis R. Rodriguez 	}
571061132d2SLuis R. Rodriguez 
572061132d2SLuis R. Rodriguez out:
573061132d2SLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
574061132d2SLuis R. Rodriguez 
575061132d2SLuis R. Rodriguez 	return rc;
576061132d2SLuis R. Rodriguez }
577061132d2SLuis R. Rodriguez static DEVICE_ATTR_WO(trigger_custom_fallback);
578061132d2SLuis R. Rodriguez 
579c92316bfSLuis R. Rodriguez static int test_fw_run_batch_request(void *data)
580c92316bfSLuis R. Rodriguez {
581c92316bfSLuis R. Rodriguez 	struct test_batched_req *req = data;
582c92316bfSLuis R. Rodriguez 
583c92316bfSLuis R. Rodriguez 	if (!req) {
584c92316bfSLuis R. Rodriguez 		test_fw_config->test_result = -EINVAL;
585c92316bfSLuis R. Rodriguez 		return -EINVAL;
586c92316bfSLuis R. Rodriguez 	}
587c92316bfSLuis R. Rodriguez 
588c92316bfSLuis R. Rodriguez 	req->rc = test_fw_config->req_firmware(&req->fw, req->name, req->dev);
589c92316bfSLuis R. Rodriguez 	if (req->rc) {
590c92316bfSLuis R. Rodriguez 		pr_info("#%u: batched sync load failed: %d\n",
591c92316bfSLuis R. Rodriguez 			req->idx, req->rc);
592c92316bfSLuis R. Rodriguez 		if (!test_fw_config->test_result)
593c92316bfSLuis R. Rodriguez 			test_fw_config->test_result = req->rc;
594c92316bfSLuis R. Rodriguez 	} else if (req->fw) {
595c92316bfSLuis R. Rodriguez 		req->sent = true;
596c92316bfSLuis R. Rodriguez 		pr_info("#%u: batched sync loaded %zu\n",
597c92316bfSLuis R. Rodriguez 			req->idx, req->fw->size);
598c92316bfSLuis R. Rodriguez 	}
599c92316bfSLuis R. Rodriguez 	complete(&req->completion);
600c92316bfSLuis R. Rodriguez 
601c92316bfSLuis R. Rodriguez 	req->task = NULL;
602c92316bfSLuis R. Rodriguez 
603c92316bfSLuis R. Rodriguez 	return 0;
604c92316bfSLuis R. Rodriguez }
605c92316bfSLuis R. Rodriguez 
606c92316bfSLuis R. Rodriguez /*
607c92316bfSLuis R. Rodriguez  * We use a kthread as otherwise the kernel serializes all our sync requests
608c92316bfSLuis R. Rodriguez  * and we would not be able to mimic batched requests on a sync call. Batched
609c92316bfSLuis R. Rodriguez  * requests on a sync call can for instance happen on a device driver when
610c92316bfSLuis R. Rodriguez  * multiple cards are used and firmware loading happens outside of probe.
611c92316bfSLuis R. Rodriguez  */
612c92316bfSLuis R. Rodriguez static ssize_t trigger_batched_requests_store(struct device *dev,
613c92316bfSLuis R. Rodriguez 					      struct device_attribute *attr,
614c92316bfSLuis R. Rodriguez 					      const char *buf, size_t count)
615c92316bfSLuis R. Rodriguez {
616c92316bfSLuis R. Rodriguez 	struct test_batched_req *req;
617c92316bfSLuis R. Rodriguez 	int rc;
618c92316bfSLuis R. Rodriguez 	u8 i;
619c92316bfSLuis R. Rodriguez 
620c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
621c92316bfSLuis R. Rodriguez 
622fad953ceSKees Cook 	test_fw_config->reqs =
623fad953ceSKees Cook 		vzalloc(array3_size(sizeof(struct test_batched_req),
624fad953ceSKees Cook 				    test_fw_config->num_requests, 2));
625c92316bfSLuis R. Rodriguez 	if (!test_fw_config->reqs) {
626c92316bfSLuis R. Rodriguez 		rc = -ENOMEM;
627c92316bfSLuis R. Rodriguez 		goto out_unlock;
628c92316bfSLuis R. Rodriguez 	}
629c92316bfSLuis R. Rodriguez 
630c92316bfSLuis R. Rodriguez 	pr_info("batched sync firmware loading '%s' %u times\n",
631c92316bfSLuis R. Rodriguez 		test_fw_config->name, test_fw_config->num_requests);
632c92316bfSLuis R. Rodriguez 
633c92316bfSLuis R. Rodriguez 	for (i = 0; i < test_fw_config->num_requests; i++) {
634c92316bfSLuis R. Rodriguez 		req = &test_fw_config->reqs[i];
635c92316bfSLuis R. Rodriguez 		req->fw = NULL;
636c92316bfSLuis R. Rodriguez 		req->idx = i;
637c92316bfSLuis R. Rodriguez 		req->name = test_fw_config->name;
638c92316bfSLuis R. Rodriguez 		req->dev = dev;
639c92316bfSLuis R. Rodriguez 		init_completion(&req->completion);
640c92316bfSLuis R. Rodriguez 		req->task = kthread_run(test_fw_run_batch_request, req,
641c92316bfSLuis R. Rodriguez 					     "%s-%u", KBUILD_MODNAME, req->idx);
642c92316bfSLuis R. Rodriguez 		if (!req->task || IS_ERR(req->task)) {
643c92316bfSLuis R. Rodriguez 			pr_err("Setting up thread %u failed\n", req->idx);
644c92316bfSLuis R. Rodriguez 			req->task = NULL;
645c92316bfSLuis R. Rodriguez 			rc = -ENOMEM;
646c92316bfSLuis R. Rodriguez 			goto out_bail;
647c92316bfSLuis R. Rodriguez 		}
648c92316bfSLuis R. Rodriguez 	}
649c92316bfSLuis R. Rodriguez 
650c92316bfSLuis R. Rodriguez 	rc = count;
651c92316bfSLuis R. Rodriguez 
652c92316bfSLuis R. Rodriguez 	/*
653c92316bfSLuis R. Rodriguez 	 * We require an explicit release to enable more time and delay of
654c92316bfSLuis R. Rodriguez 	 * calling release_firmware() to improve our chances of forcing a
655c92316bfSLuis R. Rodriguez 	 * batched request. If we instead called release_firmware() right away
656c92316bfSLuis R. Rodriguez 	 * then we might miss on an opportunity of having a successful firmware
657c92316bfSLuis R. Rodriguez 	 * request pass on the opportunity to be come a batched request.
658c92316bfSLuis R. Rodriguez 	 */
659c92316bfSLuis R. Rodriguez 
660c92316bfSLuis R. Rodriguez out_bail:
661c92316bfSLuis R. Rodriguez 	for (i = 0; i < test_fw_config->num_requests; i++) {
662c92316bfSLuis R. Rodriguez 		req = &test_fw_config->reqs[i];
663c92316bfSLuis R. Rodriguez 		if (req->task || req->sent)
664c92316bfSLuis R. Rodriguez 			wait_for_completion(&req->completion);
665c92316bfSLuis R. Rodriguez 	}
666c92316bfSLuis R. Rodriguez 
667c92316bfSLuis R. Rodriguez 	/* Override any worker error if we had a general setup error */
668c92316bfSLuis R. Rodriguez 	if (rc < 0)
669c92316bfSLuis R. Rodriguez 		test_fw_config->test_result = rc;
670c92316bfSLuis R. Rodriguez 
671c92316bfSLuis R. Rodriguez out_unlock:
672c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
673c92316bfSLuis R. Rodriguez 
674c92316bfSLuis R. Rodriguez 	return rc;
675c92316bfSLuis R. Rodriguez }
676c92316bfSLuis R. Rodriguez static DEVICE_ATTR_WO(trigger_batched_requests);
677c92316bfSLuis R. Rodriguez 
678c92316bfSLuis R. Rodriguez /*
679c92316bfSLuis R. Rodriguez  * We wait for each callback to return with the lock held, no need to lock here
680c92316bfSLuis R. Rodriguez  */
681c92316bfSLuis R. Rodriguez static void trigger_batched_cb(const struct firmware *fw, void *context)
682c92316bfSLuis R. Rodriguez {
683c92316bfSLuis R. Rodriguez 	struct test_batched_req *req = context;
684c92316bfSLuis R. Rodriguez 
685c92316bfSLuis R. Rodriguez 	if (!req) {
686c92316bfSLuis R. Rodriguez 		test_fw_config->test_result = -EINVAL;
687c92316bfSLuis R. Rodriguez 		return;
688c92316bfSLuis R. Rodriguez 	}
689c92316bfSLuis R. Rodriguez 
690c92316bfSLuis R. Rodriguez 	/* forces *some* batched requests to queue up */
691c92316bfSLuis R. Rodriguez 	if (!req->idx)
692c92316bfSLuis R. Rodriguez 		ssleep(2);
693c92316bfSLuis R. Rodriguez 
694c92316bfSLuis R. Rodriguez 	req->fw = fw;
695c92316bfSLuis R. Rodriguez 
696c92316bfSLuis R. Rodriguez 	/*
697c92316bfSLuis R. Rodriguez 	 * Unfortunately the firmware API gives us nothing other than a null FW
698c92316bfSLuis R. Rodriguez 	 * if the firmware was not found on async requests.  Best we can do is
699c92316bfSLuis R. Rodriguez 	 * just assume -ENOENT. A better API would pass the actual return
700c92316bfSLuis R. Rodriguez 	 * value to the callback.
701c92316bfSLuis R. Rodriguez 	 */
702c92316bfSLuis R. Rodriguez 	if (!fw && !test_fw_config->test_result)
703c92316bfSLuis R. Rodriguez 		test_fw_config->test_result = -ENOENT;
704c92316bfSLuis R. Rodriguez 
705c92316bfSLuis R. Rodriguez 	complete(&req->completion);
706c92316bfSLuis R. Rodriguez }
707c92316bfSLuis R. Rodriguez 
708c92316bfSLuis R. Rodriguez static
709c92316bfSLuis R. Rodriguez ssize_t trigger_batched_requests_async_store(struct device *dev,
710c92316bfSLuis R. Rodriguez 					     struct device_attribute *attr,
711c92316bfSLuis R. Rodriguez 					     const char *buf, size_t count)
712c92316bfSLuis R. Rodriguez {
713c92316bfSLuis R. Rodriguez 	struct test_batched_req *req;
714c92316bfSLuis R. Rodriguez 	bool send_uevent;
715c92316bfSLuis R. Rodriguez 	int rc;
716c92316bfSLuis R. Rodriguez 	u8 i;
717c92316bfSLuis R. Rodriguez 
718c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
719c92316bfSLuis R. Rodriguez 
720fad953ceSKees Cook 	test_fw_config->reqs =
721fad953ceSKees Cook 		vzalloc(array3_size(sizeof(struct test_batched_req),
722fad953ceSKees Cook 				    test_fw_config->num_requests, 2));
723c92316bfSLuis R. Rodriguez 	if (!test_fw_config->reqs) {
724c92316bfSLuis R. Rodriguez 		rc = -ENOMEM;
725c92316bfSLuis R. Rodriguez 		goto out;
726c92316bfSLuis R. Rodriguez 	}
727c92316bfSLuis R. Rodriguez 
728c92316bfSLuis R. Rodriguez 	pr_info("batched loading '%s' custom fallback mechanism %u times\n",
729c92316bfSLuis R. Rodriguez 		test_fw_config->name, test_fw_config->num_requests);
730c92316bfSLuis R. Rodriguez 
731c92316bfSLuis R. Rodriguez 	send_uevent = test_fw_config->send_uevent ? FW_ACTION_HOTPLUG :
732c92316bfSLuis R. Rodriguez 		FW_ACTION_NOHOTPLUG;
733c92316bfSLuis R. Rodriguez 
734c92316bfSLuis R. Rodriguez 	for (i = 0; i < test_fw_config->num_requests; i++) {
735c92316bfSLuis R. Rodriguez 		req = &test_fw_config->reqs[i];
736c92316bfSLuis R. Rodriguez 		req->name = test_fw_config->name;
737c92316bfSLuis R. Rodriguez 		req->fw = NULL;
738c92316bfSLuis R. Rodriguez 		req->idx = i;
739c92316bfSLuis R. Rodriguez 		init_completion(&req->completion);
740c92316bfSLuis R. Rodriguez 		rc = request_firmware_nowait(THIS_MODULE, send_uevent,
741c92316bfSLuis R. Rodriguez 					     req->name,
742c92316bfSLuis R. Rodriguez 					     dev, GFP_KERNEL, req,
743c92316bfSLuis R. Rodriguez 					     trigger_batched_cb);
744c92316bfSLuis R. Rodriguez 		if (rc) {
745c92316bfSLuis R. Rodriguez 			pr_info("#%u: batched async load failed setup: %d\n",
746c92316bfSLuis R. Rodriguez 				i, rc);
747c92316bfSLuis R. Rodriguez 			req->rc = rc;
748c92316bfSLuis R. Rodriguez 			goto out_bail;
749c92316bfSLuis R. Rodriguez 		} else
750c92316bfSLuis R. Rodriguez 			req->sent = true;
751c92316bfSLuis R. Rodriguez 	}
752c92316bfSLuis R. Rodriguez 
753c92316bfSLuis R. Rodriguez 	rc = count;
754c92316bfSLuis R. Rodriguez 
755c92316bfSLuis R. Rodriguez out_bail:
756c92316bfSLuis R. Rodriguez 
757c92316bfSLuis R. Rodriguez 	/*
758c92316bfSLuis R. Rodriguez 	 * We require an explicit release to enable more time and delay of
759c92316bfSLuis R. Rodriguez 	 * calling release_firmware() to improve our chances of forcing a
760c92316bfSLuis R. Rodriguez 	 * batched request. If we instead called release_firmware() right away
761c92316bfSLuis R. Rodriguez 	 * then we might miss on an opportunity of having a successful firmware
762c92316bfSLuis R. Rodriguez 	 * request pass on the opportunity to be come a batched request.
763c92316bfSLuis R. Rodriguez 	 */
764c92316bfSLuis R. Rodriguez 
765c92316bfSLuis R. Rodriguez 	for (i = 0; i < test_fw_config->num_requests; i++) {
766c92316bfSLuis R. Rodriguez 		req = &test_fw_config->reqs[i];
767c92316bfSLuis R. Rodriguez 		if (req->sent)
768c92316bfSLuis R. Rodriguez 			wait_for_completion(&req->completion);
769c92316bfSLuis R. Rodriguez 	}
770c92316bfSLuis R. Rodriguez 
771c92316bfSLuis R. Rodriguez 	/* Override any worker error if we had a general setup error */
772c92316bfSLuis R. Rodriguez 	if (rc < 0)
773c92316bfSLuis R. Rodriguez 		test_fw_config->test_result = rc;
774c92316bfSLuis R. Rodriguez 
775c92316bfSLuis R. Rodriguez out:
776c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
777c92316bfSLuis R. Rodriguez 
778c92316bfSLuis R. Rodriguez 	return rc;
779c92316bfSLuis R. Rodriguez }
780c92316bfSLuis R. Rodriguez static DEVICE_ATTR_WO(trigger_batched_requests_async);
781c92316bfSLuis R. Rodriguez 
782c92316bfSLuis R. Rodriguez static ssize_t test_result_show(struct device *dev,
783c92316bfSLuis R. Rodriguez 				struct device_attribute *attr,
784c92316bfSLuis R. Rodriguez 				char *buf)
785c92316bfSLuis R. Rodriguez {
786c92316bfSLuis R. Rodriguez 	return test_dev_config_show_int(buf, test_fw_config->test_result);
787c92316bfSLuis R. Rodriguez }
788c92316bfSLuis R. Rodriguez static DEVICE_ATTR_RO(test_result);
789c92316bfSLuis R. Rodriguez 
790c92316bfSLuis R. Rodriguez static ssize_t release_all_firmware_store(struct device *dev,
791c92316bfSLuis R. Rodriguez 					  struct device_attribute *attr,
792c92316bfSLuis R. Rodriguez 					  const char *buf, size_t count)
793c92316bfSLuis R. Rodriguez {
794c92316bfSLuis R. Rodriguez 	test_release_all_firmware();
795c92316bfSLuis R. Rodriguez 	return count;
796c92316bfSLuis R. Rodriguez }
797c92316bfSLuis R. Rodriguez static DEVICE_ATTR_WO(release_all_firmware);
798c92316bfSLuis R. Rodriguez 
799c92316bfSLuis R. Rodriguez static ssize_t read_firmware_show(struct device *dev,
800c92316bfSLuis R. Rodriguez 				  struct device_attribute *attr,
801c92316bfSLuis R. Rodriguez 				  char *buf)
802c92316bfSLuis R. Rodriguez {
803c92316bfSLuis R. Rodriguez 	struct test_batched_req *req;
804c92316bfSLuis R. Rodriguez 	u8 idx;
805c92316bfSLuis R. Rodriguez 	ssize_t rc = 0;
806c92316bfSLuis R. Rodriguez 
807c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
808c92316bfSLuis R. Rodriguez 
809c92316bfSLuis R. Rodriguez 	idx = test_fw_config->read_fw_idx;
810c92316bfSLuis R. Rodriguez 	if (idx >= test_fw_config->num_requests) {
811c92316bfSLuis R. Rodriguez 		rc = -ERANGE;
812c92316bfSLuis R. Rodriguez 		goto out;
813c92316bfSLuis R. Rodriguez 	}
814c92316bfSLuis R. Rodriguez 
815c92316bfSLuis R. Rodriguez 	if (!test_fw_config->reqs) {
816c92316bfSLuis R. Rodriguez 		rc = -EINVAL;
817c92316bfSLuis R. Rodriguez 		goto out;
818c92316bfSLuis R. Rodriguez 	}
819c92316bfSLuis R. Rodriguez 
820c92316bfSLuis R. Rodriguez 	req = &test_fw_config->reqs[idx];
821c92316bfSLuis R. Rodriguez 	if (!req->fw) {
822c92316bfSLuis R. Rodriguez 		pr_err("#%u: failed to async load firmware\n", idx);
823c92316bfSLuis R. Rodriguez 		rc = -ENOENT;
824c92316bfSLuis R. Rodriguez 		goto out;
825c92316bfSLuis R. Rodriguez 	}
826c92316bfSLuis R. Rodriguez 
827c92316bfSLuis R. Rodriguez 	pr_info("#%u: loaded %zu\n", idx, req->fw->size);
828c92316bfSLuis R. Rodriguez 
829c92316bfSLuis R. Rodriguez 	if (req->fw->size > PAGE_SIZE) {
830c92316bfSLuis R. Rodriguez 		pr_err("Testing interface must use PAGE_SIZE firmware for now\n");
831c92316bfSLuis R. Rodriguez 		rc = -EINVAL;
8328bb0a886SColin Ian King 		goto out;
833c92316bfSLuis R. Rodriguez 	}
834c92316bfSLuis R. Rodriguez 	memcpy(buf, req->fw->data, req->fw->size);
835c92316bfSLuis R. Rodriguez 
836c92316bfSLuis R. Rodriguez 	rc = req->fw->size;
837c92316bfSLuis R. Rodriguez out:
838c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
839c92316bfSLuis R. Rodriguez 
840c92316bfSLuis R. Rodriguez 	return rc;
841c92316bfSLuis R. Rodriguez }
842c92316bfSLuis R. Rodriguez static DEVICE_ATTR_RO(read_firmware);
843c92316bfSLuis R. Rodriguez 
844083a93b0SLuis R. Rodriguez #define TEST_FW_DEV_ATTR(name)          &dev_attr_##name.attr
845083a93b0SLuis R. Rodriguez 
846083a93b0SLuis R. Rodriguez static struct attribute *test_dev_attrs[] = {
847c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(reset),
848c92316bfSLuis R. Rodriguez 
849c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(config),
850c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(config_name),
851c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(config_num_requests),
852c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(config_sync_direct),
853c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(config_send_uevent),
854c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(config_read_fw_idx),
855c92316bfSLuis R. Rodriguez 
856c92316bfSLuis R. Rodriguez 	/* These don't use the config at all - they could be ported! */
857083a93b0SLuis R. Rodriguez 	TEST_FW_DEV_ATTR(trigger_request),
858083a93b0SLuis R. Rodriguez 	TEST_FW_DEV_ATTR(trigger_async_request),
859061132d2SLuis R. Rodriguez 	TEST_FW_DEV_ATTR(trigger_custom_fallback),
860c92316bfSLuis R. Rodriguez 
861c92316bfSLuis R. Rodriguez 	/* These use the config and can use the test_result */
862c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(trigger_batched_requests),
863c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(trigger_batched_requests_async),
864c92316bfSLuis R. Rodriguez 
865c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(release_all_firmware),
866c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(test_result),
867c92316bfSLuis R. Rodriguez 	TEST_FW_DEV_ATTR(read_firmware),
868083a93b0SLuis R. Rodriguez 	NULL,
869083a93b0SLuis R. Rodriguez };
870083a93b0SLuis R. Rodriguez 
871083a93b0SLuis R. Rodriguez ATTRIBUTE_GROUPS(test_dev);
872083a93b0SLuis R. Rodriguez 
87367fd553cSLuis R. Rodriguez static struct miscdevice test_fw_misc_device = {
87467fd553cSLuis R. Rodriguez 	.minor          = MISC_DYNAMIC_MINOR,
87567fd553cSLuis R. Rodriguez 	.name           = "test_firmware",
87667fd553cSLuis R. Rodriguez 	.fops           = &test_fw_fops,
877083a93b0SLuis R. Rodriguez 	.groups 	= test_dev_groups,
87867fd553cSLuis R. Rodriguez };
87967fd553cSLuis R. Rodriguez 
8800a8adf58SKees Cook static int __init test_firmware_init(void)
8810a8adf58SKees Cook {
8820a8adf58SKees Cook 	int rc;
8830a8adf58SKees Cook 
884c92316bfSLuis R. Rodriguez 	test_fw_config = kzalloc(sizeof(struct test_config), GFP_KERNEL);
885c92316bfSLuis R. Rodriguez 	if (!test_fw_config)
886c92316bfSLuis R. Rodriguez 		return -ENOMEM;
887c92316bfSLuis R. Rodriguez 
888c92316bfSLuis R. Rodriguez 	rc = __test_firmware_config_init();
889c92316bfSLuis R. Rodriguez 	if (rc)
890c92316bfSLuis R. Rodriguez 		return rc;
891c92316bfSLuis R. Rodriguez 
8920a8adf58SKees Cook 	rc = misc_register(&test_fw_misc_device);
8930a8adf58SKees Cook 	if (rc) {
894c92316bfSLuis R. Rodriguez 		kfree(test_fw_config);
8950a8adf58SKees Cook 		pr_err("could not register misc device: %d\n", rc);
8960a8adf58SKees Cook 		return rc;
8970a8adf58SKees Cook 	}
898eb910947SBrian Norris 
8990a8adf58SKees Cook 	pr_warn("interface ready\n");
9000a8adf58SKees Cook 
9010a8adf58SKees Cook 	return 0;
9020a8adf58SKees Cook }
9030a8adf58SKees Cook 
9040a8adf58SKees Cook module_init(test_firmware_init);
9050a8adf58SKees Cook 
9060a8adf58SKees Cook static void __exit test_firmware_exit(void)
9070a8adf58SKees Cook {
908c92316bfSLuis R. Rodriguez 	mutex_lock(&test_fw_mutex);
9090a8adf58SKees Cook 	release_firmware(test_firmware);
9100a8adf58SKees Cook 	misc_deregister(&test_fw_misc_device);
911c92316bfSLuis R. Rodriguez 	__test_firmware_config_free();
912c92316bfSLuis R. Rodriguez 	kfree(test_fw_config);
913c92316bfSLuis R. Rodriguez 	mutex_unlock(&test_fw_mutex);
914c92316bfSLuis R. Rodriguez 
9150a8adf58SKees Cook 	pr_warn("removed interface\n");
9160a8adf58SKees Cook }
9170a8adf58SKees Cook 
9180a8adf58SKees Cook module_exit(test_firmware_exit);
9190a8adf58SKees Cook 
9200a8adf58SKees Cook MODULE_AUTHOR("Kees Cook <[email protected]>");
9210a8adf58SKees Cook MODULE_LICENSE("GPL");
922