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 wl12xx_cmd_role_start_ibss(struct wl1271 *wl);
48 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
49 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len);
50 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
51 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
52 int wl1271_cmd_ps_mode(struct wl1271 *wl, u8 ps_mode);
53 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
55 int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id,
56 void *buf, size_t buf_len, int index, u32 rates);
57 int wl1271_cmd_build_null_data(struct wl1271 *wl);
58 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, u16 aid);
59 int wl1271_cmd_build_probe_req(struct wl1271 *wl,
60 const u8 *ssid, size_t ssid_len,
61 const u8 *ie, size_t ie_len, u8 band);
62 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
64 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, __be32 ip_addr);
65 int wl1271_build_qos_null_data(struct wl1271 *wl);
66 int wl1271_cmd_build_klv_null_data(struct wl1271 *wl);
67 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
68 int wl1271_cmd_set_sta_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
69 u8 key_size, const u8 *key, const u8 *addr,
70 u32 tx_seq_32, u16 tx_seq_16);
71 int wl1271_cmd_set_ap_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
72 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
74 int wl12xx_cmd_set_peer_state(struct wl1271 *wl, u8 hlid);
75 int wl12xx_roc(struct wl1271 *wl, u8 role_id);
76 int wl12xx_croc(struct wl1271 *wl, u8 role_id);
77 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct ieee80211_sta *sta, u8 hlid);
78 int wl12xx_cmd_remove_peer(struct wl1271 *wl, u8 hlid);
79 int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
80 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
81 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
82 int wl12xx_cmd_channel_switch(struct wl1271 *wl,
83 struct ieee80211_channel_switch *ch_switch);
84 int wl12xx_cmd_stop_channel_switch(struct wl1271 *wl);
86 enum wl1271_commands {
87 CMD_INTERROGATE = 1, /*use this to read information elements*/
88 CMD_CONFIGURE = 2, /*use this to write information elements*/
97 CMD_WRITE_MEMORY = 14,
98 CMD_SET_TEMPLATE = 19,
101 CMD_QUIET_ELEMENT_SET_STATE = 29,
102 CMD_SET_BCN_MODE = 33,
103 CMD_MEASUREMENT = 34,
104 CMD_STOP_MEASUREMENT = 35,
105 CMD_SET_PS_MODE = 37,
106 CMD_CHANNEL_SWITCH = 38,
107 CMD_STOP_CHANNEL_SWICTH = 39,
108 CMD_AP_DISCOVERY = 40,
109 CMD_STOP_AP_DISCOVERY = 41,
110 CMD_HEALTH_CHECK = 45,
112 CMD_TRIGGER_SCAN_TO = 47,
113 CMD_CONNECTION_SCAN_CFG = 48,
114 CMD_CONNECTION_SCAN_SSID_CFG = 49,
115 CMD_START_PERIODIC_SCAN = 50,
116 CMD_STOP_PERIODIC_SCAN = 51,
117 CMD_SET_PEER_STATE = 52,
118 CMD_REMAIN_ON_CHANNEL = 53,
119 CMD_CANCEL_REMAIN_ON_CHANNEL = 54,
121 CMD_CONFIG_FWLOGGER = 55,
122 CMD_START_FWLOGGER = 56,
123 CMD_STOP_FWLOGGER = 57,
127 CMD_REMOVE_PEER = 63,
130 CMD_ROLE_ENABLE = 70,
131 CMD_ROLE_DISABLE = 71,
136 CMD_WFD_START_DISCOVERY = 80,
137 CMD_WFD_STOP_DISCOVERY = 81,
138 CMD_WFD_ATTRIBUTE_CONFIG = 82,
143 MAX_COMMAND_ID = 0xFFFF,
146 #define MAX_CMD_PARAMS 572
149 CMD_TEMPL_KLV_IDX_NULL_DATA = 0,
150 CMD_TEMPL_KLV_IDX_MAX = 4
154 CMD_TEMPL_NULL_DATA = 0,
156 CMD_TEMPL_CFG_PROBE_REQ_2_4,
157 CMD_TEMPL_CFG_PROBE_REQ_5,
158 CMD_TEMPL_PROBE_RESPONSE,
159 CMD_TEMPL_QOS_NULL_DATA,
162 CMD_TEMPL_DISCONNECT,
163 CMD_TEMPL_PROBE_REQ_2_4, /* for firmware internal use only */
164 CMD_TEMPL_PROBE_REQ_5, /* for firmware internal use only */
165 CMD_TEMPL_BAR, /* for firmware internal use only */
167 * For CTS-to-self (FastCTS) mechanism
168 * for BT/WLAN coexistence (SoftGemini). */
170 CMD_TEMPL_AP_PROBE_RESPONSE,
174 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
180 #define WL1271_COMMAND_TIMEOUT 2000
181 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
182 #define WL1271_CMD_TEMPL_MAX_SIZE 548
183 #define WL1271_EVENT_TIMEOUT 750
185 struct wl1271_cmd_header {
192 #define WL1271_CMD_MAX_PARAMS 572
194 struct wl1271_command {
195 struct wl1271_cmd_header header;
196 u8 parameters[WL1271_CMD_MAX_PARAMS];
200 CMD_MAILBOX_IDLE = 0,
201 CMD_STATUS_SUCCESS = 1,
202 CMD_STATUS_UNKNOWN_CMD = 2,
203 CMD_STATUS_UNKNOWN_IE = 3,
204 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
205 CMD_STATUS_RX_BUSY = 13,
206 CMD_STATUS_INVALID_PARAM = 14,
207 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
208 CMD_STATUS_OUT_OF_MEMORY = 16,
209 CMD_STATUS_STA_TABLE_FULL = 17,
210 CMD_STATUS_RADIO_ERROR = 18,
211 CMD_STATUS_WRONG_NESTING = 19,
212 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
213 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
214 CMD_STATUS_TEMPLATE_OOM = 23,
215 CMD_STATUS_NO_RX_BA_SESSION = 24,
216 MAX_COMMAND_STATUS = 0xff
219 #define CMDMBOX_HEADER_LEN 4
220 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
224 BSS_TYPE_STA_BSS = 2,
229 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
230 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
231 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
233 struct wl12xx_cmd_role_enable {
234 struct wl1271_cmd_header header;
238 u8 mac_address[ETH_ALEN];
241 struct wl12xx_cmd_role_disable {
242 struct wl1271_cmd_header header;
249 WL12XX_BAND_2_4GHZ = 0,
250 WL12XX_BAND_5GHZ = 1,
251 WL12XX_BAND_JAPAN_4_9_GHZ = 2,
252 WL12XX_BAND_DEFAULT = WL12XX_BAND_2_4GHZ,
253 WL12XX_BAND_INVALID = 0x7E,
254 WL12XX_BAND_MAX_RADIO = 0x7F,
257 struct wl12xx_cmd_role_start {
258 struct wl1271_cmd_header header;
271 /* sta & p2p_cli use the same struct */
274 u8 hlid; /* data hlid */
276 __le32 remote_rates; /* remote supported rates */
279 * The target uses this field to determine the rate at
280 * which to transmit control frame responses (such as
281 * ACK or CTS frames).
283 __le32 basic_rate_set;
284 __le32 local_rates; /* local supported rates */
288 u8 ssid[IEEE80211_MAX_SSID_LEN];
290 __le16 beacon_interval; /* in TBTTs */
294 u8 hlid; /* data hlid */
296 __le32 remote_rates; /* remote supported rates */
298 __le32 basic_rate_set;
299 __le32 local_rates; /* local supported rates */
303 u8 ssid[IEEE80211_MAX_SSID_LEN];
305 __le16 beacon_interval; /* in TBTTs */
309 /* ap & p2p_go use the same struct */
311 __le16 aging_period; /* in secs */
312 u8 beacon_expiry; /* in ms */
314 /* The host link id for the AP's global queue */
316 /* The host link id for the AP's broadcast queue */
319 __le16 beacon_interval; /* in TBTTs */
321 __le32 basic_rate_set;
322 __le32 local_rates; /* local supported rates */
328 u8 ssid[IEEE80211_MAX_SSID_LEN];
335 struct wl12xx_cmd_role_stop {
336 struct wl1271_cmd_header header;
339 u8 disc_type; /* only STA and P2P_CLI */
340 __le16 reason; /* only STA and P2P_CLI */
343 struct cmd_enabledisable_path {
344 struct wl1271_cmd_header header;
350 #define WL1271_RATE_AUTOMATIC 0
352 struct wl1271_cmd_template_set {
353 struct wl1271_cmd_header header;
357 u8 index; /* relevant only for KLV_TEMPLATE type */
358 __le32 enabled_rates;
359 u8 short_retry_limit;
363 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
367 #define PARTIAL_VBM_MAX 251
375 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
378 enum wl1271_cmd_ps_mode {
380 STATION_POWER_SAVE_MODE
383 struct wl1271_cmd_ps_params {
384 struct wl1271_cmd_header header;
387 u8 ps_mode; /* STATION_* */
391 /* HW encryption keys */
392 #define NUM_ACCESS_CATEGORIES_COPY 4
394 enum wl1271_cmd_key_action {
395 KEY_ADD_OR_REPLACE = 1,
398 MAX_KEY_ACTION = 0xffff,
401 enum wl1271_cmd_lid_key_type {
402 UNICAST_LID_TYPE = 0,
403 BROADCAST_LID_TYPE = 1,
404 WEP_DEFAULT_LID_TYPE = 2
407 enum wl1271_cmd_key_type {
415 struct wl1271_cmd_set_keys {
416 struct wl1271_cmd_header header;
419 * Indicates whether the HLID is a unicast key set
420 * or broadcast key set. A special value 0xFF is
421 * used to indicate that the HLID is on WEP-default
422 * (multi-hlids). of type wl1271_cmd_lid_key_type.
427 * In WEP-default network (hlid == 0xFF) used to
428 * indicate which network STA/IBSS/AP role should be
434 * Key ID - For TKIP and AES key types, this field
435 * indicates the value that should be inserted into
436 * the KeyID field of frames transmitted using this
437 * key entry. For broadcast keys the index use as a
438 * marker for TX/RX key.
439 * For WEP default network (HLID=0xFF), this field
440 * indicates the ID of the key to add or remove.
448 /* key size in bytes */
454 /* This field holds the security key data to add to the STA table */
455 u8 key[MAX_KEY_SIZE];
456 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
457 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
460 struct wl1271_cmd_test_header {
465 enum wl1271_channel_tune_bands {
466 WL1271_CHANNEL_TUNE_BAND_2_4,
467 WL1271_CHANNEL_TUNE_BAND_5,
468 WL1271_CHANNEL_TUNE_BAND_4_9
471 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
473 #define TEST_CMD_INI_FILE_RADIO_PARAM 0x19
474 #define TEST_CMD_INI_FILE_GENERAL_PARAM 0x1E
475 #define TEST_CMD_INI_FILE_RF_EXTENDED_PARAM 0x26
477 struct wl1271_general_parms_cmd {
478 struct wl1271_cmd_header header;
480 struct wl1271_cmd_test_header test;
482 struct wl1271_ini_general_params general_params;
484 u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
492 struct wl128x_general_parms_cmd {
493 struct wl1271_cmd_header header;
495 struct wl1271_cmd_test_header test;
497 struct wl128x_ini_general_params general_params;
499 u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
507 struct wl1271_radio_parms_cmd {
508 struct wl1271_cmd_header header;
510 struct wl1271_cmd_test_header test;
512 /* Static radio parameters */
513 struct wl1271_ini_band_params_2 static_params_2;
514 struct wl1271_ini_band_params_5 static_params_5;
516 /* Dynamic radio parameters */
517 struct wl1271_ini_fem_params_2 dyn_params_2;
519 struct wl1271_ini_fem_params_5 dyn_params_5;
523 struct wl128x_radio_parms_cmd {
524 struct wl1271_cmd_header header;
526 struct wl1271_cmd_test_header test;
528 /* Static radio parameters */
529 struct wl128x_ini_band_params_2 static_params_2;
530 struct wl128x_ini_band_params_5 static_params_5;
532 u8 fem_vendor_and_options;
534 /* Dynamic radio parameters */
535 struct wl128x_ini_fem_params_2 dyn_params_2;
537 struct wl128x_ini_fem_params_5 dyn_params_5;
540 struct wl1271_ext_radio_parms_cmd {
541 struct wl1271_cmd_header header;
543 struct wl1271_cmd_test_header test;
545 u8 tx_per_channel_power_compensation_2[CONF_TX_PWR_COMPENSATION_LEN_2];
546 u8 tx_per_channel_power_compensation_5[CONF_TX_PWR_COMPENSATION_LEN_5];
551 * There are three types of disconnections:
553 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
554 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
556 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
559 enum wl1271_disconnect_type {
560 DISCONNECT_IMMEDIATE,
565 #define WL1271_CMD_STA_STATE_CONNECTED 1
567 struct wl12xx_cmd_set_peer_state {
568 struct wl1271_cmd_header header;
575 struct wl12xx_cmd_roc {
576 struct wl1271_cmd_header header;
584 struct wl12xx_cmd_croc {
585 struct wl1271_cmd_header header;
591 enum wl12xx_ssid_type {
592 WL12XX_SSID_TYPE_PUBLIC = 0,
593 WL12XX_SSID_TYPE_HIDDEN = 1,
594 WL12XX_SSID_TYPE_ANY = 2,
597 enum wl1271_psd_type {
598 WL1271_PSD_LEGACY = 0,
599 WL1271_PSD_UPSD_TRIGGER = 1,
600 WL1271_PSD_LEGACY_PSPOLL = 2,
604 struct wl12xx_cmd_add_peer {
605 struct wl1271_cmd_header header;
610 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
611 __le32 supported_rates;
618 struct wl12xx_cmd_remove_peer {
619 struct wl1271_cmd_header header;
628 * Continuous mode - packets are transferred to the host periodically
630 * On demand - Log messages are stored in a cyclic buffer in the
631 * firmware, and only transferred to the host when explicitly requested
633 enum wl12xx_fwlogger_log_mode {
634 WL12XX_FWLOG_CONTINUOUS,
635 WL12XX_FWLOG_ON_DEMAND
638 /* Include/exclude timestamps from the log messages */
639 enum wl12xx_fwlogger_timestamp {
640 WL12XX_FWLOG_TIMESTAMP_DISABLED,
641 WL12XX_FWLOG_TIMESTAMP_ENABLED
645 * Logs can be routed to the debug pinouts (where available), to the host bus
646 * (SDIO/SPI), or dropped
648 enum wl12xx_fwlogger_output {
649 WL12XX_FWLOG_OUTPUT_NONE,
650 WL12XX_FWLOG_OUTPUT_DBG_PINS,
651 WL12XX_FWLOG_OUTPUT_HOST,
654 struct wl12xx_cmd_config_fwlog {
655 struct wl1271_cmd_header header;
657 /* See enum wl12xx_fwlogger_log_mode */
660 /* Minimum log level threshold */
663 /* Include/exclude timestamps from the log messages */
666 /* See enum wl1271_fwlogger_output */
669 /* Regulates the frequency of log messages */
675 struct wl12xx_cmd_start_fwlog {
676 struct wl1271_cmd_header header;
679 struct wl12xx_cmd_stop_fwlog {
680 struct wl1271_cmd_header header;
683 struct wl12xx_cmd_channel_switch {
684 struct wl1271_cmd_header header;
686 /* The new serving channel */
688 /* Relative time of the serving channel switch in TBTT units */
690 /* 1: Suspend TX till switch time; 0: Do not suspend TX */
692 /* 1: Flush TX at switch time; 0: Do not flush */
696 struct wl12xx_cmd_stop_channel_switch {
697 struct wl1271_cmd_header header;
700 #endif /* __WL1271_CMD_H__ */