Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * firmware_class.c - Multi purpose firmware loading support |
| 3 | * |
Markus Rechberger | 87d37a4 | 2007-06-04 18:45:44 +0200 | [diff] [blame] | 4 | * Copyright (c) 2003 Manuel Estrada Sainz |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 5 | * |
| 6 | * Please see Documentation/firmware_class/ for more information. |
| 7 | * |
| 8 | */ |
| 9 | |
Randy.Dunlap | c59ede7 | 2006-01-11 12:17:46 -0800 | [diff] [blame] | 10 | #include <linux/capability.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 | #include <linux/device.h> |
| 12 | #include <linux/module.h> |
| 13 | #include <linux/init.h> |
| 14 | #include <linux/timer.h> |
| 15 | #include <linux/vmalloc.h> |
| 16 | #include <linux/interrupt.h> |
| 17 | #include <linux/bitops.h> |
Laura Garcia | cad1e55 | 2006-05-23 23:22:38 +0200 | [diff] [blame] | 18 | #include <linux/mutex.h> |
Stephen Boyd | a36cf84 | 2012-03-28 23:31:00 +0200 | [diff] [blame] | 19 | #include <linux/workqueue.h> |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 20 | #include <linux/highmem.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 21 | #include <linux/firmware.h> |
Tejun Heo | 5a0e3ad | 2010-03-24 17:04:11 +0900 | [diff] [blame] | 22 | #include <linux/slab.h> |
Stephen Boyd | a36cf84 | 2012-03-28 23:31:00 +0200 | [diff] [blame] | 23 | #include <linux/sched.h> |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 24 | #include <linux/io.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 26 | #define to_dev(obj) container_of(obj, struct device, kobj) |
| 27 | |
Markus Rechberger | 87d37a4 | 2007-06-04 18:45:44 +0200 | [diff] [blame] | 28 | MODULE_AUTHOR("Manuel Estrada Sainz"); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | MODULE_DESCRIPTION("Multi purpose firmware loading support"); |
| 30 | MODULE_LICENSE("GPL"); |
| 31 | |
Dmitry Torokhov | bcb9bd1 | 2010-03-13 23:49:18 -0800 | [diff] [blame] | 32 | /* Builtin firmware support */ |
| 33 | |
| 34 | #ifdef CONFIG_FW_LOADER |
| 35 | |
| 36 | extern struct builtin_fw __start_builtin_fw[]; |
| 37 | extern struct builtin_fw __end_builtin_fw[]; |
| 38 | |
| 39 | static bool fw_get_builtin_firmware(struct firmware *fw, const char *name) |
| 40 | { |
| 41 | struct builtin_fw *b_fw; |
| 42 | |
| 43 | for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) { |
| 44 | if (strcmp(name, b_fw->name) == 0) { |
| 45 | fw->size = b_fw->size; |
| 46 | fw->data = b_fw->data; |
| 47 | return true; |
| 48 | } |
| 49 | } |
| 50 | |
| 51 | return false; |
| 52 | } |
| 53 | |
| 54 | static bool fw_is_builtin_firmware(const struct firmware *fw) |
| 55 | { |
| 56 | struct builtin_fw *b_fw; |
| 57 | |
| 58 | for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) |
| 59 | if (fw->data == b_fw->data) |
| 60 | return true; |
| 61 | |
| 62 | return false; |
| 63 | } |
| 64 | |
| 65 | #else /* Module case - no builtin firmware support */ |
| 66 | |
| 67 | static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name) |
| 68 | { |
| 69 | return false; |
| 70 | } |
| 71 | |
| 72 | static inline bool fw_is_builtin_firmware(const struct firmware *fw) |
| 73 | { |
| 74 | return false; |
| 75 | } |
| 76 | #endif |
| 77 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 78 | enum { |
| 79 | FW_STATUS_LOADING, |
| 80 | FW_STATUS_DONE, |
| 81 | FW_STATUS_ABORT, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 82 | }; |
| 83 | |
Dave Jones | 2f65168 | 2007-01-25 15:56:15 -0500 | [diff] [blame] | 84 | static int loading_timeout = 60; /* In seconds */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 85 | |
Rafael J. Wysocki | 9b78c1d | 2012-03-28 23:30:02 +0200 | [diff] [blame] | 86 | static inline long firmware_loading_timeout(void) |
| 87 | { |
| 88 | return loading_timeout > 0 ? loading_timeout * HZ : MAX_SCHEDULE_TIMEOUT; |
| 89 | } |
| 90 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 91 | /* fw_lock could be moved to 'struct firmware_priv' but since it is just |
| 92 | * guarding for corner cases a global lock should be OK */ |
Laura Garcia | cad1e55 | 2006-05-23 23:22:38 +0200 | [diff] [blame] | 93 | static DEFINE_MUTEX(fw_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | |
| 95 | struct firmware_priv { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 96 | struct completion completion; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 97 | struct firmware *fw; |
| 98 | unsigned long status; |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 99 | struct page **pages; |
| 100 | int nr_pages; |
| 101 | int page_array_size; |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 102 | phys_addr_t dest_addr; |
| 103 | size_t dest_size; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 104 | struct timer_list timeout; |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 105 | struct device dev; |
Johannes Berg | e9045f9 | 2010-03-29 17:57:20 +0200 | [diff] [blame] | 106 | bool nowait; |
Dmitry Torokhov | e177123 | 2010-03-13 23:49:23 -0800 | [diff] [blame] | 107 | char fw_id[]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | }; |
| 109 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 110 | static struct firmware_priv *to_firmware_priv(struct device *dev) |
| 111 | { |
| 112 | return container_of(dev, struct firmware_priv, dev); |
| 113 | } |
| 114 | |
| 115 | static void fw_load_abort(struct firmware_priv *fw_priv) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | { |
| 117 | set_bit(FW_STATUS_ABORT, &fw_priv->status); |
| 118 | wmb(); |
| 119 | complete(&fw_priv->completion); |
| 120 | } |
| 121 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 122 | static ssize_t firmware_timeout_show(struct class *class, |
| 123 | struct class_attribute *attr, |
| 124 | char *buf) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | { |
| 126 | return sprintf(buf, "%d\n", loading_timeout); |
| 127 | } |
| 128 | |
| 129 | /** |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 130 | * firmware_timeout_store - set number of seconds to wait for firmware |
| 131 | * @class: device class pointer |
Randy Dunlap | e59817b | 2010-03-10 11:47:58 -0800 | [diff] [blame] | 132 | * @attr: device attribute pointer |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 133 | * @buf: buffer to scan for timeout value |
| 134 | * @count: number of bytes in @buf |
| 135 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | * Sets the number of seconds to wait for the firmware. Once |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 137 | * this expires an error will be returned to the driver and no |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | * firmware will be provided. |
| 139 | * |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 140 | * Note: zero means 'wait forever'. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | **/ |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 142 | static ssize_t firmware_timeout_store(struct class *class, |
| 143 | struct class_attribute *attr, |
| 144 | const char *buf, size_t count) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 145 | { |
| 146 | loading_timeout = simple_strtol(buf, NULL, 10); |
Stanislaw W. Gruszka | b92eac0 | 2005-06-28 20:44:51 -0700 | [diff] [blame] | 147 | if (loading_timeout < 0) |
| 148 | loading_timeout = 0; |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 149 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | return count; |
| 151 | } |
| 152 | |
Dmitry Torokhov | 673fae9 | 2010-03-13 23:49:13 -0800 | [diff] [blame] | 153 | static struct class_attribute firmware_class_attrs[] = { |
| 154 | __ATTR(timeout, S_IWUSR | S_IRUGO, |
| 155 | firmware_timeout_show, firmware_timeout_store), |
| 156 | __ATTR_NULL |
| 157 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | |
Dmitry Torokhov | 673fae9 | 2010-03-13 23:49:13 -0800 | [diff] [blame] | 159 | static void fw_dev_release(struct device *dev) |
| 160 | { |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 161 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
Dmitry Torokhov | 673fae9 | 2010-03-13 23:49:13 -0800 | [diff] [blame] | 162 | int i; |
| 163 | |
| 164 | for (i = 0; i < fw_priv->nr_pages; i++) |
| 165 | __free_page(fw_priv->pages[i]); |
| 166 | kfree(fw_priv->pages); |
Dmitry Torokhov | 673fae9 | 2010-03-13 23:49:13 -0800 | [diff] [blame] | 167 | kfree(fw_priv); |
Dmitry Torokhov | 673fae9 | 2010-03-13 23:49:13 -0800 | [diff] [blame] | 168 | |
| 169 | module_put(THIS_MODULE); |
| 170 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | |
Kay Sievers | 7eff2e7 | 2007-08-14 15:15:12 +0200 | [diff] [blame] | 172 | static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | { |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 174 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 175 | |
Kay Sievers | 7eff2e7 | 2007-08-14 15:15:12 +0200 | [diff] [blame] | 176 | if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 177 | return -ENOMEM; |
Kay Sievers | 7eff2e7 | 2007-08-14 15:15:12 +0200 | [diff] [blame] | 178 | if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout)) |
kay.sievers@vrfy.org | 6897089 | 2005-04-18 21:57:31 -0700 | [diff] [blame] | 179 | return -ENOMEM; |
Johannes Berg | e9045f9 | 2010-03-29 17:57:20 +0200 | [diff] [blame] | 180 | if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait)) |
| 181 | return -ENOMEM; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | |
| 183 | return 0; |
| 184 | } |
| 185 | |
Adrian Bunk | 1b81d66 | 2006-05-20 15:00:16 -0700 | [diff] [blame] | 186 | static struct class firmware_class = { |
| 187 | .name = "firmware", |
Dmitry Torokhov | 673fae9 | 2010-03-13 23:49:13 -0800 | [diff] [blame] | 188 | .class_attrs = firmware_class_attrs, |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 189 | .dev_uevent = firmware_uevent, |
| 190 | .dev_release = fw_dev_release, |
Adrian Bunk | 1b81d66 | 2006-05-20 15:00:16 -0700 | [diff] [blame] | 191 | }; |
| 192 | |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 193 | static ssize_t firmware_loading_show(struct device *dev, |
| 194 | struct device_attribute *attr, char *buf) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 195 | { |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 196 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 197 | int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status); |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 198 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | return sprintf(buf, "%d\n", loading); |
| 200 | } |
| 201 | |
David Woodhouse | dd336c5 | 2010-05-02 11:21:21 +0300 | [diff] [blame] | 202 | static void firmware_free_data(const struct firmware *fw) |
| 203 | { |
| 204 | int i; |
| 205 | vunmap(fw->data); |
| 206 | if (fw->pages) { |
| 207 | for (i = 0; i < PFN_UP(fw->size); i++) |
| 208 | __free_page(fw->pages[i]); |
| 209 | kfree(fw->pages); |
| 210 | } |
| 211 | } |
| 212 | |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 213 | /* Some architectures don't have PAGE_KERNEL_RO */ |
| 214 | #ifndef PAGE_KERNEL_RO |
| 215 | #define PAGE_KERNEL_RO PAGE_KERNEL |
| 216 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 217 | /** |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 218 | * firmware_loading_store - set value in the 'loading' control file |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 219 | * @dev: device pointer |
Randy Dunlap | af9997e | 2006-12-22 01:06:52 -0800 | [diff] [blame] | 220 | * @attr: device attribute pointer |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 221 | * @buf: buffer to scan for loading control value |
| 222 | * @count: number of bytes in @buf |
| 223 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 224 | * The relevant values are: |
| 225 | * |
| 226 | * 1: Start a load, discarding any previous partial load. |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 227 | * 0: Conclude the load and hand the data to the driver code. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 228 | * -1: Conclude the load with an error and discard any written data. |
| 229 | **/ |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 230 | static ssize_t firmware_loading_store(struct device *dev, |
| 231 | struct device_attribute *attr, |
| 232 | const char *buf, size_t count) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 233 | { |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 234 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 235 | int loading = simple_strtol(buf, NULL, 10); |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 236 | int i; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 237 | |
Neil Horman | eea915b | 2012-01-02 15:31:23 -0500 | [diff] [blame] | 238 | mutex_lock(&fw_lock); |
| 239 | |
| 240 | if (!fw_priv->fw) |
| 241 | goto out; |
| 242 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 243 | switch (loading) { |
| 244 | case 1: |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 245 | if (fw_priv->dest_addr) { |
| 246 | set_bit(FW_STATUS_LOADING, &fw_priv->status); |
| 247 | break; |
| 248 | } |
David Woodhouse | dd336c5 | 2010-05-02 11:21:21 +0300 | [diff] [blame] | 249 | firmware_free_data(fw_priv->fw); |
| 250 | memset(fw_priv->fw, 0, sizeof(struct firmware)); |
| 251 | /* If the pages are not owned by 'struct firmware' */ |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 252 | for (i = 0; i < fw_priv->nr_pages; i++) |
| 253 | __free_page(fw_priv->pages[i]); |
| 254 | kfree(fw_priv->pages); |
| 255 | fw_priv->pages = NULL; |
| 256 | fw_priv->page_array_size = 0; |
| 257 | fw_priv->nr_pages = 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 258 | set_bit(FW_STATUS_LOADING, &fw_priv->status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 259 | break; |
| 260 | case 0: |
| 261 | if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) { |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 262 | if (fw_priv->dest_addr) { |
| 263 | complete(&fw_priv->completion); |
| 264 | clear_bit(FW_STATUS_LOADING, &fw_priv->status); |
| 265 | break; |
| 266 | } |
David Woodhouse | dd336c5 | 2010-05-02 11:21:21 +0300 | [diff] [blame] | 267 | vunmap(fw_priv->fw->data); |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 268 | fw_priv->fw->data = vmap(fw_priv->pages, |
| 269 | fw_priv->nr_pages, |
| 270 | 0, PAGE_KERNEL_RO); |
| 271 | if (!fw_priv->fw->data) { |
| 272 | dev_err(dev, "%s: vmap() failed\n", __func__); |
| 273 | goto err; |
| 274 | } |
David Woodhouse | dd336c5 | 2010-05-02 11:21:21 +0300 | [diff] [blame] | 275 | /* Pages are now owned by 'struct firmware' */ |
| 276 | fw_priv->fw->pages = fw_priv->pages; |
| 277 | fw_priv->pages = NULL; |
| 278 | |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 279 | fw_priv->page_array_size = 0; |
| 280 | fw_priv->nr_pages = 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 281 | complete(&fw_priv->completion); |
| 282 | clear_bit(FW_STATUS_LOADING, &fw_priv->status); |
| 283 | break; |
| 284 | } |
| 285 | /* fallthrough */ |
| 286 | default: |
Bjorn Helgaas | 266a813 | 2008-10-15 22:04:20 -0700 | [diff] [blame] | 287 | dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 288 | /* fallthrough */ |
| 289 | case -1: |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 290 | err: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 291 | fw_load_abort(fw_priv); |
| 292 | break; |
| 293 | } |
Neil Horman | eea915b | 2012-01-02 15:31:23 -0500 | [diff] [blame] | 294 | out: |
| 295 | mutex_unlock(&fw_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 296 | return count; |
| 297 | } |
| 298 | |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 299 | static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 300 | |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 301 | static int __firmware_data_rw(struct firmware_priv *fw_priv, char *buffer, |
| 302 | loff_t *offset, size_t count, int read) |
| 303 | { |
| 304 | u8 __iomem *fw_buf; |
| 305 | int retval = count; |
| 306 | |
| 307 | if ((*offset + count) > fw_priv->dest_size) { |
| 308 | pr_debug("%s: Failed size check.\n", __func__); |
| 309 | retval = -EINVAL; |
| 310 | goto out; |
| 311 | } |
| 312 | |
| 313 | fw_buf = ioremap(fw_priv->dest_addr + *offset, count); |
| 314 | if (!fw_buf) { |
| 315 | pr_debug("%s: Failed ioremap.\n", __func__); |
| 316 | retval = -ENOMEM; |
| 317 | goto out; |
| 318 | } |
| 319 | |
| 320 | if (read) |
| 321 | memcpy(buffer, fw_buf, count); |
| 322 | else |
| 323 | memcpy(fw_buf, buffer, count); |
| 324 | |
| 325 | *offset += count; |
| 326 | iounmap(fw_buf); |
| 327 | |
| 328 | out: |
| 329 | return retval; |
| 330 | } |
| 331 | |
| 332 | static ssize_t firmware_direct_read(struct file *filp, struct kobject *kobj, |
| 333 | struct bin_attribute *bin_attr, |
| 334 | char *buffer, loff_t offset, size_t count) |
| 335 | { |
| 336 | struct device *dev = to_dev(kobj); |
| 337 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
| 338 | struct firmware *fw; |
| 339 | ssize_t ret_count; |
| 340 | |
| 341 | mutex_lock(&fw_lock); |
| 342 | fw = fw_priv->fw; |
| 343 | |
| 344 | if (offset > fw->size) { |
| 345 | ret_count = 0; |
| 346 | goto out; |
| 347 | } |
| 348 | if (count > fw->size - offset) |
| 349 | count = fw->size - offset; |
| 350 | |
| 351 | if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) { |
| 352 | ret_count = -ENODEV; |
| 353 | goto out; |
| 354 | } |
| 355 | |
| 356 | ret_count = __firmware_data_rw(fw_priv, buffer, &offset, count, 1); |
| 357 | out: |
| 358 | mutex_unlock(&fw_lock); |
| 359 | return ret_count; |
| 360 | } |
| 361 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 362 | static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj, |
| 363 | struct bin_attribute *bin_attr, |
| 364 | char *buffer, loff_t offset, size_t count) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 365 | { |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 366 | struct device *dev = to_dev(kobj); |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 367 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 368 | struct firmware *fw; |
Akinobu Mita | f37e661 | 2008-07-25 01:48:23 -0700 | [diff] [blame] | 369 | ssize_t ret_count; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 370 | |
Laura Garcia | cad1e55 | 2006-05-23 23:22:38 +0200 | [diff] [blame] | 371 | mutex_lock(&fw_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 372 | fw = fw_priv->fw; |
Stanislaw W. Gruszka | b92eac0 | 2005-06-28 20:44:51 -0700 | [diff] [blame] | 373 | if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 374 | ret_count = -ENODEV; |
| 375 | goto out; |
| 376 | } |
Jiri Slaby | 308975f | 2009-06-21 23:57:31 +0200 | [diff] [blame] | 377 | if (offset > fw->size) { |
| 378 | ret_count = 0; |
| 379 | goto out; |
| 380 | } |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 381 | if (count > fw->size - offset) |
| 382 | count = fw->size - offset; |
| 383 | |
| 384 | ret_count = count; |
| 385 | |
| 386 | while (count) { |
| 387 | void *page_data; |
| 388 | int page_nr = offset >> PAGE_SHIFT; |
| 389 | int page_ofs = offset & (PAGE_SIZE-1); |
| 390 | int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count); |
| 391 | |
| 392 | page_data = kmap(fw_priv->pages[page_nr]); |
| 393 | |
| 394 | memcpy(buffer, page_data + page_ofs, page_cnt); |
| 395 | |
| 396 | kunmap(fw_priv->pages[page_nr]); |
| 397 | buffer += page_cnt; |
| 398 | offset += page_cnt; |
| 399 | count -= page_cnt; |
| 400 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 401 | out: |
Laura Garcia | cad1e55 | 2006-05-23 23:22:38 +0200 | [diff] [blame] | 402 | mutex_unlock(&fw_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 403 | return ret_count; |
| 404 | } |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 405 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 406 | static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 407 | { |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 408 | int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 409 | |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 410 | /* If the array of pages is too small, grow it... */ |
| 411 | if (fw_priv->page_array_size < pages_needed) { |
| 412 | int new_array_size = max(pages_needed, |
| 413 | fw_priv->page_array_size * 2); |
| 414 | struct page **new_pages; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 415 | |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 416 | new_pages = kmalloc(new_array_size * sizeof(void *), |
| 417 | GFP_KERNEL); |
| 418 | if (!new_pages) { |
| 419 | fw_load_abort(fw_priv); |
| 420 | return -ENOMEM; |
| 421 | } |
| 422 | memcpy(new_pages, fw_priv->pages, |
| 423 | fw_priv->page_array_size * sizeof(void *)); |
| 424 | memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) * |
| 425 | (new_array_size - fw_priv->page_array_size)); |
| 426 | kfree(fw_priv->pages); |
| 427 | fw_priv->pages = new_pages; |
| 428 | fw_priv->page_array_size = new_array_size; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 429 | } |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 430 | |
| 431 | while (fw_priv->nr_pages < pages_needed) { |
| 432 | fw_priv->pages[fw_priv->nr_pages] = |
| 433 | alloc_page(GFP_KERNEL | __GFP_HIGHMEM); |
| 434 | |
| 435 | if (!fw_priv->pages[fw_priv->nr_pages]) { |
| 436 | fw_load_abort(fw_priv); |
| 437 | return -ENOMEM; |
| 438 | } |
| 439 | fw_priv->nr_pages++; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 440 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 441 | return 0; |
| 442 | } |
| 443 | |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 444 | static ssize_t firmware_direct_write(struct file *filp, struct kobject *kobj, |
| 445 | struct bin_attribute *bin_attr, |
| 446 | char *buffer, loff_t offset, size_t count) |
| 447 | { |
| 448 | struct device *dev = to_dev(kobj); |
| 449 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
| 450 | struct firmware *fw; |
| 451 | ssize_t retval; |
| 452 | |
| 453 | if (!capable(CAP_SYS_RAWIO)) |
| 454 | return -EPERM; |
| 455 | |
| 456 | mutex_lock(&fw_lock); |
| 457 | fw = fw_priv->fw; |
| 458 | if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) { |
| 459 | retval = -ENODEV; |
| 460 | goto out; |
| 461 | } |
| 462 | |
| 463 | retval = __firmware_data_rw(fw_priv, buffer, &offset, count, 0); |
| 464 | if (retval < 0) |
| 465 | goto out; |
| 466 | |
| 467 | fw->size = max_t(size_t, offset, fw->size); |
| 468 | out: |
| 469 | mutex_unlock(&fw_lock); |
| 470 | return retval; |
| 471 | } |
| 472 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 473 | /** |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 474 | * firmware_data_write - write method for firmware |
Chris Wright | 2c3c8be | 2010-05-12 18:28:57 -0700 | [diff] [blame] | 475 | * @filp: open sysfs file |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 476 | * @kobj: kobject for the device |
Randy Dunlap | 42e61f4 | 2007-07-23 21:42:11 -0700 | [diff] [blame] | 477 | * @bin_attr: bin_attr structure |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 478 | * @buffer: buffer being written |
| 479 | * @offset: buffer offset for write in total data store area |
| 480 | * @count: buffer size |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 481 | * |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 482 | * Data written to the 'data' attribute will be later handed to |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 483 | * the driver as a firmware image. |
| 484 | **/ |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 485 | static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj, |
| 486 | struct bin_attribute *bin_attr, |
| 487 | char *buffer, loff_t offset, size_t count) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 488 | { |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 489 | struct device *dev = to_dev(kobj); |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 490 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 491 | struct firmware *fw; |
| 492 | ssize_t retval; |
| 493 | |
| 494 | if (!capable(CAP_SYS_RAWIO)) |
| 495 | return -EPERM; |
Stanislaw W. Gruszka | b92eac0 | 2005-06-28 20:44:51 -0700 | [diff] [blame] | 496 | |
Laura Garcia | cad1e55 | 2006-05-23 23:22:38 +0200 | [diff] [blame] | 497 | mutex_lock(&fw_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 498 | fw = fw_priv->fw; |
Stanislaw W. Gruszka | b92eac0 | 2005-06-28 20:44:51 -0700 | [diff] [blame] | 499 | if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 500 | retval = -ENODEV; |
| 501 | goto out; |
| 502 | } |
| 503 | retval = fw_realloc_buffer(fw_priv, offset + count); |
| 504 | if (retval) |
| 505 | goto out; |
| 506 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 507 | retval = count; |
David Woodhouse | 6e03a20 | 2009-04-09 22:04:07 -0700 | [diff] [blame] | 508 | |
| 509 | while (count) { |
| 510 | void *page_data; |
| 511 | int page_nr = offset >> PAGE_SHIFT; |
| 512 | int page_ofs = offset & (PAGE_SIZE - 1); |
| 513 | int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count); |
| 514 | |
| 515 | page_data = kmap(fw_priv->pages[page_nr]); |
| 516 | |
| 517 | memcpy(page_data + page_ofs, buffer, page_cnt); |
| 518 | |
| 519 | kunmap(fw_priv->pages[page_nr]); |
| 520 | buffer += page_cnt; |
| 521 | offset += page_cnt; |
| 522 | count -= page_cnt; |
| 523 | } |
| 524 | |
| 525 | fw->size = max_t(size_t, offset, fw->size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 526 | out: |
Laura Garcia | cad1e55 | 2006-05-23 23:22:38 +0200 | [diff] [blame] | 527 | mutex_unlock(&fw_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 528 | return retval; |
| 529 | } |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 530 | |
Dmitry Torokhov | 0983ca2 | 2010-06-04 00:54:37 -0700 | [diff] [blame] | 531 | static struct bin_attribute firmware_attr_data = { |
| 532 | .attr = { .name = "data", .mode = 0644 }, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 533 | .size = 0, |
| 534 | .read = firmware_data_read, |
| 535 | .write = firmware_data_write, |
| 536 | }; |
| 537 | |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 538 | static struct bin_attribute firmware_direct_attr_data = { |
| 539 | .attr = { .name = "data", .mode = 0644 }, |
| 540 | .size = 0, |
| 541 | .read = firmware_direct_read, |
| 542 | .write = firmware_direct_write, |
| 543 | }; |
| 544 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 545 | static void firmware_class_timeout(u_long data) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 546 | { |
| 547 | struct firmware_priv *fw_priv = (struct firmware_priv *) data; |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 548 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 549 | fw_load_abort(fw_priv); |
| 550 | } |
| 551 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 552 | static struct firmware_priv * |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 553 | fw_create_instance(struct firmware *firmware, const char *fw_name, |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 554 | struct device *device, bool uevent, bool nowait) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 555 | { |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 556 | struct firmware_priv *fw_priv; |
| 557 | struct device *f_dev; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 558 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 559 | fw_priv = kzalloc(sizeof(*fw_priv) + strlen(fw_name) + 1 , GFP_KERNEL); |
| 560 | if (!fw_priv) { |
Bjorn Helgaas | 266a813 | 2008-10-15 22:04:20 -0700 | [diff] [blame] | 561 | dev_err(device, "%s: kmalloc failed\n", __func__); |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 562 | return ERR_PTR(-ENOMEM); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 563 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 564 | |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 565 | fw_priv->fw = firmware; |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 566 | fw_priv->nowait = nowait; |
Dmitry Torokhov | e177123 | 2010-03-13 23:49:23 -0800 | [diff] [blame] | 567 | strcpy(fw_priv->fw_id, fw_name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 568 | init_completion(&fw_priv->completion); |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 569 | setup_timer(&fw_priv->timeout, |
| 570 | firmware_class_timeout, (u_long) fw_priv); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 571 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 572 | f_dev = &fw_priv->dev; |
| 573 | |
| 574 | device_initialize(f_dev); |
Greg Kroah-Hartman | acc0e90 | 2009-06-02 15:39:55 -0700 | [diff] [blame] | 575 | dev_set_name(f_dev, "%s", dev_name(device)); |
Greg Kroah-Hartman | e55c879 | 2006-09-14 07:30:59 -0700 | [diff] [blame] | 576 | f_dev->parent = device; |
| 577 | f_dev->class = &firmware_class; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 578 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 579 | return fw_priv; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 580 | } |
| 581 | |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 582 | static struct firmware_priv * |
| 583 | _request_firmware_prepare(const struct firmware **firmware_p, const char *name, |
| 584 | struct device *device, bool uevent, bool nowait) |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 585 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 586 | struct firmware *firmware; |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 587 | struct firmware_priv *fw_priv; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 588 | |
| 589 | if (!firmware_p) |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 590 | return ERR_PTR(-EINVAL); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 591 | |
Jiri Slaby | 4aed064 | 2005-09-13 01:25:01 -0700 | [diff] [blame] | 592 | *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 593 | if (!firmware) { |
Bjorn Helgaas | 266a813 | 2008-10-15 22:04:20 -0700 | [diff] [blame] | 594 | dev_err(device, "%s: kmalloc(struct firmware) failed\n", |
| 595 | __func__); |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 596 | return ERR_PTR(-ENOMEM); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 597 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 598 | |
Dmitry Torokhov | bcb9bd1 | 2010-03-13 23:49:18 -0800 | [diff] [blame] | 599 | if (fw_get_builtin_firmware(firmware, name)) { |
Rafael J. Wysocki | 6f18ff9 | 2010-02-27 21:43:22 +0100 | [diff] [blame] | 600 | dev_dbg(device, "firmware: using built-in firmware %s\n", name); |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 601 | return NULL; |
David Woodhouse | 5658c76 | 2008-05-23 13:52:42 +0100 | [diff] [blame] | 602 | } |
| 603 | |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 604 | fw_priv = fw_create_instance(firmware, name, device, uevent, nowait); |
| 605 | if (IS_ERR(fw_priv)) { |
| 606 | release_firmware(firmware); |
| 607 | *firmware_p = NULL; |
| 608 | } |
| 609 | return fw_priv; |
Rafael J. Wysocki | 811fa40 | 2012-03-28 23:29:55 +0200 | [diff] [blame] | 610 | } |
| 611 | |
| 612 | static void _request_firmware_cleanup(const struct firmware **firmware_p) |
| 613 | { |
| 614 | release_firmware(*firmware_p); |
| 615 | *firmware_p = NULL; |
| 616 | } |
| 617 | |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 618 | static int _request_firmware_load(struct firmware_priv *fw_priv, bool uevent, |
| 619 | long timeout) |
Rafael J. Wysocki | 811fa40 | 2012-03-28 23:29:55 +0200 | [diff] [blame] | 620 | { |
Rafael J. Wysocki | 9b78c1d | 2012-03-28 23:30:02 +0200 | [diff] [blame] | 621 | int retval = 0; |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 622 | struct device *f_dev = &fw_priv->dev; |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 623 | struct bin_attribute *fw_attr_data = fw_priv->dest_addr ? |
| 624 | &firmware_direct_attr_data : &firmware_attr_data; |
Linus Torvalds | caca951 | 2011-08-24 15:55:30 -0700 | [diff] [blame] | 625 | |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 626 | dev_set_uevent_suppress(f_dev, true); |
David Woodhouse | 5658c76 | 2008-05-23 13:52:42 +0100 | [diff] [blame] | 627 | |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 628 | /* Need to pin this module until class device is destroyed */ |
| 629 | __module_get(THIS_MODULE); |
| 630 | |
| 631 | retval = device_add(f_dev); |
| 632 | if (retval) { |
| 633 | dev_err(f_dev, "%s: device_register failed\n", __func__); |
| 634 | goto err_put_dev; |
| 635 | } |
| 636 | |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 637 | retval = device_create_bin_file(f_dev, fw_attr_data); |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 638 | if (retval) { |
| 639 | dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__); |
| 640 | goto err_del_dev; |
| 641 | } |
| 642 | |
| 643 | retval = device_create_file(f_dev, &dev_attr_loading); |
| 644 | if (retval) { |
| 645 | dev_err(f_dev, "%s: device_create_file failed\n", __func__); |
| 646 | goto err_del_bin_attr; |
| 647 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 648 | |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 649 | if (uevent) { |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 650 | dev_set_uevent_suppress(f_dev, false); |
| 651 | dev_dbg(f_dev, "firmware: requesting %s\n", fw_priv->fw_id); |
Rafael J. Wysocki | 9b78c1d | 2012-03-28 23:30:02 +0200 | [diff] [blame] | 652 | if (timeout != MAX_SCHEDULE_TIMEOUT) |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 653 | mod_timer(&fw_priv->timeout, |
Rafael J. Wysocki | 9b78c1d | 2012-03-28 23:30:02 +0200 | [diff] [blame] | 654 | round_jiffies_up(jiffies + timeout)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 655 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 656 | kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD); |
| 657 | } |
| 658 | |
| 659 | wait_for_completion(&fw_priv->completion); |
| 660 | |
| 661 | set_bit(FW_STATUS_DONE, &fw_priv->status); |
| 662 | del_timer_sync(&fw_priv->timeout); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 663 | |
Laura Garcia | cad1e55 | 2006-05-23 23:22:38 +0200 | [diff] [blame] | 664 | mutex_lock(&fw_lock); |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 665 | if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 666 | retval = -ENOENT; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 667 | fw_priv->fw = NULL; |
Laura Garcia | cad1e55 | 2006-05-23 23:22:38 +0200 | [diff] [blame] | 668 | mutex_unlock(&fw_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 669 | |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 670 | device_remove_file(f_dev, &dev_attr_loading); |
| 671 | err_del_bin_attr: |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 672 | device_remove_bin_file(f_dev, fw_attr_data); |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 673 | err_del_dev: |
| 674 | device_del(f_dev); |
| 675 | err_put_dev: |
| 676 | put_device(f_dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 677 | return retval; |
| 678 | } |
| 679 | |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 680 | static int |
| 681 | __request_firmware(const struct firmware **firmware_p, const char *name, |
| 682 | struct device *device, phys_addr_t dest_addr, size_t size) |
| 683 | { |
| 684 | struct firmware_priv *fw_priv; |
| 685 | int ret; |
| 686 | |
| 687 | fw_priv = _request_firmware_prepare(firmware_p, name, device, true, |
| 688 | false); |
| 689 | if (IS_ERR_OR_NULL(fw_priv)) |
| 690 | return PTR_RET(fw_priv); |
| 691 | |
| 692 | fw_priv->dest_addr = dest_addr; |
| 693 | fw_priv->dest_size = size; |
| 694 | |
| 695 | ret = usermodehelper_read_trylock(); |
| 696 | if (WARN_ON(ret)) { |
| 697 | dev_err(device, "firmware: %s will not be loaded\n", name); |
| 698 | } else { |
| 699 | ret = _request_firmware_load(fw_priv, true, |
| 700 | firmware_loading_timeout()); |
| 701 | usermodehelper_read_unlock(); |
| 702 | } |
| 703 | if (ret) |
| 704 | _request_firmware_cleanup(firmware_p); |
| 705 | |
| 706 | return ret; |
| 707 | } |
| 708 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 709 | /** |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 710 | * request_firmware: - send firmware request and wait for it |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 711 | * @firmware_p: pointer to firmware image |
| 712 | * @name: name of firmware file |
| 713 | * @device: device for which firmware is being loaded |
| 714 | * |
| 715 | * @firmware_p will be used to return a firmware image by the name |
Abhay Salunke | 6e3eaab | 2005-09-06 15:17:13 -0700 | [diff] [blame] | 716 | * of @name for device @device. |
| 717 | * |
| 718 | * Should be called from user context where sleeping is allowed. |
| 719 | * |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 720 | * @name will be used as $FIRMWARE in the uevent environment and |
Abhay Salunke | 6e3eaab | 2005-09-06 15:17:13 -0700 | [diff] [blame] | 721 | * should be distinctive enough not to be confused with any other |
| 722 | * firmware image for this or any other device. |
| 723 | **/ |
| 724 | int |
| 725 | request_firmware(const struct firmware **firmware_p, const char *name, |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 726 | struct device *device) |
Abhay Salunke | 6e3eaab | 2005-09-06 15:17:13 -0700 | [diff] [blame] | 727 | { |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 728 | return __request_firmware(firmware_p, name, device, 0, 0); |
| 729 | } |
| 730 | |
| 731 | /** |
| 732 | * request_firmware_direct: - send firmware request and wait for it |
| 733 | * @name: name of firmware file |
| 734 | * @device: device for which firmware is being loaded |
| 735 | * @dest_addr: Destination address for the firmware |
| 736 | * @dest_size: |
| 737 | * |
| 738 | * Similar to request_firmware, except takes in a buffer address and |
| 739 | * copies firmware data directly to that buffer. Returns the size of |
| 740 | * the firmware that was loaded at dest_addr. |
| 741 | */ |
| 742 | int request_firmware_direct(const char *name, struct device *device, |
| 743 | phys_addr_t dest_addr, size_t dest_size) |
| 744 | { |
| 745 | const struct firmware *fp = NULL; |
Rafael J. Wysocki | 811fa40 | 2012-03-28 23:29:55 +0200 | [diff] [blame] | 746 | int ret; |
| 747 | |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 748 | ret = __request_firmware(&fp, name, device, dest_addr, dest_size); |
Rafael J. Wysocki | 811fa40 | 2012-03-28 23:29:55 +0200 | [diff] [blame] | 749 | if (ret) |
Vikram Mulukutla | f5e5aa8 | 2013-05-14 11:26:37 -0700 | [diff] [blame] | 750 | return ret; |
| 751 | ret = fp->size; |
| 752 | release_firmware(fp); |
Rafael J. Wysocki | 811fa40 | 2012-03-28 23:29:55 +0200 | [diff] [blame] | 753 | return ret; |
Abhay Salunke | 6e3eaab | 2005-09-06 15:17:13 -0700 | [diff] [blame] | 754 | } |
| 755 | |
| 756 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 757 | * release_firmware: - release the resource associated with a firmware image |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 758 | * @fw: firmware resource to release |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 759 | **/ |
Dmitry Torokhov | bcb9bd1 | 2010-03-13 23:49:18 -0800 | [diff] [blame] | 760 | void release_firmware(const struct firmware *fw) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 761 | { |
| 762 | if (fw) { |
Dmitry Torokhov | bcb9bd1 | 2010-03-13 23:49:18 -0800 | [diff] [blame] | 763 | if (!fw_is_builtin_firmware(fw)) |
| 764 | firmware_free_data(fw); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 765 | kfree(fw); |
| 766 | } |
| 767 | } |
| 768 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 769 | /* Async support */ |
| 770 | struct firmware_work { |
| 771 | struct work_struct work; |
| 772 | struct module *module; |
| 773 | const char *name; |
| 774 | struct device *device; |
| 775 | void *context; |
| 776 | void (*cont)(const struct firmware *fw, void *context); |
Bob Liu | 072fc8f | 2011-01-26 18:33:32 +0800 | [diff] [blame] | 777 | bool uevent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 778 | }; |
| 779 | |
Stephen Boyd | a36cf84 | 2012-03-28 23:31:00 +0200 | [diff] [blame] | 780 | static void request_firmware_work_func(struct work_struct *work) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 781 | { |
Stephen Boyd | a36cf84 | 2012-03-28 23:31:00 +0200 | [diff] [blame] | 782 | struct firmware_work *fw_work; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 783 | const struct firmware *fw; |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 784 | struct firmware_priv *fw_priv; |
Rafael J. Wysocki | 9b78c1d | 2012-03-28 23:30:02 +0200 | [diff] [blame] | 785 | long timeout; |
matthieu castet | 113fab1 | 2005-11-13 16:07:39 -0800 | [diff] [blame] | 786 | int ret; |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 787 | |
Stephen Boyd | a36cf84 | 2012-03-28 23:31:00 +0200 | [diff] [blame] | 788 | fw_work = container_of(work, struct firmware_work, work); |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 789 | fw_priv = _request_firmware_prepare(&fw, fw_work->name, fw_work->device, |
| 790 | fw_work->uevent, true); |
| 791 | if (IS_ERR_OR_NULL(fw_priv)) { |
| 792 | ret = PTR_RET(fw_priv); |
Rafael J. Wysocki | 811fa40 | 2012-03-28 23:29:55 +0200 | [diff] [blame] | 793 | goto out; |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 794 | } |
Rafael J. Wysocki | 811fa40 | 2012-03-28 23:29:55 +0200 | [diff] [blame] | 795 | |
Rafael J. Wysocki | 9b78c1d | 2012-03-28 23:30:02 +0200 | [diff] [blame] | 796 | timeout = usermodehelper_read_lock_wait(firmware_loading_timeout()); |
| 797 | if (timeout) { |
Stephen Boyd | dddb554 | 2012-03-28 23:30:43 +0200 | [diff] [blame] | 798 | ret = _request_firmware_load(fw_priv, fw_work->uevent, timeout); |
Rafael J. Wysocki | 9b78c1d | 2012-03-28 23:30:02 +0200 | [diff] [blame] | 799 | usermodehelper_read_unlock(); |
| 800 | } else { |
| 801 | dev_dbg(fw_work->device, "firmware: %s loading timed out\n", |
| 802 | fw_work->name); |
| 803 | ret = -EAGAIN; |
| 804 | } |
Rafael J. Wysocki | 811fa40 | 2012-03-28 23:29:55 +0200 | [diff] [blame] | 805 | if (ret) |
| 806 | _request_firmware_cleanup(&fw); |
| 807 | |
| 808 | out: |
Johannes Berg | 9ebfbd4 | 2009-10-29 12:36:02 +0100 | [diff] [blame] | 809 | fw_work->cont(fw, fw_work->context); |
| 810 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 811 | module_put(fw_work->module); |
| 812 | kfree(fw_work); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 813 | } |
| 814 | |
| 815 | /** |
Ben Hutchings | 3c31f07 | 2010-02-14 14:18:53 +0000 | [diff] [blame] | 816 | * request_firmware_nowait - asynchronous version of request_firmware |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 817 | * @module: module requesting the firmware |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 818 | * @uevent: sends uevent to copy the firmware image if this flag |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 819 | * is non-zero else the firmware copy must be done manually. |
| 820 | * @name: name of firmware file |
| 821 | * @device: device for which firmware is being loaded |
Johannes Berg | 9ebfbd4 | 2009-10-29 12:36:02 +0100 | [diff] [blame] | 822 | * @gfp: allocation flags |
Randy Dunlap | eb8e317 | 2005-10-30 15:03:01 -0800 | [diff] [blame] | 823 | * @context: will be passed over to @cont, and |
| 824 | * @fw may be %NULL if firmware request fails. |
| 825 | * @cont: function will be called asynchronously when the firmware |
| 826 | * request is over. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 827 | * |
Ming Lei | 7fcab09 | 2009-05-29 11:33:19 +0800 | [diff] [blame] | 828 | * Asynchronous variant of request_firmware() for user contexts where |
| 829 | * it is not possible to sleep for long time. It can't be called |
| 830 | * in atomic contexts. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 831 | **/ |
| 832 | int |
| 833 | request_firmware_nowait( |
Bob Liu | 072fc8f | 2011-01-26 18:33:32 +0800 | [diff] [blame] | 834 | struct module *module, bool uevent, |
Johannes Berg | 9ebfbd4 | 2009-10-29 12:36:02 +0100 | [diff] [blame] | 835 | const char *name, struct device *device, gfp_t gfp, void *context, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 836 | void (*cont)(const struct firmware *fw, void *context)) |
| 837 | { |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 838 | struct firmware_work *fw_work; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 839 | |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 840 | fw_work = kzalloc(sizeof (struct firmware_work), gfp); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 841 | if (!fw_work) |
| 842 | return -ENOMEM; |
Dmitry Torokhov | f8a4bd3 | 2010-06-04 00:54:43 -0700 | [diff] [blame] | 843 | |
| 844 | fw_work->module = module; |
| 845 | fw_work->name = name; |
| 846 | fw_work->device = device; |
| 847 | fw_work->context = context; |
| 848 | fw_work->cont = cont; |
| 849 | fw_work->uevent = uevent; |
| 850 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 851 | if (!try_module_get(module)) { |
| 852 | kfree(fw_work); |
| 853 | return -EFAULT; |
| 854 | } |
| 855 | |
Stephen Boyd | a36cf84 | 2012-03-28 23:31:00 +0200 | [diff] [blame] | 856 | INIT_WORK(&fw_work->work, request_firmware_work_func); |
| 857 | schedule_work(&fw_work->work); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 858 | return 0; |
| 859 | } |
| 860 | |
Dmitry Torokhov | 673fae9 | 2010-03-13 23:49:13 -0800 | [diff] [blame] | 861 | static int __init firmware_class_init(void) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 862 | { |
Dmitry Torokhov | 673fae9 | 2010-03-13 23:49:13 -0800 | [diff] [blame] | 863 | return class_register(&firmware_class); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 864 | } |
Dmitry Torokhov | 673fae9 | 2010-03-13 23:49:13 -0800 | [diff] [blame] | 865 | |
| 866 | static void __exit firmware_class_exit(void) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 867 | { |
| 868 | class_unregister(&firmware_class); |
| 869 | } |
| 870 | |
Shaohua Li | a30a6a2 | 2006-09-27 01:50:52 -0700 | [diff] [blame] | 871 | fs_initcall(firmware_class_init); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 872 | module_exit(firmware_class_exit); |
| 873 | |
| 874 | EXPORT_SYMBOL(release_firmware); |
| 875 | EXPORT_SYMBOL(request_firmware); |
| 876 | EXPORT_SYMBOL(request_firmware_nowait); |