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>
13 * Licensed under the GPLv2 only.
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>
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>
29 #define UIO_MAX_DEVICES (1U << MINORBITS)
32 static struct cdev
*uio_cdev
;
33 static DEFINE_IDR(uio_idr
);
34 static const struct file_operations uio_fops
;
36 /* Protect idr accesses */
37 static DEFINE_MUTEX(minor_lock
);
47 #define to_map(map) container_of(map, struct uio_map, kobj)
49 static ssize_t
map_name_show(struct uio_mem
*mem
, char *buf
)
51 if (unlikely(!mem
->name
))
54 return sprintf(buf
, "%s\n", mem
->name
);
57 static ssize_t
map_addr_show(struct uio_mem
*mem
, char *buf
)
59 return sprintf(buf
, "%pa\n", &mem
->addr
);
62 static ssize_t
map_size_show(struct uio_mem
*mem
, char *buf
)
64 return sprintf(buf
, "%pa\n", &mem
->size
);
67 static ssize_t
map_offset_show(struct uio_mem
*mem
, char *buf
)
69 return sprintf(buf
, "0x%llx\n", (unsigned long long)mem
->addr
& ~PAGE_MASK
);
72 struct 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);
78 static struct map_sysfs_entry name_attribute
=
79 __ATTR(name
, S_IRUGO
, map_name_show
, NULL
);
80 static struct map_sysfs_entry addr_attribute
=
81 __ATTR(addr
, S_IRUGO
, map_addr_show
, NULL
);
82 static struct map_sysfs_entry size_attribute
=
83 __ATTR(size
, S_IRUGO
, map_size_show
, NULL
);
84 static struct map_sysfs_entry offset_attribute
=
85 __ATTR(offset
, S_IRUGO
, map_offset_show
, NULL
);
87 static struct attribute
*attrs
[] = {
91 &offset_attribute
.attr
,
92 NULL
, /* need to NULL terminate the list of attributes */
95 static void map_release(struct kobject
*kobj
)
97 struct uio_map
*map
= to_map(kobj
);
101 static ssize_t
map_type_show(struct kobject
*kobj
, struct attribute
*attr
,
104 struct uio_map
*map
= to_map(kobj
);
105 struct uio_mem
*mem
= map
->mem
;
106 struct map_sysfs_entry
*entry
;
108 entry
= container_of(attr
, struct map_sysfs_entry
, attr
);
113 return entry
->show(mem
, buf
);
116 static const struct sysfs_ops map_sysfs_ops
= {
117 .show
= map_type_show
,
120 static struct kobj_type map_attr_type
= {
121 .release
= map_release
,
122 .sysfs_ops
= &map_sysfs_ops
,
123 .default_attrs
= attrs
,
128 struct uio_port
*port
;
130 #define to_portio(portio) container_of(portio, struct uio_portio, kobj)
132 static ssize_t
portio_name_show(struct uio_port
*port
, char *buf
)
134 if (unlikely(!port
->name
))
137 return sprintf(buf
, "%s\n", port
->name
);
140 static ssize_t
portio_start_show(struct uio_port
*port
, char *buf
)
142 return sprintf(buf
, "0x%lx\n", port
->start
);
145 static ssize_t
portio_size_show(struct uio_port
*port
, char *buf
)
147 return sprintf(buf
, "0x%lx\n", port
->size
);
150 static ssize_t
portio_porttype_show(struct uio_port
*port
, char *buf
)
152 const char *porttypes
[] = {"none", "x86", "gpio", "other"};
154 if ((port
->porttype
< 0) || (port
->porttype
> UIO_PORT_OTHER
))
157 return sprintf(buf
, "port_%s\n", porttypes
[port
->porttype
]);
160 struct 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);
166 static struct portio_sysfs_entry portio_name_attribute
=
167 __ATTR(name
, S_IRUGO
, portio_name_show
, NULL
);
168 static struct portio_sysfs_entry portio_start_attribute
=
169 __ATTR(start
, S_IRUGO
, portio_start_show
, NULL
);
170 static struct portio_sysfs_entry portio_size_attribute
=
171 __ATTR(size
, S_IRUGO
, portio_size_show
, NULL
);
172 static struct portio_sysfs_entry portio_porttype_attribute
=
173 __ATTR(porttype
, S_IRUGO
, portio_porttype_show
, NULL
);
175 static struct attribute
*portio_attrs
[] = {
176 &portio_name_attribute
.attr
,
177 &portio_start_attribute
.attr
,
178 &portio_size_attribute
.attr
,
179 &portio_porttype_attribute
.attr
,
183 static void portio_release(struct kobject
*kobj
)
185 struct uio_portio
*portio
= to_portio(kobj
);
189 static ssize_t
portio_type_show(struct kobject
*kobj
, struct attribute
*attr
,
192 struct uio_portio
*portio
= to_portio(kobj
);
193 struct uio_port
*port
= portio
->port
;
194 struct portio_sysfs_entry
*entry
;
196 entry
= container_of(attr
, struct portio_sysfs_entry
, attr
);
201 return entry
->show(port
, buf
);
204 static const struct sysfs_ops portio_sysfs_ops
= {
205 .show
= portio_type_show
,
208 static struct kobj_type portio_attr_type
= {
209 .release
= portio_release
,
210 .sysfs_ops
= &portio_sysfs_ops
,
211 .default_attrs
= portio_attrs
,
214 static ssize_t
name_show(struct device
*dev
,
215 struct device_attribute
*attr
, char *buf
)
217 struct uio_device
*idev
= dev_get_drvdata(dev
);
218 return sprintf(buf
, "%s\n", idev
->info
->name
);
220 static DEVICE_ATTR_RO(name
);
222 static ssize_t
version_show(struct device
*dev
,
223 struct device_attribute
*attr
, char *buf
)
225 struct uio_device
*idev
= dev_get_drvdata(dev
);
226 return sprintf(buf
, "%s\n", idev
->info
->version
);
228 static DEVICE_ATTR_RO(version
);
230 static ssize_t
event_show(struct device
*dev
,
231 struct device_attribute
*attr
, char *buf
)
233 struct uio_device
*idev
= dev_get_drvdata(dev
);
234 return sprintf(buf
, "%u\n", (unsigned int)atomic_read(&idev
->event
));
236 static DEVICE_ATTR_RO(event
);
238 static struct attribute
*uio_attrs
[] = {
240 &dev_attr_version
.attr
,
241 &dev_attr_event
.attr
,
244 ATTRIBUTE_GROUPS(uio
);
246 /* UIO class infrastructure */
247 static struct class uio_class
= {
249 .dev_groups
= uio_groups
,
255 static int uio_dev_add_attributes(struct uio_device
*idev
)
260 int portio_found
= 0;
263 struct uio_port
*port
;
264 struct uio_portio
*portio
;
266 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
267 mem
= &idev
->info
->mem
[mi
];
272 idev
->map_dir
= kobject_create_and_add("maps",
274 if (!idev
->map_dir
) {
279 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
284 kobject_init(&map
->kobj
, &map_attr_type
);
287 ret
= kobject_add(&map
->kobj
, idev
->map_dir
, "map%d", mi
);
290 ret
= kobject_uevent(&map
->kobj
, KOBJ_ADD
);
295 for (pi
= 0; pi
< MAX_UIO_PORT_REGIONS
; pi
++) {
296 port
= &idev
->info
->port
[pi
];
301 idev
->portio_dir
= kobject_create_and_add("portio",
303 if (!idev
->portio_dir
) {
308 portio
= kzalloc(sizeof(*portio
), GFP_KERNEL
);
311 goto err_portio_kobj
;
313 kobject_init(&portio
->kobj
, &portio_attr_type
);
315 port
->portio
= portio
;
316 ret
= kobject_add(&portio
->kobj
, idev
->portio_dir
,
319 goto err_portio_kobj
;
320 ret
= kobject_uevent(&portio
->kobj
, KOBJ_ADD
);
330 for (; pi
>= 0; pi
--) {
331 port
= &idev
->info
->port
[pi
];
332 portio
= port
->portio
;
333 kobject_put(&portio
->kobj
);
335 kobject_put(idev
->portio_dir
);
339 for (; mi
>= 0; mi
--) {
340 mem
= &idev
->info
->mem
[mi
];
342 kobject_put(&map
->kobj
);
344 kobject_put(idev
->map_dir
);
345 dev_err(idev
->dev
, "error creating sysfs files (%d)\n", ret
);
349 static void uio_dev_del_attributes(struct uio_device
*idev
)
353 struct uio_port
*port
;
355 for (i
= 0; i
< MAX_UIO_MAPS
; i
++) {
356 mem
= &idev
->info
->mem
[i
];
359 kobject_put(&mem
->map
->kobj
);
361 kobject_put(idev
->map_dir
);
363 for (i
= 0; i
< MAX_UIO_PORT_REGIONS
; i
++) {
364 port
= &idev
->info
->port
[i
];
367 kobject_put(&port
->portio
->kobj
);
369 kobject_put(idev
->portio_dir
);
372 static int uio_get_minor(struct uio_device
*idev
)
374 int retval
= -ENOMEM
;
376 mutex_lock(&minor_lock
);
377 retval
= idr_alloc(&uio_idr
, idev
, 0, UIO_MAX_DEVICES
, GFP_KERNEL
);
379 idev
->minor
= retval
;
381 } else if (retval
== -ENOSPC
) {
382 dev_err(idev
->dev
, "too many uio devices\n");
385 mutex_unlock(&minor_lock
);
389 static void uio_free_minor(struct uio_device
*idev
)
391 mutex_lock(&minor_lock
);
392 idr_remove(&uio_idr
, idev
->minor
);
393 mutex_unlock(&minor_lock
);
397 * uio_event_notify - trigger an interrupt event
398 * @info: UIO device capabilities
400 void uio_event_notify(struct uio_info
*info
)
402 struct uio_device
*idev
= info
->uio_dev
;
404 atomic_inc(&idev
->event
);
405 wake_up_interruptible(&idev
->wait
);
406 kill_fasync(&idev
->async_queue
, SIGIO
, POLL_IN
);
408 EXPORT_SYMBOL_GPL(uio_event_notify
);
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
415 static irqreturn_t
uio_interrupt(int irq
, void *dev_id
)
417 struct uio_device
*idev
= (struct uio_device
*)dev_id
;
418 irqreturn_t ret
= idev
->info
->handler(irq
, idev
->info
);
420 if (ret
== IRQ_HANDLED
)
421 uio_event_notify(idev
->info
);
426 struct uio_listener
{
427 struct uio_device
*dev
;
431 static int uio_open(struct inode
*inode
, struct file
*filep
)
433 struct uio_device
*idev
;
434 struct uio_listener
*listener
;
437 mutex_lock(&minor_lock
);
438 idev
= idr_find(&uio_idr
, iminor(inode
));
439 mutex_unlock(&minor_lock
);
445 if (!try_module_get(idev
->owner
)) {
450 listener
= kmalloc(sizeof(*listener
), GFP_KERNEL
);
453 goto err_alloc_listener
;
456 listener
->dev
= idev
;
457 listener
->event_count
= atomic_read(&idev
->event
);
458 filep
->private_data
= listener
;
460 if (idev
->info
->open
) {
461 ret
= idev
->info
->open(idev
->info
, inode
);
471 module_put(idev
->owner
);
477 static int uio_fasync(int fd
, struct file
*filep
, int on
)
479 struct uio_listener
*listener
= filep
->private_data
;
480 struct uio_device
*idev
= listener
->dev
;
482 return fasync_helper(fd
, filep
, on
, &idev
->async_queue
);
485 static int uio_release(struct inode
*inode
, struct file
*filep
)
488 struct uio_listener
*listener
= filep
->private_data
;
489 struct uio_device
*idev
= listener
->dev
;
491 if (idev
->info
->release
)
492 ret
= idev
->info
->release(idev
->info
, inode
);
494 module_put(idev
->owner
);
499 static unsigned int uio_poll(struct file
*filep
, poll_table
*wait
)
501 struct uio_listener
*listener
= filep
->private_data
;
502 struct uio_device
*idev
= listener
->dev
;
504 if (!idev
->info
->irq
)
507 poll_wait(filep
, &idev
->wait
, wait
);
508 if (listener
->event_count
!= atomic_read(&idev
->event
))
509 return POLLIN
| POLLRDNORM
;
513 static ssize_t
uio_read(struct file
*filep
, char __user
*buf
,
514 size_t count
, loff_t
*ppos
)
516 struct uio_listener
*listener
= filep
->private_data
;
517 struct uio_device
*idev
= listener
->dev
;
518 DECLARE_WAITQUEUE(wait
, current
);
522 if (!idev
->info
->irq
)
525 if (count
!= sizeof(s32
))
528 add_wait_queue(&idev
->wait
, &wait
);
531 set_current_state(TASK_INTERRUPTIBLE
);
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
))
539 listener
->event_count
= event_count
;
545 if (filep
->f_flags
& O_NONBLOCK
) {
550 if (signal_pending(current
)) {
551 retval
= -ERESTARTSYS
;
557 __set_current_state(TASK_RUNNING
);
558 remove_wait_queue(&idev
->wait
, &wait
);
563 static ssize_t
uio_write(struct file
*filep
, const char __user
*buf
,
564 size_t count
, loff_t
*ppos
)
566 struct uio_listener
*listener
= filep
->private_data
;
567 struct uio_device
*idev
= listener
->dev
;
571 if (!idev
->info
->irq
)
574 if (count
!= sizeof(s32
))
577 if (!idev
->info
->irqcontrol
)
580 if (copy_from_user(&irq_on
, buf
, count
))
583 retval
= idev
->info
->irqcontrol(idev
->info
, irq_on
);
585 return retval
? retval
: sizeof(s32
);
588 static int uio_find_mem_index(struct vm_area_struct
*vma
)
590 struct uio_device
*idev
= vma
->vm_private_data
;
592 if (vma
->vm_pgoff
< MAX_UIO_MAPS
) {
593 if (idev
->info
->mem
[vma
->vm_pgoff
].size
== 0)
595 return (int)vma
->vm_pgoff
;
600 static int uio_vma_fault(struct vm_fault
*vmf
)
602 struct uio_device
*idev
= vmf
->vma
->vm_private_data
;
604 unsigned long offset
;
607 int mi
= uio_find_mem_index(vmf
->vma
);
609 return VM_FAULT_SIGBUS
;
612 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
615 offset
= (vmf
->pgoff
- mi
) << PAGE_SHIFT
;
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
);
621 page
= vmalloc_to_page(addr
);
627 static const struct vm_operations_struct uio_logical_vm_ops
= {
628 .fault
= uio_vma_fault
,
631 static int uio_mmap_logical(struct vm_area_struct
*vma
)
633 vma
->vm_flags
|= VM_DONTEXPAND
| VM_DONTDUMP
;
634 vma
->vm_ops
= &uio_logical_vm_ops
;
638 static const struct vm_operations_struct uio_physical_vm_ops
= {
639 #ifdef CONFIG_HAVE_IOREMAP_PROT
640 .access
= generic_access_phys
,
644 static int uio_mmap_physical(struct vm_area_struct
*vma
)
646 struct uio_device
*idev
= vma
->vm_private_data
;
647 int mi
= uio_find_mem_index(vma
);
651 mem
= idev
->info
->mem
+ mi
;
653 if (mem
->addr
& ~PAGE_MASK
)
655 if (vma
->vm_end
- vma
->vm_start
> mem
->size
)
658 vma
->vm_ops
= &uio_physical_vm_ops
;
659 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
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.
667 * So we just do the physical mmap without a page
670 return remap_pfn_range(vma
,
672 mem
->addr
>> PAGE_SHIFT
,
673 vma
->vm_end
- vma
->vm_start
,
677 static int uio_mmap(struct file
*filep
, struct vm_area_struct
*vma
)
679 struct uio_listener
*listener
= filep
->private_data
;
680 struct uio_device
*idev
= listener
->dev
;
682 unsigned long requested_pages
, actual_pages
;
685 if (vma
->vm_end
< vma
->vm_start
)
688 vma
->vm_private_data
= idev
;
690 mi
= uio_find_mem_index(vma
);
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
)
700 if (idev
->info
->mmap
) {
701 ret
= idev
->info
->mmap(idev
->info
, vma
);
705 switch (idev
->info
->mem
[mi
].memtype
) {
707 return uio_mmap_physical(vma
);
708 case UIO_MEM_LOGICAL
:
709 case UIO_MEM_VIRTUAL
:
710 return uio_mmap_logical(vma
);
716 static const struct file_operations uio_fops
= {
717 .owner
= THIS_MODULE
,
719 .release
= uio_release
,
724 .fasync
= uio_fasync
,
725 .llseek
= noop_llseek
,
728 static int uio_major_init(void)
730 static const char name
[] = "uio";
731 struct cdev
*cdev
= NULL
;
735 result
= alloc_chrdev_region(&uio_dev
, 0, UIO_MAX_DEVICES
, name
);
744 cdev
->owner
= THIS_MODULE
;
745 cdev
->ops
= &uio_fops
;
746 kobject_set_name(&cdev
->kobj
, "%s", name
);
748 result
= cdev_add(cdev
, uio_dev
, UIO_MAX_DEVICES
);
752 uio_major
= MAJOR(uio_dev
);
756 kobject_put(&cdev
->kobj
);
758 unregister_chrdev_region(uio_dev
, UIO_MAX_DEVICES
);
763 static void uio_major_cleanup(void)
765 unregister_chrdev_region(MKDEV(uio_major
, 0), UIO_MAX_DEVICES
);
769 static int init_uio_class(void)
773 /* This is the first time in here, set everything up properly */
774 ret
= uio_major_init();
778 ret
= class_register(&uio_class
);
780 printk(KERN_ERR
"class_register failed for uio\n");
781 goto err_class_register
;
791 static void release_uio_class(void)
793 class_unregister(&uio_class
);
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
803 * returns zero on success or a negative error code.
805 int __uio_register_device(struct module
*owner
,
806 struct device
*parent
,
807 struct uio_info
*info
)
809 struct uio_device
*idev
;
812 if (!parent
|| !info
|| !info
->name
|| !info
->version
)
815 info
->uio_dev
= NULL
;
817 idev
= devm_kzalloc(parent
, sizeof(*idev
), GFP_KERNEL
);
824 init_waitqueue_head(&idev
->wait
);
825 atomic_set(&idev
->event
, 0);
827 ret
= uio_get_minor(idev
);
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
;
840 ret
= uio_dev_add_attributes(idev
);
842 goto err_uio_dev_add_attributes
;
844 info
->uio_dev
= idev
;
846 if (info
->irq
&& (info
->irq
!= UIO_IRQ_CUSTOM
)) {
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.
855 ret
= request_irq(info
->irq
, uio_interrupt
,
856 info
->irq_flags
, info
->name
, idev
);
858 goto err_request_irq
;
864 uio_dev_del_attributes(idev
);
865 err_uio_dev_add_attributes
:
866 device_destroy(&uio_class
, MKDEV(uio_major
, idev
->minor
));
868 uio_free_minor(idev
);
871 EXPORT_SYMBOL_GPL(__uio_register_device
);
874 * uio_unregister_device - unregister a industrial IO device
875 * @info: UIO device capabilities
878 void uio_unregister_device(struct uio_info
*info
)
880 struct uio_device
*idev
;
882 if (!info
|| !info
->uio_dev
)
885 idev
= info
->uio_dev
;
887 uio_free_minor(idev
);
889 uio_dev_del_attributes(idev
);
891 if (info
->irq
&& info
->irq
!= UIO_IRQ_CUSTOM
)
892 free_irq(info
->irq
, idev
);
894 device_destroy(&uio_class
, MKDEV(uio_major
, idev
->minor
));
898 EXPORT_SYMBOL_GPL(uio_unregister_device
);
900 static int __init
uio_init(void)
902 return init_uio_class();
905 static void __exit
uio_exit(void)
908 idr_destroy(&uio_idr
);
911 module_init(uio_init
)
912 module_exit(uio_exit
)
913 MODULE_LICENSE("GPL v2");