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 */ 72enum 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 113enum 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 */ 147struct 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 */ 194struct 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 */ 230struct 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 */ 266struct 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)]; 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 */ 298struct 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 325DECLARE_EWMA(signal, 1024, 8) 326 327/** 328 * struct sta_info - STA information 329 * 330 * This structure collects information about a station that 331 * mac80211 is communicating with. 332 * 333 * @list: global linked list entry 334 * @free_list: list entry for keeping track of stations to free 335 * @hash_node: hash node for rhashtable 336 * @addr: station's MAC address - duplicated from public part to 337 * let the hash table work with just a single cacheline 338 * @local: pointer to the global information 339 * @sdata: virtual interface this station belongs to 340 * @ptk: peer keys negotiated with this station, if any 341 * @ptk_idx: last installed peer key index 342 * @gtk: group keys negotiated with this station, if any 343 * @rate_ctrl: rate control algorithm reference 344 * @rate_ctrl_lock: spinlock used to protect rate control data 345 * (data inside the algorithm, so serializes calls there) 346 * @rate_ctrl_priv: rate control private per-STA pointer 347 * @lock: used for locking all fields that require locking, see comments 348 * in the header file. 349 * @drv_deliver_wk: used for delivering frames after driver PS unblocking 350 * @listen_interval: listen interval of this station, when we're acting as AP 351 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly 352 * @ps_lock: used for powersave (when mac80211 is the AP) related locking 353 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station 354 * when it leaves power saving state or polls 355 * @tx_filtered: buffers (per AC) of frames we already tried to 356 * transmit but were filtered by hardware due to STA having 357 * entered power saving state, these are also delivered to 358 * the station when it leaves powersave or polls for frames 359 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on 360 * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on 361 * @last_connected: time (in seconds) when a station got connected 362 * @last_seq_ctrl: last received seq/frag number from this STA (per TID 363 * plus one for non-QoS frames) 364 * @tid_seq: per-TID sequence numbers for sending to this STA 365 * @ampdu_mlme: A-MPDU state machine state 366 * @timer_to_tid: identity mapping to ID timers 367 * @mesh: mesh STA information 368 * @debugfs: debug filesystem info 369 * @dead: set to true when sta is unlinked 370 * @removed: set to true when sta is being removed from sta_list 371 * @uploaded: set to true when sta is uploaded to the driver 372 * @sta: station information we share with the driver 373 * @sta_state: duplicates information about station state (for debug) 374 * @beacon_loss_count: number of times beacon loss has triggered 375 * @rcu_head: RCU head used for freeing this station struct 376 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station, 377 * taken from HT/VHT capabilities or VHT operating mode notification 378 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for 379 * AP only. 380 * @cipher_scheme: optional cipher scheme for this station 381 * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED) 382 * @fast_tx: TX fastpath information 383 * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to 384 * the BSS one. 385 * @tx_stats: TX statistics 386 * @rx_stats: RX statistics 387 * @status_stats: TX status statistics 388 */ 389struct sta_info { 390 /* General information, mostly static */ 391 struct list_head list, free_list; 392 struct rcu_head rcu_head; 393 struct rhash_head hash_node; 394 u8 addr[ETH_ALEN]; 395 struct ieee80211_local *local; 396 struct ieee80211_sub_if_data *sdata; 397 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS]; 398 struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS]; 399 u8 ptk_idx; 400 struct rate_control_ref *rate_ctrl; 401 void *rate_ctrl_priv; 402 spinlock_t rate_ctrl_lock; 403 spinlock_t lock; 404 405 struct ieee80211_fast_tx __rcu *fast_tx; 406 407#ifdef CONFIG_MAC80211_MESH 408 struct mesh_sta *mesh; 409#endif 410 411 struct work_struct drv_deliver_wk; 412 413 u16 listen_interval; 414 415 bool dead; 416 bool removed; 417 418 bool uploaded; 419 420 enum ieee80211_sta_state sta_state; 421 422 /* use the accessors defined below */ 423 unsigned long _flags; 424 425 /* STA powersave lock and frame queues */ 426 spinlock_t ps_lock; 427 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS]; 428 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS]; 429 unsigned long driver_buffered_tids; 430 unsigned long txq_buffered_tids; 431 432 long last_connected; 433 434 /* Updated from RX path only, no locking requirements */ 435 struct { 436 unsigned long packets; 437 u64 bytes; 438 unsigned long last_rx; 439 unsigned long num_duplicates; 440 unsigned long fragments; 441 unsigned long dropped; 442 int last_signal; 443 struct ewma_signal avg_signal; 444 u8 chains; 445 s8 chain_signal_last[IEEE80211_MAX_CHAINS]; 446 struct ewma_signal chain_signal_avg[IEEE80211_MAX_CHAINS]; 447 int last_rate_idx; 448 u32 last_rate_flag; 449 u32 last_rate_vht_flag; 450 u8 last_rate_vht_nss; 451 u64 msdu[IEEE80211_NUM_TIDS + 1]; 452 } rx_stats; 453 454 /* Plus 1 for non-QoS frames */ 455 __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1]; 456 457 /* Updated from TX status path only, no locking requirements */ 458 struct { 459 unsigned long filtered; 460 unsigned long retry_failed, retry_count; 461 unsigned int lost_packets; 462 unsigned long last_tdls_pkt_time; 463 u64 msdu_retries[IEEE80211_NUM_TIDS + 1]; 464 u64 msdu_failed[IEEE80211_NUM_TIDS + 1]; 465 } status_stats; 466 467 /* Updated from TX path only, no locking requirements */ 468 struct { 469 u64 packets[IEEE80211_NUM_ACS]; 470 u64 bytes[IEEE80211_NUM_ACS]; 471 struct ieee80211_tx_rate last_rate; 472 u64 msdu[IEEE80211_NUM_TIDS + 1]; 473 } tx_stats; 474 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1]; 475 476 /* 477 * Aggregation information, locked with lock. 478 */ 479 struct sta_ampdu_mlme ampdu_mlme; 480 u8 timer_to_tid[IEEE80211_NUM_TIDS]; 481 482#ifdef CONFIG_MAC80211_DEBUGFS 483 struct sta_info_debugfsdentries { 484 struct dentry *dir; 485 bool add_has_run; 486 } debugfs; 487#endif 488 489 enum ieee80211_sta_rx_bandwidth cur_max_bandwidth; 490 491 enum ieee80211_smps_mode known_smps_mode; 492 const struct ieee80211_cipher_scheme *cipher_scheme; 493 494 u8 reserved_tid; 495 496 struct cfg80211_chan_def tdls_chandef; 497 498 /* keep last! */ 499 struct ieee80211_sta sta; 500}; 501 502static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta) 503{ 504#ifdef CONFIG_MAC80211_MESH 505 return sta->mesh->plink_state; 506#endif 507 return NL80211_PLINK_LISTEN; 508} 509 510static inline void set_sta_flag(struct sta_info *sta, 511 enum ieee80211_sta_info_flags flag) 512{ 513 WARN_ON(flag == WLAN_STA_AUTH || 514 flag == WLAN_STA_ASSOC || 515 flag == WLAN_STA_AUTHORIZED); 516 set_bit(flag, &sta->_flags); 517} 518 519static inline void clear_sta_flag(struct sta_info *sta, 520 enum ieee80211_sta_info_flags flag) 521{ 522 WARN_ON(flag == WLAN_STA_AUTH || 523 flag == WLAN_STA_ASSOC || 524 flag == WLAN_STA_AUTHORIZED); 525 clear_bit(flag, &sta->_flags); 526} 527 528static inline int test_sta_flag(struct sta_info *sta, 529 enum ieee80211_sta_info_flags flag) 530{ 531 return test_bit(flag, &sta->_flags); 532} 533 534static inline int test_and_clear_sta_flag(struct sta_info *sta, 535 enum ieee80211_sta_info_flags flag) 536{ 537 WARN_ON(flag == WLAN_STA_AUTH || 538 flag == WLAN_STA_ASSOC || 539 flag == WLAN_STA_AUTHORIZED); 540 return test_and_clear_bit(flag, &sta->_flags); 541} 542 543static inline int test_and_set_sta_flag(struct sta_info *sta, 544 enum ieee80211_sta_info_flags flag) 545{ 546 WARN_ON(flag == WLAN_STA_AUTH || 547 flag == WLAN_STA_ASSOC || 548 flag == WLAN_STA_AUTHORIZED); 549 return test_and_set_bit(flag, &sta->_flags); 550} 551 552int sta_info_move_state(struct sta_info *sta, 553 enum ieee80211_sta_state new_state); 554 555static inline void sta_info_pre_move_state(struct sta_info *sta, 556 enum ieee80211_sta_state new_state) 557{ 558 int ret; 559 560 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED)); 561 562 ret = sta_info_move_state(sta, new_state); 563 WARN_ON_ONCE(ret); 564} 565 566 567void ieee80211_assign_tid_tx(struct sta_info *sta, int tid, 568 struct tid_ampdu_tx *tid_tx); 569 570static inline struct tid_ampdu_tx * 571rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid) 572{ 573 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid], 574 lockdep_is_held(&sta->lock) || 575 lockdep_is_held(&sta->ampdu_mlme.mtx)); 576} 577 578/* Maximum number of frames to buffer per power saving station per AC */ 579#define STA_MAX_TX_BUFFER 64 580 581/* Minimum buffered frame expiry time. If STA uses listen interval that is 582 * smaller than this value, the minimum value here is used instead. */ 583#define STA_TX_BUFFER_EXPIRE (10 * HZ) 584 585/* How often station data is cleaned up (e.g., expiration of buffered frames) 586 */ 587#define STA_INFO_CLEANUP_INTERVAL (10 * HZ) 588 589/* 590 * Get a STA info, must be under RCU read lock. 591 */ 592struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata, 593 const u8 *addr); 594 595struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata, 596 const u8 *addr); 597 598u32 sta_addr_hash(const void *key, u32 length, u32 seed); 599 600#define _sta_bucket_idx(_tbl, _a) \ 601 rht_bucket_index(_tbl, sta_addr_hash(_a, ETH_ALEN, (_tbl)->hash_rnd)) 602 603#define for_each_sta_info(local, tbl, _addr, _sta, _tmp) \ 604 rht_for_each_entry_rcu(_sta, _tmp, tbl, \ 605 _sta_bucket_idx(tbl, _addr), \ 606 hash_node) \ 607 /* compare address and run code only if it matches */ \ 608 if (ether_addr_equal(_sta->addr, (_addr))) 609 610/* 611 * Get STA info by index, BROKEN! 612 */ 613struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata, 614 int idx); 615/* 616 * Create a new STA info, caller owns returned structure 617 * until sta_info_insert(). 618 */ 619struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata, 620 const u8 *addr, gfp_t gfp); 621 622void sta_info_free(struct ieee80211_local *local, struct sta_info *sta); 623 624/* 625 * Insert STA info into hash table/list, returns zero or a 626 * -EEXIST if (if the same MAC address is already present). 627 * 628 * Calling the non-rcu version makes the caller relinquish, 629 * the _rcu version calls read_lock_rcu() and must be called 630 * without it held. 631 */ 632int sta_info_insert(struct sta_info *sta); 633int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU); 634 635int __must_check __sta_info_destroy(struct sta_info *sta); 636int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, 637 const u8 *addr); 638int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata, 639 const u8 *addr); 640 641void sta_info_recalc_tim(struct sta_info *sta); 642 643int sta_info_init(struct ieee80211_local *local); 644void sta_info_stop(struct ieee80211_local *local); 645 646/** 647 * sta_info_flush - flush matching STA entries from the STA table 648 * 649 * Returns the number of removed STA entries. 650 * 651 * @sdata: sdata to remove all stations from 652 * @vlans: if the given interface is an AP interface, also flush VLANs 653 */ 654int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans); 655 656static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata) 657{ 658 return __sta_info_flush(sdata, false); 659} 660 661void sta_set_rate_info_tx(struct sta_info *sta, 662 const struct ieee80211_tx_rate *rate, 663 struct rate_info *rinfo); 664void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo); 665 666void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata, 667 unsigned long exp_time); 668u8 sta_info_tx_streams(struct sta_info *sta); 669 670void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta); 671void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta); 672void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta); 673 674#endif /* STA_INFO_H */ 675