blob: 9916edda52711beb4c9756d24f3e72ca10e35f1d [file] [log] [blame]
Stephen Hemmingerfbb58582018-07-20 15:11:26 -07001// SPDX-License-Identifier: GPL-2.0
Hans J. Kochbeafc542006-12-07 10:58:29 +01002/*
3 * drivers/uio/uio.c
4 *
5 * Copyright(C) 2005, Benedikt Spranger <b.spranger@linutronix.de>
6 * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
Hans J. Koch318af552010-10-30 00:36:47 +02007 * Copyright(C) 2006, Hans J. Koch <hjk@hansjkoch.de>
Hans J. Kochbeafc542006-12-07 10:58:29 +01008 * Copyright(C) 2006, Greg Kroah-Hartman <greg@kroah.com>
9 *
10 * Userspace IO
11 *
12 * Base Functions
Hans J. Kochbeafc542006-12-07 10:58:29 +010013 */
14
15#include <linux/module.h>
16#include <linux/init.h>
17#include <linux/poll.h>
18#include <linux/device.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090019#include <linux/slab.h>
Hans J. Kochbeafc542006-12-07 10:58:29 +010020#include <linux/mm.h>
21#include <linux/idr.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010022#include <linux/sched/signal.h>
Hans J. Kochbeafc542006-12-07 10:58:29 +010023#include <linux/string.h>
24#include <linux/kobject.h>
Eric W. Biederman91960a42010-09-14 11:38:06 -070025#include <linux/cdev.h>
Hans J. Kochbeafc542006-12-07 10:58:29 +010026#include <linux/uio_driver.h>
27
Eric W. Biederman91960a42010-09-14 11:38:06 -070028#define UIO_MAX_DEVICES (1U << MINORBITS)
Hans J. Kochbeafc542006-12-07 10:58:29 +010029
Hans J. Kochbeafc542006-12-07 10:58:29 +010030static int uio_major;
Eric W. Biederman91960a42010-09-14 11:38:06 -070031static struct cdev *uio_cdev;
Hans J. Kochbeafc542006-12-07 10:58:29 +010032static DEFINE_IDR(uio_idr);
Jan Engelhardt4f014692008-01-22 20:50:54 +010033static const struct file_operations uio_fops;
Hans J. Kochbeafc542006-12-07 10:58:29 +010034
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -060035/* Protect idr accesses */
36static DEFINE_MUTEX(minor_lock);
37
Hans J. Kochbeafc542006-12-07 10:58:29 +010038/*
39 * attributes
40 */
41
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000042struct uio_map {
43 struct kobject kobj;
44 struct uio_mem *mem;
Hans J. Kochbeafc542006-12-07 10:58:29 +010045};
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000046#define to_map(map) container_of(map, struct uio_map, kobj)
Hans J. Kochbeafc542006-12-07 10:58:29 +010047
Hans J. Koch82057792009-01-07 00:15:39 +010048static ssize_t map_name_show(struct uio_mem *mem, char *buf)
49{
50 if (unlikely(!mem->name))
51 mem->name = "";
52
53 return sprintf(buf, "%s\n", mem->name);
54}
55
Brandon Philips4f808bc2008-02-19 01:55:05 -080056static ssize_t map_addr_show(struct uio_mem *mem, char *buf)
Hans J. Kochbeafc542006-12-07 10:58:29 +010057{
Cristian Stoicae0f11472014-10-09 15:00:27 +030058 return sprintf(buf, "%pa\n", &mem->addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +010059}
60
Brandon Philips4f808bc2008-02-19 01:55:05 -080061static ssize_t map_size_show(struct uio_mem *mem, char *buf)
62{
Cristian Stoicae0f11472014-10-09 15:00:27 +030063 return sprintf(buf, "%pa\n", &mem->size);
Brandon Philips4f808bc2008-02-19 01:55:05 -080064}
65
Hans J. Koche2b39df2008-09-18 23:53:18 +020066static ssize_t map_offset_show(struct uio_mem *mem, char *buf)
67{
Michal Sojka171058f2017-03-16 14:50:08 +010068 return sprintf(buf, "0x%llx\n", (unsigned long long)mem->offs);
Hans J. Koche2b39df2008-09-18 23:53:18 +020069}
70
Hans J. Koche70c4122008-12-06 02:23:13 +010071struct map_sysfs_entry {
Brandon Philips4f808bc2008-02-19 01:55:05 -080072 struct attribute attr;
73 ssize_t (*show)(struct uio_mem *, char *);
74 ssize_t (*store)(struct uio_mem *, const char *, size_t);
75};
76
Hans J. Koch82057792009-01-07 00:15:39 +010077static struct map_sysfs_entry name_attribute =
78 __ATTR(name, S_IRUGO, map_name_show, NULL);
Hans J. Koche70c4122008-12-06 02:23:13 +010079static struct map_sysfs_entry addr_attribute =
Brandon Philips4f808bc2008-02-19 01:55:05 -080080 __ATTR(addr, S_IRUGO, map_addr_show, NULL);
Hans J. Koche70c4122008-12-06 02:23:13 +010081static struct map_sysfs_entry size_attribute =
Brandon Philips4f808bc2008-02-19 01:55:05 -080082 __ATTR(size, S_IRUGO, map_size_show, NULL);
Hans J. Koche70c4122008-12-06 02:23:13 +010083static struct map_sysfs_entry offset_attribute =
Hans J. Koche2b39df2008-09-18 23:53:18 +020084 __ATTR(offset, S_IRUGO, map_offset_show, NULL);
Hans J. Kochbeafc542006-12-07 10:58:29 +010085
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000086static struct attribute *attrs[] = {
Hans J. Koch82057792009-01-07 00:15:39 +010087 &name_attribute.attr,
Brandon Philips4f808bc2008-02-19 01:55:05 -080088 &addr_attribute.attr,
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000089 &size_attribute.attr,
Hans J. Koche2b39df2008-09-18 23:53:18 +020090 &offset_attribute.attr,
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000091 NULL, /* need to NULL terminate the list of attributes */
Hans J. Kochbeafc542006-12-07 10:58:29 +010092};
93
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000094static void map_release(struct kobject *kobj)
95{
96 struct uio_map *map = to_map(kobj);
97 kfree(map);
98}
99
Brandon Philips4f808bc2008-02-19 01:55:05 -0800100static ssize_t map_type_show(struct kobject *kobj, struct attribute *attr,
101 char *buf)
102{
103 struct uio_map *map = to_map(kobj);
104 struct uio_mem *mem = map->mem;
Hans J. Koche70c4122008-12-06 02:23:13 +0100105 struct map_sysfs_entry *entry;
Brandon Philips4f808bc2008-02-19 01:55:05 -0800106
Hans J. Koche70c4122008-12-06 02:23:13 +0100107 entry = container_of(attr, struct map_sysfs_entry, attr);
Brandon Philips4f808bc2008-02-19 01:55:05 -0800108
109 if (!entry->show)
110 return -EIO;
111
112 return entry->show(mem, buf);
113}
114
Emese Revfy52cf25d2010-01-19 02:58:23 +0100115static const struct sysfs_ops map_sysfs_ops = {
Brandon Philips4f808bc2008-02-19 01:55:05 -0800116 .show = map_type_show,
117};
118
Hans J. Kochbeafc542006-12-07 10:58:29 +0100119static struct kobj_type map_attr_type = {
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000120 .release = map_release,
Hans J. Koche70c4122008-12-06 02:23:13 +0100121 .sysfs_ops = &map_sysfs_ops,
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000122 .default_attrs = attrs,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100123};
124
Hans J. Koche70c4122008-12-06 02:23:13 +0100125struct uio_portio {
126 struct kobject kobj;
127 struct uio_port *port;
128};
129#define to_portio(portio) container_of(portio, struct uio_portio, kobj)
130
Hans J. Koch82057792009-01-07 00:15:39 +0100131static ssize_t portio_name_show(struct uio_port *port, char *buf)
132{
133 if (unlikely(!port->name))
134 port->name = "";
135
136 return sprintf(buf, "%s\n", port->name);
137}
138
Hans J. Koche70c4122008-12-06 02:23:13 +0100139static ssize_t portio_start_show(struct uio_port *port, char *buf)
140{
141 return sprintf(buf, "0x%lx\n", port->start);
142}
143
144static ssize_t portio_size_show(struct uio_port *port, char *buf)
145{
146 return sprintf(buf, "0x%lx\n", port->size);
147}
148
149static ssize_t portio_porttype_show(struct uio_port *port, char *buf)
150{
151 const char *porttypes[] = {"none", "x86", "gpio", "other"};
152
153 if ((port->porttype < 0) || (port->porttype > UIO_PORT_OTHER))
154 return -EINVAL;
155
156 return sprintf(buf, "port_%s\n", porttypes[port->porttype]);
157}
158
159struct portio_sysfs_entry {
160 struct attribute attr;
161 ssize_t (*show)(struct uio_port *, char *);
162 ssize_t (*store)(struct uio_port *, const char *, size_t);
163};
164
Hans J. Koch82057792009-01-07 00:15:39 +0100165static struct portio_sysfs_entry portio_name_attribute =
166 __ATTR(name, S_IRUGO, portio_name_show, NULL);
Hans J. Koche70c4122008-12-06 02:23:13 +0100167static struct portio_sysfs_entry portio_start_attribute =
168 __ATTR(start, S_IRUGO, portio_start_show, NULL);
169static struct portio_sysfs_entry portio_size_attribute =
170 __ATTR(size, S_IRUGO, portio_size_show, NULL);
171static struct portio_sysfs_entry portio_porttype_attribute =
172 __ATTR(porttype, S_IRUGO, portio_porttype_show, NULL);
173
174static struct attribute *portio_attrs[] = {
Hans J. Koch82057792009-01-07 00:15:39 +0100175 &portio_name_attribute.attr,
Hans J. Koche70c4122008-12-06 02:23:13 +0100176 &portio_start_attribute.attr,
177 &portio_size_attribute.attr,
178 &portio_porttype_attribute.attr,
179 NULL,
180};
181
182static void portio_release(struct kobject *kobj)
183{
184 struct uio_portio *portio = to_portio(kobj);
185 kfree(portio);
186}
187
188static ssize_t portio_type_show(struct kobject *kobj, struct attribute *attr,
189 char *buf)
190{
191 struct uio_portio *portio = to_portio(kobj);
192 struct uio_port *port = portio->port;
193 struct portio_sysfs_entry *entry;
194
195 entry = container_of(attr, struct portio_sysfs_entry, attr);
196
197 if (!entry->show)
198 return -EIO;
199
200 return entry->show(port, buf);
201}
202
Emese Revfy52cf25d2010-01-19 02:58:23 +0100203static const struct sysfs_ops portio_sysfs_ops = {
Hans J. Koche70c4122008-12-06 02:23:13 +0100204 .show = portio_type_show,
205};
206
207static struct kobj_type portio_attr_type = {
208 .release = portio_release,
209 .sysfs_ops = &portio_sysfs_ops,
210 .default_attrs = portio_attrs,
211};
212
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700213static ssize_t name_show(struct device *dev,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100214 struct device_attribute *attr, char *buf)
215{
216 struct uio_device *idev = dev_get_drvdata(dev);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400217 int ret;
218
219 mutex_lock(&idev->info_lock);
220 if (!idev->info) {
221 ret = -EINVAL;
222 dev_err(dev, "the device has been unregistered\n");
223 goto out;
224 }
225
226 ret = sprintf(buf, "%s\n", idev->info->name);
227
228out:
229 mutex_unlock(&idev->info_lock);
230 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100231}
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700232static DEVICE_ATTR_RO(name);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100233
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700234static ssize_t version_show(struct device *dev,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100235 struct device_attribute *attr, char *buf)
236{
237 struct uio_device *idev = dev_get_drvdata(dev);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400238 int ret;
239
240 mutex_lock(&idev->info_lock);
241 if (!idev->info) {
242 ret = -EINVAL;
243 dev_err(dev, "the device has been unregistered\n");
244 goto out;
245 }
246
247 ret = sprintf(buf, "%s\n", idev->info->version);
248
249out:
250 mutex_unlock(&idev->info_lock);
251 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100252}
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700253static DEVICE_ATTR_RO(version);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100254
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700255static ssize_t event_show(struct device *dev,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100256 struct device_attribute *attr, char *buf)
257{
258 struct uio_device *idev = dev_get_drvdata(dev);
Eric W. Biederman70a91562010-09-14 11:36:54 -0700259 return sprintf(buf, "%u\n", (unsigned int)atomic_read(&idev->event));
Hans J. Kochbeafc542006-12-07 10:58:29 +0100260}
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700261static DEVICE_ATTR_RO(event);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100262
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700263static struct attribute *uio_attrs[] = {
264 &dev_attr_name.attr,
265 &dev_attr_version.attr,
266 &dev_attr_event.attr,
267 NULL,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100268};
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700269ATTRIBUTE_GROUPS(uio);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100270
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700271/* UIO class infrastructure */
272static struct class uio_class = {
273 .name = "uio",
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700274 .dev_groups = uio_groups,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100275};
276
Alexandre Bellonic21099b2018-08-16 09:39:41 +0200277bool uio_class_registered;
278
Hans J. Kochbeafc542006-12-07 10:58:29 +0100279/*
280 * device functions
281 */
282static int uio_dev_add_attributes(struct uio_device *idev)
283{
284 int ret;
Hans J. Koche70c4122008-12-06 02:23:13 +0100285 int mi, pi;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100286 int map_found = 0;
Hans J. Koche70c4122008-12-06 02:23:13 +0100287 int portio_found = 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100288 struct uio_mem *mem;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000289 struct uio_map *map;
Hans J. Koche70c4122008-12-06 02:23:13 +0100290 struct uio_port *port;
291 struct uio_portio *portio;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100292
Hans J. Kochbeafc542006-12-07 10:58:29 +0100293 for (mi = 0; mi < MAX_UIO_MAPS; mi++) {
294 mem = &idev->info->mem[mi];
295 if (mem->size == 0)
296 break;
297 if (!map_found) {
298 map_found = 1;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000299 idev->map_dir = kobject_create_and_add("maps",
Hamish Martina93e7b32018-05-14 13:32:23 +1200300 &idev->dev.kobj);
Dan Carpenter0320a272016-04-01 14:04:23 +0300301 if (!idev->map_dir) {
302 ret = -ENOMEM;
Hans J. Koche70c4122008-12-06 02:23:13 +0100303 goto err_map;
Dan Carpenter0320a272016-04-01 14:04:23 +0300304 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100305 }
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000306 map = kzalloc(sizeof(*map), GFP_KERNEL);
Dan Carpenter0320a272016-04-01 14:04:23 +0300307 if (!map) {
308 ret = -ENOMEM;
Suman Anna0d835392017-05-09 18:58:24 -0500309 goto err_map;
Dan Carpenter0320a272016-04-01 14:04:23 +0300310 }
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700311 kobject_init(&map->kobj, &map_attr_type);
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000312 map->mem = mem;
313 mem->map = map;
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700314 ret = kobject_add(&map->kobj, idev->map_dir, "map%d", mi);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100315 if (ret)
Cong Ding75f0aef2013-10-25 00:25:53 -0700316 goto err_map_kobj;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000317 ret = kobject_uevent(&map->kobj, KOBJ_ADD);
318 if (ret)
Suman Anna0d835392017-05-09 18:58:24 -0500319 goto err_map_kobj;
Hans J. Koche70c4122008-12-06 02:23:13 +0100320 }
321
322 for (pi = 0; pi < MAX_UIO_PORT_REGIONS; pi++) {
323 port = &idev->info->port[pi];
324 if (port->size == 0)
325 break;
326 if (!portio_found) {
327 portio_found = 1;
328 idev->portio_dir = kobject_create_and_add("portio",
Hamish Martina93e7b32018-05-14 13:32:23 +1200329 &idev->dev.kobj);
Dan Carpenter0320a272016-04-01 14:04:23 +0300330 if (!idev->portio_dir) {
331 ret = -ENOMEM;
Hans J. Koche70c4122008-12-06 02:23:13 +0100332 goto err_portio;
Dan Carpenter0320a272016-04-01 14:04:23 +0300333 }
Hans J. Koche70c4122008-12-06 02:23:13 +0100334 }
335 portio = kzalloc(sizeof(*portio), GFP_KERNEL);
Dan Carpenter0320a272016-04-01 14:04:23 +0300336 if (!portio) {
337 ret = -ENOMEM;
Suman Anna0d835392017-05-09 18:58:24 -0500338 goto err_portio;
Dan Carpenter0320a272016-04-01 14:04:23 +0300339 }
Hans J. Koche70c4122008-12-06 02:23:13 +0100340 kobject_init(&portio->kobj, &portio_attr_type);
341 portio->port = port;
342 port->portio = portio;
343 ret = kobject_add(&portio->kobj, idev->portio_dir,
344 "port%d", pi);
345 if (ret)
Cong Ding75f0aef2013-10-25 00:25:53 -0700346 goto err_portio_kobj;
Hans J. Koche70c4122008-12-06 02:23:13 +0100347 ret = kobject_uevent(&portio->kobj, KOBJ_ADD);
348 if (ret)
Suman Anna0d835392017-05-09 18:58:24 -0500349 goto err_portio_kobj;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100350 }
351
352 return 0;
353
Hans J. Koche70c4122008-12-06 02:23:13 +0100354err_portio:
Cong Ding75f0aef2013-10-25 00:25:53 -0700355 pi--;
356err_portio_kobj:
357 for (; pi >= 0; pi--) {
Hans J. Koche70c4122008-12-06 02:23:13 +0100358 port = &idev->info->port[pi];
359 portio = port->portio;
360 kobject_put(&portio->kobj);
361 }
362 kobject_put(idev->portio_dir);
363err_map:
Cong Ding75f0aef2013-10-25 00:25:53 -0700364 mi--;
365err_map_kobj:
366 for (; mi >= 0; mi--) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100367 mem = &idev->info->mem[mi];
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000368 map = mem->map;
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800369 kobject_put(&map->kobj);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100370 }
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800371 kobject_put(idev->map_dir);
Hamish Martina93e7b32018-05-14 13:32:23 +1200372 dev_err(&idev->dev, "error creating sysfs files (%d)\n", ret);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100373 return ret;
374}
375
376static void uio_dev_del_attributes(struct uio_device *idev)
377{
Hans J. Koche70c4122008-12-06 02:23:13 +0100378 int i;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100379 struct uio_mem *mem;
Hans J. Koche70c4122008-12-06 02:23:13 +0100380 struct uio_port *port;
381
382 for (i = 0; i < MAX_UIO_MAPS; i++) {
383 mem = &idev->info->mem[i];
Hans J. Kochbeafc542006-12-07 10:58:29 +0100384 if (mem->size == 0)
385 break;
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800386 kobject_put(&mem->map->kobj);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100387 }
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800388 kobject_put(idev->map_dir);
Hans J. Koche70c4122008-12-06 02:23:13 +0100389
390 for (i = 0; i < MAX_UIO_PORT_REGIONS; i++) {
391 port = &idev->info->port[i];
392 if (port->size == 0)
393 break;
394 kobject_put(&port->portio->kobj);
395 }
396 kobject_put(idev->portio_dir);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100397}
398
399static int uio_get_minor(struct uio_device *idev)
400{
Hans J. Kochbeafc542006-12-07 10:58:29 +0100401 int retval = -ENOMEM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100402
403 mutex_lock(&minor_lock);
Tejun Heo6d770932013-02-27 17:04:47 -0800404 retval = idr_alloc(&uio_idr, idev, 0, UIO_MAX_DEVICES, GFP_KERNEL);
405 if (retval >= 0) {
406 idev->minor = retval;
Damian Hobson-Garcia5ed05052013-03-26 10:31:22 +0900407 retval = 0;
Tejun Heo6d770932013-02-27 17:04:47 -0800408 } else if (retval == -ENOSPC) {
Hamish Martina93e7b32018-05-14 13:32:23 +1200409 dev_err(&idev->dev, "too many uio devices\n");
Hillf Dantonc6edc422011-03-31 20:38:47 +0800410 retval = -EINVAL;
Hillf Dantonc6edc422011-03-31 20:38:47 +0800411 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100412 mutex_unlock(&minor_lock);
413 return retval;
414}
415
416static void uio_free_minor(struct uio_device *idev)
417{
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600418 mutex_lock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100419 idr_remove(&uio_idr, idev->minor);
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600420 mutex_unlock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100421}
422
423/**
424 * uio_event_notify - trigger an interrupt event
425 * @info: UIO device capabilities
426 */
427void uio_event_notify(struct uio_info *info)
428{
429 struct uio_device *idev = info->uio_dev;
430
431 atomic_inc(&idev->event);
432 wake_up_interruptible(&idev->wait);
433 kill_fasync(&idev->async_queue, SIGIO, POLL_IN);
434}
435EXPORT_SYMBOL_GPL(uio_event_notify);
436
437/**
438 * uio_interrupt - hardware interrupt handler
439 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
440 * @dev_id: Pointer to the devices uio_device structure
441 */
442static irqreturn_t uio_interrupt(int irq, void *dev_id)
443{
444 struct uio_device *idev = (struct uio_device *)dev_id;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400445 irqreturn_t ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100446
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400447 ret = idev->info->handler(irq, idev->info);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100448 if (ret == IRQ_HANDLED)
449 uio_event_notify(idev->info);
450
451 return ret;
452}
453
454struct uio_listener {
455 struct uio_device *dev;
456 s32 event_count;
457};
458
459static int uio_open(struct inode *inode, struct file *filep)
460{
461 struct uio_device *idev;
462 struct uio_listener *listener;
463 int ret = 0;
464
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600465 mutex_lock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100466 idev = idr_find(&uio_idr, iminor(inode));
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600467 mutex_unlock(&minor_lock);
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600468 if (!idev) {
469 ret = -ENODEV;
470 goto out;
471 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100472
Hamish Martina93e7b32018-05-14 13:32:23 +1200473 get_device(&idev->dev);
474
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600475 if (!try_module_get(idev->owner)) {
476 ret = -ENODEV;
Hamish Martina93e7b32018-05-14 13:32:23 +1200477 goto err_module_get;
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600478 }
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200479
Hans J. Kochbeafc542006-12-07 10:58:29 +0100480 listener = kmalloc(sizeof(*listener), GFP_KERNEL);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200481 if (!listener) {
482 ret = -ENOMEM;
483 goto err_alloc_listener;
484 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100485
486 listener->dev = idev;
487 listener->event_count = atomic_read(&idev->event);
488 filep->private_data = listener;
489
Xiubo Li543af582018-07-06 22:05:38 -0400490 mutex_lock(&idev->info_lock);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400491 if (!idev->info) {
492 mutex_unlock(&idev->info_lock);
493 ret = -EINVAL;
494 goto err_alloc_listener;
495 }
496
Hamish Martina93e7b32018-05-14 13:32:23 +1200497 if (idev->info && idev->info->open)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100498 ret = idev->info->open(idev->info, inode);
Xiubo Li543af582018-07-06 22:05:38 -0400499 mutex_unlock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200500 if (ret)
501 goto err_infoopen;
502
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200503 return 0;
504
505err_infoopen:
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200506 kfree(listener);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200507
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600508err_alloc_listener:
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200509 module_put(idev->owner);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100510
Hamish Martina93e7b32018-05-14 13:32:23 +1200511err_module_get:
512 put_device(&idev->dev);
513
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600514out:
Hans J. Kochbeafc542006-12-07 10:58:29 +0100515 return ret;
516}
517
518static int uio_fasync(int fd, struct file *filep, int on)
519{
520 struct uio_listener *listener = filep->private_data;
521 struct uio_device *idev = listener->dev;
522
523 return fasync_helper(fd, filep, on, &idev->async_queue);
524}
525
526static int uio_release(struct inode *inode, struct file *filep)
527{
528 int ret = 0;
529 struct uio_listener *listener = filep->private_data;
530 struct uio_device *idev = listener->dev;
531
Xiubo Li543af582018-07-06 22:05:38 -0400532 mutex_lock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200533 if (idev->info && idev->info->release)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100534 ret = idev->info->release(idev->info, inode);
Xiubo Li543af582018-07-06 22:05:38 -0400535 mutex_unlock(&idev->info_lock);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200536
537 module_put(idev->owner);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100538 kfree(listener);
Hamish Martina93e7b32018-05-14 13:32:23 +1200539 put_device(&idev->dev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100540 return ret;
541}
542
Al Viroafc9a422017-07-03 06:39:46 -0400543static __poll_t uio_poll(struct file *filep, poll_table *wait)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100544{
545 struct uio_listener *listener = filep->private_data;
546 struct uio_device *idev = listener->dev;
Hamish Martina93e7b32018-05-14 13:32:23 +1200547 __poll_t ret = 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100548
Xiubo Li543af582018-07-06 22:05:38 -0400549 mutex_lock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200550 if (!idev->info || !idev->info->irq)
551 ret = -EIO;
Xiubo Li543af582018-07-06 22:05:38 -0400552 mutex_unlock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200553
554 if (ret)
555 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100556
557 poll_wait(filep, &idev->wait, wait);
558 if (listener->event_count != atomic_read(&idev->event))
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800559 return EPOLLIN | EPOLLRDNORM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100560 return 0;
561}
562
563static ssize_t uio_read(struct file *filep, char __user *buf,
564 size_t count, loff_t *ppos)
565{
566 struct uio_listener *listener = filep->private_data;
567 struct uio_device *idev = listener->dev;
568 DECLARE_WAITQUEUE(wait, current);
Hamish Martina93e7b32018-05-14 13:32:23 +1200569 ssize_t retval = 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100570 s32 event_count;
571
Xiubo Li543af582018-07-06 22:05:38 -0400572 mutex_lock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200573 if (!idev->info || !idev->info->irq)
574 retval = -EIO;
Xiubo Li543af582018-07-06 22:05:38 -0400575 mutex_unlock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200576
577 if (retval)
578 return retval;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100579
580 if (count != sizeof(s32))
581 return -EINVAL;
582
583 add_wait_queue(&idev->wait, &wait);
584
585 do {
586 set_current_state(TASK_INTERRUPTIBLE);
587
588 event_count = atomic_read(&idev->event);
589 if (event_count != listener->event_count) {
Michal Hockoedce5e62015-09-07 09:21:24 +0200590 __set_current_state(TASK_RUNNING);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100591 if (copy_to_user(buf, &event_count, count))
592 retval = -EFAULT;
593 else {
594 listener->event_count = event_count;
595 retval = count;
596 }
597 break;
598 }
599
600 if (filep->f_flags & O_NONBLOCK) {
601 retval = -EAGAIN;
602 break;
603 }
604
605 if (signal_pending(current)) {
606 retval = -ERESTARTSYS;
607 break;
608 }
609 schedule();
610 } while (1);
611
612 __set_current_state(TASK_RUNNING);
613 remove_wait_queue(&idev->wait, &wait);
614
615 return retval;
616}
617
Hans J. Koch328a14e2008-05-23 13:50:14 +0200618static ssize_t uio_write(struct file *filep, const char __user *buf,
619 size_t count, loff_t *ppos)
620{
621 struct uio_listener *listener = filep->private_data;
622 struct uio_device *idev = listener->dev;
623 ssize_t retval;
624 s32 irq_on;
625
Xiubo Lib34e9a12018-07-30 03:11:48 -0400626 if (count != sizeof(s32))
627 return -EINVAL;
628
629 if (copy_from_user(&irq_on, buf, count))
630 return -EFAULT;
631
Xiubo Li543af582018-07-06 22:05:38 -0400632 mutex_lock(&idev->info_lock);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400633 if (!idev->info) {
634 retval = -EINVAL;
635 goto out;
636 }
637
Hamish Martina93e7b32018-05-14 13:32:23 +1200638 if (!idev->info || !idev->info->irq) {
Hamish Martin81daa402018-05-14 13:32:22 +1200639 retval = -EIO;
640 goto out;
641 }
Hans J. Koch328a14e2008-05-23 13:50:14 +0200642
Hamish Martin81daa402018-05-14 13:32:22 +1200643 if (!idev->info->irqcontrol) {
644 retval = -ENOSYS;
645 goto out;
646 }
Hans J. Koch328a14e2008-05-23 13:50:14 +0200647
Hans J. Koch328a14e2008-05-23 13:50:14 +0200648 retval = idev->info->irqcontrol(idev->info, irq_on);
649
Hamish Martin81daa402018-05-14 13:32:22 +1200650out:
Xiubo Li543af582018-07-06 22:05:38 -0400651 mutex_unlock(&idev->info_lock);
Hans J. Koch328a14e2008-05-23 13:50:14 +0200652 return retval ? retval : sizeof(s32);
653}
654
Hans J. Kochbeafc542006-12-07 10:58:29 +0100655static int uio_find_mem_index(struct vm_area_struct *vma)
656{
Hans J. Kochbeafc542006-12-07 10:58:29 +0100657 struct uio_device *idev = vma->vm_private_data;
658
Hillf Dantonf0c554f2011-03-28 23:33:26 +0200659 if (vma->vm_pgoff < MAX_UIO_MAPS) {
660 if (idev->info->mem[vma->vm_pgoff].size == 0)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100661 return -1;
Hillf Dantonf0c554f2011-03-28 23:33:26 +0200662 return (int)vma->vm_pgoff;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100663 }
664 return -1;
665}
666
Souptick Joarder9b85e952018-04-17 00:03:55 +0530667static vm_fault_t uio_vma_fault(struct vm_fault *vmf)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100668{
Dave Jiang11bac802017-02-24 14:56:41 -0800669 struct uio_device *idev = vmf->vma->vm_private_data;
Nick Piggina18b6302008-02-06 01:37:35 -0800670 struct page *page;
Andrew G. Harvey02683ff2008-09-24 01:10:02 +0200671 unsigned long offset;
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000672 void *addr;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400673 int ret = 0;
674 int mi;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100675
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400676 mutex_lock(&idev->info_lock);
677 if (!idev->info) {
678 ret = VM_FAULT_SIGBUS;
679 goto out;
680 }
681
682 mi = uio_find_mem_index(vmf->vma);
683 if (mi < 0) {
684 ret = VM_FAULT_SIGBUS;
685 goto out;
686 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100687
Andrew G. Harvey02683ff2008-09-24 01:10:02 +0200688 /*
689 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
690 * to use mem[N].
691 */
692 offset = (vmf->pgoff - mi) << PAGE_SHIFT;
693
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000694 addr = (void *)(unsigned long)idev->info->mem[mi].addr + offset;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100695 if (idev->info->mem[mi].memtype == UIO_MEM_LOGICAL)
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000696 page = virt_to_page(addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100697 else
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000698 page = vmalloc_to_page(addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100699 get_page(page);
Nick Piggina18b6302008-02-06 01:37:35 -0800700 vmf->page = page;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400701
702out:
703 mutex_unlock(&idev->info_lock);
704
705 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100706}
707
Uwe Kleine-König72941512013-08-07 13:02:53 +0200708static const struct vm_operations_struct uio_logical_vm_ops = {
Nick Piggina18b6302008-02-06 01:37:35 -0800709 .fault = uio_vma_fault,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100710};
711
Uwe Kleine-König72941512013-08-07 13:02:53 +0200712static int uio_mmap_logical(struct vm_area_struct *vma)
713{
714 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
715 vma->vm_ops = &uio_logical_vm_ops;
Uwe Kleine-König72941512013-08-07 13:02:53 +0200716 return 0;
717}
718
719static const struct vm_operations_struct uio_physical_vm_ops = {
720#ifdef CONFIG_HAVE_IOREMAP_PROT
721 .access = generic_access_phys,
722#endif
723};
724
Hans J. Kochbeafc542006-12-07 10:58:29 +0100725static int uio_mmap_physical(struct vm_area_struct *vma)
726{
727 struct uio_device *idev = vma->vm_private_data;
728 int mi = uio_find_mem_index(vma);
Linus Torvalds7314e6132013-10-29 10:21:34 -0700729 struct uio_mem *mem;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400730
Hans J. Kochbeafc542006-12-07 10:58:29 +0100731 if (mi < 0)
732 return -EINVAL;
Linus Torvalds7314e6132013-10-29 10:21:34 -0700733 mem = idev->info->mem + mi;
734
Linus Torvaldsb6550282013-12-02 11:50:37 -0800735 if (mem->addr & ~PAGE_MASK)
736 return -ENODEV;
Greg Kroah-Hartmanb29f6802014-06-17 16:07:08 -0700737 if (vma->vm_end - vma->vm_start > mem->size)
Linus Torvalds7314e6132013-10-29 10:21:34 -0700738 return -EINVAL;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100739
Uwe Kleine-König72941512013-08-07 13:02:53 +0200740 vma->vm_ops = &uio_physical_vm_ops;
Jean-Samuel Chenardc9698d6b2008-03-14 11:28:36 +0100741 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
742
Linus Torvalds7314e6132013-10-29 10:21:34 -0700743 /*
744 * We cannot use the vm_iomap_memory() helper here,
745 * because vma->vm_pgoff is the map index we looked
746 * up above in uio_find_mem_index(), rather than an
747 * actual page offset into the mmap.
748 *
749 * So we just do the physical mmap without a page
750 * offset.
751 */
Hans J. Kochbeafc542006-12-07 10:58:29 +0100752 return remap_pfn_range(vma,
753 vma->vm_start,
Linus Torvalds7314e6132013-10-29 10:21:34 -0700754 mem->addr >> PAGE_SHIFT,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100755 vma->vm_end - vma->vm_start,
756 vma->vm_page_prot);
757}
758
Hans J. Kochbeafc542006-12-07 10:58:29 +0100759static int uio_mmap(struct file *filep, struct vm_area_struct *vma)
760{
761 struct uio_listener *listener = filep->private_data;
762 struct uio_device *idev = listener->dev;
763 int mi;
764 unsigned long requested_pages, actual_pages;
765 int ret = 0;
766
767 if (vma->vm_end < vma->vm_start)
768 return -EINVAL;
769
770 vma->vm_private_data = idev;
771
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400772 mutex_lock(&idev->info_lock);
773 if (!idev->info) {
774 ret = -EINVAL;
775 goto out;
776 }
777
Hans J. Kochbeafc542006-12-07 10:58:29 +0100778 mi = uio_find_mem_index(vma);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400779 if (mi < 0) {
780 ret = -EINVAL;
781 goto out;
782 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100783
Libin52c2dad2013-07-03 15:01:27 -0700784 requested_pages = vma_pages(vma);
Ian Abbott6da2d372009-02-24 17:22:59 +0000785 actual_pages = ((idev->info->mem[mi].addr & ~PAGE_MASK)
786 + idev->info->mem[mi].size + PAGE_SIZE -1) >> PAGE_SHIFT;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400787 if (requested_pages > actual_pages) {
788 ret = -EINVAL;
789 goto out;
790 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100791
792 if (idev->info->mmap) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100793 ret = idev->info->mmap(idev->info, vma);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400794 goto out;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100795 }
796
797 switch (idev->info->mem[mi].memtype) {
798 case UIO_MEM_PHYS:
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400799 ret = uio_mmap_physical(vma);
800 break;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100801 case UIO_MEM_LOGICAL:
802 case UIO_MEM_VIRTUAL:
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400803 ret = uio_mmap_logical(vma);
804 break;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100805 default:
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400806 ret = -EINVAL;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100807 }
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400808
809out:
810 mutex_unlock(&idev->info_lock);
Hailong Liue7de2592018-07-20 08:31:56 +0800811 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100812}
813
Jan Engelhardt4f014692008-01-22 20:50:54 +0100814static const struct file_operations uio_fops = {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100815 .owner = THIS_MODULE,
816 .open = uio_open,
817 .release = uio_release,
818 .read = uio_read,
Hans J. Koch328a14e2008-05-23 13:50:14 +0200819 .write = uio_write,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100820 .mmap = uio_mmap,
821 .poll = uio_poll,
822 .fasync = uio_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200823 .llseek = noop_llseek,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100824};
825
826static int uio_major_init(void)
827{
Eric W. Biederman91960a42010-09-14 11:38:06 -0700828 static const char name[] = "uio";
829 struct cdev *cdev = NULL;
830 dev_t uio_dev = 0;
831 int result;
832
833 result = alloc_chrdev_region(&uio_dev, 0, UIO_MAX_DEVICES, name);
834 if (result)
835 goto out;
836
837 result = -ENOMEM;
838 cdev = cdev_alloc();
839 if (!cdev)
840 goto out_unregister;
841
842 cdev->owner = THIS_MODULE;
843 cdev->ops = &uio_fops;
844 kobject_set_name(&cdev->kobj, "%s", name);
845
846 result = cdev_add(cdev, uio_dev, UIO_MAX_DEVICES);
847 if (result)
848 goto out_put;
849
850 uio_major = MAJOR(uio_dev);
851 uio_cdev = cdev;
Wanlong Gaod80df1c2011-08-20 12:12:08 +0800852 return 0;
Eric W. Biederman91960a42010-09-14 11:38:06 -0700853out_put:
854 kobject_put(&cdev->kobj);
855out_unregister:
856 unregister_chrdev_region(uio_dev, UIO_MAX_DEVICES);
Wanlong Gaod80df1c2011-08-20 12:12:08 +0800857out:
858 return result;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100859}
860
861static void uio_major_cleanup(void)
862{
Eric W. Biederman91960a42010-09-14 11:38:06 -0700863 unregister_chrdev_region(MKDEV(uio_major, 0), UIO_MAX_DEVICES);
864 cdev_del(uio_cdev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100865}
866
867static int init_uio_class(void)
868{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700869 int ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100870
871 /* This is the first time in here, set everything up properly */
872 ret = uio_major_init();
873 if (ret)
874 goto exit;
875
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700876 ret = class_register(&uio_class);
877 if (ret) {
878 printk(KERN_ERR "class_register failed for uio\n");
879 goto err_class_register;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100880 }
Alexandre Bellonic21099b2018-08-16 09:39:41 +0200881
882 uio_class_registered = true;
883
Hans J. Kochbeafc542006-12-07 10:58:29 +0100884 return 0;
885
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700886err_class_register:
Hans J. Kochbeafc542006-12-07 10:58:29 +0100887 uio_major_cleanup();
888exit:
889 return ret;
890}
891
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700892static void release_uio_class(void)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100893{
Alexandre Bellonic21099b2018-08-16 09:39:41 +0200894 uio_class_registered = false;
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700895 class_unregister(&uio_class);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100896 uio_major_cleanup();
Hans J. Kochbeafc542006-12-07 10:58:29 +0100897}
898
Hamish Martina93e7b32018-05-14 13:32:23 +1200899static void uio_device_release(struct device *dev)
900{
901 struct uio_device *idev = dev_get_drvdata(dev);
902
903 kfree(idev);
904}
905
Hans J. Kochbeafc542006-12-07 10:58:29 +0100906/**
907 * uio_register_device - register a new userspace IO device
908 * @owner: module that creates the new device
909 * @parent: parent device
910 * @info: UIO device capabilities
911 *
912 * returns zero on success or a negative error code.
913 */
914int __uio_register_device(struct module *owner,
915 struct device *parent,
916 struct uio_info *info)
917{
918 struct uio_device *idev;
919 int ret = 0;
920
Alexandre Bellonic21099b2018-08-16 09:39:41 +0200921 if (!uio_class_registered)
922 return -EPROBE_DEFER;
923
Hans J. Kochbeafc542006-12-07 10:58:29 +0100924 if (!parent || !info || !info->name || !info->version)
925 return -EINVAL;
926
927 info->uio_dev = NULL;
928
Hamish Martina93e7b32018-05-14 13:32:23 +1200929 idev = kzalloc(sizeof(*idev), GFP_KERNEL);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100930 if (!idev) {
Michal Simeke6789cd2013-09-12 07:39:59 +0200931 return -ENOMEM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100932 }
933
934 idev->owner = owner;
935 idev->info = info;
Xiubo Li543af582018-07-06 22:05:38 -0400936 mutex_init(&idev->info_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100937 init_waitqueue_head(&idev->wait);
938 atomic_set(&idev->event, 0);
939
940 ret = uio_get_minor(idev);
941 if (ret)
Michal Simeke6789cd2013-09-12 07:39:59 +0200942 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100943
Hamish Martina93e7b32018-05-14 13:32:23 +1200944 idev->dev.devt = MKDEV(uio_major, idev->minor);
945 idev->dev.class = &uio_class;
946 idev->dev.parent = parent;
947 idev->dev.release = uio_device_release;
948 dev_set_drvdata(&idev->dev, idev);
949
950 ret = dev_set_name(&idev->dev, "uio%d", idev->minor);
951 if (ret)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100952 goto err_device_create;
Hamish Martina93e7b32018-05-14 13:32:23 +1200953
954 ret = device_register(&idev->dev);
955 if (ret)
956 goto err_device_create;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100957
958 ret = uio_dev_add_attributes(idev);
959 if (ret)
960 goto err_uio_dev_add_attributes;
961
Eric W. Biederman6427a762010-09-14 11:37:36 -0700962 if (info->irq && (info->irq != UIO_IRQ_CUSTOM)) {
Brian Russella0871462015-03-19 17:55:26 +0000963 /*
964 * Note that we deliberately don't use devm_request_irq
965 * here. The parent module can unregister the UIO device
966 * and call pci_disable_msi, which requires that this
967 * irq has been freed. However, the device may have open
968 * FDs at the time of unregister and therefore may not be
969 * freed until they are released.
970 */
Xiubo Li3d27c4d2018-08-12 07:58:23 -0400971 ret = request_irq(info->irq, uio_interrupt,
972 info->irq_flags, info->name, idev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100973 if (ret)
974 goto err_request_irq;
975 }
976
Dan Carpenterf019f072018-08-02 11:24:47 +0300977 info->uio_dev = idev;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100978 return 0;
979
980err_request_irq:
981 uio_dev_del_attributes(idev);
982err_uio_dev_add_attributes:
Hamish Martina93e7b32018-05-14 13:32:23 +1200983 device_unregister(&idev->dev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100984err_device_create:
985 uio_free_minor(idev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100986 return ret;
987}
988EXPORT_SYMBOL_GPL(__uio_register_device);
989
990/**
991 * uio_unregister_device - unregister a industrial IO device
992 * @info: UIO device capabilities
993 *
994 */
995void uio_unregister_device(struct uio_info *info)
996{
997 struct uio_device *idev;
998
999 if (!info || !info->uio_dev)
1000 return;
1001
1002 idev = info->uio_dev;
1003
1004 uio_free_minor(idev);
1005
Xiubo Li57c5f4d2018-07-06 22:05:39 -04001006 mutex_lock(&idev->info_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +01001007 uio_dev_del_attributes(idev);
1008
Stephen Hemminger9ff2c132015-05-14 09:19:13 -07001009 if (info->irq && info->irq != UIO_IRQ_CUSTOM)
1010 free_irq(info->irq, idev);
Brian Russella0871462015-03-19 17:55:26 +00001011
Hamish Martina93e7b32018-05-14 13:32:23 +12001012 idev->info = NULL;
Xiubo Li543af582018-07-06 22:05:38 -04001013 mutex_unlock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +12001014
1015 device_unregister(&idev->dev);
Hans J. Kochbeafc542006-12-07 10:58:29 +01001016
1017 return;
1018}
1019EXPORT_SYMBOL_GPL(uio_unregister_device);
1020
1021static int __init uio_init(void)
1022{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -07001023 return init_uio_class();
Hans J. Kochbeafc542006-12-07 10:58:29 +01001024}
1025
1026static void __exit uio_exit(void)
1027{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -07001028 release_uio_class();
Johannes Thumshirne2ef9392015-07-08 17:24:46 +02001029 idr_destroy(&uio_idr);
Hans J. Kochbeafc542006-12-07 10:58:29 +01001030}
1031
1032module_init(uio_init)
1033module_exit(uio_exit)
1034MODULE_LICENSE("GPL v2");