5f87b9f7b6d256b555bfc7026503de9d543f3ec8
[linux-3.10.git] / drivers / char / pcmcia / ipwireless / main.c
1 /*
2  * IPWireless 3G PCMCIA Network Driver
3  *
4  * Original code
5  *   by Stephen Blackheath <stephen@blacksapphire.com>,
6  *      Ben Martel <benm@symmetric.co.nz>
7  *
8  * Copyrighted as follows:
9  *   Copyright (C) 2004 by Symmetric Systems Ltd (NZ)
10  *
11  * Various driver changes and rewrites, port to new kernels
12  *   Copyright (C) 2006-2007 Jiri Kosina
13  *
14  * Misc code cleanups and updates
15  *   Copyright (C) 2007 David Sterba
16  */
17
18 #include "hardware.h"
19 #include "network.h"
20 #include "main.h"
21 #include "tty.h"
22
23 #include <linux/delay.h>
24 #include <linux/init.h>
25 #include <linux/io.h>
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/sched.h>
29 #include <linux/slab.h>
30
31 #include <pcmcia/cisreg.h>
32 #include <pcmcia/device_id.h>
33 #include <pcmcia/ss.h>
34 #include <pcmcia/ds.h>
35 #include <pcmcia/cs.h>
36
37 static struct pcmcia_device_id ipw_ids[] = {
38         PCMCIA_DEVICE_MANF_CARD(0x02f2, 0x0100),
39         PCMCIA_DEVICE_MANF_CARD(0x02f2, 0x0200),
40         PCMCIA_DEVICE_NULL
41 };
42 MODULE_DEVICE_TABLE(pcmcia, ipw_ids);
43
44 static void ipwireless_detach(struct pcmcia_device *link);
45
46 /*
47  * Module params
48  */
49 /* Debug mode: more verbose, print sent/recv bytes */
50 int ipwireless_debug;
51 int ipwireless_loopback;
52 int ipwireless_out_queue = 10;
53
54 module_param_named(debug, ipwireless_debug, int, 0);
55 module_param_named(loopback, ipwireless_loopback, int, 0);
56 module_param_named(out_queue, ipwireless_out_queue, int, 0);
57 MODULE_PARM_DESC(debug, "switch on debug messages [0]");
58 MODULE_PARM_DESC(loopback,
59                 "debug: enable ras_raw channel [0]");
60 MODULE_PARM_DESC(out_queue, "debug: set size of outgoing PPP queue [10]");
61
62 /* Executes in process context. */
63 static void signalled_reboot_work(struct work_struct *work_reboot)
64 {
65         struct ipw_dev *ipw = container_of(work_reboot, struct ipw_dev,
66                         work_reboot);
67         struct pcmcia_device *link = ipw->link;
68         pcmcia_reset_card(link->socket);
69 }
70
71 static void signalled_reboot_callback(void *callback_data)
72 {
73         struct ipw_dev *ipw = (struct ipw_dev *) callback_data;
74
75         /* Delegate to process context. */
76         schedule_work(&ipw->work_reboot);
77 }
78
79 static int ipwireless_probe(struct pcmcia_device *p_dev,
80                             cistpl_cftable_entry_t *cfg,
81                             cistpl_cftable_entry_t *dflt,
82                             unsigned int vcc,
83                             void *priv_data)
84 {
85         struct ipw_dev *ipw = priv_data;
86         struct resource *io_resource;
87         memreq_t memreq_attr_memory;
88         memreq_t memreq_common_memory;
89         int ret;
90
91         p_dev->resource[0]->flags |= IO_DATA_PATH_WIDTH_AUTO;
92         p_dev->resource[0]->start = cfg->io.win[0].base;
93         p_dev->resource[0]->end = cfg->io.win[0].len;
94
95         /* 0x40 causes it to generate level mode interrupts. */
96         /* 0x04 enables IREQ pin. */
97         p_dev->conf.ConfigIndex = cfg->index | 0x44;
98         p_dev->io_lines = 16;
99         ret = pcmcia_request_io(p_dev);
100         if (ret)
101                 return ret;
102
103         io_resource = request_region(p_dev->resource[0]->start,
104                                 resource_size(p_dev->resource[0]),
105                                 IPWIRELESS_PCCARD_NAME);
106
107         if (cfg->mem.nwin == 0)
108                 return 0;
109
110         ipw->request_common_memory.Attributes =
111                 WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM | WIN_ENABLE;
112         ipw->request_common_memory.Base = cfg->mem.win[0].host_addr;
113         ipw->request_common_memory.Size = cfg->mem.win[0].len;
114         if (ipw->request_common_memory.Size < 0x1000)
115                 ipw->request_common_memory.Size = 0x1000;
116         ipw->request_common_memory.AccessSpeed = 0;
117
118         ret = pcmcia_request_window(p_dev, &ipw->request_common_memory,
119                                 &ipw->handle_common_memory);
120
121         if (ret != 0)
122                 goto exit1;
123
124         memreq_common_memory.CardOffset = cfg->mem.win[0].card_addr;
125         memreq_common_memory.Page = 0;
126
127         ret = pcmcia_map_mem_page(p_dev, ipw->handle_common_memory,
128                                 &memreq_common_memory);
129
130         if (ret != 0)
131                 goto exit2;
132
133         ipw->is_v2_card = cfg->mem.win[0].len == 0x100;
134
135         ipw->common_memory = ioremap(ipw->request_common_memory.Base,
136                                 ipw->request_common_memory.Size);
137         request_mem_region(ipw->request_common_memory.Base,
138                         ipw->request_common_memory.Size,
139                         IPWIRELESS_PCCARD_NAME);
140
141         ipw->request_attr_memory.Attributes =
142                 WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_AM | WIN_ENABLE;
143         ipw->request_attr_memory.Base = 0;
144         ipw->request_attr_memory.Size = 0;      /* this used to be 0x1000 */
145         ipw->request_attr_memory.AccessSpeed = 0;
146
147         ret = pcmcia_request_window(p_dev, &ipw->request_attr_memory,
148                                 &ipw->handle_attr_memory);
149
150         if (ret != 0)
151                 goto exit2;
152
153         memreq_attr_memory.CardOffset = 0;
154         memreq_attr_memory.Page = 0;
155
156         ret = pcmcia_map_mem_page(p_dev, ipw->handle_attr_memory,
157                                 &memreq_attr_memory);
158
159         if (ret != 0)
160                 goto exit3;
161
162         ipw->attr_memory = ioremap(ipw->request_attr_memory.Base,
163                                 ipw->request_attr_memory.Size);
164         request_mem_region(ipw->request_attr_memory.Base,
165                         ipw->request_attr_memory.Size, IPWIRELESS_PCCARD_NAME);
166
167         return 0;
168
169 exit3:
170         pcmcia_release_window(p_dev, ipw->handle_attr_memory);
171 exit2:
172         if (ipw->common_memory) {
173                 release_mem_region(ipw->request_common_memory.Base,
174                                 ipw->request_common_memory.Size);
175                 iounmap(ipw->common_memory);
176                 pcmcia_release_window(p_dev, ipw->handle_common_memory);
177         } else
178                 pcmcia_release_window(p_dev, ipw->handle_common_memory);
179 exit1:
180         release_resource(io_resource);
181         pcmcia_disable_device(p_dev);
182         return -1;
183 }
184
185 static int config_ipwireless(struct ipw_dev *ipw)
186 {
187         struct pcmcia_device *link = ipw->link;
188         int ret = 0;
189
190         ipw->is_v2_card = 0;
191
192         ret = pcmcia_loop_config(link, ipwireless_probe, ipw);
193         if (ret != 0)
194                 return ret;
195
196         link->conf.Attributes = CONF_ENABLE_IRQ;
197         link->conf.IntType = INT_MEMORY_AND_IO;
198
199         INIT_WORK(&ipw->work_reboot, signalled_reboot_work);
200
201         ipwireless_init_hardware_v1(ipw->hardware, link->resource[0]->start,
202                                     ipw->attr_memory, ipw->common_memory,
203                                     ipw->is_v2_card, signalled_reboot_callback,
204                                     ipw);
205
206         ret = pcmcia_request_irq(link, ipwireless_interrupt);
207         if (ret != 0)
208                 goto exit;
209
210         printk(KERN_INFO IPWIRELESS_PCCARD_NAME ": Card type %s\n",
211                         ipw->is_v2_card ? "V2/V3" : "V1");
212         printk(KERN_INFO IPWIRELESS_PCCARD_NAME
213                 ": I/O ports %pR, irq %d\n", link->resource[0],
214                         (unsigned int) link->irq);
215         if (ipw->attr_memory && ipw->common_memory)
216                 printk(KERN_INFO IPWIRELESS_PCCARD_NAME
217                         ": attr memory 0x%08lx-0x%08lx, common memory 0x%08lx-0x%08lx\n",
218                         ipw->request_attr_memory.Base,
219                         ipw->request_attr_memory.Base
220                         + ipw->request_attr_memory.Size - 1,
221                         ipw->request_common_memory.Base,
222                         ipw->request_common_memory.Base
223                         + ipw->request_common_memory.Size - 1);
224
225         ipw->network = ipwireless_network_create(ipw->hardware);
226         if (!ipw->network)
227                 goto exit;
228
229         ipw->tty = ipwireless_tty_create(ipw->hardware, ipw->network);
230         if (!ipw->tty)
231                 goto exit;
232
233         ipwireless_init_hardware_v2_v3(ipw->hardware);
234
235         /*
236          * Do the RequestConfiguration last, because it enables interrupts.
237          * Then we don't get any interrupts before we're ready for them.
238          */
239         ret = pcmcia_request_configuration(link, &link->conf);
240
241         if (ret != 0)
242                 goto exit;
243
244         return 0;
245
246 exit:
247         if (ipw->attr_memory) {
248                 release_mem_region(ipw->request_attr_memory.Base,
249                                 ipw->request_attr_memory.Size);
250                 iounmap(ipw->attr_memory);
251                 pcmcia_release_window(link, ipw->handle_attr_memory);
252         }
253         if (ipw->common_memory) {
254                 release_mem_region(ipw->request_common_memory.Base,
255                                 ipw->request_common_memory.Size);
256                 iounmap(ipw->common_memory);
257                 pcmcia_release_window(link, ipw->handle_common_memory);
258         }
259         pcmcia_disable_device(link);
260         return -1;
261 }
262
263 static void release_ipwireless(struct ipw_dev *ipw)
264 {
265         if (ipw->common_memory) {
266                 release_mem_region(ipw->request_common_memory.Base,
267                                 ipw->request_common_memory.Size);
268                 iounmap(ipw->common_memory);
269         }
270         if (ipw->attr_memory) {
271                 release_mem_region(ipw->request_attr_memory.Base,
272                                 ipw->request_attr_memory.Size);
273                 iounmap(ipw->attr_memory);
274         }
275         if (ipw->common_memory)
276                 pcmcia_release_window(ipw->link, ipw->handle_common_memory);
277         if (ipw->attr_memory)
278                 pcmcia_release_window(ipw->link, ipw->handle_attr_memory);
279
280         pcmcia_disable_device(ipw->link);
281 }
282
283 /*
284  * ipwireless_attach() creates an "instance" of the driver, allocating
285  * local data structures for one device (one interface).  The device
286  * is registered with Card Services.
287  *
288  * The pcmcia_device structure is initialized, but we don't actually
289  * configure the card at this point -- we wait until we receive a
290  * card insertion event.
291  */
292 static int ipwireless_attach(struct pcmcia_device *link)
293 {
294         struct ipw_dev *ipw;
295         int ret;
296
297         ipw = kzalloc(sizeof(struct ipw_dev), GFP_KERNEL);
298         if (!ipw)
299                 return -ENOMEM;
300
301         ipw->link = link;
302         link->priv = ipw;
303
304         ipw->hardware = ipwireless_hardware_create();
305         if (!ipw->hardware) {
306                 kfree(ipw);
307                 return -ENOMEM;
308         }
309         /* RegisterClient will call config_ipwireless */
310
311         ret = config_ipwireless(ipw);
312
313         if (ret != 0) {
314                 ipwireless_detach(link);
315                 return ret;
316         }
317
318         return 0;
319 }
320
321 /*
322  * This deletes a driver "instance".  The device is de-registered with
323  * Card Services.  If it has been released, all local data structures
324  * are freed.  Otherwise, the structures will be freed when the device
325  * is released.
326  */
327 static void ipwireless_detach(struct pcmcia_device *link)
328 {
329         struct ipw_dev *ipw = link->priv;
330
331         release_ipwireless(ipw);
332
333         if (ipw->tty != NULL)
334                 ipwireless_tty_free(ipw->tty);
335         if (ipw->network != NULL)
336                 ipwireless_network_free(ipw->network);
337         if (ipw->hardware != NULL)
338                 ipwireless_hardware_free(ipw->hardware);
339         kfree(ipw);
340 }
341
342 static struct pcmcia_driver me = {
343         .owner          = THIS_MODULE,
344         .probe          = ipwireless_attach,
345         .remove         = ipwireless_detach,
346         .drv = { .name  = IPWIRELESS_PCCARD_NAME },
347         .id_table       = ipw_ids
348 };
349
350 /*
351  * Module insertion : initialisation of the module.
352  * Register the card with cardmgr...
353  */
354 static int __init init_ipwireless(void)
355 {
356         int ret;
357
358         printk(KERN_INFO IPWIRELESS_PCCARD_NAME " "
359                IPWIRELESS_PCMCIA_VERSION " by " IPWIRELESS_PCMCIA_AUTHOR "\n");
360
361         ret = ipwireless_tty_init();
362         if (ret != 0)
363                 return ret;
364
365         ret = pcmcia_register_driver(&me);
366         if (ret != 0)
367                 ipwireless_tty_release();
368
369         return ret;
370 }
371
372 /*
373  * Module removal
374  */
375 static void __exit exit_ipwireless(void)
376 {
377         printk(KERN_INFO IPWIRELESS_PCCARD_NAME " "
378                         IPWIRELESS_PCMCIA_VERSION " removed\n");
379
380         pcmcia_unregister_driver(&me);
381         ipwireless_tty_release();
382 }
383
384 module_init(init_ipwireless);
385 module_exit(exit_ipwireless);
386
387 MODULE_AUTHOR(IPWIRELESS_PCMCIA_AUTHOR);
388 MODULE_DESCRIPTION(IPWIRELESS_PCCARD_NAME " " IPWIRELESS_PCMCIA_VERSION);
389 MODULE_LICENSE("GPL");