[deliverable/linux.git] / drivers / isdn / hisax / teles_cs.c

/* $Id: teles_cs.c,v 1.1.2.2 2004/01/25 15:07:06 keil Exp $ */
/*======================================================================

    A teles S0 PCMCIA client driver

    Based on skeleton by David Hinds, dhinds@allegro.stanford.edu
    Written by Christof Petig, christof.petig@wtal.de
    
    Also inspired by ELSA PCMCIA driver 
    by Klaus Lichtenwalder <Lichtenwalder@ACM.org>
    
    Extentions to new hisax_pcmcia by Karsten Keil

    minor changes to be compatible with kernel 2.4.x
    by Jan.Schubert@GMX.li

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

#include <linux/kernel.h>
#include <linux/module.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_types.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 Teles PCMCIA cards");
MODULE_AUTHOR("Christof Petig, christof.petig@wtal.de, Karsten Keil, kkeil@suse.de");
MODULE_LICENSE("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 teles_cs event
   handler.
*/

static int teles_cs_config(struct pcmcia_device *link) __devinit ;
static void teles_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 teles_detach(struct pcmcia_device *p_dev) __devexit ;

/*
   A linked list of "instances" of the teles_cs device.  Each actual
   PCMCIA card corresponds to one device instance, and is described
   by one struct pcmcia_device structure (defined in ds.h).

   You may not want to use a linked list for this -- for example, the
   memory card driver uses an array of struct pcmcia_device pointers, where minor
   device numbers are used to derive the corresponding array index.
*/

/*
   A driver needs to provide a dev_node_t structure for each device
   on a card.  In some cases, there is only one device per card (for
   example, ethernet cards, modems).  In other cases, there may be
   many actual or logical devices (SCSI adapters, memory cards with
   multiple partitions).  The dev_node_t structures need to be kept
   in a linked list starting at the 'dev' field of a struct pcmcia_device
   structure.  We allocate them in the card's private data structure,
   because they generally shouldn't be allocated dynamically.
   In this case, we also provide a flag to indicate if a device is
   "stopped" due to a power management event, or card ejection.  The
   device IO routines can use a flag like this to throttle IO to a
   card that is not ready to accept it.
*/

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

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

    teles_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 teles_probe(struct pcmcia_device *link)
{
    local_info_t *local;

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

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

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

    /*
      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 = 96;
    link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
    link->io.IOAddrLines = 5;

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

    return teles_cs_config(link);
} /* teles_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 teles_detach(struct pcmcia_device *link)
{
	local_info_t *info = link->priv;

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

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

	kfree(info);
} /* teles_detach */

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

    teles_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 teles_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 "(teles_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 "(teles_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 teles_cs_config(struct pcmcia_device *link)
{
    local_info_t *dev;
    int i;
    IsdnCard_t icard;

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

    i = pcmcia_loop_config(link, teles_cs_configcheck, NULL);
    if (i != 0)
	goto cs_failed;

    if (!link->irq)
        goto cs_failed;

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

    /* At this point, the dev_node_t structure(s) should be
       initialized and arranged in a linked list at link->dev. *//*  */
    sprintf(dev->node.dev_name, "teles");
    dev->node.major = dev->node.minor = 0x0;

    link->dev_node = &dev->node;

    /* Finally, report what we've done */
    printk(KERN_INFO "%s: index 0x%02x:",
           dev->node.dev_name, link->conf.ConfigIndex);
    if (link->conf.Attributes & CONF_ENABLE_IRQ)
	    printk(", irq %d", link->irq);
    if (link->io.NumPorts1)
        printk(", io 0x%04x-0x%04x", link->io.BasePort1,
               link->io.BasePort1+link->io.NumPorts1-1);
    if (link->io.NumPorts2)
        printk(" & 0x%04x-0x%04x", link->io.BasePort2,
               link->io.BasePort2+link->io.NumPorts2-1);
    printk("\n");

    icard.para[0] = link->irq;
    icard.para[1] = link->io.BasePort1;
    icard.protocol = protocol;
    icard.typ = ISDN_CTYPE_TELESPCMCIA;
    
    i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
    if (i < 0) {
    	printk(KERN_ERR "teles_cs: failed to initialize Teles PCMCIA %d at i/o %#x\n",
    		i, link->io.BasePort1);
    	teles_cs_release(link);
	return -ENODEV;
    }

    ((local_info_t*)link->priv)->cardnr = i;
    return 0;

cs_failed:
    teles_cs_release(link);
    return -ENODEV;
} /* teles_cs_config */

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

    After a card is removed, teles_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 teles_cs_release(struct pcmcia_device *link)
{
    local_info_t *local = link->priv;

    dev_dbg(&link->dev, "teles_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);
} /* teles_cs_release */

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

        dev->busy = 1;

	return 0;
}

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

        dev->busy = 0;

	return 0;
}


static struct pcmcia_device_id teles_ids[] = {
	PCMCIA_DEVICE_PROD_ID12("TELES", "S0/PC", 0x67b50eae, 0xe9e70119),
	PCMCIA_DEVICE_NULL,
};
MODULE_DEVICE_TABLE(pcmcia, teles_ids);

static struct pcmcia_driver teles_cs_driver = {
	.owner		= THIS_MODULE,
	.drv		= {
		.name	= "teles_cs",
	},
	.probe		= teles_probe,
	.remove		= __devexit_p(teles_detach),
	.id_table       = teles_ids,
	.suspend	= teles_suspend,
	.resume		= teles_resume,
};

static int __init init_teles_cs(void)
{
	return pcmcia_register_driver(&teles_cs_driver);
}

static void __exit exit_teles_cs(void)
{
	pcmcia_unregister_driver(&teles_cs_driver);
}

module_init(init_teles_cs);
module_exit(exit_teles_cs);
Commit	Line	Data
1da177e4 LT	1	/* $Id: teles_cs.c,v 1.1.2.2 2004/01/25 15:07:06 keil Exp $ */
	2	/*======================================================================
	3
	4	A teles S0 PCMCIA client driver
	5
	6	Based on skeleton by David Hinds, dhinds@allegro.stanford.edu
	7	Written by Christof Petig, christof.petig@wtal.de
	8
	9	Also inspired by ELSA PCMCIA driver
	10	by Klaus Lichtenwalder <Lichtenwalder@ACM.org>
	11
	12	Extentions to new hisax_pcmcia by Karsten Keil
	13
	14	minor changes to be compatible with kernel 2.4.x
	15	by Jan.Schubert@GMX.li
	16
	17	======================================================================*/
	18
	19	#include <linux/kernel.h>
	20	#include <linux/module.h>
	21	#include <linux/init.h>
1da177e4 LT	22	#include <linux/ptrace.h>
	23	#include <linux/slab.h>
	24	#include <linux/string.h>
	25	#include <linux/timer.h>
	26	#include <linux/ioport.h>
	27	#include <asm/io.h>
	28	#include <asm/system.h>
	29
1da177e4 LT	30	#include <pcmcia/cs_types.h>
	31	#include <pcmcia/cs.h>
	32	#include <pcmcia/cistpl.h>
	33	#include <pcmcia/cisreg.h>
	34	#include <pcmcia/ds.h>
	35	#include "hisax_cfg.h"
	36
	37	MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Teles PCMCIA cards");
	38	MODULE_AUTHOR("Christof Petig, christof.petig@wtal.de, Karsten Keil, kkeil@suse.de");
	39	MODULE_LICENSE("GPL");
	40
1da177e4 LT	41
	42	/====================================================================/
	43
	44	/* Parameters that can be set with 'insmod' */
	45
	46	static int protocol = 2; /* EURO-ISDN Default */
	47	module_param(protocol, int, 0);
	48
	49	/====================================================================/
	50
	51	/*
	52	The event() function is this driver's Card Services event handler.
	53	It will be called by Card Services when an appropriate card status
	54	event is received. The config() and release() entry points are
	55	used to configure or release a socket, in response to card insertion
	56	and ejection events. They are invoked from the teles_cs event
	57	handler.
	58	*/
	59
158e33d1	60	static int teles_cs_config(struct pcmcia_device *link) __devinit ;
fba395ee	61	static void teles_cs_release(struct pcmcia_device *link);
1da177e4 LT	62
	63	/*
	64	The attach() and detach() entry points are used to create and destroy
	65	"instances" of the driver, where each instance represents everything
	66	needed to manage one actual PCMCIA card.
	67	*/
	68
158e33d1	69	static void teles_detach(struct pcmcia_device *p_dev) __devexit ;
1da177e4	70
1da177e4 LT	71	/*
	72	A linked list of "instances" of the teles_cs device. Each actual
	73	PCMCIA card corresponds to one device instance, and is described
fba395ee	74	by one struct pcmcia_device structure (defined in ds.h).
1da177e4 LT	75
1da177e4 LT	76	You may not want to use a linked list for this -- for example, the
fba395ee	77	memory card driver uses an array of struct pcmcia_device pointers, where minor
1da177e4 LT	78	device numbers are used to derive the corresponding array index.
	79	*/
	80
1da177e4	81	/*
1da177e4 LT	82	A driver needs to provide a dev_node_t structure for each device
	83	on a card. In some cases, there is only one device per card (for
	84	example, ethernet cards, modems). In other cases, there may be
	85	many actual or logical devices (SCSI adapters, memory cards with
	86	multiple partitions). The dev_node_t structures need to be kept
fba395ee	87	in a linked list starting at the 'dev' field of a struct pcmcia_device
1da177e4 LT	88	structure. We allocate them in the card's private data structure,
	89	because they generally shouldn't be allocated dynamically.
	90	In this case, we also provide a flag to indicate if a device is
	91	"stopped" due to a power management event, or card ejection. The
	92	device IO routines can use a flag like this to throttle IO to a
	93	card that is not ready to accept it.
	94	*/
	95
	96	typedef struct local_info_t {
fd238232	97	struct pcmcia_device *p_dev;
1da177e4 LT	98	dev_node_t node;
	99	int busy;
	100	int cardnr;
	101	} local_info_t;
	102
	103	/*======================================================================
	104
	105	teles_attach() creates an "instance" of the driver, allocatingx
	106	local data structures for one device. The device is registered
	107	with Card Services.
	108
	109	The dev_link structure is initialized, but we don't actually
	110	configure the card at this point -- we wait until we receive a
	111	card insertion event.
	112
	113	======================================================================*/
	114
158e33d1	115	static int __devinit teles_probe(struct pcmcia_device *link)
1da177e4	116	{
1da177e4	117	local_info_t *local;
1da177e4	118
e773cfe1	119	dev_dbg(&link->dev, "teles_attach()\n");
1da177e4 LT	120
1da177e4 LT	121	/* Allocate space for private device-specific data */
41f96935	122	local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
f8cfa618	123	if (!local) return -ENOMEM;
1da177e4	124	local->cardnr = -1;
fd238232	125
fba395ee	126	local->p_dev = link;
fd238232	127	link->priv = local;
1da177e4	128
1da177e4 LT	129	/*
	130	General socket configuration defaults can go here. In this
	131	client, we assume very little, and rely on the CIS for almost
	132	everything. In most clients, many details (i.e., number, sizes,
	133	and attributes of IO windows) are fixed by the nature of the
	134	device, and can be hard-wired here.
	135	*/
	136	link->io.NumPorts1 = 96;
	137	link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
	138	link->io.IOAddrLines = 5;
	139
	140	link->conf.Attributes = CONF_ENABLE_IRQ;
1da177e4 LT	141	link->conf.IntType = INT_MEMORY_AND_IO;
1da177e4 LT	142
15b99ac1	143	return teles_cs_config(link);
1da177e4 LT	144	} /* teles_attach */
	145
	146	/*======================================================================
	147
	148	This deletes a driver "instance". The device is de-registered
	149	with Card Services. If it has been released, all local data
	150	structures are freed. Otherwise, the structures will be freed
	151	when the device is released.
	152
	153	======================================================================*/
	154
158e33d1	155	static void __devexit teles_detach(struct pcmcia_device *link)
1da177e4	156	{
e2d40963	157	local_info_t *info = link->priv;
1da177e4	158
e773cfe1	159	dev_dbg(&link->dev, "teles_detach(0x%p)\n", link);
1da177e4	160
e2d40963 DB	161	info->busy = 1;
e2d40963 DB	162	teles_cs_release(link);
1da177e4	163
e2d40963	164	kfree(info);
1da177e4 LT	165	} /* teles_detach */
	166
	167	/*======================================================================
	168
	169	teles_cs_config() is scheduled to run after a CARD_INSERTION event
	170	is received, to configure the PCMCIA socket, and to make the
	171	device available to the system.
	172
	173	======================================================================*/
1da177e4	174
5fcd4da0 DB	175	static int teles_cs_configcheck(struct pcmcia_device *p_dev,
5fcd4da0 DB	176	cistpl_cftable_entry_t *cf,
8e2fc39d	177	cistpl_cftable_entry_t *dflt,
ad913c11	178	unsigned int vcc,
5fcd4da0	179	void *priv_data)
1da177e4	180	{
5fcd4da0 DB	181	int j;
	182
	183	if ((cf->io.nwin > 0) && cf->io.win[0].base) {
	184	printk(KERN_INFO "(teles_cs: looks like the 96 model)\n");
5fcd4da0 DB	185	p_dev->io.BasePort1 = cf->io.win[0].base;
	186	if (!pcmcia_request_io(p_dev, &p_dev->io))
	187	return 0;
	188	} else {
	189	printk(KERN_INFO "(teles_cs: looks like the 97 model)\n");
5fcd4da0 DB	190	for (j = 0x2f0; j > 0x100; j -= 0x10) {
	191	p_dev->io.BasePort1 = j;
	192	if (!pcmcia_request_io(p_dev, &p_dev->io))
	193	return 0;
	194	}
	195	}
	196	return -ENODEV;
1da177e4 LT	197	}
1da177e4 LT	198
158e33d1	199	static int __devinit teles_cs_config(struct pcmcia_device *link)
1da177e4	200	{
1da177e4	201	local_info_t *dev;
e773cfe1	202	int i;
1da177e4 LT	203	IsdnCard_t icard;
1da177e4 LT	204
e773cfe1	205	dev_dbg(&link->dev, "teles_config(0x%p)\n", link);
1da177e4 LT	206	dev = link->priv;
1da177e4 LT	207
5fcd4da0	208	i = pcmcia_loop_config(link, teles_cs_configcheck, NULL);
e773cfe1	209	if (i != 0)
1da177e4	210	goto cs_failed;
1da177e4	211
eb14120f	212	if (!link->irq)
1da177e4	213	goto cs_failed;
1da177e4	214
fba395ee	215	i = pcmcia_request_configuration(link, &link->conf);
e773cfe1	216	if (i != 0)
1da177e4	217	goto cs_failed;
1da177e4 LT	218
	219	/* At this point, the dev_node_t structure(s) should be
	220	initialized and arranged in a linked list at link->dev. // */
	221	sprintf(dev->node.dev_name, "teles");
	222	dev->node.major = dev->node.minor = 0x0;
	223
fd238232	224	link->dev_node = &dev->node;
1da177e4 LT	225
1da177e4 LT	226	/* Finally, report what we've done */
70294b46 DB	227	printk(KERN_INFO "%s: index 0x%02x:",
70294b46 DB	228	dev->node.dev_name, link->conf.ConfigIndex);
1da177e4	229	if (link->conf.Attributes & CONF_ENABLE_IRQ)
eb14120f	230	printk(", irq %d", link->irq);
1da177e4 LT	231	if (link->io.NumPorts1)
	232	printk(", io 0x%04x-0x%04x", link->io.BasePort1,
	233	link->io.BasePort1+link->io.NumPorts1-1);
	234	if (link->io.NumPorts2)
	235	printk(" & 0x%04x-0x%04x", link->io.BasePort2,
	236	link->io.BasePort2+link->io.NumPorts2-1);
	237	printk("\n");
	238
eb14120f	239	icard.para[0] = link->irq;
1da177e4 LT	240	icard.para[1] = link->io.BasePort1;
	241	icard.protocol = protocol;
	242	icard.typ = ISDN_CTYPE_TELESPCMCIA;
	243
	244	i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
	245	if (i < 0) {
	246	printk(KERN_ERR "teles_cs: failed to initialize Teles PCMCIA %d at i/o %#x\n",
	247	i, link->io.BasePort1);
	248	teles_cs_release(link);
15b99ac1 DB	249	return -ENODEV;
	250	}
	251
	252	((local_info_t*)link->priv)->cardnr = i;
	253	return 0;
1da177e4	254
1da177e4	255	cs_failed:
1da177e4	256	teles_cs_release(link);
15b99ac1	257	return -ENODEV;
1da177e4 LT	258	} /* teles_cs_config */
	259
	260	/*======================================================================
	261
	262	After a card is removed, teles_cs_release() will unregister the net
	263	device, and release the PCMCIA configuration. If the device is
	264	still open, this will be postponed until it is closed.
	265
	266	======================================================================*/
	267
fba395ee	268	static void teles_cs_release(struct pcmcia_device *link)
1da177e4 LT	269	{
	270	local_info_t *local = link->priv;
	271
e773cfe1	272	dev_dbg(&link->dev, "teles_cs_release(0x%p)\n", link);
1da177e4 LT	273
	274	if (local) {
	275	if (local->cardnr >= 0) {
	276	/* no unregister function with hisax */
	277	HiSax_closecard(local->cardnr);
	278	}
	279	}
5f2a71fc	280
fba395ee	281	pcmcia_disable_device(link);
1da177e4 LT	282	} /* teles_cs_release */
1da177e4 LT	283
fba395ee	284	static int teles_suspend(struct pcmcia_device *link)
98e4c28b	285	{
98e4c28b DB	286	local_info_t *dev = link->priv;
98e4c28b DB	287
98e4c28b	288	dev->busy = 1;
98e4c28b DB	289
	290	return 0;
	291	}
	292
fba395ee	293	static int teles_resume(struct pcmcia_device *link)
98e4c28b	294	{
98e4c28b DB	295	local_info_t *dev = link->priv;
98e4c28b DB	296
98e4c28b DB	297	dev->busy = 0;
	298
	299	return 0;
	300	}
	301
1da177e4	302
0a10d73d DB	303	static struct pcmcia_device_id teles_ids[] = {
	304	PCMCIA_DEVICE_PROD_ID12("TELES", "S0/PC", 0x67b50eae, 0xe9e70119),
	305	PCMCIA_DEVICE_NULL,
	306	};
	307	MODULE_DEVICE_TABLE(pcmcia, teles_ids);
	308
1da177e4 LT	309	static struct pcmcia_driver teles_cs_driver = {
	310	.owner = THIS_MODULE,
	311	.drv = {
	312	.name = "teles_cs",
	313	},
15b99ac1	314	.probe = teles_probe,
158e33d1	315	.remove = __devexit_p(teles_detach),
0a10d73d	316	.id_table = teles_ids,
98e4c28b DB	317	.suspend = teles_suspend,
98e4c28b DB	318	.resume = teles_resume,
1da177e4 LT	319	};
	320
	321	static int __init init_teles_cs(void)
	322	{
	323	return pcmcia_register_driver(&teles_cs_driver);
	324	}
	325
	326	static void __exit exit_teles_cs(void)
	327	{
	328	pcmcia_unregister_driver(&teles_cs_driver);
1da177e4 LT	329	}
	330
	331	module_init(init_teles_cs);
	332	module_exit(exit_teles_cs);