Loading...
1/*
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>
6 * Copyright(C) 2006, Hans J. Koch <hjk@hansjkoch.de>
7 * 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>
20#include <linux/slab.h>
21#include <linux/mm.h>
22#include <linux/idr.h>
23#include <linux/sched/signal.h>
24#include <linux/string.h>
25#include <linux/kobject.h>
26#include <linux/cdev.h>
27#include <linux/uio_driver.h>
28
29#define UIO_MAX_DEVICES (1U << MINORBITS)
30
31static int uio_major;
32static struct cdev *uio_cdev;
33static DEFINE_IDR(uio_idr);
34static const struct file_operations uio_fops;
35
36/* Protect idr accesses */
37static DEFINE_MUTEX(minor_lock);
38
39/*
40 * attributes
41 */
42
43struct uio_map {
44 struct kobject kobj;
45 struct uio_mem *mem;
46};
47#define to_map(map) container_of(map, struct uio_map, kobj)
48
49static 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
57static ssize_t map_addr_show(struct uio_mem *mem, char *buf)
58{
59 return sprintf(buf, "%pa\n", &mem->addr);
60}
61
62static ssize_t map_size_show(struct uio_mem *mem, char *buf)
63{
64 return sprintf(buf, "%pa\n", &mem->size);
65}
66
67static ssize_t map_offset_show(struct uio_mem *mem, char *buf)
68{
69 return sprintf(buf, "0x%llx\n", (unsigned long long)mem->offs);
70}
71
72struct map_sysfs_entry {
73 struct attribute attr;
74 ssize_t (*show)(struct uio_mem *, char *);
75 ssize_t (*store)(struct uio_mem *, const char *, size_t);
76};
77
78static struct map_sysfs_entry name_attribute =
79 __ATTR(name, S_IRUGO, map_name_show, NULL);
80static struct map_sysfs_entry addr_attribute =
81 __ATTR(addr, S_IRUGO, map_addr_show, NULL);
82static struct map_sysfs_entry size_attribute =
83 __ATTR(size, S_IRUGO, map_size_show, NULL);
84static struct map_sysfs_entry offset_attribute =
85 __ATTR(offset, S_IRUGO, map_offset_show, NULL);
86
87static struct attribute *attrs[] = {
88 &name_attribute.attr,
89 &addr_attribute.attr,
90 &size_attribute.attr,
91 &offset_attribute.attr,
92 NULL, /* need to NULL terminate the list of attributes */
93};
94
95static void map_release(struct kobject *kobj)
96{
97 struct uio_map *map = to_map(kobj);
98 kfree(map);
99}
100
101static 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;
106 struct map_sysfs_entry *entry;
107
108 entry = container_of(attr, struct map_sysfs_entry, attr);
109
110 if (!entry->show)
111 return -EIO;
112
113 return entry->show(mem, buf);
114}
115
116static const struct sysfs_ops map_sysfs_ops = {
117 .show = map_type_show,
118};
119
120static struct kobj_type map_attr_type = {
121 .release = map_release,
122 .sysfs_ops = &map_sysfs_ops,
123 .default_attrs = attrs,
124};
125
126struct 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
132static 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
140static 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
166static struct portio_sysfs_entry portio_name_attribute =
167 __ATTR(name, S_IRUGO, portio_name_show, NULL);
168static 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[] = {
176 &portio_name_attribute.attr,
177 &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
204static const struct sysfs_ops portio_sysfs_ops = {
205 .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
214static ssize_t name_show(struct device *dev,
215 struct device_attribute *attr, char *buf)
216{
217 struct uio_device *idev = dev_get_drvdata(dev);
218 return sprintf(buf, "%s\n", idev->info->name);
219}
220static DEVICE_ATTR_RO(name);
221
222static ssize_t version_show(struct device *dev,
223 struct device_attribute *attr, char *buf)
224{
225 struct uio_device *idev = dev_get_drvdata(dev);
226 return sprintf(buf, "%s\n", idev->info->version);
227}
228static DEVICE_ATTR_RO(version);
229
230static ssize_t event_show(struct device *dev,
231 struct device_attribute *attr, char *buf)
232{
233 struct uio_device *idev = dev_get_drvdata(dev);
234 return sprintf(buf, "%u\n", (unsigned int)atomic_read(&idev->event));
235}
236static DEVICE_ATTR_RO(event);
237
238static struct attribute *uio_attrs[] = {
239 &dev_attr_name.attr,
240 &dev_attr_version.attr,
241 &dev_attr_event.attr,
242 NULL,
243};
244ATTRIBUTE_GROUPS(uio);
245
246/* UIO class infrastructure */
247static struct class uio_class = {
248 .name = "uio",
249 .dev_groups = uio_groups,
250};
251
252/*
253 * device functions
254 */
255static int uio_dev_add_attributes(struct uio_device *idev)
256{
257 int ret;
258 int mi, pi;
259 int map_found = 0;
260 int portio_found = 0;
261 struct uio_mem *mem;
262 struct uio_map *map;
263 struct uio_port *port;
264 struct uio_portio *portio;
265
266 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;
272 idev->map_dir = kobject_create_and_add("maps",
273 &idev->dev->kobj);
274 if (!idev->map_dir) {
275 ret = -ENOMEM;
276 goto err_map;
277 }
278 }
279 map = kzalloc(sizeof(*map), GFP_KERNEL);
280 if (!map) {
281 ret = -ENOMEM;
282 goto err_map;
283 }
284 kobject_init(&map->kobj, &map_attr_type);
285 map->mem = mem;
286 mem->map = map;
287 ret = kobject_add(&map->kobj, idev->map_dir, "map%d", mi);
288 if (ret)
289 goto err_map_kobj;
290 ret = kobject_uevent(&map->kobj, KOBJ_ADD);
291 if (ret)
292 goto err_map_kobj;
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);
303 if (!idev->portio_dir) {
304 ret = -ENOMEM;
305 goto err_portio;
306 }
307 }
308 portio = kzalloc(sizeof(*portio), GFP_KERNEL);
309 if (!portio) {
310 ret = -ENOMEM;
311 goto err_portio;
312 }
313 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)
319 goto err_portio_kobj;
320 ret = kobject_uevent(&portio->kobj, KOBJ_ADD);
321 if (ret)
322 goto err_portio_kobj;
323 }
324
325 return 0;
326
327err_portio:
328 pi--;
329err_portio_kobj:
330 for (; pi >= 0; pi--) {
331 port = &idev->info->port[pi];
332 portio = port->portio;
333 kobject_put(&portio->kobj);
334 }
335 kobject_put(idev->portio_dir);
336err_map:
337 mi--;
338err_map_kobj:
339 for (; mi >= 0; mi--) {
340 mem = &idev->info->mem[mi];
341 map = mem->map;
342 kobject_put(&map->kobj);
343 }
344 kobject_put(idev->map_dir);
345 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{
351 int i;
352 struct uio_mem *mem;
353 struct uio_port *port;
354
355 for (i = 0; i < MAX_UIO_MAPS; i++) {
356 mem = &idev->info->mem[i];
357 if (mem->size == 0)
358 break;
359 kobject_put(&mem->map->kobj);
360 }
361 kobject_put(idev->map_dir);
362
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);
370}
371
372static int uio_get_minor(struct uio_device *idev)
373{
374 int retval = -ENOMEM;
375
376 mutex_lock(&minor_lock);
377 retval = idr_alloc(&uio_idr, idev, 0, UIO_MAX_DEVICES, GFP_KERNEL);
378 if (retval >= 0) {
379 idev->minor = retval;
380 retval = 0;
381 } else if (retval == -ENOSPC) {
382 dev_err(idev->dev, "too many uio devices\n");
383 retval = -EINVAL;
384 }
385 mutex_unlock(&minor_lock);
386 return retval;
387}
388
389static void uio_free_minor(struct uio_device *idev)
390{
391 mutex_lock(&minor_lock);
392 idr_remove(&uio_idr, idev->minor);
393 mutex_unlock(&minor_lock);
394}
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
437 mutex_lock(&minor_lock);
438 idev = idr_find(&uio_idr, iminor(inode));
439 mutex_unlock(&minor_lock);
440 if (!idev) {
441 ret = -ENODEV;
442 goto out;
443 }
444
445 if (!try_module_get(idev->owner)) {
446 ret = -ENODEV;
447 goto out;
448 }
449
450 listener = kmalloc(sizeof(*listener), GFP_KERNEL);
451 if (!listener) {
452 ret = -ENOMEM;
453 goto err_alloc_listener;
454 }
455
456 listener->dev = idev;
457 listener->event_count = atomic_read(&idev->event);
458 filep->private_data = listener;
459
460 if (idev->info->open) {
461 ret = idev->info->open(idev->info, inode);
462 if (ret)
463 goto err_infoopen;
464 }
465 return 0;
466
467err_infoopen:
468 kfree(listener);
469
470err_alloc_listener:
471 module_put(idev->owner);
472
473out:
474 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
491 if (idev->info->release)
492 ret = idev->info->release(idev->info, inode);
493
494 module_put(idev->owner);
495 kfree(listener);
496 return ret;
497}
498
499static __poll_t 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
504 if (!idev->info->irq)
505 return -EIO;
506
507 poll_wait(filep, &idev->wait, wait);
508 if (listener->event_count != atomic_read(&idev->event))
509 return EPOLLIN | EPOLLRDNORM;
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
522 if (!idev->info->irq)
523 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) {
535 __set_current_state(TASK_RUNNING);
536 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
563static 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
571 if (!idev->info->irq)
572 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
588static int uio_find_mem_index(struct vm_area_struct *vma)
589{
590 struct uio_device *idev = vma->vm_private_data;
591
592 if (vma->vm_pgoff < MAX_UIO_MAPS) {
593 if (idev->info->mem[vma->vm_pgoff].size == 0)
594 return -1;
595 return (int)vma->vm_pgoff;
596 }
597 return -1;
598}
599
600static int uio_vma_fault(struct vm_fault *vmf)
601{
602 struct uio_device *idev = vmf->vma->vm_private_data;
603 struct page *page;
604 unsigned long offset;
605 void *addr;
606
607 int mi = uio_find_mem_index(vmf->vma);
608 if (mi < 0)
609 return VM_FAULT_SIGBUS;
610
611 /*
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
617 addr = (void *)(unsigned long)idev->info->mem[mi].addr + offset;
618 if (idev->info->mem[mi].memtype == UIO_MEM_LOGICAL)
619 page = virt_to_page(addr);
620 else
621 page = vmalloc_to_page(addr);
622 get_page(page);
623 vmf->page = page;
624 return 0;
625}
626
627static const struct vm_operations_struct uio_logical_vm_ops = {
628 .fault = uio_vma_fault,
629};
630
631static 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;
635 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
644static 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);
648 struct uio_mem *mem;
649 if (mi < 0)
650 return -EINVAL;
651 mem = idev->info->mem + mi;
652
653 if (mem->addr & ~PAGE_MASK)
654 return -ENODEV;
655 if (vma->vm_end - vma->vm_start > mem->size)
656 return -EINVAL;
657
658 vma->vm_ops = &uio_physical_vm_ops;
659 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
660
661 /*
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 */
670 return remap_pfn_range(vma,
671 vma->vm_start,
672 mem->addr >> PAGE_SHIFT,
673 vma->vm_end - vma->vm_start,
674 vma->vm_page_prot);
675}
676
677static 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
694 requested_pages = vma_pages(vma);
695 actual_pages = ((idev->info->mem[mi].addr & ~PAGE_MASK)
696 + idev->info->mem[mi].size + PAGE_SIZE -1) >> PAGE_SHIFT;
697 if (requested_pages > actual_pages)
698 return -EINVAL;
699
700 if (idev->info->mmap) {
701 ret = idev->info->mmap(idev->info, vma);
702 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
716static const struct file_operations uio_fops = {
717 .owner = THIS_MODULE,
718 .open = uio_open,
719 .release = uio_release,
720 .read = uio_read,
721 .write = uio_write,
722 .mmap = uio_mmap,
723 .poll = uio_poll,
724 .fasync = uio_fasync,
725 .llseek = noop_llseek,
726};
727
728static int uio_major_init(void)
729{
730 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;
754 return 0;
755out_put:
756 kobject_put(&cdev->kobj);
757out_unregister:
758 unregister_chrdev_region(uio_dev, UIO_MAX_DEVICES);
759out:
760 return result;
761}
762
763static void uio_major_cleanup(void)
764{
765 unregister_chrdev_region(MKDEV(uio_major, 0), UIO_MAX_DEVICES);
766 cdev_del(uio_cdev);
767}
768
769static int init_uio_class(void)
770{
771 int ret;
772
773 /* This is the first time in here, set everything up properly */
774 ret = uio_major_init();
775 if (ret)
776 goto exit;
777
778 ret = class_register(&uio_class);
779 if (ret) {
780 printk(KERN_ERR "class_register failed for uio\n");
781 goto err_class_register;
782 }
783 return 0;
784
785err_class_register:
786 uio_major_cleanup();
787exit:
788 return ret;
789}
790
791static void release_uio_class(void)
792{
793 class_unregister(&uio_class);
794 uio_major_cleanup();
795}
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
817 idev = devm_kzalloc(parent, sizeof(*idev), GFP_KERNEL);
818 if (!idev) {
819 return -ENOMEM;
820 }
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)
829 return ret;
830
831 idev->dev = device_create(&uio_class, parent,
832 MKDEV(uio_major, idev->minor), idev,
833 "uio%d", idev->minor);
834 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 }
839
840 ret = uio_dev_add_attributes(idev);
841 if (ret)
842 goto err_uio_dev_add_attributes;
843
844 info->uio_dev = idev;
845
846 if (info->irq && (info->irq != UIO_IRQ_CUSTOM)) {
847 /*
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,
856 info->irq_flags, info->name, idev);
857 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:
866 device_destroy(&uio_class, MKDEV(uio_major, idev->minor));
867err_device_create:
868 uio_free_minor(idev);
869 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
889 uio_dev_del_attributes(idev);
890
891 if (info->irq && info->irq != UIO_IRQ_CUSTOM)
892 free_irq(info->irq, idev);
893
894 device_destroy(&uio_class, MKDEV(uio_major, idev->minor));
895
896 return;
897}
898EXPORT_SYMBOL_GPL(uio_unregister_device);
899
900static int __init uio_init(void)
901{
902 return init_uio_class();
903}
904
905static void __exit uio_exit(void)
906{
907 release_uio_class();
908 idr_destroy(&uio_idr);
909}
910
911module_init(uio_init)
912module_exit(uio_exit)
913MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * drivers/uio/uio.c
4 *
5 * Copyright(C) 2005, Benedikt Spranger <b.spranger@linutronix.de>
6 * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
7 * Copyright(C) 2006, Hans J. Koch <hjk@hansjkoch.de>
8 * Copyright(C) 2006, Greg Kroah-Hartman <greg@kroah.com>
9 *
10 * Userspace IO
11 *
12 * Base Functions
13 */
14
15#include <linux/module.h>
16#include <linux/init.h>
17#include <linux/poll.h>
18#include <linux/device.h>
19#include <linux/slab.h>
20#include <linux/mm.h>
21#include <linux/idr.h>
22#include <linux/sched/signal.h>
23#include <linux/string.h>
24#include <linux/kobject.h>
25#include <linux/cdev.h>
26#include <linux/uio_driver.h>
27
28#define UIO_MAX_DEVICES (1U << MINORBITS)
29
30static int uio_major;
31static struct cdev *uio_cdev;
32static DEFINE_IDR(uio_idr);
33static const struct file_operations uio_fops;
34
35/* Protect idr accesses */
36static DEFINE_MUTEX(minor_lock);
37
38/*
39 * attributes
40 */
41
42struct uio_map {
43 struct kobject kobj;
44 struct uio_mem *mem;
45};
46#define to_map(map) container_of(map, struct uio_map, kobj)
47
48static ssize_t map_name_show(struct uio_mem *mem, char *buf)
49{
50 if (unlikely(!mem->name))
51 mem->name = "";
52
53 return sprintf(buf, "%s\n", mem->name);
54}
55
56static ssize_t map_addr_show(struct uio_mem *mem, char *buf)
57{
58 return sprintf(buf, "%pa\n", &mem->addr);
59}
60
61static ssize_t map_size_show(struct uio_mem *mem, char *buf)
62{
63 return sprintf(buf, "%pa\n", &mem->size);
64}
65
66static ssize_t map_offset_show(struct uio_mem *mem, char *buf)
67{
68 return sprintf(buf, "0x%llx\n", (unsigned long long)mem->offs);
69}
70
71struct map_sysfs_entry {
72 struct attribute attr;
73 ssize_t (*show)(struct uio_mem *, char *);
74 ssize_t (*store)(struct uio_mem *, const char *, size_t);
75};
76
77static struct map_sysfs_entry name_attribute =
78 __ATTR(name, S_IRUGO, map_name_show, NULL);
79static struct map_sysfs_entry addr_attribute =
80 __ATTR(addr, S_IRUGO, map_addr_show, NULL);
81static struct map_sysfs_entry size_attribute =
82 __ATTR(size, S_IRUGO, map_size_show, NULL);
83static struct map_sysfs_entry offset_attribute =
84 __ATTR(offset, S_IRUGO, map_offset_show, NULL);
85
86static struct attribute *attrs[] = {
87 &name_attribute.attr,
88 &addr_attribute.attr,
89 &size_attribute.attr,
90 &offset_attribute.attr,
91 NULL, /* need to NULL terminate the list of attributes */
92};
93
94static void map_release(struct kobject *kobj)
95{
96 struct uio_map *map = to_map(kobj);
97 kfree(map);
98}
99
100static ssize_t map_type_show(struct kobject *kobj, struct attribute *attr,
101 char *buf)
102{
103 struct uio_map *map = to_map(kobj);
104 struct uio_mem *mem = map->mem;
105 struct map_sysfs_entry *entry;
106
107 entry = container_of(attr, struct map_sysfs_entry, attr);
108
109 if (!entry->show)
110 return -EIO;
111
112 return entry->show(mem, buf);
113}
114
115static const struct sysfs_ops map_sysfs_ops = {
116 .show = map_type_show,
117};
118
119static struct kobj_type map_attr_type = {
120 .release = map_release,
121 .sysfs_ops = &map_sysfs_ops,
122 .default_attrs = attrs,
123};
124
125struct uio_portio {
126 struct kobject kobj;
127 struct uio_port *port;
128};
129#define to_portio(portio) container_of(portio, struct uio_portio, kobj)
130
131static ssize_t portio_name_show(struct uio_port *port, char *buf)
132{
133 if (unlikely(!port->name))
134 port->name = "";
135
136 return sprintf(buf, "%s\n", port->name);
137}
138
139static ssize_t portio_start_show(struct uio_port *port, char *buf)
140{
141 return sprintf(buf, "0x%lx\n", port->start);
142}
143
144static ssize_t portio_size_show(struct uio_port *port, char *buf)
145{
146 return sprintf(buf, "0x%lx\n", port->size);
147}
148
149static ssize_t portio_porttype_show(struct uio_port *port, char *buf)
150{
151 const char *porttypes[] = {"none", "x86", "gpio", "other"};
152
153 if ((port->porttype < 0) || (port->porttype > UIO_PORT_OTHER))
154 return -EINVAL;
155
156 return sprintf(buf, "port_%s\n", porttypes[port->porttype]);
157}
158
159struct portio_sysfs_entry {
160 struct attribute attr;
161 ssize_t (*show)(struct uio_port *, char *);
162 ssize_t (*store)(struct uio_port *, const char *, size_t);
163};
164
165static struct portio_sysfs_entry portio_name_attribute =
166 __ATTR(name, S_IRUGO, portio_name_show, NULL);
167static struct portio_sysfs_entry portio_start_attribute =
168 __ATTR(start, S_IRUGO, portio_start_show, NULL);
169static struct portio_sysfs_entry portio_size_attribute =
170 __ATTR(size, S_IRUGO, portio_size_show, NULL);
171static struct portio_sysfs_entry portio_porttype_attribute =
172 __ATTR(porttype, S_IRUGO, portio_porttype_show, NULL);
173
174static struct attribute *portio_attrs[] = {
175 &portio_name_attribute.attr,
176 &portio_start_attribute.attr,
177 &portio_size_attribute.attr,
178 &portio_porttype_attribute.attr,
179 NULL,
180};
181
182static void portio_release(struct kobject *kobj)
183{
184 struct uio_portio *portio = to_portio(kobj);
185 kfree(portio);
186}
187
188static ssize_t portio_type_show(struct kobject *kobj, struct attribute *attr,
189 char *buf)
190{
191 struct uio_portio *portio = to_portio(kobj);
192 struct uio_port *port = portio->port;
193 struct portio_sysfs_entry *entry;
194
195 entry = container_of(attr, struct portio_sysfs_entry, attr);
196
197 if (!entry->show)
198 return -EIO;
199
200 return entry->show(port, buf);
201}
202
203static const struct sysfs_ops portio_sysfs_ops = {
204 .show = portio_type_show,
205};
206
207static struct kobj_type portio_attr_type = {
208 .release = portio_release,
209 .sysfs_ops = &portio_sysfs_ops,
210 .default_attrs = portio_attrs,
211};
212
213static ssize_t name_show(struct device *dev,
214 struct device_attribute *attr, char *buf)
215{
216 struct uio_device *idev = dev_get_drvdata(dev);
217 int ret;
218
219 mutex_lock(&idev->info_lock);
220 if (!idev->info) {
221 ret = -EINVAL;
222 dev_err(dev, "the device has been unregistered\n");
223 goto out;
224 }
225
226 ret = sprintf(buf, "%s\n", idev->info->name);
227
228out:
229 mutex_unlock(&idev->info_lock);
230 return ret;
231}
232static DEVICE_ATTR_RO(name);
233
234static ssize_t version_show(struct device *dev,
235 struct device_attribute *attr, char *buf)
236{
237 struct uio_device *idev = dev_get_drvdata(dev);
238 int ret;
239
240 mutex_lock(&idev->info_lock);
241 if (!idev->info) {
242 ret = -EINVAL;
243 dev_err(dev, "the device has been unregistered\n");
244 goto out;
245 }
246
247 ret = sprintf(buf, "%s\n", idev->info->version);
248
249out:
250 mutex_unlock(&idev->info_lock);
251 return ret;
252}
253static DEVICE_ATTR_RO(version);
254
255static ssize_t event_show(struct device *dev,
256 struct device_attribute *attr, char *buf)
257{
258 struct uio_device *idev = dev_get_drvdata(dev);
259 return sprintf(buf, "%u\n", (unsigned int)atomic_read(&idev->event));
260}
261static DEVICE_ATTR_RO(event);
262
263static struct attribute *uio_attrs[] = {
264 &dev_attr_name.attr,
265 &dev_attr_version.attr,
266 &dev_attr_event.attr,
267 NULL,
268};
269ATTRIBUTE_GROUPS(uio);
270
271/* UIO class infrastructure */
272static struct class uio_class = {
273 .name = "uio",
274 .dev_groups = uio_groups,
275};
276
277static bool uio_class_registered;
278
279/*
280 * device functions
281 */
282static int uio_dev_add_attributes(struct uio_device *idev)
283{
284 int ret;
285 int mi, pi;
286 int map_found = 0;
287 int portio_found = 0;
288 struct uio_mem *mem;
289 struct uio_map *map;
290 struct uio_port *port;
291 struct uio_portio *portio;
292
293 for (mi = 0; mi < MAX_UIO_MAPS; mi++) {
294 mem = &idev->info->mem[mi];
295 if (mem->size == 0)
296 break;
297 if (!map_found) {
298 map_found = 1;
299 idev->map_dir = kobject_create_and_add("maps",
300 &idev->dev.kobj);
301 if (!idev->map_dir) {
302 ret = -ENOMEM;
303 goto err_map;
304 }
305 }
306 map = kzalloc(sizeof(*map), GFP_KERNEL);
307 if (!map) {
308 ret = -ENOMEM;
309 goto err_map;
310 }
311 kobject_init(&map->kobj, &map_attr_type);
312 map->mem = mem;
313 mem->map = map;
314 ret = kobject_add(&map->kobj, idev->map_dir, "map%d", mi);
315 if (ret)
316 goto err_map_kobj;
317 ret = kobject_uevent(&map->kobj, KOBJ_ADD);
318 if (ret)
319 goto err_map_kobj;
320 }
321
322 for (pi = 0; pi < MAX_UIO_PORT_REGIONS; pi++) {
323 port = &idev->info->port[pi];
324 if (port->size == 0)
325 break;
326 if (!portio_found) {
327 portio_found = 1;
328 idev->portio_dir = kobject_create_and_add("portio",
329 &idev->dev.kobj);
330 if (!idev->portio_dir) {
331 ret = -ENOMEM;
332 goto err_portio;
333 }
334 }
335 portio = kzalloc(sizeof(*portio), GFP_KERNEL);
336 if (!portio) {
337 ret = -ENOMEM;
338 goto err_portio;
339 }
340 kobject_init(&portio->kobj, &portio_attr_type);
341 portio->port = port;
342 port->portio = portio;
343 ret = kobject_add(&portio->kobj, idev->portio_dir,
344 "port%d", pi);
345 if (ret)
346 goto err_portio_kobj;
347 ret = kobject_uevent(&portio->kobj, KOBJ_ADD);
348 if (ret)
349 goto err_portio_kobj;
350 }
351
352 return 0;
353
354err_portio:
355 pi--;
356err_portio_kobj:
357 for (; pi >= 0; pi--) {
358 port = &idev->info->port[pi];
359 portio = port->portio;
360 kobject_put(&portio->kobj);
361 }
362 kobject_put(idev->portio_dir);
363err_map:
364 mi--;
365err_map_kobj:
366 for (; mi >= 0; mi--) {
367 mem = &idev->info->mem[mi];
368 map = mem->map;
369 kobject_put(&map->kobj);
370 }
371 kobject_put(idev->map_dir);
372 dev_err(&idev->dev, "error creating sysfs files (%d)\n", ret);
373 return ret;
374}
375
376static void uio_dev_del_attributes(struct uio_device *idev)
377{
378 int i;
379 struct uio_mem *mem;
380 struct uio_port *port;
381
382 for (i = 0; i < MAX_UIO_MAPS; i++) {
383 mem = &idev->info->mem[i];
384 if (mem->size == 0)
385 break;
386 kobject_put(&mem->map->kobj);
387 }
388 kobject_put(idev->map_dir);
389
390 for (i = 0; i < MAX_UIO_PORT_REGIONS; i++) {
391 port = &idev->info->port[i];
392 if (port->size == 0)
393 break;
394 kobject_put(&port->portio->kobj);
395 }
396 kobject_put(idev->portio_dir);
397}
398
399static int uio_get_minor(struct uio_device *idev)
400{
401 int retval;
402
403 mutex_lock(&minor_lock);
404 retval = idr_alloc(&uio_idr, idev, 0, UIO_MAX_DEVICES, GFP_KERNEL);
405 if (retval >= 0) {
406 idev->minor = retval;
407 retval = 0;
408 } else if (retval == -ENOSPC) {
409 dev_err(&idev->dev, "too many uio devices\n");
410 retval = -EINVAL;
411 }
412 mutex_unlock(&minor_lock);
413 return retval;
414}
415
416static void uio_free_minor(struct uio_device *idev)
417{
418 mutex_lock(&minor_lock);
419 idr_remove(&uio_idr, idev->minor);
420 mutex_unlock(&minor_lock);
421}
422
423/**
424 * uio_event_notify - trigger an interrupt event
425 * @info: UIO device capabilities
426 */
427void uio_event_notify(struct uio_info *info)
428{
429 struct uio_device *idev = info->uio_dev;
430
431 atomic_inc(&idev->event);
432 wake_up_interruptible(&idev->wait);
433 kill_fasync(&idev->async_queue, SIGIO, POLL_IN);
434}
435EXPORT_SYMBOL_GPL(uio_event_notify);
436
437/**
438 * uio_interrupt - hardware interrupt handler
439 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
440 * @dev_id: Pointer to the devices uio_device structure
441 */
442static irqreturn_t uio_interrupt(int irq, void *dev_id)
443{
444 struct uio_device *idev = (struct uio_device *)dev_id;
445 irqreturn_t ret;
446
447 ret = idev->info->handler(irq, idev->info);
448 if (ret == IRQ_HANDLED)
449 uio_event_notify(idev->info);
450
451 return ret;
452}
453
454struct uio_listener {
455 struct uio_device *dev;
456 s32 event_count;
457};
458
459static int uio_open(struct inode *inode, struct file *filep)
460{
461 struct uio_device *idev;
462 struct uio_listener *listener;
463 int ret = 0;
464
465 mutex_lock(&minor_lock);
466 idev = idr_find(&uio_idr, iminor(inode));
467 mutex_unlock(&minor_lock);
468 if (!idev) {
469 ret = -ENODEV;
470 goto out;
471 }
472
473 get_device(&idev->dev);
474
475 if (!try_module_get(idev->owner)) {
476 ret = -ENODEV;
477 goto err_module_get;
478 }
479
480 listener = kmalloc(sizeof(*listener), GFP_KERNEL);
481 if (!listener) {
482 ret = -ENOMEM;
483 goto err_alloc_listener;
484 }
485
486 listener->dev = idev;
487 listener->event_count = atomic_read(&idev->event);
488 filep->private_data = listener;
489
490 mutex_lock(&idev->info_lock);
491 if (!idev->info) {
492 mutex_unlock(&idev->info_lock);
493 ret = -EINVAL;
494 goto err_infoopen;
495 }
496
497 if (idev->info->open)
498 ret = idev->info->open(idev->info, inode);
499 mutex_unlock(&idev->info_lock);
500 if (ret)
501 goto err_infoopen;
502
503 return 0;
504
505err_infoopen:
506 kfree(listener);
507
508err_alloc_listener:
509 module_put(idev->owner);
510
511err_module_get:
512 put_device(&idev->dev);
513
514out:
515 return ret;
516}
517
518static int uio_fasync(int fd, struct file *filep, int on)
519{
520 struct uio_listener *listener = filep->private_data;
521 struct uio_device *idev = listener->dev;
522
523 return fasync_helper(fd, filep, on, &idev->async_queue);
524}
525
526static int uio_release(struct inode *inode, struct file *filep)
527{
528 int ret = 0;
529 struct uio_listener *listener = filep->private_data;
530 struct uio_device *idev = listener->dev;
531
532 mutex_lock(&idev->info_lock);
533 if (idev->info && idev->info->release)
534 ret = idev->info->release(idev->info, inode);
535 mutex_unlock(&idev->info_lock);
536
537 module_put(idev->owner);
538 kfree(listener);
539 put_device(&idev->dev);
540 return ret;
541}
542
543static __poll_t uio_poll(struct file *filep, poll_table *wait)
544{
545 struct uio_listener *listener = filep->private_data;
546 struct uio_device *idev = listener->dev;
547 __poll_t ret = 0;
548
549 mutex_lock(&idev->info_lock);
550 if (!idev->info || !idev->info->irq)
551 ret = -EIO;
552 mutex_unlock(&idev->info_lock);
553
554 if (ret)
555 return ret;
556
557 poll_wait(filep, &idev->wait, wait);
558 if (listener->event_count != atomic_read(&idev->event))
559 return EPOLLIN | EPOLLRDNORM;
560 return 0;
561}
562
563static ssize_t uio_read(struct file *filep, char __user *buf,
564 size_t count, loff_t *ppos)
565{
566 struct uio_listener *listener = filep->private_data;
567 struct uio_device *idev = listener->dev;
568 DECLARE_WAITQUEUE(wait, current);
569 ssize_t retval = 0;
570 s32 event_count;
571
572 if (count != sizeof(s32))
573 return -EINVAL;
574
575 add_wait_queue(&idev->wait, &wait);
576
577 do {
578 mutex_lock(&idev->info_lock);
579 if (!idev->info || !idev->info->irq) {
580 retval = -EIO;
581 mutex_unlock(&idev->info_lock);
582 break;
583 }
584 mutex_unlock(&idev->info_lock);
585
586 set_current_state(TASK_INTERRUPTIBLE);
587
588 event_count = atomic_read(&idev->event);
589 if (event_count != listener->event_count) {
590 __set_current_state(TASK_RUNNING);
591 if (copy_to_user(buf, &event_count, count))
592 retval = -EFAULT;
593 else {
594 listener->event_count = event_count;
595 retval = count;
596 }
597 break;
598 }
599
600 if (filep->f_flags & O_NONBLOCK) {
601 retval = -EAGAIN;
602 break;
603 }
604
605 if (signal_pending(current)) {
606 retval = -ERESTARTSYS;
607 break;
608 }
609 schedule();
610 } while (1);
611
612 __set_current_state(TASK_RUNNING);
613 remove_wait_queue(&idev->wait, &wait);
614
615 return retval;
616}
617
618static ssize_t uio_write(struct file *filep, const char __user *buf,
619 size_t count, loff_t *ppos)
620{
621 struct uio_listener *listener = filep->private_data;
622 struct uio_device *idev = listener->dev;
623 ssize_t retval;
624 s32 irq_on;
625
626 if (count != sizeof(s32))
627 return -EINVAL;
628
629 if (copy_from_user(&irq_on, buf, count))
630 return -EFAULT;
631
632 mutex_lock(&idev->info_lock);
633 if (!idev->info) {
634 retval = -EINVAL;
635 goto out;
636 }
637
638 if (!idev->info->irq) {
639 retval = -EIO;
640 goto out;
641 }
642
643 if (!idev->info->irqcontrol) {
644 retval = -ENOSYS;
645 goto out;
646 }
647
648 retval = idev->info->irqcontrol(idev->info, irq_on);
649
650out:
651 mutex_unlock(&idev->info_lock);
652 return retval ? retval : sizeof(s32);
653}
654
655static int uio_find_mem_index(struct vm_area_struct *vma)
656{
657 struct uio_device *idev = vma->vm_private_data;
658
659 if (vma->vm_pgoff < MAX_UIO_MAPS) {
660 if (idev->info->mem[vma->vm_pgoff].size == 0)
661 return -1;
662 return (int)vma->vm_pgoff;
663 }
664 return -1;
665}
666
667static vm_fault_t uio_vma_fault(struct vm_fault *vmf)
668{
669 struct uio_device *idev = vmf->vma->vm_private_data;
670 struct page *page;
671 unsigned long offset;
672 void *addr;
673 vm_fault_t ret = 0;
674 int mi;
675
676 mutex_lock(&idev->info_lock);
677 if (!idev->info) {
678 ret = VM_FAULT_SIGBUS;
679 goto out;
680 }
681
682 mi = uio_find_mem_index(vmf->vma);
683 if (mi < 0) {
684 ret = VM_FAULT_SIGBUS;
685 goto out;
686 }
687
688 /*
689 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
690 * to use mem[N].
691 */
692 offset = (vmf->pgoff - mi) << PAGE_SHIFT;
693
694 addr = (void *)(unsigned long)idev->info->mem[mi].addr + offset;
695 if (idev->info->mem[mi].memtype == UIO_MEM_LOGICAL)
696 page = virt_to_page(addr);
697 else
698 page = vmalloc_to_page(addr);
699 get_page(page);
700 vmf->page = page;
701
702out:
703 mutex_unlock(&idev->info_lock);
704
705 return ret;
706}
707
708static const struct vm_operations_struct uio_logical_vm_ops = {
709 .fault = uio_vma_fault,
710};
711
712static int uio_mmap_logical(struct vm_area_struct *vma)
713{
714 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
715 vma->vm_ops = &uio_logical_vm_ops;
716 return 0;
717}
718
719static const struct vm_operations_struct uio_physical_vm_ops = {
720#ifdef CONFIG_HAVE_IOREMAP_PROT
721 .access = generic_access_phys,
722#endif
723};
724
725static int uio_mmap_physical(struct vm_area_struct *vma)
726{
727 struct uio_device *idev = vma->vm_private_data;
728 int mi = uio_find_mem_index(vma);
729 struct uio_mem *mem;
730
731 if (mi < 0)
732 return -EINVAL;
733 mem = idev->info->mem + mi;
734
735 if (mem->addr & ~PAGE_MASK)
736 return -ENODEV;
737 if (vma->vm_end - vma->vm_start > mem->size)
738 return -EINVAL;
739
740 vma->vm_ops = &uio_physical_vm_ops;
741 if (idev->info->mem[mi].memtype == UIO_MEM_PHYS)
742 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
743
744 /*
745 * We cannot use the vm_iomap_memory() helper here,
746 * because vma->vm_pgoff is the map index we looked
747 * up above in uio_find_mem_index(), rather than an
748 * actual page offset into the mmap.
749 *
750 * So we just do the physical mmap without a page
751 * offset.
752 */
753 return remap_pfn_range(vma,
754 vma->vm_start,
755 mem->addr >> PAGE_SHIFT,
756 vma->vm_end - vma->vm_start,
757 vma->vm_page_prot);
758}
759
760static int uio_mmap(struct file *filep, struct vm_area_struct *vma)
761{
762 struct uio_listener *listener = filep->private_data;
763 struct uio_device *idev = listener->dev;
764 int mi;
765 unsigned long requested_pages, actual_pages;
766 int ret = 0;
767
768 if (vma->vm_end < vma->vm_start)
769 return -EINVAL;
770
771 vma->vm_private_data = idev;
772
773 mutex_lock(&idev->info_lock);
774 if (!idev->info) {
775 ret = -EINVAL;
776 goto out;
777 }
778
779 mi = uio_find_mem_index(vma);
780 if (mi < 0) {
781 ret = -EINVAL;
782 goto out;
783 }
784
785 requested_pages = vma_pages(vma);
786 actual_pages = ((idev->info->mem[mi].addr & ~PAGE_MASK)
787 + idev->info->mem[mi].size + PAGE_SIZE -1) >> PAGE_SHIFT;
788 if (requested_pages > actual_pages) {
789 ret = -EINVAL;
790 goto out;
791 }
792
793 if (idev->info->mmap) {
794 ret = idev->info->mmap(idev->info, vma);
795 goto out;
796 }
797
798 switch (idev->info->mem[mi].memtype) {
799 case UIO_MEM_IOVA:
800 case UIO_MEM_PHYS:
801 ret = uio_mmap_physical(vma);
802 break;
803 case UIO_MEM_LOGICAL:
804 case UIO_MEM_VIRTUAL:
805 ret = uio_mmap_logical(vma);
806 break;
807 default:
808 ret = -EINVAL;
809 }
810
811 out:
812 mutex_unlock(&idev->info_lock);
813 return ret;
814}
815
816static const struct file_operations uio_fops = {
817 .owner = THIS_MODULE,
818 .open = uio_open,
819 .release = uio_release,
820 .read = uio_read,
821 .write = uio_write,
822 .mmap = uio_mmap,
823 .poll = uio_poll,
824 .fasync = uio_fasync,
825 .llseek = noop_llseek,
826};
827
828static int uio_major_init(void)
829{
830 static const char name[] = "uio";
831 struct cdev *cdev = NULL;
832 dev_t uio_dev = 0;
833 int result;
834
835 result = alloc_chrdev_region(&uio_dev, 0, UIO_MAX_DEVICES, name);
836 if (result)
837 goto out;
838
839 result = -ENOMEM;
840 cdev = cdev_alloc();
841 if (!cdev)
842 goto out_unregister;
843
844 cdev->owner = THIS_MODULE;
845 cdev->ops = &uio_fops;
846 kobject_set_name(&cdev->kobj, "%s", name);
847
848 result = cdev_add(cdev, uio_dev, UIO_MAX_DEVICES);
849 if (result)
850 goto out_put;
851
852 uio_major = MAJOR(uio_dev);
853 uio_cdev = cdev;
854 return 0;
855out_put:
856 kobject_put(&cdev->kobj);
857out_unregister:
858 unregister_chrdev_region(uio_dev, UIO_MAX_DEVICES);
859out:
860 return result;
861}
862
863static void uio_major_cleanup(void)
864{
865 unregister_chrdev_region(MKDEV(uio_major, 0), UIO_MAX_DEVICES);
866 cdev_del(uio_cdev);
867}
868
869static int init_uio_class(void)
870{
871 int ret;
872
873 /* This is the first time in here, set everything up properly */
874 ret = uio_major_init();
875 if (ret)
876 goto exit;
877
878 ret = class_register(&uio_class);
879 if (ret) {
880 printk(KERN_ERR "class_register failed for uio\n");
881 goto err_class_register;
882 }
883
884 uio_class_registered = true;
885
886 return 0;
887
888err_class_register:
889 uio_major_cleanup();
890exit:
891 return ret;
892}
893
894static void release_uio_class(void)
895{
896 uio_class_registered = false;
897 class_unregister(&uio_class);
898 uio_major_cleanup();
899}
900
901static void uio_device_release(struct device *dev)
902{
903 struct uio_device *idev = dev_get_drvdata(dev);
904
905 kfree(idev);
906}
907
908/**
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 (!uio_class_registered)
924 return -EPROBE_DEFER;
925
926 if (!parent || !info || !info->name || !info->version)
927 return -EINVAL;
928
929 info->uio_dev = NULL;
930
931 idev = kzalloc(sizeof(*idev), GFP_KERNEL);
932 if (!idev) {
933 return -ENOMEM;
934 }
935
936 idev->owner = owner;
937 idev->info = info;
938 mutex_init(&idev->info_lock);
939 init_waitqueue_head(&idev->wait);
940 atomic_set(&idev->event, 0);
941
942 ret = uio_get_minor(idev);
943 if (ret) {
944 kfree(idev);
945 return ret;
946 }
947
948 device_initialize(&idev->dev);
949 idev->dev.devt = MKDEV(uio_major, idev->minor);
950 idev->dev.class = &uio_class;
951 idev->dev.parent = parent;
952 idev->dev.release = uio_device_release;
953 dev_set_drvdata(&idev->dev, idev);
954
955 ret = dev_set_name(&idev->dev, "uio%d", idev->minor);
956 if (ret)
957 goto err_device_create;
958
959 ret = device_add(&idev->dev);
960 if (ret)
961 goto err_device_create;
962
963 ret = uio_dev_add_attributes(idev);
964 if (ret)
965 goto err_uio_dev_add_attributes;
966
967 info->uio_dev = idev;
968
969 if (info->irq && (info->irq != UIO_IRQ_CUSTOM)) {
970 /*
971 * Note that we deliberately don't use devm_request_irq
972 * here. The parent module can unregister the UIO device
973 * and call pci_disable_msi, which requires that this
974 * irq has been freed. However, the device may have open
975 * FDs at the time of unregister and therefore may not be
976 * freed until they are released.
977 */
978 ret = request_irq(info->irq, uio_interrupt,
979 info->irq_flags, info->name, idev);
980 if (ret) {
981 info->uio_dev = NULL;
982 goto err_request_irq;
983 }
984 }
985
986 return 0;
987
988err_request_irq:
989 uio_dev_del_attributes(idev);
990err_uio_dev_add_attributes:
991 device_del(&idev->dev);
992err_device_create:
993 uio_free_minor(idev);
994 put_device(&idev->dev);
995 return ret;
996}
997EXPORT_SYMBOL_GPL(__uio_register_device);
998
999static void devm_uio_unregister_device(struct device *dev, void *res)
1000{
1001 uio_unregister_device(*(struct uio_info **)res);
1002}
1003
1004/**
1005 * devm_uio_register_device - Resource managed uio_register_device()
1006 * @owner: module that creates the new device
1007 * @parent: parent device
1008 * @info: UIO device capabilities
1009 *
1010 * returns zero on success or a negative error code.
1011 */
1012int __devm_uio_register_device(struct module *owner,
1013 struct device *parent,
1014 struct uio_info *info)
1015{
1016 struct uio_info **ptr;
1017 int ret;
1018
1019 ptr = devres_alloc(devm_uio_unregister_device, sizeof(*ptr),
1020 GFP_KERNEL);
1021 if (!ptr)
1022 return -ENOMEM;
1023
1024 *ptr = info;
1025 ret = __uio_register_device(owner, parent, info);
1026 if (ret) {
1027 devres_free(ptr);
1028 return ret;
1029 }
1030
1031 devres_add(parent, ptr);
1032
1033 return 0;
1034}
1035EXPORT_SYMBOL_GPL(__devm_uio_register_device);
1036
1037/**
1038 * uio_unregister_device - unregister a industrial IO device
1039 * @info: UIO device capabilities
1040 *
1041 */
1042void uio_unregister_device(struct uio_info *info)
1043{
1044 struct uio_device *idev;
1045
1046 if (!info || !info->uio_dev)
1047 return;
1048
1049 idev = info->uio_dev;
1050
1051 uio_free_minor(idev);
1052
1053 mutex_lock(&idev->info_lock);
1054 uio_dev_del_attributes(idev);
1055
1056 if (info->irq && info->irq != UIO_IRQ_CUSTOM)
1057 free_irq(info->irq, idev);
1058
1059 idev->info = NULL;
1060 mutex_unlock(&idev->info_lock);
1061
1062 wake_up_interruptible(&idev->wait);
1063 kill_fasync(&idev->async_queue, SIGIO, POLL_HUP);
1064
1065 device_unregister(&idev->dev);
1066
1067 return;
1068}
1069EXPORT_SYMBOL_GPL(uio_unregister_device);
1070
1071static int __init uio_init(void)
1072{
1073 return init_uio_class();
1074}
1075
1076static void __exit uio_exit(void)
1077{
1078 release_uio_class();
1079 idr_destroy(&uio_idr);
1080}
1081
1082module_init(uio_init)
1083module_exit(uio_exit)
1084MODULE_LICENSE("GPL v2");