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 wl12xx_cmd_role_enable(struct wl1271 *wl, u8 *addr, u8 role_type,
36 int wl12xx_cmd_role_disable(struct wl1271 *wl, u8 *role_id);
37 int wl12xx_cmd_role_start_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
38 int wl12xx_cmd_role_stop_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
39 int wl12xx_cmd_role_start_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
40 int wl12xx_cmd_role_stop_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
41 int wl12xx_cmd_role_start_ibss(struct wl1271 *wl, struct wl12xx_vif *wlvif);
42 int wl12xx_start_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif,
43 enum ieee80211_band band, int channel);
44 int wl12xx_stop_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif);
45 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
46 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len);
47 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
48 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
49 int wl1271_cmd_ps_mode(struct wl1271 *wl, struct wl12xx_vif *wlvif,
50 u8 ps_mode, u16 auto_ps_timeout);
51 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
53 int wl1271_cmd_template_set(struct wl1271 *wl, u8 role_id,
54 u16 template_id, void *buf, size_t buf_len,
55 int index, u32 rates);
56 int wl12xx_cmd_build_null_data(struct wl1271 *wl, struct wl12xx_vif *wlvif);
57 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, struct wl12xx_vif *wlvif,
59 int wl12xx_cmd_build_probe_req(struct wl1271 *wl, struct wl12xx_vif *wlvif,
61 const u8 *ssid, size_t ssid_len,
62 const u8 *ie, size_t ie_len, bool sched_scan);
63 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
64 struct wl12xx_vif *wlvif,
66 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, struct wl12xx_vif *wlvif);
67 int wl1271_build_qos_null_data(struct wl1271 *wl, struct ieee80211_vif *vif);
68 int wl12xx_cmd_build_klv_null_data(struct wl1271 *wl,
69 struct wl12xx_vif *wlvif);
70 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
71 int wl1271_cmd_set_sta_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
72 u16 action, u8 id, u8 key_type,
73 u8 key_size, const u8 *key, const u8 *addr,
74 u32 tx_seq_32, u16 tx_seq_16);
75 int wl1271_cmd_set_ap_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
76 u16 action, u8 id, u8 key_type,
77 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
79 int wl12xx_cmd_set_peer_state(struct wl1271 *wl, u8 hlid);
80 int wl12xx_roc(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 role_id,
81 enum ieee80211_band band, u8 channel);
82 int wl12xx_croc(struct wl1271 *wl, u8 role_id);
83 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
84 struct ieee80211_sta *sta, u8 hlid);
85 int wl12xx_cmd_remove_peer(struct wl1271 *wl, u8 hlid);
86 int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
87 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
88 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
89 int wl12xx_cmd_channel_switch(struct wl1271 *wl,
90 struct wl12xx_vif *wlvif,
91 struct ieee80211_channel_switch *ch_switch);
92 int wl12xx_cmd_stop_channel_switch(struct wl1271 *wl);
93 int wl12xx_allocate_link(struct wl1271 *wl, struct wl12xx_vif *wlvif,
95 void wl12xx_free_link(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 *hlid);
97 enum wl1271_commands {
98 CMD_INTERROGATE = 1, /* use this to read information elements */
99 CMD_CONFIGURE = 2, /* use this to write information elements */
107 CMD_READ_MEMORY = 10,
108 CMD_WRITE_MEMORY = 11,
109 CMD_SET_TEMPLATE = 12,
112 CMD_QUIET_ELEMENT_SET_STATE = 15,
113 CMD_SET_BCN_MODE = 16,
115 CMD_MEASUREMENT = 17,
116 CMD_STOP_MEASUREMENT = 18,
117 CMD_SET_PS_MODE = 19,
118 CMD_CHANNEL_SWITCH = 20,
119 CMD_STOP_CHANNEL_SWICTH = 21,
120 CMD_AP_DISCOVERY = 22,
121 CMD_STOP_AP_DISCOVERY = 23,
122 CMD_HEALTH_CHECK = 24,
124 CMD_TRIGGER_SCAN_TO = 26,
125 CMD_CONNECTION_SCAN_CFG = 27,
126 CMD_CONNECTION_SCAN_SSID_CFG = 28,
127 CMD_START_PERIODIC_SCAN = 29,
128 CMD_STOP_PERIODIC_SCAN = 30,
129 CMD_SET_PEER_STATE = 31,
130 CMD_REMAIN_ON_CHANNEL = 32,
131 CMD_CANCEL_REMAIN_ON_CHANNEL = 33,
132 CMD_CONFIG_FWLOGGER = 34,
133 CMD_START_FWLOGGER = 35,
134 CMD_STOP_FWLOGGER = 36,
136 /* Access point commands */
138 CMD_REMOVE_PEER = 38,
141 CMD_ROLE_ENABLE = 39,
142 CMD_ROLE_DISABLE = 40,
147 CMD_START_RADAR_DETECTION = 43,
148 CMD_STOP_RADAR_DETECTION = 44,
151 CMD_WFD_START_DISCOVERY = 45,
152 CMD_WFD_STOP_DISCOVERY = 46,
153 CMD_WFD_ATTRIBUTE_CONFIG = 47,
157 MAX_COMMAND_ID = 0xFFFF,
160 #define MAX_CMD_PARAMS 572
163 CMD_TEMPL_NULL_DATA = 0,
165 CMD_TEMPL_CFG_PROBE_REQ_2_4,
166 CMD_TEMPL_CFG_PROBE_REQ_5,
167 CMD_TEMPL_PROBE_RESPONSE,
168 CMD_TEMPL_QOS_NULL_DATA,
171 CMD_TEMPL_DISCONNECT,
172 CMD_TEMPL_APP_PROBE_REQ_2_4,
173 CMD_TEMPL_APP_PROBE_REQ_5,
174 CMD_TEMPL_BAR, /* for firmware internal use only */
176 * For CTS-to-self (FastCTS) mechanism
177 * for BT/WLAN coexistence (SoftGemini). */
179 CMD_TEMPL_AP_PROBE_RESPONSE,
183 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
189 #define WL1271_COMMAND_TIMEOUT 2000
190 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
191 #define WL1271_CMD_TEMPL_MAX_SIZE 512
192 #define WL1271_EVENT_TIMEOUT 1500
194 struct wl1271_cmd_header {
201 #define WL1271_CMD_MAX_PARAMS 572
203 struct wl1271_command {
204 struct wl1271_cmd_header header;
205 u8 parameters[WL1271_CMD_MAX_PARAMS];
209 CMD_MAILBOX_IDLE = 0,
210 CMD_STATUS_SUCCESS = 1,
211 CMD_STATUS_UNKNOWN_CMD = 2,
212 CMD_STATUS_UNKNOWN_IE = 3,
213 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
214 CMD_STATUS_RX_BUSY = 13,
215 CMD_STATUS_INVALID_PARAM = 14,
216 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
217 CMD_STATUS_OUT_OF_MEMORY = 16,
218 CMD_STATUS_STA_TABLE_FULL = 17,
219 CMD_STATUS_RADIO_ERROR = 18,
220 CMD_STATUS_WRONG_NESTING = 19,
221 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
222 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
223 CMD_STATUS_TEMPLATE_OOM = 23,
224 CMD_STATUS_NO_RX_BA_SESSION = 24,
225 MAX_COMMAND_STATUS = 0xff
228 #define CMDMBOX_HEADER_LEN 4
229 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
233 BSS_TYPE_STA_BSS = 2,
238 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
239 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
240 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
242 struct wl12xx_cmd_role_enable {
243 struct wl1271_cmd_header header;
247 u8 mac_address[ETH_ALEN];
250 struct wl12xx_cmd_role_disable {
251 struct wl1271_cmd_header header;
258 WLCORE_BAND_2_4GHZ = 0,
259 WLCORE_BAND_5GHZ = 1,
260 WLCORE_BAND_JAPAN_4_9_GHZ = 2,
261 WLCORE_BAND_DEFAULT = WLCORE_BAND_2_4GHZ,
262 WLCORE_BAND_INVALID = 0x7E,
263 WLCORE_BAND_MAX_RADIO = 0x7F,
266 enum wlcore_channel_type {
269 WLCORE_CHAN_HT40MINUS,
273 struct wl12xx_cmd_role_start {
274 struct wl1271_cmd_header header;
280 /* enum wlcore_channel_type */
289 /* sta & p2p_cli use the same struct */
292 u8 hlid; /* data hlid */
294 __le32 remote_rates; /* remote supported rates */
297 * The target uses this field to determine the rate at
298 * which to transmit control frame responses (such as
299 * ACK or CTS frames).
301 __le32 basic_rate_set;
302 __le32 local_rates; /* local supported rates */
306 u8 ssid[IEEE80211_MAX_SSID_LEN];
308 __le16 beacon_interval; /* in TBTTs */
312 u8 hlid; /* data hlid */
314 __le32 remote_rates; /* remote supported rates */
316 __le32 basic_rate_set;
317 __le32 local_rates; /* local supported rates */
321 u8 ssid[IEEE80211_MAX_SSID_LEN];
323 __le16 beacon_interval; /* in TBTTs */
327 /* ap & p2p_go use the same struct */
329 __le16 aging_period; /* in secs */
330 u8 beacon_expiry; /* in ms */
332 /* The host link id for the AP's global queue */
334 /* The host link id for the AP's broadcast queue */
337 __le16 beacon_interval; /* in TBTTs */
339 __le32 basic_rate_set;
340 __le32 local_rates; /* local supported rates */
346 u8 ssid[IEEE80211_MAX_SSID_LEN];
355 struct wl12xx_cmd_role_stop {
356 struct wl1271_cmd_header header;
359 u8 disc_type; /* only STA and P2P_CLI */
360 __le16 reason; /* only STA and P2P_CLI */
363 struct cmd_enabledisable_path {
364 struct wl1271_cmd_header header;
370 #define WL1271_RATE_AUTOMATIC 0
372 struct wl1271_cmd_template_set {
373 struct wl1271_cmd_header header;
378 u8 index; /* relevant only for KLV_TEMPLATE type */
381 __le32 enabled_rates;
382 u8 short_retry_limit;
387 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
391 #define PARTIAL_VBM_MAX 251
399 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
402 enum wl1271_cmd_ps_mode {
403 STATION_AUTO_PS_MODE, /* Dynamic Power Save */
405 STATION_POWER_SAVE_MODE
408 struct wl1271_cmd_ps_params {
409 struct wl1271_cmd_header header;
412 u8 ps_mode; /* STATION_* */
416 /* HW encryption keys */
417 #define NUM_ACCESS_CATEGORIES_COPY 4
419 enum wl1271_cmd_key_action {
420 KEY_ADD_OR_REPLACE = 1,
423 MAX_KEY_ACTION = 0xffff,
426 enum wl1271_cmd_lid_key_type {
427 UNICAST_LID_TYPE = 0,
428 BROADCAST_LID_TYPE = 1,
429 WEP_DEFAULT_LID_TYPE = 2
432 enum wl1271_cmd_key_type {
440 struct wl1271_cmd_set_keys {
441 struct wl1271_cmd_header header;
444 * Indicates whether the HLID is a unicast key set
445 * or broadcast key set. A special value 0xFF is
446 * used to indicate that the HLID is on WEP-default
447 * (multi-hlids). of type wl1271_cmd_lid_key_type.
452 * In WEP-default network (hlid == 0xFF) used to
453 * indicate which network STA/IBSS/AP role should be
459 * Key ID - For TKIP and AES key types, this field
460 * indicates the value that should be inserted into
461 * the KeyID field of frames transmitted using this
462 * key entry. For broadcast keys the index use as a
463 * marker for TX/RX key.
464 * For WEP default network (HLID=0xFF), this field
465 * indicates the ID of the key to add or remove.
473 /* key size in bytes */
479 /* This field holds the security key data to add to the STA table */
480 u8 key[MAX_KEY_SIZE];
481 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
482 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
485 struct wl1271_cmd_test_header {
490 enum wl1271_channel_tune_bands {
491 WL1271_CHANNEL_TUNE_BAND_2_4,
492 WL1271_CHANNEL_TUNE_BAND_5,
493 WL1271_CHANNEL_TUNE_BAND_4_9
496 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
499 * There are three types of disconnections:
501 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
502 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
504 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
507 enum wl1271_disconnect_type {
508 DISCONNECT_IMMEDIATE,
513 #define WL1271_CMD_STA_STATE_CONNECTED 1
515 struct wl12xx_cmd_set_peer_state {
516 struct wl1271_cmd_header header;
523 struct wl12xx_cmd_roc {
524 struct wl1271_cmd_header header;
532 struct wl12xx_cmd_croc {
533 struct wl1271_cmd_header header;
539 enum wl12xx_ssid_type {
540 WL12XX_SSID_TYPE_PUBLIC = 0,
541 WL12XX_SSID_TYPE_HIDDEN = 1,
542 WL12XX_SSID_TYPE_ANY = 2,
545 enum wl1271_psd_type {
546 WL1271_PSD_LEGACY = 0,
547 WL1271_PSD_UPSD_TRIGGER = 1,
548 WL1271_PSD_LEGACY_PSPOLL = 2,
552 struct wl12xx_cmd_add_peer {
553 struct wl1271_cmd_header header;
558 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
559 __le32 supported_rates;
566 struct wl12xx_cmd_remove_peer {
567 struct wl1271_cmd_header header;
576 * Continuous mode - packets are transferred to the host periodically
578 * On demand - Log messages are stored in a cyclic buffer in the
579 * firmware, and only transferred to the host when explicitly requested
581 enum wl12xx_fwlogger_log_mode {
582 WL12XX_FWLOG_CONTINUOUS,
583 WL12XX_FWLOG_ON_DEMAND
586 /* Include/exclude timestamps from the log messages */
587 enum wl12xx_fwlogger_timestamp {
588 WL12XX_FWLOG_TIMESTAMP_DISABLED,
589 WL12XX_FWLOG_TIMESTAMP_ENABLED
593 * Logs can be routed to the debug pinouts (where available), to the host bus
594 * (SDIO/SPI), or dropped
596 enum wl12xx_fwlogger_output {
597 WL12XX_FWLOG_OUTPUT_NONE,
598 WL12XX_FWLOG_OUTPUT_DBG_PINS,
599 WL12XX_FWLOG_OUTPUT_HOST,
602 struct wl12xx_cmd_config_fwlog {
603 struct wl1271_cmd_header header;
605 /* See enum wl12xx_fwlogger_log_mode */
608 /* Minimum log level threshold */
611 /* Include/exclude timestamps from the log messages */
614 /* See enum wl1271_fwlogger_output */
617 /* Regulates the frequency of log messages */
623 struct wl12xx_cmd_start_fwlog {
624 struct wl1271_cmd_header header;
627 struct wl12xx_cmd_stop_fwlog {
628 struct wl1271_cmd_header header;
631 struct wl12xx_cmd_channel_switch {
632 struct wl1271_cmd_header header;
636 /* The new serving channel */
638 /* Relative time of the serving channel switch in TBTT units */
640 /* Stop the role TX, should expect it after radar detection */
642 /* The target channel tx status 1-stopped 0-open*/
643 u8 post_switch_tx_disable;
648 struct wl12xx_cmd_stop_channel_switch {
649 struct wl1271_cmd_header header;
652 /* Used to check radio status after calibration */
653 #define MAX_TLV_LENGTH 500
654 #define TEST_CMD_P2G_CAL 2 /* TX BiP */
656 struct wl1271_cmd_cal_p2g {
657 struct wl1271_cmd_header header;
659 struct wl1271_cmd_test_header test;
663 u8 buf[MAX_TLV_LENGTH];
673 #endif /* __WL1271_CMD_H__ */