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, comedi_devconfig * it);
59 static int dio700_detach(struct comedi_device * dev);
61 enum dio700_bustype { pcmcia_bustype };
63 typedef struct dio700_board_struct {
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 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 dio700_board *)dev->board_ptr)
95 int data; /* number of data points left to be taken */
98 #define devpriv ((dio700_private *)dev->private)
100 static comedi_driver driver_dio700 = {
101 driver_name:"ni_daq_700",
103 attach:dio700_attach,
104 detach:dio700_detach,
105 num_names:sizeof(dio700_boards) / sizeof(dio700_board),
106 board_name:&dio700_boards[0].name,
107 offset:sizeof(dio700_board),
110 /* the real driver routines */
119 struct subdev_700_struct {
120 unsigned long cb_arg;
121 int (*cb_func) (int, int, int, unsigned long);
125 #define CALLBACK_ARG (((struct subdev_700_struct *)s->private)->cb_arg)
126 #define CALLBACK_FUNC (((struct subdev_700_struct *)s->private)->cb_func)
127 #define subdevpriv ((struct subdev_700_struct *)s->private)
129 static void do_config(struct comedi_device * dev, comedi_subdevice * s);
131 void subdev_700_interrupt(struct comedi_device * dev, comedi_subdevice * s)
135 d = CALLBACK_FUNC(0, _700_DATA, 0, CALLBACK_ARG);
137 comedi_buf_put(s->async, d);
138 s->async->events |= COMEDI_CB_EOS;
140 comedi_event(dev, s);
143 static int subdev_700_cb(int dir, int port, int data, unsigned long arg)
145 /* port is always A for output and B for input (8255 emu) */
146 unsigned long iobase = arg;
149 outb(data, iobase + DIO_W);
152 return inb(iobase + DIO_R);
156 static int subdev_700_insn(struct comedi_device * dev, comedi_subdevice * s,
157 comedi_insn * insn, unsigned int * data)
160 s->state &= ~data[0];
161 s->state |= (data[0] & data[1]);
164 CALLBACK_FUNC(1, _700_DATA, s->state & 0xff,
168 data[1] = s->state & 0xff;
169 data[1] |= CALLBACK_FUNC(0, _700_DATA, 0, CALLBACK_ARG) << 8;
174 static int subdev_700_insn_config(struct comedi_device * dev, comedi_subdevice * s,
175 comedi_insn * insn, unsigned int * data)
179 case INSN_CONFIG_DIO_INPUT:
181 case INSN_CONFIG_DIO_OUTPUT:
183 case INSN_CONFIG_DIO_QUERY:
185 (s->io_bits & (1 << CR_CHAN(insn->
186 chanspec))) ? COMEDI_OUTPUT :
197 static void do_config(struct comedi_device * dev, comedi_subdevice * s)
198 { /* use powerup defaults */
202 static int subdev_700_cmdtest(struct comedi_device * dev, comedi_subdevice * s,
210 tmp = cmd->start_src;
211 cmd->start_src &= TRIG_NOW;
212 if (!cmd->start_src || tmp != cmd->start_src)
215 tmp = cmd->scan_begin_src;
216 cmd->scan_begin_src &= TRIG_EXT;
217 if (!cmd->scan_begin_src || tmp != cmd->scan_begin_src)
220 tmp = cmd->convert_src;
221 cmd->convert_src &= TRIG_FOLLOW;
222 if (!cmd->convert_src || tmp != cmd->convert_src)
225 tmp = cmd->scan_end_src;
226 cmd->scan_end_src &= TRIG_COUNT;
227 if (!cmd->scan_end_src || tmp != cmd->scan_end_src)
231 cmd->stop_src &= TRIG_NONE;
232 if (!cmd->stop_src || tmp != cmd->stop_src)
245 if (cmd->start_arg != 0) {
249 if (cmd->scan_begin_arg != 0) {
250 cmd->scan_begin_arg = 0;
253 if (cmd->convert_arg != 0) {
254 cmd->convert_arg = 0;
257 if (cmd->scan_end_arg != 1) {
258 cmd->scan_end_arg = 1;
261 if (cmd->stop_arg != 0) {
277 static int subdev_700_cmd(struct comedi_device * dev, comedi_subdevice * s)
284 static int subdev_700_cancel(struct comedi_device * dev, comedi_subdevice * s)
291 int subdev_700_init(struct comedi_device * dev, comedi_subdevice * s, int (*cb) (int,
292 int, int, unsigned long), unsigned long arg)
294 s->type = COMEDI_SUBD_DIO;
295 s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
297 s->range_table = &range_digital;
300 s->private = kmalloc(sizeof(struct subdev_700_struct), GFP_KERNEL);
306 CALLBACK_FUNC = subdev_700_cb;
310 s->insn_bits = subdev_700_insn;
311 s->insn_config = subdev_700_insn_config;
320 int subdev_700_init_irq(struct comedi_device * dev, comedi_subdevice * s,
321 int (*cb) (int, int, int, unsigned long), unsigned long arg)
325 ret = subdev_700_init(dev, s, cb, arg);
329 s->do_cmdtest = subdev_700_cmdtest;
330 s->do_cmd = subdev_700_cmd;
331 s->cancel = subdev_700_cancel;
333 subdevpriv->have_irq = 1;
338 void subdev_700_cleanup(struct comedi_device * dev, comedi_subdevice * s)
341 if (subdevpriv->have_irq) {
348 EXPORT_SYMBOL(subdev_700_init);
349 EXPORT_SYMBOL(subdev_700_init_irq);
350 EXPORT_SYMBOL(subdev_700_cleanup);
351 EXPORT_SYMBOL(subdev_700_interrupt);
353 static int dio700_attach(struct comedi_device * dev, comedi_devconfig * it)
356 unsigned long iobase = 0;
358 unsigned int irq = 0;
360 struct pcmcia_device *link;
362 /* allocate and initialize dev->private */
363 if (alloc_private(dev, sizeof(dio700_private)) < 0)
366 // get base address, irq etc. based on bustype
367 switch (thisboard->bustype) {
369 link = pcmcia_cur_dev; /* XXX hack */
372 iobase = link->io.BasePort1;
374 irq = link->irq.AssignedIRQ;
378 printk("bug! couldn't determine board type\n");
382 printk("comedi%d: ni_daq_700: %s, io 0x%lx", dev->minor,
383 thisboard->name, iobase);
386 printk(", irq %u", irq);
393 printk("io base address is zero!\n");
397 dev->iobase = iobase;
404 dev->board_name = thisboard->name;
406 if (alloc_subdevices(dev, 1) < 0)
409 /* DAQCard-700 dio */
410 s = dev->subdevices + 0;
411 subdev_700_init(dev, s, NULL, dev->iobase);
416 static int dio700_detach(struct comedi_device * dev)
418 printk("comedi%d: ni_daq_700: cs-remove\n", dev->minor);
421 subdev_700_cleanup(dev, dev->subdevices + 0);
423 if (thisboard->bustype != pcmcia_bustype && dev->iobase)
424 release_region(dev->iobase, DIO700_SIZE);
426 comedi_free_irq(dev->irq, dev);
434 All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If
435 you do not define PCMCIA_DEBUG at all, all the debug code will be
436 left out. If you compile with PCMCIA_DEBUG=0, the debug code will
437 be present but disabled -- but it can then be enabled for specific
438 modules at load time with a 'pc_debug=#' option to insmod.
441 static int pc_debug = PCMCIA_DEBUG;
442 module_param(pc_debug, int, 0644);
443 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
444 static char *version = "ni_daq_700.c, based on dummy_cs.c";
446 #define DEBUG(n, args...)
449 /*====================================================================*/
451 static void dio700_config(struct pcmcia_device *link);
452 static void dio700_release(struct pcmcia_device *link);
453 static int dio700_cs_suspend(struct pcmcia_device *p_dev);
454 static int dio700_cs_resume(struct pcmcia_device *p_dev);
457 The attach() and detach() entry points are used to create and destroy
458 "instances" of the driver, where each instance represents everything
459 needed to manage one actual PCMCIA card.
462 static int dio700_cs_attach(struct pcmcia_device *);
463 static void dio700_cs_detach(struct pcmcia_device *);
466 You'll also need to prototype all the functions that will actually
467 be used to talk to your device. See 'memory_cs' for a good example
468 of a fully self-sufficient driver; the other drivers rely more or
469 less on other parts of the kernel.
473 The dev_info variable is the "key" that is used to match up this
474 device driver with appropriate cards, through the card configuration
478 static const dev_info_t dev_info = "ni_daq_700";
480 typedef struct local_info_t {
481 struct pcmcia_device *link;
484 struct bus_operations *bus;
487 /*======================================================================
489 dio700_cs_attach() creates an "instance" of the driver, allocating
490 local data structures for one device. The device is registered
493 The dev_link structure is initialized, but we don't actually
494 configure the card at this point -- we wait until we receive a
495 card insertion event.
497 ======================================================================*/
499 static int dio700_cs_attach(struct pcmcia_device *link)
503 printk(KERN_INFO "ni_daq_700: cs-attach\n");
505 DEBUG(0, "dio700_cs_attach()\n");
507 /* Allocate space for private device-specific data */
508 local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
514 /* Interrupt setup */
515 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
516 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
517 link->irq.Handler = NULL;
520 General socket configuration defaults can go here. In this
521 client, we assume very little, and rely on the CIS for almost
522 everything. In most clients, many details (i.e., number, sizes,
523 and attributes of IO windows) are fixed by the nature of the
524 device, and can be hard-wired here.
526 link->conf.Attributes = 0;
527 link->conf.IntType = INT_MEMORY_AND_IO;
529 pcmcia_cur_dev = link;
534 } /* dio700_cs_attach */
536 /*======================================================================
538 This deletes a driver "instance". The device is de-registered
539 with Card Services. If it has been released, all local data
540 structures are freed. Otherwise, the structures will be freed
541 when the device is released.
543 ======================================================================*/
545 static void dio700_cs_detach(struct pcmcia_device *link)
548 printk(KERN_INFO "ni_daq_700: cs-detach!\n");
550 DEBUG(0, "dio700_cs_detach(0x%p)\n", link);
552 if (link->dev_node) {
553 ((local_info_t *) link->priv)->stop = 1;
554 dio700_release(link);
557 /* This points to the parent local_info_t struct */
561 } /* dio700_cs_detach */
563 /*======================================================================
565 dio700_config() is scheduled to run after a CARD_INSERTION event
566 is received, to configure the PCMCIA socket, and to make the
567 device available to the system.
569 ======================================================================*/
571 static void dio700_config(struct pcmcia_device *link)
573 local_info_t *dev = link->priv;
580 cistpl_cftable_entry_t dflt = { 0 };
582 printk(KERN_INFO "ni_daq_700: cs-config\n");
584 DEBUG(0, "dio700_config(0x%p)\n", link);
587 This reads the card's CONFIG tuple to find its configuration
590 tuple.DesiredTuple = CISTPL_CONFIG;
591 tuple.Attributes = 0;
592 tuple.TupleData = buf;
593 tuple.TupleDataMax = sizeof(buf);
594 tuple.TupleOffset = 0;
595 if ((last_ret = pcmcia_get_first_tuple(link, &tuple)) != 0) {
596 cs_error(link, GetFirstTuple, last_ret);
599 if ((last_ret = pcmcia_get_tuple_data(link, &tuple)) != 0) {
600 cs_error(link, GetTupleData, last_ret);
603 if ((last_ret = pcmcia_parse_tuple(&tuple, &parse)) != 0) {
604 cs_error(link, ParseTuple, last_ret);
607 link->conf.ConfigBase = parse.config.base;
608 link->conf.Present = parse.config.rmask[0];
611 In this loop, we scan the CIS for configuration table entries,
612 each of which describes a valid card configuration, including
613 voltage, IO window, memory window, and interrupt settings.
615 We make no assumptions about the card to be configured: we use
616 just the information available in the CIS. In an ideal world,
617 this would work for any PCMCIA card, but it requires a complete
618 and accurate CIS. In practice, a driver usually "knows" most of
619 these things without consulting the CIS, and most client drivers
620 will only use the CIS to fill in implementation-defined details.
622 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
623 if ((last_ret = pcmcia_get_first_tuple(link, &tuple)) != 0) {
624 cs_error(link, GetFirstTuple, last_ret);
628 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
629 if (pcmcia_get_tuple_data(link, &tuple) != 0)
631 if (pcmcia_parse_tuple(&tuple, &parse) != 0)
634 if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
638 link->conf.ConfigIndex = cfg->index;
640 /* Does this card need audio output? */
641 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
642 link->conf.Attributes |= CONF_ENABLE_SPKR;
643 link->conf.Status = CCSR_AUDIO_ENA;
646 /* Do we need to allocate an interrupt? */
647 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
648 link->conf.Attributes |= CONF_ENABLE_IRQ;
650 /* IO window settings */
651 link->io.NumPorts1 = link->io.NumPorts2 = 0;
652 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
653 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
654 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
655 if (!(io->flags & CISTPL_IO_8BIT))
656 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
657 if (!(io->flags & CISTPL_IO_16BIT))
658 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
659 link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
660 link->io.BasePort1 = io->win[0].base;
661 link->io.NumPorts1 = io->win[0].len;
663 link->io.Attributes2 = link->io.Attributes1;
664 link->io.BasePort2 = io->win[1].base;
665 link->io.NumPorts2 = io->win[1].len;
667 /* This reserves IO space but doesn't actually enable it */
668 if (pcmcia_request_io(link, &link->io) != 0)
672 if ((cfg->mem.nwin > 0) || (dflt.mem.nwin > 0)) {
674 (cfg->mem.nwin) ? &cfg->mem : &dflt.mem;
675 req.Attributes = WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM;
676 req.Attributes |= WIN_ENABLE;
677 req.Base = mem->win[0].host_addr;
678 req.Size = mem->win[0].len;
679 if (req.Size < 0x1000)
682 if (pcmcia_request_window(&link, &req, &link->win))
685 map.CardOffset = mem->win[0].card_addr;
686 if (pcmcia_map_mem_page(link->win, &map))
689 /* If we got this far, we're cool! */
693 if ((last_ret = pcmcia_get_next_tuple(link, &tuple)) != 0) {
694 cs_error(link, GetNextTuple, last_ret);
700 Allocate an interrupt line. Note that this does not assign a
701 handler to the interrupt, unless the 'Handler' member of the
702 irq structure is initialized.
704 if (link->conf.Attributes & CONF_ENABLE_IRQ)
705 if ((last_ret = pcmcia_request_irq(link, &link->irq)) != 0) {
706 cs_error(link, RequestIRQ, last_ret);
711 This actually configures the PCMCIA socket -- setting up
712 the I/O windows and the interrupt mapping, and putting the
713 card and host interface into "Memory and IO" mode.
715 if ((last_ret = pcmcia_request_configuration(link, &link->conf)) != 0) {
716 cs_error(link, RequestConfiguration, last_ret);
721 At this point, the dev_node_t structure(s) need to be
722 initialized and arranged in a linked list at link->dev.
724 sprintf(dev->node.dev_name, "ni_daq_700");
725 dev->node.major = dev->node.minor = 0;
726 link->dev_node = &dev->node;
728 /* Finally, report what we've done */
729 printk(KERN_INFO "%s: index 0x%02x",
730 dev->node.dev_name, link->conf.ConfigIndex);
731 if (link->conf.Attributes & CONF_ENABLE_IRQ)
732 printk(", irq %d", link->irq.AssignedIRQ);
733 if (link->io.NumPorts1)
734 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
735 link->io.BasePort1 + link->io.NumPorts1 - 1);
736 if (link->io.NumPorts2)
737 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
738 link->io.BasePort2 + link->io.NumPorts2 - 1);
740 printk(", mem 0x%06lx-0x%06lx", req.Base,
741 req.Base + req.Size - 1);
747 printk(KERN_INFO "ni_daq_700 cs failed");
748 dio700_release(link);
750 } /* dio700_config */
752 static void dio700_release(struct pcmcia_device *link)
754 DEBUG(0, "dio700_release(0x%p)\n", link);
756 pcmcia_disable_device(link);
757 } /* dio700_release */
759 /*======================================================================
761 The card status event handler. Mostly, this schedules other
762 stuff to run after an event is received.
764 When a CARD_REMOVAL event is received, we immediately set a
765 private flag to block future accesses to this device. All the
766 functions that actually access the device should check this flag
767 to make sure the card is still present.
769 ======================================================================*/
771 static int dio700_cs_suspend(struct pcmcia_device *link)
773 local_info_t *local = link->priv;
775 /* Mark the device as stopped, to block IO until later */
778 } /* dio700_cs_suspend */
780 static int dio700_cs_resume(struct pcmcia_device *link)
782 local_info_t *local = link->priv;
786 } /* dio700_cs_resume */
788 /*====================================================================*/
790 static struct pcmcia_device_id dio700_cs_ids[] = {
791 /* N.B. These IDs should match those in dio700_boards */
792 PCMCIA_DEVICE_MANF_CARD(0x010b, 0x4743), /* daqcard-700 */
796 MODULE_LICENSE("GPL");
797 MODULE_DEVICE_TABLE(pcmcia, dio700_cs_ids);
799 struct pcmcia_driver dio700_cs_driver = {
800 .probe = dio700_cs_attach,
801 .remove = dio700_cs_detach,
802 .suspend = dio700_cs_suspend,
803 .resume = dio700_cs_resume,
804 .id_table = dio700_cs_ids,
805 .owner = THIS_MODULE,
811 static int __init init_dio700_cs(void)
813 printk("ni_daq_700: cs-init \n");
814 DEBUG(0, "%s\n", version);
815 pcmcia_register_driver(&dio700_cs_driver);
819 static void __exit exit_dio700_cs(void)
821 DEBUG(0, "ni_daq_700: unloading\n");
822 pcmcia_unregister_driver(&dio700_cs_driver);
824 int __init init_module(void)
828 ret = init_dio700_cs();
832 return comedi_driver_register(&driver_dio700);
835 void __exit cleanup_module(void)
838 comedi_driver_unregister(&driver_dio700);