8d60146c7213f671c8b1f9d4baf45f70ca014995
[linux-3.10.git] / drivers / parport / parport_cs.c
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
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 {
84     dev_link_t          link;
85     int                 ndev;
86     dev_node_t          node;
87     struct parport      *port;
88 } parport_info_t;
89
90 static void parport_detach(struct pcmcia_device *p_dev);
91 static void parport_config(dev_link_t *link);
92 static void parport_cs_release(dev_link_t *);
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
102 static int parport_attach(struct pcmcia_device *p_dev)
103 {
104     parport_info_t *info;
105     dev_link_t *link;
106
107     DEBUG(0, "parport_attach()\n");
108
109     /* Create new parport device */
110     info = kmalloc(sizeof(*info), GFP_KERNEL);
111     if (!info) return -ENOMEM;
112     memset(info, 0, sizeof(*info));
113     link = &info->link; link->priv = info;
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;
120     link->conf.IntType = INT_MEMORY_AND_IO;
121
122     link->handle = p_dev;
123     p_dev->instance = link;
124
125     link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
126     parport_config(link);
127
128     return 0;
129 } /* parport_attach */
130
131 /*======================================================================
132
133     This deletes a driver "instance".  The device is de-registered
134     with Card Services.  If it has been released, all local data
135     structures are freed.  Otherwise, the structures will be freed
136     when the device is released.
137
138 ======================================================================*/
139
140 static void parport_detach(struct pcmcia_device *p_dev)
141 {
142     dev_link_t *link = dev_to_instance(p_dev);
143
144     DEBUG(0, "parport_detach(0x%p)\n", link);
145
146     if (link->state & DEV_CONFIG)
147         parport_cs_release(link);
148
149     kfree(link->priv);
150 } /* parport_detach */
151
152 /*======================================================================
153
154     parport_config() is scheduled to run after a CARD_INSERTION event
155     is received, to configure the PCMCIA socket, and to make the
156     parport device available to the system.
157
158 ======================================================================*/
159
160 #define CS_CHECK(fn, ret) \
161 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
162
163 void parport_config(dev_link_t *link)
164 {
165     client_handle_t handle = link->handle;
166     parport_info_t *info = link->priv;
167     tuple_t tuple;
168     u_short buf[128];
169     cisparse_t parse;
170     cistpl_cftable_entry_t *cfg = &parse.cftable_entry;
171     cistpl_cftable_entry_t dflt = { 0 };
172     struct parport *p;
173     int last_ret, last_fn;
174     
175     DEBUG(0, "parport_config(0x%p)\n", link);
176     
177     tuple.TupleData = (cisdata_t *)buf;
178     tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
179     tuple.Attributes = 0;
180     tuple.DesiredTuple = CISTPL_CONFIG;
181     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
182     CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
183     CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
184     link->conf.ConfigBase = parse.config.base;
185     link->conf.Present = parse.config.rmask[0];
186     
187     /* Configure card */
188     link->state |= DEV_CONFIG;
189
190     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
191     tuple.Attributes = 0;
192     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
193     while (1) {
194         if (pcmcia_get_tuple_data(handle, &tuple) != 0 ||
195                 pcmcia_parse_tuple(handle, &tuple, &parse) != 0)
196             goto next_entry;
197
198         if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
199             cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
200             link->conf.ConfigIndex = cfg->index;
201             if (epp_mode)
202                 link->conf.ConfigIndex |= FORCE_EPP_MODE;
203             link->io.BasePort1 = io->win[0].base;
204             link->io.NumPorts1 = io->win[0].len;
205             link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
206             if (io->nwin == 2) {
207                 link->io.BasePort2 = io->win[1].base;
208                 link->io.NumPorts2 = io->win[1].len;
209             }
210             if (pcmcia_request_io(link->handle, &link->io) != 0)
211                 goto next_entry;
212             /* If we've got this far, we're done */
213             break;
214         }
215         
216     next_entry:
217         if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
218         CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
219     }
220     
221     CS_CHECK(RequestIRQ, pcmcia_request_irq(handle, &link->irq));
222     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(handle, &link->conf));
223
224     p = parport_pc_probe_port(link->io.BasePort1, link->io.BasePort2,
225                               link->irq.AssignedIRQ, PARPORT_DMA_NONE,
226                               NULL);
227     if (p == NULL) {
228         printk(KERN_NOTICE "parport_cs: parport_pc_probe_port() at "
229                "0x%3x, irq %u failed\n", link->io.BasePort1,
230                link->irq.AssignedIRQ);
231         goto failed;
232     }
233
234     p->modes |= PARPORT_MODE_PCSPP;
235     if (epp_mode)
236         p->modes |= PARPORT_MODE_TRISTATE | PARPORT_MODE_EPP;
237     info->ndev = 1;
238     info->node.major = LP_MAJOR;
239     info->node.minor = p->number;
240     info->port = p;
241     strcpy(info->node.dev_name, p->name);
242     link->dev = &info->node;
243
244     link->state &= ~DEV_CONFIG_PENDING;
245     return;
246     
247 cs_failed:
248     cs_error(link->handle, last_fn, last_ret);
249 failed:
250     parport_cs_release(link);
251     link->state &= ~DEV_CONFIG_PENDING;
252
253 } /* parport_config */
254
255 /*======================================================================
256
257     After a card is removed, parport_cs_release() will unregister the
258     device, and release the PCMCIA configuration.  If the device is
259     still open, this will be postponed until it is closed.
260     
261 ======================================================================*/
262
263 void parport_cs_release(dev_link_t *link)
264 {
265         parport_info_t *info = link->priv;
266
267         DEBUG(0, "parport_release(0x%p)\n", link);
268
269         if (info->ndev) {
270                 struct parport *p = info->port;
271                 parport_pc_unregister_port(p);
272         }
273         info->ndev = 0;
274
275         pcmcia_disable_device(link->handle);
276 } /* parport_cs_release */
277
278
279 static struct pcmcia_device_id parport_ids[] = {
280         PCMCIA_DEVICE_FUNC_ID(3),
281         PCMCIA_DEVICE_MANF_CARD(0x0137, 0x0003),
282         PCMCIA_DEVICE_NULL
283 };
284 MODULE_DEVICE_TABLE(pcmcia, parport_ids);
285
286 static struct pcmcia_driver parport_cs_driver = {
287         .owner          = THIS_MODULE,
288         .drv            = {
289                 .name   = "parport_cs",
290         },
291         .probe          = parport_attach,
292         .remove         = parport_detach,
293         .id_table       = parport_ids,
294 };
295
296 static int __init init_parport_cs(void)
297 {
298         return pcmcia_register_driver(&parport_cs_driver);
299 }
300
301 static void __exit exit_parport_cs(void)
302 {
303         pcmcia_unregister_driver(&parport_cs_driver);
304 }
305
306 module_init(init_parport_cs);
307 module_exit(exit_parport_cs);