[deliverable/linux.git] / drivers / net / wireless / intel / iwlwifi / mvm / fw-api-sta.h

/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License 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 Street, Fifth Floor, Boston, MA 02110,
 * USA
 *
 * The full GNU General Public License is included in this distribution
 * in the file called COPYING.
 *
 * Contact Information:
 *  Intel Linux Wireless <linuxwifi@intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *****************************************************************************/

#ifndef __fw_api_sta_h__
#define __fw_api_sta_h__

/**
 * enum iwl_sta_flags - flags for the ADD_STA host command
 * @STA_FLG_REDUCED_TX_PWR_CTRL:
 * @STA_FLG_REDUCED_TX_PWR_DATA:
 * @STA_FLG_DISABLE_TX: set if TX should be disabled
 * @STA_FLG_PS: set if STA is in Power Save
 * @STA_FLG_INVALID: set if STA is invalid
 * @STA_FLG_DLP_EN: Direct Link Protocol is enabled
 * @STA_FLG_SET_ALL_KEYS: the current key applies to all key IDs
 * @STA_FLG_DRAIN_FLOW: drain flow
 * @STA_FLG_PAN: STA is for PAN interface
 * @STA_FLG_CLASS_AUTH:
 * @STA_FLG_CLASS_ASSOC:
 * @STA_FLG_CLASS_MIMO_PROT:
 * @STA_FLG_MAX_AGG_SIZE_MSK: maximal size for A-MPDU
 * @STA_FLG_AGG_MPDU_DENS_MSK: maximal MPDU density for Tx aggregation
 * @STA_FLG_FAT_EN_MSK: support for channel width (for Tx). This flag is
 *	initialised by driver and can be updated by fw upon reception of
 *	action frames that can change the channel width. When cleared the fw
 *	will send all the frames in 20MHz even when FAT channel is requested.
 * @STA_FLG_MIMO_EN_MSK: support for MIMO. This flag is initialised by the
 *	driver and can be updated by fw upon reception of action frames.
 * @STA_FLG_MFP_EN: Management Frame Protection
 */
enum iwl_sta_flags {
	STA_FLG_REDUCED_TX_PWR_CTRL	= BIT(3),
	STA_FLG_REDUCED_TX_PWR_DATA	= BIT(6),

	STA_FLG_DISABLE_TX		= BIT(4),

	STA_FLG_PS			= BIT(8),
	STA_FLG_DRAIN_FLOW		= BIT(12),
	STA_FLG_PAN			= BIT(13),
	STA_FLG_CLASS_AUTH		= BIT(14),
	STA_FLG_CLASS_ASSOC		= BIT(15),
	STA_FLG_RTS_MIMO_PROT		= BIT(17),

	STA_FLG_MAX_AGG_SIZE_SHIFT	= 19,
	STA_FLG_MAX_AGG_SIZE_8K		= (0 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	STA_FLG_MAX_AGG_SIZE_16K	= (1 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	STA_FLG_MAX_AGG_SIZE_32K	= (2 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	STA_FLG_MAX_AGG_SIZE_64K	= (3 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	STA_FLG_MAX_AGG_SIZE_128K	= (4 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	STA_FLG_MAX_AGG_SIZE_256K	= (5 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	STA_FLG_MAX_AGG_SIZE_512K	= (6 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	STA_FLG_MAX_AGG_SIZE_1024K	= (7 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	STA_FLG_MAX_AGG_SIZE_MSK	= (7 << STA_FLG_MAX_AGG_SIZE_SHIFT),

	STA_FLG_AGG_MPDU_DENS_SHIFT	= 23,
	STA_FLG_AGG_MPDU_DENS_2US	= (4 << STA_FLG_AGG_MPDU_DENS_SHIFT),
	STA_FLG_AGG_MPDU_DENS_4US	= (5 << STA_FLG_AGG_MPDU_DENS_SHIFT),
	STA_FLG_AGG_MPDU_DENS_8US	= (6 << STA_FLG_AGG_MPDU_DENS_SHIFT),
	STA_FLG_AGG_MPDU_DENS_16US	= (7 << STA_FLG_AGG_MPDU_DENS_SHIFT),
	STA_FLG_AGG_MPDU_DENS_MSK	= (7 << STA_FLG_AGG_MPDU_DENS_SHIFT),

	STA_FLG_FAT_EN_20MHZ		= (0 << 26),
	STA_FLG_FAT_EN_40MHZ		= (1 << 26),
	STA_FLG_FAT_EN_80MHZ		= (2 << 26),
	STA_FLG_FAT_EN_160MHZ		= (3 << 26),
	STA_FLG_FAT_EN_MSK		= (3 << 26),

	STA_FLG_MIMO_EN_SISO		= (0 << 28),
	STA_FLG_MIMO_EN_MIMO2		= (1 << 28),
	STA_FLG_MIMO_EN_MIMO3		= (2 << 28),
	STA_FLG_MIMO_EN_MSK		= (3 << 28),
};

/**
 * enum iwl_sta_key_flag - key flags for the ADD_STA host command
 * @STA_KEY_FLG_NO_ENC: no encryption
 * @STA_KEY_FLG_WEP: WEP encryption algorithm
 * @STA_KEY_FLG_CCM: CCMP encryption algorithm
 * @STA_KEY_FLG_TKIP: TKIP encryption algorithm
 * @STA_KEY_FLG_EXT: extended cipher algorithm (depends on the FW support)
 * @STA_KEY_FLG_CMAC: CMAC encryption algorithm
 * @STA_KEY_FLG_ENC_UNKNOWN: unknown encryption algorithm
 * @STA_KEY_FLG_EN_MSK: mask for encryption algorithmi value
 * @STA_KEY_FLG_WEP_KEY_MAP: wep is either a group key (0 - legacy WEP) or from
 *	station info array (1 - n 1X mode)
 * @STA_KEY_FLG_KEYID_MSK: the index of the key
 * @STA_KEY_NOT_VALID: key is invalid
 * @STA_KEY_FLG_WEP_13BYTES: set for 13 bytes WEP key
 * @STA_KEY_MULTICAST: set for multical key
 * @STA_KEY_MFP: key is used for Management Frame Protection
 */
enum iwl_sta_key_flag {
	STA_KEY_FLG_NO_ENC		= (0 << 0),
	STA_KEY_FLG_WEP			= (1 << 0),
	STA_KEY_FLG_CCM			= (2 << 0),
	STA_KEY_FLG_TKIP		= (3 << 0),
	STA_KEY_FLG_EXT			= (4 << 0),
	STA_KEY_FLG_CMAC		= (6 << 0),
	STA_KEY_FLG_ENC_UNKNOWN		= (7 << 0),
	STA_KEY_FLG_EN_MSK		= (7 << 0),

	STA_KEY_FLG_WEP_KEY_MAP		= BIT(3),
	STA_KEY_FLG_KEYID_POS		 = 8,
	STA_KEY_FLG_KEYID_MSK		= (3 << STA_KEY_FLG_KEYID_POS),
	STA_KEY_NOT_VALID		= BIT(11),
	STA_KEY_FLG_WEP_13BYTES		= BIT(12),
	STA_KEY_MULTICAST		= BIT(14),
	STA_KEY_MFP			= BIT(15),
};

/**
 * enum iwl_sta_modify_flag - indicate to the fw what flag are being changed
 * @STA_MODIFY_KEY: this command modifies %key
 * @STA_MODIFY_TID_DISABLE_TX: this command modifies %tid_disable_tx
 * @STA_MODIFY_TX_RATE: unused
 * @STA_MODIFY_ADD_BA_TID: this command modifies %add_immediate_ba_tid
 * @STA_MODIFY_REMOVE_BA_TID: this command modifies %remove_immediate_ba_tid
 * @STA_MODIFY_SLEEPING_STA_TX_COUNT: this command modifies %sleep_tx_count
 * @STA_MODIFY_PROT_TH:
 * @STA_MODIFY_QUEUES: modify the queues used by this station
 */
enum iwl_sta_modify_flag {
	STA_MODIFY_KEY				= BIT(0),
	STA_MODIFY_TID_DISABLE_TX		= BIT(1),
	STA_MODIFY_TX_RATE			= BIT(2),
	STA_MODIFY_ADD_BA_TID			= BIT(3),
	STA_MODIFY_REMOVE_BA_TID		= BIT(4),
	STA_MODIFY_SLEEPING_STA_TX_COUNT	= BIT(5),
	STA_MODIFY_PROT_TH			= BIT(6),
	STA_MODIFY_QUEUES			= BIT(7),
};

#define STA_MODE_MODIFY	1

/**
 * enum iwl_sta_sleep_flag - type of sleep of the station
 * @STA_SLEEP_STATE_AWAKE:
 * @STA_SLEEP_STATE_PS_POLL:
 * @STA_SLEEP_STATE_UAPSD:
 * @STA_SLEEP_STATE_MOREDATA: set more-data bit on
 *	(last) released frame
 */
enum iwl_sta_sleep_flag {
	STA_SLEEP_STATE_AWAKE		= 0,
	STA_SLEEP_STATE_PS_POLL		= BIT(0),
	STA_SLEEP_STATE_UAPSD		= BIT(1),
	STA_SLEEP_STATE_MOREDATA	= BIT(2),
};

/* STA ID and color bits definitions */
#define STA_ID_SEED		(0x0f)
#define STA_ID_POS		(0)
#define STA_ID_MSK		(STA_ID_SEED << STA_ID_POS)

#define STA_COLOR_SEED		(0x7)
#define STA_COLOR_POS		(4)
#define STA_COLOR_MSK		(STA_COLOR_SEED << STA_COLOR_POS)

#define STA_ID_N_COLOR_GET_COLOR(id_n_color) \
	(((id_n_color) & STA_COLOR_MSK) >> STA_COLOR_POS)
#define STA_ID_N_COLOR_GET_ID(id_n_color)    \
	(((id_n_color) & STA_ID_MSK) >> STA_ID_POS)

#define STA_KEY_MAX_NUM (16)
#define STA_KEY_IDX_INVALID (0xff)
#define STA_KEY_MAX_DATA_KEY_NUM (4)
#define IWL_MAX_GLOBAL_KEYS (4)
#define STA_KEY_LEN_WEP40 (5)
#define STA_KEY_LEN_WEP104 (13)

/**
 * struct iwl_mvm_keyinfo - key information
 * @key_flags: type %iwl_sta_key_flag
 * @tkip_rx_tsc_byte2: TSC[2] for key mix ph1 detection
 * @tkip_rx_ttak: 10-byte unicast TKIP TTAK for Rx
 * @key_offset: key offset in the fw's key table
 * @key: 16-byte unicast decryption key
 * @tx_secur_seq_cnt: initial RSC / PN needed for replay check
 * @hw_tkip_mic_rx_key: byte: MIC Rx Key - used for TKIP only
 * @hw_tkip_mic_tx_key: byte: MIC Tx Key - used for TKIP only
 */
struct iwl_mvm_keyinfo {
	__le16 key_flags;
	u8 tkip_rx_tsc_byte2;
	u8 reserved1;
	__le16 tkip_rx_ttak[5];
	u8 key_offset;
	u8 reserved2;
	u8 key[16];
	__le64 tx_secur_seq_cnt;
	__le64 hw_tkip_mic_rx_key;
	__le64 hw_tkip_mic_tx_key;
} __packed;

/**
 * struct iwl_mvm_add_sta_cmd - Add/modify a station in the fw's sta table.
 * ( REPLY_ADD_STA = 0x18 )
 * @add_modify: 1: modify existing, 0: add new station
 * @awake_acs:
 * @tid_disable_tx: is tid BIT(tid) enabled for Tx. Clear BIT(x) to enable
 *	AMPDU for tid x. Set %STA_MODIFY_TID_DISABLE_TX to change this field.
 * @mac_id_n_color: the Mac context this station belongs to
 * @addr[ETH_ALEN]: station's MAC address
 * @sta_id: index of station in uCode's station table
 * @modify_mask: STA_MODIFY_*, selects which parameters to modify vs. leave
 *	alone. 1 - modify, 0 - don't change.
 * @station_flags: look at %iwl_sta_flags
 * @station_flags_msk: what of %station_flags have changed
 * @add_immediate_ba_tid: tid for which to add block-ack support (Rx)
 *	Set %STA_MODIFY_ADD_BA_TID to use this field, and also set
 *	add_immediate_ba_ssn.
 * @remove_immediate_ba_tid: tid for which to remove block-ack support (Rx)
 *	Set %STA_MODIFY_REMOVE_BA_TID to use this field
 * @add_immediate_ba_ssn: ssn for the Rx block-ack session. Used together with
 *	add_immediate_ba_tid.
 * @sleep_tx_count: number of packets to transmit to station even though it is
 *	asleep. Used to synchronise PS-poll and u-APSD responses while ucode
 *	keeps track of STA sleep state.
 * @sleep_state_flags: Look at %iwl_sta_sleep_flag.
 * @assoc_id: assoc_id to be sent in VHT PLCP (9-bit), for grp use 0, for AP
 *	mac-addr.
 * @beamform_flags: beam forming controls
 * @tfd_queue_msk: tfd queues used by this station
 *
 * The device contains an internal table of per-station information, with info
 * on security keys, aggregation parameters, and Tx rates for initial Tx
 * attempt and any retries (set by REPLY_TX_LINK_QUALITY_CMD).
 *
 * ADD_STA sets up the table entry for one station, either creating a new
 * entry, or modifying a pre-existing one.
 */
struct iwl_mvm_add_sta_cmd {
	u8 add_modify;
	u8 awake_acs;
	__le16 tid_disable_tx;
	__le32 mac_id_n_color;
	u8 addr[ETH_ALEN];	/* _STA_ID_MODIFY_INFO_API_S_VER_1 */
	__le16 reserved2;
	u8 sta_id;
	u8 modify_mask;
	__le16 reserved3;
	__le32 station_flags;
	__le32 station_flags_msk;
	u8 add_immediate_ba_tid;
	u8 remove_immediate_ba_tid;
	__le16 add_immediate_ba_ssn;
	__le16 sleep_tx_count;
	__le16 sleep_state_flags;
	__le16 assoc_id;
	__le16 beamform_flags;
	__le32 tfd_queue_msk;
} __packed; /* ADD_STA_CMD_API_S_VER_7 */

/**
 * struct iwl_mvm_add_sta_key_cmd - add/modify sta key
 * ( REPLY_ADD_STA_KEY = 0x17 )
 * @sta_id: index of station in uCode's station table
 * @key_offset: key offset in key storage
 * @key_flags: type %iwl_sta_key_flag
 * @key: key material data
 * @key2: key material data
 * @rx_secur_seq_cnt: RX security sequence counter for the key
 * @tkip_rx_tsc_byte2: TSC[2] for key mix ph1 detection
 * @tkip_rx_ttak: 10-byte unicast TKIP TTAK for Rx
 */
struct iwl_mvm_add_sta_key_cmd {
	u8 sta_id;
	u8 key_offset;
	__le16 key_flags;
	u8 key[16];
	u8 key2[16];
	u8 rx_secur_seq_cnt[16];
	u8 tkip_rx_tsc_byte2;
	u8 reserved;
	__le16 tkip_rx_ttak[5];
} __packed; /* ADD_MODIFY_STA_KEY_API_S_VER_1 */

/**
 * enum iwl_mvm_add_sta_rsp_status - status in the response to ADD_STA command
 * @ADD_STA_SUCCESS: operation was executed successfully
 * @ADD_STA_STATIONS_OVERLOAD: no room left in the fw's station table
 * @ADD_STA_IMMEDIATE_BA_FAILURE: can't add Rx block ack session
 * @ADD_STA_MODIFY_NON_EXISTING_STA: driver requested to modify a station that
 *	doesn't exist.
 */
enum iwl_mvm_add_sta_rsp_status {
	ADD_STA_SUCCESS			= 0x1,
	ADD_STA_STATIONS_OVERLOAD	= 0x2,
	ADD_STA_IMMEDIATE_BA_FAILURE	= 0x4,
	ADD_STA_MODIFY_NON_EXISTING_STA	= 0x8,
};

/**
 * struct iwl_mvm_rm_sta_cmd - Add / modify a station in the fw's station table
 * ( REMOVE_STA = 0x19 )
 * @sta_id: the station id of the station to be removed
 */
struct iwl_mvm_rm_sta_cmd {
	u8 sta_id;
	u8 reserved[3];
} __packed; /* REMOVE_STA_CMD_API_S_VER_2 */

/**
 * struct iwl_mvm_mgmt_mcast_key_cmd
 * ( MGMT_MCAST_KEY = 0x1f )
 * @ctrl_flags: %iwl_sta_key_flag
 * @IGTK:
 * @K1: unused
 * @K2: unused
 * @sta_id: station ID that support IGTK
 * @key_id:
 * @receive_seq_cnt: initial RSC/PN needed for replay check
 */
struct iwl_mvm_mgmt_mcast_key_cmd {
	__le32 ctrl_flags;
	u8 IGTK[16];
	u8 K1[16];
	u8 K2[16];
	__le32 key_id;
	__le32 sta_id;
	__le64 receive_seq_cnt;
} __packed; /* SEC_MGMT_MULTICAST_KEY_CMD_API_S_VER_1 */

struct iwl_mvm_wep_key {
	u8 key_index;
	u8 key_offset;
	__le16 reserved1;
	u8 key_size;
	u8 reserved2[3];
	u8 key[16];
} __packed;

struct iwl_mvm_wep_key_cmd {
	__le32 mac_id_n_color;
	u8 num_keys;
	u8 decryption_type;
	u8 flags;
	u8 reserved;
	struct iwl_mvm_wep_key wep_key[0];
} __packed; /* SEC_CURR_WEP_KEY_CMD_API_S_VER_2 */

/**
 * struct iwl_mvm_eosp_notification - EOSP notification from firmware
 * @remain_frame_count: # of frames remaining, non-zero if SP was cut
 *	short by GO absence
 * @sta_id: station ID
 */
struct iwl_mvm_eosp_notification {
	__le32 remain_frame_count;
	__le32 sta_id;
} __packed; /* UAPSD_EOSP_NTFY_API_S_VER_1 */

#endif /* __fw_api_sta_h__ */
Commit	Line	Data
8ca151b5 JB	1	/******************************************************************************
	2	*
	3	* This file is provided under a dual BSD/GPLv2 license. When using or
	4	* redistributing this file, you may do so under either license.
	5	*
	6	* GPL LICENSE SUMMARY
	7	*
51368bf7	8	* Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
8b4139dc	9	* Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
8ca151b5 JB	10	*
	11	* This program is free software; you can redistribute it and/or modify
	12	* it under the terms of version 2 of the GNU General Public License as
	13	* published by the Free Software Foundation.
	14	*
	15	* This program is distributed in the hope that it will be useful, but
	16	* WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	18	* General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
	23	* USA
	24	*
	25	* The full GNU General Public License is included in this distribution
410dc5aa	26	* in the file called COPYING.
8ca151b5 JB	27	*
8ca151b5 JB	28	* Contact Information:
d01c5366	29	* Intel Linux Wireless <linuxwifi@intel.com>
8ca151b5 JB	30	* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
	31	*
	32	* BSD LICENSE
	33	*
51368bf7	34	* Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
8b4139dc	35	* Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
8ca151b5 JB	36	* All rights reserved.
	37	*
	38	* Redistribution and use in source and binary forms, with or without
	39	* modification, are permitted provided that the following conditions
	40	* are met:
	41	*
	42	* * Redistributions of source code must retain the above copyright
	43	* notice, this list of conditions and the following disclaimer.
	44	* * Redistributions in binary form must reproduce the above copyright
	45	* notice, this list of conditions and the following disclaimer in
	46	* the documentation and/or other materials provided with the
	47	* distribution.
	48	* * Neither the name Intel Corporation nor the names of its
	49	* contributors may be used to endorse or promote products derived
	50	* from this software without specific prior written permission.
	51	*
	52	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	53	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	54	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	55	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	56	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	57	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	58	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	59	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	60	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	61	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	62	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	63	*****************************************************************************/
	64
	65	#ifndef __fw_api_sta_h__
	66	#define __fw_api_sta_h__
	67
	68	/**
	69	* enum iwl_sta_flags - flags for the ADD_STA host command
	70	* @STA_FLG_REDUCED_TX_PWR_CTRL:
	71	* @STA_FLG_REDUCED_TX_PWR_DATA:
09b0ce1a	72	* @STA_FLG_DISABLE_TX: set if TX should be disabled
8ca151b5 JB	73	* @STA_FLG_PS: set if STA is in Power Save
	74	* @STA_FLG_INVALID: set if STA is invalid
	75	* @STA_FLG_DLP_EN: Direct Link Protocol is enabled
	76	* @STA_FLG_SET_ALL_KEYS: the current key applies to all key IDs
	77	* @STA_FLG_DRAIN_FLOW: drain flow
	78	* @STA_FLG_PAN: STA is for PAN interface
	79	* @STA_FLG_CLASS_AUTH:
	80	* @STA_FLG_CLASS_ASSOC:
	81	* @STA_FLG_CLASS_MIMO_PROT:
	82	* @STA_FLG_MAX_AGG_SIZE_MSK: maximal size for A-MPDU
	83	* @STA_FLG_AGG_MPDU_DENS_MSK: maximal MPDU density for Tx aggregation
	84	* @STA_FLG_FAT_EN_MSK: support for channel width (for Tx). This flag is
	85	* initialised by driver and can be updated by fw upon reception of
	86	* action frames that can change the channel width. When cleared the fw
	87	* will send all the frames in 20MHz even when FAT channel is requested.
	88	* @STA_FLG_MIMO_EN_MSK: support for MIMO. This flag is initialised by the
	89	* driver and can be updated by fw upon reception of action frames.
	90	* @STA_FLG_MFP_EN: Management Frame Protection
	91	*/
	92	enum iwl_sta_flags {
	93	STA_FLG_REDUCED_TX_PWR_CTRL = BIT(3),
	94	STA_FLG_REDUCED_TX_PWR_DATA = BIT(6),
	95
09b0ce1a	96	STA_FLG_DISABLE_TX = BIT(4),
8ca151b5 JB	97
8ca151b5 JB	98	STA_FLG_PS = BIT(8),
8ca151b5 JB	99	STA_FLG_DRAIN_FLOW = BIT(12),
	100	STA_FLG_PAN = BIT(13),
	101	STA_FLG_CLASS_AUTH = BIT(14),
	102	STA_FLG_CLASS_ASSOC = BIT(15),
	103	STA_FLG_RTS_MIMO_PROT = BIT(17),
	104
	105	STA_FLG_MAX_AGG_SIZE_SHIFT = 19,
	106	STA_FLG_MAX_AGG_SIZE_8K = (0 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	107	STA_FLG_MAX_AGG_SIZE_16K = (1 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	108	STA_FLG_MAX_AGG_SIZE_32K = (2 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	109	STA_FLG_MAX_AGG_SIZE_64K = (3 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	110	STA_FLG_MAX_AGG_SIZE_128K = (4 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	111	STA_FLG_MAX_AGG_SIZE_256K = (5 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	112	STA_FLG_MAX_AGG_SIZE_512K = (6 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	113	STA_FLG_MAX_AGG_SIZE_1024K = (7 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	114	STA_FLG_MAX_AGG_SIZE_MSK = (7 << STA_FLG_MAX_AGG_SIZE_SHIFT),
	115
	116	STA_FLG_AGG_MPDU_DENS_SHIFT = 23,
	117	STA_FLG_AGG_MPDU_DENS_2US = (4 << STA_FLG_AGG_MPDU_DENS_SHIFT),
	118	STA_FLG_AGG_MPDU_DENS_4US = (5 << STA_FLG_AGG_MPDU_DENS_SHIFT),
	119	STA_FLG_AGG_MPDU_DENS_8US = (6 << STA_FLG_AGG_MPDU_DENS_SHIFT),
	120	STA_FLG_AGG_MPDU_DENS_16US = (7 << STA_FLG_AGG_MPDU_DENS_SHIFT),
	121	STA_FLG_AGG_MPDU_DENS_MSK = (7 << STA_FLG_AGG_MPDU_DENS_SHIFT),
	122
	123	STA_FLG_FAT_EN_20MHZ = (0 << 26),
	124	STA_FLG_FAT_EN_40MHZ = (1 << 26),
	125	STA_FLG_FAT_EN_80MHZ = (2 << 26),
	126	STA_FLG_FAT_EN_160MHZ = (3 << 26),
	127	STA_FLG_FAT_EN_MSK = (3 << 26),
	128
	129	STA_FLG_MIMO_EN_SISO = (0 << 28),
	130	STA_FLG_MIMO_EN_MIMO2 = (1 << 28),
	131	STA_FLG_MIMO_EN_MIMO3 = (2 << 28),
	132	STA_FLG_MIMO_EN_MSK = (3 << 28),
	133	};
	134
	135	/**
	136	* enum iwl_sta_key_flag - key flags for the ADD_STA host command
e36e5433 MS	137	* @STA_KEY_FLG_NO_ENC: no encryption
	138	* @STA_KEY_FLG_WEP: WEP encryption algorithm
	139	* @STA_KEY_FLG_CCM: CCMP encryption algorithm
	140	* @STA_KEY_FLG_TKIP: TKIP encryption algorithm
	141	* @STA_KEY_FLG_EXT: extended cipher algorithm (depends on the FW support)
	142	* @STA_KEY_FLG_CMAC: CMAC encryption algorithm
	143	* @STA_KEY_FLG_ENC_UNKNOWN: unknown encryption algorithm
	144	* @STA_KEY_FLG_EN_MSK: mask for encryption algorithmi value
8ca151b5 JB	145	* @STA_KEY_FLG_WEP_KEY_MAP: wep is either a group key (0 - legacy WEP) or from
	146	* station info array (1 - n 1X mode)
	147	* @STA_KEY_FLG_KEYID_MSK: the index of the key
	148	* @STA_KEY_NOT_VALID: key is invalid
	149	* @STA_KEY_FLG_WEP_13BYTES: set for 13 bytes WEP key
	150	* @STA_KEY_MULTICAST: set for multical key
	151	* @STA_KEY_MFP: key is used for Management Frame Protection
	152	*/
	153	enum iwl_sta_key_flag {
	154	STA_KEY_FLG_NO_ENC = (0 << 0),
	155	STA_KEY_FLG_WEP = (1 << 0),
	156	STA_KEY_FLG_CCM = (2 << 0),
	157	STA_KEY_FLG_TKIP = (3 << 0),
e36e5433	158	STA_KEY_FLG_EXT = (4 << 0),
8ca151b5 JB	159	STA_KEY_FLG_CMAC = (6 << 0),
	160	STA_KEY_FLG_ENC_UNKNOWN = (7 << 0),
	161	STA_KEY_FLG_EN_MSK = (7 << 0),
	162
	163	STA_KEY_FLG_WEP_KEY_MAP = BIT(3),
	164	STA_KEY_FLG_KEYID_POS = 8,
	165	STA_KEY_FLG_KEYID_MSK = (3 << STA_KEY_FLG_KEYID_POS),
	166	STA_KEY_NOT_VALID = BIT(11),
	167	STA_KEY_FLG_WEP_13BYTES = BIT(12),
	168	STA_KEY_MULTICAST = BIT(14),
	169	STA_KEY_MFP = BIT(15),
	170	};
	171
	172	/**
	173	* enum iwl_sta_modify_flag - indicate to the fw what flag are being changed
	174	* @STA_MODIFY_KEY: this command modifies %key
	175	* @STA_MODIFY_TID_DISABLE_TX: this command modifies %tid_disable_tx
	176	* @STA_MODIFY_TX_RATE: unused
	177	* @STA_MODIFY_ADD_BA_TID: this command modifies %add_immediate_ba_tid
	178	* @STA_MODIFY_REMOVE_BA_TID: this command modifies %remove_immediate_ba_tid
	179	* @STA_MODIFY_SLEEPING_STA_TX_COUNT: this command modifies %sleep_tx_count
	180	* @STA_MODIFY_PROT_TH:
	181	* @STA_MODIFY_QUEUES: modify the queues used by this station
	182	*/
	183	enum iwl_sta_modify_flag {
	184	STA_MODIFY_KEY = BIT(0),
	185	STA_MODIFY_TID_DISABLE_TX = BIT(1),
	186	STA_MODIFY_TX_RATE = BIT(2),
	187	STA_MODIFY_ADD_BA_TID = BIT(3),
	188	STA_MODIFY_REMOVE_BA_TID = BIT(4),
	189	STA_MODIFY_SLEEPING_STA_TX_COUNT = BIT(5),
	190	STA_MODIFY_PROT_TH = BIT(6),
	191	STA_MODIFY_QUEUES = BIT(7),
	192	};
	193
	194	#define STA_MODE_MODIFY 1
	195
	196	/**
	197	* enum iwl_sta_sleep_flag - type of sleep of the station
	198	* @STA_SLEEP_STATE_AWAKE:
	199	* @STA_SLEEP_STATE_PS_POLL:
	200	* @STA_SLEEP_STATE_UAPSD:
3e56eadf JB	201	* @STA_SLEEP_STATE_MOREDATA: set more-data bit on
3e56eadf JB	202	* (last) released frame
8ca151b5 JB	203	*/
8ca151b5 JB	204	enum iwl_sta_sleep_flag {
3e56eadf JB	205	STA_SLEEP_STATE_AWAKE = 0,
	206	STA_SLEEP_STATE_PS_POLL = BIT(0),
	207	STA_SLEEP_STATE_UAPSD = BIT(1),
	208	STA_SLEEP_STATE_MOREDATA = BIT(2),
8ca151b5 JB	209	};
	210
	211	/* STA ID and color bits definitions */
	212	#define STA_ID_SEED (0x0f)
	213	#define STA_ID_POS (0)
	214	#define STA_ID_MSK (STA_ID_SEED << STA_ID_POS)
	215
	216	#define STA_COLOR_SEED (0x7)
	217	#define STA_COLOR_POS (4)
	218	#define STA_COLOR_MSK (STA_COLOR_SEED << STA_COLOR_POS)
	219
	220	#define STA_ID_N_COLOR_GET_COLOR(id_n_color) \
	221	(((id_n_color) & STA_COLOR_MSK) >> STA_COLOR_POS)
	222	#define STA_ID_N_COLOR_GET_ID(id_n_color) \
	223	(((id_n_color) & STA_ID_MSK) >> STA_ID_POS)
	224
	225	#define STA_KEY_MAX_NUM (16)
	226	#define STA_KEY_IDX_INVALID (0xff)
	227	#define STA_KEY_MAX_DATA_KEY_NUM (4)
	228	#define IWL_MAX_GLOBAL_KEYS (4)
	229	#define STA_KEY_LEN_WEP40 (5)
	230	#define STA_KEY_LEN_WEP104 (13)
	231
	232	/**
	233	* struct iwl_mvm_keyinfo - key information
	234	* @key_flags: type %iwl_sta_key_flag
	235	* @tkip_rx_tsc_byte2: TSC[2] for key mix ph1 detection
	236	* @tkip_rx_ttak: 10-byte unicast TKIP TTAK for Rx
	237	* @key_offset: key offset in the fw's key table
	238	* @key: 16-byte unicast decryption key
	239	* @tx_secur_seq_cnt: initial RSC / PN needed for replay check
	240	* @hw_tkip_mic_rx_key: byte: MIC Rx Key - used for TKIP only
	241	* @hw_tkip_mic_tx_key: byte: MIC Tx Key - used for TKIP only
	242	*/
	243	struct iwl_mvm_keyinfo {
	244	__le16 key_flags;
	245	u8 tkip_rx_tsc_byte2;
	246	u8 reserved1;
	247	__le16 tkip_rx_ttak[5];
	248	u8 key_offset;
	249	u8 reserved2;
	250	u8 key[16];
	251	__le64 tx_secur_seq_cnt;
	252	__le64 hw_tkip_mic_rx_key;
	253	__le64 hw_tkip_mic_tx_key;
	254	} __packed;
	255
	256	/**
f9dc0004	257	* struct iwl_mvm_add_sta_cmd - Add/modify a station in the fw's sta table.
8ca151b5 JB	258	* ( REPLY_ADD_STA = 0x18 )
8ca151b5 JB	259	* @add_modify: 1: modify existing, 0: add new station
f9dc0004 EG	260	* @awake_acs:
	261	* @tid_disable_tx: is tid BIT(tid) enabled for Tx. Clear BIT(x) to enable
	262	* AMPDU for tid x. Set %STA_MODIFY_TID_DISABLE_TX to change this field.
8ca151b5 JB	263	* @mac_id_n_color: the Mac context this station belongs to
	264	* @addr[ETH_ALEN]: station's MAC address
	265	* @sta_id: index of station in uCode's station table
	266	* @modify_mask: STA_MODIFY_*, selects which parameters to modify vs. leave
	267	* alone. 1 - modify, 0 - don't change.
8ca151b5 JB	268	* @station_flags: look at %iwl_sta_flags
8ca151b5 JB	269	* @station_flags_msk: what of %station_flags have changed
8ca151b5 JB	270	* @add_immediate_ba_tid: tid for which to add block-ack support (Rx)
	271	* Set %STA_MODIFY_ADD_BA_TID to use this field, and also set
	272	* add_immediate_ba_ssn.
	273	* @remove_immediate_ba_tid: tid for which to remove block-ack support (Rx)
	274	* Set %STA_MODIFY_REMOVE_BA_TID to use this field
	275	* @add_immediate_ba_ssn: ssn for the Rx block-ack session. Used together with
	276	* add_immediate_ba_tid.
	277	* @sleep_tx_count: number of packets to transmit to station even though it is
	278	* asleep. Used to synchronise PS-poll and u-APSD responses while ucode
	279	* keeps track of STA sleep state.
	280	* @sleep_state_flags: Look at %iwl_sta_sleep_flag.
	281	* @assoc_id: assoc_id to be sent in VHT PLCP (9-bit), for grp use 0, for AP
	282	* mac-addr.
	283	* @beamform_flags: beam forming controls
	284	* @tfd_queue_msk: tfd queues used by this station
	285	*
	286	* The device contains an internal table of per-station information, with info
	287	* on security keys, aggregation parameters, and Tx rates for initial Tx
	288	* attempt and any retries (set by REPLY_TX_LINK_QUALITY_CMD).
	289	*
	290	* ADD_STA sets up the table entry for one station, either creating a new
	291	* entry, or modifying a pre-existing one.
	292	*/
f9dc0004	293	struct iwl_mvm_add_sta_cmd {
5a258aae	294	u8 add_modify;
3e56eadf	295	u8 awake_acs;
5a258aae MS	296	__le16 tid_disable_tx;
	297	__le32 mac_id_n_color;
	298	u8 addr[ETH_ALEN]; /* _STA_ID_MODIFY_INFO_API_S_VER_1 */
	299	__le16 reserved2;
	300	u8 sta_id;
	301	u8 modify_mask;
	302	__le16 reserved3;
	303	__le32 station_flags;
	304	__le32 station_flags_msk;
	305	u8 add_immediate_ba_tid;
	306	u8 remove_immediate_ba_tid;
	307	__le16 add_immediate_ba_ssn;
	308	__le16 sleep_tx_count;
	309	__le16 sleep_state_flags;
	310	__le16 assoc_id;
	311	__le16 beamform_flags;
	312	__le32 tfd_queue_msk;
3e56eadf	313	} __packed; /* ADD_STA_CMD_API_S_VER_7 */
5a258aae MS	314
	315	/**
	316	* struct iwl_mvm_add_sta_key_cmd - add/modify sta key
	317	* ( REPLY_ADD_STA_KEY = 0x17 )
	318	* @sta_id: index of station in uCode's station table
	319	* @key_offset: key offset in key storage
	320	* @key_flags: type %iwl_sta_key_flag
	321	* @key: key material data
	322	* @key2: key material data
	323	* @rx_secur_seq_cnt: RX security sequence counter for the key
	324	* @tkip_rx_tsc_byte2: TSC[2] for key mix ph1 detection
	325	* @tkip_rx_ttak: 10-byte unicast TKIP TTAK for Rx
	326	*/
	327	struct iwl_mvm_add_sta_key_cmd {
	328	u8 sta_id;
	329	u8 key_offset;
	330	__le16 key_flags;
	331	u8 key[16];
	332	u8 key2[16];
	333	u8 rx_secur_seq_cnt[16];
	334	u8 tkip_rx_tsc_byte2;
	335	u8 reserved;
	336	__le16 tkip_rx_ttak[5];
	337	} __packed; /* ADD_MODIFY_STA_KEY_API_S_VER_1 */
	338
8ca151b5 JB	339	/**
	340	* enum iwl_mvm_add_sta_rsp_status - status in the response to ADD_STA command
	341	* @ADD_STA_SUCCESS: operation was executed successfully
	342	* @ADD_STA_STATIONS_OVERLOAD: no room left in the fw's station table
	343	* @ADD_STA_IMMEDIATE_BA_FAILURE: can't add Rx block ack session
	344	* @ADD_STA_MODIFY_NON_EXISTING_STA: driver requested to modify a station that
	345	* doesn't exist.
	346	*/
	347	enum iwl_mvm_add_sta_rsp_status {
	348	ADD_STA_SUCCESS = 0x1,
	349	ADD_STA_STATIONS_OVERLOAD = 0x2,
	350	ADD_STA_IMMEDIATE_BA_FAILURE = 0x4,
	351	ADD_STA_MODIFY_NON_EXISTING_STA = 0x8,
	352	};
	353
	354	/**
	355	* struct iwl_mvm_rm_sta_cmd - Add / modify a station in the fw's station table
	356	* ( REMOVE_STA = 0x19 )
	357	* @sta_id: the station id of the station to be removed
	358	*/
	359	struct iwl_mvm_rm_sta_cmd {
	360	u8 sta_id;
	361	u8 reserved[3];
	362	} __packed; /* REMOVE_STA_CMD_API_S_VER_2 */
	363
	364	/**
	365	* struct iwl_mvm_mgmt_mcast_key_cmd
	366	* ( MGMT_MCAST_KEY = 0x1f )
	367	* @ctrl_flags: %iwl_sta_key_flag
	368	* @IGTK:
2001a130 JB	369	* @K1: unused
2001a130 JB	370	* @K2: unused
8ca151b5 JB	371	* @sta_id: station ID that support IGTK
	372	* @key_id:
	373	* @receive_seq_cnt: initial RSC/PN needed for replay check
	374	*/
	375	struct iwl_mvm_mgmt_mcast_key_cmd {
	376	__le32 ctrl_flags;
	377	u8 IGTK[16];
	378	u8 K1[16];
	379	u8 K2[16];
	380	__le32 key_id;
	381	__le32 sta_id;
	382	__le64 receive_seq_cnt;
	383	} __packed; /* SEC_MGMT_MULTICAST_KEY_CMD_API_S_VER_1 */
	384
	385	struct iwl_mvm_wep_key {
	386	u8 key_index;
	387	u8 key_offset;
	388	__le16 reserved1;
	389	u8 key_size;
	390	u8 reserved2[3];
	391	u8 key[16];
	392	} __packed;
	393
	394	struct iwl_mvm_wep_key_cmd {
	395	__le32 mac_id_n_color;
	396	u8 num_keys;
	397	u8 decryption_type;
	398	u8 flags;
	399	u8 reserved;
	400	struct iwl_mvm_wep_key wep_key[0];
	401	} __packed; /* SEC_CURR_WEP_KEY_CMD_API_S_VER_2 */
	402
3e56eadf JB	403	/**
	404	* struct iwl_mvm_eosp_notification - EOSP notification from firmware
	405	* @remain_frame_count: # of frames remaining, non-zero if SP was cut
	406	* short by GO absence
	407	* @sta_id: station ID
	408	*/
	409	struct iwl_mvm_eosp_notification {
	410	__le32 remain_frame_count;
	411	__le32 sta_id;
	412	} __packed; /* UAPSD_EOSP_NTFY_API_S_VER_1 */
8ca151b5 JB	413
8ca151b5 JB	414	#endif /* __fw_api_sta_h__ */