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