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