ni_daq_700.c revision 9a017a910346afd88ec2e065989903bf211a7d37
1/*
2 *     comedi/drivers/ni_daq_700.c
3 *     Driver for DAQCard-700 DIO only
4 *     copied from 8255
5 *
6 *     COMEDI - Linux Control and Measurement Device Interface
7 *     Copyright (C) 1998 David A. Schleef <ds@schleef.org>
8 *
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.
13 *
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.
18 *
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.
22 *
23 */
24
25/*
26Driver: ni_daq_700
27Description: National Instruments PCMCIA DAQCard-700 DIO only
28Author: Fred Brooks <nsaspook@nsaspook.com>,
29  based on ni_daq_dio24 by Daniel Vecino Castel <dvecino@able.es>
30Devices: [National Instruments] PCMCIA DAQ-Card-700 (ni_daq_700)
31Status: works
32Updated: Thu, 21 Feb 2008 12:07:20 +0000
33
34The daqcard-700 appears in Comedi as a single digital I/O subdevice with
3516 channels.  The channel 0 corresponds to the daqcard-700's output
36port, bit 0; channel 8 corresponds to the input port, bit 0.
37
38Direction configuration: channels 0-7 output, 8-15 input (8225 device
39emu as port A output, port B input, port C N/A).
40
41IRQ is assigned but not used.
42*/
43
44#include <linux/interrupt.h>
45#include <linux/slab.h>
46#include "../comedidev.h"
47
48#include <linux/ioport.h>
49
50#include <pcmcia/cs.h>
51#include <pcmcia/cistpl.h>
52#include <pcmcia/cisreg.h>
53#include <pcmcia/ds.h>
54
55static struct pcmcia_device *pcmcia_cur_dev = NULL;
56
57#define DIO700_SIZE 8		/*  size of io region used by board */
58
59static int dio700_attach(struct comedi_device *dev,
60			 struct comedi_devconfig *it);
61static int dio700_detach(struct comedi_device *dev);
62
63enum dio700_bustype { pcmcia_bustype };
64
65struct dio700_board {
66	const char *name;
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 */
71	/*  as appropriate */
72	unsigned int (*read_byte) (unsigned int address);
73	void (*write_byte) (unsigned int byte, unsigned int address);
74};
75
76static const struct dio700_board dio700_boards[] = {
77	{
78	 .name = "daqcard-700",
79	  /*  0x10b is manufacturer id, 0x4743 is device id */
80	 .device_id = 0x4743,
81	 .bustype = pcmcia_bustype,
82	 .have_dio = 1,
83	 },
84	{
85	 .name = "ni_daq_700",
86	  /*  0x10b is manufacturer id, 0x4743 is device id */
87	 .device_id = 0x4743,
88	 .bustype = pcmcia_bustype,
89	 .have_dio = 1,
90	 },
91};
92
93/*
94 * Useful for shorthand access to the particular board structure
95 */
96#define thisboard ((const struct dio700_board *)dev->board_ptr)
97
98struct dio700_private {
99
100	int data;		/* number of data points left to be taken */
101};
102
103#define devpriv ((struct dio700_private *)dev->private)
104
105static struct comedi_driver driver_dio700 = {
106	.driver_name = "ni_daq_700",
107	.module = THIS_MODULE,
108	.attach = dio700_attach,
109	.detach = dio700_detach,
110	.num_names = ARRAY_SIZE(dio700_boards),
111	.board_name = &dio700_boards[0].name,
112	.offset = sizeof(struct dio700_board),
113};
114
115/*	the real driver routines	*/
116
117#define _700_SIZE 8
118
119#define _700_DATA 0
120
121#define DIO_W		0x04
122#define DIO_R		0x05
123
124struct subdev_700_struct {
125	unsigned long cb_arg;
126	int (*cb_func) (int, int, int, unsigned long);
127	int have_irq;
128};
129
130#define CALLBACK_ARG	(((struct subdev_700_struct *)s->private)->cb_arg)
131#define CALLBACK_FUNC	(((struct subdev_700_struct *)s->private)->cb_func)
132#define subdevpriv	((struct subdev_700_struct *)s->private)
133
134static void do_config(struct comedi_device *dev, struct comedi_subdevice *s);
135
136void subdev_700_interrupt(struct comedi_device *dev, struct comedi_subdevice *s)
137{
138	short d;
139
140	d = CALLBACK_FUNC(0, _700_DATA, 0, CALLBACK_ARG);
141
142	comedi_buf_put(s->async, d);
143	s->async->events |= COMEDI_CB_EOS;
144
145	comedi_event(dev, s);
146}
147EXPORT_SYMBOL(subdev_700_interrupt);
148
149static int subdev_700_cb(int dir, int port, int data, unsigned long arg)
150{
151	/* port is always A for output and B for input (8255 emu) */
152	unsigned long iobase = arg;
153
154	if (dir) {
155		outb(data, iobase + DIO_W);
156		return 0;
157	} else {
158		return inb(iobase + DIO_R);
159	}
160}
161
162static int subdev_700_insn(struct comedi_device *dev,
163			   struct comedi_subdevice *s, struct comedi_insn *insn,
164			   unsigned int *data)
165{
166	if (data[0]) {
167		s->state &= ~data[0];
168		s->state |= (data[0] & data[1]);
169
170		if (data[0] & 0xff)
171			CALLBACK_FUNC(1, _700_DATA, s->state & 0xff,
172				      CALLBACK_ARG);
173	}
174
175	data[1] = s->state & 0xff;
176	data[1] |= CALLBACK_FUNC(0, _700_DATA, 0, CALLBACK_ARG) << 8;
177
178	return 2;
179}
180
181static int subdev_700_insn_config(struct comedi_device *dev,
182				  struct comedi_subdevice *s,
183				  struct comedi_insn *insn, unsigned int *data)
184{
185
186	switch (data[0]) {
187	case INSN_CONFIG_DIO_INPUT:
188		break;
189	case INSN_CONFIG_DIO_OUTPUT:
190		break;
191	case INSN_CONFIG_DIO_QUERY:
192		data[1] =
193		    (s->
194		     io_bits & (1 << CR_CHAN(insn->chanspec))) ? COMEDI_OUTPUT :
195		    COMEDI_INPUT;
196		return insn->n;
197		break;
198	default:
199		return -EINVAL;
200	}
201
202	return 1;
203}
204
205static void do_config(struct comedi_device *dev, struct comedi_subdevice *s)
206{				/* use powerup defaults */
207	return;
208}
209
210static int subdev_700_cmdtest(struct comedi_device *dev,
211			      struct comedi_subdevice *s,
212			      struct comedi_cmd *cmd)
213{
214	int err = 0;
215	unsigned int tmp;
216
217	/* step 1 */
218
219	tmp = cmd->start_src;
220	cmd->start_src &= TRIG_NOW;
221	if (!cmd->start_src || tmp != cmd->start_src)
222		err++;
223
224	tmp = cmd->scan_begin_src;
225	cmd->scan_begin_src &= TRIG_EXT;
226	if (!cmd->scan_begin_src || tmp != cmd->scan_begin_src)
227		err++;
228
229	tmp = cmd->convert_src;
230	cmd->convert_src &= TRIG_FOLLOW;
231	if (!cmd->convert_src || tmp != cmd->convert_src)
232		err++;
233
234	tmp = cmd->scan_end_src;
235	cmd->scan_end_src &= TRIG_COUNT;
236	if (!cmd->scan_end_src || tmp != cmd->scan_end_src)
237		err++;
238
239	tmp = cmd->stop_src;
240	cmd->stop_src &= TRIG_NONE;
241	if (!cmd->stop_src || tmp != cmd->stop_src)
242		err++;
243
244	if (err)
245		return 1;
246
247	/* step 2 */
248
249	if (err)
250		return 2;
251
252	/* step 3 */
253
254	if (cmd->start_arg != 0) {
255		cmd->start_arg = 0;
256		err++;
257	}
258	if (cmd->scan_begin_arg != 0) {
259		cmd->scan_begin_arg = 0;
260		err++;
261	}
262	if (cmd->convert_arg != 0) {
263		cmd->convert_arg = 0;
264		err++;
265	}
266	if (cmd->scan_end_arg != 1) {
267		cmd->scan_end_arg = 1;
268		err++;
269	}
270	if (cmd->stop_arg != 0) {
271		cmd->stop_arg = 0;
272		err++;
273	}
274
275	if (err)
276		return 3;
277
278	/* step 4 */
279
280	if (err)
281		return 4;
282
283	return 0;
284}
285
286static int subdev_700_cmd(struct comedi_device *dev, struct comedi_subdevice *s)
287{
288	/* FIXME */
289
290	return 0;
291}
292
293static int subdev_700_cancel(struct comedi_device *dev,
294			     struct comedi_subdevice *s)
295{
296	/* FIXME */
297
298	return 0;
299}
300
301int subdev_700_init(struct comedi_device *dev, struct comedi_subdevice *s,
302		    int (*cb) (int, int, int, unsigned long), unsigned long arg)
303{
304	s->type = COMEDI_SUBD_DIO;
305	s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
306	s->n_chan = 16;
307	s->range_table = &range_digital;
308	s->maxdata = 1;
309
310	s->private = kmalloc(sizeof(struct subdev_700_struct), GFP_KERNEL);
311	if (!s->private)
312		return -ENOMEM;
313
314	CALLBACK_ARG = arg;
315	if (cb == NULL)
316		CALLBACK_FUNC = subdev_700_cb;
317	 else
318		CALLBACK_FUNC = cb;
319
320	s->insn_bits = subdev_700_insn;
321	s->insn_config = subdev_700_insn_config;
322
323	s->state = 0;
324	s->io_bits = 0x00ff;
325	do_config(dev, s);
326
327	return 0;
328}
329EXPORT_SYMBOL(subdev_700_init);
330
331int subdev_700_init_irq(struct comedi_device *dev, struct comedi_subdevice *s,
332			int (*cb) (int, int, int, unsigned long),
333			unsigned long arg)
334{
335	int ret;
336
337	ret = subdev_700_init(dev, s, cb, arg);
338	if (ret < 0)
339		return ret;
340
341	s->do_cmdtest = subdev_700_cmdtest;
342	s->do_cmd = subdev_700_cmd;
343	s->cancel = subdev_700_cancel;
344
345	subdevpriv->have_irq = 1;
346
347	return 0;
348}
349EXPORT_SYMBOL(subdev_700_init_irq);
350
351void subdev_700_cleanup(struct comedi_device *dev, struct comedi_subdevice *s)
352{
353	if (s->private)
354		if (subdevpriv->have_irq)
355
356			kfree(s->private);
357}
358EXPORT_SYMBOL(subdev_700_cleanup);
359
360static int dio700_attach(struct comedi_device *dev, struct comedi_devconfig *it)
361{
362	struct comedi_subdevice *s;
363	unsigned long iobase = 0;
364#ifdef incomplete
365	unsigned int irq = 0;
366#endif
367	struct pcmcia_device *link;
368
369	/* allocate and initialize dev->private */
370	if (alloc_private(dev, sizeof(struct dio700_private)) < 0)
371		return -ENOMEM;
372
373	/*  get base address, irq etc. based on bustype */
374	switch (thisboard->bustype) {
375	case pcmcia_bustype:
376		link = pcmcia_cur_dev;	/* XXX hack */
377		if (!link)
378			return -EIO;
379		iobase = link->resource[0]->start;
380#ifdef incomplete
381		irq = link->irq;
382#endif
383		break;
384	default:
385		printk("bug! couldn't determine board type\n");
386		return -EINVAL;
387		break;
388	}
389	printk("comedi%d: ni_daq_700: %s, io 0x%lx", dev->minor,
390	       thisboard->name, iobase);
391#ifdef incomplete
392	if (irq)
393		printk(", irq %u", irq);
394
395#endif
396
397	printk("\n");
398
399	if (iobase == 0) {
400		printk("io base address is zero!\n");
401		return -EINVAL;
402	}
403
404	dev->iobase = iobase;
405
406#ifdef incomplete
407	/* grab our IRQ */
408	dev->irq = irq;
409#endif
410
411	dev->board_name = thisboard->name;
412
413	if (alloc_subdevices(dev, 1) < 0)
414		return -ENOMEM;
415
416	/* DAQCard-700 dio */
417	s = dev->subdevices + 0;
418	subdev_700_init(dev, s, NULL, dev->iobase);
419
420	return 0;
421};
422
423static int dio700_detach(struct comedi_device *dev)
424{
425	printk("comedi%d: ni_daq_700: cs-remove\n", dev->minor);
426
427	if (dev->subdevices)
428		subdev_700_cleanup(dev, dev->subdevices + 0);
429
430	if (thisboard->bustype != pcmcia_bustype && dev->iobase)
431		release_region(dev->iobase, DIO700_SIZE);
432	if (dev->irq)
433		free_irq(dev->irq, dev);
434
435	return 0;
436};
437
438/* PCMCIA crap -- watch your words, please! */
439
440static void dio700_config(struct pcmcia_device *link);
441static void dio700_release(struct pcmcia_device *link);
442static int dio700_cs_suspend(struct pcmcia_device *p_dev);
443static int dio700_cs_resume(struct pcmcia_device *p_dev);
444
445/*
446   The attach() and detach() entry points are used to create and destroy
447   "instances" of the driver, where each instance represents everything
448   needed to manage one actual PCMCIA card.
449*/
450
451static int dio700_cs_attach(struct pcmcia_device *);
452static void dio700_cs_detach(struct pcmcia_device *);
453
454/*
455   You'll also need to prototype all the functions that will actually
456   be used to talk to your device.  See 'memory_cs' for a good example
457   of a fully self-sufficient driver; the other drivers rely more or
458   less on other parts of the kernel.
459*/
460
461/*
462   The dev_info variable is the "key" that is used to match up this
463   device driver with appropriate cards, through the card configuration
464   database.
465*/
466
467static const dev_info_t dev_info = "ni_daq_700";
468
469struct local_info_t {
470	struct pcmcia_device *link;
471	int stop;
472	struct bus_operations *bus;
473};
474
475/*======================================================================
476
477    dio700_cs_attach() creates an "instance" of the driver, allocating
478    local data structures for one device.  The device is registered
479    with Card Services.
480
481    The dev_link structure is initialized, but we don't actually
482    configure the card at this point -- we wait until we receive a
483    card insertion event.
484
485======================================================================*/
486
487static int dio700_cs_attach(struct pcmcia_device *link)
488{
489	struct local_info_t *local;
490
491	printk(KERN_INFO "ni_daq_700:  cs-attach\n");
492
493	dev_dbg(&link->dev, "dio700_cs_attach()\n");
494
495	/* Allocate space for private device-specific data */
496	local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
497	if (!local)
498		return -ENOMEM;
499	local->link = link;
500	link->priv = local;
501
502	/*
503	   General socket configuration defaults can go here.  In this
504	   client, we assume very little, and rely on the CIS for almost
505	   everything.  In most clients, many details (i.e., number, sizes,
506	   and attributes of IO windows) are fixed by the nature of the
507	   device, and can be hard-wired here.
508	 */
509	link->conf.Attributes = 0;
510	link->conf.IntType = INT_MEMORY_AND_IO;
511
512	pcmcia_cur_dev = link;
513
514	dio700_config(link);
515
516	return 0;
517}				/* dio700_cs_attach */
518
519/*======================================================================
520
521    This deletes a driver "instance".  The device is de-registered
522    with Card Services.  If it has been released, all local data
523    structures are freed.  Otherwise, the structures will be freed
524    when the device is released.
525
526======================================================================*/
527
528static void dio700_cs_detach(struct pcmcia_device *link)
529{
530
531	printk(KERN_INFO "ni_daq_700: cs-detach!\n");
532
533	dev_dbg(&link->dev, "dio700_cs_detach\n");
534
535	((struct local_info_t *)link->priv)->stop = 1;
536	dio700_release(link);
537
538	/* This points to the parent struct local_info_t struct */
539	if (link->priv)
540		kfree(link->priv);
541
542}				/* dio700_cs_detach */
543
544/*======================================================================
545
546    dio700_config() is scheduled to run after a CARD_INSERTION event
547    is received, to configure the PCMCIA socket, and to make the
548    device available to the system.
549
550======================================================================*/
551
552static int dio700_pcmcia_config_loop(struct pcmcia_device *p_dev,
553				cistpl_cftable_entry_t *cfg,
554				cistpl_cftable_entry_t *dflt,
555				unsigned int vcc,
556				void *priv_data)
557{
558	win_req_t *req = priv_data;
559	memreq_t map;
560
561	if (cfg->index == 0)
562		return -ENODEV;
563
564	/* Does this card need audio output? */
565	if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
566		p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
567		p_dev->conf.Status = CCSR_AUDIO_ENA;
568	}
569
570	/* Do we need to allocate an interrupt? */
571	p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
572
573	/* IO window settings */
574	p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
575	if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
576		cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
577		p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
578		if (!(io->flags & CISTPL_IO_8BIT))
579			p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
580		if (!(io->flags & CISTPL_IO_16BIT))
581			p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
582		p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
583		p_dev->io.BasePort1 = io->win[0].base;
584		p_dev->io.NumPorts1 = io->win[0].len;
585		if (io->nwin > 1) {
586			p_dev->io.Attributes2 = p_dev->io.Attributes1;
587			p_dev->io.BasePort2 = io->win[1].base;
588			p_dev->io.NumPorts2 = io->win[1].len;
589		}
590		/* This reserves IO space but doesn't actually enable it */
591		if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
592			return -ENODEV;
593	}
594
595	if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
596		cistpl_mem_t *mem =
597			(cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
598		req->Attributes = WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM;
599		req->Attributes |= WIN_ENABLE;
600		req->Base = mem->win[0].host_addr;
601		req->Size = mem->win[0].len;
602		if (req->Size < 0x1000)
603			req->Size = 0x1000;
604		req->AccessSpeed = 0;
605		if (pcmcia_request_window(p_dev, req, &p_dev->win))
606			return -ENODEV;
607		map.Page = 0;
608		map.CardOffset = mem->win[0].card_addr;
609		if (pcmcia_map_mem_page(p_dev, p_dev->win, &map))
610			return -ENODEV;
611	}
612	/* If we got this far, we're cool! */
613	return 0;
614}
615
616static void dio700_config(struct pcmcia_device *link)
617{
618	win_req_t req;
619	int ret;
620
621	printk(KERN_INFO "ni_daq_700:  cs-config\n");
622
623	dev_dbg(&link->dev, "dio700_config\n");
624
625	ret = pcmcia_loop_config(link, dio700_pcmcia_config_loop, &req);
626	if (ret) {
627		dev_warn(&link->dev, "no configuration found\n");
628		goto failed;
629	}
630
631	if (!link->irq)
632		goto failed;
633
634	/*
635	   This actually configures the PCMCIA socket -- setting up
636	   the I/O windows and the interrupt mapping, and putting the
637	   card and host interface into "Memory and IO" mode.
638	 */
639	ret = pcmcia_request_configuration(link, &link->conf);
640	if (ret != 0)
641		goto failed;
642
643	/* Finally, report what we've done */
644	dev_info(&link->dev, "index 0x%02x", link->conf.ConfigIndex);
645	if (link->conf.Attributes & CONF_ENABLE_IRQ)
646		printk(", irq %d", link->irq);
647	if (link->resource[0])
648		printk(", io %pR", link->resource[0]);
649	if (link->resource[1])
650		printk(" & %pR", link->resource[1]);
651	if (link->win)
652		printk(", mem 0x%06lx-0x%06lx", req.Base,
653		       req.Base + req.Size - 1);
654	printk("\n");
655
656	return;
657
658failed:
659	printk(KERN_INFO "ni_daq_700 cs failed");
660	dio700_release(link);
661
662}				/* dio700_config */
663
664static void dio700_release(struct pcmcia_device *link)
665{
666	dev_dbg(&link->dev, "dio700_release\n");
667
668	pcmcia_disable_device(link);
669}				/* dio700_release */
670
671/*======================================================================
672
673    The card status event handler.  Mostly, this schedules other
674    stuff to run after an event is received.
675
676    When a CARD_REMOVAL event is received, we immediately set a
677    private flag to block future accesses to this device.  All the
678    functions that actually access the device should check this flag
679    to make sure the card is still present.
680
681======================================================================*/
682
683static int dio700_cs_suspend(struct pcmcia_device *link)
684{
685	struct local_info_t *local = link->priv;
686
687	/* Mark the device as stopped, to block IO until later */
688	local->stop = 1;
689	return 0;
690}				/* dio700_cs_suspend */
691
692static int dio700_cs_resume(struct pcmcia_device *link)
693{
694	struct local_info_t *local = link->priv;
695
696	local->stop = 0;
697	return 0;
698}				/* dio700_cs_resume */
699
700/*====================================================================*/
701
702static struct pcmcia_device_id dio700_cs_ids[] = {
703	/* N.B. These IDs should match those in dio700_boards */
704	PCMCIA_DEVICE_MANF_CARD(0x010b, 0x4743),	/* daqcard-700 */
705	PCMCIA_DEVICE_NULL
706};
707
708
709MODULE_DEVICE_TABLE(pcmcia, dio700_cs_ids);
710MODULE_AUTHOR("Fred Brooks <nsaspook@nsaspook.com>");
711MODULE_DESCRIPTION("Comedi driver for National Instruments "
712		   "PCMCIA DAQCard-700 DIO");
713MODULE_LICENSE("GPL");
714
715struct pcmcia_driver dio700_cs_driver = {
716	.probe = dio700_cs_attach,
717	.remove = dio700_cs_detach,
718	.suspend = dio700_cs_suspend,
719	.resume = dio700_cs_resume,
720	.id_table = dio700_cs_ids,
721	.owner = THIS_MODULE,
722	.drv = {
723		.name = dev_info,
724		},
725};
726
727static int __init init_dio700_cs(void)
728{
729	pcmcia_register_driver(&dio700_cs_driver);
730	return 0;
731}
732
733static void __exit exit_dio700_cs(void)
734{
735	pr_debug("ni_daq_700: unloading\n");
736	pcmcia_unregister_driver(&dio700_cs_driver);
737}
738
739int __init init_module(void)
740{
741	int ret;
742
743	ret = init_dio700_cs();
744	if (ret < 0)
745		return ret;
746
747	return comedi_driver_register(&driver_dio700);
748}
749
750void __exit cleanup_module(void)
751{
752	exit_dio700_cs();
753	comedi_driver_unregister(&driver_dio700);
754}
755