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 wl1271_cmd_join(struct wl1271
*wl
, u8 bss_type
);
40 int wl1271_cmd_test(struct wl1271
*wl
, void *buf
, size_t buf_len
, u8 answer
);
41 int wl1271_cmd_interrogate(struct wl1271
*wl
, u16 id
, void *buf
, size_t len
);
42 int wl1271_cmd_configure(struct wl1271
*wl
, u16 id
, void *buf
, size_t len
);
43 int wl1271_cmd_data_path(struct wl1271
*wl
, bool enable
);
44 int wl1271_cmd_ps_mode(struct wl1271
*wl
, u8 ps_mode
);
45 int wl1271_cmd_read_memory(struct wl1271
*wl
, u32 addr
, void *answer
,
47 int wl1271_cmd_template_set(struct wl1271
*wl
, u16 template_id
,
48 void *buf
, size_t buf_len
, int index
, u32 rates
);
49 int wl1271_cmd_build_null_data(struct wl1271
*wl
);
50 int wl1271_cmd_build_ps_poll(struct wl1271
*wl
, u16 aid
);
51 int wl1271_cmd_build_probe_req(struct wl1271
*wl
,
52 const u8
*ssid
, size_t ssid_len
,
53 const u8
*ie
, size_t ie_len
, u8 band
);
54 struct sk_buff
*wl1271_cmd_build_ap_probe_req(struct wl1271
*wl
,
56 int wl1271_cmd_build_arp_rsp(struct wl1271
*wl
, __be32 ip_addr
);
57 int wl1271_build_qos_null_data(struct wl1271
*wl
);
58 int wl1271_cmd_build_klv_null_data(struct wl1271
*wl
);
59 int wl1271_cmd_set_sta_default_wep_key(struct wl1271
*wl
, u8 id
);
60 int wl1271_cmd_set_ap_default_wep_key(struct wl1271
*wl
, u8 id
);
61 int wl1271_cmd_set_sta_key(struct wl1271
*wl
, u16 action
, u8 id
, u8 key_type
,
62 u8 key_size
, const u8
*key
, const u8
*addr
,
63 u32 tx_seq_32
, u16 tx_seq_16
);
64 int wl1271_cmd_set_ap_key(struct wl1271
*wl
, u16 action
, u8 id
, u8 key_type
,
65 u8 key_size
, const u8
*key
, u8 hlid
, u32 tx_seq_32
,
67 int wl1271_cmd_disconnect(struct wl1271
*wl
);
68 int wl1271_cmd_set_sta_state(struct wl1271
*wl
);
69 int wl1271_cmd_start_bss(struct wl1271
*wl
);
70 int wl1271_cmd_stop_bss(struct wl1271
*wl
);
71 int wl1271_cmd_add_sta(struct wl1271
*wl
, struct ieee80211_sta
*sta
, u8 hlid
);
72 int wl1271_cmd_remove_sta(struct wl1271
*wl
, u8 hlid
);
73 int wl12xx_cmd_config_fwlog(struct wl1271
*wl
);
74 int wl12xx_cmd_start_fwlog(struct wl1271
*wl
);
75 int wl12xx_cmd_stop_fwlog(struct wl1271
*wl
);
77 enum wl1271_commands
{
78 CMD_INTERROGATE
= 1, /*use this to read information elements*/
79 CMD_CONFIGURE
= 2, /*use this to write information elements*/
89 CMD_WRITE_MEMORY
= 14,
90 CMD_SET_TEMPLATE
= 19,
94 CMD_SET_BCN_MODE
= 33,
96 CMD_STOP_MEASUREMENT
= 35,
99 CMD_CHANNEL_SWITCH
= 38,
100 CMD_STOP_CHANNEL_SWICTH
= 39,
101 CMD_AP_DISCOVERY
= 40,
102 CMD_STOP_AP_DISCOVERY
= 41,
104 CMD_STOP_SPS_SCAN
= 43,
105 CMD_HEALTH_CHECK
= 45,
107 CMD_TRIGGER_SCAN_TO
= 47,
108 CMD_CONNECTION_SCAN_CFG
= 48,
109 CMD_CONNECTION_SCAN_SSID_CFG
= 49,
110 CMD_START_PERIODIC_SCAN
= 50,
111 CMD_STOP_PERIODIC_SCAN
= 51,
112 CMD_SET_STA_STATE
= 52,
113 CMD_CONFIG_FWLOGGER
= 53,
114 CMD_START_FWLOGGER
= 54,
115 CMD_STOP_FWLOGGER
= 55,
117 /* AP mode commands */
124 MAX_COMMAND_ID
= 0xFFFF,
127 #define MAX_CMD_PARAMS 572
130 CMD_TEMPL_KLV_IDX_NULL_DATA
= 0,
131 CMD_TEMPL_KLV_IDX_MAX
= 4
135 CMD_TEMPL_NULL_DATA
= 0,
137 CMD_TEMPL_CFG_PROBE_REQ_2_4
,
138 CMD_TEMPL_CFG_PROBE_REQ_5
,
139 CMD_TEMPL_PROBE_RESPONSE
,
140 CMD_TEMPL_QOS_NULL_DATA
,
143 CMD_TEMPL_DISCONNECT
,
144 CMD_TEMPL_PROBE_REQ_2_4
, /* for firmware internal use only */
145 CMD_TEMPL_PROBE_REQ_5
, /* for firmware internal use only */
146 CMD_TEMPL_BAR
, /* for firmware internal use only */
148 * For CTS-to-self (FastCTS) mechanism
149 * for BT/WLAN coexistence (SoftGemini). */
151 CMD_TEMPL_LINK_MEASUREMENT_REPORT
,
153 /* AP-mode specific */
154 CMD_TEMPL_AP_BEACON
= 13,
155 CMD_TEMPL_AP_PROBE_RESPONSE
,
156 CMD_TEMPL_AP_ARP_RSP
,
163 #define WL1271_COMMAND_TIMEOUT 2000
164 #define WL1271_CMD_TEMPL_MAX_SIZE 252
165 #define WL1271_EVENT_TIMEOUT 750
167 struct wl1271_cmd_header
{
174 #define WL1271_CMD_MAX_PARAMS 572
176 struct wl1271_command
{
177 struct wl1271_cmd_header header
;
178 u8 parameters
[WL1271_CMD_MAX_PARAMS
];
182 CMD_MAILBOX_IDLE
= 0,
183 CMD_STATUS_SUCCESS
= 1,
184 CMD_STATUS_UNKNOWN_CMD
= 2,
185 CMD_STATUS_UNKNOWN_IE
= 3,
186 CMD_STATUS_REJECT_MEAS_SG_ACTIVE
= 11,
187 CMD_STATUS_RX_BUSY
= 13,
188 CMD_STATUS_INVALID_PARAM
= 14,
189 CMD_STATUS_TEMPLATE_TOO_LARGE
= 15,
190 CMD_STATUS_OUT_OF_MEMORY
= 16,
191 CMD_STATUS_STA_TABLE_FULL
= 17,
192 CMD_STATUS_RADIO_ERROR
= 18,
193 CMD_STATUS_WRONG_NESTING
= 19,
194 CMD_STATUS_TIMEOUT
= 21, /* Driver internal use.*/
195 CMD_STATUS_FW_RESET
= 22, /* Driver internal use.*/
196 MAX_COMMAND_STATUS
= 0xff
199 #define CMDMBOX_HEADER_LEN 4
200 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4
204 BSS_TYPE_STA_BSS
= 2,
209 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
210 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
211 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
213 struct wl1271_cmd_join
{
214 struct wl1271_cmd_header header
;
218 __le16 beacon_interval
; /* in TBTTs */
219 __le32 rx_config_options
;
220 __le32 rx_filter_options
;
223 * The target uses this field to determine the rate at
224 * which to transmit control frame responses (such as
225 * ACK or CTS frames).
227 __le32 basic_rate_set
;
228 __le32 supported_rate_set
;
231 * bits 0-2: This bitwise field specifies the type
232 * of BSS to start or join (BSS_TYPE_*).
233 * bit 4: Band - The radio band in which to join
237 * bits 3, 5-7: Reserved
242 u8 ssid
[IW_ESSID_MAX_SIZE
];
243 u8 ctrl
; /* JOIN_CMD_CTRL_* */
247 struct cmd_enabledisable_path
{
248 struct wl1271_cmd_header header
;
254 #define WL1271_RATE_AUTOMATIC 0
256 struct wl1271_cmd_template_set
{
257 struct wl1271_cmd_header header
;
261 u8 index
; /* relevant only for KLV_TEMPLATE type */
262 __le32 enabled_rates
;
263 u8 short_retry_limit
;
267 u8 template_data
[WL1271_CMD_TEMPL_MAX_SIZE
];
271 #define PARTIAL_VBM_MAX 251
279 u8 pvb_field
[PARTIAL_VBM_MAX
]; /* Partial Virtual Bitmap */
282 enum wl1271_cmd_ps_mode
{
284 STATION_POWER_SAVE_MODE
287 struct wl1271_cmd_ps_params
{
288 struct wl1271_cmd_header header
;
290 u8 ps_mode
; /* STATION_* */
294 /* HW encryption keys */
295 #define NUM_ACCESS_CATEGORIES_COPY 4
297 enum wl1271_cmd_key_action
{
298 KEY_ADD_OR_REPLACE
= 1,
301 MAX_KEY_ACTION
= 0xffff,
304 enum wl1271_cmd_key_type
{
312 /* FIXME: Add description for key-types */
314 struct wl1271_cmd_set_sta_keys
{
315 struct wl1271_cmd_header header
;
317 /* Ignored for default WEP key */
325 /* key size in bytes */
333 * TKIP, AES: frame's key id field.
334 * For WEP default key: key id;
338 u8 key
[MAX_KEY_SIZE
];
339 __le16 ac_seq_num16
[NUM_ACCESS_CATEGORIES_COPY
];
340 __le32 ac_seq_num32
[NUM_ACCESS_CATEGORIES_COPY
];
343 enum wl1271_cmd_lid_key_type
{
344 UNICAST_LID_TYPE
= 0,
345 BROADCAST_LID_TYPE
= 1,
346 WEP_DEFAULT_LID_TYPE
= 2
349 struct wl1271_cmd_set_ap_keys
{
350 struct wl1271_cmd_header header
;
353 * Indicates whether the HLID is a unicast key set
354 * or broadcast key set. A special value 0xFF is
355 * used to indicate that the HLID is on WEP-default
356 * (multi-hlids). of type wl1271_cmd_lid_key_type.
361 * In WEP-default network (hlid == 0xFF) used to
362 * indicate which network STA/IBSS/AP role should be
368 * Key ID - For TKIP and AES key types, this field
369 * indicates the value that should be inserted into
370 * the KeyID field of frames transmitted using this
371 * key entry. For broadcast keys the index use as a
372 * marker for TX/RX key.
373 * For WEP default network (HLID=0xFF), this field
374 * indicates the ID of the key to add or remove.
382 /* key size in bytes */
388 /* This field holds the security key data to add to the STA table */
389 u8 key
[MAX_KEY_SIZE
];
390 __le16 ac_seq_num16
[NUM_ACCESS_CATEGORIES_COPY
];
391 __le32 ac_seq_num32
[NUM_ACCESS_CATEGORIES_COPY
];
394 struct wl1271_cmd_test_header
{
399 enum wl1271_channel_tune_bands
{
400 WL1271_CHANNEL_TUNE_BAND_2_4
,
401 WL1271_CHANNEL_TUNE_BAND_5
,
402 WL1271_CHANNEL_TUNE_BAND_4_9
405 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
407 #define TEST_CMD_INI_FILE_RADIO_PARAM 0x19
408 #define TEST_CMD_INI_FILE_GENERAL_PARAM 0x1E
409 #define TEST_CMD_INI_FILE_RF_EXTENDED_PARAM 0x26
411 struct wl1271_general_parms_cmd
{
412 struct wl1271_cmd_header header
;
414 struct wl1271_cmd_test_header test
;
416 struct wl1271_ini_general_params general_params
;
418 u8 sr_debug_table
[WL1271_INI_MAX_SMART_REFLEX_PARAM
];
426 struct wl128x_general_parms_cmd
{
427 struct wl1271_cmd_header header
;
429 struct wl1271_cmd_test_header test
;
431 struct wl128x_ini_general_params general_params
;
433 u8 sr_debug_table
[WL1271_INI_MAX_SMART_REFLEX_PARAM
];
441 struct wl1271_radio_parms_cmd
{
442 struct wl1271_cmd_header header
;
444 struct wl1271_cmd_test_header test
;
446 /* Static radio parameters */
447 struct wl1271_ini_band_params_2 static_params_2
;
448 struct wl1271_ini_band_params_5 static_params_5
;
450 /* Dynamic radio parameters */
451 struct wl1271_ini_fem_params_2 dyn_params_2
;
453 struct wl1271_ini_fem_params_5 dyn_params_5
;
457 struct wl128x_radio_parms_cmd
{
458 struct wl1271_cmd_header header
;
460 struct wl1271_cmd_test_header test
;
462 /* Static radio parameters */
463 struct wl128x_ini_band_params_2 static_params_2
;
464 struct wl128x_ini_band_params_5 static_params_5
;
466 u8 fem_vendor_and_options
;
468 /* Dynamic radio parameters */
469 struct wl128x_ini_fem_params_2 dyn_params_2
;
471 struct wl128x_ini_fem_params_5 dyn_params_5
;
474 struct wl1271_ext_radio_parms_cmd
{
475 struct wl1271_cmd_header header
;
477 struct wl1271_cmd_test_header test
;
479 u8 tx_per_channel_power_compensation_2
[CONF_TX_PWR_COMPENSATION_LEN_2
];
480 u8 tx_per_channel_power_compensation_5
[CONF_TX_PWR_COMPENSATION_LEN_5
];
485 * There are three types of disconnections:
487 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
488 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
490 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
493 enum wl1271_disconnect_type
{
494 DISCONNECT_IMMEDIATE
,
499 struct wl1271_cmd_disconnect
{
500 struct wl1271_cmd_header header
;
502 __le32 rx_config_options
;
503 __le32 rx_filter_options
;
511 #define WL1271_CMD_STA_STATE_CONNECTED 1
513 struct wl1271_cmd_set_sta_state
{
514 struct wl1271_cmd_header header
;
520 enum wl1271_ssid_type
{
521 SSID_TYPE_PUBLIC
= 0,
525 struct wl1271_cmd_bss_start
{
526 struct wl1271_cmd_header header
;
528 /* wl1271_ssid_type */
531 u8 ssid
[IW_ESSID_MAX_SIZE
];
535 __le32 basic_rate_set
;
536 /* Aging period in seconds*/
540 * This field specifies the time between target beacon
541 * transmission times (TBTTs), in time units (TUs).
542 * Valid values are 1 to 1024.
544 __le16 beacon_interval
;
550 /* The host link id for the AP's global queue */
552 /* The host link id for the AP's broadcast queue */
556 /* Beacon expiry time in ms */
561 struct wl1271_cmd_add_sta
{
562 struct wl1271_cmd_header header
;
567 u8 psd_type
[NUM_ACCESS_CATEGORIES_COPY
];
568 __le32 supported_rates
;
575 struct wl1271_cmd_remove_sta
{
576 struct wl1271_cmd_header header
;
585 * Continuous mode - packets are transferred to the host periodically
587 * On demand - Log messages are stored in a cyclic buffer in the
588 * firmware, and only transferred to the host when explicitly requested
590 enum wl12xx_fwlogger_log_mode
{
591 WL12XX_FWLOG_CONTINUOUS
,
592 WL12XX_FWLOG_ON_DEMAND
595 /* Include/exclude timestamps from the log messages */
596 enum wl12xx_fwlogger_timestamp
{
597 WL12XX_FWLOG_TIMESTAMP_DISABLED
,
598 WL12XX_FWLOG_TIMESTAMP_ENABLED
602 * Logs can be routed to the debug pinouts (where available), to the host bus
603 * (SDIO/SPI), or dropped
605 enum wl12xx_fwlogger_output
{
606 WL12XX_FWLOG_OUTPUT_NONE
,
607 WL12XX_FWLOG_OUTPUT_DBG_PINS
,
608 WL12XX_FWLOG_OUTPUT_HOST
,
611 struct wl12xx_cmd_config_fwlog
{
612 struct wl1271_cmd_header header
;
614 /* See enum wl12xx_fwlogger_log_mode */
617 /* Minimum log level threshold */
620 /* Include/exclude timestamps from the log messages */
623 /* See enum wl1271_fwlogger_output */
626 /* Regulates the frequency of log messages */
632 struct wl12xx_cmd_start_fwlog
{
633 struct wl1271_cmd_header header
;
636 struct wl12xx_cmd_stop_fwlog
{
637 struct wl1271_cmd_header header
;
640 #endif /* __WL1271_CMD_H__ */