1 /**
2  * Copyright (c) 2014 Redpine Signals Inc.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #ifndef __RSI_MGMT_H__
18 #define __RSI_MGMT_H__
19 
20 #include <linux/sort.h>
21 #include "rsi_boot_params.h"
22 #include "rsi_main.h"
23 
24 #define MAX_MGMT_PKT_SIZE               512
25 #define RSI_NEEDED_HEADROOM             80
26 #define RSI_RCV_BUFFER_LEN              2000
27 
28 #define RSI_11B_MODE                    0
29 #define RSI_11G_MODE                    BIT(7)
30 #define RETRY_COUNT                     8
31 #define RETRY_LONG                      4
32 #define RETRY_SHORT                     7
33 #define WMM_SHORT_SLOT_TIME             9
34 #define SIFS_DURATION                   16
35 
36 #define KEY_TYPE_CLEAR                  0
37 #define RSI_PAIRWISE_KEY                1
38 #define RSI_GROUP_KEY                   2
39 
40 /* EPPROM_READ_ADDRESS */
41 #define WLAN_MAC_EEPROM_ADDR            40
42 #define WLAN_MAC_MAGIC_WORD_LEN         0x01
43 #define WLAN_HOST_MODE_LEN              0x04
44 #define WLAN_FW_VERSION_LEN             0x08
45 #define MAGIC_WORD                      0x5A
46 
47 /* Receive Frame Types */
48 #define TA_CONFIRM_TYPE                 0x01
49 #define RX_DOT11_MGMT                   0x02
50 #define TX_STATUS_IND                   0x04
51 #define PROBEREQ_CONFIRM                2
52 #define CARD_READY_IND                  0x00
53 
54 #define RSI_DELETE_PEER                 0x0
55 #define RSI_ADD_PEER                    0x1
56 #define START_AMPDU_AGGR                0x1
57 #define STOP_AMPDU_AGGR                 0x0
58 #define INTERNAL_MGMT_PKT               0x99
59 
60 #define PUT_BBP_RESET                   0
61 #define BBP_REG_WRITE                   0
62 #define RF_RESET_ENABLE                 BIT(3)
63 #define RATE_INFO_ENABLE                BIT(0)
64 #define RSI_BROADCAST_PKT               BIT(9)
65 
66 #define UPPER_20_ENABLE                 (0x2 << 12)
67 #define LOWER_20_ENABLE                 (0x4 << 12)
68 #define FULL40M_ENABLE                  0x6
69 
70 #define RSI_LMAC_CLOCK_80MHZ            0x1
71 #define RSI_ENABLE_40MHZ                (0x1 << 3)
72 #define ENABLE_SHORTGI_RATE		BIT(9)
73 
74 #define RX_BA_INDICATION                1
75 #define RSI_TBL_SZ                      40
76 #define MAX_RETRIES                     8
77 #define RSI_IFTYPE_STATION		 0
78 
79 #define STD_RATE_MCS7                   0x07
80 #define STD_RATE_MCS6                   0x06
81 #define STD_RATE_MCS5                   0x05
82 #define STD_RATE_MCS4                   0x04
83 #define STD_RATE_MCS3                   0x03
84 #define STD_RATE_MCS2                   0x02
85 #define STD_RATE_MCS1                   0x01
86 #define STD_RATE_MCS0                   0x00
87 #define STD_RATE_54                     0x6c
88 #define STD_RATE_48                     0x60
89 #define STD_RATE_36                     0x48
90 #define STD_RATE_24                     0x30
91 #define STD_RATE_18                     0x24
92 #define STD_RATE_12                     0x18
93 #define STD_RATE_11                     0x16
94 #define STD_RATE_09                     0x12
95 #define STD_RATE_06                     0x0C
96 #define STD_RATE_5_5                    0x0B
97 #define STD_RATE_02                     0x04
98 #define STD_RATE_01                     0x02
99 
100 #define RSI_RF_TYPE                     1
101 #define RSI_RATE_00                     0x00
102 #define RSI_RATE_1                      0x0
103 #define RSI_RATE_2                      0x2
104 #define RSI_RATE_5_5                    0x4
105 #define RSI_RATE_11                     0x6
106 #define RSI_RATE_6                      0x8b
107 #define RSI_RATE_9                      0x8f
108 #define RSI_RATE_12                     0x8a
109 #define RSI_RATE_18                     0x8e
110 #define RSI_RATE_24                     0x89
111 #define RSI_RATE_36                     0x8d
112 #define RSI_RATE_48                     0x88
113 #define RSI_RATE_54                     0x8c
114 #define RSI_RATE_MCS0                   0x100
115 #define RSI_RATE_MCS1                   0x101
116 #define RSI_RATE_MCS2                   0x102
117 #define RSI_RATE_MCS3                   0x103
118 #define RSI_RATE_MCS4                   0x104
119 #define RSI_RATE_MCS5                   0x105
120 #define RSI_RATE_MCS6                   0x106
121 #define RSI_RATE_MCS7                   0x107
122 #define RSI_RATE_MCS7_SG                0x307
123 
124 #define BW_20MHZ                        0
125 #define BW_40MHZ                        1
126 
127 #define EP_2GHZ_20MHZ			0
128 #define EP_2GHZ_40MHZ			1
129 #define EP_5GHZ_20MHZ			2
130 #define EP_5GHZ_40MHZ			3
131 
132 #define SIFS_TX_11N_VALUE		580
133 #define SIFS_TX_11B_VALUE		346
134 #define SHORT_SLOT_VALUE		360
135 #define LONG_SLOT_VALUE			640
136 #define OFDM_ACK_TOUT_VALUE		2720
137 #define CCK_ACK_TOUT_VALUE		9440
138 #define LONG_PREAMBLE			0x0000
139 #define SHORT_PREAMBLE			0x0001
140 
141 #define RSI_SUPP_FILTERS	(FIF_ALLMULTI | FIF_PROBE_REQ |\
142 				 FIF_BCN_PRBRESP_PROMISC)
143 
144 #define ANTENNA_SEL_INT			0x02 /* RF_OUT_2 / Integerated */
145 #define ANTENNA_SEL_UFL			0x03 /* RF_OUT_1 / U.FL */
146 
147 /* Rx filter word definitions */
148 #define PROMISCOUS_MODE			BIT(0)
149 #define ALLOW_DATA_ASSOC_PEER		BIT(1)
150 #define ALLOW_MGMT_ASSOC_PEER		BIT(2)
151 #define ALLOW_CTRL_ASSOC_PEER		BIT(3)
152 #define DISALLOW_BEACONS		BIT(4)
153 #define ALLOW_CONN_PEER_MGMT_WHILE_BUF_FULL BIT(5)
154 #define DISALLOW_BROADCAST_DATA		BIT(6)
155 
156 enum opmode {
157 	STA_OPMODE = 1,
158 	AP_OPMODE = 2
159 };
160 
161 enum vap_status {
162 	VAP_ADD = 1,
163 	VAP_DELETE = 2,
164 	VAP_UPDATE = 3
165 };
166 
167 extern struct ieee80211_rate rsi_rates[12];
168 extern const u16 rsi_mcsrates[8];
169 
170 enum sta_notify_events {
171 	STA_CONNECTED = 0,
172 	STA_DISCONNECTED,
173 	STA_TX_ADDBA_DONE,
174 	STA_TX_DELBA,
175 	STA_RX_ADDBA_DONE,
176 	STA_RX_DELBA
177 };
178 
179 /* Send Frames Types */
180 enum cmd_frame_type {
181 	TX_DOT11_MGMT,
182 	RESET_MAC_REQ,
183 	RADIO_CAPABILITIES,
184 	BB_PROG_VALUES_REQUEST,
185 	RF_PROG_VALUES_REQUEST,
186 	WAKEUP_SLEEP_REQUEST,
187 	SCAN_REQUEST,
188 	TSF_UPDATE,
189 	PEER_NOTIFY,
190 	BLOCK_HW_QUEUE,
191 	SET_KEY_REQ,
192 	AUTO_RATE_IND,
193 	BOOTUP_PARAMS_REQUEST,
194 	VAP_CAPABILITIES,
195 	EEPROM_READ_TYPE ,
196 	EEPROM_WRITE,
197 	GPIO_PIN_CONFIG ,
198 	SET_RX_FILTER,
199 	AMPDU_IND,
200 	STATS_REQUEST_FRAME,
201 	BB_BUF_PROG_VALUES_REQ,
202 	BBP_PROG_IN_TA,
203 	BG_SCAN_PARAMS,
204 	BG_SCAN_PROBE_REQ,
205 	CW_MODE_REQ,
206 	PER_CMD_PKT,
207 	ANT_SEL_FRAME = 0x20,
208 	RADIO_PARAMS_UPDATE = 0x29
209 };
210 
211 struct rsi_mac_frame {
212 	__le16 desc_word[8];
213 } __packed;
214 
215 struct rsi_boot_params {
216 	__le16 desc_word[8];
217 	struct bootup_params bootup_params;
218 } __packed;
219 
220 struct rsi_peer_notify {
221 	__le16 desc_word[8];
222 	u8 mac_addr[6];
223 	__le16 command;
224 	__le16 mpdu_density;
225 	__le16 reserved;
226 	__le32 sta_flags;
227 } __packed;
228 
229 struct rsi_vap_caps {
230 	__le16 desc_word[8];
231 	u8 mac_addr[6];
232 	__le16 keep_alive_period;
233 	u8 bssid[6];
234 	__le16 reserved;
235 	__le32 flags;
236 	__le16 frag_threshold;
237 	__le16 rts_threshold;
238 	__le32 default_mgmt_rate;
239 	__le32 default_ctrl_rate;
240 	__le32 default_data_rate;
241 	__le16 beacon_interval;
242 	__le16 dtim_period;
243 } __packed;
244 
245 struct rsi_set_key {
246 	__le16 desc_word[8];
247 	u8 key[4][32];
248 	u8 tx_mic_key[8];
249 	u8 rx_mic_key[8];
250 } __packed;
251 
252 struct rsi_auto_rate {
253 	__le16 desc_word[8];
254 	__le16 failure_limit;
255 	__le16 initial_boundary;
256 	__le16 max_threshold_limt;
257 	__le16 num_supported_rates;
258 	__le16 aarf_rssi;
259 	__le16 moderate_rate_inx;
260 	__le16 collision_tolerance;
261 	__le16 supported_rates[40];
262 } __packed;
263 
264 struct qos_params {
265 	__le16 cont_win_min_q;
266 	__le16 cont_win_max_q;
267 	__le16 aifsn_val_q;
268 	__le16 txop_q;
269 } __packed;
270 
271 struct rsi_radio_caps {
272 	__le16 desc_word[8];
273 	struct qos_params qos_params[MAX_HW_QUEUES];
274 	u8 num_11n_rates;
275 	u8 num_11ac_rates;
276 	__le16 gcpd_per_rate[20];
277 	__le16 sifs_tx_11n;
278 	__le16 sifs_tx_11b;
279 	__le16 slot_rx_11n;
280 	__le16 ofdm_ack_tout;
281 	__le16 cck_ack_tout;
282 	__le16 preamble_type;
283 } __packed;
284 
285 static inline u32 rsi_get_queueno(u8 *addr, u16 offset)
286 {
287 	return (le16_to_cpu(*(__le16 *)&addr[offset]) & 0x7000) >> 12;
288 }
289 
290 static inline u32 rsi_get_length(u8 *addr, u16 offset)
291 {
292 	return (le16_to_cpu(*(__le16 *)&addr[offset])) & 0x0fff;
293 }
294 
295 static inline u8 rsi_get_extended_desc(u8 *addr, u16 offset)
296 {
297 	return le16_to_cpu(*((__le16 *)&addr[offset + 4])) & 0x00ff;
298 }
299 
300 static inline u8 rsi_get_rssi(u8 *addr)
301 {
302 	return *(u8 *)(addr + FRAME_DESC_SZ);
303 }
304 
305 static inline u8 rsi_get_channel(u8 *addr)
306 {
307 	return *(char *)(addr + 15);
308 }
309 
310 int rsi_mgmt_pkt_recv(struct rsi_common *common, u8 *msg);
311 int rsi_set_vap_capabilities(struct rsi_common *common, enum opmode mode,
312 			     u8 vap_status);
313 int rsi_send_aggregation_params_frame(struct rsi_common *common, u16 tid,
314 				      u16 ssn, u8 buf_size, u8 event);
315 int rsi_hal_load_key(struct rsi_common *common, u8 *data, u16 key_len,
316 		     u8 key_type, u8 key_id, u32 cipher);
317 int rsi_set_channel(struct rsi_common *common,
318 		    struct ieee80211_channel *channel);
319 int rsi_send_block_unblock_frame(struct rsi_common *common, bool event);
320 void rsi_inform_bss_status(struct rsi_common *common, u8 status,
321 			   const u8 *bssid, u8 qos_enable, u16 aid);
322 void rsi_indicate_pkt_to_os(struct rsi_common *common, struct sk_buff *skb);
323 int rsi_mac80211_attach(struct rsi_common *common);
324 void rsi_indicate_tx_status(struct rsi_hw *common, struct sk_buff *skb,
325 			    int status);
326 bool rsi_is_cipher_wep(struct rsi_common *common);
327 void rsi_core_qos_processor(struct rsi_common *common);
328 void rsi_core_xmit(struct rsi_common *common, struct sk_buff *skb);
329 int rsi_send_mgmt_pkt(struct rsi_common *common, struct sk_buff *skb);
330 int rsi_send_data_pkt(struct rsi_common *common, struct sk_buff *skb);
331 int rsi_band_check(struct rsi_common *common);
332 int rsi_send_rx_filter_frame(struct rsi_common *common, u16 rx_filter_word);
333 int rsi_send_radio_params_update(struct rsi_common *common);
334 int rsi_set_antenna(struct rsi_common *common, u8 antenna);
335 #endif
336