2 * GE PIO2 6U VME I/O Driver
4 * Author: Martyn Welch <martyn.welch@ge.com>
5 * Copyright 2009 GE Intelligent Platforms Embedded Systems, Inc.
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version.
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/types.h>
18 #include <linux/kernel.h>
19 #include <linux/errno.h>
20 #include <linux/device.h>
21 #include <linux/ctype.h>
22 #include <linux/gpio.h>
23 #include <linux/slab.h>
24 #include <linux/vme.h>
29 static const char driver_name[] = "pio2";
31 static int bus[PIO2_CARDS_MAX];
33 static long base[PIO2_CARDS_MAX];
35 static int vector[PIO2_CARDS_MAX];
36 static int vector_num;
37 static int level[PIO2_CARDS_MAX];
39 static char *variant[PIO2_CARDS_MAX];
40 static int variant_num;
44 static int pio2_match(struct vme_dev *);
45 static int pio2_probe(struct vme_dev *);
46 static int pio2_remove(struct vme_dev *);
48 static int pio2_get_led(struct pio2_card *card)
50 /* Can't read hardware, state saved in structure */
54 static int pio2_set_led(struct pio2_card *card, int state)
59 reg = card->irq_level;
61 /* Register state inverse of led state */
68 retval = vme_master_write(card->window, ®, 1, PIO2_REGS_CTRL);
72 card->led = state ? 1 : 0;
77 static void pio2_int(int level, int vector, void *ptr)
79 int vec, i, channel, retval;
81 struct pio2_card *card = ptr;
83 vec = vector & ~PIO2_VME_VECTOR_MASK;
87 dev_warn(&card->vdev->dev, "Spurious Interrupt\n");
94 retval = vme_master_read(card->window, ®, 1,
95 PIO2_REGS_INT_STAT[vec - 1]);
97 dev_err(&card->vdev->dev,
98 "Unable to read IRQ status register\n");
101 for (i = 0; i < 8; i++) {
102 channel = ((vec - 1) * 8) + i;
103 if (reg & PIO2_CHANNEL_BIT[channel])
104 dev_info(&card->vdev->dev,
105 "Interrupt on I/O channel %d\n",
115 /* Counters are dealt with by their own handler */
116 dev_err(&card->vdev->dev,
117 "Counter interrupt\n");
124 * We return whether this has been successful - this is used in the probe to
125 * ensure we have a valid card.
127 static int pio2_reset_card(struct pio2_card *card)
132 /* Clear main register*/
133 retval = vme_master_write(card->window, &data, 1, PIO2_REGS_CTRL);
137 /* Clear VME vector */
138 retval = vme_master_write(card->window, &data, 1, PIO2_REGS_VME_VECTOR);
143 retval = pio2_gpio_reset(card);
148 retval = pio2_cntr_reset(card);
155 static struct vme_driver pio2_driver = {
159 .remove = pio2_remove,
163 static int __init pio2_init(void)
166 pr_err("No cards, skipping registration\n");
170 if (bus_num > PIO2_CARDS_MAX) {
171 pr_err("Driver only able to handle %d PIO2 Cards\n",
173 bus_num = PIO2_CARDS_MAX;
176 /* Register the PIO2 driver */
177 return vme_register_driver(&pio2_driver, bus_num);
180 static int pio2_match(struct vme_dev *vdev)
183 if (vdev->num >= bus_num) {
185 "The enumeration of the VMEbus to which the board is connected must be specified");
189 if (vdev->num >= base_num) {
191 "The VME address for the cards registers must be specified");
195 if (vdev->num >= vector_num) {
197 "The IRQ vector used by the card must be specified");
201 if (vdev->num >= level_num) {
203 "The IRQ level used by the card must be specified");
207 if (vdev->num >= variant_num) {
208 dev_err(&vdev->dev, "The variant of the card must be specified");
215 static int pio2_probe(struct vme_dev *vdev)
217 struct pio2_card *card;
223 card = kzalloc(sizeof(struct pio2_card), GFP_KERNEL);
225 dev_err(&vdev->dev, "Unable to allocate card structure\n");
230 card->id = vdev->num;
231 card->bus = bus[card->id];
232 card->base = base[card->id];
233 card->irq_vector = vector[card->id];
234 card->irq_level = level[card->id] & PIO2_VME_INT_MASK;
235 strncpy(card->variant, variant[card->id], PIO2_VARIANT_LENGTH);
238 for (i = 0; i < PIO2_VARIANT_LENGTH; i++) {
240 if (isdigit(card->variant[i]) == 0) {
241 dev_err(&card->vdev->dev, "Variant invalid\n");
248 * Bottom 4 bits of VME interrupt vector used to determine source,
249 * provided vector should only use upper 4 bits.
251 if (card->irq_vector & ~PIO2_VME_VECTOR_MASK) {
252 dev_err(&card->vdev->dev,
253 "Invalid VME IRQ Vector, vector must not use lower 4 bits\n");
259 * There is no way to determine the build variant or whether each bank
260 * is input, output or both at run time. The inputs are also inverted
261 * if configured as both.
263 * We pass in the board variant and use that to determine the
264 * configuration of the banks.
266 for (i = 1; i < PIO2_VARIANT_LENGTH; i++) {
267 switch (card->variant[i]) {
269 card->bank[i-1].config = NOFIT;
275 card->bank[i-1].config = INPUT;
278 card->bank[i-1].config = OUTPUT;
284 card->bank[i-1].config = BOTH;
289 /* Get a master window and position over regs */
290 card->window = vme_master_request(vdev, VME_A24, VME_SCT, VME_D16);
291 if (card->window == NULL) {
292 dev_err(&card->vdev->dev,
293 "Unable to assign VME master resource\n");
298 retval = vme_master_set(card->window, 1, card->base, 0x10000, VME_A24,
299 (VME_SCT | VME_USER | VME_DATA), VME_D16);
301 dev_err(&card->vdev->dev,
302 "Unable to configure VME master resource\n");
307 * There is also no obvious register which we can probe to determine
308 * whether the provided base is valid. If we can read the "ID Register"
309 * offset and the reset function doesn't error, assume we have a valid
312 retval = vme_master_read(card->window, ®, 1, PIO2_REGS_ID);
314 dev_err(&card->vdev->dev, "Unable to read from device\n");
318 dev_dbg(&card->vdev->dev, "ID Register:%x\n", reg);
321 * Ensure all the I/O is cleared. We can't read back the states, so
322 * this is the only method we have to ensure that the I/O is in a known
325 retval = pio2_reset_card(card);
327 dev_err(&card->vdev->dev,
328 "Failed to reset card, is location valid?");
333 /* Configure VME Interrupts */
334 reg = card->irq_level;
335 if (pio2_get_led(card))
339 retval = vme_master_write(card->window, ®, 1, PIO2_REGS_CTRL);
344 retval = vme_master_write(card->window, &card->irq_vector, 1,
345 PIO2_REGS_VME_VECTOR);
349 /* Attach spurious interrupt handler. */
350 vec = card->irq_vector | PIO2_VME_VECTOR_SPUR;
352 retval = vme_irq_request(vdev, card->irq_level, vec,
353 &pio2_int, (void *)card);
355 dev_err(&card->vdev->dev,
356 "Unable to attach VME interrupt vector0x%x, level 0x%x\n",
357 vec, card->irq_level);
361 /* Attach GPIO interrupt handlers. */
362 for (i = 0; i < 4; i++) {
363 vec = card->irq_vector | PIO2_VECTOR_BANK[i];
365 retval = vme_irq_request(vdev, card->irq_level, vec,
366 &pio2_int, (void *)card);
368 dev_err(&card->vdev->dev,
369 "Unable to attach VME interrupt vector0x%x, level 0x%x\n",
370 vec, card->irq_level);
375 /* Attach counter interrupt handlers. */
376 for (i = 0; i < 6; i++) {
377 vec = card->irq_vector | PIO2_VECTOR_CNTR[i];
379 retval = vme_irq_request(vdev, card->irq_level, vec,
380 &pio2_int, (void *)card);
382 dev_err(&card->vdev->dev,
383 "Unable to attach VME interrupt vector0x%x, level 0x%x\n",
384 vec, card->irq_level);
390 retval = pio2_gpio_init(card);
392 dev_err(&card->vdev->dev,
393 "Unable to register with GPIO framework\n");
397 /* Set LED - This also sets interrupt level */
398 retval = pio2_set_led(card, 0);
400 dev_err(&card->vdev->dev, "Unable to set LED\n");
404 dev_set_drvdata(&card->vdev->dev, card);
406 dev_info(&card->vdev->dev,
407 "PIO2 (variant %s) configured at 0x%lx\n", card->variant,
413 pio2_gpio_exit(card);
419 vec = card->irq_vector | PIO2_VECTOR_CNTR[i];
420 vme_irq_free(vdev, card->irq_level, vec);
427 vec = card->irq_vector | PIO2_VECTOR_BANK[i];
428 vme_irq_free(vdev, card->irq_level, vec);
431 vec = (card->irq_vector & PIO2_VME_VECTOR_MASK) | PIO2_VME_VECTOR_SPUR;
432 vme_irq_free(vdev, card->irq_level, vec);
434 pio2_reset_card(card);
437 vme_master_set(card->window, 0, 0, 0, VME_A16, 0, VME_D16);
439 vme_master_free(card->window);
448 static int pio2_remove(struct vme_dev *vdev)
453 struct pio2_card *card = dev_get_drvdata(&vdev->dev);
455 pio2_gpio_exit(card);
457 for (i = 0; i < 6; i++) {
458 vec = card->irq_vector | PIO2_VECTOR_CNTR[i];
459 vme_irq_free(vdev, card->irq_level, vec);
462 for (i = 0; i < 4; i++) {
463 vec = card->irq_vector | PIO2_VECTOR_BANK[i];
464 vme_irq_free(vdev, card->irq_level, vec);
467 vec = (card->irq_vector & PIO2_VME_VECTOR_MASK) | PIO2_VME_VECTOR_SPUR;
468 vme_irq_free(vdev, card->irq_level, vec);
470 pio2_reset_card(card);
472 vme_master_set(card->window, 0, 0, 0, VME_A16, 0, VME_D16);
474 vme_master_free(card->window);
481 static void __exit pio2_exit(void)
483 vme_unregister_driver(&pio2_driver);
487 /* These are required for each board */
488 MODULE_PARM_DESC(bus, "Enumeration of VMEbus to which the board is connected");
489 module_param_array(bus, int, &bus_num, S_IRUGO);
491 MODULE_PARM_DESC(base, "Base VME address for PIO2 Registers");
492 module_param_array(base, long, &base_num, S_IRUGO);
494 MODULE_PARM_DESC(vector, "VME IRQ Vector (Lower 4 bits masked)");
495 module_param_array(vector, int, &vector_num, S_IRUGO);
497 MODULE_PARM_DESC(level, "VME IRQ Level");
498 module_param_array(level, int, &level_num, S_IRUGO);
500 MODULE_PARM_DESC(variant, "Last 4 characters of PIO2 board variant");
501 module_param_array(variant, charp, &variant_num, S_IRUGO);
503 /* This is for debugging */
504 MODULE_PARM_DESC(loopback, "Enable loopback mode on all cards");
505 module_param(loopback, bool, S_IRUGO);
507 MODULE_DESCRIPTION("GE PIO2 6U VME I/O Driver");
508 MODULE_AUTHOR("Martyn Welch <martyn.welch@ge.com");
509 MODULE_LICENSE("GPL");
511 module_init(pio2_init);
512 module_exit(pio2_exit);