[mirror_ubuntu-hirsute-kernel.git] / net / mac80211 / sta_info.h

/*
 * Copyright 2002-2005, Devicescape Software, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef STA_INFO_H
#define STA_INFO_H

#include <linux/list.h>
#include <linux/types.h>
#include <linux/if_ether.h>
#include <linux/workqueue.h>
#include "key.h"

/**
 * enum ieee80211_sta_info_flags - Stations flags
 *
 * These flags are used with &struct sta_info's @flags member.
 *
 * @WLAN_STA_AUTH: Station is authenticated.
 * @WLAN_STA_ASSOC: Station is associated.
 * @WLAN_STA_PS_STA: Station is in power-save mode
 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
 *	This bit is always checked so needs to be enabled for all stations
 *	when virtual port control is not in use.
 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
 *	frames.
 * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
 * @WLAN_STA_WME: Station is a QoS-STA.
 * @WLAN_STA_WDS: Station is one of our WDS peers.
 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
 *	IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
 *	frame to this station is transmitted.
 * @WLAN_STA_MFP: Management frame protection is used with this STA.
 * @WLAN_STA_SUSPEND: Set/cleared during a suspend/resume cycle.
 *	Used to deny ADDBA requests (both TX and RX).
 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
 *	power-save mode logically to flush frames that might still
 *	be in the queues
 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
 *	station in power-save mode, reply when the driver unblocks.
 */
enum ieee80211_sta_info_flags {
	WLAN_STA_AUTH		= 1<<0,
	WLAN_STA_ASSOC		= 1<<1,
	WLAN_STA_PS_STA		= 1<<2,
	WLAN_STA_AUTHORIZED	= 1<<3,
	WLAN_STA_SHORT_PREAMBLE	= 1<<4,
	WLAN_STA_ASSOC_AP	= 1<<5,
	WLAN_STA_WME		= 1<<6,
	WLAN_STA_WDS		= 1<<7,
	WLAN_STA_CLEAR_PS_FILT	= 1<<9,
	WLAN_STA_MFP		= 1<<10,
	WLAN_STA_SUSPEND	= 1<<11,
	WLAN_STA_PS_DRIVER	= 1<<12,
	WLAN_STA_PSPOLL		= 1<<13,
};

#define STA_TID_NUM 16
#define ADDBA_RESP_INTERVAL HZ
#define HT_AGG_MAX_RETRIES		(0x3)

#define HT_AGG_STATE_INITIATOR_SHIFT	(4)

#define HT_ADDBA_REQUESTED_MSK		BIT(0)
#define HT_ADDBA_DRV_READY_MSK		BIT(1)
#define HT_ADDBA_RECEIVED_MSK		BIT(2)
#define HT_AGG_STATE_REQ_STOP_BA_MSK	BIT(3)
#define HT_AGG_STATE_INITIATOR_MSK      BIT(HT_AGG_STATE_INITIATOR_SHIFT)
#define HT_AGG_STATE_IDLE		(0x0)
#define HT_AGG_STATE_OPERATIONAL	(HT_ADDBA_REQUESTED_MSK |	\
					 HT_ADDBA_DRV_READY_MSK |	\
					 HT_ADDBA_RECEIVED_MSK)

/**
 * struct tid_ampdu_tx - TID aggregation information (Tx).
 *
 * @addba_resp_timer: timer for peer's response to addba request
 * @pending: pending frames queue -- use sta's spinlock to protect
 * @ssn: Starting Sequence Number expected to be aggregated.
 * @dialog_token: dialog token for aggregation session
 */
struct tid_ampdu_tx {
	struct timer_list addba_resp_timer;
	struct sk_buff_head pending;
	u16 ssn;
	u8 dialog_token;
};

/**
 * struct tid_ampdu_rx - TID aggregation information (Rx).
 *
 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
 * @reorder_time: jiffies when skb was added
 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
 * @head_seq_num: head sequence number in reordering buffer.
 * @stored_mpdu_num: number of MPDUs in reordering buffer
 * @ssn: Starting Sequence Number expected to be aggregated.
 * @buf_size: buffer size for incoming A-MPDUs
 * @timeout: reset timer value (in TUs).
 * @dialog_token: dialog token for aggregation session
 * @shutdown: this session is being shut down due to STA removal
 */
struct tid_ampdu_rx {
	struct sk_buff **reorder_buf;
	unsigned long *reorder_time;
	struct timer_list session_timer;
	u16 head_seq_num;
	u16 stored_mpdu_num;
	u16 ssn;
	u16 buf_size;
	u16 timeout;
	u8 dialog_token;
	bool shutdown;
};

/**
 * enum plink_state - state of a mesh peer link finite state machine
 *
 * @PLINK_LISTEN: initial state, considered the implicit state of non existant
 * 	mesh peer links
 * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
 * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
 * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
 * 	peer
 * @PLINK_ESTAB: mesh peer link is established
 * @PLINK_HOLDING: mesh peer link is being closed or cancelled
 * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
 */
enum plink_state {
	PLINK_LISTEN,
	PLINK_OPN_SNT,
	PLINK_OPN_RCVD,
	PLINK_CNF_RCVD,
	PLINK_ESTAB,
	PLINK_HOLDING,
	PLINK_BLOCKED
};

/**
 * struct sta_ampdu_mlme - STA aggregation information.
 *
 * @tid_state_rx: TID's state in Rx session state machine.
 * @tid_rx: aggregation info for Rx per TID
 * @tid_state_tx: TID's state in Tx session state machine.
 * @tid_tx: aggregation info for Tx per TID
 * @addba_req_num: number of times addBA request has been sent.
 * @dialog_token_allocator: dialog token enumerator for each new session;
 */
struct sta_ampdu_mlme {
	/* rx */
	u8 tid_state_rx[STA_TID_NUM];
	struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
	/* tx */
	u8 tid_state_tx[STA_TID_NUM];
	struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
	u8 addba_req_num[STA_TID_NUM];
	u8 dialog_token_allocator;
};


/* see __sta_info_unlink */
#define STA_INFO_PIN_STAT_NORMAL	0
#define STA_INFO_PIN_STAT_PINNED	1
#define STA_INFO_PIN_STAT_DESTROY	2

/**
 * struct sta_info - STA information
 *
 * This structure collects information about a station that
 * mac80211 is communicating with.
 *
 * @list: global linked list entry
 * @hnext: hash table linked list pointer
 * @local: pointer to the global information
 * @sdata: virtual interface this station belongs to
 * @key: peer key negotiated with this station, if any
 * @rate_ctrl: rate control algorithm reference
 * @rate_ctrl_priv: rate control private per-STA pointer
 * @last_tx_rate: rate used for last transmit, to report to userspace as
 *	"the" transmit rate
 * @lock: used for locking all fields that require locking, see comments
 *	in the header file.
 * @flaglock: spinlock for flags accesses
 * @listen_interval: listen interval of this station, when we're acting as AP
 * @pin_status: used internally for pinning a STA struct into memory
 * @flags: STA flags, see &enum ieee80211_sta_info_flags
 * @ps_tx_buf: buffer of frames to transmit to this station
 *	when it leaves power saving state
 * @tx_filtered: buffer of frames we already tried to transmit
 *	but were filtered by hardware due to STA having entered
 *	power saving state
 * @rx_packets: Number of MSDUs received from this STA
 * @rx_bytes: Number of bytes received from this STA
 * @wep_weak_iv_count: number of weak WEP IVs received from this station
 * @last_rx: time (in jiffies) when last frame was received from this STA
 * @num_duplicates: number of duplicate frames received from this STA
 * @rx_fragments: number of received MPDUs
 * @rx_dropped: number of dropped MPDUs from this STA
 * @last_signal: signal of last received frame from this STA
 * @last_noise: noise of last received frame from this STA
 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
 * @tx_filtered_count: number of frames the hardware filtered for this STA
 * @tx_retry_failed: number of frames that failed retry
 * @tx_retry_count: total number of retries for frames to this STA
 * @fail_avg: moving percentage of failed MSDUs
 * @tx_packets: number of RX/TX MSDUs
 * @tx_bytes: number of bytes transmitted to this STA
 * @tx_fragments: number of transmitted MPDUs
 * @tid_seq: per-TID sequence numbers for sending to this STA
 * @ampdu_mlme: A-MPDU state machine state
 * @timer_to_tid: identity mapping to ID timers
 * @llid: Local link ID
 * @plid: Peer link ID
 * @reason: Cancel reason on PLINK_HOLDING state
 * @plink_retries: Retries in establishment
 * @ignore_plink_timer: ignore the peer-link timer (used internally)
 * @plink_state: peer link state
 * @plink_timeout: timeout of peer link
 * @plink_timer: peer link watch timer
 * @plink_timer_was_running: used by suspend/resume to restore timers
 * @debugfs: debug filesystem info
 * @sta: station information we share with the driver
 * @dead: set to true when sta is unlinked
 * @drv_unblock_wk used for driver PS unblocking
 */
struct sta_info {
	/* General information, mostly static */
	struct list_head list;
	struct sta_info *hnext;
	struct ieee80211_local *local;
	struct ieee80211_sub_if_data *sdata;
	struct ieee80211_key *key;
	struct rate_control_ref *rate_ctrl;
	void *rate_ctrl_priv;
	spinlock_t lock;
	spinlock_t flaglock;

	struct work_struct drv_unblock_wk;

	u16 listen_interval;

	bool dead;

	/*
	 * for use by the internal lifetime management,
	 * see __sta_info_unlink
	 */
	u8 pin_status;

	/*
	 * frequently updated, locked with own spinlock (flaglock),
	 * use the accessors defined below
	 */
	u32 flags;

	/*
	 * STA powersave frame queues, no more than the internal
	 * locking required.
	 */
	struct sk_buff_head ps_tx_buf;
	struct sk_buff_head tx_filtered;

	/* Updated from RX path only, no locking requirements */
	unsigned long rx_packets, rx_bytes;
	unsigned long wep_weak_iv_count;
	unsigned long last_rx;
	unsigned long num_duplicates;
	unsigned long rx_fragments;
	unsigned long rx_dropped;
	int last_signal;
	int last_noise;
	__le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];

	/* Updated from TX status path only, no locking requirements */
	unsigned long tx_filtered_count;
	unsigned long tx_retry_failed, tx_retry_count;
	/* moving percentage of failed MSDUs */
	unsigned int fail_avg;

	/* Updated from TX path only, no locking requirements */
	unsigned long tx_packets;
	unsigned long tx_bytes;
	unsigned long tx_fragments;
	struct ieee80211_tx_rate last_tx_rate;
	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];

	/*
	 * Aggregation information, locked with lock.
	 */
	struct sta_ampdu_mlme ampdu_mlme;
	u8 timer_to_tid[STA_TID_NUM];

#ifdef CONFIG_MAC80211_MESH
	/*
	 * Mesh peer link attributes
	 * TODO: move to a sub-structure that is referenced with pointer?
	 */
	__le16 llid;
	__le16 plid;
	__le16 reason;
	u8 plink_retries;
	bool ignore_plink_timer;
	bool plink_timer_was_running;
	enum plink_state plink_state;
	u32 plink_timeout;
	struct timer_list plink_timer;
#endif

#ifdef CONFIG_MAC80211_DEBUGFS
	struct sta_info_debugfsdentries {
		struct dentry *dir;
		bool add_has_run;
	} debugfs;
#endif

	/* keep last! */
	struct ieee80211_sta sta;
};

static inline enum plink_state sta_plink_state(struct sta_info *sta)
{
#ifdef CONFIG_MAC80211_MESH
	return sta->plink_state;
#endif
	return PLINK_LISTEN;
}

static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
{
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
	sta->flags |= flags;
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
}

static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
{
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
	sta->flags &= ~flags;
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
}

static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
{
	u32 ret;
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
	ret = sta->flags & flags;
	spin_unlock_irqrestore(&sta->flaglock, irqfl);

	return ret;
}

static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
					   const u32 flags)
{
	u32 ret;
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
	ret = sta->flags & flags;
	sta->flags &= ~flags;
	spin_unlock_irqrestore(&sta->flaglock, irqfl);

	return ret;
}

static inline u32 get_sta_flags(struct sta_info *sta)
{
	u32 ret;
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
	ret = sta->flags;
	spin_unlock_irqrestore(&sta->flaglock, irqfl);

	return ret;
}


#define STA_HASH_SIZE 256
#define STA_HASH(sta) (sta[5])


/* Maximum number of frames to buffer per power saving station */
#define STA_MAX_TX_BUFFER 128

/* Minimum buffered frame expiry time. If STA uses listen interval that is
 * smaller than this value, the minimum value here is used instead. */
#define STA_TX_BUFFER_EXPIRE (10 * HZ)

/* How often station data is cleaned up (e.g., expiration of buffered frames)
 */
#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)

/*
 * Get a STA info, must have be under RCU read lock.
 */
struct sta_info *sta_info_get(struct ieee80211_local *local, const u8 *addr);
/*
 * Get STA info by index, BROKEN!
 */
struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
				      struct net_device *dev);
/*
 * Create a new STA info, caller owns returned structure
 * until sta_info_insert().
 */
struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
				u8 *addr, gfp_t gfp);
/*
 * Insert STA info into hash table/list, returns zero or a
 * -EEXIST if (if the same MAC address is already present).
 *
 * Calling this without RCU protection makes the caller
 * relinquish its reference to @sta.
 */
int sta_info_insert(struct sta_info *sta);
/*
 * Unlink a STA info from the hash table/list.
 * This can NULL the STA pointer if somebody else
 * has already unlinked it.
 */
void sta_info_unlink(struct sta_info **sta);

void sta_info_destroy(struct sta_info *sta);
void sta_info_set_tim_bit(struct sta_info *sta);
void sta_info_clear_tim_bit(struct sta_info *sta);

void sta_info_init(struct ieee80211_local *local);
int sta_info_start(struct ieee80211_local *local);
void sta_info_stop(struct ieee80211_local *local);
int sta_info_flush(struct ieee80211_local *local,
		   struct ieee80211_sub_if_data *sdata);
void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
			  unsigned long exp_time);

void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);

#endif /* STA_INFO_H */
Commit	Line	Data
f0706e82 JB	1	/*
	2	* Copyright 2002-2005, Devicescape Software, Inc.
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License version 2 as
	6	* published by the Free Software Foundation.
	7	*/
	8
	9	#ifndef STA_INFO_H
	10	#define STA_INFO_H
	11
	12	#include <linux/list.h>
	13	#include <linux/types.h>
	14	#include <linux/if_ether.h>
af818581	15	#include <linux/workqueue.h>
2c8dccc7	16	#include "key.h"
f0706e82	17
238814fd JB	18	/**
	19	* enum ieee80211_sta_info_flags - Stations flags
	20	*
	21	* These flags are used with &struct sta_info's @flags member.
	22	*
	23	* @WLAN_STA_AUTH: Station is authenticated.
	24	* @WLAN_STA_ASSOC: Station is associated.
af818581	25	* @WLAN_STA_PS_STA: Station is in power-save mode
238814fd JB	26	* @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
	27	* This bit is always checked so needs to be enabled for all stations
	28	* when virtual port control is not in use.
	29	* @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
	30	* frames.
	31	* @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
	32	* @WLAN_STA_WME: Station is a QoS-STA.
	33	* @WLAN_STA_WDS: Station is one of our WDS peers.
d46e144b	34	* @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
e039fa4a	35	* IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
d46e144b	36	* frame to this station is transmitted.
5394af4d	37	* @WLAN_STA_MFP: Management frame protection is used with this STA.
722f069a S	38	* @WLAN_STA_SUSPEND: Set/cleared during a suspend/resume cycle.
722f069a S	39	* Used to deny ADDBA requests (both TX and RX).
af818581 JB	40	* @WLAN_STA_PS_DRIVER: driver requires keeping this station in
	41	* power-save mode logically to flush frames that might still
	42	* be in the queues
	43	* @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
	44	* station in power-save mode, reply when the driver unblocks.
238814fd JB	45	*/
	46	enum ieee80211_sta_info_flags {
	47	WLAN_STA_AUTH = 1<<0,
	48	WLAN_STA_ASSOC = 1<<1,
af818581	49	WLAN_STA_PS_STA = 1<<2,
836341a7 JB	50	WLAN_STA_AUTHORIZED = 1<<3,
	51	WLAN_STA_SHORT_PREAMBLE = 1<<4,
	52	WLAN_STA_ASSOC_AP = 1<<5,
	53	WLAN_STA_WME = 1<<6,
	54	WLAN_STA_WDS = 1<<7,
d46e144b	55	WLAN_STA_CLEAR_PS_FILT = 1<<9,
5394af4d	56	WLAN_STA_MFP = 1<<10,
af818581 JB	57	WLAN_STA_SUSPEND = 1<<11,
	58	WLAN_STA_PS_DRIVER = 1<<12,
	59	WLAN_STA_PSPOLL = 1<<13,
238814fd	60	};
f0706e82	61
5aae2880 RR	62	#define STA_TID_NUM 16
5aae2880 RR	63	#define ADDBA_RESP_INTERVAL HZ
80656c20	64	#define HT_AGG_MAX_RETRIES (0x3)
5aae2880 RR	65
	66	#define HT_AGG_STATE_INITIATOR_SHIFT (4)
	67
80656c20 RR	68	#define HT_ADDBA_REQUESTED_MSK BIT(0)
	69	#define HT_ADDBA_DRV_READY_MSK BIT(1)
	70	#define HT_ADDBA_RECEIVED_MSK BIT(2)
5aae2880	71	#define HT_AGG_STATE_REQ_STOP_BA_MSK BIT(3)
80656c20	72	#define HT_AGG_STATE_INITIATOR_MSK BIT(HT_AGG_STATE_INITIATOR_SHIFT)
5aae2880	73	#define HT_AGG_STATE_IDLE (0x0)
80656c20 RR	74	#define HT_AGG_STATE_OPERATIONAL (HT_ADDBA_REQUESTED_MSK \| \
	75	HT_ADDBA_DRV_READY_MSK \| \
	76	HT_ADDBA_RECEIVED_MSK)
	77
	78	/**
	79	* struct tid_ampdu_tx - TID aggregation information (Tx).
	80	*
80656c20	81	* @addba_resp_timer: timer for peer's response to addba request
cd8ffc80	82	* @pending: pending frames queue -- use sta's spinlock to protect
cee24a3e RR	83	* @ssn: Starting Sequence Number expected to be aggregated.
cee24a3e RR	84	* @dialog_token: dialog token for aggregation session
80656c20 RR	85	*/
80656c20 RR	86	struct tid_ampdu_tx {
80656c20	87	struct timer_list addba_resp_timer;
cd8ffc80	88	struct sk_buff_head pending;
cee24a3e RR	89	u16 ssn;
cee24a3e RR	90	u8 dialog_token;
80656c20	91	};
5aae2880 RR	92
	93	/**
	94	* struct tid_ampdu_rx - TID aggregation information (Rx).
	95	*
5aae2880	96	* @reorder_buf: buffer to reorder incoming aggregated MPDUs
4d050f1d	97	* @reorder_time: jiffies when skb was added
5aae2880	98	* @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
056cdd59 JB	99	* @head_seq_num: head sequence number in reordering buffer.
056cdd59 JB	100	* @stored_mpdu_num: number of MPDUs in reordering buffer
cee24a3e RR	101	* @ssn: Starting Sequence Number expected to be aggregated.
cee24a3e RR	102	* @buf_size: buffer size for incoming A-MPDUs
20ad19d0	103	* @timeout: reset timer value (in TUs).
cee24a3e	104	* @dialog_token: dialog token for aggregation session
0a16ec5f	105	* @shutdown: this session is being shut down due to STA removal
5aae2880 RR	106	*/
5aae2880 RR	107	struct tid_ampdu_rx {
5aae2880	108	struct sk_buff **reorder_buf;
4d050f1d	109	unsigned long *reorder_time;
5aae2880	110	struct timer_list session_timer;
056cdd59 JB	111	u16 head_seq_num;
056cdd59 JB	112	u16 stored_mpdu_num;
cee24a3e RR	113	u16 ssn;
	114	u16 buf_size;
	115	u16 timeout;
	116	u8 dialog_token;
55687e38	117	bool shutdown;
5aae2880 RR	118	};
5aae2880 RR	119
b4e08ea1 LCC	120	/**
	121	* enum plink_state - state of a mesh peer link finite state machine
	122	*
	123	* @PLINK_LISTEN: initial state, considered the implicit state of non existant
	124	* mesh peer links
	125	* @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
	126	* @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
	127	* @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
	128	* peer
	129	* @PLINK_ESTAB: mesh peer link is established
	130	* @PLINK_HOLDING: mesh peer link is being closed or cancelled
	131	* @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
	132	*/
ee385855	133	enum plink_state {
b4e08ea1 LCC	134	PLINK_LISTEN,
	135	PLINK_OPN_SNT,
	136	PLINK_OPN_RCVD,
	137	PLINK_CNF_RCVD,
	138	PLINK_ESTAB,
	139	PLINK_HOLDING,
	140	PLINK_BLOCKED
ee385855	141	};
ee385855	142
5aae2880 RR	143	/**
	144	* struct sta_ampdu_mlme - STA aggregation information.
	145	*
cee24a3e	146	* @tid_state_rx: TID's state in Rx session state machine.
80656c20	147	* @tid_rx: aggregation info for Rx per TID
cee24a3e RR	148	* @tid_state_tx: TID's state in Tx session state machine.
	149	* @tid_tx: aggregation info for Tx per TID
	150	* @addba_req_num: number of times addBA request has been sent.
80656c20	151	* @dialog_token_allocator: dialog token enumerator for each new session;
5aae2880 RR	152	*/
5aae2880 RR	153	struct sta_ampdu_mlme {
cee24a3e RR	154	/* rx */
	155	u8 tid_state_rx[STA_TID_NUM];
	156	struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
cee24a3e RR	157	/* tx */
	158	u8 tid_state_tx[STA_TID_NUM];
	159	struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
	160	u8 addba_req_num[STA_TID_NUM];
80656c20	161	u8 dialog_token_allocator;
5aae2880	162	};
f0706e82	163
d0709a65 JB	164
	165	/* see __sta_info_unlink */
	166	#define STA_INFO_PIN_STAT_NORMAL 0
	167	#define STA_INFO_PIN_STAT_PINNED 1
	168	#define STA_INFO_PIN_STAT_DESTROY 2
	169
693b1bbc JB	170	/**
	171	* struct sta_info - STA information
	172	*
	173	* This structure collects information about a station that
	174	* mac80211 is communicating with.
	175	*
	176	* @list: global linked list entry
	177	* @hnext: hash table linked list pointer
	178	* @local: pointer to the global information
e25cf4a6 JB	179	* @sdata: virtual interface this station belongs to
	180	* @key: peer key negotiated with this station, if any
	181	* @rate_ctrl: rate control algorithm reference
	182	* @rate_ctrl_priv: rate control private per-STA pointer
	183	* @last_tx_rate: rate used for last transmit, to report to userspace as
	184	* "the" transmit rate
6ef307bc RD	185	* @lock: used for locking all fields that require locking, see comments
	186	* in the header file.
	187	* @flaglock: spinlock for flags accesses
e25cf4a6 JB	188	* @listen_interval: listen interval of this station, when we're acting as AP
e25cf4a6 JB	189	* @pin_status: used internally for pinning a STA struct into memory
693b1bbc JB	190	* @flags: STA flags, see &enum ieee80211_sta_info_flags
	191	* @ps_tx_buf: buffer of frames to transmit to this station
	192	* when it leaves power saving state
	193	* @tx_filtered: buffer of frames we already tried to transmit
	194	* but were filtered by hardware due to STA having entered
	195	* power saving state
	196	* @rx_packets: Number of MSDUs received from this STA
	197	* @rx_bytes: Number of bytes received from this STA
e25cf4a6 JB	198	* @wep_weak_iv_count: number of weak WEP IVs received from this station
e25cf4a6 JB	199	* @last_rx: time (in jiffies) when last frame was received from this STA
6ef307bc RD	200	* @num_duplicates: number of duplicate frames received from this STA
	201	* @rx_fragments: number of received MPDUs
	202	* @rx_dropped: number of dropped MPDUs from this STA
	203	* @last_signal: signal of last received frame from this STA
6ef307bc RD	204	* @last_noise: noise of last received frame from this STA
6ef307bc RD	205	* @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
e25cf4a6 JB	206	* @tx_filtered_count: number of frames the hardware filtered for this STA
	207	* @tx_retry_failed: number of frames that failed retry
	208	* @tx_retry_count: total number of retries for frames to this STA
6ef307bc RD	209	* @fail_avg: moving percentage of failed MSDUs
6ef307bc RD	210	* @tx_packets: number of RX/TX MSDUs
e25cf4a6	211	* @tx_bytes: number of bytes transmitted to this STA
6ef307bc	212	* @tx_fragments: number of transmitted MPDUs
e25cf4a6 JB	213	* @tid_seq: per-TID sequence numbers for sending to this STA
e25cf4a6 JB	214	* @ampdu_mlme: A-MPDU state machine state
6ef307bc	215	* @timer_to_tid: identity mapping to ID timers
6ef307bc RD	216	* @llid: Local link ID
	217	* @plid: Peer link ID
	218	* @reason: Cancel reason on PLINK_HOLDING state
	219	* @plink_retries: Retries in establishment
e25cf4a6 JB	220	* @ignore_plink_timer: ignore the peer-link timer (used internally)
	221	* @plink_state: peer link state
	222	* @plink_timeout: timeout of peer link
	223	* @plink_timer: peer link watch timer
cce4c77b	224	* @plink_timer_was_running: used by suspend/resume to restore timers
6ef307bc	225	* @debugfs: debug filesystem info
17741cdc	226	* @sta: station information we share with the driver
af818581 JB	227	* @dead: set to true when sta is unlinked
af818581 JB	228	* @drv_unblock_wk used for driver PS unblocking
693b1bbc	229	*/
f0706e82	230	struct sta_info {
693b1bbc	231	/* General information, mostly static */
f0706e82	232	struct list_head list;
693b1bbc	233	struct sta_info *hnext;
f0706e82	234	struct ieee80211_local *local;
d0709a65	235	struct ieee80211_sub_if_data *sdata;
f0706e82	236	struct ieee80211_key *key;
f0706e82 JB	237	struct rate_control_ref *rate_ctrl;
f0706e82 JB	238	void *rate_ctrl_priv;
07346f81	239	spinlock_t lock;
5a9f7b04	240	spinlock_t flaglock;
17741cdc	241
af818581 JB	242	struct work_struct drv_unblock_wk;
af818581 JB	243
693b1bbc	244	u16 listen_interval;
f0706e82	245
af818581 JB	246	bool dead;
af818581 JB	247
693b1bbc JB	248	/*
	249	* for use by the internal lifetime management,
	250	* see __sta_info_unlink
	251	*/
	252	u8 pin_status;
	253
5a9f7b04 JB	254	/*
	255	* frequently updated, locked with own spinlock (flaglock),
	256	* use the accessors defined below
	257	*/
693b1bbc JB	258	u32 flags;
	259
	260	/*
	261	* STA powersave frame queues, no more than the internal
	262	* locking required.
	263	*/
	264	struct sk_buff_head ps_tx_buf;
	265	struct sk_buff_head tx_filtered;
	266
	267	/* Updated from RX path only, no locking requirements */
	268	unsigned long rx_packets, rx_bytes;
	269	unsigned long wep_weak_iv_count;
	270	unsigned long last_rx;
6ef307bc RD	271	unsigned long num_duplicates;
	272	unsigned long rx_fragments;
	273	unsigned long rx_dropped;
	274	int last_signal;
6ef307bc	275	int last_noise;
693b1bbc	276	__le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
693b1bbc JB	277
	278	/* Updated from TX status path only, no locking requirements */
	279	unsigned long tx_filtered_count;
	280	unsigned long tx_retry_failed, tx_retry_count;
693b1bbc JB	281	/* moving percentage of failed MSDUs */
	282	unsigned int fail_avg;
	283
	284	/* Updated from TX path only, no locking requirements */
6ef307bc	285	unsigned long tx_packets;
693b1bbc	286	unsigned long tx_bytes;
6ef307bc	287	unsigned long tx_fragments;
e6a9854b	288	struct ieee80211_tx_rate last_tx_rate;
f591fa5d	289	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
f0706e82	290
d0709a65	291	/*
07346f81	292	* Aggregation information, locked with lock.
d0709a65	293	*/
5aae2880	294	struct sta_ampdu_mlme ampdu_mlme;
6ef307bc	295	u8 timer_to_tid[STA_TID_NUM];
693b1bbc	296
ee385855	297	#ifdef CONFIG_MAC80211_MESH
693b1bbc JB	298	/*
	299	* Mesh peer link attributes
	300	* TODO: move to a sub-structure that is referenced with pointer?
	301	*/
6ef307bc RD	302	__le16 llid;
	303	__le16 plid;
	304	__le16 reason;
	305	u8 plink_retries;
7495883b	306	bool ignore_plink_timer;
5bb644a0	307	bool plink_timer_was_running;
ee385855 LCC	308	enum plink_state plink_state;
	309	u32 plink_timeout;
	310	struct timer_list plink_timer;
ee385855	311	#endif
10816d40	312
e9f207f0 JB	313	#ifdef CONFIG_MAC80211_DEBUGFS
	314	struct sta_info_debugfsdentries {
	315	struct dentry *dir;
63044e9f	316	bool add_has_run;
e9f207f0 JB	317	} debugfs;
e9f207f0 JB	318	#endif
17741cdc JB	319
	320	/* keep last! */
	321	struct ieee80211_sta sta;
f0706e82 JB	322	};
f0706e82 JB	323
d6d1a5a7 JB	324	static inline enum plink_state sta_plink_state(struct sta_info *sta)
	325	{
	326	#ifdef CONFIG_MAC80211_MESH
	327	return sta->plink_state;
	328	#endif
b4e08ea1	329	return PLINK_LISTEN;
d6d1a5a7 JB	330	}
d6d1a5a7 JB	331
07346f81 JB	332	static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
07346f81 JB	333	{
5a9f7b04 JB	334	unsigned long irqfl;
	335
	336	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	337	sta->flags \|= flags;
5a9f7b04	338	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	339	}
	340
	341	static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
	342	{
5a9f7b04 JB	343	unsigned long irqfl;
	344
	345	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	346	sta->flags &= ~flags;
5a9f7b04	347	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	348	}
07346f81 JB	349
07346f81 JB	350	static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
	351	{
	352	u32 ret;
5a9f7b04	353	unsigned long irqfl;
07346f81	354
5a9f7b04	355	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	356	ret = sta->flags & flags;
5a9f7b04	357	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	358
	359	return ret;
	360	}
	361
	362	static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
	363	const u32 flags)
	364	{
	365	u32 ret;
5a9f7b04	366	unsigned long irqfl;
07346f81	367
5a9f7b04	368	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81 JB	369	ret = sta->flags & flags;
07346f81 JB	370	sta->flags &= ~flags;
5a9f7b04	371	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	372
	373	return ret;
	374	}
	375
	376	static inline u32 get_sta_flags(struct sta_info *sta)
	377	{
	378	u32 ret;
5a9f7b04	379	unsigned long irqfl;
07346f81	380
5a9f7b04	381	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	382	ret = sta->flags;
5a9f7b04	383	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	384
	385	return ret;
	386	}
	387
f0706e82	388
f0706e82 JB	389
	390	#define STA_HASH_SIZE 256
	391	#define STA_HASH(sta) (sta[5])
	392
	393
	394	/* Maximum number of frames to buffer per power saving station */
	395	#define STA_MAX_TX_BUFFER 128
	396
	397	/* Minimum buffered frame expiry time. If STA uses listen interval that is
	398	* smaller than this value, the minimum value here is used instead. */
	399	#define STA_TX_BUFFER_EXPIRE (10 * HZ)
	400
	401	/* How often station data is cleaned up (e.g., expiration of buffered frames)
	402	*/
	403	#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
	404
d0709a65 JB	405	/*
	406	* Get a STA info, must have be under RCU read lock.
	407	*/
4b7679a5	408	struct sta_info sta_info_get(struct ieee80211_local local, const u8 *addr);
d0709a65 JB	409	/*
	410	* Get STA info by index, BROKEN!
	411	*/
ee385855 LCC	412	struct sta_info sta_info_get_by_idx(struct ieee80211_local local, int idx,
ee385855 LCC	413	struct net_device *dev);
d0709a65	414	/*
73651ee6 JB	415	* Create a new STA info, caller owns returned structure
73651ee6 JB	416	* until sta_info_insert().
d0709a65	417	*/
73651ee6 JB	418	struct sta_info sta_info_alloc(struct ieee80211_sub_if_data sdata,
	419	u8 *addr, gfp_t gfp);
	420	/*
	421	* Insert STA info into hash table/list, returns zero or a
	422	* -EEXIST if (if the same MAC address is already present).
	423	*
	424	* Calling this without RCU protection makes the caller
	425	* relinquish its reference to @sta.
	426	*/
	427	int sta_info_insert(struct sta_info *sta);
d0709a65 JB	428	/*
	429	* Unlink a STA info from the hash table/list.
	430	* This can NULL the STA pointer if somebody else
	431	* has already unlinked it.
	432	*/
	433	void sta_info_unlink(struct sta_info **sta);
f0706e82	434
d0709a65	435	void sta_info_destroy(struct sta_info *sta);
004c872e JB	436	void sta_info_set_tim_bit(struct sta_info *sta);
	437	void sta_info_clear_tim_bit(struct sta_info *sta);
	438
d0709a65 JB	439	void sta_info_init(struct ieee80211_local *local);
	440	int sta_info_start(struct ieee80211_local *local);
	441	void sta_info_stop(struct ieee80211_local *local);
44213b5e	442	int sta_info_flush(struct ieee80211_local *local,
af8cdcd8	443	struct ieee80211_sub_if_data *sdata);
24723d1b JB	444	void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
24723d1b JB	445	unsigned long exp_time);
d0709a65	446
af818581 JB	447	void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
	448	void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
	449
f0706e82	450	#endif /* STA_INFO_H */