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, bool sched_scan);
68 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
69 struct wl12xx_vif *wlvif,
71 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, struct wl12xx_vif *wlvif);
72 int wl1271_build_qos_null_data(struct wl1271 *wl, struct ieee80211_vif *vif);
73 int wl12xx_cmd_build_klv_null_data(struct wl1271 *wl,
74 struct wl12xx_vif *wlvif);
75 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
76 int wl1271_cmd_set_sta_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
77 u16 action, u8 id, u8 key_type,
78 u8 key_size, const u8 *key, const u8 *addr,
79 u32 tx_seq_32, u16 tx_seq_16);
80 int wl1271_cmd_set_ap_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
81 u16 action, u8 id, u8 key_type,
82 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
84 int wl12xx_cmd_set_peer_state(struct wl1271 *wl, struct wl12xx_vif *wlvif,
86 int wl12xx_roc(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 role_id,
87 enum ieee80211_band band, u8 channel);
88 int wl12xx_croc(struct wl1271 *wl, u8 role_id);
89 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
90 struct ieee80211_sta *sta, u8 hlid);
91 int wl12xx_cmd_remove_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
93 void wlcore_set_pending_regdomain_ch(struct wl1271 *wl, u16 channel,
94 enum ieee80211_band band);
95 int wlcore_cmd_regdomain_config_locked(struct wl1271 *wl);
96 int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
97 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
98 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
99 int wl12xx_cmd_channel_switch(struct wl1271 *wl,
100 struct wl12xx_vif *wlvif,
101 struct ieee80211_channel_switch *ch_switch);
102 int wl12xx_cmd_stop_channel_switch(struct wl1271 *wl,
103 struct wl12xx_vif *wlvif);
104 int wl12xx_allocate_link(struct wl1271 *wl, struct wl12xx_vif *wlvif,
106 void wl12xx_free_link(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 *hlid);
107 int wlcore_cmd_wait_for_event_or_timeout(struct wl1271 *wl,
108 u32 mask, bool *timeout);
110 enum wl1271_commands {
111 CMD_INTERROGATE = 1, /* use this to read information elements */
112 CMD_CONFIGURE = 2, /* use this to write information elements */
120 CMD_READ_MEMORY = 10,
121 CMD_WRITE_MEMORY = 11,
122 CMD_SET_TEMPLATE = 12,
125 CMD_QUIET_ELEMENT_SET_STATE = 15,
126 CMD_SET_BCN_MODE = 16,
128 CMD_MEASUREMENT = 17,
129 CMD_STOP_MEASUREMENT = 18,
130 CMD_SET_PS_MODE = 19,
131 CMD_CHANNEL_SWITCH = 20,
132 CMD_STOP_CHANNEL_SWICTH = 21,
133 CMD_AP_DISCOVERY = 22,
134 CMD_STOP_AP_DISCOVERY = 23,
135 CMD_HEALTH_CHECK = 24,
137 CMD_TRIGGER_SCAN_TO = 26,
138 CMD_CONNECTION_SCAN_CFG = 27,
139 CMD_CONNECTION_SCAN_SSID_CFG = 28,
140 CMD_START_PERIODIC_SCAN = 29,
141 CMD_STOP_PERIODIC_SCAN = 30,
142 CMD_SET_PEER_STATE = 31,
143 CMD_REMAIN_ON_CHANNEL = 32,
144 CMD_CANCEL_REMAIN_ON_CHANNEL = 33,
145 CMD_CONFIG_FWLOGGER = 34,
146 CMD_START_FWLOGGER = 35,
147 CMD_STOP_FWLOGGER = 36,
149 /* Access point commands */
151 CMD_REMOVE_PEER = 38,
154 CMD_ROLE_ENABLE = 39,
155 CMD_ROLE_DISABLE = 40,
160 CMD_START_RADAR_DETECTION = 43,
161 CMD_STOP_RADAR_DETECTION = 44,
164 CMD_WFD_START_DISCOVERY = 45,
165 CMD_WFD_STOP_DISCOVERY = 46,
166 CMD_WFD_ATTRIBUTE_CONFIG = 47,
167 CMD_GENERIC_CFG = 48,
170 /* start of 18xx specific commands */
171 CMD_DFS_CHANNEL_CONFIG = 60,
173 MAX_COMMAND_ID = 0xFFFF,
176 #define MAX_CMD_PARAMS 572
179 CMD_TEMPL_NULL_DATA = 0,
181 CMD_TEMPL_CFG_PROBE_REQ_2_4,
182 CMD_TEMPL_CFG_PROBE_REQ_5,
183 CMD_TEMPL_PROBE_RESPONSE,
184 CMD_TEMPL_QOS_NULL_DATA,
187 CMD_TEMPL_DISCONNECT,
188 CMD_TEMPL_APP_PROBE_REQ_2_4_LEGACY,
189 CMD_TEMPL_APP_PROBE_REQ_5_LEGACY,
190 CMD_TEMPL_BAR, /* for firmware internal use only */
192 * For CTS-to-self (FastCTS) mechanism
193 * for BT/WLAN coexistence (SoftGemini). */
195 CMD_TEMPL_AP_PROBE_RESPONSE,
199 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
200 CMD_TEMPL_PROBE_REQ_2_4_PERIODIC,
201 CMD_TEMPL_PROBE_REQ_5_PERIODIC,
207 #define WL1271_COMMAND_TIMEOUT 2000
208 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
209 #define WL1271_CMD_TEMPL_MAX_SIZE 512
210 #define WL1271_EVENT_TIMEOUT 5000
212 struct wl1271_cmd_header {
219 #define WL1271_CMD_MAX_PARAMS 572
221 struct wl1271_command {
222 struct wl1271_cmd_header header;
223 u8 parameters[WL1271_CMD_MAX_PARAMS];
227 CMD_MAILBOX_IDLE = 0,
228 CMD_STATUS_SUCCESS = 1,
229 CMD_STATUS_UNKNOWN_CMD = 2,
230 CMD_STATUS_UNKNOWN_IE = 3,
231 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
232 CMD_STATUS_RX_BUSY = 13,
233 CMD_STATUS_INVALID_PARAM = 14,
234 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
235 CMD_STATUS_OUT_OF_MEMORY = 16,
236 CMD_STATUS_STA_TABLE_FULL = 17,
237 CMD_STATUS_RADIO_ERROR = 18,
238 CMD_STATUS_WRONG_NESTING = 19,
239 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
240 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
241 CMD_STATUS_TEMPLATE_OOM = 23,
242 CMD_STATUS_NO_RX_BA_SESSION = 24,
247 #define CMDMBOX_HEADER_LEN 4
248 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
252 BSS_TYPE_STA_BSS = 2,
257 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
258 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
259 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
261 struct wl12xx_cmd_role_enable {
262 struct wl1271_cmd_header header;
266 u8 mac_address[ETH_ALEN];
269 struct wl12xx_cmd_role_disable {
270 struct wl1271_cmd_header header;
277 WLCORE_BAND_2_4GHZ = 0,
278 WLCORE_BAND_5GHZ = 1,
279 WLCORE_BAND_JAPAN_4_9_GHZ = 2,
280 WLCORE_BAND_DEFAULT = WLCORE_BAND_2_4GHZ,
281 WLCORE_BAND_INVALID = 0x7E,
282 WLCORE_BAND_MAX_RADIO = 0x7F,
285 enum wlcore_channel_type {
288 WLCORE_CHAN_HT40MINUS,
292 struct wl12xx_cmd_role_start {
293 struct wl1271_cmd_header header;
299 /* enum wlcore_channel_type */
308 /* sta & p2p_cli use the same struct */
311 u8 hlid; /* data hlid */
313 __le32 remote_rates; /* remote supported rates */
316 * The target uses this field to determine the rate at
317 * which to transmit control frame responses (such as
318 * ACK or CTS frames).
320 __le32 basic_rate_set;
321 __le32 local_rates; /* local supported rates */
325 u8 ssid[IEEE80211_MAX_SSID_LEN];
327 __le16 beacon_interval; /* in TBTTs */
331 u8 hlid; /* data hlid */
333 __le32 remote_rates; /* remote supported rates */
335 __le32 basic_rate_set;
336 __le32 local_rates; /* local supported rates */
340 u8 ssid[IEEE80211_MAX_SSID_LEN];
342 __le16 beacon_interval; /* in TBTTs */
346 /* ap & p2p_go use the same struct */
348 __le16 aging_period; /* in secs */
349 u8 beacon_expiry; /* in ms */
351 /* The host link id for the AP's global queue */
353 /* The host link id for the AP's broadcast queue */
356 __le16 beacon_interval; /* in TBTTs */
358 __le32 basic_rate_set;
359 __le32 local_rates; /* local supported rates */
365 u8 ssid[IEEE80211_MAX_SSID_LEN];
370 * ap supports wmm (note that there is additional
371 * per-sta wmm configuration)
376 u8 global_session_id;
382 struct wl12xx_cmd_role_stop {
383 struct wl1271_cmd_header header;
386 u8 disc_type; /* only STA and P2P_CLI */
387 __le16 reason; /* only STA and P2P_CLI */
390 struct cmd_enabledisable_path {
391 struct wl1271_cmd_header header;
397 #define WL1271_RATE_AUTOMATIC 0
399 struct wl1271_cmd_template_set {
400 struct wl1271_cmd_header header;
405 u8 index; /* relevant only for KLV_TEMPLATE type */
408 __le32 enabled_rates;
409 u8 short_retry_limit;
414 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
418 #define PARTIAL_VBM_MAX 251
426 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
429 enum wl1271_cmd_ps_mode {
430 STATION_AUTO_PS_MODE, /* Dynamic Power Save */
432 STATION_POWER_SAVE_MODE
435 struct wl1271_cmd_ps_params {
436 struct wl1271_cmd_header header;
439 u8 ps_mode; /* STATION_* */
443 /* HW encryption keys */
444 #define NUM_ACCESS_CATEGORIES_COPY 4
446 enum wl1271_cmd_key_action {
447 KEY_ADD_OR_REPLACE = 1,
450 MAX_KEY_ACTION = 0xffff,
453 enum wl1271_cmd_lid_key_type {
454 UNICAST_LID_TYPE = 0,
455 BROADCAST_LID_TYPE = 1,
456 WEP_DEFAULT_LID_TYPE = 2
459 enum wl1271_cmd_key_type {
467 struct wl1271_cmd_set_keys {
468 struct wl1271_cmd_header header;
471 * Indicates whether the HLID is a unicast key set
472 * or broadcast key set. A special value 0xFF is
473 * used to indicate that the HLID is on WEP-default
474 * (multi-hlids). of type wl1271_cmd_lid_key_type.
479 * In WEP-default network (hlid == 0xFF) used to
480 * indicate which network STA/IBSS/AP role should be
486 * Key ID - For TKIP and AES key types, this field
487 * indicates the value that should be inserted into
488 * the KeyID field of frames transmitted using this
489 * key entry. For broadcast keys the index use as a
490 * marker for TX/RX key.
491 * For WEP default network (HLID=0xFF), this field
492 * indicates the ID of the key to add or remove.
500 /* key size in bytes */
506 /* This field holds the security key data to add to the STA table */
507 u8 key[MAX_KEY_SIZE];
508 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
509 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
512 struct wl1271_cmd_test_header {
517 enum wl1271_channel_tune_bands {
518 WL1271_CHANNEL_TUNE_BAND_2_4,
519 WL1271_CHANNEL_TUNE_BAND_5,
520 WL1271_CHANNEL_TUNE_BAND_4_9
523 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
526 * There are three types of disconnections:
528 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
529 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
531 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
534 enum wl1271_disconnect_type {
535 DISCONNECT_IMMEDIATE,
540 #define WL1271_CMD_STA_STATE_CONNECTED 1
542 struct wl12xx_cmd_set_peer_state {
543 struct wl1271_cmd_header header;
549 * wmm is relevant for sta role only.
550 * ap role configures the per-sta wmm params in
551 * the add_peer command.
557 struct wl12xx_cmd_roc {
558 struct wl1271_cmd_header header;
566 struct wl12xx_cmd_croc {
567 struct wl1271_cmd_header header;
573 enum wl12xx_ssid_type {
574 WL12XX_SSID_TYPE_PUBLIC = 0,
575 WL12XX_SSID_TYPE_HIDDEN = 1,
576 WL12XX_SSID_TYPE_ANY = 2,
579 enum wl1271_psd_type {
580 WL1271_PSD_LEGACY = 0,
581 WL1271_PSD_UPSD_TRIGGER = 1,
582 WL1271_PSD_LEGACY_PSPOLL = 2,
586 struct wl12xx_cmd_add_peer {
587 struct wl1271_cmd_header header;
592 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
593 __le32 supported_rates;
602 struct wl12xx_cmd_remove_peer {
603 struct wl1271_cmd_header header;
612 * Continuous mode - packets are transferred to the host periodically
614 * On demand - Log messages are stored in a cyclic buffer in the
615 * firmware, and only transferred to the host when explicitly requested
617 enum wl12xx_fwlogger_log_mode {
618 WL12XX_FWLOG_CONTINUOUS,
619 WL12XX_FWLOG_ON_DEMAND
622 /* Include/exclude timestamps from the log messages */
623 enum wl12xx_fwlogger_timestamp {
624 WL12XX_FWLOG_TIMESTAMP_DISABLED,
625 WL12XX_FWLOG_TIMESTAMP_ENABLED
629 * Logs can be routed to the debug pinouts (where available), to the host bus
630 * (SDIO/SPI), or dropped
632 enum wl12xx_fwlogger_output {
633 WL12XX_FWLOG_OUTPUT_NONE,
634 WL12XX_FWLOG_OUTPUT_DBG_PINS,
635 WL12XX_FWLOG_OUTPUT_HOST,
638 struct wl12xx_cmd_regdomain_dfs_config {
639 struct wl1271_cmd_header header;
645 struct wl12xx_cmd_config_fwlog {
646 struct wl1271_cmd_header header;
648 /* See enum wl12xx_fwlogger_log_mode */
651 /* Minimum log level threshold */
654 /* Include/exclude timestamps from the log messages */
657 /* See enum wl1271_fwlogger_output */
660 /* Regulates the frequency of log messages */
666 struct wl12xx_cmd_start_fwlog {
667 struct wl1271_cmd_header header;
670 struct wl12xx_cmd_stop_fwlog {
671 struct wl1271_cmd_header header;
674 struct wl12xx_cmd_stop_channel_switch {
675 struct wl1271_cmd_header header;
681 /* Used to check radio status after calibration */
682 #define MAX_TLV_LENGTH 500
683 #define TEST_CMD_P2G_CAL 2 /* TX BiP */
685 struct wl1271_cmd_cal_p2g {
686 struct wl1271_cmd_header header;
688 struct wl1271_cmd_test_header test;
692 u8 buf[MAX_TLV_LENGTH];
702 #endif /* __WL1271_CMD_H__ */