[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
 * @addr: MAC address of this STA
 * @aid: STA's unique AID (1..2007, 0 = not assigned yet),
 *	only used in AP (and IBSS?) mode
 * @flags: STA flags, see &enum ieee80211_sta_info_flags
 * @flaglock: spinlock for flags accesses
 * @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
 * @supp_rates: Bitmap of supported rates (per band)
 * @ht_info: HT capabilities of this STA
 * @lock: used for locking all fields that require locking, see comments
 *	in the header file.
 */
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 ieee80211_ht_info ht_info;
	u64 supp_rates[IEEE80211_NUM_BANDS];
	u8 addr[ETH_ALEN];
	u16 aid;
	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; /* number of duplicate frames received
				       * from this STA */
	unsigned long rx_fragments; /* number of received MPDUs */
	unsigned long rx_dropped; /* number of dropped MPDUs from this STA */
	int last_signal; /* signal of last received frame from this STA */
	int last_qual;  /* qual of last received frame from this STA */
	int last_noise; /* noise of last received frame from this STA */
	/* last received seq/frag number from this STA (per RX queue) */
	__le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
	unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
#endif

	/* Updated from TX status path only, no locking requirements */
	unsigned long tx_filtered_count;
	unsigned long tx_retry_failed, tx_retry_count;
	/* TODO: update in generic code not rate control? */
	u32 tx_num_consecutive_failures;
	u32 tx_num_mpdu_ok;
	u32 tx_num_mpdu_fail;
	/* moving percentage of failed MSDUs */
	unsigned int fail_avg;

	/* Updated from TX path only, no locking requirements */
	unsigned long tx_packets; /* number of RX/TX MSDUs */
	unsigned long tx_bytes;
	unsigned long tx_fragments; /* number of transmitted MPDUs */
	int txrate_idx;
	int last_txrate_idx;
#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
	unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
#endif

	/*
	 * Aggregation information, locked with lock.
	 */
	struct sta_ampdu_mlme ampdu_mlme;
	u8 timer_to_tid[STA_TID_NUM];	/* identity mapping to ID timers */
	u8 tid_to_tx_q[STA_TID_NUM];	/* map tid to tx queue */

#ifdef CONFIG_MAC80211_MESH
	/*
	 * Mesh peer link attributes
	 * TODO: move to a sub-structure that is referenced with pointer?
	 */
	__le16 llid;		/* Local link ID */
	__le16 plid;		/* Peer link ID */
	__le16 reason;		/* Cancel reason on PLINK_HOLDING state */
	u8 plink_retries;	/* Retries in establishment */
	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;
#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
		struct dentry *wme_rx_queue;
		struct dentry *wme_tx_queue;
#endif
		struct dentry *agg_status;
	} debugfs;
#endif
};

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, 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_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);

#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
	163	* @addr: MAC address of this STA
	164	* @aid: STA's unique AID (1..2007, 0 = not assigned yet),
	165	* only used in AP (and IBSS?) mode
	166	* @flags: STA flags, see &enum ieee80211_sta_info_flags
5a9f7b04	167	* @flaglock: spinlock for flags accesses
693b1bbc JB	168	* @ps_tx_buf: buffer of frames to transmit to this station
	169	* when it leaves power saving state
	170	* @tx_filtered: buffer of frames we already tried to transmit
	171	* but were filtered by hardware due to STA having entered
	172	* power saving state
	173	* @rx_packets: Number of MSDUs received from this STA
	174	* @rx_bytes: Number of bytes received from this STA
	175	* @supp_rates: Bitmap of supported rates (per band)
	176	* @ht_info: HT capabilities of this STA
07346f81 JB	177	* @lock: used for locking all fields that require locking, see comments
07346f81 JB	178	* in the header file.
693b1bbc	179	*/
f0706e82	180	struct sta_info {
693b1bbc	181	/* General information, mostly static */
f0706e82	182	struct list_head list;
693b1bbc	183	struct sta_info *hnext;
f0706e82	184	struct ieee80211_local *local;
d0709a65	185	struct ieee80211_sub_if_data *sdata;
f0706e82	186	struct ieee80211_key *key;
f0706e82 JB	187	struct rate_control_ref *rate_ctrl;
f0706e82 JB	188	void *rate_ctrl_priv;
07346f81	189	spinlock_t lock;
5a9f7b04	190	spinlock_t flaglock;
693b1bbc JB	191	struct ieee80211_ht_info ht_info;
	192	u64 supp_rates[IEEE80211_NUM_BANDS];
	193	u8 addr[ETH_ALEN];
	194	u16 aid;
	195	u16 listen_interval;
f0706e82	196
693b1bbc JB	197	/*
	198	* for use by the internal lifetime management,
	199	* see __sta_info_unlink
	200	*/
	201	u8 pin_status;
	202
5a9f7b04 JB	203	/*
	204	* frequently updated, locked with own spinlock (flaglock),
	205	* use the accessors defined below
	206	*/
693b1bbc JB	207	u32 flags;
	208
	209	/*
	210	* STA powersave frame queues, no more than the internal
	211	* locking required.
	212	*/
	213	struct sk_buff_head ps_tx_buf;
	214	struct sk_buff_head tx_filtered;
	215
	216	/* Updated from RX path only, no locking requirements */
	217	unsigned long rx_packets, rx_bytes;
	218	unsigned long wep_weak_iv_count;
	219	unsigned long last_rx;
f0706e82 JB	220	unsigned long num_duplicates; /* number of duplicate frames received
f0706e82 JB	221	* from this STA */
f0706e82 JB	222	unsigned long rx_fragments; /* number of received MPDUs */
f0706e82 JB	223	unsigned long rx_dropped; /* number of dropped MPDUs from this STA */
f0706e82	224	int last_signal; /* signal of last received frame from this STA */
566bfe5a	225	int last_qual; /* qual of last received frame from this STA */
f0706e82	226	int last_noise; /* noise of last received frame from this STA */
693b1bbc JB	227	/* last received seq/frag number from this STA (per RX queue) */
693b1bbc JB	228	__le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
f0706e82 JB	229	#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
f0706e82 JB	230	unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
693b1bbc JB	231	#endif
	232
	233	/* Updated from TX status path only, no locking requirements */
	234	unsigned long tx_filtered_count;
	235	unsigned long tx_retry_failed, tx_retry_count;
	236	/* TODO: update in generic code not rate control? */
	237	u32 tx_num_consecutive_failures;
	238	u32 tx_num_mpdu_ok;
	239	u32 tx_num_mpdu_fail;
	240	/* moving percentage of failed MSDUs */
	241	unsigned int fail_avg;
	242
	243	/* Updated from TX path only, no locking requirements */
	244	unsigned long tx_packets; /* number of RX/TX MSDUs */
	245	unsigned long tx_bytes;
	246	unsigned long tx_fragments; /* number of transmitted MPDUs */
	247	int txrate_idx;
	248	int last_txrate_idx;
	249	#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
f0706e82	250	unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
693b1bbc	251	#endif
f0706e82	252
d0709a65	253	/*
07346f81	254	* Aggregation information, locked with lock.
d0709a65	255	*/
5aae2880	256	struct sta_ampdu_mlme ampdu_mlme;
693b1bbc	257	u8 timer_to_tid[STA_TID_NUM]; /* identity mapping to ID timers */
80656c20	258	u8 tid_to_tx_q[STA_TID_NUM]; /* map tid to tx queue */
693b1bbc	259
ee385855	260	#ifdef CONFIG_MAC80211_MESH
693b1bbc JB	261	/*
	262	* Mesh peer link attributes
	263	* TODO: move to a sub-structure that is referenced with pointer?
	264	*/
ee385855 LCC	265	__le16 llid; /* Local link ID */
ee385855 LCC	266	__le16 plid; /* Peer link ID */
b4e08ea1	267	__le16 reason; /* Cancel reason on PLINK_HOLDING state */
7495883b JB	268	u8 plink_retries; /* Retries in establishment */
7495883b JB	269	bool ignore_plink_timer;
ee385855 LCC	270	enum plink_state plink_state;
	271	u32 plink_timeout;
	272	struct timer_list plink_timer;
ee385855	273	#endif
10816d40	274
e9f207f0 JB	275	#ifdef CONFIG_MAC80211_DEBUGFS
	276	struct sta_info_debugfsdentries {
	277	struct dentry *dir;
	278	struct dentry *flags;
	279	struct dentry *num_ps_buf_frames;
e9f207f0 JB	280	struct dentry *inactive_ms;
	281	struct dentry *last_seq_ctrl;
	282	#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
	283	struct dentry *wme_rx_queue;
	284	struct dentry *wme_tx_queue;
	285	#endif
eb2ba62e	286	struct dentry *agg_status;
e9f207f0 JB	287	} debugfs;
e9f207f0 JB	288	#endif
f0706e82 JB	289	};
f0706e82 JB	290
d6d1a5a7 JB	291	static inline enum plink_state sta_plink_state(struct sta_info *sta)
	292	{
	293	#ifdef CONFIG_MAC80211_MESH
	294	return sta->plink_state;
	295	#endif
b4e08ea1	296	return PLINK_LISTEN;
d6d1a5a7 JB	297	}
d6d1a5a7 JB	298
07346f81 JB	299	static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
07346f81 JB	300	{
5a9f7b04 JB	301	unsigned long irqfl;
	302
	303	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	304	sta->flags \|= flags;
5a9f7b04	305	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	306	}
	307
	308	static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
	309	{
5a9f7b04 JB	310	unsigned long irqfl;
	311
	312	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	313	sta->flags &= ~flags;
5a9f7b04	314	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	315	}
	316
	317	static inline void set_and_clear_sta_flags(struct sta_info *sta,
	318	const u32 set, const u32 clear)
	319	{
5a9f7b04 JB	320	unsigned long irqfl;
	321
	322	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81 JB	323	sta->flags \|= set;
07346f81 JB	324	sta->flags &= ~clear;
5a9f7b04	325	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	326	}
	327
	328	static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
	329	{
	330	u32 ret;
5a9f7b04	331	unsigned long irqfl;
07346f81	332
5a9f7b04	333	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	334	ret = sta->flags & flags;
5a9f7b04	335	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	336
	337	return ret;
	338	}
	339
	340	static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
	341	const u32 flags)
	342	{
	343	u32 ret;
5a9f7b04	344	unsigned long irqfl;
07346f81	345
5a9f7b04	346	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81 JB	347	ret = sta->flags & flags;
07346f81 JB	348	sta->flags &= ~flags;
5a9f7b04	349	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	350
	351	return ret;
	352	}
	353
	354	static inline u32 get_sta_flags(struct sta_info *sta)
	355	{
	356	u32 ret;
5a9f7b04	357	unsigned long irqfl;
07346f81	358
5a9f7b04	359	spin_lock_irqsave(&sta->flaglock, irqfl);
07346f81	360	ret = sta->flags;
5a9f7b04	361	spin_unlock_irqrestore(&sta->flaglock, irqfl);
07346f81 JB	362
	363	return ret;
	364	}
	365
f0706e82 JB	366
	367	/* Maximum number of concurrently registered stations */
	368	#define MAX_STA_COUNT 2007
	369
	370	#define STA_HASH_SIZE 256
	371	#define STA_HASH(sta) (sta[5])
	372
	373
	374	/* Maximum number of frames to buffer per power saving station */
	375	#define STA_MAX_TX_BUFFER 128
	376
	377	/* Minimum buffered frame expiry time. If STA uses listen interval that is
	378	* smaller than this value, the minimum value here is used instead. */
	379	#define STA_TX_BUFFER_EXPIRE (10 * HZ)
	380
	381	/* How often station data is cleaned up (e.g., expiration of buffered frames)
	382	*/
	383	#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
	384
d0709a65 JB	385	/*
	386	* Get a STA info, must have be under RCU read lock.
	387	*/
	388	struct sta_info sta_info_get(struct ieee80211_local local, u8 *addr);
	389	/*
	390	* Get STA info by index, BROKEN!
	391	*/
ee385855 LCC	392	struct sta_info sta_info_get_by_idx(struct ieee80211_local local, int idx,
ee385855 LCC	393	struct net_device *dev);
d0709a65	394	/*
73651ee6 JB	395	* Create a new STA info, caller owns returned structure
73651ee6 JB	396	* until sta_info_insert().
d0709a65	397	*/
73651ee6 JB	398	struct sta_info sta_info_alloc(struct ieee80211_sub_if_data sdata,
	399	u8 *addr, gfp_t gfp);
	400	/*
	401	* Insert STA info into hash table/list, returns zero or a
	402	* -EEXIST if (if the same MAC address is already present).
	403	*
	404	* Calling this without RCU protection makes the caller
	405	* relinquish its reference to @sta.
	406	*/
	407	int sta_info_insert(struct sta_info *sta);
d0709a65 JB	408	/*
	409	* Unlink a STA info from the hash table/list.
	410	* This can NULL the STA pointer if somebody else
	411	* has already unlinked it.
	412	*/
	413	void sta_info_unlink(struct sta_info **sta);
cb585bcc	414	void __sta_info_unlink(struct sta_info **sta);
f0706e82	415
d0709a65	416	void sta_info_destroy(struct sta_info *sta);
004c872e JB	417	void sta_info_set_tim_bit(struct sta_info *sta);
	418	void sta_info_clear_tim_bit(struct sta_info *sta);
	419
d0709a65 JB	420	void sta_info_init(struct ieee80211_local *local);
	421	int sta_info_start(struct ieee80211_local *local);
	422	void sta_info_stop(struct ieee80211_local *local);
44213b5e	423	int sta_info_flush(struct ieee80211_local *local,
d0709a65	424	struct ieee80211_sub_if_data *sdata);
dc6676b7	425	void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata);
d0709a65	426
f0706e82	427	#endif /* STA_INFO_H */