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
name_show(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
);
232 static DEVICE_ATTR_RO(name
);
234 static ssize_t
version_show(struct device
*dev
,
235 struct device_attribute
*attr
, char *buf
)
237 struct uio_device
*idev
= dev_get_drvdata(dev
);
238 return sprintf(buf
, "%s\n", idev
->info
->version
);
240 static DEVICE_ATTR_RO(version
);
242 static ssize_t
event_show(struct device
*dev
,
243 struct device_attribute
*attr
, char *buf
)
245 struct uio_device
*idev
= dev_get_drvdata(dev
);
246 return sprintf(buf
, "%u\n", (unsigned int)atomic_read(&idev
->event
));
248 static DEVICE_ATTR_RO(event
);
250 static struct attribute
*uio_attrs
[] = {
252 &dev_attr_version
.attr
,
253 &dev_attr_event
.attr
,
256 ATTRIBUTE_GROUPS(uio
);
258 /* UIO class infrastructure */
259 static struct class uio_class
= {
261 .dev_groups
= uio_groups
,
267 static int uio_dev_add_attributes(struct uio_device
*idev
)
272 int portio_found
= 0;
275 struct uio_port
*port
;
276 struct uio_portio
*portio
;
278 for (mi
= 0; mi
< MAX_UIO_MAPS
; mi
++) {
279 mem
= &idev
->info
->mem
[mi
];
284 idev
->map_dir
= kobject_create_and_add("maps",
289 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
292 kobject_init(&map
->kobj
, &map_attr_type
);
295 ret
= kobject_add(&map
->kobj
, idev
->map_dir
, "map%d", mi
);
298 ret
= kobject_uevent(&map
->kobj
, KOBJ_ADD
);
303 for (pi
= 0; pi
< MAX_UIO_PORT_REGIONS
; pi
++) {
304 port
= &idev
->info
->port
[pi
];
309 idev
->portio_dir
= kobject_create_and_add("portio",
311 if (!idev
->portio_dir
)
314 portio
= kzalloc(sizeof(*portio
), GFP_KERNEL
);
317 kobject_init(&portio
->kobj
, &portio_attr_type
);
319 port
->portio
= portio
;
320 ret
= kobject_add(&portio
->kobj
, idev
->portio_dir
,
324 ret
= kobject_uevent(&portio
->kobj
, KOBJ_ADD
);
332 for (pi
--; pi
>= 0; pi
--) {
333 port
= &idev
->info
->port
[pi
];
334 portio
= port
->portio
;
335 kobject_put(&portio
->kobj
);
337 kobject_put(idev
->portio_dir
);
339 for (mi
--; mi
>=0; mi
--) {
340 mem
= &idev
->info
->mem
[mi
];
342 kobject_put(&map
->kobj
);
344 kobject_put(idev
->map_dir
);
345 dev_err(idev
->dev
, "error creating sysfs files (%d)\n", ret
);
349 static void uio_dev_del_attributes(struct uio_device
*idev
)
353 struct uio_port
*port
;
355 for (i
= 0; i
< MAX_UIO_MAPS
; i
++) {
356 mem
= &idev
->info
->mem
[i
];
359 kobject_put(&mem
->map
->kobj
);
361 kobject_put(idev
->map_dir
);
363 for (i
= 0; i
< MAX_UIO_PORT_REGIONS
; i
++) {
364 port
= &idev
->info
->port
[i
];
367 kobject_put(&port
->portio
->kobj
);
369 kobject_put(idev
->portio_dir
);
372 static int uio_get_minor(struct uio_device
*idev
)
374 int retval
= -ENOMEM
;
376 mutex_lock(&minor_lock
);
377 retval
= idr_alloc(&uio_idr
, idev
, 0, UIO_MAX_DEVICES
, GFP_KERNEL
);
379 idev
->minor
= retval
;
381 } else if (retval
== -ENOSPC
) {
382 dev_err(idev
->dev
, "too many uio devices\n");
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
)
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
)
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
)
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
)
589 struct uio_device
*idev
= vma
->vm_private_data
;
591 if (vma
->vm_pgoff
< MAX_UIO_MAPS
) {
592 if (idev
->info
->mem
[vma
->vm_pgoff
].size
== 0)
594 return (int)vma
->vm_pgoff
;
599 static int uio_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
601 struct uio_device
*idev
= vma
->vm_private_data
;
603 unsigned long offset
;
605 int mi
= uio_find_mem_index(vma
);
607 return VM_FAULT_SIGBUS
;
610 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
613 offset
= (vmf
->pgoff
- mi
) << PAGE_SHIFT
;
615 if (idev
->info
->mem
[mi
].memtype
== UIO_MEM_LOGICAL
)
616 page
= virt_to_page(idev
->info
->mem
[mi
].addr
+ offset
);
618 page
= vmalloc_to_page((void *)(unsigned long)idev
->info
->mem
[mi
].addr
+ offset
);
624 static const struct vm_operations_struct uio_logical_vm_ops
= {
625 .fault
= uio_vma_fault
,
628 static int uio_mmap_logical(struct vm_area_struct
*vma
)
630 vma
->vm_flags
|= VM_DONTEXPAND
| VM_DONTDUMP
;
631 vma
->vm_ops
= &uio_logical_vm_ops
;
635 static const struct vm_operations_struct uio_physical_vm_ops
= {
636 #ifdef CONFIG_HAVE_IOREMAP_PROT
637 .access
= generic_access_phys
,
641 static int uio_mmap_physical(struct vm_area_struct
*vma
)
643 struct uio_device
*idev
= vma
->vm_private_data
;
644 int mi
= uio_find_mem_index(vma
);
648 mem
= idev
->info
->mem
+ mi
;
650 if (vma
->vm_end
- vma
->vm_start
> mem
->size
)
653 vma
->vm_ops
= &uio_physical_vm_ops
;
654 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
657 * We cannot use the vm_iomap_memory() helper here,
658 * because vma->vm_pgoff is the map index we looked
659 * up above in uio_find_mem_index(), rather than an
660 * actual page offset into the mmap.
662 * So we just do the physical mmap without a page
665 return remap_pfn_range(vma
,
667 mem
->addr
>> PAGE_SHIFT
,
668 vma
->vm_end
- vma
->vm_start
,
672 static int uio_mmap(struct file
*filep
, struct vm_area_struct
*vma
)
674 struct uio_listener
*listener
= filep
->private_data
;
675 struct uio_device
*idev
= listener
->dev
;
677 unsigned long requested_pages
, actual_pages
;
680 if (vma
->vm_end
< vma
->vm_start
)
683 vma
->vm_private_data
= idev
;
685 mi
= uio_find_mem_index(vma
);
689 requested_pages
= vma_pages(vma
);
690 actual_pages
= ((idev
->info
->mem
[mi
].addr
& ~PAGE_MASK
)
691 + idev
->info
->mem
[mi
].size
+ PAGE_SIZE
-1) >> PAGE_SHIFT
;
692 if (requested_pages
> actual_pages
)
695 if (idev
->info
->mmap
) {
696 ret
= idev
->info
->mmap(idev
->info
, vma
);
700 switch (idev
->info
->mem
[mi
].memtype
) {
702 return uio_mmap_physical(vma
);
703 case UIO_MEM_LOGICAL
:
704 case UIO_MEM_VIRTUAL
:
705 return uio_mmap_logical(vma
);
711 static const struct file_operations uio_fops
= {
712 .owner
= THIS_MODULE
,
714 .release
= uio_release
,
719 .fasync
= uio_fasync
,
720 .llseek
= noop_llseek
,
723 static int uio_major_init(void)
725 static const char name
[] = "uio";
726 struct cdev
*cdev
= NULL
;
730 result
= alloc_chrdev_region(&uio_dev
, 0, UIO_MAX_DEVICES
, name
);
739 cdev
->owner
= THIS_MODULE
;
740 cdev
->ops
= &uio_fops
;
741 kobject_set_name(&cdev
->kobj
, "%s", name
);
743 result
= cdev_add(cdev
, uio_dev
, UIO_MAX_DEVICES
);
747 uio_major
= MAJOR(uio_dev
);
751 kobject_put(&cdev
->kobj
);
753 unregister_chrdev_region(uio_dev
, UIO_MAX_DEVICES
);
758 static void uio_major_cleanup(void)
760 unregister_chrdev_region(MKDEV(uio_major
, 0), UIO_MAX_DEVICES
);
764 static int init_uio_class(void)
768 /* This is the first time in here, set everything up properly */
769 ret
= uio_major_init();
773 ret
= class_register(&uio_class
);
775 printk(KERN_ERR
"class_register failed for uio\n");
776 goto err_class_register
;
786 static void release_uio_class(void)
788 class_unregister(&uio_class
);
793 * uio_register_device - register a new userspace IO device
794 * @owner: module that creates the new device
795 * @parent: parent device
796 * @info: UIO device capabilities
798 * returns zero on success or a negative error code.
800 int __uio_register_device(struct module
*owner
,
801 struct device
*parent
,
802 struct uio_info
*info
)
804 struct uio_device
*idev
;
807 if (!parent
|| !info
|| !info
->name
|| !info
->version
)
810 info
->uio_dev
= NULL
;
812 idev
= kzalloc(sizeof(*idev
), GFP_KERNEL
);
820 init_waitqueue_head(&idev
->wait
);
821 atomic_set(&idev
->event
, 0);
823 ret
= uio_get_minor(idev
);
827 idev
->dev
= device_create(&uio_class
, parent
,
828 MKDEV(uio_major
, idev
->minor
), idev
,
829 "uio%d", idev
->minor
);
830 if (IS_ERR(idev
->dev
)) {
831 printk(KERN_ERR
"UIO: device register failed\n");
832 ret
= PTR_ERR(idev
->dev
);
833 goto err_device_create
;
836 ret
= uio_dev_add_attributes(idev
);
838 goto err_uio_dev_add_attributes
;
840 info
->uio_dev
= idev
;
842 if (info
->irq
&& (info
->irq
!= UIO_IRQ_CUSTOM
)) {
843 ret
= request_irq(info
->irq
, uio_interrupt
,
844 info
->irq_flags
, info
->name
, idev
);
846 goto err_request_irq
;
852 uio_dev_del_attributes(idev
);
853 err_uio_dev_add_attributes
:
854 device_destroy(&uio_class
, MKDEV(uio_major
, idev
->minor
));
856 uio_free_minor(idev
);
862 EXPORT_SYMBOL_GPL(__uio_register_device
);
865 * uio_unregister_device - unregister a industrial IO device
866 * @info: UIO device capabilities
869 void uio_unregister_device(struct uio_info
*info
)
871 struct uio_device
*idev
;
873 if (!info
|| !info
->uio_dev
)
876 idev
= info
->uio_dev
;
878 uio_free_minor(idev
);
880 if (info
->irq
&& (info
->irq
!= UIO_IRQ_CUSTOM
))
881 free_irq(info
->irq
, idev
);
883 uio_dev_del_attributes(idev
);
885 device_destroy(&uio_class
, MKDEV(uio_major
, idev
->minor
));
890 EXPORT_SYMBOL_GPL(uio_unregister_device
);
892 static int __init
uio_init(void)
894 return init_uio_class();
897 static void __exit
uio_exit(void)
902 module_init(uio_init
)
903 module_exit(uio_exit
)
904 MODULE_LICENSE("GPL v2");