drivers/net/wireless/ti/wlcore/sdio.c

   1 /*
   2  * This file is part of wl1271
   3  *
   4  * Copyright (C) 2009-2010 Nokia Corporation
   5  *
   6  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * version 2 as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  20  * 02110-1301 USA
  21  *
  22  */
  23
  24 #include <linux/irq.h>
  25 #include <linux/module.h>
  26 #include <linux/vmalloc.h>
  27 #include <linux/platform_device.h>
  28 #include <linux/mmc/sdio.h>
  29 #include <linux/mmc/sdio_func.h>
  30 #include <linux/mmc/sdio_ids.h>
  31 #include <linux/mmc/card.h>
  32 #include <linux/mmc/host.h>
  33 #include <linux/gpio.h>
  34 #include <linux/wl12xx.h>
  35 #include <linux/pm_runtime.h>
  36 #include <linux/printk.h>
  37
  38 #include "wlcore.h"
  39 #include "wl12xx_80211.h"
  40 #include "io.h"
  41
  42 #ifndef SDIO_VENDOR_ID_TI
  43 #define SDIO_VENDOR_ID_TI               0x0097
  44 #endif
  45
  46 #ifndef SDIO_DEVICE_ID_TI_WL1271
  47 #define SDIO_DEVICE_ID_TI_WL1271        0x4076
  48 #endif
  49
  50 static bool dump = false;
  51
  52 struct wl12xx_sdio_glue {
  53         struct device *dev;
  54         struct platform_device *core;
  55 };
  56
  57 static const struct sdio_device_id wl1271_devices[] __devinitconst = {
  58         { SDIO_DEVICE(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271) },
  59         {}
  60 };
  61 MODULE_DEVICE_TABLE(sdio, wl1271_devices);
  62
  63 static void wl1271_sdio_set_block_size(struct device *child,
  64                                        unsigned int blksz)
  65 {
  66         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
  67         struct sdio_func *func = dev_to_sdio_func(glue->dev);
  68
  69         sdio_claim_host(func);
  70         sdio_set_block_size(func, blksz);
  71         sdio_release_host(func);
  72 }
  73
  74 static void wl12xx_sdio_raw_read(struct device *child, int addr, void *buf,
  75                                  size_t len, bool fixed)
  76 {
  77         int ret;
  78         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
  79         struct sdio_func *func = dev_to_sdio_func(glue->dev);
  80
  81         sdio_claim_host(func);
  82
  83         if (unlikely(dump)) {
  84                 printk(KERN_DEBUG "wlcore_sdio: READ from 0x%04x\n", addr);
  85                 print_hex_dump(KERN_DEBUG, "wlcore_sdio: READ ",
  86                                 DUMP_PREFIX_OFFSET, 16, 1,
  87                                 buf, len, false);
  88         }
  89
  90         if (unlikely(addr == HW_ACCESS_ELP_CTRL_REG)) {
  91                 ((u8 *)buf)[0] = sdio_f0_readb(func, addr, &ret);
  92                 dev_dbg(child->parent, "sdio read 52 addr 0x%x, byte 0x%02x\n",
  93                         addr, ((u8 *)buf)[0]);
  94         } else {
  95                 if (fixed)
  96                         ret = sdio_readsb(func, buf, addr, len);
  97                 else
  98                         ret = sdio_memcpy_fromio(func, buf, addr, len);
  99
 100                 dev_dbg(child->parent, "sdio read 53 addr 0x%x, %zu bytes\n",
 101                         addr, len);
 102         }
 103
 104         sdio_release_host(func);
 105
 106         if (ret)
 107                 dev_err(child->parent, "sdio read failed (%d)\n", ret);
 108 }
 109
 110 static void wl12xx_sdio_raw_write(struct device *child, int addr, void *buf,
 111                                   size_t len, bool fixed)
 112 {
 113         int ret;
 114         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
 115         struct sdio_func *func = dev_to_sdio_func(glue->dev);
 116
 117         sdio_claim_host(func);
 118
 119         if (unlikely(dump)) {
 120                 printk(KERN_DEBUG "wlcore_sdio: WRITE to 0x%04x\n", addr);
 121                 print_hex_dump(KERN_DEBUG, "wlcore_sdio: WRITE ",
 122                                 DUMP_PREFIX_OFFSET, 16, 1,
 123                                 buf, len, false);
 124         }
 125
 126         if (unlikely(addr == HW_ACCESS_ELP_CTRL_REG)) {
 127                 sdio_f0_writeb(func, ((u8 *)buf)[0], addr, &ret);
 128                 dev_dbg(child->parent, "sdio write 52 addr 0x%x, byte 0x%02x\n",
 129                         addr, ((u8 *)buf)[0]);
 130         } else {
 131                 dev_dbg(child->parent, "sdio write 53 addr 0x%x, %zu bytes\n",
 132                         addr, len);
 133
 134                 if (fixed)
 135                         ret = sdio_writesb(func, addr, buf, len);
 136                 else
 137                         ret = sdio_memcpy_toio(func, addr, buf, len);
 138         }
 139
 140         sdio_release_host(func);
 141
 142         if (ret)
 143                 dev_err(child->parent, "sdio write failed (%d)\n", ret);
 144 }
 145
 146 static int wl12xx_sdio_power_on(struct wl12xx_sdio_glue *glue)
 147 {
 148         int ret;
 149         struct sdio_func *func = dev_to_sdio_func(glue->dev);
 150
 151         /* If enabled, tell runtime PM not to power off the card */
 152         if (pm_runtime_enabled(&func->dev)) {
 153                 ret = pm_runtime_get_sync(&func->dev);
 154                 if (ret < 0)
 155                         goto out;
 156         } else {
 157                 /* Runtime PM is disabled: power up the card manually */
 158                 ret = mmc_power_restore_host(func->card->host);
 159                 if (ret < 0)
 160                         goto out;
 161         }
 162
 163         sdio_claim_host(func);
 164         sdio_enable_func(func);
 165         sdio_release_host(func);
 166
 167 out:
 168         return ret;
 169 }
 170
 171 static int wl12xx_sdio_power_off(struct wl12xx_sdio_glue *glue)
 172 {
 173         int ret;
 174         struct sdio_func *func = dev_to_sdio_func(glue->dev);
 175
 176         sdio_claim_host(func);
 177         sdio_disable_func(func);
 178         sdio_release_host(func);
 179
 180         /* Power off the card manually, even if runtime PM is enabled. */
 181         ret = mmc_power_save_host(func->card->host);
 182         if (ret < 0)
 183                 return ret;
 184
 185         /* If enabled, let runtime PM know the card is powered off */
 186         if (pm_runtime_enabled(&func->dev))
 187                 ret = pm_runtime_put_sync(&func->dev);
 188
 189         return ret;
 190 }
 191
 192 static int wl12xx_sdio_set_power(struct device *child, bool enable)
 193 {
 194         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
 195
 196         if (enable)
 197                 return wl12xx_sdio_power_on(glue);
 198         else
 199                 return wl12xx_sdio_power_off(glue);
 200 }
 201
 202 static struct wl1271_if_operations sdio_ops = {
 203         .read           = wl12xx_sdio_raw_read,
 204         .write          = wl12xx_sdio_raw_write,
 205         .power          = wl12xx_sdio_set_power,
 206         .set_block_size = wl1271_sdio_set_block_size,
 207 };
 208
 209 static int __devinit wl1271_probe(struct sdio_func *func,
 210                                   const struct sdio_device_id *id)
 211 {
 212         struct wl12xx_platform_data *wlan_data;
 213         struct wl12xx_sdio_glue *glue;
 214         struct resource res[1];
 215         mmc_pm_flag_t mmcflags;
 216         int ret = -ENOMEM;
 217         const char *chip_family;
 218
 219         /* We are only able to handle the wlan function */
 220         if (func->num != 0x02)
 221                 return -ENODEV;
 222
 223         glue = kzalloc(sizeof(*glue), GFP_KERNEL);
 224         if (!glue) {
 225                 dev_err(&func->dev, "can't allocate glue\n");
 226                 goto out;
 227         }
 228
 229         glue->dev = &func->dev;
 230
 231         /* Grab access to FN0 for ELP reg. */
 232         func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
 233
 234         /* Use block mode for transferring over one block size of data */
 235         func->card->quirks |= MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
 236
 237         wlan_data = wl12xx_get_platform_data();
 238         if (IS_ERR(wlan_data)) {
 239                 ret = PTR_ERR(wlan_data);
 240                 dev_err(glue->dev, "missing wlan platform data: %d\n", ret);
 241                 goto out_free_glue;
 242         }
 243
 244         /* if sdio can keep power while host is suspended, enable wow */
 245         mmcflags = sdio_get_host_pm_caps(func);
 246         dev_dbg(glue->dev, "sdio PM caps = 0x%x\n", mmcflags);
 247
 248         if (mmcflags & MMC_PM_KEEP_POWER)
 249                 wlan_data->pwr_in_suspend = true;
 250
 251         wlan_data->ops = &sdio_ops;
 252
 253         sdio_set_drvdata(func, glue);
 254
 255         /* Tell PM core that we don't need the card to be powered now */
 256         pm_runtime_put_noidle(&func->dev);
 257
 258         /*
 259          * Due to a hardware bug, we can't differentiate wl18xx from
 260          * wl12xx, because both report the same device ID.  The only
 261          * way to differentiate is by checking the SDIO revision,
 262          * which is 3.00 on the wl18xx chips.
 263          */
 264         if (func->card->cccr.sdio_vsn == SDIO_SDIO_REV_3_00)
 265                 chip_family = "wl18xx";
 266         else
 267                 chip_family = "wl12xx";
 268
 269         glue->core = platform_device_alloc(chip_family, -1);
 270         if (!glue->core) {
 271                 dev_err(glue->dev, "can't allocate platform_device");
 272                 ret = -ENOMEM;
 273                 goto out_free_glue;
 274         }
 275
 276         glue->core->dev.parent = &func->dev;
 277
 278         memset(res, 0x00, sizeof(res));
 279
 280         res[0].start = wlan_data->irq;
 281         res[0].flags = IORESOURCE_IRQ;
 282         res[0].name = "irq";
 283
 284         ret = platform_device_add_resources(glue->core, res, ARRAY_SIZE(res));
 285         if (ret) {
 286                 dev_err(glue->dev, "can't add resources\n");
 287                 goto out_dev_put;
 288         }
 289
 290         ret = platform_device_add_data(glue->core, wlan_data,
 291                                        sizeof(*wlan_data));
 292         if (ret) {
 293                 dev_err(glue->dev, "can't add platform data\n");
 294                 goto out_dev_put;
 295         }
 296
 297         ret = platform_device_add(glue->core);
 298         if (ret) {
 299                 dev_err(glue->dev, "can't add platform device\n");
 300                 goto out_dev_put;
 301         }
 302         return 0;
 303
 304 out_dev_put:
 305         platform_device_put(glue->core);
 306
 307 out_free_glue:
 308         kfree(glue);
 309
 310 out:
 311         return ret;
 312 }
 313
 314 static void __devexit wl1271_remove(struct sdio_func *func)
 315 {
 316         struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
 317
 318         /* Undo decrement done above in wl1271_probe */
 319         pm_runtime_get_noresume(&func->dev);
 320
 321         platform_device_del(glue->core);
 322         platform_device_put(glue->core);
 323         kfree(glue);
 324 }
 325
 326 #ifdef CONFIG_PM
 327 static int wl1271_suspend(struct device *dev)
 328 {
 329         /* Tell MMC/SDIO core it's OK to power down the card
 330          * (if it isn't already), but not to remove it completely */
 331         struct sdio_func *func = dev_to_sdio_func(dev);
 332         struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
 333         struct wl1271 *wl = platform_get_drvdata(glue->core);
 334         mmc_pm_flag_t sdio_flags;
 335         int ret = 0;
 336
 337         dev_dbg(dev, "wl1271 suspend. wow_enabled: %d\n",
 338                 wl->wow_enabled);
 339
 340         /* check whether sdio should keep power */
 341         if (wl->wow_enabled) {
 342                 sdio_flags = sdio_get_host_pm_caps(func);
 343
 344                 if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
 345                         dev_err(dev, "can't keep power while host "
 346                                      "is suspended\n");
 347                         ret = -EINVAL;
 348                         goto out;
 349                 }
 350
 351                 /* keep power while host suspended */
 352                 ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
 353                 if (ret) {
 354                         dev_err(dev, "error while trying to keep power\n");
 355                         goto out;
 356                 }
 357         }
 358 out:
 359         return ret;
 360 }
 361
 362 static int wl1271_resume(struct device *dev)
 363 {
 364         dev_dbg(dev, "wl1271 resume\n");
 365
 366         return 0;
 367 }
 368
 369 static const struct dev_pm_ops wl1271_sdio_pm_ops = {
 370         .suspend        = wl1271_suspend,
 371         .resume         = wl1271_resume,
 372 };
 373 #endif
 374
 375 static struct sdio_driver wl1271_sdio_driver = {
 376         .name           = "wl1271_sdio",
 377         .id_table       = wl1271_devices,
 378         .probe          = wl1271_probe,
 379         .remove         = __devexit_p(wl1271_remove),
 380 #ifdef CONFIG_PM
 381         .drv = {
 382                 .pm = &wl1271_sdio_pm_ops,
 383         },
 384 #endif
 385 };
 386
 387 static int __init wl1271_init(void)
 388 {
 389         return sdio_register_driver(&wl1271_sdio_driver);
 390 }
 391
 392 static void __exit wl1271_exit(void)
 393 {
 394         sdio_unregister_driver(&wl1271_sdio_driver);
 395 }
 396
 397 module_init(wl1271_init);
 398 module_exit(wl1271_exit);
 399
 400 module_param(dump, bool, S_IRUSR | S_IWUSR);
 401 MODULE_PARM_DESC(dump, "Enable sdio read/write dumps.");
 402
 403 MODULE_LICENSE("GPL");
 404 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
 405 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
 406 MODULE_FIRMWARE(WL127X_FW_NAME_SINGLE);
 407 MODULE_FIRMWARE(WL127X_FW_NAME_MULTI);
 408 MODULE_FIRMWARE(WL127X_PLT_FW_NAME);
 409 MODULE_FIRMWARE(WL128X_FW_NAME_SINGLE);
 410 MODULE_FIRMWARE(WL128X_FW_NAME_MULTI);
 411 MODULE_FIRMWARE(WL128X_PLT_FW_NAME);