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