2 * comedi/drivers/ni_daq_700.c
3 * Driver for DAQCard-700 DIO only
6 * COMEDI - Linux Control and Measurement Device Interface
7 * Copyright (C) 1998 David A. Schleef <ds@schleef.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 Description: National Instruments PCMCIA DAQCard-700 DIO only
28 Author: Fred Brooks <nsaspook@nsaspook.com>,
29 based on ni_daq_dio24 by Daniel Vecino Castel <dvecino@able.es>
30 Devices: [National Instruments] PCMCIA DAQ-Card-700 (ni_daq_700)
32 Updated: Thu, 21 Feb 2008 12:07:20 +0000
34 The daqcard-700 appears in Comedi as a single digital I/O subdevice with
35 16 channels. The channel 0 corresponds to the daqcard-700's output
36 port, bit 0; channel 8 corresponds to the input port, bit 0.
38 Direction configuration: channels 0-7 output, 8-15 input (8225 device
39 emu as port A output, port B input, port C N/A).
41 IRQ is assigned but not used.
44 #include "../comedidev.h"
46 #include <linux/ioport.h>
48 #include <pcmcia/cs_types.h>
49 #include <pcmcia/cs.h>
50 #include <pcmcia/cistpl.h>
51 #include <pcmcia/cisreg.h>
52 #include <pcmcia/ds.h>
54 static struct pcmcia_device *pcmcia_cur_dev = NULL;
56 #define DIO700_SIZE 8 /* size of io region used by board */
58 static int dio700_attach(struct comedi_device * dev, struct comedi_devconfig * it);
59 static int dio700_detach(struct comedi_device * dev);
61 enum dio700_bustype { pcmcia_bustype };
65 int device_id; /* device id for pcmcia board */
66 enum dio700_bustype bustype; /* PCMCIA */
67 int have_dio; /* have daqcard-700 dio */
68 /* function pointers so we can use inb/outb or readb/writeb */
70 unsigned int (*read_byte) (unsigned int address);
71 void (*write_byte) (unsigned int byte, unsigned int address);
74 static const struct dio700_board dio700_boards[] = {
77 device_id:0x4743,/* 0x10b is manufacturer id, 0x4743 is device id */
78 bustype: pcmcia_bustype,
83 device_id:0x4743,/* 0x10b is manufacturer id, 0x4743 is device id */
84 bustype: pcmcia_bustype,
90 * Useful for shorthand access to the particular board structure
92 #define thisboard ((const struct dio700_board *)dev->board_ptr)
94 struct dio700_private {
96 int data; /* number of data points left to be taken */
100 #define devpriv ((struct dio700_private *)dev->private)
102 static struct comedi_driver driver_dio700 = {
103 driver_name:"ni_daq_700",
105 attach:dio700_attach,
106 detach:dio700_detach,
107 num_names:sizeof(dio700_boards) / sizeof(struct dio700_board),
108 board_name:&dio700_boards[0].name,
109 offset:sizeof(struct dio700_board),
112 /* the real driver routines */
121 struct subdev_700_struct {
122 unsigned long cb_arg;
123 int (*cb_func) (int, int, int, unsigned long);
127 #define CALLBACK_ARG (((struct subdev_700_struct *)s->private)->cb_arg)
128 #define CALLBACK_FUNC (((struct subdev_700_struct *)s->private)->cb_func)
129 #define subdevpriv ((struct subdev_700_struct *)s->private)
131 static void do_config(struct comedi_device * dev, struct comedi_subdevice * s);
133 void subdev_700_interrupt(struct comedi_device * dev, struct comedi_subdevice * s)
137 d = CALLBACK_FUNC(0, _700_DATA, 0, CALLBACK_ARG);
139 comedi_buf_put(s->async, d);
140 s->async->events |= COMEDI_CB_EOS;
142 comedi_event(dev, s);
145 static int subdev_700_cb(int dir, int port, int data, unsigned long arg)
147 /* port is always A for output and B for input (8255 emu) */
148 unsigned long iobase = arg;
151 outb(data, iobase + DIO_W);
154 return inb(iobase + DIO_R);
158 static int subdev_700_insn(struct comedi_device * dev, struct comedi_subdevice * s,
159 struct comedi_insn * insn, unsigned int * data)
162 s->state &= ~data[0];
163 s->state |= (data[0] & data[1]);
166 CALLBACK_FUNC(1, _700_DATA, s->state & 0xff,
170 data[1] = s->state & 0xff;
171 data[1] |= CALLBACK_FUNC(0, _700_DATA, 0, CALLBACK_ARG) << 8;
176 static int subdev_700_insn_config(struct comedi_device * dev, struct comedi_subdevice * s,
177 struct comedi_insn * insn, unsigned int * data)
181 case INSN_CONFIG_DIO_INPUT:
183 case INSN_CONFIG_DIO_OUTPUT:
185 case INSN_CONFIG_DIO_QUERY:
187 (s->io_bits & (1 << CR_CHAN(insn->
188 chanspec))) ? COMEDI_OUTPUT :
199 static void do_config(struct comedi_device * dev, struct comedi_subdevice * s)
200 { /* use powerup defaults */
204 static int subdev_700_cmdtest(struct comedi_device * dev, struct comedi_subdevice * s,
205 struct comedi_cmd * cmd)
212 tmp = cmd->start_src;
213 cmd->start_src &= TRIG_NOW;
214 if (!cmd->start_src || tmp != cmd->start_src)
217 tmp = cmd->scan_begin_src;
218 cmd->scan_begin_src &= TRIG_EXT;
219 if (!cmd->scan_begin_src || tmp != cmd->scan_begin_src)
222 tmp = cmd->convert_src;
223 cmd->convert_src &= TRIG_FOLLOW;
224 if (!cmd->convert_src || tmp != cmd->convert_src)
227 tmp = cmd->scan_end_src;
228 cmd->scan_end_src &= TRIG_COUNT;
229 if (!cmd->scan_end_src || tmp != cmd->scan_end_src)
233 cmd->stop_src &= TRIG_NONE;
234 if (!cmd->stop_src || tmp != cmd->stop_src)
247 if (cmd->start_arg != 0) {
251 if (cmd->scan_begin_arg != 0) {
252 cmd->scan_begin_arg = 0;
255 if (cmd->convert_arg != 0) {
256 cmd->convert_arg = 0;
259 if (cmd->scan_end_arg != 1) {
260 cmd->scan_end_arg = 1;
263 if (cmd->stop_arg != 0) {
279 static int subdev_700_cmd(struct comedi_device * dev, struct comedi_subdevice * s)
286 static int subdev_700_cancel(struct comedi_device * dev, struct comedi_subdevice * s)
293 int subdev_700_init(struct comedi_device * dev, struct comedi_subdevice * s, int (*cb) (int,
294 int, int, unsigned long), unsigned long arg)
296 s->type = COMEDI_SUBD_DIO;
297 s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
299 s->range_table = &range_digital;
302 s->private = kmalloc(sizeof(struct subdev_700_struct), GFP_KERNEL);
308 CALLBACK_FUNC = subdev_700_cb;
312 s->insn_bits = subdev_700_insn;
313 s->insn_config = subdev_700_insn_config;
322 int subdev_700_init_irq(struct comedi_device * dev, struct comedi_subdevice * s,
323 int (*cb) (int, int, int, unsigned long), unsigned long arg)
327 ret = subdev_700_init(dev, s, cb, arg);
331 s->do_cmdtest = subdev_700_cmdtest;
332 s->do_cmd = subdev_700_cmd;
333 s->cancel = subdev_700_cancel;
335 subdevpriv->have_irq = 1;
340 void subdev_700_cleanup(struct comedi_device * dev, struct comedi_subdevice * s)
343 if (subdevpriv->have_irq) {
350 EXPORT_SYMBOL(subdev_700_init);
351 EXPORT_SYMBOL(subdev_700_init_irq);
352 EXPORT_SYMBOL(subdev_700_cleanup);
353 EXPORT_SYMBOL(subdev_700_interrupt);
355 static int dio700_attach(struct comedi_device * dev, struct comedi_devconfig * it)
357 struct comedi_subdevice *s;
358 unsigned long iobase = 0;
360 unsigned int irq = 0;
362 struct pcmcia_device *link;
364 /* allocate and initialize dev->private */
365 if (alloc_private(dev, sizeof(struct dio700_private)) < 0)
368 /* get base address, irq etc. based on bustype */
369 switch (thisboard->bustype) {
371 link = pcmcia_cur_dev; /* XXX hack */
374 iobase = link->io.BasePort1;
376 irq = link->irq.AssignedIRQ;
380 printk("bug! couldn't determine board type\n");
384 printk("comedi%d: ni_daq_700: %s, io 0x%lx", dev->minor,
385 thisboard->name, iobase);
388 printk(", irq %u", irq);
395 printk("io base address is zero!\n");
399 dev->iobase = iobase;
406 dev->board_name = thisboard->name;
408 if (alloc_subdevices(dev, 1) < 0)
411 /* DAQCard-700 dio */
412 s = dev->subdevices + 0;
413 subdev_700_init(dev, s, NULL, dev->iobase);
418 static int dio700_detach(struct comedi_device * dev)
420 printk("comedi%d: ni_daq_700: cs-remove\n", dev->minor);
423 subdev_700_cleanup(dev, dev->subdevices + 0);
425 if (thisboard->bustype != pcmcia_bustype && dev->iobase)
426 release_region(dev->iobase, DIO700_SIZE);
428 comedi_free_irq(dev->irq, dev);
436 All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If
437 you do not define PCMCIA_DEBUG at all, all the debug code will be
438 left out. If you compile with PCMCIA_DEBUG=0, the debug code will
439 be present but disabled -- but it can then be enabled for specific
440 modules at load time with a 'pc_debug=#' option to insmod.
443 static int pc_debug = PCMCIA_DEBUG;
444 module_param(pc_debug, int, 0644);
445 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
446 static char *version = "ni_daq_700.c, based on dummy_cs.c";
448 #define DEBUG(n, args...)
451 /*====================================================================*/
453 static void dio700_config(struct pcmcia_device *link);
454 static void dio700_release(struct pcmcia_device *link);
455 static int dio700_cs_suspend(struct pcmcia_device *p_dev);
456 static int dio700_cs_resume(struct pcmcia_device *p_dev);
459 The attach() and detach() entry points are used to create and destroy
460 "instances" of the driver, where each instance represents everything
461 needed to manage one actual PCMCIA card.
464 static int dio700_cs_attach(struct pcmcia_device *);
465 static void dio700_cs_detach(struct pcmcia_device *);
468 You'll also need to prototype all the functions that will actually
469 be used to talk to your device. See 'memory_cs' for a good example
470 of a fully self-sufficient driver; the other drivers rely more or
471 less on other parts of the kernel.
475 The dev_info variable is the "key" that is used to match up this
476 device driver with appropriate cards, through the card configuration
480 static const dev_info_t dev_info = "ni_daq_700";
482 struct local_info_t {
483 struct pcmcia_device *link;
486 struct bus_operations *bus;
489 /*======================================================================
491 dio700_cs_attach() creates an "instance" of the driver, allocating
492 local data structures for one device. The device is registered
495 The dev_link structure is initialized, but we don't actually
496 configure the card at this point -- we wait until we receive a
497 card insertion event.
499 ======================================================================*/
501 static int dio700_cs_attach(struct pcmcia_device *link)
503 struct local_info_t *local;
505 printk(KERN_INFO "ni_daq_700: cs-attach\n");
507 DEBUG(0, "dio700_cs_attach()\n");
509 /* Allocate space for private device-specific data */
510 local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
516 /* Interrupt setup */
517 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
518 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
519 link->irq.Handler = NULL;
522 General socket configuration defaults can go here. In this
523 client, we assume very little, and rely on the CIS for almost
524 everything. In most clients, many details (i.e., number, sizes,
525 and attributes of IO windows) are fixed by the nature of the
526 device, and can be hard-wired here.
528 link->conf.Attributes = 0;
529 link->conf.IntType = INT_MEMORY_AND_IO;
531 pcmcia_cur_dev = link;
536 } /* dio700_cs_attach */
538 /*======================================================================
540 This deletes a driver "instance". The device is de-registered
541 with Card Services. If it has been released, all local data
542 structures are freed. Otherwise, the structures will be freed
543 when the device is released.
545 ======================================================================*/
547 static void dio700_cs_detach(struct pcmcia_device *link)
550 printk(KERN_INFO "ni_daq_700: cs-detach!\n");
552 DEBUG(0, "dio700_cs_detach(0x%p)\n", link);
554 if (link->dev_node) {
555 ((struct local_info_t *) link->priv)->stop = 1;
556 dio700_release(link);
559 /* This points to the parent struct local_info_t struct */
563 } /* dio700_cs_detach */
565 /*======================================================================
567 dio700_config() is scheduled to run after a CARD_INSERTION event
568 is received, to configure the PCMCIA socket, and to make the
569 device available to the system.
571 ======================================================================*/
573 static void dio700_config(struct pcmcia_device *link)
575 struct local_info_t *dev = link->priv;
582 cistpl_cftable_entry_t dflt = { 0 };
584 printk(KERN_INFO "ni_daq_700: cs-config\n");
586 DEBUG(0, "dio700_config(0x%p)\n", link);
589 This reads the card's CONFIG tuple to find its configuration
592 tuple.DesiredTuple = CISTPL_CONFIG;
593 tuple.Attributes = 0;
594 tuple.TupleData = buf;
595 tuple.TupleDataMax = sizeof(buf);
596 tuple.TupleOffset = 0;
597 if ((last_ret = pcmcia_get_first_tuple(link, &tuple)) != 0) {
598 cs_error(link, GetFirstTuple, last_ret);
601 if ((last_ret = pcmcia_get_tuple_data(link, &tuple)) != 0) {
602 cs_error(link, GetTupleData, last_ret);
605 if ((last_ret = pcmcia_parse_tuple(&tuple, &parse)) != 0) {
606 cs_error(link, ParseTuple, last_ret);
609 link->conf.ConfigBase = parse.config.base;
610 link->conf.Present = parse.config.rmask[0];
613 In this loop, we scan the CIS for configuration table entries,
614 each of which describes a valid card configuration, including
615 voltage, IO window, memory window, and interrupt settings.
617 We make no assumptions about the card to be configured: we use
618 just the information available in the CIS. In an ideal world,
619 this would work for any PCMCIA card, but it requires a complete
620 and accurate CIS. In practice, a driver usually "knows" most of
621 these things without consulting the CIS, and most client drivers
622 will only use the CIS to fill in implementation-defined details.
624 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
625 if ((last_ret = pcmcia_get_first_tuple(link, &tuple)) != 0) {
626 cs_error(link, GetFirstTuple, last_ret);
630 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
631 if (pcmcia_get_tuple_data(link, &tuple) != 0)
633 if (pcmcia_parse_tuple(&tuple, &parse) != 0)
636 if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
640 link->conf.ConfigIndex = cfg->index;
642 /* Does this card need audio output? */
643 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
644 link->conf.Attributes |= CONF_ENABLE_SPKR;
645 link->conf.Status = CCSR_AUDIO_ENA;
648 /* Do we need to allocate an interrupt? */
649 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
650 link->conf.Attributes |= CONF_ENABLE_IRQ;
652 /* IO window settings */
653 link->io.NumPorts1 = link->io.NumPorts2 = 0;
654 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
655 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
656 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
657 if (!(io->flags & CISTPL_IO_8BIT))
658 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
659 if (!(io->flags & CISTPL_IO_16BIT))
660 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
661 link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
662 link->io.BasePort1 = io->win[0].base;
663 link->io.NumPorts1 = io->win[0].len;
665 link->io.Attributes2 = link->io.Attributes1;
666 link->io.BasePort2 = io->win[1].base;
667 link->io.NumPorts2 = io->win[1].len;
669 /* This reserves IO space but doesn't actually enable it */
670 if (pcmcia_request_io(link, &link->io) != 0)
674 if ((cfg->mem.nwin > 0) || (dflt.mem.nwin > 0)) {
676 (cfg->mem.nwin) ? &cfg->mem : &dflt.mem;
677 req.Attributes = WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM;
678 req.Attributes |= WIN_ENABLE;
679 req.Base = mem->win[0].host_addr;
680 req.Size = mem->win[0].len;
681 if (req.Size < 0x1000)
684 if (pcmcia_request_window(&link, &req, &link->win))
687 map.CardOffset = mem->win[0].card_addr;
688 if (pcmcia_map_mem_page(link->win, &map))
691 /* If we got this far, we're cool! */
695 if ((last_ret = pcmcia_get_next_tuple(link, &tuple)) != 0) {
696 cs_error(link, GetNextTuple, last_ret);
702 Allocate an interrupt line. Note that this does not assign a
703 handler to the interrupt, unless the 'Handler' member of the
704 irq structure is initialized.
706 if (link->conf.Attributes & CONF_ENABLE_IRQ)
707 if ((last_ret = pcmcia_request_irq(link, &link->irq)) != 0) {
708 cs_error(link, RequestIRQ, last_ret);
713 This actually configures the PCMCIA socket -- setting up
714 the I/O windows and the interrupt mapping, and putting the
715 card and host interface into "Memory and IO" mode.
717 if ((last_ret = pcmcia_request_configuration(link, &link->conf)) != 0) {
718 cs_error(link, RequestConfiguration, last_ret);
723 At this point, the dev_node_t structure(s) need to be
724 initialized and arranged in a linked list at link->dev.
726 sprintf(dev->node.dev_name, "ni_daq_700");
727 dev->node.major = dev->node.minor = 0;
728 link->dev_node = &dev->node;
730 /* Finally, report what we've done */
731 printk(KERN_INFO "%s: index 0x%02x",
732 dev->node.dev_name, link->conf.ConfigIndex);
733 if (link->conf.Attributes & CONF_ENABLE_IRQ)
734 printk(", irq %d", link->irq.AssignedIRQ);
735 if (link->io.NumPorts1)
736 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
737 link->io.BasePort1 + link->io.NumPorts1 - 1);
738 if (link->io.NumPorts2)
739 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
740 link->io.BasePort2 + link->io.NumPorts2 - 1);
742 printk(", mem 0x%06lx-0x%06lx", req.Base,
743 req.Base + req.Size - 1);
749 printk(KERN_INFO "ni_daq_700 cs failed");
750 dio700_release(link);
752 } /* dio700_config */
754 static void dio700_release(struct pcmcia_device *link)
756 DEBUG(0, "dio700_release(0x%p)\n", link);
758 pcmcia_disable_device(link);
759 } /* dio700_release */
761 /*======================================================================
763 The card status event handler. Mostly, this schedules other
764 stuff to run after an event is received.
766 When a CARD_REMOVAL event is received, we immediately set a
767 private flag to block future accesses to this device. All the
768 functions that actually access the device should check this flag
769 to make sure the card is still present.
771 ======================================================================*/
773 static int dio700_cs_suspend(struct pcmcia_device *link)
775 struct local_info_t *local = link->priv;
777 /* Mark the device as stopped, to block IO until later */
780 } /* dio700_cs_suspend */
782 static int dio700_cs_resume(struct pcmcia_device *link)
784 struct local_info_t *local = link->priv;
788 } /* dio700_cs_resume */
790 /*====================================================================*/
792 static struct pcmcia_device_id dio700_cs_ids[] = {
793 /* N.B. These IDs should match those in dio700_boards */
794 PCMCIA_DEVICE_MANF_CARD(0x010b, 0x4743), /* daqcard-700 */
798 MODULE_LICENSE("GPL");
799 MODULE_DEVICE_TABLE(pcmcia, dio700_cs_ids);
801 struct pcmcia_driver dio700_cs_driver = {
802 .probe = dio700_cs_attach,
803 .remove = dio700_cs_detach,
804 .suspend = dio700_cs_suspend,
805 .resume = dio700_cs_resume,
806 .id_table = dio700_cs_ids,
807 .owner = THIS_MODULE,
813 static int __init init_dio700_cs(void)
815 printk("ni_daq_700: cs-init \n");
816 DEBUG(0, "%s\n", version);
817 pcmcia_register_driver(&dio700_cs_driver);
821 static void __exit exit_dio700_cs(void)
823 DEBUG(0, "ni_daq_700: unloading\n");
824 pcmcia_unregister_driver(&dio700_cs_driver);
826 int __init init_module(void)
830 ret = init_dio700_cs();
834 return comedi_driver_register(&driver_dio700);
837 void __exit cleanup_module(void)
840 comedi_driver_unregister(&driver_dio700);