[mirror_ubuntu-artful-kernel.git] / drivers / isdn / hisax / avma1_cs.c

/*
 * PCMCIA client driver for AVM A1 / Fritz!PCMCIA
 *
 * Author       Carsten Paeth
 * Copyright    1998-2001 by Carsten Paeth <calle@calle.in-berlin.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 <asm/io.h>
#include <asm/system.h>

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

MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for AVM A1/Fritz!PCMCIA cards");
MODULE_AUTHOR("Carsten Paeth");
MODULE_LICENSE("GPL");


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

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

static int isdnprot = 2;

module_param(isdnprot, 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 skeleton event
   handler.
*/

static int avma1cs_config(struct pcmcia_device *link);
static void avma1cs_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 avma1cs_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;

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

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

    dev_dbg(&p_dev->dev, "avma1cs_attach()\n");

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

    p_dev->priv = 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 = 16;
    p_dev->io.Attributes2 = IO_DATA_PATH_WIDTH_16;
    p_dev->io.IOAddrLines = 5;

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

    /* 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;

    return avma1cs_config(p_dev);
} /* avma1cs_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 avma1cs_detach(struct pcmcia_device *link)
{
	dev_dbg(&link->dev, "avma1cs_detach(0x%p)\n", link);
	avma1cs_release(link);
	kfree(link->priv);
} /* avma1cs_detach */

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

    avma1cs_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 avma1cs_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 "avma1_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 avma1cs_config(struct pcmcia_device *link)
{
    local_info_t *dev;
    int i;
    char devname[128];
    IsdnCard_t	icard;
    int busy = 0;

    dev = link->priv;

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

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

    if (pcmcia_loop_config(link, avma1cs_configcheck, NULL))
	    return -ENODEV;

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

	/*
	 * configure the PCMCIA socket
	 */
	i = pcmcia_request_configuration(link, &link->conf);
	if (i != 0) {
	    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. */

    strcpy(dev->node.dev_name, "A1");
    dev->node.major = 45;
    dev->node.minor = 0;
    link->dev_node = &dev->node;

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

    printk(KERN_NOTICE "avma1_cs: checking at i/o %#x, irq %d\n",
				link->io.BasePort1, link->irq.AssignedIRQ);

    icard.para[0] = link->irq.AssignedIRQ;
    icard.para[1] = link->io.BasePort1;
    icard.protocol = isdnprot;
    icard.typ = ISDN_CTYPE_A1_PCMCIA;
    
    i = hisax_init_pcmcia(link, &busy, &icard);
    if (i < 0) {
    	printk(KERN_ERR "avma1_cs: failed to initialize AVM A1 PCMCIA %d at i/o %#x\n", i, link->io.BasePort1);
	avma1cs_release(link);
	return -ENODEV;
    }
    dev->node.minor = i;

    return 0;
} /* avma1cs_config */

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

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

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

	/* now unregister function with hisax */
	HiSax_closecard(local->node.minor);

	pcmcia_disable_device(link);
} /* avma1cs_release */


static struct pcmcia_device_id avma1cs_ids[] = {
	PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN A", 0x95d42008, 0xadc9d4bb),
	PCMCIA_DEVICE_PROD_ID12("ISDN", "CARD", 0x8d9761c8, 0x01c5aa7b),
	PCMCIA_DEVICE_NULL
};
MODULE_DEVICE_TABLE(pcmcia, avma1cs_ids);

static struct pcmcia_driver avma1cs_driver = {
	.owner		= THIS_MODULE,
	.drv		= {
		.name	= "avma1_cs",
	},
	.probe		= avma1cs_probe,
	.remove		= avma1cs_detach,
	.id_table	= avma1cs_ids,
};

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

static int __init init_avma1_cs(void)
{
	return(pcmcia_register_driver(&avma1cs_driver));
}

static void __exit exit_avma1_cs(void)
{
	pcmcia_unregister_driver(&avma1cs_driver);
}

module_init(init_avma1_cs);
module_exit(exit_avma1_cs);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* PCMCIA client driver for AVM A1 / Fritz!PCMCIA
	3	*
	4	* Author Carsten Paeth
	5	* Copyright 1998-2001 by Carsten Paeth <calle@calle.in-berlin.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
	14
	15	#include <linux/kernel.h>
	16	#include <linux/init.h>
1da177e4 LT	17	#include <linux/ptrace.h>
	18	#include <linux/slab.h>
	19	#include <linux/string.h>
	20	#include <asm/io.h>
	21	#include <asm/system.h>
	22
1da177e4 LT	23	#include <pcmcia/cs_types.h>
	24	#include <pcmcia/cs.h>
	25	#include <pcmcia/cistpl.h>
	26	#include <pcmcia/ds.h>
	27	#include "hisax_cfg.h"
	28
	29	MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for AVM A1/Fritz!PCMCIA cards");
	30	MODULE_AUTHOR("Carsten Paeth");
	31	MODULE_LICENSE("GPL");
	32
1da177e4 LT	33
	34	/====================================================================/
	35
	36	/* Parameters that can be set with 'insmod' */
	37
	38	static int isdnprot = 2;
	39
	40	module_param(isdnprot, int, 0);
	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 avma1cs_config(struct pcmcia_device *link);
fba395ee	54	static void avma1cs_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 avma1cs_detach(struct pcmcia_device *p_dev);
1da177e4	63
1da177e4 LT	64
	65	/*
	66	A linked list of "instances" of the skeleton device. Each actual
	67	PCMCIA card corresponds to one device instance, and is described
fba395ee	68	by one struct pcmcia_device structure (defined in ds.h).
1da177e4 LT	69
1da177e4 LT	70	You may not want to use a linked list for this -- for example, the
fba395ee	71	memory card driver uses an array of struct pcmcia_device pointers, where minor
1da177e4 LT	72	device numbers are used to derive the corresponding array index.
	73	*/
	74
1da177e4	75	/*
1da177e4 LT	76	A driver needs to provide a dev_node_t structure for each device
	77	on a card. In some cases, there is only one device per card (for
	78	example, ethernet cards, modems). In other cases, there may be
	79	many actual or logical devices (SCSI adapters, memory cards with
	80	multiple partitions). The dev_node_t structures need to be kept
fba395ee	81	in a linked list starting at the 'dev' field of a struct pcmcia_device
1da177e4 LT	82	structure. We allocate them in the card's private data structure,
	83	because they generally can't be allocated dynamically.
	84	*/
	85
	86	typedef struct local_info_t {
	87	dev_node_t node;
	88	} local_info_t;
	89
	90	/*======================================================================
	91
	92	avma1cs_attach() creates an "instance" of the driver, allocating
	93	local data structures for one device. The device is registered
	94	with Card Services.
	95
	96	The dev_link structure is initialized, but we don't actually
	97	configure the card at this point -- we wait until we receive a
	98	card insertion event.
	99
	100	======================================================================*/
	101
15b99ac1	102	static int avma1cs_probe(struct pcmcia_device *p_dev)
1da177e4	103	{
1da177e4	104	local_info_t *local;
f8cfa618	105
e773cfe1	106	dev_dbg(&p_dev->dev, "avma1cs_attach()\n");
1da177e4	107
1da177e4	108	/* Allocate space for private device-specific data */
41f96935	109	local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
fd238232	110	if (!local)
f8cfa618	111	return -ENOMEM;
fd238232	112
fd238232	113	p_dev->priv = local;
1da177e4 LT	114
1da177e4 LT	115	/* The io structure describes IO port mapping */
fd238232 DB	116	p_dev->io.NumPorts1 = 16;
	117	p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
	118	p_dev->io.NumPorts2 = 16;
	119	p_dev->io.Attributes2 = IO_DATA_PATH_WIDTH_16;
	120	p_dev->io.IOAddrLines = 5;
1da177e4 LT	121
1da177e4 LT	122	/* Interrupt setup */
e15c1c1f	123	p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
1da177e4	124
1da177e4	125	/* General socket configuration */
fd238232 DB	126	p_dev->conf.Attributes = CONF_ENABLE_IRQ;
	127	p_dev->conf.IntType = INT_MEMORY_AND_IO;
	128	p_dev->conf.ConfigIndex = 1;
	129	p_dev->conf.Present = PRESENT_OPTION;
f8cfa618	130
15b99ac1	131	return avma1cs_config(p_dev);
1da177e4 LT	132	} /* avma1cs_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 avma1cs_detach(struct pcmcia_device *link)
1da177e4	144	{
e773cfe1	145	dev_dbg(&link->dev, "avma1cs_detach(0x%p)\n", link);
e2d40963 DB	146	avma1cs_release(link);
e2d40963 DB	147	kfree(link->priv);
1da177e4 LT	148	} /* avma1cs_detach */
	149
	150	/*======================================================================
	151
	152	avma1cs_config() is scheduled to run after a CARD_INSERTION event
	153	is received, to configure the PCMCIA socket, and to make the
	154	ethernet device available to the system.
	155
	156	======================================================================*/
	157
5fcd4da0	158	static int avma1cs_configcheck(struct pcmcia_device *p_dev,
8e2fc39d DB	159	cistpl_cftable_entry_t *cf,
8e2fc39d DB	160	cistpl_cftable_entry_t *dflt,
ad913c11	161	unsigned int vcc,
8e2fc39d	162	void *priv_data)
1da177e4	163	{
5fcd4da0 DB	164	if (cf->io.nwin <= 0)
	165	return -ENODEV;
	166
5fcd4da0 DB	167	p_dev->io.BasePort1 = cf->io.win[0].base;
	168	p_dev->io.NumPorts1 = cf->io.win[0].len;
	169	p_dev->io.NumPorts2 = 0;
	170	printk(KERN_INFO "avma1_cs: testing i/o %#x-%#x\n",
	171	p_dev->io.BasePort1,
	172	p_dev->io.BasePort1+p_dev->io.NumPorts1-1);
	173	return pcmcia_request_io(p_dev, &p_dev->io);
1da177e4 LT	174	}
1da177e4 LT	175
1da177e4	176
15b99ac1	177	static int avma1cs_config(struct pcmcia_device *link)
1da177e4	178	{
1da177e4 LT	179	local_info_t *dev;
1da177e4 LT	180	int i;
1da177e4 LT	181	char devname[128];
	182	IsdnCard_t icard;
	183	int busy = 0;
fba395ee	184
1da177e4 LT	185	dev = link->priv;
1da177e4 LT	186
e773cfe1	187	dev_dbg(&link->dev, "avma1cs_config(0x%p)\n", link);
1da177e4	188
5fcd4da0 DB	189	devname[0] = 0;
	190	if (link->prod_id[1])
	191	strlcpy(devname, link->prod_id[1], sizeof(devname));
a9606fd3	192
5fcd4da0 DB	193	if (pcmcia_loop_config(link, avma1cs_configcheck, NULL))
5fcd4da0 DB	194	return -ENODEV;
1da177e4	195
5fcd4da0	196	do {
1da177e4 LT	197	/*
	198	* allocate an interrupt line
	199	*/
fba395ee	200	i = pcmcia_request_irq(link, &link->irq);
4c89e88b	201	if (i != 0) {
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);
4c89e88b	211	if (i != 0) {
fba395ee	212	pcmcia_disable_device(link);
1da177e4 LT	213	break;
	214	}
	215
	216	} while (0);
	217
	218	/* At this point, the dev_node_t structure(s) should be
	219	initialized and arranged in a linked list at link->dev. */
	220
	221	strcpy(dev->node.dev_name, "A1");
	222	dev->node.major = 45;
	223	dev->node.minor = 0;
fd238232	224	link->dev_node = &dev->node;
e2d40963	225
1da177e4 LT	226	/* If any step failed, release any partially configured state */
	227	if (i != 0) {
	228	avma1cs_release(link);
15b99ac1	229	return -ENODEV;
1da177e4 LT	230	}
	231
	232	printk(KERN_NOTICE "avma1_cs: checking at i/o %#x, irq %d\n",
	233	link->io.BasePort1, link->irq.AssignedIRQ);
	234
	235	icard.para[0] = link->irq.AssignedIRQ;
	236	icard.para[1] = link->io.BasePort1;
	237	icard.protocol = isdnprot;
	238	icard.typ = ISDN_CTYPE_A1_PCMCIA;
	239
	240	i = hisax_init_pcmcia(link, &busy, &icard);
	241	if (i < 0) {
	242	printk(KERN_ERR "avma1_cs: failed to initialize AVM A1 PCMCIA %d at i/o %#x\n", i, link->io.BasePort1);
	243	avma1cs_release(link);
15b99ac1	244	return -ENODEV;
1da177e4 LT	245	}
	246	dev->node.minor = i;
	247
15b99ac1	248	return 0;
1da177e4 LT	249	} /* avma1cs_config */
	250
	251	/*======================================================================
	252
	253	After a card is removed, avma1cs_release() will unregister the net
	254	device, and release the PCMCIA configuration. If the device is
	255	still open, this will be postponed until it is closed.
	256
	257	======================================================================*/
	258
fba395ee	259	static void avma1cs_release(struct pcmcia_device *link)
1da177e4	260	{
5f2a71fc	261	local_info_t *local = link->priv;
1da177e4	262
e773cfe1	263	dev_dbg(&link->dev, "avma1cs_release(0x%p)\n", link);
1da177e4	264
5f2a71fc DB	265	/* now unregister function with hisax */
5f2a71fc DB	266	HiSax_closecard(local->node.minor);
1da177e4	267
fba395ee	268	pcmcia_disable_device(link);
1da177e4 LT	269	} /* avma1cs_release */
1da177e4 LT	270
1da177e4	271
c594c12c DB	272	static struct pcmcia_device_id avma1cs_ids[] = {
	273	PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN A", 0x95d42008, 0xadc9d4bb),
	274	PCMCIA_DEVICE_PROD_ID12("ISDN", "CARD", 0x8d9761c8, 0x01c5aa7b),
	275	PCMCIA_DEVICE_NULL
	276	};
	277	MODULE_DEVICE_TABLE(pcmcia, avma1cs_ids);
	278
1da177e4 LT	279	static struct pcmcia_driver avma1cs_driver = {
	280	.owner = THIS_MODULE,
	281	.drv = {
	282	.name = "avma1_cs",
	283	},
15b99ac1	284	.probe = avma1cs_probe,
cc3b4866	285	.remove = avma1cs_detach,
c594c12c	286	.id_table = avma1cs_ids,
1da177e4	287	};
8661bb5b	288
1da177e4 LT	289	/====================================================================/
	290
	291	static int __init init_avma1_cs(void)
	292	{
	293	return(pcmcia_register_driver(&avma1cs_driver));
	294	}
	295
	296	static void __exit exit_avma1_cs(void)
	297	{
	298	pcmcia_unregister_driver(&avma1cs_driver);
1da177e4 LT	299	}
	300
	301	module_init(init_avma1_cs);
	302	module_exit(exit_avma1_cs);