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>
21 #include <linux/idr.h>
22 #include <linux/sched.h>
23 #include <linux/string.h>
24 #include <linux/kobject.h>
25 #include <linux/uio_driver.h>
27 #define UIO_MAX_DEVICES 255
34 struct fasync_struct
*async_queue
;
35 wait_queue_head_t wait
;
37 struct uio_info
*info
;
38 struct kobject
*map_dir
;
39 struct kobject
*portio_dir
;
43 static DEFINE_IDR(uio_idr
);
44 static const struct file_operations uio_fops
;
46 /* UIO class infrastructure */
47 static struct uio_class
{
52 /* Protect idr accesses */
53 static DEFINE_MUTEX(minor_lock
);
63 #define to_map(map) container_of(map, struct uio_map, kobj)
65 static ssize_t
map_name_show(struct uio_mem
*mem
, char *buf
)
67 if (unlikely(!mem
->name
))
70 return sprintf(buf
, "%s\n", mem
->name
);
73 static ssize_t
map_addr_show(struct uio_mem
*mem
, char *buf
)
75 return sprintf(buf
, "0x%lx\n", mem
->addr
);
78 static ssize_t
map_size_show(struct uio_mem
*mem
, char *buf
)
80 return sprintf(buf
, "0x%lx\n", mem
->size
);
83 static ssize_t
map_offset_show(struct uio_mem
*mem
, char *buf
)
85 return sprintf(buf
, "0x%lx\n", mem
->addr
& ~PAGE_MASK
);
88 struct map_sysfs_entry
{
89 struct attribute attr
;
90 ssize_t (*show
)(struct uio_mem
*, char *);
91 ssize_t (*store
)(struct uio_mem
*, const char *, size_t);
94 static struct map_sysfs_entry name_attribute
=
95 __ATTR(name
, S_IRUGO
, map_name_show
, NULL
);
96 static struct map_sysfs_entry addr_attribute
=
97 __ATTR(addr
, S_IRUGO
, map_addr_show
, NULL
);
98 static struct map_sysfs_entry size_attribute
=
99 __ATTR(size
, S_IRUGO
, map_size_show
, NULL
);
100 static struct map_sysfs_entry offset_attribute
=
101 __ATTR(offset
, S_IRUGO
, map_offset_show
, NULL
);
103 static struct attribute
*attrs
[] = {
104 &name_attribute
.attr
,
105 &addr_attribute
.attr
,
106 &size_attribute
.attr
,
107 &offset_attribute
.attr
,
108 NULL
, /* need to NULL terminate the list of attributes */
111 static void map_release(struct kobject
*kobj
)
113 struct uio_map
*map
= to_map(kobj
);
117 static ssize_t
map_type_show(struct kobject
*kobj
, struct attribute
*attr
,
120 struct uio_map
*map
= to_map(kobj
);
121 struct uio_mem
*mem
= map
->mem
;
122 struct map_sysfs_entry
*entry
;
124 entry
= container_of(attr
, struct map_sysfs_entry
, attr
);
129 return entry
->show(mem
, buf
);
132 static const struct sysfs_ops map_sysfs_ops
= {
133 .show
= map_type_show
,
136 static struct kobj_type map_attr_type
= {
137 .release
= map_release
,
138 .sysfs_ops
= &map_sysfs_ops
,
139 .default_attrs
= attrs
,
144 struct uio_port
*port
;
146 #define to_portio(portio) container_of(portio, struct uio_portio, kobj)
148 static ssize_t
portio_name_show(struct uio_port
*port
, char *buf
)
150 if (unlikely(!port
->name
))
153 return sprintf(buf
, "%s\n", port
->name
);
156 static ssize_t
portio_start_show(struct uio_port
*port
, char *buf
)
158 return sprintf(buf
, "0x%lx\n", port
->start
);
161 static ssize_t
portio_size_show(struct uio_port
*port
, char *buf
)
163 return sprintf(buf
, "0x%lx\n", port
->size
);
166 static ssize_t
portio_porttype_show(struct uio_port
*port
, char *buf
)
168 const char *porttypes
[] = {"none", "x86", "gpio", "other"};
170 if ((port
->porttype
< 0) || (port
->porttype
> UIO_PORT_OTHER
))
173 return sprintf(buf
, "port_%s\n", porttypes
[port
->porttype
]);
176 struct portio_sysfs_entry
{
177 struct attribute attr
;
178 ssize_t (*show
)(struct uio_port
*, char *);
179 ssize_t (*store
)(struct uio_port
*, const char *, size_t);
182 static struct portio_sysfs_entry portio_name_attribute
=
183 __ATTR(name
, S_IRUGO
, portio_name_show
, NULL
);
184 static struct portio_sysfs_entry portio_start_attribute
=
185 __ATTR(start
, S_IRUGO
, portio_start_show
, NULL
);
186 static struct portio_sysfs_entry portio_size_attribute
=
187 __ATTR(size
, S_IRUGO
, portio_size_show
, NULL
);
188 static struct portio_sysfs_entry portio_porttype_attribute
=
189 __ATTR(porttype
, S_IRUGO
, portio_porttype_show
, NULL
);
191 static struct attribute
*portio_attrs
[] = {
192 &portio_name_attribute
.attr
,
193 &portio_start_attribute
.attr
,
194 &portio_size_attribute
.attr
,
195 &portio_porttype_attribute
.attr
,
199 static void portio_release(struct kobject
*kobj
)
201 struct uio_portio
*portio
= to_portio(kobj
);
205 static ssize_t
portio_type_show(struct kobject
*kobj
, struct attribute
*attr
,
208 struct uio_portio
*portio
= to_portio(kobj
);
209 struct uio_port
*port
= portio
->port
;
210 struct portio_sysfs_entry
*entry
;
212 entry
= container_of(attr
, struct portio_sysfs_entry
, attr
);
217 return entry
->show(port
, buf
);
220 static const struct sysfs_ops portio_sysfs_ops
= {
221 .show
= portio_type_show
,
224 static struct kobj_type portio_attr_type
= {
225 .release
= portio_release
,
226 .sysfs_ops
= &portio_sysfs_ops
,
227 .default_attrs
= portio_attrs
,
230 static ssize_t
show_name(struct device
*dev
,
231 struct device_attribute
*attr
, char *buf
)
233 struct uio_device
*idev
= dev_get_drvdata(dev
);
235 return sprintf(buf
, "%s\n", idev
->info
->name
);
239 static DEVICE_ATTR(name
, S_IRUGO
, show_name
, NULL
);
241 static ssize_t
show_version(struct device
*dev
,
242 struct device_attribute
*attr
, char *buf
)
244 struct uio_device
*idev
= dev_get_drvdata(dev
);
246 return sprintf(buf
, "%s\n", idev
->info
->version
);
250 static DEVICE_ATTR(version
, S_IRUGO
, show_version
, NULL
);
252 static ssize_t
show_event(struct device
*dev
,
253 struct device_attribute
*attr
, char *buf
)
255 struct uio_device
*idev
= dev_get_drvdata(dev
);
257 return sprintf(buf
, "%u\n",
258 (unsigned int)atomic_read(&idev
->event
));
262 static DEVICE_ATTR(event
, S_IRUGO
, show_event
, NULL
);
264 static struct attribute
*uio_attrs
[] = {
266 &dev_attr_version
.attr
,
267 &dev_attr_event
.attr
,
271 static struct attribute_group uio_attr_grp
= {
278 static int uio_dev_add_attributes(struct uio_device
*idev
)
283 int portio_found
= 0;
286 struct uio_port
*port
;
287 struct uio_portio
*portio
;
289 ret
= sysfs_create_group(&idev
->dev
->kobj
, &uio_attr_grp
);
293 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
294 mem
= &idev
->info
->mem
[mi
];
299 idev
->map_dir
= kobject_create_and_add("maps",
304 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
307 kobject_init(&map
->kobj
, &map_attr_type
);
310 ret
= kobject_add(&map
->kobj
, idev
->map_dir
, "map%d", mi
);
313 ret
= kobject_uevent(&map
->kobj
, KOBJ_ADD
);
318 for (pi
= 0; pi
< MAX_UIO_PORT_REGIONS
; pi
++) {
319 port
= &idev
->info
->port
[pi
];
324 idev
->portio_dir
= kobject_create_and_add("portio",
326 if (!idev
->portio_dir
)
329 portio
= kzalloc(sizeof(*portio
), GFP_KERNEL
);
332 kobject_init(&portio
->kobj
, &portio_attr_type
);
334 port
->portio
= portio
;
335 ret
= kobject_add(&portio
->kobj
, idev
->portio_dir
,
339 ret
= kobject_uevent(&portio
->kobj
, KOBJ_ADD
);
347 for (pi
--; pi
>= 0; pi
--) {
348 port
= &idev
->info
->port
[pi
];
349 portio
= port
->portio
;
350 kobject_put(&portio
->kobj
);
352 kobject_put(idev
->portio_dir
);
354 for (mi
--; mi
>=0; mi
--) {
355 mem
= &idev
->info
->mem
[mi
];
357 kobject_put(&map
->kobj
);
359 kobject_put(idev
->map_dir
);
360 sysfs_remove_group(&idev
->dev
->kobj
, &uio_attr_grp
);
362 dev_err(idev
->dev
, "error creating sysfs files (%d)\n", ret
);
366 static void uio_dev_del_attributes(struct uio_device
*idev
)
370 struct uio_port
*port
;
372 for (i
= 0; i
< MAX_UIO_MAPS
; i
++) {
373 mem
= &idev
->info
->mem
[i
];
376 kobject_put(&mem
->map
->kobj
);
378 kobject_put(idev
->map_dir
);
380 for (i
= 0; i
< MAX_UIO_PORT_REGIONS
; i
++) {
381 port
= &idev
->info
->port
[i
];
384 kobject_put(&port
->portio
->kobj
);
386 kobject_put(idev
->portio_dir
);
388 sysfs_remove_group(&idev
->dev
->kobj
, &uio_attr_grp
);
391 static int uio_get_minor(struct uio_device
*idev
)
393 int retval
= -ENOMEM
;
396 mutex_lock(&minor_lock
);
397 if (idr_pre_get(&uio_idr
, GFP_KERNEL
) == 0)
400 retval
= idr_get_new(&uio_idr
, idev
, &id
);
402 if (retval
== -EAGAIN
)
406 idev
->minor
= id
& MAX_ID_MASK
;
408 mutex_unlock(&minor_lock
);
412 static void uio_free_minor(struct uio_device
*idev
)
414 mutex_lock(&minor_lock
);
415 idr_remove(&uio_idr
, idev
->minor
);
416 mutex_unlock(&minor_lock
);
420 * uio_event_notify - trigger an interrupt event
421 * @info: UIO device capabilities
423 void uio_event_notify(struct uio_info
*info
)
425 struct uio_device
*idev
= info
->uio_dev
;
427 atomic_inc(&idev
->event
);
428 wake_up_interruptible(&idev
->wait
);
429 kill_fasync(&idev
->async_queue
, SIGIO
, POLL_IN
);
431 EXPORT_SYMBOL_GPL(uio_event_notify
);
434 * uio_interrupt - hardware interrupt handler
435 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
436 * @dev_id: Pointer to the devices uio_device structure
438 static irqreturn_t
uio_interrupt(int irq
, void *dev_id
)
440 struct uio_device
*idev
= (struct uio_device
*)dev_id
;
441 irqreturn_t ret
= idev
->info
->handler(irq
, idev
->info
);
443 if (ret
== IRQ_HANDLED
)
444 uio_event_notify(idev
->info
);
449 struct uio_listener
{
450 struct uio_device
*dev
;
454 static int uio_open(struct inode
*inode
, struct file
*filep
)
456 struct uio_device
*idev
;
457 struct uio_listener
*listener
;
460 mutex_lock(&minor_lock
);
461 idev
= idr_find(&uio_idr
, iminor(inode
));
462 mutex_unlock(&minor_lock
);
468 if (!try_module_get(idev
->owner
)) {
473 listener
= kmalloc(sizeof(*listener
), GFP_KERNEL
);
476 goto err_alloc_listener
;
479 listener
->dev
= idev
;
480 listener
->event_count
= atomic_read(&idev
->event
);
481 filep
->private_data
= listener
;
483 if (idev
->info
->open
) {
484 ret
= idev
->info
->open(idev
->info
, inode
);
494 module_put(idev
->owner
);
500 static int uio_fasync(int fd
, struct file
*filep
, int on
)
502 struct uio_listener
*listener
= filep
->private_data
;
503 struct uio_device
*idev
= listener
->dev
;
505 return fasync_helper(fd
, filep
, on
, &idev
->async_queue
);
508 static int uio_release(struct inode
*inode
, struct file
*filep
)
511 struct uio_listener
*listener
= filep
->private_data
;
512 struct uio_device
*idev
= listener
->dev
;
514 if (idev
->info
->release
)
515 ret
= idev
->info
->release(idev
->info
, inode
);
517 module_put(idev
->owner
);
522 static unsigned int uio_poll(struct file
*filep
, poll_table
*wait
)
524 struct uio_listener
*listener
= filep
->private_data
;
525 struct uio_device
*idev
= listener
->dev
;
527 if (idev
->info
->irq
== UIO_IRQ_NONE
)
530 poll_wait(filep
, &idev
->wait
, wait
);
531 if (listener
->event_count
!= atomic_read(&idev
->event
))
532 return POLLIN
| POLLRDNORM
;
536 static ssize_t
uio_read(struct file
*filep
, char __user
*buf
,
537 size_t count
, loff_t
*ppos
)
539 struct uio_listener
*listener
= filep
->private_data
;
540 struct uio_device
*idev
= listener
->dev
;
541 DECLARE_WAITQUEUE(wait
, current
);
545 if (idev
->info
->irq
== UIO_IRQ_NONE
)
548 if (count
!= sizeof(s32
))
551 add_wait_queue(&idev
->wait
, &wait
);
554 set_current_state(TASK_INTERRUPTIBLE
);
556 event_count
= atomic_read(&idev
->event
);
557 if (event_count
!= listener
->event_count
) {
558 if (copy_to_user(buf
, &event_count
, count
))
561 listener
->event_count
= event_count
;
567 if (filep
->f_flags
& O_NONBLOCK
) {
572 if (signal_pending(current
)) {
573 retval
= -ERESTARTSYS
;
579 __set_current_state(TASK_RUNNING
);
580 remove_wait_queue(&idev
->wait
, &wait
);
585 static ssize_t
uio_write(struct file
*filep
, const char __user
*buf
,
586 size_t count
, loff_t
*ppos
)
588 struct uio_listener
*listener
= filep
->private_data
;
589 struct uio_device
*idev
= listener
->dev
;
593 if (idev
->info
->irq
== UIO_IRQ_NONE
)
596 if (count
!= sizeof(s32
))
599 if (!idev
->info
->irqcontrol
)
602 if (copy_from_user(&irq_on
, buf
, count
))
605 retval
= idev
->info
->irqcontrol(idev
->info
, irq_on
);
607 return retval
? retval
: sizeof(s32
);
610 static int uio_find_mem_index(struct vm_area_struct
*vma
)
613 struct uio_device
*idev
= vma
->vm_private_data
;
615 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
616 if (idev
->info
->mem
[mi
].size
== 0)
618 if (vma
->vm_pgoff
== mi
)
624 static void uio_vma_open(struct vm_area_struct
*vma
)
626 struct uio_device
*idev
= vma
->vm_private_data
;
630 static void uio_vma_close(struct vm_area_struct
*vma
)
632 struct uio_device
*idev
= vma
->vm_private_data
;
636 static int uio_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
638 struct uio_device
*idev
= vma
->vm_private_data
;
640 unsigned long offset
;
642 int mi
= uio_find_mem_index(vma
);
644 return VM_FAULT_SIGBUS
;
647 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
650 offset
= (vmf
->pgoff
- mi
) << PAGE_SHIFT
;
652 if (idev
->info
->mem
[mi
].memtype
== UIO_MEM_LOGICAL
)
653 page
= virt_to_page(idev
->info
->mem
[mi
].addr
+ offset
);
655 page
= vmalloc_to_page((void *)idev
->info
->mem
[mi
].addr
662 static const struct vm_operations_struct uio_vm_ops
= {
663 .open
= uio_vma_open
,
664 .close
= uio_vma_close
,
665 .fault
= uio_vma_fault
,
668 static int uio_mmap_physical(struct vm_area_struct
*vma
)
670 struct uio_device
*idev
= vma
->vm_private_data
;
671 int mi
= uio_find_mem_index(vma
);
675 vma
->vm_flags
|= VM_IO
| VM_RESERVED
;
677 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
679 return remap_pfn_range(vma
,
681 idev
->info
->mem
[mi
].addr
>> PAGE_SHIFT
,
682 vma
->vm_end
- vma
->vm_start
,
686 static int uio_mmap_logical(struct vm_area_struct
*vma
)
688 vma
->vm_flags
|= VM_RESERVED
;
689 vma
->vm_ops
= &uio_vm_ops
;
694 static int uio_mmap(struct file
*filep
, struct vm_area_struct
*vma
)
696 struct uio_listener
*listener
= filep
->private_data
;
697 struct uio_device
*idev
= listener
->dev
;
699 unsigned long requested_pages
, actual_pages
;
702 if (vma
->vm_end
< vma
->vm_start
)
705 vma
->vm_private_data
= idev
;
707 mi
= uio_find_mem_index(vma
);
711 requested_pages
= (vma
->vm_end
- vma
->vm_start
) >> PAGE_SHIFT
;
712 actual_pages
= ((idev
->info
->mem
[mi
].addr
& ~PAGE_MASK
)
713 + idev
->info
->mem
[mi
].size
+ PAGE_SIZE
-1) >> PAGE_SHIFT
;
714 if (requested_pages
> actual_pages
)
717 if (idev
->info
->mmap
) {
718 ret
= idev
->info
->mmap(idev
->info
, vma
);
722 switch (idev
->info
->mem
[mi
].memtype
) {
724 return uio_mmap_physical(vma
);
725 case UIO_MEM_LOGICAL
:
726 case UIO_MEM_VIRTUAL
:
727 return uio_mmap_logical(vma
);
733 static const struct file_operations uio_fops
= {
734 .owner
= THIS_MODULE
,
736 .release
= uio_release
,
741 .fasync
= uio_fasync
,
744 static int uio_major_init(void)
746 uio_major
= register_chrdev(0, "uio", &uio_fops
);
752 static void uio_major_cleanup(void)
754 unregister_chrdev(uio_major
, "uio");
757 static int init_uio_class(void)
761 if (uio_class
!= NULL
) {
762 kref_get(&uio_class
->kref
);
766 /* This is the first time in here, set everything up properly */
767 ret
= uio_major_init();
771 uio_class
= kzalloc(sizeof(*uio_class
), GFP_KERNEL
);
777 kref_init(&uio_class
->kref
);
778 uio_class
->class = class_create(THIS_MODULE
, "uio");
779 if (IS_ERR(uio_class
->class)) {
780 ret
= IS_ERR(uio_class
->class);
781 printk(KERN_ERR
"class_create failed for uio\n");
782 goto err_class_create
;
795 static void release_uio_class(struct kref
*kref
)
797 /* Ok, we cheat as we know we only have one uio_class */
798 class_destroy(uio_class
->class);
804 static void uio_class_destroy(void)
807 kref_put(&uio_class
->kref
, release_uio_class
);
811 * uio_register_device - register a new userspace IO device
812 * @owner: module that creates the new device
813 * @parent: parent device
814 * @info: UIO device capabilities
816 * returns zero on success or a negative error code.
818 int __uio_register_device(struct module
*owner
,
819 struct device
*parent
,
820 struct uio_info
*info
)
822 struct uio_device
*idev
;
825 if (!parent
|| !info
|| !info
->name
|| !info
->version
)
828 info
->uio_dev
= NULL
;
830 ret
= init_uio_class();
834 idev
= kzalloc(sizeof(*idev
), GFP_KERNEL
);
842 init_waitqueue_head(&idev
->wait
);
843 atomic_set(&idev
->event
, 0);
845 ret
= uio_get_minor(idev
);
849 idev
->dev
= device_create(uio_class
->class, parent
,
850 MKDEV(uio_major
, idev
->minor
), idev
,
851 "uio%d", idev
->minor
);
852 if (IS_ERR(idev
->dev
)) {
853 printk(KERN_ERR
"UIO: device register failed\n");
854 ret
= PTR_ERR(idev
->dev
);
855 goto err_device_create
;
858 ret
= uio_dev_add_attributes(idev
);
860 goto err_uio_dev_add_attributes
;
862 info
->uio_dev
= idev
;
864 if (idev
->info
->irq
>= 0) {
865 ret
= request_irq(idev
->info
->irq
, uio_interrupt
,
866 idev
->info
->irq_flags
, idev
->info
->name
, idev
);
868 goto err_request_irq
;
874 uio_dev_del_attributes(idev
);
875 err_uio_dev_add_attributes
:
876 device_destroy(uio_class
->class, MKDEV(uio_major
, idev
->minor
));
878 uio_free_minor(idev
);
885 EXPORT_SYMBOL_GPL(__uio_register_device
);
888 * uio_unregister_device - unregister a industrial IO device
889 * @info: UIO device capabilities
892 void uio_unregister_device(struct uio_info
*info
)
894 struct uio_device
*idev
;
896 if (!info
|| !info
->uio_dev
)
899 idev
= info
->uio_dev
;
901 uio_free_minor(idev
);
904 free_irq(info
->irq
, idev
);
906 uio_dev_del_attributes(idev
);
908 dev_set_drvdata(idev
->dev
, NULL
);
909 device_destroy(uio_class
->class, MKDEV(uio_major
, idev
->minor
));
915 EXPORT_SYMBOL_GPL(uio_unregister_device
);
917 static int __init
uio_init(void)
922 static void __exit
uio_exit(void)
926 module_init(uio_init
)
927 module_exit(uio_exit
)
928 MODULE_LICENSE("GPL v2");