[deliverable/linux.git] / drivers / net / wireless / wl12xx / cmd.h

/*
 * This file is part of wl1271
 *
 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
 * Copyright (C) 2009 Nokia Corporation
 *
 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef __CMD_H__
#define __CMD_H__

#include "wl12xx.h"

struct acx_header;

int wl1271_cmd_send(struct wl1271 *wl, u16 id, void *buf, size_t len,
		    size_t res_len);
int wl1271_cmd_general_parms(struct wl1271 *wl);
int wl1271_cmd_radio_parms(struct wl1271 *wl);
int wl1271_cmd_ext_radio_parms(struct wl1271 *wl);
int wl1271_cmd_join(struct wl1271 *wl, u8 bss_type);
int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer);
int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len);
int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len);
int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
int wl1271_cmd_ps_mode(struct wl1271 *wl, u8 ps_mode);
int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
			   size_t len);
int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id,
			    void *buf, size_t buf_len, int index, u32 rates);
int wl1271_cmd_build_null_data(struct wl1271 *wl);
int wl1271_cmd_build_ps_poll(struct wl1271 *wl, u16 aid);
int wl1271_cmd_build_probe_req(struct wl1271 *wl,
			       const u8 *ssid, size_t ssid_len,
			       const u8 *ie, size_t ie_len, u8 band);
struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl,
					      struct sk_buff *skb);
int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, __be32 ip_addr);
int wl1271_build_qos_null_data(struct wl1271 *wl);
int wl1271_cmd_build_klv_null_data(struct wl1271 *wl);
int wl1271_cmd_set_sta_default_wep_key(struct wl1271 *wl, u8 id);
int wl1271_cmd_set_ap_default_wep_key(struct wl1271 *wl, u8 id);
int wl1271_cmd_set_sta_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
			   u8 key_size, const u8 *key, const u8 *addr,
			   u32 tx_seq_32, u16 tx_seq_16);
int wl1271_cmd_set_ap_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
			  u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
			  u16 tx_seq_16);
int wl1271_cmd_disconnect(struct wl1271 *wl);
int wl1271_cmd_set_sta_state(struct wl1271 *wl);
int wl1271_cmd_start_bss(struct wl1271 *wl);
int wl1271_cmd_stop_bss(struct wl1271 *wl);
int wl1271_cmd_add_sta(struct wl1271 *wl, struct ieee80211_sta *sta, u8 hlid);
int wl1271_cmd_remove_sta(struct wl1271 *wl, u8 hlid);

enum wl1271_commands {
	CMD_INTERROGATE     = 1,    /*use this to read information elements*/
	CMD_CONFIGURE       = 2,    /*use this to write information elements*/
	CMD_ENABLE_RX       = 3,
	CMD_ENABLE_TX       = 4,
	CMD_DISABLE_RX      = 5,
	CMD_DISABLE_TX      = 6,
	CMD_SCAN            = 8,
	CMD_STOP_SCAN       = 9,
	CMD_START_JOIN      = 11,
	CMD_SET_KEYS        = 12,
	CMD_READ_MEMORY     = 13,
	CMD_WRITE_MEMORY    = 14,
	CMD_SET_TEMPLATE    = 19,
	CMD_TEST            = 23,
	CMD_NOISE_HIST      = 28,
	CMD_LNA_CONTROL     = 32,
	CMD_SET_BCN_MODE    = 33,
	CMD_MEASUREMENT      = 34,
	CMD_STOP_MEASUREMENT = 35,
	CMD_DISCONNECT       = 36,
	CMD_SET_PS_MODE      = 37,
	CMD_CHANNEL_SWITCH   = 38,
	CMD_STOP_CHANNEL_SWICTH = 39,
	CMD_AP_DISCOVERY     = 40,
	CMD_STOP_AP_DISCOVERY = 41,
	CMD_SPS_SCAN = 42,
	CMD_STOP_SPS_SCAN = 43,
	CMD_HEALTH_CHECK     = 45,
	CMD_DEBUG            = 46,
	CMD_TRIGGER_SCAN_TO  = 47,
	CMD_CONNECTION_SCAN_CFG      = 48,
	CMD_CONNECTION_SCAN_SSID_CFG = 49,
	CMD_START_PERIODIC_SCAN      = 50,
	CMD_STOP_PERIODIC_SCAN       = 51,
	CMD_SET_STA_STATE            = 52,

	/* AP mode commands */
	CMD_BSS_START                = 60,
	CMD_BSS_STOP                 = 61,
	CMD_ADD_STA                  = 62,
	CMD_REMOVE_STA               = 63,

	NUM_COMMANDS,
	MAX_COMMAND_ID = 0xFFFF,
};

#define MAX_CMD_PARAMS 572

enum {
	CMD_TEMPL_KLV_IDX_NULL_DATA = 0,
	CMD_TEMPL_KLV_IDX_MAX = 4
};

enum cmd_templ {
	CMD_TEMPL_NULL_DATA = 0,
	CMD_TEMPL_BEACON,
	CMD_TEMPL_CFG_PROBE_REQ_2_4,
	CMD_TEMPL_CFG_PROBE_REQ_5,
	CMD_TEMPL_PROBE_RESPONSE,
	CMD_TEMPL_QOS_NULL_DATA,
	CMD_TEMPL_PS_POLL,
	CMD_TEMPL_KLV,
	CMD_TEMPL_DISCONNECT,
	CMD_TEMPL_PROBE_REQ_2_4, /* for firmware internal use only */
	CMD_TEMPL_PROBE_REQ_5,   /* for firmware internal use only */
	CMD_TEMPL_BAR,           /* for firmware internal use only */
	CMD_TEMPL_CTS,           /*
				  * For CTS-to-self (FastCTS) mechanism
				  * for BT/WLAN coexistence (SoftGemini). */
	CMD_TEMPL_ARP_RSP,
	CMD_TEMPL_LINK_MEASUREMENT_REPORT,

	/* AP-mode specific */
	CMD_TEMPL_AP_BEACON = 13,
	CMD_TEMPL_AP_PROBE_RESPONSE,
	CMD_TEMPL_AP_ARP_RSP,
	CMD_TEMPL_DEAUTH_AP,

	CMD_TEMPL_MAX = 0xff
};

/* unit ms */
#define WL1271_COMMAND_TIMEOUT     2000
#define WL1271_CMD_TEMPL_MAX_SIZE  252
#define WL1271_EVENT_TIMEOUT       750

struct wl1271_cmd_header {
	__le16 id;
	__le16 status;
	/* payload */
	u8 data[0];
} __packed;

#define WL1271_CMD_MAX_PARAMS 572

struct wl1271_command {
	struct wl1271_cmd_header header;
	u8  parameters[WL1271_CMD_MAX_PARAMS];
} __packed;

enum {
	CMD_MAILBOX_IDLE		=  0,
	CMD_STATUS_SUCCESS		=  1,
	CMD_STATUS_UNKNOWN_CMD		=  2,
	CMD_STATUS_UNKNOWN_IE		=  3,
	CMD_STATUS_REJECT_MEAS_SG_ACTIVE	= 11,
	CMD_STATUS_RX_BUSY		= 13,
	CMD_STATUS_INVALID_PARAM		= 14,
	CMD_STATUS_TEMPLATE_TOO_LARGE		= 15,
	CMD_STATUS_OUT_OF_MEMORY		= 16,
	CMD_STATUS_STA_TABLE_FULL		= 17,
	CMD_STATUS_RADIO_ERROR		= 18,
	CMD_STATUS_WRONG_NESTING		= 19,
	CMD_STATUS_TIMEOUT		= 21, /* Driver internal use.*/
	CMD_STATUS_FW_RESET		= 22, /* Driver internal use.*/
	MAX_COMMAND_STATUS		= 0xff
};

#define CMDMBOX_HEADER_LEN 4
#define CMDMBOX_INFO_ELEM_HEADER_LEN 4

enum {
	BSS_TYPE_IBSS = 0,
	BSS_TYPE_STA_BSS = 2,
	BSS_TYPE_AP_BSS = 3,
	MAX_BSS_TYPE = 0xFF
};

#define WL1271_JOIN_CMD_CTRL_TX_FLUSH     0x80 /* Firmware flushes all Tx */
#define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
#define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10

struct wl1271_cmd_join {
	struct wl1271_cmd_header header;

	__le32 bssid_lsb;
	__le16 bssid_msb;
	__le16 beacon_interval; /* in TBTTs */
	__le32 rx_config_options;
	__le32 rx_filter_options;

	/*
	 * The target uses this field to determine the rate at
	 * which to transmit control frame responses (such as
	 * ACK or CTS frames).
	 */
	__le32 basic_rate_set;
	__le32 supported_rate_set;
	u8 dtim_interval;
	/*
	 * bits 0-2: This bitwise field specifies the type
	 * of BSS to start or join (BSS_TYPE_*).
	 * bit 4: Band - The radio band in which to join
	 * or start.
	 *  0 - 2.4GHz band
	 *  1 - 5GHz band
	 * bits 3, 5-7: Reserved
	 */
	u8 bss_type;
	u8 channel;
	u8 ssid_len;
	u8 ssid[IW_ESSID_MAX_SIZE];
	u8 ctrl; /* JOIN_CMD_CTRL_* */
	u8 reserved[3];
} __packed;

struct cmd_enabledisable_path {
	struct wl1271_cmd_header header;

	u8 channel;
	u8 padding[3];
} __packed;

#define WL1271_RATE_AUTOMATIC  0

struct wl1271_cmd_template_set {
	struct wl1271_cmd_header header;

	__le16 len;
	u8 template_type;
	u8 index;  /* relevant only for KLV_TEMPLATE type */
	__le32 enabled_rates;
	u8 short_retry_limit;
	u8 long_retry_limit;
	u8 aflags;
	u8 reserved;
	u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
} __packed;

#define TIM_ELE_ID    5
#define PARTIAL_VBM_MAX    251

struct wl1271_tim {
	u8 identity;
	u8 length;
	u8 dtim_count;
	u8 dtim_period;
	u8 bitmap_ctrl;
	u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
} __packed;

enum wl1271_cmd_ps_mode {
	STATION_ACTIVE_MODE,
	STATION_POWER_SAVE_MODE
};

struct wl1271_cmd_ps_params {
	struct wl1271_cmd_header header;

	u8 ps_mode; /* STATION_* */
	u8 padding[3];
} __packed;

/* HW encryption keys */
#define NUM_ACCESS_CATEGORIES_COPY 4

enum wl1271_cmd_key_action {
	KEY_ADD_OR_REPLACE = 1,
	KEY_REMOVE         = 2,
	KEY_SET_ID         = 3,
	MAX_KEY_ACTION     = 0xffff,
};

enum wl1271_cmd_key_type {
	KEY_NONE = 0,
	KEY_WEP  = 1,
	KEY_TKIP = 2,
	KEY_AES  = 3,
	KEY_GEM  = 4,
};

/* FIXME: Add description for key-types */

struct wl1271_cmd_set_sta_keys {
	struct wl1271_cmd_header header;

	/* Ignored for default WEP key */
	u8 addr[ETH_ALEN];

	/* key_action_e */
	__le16 key_action;

	__le16 reserved_1;

	/* key size in bytes */
	u8 key_size;

	/* key_type_e */
	u8 key_type;
	u8 ssid_profile;

	/*
	 * TKIP, AES: frame's key id field.
	 * For WEP default key: key id;
	 */
	u8 id;
	u8 reserved_2[6];
	u8 key[MAX_KEY_SIZE];
	__le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
	__le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
} __packed;

enum wl1271_cmd_lid_key_type {
	UNICAST_LID_TYPE     = 0,
	BROADCAST_LID_TYPE   = 1,
	WEP_DEFAULT_LID_TYPE = 2
};

struct wl1271_cmd_set_ap_keys {
	struct wl1271_cmd_header header;

	/*
	 * Indicates whether the HLID is a unicast key set
	 * or broadcast key set. A special value 0xFF is
	 * used to indicate that the HLID is on WEP-default
	 * (multi-hlids). of type wl1271_cmd_lid_key_type.
	 */
	u8 hlid;

	/*
	 * In WEP-default network (hlid == 0xFF) used to
	 * indicate which network STA/IBSS/AP role should be
	 * changed
	 */
	u8 lid_key_type;

	/*
	 * Key ID - For TKIP and AES key types, this field
	 * indicates the value that should be inserted into
	 * the KeyID field of frames transmitted using this
	 * key entry. For broadcast keys the index use as a
	 * marker for TX/RX key.
	 * For WEP default network (HLID=0xFF), this field
	 * indicates the ID of the key to add or remove.
	 */
	u8 key_id;
	u8 reserved_1;

	/* key_action_e */
	__le16 key_action;

	/* key size in bytes */
	u8 key_size;

	/* key_type_e */
	u8 key_type;

	/* This field holds the security key data to add to the STA table */
	u8 key[MAX_KEY_SIZE];
	__le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
	__le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
} __packed;

struct wl1271_cmd_test_header {
	u8 id;
	u8 padding[3];
} __packed;

enum wl1271_channel_tune_bands {
	WL1271_CHANNEL_TUNE_BAND_2_4,
	WL1271_CHANNEL_TUNE_BAND_5,
	WL1271_CHANNEL_TUNE_BAND_4_9
};

#define WL1271_PD_REFERENCE_POINT_BAND_B_G  0

#define TEST_CMD_INI_FILE_RADIO_PARAM       0x19
#define TEST_CMD_INI_FILE_GENERAL_PARAM     0x1E
#define TEST_CMD_INI_FILE_RF_EXTENDED_PARAM 0x26

struct wl1271_general_parms_cmd {
	struct wl1271_cmd_header header;

	struct wl1271_cmd_test_header test;

	struct wl1271_ini_general_params general_params;

	u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
	u8 sr_sen_n_p;
	u8 sr_sen_n_p_gain;
	u8 sr_sen_nrn;
	u8 sr_sen_prn;
	u8 padding[3];
} __packed;

struct wl1271_radio_parms_cmd {
	struct wl1271_cmd_header header;

	struct wl1271_cmd_test_header test;

	/* Static radio parameters */
	struct wl1271_ini_band_params_2 static_params_2;
	struct wl1271_ini_band_params_5 static_params_5;

	/* Dynamic radio parameters */
	struct wl1271_ini_fem_params_2 dyn_params_2;
	u8 padding2;
	struct wl1271_ini_fem_params_5 dyn_params_5;
	u8 padding3[2];
} __packed;

struct wl1271_ext_radio_parms_cmd {
	struct wl1271_cmd_header header;

	struct wl1271_cmd_test_header test;

	u8 tx_per_channel_power_compensation_2[CONF_TX_PWR_COMPENSATION_LEN_2];
	u8 tx_per_channel_power_compensation_5[CONF_TX_PWR_COMPENSATION_LEN_5];
	u8 padding[3];
} __packed;

/*
 * There are three types of disconnections:
 *
 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames
 * DISCONNECT_DEAUTH:    the fw generates a DEAUTH request with the reason
 *                       we have passed
 * DISCONNECT_DISASSOC:  the fw generates a DESASSOC request with the reason
 *                       we have passed
 */
enum wl1271_disconnect_type {
	DISCONNECT_IMMEDIATE,
	DISCONNECT_DEAUTH,
	DISCONNECT_DISASSOC
};

struct wl1271_cmd_disconnect {
	struct wl1271_cmd_header header;

	__le32 rx_config_options;
	__le32 rx_filter_options;

	__le16 reason;
	u8  type;

	u8  padding;
} __packed;

#define WL1271_CMD_STA_STATE_CONNECTED  1

struct wl1271_cmd_set_sta_state {
	struct wl1271_cmd_header header;

	u8 state;
	u8 padding[3];
} __packed;

enum wl1271_ssid_type {
	SSID_TYPE_PUBLIC = 0,
	SSID_TYPE_HIDDEN = 1
};

struct wl1271_cmd_bss_start {
	struct wl1271_cmd_header header;

	/* wl1271_ssid_type */
	u8 ssid_type;
	u8 ssid_len;
	u8 ssid[IW_ESSID_MAX_SIZE];
	u8 padding_1[2];

	/* Basic rate set */
	__le32 basic_rate_set;
	/* Aging period in seconds*/
	__le16 aging_period;

	/*
	 * This field specifies the time between target beacon
	 * transmission times (TBTTs), in time units (TUs).
	 * Valid values are 1 to 1024.
	 */
	__le16 beacon_interval;
	u8 bssid[ETH_ALEN];
	u8 bss_index;
	/* Radio band */
	u8 band;
	u8 channel;
	/* The host link id for the AP's global queue */
	u8 global_hlid;
	/* The host link id for the AP's broadcast queue */
	u8 broadcast_hlid;
	/* DTIM count */
	u8 dtim_interval;
	/* Beacon expiry time in ms */
	u8 beacon_expiry;
	u8 padding_2[3];
} __packed;

struct wl1271_cmd_add_sta {
	struct wl1271_cmd_header header;

	u8 addr[ETH_ALEN];
	u8 hlid;
	u8 aid;
	u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
	__le32 supported_rates;
	u8 bss_index;
	u8 sp_len;
	u8 wmm;
	u8 padding1;
} __packed;

struct wl1271_cmd_remove_sta {
	struct wl1271_cmd_header header;

	u8 hlid;
	u8 reason_opcode;
	u8 send_deauth_flag;
	u8 padding1;
} __packed;

#endif /* __WL1271_CMD_H__ */
Commit	Line	Data
f5fc0f86 LC	1	/*
	2	* This file is part of wl1271
	3	*
	4	* Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
	5	* Copyright (C) 2009 Nokia Corporation
	6	*
	7	* Contact: Luciano Coelho <luciano.coelho@nokia.com>
	8	*
	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.
	12	*
	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.
	17	*
	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
	21	* 02110-1301 USA
	22	*
	23	*/
	24
00d20100 SL	25	#ifndef __CMD_H__
00d20100 SL	26	#define __CMD_H__
f5fc0f86	27
00d20100	28	#include "wl12xx.h"
f5fc0f86 LC	29
	30	struct acx_header;
	31
fa867e73 JO	32	int wl1271_cmd_send(struct wl1271 wl, u16 id, void buf, size_t len,
fa867e73 JO	33	size_t res_len);
98b5dd5d LC	34	int wl1271_cmd_general_parms(struct wl1271 *wl);
98b5dd5d LC	35	int wl1271_cmd_radio_parms(struct wl1271 *wl);
644a4860	36	int wl1271_cmd_ext_radio_parms(struct wl1271 *wl);
15305498	37	int wl1271_cmd_join(struct wl1271 *wl, u8 bss_type);
f5fc0f86 LC	38	int wl1271_cmd_test(struct wl1271 wl, void buf, size_t buf_len, u8 answer);
	39	int wl1271_cmd_interrogate(struct wl1271 wl, u16 id, void buf, size_t len);
	40	int wl1271_cmd_configure(struct wl1271 wl, u16 id, void buf, size_t len);
94210897	41	int wl1271_cmd_data_path(struct wl1271 *wl, bool enable);
c8bde243	42	int wl1271_cmd_ps_mode(struct wl1271 *wl, u8 ps_mode);
65cddbf1 JO	43	int wl1271_cmd_read_memory(struct wl1271 wl, u32 addr, void answer,
65cddbf1 JO	44	size_t len);
f5fc0f86	45	int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id,
606c1487	46	void *buf, size_t buf_len, int index, u32 rates);
f5fc0f86 LC	47	int wl1271_cmd_build_null_data(struct wl1271 *wl);
f5fc0f86 LC	48	int wl1271_cmd_build_ps_poll(struct wl1271 *wl, u16 aid);
818e3063 KV	49	int wl1271_cmd_build_probe_req(struct wl1271 *wl,
	50	const u8 *ssid, size_t ssid_len,
	51	const u8 *ie, size_t ie_len, u8 band);
2f6724b2 JO	52	struct sk_buff wl1271_cmd_build_ap_probe_req(struct wl1271 wl,
2f6724b2 JO	53	struct sk_buff *skb);
c5312772	54	int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, __be32 ip_addr);
023e0826	55	int wl1271_build_qos_null_data(struct wl1271 *wl);
bfb24c9e	56	int wl1271_cmd_build_klv_null_data(struct wl1271 *wl);
98bdaabb AN	57	int wl1271_cmd_set_sta_default_wep_key(struct wl1271 *wl, u8 id);
	58	int wl1271_cmd_set_ap_default_wep_key(struct wl1271 *wl, u8 id);
	59	int wl1271_cmd_set_sta_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
	60	u8 key_size, const u8 key, const u8 addr,
	61	u32 tx_seq_32, u16 tx_seq_16);
	62	int wl1271_cmd_set_ap_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
	63	u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32,
	64	u16 tx_seq_16);
25a7dc6d	65	int wl1271_cmd_disconnect(struct wl1271 *wl);
be86cbea	66	int wl1271_cmd_set_sta_state(struct wl1271 *wl);
98bdaabb AN	67	int wl1271_cmd_start_bss(struct wl1271 *wl);
	68	int wl1271_cmd_stop_bss(struct wl1271 *wl);
	69	int wl1271_cmd_add_sta(struct wl1271 wl, struct ieee80211_sta sta, u8 hlid);
	70	int wl1271_cmd_remove_sta(struct wl1271 *wl, u8 hlid);
f5fc0f86 LC	71
	72	enum wl1271_commands {
	73	CMD_INTERROGATE = 1, /use this to read information elements/
	74	CMD_CONFIGURE = 2, /use this to write information elements/
	75	CMD_ENABLE_RX = 3,
	76	CMD_ENABLE_TX = 4,
	77	CMD_DISABLE_RX = 5,
	78	CMD_DISABLE_TX = 6,
	79	CMD_SCAN = 8,
	80	CMD_STOP_SCAN = 9,
	81	CMD_START_JOIN = 11,
	82	CMD_SET_KEYS = 12,
	83	CMD_READ_MEMORY = 13,
	84	CMD_WRITE_MEMORY = 14,
	85	CMD_SET_TEMPLATE = 19,
	86	CMD_TEST = 23,
	87	CMD_NOISE_HIST = 28,
	88	CMD_LNA_CONTROL = 32,
	89	CMD_SET_BCN_MODE = 33,
	90	CMD_MEASUREMENT = 34,
	91	CMD_STOP_MEASUREMENT = 35,
	92	CMD_DISCONNECT = 36,
	93	CMD_SET_PS_MODE = 37,
	94	CMD_CHANNEL_SWITCH = 38,
	95	CMD_STOP_CHANNEL_SWICTH = 39,
	96	CMD_AP_DISCOVERY = 40,
	97	CMD_STOP_AP_DISCOVERY = 41,
	98	CMD_SPS_SCAN = 42,
	99	CMD_STOP_SPS_SCAN = 43,
	100	CMD_HEALTH_CHECK = 45,
	101	CMD_DEBUG = 46,
	102	CMD_TRIGGER_SCAN_TO = 47,
	103	CMD_CONNECTION_SCAN_CFG = 48,
	104	CMD_CONNECTION_SCAN_SSID_CFG = 49,
	105	CMD_START_PERIODIC_SCAN = 50,
	106	CMD_STOP_PERIODIC_SCAN = 51,
	107	CMD_SET_STA_STATE = 52,
	108
98bdaabb AN	109	/* AP mode commands */
	110	CMD_BSS_START = 60,
	111	CMD_BSS_STOP = 61,
	112	CMD_ADD_STA = 62,
	113	CMD_REMOVE_STA = 63,
	114
f5fc0f86 LC	115	NUM_COMMANDS,
	116	MAX_COMMAND_ID = 0xFFFF,
	117	};
	118
	119	#define MAX_CMD_PARAMS 572
	120
bfb24c9e JO	121	enum {
	122	CMD_TEMPL_KLV_IDX_NULL_DATA = 0,
	123	CMD_TEMPL_KLV_IDX_MAX = 4
	124	};
	125
f5fc0f86 LC	126	enum cmd_templ {
	127	CMD_TEMPL_NULL_DATA = 0,
	128	CMD_TEMPL_BEACON,
	129	CMD_TEMPL_CFG_PROBE_REQ_2_4,
	130	CMD_TEMPL_CFG_PROBE_REQ_5,
	131	CMD_TEMPL_PROBE_RESPONSE,
	132	CMD_TEMPL_QOS_NULL_DATA,
	133	CMD_TEMPL_PS_POLL,
	134	CMD_TEMPL_KLV,
	135	CMD_TEMPL_DISCONNECT,
	136	CMD_TEMPL_PROBE_REQ_2_4, /* for firmware internal use only */
	137	CMD_TEMPL_PROBE_REQ_5, /* for firmware internal use only */
	138	CMD_TEMPL_BAR, /* for firmware internal use only */
	139	CMD_TEMPL_CTS, /*
	140	* For CTS-to-self (FastCTS) mechanism
	141	* for BT/WLAN coexistence (SoftGemini). */
c5312772	142	CMD_TEMPL_ARP_RSP,
c8bde243	143	CMD_TEMPL_LINK_MEASUREMENT_REPORT,
e0fe371b AN	144
	145	/* AP-mode specific */
	146	CMD_TEMPL_AP_BEACON = 13,
	147	CMD_TEMPL_AP_PROBE_RESPONSE,
	148	CMD_TEMPL_AP_ARP_RSP,
	149	CMD_TEMPL_DEAUTH_AP,
	150
f5fc0f86 LC	151	CMD_TEMPL_MAX = 0xff
	152	};
	153
	154	/* unit ms */
	155	#define WL1271_COMMAND_TIMEOUT 2000
	156	#define WL1271_CMD_TEMPL_MAX_SIZE 252
0cbb1034	157	#define WL1271_EVENT_TIMEOUT 750
f5fc0f86 LC	158
f5fc0f86 LC	159	struct wl1271_cmd_header {
d0f63b20 LC	160	__le16 id;
d0f63b20 LC	161	__le16 status;
f5fc0f86 LC	162	/* payload */
f5fc0f86 LC	163	u8 data[0];
ba2d3587	164	} __packed;
f5fc0f86 LC	165
	166	#define WL1271_CMD_MAX_PARAMS 572
	167
	168	struct wl1271_command {
	169	struct wl1271_cmd_header header;
	170	u8 parameters[WL1271_CMD_MAX_PARAMS];
ba2d3587	171	} __packed;
f5fc0f86 LC	172
	173	enum {
	174	CMD_MAILBOX_IDLE = 0,
	175	CMD_STATUS_SUCCESS = 1,
	176	CMD_STATUS_UNKNOWN_CMD = 2,
	177	CMD_STATUS_UNKNOWN_IE = 3,
	178	CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11,
	179	CMD_STATUS_RX_BUSY = 13,
	180	CMD_STATUS_INVALID_PARAM = 14,
	181	CMD_STATUS_TEMPLATE_TOO_LARGE = 15,
	182	CMD_STATUS_OUT_OF_MEMORY = 16,
	183	CMD_STATUS_STA_TABLE_FULL = 17,
	184	CMD_STATUS_RADIO_ERROR = 18,
	185	CMD_STATUS_WRONG_NESTING = 19,
	186	CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/
	187	CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/
	188	MAX_COMMAND_STATUS = 0xff
	189	};
	190
f5fc0f86 LC	191	#define CMDMBOX_HEADER_LEN 4
	192	#define CMDMBOX_INFO_ELEM_HEADER_LEN 4
	193
	194	enum {
	195	BSS_TYPE_IBSS = 0,
	196	BSS_TYPE_STA_BSS = 2,
	197	BSS_TYPE_AP_BSS = 3,
	198	MAX_BSS_TYPE = 0xFF
	199	};
	200
	201	#define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */
	202	#define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1
a4102645	203	#define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10
f5fc0f86 LC	204
	205	struct wl1271_cmd_join {
	206	struct wl1271_cmd_header header;
	207
d0f63b20 LC	208	__le32 bssid_lsb;
	209	__le16 bssid_msb;
	210	__le16 beacon_interval; /* in TBTTs */
	211	__le32 rx_config_options;
	212	__le32 rx_filter_options;
f5fc0f86 LC	213
	214	/*
	215	* The target uses this field to determine the rate at
	216	* which to transmit control frame responses (such as
	217	* ACK or CTS frames).
	218	*/
d0f63b20	219	__le32 basic_rate_set;
c8bde243	220	__le32 supported_rate_set;
f5fc0f86 LC	221	u8 dtim_interval;
	222	/*
	223	* bits 0-2: This bitwise field specifies the type
	224	* of BSS to start or join (BSS_TYPE_*).
	225	* bit 4: Band - The radio band in which to join
	226	* or start.
	227	* 0 - 2.4GHz band
	228	* 1 - 5GHz band
	229	* bits 3, 5-7: Reserved
	230	*/
	231	u8 bss_type;
	232	u8 channel;
	233	u8 ssid_len;
	234	u8 ssid[IW_ESSID_MAX_SIZE];
	235	u8 ctrl; /* JOIN_CMD_CTRL_* */
	236	u8 reserved[3];
ba2d3587	237	} __packed;
f5fc0f86 LC	238
	239	struct cmd_enabledisable_path {
	240	struct wl1271_cmd_header header;
	241
	242	u8 channel;
	243	u8 padding[3];
ba2d3587	244	} __packed;
f5fc0f86	245
606c1487 JO	246	#define WL1271_RATE_AUTOMATIC 0
606c1487 JO	247
f5fc0f86 LC	248	struct wl1271_cmd_template_set {
	249	struct wl1271_cmd_header header;
	250
d0f63b20	251	__le16 len;
f5fc0f86 LC	252	u8 template_type;
f5fc0f86 LC	253	u8 index; /* relevant only for KLV_TEMPLATE type */
d0f63b20	254	__le32 enabled_rates;
f5fc0f86 LC	255	u8 short_retry_limit;
	256	u8 long_retry_limit;
	257	u8 aflags;
	258	u8 reserved;
	259	u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE];
ba2d3587	260	} __packed;
f5fc0f86 LC	261
	262	#define TIM_ELE_ID 5
	263	#define PARTIAL_VBM_MAX 251
	264
	265	struct wl1271_tim {
	266	u8 identity;
	267	u8 length;
	268	u8 dtim_count;
	269	u8 dtim_period;
	270	u8 bitmap_ctrl;
	271	u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */
ba2d3587	272	} __packed;
f5fc0f86 LC	273
	274	enum wl1271_cmd_ps_mode {
	275	STATION_ACTIVE_MODE,
	276	STATION_POWER_SAVE_MODE
	277	};
	278
	279	struct wl1271_cmd_ps_params {
	280	struct wl1271_cmd_header header;
	281
	282	u8 ps_mode; /* STATION_* */
c8bde243	283	u8 padding[3];
ba2d3587	284	} __packed;
f5fc0f86 LC	285
	286	/* HW encryption keys */
	287	#define NUM_ACCESS_CATEGORIES_COPY 4
f5fc0f86	288
f5fc0f86 LC	289	enum wl1271_cmd_key_action {
	290	KEY_ADD_OR_REPLACE = 1,
	291	KEY_REMOVE = 2,
	292	KEY_SET_ID = 3,
	293	MAX_KEY_ACTION = 0xffff,
	294	};
	295
	296	enum wl1271_cmd_key_type {
	297	KEY_NONE = 0,
	298	KEY_WEP = 1,
	299	KEY_TKIP = 2,
	300	KEY_AES = 3,
7a55724e	301	KEY_GEM = 4,
f5fc0f86 LC	302	};
	303
	304	/* FIXME: Add description for key-types */
	305
98bdaabb	306	struct wl1271_cmd_set_sta_keys {
f5fc0f86 LC	307	struct wl1271_cmd_header header;
	308
	309	/* Ignored for default WEP key */
	310	u8 addr[ETH_ALEN];
	311
	312	/* key_action_e */
d0f63b20	313	__le16 key_action;
f5fc0f86	314
d0f63b20	315	__le16 reserved_1;
f5fc0f86 LC	316
	317	/* key size in bytes */
	318	u8 key_size;
	319
	320	/* key_type_e */
	321	u8 key_type;
	322	u8 ssid_profile;
	323
	324	/*
	325	* TKIP, AES: frame's key id field.
	326	* For WEP default key: key id;
	327	*/
	328	u8 id;
	329	u8 reserved_2[6];
	330	u8 key[MAX_KEY_SIZE];
d0f63b20 LC	331	__le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
d0f63b20 LC	332	__le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
ba2d3587	333	} __packed;
f5fc0f86	334
98bdaabb AN	335	enum wl1271_cmd_lid_key_type {
	336	UNICAST_LID_TYPE = 0,
	337	BROADCAST_LID_TYPE = 1,
	338	WEP_DEFAULT_LID_TYPE = 2
	339	};
	340
	341	struct wl1271_cmd_set_ap_keys {
	342	struct wl1271_cmd_header header;
	343
	344	/*
	345	* Indicates whether the HLID is a unicast key set
	346	* or broadcast key set. A special value 0xFF is
	347	* used to indicate that the HLID is on WEP-default
	348	* (multi-hlids). of type wl1271_cmd_lid_key_type.
	349	*/
	350	u8 hlid;
	351
	352	/*
	353	* In WEP-default network (hlid == 0xFF) used to
	354	* indicate which network STA/IBSS/AP role should be
	355	* changed
	356	*/
	357	u8 lid_key_type;
	358
	359	/*
	360	* Key ID - For TKIP and AES key types, this field
	361	* indicates the value that should be inserted into
	362	* the KeyID field of frames transmitted using this
	363	* key entry. For broadcast keys the index use as a
	364	* marker for TX/RX key.
	365	* For WEP default network (HLID=0xFF), this field
	366	* indicates the ID of the key to add or remove.
	367	*/
	368	u8 key_id;
	369	u8 reserved_1;
	370
	371	/* key_action_e */
	372	__le16 key_action;
	373
	374	/* key size in bytes */
	375	u8 key_size;
	376
	377	/* key_type_e */
	378	u8 key_type;
	379
	380	/* This field holds the security key data to add to the STA table */
	381	u8 key[MAX_KEY_SIZE];
	382	__le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY];
	383	__le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY];
	384	} __packed;
	385
f5fc0f86 LC	386	struct wl1271_cmd_test_header {
	387	u8 id;
	388	u8 padding[3];
ba2d3587	389	} __packed;
f5fc0f86 LC	390
	391	enum wl1271_channel_tune_bands {
	392	WL1271_CHANNEL_TUNE_BAND_2_4,
	393	WL1271_CHANNEL_TUNE_BAND_5,
	394	WL1271_CHANNEL_TUNE_BAND_4_9
	395	};
	396
644a4860	397	#define WL1271_PD_REFERENCE_POINT_BAND_B_G 0
f5fc0f86	398
644a4860 JO	399	#define TEST_CMD_INI_FILE_RADIO_PARAM 0x19
	400	#define TEST_CMD_INI_FILE_GENERAL_PARAM 0x1E
	401	#define TEST_CMD_INI_FILE_RF_EXTENDED_PARAM 0x26
98b5dd5d LC	402
	403	struct wl1271_general_parms_cmd {
	404	struct wl1271_cmd_header header;
	405
	406	struct wl1271_cmd_test_header test;
	407
eb70eb72	408	struct wl1271_ini_general_params general_params;
98b5dd5d	409
eb70eb72 JO	410	u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM];
	411	u8 sr_sen_n_p;
	412	u8 sr_sen_n_p_gain;
	413	u8 sr_sen_nrn;
	414	u8 sr_sen_prn;
	415	u8 padding[3];
14599f1e	416	} __packed;
152ee6e0	417
98b5dd5d LC	418	struct wl1271_radio_parms_cmd {
	419	struct wl1271_cmd_header header;
	420
	421	struct wl1271_cmd_test_header test;
	422
eb70eb72 JO	423	/* Static radio parameters */
	424	struct wl1271_ini_band_params_2 static_params_2;
	425	struct wl1271_ini_band_params_5 static_params_5;
98b5dd5d	426
eb70eb72 JO	427	/* Dynamic radio parameters */
	428	struct wl1271_ini_fem_params_2 dyn_params_2;
	429	u8 padding2;
	430	struct wl1271_ini_fem_params_5 dyn_params_5;
	431	u8 padding3[2];
ba2d3587	432	} __packed;
f5fc0f86	433
644a4860 JO	434	struct wl1271_ext_radio_parms_cmd {
	435	struct wl1271_cmd_header header;
	436
	437	struct wl1271_cmd_test_header test;
	438
	439	u8 tx_per_channel_power_compensation_2[CONF_TX_PWR_COMPENSATION_LEN_2];
	440	u8 tx_per_channel_power_compensation_5[CONF_TX_PWR_COMPENSATION_LEN_5];
	441	u8 padding[3];
	442	} __packed;
	443
25a7dc6d LC	444	/*
	445	* There are three types of disconnections:
	446	*
	447	* DISCONNECT_IMMEDIATE: the fw doesn't send any frames
	448	* DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason
	449	* we have passed
	450	* DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason
	451	* we have passed
	452	*/
	453	enum wl1271_disconnect_type {
	454	DISCONNECT_IMMEDIATE,
	455	DISCONNECT_DEAUTH,
	456	DISCONNECT_DISASSOC
	457	};
	458
	459	struct wl1271_cmd_disconnect {
1ed95388 LC	460	struct wl1271_cmd_header header;
1ed95388 LC	461
d0f63b20 LC	462	__le32 rx_config_options;
d0f63b20 LC	463	__le32 rx_filter_options;
25a7dc6d	464
d0f63b20	465	__le16 reason;
25a7dc6d LC	466	u8 type;
	467
	468	u8 padding;
ba2d3587	469	} __packed;
25a7dc6d	470
be86cbea JO	471	#define WL1271_CMD_STA_STATE_CONNECTED 1
	472
	473	struct wl1271_cmd_set_sta_state {
	474	struct wl1271_cmd_header header;
	475
	476	u8 state;
	477	u8 padding[3];
5082b823	478	} __packed;
be86cbea	479
98bdaabb AN	480	enum wl1271_ssid_type {
	481	SSID_TYPE_PUBLIC = 0,
	482	SSID_TYPE_HIDDEN = 1
	483	};
	484
	485	struct wl1271_cmd_bss_start {
	486	struct wl1271_cmd_header header;
	487
	488	/* wl1271_ssid_type */
	489	u8 ssid_type;
	490	u8 ssid_len;
	491	u8 ssid[IW_ESSID_MAX_SIZE];
	492	u8 padding_1[2];
	493
	494	/* Basic rate set */
	495	__le32 basic_rate_set;
	496	/* Aging period in seconds*/
	497	__le16 aging_period;
	498
	499	/*
	500	* This field specifies the time between target beacon
	501	* transmission times (TBTTs), in time units (TUs).
	502	* Valid values are 1 to 1024.
	503	*/
	504	__le16 beacon_interval;
	505	u8 bssid[ETH_ALEN];
	506	u8 bss_index;
	507	/* Radio band */
	508	u8 band;
	509	u8 channel;
	510	/* The host link id for the AP's global queue */
	511	u8 global_hlid;
	512	/* The host link id for the AP's broadcast queue */
	513	u8 broadcast_hlid;
	514	/* DTIM count */
	515	u8 dtim_interval;
	516	/* Beacon expiry time in ms */
	517	u8 beacon_expiry;
	518	u8 padding_2[3];
	519	} __packed;
	520
	521	struct wl1271_cmd_add_sta {
	522	struct wl1271_cmd_header header;
	523
	524	u8 addr[ETH_ALEN];
	525	u8 hlid;
	526	u8 aid;
	527	u8 psd_type[NUM_ACCESS_CATEGORIES_COPY];
	528	__le32 supported_rates;
	529	u8 bss_index;
	530	u8 sp_len;
	531	u8 wmm;
	532	u8 padding1;
	533	} __packed;
	534
	535	struct wl1271_cmd_remove_sta {
	536	struct wl1271_cmd_header header;
	537
	538	u8 hlid;
	539	u8 reason_opcode;
	540	u8 send_deauth_flag;
	541	u8 padding1;
	542	} __packed;
	543
f5fc0f86	544	#endif /* __WL1271_CMD_H__ */