drivers/net/wimax/i2400m/sdio.c

   1 /*
   2  * Intel Wireless WiMAX Connection 2400m
   3  * Linux driver model glue for the SDIO device, reset & fw upload
   4  *
   5  *
   6  * Copyright (C) 2007-2008 Intel Corporation <linux-wimax@intel.com>
   7  * Dirk Brandewie <dirk.j.brandewie@intel.com>
   8  * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
   9  * Yanir Lubetkin <yanirx.lubetkin@intel.com>
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License version
  13  * 2 as published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23  * 02110-1301, USA.
  24  *
  25  *
  26  * See i2400m-sdio.h for a general description of this driver.
  27  *
  28  * This file implements driver model glue, and hook ups for the
  29  * generic driver to implement the bus-specific functions (device
  30  * communication setup/tear down, firmware upload and resetting).
  31  *
  32  * ROADMAP
  33  *
  34  * i2400m_probe()
  35  *   alloc_netdev()
  36  *     i2400ms_netdev_setup()
  37  *       i2400ms_init()
  38  *       i2400m_netdev_setup()
  39  *   i2400ms_enable_function()
  40  *   i2400m_setup()
  41  *
  42  * i2400m_remove()
  43  *     i2400m_release()
  44  *     free_netdev(net_dev)
  45  *
  46  * i2400ms_bus_reset()            Called by i2400m->bus_reset
  47  *   __i2400ms_reset()
  48  *     __i2400ms_send_barker()
  49  *
  50  * i2400ms_bus_dev_start()        Called by i2400m_dev_start() [who is
  51  *   i2400ms_tx_setup()           called by i2400m_setup()]
  52  *   i2400ms_rx_setup()
  53  *
  54  * i2400ms_bus_dev_stop()         Called by i2400m_dev_stop() [who is
  55  *   i2400ms_rx_release()         is called by i2400m_release()]
  56  *   i2400ms_tx_release()
  57  *
  58  */
  59
  60 #include <linux/debugfs.h>
  61 #include <linux/mmc/sdio_ids.h>
  62 #include <linux/mmc/sdio.h>
  63 #include <linux/mmc/sdio_func.h>
  64 #include "i2400m-sdio.h"
  65 #include <linux/wimax/i2400m.h>
  66
  67 #define D_SUBMODULE main
  68 #include "sdio-debug-levels.h"
  69
  70 /* IOE WiMAX function timeout in seconds */
  71 static int ioe_timeout = 2;
  72 module_param(ioe_timeout, int, 0);
  73
  74 /* Our firmware file name list */
  75 static const char *i2400ms_bus_fw_names[] = {
  76 #define I2400MS_FW_FILE_NAME "i2400m-fw-sdio-1.3.sbcf"
  77         I2400MS_FW_FILE_NAME,
  78         NULL
  79 };
  80
  81
  82 static const struct i2400m_poke_table i2400ms_pokes[] = {
  83         I2400M_FW_POKE(0x6BE260, 0x00000088),
  84         I2400M_FW_POKE(0x080550, 0x00000005),
  85         I2400M_FW_POKE(0xAE0000, 0x00000000),
  86         I2400M_FW_POKE(0x000000, 0x00000000), /* MUST be 0 terminated or bad
  87                                                * things will happen */
  88 };
  89
  90 /*
  91  * Enable the SDIO function
  92  *
  93  * Tries to enable the SDIO function; might fail if it is still not
  94  * ready (in some hardware, the SDIO WiMAX function is only enabled
  95  * when we ask it to explicitly doing). Tries until a timeout is
  96  * reached.
  97  *
  98  * The reverse of this is...sdio_disable_function()
  99  *
 100  * Returns: 0 if the SDIO function was enabled, < 0 errno code on
 101  *     error (-ENODEV when it was unable to enable the function).
 102  */
 103 static
 104 int i2400ms_enable_function(struct sdio_func *func)
 105 {
 106         u64 timeout;
 107         int err;
 108         struct device *dev = &func->dev;
 109
 110         d_fnstart(3, dev, "(func %p)\n", func);
 111         /* Setup timeout (FIXME: This needs to read the CIS table to
 112          * get a real timeout) and then wait for the device to signal
 113          * it is ready */
 114         timeout = get_jiffies_64() + ioe_timeout * HZ;
 115         err = -ENODEV;
 116         while (err != 0 && time_before64(get_jiffies_64(), timeout)) {
 117                 sdio_claim_host(func);
 118                 err = sdio_enable_func(func);
 119                 if (0 == err) {
 120                         sdio_release_host(func);
 121                         d_printf(2, dev, "SDIO function enabled\n");
 122                         goto function_enabled;
 123                 }
 124                 d_printf(2, dev, "SDIO function failed to enable: %d\n", err);
 125                 sdio_disable_func(func);
 126                 sdio_release_host(func);
 127                 msleep(I2400MS_INIT_SLEEP_INTERVAL);
 128         }
 129         /* If timed out, device is not there yet -- get -ENODEV so
 130          * the device driver core will retry later on. */
 131         if (err == -ETIME) {
 132                 dev_err(dev, "Can't enable WiMAX function; "
 133                         " has the function been enabled?\n");
 134                 err = -ENODEV;
 135         }
 136 function_enabled:
 137         d_fnend(3, dev, "(func %p) = %d\n", func, err);
 138         return err;
 139 }
 140
 141
 142 /*
 143  * Setup driver resources needed to communicate with the device
 144  *
 145  * The fw needs some time to settle, and it was just uploaded,
 146  * so give it a break first. I'd prefer to just wait for the device to
 147  * send something, but seems the poking we do to enable SDIO stuff
 148  * interferes with it, so just give it a break before starting...
 149  */
 150 static
 151 int i2400ms_bus_dev_start(struct i2400m *i2400m)
 152 {
 153         int result;
 154         struct i2400ms *i2400ms = container_of(i2400m, struct i2400ms, i2400m);
 155         struct sdio_func *func = i2400ms->func;
 156         struct device *dev = &func->dev;
 157
 158         d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
 159         msleep(200);
 160         result = i2400ms_tx_setup(i2400ms);
 161         if (result < 0)
 162                 goto error_tx_setup;
 163         d_fnend(3, dev, "(i2400m %p) = %d\n", i2400m, result);
 164         return result;
 165
 166 error_tx_setup:
 167         i2400ms_tx_release(i2400ms);
 168         d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
 169         return result;
 170 }
 171
 172
 173 static
 174 void i2400ms_bus_dev_stop(struct i2400m *i2400m)
 175 {
 176         struct i2400ms *i2400ms = container_of(i2400m, struct i2400ms, i2400m);
 177         struct sdio_func *func = i2400ms->func;
 178         struct device *dev = &func->dev;
 179
 180         d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
 181         i2400ms_tx_release(i2400ms);
 182         d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
 183 }
 184
 185
 186 /*
 187  * Sends a barker buffer to the device
 188  *
 189  * This helper will allocate a kmalloced buffer and use it to transmit
 190  * (then free it). Reason for this is that the SDIO host controller
 191  * expects alignment (unknown exactly which) which the stack won't
 192  * really provide and certain arches/host-controller combinations
 193  * cannot use stack/vmalloc/text areas for DMA transfers.
 194  */
 195 static
 196 int __i2400ms_send_barker(struct i2400ms *i2400ms,
 197                           const __le32 *barker, size_t barker_size)
 198 {
 199         int  ret;
 200         struct sdio_func *func = i2400ms->func;
 201         struct device *dev = &func->dev;
 202         void *buffer;
 203
 204         ret = -ENOMEM;
 205         buffer = kmalloc(I2400MS_BLK_SIZE, GFP_KERNEL);
 206         if (buffer == NULL)
 207                 goto error_kzalloc;
 208
 209         memcpy(buffer, barker, barker_size);
 210         sdio_claim_host(func);
 211         ret = sdio_memcpy_toio(func, 0, buffer, I2400MS_BLK_SIZE);
 212         sdio_release_host(func);
 213
 214         if (ret < 0)
 215                 d_printf(0, dev, "E: barker error: %d\n", ret);
 216
 217         kfree(buffer);
 218 error_kzalloc:
 219         return ret;
 220 }
 221
 222
 223 /*
 224  * Reset a device at different levels (warm, cold or bus)
 225  *
 226  * @i2400ms: device descriptor
 227  * @reset_type: soft, warm or bus reset (I2400M_RT_WARM/SOFT/BUS)
 228  *
 229  * FIXME: not tested -- need to confirm expected effects
 230  *
 231  * Warm and cold resets get an SDIO reset if they fail (unimplemented)
 232  *
 233  * Warm reset:
 234  *
 235  * The device will be fully reset internally, but won't be
 236  * disconnected from the bus (so no reenumeration will
 237  * happen). Firmware upload will be neccessary.
 238  *
 239  * The device will send a reboot barker that will trigger the driver
 240  * to reinitialize the state via __i2400m_dev_reset_handle.
 241  *
 242  *
 243  * Cold and bus reset:
 244  *
 245  * The device will be fully reset internally, disconnected from the
 246  * bus an a reenumeration will happen. Firmware upload will be
 247  * neccessary. Thus, we don't do any locking or struct
 248  * reinitialization, as we are going to be fully disconnected and
 249  * reenumerated.
 250  *
 251  * Note we need to return -ENODEV if a warm reset was requested and we
 252  * had to resort to a bus reset. See i2400m_op_reset(), wimax_reset()
 253  * and wimax_dev->op_reset.
 254  *
 255  * WARNING: no driver state saved/fixed
 256  */
 257 static
 258 int i2400ms_bus_reset(struct i2400m *i2400m, enum i2400m_reset_type rt)
 259 {
 260         int result = 0;
 261         struct i2400ms *i2400ms =
 262                 container_of(i2400m, struct i2400ms, i2400m);
 263         struct device *dev = i2400m_dev(i2400m);
 264         static const __le32 i2400m_WARM_BOOT_BARKER[4] = {
 265                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
 266                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
 267                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
 268                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
 269         };
 270         static const __le32 i2400m_COLD_BOOT_BARKER[4] = {
 271                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
 272                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
 273                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
 274                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
 275         };
 276
 277         if (rt == I2400M_RT_WARM)
 278                 result = __i2400ms_send_barker(i2400ms, i2400m_WARM_BOOT_BARKER,
 279                                                sizeof(i2400m_WARM_BOOT_BARKER));
 280         else if (rt == I2400M_RT_COLD)
 281                 result = __i2400ms_send_barker(i2400ms, i2400m_COLD_BOOT_BARKER,
 282                                                sizeof(i2400m_COLD_BOOT_BARKER));
 283         else if (rt == I2400M_RT_BUS) {
 284 do_bus_reset:
 285                 /* call netif_tx_disable() before sending IOE disable,
 286                  * so that all the tx from network layer are stopped
 287                  * while IOE is being reset. Make sure it is called
 288                  * only after register_netdev() was issued.
 289                  */
 290                 if (i2400m->wimax_dev.net_dev->reg_state == NETREG_REGISTERED)
 291                         netif_tx_disable(i2400m->wimax_dev.net_dev);
 292
 293                 i2400ms_rx_release(i2400ms);
 294                 sdio_claim_host(i2400ms->func);
 295                 sdio_disable_func(i2400ms->func);
 296                 sdio_release_host(i2400ms->func);
 297
 298                 /* Wait for the device to settle */
 299                 msleep(40);
 300
 301                 result = i2400ms_enable_function(i2400ms->func);
 302                 if (result >= 0)
 303                         i2400ms_rx_setup(i2400ms);
 304         } else
 305                 BUG();
 306         if (result < 0 && rt != I2400M_RT_BUS) {
 307                 dev_err(dev, "%s reset failed (%d); trying SDIO reset\n",
 308                         rt == I2400M_RT_WARM ? "warm" : "cold", result);
 309                 rt = I2400M_RT_BUS;
 310                 goto do_bus_reset;
 311         }
 312         return result;
 313 }
 314
 315
 316 static
 317 void i2400ms_netdev_setup(struct net_device *net_dev)
 318 {
 319         struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
 320         struct i2400ms *i2400ms = container_of(i2400m, struct i2400ms, i2400m);
 321         i2400ms_init(i2400ms);
 322         i2400m_netdev_setup(net_dev);
 323 }
 324
 325
 326 /*
 327  * Debug levels control; see debug.h
 328  */
 329 struct d_level D_LEVEL[] = {
 330         D_SUBMODULE_DEFINE(main),
 331         D_SUBMODULE_DEFINE(tx),
 332         D_SUBMODULE_DEFINE(rx),
 333         D_SUBMODULE_DEFINE(fw),
 334 };
 335 size_t D_LEVEL_SIZE = ARRAY_SIZE(D_LEVEL);
 336
 337
 338 #define __debugfs_register(prefix, name, parent)                        \
 339 do {                                                                    \
 340         result = d_level_register_debugfs(prefix, name, parent);        \
 341         if (result < 0)                                                 \
 342                 goto error;                                             \
 343 } while (0)
 344
 345
 346 static
 347 int i2400ms_debugfs_add(struct i2400ms *i2400ms)
 348 {
 349         int result;
 350         struct dentry *dentry = i2400ms->i2400m.wimax_dev.debugfs_dentry;
 351
 352         dentry = debugfs_create_dir("i2400m-usb", dentry);
 353         result = PTR_ERR(dentry);
 354         if (IS_ERR(dentry)) {
 355                 if (result == -ENODEV)
 356                         result = 0;     /* No debugfs support */
 357                 goto error;
 358         }
 359         i2400ms->debugfs_dentry = dentry;
 360         __debugfs_register("dl_", main, dentry);
 361         __debugfs_register("dl_", tx, dentry);
 362         __debugfs_register("dl_", rx, dentry);
 363         __debugfs_register("dl_", fw, dentry);
 364
 365         return 0;
 366
 367 error:
 368         debugfs_remove_recursive(i2400ms->debugfs_dentry);
 369         return result;
 370 }
 371
 372
 373 static struct device_type i2400ms_type = {
 374         .name   = "wimax",
 375 };
 376
 377 /*
 378  * Probe a i2400m interface and register it
 379  *
 380  * @func:    SDIO function
 381  * @id:      SDIO device ID
 382  * @returns: 0 if ok, < 0 errno code on error.
 383  *
 384  * Alloc a net device, initialize the bus-specific details and then
 385  * calls the bus-generic initialization routine. That will register
 386  * the wimax and netdev devices, upload the firmware [using
 387  * _bus_bm_*()], call _bus_dev_start() to finalize the setup of the
 388  * communication with the device and then will start to talk to it to
 389  * finnish setting it up.
 390  *
 391  * Initialization is tricky; some instances of the hw are packed with
 392  * others in a way that requires a third driver that enables the WiMAX
 393  * function. In those cases, we can't enable the SDIO function and
 394  * we'll return with -ENODEV. When the driver that enables the WiMAX
 395  * function does its thing, it has to do a bus_rescan_devices() on the
 396  * SDIO bus so this driver is called again to enumerate the WiMAX
 397  * function.
 398  */
 399 static
 400 int i2400ms_probe(struct sdio_func *func,
 401                   const struct sdio_device_id *id)
 402 {
 403         int result;
 404         struct net_device *net_dev;
 405         struct device *dev = &func->dev;
 406         struct i2400m *i2400m;
 407         struct i2400ms *i2400ms;
 408
 409         /* Allocate instance [calls i2400m_netdev_setup() on it]. */
 410         result = -ENOMEM;
 411         net_dev = alloc_netdev(sizeof(*i2400ms), "wmx%d",
 412                                i2400ms_netdev_setup);
 413         if (net_dev == NULL) {
 414                 dev_err(dev, "no memory for network device instance\n");
 415                 goto error_alloc_netdev;
 416         }
 417         SET_NETDEV_DEV(net_dev, dev);
 418         SET_NETDEV_DEVTYPE(net_dev, &i2400ms_type);
 419         i2400m = net_dev_to_i2400m(net_dev);
 420         i2400ms = container_of(i2400m, struct i2400ms, i2400m);
 421         i2400m->wimax_dev.net_dev = net_dev;
 422         i2400ms->func = func;
 423         sdio_set_drvdata(func, i2400ms);
 424
 425         i2400m->bus_tx_block_size = I2400MS_BLK_SIZE;
 426         i2400m->bus_pl_size_max = I2400MS_PL_SIZE_MAX;
 427         i2400m->bus_dev_start = i2400ms_bus_dev_start;
 428         i2400m->bus_dev_stop = i2400ms_bus_dev_stop;
 429         i2400m->bus_tx_kick = i2400ms_bus_tx_kick;
 430         i2400m->bus_reset = i2400ms_bus_reset;
 431         /* The iwmc3200-wimax sometimes requires the driver to try
 432          * hard when we paint it into a corner. */
 433         i2400m->bus_bm_retries = I3200_BOOT_RETRIES;
 434         i2400m->bus_bm_cmd_send = i2400ms_bus_bm_cmd_send;
 435         i2400m->bus_bm_wait_for_ack = i2400ms_bus_bm_wait_for_ack;
 436         i2400m->bus_fw_names = i2400ms_bus_fw_names;
 437         i2400m->bus_bm_mac_addr_impaired = 1;
 438         i2400m->bus_bm_pokes_table = &i2400ms_pokes[0];
 439
 440         sdio_claim_host(func);
 441         result = sdio_set_block_size(func, I2400MS_BLK_SIZE);
 442         sdio_release_host(func);
 443         if (result < 0) {
 444                 dev_err(dev, "Failed to set block size: %d\n", result);
 445                 goto error_set_blk_size;
 446         }
 447
 448         result = i2400ms_enable_function(i2400ms->func);
 449         if (result < 0) {
 450                 dev_err(dev, "Cannot enable SDIO function: %d\n", result);
 451                 goto error_func_enable;
 452         }
 453
 454         result = i2400ms_rx_setup(i2400ms);
 455         if (result < 0)
 456                 goto error_rx_setup;
 457
 458         result = i2400m_setup(i2400m, I2400M_BRI_NO_REBOOT);
 459         if (result < 0) {
 460                 dev_err(dev, "cannot setup device: %d\n", result);
 461                 goto error_setup;
 462         }
 463
 464         result = i2400ms_debugfs_add(i2400ms);
 465         if (result < 0) {
 466                 dev_err(dev, "cannot create SDIO debugfs: %d\n",
 467                         result);
 468                 goto error_debugfs_add;
 469         }
 470         return 0;
 471
 472 error_debugfs_add:
 473         i2400m_release(i2400m);
 474 error_setup:
 475         i2400ms_rx_release(i2400ms);
 476 error_rx_setup:
 477         sdio_claim_host(func);
 478         sdio_disable_func(func);
 479         sdio_release_host(func);
 480 error_func_enable:
 481 error_set_blk_size:
 482         sdio_set_drvdata(func, NULL);
 483         free_netdev(net_dev);
 484 error_alloc_netdev:
 485         return result;
 486 }
 487
 488
 489 static
 490 void i2400ms_remove(struct sdio_func *func)
 491 {
 492         struct device *dev = &func->dev;
 493         struct i2400ms *i2400ms = sdio_get_drvdata(func);
 494         struct i2400m *i2400m = &i2400ms->i2400m;
 495         struct net_device *net_dev = i2400m->wimax_dev.net_dev;
 496
 497         d_fnstart(3, dev, "SDIO func %p\n", func);
 498         debugfs_remove_recursive(i2400ms->debugfs_dentry);
 499         i2400ms_rx_release(i2400ms);
 500         i2400m_release(i2400m);
 501         sdio_set_drvdata(func, NULL);
 502         sdio_claim_host(func);
 503         sdio_disable_func(func);
 504         sdio_release_host(func);
 505         free_netdev(net_dev);
 506         d_fnend(3, dev, "SDIO func %p\n", func);
 507 }
 508
 509 static
 510 const struct sdio_device_id i2400ms_sdio_ids[] = {
 511         /* Intel: i2400m WiMAX (iwmc3200) over SDIO */
 512         { SDIO_DEVICE(SDIO_VENDOR_ID_INTEL,
 513                       SDIO_DEVICE_ID_INTEL_IWMC3200WIMAX) },
 514         { /* end: all zeroes */ },
 515 };
 516 MODULE_DEVICE_TABLE(sdio, i2400ms_sdio_ids);
 517
 518
 519 static
 520 struct sdio_driver i2400m_sdio_driver = {
 521         .name           = KBUILD_MODNAME,
 522         .probe          = i2400ms_probe,
 523         .remove         = i2400ms_remove,
 524         .id_table       = i2400ms_sdio_ids,
 525 };
 526
 527
 528 static
 529 int __init i2400ms_driver_init(void)
 530 {
 531         return sdio_register_driver(&i2400m_sdio_driver);
 532 }
 533 module_init(i2400ms_driver_init);
 534
 535
 536 static
 537 void __exit i2400ms_driver_exit(void)
 538 {
 539         flush_scheduled_work(); /* for the stuff we schedule */
 540         sdio_unregister_driver(&i2400m_sdio_driver);
 541 }
 542 module_exit(i2400ms_driver_exit);
 543
 544
 545 MODULE_AUTHOR("Intel Corporation <linux-wimax@intel.com>");
 546 MODULE_DESCRIPTION("Intel 2400M WiMAX networking for SDIO");
 547 MODULE_LICENSE("GPL");
 548 MODULE_FIRMWARE(I2400MS_FW_FILE_NAME);