[mirror_ubuntu-artful-kernel.git] / drivers / parport / parport_cs.c

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

    A driver for PCMCIA parallel port adapters

    (specifically, for the Quatech SPP-100 EPP card: other cards will
    probably require driver tweaks)
    
    parport_cs.c 1.29 2002/10/11 06:57:41

    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.

    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/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/sched.h>
#include <linux/ptrace.h>
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/timer.h>
#include <linux/ioport.h>
#include <linux/major.h>

#include <linux/parport.h>
#include <linux/parport_pc.h>

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

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

/* Module parameters */

MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
MODULE_DESCRIPTION("PCMCIA parallel port card driver");
MODULE_LICENSE("Dual MPL/GPL");

#define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)

INT_MODULE_PARM(epp_mode, 1);

#ifdef PCMCIA_DEBUG
INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);
#define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
static char *version =
"parport_cs.c 1.29 2002/10/11 06:57:41 (David Hinds)";
#else
#define DEBUG(n, args...)
#endif

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

#define FORCE_EPP_MODE	0x08

typedef struct parport_info_t {
	struct pcmcia_device	*p_dev;
    int			ndev;
    dev_node_t		node;
    struct parport	*port;
} parport_info_t;

static void parport_detach(struct pcmcia_device *p_dev);
static void parport_config(struct pcmcia_device *link);
static void parport_cs_release(struct pcmcia_device *);

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

    parport_attach() creates an "instance" of the driver, allocating
    local data structures for one device.  The device is registered
    with Card Services.

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

static int parport_attach(struct pcmcia_device *link)
{
    parport_info_t *info;

    DEBUG(0, "parport_attach()\n");

    /* Create new parport device */
    info = kmalloc(sizeof(*info), GFP_KERNEL);
    if (!info) return -ENOMEM;
    memset(info, 0, sizeof(*info));
    link->priv = info;
    info->p_dev = link;

    link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
    link->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
    link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
    link->irq.IRQInfo1 = IRQ_LEVEL_ID;
    link->conf.Attributes = CONF_ENABLE_IRQ;
    link->conf.IntType = INT_MEMORY_AND_IO;

    link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
    parport_config(link);

    return 0;
} /* parport_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 parport_detach(struct pcmcia_device *link)
{
    DEBUG(0, "parport_detach(0x%p)\n", link);

    if (link->state & DEV_CONFIG)
	parport_cs_release(link);

    kfree(link->priv);
} /* parport_detach */

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

    parport_config() is scheduled to run after a CARD_INSERTION event
    is received, to configure the PCMCIA socket, and to make the
    parport device available to the system.

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

#define CS_CHECK(fn, ret) \
do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)

void parport_config(struct pcmcia_device *link)
{
    parport_info_t *info = link->priv;
    tuple_t tuple;
    u_short buf[128];
    cisparse_t parse;
    cistpl_cftable_entry_t *cfg = &parse.cftable_entry;
    cistpl_cftable_entry_t dflt = { 0 };
    struct parport *p;
    int last_ret, last_fn;
    
    DEBUG(0, "parport_config(0x%p)\n", link);
    
    tuple.TupleData = (cisdata_t *)buf;
    tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
    tuple.Attributes = 0;
    tuple.DesiredTuple = CISTPL_CONFIG;
    CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
    CS_CHECK(GetTupleData, pcmcia_get_tuple_data(link, &tuple));
    CS_CHECK(ParseTuple, pcmcia_parse_tuple(link, &tuple, &parse));
    link->conf.ConfigBase = parse.config.base;
    link->conf.Present = parse.config.rmask[0];
    
    /* Configure card */
    link->state |= DEV_CONFIG;

    tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
    tuple.Attributes = 0;
    CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
    while (1) {
	if (pcmcia_get_tuple_data(link, &tuple) != 0 ||
		pcmcia_parse_tuple(link, &tuple, &parse) != 0)
	    goto next_entry;

	if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
	    cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
	    link->conf.ConfigIndex = cfg->index;
	    if (epp_mode)
		link->conf.ConfigIndex |= FORCE_EPP_MODE;
	    link->io.BasePort1 = io->win[0].base;
	    link->io.NumPorts1 = io->win[0].len;
	    link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
	    if (io->nwin == 2) {
		link->io.BasePort2 = io->win[1].base;
		link->io.NumPorts2 = io->win[1].len;
	    }
	    if (pcmcia_request_io(link, &link->io) != 0)
		goto next_entry;
	    /* If we've got this far, we're done */
	    break;
	}
	
    next_entry:
	if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
	CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(link, &tuple));
    }
    
    CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
    CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));

    p = parport_pc_probe_port(link->io.BasePort1, link->io.BasePort2,
			      link->irq.AssignedIRQ, PARPORT_DMA_NONE,
			      NULL);
    if (p == NULL) {
	printk(KERN_NOTICE "parport_cs: parport_pc_probe_port() at "
	       "0x%3x, irq %u failed\n", link->io.BasePort1,
	       link->irq.AssignedIRQ);
	goto failed;
    }

    p->modes |= PARPORT_MODE_PCSPP;
    if (epp_mode)
	p->modes |= PARPORT_MODE_TRISTATE | PARPORT_MODE_EPP;
    info->ndev = 1;
    info->node.major = LP_MAJOR;
    info->node.minor = p->number;
    info->port = p;
    strcpy(info->node.dev_name, p->name);
    link->dev_node = &info->node;

    link->state &= ~DEV_CONFIG_PENDING;
    return;
    
cs_failed:
    cs_error(link, last_fn, last_ret);
failed:
    parport_cs_release(link);
    link->state &= ~DEV_CONFIG_PENDING;

} /* parport_config */

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

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

void parport_cs_release(struct pcmcia_device *link)
{
	parport_info_t *info = link->priv;

	DEBUG(0, "parport_release(0x%p)\n", link);

	if (info->ndev) {
		struct parport *p = info->port;
		parport_pc_unregister_port(p);
	}
	info->ndev = 0;

	pcmcia_disable_device(link);
} /* parport_cs_release */


static struct pcmcia_device_id parport_ids[] = {
	PCMCIA_DEVICE_FUNC_ID(3),
	PCMCIA_DEVICE_MANF_CARD(0x0137, 0x0003),
	PCMCIA_DEVICE_NULL
};
MODULE_DEVICE_TABLE(pcmcia, parport_ids);

static struct pcmcia_driver parport_cs_driver = {
	.owner		= THIS_MODULE,
	.drv		= {
		.name	= "parport_cs",
	},
	.probe		= parport_attach,
	.remove		= parport_detach,
	.id_table	= parport_ids,
};

static int __init init_parport_cs(void)
{
	return pcmcia_register_driver(&parport_cs_driver);
}

static void __exit exit_parport_cs(void)
{
	pcmcia_unregister_driver(&parport_cs_driver);
}

module_init(init_parport_cs);
module_exit(exit_parport_cs);
Commit	Line	Data
1da177e4 LT	1	/*======================================================================
	2
	3	A driver for PCMCIA parallel port adapters
	4
	5	(specifically, for the Quatech SPP-100 EPP card: other cards will
	6	probably require driver tweaks)
	7
	8	parport_cs.c 1.29 2002/10/11 06:57:41
	9
	10	The contents of this file are subject to the Mozilla Public
	11	License Version 1.1 (the "License"); you may not use this file
	12	except in compliance with the License. You may obtain a copy of
	13	the License at http://www.mozilla.org/MPL/
	14
	15	Software distributed under the License is distributed on an "AS
	16	IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
	17	implied. See the License for the specific language governing
	18	rights and limitations under the License.
	19
	20	The initial developer of the original code is David A. Hinds
	21	<dahinds@users.sourceforge.net>. Portions created by David A. Hinds
	22	are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
	23
	24	Alternatively, the contents of this file may be used under the
	25	terms of the GNU General Public License version 2 (the "GPL"), in
	26	which case the provisions of the GPL are applicable instead of the
	27	above. If you wish to allow the use of your version of this file
	28	only under the terms of the GPL and not to allow others to use
	29	your version of this file under the MPL, indicate your decision
	30	by deleting the provisions above and replace them with the notice
	31	and other provisions required by the GPL. If you do not delete
	32	the provisions above, a recipient may use your version of this
	33	file under either the MPL or the GPL.
	34
	35	======================================================================*/
	36
	37	#include <linux/kernel.h>
	38	#include <linux/module.h>
	39	#include <linux/init.h>
	40	#include <linux/sched.h>
	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 <linux/major.h>
	47
	48	#include <linux/parport.h>
	49	#include <linux/parport_pc.h>
	50
1da177e4 LT	51	#include <pcmcia/cs_types.h>
	52	#include <pcmcia/cs.h>
	53	#include <pcmcia/cistpl.h>
	54	#include <pcmcia/ds.h>
	55	#include <pcmcia/cisreg.h>
	56	#include <pcmcia/ciscode.h>
	57
	58	/====================================================================/
	59
	60	/* Module parameters */
	61
	62	MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
	63	MODULE_DESCRIPTION("PCMCIA parallel port card driver");
	64	MODULE_LICENSE("Dual MPL/GPL");
	65
	66	#define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
	67
	68	INT_MODULE_PARM(epp_mode, 1);
	69
	70	#ifdef PCMCIA_DEBUG
	71	INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);
	72	#define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
	73	static char *version =
	74	"parport_cs.c 1.29 2002/10/11 06:57:41 (David Hinds)";
	75	#else
	76	#define DEBUG(n, args...)
	77	#endif
	78
	79	/====================================================================/
	80
	81	#define FORCE_EPP_MODE 0x08
	82
	83	typedef struct parport_info_t {
fd238232	84	struct pcmcia_device *p_dev;
1da177e4 LT	85	int ndev;
	86	dev_node_t node;
	87	struct parport *port;
	88	} parport_info_t;
	89
cc3b4866	90	static void parport_detach(struct pcmcia_device *p_dev);
fba395ee DB	91	static void parport_config(struct pcmcia_device *link);
fba395ee DB	92	static void parport_cs_release(struct pcmcia_device *);
1da177e4 LT	93
	94	/*======================================================================
	95
	96	parport_attach() creates an "instance" of the driver, allocating
	97	local data structures for one device. The device is registered
	98	with Card Services.
	99
	100	======================================================================*/
	101
fba395ee	102	static int parport_attach(struct pcmcia_device *link)
1da177e4 LT	103	{
1da177e4 LT	104	parport_info_t *info;
f8cfa618	105
1da177e4 LT	106	DEBUG(0, "parport_attach()\n");
	107
	108	/* Create new parport device */
	109	info = kmalloc(sizeof(*info), GFP_KERNEL);
f8cfa618	110	if (!info) return -ENOMEM;
1da177e4	111	memset(info, 0, sizeof(*info));
fd238232	112	link->priv = info;
fba395ee	113	info->p_dev = link;
1da177e4 LT	114
	115	link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
	116	link->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
	117	link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
	118	link->irq.IRQInfo1 = IRQ_LEVEL_ID;
	119	link->conf.Attributes = CONF_ENABLE_IRQ;
1da177e4	120	link->conf.IntType = INT_MEMORY_AND_IO;
f8cfa618	121
f8cfa618 DB	122	link->state \|= DEV_PRESENT \| DEV_CONFIG_PENDING;
	123	parport_config(link);
	124
	125	return 0;
1da177e4 LT	126	} /* parport_attach */
	127
	128	/*======================================================================
	129
	130	This deletes a driver "instance". The device is de-registered
	131	with Card Services. If it has been released, all local data
	132	structures are freed. Otherwise, the structures will be freed
	133	when the device is released.
	134
	135	======================================================================*/
	136
fba395ee	137	static void parport_detach(struct pcmcia_device *link)
1da177e4	138	{
1da177e4	139	DEBUG(0, "parport_detach(0x%p)\n", link);
cc3b4866	140
1da177e4 LT	141	if (link->state & DEV_CONFIG)
1da177e4 LT	142	parport_cs_release(link);
cc3b4866	143
1da177e4	144	kfree(link->priv);
1da177e4 LT	145	} /* parport_detach */
	146
	147	/*======================================================================
	148
	149	parport_config() is scheduled to run after a CARD_INSERTION event
	150	is received, to configure the PCMCIA socket, and to make the
	151	parport device available to the system.
	152
	153	======================================================================*/
	154
	155	#define CS_CHECK(fn, ret) \
	156	do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
	157
fba395ee	158	void parport_config(struct pcmcia_device *link)
1da177e4	159	{
1da177e4 LT	160	parport_info_t *info = link->priv;
	161	tuple_t tuple;
	162	u_short buf[128];
	163	cisparse_t parse;
1da177e4 LT	164	cistpl_cftable_entry_t *cfg = &parse.cftable_entry;
	165	cistpl_cftable_entry_t dflt = { 0 };
	166	struct parport *p;
	167	int last_ret, last_fn;
	168
	169	DEBUG(0, "parport_config(0x%p)\n", link);
	170
	171	tuple.TupleData = (cisdata_t *)buf;
	172	tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
	173	tuple.Attributes = 0;
	174	tuple.DesiredTuple = CISTPL_CONFIG;
fba395ee DB	175	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
	176	CS_CHECK(GetTupleData, pcmcia_get_tuple_data(link, &tuple));
	177	CS_CHECK(ParseTuple, pcmcia_parse_tuple(link, &tuple, &parse));
1da177e4 LT	178	link->conf.ConfigBase = parse.config.base;
	179	link->conf.Present = parse.config.rmask[0];
	180
	181	/* Configure card */
	182	link->state \|= DEV_CONFIG;
	183
1da177e4 LT	184	tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
1da177e4 LT	185	tuple.Attributes = 0;
fba395ee	186	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
1da177e4	187	while (1) {
fba395ee DB	188	if (pcmcia_get_tuple_data(link, &tuple) != 0 \|\|
fba395ee DB	189	pcmcia_parse_tuple(link, &tuple, &parse) != 0)
1da177e4 LT	190	goto next_entry;
	191
	192	if ((cfg->io.nwin > 0) \|\| (dflt.io.nwin > 0)) {
	193	cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
	194	link->conf.ConfigIndex = cfg->index;
	195	if (epp_mode)
	196	link->conf.ConfigIndex \|= FORCE_EPP_MODE;
	197	link->io.BasePort1 = io->win[0].base;
	198	link->io.NumPorts1 = io->win[0].len;
	199	link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
	200	if (io->nwin == 2) {
	201	link->io.BasePort2 = io->win[1].base;
	202	link->io.NumPorts2 = io->win[1].len;
	203	}
fba395ee	204	if (pcmcia_request_io(link, &link->io) != 0)
1da177e4 LT	205	goto next_entry;
	206	/* If we've got this far, we're done */
	207	break;
	208	}
	209
	210	next_entry:
	211	if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
fba395ee	212	CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(link, &tuple));
1da177e4 LT	213	}
1da177e4 LT	214
fba395ee DB	215	CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
fba395ee DB	216	CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
1da177e4	217
1da177e4 LT	218	p = parport_pc_probe_port(link->io.BasePort1, link->io.BasePort2,
	219	link->irq.AssignedIRQ, PARPORT_DMA_NONE,
	220	NULL);
	221	if (p == NULL) {
	222	printk(KERN_NOTICE "parport_cs: parport_pc_probe_port() at "
	223	"0x%3x, irq %u failed\n", link->io.BasePort1,
	224	link->irq.AssignedIRQ);
	225	goto failed;
	226	}
	227
	228	p->modes \|= PARPORT_MODE_PCSPP;
	229	if (epp_mode)
	230	p->modes \|= PARPORT_MODE_TRISTATE \| PARPORT_MODE_EPP;
	231	info->ndev = 1;
	232	info->node.major = LP_MAJOR;
	233	info->node.minor = p->number;
	234	info->port = p;
	235	strcpy(info->node.dev_name, p->name);
fd238232	236	link->dev_node = &info->node;
1da177e4 LT	237
	238	link->state &= ~DEV_CONFIG_PENDING;
	239	return;
	240
	241	cs_failed:
fba395ee	242	cs_error(link, last_fn, last_ret);
1da177e4 LT	243	failed:
	244	parport_cs_release(link);
	245	link->state &= ~DEV_CONFIG_PENDING;
	246
	247	} /* parport_config */
	248
	249	/*======================================================================
	250
	251	After a card is removed, parport_cs_release() will unregister the
	252	device, and release the PCMCIA configuration. If the device is
	253	still open, this will be postponed until it is closed.
	254
	255	======================================================================*/
	256
fba395ee	257	void parport_cs_release(struct pcmcia_device *link)
1da177e4	258	{
5f2a71fc	259	parport_info_t *info = link->priv;
1da177e4	260
5f2a71fc DB	261	DEBUG(0, "parport_release(0x%p)\n", link);
	262
	263	if (info->ndev) {
	264	struct parport *p = info->port;
	265	parport_pc_unregister_port(p);
	266	}
	267	info->ndev = 0;
1da177e4	268
fba395ee	269	pcmcia_disable_device(link);
1da177e4 LT	270	} /* parport_cs_release */
1da177e4 LT	271
98e4c28b	272
476835af DB	273	static struct pcmcia_device_id parport_ids[] = {
	274	PCMCIA_DEVICE_FUNC_ID(3),
	275	PCMCIA_DEVICE_MANF_CARD(0x0137, 0x0003),
	276	PCMCIA_DEVICE_NULL
	277	};
	278	MODULE_DEVICE_TABLE(pcmcia, parport_ids);
	279
1da177e4 LT	280	static struct pcmcia_driver parport_cs_driver = {
	281	.owner = THIS_MODULE,
	282	.drv = {
	283	.name = "parport_cs",
	284	},
f8cfa618	285	.probe = parport_attach,
cc3b4866	286	.remove = parport_detach,
476835af	287	.id_table = parport_ids,
1da177e4 LT	288	};
	289
	290	static int __init init_parport_cs(void)
	291	{
	292	return pcmcia_register_driver(&parport_cs_driver);
	293	}
	294
	295	static void __exit exit_parport_cs(void)
	296	{
	297	pcmcia_unregister_driver(&parport_cs_driver);
1da177e4 LT	298	}
	299
	300	module_init(init_parport_cs);
	301	module_exit(exit_parport_cs);