ni_daq_dio24.c revision 55a19b39acb8888af8e9cfe5b762d03c52fdb48c
1/*
2    comedi/drivers/ni_daq_dio24.c
3    Driver for National Instruments PCMCIA DAQ-Card DIO-24
4    Copyright (C) 2002 Daniel Vecino Castel <dvecino@able.es>
5
6    PCMCIA crap at end of file is adapted from dummy_cs.c 1.31 2001/08/24 12:13:13
7    from the pcmcia package.
8    The initial developer of the pcmcia dummy_cs.c code is David A. Hinds
9    <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
10    are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
11
12    This program is free software; you can redistribute it and/or modify
13    it under the terms of the GNU General Public License as published by
14    the Free Software Foundation; either version 2 of the License, or
15    (at your option) any later version.
16
17    This program is distributed in the hope that it will be useful,
18    but WITHOUT ANY WARRANTY; without even the implied warranty of
19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20    GNU General Public License for more details.
21
22    You should have received a copy of the GNU General Public License
23    along with this program; if not, write to the Free Software
24    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25
26************************************************************************
27*/
28/*
29Driver: ni_daq_dio24
30Description: National Instruments PCMCIA DAQ-Card DIO-24
31Author: Daniel Vecino Castel <dvecino@able.es>
32Devices: [National Instruments] PCMCIA DAQ-Card DIO-24 (ni_daq_dio24)
33Status: ?
34Updated: Thu, 07 Nov 2002 21:53:06 -0800
35
36This is just a wrapper around the 8255.o driver to properly handle
37the PCMCIA interface.
38*/
39
40			    /* #define LABPC_DEBUG *//*  enable debugging messages */
41#undef LABPC_DEBUG
42
43#include <linux/interrupt.h>
44#include "../comedidev.h"
45
46#include <linux/ioport.h>
47
48#include "8255.h"
49
50#include <pcmcia/cs_types.h>
51#include <pcmcia/cs.h>
52#include <pcmcia/cistpl.h>
53#include <pcmcia/cisreg.h>
54#include <pcmcia/ds.h>
55
56static struct pcmcia_device *pcmcia_cur_dev = NULL;
57
58#define DIO24_SIZE 4		/*  size of io region used by board */
59
60static int dio24_attach(struct comedi_device *dev, struct comedi_devconfig *it);
61static int dio24_detach(struct comedi_device *dev);
62
63enum dio24_bustype { pcmcia_bustype };
64
65struct dio24_board_struct {
66	const char *name;
67	int device_id;		/*  device id for pcmcia board */
68	enum dio24_bustype bustype;	/*  PCMCIA */
69	int have_dio;		/*  have 8255 chip */
70	/*  function pointers so we can use inb/outb or readb/writeb as appropriate */
71	unsigned int (*read_byte) (unsigned int address);
72	void (*write_byte) (unsigned int byte, unsigned int address);
73};
74
75static const struct dio24_board_struct dio24_boards[] = {
76	{
77	 .name = "daqcard-dio24",
78	 .device_id = 0x475c,	/*  0x10b is manufacturer id, 0x475c is device id */
79	 .bustype = pcmcia_bustype,
80	 .have_dio = 1,
81	 },
82	{
83	 .name = "ni_daq_dio24",
84	 .device_id = 0x475c,	/*  0x10b is manufacturer id, 0x475c is device id */
85	 .bustype = pcmcia_bustype,
86	 .have_dio = 1,
87	 },
88};
89
90/*
91 * Useful for shorthand access to the particular board structure
92 */
93#define thisboard ((const struct dio24_board_struct *)dev->board_ptr)
94
95struct dio24_private {
96
97	int data;		/* number of data points left to be taken */
98};
99
100#define devpriv ((struct dio24_private *)dev->private)
101
102static struct comedi_driver driver_dio24 = {
103	.driver_name = "ni_daq_dio24",
104	.module = THIS_MODULE,
105	.attach = dio24_attach,
106	.detach = dio24_detach,
107	.num_names = ARRAY_SIZE(dio24_boards),
108	.board_name = &dio24_boards[0].name,
109	.offset = sizeof(struct dio24_board_struct),
110};
111
112static int dio24_attach(struct comedi_device *dev, struct comedi_devconfig *it)
113{
114	struct comedi_subdevice *s;
115	unsigned long iobase = 0;
116#ifdef incomplete
117	unsigned int irq = 0;
118#endif
119	struct pcmcia_device *link;
120
121	/* allocate and initialize dev->private */
122	if (alloc_private(dev, sizeof(struct dio24_private)) < 0)
123		return -ENOMEM;
124
125	/*  get base address, irq etc. based on bustype */
126	switch (thisboard->bustype) {
127	case pcmcia_bustype:
128		link = pcmcia_cur_dev;	/* XXX hack */
129		if (!link)
130			return -EIO;
131		iobase = link->io.BasePort1;
132#ifdef incomplete
133		irq = link->irq.AssignedIRQ;
134#endif
135		break;
136	default:
137		printk("bug! couldn't determine board type\n");
138		return -EINVAL;
139		break;
140	}
141	printk("comedi%d: ni_daq_dio24: %s, io 0x%lx", dev->minor,
142	       thisboard->name, iobase);
143#ifdef incomplete
144	if (irq) {
145		printk(", irq %u", irq);
146	}
147#endif
148
149	printk("\n");
150
151	if (iobase == 0) {
152		printk("io base address is zero!\n");
153		return -EINVAL;
154	}
155
156	dev->iobase = iobase;
157
158#ifdef incomplete
159	/* grab our IRQ */
160	dev->irq = irq;
161#endif
162
163	dev->board_name = thisboard->name;
164
165	if (alloc_subdevices(dev, 1) < 0)
166		return -ENOMEM;
167
168	/* 8255 dio */
169	s = dev->subdevices + 0;
170	subdev_8255_init(dev, s, NULL, dev->iobase);
171
172	return 0;
173};
174
175static int dio24_detach(struct comedi_device *dev)
176{
177	printk("comedi%d: ni_daq_dio24: remove\n", dev->minor);
178
179	if (dev->subdevices)
180		subdev_8255_cleanup(dev, dev->subdevices + 0);
181
182	if (thisboard->bustype != pcmcia_bustype && dev->iobase)
183		release_region(dev->iobase, DIO24_SIZE);
184	if (dev->irq)
185		free_irq(dev->irq, dev);
186
187	return 0;
188};
189
190/* PCMCIA crap -- watch your words! */
191
192static void dio24_config(struct pcmcia_device *link);
193static void dio24_release(struct pcmcia_device *link);
194static int dio24_cs_suspend(struct pcmcia_device *p_dev);
195static int dio24_cs_resume(struct pcmcia_device *p_dev);
196
197/*
198   The attach() and detach() entry points are used to create and destroy
199   "instances" of the driver, where each instance represents everything
200   needed to manage one actual PCMCIA card.
201*/
202
203static int dio24_cs_attach(struct pcmcia_device *);
204static void dio24_cs_detach(struct pcmcia_device *);
205
206/*
207   You'll also need to prototype all the functions that will actually
208   be used to talk to your device.  See 'memory_cs' for a good example
209   of a fully self-sufficient driver; the other drivers rely more or
210   less on other parts of the kernel.
211*/
212
213/*
214   The dev_info variable is the "key" that is used to match up this
215   device driver with appropriate cards, through the card configuration
216   database.
217*/
218
219static const dev_info_t dev_info = "ni_daq_dio24";
220
221struct local_info_t {
222	struct pcmcia_device *link;
223	dev_node_t node;
224	int stop;
225	struct bus_operations *bus;
226};
227
228/*======================================================================
229
230    dio24_cs_attach() creates an "instance" of the driver, allocating
231    local data structures for one device.  The device is registered
232    with Card Services.
233
234    The dev_link structure is initialized, but we don't actually
235    configure the card at this point -- we wait until we receive a
236    card insertion event.
237
238======================================================================*/
239
240static int dio24_cs_attach(struct pcmcia_device *link)
241{
242	struct local_info_t *local;
243
244	printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO - CS-attach!\n");
245
246	dev_dbg(&link->dev, "dio24_cs_attach()\n");
247
248	/* Allocate space for private device-specific data */
249	local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
250	if (!local)
251		return -ENOMEM;
252	local->link = link;
253	link->priv = local;
254
255	/* Interrupt setup */
256	link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
257	link->irq.IRQInfo1 = IRQ_LEVEL_ID;
258	link->irq.Handler = NULL;
259
260	/*
261	   General socket configuration defaults can go here.  In this
262	   client, we assume very little, and rely on the CIS for almost
263	   everything.  In most clients, many details (i.e., number, sizes,
264	   and attributes of IO windows) are fixed by the nature of the
265	   device, and can be hard-wired here.
266	 */
267	link->conf.Attributes = 0;
268	link->conf.IntType = INT_MEMORY_AND_IO;
269
270	pcmcia_cur_dev = link;
271
272	dio24_config(link);
273
274	return 0;
275}				/* dio24_cs_attach */
276
277/*======================================================================
278
279    This deletes a driver "instance".  The device is de-registered
280    with Card Services.  If it has been released, all local data
281    structures are freed.  Otherwise, the structures will be freed
282    when the device is released.
283
284======================================================================*/
285
286static void dio24_cs_detach(struct pcmcia_device *link)
287{
288
289	printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO - cs-detach!\n");
290
291	dev_dbg(&link->dev, "dio24_cs_detach\n");
292
293	if (link->dev_node) {
294		((struct local_info_t *)link->priv)->stop = 1;
295		dio24_release(link);
296	}
297
298	/* This points to the parent local_info_t struct */
299	if (link->priv)
300		kfree(link->priv);
301
302}				/* dio24_cs_detach */
303
304/*======================================================================
305
306    dio24_config() is scheduled to run after a CARD_INSERTION event
307    is received, to configure the PCMCIA socket, and to make the
308    device available to the system.
309
310======================================================================*/
311
312static int dio24_pcmcia_config_loop(struct pcmcia_device *p_dev,
313				cistpl_cftable_entry_t *cfg,
314				cistpl_cftable_entry_t *dflt,
315				unsigned int vcc,
316				void *priv_data)
317{
318	win_req_t *req = priv_data;
319	memreq_t map;
320
321	if (cfg->index == 0)
322		return -ENODEV;
323
324	/* Does this card need audio output? */
325	if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
326		p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
327		p_dev->conf.Status = CCSR_AUDIO_ENA;
328	}
329
330	/* Do we need to allocate an interrupt? */
331	if (cfg->irq.IRQInfo1 || dflt->irq.IRQInfo1)
332		p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
333
334	/* IO window settings */
335	p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
336	if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
337		cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
338		p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
339		if (!(io->flags & CISTPL_IO_8BIT))
340			p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
341		if (!(io->flags & CISTPL_IO_16BIT))
342			p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
343		p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
344		p_dev->io.BasePort1 = io->win[0].base;
345		p_dev->io.NumPorts1 = io->win[0].len;
346		if (io->nwin > 1) {
347			p_dev->io.Attributes2 = p_dev->io.Attributes1;
348			p_dev->io.BasePort2 = io->win[1].base;
349			p_dev->io.NumPorts2 = io->win[1].len;
350		}
351		/* This reserves IO space but doesn't actually enable it */
352		if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
353			return -ENODEV;
354	}
355
356	if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
357		cistpl_mem_t *mem =
358			(cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
359		req->Attributes = WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM;
360		req->Attributes |= WIN_ENABLE;
361		req->Base = mem->win[0].host_addr;
362		req->Size = mem->win[0].len;
363		if (req->Size < 0x1000)
364			req->Size = 0x1000;
365		req->AccessSpeed = 0;
366		if (pcmcia_request_window(&p_dev, req, &p_dev->win))
367			return -ENODEV;
368		map.Page = 0;
369		map.CardOffset = mem->win[0].card_addr;
370		if (pcmcia_map_mem_page(p_dev->win, &map))
371			return -ENODEV;
372	}
373	/* If we got this far, we're cool! */
374	return 0;
375}
376
377static void dio24_config(struct pcmcia_device *link)
378{
379	struct local_info_t *dev = link->priv;
380	int ret;
381	win_req_t req;
382
383	printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO! - config\n");
384
385	dev_dbg(&link->dev, "dio24_config\n");
386
387	ret = pcmcia_loop_config(link, dio24_pcmcia_config_loop, &req);
388	if (ret) {
389		dev_warn(&link->dev, "no configuration found\n");
390		goto failed;
391	}
392
393	/*
394	   Allocate an interrupt line.  Note that this does not assign a
395	   handler to the interrupt, unless the 'Handler' member of the
396	   irq structure is initialized.
397	 */
398	if (link->conf.Attributes & CONF_ENABLE_IRQ) {
399		ret = pcmcia_request_irq(link, &link->irq);
400		if (ret)
401			goto failed;
402	}
403
404	/*
405	   This actually configures the PCMCIA socket -- setting up
406	   the I/O windows and the interrupt mapping, and putting the
407	   card and host interface into "Memory and IO" mode.
408	 */
409	ret = pcmcia_request_configuration(link, &link->conf);
410	if (ret)
411		goto failed;
412
413	/*
414	   At this point, the dev_node_t structure(s) need to be
415	   initialized and arranged in a linked list at link->dev.
416	 */
417	sprintf(dev->node.dev_name, "ni_daq_dio24");
418	dev->node.major = dev->node.minor = 0;
419	link->dev_node = &dev->node;
420
421	/* Finally, report what we've done */
422	printk(KERN_INFO "%s: index 0x%02x",
423	       dev->node.dev_name, link->conf.ConfigIndex);
424	if (link->conf.Attributes & CONF_ENABLE_IRQ)
425		printk(", irq %d", link->irq.AssignedIRQ);
426	if (link->io.NumPorts1)
427		printk(", io 0x%04x-0x%04x", link->io.BasePort1,
428		       link->io.BasePort1 + link->io.NumPorts1 - 1);
429	if (link->io.NumPorts2)
430		printk(" & 0x%04x-0x%04x", link->io.BasePort2,
431		       link->io.BasePort2 + link->io.NumPorts2 - 1);
432	if (link->win)
433		printk(", mem 0x%06lx-0x%06lx", req.Base,
434		       req.Base + req.Size - 1);
435	printk("\n");
436
437	return;
438
439failed:
440	printk(KERN_INFO "Fallo");
441	dio24_release(link);
442
443}				/* dio24_config */
444
445static void dio24_release(struct pcmcia_device *link)
446{
447	dev_dbg(&link->dev, "dio24_release\n");
448
449	pcmcia_disable_device(link);
450}				/* dio24_release */
451
452/*======================================================================
453
454    The card status event handler.  Mostly, this schedules other
455    stuff to run after an event is received.
456
457    When a CARD_REMOVAL event is received, we immediately set a
458    private flag to block future accesses to this device.  All the
459    functions that actually access the device should check this flag
460    to make sure the card is still present.
461
462======================================================================*/
463
464static int dio24_cs_suspend(struct pcmcia_device *link)
465{
466	struct local_info_t *local = link->priv;
467
468	/* Mark the device as stopped, to block IO until later */
469	local->stop = 1;
470	return 0;
471}				/* dio24_cs_suspend */
472
473static int dio24_cs_resume(struct pcmcia_device *link)
474{
475	struct local_info_t *local = link->priv;
476
477	local->stop = 0;
478	return 0;
479}				/* dio24_cs_resume */
480
481/*====================================================================*/
482
483static struct pcmcia_device_id dio24_cs_ids[] = {
484	/* N.B. These IDs should match those in dio24_boards */
485	PCMCIA_DEVICE_MANF_CARD(0x010b, 0x475c),	/* daqcard-dio24 */
486	PCMCIA_DEVICE_NULL
487};
488
489MODULE_DEVICE_TABLE(pcmcia, dio24_cs_ids);
490
491struct pcmcia_driver dio24_cs_driver = {
492	.probe = dio24_cs_attach,
493	.remove = dio24_cs_detach,
494	.suspend = dio24_cs_suspend,
495	.resume = dio24_cs_resume,
496	.id_table = dio24_cs_ids,
497	.owner = THIS_MODULE,
498	.drv = {
499		.name = dev_info,
500		},
501};
502
503static int __init init_dio24_cs(void)
504{
505	printk("ni_daq_dio24: HOLA SOY YO!\n");
506	pcmcia_register_driver(&dio24_cs_driver);
507	return 0;
508}
509
510static void __exit exit_dio24_cs(void)
511{
512	pcmcia_unregister_driver(&dio24_cs_driver);
513}
514
515int __init init_module(void)
516{
517	int ret;
518
519	ret = init_dio24_cs();
520	if (ret < 0)
521		return ret;
522
523	return comedi_driver_register(&driver_dio24);
524}
525
526void __exit cleanup_module(void)
527{
528	exit_dio24_cs();
529	comedi_driver_unregister(&driver_dio24);
530}
531