2 * linux/drivers/net/wireless/libertas/if_sdio.c
4 * Copyright 2007-2008 Pierre Ossman
6 * Inspired by if_cs.c, Copyright 2007 Holger Schurig
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or (at
11 * your option) any later version.
13 * This hardware has more or less no CMD53 support, so all registers
14 * must be accessed using sdio_readb()/sdio_writeb().
16 * Transfers must be in one transaction or the firmware goes bonkers.
17 * This means that the transfer must either be small enough to do a
18 * byte based transfer or it must be padded to a multiple of the
21 * As SDIO is still new to the kernel, it is unfortunately common with
22 * bugs in the host controllers related to that. One such bug is that
23 * controllers cannot do transfers that aren't a multiple of 4 bytes.
24 * If you don't have time to fix the host controller driver, you can
25 * work around the problem by modifying if_sdio_host_to_card() and
26 * if_sdio_card_to_host() to pad the data.
29 #include <linux/kernel.h>
30 #include <linux/moduleparam.h>
31 #include <linux/firmware.h>
32 #include <linux/netdevice.h>
33 #include <linux/delay.h>
34 #include <linux/mmc/card.h>
35 #include <linux/mmc/sdio_func.h>
36 #include <linux/mmc/sdio_ids.h>
44 static char *lbs_helper_name = NULL;
45 module_param_named(helper_name, lbs_helper_name, charp, 0644);
47 static char *lbs_fw_name = NULL;
48 module_param_named(fw_name, lbs_fw_name, charp, 0644);
50 static const struct sdio_device_id if_sdio_ids[] = {
51 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
52 SDIO_DEVICE_ID_MARVELL_LIBERTAS) },
53 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
54 SDIO_DEVICE_ID_MARVELL_8688WLAN) },
55 { /* end: all zeroes */ },
58 MODULE_DEVICE_TABLE(sdio, if_sdio_ids);
60 struct if_sdio_model {
64 struct if_sdio_card *card;
67 static struct if_sdio_model if_sdio_models[] = {
70 .model = IF_SDIO_MODEL_8385,
71 .helper = "sd8385_helper.bin",
72 .firmware = "sd8385.bin",
77 .model = IF_SDIO_MODEL_8686,
78 .helper = "sd8686_helper.bin",
79 .firmware = "sd8686.bin",
84 .model = IF_SDIO_MODEL_8688,
85 .helper = "sd8688_helper.bin",
86 .firmware = "sd8688.bin",
91 struct if_sdio_packet {
92 struct if_sdio_packet *next;
94 u8 buffer[0] __attribute__((aligned(4)));
98 struct sdio_func *func;
99 struct lbs_private *priv;
102 unsigned long ioport;
103 unsigned int scratch_reg;
106 const char *firmware;
111 struct if_sdio_packet *packets;
113 struct workqueue_struct *workqueue;
114 struct work_struct packet_worker;
119 /********************************************************************/
121 /********************************************************************/
124 * For SD8385/SD8686, this function reads firmware status after
125 * the image is downloaded, or reads RX packet length when
126 * interrupt (with IF_SDIO_H_INT_UPLD bit set) is received.
127 * For SD8688, this function reads firmware status only.
129 static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
134 scratch = sdio_readb(card->func, card->scratch_reg, &ret);
136 scratch |= sdio_readb(card->func, card->scratch_reg + 1,
148 static u8 if_sdio_read_rx_unit(struct if_sdio_card *card)
153 rx_unit = sdio_readb(card->func, IF_SDIO_RX_UNIT, &ret);
161 static u16 if_sdio_read_rx_len(struct if_sdio_card *card, int *err)
166 switch (card->model) {
167 case IF_SDIO_MODEL_8385:
168 case IF_SDIO_MODEL_8686:
169 rx_len = if_sdio_read_scratch(card, &ret);
171 case IF_SDIO_MODEL_8688:
172 default: /* for newer chipsets */
173 rx_len = sdio_readb(card->func, IF_SDIO_RX_LEN, &ret);
175 rx_len <<= card->rx_unit;
177 rx_len = 0xffff; /* invalid length */
188 static int if_sdio_handle_cmd(struct if_sdio_card *card,
189 u8 *buffer, unsigned size)
191 struct lbs_private *priv = card->priv;
196 lbs_deb_enter(LBS_DEB_SDIO);
198 if (size > LBS_CMD_BUFFER_SIZE) {
199 lbs_deb_sdio("response packet too large (%d bytes)\n",
205 spin_lock_irqsave(&priv->driver_lock, flags);
207 i = (priv->resp_idx == 0) ? 1 : 0;
208 BUG_ON(priv->resp_len[i]);
209 priv->resp_len[i] = size;
210 memcpy(priv->resp_buf[i], buffer, size);
211 lbs_notify_command_response(priv, i);
213 spin_unlock_irqrestore(&card->priv->driver_lock, flags);
218 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
222 static int if_sdio_handle_data(struct if_sdio_card *card,
223 u8 *buffer, unsigned size)
229 lbs_deb_enter(LBS_DEB_SDIO);
231 if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
232 lbs_deb_sdio("response packet too large (%d bytes)\n",
238 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
244 skb_reserve(skb, NET_IP_ALIGN);
246 data = skb_put(skb, size);
248 memcpy(data, buffer, size);
250 lbs_process_rxed_packet(card->priv, skb);
255 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
260 static int if_sdio_handle_event(struct if_sdio_card *card,
261 u8 *buffer, unsigned size)
266 lbs_deb_enter(LBS_DEB_SDIO);
268 if (card->model == IF_SDIO_MODEL_8385) {
269 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
273 /* right shift 3 bits to get the event id */
277 lbs_deb_sdio("event packet too small (%d bytes)\n",
282 event = buffer[3] << 24;
283 event |= buffer[2] << 16;
284 event |= buffer[1] << 8;
285 event |= buffer[0] << 0;
288 lbs_queue_event(card->priv, event & 0xFF);
292 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
297 static int if_sdio_card_to_host(struct if_sdio_card *card)
301 u16 size, type, chunk;
302 unsigned long timeout;
304 lbs_deb_enter(LBS_DEB_SDIO);
306 size = if_sdio_read_rx_len(card, &ret);
311 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
317 timeout = jiffies + HZ;
319 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
322 if (status & IF_SDIO_IO_RDY)
324 if (time_after(jiffies, timeout)) {
332 * The transfer must be in one transaction or the firmware
333 * goes suicidal. There's no way to guarantee that for all
334 * controllers, but we can at least try.
336 chunk = sdio_align_size(card->func, size);
338 ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
342 chunk = card->buffer[0] | (card->buffer[1] << 8);
343 type = card->buffer[2] | (card->buffer[3] << 8);
345 lbs_deb_sdio("packet of type %d and size %d bytes\n",
346 (int)type, (int)chunk);
349 lbs_deb_sdio("packet fragment (%d > %d)\n",
350 (int)chunk, (int)size);
356 lbs_deb_sdio("packet fragment (%d < %d)\n",
357 (int)chunk, (int)size);
362 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
367 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
372 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
377 lbs_deb_sdio("invalid type (%d) from firmware\n",
385 lbs_pr_err("problem fetching packet from firmware\n");
387 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
392 static void if_sdio_host_to_card_worker(struct work_struct *work)
394 struct if_sdio_card *card;
395 struct if_sdio_packet *packet;
396 unsigned long timeout;
401 lbs_deb_enter(LBS_DEB_SDIO);
403 card = container_of(work, struct if_sdio_card, packet_worker);
406 spin_lock_irqsave(&card->lock, flags);
407 packet = card->packets;
409 card->packets = packet->next;
410 spin_unlock_irqrestore(&card->lock, flags);
415 sdio_claim_host(card->func);
417 timeout = jiffies + HZ;
419 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
422 if (status & IF_SDIO_IO_RDY)
424 if (time_after(jiffies, timeout)) {
431 ret = sdio_writesb(card->func, card->ioport,
432 packet->buffer, packet->nb);
436 sdio_release_host(card->func);
441 lbs_deb_leave(LBS_DEB_SDIO);
444 /********************************************************************/
446 /********************************************************************/
448 static int if_sdio_prog_helper(struct if_sdio_card *card)
452 const struct firmware *fw;
453 unsigned long timeout;
459 lbs_deb_enter(LBS_DEB_SDIO);
461 ret = request_firmware(&fw, card->helper, &card->func->dev);
463 lbs_pr_err("can't load helper firmware\n");
467 chunk_buffer = kzalloc(64, GFP_KERNEL);
473 sdio_claim_host(card->func);
475 ret = sdio_set_block_size(card->func, 32);
483 timeout = jiffies + HZ;
485 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
488 if ((status & IF_SDIO_IO_RDY) &&
489 (status & IF_SDIO_DL_RDY))
491 if (time_after(jiffies, timeout)) {
498 chunk_size = min(size, (size_t)60);
500 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
501 memcpy(chunk_buffer + 4, firmware, chunk_size);
503 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
505 ret = sdio_writesb(card->func, card->ioport,
510 firmware += chunk_size;
514 /* an empty block marks the end of the transfer */
515 memset(chunk_buffer, 0, 4);
516 ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
520 lbs_deb_sdio("waiting for helper to boot...\n");
522 /* wait for the helper to boot by looking at the size register */
523 timeout = jiffies + HZ;
527 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
531 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
538 if (time_after(jiffies, timeout)) {
549 sdio_release_host(card->func);
552 release_firmware(fw);
556 lbs_pr_err("failed to load helper firmware\n");
558 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
563 static int if_sdio_prog_real(struct if_sdio_card *card)
567 const struct firmware *fw;
568 unsigned long timeout;
572 size_t size, req_size;
574 lbs_deb_enter(LBS_DEB_SDIO);
576 ret = request_firmware(&fw, card->firmware, &card->func->dev);
578 lbs_pr_err("can't load firmware\n");
582 chunk_buffer = kzalloc(512, GFP_KERNEL);
588 sdio_claim_host(card->func);
590 ret = sdio_set_block_size(card->func, 32);
598 timeout = jiffies + HZ;
600 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
603 if ((status & IF_SDIO_IO_RDY) &&
604 (status & IF_SDIO_DL_RDY))
606 if (time_after(jiffies, timeout)) {
613 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
617 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
621 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
624 lbs_deb_sdio("firmware helper gave up early\n");
629 if (req_size & 0x01) {
630 lbs_deb_sdio("firmware helper signalled error\n");
639 chunk_size = min(req_size, (size_t)512);
641 memcpy(chunk_buffer, firmware, chunk_size);
643 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
644 chunk_size, (chunk_size + 31) / 32 * 32);
646 ret = sdio_writesb(card->func, card->ioport,
647 chunk_buffer, roundup(chunk_size, 32));
651 firmware += chunk_size;
653 req_size -= chunk_size;
659 lbs_deb_sdio("waiting for firmware to boot...\n");
661 /* wait for the firmware to boot */
662 timeout = jiffies + HZ;
666 scratch = if_sdio_read_scratch(card, &ret);
670 if (scratch == IF_SDIO_FIRMWARE_OK)
673 if (time_after(jiffies, timeout)) {
684 sdio_release_host(card->func);
687 release_firmware(fw);
691 lbs_pr_err("failed to load firmware\n");
693 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
698 static int if_sdio_prog_firmware(struct if_sdio_card *card)
703 lbs_deb_enter(LBS_DEB_SDIO);
705 sdio_claim_host(card->func);
706 scratch = if_sdio_read_scratch(card, &ret);
707 sdio_release_host(card->func);
712 lbs_deb_sdio("firmware status = %#x\n", scratch);
714 if (scratch == IF_SDIO_FIRMWARE_OK) {
715 lbs_deb_sdio("firmware already loaded\n");
719 ret = if_sdio_prog_helper(card);
723 ret = if_sdio_prog_real(card);
728 sdio_claim_host(card->func);
729 sdio_set_block_size(card->func, IF_SDIO_BLOCK_SIZE);
730 sdio_release_host(card->func);
734 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
739 /*******************************************************************/
740 /* Libertas callbacks */
741 /*******************************************************************/
743 static int if_sdio_host_to_card(struct lbs_private *priv,
744 u8 type, u8 *buf, u16 nb)
747 struct if_sdio_card *card;
748 struct if_sdio_packet *packet, *cur;
752 lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
756 if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
762 * The transfer must be in one transaction or the firmware
763 * goes suicidal. There's no way to guarantee that for all
764 * controllers, but we can at least try.
766 size = sdio_align_size(card->func, nb + 4);
768 packet = kzalloc(sizeof(struct if_sdio_packet) + size,
779 * SDIO specific header.
781 packet->buffer[0] = (nb + 4) & 0xff;
782 packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
783 packet->buffer[2] = type;
784 packet->buffer[3] = 0;
786 memcpy(packet->buffer + 4, buf, nb);
788 spin_lock_irqsave(&card->lock, flags);
791 card->packets = packet;
801 priv->dnld_sent = DNLD_CMD_SENT;
804 priv->dnld_sent = DNLD_DATA_SENT;
807 lbs_deb_sdio("unknown packet type %d\n", (int)type);
810 spin_unlock_irqrestore(&card->lock, flags);
812 queue_work(card->workqueue, &card->packet_worker);
817 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
822 /*******************************************************************/
824 /*******************************************************************/
826 static void if_sdio_interrupt(struct sdio_func *func)
829 struct if_sdio_card *card;
832 lbs_deb_enter(LBS_DEB_SDIO);
834 card = sdio_get_drvdata(func);
836 cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
840 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
842 sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
847 * Ignore the define name, this really means the card has
848 * successfully received the command.
850 if (cause & IF_SDIO_H_INT_DNLD)
851 lbs_host_to_card_done(card->priv);
854 if (cause & IF_SDIO_H_INT_UPLD) {
855 ret = if_sdio_card_to_host(card);
863 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
866 static int if_sdio_probe(struct sdio_func *func,
867 const struct sdio_device_id *id)
869 struct if_sdio_card *card;
870 struct lbs_private *priv;
873 struct if_sdio_packet *packet;
875 lbs_deb_enter(LBS_DEB_SDIO);
877 for (i = 0;i < func->card->num_info;i++) {
878 if (sscanf(func->card->info[i],
879 "802.11 SDIO ID: %x", &model) == 1)
881 if (sscanf(func->card->info[i],
882 "ID: %x", &model) == 1)
884 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
885 model = IF_SDIO_MODEL_8385;
890 if (i == func->card->num_info) {
891 lbs_pr_err("unable to identify card model\n");
895 card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
902 switch (card->model) {
903 case IF_SDIO_MODEL_8385:
904 card->scratch_reg = IF_SDIO_SCRATCH_OLD;
906 case IF_SDIO_MODEL_8686:
907 card->scratch_reg = IF_SDIO_SCRATCH;
909 case IF_SDIO_MODEL_8688:
910 default: /* for newer chipsets */
911 card->scratch_reg = IF_SDIO_FW_STATUS;
915 spin_lock_init(&card->lock);
916 card->workqueue = create_workqueue("libertas_sdio");
917 INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
919 for (i = 0;i < ARRAY_SIZE(if_sdio_models);i++) {
920 if (card->model == if_sdio_models[i].model)
924 if (i == ARRAY_SIZE(if_sdio_models)) {
925 lbs_pr_err("unkown card model 0x%x\n", card->model);
930 if_sdio_models[i].card = card;
932 card->helper = if_sdio_models[i].helper;
933 card->firmware = if_sdio_models[i].firmware;
935 if (lbs_helper_name) {
936 lbs_deb_sdio("overriding helper firmware: %s\n",
938 card->helper = lbs_helper_name;
942 lbs_deb_sdio("overriding firmware: %s\n", lbs_fw_name);
943 card->firmware = lbs_fw_name;
946 sdio_claim_host(func);
948 ret = sdio_enable_func(func);
952 ret = sdio_claim_irq(func, if_sdio_interrupt);
956 card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
960 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
964 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
968 sdio_release_host(func);
970 sdio_set_drvdata(func, card);
972 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
973 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
974 func->class, func->vendor, func->device,
975 model, (unsigned)card->ioport);
977 ret = if_sdio_prog_firmware(card);
981 priv = lbs_add_card(card, &func->dev);
990 priv->hw_host_to_card = if_sdio_host_to_card;
994 sdio_claim_host(func);
997 * Get rx_unit if the chip is SD8688 or newer.
998 * SD8385 & SD8686 do not have rx_unit.
1000 if ((card->model != IF_SDIO_MODEL_8385)
1001 && (card->model != IF_SDIO_MODEL_8686))
1002 card->rx_unit = if_sdio_read_rx_unit(card);
1007 * Enable interrupts now that everything is set up
1009 sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
1010 sdio_release_host(func);
1015 * FUNC_INIT is required for SD8688 WLAN/BT multiple functions
1017 priv->fn_init_required =
1018 (card->model == IF_SDIO_MODEL_8688) ? 1 : 0;
1020 ret = lbs_start_card(priv);
1022 goto err_activate_card;
1024 if (priv->fwcapinfo & FW_CAPINFO_PS)
1025 priv->ps_supported = 1;
1028 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1033 flush_workqueue(card->workqueue);
1034 lbs_remove_card(priv);
1036 sdio_claim_host(func);
1038 sdio_release_irq(func);
1040 sdio_disable_func(func);
1042 sdio_release_host(func);
1044 destroy_workqueue(card->workqueue);
1045 while (card->packets) {
1046 packet = card->packets;
1047 card->packets = card->packets->next;
1056 static void if_sdio_remove(struct sdio_func *func)
1058 struct if_sdio_card *card;
1059 struct if_sdio_packet *packet;
1062 lbs_deb_enter(LBS_DEB_SDIO);
1064 card = sdio_get_drvdata(func);
1066 lbs_stop_card(card->priv);
1068 card->priv->surpriseremoved = 1;
1070 lbs_deb_sdio("call remove card\n");
1071 lbs_remove_card(card->priv);
1073 flush_workqueue(card->workqueue);
1074 destroy_workqueue(card->workqueue);
1076 sdio_claim_host(func);
1078 /* Disable interrupts */
1079 sdio_writeb(func, 0x00, IF_SDIO_H_INT_MASK, &ret);
1081 sdio_release_irq(func);
1082 sdio_disable_func(func);
1084 sdio_release_host(func);
1086 while (card->packets) {
1087 packet = card->packets;
1088 card->packets = card->packets->next;
1094 lbs_deb_leave(LBS_DEB_SDIO);
1097 static struct sdio_driver if_sdio_driver = {
1098 .name = "libertas_sdio",
1099 .id_table = if_sdio_ids,
1100 .probe = if_sdio_probe,
1101 .remove = if_sdio_remove,
1104 /*******************************************************************/
1105 /* Module functions */
1106 /*******************************************************************/
1108 static int __init if_sdio_init_module(void)
1112 lbs_deb_enter(LBS_DEB_SDIO);
1114 printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1115 printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1117 ret = sdio_register_driver(&if_sdio_driver);
1119 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1124 static void __exit if_sdio_exit_module(void)
1127 struct if_sdio_card *card;
1129 lbs_deb_enter(LBS_DEB_SDIO);
1131 for (i = 0; i < ARRAY_SIZE(if_sdio_models); i++) {
1132 card = if_sdio_models[i].card;
1135 * FUNC_SHUTDOWN is required for SD8688 WLAN/BT
1136 * multiple functions
1138 if (card && card->priv)
1139 card->priv->fn_shutdown_required =
1140 (card->model == IF_SDIO_MODEL_8688) ? 1 : 0;
1143 sdio_unregister_driver(&if_sdio_driver);
1145 lbs_deb_leave(LBS_DEB_SDIO);
1148 module_init(if_sdio_init_module);
1149 module_exit(if_sdio_exit_module);
1151 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1152 MODULE_AUTHOR("Pierre Ossman");
1153 MODULE_LICENSE("GPL");