[net-next-2.6.git] / drivers / isdn / hisax / elsa_cs.c

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

    An elsa_cs PCMCIA client driver

    This driver is for the Elsa PCM ISDN Cards, i.e. the MicroLink


    The contents of this file are subject to the Mozilla Public
    License Version 1.1 (the "License"); you may not use this file
    except in compliance with the License. You may obtain a copy of
    the License at http://www.mozilla.org/MPL/

    Software distributed under the License is distributed on an "AS
    IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
    implied. See the License for the specific language governing
    rights and limitations under the License.

    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.

    Modifications from dummy_cs.c are Copyright (C) 1999-2001 Klaus
    Lichtenwalder <Lichtenwalder@ACM.org>. All Rights Reserved.

    Alternatively, the contents of this file may be used under the
    terms of the GNU General Public License version 2 (the "GPL"), in
    which case the provisions of the GPL are applicable instead of the
    above.  If you wish to allow the use of your version of this file
    only under the terms of the GPL and not to allow others to use
    your version of this file under the MPL, indicate your decision
    by deleting the provisions above and replace them with the notice
    and other provisions required by the GPL.  If you do not delete
    the provisions above, a recipient may use your version of this
    file under either the MPL or the GPL.

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

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/ptrace.h>
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/timer.h>
#include <linux/ioport.h>
#include <asm/io.h>
#include <asm/system.h>

#include <pcmcia/cs.h>
#include <pcmcia/cistpl.h>
#include <pcmcia/cisreg.h>
#include <pcmcia/ds.h>
#include "hisax_cfg.h"

MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Elsa PCM cards");
MODULE_AUTHOR("Klaus Lichtenwalder");
MODULE_LICENSE("Dual MPL/GPL");


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

/* Parameters that can be set with 'insmod' */

static int protocol = 2;        /* EURO-ISDN Default */
module_param(protocol, int, 0);

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

/*
   The event() function is this driver's Card Services event handler.
   It will be called by Card Services when an appropriate card status
   event is received.  The config() and release() entry points are
   used to configure or release a socket, in response to card insertion
   and ejection events.  They are invoked from the elsa_cs event
   handler.
*/

static int elsa_cs_config(struct pcmcia_device *link) __devinit ;
static void elsa_cs_release(struct pcmcia_device *link);

/*
   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 void elsa_cs_detach(struct pcmcia_device *p_dev) __devexit;

typedef struct local_info_t {
	struct pcmcia_device	*p_dev;
    int                 busy;
    int			cardnr;
} local_info_t;

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

    elsa_cs_attach() creates an "instance" of the driver, allocatingx
    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 __devinit elsa_cs_probe(struct pcmcia_device *link)
{
    local_info_t *local;

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

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

    local->p_dev = link;
    link->priv = local;

    local->cardnr = -1;

    /*
      General socket configuration defaults can go here.  In this
      client, we assume very little, and rely on the CIS for almost
      everything.  In most clients, many details (i.e., number, sizes,
      and attributes of IO windows) are fixed by the nature of the
      device, and can be hard-wired here.
    */
    link->io.NumPorts1 = 8;
    link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
    link->io.IOAddrLines = 3;

    link->conf.Attributes = CONF_ENABLE_IRQ;
    link->conf.IntType = INT_MEMORY_AND_IO;

    return elsa_cs_config(link);
} /* elsa_cs_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 __devexit elsa_cs_detach(struct pcmcia_device *link)
{
	local_info_t *info = link->priv;

	dev_dbg(&link->dev, "elsa_cs_detach(0x%p)\n", link);

	info->busy = 1;
	elsa_cs_release(link);

	kfree(info);
} /* elsa_cs_detach */

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

    elsa_cs_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 int elsa_cs_configcheck(struct pcmcia_device *p_dev,
			       cistpl_cftable_entry_t *cf,
			       cistpl_cftable_entry_t *dflt,
			       unsigned int vcc,
			       void *priv_data)
{
	int j;

	if ((cf->io.nwin > 0) && cf->io.win[0].base) {
		printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
		p_dev->io.BasePort1 = cf->io.win[0].base;
		if (!pcmcia_request_io(p_dev, &p_dev->io))
			return 0;
	} else {
		printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
		for (j = 0x2f0; j > 0x100; j -= 0x10) {
			p_dev->io.BasePort1 = j;
			if (!pcmcia_request_io(p_dev, &p_dev->io))
				return 0;
		}
	}
	return -ENODEV;
}

static int __devinit elsa_cs_config(struct pcmcia_device *link)
{
    local_info_t *dev;
    int i;
    IsdnCard_t icard;

    dev_dbg(&link->dev, "elsa_config(0x%p)\n", link);
    dev = link->priv;

    i = pcmcia_loop_config(link, elsa_cs_configcheck, NULL);
    if (i != 0)
	goto failed;

    if (!link->irq)
	goto failed;

    i = pcmcia_request_configuration(link, &link->conf);
    if (i != 0)
	goto failed;

    /* Finally, report what we've done */
    dev_info(&link->dev, "index 0x%02x: ",
	    link->conf.ConfigIndex);
    if (link->conf.Attributes & CONF_ENABLE_IRQ)
	printk(", irq %d", link->irq);
    if (link->resource[0])
	printk(" & %pR", link->resource[0]);
    if (link->resource[1])
	printk(" & %pR", link->resource[1]);
    printk("\n");

    icard.para[0] = link->irq;
    icard.para[1] = link->resource[0]->start;
    icard.protocol = protocol;
    icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
    
    i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
    if (i < 0) {
	printk(KERN_ERR "elsa_cs: failed to initialize Elsa "
		"PCMCIA %d with %pR\n", i, link->resource[0]);
    	elsa_cs_release(link);
    } else
    	((local_info_t*)link->priv)->cardnr = i;

    return 0;
failed:
    elsa_cs_release(link);
    return -ENODEV;
} /* elsa_cs_config */

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

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

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

static void elsa_cs_release(struct pcmcia_device *link)
{
    local_info_t *local = link->priv;

    dev_dbg(&link->dev, "elsa_cs_release(0x%p)\n", link);

    if (local) {
    	if (local->cardnr >= 0) {
    	    /* no unregister function with hisax */
	    HiSax_closecard(local->cardnr);
	}
    }

    pcmcia_disable_device(link);
} /* elsa_cs_release */

static int elsa_suspend(struct pcmcia_device *link)
{
	local_info_t *dev = link->priv;

        dev->busy = 1;

	return 0;
}

static int elsa_resume(struct pcmcia_device *link)
{
	local_info_t *dev = link->priv;

        dev->busy = 0;

	return 0;
}

static struct pcmcia_device_id elsa_ids[] = {
	PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
	PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
	PCMCIA_DEVICE_NULL
};
MODULE_DEVICE_TABLE(pcmcia, elsa_ids);

static struct pcmcia_driver elsa_cs_driver = {
	.owner		= THIS_MODULE,
	.drv		= {
		.name	= "elsa_cs",
	},
	.probe		= elsa_cs_probe,
	.remove		= __devexit_p(elsa_cs_detach),
	.id_table	= elsa_ids,
	.suspend	= elsa_suspend,
	.resume		= elsa_resume,
};

static int __init init_elsa_cs(void)
{
	return pcmcia_register_driver(&elsa_cs_driver);
}

static void __exit exit_elsa_cs(void)
{
	pcmcia_unregister_driver(&elsa_cs_driver);
}

module_init(init_elsa_cs);
module_exit(exit_elsa_cs);
Commit	Line	Data
1da177e4 LT	1	/*======================================================================
	2
	3	An elsa_cs PCMCIA client driver
	4
	5	This driver is for the Elsa PCM ISDN Cards, i.e. the MicroLink
	6
	7
	8	The contents of this file are subject to the Mozilla Public
	9	License Version 1.1 (the "License"); you may not use this file
	10	except in compliance with the License. You may obtain a copy of
	11	the License at http://www.mozilla.org/MPL/
	12
	13	Software distributed under the License is distributed on an "AS
	14	IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
	15	implied. See the License for the specific language governing
	16	rights and limitations under the License.
	17
	18	The initial developer of the original code is David A. Hinds
	19	<dahinds@users.sourceforge.net>. Portions created by David A. Hinds
	20	are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
	21
	22	Modifications from dummy_cs.c are Copyright (C) 1999-2001 Klaus
	23	Lichtenwalder <Lichtenwalder@ACM.org>. All Rights Reserved.
	24
	25	Alternatively, the contents of this file may be used under the
	26	terms of the GNU General Public License version 2 (the "GPL"), in
	27	which case the provisions of the GPL are applicable instead of the
	28	above. If you wish to allow the use of your version of this file
	29	only under the terms of the GPL and not to allow others to use
	30	your version of this file under the MPL, indicate your decision
	31	by deleting the provisions above and replace them with the notice
	32	and other provisions required by the GPL. If you do not delete
	33	the provisions above, a recipient may use your version of this
	34	file under either the MPL or the GPL.
	35
	36	======================================================================*/
	37
	38	#include <linux/module.h>
	39	#include <linux/kernel.h>
	40	#include <linux/init.h>
1da177e4 LT	41	#include <linux/ptrace.h>
	42	#include <linux/slab.h>
	43	#include <linux/string.h>
	44	#include <linux/timer.h>
	45	#include <linux/ioport.h>
	46	#include <asm/io.h>
	47	#include <asm/system.h>
	48
1da177e4 LT	49	#include <pcmcia/cs.h>
	50	#include <pcmcia/cistpl.h>
	51	#include <pcmcia/cisreg.h>
	52	#include <pcmcia/ds.h>
	53	#include "hisax_cfg.h"
	54
	55	MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Elsa PCM cards");
	56	MODULE_AUTHOR("Klaus Lichtenwalder");
	57	MODULE_LICENSE("Dual MPL/GPL");
	58
1da177e4 LT	59
	60	/====================================================================/
	61
	62	/* Parameters that can be set with 'insmod' */
	63
	64	static int protocol = 2; /* EURO-ISDN Default */
	65	module_param(protocol, int, 0);
	66
	67	/====================================================================/
	68
	69	/*
	70	The event() function is this driver's Card Services event handler.
	71	It will be called by Card Services when an appropriate card status
	72	event is received. The config() and release() entry points are
	73	used to configure or release a socket, in response to card insertion
	74	and ejection events. They are invoked from the elsa_cs event
	75	handler.
	76	*/
	77
f61bb62e	78	static int elsa_cs_config(struct pcmcia_device *link) __devinit ;
fba395ee	79	static void elsa_cs_release(struct pcmcia_device *link);
1da177e4 LT	80
	81	/*
	82	The attach() and detach() entry points are used to create and destroy
	83	"instances" of the driver, where each instance represents everything
	84	needed to manage one actual PCMCIA card.
	85	*/
	86
f61bb62e	87	static void elsa_cs_detach(struct pcmcia_device *p_dev) __devexit;
1da177e4	88
1da177e4	89	typedef struct local_info_t {
fd238232	90	struct pcmcia_device *p_dev;
1da177e4 LT	91	int busy;
	92	int cardnr;
	93	} local_info_t;
	94
	95	/*======================================================================
	96
	97	elsa_cs_attach() creates an "instance" of the driver, allocatingx
	98	local data structures for one device. The device is registered
	99	with Card Services.
	100
	101	The dev_link structure is initialized, but we don't actually
	102	configure the card at this point -- we wait until we receive a
	103	card insertion event.
	104
	105	======================================================================*/
	106
f61bb62e	107	static int __devinit elsa_cs_probe(struct pcmcia_device *link)
1da177e4	108	{
1da177e4	109	local_info_t *local;
1da177e4	110
e773cfe1	111	dev_dbg(&link->dev, "elsa_cs_attach()\n");
1da177e4 LT	112
1da177e4 LT	113	/* Allocate space for private device-specific data */
41f96935	114	local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
f8cfa618	115	if (!local) return -ENOMEM;
fd238232	116
fba395ee	117	local->p_dev = link;
fd238232 DB	118	link->priv = local;
fd238232 DB	119
1da177e4	120	local->cardnr = -1;
1da177e4	121
1da177e4 LT	122	/*
	123	General socket configuration defaults can go here. In this
	124	client, we assume very little, and rely on the CIS for almost
	125	everything. In most clients, many details (i.e., number, sizes,
	126	and attributes of IO windows) are fixed by the nature of the
	127	device, and can be hard-wired here.
	128	*/
	129	link->io.NumPorts1 = 8;
	130	link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
	131	link->io.IOAddrLines = 3;
	132
	133	link->conf.Attributes = CONF_ENABLE_IRQ;
1da177e4 LT	134	link->conf.IntType = INT_MEMORY_AND_IO;
1da177e4 LT	135
15b99ac1	136	return elsa_cs_config(link);
1da177e4 LT	137	} /* elsa_cs_attach */
	138
	139	/*======================================================================
	140
	141	This deletes a driver "instance". The device is de-registered
	142	with Card Services. If it has been released, all local data
	143	structures are freed. Otherwise, the structures will be freed
	144	when the device is released.
	145
	146	======================================================================*/
	147
f61bb62e	148	static void __devexit elsa_cs_detach(struct pcmcia_device *link)
1da177e4	149	{
e2d40963	150	local_info_t *info = link->priv;
1da177e4	151
e773cfe1	152	dev_dbg(&link->dev, "elsa_cs_detach(0x%p)\n", link);
1da177e4	153
e2d40963 DB	154	info->busy = 1;
e2d40963 DB	155	elsa_cs_release(link);
1da177e4	156
e2d40963	157	kfree(info);
1da177e4 LT	158	} /* elsa_cs_detach */
	159
	160	/*======================================================================
	161
	162	elsa_cs_config() is scheduled to run after a CARD_INSERTION event
	163	is received, to configure the PCMCIA socket, and to make the
	164	device available to the system.
	165
	166	======================================================================*/
1da177e4	167
5fcd4da0 DB	168	static int elsa_cs_configcheck(struct pcmcia_device *p_dev,
5fcd4da0 DB	169	cistpl_cftable_entry_t *cf,
8e2fc39d	170	cistpl_cftable_entry_t *dflt,
ad913c11	171	unsigned int vcc,
5fcd4da0	172	void *priv_data)
1da177e4	173	{
5fcd4da0 DB	174	int j;
	175
	176	if ((cf->io.nwin > 0) && cf->io.win[0].base) {
	177	printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
5fcd4da0 DB	178	p_dev->io.BasePort1 = cf->io.win[0].base;
	179	if (!pcmcia_request_io(p_dev, &p_dev->io))
	180	return 0;
	181	} else {
	182	printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
5fcd4da0 DB	183	for (j = 0x2f0; j > 0x100; j -= 0x10) {
	184	p_dev->io.BasePort1 = j;
	185	if (!pcmcia_request_io(p_dev, &p_dev->io))
	186	return 0;
	187	}
	188	}
	189	return -ENODEV;
1da177e4 LT	190	}
1da177e4 LT	191
f61bb62e	192	static int __devinit elsa_cs_config(struct pcmcia_device *link)
1da177e4	193	{
1da177e4	194	local_info_t *dev;
e773cfe1	195	int i;
1da177e4 LT	196	IsdnCard_t icard;
1da177e4 LT	197
e773cfe1	198	dev_dbg(&link->dev, "elsa_config(0x%p)\n", link);
1da177e4 LT	199	dev = link->priv;
1da177e4 LT	200
5fcd4da0	201	i = pcmcia_loop_config(link, elsa_cs_configcheck, NULL);
e773cfe1 DB	202	if (i != 0)
e773cfe1 DB	203	goto failed;
1da177e4	204
eb14120f	205	if (!link->irq)
e773cfe1	206	goto failed;
1da177e4	207
fba395ee	208	i = pcmcia_request_configuration(link, &link->conf);
e773cfe1 DB	209	if (i != 0)
e773cfe1 DB	210	goto failed;
1da177e4	211
1da177e4	212	/* Finally, report what we've done */
ded6a1a3 DB	213	dev_info(&link->dev, "index 0x%02x: ",
ded6a1a3 DB	214	link->conf.ConfigIndex);
1da177e4	215	if (link->conf.Attributes & CONF_ENABLE_IRQ)
eb14120f	216	printk(", irq %d", link->irq);
9a017a91 DB	217	if (link->resource[0])
	218	printk(" & %pR", link->resource[0]);
	219	if (link->resource[1])
	220	printk(" & %pR", link->resource[1]);
1da177e4 LT	221	printk("\n");
1da177e4 LT	222
eb14120f	223	icard.para[0] = link->irq;
9a017a91	224	icard.para[1] = link->resource[0]->start;
1da177e4 LT	225	icard.protocol = protocol;
	226	icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
	227
	228	i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
	229	if (i < 0) {
9a017a91 DB	230	printk(KERN_ERR "elsa_cs: failed to initialize Elsa "
9a017a91 DB	231	"PCMCIA %d with %pR\n", i, link->resource[0]);
1da177e4 LT	232	elsa_cs_release(link);
	233	} else
	234	((local_info_t*)link->priv)->cardnr = i;
	235
15b99ac1	236	return 0;
e773cfe1	237	failed:
1da177e4	238	elsa_cs_release(link);
15b99ac1	239	return -ENODEV;
1da177e4 LT	240	} /* elsa_cs_config */
	241
	242	/*======================================================================
	243
	244	After a card is removed, elsa_cs_release() will unregister the net
	245	device, and release the PCMCIA configuration. If the device is
	246	still open, this will be postponed until it is closed.
	247
	248	======================================================================*/
	249
fba395ee	250	static void elsa_cs_release(struct pcmcia_device *link)
1da177e4 LT	251	{
	252	local_info_t *local = link->priv;
	253
e773cfe1	254	dev_dbg(&link->dev, "elsa_cs_release(0x%p)\n", link);
1da177e4 LT	255
	256	if (local) {
	257	if (local->cardnr >= 0) {
	258	/* no unregister function with hisax */
	259	HiSax_closecard(local->cardnr);
	260	}
	261	}
5f2a71fc	262
fba395ee	263	pcmcia_disable_device(link);
1da177e4 LT	264	} /* elsa_cs_release */
1da177e4 LT	265
fba395ee	266	static int elsa_suspend(struct pcmcia_device *link)
98e4c28b	267	{
98e4c28b DB	268	local_info_t *dev = link->priv;
98e4c28b DB	269
98e4c28b	270	dev->busy = 1;
98e4c28b DB	271
	272	return 0;
	273	}
	274
fba395ee	275	static int elsa_resume(struct pcmcia_device *link)
98e4c28b	276	{
98e4c28b DB	277	local_info_t *dev = link->priv;
98e4c28b DB	278
98e4c28b DB	279	dev->busy = 0;
	280
	281	return 0;
	282	}
	283
02ae38cf DB	284	static struct pcmcia_device_id elsa_ids[] = {
	285	PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
	286	PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
	287	PCMCIA_DEVICE_NULL
	288	};
	289	MODULE_DEVICE_TABLE(pcmcia, elsa_ids);
	290
1da177e4 LT	291	static struct pcmcia_driver elsa_cs_driver = {
	292	.owner = THIS_MODULE,
	293	.drv = {
	294	.name = "elsa_cs",
	295	},
15b99ac1	296	.probe = elsa_cs_probe,
f61bb62e	297	.remove = __devexit_p(elsa_cs_detach),
02ae38cf	298	.id_table = elsa_ids,
98e4c28b DB	299	.suspend = elsa_suspend,
98e4c28b DB	300	.resume = elsa_resume,
1da177e4 LT	301	};
	302
	303	static int __init init_elsa_cs(void)
	304	{
	305	return pcmcia_register_driver(&elsa_cs_driver);
	306	}
	307
	308	static void __exit exit_elsa_cs(void)
	309	{
	310	pcmcia_unregister_driver(&elsa_cs_driver);
1da177e4 LT	311	}
	312
	313	module_init(init_elsa_cs);
	314	module_exit(exit_elsa_cs);