xref: /freebsd/sys/contrib/dev/iwlwifi/mvm/sta.h (revision a4128aad8503277614f2d214011ef60a19447b83)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3  * Copyright (C) 2012-2014, 2018-2024 Intel Corporation
4  * Copyright (C) 2013-2014 Intel Mobile Communications GmbH
5  * Copyright (C) 2015-2016 Intel Deutschland GmbH
6  */
7 #ifndef __sta_h__
8 #define __sta_h__
9 
10 #include <linux/spinlock.h>
11 #include <net/mac80211.h>
12 #include <linux/wait.h>
13 
14 #include "iwl-trans.h" /* for IWL_MAX_TID_COUNT */
15 #include "fw-api.h" /* IWL_MVM_STATION_COUNT_MAX */
16 #include "rs.h"
17 
18 struct iwl_mvm;
19 struct iwl_mvm_vif;
20 
21 /**
22  * DOC: DQA - Dynamic Queue Allocation -introduction
23  *
24  * Dynamic Queue Allocation (AKA "DQA") is a feature implemented in iwlwifi
25  * driver to allow dynamic allocation of queues on-demand, rather than allocate
26  * them statically ahead of time. Ideally, we would like to allocate one queue
27  * per RA/TID, thus allowing an AP - for example - to send BE traffic to STA2
28  * even if it also needs to send traffic to a sleeping STA1, without being
29  * blocked by the sleeping station.
30  *
31  * Although the queues in DQA mode are dynamically allocated, there are still
32  * some queues that are statically allocated:
33  *	TXQ #0 - command queue
34  *	TXQ #1 - aux frames
35  *	TXQ #2 - P2P device frames
36  *	TXQ #3 - P2P GO/SoftAP GCAST/BCAST frames
37  *	TXQ #4 - BSS DATA frames queue
38  *	TXQ #5-8 - Non-QoS and MGMT frames queue pool
39  *	TXQ #9 - P2P GO/SoftAP probe responses
40  *	TXQ #10-31 - DATA frames queue pool
41  * The queues are dynamically taken from either the MGMT frames queue pool or
42  * the DATA frames one. See the %iwl_mvm_dqa_txq for more information on every
43  * queue.
44  *
45  * When a frame for a previously unseen RA/TID comes in, it needs to be deferred
46  * until a queue is allocated for it, and only then can be TXed. Therefore, it
47  * is placed into %iwl_mvm_tid_data.deferred_tx_frames, and a worker called
48  * %mvm->add_stream_wk later allocates the queues and TXes the deferred frames.
49  *
50  * For convenience, MGMT is considered as if it has TID=8, and go to the MGMT
51  * queues in the pool. If there is no longer a free MGMT queue to allocate, a
52  * queue will be allocated from the DATA pool instead. Since QoS NDPs can create
53  * a problem for aggregations, they too will use a MGMT queue.
54  *
55  * When adding a STA, a DATA queue is reserved for it so that it can TX from
56  * it. If no such free queue exists for reserving, the STA addition will fail.
57  *
58  * If the DATA queue pool gets exhausted, no new STA will be accepted, and if a
59  * new RA/TID comes in for an existing STA, one of the STA's queues will become
60  * shared and will serve more than the single TID (but always for the same RA!).
61  *
62  * When a RA/TID needs to become aggregated, no new queue is required to be
63  * allocated, only mark the queue as aggregated via the ADD_STA command. Note,
64  * however, that a shared queue cannot be aggregated, and only after the other
65  * TIDs become inactive and are removed - only then can the queue be
66  * reconfigured and become aggregated.
67  *
68  * When removing a station, its queues are returned to the pool for reuse. Here
69  * we also need to make sure that we are synced with the worker thread that TXes
70  * the deferred frames so we don't get into a situation where the queues are
71  * removed and then the worker puts deferred frames onto the released queues or
72  * tries to allocate new queues for a STA we don't need anymore.
73  */
74 
75 /**
76  * DOC: station table - introduction
77  *
78  * The station table is a list of data structure that reprensent the stations.
79  * In STA/P2P client mode, the driver will hold one station for the AP/ GO.
80  * In GO/AP mode, the driver will have as many stations as associated clients.
81  * All these stations are reflected in the fw's station table. The driver
82  * keeps the fw's station table up to date with the ADD_STA command. Stations
83  * can be removed by the REMOVE_STA command.
84  *
85  * All the data related to a station is held in the structure %iwl_mvm_sta
86  * which is embed in the mac80211's %ieee80211_sta (in the drv_priv) area.
87  * This data includes the index of the station in the fw, per tid information
88  * (sequence numbers, Block-ack state machine, etc...). The stations are
89  * created and deleted by the %sta_state callback from %ieee80211_ops.
90  *
91  * The driver holds a map: %fw_id_to_mac_id that allows to fetch a
92  * %ieee80211_sta (and the %iwl_mvm_sta embedded into it) based on a fw
93  * station index. That way, the driver is able to get the tid related data in
94  * O(1) in time sensitive paths (Tx / Tx response / BA notification). These
95  * paths are triggered by the fw, and the driver needs to get a pointer to the
96  * %ieee80211 structure. This map helps to get that pointer quickly.
97  */
98 
99 /**
100  * DOC: station table - locking
101  *
102  * As stated before, the station is created / deleted by mac80211's %sta_state
103  * callback from %ieee80211_ops which can sleep. The next paragraph explains
104  * the locking of a single stations, the next ones relates to the station
105  * table.
106  *
107  * The station holds the sequence number per tid. So this data needs to be
108  * accessed in the Tx path (which is softIRQ). It also holds the Block-Ack
109  * information (the state machine / and the logic that checks if the queues
110  * were drained), so it also needs to be accessible from the Tx response flow.
111  * In short, the station needs to be access from sleepable context as well as
112  * from tasklets, so the station itself needs a spinlock.
113  *
114  * The writers of %fw_id_to_mac_id map are serialized by the global mutex of
115  * the mvm op_mode. This is possible since %sta_state can sleep.
116  * The pointers in this map are RCU protected, hence we won't replace the
117  * station while we have Tx / Tx response / BA notification running.
118  *
119  * If a station is deleted while it still has packets in its A-MPDU queues,
120  * then the reclaim flow will notice that there is no station in the map for
121  * sta_id and it will dump the responses.
122  */
123 
124 /**
125  * DOC: station table - internal stations
126  *
127  * The FW needs a few internal stations that are not reflected in
128  * mac80211, such as broadcast station in AP / GO mode, or AUX sta for
129  * scanning and P2P device (during the GO negotiation).
130  * For these kind of stations we have %iwl_mvm_int_sta struct which holds the
131  * data relevant for them from both %iwl_mvm_sta and %ieee80211_sta.
132  * Usually the data for these stations is static, so no locking is required,
133  * and no TID data as this is also not needed.
134  * One thing to note, is that these stations have an ID in the fw, but not
135  * in mac80211. In order to "reserve" them a sta_id in %fw_id_to_mac_id
136  * we fill ERR_PTR(EINVAL) in this mapping and all other dereferencing of
137  * pointers from this mapping need to check that the value is not error
138  * or NULL.
139  *
140  * Currently there is only one auxiliary station for scanning, initialized
141  * on init.
142  */
143 
144 /**
145  * DOC: station table - AP Station in STA mode
146  *
147  * %iwl_mvm_vif includes the index of the AP station in the fw's STA table:
148  * %ap_sta_id. To get the point to the corresponding %ieee80211_sta,
149  * &fw_id_to_mac_id can be used. Due to the way the fw works, we must not remove
150  * the AP station from the fw before setting the MAC context as unassociated.
151  * Hence, %fw_id_to_mac_id[%ap_sta_id] will be NULLed when the AP station is
152  * removed by mac80211, but the station won't be removed in the fw until the
153  * VIF is set as unassociated. Then, %ap_sta_id will be invalidated.
154  */
155 
156 /**
157  * DOC: station table - Drain vs. Flush
158  *
159  * Flush means that all the frames in the SCD queue are dumped regardless the
160  * station to which they were sent. We do that when we disassociate and before
161  * we remove the STA of the AP. The flush can be done synchronously against the
162  * fw.
163  * Drain means that the fw will drop all the frames sent to a specific station.
164  * This is useful when a client (if we are IBSS / GO or AP) disassociates.
165  */
166 
167 /**
168  * DOC: station table - fw restart
169  *
170  * When the fw asserts, or we have any other issue that requires to reset the
171  * driver, we require mac80211 to reconfigure the driver. Since the private
172  * data of the stations is embed in mac80211's %ieee80211_sta, that data will
173  * not be zeroed and needs to be reinitialized manually.
174  * %IWL_MVM_STATUS_IN_HW_RESTART is set during restart and that will hint us
175  * that we must not allocate a new sta_id but reuse the previous one. This
176  * means that the stations being re-added after the reset will have the same
177  * place in the fw as before the reset. We do need to zero the %fw_id_to_mac_id
178  * map, since the stations aren't in the fw any more. Internal stations that
179  * are not added by mac80211 will be re-added in the init flow that is called
180  * after the restart: mac80211 call's %iwl_mvm_mac_start which calls to
181  * %iwl_mvm_up.
182  */
183 
184 /**
185  * DOC: AP mode - PS
186  *
187  * When a station is asleep, the fw will set it as "asleep". All frames on
188  * shared queues (i.e. non-aggregation queues) to that station will be dropped
189  * by the fw (%TX_STATUS_FAIL_DEST_PS failure code).
190  *
191  * AMPDUs are in a separate queue that is stopped by the fw. We just need to
192  * let mac80211 know when there are frames in these queues so that it can
193  * properly handle trigger frames.
194  *
195  * When a trigger frame is received, mac80211 tells the driver to send frames
196  * from the AMPDU queues or sends frames to non-aggregation queues itself,
197  * depending on which ACs are delivery-enabled and what TID has frames to
198  * transmit. Note that mac80211 has all the knowledge since all the non-agg
199  * frames are buffered / filtered, and the driver tells mac80211 about agg
200  * frames). The driver needs to tell the fw to let frames out even if the
201  * station is asleep. This is done by %iwl_mvm_sta_modify_sleep_tx_count.
202  *
203  * When we receive a frame from that station with PM bit unset, the driver
204  * needs to let the fw know that this station isn't asleep any more. This is
205  * done by %iwl_mvm_sta_modify_ps_wake in response to mac80211 signaling the
206  * station's wakeup.
207  *
208  * For a GO, the Service Period might be cut short due to an absence period
209  * of the GO. In this (and all other cases) the firmware notifies us with the
210  * EOSP_NOTIFICATION, and we notify mac80211 of that. Further frames that we
211  * already sent to the device will be rejected again.
212  *
213  * See also "AP support for powersaving clients" in mac80211.h.
214  */
215 
216 /**
217  * enum iwl_mvm_agg_state
218  *
219  * The state machine of the BA agreement establishment / tear down.
220  * These states relate to a specific RA / TID.
221  *
222  * @IWL_AGG_OFF: aggregation is not used
223  * @IWL_AGG_QUEUED: aggregation start work has been queued
224  * @IWL_AGG_STARTING: aggregation are starting (between start and oper)
225  * @IWL_AGG_ON: aggregation session is up
226  * @IWL_EMPTYING_HW_QUEUE_ADDBA: establishing a BA session - waiting for the
227  *	HW queue to be empty from packets for this RA /TID.
228  * @IWL_EMPTYING_HW_QUEUE_DELBA: tearing down a BA session - waiting for the
229  *	HW queue to be empty from packets for this RA /TID.
230  */
231 enum iwl_mvm_agg_state {
232 	IWL_AGG_OFF = 0,
233 	IWL_AGG_QUEUED,
234 	IWL_AGG_STARTING,
235 	IWL_AGG_ON,
236 	IWL_EMPTYING_HW_QUEUE_ADDBA,
237 	IWL_EMPTYING_HW_QUEUE_DELBA,
238 };
239 
240 /**
241  * struct iwl_mvm_tid_data - holds the states for each RA / TID
242  * @seq_number: the next WiFi sequence number to use
243  * @next_reclaimed: the WiFi sequence number of the next packet to be acked.
244  *	This is basically (last acked packet++).
245  * @rate_n_flags: Rate at which Tx was attempted. Holds the data between the
246  *	Tx response (TX_CMD), and the block ack notification (COMPRESSED_BA).
247  * @lq_color: the color of the LQ command as it appears in tx response.
248  * @amsdu_in_ampdu_allowed: true if A-MSDU in A-MPDU is allowed.
249  * @state: state of the BA agreement establishment / tear down.
250  * @txq_id: Tx queue used by the BA session / DQA
251  * @ssn: the first packet to be sent in AGG HW queue in Tx AGG start flow, or
252  *	the first packet to be sent in legacy HW queue in Tx AGG stop flow.
253  *	Basically when next_reclaimed reaches ssn, we can tell mac80211 that
254  *	we are ready to finish the Tx AGG stop / start flow.
255  * @tx_time: medium time consumed by this A-MPDU
256  * @tpt_meas_start: time of the throughput measurements start, is reset every HZ
257  * @tx_count_last: number of frames transmitted during the last second
258  * @tx_count: counts the number of frames transmitted since the last reset of
259  *	 tpt_meas_start
260  */
261 struct iwl_mvm_tid_data {
262 	u16 seq_number;
263 	u16 next_reclaimed;
264 	/* The rest is Tx AGG related */
265 	u32 rate_n_flags;
266 	u8 lq_color;
267 	bool amsdu_in_ampdu_allowed;
268 	enum iwl_mvm_agg_state state;
269 	u16 txq_id;
270 	u16 ssn;
271 	u16 tx_time;
272 	unsigned long tpt_meas_start;
273 	u32 tx_count_last;
274 	u32 tx_count;
275 };
276 
277 struct iwl_mvm_key_pn {
278 	struct rcu_head rcu_head;
279 	struct {
280 		u8 pn[IWL_MAX_TID_COUNT][IEEE80211_CCMP_PN_LEN];
281 	} ____cacheline_aligned_in_smp q[];
282 };
283 
284 /**
285  * enum iwl_mvm_rxq_notif_type - Internal message identifier
286  *
287  * @IWL_MVM_RXQ_EMPTY: empty sync notification
288  * @IWL_MVM_RXQ_NOTIF_DEL_BA: notify RSS queues of delBA
289  */
290 enum iwl_mvm_rxq_notif_type {
291 	IWL_MVM_RXQ_EMPTY,
292 	IWL_MVM_RXQ_NOTIF_DEL_BA,
293 };
294 
295 /**
296  * struct iwl_mvm_internal_rxq_notif - Internal representation of the data sent
297  * in &iwl_rxq_sync_cmd. Should be DWORD aligned.
298  * FW is agnostic to the payload, so there are no endianity requirements.
299  *
300  * @type: value from &iwl_mvm_rxq_notif_type
301  * @sync: ctrl path is waiting for all notifications to be received
302  * @cookie: internal cookie to identify old notifications
303  * @data: payload
304  */
305 struct iwl_mvm_internal_rxq_notif {
306 	u16 type;
307 	u16 sync;
308 	u32 cookie;
309 	u8 data[];
310 } __packed;
311 
312 struct iwl_mvm_delba_data {
313 	u32 baid;
314 } __packed;
315 
316 /**
317  * struct iwl_mvm_rxq_dup_data - per station per rx queue data
318  * @last_seq: last sequence per tid for duplicate packet detection
319  * @last_sub_frame: last subframe packet
320  */
321 struct iwl_mvm_rxq_dup_data {
322 	__le16 last_seq[IWL_MAX_TID_COUNT + 1];
323 	u8 last_sub_frame[IWL_MAX_TID_COUNT + 1];
324 } ____cacheline_aligned_in_smp;
325 
326 /**
327  * struct iwl_mvm_link_sta - link specific parameters of a station
328  * @rcu_head: used for freeing the data
329  * @sta_id: the index of the station in the fw
330  * @lq_sta: holds rate scaling data, either for the case when RS is done in
331  *	the driver - %rs_drv or in the FW - %rs_fw.
332  * @orig_amsdu_len: used to save the original amsdu_len when it is changed via
333  *      debugfs.  If it's set to 0, it means that it is it's not set via
334  *      debugfs.
335  * @avg_energy: energy as reported by FW statistics notification
336  */
337 struct iwl_mvm_link_sta {
338 	struct rcu_head rcu_head;
339 	u32 sta_id;
340 	union {
341 		struct iwl_lq_sta_rs_fw rs_fw;
342 		struct iwl_lq_sta rs_drv;
343 	} lq_sta;
344 
345 	u16 orig_amsdu_len;
346 
347 	u8 avg_energy;
348 };
349 
350 struct iwl_mvm_mpdu_counter {
351 	u32 tx;
352 	u32 rx;
353 };
354 
355 /**
356  * struct iwl_mvm_tpt_counter - per-queue MPDU counter
357  *
358  * @lock: Needed to protect the counters when modified from statistics.
359  * @per_link: per-link counters.
360  * @window_start: timestamp of the counting-window start
361  */
362 struct iwl_mvm_tpt_counter {
363 	spinlock_t lock;
364 	struct iwl_mvm_mpdu_counter per_link[IWL_MVM_FW_MAX_LINK_ID];
365 	unsigned long window_start;
366 } ____cacheline_aligned_in_smp;
367 
368 /**
369  * struct iwl_mvm_sta - representation of a station in the driver
370  * @vif: the interface the station belongs to
371  * @tfd_queue_msk: the tfd queues used by the station
372  * @mac_id_n_color: the MAC context this station is linked to
373  * @tid_disable_agg: bitmap: if bit(tid) is set, the fw won't send ampdus for
374  *	tid.
375  * @sta_type: station type
376  * @authorized: indicates station is authorized
377  * @sta_state: station state according to enum %ieee80211_sta_state
378  * @bt_reduced_txpower: is reduced tx power enabled for this station
379  * @next_status_eosp: the next reclaimed packet is a PS-Poll response and
380  *	we need to signal the EOSP
381  * @lock: lock to protect the whole struct. Since %tid_data is access from Tx
382  * and from Tx response flow, it needs a spinlock.
383  * @tid_data: per tid data + mgmt. Look at %iwl_mvm_tid_data.
384  * @tid_to_baid: a simple map of TID to baid
385  * @vif: a vif pointer
386  * @reserved_queue: the queue reserved for this STA for DQA purposes
387  *	Every STA has is given one reserved queue to allow it to operate. If no
388  *	such queue can be guaranteed, the STA addition will fail.
389  * @tx_protection: reference counter for controlling the Tx protection.
390  * @tt_tx_protection: is thermal throttling enable Tx protection?
391  * @disable_tx: is tx to this STA disabled?
392  * @amsdu_enabled: bitmap of TX AMSDU allowed TIDs.
393  *	In case TLC offload is not active it is either 0xFFFF or 0.
394  * @max_amsdu_len: max AMSDU length
395  * @sleeping: indicates the station is sleeping (when not offloaded to FW)
396  * @agg_tids: bitmap of tids whose status is operational aggregated (IWL_AGG_ON)
397  * @sleeping: sta sleep transitions in power management
398  * @sleep_tx_count: the number of frames that we told the firmware to let out
399  *	even when that station is asleep. This is useful in case the queue
400  *	gets empty before all the frames were sent, which can happen when
401  *	we are sending frames from an AMPDU queue and there was a hole in
402  *	the BA window. To be used for UAPSD only.
403  * @ptk_pn: per-queue PTK PN data structures
404  * @dup_data: per queue duplicate packet detection data
405  * @tx_ant: the index of the antenna to use for data tx to this station. Only
406  *	used during connection establishment (e.g. for the 4 way handshake
407  *	exchange).
408  * @pairwise_cipher: used to feed iwlmei upon authorization
409  * @deflink: the default link station, for non-MLO STA, all link specific data
410  *	is accessed via deflink (or link[0]). For MLO, it will hold data of the
411  *	first added link STA.
412  * @link: per link sta entries. For non-MLO only link[0] holds data. For MLO,
413  *	link[0] points to deflink and link[link_id] is allocated when new link
414  *	sta is added.
415  * @mpdu_counters: RX/TX MPDUs counters for each queue.
416  *
417  * When mac80211 creates a station it reserves some space (hw->sta_data_size)
418  * in the structure for use by driver. This structure is placed in that
419  * space.
420  *
421  */
422 struct iwl_mvm_sta {
423 	u32 tfd_queue_msk;
424 	u32 mac_id_n_color;
425 	u16 tid_disable_agg;
426 	u8 sta_type;
427 	enum ieee80211_sta_state sta_state;
428 	bool bt_reduced_txpower;
429 	bool next_status_eosp;
430 	bool authorized;
431 	spinlock_t lock;
432 	struct iwl_mvm_tid_data tid_data[IWL_MAX_TID_COUNT + 1];
433 	u8 tid_to_baid[IWL_MAX_TID_COUNT];
434 	struct ieee80211_vif *vif;
435 	struct iwl_mvm_key_pn __rcu *ptk_pn[4];
436 	struct iwl_mvm_rxq_dup_data *dup_data;
437 
438 	u8 reserved_queue;
439 
440 	/* Temporary, until the new TLC will control the Tx protection */
441 	s8 tx_protection;
442 	bool tt_tx_protection;
443 
444 	bool disable_tx;
445 	u16 amsdu_enabled;
446 	u16 max_amsdu_len;
447 	bool sleeping;
448 	u8 agg_tids;
449 	u8 sleep_tx_count;
450 	u8 tx_ant;
451 	u32 pairwise_cipher;
452 
453 	struct iwl_mvm_link_sta deflink;
454 	struct iwl_mvm_link_sta __rcu *link[IEEE80211_MLD_MAX_NUM_LINKS];
455 
456 	struct iwl_mvm_tpt_counter *mpdu_counters;
457 };
458 
459 u16 iwl_mvm_tid_queued(struct iwl_mvm *mvm, struct iwl_mvm_tid_data *tid_data);
460 
461 static inline struct iwl_mvm_sta *
462 iwl_mvm_sta_from_mac80211(struct ieee80211_sta *sta)
463 {
464 	return (void *)sta->drv_priv;
465 }
466 
467 /**
468  * struct iwl_mvm_int_sta - representation of an internal station (auxiliary or
469  * broadcast)
470  * @sta_id: the index of the station in the fw (will be replaced by id_n_color)
471  * @type: station type
472  * @tfd_queue_msk: the tfd queues used by the station
473  */
474 struct iwl_mvm_int_sta {
475 	u32 sta_id;
476 	u8 type;
477 	u32 tfd_queue_msk;
478 };
479 
480 /**
481  * iwl_mvm_sta_send_to_fw - Send the STA info to the FW.
482  *
483  * @mvm: the iwl_mvm* to use
484  * @sta: the STA
485  * @update: this is true if the FW is being updated about a STA it already knows
486  *	about. Otherwise (if this is a new STA), this should be false.
487  * @flags: if update==true, this marks what is being changed via ORs of values
488  *	from enum iwl_sta_modify_flag. Otherwise, this is ignored.
489  */
490 int iwl_mvm_sta_send_to_fw(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
491 			   bool update, unsigned int flags);
492 int iwl_mvm_find_free_sta_id(struct iwl_mvm *mvm, enum nl80211_iftype iftype);
493 int iwl_mvm_sta_init(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
494 		     struct ieee80211_sta *sta, int sta_id, u8 sta_type);
495 int iwl_mvm_add_sta(struct iwl_mvm *mvm,
496 		    struct ieee80211_vif *vif,
497 		    struct ieee80211_sta *sta);
498 
499 static inline int iwl_mvm_update_sta(struct iwl_mvm *mvm,
500 				     struct ieee80211_vif *vif,
501 				     struct ieee80211_sta *sta)
502 {
503 	return iwl_mvm_sta_send_to_fw(mvm, sta, true, 0);
504 }
505 
506 void iwl_mvm_realloc_queues_after_restart(struct iwl_mvm *mvm,
507 					  struct ieee80211_sta *sta);
508 int iwl_mvm_wait_sta_queues_empty(struct iwl_mvm *mvm,
509 				  struct iwl_mvm_sta *mvm_sta);
510 bool iwl_mvm_sta_del(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
511 		     struct ieee80211_sta *sta,
512 		     struct ieee80211_link_sta *link_sta, int *ret);
513 int iwl_mvm_rm_sta(struct iwl_mvm *mvm,
514 		   struct ieee80211_vif *vif,
515 		   struct ieee80211_sta *sta);
516 int iwl_mvm_rm_sta_id(struct iwl_mvm *mvm,
517 		      struct ieee80211_vif *vif,
518 		      u8 sta_id);
519 int iwl_mvm_set_sta_key(struct iwl_mvm *mvm,
520 			struct ieee80211_vif *vif,
521 			struct ieee80211_sta *sta,
522 			struct ieee80211_key_conf *keyconf,
523 			u8 key_offset);
524 int iwl_mvm_remove_sta_key(struct iwl_mvm *mvm,
525 			   struct ieee80211_vif *vif,
526 			   struct ieee80211_sta *sta,
527 			   struct ieee80211_key_conf *keyconf);
528 
529 void iwl_mvm_update_tkip_key(struct iwl_mvm *mvm,
530 			     struct ieee80211_vif *vif,
531 			     struct ieee80211_key_conf *keyconf,
532 			     struct ieee80211_sta *sta, u32 iv32,
533 			     u16 *phase1key);
534 
535 void iwl_mvm_rx_eosp_notif(struct iwl_mvm *mvm,
536 			   struct iwl_rx_cmd_buffer *rxb);
537 
538 void iwl_mvm_count_mpdu(struct iwl_mvm_sta *mvm_sta, u8 fw_sta_id, u32 count,
539 			bool tx, int queue);
540 
541 /* AMPDU */
542 int iwl_mvm_sta_rx_agg(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
543 		       int tid, u16 ssn, bool start, u16 buf_size, u16 timeout);
544 int iwl_mvm_sta_tx_agg_start(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
545 			struct ieee80211_sta *sta, u16 tid, u16 *ssn);
546 int iwl_mvm_sta_tx_agg_oper(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
547 			    struct ieee80211_sta *sta, u16 tid, u16 buf_size,
548 			    bool amsdu);
549 int iwl_mvm_sta_tx_agg_stop(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
550 			    struct ieee80211_sta *sta, u16 tid);
551 int iwl_mvm_sta_tx_agg_flush(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
552 			    struct ieee80211_sta *sta, u16 tid);
553 
554 int iwl_mvm_sta_tx_agg(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
555 		       int tid, u8 queue, bool start);
556 
557 int iwl_mvm_add_aux_sta(struct iwl_mvm *mvm, u32 lmac_id);
558 int iwl_mvm_rm_aux_sta(struct iwl_mvm *mvm);
559 
560 int iwl_mvm_alloc_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
561 void iwl_mvm_free_bcast_sta_queues(struct iwl_mvm *mvm,
562 				   struct ieee80211_vif *vif);
563 int iwl_mvm_send_add_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
564 int iwl_mvm_add_p2p_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
565 int iwl_mvm_send_rm_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
566 int iwl_mvm_rm_p2p_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
567 int iwl_mvm_add_mcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
568 int iwl_mvm_rm_mcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
569 int iwl_mvm_allocate_int_sta(struct iwl_mvm *mvm,
570 			     struct iwl_mvm_int_sta *sta,
571 				    u32 qmask, enum nl80211_iftype iftype,
572 				    u8 type);
573 void iwl_mvm_dealloc_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
574 void iwl_mvm_dealloc_int_sta(struct iwl_mvm *mvm, struct iwl_mvm_int_sta *sta);
575 int iwl_mvm_add_snif_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
576 int iwl_mvm_rm_snif_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
577 void iwl_mvm_dealloc_snif_sta(struct iwl_mvm *mvm);
578 
579 void iwl_mvm_sta_modify_ps_wake(struct iwl_mvm *mvm,
580 				struct ieee80211_sta *sta);
581 void iwl_mvm_sta_modify_sleep_tx_count(struct iwl_mvm *mvm,
582 				       struct ieee80211_sta *sta,
583 				       enum ieee80211_frame_release_type reason,
584 				       u16 cnt, u16 tids, bool more_data,
585 				       bool single_sta_queue);
586 int iwl_mvm_drain_sta(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,
587 		      bool drain);
588 void iwl_mvm_sta_modify_disable_tx(struct iwl_mvm *mvm,
589 				   struct iwl_mvm_sta *mvmsta, bool disable);
590 void iwl_mvm_sta_modify_disable_tx_ap(struct iwl_mvm *mvm,
591 				      struct ieee80211_sta *sta,
592 				      bool disable);
593 void iwl_mvm_modify_all_sta_disable_tx(struct iwl_mvm *mvm,
594 				       struct iwl_mvm_vif *mvmvif,
595 				       bool disable);
596 
597 void iwl_mvm_csa_client_absent(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
598 int iwl_mvm_sta_ensure_queue(struct iwl_mvm *mvm, struct ieee80211_txq *txq);
599 void iwl_mvm_add_new_dqa_stream_wk(struct work_struct *wk);
600 #if defined(__linux__)
601 int iwl_mvm_add_pasn_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
602 			 struct iwl_mvm_int_sta *sta, u8 *addr, u32 cipher,
603 			 u8 *key, u32 key_len,
604 			 struct ieee80211_key_conf *key_conf_out);
605 #endif
606 void iwl_mvm_cancel_channel_switch(struct iwl_mvm *mvm,
607 				   struct ieee80211_vif *vif,
608 				   u32 id);
609 /* Queues */
610 int iwl_mvm_tvqm_enable_txq(struct iwl_mvm *mvm,
611 			    struct ieee80211_sta *sta,
612 			    u8 sta_id, u8 tid, unsigned int timeout);
613 
614 /* Sta state */
615 /**
616  * struct iwl_mvm_sta_state_ops - callbacks for the sta_state() ops
617  *
618  * Since the only difference between both MLD and
619  * non-MLD versions of sta_state() is these function calls,
620  * each version will send its specific function calls to
621  * %iwl_mvm_mac_sta_state_common().
622  *
623  * @add_sta: pointer to the function that adds a new sta
624  * @update_sta: pointer to the function that updates a sta
625  * @rm_sta: pointer to the functions that removes a sta
626  * @mac_ctxt_changed: pointer to the function that handles a change in mac ctxt
627  */
628 struct iwl_mvm_sta_state_ops {
629 	int (*add_sta)(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
630 		       struct ieee80211_sta *sta);
631 	int (*update_sta)(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
632 			  struct ieee80211_sta *sta);
633 	int (*rm_sta)(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
634 		      struct ieee80211_sta *sta);
635 	int (*mac_ctxt_changed)(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
636 				bool force_assoc_off);
637 };
638 
639 int iwl_mvm_mac_sta_state_common(struct ieee80211_hw *hw,
640 				 struct ieee80211_vif *vif,
641 				 struct ieee80211_sta *sta,
642 				 enum ieee80211_sta_state old_state,
643 				 enum ieee80211_sta_state new_state,
644 				 const struct iwl_mvm_sta_state_ops *callbacks);
645 
646 /* New MLD STA related APIs */
647 /* STA */
648 int iwl_mvm_mld_add_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
649 			      struct ieee80211_bss_conf *link_conf);
650 int iwl_mvm_mld_add_snif_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
651 			     struct ieee80211_bss_conf *link_conf);
652 int iwl_mvm_mld_add_mcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
653 			      struct ieee80211_bss_conf *link_conf);
654 int iwl_mvm_mld_add_aux_sta(struct iwl_mvm *mvm, u32 lmac_id);
655 int iwl_mvm_mld_rm_bcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
656 			     struct ieee80211_bss_conf *link_conf);
657 int iwl_mvm_mld_rm_snif_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
658 int iwl_mvm_mld_rm_mcast_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
659 			     struct ieee80211_bss_conf *link_conf);
660 int iwl_mvm_mld_rm_aux_sta(struct iwl_mvm *mvm);
661 int iwl_mvm_mld_add_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
662 			struct ieee80211_sta *sta);
663 int iwl_mvm_mld_update_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
664 			   struct ieee80211_sta *sta);
665 int iwl_mvm_mld_rm_sta(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
666 		       struct ieee80211_sta *sta);
667 void iwl_mvm_mld_free_sta_link(struct iwl_mvm *mvm,
668 			       struct iwl_mvm_sta *mvm_sta,
669 			       struct iwl_mvm_link_sta *mvm_sta_link,
670 			       unsigned int link_id,
671 			       bool is_in_fw);
672 int iwl_mvm_mld_rm_sta_id(struct iwl_mvm *mvm, u8 sta_id);
673 int iwl_mvm_mld_update_sta_links(struct iwl_mvm *mvm,
674 				 struct ieee80211_vif *vif,
675 				 struct ieee80211_sta *sta,
676 				 u16 old_links, u16 new_links);
677 u32 iwl_mvm_sta_fw_id_mask(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
678 			   int filter_link_id);
679 int iwl_mvm_mld_add_int_sta_with_queue(struct iwl_mvm *mvm,
680 				       struct iwl_mvm_int_sta *sta,
681 				       const u8 *addr, int link_id,
682 				       u16 *queue, u8 tid,
683 				       unsigned int *_wdg_timeout);
684 
685 /* Queues */
686 void iwl_mvm_mld_modify_all_sta_disable_tx(struct iwl_mvm *mvm,
687 					   struct iwl_mvm_vif *mvmvif,
688 					   bool disable);
689 void iwl_mvm_mld_sta_modify_disable_tx(struct iwl_mvm *mvm,
690 				       struct iwl_mvm_sta *mvm_sta,
691 				       bool disable);
692 void iwl_mvm_mld_sta_modify_disable_tx_ap(struct iwl_mvm *mvm,
693 					  struct ieee80211_sta *sta,
694 					  bool disable);
695 #endif /* __sta_h__ */
696