wl1271: Workaround for reference clock setting on boot.
[linux-2.6.git] / drivers / net / wireless / wl12xx / wl1271_cmd.h
1 /*
2  * This file is part of wl1271
3  *
4  * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
5  * Copyright (C) 2009 Nokia Corporation
6  *
7  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * version 2 as published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21  * 02110-1301 USA
22  *
23  */
24
25 #ifndef __WL1271_CMD_H__
26 #define __WL1271_CMD_H__
27
28 #include "wl1271.h"
29
30 struct acx_header;
31
32 int wl1271_cmd_send(struct wl1271 *wl, u16 type, void *buf, size_t buf_len);
33 int wl1271_cmd_join(struct wl1271 *wl);
34 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
35 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len);
36 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
37 int wl1271_cmd_data_path(struct wl1271 *wl, u8 channel, bool enable);
38 int wl1271_cmd_ps_mode(struct wl1271 *wl, u8 ps_mode);
39 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
40                            size_t len);
41 int wl1271_cmd_scan(struct wl1271 *wl, u8 *ssid, size_t len,
42                     u8 active_scan, u8 high_prio, u8 num_channels,
43                     u8 probe_requests);
44 int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id,
45                             void *buf, size_t buf_len);
46 int wl1271_cmd_build_null_data(struct wl1271 *wl);
47 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, u16 aid);
48 int wl1271_cmd_build_probe_req(struct wl1271 *wl, u8 *ssid, size_t ssid_len);
49 int wl1271_cmd_set_default_wep_key(struct wl1271 *wl, u8 id);
50 int wl1271_cmd_set_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
51                        u8 key_size, const u8 *key, const u8 *addr,
52                        u32 tx_seq_32, u16 tx_seq_16);
53 int wl1271_cmd_disconnect(struct wl1271 *wl);
54
55 enum wl1271_commands {
56         CMD_INTERROGATE     = 1,    /*use this to read information elements*/
57         CMD_CONFIGURE       = 2,    /*use this to write information elements*/
58         CMD_ENABLE_RX       = 3,
59         CMD_ENABLE_TX       = 4,
60         CMD_DISABLE_RX      = 5,
61         CMD_DISABLE_TX      = 6,
62         CMD_SCAN            = 8,
63         CMD_STOP_SCAN       = 9,
64         CMD_START_JOIN      = 11,
65         CMD_SET_KEYS        = 12,
66         CMD_READ_MEMORY     = 13,
67         CMD_WRITE_MEMORY    = 14,
68         CMD_SET_TEMPLATE    = 19,
69         CMD_TEST            = 23,
70         CMD_NOISE_HIST      = 28,
71         CMD_LNA_CONTROL     = 32,
72         CMD_SET_BCN_MODE    = 33,
73         CMD_MEASUREMENT      = 34,
74         CMD_STOP_MEASUREMENT = 35,
75         CMD_DISCONNECT       = 36,
76         CMD_SET_PS_MODE      = 37,
77         CMD_CHANNEL_SWITCH   = 38,
78         CMD_STOP_CHANNEL_SWICTH = 39,
79         CMD_AP_DISCOVERY     = 40,
80         CMD_STOP_AP_DISCOVERY = 41,
81         CMD_SPS_SCAN = 42,
82         CMD_STOP_SPS_SCAN = 43,
83         CMD_HEALTH_CHECK     = 45,
84         CMD_DEBUG            = 46,
85         CMD_TRIGGER_SCAN_TO  = 47,
86         CMD_CONNECTION_SCAN_CFG      = 48,
87         CMD_CONNECTION_SCAN_SSID_CFG = 49,
88         CMD_START_PERIODIC_SCAN      = 50,
89         CMD_STOP_PERIODIC_SCAN       = 51,
90         CMD_SET_STA_STATE            = 52,
91
92         NUM_COMMANDS,
93         MAX_COMMAND_ID = 0xFFFF,
94 };
95
96 #define MAX_CMD_PARAMS 572
97
98 enum cmd_templ {
99         CMD_TEMPL_NULL_DATA = 0,
100         CMD_TEMPL_BEACON,
101         CMD_TEMPL_CFG_PROBE_REQ_2_4,
102         CMD_TEMPL_CFG_PROBE_REQ_5,
103         CMD_TEMPL_PROBE_RESPONSE,
104         CMD_TEMPL_QOS_NULL_DATA,
105         CMD_TEMPL_PS_POLL,
106         CMD_TEMPL_KLV,
107         CMD_TEMPL_DISCONNECT,
108         CMD_TEMPL_PROBE_REQ_2_4, /* for firmware internal use only */
109         CMD_TEMPL_PROBE_REQ_5,   /* for firmware internal use only */
110         CMD_TEMPL_BAR,           /* for firmware internal use only */
111         CMD_TEMPL_CTS,           /*
112                                   * For CTS-to-self (FastCTS) mechanism
113                                   * for BT/WLAN coexistence (SoftGemini). */
114         CMD_TEMPL_MAX = 0xff
115 };
116
117 /* unit ms */
118 #define WL1271_COMMAND_TIMEOUT     2000
119 #define WL1271_CMD_TEMPL_MAX_SIZE  252
120
121 struct wl1271_cmd_header {
122         u16 id;
123         u16 status;
124         /* payload */
125         u8 data[0];
126 } __attribute__ ((packed));
127
128 #define WL1271_CMD_MAX_PARAMS 572
129
130 struct wl1271_command {
131         struct wl1271_cmd_header header;
132         u8  parameters[WL1271_CMD_MAX_PARAMS];
133 } __attribute__ ((packed));
134
135 enum {
136         CMD_MAILBOX_IDLE                =  0,
137         CMD_STATUS_SUCCESS              =  1,
138         CMD_STATUS_UNKNOWN_CMD          =  2,
139         CMD_STATUS_UNKNOWN_IE           =  3,
140         CMD_STATUS_REJECT_MEAS_SG_ACTIVE        = 11,
141         CMD_STATUS_RX_BUSY              = 13,
142         CMD_STATUS_INVALID_PARAM                = 14,
143         CMD_STATUS_TEMPLATE_TOO_LARGE           = 15,
144         CMD_STATUS_OUT_OF_MEMORY                = 16,
145         CMD_STATUS_STA_TABLE_FULL               = 17,
146         CMD_STATUS_RADIO_ERROR          = 18,
147         CMD_STATUS_WRONG_NESTING                = 19,
148         CMD_STATUS_TIMEOUT              = 21, /* Driver internal use.*/
149         CMD_STATUS_FW_RESET             = 22, /* Driver internal use.*/
150         MAX_COMMAND_STATUS              = 0xff
151 };
152
153
154 /*
155  * CMD_READ_MEMORY
156  *
157  * The host issues this command to read the WiLink device memory/registers.
158  *
159  * Note: The Base Band address has special handling (16 bits registers and
160  * addresses). For more information, see the hardware specification.
161  */
162 /*
163  * CMD_WRITE_MEMORY
164  *
165  * The host issues this command to write the WiLink device memory/registers.
166  *
167  * The Base Band address has special handling (16 bits registers and
168  * addresses). For more information, see the hardware specification.
169  */
170 #define MAX_READ_SIZE 256
171
172 struct cmd_read_write_memory {
173         struct wl1271_cmd_header header;
174
175         /* The address of the memory to read from or write to.*/
176         u32 addr;
177
178         /* The amount of data in bytes to read from or write to the WiLink
179          * device.*/
180         u32 size;
181
182         /* The actual value read from or written to the Wilink. The source
183            of this field is the Host in WRITE command or the Wilink in READ
184            command. */
185         u8 value[MAX_READ_SIZE];
186 };
187
188 #define CMDMBOX_HEADER_LEN 4
189 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
190
191 enum {
192         BSS_TYPE_IBSS = 0,
193         BSS_TYPE_STA_BSS = 2,
194         BSS_TYPE_AP_BSS = 3,
195         MAX_BSS_TYPE = 0xFF
196 };
197
198 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH     0x80 /* Firmware flushes all Tx */
199 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
200
201 struct wl1271_cmd_join {
202         struct wl1271_cmd_header header;
203
204         u32 bssid_lsb;
205         u16 bssid_msb;
206         u16 beacon_interval; /* in TBTTs */
207         u32 rx_config_options;
208         u32 rx_filter_options;
209
210         /*
211          * The target uses this field to determine the rate at
212          * which to transmit control frame responses (such as
213          * ACK or CTS frames).
214          */
215         u32 basic_rate_set;
216         u8 dtim_interval;
217         /*
218          * bits 0-2: This bitwise field specifies the type
219          * of BSS to start or join (BSS_TYPE_*).
220          * bit 4: Band - The radio band in which to join
221          * or start.
222          *  0 - 2.4GHz band
223          *  1 - 5GHz band
224          * bits 3, 5-7: Reserved
225          */
226         u8 bss_type;
227         u8 channel;
228         u8 ssid_len;
229         u8 ssid[IW_ESSID_MAX_SIZE];
230         u8 ctrl; /* JOIN_CMD_CTRL_* */
231         u8 reserved[3];
232 } __attribute__ ((packed));
233
234 struct cmd_enabledisable_path {
235         struct wl1271_cmd_header header;
236
237         u8 channel;
238         u8 padding[3];
239 } __attribute__ ((packed));
240
241 struct wl1271_cmd_template_set {
242         struct wl1271_cmd_header header;
243
244         u16 len;
245         u8 template_type;
246         u8 index;  /* relevant only for KLV_TEMPLATE type */
247         u32 enabled_rates;
248         u8 short_retry_limit;
249         u8 long_retry_limit;
250         u8 aflags;
251         u8 reserved;
252         u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
253 } __attribute__ ((packed));
254
255 #define TIM_ELE_ID    5
256 #define PARTIAL_VBM_MAX    251
257
258 struct wl1271_tim {
259         u8 identity;
260         u8 length;
261         u8 dtim_count;
262         u8 dtim_period;
263         u8 bitmap_ctrl;
264         u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
265 } __attribute__ ((packed));
266
267 enum wl1271_cmd_ps_mode {
268         STATION_ACTIVE_MODE,
269         STATION_POWER_SAVE_MODE
270 };
271
272 struct wl1271_cmd_ps_params {
273         struct wl1271_cmd_header header;
274
275         u8 ps_mode; /* STATION_* */
276         u8 send_null_data; /* Do we have to send NULL data packet ? */
277         u8 retries; /* Number of retires for the initial NULL data packet */
278
279          /*
280           * TUs during which the target stays awake after switching
281           * to power save mode.
282           */
283         u8 hang_over_period;
284         u32 null_data_rate;
285 } __attribute__ ((packed));
286
287 /* HW encryption keys */
288 #define NUM_ACCESS_CATEGORIES_COPY 4
289 #define MAX_KEY_SIZE 32
290
291 /* When set, disable HW encryption */
292 #define DF_ENCRYPTION_DISABLE      0x01
293 /* When set, disable HW decryption */
294 #define DF_SNIFF_MODE_ENABLE       0x80
295
296 enum wl1271_cmd_key_action {
297         KEY_ADD_OR_REPLACE = 1,
298         KEY_REMOVE         = 2,
299         KEY_SET_ID         = 3,
300         MAX_KEY_ACTION     = 0xffff,
301 };
302
303 enum wl1271_cmd_key_type {
304         KEY_NONE = 0,
305         KEY_WEP  = 1,
306         KEY_TKIP = 2,
307         KEY_AES  = 3,
308         KEY_GEM  = 4
309 };
310
311 /* FIXME: Add description for key-types */
312
313 struct wl1271_cmd_set_keys {
314         struct wl1271_cmd_header header;
315
316         /* Ignored for default WEP key */
317         u8 addr[ETH_ALEN];
318
319         /* key_action_e */
320         u16 key_action;
321
322         u16 reserved_1;
323
324         /* key size in bytes */
325         u8 key_size;
326
327         /* key_type_e */
328         u8 key_type;
329         u8 ssid_profile;
330
331         /*
332          * TKIP, AES: frame's key id field.
333          * For WEP default key: key id;
334          */
335         u8 id;
336         u8 reserved_2[6];
337         u8 key[MAX_KEY_SIZE];
338         u16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
339         u32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
340 } __attribute__ ((packed));
341
342
343 #define WL1271_SCAN_MAX_CHANNELS       24
344 #define WL1271_SCAN_DEFAULT_TAG        1
345 #define WL1271_SCAN_CURRENT_TX_PWR     0
346 #define WL1271_SCAN_OPT_ACTIVE         0
347 #define WL1271_SCAN_OPT_PASSIVE        1
348 #define WL1271_SCAN_OPT_PRIORITY_HIGH  4
349 #define WL1271_SCAN_CHAN_MIN_DURATION  30000  /* TU */
350 #define WL1271_SCAN_CHAN_MAX_DURATION  60000  /* TU */
351
352 struct basic_scan_params {
353         u32 rx_config_options;
354         u32 rx_filter_options;
355         /* Scan option flags (WL1271_SCAN_OPT_*) */
356         u16 scan_options;
357         /* Number of scan channels in the list (maximum 30) */
358         u8 num_channels;
359         /* This field indicates the number of probe requests to send
360            per channel for an active scan */
361         u8 num_probe_requests;
362         /* Rate bit field for sending the probes */
363         u32 tx_rate;
364         u8 tid_trigger;
365         u8 ssid_len;
366         /* in order to align */
367         u8 padding1[2];
368         u8 ssid[IW_ESSID_MAX_SIZE];
369         /* Band to scan */
370         u8 band;
371         u8 use_ssid_list;
372         u8 scan_tag;
373         u8 padding2;
374 } __attribute__ ((packed));
375
376 struct basic_scan_channel_params {
377         /* Duration in TU to wait for frames on a channel for active scan */
378         u32 min_duration;
379         u32 max_duration;
380         u32 bssid_lsb;
381         u16 bssid_msb;
382         u8 early_termination;
383         u8 tx_power_att;
384         u8 channel;
385         /* FW internal use only! */
386         u8 dfs_candidate;
387         u8 activity_detected;
388         u8 pad;
389 } __attribute__ ((packed));
390
391 struct wl1271_cmd_scan {
392         struct wl1271_cmd_header header;
393
394         struct basic_scan_params params;
395         struct basic_scan_channel_params channels[WL1271_SCAN_MAX_CHANNELS];
396 } __attribute__ ((packed));
397
398 struct wl1271_cmd_trigger_scan_to {
399         struct wl1271_cmd_header header;
400
401         u32 timeout;
402 };
403
404 struct wl1271_cmd_test_header {
405         u8 id;
406         u8 padding[3];
407 };
408
409 enum wl1271_channel_tune_bands {
410         WL1271_CHANNEL_TUNE_BAND_2_4,
411         WL1271_CHANNEL_TUNE_BAND_5,
412         WL1271_CHANNEL_TUNE_BAND_4_9
413 };
414
415 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
416
417 #define TEST_CMD_P2G_CAL                   0x02
418 #define TEST_CMD_CHANNEL_TUNE              0x0d
419 #define TEST_CMD_UPDATE_PD_REFERENCE_POINT 0x1d
420
421 struct wl1271_cmd_cal_channel_tune {
422         struct wl1271_cmd_header header;
423
424         struct wl1271_cmd_test_header test;
425
426         u8 band;
427         u8 channel;
428
429         u16 radio_status;
430 } __attribute__ ((packed));
431
432 struct wl1271_cmd_cal_update_ref_point {
433         struct wl1271_cmd_header header;
434
435         struct wl1271_cmd_test_header test;
436
437         s32 ref_power;
438         s32 ref_detector;
439         u8  sub_band;
440         u8  padding[3];
441 } __attribute__ ((packed));
442
443 #define MAX_TLV_LENGTH         400
444 #define MAX_NVS_VERSION_LENGTH 12
445
446 #define WL1271_CAL_P2G_BAND_B_G BIT(0)
447
448 struct wl1271_cmd_cal_p2g {
449         struct wl1271_cmd_header header;
450
451         struct wl1271_cmd_test_header test;
452
453         u16 len;
454         u8  buf[MAX_TLV_LENGTH];
455         u8  type;
456         u8  padding;
457
458         s16 radio_status;
459         u8  nvs_version[MAX_NVS_VERSION_LENGTH];
460
461         u8  sub_band_mask;
462         u8  padding2;
463 } __attribute__ ((packed));
464
465
466 /*
467  * There are three types of disconnections:
468  *
469  * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
470  * DISCONNECT_DEAUTH:    the fw generates a DEAUTH request with the reason
471  *                       we have passed
472  * DISCONNECT_DISASSOC:  the fw generates a DESASSOC request with the reason
473  *                       we have passed
474  */
475 enum wl1271_disconnect_type {
476         DISCONNECT_IMMEDIATE,
477         DISCONNECT_DEAUTH,
478         DISCONNECT_DISASSOC
479 };
480
481 struct wl1271_cmd_disconnect {
482         u32 rx_config_options;
483         u32 rx_filter_options;
484
485         u16 reason;
486         u8  type;
487
488         u8  padding;
489 } __attribute__ ((packed));
490
491 #endif /* __WL1271_CMD_H__ */