[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_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
 *	during suspend/resume and station removal.
 * @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.
 * @WLAN_STA_DISASSOC: Disassociation in progress.
 *	This is used to reject TX BA session requests when disassociation
 *	is in progress.
 */
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_BLOCK_BA	= 1<<11,
	WLAN_STA_PS_DRIVER	= 1<<12,
	WLAN_STA_PSPOLL		= 1<<13,
	WLAN_STA_DISASSOC       = 1<<14,
};

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

/**
 * 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_active_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 */
	bool tid_active_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;
};


/**
 * 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
 * @drv_unblock_wk: used for driver PS unblocking
 * @listen_interval: listen interval of this station, when we're acting as AP
 * @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_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
 * @uploaded: set to true when sta is uploaded to 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;

	struct work_struct drv_unblock_wk;

	u16 listen_interval;

	bool dead;

	bool uploaded;

	/*
	 * 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;
	__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 be under RCU read lock.
 */
struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
			      const u8 *addr);

struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
				  const u8 *addr);

static inline
void for_each_sta_info_type_check(struct ieee80211_local *local,
				  const u8 *addr,
				  struct sta_info *sta,
				  struct sta_info *nxt)
{
}

#define for_each_sta_info(local, _addr, sta, nxt) 			\
	for (	/* initialise loop */					\
		sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
		nxt = sta ? rcu_dereference(sta->hnext) : NULL;		\
		/* typecheck */						\
		for_each_sta_info_type_check(local, (_addr), sta, nxt),	\
		/* continue condition */				\
		sta;							\
		/* advance loop */					\
		sta = nxt,						\
		nxt = sta ? rcu_dereference(sta->hnext) : NULL		\
	     )								\
	/* compare address and run code only if it matches */		\
	if (memcmp(sta->sta.addr, (_addr), ETH_ALEN) == 0)

/*
 * Get STA info by index, BROKEN!
 */
struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
				     int idx);
/*
 * 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 the non-rcu version makes the caller relinquish,
 * the _rcu version calls read_lock_rcu() and must be called
 * without it held.
 */
int sta_info_insert(struct sta_info *sta);
int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
int sta_info_insert_atomic(struct sta_info *sta);

int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
			  const u8 *addr);
int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
			      const u8 *addr);

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