drivers/net/wireless/iwlegacy/iwl-rx.c

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2011 Intel Corporation. All rights reserved.
   4  *
   5  * Portions of this file are derived from the ipw3945 project, as well
   6  * as portions of the ieee80211 subsystem header files.
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of version 2 of the GNU General Public License as
  10  * published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  15  * more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with
  18  * this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  20  *
  21  * The full GNU General Public License is included in this distribution in the
  22  * file called LICENSE.
  23  *
  24  * Contact Information:
  25  *  Intel Linux Wireless <ilw@linux.intel.com>
  26  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  27  *
  28  *****************************************************************************/
  29
  30 #include <linux/etherdevice.h>
  31 #include <linux/slab.h>
  32 #include <linux/export.h>
  33 #include <net/mac80211.h>
  34 #include <asm/unaligned.h>
  35 #include "iwl-eeprom.h"
  36 #include "iwl-dev.h"
  37 #include "iwl-core.h"
  38 #include "iwl-sta.h"
  39 #include "iwl-io.h"
  40 #include "iwl-helpers.h"
  41 /************************** RX-FUNCTIONS ****************************/
  42 /*
  43  * Rx theory of operation
  44  *
  45  * Driver allocates a circular buffer of Receive Buffer Descriptors (RBDs),
  46  * each of which point to Receive Buffers to be filled by the NIC.  These get
  47  * used not only for Rx frames, but for any command response or notification
  48  * from the NIC.  The driver and NIC manage the Rx buffers by means
  49  * of indexes into the circular buffer.
  50  *
  51  * Rx Queue Indexes
  52  * The host/firmware share two index registers for managing the Rx buffers.
  53  *
  54  * The READ index maps to the first position that the firmware may be writing
  55  * to -- the driver can read up to (but not including) this position and get
  56  * good data.
  57  * The READ index is managed by the firmware once the card is enabled.
  58  *
  59  * The WRITE index maps to the last position the driver has read from -- the
  60  * position preceding WRITE is the last slot the firmware can place a packet.
  61  *
  62  * The queue is empty (no good data) if WRITE = READ - 1, and is full if
  63  * WRITE = READ.
  64  *
  65  * During initialization, the host sets up the READ queue position to the first
  66  * INDEX position, and WRITE to the last (READ - 1 wrapped)
  67  *
  68  * When the firmware places a packet in a buffer, it will advance the READ index
  69  * and fire the RX interrupt.  The driver can then query the READ index and
  70  * process as many packets as possible, moving the WRITE index forward as it
  71  * resets the Rx queue buffers with new memory.
  72  *
  73  * The management in the driver is as follows:
  74  * + A list of pre-allocated SKBs is stored in iwl->rxq->rx_free.  When
  75  *   iwl->rxq->free_count drops to or below RX_LOW_WATERMARK, work is scheduled
  76  *   to replenish the iwl->rxq->rx_free.
  77  * + In iwl_rx_replenish (scheduled) if 'processed' != 'read' then the
  78  *   iwl->rxq is replenished and the READ INDEX is updated (updating the
  79  *   'processed' and 'read' driver indexes as well)
  80  * + A received packet is processed and handed to the kernel network stack,
  81  *   detached from the iwl->rxq.  The driver 'processed' index is updated.
  82  * + The Host/Firmware iwl->rxq is replenished at tasklet time from the rx_free
  83  *   list. If there are no allocated buffers in iwl->rxq->rx_free, the READ
  84  *   INDEX is not incremented and iwl->status(RX_STALLED) is set.  If there
  85  *   were enough free buffers and RX_STALLED is set it is cleared.
  86  *
  87  *
  88  * Driver sequence:
  89  *
  90  * iwl_legacy_rx_queue_alloc()   Allocates rx_free
  91  * iwl_rx_replenish()     Replenishes rx_free list from rx_used, and calls
  92  *                            iwl_rx_queue_restock
  93  * iwl_rx_queue_restock() Moves available buffers from rx_free into Rx
  94  *                            queue, updates firmware pointers, and updates
  95  *                            the WRITE index.  If insufficient rx_free buffers
  96  *                            are available, schedules iwl_rx_replenish
  97  *
  98  * -- enable interrupts --
  99  * ISR - iwl_rx()         Detach iwl_rx_mem_buffers from pool up to the
 100  *                            READ INDEX, detaching the SKB from the pool.
 101  *                            Moves the packet buffer from queue to rx_used.
 102  *                            Calls iwl_rx_queue_restock to refill any empty
 103  *                            slots.
 104  * ...
 105  *
 106  */
 107
 108 /**
 109  * iwl_legacy_rx_queue_space - Return number of free slots available in queue.
 110  */
 111 int iwl_legacy_rx_queue_space(const struct iwl_rx_queue *q)
 112 {
 113         int s = q->read - q->write;
 114         if (s <= 0)
 115                 s += RX_QUEUE_SIZE;
 116         /* keep some buffer to not confuse full and empty queue */
 117         s -= 2;
 118         if (s < 0)
 119                 s = 0;
 120         return s;
 121 }
 122 EXPORT_SYMBOL(iwl_legacy_rx_queue_space);
 123
 124 /**
 125  * iwl_legacy_rx_queue_update_write_ptr - Update the write pointer for the RX queue
 126  */
 127 void
 128 iwl_legacy_rx_queue_update_write_ptr(struct iwl_priv *priv,
 129                                         struct iwl_rx_queue *q)
 130 {
 131         unsigned long flags;
 132         u32 rx_wrt_ptr_reg = priv->hw_params.rx_wrt_ptr_reg;
 133         u32 reg;
 134
 135         spin_lock_irqsave(&q->lock, flags);
 136
 137         if (q->need_update == 0)
 138                 goto exit_unlock;
 139
 140         /* If power-saving is in use, make sure device is awake */
 141         if (test_bit(STATUS_POWER_PMI, &priv->status)) {
 142                 reg = iwl_read32(priv, CSR_UCODE_DRV_GP1);
 143
 144                 if (reg & CSR_UCODE_DRV_GP1_BIT_MAC_SLEEP) {
 145                         IWL_DEBUG_INFO(priv,
 146                                 "Rx queue requesting wakeup,"
 147                                 " GP1 = 0x%x\n", reg);
 148                         iwl_legacy_set_bit(priv, CSR_GP_CNTRL,
 149                                 CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
 150                         goto exit_unlock;
 151                 }
 152
 153                 q->write_actual = (q->write & ~0x7);
 154                 iwl_legacy_write_direct32(priv, rx_wrt_ptr_reg,
 155                                 q->write_actual);
 156
 157         /* Else device is assumed to be awake */
 158         } else {
 159                 /* Device expects a multiple of 8 */
 160                 q->write_actual = (q->write & ~0x7);
 161                 iwl_legacy_write_direct32(priv, rx_wrt_ptr_reg,
 162                         q->write_actual);
 163         }
 164
 165         q->need_update = 0;
 166
 167  exit_unlock:
 168         spin_unlock_irqrestore(&q->lock, flags);
 169 }
 170 EXPORT_SYMBOL(iwl_legacy_rx_queue_update_write_ptr);
 171
 172 int iwl_legacy_rx_queue_alloc(struct iwl_priv *priv)
 173 {
 174         struct iwl_rx_queue *rxq = &priv->rxq;
 175         struct device *dev = &priv->pci_dev->dev;
 176         int i;
 177
 178         spin_lock_init(&rxq->lock);
 179         INIT_LIST_HEAD(&rxq->rx_free);
 180         INIT_LIST_HEAD(&rxq->rx_used);
 181
 182         /* Alloc the circular buffer of Read Buffer Descriptors (RBDs) */
 183         rxq->bd = dma_alloc_coherent(dev, 4 * RX_QUEUE_SIZE, &rxq->bd_dma,
 184                                      GFP_KERNEL);
 185         if (!rxq->bd)
 186                 goto err_bd;
 187
 188         rxq->rb_stts = dma_alloc_coherent(dev, sizeof(struct iwl_rb_status),
 189                                           &rxq->rb_stts_dma, GFP_KERNEL);
 190         if (!rxq->rb_stts)
 191                 goto err_rb;
 192
 193         /* Fill the rx_used queue with _all_ of the Rx buffers */
 194         for (i = 0; i < RX_FREE_BUFFERS + RX_QUEUE_SIZE; i++)
 195                 list_add_tail(&rxq->pool[i].list, &rxq->rx_used);
 196
 197         /* Set us so that we have processed and used all buffers, but have
 198          * not restocked the Rx queue with fresh buffers */
 199         rxq->read = rxq->write = 0;
 200         rxq->write_actual = 0;
 201         rxq->free_count = 0;
 202         rxq->need_update = 0;
 203         return 0;
 204
 205 err_rb:
 206         dma_free_coherent(&priv->pci_dev->dev, 4 * RX_QUEUE_SIZE, rxq->bd,
 207                           rxq->bd_dma);
 208 err_bd:
 209         return -ENOMEM;
 210 }
 211 EXPORT_SYMBOL(iwl_legacy_rx_queue_alloc);
 212
 213
 214 void iwl_legacy_rx_spectrum_measure_notif(struct iwl_priv *priv,
 215                                           struct iwl_rx_mem_buffer *rxb)
 216 {
 217         struct iwl_rx_packet *pkt = rxb_addr(rxb);
 218         struct iwl_spectrum_notification *report = &(pkt->u.spectrum_notif);
 219
 220         if (!report->state) {
 221                 IWL_DEBUG_11H(priv,
 222                         "Spectrum Measure Notification: Start\n");
 223                 return;
 224         }
 225
 226         memcpy(&priv->measure_report, report, sizeof(*report));
 227         priv->measurement_status |= MEASUREMENT_READY;
 228 }
 229 EXPORT_SYMBOL(iwl_legacy_rx_spectrum_measure_notif);
 230
 231 /*
 232  * returns non-zero if packet should be dropped
 233  */
 234 int iwl_legacy_set_decrypted_flag(struct iwl_priv *priv,
 235                            struct ieee80211_hdr *hdr,
 236                            u32 decrypt_res,
 237                            struct ieee80211_rx_status *stats)
 238 {
 239         u16 fc = le16_to_cpu(hdr->frame_control);
 240
 241         /*
 242          * All contexts have the same setting here due to it being
 243          * a module parameter, so OK to check any context.
 244          */
 245         if (priv->contexts[IWL_RXON_CTX_BSS].active.filter_flags &
 246                                                 RXON_FILTER_DIS_DECRYPT_MSK)
 247                 return 0;
 248
 249         if (!(fc & IEEE80211_FCTL_PROTECTED))
 250                 return 0;
 251
 252         IWL_DEBUG_RX(priv, "decrypt_res:0x%x\n", decrypt_res);
 253         switch (decrypt_res & RX_RES_STATUS_SEC_TYPE_MSK) {
 254         case RX_RES_STATUS_SEC_TYPE_TKIP:
 255                 /* The uCode has got a bad phase 1 Key, pushes the packet.
 256                  * Decryption will be done in SW. */
 257                 if ((decrypt_res & RX_RES_STATUS_DECRYPT_TYPE_MSK) ==
 258                     RX_RES_STATUS_BAD_KEY_TTAK)
 259                         break;
 260
 261         case RX_RES_STATUS_SEC_TYPE_WEP:
 262                 if ((decrypt_res & RX_RES_STATUS_DECRYPT_TYPE_MSK) ==
 263                     RX_RES_STATUS_BAD_ICV_MIC) {
 264                         /* bad ICV, the packet is destroyed since the
 265                          * decryption is inplace, drop it */
 266                         IWL_DEBUG_RX(priv, "Packet destroyed\n");
 267                         return -1;
 268                 }
 269         case RX_RES_STATUS_SEC_TYPE_CCMP:
 270                 if ((decrypt_res & RX_RES_STATUS_DECRYPT_TYPE_MSK) ==
 271                     RX_RES_STATUS_DECRYPT_OK) {
 272                         IWL_DEBUG_RX(priv, "hw decrypt successfully!!!\n");
 273                         stats->flag |= RX_FLAG_DECRYPTED;
 274                 }
 275                 break;
 276
 277         default:
 278                 break;
 279         }
 280         return 0;
 281 }
 282 EXPORT_SYMBOL(iwl_legacy_set_decrypted_flag);