[deliverable/linux.git] / drivers / isdn / hardware / avm / avm_cs.c

/* $Id: avm_cs.c,v 1.4.6.3 2001/09/23 22:24:33 kai Exp $
 *
 * A PCMCIA client driver for AVM B1/M1/M2
 *
 * Copyright 1999 by Carsten Paeth <calle@calle.de>
 *
 * This software may be used and distributed according to the terms
 * of the GNU General Public License, incorporated herein by reference.
 *
 */

#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/tty.h>
#include <linux/serial.h>
#include <linux/major.h>
#include <asm/io.h>
#include <asm/system.h>

#include <pcmcia/cs_types.h>
#include <pcmcia/cs.h>
#include <pcmcia/cistpl.h>
#include <pcmcia/ciscode.h>
#include <pcmcia/ds.h>
#include <pcmcia/cisreg.h>

#include <linux/skbuff.h>
#include <linux/capi.h>
#include <linux/b1lli.h>
#include <linux/b1pcmcia.h>

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

MODULE_DESCRIPTION("CAPI4Linux: PCMCIA client driver for AVM B1/M1/M2");
MODULE_AUTHOR("Carsten Paeth");
MODULE_LICENSE("GPL");

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

/*
   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 skeleton event
   handler.
*/

static int avmcs_config(struct pcmcia_device *link);
static void avmcs_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 avmcs_detach(struct pcmcia_device *p_dev);

/*
   A linked list of "instances" of the skeleton 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 can't be allocated dynamically.
*/
   
typedef struct local_info_t {
    dev_node_t	node;
} local_info_t;

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

    avmcs_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 avmcs_probe(struct pcmcia_device *p_dev)
{
    local_info_t *local;

    /* The io structure describes IO port mapping */
    p_dev->io.NumPorts1 = 16;
    p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
    p_dev->io.NumPorts2 = 0;

    /* Interrupt setup */
    p_dev->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
    p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;

    p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;

    /* General socket configuration */
    p_dev->conf.Attributes = CONF_ENABLE_IRQ;
    p_dev->conf.IntType = INT_MEMORY_AND_IO;
    p_dev->conf.ConfigIndex = 1;
    p_dev->conf.Present = PRESENT_OPTION;

    /* Allocate space for private device-specific data */
    local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
    if (!local)
        goto err;
    p_dev->priv = local;

    return avmcs_config(p_dev);

 err:
    return -ENOMEM;
} /* avmcs_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 avmcs_detach(struct pcmcia_device *link)
{
	avmcs_release(link);
	kfree(link->priv);
} /* avmcs_detach */

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

    avmcs_config() is scheduled to run after a CARD_INSERTION event
    is received, to configure the PCMCIA socket, and to make the
    ethernet device available to the system.
    
======================================================================*/

static int avmcs_configcheck(struct pcmcia_device *p_dev,
			     cistpl_cftable_entry_t *cf,
			     cistpl_cftable_entry_t *dflt,
			     unsigned int vcc,
			     void *priv_data)
{
	if (cf->io.nwin <= 0)
		return -ENODEV;

	p_dev->io.BasePort1 = cf->io.win[0].base;
	p_dev->io.NumPorts1 = cf->io.win[0].len;
	p_dev->io.NumPorts2 = 0;
	printk(KERN_INFO "avm_cs: testing i/o %#x-%#x\n",
	       p_dev->io.BasePort1,
	       p_dev->io.BasePort1+p_dev->io.NumPorts1-1);
	return pcmcia_request_io(p_dev, &p_dev->io);
}

static int avmcs_config(struct pcmcia_device *link)
{
    local_info_t *dev;
    int i;
    char devname[128];
    int cardtype;
    int (*addcard)(unsigned int port, unsigned irq);

    dev = link->priv;

    devname[0] = 0;
    if (link->prod_id[1])
	    strlcpy(devname, link->prod_id[1], sizeof(devname));

    /*
     * find IO port
     */
    if (pcmcia_loop_config(link, avmcs_configcheck, NULL))
	    return -ENODEV;

    do {
	/*
	 * allocate an interrupt line
	 */
	i = pcmcia_request_irq(link, &link->irq);
	if (i != CS_SUCCESS) {
	    cs_error(link, RequestIRQ, i);
	    /* undo */
	    pcmcia_disable_device(link);
	    break;
	}

	/*
         * configure the PCMCIA socket
	  */
	i = pcmcia_request_configuration(link, &link->conf);
	if (i != CS_SUCCESS) {
	    cs_error(link, RequestConfiguration, i);
	    pcmcia_disable_device(link);
	    break;
	}

    } while (0);

    /* At this point, the dev_node_t structure(s) should be
       initialized and arranged in a linked list at link->dev. */

    if (devname[0]) {
	char *s = strrchr(devname, ' ');
	if (!s)
	   s = devname;
	else s++;
	strcpy(dev->node.dev_name, s);
        if (strcmp("M1", s) == 0) {
           cardtype = AVM_CARDTYPE_M1;
        } else if (strcmp("M2", s) == 0) {
           cardtype = AVM_CARDTYPE_M2;
	} else {
           cardtype = AVM_CARDTYPE_B1;
	}
    } else {
        strcpy(dev->node.dev_name, "b1");
        cardtype = AVM_CARDTYPE_B1;
    }

    dev->node.major = 64;
    dev->node.minor = 0;
    link->dev_node = &dev->node;

    /* If any step failed, release any partially configured state */
    if (i != 0) {
	avmcs_release(link);
	return -ENODEV;
    }


    switch (cardtype) {
        case AVM_CARDTYPE_M1: addcard = b1pcmcia_addcard_m1; break;
        case AVM_CARDTYPE_M2: addcard = b1pcmcia_addcard_m2; break;
	default:
        case AVM_CARDTYPE_B1: addcard = b1pcmcia_addcard_b1; break;
    }
    if ((i = (*addcard)(link->io.BasePort1, link->irq.AssignedIRQ)) < 0) {
        printk(KERN_ERR "avm_cs: failed to add AVM-%s-Controller at i/o %#x, irq %d\n",
		dev->node.dev_name, link->io.BasePort1, link->irq.AssignedIRQ);
	avmcs_release(link);
	return -ENODEV;
    }
    dev->node.minor = i;
    return 0;

} /* avmcs_config */

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

    After a card is removed, avmcs_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 avmcs_release(struct pcmcia_device *link)
{
	b1pcmcia_delcard(link->io.BasePort1, link->irq.AssignedIRQ);
	pcmcia_disable_device(link);
} /* avmcs_release */


static struct pcmcia_device_id avmcs_ids[] = {
	PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN-Controller B1", 0x95d42008, 0x845dc335),
	PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M1", 0x95d42008, 0x81e10430),
	PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M2", 0x95d42008, 0x18e8558a),
	PCMCIA_DEVICE_NULL
};
MODULE_DEVICE_TABLE(pcmcia, avmcs_ids);

static struct pcmcia_driver avmcs_driver = {
	.owner	= THIS_MODULE,
	.drv	= {
		.name	= "avm_cs",
	},
	.probe = avmcs_probe,
	.remove	= avmcs_detach,
	.id_table = avmcs_ids,
};

static int __init avmcs_init(void)
{
	return pcmcia_register_driver(&avmcs_driver);
}

static void __exit avmcs_exit(void)
{
	pcmcia_unregister_driver(&avmcs_driver);
}

module_init(avmcs_init);
module_exit(avmcs_exit);
Commit	Line	Data
1da177e4 LT	1	/* $Id: avm_cs.c,v 1.4.6.3 2001/09/23 22:24:33 kai Exp $
	2	*
	3	* A PCMCIA client driver for AVM B1/M1/M2
	4	*
	5	* Copyright 1999 by Carsten Paeth <calle@calle.de>
	6	*
	7	* This software may be used and distributed according to the terms
	8	* of the GNU General Public License, incorporated herein by reference.
	9	*
	10	*/
	11
	12	#include <linux/module.h>
	13	#include <linux/kernel.h>
	14	#include <linux/init.h>
1da177e4 LT	15	#include <linux/ptrace.h>
	16	#include <linux/slab.h>
	17	#include <linux/string.h>
	18	#include <linux/tty.h>
	19	#include <linux/serial.h>
	20	#include <linux/major.h>
	21	#include <asm/io.h>
	22	#include <asm/system.h>
	23
1da177e4 LT	24	#include <pcmcia/cs_types.h>
	25	#include <pcmcia/cs.h>
	26	#include <pcmcia/cistpl.h>
	27	#include <pcmcia/ciscode.h>
	28	#include <pcmcia/ds.h>
	29	#include <pcmcia/cisreg.h>
	30
	31	#include <linux/skbuff.h>
	32	#include <linux/capi.h>
	33	#include <linux/b1lli.h>
	34	#include <linux/b1pcmcia.h>
	35
	36	/====================================================================/
	37
	38	MODULE_DESCRIPTION("CAPI4Linux: PCMCIA client driver for AVM B1/M1/M2");
	39	MODULE_AUTHOR("Carsten Paeth");
	40	MODULE_LICENSE("GPL");
	41
	42	/====================================================================/
	43
	44	/*
	45	The event() function is this driver's Card Services event handler.
	46	It will be called by Card Services when an appropriate card status
	47	event is received. The config() and release() entry points are
	48	used to configure or release a socket, in response to card insertion
	49	and ejection events. They are invoked from the skeleton event
	50	handler.
	51	*/
	52
15b99ac1	53	static int avmcs_config(struct pcmcia_device *link);
fba395ee	54	static void avmcs_release(struct pcmcia_device *link);
1da177e4 LT	55
	56	/*
	57	The attach() and detach() entry points are used to create and destroy
	58	"instances" of the driver, where each instance represents everything
	59	needed to manage one actual PCMCIA card.
	60	*/
	61
cc3b4866	62	static void avmcs_detach(struct pcmcia_device *p_dev);
1da177e4	63
1da177e4 LT	64	/*
	65	A linked list of "instances" of the skeleton device. Each actual
	66	PCMCIA card corresponds to one device instance, and is described
fba395ee	67	by one struct pcmcia_device structure (defined in ds.h).
1da177e4 LT	68
1da177e4 LT	69	You may not want to use a linked list for this -- for example, the
fba395ee	70	memory card driver uses an array of struct pcmcia_device pointers, where minor
1da177e4 LT	71	device numbers are used to derive the corresponding array index.
	72	*/
	73
1da177e4	74	/*
1da177e4 LT	75	A driver needs to provide a dev_node_t structure for each device
	76	on a card. In some cases, there is only one device per card (for
	77	example, ethernet cards, modems). In other cases, there may be
	78	many actual or logical devices (SCSI adapters, memory cards with
	79	multiple partitions). The dev_node_t structures need to be kept
fba395ee	80	in a linked list starting at the 'dev' field of a struct pcmcia_device
1da177e4 LT	81	structure. We allocate them in the card's private data structure,
	82	because they generally can't be allocated dynamically.
	83	*/
	84
	85	typedef struct local_info_t {
	86	dev_node_t node;
	87	} local_info_t;
	88
	89	/*======================================================================
	90
	91	avmcs_attach() creates an "instance" of the driver, allocating
	92	local data structures for one device. The device is registered
	93	with Card Services.
	94
	95	The dev_link structure is initialized, but we don't actually
	96	configure the card at this point -- we wait until we receive a
	97	card insertion event.
	98
	99	======================================================================*/
	100
15b99ac1	101	static int avmcs_probe(struct pcmcia_device *p_dev)
1da177e4	102	{
1da177e4	103	local_info_t *local;
f8cfa618	104
1da177e4	105	/* The io structure describes IO port mapping */
fd238232 DB	106	p_dev->io.NumPorts1 = 16;
	107	p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
	108	p_dev->io.NumPorts2 = 0;
1da177e4 LT	109
1da177e4 LT	110	/* Interrupt setup */
fd238232 DB	111	p_dev->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
	112	p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING\|IRQ_FIRST_SHARED;
	113
	114	p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
1da177e4	115
1da177e4	116	/* General socket configuration */
fd238232 DB	117	p_dev->conf.Attributes = CONF_ENABLE_IRQ;
	118	p_dev->conf.IntType = INT_MEMORY_AND_IO;
	119	p_dev->conf.ConfigIndex = 1;
	120	p_dev->conf.Present = PRESENT_OPTION;
1da177e4 LT	121
1da177e4 LT	122	/* Allocate space for private device-specific data */
41f96935	123	local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
1da177e4	124	if (!local)
fd238232	125	goto err;
fd238232	126	p_dev->priv = local;
f8cfa618	127
15b99ac1	128	return avmcs_config(p_dev);
1da177e4	129
1da177e4	130	err:
15b99ac1	131	return -ENOMEM;
1da177e4 LT	132	} /* avmcs_attach */
	133
	134	/*======================================================================
	135
	136	This deletes a driver "instance". The device is de-registered
	137	with Card Services. If it has been released, all local data
	138	structures are freed. Otherwise, the structures will be freed
	139	when the device is released.
	140
	141	======================================================================*/
	142
fba395ee	143	static void avmcs_detach(struct pcmcia_device *link)
1da177e4	144	{
cc3b4866	145	avmcs_release(link);
e2d40963	146	kfree(link->priv);
1da177e4 LT	147	} /* avmcs_detach */
	148
	149	/*======================================================================
	150
	151	avmcs_config() is scheduled to run after a CARD_INSERTION event
	152	is received, to configure the PCMCIA socket, and to make the
	153	ethernet device available to the system.
	154
	155	======================================================================*/
	156
5fcd4da0 DB	157	static int avmcs_configcheck(struct pcmcia_device *p_dev,
5fcd4da0 DB	158	cistpl_cftable_entry_t *cf,
8e2fc39d	159	cistpl_cftable_entry_t *dflt,
ad913c11	160	unsigned int vcc,
5fcd4da0	161	void *priv_data)
1da177e4	162	{
5fcd4da0 DB	163	if (cf->io.nwin <= 0)
	164	return -ENODEV;
	165
5fcd4da0 DB	166	p_dev->io.BasePort1 = cf->io.win[0].base;
	167	p_dev->io.NumPorts1 = cf->io.win[0].len;
	168	p_dev->io.NumPorts2 = 0;
	169	printk(KERN_INFO "avm_cs: testing i/o %#x-%#x\n",
	170	p_dev->io.BasePort1,
	171	p_dev->io.BasePort1+p_dev->io.NumPorts1-1);
	172	return pcmcia_request_io(p_dev, &p_dev->io);
1da177e4 LT	173	}
1da177e4 LT	174
15b99ac1	175	static int avmcs_config(struct pcmcia_device *link)
1da177e4	176	{
1da177e4 LT	177	local_info_t *dev;
1da177e4 LT	178	int i;
1da177e4 LT	179	char devname[128];
	180	int cardtype;
	181	int (*addcard)(unsigned int port, unsigned irq);
fba395ee	182
1da177e4 LT	183	dev = link->priv;
1da177e4 LT	184
5fcd4da0 DB	185	devname[0] = 0;
	186	if (link->prod_id[1])
	187	strlcpy(devname, link->prod_id[1], sizeof(devname));
a9606fd3	188
5fcd4da0 DB	189	/*
	190	* find IO port
	191	*/
	192	if (pcmcia_loop_config(link, avmcs_configcheck, NULL))
	193	return -ENODEV;
50db3fdb	194
5fcd4da0	195	do {
1da177e4 LT	196	/*
	197	* allocate an interrupt line
	198	*/
fba395ee	199	i = pcmcia_request_irq(link, &link->irq);
1da177e4	200	if (i != CS_SUCCESS) {
fba395ee	201	cs_error(link, RequestIRQ, i);
50db3fdb	202	/* undo */
fba395ee	203	pcmcia_disable_device(link);
1da177e4 LT	204	break;
1da177e4 LT	205	}
50db3fdb	206
1da177e4 LT	207	/*
	208	* configure the PCMCIA socket
	209	*/
fba395ee	210	i = pcmcia_request_configuration(link, &link->conf);
1da177e4	211	if (i != CS_SUCCESS) {
fba395ee DB	212	cs_error(link, RequestConfiguration, i);
fba395ee DB	213	pcmcia_disable_device(link);
1da177e4 LT	214	break;
	215	}
	216
	217	} while (0);
	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
	222	if (devname[0]) {
	223	char *s = strrchr(devname, ' ');
	224	if (!s)
	225	s = devname;
	226	else s++;
	227	strcpy(dev->node.dev_name, s);
	228	if (strcmp("M1", s) == 0) {
	229	cardtype = AVM_CARDTYPE_M1;
	230	} else if (strcmp("M2", s) == 0) {
	231	cardtype = AVM_CARDTYPE_M2;
	232	} else {
	233	cardtype = AVM_CARDTYPE_B1;
	234	}
	235	} else {
	236	strcpy(dev->node.dev_name, "b1");
	237	cardtype = AVM_CARDTYPE_B1;
	238	}
	239
	240	dev->node.major = 64;
	241	dev->node.minor = 0;
fd238232	242	link->dev_node = &dev->node;
e2d40963	243
1da177e4 LT	244	/* If any step failed, release any partially configured state */
	245	if (i != 0) {
	246	avmcs_release(link);
15b99ac1	247	return -ENODEV;
1da177e4 LT	248	}
	249
	250
	251	switch (cardtype) {
	252	case AVM_CARDTYPE_M1: addcard = b1pcmcia_addcard_m1; break;
	253	case AVM_CARDTYPE_M2: addcard = b1pcmcia_addcard_m2; break;
	254	default:
	255	case AVM_CARDTYPE_B1: addcard = b1pcmcia_addcard_b1; break;
	256	}
	257	if ((i = (*addcard)(link->io.BasePort1, link->irq.AssignedIRQ)) < 0) {
	258	printk(KERN_ERR "avm_cs: failed to add AVM-%s-Controller at i/o %#x, irq %d\n",
	259	dev->node.dev_name, link->io.BasePort1, link->irq.AssignedIRQ);
	260	avmcs_release(link);
15b99ac1	261	return -ENODEV;
1da177e4 LT	262	}
1da177e4 LT	263	dev->node.minor = i;
15b99ac1	264	return 0;
1da177e4 LT	265
	266	} /* avmcs_config */
	267
	268	/*======================================================================
	269
	270	After a card is removed, avmcs_release() will unregister the net
	271	device, and release the PCMCIA configuration. If the device is
	272	still open, this will be postponed until it is closed.
	273
	274	======================================================================*/
	275
fba395ee	276	static void avmcs_release(struct pcmcia_device *link)
1da177e4	277	{
5f2a71fc	278	b1pcmcia_delcard(link->io.BasePort1, link->irq.AssignedIRQ);
fba395ee	279	pcmcia_disable_device(link);
1da177e4 LT	280	} /* avmcs_release */
1da177e4 LT	281
1da177e4	282
a13bcf0d DB	283	static struct pcmcia_device_id avmcs_ids[] = {
	284	PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN-Controller B1", 0x95d42008, 0x845dc335),
	285	PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M1", 0x95d42008, 0x81e10430),
	286	PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M2", 0x95d42008, 0x18e8558a),
	287	PCMCIA_DEVICE_NULL
	288	};
	289	MODULE_DEVICE_TABLE(pcmcia, avmcs_ids);
	290
1da177e4 LT	291	static struct pcmcia_driver avmcs_driver = {
	292	.owner = THIS_MODULE,
	293	.drv = {
	294	.name = "avm_cs",
	295	},
15b99ac1	296	.probe = avmcs_probe,
cc3b4866	297	.remove = avmcs_detach,
a13bcf0d	298	.id_table = avmcs_ids,
1da177e4 LT	299	};
	300
	301	static int __init avmcs_init(void)
	302	{
	303	return pcmcia_register_driver(&avmcs_driver);
	304	}
	305
	306	static void __exit avmcs_exit(void)
	307	{
	308	pcmcia_unregister_driver(&avmcs_driver);
1da177e4 LT	309	}
	310
	311	module_init(avmcs_init);
	312	module_exit(avmcs_exit);