drivers/net/wireless/ti/wlcore/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_MGMT_PKT_LIFETIME_TU       2000
  29 #define TX_HW_AP_MODE_PKT_LIFETIME_TU    8000
  30
  31 #define TX_HW_ATTR_SAVE_RETRIES          BIT(0)
  32 #define TX_HW_ATTR_HEADER_PAD            BIT(1)
  33 #define TX_HW_ATTR_SESSION_COUNTER       (BIT(2) | BIT(3) | BIT(4))
  34 #define TX_HW_ATTR_RATE_POLICY           (BIT(5) | BIT(6) | BIT(7) | \
  35                                           BIT(8) | BIT(9))
  36 #define TX_HW_ATTR_LAST_WORD_PAD         (BIT(10) | BIT(11))
  37 #define TX_HW_ATTR_TX_CMPLT_REQ          BIT(12)
  38 #define TX_HW_ATTR_TX_DUMMY_REQ          BIT(13)
  39 #define TX_HW_ATTR_HOST_ENCRYPT          BIT(14)
  40
  41 #define TX_HW_ATTR_OFST_SAVE_RETRIES     0
  42 #define TX_HW_ATTR_OFST_HEADER_PAD       1
  43 #define TX_HW_ATTR_OFST_SESSION_COUNTER  2
  44 #define TX_HW_ATTR_OFST_RATE_POLICY      5
  45 #define TX_HW_ATTR_OFST_LAST_WORD_PAD    10
  46 #define TX_HW_ATTR_OFST_TX_CMPLT_REQ     12
  47
  48 #define TX_HW_RESULT_QUEUE_LEN           16
  49 #define TX_HW_RESULT_QUEUE_LEN_MASK      0xf
  50
  51 #define WL1271_TX_ALIGN_TO 4
  52 #define WL1271_EXTRA_SPACE_TKIP 4
  53 #define WL1271_EXTRA_SPACE_AES  8
  54 #define WL1271_EXTRA_SPACE_MAX  8
  55
  56 /* Used for management frames and dummy packets */
  57 #define WL1271_TID_MGMT 7
  58
  59 struct wl127x_tx_mem {
  60         /*
  61          * Number of extra memory blocks to allocate for this packet
  62          * in addition to the number of blocks derived from the packet
  63          * length.
  64          */
  65         u8 extra_blocks;
  66         /*
  67          * Total number of memory blocks allocated by the host for
  68          * this packet. Must be equal or greater than the actual
  69          * blocks number allocated by HW.
  70          */
  71         u8 total_mem_blocks;
  72 } __packed;
  73
  74 struct wl128x_tx_mem {
  75         /*
  76          * Total number of memory blocks allocated by the host for
  77          * this packet.
  78          */
  79         u8 total_mem_blocks;
  80         /*
  81          * Number of extra bytes, at the end of the frame. the host
  82          * uses this padding to complete each frame to integer number
  83          * of SDIO blocks.
  84          */
  85         u8 extra_bytes;
  86 } __packed;
  87
  88 struct wl18xx_tx_mem {
  89         /*
  90          * Total number of memory blocks allocated by the host for
  91          * this packet.
  92          */
  93         u8 total_mem_blocks;
  94
  95         /*
  96          * control bits
  97          */
  98         u8 ctrl;
  99 } __packed;
 100
 101 /*
 102  * On wl128x based devices, when TX packets are aggregated, each packet
 103  * size must be aligned to the SDIO block size. The maximum block size
 104  * is bounded by the type of the padded bytes field that is sent to the
 105  * FW. Currently the type is u8, so the maximum block size is 256 bytes.
 106  */
 107 #define WL12XX_BUS_BLOCK_SIZE min(512u, \
 108             (1u << (8 * sizeof(((struct wl128x_tx_mem *) 0)->extra_bytes))))
 109
 110 struct wl1271_tx_hw_descr {
 111         /* Length of packet in words, including descriptor+header+data */
 112         __le16 length;
 113         union {
 114                 struct wl127x_tx_mem wl127x_mem;
 115                 struct wl128x_tx_mem wl128x_mem;
 116                 struct wl18xx_tx_mem wl18xx_mem;
 117         } __packed;
 118         /* Device time (in us) when the packet arrived to the driver */
 119         __le32 start_time;
 120         /*
 121          * Max delay in TUs until transmission. The last device time the
 122          * packet can be transmitted is: start_time + (1024 * life_time)
 123          */
 124         __le16 life_time;
 125         /* Bitwise fields - see TX_ATTR... definitions above. */
 126         __le16 tx_attr;
 127         /* Packet identifier used also in the Tx-Result. */
 128         u8 id;
 129         /* The packet TID value (as User-Priority) */
 130         u8 tid;
 131         /* host link ID (HLID) */
 132         u8 hlid;
 133
 134         union {
 135                 u8 wl12xx_reserved;
 136
 137                 /*
 138                  * bit 0   -> 0 = udp, 1 = tcp
 139                  * bit 1:7 -> IP header offset
 140                  */
 141                 u8 wl18xx_checksum_data;
 142         } __packed;
 143 } __packed;
 144
 145 enum wl1271_tx_hw_res_status {
 146         TX_SUCCESS          = 0,
 147         TX_HW_ERROR         = 1,
 148         TX_DISABLED         = 2,
 149         TX_RETRY_EXCEEDED   = 3,
 150         TX_TIMEOUT          = 4,
 151         TX_KEY_NOT_FOUND    = 5,
 152         TX_PEER_NOT_FOUND   = 6,
 153         TX_SESSION_MISMATCH = 7,
 154         TX_LINK_NOT_VALID   = 8,
 155 };
 156
 157 struct wl1271_tx_hw_res_descr {
 158         /* Packet Identifier - same value used in the Tx descriptor.*/
 159         u8 id;
 160         /* The status of the transmission, indicating success or one of
 161            several possible reasons for failure. */
 162         u8 status;
 163         /* Total air access duration including all retrys and overheads.*/
 164         __le16 medium_usage;
 165         /* The time passed from host xfer to Tx-complete.*/
 166         __le32 fw_handling_time;
 167         /* Total media delay
 168            (from 1st EDCA AIFS counter until TX Complete). */
 169         __le32 medium_delay;
 170         /* LS-byte of last TKIP seq-num (saved per AC for recovery). */
 171         u8 tx_security_sequence_number_lsb;
 172         /* Retry count - number of transmissions without successful ACK.*/
 173         u8 ack_failures;
 174         /* The rate that succeeded getting ACK
 175            (Valid only if status=SUCCESS). */
 176         u8 rate_class_index;
 177         /* for 4-byte alignment. */
 178         u8 spare;
 179 } __packed;
 180
 181 struct wl1271_tx_hw_res_if {
 182         __le32 tx_result_fw_counter;
 183         __le32 tx_result_host_counter;
 184         struct wl1271_tx_hw_res_descr tx_results_queue[TX_HW_RESULT_QUEUE_LEN];
 185 } __packed;
 186
 187 enum wlcore_queue_stop_reason {
 188         WLCORE_QUEUE_STOP_REASON_WATERMARK,
 189         WLCORE_QUEUE_STOP_REASON_FW_RESTART,
 190         WLCORE_QUEUE_STOP_REASON_FLUSH,
 191         WLCORE_QUEUE_STOP_REASON_SPARE_BLK, /* 18xx specific */
 192 };
 193
 194 static inline int wl1271_tx_get_queue(int queue)
 195 {
 196         switch (queue) {
 197         case 0:
 198                 return CONF_TX_AC_VO;
 199         case 1:
 200                 return CONF_TX_AC_VI;
 201         case 2:
 202                 return CONF_TX_AC_BE;
 203         case 3:
 204                 return CONF_TX_AC_BK;
 205         default:
 206                 return CONF_TX_AC_BE;
 207         }
 208 }
 209
 210 static inline
 211 int wlcore_tx_get_mac80211_queue(struct wl12xx_vif *wlvif, int queue)
 212 {
 213         int mac_queue = wlvif->hw_queue_base;
 214
 215         switch (queue) {
 216         case CONF_TX_AC_VO:
 217                 return mac_queue + 0;
 218         case CONF_TX_AC_VI:
 219                 return mac_queue + 1;
 220         case CONF_TX_AC_BE:
 221                 return mac_queue + 2;
 222         case CONF_TX_AC_BK:
 223                 return mac_queue + 3;
 224         default:
 225                 return mac_queue + 2;
 226         }
 227 }
 228
 229 static inline int wl1271_tx_total_queue_count(struct wl1271 *wl)
 230 {
 231         int i, count = 0;
 232
 233         for (i = 0; i < NUM_TX_QUEUES; i++)
 234                 count += wl->tx_queue_count[i];
 235
 236         return count;
 237 }
 238
 239 void wl1271_tx_work(struct work_struct *work);
 240 int wlcore_tx_work_locked(struct wl1271 *wl);
 241 int wlcore_tx_complete(struct wl1271 *wl);
 242 void wl12xx_tx_reset_wlvif(struct wl1271 *wl, struct wl12xx_vif *wlvif);
 243 void wl12xx_tx_reset(struct wl1271 *wl);
 244 void wl1271_tx_flush(struct wl1271 *wl);
 245 u8 wlcore_rate_to_idx(struct wl1271 *wl, u8 rate, enum ieee80211_band band);
 246 u32 wl1271_tx_enabled_rates_get(struct wl1271 *wl, u32 rate_set,
 247                                 enum ieee80211_band rate_band);
 248 u32 wl1271_tx_min_rate_get(struct wl1271 *wl, u32 rate_set);
 249 u8 wl12xx_tx_get_hlid(struct wl1271 *wl, struct wl12xx_vif *wlvif,
 250                       struct sk_buff *skb, struct ieee80211_sta *sta);
 251 void wl1271_tx_reset_link_queues(struct wl1271 *wl, u8 hlid);
 252 void wl1271_handle_tx_low_watermark(struct wl1271 *wl);
 253 bool wl12xx_is_dummy_packet(struct wl1271 *wl, struct sk_buff *skb);
 254 void wl12xx_rearm_rx_streaming(struct wl1271 *wl, unsigned long *active_hlids);
 255 unsigned int wlcore_calc_packet_alignment(struct wl1271 *wl,
 256                                           unsigned int packet_length);
 257 void wl1271_free_tx_id(struct wl1271 *wl, int id);
 258 void wlcore_stop_queue_locked(struct wl1271 *wl, struct wl12xx_vif *wlvif,
 259                               u8 queue, enum wlcore_queue_stop_reason reason);
 260 void wlcore_stop_queue(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 queue,
 261                        enum wlcore_queue_stop_reason reason);
 262 void wlcore_wake_queue(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 queue,
 263                        enum wlcore_queue_stop_reason reason);
 264 void wlcore_stop_queues(struct wl1271 *wl,
 265                         enum wlcore_queue_stop_reason reason);
 266 void wlcore_wake_queues(struct wl1271 *wl,
 267                         enum wlcore_queue_stop_reason reason);
 268 bool wlcore_is_queue_stopped_by_reason(struct wl1271 *wl,
 269                                        struct wl12xx_vif *wlvif, u8 queue,
 270                                        enum wlcore_queue_stop_reason reason);
 271 bool
 272 wlcore_is_queue_stopped_by_reason_locked(struct wl1271 *wl,
 273                                          struct wl12xx_vif *wlvif,
 274                                          u8 queue,
 275                                          enum wlcore_queue_stop_reason reason);
 276 bool wlcore_is_queue_stopped_locked(struct wl1271 *wl, struct wl12xx_vif *wlvif,
 277                                     u8 queue);
 278
 279 /* from main.c */
 280 void wl1271_free_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 hlid);
 281 void wl12xx_rearm_tx_watchdog_locked(struct wl1271 *wl);
 282
 283 #endif