Quelle  commands.h   Sprache: C

/******************************************************************************
 *
 * 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) 2005 - 2011 Intel Corporation. All rights reserved.
 *
 * 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 LICENSE.GPL.
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
 * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
 * 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 __il_commands_h__
#define __il_commands_h__

#include <linux/ieee80211.h>

struct il_priv;

/* uCode version contains 4 values: Major/Minor/API/Serial */
#define IL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
#define IL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
#define IL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
#define IL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)

/* Tx rates */
#define IL_CCK_RATES 4
#define IL_OFDM_RATES 8
#define IL_MAX_RATES (IL_CCK_RATES + IL_OFDM_RATES)

enum {
 N_ALIVE = 0x1,
 N_ERROR = 0x2,

 /* RXON and QOS commands */
 C_RXON = 0x10,
 C_RXON_ASSOC = 0x11,
 C_QOS_PARAM = 0x13,
 C_RXON_TIMING = 0x14,

 /* Multi-Station support */
 C_ADD_STA = 0x18,
 C_REM_STA = 0x19,

 /* Security */
 C_WEPKEY = 0x20,

 /* RX, TX, LEDs */
 N_3945_RX = 0x1b, /* 3945 only */
 C_TX = 0x1c,
 C_RATE_SCALE = 0x47, /* 3945 only */
 C_LEDS = 0x48,
 C_TX_LINK_QUALITY_CMD = 0x4e, /* for 4965 */

 /* 802.11h related */
 C_CHANNEL_SWITCH = 0x72,
 N_CHANNEL_SWITCH = 0x73,
 C_SPECTRUM_MEASUREMENT = 0x74,
 N_SPECTRUM_MEASUREMENT = 0x75,

 /* Power Management */
 C_POWER_TBL = 0x77,
 N_PM_SLEEP = 0x7A,
 N_PM_DEBUG_STATS = 0x7B,

 /* Scan commands and notifications */
 C_SCAN = 0x80,
 C_SCAN_ABORT = 0x81,
 N_SCAN_START = 0x82,
 N_SCAN_RESULTS = 0x83,
 N_SCAN_COMPLETE = 0x84,

 /* IBSS/AP commands */
 N_BEACON = 0x90,
 C_TX_BEACON = 0x91,

 /* Miscellaneous commands */
 C_TX_PWR_TBL = 0x97,

 /* Bluetooth device coexistence config command */
 C_BT_CONFIG = 0x9b,

 /* Statistics */
 C_STATS = 0x9c,
 N_STATS = 0x9d,

 /* RF-KILL commands and notifications */
 N_CARD_STATE = 0xa1,

 /* Missed beacons notification */
 N_MISSED_BEACONS = 0xa2,

 C_CT_KILL_CONFIG = 0xa4,
 C_SENSITIVITY = 0xa8,
 C_PHY_CALIBRATION = 0xb0,
 N_RX_PHY = 0xc0,
 N_RX_MPDU = 0xc1,
 N_RX = 0xc3,
 N_COMPRESSED_BA = 0xc5,

 IL_CN_MAX = 0xff
};

/******************************************************************************
 * (0)
 * Commonly used structures and definitions:
 * Command header, rate_n_flags, txpower
 *
 *****************************************************************************/

/* il_cmd_header flags value */
#define IL_CMD_FAILED_MSK 0x40

#define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
#define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
#define SEQ_TO_IDX(s) ((s) & 0xff)
#define IDX_TO_SEQ(i) ((i) & 0xff)
#define SEQ_HUGE_FRAME cpu_to_le16(0x4000)
#define SEQ_RX_FRAME cpu_to_le16(0x8000)

/**
 * struct il_cmd_header
 *
 * This header format appears in the beginning of each command sent from the
 * driver, and each response/notification received from uCode.
 */
struct il_cmd_header {
 u8 cmd;   /* Command ID:  C_RXON, etc. */
 u8 flags;  /* 0:5 reserved, 6 abort, 7 internal */
 /*
 * The driver sets up the sequence number to values of its choosing.
 * uCode does not use this value, but passes it back to the driver
 * when sending the response to each driver-originated command, so
 * the driver can match the response to the command.  Since the values
 * don't get used by uCode, the driver may set up an arbitrary format.
 *
 * There is one exception:  uCode sets bit 15 when it originates
 * the response/notification, i.e. when the response/notification
 * is not a direct response to a command sent by the driver.  For
 * example, uCode issues N_3945_RX when it sends a received frame
 * to the driver; it is not a direct response to any driver command.
 *
 * The Linux driver uses the following format:
 *
 *  0:7         tfd idx - position within TX queue
 *  8:12        TX queue id
 *  13          reserved
 *  14          huge - driver sets this to indicate command is in the
 *              'huge' storage at the end of the command buffers
 *  15          unsolicited RX or uCode-originated notification
 */
 __le16 sequence;
} __packed;

/**
 * struct il3945_tx_power
 *
 * Used in C_TX_PWR_TBL, C_SCAN, C_CHANNEL_SWITCH
 *
 * Each entry contains two values:
 * 1)  DSP gain (or sometimes called DSP attenuation).  This is a fine-grained
 *     linear value that multiplies the output of the digital signal processor,
 *     before being sent to the analog radio.
 * 2)  Radio gain.  This sets the analog gain of the radio Tx path.
 *     It is a coarser setting, and behaves in a logarithmic (dB) fashion.
 *
 * Driver obtains values from struct il3945_tx_power power_gain_table[][].
 */
struct il3945_tx_power {
 u8 tx_gain;  /* gain for analog radio */
 u8 dsp_atten;  /* gain for DSP */
} __packed;

/**
 * struct il3945_power_per_rate
 *
 * Used in C_TX_PWR_TBL, C_CHANNEL_SWITCH
 */
struct il3945_power_per_rate {
 u8 rate;  /* plcp */
 struct il3945_tx_power tpc;
 u8 reserved;
} __packed;

/**
 * iwl4965 rate_n_flags bit fields
 *
 * rate_n_flags format is used in following iwl4965 commands:
 *  N_RX (response only)
 *  N_RX_MPDU (response only)
 *  C_TX (both command and response)
 *  C_TX_LINK_QUALITY_CMD
 *
 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
 *  2-0:  0)   6 Mbps
 *        1)  12 Mbps
 *        2)  18 Mbps
 *        3)  24 Mbps
 *        4)  36 Mbps
 *        5)  48 Mbps
 *        6)  54 Mbps
 *        7)  60 Mbps
 *
 *  4-3:  0)  Single stream (SISO)
 *        1)  Dual stream (MIMO)
 *        2)  Triple stream (MIMO)
 *
 *    5:  Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
 *
 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
 *  3-0:  0xD)   6 Mbps
 *        0xF)   9 Mbps
 *        0x5)  12 Mbps
 *        0x7)  18 Mbps
 *        0x9)  24 Mbps
 *        0xB)  36 Mbps
 *        0x1)  48 Mbps
 *        0x3)  54 Mbps
 *
 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
 *  6-0:   10)  1 Mbps
 *         20)  2 Mbps
 *         55)  5.5 Mbps
 *        110)  11 Mbps
 */
#define RATE_MCS_CODE_MSK 0x7
#define RATE_MCS_SPATIAL_POS 3
#define RATE_MCS_SPATIAL_MSK 0x18
#define RATE_MCS_HT_DUP_POS 5
#define RATE_MCS_HT_DUP_MSK 0x20

/* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
#define RATE_MCS_FLAGS_POS 8
#define RATE_MCS_HT_POS 8
#define RATE_MCS_HT_MSK 0x100

/* Bit 9: (1) CCK, (0) OFDM.  HT (bit 8) must be "0" for this bit to be valid */
#define RATE_MCS_CCK_POS 9
#define RATE_MCS_CCK_MSK 0x200

/* Bit 10: (1) Use Green Field preamble */
#define RATE_MCS_GF_POS 10
#define RATE_MCS_GF_MSK 0x400

/* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */
#define RATE_MCS_HT40_POS 11
#define RATE_MCS_HT40_MSK 0x800

/* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */
#define RATE_MCS_DUP_POS 12
#define RATE_MCS_DUP_MSK 0x1000

/* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
#define RATE_MCS_SGI_POS 13
#define RATE_MCS_SGI_MSK 0x2000

/**
 * rate_n_flags Tx antenna masks
 * 4965 has 2 transmitters
 * bit14:16
 */
#define RATE_MCS_ANT_POS 14
#define RATE_MCS_ANT_A_MSK 0x04000
#define RATE_MCS_ANT_B_MSK 0x08000
#define RATE_MCS_ANT_C_MSK 0x10000
#define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
#define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
#define RATE_ANT_NUM 3

#define POWER_TBL_NUM_ENTRIES   33
#define POWER_TBL_NUM_HT_OFDM_ENTRIES  32
#define POWER_TBL_CCK_ENTRY   32

#define IL_PWR_NUM_HT_OFDM_ENTRIES  24
#define IL_PWR_CCK_ENTRIES   2

/**
 * union il4965_tx_power_dual_stream
 *
 * Host format used for C_TX_PWR_TBL, C_CHANNEL_SWITCH
 * Use __le32 version (struct tx_power_dual_stream) when building command.
 *
 * Driver provides radio gain and DSP attenuation settings to device in pairs,
 * one value for each transmitter chain.  The first value is for transmitter A,
 * second for transmitter B.
 *
 * For SISO bit rates, both values in a pair should be identical.
 * For MIMO rates, one value may be different from the other,
 * in order to balance the Tx output between the two transmitters.
 *
 * See more details in doc for TXPOWER in 4965.h.
 */
union il4965_tx_power_dual_stream {
 struct {
  u8 radio_tx_gain[2];
  u8 dsp_predis_atten[2];
 } s;
 u32 dw;
};

/**
 * struct tx_power_dual_stream
 *
 * Table entries in C_TX_PWR_TBL, C_CHANNEL_SWITCH
 *
 * Same format as il_tx_power_dual_stream, but __le32
 */
struct tx_power_dual_stream {
 __le32 dw;
} __packed;

/**
 * struct il4965_tx_power_db
 *
 * Entire table within C_TX_PWR_TBL, C_CHANNEL_SWITCH
 */
struct il4965_tx_power_db {
 struct tx_power_dual_stream power_tbl[POWER_TBL_NUM_ENTRIES];
} __packed;

/******************************************************************************
 * (0a)
 * Alive and Error Commands & Responses:
 *
 *****************************************************************************/

#define UCODE_VALID_OK cpu_to_le32(0x1)
#define INITIALIZE_SUBTYPE    (9)

/*
 * ("Initialize") N_ALIVE = 0x1 (response only, not a command)
 *
 * uCode issues this "initialize alive" notification once the initialization
 * uCode image has completed its work, and is ready to load the runtime image.
 * This is the *first* "alive" notification that the driver will receive after
 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
 *
 * See comments documenting "BSM" (bootstrap state machine).
 *
 * For 4965, this notification contains important calibration data for
 * calculating txpower settings:
 *
 * 1)  Power supply voltage indication.  The voltage sensor outputs higher
 *     values for lower voltage, and vice verse.
 *
 * 2)  Temperature measurement parameters, for each of two channel widths
 *     (20 MHz and 40 MHz) supported by the radios.  Temperature sensing
 *     is done via one of the receiver chains, and channel width influences
 *     the results.
 *
 * 3)  Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
 *     for each of 5 frequency ranges.
 */
struct il_init_alive_resp {
 u8 ucode_minor;
 u8 ucode_major;
 __le16 reserved1;
 u8 sw_rev[8];
 u8 ver_type;
 u8 ver_subtype;  /* "9" for initialize alive */
 __le16 reserved2;
 __le32 log_event_table_ptr;
 __le32 error_event_table_ptr;
 __le32 timestamp;
 __le32 is_valid;

 /* calibration values from "initialize" uCode */
 __le32 voltage;  /* signed, higher value is lower voltage */
 __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for HT40 */
 __le32 therm_r2[2]; /* signed */
 __le32 therm_r3[2]; /* signed */
 __le32 therm_r4[2]; /* signed */
 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
 * 2 Tx chains */
} __packed;

/**
 * N_ALIVE = 0x1 (response only, not a command)
 *
 * uCode issues this "alive" notification once the runtime image is ready
 * to receive commands from the driver.  This is the *second* "alive"
 * notification that the driver will receive after rebooting uCode;
 * this "alive" is indicated by subtype field != 9.
 *
 * See comments documenting "BSM" (bootstrap state machine).
 *
 * This response includes two pointers to structures within the device's
 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
 *
 * 1)  log_event_table_ptr indicates base of the event log.  This traces
 *     a 256-entry history of uCode execution within a circular buffer.
 *     Its header format is:
 *
 * __le32 log_size;     log capacity (in number of entries)
 * __le32 type;         (1) timestamp with each entry, (0) no timestamp
 * __le32 wraps;        # times uCode has wrapped to top of circular buffer
 *      __le32 write_idx;  next circular buffer entry that uCode would fill
 *
 *     The header is followed by the circular buffer of log entries.  Entries
 *     with timestamps have the following format:
 *
 * __le32 event_id;     range 0 - 1500
 * __le32 timestamp;    low 32 bits of TSF (of network, if associated)
 * __le32 data;         event_id-specific data value
 *
 *     Entries without timestamps contain only event_id and data.
 *
 *
 * 2)  error_event_table_ptr indicates base of the error log.  This contains
 *     information about any uCode error that occurs.  For 4965, the format
 *     of the error log is:
 *
 * __le32 valid;        (nonzero) valid, (0) log is empty
 * __le32 error_id;     type of error
 * __le32 pc;           program counter
 * __le32 blink1;       branch link
 * __le32 blink2;       branch link
 * __le32 ilink1;       interrupt link
 * __le32 ilink2;       interrupt link
 * __le32 data1;        error-specific data
 * __le32 data2;        error-specific data
 * __le32 line;         source code line of error
 * __le32 bcon_time;    beacon timer
 * __le32 tsf_low;      network timestamp function timer
 * __le32 tsf_hi;       network timestamp function timer
 * __le32 gp1;          GP1 timer register
 * __le32 gp2;          GP2 timer register
 * __le32 gp3;          GP3 timer register
 * __le32 ucode_ver;    uCode version
 * __le32 hw_ver;       HW Silicon version
 * __le32 brd_ver;      HW board version
 * __le32 log_pc;       log program counter
 * __le32 frame_ptr;    frame pointer
 * __le32 stack_ptr;    stack pointer
 * __le32 hcmd;         last host command
 * __le32 isr0;         isr status register LMPM_NIC_ISR0: rxtx_flag
 * __le32 isr1;         isr status register LMPM_NIC_ISR1: host_flag
 * __le32 isr2;         isr status register LMPM_NIC_ISR2: enc_flag
 * __le32 isr3;         isr status register LMPM_NIC_ISR3: time_flag
 * __le32 isr4;         isr status register LMPM_NIC_ISR4: wico interrupt
 * __le32 isr_pref;     isr status register LMPM_NIC_PREF_STAT
 * __le32 wait_event;   wait event() caller address
 * __le32 l2p_control;  L2pControlField
 * __le32 l2p_duration; L2pDurationField
 * __le32 l2p_mhvalid;  L2pMhValidBits
 * __le32 l2p_addr_match; L2pAddrMatchStat
 * __le32 lmpm_pmg_sel; indicate which clocks are turned on (LMPM_PMG_SEL)
 * __le32 u_timestamp;  indicate when the date and time of the compilation
 * __le32 reserved;
 *
 * The Linux driver can print both logs to the system log when a uCode error
 * occurs.
 */
struct il_alive_resp {
 u8 ucode_minor;
 u8 ucode_major;
 __le16 reserved1;
 u8 sw_rev[8];
 u8 ver_type;
 u8 ver_subtype;  /* not "9" for runtime alive */
 __le16 reserved2;
 __le32 log_event_table_ptr; /* SRAM address for event log */
 __le32 error_event_table_ptr; /* SRAM address for error log */
 __le32 timestamp;
 __le32 is_valid;
} __packed;

/*
 * N_ERROR = 0x2 (response only, not a command)
 */
struct il_error_resp {
 __le32 error_type;
 u8 cmd_id;
 u8 reserved1;
 __le16 bad_cmd_seq_num;
 __le32 error_info;
 __le64 timestamp;
} __packed;

/******************************************************************************
 * (1)
 * RXON Commands & Responses:
 *
 *****************************************************************************/

/*
 * Rx config defines & structure
 */
/* rx_config device types  */
enum {
 RXON_DEV_TYPE_AP = 1,
 RXON_DEV_TYPE_ESS = 3,
 RXON_DEV_TYPE_IBSS = 4,
 RXON_DEV_TYPE_SNIFFER = 6,
};

#define RXON_RX_CHAIN_DRIVER_FORCE_MSK  cpu_to_le16(0x1 << 0)
#define RXON_RX_CHAIN_DRIVER_FORCE_POS  (0)
#define RXON_RX_CHAIN_VALID_MSK   cpu_to_le16(0x7 << 1)
#define RXON_RX_CHAIN_VALID_POS   (1)
#define RXON_RX_CHAIN_FORCE_SEL_MSK  cpu_to_le16(0x7 << 4)
#define RXON_RX_CHAIN_FORCE_SEL_POS  (4)
#define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7)
#define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
#define RXON_RX_CHAIN_CNT_MSK   cpu_to_le16(0x3 << 10)
#define RXON_RX_CHAIN_CNT_POS   (10)
#define RXON_RX_CHAIN_MIMO_CNT_MSK  cpu_to_le16(0x3 << 12)
#define RXON_RX_CHAIN_MIMO_CNT_POS  (12)
#define RXON_RX_CHAIN_MIMO_FORCE_MSK  cpu_to_le16(0x1 << 14)
#define RXON_RX_CHAIN_MIMO_FORCE_POS  (14)

/* rx_config flags */
/* band & modulation selection */
#define RXON_FLG_BAND_24G_MSK           cpu_to_le32(1 << 0)
#define RXON_FLG_CCK_MSK                cpu_to_le32(1 << 1)
/* auto detection enable */
#define RXON_FLG_AUTO_DETECT_MSK        cpu_to_le32(1 << 2)
/* TGg protection when tx */
#define RXON_FLG_TGG_PROTECT_MSK        cpu_to_le32(1 << 3)
/* cck short slot & preamble */
#define RXON_FLG_SHORT_SLOT_MSK          cpu_to_le32(1 << 4)
#define RXON_FLG_SHORT_PREAMBLE_MSK     cpu_to_le32(1 << 5)
/* antenna selection */
#define RXON_FLG_DIS_DIV_MSK            cpu_to_le32(1 << 7)
#define RXON_FLG_ANT_SEL_MSK            cpu_to_le32(0x0f00)
#define RXON_FLG_ANT_A_MSK              cpu_to_le32(1 << 8)
#define RXON_FLG_ANT_B_MSK              cpu_to_le32(1 << 9)
/* radar detection enable */
#define RXON_FLG_RADAR_DETECT_MSK       cpu_to_le32(1 << 12)
#define RXON_FLG_TGJ_NARROW_BAND_MSK    cpu_to_le32(1 << 13)
/* rx response to host with 8-byte TSF
* (according to ON_AIR deassertion) */
#define RXON_FLG_TSF2HOST_MSK           cpu_to_le32(1 << 15)

/* HT flags */
#define RXON_FLG_CTRL_CHANNEL_LOC_POS  (22)
#define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22)

#define RXON_FLG_HT_OPERATING_MODE_POS  (23)

#define RXON_FLG_HT_PROT_MSK   cpu_to_le32(0x1 << 23)
#define RXON_FLG_HT40_PROT_MSK   cpu_to_le32(0x2 << 23)

#define RXON_FLG_CHANNEL_MODE_POS  (25)
#define RXON_FLG_CHANNEL_MODE_MSK  cpu_to_le32(0x3 << 25)

/* channel mode */
enum {
 CHANNEL_MODE_LEGACY = 0,
 CHANNEL_MODE_PURE_40 = 1,
 CHANNEL_MODE_MIXED = 2,
 CHANNEL_MODE_RESERVED = 3,
};
#define RXON_FLG_CHANNEL_MODE_LEGACY   \
 cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)
#define RXON_FLG_CHANNEL_MODE_PURE_40   \
 cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)
#define RXON_FLG_CHANNEL_MODE_MIXED   \
 cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)

/* CTS to self (if spec allows) flag */
#define RXON_FLG_SELF_CTS_EN   cpu_to_le32(0x1<<30)

/* rx_config filter flags */
/* accept all data frames */
#define RXON_FILTER_PROMISC_MSK         cpu_to_le32(1 << 0)
/* pass control & management to host */
#define RXON_FILTER_CTL2HOST_MSK        cpu_to_le32(1 << 1)
/* accept multi-cast */
#define RXON_FILTER_ACCEPT_GRP_MSK      cpu_to_le32(1 << 2)
/* don't decrypt uni-cast frames */
#define RXON_FILTER_DIS_DECRYPT_MSK     cpu_to_le32(1 << 3)
/* don't decrypt multi-cast frames */
#define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
/* STA is associated */
#define RXON_FILTER_ASSOC_MSK           cpu_to_le32(1 << 5)
/* transfer to host non bssid beacons in associated state */
#define RXON_FILTER_BCON_AWARE_MSK      cpu_to_le32(1 << 6)

/**
 * C_RXON = 0x10 (command, has simple generic response)
 *
 * RXON tunes the radio tuner to a service channel, and sets up a number
 * of parameters that are used primarily for Rx, but also for Tx operations.
 *
 * NOTE:  When tuning to a new channel, driver must set the
 *        RXON_FILTER_ASSOC_MSK to 0.  This will clear station-dependent
 *        info within the device, including the station tables, tx retry
 *        rate tables, and txpower tables.  Driver must build a new station
 *        table and txpower table before transmitting anything on the RXON
 *        channel.
 *
 * NOTE:  All RXONs wipe clean the internal txpower table.  Driver must
 *        issue a new C_TX_PWR_TBL after each C_RXON (0x10),
 *        regardless of whether RXON_FILTER_ASSOC_MSK is set.
 */

struct il3945_rxon_cmd {
 u8 node_addr[6];
 __le16 reserved1;
 u8 bssid_addr[6];
 __le16 reserved2;
 u8 wlap_bssid_addr[6];
 __le16 reserved3;
 u8 dev_type;
 u8 air_propagation;
 __le16 reserved4;
 u8 ofdm_basic_rates;
 u8 cck_basic_rates;
 __le16 assoc_id;
 __le32 flags;
 __le32 filter_flags;
 __le16 channel;
 __le16 reserved5;
} __packed;

struct il4965_rxon_cmd {
 u8 node_addr[6];
 __le16 reserved1;
 u8 bssid_addr[6];
 __le16 reserved2;
 u8 wlap_bssid_addr[6];
 __le16 reserved3;
 u8 dev_type;
 u8 air_propagation;
 __le16 rx_chain;
 u8 ofdm_basic_rates;
 u8 cck_basic_rates;
 __le16 assoc_id;
 __le32 flags;
 __le32 filter_flags;
 __le16 channel;
 u8 ofdm_ht_single_stream_basic_rates;
 u8 ofdm_ht_dual_stream_basic_rates;
} __packed;

/* Create a common rxon cmd which will be typecast into the 3945 or 4965
 * specific rxon cmd, depending on where it is called from.
 */
struct il_rxon_cmd {
 u8 node_addr[6];
 __le16 reserved1;
 u8 bssid_addr[6];
 __le16 reserved2;
 u8 wlap_bssid_addr[6];
 __le16 reserved3;
 u8 dev_type;
 u8 air_propagation;
 __le16 rx_chain;
 u8 ofdm_basic_rates;
 u8 cck_basic_rates;
 __le16 assoc_id;
 __le32 flags;
 __le32 filter_flags;
 __le16 channel;
 u8 ofdm_ht_single_stream_basic_rates;
 u8 ofdm_ht_dual_stream_basic_rates;
 u8 reserved4;
 u8 reserved5;
} __packed;

/*
 * C_RXON_ASSOC = 0x11 (command, has simple generic response)
 */
struct il3945_rxon_assoc_cmd {
 __le32 flags;
 __le32 filter_flags;
 u8 ofdm_basic_rates;
 u8 cck_basic_rates;
 __le16 reserved;
} __packed;

struct il4965_rxon_assoc_cmd {
 __le32 flags;
 __le32 filter_flags;
 u8 ofdm_basic_rates;
 u8 cck_basic_rates;
 u8 ofdm_ht_single_stream_basic_rates;
 u8 ofdm_ht_dual_stream_basic_rates;
 __le16 rx_chain_select_flags;
 __le16 reserved;
} __packed;

#define IL_CONN_MAX_LISTEN_INTERVAL 10
#define IL_MAX_UCODE_BEACON_INTERVAL 4 /* 4096 */
#define IL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */

/*
 * C_RXON_TIMING = 0x14 (command, has simple generic response)
 */
struct il_rxon_time_cmd {
 __le64 timestamp;
 __le16 beacon_interval;
 __le16 atim_win;
 __le32 beacon_init_val;
 __le16 listen_interval;
 u8 dtim_period;
 u8 delta_cp_bss_tbtts;
} __packed;

/*
 * C_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
 */
struct il3945_channel_switch_cmd {
 u8 band;
 u8 expect_beacon;
 __le16 channel;
 __le32 rxon_flags;
 __le32 rxon_filter_flags;
 __le32 switch_time;
 struct il3945_power_per_rate power[IL_MAX_RATES];
} __packed;

struct il4965_channel_switch_cmd {
 u8 band;
 u8 expect_beacon;
 __le16 channel;
 __le32 rxon_flags;
 __le32 rxon_filter_flags;
 __le32 switch_time;
 struct il4965_tx_power_db tx_power;
} __packed;

/*
 * N_CHANNEL_SWITCH = 0x73 (notification only, not a command)
 */
struct il_csa_notification {
 __le16 band;
 __le16 channel;
 __le32 status;  /* 0 - OK, 1 - fail */
} __packed;

/******************************************************************************
 * (2)
 * Quality-of-Service (QOS) Commands & Responses:
 *
 *****************************************************************************/

/**
 * struct il_ac_qos -- QOS timing params for C_QOS_PARAM
 * One for each of 4 EDCA access categories in struct il_qosparam_cmd
 *
 * @cw_min: Contention win, start value in numbers of slots.
 *          Should be a power-of-2, minus 1.  Device's default is 0x0f.
 * @cw_max: Contention win, max value in numbers of slots.
 *          Should be a power-of-2, minus 1.  Device's default is 0x3f.
 * @aifsn:  Number of slots in Arbitration Interframe Space (before
 *          performing random backoff timing prior to Tx).  Device default 1.
 * @edca_txop:  Length of Tx opportunity, in uSecs.  Device default is 0.
 *
 * Device will automatically increase contention win by (2*CW) + 1 for each
 * transmission retry.  Device uses cw_max as a bit mask, ANDed with new CW
 * value, to cap the CW value.
 */
struct il_ac_qos {
 __le16 cw_min;
 __le16 cw_max;
 u8 aifsn;
 u8 reserved1;
 __le16 edca_txop;
} __packed;

/* QoS flags defines */
#define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01)
#define QOS_PARAM_FLG_TGN_MSK  cpu_to_le32(0x02)
#define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10)

/* Number of Access Categories (AC) (EDCA), queues 0..3 */
#define AC_NUM                4

/*
 * C_QOS_PARAM = 0x13 (command, has simple generic response)
 *
 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
 */
struct il_qosparam_cmd {
 __le32 qos_flags;
 struct il_ac_qos ac[AC_NUM];
} __packed;

/******************************************************************************
 * (3)
 * Add/Modify Stations Commands & Responses:
 *
 *****************************************************************************/
/*
 * Multi station support
 */

/* Special, dedicated locations within device's station table */
#define IL_AP_ID  0
#define IL_STA_ID  2
#define IL3945_BROADCAST_ID 24
#define IL3945_STATION_COUNT 25
#define IL4965_BROADCAST_ID 31
#define IL4965_STATION_COUNT 32

#define IL_STATION_COUNT 32 /* MAX(3945,4965) */
#define IL_INVALID_STATION 255

#define STA_FLG_TX_RATE_MSK  cpu_to_le32(1 << 2)
#define STA_FLG_PWR_SAVE_MSK  cpu_to_le32(1 << 8)
#define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17)
#define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18)
#define STA_FLG_MAX_AGG_SIZE_POS (19)
#define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19)
#define STA_FLG_HT40_EN_MSK  cpu_to_le32(1 << 21)
#define STA_FLG_MIMO_DIS_MSK  cpu_to_le32(1 << 22)
#define STA_FLG_AGG_MPDU_DENSITY_POS (23)
#define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23)

/* Use in mode field.  1: modify existing entry, 0: add new station entry */
#define STA_CONTROL_MODIFY_MSK  0x01

/* key flags __le16*/
#define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
#define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000)
#define STA_KEY_FLG_WEP  cpu_to_le16(0x0001)
#define STA_KEY_FLG_CCMP cpu_to_le16(0x0002)
#define STA_KEY_FLG_TKIP cpu_to_le16(0x0003)

#define STA_KEY_FLG_KEYID_POS 8
#define STA_KEY_FLG_INVALID cpu_to_le16(0x0800)
/* wep key is either from global key (0) or from station info array (1) */
#define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)

/* wep key in STA: 5-bytes (0) or 13-bytes (1) */
#define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000)
#define STA_KEY_MULTICAST_MSK  cpu_to_le16(0x4000)
#define STA_KEY_MAX_NUM  8

/* Flags indicate whether to modify vs. don't change various station params */
#define STA_MODIFY_KEY_MASK  0x01
#define STA_MODIFY_TID_DISABLE_TX 0x02
#define STA_MODIFY_TX_RATE_MSK  0x04
#define STA_MODIFY_ADDBA_TID_MSK 0x08
#define STA_MODIFY_DELBA_TID_MSK 0x10
#define STA_MODIFY_SLEEP_TX_COUNT_MSK 0x20

/* Receiver address (actually, Rx station's idx into station table),
 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
#define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))

struct il4965_keyinfo {
 __le16 key_flags;
 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
 u8 reserved1;
 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
 u8 key_offset;
 u8 reserved2;
 u8 key[16];  /* 16-byte unicast decryption key */
} __packed;

/**
 * struct sta_id_modify
 * @addr[ETH_ALEN]: station's MAC address
 * @sta_id: idx of station in uCode's station table
 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
 *
 * Driver selects unused table idx when adding new station,
 * or the idx to a pre-existing station entry when modifying that station.
 * Some idxes have special purposes (IL_AP_ID, idx 0, is for AP).
 *
 * modify_mask flags select which parameters to modify vs. leave alone.
 */
struct sta_id_modify {
 u8 addr[ETH_ALEN];
 __le16 reserved1;
 u8 sta_id;
 u8 modify_mask;
 __le16 reserved2;
} __packed;

/*
 * C_ADD_STA = 0x18 (command)
 *
 * 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 (4965 devices uses
 * C_TX_LINK_QUALITY_CMD,
 * 3945 uses C_RATE_SCALE to set up rate tables).
 *
 * C_ADD_STA sets up the table entry for one station, either creating
 * a new entry, or modifying a pre-existing one.
 *
 * NOTE:  RXON command (without "associated" bit set) wipes the station table
 *        clean.  Moving into RF_KILL state does this also.  Driver must set up
 *        new station table before transmitting anything on the RXON channel
 *        (except active scans or active measurements; those commands carry
 *        their own txpower/rate setup data).
 *
 *        When getting started on a new channel, driver must set up the
 *        IL_BROADCAST_ID entry (last entry in the table).  For a client
 *        station in a BSS, once an AP is selected, driver sets up the AP STA
 *        in the IL_AP_ID entry (1st entry in the table).  BROADCAST and AP
 *        are all that are needed for a BSS client station.  If the device is
 *        used as AP, or in an IBSS network, driver must set up station table
 *        entries for all STAs in network, starting with idx IL_STA_ID.
 */

struct il3945_addsta_cmd {
 u8 mode;  /* 1: modify existing, 0: add new station */
 u8 reserved[3];
 struct sta_id_modify sta;
 struct il4965_keyinfo key;
 __le32 station_flags; /* STA_FLG_* */
 __le32 station_flags_msk; /* STA_FLG_* */

 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
 * corresponding to bit (e.g. bit 5 controls TID 5).
 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
 __le16 tid_disable_tx;

 __le16 rate_n_flags;

 /* TID for which to add block-ack support.
 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 u8 add_immediate_ba_tid;

 /* TID for which to remove block-ack support.
 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
 u8 remove_immediate_ba_tid;

 /* Starting Sequence Number for added block-ack support.
 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 __le16 add_immediate_ba_ssn;
} __packed;

struct il4965_addsta_cmd {
 u8 mode;  /* 1: modify existing, 0: add new station */
 u8 reserved[3];
 struct sta_id_modify sta;
 struct il4965_keyinfo key;
 __le32 station_flags; /* STA_FLG_* */
 __le32 station_flags_msk; /* STA_FLG_* */

 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
 * corresponding to bit (e.g. bit 5 controls TID 5).
 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
 __le16 tid_disable_tx;

 __le16 reserved1;

 /* TID for which to add block-ack support.
 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 u8 add_immediate_ba_tid;

 /* TID for which to remove block-ack support.
 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
 u8 remove_immediate_ba_tid;

 /* Starting Sequence Number for added block-ack support.
 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 __le16 add_immediate_ba_ssn;

 /*
 * Number of packets OK 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.
 */
 __le16 sleep_tx_count;

 __le16 reserved2;
} __packed;

/* Wrapper struct for 3945 and 4965 addsta_cmd structures */
struct il_addsta_cmd {
 u8 mode;  /* 1: modify existing, 0: add new station */
 u8 reserved[3];
 struct sta_id_modify sta;
 struct il4965_keyinfo key;
 __le32 station_flags; /* STA_FLG_* */
 __le32 station_flags_msk; /* STA_FLG_* */

 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
 * corresponding to bit (e.g. bit 5 controls TID 5).
 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
 __le16 tid_disable_tx;

 __le16 rate_n_flags; /* 3945 only */

 /* TID for which to add block-ack support.
 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 u8 add_immediate_ba_tid;

 /* TID for which to remove block-ack support.
 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
 u8 remove_immediate_ba_tid;

 /* Starting Sequence Number for added block-ack support.
 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 __le16 add_immediate_ba_ssn;

 /*
 * Number of packets OK 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.
 */
 __le16 sleep_tx_count;

 __le16 reserved2;
} __packed;

#define ADD_STA_SUCCESS_MSK  0x1
#define ADD_STA_NO_ROOM_IN_TBL 0x2
#define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
#define ADD_STA_MODIFY_NON_EXIST_STA 0x8
/*
 * C_ADD_STA = 0x18 (response)
 */
struct il_add_sta_resp {
 u8 status;  /* ADD_STA_* */
} __packed;

#define REM_STA_SUCCESS_MSK              0x1
/*
 *  C_REM_STA = 0x19 (response)
 */
struct il_rem_sta_resp {
 u8 status;
} __packed;

/*
 *  C_REM_STA = 0x19 (command)
 */
struct il_rem_sta_cmd {
 u8 num_sta;  /* number of removed stations */
 u8 reserved[3];
 u8 addr[ETH_ALEN]; /* MAC addr of the first station */
 u8 reserved2[2];
} __packed;

#define IL_TX_FIFO_BK_MSK  cpu_to_le32(BIT(0))
#define IL_TX_FIFO_BE_MSK  cpu_to_le32(BIT(1))
#define IL_TX_FIFO_VI_MSK  cpu_to_le32(BIT(2))
#define IL_TX_FIFO_VO_MSK  cpu_to_le32(BIT(3))
#define IL_AGG_TX_QUEUE_MSK  cpu_to_le32(0xffc00)

#define IL_DROP_SINGLE  0
#define IL_DROP_SELECTED 1
#define IL_DROP_ALL  2

/*
 * REPLY_WEP_KEY = 0x20
 */
struct il_wep_key {
 u8 key_idx;
 u8 key_offset;
 u8 reserved1[2];
 u8 key_size;
 u8 reserved2[3];
 u8 key[16];
} __packed;

struct il_wep_cmd {
 u8 num_keys;
 u8 global_key_type;
 u8 flags;
 u8 reserved;
 struct il_wep_key key[];
} __packed;

#define WEP_KEY_WEP_TYPE 1
#define WEP_KEYS_MAX 4
#define WEP_INVALID_OFFSET 0xff
#define WEP_KEY_LEN_64 5
#define WEP_KEY_LEN_128 13

/******************************************************************************
 * (4)
 * Rx Responses:
 *
 *****************************************************************************/

#define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0)
#define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1)

#define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0)
#define RX_RES_PHY_FLAGS_MOD_CCK_MSK  cpu_to_le16(1 << 1)
#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2)
#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3)
#define RX_RES_PHY_FLAGS_ANTENNA_MSK  0x70
#define RX_RES_PHY_FLAGS_ANTENNA_POS  4
#define RX_RES_PHY_FLAGS_AGG_MSK cpu_to_le16(1 << 7)

#define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
#define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
#define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
#define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
#define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
#define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)

#define RX_RES_STATUS_STATION_FOUND (1<<6)
#define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)

#define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
#define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
#define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
#define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
#define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)

#define RX_MPDU_RES_STATUS_ICV_OK (0x20)
#define RX_MPDU_RES_STATUS_MIC_OK (0x40)
#define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
#define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)

struct il3945_rx_frame_stats {
 /* New members MUST be added within the __struct_group() macro below. */
 __struct_group(il3945_rx_frame_stats_hdr, hdr, __packed,
  u8 phy_count;
  u8 id;
  u8 rssi;
  u8 agc;
  __le16 sig_avg;
  __le16 noise_diff;
 );
 u8 payload[];
} __packed;
static_assert(offsetof(struct il3945_rx_frame_stats, payload) == sizeof(struct il3945_rx_frame_stats_hdr),
       "struct member likely outside of __struct_group()");

struct il3945_rx_frame_hdr {
 /* New members MUST be added within the __struct_group() macro below. */
 __struct_group(il3945_rx_frame_hdr_hdr, hdr, __packed,
  __le16 channel;
  __le16 phy_flags;
  u8 reserved1;
  u8 rate;
  __le16 len;
 );
 u8 payload[];
} __packed;
static_assert(offsetof(struct il3945_rx_frame_hdr, payload) == sizeof(struct il3945_rx_frame_hdr_hdr),
       "struct member likely outside of __struct_group()");

struct il3945_rx_frame_end {
 __le32 status;
 __le64 timestamp;
 __le32 beacon_timestamp;
} __packed;

/*
 * N_3945_RX = 0x1b (response only, not a command)
 *
 * NOTE:  DO NOT dereference from casts to this structure
 * It is provided only for calculating minimum data set size.
 * The actual offsets of the hdr and end are dynamic based on
 * stats.phy_count
 */
struct il3945_rx_frame {
 struct il3945_rx_frame_stats_hdr stats;
 struct il3945_rx_frame_hdr_hdr hdr;
 struct il3945_rx_frame_end end;
} __packed;

#define IL39_RX_FRAME_SIZE (4 + sizeof(struct il3945_rx_frame))

/* Fixed (non-configurable) rx data from phy */

#define IL49_RX_RES_PHY_CNT 14
#define IL49_RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
#define IL49_RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
#define IL49_AGC_DB_MASK   (0x3f80) /* MASK(7,13) */
#define IL49_AGC_DB_POS   (7)
struct il4965_rx_non_cfg_phy {
 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
 u8 pad[];
} __packed;

/*
 * N_RX = 0xc3 (response only, not a command)
 * Used only for legacy (non 11n) frames.
 */
struct il_rx_phy_res {
 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
 u8 cfg_phy_cnt;  /* configurable DSP phy data byte count */
 u8 stat_id;  /* configurable DSP phy data set ID */
 u8 reserved1;
 __le64 timestamp; /* TSF at on air rise */
 __le32 beacon_time_stamp; /* beacon at on-air rise */
 __le16 phy_flags; /* general phy flags: band, modulation, ... */
 __le16 channel;  /* channel number */
 u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
 __le32 rate_n_flags; /* RATE_MCS_* */
 __le16 byte_count; /* frame's byte-count */
 __le16 frame_time; /* frame's time on the air */
} __packed;

struct il_rx_mpdu_res_start {
 __le16 byte_count;
 __le16 reserved;
} __packed;

/******************************************************************************
 * (5)
 * Tx Commands & Responses:
 *
 * Driver must place each C_TX command into one of the prioritized Tx
 * queues in host DRAM, shared between driver and device (see comments for
 * SCD registers and Tx/Rx Queues).  When the device's Tx scheduler and uCode
 * are preparing to transmit, the device pulls the Tx command over the PCI
 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
 * from which data will be transmitted.
 *
 * uCode handles all timing and protocol related to control frames
 * (RTS/CTS/ACK), based on flags in the Tx command.  uCode and Tx scheduler
 * handle reception of block-acks; uCode updates the host driver via
 * N_COMPRESSED_BA.
 *
 * uCode handles retrying Tx when an ACK is expected but not received.
 * This includes trying lower data rates than the one requested in the Tx
 * command, as set up by the C_RATE_SCALE (for 3945) or
 * C_TX_LINK_QUALITY_CMD (4965).
 *
 * Driver sets up transmit power for various rates via C_TX_PWR_TBL.
 * This command must be executed after every RXON command, before Tx can occur.
 *****************************************************************************/

/* C_TX Tx flags field */

/*
 * 1: Use Request-To-Send protocol before this frame.
 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK.
 */
#define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)

/*
 * 1: Transmit Clear-To-Send to self before this frame.
 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK.
 */
#define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)

/* 1: Expect ACK from receiving station
 * 0: Don't expect ACK (MAC header's duration field s/b 0)
 * Set this for unicast frames, but not broadcast/multicast. */
#define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)

/* For 4965 devices:
 * 1: Use rate scale table (see C_TX_LINK_QUALITY_CMD).
 *    Tx command's initial_rate_idx indicates first rate to try;
 *    uCode walks through table for additional Tx attempts.
 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
 *    This rate will be used for all Tx attempts; it will not be scaled. */
#define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)

/* 1: Expect immediate block-ack.
 * Set when Txing a block-ack request frame.  Also set TX_CMD_FLG_ACK_MSK. */
#define TX_CMD_FLG_IMM_BA_RSP_MASK  cpu_to_le32(1 << 6)

/*
 * 1: Frame requires full Tx-Op protection.
 * Set this if either RTS or CTS Tx Flag gets set.
 */
#define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)

/* Tx antenna selection field; used only for 3945, reserved (0) for 4965 devices.
 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
#define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
#define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
#define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)

/* 1: uCode overrides sequence control field in MAC header.
 * 0: Driver provides sequence control field in MAC header.
 * Set this for management frames, non-QOS data frames, non-unicast frames,
 * and also in Tx command embedded in C_SCAN for active scans. */
#define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)

/* 1: This frame is non-last MPDU; more fragments are coming.
 * 0: Last fragment, or not using fragmentation. */
#define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)

/* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
 * 0: No TSF required in outgoing frame.
 * Set this for transmitting beacons and probe responses. */
#define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)

/* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
 *    alignment of frame's payload data field.
 * 0: No pad
 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
 * field (but not both).  Driver must align frame data (i.e. data following
 * MAC header) to DWORD boundary. */
#define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)

/* accelerate aggregation support
 * 0 - no CCMP encryption; 1 - CCMP encryption */
#define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)

/* HCCA-AP - disable duration overwriting. */
#define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)

/*
 * TX command security control
 */
#define TX_CMD_SEC_WEP  0x01
#define TX_CMD_SEC_CCM  0x02
#define TX_CMD_SEC_TKIP  0x03
#define TX_CMD_SEC_MSK  0x03
#define TX_CMD_SEC_SHIFT 6
#define TX_CMD_SEC_KEY128 0x08

/*
 * C_TX = 0x1c (command)
 */

struct il3945_tx_cmd {
 /* New members MUST be added within the __struct_group() macro below. */
 __struct_group(il3945_tx_cmd_hdr, __hdr, __packed,
  /*
 * MPDU byte count:
 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
 * + 8 byte IV for CCM or TKIP (not used for WEP)
 * + Data payload
 * + 8-byte MIC (not used for CCM/WEP)
 * NOTE:  Does not include Tx command bytes, post-MAC pad bytes,
 *        MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
 * Range: 14-2342 bytes.
 */
  __le16 len;

  /*
 * MPDU or MSDU byte count for next frame.
 * Used for fragmentation and bursting, but not 11n aggregation.
 * Same as "len", but for next frame.  Set to 0 if not applicable.
 */
  __le16 next_frame_len;

  __le32 tx_flags; /* TX_CMD_FLG_* */

  u8 rate;

  /* Index of recipient station in uCode's station table */
  u8 sta_id;
  u8 tid_tspec;
  u8 sec_ctl;
  u8 key[16];
  union {
   u8 byte[8];
   __le16 word[4];
   __le32 dw[2];
  } tkip_mic;
  __le32 next_frame_info;
  union {
   __le32 life_time;
   __le32 attempt;
  } stop_time;
  u8 supp_rates[2];
  u8 rts_retry_limit; /*byte 50 */
  u8 data_retry_limit; /*byte 51 */
  union {
   __le16 pm_frame_timeout;
   __le16 attempt_duration;
  } timeout;

  /*
 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
 */
  __le16 driver_txop;
 );

 /*
 * MAC header goes here, followed by 2 bytes padding if MAC header
 * length is 26 or 30 bytes, followed by payload data
 */
 struct ieee80211_hdr hdr[];
} __packed;
static_assert(offsetof(struct il3945_tx_cmd, hdr) == sizeof(struct il3945_tx_cmd_hdr),
       "struct member likely outside of __struct_group()");

/*
 * C_TX = 0x1c (response)
 */
struct il3945_tx_resp {
 u8 failure_rts;
 u8 failure_frame;
 u8 bt_kill_count;
 u8 rate;
 __le32 wireless_media_time;
 __le32 status;  /* TX status */
} __packed;

/*
 * 4965 uCode updates these Tx attempt count values in host DRAM.
 * Used for managing Tx retries when expecting block-acks.
 * Driver should set these fields to 0.
 */
struct il_dram_scratch {
 u8 try_cnt;  /* Tx attempts */
 u8 bt_kill_cnt;  /* Tx attempts blocked by Bluetooth device */
 __le16 reserved;
} __packed;

struct il_tx_cmd {
 /* New members MUST be added within the __struct_group() macro below. */
 __struct_group(il_tx_cmd_hdr, __hdr, __packed,
  /*
 * MPDU byte count:
 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
 * + 8 byte IV for CCM or TKIP (not used for WEP)
 * + Data payload
 * + 8-byte MIC (not used for CCM/WEP)
 * NOTE:  Does not include Tx command bytes, post-MAC pad bytes,
 *        MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
 * Range: 14-2342 bytes.
 */
  __le16 len;

  /*
 * MPDU or MSDU byte count for next frame.
 * Used for fragmentation and bursting, but not 11n aggregation.
 * Same as "len", but for next frame.  Set to 0 if not applicable.
 */
  __le16 next_frame_len;

  __le32 tx_flags; /* TX_CMD_FLG_* */

  /* uCode may modify this field of the Tx command (in host DRAM!).
 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
  struct il_dram_scratch scratch;

  /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
  __le32 rate_n_flags; /* RATE_MCS_* */

  /* Index of destination station in uCode's station table */
  u8 sta_id;

  /* Type of security encryption:  CCM or TKIP */
  u8 sec_ctl;  /* TX_CMD_SEC_* */

  /*
 * Index into rate table (see C_TX_LINK_QUALITY_CMD) for initial
 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set.  Normally "0" for
 * data frames, this field may be used to selectively reduce initial
 * rate (via non-0 value) for special frames (e.g. management), while
 * still supporting rate scaling for all frames.
 */
  u8 initial_rate_idx;
  u8 reserved;
  u8 key[16];
  __le16 next_frame_flags;
  __le16 reserved2;
  union {
   __le32 life_time;
   __le32 attempt;
  } stop_time;

  /* Host DRAM physical address pointer to "scratch" in this command.
 * Must be dword aligned.  "0" in dram_lsb_ptr disables usage. */
  __le32 dram_lsb_ptr;
  u8 dram_msb_ptr;

  u8 rts_retry_limit; /*byte 50 */
  u8 data_retry_limit; /*byte 51 */
  u8 tid_tspec;
  union {
   __le16 pm_frame_timeout;
   __le16 attempt_duration;
  } timeout;

  /*
 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
 */
  __le16 driver_txop;
 );

 /*
 * MAC header goes here, followed by 2 bytes padding if MAC header
 * length is 26 or 30 bytes, followed by payload data
 */
 struct ieee80211_hdr hdr[];
} __packed;
static_assert(offsetof(struct il_tx_cmd, hdr) == sizeof(struct il_tx_cmd_hdr),
       "struct member likely outside of __struct_group()");

/* TX command response is sent after *3945* transmission attempts.
 *
 * NOTES:
 *
 * TX_STATUS_FAIL_NEXT_FRAG
 *
 * If the fragment flag in the MAC header for the frame being transmitted
 * is set and there is insufficient time to transmit the next frame, the
 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
 *
 * TX_STATUS_FIFO_UNDERRUN
 *
 * Indicates the host did not provide bytes to the FIFO fast enough while
 * a TX was in progress.
 *
 * TX_STATUS_FAIL_MGMNT_ABORT
 *
 * This status is only possible if the ABORT ON MGMT RX parameter was
 * set to true with the TX command.
 *
 * If the MSB of the status parameter is set then an abort sequence is
 * required.  This sequence consists of the host activating the TX Abort
 * control line, and then waiting for the TX Abort command response.  This
 * indicates that a the device is no longer in a transmit state, and that the
 * command FIFO has been cleared.  The host must then deactivate the TX Abort
 * control line.  Receiving is still allowed in this case.
 */
enum {
 TX_3945_STATUS_SUCCESS = 0x01,
 TX_3945_STATUS_DIRECT_DONE = 0x02,
 TX_3945_STATUS_FAIL_SHORT_LIMIT = 0x82,
 TX_3945_STATUS_FAIL_LONG_LIMIT = 0x83,
 TX_3945_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
 TX_3945_STATUS_FAIL_MGMNT_ABORT = 0x85,
 TX_3945_STATUS_FAIL_NEXT_FRAG = 0x86,
 TX_3945_STATUS_FAIL_LIFE_EXPIRE = 0x87,
 TX_3945_STATUS_FAIL_DEST_PS = 0x88,
 TX_3945_STATUS_FAIL_ABORTED = 0x89,
 TX_3945_STATUS_FAIL_BT_RETRY = 0x8a,
 TX_3945_STATUS_FAIL_STA_INVALID = 0x8b,
 TX_3945_STATUS_FAIL_FRAG_DROPPED = 0x8c,
 TX_3945_STATUS_FAIL_TID_DISABLE = 0x8d,
 TX_3945_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
 TX_3945_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
 TX_3945_STATUS_FAIL_TX_LOCKED = 0x90,
 TX_3945_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
};

/*
 * TX command response is sent after *4965* transmission attempts.
 *
 * both postpone and abort status are expected behavior from uCode. there is
 * no special operation required from driver; except for RFKILL_FLUSH,
 * which required tx flush host command to flush all the tx frames in queues
 */
enum {
 TX_STATUS_SUCCESS = 0x01,
 TX_STATUS_DIRECT_DONE = 0x02,
 /* postpone TX */
 TX_STATUS_POSTPONE_DELAY = 0x40,
 TX_STATUS_POSTPONE_FEW_BYTES = 0x41,
 TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43,
 TX_STATUS_POSTPONE_CALC_TTAK = 0x44,
 /* abort TX */
 TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81,
 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
 TX_STATUS_FAIL_DRAIN_FLOW = 0x85,
 TX_STATUS_FAIL_RFKILL_FLUSH = 0x86,
 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
 TX_STATUS_FAIL_DEST_PS = 0x88,
 TX_STATUS_FAIL_HOST_ABORTED = 0x89,
 TX_STATUS_FAIL_BT_RETRY = 0x8a,
 TX_STATUS_FAIL_STA_INVALID = 0x8b,
 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
 TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e,
 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
 TX_STATUS_FAIL_PASSIVE_NO_RX = 0x90,
 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
};

#define TX_PACKET_MODE_REGULAR  0x0000
#define TX_PACKET_MODE_BURST_SEQ 0x0100
#define TX_PACKET_MODE_BURST_FIRST 0x0200

enum {
 TX_POWER_PA_NOT_ACTIVE = 0x0,
};

enum {
 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
 TX_STATUS_DELAY_MSK = 0x00000040,
 TX_STATUS_ABORT_MSK = 0x00000080,
 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
 TX_RESERVED = 0x00780000, /* bits 19:22 */
 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
};

/* *******************************
 * TX aggregation status
 ******************************* */

enum {
 AGG_TX_STATE_TRANSMITTED = 0x00,
 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
 AGG_TX_STATE_ABORT_MSK = 0x08,
 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
 AGG_TX_STATE_DELAY_TX_MSK = 0x400
};

#define AGG_TX_STATUS_MSK 0x00000fff /* bits 0:11 */
#define AGG_TX_TRY_MSK  0x0000f000 /* bits 12:15 */

#define AGG_TX_STATE_LAST_SENT_MSK  (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
         AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK)

/* # tx attempts for first frame in aggregation */
#define AGG_TX_STATE_TRY_CNT_POS 12
#define AGG_TX_STATE_TRY_CNT_MSK 0xf000

/* Command ID and sequence number of Tx command for this frame */
#define AGG_TX_STATE_SEQ_NUM_POS 16
#define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000

/*
 * C_TX = 0x1c (response)
 *
 * This response may be in one of two slightly different formats, indicated
 * by the frame_count field:
 *
 * 1)  No aggregation (frame_count == 1).  This reports Tx results for
 *     a single frame.  Multiple attempts, at various bit rates, may have
 *     been made for this frame.
 *
 * 2)  Aggregation (frame_count > 1).  This reports Tx results for
 *     2 or more frames that used block-acknowledge.  All frames were
 *     transmitted at same rate.  Rate scaling may have been used if first
 *     frame in this new agg block failed in previous agg block(s).
 *
 *     Note that, for aggregation, ACK (block-ack) status is not delivered here;
 *     block-ack has not been received by the time the 4965 device records
 *     this status.
 *     This status relates to reasons the tx might have been blocked or aborted
 *     within the sending station (this 4965 device), rather than whether it was
 *     received successfully by the destination station.
 */
struct agg_tx_status {
 __le16 status;
 __le16 sequence;
} __packed;

struct il4965_tx_resp {
 u8 frame_count;  /* 1 no aggregation, >1 aggregation */
 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
 u8 failure_rts;  /* # failures due to unsuccessful RTS */
 u8 failure_frame; /* # failures due to no ACK (unused for agg) */

 /* For non-agg:  Rate at which frame was successful.
 * For agg:  Rate at which all frames were transmitted. */
 __le32 rate_n_flags; /* RATE_MCS_*  */

 /* For non-agg:  RTS + CTS + frame tx attempts time + ACK.
 * For agg:  RTS + CTS + aggregation tx time + block-ack time. */
 __le16 wireless_media_time; /* uSecs */

 __le16 reserved;
 __le32 pa_power1; /* RF power amplifier measurement (not used) */
 __le32 pa_power2;

 /*
 * For non-agg:  frame status TX_STATUS_*
 * For agg:  status of 1st frame, AGG_TX_STATE_*; other frame status
 *           fields follow this one, up to frame_count.
 *           Bit fields:
 *           11- 0:  AGG_TX_STATE_* status code
 *           15-12:  Retry count for 1st frame in aggregation (retries
 *                   occur if tx failed for this frame when it was a
 *                   member of a previous aggregation block).  If rate
 *                   scaling is used, retry count indicates the rate
 *                   table entry used for all frames in the new agg.
 *           31-16:  Sequence # for this frame's Tx cmd (not SSN!)
 */
 union {
  __le32 status;
  DECLARE_FLEX_ARRAY(struct agg_tx_status, agg_status); /* for each agg frame */
 } u;
} __packed;

/*
 * N_COMPRESSED_BA = 0xc5 (response only, not a command)
 *
 * Reports Block-Acknowledge from recipient station
 */
struct il_compressed_ba_resp {
 __le32 sta_addr_lo32;
 __le16 sta_addr_hi16;
 __le16 reserved;

 /* Index of recipient (BA-sending) station in uCode's station table */
 u8 sta_id;
 u8 tid;
 __le16 seq_ctl;
 __le64 bitmap;
 __le16 scd_flow;
 __le16 scd_ssn;
} __packed;

/*
 * C_TX_PWR_TBL = 0x97 (command, has simple generic response)
 *
 * See details under "TXPOWER" in 4965.h.
 */

struct il3945_txpowertable_cmd {
 u8 band;  /* 0: 5 GHz, 1: 2.4 GHz */
 u8 reserved;
 __le16 channel;
 struct il3945_power_per_rate power[IL_MAX_RATES];
} __packed;

struct il4965_txpowertable_cmd {
 u8 band;  /* 0: 5 GHz, 1: 2.4 GHz */
 u8 reserved;
 __le16 channel;
 struct il4965_tx_power_db tx_power;
} __packed;

/**
 * struct il3945_rate_scaling_cmd - Rate Scaling Command & Response
 *
 * C_RATE_SCALE = 0x47 (command, has simple generic response)
 *
 * NOTE: The table of rates passed to the uCode via the
 * RATE_SCALE command sets up the corresponding order of
 * rates used for all related commands, including rate
 * masks, etc.
 *
 * For example, if you set 9MB (PLCP 0x0f) as the first
 * rate in the rate table, the bit mask for that rate
 * when passed through ofdm_basic_rates on the C_RXON
 * command would be bit 0 (1 << 0)
 */
struct il3945_rate_scaling_info {
 __le16 rate_n_flags;
 u8 try_cnt;
 u8 next_rate_idx;
} __packed;

struct il3945_rate_scaling_cmd {
 u8 table_id;
 u8 reserved[3];
 struct il3945_rate_scaling_info table[IL_MAX_RATES];
} __packed;

/*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
#define  LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)

/* # of EDCA prioritized tx fifos */
#define  LINK_QUAL_AC_NUM AC_NUM

/* # entries in rate scale table to support Tx retries */
#define  LINK_QUAL_MAX_RETRY_NUM 16

/* Tx antenna selection values */
#define  LINK_QUAL_ANT_A_MSK (1 << 0)
#define  LINK_QUAL_ANT_B_MSK (1 << 1)
#define  LINK_QUAL_ANT_MSK   (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)

/**
 * struct il_link_qual_general_params
 *
 * Used in C_TX_LINK_QUALITY_CMD
 */
struct il_link_qual_general_params {
 u8 flags;

 /* No entries at or above this (driver chosen) idx contain MIMO */
 u8 mimo_delimiter;

 /* Best single antenna to use for single stream (legacy, SISO). */
 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */

 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */

 /*
 * If driver needs to use different initial rates for different
 * EDCA QOS access categories (as implemented by tx fifos 0-3),
 * this table will set that up, by indicating the idxes in the
 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
 * Otherwise, driver should set all entries to 0.
 *
 * Entry usage:
 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
 */
 u8 start_rate_idx[LINK_QUAL_AC_NUM];
} __packed;

#define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */
#define LINK_QUAL_AGG_TIME_LIMIT_MAX (8000)
#define LINK_QUAL_AGG_TIME_LIMIT_MIN (100)

#define LINK_QUAL_AGG_DISABLE_START_DEF (3)
#define LINK_QUAL_AGG_DISABLE_START_MAX (255)
#define LINK_QUAL_AGG_DISABLE_START_MIN (0)

#define LINK_QUAL_AGG_FRAME_LIMIT_DEF (31)
#define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)
#define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)

/**
 * struct il_link_qual_agg_params
 *
 * Used in C_TX_LINK_QUALITY_CMD
 */
struct il_link_qual_agg_params {

 /*
 *Maximum number of uSec in aggregation.
 * default set to 4000 (4 milliseconds) if not configured in .cfg
 */
 __le16 agg_time_limit;

 /*
 * Number of Tx retries allowed for a frame, before that frame will
 * no longer be considered for the start of an aggregation sequence
 * (scheduler will then try to tx it as single frame).
 * Driver should set this to 3.
 */
 u8 agg_dis_start_th;

 /*
 * Maximum number of frames in aggregation.
 * 0 = no limit (default).  1 = no aggregation.
 * Other values = max # frames in aggregation.
 */
 u8 agg_frame_cnt_limit;

 __le32 reserved;
} __packed;

/*
 * C_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
 *
 * For 4965 devices only; 3945 uses C_RATE_SCALE.
 *
 * Each station in the 4965 device's internal station table has its own table
 * of 16
 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
 * an ACK is not received.  This command replaces the entire table for
 * one station.
 *
 * NOTE:  Station must already be in 4965 device's station table.
 *   Use C_ADD_STA.
 *
 * The rate scaling procedures described below work well.  Of course, other
 * procedures are possible, and may work better for particular environments.
 *
 *
 * FILLING THE RATE TBL
 *
 * Given a particular initial rate and mode, as determined by the rate
 * scaling algorithm described below, the Linux driver uses the following
 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
 * Link Quality command:
 *
 *
 * 1)  If using High-throughput (HT) (SISO or MIMO) initial rate:
 *     a) Use this same initial rate for first 3 entries.
 *     b) Find next lower available rate using same mode (SISO or MIMO),
 *        use for next 3 entries.  If no lower rate available, switch to
 *        legacy mode (no HT40 channel, no MIMO, no short guard interval).
 *     c) If using MIMO, set command's mimo_delimiter to number of entries
 *        using MIMO (3 or 6).
 *     d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,
 *        no MIMO, no short guard interval), at the next lower bit rate
 *        (e.g. if second HT bit rate was 54, try 48 legacy), and follow
 *        legacy procedure for remaining table entries.
 *
 * 2)  If using legacy initial rate:
 *     a) Use the initial rate for only one entry.
 *     b) For each following entry, reduce the rate to next lower available
 *        rate, until reaching the lowest available rate.
 *     c) When reducing rate, also switch antenna selection.
 *     d) Once lowest available rate is reached, repeat this rate until
 *        rate table is filled (16 entries), switching antenna each entry.
 *
 *
 * ACCUMULATING HISTORY
 *
 * The rate scaling algorithm for 4965 devices, as implemented in Linux driver,
 * uses two sets of frame Tx success history:  One for the current/active
 * modulation mode, and one for a speculative/search mode that is being
 * attempted. If the speculative mode turns out to be more effective (i.e.
 * actual transfer rate is better), then the driver continues to use the
 * speculative mode as the new current active mode.
 *
 * Each history set contains, separately for each possible rate, data for a
 * sliding win of the 62 most recent tx attempts at that rate.  The data
 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
 * and attempted frames, from which the driver can additionally calculate a
 * success ratio (success / attempted) and number of failures
 * (attempted - success), and control the size of the win (attempted).
 * The driver uses the bit map to remove successes from the success sum, as
 * the oldest tx attempts fall out of the win.
 *
 * When the 4965 device makes multiple tx attempts for a given frame, each
 * attempt might be at a different rate, and have different modulation
 * characteristics (e.g. antenna, fat channel, short guard interval), as set
 * up in the rate scaling table in the Link Quality command.  The driver must
 * determine which rate table entry was used for each tx attempt, to determine
 * which rate-specific history to update, and record only those attempts that
 * match the modulation characteristics of the history set.
 *
 * When using block-ack (aggregation), all frames are transmitted at the same
 * rate, since there is no per-attempt acknowledgment from the destination
 * station.  The Tx response struct il_tx_resp indicates the Tx rate in
 * rate_n_flags field.  After receiving a block-ack, the driver can update
 * history for the entire block all at once.
 *
 *
 * FINDING BEST STARTING RATE:
 *
 * When working with a selected initial modulation mode (see below), the
 * driver attempts to find a best initial rate.  The initial rate is the
 * first entry in the Link Quality command's rate table.
 *
 * 1)  Calculate actual throughput (success ratio * expected throughput, see
 *     table below) for current initial rate.  Do this only if enough frames
 *     have been attempted to make the value meaningful:  at least 6 failed
 *     tx attempts, or at least 8 successes.  If not enough, don't try rate
 *     scaling yet.
 *
 * 2)  Find available rates adjacent to current initial rate.  Available means:
 *     a)  supported by hardware &&
 *     b)  supported by association &&
 *     c)  within any constraints selected by user
 *
 * 3)  Gather measured throughputs for adjacent rates.  These might not have
 *     enough history to calculate a throughput.  That's okay, we might try
 *     using one of them anyway!
 *
 * 4)  Try decreasing rate if, for current rate:
--> --------------------

--> maximum size reached

--> --------------------