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