]>
Commit | Line | Data |
---|---|---|
8ca151b5 JB |
1 | /****************************************************************************** |
2 | * | |
3 | * This file is provided under a dual BSD/GPLv2 license. When using or | |
4 | * redistributing this file, you may do so under either license. | |
5 | * | |
6 | * GPL LICENSE SUMMARY | |
7 | * | |
51368bf7 | 8 | * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved. |
8ca151b5 JB |
9 | * |
10 | * This program is free software; you can redistribute it and/or modify | |
11 | * it under the terms of version 2 of the GNU General Public License as | |
12 | * published by the Free Software Foundation. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, but | |
15 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 | * General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, | |
22 | * USA | |
23 | * | |
24 | * The full GNU General Public License is included in this distribution | |
410dc5aa | 25 | * in the file called COPYING. |
8ca151b5 JB |
26 | * |
27 | * Contact Information: | |
28 | * Intel Linux Wireless <ilw@linux.intel.com> | |
29 | * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 | |
30 | * | |
31 | * BSD LICENSE | |
32 | * | |
51368bf7 | 33 | * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved. |
8ca151b5 JB |
34 | * All rights reserved. |
35 | * | |
36 | * Redistribution and use in source and binary forms, with or without | |
37 | * modification, are permitted provided that the following conditions | |
38 | * are met: | |
39 | * | |
40 | * * Redistributions of source code must retain the above copyright | |
41 | * notice, this list of conditions and the following disclaimer. | |
42 | * * Redistributions in binary form must reproduce the above copyright | |
43 | * notice, this list of conditions and the following disclaimer in | |
44 | * the documentation and/or other materials provided with the | |
45 | * distribution. | |
46 | * * Neither the name Intel Corporation nor the names of its | |
47 | * contributors may be used to endorse or promote products derived | |
48 | * from this software without specific prior written permission. | |
49 | * | |
50 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
51 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
52 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
53 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
54 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
55 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
56 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
57 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
58 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
59 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
60 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
61 | * | |
62 | *****************************************************************************/ | |
63 | ||
64 | #ifndef __sta_h__ | |
65 | #define __sta_h__ | |
66 | ||
67 | #include <linux/spinlock.h> | |
68 | #include <net/mac80211.h> | |
69 | #include <linux/wait.h> | |
70 | ||
71 | #include "iwl-trans.h" /* for IWL_MAX_TID_COUNT */ | |
72 | #include "fw-api.h" /* IWL_MVM_STATION_COUNT */ | |
73 | #include "rs.h" | |
74 | ||
75 | struct iwl_mvm; | |
76 | ||
77 | /** | |
78 | * DOC: station table - introduction | |
79 | * | |
80 | * The station table is a list of data structure that reprensent the stations. | |
81 | * In STA/P2P client mode, the driver will hold one station for the AP/ GO. | |
82 | * In GO/AP mode, the driver will have as many stations as associated clients. | |
83 | * All these stations are reflected in the fw's station table. The driver | |
84 | * keeps the fw's station table up to date with the ADD_STA command. Stations | |
85 | * can be removed by the REMOVE_STA command. | |
86 | * | |
87 | * All the data related to a station is held in the structure %iwl_mvm_sta | |
88 | * which is embed in the mac80211's %ieee80211_sta (in the drv_priv) area. | |
89 | * This data includes the index of the station in the fw, per tid information | |
90 | * (sequence numbers, Block-ack state machine, etc...). The stations are | |
91 | * created and deleted by the %sta_state callback from %ieee80211_ops. | |
92 | * | |
93 | * The driver holds a map: %fw_id_to_mac_id that allows to fetch a | |
94 | * %ieee80211_sta (and the %iwl_mvm_sta embedded into it) based on a fw | |
95 | * station index. That way, the driver is able to get the tid related data in | |
96 | * O(1) in time sensitive paths (Tx / Tx response / BA notification). These | |
97 | * paths are triggered by the fw, and the driver needs to get a pointer to the | |
98 | * %ieee80211 structure. This map helps to get that pointer quickly. | |
99 | */ | |
100 | ||
101 | /** | |
102 | * DOC: station table - locking | |
103 | * | |
104 | * As stated before, the station is created / deleted by mac80211's %sta_state | |
105 | * callback from %ieee80211_ops which can sleep. The next paragraph explains | |
106 | * the locking of a single stations, the next ones relates to the station | |
107 | * table. | |
108 | * | |
109 | * The station holds the sequence number per tid. So this data needs to be | |
110 | * accessed in the Tx path (which is softIRQ). It also holds the Block-Ack | |
111 | * information (the state machine / and the logic that checks if the queues | |
112 | * were drained), so it also needs to be accessible from the Tx response flow. | |
113 | * In short, the station needs to be access from sleepable context as well as | |
114 | * from tasklets, so the station itself needs a spinlock. | |
115 | * | |
116 | * The writers of %fw_id_to_mac_id map are serialized by the global mutex of | |
117 | * the mvm op_mode. This is possible since %sta_state can sleep. | |
118 | * The pointers in this map are RCU protected, hence we won't replace the | |
119 | * station while we have Tx / Tx response / BA notification running. | |
120 | * | |
121 | * If a station is deleted while it still has packets in its A-MPDU queues, | |
122 | * then the reclaim flow will notice that there is no station in the map for | |
123 | * sta_id and it will dump the responses. | |
124 | */ | |
125 | ||
126 | /** | |
127 | * DOC: station table - internal stations | |
128 | * | |
129 | * The FW needs a few internal stations that are not reflected in | |
130 | * mac80211, such as broadcast station in AP / GO mode, or AUX sta for | |
131 | * scanning and P2P device (during the GO negotiation). | |
132 | * For these kind of stations we have %iwl_mvm_int_sta struct which holds the | |
133 | * data relevant for them from both %iwl_mvm_sta and %ieee80211_sta. | |
134 | * Usually the data for these stations is static, so no locking is required, | |
135 | * and no TID data as this is also not needed. | |
136 | * One thing to note, is that these stations have an ID in the fw, but not | |
137 | * in mac80211. In order to "reserve" them a sta_id in %fw_id_to_mac_id | |
138 | * we fill ERR_PTR(EINVAL) in this mapping and all other dereferencing of | |
139 | * pointers from this mapping need to check that the value is not error | |
140 | * or NULL. | |
141 | * | |
142 | * Currently there is only one auxiliary station for scanning, initialized | |
143 | * on init. | |
144 | */ | |
145 | ||
146 | /** | |
147 | * DOC: station table - AP Station in STA mode | |
148 | * | |
149 | * %iwl_mvm_vif includes the index of the AP station in the fw's STA table: | |
150 | * %ap_sta_id. To get the point to the coresponsding %ieee80211_sta, | |
151 | * &fw_id_to_mac_id can be used. Due to the way the fw works, we must not remove | |
152 | * the AP station from the fw before setting the MAC context as unassociated. | |
153 | * Hence, %fw_id_to_mac_id[%ap_sta_id] will be NULLed when the AP station is | |
154 | * removed by mac80211, but the station won't be removed in the fw until the | |
155 | * VIF is set as unassociated. Then, %ap_sta_id will be invalidated. | |
156 | */ | |
157 | ||
158 | /** | |
159 | * DOC: station table - Drain vs. Flush | |
160 | * | |
161 | * Flush means that all the frames in the SCD queue are dumped regardless the | |
162 | * station to which they were sent. We do that when we disassociate and before | |
163 | * we remove the STA of the AP. The flush can be done synchronously against the | |
164 | * fw. | |
165 | * Drain means that the fw will drop all the frames sent to a specific station. | |
166 | * This is useful when a client (if we are IBSS / GO or AP) disassociates. In | |
167 | * that case, we need to drain all the frames for that client from the AC queues | |
168 | * that are shared with the other clients. Only then, we can remove the STA in | |
169 | * the fw. In order to do so, we track the non-AMPDU packets for each station. | |
170 | * If mac80211 removes a STA and if it still has non-AMPDU packets pending in | |
171 | * the queues, we mark this station as %EBUSY in %fw_id_to_mac_id, and drop all | |
172 | * the frames for this STA (%iwl_mvm_rm_sta). When the last frame is dropped | |
173 | * (we know about it with its Tx response), we remove the station in fw and set | |
174 | * it as %NULL in %fw_id_to_mac_id: this is the purpose of | |
175 | * %iwl_mvm_sta_drained_wk. | |
176 | */ | |
177 | ||
178 | /** | |
179 | * DOC: station table - fw restart | |
180 | * | |
181 | * When the fw asserts, or we have any other issue that requires to reset the | |
182 | * driver, we require mac80211 to reconfigure the driver. Since the private | |
183 | * data of the stations is embed in mac80211's %ieee80211_sta, that data will | |
184 | * not be zeroed and needs to be reinitialized manually. | |
185 | * %IWL_MVM_STATUS_IN_HW_RESTART is set during restart and that will hint us | |
186 | * that we must not allocate a new sta_id but reuse the previous one. This | |
187 | * means that the stations being re-added after the reset will have the same | |
188 | * place in the fw as before the reset. We do need to zero the %fw_id_to_mac_id | |
189 | * map, since the stations aren't in the fw any more. Internal stations that | |
190 | * are not added by mac80211 will be re-added in the init flow that is called | |
191 | * after the restart: mac80211 call's %iwl_mvm_mac_start which calls to | |
192 | * %iwl_mvm_up. | |
193 | */ | |
194 | ||
195 | /** | |
196 | * DOC: AP mode - PS | |
197 | * | |
3e56eadf JB |
198 | * When a station is asleep, the fw will set it as "asleep". All frames on |
199 | * shared queues (i.e. non-aggregation queues) to that station will be dropped | |
200 | * by the fw (%TX_STATUS_FAIL_DEST_PS failure code). | |
201 | * | |
8ca151b5 | 202 | * AMPDUs are in a separate queue that is stopped by the fw. We just need to |
3e56eadf | 203 | * let mac80211 know when there are frames in these queues so that it can |
8ca151b5 | 204 | * properly handle trigger frames. |
3e56eadf JB |
205 | * |
206 | * When a trigger frame is received, mac80211 tells the driver to send frames | |
207 | * from the AMPDU queues or sends frames to non-aggregation queues itself, | |
208 | * depending on which ACs are delivery-enabled and what TID has frames to | |
209 | * transmit. Note that mac80211 has all the knowledege since all the non-agg | |
210 | * frames are buffered / filtered, and the driver tells mac80211 about agg | |
211 | * frames). The driver needs to tell the fw to let frames out even if the | |
212 | * station is asleep. This is done by %iwl_mvm_sta_modify_sleep_tx_count. | |
213 | * | |
214 | * When we receive a frame from that station with PM bit unset, the driver | |
215 | * needs to let the fw know that this station isn't asleep any more. This is | |
216 | * done by %iwl_mvm_sta_modify_ps_wake in response to mac80211 signalling the | |
217 | * station's wakeup. | |
218 | * | |
219 | * For a GO, the Service Period might be cut short due to an absence period | |
220 | * of the GO. In this (and all other cases) the firmware notifies us with the | |
221 | * EOSP_NOTIFICATION, and we notify mac80211 of that. Further frames that we | |
222 | * already sent to the device will be rejected again. | |
223 | * | |
224 | * See also "AP support for powersaving clients" in mac80211.h. | |
8ca151b5 JB |
225 | */ |
226 | ||
227 | /** | |
228 | * enum iwl_mvm_agg_state | |
229 | * | |
230 | * The state machine of the BA agreement establishment / tear down. | |
231 | * These states relate to a specific RA / TID. | |
232 | * | |
233 | * @IWL_AGG_OFF: aggregation is not used | |
234 | * @IWL_AGG_STARTING: aggregation are starting (between start and oper) | |
235 | * @IWL_AGG_ON: aggregation session is up | |
236 | * @IWL_EMPTYING_HW_QUEUE_ADDBA: establishing a BA session - waiting for the | |
237 | * HW queue to be empty from packets for this RA /TID. | |
238 | * @IWL_EMPTYING_HW_QUEUE_DELBA: tearing down a BA session - waiting for the | |
239 | * HW queue to be empty from packets for this RA /TID. | |
240 | */ | |
241 | enum iwl_mvm_agg_state { | |
242 | IWL_AGG_OFF = 0, | |
243 | IWL_AGG_STARTING, | |
244 | IWL_AGG_ON, | |
245 | IWL_EMPTYING_HW_QUEUE_ADDBA, | |
246 | IWL_EMPTYING_HW_QUEUE_DELBA, | |
247 | }; | |
248 | ||
249 | /** | |
250 | * struct iwl_mvm_tid_data - holds the states for each RA / TID | |
251 | * @seq_number: the next WiFi sequence number to use | |
252 | * @next_reclaimed: the WiFi sequence number of the next packet to be acked. | |
253 | * This is basically (last acked packet++). | |
254 | * @rate_n_flags: Rate at which Tx was attempted. Holds the data between the | |
255 | * Tx response (TX_CMD), and the block ack notification (COMPRESSED_BA). | |
3a84b69e EP |
256 | * @reduced_tpc: Reduced tx power. Holds the data between the |
257 | * Tx response (TX_CMD), and the block ack notification (COMPRESSED_BA). | |
8ca151b5 JB |
258 | * @state: state of the BA agreement establishment / tear down. |
259 | * @txq_id: Tx queue used by the BA session | |
260 | * @ssn: the first packet to be sent in AGG HW queue in Tx AGG start flow, or | |
261 | * the first packet to be sent in legacy HW queue in Tx AGG stop flow. | |
262 | * Basically when next_reclaimed reaches ssn, we can tell mac80211 that | |
263 | * we are ready to finish the Tx AGG stop / start flow. | |
8ca151b5 JB |
264 | */ |
265 | struct iwl_mvm_tid_data { | |
266 | u16 seq_number; | |
267 | u16 next_reclaimed; | |
268 | /* The rest is Tx AGG related */ | |
269 | u32 rate_n_flags; | |
3a84b69e | 270 | u8 reduced_tpc; |
8ca151b5 JB |
271 | enum iwl_mvm_agg_state state; |
272 | u16 txq_id; | |
273 | u16 ssn; | |
8ca151b5 JB |
274 | }; |
275 | ||
3e56eadf JB |
276 | static inline u16 iwl_mvm_tid_queued(struct iwl_mvm_tid_data *tid_data) |
277 | { | |
278 | return ieee80211_sn_sub(IEEE80211_SEQ_TO_SN(tid_data->seq_number), | |
279 | tid_data->next_reclaimed); | |
280 | } | |
281 | ||
8ca151b5 JB |
282 | /** |
283 | * struct iwl_mvm_sta - representation of a station in the driver | |
284 | * @sta_id: the index of the station in the fw (will be replaced by id_n_color) | |
285 | * @tfd_queue_msk: the tfd queues used by the station | |
286 | * @mac_id_n_color: the MAC context this station is linked to | |
287 | * @tid_disable_agg: bitmap: if bit(tid) is set, the fw won't send ampdus for | |
288 | * tid. | |
289 | * @max_agg_bufsize: the maximal size of the AGG buffer for this station | |
2b76ef13 | 290 | * @bt_reduced_txpower: is reduced tx power enabled for this station |
3e56eadf JB |
291 | * @next_status_eosp: the next reclaimed packet is a PS-Poll response and |
292 | * we need to signal the EOSP | |
8ca151b5 JB |
293 | * @lock: lock to protect the whole struct. Since %tid_data is access from Tx |
294 | * and from Tx response flow, it needs a spinlock. | |
8ca151b5 | 295 | * @tid_data: per tid data. Look at %iwl_mvm_tid_data. |
9ee718aa EL |
296 | * @tx_protection: reference counter for controlling the Tx protection. |
297 | * @tt_tx_protection: is thermal throttling enable Tx protection? | |
8ca151b5 JB |
298 | * |
299 | * When mac80211 creates a station it reserves some space (hw->sta_data_size) | |
300 | * in the structure for use by driver. This structure is placed in that | |
301 | * space. | |
302 | * | |
303 | */ | |
304 | struct iwl_mvm_sta { | |
305 | u32 sta_id; | |
306 | u32 tfd_queue_msk; | |
307 | u32 mac_id_n_color; | |
308 | u16 tid_disable_agg; | |
309 | u8 max_agg_bufsize; | |
2b76ef13 | 310 | bool bt_reduced_txpower; |
3e56eadf | 311 | bool next_status_eosp; |
8ca151b5 | 312 | spinlock_t lock; |
8ca151b5 JB |
313 | struct iwl_mvm_tid_data tid_data[IWL_MAX_TID_COUNT]; |
314 | struct iwl_lq_sta lq_sta; | |
315 | struct ieee80211_vif *vif; | |
316 | ||
9ee718aa EL |
317 | /* Temporary, until the new TLC will control the Tx protection */ |
318 | s8 tx_protection; | |
319 | bool tt_tx_protection; | |
8ca151b5 JB |
320 | }; |
321 | ||
5b577a90 JB |
322 | static inline struct iwl_mvm_sta * |
323 | iwl_mvm_sta_from_mac80211(struct ieee80211_sta *sta) | |
324 | { | |
325 | return (void *)sta->drv_priv; | |
326 | } | |
327 | ||
8ca151b5 JB |
328 | /** |
329 | * struct iwl_mvm_int_sta - representation of an internal station (auxiliary or | |
330 | * broadcast) | |
331 | * @sta_id: the index of the station in the fw (will be replaced by id_n_color) | |
332 | * @tfd_queue_msk: the tfd queues used by the station | |
333 | */ | |
334 | struct iwl_mvm_int_sta { | |
335 | u32 sta_id; | |
336 | u32 tfd_queue_msk; | |
337 | }; | |
338 | ||
7a453973 JB |
339 | int iwl_mvm_sta_send_to_fw(struct iwl_mvm *mvm, struct ieee80211_sta *sta, |
340 | bool update); | |
8ca151b5 JB |
341 | int iwl_mvm_add_sta(struct iwl_mvm *mvm, |
342 | struct ieee80211_vif *vif, | |
343 | struct ieee80211_sta *sta); | |
7a453973 JB |
344 | int iwl_mvm_update_sta(struct iwl_mvm *mvm, |
345 | struct ieee80211_vif *vif, | |
346 | struct ieee80211_sta *sta); | |
8ca151b5 JB |
347 | int iwl_mvm_rm_sta(struct iwl_mvm *mvm, |
348 | struct ieee80211_vif *vif, | |
349 | struct ieee80211_sta *sta); | |
350 | int iwl_mvm_rm_sta_id(struct iwl_mvm *mvm, | |
351 | struct ieee80211_vif *vif, | |
352 | u8 sta_id); | |
353 | int iwl_mvm_set_sta_key(struct iwl_mvm *mvm, | |
354 | struct ieee80211_vif *vif, | |
355 | struct ieee80211_sta *sta, | |
356 | struct ieee80211_key_conf *key, | |
357 | bool have_key_offset); | |
358 | int iwl_mvm_remove_sta_key(struct iwl_mvm *mvm, | |
359 | struct ieee80211_vif *vif, | |
360 | struct ieee80211_sta *sta, | |
361 | struct ieee80211_key_conf *keyconf); | |
362 | ||
363 | void iwl_mvm_update_tkip_key(struct iwl_mvm *mvm, | |
364 | struct ieee80211_vif *vif, | |
365 | struct ieee80211_key_conf *keyconf, | |
366 | struct ieee80211_sta *sta, u32 iv32, | |
367 | u16 *phase1key); | |
368 | ||
3e56eadf JB |
369 | int iwl_mvm_rx_eosp_notif(struct iwl_mvm *mvm, |
370 | struct iwl_rx_cmd_buffer *rxb, | |
371 | struct iwl_device_cmd *cmd); | |
372 | ||
8ca151b5 JB |
373 | /* AMPDU */ |
374 | int iwl_mvm_sta_rx_agg(struct iwl_mvm *mvm, struct ieee80211_sta *sta, | |
375 | int tid, u16 ssn, bool start); | |
376 | int iwl_mvm_sta_tx_agg_start(struct iwl_mvm *mvm, struct ieee80211_vif *vif, | |
377 | struct ieee80211_sta *sta, u16 tid, u16 *ssn); | |
378 | int iwl_mvm_sta_tx_agg_oper(struct iwl_mvm *mvm, struct ieee80211_vif *vif, | |
379 | struct ieee80211_sta *sta, u16 tid, u8 buf_size); | |
380 | int iwl_mvm_sta_tx_agg_stop(struct iwl_mvm *mvm, struct ieee80211_vif *vif, | |
381 | struct ieee80211_sta *sta, u16 tid); | |
e3d9e7ce EG |
382 | int iwl_mvm_sta_tx_agg_flush(struct iwl_mvm *mvm, struct ieee80211_vif *vif, |
383 | struct ieee80211_sta *sta, u16 tid); | |
8ca151b5 JB |
384 | |
385 | int iwl_mvm_add_aux_sta(struct iwl_mvm *mvm); | |
386 | int iwl_mvm_allocate_int_sta(struct iwl_mvm *mvm, struct iwl_mvm_int_sta *sta, | |
b92e661b | 387 | u32 qmask, enum nl80211_iftype iftype); |
8ca151b5 JB |
388 | void iwl_mvm_dealloc_int_sta(struct iwl_mvm *mvm, |
389 | struct iwl_mvm_int_sta *sta); | |
390 | int iwl_mvm_send_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif, | |
391 | struct iwl_mvm_int_sta *bsta); | |
392 | int iwl_mvm_send_rm_bcast_sta(struct iwl_mvm *mvm, | |
393 | struct iwl_mvm_int_sta *bsta); | |
394 | int iwl_mvm_add_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif, | |
395 | struct iwl_mvm_int_sta *bsta); | |
396 | int iwl_mvm_rm_bcast_sta(struct iwl_mvm *mvm, struct iwl_mvm_int_sta *bsta); | |
397 | void iwl_mvm_sta_drained_wk(struct work_struct *wk); | |
9cc40712 JB |
398 | void iwl_mvm_sta_modify_ps_wake(struct iwl_mvm *mvm, |
399 | struct ieee80211_sta *sta); | |
400 | void iwl_mvm_sta_modify_sleep_tx_count(struct iwl_mvm *mvm, | |
401 | struct ieee80211_sta *sta, | |
8ca151b5 | 402 | enum ieee80211_frame_release_type reason, |
3e56eadf JB |
403 | u16 cnt, u16 tids, bool more_data, |
404 | bool agg); | |
8ca151b5 JB |
405 | int iwl_mvm_drain_sta(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta, |
406 | bool drain); | |
407 | ||
408 | #endif /* __sta_h__ */ |