libertas: kill whitespace at end of lines
[linux-2.6] / drivers / net / wireless / libertas / if_usb.c
1 /**
2   * This file contains functions used in USB interface module.
3   */
4 #include <linux/delay.h>
5 #include <linux/moduleparam.h>
6 #include <linux/firmware.h>
7 #include <linux/netdevice.h>
8 #include <linux/usb.h>
9
10 #define DRV_NAME "usb8xxx"
11
12 #include "host.h"
13 #include "decl.h"
14 #include "defs.h"
15 #include "dev.h"
16 #include "cmd.h"
17 #include "if_usb.h"
18
19 #define INSANEDEBUG     0
20 #define lbs_deb_usb2(...) do { if (INSANEDEBUG) lbs_deb_usbd(__VA_ARGS__); } while (0)
21
22 #define MESSAGE_HEADER_LEN      4
23
24 static char *lbs_fw_name = "usb8388.bin";
25 module_param_named(fw_name, lbs_fw_name, charp, 0644);
26
27 static struct usb_device_id if_usb_table[] = {
28         /* Enter the device signature inside */
29         { USB_DEVICE(0x1286, 0x2001) },
30         { USB_DEVICE(0x05a3, 0x8388) },
31         {}      /* Terminating entry */
32 };
33
34 MODULE_DEVICE_TABLE(usb, if_usb_table);
35
36 static void if_usb_receive(struct urb *urb);
37 static void if_usb_receive_fwload(struct urb *urb);
38 static int if_usb_prog_firmware(struct if_usb_card *cardp);
39 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
40                                uint8_t *payload, uint16_t nb);
41 static int if_usb_get_int_status(struct lbs_private *priv, uint8_t *);
42 static int if_usb_read_event_cause(struct lbs_private *);
43 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
44                         uint16_t nb);
45 static void if_usb_free(struct if_usb_card *cardp);
46 static int if_usb_submit_rx_urb(struct if_usb_card *cardp);
47 static int if_usb_reset_device(struct if_usb_card *cardp);
48
49 /**
50  *  @brief  call back function to handle the status of the URB
51  *  @param urb          pointer to urb structure
52  *  @return             N/A
53  */
54 static void if_usb_write_bulk_callback(struct urb *urb)
55 {
56         struct if_usb_card *cardp = (struct if_usb_card *) urb->context;
57
58         /* handle the transmission complete validations */
59
60         if (urb->status == 0) {
61                 struct lbs_private *priv = cardp->priv;
62
63                 lbs_deb_usb2(&urb->dev->dev, "URB status is successful\n");
64                 lbs_deb_usb2(&urb->dev->dev, "Actual length transmitted %d\n",
65                              urb->actual_length);
66
67                 /* Used for both firmware TX and regular TX.  priv isn't
68                  * valid at firmware load time.
69                  */
70                 if (priv)
71                         lbs_host_to_card_done(priv);
72         } else {
73                 /* print the failure status number for debug */
74                 lbs_pr_info("URB in failure status: %d\n", urb->status);
75         }
76
77         return;
78 }
79
80 /**
81  *  @brief  free tx/rx urb, skb and rx buffer
82  *  @param cardp        pointer if_usb_card
83  *  @return             N/A
84  */
85 static void if_usb_free(struct if_usb_card *cardp)
86 {
87         lbs_deb_enter(LBS_DEB_USB);
88
89         /* Unlink tx & rx urb */
90         usb_kill_urb(cardp->tx_urb);
91         usb_kill_urb(cardp->rx_urb);
92
93         usb_free_urb(cardp->tx_urb);
94         cardp->tx_urb = NULL;
95
96         usb_free_urb(cardp->rx_urb);
97         cardp->rx_urb = NULL;
98
99         kfree(cardp->ep_out_buf);
100         cardp->ep_out_buf = NULL;
101
102         lbs_deb_leave(LBS_DEB_USB);
103 }
104
105 static void if_usb_set_boot2_ver(struct lbs_private *priv)
106 {
107         struct cmd_ds_set_boot2_ver b2_cmd;
108
109         b2_cmd.action = 0;
110         b2_cmd.version = priv->boot2_version;
111
112         if (lbs_cmd(priv, CMD_SET_BOOT2_VER, &b2_cmd, NULL, 0))
113                 lbs_deb_usb("Setting boot2 version failed\n");
114 }
115
116 static void if_usb_fw_timeo(unsigned long priv)
117 {
118         struct if_usb_card *cardp = (void *)priv;
119
120         if (cardp->fwdnldover) {
121                 lbs_deb_usb("Download complete, no event. Assuming success\n");
122         } else {
123                 lbs_pr_err("Download timed out\n");
124                 cardp->surprise_removed = 1;
125         }
126         wake_up(&cardp->fw_wq);
127 }
128
129 /**
130  *  @brief sets the configuration values
131  *  @param ifnum        interface number
132  *  @param id           pointer to usb_device_id
133  *  @return             0 on success, error code on failure
134  */
135 static int if_usb_probe(struct usb_interface *intf,
136                         const struct usb_device_id *id)
137 {
138         struct usb_device *udev;
139         struct usb_host_interface *iface_desc;
140         struct usb_endpoint_descriptor *endpoint;
141         struct lbs_private *priv;
142         struct if_usb_card *cardp;
143         int i;
144
145         udev = interface_to_usbdev(intf);
146
147         cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
148         if (!cardp) {
149                 lbs_pr_err("Out of memory allocating private data.\n");
150                 goto error;
151         }
152
153         setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp);
154         init_waitqueue_head(&cardp->fw_wq);
155
156         cardp->udev = udev;
157         iface_desc = intf->cur_altsetting;
158
159         lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
160                      " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
161                      le16_to_cpu(udev->descriptor.bcdUSB),
162                      udev->descriptor.bDeviceClass,
163                      udev->descriptor.bDeviceSubClass,
164                      udev->descriptor.bDeviceProtocol);
165
166         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
167                 endpoint = &iface_desc->endpoint[i].desc;
168                 if (usb_endpoint_is_bulk_in(endpoint)) {
169                         cardp->ep_in_size = le16_to_cpu(endpoint->wMaxPacketSize);
170                         cardp->ep_in = usb_endpoint_num(endpoint);
171
172                         lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in);
173                         lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size);
174
175                 } else if (usb_endpoint_is_bulk_out(endpoint)) {
176                         cardp->ep_out_size = le16_to_cpu(endpoint->wMaxPacketSize);
177                         cardp->ep_out = usb_endpoint_num(endpoint);
178
179                         lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out);
180                         lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size);
181                 }
182         }
183         if (!cardp->ep_out_size || !cardp->ep_in_size) {
184                 lbs_deb_usbd(&udev->dev, "Endpoints not found\n");
185                 goto dealloc;
186         }
187         if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
188                 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n");
189                 goto dealloc;
190         }
191         if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
192                 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n");
193                 goto dealloc;
194         }
195         cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL);
196         if (!cardp->ep_out_buf) {
197                 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n");
198                 goto dealloc;
199         }
200
201         /* Upload firmware */
202         if (if_usb_prog_firmware(cardp)) {
203                 lbs_deb_usbd(&udev->dev, "FW upload failed\n");
204                 goto err_prog_firmware;
205         }
206
207         if (!(priv = lbs_add_card(cardp, &udev->dev)))
208                 goto err_prog_firmware;
209
210         cardp->priv = priv;
211         cardp->priv->fw_ready = 1;
212
213         priv->hw_host_to_card = if_usb_host_to_card;
214         priv->hw_get_int_status = if_usb_get_int_status;
215         priv->hw_read_event_cause = if_usb_read_event_cause;
216         priv->boot2_version = udev->descriptor.bcdDevice;
217
218         if_usb_submit_rx_urb(cardp);
219
220         if (lbs_start_card(priv))
221                 goto err_start_card;
222
223         if_usb_set_boot2_ver(priv);
224
225         priv->wol_gpio = 2; /* Wake via GPIO2... */
226         priv->wol_gap = 20; /* ... after 20ms    */
227         lbs_host_sleep_cfg(priv, EHS_WAKE_ON_UNICAST_DATA);
228
229         usb_get_dev(udev);
230         usb_set_intfdata(intf, cardp);
231
232         return 0;
233
234 err_start_card:
235         lbs_remove_card(priv);
236 err_prog_firmware:
237         if_usb_reset_device(cardp);
238 dealloc:
239         if_usb_free(cardp);
240
241 error:
242         return -ENOMEM;
243 }
244
245 /**
246  *  @brief free resource and cleanup
247  *  @param intf         USB interface structure
248  *  @return             N/A
249  */
250 static void if_usb_disconnect(struct usb_interface *intf)
251 {
252         struct if_usb_card *cardp = usb_get_intfdata(intf);
253         struct lbs_private *priv = (struct lbs_private *) cardp->priv;
254
255         lbs_deb_enter(LBS_DEB_MAIN);
256
257         cardp->surprise_removed = 1;
258
259         if (priv) {
260                 priv->surpriseremoved = 1;
261                 lbs_stop_card(priv);
262                 lbs_remove_card(priv);
263         }
264
265         /* Unlink and free urb */
266         if_usb_free(cardp);
267
268         usb_set_intfdata(intf, NULL);
269         usb_put_dev(interface_to_usbdev(intf));
270
271         lbs_deb_leave(LBS_DEB_MAIN);
272 }
273
274 /**
275  *  @brief  This function download FW
276  *  @param priv         pointer to struct lbs_private
277  *  @return             0
278  */
279 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
280 {
281         struct fwdata *fwdata = cardp->ep_out_buf;
282         uint8_t *firmware = cardp->fw->data;
283
284         /* If we got a CRC failure on the last block, back
285            up and retry it */
286         if (!cardp->CRC_OK) {
287                 cardp->totalbytes = cardp->fwlastblksent;
288                 cardp->fwseqnum--;
289         }
290
291         lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n",
292                      cardp->totalbytes);
293
294         /* struct fwdata (which we sent to the card) has an
295            extra __le32 field in between the header and the data,
296            which is not in the struct fwheader in the actual
297            firmware binary. Insert the seqnum in the middle... */
298         memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
299                sizeof(struct fwheader));
300
301         cardp->fwlastblksent = cardp->totalbytes;
302         cardp->totalbytes += sizeof(struct fwheader);
303
304         memcpy(fwdata->data, &firmware[cardp->totalbytes],
305                le32_to_cpu(fwdata->hdr.datalength));
306
307         lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n",
308                      le32_to_cpu(fwdata->hdr.datalength));
309
310         fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
311         cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
312
313         usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
314                      le32_to_cpu(fwdata->hdr.datalength));
315
316         if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
317                 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n");
318                 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n",
319                              cardp->fwseqnum, cardp->totalbytes);
320         } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
321                 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n");
322                 lbs_deb_usb2(&cardp->udev->dev, "Donwloading FW JUMP BLOCK\n");
323
324                 cardp->fwfinalblk = 1;
325         }
326
327         lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n",
328                      cardp->totalbytes);
329
330         return 0;
331 }
332
333 static int if_usb_reset_device(struct if_usb_card *cardp)
334 {
335         struct cmd_ds_command *cmd = cardp->ep_out_buf + 4;
336         int ret;
337
338         lbs_deb_enter(LBS_DEB_USB);
339
340         *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
341
342         cmd->command = cpu_to_le16(CMD_802_11_RESET);
343         cmd->size = cpu_to_le16(sizeof(struct cmd_ds_802_11_reset) + S_DS_GEN);
344         cmd->result = cpu_to_le16(0);
345         cmd->seqnum = cpu_to_le16(0x5a5a);
346         cmd->params.reset.action = cpu_to_le16(CMD_ACT_HALT);
347         usb_tx_block(cardp, cardp->ep_out_buf, 4 + S_DS_GEN + sizeof(struct cmd_ds_802_11_reset));
348
349         msleep(100);
350         ret = usb_reset_device(cardp->udev);
351         msleep(100);
352
353         lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
354
355         return ret;
356 }
357
358 /**
359  *  @brief This function transfer the data to the device.
360  *  @param priv         pointer to struct lbs_private
361  *  @param payload      pointer to payload data
362  *  @param nb           data length
363  *  @return             0 or -1
364  */
365 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb)
366 {
367         int ret = -1;
368
369         /* check if device is removed */
370         if (cardp->surprise_removed) {
371                 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
372                 goto tx_ret;
373         }
374
375         usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
376                           usb_sndbulkpipe(cardp->udev,
377                                           cardp->ep_out),
378                           payload, nb, if_usb_write_bulk_callback, cardp);
379
380         cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
381
382         if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
383                 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret);
384                 ret = -1;
385         } else {
386                 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
387                 ret = 0;
388         }
389
390 tx_ret:
391         return ret;
392 }
393
394 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
395                                   void (*callbackfn)(struct urb *urb))
396 {
397         struct sk_buff *skb;
398         int ret = -1;
399
400         if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
401                 lbs_pr_err("No free skb\n");
402                 goto rx_ret;
403         }
404
405         cardp->rx_skb = skb;
406
407         /* Fill the receive configuration URB and initialise the Rx call back */
408         usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
409                           usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
410                           (void *) (skb->tail + (size_t) IPFIELD_ALIGN_OFFSET),
411                           MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
412                           cardp);
413
414         cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;
415
416         lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb);
417         if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
418                 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret);
419                 kfree_skb(skb);
420                 cardp->rx_skb = NULL;
421                 ret = -1;
422         } else {
423                 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
424                 ret = 0;
425         }
426
427 rx_ret:
428         return ret;
429 }
430
431 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
432 {
433         return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
434 }
435
436 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
437 {
438         return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
439 }
440
441 static void if_usb_receive_fwload(struct urb *urb)
442 {
443         struct if_usb_card *cardp = urb->context;
444         struct sk_buff *skb = cardp->rx_skb;
445         struct fwsyncheader *syncfwheader;
446         struct bootcmdresp bootcmdresp;
447
448         if (urb->status) {
449                 lbs_deb_usbd(&cardp->udev->dev,
450                              "URB status is failed during fw load\n");
451                 kfree_skb(skb);
452                 return;
453         }
454
455         if (cardp->fwdnldover) {
456                 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
457
458                 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
459                     tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
460                         lbs_pr_info("Firmware ready event received\n");
461                         wake_up(&cardp->fw_wq);
462                 } else {
463                         lbs_deb_usb("Waiting for confirmation; got %x %x\n",
464                                     le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
465                         if_usb_submit_rx_urb_fwload(cardp);
466                 }
467                 kfree_skb(skb);
468                 return;
469         }
470         if (cardp->bootcmdresp <= 0) {
471                 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
472                         sizeof(bootcmdresp));
473
474                 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
475                         kfree_skb(skb);
476                         if_usb_submit_rx_urb_fwload(cardp);
477                         cardp->bootcmdresp = 1;
478                         lbs_deb_usbd(&cardp->udev->dev,
479                                      "Received valid boot command response\n");
480                         return;
481                 }
482                 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
483                         if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
484                             bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
485                             bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
486                                 if (!cardp->bootcmdresp)
487                                         lbs_pr_info("Firmware already seems alive; resetting\n");
488                                 cardp->bootcmdresp = -1;
489                         } else {
490                                 lbs_pr_info("boot cmd response wrong magic number (0x%x)\n",
491                                             le32_to_cpu(bootcmdresp.magic));
492                         }
493                 } else if (bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) {
494                         lbs_pr_info("boot cmd response cmd_tag error (%d)\n",
495                                     bootcmdresp.cmd);
496                 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) {
497                         lbs_pr_info("boot cmd response result error (%d)\n",
498                                     bootcmdresp.result);
499                 } else {
500                         cardp->bootcmdresp = 1;
501                         lbs_deb_usbd(&cardp->udev->dev,
502                                      "Received valid boot command response\n");
503                 }
504                 kfree_skb(skb);
505                 if_usb_submit_rx_urb_fwload(cardp);
506                 return;
507         }
508
509         syncfwheader = kmalloc(sizeof(struct fwsyncheader), GFP_ATOMIC);
510         if (!syncfwheader) {
511                 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
512                 kfree_skb(skb);
513                 return;
514         }
515
516         memcpy(syncfwheader, skb->data + IPFIELD_ALIGN_OFFSET,
517                sizeof(struct fwsyncheader));
518
519         if (!syncfwheader->cmd) {
520                 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n");
521                 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n",
522                              le32_to_cpu(syncfwheader->seqnum));
523                 cardp->CRC_OK = 1;
524         } else {
525                 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n");
526                 cardp->CRC_OK = 0;
527         }
528
529         kfree_skb(skb);
530
531         /* reschedule timer for 200ms hence */
532         mod_timer(&cardp->fw_timeout, jiffies + (HZ/5));
533
534         if (cardp->fwfinalblk) {
535                 cardp->fwdnldover = 1;
536                 goto exit;
537         }
538
539         if_usb_send_fw_pkt(cardp);
540
541  exit:
542         if_usb_submit_rx_urb_fwload(cardp);
543
544         kfree(syncfwheader);
545
546         return;
547 }
548
549 #define MRVDRV_MIN_PKT_LEN      30
550
551 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
552                                        struct if_usb_card *cardp,
553                                        struct lbs_private *priv)
554 {
555         if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
556             || recvlength < MRVDRV_MIN_PKT_LEN) {
557                 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
558                 kfree_skb(skb);
559                 return;
560         }
561
562         skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
563         skb_put(skb, recvlength);
564         skb_pull(skb, MESSAGE_HEADER_LEN);
565
566         lbs_process_rxed_packet(priv, skb);
567         priv->upld_len = (recvlength - MESSAGE_HEADER_LEN);
568 }
569
570 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
571                                       struct sk_buff *skb,
572                                       struct if_usb_card *cardp,
573                                       struct lbs_private *priv)
574 {
575         uint8_t *cmdbuf;
576
577         if (recvlength > LBS_CMD_BUFFER_SIZE) {
578                 lbs_deb_usbd(&cardp->udev->dev,
579                              "The receive buffer is too large\n");
580                 kfree_skb(skb);
581                 return;
582         }
583
584         if (!in_interrupt())
585                 BUG();
586
587         spin_lock(&priv->driver_lock);
588         /* take care of cur_cmd = NULL case by reading the
589          * data to clear the interrupt */
590         if (!priv->cur_cmd) {
591                 lbs_deb_hex(LBS_DEB_HOST, "Unsolicited CMD_RESP",
592                             (void *) recvbuff + MESSAGE_HEADER_LEN, priv->upld_len);
593                 cmdbuf = priv->upld_buf;
594                 priv->hisregcpy &= ~MRVDRV_CMD_UPLD_RDY;
595         } else
596                 cmdbuf = (uint8_t *) priv->cur_cmd->cmdbuf;
597
598         cardp->usb_int_cause |= MRVDRV_CMD_UPLD_RDY;
599         priv->upld_len = (recvlength - MESSAGE_HEADER_LEN);
600         memcpy(cmdbuf, recvbuff + MESSAGE_HEADER_LEN, priv->upld_len);
601
602         kfree_skb(skb);
603         lbs_interrupt(priv);
604         spin_unlock(&priv->driver_lock);
605
606         lbs_deb_usbd(&cardp->udev->dev,
607                     "Wake up main thread to handle cmd response\n");
608 }
609
610 /**
611  *  @brief This function reads of the packet into the upload buff,
612  *  wake up the main thread and initialise the Rx callack.
613  *
614  *  @param urb          pointer to struct urb
615  *  @return             N/A
616  */
617 static void if_usb_receive(struct urb *urb)
618 {
619         struct if_usb_card *cardp = urb->context;
620         struct sk_buff *skb = cardp->rx_skb;
621         struct lbs_private *priv = cardp->priv;
622         int recvlength = urb->actual_length;
623         uint8_t *recvbuff = NULL;
624         uint32_t recvtype = 0;
625         __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
626
627         lbs_deb_enter(LBS_DEB_USB);
628
629         if (recvlength) {
630                 if (urb->status) {
631                         lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n",
632                                      urb->status);
633                         kfree_skb(skb);
634                         goto setup_for_next;
635                 }
636
637                 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
638                 recvtype = le32_to_cpu(pkt[0]);
639                 lbs_deb_usbd(&cardp->udev->dev,
640                             "Recv length = 0x%x, Recv type = 0x%X\n",
641                             recvlength, recvtype);
642         } else if (urb->status) {
643                 kfree_skb(skb);
644                 goto rx_exit;
645         }
646
647         switch (recvtype) {
648         case CMD_TYPE_DATA:
649                 process_cmdtypedata(recvlength, skb, cardp, priv);
650                 break;
651
652         case CMD_TYPE_REQUEST:
653                 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
654                 break;
655
656         case CMD_TYPE_INDICATION:
657                 /* Event cause handling */
658                 spin_lock(&priv->driver_lock);
659
660                 cardp->usb_event_cause = le32_to_cpu(pkt[1]);
661
662                 lbs_deb_usbd(&cardp->udev->dev,"**EVENT** 0x%X\n",
663                              cardp->usb_event_cause);
664
665                 /* Icky undocumented magic special case */
666                 if (cardp->usb_event_cause & 0xffff0000) {
667                         lbs_send_tx_feedback(priv);
668                         spin_unlock(&priv->driver_lock);
669                         break;
670                 }
671                 cardp->usb_event_cause <<= 3;
672                 cardp->usb_int_cause |= MRVDRV_CARDEVENT;
673                 kfree_skb(skb);
674                 lbs_interrupt(priv);
675                 spin_unlock(&priv->driver_lock);
676                 goto rx_exit;
677         default:
678                 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
679                              recvtype);
680                 kfree_skb(skb);
681                 break;
682         }
683
684 setup_for_next:
685         if_usb_submit_rx_urb(cardp);
686 rx_exit:
687         lbs_deb_leave(LBS_DEB_USB);
688 }
689
690 /**
691  *  @brief This function downloads data to FW
692  *  @param priv         pointer to struct lbs_private structure
693  *  @param type         type of data
694  *  @param buf          pointer to data buffer
695  *  @param len          number of bytes
696  *  @return             0 or -1
697  */
698 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
699                                uint8_t *payload, uint16_t nb)
700 {
701         struct if_usb_card *cardp = priv->card;
702
703         lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
704         lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
705
706         if (type == MVMS_CMD) {
707                 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
708                 priv->dnld_sent = DNLD_CMD_SENT;
709         } else {
710                 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
711                 priv->dnld_sent = DNLD_DATA_SENT;
712         }
713
714         memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
715
716         return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN);
717 }
718
719 /* called with priv->driver_lock held */
720 static int if_usb_get_int_status(struct lbs_private *priv, uint8_t *ireg)
721 {
722         struct if_usb_card *cardp = priv->card;
723
724         *ireg = cardp->usb_int_cause;
725         cardp->usb_int_cause = 0;
726
727         lbs_deb_usbd(&cardp->udev->dev, "Int cause is 0x%X\n", *ireg);
728
729         return 0;
730 }
731
732 static int if_usb_read_event_cause(struct lbs_private *priv)
733 {
734         struct if_usb_card *cardp = priv->card;
735
736         priv->eventcause = cardp->usb_event_cause;
737         /* Re-submit rx urb here to avoid event lost issue */
738         if_usb_submit_rx_urb(cardp);
739
740         return 0;
741 }
742
743 /**
744  *  @brief This function issues Boot command to the Boot2 code
745  *  @param ivalue   1:Boot from FW by USB-Download
746  *                  2:Boot from FW in EEPROM
747  *  @return             0
748  */
749 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
750 {
751         struct bootcmd *bootcmd = cardp->ep_out_buf;
752
753         /* Prepare command */
754         bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
755         bootcmd->cmd = ivalue;
756         memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
757
758         /* Issue command */
759         usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd));
760
761         return 0;
762 }
763
764
765 /**
766  *  @brief This function checks the validity of Boot2/FW image.
767  *
768  *  @param data              pointer to image
769  *         len               image length
770  *  @return     0 or -1
771  */
772 static int check_fwfile_format(uint8_t *data, uint32_t totlen)
773 {
774         uint32_t bincmd, exit;
775         uint32_t blksize, offset, len;
776         int ret;
777
778         ret = 1;
779         exit = len = 0;
780
781         do {
782                 struct fwheader *fwh = (void *)data;
783
784                 bincmd = le32_to_cpu(fwh->dnldcmd);
785                 blksize = le32_to_cpu(fwh->datalength);
786                 switch (bincmd) {
787                 case FW_HAS_DATA_TO_RECV:
788                         offset = sizeof(struct fwheader) + blksize;
789                         data += offset;
790                         len += offset;
791                         if (len >= totlen)
792                                 exit = 1;
793                         break;
794                 case FW_HAS_LAST_BLOCK:
795                         exit = 1;
796                         ret = 0;
797                         break;
798                 default:
799                         exit = 1;
800                         break;
801                 }
802         } while (!exit);
803
804         if (ret)
805                 lbs_pr_err("firmware file format check FAIL\n");
806         else
807                 lbs_deb_fw("firmware file format check PASS\n");
808
809         return ret;
810 }
811
812
813 static int if_usb_prog_firmware(struct if_usb_card *cardp)
814 {
815         int i = 0;
816         static int reset_count = 10;
817         int ret = 0;
818
819         lbs_deb_enter(LBS_DEB_USB);
820
821         if ((ret = request_firmware(&cardp->fw, lbs_fw_name,
822                                     &cardp->udev->dev)) < 0) {
823                 lbs_pr_err("request_firmware() failed with %#x\n", ret);
824                 lbs_pr_err("firmware %s not found\n", lbs_fw_name);
825                 goto done;
826         }
827
828         if (check_fwfile_format(cardp->fw->data, cardp->fw->size))
829                 goto release_fw;
830
831 restart:
832         if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
833                 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
834                 ret = -1;
835                 goto release_fw;
836         }
837
838         cardp->bootcmdresp = 0;
839         do {
840                 int j = 0;
841                 i++;
842                 /* Issue Boot command = 1, Boot from Download-FW */
843                 if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB);
844                 /* wait for command response */
845                 do {
846                         j++;
847                         msleep_interruptible(100);
848                 } while (cardp->bootcmdresp == 0 && j < 10);
849         } while (cardp->bootcmdresp == 0 && i < 5);
850
851         if (cardp->bootcmdresp <= 0) {
852                 if (--reset_count >= 0) {
853                         if_usb_reset_device(cardp);
854                         goto restart;
855                 }
856                 return -1;
857         }
858
859         i = 0;
860
861         cardp->totalbytes = 0;
862         cardp->fwlastblksent = 0;
863         cardp->CRC_OK = 1;
864         cardp->fwdnldover = 0;
865         cardp->fwseqnum = -1;
866         cardp->totalbytes = 0;
867         cardp->fwfinalblk = 0;
868
869         /* Send the first firmware packet... */
870         if_usb_send_fw_pkt(cardp);
871
872         /* ... and wait for the process to complete */
873         wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover);
874
875         del_timer_sync(&cardp->fw_timeout);
876         usb_kill_urb(cardp->rx_urb);
877
878         if (!cardp->fwdnldover) {
879                 lbs_pr_info("failed to load fw, resetting device!\n");
880                 if (--reset_count >= 0) {
881                         if_usb_reset_device(cardp);
882                         goto restart;
883                 }
884
885                 lbs_pr_info("FW download failure, time = %d ms\n", i * 100);
886                 ret = -1;
887                 goto release_fw;
888         }
889
890  release_fw:
891         release_firmware(cardp->fw);
892         cardp->fw = NULL;
893
894  done:
895         lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
896         return ret;
897 }
898
899
900 #ifdef CONFIG_PM
901 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
902 {
903         struct if_usb_card *cardp = usb_get_intfdata(intf);
904         struct lbs_private *priv = cardp->priv;
905         int ret;
906
907         lbs_deb_enter(LBS_DEB_USB);
908
909         if (priv->psstate != PS_STATE_FULL_POWER)
910                 return -1;
911
912         ret = lbs_suspend(priv);
913         if (ret)
914                 goto out;
915
916         /* Unlink tx & rx urb */
917         usb_kill_urb(cardp->tx_urb);
918         usb_kill_urb(cardp->rx_urb);
919
920  out:
921         lbs_deb_leave(LBS_DEB_USB);
922         return ret;
923 }
924
925 static int if_usb_resume(struct usb_interface *intf)
926 {
927         struct if_usb_card *cardp = usb_get_intfdata(intf);
928         struct lbs_private *priv = cardp->priv;
929
930         lbs_deb_enter(LBS_DEB_USB);
931
932         if_usb_submit_rx_urb(cardp);
933
934         lbs_resume(priv);
935
936         lbs_deb_leave(LBS_DEB_USB);
937         return 0;
938 }
939 #else
940 #define if_usb_suspend NULL
941 #define if_usb_resume NULL
942 #endif
943
944 static struct usb_driver if_usb_driver = {
945         .name = DRV_NAME,
946         .probe = if_usb_probe,
947         .disconnect = if_usb_disconnect,
948         .id_table = if_usb_table,
949         .suspend = if_usb_suspend,
950         .resume = if_usb_resume,
951 };
952
953 static int __init if_usb_init_module(void)
954 {
955         int ret = 0;
956
957         lbs_deb_enter(LBS_DEB_MAIN);
958
959         ret = usb_register(&if_usb_driver);
960
961         lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
962         return ret;
963 }
964
965 static void __exit if_usb_exit_module(void)
966 {
967         lbs_deb_enter(LBS_DEB_MAIN);
968
969         usb_deregister(&if_usb_driver);
970
971         lbs_deb_leave(LBS_DEB_MAIN);
972 }
973
974 module_init(if_usb_init_module);
975 module_exit(if_usb_exit_module);
976
977 MODULE_DESCRIPTION("8388 USB WLAN Driver");
978 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
979 MODULE_LICENSE("GPL");