[mirror_ubuntu-focal-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");

/*
   All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
   you do not define PCMCIA_DEBUG at all, all the debug code will be
   left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
   be present but disabled -- but it can then be enabled for specific
   modules at load time with a 'pc_debug=#' option to insmod.
*/
#ifdef PCMCIA_DEBUG
static int pc_debug = PCMCIA_DEBUG;
module_param(pc_debug, int, 0);
#define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
static char *version =
"avma1_cs.c 1.00 1998/01/23 10:00:00 (Carsten Paeth)";
#else
#define DEBUG(n, args...)
#endif

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

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

    DEBUG(0, "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_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;

    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)
{
	DEBUG(0, "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;

    DEBUG(0, "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) {
	    cs_error(link, RequestIRQ, i);
	    /* undo */
	    pcmcia_disable_device(link);
	    break;
	}

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

    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;

	DEBUG(0, "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
	33	/*
	34	All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If
	35	you do not define PCMCIA_DEBUG at all, all the debug code will be
	36	left out. If you compile with PCMCIA_DEBUG=0, the debug code will
	37	be present but disabled -- but it can then be enabled for specific
	38	modules at load time with a 'pc_debug=#' option to insmod.
	39	*/
	40	#ifdef PCMCIA_DEBUG
	41	static int pc_debug = PCMCIA_DEBUG;
	42	module_param(pc_debug, int, 0);
	43	#define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
	44	static char *version =
	45	"avma1_cs.c 1.00 1998/01/23 10:00:00 (Carsten Paeth)";
	46	#else
	47	#define DEBUG(n, args...)
	48	#endif
	49
	50	/====================================================================/
	51
	52	/* Parameters that can be set with 'insmod' */
	53
	54	static int isdnprot = 2;
	55
	56	module_param(isdnprot, int, 0);
	57
	58	/====================================================================/
	59
	60	/*
	61	The event() function is this driver's Card Services event handler.
	62	It will be called by Card Services when an appropriate card status
	63	event is received. The config() and release() entry points are
	64	used to configure or release a socket, in response to card insertion
	65	and ejection events. They are invoked from the skeleton event
	66	handler.
	67	*/
	68
15b99ac1	69	static int avma1cs_config(struct pcmcia_device *link);
fba395ee	70	static void avma1cs_release(struct pcmcia_device *link);
1da177e4 LT	71
	72	/*
	73	The attach() and detach() entry points are used to create and destroy
	74	"instances" of the driver, where each instance represents everything
	75	needed to manage one actual PCMCIA card.
	76	*/
	77
cc3b4866	78	static void avma1cs_detach(struct pcmcia_device *p_dev);
1da177e4	79
1da177e4 LT	80
	81	/*
	82	A linked list of "instances" of the skeleton device. Each actual
	83	PCMCIA card corresponds to one device instance, and is described
fba395ee	84	by one struct pcmcia_device structure (defined in ds.h).
1da177e4 LT	85
1da177e4 LT	86	You may not want to use a linked list for this -- for example, the
fba395ee	87	memory card driver uses an array of struct pcmcia_device pointers, where minor
1da177e4 LT	88	device numbers are used to derive the corresponding array index.
	89	*/
	90
1da177e4	91	/*
1da177e4 LT	92	A driver needs to provide a dev_node_t structure for each device
	93	on a card. In some cases, there is only one device per card (for
	94	example, ethernet cards, modems). In other cases, there may be
	95	many actual or logical devices (SCSI adapters, memory cards with
	96	multiple partitions). The dev_node_t structures need to be kept
fba395ee	97	in a linked list starting at the 'dev' field of a struct pcmcia_device
1da177e4 LT	98	structure. We allocate them in the card's private data structure,
	99	because they generally can't be allocated dynamically.
	100	*/
	101
	102	typedef struct local_info_t {
	103	dev_node_t node;
	104	} local_info_t;
	105
	106	/*======================================================================
	107
	108	avma1cs_attach() creates an "instance" of the driver, allocating
	109	local data structures for one device. The device is registered
	110	with Card Services.
	111
	112	The dev_link structure is initialized, but we don't actually
	113	configure the card at this point -- we wait until we receive a
	114	card insertion event.
	115
	116	======================================================================*/
	117
15b99ac1	118	static int avma1cs_probe(struct pcmcia_device *p_dev)
1da177e4	119	{
1da177e4	120	local_info_t *local;
f8cfa618	121
1da177e4 LT	122	DEBUG(0, "avma1cs_attach()\n");
1da177e4 LT	123
1da177e4	124	/* Allocate space for private device-specific data */
41f96935	125	local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
fd238232	126	if (!local)
f8cfa618	127	return -ENOMEM;
fd238232	128
fd238232	129	p_dev->priv = local;
1da177e4 LT	130
1da177e4 LT	131	/* The io structure describes IO port mapping */
fd238232 DB	132	p_dev->io.NumPorts1 = 16;
	133	p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
	134	p_dev->io.NumPorts2 = 16;
	135	p_dev->io.Attributes2 = IO_DATA_PATH_WIDTH_16;
	136	p_dev->io.IOAddrLines = 5;
1da177e4 LT	137
1da177e4 LT	138	/* Interrupt setup */
fd238232 DB	139	p_dev->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
fd238232 DB	140	p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING\|IRQ_FIRST_SHARED;
1da177e4	141
fd238232	142	p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
1da177e4 LT	143
1da177e4 LT	144	/* General socket configuration */
fd238232 DB	145	p_dev->conf.Attributes = CONF_ENABLE_IRQ;
	146	p_dev->conf.IntType = INT_MEMORY_AND_IO;
	147	p_dev->conf.ConfigIndex = 1;
	148	p_dev->conf.Present = PRESENT_OPTION;
f8cfa618	149
15b99ac1	150	return avma1cs_config(p_dev);
1da177e4 LT	151	} /* avma1cs_attach */
	152
	153	/*======================================================================
	154
	155	This deletes a driver "instance". The device is de-registered
	156	with Card Services. If it has been released, all local data
	157	structures are freed. Otherwise, the structures will be freed
	158	when the device is released.
	159
	160	======================================================================*/
	161
fba395ee	162	static void avma1cs_detach(struct pcmcia_device *link)
1da177e4	163	{
e2d40963 DB	164	DEBUG(0, "avma1cs_detach(0x%p)\n", link);
	165	avma1cs_release(link);
	166	kfree(link->priv);
1da177e4 LT	167	} /* avma1cs_detach */
	168
	169	/*======================================================================
	170
	171	avma1cs_config() is scheduled to run after a CARD_INSERTION event
	172	is received, to configure the PCMCIA socket, and to make the
	173	ethernet device available to the system.
	174
	175	======================================================================*/
	176
5fcd4da0	177	static int avma1cs_configcheck(struct pcmcia_device *p_dev,
8e2fc39d DB	178	cistpl_cftable_entry_t *cf,
8e2fc39d DB	179	cistpl_cftable_entry_t *dflt,
ad913c11	180	unsigned int vcc,
8e2fc39d	181	void *priv_data)
1da177e4	182	{
5fcd4da0 DB	183	if (cf->io.nwin <= 0)
	184	return -ENODEV;
	185
5fcd4da0 DB	186	p_dev->io.BasePort1 = cf->io.win[0].base;
	187	p_dev->io.NumPorts1 = cf->io.win[0].len;
	188	p_dev->io.NumPorts2 = 0;
	189	printk(KERN_INFO "avma1_cs: testing i/o %#x-%#x\n",
	190	p_dev->io.BasePort1,
	191	p_dev->io.BasePort1+p_dev->io.NumPorts1-1);
	192	return pcmcia_request_io(p_dev, &p_dev->io);
1da177e4 LT	193	}
1da177e4 LT	194
1da177e4	195
15b99ac1	196	static int avma1cs_config(struct pcmcia_device *link)
1da177e4	197	{
1da177e4 LT	198	local_info_t *dev;
1da177e4 LT	199	int i;
1da177e4 LT	200	char devname[128];
	201	IsdnCard_t icard;
	202	int busy = 0;
fba395ee	203
1da177e4 LT	204	dev = link->priv;
	205
	206	DEBUG(0, "avma1cs_config(0x%p)\n", link);
	207
5fcd4da0 DB	208	devname[0] = 0;
	209	if (link->prod_id[1])
	210	strlcpy(devname, link->prod_id[1], sizeof(devname));
a9606fd3	211
5fcd4da0 DB	212	if (pcmcia_loop_config(link, avma1cs_configcheck, NULL))
5fcd4da0 DB	213	return -ENODEV;
1da177e4	214
5fcd4da0	215	do {
1da177e4 LT	216	/*
	217	* allocate an interrupt line
	218	*/
fba395ee	219	i = pcmcia_request_irq(link, &link->irq);
4c89e88b	220	if (i != 0) {
fba395ee	221	cs_error(link, RequestIRQ, i);
50db3fdb	222	/* undo */
fba395ee	223	pcmcia_disable_device(link);
1da177e4 LT	224	break;
1da177e4 LT	225	}
50db3fdb	226
1da177e4 LT	227	/*
	228	* configure the PCMCIA socket
	229	*/
fba395ee	230	i = pcmcia_request_configuration(link, &link->conf);
4c89e88b	231	if (i != 0) {
fba395ee DB	232	cs_error(link, RequestConfiguration, i);
fba395ee DB	233	pcmcia_disable_device(link);
1da177e4 LT	234	break;
	235	}
	236
	237	} while (0);
	238
	239	/* At this point, the dev_node_t structure(s) should be
	240	initialized and arranged in a linked list at link->dev. */
	241
	242	strcpy(dev->node.dev_name, "A1");
	243	dev->node.major = 45;
	244	dev->node.minor = 0;
fd238232	245	link->dev_node = &dev->node;
e2d40963	246
1da177e4 LT	247	/* If any step failed, release any partially configured state */
	248	if (i != 0) {
	249	avma1cs_release(link);
15b99ac1	250	return -ENODEV;
1da177e4 LT	251	}
	252
	253	printk(KERN_NOTICE "avma1_cs: checking at i/o %#x, irq %d\n",
	254	link->io.BasePort1, link->irq.AssignedIRQ);
	255
	256	icard.para[0] = link->irq.AssignedIRQ;
	257	icard.para[1] = link->io.BasePort1;
	258	icard.protocol = isdnprot;
	259	icard.typ = ISDN_CTYPE_A1_PCMCIA;
	260
	261	i = hisax_init_pcmcia(link, &busy, &icard);
	262	if (i < 0) {
	263	printk(KERN_ERR "avma1_cs: failed to initialize AVM A1 PCMCIA %d at i/o %#x\n", i, link->io.BasePort1);
	264	avma1cs_release(link);
15b99ac1	265	return -ENODEV;
1da177e4 LT	266	}
	267	dev->node.minor = i;
	268
15b99ac1	269	return 0;
1da177e4 LT	270	} /* avma1cs_config */
	271
	272	/*======================================================================
	273
	274	After a card is removed, avma1cs_release() will unregister the net
	275	device, and release the PCMCIA configuration. If the device is
	276	still open, this will be postponed until it is closed.
	277
	278	======================================================================*/
	279
fba395ee	280	static void avma1cs_release(struct pcmcia_device *link)
1da177e4	281	{
5f2a71fc	282	local_info_t *local = link->priv;
1da177e4	283
5f2a71fc	284	DEBUG(0, "avma1cs_release(0x%p)\n", link);
1da177e4	285
5f2a71fc DB	286	/* now unregister function with hisax */
5f2a71fc DB	287	HiSax_closecard(local->node.minor);
1da177e4	288
fba395ee	289	pcmcia_disable_device(link);
1da177e4 LT	290	} /* avma1cs_release */
1da177e4 LT	291
1da177e4	292
c594c12c DB	293	static struct pcmcia_device_id avma1cs_ids[] = {
	294	PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN A", 0x95d42008, 0xadc9d4bb),
	295	PCMCIA_DEVICE_PROD_ID12("ISDN", "CARD", 0x8d9761c8, 0x01c5aa7b),
	296	PCMCIA_DEVICE_NULL
	297	};
	298	MODULE_DEVICE_TABLE(pcmcia, avma1cs_ids);
	299
1da177e4 LT	300	static struct pcmcia_driver avma1cs_driver = {
	301	.owner = THIS_MODULE,
	302	.drv = {
	303	.name = "avma1_cs",
	304	},
15b99ac1	305	.probe = avma1cs_probe,
cc3b4866	306	.remove = avma1cs_detach,
c594c12c	307	.id_table = avma1cs_ids,
1da177e4	308	};
8661bb5b	309
1da177e4 LT	310	/====================================================================/
	311
	312	static int __init init_avma1_cs(void)
	313	{
	314	return(pcmcia_register_driver(&avma1cs_driver));
	315	}
	316
	317	static void __exit exit_avma1_cs(void)
	318	{
	319	pcmcia_unregister_driver(&avma1cs_driver);
1da177e4 LT	320	}
	321
	322	module_init(init_avma1_cs);
	323	module_exit(exit_avma1_cs);