[deliverable/linux.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.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * 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 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)		\
	memcpy(((u8 *)(_hdr)) + 4, (u8 *)(_val), ETH_ALEN)
#define SET_80211_PS_POLL_TA(_hdr, _val)		\
	memcpy(((u8 *)(_hdr)) + 10, (u8 *)(_val), ETH_ALEN)

#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_beacon_statistic(struct ieee80211_hw *hw, struct sk_buff *skb);
void rtl_deinit_deferred_work(struct ieee80211_hw *hw);

bool rtl_action_proc(struct ieee80211_hw *hw, struct sk_buff *skb, u8 is_tx);
u8 rtl_is_special_data(struct ieee80211_hw *hw, struct sk_buff *skb, u8 is_tx);

void rtl_watch_dog_timer_callback(unsigned long data);
int rtl_tx_agg_start(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
		     u16 tid, u16 *ssn);
int rtl_tx_agg_stop(struct ieee80211_hw *hw, 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;
int rtlwifi_rate_mapping(struct ieee80211_hw *hw,
			 bool isht, u8 desc_rate, bool first_ampdu);
bool rtl_tx_mgmt_proc(struct ieee80211_hw *hw, struct sk_buff *skb);
struct sk_buff *rtl_make_del_ba(struct ieee80211_hw *hw,
				u8 *sa, u8 *bssid, u16 tid);
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	*
	14	* You should have received a copy of the GNU General Public License along with
	15	* this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
	17	*
	18	* The full GNU General Public License is included in this distribution in the
	19	* file called LICENSE.
	20	*
	21	* Contact Information:
	22	* wlanfae <wlanfae@realtek.com>
	23	* Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
	24	* Hsinchu 300, Taiwan.
	25	*
	26	* Larry Finger <Larry.Finger@lwfinger.net>
acd48572	27	*
0c817338 LF	28	*****************************************************************************/
	29
	30	#ifndef __RTL_BASE_H__
	31	#define __RTL_BASE_H__
	32
acd48572 C	33	enum ap_peer {
	34	PEER_UNKNOWN = 0,
	35	PEER_RTL = 1,
	36	PEER_RTL_92SE = 2,
	37	PEER_BROAD = 3,
	38	PEER_RAL = 4,
	39	PEER_ATH = 5,
	40	PEER_CISCO = 6,
	41	PEER_MARV = 7,
	42	PEER_AIRGO = 9,
	43	PEER_MAX = 10,
	44	} ;
	45
0c817338 LF	46	#define RTL_DUMMY_OFFSET 0
	47	#define RTL_DUMMY_UNIT 8
	48	#define RTL_TX_DUMMY_SIZE (RTL_DUMMY_OFFSET * RTL_DUMMY_UNIT)
	49	#define RTL_TX_DESC_SIZE 32
	50	#define RTL_TX_HEADER_SIZE (RTL_TX_DESC_SIZE + RTL_TX_DUMMY_SIZE)
	51
	52	#define HT_AMSDU_SIZE_4K 3839
	53	#define HT_AMSDU_SIZE_8K 7935
	54
	55	#define MAX_BIT_RATE_40MHZ_MCS15 300 /* Mbps */
	56	#define MAX_BIT_RATE_40MHZ_MCS7 150 /* Mbps */
	57
	58	#define RTL_RATE_COUNT_LEGACY 12
	59	#define RTL_CHANNEL_COUNT 14
	60
	61	#define FRAME_OFFSET_FRAME_CONTROL 0
	62	#define FRAME_OFFSET_DURATION 2
	63	#define FRAME_OFFSET_ADDRESS1 4
	64	#define FRAME_OFFSET_ADDRESS2 10
	65	#define FRAME_OFFSET_ADDRESS3 16
	66	#define FRAME_OFFSET_SEQUENCE 22
	67	#define FRAME_OFFSET_ADDRESS4 24
	68
acd48572 C	69	#define SET_80211_HDR_FRAME_CONTROL(_hdr, _val) \
	70	WRITEEF2BYTE(_hdr, _val)
	71	#define SET_80211_HDR_TYPE_AND_SUBTYPE(_hdr, _val) \
	72	WRITEEF1BYTE(_hdr, _val)
	73	#define SET_80211_HDR_PWR_MGNT(_hdr, _val) \
	74	SET_BITS_TO_LE_2BYTE(_hdr, 12, 1, _val)
	75	#define SET_80211_HDR_TO_DS(_hdr, _val) \
	76	SET_BITS_TO_LE_2BYTE(_hdr, 8, 1, _val)
0c817338 LF	77
0c817338 LF	78	#define SET_80211_PS_POLL_AID(_hdr, _val) \
abfabc9b	79	((u16 )((u8 *)(_hdr) + 2) = _val)
0c817338	80	#define SET_80211_PS_POLL_BSSID(_hdr, _val) \
9e0bc671	81	memcpy(((u8 )(_hdr)) + 4, (u8 )(_val), ETH_ALEN)
0c817338	82	#define SET_80211_PS_POLL_TA(_hdr, _val) \
9e0bc671	83	memcpy(((u8 )(_hdr)) + 10, (u8 )(_val), ETH_ALEN)
0c817338 LF	84
0c817338 LF	85	#define SET_80211_HDR_DURATION(_hdr, _val) \
9e0bc671	86	((u16 )((u8 *)(_hdr) + FRAME_OFFSET_DURATION) = le16_to_cpu(_val))
0c817338	87	#define SET_80211_HDR_ADDRESS1(_hdr, _val) \
acd48572	88	CP_MACADDR((u8 )(_hdr)+FRAME_OFFSET_ADDRESS1, (u8 )(_val))
0c817338	89	#define SET_80211_HDR_ADDRESS2(_hdr, _val) \
acd48572	90	CP_MACADDR((u8 )(_hdr)+FRAME_OFFSET_ADDRESS2, (u8 )(_val))
0c817338	91	#define SET_80211_HDR_ADDRESS3(_hdr, _val) \
acd48572 C	92	CP_MACADDR((u8 )(_hdr)+FRAME_OFFSET_ADDRESS3, (u8 )(_val))
	93	#define SET_80211_HDR_FRAGMENT_SEQUENCE(_hdr, _val) \
	94	WRITEEF2BYTE((u8 *)(_hdr)+FRAME_OFFSET_SEQUENCE, _val)
	95
	96	#define SET_BEACON_PROBE_RSP_TIME_STAMP_LOW(__phdr, __val) \
	97	WRITEEF4BYTE(((u8 *)(__phdr)) + 24, __val)
	98	#define SET_BEACON_PROBE_RSP_TIME_STAMP_HIGH(__phdr, __val) \
	99	WRITEEF4BYTE(((u8 *)(__phdr)) + 28, __val)
	100	#define SET_BEACON_PROBE_RSP_BEACON_INTERVAL(__phdr, __val) \
	101	WRITEEF2BYTE(((u8 *)(__phdr)) + 32, __val)
	102	#define GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr) \
	103	READEF2BYTE(((u8 *)(__phdr)) + 34)
	104	#define SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
	105	WRITEEF2BYTE(((u8 *)(__phdr)) + 34, __val)
	106	#define MASK_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
	107	SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, \
	108	(GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr) & (~(__val))))
0c817338 LF	109
	110	int rtl_init_core(struct ieee80211_hw *hw);
	111	void rtl_deinit_core(struct ieee80211_hw *hw);
	112	void rtl_init_rx_config(struct ieee80211_hw *hw);
	113	void rtl_init_rfkill(struct ieee80211_hw *hw);
	114	void rtl_deinit_rfkill(struct ieee80211_hw *hw);
	115
26634c4b	116	void rtl_beacon_statistic(struct ieee80211_hw hw, struct sk_buff skb);
0c817338 LF	117	void rtl_deinit_deferred_work(struct ieee80211_hw *hw);
	118
	119	bool rtl_action_proc(struct ieee80211_hw hw, struct sk_buff skb, u8 is_tx);
0c817338 LF	120	u8 rtl_is_special_data(struct ieee80211_hw hw, struct sk_buff skb, u8 is_tx);
	121
	122	void rtl_watch_dog_timer_callback(unsigned long data);
acd48572	123	int rtl_tx_agg_start(struct ieee80211_hw hw, struct ieee80211_sta sta,
0c817338	124	u16 tid, u16 *ssn);
acd48572 C	125	int rtl_tx_agg_stop(struct ieee80211_hw hw, struct ieee80211_sta sta,
	126	u16 tid);
	127	int rtl_tx_agg_oper(struct ieee80211_hw hw, struct ieee80211_sta sta,
	128	u16 tid);
26634c4b LF	129	int rtl_rx_agg_start(struct ieee80211_hw hw, struct ieee80211_sta sta,
	130	u16 tid);
	131	int rtl_rx_agg_stop(struct ieee80211_hw hw, struct ieee80211_sta sta,
	132	u16 tid);
0c817338	133	void rtl_watchdog_wq_callback(void *data);
26634c4b	134	void rtl_fwevt_wq_callback(void *data);
0c817338 LF	135
	136	void rtl_get_tcb_desc(struct ieee80211_hw *hw,
	137	struct ieee80211_tx_info *info,
acd48572	138	struct ieee80211_sta *sta,
0c817338 LF	139	struct sk_buff skb, struct rtl_tcb_desc tcb_desc);
0c817338 LF	140
acd48572	141	int rtl_send_smps_action(struct ieee80211_hw *hw,
26634c4b LF	142	struct ieee80211_sta *sta,
26634c4b LF	143	enum ieee80211_smps_mode smps);
acd48572 C	144	u8 rtl_find_ie(u8 data, unsigned int len, u8 ie);
acd48572 C	145	void rtl_recognize_peer(struct ieee80211_hw hw, u8 data, unsigned int len);
2a00def4	146	u8 rtl_tid_to_ac(u8 tid);
0c817338	147	extern struct attribute_group rtl_attribute_group;
26634c4b	148	void rtl_easy_concurrent_retrytimer_callback(unsigned long data);
6f334c2b	149	extern struct rtl_global_var rtl_global_var;
7ad0ce35 LF	150	int rtlwifi_rate_mapping(struct ieee80211_hw *hw,
7ad0ce35 LF	151	bool isht, u8 desc_rate, bool first_ampdu);
0f015453	152	bool rtl_tx_mgmt_proc(struct ieee80211_hw hw, struct sk_buff skb);
26634c4b LF	153	struct sk_buff rtl_make_del_ba(struct ieee80211_hw hw,
26634c4b LF	154	u8 sa, u8 bssid, u16 tid);
4f4826da	155	void rtl_phy_scan_operation_backup(struct ieee80211_hw *hw, u8 operation);
0f015453	156
0c817338	157	#endif