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,
47 size_t cmd_len, size_t res_len);
48 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
49 int wlcore_cmd_configure_failsafe(struct wl1271 *wl, u16 id, void *buf,
50 size_t len, unsigned long valid_rets);
51 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
52 int wl1271_cmd_ps_mode(struct wl1271 *wl, struct wl12xx_vif *wlvif,
53 u8 ps_mode, u16 auto_ps_timeout);
54 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
56 int wl1271_cmd_template_set(struct wl1271 *wl, u8 role_id,
57 u16 template_id, void *buf, size_t buf_len,
58 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 wl12xx_cmd_build_probe_req(struct wl1271 *wl, struct wl12xx_vif *wlvif,
64 const u8 *ssid, size_t ssid_len,
65 const u8 *ie, size_t ie_len, const u8 *common_ie,
66 size_t common_ie_len, bool sched_scan);
67 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
68 struct wl12xx_vif *wlvif,
70 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, struct wl12xx_vif *wlvif);
71 int wl1271_build_qos_null_data(struct wl1271 *wl, struct ieee80211_vif *vif);
72 int wl12xx_cmd_build_klv_null_data(struct wl1271 *wl,
73 struct wl12xx_vif *wlvif);
74 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
75 int wl1271_cmd_set_sta_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
76 u16 action, u8 id, u8 key_type,
77 u8 key_size, const u8 *key, const u8 *addr,
78 u32 tx_seq_32, u16 tx_seq_16);
79 int wl1271_cmd_set_ap_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
80 u16 action, u8 id, u8 key_type,
81 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
83 int wl12xx_cmd_set_peer_state(struct wl1271 *wl, struct wl12xx_vif *wlvif,
85 int wl12xx_roc(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 role_id,
86 enum ieee80211_band band, u8 channel);
87 int wl12xx_croc(struct wl1271 *wl, u8 role_id);
88 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
89 struct ieee80211_sta *sta, u8 hlid);
90 int wl12xx_cmd_remove_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
92 void wlcore_set_pending_regdomain_ch(struct wl1271 *wl, u16 channel,
93 enum ieee80211_band band);
94 int wlcore_cmd_regdomain_config_locked(struct wl1271 *wl);
95 int wlcore_cmd_generic_cfg(struct wl1271 *wl, struct wl12xx_vif *wlvif,
96 u8 feature, u8 enable, u8 value);
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);
110 u8 wlcore_get_native_channel_type(u8 nl_channel_type);
112 enum wl1271_commands {
113 CMD_INTERROGATE = 1, /* use this to read information elements */
114 CMD_CONFIGURE = 2, /* use this to write information elements */
122 CMD_READ_MEMORY = 10,
123 CMD_WRITE_MEMORY = 11,
124 CMD_SET_TEMPLATE = 12,
127 CMD_QUIET_ELEMENT_SET_STATE = 15,
128 CMD_SET_BCN_MODE = 16,
130 CMD_MEASUREMENT = 17,
131 CMD_STOP_MEASUREMENT = 18,
132 CMD_SET_PS_MODE = 19,
133 CMD_CHANNEL_SWITCH = 20,
134 CMD_STOP_CHANNEL_SWICTH = 21,
135 CMD_AP_DISCOVERY = 22,
136 CMD_STOP_AP_DISCOVERY = 23,
137 CMD_HEALTH_CHECK = 24,
139 CMD_TRIGGER_SCAN_TO = 26,
140 CMD_CONNECTION_SCAN_CFG = 27,
141 CMD_CONNECTION_SCAN_SSID_CFG = 28,
142 CMD_START_PERIODIC_SCAN = 29,
143 CMD_STOP_PERIODIC_SCAN = 30,
144 CMD_SET_PEER_STATE = 31,
145 CMD_REMAIN_ON_CHANNEL = 32,
146 CMD_CANCEL_REMAIN_ON_CHANNEL = 33,
147 CMD_CONFIG_FWLOGGER = 34,
148 CMD_START_FWLOGGER = 35,
149 CMD_STOP_FWLOGGER = 36,
151 /* Access point commands */
153 CMD_REMOVE_PEER = 38,
156 CMD_ROLE_ENABLE = 39,
157 CMD_ROLE_DISABLE = 40,
162 CMD_START_RADAR_DETECTION = 43,
163 CMD_STOP_RADAR_DETECTION = 44,
166 CMD_WFD_START_DISCOVERY = 45,
167 CMD_WFD_STOP_DISCOVERY = 46,
168 CMD_WFD_ATTRIBUTE_CONFIG = 47,
169 CMD_GENERIC_CFG = 48,
172 /* start of 18xx specific commands */
173 CMD_DFS_CHANNEL_CONFIG = 60,
174 CMD_SMART_CONFIG_START = 61,
175 CMD_SMART_CONFIG_STOP = 62,
176 CMD_SMART_CONFIG_SET_GROUP_KEY = 63,
180 CMD_DFS_MASTER_RESTART = 66,
181 CMD_DFS_RADAR_DETECTION_DEBUG = 67,
183 MAX_COMMAND_ID = 0xFFFF,
186 #define MAX_CMD_PARAMS 572
189 CMD_TEMPL_NULL_DATA = 0,
191 CMD_TEMPL_CFG_PROBE_REQ_2_4,
192 CMD_TEMPL_CFG_PROBE_REQ_5,
193 CMD_TEMPL_PROBE_RESPONSE,
194 CMD_TEMPL_QOS_NULL_DATA,
197 CMD_TEMPL_DISCONNECT,
198 CMD_TEMPL_APP_PROBE_REQ_2_4_LEGACY,
199 CMD_TEMPL_APP_PROBE_REQ_5_LEGACY,
200 CMD_TEMPL_BAR, /* for firmware internal use only */
202 * For CTS-to-self (FastCTS) mechanism
203 * for BT/WLAN coexistence (SoftGemini). */
205 CMD_TEMPL_AP_PROBE_RESPONSE,
209 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
210 CMD_TEMPL_PROBE_REQ_2_4_PERIODIC,
211 CMD_TEMPL_PROBE_REQ_5_PERIODIC,
217 #define WL1271_COMMAND_TIMEOUT 2000
218 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
219 #define WL1271_CMD_TEMPL_MAX_SIZE 512
220 #define WL1271_EVENT_TIMEOUT 5000
222 struct wl1271_cmd_header {
229 #define WL1271_CMD_MAX_PARAMS 572
231 struct wl1271_command {
232 struct wl1271_cmd_header header;
233 u8 parameters[WL1271_CMD_MAX_PARAMS];
237 CMD_MAILBOX_IDLE = 0,
238 CMD_STATUS_SUCCESS = 1,
239 CMD_STATUS_UNKNOWN_CMD = 2,
240 CMD_STATUS_UNKNOWN_IE = 3,
241 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
242 CMD_STATUS_RX_BUSY = 13,
243 CMD_STATUS_INVALID_PARAM = 14,
244 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
245 CMD_STATUS_OUT_OF_MEMORY = 16,
246 CMD_STATUS_STA_TABLE_FULL = 17,
247 CMD_STATUS_RADIO_ERROR = 18,
248 CMD_STATUS_WRONG_NESTING = 19,
249 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
250 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
251 CMD_STATUS_TEMPLATE_OOM = 23,
252 CMD_STATUS_NO_RX_BA_SESSION = 24,
257 #define CMDMBOX_HEADER_LEN 4
258 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
262 BSS_TYPE_STA_BSS = 2,
267 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
268 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
269 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
271 struct wl12xx_cmd_role_enable {
272 struct wl1271_cmd_header header;
276 u8 mac_address[ETH_ALEN];
279 struct wl12xx_cmd_role_disable {
280 struct wl1271_cmd_header header;
287 WLCORE_BAND_2_4GHZ = 0,
288 WLCORE_BAND_5GHZ = 1,
289 WLCORE_BAND_JAPAN_4_9_GHZ = 2,
290 WLCORE_BAND_DEFAULT = WLCORE_BAND_2_4GHZ,
291 WLCORE_BAND_INVALID = 0x7E,
292 WLCORE_BAND_MAX_RADIO = 0x7F,
295 enum wlcore_channel_type {
298 WLCORE_CHAN_HT40MINUS,
302 struct wl12xx_cmd_role_start {
303 struct wl1271_cmd_header header;
309 /* enum wlcore_channel_type */
318 /* sta & p2p_cli use the same struct */
321 u8 hlid; /* data hlid */
323 __le32 remote_rates; /* remote supported rates */
326 * The target uses this field to determine the rate at
327 * which to transmit control frame responses (such as
328 * ACK or CTS frames).
330 __le32 basic_rate_set;
331 __le32 local_rates; /* local supported rates */
335 u8 ssid[IEEE80211_MAX_SSID_LEN];
337 __le16 beacon_interval; /* in TBTTs */
341 u8 hlid; /* data hlid */
343 __le32 remote_rates; /* remote supported rates */
345 __le32 basic_rate_set;
346 __le32 local_rates; /* local supported rates */
350 u8 ssid[IEEE80211_MAX_SSID_LEN];
352 __le16 beacon_interval; /* in TBTTs */
356 /* ap & p2p_go use the same struct */
358 __le16 aging_period; /* in secs */
359 u8 beacon_expiry; /* in ms */
361 /* The host link id for the AP's global queue */
363 /* The host link id for the AP's broadcast queue */
366 __le16 beacon_interval; /* in TBTTs */
368 __le32 basic_rate_set;
369 __le32 local_rates; /* local supported rates */
375 u8 ssid[IEEE80211_MAX_SSID_LEN];
380 * ap supports wmm (note that there is additional
381 * per-sta wmm configuration)
386 u8 global_session_id;
392 struct wl12xx_cmd_role_stop {
393 struct wl1271_cmd_header header;
396 u8 disc_type; /* only STA and P2P_CLI */
397 __le16 reason; /* only STA and P2P_CLI */
400 struct cmd_enabledisable_path {
401 struct wl1271_cmd_header header;
407 #define WL1271_RATE_AUTOMATIC 0
409 struct wl1271_cmd_template_set {
410 struct wl1271_cmd_header header;
415 u8 index; /* relevant only for KLV_TEMPLATE type */
418 __le32 enabled_rates;
419 u8 short_retry_limit;
424 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
428 #define PARTIAL_VBM_MAX 251
436 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
439 enum wl1271_cmd_ps_mode {
440 STATION_AUTO_PS_MODE, /* Dynamic Power Save */
442 STATION_POWER_SAVE_MODE
445 struct wl1271_cmd_ps_params {
446 struct wl1271_cmd_header header;
449 u8 ps_mode; /* STATION_* */
453 /* HW encryption keys */
454 #define NUM_ACCESS_CATEGORIES_COPY 4
456 enum wl1271_cmd_key_action {
457 KEY_ADD_OR_REPLACE = 1,
460 MAX_KEY_ACTION = 0xffff,
463 enum wl1271_cmd_lid_key_type {
464 UNICAST_LID_TYPE = 0,
465 BROADCAST_LID_TYPE = 1,
466 WEP_DEFAULT_LID_TYPE = 2
469 enum wl1271_cmd_key_type {
477 struct wl1271_cmd_set_keys {
478 struct wl1271_cmd_header header;
481 * Indicates whether the HLID is a unicast key set
482 * or broadcast key set. A special value 0xFF is
483 * used to indicate that the HLID is on WEP-default
484 * (multi-hlids). of type wl1271_cmd_lid_key_type.
489 * In WEP-default network (hlid == 0xFF) used to
490 * indicate which network STA/IBSS/AP role should be
496 * Key ID - For TKIP and AES key types, this field
497 * indicates the value that should be inserted into
498 * the KeyID field of frames transmitted using this
499 * key entry. For broadcast keys the index use as a
500 * marker for TX/RX key.
501 * For WEP default network (HLID=0xFF), this field
502 * indicates the ID of the key to add or remove.
510 /* key size in bytes */
516 /* This field holds the security key data to add to the STA table */
517 u8 key[MAX_KEY_SIZE];
518 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
519 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
522 struct wl1271_cmd_test_header {
527 enum wl1271_channel_tune_bands {
528 WL1271_CHANNEL_TUNE_BAND_2_4,
529 WL1271_CHANNEL_TUNE_BAND_5,
530 WL1271_CHANNEL_TUNE_BAND_4_9
533 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
536 * There are three types of disconnections:
538 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
539 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
541 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
544 enum wl1271_disconnect_type {
545 DISCONNECT_IMMEDIATE,
550 #define WL1271_CMD_STA_STATE_CONNECTED 1
552 struct wl12xx_cmd_set_peer_state {
553 struct wl1271_cmd_header header;
559 * wmm is relevant for sta role only.
560 * ap role configures the per-sta wmm params in
561 * the add_peer command.
567 struct wl12xx_cmd_roc {
568 struct wl1271_cmd_header header;
576 struct wl12xx_cmd_croc {
577 struct wl1271_cmd_header header;
583 enum wl12xx_ssid_type {
584 WL12XX_SSID_TYPE_PUBLIC = 0,
585 WL12XX_SSID_TYPE_HIDDEN = 1,
586 WL12XX_SSID_TYPE_ANY = 2,
589 enum wl1271_psd_type {
590 WL1271_PSD_LEGACY = 0,
591 WL1271_PSD_UPSD_TRIGGER = 1,
592 WL1271_PSD_LEGACY_PSPOLL = 2,
596 struct wl12xx_cmd_add_peer {
597 struct wl1271_cmd_header header;
602 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
603 __le32 supported_rates;
612 struct wl12xx_cmd_remove_peer {
613 struct wl1271_cmd_header header;
622 * Continuous mode - packets are transferred to the host periodically
624 * On demand - Log messages are stored in a cyclic buffer in the
625 * firmware, and only transferred to the host when explicitly requested
627 enum wl12xx_fwlogger_log_mode {
628 WL12XX_FWLOG_CONTINUOUS,
629 WL12XX_FWLOG_ON_DEMAND
632 /* Include/exclude timestamps from the log messages */
633 enum wl12xx_fwlogger_timestamp {
634 WL12XX_FWLOG_TIMESTAMP_DISABLED,
635 WL12XX_FWLOG_TIMESTAMP_ENABLED
639 * Logs can be routed to the debug pinouts (where available), to the host bus
640 * (SDIO/SPI), or dropped
642 enum wl12xx_fwlogger_output {
643 WL12XX_FWLOG_OUTPUT_NONE,
644 WL12XX_FWLOG_OUTPUT_DBG_PINS,
645 WL12XX_FWLOG_OUTPUT_HOST,
648 struct wl12xx_cmd_regdomain_dfs_config {
649 struct wl1271_cmd_header header;
657 enum wlcore_generic_cfg_feature {
658 WLCORE_CFG_FEATURE_RADAR_DEBUG = 2,
661 struct wlcore_cmd_generic_cfg {
662 struct wl1271_cmd_header header;
670 struct wl12xx_cmd_config_fwlog {
671 struct wl1271_cmd_header header;
673 /* See enum wl12xx_fwlogger_log_mode */
676 /* Minimum log level threshold */
679 /* Include/exclude timestamps from the log messages */
682 /* See enum wl1271_fwlogger_output */
685 /* Regulates the frequency of log messages */
691 struct wl12xx_cmd_start_fwlog {
692 struct wl1271_cmd_header header;
695 struct wl12xx_cmd_stop_fwlog {
696 struct wl1271_cmd_header header;
699 struct wl12xx_cmd_stop_channel_switch {
700 struct wl1271_cmd_header header;
706 /* Used to check radio status after calibration */
707 #define MAX_TLV_LENGTH 500
708 #define TEST_CMD_P2G_CAL 2 /* TX BiP */
710 struct wl1271_cmd_cal_p2g {
711 struct wl1271_cmd_header header;
713 struct wl1271_cmd_test_header test;
717 u8 buf[MAX_TLV_LENGTH];
727 #endif /* __WL1271_CMD_H__ */