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