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 *addr, u8 role_type,
41 int wl12xx_cmd_role_disable(struct wl1271 *wl, u8 *role_id);
42 int wl12xx_cmd_role_start_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
43 int wl12xx_cmd_role_stop_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
44 int wl12xx_cmd_role_start_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
45 int wl12xx_cmd_role_stop_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
46 int wl12xx_cmd_role_start_ibss(struct wl1271 *wl, struct wl12xx_vif *wlvif);
47 int wl12xx_start_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif);
48 int wl12xx_stop_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif);
49 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
50 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len);
51 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
52 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
53 int wl1271_cmd_ps_mode(struct wl1271 *wl, struct wl12xx_vif *wlvif,
55 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
57 int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id,
58 void *buf, size_t buf_len, int index, u32 rates);
59 int wl12xx_cmd_build_null_data(struct wl1271 *wl, struct wl12xx_vif *wlvif);
60 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, struct wl12xx_vif *wlvif,
62 int wl1271_cmd_build_probe_req(struct wl1271 *wl, struct wl12xx_vif *wlvif,
63 const u8 *ssid, size_t ssid_len,
64 const u8 *ie, size_t ie_len, u8 band);
65 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
66 struct wl12xx_vif *wlvif,
68 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, struct wl12xx_vif *wlvif,
70 int wl1271_build_qos_null_data(struct wl1271 *wl, struct ieee80211_vif *vif);
71 int wl12xx_cmd_build_klv_null_data(struct wl1271 *wl,
72 struct wl12xx_vif *wlvif);
73 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
74 int wl1271_cmd_set_sta_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
75 u16 action, u8 id, u8 key_type,
76 u8 key_size, const u8 *key, const u8 *addr,
77 u32 tx_seq_32, u16 tx_seq_16);
78 int wl1271_cmd_set_ap_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
79 u16 action, u8 id, u8 key_type,
80 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
82 int wl12xx_cmd_set_peer_state(struct wl1271 *wl, u8 hlid);
83 int wl12xx_roc(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 role_id);
84 int wl12xx_croc(struct wl1271 *wl, u8 role_id);
85 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
86 struct ieee80211_sta *sta, u8 hlid);
87 int wl12xx_cmd_remove_peer(struct wl1271 *wl, u8 hlid);
88 int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
89 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
90 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
91 int wl12xx_cmd_channel_switch(struct wl1271 *wl,
92 struct ieee80211_channel_switch *ch_switch);
93 int wl12xx_cmd_stop_channel_switch(struct wl1271 *wl);
94 int wl12xx_allocate_link(struct wl1271 *wl, struct wl12xx_vif *wlvif,
96 void wl12xx_free_link(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 *hlid);
98 enum wl1271_commands {
99 CMD_INTERROGATE = 1, /*use this to read information elements*/
100 CMD_CONFIGURE = 2, /*use this to write information elements*/
108 CMD_READ_MEMORY = 13,
109 CMD_WRITE_MEMORY = 14,
110 CMD_SET_TEMPLATE = 19,
113 CMD_QUIET_ELEMENT_SET_STATE = 29,
114 CMD_SET_BCN_MODE = 33,
115 CMD_MEASUREMENT = 34,
116 CMD_STOP_MEASUREMENT = 35,
117 CMD_SET_PS_MODE = 37,
118 CMD_CHANNEL_SWITCH = 38,
119 CMD_STOP_CHANNEL_SWICTH = 39,
120 CMD_AP_DISCOVERY = 40,
121 CMD_STOP_AP_DISCOVERY = 41,
122 CMD_HEALTH_CHECK = 45,
124 CMD_TRIGGER_SCAN_TO = 47,
125 CMD_CONNECTION_SCAN_CFG = 48,
126 CMD_CONNECTION_SCAN_SSID_CFG = 49,
127 CMD_START_PERIODIC_SCAN = 50,
128 CMD_STOP_PERIODIC_SCAN = 51,
129 CMD_SET_PEER_STATE = 52,
130 CMD_REMAIN_ON_CHANNEL = 53,
131 CMD_CANCEL_REMAIN_ON_CHANNEL = 54,
133 CMD_CONFIG_FWLOGGER = 55,
134 CMD_START_FWLOGGER = 56,
135 CMD_STOP_FWLOGGER = 57,
139 CMD_REMOVE_PEER = 63,
142 CMD_ROLE_ENABLE = 70,
143 CMD_ROLE_DISABLE = 71,
148 CMD_WFD_START_DISCOVERY = 80,
149 CMD_WFD_STOP_DISCOVERY = 81,
150 CMD_WFD_ATTRIBUTE_CONFIG = 82,
155 MAX_COMMAND_ID = 0xFFFF,
158 #define MAX_CMD_PARAMS 572
161 CMD_TEMPL_KLV_IDX_NULL_DATA = 0,
162 CMD_TEMPL_KLV_IDX_MAX = 4
166 CMD_TEMPL_NULL_DATA = 0,
168 CMD_TEMPL_CFG_PROBE_REQ_2_4,
169 CMD_TEMPL_CFG_PROBE_REQ_5,
170 CMD_TEMPL_PROBE_RESPONSE,
171 CMD_TEMPL_QOS_NULL_DATA,
174 CMD_TEMPL_DISCONNECT,
175 CMD_TEMPL_PROBE_REQ_2_4, /* for firmware internal use only */
176 CMD_TEMPL_PROBE_REQ_5, /* for firmware internal use only */
177 CMD_TEMPL_BAR, /* for firmware internal use only */
179 * For CTS-to-self (FastCTS) mechanism
180 * for BT/WLAN coexistence (SoftGemini). */
182 CMD_TEMPL_AP_PROBE_RESPONSE,
186 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
192 #define WL1271_COMMAND_TIMEOUT 2000
193 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
194 #define WL1271_CMD_TEMPL_MAX_SIZE 548
195 #define WL1271_EVENT_TIMEOUT 750
197 struct wl1271_cmd_header {
204 #define WL1271_CMD_MAX_PARAMS 572
206 struct wl1271_command {
207 struct wl1271_cmd_header header;
208 u8 parameters[WL1271_CMD_MAX_PARAMS];
212 CMD_MAILBOX_IDLE = 0,
213 CMD_STATUS_SUCCESS = 1,
214 CMD_STATUS_UNKNOWN_CMD = 2,
215 CMD_STATUS_UNKNOWN_IE = 3,
216 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
217 CMD_STATUS_RX_BUSY = 13,
218 CMD_STATUS_INVALID_PARAM = 14,
219 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
220 CMD_STATUS_OUT_OF_MEMORY = 16,
221 CMD_STATUS_STA_TABLE_FULL = 17,
222 CMD_STATUS_RADIO_ERROR = 18,
223 CMD_STATUS_WRONG_NESTING = 19,
224 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
225 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
226 CMD_STATUS_TEMPLATE_OOM = 23,
227 CMD_STATUS_NO_RX_BA_SESSION = 24,
228 MAX_COMMAND_STATUS = 0xff
231 #define CMDMBOX_HEADER_LEN 4
232 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
236 BSS_TYPE_STA_BSS = 2,
241 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
242 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
243 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
245 struct wl12xx_cmd_role_enable {
246 struct wl1271_cmd_header header;
250 u8 mac_address[ETH_ALEN];
253 struct wl12xx_cmd_role_disable {
254 struct wl1271_cmd_header header;
261 WL12XX_BAND_2_4GHZ = 0,
262 WL12XX_BAND_5GHZ = 1,
263 WL12XX_BAND_JAPAN_4_9_GHZ = 2,
264 WL12XX_BAND_DEFAULT = WL12XX_BAND_2_4GHZ,
265 WL12XX_BAND_INVALID = 0x7E,
266 WL12XX_BAND_MAX_RADIO = 0x7F,
269 struct wl12xx_cmd_role_start {
270 struct wl1271_cmd_header header;
283 /* sta & p2p_cli use the same struct */
286 u8 hlid; /* data hlid */
288 __le32 remote_rates; /* remote supported rates */
291 * The target uses this field to determine the rate at
292 * which to transmit control frame responses (such as
293 * ACK or CTS frames).
295 __le32 basic_rate_set;
296 __le32 local_rates; /* local supported rates */
300 u8 ssid[IEEE80211_MAX_SSID_LEN];
302 __le16 beacon_interval; /* in TBTTs */
306 u8 hlid; /* data hlid */
308 __le32 remote_rates; /* remote supported rates */
310 __le32 basic_rate_set;
311 __le32 local_rates; /* local supported rates */
315 u8 ssid[IEEE80211_MAX_SSID_LEN];
317 __le16 beacon_interval; /* in TBTTs */
321 /* ap & p2p_go use the same struct */
323 __le16 aging_period; /* in secs */
324 u8 beacon_expiry; /* in ms */
326 /* The host link id for the AP's global queue */
328 /* The host link id for the AP's broadcast queue */
331 __le16 beacon_interval; /* in TBTTs */
333 __le32 basic_rate_set;
334 __le32 local_rates; /* local supported rates */
340 u8 ssid[IEEE80211_MAX_SSID_LEN];
347 struct wl12xx_cmd_role_stop {
348 struct wl1271_cmd_header header;
351 u8 disc_type; /* only STA and P2P_CLI */
352 __le16 reason; /* only STA and P2P_CLI */
355 struct cmd_enabledisable_path {
356 struct wl1271_cmd_header header;
362 #define WL1271_RATE_AUTOMATIC 0
364 struct wl1271_cmd_template_set {
365 struct wl1271_cmd_header header;
369 u8 index; /* relevant only for KLV_TEMPLATE type */
370 __le32 enabled_rates;
371 u8 short_retry_limit;
375 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
379 #define PARTIAL_VBM_MAX 251
387 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
390 enum wl1271_cmd_ps_mode {
392 STATION_POWER_SAVE_MODE
395 struct wl1271_cmd_ps_params {
396 struct wl1271_cmd_header header;
399 u8 ps_mode; /* STATION_* */
403 /* HW encryption keys */
404 #define NUM_ACCESS_CATEGORIES_COPY 4
406 enum wl1271_cmd_key_action {
407 KEY_ADD_OR_REPLACE = 1,
410 MAX_KEY_ACTION = 0xffff,
413 enum wl1271_cmd_lid_key_type {
414 UNICAST_LID_TYPE = 0,
415 BROADCAST_LID_TYPE = 1,
416 WEP_DEFAULT_LID_TYPE = 2
419 enum wl1271_cmd_key_type {
427 struct wl1271_cmd_set_keys {
428 struct wl1271_cmd_header header;
431 * Indicates whether the HLID is a unicast key set
432 * or broadcast key set. A special value 0xFF is
433 * used to indicate that the HLID is on WEP-default
434 * (multi-hlids). of type wl1271_cmd_lid_key_type.
439 * In WEP-default network (hlid == 0xFF) used to
440 * indicate which network STA/IBSS/AP role should be
446 * Key ID - For TKIP and AES key types, this field
447 * indicates the value that should be inserted into
448 * the KeyID field of frames transmitted using this
449 * key entry. For broadcast keys the index use as a
450 * marker for TX/RX key.
451 * For WEP default network (HLID=0xFF), this field
452 * indicates the ID of the key to add or remove.
460 /* key size in bytes */
466 /* This field holds the security key data to add to the STA table */
467 u8 key[MAX_KEY_SIZE];
468 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
469 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
472 struct wl1271_cmd_test_header {
477 enum wl1271_channel_tune_bands {
478 WL1271_CHANNEL_TUNE_BAND_2_4,
479 WL1271_CHANNEL_TUNE_BAND_5,
480 WL1271_CHANNEL_TUNE_BAND_4_9
483 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
485 #define TEST_CMD_INI_FILE_RADIO_PARAM 0x19
486 #define TEST_CMD_INI_FILE_GENERAL_PARAM 0x1E
487 #define TEST_CMD_INI_FILE_RF_EXTENDED_PARAM 0x26
489 struct wl1271_general_parms_cmd {
490 struct wl1271_cmd_header header;
492 struct wl1271_cmd_test_header test;
494 struct wl1271_ini_general_params general_params;
496 u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
504 struct wl128x_general_parms_cmd {
505 struct wl1271_cmd_header header;
507 struct wl1271_cmd_test_header test;
509 struct wl128x_ini_general_params general_params;
511 u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
519 struct wl1271_radio_parms_cmd {
520 struct wl1271_cmd_header header;
522 struct wl1271_cmd_test_header test;
524 /* Static radio parameters */
525 struct wl1271_ini_band_params_2 static_params_2;
526 struct wl1271_ini_band_params_5 static_params_5;
528 /* Dynamic radio parameters */
529 struct wl1271_ini_fem_params_2 dyn_params_2;
531 struct wl1271_ini_fem_params_5 dyn_params_5;
535 struct wl128x_radio_parms_cmd {
536 struct wl1271_cmd_header header;
538 struct wl1271_cmd_test_header test;
540 /* Static radio parameters */
541 struct wl128x_ini_band_params_2 static_params_2;
542 struct wl128x_ini_band_params_5 static_params_5;
544 u8 fem_vendor_and_options;
546 /* Dynamic radio parameters */
547 struct wl128x_ini_fem_params_2 dyn_params_2;
549 struct wl128x_ini_fem_params_5 dyn_params_5;
552 struct wl1271_ext_radio_parms_cmd {
553 struct wl1271_cmd_header header;
555 struct wl1271_cmd_test_header test;
557 u8 tx_per_channel_power_compensation_2[CONF_TX_PWR_COMPENSATION_LEN_2];
558 u8 tx_per_channel_power_compensation_5[CONF_TX_PWR_COMPENSATION_LEN_5];
563 * There are three types of disconnections:
565 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
566 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
568 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
571 enum wl1271_disconnect_type {
572 DISCONNECT_IMMEDIATE,
577 #define WL1271_CMD_STA_STATE_CONNECTED 1
579 struct wl12xx_cmd_set_peer_state {
580 struct wl1271_cmd_header header;
587 struct wl12xx_cmd_roc {
588 struct wl1271_cmd_header header;
596 struct wl12xx_cmd_croc {
597 struct wl1271_cmd_header header;
603 enum wl12xx_ssid_type {
604 WL12XX_SSID_TYPE_PUBLIC = 0,
605 WL12XX_SSID_TYPE_HIDDEN = 1,
606 WL12XX_SSID_TYPE_ANY = 2,
609 enum wl1271_psd_type {
610 WL1271_PSD_LEGACY = 0,
611 WL1271_PSD_UPSD_TRIGGER = 1,
612 WL1271_PSD_LEGACY_PSPOLL = 2,
616 struct wl12xx_cmd_add_peer {
617 struct wl1271_cmd_header header;
622 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
623 __le32 supported_rates;
630 struct wl12xx_cmd_remove_peer {
631 struct wl1271_cmd_header header;
640 * Continuous mode - packets are transferred to the host periodically
642 * On demand - Log messages are stored in a cyclic buffer in the
643 * firmware, and only transferred to the host when explicitly requested
645 enum wl12xx_fwlogger_log_mode {
646 WL12XX_FWLOG_CONTINUOUS,
647 WL12XX_FWLOG_ON_DEMAND
650 /* Include/exclude timestamps from the log messages */
651 enum wl12xx_fwlogger_timestamp {
652 WL12XX_FWLOG_TIMESTAMP_DISABLED,
653 WL12XX_FWLOG_TIMESTAMP_ENABLED
657 * Logs can be routed to the debug pinouts (where available), to the host bus
658 * (SDIO/SPI), or dropped
660 enum wl12xx_fwlogger_output {
661 WL12XX_FWLOG_OUTPUT_NONE,
662 WL12XX_FWLOG_OUTPUT_DBG_PINS,
663 WL12XX_FWLOG_OUTPUT_HOST,
666 struct wl12xx_cmd_config_fwlog {
667 struct wl1271_cmd_header header;
669 /* See enum wl12xx_fwlogger_log_mode */
672 /* Minimum log level threshold */
675 /* Include/exclude timestamps from the log messages */
678 /* See enum wl1271_fwlogger_output */
681 /* Regulates the frequency of log messages */
687 struct wl12xx_cmd_start_fwlog {
688 struct wl1271_cmd_header header;
691 struct wl12xx_cmd_stop_fwlog {
692 struct wl1271_cmd_header header;
695 struct wl12xx_cmd_channel_switch {
696 struct wl1271_cmd_header header;
698 /* The new serving channel */
700 /* Relative time of the serving channel switch in TBTT units */
702 /* 1: Suspend TX till switch time; 0: Do not suspend TX */
704 /* 1: Flush TX at switch time; 0: Do not flush */
708 struct wl12xx_cmd_stop_channel_switch {
709 struct wl1271_cmd_header header;
712 #endif /* __WL1271_CMD_H__ */