a564671a242e22541bfff54b3f5a19b7c64e7879
[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-2012, 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 342895 2012-07-04 11:36:15Z $
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_4319)
53 #define SDIO_DEVICE_ID_BROADCOM_4319    0x4319
54 #endif /* !defined(SDIO_DEVICE_ID_BROADCOM_4319) */
55 #if !defined(SDIO_DEVICE_ID_BROADCOM_4330)
56 #define SDIO_DEVICE_ID_BROADCOM_4330    0x4330
57 #endif /* !defined(SDIO_DEVICE_ID_BROADCOM_4330) */
58 #if !defined(SDIO_DEVICE_ID_BROADCOM_4334)
59 #define SDIO_DEVICE_ID_BROADCOM_4334    0x4334
60 #endif /* !defined(SDIO_DEVICE_ID_BROADCOM_4334) */
61 #if !defined(SDIO_DEVICE_ID_BROADCOM_4324)
62 #define SDIO_DEVICE_ID_BROADCOM_4324    0x4324
63 #endif /* !defined(SDIO_DEVICE_ID_BROADCOM_4324) */
64 #if !defined(SDIO_DEVICE_ID_BROADCOM_43239)
65 #define SDIO_DEVICE_ID_BROADCOM_43239    43239
66 #endif /* !defined(SDIO_DEVICE_ID_BROADCOM_43239) */
67
68 #include <bcmsdh_sdmmc.h>
69
70 #include <dhd_dbg.h>
71
72 #ifdef WL_CFG80211
73 extern void wl_cfg80211_set_parent_dev(void *dev);
74 #endif
75
76 extern void sdioh_sdmmc_devintr_off(sdioh_info_t *sd);
77 extern void sdioh_sdmmc_devintr_on(sdioh_info_t *sd);
78 extern int dhd_os_check_wakelock(void *dhdp);
79 extern int dhd_os_check_if_up(void *dhdp);
80 extern void *bcmsdh_get_drvdata(void);
81
82 int sdio_function_init(void);
83 void sdio_function_cleanup(void);
84
85 #define DESCRIPTION "bcmsdh_sdmmc Driver"
86 #define AUTHOR "Broadcom Corporation"
87
88 /* module param defaults */
89 static int clockoverride = 0;
90
91 module_param(clockoverride, int, 0644);
92 MODULE_PARM_DESC(clockoverride, "SDIO card clock override");
93
94 PBCMSDH_SDMMC_INSTANCE gInstance;
95
96 /* Maximum number of bcmsdh_sdmmc devices supported by driver */
97 #define BCMSDH_SDMMC_MAX_DEVICES 1
98
99 extern int bcmsdh_probe_bcmdhd(struct device *dev);
100 extern int bcmsdh_remove_bcmdhd(struct device *dev);
101 extern volatile bool dhd_mmc_suspend;
102
103 static int bcmsdh_sdmmc_probe(struct sdio_func *func,
104                               const struct sdio_device_id *id)
105 {
106         int ret = 0;
107         static struct sdio_func sdio_func_0;
108
109         if (func) {
110                 sd_trace(("bcmsdh_sdmmc: %s Enter\n", __FUNCTION__));
111                 sd_trace(("sdio_bcmsdh: func->class=%x\n", func->class));
112                 sd_trace(("sdio_vendor: 0x%04x\n", func->vendor));
113                 sd_trace(("sdio_device: 0x%04x\n", func->device));
114                 sd_trace(("Function#: 0x%04x\n", func->num));
115
116                 if (func->num == 1) {
117                         sdio_func_0.num = 0;
118                         sdio_func_0.card = func->card;
119                         gInstance->func[0] = &sdio_func_0;
120                         if(func->device == 0x4) { /* 4318 */
121                                 gInstance->func[2] = NULL;
122                                 sd_trace(("NIC found, calling bcmsdh_probe...\n"));
123                                 ret = bcmsdh_probe_bcmdhd(&func->dev);
124                         }
125                 }
126
127                 gInstance->func[func->num] = func;
128
129         if (func->num == 2) {
130         #ifdef WL_CFG80211
131                         wl_cfg80211_set_parent_dev(&func->dev);
132         #endif
133                         sd_trace(("F2 found, calling bcmsdh_probe...\n"));
134                         ret = bcmsdh_probe_bcmdhd(&func->dev);
135                 }
136         } else {
137                 ret = -ENODEV;
138         }
139
140         return ret;
141 }
142
143 static void bcmsdh_sdmmc_remove(struct sdio_func *func)
144 {
145         if (func) {
146                 sd_trace(("bcmsdh_sdmmc: %s Enter\n", __FUNCTION__));
147                 sd_info(("sdio_bcmsdh: func->class=%x\n", func->class));
148                 sd_info(("sdio_vendor: 0x%04x\n", func->vendor));
149                 sd_info(("sdio_device: 0x%04x\n", func->device));
150                 sd_info(("Function#: 0x%04x\n", func->num));
151
152                 if (func->num == 2) {
153                         sd_trace(("F2 found, calling bcmsdh_remove...\n"));
154                         bcmsdh_remove_bcmdhd(&func->dev);
155                 } else if (func->num == 1) {
156                         sdio_claim_host(func);
157                         sdio_disable_func(func);
158                         sdio_release_host(func);
159                         gInstance->func[1] = NULL;
160                 }
161         }
162 }
163
164 /* devices we support, null terminated */
165 static const struct sdio_device_id bcmsdh_sdmmc_ids[] = {
166         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_DEFAULT) },
167         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4325_SDGWB) },
168         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4325) },
169         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4319) },
170         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4330) },
171         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4334) },
172         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4324) },
173         { SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_43239) },
174 #ifdef CONFIG_ANDROID
175         { SDIO_DEVICE_CLASS(SDIO_CLASS_NONE)            },
176 #endif
177         { /* end: all zeroes */                         },
178 };
179
180 MODULE_DEVICE_TABLE(sdio, bcmsdh_sdmmc_ids);
181
182 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 39)) && defined(CONFIG_PM)
183 static int bcmsdh_sdmmc_suspend(struct device *pdev)
184 {
185         struct sdio_func *func = dev_to_sdio_func(pdev);
186         mmc_pm_flag_t sdio_flags;
187         int ret = 0;
188
189         if (func->num != 2)
190                 return 0;
191
192         sd_trace(("%s Enter\n", __FUNCTION__));
193
194         if (dhd_os_check_wakelock(bcmsdh_get_drvdata()))
195                 return -EBUSY;
196
197         sdio_flags = sdio_get_host_pm_caps(func);
198
199         if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
200                 sd_err(("%s: can't keep power while host is suspended\n", __FUNCTION__));
201                 return  -EINVAL;
202         }
203
204         /* keep power while host suspended */
205         ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
206         if (ret) {
207                 sd_err(("%s: error while trying to keep power\n", __FUNCTION__));
208                 return ret;
209         }
210 #if defined(OOB_INTR_ONLY)
211         bcmsdh_oob_intr_set(0);
212 #endif /* defined(OOB_INTR_ONLY) */
213
214         sdio_flags = sdio_get_host_pm_caps(func);
215
216         if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
217                 sd_err(("can't keep power while host "
218                                 "is suspended\n", __FUNCTION__));
219                 ret = -EINVAL;
220                 goto out;
221         }
222
223         /* keep power while host suspended */
224         ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
225         if (ret) {
226                 sd_err(("error while trying to keep power\n", __FUNCTION__));
227                 goto out;
228         }
229
230         dhd_mmc_suspend = TRUE;
231         smp_mb();
232
233 out:
234         return ret;
235 }
236
237 static int bcmsdh_sdmmc_resume(struct device *pdev)
238 {
239 #if defined(OOB_INTR_ONLY)
240         struct sdio_func *func = dev_to_sdio_func(pdev);
241 #endif
242         sd_trace(("%s Enter\n", __FUNCTION__));
243         dhd_mmc_suspend = FALSE;
244 #if defined(OOB_INTR_ONLY)
245         if ((func->num == 2) && dhd_os_check_if_up(bcmsdh_get_drvdata()))
246                 bcmsdh_oob_intr_set(1);
247 #endif /* (OOB_INTR_ONLY) */
248
249         smp_mb();
250         return 0;
251 }
252
253 static const struct dev_pm_ops bcmsdh_sdmmc_pm_ops = {
254         .suspend        = bcmsdh_sdmmc_suspend,
255         .resume         = bcmsdh_sdmmc_resume,
256 };
257 #endif  /* (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 39)) && defined(CONFIG_PM) */
258
259 #if defined(BCMLXSDMMC)
260 static struct semaphore *notify_semaphore = NULL;
261
262 static int dummy_probe(struct sdio_func *func,
263                               const struct sdio_device_id *id)
264 {
265         if (notify_semaphore)
266                 up(notify_semaphore);
267         return 0;
268 }
269
270 static void dummy_remove(struct sdio_func *func)
271 {
272 }
273
274 static struct sdio_driver dummy_sdmmc_driver = {
275         .probe          = dummy_probe,
276         .remove         = dummy_remove,
277         .name           = "dummy_sdmmc",
278         .id_table       = bcmsdh_sdmmc_ids,
279         };
280
281 int sdio_func_reg_notify(void* semaphore)
282 {
283         notify_semaphore = semaphore;
284         return sdio_register_driver(&dummy_sdmmc_driver);
285 }
286
287 void sdio_func_unreg_notify(void)
288 {
289         sdio_unregister_driver(&dummy_sdmmc_driver);
290 }
291
292 #endif /* defined(BCMLXSDMMC) */
293
294 static struct sdio_driver bcmsdh_sdmmc_driver = {
295         .probe          = bcmsdh_sdmmc_probe,
296         .remove         = bcmsdh_sdmmc_remove,
297         .name           = "bcmsdh_sdmmc",
298         .id_table       = bcmsdh_sdmmc_ids,
299 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 39)) && defined(CONFIG_PM)
300         .drv = {
301         .pm     = &bcmsdh_sdmmc_pm_ops,
302         },
303 #endif /* (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 39)) && defined(CONFIG_PM) */
304         };
305
306 struct sdos_info {
307         sdioh_info_t *sd;
308         spinlock_t lock;
309 };
310
311
312 int
313 sdioh_sdmmc_osinit(sdioh_info_t *sd)
314 {
315         struct sdos_info *sdos;
316
317         if (!sd)
318                 return BCME_BADARG;
319
320         sdos = (struct sdos_info*)MALLOC(sd->osh, sizeof(struct sdos_info));
321         sd->sdos_info = (void*)sdos;
322         if (sdos == NULL)
323                 return BCME_NOMEM;
324
325         sdos->sd = sd;
326         spin_lock_init(&sdos->lock);
327         return BCME_OK;
328 }
329
330 void
331 sdioh_sdmmc_osfree(sdioh_info_t *sd)
332 {
333         struct sdos_info *sdos;
334         ASSERT(sd && sd->sdos_info);
335
336         sdos = (struct sdos_info *)sd->sdos_info;
337         MFREE(sd->osh, sdos, sizeof(struct sdos_info));
338 }
339
340 /* Interrupt enable/disable */
341 SDIOH_API_RC
342 sdioh_interrupt_set(sdioh_info_t *sd, bool enable)
343 {
344         ulong flags;
345         struct sdos_info *sdos;
346
347         if (!sd)
348                 return BCME_BADARG;
349
350         sd_trace(("%s: %s\n", __FUNCTION__, enable ? "Enabling" : "Disabling"));
351
352         sdos = (struct sdos_info *)sd->sdos_info;
353         ASSERT(sdos);
354
355 #if !defined(OOB_INTR_ONLY)
356         if (enable && !(sd->intr_handler && sd->intr_handler_arg)) {
357                 sd_err(("%s: no handler registered, will not enable\n", __FUNCTION__));
358                 return SDIOH_API_RC_FAIL;
359         }
360 #endif /* !defined(OOB_INTR_ONLY) */
361
362         /* Ensure atomicity for enable/disable calls */
363         spin_lock_irqsave(&sdos->lock, flags);
364
365         sd->client_intr_enabled = enable;
366         if (enable) {
367                 sdioh_sdmmc_devintr_on(sd);
368         } else {
369                 sdioh_sdmmc_devintr_off(sd);
370         }
371
372         spin_unlock_irqrestore(&sdos->lock, flags);
373
374         return SDIOH_API_RC_SUCCESS;
375 }
376
377
378 #ifdef BCMSDH_MODULE
379 static int __init
380 bcmsdh_module_init(void)
381 {
382         int error = 0;
383         sdio_function_init();
384         return error;
385 }
386
387 static void __exit
388 bcmsdh_module_cleanup(void)
389 {
390         sdio_function_cleanup();
391 }
392
393 module_init(bcmsdh_module_init);
394 module_exit(bcmsdh_module_cleanup);
395
396 MODULE_LICENSE("GPL v2");
397 MODULE_DESCRIPTION(DESCRIPTION);
398 MODULE_AUTHOR(AUTHOR);
399
400 #endif /* BCMSDH_MODULE */
401 /*
402  * module init
403 */
404 int sdio_function_init(void)
405 {
406         int error = 0;
407         sd_trace(("bcmsdh_sdmmc: %s Enter\n", __FUNCTION__));
408
409         gInstance = kzalloc(sizeof(BCMSDH_SDMMC_INSTANCE), GFP_KERNEL);
410         if (!gInstance)
411                 return -ENOMEM;
412
413         error = sdio_register_driver(&bcmsdh_sdmmc_driver);
414
415         return error;
416 }
417
418 /*
419  * module cleanup
420 */
421 void sdio_function_cleanup(void)
422 {
423         sd_trace(("%s Enter\n", __FUNCTION__));
424
425
426         sdio_unregister_driver(&bcmsdh_sdmmc_driver);
427
428         if (gInstance)
429                 kfree(gInstance);
430 }