drivers/net/wireless/wl12xx/tx.h

   1 /*
   2  * This file is part of wl1271
   3  *
   4  * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
   5  * Copyright (C) 2009 Nokia Corporation
   6  *
   7  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * version 2 as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  *
  23  */
  24
  25 #ifndef __TX_H__
  26 #define __TX_H__
  27
  28 #define TX_HW_BLOCK_SIZE                 252
  29
  30 #define TX_HW_MGMT_PKT_LIFETIME_TU       2000
  31 #define TX_HW_AP_MODE_PKT_LIFETIME_TU    8000
  32
  33 #define TX_HW_ATTR_SAVE_RETRIES          BIT(0)
  34 #define TX_HW_ATTR_HEADER_PAD            BIT(1)
  35 #define TX_HW_ATTR_SESSION_COUNTER       (BIT(2) | BIT(3) | BIT(4))
  36 #define TX_HW_ATTR_RATE_POLICY           (BIT(5) | BIT(6) | BIT(7) | \
  37                                           BIT(8) | BIT(9))
  38 #define TX_HW_ATTR_LAST_WORD_PAD         (BIT(10) | BIT(11))
  39 #define TX_HW_ATTR_TX_CMPLT_REQ          BIT(12)
  40 #define TX_HW_ATTR_TX_DUMMY_REQ          BIT(13)
  41
  42 #define TX_HW_ATTR_OFST_SAVE_RETRIES     0
  43 #define TX_HW_ATTR_OFST_HEADER_PAD       1
  44 #define TX_HW_ATTR_OFST_SESSION_COUNTER  2
  45 #define TX_HW_ATTR_OFST_RATE_POLICY      5
  46 #define TX_HW_ATTR_OFST_LAST_WORD_PAD    10
  47 #define TX_HW_ATTR_OFST_TX_CMPLT_REQ     12
  48
  49 #define TX_HW_RESULT_QUEUE_LEN           16
  50 #define TX_HW_RESULT_QUEUE_LEN_MASK      0xf
  51
  52 #define WL1271_TX_ALIGN_TO 4
  53 #define WL1271_TKIP_IV_SPACE 4
  54
  55 /* Used for management frames and dummy packets */
  56 #define WL1271_TID_MGMT 7
  57
  58 struct wl127x_tx_mem {
  59         /*
  60          * Number of extra memory blocks to allocate for this packet
  61          * in addition to the number of blocks derived from the packet
  62          * length.
  63          */
  64         u8 extra_blocks;
  65         /*
  66          * Total number of memory blocks allocated by the host for
  67          * this packet. Must be equal or greater than the actual
  68          * blocks number allocated by HW.
  69          */
  70         u8 total_mem_blocks;
  71 } __packed;
  72
  73 struct wl128x_tx_mem {
  74         /*
  75          * Total number of memory blocks allocated by the host for
  76          * this packet.
  77          */
  78         u8 total_mem_blocks;
  79         /*
  80          * Number of extra bytes, at the end of the frame. the host
  81          * uses this padding to complete each frame to integer number
  82          * of SDIO blocks.
  83          */
  84         u8 extra_bytes;
  85 } __packed;
  86
  87 /*
  88  * On wl128x based devices, when TX packets are aggregated, each packet
  89  * size must be aligned to the SDIO block size. The maximum block size
  90  * is bounded by the type of the padded bytes field that is sent to the
  91  * FW. Currently the type is u8, so the maximum block size is 256 bytes.
  92  */
  93 #define WL12XX_BUS_BLOCK_SIZE min(512u, \
  94             (1u << (8 * sizeof(((struct wl128x_tx_mem *) 0)->extra_bytes))))
  95
  96 struct wl1271_tx_hw_descr {
  97         /* Length of packet in words, including descriptor+header+data */
  98         __le16 length;
  99         union {
 100                 struct wl127x_tx_mem wl127x_mem;
 101                 struct wl128x_tx_mem wl128x_mem;
 102         } __packed;
 103         /* Device time (in us) when the packet arrived to the driver */
 104         __le32 start_time;
 105         /*
 106          * Max delay in TUs until transmission. The last device time the
 107          * packet can be transmitted is: start_time + (1024 * life_time)
 108          */
 109         __le16 life_time;
 110         /* Bitwise fields - see TX_ATTR... definitions above. */
 111         __le16 tx_attr;
 112         /* Packet identifier used also in the Tx-Result. */
 113         u8 id;
 114         /* The packet TID value (as User-Priority) */
 115         u8 tid;
 116         /* host link ID (HLID) */
 117         u8 hlid;
 118         u8 reserved;
 119 } __packed;
 120
 121 enum wl1271_tx_hw_res_status {
 122         TX_SUCCESS          = 0,
 123         TX_HW_ERROR         = 1,
 124         TX_DISABLED         = 2,
 125         TX_RETRY_EXCEEDED   = 3,
 126         TX_TIMEOUT          = 4,
 127         TX_KEY_NOT_FOUND    = 5,
 128         TX_PEER_NOT_FOUND   = 6,
 129         TX_SESSION_MISMATCH = 7,
 130         TX_LINK_NOT_VALID   = 8,
 131 };
 132
 133 struct wl1271_tx_hw_res_descr {
 134         /* Packet Identifier - same value used in the Tx descriptor.*/
 135         u8 id;
 136         /* The status of the transmission, indicating success or one of
 137            several possible reasons for failure. */
 138         u8 status;
 139         /* Total air access duration including all retrys and overheads.*/
 140         __le16 medium_usage;
 141         /* The time passed from host xfer to Tx-complete.*/
 142         __le32 fw_handling_time;
 143         /* Total media delay
 144            (from 1st EDCA AIFS counter until TX Complete). */
 145         __le32 medium_delay;
 146         /* LS-byte of last TKIP seq-num (saved per AC for recovery). */
 147         u8 tx_security_sequence_number_lsb;
 148         /* Retry count - number of transmissions without successful ACK.*/
 149         u8 ack_failures;
 150         /* The rate that succeeded getting ACK
 151            (Valid only if status=SUCCESS). */
 152         u8 rate_class_index;
 153         /* for 4-byte alignment. */
 154         u8 spare;
 155 } __packed;
 156
 157 struct wl1271_tx_hw_res_if {
 158         __le32 tx_result_fw_counter;
 159         __le32 tx_result_host_counter;
 160         struct wl1271_tx_hw_res_descr tx_results_queue[TX_HW_RESULT_QUEUE_LEN];
 161 } __packed;
 162
 163 static inline int wl1271_tx_get_queue(int queue)
 164 {
 165         switch (queue) {
 166         case 0:
 167                 return CONF_TX_AC_VO;
 168         case 1:
 169                 return CONF_TX_AC_VI;
 170         case 2:
 171                 return CONF_TX_AC_BE;
 172         case 3:
 173                 return CONF_TX_AC_BK;
 174         default:
 175                 return CONF_TX_AC_BE;
 176         }
 177 }
 178
 179 static inline int wl1271_tx_get_mac80211_queue(int queue)
 180 {
 181         switch (queue) {
 182         case CONF_TX_AC_VO:
 183                 return 0;
 184         case CONF_TX_AC_VI:
 185                 return 1;
 186         case CONF_TX_AC_BE:
 187                 return 2;
 188         case CONF_TX_AC_BK:
 189                 return 3;
 190         default:
 191                 return 2;
 192         }
 193 }
 194
 195 static inline int wl1271_tx_total_queue_count(struct wl1271 *wl)
 196 {
 197         int i, count = 0;
 198
 199         for (i = 0; i < NUM_TX_QUEUES; i++)
 200                 count += wl->tx_queue_count[i];
 201
 202         return count;
 203 }
 204
 205 void wl1271_tx_work(struct work_struct *work);
 206 void wl1271_tx_work_locked(struct wl1271 *wl);
 207 void wl1271_tx_complete(struct wl1271 *wl);
 208 void wl1271_tx_reset(struct wl1271 *wl, bool reset_tx_queues);
 209 void wl1271_tx_flush(struct wl1271 *wl);
 210 u8 wl1271_rate_to_idx(int rate, enum ieee80211_band band);
 211 u32 wl1271_tx_enabled_rates_get(struct wl1271 *wl, u32 rate_set);
 212 u32 wl1271_tx_min_rate_get(struct wl1271 *wl);
 213 u8 wl12xx_tx_get_hlid_ap(struct wl1271 *wl, struct sk_buff *skb);
 214 void wl1271_tx_reset_link_queues(struct wl1271 *wl, u8 hlid);
 215 void wl1271_handle_tx_low_watermark(struct wl1271 *wl);
 216
 217 #endif