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);
213 /* right shift 3 bits to get the event id */
217 lbs_deb_sdio("event packet too small (%d bytes)\n",
222 event = buffer[3] << 24;
223 event |= buffer[2] << 16;
224 event |= buffer[1] << 8;
225 event |= buffer[0] << 0;
228 lbs_queue_event(card->priv, event & 0xFF);
232 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
237 static int if_sdio_card_to_host(struct if_sdio_card *card)
241 u16 size, type, chunk;
242 unsigned long timeout;
244 lbs_deb_enter(LBS_DEB_SDIO);
246 size = if_sdio_read_scratch(card, &ret);
251 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
257 timeout = jiffies + HZ;
259 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
262 if (status & IF_SDIO_IO_RDY)
264 if (time_after(jiffies, timeout)) {
272 * The transfer must be in one transaction or the firmware
273 * goes suicidal. There's no way to guarantee that for all
274 * controllers, but we can at least try.
276 chunk = sdio_align_size(card->func, size);
278 ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
282 chunk = card->buffer[0] | (card->buffer[1] << 8);
283 type = card->buffer[2] | (card->buffer[3] << 8);
285 lbs_deb_sdio("packet of type %d and size %d bytes\n",
286 (int)type, (int)chunk);
289 lbs_deb_sdio("packet fragment (%d > %d)\n",
290 (int)chunk, (int)size);
296 lbs_deb_sdio("packet fragment (%d < %d)\n",
297 (int)chunk, (int)size);
302 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
307 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
312 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
317 lbs_deb_sdio("invalid type (%d) from firmware\n",
325 lbs_pr_err("problem fetching packet from firmware\n");
327 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
332 static void if_sdio_host_to_card_worker(struct work_struct *work)
334 struct if_sdio_card *card;
335 struct if_sdio_packet *packet;
336 unsigned long timeout;
341 lbs_deb_enter(LBS_DEB_SDIO);
343 card = container_of(work, struct if_sdio_card, packet_worker);
346 spin_lock_irqsave(&card->lock, flags);
347 packet = card->packets;
349 card->packets = packet->next;
350 spin_unlock_irqrestore(&card->lock, flags);
355 sdio_claim_host(card->func);
357 timeout = jiffies + HZ;
359 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
362 if (status & IF_SDIO_IO_RDY)
364 if (time_after(jiffies, timeout)) {
371 ret = sdio_writesb(card->func, card->ioport,
372 packet->buffer, packet->nb);
376 sdio_release_host(card->func);
381 lbs_deb_leave(LBS_DEB_SDIO);
384 /********************************************************************/
386 /********************************************************************/
388 static int if_sdio_prog_helper(struct if_sdio_card *card)
392 const struct firmware *fw;
393 unsigned long timeout;
399 lbs_deb_enter(LBS_DEB_SDIO);
401 ret = request_firmware(&fw, card->helper, &card->func->dev);
403 lbs_pr_err("can't load helper firmware\n");
407 chunk_buffer = kzalloc(64, GFP_KERNEL);
413 sdio_claim_host(card->func);
415 ret = sdio_set_block_size(card->func, 32);
423 timeout = jiffies + HZ;
425 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
428 if ((status & IF_SDIO_IO_RDY) &&
429 (status & IF_SDIO_DL_RDY))
431 if (time_after(jiffies, timeout)) {
438 chunk_size = min(size, (size_t)60);
440 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
441 memcpy(chunk_buffer + 4, firmware, chunk_size);
443 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
445 ret = sdio_writesb(card->func, card->ioport,
450 firmware += chunk_size;
454 /* an empty block marks the end of the transfer */
455 memset(chunk_buffer, 0, 4);
456 ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
460 lbs_deb_sdio("waiting for helper to boot...\n");
462 /* wait for the helper to boot by looking at the size register */
463 timeout = jiffies + HZ;
467 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
471 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
478 if (time_after(jiffies, timeout)) {
489 sdio_set_block_size(card->func, 0);
490 sdio_release_host(card->func);
493 release_firmware(fw);
497 lbs_pr_err("failed to load helper firmware\n");
499 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
504 static int if_sdio_prog_real(struct if_sdio_card *card)
508 const struct firmware *fw;
509 unsigned long timeout;
513 size_t size, req_size;
515 lbs_deb_enter(LBS_DEB_SDIO);
517 ret = request_firmware(&fw, card->firmware, &card->func->dev);
519 lbs_pr_err("can't load firmware\n");
523 chunk_buffer = kzalloc(512, GFP_KERNEL);
529 sdio_claim_host(card->func);
531 ret = sdio_set_block_size(card->func, 32);
539 timeout = jiffies + HZ;
541 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
544 if ((status & IF_SDIO_IO_RDY) &&
545 (status & IF_SDIO_DL_RDY))
547 if (time_after(jiffies, timeout)) {
554 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
558 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
562 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
565 lbs_deb_sdio("firmware helper gave up early\n");
570 if (req_size & 0x01) {
571 lbs_deb_sdio("firmware helper signalled error\n");
580 chunk_size = min(req_size, (size_t)512);
582 memcpy(chunk_buffer, firmware, chunk_size);
584 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
585 chunk_size, (chunk_size + 31) / 32 * 32);
587 ret = sdio_writesb(card->func, card->ioport,
588 chunk_buffer, roundup(chunk_size, 32));
592 firmware += chunk_size;
594 req_size -= chunk_size;
600 lbs_deb_sdio("waiting for firmware to boot...\n");
602 /* wait for the firmware to boot */
603 timeout = jiffies + HZ;
607 scratch = if_sdio_read_scratch(card, &ret);
611 if (scratch == IF_SDIO_FIRMWARE_OK)
614 if (time_after(jiffies, timeout)) {
625 sdio_set_block_size(card->func, 0);
626 sdio_release_host(card->func);
629 release_firmware(fw);
633 lbs_pr_err("failed to load firmware\n");
635 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
640 static int if_sdio_prog_firmware(struct if_sdio_card *card)
645 lbs_deb_enter(LBS_DEB_SDIO);
647 sdio_claim_host(card->func);
648 scratch = if_sdio_read_scratch(card, &ret);
649 sdio_release_host(card->func);
654 if (scratch == IF_SDIO_FIRMWARE_OK) {
655 lbs_deb_sdio("firmware already loaded\n");
659 ret = if_sdio_prog_helper(card);
663 ret = if_sdio_prog_real(card);
671 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
676 /*******************************************************************/
677 /* Libertas callbacks */
678 /*******************************************************************/
680 static int if_sdio_host_to_card(struct lbs_private *priv,
681 u8 type, u8 *buf, u16 nb)
684 struct if_sdio_card *card;
685 struct if_sdio_packet *packet, *cur;
689 lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
693 if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
699 * The transfer must be in one transaction or the firmware
700 * goes suicidal. There's no way to guarantee that for all
701 * controllers, but we can at least try.
703 size = sdio_align_size(card->func, nb + 4);
705 packet = kzalloc(sizeof(struct if_sdio_packet) + size,
716 * SDIO specific header.
718 packet->buffer[0] = (nb + 4) & 0xff;
719 packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
720 packet->buffer[2] = type;
721 packet->buffer[3] = 0;
723 memcpy(packet->buffer + 4, buf, nb);
725 spin_lock_irqsave(&card->lock, flags);
728 card->packets = packet;
738 priv->dnld_sent = DNLD_CMD_SENT;
741 priv->dnld_sent = DNLD_DATA_SENT;
744 lbs_deb_sdio("unknown packet type %d\n", (int)type);
747 spin_unlock_irqrestore(&card->lock, flags);
749 schedule_work(&card->packet_worker);
754 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
759 /*******************************************************************/
761 /*******************************************************************/
763 static void if_sdio_interrupt(struct sdio_func *func)
766 struct if_sdio_card *card;
769 lbs_deb_enter(LBS_DEB_SDIO);
771 card = sdio_get_drvdata(func);
773 cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
777 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
779 sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
784 * Ignore the define name, this really means the card has
785 * successfully received the command.
787 if (cause & IF_SDIO_H_INT_DNLD)
788 lbs_host_to_card_done(card->priv);
791 if (cause & IF_SDIO_H_INT_UPLD) {
792 ret = if_sdio_card_to_host(card);
800 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
803 static int if_sdio_probe(struct sdio_func *func,
804 const struct sdio_device_id *id)
806 struct if_sdio_card *card;
807 struct lbs_private *priv;
810 struct if_sdio_packet *packet;
812 lbs_deb_enter(LBS_DEB_SDIO);
814 for (i = 0;i < func->card->num_info;i++) {
815 if (sscanf(func->card->info[i],
816 "802.11 SDIO ID: %x", &model) == 1)
818 if (sscanf(func->card->info[i],
819 "ID: %x", &model) == 1)
821 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
827 if (i == func->card->num_info) {
828 lbs_pr_err("unable to identify card model\n");
832 card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
838 spin_lock_init(&card->lock);
839 INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
841 for (i = 0;i < ARRAY_SIZE(if_sdio_models);i++) {
842 if (card->model == if_sdio_models[i].model)
846 if (i == ARRAY_SIZE(if_sdio_models)) {
847 lbs_pr_err("unkown card model 0x%x\n", card->model);
852 card->helper = if_sdio_models[i].helper;
853 card->firmware = if_sdio_models[i].firmware;
855 if (lbs_helper_name) {
856 lbs_deb_sdio("overriding helper firmware: %s\n",
858 card->helper = lbs_helper_name;
862 lbs_deb_sdio("overriding firmware: %s\n", lbs_fw_name);
863 card->firmware = lbs_fw_name;
866 sdio_claim_host(func);
868 ret = sdio_enable_func(func);
872 ret = sdio_claim_irq(func, if_sdio_interrupt);
876 card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
880 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
884 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
888 sdio_release_host(func);
890 sdio_set_drvdata(func, card);
892 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
893 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
894 func->class, func->vendor, func->device,
895 model, (unsigned)card->ioport);
897 ret = if_sdio_prog_firmware(card);
901 priv = lbs_add_card(card, &func->dev);
910 priv->hw_host_to_card = if_sdio_host_to_card;
915 * Enable interrupts now that everything is set up
917 sdio_claim_host(func);
918 sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
919 sdio_release_host(func);
923 ret = lbs_start_card(priv);
925 goto err_activate_card;
927 if (priv->fwcapinfo & FW_CAPINFO_PS)
928 priv->ps_supported = 1;
931 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
936 flush_scheduled_work();
937 free_netdev(priv->dev);
940 sdio_claim_host(func);
942 sdio_release_irq(func);
944 sdio_disable_func(func);
946 sdio_release_host(func);
948 while (card->packets) {
949 packet = card->packets;
950 card->packets = card->packets->next;
959 static void if_sdio_remove(struct sdio_func *func)
961 struct if_sdio_card *card;
962 struct if_sdio_packet *packet;
964 lbs_deb_enter(LBS_DEB_SDIO);
966 card = sdio_get_drvdata(func);
968 card->priv->surpriseremoved = 1;
970 lbs_deb_sdio("call remove card\n");
971 lbs_stop_card(card->priv);
972 lbs_remove_card(card->priv);
974 flush_scheduled_work();
976 sdio_claim_host(func);
977 sdio_release_irq(func);
978 sdio_disable_func(func);
979 sdio_release_host(func);
981 while (card->packets) {
982 packet = card->packets;
983 card->packets = card->packets->next;
989 lbs_deb_leave(LBS_DEB_SDIO);
992 static struct sdio_driver if_sdio_driver = {
993 .name = "libertas_sdio",
994 .id_table = if_sdio_ids,
995 .probe = if_sdio_probe,
996 .remove = if_sdio_remove,
999 /*******************************************************************/
1000 /* Module functions */
1001 /*******************************************************************/
1003 static int __init if_sdio_init_module(void)
1007 lbs_deb_enter(LBS_DEB_SDIO);
1009 printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1010 printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1012 ret = sdio_register_driver(&if_sdio_driver);
1014 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1019 static void __exit if_sdio_exit_module(void)
1021 lbs_deb_enter(LBS_DEB_SDIO);
1023 sdio_unregister_driver(&if_sdio_driver);
1025 lbs_deb_leave(LBS_DEB_SDIO);
1028 module_init(if_sdio_init_module);
1029 module_exit(if_sdio_exit_module);
1031 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1032 MODULE_AUTHOR("Pierre Ossman");
1033 MODULE_LICENSE("GPL");