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 int wl12xx_stop_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif);
44 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
45 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len);
46 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
47 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
48 int wl1271_cmd_ps_mode(struct wl1271 *wl, struct wl12xx_vif *wlvif,
49 u8 ps_mode, u16 auto_ps_timeout);
50 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
52 int wl1271_cmd_template_set(struct wl1271 *wl, u8 role_id,
53 u16 template_id, void *buf, size_t buf_len,
54 int index, u32 rates);
55 int wl12xx_cmd_build_null_data(struct wl1271 *wl, struct wl12xx_vif *wlvif);
56 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, struct wl12xx_vif *wlvif,
58 int wl12xx_cmd_build_probe_req(struct wl1271 *wl, struct wl12xx_vif *wlvif,
60 const u8 *ssid, size_t ssid_len,
61 const u8 *ie, size_t ie_len, bool sched_scan);
62 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
63 struct wl12xx_vif *wlvif,
65 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, struct wl12xx_vif *wlvif);
66 int wl1271_build_qos_null_data(struct wl1271 *wl, struct ieee80211_vif *vif);
67 int wl12xx_cmd_build_klv_null_data(struct wl1271 *wl,
68 struct wl12xx_vif *wlvif);
69 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
70 int wl1271_cmd_set_sta_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
71 u16 action, u8 id, u8 key_type,
72 u8 key_size, const u8 *key, const u8 *addr,
73 u32 tx_seq_32, u16 tx_seq_16);
74 int wl1271_cmd_set_ap_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
75 u16 action, u8 id, u8 key_type,
76 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
78 int wl12xx_cmd_set_peer_state(struct wl1271 *wl, u8 hlid);
79 int wl12xx_roc(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 role_id);
80 int wl12xx_croc(struct wl1271 *wl, u8 role_id);
81 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
82 struct ieee80211_sta *sta, u8 hlid);
83 int wl12xx_cmd_remove_peer(struct wl1271 *wl, u8 hlid);
84 int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
85 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
86 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
87 int wl12xx_cmd_channel_switch(struct wl1271 *wl,
88 struct wl12xx_vif *wlvif,
89 struct ieee80211_channel_switch *ch_switch);
90 int wl12xx_cmd_stop_channel_switch(struct wl1271 *wl);
91 int wl12xx_allocate_link(struct wl1271 *wl, struct wl12xx_vif *wlvif,
93 void wl12xx_free_link(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 *hlid);
95 enum wl1271_commands {
96 CMD_INTERROGATE = 1, /* use this to read information elements */
97 CMD_CONFIGURE = 2, /* use this to write information elements */
105 CMD_READ_MEMORY = 10,
106 CMD_WRITE_MEMORY = 11,
107 CMD_SET_TEMPLATE = 12,
110 CMD_QUIET_ELEMENT_SET_STATE = 15,
111 CMD_SET_BCN_MODE = 16,
113 CMD_MEASUREMENT = 17,
114 CMD_STOP_MEASUREMENT = 18,
115 CMD_SET_PS_MODE = 19,
116 CMD_CHANNEL_SWITCH = 20,
117 CMD_STOP_CHANNEL_SWICTH = 21,
118 CMD_AP_DISCOVERY = 22,
119 CMD_STOP_AP_DISCOVERY = 23,
120 CMD_HEALTH_CHECK = 24,
122 CMD_TRIGGER_SCAN_TO = 26,
123 CMD_CONNECTION_SCAN_CFG = 27,
124 CMD_CONNECTION_SCAN_SSID_CFG = 28,
125 CMD_START_PERIODIC_SCAN = 29,
126 CMD_STOP_PERIODIC_SCAN = 30,
127 CMD_SET_PEER_STATE = 31,
128 CMD_REMAIN_ON_CHANNEL = 32,
129 CMD_CANCEL_REMAIN_ON_CHANNEL = 33,
130 CMD_CONFIG_FWLOGGER = 34,
131 CMD_START_FWLOGGER = 35,
132 CMD_STOP_FWLOGGER = 36,
134 /* Access point commands */
136 CMD_REMOVE_PEER = 38,
139 CMD_ROLE_ENABLE = 39,
140 CMD_ROLE_DISABLE = 40,
145 CMD_START_RADAR_DETECTION = 43,
146 CMD_STOP_RADAR_DETECTION = 44,
149 CMD_WFD_START_DISCOVERY = 45,
150 CMD_WFD_STOP_DISCOVERY = 46,
151 CMD_WFD_ATTRIBUTE_CONFIG = 47,
155 MAX_COMMAND_ID = 0xFFFF,
158 #define MAX_CMD_PARAMS 572
161 CMD_TEMPL_KLV_IDX_NULL_DATA = 0,
162 CMD_TEMPL_KLV_IDX_MAX = 4
166 CMD_TEMPL_NULL_DATA = 0,
168 CMD_TEMPL_CFG_PROBE_REQ_2_4,
169 CMD_TEMPL_CFG_PROBE_REQ_5,
170 CMD_TEMPL_PROBE_RESPONSE,
171 CMD_TEMPL_QOS_NULL_DATA,
174 CMD_TEMPL_DISCONNECT,
175 CMD_TEMPL_APP_PROBE_REQ_2_4,
176 CMD_TEMPL_APP_PROBE_REQ_5,
177 CMD_TEMPL_BAR, /* for firmware internal use only */
179 * For CTS-to-self (FastCTS) mechanism
180 * for BT/WLAN coexistence (SoftGemini). */
182 CMD_TEMPL_AP_PROBE_RESPONSE,
186 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
192 #define WL1271_COMMAND_TIMEOUT 2000
193 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
194 #define WL1271_CMD_TEMPL_MAX_SIZE 512
195 #define WL1271_EVENT_TIMEOUT 1500
197 struct wl1271_cmd_header {
204 #define WL1271_CMD_MAX_PARAMS 572
206 struct wl1271_command {
207 struct wl1271_cmd_header header;
208 u8 parameters[WL1271_CMD_MAX_PARAMS];
212 CMD_MAILBOX_IDLE = 0,
213 CMD_STATUS_SUCCESS = 1,
214 CMD_STATUS_UNKNOWN_CMD = 2,
215 CMD_STATUS_UNKNOWN_IE = 3,
216 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
217 CMD_STATUS_RX_BUSY = 13,
218 CMD_STATUS_INVALID_PARAM = 14,
219 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
220 CMD_STATUS_OUT_OF_MEMORY = 16,
221 CMD_STATUS_STA_TABLE_FULL = 17,
222 CMD_STATUS_RADIO_ERROR = 18,
223 CMD_STATUS_WRONG_NESTING = 19,
224 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
225 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
226 CMD_STATUS_TEMPLATE_OOM = 23,
227 CMD_STATUS_NO_RX_BA_SESSION = 24,
228 MAX_COMMAND_STATUS = 0xff
231 #define CMDMBOX_HEADER_LEN 4
232 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
236 BSS_TYPE_STA_BSS = 2,
241 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
242 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
243 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
245 struct wl12xx_cmd_role_enable {
246 struct wl1271_cmd_header header;
250 u8 mac_address[ETH_ALEN];
253 struct wl12xx_cmd_role_disable {
254 struct wl1271_cmd_header header;
261 WLCORE_BAND_2_4GHZ = 0,
262 WLCORE_BAND_5GHZ = 1,
263 WLCORE_BAND_JAPAN_4_9_GHZ = 2,
264 WLCORE_BAND_DEFAULT = WLCORE_BAND_2_4GHZ,
265 WLCORE_BAND_INVALID = 0x7E,
266 WLCORE_BAND_MAX_RADIO = 0x7F,
269 enum wlcore_channel_type {
272 WLCORE_CHAN_HT40MINUS,
276 struct wl12xx_cmd_role_start {
277 struct wl1271_cmd_header header;
283 /* enum wlcore_channel_type */
292 /* sta & p2p_cli use the same struct */
295 u8 hlid; /* data hlid */
297 __le32 remote_rates; /* remote supported rates */
300 * The target uses this field to determine the rate at
301 * which to transmit control frame responses (such as
302 * ACK or CTS frames).
304 __le32 basic_rate_set;
305 __le32 local_rates; /* local supported rates */
309 u8 ssid[IEEE80211_MAX_SSID_LEN];
311 __le16 beacon_interval; /* in TBTTs */
315 u8 hlid; /* data hlid */
317 __le32 remote_rates; /* remote supported rates */
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 /* ap & p2p_go use the same struct */
332 __le16 aging_period; /* in secs */
333 u8 beacon_expiry; /* in ms */
335 /* The host link id for the AP's global queue */
337 /* The host link id for the AP's broadcast queue */
340 __le16 beacon_interval; /* in TBTTs */
342 __le32 basic_rate_set;
343 __le32 local_rates; /* local supported rates */
349 u8 ssid[IEEE80211_MAX_SSID_LEN];
358 struct wl12xx_cmd_role_stop {
359 struct wl1271_cmd_header header;
362 u8 disc_type; /* only STA and P2P_CLI */
363 __le16 reason; /* only STA and P2P_CLI */
366 struct cmd_enabledisable_path {
367 struct wl1271_cmd_header header;
373 #define WL1271_RATE_AUTOMATIC 0
375 struct wl1271_cmd_template_set {
376 struct wl1271_cmd_header header;
381 u8 index; /* relevant only for KLV_TEMPLATE type */
384 __le32 enabled_rates;
385 u8 short_retry_limit;
390 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
394 #define PARTIAL_VBM_MAX 251
402 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
405 enum wl1271_cmd_ps_mode {
406 STATION_AUTO_PS_MODE, /* Dynamic Power Save */
408 STATION_POWER_SAVE_MODE
411 struct wl1271_cmd_ps_params {
412 struct wl1271_cmd_header header;
415 u8 ps_mode; /* STATION_* */
419 /* HW encryption keys */
420 #define NUM_ACCESS_CATEGORIES_COPY 4
422 enum wl1271_cmd_key_action {
423 KEY_ADD_OR_REPLACE = 1,
426 MAX_KEY_ACTION = 0xffff,
429 enum wl1271_cmd_lid_key_type {
430 UNICAST_LID_TYPE = 0,
431 BROADCAST_LID_TYPE = 1,
432 WEP_DEFAULT_LID_TYPE = 2
435 enum wl1271_cmd_key_type {
443 struct wl1271_cmd_set_keys {
444 struct wl1271_cmd_header header;
447 * Indicates whether the HLID is a unicast key set
448 * or broadcast key set. A special value 0xFF is
449 * used to indicate that the HLID is on WEP-default
450 * (multi-hlids). of type wl1271_cmd_lid_key_type.
455 * In WEP-default network (hlid == 0xFF) used to
456 * indicate which network STA/IBSS/AP role should be
462 * Key ID - For TKIP and AES key types, this field
463 * indicates the value that should be inserted into
464 * the KeyID field of frames transmitted using this
465 * key entry. For broadcast keys the index use as a
466 * marker for TX/RX key.
467 * For WEP default network (HLID=0xFF), this field
468 * indicates the ID of the key to add or remove.
476 /* key size in bytes */
482 /* This field holds the security key data to add to the STA table */
483 u8 key[MAX_KEY_SIZE];
484 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
485 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
488 struct wl1271_cmd_test_header {
493 enum wl1271_channel_tune_bands {
494 WL1271_CHANNEL_TUNE_BAND_2_4,
495 WL1271_CHANNEL_TUNE_BAND_5,
496 WL1271_CHANNEL_TUNE_BAND_4_9
499 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
502 * There are three types of disconnections:
504 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
505 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
507 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
510 enum wl1271_disconnect_type {
511 DISCONNECT_IMMEDIATE,
516 #define WL1271_CMD_STA_STATE_CONNECTED 1
518 struct wl12xx_cmd_set_peer_state {
519 struct wl1271_cmd_header header;
526 struct wl12xx_cmd_roc {
527 struct wl1271_cmd_header header;
535 struct wl12xx_cmd_croc {
536 struct wl1271_cmd_header header;
542 enum wl12xx_ssid_type {
543 WL12XX_SSID_TYPE_PUBLIC = 0,
544 WL12XX_SSID_TYPE_HIDDEN = 1,
545 WL12XX_SSID_TYPE_ANY = 2,
548 enum wl1271_psd_type {
549 WL1271_PSD_LEGACY = 0,
550 WL1271_PSD_UPSD_TRIGGER = 1,
551 WL1271_PSD_LEGACY_PSPOLL = 2,
555 struct wl12xx_cmd_add_peer {
556 struct wl1271_cmd_header header;
561 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
562 __le32 supported_rates;
569 struct wl12xx_cmd_remove_peer {
570 struct wl1271_cmd_header header;
579 * Continuous mode - packets are transferred to the host periodically
581 * On demand - Log messages are stored in a cyclic buffer in the
582 * firmware, and only transferred to the host when explicitly requested
584 enum wl12xx_fwlogger_log_mode {
585 WL12XX_FWLOG_CONTINUOUS,
586 WL12XX_FWLOG_ON_DEMAND
589 /* Include/exclude timestamps from the log messages */
590 enum wl12xx_fwlogger_timestamp {
591 WL12XX_FWLOG_TIMESTAMP_DISABLED,
592 WL12XX_FWLOG_TIMESTAMP_ENABLED
596 * Logs can be routed to the debug pinouts (where available), to the host bus
597 * (SDIO/SPI), or dropped
599 enum wl12xx_fwlogger_output {
600 WL12XX_FWLOG_OUTPUT_NONE,
601 WL12XX_FWLOG_OUTPUT_DBG_PINS,
602 WL12XX_FWLOG_OUTPUT_HOST,
605 struct wl12xx_cmd_config_fwlog {
606 struct wl1271_cmd_header header;
608 /* See enum wl12xx_fwlogger_log_mode */
611 /* Minimum log level threshold */
614 /* Include/exclude timestamps from the log messages */
617 /* See enum wl1271_fwlogger_output */
620 /* Regulates the frequency of log messages */
626 struct wl12xx_cmd_start_fwlog {
627 struct wl1271_cmd_header header;
630 struct wl12xx_cmd_stop_fwlog {
631 struct wl1271_cmd_header header;
634 struct wl12xx_cmd_channel_switch {
635 struct wl1271_cmd_header header;
639 /* The new serving channel */
641 /* Relative time of the serving channel switch in TBTT units */
643 /* Stop the role TX, should expect it after radar detection */
645 /* The target channel tx status 1-stopped 0-open*/
646 u8 post_switch_tx_disable;
651 struct wl12xx_cmd_stop_channel_switch {
652 struct wl1271_cmd_header header;
655 /* Used to check radio status after calibration */
656 #define MAX_TLV_LENGTH 500
657 #define TEST_CMD_P2G_CAL 2 /* TX BiP */
659 struct wl1271_cmd_cal_p2g {
660 struct wl1271_cmd_header header;
662 struct wl1271_cmd_test_header test;
666 u8 buf[MAX_TLV_LENGTH];
676 #endif /* __WL1271_CMD_H__ */