2 * linux/drivers/net/wireless/libertas/if_sdio.c
4 * Copyright 2007 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/moduleparam.h>
30 #include <linux/firmware.h>
31 #include <linux/netdevice.h>
32 #include <linux/delay.h>
33 #include <linux/mmc/card.h>
34 #include <linux/mmc/sdio_func.h>
35 #include <linux/mmc/sdio_ids.h>
43 static char *libertas_helper_name = NULL;
44 module_param_named(helper_name, libertas_helper_name, charp, 0644);
46 static char *libertas_fw_name = NULL;
47 module_param_named(fw_name, libertas_fw_name, charp, 0644);
49 static const struct sdio_device_id if_sdio_ids[] = {
50 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, SDIO_DEVICE_ID_MARVELL_LIBERTAS) },
51 { /* end: all zeroes */ },
54 MODULE_DEVICE_TABLE(sdio, if_sdio_ids);
56 struct if_sdio_model {
62 static struct if_sdio_model if_sdio_models[] = {
66 .helper = "sd8385_helper.bin",
67 .firmware = "sd8385.bin",
72 .helper = "sd8686_helper.bin",
73 .firmware = "sd8686.bin",
77 struct if_sdio_packet {
78 struct if_sdio_packet *next;
80 u8 buffer[0] __attribute__((aligned(4)));
84 struct sdio_func *func;
98 struct if_sdio_packet *packets;
99 struct work_struct packet_worker;
102 /********************************************************************/
104 /********************************************************************/
106 static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
111 if (card->model == 0x04)
112 reg = IF_SDIO_SCRATCH_OLD;
114 reg = IF_SDIO_SCRATCH;
116 scratch = sdio_readb(card->func, reg, &ret);
118 scratch |= sdio_readb(card->func, reg + 1, &ret) << 8;
129 static int if_sdio_handle_cmd(struct if_sdio_card *card,
130 u8 *buffer, unsigned size)
135 lbs_deb_enter(LBS_DEB_SDIO);
137 spin_lock_irqsave(&card->priv->adapter->driver_lock, flags);
139 if (!card->priv->adapter->cur_cmd) {
140 lbs_deb_sdio("discarding spurious response\n");
145 if (size > MRVDRV_SIZE_OF_CMD_BUFFER) {
146 lbs_deb_sdio("response packet too large (%d bytes)\n",
152 memcpy(card->priv->adapter->cur_cmd->bufvirtualaddr, buffer, size);
153 card->priv->upld_len = size;
155 card->int_cause |= MRVDRV_CMD_UPLD_RDY;
157 libertas_interrupt(card->priv->dev);
162 spin_unlock_irqrestore(&card->priv->adapter->driver_lock, flags);
164 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
169 static int if_sdio_handle_data(struct if_sdio_card *card,
170 u8 *buffer, unsigned size)
176 lbs_deb_enter(LBS_DEB_SDIO);
178 if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
179 lbs_deb_sdio("response packet too large (%d bytes)\n",
185 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE);
191 data = skb_put(skb, size);
193 memcpy(data, buffer, size);
195 libertas_process_rxed_packet(card->priv, skb);
200 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
205 static int if_sdio_handle_event(struct if_sdio_card *card,
206 u8 *buffer, unsigned size)
212 lbs_deb_enter(LBS_DEB_SDIO);
214 if (card->model == 0x04) {
215 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
220 lbs_deb_sdio("event packet too small (%d bytes)\n",
225 event = buffer[3] << 24;
226 event |= buffer[2] << 16;
227 event |= buffer[1] << 8;
228 event |= buffer[0] << 0;
229 event <<= SBI_EVENT_CAUSE_SHIFT;
232 spin_lock_irqsave(&card->priv->adapter->driver_lock, flags);
235 card->int_cause |= MRVDRV_CARDEVENT;
237 libertas_interrupt(card->priv->dev);
239 spin_unlock_irqrestore(&card->priv->adapter->driver_lock, flags);
244 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
249 static int if_sdio_card_to_host(struct if_sdio_card *card)
253 u16 size, type, chunk;
254 unsigned long timeout;
256 lbs_deb_enter(LBS_DEB_SDIO);
258 size = if_sdio_read_scratch(card, &ret);
263 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
269 timeout = jiffies + HZ;
271 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
274 if (status & IF_SDIO_IO_RDY)
276 if (time_after(jiffies, timeout)) {
284 * The transfer must be in one transaction or the firmware
288 if ((chunk > card->func->cur_blksize) || (chunk > 512)) {
289 chunk = (chunk + card->func->cur_blksize - 1) /
290 card->func->cur_blksize * card->func->cur_blksize;
293 ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
297 chunk = card->buffer[0] | (card->buffer[1] << 8);
298 type = card->buffer[2] | (card->buffer[3] << 8);
300 lbs_deb_sdio("packet of type %d and size %d bytes\n",
301 (int)type, (int)chunk);
304 lbs_deb_sdio("packet fragment (%d > %d)\n",
305 (int)chunk, (int)size);
311 lbs_deb_sdio("packet fragment (%d < %d)\n",
312 (int)chunk, (int)size);
317 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
322 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
327 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
332 lbs_deb_sdio("invalid type (%d) from firmware\n",
340 lbs_pr_err("problem fetching packet from firmware\n");
342 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
347 static void if_sdio_host_to_card_worker(struct work_struct *work)
349 struct if_sdio_card *card;
350 struct if_sdio_packet *packet;
351 unsigned long timeout;
356 lbs_deb_enter(LBS_DEB_SDIO);
358 card = container_of(work, struct if_sdio_card, packet_worker);
361 spin_lock_irqsave(&card->lock, flags);
362 packet = card->packets;
364 card->packets = packet->next;
365 spin_unlock_irqrestore(&card->lock, flags);
370 sdio_claim_host(card->func);
372 timeout = jiffies + HZ;
374 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
377 if (status & IF_SDIO_IO_RDY)
379 if (time_after(jiffies, timeout)) {
386 ret = sdio_writesb(card->func, card->ioport,
387 packet->buffer, packet->nb);
391 sdio_release_host(card->func);
396 lbs_deb_leave(LBS_DEB_SDIO);
399 /********************************************************************/
401 /********************************************************************/
403 static int if_sdio_prog_helper(struct if_sdio_card *card)
407 const struct firmware *fw;
408 unsigned long timeout;
414 lbs_deb_enter(LBS_DEB_SDIO);
416 ret = request_firmware(&fw, card->helper, &card->func->dev);
418 lbs_pr_err("can't load helper firmware\n");
422 chunk_buffer = kzalloc(64, GFP_KERNEL);
428 sdio_claim_host(card->func);
430 ret = sdio_set_block_size(card->func, 32);
438 timeout = jiffies + HZ;
440 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
443 if ((status & IF_SDIO_IO_RDY) &&
444 (status & IF_SDIO_DL_RDY))
446 if (time_after(jiffies, timeout)) {
453 chunk_size = min(size, (size_t)60);
455 *((u32*)chunk_buffer) = cpu_to_le32(chunk_size);
456 memcpy(chunk_buffer + 4, firmware, chunk_size);
458 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
460 ret = sdio_writesb(card->func, card->ioport,
465 firmware += chunk_size;
469 /* an empty block marks the end of the transfer */
470 memset(chunk_buffer, 0, 4);
471 ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
475 lbs_deb_sdio("waiting for helper to boot...\n");
477 /* wait for the helper to boot by looking at the size register */
478 timeout = jiffies + HZ;
482 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
486 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
493 if (time_after(jiffies, timeout)) {
504 sdio_set_block_size(card->func, 0);
505 sdio_release_host(card->func);
508 release_firmware(fw);
512 lbs_pr_err("failed to load helper firmware\n");
514 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
519 static int if_sdio_prog_real(struct if_sdio_card *card)
523 const struct firmware *fw;
524 unsigned long timeout;
528 size_t size, req_size;
530 lbs_deb_enter(LBS_DEB_SDIO);
532 ret = request_firmware(&fw, card->firmware, &card->func->dev);
534 lbs_pr_err("can't load firmware\n");
538 chunk_buffer = kzalloc(512, GFP_KERNEL);
544 sdio_claim_host(card->func);
546 ret = sdio_set_block_size(card->func, 32);
554 timeout = jiffies + HZ;
556 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
559 if ((status & IF_SDIO_IO_RDY) &&
560 (status & IF_SDIO_DL_RDY))
562 if (time_after(jiffies, timeout)) {
569 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
573 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
577 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
580 lbs_deb_sdio("firmware helper gave up early\n");
585 if (req_size & 0x01) {
586 lbs_deb_sdio("firmware helper signalled error\n");
595 chunk_size = min(req_size, (size_t)512);
597 memcpy(chunk_buffer, firmware, chunk_size);
599 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
600 chunk_size, (chunk_size + 31) / 32 * 32);
602 ret = sdio_writesb(card->func, card->ioport,
603 chunk_buffer, (chunk_size + 31) / 32 * 32);
607 firmware += chunk_size;
609 req_size -= chunk_size;
615 lbs_deb_sdio("waiting for firmware to boot...\n");
617 /* wait for the firmware to boot */
618 timeout = jiffies + HZ;
622 scratch = if_sdio_read_scratch(card, &ret);
626 if (scratch == IF_SDIO_FIRMWARE_OK)
629 if (time_after(jiffies, timeout)) {
640 sdio_set_block_size(card->func, 0);
641 sdio_release_host(card->func);
644 release_firmware(fw);
648 lbs_pr_err("failed to load firmware\n");
650 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
655 static int if_sdio_prog_firmware(struct if_sdio_card *card)
660 lbs_deb_enter(LBS_DEB_SDIO);
662 sdio_claim_host(card->func);
663 scratch = if_sdio_read_scratch(card, &ret);
664 sdio_release_host(card->func);
669 if (scratch == IF_SDIO_FIRMWARE_OK) {
670 lbs_deb_sdio("firmware already loaded\n");
674 ret = if_sdio_prog_helper(card);
678 ret = if_sdio_prog_real(card);
686 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
691 /*******************************************************************/
692 /* Libertas callbacks */
693 /*******************************************************************/
695 static int if_sdio_host_to_card(wlan_private *priv, u8 type, u8 *buf, u16 nb)
698 struct if_sdio_card *card;
699 struct if_sdio_packet *packet, *cur;
703 lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
707 if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
713 * The transfer must be in one transaction or the firmware
717 if ((size > card->func->cur_blksize) || (size > 512)) {
718 size = (size + card->func->cur_blksize - 1) /
719 card->func->cur_blksize * card->func->cur_blksize;
722 packet = kzalloc(sizeof(struct if_sdio_packet) + size,
733 * SDIO specific header.
735 packet->buffer[0] = (nb + 4) & 0xff;
736 packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
737 packet->buffer[2] = type;
738 packet->buffer[3] = 0;
740 memcpy(packet->buffer + 4, buf, nb);
742 spin_lock_irqsave(&card->lock, flags);
745 card->packets = packet;
755 priv->dnld_sent = DNLD_CMD_SENT;
758 priv->dnld_sent = DNLD_DATA_SENT;
761 lbs_deb_sdio("unknown packet type %d\n", (int)type);
764 spin_unlock_irqrestore(&card->lock, flags);
766 schedule_work(&card->packet_worker);
771 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
776 static int if_sdio_get_int_status(wlan_private *priv, u8 *ireg)
778 struct if_sdio_card *card;
780 lbs_deb_enter(LBS_DEB_SDIO);
784 *ireg = card->int_cause;
787 lbs_deb_leave(LBS_DEB_SDIO);
792 static int if_sdio_read_event_cause(wlan_private *priv)
794 struct if_sdio_card *card;
796 lbs_deb_enter(LBS_DEB_SDIO);
800 priv->adapter->eventcause = card->event;
802 lbs_deb_leave(LBS_DEB_SDIO);
807 /*******************************************************************/
809 /*******************************************************************/
811 static void if_sdio_interrupt(struct sdio_func *func)
814 struct if_sdio_card *card;
817 lbs_deb_enter(LBS_DEB_SDIO);
819 card = sdio_get_drvdata(func);
821 cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
825 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
827 sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
832 * Ignore the define name, this really means the card has
833 * successfully received the command.
835 if (cause & IF_SDIO_H_INT_DNLD) {
836 if ((card->priv->dnld_sent == DNLD_DATA_SENT) &&
837 (card->priv->adapter->connect_status == LIBERTAS_CONNECTED))
838 netif_wake_queue(card->priv->dev);
839 card->priv->dnld_sent = DNLD_RES_RECEIVED;
842 if (cause & IF_SDIO_H_INT_UPLD) {
843 ret = if_sdio_card_to_host(card);
851 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
854 static int if_sdio_probe(struct sdio_func *func,
855 const struct sdio_device_id *id)
857 struct if_sdio_card *card;
861 struct if_sdio_packet *packet;
863 lbs_deb_enter(LBS_DEB_SDIO);
865 for (i = 0;i < func->card->num_info;i++) {
866 if (sscanf(func->card->info[i],
867 "802.11 SDIO ID: %x", &model) == 1)
869 if (sscanf(func->card->info[i],
870 "ID: %x", &model) == 1)
874 if (i == func->card->num_info) {
875 lbs_pr_err("unable to identify card model\n");
879 card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
885 spin_lock_init(&card->lock);
886 INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
888 for (i = 0;i < ARRAY_SIZE(if_sdio_models);i++) {
889 if (card->model == if_sdio_models[i].model)
893 if (i == ARRAY_SIZE(if_sdio_models)) {
894 lbs_pr_err("unkown card model 0x%x\n", card->model);
899 card->helper = if_sdio_models[i].helper;
900 card->firmware = if_sdio_models[i].firmware;
902 if (libertas_helper_name) {
903 lbs_deb_sdio("overriding helper firmware: %s\n",
904 libertas_helper_name);
905 card->helper = libertas_helper_name;
908 if (libertas_fw_name) {
909 lbs_deb_sdio("overriding firmware: %s\n", libertas_fw_name);
910 card->firmware = libertas_fw_name;
913 sdio_claim_host(func);
915 ret = sdio_enable_func(func);
919 ret = sdio_claim_irq(func, if_sdio_interrupt);
923 card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
927 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
931 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
935 sdio_release_host(func);
937 sdio_set_drvdata(func, card);
939 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
940 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
941 func->class, func->vendor, func->device,
942 model, (unsigned)card->ioport);
944 ret = if_sdio_prog_firmware(card);
948 priv = libertas_add_card(card, &func->dev);
957 priv->hw_host_to_card = if_sdio_host_to_card;
958 priv->hw_get_int_status = if_sdio_get_int_status;
959 priv->hw_read_event_cause = if_sdio_read_event_cause;
961 priv->adapter->fw_ready = 1;
964 * Enable interrupts now that everything is set up
966 sdio_claim_host(func);
967 sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
968 sdio_release_host(func);
972 ret = libertas_start_card(priv);
974 goto err_activate_card;
977 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
982 flush_scheduled_work();
983 free_netdev(priv->dev);
984 kfree(priv->adapter);
986 sdio_claim_host(func);
988 sdio_release_irq(func);
990 sdio_disable_func(func);
992 sdio_release_host(func);
994 while (card->packets) {
995 packet = card->packets;
996 card->packets = card->packets->next;
1005 static void if_sdio_remove(struct sdio_func *func)
1007 struct if_sdio_card *card;
1008 struct if_sdio_packet *packet;
1010 lbs_deb_enter(LBS_DEB_SDIO);
1012 card = sdio_get_drvdata(func);
1014 card->priv->adapter->surpriseremoved = 1;
1016 lbs_deb_sdio("call remove card\n");
1017 libertas_stop_card(card->priv);
1018 libertas_remove_card(card->priv);
1020 flush_scheduled_work();
1022 sdio_claim_host(func);
1023 sdio_release_irq(func);
1024 sdio_disable_func(func);
1025 sdio_release_host(func);
1027 while (card->packets) {
1028 packet = card->packets;
1029 card->packets = card->packets->next;
1035 lbs_deb_leave(LBS_DEB_SDIO);
1038 static struct sdio_driver if_sdio_driver = {
1039 .name = "libertas_sdio",
1040 .id_table = if_sdio_ids,
1041 .probe = if_sdio_probe,
1042 .remove = if_sdio_remove,
1045 /*******************************************************************/
1046 /* Module functions */
1047 /*******************************************************************/
1049 static int if_sdio_init_module(void)
1053 lbs_deb_enter(LBS_DEB_SDIO);
1055 printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1056 printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1058 ret = sdio_register_driver(&if_sdio_driver);
1060 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1065 static void if_sdio_exit_module(void)
1067 lbs_deb_enter(LBS_DEB_SDIO);
1069 sdio_unregister_driver(&if_sdio_driver);
1071 lbs_deb_leave(LBS_DEB_SDIO);
1074 module_init(if_sdio_init_module);
1075 module_exit(if_sdio_exit_module);
1077 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1078 MODULE_AUTHOR("Pierre Ossman");
1079 MODULE_LICENSE("GPL");