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, SDIO_DEVICE_ID_MARVELL_LIBERTAS) },
52 { /* end: all zeroes */ },
55 MODULE_DEVICE_TABLE(sdio, if_sdio_ids);
57 struct if_sdio_model {
63 static struct if_sdio_model if_sdio_models[] = {
67 .helper = "sd8385_helper.bin",
68 .firmware = "sd8385.bin",
73 .helper = "sd8686_helper.bin",
74 .firmware = "sd8686.bin",
78 struct if_sdio_packet {
79 struct if_sdio_packet *next;
81 u8 buffer[0] __attribute__((aligned(4)));
85 struct sdio_func *func;
86 struct lbs_private *priv;
97 struct if_sdio_packet *packets;
99 struct workqueue_struct *workqueue;
100 struct work_struct packet_worker;
103 /********************************************************************/
105 /********************************************************************/
107 static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
112 if (card->model == 0x04)
113 reg = IF_SDIO_SCRATCH_OLD;
115 reg = IF_SDIO_SCRATCH;
117 scratch = sdio_readb(card->func, reg, &ret);
119 scratch |= sdio_readb(card->func, reg + 1, &ret) << 8;
130 static int if_sdio_handle_cmd(struct if_sdio_card *card,
131 u8 *buffer, unsigned size)
133 struct lbs_private *priv = card->priv;
138 lbs_deb_enter(LBS_DEB_SDIO);
140 if (size > LBS_CMD_BUFFER_SIZE) {
141 lbs_deb_sdio("response packet too large (%d bytes)\n",
147 spin_lock_irqsave(&priv->driver_lock, flags);
149 i = (priv->resp_idx == 0) ? 1 : 0;
150 BUG_ON(priv->resp_len[i]);
151 priv->resp_len[i] = size;
152 memcpy(priv->resp_buf[i], buffer, size);
153 lbs_notify_command_response(priv, i);
155 spin_unlock_irqrestore(&card->priv->driver_lock, flags);
160 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
164 static int if_sdio_handle_data(struct if_sdio_card *card,
165 u8 *buffer, unsigned size)
171 lbs_deb_enter(LBS_DEB_SDIO);
173 if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
174 lbs_deb_sdio("response packet too large (%d bytes)\n",
180 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
186 skb_reserve(skb, NET_IP_ALIGN);
188 data = skb_put(skb, size);
190 memcpy(data, buffer, size);
192 lbs_process_rxed_packet(card->priv, skb);
197 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
202 static int if_sdio_handle_event(struct if_sdio_card *card,
203 u8 *buffer, unsigned size)
208 lbs_deb_enter(LBS_DEB_SDIO);
210 if (card->model == 0x04) {
211 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
215 /* right shift 3 bits to get the event id */
219 lbs_deb_sdio("event packet too small (%d bytes)\n",
224 event = buffer[3] << 24;
225 event |= buffer[2] << 16;
226 event |= buffer[1] << 8;
227 event |= buffer[0] << 0;
230 lbs_queue_event(card->priv, event & 0xFF);
234 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
239 static int if_sdio_card_to_host(struct if_sdio_card *card)
243 u16 size, type, chunk;
244 unsigned long timeout;
246 lbs_deb_enter(LBS_DEB_SDIO);
248 size = if_sdio_read_scratch(card, &ret);
253 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
259 timeout = jiffies + HZ;
261 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
264 if (status & IF_SDIO_IO_RDY)
266 if (time_after(jiffies, timeout)) {
274 * The transfer must be in one transaction or the firmware
275 * goes suicidal. There's no way to guarantee that for all
276 * controllers, but we can at least try.
278 chunk = sdio_align_size(card->func, size);
280 ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
284 chunk = card->buffer[0] | (card->buffer[1] << 8);
285 type = card->buffer[2] | (card->buffer[3] << 8);
287 lbs_deb_sdio("packet of type %d and size %d bytes\n",
288 (int)type, (int)chunk);
291 lbs_deb_sdio("packet fragment (%d > %d)\n",
292 (int)chunk, (int)size);
298 lbs_deb_sdio("packet fragment (%d < %d)\n",
299 (int)chunk, (int)size);
304 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
309 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
314 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
319 lbs_deb_sdio("invalid type (%d) from firmware\n",
327 lbs_pr_err("problem fetching packet from firmware\n");
329 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
334 static void if_sdio_host_to_card_worker(struct work_struct *work)
336 struct if_sdio_card *card;
337 struct if_sdio_packet *packet;
338 unsigned long timeout;
343 lbs_deb_enter(LBS_DEB_SDIO);
345 card = container_of(work, struct if_sdio_card, packet_worker);
348 spin_lock_irqsave(&card->lock, flags);
349 packet = card->packets;
351 card->packets = packet->next;
352 spin_unlock_irqrestore(&card->lock, flags);
357 sdio_claim_host(card->func);
359 timeout = jiffies + HZ;
361 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
364 if (status & IF_SDIO_IO_RDY)
366 if (time_after(jiffies, timeout)) {
373 ret = sdio_writesb(card->func, card->ioport,
374 packet->buffer, packet->nb);
378 sdio_release_host(card->func);
383 lbs_deb_leave(LBS_DEB_SDIO);
386 /********************************************************************/
388 /********************************************************************/
390 static int if_sdio_prog_helper(struct if_sdio_card *card)
394 const struct firmware *fw;
395 unsigned long timeout;
401 lbs_deb_enter(LBS_DEB_SDIO);
403 ret = request_firmware(&fw, card->helper, &card->func->dev);
405 lbs_pr_err("can't load helper firmware\n");
409 chunk_buffer = kzalloc(64, GFP_KERNEL);
415 sdio_claim_host(card->func);
417 ret = sdio_set_block_size(card->func, 32);
425 timeout = jiffies + HZ;
427 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
430 if ((status & IF_SDIO_IO_RDY) &&
431 (status & IF_SDIO_DL_RDY))
433 if (time_after(jiffies, timeout)) {
440 chunk_size = min(size, (size_t)60);
442 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
443 memcpy(chunk_buffer + 4, firmware, chunk_size);
445 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
447 ret = sdio_writesb(card->func, card->ioport,
452 firmware += chunk_size;
456 /* an empty block marks the end of the transfer */
457 memset(chunk_buffer, 0, 4);
458 ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
462 lbs_deb_sdio("waiting for helper to boot...\n");
464 /* wait for the helper to boot by looking at the size register */
465 timeout = jiffies + HZ;
469 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
473 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
480 if (time_after(jiffies, timeout)) {
491 sdio_set_block_size(card->func, 0);
492 sdio_release_host(card->func);
495 release_firmware(fw);
499 lbs_pr_err("failed to load helper firmware\n");
501 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
506 static int if_sdio_prog_real(struct if_sdio_card *card)
510 const struct firmware *fw;
511 unsigned long timeout;
515 size_t size, req_size;
517 lbs_deb_enter(LBS_DEB_SDIO);
519 ret = request_firmware(&fw, card->firmware, &card->func->dev);
521 lbs_pr_err("can't load firmware\n");
525 chunk_buffer = kzalloc(512, GFP_KERNEL);
531 sdio_claim_host(card->func);
533 ret = sdio_set_block_size(card->func, 32);
541 timeout = jiffies + HZ;
543 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
546 if ((status & IF_SDIO_IO_RDY) &&
547 (status & IF_SDIO_DL_RDY))
549 if (time_after(jiffies, timeout)) {
556 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
560 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
564 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
567 lbs_deb_sdio("firmware helper gave up early\n");
572 if (req_size & 0x01) {
573 lbs_deb_sdio("firmware helper signalled error\n");
582 chunk_size = min(req_size, (size_t)512);
584 memcpy(chunk_buffer, firmware, chunk_size);
586 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
587 chunk_size, (chunk_size + 31) / 32 * 32);
589 ret = sdio_writesb(card->func, card->ioport,
590 chunk_buffer, roundup(chunk_size, 32));
594 firmware += chunk_size;
596 req_size -= chunk_size;
602 lbs_deb_sdio("waiting for firmware to boot...\n");
604 /* wait for the firmware to boot */
605 timeout = jiffies + HZ;
609 scratch = if_sdio_read_scratch(card, &ret);
613 if (scratch == IF_SDIO_FIRMWARE_OK)
616 if (time_after(jiffies, timeout)) {
627 sdio_set_block_size(card->func, 0);
628 sdio_release_host(card->func);
631 release_firmware(fw);
635 lbs_pr_err("failed to load firmware\n");
637 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
642 static int if_sdio_prog_firmware(struct if_sdio_card *card)
647 lbs_deb_enter(LBS_DEB_SDIO);
649 sdio_claim_host(card->func);
650 scratch = if_sdio_read_scratch(card, &ret);
651 sdio_release_host(card->func);
656 if (scratch == IF_SDIO_FIRMWARE_OK) {
657 lbs_deb_sdio("firmware already loaded\n");
661 ret = if_sdio_prog_helper(card);
665 ret = if_sdio_prog_real(card);
673 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
678 /*******************************************************************/
679 /* Libertas callbacks */
680 /*******************************************************************/
682 static int if_sdio_host_to_card(struct lbs_private *priv,
683 u8 type, u8 *buf, u16 nb)
686 struct if_sdio_card *card;
687 struct if_sdio_packet *packet, *cur;
691 lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
695 if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
701 * The transfer must be in one transaction or the firmware
702 * goes suicidal. There's no way to guarantee that for all
703 * controllers, but we can at least try.
705 size = sdio_align_size(card->func, nb + 4);
707 packet = kzalloc(sizeof(struct if_sdio_packet) + size,
718 * SDIO specific header.
720 packet->buffer[0] = (nb + 4) & 0xff;
721 packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
722 packet->buffer[2] = type;
723 packet->buffer[3] = 0;
725 memcpy(packet->buffer + 4, buf, nb);
727 spin_lock_irqsave(&card->lock, flags);
730 card->packets = packet;
740 priv->dnld_sent = DNLD_CMD_SENT;
743 priv->dnld_sent = DNLD_DATA_SENT;
746 lbs_deb_sdio("unknown packet type %d\n", (int)type);
749 spin_unlock_irqrestore(&card->lock, flags);
751 queue_work(card->workqueue, &card->packet_worker);
756 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
761 /*******************************************************************/
763 /*******************************************************************/
765 static void if_sdio_interrupt(struct sdio_func *func)
768 struct if_sdio_card *card;
771 lbs_deb_enter(LBS_DEB_SDIO);
773 card = sdio_get_drvdata(func);
775 cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
779 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
781 sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
786 * Ignore the define name, this really means the card has
787 * successfully received the command.
789 if (cause & IF_SDIO_H_INT_DNLD)
790 lbs_host_to_card_done(card->priv);
793 if (cause & IF_SDIO_H_INT_UPLD) {
794 ret = if_sdio_card_to_host(card);
802 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
805 static int if_sdio_probe(struct sdio_func *func,
806 const struct sdio_device_id *id)
808 struct if_sdio_card *card;
809 struct lbs_private *priv;
812 struct if_sdio_packet *packet;
814 lbs_deb_enter(LBS_DEB_SDIO);
816 for (i = 0;i < func->card->num_info;i++) {
817 if (sscanf(func->card->info[i],
818 "802.11 SDIO ID: %x", &model) == 1)
820 if (sscanf(func->card->info[i],
821 "ID: %x", &model) == 1)
823 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
829 if (i == func->card->num_info) {
830 lbs_pr_err("unable to identify card model\n");
834 card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
840 spin_lock_init(&card->lock);
841 card->workqueue = create_workqueue("libertas_sdio");
842 INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
844 for (i = 0;i < ARRAY_SIZE(if_sdio_models);i++) {
845 if (card->model == if_sdio_models[i].model)
849 if (i == ARRAY_SIZE(if_sdio_models)) {
850 lbs_pr_err("unkown card model 0x%x\n", card->model);
855 card->helper = if_sdio_models[i].helper;
856 card->firmware = if_sdio_models[i].firmware;
858 if (lbs_helper_name) {
859 lbs_deb_sdio("overriding helper firmware: %s\n",
861 card->helper = lbs_helper_name;
865 lbs_deb_sdio("overriding firmware: %s\n", lbs_fw_name);
866 card->firmware = lbs_fw_name;
869 sdio_claim_host(func);
871 ret = sdio_enable_func(func);
875 ret = sdio_claim_irq(func, if_sdio_interrupt);
879 card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
883 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
887 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
891 sdio_release_host(func);
893 sdio_set_drvdata(func, card);
895 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
896 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
897 func->class, func->vendor, func->device,
898 model, (unsigned)card->ioport);
900 ret = if_sdio_prog_firmware(card);
904 priv = lbs_add_card(card, &func->dev);
913 priv->hw_host_to_card = if_sdio_host_to_card;
918 * Enable interrupts now that everything is set up
920 sdio_claim_host(func);
921 sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
922 sdio_release_host(func);
926 ret = lbs_start_card(priv);
928 goto err_activate_card;
930 if (priv->fwcapinfo & FW_CAPINFO_PS)
931 priv->ps_supported = 1;
934 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
939 flush_workqueue(card->workqueue);
940 lbs_remove_card(priv);
942 sdio_claim_host(func);
944 sdio_release_irq(func);
946 sdio_disable_func(func);
948 sdio_release_host(func);
950 destroy_workqueue(card->workqueue);
951 while (card->packets) {
952 packet = card->packets;
953 card->packets = card->packets->next;
962 static void if_sdio_remove(struct sdio_func *func)
964 struct if_sdio_card *card;
965 struct if_sdio_packet *packet;
967 lbs_deb_enter(LBS_DEB_SDIO);
969 card = sdio_get_drvdata(func);
971 card->priv->surpriseremoved = 1;
973 lbs_deb_sdio("call remove card\n");
974 lbs_stop_card(card->priv);
975 lbs_remove_card(card->priv);
977 flush_workqueue(card->workqueue);
978 destroy_workqueue(card->workqueue);
980 sdio_claim_host(func);
981 sdio_release_irq(func);
982 sdio_disable_func(func);
983 sdio_release_host(func);
985 while (card->packets) {
986 packet = card->packets;
987 card->packets = card->packets->next;
993 lbs_deb_leave(LBS_DEB_SDIO);
996 static struct sdio_driver if_sdio_driver = {
997 .name = "libertas_sdio",
998 .id_table = if_sdio_ids,
999 .probe = if_sdio_probe,
1000 .remove = if_sdio_remove,
1003 /*******************************************************************/
1004 /* Module functions */
1005 /*******************************************************************/
1007 static int __init if_sdio_init_module(void)
1011 lbs_deb_enter(LBS_DEB_SDIO);
1013 printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1014 printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1016 ret = sdio_register_driver(&if_sdio_driver);
1018 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1023 static void __exit if_sdio_exit_module(void)
1025 lbs_deb_enter(LBS_DEB_SDIO);
1027 sdio_unregister_driver(&if_sdio_driver);
1029 lbs_deb_leave(LBS_DEB_SDIO);
1032 module_init(if_sdio_init_module);
1033 module_exit(if_sdio_exit_module);
1035 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1036 MODULE_AUTHOR("Pierre Ossman");
1037 MODULE_LICENSE("GPL");