x86/speculation/mds: Fix documentation typo
[linux/fpc-iii.git] / drivers / staging / rtlwifi / base.h
blob1829712dc4e25ce68ae77c4b1ad5e01d58fe8249
1 /******************************************************************************
3 * Copyright(c) 2009-2012 Realtek Corporation.
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.
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.
14 * The full GNU General Public License is included in this distribution in the
15 * file called LICENSE.
17 * Contact Information:
18 * wlanfae <wlanfae@realtek.com>
19 * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
20 * Hsinchu 300, Taiwan.
22 * Larry Finger <Larry.Finger@lwfinger.net>
24 *****************************************************************************/
26 #ifndef __RTL_BASE_H__
27 #define __RTL_BASE_H__
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,
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)
48 #define MAX_BIT_RATE_40MHZ_MCS15 300 /* Mbps */
49 #define MAX_BIT_RATE_40MHZ_MCS7 150 /* Mbps */
51 #define MAX_BIT_RATE_SHORT_GI_2NSS_80MHZ_MCS9 867 /* Mbps */
52 #define MAX_BIT_RATE_SHORT_GI_2NSS_80MHZ_MCS7 650 /* Mbps */
53 #define MAX_BIT_RATE_LONG_GI_2NSS_80MHZ_MCS9 780 /* Mbps */
54 #define MAX_BIT_RATE_LONG_GI_2NSS_80MHZ_MCS7 585 /* Mbps */
56 #define MAX_BIT_RATE_SHORT_GI_1NSS_80MHZ_MCS9 434 /* Mbps */
57 #define MAX_BIT_RATE_SHORT_GI_1NSS_80MHZ_MCS7 325 /* Mbps */
58 #define MAX_BIT_RATE_LONG_GI_1NSS_80MHZ_MCS9 390 /* Mbps */
59 #define MAX_BIT_RATE_LONG_GI_1NSS_80MHZ_MCS7 293 /* Mbps */
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 #define MAX_LISTEN_INTERVAL 10
69 #define MAX_RATE_TRIES 4
71 #define SET_80211_HDR_FRAME_CONTROL(_hdr, _val) \
72 WRITEEF2BYTE(_hdr, _val)
73 #define SET_80211_HDR_TYPE_AND_SUBTYPE(_hdr, _val) \
74 WRITEEF1BYTE(_hdr, _val)
75 #define SET_80211_HDR_PWR_MGNT(_hdr, _val) \
76 SET_BITS_TO_LE_2BYTE(_hdr, 12, 1, _val)
77 #define SET_80211_HDR_TO_DS(_hdr, _val) \
78 SET_BITS_TO_LE_2BYTE(_hdr, 8, 1, _val)
80 #define SET_80211_PS_POLL_AID(_hdr, _val) \
81 (*(u16 *)((u8 *)(_hdr) + 2) = _val)
82 #define SET_80211_PS_POLL_BSSID(_hdr, _val) \
83 ether_addr_copy(((u8 *)(_hdr)) + 4, (u8 *)(_val))
84 #define SET_80211_PS_POLL_TA(_hdr, _val) \
85 ether_addr_copy(((u8 *)(_hdr)) + 10, (u8 *)(_val))
87 #define SET_80211_HDR_DURATION(_hdr, _val) \
88 (*(u16 *)((u8 *)(_hdr) + FRAME_OFFSET_DURATION) = le16_to_cpu(_val))
89 #define SET_80211_HDR_ADDRESS1(_hdr, _val) \
90 CP_MACADDR((u8 *)(_hdr) + FRAME_OFFSET_ADDRESS1, (u8 *)(_val))
91 #define SET_80211_HDR_ADDRESS2(_hdr, _val) \
92 CP_MACADDR((u8 *)(_hdr) + FRAME_OFFSET_ADDRESS2, (u8 *)(_val))
93 #define SET_80211_HDR_ADDRESS3(_hdr, _val) \
94 CP_MACADDR((u8 *)(_hdr) + FRAME_OFFSET_ADDRESS3, (u8 *)(_val))
95 #define SET_80211_HDR_FRAGMENT_SEQUENCE(_hdr, _val) \
96 WRITEEF2BYTE((u8 *)(_hdr) + FRAME_OFFSET_SEQUENCE, _val)
98 #define SET_BEACON_PROBE_RSP_TIME_STAMP_LOW(__phdr, __val) \
99 WRITEEF4BYTE(((u8 *)(__phdr)) + 24, __val)
100 #define SET_BEACON_PROBE_RSP_TIME_STAMP_HIGH(__phdr, __val) \
101 WRITEEF4BYTE(((u8 *)(__phdr)) + 28, __val)
102 #define SET_BEACON_PROBE_RSP_BEACON_INTERVAL(__phdr, __val) \
103 WRITEEF2BYTE(((u8 *)(__phdr)) + 32, __val)
104 #define GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr) \
105 READEF2BYTE(((u8 *)(__phdr)) + 34)
106 #define SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
107 WRITEEF2BYTE(((u8 *)(__phdr)) + 34, __val)
108 #define MASK_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, __val) \
109 SET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr, \
110 (GET_BEACON_PROBE_RSP_CAPABILITY_INFO(__phdr) & (~(__val))))
112 #define SET_TX_DESC_SPE_RPT(__pdesc, __val) \
113 SET_BITS_TO_LE_4BYTE((__pdesc) + 8, 19, 1, __val)
114 #define SET_TX_DESC_SW_DEFINE(__pdesc, __val) \
115 SET_BITS_TO_LE_4BYTE((__pdesc) + 24, 0, 12, __val)
117 int rtl_init_core(struct ieee80211_hw *hw);
118 void rtl_deinit_core(struct ieee80211_hw *hw);
119 void rtl_init_rx_config(struct ieee80211_hw *hw);
120 void rtl_init_rfkill(struct ieee80211_hw *hw);
121 void rtl_deinit_rfkill(struct ieee80211_hw *hw);
123 void rtl_watch_dog_timer_callback(unsigned long data);
124 void rtl_deinit_deferred_work(struct ieee80211_hw *hw);
126 bool rtl_action_proc(struct ieee80211_hw *hw, struct sk_buff *skb, u8 is_tx);
127 int rtlwifi_rate_mapping(struct ieee80211_hw *hw, bool isht,
128 bool isvht, u8 desc_rate);
129 bool rtl_tx_mgmt_proc(struct ieee80211_hw *hw, struct sk_buff *skb);
130 u8 rtl_is_special_data(struct ieee80211_hw *hw, struct sk_buff *skb, u8 is_tx,
131 bool is_enc);
133 bool rtl_is_tx_report_skb(struct ieee80211_hw *hw, struct sk_buff *skb);
134 void rtl_get_tx_report(struct rtl_tcb_desc *ptcb_desc, u8 *pdesc,
135 struct ieee80211_hw *hw);
136 void rtl_tx_report_handler(struct ieee80211_hw *hw, u8 *tmp_buf,
137 u8 c2h_cmd_len);
138 bool rtl_check_tx_report_acked(struct ieee80211_hw *hw);
139 void rtl_wait_tx_report_acked(struct ieee80211_hw *hw, u32 wait_ms);
140 u32 rtl_get_hal_edca_param(struct ieee80211_hw *hw,
141 struct ieee80211_vif *vif,
142 enum wireless_mode wirelessmode,
143 struct ieee80211_tx_queue_params *param);
145 void rtl_beacon_statistic(struct ieee80211_hw *hw, struct sk_buff *skb);
146 void rtl_collect_scan_list(struct ieee80211_hw *hw, struct sk_buff *skb);
147 void rtl_scan_list_expire(struct ieee80211_hw *hw);
148 int rtl_tx_agg_start(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
149 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
150 int rtl_tx_agg_stop(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
151 struct ieee80211_sta *sta, u16 tid);
152 int rtl_tx_agg_oper(struct ieee80211_hw *hw,
153 struct ieee80211_sta *sta, u16 tid);
154 int rtl_rx_agg_start(struct ieee80211_hw *hw,
155 struct ieee80211_sta *sta, u16 tid);
156 int rtl_rx_agg_stop(struct ieee80211_hw *hw,
157 struct ieee80211_sta *sta, u16 tid);
158 void rtl_rx_ampdu_apply(struct rtl_priv *rtlpriv);
159 void rtl_watchdog_wq_callback(void *data);
160 void rtl_fwevt_wq_callback(void *data);
161 void rtl_c2hcmd_wq_callback(void *data);
162 void rtl_c2hcmd_launcher(struct ieee80211_hw *hw, int exec);
163 void rtl_c2hcmd_enqueue(struct ieee80211_hw *hw, u8 tag, u8 len, u8 *val);
165 u8 rtl_mrate_idx_to_arfr_id(
166 struct ieee80211_hw *hw, u8 rate_index,
167 enum wireless_mode wirelessmode);
168 void rtl_get_tcb_desc(struct ieee80211_hw *hw,
169 struct ieee80211_tx_info *info,
170 struct ieee80211_sta *sta,
171 struct sk_buff *skb, struct rtl_tcb_desc *tcb_desc);
173 int rtl_send_smps_action(struct ieee80211_hw *hw,
174 struct ieee80211_sta *sta,
175 enum ieee80211_smps_mode smps);
176 u8 *rtl_find_ie(u8 *data, unsigned int len, u8 ie);
177 void rtl_recognize_peer(struct ieee80211_hw *hw, u8 *data, unsigned int len);
178 u8 rtl_tid_to_ac(u8 tid);
179 void rtl_easy_concurrent_retrytimer_callback(unsigned long data);
180 extern struct rtl_global_var rtl_global_var;
181 void rtl_phy_scan_operation_backup(struct ieee80211_hw *hw, u8 operation);
182 bool rtl_check_beacon_key(struct ieee80211_hw *hw, void *data,
183 unsigned int len);
184 int rtl_core_module_init(void);
185 void rtl_core_module_exit(void);
186 #endif