[deliverable/linux.git] / drivers / staging / comedi / drivers / das08_cs.c

/*
    comedi/drivers/das08_cs.c
    DAS08 driver

    COMEDI - Linux Control and Measurement Device Interface
    Copyright (C) 2000 David A. Schleef <ds@schleef.org>
    Copyright (C) 2001,2002,2003 Frank Mori Hess <fmhess@users.sourceforge.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*****************************************************************

*/
/*
Driver: das08_cs
Description: DAS-08 PCMCIA boards
Author: Warren Jasper, ds, Frank Hess
Devices: [ComputerBoards] PCM-DAS08 (pcm-das08)
Status: works

This is the PCMCIA-specific support split off from the
das08 driver.

Options (for pcm-das08):
	NONE

Command support does not exist, but could be added for this board.
*/

#include "../comedidev.h"

#include <linux/delay.h>
#include <linux/pci.h>
#include <linux/slab.h>

#include "das08.h"

/* pcmcia includes */
#include <pcmcia/cistpl.h>
#include <pcmcia/ds.h>

static struct pcmcia_device *cur_dev;

#define thisboard ((const struct das08_board_struct *)dev->board_ptr)

static int das08_cs_attach(struct comedi_device *dev,
			   struct comedi_devconfig *it);

static struct comedi_driver driver_das08_cs = {
	.driver_name = "das08_cs",
	.module = THIS_MODULE,
	.attach = das08_cs_attach,
	.detach = das08_common_detach,
	.board_name = &das08_cs_boards[0].name,
	.num_names = ARRAY_SIZE(das08_cs_boards),
	.offset = sizeof(struct das08_board_struct),
};

static int das08_cs_attach(struct comedi_device *dev,
			   struct comedi_devconfig *it)
{
	int ret;
	unsigned long iobase;
	struct pcmcia_device *link = cur_dev;	/*  XXX hack */

	ret = alloc_private(dev, sizeof(struct das08_private_struct));
	if (ret < 0)
		return ret;

	printk("comedi%d: das08_cs: ", dev->minor);
	/*  deal with a pci board */

	if (thisboard->bustype == pcmcia) {
		if (link == NULL) {
			printk(" no pcmcia cards found\n");
			return -EIO;
		}
		iobase = link->resource[0]->start;
	} else {
		printk(" bug! board does not have PCMCIA bustype\n");
		return -EINVAL;
	}

	printk("\n");

	return das08_common_attach(dev, iobase);
}

/*======================================================================

    The following pcmcia code for the pcm-das08 is adapted from the
    dummy_cs.c driver of the Linux PCMCIA Card Services package.

    The initial developer of the original code is David A. Hinds
    <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
    are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.

======================================================================*/

static void das08_pcmcia_config(struct pcmcia_device *link);
static void das08_pcmcia_release(struct pcmcia_device *link);
static int das08_pcmcia_suspend(struct pcmcia_device *p_dev);
static int das08_pcmcia_resume(struct pcmcia_device *p_dev);

/*
   The attach() and detach() entry points are used to create and destroy
   "instances" of the driver, where each instance represents everything
   needed to manage one actual PCMCIA card.
*/

static int das08_pcmcia_attach(struct pcmcia_device *);
static void das08_pcmcia_detach(struct pcmcia_device *);

/*
   You'll also need to prototype all the functions that will actually
   be used to talk to your device.  See 'memory_cs' for a good example
   of a fully self-sufficient driver; the other drivers rely more or
   less on other parts of the kernel.
*/

struct local_info_t {
	struct pcmcia_device *link;
	int stop;
	struct bus_operations *bus;
};

/*======================================================================

    das08_pcmcia_attach() creates an "instance" of the driver, allocating
    local data structures for one device.  The device is registered
    with Card Services.

    The dev_link structure is initialized, but we don't actually
    configure the card at this point -- we wait until we receive a
    card insertion event.

======================================================================*/

static int das08_pcmcia_attach(struct pcmcia_device *link)
{
	struct local_info_t *local;

	dev_dbg(&link->dev, "das08_pcmcia_attach()\n");

	/* Allocate space for private device-specific data */
	local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
	if (!local)
		return -ENOMEM;
	local->link = link;
	link->priv = local;

	cur_dev = link;

	das08_pcmcia_config(link);

	return 0;
}				/* das08_pcmcia_attach */

/*======================================================================

    This deletes a driver "instance".  The device is de-registered
    with Card Services.  If it has been released, all local data
    structures are freed.  Otherwise, the structures will be freed
    when the device is released.

======================================================================*/

static void das08_pcmcia_detach(struct pcmcia_device *link)
{

	dev_dbg(&link->dev, "das08_pcmcia_detach\n");

	((struct local_info_t *)link->priv)->stop = 1;
	das08_pcmcia_release(link);

	/* This points to the parent struct local_info_t struct */
	kfree(link->priv);

}				/* das08_pcmcia_detach */


static int das08_pcmcia_config_loop(struct pcmcia_device *p_dev,
				void *priv_data)
{
	if (p_dev->config_index == 0)
		return -EINVAL;

	return pcmcia_request_io(p_dev);
}


/*======================================================================

    das08_pcmcia_config() is scheduled to run after a CARD_INSERTION event
    is received, to configure the PCMCIA socket, and to make the
    device available to the system.

======================================================================*/

static void das08_pcmcia_config(struct pcmcia_device *link)
{
	int ret;

	dev_dbg(&link->dev, "das08_pcmcia_config\n");

	link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_IO;

	ret = pcmcia_loop_config(link, das08_pcmcia_config_loop, NULL);
	if (ret) {
		dev_warn(&link->dev, "no configuration found\n");
		goto failed;
	}

	if (!link->irq)
		goto failed;

	/*
	   This actually configures the PCMCIA socket -- setting up
	   the I/O windows and the interrupt mapping, and putting the
	   card and host interface into "Memory and IO" mode.
	 */
	ret = pcmcia_enable_device(link);
	if (ret)
		goto failed;

	return;

failed:
	das08_pcmcia_release(link);

}				/* das08_pcmcia_config */

/*======================================================================

    After a card is removed, das08_pcmcia_release() will unregister the
    device, and release the PCMCIA configuration.  If the device is
    still open, this will be postponed until it is closed.

======================================================================*/

static void das08_pcmcia_release(struct pcmcia_device *link)
{
	dev_dbg(&link->dev, "das08_pcmcia_release\n");
	pcmcia_disable_device(link);
}				/* das08_pcmcia_release */

/*======================================================================

    The card status event handler.  Mostly, this schedules other
    stuff to run after an event is received.

    When a CARD_REMOVAL event is received, we immediately set a
    private flag to block future accesses to this device.  All the
    functions that actually access the device should check this flag
    to make sure the card is still present.

======================================================================*/

static int das08_pcmcia_suspend(struct pcmcia_device *link)
{
	struct local_info_t *local = link->priv;
	/* Mark the device as stopped, to block IO until later */
	local->stop = 1;

	return 0;
}				/* das08_pcmcia_suspend */

static int das08_pcmcia_resume(struct pcmcia_device *link)
{
	struct local_info_t *local = link->priv;

	local->stop = 0;
	return 0;
}				/* das08_pcmcia_resume */

/*====================================================================*/

static struct pcmcia_device_id das08_cs_id_table[] = {
	PCMCIA_DEVICE_MANF_CARD(0x01c5, 0x4001),
	PCMCIA_DEVICE_NULL
};

MODULE_DEVICE_TABLE(pcmcia, das08_cs_id_table);
MODULE_AUTHOR("David A. Schleef <ds@schleef.org>, "
	      "Frank Mori Hess <fmhess@users.sourceforge.net>");
MODULE_DESCRIPTION("Comedi driver for ComputerBoards DAS-08 PCMCIA boards");
MODULE_LICENSE("GPL");

struct pcmcia_driver das08_cs_driver = {
	.probe = das08_pcmcia_attach,
	.remove = das08_pcmcia_detach,
	.suspend = das08_pcmcia_suspend,
	.resume = das08_pcmcia_resume,
	.id_table = das08_cs_id_table,
	.owner = THIS_MODULE,
	.name = "pcm-das08",
};

static int __init init_das08_pcmcia_cs(void)
{
	pcmcia_register_driver(&das08_cs_driver);
	return 0;
}

static void __exit exit_das08_pcmcia_cs(void)
{
	pr_debug("das08_pcmcia_cs: unloading\n");
	pcmcia_unregister_driver(&das08_cs_driver);
}

static int __init das08_cs_init_module(void)
{
	int ret;

	ret = init_das08_pcmcia_cs();
	if (ret < 0)
		return ret;

	return comedi_driver_register(&driver_das08_cs);
}

static void __exit das08_cs_exit_module(void)
{
	exit_das08_pcmcia_cs();
	comedi_driver_unregister(&driver_das08_cs);
}

module_init(das08_cs_init_module);
module_exit(das08_cs_exit_module);
Commit	Line	Data
0882eaa6 DS	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	/*
	27	Driver: das08_cs
	28	Description: DAS-08 PCMCIA boards
	29	Author: Warren Jasper, ds, Frank Hess
	30	Devices: [ComputerBoards] PCM-DAS08 (pcm-das08)
	31	Status: works
	32
	33	This is the PCMCIA-specific support split off from the
	34	das08 driver.
	35
	36	Options (for pcm-das08):
d539047c	37	NONE
0882eaa6 DS	38
	39	Command 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>
5a0e3ad6	46	#include <linux/slab.h>
0882eaa6 DS	47
	48	#include "das08.h"
	49
2696fb57	50	/* pcmcia includes */
0882eaa6 DS	51	#include <pcmcia/cistpl.h>
	52	#include <pcmcia/ds.h>
	53
d539047c	54	static struct pcmcia_device *cur_dev;
0882eaa6 DS	55
	56	#define thisboard ((const struct das08_board_struct *)dev->board_ptr)
	57
0a85b6f0 MT	58	static int das08_cs_attach(struct comedi_device *dev,
0a85b6f0 MT	59	struct comedi_devconfig *it);
0882eaa6	60
139dfbdf	61	static struct comedi_driver driver_das08_cs = {
68c3dbff BP	62	.driver_name = "das08_cs",
	63	.module = THIS_MODULE,
	64	.attach = das08_cs_attach,
	65	.detach = das08_common_detach,
	66	.board_name = &das08_cs_boards[0].name,
b6ac1613	67	.num_names = ARRAY_SIZE(das08_cs_boards),
68c3dbff	68	.offset = sizeof(struct das08_board_struct),
0882eaa6 DS	69	};
0882eaa6 DS	70
0a85b6f0 MT	71	static int das08_cs_attach(struct comedi_device *dev,
0a85b6f0 MT	72	struct comedi_devconfig *it)
0882eaa6 DS	73	{
	74	int ret;
	75	unsigned long iobase;
2696fb57	76	struct pcmcia_device link = cur_dev; / XXX hack */
0882eaa6	77
c3744138 BP	78	ret = alloc_private(dev, sizeof(struct das08_private_struct));
c3744138 BP	79	if (ret < 0)
0882eaa6 DS	80	return ret;
	81
	82	printk("comedi%d: das08_cs: ", dev->minor);
2696fb57	83	/* deal with a pci board */
0882eaa6 DS	84
	85	if (thisboard->bustype == pcmcia) {
	86	if (link == NULL) {
	87	printk(" no pcmcia cards found\n");
	88	return -EIO;
	89	}
9a017a91	90	iobase = link->resource[0]->start;
0882eaa6 DS	91	} else {
	92	printk(" bug! board does not have PCMCIA bustype\n");
	93	return -EINVAL;
	94	}
	95
	96	printk("\n");
	97
	98	return das08_common_attach(dev, iobase);
	99	}
	100
	101	/*======================================================================
	102
	103	The following pcmcia code for the pcm-das08 is adapted from the
	104	dummy_cs.c driver of the Linux PCMCIA Card Services package.
	105
	106	The initial developer of the original code is David A. Hinds
	107	<dahinds@users.sourceforge.net>. Portions created by David A. Hinds
	108	are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
	109
	110	======================================================================*/
	111
0882eaa6 DS	112	static void das08_pcmcia_config(struct pcmcia_device *link);
	113	static void das08_pcmcia_release(struct pcmcia_device *link);
	114	static int das08_pcmcia_suspend(struct pcmcia_device *p_dev);
	115	static int das08_pcmcia_resume(struct pcmcia_device *p_dev);
	116
	117	/*
	118	The attach() and detach() entry points are used to create and destroy
	119	"instances" of the driver, where each instance represents everything
	120	needed to manage one actual PCMCIA card.
	121	*/
	122
	123	static int das08_pcmcia_attach(struct pcmcia_device *);
	124	static void das08_pcmcia_detach(struct pcmcia_device *);
	125
	126	/*
	127	You'll also need to prototype all the functions that will actually
	128	be used to talk to your device. See 'memory_cs' for a good example
	129	of a fully self-sufficient driver; the other drivers rely more or
	130	less on other parts of the kernel.
	131	*/
	132
d8961467	133	struct local_info_t {
0882eaa6	134	struct pcmcia_device *link;
0882eaa6 DS	135	int stop;
0882eaa6 DS	136	struct bus_operations *bus;
d8961467	137	};
0882eaa6 DS	138
	139	/*======================================================================
	140
	141	das08_pcmcia_attach() creates an "instance" of the driver, allocating
	142	local data structures for one device. The device is registered
	143	with Card Services.
	144
	145	The dev_link structure is initialized, but we don't actually
	146	configure the card at this point -- we wait until we receive a
	147	card insertion event.
	148
	149	======================================================================*/
	150
	151	static int das08_pcmcia_attach(struct pcmcia_device *link)
	152	{
d8961467	153	struct local_info_t *local;
0882eaa6	154
55a19b39	155	dev_dbg(&link->dev, "das08_pcmcia_attach()\n");
0882eaa6 DS	156
0882eaa6 DS	157	/* Allocate space for private device-specific data */
d8961467	158	local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
0882eaa6 DS	159	if (!local)
	160	return -ENOMEM;
	161	local->link = link;
	162	link->priv = local;
	163
0882eaa6 DS	164	cur_dev = link;
	165
	166	das08_pcmcia_config(link);
	167
	168	return 0;
	169	} /* das08_pcmcia_attach */
	170
	171	/*======================================================================
	172
	173	This deletes a driver "instance". The device is de-registered
	174	with Card Services. If it has been released, all local data
	175	structures are freed. Otherwise, the structures will be freed
	176	when the device is released.
	177
	178	======================================================================*/
	179
	180	static void das08_pcmcia_detach(struct pcmcia_device *link)
	181	{
	182
55a19b39	183	dev_dbg(&link->dev, "das08_pcmcia_detach\n");
0882eaa6	184
df3f97a2 JMC	185	((struct local_info_t *)link->priv)->stop = 1;
df3f97a2 JMC	186	das08_pcmcia_release(link);
0882eaa6	187
d8961467	188	/* This points to the parent struct local_info_t struct */
f25bd6bf	189	kfree(link->priv);
0882eaa6 DS	190
	191	} /* das08_pcmcia_detach */
	192
55a19b39 DB	193
55a19b39 DB	194	static int das08_pcmcia_config_loop(struct pcmcia_device *p_dev,
55a19b39 DB	195	void *priv_data)
55a19b39 DB	196	{
00990e7c DB	197	if (p_dev->config_index == 0)
	198	return -EINVAL;
	199
	200	return pcmcia_request_io(p_dev);
55a19b39 DB	201	}
	202
	203
0882eaa6 DS	204	/*======================================================================
	205
	206	das08_pcmcia_config() is scheduled to run after a CARD_INSERTION event
	207	is received, to configure the PCMCIA socket, and to make the
	208	device available to the system.
	209
	210	======================================================================*/
	211
	212	static void das08_pcmcia_config(struct pcmcia_device *link)
	213	{
55a19b39	214	int ret;
0882eaa6	215
55a19b39	216	dev_dbg(&link->dev, "das08_pcmcia_config\n");
c3744138	217
00990e7c DB	218	link->config_flags \|= CONF_ENABLE_IRQ \| CONF_AUTO_SET_IO;
00990e7c DB	219
55a19b39 DB	220	ret = pcmcia_loop_config(link, das08_pcmcia_config_loop, NULL);
	221	if (ret) {
	222	dev_warn(&link->dev, "no configuration found\n");
	223	goto failed;
0882eaa6 DS	224	}
0882eaa6 DS	225
eb14120f DB	226	if (!link->irq)
eb14120f DB	227	goto failed;
0882eaa6 DS	228
	229	/*
	230	This actually configures the PCMCIA socket -- setting up
	231	the I/O windows and the interrupt mapping, and putting the
	232	card and host interface into "Memory and IO" mode.
	233	*/
1ac71e5a	234	ret = pcmcia_enable_device(link);
55a19b39 DB	235	if (ret)
55a19b39 DB	236	goto failed;
0882eaa6	237
0882eaa6 DS	238	return;
0882eaa6 DS	239
55a19b39	240	failed:
0882eaa6 DS	241	das08_pcmcia_release(link);
	242
	243	} /* das08_pcmcia_config */
	244
	245	/*======================================================================
	246
	247	After a card is removed, das08_pcmcia_release() will unregister the
	248	device, and release the PCMCIA configuration. If the device is
	249	still open, this will be postponed until it is closed.
	250
	251	======================================================================*/
	252
	253	static void das08_pcmcia_release(struct pcmcia_device *link)
	254	{
55a19b39	255	dev_dbg(&link->dev, "das08_pcmcia_release\n");
0882eaa6 DS	256	pcmcia_disable_device(link);
	257	} /* das08_pcmcia_release */
	258
	259	/*======================================================================
	260
	261	The card status event handler. Mostly, this schedules other
	262	stuff to run after an event is received.
	263
	264	When a CARD_REMOVAL event is received, we immediately set a
	265	private flag to block future accesses to this device. All the
	266	functions that actually access the device should check this flag
	267	to make sure the card is still present.
	268
	269	======================================================================*/
	270
	271	static int das08_pcmcia_suspend(struct pcmcia_device *link)
	272	{
d8961467	273	struct local_info_t *local = link->priv;
0882eaa6 DS	274	/* Mark the device as stopped, to block IO until later */
	275	local->stop = 1;
	276
	277	return 0;
	278	} /* das08_pcmcia_suspend */
	279
	280	static int das08_pcmcia_resume(struct pcmcia_device *link)
	281	{
d8961467	282	struct local_info_t *local = link->priv;
0882eaa6 DS	283
	284	local->stop = 0;
	285	return 0;
	286	} /* das08_pcmcia_resume */
	287
	288	/====================================================================/
	289
	290	static struct pcmcia_device_id das08_cs_id_table[] = {
	291	PCMCIA_DEVICE_MANF_CARD(0x01c5, 0x4001),
	292	PCMCIA_DEVICE_NULL
	293	};
	294
	295	MODULE_DEVICE_TABLE(pcmcia, das08_cs_id_table);
6c7f8196 AK	296	MODULE_AUTHOR("David A. Schleef <ds@schleef.org>, "
	297	"Frank Mori Hess <fmhess@users.sourceforge.net>");
	298	MODULE_DESCRIPTION("Comedi driver for ComputerBoards DAS-08 PCMCIA boards");
	299	MODULE_LICENSE("GPL");
0882eaa6 DS	300
	301	struct pcmcia_driver das08_cs_driver = {
	302	.probe = das08_pcmcia_attach,
	303	.remove = das08_pcmcia_detach,
	304	.suspend = das08_pcmcia_suspend,
	305	.resume = das08_pcmcia_resume,
	306	.id_table = das08_cs_id_table,
	307	.owner = THIS_MODULE,
2e9b981a	308	.name = "pcm-das08",
0882eaa6 DS	309	};
	310
	311	static int __init init_das08_pcmcia_cs(void)
	312	{
0882eaa6 DS	313	pcmcia_register_driver(&das08_cs_driver);
	314	return 0;
	315	}
	316
	317	static void __exit exit_das08_pcmcia_cs(void)
	318	{
55a19b39	319	pr_debug("das08_pcmcia_cs: unloading\n");
0882eaa6 DS	320	pcmcia_unregister_driver(&das08_cs_driver);
	321	}
	322
	323	static int __init das08_cs_init_module(void)
	324	{
	325	int ret;
	326
	327	ret = init_das08_pcmcia_cs();
	328	if (ret < 0)
	329	return ret;
	330
	331	return comedi_driver_register(&driver_das08_cs);
	332	}
	333
	334	static void __exit das08_cs_exit_module(void)
	335	{
	336	exit_das08_pcmcia_cs();
	337	comedi_driver_unregister(&driver_das08_cs);
	338	}
	339
0882eaa6 DS	340	module_init(das08_cs_init_module);
0882eaa6 DS	341	module_exit(das08_cs_exit_module);