[linux-2.6-block.git] / drivers / net / wireless / rtlwifi / base.h

/******************************************************************************
 *
 * Copyright(c) 2009-2012  Realtek Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * The full GNU General Public License is included in this distribution in the
 * file called LICENSE.
 *
 * Contact Information:
 * wlanfae <wlanfae@realtek.com>
 * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
 * Hsinchu 300, Taiwan.
 *
 * Larry Finger <Larry.Finger@lwfinger.net>
 *
 *****************************************************************************/

#ifndef __RTL_BASE_H__
#define __RTL_BASE_H__

enum ap_peer {
	PEER_UNKNOWN = 0,
	PEER_RTL = 1,
	PEER_RTL_92SE = 2,
	PEER_BROAD = 3,
	PEER_RAL = 4,
	PEER_ATH = 5,
	PEER_CISCO = 6,
	PEER_MARV = 7,
	PEER_AIRGO = 9,
	PEER_MAX = 10,
};

#define RTL_DUMMY_OFFSET	0
#define RTL_DUMMY_UNIT		8
#define RTL_TX_DUMMY_SIZE	(RTL_DUMMY_OFFSET * RTL_DUMMY_UNIT)
#define RTL_TX_DESC_SIZE	32
#define RTL_TX_HEADER_SIZE	(RTL_TX_DESC_SIZE + RTL_TX_DUMMY_SIZE)

#define HT_AMSDU_SIZE_4K	3839
#define HT_AMSDU_SIZE_8K	7935

#define MAX_BIT_RATE_40MHZ_MCS15	300	/* Mbps */
#define MAX_BIT_RATE_40MHZ_MCS7		150	/* Mbps */

#define MAX_BIT_RATE_SHORT_GI_2NSS_80MHZ_MCS9	867	/* Mbps */
#define MAX_BIT_RATE_SHORT_GI_2NSS_80MHZ_MCS7	650	/* Mbps */
#define MAX_BIT_RATE_LONG_GI_2NSS_80MHZ_MCS9	780	/* Mbps */
#define MAX_BIT_RATE_LONG_GI_2NSS_80MHZ_MCS7	585	/* Mbps */

#define MAX_BIT_RATE_SHORT_GI_1NSS_80MHZ_MCS9	434	/* Mbps */
#define MAX_BIT_RATE_SHORT_GI_1NSS_80MHZ_MCS7	325	/* Mbps */
#define MAX_BIT_RATE_LONG_GI_1NSS_80MHZ_MCS9	390	/* Mbps */
#define MAX_BIT_RATE_LONG_GI_1NSS_80MHZ_MCS7	293	/* Mbps */

#define RTL_RATE_COUNT_LEGACY		12
#define RTL_CHANNEL_COUNT		14

#define FRAME_OFFSET_FRAME_CONTROL	0
#define FRAME_OFFSET_DURATION		2
#define FRAME_OFFSET_ADDRESS1		4
#define FRAME_OFFSET_ADDRESS2		10
#define FRAME_OFFSET_ADDRESS3		16
#define FRAME_OFFSET_SEQUENCE		22
#define FRAME_OFFSET_ADDRESS4		24

#define SET_80211_HDR_FRAME_CONTROL(_hdr, _val)		\
	WRITEEF2BYTE(_hdr, _val)
#define SET_80211_HDR_TYPE_AND_SUBTYPE(_hdr, _val)	\
	WRITEEF1BYTE(_hdr, _val)
#define SET_80211_HDR_PWR_MGNT(_hdr, _val)		\
	SET_BITS_TO_LE_2BYTE(_hdr, 12, 1, _val)
#define SET_80211_HDR_TO_DS(_hdr, _val)			\
	SET_BITS_TO_LE_2BYTE(_hdr, 8, 1, _val)

#define SET_80211_PS_POLL_AID(_hdr, _val)		\
	(*(u16 *)((u8 *)(_hdr) + 2) = _val)
#define SET_80211_PS_POLL_BSSID(_hdr, _val)		\
	ether_addr_copy(((u8 *)(_hdr)) + 4, (u8 *)(_val))
#define SET_80211_PS_POLL_TA(_hdr, _val)		\
	ether_addr_copy(((u8 *)(_hdr))+10, (u8 *)(_val))

#define SET_80211_HDR_DURATION(_hdr, _val)	\
	(*(u16 *)((u8 *)(_hdr) + FRAME_OFFSET_DURATION) = le16_to_cpu(_val))
#define SET_80211_HDR_ADDRESS1(_hdr, _val)	\
	CP_MACADDR((u8 *)(_hdr)+FRAME_OFFSET_ADDRESS1, (u8 *)(_val))
#define SET_80211_HDR_ADDRESS2(_hdr, _val)	\
	CP_MACADDR((u8 *)(_hdr)+FRAME_OFFSET_ADDRESS2, (u8 *)(_val))
#define SET_80211_HDR_ADDRESS3(_hdr, _val)	\
	CP_MACADDR((u8 *)(_hdr)+FRAME_OFFSET_ADDRESS3, (u8 *)(_val))
#define SET_80211_HDR_FRAGMENT_SEQUENCE(_hdr, _val)  \
	WRITEEF2BYTE((u8 *)(_hdr)+FRAME_OFFSET_SEQUENCE, _val)

#define SET_BEACON_PROBE_RSP_TIME_STAMP_LOW(__phdr, __val)	\
	WRITEEF4BYTE(((u8 *)(__phdr)) + 24, __val)
#define SET_BEACON_PROBE_RSP_TIME_STAMP_HIGH(__phdr, __val) \
	WRITEEF4BYTE(((u8 *)(__phdr)) + 28, __val)
#define SET_BEACON_PROBE_RSP_BEACON_INTERVAL(__phdr, __val) \
	WRITEEF2BYTE(((u8 *)(__phdr)) + 32, __val)
#define GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr)		\
	READEF2BYTE(((u8 *)(__phdr)) + 34)
#define SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
	WRITEEF2BYTE(((u8 *)(__phdr)) + 34, __val)
#define MASK_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
	SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, \
	(GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr) & (~(__val))))

int rtl_init_core(struct ieee80211_hw *hw);
void rtl_deinit_core(struct ieee80211_hw *hw);
void rtl_init_rx_config(struct ieee80211_hw *hw);
void rtl_init_rfkill(struct ieee80211_hw *hw);
void rtl_deinit_rfkill(struct ieee80211_hw *hw);

void rtl_watch_dog_timer_callback(unsigned long data);
void rtl_deinit_deferred_work(struct ieee80211_hw *hw);

bool rtl_action_proc(struct ieee80211_hw *hw, struct sk_buff *skb, u8 is_tx);
int rtlwifi_rate_mapping(struct ieee80211_hw *hw,
			 bool isht, u8 desc_rate);
bool rtl_tx_mgmt_proc(struct ieee80211_hw *hw, struct sk_buff *skb);
u8 rtl_is_special_data(struct ieee80211_hw *hw, struct sk_buff *skb, u8 is_tx);

void rtl_beacon_statistic(struct ieee80211_hw *hw, struct sk_buff *skb);
void rtl_watch_dog_timer_callback(unsigned long data);
int rtl_tx_agg_start(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
	struct ieee80211_sta *sta, u16 tid, u16 *ssn);
int rtl_tx_agg_stop(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
	struct ieee80211_sta *sta, u16 tid);
int rtl_tx_agg_oper(struct ieee80211_hw *hw,
		    struct ieee80211_sta *sta, u16 tid);
int rtl_rx_agg_start(struct ieee80211_hw *hw,
		     struct ieee80211_sta *sta, u16 tid);
int rtl_rx_agg_stop(struct ieee80211_hw *hw,
		    struct ieee80211_sta *sta, u16 tid);
void rtl_watchdog_wq_callback(void *data);
void rtl_fwevt_wq_callback(void *data);

void rtl_get_tcb_desc(struct ieee80211_hw *hw,
		      struct ieee80211_tx_info *info,
		      struct ieee80211_sta *sta,
		      struct sk_buff *skb, struct rtl_tcb_desc *tcb_desc);

int rtl_send_smps_action(struct ieee80211_hw *hw,
		struct ieee80211_sta *sta,
		enum ieee80211_smps_mode smps);
u8 *rtl_find_ie(u8 *data, unsigned int len, u8 ie);
void rtl_recognize_peer(struct ieee80211_hw *hw, u8 *data, unsigned int len);
u8 rtl_tid_to_ac(u8 tid);
extern struct attribute_group rtl_attribute_group;
void rtl_easy_concurrent_retrytimer_callback(unsigned long data);
extern struct rtl_global_var rtl_global_var;
void rtl_phy_scan_operation_backup(struct ieee80211_hw *hw, u8 operation);

#endif
Commit	Line	Data
0c817338 LF	1	/******************************************************************************
0c817338 LF	2	*
a8d76066	3	* Copyright(c) 2009-2012 Realtek Corporation.
0c817338 LF	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of version 2 of the GNU General Public License as
	7	* published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*
0c817338 LF	14	* The full GNU General Public License is included in this distribution in the
	15	* file called LICENSE.
	16	*
	17	* Contact Information:
	18	* wlanfae <wlanfae@realtek.com>
	19	* Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
	20	* Hsinchu 300, Taiwan.
	21	*
	22	* Larry Finger <Larry.Finger@lwfinger.net>
acd48572	23	*
0c817338 LF	24	*****************************************************************************/
	25
	26	#ifndef __RTL_BASE_H__
	27	#define __RTL_BASE_H__
	28
acd48572 C	29	enum ap_peer {
	30	PEER_UNKNOWN = 0,
	31	PEER_RTL = 1,
	32	PEER_RTL_92SE = 2,
	33	PEER_BROAD = 3,
	34	PEER_RAL = 4,
	35	PEER_ATH = 5,
	36	PEER_CISCO = 6,
	37	PEER_MARV = 7,
	38	PEER_AIRGO = 9,
	39	PEER_MAX = 10,
9afa2e44	40	};
acd48572	41
0c817338 LF	42	#define RTL_DUMMY_OFFSET 0
	43	#define RTL_DUMMY_UNIT 8
	44	#define RTL_TX_DUMMY_SIZE (RTL_DUMMY_OFFSET * RTL_DUMMY_UNIT)
	45	#define RTL_TX_DESC_SIZE 32
	46	#define RTL_TX_HEADER_SIZE (RTL_TX_DESC_SIZE + RTL_TX_DUMMY_SIZE)
	47
	48	#define HT_AMSDU_SIZE_4K 3839
	49	#define HT_AMSDU_SIZE_8K 7935
	50
	51	#define MAX_BIT_RATE_40MHZ_MCS15 300 /* Mbps */
	52	#define MAX_BIT_RATE_40MHZ_MCS7 150 /* Mbps */
	53
9afa2e44 LF	54	#define MAX_BIT_RATE_SHORT_GI_2NSS_80MHZ_MCS9 867 /* Mbps */
	55	#define MAX_BIT_RATE_SHORT_GI_2NSS_80MHZ_MCS7 650 /* Mbps */
	56	#define MAX_BIT_RATE_LONG_GI_2NSS_80MHZ_MCS9 780 /* Mbps */
	57	#define MAX_BIT_RATE_LONG_GI_2NSS_80MHZ_MCS7 585 /* Mbps */
	58
	59	#define MAX_BIT_RATE_SHORT_GI_1NSS_80MHZ_MCS9 434 /* Mbps */
	60	#define MAX_BIT_RATE_SHORT_GI_1NSS_80MHZ_MCS7 325 /* Mbps */
	61	#define MAX_BIT_RATE_LONG_GI_1NSS_80MHZ_MCS9 390 /* Mbps */
	62	#define MAX_BIT_RATE_LONG_GI_1NSS_80MHZ_MCS7 293 /* Mbps */
	63
0c817338 LF	64	#define RTL_RATE_COUNT_LEGACY 12
	65	#define RTL_CHANNEL_COUNT 14
	66
	67	#define FRAME_OFFSET_FRAME_CONTROL 0
	68	#define FRAME_OFFSET_DURATION 2
	69	#define FRAME_OFFSET_ADDRESS1 4
	70	#define FRAME_OFFSET_ADDRESS2 10
	71	#define FRAME_OFFSET_ADDRESS3 16
	72	#define FRAME_OFFSET_SEQUENCE 22
	73	#define FRAME_OFFSET_ADDRESS4 24
	74
acd48572 C	75	#define SET_80211_HDR_FRAME_CONTROL(_hdr, _val) \
	76	WRITEEF2BYTE(_hdr, _val)
	77	#define SET_80211_HDR_TYPE_AND_SUBTYPE(_hdr, _val) \
	78	WRITEEF1BYTE(_hdr, _val)
	79	#define SET_80211_HDR_PWR_MGNT(_hdr, _val) \
	80	SET_BITS_TO_LE_2BYTE(_hdr, 12, 1, _val)
	81	#define SET_80211_HDR_TO_DS(_hdr, _val) \
	82	SET_BITS_TO_LE_2BYTE(_hdr, 8, 1, _val)
0c817338 LF	83
0c817338 LF	84	#define SET_80211_PS_POLL_AID(_hdr, _val) \
abfabc9b	85	((u16 )((u8 *)(_hdr) + 2) = _val)
0c817338	86	#define SET_80211_PS_POLL_BSSID(_hdr, _val) \
9afa2e44	87	ether_addr_copy(((u8 )(_hdr)) + 4, (u8 )(_val))
0c817338	88	#define SET_80211_PS_POLL_TA(_hdr, _val) \
9afa2e44	89	ether_addr_copy(((u8 )(_hdr))+10, (u8 )(_val))
0c817338 LF	90
0c817338 LF	91	#define SET_80211_HDR_DURATION(_hdr, _val) \
9e0bc671	92	((u16 )((u8 *)(_hdr) + FRAME_OFFSET_DURATION) = le16_to_cpu(_val))
0c817338	93	#define SET_80211_HDR_ADDRESS1(_hdr, _val) \
acd48572	94	CP_MACADDR((u8 )(_hdr)+FRAME_OFFSET_ADDRESS1, (u8 )(_val))
0c817338	95	#define SET_80211_HDR_ADDRESS2(_hdr, _val) \
acd48572	96	CP_MACADDR((u8 )(_hdr)+FRAME_OFFSET_ADDRESS2, (u8 )(_val))
0c817338	97	#define SET_80211_HDR_ADDRESS3(_hdr, _val) \
acd48572 C	98	CP_MACADDR((u8 )(_hdr)+FRAME_OFFSET_ADDRESS3, (u8 )(_val))
	99	#define SET_80211_HDR_FRAGMENT_SEQUENCE(_hdr, _val) \
	100	WRITEEF2BYTE((u8 *)(_hdr)+FRAME_OFFSET_SEQUENCE, _val)
	101
	102	#define SET_BEACON_PROBE_RSP_TIME_STAMP_LOW(__phdr, __val) \
	103	WRITEEF4BYTE(((u8 *)(__phdr)) + 24, __val)
	104	#define SET_BEACON_PROBE_RSP_TIME_STAMP_HIGH(__phdr, __val) \
	105	WRITEEF4BYTE(((u8 *)(__phdr)) + 28, __val)
	106	#define SET_BEACON_PROBE_RSP_BEACON_INTERVAL(__phdr, __val) \
	107	WRITEEF2BYTE(((u8 *)(__phdr)) + 32, __val)
	108	#define GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr) \
	109	READEF2BYTE(((u8 *)(__phdr)) + 34)
	110	#define SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
	111	WRITEEF2BYTE(((u8 *)(__phdr)) + 34, __val)
	112	#define MASK_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
	113	SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, \
	114	(GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr) & (~(__val))))
0c817338 LF	115
	116	int rtl_init_core(struct ieee80211_hw *hw);
	117	void rtl_deinit_core(struct ieee80211_hw *hw);
	118	void rtl_init_rx_config(struct ieee80211_hw *hw);
	119	void rtl_init_rfkill(struct ieee80211_hw *hw);
	120	void rtl_deinit_rfkill(struct ieee80211_hw *hw);
	121
9afa2e44	122	void rtl_watch_dog_timer_callback(unsigned long data);
0c817338 LF	123	void rtl_deinit_deferred_work(struct ieee80211_hw *hw);
	124
	125	bool rtl_action_proc(struct ieee80211_hw hw, struct sk_buff skb, u8 is_tx);
9afa2e44	126	int rtlwifi_rate_mapping(struct ieee80211_hw *hw,
f1f21770	127	bool isht, u8 desc_rate);
9afa2e44	128	bool rtl_tx_mgmt_proc(struct ieee80211_hw hw, struct sk_buff skb);
0c817338 LF	129	u8 rtl_is_special_data(struct ieee80211_hw hw, struct sk_buff skb, u8 is_tx);
0c817338 LF	130
9afa2e44	131	void rtl_beacon_statistic(struct ieee80211_hw hw, struct sk_buff skb);
0c817338	132	void rtl_watch_dog_timer_callback(unsigned long data);
f7953b2a	133	int rtl_tx_agg_start(struct ieee80211_hw hw, struct ieee80211_vif vif,
9afa2e44	134	struct ieee80211_sta sta, u16 tid, u16 ssn);
f7953b2a	135	int rtl_tx_agg_stop(struct ieee80211_hw hw, struct ieee80211_vif vif,
9afa2e44 LF	136	struct ieee80211_sta *sta, u16 tid);
	137	int rtl_tx_agg_oper(struct ieee80211_hw *hw,
	138	struct ieee80211_sta *sta, u16 tid);
	139	int rtl_rx_agg_start(struct ieee80211_hw *hw,
	140	struct ieee80211_sta *sta, u16 tid);
	141	int rtl_rx_agg_stop(struct ieee80211_hw *hw,
f7953b2a	142	struct ieee80211_sta *sta, u16 tid);
0c817338	143	void rtl_watchdog_wq_callback(void *data);
26634c4b	144	void rtl_fwevt_wq_callback(void *data);
0c817338 LF	145
	146	void rtl_get_tcb_desc(struct ieee80211_hw *hw,
	147	struct ieee80211_tx_info *info,
acd48572	148	struct ieee80211_sta *sta,
0c817338 LF	149	struct sk_buff skb, struct rtl_tcb_desc tcb_desc);
0c817338 LF	150
acd48572	151	int rtl_send_smps_action(struct ieee80211_hw *hw,
9afa2e44 LF	152	struct ieee80211_sta *sta,
9afa2e44 LF	153	enum ieee80211_smps_mode smps);
acd48572 C	154	u8 rtl_find_ie(u8 data, unsigned int len, u8 ie);
acd48572 C	155	void rtl_recognize_peer(struct ieee80211_hw hw, u8 data, unsigned int len);
2a00def4	156	u8 rtl_tid_to_ac(u8 tid);
0c817338	157	extern struct attribute_group rtl_attribute_group;
26634c4b	158	void rtl_easy_concurrent_retrytimer_callback(unsigned long data);
6f334c2b	159	extern struct rtl_global_var rtl_global_var;
4f4826da	160	void rtl_phy_scan_operation_backup(struct ieee80211_hw *hw, u8 operation);
0f015453	161
0c817338	162	#endif