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