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