drivers/net/wireless/wl12xx/wl1271_spi.c

   1 /*
   2  * This file is part of wl1271
   3  *
   4  * Copyright (C) 2008-2009 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/crc7.h>
  27 #include <linux/spi/spi.h>
  28 #include <linux/spi/wl12xx.h>
  29 #include <linux/slab.h>
  30
  31 #include "wl1271.h"
  32 #include "wl12xx_80211.h"
  33 #include "wl1271_io.h"
  34
  35 #include "wl1271_reg.h"
  36
  37 #define WSPI_CMD_READ                 0x40000000
  38 #define WSPI_CMD_WRITE                0x00000000
  39 #define WSPI_CMD_FIXED                0x20000000
  40 #define WSPI_CMD_BYTE_LENGTH          0x1FFE0000
  41 #define WSPI_CMD_BYTE_LENGTH_OFFSET   17
  42 #define WSPI_CMD_BYTE_ADDR            0x0001FFFF
  43
  44 #define WSPI_INIT_CMD_CRC_LEN       5
  45
  46 #define WSPI_INIT_CMD_START         0x00
  47 #define WSPI_INIT_CMD_TX            0x40
  48 /* the extra bypass bit is sampled by the TNET as '1' */
  49 #define WSPI_INIT_CMD_BYPASS_BIT    0x80
  50 #define WSPI_INIT_CMD_FIXEDBUSY_LEN 0x07
  51 #define WSPI_INIT_CMD_EN_FIXEDBUSY  0x80
  52 #define WSPI_INIT_CMD_DIS_FIXEDBUSY 0x00
  53 #define WSPI_INIT_CMD_IOD           0x40
  54 #define WSPI_INIT_CMD_IP            0x20
  55 #define WSPI_INIT_CMD_CS            0x10
  56 #define WSPI_INIT_CMD_WS            0x08
  57 #define WSPI_INIT_CMD_WSPI          0x01
  58 #define WSPI_INIT_CMD_END           0x01
  59
  60 #define WSPI_INIT_CMD_LEN           8
  61
  62 #define HW_ACCESS_WSPI_FIXED_BUSY_LEN \
  63                 ((WL1271_BUSY_WORD_LEN - 4) / sizeof(u32))
  64 #define HW_ACCESS_WSPI_INIT_CMD_MASK  0
  65
  66 static inline struct spi_device *wl_to_spi(struct wl1271 *wl)
  67 {
  68         return wl->if_priv;
  69 }
  70
  71 static struct device *wl1271_spi_wl_to_dev(struct wl1271 *wl)
  72 {
  73         return &(wl_to_spi(wl)->dev);
  74 }
  75
  76 static void wl1271_spi_disable_interrupts(struct wl1271 *wl)
  77 {
  78         disable_irq(wl->irq);
  79 }
  80
  81 static void wl1271_spi_enable_interrupts(struct wl1271 *wl)
  82 {
  83         enable_irq(wl->irq);
  84 }
  85
  86 static void wl1271_spi_reset(struct wl1271 *wl)
  87 {
  88         u8 *cmd;
  89         struct spi_transfer t;
  90         struct spi_message m;
  91
  92         cmd = kzalloc(WSPI_INIT_CMD_LEN, GFP_KERNEL);
  93         if (!cmd) {
  94                 wl1271_error("could not allocate cmd for spi reset");
  95                 return;
  96         }
  97
  98         memset(&t, 0, sizeof(t));
  99         spi_message_init(&m);
 100
 101         memset(cmd, 0xff, WSPI_INIT_CMD_LEN);
 102
 103         t.tx_buf = cmd;
 104         t.len = WSPI_INIT_CMD_LEN;
 105         spi_message_add_tail(&t, &m);
 106
 107         spi_sync(wl_to_spi(wl), &m);
 108
 109         wl1271_dump(DEBUG_SPI, "spi reset -> ", cmd, WSPI_INIT_CMD_LEN);
 110 }
 111
 112 static void wl1271_spi_init(struct wl1271 *wl)
 113 {
 114         u8 crc[WSPI_INIT_CMD_CRC_LEN], *cmd;
 115         struct spi_transfer t;
 116         struct spi_message m;
 117
 118         cmd = kzalloc(WSPI_INIT_CMD_LEN, GFP_KERNEL);
 119         if (!cmd) {
 120                 wl1271_error("could not allocate cmd for spi init");
 121                 return;
 122         }
 123
 124         memset(crc, 0, sizeof(crc));
 125         memset(&t, 0, sizeof(t));
 126         spi_message_init(&m);
 127
 128         /*
 129          * Set WSPI_INIT_COMMAND
 130          * the data is being send from the MSB to LSB
 131          */
 132         cmd[2] = 0xff;
 133         cmd[3] = 0xff;
 134         cmd[1] = WSPI_INIT_CMD_START | WSPI_INIT_CMD_TX;
 135         cmd[0] = 0;
 136         cmd[7] = 0;
 137         cmd[6] |= HW_ACCESS_WSPI_INIT_CMD_MASK << 3;
 138         cmd[6] |= HW_ACCESS_WSPI_FIXED_BUSY_LEN & WSPI_INIT_CMD_FIXEDBUSY_LEN;
 139
 140         if (HW_ACCESS_WSPI_FIXED_BUSY_LEN == 0)
 141                 cmd[5] |=  WSPI_INIT_CMD_DIS_FIXEDBUSY;
 142         else
 143                 cmd[5] |= WSPI_INIT_CMD_EN_FIXEDBUSY;
 144
 145         cmd[5] |= WSPI_INIT_CMD_IOD | WSPI_INIT_CMD_IP | WSPI_INIT_CMD_CS
 146                 | WSPI_INIT_CMD_WSPI | WSPI_INIT_CMD_WS;
 147
 148         crc[0] = cmd[1];
 149         crc[1] = cmd[0];
 150         crc[2] = cmd[7];
 151         crc[3] = cmd[6];
 152         crc[4] = cmd[5];
 153
 154         cmd[4] |= crc7(0, crc, WSPI_INIT_CMD_CRC_LEN) << 1;
 155         cmd[4] |= WSPI_INIT_CMD_END;
 156
 157         t.tx_buf = cmd;
 158         t.len = WSPI_INIT_CMD_LEN;
 159         spi_message_add_tail(&t, &m);
 160
 161         spi_sync(wl_to_spi(wl), &m);
 162
 163         wl1271_dump(DEBUG_SPI, "spi init -> ", cmd, WSPI_INIT_CMD_LEN);
 164 }
 165
 166 #define WL1271_BUSY_WORD_TIMEOUT 1000
 167
 168 /* FIXME: Check busy words, removed due to SPI bug */
 169 #if 0
 170 static void wl1271_spi_read_busy(struct wl1271 *wl, void *buf, size_t len)
 171 {
 172         struct spi_transfer t[1];
 173         struct spi_message m;
 174         u32 *busy_buf;
 175         int num_busy_bytes = 0;
 176
 177         wl1271_info("spi read BUSY!");
 178
 179         /*
 180          * Look for the non-busy word in the read buffer, and if found,
 181          * read in the remaining data into the buffer.
 182          */
 183         busy_buf = (u32 *)buf;
 184         for (; (u32)busy_buf < (u32)buf + len; busy_buf++) {
 185                 num_busy_bytes += sizeof(u32);
 186                 if (*busy_buf & 0x1) {
 187                         spi_message_init(&m);
 188                         memset(t, 0, sizeof(t));
 189                         memmove(buf, busy_buf, len - num_busy_bytes);
 190                         t[0].rx_buf = buf + (len - num_busy_bytes);
 191                         t[0].len = num_busy_bytes;
 192                         spi_message_add_tail(&t[0], &m);
 193                         spi_sync(wl_to_spi(wl), &m);
 194                         return;
 195                 }
 196         }
 197
 198         /*
 199          * Read further busy words from SPI until a non-busy word is
 200          * encountered, then read the data itself into the buffer.
 201          */
 202         wl1271_info("spi read BUSY-polling needed!");
 203
 204         num_busy_bytes = WL1271_BUSY_WORD_TIMEOUT;
 205         busy_buf = wl->buffer_busyword;
 206         while (num_busy_bytes) {
 207                 num_busy_bytes--;
 208                 spi_message_init(&m);
 209                 memset(t, 0, sizeof(t));
 210                 t[0].rx_buf = busy_buf;
 211                 t[0].len = sizeof(u32);
 212                 spi_message_add_tail(&t[0], &m);
 213                 spi_sync(wl_to_spi(wl), &m);
 214
 215                 if (*busy_buf & 0x1) {
 216                         spi_message_init(&m);
 217                         memset(t, 0, sizeof(t));
 218                         t[0].rx_buf = buf;
 219                         t[0].len = len;
 220                         spi_message_add_tail(&t[0], &m);
 221                         spi_sync(wl_to_spi(wl), &m);
 222                         return;
 223                 }
 224         }
 225
 226         /* The SPI bus is unresponsive, the read failed. */
 227         memset(buf, 0, len);
 228         wl1271_error("SPI read busy-word timeout!\n");
 229 }
 230 #endif
 231
 232 static void wl1271_spi_raw_read(struct wl1271 *wl, int addr, void *buf,
 233                          size_t len, bool fixed)
 234 {
 235         struct spi_transfer t[3];
 236         struct spi_message m;
 237         u32 *busy_buf;
 238         u32 *cmd;
 239
 240         cmd = &wl->buffer_cmd;
 241         busy_buf = wl->buffer_busyword;
 242
 243         *cmd = 0;
 244         *cmd |= WSPI_CMD_READ;
 245         *cmd |= (len << WSPI_CMD_BYTE_LENGTH_OFFSET) & WSPI_CMD_BYTE_LENGTH;
 246         *cmd |= addr & WSPI_CMD_BYTE_ADDR;
 247
 248         if (fixed)
 249                 *cmd |= WSPI_CMD_FIXED;
 250
 251         spi_message_init(&m);
 252         memset(t, 0, sizeof(t));
 253
 254         t[0].tx_buf = cmd;
 255         t[0].len = 4;
 256         spi_message_add_tail(&t[0], &m);
 257
 258         /* Busy and non busy words read */
 259         t[1].rx_buf = busy_buf;
 260         t[1].len = WL1271_BUSY_WORD_LEN;
 261         spi_message_add_tail(&t[1], &m);
 262
 263         t[2].rx_buf = buf;
 264         t[2].len = len;
 265         spi_message_add_tail(&t[2], &m);
 266
 267         spi_sync(wl_to_spi(wl), &m);
 268
 269         /* FIXME: Check busy words, removed due to SPI bug */
 270         /* if (!(busy_buf[WL1271_BUSY_WORD_CNT - 1] & 0x1))
 271            wl1271_spi_read_busy(wl, buf, len); */
 272
 273         wl1271_dump(DEBUG_SPI, "spi_read cmd -> ", cmd, sizeof(*cmd));
 274         wl1271_dump(DEBUG_SPI, "spi_read buf <- ", buf, len);
 275 }
 276
 277 static void wl1271_spi_raw_write(struct wl1271 *wl, int addr, void *buf,
 278                           size_t len, bool fixed)
 279 {
 280         struct spi_transfer t[2];
 281         struct spi_message m;
 282         u32 *cmd;
 283
 284         cmd = &wl->buffer_cmd;
 285
 286         *cmd = 0;
 287         *cmd |= WSPI_CMD_WRITE;
 288         *cmd |= (len << WSPI_CMD_BYTE_LENGTH_OFFSET) & WSPI_CMD_BYTE_LENGTH;
 289         *cmd |= addr & WSPI_CMD_BYTE_ADDR;
 290
 291         if (fixed)
 292                 *cmd |= WSPI_CMD_FIXED;
 293
 294         spi_message_init(&m);
 295         memset(t, 0, sizeof(t));
 296
 297         t[0].tx_buf = cmd;
 298         t[0].len = sizeof(*cmd);
 299         spi_message_add_tail(&t[0], &m);
 300
 301         t[1].tx_buf = buf;
 302         t[1].len = len;
 303         spi_message_add_tail(&t[1], &m);
 304
 305         spi_sync(wl_to_spi(wl), &m);
 306
 307         wl1271_dump(DEBUG_SPI, "spi_write cmd -> ", cmd, sizeof(*cmd));
 308         wl1271_dump(DEBUG_SPI, "spi_write buf -> ", buf, len);
 309 }
 310
 311 static irqreturn_t wl1271_irq(int irq, void *cookie)
 312 {
 313         struct wl1271 *wl;
 314         unsigned long flags;
 315
 316         wl1271_debug(DEBUG_IRQ, "IRQ");
 317
 318         wl = cookie;
 319
 320         /* complete the ELP completion */
 321         spin_lock_irqsave(&wl->wl_lock, flags);
 322         if (wl->elp_compl) {
 323                 complete(wl->elp_compl);
 324                 wl->elp_compl = NULL;
 325         }
 326
 327         if (!test_and_set_bit(WL1271_FLAG_IRQ_RUNNING, &wl->flags))
 328                 ieee80211_queue_work(wl->hw, &wl->irq_work);
 329         set_bit(WL1271_FLAG_IRQ_PENDING, &wl->flags);
 330         spin_unlock_irqrestore(&wl->wl_lock, flags);
 331
 332         return IRQ_HANDLED;
 333 }
 334
 335 static void wl1271_spi_set_power(struct wl1271 *wl, bool enable)
 336 {
 337         if (wl->set_power)
 338                 wl->set_power(enable);
 339 }
 340
 341 static struct wl1271_if_operations spi_ops = {
 342         .read           = wl1271_spi_raw_read,
 343         .write          = wl1271_spi_raw_write,
 344         .reset          = wl1271_spi_reset,
 345         .init           = wl1271_spi_init,
 346         .power          = wl1271_spi_set_power,
 347         .dev            = wl1271_spi_wl_to_dev,
 348         .enable_irq     = wl1271_spi_enable_interrupts,
 349         .disable_irq    = wl1271_spi_disable_interrupts
 350 };
 351
 352 static int __devinit wl1271_probe(struct spi_device *spi)
 353 {
 354         struct wl12xx_platform_data *pdata;
 355         struct ieee80211_hw *hw;
 356         struct wl1271 *wl;
 357         int ret;
 358
 359         pdata = spi->dev.platform_data;
 360         if (!pdata) {
 361                 wl1271_error("no platform data");
 362                 return -ENODEV;
 363         }
 364
 365         hw = wl1271_alloc_hw();
 366         if (IS_ERR(hw))
 367                 return PTR_ERR(hw);
 368
 369         wl = hw->priv;
 370
 371         dev_set_drvdata(&spi->dev, wl);
 372         wl->if_priv = spi;
 373
 374         wl->if_ops = &spi_ops;
 375
 376         /* This is the only SPI value that we need to set here, the rest
 377          * comes from the board-peripherals file */
 378         spi->bits_per_word = 32;
 379
 380         ret = spi_setup(spi);
 381         if (ret < 0) {
 382                 wl1271_error("spi_setup failed");
 383                 goto out_free;
 384         }
 385
 386         wl->set_power = pdata->set_power;
 387         if (!wl->set_power) {
 388                 wl1271_error("set power function missing in platform data");
 389                 ret = -ENODEV;
 390                 goto out_free;
 391         }
 392
 393         wl->irq = spi->irq;
 394         if (wl->irq < 0) {
 395                 wl1271_error("irq missing in platform data");
 396                 ret = -ENODEV;
 397                 goto out_free;
 398         }
 399
 400         ret = request_irq(wl->irq, wl1271_irq, 0, DRIVER_NAME, wl);
 401         if (ret < 0) {
 402                 wl1271_error("request_irq() failed: %d", ret);
 403                 goto out_free;
 404         }
 405
 406         set_irq_type(wl->irq, IRQ_TYPE_EDGE_RISING);
 407
 408         disable_irq(wl->irq);
 409
 410         ret = wl1271_init_ieee80211(wl);
 411         if (ret)
 412                 goto out_irq;
 413
 414         ret = wl1271_register_hw(wl);
 415         if (ret)
 416                 goto out_irq;
 417
 418         wl1271_notice("initialized");
 419
 420         return 0;
 421
 422  out_irq:
 423         free_irq(wl->irq, wl);
 424
 425  out_free:
 426         wl1271_free_hw(wl);
 427
 428         return ret;
 429 }
 430
 431 static int __devexit wl1271_remove(struct spi_device *spi)
 432 {
 433         struct wl1271 *wl = dev_get_drvdata(&spi->dev);
 434
 435         free_irq(wl->irq, wl);
 436
 437         wl1271_unregister_hw(wl);
 438         wl1271_free_hw(wl);
 439
 440         return 0;
 441 }
 442
 443
 444 static struct spi_driver wl1271_spi_driver = {
 445         .driver = {
 446                 .name           = "wl1271",
 447                 .bus            = &spi_bus_type,
 448                 .owner          = THIS_MODULE,
 449         },
 450
 451         .probe          = wl1271_probe,
 452         .remove         = __devexit_p(wl1271_remove),
 453 };
 454
 455 static int __init wl1271_init(void)
 456 {
 457         int ret;
 458
 459         ret = spi_register_driver(&wl1271_spi_driver);
 460         if (ret < 0) {
 461                 wl1271_error("failed to register spi driver: %d", ret);
 462                 goto out;
 463         }
 464
 465 out:
 466         return ret;
 467 }
 468
 469 static void __exit wl1271_exit(void)
 470 {
 471         spi_unregister_driver(&wl1271_spi_driver);
 472
 473         wl1271_notice("unloaded");
 474 }
 475
 476 module_init(wl1271_init);
 477 module_exit(wl1271_exit);
 478
 479 MODULE_LICENSE("GPL");
 480 MODULE_AUTHOR("Luciano Coelho <luciano.coelho@nokia.com>");
 481 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
 482 MODULE_FIRMWARE(WL1271_FW_NAME);