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, u8 hlid);
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 wl12xx_cmd_config_fwlog(struct wl1271 *wl);
96 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
97 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
98 int wl12xx_cmd_channel_switch(struct wl1271 *wl,
99 struct wl12xx_vif *wlvif,
100 struct ieee80211_channel_switch *ch_switch);
101 int wl12xx_cmd_stop_channel_switch(struct wl1271 *wl,
102 struct wl12xx_vif *wlvif);
103 int wl12xx_allocate_link(struct wl1271 *wl, struct wl12xx_vif *wlvif,
105 void wl12xx_free_link(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 *hlid);
106 int wlcore_cmd_wait_for_event_or_timeout(struct wl1271 *wl,
107 u32 mask, bool *timeout);
109 enum wl1271_commands {
110 CMD_INTERROGATE = 1, /* use this to read information elements */
111 CMD_CONFIGURE = 2, /* use this to write information elements */
119 CMD_READ_MEMORY = 10,
120 CMD_WRITE_MEMORY = 11,
121 CMD_SET_TEMPLATE = 12,
124 CMD_QUIET_ELEMENT_SET_STATE = 15,
125 CMD_SET_BCN_MODE = 16,
127 CMD_MEASUREMENT = 17,
128 CMD_STOP_MEASUREMENT = 18,
129 CMD_SET_PS_MODE = 19,
130 CMD_CHANNEL_SWITCH = 20,
131 CMD_STOP_CHANNEL_SWICTH = 21,
132 CMD_AP_DISCOVERY = 22,
133 CMD_STOP_AP_DISCOVERY = 23,
134 CMD_HEALTH_CHECK = 24,
136 CMD_TRIGGER_SCAN_TO = 26,
137 CMD_CONNECTION_SCAN_CFG = 27,
138 CMD_CONNECTION_SCAN_SSID_CFG = 28,
139 CMD_START_PERIODIC_SCAN = 29,
140 CMD_STOP_PERIODIC_SCAN = 30,
141 CMD_SET_PEER_STATE = 31,
142 CMD_REMAIN_ON_CHANNEL = 32,
143 CMD_CANCEL_REMAIN_ON_CHANNEL = 33,
144 CMD_CONFIG_FWLOGGER = 34,
145 CMD_START_FWLOGGER = 35,
146 CMD_STOP_FWLOGGER = 36,
148 /* Access point commands */
150 CMD_REMOVE_PEER = 38,
153 CMD_ROLE_ENABLE = 39,
154 CMD_ROLE_DISABLE = 40,
159 CMD_START_RADAR_DETECTION = 43,
160 CMD_STOP_RADAR_DETECTION = 44,
163 CMD_WFD_START_DISCOVERY = 45,
164 CMD_WFD_STOP_DISCOVERY = 46,
165 CMD_WFD_ATTRIBUTE_CONFIG = 47,
166 CMD_GENERIC_CFG = 48,
169 /* start of 18xx specific commands */
170 CMD_DFS_CHANNEL_CONFIG = 60,
172 MAX_COMMAND_ID = 0xFFFF,
175 #define MAX_CMD_PARAMS 572
178 CMD_TEMPL_NULL_DATA = 0,
180 CMD_TEMPL_CFG_PROBE_REQ_2_4,
181 CMD_TEMPL_CFG_PROBE_REQ_5,
182 CMD_TEMPL_PROBE_RESPONSE,
183 CMD_TEMPL_QOS_NULL_DATA,
186 CMD_TEMPL_DISCONNECT,
187 CMD_TEMPL_APP_PROBE_REQ_2_4_LEGACY,
188 CMD_TEMPL_APP_PROBE_REQ_5_LEGACY,
189 CMD_TEMPL_BAR, /* for firmware internal use only */
191 * For CTS-to-self (FastCTS) mechanism
192 * for BT/WLAN coexistence (SoftGemini). */
194 CMD_TEMPL_AP_PROBE_RESPONSE,
198 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
199 CMD_TEMPL_PROBE_REQ_2_4_PERIODIC,
200 CMD_TEMPL_PROBE_REQ_5_PERIODIC,
206 #define WL1271_COMMAND_TIMEOUT 2000
207 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
208 #define WL1271_CMD_TEMPL_MAX_SIZE 512
209 #define WL1271_EVENT_TIMEOUT 1500
211 struct wl1271_cmd_header {
218 #define WL1271_CMD_MAX_PARAMS 572
220 struct wl1271_command {
221 struct wl1271_cmd_header header;
222 u8 parameters[WL1271_CMD_MAX_PARAMS];
226 CMD_MAILBOX_IDLE = 0,
227 CMD_STATUS_SUCCESS = 1,
228 CMD_STATUS_UNKNOWN_CMD = 2,
229 CMD_STATUS_UNKNOWN_IE = 3,
230 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
231 CMD_STATUS_RX_BUSY = 13,
232 CMD_STATUS_INVALID_PARAM = 14,
233 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
234 CMD_STATUS_OUT_OF_MEMORY = 16,
235 CMD_STATUS_STA_TABLE_FULL = 17,
236 CMD_STATUS_RADIO_ERROR = 18,
237 CMD_STATUS_WRONG_NESTING = 19,
238 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
239 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
240 CMD_STATUS_TEMPLATE_OOM = 23,
241 CMD_STATUS_NO_RX_BA_SESSION = 24,
246 #define CMDMBOX_HEADER_LEN 4
247 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
251 BSS_TYPE_STA_BSS = 2,
256 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
257 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
258 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
260 struct wl12xx_cmd_role_enable {
261 struct wl1271_cmd_header header;
265 u8 mac_address[ETH_ALEN];
268 struct wl12xx_cmd_role_disable {
269 struct wl1271_cmd_header header;
276 WLCORE_BAND_2_4GHZ = 0,
277 WLCORE_BAND_5GHZ = 1,
278 WLCORE_BAND_JAPAN_4_9_GHZ = 2,
279 WLCORE_BAND_DEFAULT = WLCORE_BAND_2_4GHZ,
280 WLCORE_BAND_INVALID = 0x7E,
281 WLCORE_BAND_MAX_RADIO = 0x7F,
284 enum wlcore_channel_type {
287 WLCORE_CHAN_HT40MINUS,
291 struct wl12xx_cmd_role_start {
292 struct wl1271_cmd_header header;
298 /* enum wlcore_channel_type */
307 /* sta & p2p_cli use the same struct */
310 u8 hlid; /* data hlid */
312 __le32 remote_rates; /* remote supported rates */
315 * The target uses this field to determine the rate at
316 * which to transmit control frame responses (such as
317 * ACK or CTS frames).
319 __le32 basic_rate_set;
320 __le32 local_rates; /* local supported rates */
324 u8 ssid[IEEE80211_MAX_SSID_LEN];
326 __le16 beacon_interval; /* in TBTTs */
330 u8 hlid; /* data hlid */
332 __le32 remote_rates; /* remote supported rates */
334 __le32 basic_rate_set;
335 __le32 local_rates; /* local supported rates */
339 u8 ssid[IEEE80211_MAX_SSID_LEN];
341 __le16 beacon_interval; /* in TBTTs */
345 /* ap & p2p_go use the same struct */
347 __le16 aging_period; /* in secs */
348 u8 beacon_expiry; /* in ms */
350 /* The host link id for the AP's global queue */
352 /* The host link id for the AP's broadcast queue */
355 __le16 beacon_interval; /* in TBTTs */
357 __le32 basic_rate_set;
358 __le32 local_rates; /* local supported rates */
364 u8 ssid[IEEE80211_MAX_SSID_LEN];
369 * ap supports wmm (note that there is additional
370 * per-sta wmm configuration)
375 u8 global_session_id;
381 struct wl12xx_cmd_role_stop {
382 struct wl1271_cmd_header header;
385 u8 disc_type; /* only STA and P2P_CLI */
386 __le16 reason; /* only STA and P2P_CLI */
389 struct cmd_enabledisable_path {
390 struct wl1271_cmd_header header;
396 #define WL1271_RATE_AUTOMATIC 0
398 struct wl1271_cmd_template_set {
399 struct wl1271_cmd_header header;
404 u8 index; /* relevant only for KLV_TEMPLATE type */
407 __le32 enabled_rates;
408 u8 short_retry_limit;
413 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
417 #define PARTIAL_VBM_MAX 251
425 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
428 enum wl1271_cmd_ps_mode {
429 STATION_AUTO_PS_MODE, /* Dynamic Power Save */
431 STATION_POWER_SAVE_MODE
434 struct wl1271_cmd_ps_params {
435 struct wl1271_cmd_header header;
438 u8 ps_mode; /* STATION_* */
442 /* HW encryption keys */
443 #define NUM_ACCESS_CATEGORIES_COPY 4
445 enum wl1271_cmd_key_action {
446 KEY_ADD_OR_REPLACE = 1,
449 MAX_KEY_ACTION = 0xffff,
452 enum wl1271_cmd_lid_key_type {
453 UNICAST_LID_TYPE = 0,
454 BROADCAST_LID_TYPE = 1,
455 WEP_DEFAULT_LID_TYPE = 2
458 enum wl1271_cmd_key_type {
466 struct wl1271_cmd_set_keys {
467 struct wl1271_cmd_header header;
470 * Indicates whether the HLID is a unicast key set
471 * or broadcast key set. A special value 0xFF is
472 * used to indicate that the HLID is on WEP-default
473 * (multi-hlids). of type wl1271_cmd_lid_key_type.
478 * In WEP-default network (hlid == 0xFF) used to
479 * indicate which network STA/IBSS/AP role should be
485 * Key ID - For TKIP and AES key types, this field
486 * indicates the value that should be inserted into
487 * the KeyID field of frames transmitted using this
488 * key entry. For broadcast keys the index use as a
489 * marker for TX/RX key.
490 * For WEP default network (HLID=0xFF), this field
491 * indicates the ID of the key to add or remove.
499 /* key size in bytes */
505 /* This field holds the security key data to add to the STA table */
506 u8 key[MAX_KEY_SIZE];
507 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
508 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
511 struct wl1271_cmd_test_header {
516 enum wl1271_channel_tune_bands {
517 WL1271_CHANNEL_TUNE_BAND_2_4,
518 WL1271_CHANNEL_TUNE_BAND_5,
519 WL1271_CHANNEL_TUNE_BAND_4_9
522 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
525 * There are three types of disconnections:
527 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
528 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
530 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
533 enum wl1271_disconnect_type {
534 DISCONNECT_IMMEDIATE,
539 #define WL1271_CMD_STA_STATE_CONNECTED 1
541 struct wl12xx_cmd_set_peer_state {
542 struct wl1271_cmd_header header;
548 * wmm is relevant for sta role only.
549 * ap role configures the per-sta wmm params in
550 * the add_peer command.
556 struct wl12xx_cmd_roc {
557 struct wl1271_cmd_header header;
565 struct wl12xx_cmd_croc {
566 struct wl1271_cmd_header header;
572 enum wl12xx_ssid_type {
573 WL12XX_SSID_TYPE_PUBLIC = 0,
574 WL12XX_SSID_TYPE_HIDDEN = 1,
575 WL12XX_SSID_TYPE_ANY = 2,
578 enum wl1271_psd_type {
579 WL1271_PSD_LEGACY = 0,
580 WL1271_PSD_UPSD_TRIGGER = 1,
581 WL1271_PSD_LEGACY_PSPOLL = 2,
585 struct wl12xx_cmd_add_peer {
586 struct wl1271_cmd_header header;
591 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
592 __le32 supported_rates;
599 struct wl12xx_cmd_remove_peer {
600 struct wl1271_cmd_header header;
609 * Continuous mode - packets are transferred to the host periodically
611 * On demand - Log messages are stored in a cyclic buffer in the
612 * firmware, and only transferred to the host when explicitly requested
614 enum wl12xx_fwlogger_log_mode {
615 WL12XX_FWLOG_CONTINUOUS,
616 WL12XX_FWLOG_ON_DEMAND
619 /* Include/exclude timestamps from the log messages */
620 enum wl12xx_fwlogger_timestamp {
621 WL12XX_FWLOG_TIMESTAMP_DISABLED,
622 WL12XX_FWLOG_TIMESTAMP_ENABLED
626 * Logs can be routed to the debug pinouts (where available), to the host bus
627 * (SDIO/SPI), or dropped
629 enum wl12xx_fwlogger_output {
630 WL12XX_FWLOG_OUTPUT_NONE,
631 WL12XX_FWLOG_OUTPUT_DBG_PINS,
632 WL12XX_FWLOG_OUTPUT_HOST,
635 struct wl12xx_cmd_regdomain_dfs_config {
636 struct wl1271_cmd_header header;
642 struct wl12xx_cmd_config_fwlog {
643 struct wl1271_cmd_header header;
645 /* See enum wl12xx_fwlogger_log_mode */
648 /* Minimum log level threshold */
651 /* Include/exclude timestamps from the log messages */
654 /* See enum wl1271_fwlogger_output */
657 /* Regulates the frequency of log messages */
663 struct wl12xx_cmd_start_fwlog {
664 struct wl1271_cmd_header header;
667 struct wl12xx_cmd_stop_fwlog {
668 struct wl1271_cmd_header header;
671 struct wl12xx_cmd_stop_channel_switch {
672 struct wl1271_cmd_header header;
678 /* Used to check radio status after calibration */
679 #define MAX_TLV_LENGTH 500
680 #define TEST_CMD_P2G_CAL 2 /* TX BiP */
682 struct wl1271_cmd_cal_p2g {
683 struct wl1271_cmd_header header;
685 struct wl1271_cmd_test_header test;
689 u8 buf[MAX_TLV_LENGTH];
699 #endif /* __WL1271_CMD_H__ */