blob: 5d421d7e8904fc633f9f25c0faf6d69ec1d8f498 [file] [log] [blame]
Hans J. Kochbeafc542006-12-07 10:58:29 +01001/*
2 * drivers/uio/uio.c
3 *
4 * Copyright(C) 2005, Benedikt Spranger <b.spranger@linutronix.de>
5 * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
Hans J. Koch318af552010-10-30 00:36:47 +02006 * Copyright(C) 2006, Hans J. Koch <hjk@hansjkoch.de>
Hans J. Kochbeafc542006-12-07 10:58:29 +01007 * Copyright(C) 2006, Greg Kroah-Hartman <greg@kroah.com>
8 *
9 * Userspace IO
10 *
11 * Base Functions
12 *
13 * Licensed under the GPLv2 only.
14 */
15
16#include <linux/module.h>
17#include <linux/init.h>
18#include <linux/poll.h>
19#include <linux/device.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090020#include <linux/slab.h>
Hans J. Kochbeafc542006-12-07 10:58:29 +010021#include <linux/mm.h>
22#include <linux/idr.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010023#include <linux/sched/signal.h>
Hans J. Kochbeafc542006-12-07 10:58:29 +010024#include <linux/string.h>
25#include <linux/kobject.h>
Eric W. Biederman91960a42010-09-14 11:38:06 -070026#include <linux/cdev.h>
Hans J. Kochbeafc542006-12-07 10:58:29 +010027#include <linux/uio_driver.h>
28
Eric W. Biederman91960a42010-09-14 11:38:06 -070029#define UIO_MAX_DEVICES (1U << MINORBITS)
Hans J. Kochbeafc542006-12-07 10:58:29 +010030
Hans J. Kochbeafc542006-12-07 10:58:29 +010031static int uio_major;
Eric W. Biederman91960a42010-09-14 11:38:06 -070032static struct cdev *uio_cdev;
Hans J. Kochbeafc542006-12-07 10:58:29 +010033static DEFINE_IDR(uio_idr);
Jan Engelhardt4f014692008-01-22 20:50:54 +010034static const struct file_operations uio_fops;
Hans J. Kochbeafc542006-12-07 10:58:29 +010035
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -060036/* Protect idr accesses */
37static DEFINE_MUTEX(minor_lock);
38
Hans J. Kochbeafc542006-12-07 10:58:29 +010039/*
40 * attributes
41 */
42
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000043struct uio_map {
44 struct kobject kobj;
45 struct uio_mem *mem;
Hans J. Kochbeafc542006-12-07 10:58:29 +010046};
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000047#define to_map(map) container_of(map, struct uio_map, kobj)
Hans J. Kochbeafc542006-12-07 10:58:29 +010048
Hans J. Koch82057792009-01-07 00:15:39 +010049static ssize_t map_name_show(struct uio_mem *mem, char *buf)
50{
51 if (unlikely(!mem->name))
52 mem->name = "";
53
54 return sprintf(buf, "%s\n", mem->name);
55}
56
Brandon Philips4f808bc2008-02-19 01:55:05 -080057static ssize_t map_addr_show(struct uio_mem *mem, char *buf)
Hans J. Kochbeafc542006-12-07 10:58:29 +010058{
Cristian Stoicae0f11472014-10-09 15:00:27 +030059 return sprintf(buf, "%pa\n", &mem->addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +010060}
61
Brandon Philips4f808bc2008-02-19 01:55:05 -080062static ssize_t map_size_show(struct uio_mem *mem, char *buf)
63{
Cristian Stoicae0f11472014-10-09 15:00:27 +030064 return sprintf(buf, "%pa\n", &mem->size);
Brandon Philips4f808bc2008-02-19 01:55:05 -080065}
66
Hans J. Koche2b39df2008-09-18 23:53:18 +020067static ssize_t map_offset_show(struct uio_mem *mem, char *buf)
68{
Michal Sojka171058fb2017-03-16 14:50:08 +010069 return sprintf(buf, "0x%llx\n", (unsigned long long)mem->offs);
Hans J. Koche2b39df2008-09-18 23:53:18 +020070}
71
Hans J. Koche70c4122008-12-06 02:23:13 +010072struct map_sysfs_entry {
Brandon Philips4f808bc2008-02-19 01:55:05 -080073 struct attribute attr;
74 ssize_t (*show)(struct uio_mem *, char *);
75 ssize_t (*store)(struct uio_mem *, const char *, size_t);
76};
77
Hans J. Koch82057792009-01-07 00:15:39 +010078static struct map_sysfs_entry name_attribute =
79 __ATTR(name, S_IRUGO, map_name_show, NULL);
Hans J. Koche70c4122008-12-06 02:23:13 +010080static struct map_sysfs_entry addr_attribute =
Brandon Philips4f808bc2008-02-19 01:55:05 -080081 __ATTR(addr, S_IRUGO, map_addr_show, NULL);
Hans J. Koche70c4122008-12-06 02:23:13 +010082static struct map_sysfs_entry size_attribute =
Brandon Philips4f808bc2008-02-19 01:55:05 -080083 __ATTR(size, S_IRUGO, map_size_show, NULL);
Hans J. Koche70c4122008-12-06 02:23:13 +010084static struct map_sysfs_entry offset_attribute =
Hans J. Koche2b39df2008-09-18 23:53:18 +020085 __ATTR(offset, S_IRUGO, map_offset_show, NULL);
Hans J. Kochbeafc542006-12-07 10:58:29 +010086
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000087static struct attribute *attrs[] = {
Hans J. Koch82057792009-01-07 00:15:39 +010088 &name_attribute.attr,
Brandon Philips4f808bc2008-02-19 01:55:05 -080089 &addr_attribute.attr,
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000090 &size_attribute.attr,
Hans J. Koche2b39df2008-09-18 23:53:18 +020091 &offset_attribute.attr,
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000092 NULL, /* need to NULL terminate the list of attributes */
Hans J. Kochbeafc542006-12-07 10:58:29 +010093};
94
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000095static void map_release(struct kobject *kobj)
96{
97 struct uio_map *map = to_map(kobj);
98 kfree(map);
99}
100
Brandon Philips4f808bc2008-02-19 01:55:05 -0800101static ssize_t map_type_show(struct kobject *kobj, struct attribute *attr,
102 char *buf)
103{
104 struct uio_map *map = to_map(kobj);
105 struct uio_mem *mem = map->mem;
Hans J. Koche70c4122008-12-06 02:23:13 +0100106 struct map_sysfs_entry *entry;
Brandon Philips4f808bc2008-02-19 01:55:05 -0800107
Hans J. Koche70c4122008-12-06 02:23:13 +0100108 entry = container_of(attr, struct map_sysfs_entry, attr);
Brandon Philips4f808bc2008-02-19 01:55:05 -0800109
110 if (!entry->show)
111 return -EIO;
112
113 return entry->show(mem, buf);
114}
115
Emese Revfy52cf25d2010-01-19 02:58:23 +0100116static const struct sysfs_ops map_sysfs_ops = {
Brandon Philips4f808bc2008-02-19 01:55:05 -0800117 .show = map_type_show,
118};
119
Hans J. Kochbeafc542006-12-07 10:58:29 +0100120static struct kobj_type map_attr_type = {
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000121 .release = map_release,
Hans J. Koche70c4122008-12-06 02:23:13 +0100122 .sysfs_ops = &map_sysfs_ops,
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000123 .default_attrs = attrs,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100124};
125
Hans J. Koche70c4122008-12-06 02:23:13 +0100126struct uio_portio {
127 struct kobject kobj;
128 struct uio_port *port;
129};
130#define to_portio(portio) container_of(portio, struct uio_portio, kobj)
131
Hans J. Koch82057792009-01-07 00:15:39 +0100132static ssize_t portio_name_show(struct uio_port *port, char *buf)
133{
134 if (unlikely(!port->name))
135 port->name = "";
136
137 return sprintf(buf, "%s\n", port->name);
138}
139
Hans J. Koche70c4122008-12-06 02:23:13 +0100140static ssize_t portio_start_show(struct uio_port *port, char *buf)
141{
142 return sprintf(buf, "0x%lx\n", port->start);
143}
144
145static ssize_t portio_size_show(struct uio_port *port, char *buf)
146{
147 return sprintf(buf, "0x%lx\n", port->size);
148}
149
150static ssize_t portio_porttype_show(struct uio_port *port, char *buf)
151{
152 const char *porttypes[] = {"none", "x86", "gpio", "other"};
153
154 if ((port->porttype < 0) || (port->porttype > UIO_PORT_OTHER))
155 return -EINVAL;
156
157 return sprintf(buf, "port_%s\n", porttypes[port->porttype]);
158}
159
160struct portio_sysfs_entry {
161 struct attribute attr;
162 ssize_t (*show)(struct uio_port *, char *);
163 ssize_t (*store)(struct uio_port *, const char *, size_t);
164};
165
Hans J. Koch82057792009-01-07 00:15:39 +0100166static struct portio_sysfs_entry portio_name_attribute =
167 __ATTR(name, S_IRUGO, portio_name_show, NULL);
Hans J. Koche70c4122008-12-06 02:23:13 +0100168static struct portio_sysfs_entry portio_start_attribute =
169 __ATTR(start, S_IRUGO, portio_start_show, NULL);
170static struct portio_sysfs_entry portio_size_attribute =
171 __ATTR(size, S_IRUGO, portio_size_show, NULL);
172static struct portio_sysfs_entry portio_porttype_attribute =
173 __ATTR(porttype, S_IRUGO, portio_porttype_show, NULL);
174
175static struct attribute *portio_attrs[] = {
Hans J. Koch82057792009-01-07 00:15:39 +0100176 &portio_name_attribute.attr,
Hans J. Koche70c4122008-12-06 02:23:13 +0100177 &portio_start_attribute.attr,
178 &portio_size_attribute.attr,
179 &portio_porttype_attribute.attr,
180 NULL,
181};
182
183static void portio_release(struct kobject *kobj)
184{
185 struct uio_portio *portio = to_portio(kobj);
186 kfree(portio);
187}
188
189static ssize_t portio_type_show(struct kobject *kobj, struct attribute *attr,
190 char *buf)
191{
192 struct uio_portio *portio = to_portio(kobj);
193 struct uio_port *port = portio->port;
194 struct portio_sysfs_entry *entry;
195
196 entry = container_of(attr, struct portio_sysfs_entry, attr);
197
198 if (!entry->show)
199 return -EIO;
200
201 return entry->show(port, buf);
202}
203
Emese Revfy52cf25d2010-01-19 02:58:23 +0100204static const struct sysfs_ops portio_sysfs_ops = {
Hans J. Koche70c4122008-12-06 02:23:13 +0100205 .show = portio_type_show,
206};
207
208static struct kobj_type portio_attr_type = {
209 .release = portio_release,
210 .sysfs_ops = &portio_sysfs_ops,
211 .default_attrs = portio_attrs,
212};
213
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700214static ssize_t name_show(struct device *dev,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100215 struct device_attribute *attr, char *buf)
216{
217 struct uio_device *idev = dev_get_drvdata(dev);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400218 int ret;
219
220 mutex_lock(&idev->info_lock);
221 if (!idev->info) {
222 ret = -EINVAL;
223 dev_err(dev, "the device has been unregistered\n");
224 goto out;
225 }
226
227 ret = sprintf(buf, "%s\n", idev->info->name);
228
229out:
230 mutex_unlock(&idev->info_lock);
231 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100232}
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700233static DEVICE_ATTR_RO(name);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100234
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700235static ssize_t version_show(struct device *dev,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100236 struct device_attribute *attr, char *buf)
237{
238 struct uio_device *idev = dev_get_drvdata(dev);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400239 int ret;
240
241 mutex_lock(&idev->info_lock);
242 if (!idev->info) {
243 ret = -EINVAL;
244 dev_err(dev, "the device has been unregistered\n");
245 goto out;
246 }
247
248 ret = sprintf(buf, "%s\n", idev->info->version);
249
250out:
251 mutex_unlock(&idev->info_lock);
252 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100253}
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700254static DEVICE_ATTR_RO(version);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100255
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700256static ssize_t event_show(struct device *dev,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100257 struct device_attribute *attr, char *buf)
258{
259 struct uio_device *idev = dev_get_drvdata(dev);
Eric W. Biederman70a91562010-09-14 11:36:54 -0700260 return sprintf(buf, "%u\n", (unsigned int)atomic_read(&idev->event));
Hans J. Kochbeafc542006-12-07 10:58:29 +0100261}
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700262static DEVICE_ATTR_RO(event);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100263
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700264static struct attribute *uio_attrs[] = {
265 &dev_attr_name.attr,
266 &dev_attr_version.attr,
267 &dev_attr_event.attr,
268 NULL,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100269};
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700270ATTRIBUTE_GROUPS(uio);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100271
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700272/* UIO class infrastructure */
273static struct class uio_class = {
274 .name = "uio",
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700275 .dev_groups = uio_groups,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100276};
277
278/*
279 * device functions
280 */
281static int uio_dev_add_attributes(struct uio_device *idev)
282{
283 int ret;
Hans J. Koche70c4122008-12-06 02:23:13 +0100284 int mi, pi;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100285 int map_found = 0;
Hans J. Koche70c4122008-12-06 02:23:13 +0100286 int portio_found = 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100287 struct uio_mem *mem;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000288 struct uio_map *map;
Hans J. Koche70c4122008-12-06 02:23:13 +0100289 struct uio_port *port;
290 struct uio_portio *portio;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100291
Hans J. Kochbeafc542006-12-07 10:58:29 +0100292 for (mi = 0; mi < MAX_UIO_MAPS; mi++) {
293 mem = &idev->info->mem[mi];
294 if (mem->size == 0)
295 break;
296 if (!map_found) {
297 map_found = 1;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000298 idev->map_dir = kobject_create_and_add("maps",
Hamish Martina93e7b32018-05-14 13:32:23 +1200299 &idev->dev.kobj);
Dan Carpenter0320a272016-04-01 14:04:23 +0300300 if (!idev->map_dir) {
301 ret = -ENOMEM;
Hans J. Koche70c4122008-12-06 02:23:13 +0100302 goto err_map;
Dan Carpenter0320a272016-04-01 14:04:23 +0300303 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100304 }
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000305 map = kzalloc(sizeof(*map), GFP_KERNEL);
Dan Carpenter0320a272016-04-01 14:04:23 +0300306 if (!map) {
307 ret = -ENOMEM;
Suman Anna0d835392017-05-09 18:58:24 -0500308 goto err_map;
Dan Carpenter0320a272016-04-01 14:04:23 +0300309 }
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700310 kobject_init(&map->kobj, &map_attr_type);
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000311 map->mem = mem;
312 mem->map = map;
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700313 ret = kobject_add(&map->kobj, idev->map_dir, "map%d", mi);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100314 if (ret)
Cong Ding75f0aef2013-10-25 00:25:53 -0700315 goto err_map_kobj;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000316 ret = kobject_uevent(&map->kobj, KOBJ_ADD);
317 if (ret)
Suman Anna0d835392017-05-09 18:58:24 -0500318 goto err_map_kobj;
Hans J. Koche70c4122008-12-06 02:23:13 +0100319 }
320
321 for (pi = 0; pi < MAX_UIO_PORT_REGIONS; pi++) {
322 port = &idev->info->port[pi];
323 if (port->size == 0)
324 break;
325 if (!portio_found) {
326 portio_found = 1;
327 idev->portio_dir = kobject_create_and_add("portio",
Hamish Martina93e7b32018-05-14 13:32:23 +1200328 &idev->dev.kobj);
Dan Carpenter0320a272016-04-01 14:04:23 +0300329 if (!idev->portio_dir) {
330 ret = -ENOMEM;
Hans J. Koche70c4122008-12-06 02:23:13 +0100331 goto err_portio;
Dan Carpenter0320a272016-04-01 14:04:23 +0300332 }
Hans J. Koche70c4122008-12-06 02:23:13 +0100333 }
334 portio = kzalloc(sizeof(*portio), GFP_KERNEL);
Dan Carpenter0320a272016-04-01 14:04:23 +0300335 if (!portio) {
336 ret = -ENOMEM;
Suman Anna0d835392017-05-09 18:58:24 -0500337 goto err_portio;
Dan Carpenter0320a272016-04-01 14:04:23 +0300338 }
Hans J. Koche70c4122008-12-06 02:23:13 +0100339 kobject_init(&portio->kobj, &portio_attr_type);
340 portio->port = port;
341 port->portio = portio;
342 ret = kobject_add(&portio->kobj, idev->portio_dir,
343 "port%d", pi);
344 if (ret)
Cong Ding75f0aef2013-10-25 00:25:53 -0700345 goto err_portio_kobj;
Hans J. Koche70c4122008-12-06 02:23:13 +0100346 ret = kobject_uevent(&portio->kobj, KOBJ_ADD);
347 if (ret)
Suman Anna0d835392017-05-09 18:58:24 -0500348 goto err_portio_kobj;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100349 }
350
351 return 0;
352
Hans J. Koche70c4122008-12-06 02:23:13 +0100353err_portio:
Cong Ding75f0aef2013-10-25 00:25:53 -0700354 pi--;
355err_portio_kobj:
356 for (; pi >= 0; pi--) {
Hans J. Koche70c4122008-12-06 02:23:13 +0100357 port = &idev->info->port[pi];
358 portio = port->portio;
359 kobject_put(&portio->kobj);
360 }
361 kobject_put(idev->portio_dir);
362err_map:
Cong Ding75f0aef2013-10-25 00:25:53 -0700363 mi--;
364err_map_kobj:
365 for (; mi >= 0; mi--) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100366 mem = &idev->info->mem[mi];
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000367 map = mem->map;
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800368 kobject_put(&map->kobj);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100369 }
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800370 kobject_put(idev->map_dir);
Hamish Martina93e7b32018-05-14 13:32:23 +1200371 dev_err(&idev->dev, "error creating sysfs files (%d)\n", ret);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100372 return ret;
373}
374
375static void uio_dev_del_attributes(struct uio_device *idev)
376{
Hans J. Koche70c4122008-12-06 02:23:13 +0100377 int i;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100378 struct uio_mem *mem;
Hans J. Koche70c4122008-12-06 02:23:13 +0100379 struct uio_port *port;
380
381 for (i = 0; i < MAX_UIO_MAPS; i++) {
382 mem = &idev->info->mem[i];
Hans J. Kochbeafc542006-12-07 10:58:29 +0100383 if (mem->size == 0)
384 break;
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800385 kobject_put(&mem->map->kobj);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100386 }
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800387 kobject_put(idev->map_dir);
Hans J. Koche70c4122008-12-06 02:23:13 +0100388
389 for (i = 0; i < MAX_UIO_PORT_REGIONS; i++) {
390 port = &idev->info->port[i];
391 if (port->size == 0)
392 break;
393 kobject_put(&port->portio->kobj);
394 }
395 kobject_put(idev->portio_dir);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100396}
397
398static int uio_get_minor(struct uio_device *idev)
399{
Hans J. Kochbeafc542006-12-07 10:58:29 +0100400 int retval = -ENOMEM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100401
402 mutex_lock(&minor_lock);
Tejun Heo6d770932013-02-27 17:04:47 -0800403 retval = idr_alloc(&uio_idr, idev, 0, UIO_MAX_DEVICES, GFP_KERNEL);
404 if (retval >= 0) {
405 idev->minor = retval;
Damian Hobson-Garcia5ed05052013-03-26 10:31:22 +0900406 retval = 0;
Tejun Heo6d770932013-02-27 17:04:47 -0800407 } else if (retval == -ENOSPC) {
Hamish Martina93e7b32018-05-14 13:32:23 +1200408 dev_err(&idev->dev, "too many uio devices\n");
Hillf Dantonc6edc422011-03-31 20:38:47 +0800409 retval = -EINVAL;
Hillf Dantonc6edc422011-03-31 20:38:47 +0800410 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100411 mutex_unlock(&minor_lock);
412 return retval;
413}
414
415static void uio_free_minor(struct uio_device *idev)
416{
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600417 mutex_lock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100418 idr_remove(&uio_idr, idev->minor);
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600419 mutex_unlock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100420}
421
422/**
423 * uio_event_notify - trigger an interrupt event
424 * @info: UIO device capabilities
425 */
426void uio_event_notify(struct uio_info *info)
427{
428 struct uio_device *idev = info->uio_dev;
429
430 atomic_inc(&idev->event);
431 wake_up_interruptible(&idev->wait);
432 kill_fasync(&idev->async_queue, SIGIO, POLL_IN);
433}
434EXPORT_SYMBOL_GPL(uio_event_notify);
435
436/**
437 * uio_interrupt - hardware interrupt handler
438 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
439 * @dev_id: Pointer to the devices uio_device structure
440 */
441static irqreturn_t uio_interrupt(int irq, void *dev_id)
442{
443 struct uio_device *idev = (struct uio_device *)dev_id;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400444 irqreturn_t ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100445
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400446 mutex_lock(&idev->info_lock);
447
448 ret = idev->info->handler(irq, idev->info);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100449 if (ret == IRQ_HANDLED)
450 uio_event_notify(idev->info);
451
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400452 mutex_unlock(&idev->info_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100453 return ret;
454}
455
456struct uio_listener {
457 struct uio_device *dev;
458 s32 event_count;
459};
460
461static int uio_open(struct inode *inode, struct file *filep)
462{
463 struct uio_device *idev;
464 struct uio_listener *listener;
465 int ret = 0;
466
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600467 mutex_lock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100468 idev = idr_find(&uio_idr, iminor(inode));
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600469 mutex_unlock(&minor_lock);
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600470 if (!idev) {
471 ret = -ENODEV;
472 goto out;
473 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100474
Hamish Martina93e7b32018-05-14 13:32:23 +1200475 get_device(&idev->dev);
476
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600477 if (!try_module_get(idev->owner)) {
478 ret = -ENODEV;
Hamish Martina93e7b32018-05-14 13:32:23 +1200479 goto err_module_get;
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600480 }
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200481
Hans J. Kochbeafc542006-12-07 10:58:29 +0100482 listener = kmalloc(sizeof(*listener), GFP_KERNEL);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200483 if (!listener) {
484 ret = -ENOMEM;
485 goto err_alloc_listener;
486 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100487
488 listener->dev = idev;
489 listener->event_count = atomic_read(&idev->event);
490 filep->private_data = listener;
491
Xiubo Li543af582018-07-06 22:05:38 -0400492 mutex_lock(&idev->info_lock);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400493 if (!idev->info) {
494 mutex_unlock(&idev->info_lock);
495 ret = -EINVAL;
496 goto err_alloc_listener;
497 }
498
Hamish Martina93e7b32018-05-14 13:32:23 +1200499 if (idev->info && idev->info->open)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100500 ret = idev->info->open(idev->info, inode);
Xiubo Li543af582018-07-06 22:05:38 -0400501 mutex_unlock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200502 if (ret)
503 goto err_infoopen;
504
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200505 return 0;
506
507err_infoopen:
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200508 kfree(listener);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200509
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600510err_alloc_listener:
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200511 module_put(idev->owner);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100512
Hamish Martina93e7b32018-05-14 13:32:23 +1200513err_module_get:
514 put_device(&idev->dev);
515
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600516out:
Hans J. Kochbeafc542006-12-07 10:58:29 +0100517 return ret;
518}
519
520static int uio_fasync(int fd, struct file *filep, int on)
521{
522 struct uio_listener *listener = filep->private_data;
523 struct uio_device *idev = listener->dev;
524
525 return fasync_helper(fd, filep, on, &idev->async_queue);
526}
527
528static int uio_release(struct inode *inode, struct file *filep)
529{
530 int ret = 0;
531 struct uio_listener *listener = filep->private_data;
532 struct uio_device *idev = listener->dev;
533
Xiubo Li543af582018-07-06 22:05:38 -0400534 mutex_lock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200535 if (idev->info && idev->info->release)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100536 ret = idev->info->release(idev->info, inode);
Xiubo Li543af582018-07-06 22:05:38 -0400537 mutex_unlock(&idev->info_lock);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200538
539 module_put(idev->owner);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100540 kfree(listener);
Hamish Martina93e7b32018-05-14 13:32:23 +1200541 put_device(&idev->dev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100542 return ret;
543}
544
Al Viroafc9a422017-07-03 06:39:46 -0400545static __poll_t uio_poll(struct file *filep, poll_table *wait)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100546{
547 struct uio_listener *listener = filep->private_data;
548 struct uio_device *idev = listener->dev;
Hamish Martina93e7b32018-05-14 13:32:23 +1200549 __poll_t ret = 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100550
Xiubo Li543af582018-07-06 22:05:38 -0400551 mutex_lock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200552 if (!idev->info || !idev->info->irq)
553 ret = -EIO;
Xiubo Li543af582018-07-06 22:05:38 -0400554 mutex_unlock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200555
556 if (ret)
557 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100558
559 poll_wait(filep, &idev->wait, wait);
560 if (listener->event_count != atomic_read(&idev->event))
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800561 return EPOLLIN | EPOLLRDNORM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100562 return 0;
563}
564
565static ssize_t uio_read(struct file *filep, char __user *buf,
566 size_t count, loff_t *ppos)
567{
568 struct uio_listener *listener = filep->private_data;
569 struct uio_device *idev = listener->dev;
570 DECLARE_WAITQUEUE(wait, current);
Hamish Martina93e7b32018-05-14 13:32:23 +1200571 ssize_t retval = 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100572 s32 event_count;
573
Xiubo Li543af582018-07-06 22:05:38 -0400574 mutex_lock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200575 if (!idev->info || !idev->info->irq)
576 retval = -EIO;
Xiubo Li543af582018-07-06 22:05:38 -0400577 mutex_unlock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +1200578
579 if (retval)
580 return retval;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100581
582 if (count != sizeof(s32))
583 return -EINVAL;
584
585 add_wait_queue(&idev->wait, &wait);
586
587 do {
588 set_current_state(TASK_INTERRUPTIBLE);
589
590 event_count = atomic_read(&idev->event);
591 if (event_count != listener->event_count) {
Michal Hockoedce5e62015-09-07 09:21:24 +0200592 __set_current_state(TASK_RUNNING);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100593 if (copy_to_user(buf, &event_count, count))
594 retval = -EFAULT;
595 else {
596 listener->event_count = event_count;
597 retval = count;
598 }
599 break;
600 }
601
602 if (filep->f_flags & O_NONBLOCK) {
603 retval = -EAGAIN;
604 break;
605 }
606
607 if (signal_pending(current)) {
608 retval = -ERESTARTSYS;
609 break;
610 }
611 schedule();
612 } while (1);
613
614 __set_current_state(TASK_RUNNING);
615 remove_wait_queue(&idev->wait, &wait);
616
617 return retval;
618}
619
Hans J. Koch328a14e2008-05-23 13:50:14 +0200620static ssize_t uio_write(struct file *filep, const char __user *buf,
621 size_t count, loff_t *ppos)
622{
623 struct uio_listener *listener = filep->private_data;
624 struct uio_device *idev = listener->dev;
625 ssize_t retval;
626 s32 irq_on;
627
Xiubo Li543af582018-07-06 22:05:38 -0400628 mutex_lock(&idev->info_lock);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400629 if (!idev->info) {
630 retval = -EINVAL;
631 goto out;
632 }
633
Hamish Martina93e7b32018-05-14 13:32:23 +1200634 if (!idev->info || !idev->info->irq) {
Hamish Martin81daa402018-05-14 13:32:22 +1200635 retval = -EIO;
636 goto out;
637 }
Hans J. Koch328a14e2008-05-23 13:50:14 +0200638
Hamish Martin81daa402018-05-14 13:32:22 +1200639 if (count != sizeof(s32)) {
640 retval = -EINVAL;
641 goto out;
642 }
Hans J. Koch328a14e2008-05-23 13:50:14 +0200643
Hamish Martin81daa402018-05-14 13:32:22 +1200644 if (!idev->info->irqcontrol) {
645 retval = -ENOSYS;
646 goto out;
647 }
Hans J. Koch328a14e2008-05-23 13:50:14 +0200648
Hamish Martin81daa402018-05-14 13:32:22 +1200649 if (copy_from_user(&irq_on, buf, count)) {
650 retval = -EFAULT;
651 goto out;
652 }
Hans J. Koch328a14e2008-05-23 13:50:14 +0200653
654 retval = idev->info->irqcontrol(idev->info, irq_on);
655
Hamish Martin81daa402018-05-14 13:32:22 +1200656out:
Xiubo Li543af582018-07-06 22:05:38 -0400657 mutex_unlock(&idev->info_lock);
Hans J. Koch328a14e2008-05-23 13:50:14 +0200658 return retval ? retval : sizeof(s32);
659}
660
Hans J. Kochbeafc542006-12-07 10:58:29 +0100661static int uio_find_mem_index(struct vm_area_struct *vma)
662{
Hans J. Kochbeafc542006-12-07 10:58:29 +0100663 struct uio_device *idev = vma->vm_private_data;
664
Hillf Dantonf0c554f2011-03-28 23:33:26 +0200665 if (vma->vm_pgoff < MAX_UIO_MAPS) {
666 if (idev->info->mem[vma->vm_pgoff].size == 0)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100667 return -1;
Hillf Dantonf0c554f2011-03-28 23:33:26 +0200668 return (int)vma->vm_pgoff;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100669 }
670 return -1;
671}
672
Souptick Joarder9b85e952018-04-17 00:03:55 +0530673static vm_fault_t uio_vma_fault(struct vm_fault *vmf)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100674{
Dave Jiang11bac802017-02-24 14:56:41 -0800675 struct uio_device *idev = vmf->vma->vm_private_data;
Nick Piggina18b6302008-02-06 01:37:35 -0800676 struct page *page;
Andrew G. Harvey02683ff2008-09-24 01:10:02 +0200677 unsigned long offset;
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000678 void *addr;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400679 int ret = 0;
680 int mi;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100681
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400682 mutex_lock(&idev->info_lock);
683 if (!idev->info) {
684 ret = VM_FAULT_SIGBUS;
685 goto out;
686 }
687
688 mi = uio_find_mem_index(vmf->vma);
689 if (mi < 0) {
690 ret = VM_FAULT_SIGBUS;
691 goto out;
692 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100693
Andrew G. Harvey02683ff2008-09-24 01:10:02 +0200694 /*
695 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
696 * to use mem[N].
697 */
698 offset = (vmf->pgoff - mi) << PAGE_SHIFT;
699
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000700 addr = (void *)(unsigned long)idev->info->mem[mi].addr + offset;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100701 if (idev->info->mem[mi].memtype == UIO_MEM_LOGICAL)
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000702 page = virt_to_page(addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100703 else
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000704 page = vmalloc_to_page(addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100705 get_page(page);
Nick Piggina18b6302008-02-06 01:37:35 -0800706 vmf->page = page;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400707
708out:
709 mutex_unlock(&idev->info_lock);
710
711 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100712}
713
Uwe Kleine-König72941512013-08-07 13:02:53 +0200714static const struct vm_operations_struct uio_logical_vm_ops = {
Nick Piggina18b6302008-02-06 01:37:35 -0800715 .fault = uio_vma_fault,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100716};
717
Uwe Kleine-König72941512013-08-07 13:02:53 +0200718static int uio_mmap_logical(struct vm_area_struct *vma)
719{
720 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
721 vma->vm_ops = &uio_logical_vm_ops;
Uwe Kleine-König72941512013-08-07 13:02:53 +0200722 return 0;
723}
724
725static const struct vm_operations_struct uio_physical_vm_ops = {
726#ifdef CONFIG_HAVE_IOREMAP_PROT
727 .access = generic_access_phys,
728#endif
729};
730
Hans J. Kochbeafc542006-12-07 10:58:29 +0100731static int uio_mmap_physical(struct vm_area_struct *vma)
732{
733 struct uio_device *idev = vma->vm_private_data;
734 int mi = uio_find_mem_index(vma);
Linus Torvalds7314e612013-10-29 10:21:34 -0700735 struct uio_mem *mem;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400736
Hans J. Kochbeafc542006-12-07 10:58:29 +0100737 if (mi < 0)
738 return -EINVAL;
Linus Torvalds7314e612013-10-29 10:21:34 -0700739 mem = idev->info->mem + mi;
740
Linus Torvaldsb6550282013-12-02 11:50:37 -0800741 if (mem->addr & ~PAGE_MASK)
742 return -ENODEV;
Greg Kroah-Hartmanb29f6802014-06-17 16:07:08 -0700743 if (vma->vm_end - vma->vm_start > mem->size)
Linus Torvalds7314e612013-10-29 10:21:34 -0700744 return -EINVAL;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100745
Uwe Kleine-König72941512013-08-07 13:02:53 +0200746 vma->vm_ops = &uio_physical_vm_ops;
Jean-Samuel Chenardc9698d6b2008-03-14 11:28:36 +0100747 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
748
Linus Torvalds7314e612013-10-29 10:21:34 -0700749 /*
750 * We cannot use the vm_iomap_memory() helper here,
751 * because vma->vm_pgoff is the map index we looked
752 * up above in uio_find_mem_index(), rather than an
753 * actual page offset into the mmap.
754 *
755 * So we just do the physical mmap without a page
756 * offset.
757 */
Hans J. Kochbeafc542006-12-07 10:58:29 +0100758 return remap_pfn_range(vma,
759 vma->vm_start,
Linus Torvalds7314e612013-10-29 10:21:34 -0700760 mem->addr >> PAGE_SHIFT,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100761 vma->vm_end - vma->vm_start,
762 vma->vm_page_prot);
763}
764
Hans J. Kochbeafc542006-12-07 10:58:29 +0100765static int uio_mmap(struct file *filep, struct vm_area_struct *vma)
766{
767 struct uio_listener *listener = filep->private_data;
768 struct uio_device *idev = listener->dev;
769 int mi;
770 unsigned long requested_pages, actual_pages;
771 int ret = 0;
772
773 if (vma->vm_end < vma->vm_start)
774 return -EINVAL;
775
776 vma->vm_private_data = idev;
777
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400778 mutex_lock(&idev->info_lock);
779 if (!idev->info) {
780 ret = -EINVAL;
781 goto out;
782 }
783
Hans J. Kochbeafc542006-12-07 10:58:29 +0100784 mi = uio_find_mem_index(vma);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400785 if (mi < 0) {
786 ret = -EINVAL;
787 goto out;
788 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100789
Libin52c2dad2013-07-03 15:01:27 -0700790 requested_pages = vma_pages(vma);
Ian Abbott6da2d372009-02-24 17:22:59 +0000791 actual_pages = ((idev->info->mem[mi].addr & ~PAGE_MASK)
792 + idev->info->mem[mi].size + PAGE_SIZE -1) >> PAGE_SHIFT;
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400793 if (requested_pages > actual_pages) {
794 ret = -EINVAL;
795 goto out;
796 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100797
798 if (idev->info->mmap) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100799 ret = idev->info->mmap(idev->info, vma);
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400800 goto out;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100801 }
802
803 switch (idev->info->mem[mi].memtype) {
804 case UIO_MEM_PHYS:
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400805 ret = uio_mmap_physical(vma);
806 break;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100807 case UIO_MEM_LOGICAL:
808 case UIO_MEM_VIRTUAL:
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400809 ret = uio_mmap_logical(vma);
810 break;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100811 default:
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400812 ret = -EINVAL;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100813 }
Xiubo Li57c5f4d2018-07-06 22:05:39 -0400814
815out:
816 mutex_unlock(&idev->info_lock);
817 return 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100818}
819
Jan Engelhardt4f014692008-01-22 20:50:54 +0100820static const struct file_operations uio_fops = {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100821 .owner = THIS_MODULE,
822 .open = uio_open,
823 .release = uio_release,
824 .read = uio_read,
Hans J. Koch328a14e2008-05-23 13:50:14 +0200825 .write = uio_write,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100826 .mmap = uio_mmap,
827 .poll = uio_poll,
828 .fasync = uio_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200829 .llseek = noop_llseek,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100830};
831
832static int uio_major_init(void)
833{
Eric W. Biederman91960a42010-09-14 11:38:06 -0700834 static const char name[] = "uio";
835 struct cdev *cdev = NULL;
836 dev_t uio_dev = 0;
837 int result;
838
839 result = alloc_chrdev_region(&uio_dev, 0, UIO_MAX_DEVICES, name);
840 if (result)
841 goto out;
842
843 result = -ENOMEM;
844 cdev = cdev_alloc();
845 if (!cdev)
846 goto out_unregister;
847
848 cdev->owner = THIS_MODULE;
849 cdev->ops = &uio_fops;
850 kobject_set_name(&cdev->kobj, "%s", name);
851
852 result = cdev_add(cdev, uio_dev, UIO_MAX_DEVICES);
853 if (result)
854 goto out_put;
855
856 uio_major = MAJOR(uio_dev);
857 uio_cdev = cdev;
Wanlong Gaod80df1c2011-08-20 12:12:08 +0800858 return 0;
Eric W. Biederman91960a42010-09-14 11:38:06 -0700859out_put:
860 kobject_put(&cdev->kobj);
861out_unregister:
862 unregister_chrdev_region(uio_dev, UIO_MAX_DEVICES);
Wanlong Gaod80df1c2011-08-20 12:12:08 +0800863out:
864 return result;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100865}
866
867static void uio_major_cleanup(void)
868{
Eric W. Biederman91960a42010-09-14 11:38:06 -0700869 unregister_chrdev_region(MKDEV(uio_major, 0), UIO_MAX_DEVICES);
870 cdev_del(uio_cdev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100871}
872
873static int init_uio_class(void)
874{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700875 int ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100876
877 /* This is the first time in here, set everything up properly */
878 ret = uio_major_init();
879 if (ret)
880 goto exit;
881
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700882 ret = class_register(&uio_class);
883 if (ret) {
884 printk(KERN_ERR "class_register failed for uio\n");
885 goto err_class_register;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100886 }
887 return 0;
888
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700889err_class_register:
Hans J. Kochbeafc542006-12-07 10:58:29 +0100890 uio_major_cleanup();
891exit:
892 return ret;
893}
894
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700895static void release_uio_class(void)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100896{
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700897 class_unregister(&uio_class);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100898 uio_major_cleanup();
Hans J. Kochbeafc542006-12-07 10:58:29 +0100899}
900
Hamish Martina93e7b32018-05-14 13:32:23 +1200901static void uio_device_release(struct device *dev)
902{
903 struct uio_device *idev = dev_get_drvdata(dev);
904
905 kfree(idev);
906}
907
Hans J. Kochbeafc542006-12-07 10:58:29 +0100908/**
909 * uio_register_device - register a new userspace IO device
910 * @owner: module that creates the new device
911 * @parent: parent device
912 * @info: UIO device capabilities
913 *
914 * returns zero on success or a negative error code.
915 */
916int __uio_register_device(struct module *owner,
917 struct device *parent,
918 struct uio_info *info)
919{
920 struct uio_device *idev;
921 int ret = 0;
922
923 if (!parent || !info || !info->name || !info->version)
924 return -EINVAL;
925
926 info->uio_dev = NULL;
927
Hamish Martina93e7b32018-05-14 13:32:23 +1200928 idev = kzalloc(sizeof(*idev), GFP_KERNEL);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100929 if (!idev) {
Michal Simeke6789cd2013-09-12 07:39:59 +0200930 return -ENOMEM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100931 }
932
933 idev->owner = owner;
934 idev->info = info;
Xiubo Li543af582018-07-06 22:05:38 -0400935 mutex_init(&idev->info_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100936 init_waitqueue_head(&idev->wait);
937 atomic_set(&idev->event, 0);
938
939 ret = uio_get_minor(idev);
940 if (ret)
Michal Simeke6789cd2013-09-12 07:39:59 +0200941 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100942
Hamish Martina93e7b32018-05-14 13:32:23 +1200943 idev->dev.devt = MKDEV(uio_major, idev->minor);
944 idev->dev.class = &uio_class;
945 idev->dev.parent = parent;
946 idev->dev.release = uio_device_release;
947 dev_set_drvdata(&idev->dev, idev);
948
949 ret = dev_set_name(&idev->dev, "uio%d", idev->minor);
950 if (ret)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100951 goto err_device_create;
Hamish Martina93e7b32018-05-14 13:32:23 +1200952
953 ret = device_register(&idev->dev);
954 if (ret)
955 goto err_device_create;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100956
957 ret = uio_dev_add_attributes(idev);
958 if (ret)
959 goto err_uio_dev_add_attributes;
960
961 info->uio_dev = idev;
962
Eric W. Biederman6427a762010-09-14 11:37:36 -0700963 if (info->irq && (info->irq != UIO_IRQ_CUSTOM)) {
Brian Russella0871462015-03-19 17:55:26 +0000964 /*
965 * Note that we deliberately don't use devm_request_irq
966 * here. The parent module can unregister the UIO device
967 * and call pci_disable_msi, which requires that this
968 * irq has been freed. However, the device may have open
969 * FDs at the time of unregister and therefore may not be
970 * freed until they are released.
971 */
Xiubo Li9421e452018-07-06 22:05:37 -0400972 ret = request_threaded_irq(info->irq, NULL, uio_interrupt,
973 info->irq_flags, info->name, idev);
974
Hans J. Kochbeafc542006-12-07 10:58:29 +0100975 if (ret)
976 goto err_request_irq;
977 }
978
979 return 0;
980
981err_request_irq:
982 uio_dev_del_attributes(idev);
983err_uio_dev_add_attributes:
Hamish Martina93e7b32018-05-14 13:32:23 +1200984 device_unregister(&idev->dev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100985err_device_create:
986 uio_free_minor(idev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100987 return ret;
988}
989EXPORT_SYMBOL_GPL(__uio_register_device);
990
991/**
992 * uio_unregister_device - unregister a industrial IO device
993 * @info: UIO device capabilities
994 *
995 */
996void uio_unregister_device(struct uio_info *info)
997{
998 struct uio_device *idev;
999
1000 if (!info || !info->uio_dev)
1001 return;
1002
1003 idev = info->uio_dev;
1004
1005 uio_free_minor(idev);
1006
Xiubo Li57c5f4d2018-07-06 22:05:39 -04001007 mutex_lock(&idev->info_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +01001008 uio_dev_del_attributes(idev);
1009
Stephen Hemminger9ff2c132015-05-14 09:19:13 -07001010 if (info->irq && info->irq != UIO_IRQ_CUSTOM)
1011 free_irq(info->irq, idev);
Brian Russella0871462015-03-19 17:55:26 +00001012
Hamish Martina93e7b32018-05-14 13:32:23 +12001013 idev->info = NULL;
Xiubo Li543af582018-07-06 22:05:38 -04001014 mutex_unlock(&idev->info_lock);
Hamish Martina93e7b32018-05-14 13:32:23 +12001015
1016 device_unregister(&idev->dev);
Hans J. Kochbeafc542006-12-07 10:58:29 +01001017
1018 return;
1019}
1020EXPORT_SYMBOL_GPL(uio_unregister_device);
1021
1022static int __init uio_init(void)
1023{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -07001024 return init_uio_class();
Hans J. Kochbeafc542006-12-07 10:58:29 +01001025}
1026
1027static void __exit uio_exit(void)
1028{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -07001029 release_uio_class();
Johannes Thumshirne2ef9392015-07-08 17:24:46 +02001030 idr_destroy(&uio_idr);
Hans J. Kochbeafc542006-12-07 10:58:29 +01001031}
1032
1033module_init(uio_init)
1034module_exit(uio_exit)
1035MODULE_LICENSE("GPL v2");