2 * This file is part of wl1271
4 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
5 * Copyright (C) 2009 Nokia Corporation
7 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
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.
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.
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
32 int wl1271_cmd_send(struct wl1271 *wl, u16 id, void *buf, size_t len,
34 int wl1271_cmd_general_parms(struct wl1271 *wl);
35 int wl128x_cmd_general_parms(struct wl1271 *wl);
36 int wl1271_cmd_radio_parms(struct wl1271 *wl);
37 int wl128x_cmd_radio_parms(struct wl1271 *wl);
38 int wl1271_cmd_ext_radio_parms(struct wl1271 *wl);
39 int wl12xx_cmd_role_enable(struct wl1271 *wl, u8 role_type, u8 *role_id);
40 int wl12xx_cmd_role_disable(struct wl1271 *wl, u8 *role_id);
41 int wl12xx_cmd_role_start_dev(struct wl1271 *wl);
42 int wl12xx_cmd_role_stop_dev(struct wl1271 *wl);
43 int wl12xx_cmd_role_start_sta(struct wl1271 *wl);
44 int wl12xx_cmd_role_stop_sta(struct wl1271 *wl);
45 int wl12xx_cmd_role_start_ap(struct wl1271 *wl);
46 int wl12xx_cmd_role_stop_ap(struct wl1271 *wl);
47 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
48 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len);
49 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
50 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
51 int wl1271_cmd_ps_mode(struct wl1271 *wl, u8 ps_mode);
52 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
54 int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id,
55 void *buf, size_t buf_len, int index, u32 rates);
56 int wl1271_cmd_build_null_data(struct wl1271 *wl);
57 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, u16 aid);
58 int wl1271_cmd_build_probe_req(struct wl1271 *wl,
59 const u8 *ssid, size_t ssid_len,
60 const u8 *ie, size_t ie_len, u8 band);
61 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
63 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, __be32 ip_addr);
64 int wl1271_build_qos_null_data(struct wl1271 *wl);
65 int wl1271_cmd_build_klv_null_data(struct wl1271 *wl);
66 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
67 int wl1271_cmd_set_sta_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
68 u8 key_size, const u8 *key, const u8 *addr,
69 u32 tx_seq_32, u16 tx_seq_16);
70 int wl1271_cmd_set_ap_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
71 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
73 int wl12xx_cmd_set_peer_state(struct wl1271 *wl);
74 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct ieee80211_sta *sta, u8 hlid);
75 int wl12xx_cmd_remove_peer(struct wl1271 *wl, u8 hlid);
76 int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
77 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
78 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
80 enum wl1271_commands {
81 CMD_INTERROGATE = 1, /*use this to read information elements*/
82 CMD_CONFIGURE = 2, /*use this to write information elements*/
91 CMD_WRITE_MEMORY = 14,
92 CMD_SET_TEMPLATE = 19,
95 CMD_QUIET_ELEMENT_SET_STATE = 29,
96 CMD_SET_BCN_MODE = 33,
98 CMD_STOP_MEASUREMENT = 35,
100 CMD_CHANNEL_SWITCH = 38,
101 CMD_STOP_CHANNEL_SWICTH = 39,
102 CMD_AP_DISCOVERY = 40,
103 CMD_STOP_AP_DISCOVERY = 41,
104 CMD_HEALTH_CHECK = 45,
106 CMD_TRIGGER_SCAN_TO = 47,
107 CMD_CONNECTION_SCAN_CFG = 48,
108 CMD_CONNECTION_SCAN_SSID_CFG = 49,
109 CMD_START_PERIODIC_SCAN = 50,
110 CMD_STOP_PERIODIC_SCAN = 51,
111 CMD_SET_PEER_STATE = 52,
112 CMD_REMAIN_ON_CHANNEL = 53,
113 CMD_CANCEL_REMAIN_ON_CHANNEL = 54,
115 CMD_CONFIG_FWLOGGER = 55,
116 CMD_START_FWLOGGER = 56,
117 CMD_STOP_FWLOGGER = 57,
121 CMD_REMOVE_PEER = 63,
124 CMD_ROLE_ENABLE = 70,
125 CMD_ROLE_DISABLE = 71,
130 CMD_WFD_START_DISCOVERY = 80,
131 CMD_WFD_STOP_DISCOVERY = 81,
132 CMD_WFD_ATTRIBUTE_CONFIG = 82,
137 MAX_COMMAND_ID = 0xFFFF,
140 #define MAX_CMD_PARAMS 572
143 CMD_TEMPL_KLV_IDX_NULL_DATA = 0,
144 CMD_TEMPL_KLV_IDX_MAX = 4
148 CMD_TEMPL_NULL_DATA = 0,
150 CMD_TEMPL_CFG_PROBE_REQ_2_4,
151 CMD_TEMPL_CFG_PROBE_REQ_5,
152 CMD_TEMPL_PROBE_RESPONSE,
153 CMD_TEMPL_QOS_NULL_DATA,
156 CMD_TEMPL_DISCONNECT,
157 CMD_TEMPL_PROBE_REQ_2_4, /* for firmware internal use only */
158 CMD_TEMPL_PROBE_REQ_5, /* for firmware internal use only */
159 CMD_TEMPL_BAR, /* for firmware internal use only */
161 * For CTS-to-self (FastCTS) mechanism
162 * for BT/WLAN coexistence (SoftGemini). */
164 CMD_TEMPL_AP_PROBE_RESPONSE,
168 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
174 #define WL1271_COMMAND_TIMEOUT 2000
175 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
176 #define WL1271_CMD_TEMPL_MAX_SIZE 548
177 #define WL1271_EVENT_TIMEOUT 750
179 struct wl1271_cmd_header {
186 #define WL1271_CMD_MAX_PARAMS 572
188 struct wl1271_command {
189 struct wl1271_cmd_header header;
190 u8 parameters[WL1271_CMD_MAX_PARAMS];
194 CMD_MAILBOX_IDLE = 0,
195 CMD_STATUS_SUCCESS = 1,
196 CMD_STATUS_UNKNOWN_CMD = 2,
197 CMD_STATUS_UNKNOWN_IE = 3,
198 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
199 CMD_STATUS_RX_BUSY = 13,
200 CMD_STATUS_INVALID_PARAM = 14,
201 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
202 CMD_STATUS_OUT_OF_MEMORY = 16,
203 CMD_STATUS_STA_TABLE_FULL = 17,
204 CMD_STATUS_RADIO_ERROR = 18,
205 CMD_STATUS_WRONG_NESTING = 19,
206 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
207 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
208 CMD_STATUS_TEMPLATE_OOM = 23,
209 MAX_COMMAND_STATUS = 0xff
212 #define CMDMBOX_HEADER_LEN 4
213 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
217 BSS_TYPE_STA_BSS = 2,
222 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
223 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
224 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
226 struct wl12xx_cmd_role_enable {
227 struct wl1271_cmd_header header;
231 u8 mac_address[ETH_ALEN];
234 struct wl12xx_cmd_role_disable {
235 struct wl1271_cmd_header header;
242 WL12XX_BAND_2_4GHZ = 0,
243 WL12XX_BAND_5GHZ = 1,
244 WL12XX_BAND_JAPAN_4_9_GHZ = 2,
245 WL12XX_BAND_DEFAULT = WL12XX_BAND_2_4GHZ,
246 WL12XX_BAND_INVALID = 0x7E,
247 WL12XX_BAND_MAX_RADIO = 0x7F,
250 struct wl12xx_cmd_role_start {
251 struct wl1271_cmd_header header;
264 /* sta & p2p_cli use the same struct */
267 u8 hlid; /* data hlid */
269 __le32 remote_rates; /* remote supported rates */
272 * The target uses this field to determine the rate at
273 * which to transmit control frame responses (such as
274 * ACK or CTS frames).
276 __le32 basic_rate_set;
277 __le32 local_rates; /* local supported rates */
281 u8 ssid[IEEE80211_MAX_SSID_LEN];
283 __le16 beacon_interval; /* in TBTTs */
287 u8 hlid; /* data hlid */
289 __le32 remote_rates; /* remote supported rates */
291 __le32 basic_rate_set;
292 __le32 local_rates; /* local supported rates */
296 u8 ssid[IEEE80211_MAX_SSID_LEN];
298 __le16 beacon_interval; /* in TBTTs */
302 /* ap & p2p_go use the same struct */
304 __le16 aging_period; /* in secs */
305 u8 beacon_expiry; /* in ms */
307 /* The host link id for the AP's global queue */
309 /* The host link id for the AP's broadcast queue */
312 __le16 beacon_interval; /* in TBTTs */
314 __le32 basic_rate_set;
315 __le32 local_rates; /* local supported rates */
321 u8 ssid[IEEE80211_MAX_SSID_LEN];
328 struct wl12xx_cmd_role_stop {
329 struct wl1271_cmd_header header;
332 u8 disc_type; /* only STA and P2P_CLI */
333 __le16 reason; /* only STA and P2P_CLI */
336 struct cmd_enabledisable_path {
337 struct wl1271_cmd_header header;
343 #define WL1271_RATE_AUTOMATIC 0
345 struct wl1271_cmd_template_set {
346 struct wl1271_cmd_header header;
350 u8 index; /* relevant only for KLV_TEMPLATE type */
351 __le32 enabled_rates;
352 u8 short_retry_limit;
356 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
360 #define PARTIAL_VBM_MAX 251
368 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
371 enum wl1271_cmd_ps_mode {
373 STATION_POWER_SAVE_MODE
376 struct wl1271_cmd_ps_params {
377 struct wl1271_cmd_header header;
380 u8 ps_mode; /* STATION_* */
384 /* HW encryption keys */
385 #define NUM_ACCESS_CATEGORIES_COPY 4
387 enum wl1271_cmd_key_action {
388 KEY_ADD_OR_REPLACE = 1,
391 MAX_KEY_ACTION = 0xffff,
394 enum wl1271_cmd_lid_key_type {
395 UNICAST_LID_TYPE = 0,
396 BROADCAST_LID_TYPE = 1,
397 WEP_DEFAULT_LID_TYPE = 2
400 enum wl1271_cmd_key_type {
408 struct wl1271_cmd_set_keys {
409 struct wl1271_cmd_header header;
412 * Indicates whether the HLID is a unicast key set
413 * or broadcast key set. A special value 0xFF is
414 * used to indicate that the HLID is on WEP-default
415 * (multi-hlids). of type wl1271_cmd_lid_key_type.
420 * In WEP-default network (hlid == 0xFF) used to
421 * indicate which network STA/IBSS/AP role should be
427 * Key ID - For TKIP and AES key types, this field
428 * indicates the value that should be inserted into
429 * the KeyID field of frames transmitted using this
430 * key entry. For broadcast keys the index use as a
431 * marker for TX/RX key.
432 * For WEP default network (HLID=0xFF), this field
433 * indicates the ID of the key to add or remove.
441 /* key size in bytes */
447 /* This field holds the security key data to add to the STA table */
448 u8 key[MAX_KEY_SIZE];
449 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
450 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
453 struct wl1271_cmd_test_header {
458 enum wl1271_channel_tune_bands {
459 WL1271_CHANNEL_TUNE_BAND_2_4,
460 WL1271_CHANNEL_TUNE_BAND_5,
461 WL1271_CHANNEL_TUNE_BAND_4_9
464 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
466 #define TEST_CMD_INI_FILE_RADIO_PARAM 0x19
467 #define TEST_CMD_INI_FILE_GENERAL_PARAM 0x1E
468 #define TEST_CMD_INI_FILE_RF_EXTENDED_PARAM 0x26
470 struct wl1271_general_parms_cmd {
471 struct wl1271_cmd_header header;
473 struct wl1271_cmd_test_header test;
475 struct wl1271_ini_general_params general_params;
477 u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
485 struct wl128x_general_parms_cmd {
486 struct wl1271_cmd_header header;
488 struct wl1271_cmd_test_header test;
490 struct wl128x_ini_general_params general_params;
492 u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
500 struct wl1271_radio_parms_cmd {
501 struct wl1271_cmd_header header;
503 struct wl1271_cmd_test_header test;
505 /* Static radio parameters */
506 struct wl1271_ini_band_params_2 static_params_2;
507 struct wl1271_ini_band_params_5 static_params_5;
509 /* Dynamic radio parameters */
510 struct wl1271_ini_fem_params_2 dyn_params_2;
512 struct wl1271_ini_fem_params_5 dyn_params_5;
516 struct wl128x_radio_parms_cmd {
517 struct wl1271_cmd_header header;
519 struct wl1271_cmd_test_header test;
521 /* Static radio parameters */
522 struct wl128x_ini_band_params_2 static_params_2;
523 struct wl128x_ini_band_params_5 static_params_5;
525 u8 fem_vendor_and_options;
527 /* Dynamic radio parameters */
528 struct wl128x_ini_fem_params_2 dyn_params_2;
530 struct wl128x_ini_fem_params_5 dyn_params_5;
533 struct wl1271_ext_radio_parms_cmd {
534 struct wl1271_cmd_header header;
536 struct wl1271_cmd_test_header test;
538 u8 tx_per_channel_power_compensation_2[CONF_TX_PWR_COMPENSATION_LEN_2];
539 u8 tx_per_channel_power_compensation_5[CONF_TX_PWR_COMPENSATION_LEN_5];
544 * There are three types of disconnections:
546 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
547 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
549 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
552 enum wl1271_disconnect_type {
553 DISCONNECT_IMMEDIATE,
558 #define WL1271_CMD_STA_STATE_CONNECTED 1
560 struct wl12xx_cmd_set_peer_state {
561 struct wl1271_cmd_header header;
568 enum wl12xx_ssid_type {
569 WL12XX_SSID_TYPE_PUBLIC = 0,
570 WL12XX_SSID_TYPE_HIDDEN = 1,
571 WL12XX_SSID_TYPE_ANY = 2,
574 struct wl12xx_cmd_add_peer {
575 struct wl1271_cmd_header header;
580 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
581 __le32 supported_rates;
588 struct wl12xx_cmd_remove_peer {
589 struct wl1271_cmd_header header;
598 * Continuous mode - packets are transferred to the host periodically
600 * On demand - Log messages are stored in a cyclic buffer in the
601 * firmware, and only transferred to the host when explicitly requested
603 enum wl12xx_fwlogger_log_mode {
604 WL12XX_FWLOG_CONTINUOUS,
605 WL12XX_FWLOG_ON_DEMAND
608 /* Include/exclude timestamps from the log messages */
609 enum wl12xx_fwlogger_timestamp {
610 WL12XX_FWLOG_TIMESTAMP_DISABLED,
611 WL12XX_FWLOG_TIMESTAMP_ENABLED
615 * Logs can be routed to the debug pinouts (where available), to the host bus
616 * (SDIO/SPI), or dropped
618 enum wl12xx_fwlogger_output {
619 WL12XX_FWLOG_OUTPUT_NONE,
620 WL12XX_FWLOG_OUTPUT_DBG_PINS,
621 WL12XX_FWLOG_OUTPUT_HOST,
624 struct wl12xx_cmd_config_fwlog {
625 struct wl1271_cmd_header header;
627 /* See enum wl12xx_fwlogger_log_mode */
630 /* Minimum log level threshold */
633 /* Include/exclude timestamps from the log messages */
636 /* See enum wl1271_fwlogger_output */
639 /* Regulates the frequency of log messages */
645 struct wl12xx_cmd_start_fwlog {
646 struct wl1271_cmd_header header;
649 struct wl12xx_cmd_stop_fwlog {
650 struct wl1271_cmd_header header;
653 #endif /* __WL1271_CMD_H__ */