[mirror_ubuntu-artful-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 "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: 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).
 */
enum ieee80211_sta_info_flags {
	WLAN_STA_AUTH		= 1<<0,
	WLAN_STA_ASSOC		= 1<<1,
	WLAN_STA_PS		= 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
};

#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
 */
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;

	u16 listen_interval;

	/*
	 * 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);

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