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