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@linutronix.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/uio_driver.h>
28 #define UIO_MAX_DEVICES 255
35 struct fasync_struct
*async_queue
;
36 wait_queue_head_t wait
;
38 struct uio_info
*info
;
39 struct kobject
*map_dir
;
40 struct kobject
*portio_dir
;
44 static DEFINE_IDR(uio_idr
);
45 static const struct file_operations uio_fops
;
47 /* UIO class infrastructure */
48 static struct class *uio_class
;
50 /* Protect idr accesses */
51 static DEFINE_MUTEX(minor_lock
);
61 #define to_map(map) container_of(map, struct uio_map, kobj)
63 static ssize_t
map_name_show(struct uio_mem
*mem
, char *buf
)
65 if (unlikely(!mem
->name
))
68 return sprintf(buf
, "%s\n", mem
->name
);
71 static ssize_t
map_addr_show(struct uio_mem
*mem
, char *buf
)
73 return sprintf(buf
, "0x%lx\n", mem
->addr
);
76 static ssize_t
map_size_show(struct uio_mem
*mem
, char *buf
)
78 return sprintf(buf
, "0x%lx\n", mem
->size
);
81 static ssize_t
map_offset_show(struct uio_mem
*mem
, char *buf
)
83 return sprintf(buf
, "0x%lx\n", mem
->addr
& ~PAGE_MASK
);
86 struct map_sysfs_entry
{
87 struct attribute attr
;
88 ssize_t (*show
)(struct uio_mem
*, char *);
89 ssize_t (*store
)(struct uio_mem
*, const char *, size_t);
92 static struct map_sysfs_entry name_attribute
=
93 __ATTR(name
, S_IRUGO
, map_name_show
, NULL
);
94 static struct map_sysfs_entry addr_attribute
=
95 __ATTR(addr
, S_IRUGO
, map_addr_show
, NULL
);
96 static struct map_sysfs_entry size_attribute
=
97 __ATTR(size
, S_IRUGO
, map_size_show
, NULL
);
98 static struct map_sysfs_entry offset_attribute
=
99 __ATTR(offset
, S_IRUGO
, map_offset_show
, NULL
);
101 static struct attribute
*attrs
[] = {
102 &name_attribute
.attr
,
103 &addr_attribute
.attr
,
104 &size_attribute
.attr
,
105 &offset_attribute
.attr
,
106 NULL
, /* need to NULL terminate the list of attributes */
109 static void map_release(struct kobject
*kobj
)
111 struct uio_map
*map
= to_map(kobj
);
115 static ssize_t
map_type_show(struct kobject
*kobj
, struct attribute
*attr
,
118 struct uio_map
*map
= to_map(kobj
);
119 struct uio_mem
*mem
= map
->mem
;
120 struct map_sysfs_entry
*entry
;
122 entry
= container_of(attr
, struct map_sysfs_entry
, attr
);
127 return entry
->show(mem
, buf
);
130 static const struct sysfs_ops map_sysfs_ops
= {
131 .show
= map_type_show
,
134 static struct kobj_type map_attr_type
= {
135 .release
= map_release
,
136 .sysfs_ops
= &map_sysfs_ops
,
137 .default_attrs
= attrs
,
142 struct uio_port
*port
;
144 #define to_portio(portio) container_of(portio, struct uio_portio, kobj)
146 static ssize_t
portio_name_show(struct uio_port
*port
, char *buf
)
148 if (unlikely(!port
->name
))
151 return sprintf(buf
, "%s\n", port
->name
);
154 static ssize_t
portio_start_show(struct uio_port
*port
, char *buf
)
156 return sprintf(buf
, "0x%lx\n", port
->start
);
159 static ssize_t
portio_size_show(struct uio_port
*port
, char *buf
)
161 return sprintf(buf
, "0x%lx\n", port
->size
);
164 static ssize_t
portio_porttype_show(struct uio_port
*port
, char *buf
)
166 const char *porttypes
[] = {"none", "x86", "gpio", "other"};
168 if ((port
->porttype
< 0) || (port
->porttype
> UIO_PORT_OTHER
))
171 return sprintf(buf
, "port_%s\n", porttypes
[port
->porttype
]);
174 struct portio_sysfs_entry
{
175 struct attribute attr
;
176 ssize_t (*show
)(struct uio_port
*, char *);
177 ssize_t (*store
)(struct uio_port
*, const char *, size_t);
180 static struct portio_sysfs_entry portio_name_attribute
=
181 __ATTR(name
, S_IRUGO
, portio_name_show
, NULL
);
182 static struct portio_sysfs_entry portio_start_attribute
=
183 __ATTR(start
, S_IRUGO
, portio_start_show
, NULL
);
184 static struct portio_sysfs_entry portio_size_attribute
=
185 __ATTR(size
, S_IRUGO
, portio_size_show
, NULL
);
186 static struct portio_sysfs_entry portio_porttype_attribute
=
187 __ATTR(porttype
, S_IRUGO
, portio_porttype_show
, NULL
);
189 static struct attribute
*portio_attrs
[] = {
190 &portio_name_attribute
.attr
,
191 &portio_start_attribute
.attr
,
192 &portio_size_attribute
.attr
,
193 &portio_porttype_attribute
.attr
,
197 static void portio_release(struct kobject
*kobj
)
199 struct uio_portio
*portio
= to_portio(kobj
);
203 static ssize_t
portio_type_show(struct kobject
*kobj
, struct attribute
*attr
,
206 struct uio_portio
*portio
= to_portio(kobj
);
207 struct uio_port
*port
= portio
->port
;
208 struct portio_sysfs_entry
*entry
;
210 entry
= container_of(attr
, struct portio_sysfs_entry
, attr
);
215 return entry
->show(port
, buf
);
218 static const struct sysfs_ops portio_sysfs_ops
= {
219 .show
= portio_type_show
,
222 static struct kobj_type portio_attr_type
= {
223 .release
= portio_release
,
224 .sysfs_ops
= &portio_sysfs_ops
,
225 .default_attrs
= portio_attrs
,
228 static ssize_t
show_name(struct device
*dev
,
229 struct device_attribute
*attr
, char *buf
)
231 struct uio_device
*idev
= dev_get_drvdata(dev
);
232 return sprintf(buf
, "%s\n", idev
->info
->name
);
234 static DEVICE_ATTR(name
, S_IRUGO
, show_name
, NULL
);
236 static ssize_t
show_version(struct device
*dev
,
237 struct device_attribute
*attr
, char *buf
)
239 struct uio_device
*idev
= dev_get_drvdata(dev
);
240 return sprintf(buf
, "%s\n", idev
->info
->version
);
242 static DEVICE_ATTR(version
, S_IRUGO
, show_version
, NULL
);
244 static ssize_t
show_event(struct device
*dev
,
245 struct device_attribute
*attr
, char *buf
)
247 struct uio_device
*idev
= dev_get_drvdata(dev
);
248 return sprintf(buf
, "%u\n", (unsigned int)atomic_read(&idev
->event
));
250 static DEVICE_ATTR(event
, S_IRUGO
, show_event
, NULL
);
252 static struct attribute
*uio_attrs
[] = {
254 &dev_attr_version
.attr
,
255 &dev_attr_event
.attr
,
259 static struct attribute_group uio_attr_grp
= {
266 static int uio_dev_add_attributes(struct uio_device
*idev
)
271 int portio_found
= 0;
274 struct uio_port
*port
;
275 struct uio_portio
*portio
;
277 ret
= sysfs_create_group(&idev
->dev
->kobj
, &uio_attr_grp
);
281 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
282 mem
= &idev
->info
->mem
[mi
];
287 idev
->map_dir
= kobject_create_and_add("maps",
292 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
295 kobject_init(&map
->kobj
, &map_attr_type
);
298 ret
= kobject_add(&map
->kobj
, idev
->map_dir
, "map%d", mi
);
301 ret
= kobject_uevent(&map
->kobj
, KOBJ_ADD
);
306 for (pi
= 0; pi
< MAX_UIO_PORT_REGIONS
; pi
++) {
307 port
= &idev
->info
->port
[pi
];
312 idev
->portio_dir
= kobject_create_and_add("portio",
314 if (!idev
->portio_dir
)
317 portio
= kzalloc(sizeof(*portio
), GFP_KERNEL
);
320 kobject_init(&portio
->kobj
, &portio_attr_type
);
322 port
->portio
= portio
;
323 ret
= kobject_add(&portio
->kobj
, idev
->portio_dir
,
327 ret
= kobject_uevent(&portio
->kobj
, KOBJ_ADD
);
335 for (pi
--; pi
>= 0; pi
--) {
336 port
= &idev
->info
->port
[pi
];
337 portio
= port
->portio
;
338 kobject_put(&portio
->kobj
);
340 kobject_put(idev
->portio_dir
);
342 for (mi
--; mi
>=0; mi
--) {
343 mem
= &idev
->info
->mem
[mi
];
345 kobject_put(&map
->kobj
);
347 kobject_put(idev
->map_dir
);
348 sysfs_remove_group(&idev
->dev
->kobj
, &uio_attr_grp
);
350 dev_err(idev
->dev
, "error creating sysfs files (%d)\n", ret
);
354 static void uio_dev_del_attributes(struct uio_device
*idev
)
358 struct uio_port
*port
;
360 for (i
= 0; i
< MAX_UIO_MAPS
; i
++) {
361 mem
= &idev
->info
->mem
[i
];
364 kobject_put(&mem
->map
->kobj
);
366 kobject_put(idev
->map_dir
);
368 for (i
= 0; i
< MAX_UIO_PORT_REGIONS
; i
++) {
369 port
= &idev
->info
->port
[i
];
372 kobject_put(&port
->portio
->kobj
);
374 kobject_put(idev
->portio_dir
);
376 sysfs_remove_group(&idev
->dev
->kobj
, &uio_attr_grp
);
379 static int uio_get_minor(struct uio_device
*idev
)
381 int retval
= -ENOMEM
;
384 mutex_lock(&minor_lock
);
385 if (idr_pre_get(&uio_idr
, GFP_KERNEL
) == 0)
388 retval
= idr_get_new(&uio_idr
, idev
, &id
);
390 if (retval
== -EAGAIN
)
394 idev
->minor
= id
& MAX_ID_MASK
;
396 mutex_unlock(&minor_lock
);
400 static void uio_free_minor(struct uio_device
*idev
)
402 mutex_lock(&minor_lock
);
403 idr_remove(&uio_idr
, idev
->minor
);
404 mutex_unlock(&minor_lock
);
408 * uio_event_notify - trigger an interrupt event
409 * @info: UIO device capabilities
411 void uio_event_notify(struct uio_info
*info
)
413 struct uio_device
*idev
= info
->uio_dev
;
415 atomic_inc(&idev
->event
);
416 wake_up_interruptible(&idev
->wait
);
417 kill_fasync(&idev
->async_queue
, SIGIO
, POLL_IN
);
419 EXPORT_SYMBOL_GPL(uio_event_notify
);
422 * uio_interrupt - hardware interrupt handler
423 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
424 * @dev_id: Pointer to the devices uio_device structure
426 static irqreturn_t
uio_interrupt(int irq
, void *dev_id
)
428 struct uio_device
*idev
= (struct uio_device
*)dev_id
;
429 irqreturn_t ret
= idev
->info
->handler(irq
, idev
->info
);
431 if (ret
== IRQ_HANDLED
)
432 uio_event_notify(idev
->info
);
437 struct uio_listener
{
438 struct uio_device
*dev
;
442 static int uio_open(struct inode
*inode
, struct file
*filep
)
444 struct uio_device
*idev
;
445 struct uio_listener
*listener
;
448 mutex_lock(&minor_lock
);
449 idev
= idr_find(&uio_idr
, iminor(inode
));
450 mutex_unlock(&minor_lock
);
456 if (!try_module_get(idev
->owner
)) {
461 listener
= kmalloc(sizeof(*listener
), GFP_KERNEL
);
464 goto err_alloc_listener
;
467 listener
->dev
= idev
;
468 listener
->event_count
= atomic_read(&idev
->event
);
469 filep
->private_data
= listener
;
471 if (idev
->info
->open
) {
472 ret
= idev
->info
->open(idev
->info
, inode
);
482 module_put(idev
->owner
);
488 static int uio_fasync(int fd
, struct file
*filep
, int on
)
490 struct uio_listener
*listener
= filep
->private_data
;
491 struct uio_device
*idev
= listener
->dev
;
493 return fasync_helper(fd
, filep
, on
, &idev
->async_queue
);
496 static int uio_release(struct inode
*inode
, struct file
*filep
)
499 struct uio_listener
*listener
= filep
->private_data
;
500 struct uio_device
*idev
= listener
->dev
;
502 if (idev
->info
->release
)
503 ret
= idev
->info
->release(idev
->info
, inode
);
505 module_put(idev
->owner
);
510 static unsigned int uio_poll(struct file
*filep
, poll_table
*wait
)
512 struct uio_listener
*listener
= filep
->private_data
;
513 struct uio_device
*idev
= listener
->dev
;
515 if (!idev
->info
->irq
)
518 poll_wait(filep
, &idev
->wait
, wait
);
519 if (listener
->event_count
!= atomic_read(&idev
->event
))
520 return POLLIN
| POLLRDNORM
;
524 static ssize_t
uio_read(struct file
*filep
, char __user
*buf
,
525 size_t count
, loff_t
*ppos
)
527 struct uio_listener
*listener
= filep
->private_data
;
528 struct uio_device
*idev
= listener
->dev
;
529 DECLARE_WAITQUEUE(wait
, current
);
533 if (!idev
->info
->irq
)
536 if (count
!= sizeof(s32
))
539 add_wait_queue(&idev
->wait
, &wait
);
542 set_current_state(TASK_INTERRUPTIBLE
);
544 event_count
= atomic_read(&idev
->event
);
545 if (event_count
!= listener
->event_count
) {
546 if (copy_to_user(buf
, &event_count
, count
))
549 listener
->event_count
= event_count
;
555 if (filep
->f_flags
& O_NONBLOCK
) {
560 if (signal_pending(current
)) {
561 retval
= -ERESTARTSYS
;
567 __set_current_state(TASK_RUNNING
);
568 remove_wait_queue(&idev
->wait
, &wait
);
573 static ssize_t
uio_write(struct file
*filep
, const char __user
*buf
,
574 size_t count
, loff_t
*ppos
)
576 struct uio_listener
*listener
= filep
->private_data
;
577 struct uio_device
*idev
= listener
->dev
;
581 if (!idev
->info
->irq
)
584 if (count
!= sizeof(s32
))
587 if (!idev
->info
->irqcontrol
)
590 if (copy_from_user(&irq_on
, buf
, count
))
593 retval
= idev
->info
->irqcontrol(idev
->info
, irq_on
);
595 return retval
? retval
: sizeof(s32
);
598 static int uio_find_mem_index(struct vm_area_struct
*vma
)
601 struct uio_device
*idev
= vma
->vm_private_data
;
603 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
604 if (idev
->info
->mem
[mi
].size
== 0)
606 if (vma
->vm_pgoff
== mi
)
612 static void uio_vma_open(struct vm_area_struct
*vma
)
614 struct uio_device
*idev
= vma
->vm_private_data
;
618 static void uio_vma_close(struct vm_area_struct
*vma
)
620 struct uio_device
*idev
= vma
->vm_private_data
;
624 static int uio_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
626 struct uio_device
*idev
= vma
->vm_private_data
;
628 unsigned long offset
;
630 int mi
= uio_find_mem_index(vma
);
632 return VM_FAULT_SIGBUS
;
635 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
638 offset
= (vmf
->pgoff
- mi
) << PAGE_SHIFT
;
640 if (idev
->info
->mem
[mi
].memtype
== UIO_MEM_LOGICAL
)
641 page
= virt_to_page(idev
->info
->mem
[mi
].addr
+ offset
);
643 page
= vmalloc_to_page((void *)idev
->info
->mem
[mi
].addr
650 static const struct vm_operations_struct uio_vm_ops
= {
651 .open
= uio_vma_open
,
652 .close
= uio_vma_close
,
653 .fault
= uio_vma_fault
,
656 static int uio_mmap_physical(struct vm_area_struct
*vma
)
658 struct uio_device
*idev
= vma
->vm_private_data
;
659 int mi
= uio_find_mem_index(vma
);
663 vma
->vm_flags
|= VM_IO
| VM_RESERVED
;
665 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
667 return remap_pfn_range(vma
,
669 idev
->info
->mem
[mi
].addr
>> PAGE_SHIFT
,
670 vma
->vm_end
- vma
->vm_start
,
674 static int uio_mmap_logical(struct vm_area_struct
*vma
)
676 vma
->vm_flags
|= VM_RESERVED
;
677 vma
->vm_ops
= &uio_vm_ops
;
682 static int uio_mmap(struct file
*filep
, struct vm_area_struct
*vma
)
684 struct uio_listener
*listener
= filep
->private_data
;
685 struct uio_device
*idev
= listener
->dev
;
687 unsigned long requested_pages
, actual_pages
;
690 if (vma
->vm_end
< vma
->vm_start
)
693 vma
->vm_private_data
= idev
;
695 mi
= uio_find_mem_index(vma
);
699 requested_pages
= (vma
->vm_end
- vma
->vm_start
) >> PAGE_SHIFT
;
700 actual_pages
= ((idev
->info
->mem
[mi
].addr
& ~PAGE_MASK
)
701 + idev
->info
->mem
[mi
].size
+ PAGE_SIZE
-1) >> PAGE_SHIFT
;
702 if (requested_pages
> actual_pages
)
705 if (idev
->info
->mmap
) {
706 ret
= idev
->info
->mmap(idev
->info
, vma
);
710 switch (idev
->info
->mem
[mi
].memtype
) {
712 return uio_mmap_physical(vma
);
713 case UIO_MEM_LOGICAL
:
714 case UIO_MEM_VIRTUAL
:
715 return uio_mmap_logical(vma
);
721 static const struct file_operations uio_fops
= {
722 .owner
= THIS_MODULE
,
724 .release
= uio_release
,
729 .fasync
= uio_fasync
,
732 static int uio_major_init(void)
734 uio_major
= register_chrdev(0, "uio", &uio_fops
);
740 static void uio_major_cleanup(void)
742 unregister_chrdev(uio_major
, "uio");
745 static int init_uio_class(void)
750 /* This is the first time in here, set everything up properly */
751 ret
= uio_major_init();
755 class = class_create(THIS_MODULE
, "uio");
758 printk(KERN_ERR
"class_create failed for uio\n");
759 goto err_class_create
;
770 static void release_uio_class(void)
772 /* Ok, we cheat as we know we only have one uio_class */
773 class_destroy(uio_class
);
779 * uio_register_device - register a new userspace IO device
780 * @owner: module that creates the new device
781 * @parent: parent device
782 * @info: UIO device capabilities
784 * returns zero on success or a negative error code.
786 int __uio_register_device(struct module
*owner
,
787 struct device
*parent
,
788 struct uio_info
*info
)
790 struct uio_device
*idev
;
793 if (!parent
|| !info
|| !info
->name
|| !info
->version
)
796 info
->uio_dev
= NULL
;
798 idev
= kzalloc(sizeof(*idev
), GFP_KERNEL
);
806 init_waitqueue_head(&idev
->wait
);
807 atomic_set(&idev
->event
, 0);
809 ret
= uio_get_minor(idev
);
813 idev
->dev
= device_create(uio_class
, parent
,
814 MKDEV(uio_major
, idev
->minor
), idev
,
815 "uio%d", idev
->minor
);
816 if (IS_ERR(idev
->dev
)) {
817 printk(KERN_ERR
"UIO: device register failed\n");
818 ret
= PTR_ERR(idev
->dev
);
819 goto err_device_create
;
822 ret
= uio_dev_add_attributes(idev
);
824 goto err_uio_dev_add_attributes
;
826 info
->uio_dev
= idev
;
828 if (info
->irq
&& (info
->irq
!= UIO_IRQ_CUSTOM
)) {
829 ret
= request_irq(info
->irq
, uio_interrupt
,
830 info
->irq_flags
, info
->name
, idev
);
832 goto err_request_irq
;
838 uio_dev_del_attributes(idev
);
839 err_uio_dev_add_attributes
:
840 device_destroy(uio_class
, MKDEV(uio_major
, idev
->minor
));
842 uio_free_minor(idev
);
848 EXPORT_SYMBOL_GPL(__uio_register_device
);
851 * uio_unregister_device - unregister a industrial IO device
852 * @info: UIO device capabilities
855 void uio_unregister_device(struct uio_info
*info
)
857 struct uio_device
*idev
;
859 if (!info
|| !info
->uio_dev
)
862 idev
= info
->uio_dev
;
864 uio_free_minor(idev
);
866 if (info
->irq
&& (info
->irq
!= UIO_IRQ_CUSTOM
))
867 free_irq(info
->irq
, idev
);
869 uio_dev_del_attributes(idev
);
871 device_destroy(uio_class
, MKDEV(uio_major
, idev
->minor
));
876 EXPORT_SYMBOL_GPL(uio_unregister_device
);
878 static int __init
uio_init(void)
880 return init_uio_class();
883 static void __exit
uio_exit(void)
888 module_init(uio_init
)
889 module_exit(uio_exit
)
890 MODULE_LICENSE("GPL v2");