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;
98 struct work_struct packet_worker;
101 /********************************************************************/
103 /********************************************************************/
105 static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
110 if (card->model == 0x04)
111 reg = IF_SDIO_SCRATCH_OLD;
113 reg = IF_SDIO_SCRATCH;
115 scratch = sdio_readb(card->func, reg, &ret);
117 scratch |= sdio_readb(card->func, reg + 1, &ret) << 8;
128 static int if_sdio_handle_cmd(struct if_sdio_card *card,
129 u8 *buffer, unsigned size)
131 struct lbs_private *priv = card->priv;
136 lbs_deb_enter(LBS_DEB_SDIO);
138 if (size > LBS_CMD_BUFFER_SIZE) {
139 lbs_deb_sdio("response packet too large (%d bytes)\n",
145 spin_lock_irqsave(&priv->driver_lock, flags);
147 i = (priv->resp_idx == 0) ? 1 : 0;
148 BUG_ON(priv->resp_len[i]);
149 priv->resp_len[i] = size;
150 memcpy(priv->resp_buf[i], buffer, size);
151 lbs_notify_command_response(priv, i);
153 spin_unlock_irqrestore(&card->priv->driver_lock, flags);
158 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
162 static int if_sdio_handle_data(struct if_sdio_card *card,
163 u8 *buffer, unsigned size)
169 lbs_deb_enter(LBS_DEB_SDIO);
171 if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
172 lbs_deb_sdio("response packet too large (%d bytes)\n",
178 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
184 skb_reserve(skb, NET_IP_ALIGN);
186 data = skb_put(skb, size);
188 memcpy(data, buffer, size);
190 lbs_process_rxed_packet(card->priv, skb);
195 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
200 static int if_sdio_handle_event(struct if_sdio_card *card,
201 u8 *buffer, unsigned size)
206 lbs_deb_enter(LBS_DEB_SDIO);
208 if (card->model == 0x04) {
209 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
214 lbs_deb_sdio("event packet too small (%d bytes)\n",
219 event = buffer[3] << 24;
220 event |= buffer[2] << 16;
221 event |= buffer[1] << 8;
222 event |= buffer[0] << 0;
225 lbs_queue_event(card->priv, event & 0xFF);
229 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
234 static int if_sdio_card_to_host(struct if_sdio_card *card)
238 u16 size, type, chunk;
239 unsigned long timeout;
241 lbs_deb_enter(LBS_DEB_SDIO);
243 size = if_sdio_read_scratch(card, &ret);
248 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
254 timeout = jiffies + HZ;
256 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
259 if (status & IF_SDIO_IO_RDY)
261 if (time_after(jiffies, timeout)) {
269 * The transfer must be in one transaction or the firmware
270 * goes suicidal. There's no way to guarantee that for all
271 * controllers, but we can at least try.
273 chunk = sdio_align_size(card->func, size);
275 ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
279 chunk = card->buffer[0] | (card->buffer[1] << 8);
280 type = card->buffer[2] | (card->buffer[3] << 8);
282 lbs_deb_sdio("packet of type %d and size %d bytes\n",
283 (int)type, (int)chunk);
286 lbs_deb_sdio("packet fragment (%d > %d)\n",
287 (int)chunk, (int)size);
293 lbs_deb_sdio("packet fragment (%d < %d)\n",
294 (int)chunk, (int)size);
299 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
304 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
309 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
314 lbs_deb_sdio("invalid type (%d) from firmware\n",
322 lbs_pr_err("problem fetching packet from firmware\n");
324 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
329 static void if_sdio_host_to_card_worker(struct work_struct *work)
331 struct if_sdio_card *card;
332 struct if_sdio_packet *packet;
333 unsigned long timeout;
338 lbs_deb_enter(LBS_DEB_SDIO);
340 card = container_of(work, struct if_sdio_card, packet_worker);
343 spin_lock_irqsave(&card->lock, flags);
344 packet = card->packets;
346 card->packets = packet->next;
347 spin_unlock_irqrestore(&card->lock, flags);
352 sdio_claim_host(card->func);
354 timeout = jiffies + HZ;
356 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
359 if (status & IF_SDIO_IO_RDY)
361 if (time_after(jiffies, timeout)) {
368 ret = sdio_writesb(card->func, card->ioport,
369 packet->buffer, packet->nb);
373 sdio_release_host(card->func);
378 lbs_deb_leave(LBS_DEB_SDIO);
381 /********************************************************************/
383 /********************************************************************/
385 static int if_sdio_prog_helper(struct if_sdio_card *card)
389 const struct firmware *fw;
390 unsigned long timeout;
396 lbs_deb_enter(LBS_DEB_SDIO);
398 ret = request_firmware(&fw, card->helper, &card->func->dev);
400 lbs_pr_err("can't load helper firmware\n");
404 chunk_buffer = kzalloc(64, GFP_KERNEL);
410 sdio_claim_host(card->func);
412 ret = sdio_set_block_size(card->func, 32);
420 timeout = jiffies + HZ;
422 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
425 if ((status & IF_SDIO_IO_RDY) &&
426 (status & IF_SDIO_DL_RDY))
428 if (time_after(jiffies, timeout)) {
435 chunk_size = min(size, (size_t)60);
437 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
438 memcpy(chunk_buffer + 4, firmware, chunk_size);
440 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
442 ret = sdio_writesb(card->func, card->ioport,
447 firmware += chunk_size;
451 /* an empty block marks the end of the transfer */
452 memset(chunk_buffer, 0, 4);
453 ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
457 lbs_deb_sdio("waiting for helper to boot...\n");
459 /* wait for the helper to boot by looking at the size register */
460 timeout = jiffies + HZ;
464 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
468 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
475 if (time_after(jiffies, timeout)) {
486 sdio_set_block_size(card->func, 0);
487 sdio_release_host(card->func);
490 release_firmware(fw);
494 lbs_pr_err("failed to load helper firmware\n");
496 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
501 static int if_sdio_prog_real(struct if_sdio_card *card)
505 const struct firmware *fw;
506 unsigned long timeout;
510 size_t size, req_size;
512 lbs_deb_enter(LBS_DEB_SDIO);
514 ret = request_firmware(&fw, card->firmware, &card->func->dev);
516 lbs_pr_err("can't load firmware\n");
520 chunk_buffer = kzalloc(512, GFP_KERNEL);
526 sdio_claim_host(card->func);
528 ret = sdio_set_block_size(card->func, 32);
536 timeout = jiffies + HZ;
538 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
541 if ((status & IF_SDIO_IO_RDY) &&
542 (status & IF_SDIO_DL_RDY))
544 if (time_after(jiffies, timeout)) {
551 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
555 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
559 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
562 lbs_deb_sdio("firmware helper gave up early\n");
567 if (req_size & 0x01) {
568 lbs_deb_sdio("firmware helper signalled error\n");
577 chunk_size = min(req_size, (size_t)512);
579 memcpy(chunk_buffer, firmware, chunk_size);
581 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
582 chunk_size, (chunk_size + 31) / 32 * 32);
584 ret = sdio_writesb(card->func, card->ioport,
585 chunk_buffer, roundup(chunk_size, 32));
589 firmware += chunk_size;
591 req_size -= chunk_size;
597 lbs_deb_sdio("waiting for firmware to boot...\n");
599 /* wait for the firmware to boot */
600 timeout = jiffies + HZ;
604 scratch = if_sdio_read_scratch(card, &ret);
608 if (scratch == IF_SDIO_FIRMWARE_OK)
611 if (time_after(jiffies, timeout)) {
622 sdio_set_block_size(card->func, 0);
623 sdio_release_host(card->func);
626 release_firmware(fw);
630 lbs_pr_err("failed to load firmware\n");
632 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
637 static int if_sdio_prog_firmware(struct if_sdio_card *card)
642 lbs_deb_enter(LBS_DEB_SDIO);
644 sdio_claim_host(card->func);
645 scratch = if_sdio_read_scratch(card, &ret);
646 sdio_release_host(card->func);
651 if (scratch == IF_SDIO_FIRMWARE_OK) {
652 lbs_deb_sdio("firmware already loaded\n");
656 ret = if_sdio_prog_helper(card);
660 ret = if_sdio_prog_real(card);
668 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
673 /*******************************************************************/
674 /* Libertas callbacks */
675 /*******************************************************************/
677 static int if_sdio_host_to_card(struct lbs_private *priv,
678 u8 type, u8 *buf, u16 nb)
681 struct if_sdio_card *card;
682 struct if_sdio_packet *packet, *cur;
686 lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
690 if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
696 * The transfer must be in one transaction or the firmware
697 * goes suicidal. There's no way to guarantee that for all
698 * controllers, but we can at least try.
700 size = sdio_align_size(card->func, nb + 4);
702 packet = kzalloc(sizeof(struct if_sdio_packet) + size,
713 * SDIO specific header.
715 packet->buffer[0] = (nb + 4) & 0xff;
716 packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
717 packet->buffer[2] = type;
718 packet->buffer[3] = 0;
720 memcpy(packet->buffer + 4, buf, nb);
722 spin_lock_irqsave(&card->lock, flags);
725 card->packets = packet;
735 priv->dnld_sent = DNLD_CMD_SENT;
738 priv->dnld_sent = DNLD_DATA_SENT;
741 lbs_deb_sdio("unknown packet type %d\n", (int)type);
744 spin_unlock_irqrestore(&card->lock, flags);
746 schedule_work(&card->packet_worker);
751 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
756 /*******************************************************************/
758 /*******************************************************************/
760 static void if_sdio_interrupt(struct sdio_func *func)
763 struct if_sdio_card *card;
766 lbs_deb_enter(LBS_DEB_SDIO);
768 card = sdio_get_drvdata(func);
770 cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
774 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
776 sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
781 * Ignore the define name, this really means the card has
782 * successfully received the command.
784 if (cause & IF_SDIO_H_INT_DNLD)
785 lbs_host_to_card_done(card->priv);
788 if (cause & IF_SDIO_H_INT_UPLD) {
789 ret = if_sdio_card_to_host(card);
797 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
800 static int if_sdio_probe(struct sdio_func *func,
801 const struct sdio_device_id *id)
803 struct if_sdio_card *card;
804 struct lbs_private *priv;
807 struct if_sdio_packet *packet;
809 lbs_deb_enter(LBS_DEB_SDIO);
811 for (i = 0;i < func->card->num_info;i++) {
812 if (sscanf(func->card->info[i],
813 "802.11 SDIO ID: %x", &model) == 1)
815 if (sscanf(func->card->info[i],
816 "ID: %x", &model) == 1)
818 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
824 if (i == func->card->num_info) {
825 lbs_pr_err("unable to identify card model\n");
829 card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
835 spin_lock_init(&card->lock);
836 INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
838 for (i = 0;i < ARRAY_SIZE(if_sdio_models);i++) {
839 if (card->model == if_sdio_models[i].model)
843 if (i == ARRAY_SIZE(if_sdio_models)) {
844 lbs_pr_err("unkown card model 0x%x\n", card->model);
849 card->helper = if_sdio_models[i].helper;
850 card->firmware = if_sdio_models[i].firmware;
852 if (lbs_helper_name) {
853 lbs_deb_sdio("overriding helper firmware: %s\n",
855 card->helper = lbs_helper_name;
859 lbs_deb_sdio("overriding firmware: %s\n", lbs_fw_name);
860 card->firmware = lbs_fw_name;
863 sdio_claim_host(func);
865 ret = sdio_enable_func(func);
869 ret = sdio_claim_irq(func, if_sdio_interrupt);
873 card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
877 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
881 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
885 sdio_release_host(func);
887 sdio_set_drvdata(func, card);
889 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
890 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
891 func->class, func->vendor, func->device,
892 model, (unsigned)card->ioport);
894 ret = if_sdio_prog_firmware(card);
898 priv = lbs_add_card(card, &func->dev);
907 priv->hw_host_to_card = if_sdio_host_to_card;
912 * Enable interrupts now that everything is set up
914 sdio_claim_host(func);
915 sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
916 sdio_release_host(func);
920 ret = lbs_start_card(priv);
922 goto err_activate_card;
925 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
930 flush_scheduled_work();
931 free_netdev(priv->dev);
934 sdio_claim_host(func);
936 sdio_release_irq(func);
938 sdio_disable_func(func);
940 sdio_release_host(func);
942 while (card->packets) {
943 packet = card->packets;
944 card->packets = card->packets->next;
953 static void if_sdio_remove(struct sdio_func *func)
955 struct if_sdio_card *card;
956 struct if_sdio_packet *packet;
958 lbs_deb_enter(LBS_DEB_SDIO);
960 card = sdio_get_drvdata(func);
962 card->priv->surpriseremoved = 1;
964 lbs_deb_sdio("call remove card\n");
965 lbs_stop_card(card->priv);
966 lbs_remove_card(card->priv);
968 flush_scheduled_work();
970 sdio_claim_host(func);
971 sdio_release_irq(func);
972 sdio_disable_func(func);
973 sdio_release_host(func);
975 while (card->packets) {
976 packet = card->packets;
977 card->packets = card->packets->next;
983 lbs_deb_leave(LBS_DEB_SDIO);
986 static struct sdio_driver if_sdio_driver = {
987 .name = "libertas_sdio",
988 .id_table = if_sdio_ids,
989 .probe = if_sdio_probe,
990 .remove = if_sdio_remove,
993 /*******************************************************************/
994 /* Module functions */
995 /*******************************************************************/
997 static int __init if_sdio_init_module(void)
1001 lbs_deb_enter(LBS_DEB_SDIO);
1003 printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1004 printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1006 ret = sdio_register_driver(&if_sdio_driver);
1008 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1013 static void __exit if_sdio_exit_module(void)
1015 lbs_deb_enter(LBS_DEB_SDIO);
1017 sdio_unregister_driver(&if_sdio_driver);
1019 lbs_deb_leave(LBS_DEB_SDIO);
1022 module_init(if_sdio_init_module);
1023 module_exit(if_sdio_exit_module);
1025 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1026 MODULE_AUTHOR("Pierre Ossman");
1027 MODULE_LICENSE("GPL");