1 /*
2 * Copyright 2002-2005, Devicescape Software, Inc.
3 * Copyright 2013-2014 Intel Mobile Communications GmbH
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
8 */
9
10 #ifndef STA_INFO_H
11 #define STA_INFO_H
12
13 #include <linux/list.h>
14 #include <linux/types.h>
15 #include <linux/if_ether.h>
16 #include <linux/workqueue.h>
17 #include <linux/average.h>
18 #include <linux/etherdevice.h>
19 #include <linux/rhashtable.h>
20 #include "key.h"
21
22 /**
23 * enum ieee80211_sta_info_flags - Stations flags
24 *
25 * These flags are used with &struct sta_info's @flags member, but
26 * only indirectly with set_sta_flag() and friends.
27 *
28 * @WLAN_STA_AUTH: Station is authenticated.
29 * @WLAN_STA_ASSOC: Station is associated.
30 * @WLAN_STA_PS_STA: Station is in power-save mode
31 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
32 * This bit is always checked so needs to be enabled for all stations
33 * when virtual port control is not in use.
34 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
35 * frames.
36 * @WLAN_STA_WDS: Station is one of our WDS peers.
37 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
38 * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
39 * frame to this station is transmitted.
40 * @WLAN_STA_MFP: Management frame protection is used with this STA.
41 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
42 * during suspend/resume and station removal.
43 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
44 * power-save mode logically to flush frames that might still
45 * be in the queues
46 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
47 * station in power-save mode, reply when the driver unblocks.
48 * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
49 * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
50 * packets. This means the link is enabled.
51 * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
52 * station.
53 * @WLAN_STA_TDLS_CHAN_SWITCH: This TDLS peer supports TDLS channel-switching
54 * @WLAN_STA_TDLS_OFF_CHANNEL: The local STA is currently off-channel with this
55 * TDLS peer
56 * @WLAN_STA_TDLS_WIDER_BW: This TDLS peer supports working on a wider bw on
57 * the BSS base channel.
58 * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
59 * keeping station in power-save mode, reply when the driver
60 * unblocks the station.
61 * @WLAN_STA_SP: Station is in a service period, so don't try to
62 * reply to other uAPSD trigger frames or PS-Poll.
63 * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
64 * @WLAN_STA_INSERTED: This station is inserted into the hash table.
65 * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
66 * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
67 * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
68 * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
69 * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
70 * until pending frames are delivered
71 */
72 enum ieee80211_sta_info_flags {
73 WLAN_STA_AUTH,
74 WLAN_STA_ASSOC,
75 WLAN_STA_PS_STA,
76 WLAN_STA_AUTHORIZED,
77 WLAN_STA_SHORT_PREAMBLE,
78 WLAN_STA_WDS,
79 WLAN_STA_CLEAR_PS_FILT,
80 WLAN_STA_MFP,
81 WLAN_STA_BLOCK_BA,
82 WLAN_STA_PS_DRIVER,
83 WLAN_STA_PSPOLL,
84 WLAN_STA_TDLS_PEER,
85 WLAN_STA_TDLS_PEER_AUTH,
86 WLAN_STA_TDLS_INITIATOR,
87 WLAN_STA_TDLS_CHAN_SWITCH,
88 WLAN_STA_TDLS_OFF_CHANNEL,
89 WLAN_STA_TDLS_WIDER_BW,
90 WLAN_STA_UAPSD,
91 WLAN_STA_SP,
92 WLAN_STA_4ADDR_EVENT,
93 WLAN_STA_INSERTED,
94 WLAN_STA_RATE_CONTROL,
95 WLAN_STA_TOFFSET_KNOWN,
96 WLAN_STA_MPSP_OWNER,
97 WLAN_STA_MPSP_RECIPIENT,
98 WLAN_STA_PS_DELIVER,
99 };
100
101 #define ADDBA_RESP_INTERVAL HZ
102 #define HT_AGG_MAX_RETRIES 15
103 #define HT_AGG_BURST_RETRIES 3
104 #define HT_AGG_RETRIES_PERIOD (15 * HZ)
105
106 #define HT_AGG_STATE_DRV_READY 0
107 #define HT_AGG_STATE_RESPONSE_RECEIVED 1
108 #define HT_AGG_STATE_OPERATIONAL 2
109 #define HT_AGG_STATE_STOPPING 3
110 #define HT_AGG_STATE_WANT_START 4
111 #define HT_AGG_STATE_WANT_STOP 5
112
113 enum ieee80211_agg_stop_reason {
114 AGG_STOP_DECLINED,
115 AGG_STOP_LOCAL_REQUEST,
116 AGG_STOP_PEER_REQUEST,
117 AGG_STOP_DESTROY_STA,
118 };
119
120 /**
121 * struct tid_ampdu_tx - TID aggregation information (Tx).
122 *
123 * @rcu_head: rcu head for freeing structure
124 * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
125 * @addba_resp_timer: timer for peer's response to addba request
126 * @pending: pending frames queue -- use sta's spinlock to protect
127 * @dialog_token: dialog token for aggregation session
128 * @timeout: session timeout value to be filled in ADDBA requests
129 * @state: session state (see above)
130 * @last_tx: jiffies of last tx activity
131 * @stop_initiator: initiator of a session stop
132 * @tx_stop: TX DelBA frame when stopping
133 * @buf_size: reorder buffer size at receiver
134 * @failed_bar_ssn: ssn of the last failed BAR tx attempt
135 * @bar_pending: BAR needs to be re-sent
136 * @amsdu: support A-MSDU withing A-MDPU
137 *
138 * This structure's lifetime is managed by RCU, assignments to
139 * the array holding it must hold the aggregation mutex.
140 *
141 * The TX path can access it under RCU lock-free if, and
142 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
143 * set. Otherwise, the TX path must also acquire the spinlock
144 * and re-check the state, see comments in the tx code
145 * touching it.
146 */
147 struct tid_ampdu_tx {
148 struct rcu_head rcu_head;
149 struct timer_list session_timer;
150 struct timer_list addba_resp_timer;
151 struct sk_buff_head pending;
152 unsigned long state;
153 unsigned long last_tx;
154 u16 timeout;
155 u8 dialog_token;
156 u8 stop_initiator;
157 bool tx_stop;
158 u8 buf_size;
159
160 u16 failed_bar_ssn;
161 bool bar_pending;
162 bool amsdu;
163 };
164
165 /**
166 * struct tid_ampdu_rx - TID aggregation information (Rx).
167 *
168 * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an
169 * A-MSDU with individually reported subframes.
170 * @reorder_time: jiffies when skb was added
171 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
172 * @reorder_timer: releases expired frames from the reorder buffer.
173 * @last_rx: jiffies of last rx activity
174 * @head_seq_num: head sequence number in reordering buffer.
175 * @stored_mpdu_num: number of MPDUs in reordering buffer
176 * @ssn: Starting Sequence Number expected to be aggregated.
177 * @buf_size: buffer size for incoming A-MPDUs
178 * @timeout: reset timer value (in TUs).
179 * @dialog_token: dialog token for aggregation session
180 * @rcu_head: RCU head used for freeing this struct
181 * @reorder_lock: serializes access to reorder buffer, see below.
182 * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and
183 * and ssn.
184 * @removed: this session is removed (but might have been found due to RCU)
185 *
186 * This structure's lifetime is managed by RCU, assignments to
187 * the array holding it must hold the aggregation mutex.
188 *
189 * The @reorder_lock is used to protect the members of this
190 * struct, except for @timeout, @buf_size and @dialog_token,
191 * which are constant across the lifetime of the struct (the
192 * dialog token being used only for debugging).
193 */
194 struct tid_ampdu_rx {
195 struct rcu_head rcu_head;
196 spinlock_t reorder_lock;
197 struct sk_buff_head *reorder_buf;
198 unsigned long *reorder_time;
199 struct timer_list session_timer;
200 struct timer_list reorder_timer;
201 unsigned long last_rx;
202 u16 head_seq_num;
203 u16 stored_mpdu_num;
204 u16 ssn;
205 u16 buf_size;
206 u16 timeout;
207 u8 dialog_token;
208 bool auto_seq;
209 bool removed;
210 };
211
212 /**
213 * struct sta_ampdu_mlme - STA aggregation information.
214 *
215 * @tid_rx: aggregation info for Rx per TID -- RCU protected
216 * @tid_tx: aggregation info for Tx per TID
217 * @tid_start_tx: sessions where start was requested
218 * @addba_req_num: number of times addBA request has been sent.
219 * @last_addba_req_time: timestamp of the last addBA request.
220 * @dialog_token_allocator: dialog token enumerator for each new session;
221 * @work: work struct for starting/stopping aggregation
222 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
223 * RX timer expired until the work for it runs
224 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the
225 * driver requested to close until the work for it runs
226 * @mtx: mutex to protect all TX data (except non-NULL assignments
227 * to tid_tx[idx], which are protected by the sta spinlock)
228 * tid_start_tx is also protected by sta->lock.
229 */
230 struct sta_ampdu_mlme {
231 struct mutex mtx;
232 /* rx */
233 struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
234 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
235 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
236 /* tx */
237 struct work_struct work;
238 struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
239 struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
240 unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
241 u8 addba_req_num[IEEE80211_NUM_TIDS];
242 u8 dialog_token_allocator;
243 };
244
245
246 /* Value to indicate no TID reservation */
247 #define IEEE80211_TID_UNRESERVED 0xff
248
249 #define IEEE80211_FAST_XMIT_MAX_IV 18
250
251 /**
252 * struct ieee80211_fast_tx - TX fastpath information
253 * @key: key to use for hw crypto
254 * @hdr: the 802.11 header to put with the frame
255 * @hdr_len: actual 802.11 header length
256 * @sa_offs: offset of the SA
257 * @da_offs: offset of the DA
258 * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
259 * @band: band this will be transmitted on, for tx_info
260 * @rcu_head: RCU head to free this struct
261 *
262 * This struct is small enough so that the common case (maximum crypto
263 * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
264 * cache line.
265 */
266 struct ieee80211_fast_tx {
267 struct ieee80211_key *key;
268 u8 hdr_len;
269 u8 sa_offs, da_offs, pn_offs;
270 u8 band;
271 u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
272 sizeof(rfc1042_header)] __aligned(2);
273
274 struct rcu_head rcu_head;
275 };
276
277 /**
278 * struct mesh_sta - mesh STA information
279 * @plink_lock: serialize access to plink fields
280 * @llid: Local link ID
281 * @plid: Peer link ID
282 * @aid: local aid supplied by peer
283 * @reason: Cancel reason on PLINK_HOLDING state
284 * @plink_retries: Retries in establishment
285 * @plink_state: peer link state
286 * @plink_timeout: timeout of peer link
287 * @plink_timer: peer link watch timer
288 * @t_offset: timing offset relative to this host
289 * @t_offset_setpoint: reference timing offset of this sta to be used when
290 * calculating clockdrift
291 * @local_pm: local link-specific power save mode
292 * @peer_pm: peer-specific power save mode towards local STA
293 * @nonpeer_pm: STA power save mode towards non-peer neighbors
294 * @processed_beacon: set to true after peer rates and capabilities are
295 * processed
296 * @fail_avg: moving percentage of failed MSDUs
297 */
298 struct mesh_sta {
299 struct timer_list plink_timer;
300
301 s64 t_offset;
302 s64 t_offset_setpoint;
303
304 spinlock_t plink_lock;
305 u16 llid;
306 u16 plid;
307 u16 aid;
308 u16 reason;
309 u8 plink_retries;
310
311 bool processed_beacon;
312
313 enum nl80211_plink_state plink_state;
314 u32 plink_timeout;
315
316 /* mesh power save */
317 enum nl80211_mesh_power_mode local_pm;
318 enum nl80211_mesh_power_mode peer_pm;
319 enum nl80211_mesh_power_mode nonpeer_pm;
320
321 /* moving percentage of failed MSDUs */
322 unsigned int fail_avg;
323 };
324
325 DECLARE_EWMA(signal, 1024, 8)
326
327 /*
328 * IEEE 802.11-2016 (10.6 "Defragmentation") recommends support for "concurrent
329 * reception of at least one MSDU per access category per associated STA"
330 * on APs, or "at least one MSDU per access category" on other interface types.
331 *
332 * This limit can be increased by changing this define, at the cost of slower
333 * frame reassembly and increased memory use while fragments are pending.
334 */
335 #define IEEE80211_FRAGMENT_MAX 4
336
337 struct ieee80211_fragment_entry {
338 struct sk_buff_head skb_list;
339 unsigned long first_frag_time;
340 u16 seq;
341 u16 extra_len;
342 u16 last_frag;
343 u8 rx_queue;
344 u8 check_sequential_pn:1, /* needed for CCMP/GCMP */
345 is_protected:1;
346 u8 last_pn[6]; /* PN of the last fragment if CCMP was used */
347 unsigned int key_color;
348 };
349
350 struct ieee80211_fragment_cache {
351 struct ieee80211_fragment_entry entries[IEEE80211_FRAGMENT_MAX];
352 unsigned int next;
353 };
354
355 /**
356 * struct sta_info - STA information
357 *
358 * This structure collects information about a station that
359 * mac80211 is communicating with.
360 *
361 * @list: global linked list entry
362 * @free_list: list entry for keeping track of stations to free
363 * @hash_node: hash node for rhashtable
364 * @addr: station's MAC address - duplicated from public part to
365 * let the hash table work with just a single cacheline
366 * @local: pointer to the global information
367 * @sdata: virtual interface this station belongs to
368 * @ptk: peer keys negotiated with this station, if any
369 * @ptk_idx: last installed peer key index
370 * @gtk: group keys negotiated with this station, if any
371 * @rate_ctrl: rate control algorithm reference
372 * @rate_ctrl_lock: spinlock used to protect rate control data
373 * (data inside the algorithm, so serializes calls there)
374 * @rate_ctrl_priv: rate control private per-STA pointer
375 * @lock: used for locking all fields that require locking, see comments
376 * in the header file.
377 * @drv_deliver_wk: used for delivering frames after driver PS unblocking
378 * @listen_interval: listen interval of this station, when we're acting as AP
379 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
380 * @ps_lock: used for powersave (when mac80211 is the AP) related locking
381 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
382 * when it leaves power saving state or polls
383 * @tx_filtered: buffers (per AC) of frames we already tried to
384 * transmit but were filtered by hardware due to STA having
385 * entered power saving state, these are also delivered to
386 * the station when it leaves powersave or polls for frames
387 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
388 * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
389 * @last_connected: time (in seconds) when a station got connected
390 * @last_seq_ctrl: last received seq/frag number from this STA (per TID
391 * plus one for non-QoS frames)
392 * @tid_seq: per-TID sequence numbers for sending to this STA
393 * @ampdu_mlme: A-MPDU state machine state
394 * @timer_to_tid: identity mapping to ID timers
395 * @mesh: mesh STA information
396 * @debugfs: debug filesystem info
397 * @dead: set to true when sta is unlinked
398 * @uploaded: set to true when sta is uploaded to the driver
399 * @sta: station information we share with the driver
400 * @sta_state: duplicates information about station state (for debug)
401 * @beacon_loss_count: number of times beacon loss has triggered
402 * @rcu_head: RCU head used for freeing this station struct
403 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
404 * taken from HT/VHT capabilities or VHT operating mode notification
405 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
406 * AP only.
407 * @cipher_scheme: optional cipher scheme for this station
408 * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
409 * @fast_tx: TX fastpath information
410 * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
411 * the BSS one.
412 * @tx_stats: TX statistics
413 * @rx_stats: RX statistics
414 * @status_stats: TX status statistics
415 * @frags: fragment cache
416 */
417 struct sta_info {
418 /* General information, mostly static */
419 struct list_head list, free_list;
420 struct rcu_head rcu_head;
421 struct rhash_head hash_node;
422 u8 addr[ETH_ALEN];
423 struct ieee80211_local *local;
424 struct ieee80211_sub_if_data *sdata;
425 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
426 struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
427 u8 ptk_idx;
428 struct rate_control_ref *rate_ctrl;
429 void *rate_ctrl_priv;
430 spinlock_t rate_ctrl_lock;
431 spinlock_t lock;
432
433 struct ieee80211_fast_tx __rcu *fast_tx;
434
435 #ifdef CONFIG_MAC80211_MESH
436 struct mesh_sta *mesh;
437 #endif
438
439 struct work_struct drv_deliver_wk;
440
441 u16 listen_interval;
442
443 bool dead;
444
445 bool uploaded;
446
447 enum ieee80211_sta_state sta_state;
448
449 /* use the accessors defined below */
450 unsigned long _flags;
451
452 /* STA powersave lock and frame queues */
453 spinlock_t ps_lock;
454 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
455 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
456 unsigned long driver_buffered_tids;
457 unsigned long txq_buffered_tids;
458
459 long last_connected;
460
461 /* Updated from RX path only, no locking requirements */
462 struct {
463 unsigned long packets;
464 u64 bytes;
465 unsigned long last_rx;
466 unsigned long num_duplicates;
467 unsigned long fragments;
468 unsigned long dropped;
469 int last_signal;
470 struct ewma_signal avg_signal;
471 u8 chains;
472 s8 chain_signal_last[IEEE80211_MAX_CHAINS];
473 struct ewma_signal chain_signal_avg[IEEE80211_MAX_CHAINS];
474 int last_rate_idx;
475 u32 last_rate_flag;
476 u32 last_rate_vht_flag;
477 u8 last_rate_vht_nss;
478 u64 msdu[IEEE80211_NUM_TIDS + 1];
479 } rx_stats;
480
481 /* Plus 1 for non-QoS frames */
482 __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
483
484 /* Updated from TX status path only, no locking requirements */
485 struct {
486 unsigned long filtered;
487 unsigned long retry_failed, retry_count;
488 unsigned int lost_packets;
489 unsigned long last_tdls_pkt_time;
490 u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
491 u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
492 } status_stats;
493
494 /* Updated from TX path only, no locking requirements */
495 struct {
496 u64 packets[IEEE80211_NUM_ACS];
497 u64 bytes[IEEE80211_NUM_ACS];
498 struct ieee80211_tx_rate last_rate;
499 u64 msdu[IEEE80211_NUM_TIDS + 1];
500 } tx_stats;
501 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
502
503 /*
504 * Aggregation information, locked with lock.
505 */
506 struct sta_ampdu_mlme ampdu_mlme;
507 u8 timer_to_tid[IEEE80211_NUM_TIDS];
508
509 #ifdef CONFIG_MAC80211_DEBUGFS
510 struct sta_info_debugfsdentries {
511 struct dentry *dir;
512 bool add_has_run;
513 } debugfs;
514 #endif
515
516 enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
517
518 enum ieee80211_smps_mode known_smps_mode;
519 const struct ieee80211_cipher_scheme *cipher_scheme;
520
521 u8 reserved_tid;
522
523 struct cfg80211_chan_def tdls_chandef;
524
525 struct ieee80211_fragment_cache frags;
526
527 /* keep last! */
528 struct ieee80211_sta sta;
529 };
530
sta_plink_state(struct sta_info * sta)531 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
532 {
533 #ifdef CONFIG_MAC80211_MESH
534 return sta->mesh->plink_state;
535 #endif
536 return NL80211_PLINK_LISTEN;
537 }
538
set_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)539 static inline void set_sta_flag(struct sta_info *sta,
540 enum ieee80211_sta_info_flags flag)
541 {
542 WARN_ON(flag == WLAN_STA_AUTH ||
543 flag == WLAN_STA_ASSOC ||
544 flag == WLAN_STA_AUTHORIZED);
545 set_bit(flag, &sta->_flags);
546 }
547
clear_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)548 static inline void clear_sta_flag(struct sta_info *sta,
549 enum ieee80211_sta_info_flags flag)
550 {
551 WARN_ON(flag == WLAN_STA_AUTH ||
552 flag == WLAN_STA_ASSOC ||
553 flag == WLAN_STA_AUTHORIZED);
554 clear_bit(flag, &sta->_flags);
555 }
556
test_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)557 static inline int test_sta_flag(struct sta_info *sta,
558 enum ieee80211_sta_info_flags flag)
559 {
560 return test_bit(flag, &sta->_flags);
561 }
562
test_and_clear_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)563 static inline int test_and_clear_sta_flag(struct sta_info *sta,
564 enum ieee80211_sta_info_flags flag)
565 {
566 WARN_ON(flag == WLAN_STA_AUTH ||
567 flag == WLAN_STA_ASSOC ||
568 flag == WLAN_STA_AUTHORIZED);
569 return test_and_clear_bit(flag, &sta->_flags);
570 }
571
test_and_set_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)572 static inline int test_and_set_sta_flag(struct sta_info *sta,
573 enum ieee80211_sta_info_flags flag)
574 {
575 WARN_ON(flag == WLAN_STA_AUTH ||
576 flag == WLAN_STA_ASSOC ||
577 flag == WLAN_STA_AUTHORIZED);
578 return test_and_set_bit(flag, &sta->_flags);
579 }
580
581 int sta_info_move_state(struct sta_info *sta,
582 enum ieee80211_sta_state new_state);
583
sta_info_pre_move_state(struct sta_info * sta,enum ieee80211_sta_state new_state)584 static inline void sta_info_pre_move_state(struct sta_info *sta,
585 enum ieee80211_sta_state new_state)
586 {
587 int ret;
588
589 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
590
591 ret = sta_info_move_state(sta, new_state);
592 WARN_ON_ONCE(ret);
593 }
594
595
596 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
597 struct tid_ampdu_tx *tid_tx);
598
599 static inline struct tid_ampdu_tx *
rcu_dereference_protected_tid_tx(struct sta_info * sta,int tid)600 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
601 {
602 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
603 lockdep_is_held(&sta->lock) ||
604 lockdep_is_held(&sta->ampdu_mlme.mtx));
605 }
606
607 /* Maximum number of frames to buffer per power saving station per AC */
608 #define STA_MAX_TX_BUFFER 64
609
610 /* Minimum buffered frame expiry time. If STA uses listen interval that is
611 * smaller than this value, the minimum value here is used instead. */
612 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
613
614 /* How often station data is cleaned up (e.g., expiration of buffered frames)
615 */
616 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
617
618 /*
619 * Get a STA info, must be under RCU read lock.
620 */
621 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
622 const u8 *addr);
623
624 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
625 const u8 *addr);
626
627 u32 sta_addr_hash(const void *key, u32 length, u32 seed);
628
629 #define _sta_bucket_idx(_tbl, _a) \
630 rht_bucket_index(_tbl, sta_addr_hash(_a, ETH_ALEN, (_tbl)->hash_rnd))
631
632 #define for_each_sta_info(local, tbl, _addr, _sta, _tmp) \
633 rht_for_each_entry_rcu(_sta, _tmp, tbl, \
634 _sta_bucket_idx(tbl, _addr), \
635 hash_node) \
636 /* compare address and run code only if it matches */ \
637 if (ether_addr_equal(_sta->addr, (_addr)))
638
639 /*
640 * Get STA info by index, BROKEN!
641 */
642 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
643 int idx);
644 /*
645 * Create a new STA info, caller owns returned structure
646 * until sta_info_insert().
647 */
648 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
649 const u8 *addr, gfp_t gfp);
650
651 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
652
653 /*
654 * Insert STA info into hash table/list, returns zero or a
655 * -EEXIST if (if the same MAC address is already present).
656 *
657 * Calling the non-rcu version makes the caller relinquish,
658 * the _rcu version calls read_lock_rcu() and must be called
659 * without it held.
660 */
661 int sta_info_insert(struct sta_info *sta);
662 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
663
664 int __must_check __sta_info_destroy(struct sta_info *sta);
665 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
666 const u8 *addr);
667 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
668 const u8 *addr);
669
670 void sta_info_recalc_tim(struct sta_info *sta);
671
672 int sta_info_init(struct ieee80211_local *local);
673 void sta_info_stop(struct ieee80211_local *local);
674
675 /**
676 * sta_info_flush - flush matching STA entries from the STA table
677 *
678 * Returns the number of removed STA entries.
679 *
680 * @sdata: sdata to remove all stations from
681 * @vlans: if the given interface is an AP interface, also flush VLANs
682 */
683 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
684
sta_info_flush(struct ieee80211_sub_if_data * sdata)685 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
686 {
687 return __sta_info_flush(sdata, false);
688 }
689
690 void sta_set_rate_info_tx(struct sta_info *sta,
691 const struct ieee80211_tx_rate *rate,
692 struct rate_info *rinfo);
693 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo);
694
695 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
696 unsigned long exp_time);
697 u8 sta_info_tx_streams(struct sta_info *sta);
698
699 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
700 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
701 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
702
703 #endif /* STA_INFO_H */
704