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