Loading...
Note: File does not exist in v6.8.
1/*
2 * linux/drivers/net/wireless/libertas/if_sdio.c
3 *
4 * Copyright 2007-2008 Pierre Ossman
5 *
6 * Inspired by if_cs.c, Copyright 2007 Holger Schurig
7 *
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.
12 *
13 * This hardware has more or less no CMD53 support, so all registers
14 * must be accessed using sdio_readb()/sdio_writeb().
15 *
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
19 * current block size.
20 *
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.
27 */
28
29#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
30
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>
43
44#include "host.h"
45#include "decl.h"
46#include "defs.h"
47#include "dev.h"
48#include "cmd.h"
49#include "if_sdio.h"
50
51static void if_sdio_interrupt(struct sdio_func *func);
52
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.
60 *
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.
65 */
66static u8 user_rmmod;
67
68static 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 */ },
74};
75
76MODULE_DEVICE_TABLE(sdio, if_sdio_ids);
77
78#define MODEL_8385 0x04
79#define MODEL_8686 0x0b
80#define MODEL_8688 0x10
81
82static 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" },
90 { 0, NULL, NULL }
91};
92MODULE_FIRMWARE("libertas/sd8385_helper.bin");
93MODULE_FIRMWARE("libertas/sd8385.bin");
94MODULE_FIRMWARE("sd8385_helper.bin");
95MODULE_FIRMWARE("sd8385.bin");
96MODULE_FIRMWARE("libertas/sd8686_v9_helper.bin");
97MODULE_FIRMWARE("libertas/sd8686_v9.bin");
98MODULE_FIRMWARE("libertas/sd8686_v8_helper.bin");
99MODULE_FIRMWARE("libertas/sd8686_v8.bin");
100MODULE_FIRMWARE("sd8686_helper.bin");
101MODULE_FIRMWARE("sd8686.bin");
102MODULE_FIRMWARE("libertas/sd8688_helper.bin");
103MODULE_FIRMWARE("libertas/sd8688.bin");
104MODULE_FIRMWARE("sd8688_helper.bin");
105MODULE_FIRMWARE("sd8688.bin");
106
107struct if_sdio_packet {
108 struct if_sdio_packet *next;
109 u16 nb;
110 u8 buffer[0] __attribute__((aligned(4)));
111};
112
113struct if_sdio_card {
114 struct sdio_func *func;
115 struct lbs_private *priv;
116
117 int model;
118 unsigned long ioport;
119 unsigned int scratch_reg;
120 bool started;
121 wait_queue_head_t pwron_waitq;
122
123 u8 buffer[65536] __attribute__((aligned(4)));
124
125 spinlock_t lock;
126 struct if_sdio_packet *packets;
127
128 struct workqueue_struct *workqueue;
129 struct work_struct packet_worker;
130
131 u8 rx_unit;
132};
133
134static void if_sdio_finish_power_on(struct if_sdio_card *card);
135static int if_sdio_power_off(struct if_sdio_card *card);
136
137/********************************************************************/
138/* I/O */
139/********************************************************************/
140
141/*
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.
146 */
147static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
148{
149 int ret;
150 u16 scratch;
151
152 scratch = sdio_readb(card->func, card->scratch_reg, &ret);
153 if (!ret)
154 scratch |= sdio_readb(card->func, card->scratch_reg + 1,
155 &ret) << 8;
156
157 if (err)
158 *err = ret;
159
160 if (ret)
161 return 0xffff;
162
163 return scratch;
164}
165
166static u8 if_sdio_read_rx_unit(struct if_sdio_card *card)
167{
168 int ret;
169 u8 rx_unit;
170
171 rx_unit = sdio_readb(card->func, IF_SDIO_RX_UNIT, &ret);
172
173 if (ret)
174 rx_unit = 0;
175
176 return rx_unit;
177}
178
179static u16 if_sdio_read_rx_len(struct if_sdio_card *card, int *err)
180{
181 int ret;
182 u16 rx_len;
183
184 switch (card->model) {
185 case MODEL_8385:
186 case MODEL_8686:
187 rx_len = if_sdio_read_scratch(card, &ret);
188 break;
189 case MODEL_8688:
190 default: /* for newer chipsets */
191 rx_len = sdio_readb(card->func, IF_SDIO_RX_LEN, &ret);
192 if (!ret)
193 rx_len <<= card->rx_unit;
194 else
195 rx_len = 0xffff; /* invalid length */
196
197 break;
198 }
199
200 if (err)
201 *err = ret;
202
203 return rx_len;
204}
205
206static int if_sdio_handle_cmd(struct if_sdio_card *card,
207 u8 *buffer, unsigned size)
208{
209 struct lbs_private *priv = card->priv;
210 int ret;
211 unsigned long flags;
212 u8 i;
213
214 lbs_deb_enter(LBS_DEB_SDIO);
215
216 if (size > LBS_CMD_BUFFER_SIZE) {
217 lbs_deb_sdio("response packet too large (%d bytes)\n",
218 (int)size);
219 ret = -E2BIG;
220 goto out;
221 }
222
223 spin_lock_irqsave(&priv->driver_lock, flags);
224
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);
230
231 spin_unlock_irqrestore(&card->priv->driver_lock, flags);
232
233 ret = 0;
234
235out:
236 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
237 return ret;
238}
239
240static int if_sdio_handle_data(struct if_sdio_card *card,
241 u8 *buffer, unsigned size)
242{
243 int ret;
244 struct sk_buff *skb;
245 char *data;
246
247 lbs_deb_enter(LBS_DEB_SDIO);
248
249 if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
250 lbs_deb_sdio("response packet too large (%d bytes)\n",
251 (int)size);
252 ret = -E2BIG;
253 goto out;
254 }
255
256 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
257 if (!skb) {
258 ret = -ENOMEM;
259 goto out;
260 }
261
262 skb_reserve(skb, NET_IP_ALIGN);
263
264 data = skb_put(skb, size);
265
266 memcpy(data, buffer, size);
267
268 lbs_process_rxed_packet(card->priv, skb);
269
270 ret = 0;
271
272out:
273 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
274
275 return ret;
276}
277
278static int if_sdio_handle_event(struct if_sdio_card *card,
279 u8 *buffer, unsigned size)
280{
281 int ret;
282 u32 event;
283
284 lbs_deb_enter(LBS_DEB_SDIO);
285
286 if (card->model == MODEL_8385) {
287 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
288 if (ret)
289 goto out;
290
291 /* right shift 3 bits to get the event id */
292 event >>= 3;
293 } else {
294 if (size < 4) {
295 lbs_deb_sdio("event packet too small (%d bytes)\n",
296 (int)size);
297 ret = -EINVAL;
298 goto out;
299 }
300 event = buffer[3] << 24;
301 event |= buffer[2] << 16;
302 event |= buffer[1] << 8;
303 event |= buffer[0] << 0;
304 }
305
306 lbs_queue_event(card->priv, event & 0xFF);
307 ret = 0;
308
309out:
310 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
311
312 return ret;
313}
314
315static int if_sdio_wait_status(struct if_sdio_card *card, const u8 condition)
316{
317 u8 status;
318 unsigned long timeout;
319 int ret = 0;
320
321 timeout = jiffies + HZ;
322 while (1) {
323 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
324 if (ret)
325 return ret;
326 if ((status & condition) == condition)
327 break;
328 if (time_after(jiffies, timeout))
329 return -ETIMEDOUT;
330 mdelay(1);
331 }
332 return ret;
333}
334
335static int if_sdio_card_to_host(struct if_sdio_card *card)
336{
337 int ret;
338 u16 size, type, chunk;
339
340 lbs_deb_enter(LBS_DEB_SDIO);
341
342 size = if_sdio_read_rx_len(card, &ret);
343 if (ret)
344 goto out;
345
346 if (size < 4) {
347 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
348 (int)size);
349 ret = -EINVAL;
350 goto out;
351 }
352
353 ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
354 if (ret)
355 goto out;
356
357 /*
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.
361 */
362 chunk = sdio_align_size(card->func, size);
363
364 ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
365 if (ret)
366 goto out;
367
368 chunk = card->buffer[0] | (card->buffer[1] << 8);
369 type = card->buffer[2] | (card->buffer[3] << 8);
370
371 lbs_deb_sdio("packet of type %d and size %d bytes\n",
372 (int)type, (int)chunk);
373
374 if (chunk > size) {
375 lbs_deb_sdio("packet fragment (%d > %d)\n",
376 (int)chunk, (int)size);
377 ret = -EINVAL;
378 goto out;
379 }
380
381 if (chunk < size) {
382 lbs_deb_sdio("packet fragment (%d < %d)\n",
383 (int)chunk, (int)size);
384 }
385
386 switch (type) {
387 case MVMS_CMD:
388 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
389 if (ret)
390 goto out;
391 break;
392 case MVMS_DAT:
393 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
394 if (ret)
395 goto out;
396 break;
397 case MVMS_EVENT:
398 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
399 if (ret)
400 goto out;
401 break;
402 default:
403 lbs_deb_sdio("invalid type (%d) from firmware\n",
404 (int)type);
405 ret = -EINVAL;
406 goto out;
407 }
408
409out:
410 if (ret)
411 pr_err("problem fetching packet from firmware\n");
412
413 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
414
415 return ret;
416}
417
418static void if_sdio_host_to_card_worker(struct work_struct *work)
419{
420 struct if_sdio_card *card;
421 struct if_sdio_packet *packet;
422 int ret;
423 unsigned long flags;
424
425 lbs_deb_enter(LBS_DEB_SDIO);
426
427 card = container_of(work, struct if_sdio_card, packet_worker);
428
429 while (1) {
430 spin_lock_irqsave(&card->lock, flags);
431 packet = card->packets;
432 if (packet)
433 card->packets = packet->next;
434 spin_unlock_irqrestore(&card->lock, flags);
435
436 if (!packet)
437 break;
438
439 sdio_claim_host(card->func);
440
441 ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
442 if (ret == 0) {
443 ret = sdio_writesb(card->func, card->ioport,
444 packet->buffer, packet->nb);
445 }
446
447 if (ret)
448 pr_err("error %d sending packet to firmware\n", ret);
449
450 sdio_release_host(card->func);
451
452 kfree(packet);
453 }
454
455 lbs_deb_leave(LBS_DEB_SDIO);
456}
457
458/********************************************************************/
459/* Firmware */
460/********************************************************************/
461
462#define FW_DL_READY_STATUS (IF_SDIO_IO_RDY | IF_SDIO_DL_RDY)
463
464static int if_sdio_prog_helper(struct if_sdio_card *card,
465 const struct firmware *fw)
466{
467 int ret;
468 unsigned long timeout;
469 u8 *chunk_buffer;
470 u32 chunk_size;
471 const u8 *firmware;
472 size_t size;
473
474 lbs_deb_enter(LBS_DEB_SDIO);
475
476 chunk_buffer = kzalloc(64, GFP_KERNEL);
477 if (!chunk_buffer) {
478 ret = -ENOMEM;
479 goto out;
480 }
481
482 sdio_claim_host(card->func);
483
484 ret = sdio_set_block_size(card->func, 32);
485 if (ret)
486 goto release;
487
488 firmware = fw->data;
489 size = fw->size;
490
491 while (size) {
492 ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
493 if (ret)
494 goto release;
495
496 /* On some platforms (like Davinci) the chip needs more time
497 * between helper blocks.
498 */
499 mdelay(2);
500
501 chunk_size = min(size, (size_t)60);
502
503 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
504 memcpy(chunk_buffer + 4, firmware, chunk_size);
505/*
506 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
507*/
508 ret = sdio_writesb(card->func, card->ioport,
509 chunk_buffer, 64);
510 if (ret)
511 goto release;
512
513 firmware += chunk_size;
514 size -= chunk_size;
515 }
516
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);
520 if (ret)
521 goto release;
522
523 lbs_deb_sdio("waiting for helper to boot...\n");
524
525 /* wait for the helper to boot by looking at the size register */
526 timeout = jiffies + HZ;
527 while (1) {
528 u16 req_size;
529
530 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
531 if (ret)
532 goto release;
533
534 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
535 if (ret)
536 goto release;
537
538 if (req_size != 0)
539 break;
540
541 if (time_after(jiffies, timeout)) {
542 ret = -ETIMEDOUT;
543 goto release;
544 }
545
546 msleep(10);
547 }
548
549 ret = 0;
550
551release:
552 sdio_release_host(card->func);
553 kfree(chunk_buffer);
554
555out:
556 if (ret)
557 pr_err("failed to load helper firmware\n");
558
559 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
560 return ret;
561}
562
563static int if_sdio_prog_real(struct if_sdio_card *card,
564 const struct firmware *fw)
565{
566 int ret;
567 unsigned long timeout;
568 u8 *chunk_buffer;
569 u32 chunk_size;
570 const u8 *firmware;
571 size_t size, req_size;
572
573 lbs_deb_enter(LBS_DEB_SDIO);
574
575 chunk_buffer = kzalloc(512, GFP_KERNEL);
576 if (!chunk_buffer) {
577 ret = -ENOMEM;
578 goto out;
579 }
580
581 sdio_claim_host(card->func);
582
583 ret = sdio_set_block_size(card->func, 32);
584 if (ret)
585 goto release;
586
587 firmware = fw->data;
588 size = fw->size;
589
590 while (size) {
591 ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
592 if (ret)
593 goto release;
594
595 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
596 if (ret)
597 goto release;
598
599 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
600 if (ret)
601 goto release;
602/*
603 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
604*/
605 if (req_size == 0) {
606 lbs_deb_sdio("firmware helper gave up early\n");
607 ret = -EIO;
608 goto release;
609 }
610
611 if (req_size & 0x01) {
612 lbs_deb_sdio("firmware helper signalled error\n");
613 ret = -EIO;
614 goto release;
615 }
616
617 if (req_size > size)
618 req_size = size;
619
620 while (req_size) {
621 chunk_size = min(req_size, (size_t)512);
622
623 memcpy(chunk_buffer, firmware, chunk_size);
624/*
625 lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
626 chunk_size, (chunk_size + 31) / 32 * 32);
627*/
628 ret = sdio_writesb(card->func, card->ioport,
629 chunk_buffer, roundup(chunk_size, 32));
630 if (ret)
631 goto release;
632
633 firmware += chunk_size;
634 size -= chunk_size;
635 req_size -= chunk_size;
636 }
637 }
638
639 ret = 0;
640
641 lbs_deb_sdio("waiting for firmware to boot...\n");
642
643 /* wait for the firmware to boot */
644 timeout = jiffies + HZ;
645 while (1) {
646 u16 scratch;
647
648 scratch = if_sdio_read_scratch(card, &ret);
649 if (ret)
650 goto release;
651
652 if (scratch == IF_SDIO_FIRMWARE_OK)
653 break;
654
655 if (time_after(jiffies, timeout)) {
656 ret = -ETIMEDOUT;
657 goto release;
658 }
659
660 msleep(10);
661 }
662
663 ret = 0;
664
665release:
666 sdio_release_host(card->func);
667 kfree(chunk_buffer);
668
669out:
670 if (ret)
671 pr_err("failed to load firmware\n");
672
673 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
674 return ret;
675}
676
677static void if_sdio_do_prog_firmware(struct lbs_private *priv, int ret,
678 const struct firmware *helper,
679 const struct firmware *mainfw)
680{
681 struct if_sdio_card *card = priv->card;
682
683 if (ret) {
684 pr_err("failed to find firmware (%d)\n", ret);
685 return;
686 }
687
688 ret = if_sdio_prog_helper(card, helper);
689 if (ret)
690 goto out;
691
692 lbs_deb_sdio("Helper firmware loaded\n");
693
694 ret = if_sdio_prog_real(card, mainfw);
695 if (ret)
696 goto out;
697
698 lbs_deb_sdio("Firmware loaded\n");
699 if_sdio_finish_power_on(card);
700
701out:
702 release_firmware(helper);
703 release_firmware(mainfw);
704}
705
706static int if_sdio_prog_firmware(struct if_sdio_card *card)
707{
708 int ret;
709 u16 scratch;
710
711 lbs_deb_enter(LBS_DEB_SDIO);
712
713 /*
714 * Disable interrupts
715 */
716 sdio_claim_host(card->func);
717 sdio_writeb(card->func, 0x00, IF_SDIO_H_INT_MASK, &ret);
718 sdio_release_host(card->func);
719
720 sdio_claim_host(card->func);
721 scratch = if_sdio_read_scratch(card, &ret);
722 sdio_release_host(card->func);
723
724 lbs_deb_sdio("firmware status = %#x\n", scratch);
725 lbs_deb_sdio("scratch ret = %d\n", ret);
726
727 if (ret)
728 goto out;
729
730
731 /*
732 * The manual clearly describes that FEDC is the right code to use
733 * to detect firmware presence, but for SD8686 it is not that simple.
734 * Scratch is also used to store the RX packet length, so we lose
735 * the FEDC value early on. So we use a non-zero check in order
736 * to validate firmware presence.
737 * Additionally, the SD8686 in the Gumstix always has the high scratch
738 * bit set, even when the firmware is not loaded. So we have to
739 * exclude that from the test.
740 */
741 if (scratch == IF_SDIO_FIRMWARE_OK) {
742 lbs_deb_sdio("firmware already loaded\n");
743 if_sdio_finish_power_on(card);
744 return 0;
745 } else if ((card->model == MODEL_8686) && (scratch & 0x7fff)) {
746 lbs_deb_sdio("firmware may be running\n");
747 if_sdio_finish_power_on(card);
748 return 0;
749 }
750
751 ret = lbs_get_firmware_async(card->priv, &card->func->dev, card->model,
752 fw_table, if_sdio_do_prog_firmware);
753
754out:
755 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
756 return ret;
757}
758
759/********************************************************************/
760/* Power management */
761/********************************************************************/
762
763/* Finish power on sequence (after firmware is loaded) */
764static void if_sdio_finish_power_on(struct if_sdio_card *card)
765{
766 struct sdio_func *func = card->func;
767 struct lbs_private *priv = card->priv;
768 int ret;
769
770 sdio_claim_host(func);
771 sdio_set_block_size(card->func, IF_SDIO_BLOCK_SIZE);
772
773 /*
774 * Get rx_unit if the chip is SD8688 or newer.
775 * SD8385 & SD8686 do not have rx_unit.
776 */
777 if ((card->model != MODEL_8385)
778 && (card->model != MODEL_8686))
779 card->rx_unit = if_sdio_read_rx_unit(card);
780 else
781 card->rx_unit = 0;
782
783 /*
784 * Set up the interrupt handler late.
785 *
786 * If we set it up earlier, the (buggy) hardware generates a spurious
787 * interrupt, even before the interrupt has been enabled, with
788 * CCCR_INTx = 0.
789 *
790 * We register the interrupt handler late so that we can handle any
791 * spurious interrupts, and also to avoid generation of that known
792 * spurious interrupt in the first place.
793 */
794 ret = sdio_claim_irq(func, if_sdio_interrupt);
795 if (ret)
796 goto release;
797
798 /*
799 * Enable interrupts now that everything is set up
800 */
801 sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
802 if (ret)
803 goto release_irq;
804
805 sdio_release_host(func);
806
807 /*
808 * FUNC_INIT is required for SD8688 WLAN/BT multiple functions
809 */
810 if (card->model == MODEL_8688) {
811 struct cmd_header cmd;
812
813 memset(&cmd, 0, sizeof(cmd));
814
815 lbs_deb_sdio("send function INIT command\n");
816 if (__lbs_cmd(priv, CMD_FUNC_INIT, &cmd, sizeof(cmd),
817 lbs_cmd_copyback, (unsigned long) &cmd))
818 netdev_alert(priv->dev, "CMD_FUNC_INIT cmd failed\n");
819 }
820
821 priv->fw_ready = 1;
822 wake_up(&card->pwron_waitq);
823
824 if (!card->started) {
825 ret = lbs_start_card(priv);
826 if_sdio_power_off(card);
827 if (ret == 0) {
828 card->started = true;
829 /* Tell PM core that we don't need the card to be
830 * powered now */
831 pm_runtime_put_noidle(&func->dev);
832 }
833 }
834
835 return;
836
837release_irq:
838 sdio_release_irq(func);
839release:
840 sdio_release_host(func);
841}
842
843static int if_sdio_power_on(struct if_sdio_card *card)
844{
845 struct sdio_func *func = card->func;
846 struct mmc_host *host = func->card->host;
847 int ret;
848
849 sdio_claim_host(func);
850
851 ret = sdio_enable_func(func);
852 if (ret)
853 goto release;
854
855 /* For 1-bit transfers to the 8686 model, we need to enable the
856 * interrupt flag in the CCCR register. Set the MMC_QUIRK_LENIENT_FN0
857 * bit to allow access to non-vendor registers. */
858 if ((card->model == MODEL_8686) &&
859 (host->caps & MMC_CAP_SDIO_IRQ) &&
860 (host->ios.bus_width == MMC_BUS_WIDTH_1)) {
861 u8 reg;
862
863 func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
864 reg = sdio_f0_readb(func, SDIO_CCCR_IF, &ret);
865 if (ret)
866 goto disable;
867
868 reg |= SDIO_BUS_ECSI;
869 sdio_f0_writeb(func, reg, SDIO_CCCR_IF, &ret);
870 if (ret)
871 goto disable;
872 }
873
874 card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
875 if (ret)
876 goto disable;
877
878 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
879 if (ret)
880 goto disable;
881
882 card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
883 if (ret)
884 goto disable;
885
886 sdio_release_host(func);
887 ret = if_sdio_prog_firmware(card);
888 if (ret) {
889 sdio_disable_func(func);
890 return ret;
891 }
892
893 return 0;
894
895disable:
896 sdio_disable_func(func);
897release:
898 sdio_release_host(func);
899 return ret;
900}
901
902static int if_sdio_power_off(struct if_sdio_card *card)
903{
904 struct sdio_func *func = card->func;
905 struct lbs_private *priv = card->priv;
906
907 priv->fw_ready = 0;
908
909 sdio_claim_host(func);
910 sdio_release_irq(func);
911 sdio_disable_func(func);
912 sdio_release_host(func);
913 return 0;
914}
915
916
917/*******************************************************************/
918/* Libertas callbacks */
919/*******************************************************************/
920
921static int if_sdio_host_to_card(struct lbs_private *priv,
922 u8 type, u8 *buf, u16 nb)
923{
924 int ret;
925 struct if_sdio_card *card;
926 struct if_sdio_packet *packet, *cur;
927 u16 size;
928 unsigned long flags;
929
930 lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
931
932 card = priv->card;
933
934 if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
935 ret = -EINVAL;
936 goto out;
937 }
938
939 /*
940 * The transfer must be in one transaction or the firmware
941 * goes suicidal. There's no way to guarantee that for all
942 * controllers, but we can at least try.
943 */
944 size = sdio_align_size(card->func, nb + 4);
945
946 packet = kzalloc(sizeof(struct if_sdio_packet) + size,
947 GFP_ATOMIC);
948 if (!packet) {
949 ret = -ENOMEM;
950 goto out;
951 }
952
953 packet->next = NULL;
954 packet->nb = size;
955
956 /*
957 * SDIO specific header.
958 */
959 packet->buffer[0] = (nb + 4) & 0xff;
960 packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
961 packet->buffer[2] = type;
962 packet->buffer[3] = 0;
963
964 memcpy(packet->buffer + 4, buf, nb);
965
966 spin_lock_irqsave(&card->lock, flags);
967
968 if (!card->packets)
969 card->packets = packet;
970 else {
971 cur = card->packets;
972 while (cur->next)
973 cur = cur->next;
974 cur->next = packet;
975 }
976
977 switch (type) {
978 case MVMS_CMD:
979 priv->dnld_sent = DNLD_CMD_SENT;
980 break;
981 case MVMS_DAT:
982 priv->dnld_sent = DNLD_DATA_SENT;
983 break;
984 default:
985 lbs_deb_sdio("unknown packet type %d\n", (int)type);
986 }
987
988 spin_unlock_irqrestore(&card->lock, flags);
989
990 queue_work(card->workqueue, &card->packet_worker);
991
992 ret = 0;
993
994out:
995 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
996
997 return ret;
998}
999
1000static int if_sdio_enter_deep_sleep(struct lbs_private *priv)
1001{
1002 int ret = -1;
1003 struct cmd_header cmd;
1004
1005 memset(&cmd, 0, sizeof(cmd));
1006
1007 lbs_deb_sdio("send DEEP_SLEEP command\n");
1008 ret = __lbs_cmd(priv, CMD_802_11_DEEP_SLEEP, &cmd, sizeof(cmd),
1009 lbs_cmd_copyback, (unsigned long) &cmd);
1010 if (ret)
1011 netdev_err(priv->dev, "DEEP_SLEEP cmd failed\n");
1012
1013 mdelay(200);
1014 return ret;
1015}
1016
1017static int if_sdio_exit_deep_sleep(struct lbs_private *priv)
1018{
1019 struct if_sdio_card *card = priv->card;
1020 int ret = -1;
1021
1022 lbs_deb_enter(LBS_DEB_SDIO);
1023 sdio_claim_host(card->func);
1024
1025 sdio_writeb(card->func, HOST_POWER_UP, CONFIGURATION_REG, &ret);
1026 if (ret)
1027 netdev_err(priv->dev, "sdio_writeb failed!\n");
1028
1029 sdio_release_host(card->func);
1030 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1031 return ret;
1032}
1033
1034static int if_sdio_reset_deep_sleep_wakeup(struct lbs_private *priv)
1035{
1036 struct if_sdio_card *card = priv->card;
1037 int ret = -1;
1038
1039 lbs_deb_enter(LBS_DEB_SDIO);
1040 sdio_claim_host(card->func);
1041
1042 sdio_writeb(card->func, 0, CONFIGURATION_REG, &ret);
1043 if (ret)
1044 netdev_err(priv->dev, "sdio_writeb failed!\n");
1045
1046 sdio_release_host(card->func);
1047 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1048 return ret;
1049
1050}
1051
1052static struct mmc_host *reset_host;
1053
1054static void if_sdio_reset_card_worker(struct work_struct *work)
1055{
1056 /*
1057 * The actual reset operation must be run outside of lbs_thread. This
1058 * is because mmc_remove_host() will cause the device to be instantly
1059 * destroyed, and the libertas driver then needs to end lbs_thread,
1060 * leading to a deadlock.
1061 *
1062 * We run it in a workqueue totally independent from the if_sdio_card
1063 * instance for that reason.
1064 */
1065
1066 pr_info("Resetting card...");
1067 mmc_remove_host(reset_host);
1068 mmc_add_host(reset_host);
1069}
1070static DECLARE_WORK(card_reset_work, if_sdio_reset_card_worker);
1071
1072static void if_sdio_reset_card(struct lbs_private *priv)
1073{
1074 struct if_sdio_card *card = priv->card;
1075
1076 if (work_pending(&card_reset_work))
1077 return;
1078
1079 reset_host = card->func->card->host;
1080 schedule_work(&card_reset_work);
1081}
1082
1083static int if_sdio_power_save(struct lbs_private *priv)
1084{
1085 struct if_sdio_card *card = priv->card;
1086 int ret;
1087
1088 flush_workqueue(card->workqueue);
1089
1090 ret = if_sdio_power_off(card);
1091
1092 /* Let runtime PM know the card is powered off */
1093 pm_runtime_put_sync(&card->func->dev);
1094
1095 return ret;
1096}
1097
1098static int if_sdio_power_restore(struct lbs_private *priv)
1099{
1100 struct if_sdio_card *card = priv->card;
1101 int r;
1102
1103 /* Make sure the card will not be powered off by runtime PM */
1104 pm_runtime_get_sync(&card->func->dev);
1105
1106 r = if_sdio_power_on(card);
1107 if (r)
1108 return r;
1109
1110 wait_event(card->pwron_waitq, priv->fw_ready);
1111 return 0;
1112}
1113
1114
1115/*******************************************************************/
1116/* SDIO callbacks */
1117/*******************************************************************/
1118
1119static void if_sdio_interrupt(struct sdio_func *func)
1120{
1121 int ret;
1122 struct if_sdio_card *card;
1123 u8 cause;
1124
1125 lbs_deb_enter(LBS_DEB_SDIO);
1126
1127 card = sdio_get_drvdata(func);
1128
1129 cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
1130 if (ret || !cause)
1131 goto out;
1132
1133 lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
1134
1135 sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
1136 if (ret)
1137 goto out;
1138
1139 /*
1140 * Ignore the define name, this really means the card has
1141 * successfully received the command.
1142 */
1143 card->priv->is_activity_detected = 1;
1144 if (cause & IF_SDIO_H_INT_DNLD)
1145 lbs_host_to_card_done(card->priv);
1146
1147
1148 if (cause & IF_SDIO_H_INT_UPLD) {
1149 ret = if_sdio_card_to_host(card);
1150 if (ret)
1151 goto out;
1152 }
1153
1154 ret = 0;
1155
1156out:
1157 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1158}
1159
1160static int if_sdio_probe(struct sdio_func *func,
1161 const struct sdio_device_id *id)
1162{
1163 struct if_sdio_card *card;
1164 struct lbs_private *priv;
1165 int ret, i;
1166 unsigned int model;
1167 struct if_sdio_packet *packet;
1168
1169 lbs_deb_enter(LBS_DEB_SDIO);
1170
1171 for (i = 0;i < func->card->num_info;i++) {
1172 if (sscanf(func->card->info[i],
1173 "802.11 SDIO ID: %x", &model) == 1)
1174 break;
1175 if (sscanf(func->card->info[i],
1176 "ID: %x", &model) == 1)
1177 break;
1178 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
1179 model = MODEL_8385;
1180 break;
1181 }
1182 }
1183
1184 if (i == func->card->num_info) {
1185 pr_err("unable to identify card model\n");
1186 return -ENODEV;
1187 }
1188
1189 card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
1190 if (!card)
1191 return -ENOMEM;
1192
1193 card->func = func;
1194 card->model = model;
1195
1196 switch (card->model) {
1197 case MODEL_8385:
1198 card->scratch_reg = IF_SDIO_SCRATCH_OLD;
1199 break;
1200 case MODEL_8686:
1201 card->scratch_reg = IF_SDIO_SCRATCH;
1202 break;
1203 case MODEL_8688:
1204 default: /* for newer chipsets */
1205 card->scratch_reg = IF_SDIO_FW_STATUS;
1206 break;
1207 }
1208
1209 spin_lock_init(&card->lock);
1210 card->workqueue = create_workqueue("libertas_sdio");
1211 INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
1212 init_waitqueue_head(&card->pwron_waitq);
1213
1214 /* Check if we support this card */
1215 for (i = 0; i < ARRAY_SIZE(fw_table); i++) {
1216 if (card->model == fw_table[i].model)
1217 break;
1218 }
1219 if (i == ARRAY_SIZE(fw_table)) {
1220 pr_err("unknown card model 0x%x\n", card->model);
1221 ret = -ENODEV;
1222 goto free;
1223 }
1224
1225 sdio_set_drvdata(func, card);
1226
1227 lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
1228 "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
1229 func->class, func->vendor, func->device,
1230 model, (unsigned)card->ioport);
1231
1232
1233 priv = lbs_add_card(card, &func->dev);
1234 if (!priv) {
1235 ret = -ENOMEM;
1236 goto free;
1237 }
1238
1239 card->priv = priv;
1240
1241 priv->card = card;
1242 priv->hw_host_to_card = if_sdio_host_to_card;
1243 priv->enter_deep_sleep = if_sdio_enter_deep_sleep;
1244 priv->exit_deep_sleep = if_sdio_exit_deep_sleep;
1245 priv->reset_deep_sleep_wakeup = if_sdio_reset_deep_sleep_wakeup;
1246 priv->reset_card = if_sdio_reset_card;
1247 priv->power_save = if_sdio_power_save;
1248 priv->power_restore = if_sdio_power_restore;
1249
1250 ret = if_sdio_power_on(card);
1251 if (ret)
1252 goto err_activate_card;
1253
1254out:
1255 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1256
1257 return ret;
1258
1259err_activate_card:
1260 flush_workqueue(card->workqueue);
1261 lbs_remove_card(priv);
1262free:
1263 destroy_workqueue(card->workqueue);
1264 while (card->packets) {
1265 packet = card->packets;
1266 card->packets = card->packets->next;
1267 kfree(packet);
1268 }
1269
1270 kfree(card);
1271
1272 goto out;
1273}
1274
1275static void if_sdio_remove(struct sdio_func *func)
1276{
1277 struct if_sdio_card *card;
1278 struct if_sdio_packet *packet;
1279
1280 lbs_deb_enter(LBS_DEB_SDIO);
1281
1282 card = sdio_get_drvdata(func);
1283
1284 /* Undo decrement done above in if_sdio_probe */
1285 pm_runtime_get_noresume(&func->dev);
1286
1287 if (user_rmmod && (card->model == MODEL_8688)) {
1288 /*
1289 * FUNC_SHUTDOWN is required for SD8688 WLAN/BT
1290 * multiple functions
1291 */
1292 struct cmd_header cmd;
1293
1294 memset(&cmd, 0, sizeof(cmd));
1295
1296 lbs_deb_sdio("send function SHUTDOWN command\n");
1297 if (__lbs_cmd(card->priv, CMD_FUNC_SHUTDOWN,
1298 &cmd, sizeof(cmd), lbs_cmd_copyback,
1299 (unsigned long) &cmd))
1300 pr_alert("CMD_FUNC_SHUTDOWN cmd failed\n");
1301 }
1302
1303
1304 lbs_deb_sdio("call remove card\n");
1305 lbs_stop_card(card->priv);
1306 lbs_remove_card(card->priv);
1307
1308 flush_workqueue(card->workqueue);
1309 destroy_workqueue(card->workqueue);
1310
1311 while (card->packets) {
1312 packet = card->packets;
1313 card->packets = card->packets->next;
1314 kfree(packet);
1315 }
1316
1317 lbs_deb_leave(LBS_DEB_SDIO);
1318}
1319
1320static int if_sdio_suspend(struct device *dev)
1321{
1322 struct sdio_func *func = dev_to_sdio_func(dev);
1323 int ret;
1324 struct if_sdio_card *card = sdio_get_drvdata(func);
1325
1326 mmc_pm_flag_t flags = sdio_get_host_pm_caps(func);
1327
1328 dev_info(dev, "%s: suspend: PM flags = 0x%x\n",
1329 sdio_func_id(func), flags);
1330
1331 /* If we aren't being asked to wake on anything, we should bail out
1332 * and let the SD stack power down the card.
1333 */
1334 if (card->priv->wol_criteria == EHS_REMOVE_WAKEUP) {
1335 dev_info(dev, "Suspend without wake params -- powering down card\n");
1336 return -ENOSYS;
1337 }
1338
1339 if (!(flags & MMC_PM_KEEP_POWER)) {
1340 dev_err(dev, "%s: cannot remain alive while host is suspended\n",
1341 sdio_func_id(func));
1342 return -ENOSYS;
1343 }
1344
1345 ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
1346 if (ret)
1347 return ret;
1348
1349 ret = lbs_suspend(card->priv);
1350 if (ret)
1351 return ret;
1352
1353 return sdio_set_host_pm_flags(func, MMC_PM_WAKE_SDIO_IRQ);
1354}
1355
1356static int if_sdio_resume(struct device *dev)
1357{
1358 struct sdio_func *func = dev_to_sdio_func(dev);
1359 struct if_sdio_card *card = sdio_get_drvdata(func);
1360 int ret;
1361
1362 dev_info(dev, "%s: resume: we're back\n", sdio_func_id(func));
1363
1364 ret = lbs_resume(card->priv);
1365
1366 return ret;
1367}
1368
1369static const struct dev_pm_ops if_sdio_pm_ops = {
1370 .suspend = if_sdio_suspend,
1371 .resume = if_sdio_resume,
1372};
1373
1374static struct sdio_driver if_sdio_driver = {
1375 .name = "libertas_sdio",
1376 .id_table = if_sdio_ids,
1377 .probe = if_sdio_probe,
1378 .remove = if_sdio_remove,
1379 .drv = {
1380 .pm = &if_sdio_pm_ops,
1381 },
1382};
1383
1384/*******************************************************************/
1385/* Module functions */
1386/*******************************************************************/
1387
1388static int __init if_sdio_init_module(void)
1389{
1390 int ret = 0;
1391
1392 lbs_deb_enter(LBS_DEB_SDIO);
1393
1394 printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1395 printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1396
1397 ret = sdio_register_driver(&if_sdio_driver);
1398
1399 /* Clear the flag in case user removes the card. */
1400 user_rmmod = 0;
1401
1402 lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1403
1404 return ret;
1405}
1406
1407static void __exit if_sdio_exit_module(void)
1408{
1409 lbs_deb_enter(LBS_DEB_SDIO);
1410
1411 /* Set the flag as user is removing this module. */
1412 user_rmmod = 1;
1413
1414 cancel_work_sync(&card_reset_work);
1415
1416 sdio_unregister_driver(&if_sdio_driver);
1417
1418 lbs_deb_leave(LBS_DEB_SDIO);
1419}
1420
1421module_init(if_sdio_init_module);
1422module_exit(if_sdio_exit_module);
1423
1424MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1425MODULE_AUTHOR("Pierre Ossman");
1426MODULE_LICENSE("GPL");