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 /* The chipset reference driver states, that the "aid" value 1
  33  * is for infra-BSS, but is still always used */
  34 #define TX_HW_DEFAULT_AID                1
  35
  36 #define TX_HW_ATTR_SAVE_RETRIES          BIT(0)
  37 #define TX_HW_ATTR_HEADER_PAD            BIT(1)
  38 #define TX_HW_ATTR_SESSION_COUNTER       (BIT(2) | BIT(3) | BIT(4))
  39 #define TX_HW_ATTR_RATE_POLICY           (BIT(5) | BIT(6) | BIT(7) | \
  40                                           BIT(8) | BIT(9))
  41 #define TX_HW_ATTR_LAST_WORD_PAD         (BIT(10) | BIT(11))
  42 #define TX_HW_ATTR_TX_CMPLT_REQ          BIT(12)
  43 #define TX_HW_ATTR_TX_DUMMY_REQ          BIT(13)
  44
  45 #define TX_HW_ATTR_OFST_SAVE_RETRIES     0
  46 #define TX_HW_ATTR_OFST_HEADER_PAD       1
  47 #define TX_HW_ATTR_OFST_SESSION_COUNTER  2
  48 #define TX_HW_ATTR_OFST_RATE_POLICY      5
  49 #define TX_HW_ATTR_OFST_LAST_WORD_PAD    10
  50 #define TX_HW_ATTR_OFST_TX_CMPLT_REQ     12
  51
  52 #define TX_HW_RESULT_QUEUE_LEN           16
  53 #define TX_HW_RESULT_QUEUE_LEN_MASK      0xf
  54
  55 #define WL1271_TX_ALIGN_TO 4
  56 #define WL1271_TKIP_IV_SPACE 4
  57
  58 /* Used for management frames and dummy packets */
  59 #define WL1271_TID_MGMT 7
  60
  61 struct wl127x_tx_mem {
  62         /*
  63          * Number of extra memory blocks to allocate for this packet
  64          * in addition to the number of blocks derived from the packet
  65          * length.
  66          */
  67         u8 extra_blocks;
  68         /*
  69          * Total number of memory blocks allocated by the host for
  70          * this packet. Must be equal or greater than the actual
  71          * blocks number allocated by HW.
  72          */
  73         u8 total_mem_blocks;
  74 } __packed;
  75
  76 struct wl128x_tx_mem {
  77         /*
  78          * Total number of memory blocks allocated by the host for
  79          * this packet.
  80          */
  81         u8 total_mem_blocks;
  82         /*
  83          * Number of extra bytes, at the end of the frame. the host
  84          * uses this padding to complete each frame to integer number
  85          * of SDIO blocks.
  86          */
  87         u8 extra_bytes;
  88 } __packed;
  89
  90 /*
  91  * On wl128x based devices, when TX packets are aggregated, each packet
  92  * size must be aligned to the SDIO block size. The maximum block size
  93  * is bounded by the type of the padded bytes field that is sent to the
  94  * FW. Currently the type is u8, so the maximum block size is 256 bytes.
  95  */
  96 #define WL12XX_BUS_BLOCK_SIZE min(512u, \
  97             (1u << (8 * sizeof(((struct wl128x_tx_mem *) 0)->extra_bytes))))
  98
  99 struct wl1271_tx_hw_descr {
 100         /* Length of packet in words, including descriptor+header+data */
 101         __le16 length;
 102         union {
 103                 struct wl127x_tx_mem wl127x_mem;
 104                 struct wl128x_tx_mem wl128x_mem;
 105         } __packed;
 106         /* Device time (in us) when the packet arrived to the driver */
 107         __le32 start_time;
 108         /*
 109          * Max delay in TUs until transmission. The last device time the
 110          * packet can be transmitted is: start_time + (1024 * life_time)
 111          */
 112         __le16 life_time;
 113         /* Bitwise fields - see TX_ATTR... definitions above. */
 114         __le16 tx_attr;
 115         /* Packet identifier used also in the Tx-Result. */
 116         u8 id;
 117         /* The packet TID value (as User-Priority) */
 118         u8 tid;
 119         union {
 120                 /* STA - Identifier of the remote STA in IBSS, 1 in infra-BSS */
 121                 u8 aid;
 122                 /* AP - host link ID (HLID) */
 123                 u8 hlid;
 124         } __packed;
 125         u8 reserved;
 126 } __packed;
 127
 128 enum wl1271_tx_hw_res_status {
 129         TX_SUCCESS          = 0,
 130         TX_HW_ERROR         = 1,
 131         TX_DISABLED         = 2,
 132         TX_RETRY_EXCEEDED   = 3,
 133         TX_TIMEOUT          = 4,
 134         TX_KEY_NOT_FOUND    = 5,
 135         TX_PEER_NOT_FOUND   = 6,
 136         TX_SESSION_MISMATCH = 7
 137 };
 138
 139 struct wl1271_tx_hw_res_descr {
 140         /* Packet Identifier - same value used in the Tx descriptor.*/
 141         u8 id;
 142         /* The status of the transmission, indicating success or one of
 143            several possible reasons for failure. */
 144         u8 status;
 145         /* Total air access duration including all retrys and overheads.*/
 146         __le16 medium_usage;
 147         /* The time passed from host xfer to Tx-complete.*/
 148         __le32 fw_handling_time;
 149         /* Total media delay
 150            (from 1st EDCA AIFS counter until TX Complete). */
 151         __le32 medium_delay;
 152         /* LS-byte of last TKIP seq-num (saved per AC for recovery). */
 153         u8 tx_security_sequence_number_lsb;
 154         /* Retry count - number of transmissions without successful ACK.*/
 155         u8 ack_failures;
 156         /* The rate that succeeded getting ACK
 157            (Valid only if status=SUCCESS). */
 158         u8 rate_class_index;
 159         /* for 4-byte alignment. */
 160         u8 spare;
 161 } __packed;
 162
 163 struct wl1271_tx_hw_res_if {
 164         __le32 tx_result_fw_counter;
 165         __le32 tx_result_host_counter;
 166         struct wl1271_tx_hw_res_descr tx_results_queue[TX_HW_RESULT_QUEUE_LEN];
 167 } __packed;
 168
 169 static inline int wl1271_tx_get_queue(int queue)
 170 {
 171         switch (queue) {
 172         case 0:
 173                 return CONF_TX_AC_VO;
 174         case 1:
 175                 return CONF_TX_AC_VI;
 176         case 2:
 177                 return CONF_TX_AC_BE;
 178         case 3:
 179                 return CONF_TX_AC_BK;
 180         default:
 181                 return CONF_TX_AC_BE;
 182         }
 183 }
 184
 185 static inline int wl1271_tx_get_mac80211_queue(int queue)
 186 {
 187         switch (queue) {
 188         case CONF_TX_AC_VO:
 189                 return 0;
 190         case CONF_TX_AC_VI:
 191                 return 1;
 192         case CONF_TX_AC_BE:
 193                 return 2;
 194         case CONF_TX_AC_BK:
 195                 return 3;
 196         default:
 197                 return 2;
 198         }
 199 }
 200
 201 static inline int wl1271_tx_total_queue_count(struct wl1271 *wl)
 202 {
 203         int i, count = 0;
 204
 205         for (i = 0; i < NUM_TX_QUEUES; i++)
 206                 count += wl->tx_queue_count[i];
 207
 208         return count;
 209 }
 210
 211 void wl1271_tx_work(struct work_struct *work);
 212 void wl1271_tx_work_locked(struct wl1271 *wl);
 213 void wl1271_tx_complete(struct wl1271 *wl);
 214 void wl1271_tx_reset(struct wl1271 *wl, bool reset_tx_queues);
 215 void wl1271_tx_flush(struct wl1271 *wl);
 216 u8 wl1271_rate_to_idx(int rate, enum ieee80211_band band);
 217 u32 wl1271_tx_enabled_rates_get(struct wl1271 *wl, u32 rate_set);
 218 u32 wl1271_tx_min_rate_get(struct wl1271 *wl);
 219 u8 wl1271_tx_get_hlid(struct sk_buff *skb);
 220 void wl1271_tx_reset_link_queues(struct wl1271 *wl, u8 hlid);
 221 void wl1271_handle_tx_low_watermark(struct wl1271 *wl);
 222
 223 #endif