drivers/net/wimax/i2400m/sdio-rx.c

   1 /*
   2  * Intel Wireless WiMAX Connection 2400m
   3  * SDIO RX handling
   4  *
   5  *
   6  * Copyright (C) 2007-2008 Intel Corporation. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *   * Redistributions in binary form must reproduce the above copyright
  15  *     notice, this list of conditions and the following disclaimer in
  16  *     the documentation and/or other materials provided with the
  17  *     distribution.
  18  *   * Neither the name of Intel Corporation nor the names of its
  19  *     contributors may be used to endorse or promote products derived
  20  *     from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  *
  35  * Intel Corporation <linux-wimax@intel.com>
  36  * Dirk Brandewie <dirk.j.brandewie@intel.com>
  37  *  - Initial implementation
  38  *
  39  *
  40  * This handles the RX path on SDIO.
  41  *
  42  * The SDIO bus driver calls the "irq" routine when data is available.
  43  * This is not a traditional interrupt routine since the SDIO bus
  44  * driver calls us from its irq thread context.  Because of this
  45  * sleeping in the SDIO RX IRQ routine is okay.
  46  *
  47  * From there on, we obtain the size of the data that is available,
  48  * allocate an skb, copy it and then pass it to the generic driver's
  49  * RX routine [i2400m_rx()].
  50  *
  51  * ROADMAP
  52  *
  53  * i2400ms_irq()
  54  *   i2400ms_rx()
  55  *     __i2400ms_rx_get_size()
  56  *     i2400m_is_boot_barker()
  57  *     i2400m_rx()
  58  *
  59  * i2400ms_rx_setup()
  60  *
  61  * i2400ms_rx_release()
  62  */
  63 #include <linux/workqueue.h>
  64 #include <linux/wait.h>
  65 #include <linux/skbuff.h>
  66 #include <linux/mmc/sdio.h>
  67 #include <linux/mmc/sdio_func.h>
  68 #include "i2400m-sdio.h"
  69
  70 #define D_SUBMODULE rx
  71 #include "sdio-debug-levels.h"
  72
  73 static const __le32 i2400m_ACK_BARKER[4] = {
  74         __constant_cpu_to_le32(I2400M_ACK_BARKER),
  75         __constant_cpu_to_le32(I2400M_ACK_BARKER),
  76         __constant_cpu_to_le32(I2400M_ACK_BARKER),
  77         __constant_cpu_to_le32(I2400M_ACK_BARKER)
  78 };
  79
  80
  81 /*
  82  * Read and return the amount of bytes available for RX
  83  *
  84  * The RX size has to be read like this: byte reads of three
  85  * sequential locations; then glue'em together.
  86  *
  87  * sdio_readl() doesn't work.
  88  */
  89 ssize_t __i2400ms_rx_get_size(struct i2400ms *i2400ms)
  90 {
  91         int ret, cnt, val;
  92         ssize_t rx_size;
  93         unsigned xfer_size_addr;
  94         struct sdio_func *func = i2400ms->func;
  95         struct device *dev = &i2400ms->func->dev;
  96
  97         d_fnstart(7, dev, "(i2400ms %p)\n", i2400ms);
  98         xfer_size_addr = I2400MS_INTR_GET_SIZE_ADDR;
  99         rx_size = 0;
 100         for (cnt = 0; cnt < 3; cnt++) {
 101                 val = sdio_readb(func, xfer_size_addr + cnt, &ret);
 102                 if (ret < 0) {
 103                         dev_err(dev, "RX: Can't read byte %d of RX size from "
 104                                 "0x%08x: %d\n", cnt, xfer_size_addr + cnt, ret);
 105                         rx_size = ret;
 106                         goto error_read;
 107                 }
 108                 rx_size = rx_size << 8 | (val & 0xff);
 109         }
 110         d_printf(6, dev, "RX: rx_size is %ld\n", (long) rx_size);
 111 error_read:
 112         d_fnend(7, dev, "(i2400ms %p) = %ld\n", i2400ms, (long) rx_size);
 113         return rx_size;
 114 }
 115
 116
 117 /*
 118  * Read data from the device (when in normal)
 119  *
 120  * Allocate an SKB of the right size, read the data in and then
 121  * deliver it to the generic layer.
 122  *
 123  * We also check for a reboot barker. That means the device died and
 124  * we have to reboot it.
 125  */
 126 static
 127 void i2400ms_rx(struct i2400ms *i2400ms)
 128 {
 129         int ret;
 130         struct sdio_func *func = i2400ms->func;
 131         struct device *dev = &func->dev;
 132         struct i2400m *i2400m = &i2400ms->i2400m;
 133         struct sk_buff *skb;
 134         ssize_t rx_size;
 135
 136         d_fnstart(7, dev, "(i2400ms %p)\n", i2400ms);
 137         rx_size = __i2400ms_rx_get_size(i2400ms);
 138         if (rx_size < 0) {
 139                 ret = rx_size;
 140                 goto error_get_size;
 141         }
 142         /*
 143          * Hardware quirk: make sure to clear the INTR status register
 144          * AFTER getting the data transfer size.
 145          */
 146         sdio_writeb(func, 1, I2400MS_INTR_CLEAR_ADDR, &ret);
 147
 148         ret = -ENOMEM;
 149         skb = alloc_skb(rx_size, GFP_ATOMIC);
 150         if (NULL == skb) {
 151                 dev_err(dev, "RX: unable to alloc skb\n");
 152                 goto error_alloc_skb;
 153         }
 154         ret = sdio_memcpy_fromio(func, skb->data,
 155                                  I2400MS_DATA_ADDR, rx_size);
 156         if (ret < 0) {
 157                 dev_err(dev, "RX: SDIO data read failed: %d\n", ret);
 158                 goto error_memcpy_fromio;
 159         }
 160
 161         rmb();  /* make sure we get boot_mode from dev_reset_handle */
 162         if (unlikely(i2400m->boot_mode == 1)) {
 163                 spin_lock(&i2400m->rx_lock);
 164                 i2400ms->bm_ack_size = rx_size;
 165                 spin_unlock(&i2400m->rx_lock);
 166                 memcpy(i2400m->bm_ack_buf, skb->data, rx_size);
 167                 wake_up(&i2400ms->bm_wfa_wq);
 168                 d_printf(5, dev, "RX: SDIO boot mode message\n");
 169                 kfree_skb(skb);
 170                 goto out;
 171         }
 172         ret = -EIO;
 173         if (unlikely(rx_size < sizeof(__le32))) {
 174                 dev_err(dev, "HW BUG? only %zu bytes received\n", rx_size);
 175                 goto error_bad_size;
 176         }
 177         if (likely(i2400m_is_d2h_barker(skb->data))) {
 178                 skb_put(skb, rx_size);
 179                 i2400m_rx(i2400m, skb);
 180         } else if (unlikely(i2400m_is_boot_barker(i2400m,
 181                                                   skb->data, rx_size))) {
 182                 ret = i2400m_dev_reset_handle(i2400m, "device rebooted");
 183                 dev_err(dev, "RX: SDIO reboot barker\n");
 184                 kfree_skb(skb);
 185         } else {
 186                 i2400m_unknown_barker(i2400m, skb->data, rx_size);
 187                 kfree_skb(skb);
 188         }
 189 out:
 190         d_fnend(7, dev, "(i2400ms %p) = void\n", i2400ms);
 191         return;
 192
 193 error_memcpy_fromio:
 194         kfree_skb(skb);
 195 error_alloc_skb:
 196 error_get_size:
 197 error_bad_size:
 198         d_fnend(7, dev, "(i2400ms %p) = %d\n", i2400ms, ret);
 199         return;
 200 }
 201
 202
 203 /*
 204  * Process an interrupt from the SDIO card
 205  *
 206  * FIXME: need to process other events that are not just ready-to-read
 207  *
 208  * Checks there is data ready and then proceeds to read it.
 209  */
 210 static
 211 void i2400ms_irq(struct sdio_func *func)
 212 {
 213         int ret;
 214         struct i2400ms *i2400ms = sdio_get_drvdata(func);
 215         struct device *dev = &func->dev;
 216         int val;
 217
 218         d_fnstart(6, dev, "(i2400ms %p)\n", i2400ms);
 219         val = sdio_readb(func, I2400MS_INTR_STATUS_ADDR, &ret);
 220         if (ret < 0) {
 221                 dev_err(dev, "RX: Can't read interrupt status: %d\n", ret);
 222                 goto error_no_irq;
 223         }
 224         if (!val) {
 225                 dev_err(dev, "RX: BUG? got IRQ but no interrupt ready?\n");
 226                 goto error_no_irq;
 227         }
 228         i2400ms_rx(i2400ms);
 229 error_no_irq:
 230         d_fnend(6, dev, "(i2400ms %p) = void\n", i2400ms);
 231         return;
 232 }
 233
 234
 235 /*
 236  * Setup SDIO RX
 237  *
 238  * Hooks up the IRQ handler and then enables IRQs.
 239  */
 240 int i2400ms_rx_setup(struct i2400ms *i2400ms)
 241 {
 242         int result;
 243         struct sdio_func *func = i2400ms->func;
 244         struct device *dev = &func->dev;
 245         struct i2400m *i2400m = &i2400ms->i2400m;
 246
 247         d_fnstart(5, dev, "(i2400ms %p)\n", i2400ms);
 248
 249         init_waitqueue_head(&i2400ms->bm_wfa_wq);
 250         spin_lock(&i2400m->rx_lock);
 251         i2400ms->bm_wait_result = -EINPROGRESS;
 252         /*
 253          * Before we are about to enable the RX interrupt, make sure
 254          * bm_ack_size is cleared to -EINPROGRESS which indicates
 255          * no RX interrupt happened yet or the previous interrupt
 256          * has been handled, we are ready to take the new interrupt
 257          */
 258         i2400ms->bm_ack_size = -EINPROGRESS;
 259         spin_unlock(&i2400m->rx_lock);
 260
 261         sdio_claim_host(func);
 262         result = sdio_claim_irq(func, i2400ms_irq);
 263         if (result < 0) {
 264                 dev_err(dev, "Cannot claim IRQ: %d\n", result);
 265                 goto error_irq_claim;
 266         }
 267         result = 0;
 268         sdio_writeb(func, 1, I2400MS_INTR_ENABLE_ADDR, &result);
 269         if (result < 0) {
 270                 sdio_release_irq(func);
 271                 dev_err(dev, "Failed to enable interrupts %d\n", result);
 272         }
 273 error_irq_claim:
 274         sdio_release_host(func);
 275         d_fnend(5, dev, "(i2400ms %p) = %d\n", i2400ms, result);
 276         return result;
 277 }
 278
 279
 280 /*
 281  * Tear down SDIO RX
 282  *
 283  * Disables IRQs in the device and removes the IRQ handler.
 284  */
 285 void i2400ms_rx_release(struct i2400ms *i2400ms)
 286 {
 287         int result;
 288         struct sdio_func *func = i2400ms->func;
 289         struct device *dev = &func->dev;
 290         struct i2400m *i2400m = &i2400ms->i2400m;
 291
 292         d_fnstart(5, dev, "(i2400ms %p)\n", i2400ms);
 293         spin_lock(&i2400m->rx_lock);
 294         i2400ms->bm_ack_size = -EINTR;
 295         spin_unlock(&i2400m->rx_lock);
 296         wake_up_all(&i2400ms->bm_wfa_wq);
 297         sdio_claim_host(func);
 298         sdio_writeb(func, 0, I2400MS_INTR_ENABLE_ADDR, &result);
 299         sdio_release_irq(func);
 300         sdio_release_host(func);
 301         d_fnend(5, dev, "(i2400ms %p) = %d\n", i2400ms, result);
 302 }