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 <linux/interrupt.h>
45 #include "../comedidev.h"
47 #include <linux/ioport.h>
49 #include <pcmcia/cs_types.h>
50 #include <pcmcia/cs.h>
51 #include <pcmcia/cistpl.h>
52 #include <pcmcia/cisreg.h>
53 #include <pcmcia/ds.h>
55 static struct pcmcia_device *pcmcia_cur_dev = NULL;
57 #define DIO700_SIZE 8 /* size of io region used by board */
59 static int dio700_attach(struct comedi_device *dev,
60 struct comedi_devconfig *it);
61 static int dio700_detach(struct comedi_device *dev);
63 enum dio700_bustype { pcmcia_bustype };
67 int device_id; /* device id for pcmcia board */
68 enum dio700_bustype bustype; /* PCMCIA */
69 int have_dio; /* have daqcard-700 dio */
70 /* function pointers so we can use inb/outb or readb/writeb */
72 unsigned int (*read_byte) (unsigned int address);
73 void (*write_byte) (unsigned int byte, unsigned int address);
76 static const struct dio700_board dio700_boards[] = {
78 .name = "daqcard-700",
79 .device_id = 0x4743, /* 0x10b is manufacturer id, 0x4743 is device id */
80 .bustype = pcmcia_bustype,
85 .device_id = 0x4743, /* 0x10b is manufacturer id, 0x4743 is device id */
86 .bustype = pcmcia_bustype,
92 * Useful for shorthand access to the particular board structure
94 #define thisboard ((const struct dio700_board *)dev->board_ptr)
96 struct dio700_private {
98 int data; /* number of data points left to be taken */
101 #define devpriv ((struct dio700_private *)dev->private)
103 static struct comedi_driver driver_dio700 = {
104 .driver_name = "ni_daq_700",
105 .module = THIS_MODULE,
106 .attach = dio700_attach,
107 .detach = dio700_detach,
108 .num_names = ARRAY_SIZE(dio700_boards),
109 .board_name = &dio700_boards[0].name,
110 .offset = sizeof(struct dio700_board),
113 /* the real driver routines */
122 struct subdev_700_struct {
123 unsigned long cb_arg;
124 int (*cb_func) (int, int, int, unsigned long);
128 #define CALLBACK_ARG (((struct subdev_700_struct *)s->private)->cb_arg)
129 #define CALLBACK_FUNC (((struct subdev_700_struct *)s->private)->cb_func)
130 #define subdevpriv ((struct subdev_700_struct *)s->private)
132 static void do_config(struct comedi_device *dev, struct comedi_subdevice *s);
134 void subdev_700_interrupt(struct comedi_device *dev, struct comedi_subdevice *s)
138 d = CALLBACK_FUNC(0, _700_DATA, 0, CALLBACK_ARG);
140 comedi_buf_put(s->async, d);
141 s->async->events |= COMEDI_CB_EOS;
143 comedi_event(dev, s);
146 static int subdev_700_cb(int dir, int port, int data, unsigned long arg)
148 /* port is always A for output and B for input (8255 emu) */
149 unsigned long iobase = arg;
152 outb(data, iobase + DIO_W);
155 return inb(iobase + DIO_R);
159 static int subdev_700_insn(struct comedi_device *dev,
160 struct comedi_subdevice *s, struct comedi_insn *insn,
164 s->state &= ~data[0];
165 s->state |= (data[0] & data[1]);
168 CALLBACK_FUNC(1, _700_DATA, s->state & 0xff,
172 data[1] = s->state & 0xff;
173 data[1] |= CALLBACK_FUNC(0, _700_DATA, 0, CALLBACK_ARG) << 8;
178 static int subdev_700_insn_config(struct comedi_device *dev,
179 struct comedi_subdevice *s,
180 struct comedi_insn *insn, unsigned int *data)
184 case INSN_CONFIG_DIO_INPUT:
186 case INSN_CONFIG_DIO_OUTPUT:
188 case INSN_CONFIG_DIO_QUERY:
191 io_bits & (1 << CR_CHAN(insn->chanspec))) ? COMEDI_OUTPUT :
202 static void do_config(struct comedi_device *dev, struct comedi_subdevice *s)
203 { /* use powerup defaults */
207 static int subdev_700_cmdtest(struct comedi_device *dev,
208 struct comedi_subdevice *s,
209 struct comedi_cmd *cmd)
216 tmp = cmd->start_src;
217 cmd->start_src &= TRIG_NOW;
218 if (!cmd->start_src || tmp != cmd->start_src)
221 tmp = cmd->scan_begin_src;
222 cmd->scan_begin_src &= TRIG_EXT;
223 if (!cmd->scan_begin_src || tmp != cmd->scan_begin_src)
226 tmp = cmd->convert_src;
227 cmd->convert_src &= TRIG_FOLLOW;
228 if (!cmd->convert_src || tmp != cmd->convert_src)
231 tmp = cmd->scan_end_src;
232 cmd->scan_end_src &= TRIG_COUNT;
233 if (!cmd->scan_end_src || tmp != cmd->scan_end_src)
237 cmd->stop_src &= TRIG_NONE;
238 if (!cmd->stop_src || tmp != cmd->stop_src)
251 if (cmd->start_arg != 0) {
255 if (cmd->scan_begin_arg != 0) {
256 cmd->scan_begin_arg = 0;
259 if (cmd->convert_arg != 0) {
260 cmd->convert_arg = 0;
263 if (cmd->scan_end_arg != 1) {
264 cmd->scan_end_arg = 1;
267 if (cmd->stop_arg != 0) {
283 static int subdev_700_cmd(struct comedi_device *dev, struct comedi_subdevice *s)
290 static int subdev_700_cancel(struct comedi_device *dev,
291 struct comedi_subdevice *s)
298 int subdev_700_init(struct comedi_device *dev, struct comedi_subdevice *s,
299 int (*cb) (int, int, int, unsigned long), unsigned long arg)
301 s->type = COMEDI_SUBD_DIO;
302 s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
304 s->range_table = &range_digital;
307 s->private = kmalloc(sizeof(struct subdev_700_struct), GFP_KERNEL);
313 CALLBACK_FUNC = subdev_700_cb;
317 s->insn_bits = subdev_700_insn;
318 s->insn_config = subdev_700_insn_config;
327 int subdev_700_init_irq(struct comedi_device *dev, struct comedi_subdevice *s,
328 int (*cb) (int, int, int, unsigned long),
333 ret = subdev_700_init(dev, s, cb, arg);
337 s->do_cmdtest = subdev_700_cmdtest;
338 s->do_cmd = subdev_700_cmd;
339 s->cancel = subdev_700_cancel;
341 subdevpriv->have_irq = 1;
346 void subdev_700_cleanup(struct comedi_device *dev, struct comedi_subdevice *s)
349 if (subdevpriv->have_irq) {
356 EXPORT_SYMBOL(subdev_700_init);
357 EXPORT_SYMBOL(subdev_700_init_irq);
358 EXPORT_SYMBOL(subdev_700_cleanup);
359 EXPORT_SYMBOL(subdev_700_interrupt);
361 static int dio700_attach(struct comedi_device *dev, struct comedi_devconfig *it)
363 struct comedi_subdevice *s;
364 unsigned long iobase = 0;
366 unsigned int irq = 0;
368 struct pcmcia_device *link;
370 /* allocate and initialize dev->private */
371 if (alloc_private(dev, sizeof(struct dio700_private)) < 0)
374 /* get base address, irq etc. based on bustype */
375 switch (thisboard->bustype) {
377 link = pcmcia_cur_dev; /* XXX hack */
380 iobase = link->io.BasePort1;
382 irq = link->irq.AssignedIRQ;
386 printk("bug! couldn't determine board type\n");
390 printk("comedi%d: ni_daq_700: %s, io 0x%lx", dev->minor,
391 thisboard->name, iobase);
394 printk(", irq %u", irq);
401 printk("io base address is zero!\n");
405 dev->iobase = iobase;
412 dev->board_name = thisboard->name;
414 if (alloc_subdevices(dev, 1) < 0)
417 /* DAQCard-700 dio */
418 s = dev->subdevices + 0;
419 subdev_700_init(dev, s, NULL, dev->iobase);
424 static int dio700_detach(struct comedi_device *dev)
426 printk("comedi%d: ni_daq_700: cs-remove\n", dev->minor);
429 subdev_700_cleanup(dev, dev->subdevices + 0);
431 if (thisboard->bustype != pcmcia_bustype && dev->iobase)
432 release_region(dev->iobase, DIO700_SIZE);
434 free_irq(dev->irq, dev);
442 All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If
443 you do not define PCMCIA_DEBUG at all, all the debug code will be
444 left out. If you compile with PCMCIA_DEBUG=0, the debug code will
445 be present but disabled -- but it can then be enabled for specific
446 modules at load time with a 'pc_debug=#' option to insmod.
449 static int pc_debug = PCMCIA_DEBUG;
450 module_param(pc_debug, int, 0644);
451 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
452 static char *version = "ni_daq_700.c, based on dummy_cs.c";
454 #define DEBUG(n, args...)
457 /*====================================================================*/
459 static void dio700_config(struct pcmcia_device *link);
460 static void dio700_release(struct pcmcia_device *link);
461 static int dio700_cs_suspend(struct pcmcia_device *p_dev);
462 static int dio700_cs_resume(struct pcmcia_device *p_dev);
465 The attach() and detach() entry points are used to create and destroy
466 "instances" of the driver, where each instance represents everything
467 needed to manage one actual PCMCIA card.
470 static int dio700_cs_attach(struct pcmcia_device *);
471 static void dio700_cs_detach(struct pcmcia_device *);
474 You'll also need to prototype all the functions that will actually
475 be used to talk to your device. See 'memory_cs' for a good example
476 of a fully self-sufficient driver; the other drivers rely more or
477 less on other parts of the kernel.
481 The dev_info variable is the "key" that is used to match up this
482 device driver with appropriate cards, through the card configuration
486 static const dev_info_t dev_info = "ni_daq_700";
488 struct local_info_t {
489 struct pcmcia_device *link;
492 struct bus_operations *bus;
495 /*======================================================================
497 dio700_cs_attach() creates an "instance" of the driver, allocating
498 local data structures for one device. The device is registered
501 The dev_link structure is initialized, but we don't actually
502 configure the card at this point -- we wait until we receive a
503 card insertion event.
505 ======================================================================*/
507 static int dio700_cs_attach(struct pcmcia_device *link)
509 struct local_info_t *local;
511 printk(KERN_INFO "ni_daq_700: cs-attach\n");
513 DEBUG(0, "dio700_cs_attach()\n");
515 /* Allocate space for private device-specific data */
516 local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
522 /* Interrupt setup */
523 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
524 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
525 link->irq.Handler = NULL;
528 General socket configuration defaults can go here. In this
529 client, we assume very little, and rely on the CIS for almost
530 everything. In most clients, many details (i.e., number, sizes,
531 and attributes of IO windows) are fixed by the nature of the
532 device, and can be hard-wired here.
534 link->conf.Attributes = 0;
535 link->conf.IntType = INT_MEMORY_AND_IO;
537 pcmcia_cur_dev = link;
542 } /* dio700_cs_attach */
544 /*======================================================================
546 This deletes a driver "instance". The device is de-registered
547 with Card Services. If it has been released, all local data
548 structures are freed. Otherwise, the structures will be freed
549 when the device is released.
551 ======================================================================*/
553 static void dio700_cs_detach(struct pcmcia_device *link)
556 printk(KERN_INFO "ni_daq_700: cs-detach!\n");
558 DEBUG(0, "dio700_cs_detach(0x%p)\n", link);
560 if (link->dev_node) {
561 ((struct local_info_t *)link->priv)->stop = 1;
562 dio700_release(link);
565 /* This points to the parent struct local_info_t struct */
569 } /* dio700_cs_detach */
571 /*======================================================================
573 dio700_config() is scheduled to run after a CARD_INSERTION event
574 is received, to configure the PCMCIA socket, and to make the
575 device available to the system.
577 ======================================================================*/
579 static void dio700_config(struct pcmcia_device *link)
581 struct local_info_t *dev = link->priv;
588 cistpl_cftable_entry_t dflt = { 0 };
590 printk(KERN_INFO "ni_daq_700: cs-config\n");
592 DEBUG(0, "dio700_config(0x%p)\n", link);
595 This reads the card's CONFIG tuple to find its configuration
598 tuple.DesiredTuple = CISTPL_CONFIG;
599 tuple.Attributes = 0;
600 tuple.TupleData = buf;
601 tuple.TupleDataMax = sizeof(buf);
602 tuple.TupleOffset = 0;
604 last_ret = pcmcia_get_first_tuple(link, &tuple);
606 cs_error(link, GetFirstTuple, last_ret);
610 last_ret = pcmcia_get_tuple_data(link, &tuple);
612 cs_error(link, GetTupleData, last_ret);
616 last_ret = pcmcia_parse_tuple(&tuple, &parse);
618 cs_error(link, ParseTuple, last_ret);
621 link->conf.ConfigBase = parse.config.base;
622 link->conf.Present = parse.config.rmask[0];
625 In this loop, we scan the CIS for configuration table entries,
626 each of which describes a valid card configuration, including
627 voltage, IO window, memory window, and interrupt settings.
629 We make no assumptions about the card to be configured: we use
630 just the information available in the CIS. In an ideal world,
631 this would work for any PCMCIA card, but it requires a complete
632 and accurate CIS. In practice, a driver usually "knows" most of
633 these things without consulting the CIS, and most client drivers
634 will only use the CIS to fill in implementation-defined details.
636 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
637 last_ret = pcmcia_get_first_tuple(link, &tuple);
639 cs_error(link, GetFirstTuple, last_ret);
643 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
644 if (pcmcia_get_tuple_data(link, &tuple) != 0)
646 if (pcmcia_parse_tuple(&tuple, &parse) != 0)
649 if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
653 link->conf.ConfigIndex = cfg->index;
655 /* Does this card need audio output? */
656 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
657 link->conf.Attributes |= CONF_ENABLE_SPKR;
658 link->conf.Status = CCSR_AUDIO_ENA;
661 /* Do we need to allocate an interrupt? */
662 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
663 link->conf.Attributes |= CONF_ENABLE_IRQ;
665 /* IO window settings */
666 link->io.NumPorts1 = link->io.NumPorts2 = 0;
667 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
668 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
669 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
670 if (!(io->flags & CISTPL_IO_8BIT))
671 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
672 if (!(io->flags & CISTPL_IO_16BIT))
673 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
674 link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
675 link->io.BasePort1 = io->win[0].base;
676 link->io.NumPorts1 = io->win[0].len;
678 link->io.Attributes2 = link->io.Attributes1;
679 link->io.BasePort2 = io->win[1].base;
680 link->io.NumPorts2 = io->win[1].len;
682 /* This reserves IO space but doesn't actually enable it */
683 if (pcmcia_request_io(link, &link->io) != 0)
687 if ((cfg->mem.nwin > 0) || (dflt.mem.nwin > 0)) {
689 (cfg->mem.nwin) ? &cfg->mem : &dflt.mem;
690 req.Attributes = WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM;
691 req.Attributes |= WIN_ENABLE;
692 req.Base = mem->win[0].host_addr;
693 req.Size = mem->win[0].len;
694 if (req.Size < 0x1000)
697 if (pcmcia_request_window(&link, &req, &link->win))
700 map.CardOffset = mem->win[0].card_addr;
701 if (pcmcia_map_mem_page(link->win, &map))
704 /* If we got this far, we're cool! */
709 last_ret = pcmcia_get_next_tuple(link, &tuple);
711 cs_error(link, GetNextTuple, last_ret);
717 Allocate an interrupt line. Note that this does not assign a
718 handler to the interrupt, unless the 'Handler' member of the
719 irq structure is initialized.
721 if (link->conf.Attributes & CONF_ENABLE_IRQ) {
722 last_ret = pcmcia_request_irq(link, &link->irq);
724 cs_error(link, RequestIRQ, last_ret);
730 This actually configures the PCMCIA socket -- setting up
731 the I/O windows and the interrupt mapping, and putting the
732 card and host interface into "Memory and IO" mode.
734 last_ret = pcmcia_request_configuration(link, &link->conf);
736 cs_error(link, RequestConfiguration, last_ret);
741 At this point, the dev_node_t structure(s) need to be
742 initialized and arranged in a linked list at link->dev.
744 sprintf(dev->node.dev_name, "ni_daq_700");
745 dev->node.major = dev->node.minor = 0;
746 link->dev_node = &dev->node;
748 /* Finally, report what we've done */
749 printk(KERN_INFO "%s: index 0x%02x",
750 dev->node.dev_name, link->conf.ConfigIndex);
751 if (link->conf.Attributes & CONF_ENABLE_IRQ)
752 printk(", irq %d", link->irq.AssignedIRQ);
753 if (link->io.NumPorts1)
754 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
755 link->io.BasePort1 + link->io.NumPorts1 - 1);
756 if (link->io.NumPorts2)
757 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
758 link->io.BasePort2 + link->io.NumPorts2 - 1);
760 printk(", mem 0x%06lx-0x%06lx", req.Base,
761 req.Base + req.Size - 1);
767 printk(KERN_INFO "ni_daq_700 cs failed");
768 dio700_release(link);
770 } /* dio700_config */
772 static void dio700_release(struct pcmcia_device *link)
774 DEBUG(0, "dio700_release(0x%p)\n", link);
776 pcmcia_disable_device(link);
777 } /* dio700_release */
779 /*======================================================================
781 The card status event handler. Mostly, this schedules other
782 stuff to run after an event is received.
784 When a CARD_REMOVAL event is received, we immediately set a
785 private flag to block future accesses to this device. All the
786 functions that actually access the device should check this flag
787 to make sure the card is still present.
789 ======================================================================*/
791 static int dio700_cs_suspend(struct pcmcia_device *link)
793 struct local_info_t *local = link->priv;
795 /* Mark the device as stopped, to block IO until later */
798 } /* dio700_cs_suspend */
800 static int dio700_cs_resume(struct pcmcia_device *link)
802 struct local_info_t *local = link->priv;
806 } /* dio700_cs_resume */
808 /*====================================================================*/
810 static struct pcmcia_device_id dio700_cs_ids[] = {
811 /* N.B. These IDs should match those in dio700_boards */
812 PCMCIA_DEVICE_MANF_CARD(0x010b, 0x4743), /* daqcard-700 */
816 MODULE_LICENSE("GPL");
817 MODULE_DEVICE_TABLE(pcmcia, dio700_cs_ids);
819 struct pcmcia_driver dio700_cs_driver = {
820 .probe = dio700_cs_attach,
821 .remove = dio700_cs_detach,
822 .suspend = dio700_cs_suspend,
823 .resume = dio700_cs_resume,
824 .id_table = dio700_cs_ids,
825 .owner = THIS_MODULE,
831 static int __init init_dio700_cs(void)
833 printk("ni_daq_700: cs-init \n");
834 DEBUG(0, "%s\n", version);
835 pcmcia_register_driver(&dio700_cs_driver);
839 static void __exit exit_dio700_cs(void)
841 DEBUG(0, "ni_daq_700: unloading\n");
842 pcmcia_unregister_driver(&dio700_cs_driver);
845 int __init init_module(void)
849 ret = init_dio700_cs();
853 return comedi_driver_register(&driver_dio700);
856 void __exit cleanup_module(void)
859 comedi_driver_unregister(&driver_dio700);