[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 <linux/kref.h>
#include "ieee80211_key.h"

/* Stations flags (struct sta_info::flags) */
#define WLAN_STA_AUTH BIT(0)
#define WLAN_STA_ASSOC BIT(1)
#define WLAN_STA_PS BIT(2)
#define WLAN_STA_TIM BIT(3) /* TIM bit is on for PS stations */
#define WLAN_STA_PERM BIT(4) /* permanent; do not remove entry on expiration */
#define WLAN_STA_AUTHORIZED BIT(5) /* If 802.1X is used, this flag is
				    * controlling whether STA is authorized to
				    * send and receive non-IEEE 802.1X frames
				    */
#define WLAN_STA_SHORT_PREAMBLE BIT(7)
/* whether this is an AP that we are associated with as a client */
#define WLAN_STA_ASSOC_AP BIT(8)
#define WLAN_STA_WME BIT(9)
#define WLAN_STA_WDS BIT(27)


struct sta_info {
	struct kref kref;
	struct list_head list;
	struct sta_info *hnext; /* next entry in hash table list */

	struct ieee80211_local *local;

	u8 addr[ETH_ALEN];
	u16 aid; /* STA's unique AID (1..2007), 0 = not yet assigned */
	u32 flags; /* WLAN_STA_ */

	struct sk_buff_head ps_tx_buf; /* buffer of TX frames for station in
					* power saving state */
	int pspoll; /* whether STA has send a PS Poll frame */
	struct sk_buff_head tx_filtered; /* buffer of TX frames that were
					  * already given to low-level driver,
					  * but were filtered */
	int clear_dst_mask;

	unsigned long rx_packets, tx_packets; /* number of RX/TX MSDUs */
	unsigned long rx_bytes, tx_bytes;
	unsigned long tx_retry_failed, tx_retry_count;
	unsigned long tx_filtered_count;

	unsigned int wep_weak_iv_count; /* number of RX frames with weak IV */

	unsigned long last_rx;
	u32 supp_rates; /* bitmap of supported rates in local->curr_rates */
	int txrate; /* index in local->curr_rates */
	int last_txrate; /* last rate used to send a frame to this STA */
	int last_nonerp_idx;

	struct net_device *dev; /* which net device is this station associated
				 * to */

	struct ieee80211_key *key;

	u32 tx_num_consecutive_failures;
	u32 tx_num_mpdu_ok;
	u32 tx_num_mpdu_fail;

	struct rate_control_ref *rate_ctrl;
	void *rate_ctrl_priv;

	/* last received seq/frag number from this STA (per RX queue) */
	__le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
	unsigned long num_duplicates; /* number of duplicate frames received
				       * from this STA */
	unsigned long tx_fragments; /* number of transmitted MPDUs */
	unsigned long rx_fragments; /* number of received MPDUs */
	unsigned long rx_dropped; /* number of dropped MPDUs from this STA */

	int last_rssi; /* RSSI of last received frame from this STA */
	int last_signal; /* signal of last received frame from this STA */
	int last_noise; /* noise of last received frame from this STA */
	int last_ack_rssi[3]; /* RSSI of last received ACKs from this STA */
	unsigned long last_ack;
	int channel_use;
	int channel_use_raw;

#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
	unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
	unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
#endif /* CONFIG_MAC80211_DEBUG_COUNTERS */

	u16 listen_interval;

	struct ieee80211_ht_info ht_info; /* 802.11n HT capabilities
					     of this STA */

#ifdef CONFIG_MAC80211_DEBUGFS
	struct sta_info_debugfsdentries {
		struct dentry *dir;
		struct dentry *flags;
		struct dentry *num_ps_buf_frames;
		struct dentry *last_ack_rssi;
		struct dentry *last_ack_ms;
		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
	} debugfs;
#endif
};


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

static inline void __sta_info_get(struct sta_info *sta)
{
	kref_get(&sta->kref);
}

struct sta_info * sta_info_get(struct ieee80211_local *local, u8 *addr);
int sta_info_min_txrate_get(struct ieee80211_local *local);
void sta_info_put(struct sta_info *sta);
struct sta_info * sta_info_add(struct ieee80211_local *local,
			       struct net_device *dev, u8 *addr, gfp_t gfp);
void sta_info_remove(struct sta_info *sta);
void sta_info_free(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);
void sta_info_remove_aid_ptr(struct sta_info *sta);
void sta_info_flush(struct ieee80211_local *local, struct net_device *dev);

#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>
	15	#include <linux/kref.h>
	16	#include "ieee80211_key.h"
	17
	18	/* Stations flags (struct sta_info::flags) */
	19	#define WLAN_STA_AUTH BIT(0)
	20	#define WLAN_STA_ASSOC BIT(1)
	21	#define WLAN_STA_PS BIT(2)
	22	#define WLAN_STA_TIM BIT(3) /* TIM bit is on for PS stations */
	23	#define WLAN_STA_PERM BIT(4) /* permanent; do not remove entry on expiration */
	24	#define WLAN_STA_AUTHORIZED BIT(5) /* If 802.1X is used, this flag is
	25	* controlling whether STA is authorized to
	26	* send and receive non-IEEE 802.1X frames
	27	*/
	28	#define WLAN_STA_SHORT_PREAMBLE BIT(7)
c9ee23df JB	29	/* whether this is an AP that we are associated with as a client */
c9ee23df JB	30	#define WLAN_STA_ASSOC_AP BIT(8)
f0706e82 JB	31	#define WLAN_STA_WME BIT(9)
	32	#define WLAN_STA_WDS BIT(27)
	33
	34
	35	struct sta_info {
	36	struct kref kref;
	37	struct list_head list;
	38	struct sta_info hnext; / next entry in hash table list */
	39
	40	struct ieee80211_local *local;
	41
	42	u8 addr[ETH_ALEN];
	43	u16 aid; /* STA's unique AID (1..2007), 0 = not yet assigned */
	44	u32 flags; /* WLAN_STA_ */
	45
	46	struct sk_buff_head ps_tx_buf; /* buffer of TX frames for station in
	47	* power saving state */
	48	int pspoll; /* whether STA has send a PS Poll frame */
	49	struct sk_buff_head tx_filtered; /* buffer of TX frames that were
	50	* already given to low-level driver,
	51	* but were filtered */
	52	int clear_dst_mask;
	53
	54	unsigned long rx_packets, tx_packets; /* number of RX/TX MSDUs */
	55	unsigned long rx_bytes, tx_bytes;
	56	unsigned long tx_retry_failed, tx_retry_count;
	57	unsigned long tx_filtered_count;
	58
	59	unsigned int wep_weak_iv_count; /* number of RX frames with weak IV */
	60
	61	unsigned long last_rx;
	62	u32 supp_rates; /* bitmap of supported rates in local->curr_rates */
	63	int txrate; /* index in local->curr_rates */
	64	int last_txrate; /* last rate used to send a frame to this STA */
	65	int last_nonerp_idx;
	66
	67	struct net_device dev; / which net device is this station associated
	68	* to */
	69
	70	struct ieee80211_key *key;
	71
	72	u32 tx_num_consecutive_failures;
	73	u32 tx_num_mpdu_ok;
	74	u32 tx_num_mpdu_fail;
	75
	76	struct rate_control_ref *rate_ctrl;
	77	void *rate_ctrl_priv;
	78
	79	/* last received seq/frag number from this STA (per RX queue) */
	80	__le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
	81	unsigned long num_duplicates; /* number of duplicate frames received
	82	* from this STA */
	83	unsigned long tx_fragments; /* number of transmitted MPDUs */
	84	unsigned long rx_fragments; /* number of received MPDUs */
	85	unsigned long rx_dropped; /* number of dropped MPDUs from this STA */
	86
	87	int last_rssi; /* RSSI of last received frame from this STA */
	88	int last_signal; /* signal of last received frame from this STA */
	89	int last_noise; /* noise of last received frame from this STA */
	90	int last_ack_rssi[3]; /* RSSI of last received ACKs from this STA */
	91	unsigned long last_ack;
	92	int channel_use;
	93	int channel_use_raw;
	94
f0706e82 JB	95	#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
	96	unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
	97	unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
	98	#endif /* CONFIG_MAC80211_DEBUG_COUNTERS */
	99
f0706e82	100	u16 listen_interval;
e9f207f0	101
10816d40 RR	102	struct ieee80211_ht_info ht_info; /* 802.11n HT capabilities
	103	of this STA */
	104
e9f207f0 JB	105	#ifdef CONFIG_MAC80211_DEBUGFS
	106	struct sta_info_debugfsdentries {
	107	struct dentry *dir;
	108	struct dentry *flags;
	109	struct dentry *num_ps_buf_frames;
	110	struct dentry *last_ack_rssi;
	111	struct dentry *last_ack_ms;
	112	struct dentry *inactive_ms;
	113	struct dentry *last_seq_ctrl;
	114	#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
	115	struct dentry *wme_rx_queue;
	116	struct dentry *wme_tx_queue;
	117	#endif
	118	} debugfs;
	119	#endif
f0706e82 JB	120	};
	121
	122
	123	/* Maximum number of concurrently registered stations */
	124	#define MAX_STA_COUNT 2007
	125
	126	#define STA_HASH_SIZE 256
	127	#define STA_HASH(sta) (sta[5])
	128
	129
	130	/* Maximum number of frames to buffer per power saving station */
	131	#define STA_MAX_TX_BUFFER 128
	132
	133	/* Minimum buffered frame expiry time. If STA uses listen interval that is
	134	* smaller than this value, the minimum value here is used instead. */
	135	#define STA_TX_BUFFER_EXPIRE (10 * HZ)
	136
	137	/* How often station data is cleaned up (e.g., expiration of buffered frames)
	138	*/
	139	#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
	140
be8755e1 MW	141	static inline void __sta_info_get(struct sta_info *sta)
	142	{
	143	kref_get(&sta->kref);
	144	}
	145
f0706e82 JB	146	struct sta_info * sta_info_get(struct ieee80211_local local, u8 addr);
	147	int sta_info_min_txrate_get(struct ieee80211_local *local);
	148	void sta_info_put(struct sta_info *sta);
	149	struct sta_info * sta_info_add(struct ieee80211_local *local,
	150	struct net_device dev, u8 addr, gfp_t gfp);
be8755e1 MW	151	void sta_info_remove(struct sta_info *sta);
be8755e1 MW	152	void sta_info_free(struct sta_info *sta);
f0706e82 JB	153	void sta_info_init(struct ieee80211_local *local);
	154	int sta_info_start(struct ieee80211_local *local);
	155	void sta_info_stop(struct ieee80211_local *local);
	156	void sta_info_remove_aid_ptr(struct sta_info *sta);
	157	void sta_info_flush(struct ieee80211_local local, struct net_device dev);
	158
	159	#endif /* STA_INFO_H */