1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * This file is part of wl1271
5 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
6 * Copyright (C) 2009 Nokia Corporation
8 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
18 int wl1271_cmd_send(struct wl1271 *wl, u16 id, void *buf, size_t len,
20 int wl12xx_cmd_role_enable(struct wl1271 *wl, u8 *addr, u8 role_type,
22 int wl12xx_cmd_role_disable(struct wl1271 *wl, u8 *role_id);
23 int wl12xx_cmd_role_start_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
24 int wl12xx_cmd_role_stop_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif);
25 int wl12xx_cmd_role_start_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
26 int wl12xx_cmd_role_stop_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif);
27 int wl12xx_cmd_role_start_ibss(struct wl1271 *wl, struct wl12xx_vif *wlvif);
28 int wl12xx_start_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif,
29 enum nl80211_band band, int channel);
30 int wl12xx_stop_dev(struct wl1271 *wl, struct wl12xx_vif *wlvif);
31 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
32 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf,
33 size_t cmd_len, size_t res_len);
34 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
35 int wlcore_cmd_configure_failsafe(struct wl1271 *wl, u16 id, void *buf,
36 size_t len, unsigned long valid_rets);
37 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
38 int wl1271_cmd_ps_mode(struct wl1271 *wl, struct wl12xx_vif *wlvif,
39 u8 ps_mode, u16 auto_ps_timeout);
40 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
42 int wl1271_cmd_template_set(struct wl1271 *wl, u8 role_id,
43 u16 template_id, void *buf, size_t buf_len,
44 int index, u32 rates);
45 int wl12xx_cmd_build_null_data(struct wl1271 *wl, struct wl12xx_vif *wlvif);
46 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, struct wl12xx_vif *wlvif,
48 int wl12xx_cmd_build_probe_req(struct wl1271 *wl, struct wl12xx_vif *wlvif,
50 const u8 *ssid, size_t ssid_len,
51 const u8 *ie, size_t ie_len, const u8 *common_ie,
52 size_t common_ie_len, bool sched_scan);
53 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
54 struct wl12xx_vif *wlvif,
56 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, struct wl12xx_vif *wlvif);
57 int wl1271_build_qos_null_data(struct wl1271 *wl, struct ieee80211_vif *vif);
58 int wl12xx_cmd_build_klv_null_data(struct wl1271 *wl,
59 struct wl12xx_vif *wlvif);
60 int wl12xx_cmd_set_default_wep_key(struct wl1271 *wl, u8 id, u8 hlid);
61 int wl1271_cmd_set_sta_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
62 u16 action, u8 id, u8 key_type,
63 u8 key_size, const u8 *key, const u8 *addr,
64 u32 tx_seq_32, u16 tx_seq_16);
65 int wl1271_cmd_set_ap_key(struct wl1271 *wl, struct wl12xx_vif *wlvif,
66 u16 action, u8 id, u8 key_type,
67 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
69 int wl12xx_cmd_set_peer_state(struct wl1271 *wl, struct wl12xx_vif *wlvif,
71 int wl12xx_roc(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 role_id,
72 enum nl80211_band band, u8 channel);
73 int wl12xx_croc(struct wl1271 *wl, u8 role_id);
74 int wl12xx_cmd_add_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
75 struct ieee80211_sta *sta, u8 hlid);
76 int wl12xx_cmd_remove_peer(struct wl1271 *wl, struct wl12xx_vif *wlvif,
78 void wlcore_set_pending_regdomain_ch(struct wl1271 *wl, u16 channel,
79 enum nl80211_band band);
80 int wlcore_cmd_regdomain_config_locked(struct wl1271 *wl);
81 int wlcore_cmd_generic_cfg(struct wl1271 *wl, struct wl12xx_vif *wlvif,
82 u8 feature, u8 enable, u8 value);
83 int wl12xx_cmd_config_fwlog(struct wl1271 *wl);
84 int wl12xx_cmd_start_fwlog(struct wl1271 *wl);
85 int wl12xx_cmd_stop_fwlog(struct wl1271 *wl);
86 int wl12xx_cmd_channel_switch(struct wl1271 *wl,
87 struct wl12xx_vif *wlvif,
88 struct ieee80211_channel_switch *ch_switch);
89 int wl12xx_cmd_stop_channel_switch(struct wl1271 *wl,
90 struct wl12xx_vif *wlvif);
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);
94 int wlcore_cmd_wait_for_event_or_timeout(struct wl1271 *wl,
95 u32 mask, bool *timeout);
96 u8 wlcore_get_native_channel_type(u8 nl_channel_type);
98 enum wl1271_commands {
99 CMD_INTERROGATE = 1, /* use this to read information elements */
100 CMD_CONFIGURE = 2, /* use this to write information elements */
108 CMD_READ_MEMORY = 10,
109 CMD_WRITE_MEMORY = 11,
110 CMD_SET_TEMPLATE = 12,
113 CMD_QUIET_ELEMENT_SET_STATE = 15,
114 CMD_SET_BCN_MODE = 16,
116 CMD_MEASUREMENT = 17,
117 CMD_STOP_MEASUREMENT = 18,
118 CMD_SET_PS_MODE = 19,
119 CMD_CHANNEL_SWITCH = 20,
120 CMD_STOP_CHANNEL_SWICTH = 21,
121 CMD_AP_DISCOVERY = 22,
122 CMD_STOP_AP_DISCOVERY = 23,
123 CMD_HEALTH_CHECK = 24,
125 CMD_TRIGGER_SCAN_TO = 26,
126 CMD_CONNECTION_SCAN_CFG = 27,
127 CMD_CONNECTION_SCAN_SSID_CFG = 28,
128 CMD_START_PERIODIC_SCAN = 29,
129 CMD_STOP_PERIODIC_SCAN = 30,
130 CMD_SET_PEER_STATE = 31,
131 CMD_REMAIN_ON_CHANNEL = 32,
132 CMD_CANCEL_REMAIN_ON_CHANNEL = 33,
133 CMD_CONFIG_FWLOGGER = 34,
134 CMD_START_FWLOGGER = 35,
135 CMD_STOP_FWLOGGER = 36,
137 /* Access point commands */
139 CMD_REMOVE_PEER = 38,
142 CMD_ROLE_ENABLE = 39,
143 CMD_ROLE_DISABLE = 40,
148 CMD_START_RADAR_DETECTION = 43,
149 CMD_STOP_RADAR_DETECTION = 44,
152 CMD_WFD_START_DISCOVERY = 45,
153 CMD_WFD_STOP_DISCOVERY = 46,
154 CMD_WFD_ATTRIBUTE_CONFIG = 47,
155 CMD_GENERIC_CFG = 48,
158 /* start of 18xx specific commands */
159 CMD_DFS_CHANNEL_CONFIG = 60,
160 CMD_SMART_CONFIG_START = 61,
161 CMD_SMART_CONFIG_STOP = 62,
162 CMD_SMART_CONFIG_SET_GROUP_KEY = 63,
166 CMD_DFS_MASTER_RESTART = 66,
167 CMD_DFS_RADAR_DETECTION_DEBUG = 67,
169 MAX_COMMAND_ID = 0xFFFF,
172 #define MAX_CMD_PARAMS 572
175 CMD_TEMPL_NULL_DATA = 0,
177 CMD_TEMPL_CFG_PROBE_REQ_2_4,
178 CMD_TEMPL_CFG_PROBE_REQ_5,
179 CMD_TEMPL_PROBE_RESPONSE,
180 CMD_TEMPL_QOS_NULL_DATA,
183 CMD_TEMPL_DISCONNECT,
184 CMD_TEMPL_APP_PROBE_REQ_2_4_LEGACY,
185 CMD_TEMPL_APP_PROBE_REQ_5_LEGACY,
186 CMD_TEMPL_BAR, /* for firmware internal use only */
188 * For CTS-to-self (FastCTS) mechanism
189 * for BT/WLAN coexistence (SoftGemini). */
191 CMD_TEMPL_AP_PROBE_RESPONSE,
195 CMD_TEMPL_LINK_MEASUREMENT_REPORT,
196 CMD_TEMPL_PROBE_REQ_2_4_PERIODIC,
197 CMD_TEMPL_PROBE_REQ_5_PERIODIC,
203 #define WL1271_COMMAND_TIMEOUT 2000
204 #define WL1271_CMD_TEMPL_DFLT_SIZE 252
205 #define WL1271_CMD_TEMPL_MAX_SIZE 512
206 #define WL1271_EVENT_TIMEOUT 5000
208 struct wl1271_cmd_header {
215 #define WL1271_CMD_MAX_PARAMS 572
217 struct wl1271_command {
218 struct wl1271_cmd_header header;
219 u8 parameters[WL1271_CMD_MAX_PARAMS];
223 CMD_MAILBOX_IDLE = 0,
224 CMD_STATUS_SUCCESS = 1,
225 CMD_STATUS_UNKNOWN_CMD = 2,
226 CMD_STATUS_UNKNOWN_IE = 3,
227 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
228 CMD_STATUS_RX_BUSY = 13,
229 CMD_STATUS_INVALID_PARAM = 14,
230 CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
231 CMD_STATUS_OUT_OF_MEMORY = 16,
232 CMD_STATUS_STA_TABLE_FULL = 17,
233 CMD_STATUS_RADIO_ERROR = 18,
234 CMD_STATUS_WRONG_NESTING = 19,
235 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
236 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
237 CMD_STATUS_TEMPLATE_OOM = 23,
238 CMD_STATUS_NO_RX_BA_SESSION = 24,
243 #define CMDMBOX_HEADER_LEN 4
244 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
248 BSS_TYPE_STA_BSS = 2,
253 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
254 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
255 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
257 struct wl12xx_cmd_role_enable {
258 struct wl1271_cmd_header header;
262 u8 mac_address[ETH_ALEN];
265 struct wl12xx_cmd_role_disable {
266 struct wl1271_cmd_header header;
273 WLCORE_BAND_2_4GHZ = 0,
274 WLCORE_BAND_5GHZ = 1,
275 WLCORE_BAND_JAPAN_4_9_GHZ = 2,
276 WLCORE_BAND_DEFAULT = WLCORE_BAND_2_4GHZ,
277 WLCORE_BAND_INVALID = 0x7E,
278 WLCORE_BAND_MAX_RADIO = 0x7F,
281 enum wlcore_channel_type {
284 WLCORE_CHAN_HT40MINUS,
288 struct wl12xx_cmd_role_start {
289 struct wl1271_cmd_header header;
295 /* enum wlcore_channel_type */
304 /* sta & p2p_cli use the same struct */
307 u8 hlid; /* data hlid */
309 __le32 remote_rates; /* remote supported rates */
312 * The target uses this field to determine the rate at
313 * which to transmit control frame responses (such as
314 * ACK or CTS frames).
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 u8 hlid; /* data hlid */
329 __le32 remote_rates; /* remote supported rates */
331 __le32 basic_rate_set;
332 __le32 local_rates; /* local supported rates */
336 u8 ssid[IEEE80211_MAX_SSID_LEN];
338 __le16 beacon_interval; /* in TBTTs */
342 /* ap & p2p_go use the same struct */
344 __le16 aging_period; /* in secs */
345 u8 beacon_expiry; /* in ms */
347 /* The host link id for the AP's global queue */
349 /* The host link id for the AP's broadcast queue */
352 __le16 beacon_interval; /* in TBTTs */
354 __le32 basic_rate_set;
355 __le32 local_rates; /* local supported rates */
361 u8 ssid[IEEE80211_MAX_SSID_LEN];
366 * ap supports wmm (note that there is additional
367 * per-sta wmm configuration)
372 u8 global_session_id;
378 struct wl12xx_cmd_role_stop {
379 struct wl1271_cmd_header header;
382 u8 disc_type; /* only STA and P2P_CLI */
383 __le16 reason; /* only STA and P2P_CLI */
386 struct cmd_enabledisable_path {
387 struct wl1271_cmd_header header;
393 #define WL1271_RATE_AUTOMATIC 0
395 struct wl1271_cmd_template_set {
396 struct wl1271_cmd_header header;
401 u8 index; /* relevant only for KLV_TEMPLATE type */
404 __le32 enabled_rates;
405 u8 short_retry_limit;
410 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
414 #define PARTIAL_VBM_MAX 251
422 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
425 enum wl1271_cmd_ps_mode {
426 STATION_AUTO_PS_MODE, /* Dynamic Power Save */
428 STATION_POWER_SAVE_MODE
431 struct wl1271_cmd_ps_params {
432 struct wl1271_cmd_header header;
435 u8 ps_mode; /* STATION_* */
439 /* HW encryption keys */
440 #define NUM_ACCESS_CATEGORIES_COPY 4
442 enum wl1271_cmd_key_action {
443 KEY_ADD_OR_REPLACE = 1,
446 MAX_KEY_ACTION = 0xffff,
449 enum wl1271_cmd_lid_key_type {
450 UNICAST_LID_TYPE = 0,
451 BROADCAST_LID_TYPE = 1,
452 WEP_DEFAULT_LID_TYPE = 2
455 enum wl1271_cmd_key_type {
463 struct wl1271_cmd_set_keys {
464 struct wl1271_cmd_header header;
467 * Indicates whether the HLID is a unicast key set
468 * or broadcast key set. A special value 0xFF is
469 * used to indicate that the HLID is on WEP-default
470 * (multi-hlids). of type wl1271_cmd_lid_key_type.
475 * In WEP-default network (hlid == 0xFF) used to
476 * indicate which network STA/IBSS/AP role should be
482 * Key ID - For TKIP and AES key types, this field
483 * indicates the value that should be inserted into
484 * the KeyID field of frames transmitted using this
485 * key entry. For broadcast keys the index use as a
486 * marker for TX/RX key.
487 * For WEP default network (HLID=0xFF), this field
488 * indicates the ID of the key to add or remove.
496 /* key size in bytes */
502 /* This field holds the security key data to add to the STA table */
503 u8 key[MAX_KEY_SIZE];
504 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
505 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
508 struct wl1271_cmd_test_header {
513 enum wl1271_channel_tune_bands {
514 WL1271_CHANNEL_TUNE_BAND_2_4,
515 WL1271_CHANNEL_TUNE_BAND_5,
516 WL1271_CHANNEL_TUNE_BAND_4_9
519 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
522 * There are three types of disconnections:
524 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
525 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
527 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
530 enum wl1271_disconnect_type {
531 DISCONNECT_IMMEDIATE,
536 #define WL1271_CMD_STA_STATE_CONNECTED 1
538 struct wl12xx_cmd_set_peer_state {
539 struct wl1271_cmd_header header;
545 * wmm is relevant for sta role only.
546 * ap role configures the per-sta wmm params in
547 * the add_peer command.
553 struct wl12xx_cmd_roc {
554 struct wl1271_cmd_header header;
562 struct wl12xx_cmd_croc {
563 struct wl1271_cmd_header header;
569 enum wl12xx_ssid_type {
570 WL12XX_SSID_TYPE_PUBLIC = 0,
571 WL12XX_SSID_TYPE_HIDDEN = 1,
572 WL12XX_SSID_TYPE_ANY = 2,
575 enum wl1271_psd_type {
576 WL1271_PSD_LEGACY = 0,
577 WL1271_PSD_UPSD_TRIGGER = 1,
578 WL1271_PSD_LEGACY_PSPOLL = 2,
582 struct wl12xx_cmd_add_peer {
583 struct wl1271_cmd_header header;
588 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
589 __le32 supported_rates;
598 struct wl12xx_cmd_remove_peer {
599 struct wl1271_cmd_header header;
608 * Continuous mode - packets are transferred to the host periodically
610 * On demand - Log messages are stored in a cyclic buffer in the
611 * firmware, and only transferred to the host when explicitly requested
613 enum wl12xx_fwlogger_log_mode {
614 WL12XX_FWLOG_CONTINUOUS,
617 /* Include/exclude timestamps from the log messages */
618 enum wl12xx_fwlogger_timestamp {
619 WL12XX_FWLOG_TIMESTAMP_DISABLED,
620 WL12XX_FWLOG_TIMESTAMP_ENABLED
624 * Logs can be routed to the debug pinouts (where available), to the host bus
625 * (SDIO/SPI), or dropped
627 enum wl12xx_fwlogger_output {
628 WL12XX_FWLOG_OUTPUT_NONE,
629 WL12XX_FWLOG_OUTPUT_DBG_PINS,
630 WL12XX_FWLOG_OUTPUT_HOST,
633 struct wl12xx_cmd_regdomain_dfs_config {
634 struct wl1271_cmd_header header;
642 enum wlcore_generic_cfg_feature {
643 WLCORE_CFG_FEATURE_RADAR_DEBUG = 2,
646 struct wlcore_cmd_generic_cfg {
647 struct wl1271_cmd_header header;
655 struct wl12xx_cmd_config_fwlog {
656 struct wl1271_cmd_header header;
658 /* See enum wl12xx_fwlogger_log_mode */
661 /* Minimum log level threshold */
664 /* Include/exclude timestamps from the log messages */
667 /* See enum wl1271_fwlogger_output */
670 /* Regulates the frequency of log messages */
676 struct wl12xx_cmd_start_fwlog {
677 struct wl1271_cmd_header header;
680 struct wl12xx_cmd_stop_fwlog {
681 struct wl1271_cmd_header header;
684 struct wl12xx_cmd_stop_channel_switch {
685 struct wl1271_cmd_header header;
691 /* Used to check radio status after calibration */
692 #define MAX_TLV_LENGTH 500
693 #define TEST_CMD_P2G_CAL 2 /* TX BiP */
695 struct wl1271_cmd_cal_p2g {
696 struct wl1271_cmd_header header;
698 struct wl1271_cmd_test_header test;
702 u8 buf[MAX_TLV_LENGTH];
712 #endif /* __WL1271_CMD_H__ */