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/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
;
39 struct uio_info
*info
;
40 struct kobject
*map_dir
;
41 struct kobject
*portio_dir
;
45 static struct cdev
*uio_cdev
;
46 static DEFINE_IDR(uio_idr
);
47 static const struct file_operations uio_fops
;
49 /* UIO class infrastructure */
50 static struct class *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
);
234 return sprintf(buf
, "%s\n", idev
->info
->name
);
236 static DEVICE_ATTR(name
, S_IRUGO
, show_name
, NULL
);
238 static ssize_t
show_version(struct device
*dev
,
239 struct device_attribute
*attr
, char *buf
)
241 struct uio_device
*idev
= dev_get_drvdata(dev
);
242 return sprintf(buf
, "%s\n", idev
->info
->version
);
244 static DEVICE_ATTR(version
, S_IRUGO
, show_version
, NULL
);
246 static ssize_t
show_event(struct device
*dev
,
247 struct device_attribute
*attr
, char *buf
)
249 struct uio_device
*idev
= dev_get_drvdata(dev
);
250 return sprintf(buf
, "%u\n", (unsigned int)atomic_read(&idev
->event
));
252 static DEVICE_ATTR(event
, S_IRUGO
, show_event
, NULL
);
254 static struct attribute
*uio_attrs
[] = {
256 &dev_attr_version
.attr
,
257 &dev_attr_event
.attr
,
261 static struct attribute_group uio_attr_grp
= {
268 static int uio_dev_add_attributes(struct uio_device
*idev
)
273 int portio_found
= 0;
276 struct uio_port
*port
;
277 struct uio_portio
*portio
;
279 ret
= sysfs_create_group(&idev
->dev
->kobj
, &uio_attr_grp
);
283 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
284 mem
= &idev
->info
->mem
[mi
];
289 idev
->map_dir
= kobject_create_and_add("maps",
294 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
297 kobject_init(&map
->kobj
, &map_attr_type
);
300 ret
= kobject_add(&map
->kobj
, idev
->map_dir
, "map%d", mi
);
303 ret
= kobject_uevent(&map
->kobj
, KOBJ_ADD
);
308 for (pi
= 0; pi
< MAX_UIO_PORT_REGIONS
; pi
++) {
309 port
= &idev
->info
->port
[pi
];
314 idev
->portio_dir
= kobject_create_and_add("portio",
316 if (!idev
->portio_dir
)
319 portio
= kzalloc(sizeof(*portio
), GFP_KERNEL
);
322 kobject_init(&portio
->kobj
, &portio_attr_type
);
324 port
->portio
= portio
;
325 ret
= kobject_add(&portio
->kobj
, idev
->portio_dir
,
329 ret
= kobject_uevent(&portio
->kobj
, KOBJ_ADD
);
337 for (pi
--; pi
>= 0; pi
--) {
338 port
= &idev
->info
->port
[pi
];
339 portio
= port
->portio
;
340 kobject_put(&portio
->kobj
);
342 kobject_put(idev
->portio_dir
);
344 for (mi
--; mi
>=0; mi
--) {
345 mem
= &idev
->info
->mem
[mi
];
347 kobject_put(&map
->kobj
);
349 kobject_put(idev
->map_dir
);
350 sysfs_remove_group(&idev
->dev
->kobj
, &uio_attr_grp
);
352 dev_err(idev
->dev
, "error creating sysfs files (%d)\n", ret
);
356 static void uio_dev_del_attributes(struct uio_device
*idev
)
360 struct uio_port
*port
;
362 for (i
= 0; i
< MAX_UIO_MAPS
; i
++) {
363 mem
= &idev
->info
->mem
[i
];
366 kobject_put(&mem
->map
->kobj
);
368 kobject_put(idev
->map_dir
);
370 for (i
= 0; i
< MAX_UIO_PORT_REGIONS
; i
++) {
371 port
= &idev
->info
->port
[i
];
374 kobject_put(&port
->portio
->kobj
);
376 kobject_put(idev
->portio_dir
);
378 sysfs_remove_group(&idev
->dev
->kobj
, &uio_attr_grp
);
381 static int uio_get_minor(struct uio_device
*idev
)
383 int retval
= -ENOMEM
;
386 mutex_lock(&minor_lock
);
387 if (idr_pre_get(&uio_idr
, GFP_KERNEL
) == 0)
390 retval
= idr_get_new(&uio_idr
, idev
, &id
);
392 if (retval
== -EAGAIN
)
396 idev
->minor
= id
& MAX_ID_MASK
;
398 mutex_unlock(&minor_lock
);
402 static void uio_free_minor(struct uio_device
*idev
)
404 mutex_lock(&minor_lock
);
405 idr_remove(&uio_idr
, idev
->minor
);
406 mutex_unlock(&minor_lock
);
410 * uio_event_notify - trigger an interrupt event
411 * @info: UIO device capabilities
413 void uio_event_notify(struct uio_info
*info
)
415 struct uio_device
*idev
= info
->uio_dev
;
417 atomic_inc(&idev
->event
);
418 wake_up_interruptible(&idev
->wait
);
419 kill_fasync(&idev
->async_queue
, SIGIO
, POLL_IN
);
421 EXPORT_SYMBOL_GPL(uio_event_notify
);
424 * uio_interrupt - hardware interrupt handler
425 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
426 * @dev_id: Pointer to the devices uio_device structure
428 static irqreturn_t
uio_interrupt(int irq
, void *dev_id
)
430 struct uio_device
*idev
= (struct uio_device
*)dev_id
;
431 irqreturn_t ret
= idev
->info
->handler(irq
, idev
->info
);
433 if (ret
== IRQ_HANDLED
)
434 uio_event_notify(idev
->info
);
439 struct uio_listener
{
440 struct uio_device
*dev
;
444 static int uio_open(struct inode
*inode
, struct file
*filep
)
446 struct uio_device
*idev
;
447 struct uio_listener
*listener
;
450 mutex_lock(&minor_lock
);
451 idev
= idr_find(&uio_idr
, iminor(inode
));
452 mutex_unlock(&minor_lock
);
458 if (!try_module_get(idev
->owner
)) {
463 listener
= kmalloc(sizeof(*listener
), GFP_KERNEL
);
466 goto err_alloc_listener
;
469 listener
->dev
= idev
;
470 listener
->event_count
= atomic_read(&idev
->event
);
471 filep
->private_data
= listener
;
473 if (idev
->info
->open
) {
474 ret
= idev
->info
->open(idev
->info
, inode
);
484 module_put(idev
->owner
);
490 static int uio_fasync(int fd
, struct file
*filep
, int on
)
492 struct uio_listener
*listener
= filep
->private_data
;
493 struct uio_device
*idev
= listener
->dev
;
495 return fasync_helper(fd
, filep
, on
, &idev
->async_queue
);
498 static int uio_release(struct inode
*inode
, struct file
*filep
)
501 struct uio_listener
*listener
= filep
->private_data
;
502 struct uio_device
*idev
= listener
->dev
;
504 if (idev
->info
->release
)
505 ret
= idev
->info
->release(idev
->info
, inode
);
507 module_put(idev
->owner
);
512 static unsigned int uio_poll(struct file
*filep
, poll_table
*wait
)
514 struct uio_listener
*listener
= filep
->private_data
;
515 struct uio_device
*idev
= listener
->dev
;
517 if (!idev
->info
->irq
)
520 poll_wait(filep
, &idev
->wait
, wait
);
521 if (listener
->event_count
!= atomic_read(&idev
->event
))
522 return POLLIN
| POLLRDNORM
;
526 static ssize_t
uio_read(struct file
*filep
, char __user
*buf
,
527 size_t count
, loff_t
*ppos
)
529 struct uio_listener
*listener
= filep
->private_data
;
530 struct uio_device
*idev
= listener
->dev
;
531 DECLARE_WAITQUEUE(wait
, current
);
535 if (!idev
->info
->irq
)
538 if (count
!= sizeof(s32
))
541 add_wait_queue(&idev
->wait
, &wait
);
544 set_current_state(TASK_INTERRUPTIBLE
);
546 event_count
= atomic_read(&idev
->event
);
547 if (event_count
!= listener
->event_count
) {
548 if (copy_to_user(buf
, &event_count
, count
))
551 listener
->event_count
= event_count
;
557 if (filep
->f_flags
& O_NONBLOCK
) {
562 if (signal_pending(current
)) {
563 retval
= -ERESTARTSYS
;
569 __set_current_state(TASK_RUNNING
);
570 remove_wait_queue(&idev
->wait
, &wait
);
575 static ssize_t
uio_write(struct file
*filep
, const char __user
*buf
,
576 size_t count
, loff_t
*ppos
)
578 struct uio_listener
*listener
= filep
->private_data
;
579 struct uio_device
*idev
= listener
->dev
;
583 if (!idev
->info
->irq
)
586 if (count
!= sizeof(s32
))
589 if (!idev
->info
->irqcontrol
)
592 if (copy_from_user(&irq_on
, buf
, count
))
595 retval
= idev
->info
->irqcontrol(idev
->info
, irq_on
);
597 return retval
? retval
: sizeof(s32
);
600 static int uio_find_mem_index(struct vm_area_struct
*vma
)
603 struct uio_device
*idev
= vma
->vm_private_data
;
605 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
606 if (idev
->info
->mem
[mi
].size
== 0)
608 if (vma
->vm_pgoff
== mi
)
614 static void uio_vma_open(struct vm_area_struct
*vma
)
616 struct uio_device
*idev
= vma
->vm_private_data
;
620 static void uio_vma_close(struct vm_area_struct
*vma
)
622 struct uio_device
*idev
= vma
->vm_private_data
;
626 static int uio_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
628 struct uio_device
*idev
= vma
->vm_private_data
;
630 unsigned long offset
;
632 int mi
= uio_find_mem_index(vma
);
634 return VM_FAULT_SIGBUS
;
637 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
640 offset
= (vmf
->pgoff
- mi
) << PAGE_SHIFT
;
642 if (idev
->info
->mem
[mi
].memtype
== UIO_MEM_LOGICAL
)
643 page
= virt_to_page(idev
->info
->mem
[mi
].addr
+ offset
);
645 page
= vmalloc_to_page((void *)idev
->info
->mem
[mi
].addr
652 static const struct vm_operations_struct uio_vm_ops
= {
653 .open
= uio_vma_open
,
654 .close
= uio_vma_close
,
655 .fault
= uio_vma_fault
,
658 static int uio_mmap_physical(struct vm_area_struct
*vma
)
660 struct uio_device
*idev
= vma
->vm_private_data
;
661 int mi
= uio_find_mem_index(vma
);
665 vma
->vm_flags
|= VM_IO
| VM_RESERVED
;
667 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
669 return remap_pfn_range(vma
,
671 idev
->info
->mem
[mi
].addr
>> PAGE_SHIFT
,
672 vma
->vm_end
- vma
->vm_start
,
676 static int uio_mmap_logical(struct vm_area_struct
*vma
)
678 vma
->vm_flags
|= VM_RESERVED
;
679 vma
->vm_ops
= &uio_vm_ops
;
684 static int uio_mmap(struct file
*filep
, struct vm_area_struct
*vma
)
686 struct uio_listener
*listener
= filep
->private_data
;
687 struct uio_device
*idev
= listener
->dev
;
689 unsigned long requested_pages
, actual_pages
;
692 if (vma
->vm_end
< vma
->vm_start
)
695 vma
->vm_private_data
= idev
;
697 mi
= uio_find_mem_index(vma
);
701 requested_pages
= (vma
->vm_end
- vma
->vm_start
) >> PAGE_SHIFT
;
702 actual_pages
= ((idev
->info
->mem
[mi
].addr
& ~PAGE_MASK
)
703 + idev
->info
->mem
[mi
].size
+ PAGE_SIZE
-1) >> PAGE_SHIFT
;
704 if (requested_pages
> actual_pages
)
707 if (idev
->info
->mmap
) {
708 ret
= idev
->info
->mmap(idev
->info
, vma
);
712 switch (idev
->info
->mem
[mi
].memtype
) {
714 return uio_mmap_physical(vma
);
715 case UIO_MEM_LOGICAL
:
716 case UIO_MEM_VIRTUAL
:
717 return uio_mmap_logical(vma
);
723 static const struct file_operations uio_fops
= {
724 .owner
= THIS_MODULE
,
726 .release
= uio_release
,
731 .fasync
= uio_fasync
,
734 static int uio_major_init(void)
736 static const char name
[] = "uio";
737 struct cdev
*cdev
= NULL
;
741 result
= alloc_chrdev_region(&uio_dev
, 0, UIO_MAX_DEVICES
, name
);
750 cdev
->owner
= THIS_MODULE
;
751 cdev
->ops
= &uio_fops
;
752 kobject_set_name(&cdev
->kobj
, "%s", name
);
754 result
= cdev_add(cdev
, uio_dev
, UIO_MAX_DEVICES
);
758 uio_major
= MAJOR(uio_dev
);
764 kobject_put(&cdev
->kobj
);
766 unregister_chrdev_region(uio_dev
, UIO_MAX_DEVICES
);
770 static void uio_major_cleanup(void)
772 unregister_chrdev_region(MKDEV(uio_major
, 0), UIO_MAX_DEVICES
);
776 static int init_uio_class(void)
781 /* This is the first time in here, set everything up properly */
782 ret
= uio_major_init();
786 class = class_create(THIS_MODULE
, "uio");
789 printk(KERN_ERR
"class_create failed for uio\n");
790 goto err_class_create
;
801 static void release_uio_class(void)
803 /* Ok, we cheat as we know we only have one uio_class */
804 class_destroy(uio_class
);
810 * uio_register_device - register a new userspace IO device
811 * @owner: module that creates the new device
812 * @parent: parent device
813 * @info: UIO device capabilities
815 * returns zero on success or a negative error code.
817 int __uio_register_device(struct module
*owner
,
818 struct device
*parent
,
819 struct uio_info
*info
)
821 struct uio_device
*idev
;
824 if (!parent
|| !info
|| !info
->name
|| !info
->version
)
827 info
->uio_dev
= NULL
;
829 idev
= kzalloc(sizeof(*idev
), GFP_KERNEL
);
837 init_waitqueue_head(&idev
->wait
);
838 atomic_set(&idev
->event
, 0);
840 ret
= uio_get_minor(idev
);
844 idev
->dev
= device_create(uio_class
, parent
,
845 MKDEV(uio_major
, idev
->minor
), idev
,
846 "uio%d", idev
->minor
);
847 if (IS_ERR(idev
->dev
)) {
848 printk(KERN_ERR
"UIO: device register failed\n");
849 ret
= PTR_ERR(idev
->dev
);
850 goto err_device_create
;
853 ret
= uio_dev_add_attributes(idev
);
855 goto err_uio_dev_add_attributes
;
857 info
->uio_dev
= idev
;
859 if (info
->irq
&& (info
->irq
!= UIO_IRQ_CUSTOM
)) {
860 ret
= request_irq(info
->irq
, uio_interrupt
,
861 info
->irq_flags
, info
->name
, idev
);
863 goto err_request_irq
;
869 uio_dev_del_attributes(idev
);
870 err_uio_dev_add_attributes
:
871 device_destroy(uio_class
, MKDEV(uio_major
, idev
->minor
));
873 uio_free_minor(idev
);
879 EXPORT_SYMBOL_GPL(__uio_register_device
);
882 * uio_unregister_device - unregister a industrial IO device
883 * @info: UIO device capabilities
886 void uio_unregister_device(struct uio_info
*info
)
888 struct uio_device
*idev
;
890 if (!info
|| !info
->uio_dev
)
893 idev
= info
->uio_dev
;
895 uio_free_minor(idev
);
897 if (info
->irq
&& (info
->irq
!= UIO_IRQ_CUSTOM
))
898 free_irq(info
->irq
, idev
);
900 uio_dev_del_attributes(idev
);
902 device_destroy(uio_class
, MKDEV(uio_major
, idev
->minor
));
907 EXPORT_SYMBOL_GPL(uio_unregister_device
);
909 static int __init
uio_init(void)
911 return init_uio_class();
914 static void __exit
uio_exit(void)
919 module_init(uio_init
)
920 module_exit(uio_exit
)
921 MODULE_LICENSE("GPL v2");