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;
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 /* Protect idr accesses */
50 static DEFINE_MUTEX(minor_lock);
60 #define to_map(map) container_of(map, struct uio_map, kobj)
62 static ssize_t map_name_show(struct uio_mem *mem, char *buf)
64 if (unlikely(!mem->name))
67 return sprintf(buf, "%s\n", mem->name);
70 static ssize_t map_addr_show(struct uio_mem *mem, char *buf)
72 return sprintf(buf, "0x%llx\n", (unsigned long long)mem->addr);
75 static ssize_t map_size_show(struct uio_mem *mem, char *buf)
77 return sprintf(buf, "0x%lx\n", mem->size);
80 static ssize_t map_offset_show(struct uio_mem *mem, char *buf)
82 return sprintf(buf, "0x%llx\n", (unsigned long long)mem->addr & ~PAGE_MASK);
85 struct map_sysfs_entry {
86 struct attribute attr;
87 ssize_t (*show)(struct uio_mem *, char *);
88 ssize_t (*store)(struct uio_mem *, const char *, size_t);
91 static struct map_sysfs_entry name_attribute =
92 __ATTR(name, S_IRUGO, map_name_show, NULL);
93 static struct map_sysfs_entry addr_attribute =
94 __ATTR(addr, S_IRUGO, map_addr_show, NULL);
95 static struct map_sysfs_entry size_attribute =
96 __ATTR(size, S_IRUGO, map_size_show, NULL);
97 static struct map_sysfs_entry offset_attribute =
98 __ATTR(offset, S_IRUGO, map_offset_show, NULL);
100 static struct attribute *attrs[] = {
101 &name_attribute.attr,
102 &addr_attribute.attr,
103 &size_attribute.attr,
104 &offset_attribute.attr,
105 NULL, /* need to NULL terminate the list of attributes */
108 static void map_release(struct kobject *kobj)
110 struct uio_map *map = to_map(kobj);
114 static ssize_t map_type_show(struct kobject *kobj, struct attribute *attr,
117 struct uio_map *map = to_map(kobj);
118 struct uio_mem *mem = map->mem;
119 struct map_sysfs_entry *entry;
121 entry = container_of(attr, struct map_sysfs_entry, attr);
126 return entry->show(mem, buf);
129 static const struct sysfs_ops map_sysfs_ops = {
130 .show = map_type_show,
133 static struct kobj_type map_attr_type = {
134 .release = map_release,
135 .sysfs_ops = &map_sysfs_ops,
136 .default_attrs = attrs,
141 struct uio_port *port;
143 #define to_portio(portio) container_of(portio, struct uio_portio, kobj)
145 static ssize_t portio_name_show(struct uio_port *port, char *buf)
147 if (unlikely(!port->name))
150 return sprintf(buf, "%s\n", port->name);
153 static ssize_t portio_start_show(struct uio_port *port, char *buf)
155 return sprintf(buf, "0x%lx\n", port->start);
158 static ssize_t portio_size_show(struct uio_port *port, char *buf)
160 return sprintf(buf, "0x%lx\n", port->size);
163 static ssize_t portio_porttype_show(struct uio_port *port, char *buf)
165 const char *porttypes[] = {"none", "x86", "gpio", "other"};
167 if ((port->porttype < 0) || (port->porttype > UIO_PORT_OTHER))
170 return sprintf(buf, "port_%s\n", porttypes[port->porttype]);
173 struct portio_sysfs_entry {
174 struct attribute attr;
175 ssize_t (*show)(struct uio_port *, char *);
176 ssize_t (*store)(struct uio_port *, const char *, size_t);
179 static struct portio_sysfs_entry portio_name_attribute =
180 __ATTR(name, S_IRUGO, portio_name_show, NULL);
181 static struct portio_sysfs_entry portio_start_attribute =
182 __ATTR(start, S_IRUGO, portio_start_show, NULL);
183 static struct portio_sysfs_entry portio_size_attribute =
184 __ATTR(size, S_IRUGO, portio_size_show, NULL);
185 static struct portio_sysfs_entry portio_porttype_attribute =
186 __ATTR(porttype, S_IRUGO, portio_porttype_show, NULL);
188 static struct attribute *portio_attrs[] = {
189 &portio_name_attribute.attr,
190 &portio_start_attribute.attr,
191 &portio_size_attribute.attr,
192 &portio_porttype_attribute.attr,
196 static void portio_release(struct kobject *kobj)
198 struct uio_portio *portio = to_portio(kobj);
202 static ssize_t portio_type_show(struct kobject *kobj, struct attribute *attr,
205 struct uio_portio *portio = to_portio(kobj);
206 struct uio_port *port = portio->port;
207 struct portio_sysfs_entry *entry;
209 entry = container_of(attr, struct portio_sysfs_entry, attr);
214 return entry->show(port, buf);
217 static const struct sysfs_ops portio_sysfs_ops = {
218 .show = portio_type_show,
221 static struct kobj_type portio_attr_type = {
222 .release = portio_release,
223 .sysfs_ops = &portio_sysfs_ops,
224 .default_attrs = portio_attrs,
227 static ssize_t show_name(struct device *dev,
228 struct device_attribute *attr, char *buf)
230 struct uio_device *idev = dev_get_drvdata(dev);
231 return sprintf(buf, "%s\n", idev->info->name);
234 static ssize_t show_version(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);
241 static ssize_t show_event(struct device *dev,
242 struct device_attribute *attr, char *buf)
244 struct uio_device *idev = dev_get_drvdata(dev);
245 return sprintf(buf, "%u\n", (unsigned int)atomic_read(&idev->event));
248 static struct device_attribute uio_class_attributes[] = {
249 __ATTR(name, S_IRUGO, show_name, NULL),
250 __ATTR(version, S_IRUGO, show_version, NULL),
251 __ATTR(event, S_IRUGO, show_event, NULL),
255 /* UIO class infrastructure */
256 static struct class uio_class = {
258 .dev_attrs = uio_class_attributes,
264 static int uio_dev_add_attributes(struct uio_device *idev)
269 int portio_found = 0;
272 struct uio_port *port;
273 struct uio_portio *portio;
275 for (mi = 0; mi < MAX_UIO_MAPS; mi++) {
276 mem = &idev->info->mem[mi];
281 idev->map_dir = kobject_create_and_add("maps",
286 map = kzalloc(sizeof(*map), GFP_KERNEL);
289 kobject_init(&map->kobj, &map_attr_type);
292 ret = kobject_add(&map->kobj, idev->map_dir, "map%d", mi);
295 ret = kobject_uevent(&map->kobj, KOBJ_ADD);
300 for (pi = 0; pi < MAX_UIO_PORT_REGIONS; pi++) {
301 port = &idev->info->port[pi];
306 idev->portio_dir = kobject_create_and_add("portio",
308 if (!idev->portio_dir)
311 portio = kzalloc(sizeof(*portio), GFP_KERNEL);
314 kobject_init(&portio->kobj, &portio_attr_type);
316 port->portio = portio;
317 ret = kobject_add(&portio->kobj, idev->portio_dir,
321 ret = kobject_uevent(&portio->kobj, KOBJ_ADD);
329 for (pi--; pi >= 0; pi--) {
330 port = &idev->info->port[pi];
331 portio = port->portio;
332 kobject_put(&portio->kobj);
334 kobject_put(idev->portio_dir);
336 for (mi--; mi>=0; mi--) {
337 mem = &idev->info->mem[mi];
339 kobject_put(&map->kobj);
341 kobject_put(idev->map_dir);
342 dev_err(idev->dev, "error creating sysfs files (%d)\n", ret);
346 static void uio_dev_del_attributes(struct uio_device *idev)
350 struct uio_port *port;
352 for (i = 0; i < MAX_UIO_MAPS; i++) {
353 mem = &idev->info->mem[i];
356 kobject_put(&mem->map->kobj);
358 kobject_put(idev->map_dir);
360 for (i = 0; i < MAX_UIO_PORT_REGIONS; i++) {
361 port = &idev->info->port[i];
364 kobject_put(&port->portio->kobj);
366 kobject_put(idev->portio_dir);
369 static int uio_get_minor(struct uio_device *idev)
371 int retval = -ENOMEM;
373 mutex_lock(&minor_lock);
374 retval = idr_alloc(&uio_idr, idev, 0, UIO_MAX_DEVICES, GFP_KERNEL);
376 idev->minor = retval;
378 } else if (retval == -ENOSPC) {
379 dev_err(idev->dev, "too many uio devices\n");
382 mutex_unlock(&minor_lock);
386 static void uio_free_minor(struct uio_device *idev)
388 mutex_lock(&minor_lock);
389 idr_remove(&uio_idr, idev->minor);
390 mutex_unlock(&minor_lock);
394 * uio_event_notify - trigger an interrupt event
395 * @info: UIO device capabilities
397 void uio_event_notify(struct uio_info *info)
399 struct uio_device *idev = info->uio_dev;
401 atomic_inc(&idev->event);
402 wake_up_interruptible(&idev->wait);
403 kill_fasync(&idev->async_queue, SIGIO, POLL_IN);
405 EXPORT_SYMBOL_GPL(uio_event_notify);
408 * uio_interrupt - hardware interrupt handler
409 * @irq: IRQ number, can be UIO_IRQ_CYCLIC for cyclic timer
410 * @dev_id: Pointer to the devices uio_device structure
412 static irqreturn_t uio_interrupt(int irq, void *dev_id)
414 struct uio_device *idev = (struct uio_device *)dev_id;
415 irqreturn_t ret = idev->info->handler(irq, idev->info);
417 if (ret == IRQ_HANDLED)
418 uio_event_notify(idev->info);
423 struct uio_listener {
424 struct uio_device *dev;
428 static int uio_open(struct inode *inode, struct file *filep)
430 struct uio_device *idev;
431 struct uio_listener *listener;
434 mutex_lock(&minor_lock);
435 idev = idr_find(&uio_idr, iminor(inode));
436 mutex_unlock(&minor_lock);
442 if (!try_module_get(idev->owner)) {
447 listener = kmalloc(sizeof(*listener), GFP_KERNEL);
450 goto err_alloc_listener;
453 listener->dev = idev;
454 listener->event_count = atomic_read(&idev->event);
455 filep->private_data = listener;
457 if (idev->info->open) {
458 ret = idev->info->open(idev->info, inode);
468 module_put(idev->owner);
474 static int uio_fasync(int fd, struct file *filep, int on)
476 struct uio_listener *listener = filep->private_data;
477 struct uio_device *idev = listener->dev;
479 return fasync_helper(fd, filep, on, &idev->async_queue);
482 static int uio_release(struct inode *inode, struct file *filep)
485 struct uio_listener *listener = filep->private_data;
486 struct uio_device *idev = listener->dev;
488 if (idev->info->release)
489 ret = idev->info->release(idev->info, inode);
491 module_put(idev->owner);
496 static unsigned int uio_poll(struct file *filep, poll_table *wait)
498 struct uio_listener *listener = filep->private_data;
499 struct uio_device *idev = listener->dev;
501 if (!idev->info->irq)
504 poll_wait(filep, &idev->wait, wait);
505 if (listener->event_count != atomic_read(&idev->event))
506 return POLLIN | POLLRDNORM;
510 static ssize_t uio_read(struct file *filep, char __user *buf,
511 size_t count, loff_t *ppos)
513 struct uio_listener *listener = filep->private_data;
514 struct uio_device *idev = listener->dev;
515 DECLARE_WAITQUEUE(wait, current);
519 if (!idev->info->irq)
522 if (count != sizeof(s32))
525 add_wait_queue(&idev->wait, &wait);
528 set_current_state(TASK_INTERRUPTIBLE);
530 event_count = atomic_read(&idev->event);
531 if (event_count != listener->event_count) {
532 if (copy_to_user(buf, &event_count, count))
535 listener->event_count = event_count;
541 if (filep->f_flags & O_NONBLOCK) {
546 if (signal_pending(current)) {
547 retval = -ERESTARTSYS;
553 __set_current_state(TASK_RUNNING);
554 remove_wait_queue(&idev->wait, &wait);
559 static ssize_t uio_write(struct file *filep, const char __user *buf,
560 size_t count, loff_t *ppos)
562 struct uio_listener *listener = filep->private_data;
563 struct uio_device *idev = listener->dev;
567 if (!idev->info->irq)
570 if (count != sizeof(s32))
573 if (!idev->info->irqcontrol)
576 if (copy_from_user(&irq_on, buf, count))
579 retval = idev->info->irqcontrol(idev->info, irq_on);
581 return retval ? retval : sizeof(s32);
584 static int uio_find_mem_index(struct vm_area_struct *vma)
586 struct uio_device *idev = vma->vm_private_data;
588 if (vma->vm_pgoff < MAX_UIO_MAPS) {
589 if (idev->info->mem[vma->vm_pgoff].size == 0)
591 return (int)vma->vm_pgoff;
596 static void uio_vma_open(struct vm_area_struct *vma)
598 struct uio_device *idev = vma->vm_private_data;
602 static void uio_vma_close(struct vm_area_struct *vma)
604 struct uio_device *idev = vma->vm_private_data;
608 static int uio_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
610 struct uio_device *idev = vma->vm_private_data;
612 unsigned long offset;
614 int mi = uio_find_mem_index(vma);
616 return VM_FAULT_SIGBUS;
619 * We need to subtract mi because userspace uses offset = N*PAGE_SIZE
622 offset = (vmf->pgoff - mi) << PAGE_SHIFT;
624 if (idev->info->mem[mi].memtype == UIO_MEM_LOGICAL)
625 page = virt_to_page(idev->info->mem[mi].addr + offset);
627 page = vmalloc_to_page((void *)(unsigned long)idev->info->mem[mi].addr + offset);
633 static const struct vm_operations_struct uio_logical_vm_ops = {
634 .open = uio_vma_open,
635 .close = uio_vma_close,
636 .fault = uio_vma_fault,
639 static int uio_mmap_logical(struct vm_area_struct *vma)
641 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
642 vma->vm_ops = &uio_logical_vm_ops;
647 static const struct vm_operations_struct uio_physical_vm_ops = {
648 #ifdef CONFIG_HAVE_IOREMAP_PROT
649 .access = generic_access_phys,
653 static int uio_mmap_physical(struct vm_area_struct *vma)
655 struct uio_device *idev = vma->vm_private_data;
656 int mi = uio_find_mem_index(vma);
660 mem = idev->info->mem + mi;
662 if (vma->vm_end - vma->vm_start > mem->size)
665 vma->vm_ops = &uio_physical_vm_ops;
666 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
669 * We cannot use the vm_iomap_memory() helper here,
670 * because vma->vm_pgoff is the map index we looked
671 * up above in uio_find_mem_index(), rather than an
672 * actual page offset into the mmap.
674 * So we just do the physical mmap without a page
677 return remap_pfn_range(vma,
679 mem->addr >> PAGE_SHIFT,
680 vma->vm_end - vma->vm_start,
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,
732 .llseek = noop_llseek,
735 static int uio_major_init(void)
737 static const char name[] = "uio";
738 struct cdev *cdev = NULL;
742 result = alloc_chrdev_region(&uio_dev, 0, UIO_MAX_DEVICES, name);
751 cdev->owner = THIS_MODULE;
752 cdev->ops = &uio_fops;
753 kobject_set_name(&cdev->kobj, "%s", name);
755 result = cdev_add(cdev, uio_dev, UIO_MAX_DEVICES);
759 uio_major = MAJOR(uio_dev);
763 kobject_put(&cdev->kobj);
765 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)
780 /* This is the first time in here, set everything up properly */
781 ret = uio_major_init();
785 ret = class_register(&uio_class);
787 printk(KERN_ERR "class_register failed for uio\n");
788 goto err_class_register;
798 static void release_uio_class(void)
800 class_unregister(&uio_class);
805 * uio_register_device - register a new userspace IO device
806 * @owner: module that creates the new device
807 * @parent: parent device
808 * @info: UIO device capabilities
810 * returns zero on success or a negative error code.
812 int __uio_register_device(struct module *owner,
813 struct device *parent,
814 struct uio_info *info)
816 struct uio_device *idev;
819 if (!parent || !info || !info->name || !info->version)
822 info->uio_dev = NULL;
824 idev = kzalloc(sizeof(*idev), GFP_KERNEL);
832 init_waitqueue_head(&idev->wait);
833 atomic_set(&idev->event, 0);
835 ret = uio_get_minor(idev);
839 idev->dev = device_create(&uio_class, parent,
840 MKDEV(uio_major, idev->minor), idev,
841 "uio%d", idev->minor);
842 if (IS_ERR(idev->dev)) {
843 printk(KERN_ERR "UIO: device register failed\n");
844 ret = PTR_ERR(idev->dev);
845 goto err_device_create;
848 ret = uio_dev_add_attributes(idev);
850 goto err_uio_dev_add_attributes;
852 info->uio_dev = idev;
854 if (info->irq && (info->irq != UIO_IRQ_CUSTOM)) {
855 ret = request_irq(info->irq, uio_interrupt,
856 info->irq_flags, info->name, idev);
858 goto err_request_irq;
864 uio_dev_del_attributes(idev);
865 err_uio_dev_add_attributes:
866 device_destroy(&uio_class, MKDEV(uio_major, idev->minor));
868 uio_free_minor(idev);
874 EXPORT_SYMBOL_GPL(__uio_register_device);
877 * uio_unregister_device - unregister a industrial IO device
878 * @info: UIO device capabilities
881 void uio_unregister_device(struct uio_info *info)
883 struct uio_device *idev;
885 if (!info || !info->uio_dev)
888 idev = info->uio_dev;
890 uio_free_minor(idev);
892 if (info->irq && (info->irq != UIO_IRQ_CUSTOM))
893 free_irq(info->irq, idev);
895 uio_dev_del_attributes(idev);
897 device_destroy(&uio_class, MKDEV(uio_major, idev->minor));
902 EXPORT_SYMBOL_GPL(uio_unregister_device);
904 static int __init uio_init(void)
906 return init_uio_class();
909 static void __exit uio_exit(void)
914 module_init(uio_init)
915 module_exit(uio_exit)
916 MODULE_LICENSE("GPL v2");