blob: e6b20716e8e0ed7cd1ccf4b5d287a3df8451dddf [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>
Alexey Dobriyand43c36d2009-10-07 17:09:06 +040023#include <linux/sched.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{
Kai Jiang27a90702011-10-17 20:50:20 +020069 return sprintf(buf, "0x%llx\n", (unsigned long long)mem->addr & ~PAGE_MASK);
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);
Eric W. Biederman70a91562010-09-14 11:36:54 -0700218 return sprintf(buf, "%s\n", idev->info->name);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100219}
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700220static DEVICE_ATTR_RO(name);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100221
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700222static ssize_t version_show(struct device *dev,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100223 struct device_attribute *attr, char *buf)
224{
225 struct uio_device *idev = dev_get_drvdata(dev);
Eric W. Biederman70a91562010-09-14 11:36:54 -0700226 return sprintf(buf, "%s\n", idev->info->version);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100227}
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700228static DEVICE_ATTR_RO(version);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100229
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700230static ssize_t event_show(struct device *dev,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100231 struct device_attribute *attr, char *buf)
232{
233 struct uio_device *idev = dev_get_drvdata(dev);
Eric W. Biederman70a91562010-09-14 11:36:54 -0700234 return sprintf(buf, "%u\n", (unsigned int)atomic_read(&idev->event));
Hans J. Kochbeafc542006-12-07 10:58:29 +0100235}
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700236static DEVICE_ATTR_RO(event);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100237
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700238static struct attribute *uio_attrs[] = {
239 &dev_attr_name.attr,
240 &dev_attr_version.attr,
241 &dev_attr_event.attr,
242 NULL,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100243};
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700244ATTRIBUTE_GROUPS(uio);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100245
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700246/* UIO class infrastructure */
247static struct class uio_class = {
248 .name = "uio",
Greg Kroah-Hartmanc9dce922013-07-24 15:05:23 -0700249 .dev_groups = uio_groups,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100250};
251
Alexandre Bellonie2274c762018-08-16 09:39:41 +0200252bool uio_class_registered;
253
Hans J. Kochbeafc542006-12-07 10:58:29 +0100254/*
255 * device functions
256 */
257static int uio_dev_add_attributes(struct uio_device *idev)
258{
259 int ret;
Hans J. Koche70c4122008-12-06 02:23:13 +0100260 int mi, pi;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100261 int map_found = 0;
Hans J. Koche70c4122008-12-06 02:23:13 +0100262 int portio_found = 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100263 struct uio_mem *mem;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000264 struct uio_map *map;
Hans J. Koche70c4122008-12-06 02:23:13 +0100265 struct uio_port *port;
266 struct uio_portio *portio;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100267
Hans J. Kochbeafc542006-12-07 10:58:29 +0100268 for (mi = 0; mi < MAX_UIO_MAPS; mi++) {
269 mem = &idev->info->mem[mi];
270 if (mem->size == 0)
271 break;
272 if (!map_found) {
273 map_found = 1;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000274 idev->map_dir = kobject_create_and_add("maps",
275 &idev->dev->kobj);
Dan Carpenter0320a272016-04-01 14:04:23 +0300276 if (!idev->map_dir) {
277 ret = -ENOMEM;
Hans J. Koche70c4122008-12-06 02:23:13 +0100278 goto err_map;
Dan Carpenter0320a272016-04-01 14:04:23 +0300279 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100280 }
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000281 map = kzalloc(sizeof(*map), GFP_KERNEL);
Dan Carpenter0320a272016-04-01 14:04:23 +0300282 if (!map) {
283 ret = -ENOMEM;
Suman Anna4cc339e2017-05-09 18:58:24 -0500284 goto err_map;
Dan Carpenter0320a272016-04-01 14:04:23 +0300285 }
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700286 kobject_init(&map->kobj, &map_attr_type);
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000287 map->mem = mem;
288 mem->map = map;
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700289 ret = kobject_add(&map->kobj, idev->map_dir, "map%d", mi);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100290 if (ret)
Cong Ding75f0aef2013-10-25 00:25:53 -0700291 goto err_map_kobj;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000292 ret = kobject_uevent(&map->kobj, KOBJ_ADD);
293 if (ret)
Suman Anna4cc339e2017-05-09 18:58:24 -0500294 goto err_map_kobj;
Hans J. Koche70c4122008-12-06 02:23:13 +0100295 }
296
297 for (pi = 0; pi < MAX_UIO_PORT_REGIONS; pi++) {
298 port = &idev->info->port[pi];
299 if (port->size == 0)
300 break;
301 if (!portio_found) {
302 portio_found = 1;
303 idev->portio_dir = kobject_create_and_add("portio",
304 &idev->dev->kobj);
Dan Carpenter0320a272016-04-01 14:04:23 +0300305 if (!idev->portio_dir) {
306 ret = -ENOMEM;
Hans J. Koche70c4122008-12-06 02:23:13 +0100307 goto err_portio;
Dan Carpenter0320a272016-04-01 14:04:23 +0300308 }
Hans J. Koche70c4122008-12-06 02:23:13 +0100309 }
310 portio = kzalloc(sizeof(*portio), GFP_KERNEL);
Dan Carpenter0320a272016-04-01 14:04:23 +0300311 if (!portio) {
312 ret = -ENOMEM;
Suman Anna4cc339e2017-05-09 18:58:24 -0500313 goto err_portio;
Dan Carpenter0320a272016-04-01 14:04:23 +0300314 }
Hans J. Koche70c4122008-12-06 02:23:13 +0100315 kobject_init(&portio->kobj, &portio_attr_type);
316 portio->port = port;
317 port->portio = portio;
318 ret = kobject_add(&portio->kobj, idev->portio_dir,
319 "port%d", pi);
320 if (ret)
Cong Ding75f0aef2013-10-25 00:25:53 -0700321 goto err_portio_kobj;
Hans J. Koche70c4122008-12-06 02:23:13 +0100322 ret = kobject_uevent(&portio->kobj, KOBJ_ADD);
323 if (ret)
Suman Anna4cc339e2017-05-09 18:58:24 -0500324 goto err_portio_kobj;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100325 }
326
327 return 0;
328
Hans J. Koche70c4122008-12-06 02:23:13 +0100329err_portio:
Cong Ding75f0aef2013-10-25 00:25:53 -0700330 pi--;
331err_portio_kobj:
332 for (; pi >= 0; pi--) {
Hans J. Koche70c4122008-12-06 02:23:13 +0100333 port = &idev->info->port[pi];
334 portio = port->portio;
335 kobject_put(&portio->kobj);
336 }
337 kobject_put(idev->portio_dir);
338err_map:
Cong Ding75f0aef2013-10-25 00:25:53 -0700339 mi--;
340err_map_kobj:
341 for (; mi >= 0; mi--) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100342 mem = &idev->info->mem[mi];
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000343 map = mem->map;
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800344 kobject_put(&map->kobj);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100345 }
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800346 kobject_put(idev->map_dir);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100347 dev_err(idev->dev, "error creating sysfs files (%d)\n", ret);
348 return ret;
349}
350
351static void uio_dev_del_attributes(struct uio_device *idev)
352{
Hans J. Koche70c4122008-12-06 02:23:13 +0100353 int i;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100354 struct uio_mem *mem;
Hans J. Koche70c4122008-12-06 02:23:13 +0100355 struct uio_port *port;
356
357 for (i = 0; i < MAX_UIO_MAPS; i++) {
358 mem = &idev->info->mem[i];
Hans J. Kochbeafc542006-12-07 10:58:29 +0100359 if (mem->size == 0)
360 break;
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800361 kobject_put(&mem->map->kobj);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100362 }
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800363 kobject_put(idev->map_dir);
Hans J. Koche70c4122008-12-06 02:23:13 +0100364
365 for (i = 0; i < MAX_UIO_PORT_REGIONS; i++) {
366 port = &idev->info->port[i];
367 if (port->size == 0)
368 break;
369 kobject_put(&port->portio->kobj);
370 }
371 kobject_put(idev->portio_dir);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100372}
373
374static int uio_get_minor(struct uio_device *idev)
375{
Hans J. Kochbeafc542006-12-07 10:58:29 +0100376 int retval = -ENOMEM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100377
378 mutex_lock(&minor_lock);
Tejun Heo6d770932013-02-27 17:04:47 -0800379 retval = idr_alloc(&uio_idr, idev, 0, UIO_MAX_DEVICES, GFP_KERNEL);
380 if (retval >= 0) {
381 idev->minor = retval;
Damian Hobson-Garcia5ed05052013-03-26 10:31:22 +0900382 retval = 0;
Tejun Heo6d770932013-02-27 17:04:47 -0800383 } else if (retval == -ENOSPC) {
Hillf Dantonc6edc422011-03-31 20:38:47 +0800384 dev_err(idev->dev, "too many uio devices\n");
385 retval = -EINVAL;
Hillf Dantonc6edc422011-03-31 20:38:47 +0800386 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100387 mutex_unlock(&minor_lock);
388 return retval;
389}
390
391static void uio_free_minor(struct uio_device *idev)
392{
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600393 mutex_lock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100394 idr_remove(&uio_idr, idev->minor);
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600395 mutex_unlock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100396}
397
398/**
399 * uio_event_notify - trigger an interrupt event
400 * @info: UIO device capabilities
401 */
402void uio_event_notify(struct uio_info *info)
403{
404 struct uio_device *idev = info->uio_dev;
405
406 atomic_inc(&idev->event);
407 wake_up_interruptible(&idev->wait);
408 kill_fasync(&idev->async_queue, SIGIO, POLL_IN);
409}
410EXPORT_SYMBOL_GPL(uio_event_notify);
411
412/**
413 * uio_interrupt - hardware interrupt handler
414 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
415 * @dev_id: Pointer to the devices uio_device structure
416 */
417static irqreturn_t uio_interrupt(int irq, void *dev_id)
418{
419 struct uio_device *idev = (struct uio_device *)dev_id;
420 irqreturn_t ret = idev->info->handler(irq, idev->info);
421
422 if (ret == IRQ_HANDLED)
423 uio_event_notify(idev->info);
424
425 return ret;
426}
427
428struct uio_listener {
429 struct uio_device *dev;
430 s32 event_count;
431};
432
433static int uio_open(struct inode *inode, struct file *filep)
434{
435 struct uio_device *idev;
436 struct uio_listener *listener;
437 int ret = 0;
438
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600439 mutex_lock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100440 idev = idr_find(&uio_idr, iminor(inode));
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600441 mutex_unlock(&minor_lock);
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600442 if (!idev) {
443 ret = -ENODEV;
444 goto out;
445 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100446
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600447 if (!try_module_get(idev->owner)) {
448 ret = -ENODEV;
449 goto out;
450 }
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200451
Hans J. Kochbeafc542006-12-07 10:58:29 +0100452 listener = kmalloc(sizeof(*listener), GFP_KERNEL);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200453 if (!listener) {
454 ret = -ENOMEM;
455 goto err_alloc_listener;
456 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100457
458 listener->dev = idev;
459 listener->event_count = atomic_read(&idev->event);
460 filep->private_data = listener;
461
462 if (idev->info->open) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100463 ret = idev->info->open(idev->info, inode);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200464 if (ret)
465 goto err_infoopen;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100466 }
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200467 return 0;
468
469err_infoopen:
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200470 kfree(listener);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200471
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600472err_alloc_listener:
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200473 module_put(idev->owner);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100474
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600475out:
Hans J. Kochbeafc542006-12-07 10:58:29 +0100476 return ret;
477}
478
479static int uio_fasync(int fd, struct file *filep, int on)
480{
481 struct uio_listener *listener = filep->private_data;
482 struct uio_device *idev = listener->dev;
483
484 return fasync_helper(fd, filep, on, &idev->async_queue);
485}
486
487static int uio_release(struct inode *inode, struct file *filep)
488{
489 int ret = 0;
490 struct uio_listener *listener = filep->private_data;
491 struct uio_device *idev = listener->dev;
492
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200493 if (idev->info->release)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100494 ret = idev->info->release(idev->info, inode);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200495
496 module_put(idev->owner);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100497 kfree(listener);
498 return ret;
499}
500
501static unsigned int uio_poll(struct file *filep, poll_table *wait)
502{
503 struct uio_listener *listener = filep->private_data;
504 struct uio_device *idev = listener->dev;
505
Eric W. Biederman6427a762010-09-14 11:37:36 -0700506 if (!idev->info->irq)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100507 return -EIO;
508
509 poll_wait(filep, &idev->wait, wait);
510 if (listener->event_count != atomic_read(&idev->event))
511 return POLLIN | POLLRDNORM;
512 return 0;
513}
514
515static ssize_t uio_read(struct file *filep, char __user *buf,
516 size_t count, loff_t *ppos)
517{
518 struct uio_listener *listener = filep->private_data;
519 struct uio_device *idev = listener->dev;
520 DECLARE_WAITQUEUE(wait, current);
521 ssize_t retval;
522 s32 event_count;
523
Eric W. Biederman6427a762010-09-14 11:37:36 -0700524 if (!idev->info->irq)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100525 return -EIO;
526
527 if (count != sizeof(s32))
528 return -EINVAL;
529
530 add_wait_queue(&idev->wait, &wait);
531
532 do {
533 set_current_state(TASK_INTERRUPTIBLE);
534
535 event_count = atomic_read(&idev->event);
536 if (event_count != listener->event_count) {
Michal Hockoedce5e62015-09-07 09:21:24 +0200537 __set_current_state(TASK_RUNNING);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100538 if (copy_to_user(buf, &event_count, count))
539 retval = -EFAULT;
540 else {
541 listener->event_count = event_count;
542 retval = count;
543 }
544 break;
545 }
546
547 if (filep->f_flags & O_NONBLOCK) {
548 retval = -EAGAIN;
549 break;
550 }
551
552 if (signal_pending(current)) {
553 retval = -ERESTARTSYS;
554 break;
555 }
556 schedule();
557 } while (1);
558
559 __set_current_state(TASK_RUNNING);
560 remove_wait_queue(&idev->wait, &wait);
561
562 return retval;
563}
564
Hans J. Koch328a14e2008-05-23 13:50:14 +0200565static ssize_t uio_write(struct file *filep, const 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 ssize_t retval;
571 s32 irq_on;
572
Eric W. Biederman6427a762010-09-14 11:37:36 -0700573 if (!idev->info->irq)
Hans J. Koch328a14e2008-05-23 13:50:14 +0200574 return -EIO;
575
576 if (count != sizeof(s32))
577 return -EINVAL;
578
579 if (!idev->info->irqcontrol)
580 return -ENOSYS;
581
582 if (copy_from_user(&irq_on, buf, count))
583 return -EFAULT;
584
585 retval = idev->info->irqcontrol(idev->info, irq_on);
586
587 return retval ? retval : sizeof(s32);
588}
589
Hans J. Kochbeafc542006-12-07 10:58:29 +0100590static int uio_find_mem_index(struct vm_area_struct *vma)
591{
Hans J. Kochbeafc542006-12-07 10:58:29 +0100592 struct uio_device *idev = vma->vm_private_data;
593
Hillf Dantonf0c554f2011-03-28 23:33:26 +0200594 if (vma->vm_pgoff < MAX_UIO_MAPS) {
595 if (idev->info->mem[vma->vm_pgoff].size == 0)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100596 return -1;
Hillf Dantonf0c554f2011-03-28 23:33:26 +0200597 return (int)vma->vm_pgoff;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100598 }
599 return -1;
600}
601
Nick Piggina18b6302008-02-06 01:37:35 -0800602static int uio_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100603{
604 struct uio_device *idev = vma->vm_private_data;
Nick Piggina18b6302008-02-06 01:37:35 -0800605 struct page *page;
Andrew G. Harvey02683ff2008-09-24 01:10:02 +0200606 unsigned long offset;
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000607 void *addr;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100608
609 int mi = uio_find_mem_index(vma);
610 if (mi < 0)
Nick Piggina18b6302008-02-06 01:37:35 -0800611 return VM_FAULT_SIGBUS;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100612
Andrew G. Harvey02683ff2008-09-24 01:10:02 +0200613 /*
614 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
615 * to use mem[N].
616 */
617 offset = (vmf->pgoff - mi) << PAGE_SHIFT;
618
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000619 addr = (void *)(unsigned long)idev->info->mem[mi].addr + offset;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100620 if (idev->info->mem[mi].memtype == UIO_MEM_LOGICAL)
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000621 page = virt_to_page(addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100622 else
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000623 page = vmalloc_to_page(addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100624 get_page(page);
Nick Piggina18b6302008-02-06 01:37:35 -0800625 vmf->page = page;
626 return 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100627}
628
Uwe Kleine-König72941512013-08-07 13:02:53 +0200629static const struct vm_operations_struct uio_logical_vm_ops = {
Nick Piggina18b6302008-02-06 01:37:35 -0800630 .fault = uio_vma_fault,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100631};
632
Uwe Kleine-König72941512013-08-07 13:02:53 +0200633static int uio_mmap_logical(struct vm_area_struct *vma)
634{
635 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
636 vma->vm_ops = &uio_logical_vm_ops;
Uwe Kleine-König72941512013-08-07 13:02:53 +0200637 return 0;
638}
639
640static const struct vm_operations_struct uio_physical_vm_ops = {
641#ifdef CONFIG_HAVE_IOREMAP_PROT
642 .access = generic_access_phys,
643#endif
644};
645
Hans J. Kochbeafc542006-12-07 10:58:29 +0100646static int uio_mmap_physical(struct vm_area_struct *vma)
647{
648 struct uio_device *idev = vma->vm_private_data;
649 int mi = uio_find_mem_index(vma);
Linus Torvalds7314e612013-10-29 10:21:34 -0700650 struct uio_mem *mem;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100651 if (mi < 0)
652 return -EINVAL;
Linus Torvalds7314e612013-10-29 10:21:34 -0700653 mem = idev->info->mem + mi;
654
Linus Torvaldsb6550282013-12-02 11:50:37 -0800655 if (mem->addr & ~PAGE_MASK)
656 return -ENODEV;
Greg Kroah-Hartmanb29f6802014-06-17 16:07:08 -0700657 if (vma->vm_end - vma->vm_start > mem->size)
Linus Torvalds7314e612013-10-29 10:21:34 -0700658 return -EINVAL;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100659
Uwe Kleine-König72941512013-08-07 13:02:53 +0200660 vma->vm_ops = &uio_physical_vm_ops;
Jean-Samuel Chenardc9698d6b2008-03-14 11:28:36 +0100661 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
662
Linus Torvalds7314e612013-10-29 10:21:34 -0700663 /*
664 * We cannot use the vm_iomap_memory() helper here,
665 * because vma->vm_pgoff is the map index we looked
666 * up above in uio_find_mem_index(), rather than an
667 * actual page offset into the mmap.
668 *
669 * So we just do the physical mmap without a page
670 * offset.
671 */
Hans J. Kochbeafc542006-12-07 10:58:29 +0100672 return remap_pfn_range(vma,
673 vma->vm_start,
Linus Torvalds7314e612013-10-29 10:21:34 -0700674 mem->addr >> PAGE_SHIFT,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100675 vma->vm_end - vma->vm_start,
676 vma->vm_page_prot);
677}
678
Hans J. Kochbeafc542006-12-07 10:58:29 +0100679static int uio_mmap(struct file *filep, struct vm_area_struct *vma)
680{
681 struct uio_listener *listener = filep->private_data;
682 struct uio_device *idev = listener->dev;
683 int mi;
684 unsigned long requested_pages, actual_pages;
685 int ret = 0;
686
687 if (vma->vm_end < vma->vm_start)
688 return -EINVAL;
689
690 vma->vm_private_data = idev;
691
692 mi = uio_find_mem_index(vma);
693 if (mi < 0)
694 return -EINVAL;
695
Libin52c2dad2013-07-03 15:01:27 -0700696 requested_pages = vma_pages(vma);
Ian Abbott6da2d372009-02-24 17:22:59 +0000697 actual_pages = ((idev->info->mem[mi].addr & ~PAGE_MASK)
698 + idev->info->mem[mi].size + PAGE_SIZE -1) >> PAGE_SHIFT;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100699 if (requested_pages > actual_pages)
700 return -EINVAL;
701
702 if (idev->info->mmap) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100703 ret = idev->info->mmap(idev->info, vma);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100704 return ret;
705 }
706
707 switch (idev->info->mem[mi].memtype) {
708 case UIO_MEM_PHYS:
709 return uio_mmap_physical(vma);
710 case UIO_MEM_LOGICAL:
711 case UIO_MEM_VIRTUAL:
712 return uio_mmap_logical(vma);
713 default:
714 return -EINVAL;
715 }
716}
717
Jan Engelhardt4f014692008-01-22 20:50:54 +0100718static const struct file_operations uio_fops = {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100719 .owner = THIS_MODULE,
720 .open = uio_open,
721 .release = uio_release,
722 .read = uio_read,
Hans J. Koch328a14e2008-05-23 13:50:14 +0200723 .write = uio_write,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100724 .mmap = uio_mmap,
725 .poll = uio_poll,
726 .fasync = uio_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200727 .llseek = noop_llseek,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100728};
729
730static int uio_major_init(void)
731{
Eric W. Biederman91960a42010-09-14 11:38:06 -0700732 static const char name[] = "uio";
733 struct cdev *cdev = NULL;
734 dev_t uio_dev = 0;
735 int result;
736
737 result = alloc_chrdev_region(&uio_dev, 0, UIO_MAX_DEVICES, name);
738 if (result)
739 goto out;
740
741 result = -ENOMEM;
742 cdev = cdev_alloc();
743 if (!cdev)
744 goto out_unregister;
745
746 cdev->owner = THIS_MODULE;
747 cdev->ops = &uio_fops;
748 kobject_set_name(&cdev->kobj, "%s", name);
749
750 result = cdev_add(cdev, uio_dev, UIO_MAX_DEVICES);
751 if (result)
752 goto out_put;
753
754 uio_major = MAJOR(uio_dev);
755 uio_cdev = cdev;
Wanlong Gaod80df1c2011-08-20 12:12:08 +0800756 return 0;
Eric W. Biederman91960a42010-09-14 11:38:06 -0700757out_put:
758 kobject_put(&cdev->kobj);
759out_unregister:
760 unregister_chrdev_region(uio_dev, UIO_MAX_DEVICES);
Wanlong Gaod80df1c2011-08-20 12:12:08 +0800761out:
762 return result;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100763}
764
765static void uio_major_cleanup(void)
766{
Eric W. Biederman91960a42010-09-14 11:38:06 -0700767 unregister_chrdev_region(MKDEV(uio_major, 0), UIO_MAX_DEVICES);
768 cdev_del(uio_cdev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100769}
770
771static int init_uio_class(void)
772{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700773 int ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100774
775 /* This is the first time in here, set everything up properly */
776 ret = uio_major_init();
777 if (ret)
778 goto exit;
779
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700780 ret = class_register(&uio_class);
781 if (ret) {
782 printk(KERN_ERR "class_register failed for uio\n");
783 goto err_class_register;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100784 }
Alexandre Bellonie2274c762018-08-16 09:39:41 +0200785
786 uio_class_registered = true;
787
Hans J. Kochbeafc542006-12-07 10:58:29 +0100788 return 0;
789
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700790err_class_register:
Hans J. Kochbeafc542006-12-07 10:58:29 +0100791 uio_major_cleanup();
792exit:
793 return ret;
794}
795
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700796static void release_uio_class(void)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100797{
Alexandre Bellonie2274c762018-08-16 09:39:41 +0200798 uio_class_registered = false;
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700799 class_unregister(&uio_class);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100800 uio_major_cleanup();
Hans J. Kochbeafc542006-12-07 10:58:29 +0100801}
802
803/**
804 * uio_register_device - register a new userspace IO device
805 * @owner: module that creates the new device
806 * @parent: parent device
807 * @info: UIO device capabilities
808 *
809 * returns zero on success or a negative error code.
810 */
811int __uio_register_device(struct module *owner,
812 struct device *parent,
813 struct uio_info *info)
814{
815 struct uio_device *idev;
816 int ret = 0;
817
Alexandre Bellonie2274c762018-08-16 09:39:41 +0200818 if (!uio_class_registered)
819 return -EPROBE_DEFER;
820
Hans J. Kochbeafc542006-12-07 10:58:29 +0100821 if (!parent || !info || !info->name || !info->version)
822 return -EINVAL;
823
824 info->uio_dev = NULL;
825
Michal Simeke6789cd2013-09-12 07:39:59 +0200826 idev = devm_kzalloc(parent, sizeof(*idev), GFP_KERNEL);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100827 if (!idev) {
Michal Simeke6789cd2013-09-12 07:39:59 +0200828 return -ENOMEM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100829 }
830
831 idev->owner = owner;
832 idev->info = info;
833 init_waitqueue_head(&idev->wait);
834 atomic_set(&idev->event, 0);
835
836 ret = uio_get_minor(idev);
837 if (ret)
Michal Simeke6789cd2013-09-12 07:39:59 +0200838 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100839
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700840 idev->dev = device_create(&uio_class, parent,
Greg Kroah-Hartmana9b12612008-07-21 20:03:34 -0700841 MKDEV(uio_major, idev->minor), idev,
842 "uio%d", idev->minor);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100843 if (IS_ERR(idev->dev)) {
844 printk(KERN_ERR "UIO: device register failed\n");
845 ret = PTR_ERR(idev->dev);
846 goto err_device_create;
847 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100848
849 ret = uio_dev_add_attributes(idev);
850 if (ret)
851 goto err_uio_dev_add_attributes;
852
Dan Carpenterbb5f5312018-10-26 10:19:51 +0300853 info->uio_dev = idev;
854
Eric W. Biederman6427a762010-09-14 11:37:36 -0700855 if (info->irq && (info->irq != UIO_IRQ_CUSTOM)) {
Brian Russella0871462015-03-19 17:55:26 +0000856 /*
857 * Note that we deliberately don't use devm_request_irq
858 * here. The parent module can unregister the UIO device
859 * and call pci_disable_msi, which requires that this
860 * irq has been freed. However, the device may have open
861 * FDs at the time of unregister and therefore may not be
862 * freed until they are released.
863 */
864 ret = request_irq(info->irq, uio_interrupt,
Eric W. Biederman6427a762010-09-14 11:37:36 -0700865 info->irq_flags, info->name, idev);
Dan Carpenterbb5f5312018-10-26 10:19:51 +0300866 if (ret) {
867 info->uio_dev = NULL;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100868 goto err_request_irq;
Dan Carpenterbb5f5312018-10-26 10:19:51 +0300869 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100870 }
871
872 return 0;
873
874err_request_irq:
875 uio_dev_del_attributes(idev);
876err_uio_dev_add_attributes:
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700877 device_destroy(&uio_class, MKDEV(uio_major, idev->minor));
Hans J. Kochbeafc542006-12-07 10:58:29 +0100878err_device_create:
879 uio_free_minor(idev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100880 return ret;
881}
882EXPORT_SYMBOL_GPL(__uio_register_device);
883
884/**
885 * uio_unregister_device - unregister a industrial IO device
886 * @info: UIO device capabilities
887 *
888 */
889void uio_unregister_device(struct uio_info *info)
890{
891 struct uio_device *idev;
892
893 if (!info || !info->uio_dev)
894 return;
895
896 idev = info->uio_dev;
897
898 uio_free_minor(idev);
899
Hans J. Kochbeafc542006-12-07 10:58:29 +0100900 uio_dev_del_attributes(idev);
901
Stephen Hemminger9ff2c132015-05-14 09:19:13 -0700902 if (info->irq && info->irq != UIO_IRQ_CUSTOM)
903 free_irq(info->irq, idev);
Brian Russella0871462015-03-19 17:55:26 +0000904
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700905 device_destroy(&uio_class, MKDEV(uio_major, idev->minor));
Hans J. Kochbeafc542006-12-07 10:58:29 +0100906
907 return;
908}
909EXPORT_SYMBOL_GPL(uio_unregister_device);
910
911static int __init uio_init(void)
912{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700913 return init_uio_class();
Hans J. Kochbeafc542006-12-07 10:58:29 +0100914}
915
916static void __exit uio_exit(void)
917{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700918 release_uio_class();
Johannes Thumshirne2ef9392015-07-08 17:24:46 +0200919 idr_destroy(&uio_idr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100920}
921
922module_init(uio_init)
923module_exit(uio_exit)
924MODULE_LICENSE("GPL v2");