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/pm_runtime.h>
  35 #include <linux/printk.h>
  36 #include <linux/of.h>
  37 #include <linux/of_irq.h>
  38
  39 #include "wlcore.h"
  40 #include "wl12xx_80211.h"
  41 #include "io.h"
  42
  43 #ifndef SDIO_VENDOR_ID_TI
  44 #define SDIO_VENDOR_ID_TI               0x0097
  45 #endif
  46
  47 #ifndef SDIO_DEVICE_ID_TI_WL1271
  48 #define SDIO_DEVICE_ID_TI_WL1271        0x4076
  49 #endif
  50
  51 static bool dump = false;
  52
  53 struct wl12xx_sdio_glue {
  54         struct device *dev;
  55         struct platform_device *core;
  56 };
  57
  58 static const struct sdio_device_id wl1271_devices[] = {
  59         { SDIO_DEVICE(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271) },
  60         {}
  61 };
  62 MODULE_DEVICE_TABLE(sdio, wl1271_devices);
  63
  64 static void wl1271_sdio_set_block_size(struct device *child,
  65                                        unsigned int blksz)
  66 {
  67         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
  68         struct sdio_func *func = dev_to_sdio_func(glue->dev);
  69
  70         sdio_claim_host(func);
  71         sdio_set_block_size(func, blksz);
  72         sdio_release_host(func);
  73 }
  74
  75 static int __must_check wl12xx_sdio_raw_read(struct device *child, int addr,
  76                                              void *buf, size_t len, bool fixed)
  77 {
  78         int ret;
  79         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
  80         struct sdio_func *func = dev_to_sdio_func(glue->dev);
  81
  82         sdio_claim_host(func);
  83
  84         if (unlikely(addr == HW_ACCESS_ELP_CTRL_REG)) {
  85                 ((u8 *)buf)[0] = sdio_f0_readb(func, addr, &ret);
  86                 dev_dbg(child->parent, "sdio read 52 addr 0x%x, byte 0x%02x\n",
  87                         addr, ((u8 *)buf)[0]);
  88         } else {
  89                 if (fixed)
  90                         ret = sdio_readsb(func, buf, addr, len);
  91                 else
  92                         ret = sdio_memcpy_fromio(func, buf, addr, len);
  93
  94                 dev_dbg(child->parent, "sdio read 53 addr 0x%x, %zu bytes\n",
  95                         addr, len);
  96         }
  97
  98         sdio_release_host(func);
  99
 100         if (WARN_ON(ret))
 101                 dev_err(child->parent, "sdio read failed (%d)\n", ret);
 102
 103         if (unlikely(dump)) {
 104                 printk(KERN_DEBUG "wlcore_sdio: READ from 0x%04x\n", addr);
 105                 print_hex_dump(KERN_DEBUG, "wlcore_sdio: READ ",
 106                                DUMP_PREFIX_OFFSET, 16, 1,
 107                                buf, len, false);
 108         }
 109
 110         return ret;
 111 }
 112
 113 static int __must_check wl12xx_sdio_raw_write(struct device *child, int addr,
 114                                               void *buf, size_t len, bool fixed)
 115 {
 116         int ret;
 117         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
 118         struct sdio_func *func = dev_to_sdio_func(glue->dev);
 119
 120         sdio_claim_host(func);
 121
 122         if (unlikely(dump)) {
 123                 printk(KERN_DEBUG "wlcore_sdio: WRITE to 0x%04x\n", addr);
 124                 print_hex_dump(KERN_DEBUG, "wlcore_sdio: WRITE ",
 125                                 DUMP_PREFIX_OFFSET, 16, 1,
 126                                 buf, len, false);
 127         }
 128
 129         if (unlikely(addr == HW_ACCESS_ELP_CTRL_REG)) {
 130                 sdio_f0_writeb(func, ((u8 *)buf)[0], addr, &ret);
 131                 dev_dbg(child->parent, "sdio write 52 addr 0x%x, byte 0x%02x\n",
 132                         addr, ((u8 *)buf)[0]);
 133         } else {
 134                 dev_dbg(child->parent, "sdio write 53 addr 0x%x, %zu bytes\n",
 135                         addr, len);
 136
 137                 if (fixed)
 138                         ret = sdio_writesb(func, addr, buf, len);
 139                 else
 140                         ret = sdio_memcpy_toio(func, addr, buf, len);
 141         }
 142
 143         sdio_release_host(func);
 144
 145         if (WARN_ON(ret))
 146                 dev_err(child->parent, "sdio write failed (%d)\n", ret);
 147
 148         return ret;
 149 }
 150
 151 static int wl12xx_sdio_power_on(struct wl12xx_sdio_glue *glue)
 152 {
 153         int ret;
 154         struct sdio_func *func = dev_to_sdio_func(glue->dev);
 155         struct mmc_card *card = func->card;
 156
 157         ret = pm_runtime_get_sync(&card->dev);
 158         if (ret < 0) {
 159                 pm_runtime_put_noidle(&card->dev);
 160                 dev_err(glue->dev, "%s: failed to get_sync(%d)\n",
 161                         __func__, ret);
 162
 163                 return ret;
 164         }
 165
 166         sdio_claim_host(func);
 167         /*
 168          * To guarantee that the SDIO card is power cycled, as required to make
 169          * the FW programming to succeed, let's do a brute force HW reset.
 170          */
 171         mmc_hw_reset(card->host);
 172
 173         sdio_enable_func(func);
 174         sdio_release_host(func);
 175
 176         return 0;
 177 }
 178
 179 static int wl12xx_sdio_power_off(struct wl12xx_sdio_glue *glue)
 180 {
 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         /* Let runtime PM know the card is powered off */
 189         pm_runtime_put(&card->dev);
 190         return 0;
 191 }
 192
 193 static int wl12xx_sdio_set_power(struct device *child, bool enable)
 194 {
 195         struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
 196
 197         if (enable)
 198                 return wl12xx_sdio_power_on(glue);
 199         else
 200                 return wl12xx_sdio_power_off(glue);
 201 }
 202
 203 static struct wl1271_if_operations sdio_ops = {
 204         .read           = wl12xx_sdio_raw_read,
 205         .write          = wl12xx_sdio_raw_write,
 206         .power          = wl12xx_sdio_set_power,
 207         .set_block_size = wl1271_sdio_set_block_size,
 208 };
 209
 210 #ifdef CONFIG_OF
 211
 212 static const struct wilink_family_data wl127x_data = {
 213         .name = "wl127x",
 214         .nvs_name = "/*(DEBLOBBED)*/",
 215 };
 216
 217 static const struct wilink_family_data wl128x_data = {
 218         .name = "wl128x",
 219         .nvs_name = "/*(DEBLOBBED)*/",
 220 };
 221
 222 static const struct wilink_family_data wl18xx_data = {
 223         .name = "wl18xx",
 224         .cfg_name = "/*(DEBLOBBED)*/",
 225         .nvs_name = "/*(DEBLOBBED)*/",
 226 };
 227
 228 static const struct of_device_id wlcore_sdio_of_match_table[] = {
 229         { .compatible = "ti,wl1271", .data = &wl127x_data },
 230         { .compatible = "ti,wl1273", .data = &wl127x_data },
 231         { .compatible = "ti,wl1281", .data = &wl128x_data },
 232         { .compatible = "ti,wl1283", .data = &wl128x_data },
 233         { .compatible = "ti,wl1285", .data = &wl128x_data },
 234         { .compatible = "ti,wl1801", .data = &wl18xx_data },
 235         { .compatible = "ti,wl1805", .data = &wl18xx_data },
 236         { .compatible = "ti,wl1807", .data = &wl18xx_data },
 237         { .compatible = "ti,wl1831", .data = &wl18xx_data },
 238         { .compatible = "ti,wl1835", .data = &wl18xx_data },
 239         { .compatible = "ti,wl1837", .data = &wl18xx_data },
 240         { }
 241 };
 242
 243 static int wlcore_probe_of(struct device *dev, int *irq,
 244                            struct wlcore_platdev_data *pdev_data)
 245 {
 246         struct device_node *np = dev->of_node;
 247         const struct of_device_id *of_id;
 248
 249         of_id = of_match_node(wlcore_sdio_of_match_table, np);
 250         if (!of_id)
 251                 return -ENODEV;
 252
 253         pdev_data->family = of_id->data;
 254
 255         *irq = irq_of_parse_and_map(np, 0);
 256         if (!*irq) {
 257                 dev_err(dev, "No irq in platform data\n");
 258                 return -EINVAL;
 259         }
 260
 261         /* optional clock frequency params */
 262         of_property_read_u32(np, "ref-clock-frequency",
 263                              &pdev_data->ref_clock_freq);
 264         of_property_read_u32(np, "tcxo-clock-frequency",
 265                              &pdev_data->tcxo_clock_freq);
 266
 267         return 0;
 268 }
 269 #else
 270 static int wlcore_probe_of(struct device *dev, int *irq,
 271                            struct wlcore_platdev_data *pdev_data)
 272 {
 273         return -ENODATA;
 274 }
 275 #endif
 276
 277 static int wl1271_probe(struct sdio_func *func,
 278                                   const struct sdio_device_id *id)
 279 {
 280         struct wlcore_platdev_data *pdev_data;
 281         struct wl12xx_sdio_glue *glue;
 282         struct resource res[1];
 283         mmc_pm_flag_t mmcflags;
 284         int ret = -ENOMEM;
 285         int irq;
 286         const char *chip_family;
 287
 288         /* We are only able to handle the wlan function */
 289         if (func->num != 0x02)
 290                 return -ENODEV;
 291
 292         pdev_data = devm_kzalloc(&func->dev, sizeof(*pdev_data), GFP_KERNEL);
 293         if (!pdev_data)
 294                 return -ENOMEM;
 295
 296         pdev_data->if_ops = &sdio_ops;
 297
 298         glue = devm_kzalloc(&func->dev, sizeof(*glue), GFP_KERNEL);
 299         if (!glue)
 300                 return -ENOMEM;
 301
 302         glue->dev = &func->dev;
 303
 304         /* Grab access to FN0 for ELP reg. */
 305         func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
 306
 307         /* Use block mode for transferring over one block size of data */
 308         func->card->quirks |= MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
 309
 310         ret = wlcore_probe_of(&func->dev, &irq, pdev_data);
 311         if (ret)
 312                 goto out;
 313
 314         /* if sdio can keep power while host is suspended, enable wow */
 315         mmcflags = sdio_get_host_pm_caps(func);
 316         dev_dbg(glue->dev, "sdio PM caps = 0x%x\n", mmcflags);
 317
 318         if (mmcflags & MMC_PM_KEEP_POWER)
 319                 pdev_data->pwr_in_suspend = true;
 320
 321         sdio_set_drvdata(func, glue);
 322
 323         /* Tell PM core that we don't need the card to be powered now */
 324         pm_runtime_put_noidle(&func->dev);
 325
 326         /*
 327          * Due to a hardware bug, we can't differentiate wl18xx from
 328          * wl12xx, because both report the same device ID.  The only
 329          * way to differentiate is by checking the SDIO revision,
 330          * which is 3.00 on the wl18xx chips.
 331          */
 332         if (func->card->cccr.sdio_vsn == SDIO_SDIO_REV_3_00)
 333                 chip_family = "wl18xx";
 334         else
 335                 chip_family = "wl12xx";
 336
 337         glue->core = platform_device_alloc(chip_family, PLATFORM_DEVID_AUTO);
 338         if (!glue->core) {
 339                 dev_err(glue->dev, "can't allocate platform_device");
 340                 ret = -ENOMEM;
 341                 goto out;
 342         }
 343
 344         glue->core->dev.parent = &func->dev;
 345
 346         memset(res, 0x00, sizeof(res));
 347
 348         res[0].start = irq;
 349         res[0].flags = IORESOURCE_IRQ |
 350                        irqd_get_trigger_type(irq_get_irq_data(irq));
 351         res[0].name = "irq";
 352
 353         ret = platform_device_add_resources(glue->core, res, ARRAY_SIZE(res));
 354         if (ret) {
 355                 dev_err(glue->dev, "can't add resources\n");
 356                 goto out_dev_put;
 357         }
 358
 359         ret = platform_device_add_data(glue->core, pdev_data,
 360                                        sizeof(*pdev_data));
 361         if (ret) {
 362                 dev_err(glue->dev, "can't add platform data\n");
 363                 goto out_dev_put;
 364         }
 365
 366         ret = platform_device_add(glue->core);
 367         if (ret) {
 368                 dev_err(glue->dev, "can't add platform device\n");
 369                 goto out_dev_put;
 370         }
 371         return 0;
 372
 373 out_dev_put:
 374         platform_device_put(glue->core);
 375
 376 out:
 377         return ret;
 378 }
 379
 380 static void wl1271_remove(struct sdio_func *func)
 381 {
 382         struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
 383
 384         /* Undo decrement done above in wl1271_probe */
 385         pm_runtime_get_noresume(&func->dev);
 386
 387         platform_device_unregister(glue->core);
 388 }
 389
 390 #ifdef CONFIG_PM
 391 static int wl1271_suspend(struct device *dev)
 392 {
 393         /* Tell MMC/SDIO core it's OK to power down the card
 394          * (if it isn't already), but not to remove it completely */
 395         struct sdio_func *func = dev_to_sdio_func(dev);
 396         struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
 397         struct wl1271 *wl = platform_get_drvdata(glue->core);
 398         mmc_pm_flag_t sdio_flags;
 399         int ret = 0;
 400
 401         if (!wl) {
 402                 dev_err(dev, "no wilink module was probed\n");
 403                 goto out;
 404         }
 405
 406         dev_dbg(dev, "wl1271 suspend. wow_enabled: %d\n",
 407                 wl->wow_enabled);
 408
 409         /* check whether sdio should keep power */
 410         if (wl->wow_enabled) {
 411                 sdio_flags = sdio_get_host_pm_caps(func);
 412
 413                 if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
 414                         dev_err(dev, "can't keep power while host "
 415                                      "is suspended\n");
 416                         ret = -EINVAL;
 417                         goto out;
 418                 }
 419
 420                 /* keep power while host suspended */
 421                 ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
 422                 if (ret) {
 423                         dev_err(dev, "error while trying to keep power\n");
 424                         goto out;
 425                 }
 426         }
 427 out:
 428         return ret;
 429 }
 430
 431 static int wl1271_resume(struct device *dev)
 432 {
 433         dev_dbg(dev, "wl1271 resume\n");
 434
 435         return 0;
 436 }
 437
 438 static const struct dev_pm_ops wl1271_sdio_pm_ops = {
 439         .suspend        = wl1271_suspend,
 440         .resume         = wl1271_resume,
 441 };
 442 #endif
 443
 444 static struct sdio_driver wl1271_sdio_driver = {
 445         .name           = "wl1271_sdio",
 446         .id_table       = wl1271_devices,
 447         .probe          = wl1271_probe,
 448         .remove         = wl1271_remove,
 449 #ifdef CONFIG_PM
 450         .drv = {
 451                 .pm = &wl1271_sdio_pm_ops,
 452         },
 453 #endif
 454 };
 455
 456 static int __init wl1271_init(void)
 457 {
 458         return sdio_register_driver(&wl1271_sdio_driver);
 459 }
 460
 461 static void __exit wl1271_exit(void)
 462 {
 463         sdio_unregister_driver(&wl1271_sdio_driver);
 464 }
 465
 466 module_init(wl1271_init);
 467 module_exit(wl1271_exit);
 468
 469 module_param(dump, bool, 0600);
 470 MODULE_PARM_DESC(dump, "Enable sdio read/write dumps.");
 471
 472 MODULE_LICENSE("GPL");
 473 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
 474 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");