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_SPARE_DEFAULT 1
29 #define TX_HW_BLOCK_SIZE 252
30
31 #define TX_HW_MGMT_PKT_LIFETIME_TU 2000
32 #define TX_HW_AP_MODE_PKT_LIFETIME_TU 8000
33
34 #define TX_HW_ATTR_SAVE_RETRIES BIT(0)
35 #define TX_HW_ATTR_HEADER_PAD BIT(1)
36 #define TX_HW_ATTR_SESSION_COUNTER (BIT(2) | BIT(3) | BIT(4))
37 #define TX_HW_ATTR_RATE_POLICY (BIT(5) | BIT(6) | BIT(7) | \
38 BIT(8) | BIT(9))
39 #define TX_HW_ATTR_LAST_WORD_PAD (BIT(10) | BIT(11))
40 #define TX_HW_ATTR_TX_CMPLT_REQ BIT(12)
41 #define TX_HW_ATTR_TX_DUMMY_REQ BIT(13)
42
43 #define TX_HW_ATTR_OFST_SAVE_RETRIES 0
44 #define TX_HW_ATTR_OFST_HEADER_PAD 1
45 #define TX_HW_ATTR_OFST_SESSION_COUNTER 2
46 #define TX_HW_ATTR_OFST_RATE_POLICY 5
47 #define TX_HW_ATTR_OFST_LAST_WORD_PAD 10
48 #define TX_HW_ATTR_OFST_TX_CMPLT_REQ 12
49
50 #define TX_HW_RESULT_QUEUE_LEN 16
51 #define TX_HW_RESULT_QUEUE_LEN_MASK 0xf
52
53 #define WL1271_TX_ALIGN_TO 4
54 #define WL1271_TKIP_IV_SPACE 4
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 /*
89 * On wl128x based devices, when TX packets are aggregated, each packet
90 * size must be aligned to the SDIO block size. The maximum block size
91 * is bounded by the type of the padded bytes field that is sent to the
92 * FW. Currently the type is u8, so the maximum block size is 256 bytes.
93 */
94 #define WL12XX_BUS_BLOCK_SIZE min(512u, \
95 (1u << (8 * sizeof(((struct wl128x_tx_mem *) 0)->extra_bytes))))
96
97 struct wl1271_tx_hw_descr {
98 /* Length of packet in words, including descriptor+header+data */
99 __le16 length;
100 union {
101 struct wl127x_tx_mem wl127x_mem;
102 struct wl128x_tx_mem wl128x_mem;
103 } __packed;
104 /* Device time (in us) when the packet arrived to the driver */
105 __le32 start_time;
106 /*
107 * Max delay in TUs until transmission. The last device time the
108 * packet can be transmitted is: start_time + (1024 * life_time)
109 */
110 __le16 life_time;
111 /* Bitwise fields - see TX_ATTR... definitions above. */
112 __le16 tx_attr;
113 /* Packet identifier used also in the Tx-Result. */
114 u8 id;
115 /* The packet TID value (as User-Priority) */
116 u8 tid;
117 /* host link ID (HLID) */
118 u8 hlid;
119 u8 reserved;
120 } __packed;
121
122 enum wl1271_tx_hw_res_status {
123 TX_SUCCESS = 0,
124 TX_HW_ERROR = 1,
125 TX_DISABLED = 2,
126 TX_RETRY_EXCEEDED = 3,
127 TX_TIMEOUT = 4,
128 TX_KEY_NOT_FOUND = 5,
129 TX_PEER_NOT_FOUND = 6,
130 TX_SESSION_MISMATCH = 7,
131 TX_LINK_NOT_VALID = 8,
132 };
133
134 struct wl1271_tx_hw_res_descr {
135 /* Packet Identifier - same value used in the Tx descriptor.*/
136 u8 id;
137 /* The status of the transmission, indicating success or one of
138 several possible reasons for failure. */
139 u8 status;
140 /* Total air access duration including all retrys and overheads.*/
141 __le16 medium_usage;
142 /* The time passed from host xfer to Tx-complete.*/
143 __le32 fw_handling_time;
144 /* Total media delay
145 (from 1st EDCA AIFS counter until TX Complete). */
146 __le32 medium_delay;
147 /* LS-byte of last TKIP seq-num (saved per AC for recovery). */
148 u8 tx_security_sequence_number_lsb;
149 /* Retry count - number of transmissions without successful ACK.*/
150 u8 ack_failures;
151 /* The rate that succeeded getting ACK
152 (Valid only if status=SUCCESS). */
153 u8 rate_class_index;
154 /* for 4-byte alignment. */
155 u8 spare;
156 } __packed;
157
158 struct wl1271_tx_hw_res_if {
159 __le32 tx_result_fw_counter;
160 __le32 tx_result_host_counter;
161 struct wl1271_tx_hw_res_descr tx_results_queue[TX_HW_RESULT_QUEUE_LEN];
162 } __packed;
163
wl1271_tx_get_queue(int queue)164 static inline int wl1271_tx_get_queue(int queue)
165 {
166 switch (queue) {
167 case 0:
168 return CONF_TX_AC_VO;
169 case 1:
170 return CONF_TX_AC_VI;
171 case 2:
172 return CONF_TX_AC_BE;
173 case 3:
174 return CONF_TX_AC_BK;
175 default:
176 return CONF_TX_AC_BE;
177 }
178 }
179
wl1271_tx_get_mac80211_queue(int queue)180 static inline int wl1271_tx_get_mac80211_queue(int queue)
181 {
182 switch (queue) {
183 case CONF_TX_AC_VO:
184 return 0;
185 case CONF_TX_AC_VI:
186 return 1;
187 case CONF_TX_AC_BE:
188 return 2;
189 case CONF_TX_AC_BK:
190 return 3;
191 default:
192 return 2;
193 }
194 }
195
wl1271_tx_total_queue_count(struct wl1271 * wl)196 static inline int wl1271_tx_total_queue_count(struct wl1271 *wl)
197 {
198 int i, count = 0;
199
200 for (i = 0; i < NUM_TX_QUEUES; i++)
201 count += wl->tx_queue_count[i];
202
203 return count;
204 }
205
206 void wl1271_tx_work(struct work_struct *work);
207 void wl1271_tx_work_locked(struct wl1271 *wl);
208 void wl1271_tx_complete(struct wl1271 *wl);
209 void wl12xx_tx_reset_wlvif(struct wl1271 *wl, struct wl12xx_vif *wlvif);
210 void wl12xx_tx_reset(struct wl1271 *wl, bool reset_tx_queues);
211 void wl1271_tx_flush(struct wl1271 *wl);
212 u8 wl1271_rate_to_idx(int rate, enum ieee80211_band band);
213 u32 wl1271_tx_enabled_rates_get(struct wl1271 *wl, u32 rate_set,
214 enum ieee80211_band rate_band);
215 u32 wl1271_tx_min_rate_get(struct wl1271 *wl, u32 rate_set);
216 u8 wl12xx_tx_get_hlid_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif,
217 struct sk_buff *skb);
218 u8 wl12xx_tx_get_hlid(struct wl1271 *wl, struct wl12xx_vif *wlvif,
219 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 bool wl12xx_is_dummy_packet(struct wl1271 *wl, struct sk_buff *skb);
223 void wl12xx_rearm_rx_streaming(struct wl1271 *wl, unsigned long *active_hlids);
224
225 /* from main.c */
226 void wl1271_free_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 hlid);
227
228 #endif
229