Commit | Line | Data |
---|---|---|
2f01a1f5 | 1 | /* |
80301cdc | 2 | * This file is part of wl1251 |
2f01a1f5 KV |
3 | * |
4 | * Copyright (c) 1998-2007 Texas Instruments Incorporated | |
5 | * Copyright (C) 2008 Nokia Corporation | |
6 | * | |
2f01a1f5 KV |
7 | * This program is free software; you can redistribute it and/or |
8 | * modify it under the terms of the GNU General Public License | |
9 | * version 2 as published by the Free Software Foundation. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, but | |
12 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 | * General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program; if not, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
19 | * 02110-1301 USA | |
20 | * | |
21 | */ | |
22 | ||
80301cdc KV |
23 | #ifndef __WL1251_CMD_H__ |
24 | #define __WL1251_CMD_H__ | |
2f01a1f5 | 25 | |
13674118 | 26 | #include "wl1251.h" |
2f01a1f5 | 27 | |
dc52f0a8 KV |
28 | #include <net/cfg80211.h> |
29 | ||
ff25839b KV |
30 | struct acx_header; |
31 | ||
80301cdc KV |
32 | int wl1251_cmd_send(struct wl1251 *wl, u16 type, void *buf, size_t buf_len); |
33 | int wl1251_cmd_test(struct wl1251 *wl, void *buf, size_t buf_len, u8 answer); | |
34 | int wl1251_cmd_interrogate(struct wl1251 *wl, u16 id, void *buf, size_t len); | |
35 | int wl1251_cmd_configure(struct wl1251 *wl, u16 id, void *buf, size_t len); | |
36 | int wl1251_cmd_vbm(struct wl1251 *wl, u8 identity, | |
2f01a1f5 | 37 | void *bitmap, u16 bitmap_len, u8 bitmap_control); |
9281691f DG |
38 | int wl1251_cmd_data_path_rx(struct wl1251 *wl, u8 channel, bool enable); |
39 | int wl1251_cmd_data_path_tx(struct wl1251 *wl, u8 channel, bool enable); | |
c88f8754 KV |
40 | int wl1251_cmd_join(struct wl1251 *wl, u8 bss_type, u8 channel, |
41 | u16 beacon_interval, u8 dtim_interval); | |
80301cdc KV |
42 | int wl1251_cmd_ps_mode(struct wl1251 *wl, u8 ps_mode); |
43 | int wl1251_cmd_read_memory(struct wl1251 *wl, u32 addr, void *answer, | |
ff25839b | 44 | size_t len); |
80301cdc | 45 | int wl1251_cmd_template_set(struct wl1251 *wl, u16 cmd_id, |
2f01a1f5 | 46 | void *buf, size_t buf_len); |
3a98c30f | 47 | int wl1251_cmd_scan(struct wl1251 *wl, u8 *ssid, size_t ssid_len, |
dc52f0a8 | 48 | struct ieee80211_channel *channels[], |
3a98c30f KV |
49 | unsigned int n_channels, unsigned int n_probes); |
50 | int wl1251_cmd_trigger_scan_to(struct wl1251 *wl, u32 timeout); | |
2f01a1f5 KV |
51 | |
52 | /* unit ms */ | |
80301cdc | 53 | #define WL1251_COMMAND_TIMEOUT 2000 |
2f01a1f5 | 54 | |
80301cdc | 55 | enum wl1251_commands { |
2f01a1f5 KV |
56 | CMD_RESET = 0, |
57 | CMD_INTERROGATE = 1, /*use this to read information elements*/ | |
58 | CMD_CONFIGURE = 2, /*use this to write information elements*/ | |
59 | CMD_ENABLE_RX = 3, | |
60 | CMD_ENABLE_TX = 4, | |
61 | CMD_DISABLE_RX = 5, | |
62 | CMD_DISABLE_TX = 6, | |
63 | CMD_SCAN = 8, | |
64 | CMD_STOP_SCAN = 9, | |
65 | CMD_VBM = 10, | |
66 | CMD_START_JOIN = 11, | |
67 | CMD_SET_KEYS = 12, | |
68 | CMD_READ_MEMORY = 13, | |
69 | CMD_WRITE_MEMORY = 14, | |
70 | CMD_BEACON = 19, | |
71 | CMD_PROBE_RESP = 20, | |
72 | CMD_NULL_DATA = 21, | |
73 | CMD_PROBE_REQ = 22, | |
74 | CMD_TEST = 23, | |
75 | CMD_RADIO_CALIBRATE = 25, /* OBSOLETE */ | |
76 | CMD_ENABLE_RX_PATH = 27, /* OBSOLETE */ | |
77 | CMD_NOISE_HIST = 28, | |
78 | CMD_RX_RESET = 29, | |
79 | CMD_PS_POLL = 30, | |
80 | CMD_QOS_NULL_DATA = 31, | |
81 | CMD_LNA_CONTROL = 32, | |
82 | CMD_SET_BCN_MODE = 33, | |
83 | CMD_MEASUREMENT = 34, | |
84 | CMD_STOP_MEASUREMENT = 35, | |
85 | CMD_DISCONNECT = 36, | |
86 | CMD_SET_PS_MODE = 37, | |
87 | CMD_CHANNEL_SWITCH = 38, | |
88 | CMD_STOP_CHANNEL_SWICTH = 39, | |
89 | CMD_AP_DISCOVERY = 40, | |
90 | CMD_STOP_AP_DISCOVERY = 41, | |
91 | CMD_SPS_SCAN = 42, | |
92 | CMD_STOP_SPS_SCAN = 43, | |
93 | CMD_HEALTH_CHECK = 45, | |
94 | CMD_DEBUG = 46, | |
95 | CMD_TRIGGER_SCAN_TO = 47, | |
96 | ||
97 | NUM_COMMANDS, | |
98 | MAX_COMMAND_ID = 0xFFFF, | |
99 | }; | |
100 | ||
101 | #define MAX_CMD_PARAMS 572 | |
102 | ||
80301cdc | 103 | struct wl1251_cmd_header { |
2f01a1f5 KV |
104 | u16 id; |
105 | u16 status; | |
ff25839b KV |
106 | /* payload */ |
107 | u8 data[0]; | |
ba2d3587 | 108 | } __packed; |
ff25839b | 109 | |
80301cdc KV |
110 | struct wl1251_command { |
111 | struct wl1251_cmd_header header; | |
2f01a1f5 | 112 | u8 parameters[MAX_CMD_PARAMS]; |
8d5ad085 | 113 | } __packed; |
2f01a1f5 KV |
114 | |
115 | enum { | |
116 | CMD_MAILBOX_IDLE = 0, | |
117 | CMD_STATUS_SUCCESS = 1, | |
118 | CMD_STATUS_UNKNOWN_CMD = 2, | |
119 | CMD_STATUS_UNKNOWN_IE = 3, | |
120 | CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11, | |
121 | CMD_STATUS_RX_BUSY = 13, | |
122 | CMD_STATUS_INVALID_PARAM = 14, | |
123 | CMD_STATUS_TEMPLATE_TOO_LARGE = 15, | |
124 | CMD_STATUS_OUT_OF_MEMORY = 16, | |
125 | CMD_STATUS_STA_TABLE_FULL = 17, | |
126 | CMD_STATUS_RADIO_ERROR = 18, | |
127 | CMD_STATUS_WRONG_NESTING = 19, | |
128 | CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/ | |
129 | CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/ | |
130 | MAX_COMMAND_STATUS = 0xff | |
131 | }; | |
132 | ||
133 | ||
134 | /* | |
135 | * CMD_READ_MEMORY | |
136 | * | |
137 | * The host issues this command to read the WiLink device memory/registers. | |
138 | * | |
139 | * Note: The Base Band address has special handling (16 bits registers and | |
140 | * addresses). For more information, see the hardware specification. | |
141 | */ | |
142 | /* | |
143 | * CMD_WRITE_MEMORY | |
144 | * | |
145 | * The host issues this command to write the WiLink device memory/registers. | |
146 | * | |
147 | * The Base Band address has special handling (16 bits registers and | |
148 | * addresses). For more information, see the hardware specification. | |
149 | */ | |
150 | #define MAX_READ_SIZE 256 | |
151 | ||
152 | struct cmd_read_write_memory { | |
80301cdc | 153 | struct wl1251_cmd_header header; |
ff25839b | 154 | |
2f01a1f5 KV |
155 | /* The address of the memory to read from or write to.*/ |
156 | u32 addr; | |
157 | ||
158 | /* The amount of data in bytes to read from or write to the WiLink | |
159 | * device.*/ | |
160 | u32 size; | |
161 | ||
162 | /* The actual value read from or written to the Wilink. The source | |
163 | of this field is the Host in WRITE command or the Wilink in READ | |
164 | command. */ | |
165 | u8 value[MAX_READ_SIZE]; | |
8d5ad085 | 166 | } __packed; |
2f01a1f5 KV |
167 | |
168 | #define CMDMBOX_HEADER_LEN 4 | |
169 | #define CMDMBOX_INFO_ELEM_HEADER_LEN 4 | |
170 | ||
64322e28 DG |
171 | #define WL1251_SCAN_OPT_PASSIVE 1 |
172 | #define WL1251_SCAN_OPT_5GHZ_BAND 2 | |
173 | #define WL1251_SCAN_OPT_TRIGGERD_SCAN 4 | |
174 | #define WL1251_SCAN_OPT_PRIORITY_HIGH 8 | |
175 | ||
3a98c30f KV |
176 | #define WL1251_SCAN_MIN_DURATION 30000 |
177 | #define WL1251_SCAN_MAX_DURATION 60000 | |
2f01a1f5 | 178 | |
dc52f0a8 KV |
179 | #define WL1251_SCAN_NUM_PROBES 3 |
180 | ||
3a98c30f | 181 | struct wl1251_scan_parameters { |
1ab36d68 JL |
182 | __le32 rx_config_options; |
183 | __le32 rx_filter_options; | |
2f01a1f5 KV |
184 | |
185 | /* | |
186 | * Scan options: | |
187 | * bit 0: When this bit is set, passive scan. | |
188 | * bit 1: Band, when this bit is set we scan | |
189 | * in the 5Ghz band. | |
190 | * bit 2: voice mode, 0 for normal scan. | |
191 | * bit 3: scan priority, 1 for high priority. | |
192 | */ | |
1ab36d68 | 193 | __le16 scan_options; |
2f01a1f5 KV |
194 | |
195 | /* Number of channels to scan */ | |
196 | u8 num_channels; | |
197 | ||
198 | /* Number opf probe requests to send, per channel */ | |
199 | u8 num_probe_requests; | |
200 | ||
201 | /* Rate and modulation for probe requests */ | |
1ab36d68 | 202 | __le16 tx_rate; |
2f01a1f5 KV |
203 | |
204 | u8 tid_trigger; | |
205 | u8 ssid_len; | |
3a98c30f | 206 | u8 ssid[32]; |
2f01a1f5 | 207 | |
ba2d3587 | 208 | } __packed; |
2f01a1f5 | 209 | |
3a98c30f | 210 | struct wl1251_scan_ch_parameters { |
1ab36d68 JL |
211 | __le32 min_duration; /* in TU */ |
212 | __le32 max_duration; /* in TU */ | |
2f01a1f5 KV |
213 | u32 bssid_lsb; |
214 | u16 bssid_msb; | |
215 | ||
216 | /* | |
217 | * bits 0-3: Early termination count. | |
218 | * bits 4-5: Early termination condition. | |
219 | */ | |
220 | u8 early_termination; | |
221 | ||
222 | u8 tx_power_att; | |
223 | u8 channel; | |
224 | u8 pad[3]; | |
ba2d3587 | 225 | } __packed; |
2f01a1f5 KV |
226 | |
227 | /* SCAN parameters */ | |
228 | #define SCAN_MAX_NUM_OF_CHANNELS 16 | |
229 | ||
3a98c30f | 230 | struct wl1251_cmd_scan { |
80301cdc | 231 | struct wl1251_cmd_header header; |
ff25839b | 232 | |
3a98c30f KV |
233 | struct wl1251_scan_parameters params; |
234 | struct wl1251_scan_ch_parameters channels[SCAN_MAX_NUM_OF_CHANNELS]; | |
ba2d3587 | 235 | } __packed; |
2f01a1f5 KV |
236 | |
237 | enum { | |
238 | BSS_TYPE_IBSS = 0, | |
239 | BSS_TYPE_STA_BSS = 2, | |
240 | BSS_TYPE_AP_BSS = 3, | |
241 | MAX_BSS_TYPE = 0xFF | |
242 | }; | |
243 | ||
244 | #define JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */ | |
245 | #define JOIN_CMD_CTRL_EARLY_WAKEUP_ENABLE 0x01 /* Early wakeup time */ | |
246 | ||
247 | ||
248 | struct cmd_join { | |
80301cdc | 249 | struct wl1251_cmd_header header; |
ff25839b | 250 | |
2f01a1f5 KV |
251 | u32 bssid_lsb; |
252 | u16 bssid_msb; | |
253 | u16 beacon_interval; /* in TBTTs */ | |
254 | u32 rx_config_options; | |
255 | u32 rx_filter_options; | |
256 | ||
257 | /* | |
258 | * The target uses this field to determine the rate at | |
259 | * which to transmit control frame responses (such as | |
260 | * ACK or CTS frames). | |
261 | */ | |
262 | u16 basic_rate_set; | |
263 | u8 dtim_interval; | |
264 | u8 tx_ctrl_frame_rate; /* OBSOLETE */ | |
265 | u8 tx_ctrl_frame_mod; /* OBSOLETE */ | |
266 | /* | |
267 | * bits 0-2: This bitwise field specifies the type | |
268 | * of BSS to start or join (BSS_TYPE_*). | |
269 | * bit 4: Band - The radio band in which to join | |
270 | * or start. | |
271 | * 0 - 2.4GHz band | |
272 | * 1 - 5GHz band | |
273 | * bits 3, 5-7: Reserved | |
274 | */ | |
275 | u8 bss_type; | |
276 | u8 channel; | |
277 | u8 ssid_len; | |
9090e167 | 278 | u8 ssid[IEEE80211_MAX_SSID_LEN]; |
2f01a1f5 KV |
279 | u8 ctrl; /* JOIN_CMD_CTRL_* */ |
280 | u8 tx_mgt_frame_rate; /* OBSOLETE */ | |
281 | u8 tx_mgt_frame_mod; /* OBSOLETE */ | |
282 | u8 reserved; | |
ba2d3587 | 283 | } __packed; |
2f01a1f5 | 284 | |
ff25839b | 285 | struct cmd_enabledisable_path { |
80301cdc | 286 | struct wl1251_cmd_header header; |
ff25839b KV |
287 | |
288 | u8 channel; | |
289 | u8 padding[3]; | |
ba2d3587 | 290 | } __packed; |
ff25839b | 291 | |
80301cdc | 292 | #define WL1251_MAX_TEMPLATE_SIZE 300 |
ff25839b | 293 | |
80301cdc KV |
294 | struct wl1251_cmd_packet_template { |
295 | struct wl1251_cmd_header header; | |
ff25839b KV |
296 | |
297 | __le16 size; | |
298 | u8 data[0]; | |
ba2d3587 | 299 | } __packed; |
ff25839b KV |
300 | |
301 | #define TIM_ELE_ID 5 | |
302 | #define PARTIAL_VBM_MAX 251 | |
303 | ||
80301cdc | 304 | struct wl1251_tim { |
ff25839b KV |
305 | u8 identity; |
306 | u8 length; | |
307 | u8 dtim_count; | |
308 | u8 dtim_period; | |
309 | u8 bitmap_ctrl; | |
310 | u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */ | |
ba2d3587 | 311 | } __packed; |
ff25839b KV |
312 | |
313 | /* Virtual Bit Map update */ | |
80301cdc KV |
314 | struct wl1251_cmd_vbm_update { |
315 | struct wl1251_cmd_header header; | |
ff25839b KV |
316 | __le16 len; |
317 | u8 padding[2]; | |
80301cdc | 318 | struct wl1251_tim tim; |
ba2d3587 | 319 | } __packed; |
ff25839b | 320 | |
80301cdc | 321 | enum wl1251_cmd_ps_mode { |
a0bbb58b JN |
322 | CHIP_ACTIVE_MODE, |
323 | CHIP_POWER_SAVE_MODE | |
ff25839b KV |
324 | }; |
325 | ||
80301cdc KV |
326 | struct wl1251_cmd_ps_params { |
327 | struct wl1251_cmd_header header; | |
ff25839b KV |
328 | |
329 | u8 ps_mode; /* STATION_* */ | |
330 | u8 send_null_data; /* Do we have to send NULL data packet ? */ | |
331 | u8 retries; /* Number of retires for the initial NULL data packet */ | |
332 | ||
333 | /* | |
334 | * TUs during which the target stays awake after switching | |
335 | * to power save mode. | |
336 | */ | |
337 | u8 hang_over_period; | |
338 | u16 null_data_rate; | |
339 | u8 pad[2]; | |
ba2d3587 | 340 | } __packed; |
ff25839b | 341 | |
80301cdc KV |
342 | struct wl1251_cmd_trigger_scan_to { |
343 | struct wl1251_cmd_header header; | |
ff25839b KV |
344 | |
345 | u32 timeout; | |
8d5ad085 | 346 | } __packed; |
ff25839b KV |
347 | |
348 | /* HW encryption keys */ | |
349 | #define NUM_ACCESS_CATEGORIES_COPY 4 | |
350 | #define MAX_KEY_SIZE 32 | |
351 | ||
352 | /* When set, disable HW encryption */ | |
353 | #define DF_ENCRYPTION_DISABLE 0x01 | |
354 | /* When set, disable HW decryption */ | |
355 | #define DF_SNIFF_MODE_ENABLE 0x80 | |
356 | ||
80301cdc | 357 | enum wl1251_cmd_key_action { |
ff25839b KV |
358 | KEY_ADD_OR_REPLACE = 1, |
359 | KEY_REMOVE = 2, | |
360 | KEY_SET_ID = 3, | |
361 | MAX_KEY_ACTION = 0xffff, | |
362 | }; | |
363 | ||
80301cdc | 364 | enum wl1251_cmd_key_type { |
ff25839b KV |
365 | KEY_WEP_DEFAULT = 0, |
366 | KEY_WEP_ADDR = 1, | |
367 | KEY_AES_GROUP = 4, | |
368 | KEY_AES_PAIRWISE = 5, | |
369 | KEY_WEP_GROUP = 6, | |
370 | KEY_TKIP_MIC_GROUP = 10, | |
371 | KEY_TKIP_MIC_PAIRWISE = 11, | |
372 | }; | |
373 | ||
374 | /* | |
375 | * | |
376 | * key_type_e key size key format | |
377 | * ---------- --------- ---------- | |
378 | * 0x00 5, 13, 29 Key data | |
379 | * 0x01 5, 13, 29 Key data | |
380 | * 0x04 16 16 bytes of key data | |
381 | * 0x05 16 16 bytes of key data | |
382 | * 0x0a 32 16 bytes of TKIP key data | |
383 | * 8 bytes of RX MIC key data | |
384 | * 8 bytes of TX MIC key data | |
385 | * 0x0b 32 16 bytes of TKIP key data | |
386 | * 8 bytes of RX MIC key data | |
387 | * 8 bytes of TX MIC key data | |
388 | * | |
389 | */ | |
390 | ||
80301cdc KV |
391 | struct wl1251_cmd_set_keys { |
392 | struct wl1251_cmd_header header; | |
ff25839b KV |
393 | |
394 | /* Ignored for default WEP key */ | |
395 | u8 addr[ETH_ALEN]; | |
396 | ||
397 | /* key_action_e */ | |
398 | u16 key_action; | |
399 | ||
400 | u16 reserved_1; | |
401 | ||
402 | /* key size in bytes */ | |
403 | u8 key_size; | |
404 | ||
405 | /* key_type_e */ | |
406 | u8 key_type; | |
407 | u8 ssid_profile; | |
408 | ||
409 | /* | |
410 | * TKIP, AES: frame's key id field. | |
411 | * For WEP default key: key id; | |
412 | */ | |
413 | u8 id; | |
414 | u8 reserved_2[6]; | |
415 | u8 key[MAX_KEY_SIZE]; | |
416 | u16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY]; | |
417 | u32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY]; | |
ba2d3587 | 418 | } __packed; |
ff25839b | 419 | |
2f01a1f5 | 420 | |
80301cdc | 421 | #endif /* __WL1251_CMD_H__ */ |