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.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)
36 struct fasync_struct
*async_queue
;
37 wait_queue_head_t wait
;
38 struct uio_info
*info
;
39 struct kobject
*map_dir
;
40 struct kobject
*portio_dir
;
44 static struct cdev
*uio_cdev
;
45 static DEFINE_IDR(uio_idr
);
46 static const struct file_operations uio_fops
;
48 /* Protect idr accesses */
49 static DEFINE_MUTEX(minor_lock
);
59 #define to_map(map) container_of(map, struct uio_map, kobj)
61 static ssize_t
map_name_show(struct uio_mem
*mem
, char *buf
)
63 if (unlikely(!mem
->name
))
66 return sprintf(buf
, "%s\n", mem
->name
);
69 static ssize_t
map_addr_show(struct uio_mem
*mem
, char *buf
)
71 return sprintf(buf
, "0x%llx\n", (unsigned long long)mem
->addr
);
74 static ssize_t
map_size_show(struct uio_mem
*mem
, char *buf
)
76 return sprintf(buf
, "0x%lx\n", mem
->size
);
79 static ssize_t
map_offset_show(struct uio_mem
*mem
, char *buf
)
81 return sprintf(buf
, "0x%llx\n", (unsigned long long)mem
->addr
& ~PAGE_MASK
);
84 struct map_sysfs_entry
{
85 struct attribute attr
;
86 ssize_t (*show
)(struct uio_mem
*, char *);
87 ssize_t (*store
)(struct uio_mem
*, const char *, size_t);
90 static struct map_sysfs_entry name_attribute
=
91 __ATTR(name
, S_IRUGO
, map_name_show
, NULL
);
92 static struct map_sysfs_entry addr_attribute
=
93 __ATTR(addr
, S_IRUGO
, map_addr_show
, NULL
);
94 static struct map_sysfs_entry size_attribute
=
95 __ATTR(size
, S_IRUGO
, map_size_show
, NULL
);
96 static struct map_sysfs_entry offset_attribute
=
97 __ATTR(offset
, S_IRUGO
, map_offset_show
, NULL
);
99 static struct attribute
*attrs
[] = {
100 &name_attribute
.attr
,
101 &addr_attribute
.attr
,
102 &size_attribute
.attr
,
103 &offset_attribute
.attr
,
104 NULL
, /* need to NULL terminate the list of attributes */
107 static void map_release(struct kobject
*kobj
)
109 struct uio_map
*map
= to_map(kobj
);
113 static ssize_t
map_type_show(struct kobject
*kobj
, struct attribute
*attr
,
116 struct uio_map
*map
= to_map(kobj
);
117 struct uio_mem
*mem
= map
->mem
;
118 struct map_sysfs_entry
*entry
;
120 entry
= container_of(attr
, struct map_sysfs_entry
, attr
);
125 return entry
->show(mem
, buf
);
128 static const struct sysfs_ops map_sysfs_ops
= {
129 .show
= map_type_show
,
132 static struct kobj_type map_attr_type
= {
133 .release
= map_release
,
134 .sysfs_ops
= &map_sysfs_ops
,
135 .default_attrs
= attrs
,
140 struct uio_port
*port
;
142 #define to_portio(portio) container_of(portio, struct uio_portio, kobj)
144 static ssize_t
portio_name_show(struct uio_port
*port
, char *buf
)
146 if (unlikely(!port
->name
))
149 return sprintf(buf
, "%s\n", port
->name
);
152 static ssize_t
portio_start_show(struct uio_port
*port
, char *buf
)
154 return sprintf(buf
, "0x%lx\n", port
->start
);
157 static ssize_t
portio_size_show(struct uio_port
*port
, char *buf
)
159 return sprintf(buf
, "0x%lx\n", port
->size
);
162 static ssize_t
portio_porttype_show(struct uio_port
*port
, char *buf
)
164 const char *porttypes
[] = {"none", "x86", "gpio", "other"};
166 if ((port
->porttype
< 0) || (port
->porttype
> UIO_PORT_OTHER
))
169 return sprintf(buf
, "port_%s\n", porttypes
[port
->porttype
]);
172 struct portio_sysfs_entry
{
173 struct attribute attr
;
174 ssize_t (*show
)(struct uio_port
*, char *);
175 ssize_t (*store
)(struct uio_port
*, const char *, size_t);
178 static struct portio_sysfs_entry portio_name_attribute
=
179 __ATTR(name
, S_IRUGO
, portio_name_show
, NULL
);
180 static struct portio_sysfs_entry portio_start_attribute
=
181 __ATTR(start
, S_IRUGO
, portio_start_show
, NULL
);
182 static struct portio_sysfs_entry portio_size_attribute
=
183 __ATTR(size
, S_IRUGO
, portio_size_show
, NULL
);
184 static struct portio_sysfs_entry portio_porttype_attribute
=
185 __ATTR(porttype
, S_IRUGO
, portio_porttype_show
, NULL
);
187 static struct attribute
*portio_attrs
[] = {
188 &portio_name_attribute
.attr
,
189 &portio_start_attribute
.attr
,
190 &portio_size_attribute
.attr
,
191 &portio_porttype_attribute
.attr
,
195 static void portio_release(struct kobject
*kobj
)
197 struct uio_portio
*portio
= to_portio(kobj
);
201 static ssize_t
portio_type_show(struct kobject
*kobj
, struct attribute
*attr
,
204 struct uio_portio
*portio
= to_portio(kobj
);
205 struct uio_port
*port
= portio
->port
;
206 struct portio_sysfs_entry
*entry
;
208 entry
= container_of(attr
, struct portio_sysfs_entry
, attr
);
213 return entry
->show(port
, buf
);
216 static const struct sysfs_ops portio_sysfs_ops
= {
217 .show
= portio_type_show
,
220 static struct kobj_type portio_attr_type
= {
221 .release
= portio_release
,
222 .sysfs_ops
= &portio_sysfs_ops
,
223 .default_attrs
= portio_attrs
,
226 static ssize_t
show_name(struct device
*dev
,
227 struct device_attribute
*attr
, char *buf
)
229 struct uio_device
*idev
= dev_get_drvdata(dev
);
230 return sprintf(buf
, "%s\n", idev
->info
->name
);
233 static ssize_t
show_version(struct device
*dev
,
234 struct device_attribute
*attr
, char *buf
)
236 struct uio_device
*idev
= dev_get_drvdata(dev
);
237 return sprintf(buf
, "%s\n", idev
->info
->version
);
240 static ssize_t
show_event(struct device
*dev
,
241 struct device_attribute
*attr
, char *buf
)
243 struct uio_device
*idev
= dev_get_drvdata(dev
);
244 return sprintf(buf
, "%u\n", (unsigned int)atomic_read(&idev
->event
));
247 static struct device_attribute uio_class_attributes
[] = {
248 __ATTR(name
, S_IRUGO
, show_name
, NULL
),
249 __ATTR(version
, S_IRUGO
, show_version
, NULL
),
250 __ATTR(event
, S_IRUGO
, show_event
, NULL
),
254 /* UIO class infrastructure */
255 static struct class uio_class
= {
257 .dev_attrs
= uio_class_attributes
,
263 static int uio_dev_add_attributes(struct uio_device
*idev
)
268 int portio_found
= 0;
271 struct uio_port
*port
;
272 struct uio_portio
*portio
;
274 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
275 mem
= &idev
->info
->mem
[mi
];
280 idev
->map_dir
= kobject_create_and_add("maps",
285 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
288 kobject_init(&map
->kobj
, &map_attr_type
);
291 ret
= kobject_add(&map
->kobj
, idev
->map_dir
, "map%d", mi
);
294 ret
= kobject_uevent(&map
->kobj
, KOBJ_ADD
);
299 for (pi
= 0; pi
< MAX_UIO_PORT_REGIONS
; pi
++) {
300 port
= &idev
->info
->port
[pi
];
305 idev
->portio_dir
= kobject_create_and_add("portio",
307 if (!idev
->portio_dir
)
310 portio
= kzalloc(sizeof(*portio
), GFP_KERNEL
);
313 kobject_init(&portio
->kobj
, &portio_attr_type
);
315 port
->portio
= portio
;
316 ret
= kobject_add(&portio
->kobj
, idev
->portio_dir
,
320 ret
= kobject_uevent(&portio
->kobj
, KOBJ_ADD
);
328 for (pi
--; pi
>= 0; pi
--) {
329 port
= &idev
->info
->port
[pi
];
330 portio
= port
->portio
;
331 kobject_put(&portio
->kobj
);
333 kobject_put(idev
->portio_dir
);
335 for (mi
--; mi
>=0; mi
--) {
336 mem
= &idev
->info
->mem
[mi
];
338 kobject_put(&map
->kobj
);
340 kobject_put(idev
->map_dir
);
341 dev_err(idev
->dev
, "error creating sysfs files (%d)\n", ret
);
345 static void uio_dev_del_attributes(struct uio_device
*idev
)
349 struct uio_port
*port
;
351 for (i
= 0; i
< MAX_UIO_MAPS
; i
++) {
352 mem
= &idev
->info
->mem
[i
];
355 kobject_put(&mem
->map
->kobj
);
357 kobject_put(idev
->map_dir
);
359 for (i
= 0; i
< MAX_UIO_PORT_REGIONS
; i
++) {
360 port
= &idev
->info
->port
[i
];
363 kobject_put(&port
->portio
->kobj
);
365 kobject_put(idev
->portio_dir
);
368 static int uio_get_minor(struct uio_device
*idev
)
370 int retval
= -ENOMEM
;
372 mutex_lock(&minor_lock
);
373 retval
= idr_alloc(&uio_idr
, idev
, 0, UIO_MAX_DEVICES
, GFP_KERNEL
);
375 idev
->minor
= retval
;
377 } else if (retval
== -ENOSPC
) {
378 dev_err(idev
->dev
, "too many uio devices\n");
381 mutex_unlock(&minor_lock
);
385 static void uio_free_minor(struct uio_device
*idev
)
387 mutex_lock(&minor_lock
);
388 idr_remove(&uio_idr
, idev
->minor
);
389 mutex_unlock(&minor_lock
);
393 * uio_event_notify - trigger an interrupt event
394 * @info: UIO device capabilities
396 void uio_event_notify(struct uio_info
*info
)
398 struct uio_device
*idev
= info
->uio_dev
;
400 atomic_inc(&idev
->event
);
401 wake_up_interruptible(&idev
->wait
);
402 kill_fasync(&idev
->async_queue
, SIGIO
, POLL_IN
);
404 EXPORT_SYMBOL_GPL(uio_event_notify
);
407 * uio_interrupt - hardware interrupt handler
408 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
409 * @dev_id: Pointer to the devices uio_device structure
411 static irqreturn_t
uio_interrupt(int irq
, void *dev_id
)
413 struct uio_device
*idev
= (struct uio_device
*)dev_id
;
414 irqreturn_t ret
= idev
->info
->handler(irq
, idev
->info
);
416 if (ret
== IRQ_HANDLED
)
417 uio_event_notify(idev
->info
);
422 struct uio_listener
{
423 struct uio_device
*dev
;
427 static int uio_open(struct inode
*inode
, struct file
*filep
)
429 struct uio_device
*idev
;
430 struct uio_listener
*listener
;
433 mutex_lock(&minor_lock
);
434 idev
= idr_find(&uio_idr
, iminor(inode
));
435 mutex_unlock(&minor_lock
);
441 if (!try_module_get(idev
->owner
)) {
446 listener
= kmalloc(sizeof(*listener
), GFP_KERNEL
);
449 goto err_alloc_listener
;
452 listener
->dev
= idev
;
453 listener
->event_count
= atomic_read(&idev
->event
);
454 filep
->private_data
= listener
;
456 if (idev
->info
->open
) {
457 ret
= idev
->info
->open(idev
->info
, inode
);
467 module_put(idev
->owner
);
473 static int uio_fasync(int fd
, struct file
*filep
, int on
)
475 struct uio_listener
*listener
= filep
->private_data
;
476 struct uio_device
*idev
= listener
->dev
;
478 return fasync_helper(fd
, filep
, on
, &idev
->async_queue
);
481 static int uio_release(struct inode
*inode
, struct file
*filep
)
484 struct uio_listener
*listener
= filep
->private_data
;
485 struct uio_device
*idev
= listener
->dev
;
487 if (idev
->info
->release
)
488 ret
= idev
->info
->release(idev
->info
, inode
);
490 module_put(idev
->owner
);
495 static unsigned int uio_poll(struct file
*filep
, poll_table
*wait
)
497 struct uio_listener
*listener
= filep
->private_data
;
498 struct uio_device
*idev
= listener
->dev
;
500 if (!idev
->info
->irq
)
503 poll_wait(filep
, &idev
->wait
, wait
);
504 if (listener
->event_count
!= atomic_read(&idev
->event
))
505 return POLLIN
| POLLRDNORM
;
509 static ssize_t
uio_read(struct file
*filep
, char __user
*buf
,
510 size_t count
, loff_t
*ppos
)
512 struct uio_listener
*listener
= filep
->private_data
;
513 struct uio_device
*idev
= listener
->dev
;
514 DECLARE_WAITQUEUE(wait
, current
);
518 if (!idev
->info
->irq
)
521 if (count
!= sizeof(s32
))
524 add_wait_queue(&idev
->wait
, &wait
);
527 set_current_state(TASK_INTERRUPTIBLE
);
529 event_count
= atomic_read(&idev
->event
);
530 if (event_count
!= listener
->event_count
) {
531 if (copy_to_user(buf
, &event_count
, count
))
534 listener
->event_count
= event_count
;
540 if (filep
->f_flags
& O_NONBLOCK
) {
545 if (signal_pending(current
)) {
546 retval
= -ERESTARTSYS
;
552 __set_current_state(TASK_RUNNING
);
553 remove_wait_queue(&idev
->wait
, &wait
);
558 static ssize_t
uio_write(struct file
*filep
, const char __user
*buf
,
559 size_t count
, loff_t
*ppos
)
561 struct uio_listener
*listener
= filep
->private_data
;
562 struct uio_device
*idev
= listener
->dev
;
566 if (!idev
->info
->irq
)
569 if (count
!= sizeof(s32
))
572 if (!idev
->info
->irqcontrol
)
575 if (copy_from_user(&irq_on
, buf
, count
))
578 retval
= idev
->info
->irqcontrol(idev
->info
, irq_on
);
580 return retval
? retval
: sizeof(s32
);
583 static int uio_find_mem_index(struct vm_area_struct
*vma
)
585 struct uio_device
*idev
= vma
->vm_private_data
;
587 if (vma
->vm_pgoff
< MAX_UIO_MAPS
) {
588 if (idev
->info
->mem
[vma
->vm_pgoff
].size
== 0)
590 return (int)vma
->vm_pgoff
;
595 static int uio_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
597 struct uio_device
*idev
= vma
->vm_private_data
;
599 unsigned long offset
;
601 int mi
= uio_find_mem_index(vma
);
603 return VM_FAULT_SIGBUS
;
606 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
609 offset
= (vmf
->pgoff
- mi
) << PAGE_SHIFT
;
611 if (idev
->info
->mem
[mi
].memtype
== UIO_MEM_LOGICAL
)
612 page
= virt_to_page(idev
->info
->mem
[mi
].addr
+ offset
);
614 page
= vmalloc_to_page((void *)(unsigned long)idev
->info
->mem
[mi
].addr
+ offset
);
620 static const struct vm_operations_struct uio_logical_vm_ops
= {
621 .fault
= uio_vma_fault
,
624 static int uio_mmap_logical(struct vm_area_struct
*vma
)
626 vma
->vm_flags
|= VM_DONTEXPAND
| VM_DONTDUMP
;
627 vma
->vm_ops
= &uio_logical_vm_ops
;
631 static const struct vm_operations_struct uio_physical_vm_ops
= {
632 #ifdef CONFIG_HAVE_IOREMAP_PROT
633 .access
= generic_access_phys
,
637 static int uio_mmap_physical(struct vm_area_struct
*vma
)
639 struct uio_device
*idev
= vma
->vm_private_data
;
640 int mi
= uio_find_mem_index(vma
);
644 vma
->vm_ops
= &uio_physical_vm_ops
;
646 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
648 return remap_pfn_range(vma
,
650 idev
->info
->mem
[mi
].addr
>> PAGE_SHIFT
,
651 vma
->vm_end
- vma
->vm_start
,
655 static int uio_mmap(struct file
*filep
, struct vm_area_struct
*vma
)
657 struct uio_listener
*listener
= filep
->private_data
;
658 struct uio_device
*idev
= listener
->dev
;
660 unsigned long requested_pages
, actual_pages
;
663 if (vma
->vm_end
< vma
->vm_start
)
666 vma
->vm_private_data
= idev
;
668 mi
= uio_find_mem_index(vma
);
672 requested_pages
= vma_pages(vma
);
673 actual_pages
= ((idev
->info
->mem
[mi
].addr
& ~PAGE_MASK
)
674 + idev
->info
->mem
[mi
].size
+ PAGE_SIZE
-1) >> PAGE_SHIFT
;
675 if (requested_pages
> actual_pages
)
678 if (idev
->info
->mmap
) {
679 ret
= idev
->info
->mmap(idev
->info
, vma
);
683 switch (idev
->info
->mem
[mi
].memtype
) {
685 return uio_mmap_physical(vma
);
686 case UIO_MEM_LOGICAL
:
687 case UIO_MEM_VIRTUAL
:
688 return uio_mmap_logical(vma
);
694 static const struct file_operations uio_fops
= {
695 .owner
= THIS_MODULE
,
697 .release
= uio_release
,
702 .fasync
= uio_fasync
,
703 .llseek
= noop_llseek
,
706 static int uio_major_init(void)
708 static const char name
[] = "uio";
709 struct cdev
*cdev
= NULL
;
713 result
= alloc_chrdev_region(&uio_dev
, 0, UIO_MAX_DEVICES
, name
);
722 cdev
->owner
= THIS_MODULE
;
723 cdev
->ops
= &uio_fops
;
724 kobject_set_name(&cdev
->kobj
, "%s", name
);
726 result
= cdev_add(cdev
, uio_dev
, UIO_MAX_DEVICES
);
730 uio_major
= MAJOR(uio_dev
);
734 kobject_put(&cdev
->kobj
);
736 unregister_chrdev_region(uio_dev
, UIO_MAX_DEVICES
);
741 static void uio_major_cleanup(void)
743 unregister_chrdev_region(MKDEV(uio_major
, 0), UIO_MAX_DEVICES
);
747 static int init_uio_class(void)
751 /* This is the first time in here, set everything up properly */
752 ret
= uio_major_init();
756 ret
= class_register(&uio_class
);
758 printk(KERN_ERR
"class_register failed for uio\n");
759 goto err_class_register
;
769 static void release_uio_class(void)
771 class_unregister(&uio_class
);
776 * uio_register_device - register a new userspace IO device
777 * @owner: module that creates the new device
778 * @parent: parent device
779 * @info: UIO device capabilities
781 * returns zero on success or a negative error code.
783 int __uio_register_device(struct module
*owner
,
784 struct device
*parent
,
785 struct uio_info
*info
)
787 struct uio_device
*idev
;
790 if (!parent
|| !info
|| !info
->name
|| !info
->version
)
793 info
->uio_dev
= NULL
;
795 idev
= kzalloc(sizeof(*idev
), GFP_KERNEL
);
803 init_waitqueue_head(&idev
->wait
);
804 atomic_set(&idev
->event
, 0);
806 ret
= uio_get_minor(idev
);
810 idev
->dev
= device_create(&uio_class
, parent
,
811 MKDEV(uio_major
, idev
->minor
), idev
,
812 "uio%d", idev
->minor
);
813 if (IS_ERR(idev
->dev
)) {
814 printk(KERN_ERR
"UIO: device register failed\n");
815 ret
= PTR_ERR(idev
->dev
);
816 goto err_device_create
;
819 ret
= uio_dev_add_attributes(idev
);
821 goto err_uio_dev_add_attributes
;
823 info
->uio_dev
= idev
;
825 if (info
->irq
&& (info
->irq
!= UIO_IRQ_CUSTOM
)) {
826 ret
= request_irq(info
->irq
, uio_interrupt
,
827 info
->irq_flags
, info
->name
, idev
);
829 goto err_request_irq
;
835 uio_dev_del_attributes(idev
);
836 err_uio_dev_add_attributes
:
837 device_destroy(&uio_class
, MKDEV(uio_major
, idev
->minor
));
839 uio_free_minor(idev
);
845 EXPORT_SYMBOL_GPL(__uio_register_device
);
848 * uio_unregister_device - unregister a industrial IO device
849 * @info: UIO device capabilities
852 void uio_unregister_device(struct uio_info
*info
)
854 struct uio_device
*idev
;
856 if (!info
|| !info
->uio_dev
)
859 idev
= info
->uio_dev
;
861 uio_free_minor(idev
);
863 if (info
->irq
&& (info
->irq
!= UIO_IRQ_CUSTOM
))
864 free_irq(info
->irq
, idev
);
866 uio_dev_del_attributes(idev
);
868 device_destroy(&uio_class
, MKDEV(uio_major
, idev
->minor
));
873 EXPORT_SYMBOL_GPL(uio_unregister_device
);
875 static int __init
uio_init(void)
877 return init_uio_class();
880 static void __exit
uio_exit(void)
885 module_init(uio_init
)
886 module_exit(uio_exit
)
887 MODULE_LICENSE("GPL v2");