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 char *lbs_helper_name
= NULL
;
69 module_param_named(helper_name
, lbs_helper_name
, charp
, 0644);
71 static char *lbs_fw_name
= NULL
;
72 module_param_named(fw_name
, lbs_fw_name
, charp
, 0644);
74 static const struct sdio_device_id if_sdio_ids
[] = {
75 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL
,
76 SDIO_DEVICE_ID_MARVELL_LIBERTAS
) },
77 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL
,
78 SDIO_DEVICE_ID_MARVELL_8688WLAN
) },
79 { /* end: all zeroes */ },
82 MODULE_DEVICE_TABLE(sdio
, if_sdio_ids
);
84 #define MODEL_8385 0x04
85 #define MODEL_8686 0x0b
86 #define MODEL_8688 0x10
88 static const struct lbs_fw_table fw_table
[] = {
89 { MODEL_8385
, "libertas/sd8385_helper.bin", "libertas/sd8385.bin" },
90 { MODEL_8385
, "sd8385_helper.bin", "sd8385.bin" },
91 { MODEL_8686
, "libertas/sd8686_v9_helper.bin", "libertas/sd8686_v9.bin" },
92 { MODEL_8686
, "libertas/sd8686_v8_helper.bin", "libertas/sd8686_v8.bin" },
93 { MODEL_8686
, "sd8686_helper.bin", "sd8686.bin" },
94 { MODEL_8688
, "libertas/sd8688_helper.bin", "libertas/sd8688.bin" },
95 { MODEL_8688
, "sd8688_helper.bin", "sd8688.bin" },
98 MODULE_FIRMWARE("libertas/sd8385_helper.bin");
99 MODULE_FIRMWARE("libertas/sd8385.bin");
100 MODULE_FIRMWARE("sd8385_helper.bin");
101 MODULE_FIRMWARE("sd8385.bin");
102 MODULE_FIRMWARE("libertas/sd8686_v9_helper.bin");
103 MODULE_FIRMWARE("libertas/sd8686_v9.bin");
104 MODULE_FIRMWARE("libertas/sd8686_v8_helper.bin");
105 MODULE_FIRMWARE("libertas/sd8686_v8.bin");
106 MODULE_FIRMWARE("sd8686_helper.bin");
107 MODULE_FIRMWARE("sd8686.bin");
108 MODULE_FIRMWARE("libertas/sd8688_helper.bin");
109 MODULE_FIRMWARE("libertas/sd8688.bin");
110 MODULE_FIRMWARE("sd8688_helper.bin");
111 MODULE_FIRMWARE("sd8688.bin");
113 struct if_sdio_packet
{
114 struct if_sdio_packet
*next
;
116 u8 buffer
[0] __attribute__((aligned(4)));
119 struct if_sdio_card
{
120 struct sdio_func
*func
;
121 struct lbs_private
*priv
;
124 unsigned long ioport
;
125 unsigned int scratch_reg
;
128 const char *firmware
;
129 bool helper_allocated
;
130 bool firmware_allocated
;
132 u8 buffer
[65536] __attribute__((aligned(4)));
135 struct if_sdio_packet
*packets
;
137 struct workqueue_struct
*workqueue
;
138 struct work_struct packet_worker
;
143 /********************************************************************/
145 /********************************************************************/
148 * For SD8385/SD8686, this function reads firmware status after
149 * the image is downloaded, or reads RX packet length when
150 * interrupt (with IF_SDIO_H_INT_UPLD bit set) is received.
151 * For SD8688, this function reads firmware status only.
153 static u16
if_sdio_read_scratch(struct if_sdio_card
*card
, int *err
)
158 scratch
= sdio_readb(card
->func
, card
->scratch_reg
, &ret
);
160 scratch
|= sdio_readb(card
->func
, card
->scratch_reg
+ 1,
172 static u8
if_sdio_read_rx_unit(struct if_sdio_card
*card
)
177 rx_unit
= sdio_readb(card
->func
, IF_SDIO_RX_UNIT
, &ret
);
185 static u16
if_sdio_read_rx_len(struct if_sdio_card
*card
, int *err
)
190 switch (card
->model
) {
193 rx_len
= if_sdio_read_scratch(card
, &ret
);
196 default: /* for newer chipsets */
197 rx_len
= sdio_readb(card
->func
, IF_SDIO_RX_LEN
, &ret
);
199 rx_len
<<= card
->rx_unit
;
201 rx_len
= 0xffff; /* invalid length */
212 static int if_sdio_handle_cmd(struct if_sdio_card
*card
,
213 u8
*buffer
, unsigned size
)
215 struct lbs_private
*priv
= card
->priv
;
220 lbs_deb_enter(LBS_DEB_SDIO
);
222 if (size
> LBS_CMD_BUFFER_SIZE
) {
223 lbs_deb_sdio("response packet too large (%d bytes)\n",
229 spin_lock_irqsave(&priv
->driver_lock
, flags
);
231 i
= (priv
->resp_idx
== 0) ? 1 : 0;
232 BUG_ON(priv
->resp_len
[i
]);
233 priv
->resp_len
[i
] = size
;
234 memcpy(priv
->resp_buf
[i
], buffer
, size
);
235 lbs_notify_command_response(priv
, i
);
237 spin_unlock_irqrestore(&card
->priv
->driver_lock
, flags
);
242 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
246 static int if_sdio_handle_data(struct if_sdio_card
*card
,
247 u8
*buffer
, unsigned size
)
253 lbs_deb_enter(LBS_DEB_SDIO
);
255 if (size
> MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
) {
256 lbs_deb_sdio("response packet too large (%d bytes)\n",
262 skb
= dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
+ NET_IP_ALIGN
);
268 skb_reserve(skb
, NET_IP_ALIGN
);
270 data
= skb_put(skb
, size
);
272 memcpy(data
, buffer
, size
);
274 lbs_process_rxed_packet(card
->priv
, skb
);
279 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
284 static int if_sdio_handle_event(struct if_sdio_card
*card
,
285 u8
*buffer
, unsigned size
)
290 lbs_deb_enter(LBS_DEB_SDIO
);
292 if (card
->model
== MODEL_8385
) {
293 event
= sdio_readb(card
->func
, IF_SDIO_EVENT
, &ret
);
297 /* right shift 3 bits to get the event id */
301 lbs_deb_sdio("event packet too small (%d bytes)\n",
306 event
= buffer
[3] << 24;
307 event
|= buffer
[2] << 16;
308 event
|= buffer
[1] << 8;
309 event
|= buffer
[0] << 0;
312 lbs_queue_event(card
->priv
, event
& 0xFF);
316 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
321 static int if_sdio_wait_status(struct if_sdio_card
*card
, const u8 condition
)
324 unsigned long timeout
;
327 timeout
= jiffies
+ HZ
;
329 status
= sdio_readb(card
->func
, IF_SDIO_STATUS
, &ret
);
332 if ((status
& condition
) == condition
)
334 if (time_after(jiffies
, timeout
))
341 static int if_sdio_card_to_host(struct if_sdio_card
*card
)
344 u16 size
, type
, chunk
;
346 lbs_deb_enter(LBS_DEB_SDIO
);
348 size
= if_sdio_read_rx_len(card
, &ret
);
353 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
359 ret
= if_sdio_wait_status(card
, IF_SDIO_IO_RDY
);
364 * The transfer must be in one transaction or the firmware
365 * goes suicidal. There's no way to guarantee that for all
366 * controllers, but we can at least try.
368 chunk
= sdio_align_size(card
->func
, size
);
370 ret
= sdio_readsb(card
->func
, card
->buffer
, card
->ioport
, chunk
);
374 chunk
= card
->buffer
[0] | (card
->buffer
[1] << 8);
375 type
= card
->buffer
[2] | (card
->buffer
[3] << 8);
377 lbs_deb_sdio("packet of type %d and size %d bytes\n",
378 (int)type
, (int)chunk
);
381 lbs_deb_sdio("packet fragment (%d > %d)\n",
382 (int)chunk
, (int)size
);
388 lbs_deb_sdio("packet fragment (%d < %d)\n",
389 (int)chunk
, (int)size
);
394 ret
= if_sdio_handle_cmd(card
, card
->buffer
+ 4, chunk
- 4);
399 ret
= if_sdio_handle_data(card
, card
->buffer
+ 4, chunk
- 4);
404 ret
= if_sdio_handle_event(card
, card
->buffer
+ 4, chunk
- 4);
409 lbs_deb_sdio("invalid type (%d) from firmware\n",
417 pr_err("problem fetching packet from firmware\n");
419 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
424 static void if_sdio_host_to_card_worker(struct work_struct
*work
)
426 struct if_sdio_card
*card
;
427 struct if_sdio_packet
*packet
;
431 lbs_deb_enter(LBS_DEB_SDIO
);
433 card
= container_of(work
, struct if_sdio_card
, packet_worker
);
436 spin_lock_irqsave(&card
->lock
, flags
);
437 packet
= card
->packets
;
439 card
->packets
= packet
->next
;
440 spin_unlock_irqrestore(&card
->lock
, flags
);
445 sdio_claim_host(card
->func
);
447 ret
= if_sdio_wait_status(card
, IF_SDIO_IO_RDY
);
449 ret
= sdio_writesb(card
->func
, card
->ioport
,
450 packet
->buffer
, packet
->nb
);
454 pr_err("error %d sending packet to firmware\n", ret
);
456 sdio_release_host(card
->func
);
461 lbs_deb_leave(LBS_DEB_SDIO
);
464 /********************************************************************/
466 /********************************************************************/
468 #define FW_DL_READY_STATUS (IF_SDIO_IO_RDY | IF_SDIO_DL_RDY)
470 static int if_sdio_prog_helper(struct if_sdio_card
*card
,
471 const struct firmware
*fw
)
474 unsigned long timeout
;
480 lbs_deb_enter(LBS_DEB_SDIO
);
482 chunk_buffer
= kzalloc(64, GFP_KERNEL
);
488 sdio_claim_host(card
->func
);
490 ret
= sdio_set_block_size(card
->func
, 32);
498 ret
= if_sdio_wait_status(card
, FW_DL_READY_STATUS
);
502 /* On some platforms (like Davinci) the chip needs more time
503 * between helper blocks.
507 chunk_size
= min(size
, (size_t)60);
509 *((__le32
*)chunk_buffer
) = cpu_to_le32(chunk_size
);
510 memcpy(chunk_buffer
+ 4, firmware
, chunk_size
);
512 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
514 ret
= sdio_writesb(card
->func
, card
->ioport
,
519 firmware
+= chunk_size
;
523 /* an empty block marks the end of the transfer */
524 memset(chunk_buffer
, 0, 4);
525 ret
= sdio_writesb(card
->func
, card
->ioport
, chunk_buffer
, 64);
529 lbs_deb_sdio("waiting for helper to boot...\n");
531 /* wait for the helper to boot by looking at the size register */
532 timeout
= jiffies
+ HZ
;
536 req_size
= sdio_readb(card
->func
, IF_SDIO_RD_BASE
, &ret
);
540 req_size
|= sdio_readb(card
->func
, IF_SDIO_RD_BASE
+ 1, &ret
) << 8;
547 if (time_after(jiffies
, timeout
)) {
558 sdio_release_host(card
->func
);
563 pr_err("failed to load helper firmware\n");
565 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
569 static int if_sdio_prog_real(struct if_sdio_card
*card
,
570 const struct firmware
*fw
)
573 unsigned long timeout
;
577 size_t size
, req_size
;
579 lbs_deb_enter(LBS_DEB_SDIO
);
581 chunk_buffer
= kzalloc(512, GFP_KERNEL
);
587 sdio_claim_host(card
->func
);
589 ret
= sdio_set_block_size(card
->func
, 32);
597 ret
= if_sdio_wait_status(card
, FW_DL_READY_STATUS
);
601 req_size
= sdio_readb(card
->func
, IF_SDIO_RD_BASE
, &ret
);
605 req_size
|= sdio_readb(card
->func
, IF_SDIO_RD_BASE
+ 1, &ret
) << 8;
609 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
612 lbs_deb_sdio("firmware helper gave up early\n");
617 if (req_size
& 0x01) {
618 lbs_deb_sdio("firmware helper signalled error\n");
627 chunk_size
= min(req_size
, (size_t)512);
629 memcpy(chunk_buffer
, firmware
, chunk_size
);
631 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
632 chunk_size, (chunk_size + 31) / 32 * 32);
634 ret
= sdio_writesb(card
->func
, card
->ioport
,
635 chunk_buffer
, roundup(chunk_size
, 32));
639 firmware
+= chunk_size
;
641 req_size
-= chunk_size
;
647 lbs_deb_sdio("waiting for firmware to boot...\n");
649 /* wait for the firmware to boot */
650 timeout
= jiffies
+ HZ
;
654 scratch
= if_sdio_read_scratch(card
, &ret
);
658 if (scratch
== IF_SDIO_FIRMWARE_OK
)
661 if (time_after(jiffies
, timeout
)) {
672 sdio_release_host(card
->func
);
677 pr_err("failed to load firmware\n");
679 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
683 static int if_sdio_prog_firmware(struct if_sdio_card
*card
)
687 const struct firmware
*helper
= NULL
;
688 const struct firmware
*mainfw
= NULL
;
690 lbs_deb_enter(LBS_DEB_SDIO
);
695 sdio_claim_host(card
->func
);
696 sdio_writeb(card
->func
, 0x00, IF_SDIO_H_INT_MASK
, &ret
);
697 sdio_release_host(card
->func
);
699 sdio_claim_host(card
->func
);
700 scratch
= if_sdio_read_scratch(card
, &ret
);
701 sdio_release_host(card
->func
);
703 lbs_deb_sdio("firmware status = %#x\n", scratch
);
704 lbs_deb_sdio("scratch ret = %d\n", ret
);
711 * The manual clearly describes that FEDC is the right code to use
712 * to detect firmware presence, but for SD8686 it is not that simple.
713 * Scratch is also used to store the RX packet length, so we lose
714 * the FEDC value early on. So we use a non-zero check in order
715 * to validate firmware presence.
716 * Additionally, the SD8686 in the Gumstix always has the high scratch
717 * bit set, even when the firmware is not loaded. So we have to
718 * exclude that from the test.
720 if (scratch
== IF_SDIO_FIRMWARE_OK
) {
721 lbs_deb_sdio("firmware already loaded\n");
723 } else if ((card
->model
== MODEL_8686
) && (scratch
& 0x7fff)) {
724 lbs_deb_sdio("firmware may be running\n");
728 ret
= lbs_get_firmware(&card
->func
->dev
, lbs_helper_name
, lbs_fw_name
,
729 card
->model
, &fw_table
[0], &helper
, &mainfw
);
731 pr_err("failed to find firmware (%d)\n", ret
);
735 ret
= if_sdio_prog_helper(card
, helper
);
739 lbs_deb_sdio("Helper firmware loaded\n");
741 ret
= if_sdio_prog_real(card
, mainfw
);
745 lbs_deb_sdio("Firmware loaded\n");
748 sdio_claim_host(card
->func
);
749 sdio_set_block_size(card
->func
, IF_SDIO_BLOCK_SIZE
);
750 sdio_release_host(card
->func
);
754 release_firmware(helper
);
755 release_firmware(mainfw
);
757 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
761 /********************************************************************/
762 /* Power management */
763 /********************************************************************/
765 static int if_sdio_power_on(struct if_sdio_card
*card
)
767 struct sdio_func
*func
= card
->func
;
768 struct lbs_private
*priv
= card
->priv
;
769 struct mmc_host
*host
= func
->card
->host
;
772 sdio_claim_host(func
);
774 ret
= sdio_enable_func(func
);
778 /* For 1-bit transfers to the 8686 model, we need to enable the
779 * interrupt flag in the CCCR register. Set the MMC_QUIRK_LENIENT_FN0
780 * bit to allow access to non-vendor registers. */
781 if ((card
->model
== MODEL_8686
) &&
782 (host
->caps
& MMC_CAP_SDIO_IRQ
) &&
783 (host
->ios
.bus_width
== MMC_BUS_WIDTH_1
)) {
786 func
->card
->quirks
|= MMC_QUIRK_LENIENT_FN0
;
787 reg
= sdio_f0_readb(func
, SDIO_CCCR_IF
, &ret
);
791 reg
|= SDIO_BUS_ECSI
;
792 sdio_f0_writeb(func
, reg
, SDIO_CCCR_IF
, &ret
);
797 card
->ioport
= sdio_readb(func
, IF_SDIO_IOPORT
, &ret
);
801 card
->ioport
|= sdio_readb(func
, IF_SDIO_IOPORT
+ 1, &ret
) << 8;
805 card
->ioport
|= sdio_readb(func
, IF_SDIO_IOPORT
+ 2, &ret
) << 16;
809 sdio_release_host(func
);
810 ret
= if_sdio_prog_firmware(card
);
811 sdio_claim_host(func
);
816 * Get rx_unit if the chip is SD8688 or newer.
817 * SD8385 & SD8686 do not have rx_unit.
819 if ((card
->model
!= MODEL_8385
)
820 && (card
->model
!= MODEL_8686
))
821 card
->rx_unit
= if_sdio_read_rx_unit(card
);
826 * Set up the interrupt handler late.
828 * If we set it up earlier, the (buggy) hardware generates a spurious
829 * interrupt, even before the interrupt has been enabled, with
832 * We register the interrupt handler late so that we can handle any
833 * spurious interrupts, and also to avoid generation of that known
834 * spurious interrupt in the first place.
836 ret
= sdio_claim_irq(func
, if_sdio_interrupt
);
841 * Enable interrupts now that everything is set up
843 sdio_writeb(func
, 0x0f, IF_SDIO_H_INT_MASK
, &ret
);
847 sdio_release_host(func
);
850 * FUNC_INIT is required for SD8688 WLAN/BT multiple functions
852 if (card
->model
== MODEL_8688
) {
853 struct cmd_header cmd
;
855 memset(&cmd
, 0, sizeof(cmd
));
857 lbs_deb_sdio("send function INIT command\n");
858 if (__lbs_cmd(priv
, CMD_FUNC_INIT
, &cmd
, sizeof(cmd
),
859 lbs_cmd_copyback
, (unsigned long) &cmd
))
860 netdev_alert(priv
->dev
, "CMD_FUNC_INIT cmd failed\n");
868 sdio_release_irq(func
);
870 sdio_disable_func(func
);
872 sdio_release_host(func
);
876 static int if_sdio_power_off(struct if_sdio_card
*card
)
878 struct sdio_func
*func
= card
->func
;
879 struct lbs_private
*priv
= card
->priv
;
883 sdio_claim_host(func
);
884 sdio_release_irq(func
);
885 sdio_disable_func(func
);
886 sdio_release_host(func
);
891 /*******************************************************************/
892 /* Libertas callbacks */
893 /*******************************************************************/
895 static int if_sdio_host_to_card(struct lbs_private
*priv
,
896 u8 type
, u8
*buf
, u16 nb
)
899 struct if_sdio_card
*card
;
900 struct if_sdio_packet
*packet
, *cur
;
904 lbs_deb_enter_args(LBS_DEB_SDIO
, "type %d, bytes %d", type
, nb
);
908 if (nb
> (65536 - sizeof(struct if_sdio_packet
) - 4)) {
914 * The transfer must be in one transaction or the firmware
915 * goes suicidal. There's no way to guarantee that for all
916 * controllers, but we can at least try.
918 size
= sdio_align_size(card
->func
, nb
+ 4);
920 packet
= kzalloc(sizeof(struct if_sdio_packet
) + size
,
931 * SDIO specific header.
933 packet
->buffer
[0] = (nb
+ 4) & 0xff;
934 packet
->buffer
[1] = ((nb
+ 4) >> 8) & 0xff;
935 packet
->buffer
[2] = type
;
936 packet
->buffer
[3] = 0;
938 memcpy(packet
->buffer
+ 4, buf
, nb
);
940 spin_lock_irqsave(&card
->lock
, flags
);
943 card
->packets
= packet
;
953 priv
->dnld_sent
= DNLD_CMD_SENT
;
956 priv
->dnld_sent
= DNLD_DATA_SENT
;
959 lbs_deb_sdio("unknown packet type %d\n", (int)type
);
962 spin_unlock_irqrestore(&card
->lock
, flags
);
964 queue_work(card
->workqueue
, &card
->packet_worker
);
969 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
974 static int if_sdio_enter_deep_sleep(struct lbs_private
*priv
)
977 struct cmd_header cmd
;
979 memset(&cmd
, 0, sizeof(cmd
));
981 lbs_deb_sdio("send DEEP_SLEEP command\n");
982 ret
= __lbs_cmd(priv
, CMD_802_11_DEEP_SLEEP
, &cmd
, sizeof(cmd
),
983 lbs_cmd_copyback
, (unsigned long) &cmd
);
985 netdev_err(priv
->dev
, "DEEP_SLEEP cmd failed\n");
991 static int if_sdio_exit_deep_sleep(struct lbs_private
*priv
)
993 struct if_sdio_card
*card
= priv
->card
;
996 lbs_deb_enter(LBS_DEB_SDIO
);
997 sdio_claim_host(card
->func
);
999 sdio_writeb(card
->func
, HOST_POWER_UP
, CONFIGURATION_REG
, &ret
);
1001 netdev_err(priv
->dev
, "sdio_writeb failed!\n");
1003 sdio_release_host(card
->func
);
1004 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
1008 static int if_sdio_reset_deep_sleep_wakeup(struct lbs_private
*priv
)
1010 struct if_sdio_card
*card
= priv
->card
;
1013 lbs_deb_enter(LBS_DEB_SDIO
);
1014 sdio_claim_host(card
->func
);
1016 sdio_writeb(card
->func
, 0, CONFIGURATION_REG
, &ret
);
1018 netdev_err(priv
->dev
, "sdio_writeb failed!\n");
1020 sdio_release_host(card
->func
);
1021 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
1026 static struct mmc_host
*reset_host
;
1028 static void if_sdio_reset_card_worker(struct work_struct
*work
)
1031 * The actual reset operation must be run outside of lbs_thread. This
1032 * is because mmc_remove_host() will cause the device to be instantly
1033 * destroyed, and the libertas driver then needs to end lbs_thread,
1034 * leading to a deadlock.
1036 * We run it in a workqueue totally independent from the if_sdio_card
1037 * instance for that reason.
1040 pr_info("Resetting card...");
1041 mmc_remove_host(reset_host
);
1042 mmc_add_host(reset_host
);
1044 static DECLARE_WORK(card_reset_work
, if_sdio_reset_card_worker
);
1046 static void if_sdio_reset_card(struct lbs_private
*priv
)
1048 struct if_sdio_card
*card
= priv
->card
;
1050 if (work_pending(&card_reset_work
))
1053 reset_host
= card
->func
->card
->host
;
1054 schedule_work(&card_reset_work
);
1057 static int if_sdio_power_save(struct lbs_private
*priv
)
1059 struct if_sdio_card
*card
= priv
->card
;
1062 flush_workqueue(card
->workqueue
);
1064 ret
= if_sdio_power_off(card
);
1066 /* Let runtime PM know the card is powered off */
1067 pm_runtime_put_sync(&card
->func
->dev
);
1072 static int if_sdio_power_restore(struct lbs_private
*priv
)
1074 struct if_sdio_card
*card
= priv
->card
;
1076 /* Make sure the card will not be powered off by runtime PM */
1077 pm_runtime_get_sync(&card
->func
->dev
);
1079 return if_sdio_power_on(card
);
1083 /*******************************************************************/
1084 /* SDIO callbacks */
1085 /*******************************************************************/
1087 static void if_sdio_interrupt(struct sdio_func
*func
)
1090 struct if_sdio_card
*card
;
1093 lbs_deb_enter(LBS_DEB_SDIO
);
1095 card
= sdio_get_drvdata(func
);
1097 cause
= sdio_readb(card
->func
, IF_SDIO_H_INT_STATUS
, &ret
);
1101 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause
);
1103 sdio_writeb(card
->func
, ~cause
, IF_SDIO_H_INT_STATUS
, &ret
);
1108 * Ignore the define name, this really means the card has
1109 * successfully received the command.
1111 card
->priv
->is_activity_detected
= 1;
1112 if (cause
& IF_SDIO_H_INT_DNLD
)
1113 lbs_host_to_card_done(card
->priv
);
1116 if (cause
& IF_SDIO_H_INT_UPLD
) {
1117 ret
= if_sdio_card_to_host(card
);
1125 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
1128 static int if_sdio_probe(struct sdio_func
*func
,
1129 const struct sdio_device_id
*id
)
1131 struct if_sdio_card
*card
;
1132 struct lbs_private
*priv
;
1135 struct if_sdio_packet
*packet
;
1137 lbs_deb_enter(LBS_DEB_SDIO
);
1139 for (i
= 0;i
< func
->card
->num_info
;i
++) {
1140 if (sscanf(func
->card
->info
[i
],
1141 "802.11 SDIO ID: %x", &model
) == 1)
1143 if (sscanf(func
->card
->info
[i
],
1144 "ID: %x", &model
) == 1)
1146 if (!strcmp(func
->card
->info
[i
], "IBIS Wireless SDIO Card")) {
1152 if (i
== func
->card
->num_info
) {
1153 pr_err("unable to identify card model\n");
1157 card
= kzalloc(sizeof(struct if_sdio_card
), GFP_KERNEL
);
1162 card
->model
= model
;
1164 switch (card
->model
) {
1166 card
->scratch_reg
= IF_SDIO_SCRATCH_OLD
;
1169 card
->scratch_reg
= IF_SDIO_SCRATCH
;
1172 default: /* for newer chipsets */
1173 card
->scratch_reg
= IF_SDIO_FW_STATUS
;
1177 spin_lock_init(&card
->lock
);
1178 card
->workqueue
= create_workqueue("libertas_sdio");
1179 INIT_WORK(&card
->packet_worker
, if_sdio_host_to_card_worker
);
1181 /* Check if we support this card */
1182 for (i
= 0; i
< ARRAY_SIZE(fw_table
); i
++) {
1183 if (card
->model
== fw_table
[i
].model
)
1186 if (i
== ARRAY_SIZE(fw_table
)) {
1187 pr_err("unknown card model 0x%x\n", card
->model
);
1192 sdio_set_drvdata(func
, card
);
1194 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
1195 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
1196 func
->class, func
->vendor
, func
->device
,
1197 model
, (unsigned)card
->ioport
);
1200 priv
= lbs_add_card(card
, &func
->dev
);
1209 priv
->hw_host_to_card
= if_sdio_host_to_card
;
1210 priv
->enter_deep_sleep
= if_sdio_enter_deep_sleep
;
1211 priv
->exit_deep_sleep
= if_sdio_exit_deep_sleep
;
1212 priv
->reset_deep_sleep_wakeup
= if_sdio_reset_deep_sleep_wakeup
;
1213 priv
->reset_card
= if_sdio_reset_card
;
1214 priv
->power_save
= if_sdio_power_save
;
1215 priv
->power_restore
= if_sdio_power_restore
;
1217 ret
= if_sdio_power_on(card
);
1219 goto err_activate_card
;
1221 ret
= lbs_start_card(priv
);
1222 if_sdio_power_off(card
);
1224 goto err_activate_card
;
1226 /* Tell PM core that we don't need the card to be powered now */
1227 pm_runtime_put_noidle(&func
->dev
);
1230 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
1235 flush_workqueue(card
->workqueue
);
1236 lbs_remove_card(priv
);
1238 destroy_workqueue(card
->workqueue
);
1239 while (card
->packets
) {
1240 packet
= card
->packets
;
1241 card
->packets
= card
->packets
->next
;
1245 if (card
->helper_allocated
)
1246 kfree(card
->helper
);
1247 if (card
->firmware_allocated
)
1248 kfree(card
->firmware
);
1254 static void if_sdio_remove(struct sdio_func
*func
)
1256 struct if_sdio_card
*card
;
1257 struct if_sdio_packet
*packet
;
1259 lbs_deb_enter(LBS_DEB_SDIO
);
1261 card
= sdio_get_drvdata(func
);
1263 /* Undo decrement done above in if_sdio_probe */
1264 pm_runtime_get_noresume(&func
->dev
);
1266 if (user_rmmod
&& (card
->model
== MODEL_8688
)) {
1268 * FUNC_SHUTDOWN is required for SD8688 WLAN/BT
1269 * multiple functions
1271 struct cmd_header cmd
;
1273 memset(&cmd
, 0, sizeof(cmd
));
1275 lbs_deb_sdio("send function SHUTDOWN command\n");
1276 if (__lbs_cmd(card
->priv
, CMD_FUNC_SHUTDOWN
,
1277 &cmd
, sizeof(cmd
), lbs_cmd_copyback
,
1278 (unsigned long) &cmd
))
1279 pr_alert("CMD_FUNC_SHUTDOWN cmd failed\n");
1283 lbs_deb_sdio("call remove card\n");
1284 lbs_stop_card(card
->priv
);
1285 lbs_remove_card(card
->priv
);
1287 flush_workqueue(card
->workqueue
);
1288 destroy_workqueue(card
->workqueue
);
1290 while (card
->packets
) {
1291 packet
= card
->packets
;
1292 card
->packets
= card
->packets
->next
;
1296 if (card
->helper_allocated
)
1297 kfree(card
->helper
);
1298 if (card
->firmware_allocated
)
1299 kfree(card
->firmware
);
1302 lbs_deb_leave(LBS_DEB_SDIO
);
1305 static int if_sdio_suspend(struct device
*dev
)
1307 struct sdio_func
*func
= dev_to_sdio_func(dev
);
1309 struct if_sdio_card
*card
= sdio_get_drvdata(func
);
1311 mmc_pm_flag_t flags
= sdio_get_host_pm_caps(func
);
1313 dev_info(dev
, "%s: suspend: PM flags = 0x%x\n",
1314 sdio_func_id(func
), flags
);
1316 /* If we aren't being asked to wake on anything, we should bail out
1317 * and let the SD stack power down the card.
1319 if (card
->priv
->wol_criteria
== EHS_REMOVE_WAKEUP
) {
1320 dev_info(dev
, "Suspend without wake params -- powering down card\n");
1324 if (!(flags
& MMC_PM_KEEP_POWER
)) {
1325 dev_err(dev
, "%s: cannot remain alive while host is suspended\n",
1326 sdio_func_id(func
));
1330 ret
= sdio_set_host_pm_flags(func
, MMC_PM_KEEP_POWER
);
1334 ret
= lbs_suspend(card
->priv
);
1338 return sdio_set_host_pm_flags(func
, MMC_PM_WAKE_SDIO_IRQ
);
1341 static int if_sdio_resume(struct device
*dev
)
1343 struct sdio_func
*func
= dev_to_sdio_func(dev
);
1344 struct if_sdio_card
*card
= sdio_get_drvdata(func
);
1347 dev_info(dev
, "%s: resume: we're back\n", sdio_func_id(func
));
1349 ret
= lbs_resume(card
->priv
);
1354 static const struct dev_pm_ops if_sdio_pm_ops
= {
1355 .suspend
= if_sdio_suspend
,
1356 .resume
= if_sdio_resume
,
1359 static struct sdio_driver if_sdio_driver
= {
1360 .name
= "libertas_sdio",
1361 .id_table
= if_sdio_ids
,
1362 .probe
= if_sdio_probe
,
1363 .remove
= if_sdio_remove
,
1365 .pm
= &if_sdio_pm_ops
,
1369 /*******************************************************************/
1370 /* Module functions */
1371 /*******************************************************************/
1373 static int __init
if_sdio_init_module(void)
1377 lbs_deb_enter(LBS_DEB_SDIO
);
1379 printk(KERN_INFO
"libertas_sdio: Libertas SDIO driver\n");
1380 printk(KERN_INFO
"libertas_sdio: Copyright Pierre Ossman\n");
1382 ret
= sdio_register_driver(&if_sdio_driver
);
1384 /* Clear the flag in case user removes the card. */
1387 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
1392 static void __exit
if_sdio_exit_module(void)
1394 lbs_deb_enter(LBS_DEB_SDIO
);
1396 /* Set the flag as user is removing this module. */
1399 cancel_work_sync(&card_reset_work
);
1401 sdio_unregister_driver(&if_sdio_driver
);
1403 lbs_deb_leave(LBS_DEB_SDIO
);
1406 module_init(if_sdio_init_module
);
1407 module_exit(if_sdio_exit_module
);
1409 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1410 MODULE_AUTHOR("Pierre Ossman");
1411 MODULE_LICENSE("GPL");