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