blob: 31d95dc9c202daab21e996015ee7d4b8e466ea32 [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
252/*
253 * device functions
254 */
255static int uio_dev_add_attributes(struct uio_device *idev)
256{
257 int ret;
Hans J. Koche70c4122008-12-06 02:23:13 +0100258 int mi, pi;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100259 int map_found = 0;
Hans J. Koche70c4122008-12-06 02:23:13 +0100260 int portio_found = 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100261 struct uio_mem *mem;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000262 struct uio_map *map;
Hans J. Koche70c4122008-12-06 02:23:13 +0100263 struct uio_port *port;
264 struct uio_portio *portio;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100265
Hans J. Kochbeafc542006-12-07 10:58:29 +0100266 for (mi = 0; mi < MAX_UIO_MAPS; mi++) {
267 mem = &idev->info->mem[mi];
268 if (mem->size == 0)
269 break;
270 if (!map_found) {
271 map_found = 1;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000272 idev->map_dir = kobject_create_and_add("maps",
273 &idev->dev->kobj);
Dan Carpenter0320a272016-04-01 14:04:23 +0300274 if (!idev->map_dir) {
275 ret = -ENOMEM;
Hans J. Koche70c4122008-12-06 02:23:13 +0100276 goto err_map;
Dan Carpenter0320a272016-04-01 14:04:23 +0300277 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100278 }
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000279 map = kzalloc(sizeof(*map), GFP_KERNEL);
Dan Carpenter0320a272016-04-01 14:04:23 +0300280 if (!map) {
281 ret = -ENOMEM;
Cong Ding75f0aef2013-10-25 00:25:53 -0700282 goto err_map_kobj;
Dan Carpenter0320a272016-04-01 14:04:23 +0300283 }
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700284 kobject_init(&map->kobj, &map_attr_type);
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000285 map->mem = mem;
286 mem->map = map;
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700287 ret = kobject_add(&map->kobj, idev->map_dir, "map%d", mi);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100288 if (ret)
Cong Ding75f0aef2013-10-25 00:25:53 -0700289 goto err_map_kobj;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000290 ret = kobject_uevent(&map->kobj, KOBJ_ADD);
291 if (ret)
Hans J. Koche70c4122008-12-06 02:23:13 +0100292 goto err_map;
293 }
294
295 for (pi = 0; pi < MAX_UIO_PORT_REGIONS; pi++) {
296 port = &idev->info->port[pi];
297 if (port->size == 0)
298 break;
299 if (!portio_found) {
300 portio_found = 1;
301 idev->portio_dir = kobject_create_and_add("portio",
302 &idev->dev->kobj);
Dan Carpenter0320a272016-04-01 14:04:23 +0300303 if (!idev->portio_dir) {
304 ret = -ENOMEM;
Hans J. Koche70c4122008-12-06 02:23:13 +0100305 goto err_portio;
Dan Carpenter0320a272016-04-01 14:04:23 +0300306 }
Hans J. Koche70c4122008-12-06 02:23:13 +0100307 }
308 portio = kzalloc(sizeof(*portio), GFP_KERNEL);
Dan Carpenter0320a272016-04-01 14:04:23 +0300309 if (!portio) {
310 ret = -ENOMEM;
Cong Ding75f0aef2013-10-25 00:25:53 -0700311 goto err_portio_kobj;
Dan Carpenter0320a272016-04-01 14:04:23 +0300312 }
Hans J. Koche70c4122008-12-06 02:23:13 +0100313 kobject_init(&portio->kobj, &portio_attr_type);
314 portio->port = port;
315 port->portio = portio;
316 ret = kobject_add(&portio->kobj, idev->portio_dir,
317 "port%d", pi);
318 if (ret)
Cong Ding75f0aef2013-10-25 00:25:53 -0700319 goto err_portio_kobj;
Hans J. Koche70c4122008-12-06 02:23:13 +0100320 ret = kobject_uevent(&portio->kobj, KOBJ_ADD);
321 if (ret)
322 goto err_portio;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100323 }
324
325 return 0;
326
Hans J. Koche70c4122008-12-06 02:23:13 +0100327err_portio:
Cong Ding75f0aef2013-10-25 00:25:53 -0700328 pi--;
329err_portio_kobj:
330 for (; pi >= 0; pi--) {
Hans J. Koche70c4122008-12-06 02:23:13 +0100331 port = &idev->info->port[pi];
332 portio = port->portio;
333 kobject_put(&portio->kobj);
334 }
335 kobject_put(idev->portio_dir);
336err_map:
Cong Ding75f0aef2013-10-25 00:25:53 -0700337 mi--;
338err_map_kobj:
339 for (; mi >= 0; mi--) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100340 mem = &idev->info->mem[mi];
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +0000341 map = mem->map;
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800342 kobject_put(&map->kobj);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100343 }
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800344 kobject_put(idev->map_dir);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100345 dev_err(idev->dev, "error creating sysfs files (%d)\n", ret);
346 return ret;
347}
348
349static void uio_dev_del_attributes(struct uio_device *idev)
350{
Hans J. Koche70c4122008-12-06 02:23:13 +0100351 int i;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100352 struct uio_mem *mem;
Hans J. Koche70c4122008-12-06 02:23:13 +0100353 struct uio_port *port;
354
355 for (i = 0; i < MAX_UIO_MAPS; i++) {
356 mem = &idev->info->mem[i];
Hans J. Kochbeafc542006-12-07 10:58:29 +0100357 if (mem->size == 0)
358 break;
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800359 kobject_put(&mem->map->kobj);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100360 }
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800361 kobject_put(idev->map_dir);
Hans J. Koche70c4122008-12-06 02:23:13 +0100362
363 for (i = 0; i < MAX_UIO_PORT_REGIONS; i++) {
364 port = &idev->info->port[i];
365 if (port->size == 0)
366 break;
367 kobject_put(&port->portio->kobj);
368 }
369 kobject_put(idev->portio_dir);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100370}
371
372static int uio_get_minor(struct uio_device *idev)
373{
Hans J. Kochbeafc542006-12-07 10:58:29 +0100374 int retval = -ENOMEM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100375
376 mutex_lock(&minor_lock);
Tejun Heo6d770932013-02-27 17:04:47 -0800377 retval = idr_alloc(&uio_idr, idev, 0, UIO_MAX_DEVICES, GFP_KERNEL);
378 if (retval >= 0) {
379 idev->minor = retval;
Damian Hobson-Garcia5ed05052013-03-26 10:31:22 +0900380 retval = 0;
Tejun Heo6d770932013-02-27 17:04:47 -0800381 } else if (retval == -ENOSPC) {
Hillf Dantonc6edc422011-03-31 20:38:47 +0800382 dev_err(idev->dev, "too many uio devices\n");
383 retval = -EINVAL;
Hillf Dantonc6edc422011-03-31 20:38:47 +0800384 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100385 mutex_unlock(&minor_lock);
386 return retval;
387}
388
389static void uio_free_minor(struct uio_device *idev)
390{
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600391 mutex_lock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100392 idr_remove(&uio_idr, idev->minor);
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600393 mutex_unlock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100394}
395
396/**
397 * uio_event_notify - trigger an interrupt event
398 * @info: UIO device capabilities
399 */
400void uio_event_notify(struct uio_info *info)
401{
402 struct uio_device *idev = info->uio_dev;
403
404 atomic_inc(&idev->event);
405 wake_up_interruptible(&idev->wait);
406 kill_fasync(&idev->async_queue, SIGIO, POLL_IN);
407}
408EXPORT_SYMBOL_GPL(uio_event_notify);
409
410/**
411 * uio_interrupt - hardware interrupt handler
412 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
413 * @dev_id: Pointer to the devices uio_device structure
414 */
415static irqreturn_t uio_interrupt(int irq, void *dev_id)
416{
417 struct uio_device *idev = (struct uio_device *)dev_id;
418 irqreturn_t ret = idev->info->handler(irq, idev->info);
419
420 if (ret == IRQ_HANDLED)
421 uio_event_notify(idev->info);
422
423 return ret;
424}
425
426struct uio_listener {
427 struct uio_device *dev;
428 s32 event_count;
429};
430
431static int uio_open(struct inode *inode, struct file *filep)
432{
433 struct uio_device *idev;
434 struct uio_listener *listener;
435 int ret = 0;
436
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600437 mutex_lock(&minor_lock);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100438 idev = idr_find(&uio_idr, iminor(inode));
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600439 mutex_unlock(&minor_lock);
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600440 if (!idev) {
441 ret = -ENODEV;
442 goto out;
443 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100444
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600445 if (!try_module_get(idev->owner)) {
446 ret = -ENODEV;
447 goto out;
448 }
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200449
Hans J. Kochbeafc542006-12-07 10:58:29 +0100450 listener = kmalloc(sizeof(*listener), GFP_KERNEL);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200451 if (!listener) {
452 ret = -ENOMEM;
453 goto err_alloc_listener;
454 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100455
456 listener->dev = idev;
457 listener->event_count = atomic_read(&idev->event);
458 filep->private_data = listener;
459
460 if (idev->info->open) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100461 ret = idev->info->open(idev->info, inode);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200462 if (ret)
463 goto err_infoopen;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100464 }
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200465 return 0;
466
467err_infoopen:
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200468 kfree(listener);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200469
Jonathan Corbet0d4a7bc2008-08-26 17:15:45 -0600470err_alloc_listener:
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200471 module_put(idev->owner);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100472
Jonathan Corbetfbc8a812008-05-15 10:39:37 -0600473out:
Hans J. Kochbeafc542006-12-07 10:58:29 +0100474 return ret;
475}
476
477static int uio_fasync(int fd, struct file *filep, int on)
478{
479 struct uio_listener *listener = filep->private_data;
480 struct uio_device *idev = listener->dev;
481
482 return fasync_helper(fd, filep, on, &idev->async_queue);
483}
484
485static int uio_release(struct inode *inode, struct file *filep)
486{
487 int ret = 0;
488 struct uio_listener *listener = filep->private_data;
489 struct uio_device *idev = listener->dev;
490
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200491 if (idev->info->release)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100492 ret = idev->info->release(idev->info, inode);
Uwe Kleine-König610ad502008-04-11 11:07:39 +0200493
494 module_put(idev->owner);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100495 kfree(listener);
496 return ret;
497}
498
499static unsigned int uio_poll(struct file *filep, poll_table *wait)
500{
501 struct uio_listener *listener = filep->private_data;
502 struct uio_device *idev = listener->dev;
503
Eric W. Biederman6427a762010-09-14 11:37:36 -0700504 if (!idev->info->irq)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100505 return -EIO;
506
507 poll_wait(filep, &idev->wait, wait);
508 if (listener->event_count != atomic_read(&idev->event))
509 return POLLIN | POLLRDNORM;
510 return 0;
511}
512
513static ssize_t uio_read(struct file *filep, char __user *buf,
514 size_t count, loff_t *ppos)
515{
516 struct uio_listener *listener = filep->private_data;
517 struct uio_device *idev = listener->dev;
518 DECLARE_WAITQUEUE(wait, current);
519 ssize_t retval;
520 s32 event_count;
521
Eric W. Biederman6427a762010-09-14 11:37:36 -0700522 if (!idev->info->irq)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100523 return -EIO;
524
525 if (count != sizeof(s32))
526 return -EINVAL;
527
528 add_wait_queue(&idev->wait, &wait);
529
530 do {
531 set_current_state(TASK_INTERRUPTIBLE);
532
533 event_count = atomic_read(&idev->event);
534 if (event_count != listener->event_count) {
Michal Hockoedce5e62015-09-07 09:21:24 +0200535 __set_current_state(TASK_RUNNING);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100536 if (copy_to_user(buf, &event_count, count))
537 retval = -EFAULT;
538 else {
539 listener->event_count = event_count;
540 retval = count;
541 }
542 break;
543 }
544
545 if (filep->f_flags & O_NONBLOCK) {
546 retval = -EAGAIN;
547 break;
548 }
549
550 if (signal_pending(current)) {
551 retval = -ERESTARTSYS;
552 break;
553 }
554 schedule();
555 } while (1);
556
557 __set_current_state(TASK_RUNNING);
558 remove_wait_queue(&idev->wait, &wait);
559
560 return retval;
561}
562
Hans J. Koch328a14e2008-05-23 13:50:14 +0200563static ssize_t uio_write(struct file *filep, const 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 ssize_t retval;
569 s32 irq_on;
570
Eric W. Biederman6427a762010-09-14 11:37:36 -0700571 if (!idev->info->irq)
Hans J. Koch328a14e2008-05-23 13:50:14 +0200572 return -EIO;
573
574 if (count != sizeof(s32))
575 return -EINVAL;
576
577 if (!idev->info->irqcontrol)
578 return -ENOSYS;
579
580 if (copy_from_user(&irq_on, buf, count))
581 return -EFAULT;
582
583 retval = idev->info->irqcontrol(idev->info, irq_on);
584
585 return retval ? retval : sizeof(s32);
586}
587
Hans J. Kochbeafc542006-12-07 10:58:29 +0100588static int uio_find_mem_index(struct vm_area_struct *vma)
589{
Hans J. Kochbeafc542006-12-07 10:58:29 +0100590 struct uio_device *idev = vma->vm_private_data;
591
Hillf Dantonf0c554f2011-03-28 23:33:26 +0200592 if (vma->vm_pgoff < MAX_UIO_MAPS) {
593 if (idev->info->mem[vma->vm_pgoff].size == 0)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100594 return -1;
Hillf Dantonf0c554f2011-03-28 23:33:26 +0200595 return (int)vma->vm_pgoff;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100596 }
597 return -1;
598}
599
Dave Jiang11bac802017-02-24 14:56:41 -0800600static int uio_vma_fault(struct vm_fault *vmf)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100601{
Dave Jiang11bac802017-02-24 14:56:41 -0800602 struct uio_device *idev = vmf->vma->vm_private_data;
Nick Piggina18b6302008-02-06 01:37:35 -0800603 struct page *page;
Andrew G. Harvey02683ff2008-09-24 01:10:02 +0200604 unsigned long offset;
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000605 void *addr;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100606
Dave Jiang11bac802017-02-24 14:56:41 -0800607 int mi = uio_find_mem_index(vmf->vma);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100608 if (mi < 0)
Nick Piggina18b6302008-02-06 01:37:35 -0800609 return VM_FAULT_SIGBUS;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100610
Andrew G. Harvey02683ff2008-09-24 01:10:02 +0200611 /*
612 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
613 * to use mem[N].
614 */
615 offset = (vmf->pgoff - mi) << PAGE_SHIFT;
616
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000617 addr = (void *)(unsigned long)idev->info->mem[mi].addr + offset;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100618 if (idev->info->mem[mi].memtype == UIO_MEM_LOGICAL)
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000619 page = virt_to_page(addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100620 else
Ben Hutchingse6418fc2013-10-27 21:53:40 +0000621 page = vmalloc_to_page(addr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100622 get_page(page);
Nick Piggina18b6302008-02-06 01:37:35 -0800623 vmf->page = page;
624 return 0;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100625}
626
Uwe Kleine-König72941512013-08-07 13:02:53 +0200627static const struct vm_operations_struct uio_logical_vm_ops = {
Nick Piggina18b6302008-02-06 01:37:35 -0800628 .fault = uio_vma_fault,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100629};
630
Uwe Kleine-König72941512013-08-07 13:02:53 +0200631static int uio_mmap_logical(struct vm_area_struct *vma)
632{
633 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
634 vma->vm_ops = &uio_logical_vm_ops;
Uwe Kleine-König72941512013-08-07 13:02:53 +0200635 return 0;
636}
637
638static const struct vm_operations_struct uio_physical_vm_ops = {
639#ifdef CONFIG_HAVE_IOREMAP_PROT
640 .access = generic_access_phys,
641#endif
642};
643
Hans J. Kochbeafc542006-12-07 10:58:29 +0100644static int uio_mmap_physical(struct vm_area_struct *vma)
645{
646 struct uio_device *idev = vma->vm_private_data;
647 int mi = uio_find_mem_index(vma);
Linus Torvalds7314e612013-10-29 10:21:34 -0700648 struct uio_mem *mem;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100649 if (mi < 0)
650 return -EINVAL;
Linus Torvalds7314e612013-10-29 10:21:34 -0700651 mem = idev->info->mem + mi;
652
Linus Torvaldsb6550282013-12-02 11:50:37 -0800653 if (mem->addr & ~PAGE_MASK)
654 return -ENODEV;
Greg Kroah-Hartmanb29f6802014-06-17 16:07:08 -0700655 if (vma->vm_end - vma->vm_start > mem->size)
Linus Torvalds7314e612013-10-29 10:21:34 -0700656 return -EINVAL;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100657
Uwe Kleine-König72941512013-08-07 13:02:53 +0200658 vma->vm_ops = &uio_physical_vm_ops;
Jean-Samuel Chenardc9698d6b2008-03-14 11:28:36 +0100659 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
660
Linus Torvalds7314e612013-10-29 10:21:34 -0700661 /*
662 * We cannot use the vm_iomap_memory() helper here,
663 * because vma->vm_pgoff is the map index we looked
664 * up above in uio_find_mem_index(), rather than an
665 * actual page offset into the mmap.
666 *
667 * So we just do the physical mmap without a page
668 * offset.
669 */
Hans J. Kochbeafc542006-12-07 10:58:29 +0100670 return remap_pfn_range(vma,
671 vma->vm_start,
Linus Torvalds7314e612013-10-29 10:21:34 -0700672 mem->addr >> PAGE_SHIFT,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100673 vma->vm_end - vma->vm_start,
674 vma->vm_page_prot);
675}
676
Hans J. Kochbeafc542006-12-07 10:58:29 +0100677static int uio_mmap(struct file *filep, struct vm_area_struct *vma)
678{
679 struct uio_listener *listener = filep->private_data;
680 struct uio_device *idev = listener->dev;
681 int mi;
682 unsigned long requested_pages, actual_pages;
683 int ret = 0;
684
685 if (vma->vm_end < vma->vm_start)
686 return -EINVAL;
687
688 vma->vm_private_data = idev;
689
690 mi = uio_find_mem_index(vma);
691 if (mi < 0)
692 return -EINVAL;
693
Libin52c2dad2013-07-03 15:01:27 -0700694 requested_pages = vma_pages(vma);
Ian Abbott6da2d372009-02-24 17:22:59 +0000695 actual_pages = ((idev->info->mem[mi].addr & ~PAGE_MASK)
696 + idev->info->mem[mi].size + PAGE_SIZE -1) >> PAGE_SHIFT;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100697 if (requested_pages > actual_pages)
698 return -EINVAL;
699
700 if (idev->info->mmap) {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100701 ret = idev->info->mmap(idev->info, vma);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100702 return ret;
703 }
704
705 switch (idev->info->mem[mi].memtype) {
706 case UIO_MEM_PHYS:
707 return uio_mmap_physical(vma);
708 case UIO_MEM_LOGICAL:
709 case UIO_MEM_VIRTUAL:
710 return uio_mmap_logical(vma);
711 default:
712 return -EINVAL;
713 }
714}
715
Jan Engelhardt4f014692008-01-22 20:50:54 +0100716static const struct file_operations uio_fops = {
Hans J. Kochbeafc542006-12-07 10:58:29 +0100717 .owner = THIS_MODULE,
718 .open = uio_open,
719 .release = uio_release,
720 .read = uio_read,
Hans J. Koch328a14e2008-05-23 13:50:14 +0200721 .write = uio_write,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100722 .mmap = uio_mmap,
723 .poll = uio_poll,
724 .fasync = uio_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200725 .llseek = noop_llseek,
Hans J. Kochbeafc542006-12-07 10:58:29 +0100726};
727
728static int uio_major_init(void)
729{
Eric W. Biederman91960a42010-09-14 11:38:06 -0700730 static const char name[] = "uio";
731 struct cdev *cdev = NULL;
732 dev_t uio_dev = 0;
733 int result;
734
735 result = alloc_chrdev_region(&uio_dev, 0, UIO_MAX_DEVICES, name);
736 if (result)
737 goto out;
738
739 result = -ENOMEM;
740 cdev = cdev_alloc();
741 if (!cdev)
742 goto out_unregister;
743
744 cdev->owner = THIS_MODULE;
745 cdev->ops = &uio_fops;
746 kobject_set_name(&cdev->kobj, "%s", name);
747
748 result = cdev_add(cdev, uio_dev, UIO_MAX_DEVICES);
749 if (result)
750 goto out_put;
751
752 uio_major = MAJOR(uio_dev);
753 uio_cdev = cdev;
Wanlong Gaod80df1c2011-08-20 12:12:08 +0800754 return 0;
Eric W. Biederman91960a42010-09-14 11:38:06 -0700755out_put:
756 kobject_put(&cdev->kobj);
757out_unregister:
758 unregister_chrdev_region(uio_dev, UIO_MAX_DEVICES);
Wanlong Gaod80df1c2011-08-20 12:12:08 +0800759out:
760 return result;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100761}
762
763static void uio_major_cleanup(void)
764{
Eric W. Biederman91960a42010-09-14 11:38:06 -0700765 unregister_chrdev_region(MKDEV(uio_major, 0), UIO_MAX_DEVICES);
766 cdev_del(uio_cdev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100767}
768
769static int init_uio_class(void)
770{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700771 int ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100772
773 /* This is the first time in here, set everything up properly */
774 ret = uio_major_init();
775 if (ret)
776 goto exit;
777
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700778 ret = class_register(&uio_class);
779 if (ret) {
780 printk(KERN_ERR "class_register failed for uio\n");
781 goto err_class_register;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100782 }
783 return 0;
784
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700785err_class_register:
Hans J. Kochbeafc542006-12-07 10:58:29 +0100786 uio_major_cleanup();
787exit:
788 return ret;
789}
790
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700791static void release_uio_class(void)
Hans J. Kochbeafc542006-12-07 10:58:29 +0100792{
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700793 class_unregister(&uio_class);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100794 uio_major_cleanup();
Hans J. Kochbeafc542006-12-07 10:58:29 +0100795}
796
797/**
798 * uio_register_device - register a new userspace IO device
799 * @owner: module that creates the new device
800 * @parent: parent device
801 * @info: UIO device capabilities
802 *
803 * returns zero on success or a negative error code.
804 */
805int __uio_register_device(struct module *owner,
806 struct device *parent,
807 struct uio_info *info)
808{
809 struct uio_device *idev;
810 int ret = 0;
811
812 if (!parent || !info || !info->name || !info->version)
813 return -EINVAL;
814
815 info->uio_dev = NULL;
816
Michal Simeke6789cd2013-09-12 07:39:59 +0200817 idev = devm_kzalloc(parent, sizeof(*idev), GFP_KERNEL);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100818 if (!idev) {
Michal Simeke6789cd2013-09-12 07:39:59 +0200819 return -ENOMEM;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100820 }
821
822 idev->owner = owner;
823 idev->info = info;
824 init_waitqueue_head(&idev->wait);
825 atomic_set(&idev->event, 0);
826
827 ret = uio_get_minor(idev);
828 if (ret)
Michal Simeke6789cd2013-09-12 07:39:59 +0200829 return ret;
Hans J. Kochbeafc542006-12-07 10:58:29 +0100830
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700831 idev->dev = device_create(&uio_class, parent,
Greg Kroah-Hartmana9b12612008-07-21 20:03:34 -0700832 MKDEV(uio_major, idev->minor), idev,
833 "uio%d", idev->minor);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100834 if (IS_ERR(idev->dev)) {
835 printk(KERN_ERR "UIO: device register failed\n");
836 ret = PTR_ERR(idev->dev);
837 goto err_device_create;
838 }
Hans J. Kochbeafc542006-12-07 10:58:29 +0100839
840 ret = uio_dev_add_attributes(idev);
841 if (ret)
842 goto err_uio_dev_add_attributes;
843
844 info->uio_dev = idev;
845
Eric W. Biederman6427a762010-09-14 11:37:36 -0700846 if (info->irq && (info->irq != UIO_IRQ_CUSTOM)) {
Brian Russella0871462015-03-19 17:55:26 +0000847 /*
848 * Note that we deliberately don't use devm_request_irq
849 * here. The parent module can unregister the UIO device
850 * and call pci_disable_msi, which requires that this
851 * irq has been freed. However, the device may have open
852 * FDs at the time of unregister and therefore may not be
853 * freed until they are released.
854 */
855 ret = request_irq(info->irq, uio_interrupt,
Eric W. Biederman6427a762010-09-14 11:37:36 -0700856 info->irq_flags, info->name, idev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100857 if (ret)
858 goto err_request_irq;
859 }
860
861 return 0;
862
863err_request_irq:
864 uio_dev_del_attributes(idev);
865err_uio_dev_add_attributes:
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700866 device_destroy(&uio_class, MKDEV(uio_major, idev->minor));
Hans J. Kochbeafc542006-12-07 10:58:29 +0100867err_device_create:
868 uio_free_minor(idev);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100869 return ret;
870}
871EXPORT_SYMBOL_GPL(__uio_register_device);
872
873/**
874 * uio_unregister_device - unregister a industrial IO device
875 * @info: UIO device capabilities
876 *
877 */
878void uio_unregister_device(struct uio_info *info)
879{
880 struct uio_device *idev;
881
882 if (!info || !info->uio_dev)
883 return;
884
885 idev = info->uio_dev;
886
887 uio_free_minor(idev);
888
Hans J. Kochbeafc542006-12-07 10:58:29 +0100889 uio_dev_del_attributes(idev);
890
Stephen Hemminger9ff2c132015-05-14 09:19:13 -0700891 if (info->irq && info->irq != UIO_IRQ_CUSTOM)
892 free_irq(info->irq, idev);
Brian Russella0871462015-03-19 17:55:26 +0000893
Eric W. Biedermanc66fdab2010-09-14 11:38:36 -0700894 device_destroy(&uio_class, MKDEV(uio_major, idev->minor));
Hans J. Kochbeafc542006-12-07 10:58:29 +0100895
896 return;
897}
898EXPORT_SYMBOL_GPL(uio_unregister_device);
899
900static int __init uio_init(void)
901{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700902 return init_uio_class();
Hans J. Kochbeafc542006-12-07 10:58:29 +0100903}
904
905static void __exit uio_exit(void)
906{
Eric W. Biederman3d4f9d72010-09-14 11:36:27 -0700907 release_uio_class();
Johannes Thumshirne2ef9392015-07-08 17:24:46 +0200908 idr_destroy(&uio_idr);
Hans J. Kochbeafc542006-12-07 10:58:29 +0100909}
910
911module_init(uio_init)
912module_exit(uio_exit)
913MODULE_LICENSE("GPL v2");