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