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_anchored_urbs(&cardp->tx_submitted);
118 usb_kill_anchored_urbs(&cardp->rx_submitted);
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_endpoint_descriptor *ep_in, *ep_out;
197 struct usb_device *udev;
198 struct usb_host_interface *iface_desc;
199 struct lbs_private *priv;
200 struct if_usb_card *cardp;
201 int r = -ENOMEM;
202
203 udev = interface_to_usbdev(intf);
204
205 cardp = kzalloc_obj(struct if_usb_card);
206 if (!cardp)
207 goto error;
208
209 timer_setup(&cardp->fw_timeout, if_usb_fw_timeo, 0);
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 init_usb_anchor(&cardp->rx_submitted);
224 init_usb_anchor(&cardp->tx_submitted);
225
226 if (usb_find_common_endpoints_reverse(iface_desc, &ep_in, &ep_out, NULL, NULL)) {
227 lbs_deb_usbd(&udev->dev, "Endpoints not found\n");
228 goto dealloc;
229 }
230
231 cardp->ep_in_size = usb_endpoint_maxp(ep_in);
232 cardp->ep_in = usb_endpoint_num(ep_in);
233
234 lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in);
235 lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size);
236
237 cardp->ep_out_size = usb_endpoint_maxp(ep_out);
238 cardp->ep_out = usb_endpoint_num(ep_out);
239
240 lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out);
241 lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size);
242
243 if (!cardp->ep_out_size || !cardp->ep_in_size) {
244 lbs_deb_usbd(&udev->dev, "Endpoints not valid\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 priv = lbs_add_card(cardp, &intf->dev);
262 if (IS_ERR(priv)) {
263 r = PTR_ERR(priv);
264 goto err_add_card;
265 }
266
267 cardp->priv = priv;
268
269 priv->hw_host_to_card = if_usb_host_to_card;
270 priv->enter_deep_sleep = NULL;
271 priv->exit_deep_sleep = NULL;
272 priv->reset_deep_sleep_wakeup = NULL;
273 priv->is_polling = false;
274 #ifdef CONFIG_OLPC
275 if (machine_is_olpc())
276 priv->reset_card = if_usb_reset_olpc_card;
277 #endif
278
279 cardp->boot2_version = udev->descriptor.bcdDevice;
280
281 usb_set_intfdata(intf, cardp);
282
283 r = lbs_get_firmware_async(priv, &udev->dev, cardp->model,
284 fw_table, if_usb_prog_firmware);
285 if (r)
286 goto err_get_fw;
287
288 return 0;
289
290 err_get_fw:
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 wake_up(&cardp->fw_wq);
314
315 if (priv) {
316 lbs_stop_card(priv);
317 lbs_remove_card(priv);
318 }
319
320 /* Unlink and free urb */
321 if_usb_free(cardp);
322 kfree(cardp);
323
324 usb_set_intfdata(intf, NULL);
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 /* check if there are pending URBs */
430 if (!usb_anchor_empty(&cardp->tx_submitted)) {
431 lbs_deb_usbd(&cardp->udev->dev, "%s failed: pending URB\n", __func__);
432 ret = -EBUSY;
433 goto tx_ret;
434 }
435
436 usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
437 usb_sndbulkpipe(cardp->udev,
438 cardp->ep_out),
439 payload, nb, if_usb_write_bulk_callback, cardp);
440
441 cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
442
443 usb_anchor_urb(cardp->tx_urb, &cardp->tx_submitted);
444 if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
445 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret);
446 usb_unanchor_urb(cardp->tx_urb);
447 } else {
448 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
449 ret = 0;
450 }
451
452 tx_ret:
453 return ret;
454 }
455
__if_usb_submit_rx_urb(struct if_usb_card * cardp,void (* callbackfn)(struct urb * urb))456 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
457 void (*callbackfn)(struct urb *urb))
458 {
459 struct sk_buff *skb;
460 int ret = -1;
461
462 if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
463 pr_err("No free skb\n");
464 goto rx_ret;
465 }
466
467 cardp->rx_skb = skb;
468
469 /* Fill the receive configuration URB and initialise the Rx call back */
470 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
471 usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
472 skb->data + IPFIELD_ALIGN_OFFSET,
473 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
474 cardp);
475
476 lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb);
477 usb_anchor_urb(cardp->rx_urb, &cardp->rx_submitted);
478 if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
479 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret);
480 usb_unanchor_urb(cardp->rx_urb);
481 kfree_skb(skb);
482 cardp->rx_skb = NULL;
483 ret = -1;
484 } else {
485 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
486 ret = 0;
487 }
488
489 rx_ret:
490 return ret;
491 }
492
if_usb_submit_rx_urb_fwload(struct if_usb_card * cardp)493 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
494 {
495 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
496 }
497
if_usb_submit_rx_urb(struct if_usb_card * cardp)498 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
499 {
500 return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
501 }
502
if_usb_receive_fwload(struct urb * urb)503 static void if_usb_receive_fwload(struct urb *urb)
504 {
505 struct if_usb_card *cardp = urb->context;
506 struct sk_buff *skb = cardp->rx_skb;
507 struct fwsyncheader *syncfwheader;
508 struct bootcmdresp bootcmdresp;
509
510 if (urb->status) {
511 lbs_deb_usbd(&cardp->udev->dev,
512 "URB status is failed during fw load\n");
513 kfree_skb(skb);
514 return;
515 }
516
517 if (cardp->fwdnldover) {
518 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
519
520 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
521 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
522 pr_info("Firmware ready event received\n");
523 wake_up(&cardp->fw_wq);
524 } else {
525 lbs_deb_usb("Waiting for confirmation; got %x %x\n",
526 le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
527 if_usb_submit_rx_urb_fwload(cardp);
528 }
529 kfree_skb(skb);
530 return;
531 }
532 if (cardp->bootcmdresp <= 0) {
533 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
534 sizeof(bootcmdresp));
535
536 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
537 kfree_skb(skb);
538 if_usb_submit_rx_urb_fwload(cardp);
539 cardp->bootcmdresp = BOOT_CMD_RESP_OK;
540 lbs_deb_usbd(&cardp->udev->dev,
541 "Received valid boot command response\n");
542 return;
543 }
544 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
545 if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
546 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
547 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
548 if (!cardp->bootcmdresp)
549 pr_info("Firmware already seems alive; resetting\n");
550 cardp->bootcmdresp = -1;
551 } else {
552 pr_info("boot cmd response wrong magic number (0x%x)\n",
553 le32_to_cpu(bootcmdresp.magic));
554 }
555 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) &&
556 (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) &&
557 (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) {
558 pr_info("boot cmd response cmd_tag error (%d)\n",
559 bootcmdresp.cmd);
560 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) {
561 pr_info("boot cmd response result error (%d)\n",
562 bootcmdresp.result);
563 } else {
564 cardp->bootcmdresp = 1;
565 lbs_deb_usbd(&cardp->udev->dev,
566 "Received valid boot command response\n");
567 }
568 kfree_skb(skb);
569 if_usb_submit_rx_urb_fwload(cardp);
570 return;
571 }
572
573 syncfwheader = kmemdup(skb->data + IPFIELD_ALIGN_OFFSET,
574 sizeof(struct fwsyncheader), GFP_ATOMIC);
575 if (!syncfwheader) {
576 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
577 kfree_skb(skb);
578 return;
579 }
580
581 if (!syncfwheader->cmd) {
582 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n");
583 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n",
584 le32_to_cpu(syncfwheader->seqnum));
585 cardp->CRC_OK = 1;
586 } else {
587 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n");
588 cardp->CRC_OK = 0;
589 }
590
591 kfree_skb(skb);
592
593 /* Give device 5s to either write firmware to its RAM or eeprom */
594 mod_timer(&cardp->fw_timeout, jiffies + (HZ*5));
595
596 if (cardp->fwfinalblk) {
597 cardp->fwdnldover = 1;
598 goto exit;
599 }
600
601 if_usb_send_fw_pkt(cardp);
602
603 exit:
604 if_usb_submit_rx_urb_fwload(cardp);
605
606 kfree(syncfwheader);
607 }
608
609 #define MRVDRV_MIN_PKT_LEN 30
610
process_cmdtypedata(int recvlength,struct sk_buff * skb,struct if_usb_card * cardp,struct lbs_private * priv)611 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
612 struct if_usb_card *cardp,
613 struct lbs_private *priv)
614 {
615 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
616 || recvlength < MRVDRV_MIN_PKT_LEN) {
617 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
618 kfree_skb(skb);
619 return;
620 }
621
622 skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
623 skb_put(skb, recvlength);
624 skb_pull(skb, MESSAGE_HEADER_LEN);
625
626 lbs_process_rxed_packet(priv, skb);
627 }
628
process_cmdrequest(int recvlength,uint8_t * recvbuff,struct sk_buff * skb,struct if_usb_card * cardp,struct lbs_private * priv)629 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
630 struct sk_buff *skb,
631 struct if_usb_card *cardp,
632 struct lbs_private *priv)
633 {
634 unsigned long flags;
635 u8 i;
636
637 if (recvlength < MESSAGE_HEADER_LEN ||
638 recvlength > LBS_CMD_BUFFER_SIZE) {
639 lbs_deb_usbd(&cardp->udev->dev,
640 "The receive buffer is invalid: %d\n", recvlength);
641 kfree_skb(skb);
642 return;
643 }
644
645 spin_lock_irqsave(&priv->driver_lock, flags);
646
647 i = (priv->resp_idx == 0) ? 1 : 0;
648 BUG_ON(priv->resp_len[i]);
649 priv->resp_len[i] = (recvlength - MESSAGE_HEADER_LEN);
650 memcpy(priv->resp_buf[i], recvbuff + MESSAGE_HEADER_LEN,
651 priv->resp_len[i]);
652 dev_kfree_skb_irq(skb);
653 lbs_notify_command_response(priv, i);
654
655 spin_unlock_irqrestore(&priv->driver_lock, flags);
656
657 lbs_deb_usbd(&cardp->udev->dev,
658 "Wake up main thread to handle cmd response\n");
659 }
660
661 /**
662 * if_usb_receive - read the packet into the upload buffer,
663 * wake up the main thread and initialise the Rx callack
664 *
665 * @urb: pointer to &struct urb
666 * returns: N/A
667 */
if_usb_receive(struct urb * urb)668 static void if_usb_receive(struct urb *urb)
669 {
670 struct if_usb_card *cardp = urb->context;
671 struct sk_buff *skb = cardp->rx_skb;
672 struct lbs_private *priv = cardp->priv;
673 int recvlength = urb->actual_length;
674 uint8_t *recvbuff = NULL;
675 uint32_t recvtype = 0;
676 __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
677 uint32_t event;
678
679 if (recvlength) {
680 if (urb->status) {
681 lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n",
682 urb->status);
683 kfree_skb(skb);
684 goto setup_for_next;
685 }
686
687 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
688 recvtype = le32_to_cpu(pkt[0]);
689 lbs_deb_usbd(&cardp->udev->dev,
690 "Recv length = 0x%x, Recv type = 0x%X\n",
691 recvlength, recvtype);
692 } else if (urb->status) {
693 kfree_skb(skb);
694 return;
695 }
696
697 switch (recvtype) {
698 case CMD_TYPE_DATA:
699 process_cmdtypedata(recvlength, skb, cardp, priv);
700 break;
701
702 case CMD_TYPE_REQUEST:
703 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
704 break;
705
706 case CMD_TYPE_INDICATION:
707 /* Event handling */
708 event = le32_to_cpu(pkt[1]);
709 lbs_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n", event);
710 kfree_skb(skb);
711
712 /* Icky undocumented magic special case */
713 if (event & 0xffff0000) {
714 u32 trycount = (event & 0xffff0000) >> 16;
715
716 lbs_send_tx_feedback(priv, trycount);
717 } else
718 lbs_queue_event(priv, event & 0xFF);
719 break;
720
721 default:
722 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
723 recvtype);
724 kfree_skb(skb);
725 break;
726 }
727
728 setup_for_next:
729 if_usb_submit_rx_urb(cardp);
730 }
731
732 /**
733 * if_usb_host_to_card - downloads data to FW
734 * @priv: pointer to &struct lbs_private structure
735 * @type: type of data
736 * @payload: pointer to data buffer
737 * @nb: number of bytes
738 * returns: 0 for success or negative error code
739 */
if_usb_host_to_card(struct lbs_private * priv,uint8_t type,uint8_t * payload,uint16_t nb)740 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
741 uint8_t *payload, uint16_t nb)
742 {
743 struct if_usb_card *cardp = priv->card;
744
745 lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
746 lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
747
748 if (type == MVMS_CMD) {
749 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
750 priv->dnld_sent = DNLD_CMD_SENT;
751 } else {
752 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
753 priv->dnld_sent = DNLD_DATA_SENT;
754 }
755
756 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
757
758 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN);
759 }
760
761 /**
762 * if_usb_issue_boot_command - issues Boot command to the Boot2 code
763 * @cardp: pointer to &if_usb_card
764 * @ivalue: 1:Boot from FW by USB-Download
765 * 2:Boot from FW in EEPROM
766 * returns: 0 for success or negative error code
767 */
if_usb_issue_boot_command(struct if_usb_card * cardp,int ivalue)768 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
769 {
770 struct bootcmd *bootcmd = cardp->ep_out_buf;
771
772 /* Prepare command */
773 bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
774 bootcmd->cmd = ivalue;
775 memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
776
777 /* Issue command */
778 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd));
779
780 return 0;
781 }
782
783
784 /**
785 * check_fwfile_format - check the validity of Boot2/FW image
786 *
787 * @data: pointer to image
788 * @totlen: image length
789 * returns: 0 (good) or 1 (failure)
790 */
check_fwfile_format(const uint8_t * data,uint32_t totlen)791 static int check_fwfile_format(const uint8_t *data, uint32_t totlen)
792 {
793 uint32_t bincmd, exit;
794 uint32_t blksize, offset, len;
795 int ret;
796
797 ret = 1;
798 exit = len = 0;
799
800 do {
801 struct fwheader *fwh = (void *)data;
802
803 bincmd = le32_to_cpu(fwh->dnldcmd);
804 blksize = le32_to_cpu(fwh->datalength);
805 switch (bincmd) {
806 case FW_HAS_DATA_TO_RECV:
807 offset = sizeof(struct fwheader) + blksize;
808 data += offset;
809 len += offset;
810 if (len >= totlen)
811 exit = 1;
812 break;
813 case FW_HAS_LAST_BLOCK:
814 exit = 1;
815 ret = 0;
816 break;
817 default:
818 exit = 1;
819 break;
820 }
821 } while (!exit);
822
823 if (ret)
824 pr_err("firmware file format check FAIL\n");
825 else
826 lbs_deb_fw("firmware file format check PASS\n");
827
828 return ret;
829 }
830
if_usb_prog_firmware(struct lbs_private * priv,int ret,const struct firmware * fw,const struct firmware * unused)831 static void if_usb_prog_firmware(struct lbs_private *priv, int ret,
832 const struct firmware *fw,
833 const struct firmware *unused)
834 {
835 struct if_usb_card *cardp = priv->card;
836 int i = 0;
837 static int reset_count = 10;
838
839 if (ret) {
840 pr_err("failed to find firmware (%d)\n", ret);
841 goto done;
842 }
843
844 cardp->fw = fw;
845 if (check_fwfile_format(cardp->fw->data, cardp->fw->size)) {
846 ret = -EINVAL;
847 goto done;
848 }
849
850 /* Cancel any pending usb business */
851 usb_kill_anchored_urbs(&cardp->rx_submitted);
852 usb_kill_anchored_urbs(&cardp->tx_submitted);
853
854 cardp->fwlastblksent = 0;
855 cardp->fwdnldover = 0;
856 cardp->totalbytes = 0;
857 cardp->fwfinalblk = 0;
858 cardp->bootcmdresp = 0;
859
860 restart:
861 if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
862 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
863 ret = -EIO;
864 goto done;
865 }
866
867 cardp->bootcmdresp = 0;
868 do {
869 int j = 0;
870 i++;
871 if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB);
872 /* wait for command response */
873 do {
874 j++;
875 msleep_interruptible(100);
876 } while (cardp->bootcmdresp == 0 && j < 10);
877 } while (cardp->bootcmdresp == 0 && i < 5);
878
879 if (cardp->bootcmdresp == BOOT_CMD_RESP_NOT_SUPPORTED) {
880 /* Return to normal operation */
881 ret = -EOPNOTSUPP;
882 usb_kill_anchored_urbs(&cardp->rx_submitted);
883 usb_kill_anchored_urbs(&cardp->tx_submitted);
884 if (if_usb_submit_rx_urb(cardp) < 0)
885 ret = -EIO;
886 goto done;
887 } else if (cardp->bootcmdresp <= 0) {
888 if (--reset_count >= 0) {
889 if_usb_reset_device(cardp);
890 goto restart;
891 }
892 ret = -EIO;
893 goto done;
894 }
895
896 i = 0;
897
898 cardp->totalbytes = 0;
899 cardp->fwlastblksent = 0;
900 cardp->CRC_OK = 1;
901 cardp->fwdnldover = 0;
902 cardp->fwseqnum = -1;
903 cardp->totalbytes = 0;
904 cardp->fwfinalblk = 0;
905
906 /* Send the first firmware packet... */
907 if_usb_send_fw_pkt(cardp);
908
909 /* ... and wait for the process to complete */
910 wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover);
911
912 timer_delete_sync(&cardp->fw_timeout);
913 usb_kill_anchored_urbs(&cardp->rx_submitted);
914
915 if (!cardp->fwdnldover) {
916 pr_info("failed to load fw, resetting device!\n");
917 if (--reset_count >= 0) {
918 if_usb_reset_device(cardp);
919 goto restart;
920 }
921
922 pr_info("FW download failure, time = %d ms\n", i * 100);
923 ret = -EIO;
924 goto done;
925 }
926
927 cardp->priv->fw_ready = 1;
928 if_usb_submit_rx_urb(cardp);
929
930 if (lbs_start_card(priv))
931 goto done;
932
933 if_usb_setup_firmware(priv);
934
935 /*
936 * EHS_REMOVE_WAKEUP is not supported on all versions of the firmware.
937 */
938 priv->wol_criteria = EHS_REMOVE_WAKEUP;
939 if (lbs_host_sleep_cfg(priv, priv->wol_criteria, NULL))
940 priv->ehs_remove_supported = false;
941
942 done:
943 cardp->fw = NULL;
944 }
945
946
947 #ifdef CONFIG_PM
if_usb_suspend(struct usb_interface * intf,pm_message_t message)948 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
949 {
950 struct if_usb_card *cardp = usb_get_intfdata(intf);
951 struct lbs_private *priv = cardp->priv;
952 int ret;
953
954 if (priv->psstate != PS_STATE_FULL_POWER) {
955 ret = -1;
956 goto out;
957 }
958
959 #ifdef CONFIG_OLPC
960 if (machine_is_olpc()) {
961 if (priv->wol_criteria == EHS_REMOVE_WAKEUP)
962 olpc_ec_wakeup_clear(EC_SCI_SRC_WLAN);
963 else
964 olpc_ec_wakeup_set(EC_SCI_SRC_WLAN);
965 }
966 #endif
967
968 ret = lbs_suspend(priv);
969 if (ret)
970 goto out;
971
972 /* Unlink tx & rx urb */
973 usb_kill_anchored_urbs(&cardp->tx_submitted);
974 usb_kill_anchored_urbs(&cardp->rx_submitted);
975
976 out:
977 return ret;
978 }
979
if_usb_resume(struct usb_interface * intf)980 static int if_usb_resume(struct usb_interface *intf)
981 {
982 struct if_usb_card *cardp = usb_get_intfdata(intf);
983 struct lbs_private *priv = cardp->priv;
984
985 if_usb_submit_rx_urb(cardp);
986
987 lbs_resume(priv);
988
989 return 0;
990 }
991 #else
992 #define if_usb_suspend NULL
993 #define if_usb_resume NULL
994 #endif
995
996 static struct usb_driver if_usb_driver = {
997 .name = DRV_NAME,
998 .probe = if_usb_probe,
999 .disconnect = if_usb_disconnect,
1000 .id_table = if_usb_table,
1001 .suspend = if_usb_suspend,
1002 .resume = if_usb_resume,
1003 .reset_resume = if_usb_resume,
1004 .disable_hub_initiated_lpm = 1,
1005 };
1006
1007 module_usb_driver(if_usb_driver);
1008
1009 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1010 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
1011 MODULE_LICENSE("GPL");
1012