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 {
66 static struct if_sdio_model if_sdio_models[] = {
69 .model = IF_SDIO_MODEL_8385,
70 .helper = "sd8385_helper.bin",
71 .firmware = "sd8385.bin",
75 .model = IF_SDIO_MODEL_8686,
76 .helper = "sd8686_helper.bin",
77 .firmware = "sd8686.bin",
81 .model = IF_SDIO_MODEL_8688,
82 .helper = "sd8688_helper.bin",
83 .firmware = "sd8688.bin",
87 struct if_sdio_packet {
88 struct if_sdio_packet *next;
90 u8 buffer[0] __attribute__((aligned(4)));
94 struct sdio_func *func;
95 struct lbs_private *priv;
101 const char *firmware;
106 struct if_sdio_packet *packets;
108 struct workqueue_struct *workqueue;
109 struct work_struct packet_worker;
112 /********************************************************************/
114 /********************************************************************/
116 static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
121 if (card->model == IF_SDIO_MODEL_8385)
122 reg = IF_SDIO_SCRATCH_OLD;
124 reg = IF_SDIO_SCRATCH;
126 scratch = sdio_readb(card->func, reg, &ret);
128 scratch |= sdio_readb(card->func, reg + 1, &ret) << 8;
139 static int if_sdio_handle_cmd(struct if_sdio_card *card,
140 u8 *buffer, unsigned size)
142 struct lbs_private *priv = card->priv;
147 lbs_deb_enter(LBS_DEB_SDIO);
149 if (size > LBS_CMD_BUFFER_SIZE) {
150 lbs_deb_sdio("response packet too large (%d bytes)\n",
156 spin_lock_irqsave(&priv->driver_lock, flags);
158 i = (priv->resp_idx == 0) ? 1 : 0;
159 BUG_ON(priv->resp_len[i]);
160 priv->resp_len[i] = size;
161 memcpy(priv->resp_buf[i], buffer, size);
162 lbs_notify_command_response(priv, i);
164 spin_unlock_irqrestore(&card->priv->driver_lock, flags);
169 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
173 static int if_sdio_handle_data(struct if_sdio_card *card,
174 u8 *buffer, unsigned size)
180 lbs_deb_enter(LBS_DEB_SDIO);
182 if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
183 lbs_deb_sdio("response packet too large (%d bytes)\n",
189 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
195 skb_reserve(skb, NET_IP_ALIGN);
197 data = skb_put(skb, size);
199 memcpy(data, buffer, size);
201 lbs_process_rxed_packet(card->priv, skb);
206 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
211 static int if_sdio_handle_event(struct if_sdio_card *card,
212 u8 *buffer, unsigned size)
217 lbs_deb_enter(LBS_DEB_SDIO);
219 if (card->model == IF_SDIO_MODEL_8385) {
220 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
224 /* right shift 3 bits to get the event id */
228 lbs_deb_sdio("event packet too small (%d bytes)\n",
233 event = buffer[3] << 24;
234 event |= buffer[2] << 16;
235 event |= buffer[1] << 8;
236 event |= buffer[0] << 0;
239 lbs_queue_event(card->priv, event & 0xFF);
243 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
248 static int if_sdio_card_to_host(struct if_sdio_card *card)
252 u16 size, type, chunk;
253 unsigned long timeout;
255 lbs_deb_enter(LBS_DEB_SDIO);
257 size = if_sdio_read_scratch(card, &ret);
262 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
268 timeout = jiffies + HZ;
270 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
273 if (status & IF_SDIO_IO_RDY)
275 if (time_after(jiffies, timeout)) {
283 * The transfer must be in one transaction or the firmware
284 * goes suicidal. There's no way to guarantee that for all
285 * controllers, but we can at least try.
287 chunk = sdio_align_size(card->func, size);
289 ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
293 chunk = card->buffer[0] | (card->buffer[1] << 8);
294 type = card->buffer[2] | (card->buffer[3] << 8);
296 lbs_deb_sdio("packet of type %d and size %d bytes\n",
297 (int)type, (int)chunk);
300 lbs_deb_sdio("packet fragment (%d > %d)\n",
301 (int)chunk, (int)size);
307 lbs_deb_sdio("packet fragment (%d < %d)\n",
308 (int)chunk, (int)size);
313 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
318 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
323 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
328 lbs_deb_sdio("invalid type (%d) from firmware\n",
336 lbs_pr_err("problem fetching packet from firmware\n");
338 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
343 static void if_sdio_host_to_card_worker(struct work_struct *work)
345 struct if_sdio_card *card;
346 struct if_sdio_packet *packet;
347 unsigned long timeout;
352 lbs_deb_enter(LBS_DEB_SDIO);
354 card = container_of(work, struct if_sdio_card, packet_worker);
357 spin_lock_irqsave(&card->lock, flags);
358 packet = card->packets;
360 card->packets = packet->next;
361 spin_unlock_irqrestore(&card->lock, flags);
366 sdio_claim_host(card->func);
368 timeout = jiffies + HZ;
370 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
373 if (status & IF_SDIO_IO_RDY)
375 if (time_after(jiffies, timeout)) {
382 ret = sdio_writesb(card->func, card->ioport,
383 packet->buffer, packet->nb);
387 sdio_release_host(card->func);
392 lbs_deb_leave(LBS_DEB_SDIO);
395 /********************************************************************/
397 /********************************************************************/
399 static int if_sdio_prog_helper(struct if_sdio_card *card)
403 const struct firmware *fw;
404 unsigned long timeout;
410 lbs_deb_enter(LBS_DEB_SDIO);
412 ret = request_firmware(&fw, card->helper, &card->func->dev);
414 lbs_pr_err("can't load helper firmware\n");
418 chunk_buffer = kzalloc(64, GFP_KERNEL);
424 sdio_claim_host(card->func);
426 ret = sdio_set_block_size(card->func, 32);
434 timeout = jiffies + HZ;
436 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
439 if ((status & IF_SDIO_IO_RDY) &&
440 (status & IF_SDIO_DL_RDY))
442 if (time_after(jiffies, timeout)) {
449 chunk_size = min(size, (size_t)60);
451 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
452 memcpy(chunk_buffer + 4, firmware, chunk_size);
454 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
456 ret = sdio_writesb(card->func, card->ioport,
461 firmware += chunk_size;
465 /* an empty block marks the end of the transfer */
466 memset(chunk_buffer, 0, 4);
467 ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
471 lbs_deb_sdio("waiting for helper to boot...\n");
473 /* wait for the helper to boot by looking at the size register */
474 timeout = jiffies + HZ;
478 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
482 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
489 if (time_after(jiffies, timeout)) {
500 sdio_set_block_size(card->func, IF_SDIO_BLOCK_SIZE);
501 sdio_release_host(card->func);
504 release_firmware(fw);
508 lbs_pr_err("failed to load helper firmware\n");
510 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
515 static int if_sdio_prog_real(struct if_sdio_card *card)
519 const struct firmware *fw;
520 unsigned long timeout;
524 size_t size, req_size;
526 lbs_deb_enter(LBS_DEB_SDIO);
528 ret = request_firmware(&fw, card->firmware, &card->func->dev);
530 lbs_pr_err("can't load firmware\n");
534 chunk_buffer = kzalloc(512, GFP_KERNEL);
540 sdio_claim_host(card->func);
542 ret = sdio_set_block_size(card->func, 32);
550 timeout = jiffies + HZ;
552 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
555 if ((status & IF_SDIO_IO_RDY) &&
556 (status & IF_SDIO_DL_RDY))
558 if (time_after(jiffies, timeout)) {
565 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
569 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
573 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
576 lbs_deb_sdio("firmware helper gave up early\n");
581 if (req_size & 0x01) {
582 lbs_deb_sdio("firmware helper signalled error\n");
591 chunk_size = min(req_size, (size_t)512);
593 memcpy(chunk_buffer, firmware, chunk_size);
595 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
596 chunk_size, (chunk_size + 31) / 32 * 32);
598 ret = sdio_writesb(card->func, card->ioport,
599 chunk_buffer, roundup(chunk_size, 32));
603 firmware += chunk_size;
605 req_size -= chunk_size;
611 lbs_deb_sdio("waiting for firmware to boot...\n");
613 /* wait for the firmware to boot */
614 timeout = jiffies + HZ;
618 scratch = if_sdio_read_scratch(card, &ret);
622 if (scratch == IF_SDIO_FIRMWARE_OK)
625 if (time_after(jiffies, timeout)) {
636 sdio_set_block_size(card->func, IF_SDIO_BLOCK_SIZE);
637 sdio_release_host(card->func);
640 release_firmware(fw);
644 lbs_pr_err("failed to load firmware\n");
646 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
651 static int if_sdio_prog_firmware(struct if_sdio_card *card)
656 lbs_deb_enter(LBS_DEB_SDIO);
658 sdio_claim_host(card->func);
659 scratch = if_sdio_read_scratch(card, &ret);
660 sdio_release_host(card->func);
665 if (scratch == IF_SDIO_FIRMWARE_OK) {
666 lbs_deb_sdio("firmware already loaded\n");
670 ret = if_sdio_prog_helper(card);
674 ret = if_sdio_prog_real(card);
682 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
687 /*******************************************************************/
688 /* Libertas callbacks */
689 /*******************************************************************/
691 static int if_sdio_host_to_card(struct lbs_private *priv,
692 u8 type, u8 *buf, u16 nb)
695 struct if_sdio_card *card;
696 struct if_sdio_packet *packet, *cur;
700 lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
704 if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
710 * The transfer must be in one transaction or the firmware
711 * goes suicidal. There's no way to guarantee that for all
712 * controllers, but we can at least try.
714 size = sdio_align_size(card->func, nb + 4);
716 packet = kzalloc(sizeof(struct if_sdio_packet) + size,
727 * SDIO specific header.
729 packet->buffer[0] = (nb + 4) & 0xff;
730 packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
731 packet->buffer[2] = type;
732 packet->buffer[3] = 0;
734 memcpy(packet->buffer + 4, buf, nb);
736 spin_lock_irqsave(&card->lock, flags);
739 card->packets = packet;
749 priv->dnld_sent = DNLD_CMD_SENT;
752 priv->dnld_sent = DNLD_DATA_SENT;
755 lbs_deb_sdio("unknown packet type %d\n", (int)type);
758 spin_unlock_irqrestore(&card->lock, flags);
760 queue_work(card->workqueue, &card->packet_worker);
765 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
770 /*******************************************************************/
772 /*******************************************************************/
774 static void if_sdio_interrupt(struct sdio_func *func)
777 struct if_sdio_card *card;
780 lbs_deb_enter(LBS_DEB_SDIO);
782 card = sdio_get_drvdata(func);
784 cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
788 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
790 sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
795 * Ignore the define name, this really means the card has
796 * successfully received the command.
798 if (cause & IF_SDIO_H_INT_DNLD)
799 lbs_host_to_card_done(card->priv);
802 if (cause & IF_SDIO_H_INT_UPLD) {
803 ret = if_sdio_card_to_host(card);
811 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
814 static int if_sdio_probe(struct sdio_func *func,
815 const struct sdio_device_id *id)
817 struct if_sdio_card *card;
818 struct lbs_private *priv;
821 struct if_sdio_packet *packet;
823 lbs_deb_enter(LBS_DEB_SDIO);
825 for (i = 0;i < func->card->num_info;i++) {
826 if (sscanf(func->card->info[i],
827 "802.11 SDIO ID: %x", &model) == 1)
829 if (sscanf(func->card->info[i],
830 "ID: %x", &model) == 1)
832 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
833 model = IF_SDIO_MODEL_8385;
838 if (i == func->card->num_info) {
839 lbs_pr_err("unable to identify card model\n");
843 card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
849 spin_lock_init(&card->lock);
850 card->workqueue = create_workqueue("libertas_sdio");
851 INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
853 for (i = 0;i < ARRAY_SIZE(if_sdio_models);i++) {
854 if (card->model == if_sdio_models[i].model)
858 if (i == ARRAY_SIZE(if_sdio_models)) {
859 lbs_pr_err("unkown card model 0x%x\n", card->model);
864 card->helper = if_sdio_models[i].helper;
865 card->firmware = if_sdio_models[i].firmware;
867 if (lbs_helper_name) {
868 lbs_deb_sdio("overriding helper firmware: %s\n",
870 card->helper = lbs_helper_name;
874 lbs_deb_sdio("overriding firmware: %s\n", lbs_fw_name);
875 card->firmware = lbs_fw_name;
878 sdio_claim_host(func);
880 ret = sdio_enable_func(func);
884 ret = sdio_claim_irq(func, if_sdio_interrupt);
888 card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
892 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
896 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
900 sdio_release_host(func);
902 sdio_set_drvdata(func, card);
904 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
905 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
906 func->class, func->vendor, func->device,
907 model, (unsigned)card->ioport);
909 ret = if_sdio_prog_firmware(card);
913 priv = lbs_add_card(card, &func->dev);
922 priv->hw_host_to_card = if_sdio_host_to_card;
927 * Enable interrupts now that everything is set up
929 sdio_claim_host(func);
930 sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
931 sdio_release_host(func);
935 ret = lbs_start_card(priv);
937 goto err_activate_card;
939 if (priv->fwcapinfo & FW_CAPINFO_PS)
940 priv->ps_supported = 1;
943 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
948 flush_workqueue(card->workqueue);
949 lbs_remove_card(priv);
951 sdio_claim_host(func);
953 sdio_release_irq(func);
955 sdio_disable_func(func);
957 sdio_release_host(func);
959 destroy_workqueue(card->workqueue);
960 while (card->packets) {
961 packet = card->packets;
962 card->packets = card->packets->next;
971 static void if_sdio_remove(struct sdio_func *func)
973 struct if_sdio_card *card;
974 struct if_sdio_packet *packet;
976 lbs_deb_enter(LBS_DEB_SDIO);
978 card = sdio_get_drvdata(func);
980 card->priv->surpriseremoved = 1;
982 lbs_deb_sdio("call remove card\n");
983 lbs_stop_card(card->priv);
984 lbs_remove_card(card->priv);
986 flush_workqueue(card->workqueue);
987 destroy_workqueue(card->workqueue);
989 sdio_claim_host(func);
990 sdio_release_irq(func);
991 sdio_disable_func(func);
992 sdio_release_host(func);
994 while (card->packets) {
995 packet = card->packets;
996 card->packets = card->packets->next;
1002 lbs_deb_leave(LBS_DEB_SDIO);
1005 static struct sdio_driver if_sdio_driver = {
1006 .name = "libertas_sdio",
1007 .id_table = if_sdio_ids,
1008 .probe = if_sdio_probe,
1009 .remove = if_sdio_remove,
1012 /*******************************************************************/
1013 /* Module functions */
1014 /*******************************************************************/
1016 static int __init if_sdio_init_module(void)
1020 lbs_deb_enter(LBS_DEB_SDIO);
1022 printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1023 printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1025 ret = sdio_register_driver(&if_sdio_driver);
1027 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1032 static void __exit if_sdio_exit_module(void)
1034 lbs_deb_enter(LBS_DEB_SDIO);
1036 sdio_unregister_driver(&if_sdio_driver);
1038 lbs_deb_leave(LBS_DEB_SDIO);
1041 module_init(if_sdio_init_module);
1042 module_exit(if_sdio_exit_module);
1044 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1045 MODULE_AUTHOR("Pierre Ossman");
1046 MODULE_LICENSE("GPL");