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