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