net: wireless: bcmdhd: Improve suspend/resume processing
[linux-2.6.git] / drivers / net / wireless / bcmdhd / bcmsdh_sdmmc_linux.c
1 /*
2  * BCMSDH Function Driver for the native SDIO/MMC driver in the Linux Kernel
3  *
4  * Copyright (C) 1999-2011, Broadcom Corporation
5  * 
6  *         Unless you and Broadcom execute a separate written software license
7  * agreement governing use of this software, this software is licensed to you
8  * under the terms of the GNU General Public License version 2 (the "GPL"),
9  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
10  * following added to such license:
11  * 
12  *      As a special exception, the copyright holders of this software give you
13  * permission to link this software with independent modules, and to copy and
14  * distribute the resulting executable under terms of your choice, provided that
15  * you also meet, for each linked independent module, the terms and conditions of
16  * the license of that module.  An independent module is a module which is not
17  * derived from this software.  The special exception does not apply to any
18  * modifications of the software.
19  * 
20  *      Notwithstanding the above, under no circumstances may you combine this
21  * software in any way with any other Broadcom software provided under a license
22  * other than the GPL, without Broadcom's express prior written consent.
23  *
24  * $Id: bcmsdh_sdmmc_linux.c,v 1.8.6.2 2011-02-01 18:38:36 Exp $
25  */
26
27 #include <typedefs.h>
28 #include <bcmutils.h>
29 #include <sdio.h>       /* SDIO Device and Protocol Specs */
30 #include <bcmsdbus.h>   /* bcmsdh to/from specific controller APIs */
31 #include <sdiovar.h>    /* to get msglevel bit values */
32
33 #include <linux/sched.h>        /* request_irq() */
34
35 #include <linux/mmc/core.h>
36 #include <linux/mmc/card.h>
37 #include <linux/mmc/sdio_func.h>
38 #include <linux/mmc/sdio_ids.h>
39
40 #if !defined(SDIO_VENDOR_ID_BROADCOM)
41 #define SDIO_VENDOR_ID_BROADCOM         0x02d0
42 #endif /* !defined(SDIO_VENDOR_ID_BROADCOM) */
43
44 #define SDIO_DEVICE_ID_BROADCOM_DEFAULT 0x0000
45
46 #if !defined(SDIO_DEVICE_ID_BROADCOM_4325_SDGWB)
47 #define SDIO_DEVICE_ID_BROADCOM_4325_SDGWB      0x0492  /* BCM94325SDGWB */
48 #endif /* !defined(SDIO_DEVICE_ID_BROADCOM_4325_SDGWB) */
49 #if !defined(SDIO_DEVICE_ID_BROADCOM_4325)
50 #define SDIO_DEVICE_ID_BROADCOM_4325    0x0493
51 #endif /* !defined(SDIO_DEVICE_ID_BROADCOM_4325) */
52 #if !defined(SDIO_DEVICE_ID_BROADCOM_4329)
53 #define SDIO_DEVICE_ID_BROADCOM_4329    0x4329
54 #endif /* !defined(SDIO_DEVICE_ID_BROADCOM_4329) */
55 #if !defined(SDIO_DEVICE_ID_BROADCOM_4319)
56 #define SDIO_DEVICE_ID_BROADCOM_4319    0x4319
57 #endif /* !defined(SDIO_DEVICE_ID_BROADCOM_4319) */
58
59 #include <bcmsdh_sdmmc.h>
60
61 #include <dhd_dbg.h>
62
63 #ifdef WL_CFG80211
64 extern void wl_cfg80211_set_sdio_func(void *func);
65 #endif
66
67 extern void sdioh_sdmmc_devintr_off(sdioh_info_t *sd);
68 extern void sdioh_sdmmc_devintr_on(sdioh_info_t *sd);
69 extern int dhd_os_check_wakelock(void *dhdp);
70 extern int dhd_os_check_if_up(void *dhdp);
71 extern void *bcmsdh_get_drvdata(void);
72
73 int sdio_function_init(void);
74 void sdio_function_cleanup(void);
75
76 #define DESCRIPTION "bcmsdh_sdmmc Driver"
77 #define AUTHOR "Broadcom Corporation"
78
79 /* module param defaults */
80 static int clockoverride = 0;
81
82 module_param(clockoverride, int, 0644);
83 MODULE_PARM_DESC(clockoverride, "SDIO card clock override");
84
85 PBCMSDH_SDMMC_INSTANCE gInstance;
86
87 /* Maximum number of bcmsdh_sdmmc devices supported by driver */
88 #define BCMSDH_SDMMC_MAX_DEVICES 1
89
90 extern int bcmsdh_probe(struct device *dev);
91 extern int bcmsdh_remove(struct device *dev);
92
93 extern volatile bool dhd_mmc_suspend;
94
95 static int bcmsdh_sdmmc_probe(struct sdio_func *func,
96                               const struct sdio_device_id *id)
97 {
98         int ret = 0;
99         static struct sdio_func sdio_func_0;
100         sd_trace(("bcmsdh_sdmmc: %s Enter\n", __FUNCTION__));
101         sd_trace(("sdio_bcmsdh: func->class=%x\n", func->class));
102         sd_trace(("sdio_vendor: 0x%04x\n", func->vendor));
103         sd_trace(("sdio_device: 0x%04x\n", func->device));
104         sd_trace(("Function#: 0x%04x\n", func->num));
105
106         if (func->num == 1) {
107                 sdio_func_0.num = 0;
108                 sdio_func_0.card = func->card;
109                 gInstance->func[0] = &sdio_func_0;
110                 if(func->device == 0x4) { /* 4318 */
111                         gInstance->func[2] = NULL;
112                         sd_trace(("NIC found, calling bcmsdh_probe...\n"));
113                         ret = bcmsdh_probe(&func->dev);
114                 }
115         }
116
117         gInstance->func[func->num] = func;
118
119         if (func->num == 2) {
120 #ifdef WL_CFG80211
121                 wl_cfg80211_set_sdio_func(func);
122 #endif
123                 sd_trace(("F2 found, calling bcmsdh_probe...\n"));
124                 ret = bcmsdh_probe(&func->dev);
125         }
126
127         return ret;
128 }
129
130 static void bcmsdh_sdmmc_remove(struct sdio_func *func)
131 {
132         sd_trace(("bcmsdh_sdmmc: %s Enter\n", __FUNCTION__));
133         sd_info(("sdio_bcmsdh: func->class=%x\n", func->class));
134         sd_info(("sdio_vendor: 0x%04x\n", func->vendor));
135         sd_info(("sdio_device: 0x%04x\n", func->device));
136         sd_info(("Function#: 0x%04x\n", func->num));
137
138         if (func->num == 2) {
139                 sd_trace(("F2 found, calling bcmsdh_remove...\n"));
140                 bcmsdh_remove(&func->dev);
141         } else if (func->num == 1) {
142                 sdio_claim_host(func);
143                 sdio_disable_func(func);
144                 sdio_release_host(func);
145                 gInstance->func[1] = NULL;
146         }
147 }
148
149 /* devices we support, null terminated */
150 static const struct sdio_device_id bcmsdh_sdmmc_ids[] = {
151         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_DEFAULT) },
152         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4325_SDGWB) },
153         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4325) },
154         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4329) },
155         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4319) },
156         { SDIO_DEVICE_CLASS(SDIO_CLASS_NONE)            },
157         { /* end: all zeroes */                         },
158 };
159
160 MODULE_DEVICE_TABLE(sdio, bcmsdh_sdmmc_ids);
161
162 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 39)) && defined(CONFIG_PM)
163 static int bcmsdh_sdmmc_suspend(struct device *pdev)
164 {
165         struct sdio_func *func = dev_to_sdio_func(pdev);
166
167         if (func->num != 2)
168                 return 0;
169         if (dhd_os_check_wakelock(bcmsdh_get_drvdata()))
170                 return -EBUSY;
171 #if defined(OOB_INTR_ONLY)
172         bcmsdh_oob_intr_set(0);
173 #endif
174         dhd_mmc_suspend = TRUE;
175         smp_mb();
176
177         return 0;
178 }
179
180 static int bcmsdh_sdmmc_resume(struct device *pdev)
181 {
182         struct sdio_func *func = dev_to_sdio_func(pdev);
183
184         if (func->num != 2)
185                 return 0;
186         dhd_mmc_suspend = FALSE;
187 #if defined(OOB_INTR_ONLY)
188         if (dhd_os_check_if_up(bcmsdh_get_drvdata()))
189                 bcmsdh_oob_intr_set(1);
190 #endif
191         smp_mb();
192         return 0;
193 }
194
195 static const struct dev_pm_ops bcmsdh_sdmmc_pm_ops = {
196         .suspend        = bcmsdh_sdmmc_suspend,
197         .resume         = bcmsdh_sdmmc_resume,
198 };
199 #endif
200
201 static struct sdio_driver bcmsdh_sdmmc_driver = {
202         .probe          = bcmsdh_sdmmc_probe,
203         .remove         = bcmsdh_sdmmc_remove,
204         .name           = "bcmsdh_sdmmc",
205         .id_table       = bcmsdh_sdmmc_ids,
206 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 39)) && defined(CONFIG_PM)
207         .drv = {
208                 .pm     = &bcmsdh_sdmmc_pm_ops,
209         },
210 #endif
211 };
212
213 struct sdos_info {
214         sdioh_info_t *sd;
215         spinlock_t lock;
216 };
217
218
219 int
220 sdioh_sdmmc_osinit(sdioh_info_t *sd)
221 {
222         struct sdos_info *sdos;
223
224         sdos = (struct sdos_info*)MALLOC(sd->osh, sizeof(struct sdos_info));
225         sd->sdos_info = (void*)sdos;
226         if (sdos == NULL)
227                 return BCME_NOMEM;
228
229         sdos->sd = sd;
230         spin_lock_init(&sdos->lock);
231         return BCME_OK;
232 }
233
234 void
235 sdioh_sdmmc_osfree(sdioh_info_t *sd)
236 {
237         struct sdos_info *sdos;
238         ASSERT(sd && sd->sdos_info);
239
240         sdos = (struct sdos_info *)sd->sdos_info;
241         MFREE(sd->osh, sdos, sizeof(struct sdos_info));
242 }
243
244 /* Interrupt enable/disable */
245 SDIOH_API_RC
246 sdioh_interrupt_set(sdioh_info_t *sd, bool enable)
247 {
248         ulong flags;
249         struct sdos_info *sdos;
250
251         sd_trace(("%s: %s\n", __FUNCTION__, enable ? "Enabling" : "Disabling"));
252
253         sdos = (struct sdos_info *)sd->sdos_info;
254         ASSERT(sdos);
255
256 #if !defined(OOB_INTR_ONLY)
257         if (enable && !(sd->intr_handler && sd->intr_handler_arg)) {
258                 sd_err(("%s: no handler registered, will not enable\n", __FUNCTION__));
259                 return SDIOH_API_RC_FAIL;
260         }
261 #endif /* !defined(OOB_INTR_ONLY) */
262
263         /* Ensure atomicity for enable/disable calls */
264         spin_lock_irqsave(&sdos->lock, flags);
265
266         sd->client_intr_enabled = enable;
267         if (enable) {
268                 sdioh_sdmmc_devintr_on(sd);
269         } else {
270                 sdioh_sdmmc_devintr_off(sd);
271         }
272
273         spin_unlock_irqrestore(&sdos->lock, flags);
274
275         return SDIOH_API_RC_SUCCESS;
276 }
277
278
279 #ifdef BCMSDH_MODULE
280 static int __init
281 bcmsdh_module_init(void)
282 {
283         int error = 0;
284         sdio_function_init();
285         return error;
286 }
287
288 static void __exit
289 bcmsdh_module_cleanup(void)
290 {
291         sdio_function_cleanup();
292 }
293
294 module_init(bcmsdh_module_init);
295 module_exit(bcmsdh_module_cleanup);
296
297 MODULE_LICENSE("GPL v2");
298 MODULE_DESCRIPTION(DESCRIPTION);
299 MODULE_AUTHOR(AUTHOR);
300
301 #endif /* BCMSDH_MODULE */
302 /*
303  * module init
304 */
305 int sdio_function_init(void)
306 {
307         int error = 0;
308         sd_trace(("bcmsdh_sdmmc: %s Enter\n", __FUNCTION__));
309
310         gInstance = kzalloc(sizeof(BCMSDH_SDMMC_INSTANCE), GFP_KERNEL);
311         if (!gInstance)
312                 return -ENOMEM;
313
314         error = sdio_register_driver(&bcmsdh_sdmmc_driver);
315
316         return error;
317 }
318
319 /*
320  * module cleanup
321 */
322 extern int bcmsdh_remove(struct device *dev);
323 void sdio_function_cleanup(void)
324 {
325         sd_trace(("%s Enter\n", __FUNCTION__));
326
327
328         sdio_unregister_driver(&bcmsdh_sdmmc_driver);
329
330         if (gInstance)
331                 kfree(gInstance);
332 }