2 * VMEbus User access driver
4 * Author: Martyn Welch <martyn.welch@ge.com>
5 * Copyright 2008 GE Intelligent Platforms Embedded Systems, Inc.
8 * Tom Armistead and Ajit Prem
9 * Copyright 2004 Motorola Inc.
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version.
18 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
20 #include <linux/cdev.h>
21 #include <linux/delay.h>
22 #include <linux/device.h>
23 #include <linux/dma-mapping.h>
24 #include <linux/errno.h>
25 #include <linux/init.h>
26 #include <linux/ioctl.h>
27 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/pagemap.h>
31 #include <linux/pci.h>
32 #include <linux/mutex.h>
33 #include <linux/slab.h>
34 #include <linux/spinlock.h>
35 #include <linux/syscalls.h>
36 #include <linux/types.h>
39 #include <linux/uaccess.h>
40 #include <linux/vme.h>
44 static DEFINE_MUTEX(vme_user_mutex);
45 static const char driver_name[] = "vme_user";
47 static int bus[VME_USER_BUS_MAX];
48 static unsigned int bus_num;
50 /* Currently Documentation/devices.txt defines the following for VME:
53 * 0 = /dev/bus/vme/m0 First master image
54 * 1 = /dev/bus/vme/m1 Second master image
55 * 2 = /dev/bus/vme/m2 Third master image
56 * 3 = /dev/bus/vme/m3 Fourth master image
57 * 4 = /dev/bus/vme/s0 First slave image
58 * 5 = /dev/bus/vme/s1 Second slave image
59 * 6 = /dev/bus/vme/s2 Third slave image
60 * 7 = /dev/bus/vme/s3 Fourth slave image
61 * 8 = /dev/bus/vme/ctl Control
63 * It is expected that all VME bus drivers will use the
64 * same interface. For interface documentation see
65 * http://www.vmelinux.org/.
67 * However the VME driver at http://www.vmelinux.org/ is rather old and doesn't
68 * even support the tsi148 chipset (which has 8 master and 8 slave windows).
69 * We'll run with this for now as far as possible, however it probably makes
70 * sense to get rid of the old mappings and just do everything dynamically.
72 * So for now, we'll restrict the driver to providing 4 masters and 4 slaves as
73 * defined above and try to support at least some of the interface from
74 * http://www.vmelinux.org/ as an alternative the driver can be written
75 * providing a saner interface later.
77 * The vmelinux.org driver never supported slave images, the devices reserved
78 * for slaves were repurposed to support all 8 master images on the UniverseII!
79 * We shall support 4 masters and 4 slaves with this driver.
81 #define VME_MAJOR 221 /* VME Major Device Number */
82 #define VME_DEVS 9 /* Number of dev entries */
84 #define MASTER_MINOR 0
88 #define CONTROL_MINOR 8
90 #define PCI_BUF_SIZE 0x20000 /* Size of one slave image buffer */
93 * Structure to handle image related parameters.
96 void *kern_buf; /* Buffer address in kernel space */
97 dma_addr_t pci_buf; /* Buffer address in PCI address space */
98 unsigned long long size_buf; /* Buffer size */
99 struct mutex mutex; /* Mutex for locking image */
100 struct device *device; /* Sysfs device */
101 struct vme_resource *resource; /* VME resource */
102 int users; /* Number of current users */
104 static struct image_desc image[VME_DEVS];
106 struct driver_stats {
108 unsigned long writes;
109 unsigned long ioctls;
112 unsigned long dmaErrors;
113 unsigned long timeouts;
114 unsigned long external;
116 static struct driver_stats statistics;
118 static struct cdev *vme_user_cdev; /* Character device */
119 static struct class *vme_user_sysfs_class; /* Sysfs class */
120 static struct vme_dev *vme_user_bridge; /* Pointer to user device */
123 static const int type[VME_DEVS] = { MASTER_MINOR, MASTER_MINOR,
124 MASTER_MINOR, MASTER_MINOR,
125 SLAVE_MINOR, SLAVE_MINOR,
126 SLAVE_MINOR, SLAVE_MINOR,
131 static int vme_user_open(struct inode *, struct file *);
132 static int vme_user_release(struct inode *, struct file *);
133 static ssize_t vme_user_read(struct file *, char __user *, size_t, loff_t *);
134 static ssize_t vme_user_write(struct file *, const char __user *, size_t,
136 static loff_t vme_user_llseek(struct file *, loff_t, int);
137 static long vme_user_unlocked_ioctl(struct file *, unsigned int, unsigned long);
139 static int vme_user_match(struct vme_dev *);
140 static int vme_user_probe(struct vme_dev *);
141 static int vme_user_remove(struct vme_dev *);
143 static const struct file_operations vme_user_fops = {
144 .open = vme_user_open,
145 .release = vme_user_release,
146 .read = vme_user_read,
147 .write = vme_user_write,
148 .llseek = vme_user_llseek,
149 .unlocked_ioctl = vme_user_unlocked_ioctl,
154 * Reset all the statistic counters
156 static void reset_counters(void)
158 statistics.reads = 0;
159 statistics.writes = 0;
160 statistics.ioctls = 0;
162 statistics.berrs = 0;
163 statistics.dmaErrors = 0;
164 statistics.timeouts = 0;
167 static int vme_user_open(struct inode *inode, struct file *file)
170 unsigned int minor = MINOR(inode->i_rdev);
172 mutex_lock(&image[minor].mutex);
173 /* Allow device to be opened if a resource is needed and allocated. */
174 if (minor < CONTROL_MINOR && image[minor].resource == NULL) {
175 pr_err("No resources allocated for device\n");
180 /* Increment user count */
181 image[minor].users++;
183 mutex_unlock(&image[minor].mutex);
188 mutex_unlock(&image[minor].mutex);
193 static int vme_user_release(struct inode *inode, struct file *file)
195 unsigned int minor = MINOR(inode->i_rdev);
197 mutex_lock(&image[minor].mutex);
199 /* Decrement user count */
200 image[minor].users--;
202 mutex_unlock(&image[minor].mutex);
208 * We are going ot alloc a page during init per window for small transfers.
209 * Small transfers will go VME -> buffer -> user space. Larger (more than a
210 * page) transfers will lock the user space buffer into memory and then
211 * transfer the data directly into the user space buffers.
213 static ssize_t resource_to_user(int minor, char __user *buf, size_t count,
219 if (count <= image[minor].size_buf) {
220 /* We copy to kernel buffer */
221 copied = vme_master_read(image[minor].resource,
222 image[minor].kern_buf, count, *ppos);
226 retval = __copy_to_user(buf, image[minor].kern_buf,
227 (unsigned long)copied);
229 copied = (copied - retval);
230 pr_info("User copy failed\n");
235 /* XXX Need to write this */
236 pr_info("Currently don't support large transfers\n");
237 /* Map in pages from userspace */
239 /* Call vme_master_read to do the transfer */
247 * We are going to alloc a page during init per window for small transfers.
248 * Small transfers will go user space -> buffer -> VME. Larger (more than a
249 * page) transfers will lock the user space buffer into memory and then
250 * transfer the data directly from the user space buffers out to VME.
252 static ssize_t resource_from_user(unsigned int minor, const char __user *buf,
253 size_t count, loff_t *ppos)
258 if (count <= image[minor].size_buf) {
259 retval = __copy_from_user(image[minor].kern_buf, buf,
260 (unsigned long)count);
262 copied = (copied - retval);
266 copied = vme_master_write(image[minor].resource,
267 image[minor].kern_buf, copied, *ppos);
269 /* XXX Need to write this */
270 pr_info("Currently don't support large transfers\n");
271 /* Map in pages from userspace */
273 /* Call vme_master_write to do the transfer */
280 static ssize_t buffer_to_user(unsigned int minor, char __user *buf,
281 size_t count, loff_t *ppos)
286 image_ptr = image[minor].kern_buf + *ppos;
288 retval = __copy_to_user(buf, image_ptr, (unsigned long)count);
290 retval = (count - retval);
291 pr_warn("Partial copy to userspace\n");
295 /* Return number of bytes successfully read */
299 static ssize_t buffer_from_user(unsigned int minor, const char __user *buf,
300 size_t count, loff_t *ppos)
305 image_ptr = image[minor].kern_buf + *ppos;
307 retval = __copy_from_user(image_ptr, buf, (unsigned long)count);
309 retval = (count - retval);
310 pr_warn("Partial copy to userspace\n");
314 /* Return number of bytes successfully read */
318 static ssize_t vme_user_read(struct file *file, char __user *buf, size_t count,
321 unsigned int minor = MINOR(file_inode(file)->i_rdev);
326 if (minor == CONTROL_MINOR)
329 mutex_lock(&image[minor].mutex);
331 /* XXX Do we *really* want this helper - we can use vme_*_get ? */
332 image_size = vme_get_size(image[minor].resource);
334 /* Ensure we are starting at a valid location */
335 if ((*ppos < 0) || (*ppos > (image_size - 1))) {
336 mutex_unlock(&image[minor].mutex);
340 /* Ensure not reading past end of the image */
341 if (*ppos + count > image_size)
342 okcount = image_size - *ppos;
346 switch (type[minor]) {
348 retval = resource_to_user(minor, buf, okcount, ppos);
351 retval = buffer_to_user(minor, buf, okcount, ppos);
357 mutex_unlock(&image[minor].mutex);
364 static ssize_t vme_user_write(struct file *file, const char __user *buf,
365 size_t count, loff_t *ppos)
367 unsigned int minor = MINOR(file_inode(file)->i_rdev);
372 if (minor == CONTROL_MINOR)
375 mutex_lock(&image[minor].mutex);
377 image_size = vme_get_size(image[minor].resource);
379 /* Ensure we are starting at a valid location */
380 if ((*ppos < 0) || (*ppos > (image_size - 1))) {
381 mutex_unlock(&image[minor].mutex);
385 /* Ensure not reading past end of the image */
386 if (*ppos + count > image_size)
387 okcount = image_size - *ppos;
391 switch (type[minor]) {
393 retval = resource_from_user(minor, buf, okcount, ppos);
396 retval = buffer_from_user(minor, buf, okcount, ppos);
402 mutex_unlock(&image[minor].mutex);
410 static loff_t vme_user_llseek(struct file *file, loff_t off, int whence)
412 loff_t absolute = -1;
413 unsigned int minor = MINOR(file_inode(file)->i_rdev);
416 if (minor == CONTROL_MINOR)
419 mutex_lock(&image[minor].mutex);
420 image_size = vme_get_size(image[minor].resource);
427 absolute = file->f_pos + off;
430 absolute = image_size + off;
433 mutex_unlock(&image[minor].mutex);
438 if ((absolute < 0) || (absolute >= image_size)) {
439 mutex_unlock(&image[minor].mutex);
443 file->f_pos = absolute;
445 mutex_unlock(&image[minor].mutex);
451 * The ioctls provided by the old VME access method (the one at vmelinux.org)
452 * are most certainly wrong as the effectively push the registers layout
453 * through to user space. Given that the VME core can handle multiple bridges,
454 * with different register layouts this is most certainly not the way to go.
456 * We aren't using the structures defined in the Motorola driver either - these
457 * are also quite low level, however we should use the definitions that have
458 * already been defined.
460 static int vme_user_ioctl(struct inode *inode, struct file *file,
461 unsigned int cmd, unsigned long arg)
463 struct vme_master master;
464 struct vme_slave slave;
465 struct vme_irq_id irq_req;
466 unsigned long copied;
467 unsigned int minor = MINOR(inode->i_rdev);
470 void __user *argp = (void __user *)arg;
474 switch (type[minor]) {
478 copied = copy_from_user(&irq_req, argp,
479 sizeof(struct vme_irq_id));
481 pr_warn("Partial copy from userspace\n");
485 retval = vme_irq_generate(vme_user_bridge,
495 memset(&master, 0, sizeof(struct vme_master));
497 /* XXX We do not want to push aspace, cycle and width
498 * to userspace as they are
500 retval = vme_master_get(image[minor].resource,
501 &master.enable, &master.vme_addr,
502 &master.size, &master.aspace,
503 &master.cycle, &master.dwidth);
505 copied = copy_to_user(argp, &master,
506 sizeof(struct vme_master));
508 pr_warn("Partial copy to userspace\n");
517 copied = copy_from_user(&master, argp, sizeof(master));
519 pr_warn("Partial copy from userspace\n");
523 /* XXX We do not want to push aspace, cycle and width
524 * to userspace as they are
526 return vme_master_set(image[minor].resource,
527 master.enable, master.vme_addr, master.size,
528 master.aspace, master.cycle, master.dwidth);
536 memset(&slave, 0, sizeof(struct vme_slave));
538 /* XXX We do not want to push aspace, cycle and width
539 * to userspace as they are
541 retval = vme_slave_get(image[minor].resource,
542 &slave.enable, &slave.vme_addr,
543 &slave.size, &pci_addr, &slave.aspace,
546 copied = copy_to_user(argp, &slave,
547 sizeof(struct vme_slave));
549 pr_warn("Partial copy to userspace\n");
558 copied = copy_from_user(&slave, argp, sizeof(slave));
560 pr_warn("Partial copy from userspace\n");
564 /* XXX We do not want to push aspace, cycle and width
565 * to userspace as they are
567 return vme_slave_set(image[minor].resource,
568 slave.enable, slave.vme_addr, slave.size,
569 image[minor].pci_buf, slave.aspace,
581 vme_user_unlocked_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
585 mutex_lock(&vme_user_mutex);
586 ret = vme_user_ioctl(file_inode(file), file, cmd, arg);
587 mutex_unlock(&vme_user_mutex);
594 * Unallocate a previously allocated buffer
596 static void buf_unalloc(int num)
598 if (image[num].kern_buf) {
600 pr_debug("UniverseII:Releasing buffer at %p\n",
604 vme_free_consistent(image[num].resource, image[num].size_buf,
605 image[num].kern_buf, image[num].pci_buf);
607 image[num].kern_buf = NULL;
608 image[num].pci_buf = 0;
609 image[num].size_buf = 0;
613 pr_debug("UniverseII: Buffer not allocated\n");
618 static struct vme_driver vme_user_driver = {
620 .match = vme_user_match,
621 .probe = vme_user_probe,
622 .remove = vme_user_remove,
626 static int __init vme_user_init(void)
630 pr_info("VME User Space Access Driver\n");
633 pr_err("No cards, skipping registration\n");
638 /* Let's start by supporting one bus, we can support more than one
639 * in future revisions if that ever becomes necessary.
641 if (bus_num > VME_USER_BUS_MAX) {
642 pr_err("Driver only able to handle %d buses\n",
644 bus_num = VME_USER_BUS_MAX;
648 * Here we just register the maximum number of devices we can and
649 * leave vme_user_match() to allow only 1 to go through to probe().
650 * This way, if we later want to allow multiple user access devices,
651 * we just change the code in vme_user_match().
653 retval = vme_register_driver(&vme_user_driver, VME_MAX_SLOTS);
664 static int vme_user_match(struct vme_dev *vdev)
666 if (vdev->num >= VME_USER_BUS_MAX)
672 * In this simple access driver, the old behaviour is being preserved as much
673 * as practical. We will therefore reserve the buffers and request the images
674 * here so that we don't have to do it later.
676 static int vme_user_probe(struct vme_dev *vdev)
681 /* Save pointer to the bridge device */
682 if (vme_user_bridge != NULL) {
683 dev_err(&vdev->dev, "Driver can only be loaded for 1 device\n");
687 vme_user_bridge = vdev;
689 /* Initialise descriptors */
690 for (i = 0; i < VME_DEVS; i++) {
691 image[i].kern_buf = NULL;
692 image[i].pci_buf = 0;
693 mutex_init(&image[i].mutex);
694 image[i].device = NULL;
695 image[i].resource = NULL;
699 /* Initialise statistics counters */
702 /* Assign major and minor numbers for the driver */
703 err = register_chrdev_region(MKDEV(VME_MAJOR, 0), VME_DEVS,
706 dev_warn(&vdev->dev, "Error getting Major Number %d for driver.\n",
711 /* Register the driver as a char device */
712 vme_user_cdev = cdev_alloc();
713 vme_user_cdev->ops = &vme_user_fops;
714 vme_user_cdev->owner = THIS_MODULE;
715 err = cdev_add(vme_user_cdev, MKDEV(VME_MAJOR, 0), VME_DEVS);
717 dev_warn(&vdev->dev, "cdev_all failed\n");
721 /* Request slave resources and allocate buffers (128kB wide) */
722 for (i = SLAVE_MINOR; i < (SLAVE_MAX + 1); i++) {
723 /* XXX Need to properly request attributes */
724 /* For ca91cx42 bridge there are only two slave windows
725 * supporting A16 addressing, so we request A24 supported
728 image[i].resource = vme_slave_request(vme_user_bridge,
730 if (image[i].resource == NULL) {
732 "Unable to allocate slave resource\n");
735 image[i].size_buf = PCI_BUF_SIZE;
736 image[i].kern_buf = vme_alloc_consistent(image[i].resource,
737 image[i].size_buf, &image[i].pci_buf);
738 if (image[i].kern_buf == NULL) {
740 "Unable to allocate memory for buffer\n");
741 image[i].pci_buf = 0;
742 vme_slave_free(image[i].resource);
749 * Request master resources allocate page sized buffers for small
752 for (i = MASTER_MINOR; i < (MASTER_MAX + 1); i++) {
753 /* XXX Need to properly request attributes */
754 image[i].resource = vme_master_request(vme_user_bridge,
755 VME_A32, VME_SCT, VME_D32);
756 if (image[i].resource == NULL) {
758 "Unable to allocate master resource\n");
761 image[i].size_buf = PCI_BUF_SIZE;
762 image[i].kern_buf = kmalloc(image[i].size_buf, GFP_KERNEL);
763 if (image[i].kern_buf == NULL) {
765 "Unable to allocate memory for master window buffers\n");
771 /* Create sysfs entries - on udev systems this creates the dev files */
772 vme_user_sysfs_class = class_create(THIS_MODULE, driver_name);
773 if (IS_ERR(vme_user_sysfs_class)) {
774 dev_err(&vdev->dev, "Error creating vme_user class.\n");
775 err = PTR_ERR(vme_user_sysfs_class);
779 /* Add sysfs Entries */
780 for (i = 0; i < VME_DEVS; i++) {
784 sprintf(name, "bus/vme/m%%d");
787 sprintf(name, "bus/vme/ctl");
790 sprintf(name, "bus/vme/s%%d");
798 num = (type[i] == SLAVE_MINOR) ? i - (MASTER_MAX + 1) : i;
799 image[i].device = device_create(vme_user_sysfs_class, NULL,
800 MKDEV(VME_MAJOR, i), NULL, name, num);
801 if (IS_ERR(image[i].device)) {
802 dev_info(&vdev->dev, "Error creating sysfs device\n");
803 err = PTR_ERR(image[i].device);
810 /* Ensure counter set correcty to destroy all sysfs devices */
815 device_destroy(vme_user_sysfs_class, MKDEV(VME_MAJOR, i));
817 class_destroy(vme_user_sysfs_class);
819 /* Ensure counter set correcty to unalloc all master windows */
822 for (i = MASTER_MINOR; i < (MASTER_MAX + 1); i++)
823 kfree(image[i].kern_buf);
825 while (i > MASTER_MINOR) {
827 vme_master_free(image[i].resource);
831 * Ensure counter set correcty to unalloc all slave windows and buffers
835 while (i > SLAVE_MINOR) {
838 vme_slave_free(image[i].resource);
841 cdev_del(vme_user_cdev);
843 unregister_chrdev_region(MKDEV(VME_MAJOR, 0), VME_DEVS);
849 static int vme_user_remove(struct vme_dev *dev)
853 /* Remove sysfs Entries */
854 for (i = 0; i < VME_DEVS; i++) {
855 mutex_destroy(&image[i].mutex);
856 device_destroy(vme_user_sysfs_class, MKDEV(VME_MAJOR, i));
858 class_destroy(vme_user_sysfs_class);
860 for (i = MASTER_MINOR; i < (MASTER_MAX + 1); i++) {
861 kfree(image[i].kern_buf);
862 vme_master_free(image[i].resource);
865 for (i = SLAVE_MINOR; i < (SLAVE_MAX + 1); i++) {
866 vme_slave_set(image[i].resource, 0, 0, 0, 0, VME_A32, 0);
868 vme_slave_free(image[i].resource);
871 /* Unregister device driver */
872 cdev_del(vme_user_cdev);
874 /* Unregiser the major and minor device numbers */
875 unregister_chrdev_region(MKDEV(VME_MAJOR, 0), VME_DEVS);
880 static void __exit vme_user_exit(void)
882 vme_unregister_driver(&vme_user_driver);
886 MODULE_PARM_DESC(bus, "Enumeration of VMEbus to which the driver is connected");
887 module_param_array(bus, int, &bus_num, 0);
889 MODULE_DESCRIPTION("VME User Space Access Driver");
890 MODULE_AUTHOR("Martyn Welch <martyn.welch@ge.com");
891 MODULE_LICENSE("GPL");
893 module_init(vme_user_init);
894 module_exit(vme_user_exit);