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 wlcore_cmd_send_failsafe(struct wl1271 *wl, u16 id, void *buf, size_t len,
35 size_t res_len, unsigned long valid_rets);
36 int wl12xx_cmd_role_enable(struct wl1271 *wl, u8 *addr, u8 role_type,
38 int wl12xx_cmd_role_disable(struct wl1271 *wl, u8 *role_id);
39 int wl12xx_cmd_role_start_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
40 int wl12xx_cmd_role_stop_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
41 int wl12xx_cmd_role_start_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
42 int wl12xx_cmd_role_stop_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
43 int wl12xx_cmd_role_start_ibss(struct wl1271 *wl, struct wl12xx_vif *wlvif);
44 int wl12xx_start_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif,
45 enum ieee80211_band band, int channel);
46 int wl12xx_stop_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif);
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,
49 size_t cmd_len, size_t res_len);
50 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
51 int wlcore_cmd_configure_failsafe(struct wl1271 *wl, u16 id, void *buf,
52 size_t len, unsigned long valid_rets);
53 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
54 int wl1271_cmd_ps_mode(struct wl1271 *wl, struct wl12xx_vif *wlvif,
55 u8 ps_mode, u16 auto_ps_timeout);
56 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
58 int wl1271_cmd_template_set(struct wl1271 *wl, u8 role_id,
59 u16 template_id, void *buf, size_t buf_len,
60 int index, u32 rates);
61 int wl12xx_cmd_build_null_data(struct wl1271 *wl, struct wl12xx_vif *wlvif);
62 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, struct wl12xx_vif *wlvif,
64 int wl12xx_cmd_build_probe_req(struct wl1271 *wl, struct wl12xx_vif *wlvif,
66 const u8 *ssid, size_t ssid_len,
67 const u8 *ie, size_t ie_len, const u8 *common_ie,
68 size_t common_ie_len, bool sched_scan);
69 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
70 struct wl12xx_vif *wlvif,
72 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, struct wl12xx_vif *wlvif);
73 int wl1271_build_qos_null_data(struct wl1271 *wl, struct ieee80211_vif *vif);
74 int wl12xx_cmd_build_klv_null_data(struct wl1271 *wl,
75 struct wl12xx_vif *wlvif);
76 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
77 int wl1271_cmd_set_sta_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
78 u16 action, u8 id, u8 key_type,
79 u8 key_size, const u8 *key, const u8 *addr,
80 u32 tx_seq_32, u16 tx_seq_16);
81 int wl1271_cmd_set_ap_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
82 u16 action, u8 id, u8 key_type,
83 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
85 int wl12xx_cmd_set_peer_state(struct wl1271 *wl, struct wl12xx_vif *wlvif,
87 int wl12xx_roc(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 role_id,
88 enum ieee80211_band band, u8 channel);
89 int wl12xx_croc(struct wl1271 *wl, u8 role_id);
90 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
91 struct ieee80211_sta *sta, u8 hlid);
92 int wl12xx_cmd_remove_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
94 void wlcore_set_pending_regdomain_ch(struct wl1271 *wl, u16 channel,
95 enum ieee80211_band band);
96 int wlcore_cmd_regdomain_config_locked(struct wl1271 *wl);
97 int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
98 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
99 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
100 int wl12xx_cmd_channel_switch(struct wl1271 *wl,
101 struct wl12xx_vif *wlvif,
102 struct ieee80211_channel_switch *ch_switch);
103 int wl12xx_cmd_stop_channel_switch(struct wl1271 *wl,
104 struct wl12xx_vif *wlvif);
105 int wl12xx_allocate_link(struct wl1271 *wl, struct wl12xx_vif *wlvif,
107 void wl12xx_free_link(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 *hlid);
108 int wlcore_cmd_wait_for_event_or_timeout(struct wl1271 *wl,
109 u32 mask, bool *timeout);
111 enum wl1271_commands {
112 CMD_INTERROGATE = 1, /* use this to read information elements */
113 CMD_CONFIGURE = 2, /* use this to write information elements */
121 CMD_READ_MEMORY = 10,
122 CMD_WRITE_MEMORY = 11,
123 CMD_SET_TEMPLATE = 12,
126 CMD_QUIET_ELEMENT_SET_STATE = 15,
127 CMD_SET_BCN_MODE = 16,
129 CMD_MEASUREMENT = 17,
130 CMD_STOP_MEASUREMENT = 18,
131 CMD_SET_PS_MODE = 19,
132 CMD_CHANNEL_SWITCH = 20,
133 CMD_STOP_CHANNEL_SWICTH = 21,
134 CMD_AP_DISCOVERY = 22,
135 CMD_STOP_AP_DISCOVERY = 23,
136 CMD_HEALTH_CHECK = 24,
138 CMD_TRIGGER_SCAN_TO = 26,
139 CMD_CONNECTION_SCAN_CFG = 27,
140 CMD_CONNECTION_SCAN_SSID_CFG = 28,
141 CMD_START_PERIODIC_SCAN = 29,
142 CMD_STOP_PERIODIC_SCAN = 30,
143 CMD_SET_PEER_STATE = 31,
144 CMD_REMAIN_ON_CHANNEL = 32,
145 CMD_CANCEL_REMAIN_ON_CHANNEL = 33,
146 CMD_CONFIG_FWLOGGER = 34,
147 CMD_START_FWLOGGER = 35,
148 CMD_STOP_FWLOGGER = 36,
150 /* Access point commands */
152 CMD_REMOVE_PEER = 38,
155 CMD_ROLE_ENABLE = 39,
156 CMD_ROLE_DISABLE = 40,
161 CMD_START_RADAR_DETECTION = 43,
162 CMD_STOP_RADAR_DETECTION = 44,
165 CMD_WFD_START_DISCOVERY = 45,
166 CMD_WFD_STOP_DISCOVERY = 46,
167 CMD_WFD_ATTRIBUTE_CONFIG = 47,
168 CMD_GENERIC_CFG = 48,
171 /* start of 18xx specific commands */
172 CMD_DFS_CHANNEL_CONFIG = 60,
173 CMD_SMART_CONFIG_START = 61,
174 CMD_SMART_CONFIG_STOP = 62,
175 CMD_SMART_CONFIG_SET_GROUP_KEY = 63,
177 MAX_COMMAND_ID = 0xFFFF,
180 #define MAX_CMD_PARAMS 572
183 CMD_TEMPL_NULL_DATA = 0,
185 CMD_TEMPL_CFG_PROBE_REQ_2_4,
186 CMD_TEMPL_CFG_PROBE_REQ_5,
187 CMD_TEMPL_PROBE_RESPONSE,
188 CMD_TEMPL_QOS_NULL_DATA,
191 CMD_TEMPL_DISCONNECT,
192 CMD_TEMPL_APP_PROBE_REQ_2_4_LEGACY,
193 CMD_TEMPL_APP_PROBE_REQ_5_LEGACY,
194 CMD_TEMPL_BAR, /* for firmware internal use only */
196 * For CTS-to-self (FastCTS) mechanism
197 * for BT/WLAN coexistence (SoftGemini). */
199 CMD_TEMPL_AP_PROBE_RESPONSE,
203 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
204 CMD_TEMPL_PROBE_REQ_2_4_PERIODIC,
205 CMD_TEMPL_PROBE_REQ_5_PERIODIC,
211 #define WL1271_COMMAND_TIMEOUT 2000
212 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
213 #define WL1271_CMD_TEMPL_MAX_SIZE 512
214 #define WL1271_EVENT_TIMEOUT 5000
216 struct wl1271_cmd_header {
223 #define WL1271_CMD_MAX_PARAMS 572
225 struct wl1271_command {
226 struct wl1271_cmd_header header;
227 u8 parameters[WL1271_CMD_MAX_PARAMS];
231 CMD_MAILBOX_IDLE = 0,
232 CMD_STATUS_SUCCESS = 1,
233 CMD_STATUS_UNKNOWN_CMD = 2,
234 CMD_STATUS_UNKNOWN_IE = 3,
235 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
236 CMD_STATUS_RX_BUSY = 13,
237 CMD_STATUS_INVALID_PARAM = 14,
238 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
239 CMD_STATUS_OUT_OF_MEMORY = 16,
240 CMD_STATUS_STA_TABLE_FULL = 17,
241 CMD_STATUS_RADIO_ERROR = 18,
242 CMD_STATUS_WRONG_NESTING = 19,
243 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
244 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
245 CMD_STATUS_TEMPLATE_OOM = 23,
246 CMD_STATUS_NO_RX_BA_SESSION = 24,
251 #define CMDMBOX_HEADER_LEN 4
252 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
256 BSS_TYPE_STA_BSS = 2,
261 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
262 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
263 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
265 struct wl12xx_cmd_role_enable {
266 struct wl1271_cmd_header header;
270 u8 mac_address[ETH_ALEN];
273 struct wl12xx_cmd_role_disable {
274 struct wl1271_cmd_header header;
281 WLCORE_BAND_2_4GHZ = 0,
282 WLCORE_BAND_5GHZ = 1,
283 WLCORE_BAND_JAPAN_4_9_GHZ = 2,
284 WLCORE_BAND_DEFAULT = WLCORE_BAND_2_4GHZ,
285 WLCORE_BAND_INVALID = 0x7E,
286 WLCORE_BAND_MAX_RADIO = 0x7F,
289 enum wlcore_channel_type {
292 WLCORE_CHAN_HT40MINUS,
296 struct wl12xx_cmd_role_start {
297 struct wl1271_cmd_header header;
303 /* enum wlcore_channel_type */
312 /* sta & p2p_cli use the same struct */
315 u8 hlid; /* data hlid */
317 __le32 remote_rates; /* remote supported rates */
320 * The target uses this field to determine the rate at
321 * which to transmit control frame responses (such as
322 * ACK or CTS frames).
324 __le32 basic_rate_set;
325 __le32 local_rates; /* local supported rates */
329 u8 ssid[IEEE80211_MAX_SSID_LEN];
331 __le16 beacon_interval; /* in TBTTs */
335 u8 hlid; /* data hlid */
337 __le32 remote_rates; /* remote supported rates */
339 __le32 basic_rate_set;
340 __le32 local_rates; /* local supported rates */
344 u8 ssid[IEEE80211_MAX_SSID_LEN];
346 __le16 beacon_interval; /* in TBTTs */
350 /* ap & p2p_go use the same struct */
352 __le16 aging_period; /* in secs */
353 u8 beacon_expiry; /* in ms */
355 /* The host link id for the AP's global queue */
357 /* The host link id for the AP's broadcast queue */
360 __le16 beacon_interval; /* in TBTTs */
362 __le32 basic_rate_set;
363 __le32 local_rates; /* local supported rates */
369 u8 ssid[IEEE80211_MAX_SSID_LEN];
374 * ap supports wmm (note that there is additional
375 * per-sta wmm configuration)
380 u8 global_session_id;
386 struct wl12xx_cmd_role_stop {
387 struct wl1271_cmd_header header;
390 u8 disc_type; /* only STA and P2P_CLI */
391 __le16 reason; /* only STA and P2P_CLI */
394 struct cmd_enabledisable_path {
395 struct wl1271_cmd_header header;
401 #define WL1271_RATE_AUTOMATIC 0
403 struct wl1271_cmd_template_set {
404 struct wl1271_cmd_header header;
409 u8 index; /* relevant only for KLV_TEMPLATE type */
412 __le32 enabled_rates;
413 u8 short_retry_limit;
418 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
422 #define PARTIAL_VBM_MAX 251
430 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
433 enum wl1271_cmd_ps_mode {
434 STATION_AUTO_PS_MODE, /* Dynamic Power Save */
436 STATION_POWER_SAVE_MODE
439 struct wl1271_cmd_ps_params {
440 struct wl1271_cmd_header header;
443 u8 ps_mode; /* STATION_* */
447 /* HW encryption keys */
448 #define NUM_ACCESS_CATEGORIES_COPY 4
450 enum wl1271_cmd_key_action {
451 KEY_ADD_OR_REPLACE = 1,
454 MAX_KEY_ACTION = 0xffff,
457 enum wl1271_cmd_lid_key_type {
458 UNICAST_LID_TYPE = 0,
459 BROADCAST_LID_TYPE = 1,
460 WEP_DEFAULT_LID_TYPE = 2
463 enum wl1271_cmd_key_type {
471 struct wl1271_cmd_set_keys {
472 struct wl1271_cmd_header header;
475 * Indicates whether the HLID is a unicast key set
476 * or broadcast key set. A special value 0xFF is
477 * used to indicate that the HLID is on WEP-default
478 * (multi-hlids). of type wl1271_cmd_lid_key_type.
483 * In WEP-default network (hlid == 0xFF) used to
484 * indicate which network STA/IBSS/AP role should be
490 * Key ID - For TKIP and AES key types, this field
491 * indicates the value that should be inserted into
492 * the KeyID field of frames transmitted using this
493 * key entry. For broadcast keys the index use as a
494 * marker for TX/RX key.
495 * For WEP default network (HLID=0xFF), this field
496 * indicates the ID of the key to add or remove.
504 /* key size in bytes */
510 /* This field holds the security key data to add to the STA table */
511 u8 key[MAX_KEY_SIZE];
512 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
513 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
516 struct wl1271_cmd_test_header {
521 enum wl1271_channel_tune_bands {
522 WL1271_CHANNEL_TUNE_BAND_2_4,
523 WL1271_CHANNEL_TUNE_BAND_5,
524 WL1271_CHANNEL_TUNE_BAND_4_9
527 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
530 * There are three types of disconnections:
532 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
533 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
535 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
538 enum wl1271_disconnect_type {
539 DISCONNECT_IMMEDIATE,
544 #define WL1271_CMD_STA_STATE_CONNECTED 1
546 struct wl12xx_cmd_set_peer_state {
547 struct wl1271_cmd_header header;
553 * wmm is relevant for sta role only.
554 * ap role configures the per-sta wmm params in
555 * the add_peer command.
561 struct wl12xx_cmd_roc {
562 struct wl1271_cmd_header header;
570 struct wl12xx_cmd_croc {
571 struct wl1271_cmd_header header;
577 enum wl12xx_ssid_type {
578 WL12XX_SSID_TYPE_PUBLIC = 0,
579 WL12XX_SSID_TYPE_HIDDEN = 1,
580 WL12XX_SSID_TYPE_ANY = 2,
583 enum wl1271_psd_type {
584 WL1271_PSD_LEGACY = 0,
585 WL1271_PSD_UPSD_TRIGGER = 1,
586 WL1271_PSD_LEGACY_PSPOLL = 2,
590 struct wl12xx_cmd_add_peer {
591 struct wl1271_cmd_header header;
596 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
597 __le32 supported_rates;
606 struct wl12xx_cmd_remove_peer {
607 struct wl1271_cmd_header header;
616 * Continuous mode - packets are transferred to the host periodically
618 * On demand - Log messages are stored in a cyclic buffer in the
619 * firmware, and only transferred to the host when explicitly requested
621 enum wl12xx_fwlogger_log_mode {
622 WL12XX_FWLOG_CONTINUOUS,
623 WL12XX_FWLOG_ON_DEMAND
626 /* Include/exclude timestamps from the log messages */
627 enum wl12xx_fwlogger_timestamp {
628 WL12XX_FWLOG_TIMESTAMP_DISABLED,
629 WL12XX_FWLOG_TIMESTAMP_ENABLED
633 * Logs can be routed to the debug pinouts (where available), to the host bus
634 * (SDIO/SPI), or dropped
636 enum wl12xx_fwlogger_output {
637 WL12XX_FWLOG_OUTPUT_NONE,
638 WL12XX_FWLOG_OUTPUT_DBG_PINS,
639 WL12XX_FWLOG_OUTPUT_HOST,
642 struct wl12xx_cmd_regdomain_dfs_config {
643 struct wl1271_cmd_header header;
649 struct wl12xx_cmd_config_fwlog {
650 struct wl1271_cmd_header header;
652 /* See enum wl12xx_fwlogger_log_mode */
655 /* Minimum log level threshold */
658 /* Include/exclude timestamps from the log messages */
661 /* See enum wl1271_fwlogger_output */
664 /* Regulates the frequency of log messages */
670 struct wl12xx_cmd_start_fwlog {
671 struct wl1271_cmd_header header;
674 struct wl12xx_cmd_stop_fwlog {
675 struct wl1271_cmd_header header;
678 struct wl12xx_cmd_stop_channel_switch {
679 struct wl1271_cmd_header header;
685 /* Used to check radio status after calibration */
686 #define MAX_TLV_LENGTH 500
687 #define TEST_CMD_P2G_CAL 2 /* TX BiP */
689 struct wl1271_cmd_cal_p2g {
690 struct wl1271_cmd_header header;
692 struct wl1271_cmd_test_header test;
696 u8 buf[MAX_TLV_LENGTH];
706 #endif /* __WL1271_CMD_H__ */