das08_cs.c revision 55a19b39acb8888af8e9cfe5b762d03c52fdb48c 
1/*
2    comedi/drivers/das08_cs.c
3    DAS08 driver
4
5    COMEDI - Linux Control and Measurement Device Interface
6    Copyright (C) 2000 David A. Schleef <ds@schleef.org>
7    Copyright (C) 2001,2002,2003 Frank Mori Hess <fmhess@users.sourceforge.net>
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*/
26/*
27Driver: das08_cs
28Description: DAS-08 PCMCIA boards
29Author: Warren Jasper, ds, Frank Hess
30Devices: [ComputerBoards] PCM-DAS08 (pcm-das08)
31Status: works
32
33This is the PCMCIA-specific support split off from the
34das08 driver.
35
36Options (for pcm-das08):
37        NONE
38
39Command support does not exist, but could be added for this board.
40*/
41
42#include "../comedidev.h"
43
44#include <linux/delay.h>
45#include <linux/pci.h>
46
47#include "das08.h"
48
49/* pcmcia includes */
50#include <pcmcia/cs_types.h>
51#include <pcmcia/cs.h>
52#include <pcmcia/cistpl.h>
53#include <pcmcia/ds.h>
54
55static struct pcmcia_device *cur_dev = NULL;
56
57#define thisboard ((const struct das08_board_struct *)dev->board_ptr)
58
59static int das08_cs_attach(struct comedi_device *dev,
60			   struct comedi_devconfig *it);
61
62static struct comedi_driver driver_das08_cs = {
63	.driver_name = "das08_cs",
64	.module = THIS_MODULE,
65	.attach = das08_cs_attach,
66	.detach = das08_common_detach,
67	.board_name = &das08_cs_boards[0].name,
68	.num_names = ARRAY_SIZE(das08_cs_boards),
69	.offset = sizeof(struct das08_board_struct),
70};
71
72static int das08_cs_attach(struct comedi_device *dev,
73			   struct comedi_devconfig *it)
74{
75	int ret;
76	unsigned long iobase;
77	struct pcmcia_device *link = cur_dev;	/*  XXX hack */
78
79	ret = alloc_private(dev, sizeof(struct das08_private_struct));
80	if (ret < 0)
81		return ret;
82
83	printk("comedi%d: das08_cs: ", dev->minor);
84	/*  deal with a pci board */
85
86	if (thisboard->bustype == pcmcia) {
87		if (link == NULL) {
88			printk(" no pcmcia cards found\n");
89			return -EIO;
90		}
91		iobase = link->io.BasePort1;
92	} else {
93		printk(" bug! board does not have PCMCIA bustype\n");
94		return -EINVAL;
95	}
96
97	printk("\n");
98
99	return das08_common_attach(dev, iobase);
100}
101
102/*======================================================================
103
104    The following pcmcia code for the pcm-das08 is adapted from the
105    dummy_cs.c driver of the Linux PCMCIA Card Services package.
106
107    The initial developer of the original code is David A. Hinds
108    <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
109    are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
110
111======================================================================*/
112
113static void das08_pcmcia_config(struct pcmcia_device *link);
114static void das08_pcmcia_release(struct pcmcia_device *link);
115static int das08_pcmcia_suspend(struct pcmcia_device *p_dev);
116static int das08_pcmcia_resume(struct pcmcia_device *p_dev);
117
118/*
119   The attach() and detach() entry points are used to create and destroy
120   "instances" of the driver, where each instance represents everything
121   needed to manage one actual PCMCIA card.
122*/
123
124static int das08_pcmcia_attach(struct pcmcia_device *);
125static void das08_pcmcia_detach(struct pcmcia_device *);
126
127/*
128   You'll also need to prototype all the functions that will actually
129   be used to talk to your device.  See 'memory_cs' for a good example
130   of a fully self-sufficient driver; the other drivers rely more or
131   less on other parts of the kernel.
132*/
133
134/*
135   The dev_info variable is the "key" that is used to match up this
136   device driver with appropriate cards, through the card configuration
137   database.
138*/
139
140static const dev_info_t dev_info = "pcm-das08";
141
142struct local_info_t {
143	struct pcmcia_device *link;
144	dev_node_t node;
145	int stop;
146	struct bus_operations *bus;
147};
148
149/*======================================================================
150
151    das08_pcmcia_attach() creates an "instance" of the driver, allocating
152    local data structures for one device.  The device is registered
153    with Card Services.
154
155    The dev_link structure is initialized, but we don't actually
156    configure the card at this point -- we wait until we receive a
157    card insertion event.
158
159======================================================================*/
160
161static int das08_pcmcia_attach(struct pcmcia_device *link)
162{
163	struct local_info_t *local;
164
165	dev_dbg(&link->dev, "das08_pcmcia_attach()\n");
166
167	/* Allocate space for private device-specific data */
168	local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
169	if (!local)
170		return -ENOMEM;
171	local->link = link;
172	link->priv = local;
173
174	/* Interrupt setup */
175	link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
176	link->irq.IRQInfo1 = IRQ_LEVEL_ID;
177	link->irq.Handler = NULL;
178
179	/*
180	   General socket configuration defaults can go here.  In this
181	   client, we assume very little, and rely on the CIS for almost
182	   everything.  In most clients, many details (i.e., number, sizes,
183	   and attributes of IO windows) are fixed by the nature of the
184	   device, and can be hard-wired here.
185	 */
186	link->conf.Attributes = 0;
187	link->conf.IntType = INT_MEMORY_AND_IO;
188
189	cur_dev = link;
190
191	das08_pcmcia_config(link);
192
193	return 0;
194}				/* das08_pcmcia_attach */
195
196/*======================================================================
197
198    This deletes a driver "instance".  The device is de-registered
199    with Card Services.  If it has been released, all local data
200    structures are freed.  Otherwise, the structures will be freed
201    when the device is released.
202
203======================================================================*/
204
205static void das08_pcmcia_detach(struct pcmcia_device *link)
206{
207
208	dev_dbg(&link->dev, "das08_pcmcia_detach\n");
209
210	if (link->dev_node) {
211		((struct local_info_t *)link->priv)->stop = 1;
212		das08_pcmcia_release(link);
213	}
214
215	/* This points to the parent struct local_info_t struct */
216	if (link->priv)
217		kfree(link->priv);
218
219}				/* das08_pcmcia_detach */
220
221
222static int das08_pcmcia_config_loop(struct pcmcia_device *p_dev,
223				cistpl_cftable_entry_t *cfg,
224				cistpl_cftable_entry_t *dflt,
225				unsigned int vcc,
226				void *priv_data)
227{
228	if (cfg->index == 0)
229		return -ENODEV;
230
231	/* Do we need to allocate an interrupt? */
232	if (cfg->irq.IRQInfo1 || dflt->irq.IRQInfo1)
233		p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
234
235	/* IO window settings */
236	p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
237	if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
238		cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
239		p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
240		if (!(io->flags & CISTPL_IO_8BIT))
241			p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
242		if (!(io->flags & CISTPL_IO_16BIT))
243			p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
244		p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
245		p_dev->io.BasePort1 = io->win[0].base;
246		p_dev->io.NumPorts1 = io->win[0].len;
247		if (io->nwin > 1) {
248			p_dev->io.Attributes2 = p_dev->io.Attributes1;
249			p_dev->io.BasePort2 = io->win[1].base;
250			p_dev->io.NumPorts2 = io->win[1].len;
251		}
252		/* This reserves IO space but doesn't actually enable it */
253		return pcmcia_request_io(p_dev, &p_dev->io);
254	}
255	return 0;
256}
257
258
259/*======================================================================
260
261    das08_pcmcia_config() is scheduled to run after a CARD_INSERTION event
262    is received, to configure the PCMCIA socket, and to make the
263    device available to the system.
264
265======================================================================*/
266
267static void das08_pcmcia_config(struct pcmcia_device *link)
268{
269	struct local_info_t *dev = link->priv;
270	int ret;
271
272	dev_dbg(&link->dev, "das08_pcmcia_config\n");
273
274	ret = pcmcia_loop_config(link, das08_pcmcia_config_loop, NULL);
275	if (ret) {
276		dev_warn(&link->dev, "no configuration found\n");
277		goto failed;
278	}
279
280	if (link->conf.Attributes & CONF_ENABLE_IRQ) {
281		ret = pcmcia_request_irq(link, &link->irq);
282		if (ret)
283			goto failed;
284	}
285
286	/*
287	   This actually configures the PCMCIA socket -- setting up
288	   the I/O windows and the interrupt mapping, and putting the
289	   card and host interface into "Memory and IO" mode.
290	 */
291	ret = pcmcia_request_configuration(link, &link->conf);
292	if (ret)
293		goto failed;
294
295	/*
296	   At this point, the dev_node_t structure(s) need to be
297	   initialized and arranged in a linked list at link->dev.
298	 */
299	sprintf(dev->node.dev_name, "pcm-das08");
300	dev->node.major = dev->node.minor = 0;
301	link->dev_node = &dev->node;
302
303	/* Finally, report what we've done */
304	printk(KERN_INFO "%s: index 0x%02x",
305	       dev->node.dev_name, link->conf.ConfigIndex);
306	if (link->conf.Attributes & CONF_ENABLE_IRQ)
307		printk(", irq %u", link->irq.AssignedIRQ);
308	if (link->io.NumPorts1)
309		printk(", io 0x%04x-0x%04x", link->io.BasePort1,
310		       link->io.BasePort1 + link->io.NumPorts1 - 1);
311	if (link->io.NumPorts2)
312		printk(" & 0x%04x-0x%04x", link->io.BasePort2,
313		       link->io.BasePort2 + link->io.NumPorts2 - 1);
314	printk("\n");
315
316	return;
317
318failed:
319	das08_pcmcia_release(link);
320
321}				/* das08_pcmcia_config */
322
323/*======================================================================
324
325    After a card is removed, das08_pcmcia_release() will unregister the
326    device, and release the PCMCIA configuration.  If the device is
327    still open, this will be postponed until it is closed.
328
329======================================================================*/
330
331static void das08_pcmcia_release(struct pcmcia_device *link)
332{
333	dev_dbg(&link->dev, "das08_pcmcia_release\n");
334	pcmcia_disable_device(link);
335}				/* das08_pcmcia_release */
336
337/*======================================================================
338
339    The card status event handler.  Mostly, this schedules other
340    stuff to run after an event is received.
341
342    When a CARD_REMOVAL event is received, we immediately set a
343    private flag to block future accesses to this device.  All the
344    functions that actually access the device should check this flag
345    to make sure the card is still present.
346
347======================================================================*/
348
349static int das08_pcmcia_suspend(struct pcmcia_device *link)
350{
351	struct local_info_t *local = link->priv;
352	/* Mark the device as stopped, to block IO until later */
353	local->stop = 1;
354
355	return 0;
356}				/* das08_pcmcia_suspend */
357
358static int das08_pcmcia_resume(struct pcmcia_device *link)
359{
360	struct local_info_t *local = link->priv;
361
362	local->stop = 0;
363	return 0;
364}				/* das08_pcmcia_resume */
365
366/*====================================================================*/
367
368static struct pcmcia_device_id das08_cs_id_table[] = {
369	PCMCIA_DEVICE_MANF_CARD(0x01c5, 0x4001),
370	PCMCIA_DEVICE_NULL
371};
372
373MODULE_DEVICE_TABLE(pcmcia, das08_cs_id_table);
374
375struct pcmcia_driver das08_cs_driver = {
376	.probe = das08_pcmcia_attach,
377	.remove = das08_pcmcia_detach,
378	.suspend = das08_pcmcia_suspend,
379	.resume = das08_pcmcia_resume,
380	.id_table = das08_cs_id_table,
381	.owner = THIS_MODULE,
382	.drv = {
383		.name = dev_info,
384		},
385};
386
387static int __init init_das08_pcmcia_cs(void)
388{
389	pcmcia_register_driver(&das08_cs_driver);
390	return 0;
391}
392
393static void __exit exit_das08_pcmcia_cs(void)
394{
395	pr_debug("das08_pcmcia_cs: unloading\n");
396	pcmcia_unregister_driver(&das08_cs_driver);
397}
398
399static int __init das08_cs_init_module(void)
400{
401	int ret;
402
403	ret = init_das08_pcmcia_cs();
404	if (ret < 0)
405		return ret;
406
407	return comedi_driver_register(&driver_das08_cs);
408}
409
410static void __exit das08_cs_exit_module(void)
411{
412	exit_das08_pcmcia_cs();
413	comedi_driver_unregister(&driver_das08_cs);
414}
415
416MODULE_LICENSE("GPL");
417module_init(das08_cs_init_module);
418module_exit(das08_cs_exit_module);
419