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 wl1271_cmd_general_parms(struct wl1271 *wl);
35 int wl128x_cmd_general_parms(struct wl1271 *wl);
36 int wl1271_cmd_radio_parms(struct wl1271 *wl);
37 int wl128x_cmd_radio_parms(struct wl1271 *wl);
38 int wl1271_cmd_ext_radio_parms(struct wl1271 *wl);
39 int wl12xx_cmd_role_enable(struct wl1271 *wl, u8 role_type, u8 *role_id);
40 int wl12xx_cmd_role_disable(struct wl1271 *wl, u8 *role_id);
41 int wl12xx_cmd_role_start_dev(struct wl1271 *wl);
42 int wl12xx_cmd_role_stop_dev(struct wl1271 *wl);
43 int wl12xx_cmd_role_start_sta(struct wl1271 *wl);
44 int wl12xx_cmd_role_stop_sta(struct wl1271 *wl);
45 int wl12xx_cmd_role_start_ap(struct wl1271 *wl);
46 int wl12xx_cmd_role_stop_ap(struct wl1271 *wl);
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, size_t len);
49 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
50 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
51 int wl1271_cmd_ps_mode(struct wl1271 *wl, u8 ps_mode);
52 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
54 int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id,
55 void *buf, size_t buf_len, int index, u32 rates);
56 int wl1271_cmd_build_null_data(struct wl1271 *wl);
57 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, u16 aid);
58 int wl1271_cmd_build_probe_req(struct wl1271 *wl,
59 const u8 *ssid, size_t ssid_len,
60 const u8 *ie, size_t ie_len, u8 band);
61 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
63 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, __be32 ip_addr);
64 int wl1271_build_qos_null_data(struct wl1271 *wl);
65 int wl1271_cmd_build_klv_null_data(struct wl1271 *wl);
66 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
67 int wl1271_cmd_set_sta_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
68 u8 key_size, const u8 *key, const u8 *addr,
69 u32 tx_seq_32, u16 tx_seq_16);
70 int wl1271_cmd_set_ap_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
71 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
73 int wl12xx_cmd_set_peer_state(struct wl1271 *wl, u8 hlid);
74 int wl12xx_roc(struct wl1271 *wl, u8 role_id);
75 int wl12xx_croc(struct wl1271 *wl, u8 role_id);
76 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct ieee80211_sta *sta, u8 hlid);
77 int wl12xx_cmd_remove_peer(struct wl1271 *wl, u8 hlid);
78 int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
79 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
80 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
82 enum wl1271_commands {
83 CMD_INTERROGATE = 1, /*use this to read information elements*/
84 CMD_CONFIGURE = 2, /*use this to write information elements*/
93 CMD_WRITE_MEMORY = 14,
94 CMD_SET_TEMPLATE = 19,
97 CMD_QUIET_ELEMENT_SET_STATE = 29,
98 CMD_SET_BCN_MODE = 33,
100 CMD_STOP_MEASUREMENT = 35,
101 CMD_SET_PS_MODE = 37,
102 CMD_CHANNEL_SWITCH = 38,
103 CMD_STOP_CHANNEL_SWICTH = 39,
104 CMD_AP_DISCOVERY = 40,
105 CMD_STOP_AP_DISCOVERY = 41,
106 CMD_HEALTH_CHECK = 45,
108 CMD_TRIGGER_SCAN_TO = 47,
109 CMD_CONNECTION_SCAN_CFG = 48,
110 CMD_CONNECTION_SCAN_SSID_CFG = 49,
111 CMD_START_PERIODIC_SCAN = 50,
112 CMD_STOP_PERIODIC_SCAN = 51,
113 CMD_SET_PEER_STATE = 52,
114 CMD_REMAIN_ON_CHANNEL = 53,
115 CMD_CANCEL_REMAIN_ON_CHANNEL = 54,
117 CMD_CONFIG_FWLOGGER = 55,
118 CMD_START_FWLOGGER = 56,
119 CMD_STOP_FWLOGGER = 57,
123 CMD_REMOVE_PEER = 63,
126 CMD_ROLE_ENABLE = 70,
127 CMD_ROLE_DISABLE = 71,
132 CMD_WFD_START_DISCOVERY = 80,
133 CMD_WFD_STOP_DISCOVERY = 81,
134 CMD_WFD_ATTRIBUTE_CONFIG = 82,
139 MAX_COMMAND_ID = 0xFFFF,
142 #define MAX_CMD_PARAMS 572
145 CMD_TEMPL_KLV_IDX_NULL_DATA = 0,
146 CMD_TEMPL_KLV_IDX_MAX = 4
150 CMD_TEMPL_NULL_DATA = 0,
152 CMD_TEMPL_CFG_PROBE_REQ_2_4,
153 CMD_TEMPL_CFG_PROBE_REQ_5,
154 CMD_TEMPL_PROBE_RESPONSE,
155 CMD_TEMPL_QOS_NULL_DATA,
158 CMD_TEMPL_DISCONNECT,
159 CMD_TEMPL_PROBE_REQ_2_4, /* for firmware internal use only */
160 CMD_TEMPL_PROBE_REQ_5, /* for firmware internal use only */
161 CMD_TEMPL_BAR, /* for firmware internal use only */
163 * For CTS-to-self (FastCTS) mechanism
164 * for BT/WLAN coexistence (SoftGemini). */
166 CMD_TEMPL_AP_PROBE_RESPONSE,
170 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
176 #define WL1271_COMMAND_TIMEOUT 2000
177 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
178 #define WL1271_CMD_TEMPL_MAX_SIZE 548
179 #define WL1271_EVENT_TIMEOUT 750
181 struct wl1271_cmd_header {
188 #define WL1271_CMD_MAX_PARAMS 572
190 struct wl1271_command {
191 struct wl1271_cmd_header header;
192 u8 parameters[WL1271_CMD_MAX_PARAMS];
196 CMD_MAILBOX_IDLE = 0,
197 CMD_STATUS_SUCCESS = 1,
198 CMD_STATUS_UNKNOWN_CMD = 2,
199 CMD_STATUS_UNKNOWN_IE = 3,
200 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
201 CMD_STATUS_RX_BUSY = 13,
202 CMD_STATUS_INVALID_PARAM = 14,
203 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
204 CMD_STATUS_OUT_OF_MEMORY = 16,
205 CMD_STATUS_STA_TABLE_FULL = 17,
206 CMD_STATUS_RADIO_ERROR = 18,
207 CMD_STATUS_WRONG_NESTING = 19,
208 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
209 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
210 CMD_STATUS_TEMPLATE_OOM = 23,
211 CMD_STATUS_NO_RX_BA_SESSION = 24,
212 MAX_COMMAND_STATUS = 0xff
215 #define CMDMBOX_HEADER_LEN 4
216 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
220 BSS_TYPE_STA_BSS = 2,
225 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
226 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
227 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
229 struct wl12xx_cmd_role_enable {
230 struct wl1271_cmd_header header;
234 u8 mac_address[ETH_ALEN];
237 struct wl12xx_cmd_role_disable {
238 struct wl1271_cmd_header header;
245 WL12XX_BAND_2_4GHZ = 0,
246 WL12XX_BAND_5GHZ = 1,
247 WL12XX_BAND_JAPAN_4_9_GHZ = 2,
248 WL12XX_BAND_DEFAULT = WL12XX_BAND_2_4GHZ,
249 WL12XX_BAND_INVALID = 0x7E,
250 WL12XX_BAND_MAX_RADIO = 0x7F,
253 struct wl12xx_cmd_role_start {
254 struct wl1271_cmd_header header;
267 /* sta & p2p_cli use the same struct */
270 u8 hlid; /* data hlid */
272 __le32 remote_rates; /* remote supported rates */
275 * The target uses this field to determine the rate at
276 * which to transmit control frame responses (such as
277 * ACK or CTS frames).
279 __le32 basic_rate_set;
280 __le32 local_rates; /* local supported rates */
284 u8 ssid[IEEE80211_MAX_SSID_LEN];
286 __le16 beacon_interval; /* in TBTTs */
290 u8 hlid; /* data hlid */
292 __le32 remote_rates; /* remote supported rates */
294 __le32 basic_rate_set;
295 __le32 local_rates; /* local supported rates */
299 u8 ssid[IEEE80211_MAX_SSID_LEN];
301 __le16 beacon_interval; /* in TBTTs */
305 /* ap & p2p_go use the same struct */
307 __le16 aging_period; /* in secs */
308 u8 beacon_expiry; /* in ms */
310 /* The host link id for the AP's global queue */
312 /* The host link id for the AP's broadcast queue */
315 __le16 beacon_interval; /* in TBTTs */
317 __le32 basic_rate_set;
318 __le32 local_rates; /* local supported rates */
324 u8 ssid[IEEE80211_MAX_SSID_LEN];
331 struct wl12xx_cmd_role_stop {
332 struct wl1271_cmd_header header;
335 u8 disc_type; /* only STA and P2P_CLI */
336 __le16 reason; /* only STA and P2P_CLI */
339 struct cmd_enabledisable_path {
340 struct wl1271_cmd_header header;
346 #define WL1271_RATE_AUTOMATIC 0
348 struct wl1271_cmd_template_set {
349 struct wl1271_cmd_header header;
353 u8 index; /* relevant only for KLV_TEMPLATE type */
354 __le32 enabled_rates;
355 u8 short_retry_limit;
359 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
363 #define PARTIAL_VBM_MAX 251
371 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
374 enum wl1271_cmd_ps_mode {
376 STATION_POWER_SAVE_MODE
379 struct wl1271_cmd_ps_params {
380 struct wl1271_cmd_header header;
383 u8 ps_mode; /* STATION_* */
387 /* HW encryption keys */
388 #define NUM_ACCESS_CATEGORIES_COPY 4
390 enum wl1271_cmd_key_action {
391 KEY_ADD_OR_REPLACE = 1,
394 MAX_KEY_ACTION = 0xffff,
397 enum wl1271_cmd_lid_key_type {
398 UNICAST_LID_TYPE = 0,
399 BROADCAST_LID_TYPE = 1,
400 WEP_DEFAULT_LID_TYPE = 2
403 enum wl1271_cmd_key_type {
411 struct wl1271_cmd_set_keys {
412 struct wl1271_cmd_header header;
415 * Indicates whether the HLID is a unicast key set
416 * or broadcast key set. A special value 0xFF is
417 * used to indicate that the HLID is on WEP-default
418 * (multi-hlids). of type wl1271_cmd_lid_key_type.
423 * In WEP-default network (hlid == 0xFF) used to
424 * indicate which network STA/IBSS/AP role should be
430 * Key ID - For TKIP and AES key types, this field
431 * indicates the value that should be inserted into
432 * the KeyID field of frames transmitted using this
433 * key entry. For broadcast keys the index use as a
434 * marker for TX/RX key.
435 * For WEP default network (HLID=0xFF), this field
436 * indicates the ID of the key to add or remove.
444 /* key size in bytes */
450 /* This field holds the security key data to add to the STA table */
451 u8 key[MAX_KEY_SIZE];
452 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
453 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
456 struct wl1271_cmd_test_header {
461 enum wl1271_channel_tune_bands {
462 WL1271_CHANNEL_TUNE_BAND_2_4,
463 WL1271_CHANNEL_TUNE_BAND_5,
464 WL1271_CHANNEL_TUNE_BAND_4_9
467 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
469 #define TEST_CMD_INI_FILE_RADIO_PARAM 0x19
470 #define TEST_CMD_INI_FILE_GENERAL_PARAM 0x1E
471 #define TEST_CMD_INI_FILE_RF_EXTENDED_PARAM 0x26
473 struct wl1271_general_parms_cmd {
474 struct wl1271_cmd_header header;
476 struct wl1271_cmd_test_header test;
478 struct wl1271_ini_general_params general_params;
480 u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
488 struct wl128x_general_parms_cmd {
489 struct wl1271_cmd_header header;
491 struct wl1271_cmd_test_header test;
493 struct wl128x_ini_general_params general_params;
495 u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
503 struct wl1271_radio_parms_cmd {
504 struct wl1271_cmd_header header;
506 struct wl1271_cmd_test_header test;
508 /* Static radio parameters */
509 struct wl1271_ini_band_params_2 static_params_2;
510 struct wl1271_ini_band_params_5 static_params_5;
512 /* Dynamic radio parameters */
513 struct wl1271_ini_fem_params_2 dyn_params_2;
515 struct wl1271_ini_fem_params_5 dyn_params_5;
519 struct wl128x_radio_parms_cmd {
520 struct wl1271_cmd_header header;
522 struct wl1271_cmd_test_header test;
524 /* Static radio parameters */
525 struct wl128x_ini_band_params_2 static_params_2;
526 struct wl128x_ini_band_params_5 static_params_5;
528 u8 fem_vendor_and_options;
530 /* Dynamic radio parameters */
531 struct wl128x_ini_fem_params_2 dyn_params_2;
533 struct wl128x_ini_fem_params_5 dyn_params_5;
536 struct wl1271_ext_radio_parms_cmd {
537 struct wl1271_cmd_header header;
539 struct wl1271_cmd_test_header test;
541 u8 tx_per_channel_power_compensation_2[CONF_TX_PWR_COMPENSATION_LEN_2];
542 u8 tx_per_channel_power_compensation_5[CONF_TX_PWR_COMPENSATION_LEN_5];
547 * There are three types of disconnections:
549 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
550 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
552 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
555 enum wl1271_disconnect_type {
556 DISCONNECT_IMMEDIATE,
561 #define WL1271_CMD_STA_STATE_CONNECTED 1
563 struct wl12xx_cmd_set_peer_state {
564 struct wl1271_cmd_header header;
571 struct wl12xx_cmd_roc {
572 struct wl1271_cmd_header header;
580 struct wl12xx_cmd_croc {
581 struct wl1271_cmd_header header;
587 enum wl12xx_ssid_type {
588 WL12XX_SSID_TYPE_PUBLIC = 0,
589 WL12XX_SSID_TYPE_HIDDEN = 1,
590 WL12XX_SSID_TYPE_ANY = 2,
593 struct wl12xx_cmd_add_peer {
594 struct wl1271_cmd_header header;
599 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
600 __le32 supported_rates;
607 struct wl12xx_cmd_remove_peer {
608 struct wl1271_cmd_header header;
617 * Continuous mode - packets are transferred to the host periodically
619 * On demand - Log messages are stored in a cyclic buffer in the
620 * firmware, and only transferred to the host when explicitly requested
622 enum wl12xx_fwlogger_log_mode {
623 WL12XX_FWLOG_CONTINUOUS,
624 WL12XX_FWLOG_ON_DEMAND
627 /* Include/exclude timestamps from the log messages */
628 enum wl12xx_fwlogger_timestamp {
629 WL12XX_FWLOG_TIMESTAMP_DISABLED,
630 WL12XX_FWLOG_TIMESTAMP_ENABLED
634 * Logs can be routed to the debug pinouts (where available), to the host bus
635 * (SDIO/SPI), or dropped
637 enum wl12xx_fwlogger_output {
638 WL12XX_FWLOG_OUTPUT_NONE,
639 WL12XX_FWLOG_OUTPUT_DBG_PINS,
640 WL12XX_FWLOG_OUTPUT_HOST,
643 struct wl12xx_cmd_config_fwlog {
644 struct wl1271_cmd_header header;
646 /* See enum wl12xx_fwlogger_log_mode */
649 /* Minimum log level threshold */
652 /* Include/exclude timestamps from the log messages */
655 /* See enum wl1271_fwlogger_output */
658 /* Regulates the frequency of log messages */
664 struct wl12xx_cmd_start_fwlog {
665 struct wl1271_cmd_header header;
668 struct wl12xx_cmd_stop_fwlog {
669 struct wl1271_cmd_header header;
672 #endif /* __WL1271_CMD_H__ */