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>
18 #define DRV_NAME "usb8xxx"
28 #define lbs_deb_usb2(...) do { if (INSANEDEBUG) lbs_deb_usbd(__VA_ARGS__); } while (0)
30 #define MESSAGE_HEADER_LEN 4
32 MODULE_FIRMWARE("libertas/usb8388_v9.bin");
33 MODULE_FIRMWARE("libertas/usb8388_v5.bin");
34 MODULE_FIRMWARE("libertas/usb8388.bin");
35 MODULE_FIRMWARE("libertas/usb8682.bin");
36 MODULE_FIRMWARE("usb8388.bin");
44 static struct usb_device_id if_usb_table
[] = {
45 /* Enter the device signature inside */
46 { USB_DEVICE(0x1286, 0x2001), .driver_info
= MODEL_8388
},
47 { USB_DEVICE(0x05a3, 0x8388), .driver_info
= MODEL_8388
},
48 {} /* Terminating entry */
51 MODULE_DEVICE_TABLE(usb
, if_usb_table
);
53 static void if_usb_receive(struct urb
*urb
);
54 static void if_usb_receive_fwload(struct urb
*urb
);
55 static int if_usb_prog_firmware(struct if_usb_card
*cardp
);
56 static int if_usb_host_to_card(struct lbs_private
*priv
, uint8_t type
,
57 uint8_t *payload
, uint16_t nb
);
58 static int usb_tx_block(struct if_usb_card
*cardp
, uint8_t *payload
,
60 static void if_usb_free(struct if_usb_card
*cardp
);
61 static int if_usb_submit_rx_urb(struct if_usb_card
*cardp
);
62 static int if_usb_reset_device(struct if_usb_card
*cardp
);
65 * if_usb_write_bulk_callback - callback function to handle the status
67 * @urb: pointer to &urb structure
70 static void if_usb_write_bulk_callback(struct urb
*urb
)
72 struct if_usb_card
*cardp
= (struct if_usb_card
*) urb
->context
;
74 /* handle the transmission complete validations */
76 if (urb
->status
== 0) {
77 struct lbs_private
*priv
= cardp
->priv
;
79 lbs_deb_usb2(&urb
->dev
->dev
, "URB status is successful\n");
80 lbs_deb_usb2(&urb
->dev
->dev
, "Actual length transmitted %d\n",
83 /* Boot commands such as UPDATE_FW and UPDATE_BOOT2 are not
84 * passed up to the lbs level.
86 if (priv
&& priv
->dnld_sent
!= DNLD_BOOTCMD_SENT
)
87 lbs_host_to_card_done(priv
);
89 /* print the failure status number for debug */
90 pr_info("URB in failure status: %d\n", urb
->status
);
95 * if_usb_free - free tx/rx urb, skb and rx buffer
96 * @cardp: pointer to &if_usb_card
99 static void if_usb_free(struct if_usb_card
*cardp
)
101 lbs_deb_enter(LBS_DEB_USB
);
103 /* Unlink tx & rx urb */
104 usb_kill_urb(cardp
->tx_urb
);
105 usb_kill_urb(cardp
->rx_urb
);
107 usb_free_urb(cardp
->tx_urb
);
108 cardp
->tx_urb
= NULL
;
110 usb_free_urb(cardp
->rx_urb
);
111 cardp
->rx_urb
= NULL
;
113 kfree(cardp
->ep_out_buf
);
114 cardp
->ep_out_buf
= NULL
;
116 lbs_deb_leave(LBS_DEB_USB
);
119 static void if_usb_setup_firmware(struct lbs_private
*priv
)
121 struct if_usb_card
*cardp
= priv
->card
;
122 struct cmd_ds_set_boot2_ver b2_cmd
;
123 struct cmd_ds_802_11_fw_wake_method wake_method
;
125 b2_cmd
.hdr
.size
= cpu_to_le16(sizeof(b2_cmd
));
127 b2_cmd
.version
= cardp
->boot2_version
;
129 if (lbs_cmd_with_response(priv
, CMD_SET_BOOT2_VER
, &b2_cmd
))
130 lbs_deb_usb("Setting boot2 version failed\n");
132 priv
->wol_gpio
= 2; /* Wake via GPIO2... */
133 priv
->wol_gap
= 20; /* ... after 20ms */
134 lbs_host_sleep_cfg(priv
, EHS_WAKE_ON_UNICAST_DATA
,
135 (struct wol_config
*) NULL
);
137 wake_method
.hdr
.size
= cpu_to_le16(sizeof(wake_method
));
138 wake_method
.action
= cpu_to_le16(CMD_ACT_GET
);
139 if (lbs_cmd_with_response(priv
, CMD_802_11_FW_WAKE_METHOD
, &wake_method
)) {
140 netdev_info(priv
->dev
, "Firmware does not seem to support PS mode\n");
141 priv
->fwcapinfo
&= ~FW_CAPINFO_PS
;
143 if (le16_to_cpu(wake_method
.method
) == CMD_WAKE_METHOD_COMMAND_INT
) {
144 lbs_deb_usb("Firmware seems to support PS with wake-via-command\n");
146 /* The versions which boot up this way don't seem to
147 work even if we set it to the command interrupt */
148 priv
->fwcapinfo
&= ~FW_CAPINFO_PS
;
149 netdev_info(priv
->dev
,
150 "Firmware doesn't wake via command interrupt; disabling PS mode\n");
155 static void if_usb_fw_timeo(unsigned long priv
)
157 struct if_usb_card
*cardp
= (void *)priv
;
159 if (cardp
->fwdnldover
) {
160 lbs_deb_usb("Download complete, no event. Assuming success\n");
162 pr_err("Download timed out\n");
163 cardp
->surprise_removed
= 1;
165 wake_up(&cardp
->fw_wq
);
169 static void if_usb_reset_olpc_card(struct lbs_private
*priv
)
171 printk(KERN_CRIT
"Resetting OLPC wireless via EC...\n");
172 olpc_ec_cmd(0x25, NULL
, 0, NULL
, 0);
177 * if_usb_probe - sets the configuration values
178 * @intf: &usb_interface pointer
179 * @id: pointer to usb_device_id
180 * returns: 0 on success, error code on failure
182 static int if_usb_probe(struct usb_interface
*intf
,
183 const struct usb_device_id
*id
)
185 struct usb_device
*udev
;
186 struct usb_host_interface
*iface_desc
;
187 struct usb_endpoint_descriptor
*endpoint
;
188 struct lbs_private
*priv
;
189 struct if_usb_card
*cardp
;
192 udev
= interface_to_usbdev(intf
);
194 cardp
= kzalloc(sizeof(struct if_usb_card
), GFP_KERNEL
);
198 setup_timer(&cardp
->fw_timeout
, if_usb_fw_timeo
, (unsigned long)cardp
);
199 init_waitqueue_head(&cardp
->fw_wq
);
202 cardp
->model
= (uint32_t) id
->driver_info
;
203 iface_desc
= intf
->cur_altsetting
;
205 lbs_deb_usbd(&udev
->dev
, "bcdUSB = 0x%X bDeviceClass = 0x%X"
206 " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
207 le16_to_cpu(udev
->descriptor
.bcdUSB
),
208 udev
->descriptor
.bDeviceClass
,
209 udev
->descriptor
.bDeviceSubClass
,
210 udev
->descriptor
.bDeviceProtocol
);
212 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
213 endpoint
= &iface_desc
->endpoint
[i
].desc
;
214 if (usb_endpoint_is_bulk_in(endpoint
)) {
215 cardp
->ep_in_size
= le16_to_cpu(endpoint
->wMaxPacketSize
);
216 cardp
->ep_in
= usb_endpoint_num(endpoint
);
218 lbs_deb_usbd(&udev
->dev
, "in_endpoint = %d\n", cardp
->ep_in
);
219 lbs_deb_usbd(&udev
->dev
, "Bulk in size is %d\n", cardp
->ep_in_size
);
221 } else if (usb_endpoint_is_bulk_out(endpoint
)) {
222 cardp
->ep_out_size
= le16_to_cpu(endpoint
->wMaxPacketSize
);
223 cardp
->ep_out
= usb_endpoint_num(endpoint
);
225 lbs_deb_usbd(&udev
->dev
, "out_endpoint = %d\n", cardp
->ep_out
);
226 lbs_deb_usbd(&udev
->dev
, "Bulk out size is %d\n", cardp
->ep_out_size
);
229 if (!cardp
->ep_out_size
|| !cardp
->ep_in_size
) {
230 lbs_deb_usbd(&udev
->dev
, "Endpoints not found\n");
233 if (!(cardp
->rx_urb
= usb_alloc_urb(0, GFP_KERNEL
))) {
234 lbs_deb_usbd(&udev
->dev
, "Rx URB allocation failed\n");
237 if (!(cardp
->tx_urb
= usb_alloc_urb(0, GFP_KERNEL
))) {
238 lbs_deb_usbd(&udev
->dev
, "Tx URB allocation failed\n");
241 cardp
->ep_out_buf
= kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE
, GFP_KERNEL
);
242 if (!cardp
->ep_out_buf
) {
243 lbs_deb_usbd(&udev
->dev
, "Could not allocate buffer\n");
247 /* Upload firmware */
248 if (if_usb_prog_firmware(cardp
)) {
249 lbs_deb_usbd(&udev
->dev
, "FW upload failed\n");
250 goto err_prog_firmware
;
253 if (!(priv
= lbs_add_card(cardp
, &intf
->dev
)))
254 goto err_prog_firmware
;
257 cardp
->priv
->fw_ready
= 1;
259 priv
->hw_host_to_card
= if_usb_host_to_card
;
260 priv
->enter_deep_sleep
= NULL
;
261 priv
->exit_deep_sleep
= NULL
;
262 priv
->reset_deep_sleep_wakeup
= NULL
;
264 if (machine_is_olpc())
265 priv
->reset_card
= if_usb_reset_olpc_card
;
268 cardp
->boot2_version
= udev
->descriptor
.bcdDevice
;
270 if_usb_submit_rx_urb(cardp
);
272 if (lbs_start_card(priv
))
275 if_usb_setup_firmware(priv
);
278 usb_set_intfdata(intf
, cardp
);
281 * EHS_REMOVE_WAKEUP is not supported on all versions of the firmware.
283 priv
->wol_criteria
= EHS_REMOVE_WAKEUP
;
284 if (lbs_host_sleep_cfg(priv
, priv
->wol_criteria
, NULL
))
285 priv
->ehs_remove_supported
= false;
290 lbs_remove_card(priv
);
292 if_usb_reset_device(cardp
);
301 * if_usb_disconnect - free resource and cleanup
302 * @intf: USB interface structure
305 static void if_usb_disconnect(struct usb_interface
*intf
)
307 struct if_usb_card
*cardp
= usb_get_intfdata(intf
);
308 struct lbs_private
*priv
= (struct lbs_private
*) cardp
->priv
;
310 lbs_deb_enter(LBS_DEB_MAIN
);
312 cardp
->surprise_removed
= 1;
315 priv
->surpriseremoved
= 1;
317 lbs_remove_card(priv
);
320 /* Unlink and free urb */
323 usb_set_intfdata(intf
, NULL
);
324 usb_put_dev(interface_to_usbdev(intf
));
326 lbs_deb_leave(LBS_DEB_MAIN
);
330 * if_usb_send_fw_pkt - download FW
331 * @cardp: pointer to &struct if_usb_card
334 static int if_usb_send_fw_pkt(struct if_usb_card
*cardp
)
336 struct fwdata
*fwdata
= cardp
->ep_out_buf
;
337 const uint8_t *firmware
= cardp
->fw
->data
;
339 /* If we got a CRC failure on the last block, back
341 if (!cardp
->CRC_OK
) {
342 cardp
->totalbytes
= cardp
->fwlastblksent
;
346 lbs_deb_usb2(&cardp
->udev
->dev
, "totalbytes = %d\n",
349 /* struct fwdata (which we sent to the card) has an
350 extra __le32 field in between the header and the data,
351 which is not in the struct fwheader in the actual
352 firmware binary. Insert the seqnum in the middle... */
353 memcpy(&fwdata
->hdr
, &firmware
[cardp
->totalbytes
],
354 sizeof(struct fwheader
));
356 cardp
->fwlastblksent
= cardp
->totalbytes
;
357 cardp
->totalbytes
+= sizeof(struct fwheader
);
359 memcpy(fwdata
->data
, &firmware
[cardp
->totalbytes
],
360 le32_to_cpu(fwdata
->hdr
.datalength
));
362 lbs_deb_usb2(&cardp
->udev
->dev
, "Data length = %d\n",
363 le32_to_cpu(fwdata
->hdr
.datalength
));
365 fwdata
->seqnum
= cpu_to_le32(++cardp
->fwseqnum
);
366 cardp
->totalbytes
+= le32_to_cpu(fwdata
->hdr
.datalength
);
368 usb_tx_block(cardp
, cardp
->ep_out_buf
, sizeof(struct fwdata
) +
369 le32_to_cpu(fwdata
->hdr
.datalength
));
371 if (fwdata
->hdr
.dnldcmd
== cpu_to_le32(FW_HAS_DATA_TO_RECV
)) {
372 lbs_deb_usb2(&cardp
->udev
->dev
, "There are data to follow\n");
373 lbs_deb_usb2(&cardp
->udev
->dev
, "seqnum = %d totalbytes = %d\n",
374 cardp
->fwseqnum
, cardp
->totalbytes
);
375 } else if (fwdata
->hdr
.dnldcmd
== cpu_to_le32(FW_HAS_LAST_BLOCK
)) {
376 lbs_deb_usb2(&cardp
->udev
->dev
, "Host has finished FW downloading\n");
377 lbs_deb_usb2(&cardp
->udev
->dev
, "Donwloading FW JUMP BLOCK\n");
379 cardp
->fwfinalblk
= 1;
382 lbs_deb_usb2(&cardp
->udev
->dev
, "Firmware download done; size %d\n",
388 static int if_usb_reset_device(struct if_usb_card
*cardp
)
390 struct cmd_header
*cmd
= cardp
->ep_out_buf
+ 4;
393 lbs_deb_enter(LBS_DEB_USB
);
395 *(__le32
*)cardp
->ep_out_buf
= cpu_to_le32(CMD_TYPE_REQUEST
);
397 cmd
->command
= cpu_to_le16(CMD_802_11_RESET
);
398 cmd
->size
= cpu_to_le16(sizeof(cmd
));
399 cmd
->result
= cpu_to_le16(0);
400 cmd
->seqnum
= cpu_to_le16(0x5a5a);
401 usb_tx_block(cardp
, cardp
->ep_out_buf
, 4 + sizeof(struct cmd_header
));
404 ret
= usb_reset_device(cardp
->udev
);
408 if (ret
&& machine_is_olpc())
409 if_usb_reset_olpc_card(NULL
);
412 lbs_deb_leave_args(LBS_DEB_USB
, "ret %d", ret
);
418 * usb_tx_block - transfer the data to the device
419 * @cardp: pointer to &struct if_usb_card
420 * @payload: pointer to payload data
422 * returns: 0 for success or negative error code
424 static int usb_tx_block(struct if_usb_card
*cardp
, uint8_t *payload
, uint16_t nb
)
428 /* check if device is removed */
429 if (cardp
->surprise_removed
) {
430 lbs_deb_usbd(&cardp
->udev
->dev
, "Device removed\n");
435 usb_fill_bulk_urb(cardp
->tx_urb
, cardp
->udev
,
436 usb_sndbulkpipe(cardp
->udev
,
438 payload
, nb
, if_usb_write_bulk_callback
, cardp
);
440 cardp
->tx_urb
->transfer_flags
|= URB_ZERO_PACKET
;
442 if ((ret
= usb_submit_urb(cardp
->tx_urb
, GFP_ATOMIC
))) {
443 lbs_deb_usbd(&cardp
->udev
->dev
, "usb_submit_urb failed: %d\n", ret
);
445 lbs_deb_usb2(&cardp
->udev
->dev
, "usb_submit_urb success\n");
453 static int __if_usb_submit_rx_urb(struct if_usb_card
*cardp
,
454 void (*callbackfn
)(struct urb
*urb
))
459 if (!(skb
= dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
))) {
460 pr_err("No free skb\n");
466 /* Fill the receive configuration URB and initialise the Rx call back */
467 usb_fill_bulk_urb(cardp
->rx_urb
, cardp
->udev
,
468 usb_rcvbulkpipe(cardp
->udev
, cardp
->ep_in
),
469 skb
->data
+ IPFIELD_ALIGN_OFFSET
,
470 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
, callbackfn
,
473 cardp
->rx_urb
->transfer_flags
|= URB_ZERO_PACKET
;
475 lbs_deb_usb2(&cardp
->udev
->dev
, "Pointer for rx_urb %p\n", cardp
->rx_urb
);
476 if ((ret
= usb_submit_urb(cardp
->rx_urb
, GFP_ATOMIC
))) {
477 lbs_deb_usbd(&cardp
->udev
->dev
, "Submit Rx URB failed: %d\n", ret
);
479 cardp
->rx_skb
= NULL
;
482 lbs_deb_usb2(&cardp
->udev
->dev
, "Submit Rx URB success\n");
490 static int if_usb_submit_rx_urb_fwload(struct if_usb_card
*cardp
)
492 return __if_usb_submit_rx_urb(cardp
, &if_usb_receive_fwload
);
495 static int if_usb_submit_rx_urb(struct if_usb_card
*cardp
)
497 return __if_usb_submit_rx_urb(cardp
, &if_usb_receive
);
500 static void if_usb_receive_fwload(struct urb
*urb
)
502 struct if_usb_card
*cardp
= urb
->context
;
503 struct sk_buff
*skb
= cardp
->rx_skb
;
504 struct fwsyncheader
*syncfwheader
;
505 struct bootcmdresp bootcmdresp
;
508 lbs_deb_usbd(&cardp
->udev
->dev
,
509 "URB status is failed during fw load\n");
514 if (cardp
->fwdnldover
) {
515 __le32
*tmp
= (__le32
*)(skb
->data
+ IPFIELD_ALIGN_OFFSET
);
517 if (tmp
[0] == cpu_to_le32(CMD_TYPE_INDICATION
) &&
518 tmp
[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY
)) {
519 pr_info("Firmware ready event received\n");
520 wake_up(&cardp
->fw_wq
);
522 lbs_deb_usb("Waiting for confirmation; got %x %x\n",
523 le32_to_cpu(tmp
[0]), le32_to_cpu(tmp
[1]));
524 if_usb_submit_rx_urb_fwload(cardp
);
529 if (cardp
->bootcmdresp
<= 0) {
530 memcpy (&bootcmdresp
, skb
->data
+ IPFIELD_ALIGN_OFFSET
,
531 sizeof(bootcmdresp
));
533 if (le16_to_cpu(cardp
->udev
->descriptor
.bcdDevice
) < 0x3106) {
535 if_usb_submit_rx_urb_fwload(cardp
);
536 cardp
->bootcmdresp
= BOOT_CMD_RESP_OK
;
537 lbs_deb_usbd(&cardp
->udev
->dev
,
538 "Received valid boot command response\n");
541 if (bootcmdresp
.magic
!= cpu_to_le32(BOOT_CMD_MAGIC_NUMBER
)) {
542 if (bootcmdresp
.magic
== cpu_to_le32(CMD_TYPE_REQUEST
) ||
543 bootcmdresp
.magic
== cpu_to_le32(CMD_TYPE_DATA
) ||
544 bootcmdresp
.magic
== cpu_to_le32(CMD_TYPE_INDICATION
)) {
545 if (!cardp
->bootcmdresp
)
546 pr_info("Firmware already seems alive; resetting\n");
547 cardp
->bootcmdresp
= -1;
549 pr_info("boot cmd response wrong magic number (0x%x)\n",
550 le32_to_cpu(bootcmdresp
.magic
));
552 } else if ((bootcmdresp
.cmd
!= BOOT_CMD_FW_BY_USB
) &&
553 (bootcmdresp
.cmd
!= BOOT_CMD_UPDATE_FW
) &&
554 (bootcmdresp
.cmd
!= BOOT_CMD_UPDATE_BOOT2
)) {
555 pr_info("boot cmd response cmd_tag error (%d)\n",
557 } else if (bootcmdresp
.result
!= BOOT_CMD_RESP_OK
) {
558 pr_info("boot cmd response result error (%d)\n",
561 cardp
->bootcmdresp
= 1;
562 lbs_deb_usbd(&cardp
->udev
->dev
,
563 "Received valid boot command response\n");
566 if_usb_submit_rx_urb_fwload(cardp
);
570 syncfwheader
= kmemdup(skb
->data
+ IPFIELD_ALIGN_OFFSET
,
571 sizeof(struct fwsyncheader
), GFP_ATOMIC
);
573 lbs_deb_usbd(&cardp
->udev
->dev
, "Failure to allocate syncfwheader\n");
578 if (!syncfwheader
->cmd
) {
579 lbs_deb_usb2(&cardp
->udev
->dev
, "FW received Blk with correct CRC\n");
580 lbs_deb_usb2(&cardp
->udev
->dev
, "FW received Blk seqnum = %d\n",
581 le32_to_cpu(syncfwheader
->seqnum
));
584 lbs_deb_usbd(&cardp
->udev
->dev
, "FW received Blk with CRC error\n");
590 /* Give device 5s to either write firmware to its RAM or eeprom */
591 mod_timer(&cardp
->fw_timeout
, jiffies
+ (HZ
*5));
593 if (cardp
->fwfinalblk
) {
594 cardp
->fwdnldover
= 1;
598 if_usb_send_fw_pkt(cardp
);
601 if_usb_submit_rx_urb_fwload(cardp
);
606 #define MRVDRV_MIN_PKT_LEN 30
608 static inline void process_cmdtypedata(int recvlength
, struct sk_buff
*skb
,
609 struct if_usb_card
*cardp
,
610 struct lbs_private
*priv
)
612 if (recvlength
> MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
+ MESSAGE_HEADER_LEN
613 || recvlength
< MRVDRV_MIN_PKT_LEN
) {
614 lbs_deb_usbd(&cardp
->udev
->dev
, "Packet length is Invalid\n");
619 skb_reserve(skb
, IPFIELD_ALIGN_OFFSET
);
620 skb_put(skb
, recvlength
);
621 skb_pull(skb
, MESSAGE_HEADER_LEN
);
623 lbs_process_rxed_packet(priv
, skb
);
626 static inline void process_cmdrequest(int recvlength
, uint8_t *recvbuff
,
628 struct if_usb_card
*cardp
,
629 struct lbs_private
*priv
)
633 if (recvlength
> LBS_CMD_BUFFER_SIZE
) {
634 lbs_deb_usbd(&cardp
->udev
->dev
,
635 "The receive buffer is too large\n");
640 BUG_ON(!in_interrupt());
642 spin_lock(&priv
->driver_lock
);
644 i
= (priv
->resp_idx
== 0) ? 1 : 0;
645 BUG_ON(priv
->resp_len
[i
]);
646 priv
->resp_len
[i
] = (recvlength
- MESSAGE_HEADER_LEN
);
647 memcpy(priv
->resp_buf
[i
], recvbuff
+ MESSAGE_HEADER_LEN
,
650 lbs_notify_command_response(priv
, i
);
652 spin_unlock(&priv
->driver_lock
);
654 lbs_deb_usbd(&cardp
->udev
->dev
,
655 "Wake up main thread to handle cmd response\n");
659 * if_usb_receive - read the packet into the upload buffer,
660 * wake up the main thread and initialise the Rx callack
662 * @urb: pointer to &struct urb
665 static void if_usb_receive(struct urb
*urb
)
667 struct if_usb_card
*cardp
= urb
->context
;
668 struct sk_buff
*skb
= cardp
->rx_skb
;
669 struct lbs_private
*priv
= cardp
->priv
;
670 int recvlength
= urb
->actual_length
;
671 uint8_t *recvbuff
= NULL
;
672 uint32_t recvtype
= 0;
673 __le32
*pkt
= (__le32
*)(skb
->data
+ IPFIELD_ALIGN_OFFSET
);
676 lbs_deb_enter(LBS_DEB_USB
);
680 lbs_deb_usbd(&cardp
->udev
->dev
, "RX URB failed: %d\n",
686 recvbuff
= skb
->data
+ IPFIELD_ALIGN_OFFSET
;
687 recvtype
= le32_to_cpu(pkt
[0]);
688 lbs_deb_usbd(&cardp
->udev
->dev
,
689 "Recv length = 0x%x, Recv type = 0x%X\n",
690 recvlength
, recvtype
);
691 } else if (urb
->status
) {
698 process_cmdtypedata(recvlength
, skb
, cardp
, priv
);
701 case CMD_TYPE_REQUEST
:
702 process_cmdrequest(recvlength
, recvbuff
, skb
, cardp
, priv
);
705 case CMD_TYPE_INDICATION
:
707 event
= le32_to_cpu(pkt
[1]);
708 lbs_deb_usbd(&cardp
->udev
->dev
, "**EVENT** 0x%X\n", event
);
711 /* Icky undocumented magic special case */
712 if (event
& 0xffff0000) {
713 u32 trycount
= (event
& 0xffff0000) >> 16;
715 lbs_send_tx_feedback(priv
, trycount
);
717 lbs_queue_event(priv
, event
& 0xFF);
721 lbs_deb_usbd(&cardp
->udev
->dev
, "Unknown command type 0x%X\n",
728 if_usb_submit_rx_urb(cardp
);
730 lbs_deb_leave(LBS_DEB_USB
);
734 * if_usb_host_to_card - downloads data to FW
735 * @priv: pointer to &struct lbs_private structure
736 * @type: type of data
737 * @payload: pointer to data buffer
738 * @nb: number of bytes
739 * returns: 0 for success or negative error code
741 static int if_usb_host_to_card(struct lbs_private
*priv
, uint8_t type
,
742 uint8_t *payload
, uint16_t nb
)
744 struct if_usb_card
*cardp
= priv
->card
;
746 lbs_deb_usbd(&cardp
->udev
->dev
,"*** type = %u\n", type
);
747 lbs_deb_usbd(&cardp
->udev
->dev
,"size after = %d\n", nb
);
749 if (type
== MVMS_CMD
) {
750 *(__le32
*)cardp
->ep_out_buf
= cpu_to_le32(CMD_TYPE_REQUEST
);
751 priv
->dnld_sent
= DNLD_CMD_SENT
;
753 *(__le32
*)cardp
->ep_out_buf
= cpu_to_le32(CMD_TYPE_DATA
);
754 priv
->dnld_sent
= DNLD_DATA_SENT
;
757 memcpy((cardp
->ep_out_buf
+ MESSAGE_HEADER_LEN
), payload
, nb
);
759 return usb_tx_block(cardp
, cardp
->ep_out_buf
, nb
+ MESSAGE_HEADER_LEN
);
763 * if_usb_issue_boot_command - issues Boot command to the Boot2 code
764 * @cardp: pointer to &if_usb_card
765 * @ivalue: 1:Boot from FW by USB-Download
766 * 2:Boot from FW in EEPROM
767 * returns: 0 for success or negative error code
769 static int if_usb_issue_boot_command(struct if_usb_card
*cardp
, int ivalue
)
771 struct bootcmd
*bootcmd
= cardp
->ep_out_buf
;
773 /* Prepare command */
774 bootcmd
->magic
= cpu_to_le32(BOOT_CMD_MAGIC_NUMBER
);
775 bootcmd
->cmd
= ivalue
;
776 memset(bootcmd
->pad
, 0, sizeof(bootcmd
->pad
));
779 usb_tx_block(cardp
, cardp
->ep_out_buf
, sizeof(*bootcmd
));
786 * check_fwfile_format - check the validity of Boot2/FW image
788 * @data: pointer to image
789 * @totlen: image length
790 * returns: 0 (good) or 1 (failure)
792 static int check_fwfile_format(const uint8_t *data
, uint32_t totlen
)
794 uint32_t bincmd
, exit
;
795 uint32_t blksize
, offset
, len
;
802 struct fwheader
*fwh
= (void *)data
;
804 bincmd
= le32_to_cpu(fwh
->dnldcmd
);
805 blksize
= le32_to_cpu(fwh
->datalength
);
807 case FW_HAS_DATA_TO_RECV
:
808 offset
= sizeof(struct fwheader
) + blksize
;
814 case FW_HAS_LAST_BLOCK
:
825 pr_err("firmware file format check FAIL\n");
827 lbs_deb_fw("firmware file format check PASS\n");
832 /* table of firmware file names */
833 static const struct {
837 { MODEL_8388
, "libertas/usb8388_olpc.bin" },
838 { MODEL_8388
, "libertas/usb8388_v9.bin" },
839 { MODEL_8388
, "libertas/usb8388_v5.bin" },
840 { MODEL_8388
, "libertas/usb8388.bin" },
841 { MODEL_8388
, "usb8388.bin" },
842 { MODEL_8682
, "libertas/usb8682.bin" }
845 static int get_fw(struct if_usb_card
*cardp
)
849 /* Otherwise search for firmware to use */
850 for (i
= 0; i
< ARRAY_SIZE(fw_table
); i
++) {
851 if (fw_table
[i
].model
!= cardp
->model
)
853 if (request_firmware(&cardp
->fw
, fw_table
[i
].fwname
,
854 &cardp
->udev
->dev
) == 0)
861 static int if_usb_prog_firmware(struct if_usb_card
*cardp
)
864 static int reset_count
= 10;
867 lbs_deb_enter(LBS_DEB_USB
);
871 pr_err("failed to find firmware (%d)\n", ret
);
875 if (check_fwfile_format(cardp
->fw
->data
, cardp
->fw
->size
)) {
880 /* Cancel any pending usb business */
881 usb_kill_urb(cardp
->rx_urb
);
882 usb_kill_urb(cardp
->tx_urb
);
884 cardp
->fwlastblksent
= 0;
885 cardp
->fwdnldover
= 0;
886 cardp
->totalbytes
= 0;
887 cardp
->fwfinalblk
= 0;
888 cardp
->bootcmdresp
= 0;
891 if (if_usb_submit_rx_urb_fwload(cardp
) < 0) {
892 lbs_deb_usbd(&cardp
->udev
->dev
, "URB submission is failed\n");
897 cardp
->bootcmdresp
= 0;
901 if_usb_issue_boot_command(cardp
, BOOT_CMD_FW_BY_USB
);
902 /* wait for command response */
905 msleep_interruptible(100);
906 } while (cardp
->bootcmdresp
== 0 && j
< 10);
907 } while (cardp
->bootcmdresp
== 0 && i
< 5);
909 if (cardp
->bootcmdresp
== BOOT_CMD_RESP_NOT_SUPPORTED
) {
910 /* Return to normal operation */
912 usb_kill_urb(cardp
->rx_urb
);
913 usb_kill_urb(cardp
->tx_urb
);
914 if (if_usb_submit_rx_urb(cardp
) < 0)
917 } else if (cardp
->bootcmdresp
<= 0) {
918 if (--reset_count
>= 0) {
919 if_usb_reset_device(cardp
);
928 cardp
->totalbytes
= 0;
929 cardp
->fwlastblksent
= 0;
931 cardp
->fwdnldover
= 0;
932 cardp
->fwseqnum
= -1;
933 cardp
->totalbytes
= 0;
934 cardp
->fwfinalblk
= 0;
936 /* Send the first firmware packet... */
937 if_usb_send_fw_pkt(cardp
);
939 /* ... and wait for the process to complete */
940 wait_event_interruptible(cardp
->fw_wq
, cardp
->surprise_removed
|| cardp
->fwdnldover
);
942 del_timer_sync(&cardp
->fw_timeout
);
943 usb_kill_urb(cardp
->rx_urb
);
945 if (!cardp
->fwdnldover
) {
946 pr_info("failed to load fw, resetting device!\n");
947 if (--reset_count
>= 0) {
948 if_usb_reset_device(cardp
);
952 pr_info("FW download failure, time = %d ms\n", i
* 100);
958 release_firmware(cardp
->fw
);
962 lbs_deb_leave_args(LBS_DEB_USB
, "ret %d", ret
);
968 static int if_usb_suspend(struct usb_interface
*intf
, pm_message_t message
)
970 struct if_usb_card
*cardp
= usb_get_intfdata(intf
);
971 struct lbs_private
*priv
= cardp
->priv
;
974 lbs_deb_enter(LBS_DEB_USB
);
976 if (priv
->psstate
!= PS_STATE_FULL_POWER
) {
982 if (machine_is_olpc()) {
983 if (priv
->wol_criteria
== EHS_REMOVE_WAKEUP
)
984 olpc_ec_wakeup_clear(EC_SCI_SRC_WLAN
);
986 olpc_ec_wakeup_set(EC_SCI_SRC_WLAN
);
990 ret
= lbs_suspend(priv
);
994 /* Unlink tx & rx urb */
995 usb_kill_urb(cardp
->tx_urb
);
996 usb_kill_urb(cardp
->rx_urb
);
999 lbs_deb_leave(LBS_DEB_USB
);
1003 static int if_usb_resume(struct usb_interface
*intf
)
1005 struct if_usb_card
*cardp
= usb_get_intfdata(intf
);
1006 struct lbs_private
*priv
= cardp
->priv
;
1008 lbs_deb_enter(LBS_DEB_USB
);
1010 if_usb_submit_rx_urb(cardp
);
1014 lbs_deb_leave(LBS_DEB_USB
);
1018 #define if_usb_suspend NULL
1019 #define if_usb_resume NULL
1022 static struct usb_driver if_usb_driver
= {
1024 .probe
= if_usb_probe
,
1025 .disconnect
= if_usb_disconnect
,
1026 .id_table
= if_usb_table
,
1027 .suspend
= if_usb_suspend
,
1028 .resume
= if_usb_resume
,
1029 .reset_resume
= if_usb_resume
,
1032 module_usb_driver(if_usb_driver
);
1034 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1035 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
1036 MODULE_LICENSE("GPL");