[deliverable/linux.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_PSPOLL: Station has just PS-polled us.
 * @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.
 */
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_PSPOLL		= 1<<8,
	WLAN_STA_CLEAR_PS_FILT	= 1<<9,
};

#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)
#define HT_AGG_STATE_DEBUGFS_CTL	BIT(7)

/**
 * struct tid_ampdu_tx - TID aggregation information (Tx).
 *
 * @addba_resp_timer: timer for peer's response to addba request
 * @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;
	u16 ssn;
	u8 dialog_token;
};

/**
 * struct tid_ampdu_rx - TID aggregation information (Rx).
 *
 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
 * @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.
 * @dialog_token: dialog token for aggregation session
 */
struct tid_ampdu_rx {
	struct sk_buff **reorder_buf;
	struct timer_list session_timer;
	u16 head_seq_num;
	u16 stored_mpdu_num;
	u16 ssn;
	u16 buf_size;
	u16 timeout;
	u8 dialog_token;
};

/**
 * 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: TBD
 * @key: TBD
 * @rate_ctrl: TBD
 * @rate_ctrl_priv: TBD
 * @lock: used for locking all fields that require locking, see comments
 *	in the header file.
 * @flaglock: spinlock for flags accesses
 * @addr: MAC address of this STA
 * @aid: STA's unique AID (1..2007, 0 = not assigned yet),
 *	only used in AP (and IBSS?) mode
 * @listen_interval: TBD
 * @pin_status: TBD
 * @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: TBD
 * @last_rx: TBD
 * @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_qual: qual 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: TBD
 * @tx_retry_failed: TBD
 * @tx_retry_count: TBD
 * @fail_avg: moving percentage of failed MSDUs
 * @tx_packets: number of RX/TX MSDUs
 * @tx_bytes: TBD
 * @tx_fragments: number of transmitted MPDUs
 * @last_txrate_idx: Index of the last used transmit rate
 * @tid_seq: TBD
 * @ampdu_mlme: TBD
 * @timer_to_tid: identity mapping to ID timers
 * @tid_to_tx_q: map tid to tx queue
 * @llid: Local link ID
 * @plid: Peer link ID
 * @reason: Cancel reason on PLINK_HOLDING state
 * @plink_retries: Retries in establishment
 * @ignore_plink_timer: TBD
 * @plink_state plink_state: TBD
 * @plink_timeout: TBD
 * @plink_timer: TBD
 * @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_qual;
	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;
	unsigned int last_txrate_idx;
	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];
	u8 tid_to_tx_q[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;
	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;
		struct dentry *flags;
		struct dentry *num_ps_buf_frames;
		struct dentry *inactive_ms;
		struct dentry *last_seq_ctrl;
		struct dentry *agg_status;
	} 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 void set_and_clear_sta_flags(struct sta_info *sta,
					   const u32 set, const u32 clear)
{
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
	sta->flags |= set;
	sta->flags &= ~clear;
	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;
}


/* Maximum number of concurrently registered stations */
#define MAX_STA_COUNT 2007

#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 sta_info_flush_delayed(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.
4a9a66e9	33	* @WLAN_STA_PSPOLL: Station has just PS-polled us.
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.
238814fd JB	37	*/
	38	enum ieee80211_sta_info_flags {
	39	WLAN_STA_AUTH = 1<<0,
	40	WLAN_STA_ASSOC = 1<<1,
	41	WLAN_STA_PS = 1<<2,
836341a7 JB	42	WLAN_STA_AUTHORIZED = 1<<3,
	43	WLAN_STA_SHORT_PREAMBLE = 1<<4,
	44	WLAN_STA_ASSOC_AP = 1<<5,
	45	WLAN_STA_WME = 1<<6,
	46	WLAN_STA_WDS = 1<<7,
	47	WLAN_STA_PSPOLL = 1<<8,
d46e144b	48	WLAN_STA_CLEAR_PS_FILT = 1<<9,
238814fd	49	};
f0706e82	50
5aae2880 RR	51	#define STA_TID_NUM 16
5aae2880 RR	52	#define ADDBA_RESP_INTERVAL HZ
80656c20	53	#define HT_AGG_MAX_RETRIES (0x3)
5aae2880 RR	54
	55	#define HT_AGG_STATE_INITIATOR_SHIFT (4)
	56
80656c20 RR	57	#define HT_ADDBA_REQUESTED_MSK BIT(0)
	58	#define HT_ADDBA_DRV_READY_MSK BIT(1)
	59	#define HT_ADDBA_RECEIVED_MSK BIT(2)
5aae2880	60	#define HT_AGG_STATE_REQ_STOP_BA_MSK BIT(3)
80656c20	61	#define HT_AGG_STATE_INITIATOR_MSK BIT(HT_AGG_STATE_INITIATOR_SHIFT)
5aae2880	62	#define HT_AGG_STATE_IDLE (0x0)
80656c20 RR	63	#define HT_AGG_STATE_OPERATIONAL (HT_ADDBA_REQUESTED_MSK \| \
	64	HT_ADDBA_DRV_READY_MSK \| \
	65	HT_ADDBA_RECEIVED_MSK)
24709182	66	#define HT_AGG_STATE_DEBUGFS_CTL BIT(7)
80656c20 RR	67
	68	/**
	69	* struct tid_ampdu_tx - TID aggregation information (Tx).
	70	*
80656c20	71	* @addba_resp_timer: timer for peer's response to addba request
cee24a3e RR	72	* @ssn: Starting Sequence Number expected to be aggregated.
cee24a3e RR	73	* @dialog_token: dialog token for aggregation session
80656c20 RR	74	*/
80656c20 RR	75	struct tid_ampdu_tx {
80656c20	76	struct timer_list addba_resp_timer;
cee24a3e RR	77	u16 ssn;
cee24a3e RR	78	u8 dialog_token;
80656c20	79	};
5aae2880 RR	80
	81	/**
	82	* struct tid_ampdu_rx - TID aggregation information (Rx).
	83	*
5aae2880 RR	84	* @reorder_buf: buffer to reorder incoming aggregated MPDUs
5aae2880 RR	85	* @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
056cdd59 JB	86	* @head_seq_num: head sequence number in reordering buffer.
056cdd59 JB	87	* @stored_mpdu_num: number of MPDUs in reordering buffer
cee24a3e RR	88	* @ssn: Starting Sequence Number expected to be aggregated.
	89	* @buf_size: buffer size for incoming A-MPDUs
	90	* @timeout: reset timer value.
	91	* @dialog_token: dialog token for aggregation session
5aae2880 RR	92	*/
5aae2880 RR	93	struct tid_ampdu_rx {
5aae2880 RR	94	struct sk_buff **reorder_buf;
5aae2880 RR	95	struct timer_list session_timer;
056cdd59 JB	96	u16 head_seq_num;
056cdd59 JB	97	u16 stored_mpdu_num;
cee24a3e RR	98	u16 ssn;
	99	u16 buf_size;
	100	u16 timeout;
	101	u8 dialog_token;
5aae2880 RR	102	};
5aae2880 RR	103
b4e08ea1 LCC	104	/**
	105	* enum plink_state - state of a mesh peer link finite state machine
	106	*
	107	* @PLINK_LISTEN: initial state, considered the implicit state of non existant
	108	* mesh peer links
	109	* @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
	110	* @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
	111	* @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
	112	* peer
	113	* @PLINK_ESTAB: mesh peer link is established
	114	* @PLINK_HOLDING: mesh peer link is being closed or cancelled
	115	* @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
	116	*/
ee385855	117	enum plink_state {
b4e08ea1 LCC	118	PLINK_LISTEN,
	119	PLINK_OPN_SNT,
	120	PLINK_OPN_RCVD,
	121	PLINK_CNF_RCVD,
	122	PLINK_ESTAB,
	123	PLINK_HOLDING,
	124	PLINK_BLOCKED
ee385855	125	};
ee385855	126
5aae2880 RR	127	/**
	128	* struct sta_ampdu_mlme - STA aggregation information.
	129	*
cee24a3e	130	* @tid_state_rx: TID's state in Rx session state machine.
80656c20	131	* @tid_rx: aggregation info for Rx per TID
cee24a3e RR	132	* @tid_state_tx: TID's state in Tx session state machine.
	133	* @tid_tx: aggregation info for Tx per TID
	134	* @addba_req_num: number of times addBA request has been sent.
80656c20	135	* @dialog_token_allocator: dialog token enumerator for each new session;
5aae2880 RR	136	*/
5aae2880 RR	137	struct sta_ampdu_mlme {
cee24a3e RR	138	/* rx */
	139	u8 tid_state_rx[STA_TID_NUM];
	140	struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
cee24a3e RR	141	/* tx */
	142	u8 tid_state_tx[STA_TID_NUM];
	143	struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
	144	u8 addba_req_num[STA_TID_NUM];
80656c20	145	u8 dialog_token_allocator;
5aae2880	146	};
f0706e82	147
d0709a65 JB	148
	149	/* see __sta_info_unlink */
	150	#define STA_INFO_PIN_STAT_NORMAL 0
	151	#define STA_INFO_PIN_STAT_PINNED 1
	152	#define STA_INFO_PIN_STAT_DESTROY 2
	153
693b1bbc JB	154	/**
	155	* struct sta_info - STA information
	156	*
	157	* This structure collects information about a station that
	158	* mac80211 is communicating with.
	159	*
	160	* @list: global linked list entry
	161	* @hnext: hash table linked list pointer
	162	* @local: pointer to the global information
6ef307bc RD	163	* @sdata: TBD
	164	* @key: TBD
	165	* @rate_ctrl: TBD
	166	* @rate_ctrl_priv: TBD
	167	* @lock: used for locking all fields that require locking, see comments
	168	* in the header file.
	169	* @flaglock: spinlock for flags accesses
693b1bbc JB	170	* @addr: MAC address of this STA
	171	* @aid: STA's unique AID (1..2007, 0 = not assigned yet),
	172	* only used in AP (and IBSS?) mode
6ef307bc RD	173	* @listen_interval: TBD
6ef307bc RD	174	* @pin_status: TBD
693b1bbc JB	175	* @flags: STA flags, see &enum ieee80211_sta_info_flags
	176	* @ps_tx_buf: buffer of frames to transmit to this station
	177	* when it leaves power saving state
	178	* @tx_filtered: buffer of frames we already tried to transmit
	179	* but were filtered by hardware due to STA having entered
	180	* power saving state
	181	* @rx_packets: Number of MSDUs received from this STA
	182	* @rx_bytes: Number of bytes received from this STA
6ef307bc RD	183	* @wep_weak_iv_count: TBD
	184	* @last_rx: TBD
	185	* @num_duplicates: number of duplicate frames received from this STA
	186	* @rx_fragments: number of received MPDUs
	187	* @rx_dropped: number of dropped MPDUs from this STA
	188	* @last_signal: signal of last received frame from this STA
	189	* @last_qual: qual of last received frame from this STA
	190	* @last_noise: noise of last received frame from this STA
	191	* @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
6ef307bc RD	192	* @tx_filtered_count: TBD
	193	* @tx_retry_failed: TBD
	194	* @tx_retry_count: TBD
6ef307bc RD	195	* @fail_avg: moving percentage of failed MSDUs
	196	* @tx_packets: number of RX/TX MSDUs
	197	* @tx_bytes: TBD
	198	* @tx_fragments: number of transmitted MPDUs
9222963f	199	* @last_txrate_idx: Index of the last used transmit rate
701b9cb3	200	* @tid_seq: TBD
6ef307bc RD	201	* @ampdu_mlme: TBD
	202	* @timer_to_tid: identity mapping to ID timers
	203	* @tid_to_tx_q: map tid to tx queue
	204	* @llid: Local link ID
	205	* @plid: Peer link ID
	206	* @reason: Cancel reason on PLINK_HOLDING state
	207	* @plink_retries: Retries in establishment
	208	* @ignore_plink_timer: TBD
	209	* @plink_state plink_state: TBD
	210	* @plink_timeout: TBD
	211	* @plink_timer: TBD
	212	* @debugfs: debug filesystem info
17741cdc	213	* @sta: station information we share with the driver
693b1bbc	214	*/
f0706e82	215	struct sta_info {
693b1bbc	216	/* General information, mostly static */
f0706e82	217	struct list_head list;
693b1bbc	218	struct sta_info *hnext;
f0706e82	219	struct ieee80211_local *local;
d0709a65	220	struct ieee80211_sub_if_data *sdata;
f0706e82	221	struct ieee80211_key *key;
f0706e82 JB	222	struct rate_control_ref *rate_ctrl;
f0706e82 JB	223	void *rate_ctrl_priv;
07346f81	224	spinlock_t lock;
5a9f7b04	225	spinlock_t flaglock;
17741cdc	226
693b1bbc	227	u16 listen_interval;
f0706e82	228
693b1bbc JB	229	/*
	230	* for use by the internal lifetime management,
	231	* see __sta_info_unlink
	232	*/
	233	u8 pin_status;
	234
5a9f7b04 JB	235	/*
	236	* frequently updated, locked with own spinlock (flaglock),
	237	* use the accessors defined below
	238	*/
693b1bbc JB	239	u32 flags;
	240
	241	/*
	242	* STA powersave frame queues, no more than the internal
	243	* locking required.
	244	*/
	245	struct sk_buff_head ps_tx_buf;
	246	struct sk_buff_head tx_filtered;
	247
	248	/* Updated from RX path only, no locking requirements */
	249	unsigned long rx_packets, rx_bytes;
	250	unsigned long wep_weak_iv_count;
	251	unsigned long last_rx;
6ef307bc RD	252	unsigned long num_duplicates;
	253	unsigned long rx_fragments;
	254	unsigned long rx_dropped;
	255	int last_signal;
	256	int last_qual;
	257	int last_noise;
693b1bbc	258	__le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
693b1bbc JB	259
	260	/* Updated from TX status path only, no locking requirements */
	261	unsigned long tx_filtered_count;
	262	unsigned long tx_retry_failed, tx_retry_count;
693b1bbc JB	263	/* moving percentage of failed MSDUs */
	264	unsigned int fail_avg;
	265
	266	/* Updated from TX path only, no locking requirements */
6ef307bc	267	unsigned long tx_packets;
693b1bbc	268	unsigned long tx_bytes;
6ef307bc	269	unsigned long tx_fragments;
ae17e986	270	unsigned int last_txrate_idx;
f591fa5d	271	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
f0706e82	272
d0709a65	273	/*
07346f81	274	* Aggregation information, locked with lock.
d0709a65	275	*/
5aae2880	276	struct sta_ampdu_mlme ampdu_mlme;
6ef307bc RD	277	u8 timer_to_tid[STA_TID_NUM];
6ef307bc RD	278	u8 tid_to_tx_q[STA_TID_NUM];
693b1bbc	279
ee385855	280	#ifdef CONFIG_MAC80211_MESH
693b1bbc JB	281	/*
	282	* Mesh peer link attributes
	283	* TODO: move to a sub-structure that is referenced with pointer?
	284	*/
6ef307bc RD	285	__le16 llid;
	286	__le16 plid;
	287	__le16 reason;
	288	u8 plink_retries;
7495883b	289	bool ignore_plink_timer;
ee385855 LCC	290	enum plink_state plink_state;
	291	u32 plink_timeout;
	292	struct timer_list plink_timer;
ee385855	293	#endif
10816d40	294
e9f207f0 JB	295	#ifdef CONFIG_MAC80211_DEBUGFS
	296	struct sta_info_debugfsdentries {
	297	struct dentry *dir;
	298	struct dentry *flags;
	299	struct dentry *num_ps_buf_frames;
e9f207f0 JB	300	struct dentry *inactive_ms;
e9f207f0 JB	301	struct dentry *last_seq_ctrl;
eb2ba62e	302	struct dentry *agg_status;
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	}
	335
	336	static inline void set_and_clear_sta_flags(struct sta_info *sta,
	337	const u32 set, const u32 clear)
	338	{
5a9f7b04 JB	339	unsigned long irqfl;
	340
	341	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81 JB	342	sta->flags \|= set;
07346f81 JB	343	sta->flags &= ~clear;
5a9f7b04	344	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	345	}
	346
	347	static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
	348	{
	349	u32 ret;
5a9f7b04	350	unsigned long irqfl;
07346f81	351
5a9f7b04	352	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	353	ret = sta->flags & flags;
5a9f7b04	354	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	355
	356	return ret;
	357	}
	358
	359	static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
	360	const u32 flags)
	361	{
	362	u32 ret;
5a9f7b04	363	unsigned long irqfl;
07346f81	364
5a9f7b04	365	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81 JB	366	ret = sta->flags & flags;
07346f81 JB	367	sta->flags &= ~flags;
5a9f7b04	368	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	369
	370	return ret;
	371	}
	372
	373	static inline u32 get_sta_flags(struct sta_info *sta)
	374	{
	375	u32 ret;
5a9f7b04	376	unsigned long irqfl;
07346f81	377
5a9f7b04	378	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	379	ret = sta->flags;
5a9f7b04	380	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	381
	382	return ret;
	383	}
	384
f0706e82 JB	385
	386	/* Maximum number of concurrently registered stations */
	387	#define MAX_STA_COUNT 2007
	388
	389	#define STA_HASH_SIZE 256
	390	#define STA_HASH(sta) (sta[5])
	391
	392
	393	/* Maximum number of frames to buffer per power saving station */
	394	#define STA_MAX_TX_BUFFER 128
	395
	396	/* Minimum buffered frame expiry time. If STA uses listen interval that is
	397	* smaller than this value, the minimum value here is used instead. */
	398	#define STA_TX_BUFFER_EXPIRE (10 * HZ)
	399
	400	/* How often station data is cleaned up (e.g., expiration of buffered frames)
	401	*/
	402	#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
	403
d0709a65 JB	404	/*
	405	* Get a STA info, must have be under RCU read lock.
	406	*/
4b7679a5	407	struct sta_info sta_info_get(struct ieee80211_local local, const u8 *addr);
d0709a65 JB	408	/*
	409	* Get STA info by index, BROKEN!
	410	*/
ee385855 LCC	411	struct sta_info sta_info_get_by_idx(struct ieee80211_local local, int idx,
ee385855 LCC	412	struct net_device *dev);
d0709a65	413	/*
73651ee6 JB	414	* Create a new STA info, caller owns returned structure
73651ee6 JB	415	* until sta_info_insert().
d0709a65	416	*/
73651ee6 JB	417	struct sta_info sta_info_alloc(struct ieee80211_sub_if_data sdata,
	418	u8 *addr, gfp_t gfp);
	419	/*
	420	* Insert STA info into hash table/list, returns zero or a
	421	* -EEXIST if (if the same MAC address is already present).
	422	*
	423	* Calling this without RCU protection makes the caller
	424	* relinquish its reference to @sta.
	425	*/
	426	int sta_info_insert(struct sta_info *sta);
d0709a65 JB	427	/*
	428	* Unlink a STA info from the hash table/list.
	429	* This can NULL the STA pointer if somebody else
	430	* has already unlinked it.
	431	*/
	432	void sta_info_unlink(struct sta_info **sta);
f0706e82	433
d0709a65	434	void sta_info_destroy(struct sta_info *sta);
004c872e JB	435	void sta_info_set_tim_bit(struct sta_info *sta);
	436	void sta_info_clear_tim_bit(struct sta_info *sta);
	437
d0709a65 JB	438	void sta_info_init(struct ieee80211_local *local);
	439	int sta_info_start(struct ieee80211_local *local);
	440	void sta_info_stop(struct ieee80211_local *local);
44213b5e	441	int sta_info_flush(struct ieee80211_local *local,
d0709a65	442	struct ieee80211_sub_if_data *sdata);
dc6676b7	443	void sta_info_flush_delayed(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
f0706e82	447	#endif /* STA_INFO_H */