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/string.h>
23 #include <linux/kobject.h>
24 #include <linux/uio_driver.h>
26 #define UIO_MAX_DEVICES 255
33 struct fasync_struct
*async_queue
;
34 wait_queue_head_t wait
;
36 struct uio_info
*info
;
37 struct kobject
*map_dir
;
38 struct kobject
*portio_dir
;
42 static DEFINE_IDR(uio_idr
);
43 static const struct file_operations uio_fops
;
45 /* UIO class infrastructure */
46 static struct uio_class
{
51 /* Protect idr accesses */
52 static DEFINE_MUTEX(minor_lock
);
62 #define to_map(map) container_of(map, struct uio_map, kobj)
64 static ssize_t
map_addr_show(struct uio_mem
*mem
, char *buf
)
66 return sprintf(buf
, "0x%lx\n", mem
->addr
);
69 static ssize_t
map_size_show(struct uio_mem
*mem
, char *buf
)
71 return sprintf(buf
, "0x%lx\n", mem
->size
);
74 static ssize_t
map_offset_show(struct uio_mem
*mem
, char *buf
)
76 return sprintf(buf
, "0x%lx\n", mem
->addr
& ~PAGE_MASK
);
79 struct map_sysfs_entry
{
80 struct attribute attr
;
81 ssize_t (*show
)(struct uio_mem
*, char *);
82 ssize_t (*store
)(struct uio_mem
*, const char *, size_t);
85 static struct map_sysfs_entry addr_attribute
=
86 __ATTR(addr
, S_IRUGO
, map_addr_show
, NULL
);
87 static struct map_sysfs_entry size_attribute
=
88 __ATTR(size
, S_IRUGO
, map_size_show
, NULL
);
89 static struct map_sysfs_entry offset_attribute
=
90 __ATTR(offset
, S_IRUGO
, map_offset_show
, NULL
);
92 static struct attribute
*attrs
[] = {
95 &offset_attribute
.attr
,
96 NULL
, /* need to NULL terminate the list of attributes */
99 static void map_release(struct kobject
*kobj
)
101 struct uio_map
*map
= to_map(kobj
);
105 static ssize_t
map_type_show(struct kobject
*kobj
, struct attribute
*attr
,
108 struct uio_map
*map
= to_map(kobj
);
109 struct uio_mem
*mem
= map
->mem
;
110 struct map_sysfs_entry
*entry
;
112 entry
= container_of(attr
, struct map_sysfs_entry
, attr
);
117 return entry
->show(mem
, buf
);
120 static struct sysfs_ops map_sysfs_ops
= {
121 .show
= map_type_show
,
124 static struct kobj_type map_attr_type
= {
125 .release
= map_release
,
126 .sysfs_ops
= &map_sysfs_ops
,
127 .default_attrs
= attrs
,
132 struct uio_port
*port
;
134 #define to_portio(portio) container_of(portio, struct uio_portio, kobj)
136 static ssize_t
portio_start_show(struct uio_port
*port
, char *buf
)
138 return sprintf(buf
, "0x%lx\n", port
->start
);
141 static ssize_t
portio_size_show(struct uio_port
*port
, char *buf
)
143 return sprintf(buf
, "0x%lx\n", port
->size
);
146 static ssize_t
portio_porttype_show(struct uio_port
*port
, char *buf
)
148 const char *porttypes
[] = {"none", "x86", "gpio", "other"};
150 if ((port
->porttype
< 0) || (port
->porttype
> UIO_PORT_OTHER
))
153 return sprintf(buf
, "port_%s\n", porttypes
[port
->porttype
]);
156 struct portio_sysfs_entry
{
157 struct attribute attr
;
158 ssize_t (*show
)(struct uio_port
*, char *);
159 ssize_t (*store
)(struct uio_port
*, const char *, size_t);
162 static struct portio_sysfs_entry portio_start_attribute
=
163 __ATTR(start
, S_IRUGO
, portio_start_show
, NULL
);
164 static struct portio_sysfs_entry portio_size_attribute
=
165 __ATTR(size
, S_IRUGO
, portio_size_show
, NULL
);
166 static struct portio_sysfs_entry portio_porttype_attribute
=
167 __ATTR(porttype
, S_IRUGO
, portio_porttype_show
, NULL
);
169 static struct attribute
*portio_attrs
[] = {
170 &portio_start_attribute
.attr
,
171 &portio_size_attribute
.attr
,
172 &portio_porttype_attribute
.attr
,
176 static void portio_release(struct kobject
*kobj
)
178 struct uio_portio
*portio
= to_portio(kobj
);
182 static ssize_t
portio_type_show(struct kobject
*kobj
, struct attribute
*attr
,
185 struct uio_portio
*portio
= to_portio(kobj
);
186 struct uio_port
*port
= portio
->port
;
187 struct portio_sysfs_entry
*entry
;
189 entry
= container_of(attr
, struct portio_sysfs_entry
, attr
);
194 return entry
->show(port
, buf
);
197 static struct sysfs_ops portio_sysfs_ops
= {
198 .show
= portio_type_show
,
201 static struct kobj_type portio_attr_type
= {
202 .release
= portio_release
,
203 .sysfs_ops
= &portio_sysfs_ops
,
204 .default_attrs
= portio_attrs
,
207 static ssize_t
show_name(struct device
*dev
,
208 struct device_attribute
*attr
, char *buf
)
210 struct uio_device
*idev
= dev_get_drvdata(dev
);
212 return sprintf(buf
, "%s\n", idev
->info
->name
);
216 static DEVICE_ATTR(name
, S_IRUGO
, show_name
, NULL
);
218 static ssize_t
show_version(struct device
*dev
,
219 struct device_attribute
*attr
, char *buf
)
221 struct uio_device
*idev
= dev_get_drvdata(dev
);
223 return sprintf(buf
, "%s\n", idev
->info
->version
);
227 static DEVICE_ATTR(version
, S_IRUGO
, show_version
, NULL
);
229 static ssize_t
show_event(struct device
*dev
,
230 struct device_attribute
*attr
, char *buf
)
232 struct uio_device
*idev
= dev_get_drvdata(dev
);
234 return sprintf(buf
, "%u\n",
235 (unsigned int)atomic_read(&idev
->event
));
239 static DEVICE_ATTR(event
, S_IRUGO
, show_event
, NULL
);
241 static struct attribute
*uio_attrs
[] = {
243 &dev_attr_version
.attr
,
244 &dev_attr_event
.attr
,
248 static struct attribute_group uio_attr_grp
= {
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 ret
= sysfs_create_group(&idev
->dev
->kobj
, &uio_attr_grp
);
270 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
271 mem
= &idev
->info
->mem
[mi
];
276 idev
->map_dir
= kobject_create_and_add("maps",
281 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
)
306 portio
= kzalloc(sizeof(*portio
), GFP_KERNEL
);
309 kobject_init(&portio
->kobj
, &portio_attr_type
);
311 port
->portio
= portio
;
312 ret
= kobject_add(&portio
->kobj
, idev
->portio_dir
,
316 ret
= kobject_uevent(&portio
->kobj
, KOBJ_ADD
);
324 for (pi
--; pi
>= 0; pi
--) {
325 port
= &idev
->info
->port
[pi
];
326 portio
= port
->portio
;
327 kobject_put(&portio
->kobj
);
329 kobject_put(idev
->portio_dir
);
331 for (mi
--; mi
>=0; mi
--) {
332 mem
= &idev
->info
->mem
[mi
];
334 kobject_put(&map
->kobj
);
336 kobject_put(idev
->map_dir
);
337 sysfs_remove_group(&idev
->dev
->kobj
, &uio_attr_grp
);
339 dev_err(idev
->dev
, "error creating sysfs files (%d)\n", ret
);
343 static void uio_dev_del_attributes(struct uio_device
*idev
)
347 struct uio_port
*port
;
349 for (i
= 0; i
< MAX_UIO_MAPS
; i
++) {
350 mem
= &idev
->info
->mem
[i
];
353 kobject_put(&mem
->map
->kobj
);
355 kobject_put(idev
->map_dir
);
357 for (i
= 0; i
< MAX_UIO_PORT_REGIONS
; i
++) {
358 port
= &idev
->info
->port
[i
];
361 kobject_put(&port
->portio
->kobj
);
363 kobject_put(idev
->portio_dir
);
365 sysfs_remove_group(&idev
->dev
->kobj
, &uio_attr_grp
);
368 static int uio_get_minor(struct uio_device
*idev
)
370 int retval
= -ENOMEM
;
373 mutex_lock(&minor_lock
);
374 if (idr_pre_get(&uio_idr
, GFP_KERNEL
) == 0)
377 retval
= idr_get_new(&uio_idr
, idev
, &id
);
379 if (retval
== -EAGAIN
)
383 idev
->minor
= id
& MAX_ID_MASK
;
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
== UIO_IRQ_NONE
)
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
== UIO_IRQ_NONE
)
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 if (copy_to_user(buf
, &event_count
, count
))
538 listener
->event_count
= event_count
;
544 if (filep
->f_flags
& O_NONBLOCK
) {
549 if (signal_pending(current
)) {
550 retval
= -ERESTARTSYS
;
556 __set_current_state(TASK_RUNNING
);
557 remove_wait_queue(&idev
->wait
, &wait
);
562 static ssize_t
uio_write(struct file
*filep
, const char __user
*buf
,
563 size_t count
, loff_t
*ppos
)
565 struct uio_listener
*listener
= filep
->private_data
;
566 struct uio_device
*idev
= listener
->dev
;
570 if (idev
->info
->irq
== UIO_IRQ_NONE
)
573 if (count
!= sizeof(s32
))
576 if (!idev
->info
->irqcontrol
)
579 if (copy_from_user(&irq_on
, buf
, count
))
582 retval
= idev
->info
->irqcontrol(idev
->info
, irq_on
);
584 return retval
? retval
: sizeof(s32
);
587 static int uio_find_mem_index(struct vm_area_struct
*vma
)
590 struct uio_device
*idev
= vma
->vm_private_data
;
592 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
593 if (idev
->info
->mem
[mi
].size
== 0)
595 if (vma
->vm_pgoff
== mi
)
601 static void uio_vma_open(struct vm_area_struct
*vma
)
603 struct uio_device
*idev
= vma
->vm_private_data
;
607 static void uio_vma_close(struct vm_area_struct
*vma
)
609 struct uio_device
*idev
= vma
->vm_private_data
;
613 static int uio_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
615 struct uio_device
*idev
= vma
->vm_private_data
;
617 unsigned long offset
;
619 int mi
= uio_find_mem_index(vma
);
621 return VM_FAULT_SIGBUS
;
624 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
627 offset
= (vmf
->pgoff
- mi
) << PAGE_SHIFT
;
629 if (idev
->info
->mem
[mi
].memtype
== UIO_MEM_LOGICAL
)
630 page
= virt_to_page(idev
->info
->mem
[mi
].addr
+ offset
);
632 page
= vmalloc_to_page((void *)idev
->info
->mem
[mi
].addr
639 static struct vm_operations_struct uio_vm_ops
= {
640 .open
= uio_vma_open
,
641 .close
= uio_vma_close
,
642 .fault
= uio_vma_fault
,
645 static int uio_mmap_physical(struct vm_area_struct
*vma
)
647 struct uio_device
*idev
= vma
->vm_private_data
;
648 int mi
= uio_find_mem_index(vma
);
652 vma
->vm_flags
|= VM_IO
| VM_RESERVED
;
654 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
656 return remap_pfn_range(vma
,
658 idev
->info
->mem
[mi
].addr
>> PAGE_SHIFT
,
659 vma
->vm_end
- vma
->vm_start
,
663 static int uio_mmap_logical(struct vm_area_struct
*vma
)
665 vma
->vm_flags
|= VM_RESERVED
;
666 vma
->vm_ops
= &uio_vm_ops
;
671 static int uio_mmap(struct file
*filep
, struct vm_area_struct
*vma
)
673 struct uio_listener
*listener
= filep
->private_data
;
674 struct uio_device
*idev
= listener
->dev
;
676 unsigned long requested_pages
, actual_pages
;
679 if (vma
->vm_end
< vma
->vm_start
)
682 vma
->vm_private_data
= idev
;
684 mi
= uio_find_mem_index(vma
);
688 requested_pages
= (vma
->vm_end
- vma
->vm_start
) >> PAGE_SHIFT
;
689 actual_pages
= (idev
->info
->mem
[mi
].size
+ PAGE_SIZE
-1) >> PAGE_SHIFT
;
690 if (requested_pages
> actual_pages
)
693 if (idev
->info
->mmap
) {
694 ret
= idev
->info
->mmap(idev
->info
, vma
);
698 switch (idev
->info
->mem
[mi
].memtype
) {
700 return uio_mmap_physical(vma
);
701 case UIO_MEM_LOGICAL
:
702 case UIO_MEM_VIRTUAL
:
703 return uio_mmap_logical(vma
);
709 static const struct file_operations uio_fops
= {
710 .owner
= THIS_MODULE
,
712 .release
= uio_release
,
717 .fasync
= uio_fasync
,
720 static int uio_major_init(void)
722 uio_major
= register_chrdev(0, "uio", &uio_fops
);
728 static void uio_major_cleanup(void)
730 unregister_chrdev(uio_major
, "uio");
733 static int init_uio_class(void)
737 if (uio_class
!= NULL
) {
738 kref_get(&uio_class
->kref
);
742 /* This is the first time in here, set everything up properly */
743 ret
= uio_major_init();
747 uio_class
= kzalloc(sizeof(*uio_class
), GFP_KERNEL
);
753 kref_init(&uio_class
->kref
);
754 uio_class
->class = class_create(THIS_MODULE
, "uio");
755 if (IS_ERR(uio_class
->class)) {
756 ret
= IS_ERR(uio_class
->class);
757 printk(KERN_ERR
"class_create failed for uio\n");
758 goto err_class_create
;
771 static void release_uio_class(struct kref
*kref
)
773 /* Ok, we cheat as we know we only have one uio_class */
774 class_destroy(uio_class
->class);
780 static void uio_class_destroy(void)
783 kref_put(&uio_class
->kref
, release_uio_class
);
787 * uio_register_device - register a new userspace IO device
788 * @owner: module that creates the new device
789 * @parent: parent device
790 * @info: UIO device capabilities
792 * returns zero on success or a negative error code.
794 int __uio_register_device(struct module
*owner
,
795 struct device
*parent
,
796 struct uio_info
*info
)
798 struct uio_device
*idev
;
801 if (!parent
|| !info
|| !info
->name
|| !info
->version
)
804 info
->uio_dev
= NULL
;
806 ret
= init_uio_class();
810 idev
= kzalloc(sizeof(*idev
), GFP_KERNEL
);
818 init_waitqueue_head(&idev
->wait
);
819 atomic_set(&idev
->event
, 0);
821 ret
= uio_get_minor(idev
);
825 idev
->dev
= device_create(uio_class
->class, parent
,
826 MKDEV(uio_major
, idev
->minor
), idev
,
827 "uio%d", idev
->minor
);
828 if (IS_ERR(idev
->dev
)) {
829 printk(KERN_ERR
"UIO: device register failed\n");
830 ret
= PTR_ERR(idev
->dev
);
831 goto err_device_create
;
834 ret
= uio_dev_add_attributes(idev
);
836 goto err_uio_dev_add_attributes
;
838 info
->uio_dev
= idev
;
840 if (idev
->info
->irq
>= 0) {
841 ret
= request_irq(idev
->info
->irq
, uio_interrupt
,
842 idev
->info
->irq_flags
, idev
->info
->name
, idev
);
844 goto err_request_irq
;
850 uio_dev_del_attributes(idev
);
851 err_uio_dev_add_attributes
:
852 device_destroy(uio_class
->class, MKDEV(uio_major
, idev
->minor
));
854 uio_free_minor(idev
);
861 EXPORT_SYMBOL_GPL(__uio_register_device
);
864 * uio_unregister_device - unregister a industrial IO device
865 * @info: UIO device capabilities
868 void uio_unregister_device(struct uio_info
*info
)
870 struct uio_device
*idev
;
872 if (!info
|| !info
->uio_dev
)
875 idev
= info
->uio_dev
;
877 uio_free_minor(idev
);
880 free_irq(info
->irq
, idev
);
882 uio_dev_del_attributes(idev
);
884 dev_set_drvdata(idev
->dev
, NULL
);
885 device_destroy(uio_class
->class, MKDEV(uio_major
, idev
->minor
));
891 EXPORT_SYMBOL_GPL(uio_unregister_device
);
893 static int __init
uio_init(void)
898 static void __exit
uio_exit(void)
902 module_init(uio_init
)
903 module_exit(uio_exit
)
904 MODULE_LICENSE("GPL v2");