GNU Linux-libre 4.9.309-gnu1
[releases.git] / drivers / net / wireless / intersil / p54 / p54usb.c
1
2 /*
3  * Linux device driver for USB based Prism54
4  *
5  * Copyright (c) 2006, Michael Wu <flamingice@sourmilk.net>
6  *
7  * Based on the islsm (softmac prism54) driver, which is:
8  * Copyright 2004-2006 Jean-Baptiste Note <jbnote@gmail.com>, et al.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  */
14
15 #include <linux/usb.h>
16 #include <linux/pci.h>
17 #include <linux/slab.h>
18 #include <linux/firmware.h>
19 #include <linux/etherdevice.h>
20 #include <linux/delay.h>
21 #include <linux/crc32.h>
22 #include <linux/module.h>
23 #include <net/mac80211.h>
24
25 #include "p54.h"
26 #include "lmac.h"
27 #include "p54usb.h"
28
29 MODULE_AUTHOR("Michael Wu <flamingice@sourmilk.net>");
30 MODULE_DESCRIPTION("Prism54 USB wireless driver");
31 MODULE_LICENSE("GPL");
32 MODULE_ALIAS("prism54usb");
33 /*(DEBLOBBED)*/
34
35 static struct usb_driver p54u_driver;
36
37 /*
38  * Note:
39  *
40  * Always update our wiki's device list (located at:
41  * http://wireless.kernel.org/en/users/Drivers/p54/devices ),
42  * whenever you add a new device.
43  */
44
45 static struct usb_device_id p54u_table[] = {
46         /* Version 1 devices (pci chip + net2280) */
47         {USB_DEVICE(0x0411, 0x0050)},   /* Buffalo WLI2-USB2-G54 */
48         {USB_DEVICE(0x045e, 0x00c2)},   /* Microsoft MN-710 */
49         {USB_DEVICE(0x0506, 0x0a11)},   /* 3COM 3CRWE254G72 */
50         {USB_DEVICE(0x0675, 0x0530)},   /* DrayTek Vigor 530 */
51         {USB_DEVICE(0x06b9, 0x0120)},   /* Thomson SpeedTouch 120g */
52         {USB_DEVICE(0x0707, 0xee06)},   /* SMC 2862W-G */
53         {USB_DEVICE(0x07aa, 0x001c)},   /* Corega CG-WLUSB2GT */
54         {USB_DEVICE(0x083a, 0x4501)},   /* Accton 802.11g WN4501 USB */
55         {USB_DEVICE(0x083a, 0x4502)},   /* Siemens Gigaset USB Adapter */
56         {USB_DEVICE(0x083a, 0x5501)},   /* Phillips CPWUA054 */
57         {USB_DEVICE(0x0846, 0x4200)},   /* Netgear WG121 */
58         {USB_DEVICE(0x0846, 0x4210)},   /* Netgear WG121 the second ? */
59         {USB_DEVICE(0x0846, 0x4220)},   /* Netgear WG111 */
60         {USB_DEVICE(0x09aa, 0x1000)},   /* Spinnaker Proto board */
61         {USB_DEVICE(0x0bf8, 0x1007)},   /* Fujitsu E-5400 USB */
62         {USB_DEVICE(0x0cde, 0x0006)},   /* Medion 40900, Roper Europe */
63         {USB_DEVICE(0x0db0, 0x6826)},   /* MSI UB54G (MS-6826) */
64         {USB_DEVICE(0x107b, 0x55f2)},   /* Gateway WGU-210 (Gemtek) */
65         {USB_DEVICE(0x124a, 0x4023)},   /* Shuttle PN15, Airvast WM168g, IOGear GWU513 */
66         {USB_DEVICE(0x124a, 0x4026)},   /* AirVasT USB wireless device */
67         {USB_DEVICE(0x1435, 0x0210)},   /* Inventel UR054G */
68         {USB_DEVICE(0x15a9, 0x0002)},   /* Gemtek WUBI-100GW 802.11g */
69         {USB_DEVICE(0x1630, 0x0005)},   /* 2Wire 802.11g USB (v1) / Z-Com */
70         {USB_DEVICE(0x182d, 0x096b)},   /* Sitecom WL-107 */
71         {USB_DEVICE(0x1915, 0x2234)},   /* Linksys WUSB54G OEM */
72         {USB_DEVICE(0x1915, 0x2235)},   /* Linksys WUSB54G Portable OEM */
73         {USB_DEVICE(0x2001, 0x3701)},   /* DLink DWL-G120 Spinnaker */
74         {USB_DEVICE(0x2001, 0x3703)},   /* DLink DWL-G122 */
75         {USB_DEVICE(0x2001, 0x3762)},   /* Conceptronic C54U */
76         {USB_DEVICE(0x5041, 0x2234)},   /* Linksys WUSB54G */
77         {USB_DEVICE(0x5041, 0x2235)},   /* Linksys WUSB54G Portable */
78
79         /* Version 2 devices (3887) */
80         {USB_DEVICE(0x0471, 0x1230)},   /* Philips CPWUA054/00 */
81         {USB_DEVICE(0x050d, 0x7050)},   /* Belkin F5D7050 ver 1000 */
82         {USB_DEVICE(0x0572, 0x2000)},   /* Cohiba Proto board */
83         {USB_DEVICE(0x0572, 0x2002)},   /* Cohiba Proto board */
84         {USB_DEVICE(0x06a9, 0x000e)},   /* Westell 802.11g USB (A90-211WG-01) */
85         {USB_DEVICE(0x06b9, 0x0121)},   /* Thomson SpeedTouch 121g */
86         {USB_DEVICE(0x0707, 0xee13)},   /* SMC 2862W-G version 2 */
87         {USB_DEVICE(0x07aa, 0x0020)},   /* Corega WLUSB2GTST USB */
88         {USB_DEVICE(0x0803, 0x4310)},   /* Zoom 4410a */
89         {USB_DEVICE(0x083a, 0x4521)},   /* Siemens Gigaset USB Adapter 54 version 2 */
90         {USB_DEVICE(0x083a, 0x4531)},   /* T-Com Sinus 154 data II */
91         {USB_DEVICE(0x083a, 0xc501)},   /* Zoom Wireless-G 4410 */
92         {USB_DEVICE(0x083a, 0xf503)},   /* Accton FD7050E ver 1010ec  */
93         {USB_DEVICE(0x0846, 0x4240)},   /* Netgear WG111 (v2) */
94         {USB_DEVICE(0x0915, 0x2000)},   /* Cohiba Proto board */
95         {USB_DEVICE(0x0915, 0x2002)},   /* Cohiba Proto board */
96         {USB_DEVICE(0x0baf, 0x0118)},   /* U.S. Robotics U5 802.11g Adapter*/
97         {USB_DEVICE(0x0bf8, 0x1009)},   /* FUJITSU E-5400 USB D1700*/
98         /* {USB_DEVICE(0x0cde, 0x0006)}, * Medion MD40900 already listed above,
99                                          * just noting it here for clarity */
100         {USB_DEVICE(0x0cde, 0x0008)},   /* Sagem XG703A */
101         {USB_DEVICE(0x0cde, 0x0015)},   /* Zcomax XG-705A */
102         {USB_DEVICE(0x0d8e, 0x3762)},   /* DLink DWL-G120 Cohiba */
103         {USB_DEVICE(0x124a, 0x4025)},   /* IOGear GWU513 (GW3887IK chip) */
104         {USB_DEVICE(0x1260, 0xee22)},   /* SMC 2862W-G version 2 */
105         {USB_DEVICE(0x13b1, 0x000a)},   /* Linksys WUSB54G ver 2 */
106         {USB_DEVICE(0x13B1, 0x000C)},   /* Linksys WUSB54AG */
107         {USB_DEVICE(0x1413, 0x5400)},   /* Telsey 802.11g USB2.0 Adapter */
108         {USB_DEVICE(0x1435, 0x0427)},   /* Inventel UR054G */
109         /* {USB_DEVICE(0x15a9, 0x0002)}, * Also SparkLAN WL-682 with 3887 */
110         {USB_DEVICE(0x1668, 0x1050)},   /* Actiontec 802UIG-1 */
111         {USB_DEVICE(0x1740, 0x1000)},   /* Senao NUB-350 */
112         {USB_DEVICE(0x2001, 0x3704)},   /* DLink DWL-G122 rev A2 */
113         {USB_DEVICE(0x2001, 0x3705)},   /* D-Link DWL-G120 rev C1 */
114         {USB_DEVICE(0x413c, 0x5513)},   /* Dell WLA3310 USB Wireless Adapter */
115         {USB_DEVICE(0x413c, 0x8102)},   /* Spinnaker DUT */
116         {USB_DEVICE(0x413c, 0x8104)},   /* Cohiba Proto board */
117         {}
118 };
119
120 MODULE_DEVICE_TABLE(usb, p54u_table);
121
122 static const struct {
123         u32 intf;
124         enum p54u_hw_type type;
125         const char *fw;
126         char hw[20];
127 } p54u_fwlist[__NUM_P54U_HWTYPES] = {
128         {
129                 .type = P54U_NET2280,
130                 .intf = FW_LM86,
131                 .fw = "/*(DEBLOBBED)*/",
132                 .hw = "ISL3886 + net2280",
133         },
134         {
135                 .type = P54U_3887,
136                 .intf = FW_LM87,
137                 .fw = "/*(DEBLOBBED)*/",
138                 .hw = "ISL3887",
139         },
140 };
141
142 static void p54u_rx_cb(struct urb *urb)
143 {
144         struct sk_buff *skb = (struct sk_buff *) urb->context;
145         struct p54u_rx_info *info = (struct p54u_rx_info *)skb->cb;
146         struct ieee80211_hw *dev = info->dev;
147         struct p54u_priv *priv = dev->priv;
148
149         skb_unlink(skb, &priv->rx_queue);
150
151         if (unlikely(urb->status)) {
152                 dev_kfree_skb_irq(skb);
153                 return;
154         }
155
156         skb_put(skb, urb->actual_length);
157
158         if (priv->hw_type == P54U_NET2280)
159                 skb_pull(skb, priv->common.tx_hdr_len);
160         if (priv->common.fw_interface == FW_LM87) {
161                 skb_pull(skb, 4);
162                 skb_put(skb, 4);
163         }
164
165         if (p54_rx(dev, skb)) {
166                 skb = dev_alloc_skb(priv->common.rx_mtu + 32);
167                 if (unlikely(!skb)) {
168                         /* TODO check rx queue length and refill *somewhere* */
169                         return;
170                 }
171
172                 info = (struct p54u_rx_info *) skb->cb;
173                 info->urb = urb;
174                 info->dev = dev;
175                 urb->transfer_buffer = skb_tail_pointer(skb);
176                 urb->context = skb;
177         } else {
178                 if (priv->hw_type == P54U_NET2280)
179                         skb_push(skb, priv->common.tx_hdr_len);
180                 if (priv->common.fw_interface == FW_LM87) {
181                         skb_push(skb, 4);
182                         skb_put(skb, 4);
183                 }
184                 skb_reset_tail_pointer(skb);
185                 skb_trim(skb, 0);
186                 urb->transfer_buffer = skb_tail_pointer(skb);
187         }
188         skb_queue_tail(&priv->rx_queue, skb);
189         usb_anchor_urb(urb, &priv->submitted);
190         if (usb_submit_urb(urb, GFP_ATOMIC)) {
191                 skb_unlink(skb, &priv->rx_queue);
192                 usb_unanchor_urb(urb);
193                 dev_kfree_skb_irq(skb);
194         }
195 }
196
197 static void p54u_tx_cb(struct urb *urb)
198 {
199         struct sk_buff *skb = urb->context;
200         struct ieee80211_hw *dev =
201                 usb_get_intfdata(usb_ifnum_to_if(urb->dev, 0));
202
203         p54_free_skb(dev, skb);
204 }
205
206 static void p54u_tx_dummy_cb(struct urb *urb) { }
207
208 static void p54u_free_urbs(struct ieee80211_hw *dev)
209 {
210         struct p54u_priv *priv = dev->priv;
211         usb_kill_anchored_urbs(&priv->submitted);
212 }
213
214 static void p54u_stop(struct ieee80211_hw *dev)
215 {
216         /*
217          * TODO: figure out how to reliably stop the 3887 and net2280 so
218          * the hardware is still usable next time we want to start it.
219          * until then, we just stop listening to the hardware..
220          */
221         p54u_free_urbs(dev);
222 }
223
224 static int p54u_init_urbs(struct ieee80211_hw *dev)
225 {
226         struct p54u_priv *priv = dev->priv;
227         struct urb *entry = NULL;
228         struct sk_buff *skb;
229         struct p54u_rx_info *info;
230         int ret = 0;
231
232         while (skb_queue_len(&priv->rx_queue) < 32) {
233                 skb = __dev_alloc_skb(priv->common.rx_mtu + 32, GFP_KERNEL);
234                 if (!skb) {
235                         ret = -ENOMEM;
236                         goto err;
237                 }
238                 entry = usb_alloc_urb(0, GFP_KERNEL);
239                 if (!entry) {
240                         ret = -ENOMEM;
241                         goto err;
242                 }
243
244                 usb_fill_bulk_urb(entry, priv->udev,
245                                   usb_rcvbulkpipe(priv->udev, P54U_PIPE_DATA),
246                                   skb_tail_pointer(skb),
247                                   priv->common.rx_mtu + 32, p54u_rx_cb, skb);
248                 info = (struct p54u_rx_info *) skb->cb;
249                 info->urb = entry;
250                 info->dev = dev;
251                 skb_queue_tail(&priv->rx_queue, skb);
252
253                 usb_anchor_urb(entry, &priv->submitted);
254                 ret = usb_submit_urb(entry, GFP_KERNEL);
255                 if (ret) {
256                         skb_unlink(skb, &priv->rx_queue);
257                         usb_unanchor_urb(entry);
258                         goto err;
259                 }
260                 usb_free_urb(entry);
261                 entry = NULL;
262         }
263
264         return 0;
265
266  err:
267         usb_free_urb(entry);
268         kfree_skb(skb);
269         p54u_free_urbs(dev);
270         return ret;
271 }
272
273 static int p54u_open(struct ieee80211_hw *dev)
274 {
275         /*
276          * TODO: Because we don't know how to reliably stop the 3887 and
277          * the isl3886+net2280, other than brutally cut off all
278          * communications. We have to reinitialize the urbs on every start.
279          */
280         return p54u_init_urbs(dev);
281 }
282
283 static __le32 p54u_lm87_chksum(const __le32 *data, size_t length)
284 {
285         u32 chk = 0;
286
287         length >>= 2;
288         while (length--) {
289                 chk ^= le32_to_cpu(*data++);
290                 chk = (chk >> 5) ^ (chk << 3);
291         }
292
293         return cpu_to_le32(chk);
294 }
295
296 static void p54u_tx_lm87(struct ieee80211_hw *dev, struct sk_buff *skb)
297 {
298         struct p54u_priv *priv = dev->priv;
299         struct urb *data_urb;
300         struct lm87_tx_hdr *hdr = (void *)skb->data - sizeof(*hdr);
301
302         data_urb = usb_alloc_urb(0, GFP_ATOMIC);
303         if (!data_urb) {
304                 p54_free_skb(dev, skb);
305                 return;
306         }
307
308         hdr->chksum = p54u_lm87_chksum((__le32 *)skb->data, skb->len);
309         hdr->device_addr = ((struct p54_hdr *)skb->data)->req_id;
310
311         usb_fill_bulk_urb(data_urb, priv->udev,
312                           usb_sndbulkpipe(priv->udev, P54U_PIPE_DATA),
313                           hdr, skb->len + sizeof(*hdr),  FREE_AFTER_TX(skb) ?
314                           p54u_tx_cb : p54u_tx_dummy_cb, skb);
315         data_urb->transfer_flags |= URB_ZERO_PACKET;
316
317         usb_anchor_urb(data_urb, &priv->submitted);
318         if (usb_submit_urb(data_urb, GFP_ATOMIC)) {
319                 usb_unanchor_urb(data_urb);
320                 p54_free_skb(dev, skb);
321         }
322         usb_free_urb(data_urb);
323 }
324
325 static void p54u_tx_net2280(struct ieee80211_hw *dev, struct sk_buff *skb)
326 {
327         struct p54u_priv *priv = dev->priv;
328         struct urb *int_urb = NULL, *data_urb = NULL;
329         struct net2280_tx_hdr *hdr = (void *)skb->data - sizeof(*hdr);
330         struct net2280_reg_write *reg = NULL;
331         int err = -ENOMEM;
332
333         reg = kmalloc(sizeof(*reg), GFP_ATOMIC);
334         if (!reg)
335                 goto out;
336
337         int_urb = usb_alloc_urb(0, GFP_ATOMIC);
338         if (!int_urb)
339                 goto out;
340
341         data_urb = usb_alloc_urb(0, GFP_ATOMIC);
342         if (!data_urb)
343                 goto out;
344
345         reg->port = cpu_to_le16(NET2280_DEV_U32);
346         reg->addr = cpu_to_le32(P54U_DEV_BASE);
347         reg->val = cpu_to_le32(ISL38XX_DEV_INT_DATA);
348
349         memset(hdr, 0, sizeof(*hdr));
350         hdr->len = cpu_to_le16(skb->len);
351         hdr->device_addr = ((struct p54_hdr *) skb->data)->req_id;
352
353         usb_fill_bulk_urb(int_urb, priv->udev,
354                 usb_sndbulkpipe(priv->udev, P54U_PIPE_DEV), reg, sizeof(*reg),
355                 p54u_tx_dummy_cb, dev);
356
357         /*
358          * URB_FREE_BUFFER triggers a code path in the USB subsystem that will
359          * free what is inside the transfer_buffer after the last reference to
360          * the int_urb is dropped.
361          */
362         int_urb->transfer_flags |= URB_FREE_BUFFER | URB_ZERO_PACKET;
363         reg = NULL;
364
365         usb_fill_bulk_urb(data_urb, priv->udev,
366                           usb_sndbulkpipe(priv->udev, P54U_PIPE_DATA),
367                           hdr, skb->len + sizeof(*hdr), FREE_AFTER_TX(skb) ?
368                           p54u_tx_cb : p54u_tx_dummy_cb, skb);
369         data_urb->transfer_flags |= URB_ZERO_PACKET;
370
371         usb_anchor_urb(int_urb, &priv->submitted);
372         err = usb_submit_urb(int_urb, GFP_ATOMIC);
373         if (err) {
374                 usb_unanchor_urb(int_urb);
375                 goto out;
376         }
377
378         usb_anchor_urb(data_urb, &priv->submitted);
379         err = usb_submit_urb(data_urb, GFP_ATOMIC);
380         if (err) {
381                 usb_unanchor_urb(data_urb);
382                 goto out;
383         }
384 out:
385         usb_free_urb(int_urb);
386         usb_free_urb(data_urb);
387
388         if (err) {
389                 kfree(reg);
390                 p54_free_skb(dev, skb);
391         }
392 }
393
394 static int p54u_write(struct p54u_priv *priv,
395                       struct net2280_reg_write *buf,
396                       enum net2280_op_type type,
397                       __le32 addr, __le32 val)
398 {
399         unsigned int ep;
400         int alen;
401
402         if (type & 0x0800)
403                 ep = usb_sndbulkpipe(priv->udev, P54U_PIPE_DEV);
404         else
405                 ep = usb_sndbulkpipe(priv->udev, P54U_PIPE_BRG);
406
407         buf->port = cpu_to_le16(type);
408         buf->addr = addr;
409         buf->val = val;
410
411         return usb_bulk_msg(priv->udev, ep, buf, sizeof(*buf), &alen, 1000);
412 }
413
414 static int p54u_read(struct p54u_priv *priv, void *buf,
415                      enum net2280_op_type type,
416                      __le32 addr, __le32 *val)
417 {
418         struct net2280_reg_read *read = buf;
419         __le32 *reg = buf;
420         unsigned int ep;
421         int alen, err;
422
423         if (type & 0x0800)
424                 ep = P54U_PIPE_DEV;
425         else
426                 ep = P54U_PIPE_BRG;
427
428         read->port = cpu_to_le16(type);
429         read->addr = addr;
430
431         err = usb_bulk_msg(priv->udev, usb_sndbulkpipe(priv->udev, ep),
432                            read, sizeof(*read), &alen, 1000);
433         if (err)
434                 return err;
435
436         err = usb_bulk_msg(priv->udev, usb_rcvbulkpipe(priv->udev, ep),
437                            reg, sizeof(*reg), &alen, 1000);
438         if (err)
439                 return err;
440
441         *val = *reg;
442         return 0;
443 }
444
445 static int p54u_bulk_msg(struct p54u_priv *priv, unsigned int ep,
446                          void *data, size_t len)
447 {
448         int alen;
449         return usb_bulk_msg(priv->udev, usb_sndbulkpipe(priv->udev, ep),
450                             data, len, &alen, 2000);
451 }
452
453 static int p54u_device_reset(struct ieee80211_hw *dev)
454 {
455         struct p54u_priv *priv = dev->priv;
456         int ret, lock = (priv->intf->condition != USB_INTERFACE_BINDING);
457
458         if (lock) {
459                 ret = usb_lock_device_for_reset(priv->udev, priv->intf);
460                 if (ret < 0) {
461                         dev_err(&priv->udev->dev, "(p54usb) unable to lock "
462                                 "device for reset (%d)!\n", ret);
463                         return ret;
464                 }
465         }
466
467         ret = usb_reset_device(priv->udev);
468         if (lock)
469                 usb_unlock_device(priv->udev);
470
471         if (ret)
472                 dev_err(&priv->udev->dev, "(p54usb) unable to reset "
473                         "device (%d)!\n", ret);
474
475         return ret;
476 }
477
478 static const char p54u_romboot_3887[] = "~~~~";
479 static int p54u_firmware_reset_3887(struct ieee80211_hw *dev)
480 {
481         struct p54u_priv *priv = dev->priv;
482         u8 *buf;
483         int ret;
484
485         buf = kmemdup(p54u_romboot_3887, 4, GFP_KERNEL);
486         if (!buf)
487                 return -ENOMEM;
488         ret = p54u_bulk_msg(priv, P54U_PIPE_DATA,
489                             buf, 4);
490         kfree(buf);
491         if (ret)
492                 dev_err(&priv->udev->dev, "(p54usb) unable to jump to "
493                         "boot ROM (%d)!\n", ret);
494
495         return ret;
496 }
497
498 static const char p54u_firmware_upload_3887[] = "<\r";
499 static int p54u_upload_firmware_3887(struct ieee80211_hw *dev)
500 {
501         struct p54u_priv *priv = dev->priv;
502         int err, alen;
503         u8 carry = 0;
504         u8 *buf, *tmp;
505         const u8 *data;
506         unsigned int left, remains, block_size;
507         struct x2_header *hdr;
508         unsigned long timeout;
509
510         err = p54u_firmware_reset_3887(dev);
511         if (err)
512                 return err;
513
514         tmp = buf = kmalloc(P54U_FW_BLOCK, GFP_KERNEL);
515         if (!buf)
516                 return -ENOMEM;
517
518         left = block_size = min_t(size_t, P54U_FW_BLOCK, priv->fw->size);
519         strcpy(buf, p54u_firmware_upload_3887);
520         left -= strlen(p54u_firmware_upload_3887);
521         tmp += strlen(p54u_firmware_upload_3887);
522
523         data = priv->fw->data;
524         remains = priv->fw->size;
525
526         hdr = (struct x2_header *)(buf + strlen(p54u_firmware_upload_3887));
527         memcpy(hdr->signature, X2_SIGNATURE, X2_SIGNATURE_SIZE);
528         hdr->fw_load_addr = cpu_to_le32(ISL38XX_DEV_FIRMWARE_ADDR);
529         hdr->fw_length = cpu_to_le32(priv->fw->size);
530         hdr->crc = cpu_to_le32(~crc32_le(~0, (void *)&hdr->fw_load_addr,
531                                          sizeof(u32)*2));
532         left -= sizeof(*hdr);
533         tmp += sizeof(*hdr);
534
535         while (remains) {
536                 while (left--) {
537                         if (carry) {
538                                 *tmp++ = carry;
539                                 carry = 0;
540                                 remains--;
541                                 continue;
542                         }
543                         switch (*data) {
544                         case '~':
545                                 *tmp++ = '}';
546                                 carry = '^';
547                                 break;
548                         case '}':
549                                 *tmp++ = '}';
550                                 carry = ']';
551                                 break;
552                         default:
553                                 *tmp++ = *data;
554                                 remains--;
555                                 break;
556                         }
557                         data++;
558                 }
559
560                 err = p54u_bulk_msg(priv, P54U_PIPE_DATA, buf, block_size);
561                 if (err) {
562                         dev_err(&priv->udev->dev, "(p54usb) firmware "
563                                                   "upload failed!\n");
564                         goto err_upload_failed;
565                 }
566
567                 tmp = buf;
568                 left = block_size = min((unsigned int)P54U_FW_BLOCK, remains);
569         }
570
571         *((__le32 *)buf) = cpu_to_le32(~crc32_le(~0, priv->fw->data,
572                                                  priv->fw->size));
573         err = p54u_bulk_msg(priv, P54U_PIPE_DATA, buf, sizeof(u32));
574         if (err) {
575                 dev_err(&priv->udev->dev, "(p54usb) firmware upload failed!\n");
576                 goto err_upload_failed;
577         }
578         timeout = jiffies + msecs_to_jiffies(1000);
579         while (!(err = usb_bulk_msg(priv->udev,
580                 usb_rcvbulkpipe(priv->udev, P54U_PIPE_DATA), buf, 128, &alen, 1000))) {
581                 if (alen > 2 && !memcmp(buf, "OK", 2))
582                         break;
583
584                 if (alen > 5 && !memcmp(buf, "ERROR", 5)) {
585                         err = -EINVAL;
586                         break;
587                 }
588
589                 if (time_after(jiffies, timeout)) {
590                         dev_err(&priv->udev->dev, "(p54usb) firmware boot "
591                                                   "timed out!\n");
592                         err = -ETIMEDOUT;
593                         break;
594                 }
595         }
596         if (err) {
597                 dev_err(&priv->udev->dev, "(p54usb) firmware upload failed!\n");
598                 goto err_upload_failed;
599         }
600
601         buf[0] = 'g';
602         buf[1] = '\r';
603         err = p54u_bulk_msg(priv, P54U_PIPE_DATA, buf, 2);
604         if (err) {
605                 dev_err(&priv->udev->dev, "(p54usb) firmware boot failed!\n");
606                 goto err_upload_failed;
607         }
608
609         timeout = jiffies + msecs_to_jiffies(1000);
610         while (!(err = usb_bulk_msg(priv->udev,
611                 usb_rcvbulkpipe(priv->udev, P54U_PIPE_DATA), buf, 128, &alen, 1000))) {
612                 if (alen > 0 && buf[0] == 'g')
613                         break;
614
615                 if (time_after(jiffies, timeout)) {
616                         err = -ETIMEDOUT;
617                         break;
618                 }
619         }
620         if (err)
621                 goto err_upload_failed;
622
623 err_upload_failed:
624         kfree(buf);
625         return err;
626 }
627
628 static int p54u_upload_firmware_net2280(struct ieee80211_hw *dev)
629 {
630         struct p54u_priv *priv = dev->priv;
631         const struct p54p_csr *devreg = (const struct p54p_csr *) P54U_DEV_BASE;
632         int err, alen;
633         void *buf;
634         __le32 reg;
635         unsigned int remains, offset;
636         const u8 *data;
637
638         buf = kmalloc(512, GFP_KERNEL);
639         if (!buf)
640                 return -ENOMEM;
641
642 #define P54U_WRITE(type, addr, data) \
643         do {\
644                 err = p54u_write(priv, buf, type,\
645                                  cpu_to_le32((u32)(unsigned long)addr), data);\
646                 if (err) \
647                         goto fail;\
648         } while (0)
649
650 #define P54U_READ(type, addr) \
651         do {\
652                 err = p54u_read(priv, buf, type,\
653                                 cpu_to_le32((u32)(unsigned long)addr), &reg);\
654                 if (err)\
655                         goto fail;\
656         } while (0)
657
658         /* power down net2280 bridge */
659         P54U_READ(NET2280_BRG_U32, NET2280_GPIOCTL);
660         reg |= cpu_to_le32(P54U_BRG_POWER_DOWN);
661         reg &= cpu_to_le32(~P54U_BRG_POWER_UP);
662         P54U_WRITE(NET2280_BRG_U32, NET2280_GPIOCTL, reg);
663
664         mdelay(100);
665
666         /* power up bridge */
667         reg |= cpu_to_le32(P54U_BRG_POWER_UP);
668         reg &= cpu_to_le32(~P54U_BRG_POWER_DOWN);
669         P54U_WRITE(NET2280_BRG_U32, NET2280_GPIOCTL, reg);
670
671         mdelay(100);
672
673         P54U_WRITE(NET2280_BRG_U32, NET2280_DEVINIT,
674                    cpu_to_le32(NET2280_CLK_30Mhz |
675                                NET2280_PCI_ENABLE |
676                                NET2280_PCI_SOFT_RESET));
677
678         mdelay(20);
679
680         P54U_WRITE(NET2280_BRG_CFG_U16, PCI_COMMAND,
681                    cpu_to_le32(PCI_COMMAND_MEMORY |
682                                PCI_COMMAND_MASTER));
683
684         P54U_WRITE(NET2280_BRG_CFG_U32, PCI_BASE_ADDRESS_0,
685                    cpu_to_le32(NET2280_BASE));
686
687         P54U_READ(NET2280_BRG_CFG_U16, PCI_STATUS);
688         reg |= cpu_to_le32(PCI_STATUS_REC_MASTER_ABORT);
689         P54U_WRITE(NET2280_BRG_CFG_U16, PCI_STATUS, reg);
690
691         // TODO: we really need this?
692         P54U_READ(NET2280_BRG_U32, NET2280_RELNUM);
693
694         P54U_WRITE(NET2280_BRG_U32, NET2280_EPA_RSP,
695                    cpu_to_le32(NET2280_CLEAR_NAK_OUT_PACKETS_MODE));
696         P54U_WRITE(NET2280_BRG_U32, NET2280_EPC_RSP,
697                    cpu_to_le32(NET2280_CLEAR_NAK_OUT_PACKETS_MODE));
698
699         P54U_WRITE(NET2280_BRG_CFG_U32, PCI_BASE_ADDRESS_2,
700                    cpu_to_le32(NET2280_BASE2));
701
702         /* finally done setting up the bridge */
703
704         P54U_WRITE(NET2280_DEV_CFG_U16, 0x10000 | PCI_COMMAND,
705                    cpu_to_le32(PCI_COMMAND_MEMORY |
706                                PCI_COMMAND_MASTER));
707
708         P54U_WRITE(NET2280_DEV_CFG_U16, 0x10000 | 0x40 /* TRDY timeout */, 0);
709         P54U_WRITE(NET2280_DEV_CFG_U32, 0x10000 | PCI_BASE_ADDRESS_0,
710                    cpu_to_le32(P54U_DEV_BASE));
711
712         P54U_WRITE(NET2280_BRG_U32, NET2280_USBIRQENB1, 0);
713         P54U_WRITE(NET2280_BRG_U32, NET2280_IRQSTAT1,
714                    cpu_to_le32(NET2280_PCI_INTA_INTERRUPT));
715
716         /* do romboot */
717         P54U_WRITE(NET2280_DEV_U32, &devreg->int_enable, 0);
718
719         P54U_READ(NET2280_DEV_U32, &devreg->ctrl_stat);
720         reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
721         reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RAMBOOT);
722         reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_CLKRUN);
723         P54U_WRITE(NET2280_DEV_U32, &devreg->ctrl_stat, reg);
724
725         mdelay(20);
726
727         reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RESET);
728         P54U_WRITE(NET2280_DEV_U32, &devreg->ctrl_stat, reg);
729
730         mdelay(20);
731
732         reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
733         P54U_WRITE(NET2280_DEV_U32, &devreg->ctrl_stat, reg);
734
735         mdelay(100);
736
737         P54U_READ(NET2280_DEV_U32, &devreg->int_ident);
738         P54U_WRITE(NET2280_DEV_U32, &devreg->int_ack, reg);
739
740         /* finally, we can upload firmware now! */
741         remains = priv->fw->size;
742         data = priv->fw->data;
743         offset = ISL38XX_DEV_FIRMWARE_ADDR;
744
745         while (remains) {
746                 unsigned int block_len = min(remains, (unsigned int)512);
747                 memcpy(buf, data, block_len);
748
749                 err = p54u_bulk_msg(priv, P54U_PIPE_DATA, buf, block_len);
750                 if (err) {
751                         dev_err(&priv->udev->dev, "(p54usb) firmware block "
752                                                   "upload failed\n");
753                         goto fail;
754                 }
755
756                 P54U_WRITE(NET2280_DEV_U32, &devreg->direct_mem_base,
757                            cpu_to_le32(0xc0000f00));
758
759                 P54U_WRITE(NET2280_DEV_U32,
760                            0x0020 | (unsigned long)&devreg->direct_mem_win, 0);
761                 P54U_WRITE(NET2280_DEV_U32,
762                            0x0020 | (unsigned long)&devreg->direct_mem_win,
763                            cpu_to_le32(1));
764
765                 P54U_WRITE(NET2280_DEV_U32,
766                            0x0024 | (unsigned long)&devreg->direct_mem_win,
767                            cpu_to_le32(block_len));
768                 P54U_WRITE(NET2280_DEV_U32,
769                            0x0028 | (unsigned long)&devreg->direct_mem_win,
770                            cpu_to_le32(offset));
771
772                 P54U_WRITE(NET2280_DEV_U32, &devreg->dma_addr,
773                            cpu_to_le32(NET2280_EPA_FIFO_PCI_ADDR));
774                 P54U_WRITE(NET2280_DEV_U32, &devreg->dma_len,
775                            cpu_to_le32(block_len >> 2));
776                 P54U_WRITE(NET2280_DEV_U32, &devreg->dma_ctrl,
777                            cpu_to_le32(ISL38XX_DMA_MASTER_CONTROL_TRIGGER));
778
779                 mdelay(10);
780
781                 P54U_READ(NET2280_DEV_U32,
782                           0x002C | (unsigned long)&devreg->direct_mem_win);
783                 if (!(reg & cpu_to_le32(ISL38XX_DMA_STATUS_DONE)) ||
784                     !(reg & cpu_to_le32(ISL38XX_DMA_STATUS_READY))) {
785                         dev_err(&priv->udev->dev, "(p54usb) firmware DMA "
786                                                   "transfer failed\n");
787                         goto fail;
788                 }
789
790                 P54U_WRITE(NET2280_BRG_U32, NET2280_EPA_STAT,
791                            cpu_to_le32(NET2280_FIFO_FLUSH));
792
793                 remains -= block_len;
794                 data += block_len;
795                 offset += block_len;
796         }
797
798         /* do ramboot */
799         P54U_READ(NET2280_DEV_U32, &devreg->ctrl_stat);
800         reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
801         reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_CLKRUN);
802         reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RAMBOOT);
803         P54U_WRITE(NET2280_DEV_U32, &devreg->ctrl_stat, reg);
804
805         mdelay(20);
806
807         reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RESET);
808         P54U_WRITE(NET2280_DEV_U32, &devreg->ctrl_stat, reg);
809
810         reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
811         P54U_WRITE(NET2280_DEV_U32, &devreg->ctrl_stat, reg);
812
813         mdelay(100);
814
815         P54U_READ(NET2280_DEV_U32, &devreg->int_ident);
816         P54U_WRITE(NET2280_DEV_U32, &devreg->int_ack, reg);
817
818         /* start up the firmware */
819         P54U_WRITE(NET2280_DEV_U32, &devreg->int_enable,
820                    cpu_to_le32(ISL38XX_INT_IDENT_INIT));
821
822         P54U_WRITE(NET2280_BRG_U32, NET2280_IRQSTAT1,
823                    cpu_to_le32(NET2280_PCI_INTA_INTERRUPT));
824
825         P54U_WRITE(NET2280_BRG_U32, NET2280_USBIRQENB1,
826                    cpu_to_le32(NET2280_PCI_INTA_INTERRUPT_ENABLE |
827                                NET2280_USB_INTERRUPT_ENABLE));
828
829         P54U_WRITE(NET2280_DEV_U32, &devreg->dev_int,
830                    cpu_to_le32(ISL38XX_DEV_INT_RESET));
831
832         err = usb_interrupt_msg(priv->udev,
833                                 usb_rcvbulkpipe(priv->udev, P54U_PIPE_INT),
834                                 buf, sizeof(__le32), &alen, 1000);
835         if (err || alen != sizeof(__le32))
836                 goto fail;
837
838         P54U_READ(NET2280_DEV_U32, &devreg->int_ident);
839         P54U_WRITE(NET2280_DEV_U32, &devreg->int_ack, reg);
840
841         if (!(reg & cpu_to_le32(ISL38XX_INT_IDENT_INIT)))
842                 err = -EINVAL;
843
844         P54U_WRITE(NET2280_BRG_U32, NET2280_USBIRQENB1, 0);
845         P54U_WRITE(NET2280_BRG_U32, NET2280_IRQSTAT1,
846                    cpu_to_le32(NET2280_PCI_INTA_INTERRUPT));
847
848 #undef P54U_WRITE
849 #undef P54U_READ
850
851 fail:
852         kfree(buf);
853         return err;
854 }
855
856 static int p54_find_type(struct p54u_priv *priv)
857 {
858         int i;
859
860         for (i = 0; i < __NUM_P54U_HWTYPES; i++)
861                 if (p54u_fwlist[i].type == priv->hw_type)
862                         break;
863         if (i == __NUM_P54U_HWTYPES)
864                 return -EOPNOTSUPP;
865
866         return i;
867 }
868
869 static int p54u_start_ops(struct p54u_priv *priv)
870 {
871         struct ieee80211_hw *dev = priv->common.hw;
872         int ret;
873
874         ret = p54_parse_firmware(dev, priv->fw);
875         if (ret)
876                 goto err_out;
877
878         ret = p54_find_type(priv);
879         if (ret < 0)
880                 goto err_out;
881
882         if (priv->common.fw_interface != p54u_fwlist[ret].intf) {
883                 dev_err(&priv->udev->dev, "wrong firmware, please get "
884                         "a firmware for \"%s\" and try again.\n",
885                         p54u_fwlist[ret].hw);
886                 ret = -ENODEV;
887                 goto err_out;
888         }
889
890         ret = priv->upload_fw(dev);
891         if (ret)
892                 goto err_out;
893
894         ret = p54u_open(dev);
895         if (ret)
896                 goto err_out;
897
898         ret = p54_read_eeprom(dev);
899         if (ret)
900                 goto err_stop;
901
902         p54u_stop(dev);
903
904         ret = p54_register_common(dev, &priv->udev->dev);
905         if (ret)
906                 goto err_stop;
907
908         return 0;
909
910 err_stop:
911         p54u_stop(dev);
912
913 err_out:
914         /*
915          * p54u_disconnect will do the rest of the
916          * cleanup
917          */
918         return ret;
919 }
920
921 static void p54u_load_firmware_cb(const struct firmware *firmware,
922                                   void *context)
923 {
924         struct p54u_priv *priv = context;
925         struct usb_device *udev = priv->udev;
926         struct usb_interface *intf = priv->intf;
927         int err;
928
929         if (firmware) {
930                 priv->fw = firmware;
931                 err = p54u_start_ops(priv);
932         } else {
933                 err = -ENOENT;
934                 dev_err(&udev->dev, "Firmware not found.\n");
935         }
936
937         complete(&priv->fw_wait_load);
938         /*
939          * At this point p54u_disconnect may have already freed
940          * the "priv" context. Do not use it anymore!
941          */
942         priv = NULL;
943
944         if (err) {
945                 dev_err(&intf->dev, "failed to initialize device (%d)\n", err);
946
947                 usb_lock_device(udev);
948                 usb_driver_release_interface(&p54u_driver, intf);
949                 usb_unlock_device(udev);
950         }
951
952         usb_put_intf(intf);
953 }
954
955 static int p54u_load_firmware(struct ieee80211_hw *dev,
956                               struct usb_interface *intf)
957 {
958         struct usb_device *udev = interface_to_usbdev(intf);
959         struct p54u_priv *priv = dev->priv;
960         struct device *device = &udev->dev;
961         int err, i;
962
963         BUILD_BUG_ON(ARRAY_SIZE(p54u_fwlist) != __NUM_P54U_HWTYPES);
964
965         init_completion(&priv->fw_wait_load);
966         i = p54_find_type(priv);
967         if (i < 0)
968                 return i;
969
970         dev_info(&priv->udev->dev, "Loading firmware file %s\n",
971                p54u_fwlist[i].fw);
972
973         usb_get_intf(intf);
974         err = reject_firmware_nowait(THIS_MODULE, 1, p54u_fwlist[i].fw,
975                                       device, GFP_KERNEL, priv,
976                                       p54u_load_firmware_cb);
977         if (err) {
978                 dev_err(&priv->udev->dev, "(p54usb) cannot load firmware %s "
979                                           "(%d)!\n", p54u_fwlist[i].fw, err);
980                 usb_put_intf(intf);
981         }
982
983         return err;
984 }
985
986 static int p54u_probe(struct usb_interface *intf,
987                                 const struct usb_device_id *id)
988 {
989         struct usb_device *udev = interface_to_usbdev(intf);
990         struct ieee80211_hw *dev;
991         struct p54u_priv *priv;
992         int err;
993         unsigned int i, recognized_pipes;
994
995         dev = p54_init_common(sizeof(*priv));
996
997         if (!dev) {
998                 dev_err(&udev->dev, "(p54usb) ieee80211 alloc failed\n");
999                 return -ENOMEM;
1000         }
1001
1002         priv = dev->priv;
1003         priv->hw_type = P54U_INVALID_HW;
1004
1005         SET_IEEE80211_DEV(dev, &intf->dev);
1006         usb_set_intfdata(intf, dev);
1007         priv->udev = udev;
1008         priv->intf = intf;
1009         skb_queue_head_init(&priv->rx_queue);
1010         init_usb_anchor(&priv->submitted);
1011
1012         /* really lazy and simple way of figuring out if we're a 3887 */
1013         /* TODO: should just stick the identification in the device table */
1014         i = intf->altsetting->desc.bNumEndpoints;
1015         recognized_pipes = 0;
1016         while (i--) {
1017                 switch (intf->altsetting->endpoint[i].desc.bEndpointAddress) {
1018                 case P54U_PIPE_DATA:
1019                 case P54U_PIPE_MGMT:
1020                 case P54U_PIPE_BRG:
1021                 case P54U_PIPE_DEV:
1022                 case P54U_PIPE_DATA | USB_DIR_IN:
1023                 case P54U_PIPE_MGMT | USB_DIR_IN:
1024                 case P54U_PIPE_BRG | USB_DIR_IN:
1025                 case P54U_PIPE_DEV | USB_DIR_IN:
1026                 case P54U_PIPE_INT | USB_DIR_IN:
1027                         recognized_pipes++;
1028                 }
1029         }
1030         priv->common.open = p54u_open;
1031         priv->common.stop = p54u_stop;
1032         if (recognized_pipes < P54U_PIPE_NUMBER) {
1033 #ifdef CONFIG_PM
1034                 /* ISL3887 needs a full reset on resume */
1035                 udev->reset_resume = 1;
1036 #endif /* CONFIG_PM */
1037                 err = p54u_device_reset(dev);
1038
1039                 priv->hw_type = P54U_3887;
1040                 dev->extra_tx_headroom += sizeof(struct lm87_tx_hdr);
1041                 priv->common.tx_hdr_len = sizeof(struct lm87_tx_hdr);
1042                 priv->common.tx = p54u_tx_lm87;
1043                 priv->upload_fw = p54u_upload_firmware_3887;
1044         } else {
1045                 priv->hw_type = P54U_NET2280;
1046                 dev->extra_tx_headroom += sizeof(struct net2280_tx_hdr);
1047                 priv->common.tx_hdr_len = sizeof(struct net2280_tx_hdr);
1048                 priv->common.tx = p54u_tx_net2280;
1049                 priv->upload_fw = p54u_upload_firmware_net2280;
1050         }
1051         err = p54u_load_firmware(dev, intf);
1052         if (err)
1053                 p54_free_common(dev);
1054         return err;
1055 }
1056
1057 static void p54u_disconnect(struct usb_interface *intf)
1058 {
1059         struct ieee80211_hw *dev = usb_get_intfdata(intf);
1060         struct p54u_priv *priv;
1061
1062         if (!dev)
1063                 return;
1064
1065         priv = dev->priv;
1066         wait_for_completion(&priv->fw_wait_load);
1067         p54_unregister_common(dev);
1068
1069         release_firmware(priv->fw);
1070         p54_free_common(dev);
1071 }
1072
1073 static int p54u_pre_reset(struct usb_interface *intf)
1074 {
1075         struct ieee80211_hw *dev = usb_get_intfdata(intf);
1076
1077         if (!dev)
1078                 return -ENODEV;
1079
1080         p54u_stop(dev);
1081         return 0;
1082 }
1083
1084 static int p54u_resume(struct usb_interface *intf)
1085 {
1086         struct ieee80211_hw *dev = usb_get_intfdata(intf);
1087         struct p54u_priv *priv;
1088
1089         if (!dev)
1090                 return -ENODEV;
1091
1092         priv = dev->priv;
1093         if (unlikely(!(priv->upload_fw && priv->fw)))
1094                 return 0;
1095
1096         return priv->upload_fw(dev);
1097 }
1098
1099 static int p54u_post_reset(struct usb_interface *intf)
1100 {
1101         struct ieee80211_hw *dev = usb_get_intfdata(intf);
1102         struct p54u_priv *priv;
1103         int err;
1104
1105         err = p54u_resume(intf);
1106         if (err)
1107                 return err;
1108
1109         /* reinitialize old device state */
1110         priv = dev->priv;
1111         if (priv->common.mode != NL80211_IFTYPE_UNSPECIFIED)
1112                 ieee80211_restart_hw(dev);
1113
1114         return 0;
1115 }
1116
1117 #ifdef CONFIG_PM
1118
1119 static int p54u_suspend(struct usb_interface *intf, pm_message_t message)
1120 {
1121         return p54u_pre_reset(intf);
1122 }
1123
1124 #endif /* CONFIG_PM */
1125
1126 static struct usb_driver p54u_driver = {
1127         .name   = "p54usb",
1128         .id_table = p54u_table,
1129         .probe = p54u_probe,
1130         .disconnect = p54u_disconnect,
1131         .pre_reset = p54u_pre_reset,
1132         .post_reset = p54u_post_reset,
1133 #ifdef CONFIG_PM
1134         .suspend = p54u_suspend,
1135         .resume = p54u_resume,
1136         .reset_resume = p54u_resume,
1137 #endif /* CONFIG_PM */
1138         .soft_unbind = 1,
1139         .disable_hub_initiated_lpm = 1,
1140 };
1141
1142 module_usb_driver(p54u_driver);