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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31 #include <linux/kernel.h>
32 #include <linux/module.h>
33 #include <linux/slab.h>
34 #include <linux/firmware.h>
35 #include <linux/netdevice.h>
36 #include <linux/delay.h>
37 #include <linux/mmc/card.h>
38 #include <linux/mmc/sdio_func.h>
39 #include <linux/mmc/sdio_ids.h>
40 #include <linux/mmc/sdio.h>
41 #include <linux/mmc/host.h>
42 #include <linux/pm_runtime.h>
51 static void if_sdio_interrupt(struct sdio_func *func);
53 /* The if_sdio_remove() callback function is called when
54 * user removes this module from kernel space or ejects
55 * the card from the slot. The driver handles these 2 cases
56 * differently for SD8688 combo chip.
57 * If the user is removing the module, the FUNC_SHUTDOWN
58 * command for SD8688 is sent to the firmware.
59 * If the card is removed, there is no need to send this command.
61 * The variable 'user_rmmod' is used to distinguish these two
62 * scenarios. This flag is initialized as FALSE in case the card
63 * is removed, and will be set to TRUE for module removal when
64 * module_exit function is called.
68 static const struct sdio_device_id if_sdio_ids[] = {
69 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
70 SDIO_DEVICE_ID_MARVELL_LIBERTAS) },
71 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
72 SDIO_DEVICE_ID_MARVELL_8688WLAN) },
73 { /* end: all zeroes */ },
76 MODULE_DEVICE_TABLE(sdio, if_sdio_ids);
78 #define MODEL_8385 0x04
79 #define MODEL_8686 0x0b
80 #define MODEL_8688 0x10
82 static const struct lbs_fw_table fw_table[] = {
83 { MODEL_8385, "libertas/sd8385_helper.bin", "libertas/sd8385.bin" },
84 { MODEL_8385, "sd8385_helper.bin", "sd8385.bin" },
85 { MODEL_8686, "libertas/sd8686_v9_helper.bin", "libertas/sd8686_v9.bin" },
86 { MODEL_8686, "libertas/sd8686_v8_helper.bin", "libertas/sd8686_v8.bin" },
87 { MODEL_8686, "sd8686_helper.bin", "sd8686.bin" },
88 { MODEL_8688, "libertas/sd8688_helper.bin", "libertas/sd8688.bin" },
89 { MODEL_8688, "sd8688_helper.bin", "sd8688.bin" },
92 MODULE_FIRMWARE("libertas/sd8385_helper.bin");
93 MODULE_FIRMWARE("libertas/sd8385.bin");
94 MODULE_FIRMWARE("sd8385_helper.bin");
95 MODULE_FIRMWARE("sd8385.bin");
96 MODULE_FIRMWARE("libertas/sd8686_v9_helper.bin");
97 MODULE_FIRMWARE("libertas/sd8686_v9.bin");
98 MODULE_FIRMWARE("libertas/sd8686_v8_helper.bin");
99 MODULE_FIRMWARE("libertas/sd8686_v8.bin");
100 MODULE_FIRMWARE("sd8686_helper.bin");
101 MODULE_FIRMWARE("sd8686.bin");
102 MODULE_FIRMWARE("libertas/sd8688_helper.bin");
103 MODULE_FIRMWARE("libertas/sd8688.bin");
104 MODULE_FIRMWARE("sd8688_helper.bin");
105 MODULE_FIRMWARE("sd8688.bin");
107 struct if_sdio_packet {
108 struct if_sdio_packet *next;
110 u8 buffer[0] __attribute__((aligned(4)));
113 struct if_sdio_card {
114 struct sdio_func *func;
115 struct lbs_private *priv;
118 unsigned long ioport;
119 unsigned int scratch_reg;
121 wait_queue_head_t pwron_waitq;
123 u8 buffer[65536] __attribute__((aligned(4)));
126 struct if_sdio_packet *packets;
128 struct workqueue_struct *workqueue;
129 struct work_struct packet_worker;
134 static void if_sdio_finish_power_on(struct if_sdio_card *card);
135 static int if_sdio_power_off(struct if_sdio_card *card);
137 /********************************************************************/
139 /********************************************************************/
142 * For SD8385/SD8686, this function reads firmware status after
143 * the image is downloaded, or reads RX packet length when
144 * interrupt (with IF_SDIO_H_INT_UPLD bit set) is received.
145 * For SD8688, this function reads firmware status only.
147 static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
152 scratch = sdio_readb(card->func, card->scratch_reg, &ret);
154 scratch |= sdio_readb(card->func, card->scratch_reg + 1,
166 static u8 if_sdio_read_rx_unit(struct if_sdio_card *card)
171 rx_unit = sdio_readb(card->func, IF_SDIO_RX_UNIT, &ret);
179 static u16 if_sdio_read_rx_len(struct if_sdio_card *card, int *err)
184 switch (card->model) {
187 rx_len = if_sdio_read_scratch(card, &ret);
190 default: /* for newer chipsets */
191 rx_len = sdio_readb(card->func, IF_SDIO_RX_LEN, &ret);
193 rx_len <<= card->rx_unit;
195 rx_len = 0xffff; /* invalid length */
206 static int if_sdio_handle_cmd(struct if_sdio_card *card,
207 u8 *buffer, unsigned size)
209 struct lbs_private *priv = card->priv;
214 lbs_deb_enter(LBS_DEB_SDIO);
216 if (size > LBS_CMD_BUFFER_SIZE) {
217 lbs_deb_sdio("response packet too large (%d bytes)\n",
223 spin_lock_irqsave(&priv->driver_lock, flags);
225 i = (priv->resp_idx == 0) ? 1 : 0;
226 BUG_ON(priv->resp_len[i]);
227 priv->resp_len[i] = size;
228 memcpy(priv->resp_buf[i], buffer, size);
229 lbs_notify_command_response(priv, i);
231 spin_unlock_irqrestore(&card->priv->driver_lock, flags);
236 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
240 static int if_sdio_handle_data(struct if_sdio_card *card,
241 u8 *buffer, unsigned size)
247 lbs_deb_enter(LBS_DEB_SDIO);
249 if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
250 lbs_deb_sdio("response packet too large (%d bytes)\n",
256 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
262 skb_reserve(skb, NET_IP_ALIGN);
264 data = skb_put(skb, size);
266 memcpy(data, buffer, size);
268 lbs_process_rxed_packet(card->priv, skb);
273 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
278 static int if_sdio_handle_event(struct if_sdio_card *card,
279 u8 *buffer, unsigned size)
284 lbs_deb_enter(LBS_DEB_SDIO);
286 if (card->model == MODEL_8385) {
287 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
291 /* right shift 3 bits to get the event id */
295 lbs_deb_sdio("event packet too small (%d bytes)\n",
300 event = buffer[3] << 24;
301 event |= buffer[2] << 16;
302 event |= buffer[1] << 8;
303 event |= buffer[0] << 0;
306 lbs_queue_event(card->priv, event & 0xFF);
310 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
315 static int if_sdio_wait_status(struct if_sdio_card *card, const u8 condition)
318 unsigned long timeout;
321 timeout = jiffies + HZ;
323 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
326 if ((status & condition) == condition)
328 if (time_after(jiffies, timeout))
335 static int if_sdio_card_to_host(struct if_sdio_card *card)
338 u16 size, type, chunk;
340 lbs_deb_enter(LBS_DEB_SDIO);
342 size = if_sdio_read_rx_len(card, &ret);
347 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
353 ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
358 * The transfer must be in one transaction or the firmware
359 * goes suicidal. There's no way to guarantee that for all
360 * controllers, but we can at least try.
362 chunk = sdio_align_size(card->func, size);
364 ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
368 chunk = card->buffer[0] | (card->buffer[1] << 8);
369 type = card->buffer[2] | (card->buffer[3] << 8);
371 lbs_deb_sdio("packet of type %d and size %d bytes\n",
372 (int)type, (int)chunk);
375 lbs_deb_sdio("packet fragment (%d > %d)\n",
376 (int)chunk, (int)size);
382 lbs_deb_sdio("packet fragment (%d < %d)\n",
383 (int)chunk, (int)size);
388 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
393 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
398 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
403 lbs_deb_sdio("invalid type (%d) from firmware\n",
411 pr_err("problem fetching packet from firmware\n");
413 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
418 static void if_sdio_host_to_card_worker(struct work_struct *work)
420 struct if_sdio_card *card;
421 struct if_sdio_packet *packet;
425 lbs_deb_enter(LBS_DEB_SDIO);
427 card = container_of(work, struct if_sdio_card, packet_worker);
430 spin_lock_irqsave(&card->lock, flags);
431 packet = card->packets;
433 card->packets = packet->next;
434 spin_unlock_irqrestore(&card->lock, flags);
439 sdio_claim_host(card->func);
441 ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
443 ret = sdio_writesb(card->func, card->ioport,
444 packet->buffer, packet->nb);
448 pr_err("error %d sending packet to firmware\n", ret);
450 sdio_release_host(card->func);
455 lbs_deb_leave(LBS_DEB_SDIO);
458 /********************************************************************/
460 /********************************************************************/
462 #define FW_DL_READY_STATUS (IF_SDIO_IO_RDY | IF_SDIO_DL_RDY)
464 static int if_sdio_prog_helper(struct if_sdio_card *card,
465 const struct firmware *fw)
468 unsigned long timeout;
474 lbs_deb_enter(LBS_DEB_SDIO);
476 chunk_buffer = kzalloc(64, GFP_KERNEL);
482 sdio_claim_host(card->func);
484 ret = sdio_set_block_size(card->func, 32);
492 ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
496 /* On some platforms (like Davinci) the chip needs more time
497 * between helper blocks.
501 chunk_size = min(size, (size_t)60);
503 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
504 memcpy(chunk_buffer + 4, firmware, chunk_size);
506 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
508 ret = sdio_writesb(card->func, card->ioport,
513 firmware += chunk_size;
517 /* an empty block marks the end of the transfer */
518 memset(chunk_buffer, 0, 4);
519 ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
523 lbs_deb_sdio("waiting for helper to boot...\n");
525 /* wait for the helper to boot by looking at the size register */
526 timeout = jiffies + HZ;
530 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
534 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
541 if (time_after(jiffies, timeout)) {
552 sdio_release_host(card->func);
557 pr_err("failed to load helper firmware\n");
559 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
563 static int if_sdio_prog_real(struct if_sdio_card *card,
564 const struct firmware *fw)
567 unsigned long timeout;
571 size_t size, req_size;
573 lbs_deb_enter(LBS_DEB_SDIO);
575 chunk_buffer = kzalloc(512, GFP_KERNEL);
581 sdio_claim_host(card->func);
583 ret = sdio_set_block_size(card->func, 32);
591 timeout = jiffies + HZ;
593 ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
597 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE,
602 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1,
608 * For SD8688 wait until the length is not 0, 1 or 2
609 * before downloading the first FW block,
610 * since BOOT code writes the register to indicate the
611 * helper/FW download winner,
612 * the value could be 1 or 2 (Func1 or Func2).
614 if ((size != fw->size) || (req_size > 2))
616 if (time_after(jiffies, timeout)) {
624 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
627 lbs_deb_sdio("firmware helper gave up early\n");
632 if (req_size & 0x01) {
633 lbs_deb_sdio("firmware helper signalled error\n");
642 chunk_size = min(req_size, (size_t)512);
644 memcpy(chunk_buffer, firmware, chunk_size);
646 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
647 chunk_size, (chunk_size + 31) / 32 * 32);
649 ret = sdio_writesb(card->func, card->ioport,
650 chunk_buffer, roundup(chunk_size, 32));
654 firmware += chunk_size;
656 req_size -= chunk_size;
662 lbs_deb_sdio("waiting for firmware to boot...\n");
664 /* wait for the firmware to boot */
665 timeout = jiffies + HZ;
669 scratch = if_sdio_read_scratch(card, &ret);
673 if (scratch == IF_SDIO_FIRMWARE_OK)
676 if (time_after(jiffies, timeout)) {
687 sdio_release_host(card->func);
692 pr_err("failed to load firmware\n");
694 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
698 static void if_sdio_do_prog_firmware(struct lbs_private *priv, int ret,
699 const struct firmware *helper,
700 const struct firmware *mainfw)
702 struct if_sdio_card *card = priv->card;
705 pr_err("failed to find firmware (%d)\n", ret);
709 ret = if_sdio_prog_helper(card, helper);
713 lbs_deb_sdio("Helper firmware loaded\n");
715 ret = if_sdio_prog_real(card, mainfw);
719 lbs_deb_sdio("Firmware loaded\n");
720 if_sdio_finish_power_on(card);
723 static int if_sdio_prog_firmware(struct if_sdio_card *card)
728 lbs_deb_enter(LBS_DEB_SDIO);
733 sdio_claim_host(card->func);
734 sdio_writeb(card->func, 0x00, IF_SDIO_H_INT_MASK, &ret);
735 sdio_release_host(card->func);
737 sdio_claim_host(card->func);
738 scratch = if_sdio_read_scratch(card, &ret);
739 sdio_release_host(card->func);
741 lbs_deb_sdio("firmware status = %#x\n", scratch);
742 lbs_deb_sdio("scratch ret = %d\n", ret);
749 * The manual clearly describes that FEDC is the right code to use
750 * to detect firmware presence, but for SD8686 it is not that simple.
751 * Scratch is also used to store the RX packet length, so we lose
752 * the FEDC value early on. So we use a non-zero check in order
753 * to validate firmware presence.
754 * Additionally, the SD8686 in the Gumstix always has the high scratch
755 * bit set, even when the firmware is not loaded. So we have to
756 * exclude that from the test.
758 if (scratch == IF_SDIO_FIRMWARE_OK) {
759 lbs_deb_sdio("firmware already loaded\n");
760 if_sdio_finish_power_on(card);
762 } else if ((card->model == MODEL_8686) && (scratch & 0x7fff)) {
763 lbs_deb_sdio("firmware may be running\n");
764 if_sdio_finish_power_on(card);
768 ret = lbs_get_firmware_async(card->priv, &card->func->dev, card->model,
769 fw_table, if_sdio_do_prog_firmware);
772 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
776 /********************************************************************/
777 /* Power management */
778 /********************************************************************/
780 /* Finish power on sequence (after firmware is loaded) */
781 static void if_sdio_finish_power_on(struct if_sdio_card *card)
783 struct sdio_func *func = card->func;
784 struct lbs_private *priv = card->priv;
787 sdio_claim_host(func);
788 sdio_set_block_size(card->func, IF_SDIO_BLOCK_SIZE);
791 * Get rx_unit if the chip is SD8688 or newer.
792 * SD8385 & SD8686 do not have rx_unit.
794 if ((card->model != MODEL_8385)
795 && (card->model != MODEL_8686))
796 card->rx_unit = if_sdio_read_rx_unit(card);
801 * Set up the interrupt handler late.
803 * If we set it up earlier, the (buggy) hardware generates a spurious
804 * interrupt, even before the interrupt has been enabled, with
807 * We register the interrupt handler late so that we can handle any
808 * spurious interrupts, and also to avoid generation of that known
809 * spurious interrupt in the first place.
811 ret = sdio_claim_irq(func, if_sdio_interrupt);
816 * Enable interrupts now that everything is set up
818 sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
822 sdio_release_host(func);
824 /* Set fw_ready before queuing any commands so that
825 * lbs_thread won't block from sending them to firmware.
830 * FUNC_INIT is required for SD8688 WLAN/BT multiple functions
832 if (card->model == MODEL_8688) {
833 struct cmd_header cmd;
835 memset(&cmd, 0, sizeof(cmd));
837 lbs_deb_sdio("send function INIT command\n");
838 if (__lbs_cmd(priv, CMD_FUNC_INIT, &cmd, sizeof(cmd),
839 lbs_cmd_copyback, (unsigned long) &cmd))
840 netdev_alert(priv->dev, "CMD_FUNC_INIT cmd failed\n");
843 wake_up(&card->pwron_waitq);
845 if (!card->started) {
846 ret = lbs_start_card(priv);
847 if_sdio_power_off(card);
849 card->started = true;
850 /* Tell PM core that we don't need the card to be
852 pm_runtime_put(&func->dev);
859 sdio_release_irq(func);
861 sdio_release_host(func);
864 static int if_sdio_power_on(struct if_sdio_card *card)
866 struct sdio_func *func = card->func;
867 struct mmc_host *host = func->card->host;
870 sdio_claim_host(func);
872 ret = sdio_enable_func(func);
876 /* For 1-bit transfers to the 8686 model, we need to enable the
877 * interrupt flag in the CCCR register. Set the MMC_QUIRK_LENIENT_FN0
878 * bit to allow access to non-vendor registers. */
879 if ((card->model == MODEL_8686) &&
880 (host->caps & MMC_CAP_SDIO_IRQ) &&
881 (host->ios.bus_width == MMC_BUS_WIDTH_1)) {
884 func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
885 reg = sdio_f0_readb(func, SDIO_CCCR_IF, &ret);
889 reg |= SDIO_BUS_ECSI;
890 sdio_f0_writeb(func, reg, SDIO_CCCR_IF, &ret);
895 card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
899 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
903 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
907 sdio_release_host(func);
908 ret = if_sdio_prog_firmware(card);
910 sdio_claim_host(func);
917 sdio_disable_func(func);
919 sdio_release_host(func);
923 static int if_sdio_power_off(struct if_sdio_card *card)
925 struct sdio_func *func = card->func;
926 struct lbs_private *priv = card->priv;
930 sdio_claim_host(func);
931 sdio_release_irq(func);
932 sdio_disable_func(func);
933 sdio_release_host(func);
938 /*******************************************************************/
939 /* Libertas callbacks */
940 /*******************************************************************/
942 static int if_sdio_host_to_card(struct lbs_private *priv,
943 u8 type, u8 *buf, u16 nb)
946 struct if_sdio_card *card;
947 struct if_sdio_packet *packet, *cur;
951 lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
955 if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
961 * The transfer must be in one transaction or the firmware
962 * goes suicidal. There's no way to guarantee that for all
963 * controllers, but we can at least try.
965 size = sdio_align_size(card->func, nb + 4);
967 packet = kzalloc(sizeof(struct if_sdio_packet) + size,
978 * SDIO specific header.
980 packet->buffer[0] = (nb + 4) & 0xff;
981 packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
982 packet->buffer[2] = type;
983 packet->buffer[3] = 0;
985 memcpy(packet->buffer + 4, buf, nb);
987 spin_lock_irqsave(&card->lock, flags);
990 card->packets = packet;
1000 priv->dnld_sent = DNLD_CMD_SENT;
1003 priv->dnld_sent = DNLD_DATA_SENT;
1006 lbs_deb_sdio("unknown packet type %d\n", (int)type);
1009 spin_unlock_irqrestore(&card->lock, flags);
1011 queue_work(card->workqueue, &card->packet_worker);
1016 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1021 static int if_sdio_enter_deep_sleep(struct lbs_private *priv)
1024 struct cmd_header cmd;
1026 memset(&cmd, 0, sizeof(cmd));
1028 lbs_deb_sdio("send DEEP_SLEEP command\n");
1029 ret = __lbs_cmd(priv, CMD_802_11_DEEP_SLEEP, &cmd, sizeof(cmd),
1030 lbs_cmd_copyback, (unsigned long) &cmd);
1032 netdev_err(priv->dev, "DEEP_SLEEP cmd failed\n");
1038 static int if_sdio_exit_deep_sleep(struct lbs_private *priv)
1040 struct if_sdio_card *card = priv->card;
1043 lbs_deb_enter(LBS_DEB_SDIO);
1044 sdio_claim_host(card->func);
1046 sdio_writeb(card->func, HOST_POWER_UP, CONFIGURATION_REG, &ret);
1048 netdev_err(priv->dev, "sdio_writeb failed!\n");
1050 sdio_release_host(card->func);
1051 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1055 static int if_sdio_reset_deep_sleep_wakeup(struct lbs_private *priv)
1057 struct if_sdio_card *card = priv->card;
1060 lbs_deb_enter(LBS_DEB_SDIO);
1061 sdio_claim_host(card->func);
1063 sdio_writeb(card->func, 0, CONFIGURATION_REG, &ret);
1065 netdev_err(priv->dev, "sdio_writeb failed!\n");
1067 sdio_release_host(card->func);
1068 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1073 static struct mmc_host *reset_host;
1075 static void if_sdio_reset_card_worker(struct work_struct *work)
1078 * The actual reset operation must be run outside of lbs_thread. This
1079 * is because mmc_remove_host() will cause the device to be instantly
1080 * destroyed, and the libertas driver then needs to end lbs_thread,
1081 * leading to a deadlock.
1083 * We run it in a workqueue totally independent from the if_sdio_card
1084 * instance for that reason.
1087 pr_info("Resetting card...");
1088 mmc_remove_host(reset_host);
1089 mmc_add_host(reset_host);
1091 static DECLARE_WORK(card_reset_work, if_sdio_reset_card_worker);
1093 static void if_sdio_reset_card(struct lbs_private *priv)
1095 struct if_sdio_card *card = priv->card;
1097 if (work_pending(&card_reset_work))
1100 reset_host = card->func->card->host;
1101 schedule_work(&card_reset_work);
1104 static int if_sdio_power_save(struct lbs_private *priv)
1106 struct if_sdio_card *card = priv->card;
1109 flush_workqueue(card->workqueue);
1111 ret = if_sdio_power_off(card);
1113 /* Let runtime PM know the card is powered off */
1114 pm_runtime_put_sync(&card->func->dev);
1119 static int if_sdio_power_restore(struct lbs_private *priv)
1121 struct if_sdio_card *card = priv->card;
1124 /* Make sure the card will not be powered off by runtime PM */
1125 pm_runtime_get_sync(&card->func->dev);
1127 r = if_sdio_power_on(card);
1131 wait_event(card->pwron_waitq, priv->fw_ready);
1136 /*******************************************************************/
1137 /* SDIO callbacks */
1138 /*******************************************************************/
1140 static void if_sdio_interrupt(struct sdio_func *func)
1143 struct if_sdio_card *card;
1146 lbs_deb_enter(LBS_DEB_SDIO);
1148 card = sdio_get_drvdata(func);
1150 cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
1154 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
1156 sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
1161 * Ignore the define name, this really means the card has
1162 * successfully received the command.
1164 card->priv->is_activity_detected = 1;
1165 if (cause & IF_SDIO_H_INT_DNLD)
1166 lbs_host_to_card_done(card->priv);
1169 if (cause & IF_SDIO_H_INT_UPLD) {
1170 ret = if_sdio_card_to_host(card);
1178 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1181 static int if_sdio_probe(struct sdio_func *func,
1182 const struct sdio_device_id *id)
1184 struct if_sdio_card *card;
1185 struct lbs_private *priv;
1188 struct if_sdio_packet *packet;
1190 lbs_deb_enter(LBS_DEB_SDIO);
1192 for (i = 0;i < func->card->num_info;i++) {
1193 if (sscanf(func->card->info[i],
1194 "802.11 SDIO ID: %x", &model) == 1)
1196 if (sscanf(func->card->info[i],
1197 "ID: %x", &model) == 1)
1199 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
1205 if (i == func->card->num_info) {
1206 pr_err("unable to identify card model\n");
1210 card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
1215 card->model = model;
1217 switch (card->model) {
1219 card->scratch_reg = IF_SDIO_SCRATCH_OLD;
1222 card->scratch_reg = IF_SDIO_SCRATCH;
1225 default: /* for newer chipsets */
1226 card->scratch_reg = IF_SDIO_FW_STATUS;
1230 spin_lock_init(&card->lock);
1231 card->workqueue = create_workqueue("libertas_sdio");
1232 INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
1233 init_waitqueue_head(&card->pwron_waitq);
1235 /* Check if we support this card */
1236 for (i = 0; i < ARRAY_SIZE(fw_table); i++) {
1237 if (card->model == fw_table[i].model)
1240 if (i == ARRAY_SIZE(fw_table)) {
1241 pr_err("unknown card model 0x%x\n", card->model);
1246 sdio_set_drvdata(func, card);
1248 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
1249 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
1250 func->class, func->vendor, func->device,
1251 model, (unsigned)card->ioport);
1254 priv = lbs_add_card(card, &func->dev);
1263 priv->hw_host_to_card = if_sdio_host_to_card;
1264 priv->enter_deep_sleep = if_sdio_enter_deep_sleep;
1265 priv->exit_deep_sleep = if_sdio_exit_deep_sleep;
1266 priv->reset_deep_sleep_wakeup = if_sdio_reset_deep_sleep_wakeup;
1267 priv->reset_card = if_sdio_reset_card;
1268 priv->power_save = if_sdio_power_save;
1269 priv->power_restore = if_sdio_power_restore;
1271 ret = if_sdio_power_on(card);
1273 goto err_activate_card;
1276 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1281 flush_workqueue(card->workqueue);
1282 lbs_remove_card(priv);
1284 destroy_workqueue(card->workqueue);
1285 while (card->packets) {
1286 packet = card->packets;
1287 card->packets = card->packets->next;
1296 static void if_sdio_remove(struct sdio_func *func)
1298 struct if_sdio_card *card;
1299 struct if_sdio_packet *packet;
1301 lbs_deb_enter(LBS_DEB_SDIO);
1303 card = sdio_get_drvdata(func);
1305 /* Undo decrement done above in if_sdio_probe */
1306 pm_runtime_get_noresume(&func->dev);
1308 if (user_rmmod && (card->model == MODEL_8688)) {
1310 * FUNC_SHUTDOWN is required for SD8688 WLAN/BT
1311 * multiple functions
1313 struct cmd_header cmd;
1315 memset(&cmd, 0, sizeof(cmd));
1317 lbs_deb_sdio("send function SHUTDOWN command\n");
1318 if (__lbs_cmd(card->priv, CMD_FUNC_SHUTDOWN,
1319 &cmd, sizeof(cmd), lbs_cmd_copyback,
1320 (unsigned long) &cmd))
1321 pr_alert("CMD_FUNC_SHUTDOWN cmd failed\n");
1325 lbs_deb_sdio("call remove card\n");
1326 lbs_stop_card(card->priv);
1327 lbs_remove_card(card->priv);
1329 flush_workqueue(card->workqueue);
1330 destroy_workqueue(card->workqueue);
1332 while (card->packets) {
1333 packet = card->packets;
1334 card->packets = card->packets->next;
1339 lbs_deb_leave(LBS_DEB_SDIO);
1342 static int if_sdio_suspend(struct device *dev)
1344 struct sdio_func *func = dev_to_sdio_func(dev);
1346 struct if_sdio_card *card = sdio_get_drvdata(func);
1348 mmc_pm_flag_t flags = sdio_get_host_pm_caps(func);
1350 /* If we're powered off anyway, just let the mmc layer remove the
1352 if (!lbs_iface_active(card->priv))
1355 dev_info(dev, "%s: suspend: PM flags = 0x%x\n",
1356 sdio_func_id(func), flags);
1358 /* If we aren't being asked to wake on anything, we should bail out
1359 * and let the SD stack power down the card.
1361 if (card->priv->wol_criteria == EHS_REMOVE_WAKEUP) {
1362 dev_info(dev, "Suspend without wake params -- powering down card\n");
1366 if (!(flags & MMC_PM_KEEP_POWER)) {
1367 dev_err(dev, "%s: cannot remain alive while host is suspended\n",
1368 sdio_func_id(func));
1372 ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
1376 ret = lbs_suspend(card->priv);
1380 return sdio_set_host_pm_flags(func, MMC_PM_WAKE_SDIO_IRQ);
1383 static int if_sdio_resume(struct device *dev)
1385 struct sdio_func *func = dev_to_sdio_func(dev);
1386 struct if_sdio_card *card = sdio_get_drvdata(func);
1389 dev_info(dev, "%s: resume: we're back\n", sdio_func_id(func));
1391 ret = lbs_resume(card->priv);
1396 static const struct dev_pm_ops if_sdio_pm_ops = {
1397 .suspend = if_sdio_suspend,
1398 .resume = if_sdio_resume,
1401 static struct sdio_driver if_sdio_driver = {
1402 .name = "libertas_sdio",
1403 .id_table = if_sdio_ids,
1404 .probe = if_sdio_probe,
1405 .remove = if_sdio_remove,
1407 .pm = &if_sdio_pm_ops,
1411 /*******************************************************************/
1412 /* Module functions */
1413 /*******************************************************************/
1415 static int __init if_sdio_init_module(void)
1419 lbs_deb_enter(LBS_DEB_SDIO);
1421 printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1422 printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1424 ret = sdio_register_driver(&if_sdio_driver);
1426 /* Clear the flag in case user removes the card. */
1429 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1434 static void __exit if_sdio_exit_module(void)
1436 lbs_deb_enter(LBS_DEB_SDIO);
1438 /* Set the flag as user is removing this module. */
1441 cancel_work_sync(&card_reset_work);
1443 sdio_unregister_driver(&if_sdio_driver);
1445 lbs_deb_leave(LBS_DEB_SDIO);
1448 module_init(if_sdio_init_module);
1449 module_exit(if_sdio_exit_module);
1451 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1452 MODULE_AUTHOR("Pierre Ossman");
1453 MODULE_LICENSE("GPL");