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[] = {
  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 int __must_check wl12xx_sdio_raw_read(struct device *child, int addr,
  75                                              void *buf, 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 (WARN_ON(ret))
 107                 dev_err(child->parent, "sdio read failed (%d)\n", ret);
 108
 109         return ret;
 110 }
 111
 112 static int __must_check wl12xx_sdio_raw_write(struct device *child, int addr,
 113                                               void *buf, size_t len, bool fixed)
 114 {
 115         int ret;
 116         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
 117         struct sdio_func *func = dev_to_sdio_func(glue->dev);
 118
 119         sdio_claim_host(func);
 120
 121         if (unlikely(dump)) {
 122                 printk(KERN_DEBUG "wlcore_sdio: WRITE to 0x%04x\n", addr);
 123                 print_hex_dump(KERN_DEBUG, "wlcore_sdio: WRITE ",
 124                                 DUMP_PREFIX_OFFSET, 16, 1,
 125                                 buf, len, false);
 126         }
 127
 128         if (unlikely(addr == HW_ACCESS_ELP_CTRL_REG)) {
 129                 sdio_f0_writeb(func, ((u8 *)buf)[0], addr, &ret);
 130                 dev_dbg(child->parent, "sdio write 52 addr 0x%x, byte 0x%02x\n",
 131                         addr, ((u8 *)buf)[0]);
 132         } else {
 133                 dev_dbg(child->parent, "sdio write 53 addr 0x%x, %zu bytes\n",
 134                         addr, len);
 135
 136                 if (fixed)
 137                         ret = sdio_writesb(func, addr, buf, len);
 138                 else
 139                         ret = sdio_memcpy_toio(func, addr, buf, len);
 140         }
 141
 142         sdio_release_host(func);
 143
 144         if (WARN_ON(ret))
 145                 dev_err(child->parent, "sdio write failed (%d)\n", ret);
 146
 147         return ret;
 148 }
 149
 150 static int wl12xx_sdio_power_on(struct wl12xx_sdio_glue *glue)
 151 {
 152         int ret;
 153         struct sdio_func *func = dev_to_sdio_func(glue->dev);
 154         struct mmc_card *card = func->card;
 155
 156         ret = pm_runtime_get_sync(&card->dev);
 157         if (ret) {
 158                 /*
 159                  * Runtime PM might be temporarily disabled, or the device
 160                  * might have a positive reference counter. Make sure it is
 161                  * really powered on.
 162                  */
 163                 ret = mmc_power_restore_host(card->host);
 164                 if (ret < 0) {
 165                         pm_runtime_put_sync(&card->dev);
 166                         goto out;
 167                 }
 168         }
 169
 170         sdio_claim_host(func);
 171         sdio_enable_func(func);
 172         sdio_release_host(func);
 173
 174 out:
 175         return ret;
 176 }
 177
 178 static int wl12xx_sdio_power_off(struct wl12xx_sdio_glue *glue)
 179 {
 180         int ret;
 181         struct sdio_func *func = dev_to_sdio_func(glue->dev);
 182         struct mmc_card *card = func->card;
 183
 184         sdio_claim_host(func);
 185         sdio_disable_func(func);
 186         sdio_release_host(func);
 187
 188         /* Power off the card manually in case it wasn't powered off above */
 189         ret = mmc_power_save_host(card->host);
 190         if (ret < 0)
 191                 goto out;
 192
 193         /* Let runtime PM know the card is powered off */
 194         pm_runtime_put_sync(&card->dev);
 195
 196 out:
 197         return ret;
 198 }
 199
 200 static int wl12xx_sdio_set_power(struct device *child, bool enable)
 201 {
 202         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
 203
 204         if (enable)
 205                 return wl12xx_sdio_power_on(glue);
 206         else
 207                 return wl12xx_sdio_power_off(glue);
 208 }
 209
 210 static struct wl1271_if_operations sdio_ops = {
 211         .read           = wl12xx_sdio_raw_read,
 212         .write          = wl12xx_sdio_raw_write,
 213         .power          = wl12xx_sdio_set_power,
 214         .set_block_size = wl1271_sdio_set_block_size,
 215 };
 216
 217 static int wl1271_probe(struct sdio_func *func,
 218                                   const struct sdio_device_id *id)
 219 {
 220         struct wlcore_platdev_data *pdev_data;
 221         struct wl12xx_sdio_glue *glue;
 222         struct resource res[1];
 223         mmc_pm_flag_t mmcflags;
 224         int ret = -ENOMEM;
 225         const char *chip_family;
 226
 227         /* We are only able to handle the wlan function */
 228         if (func->num != 0x02)
 229                 return -ENODEV;
 230
 231         pdev_data = kzalloc(sizeof(*pdev_data), GFP_KERNEL);
 232         if (!pdev_data) {
 233                 dev_err(&func->dev, "can't allocate platdev_data\n");
 234                 goto out;
 235         }
 236
 237         pdev_data->if_ops = &sdio_ops;
 238
 239         glue = kzalloc(sizeof(*glue), GFP_KERNEL);
 240         if (!glue) {
 241                 dev_err(&func->dev, "can't allocate glue\n");
 242                 goto out_free_pdev_data;
 243         }
 244
 245         glue->dev = &func->dev;
 246
 247         /* Grab access to FN0 for ELP reg. */
 248         func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
 249
 250         /* Use block mode for transferring over one block size of data */
 251         func->card->quirks |= MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
 252
 253         pdev_data->pdata = wl12xx_get_platform_data();
 254         if (IS_ERR(pdev_data->pdata)) {
 255                 ret = PTR_ERR(pdev_data->pdata);
 256                 dev_err(glue->dev, "missing wlan platform data: %d\n", ret);
 257                 goto out_free_glue;
 258         }
 259
 260         /* if sdio can keep power while host is suspended, enable wow */
 261         mmcflags = sdio_get_host_pm_caps(func);
 262         dev_dbg(glue->dev, "sdio PM caps = 0x%x\n", mmcflags);
 263
 264         if (mmcflags & MMC_PM_KEEP_POWER)
 265                 pdev_data->pdata->pwr_in_suspend = true;
 266
 267         sdio_set_drvdata(func, glue);
 268
 269         /* Tell PM core that we don't need the card to be powered now */
 270         pm_runtime_put_noidle(&func->dev);
 271
 272         /*
 273          * Due to a hardware bug, we can't differentiate wl18xx from
 274          * wl12xx, because both report the same device ID.  The only
 275          * way to differentiate is by checking the SDIO revision,
 276          * which is 3.00 on the wl18xx chips.
 277          */
 278         if (func->card->cccr.sdio_vsn == SDIO_SDIO_REV_3_00)
 279                 chip_family = "wl18xx";
 280         else
 281                 chip_family = "wl12xx";
 282
 283         glue->core = platform_device_alloc(chip_family, -1);
 284         if (!glue->core) {
 285                 dev_err(glue->dev, "can't allocate platform_device");
 286                 ret = -ENOMEM;
 287                 goto out_free_glue;
 288         }
 289
 290         glue->core->dev.parent = &func->dev;
 291
 292         memset(res, 0x00, sizeof(res));
 293
 294         res[0].start = pdev_data->pdata->irq;
 295         res[0].flags = IORESOURCE_IRQ;
 296         res[0].name = "irq";
 297
 298         ret = platform_device_add_resources(glue->core, res, ARRAY_SIZE(res));
 299         if (ret) {
 300                 dev_err(glue->dev, "can't add resources\n");
 301                 goto out_dev_put;
 302         }
 303
 304         ret = platform_device_add_data(glue->core, pdev_data,
 305                                        sizeof(*pdev_data));
 306         if (ret) {
 307                 dev_err(glue->dev, "can't add platform data\n");
 308                 goto out_dev_put;
 309         }
 310
 311         ret = platform_device_add(glue->core);
 312         if (ret) {
 313                 dev_err(glue->dev, "can't add platform device\n");
 314                 goto out_dev_put;
 315         }
 316         return 0;
 317
 318 out_dev_put:
 319         platform_device_put(glue->core);
 320
 321 out_free_glue:
 322         kfree(glue);
 323
 324 out_free_pdev_data:
 325         kfree(pdev_data);
 326
 327 out:
 328         return ret;
 329 }
 330
 331 static void wl1271_remove(struct sdio_func *func)
 332 {
 333         struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
 334
 335         /* Undo decrement done above in wl1271_probe */
 336         pm_runtime_get_noresume(&func->dev);
 337
 338         platform_device_unregister(glue->core);
 339         kfree(glue);
 340 }
 341
 342 #ifdef CONFIG_PM
 343 static int wl1271_suspend(struct device *dev)
 344 {
 345         /* Tell MMC/SDIO core it's OK to power down the card
 346          * (if it isn't already), but not to remove it completely */
 347         struct sdio_func *func = dev_to_sdio_func(dev);
 348         struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
 349         struct wl1271 *wl = platform_get_drvdata(glue->core);
 350         mmc_pm_flag_t sdio_flags;
 351         int ret = 0;
 352
 353         dev_dbg(dev, "wl1271 suspend. wow_enabled: %d\n",
 354                 wl->wow_enabled);
 355
 356         /* check whether sdio should keep power */
 357         if (wl->wow_enabled) {
 358                 sdio_flags = sdio_get_host_pm_caps(func);
 359
 360                 if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
 361                         dev_err(dev, "can't keep power while host "
 362                                      "is suspended\n");
 363                         ret = -EINVAL;
 364                         goto out;
 365                 }
 366
 367                 /* keep power while host suspended */
 368                 ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
 369                 if (ret) {
 370                         dev_err(dev, "error while trying to keep power\n");
 371                         goto out;
 372                 }
 373         }
 374 out:
 375         return ret;
 376 }
 377
 378 static int wl1271_resume(struct device *dev)
 379 {
 380         dev_dbg(dev, "wl1271 resume\n");
 381
 382         return 0;
 383 }
 384
 385 static const struct dev_pm_ops wl1271_sdio_pm_ops = {
 386         .suspend        = wl1271_suspend,
 387         .resume         = wl1271_resume,
 388 };
 389 #endif
 390
 391 static struct sdio_driver wl1271_sdio_driver = {
 392         .name           = "wl1271_sdio",
 393         .id_table       = wl1271_devices,
 394         .probe          = wl1271_probe,
 395         .remove         = wl1271_remove,
 396 #ifdef CONFIG_PM
 397         .drv = {
 398                 .pm = &wl1271_sdio_pm_ops,
 399         },
 400 #endif
 401 };
 402
 403 static int __init wl1271_init(void)
 404 {
 405         return sdio_register_driver(&wl1271_sdio_driver);
 406 }
 407
 408 static void __exit wl1271_exit(void)
 409 {
 410         sdio_unregister_driver(&wl1271_sdio_driver);
 411 }
 412
 413 module_init(wl1271_init);
 414 module_exit(wl1271_exit);
 415
 416 module_param(dump, bool, S_IRUSR | S_IWUSR);
 417 MODULE_PARM_DESC(dump, "Enable sdio read/write dumps.");
 418
 419 MODULE_LICENSE("GPL");
 420 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
 421 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");