2 * This file contains functions used in USB interface module.
5 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
19 #define DRV_NAME "usb8xxx"
29 #define lbs_deb_usb2(...) do { if (INSANEDEBUG) lbs_deb_usbd(__VA_ARGS__); } while (0)
31 #define MESSAGE_HEADER_LEN 4
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");
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
}
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 */
62 MODULE_DEVICE_TABLE(usb
, if_usb_table
);
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
,
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
);
78 * if_usb_write_bulk_callback - callback function to handle the status
80 * @urb: pointer to &urb structure
83 static void if_usb_write_bulk_callback(struct urb
*urb
)
85 struct if_usb_card
*cardp
= (struct if_usb_card
*) urb
->context
;
87 /* handle the transmission complete validations */
89 if (urb
->status
== 0) {
90 struct lbs_private
*priv
= cardp
->priv
;
92 lbs_deb_usb2(&urb
->dev
->dev
, "URB status is successful\n");
93 lbs_deb_usb2(&urb
->dev
->dev
, "Actual length transmitted %d\n",
96 /* Boot commands such as UPDATE_FW and UPDATE_BOOT2 are not
97 * passed up to the lbs level.
99 if (priv
&& priv
->dnld_sent
!= DNLD_BOOTCMD_SENT
)
100 lbs_host_to_card_done(priv
);
102 /* print the failure status number for debug */
103 pr_info("URB in failure status: %d\n", urb
->status
);
108 * if_usb_free - free tx/rx urb, skb and rx buffer
109 * @cardp: pointer to &if_usb_card
112 static void if_usb_free(struct if_usb_card
*cardp
)
114 lbs_deb_enter(LBS_DEB_USB
);
116 /* Unlink tx & rx urb */
117 usb_kill_urb(cardp
->tx_urb
);
118 usb_kill_urb(cardp
->rx_urb
);
120 usb_free_urb(cardp
->tx_urb
);
121 cardp
->tx_urb
= NULL
;
123 usb_free_urb(cardp
->rx_urb
);
124 cardp
->rx_urb
= NULL
;
126 kfree(cardp
->ep_out_buf
);
127 cardp
->ep_out_buf
= NULL
;
129 lbs_deb_leave(LBS_DEB_USB
);
132 static void if_usb_setup_firmware(struct lbs_private
*priv
)
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
;
138 b2_cmd
.hdr
.size
= cpu_to_le16(sizeof(b2_cmd
));
140 b2_cmd
.version
= cardp
->boot2_version
;
142 if (lbs_cmd_with_response(priv
, CMD_SET_BOOT2_VER
, &b2_cmd
))
143 lbs_deb_usb("Setting boot2 version failed\n");
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
);
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
;
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");
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");
168 static void if_usb_fw_timeo(unsigned long priv
)
170 struct if_usb_card
*cardp
= (void *)priv
;
172 if (cardp
->fwdnldover
) {
173 lbs_deb_usb("Download complete, no event. Assuming success\n");
175 pr_err("Download timed out\n");
176 cardp
->surprise_removed
= 1;
178 wake_up(&cardp
->fw_wq
);
182 static void if_usb_reset_olpc_card(struct lbs_private
*priv
)
184 printk(KERN_CRIT
"Resetting OLPC wireless via EC...\n");
185 olpc_ec_cmd(0x25, NULL
, 0, NULL
, 0);
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
195 static int if_usb_probe(struct usb_interface
*intf
,
196 const struct usb_device_id
*id
)
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
;
206 udev
= interface_to_usbdev(intf
);
208 cardp
= kzalloc(sizeof(struct if_usb_card
), GFP_KERNEL
);
212 setup_timer(&cardp
->fw_timeout
, if_usb_fw_timeo
, (unsigned long)cardp
);
213 init_waitqueue_head(&cardp
->fw_wq
);
216 cardp
->model
= (uint32_t) id
->driver_info
;
217 iface_desc
= intf
->cur_altsetting
;
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
);
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
);
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
);
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
);
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
);
243 if (!cardp
->ep_out_size
|| !cardp
->ep_in_size
) {
244 lbs_deb_usbd(&udev
->dev
, "Endpoints not found\n");
247 if (!(cardp
->rx_urb
= usb_alloc_urb(0, GFP_KERNEL
))) {
248 lbs_deb_usbd(&udev
->dev
, "Rx URB allocation failed\n");
251 if (!(cardp
->tx_urb
= usb_alloc_urb(0, GFP_KERNEL
))) {
252 lbs_deb_usbd(&udev
->dev
, "Tx URB allocation failed\n");
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");
261 if (!(priv
= lbs_add_card(cardp
, &intf
->dev
)))
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
;
271 if (machine_is_olpc())
272 priv
->reset_card
= if_usb_reset_olpc_card
;
275 cardp
->boot2_version
= udev
->descriptor
.bcdDevice
;
278 usb_set_intfdata(intf
, cardp
);
280 r
= lbs_get_firmware_async(priv
, &udev
->dev
, cardp
->model
,
281 fw_table
, if_usb_prog_firmware
);
288 lbs_remove_card(priv
);
290 if_usb_reset_device(cardp
);
299 * if_usb_disconnect - free resource and cleanup
300 * @intf: USB interface structure
303 static void if_usb_disconnect(struct usb_interface
*intf
)
305 struct if_usb_card
*cardp
= usb_get_intfdata(intf
);
306 struct lbs_private
*priv
= cardp
->priv
;
308 lbs_deb_enter(LBS_DEB_MAIN
);
310 cardp
->surprise_removed
= 1;
314 lbs_remove_card(priv
);
317 /* Unlink and free urb */
320 usb_set_intfdata(intf
, NULL
);
321 usb_put_dev(interface_to_usbdev(intf
));
323 lbs_deb_leave(LBS_DEB_MAIN
);
327 * if_usb_send_fw_pkt - download FW
328 * @cardp: pointer to &struct if_usb_card
331 static int if_usb_send_fw_pkt(struct if_usb_card
*cardp
)
333 struct fwdata
*fwdata
= cardp
->ep_out_buf
;
334 const uint8_t *firmware
= cardp
->fw
->data
;
336 /* If we got a CRC failure on the last block, back
338 if (!cardp
->CRC_OK
) {
339 cardp
->totalbytes
= cardp
->fwlastblksent
;
343 lbs_deb_usb2(&cardp
->udev
->dev
, "totalbytes = %d\n",
346 /* struct fwdata (which we sent to the card) has an
347 extra __le32 field in between the header and the data,
348 which is not in the struct fwheader in the actual
349 firmware binary. Insert the seqnum in the middle... */
350 memcpy(&fwdata
->hdr
, &firmware
[cardp
->totalbytes
],
351 sizeof(struct fwheader
));
353 cardp
->fwlastblksent
= cardp
->totalbytes
;
354 cardp
->totalbytes
+= sizeof(struct fwheader
);
356 memcpy(fwdata
->data
, &firmware
[cardp
->totalbytes
],
357 le32_to_cpu(fwdata
->hdr
.datalength
));
359 lbs_deb_usb2(&cardp
->udev
->dev
, "Data length = %d\n",
360 le32_to_cpu(fwdata
->hdr
.datalength
));
362 fwdata
->seqnum
= cpu_to_le32(++cardp
->fwseqnum
);
363 cardp
->totalbytes
+= le32_to_cpu(fwdata
->hdr
.datalength
);
365 usb_tx_block(cardp
, cardp
->ep_out_buf
, sizeof(struct fwdata
) +
366 le32_to_cpu(fwdata
->hdr
.datalength
));
368 if (fwdata
->hdr
.dnldcmd
== cpu_to_le32(FW_HAS_DATA_TO_RECV
)) {
369 lbs_deb_usb2(&cardp
->udev
->dev
, "There are data to follow\n");
370 lbs_deb_usb2(&cardp
->udev
->dev
, "seqnum = %d totalbytes = %d\n",
371 cardp
->fwseqnum
, cardp
->totalbytes
);
372 } else if (fwdata
->hdr
.dnldcmd
== cpu_to_le32(FW_HAS_LAST_BLOCK
)) {
373 lbs_deb_usb2(&cardp
->udev
->dev
, "Host has finished FW downloading\n");
374 lbs_deb_usb2(&cardp
->udev
->dev
, "Donwloading FW JUMP BLOCK\n");
376 cardp
->fwfinalblk
= 1;
379 lbs_deb_usb2(&cardp
->udev
->dev
, "Firmware download done; size %d\n",
385 static int if_usb_reset_device(struct if_usb_card
*cardp
)
387 struct cmd_header
*cmd
= cardp
->ep_out_buf
+ 4;
390 lbs_deb_enter(LBS_DEB_USB
);
392 *(__le32
*)cardp
->ep_out_buf
= cpu_to_le32(CMD_TYPE_REQUEST
);
394 cmd
->command
= cpu_to_le16(CMD_802_11_RESET
);
395 cmd
->size
= cpu_to_le16(sizeof(cmd
));
396 cmd
->result
= cpu_to_le16(0);
397 cmd
->seqnum
= cpu_to_le16(0x5a5a);
398 usb_tx_block(cardp
, cardp
->ep_out_buf
, 4 + sizeof(struct cmd_header
));
401 ret
= usb_reset_device(cardp
->udev
);
405 if (ret
&& machine_is_olpc())
406 if_usb_reset_olpc_card(NULL
);
409 lbs_deb_leave_args(LBS_DEB_USB
, "ret %d", ret
);
415 * usb_tx_block - transfer the data to the device
416 * @cardp: pointer to &struct if_usb_card
417 * @payload: pointer to payload data
419 * returns: 0 for success or negative error code
421 static int usb_tx_block(struct if_usb_card
*cardp
, uint8_t *payload
, uint16_t nb
)
425 /* check if device is removed */
426 if (cardp
->surprise_removed
) {
427 lbs_deb_usbd(&cardp
->udev
->dev
, "Device removed\n");
432 usb_fill_bulk_urb(cardp
->tx_urb
, cardp
->udev
,
433 usb_sndbulkpipe(cardp
->udev
,
435 payload
, nb
, if_usb_write_bulk_callback
, cardp
);
437 cardp
->tx_urb
->transfer_flags
|= URB_ZERO_PACKET
;
439 if ((ret
= usb_submit_urb(cardp
->tx_urb
, GFP_ATOMIC
))) {
440 lbs_deb_usbd(&cardp
->udev
->dev
, "usb_submit_urb failed: %d\n", ret
);
442 lbs_deb_usb2(&cardp
->udev
->dev
, "usb_submit_urb success\n");
450 static int __if_usb_submit_rx_urb(struct if_usb_card
*cardp
,
451 void (*callbackfn
)(struct urb
*urb
))
456 if (!(skb
= dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
))) {
457 pr_err("No free skb\n");
463 /* Fill the receive configuration URB and initialise the Rx call back */
464 usb_fill_bulk_urb(cardp
->rx_urb
, cardp
->udev
,
465 usb_rcvbulkpipe(cardp
->udev
, cardp
->ep_in
),
466 skb
->data
+ IPFIELD_ALIGN_OFFSET
,
467 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
, callbackfn
,
470 cardp
->rx_urb
->transfer_flags
|= URB_ZERO_PACKET
;
472 lbs_deb_usb2(&cardp
->udev
->dev
, "Pointer for rx_urb %p\n", cardp
->rx_urb
);
473 if ((ret
= usb_submit_urb(cardp
->rx_urb
, GFP_ATOMIC
))) {
474 lbs_deb_usbd(&cardp
->udev
->dev
, "Submit Rx URB failed: %d\n", ret
);
476 cardp
->rx_skb
= NULL
;
479 lbs_deb_usb2(&cardp
->udev
->dev
, "Submit Rx URB success\n");
487 static int if_usb_submit_rx_urb_fwload(struct if_usb_card
*cardp
)
489 return __if_usb_submit_rx_urb(cardp
, &if_usb_receive_fwload
);
492 static int if_usb_submit_rx_urb(struct if_usb_card
*cardp
)
494 return __if_usb_submit_rx_urb(cardp
, &if_usb_receive
);
497 static void if_usb_receive_fwload(struct urb
*urb
)
499 struct if_usb_card
*cardp
= urb
->context
;
500 struct sk_buff
*skb
= cardp
->rx_skb
;
501 struct fwsyncheader
*syncfwheader
;
502 struct bootcmdresp bootcmdresp
;
505 lbs_deb_usbd(&cardp
->udev
->dev
,
506 "URB status is failed during fw load\n");
511 if (cardp
->fwdnldover
) {
512 __le32
*tmp
= (__le32
*)(skb
->data
+ IPFIELD_ALIGN_OFFSET
);
514 if (tmp
[0] == cpu_to_le32(CMD_TYPE_INDICATION
) &&
515 tmp
[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY
)) {
516 pr_info("Firmware ready event received\n");
517 wake_up(&cardp
->fw_wq
);
519 lbs_deb_usb("Waiting for confirmation; got %x %x\n",
520 le32_to_cpu(tmp
[0]), le32_to_cpu(tmp
[1]));
521 if_usb_submit_rx_urb_fwload(cardp
);
526 if (cardp
->bootcmdresp
<= 0) {
527 memcpy (&bootcmdresp
, skb
->data
+ IPFIELD_ALIGN_OFFSET
,
528 sizeof(bootcmdresp
));
530 if (le16_to_cpu(cardp
->udev
->descriptor
.bcdDevice
) < 0x3106) {
532 if_usb_submit_rx_urb_fwload(cardp
);
533 cardp
->bootcmdresp
= BOOT_CMD_RESP_OK
;
534 lbs_deb_usbd(&cardp
->udev
->dev
,
535 "Received valid boot command response\n");
538 if (bootcmdresp
.magic
!= cpu_to_le32(BOOT_CMD_MAGIC_NUMBER
)) {
539 if (bootcmdresp
.magic
== cpu_to_le32(CMD_TYPE_REQUEST
) ||
540 bootcmdresp
.magic
== cpu_to_le32(CMD_TYPE_DATA
) ||
541 bootcmdresp
.magic
== cpu_to_le32(CMD_TYPE_INDICATION
)) {
542 if (!cardp
->bootcmdresp
)
543 pr_info("Firmware already seems alive; resetting\n");
544 cardp
->bootcmdresp
= -1;
546 pr_info("boot cmd response wrong magic number (0x%x)\n",
547 le32_to_cpu(bootcmdresp
.magic
));
549 } else if ((bootcmdresp
.cmd
!= BOOT_CMD_FW_BY_USB
) &&
550 (bootcmdresp
.cmd
!= BOOT_CMD_UPDATE_FW
) &&
551 (bootcmdresp
.cmd
!= BOOT_CMD_UPDATE_BOOT2
)) {
552 pr_info("boot cmd response cmd_tag error (%d)\n",
554 } else if (bootcmdresp
.result
!= BOOT_CMD_RESP_OK
) {
555 pr_info("boot cmd response result error (%d)\n",
558 cardp
->bootcmdresp
= 1;
559 lbs_deb_usbd(&cardp
->udev
->dev
,
560 "Received valid boot command response\n");
563 if_usb_submit_rx_urb_fwload(cardp
);
567 syncfwheader
= kmemdup(skb
->data
+ IPFIELD_ALIGN_OFFSET
,
568 sizeof(struct fwsyncheader
), GFP_ATOMIC
);
570 lbs_deb_usbd(&cardp
->udev
->dev
, "Failure to allocate syncfwheader\n");
575 if (!syncfwheader
->cmd
) {
576 lbs_deb_usb2(&cardp
->udev
->dev
, "FW received Blk with correct CRC\n");
577 lbs_deb_usb2(&cardp
->udev
->dev
, "FW received Blk seqnum = %d\n",
578 le32_to_cpu(syncfwheader
->seqnum
));
581 lbs_deb_usbd(&cardp
->udev
->dev
, "FW received Blk with CRC error\n");
587 /* Give device 5s to either write firmware to its RAM or eeprom */
588 mod_timer(&cardp
->fw_timeout
, jiffies
+ (HZ
*5));
590 if (cardp
->fwfinalblk
) {
591 cardp
->fwdnldover
= 1;
595 if_usb_send_fw_pkt(cardp
);
598 if_usb_submit_rx_urb_fwload(cardp
);
603 #define MRVDRV_MIN_PKT_LEN 30
605 static inline void process_cmdtypedata(int recvlength
, struct sk_buff
*skb
,
606 struct if_usb_card
*cardp
,
607 struct lbs_private
*priv
)
609 if (recvlength
> MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
+ MESSAGE_HEADER_LEN
610 || recvlength
< MRVDRV_MIN_PKT_LEN
) {
611 lbs_deb_usbd(&cardp
->udev
->dev
, "Packet length is Invalid\n");
616 skb_reserve(skb
, IPFIELD_ALIGN_OFFSET
);
617 skb_put(skb
, recvlength
);
618 skb_pull(skb
, MESSAGE_HEADER_LEN
);
620 lbs_process_rxed_packet(priv
, skb
);
623 static inline void process_cmdrequest(int recvlength
, uint8_t *recvbuff
,
625 struct if_usb_card
*cardp
,
626 struct lbs_private
*priv
)
630 if (recvlength
> LBS_CMD_BUFFER_SIZE
) {
631 lbs_deb_usbd(&cardp
->udev
->dev
,
632 "The receive buffer is too large\n");
637 BUG_ON(!in_interrupt());
639 spin_lock(&priv
->driver_lock
);
641 i
= (priv
->resp_idx
== 0) ? 1 : 0;
642 BUG_ON(priv
->resp_len
[i
]);
643 priv
->resp_len
[i
] = (recvlength
- MESSAGE_HEADER_LEN
);
644 memcpy(priv
->resp_buf
[i
], recvbuff
+ MESSAGE_HEADER_LEN
,
647 lbs_notify_command_response(priv
, i
);
649 spin_unlock(&priv
->driver_lock
);
651 lbs_deb_usbd(&cardp
->udev
->dev
,
652 "Wake up main thread to handle cmd response\n");
656 * if_usb_receive - read the packet into the upload buffer,
657 * wake up the main thread and initialise the Rx callack
659 * @urb: pointer to &struct urb
662 static void if_usb_receive(struct urb
*urb
)
664 struct if_usb_card
*cardp
= urb
->context
;
665 struct sk_buff
*skb
= cardp
->rx_skb
;
666 struct lbs_private
*priv
= cardp
->priv
;
667 int recvlength
= urb
->actual_length
;
668 uint8_t *recvbuff
= NULL
;
669 uint32_t recvtype
= 0;
670 __le32
*pkt
= (__le32
*)(skb
->data
+ IPFIELD_ALIGN_OFFSET
);
673 lbs_deb_enter(LBS_DEB_USB
);
677 lbs_deb_usbd(&cardp
->udev
->dev
, "RX URB failed: %d\n",
683 recvbuff
= skb
->data
+ IPFIELD_ALIGN_OFFSET
;
684 recvtype
= le32_to_cpu(pkt
[0]);
685 lbs_deb_usbd(&cardp
->udev
->dev
,
686 "Recv length = 0x%x, Recv type = 0x%X\n",
687 recvlength
, recvtype
);
688 } else if (urb
->status
) {
695 process_cmdtypedata(recvlength
, skb
, cardp
, priv
);
698 case CMD_TYPE_REQUEST
:
699 process_cmdrequest(recvlength
, recvbuff
, skb
, cardp
, priv
);
702 case CMD_TYPE_INDICATION
:
704 event
= le32_to_cpu(pkt
[1]);
705 lbs_deb_usbd(&cardp
->udev
->dev
, "**EVENT** 0x%X\n", event
);
708 /* Icky undocumented magic special case */
709 if (event
& 0xffff0000) {
710 u32 trycount
= (event
& 0xffff0000) >> 16;
712 lbs_send_tx_feedback(priv
, trycount
);
714 lbs_queue_event(priv
, event
& 0xFF);
718 lbs_deb_usbd(&cardp
->udev
->dev
, "Unknown command type 0x%X\n",
725 if_usb_submit_rx_urb(cardp
);
727 lbs_deb_leave(LBS_DEB_USB
);
731 * if_usb_host_to_card - downloads data to FW
732 * @priv: pointer to &struct lbs_private structure
733 * @type: type of data
734 * @payload: pointer to data buffer
735 * @nb: number of bytes
736 * returns: 0 for success or negative error code
738 static int if_usb_host_to_card(struct lbs_private
*priv
, uint8_t type
,
739 uint8_t *payload
, uint16_t nb
)
741 struct if_usb_card
*cardp
= priv
->card
;
743 lbs_deb_usbd(&cardp
->udev
->dev
,"*** type = %u\n", type
);
744 lbs_deb_usbd(&cardp
->udev
->dev
,"size after = %d\n", nb
);
746 if (type
== MVMS_CMD
) {
747 *(__le32
*)cardp
->ep_out_buf
= cpu_to_le32(CMD_TYPE_REQUEST
);
748 priv
->dnld_sent
= DNLD_CMD_SENT
;
750 *(__le32
*)cardp
->ep_out_buf
= cpu_to_le32(CMD_TYPE_DATA
);
751 priv
->dnld_sent
= DNLD_DATA_SENT
;
754 memcpy((cardp
->ep_out_buf
+ MESSAGE_HEADER_LEN
), payload
, nb
);
756 return usb_tx_block(cardp
, cardp
->ep_out_buf
, nb
+ MESSAGE_HEADER_LEN
);
760 * if_usb_issue_boot_command - issues Boot command to the Boot2 code
761 * @cardp: pointer to &if_usb_card
762 * @ivalue: 1:Boot from FW by USB-Download
763 * 2:Boot from FW in EEPROM
764 * returns: 0 for success or negative error code
766 static int if_usb_issue_boot_command(struct if_usb_card
*cardp
, int ivalue
)
768 struct bootcmd
*bootcmd
= cardp
->ep_out_buf
;
770 /* Prepare command */
771 bootcmd
->magic
= cpu_to_le32(BOOT_CMD_MAGIC_NUMBER
);
772 bootcmd
->cmd
= ivalue
;
773 memset(bootcmd
->pad
, 0, sizeof(bootcmd
->pad
));
776 usb_tx_block(cardp
, cardp
->ep_out_buf
, sizeof(*bootcmd
));
783 * check_fwfile_format - check the validity of Boot2/FW image
785 * @data: pointer to image
786 * @totlen: image length
787 * returns: 0 (good) or 1 (failure)
789 static int check_fwfile_format(const uint8_t *data
, uint32_t totlen
)
791 uint32_t bincmd
, exit
;
792 uint32_t blksize
, offset
, len
;
799 struct fwheader
*fwh
= (void *)data
;
801 bincmd
= le32_to_cpu(fwh
->dnldcmd
);
802 blksize
= le32_to_cpu(fwh
->datalength
);
804 case FW_HAS_DATA_TO_RECV
:
805 offset
= sizeof(struct fwheader
) + blksize
;
811 case FW_HAS_LAST_BLOCK
:
822 pr_err("firmware file format check FAIL\n");
824 lbs_deb_fw("firmware file format check PASS\n");
829 static void if_usb_prog_firmware(struct lbs_private
*priv
, int ret
,
830 const struct firmware
*fw
,
831 const struct firmware
*unused
)
833 struct if_usb_card
*cardp
= priv
->card
;
835 static int reset_count
= 10;
837 lbs_deb_enter(LBS_DEB_USB
);
840 pr_err("failed to find firmware (%d)\n", ret
);
845 if (check_fwfile_format(cardp
->fw
->data
, cardp
->fw
->size
)) {
850 /* Cancel any pending usb business */
851 usb_kill_urb(cardp
->rx_urb
);
852 usb_kill_urb(cardp
->tx_urb
);
854 cardp
->fwlastblksent
= 0;
855 cardp
->fwdnldover
= 0;
856 cardp
->totalbytes
= 0;
857 cardp
->fwfinalblk
= 0;
858 cardp
->bootcmdresp
= 0;
861 if (if_usb_submit_rx_urb_fwload(cardp
) < 0) {
862 lbs_deb_usbd(&cardp
->udev
->dev
, "URB submission is failed\n");
867 cardp
->bootcmdresp
= 0;
871 if_usb_issue_boot_command(cardp
, BOOT_CMD_FW_BY_USB
);
872 /* wait for command response */
875 msleep_interruptible(100);
876 } while (cardp
->bootcmdresp
== 0 && j
< 10);
877 } while (cardp
->bootcmdresp
== 0 && i
< 5);
879 if (cardp
->bootcmdresp
== BOOT_CMD_RESP_NOT_SUPPORTED
) {
880 /* Return to normal operation */
882 usb_kill_urb(cardp
->rx_urb
);
883 usb_kill_urb(cardp
->tx_urb
);
884 if (if_usb_submit_rx_urb(cardp
) < 0)
887 } else if (cardp
->bootcmdresp
<= 0) {
888 if (--reset_count
>= 0) {
889 if_usb_reset_device(cardp
);
898 cardp
->totalbytes
= 0;
899 cardp
->fwlastblksent
= 0;
901 cardp
->fwdnldover
= 0;
902 cardp
->fwseqnum
= -1;
903 cardp
->totalbytes
= 0;
904 cardp
->fwfinalblk
= 0;
906 /* Send the first firmware packet... */
907 if_usb_send_fw_pkt(cardp
);
909 /* ... and wait for the process to complete */
910 wait_event_interruptible(cardp
->fw_wq
, cardp
->surprise_removed
|| cardp
->fwdnldover
);
912 del_timer_sync(&cardp
->fw_timeout
);
913 usb_kill_urb(cardp
->rx_urb
);
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
);
922 pr_info("FW download failure, time = %d ms\n", i
* 100);
927 cardp
->priv
->fw_ready
= 1;
928 if_usb_submit_rx_urb(cardp
);
930 if (lbs_start_card(priv
))
933 if_usb_setup_firmware(priv
);
936 * EHS_REMOVE_WAKEUP is not supported on all versions of the firmware.
938 priv
->wol_criteria
= EHS_REMOVE_WAKEUP
;
939 if (lbs_host_sleep_cfg(priv
, priv
->wol_criteria
, NULL
))
940 priv
->ehs_remove_supported
= false;
944 lbs_deb_leave(LBS_DEB_USB
);
949 static int if_usb_suspend(struct usb_interface
*intf
, pm_message_t message
)
951 struct if_usb_card
*cardp
= usb_get_intfdata(intf
);
952 struct lbs_private
*priv
= cardp
->priv
;
955 lbs_deb_enter(LBS_DEB_USB
);
957 if (priv
->psstate
!= PS_STATE_FULL_POWER
) {
963 if (machine_is_olpc()) {
964 if (priv
->wol_criteria
== EHS_REMOVE_WAKEUP
)
965 olpc_ec_wakeup_clear(EC_SCI_SRC_WLAN
);
967 olpc_ec_wakeup_set(EC_SCI_SRC_WLAN
);
971 ret
= lbs_suspend(priv
);
975 /* Unlink tx & rx urb */
976 usb_kill_urb(cardp
->tx_urb
);
977 usb_kill_urb(cardp
->rx_urb
);
980 lbs_deb_leave(LBS_DEB_USB
);
984 static int if_usb_resume(struct usb_interface
*intf
)
986 struct if_usb_card
*cardp
= usb_get_intfdata(intf
);
987 struct lbs_private
*priv
= cardp
->priv
;
989 lbs_deb_enter(LBS_DEB_USB
);
991 if_usb_submit_rx_urb(cardp
);
995 lbs_deb_leave(LBS_DEB_USB
);
999 #define if_usb_suspend NULL
1000 #define if_usb_resume NULL
1003 static struct usb_driver if_usb_driver
= {
1005 .probe
= if_usb_probe
,
1006 .disconnect
= if_usb_disconnect
,
1007 .id_table
= if_usb_table
,
1008 .suspend
= if_usb_suspend
,
1009 .resume
= if_usb_resume
,
1010 .reset_resume
= if_usb_resume
,
1011 .disable_hub_initiated_lpm
= 1,
1014 module_usb_driver(if_usb_driver
);
1016 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1017 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
1018 MODULE_LICENSE("GPL");