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 *lbs_helper_name
= NULL
;
44 module_param_named(helper_name
, lbs_helper_name
, charp
, 0644);
46 static char *lbs_fw_name
= NULL
;
47 module_param_named(fw_name
, lbs_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
;
85 struct lbs_private
*priv
;
96 struct if_sdio_packet
*packets
;
97 struct work_struct packet_worker
;
100 /********************************************************************/
102 /********************************************************************/
104 static u16
if_sdio_read_scratch(struct if_sdio_card
*card
, int *err
)
109 if (card
->model
== 0x04)
110 reg
= IF_SDIO_SCRATCH_OLD
;
112 reg
= IF_SDIO_SCRATCH
;
114 scratch
= sdio_readb(card
->func
, reg
, &ret
);
116 scratch
|= sdio_readb(card
->func
, reg
+ 1, &ret
) << 8;
127 static int if_sdio_handle_cmd(struct if_sdio_card
*card
,
128 u8
*buffer
, unsigned size
)
130 struct lbs_private
*priv
= card
->priv
;
135 lbs_deb_enter(LBS_DEB_SDIO
);
137 if (size
> LBS_CMD_BUFFER_SIZE
) {
138 lbs_deb_sdio("response packet too large (%d bytes)\n",
144 spin_lock_irqsave(&priv
->driver_lock
, flags
);
146 i
= (priv
->resp_idx
== 0) ? 1 : 0;
147 BUG_ON(priv
->resp_len
[i
]);
148 priv
->resp_len
[i
] = size
;
149 memcpy(priv
->resp_buf
[i
], buffer
, size
);
150 lbs_notify_command_response(priv
, i
);
152 spin_unlock_irqrestore(&card
->priv
->driver_lock
, flags
);
157 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
161 static int if_sdio_handle_data(struct if_sdio_card
*card
,
162 u8
*buffer
, unsigned size
)
168 lbs_deb_enter(LBS_DEB_SDIO
);
170 if (size
> MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
) {
171 lbs_deb_sdio("response packet too large (%d bytes)\n",
177 skb
= dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
+ NET_IP_ALIGN
);
183 skb_reserve(skb
, NET_IP_ALIGN
);
185 data
= skb_put(skb
, size
);
187 memcpy(data
, buffer
, size
);
189 lbs_process_rxed_packet(card
->priv
, skb
);
194 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
199 static int if_sdio_handle_event(struct if_sdio_card
*card
,
200 u8
*buffer
, unsigned size
)
205 lbs_deb_enter(LBS_DEB_SDIO
);
207 if (card
->model
== 0x04) {
208 event
= sdio_readb(card
->func
, IF_SDIO_EVENT
, &ret
);
213 lbs_deb_sdio("event packet too small (%d bytes)\n",
218 event
= buffer
[3] << 24;
219 event
|= buffer
[2] << 16;
220 event
|= buffer
[1] << 8;
221 event
|= buffer
[0] << 0;
224 lbs_queue_event(card
->priv
, event
& 0xFF);
228 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
233 static int if_sdio_card_to_host(struct if_sdio_card
*card
)
237 u16 size
, type
, chunk
;
238 unsigned long timeout
;
240 lbs_deb_enter(LBS_DEB_SDIO
);
242 size
= if_sdio_read_scratch(card
, &ret
);
247 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
253 timeout
= jiffies
+ HZ
;
255 status
= sdio_readb(card
->func
, IF_SDIO_STATUS
, &ret
);
258 if (status
& IF_SDIO_IO_RDY
)
260 if (time_after(jiffies
, timeout
)) {
268 * The transfer must be in one transaction or the firmware
272 if ((chunk
> card
->func
->cur_blksize
) || (chunk
> 512)) {
273 chunk
= (chunk
+ card
->func
->cur_blksize
- 1) /
274 card
->func
->cur_blksize
* card
->func
->cur_blksize
;
277 ret
= sdio_readsb(card
->func
, card
->buffer
, card
->ioport
, chunk
);
281 chunk
= card
->buffer
[0] | (card
->buffer
[1] << 8);
282 type
= card
->buffer
[2] | (card
->buffer
[3] << 8);
284 lbs_deb_sdio("packet of type %d and size %d bytes\n",
285 (int)type
, (int)chunk
);
288 lbs_deb_sdio("packet fragment (%d > %d)\n",
289 (int)chunk
, (int)size
);
295 lbs_deb_sdio("packet fragment (%d < %d)\n",
296 (int)chunk
, (int)size
);
301 ret
= if_sdio_handle_cmd(card
, card
->buffer
+ 4, chunk
- 4);
306 ret
= if_sdio_handle_data(card
, card
->buffer
+ 4, chunk
- 4);
311 ret
= if_sdio_handle_event(card
, card
->buffer
+ 4, chunk
- 4);
316 lbs_deb_sdio("invalid type (%d) from firmware\n",
324 lbs_pr_err("problem fetching packet from firmware\n");
326 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
331 static void if_sdio_host_to_card_worker(struct work_struct
*work
)
333 struct if_sdio_card
*card
;
334 struct if_sdio_packet
*packet
;
335 unsigned long timeout
;
340 lbs_deb_enter(LBS_DEB_SDIO
);
342 card
= container_of(work
, struct if_sdio_card
, packet_worker
);
345 spin_lock_irqsave(&card
->lock
, flags
);
346 packet
= card
->packets
;
348 card
->packets
= packet
->next
;
349 spin_unlock_irqrestore(&card
->lock
, flags
);
354 sdio_claim_host(card
->func
);
356 timeout
= jiffies
+ HZ
;
358 status
= sdio_readb(card
->func
, IF_SDIO_STATUS
, &ret
);
361 if (status
& IF_SDIO_IO_RDY
)
363 if (time_after(jiffies
, timeout
)) {
370 ret
= sdio_writesb(card
->func
, card
->ioport
,
371 packet
->buffer
, packet
->nb
);
375 sdio_release_host(card
->func
);
380 lbs_deb_leave(LBS_DEB_SDIO
);
383 /********************************************************************/
385 /********************************************************************/
387 static int if_sdio_prog_helper(struct if_sdio_card
*card
)
391 const struct firmware
*fw
;
392 unsigned long timeout
;
398 lbs_deb_enter(LBS_DEB_SDIO
);
400 ret
= request_firmware(&fw
, card
->helper
, &card
->func
->dev
);
402 lbs_pr_err("can't load helper firmware\n");
406 chunk_buffer
= kzalloc(64, GFP_KERNEL
);
412 sdio_claim_host(card
->func
);
414 ret
= sdio_set_block_size(card
->func
, 32);
422 timeout
= jiffies
+ HZ
;
424 status
= sdio_readb(card
->func
, IF_SDIO_STATUS
, &ret
);
427 if ((status
& IF_SDIO_IO_RDY
) &&
428 (status
& IF_SDIO_DL_RDY
))
430 if (time_after(jiffies
, timeout
)) {
437 chunk_size
= min(size
, (size_t)60);
439 *((__le32
*)chunk_buffer
) = cpu_to_le32(chunk_size
);
440 memcpy(chunk_buffer
+ 4, firmware
, chunk_size
);
442 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
444 ret
= sdio_writesb(card
->func
, card
->ioport
,
449 firmware
+= chunk_size
;
453 /* an empty block marks the end of the transfer */
454 memset(chunk_buffer
, 0, 4);
455 ret
= sdio_writesb(card
->func
, card
->ioport
, chunk_buffer
, 64);
459 lbs_deb_sdio("waiting for helper to boot...\n");
461 /* wait for the helper to boot by looking at the size register */
462 timeout
= jiffies
+ HZ
;
466 req_size
= sdio_readb(card
->func
, IF_SDIO_RD_BASE
, &ret
);
470 req_size
|= sdio_readb(card
->func
, IF_SDIO_RD_BASE
+ 1, &ret
) << 8;
477 if (time_after(jiffies
, timeout
)) {
488 sdio_set_block_size(card
->func
, 0);
489 sdio_release_host(card
->func
);
492 release_firmware(fw
);
496 lbs_pr_err("failed to load helper firmware\n");
498 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
503 static int if_sdio_prog_real(struct if_sdio_card
*card
)
507 const struct firmware
*fw
;
508 unsigned long timeout
;
512 size_t size
, req_size
;
514 lbs_deb_enter(LBS_DEB_SDIO
);
516 ret
= request_firmware(&fw
, card
->firmware
, &card
->func
->dev
);
518 lbs_pr_err("can't load firmware\n");
522 chunk_buffer
= kzalloc(512, GFP_KERNEL
);
528 sdio_claim_host(card
->func
);
530 ret
= sdio_set_block_size(card
->func
, 32);
538 timeout
= jiffies
+ HZ
;
540 status
= sdio_readb(card
->func
, IF_SDIO_STATUS
, &ret
);
543 if ((status
& IF_SDIO_IO_RDY
) &&
544 (status
& IF_SDIO_DL_RDY
))
546 if (time_after(jiffies
, timeout
)) {
553 req_size
= sdio_readb(card
->func
, IF_SDIO_RD_BASE
, &ret
);
557 req_size
|= sdio_readb(card
->func
, IF_SDIO_RD_BASE
+ 1, &ret
) << 8;
561 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
564 lbs_deb_sdio("firmware helper gave up early\n");
569 if (req_size
& 0x01) {
570 lbs_deb_sdio("firmware helper signalled error\n");
579 chunk_size
= min(req_size
, (size_t)512);
581 memcpy(chunk_buffer
, firmware
, chunk_size
);
583 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
584 chunk_size, (chunk_size + 31) / 32 * 32);
586 ret
= sdio_writesb(card
->func
, card
->ioport
,
587 chunk_buffer
, (chunk_size
+ 31) / 32 * 32);
591 firmware
+= chunk_size
;
593 req_size
-= chunk_size
;
599 lbs_deb_sdio("waiting for firmware to boot...\n");
601 /* wait for the firmware to boot */
602 timeout
= jiffies
+ HZ
;
606 scratch
= if_sdio_read_scratch(card
, &ret
);
610 if (scratch
== IF_SDIO_FIRMWARE_OK
)
613 if (time_after(jiffies
, timeout
)) {
624 sdio_set_block_size(card
->func
, 0);
625 sdio_release_host(card
->func
);
628 release_firmware(fw
);
632 lbs_pr_err("failed to load firmware\n");
634 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
639 static int if_sdio_prog_firmware(struct if_sdio_card
*card
)
644 lbs_deb_enter(LBS_DEB_SDIO
);
646 sdio_claim_host(card
->func
);
647 scratch
= if_sdio_read_scratch(card
, &ret
);
648 sdio_release_host(card
->func
);
653 if (scratch
== IF_SDIO_FIRMWARE_OK
) {
654 lbs_deb_sdio("firmware already loaded\n");
658 ret
= if_sdio_prog_helper(card
);
662 ret
= if_sdio_prog_real(card
);
670 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
675 /*******************************************************************/
676 /* Libertas callbacks */
677 /*******************************************************************/
679 static int if_sdio_host_to_card(struct lbs_private
*priv
,
680 u8 type
, u8
*buf
, u16 nb
)
683 struct if_sdio_card
*card
;
684 struct if_sdio_packet
*packet
, *cur
;
688 lbs_deb_enter_args(LBS_DEB_SDIO
, "type %d, bytes %d", type
, nb
);
692 if (nb
> (65536 - sizeof(struct if_sdio_packet
) - 4)) {
698 * The transfer must be in one transaction or the firmware
702 if ((size
> card
->func
->cur_blksize
) || (size
> 512)) {
703 size
= (size
+ card
->func
->cur_blksize
- 1) /
704 card
->func
->cur_blksize
* card
->func
->cur_blksize
;
707 packet
= kzalloc(sizeof(struct if_sdio_packet
) + size
,
718 * SDIO specific header.
720 packet
->buffer
[0] = (nb
+ 4) & 0xff;
721 packet
->buffer
[1] = ((nb
+ 4) >> 8) & 0xff;
722 packet
->buffer
[2] = type
;
723 packet
->buffer
[3] = 0;
725 memcpy(packet
->buffer
+ 4, buf
, nb
);
727 spin_lock_irqsave(&card
->lock
, flags
);
730 card
->packets
= packet
;
740 priv
->dnld_sent
= DNLD_CMD_SENT
;
743 priv
->dnld_sent
= DNLD_DATA_SENT
;
746 lbs_deb_sdio("unknown packet type %d\n", (int)type
);
749 spin_unlock_irqrestore(&card
->lock
, flags
);
751 schedule_work(&card
->packet_worker
);
756 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
761 /*******************************************************************/
763 /*******************************************************************/
765 static void if_sdio_interrupt(struct sdio_func
*func
)
768 struct if_sdio_card
*card
;
771 lbs_deb_enter(LBS_DEB_SDIO
);
773 card
= sdio_get_drvdata(func
);
775 cause
= sdio_readb(card
->func
, IF_SDIO_H_INT_STATUS
, &ret
);
779 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause
);
781 sdio_writeb(card
->func
, ~cause
, IF_SDIO_H_INT_STATUS
, &ret
);
786 * Ignore the define name, this really means the card has
787 * successfully received the command.
789 if (cause
& IF_SDIO_H_INT_DNLD
)
790 lbs_host_to_card_done(card
->priv
);
793 if (cause
& IF_SDIO_H_INT_UPLD
) {
794 ret
= if_sdio_card_to_host(card
);
802 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
805 static int if_sdio_probe(struct sdio_func
*func
,
806 const struct sdio_device_id
*id
)
808 struct if_sdio_card
*card
;
809 struct lbs_private
*priv
;
812 struct if_sdio_packet
*packet
;
814 lbs_deb_enter(LBS_DEB_SDIO
);
816 for (i
= 0;i
< func
->card
->num_info
;i
++) {
817 if (sscanf(func
->card
->info
[i
],
818 "802.11 SDIO ID: %x", &model
) == 1)
820 if (sscanf(func
->card
->info
[i
],
821 "ID: %x", &model
) == 1)
823 if (!strcmp(func
->card
->info
[i
], "IBIS Wireless SDIO Card")) {
829 if (i
== func
->card
->num_info
) {
830 lbs_pr_err("unable to identify card model\n");
834 card
= kzalloc(sizeof(struct if_sdio_card
), GFP_KERNEL
);
840 spin_lock_init(&card
->lock
);
841 INIT_WORK(&card
->packet_worker
, if_sdio_host_to_card_worker
);
843 for (i
= 0;i
< ARRAY_SIZE(if_sdio_models
);i
++) {
844 if (card
->model
== if_sdio_models
[i
].model
)
848 if (i
== ARRAY_SIZE(if_sdio_models
)) {
849 lbs_pr_err("unkown card model 0x%x\n", card
->model
);
854 card
->helper
= if_sdio_models
[i
].helper
;
855 card
->firmware
= if_sdio_models
[i
].firmware
;
857 if (lbs_helper_name
) {
858 lbs_deb_sdio("overriding helper firmware: %s\n",
860 card
->helper
= lbs_helper_name
;
864 lbs_deb_sdio("overriding firmware: %s\n", lbs_fw_name
);
865 card
->firmware
= lbs_fw_name
;
868 sdio_claim_host(func
);
870 ret
= sdio_enable_func(func
);
874 ret
= sdio_claim_irq(func
, if_sdio_interrupt
);
878 card
->ioport
= sdio_readb(func
, IF_SDIO_IOPORT
, &ret
);
882 card
->ioport
|= sdio_readb(func
, IF_SDIO_IOPORT
+ 1, &ret
) << 8;
886 card
->ioport
|= sdio_readb(func
, IF_SDIO_IOPORT
+ 2, &ret
) << 16;
890 sdio_release_host(func
);
892 sdio_set_drvdata(func
, card
);
894 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
895 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
896 func
->class, func
->vendor
, func
->device
,
897 model
, (unsigned)card
->ioport
);
899 ret
= if_sdio_prog_firmware(card
);
903 priv
= lbs_add_card(card
, &func
->dev
);
912 priv
->hw_host_to_card
= if_sdio_host_to_card
;
917 * Enable interrupts now that everything is set up
919 sdio_claim_host(func
);
920 sdio_writeb(func
, 0x0f, IF_SDIO_H_INT_MASK
, &ret
);
921 sdio_release_host(func
);
925 ret
= lbs_start_card(priv
);
927 goto err_activate_card
;
930 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
935 flush_scheduled_work();
936 free_netdev(priv
->dev
);
939 sdio_claim_host(func
);
941 sdio_release_irq(func
);
943 sdio_disable_func(func
);
945 sdio_release_host(func
);
947 while (card
->packets
) {
948 packet
= card
->packets
;
949 card
->packets
= card
->packets
->next
;
958 static void if_sdio_remove(struct sdio_func
*func
)
960 struct if_sdio_card
*card
;
961 struct if_sdio_packet
*packet
;
963 lbs_deb_enter(LBS_DEB_SDIO
);
965 card
= sdio_get_drvdata(func
);
967 card
->priv
->surpriseremoved
= 1;
969 lbs_deb_sdio("call remove card\n");
970 lbs_stop_card(card
->priv
);
971 lbs_remove_card(card
->priv
);
973 flush_scheduled_work();
975 sdio_claim_host(func
);
976 sdio_release_irq(func
);
977 sdio_disable_func(func
);
978 sdio_release_host(func
);
980 while (card
->packets
) {
981 packet
= card
->packets
;
982 card
->packets
= card
->packets
->next
;
988 lbs_deb_leave(LBS_DEB_SDIO
);
991 static struct sdio_driver if_sdio_driver
= {
992 .name
= "libertas_sdio",
993 .id_table
= if_sdio_ids
,
994 .probe
= if_sdio_probe
,
995 .remove
= if_sdio_remove
,
998 /*******************************************************************/
999 /* Module functions */
1000 /*******************************************************************/
1002 static int __init
if_sdio_init_module(void)
1006 lbs_deb_enter(LBS_DEB_SDIO
);
1008 printk(KERN_INFO
"libertas_sdio: Libertas SDIO driver\n");
1009 printk(KERN_INFO
"libertas_sdio: Copyright Pierre Ossman\n");
1011 ret
= sdio_register_driver(&if_sdio_driver
);
1013 lbs_deb_leave_args(LBS_DEB_SDIO
, "ret %d", ret
);
1018 static void __exit
if_sdio_exit_module(void)
1020 lbs_deb_enter(LBS_DEB_SDIO
);
1022 sdio_unregister_driver(&if_sdio_driver
);
1024 lbs_deb_leave(LBS_DEB_SDIO
);
1027 module_init(if_sdio_init_module
);
1028 module_exit(if_sdio_exit_module
);
1030 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1031 MODULE_AUTHOR("Pierre Ossman");
1032 MODULE_LICENSE("GPL");