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 #include <linux/cdev.h>
19 #include <linux/delay.h>
20 #include <linux/device.h>
21 #include <linux/dma-mapping.h>
22 #include <linux/errno.h>
23 #include <linux/init.h>
24 #include <linux/ioctl.h>
25 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/pagemap.h>
29 #include <linux/pci.h>
30 #include <linux/semaphore.h>
31 #include <linux/slab.h>
32 #include <linux/spinlock.h>
33 #include <linux/syscalls.h>
34 #include <linux/mutex.h>
35 #include <linux/types.h>
38 #include <linux/uaccess.h>
43 static DEFINE_MUTEX(vme_user_mutex
);
44 static char driver_name
[] = "vme_user";
46 static int bus
[USER_BUS_MAX
];
49 /* Currently Documentation/devices.txt defines the following for VME:
52 * 0 = /dev/bus/vme/m0 First master image
53 * 1 = /dev/bus/vme/m1 Second master image
54 * 2 = /dev/bus/vme/m2 Third master image
55 * 3 = /dev/bus/vme/m3 Fourth master image
56 * 4 = /dev/bus/vme/s0 First slave image
57 * 5 = /dev/bus/vme/s1 Second slave image
58 * 6 = /dev/bus/vme/s2 Third slave image
59 * 7 = /dev/bus/vme/s3 Fourth slave image
60 * 8 = /dev/bus/vme/ctl Control
62 * It is expected that all VME bus drivers will use the
63 * same interface. For interface documentation see
64 * http://www.vmelinux.org/.
66 * However the VME driver at http://www.vmelinux.org/ is rather old and doesn't
67 * even support the tsi148 chipset (which has 8 master and 8 slave windows).
68 * We'll run with this or now as far as possible, however it probably makes
69 * sense to get rid of the old mappings and just do everything dynamically.
71 * So for now, we'll restrict the driver to providing 4 masters and 4 slaves as
72 * defined above and try to support at least some of the interface from
73 * http://www.vmelinux.org/ as an alternative drive can be written providing a
74 * saner interface later.
76 * The vmelinux.org driver never supported slave images, the devices reserved
77 * for slaves were repurposed to support all 8 master images on the UniverseII!
78 * We shall support 4 masters and 4 slaves with this driver.
80 #define VME_MAJOR 221 /* VME Major Device Number */
81 #define VME_DEVS 9 /* Number of dev entries */
83 #define MASTER_MINOR 0
87 #define CONTROL_MINOR 8
89 #define PCI_BUF_SIZE 0x20000 /* Size of one slave image buffer */
92 * Structure to handle image related parameters.
95 void __iomem
*kern_buf
; /* Buffer address in kernel space */
96 dma_addr_t pci_buf
; /* Buffer address in PCI address space */
97 unsigned long long size_buf
; /* Buffer size */
98 struct semaphore sem
; /* Semaphore for locking image */
99 struct device
*device
; /* Sysfs device */
100 struct vme_resource
*resource
; /* VME resource */
101 int users
; /* Number of current users */
103 static image_desc_t image
[VME_DEVS
];
107 unsigned long writes
;
108 unsigned long ioctls
;
111 unsigned long dmaErrors
;
112 unsigned long timeouts
;
113 unsigned long external
;
115 static driver_stats_t statistics
;
117 struct cdev
*vme_user_cdev
; /* Character device */
118 struct class *vme_user_sysfs_class
; /* Sysfs class */
119 struct device
*vme_user_bridge
; /* Pointer to the bridge device */
122 static const int type
[VME_DEVS
] = { MASTER_MINOR
, MASTER_MINOR
,
123 MASTER_MINOR
, MASTER_MINOR
,
124 SLAVE_MINOR
, SLAVE_MINOR
,
125 SLAVE_MINOR
, SLAVE_MINOR
,
130 static int vme_user_open(struct inode
*, struct file
*);
131 static int vme_user_release(struct inode
*, struct file
*);
132 static ssize_t
vme_user_read(struct file
*, char *, size_t, loff_t
*);
133 static ssize_t
vme_user_write(struct file
*, const char *, size_t, loff_t
*);
134 static loff_t
vme_user_llseek(struct file
*, loff_t
, int);
135 static long vme_user_unlocked_ioctl(struct file
*, unsigned int, unsigned long);
137 static int __init
vme_user_probe(struct device
*, int, int);
138 static int __exit
vme_user_remove(struct device
*, int, int);
140 static struct file_operations vme_user_fops
= {
141 .open
= vme_user_open
,
142 .release
= vme_user_release
,
143 .read
= vme_user_read
,
144 .write
= vme_user_write
,
145 .llseek
= vme_user_llseek
,
146 .unlocked_ioctl
= vme_user_unlocked_ioctl
,
151 * Reset all the statistic counters
153 static void reset_counters(void)
155 statistics
.reads
= 0;
156 statistics
.writes
= 0;
157 statistics
.ioctls
= 0;
159 statistics
.berrs
= 0;
160 statistics
.dmaErrors
= 0;
161 statistics
.timeouts
= 0;
164 static int vme_user_open(struct inode
*inode
, struct file
*file
)
167 unsigned int minor
= MINOR(inode
->i_rdev
);
169 down(&image
[minor
].sem
);
170 /* Only allow device to be opened if a resource is allocated */
171 if (image
[minor
].resource
== NULL
) {
172 printk(KERN_ERR
"No resources allocated for device\n");
177 /* Increment user count */
178 image
[minor
].users
++;
180 up(&image
[minor
].sem
);
185 up(&image
[minor
].sem
);
190 static int vme_user_release(struct inode
*inode
, struct file
*file
)
192 unsigned int minor
= MINOR(inode
->i_rdev
);
194 down(&image
[minor
].sem
);
196 /* Decrement user count */
197 image
[minor
].users
--;
199 up(&image
[minor
].sem
);
205 * We are going ot alloc a page during init per window for small transfers.
206 * Small transfers will go VME -> buffer -> user space. Larger (more than a
207 * page) transfers will lock the user space buffer into memory and then
208 * transfer the data directly into the user space buffers.
210 static ssize_t
resource_to_user(int minor
, char __user
*buf
, size_t count
,
216 if (count
<= image
[minor
].size_buf
) {
217 /* We copy to kernel buffer */
218 copied
= vme_master_read(image
[minor
].resource
,
219 image
[minor
].kern_buf
, count
, *ppos
);
223 retval
= __copy_to_user(buf
, image
[minor
].kern_buf
,
224 (unsigned long)copied
);
226 copied
= (copied
- retval
);
227 printk(KERN_INFO
"User copy failed\n");
232 printk(KERN_INFO
"Currently don't support large transfers\n");
233 /* Map in pages from userspace */
235 /* Call vme_master_read to do the transfer */
243 * We are going ot alloc a page during init per window for small transfers.
244 * Small transfers will go user space -> buffer -> VME. Larger (more than a
245 * page) transfers will lock the user space buffer into memory and then
246 * transfer the data directly from the user space buffers out to VME.
248 static ssize_t
resource_from_user(unsigned int minor
, const char *buf
,
249 size_t count
, loff_t
*ppos
)
254 if (count
<= image
[minor
].size_buf
) {
255 retval
= __copy_from_user(image
[minor
].kern_buf
, buf
,
256 (unsigned long)count
);
258 copied
= (copied
- retval
);
262 copied
= vme_master_write(image
[minor
].resource
,
263 image
[minor
].kern_buf
, copied
, *ppos
);
265 printk(KERN_INFO
"Currently don't support large transfers\n");
266 /* Map in pages from userspace */
268 /* Call vme_master_write to do the transfer */
275 static ssize_t
buffer_to_user(unsigned int minor
, char __user
*buf
,
276 size_t count
, loff_t
*ppos
)
278 void __iomem
*image_ptr
;
281 image_ptr
= image
[minor
].kern_buf
+ *ppos
;
283 retval
= __copy_to_user(buf
, image_ptr
, (unsigned long)count
);
285 retval
= (count
- retval
);
286 printk(KERN_WARNING
"Partial copy to userspace\n");
290 /* Return number of bytes successfully read */
294 static ssize_t
buffer_from_user(unsigned int minor
, const char *buf
,
295 size_t count
, loff_t
*ppos
)
297 void __iomem
*image_ptr
;
300 image_ptr
= image
[minor
].kern_buf
+ *ppos
;
302 retval
= __copy_from_user(image_ptr
, buf
, (unsigned long)count
);
304 retval
= (count
- retval
);
305 printk(KERN_WARNING
"Partial copy to userspace\n");
309 /* Return number of bytes successfully read */
313 static ssize_t
vme_user_read(struct file
*file
, char *buf
, size_t count
,
316 unsigned int minor
= MINOR(file
->f_dentry
->d_inode
->i_rdev
);
321 down(&image
[minor
].sem
);
323 image_size
= vme_get_size(image
[minor
].resource
);
325 /* Ensure we are starting at a valid location */
326 if ((*ppos
< 0) || (*ppos
> (image_size
- 1))) {
327 up(&image
[minor
].sem
);
331 /* Ensure not reading past end of the image */
332 if (*ppos
+ count
> image_size
)
333 okcount
= image_size
- *ppos
;
337 switch (type
[minor
]) {
339 retval
= resource_to_user(minor
, buf
, okcount
, ppos
);
342 retval
= buffer_to_user(minor
, buf
, okcount
, ppos
);
348 up(&image
[minor
].sem
);
356 static ssize_t
vme_user_write(struct file
*file
, const char *buf
, size_t count
,
359 unsigned int minor
= MINOR(file
->f_dentry
->d_inode
->i_rdev
);
364 down(&image
[minor
].sem
);
366 image_size
= vme_get_size(image
[minor
].resource
);
368 /* Ensure we are starting at a valid location */
369 if ((*ppos
< 0) || (*ppos
> (image_size
- 1))) {
370 up(&image
[minor
].sem
);
374 /* Ensure not reading past end of the image */
375 if (*ppos
+ count
> image_size
)
376 okcount
= image_size
- *ppos
;
380 switch (type
[minor
]) {
382 retval
= resource_from_user(minor
, buf
, okcount
, ppos
);
385 retval
= buffer_from_user(minor
, buf
, okcount
, ppos
);
391 up(&image
[minor
].sem
);
399 static loff_t
vme_user_llseek(struct file
*file
, loff_t off
, int whence
)
401 loff_t absolute
= -1;
402 unsigned int minor
= MINOR(file
->f_dentry
->d_inode
->i_rdev
);
405 down(&image
[minor
].sem
);
406 image_size
= vme_get_size(image
[minor
].resource
);
413 absolute
= file
->f_pos
+ off
;
416 absolute
= image_size
+ off
;
419 up(&image
[minor
].sem
);
424 if ((absolute
< 0) || (absolute
>= image_size
)) {
425 up(&image
[minor
].sem
);
429 file
->f_pos
= absolute
;
431 up(&image
[minor
].sem
);
437 * The ioctls provided by the old VME access method (the one at vmelinux.org)
438 * are most certainly wrong as the effectively push the registers layout
439 * through to user space. Given that the VME core can handle multiple bridges,
440 * with different register layouts this is most certainly not the way to go.
442 * We aren't using the structures defined in the Motorola driver either - these
443 * are also quite low level, however we should use the definitions that have
444 * already been defined.
446 static int vme_user_ioctl(struct inode
*inode
, struct file
*file
,
447 unsigned int cmd
, unsigned long arg
)
449 struct vme_master master
;
450 struct vme_slave slave
;
451 unsigned long copied
;
452 unsigned int minor
= MINOR(inode
->i_rdev
);
458 switch (type
[minor
]) {
464 memset(&master
, 0, sizeof(struct vme_master
));
466 retval
= vme_master_get(image
[minor
].resource
,
467 &(master
.enable
), &(master
.vme_addr
),
468 &(master
.size
), &(master
.aspace
),
469 &(master
.cycle
), &(master
.dwidth
));
471 copied
= copy_to_user((char *)arg
, &master
,
472 sizeof(struct vme_master
));
474 printk(KERN_WARNING
"Partial copy to "
484 copied
= copy_from_user(&master
, (char *)arg
,
487 printk(KERN_WARNING
"Partial copy from "
492 return vme_master_set(image
[minor
].resource
,
493 master
.enable
, master
.vme_addr
, master
.size
,
494 master
.aspace
, master
.cycle
, master
.dwidth
);
502 memset(&slave
, 0, sizeof(struct vme_slave
));
504 retval
= vme_slave_get(image
[minor
].resource
,
505 &(slave
.enable
), &(slave
.vme_addr
),
506 &(slave
.size
), &pci_addr
, &(slave
.aspace
),
509 copied
= copy_to_user((char *)arg
, &slave
,
510 sizeof(struct vme_slave
));
512 printk(KERN_WARNING
"Partial copy to "
522 copied
= copy_from_user(&slave
, (char *)arg
,
525 printk(KERN_WARNING
"Partial copy from "
530 return vme_slave_set(image
[minor
].resource
,
531 slave
.enable
, slave
.vme_addr
, slave
.size
,
532 image
[minor
].pci_buf
, slave
.aspace
,
544 vme_user_unlocked_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
548 mutex_lock(&vme_user_mutex
);
549 ret
= vme_user_ioctl(file
->f_path
.dentry
->d_inode
, file
, cmd
, arg
);
550 mutex_unlock(&vme_user_mutex
);
557 * Unallocate a previously allocated buffer
559 static void buf_unalloc(int num
)
561 if (image
[num
].kern_buf
) {
563 printk(KERN_DEBUG
"UniverseII:Releasing buffer at %p\n",
567 vme_free_consistent(image
[num
].resource
, image
[num
].size_buf
,
568 image
[num
].kern_buf
, image
[num
].pci_buf
);
570 image
[num
].kern_buf
= NULL
;
571 image
[num
].pci_buf
= 0;
572 image
[num
].size_buf
= 0;
576 printk(KERN_DEBUG
"UniverseII: Buffer not allocated\n");
581 static struct vme_driver vme_user_driver
= {
583 .probe
= vme_user_probe
,
584 .remove
= vme_user_remove
,
588 static int __init
vme_user_init(void)
592 struct vme_device_id
*ids
;
594 printk(KERN_INFO
"VME User Space Access Driver\n");
597 printk(KERN_ERR
"%s: No cards, skipping registration\n",
602 /* Let's start by supporting one bus, we can support more than one
603 * in future revisions if that ever becomes necessary.
605 if (bus_num
> USER_BUS_MAX
) {
606 printk(KERN_ERR
"%s: Driver only able to handle %d buses\n",
607 driver_name
, USER_BUS_MAX
);
608 bus_num
= USER_BUS_MAX
;
612 /* Dynamically create the bind table based on module parameters */
613 ids
= kmalloc(sizeof(struct vme_device_id
) * (bus_num
+ 1), GFP_KERNEL
);
615 printk(KERN_ERR
"%s: Unable to allocate ID table\n",
620 memset(ids
, 0, (sizeof(struct vme_device_id
) * (bus_num
+ 1)));
622 for (i
= 0; i
< bus_num
; i
++) {
625 * We register the driver against the slot occupied by *this*
626 * card, since it's really a low level way of controlling
629 ids
[i
].slot
= VME_SLOT_CURRENT
;
632 vme_user_driver
.bind_table
= ids
;
634 retval
= vme_register_driver(&vme_user_driver
);
640 vme_unregister_driver(&vme_user_driver
);
649 * In this simple access driver, the old behaviour is being preserved as much
650 * as practical. We will therefore reserve the buffers and request the images
651 * here so that we don't have to do it later.
653 static int __init
vme_user_probe(struct device
*dev
, int cur_bus
, int cur_slot
)
658 /* Save pointer to the bridge device */
659 if (vme_user_bridge
!= NULL
) {
660 printk(KERN_ERR
"%s: Driver can only be loaded for 1 device\n",
665 vme_user_bridge
= dev
;
667 /* Initialise descriptors */
668 for (i
= 0; i
< VME_DEVS
; i
++) {
669 image
[i
].kern_buf
= NULL
;
670 image
[i
].pci_buf
= 0;
671 init_MUTEX(&(image
[i
].sem
));
672 image
[i
].device
= NULL
;
673 image
[i
].resource
= NULL
;
677 /* Initialise statistics counters */
680 /* Assign major and minor numbers for the driver */
681 err
= register_chrdev_region(MKDEV(VME_MAJOR
, 0), VME_DEVS
,
684 printk(KERN_WARNING
"%s: Error getting Major Number %d for "
685 "driver.\n", driver_name
, VME_MAJOR
);
689 /* Register the driver as a char device */
690 vme_user_cdev
= cdev_alloc();
691 vme_user_cdev
->ops
= &vme_user_fops
;
692 vme_user_cdev
->owner
= THIS_MODULE
;
693 err
= cdev_add(vme_user_cdev
, MKDEV(VME_MAJOR
, 0), VME_DEVS
);
695 printk(KERN_WARNING
"%s: cdev_all failed\n", driver_name
);
699 /* Request slave resources and allocate buffers (128kB wide) */
700 for (i
= SLAVE_MINOR
; i
< (SLAVE_MAX
+ 1); i
++) {
701 /* For ca91cx42 bridge there are only two slave windows
702 * supporting A16 addressing, so we request A24 supported
705 image
[i
].resource
= vme_slave_request(vme_user_bridge
,
707 if (image
[i
].resource
== NULL
) {
708 printk(KERN_WARNING
"Unable to allocate slave "
712 image
[i
].size_buf
= PCI_BUF_SIZE
;
713 image
[i
].kern_buf
= vme_alloc_consistent(image
[i
].resource
,
714 image
[i
].size_buf
, &(image
[i
].pci_buf
));
715 if (image
[i
].kern_buf
== NULL
) {
716 printk(KERN_WARNING
"Unable to allocate memory for "
718 image
[i
].pci_buf
= 0;
719 vme_slave_free(image
[i
].resource
);
726 * Request master resources allocate page sized buffers for small
729 for (i
= MASTER_MINOR
; i
< (MASTER_MAX
+ 1); i
++) {
730 image
[i
].resource
= vme_master_request(vme_user_bridge
,
731 VME_A32
, VME_SCT
, VME_D32
);
732 if (image
[i
].resource
== NULL
) {
733 printk(KERN_WARNING
"Unable to allocate master "
737 image
[i
].size_buf
= PCI_BUF_SIZE
;
738 image
[i
].kern_buf
= kmalloc(image
[i
].size_buf
, GFP_KERNEL
);
739 if (image
[i
].kern_buf
== NULL
) {
740 printk(KERN_WARNING
"Unable to allocate memory for "
741 "master window buffers\n");
747 /* Create sysfs entries - on udev systems this creates the dev files */
748 vme_user_sysfs_class
= class_create(THIS_MODULE
, driver_name
);
749 if (IS_ERR(vme_user_sysfs_class
)) {
750 printk(KERN_ERR
"Error creating vme_user class.\n");
751 err
= PTR_ERR(vme_user_sysfs_class
);
755 /* Add sysfs Entries */
756 for (i
= 0; i
< VME_DEVS
; i
++) {
759 sprintf(name
, "bus/vme/m%%d");
762 sprintf(name
, "bus/vme/ctl");
765 sprintf(name
, "bus/vme/s%%d");
774 device_create(vme_user_sysfs_class
, NULL
,
775 MKDEV(VME_MAJOR
, i
), NULL
, name
,
776 (type
[i
] == SLAVE_MINOR
) ? i
- (MASTER_MAX
+ 1) : i
);
777 if (IS_ERR(image
[i
].device
)) {
778 printk(KERN_INFO
"%s: Error creating sysfs device\n",
780 err
= PTR_ERR(image
[i
].device
);
787 /* Ensure counter set correcty to destroy all sysfs devices */
792 device_destroy(vme_user_sysfs_class
, MKDEV(VME_MAJOR
, i
));
794 class_destroy(vme_user_sysfs_class
);
796 /* Ensure counter set correcty to unalloc all master windows */
799 for (i
= MASTER_MINOR
; i
< (MASTER_MAX
+ 1); i
++)
800 kfree(image
[i
].kern_buf
);
802 while (i
> MASTER_MINOR
) {
804 vme_master_free(image
[i
].resource
);
808 * Ensure counter set correcty to unalloc all slave windows and buffers
812 while (i
> SLAVE_MINOR
) {
814 vme_slave_free(image
[i
].resource
);
818 cdev_del(vme_user_cdev
);
820 unregister_chrdev_region(MKDEV(VME_MAJOR
, 0), VME_DEVS
);
826 static int __exit
vme_user_remove(struct device
*dev
, int cur_bus
, int cur_slot
)
830 /* Remove sysfs Entries */
831 for (i
= 0; i
< VME_DEVS
; i
++)
832 device_destroy(vme_user_sysfs_class
, MKDEV(VME_MAJOR
, i
));
833 class_destroy(vme_user_sysfs_class
);
835 for (i
= MASTER_MINOR
; i
< (MASTER_MAX
+ 1); i
++)
836 kfree(image
[i
].kern_buf
);
838 for (i
= SLAVE_MINOR
; i
< (SLAVE_MAX
+ 1); i
++) {
839 vme_slave_set(image
[i
].resource
, 0, 0, 0, 0, VME_A32
, 0);
840 vme_slave_free(image
[i
].resource
);
844 /* Unregister device driver */
845 cdev_del(vme_user_cdev
);
847 /* Unregiser the major and minor device numbers */
848 unregister_chrdev_region(MKDEV(VME_MAJOR
, 0), VME_DEVS
);
853 static void __exit
vme_user_exit(void)
855 vme_unregister_driver(&vme_user_driver
);
857 kfree(vme_user_driver
.bind_table
);
861 MODULE_PARM_DESC(bus
, "Enumeration of VMEbus to which the driver is connected");
862 module_param_array(bus
, int, &bus_num
, 0);
864 MODULE_DESCRIPTION("VME User Space Access Driver");
865 MODULE_AUTHOR("Martyn Welch <martyn.welch@ge.com");
866 MODULE_LICENSE("GPL");
868 module_init(vme_user_init
);
869 module_exit(vme_user_exit
);