iwlagn: move sysfs files to debugfs

[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / net / wireless / iwlwifi / iwl-dev.h

/******************************************************************************
 *
 * Copyright(c) 2003 - 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.
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 *****************************************************************************/
/*
 * Please use this file (iwl-dev.h) for driver implementation definitions.
 * Please use iwl-commands.h for uCode API definitions.
 */

#ifndef __iwl_dev_h__
#define __iwl_dev_h__

#include <linux/interrupt.h>
#include <linux/kernel.h>
#include <linux/wait.h>
#include <linux/leds.h>
#include <linux/slab.h>
#include <net/ieee80211_radiotap.h>

#include "iwl-eeprom.h"
#include "iwl-csr.h"
#include "iwl-prph.h"
#include "iwl-debug.h"
#include "iwl-agn-hw.h"
#include "iwl-led.h"
#include "iwl-power.h"
#include "iwl-agn-rs.h"
#include "iwl-agn-tt.h"
#include "iwl-bus.h"
#include "iwl-trans.h"
#include "iwl-shared.h"

struct iwl_tx_queue;

/* CT-KILL constants */
#define CT_KILL_THRESHOLD_LEGACY   110 /* in Celsius */
#define CT_KILL_THRESHOLD          114 /* in Celsius */
#define CT_KILL_EXIT_THRESHOLD     95  /* in Celsius */

/* Default noise level to report when noise measurement is not available.
 *   This may be because we're:
 *   1)  Not associated (4965, no beacon statistics being sent to driver)
 *   2)  Scanning (noise measurement does not apply to associated channel)
 *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
 * Use default noise value of -127 ... this is below the range of measurable
 *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
 *   Also, -127 works better than 0 when averaging frames with/without
 *   noise info (e.g. averaging might be done in app); measured dBm values are
 *   always negative ... using a negative value as the default keeps all
 *   averages within an s8's (used in some apps) range of negative values. */
#define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)

/*
 * RTS threshold here is total size [2347] minus 4 FCS bytes
 * Per spec:
 *   a value of 0 means RTS on all data/management packets
 *   a value > max MSDU size means no RTS
 * else RTS for data/management frames where MPDU is larger
 *   than RTS value.
 */
#define DEFAULT_RTS_THRESHOLD     2347U
#define MIN_RTS_THRESHOLD         0U
#define MAX_RTS_THRESHOLD         2347U
#define MAX_MSDU_SIZE             2304U
#define MAX_MPDU_SIZE             2346U
#define DEFAULT_BEACON_INTERVAL   200U
#define DEFAULT_SHORT_RETRY_LIMIT 7U
#define DEFAULT_LONG_RETRY_LIMIT  4U

#define IWL_NUM_SCAN_RATES         (2)

/*
 * One for each channel, holds all channel setup data
 * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
 *     with one another!
 */
struct iwl_channel_info {
        struct iwl_eeprom_channel eeprom;       /* EEPROM regulatory limit */
        struct iwl_eeprom_channel ht40_eeprom;  /* EEPROM regulatory limit for
                                                 * HT40 channel */

        u8 channel;       /* channel number */
        u8 flags;         /* flags copied from EEPROM */
        s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
        s8 curr_txpow;    /* (dBm) regulatory/spectrum/user (not h/w) limit */
        s8 min_power;     /* always 0 */
        s8 scan_power;    /* (dBm) regul. eeprom, direct scans, any rate */

        u8 group_index;   /* 0-4, maps channel to group1/2/3/4/5 */
        u8 band_index;    /* 0-4, maps channel to band1/2/3/4/5 */
        enum ieee80211_band band;

        /* HT40 channel info */
        s8 ht40_max_power_avg;  /* (dBm) regul. eeprom, normal Tx, any rate */
        u8 ht40_flags;          /* flags copied from EEPROM */
        u8 ht40_extension_channel; /* HT_IE_EXT_CHANNEL_* */
};

/*
 * Minimum number of queues. MAX_NUM is defined in hw specific files.
 * Set the minimum to accommodate
 *  - 4 standard TX queues
 *  - the command queue
 *  - 4 PAN TX queues
 *  - the PAN multicast queue, and
 *  - the AUX (TX during scan dwell) queue.
 */
#define IWL_MIN_NUM_QUEUES      11

/*
 * Command queue depends on iPAN support.
 */
#define IWL_DEFAULT_CMD_QUEUE_NUM       4
#define IWL_IPAN_CMD_QUEUE_NUM          9

#define IEEE80211_DATA_LEN              2304
#define IEEE80211_4ADDR_LEN             30
#define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
#define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)

#define SUP_RATE_11A_MAX_NUM_CHANNELS  8
#define SUP_RATE_11B_MAX_NUM_CHANNELS  4
#define SUP_RATE_11G_MAX_NUM_CHANNELS  12

#define IWL_SUPPORTED_RATES_IE_LEN         8

#define IWL_INVALID_RATE     0xFF
#define IWL_INVALID_VALUE    -1

union iwl_ht_rate_supp {
        u16 rates;
        struct {
                u8 siso_rate;
                u8 mimo_rate;
        };
};

#define CFG_HT_RX_AMPDU_FACTOR_8K   (0x0)
#define CFG_HT_RX_AMPDU_FACTOR_16K  (0x1)
#define CFG_HT_RX_AMPDU_FACTOR_32K  (0x2)
#define CFG_HT_RX_AMPDU_FACTOR_64K  (0x3)
#define CFG_HT_RX_AMPDU_FACTOR_DEF  CFG_HT_RX_AMPDU_FACTOR_64K
#define CFG_HT_RX_AMPDU_FACTOR_MAX  CFG_HT_RX_AMPDU_FACTOR_64K
#define CFG_HT_RX_AMPDU_FACTOR_MIN  CFG_HT_RX_AMPDU_FACTOR_8K

/*
 * Maximal MPDU density for TX aggregation
 * 4 - 2us density
 * 5 - 4us density
 * 6 - 8us density
 * 7 - 16us density
 */
#define CFG_HT_MPDU_DENSITY_2USEC   (0x4)
#define CFG_HT_MPDU_DENSITY_4USEC   (0x5)
#define CFG_HT_MPDU_DENSITY_8USEC   (0x6)
#define CFG_HT_MPDU_DENSITY_16USEC  (0x7)
#define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_4USEC
#define CFG_HT_MPDU_DENSITY_MAX CFG_HT_MPDU_DENSITY_16USEC
#define CFG_HT_MPDU_DENSITY_MIN     (0x1)

struct iwl_ht_config {
        bool single_chain_sufficient;
        enum ieee80211_smps_mode smps; /* current smps mode */
};

/* QoS structures */
struct iwl_qos_info {
        int qos_active;
        struct iwl_qosparam_cmd def_qos_parm;
};

/*
 * Structure should be accessed with sta_lock held. When station addition
 * is in progress (IWL_STA_UCODE_INPROGRESS) it is possible to access only
 * the commands (iwl_addsta_cmd and iwl_link_quality_cmd) without sta_lock
 * held.
 */
struct iwl_station_entry {
        struct iwl_addsta_cmd sta;
        u8 used, ctxid;
        struct iwl_link_quality_cmd *lq;
};

struct iwl_station_priv_common {
        struct iwl_rxon_context *ctx;
        u8 sta_id;
};

/*
 * iwl_station_priv: Driver's private station information
 *
 * When mac80211 creates a station it reserves some space (hw->sta_data_size)
 * in the structure for use by driver. This structure is places in that
 * space.
 */
struct iwl_station_priv {
        struct iwl_station_priv_common common;
        struct iwl_lq_sta lq_sta;
        atomic_t pending_frames;
        bool client;
        bool asleep;
        u8 max_agg_bufsize;
};

/**
 * struct iwl_vif_priv - driver's private per-interface information
 *
 * When mac80211 allocates a virtual interface, it can allocate
 * space for us to put data into.
 */
struct iwl_vif_priv {
        struct iwl_rxon_context *ctx;
        u8 ibss_bssid_sta_id;
};

/* one for each uCode image (inst/data, boot/init/runtime) */
struct fw_desc {
        void *v_addr;           /* access by driver */
        dma_addr_t p_addr;      /* access by card's busmaster DMA */
        u32 len;                /* bytes */
};

struct fw_img {
        struct fw_desc code, data;
};

/* v1/v2 uCode file layout */
struct iwl_ucode_header {
        __le32 ver;     /* major/minor/API/serial */
        union {
                struct {
                        __le32 inst_size;       /* bytes of runtime code */
                        __le32 data_size;       /* bytes of runtime data */
                        __le32 init_size;       /* bytes of init code */
                        __le32 init_data_size;  /* bytes of init data */
                        __le32 boot_size;       /* bytes of bootstrap code */
                        u8 data[0];             /* in same order as sizes */
                } v1;
                struct {
                        __le32 build;           /* build number */
                        __le32 inst_size;       /* bytes of runtime code */
                        __le32 data_size;       /* bytes of runtime data */
                        __le32 init_size;       /* bytes of init code */
                        __le32 init_data_size;  /* bytes of init data */
                        __le32 boot_size;       /* bytes of bootstrap code */
                        u8 data[0];             /* in same order as sizes */
                } v2;
        } u;
};

/*
 * new TLV uCode file layout
 *
 * The new TLV file format contains TLVs, that each specify
 * some piece of data. To facilitate "groups", for example
 * different instruction image with different capabilities,
 * bundled with the same init image, an alternative mechanism
 * is provided:
 * When the alternative field is 0, that means that the item
 * is always valid. When it is non-zero, then it is only
 * valid in conjunction with items of the same alternative,
 * in which case the driver (user) selects one alternative
 * to use.
 */

enum iwl_ucode_tlv_type {
        IWL_UCODE_TLV_INVALID           = 0, /* unused */
        IWL_UCODE_TLV_INST              = 1,
        IWL_UCODE_TLV_DATA              = 2,
        IWL_UCODE_TLV_INIT              = 3,
        IWL_UCODE_TLV_INIT_DATA         = 4,
        IWL_UCODE_TLV_BOOT              = 5,
        IWL_UCODE_TLV_PROBE_MAX_LEN     = 6, /* a u32 value */
        IWL_UCODE_TLV_PAN               = 7,
        IWL_UCODE_TLV_RUNT_EVTLOG_PTR   = 8,
        IWL_UCODE_TLV_RUNT_EVTLOG_SIZE  = 9,
        IWL_UCODE_TLV_RUNT_ERRLOG_PTR   = 10,
        IWL_UCODE_TLV_INIT_EVTLOG_PTR   = 11,
        IWL_UCODE_TLV_INIT_EVTLOG_SIZE  = 12,
        IWL_UCODE_TLV_INIT_ERRLOG_PTR   = 13,
        IWL_UCODE_TLV_ENHANCE_SENS_TBL  = 14,
        IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
        IWL_UCODE_TLV_WOWLAN_INST       = 16,
        IWL_UCODE_TLV_WOWLAN_DATA       = 17,
        IWL_UCODE_TLV_FLAGS             = 18,
};

/**
 * enum iwl_ucode_tlv_flag - ucode API flags
 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
 *      was a separate TLV but moved here to save space.
 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
 *      treats good CRC threshold as a boolean
 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
 */
enum iwl_ucode_tlv_flag {
        IWL_UCODE_TLV_FLAGS_PAN         = BIT(0),
        IWL_UCODE_TLV_FLAGS_NEWSCAN     = BIT(1),
        IWL_UCODE_TLV_FLAGS_MFP         = BIT(2),
        IWL_UCODE_TLV_FLAGS_P2P         = BIT(3),
};

struct iwl_ucode_tlv {
        __le16 type;            /* see above */
        __le16 alternative;     /* see comment */
        __le32 length;          /* not including type/length fields */
        u8 data[0];
} __packed;

#define IWL_TLV_UCODE_MAGIC     0x0a4c5749

struct iwl_tlv_ucode_header {
        /*
         * The TLV style ucode header is distinguished from
         * the v1/v2 style header by first four bytes being
         * zero, as such is an invalid combination of
         * major/minor/API/serial versions.
         */
        __le32 zero;
        __le32 magic;
        u8 human_readable[64];
        __le32 ver;             /* major/minor/API/serial */
        __le32 build;
        __le64 alternatives;    /* bitmask of valid alternatives */
        /*
         * The data contained herein has a TLV layout,
         * see above for the TLV header and types.
         * Note that each TLV is padded to a length
         * that is a multiple of 4 for alignment.
         */
        u8 data[0];
};

struct iwl_sensitivity_ranges {
        u16 min_nrg_cck;
        u16 max_nrg_cck;

        u16 nrg_th_cck;
        u16 nrg_th_ofdm;

        u16 auto_corr_min_ofdm;
        u16 auto_corr_min_ofdm_mrc;
        u16 auto_corr_min_ofdm_x1;
        u16 auto_corr_min_ofdm_mrc_x1;

        u16 auto_corr_max_ofdm;
        u16 auto_corr_max_ofdm_mrc;
        u16 auto_corr_max_ofdm_x1;
        u16 auto_corr_max_ofdm_mrc_x1;

        u16 auto_corr_max_cck;
        u16 auto_corr_max_cck_mrc;
        u16 auto_corr_min_cck;
        u16 auto_corr_min_cck_mrc;

        u16 barker_corr_th_min;
        u16 barker_corr_th_min_mrc;
        u16 nrg_th_cca;
};


#define KELVIN_TO_CELSIUS(x) ((x)-273)
#define CELSIUS_TO_KELVIN(x) ((x)+273)


/******************************************************************************
 *
 * Functions implemented in core module which are forward declared here
 * for use by iwl-[4-5].c
 *
 * NOTE:  The implementation of these functions are not hardware specific
 * which is why they are in the core module files.
 *
 * Naming convention --
 * iwl_         <-- Is part of iwlwifi
 * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
 *
 ****************************************************************************/
extern void iwl_update_chain_flags(struct iwl_priv *priv);
extern const u8 iwl_bcast_addr[ETH_ALEN];

#define IWL_OPERATION_MODE_AUTO     0
#define IWL_OPERATION_MODE_HT_ONLY  1
#define IWL_OPERATION_MODE_MIXED    2
#define IWL_OPERATION_MODE_20MHZ    3

#define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000

/* Sensitivity and chain noise calibration */
#define INITIALIZATION_VALUE            0xFFFF
#define IWL_CAL_NUM_BEACONS             16
#define MAXIMUM_ALLOWED_PATHLOSS        15

#define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3

#define MAX_FA_OFDM  50
#define MIN_FA_OFDM  5
#define MAX_FA_CCK   50
#define MIN_FA_CCK   5

#define AUTO_CORR_STEP_OFDM       1

#define AUTO_CORR_STEP_CCK     3
#define AUTO_CORR_MAX_TH_CCK   160

#define NRG_DIFF               2
#define NRG_STEP_CCK           2
#define NRG_MARGIN             8
#define MAX_NUMBER_CCK_NO_FA 100

#define AUTO_CORR_CCK_MIN_VAL_DEF    (125)

#define CHAIN_A             0
#define CHAIN_B             1
#define CHAIN_C             2
#define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
#define ALL_BAND_FILTER                 0xFF00
#define IN_BAND_FILTER                  0xFF
#define MIN_AVERAGE_NOISE_MAX_VALUE     0xFFFFFFFF

#define NRG_NUM_PREV_STAT_L     20
#define NUM_RX_CHAINS           3

enum iwlagn_false_alarm_state {
        IWL_FA_TOO_MANY = 0,
        IWL_FA_TOO_FEW = 1,
        IWL_FA_GOOD_RANGE = 2,
};

enum iwlagn_chain_noise_state {
        IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
        IWL_CHAIN_NOISE_ACCUMULATE,
        IWL_CHAIN_NOISE_CALIBRATED,
        IWL_CHAIN_NOISE_DONE,
};


/*
 * enum iwl_calib
 * defines the order in which results of initial calibrations
 * should be sent to the runtime uCode
 */
enum iwl_calib {
        IWL_CALIB_XTAL,
        IWL_CALIB_DC,
        IWL_CALIB_LO,
        IWL_CALIB_TX_IQ,
        IWL_CALIB_TX_IQ_PERD,
        IWL_CALIB_BASE_BAND,
        IWL_CALIB_TEMP_OFFSET,
        IWL_CALIB_MAX
};

/* Opaque calibration results */
struct iwl_calib_result {
        void *buf;
        size_t buf_len;
};

/* Sensitivity calib data */
struct iwl_sensitivity_data {
        u32 auto_corr_ofdm;
        u32 auto_corr_ofdm_mrc;
        u32 auto_corr_ofdm_x1;
        u32 auto_corr_ofdm_mrc_x1;
        u32 auto_corr_cck;
        u32 auto_corr_cck_mrc;

        u32 last_bad_plcp_cnt_ofdm;
        u32 last_fa_cnt_ofdm;
        u32 last_bad_plcp_cnt_cck;
        u32 last_fa_cnt_cck;

        u32 nrg_curr_state;
        u32 nrg_prev_state;
        u32 nrg_value[10];
        u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
        u32 nrg_silence_ref;
        u32 nrg_energy_idx;
        u32 nrg_silence_idx;
        u32 nrg_th_cck;
        s32 nrg_auto_corr_silence_diff;
        u32 num_in_cck_no_fa;
        u32 nrg_th_ofdm;

        u16 barker_corr_th_min;
        u16 barker_corr_th_min_mrc;
        u16 nrg_th_cca;
};

/* Chain noise (differential Rx gain) calib data */
struct iwl_chain_noise_data {
        u32 active_chains;
        u32 chain_noise_a;
        u32 chain_noise_b;
        u32 chain_noise_c;
        u32 chain_signal_a;
        u32 chain_signal_b;
        u32 chain_signal_c;
        u16 beacon_count;
        u8 disconn_array[NUM_RX_CHAINS];
        u8 delta_gain_code[NUM_RX_CHAINS];
        u8 radio_write;
        u8 state;
};

#define EEPROM_SEM_TIMEOUT 10           /* milliseconds */
#define EEPROM_SEM_RETRY_LIMIT 1000     /* number of attempts (not time) */

enum {
        MEASUREMENT_READY = (1 << 0),
        MEASUREMENT_ACTIVE = (1 << 1),
};

enum iwl_nvm_type {
        NVM_DEVICE_TYPE_EEPROM = 0,
        NVM_DEVICE_TYPE_OTP,
};

/*
 * Two types of OTP memory access modes
 *   IWL_OTP_ACCESS_ABSOLUTE - absolute address mode,
 *                              based on physical memory addressing
 *   IWL_OTP_ACCESS_RELATIVE - relative address mode,
 *                             based on logical memory addressing
 */
enum iwl_access_mode {
        IWL_OTP_ACCESS_ABSOLUTE,
        IWL_OTP_ACCESS_RELATIVE,
};

/**
 * enum iwl_pa_type - Power Amplifier type
 * @IWL_PA_SYSTEM:  based on uCode configuration
 * @IWL_PA_INTERNAL: use Internal only
 */
enum iwl_pa_type {
        IWL_PA_SYSTEM = 0,
        IWL_PA_INTERNAL = 1,
};

/* reply_tx_statistics (for _agn devices) */
struct reply_tx_error_statistics {
        u32 pp_delay;
        u32 pp_few_bytes;
        u32 pp_bt_prio;
        u32 pp_quiet_period;
        u32 pp_calc_ttak;
        u32 int_crossed_retry;
        u32 short_limit;
        u32 long_limit;
        u32 fifo_underrun;
        u32 drain_flow;
        u32 rfkill_flush;
        u32 life_expire;
        u32 dest_ps;
        u32 host_abort;
        u32 bt_retry;
        u32 sta_invalid;
        u32 frag_drop;
        u32 tid_disable;
        u32 fifo_flush;
        u32 insuff_cf_poll;
        u32 fail_hw_drop;
        u32 sta_color_mismatch;
        u32 unknown;
};

/* reply_agg_tx_statistics (for _agn devices) */
struct reply_agg_tx_error_statistics {
        u32 underrun;
        u32 bt_prio;
        u32 few_bytes;
        u32 abort;
        u32 last_sent_ttl;
        u32 last_sent_try;
        u32 last_sent_bt_kill;
        u32 scd_query;
        u32 bad_crc32;
        u32 response;
        u32 dump_tx;
        u32 delay_tx;
        u32 unknown;
};

/* management statistics */
enum iwl_mgmt_stats {
        MANAGEMENT_ASSOC_REQ = 0,
        MANAGEMENT_ASSOC_RESP,
        MANAGEMENT_REASSOC_REQ,
        MANAGEMENT_REASSOC_RESP,
        MANAGEMENT_PROBE_REQ,
        MANAGEMENT_PROBE_RESP,
        MANAGEMENT_BEACON,
        MANAGEMENT_ATIM,
        MANAGEMENT_DISASSOC,
        MANAGEMENT_AUTH,
        MANAGEMENT_DEAUTH,
        MANAGEMENT_ACTION,
        MANAGEMENT_MAX,
};
/* control statistics */
enum iwl_ctrl_stats {
        CONTROL_BACK_REQ =  0,
        CONTROL_BACK,
        CONTROL_PSPOLL,
        CONTROL_RTS,
        CONTROL_CTS,
        CONTROL_ACK,
        CONTROL_CFEND,
        CONTROL_CFENDACK,
        CONTROL_MAX,
};

struct traffic_stats {
#ifdef CONFIG_IWLWIFI_DEBUGFS
        u32 mgmt[MANAGEMENT_MAX];
        u32 ctrl[CONTROL_MAX];
        u32 data_cnt;
        u64 data_bytes;
#endif
};

/*
 * schedule the timer to wake up every UCODE_TRACE_PERIOD milliseconds
 * to perform continuous uCode event logging operation if enabled
 */
#define UCODE_TRACE_PERIOD (100)

/*
 * iwl_event_log: current uCode event log position
 *
 * @ucode_trace: enable/disable ucode continuous trace timer
 * @num_wraps: how many times the event buffer wraps
 * @next_entry:  the entry just before the next one that uCode would fill
 * @non_wraps_count: counter for no wrap detected when dump ucode events
 * @wraps_once_count: counter for wrap once detected when dump ucode events
 * @wraps_more_count: counter for wrap more than once detected
 *                    when dump ucode events
 */
struct iwl_event_log {
        bool ucode_trace;
        u32 num_wraps;
        u32 next_entry;
        int non_wraps_count;
        int wraps_once_count;
        int wraps_more_count;
};

/*
 * This is the threshold value of plcp error rate per 100mSecs.  It is
 * used to set and check for the validity of plcp_delta.
 */
#define IWL_MAX_PLCP_ERR_THRESHOLD_MIN  (1)
#define IWL_MAX_PLCP_ERR_THRESHOLD_DEF  (50)
#define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF     (100)
#define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF (200)
#define IWL_MAX_PLCP_ERR_THRESHOLD_MAX  (255)
#define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE      (0)

#define IWL_DELAY_NEXT_FORCE_RF_RESET  (HZ*3)
#define IWL_DELAY_NEXT_FORCE_FW_RELOAD (HZ*5)

/* TX queue watchdog timeouts in mSecs */
#define IWL_DEF_WD_TIMEOUT      (2000)
#define IWL_LONG_WD_TIMEOUT     (10000)
#define IWL_MAX_WD_TIMEOUT      (120000)

/* BT Antenna Coupling Threshold (dB) */
#define IWL_BT_ANTENNA_COUPLING_THRESHOLD       (35)

/* Firmware reload counter and Timestamp */
#define IWL_MIN_RELOAD_DURATION         1000 /* 1000 ms */
#define IWL_MAX_CONTINUE_RELOAD_CNT     4


enum iwl_reset {
        IWL_RF_RESET = 0,
        IWL_FW_RESET,
        IWL_MAX_FORCE_RESET,
};

struct iwl_force_reset {
        int reset_request_count;
        int reset_success_count;
        int reset_reject_count;
        unsigned long reset_duration;
        unsigned long last_force_reset_jiffies;
};

/* extend beacon time format bit shifting  */
/*
 * for _agn devices
 * bits 31:22 - extended
 * bits 21:0  - interval
 */
#define IWLAGN_EXT_BEACON_TIME_POS      22

/**
 * struct iwl_notification_wait - notification wait entry
 * @list: list head for global list
 * @fn: function called with the notification
 * @cmd: command ID
 *
 * This structure is not used directly, to wait for a
 * notification declare it on the stack, and call
 * iwlagn_init_notification_wait() with appropriate
 * parameters. Then do whatever will cause the ucode
 * to notify the driver, and to wait for that then
 * call iwlagn_wait_notification().
 *
 * Each notification is one-shot. If at some point we
 * need to support multi-shot notifications (which
 * can't be allocated on the stack) we need to modify
 * the code for them.
 */
struct iwl_notification_wait {
        struct list_head list;

        void (*fn)(struct iwl_priv *priv, struct iwl_rx_packet *pkt,
                   void *data);
        void *fn_data;

        u8 cmd;
        bool triggered, aborted;
};

struct iwl_rxon_context {
        struct ieee80211_vif *vif;

        /*
         * We could use the vif to indicate active, but we
         * also need it to be active during disabling when
         * we already removed the vif for type setting.
         */
        bool always_active, is_active;

        bool ht_need_multiple_chains;

        enum iwl_rxon_context_id ctxid;

        u32 interface_modes, exclusive_interface_modes;
        u8 unused_devtype, ap_devtype, ibss_devtype, station_devtype;

        /*
         * We declare this const so it can only be
         * changed via explicit cast within the
         * routines that actually update the physical
         * hardware.
         */
        const struct iwl_rxon_cmd active;
        struct iwl_rxon_cmd staging;

        struct iwl_rxon_time_cmd timing;

        struct iwl_qos_info qos_data;

        u8 bcast_sta_id, ap_sta_id;

        u8 rxon_cmd, rxon_assoc_cmd, rxon_timing_cmd;
        u8 qos_cmd;
        u8 wep_key_cmd;

        struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
        u8 key_mapping_keys;

        __le32 station_flags;

        int beacon_int;

        struct {
                bool non_gf_sta_present;
                u8 protection;
                bool enabled, is_40mhz;
                u8 extension_chan_offset;
        } ht;

        u8 bssid[ETH_ALEN];
        bool preauth_bssid;

        bool last_tx_rejected;
};

enum iwl_scan_type {
        IWL_SCAN_NORMAL,
        IWL_SCAN_RADIO_RESET,
        IWL_SCAN_ROC,
};

enum iwlagn_ucode_type {
        IWL_UCODE_NONE,
        IWL_UCODE_REGULAR,
        IWL_UCODE_INIT,
        IWL_UCODE_WOWLAN,
};

#ifdef CONFIG_IWLWIFI_DEVICE_SVTOOL
struct iwl_testmode_trace {
        u32 buff_size;
        u32 total_size;
        u32 num_chunks;
        u8 *cpu_addr;
        u8 *trace_addr;
        dma_addr_t dma_addr;
        bool trace_enabled;
};
#endif

struct iwl_priv {

        /*data shared among all the driver's layers */
        struct iwl_shared _shrd;
        struct iwl_shared *shrd;

        /* ieee device used by generic ieee processing code */
        struct ieee80211_hw *hw;
        struct ieee80211_channel *ieee_channels;
        struct ieee80211_rate *ieee_rates;
        struct kmem_cache *tx_cmd_pool;
        struct iwl_cfg *cfg;

        enum ieee80211_band band;

        void (*pre_rx_handler)(struct iwl_priv *priv,
                               struct iwl_rx_mem_buffer *rxb);
        void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
                                       struct iwl_rx_mem_buffer *rxb);

        struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];

        /* spectrum measurement report caching */
        struct iwl_spectrum_notification measure_report;
        u8 measurement_status;

        /* ucode beacon time */
        u32 ucode_beacon_time;
        int missed_beacon_threshold;

        /* track IBSS manager (last beacon) status */
        u32 ibss_manager;

        /* jiffies when last recovery from statistics was performed */
        unsigned long rx_statistics_jiffies;

        /*counters */
        u32 rx_handlers_stats[REPLY_MAX];

        /* force reset */
        struct iwl_force_reset force_reset[IWL_MAX_FORCE_RESET];

        /* firmware reload counter and timestamp */
        unsigned long reload_jiffies;
        int reload_count;

        /* we allocate array of iwl_channel_info for NIC's valid channels.
         *    Access via channel # using indirect index array */
        struct iwl_channel_info *channel_info;  /* channel info array */
        u8 channel_count;       /* # of channels */

        /* thermal calibration */
        s32 temperature;        /* degrees Kelvin */
        s32 last_temperature;

        /* init calibration results */
        struct iwl_calib_result calib_results[IWL_CALIB_MAX];

        /* Scan related variables */
        unsigned long scan_start;
        unsigned long scan_start_tsf;
        void *scan_cmd;
        enum ieee80211_band scan_band;
        struct cfg80211_scan_request *scan_request;
        struct ieee80211_vif *scan_vif;
        enum iwl_scan_type scan_type;
        u8 scan_tx_ant[IEEE80211_NUM_BANDS];
        u8 mgmt_tx_ant;

        /*TODO: remove these pointers - use bus(priv) instead */
        struct iwl_bus *bus;    /* bus specific data */

        /* max number of station keys */
        u8 sta_key_max_num;

        bool new_scan_threshold_behaviour;

        /* EEPROM MAC addresses */
        struct mac_address addresses[2];

        /* uCode images, save to reload in case of failure */
        int fw_index;                   /* firmware we're trying to load */
        u32 ucode_ver;                  /* version of ucode, copy of
                                           iwl_ucode.ver */

        struct fw_img ucode_rt;
        struct fw_img ucode_init;
        struct fw_img ucode_wowlan;

        enum iwlagn_ucode_type ucode_type;
        u8 ucode_write_complete;        /* the image write is complete */
        char firmware_name[25];

        struct iwl_rxon_context contexts[NUM_IWL_RXON_CTX];

        __le16 switch_channel;

        struct {
                u32 error_event_table;
                u32 log_event_table;
        } device_pointers;

        u16 active_rate;

        u8 start_calib;
        struct iwl_sensitivity_data sensitivity_data;
        struct iwl_chain_noise_data chain_noise_data;
        bool enhance_sensitivity_table;
        __le16 sensitivity_tbl[HD_TABLE_SIZE];
        __le16 enhance_sensitivity_tbl[ENHANCE_HD_TABLE_ENTRIES];

        struct iwl_ht_config current_ht_config;

        /* Rate scaling data */
        u8 retry_rate;

        int activity_timer_active;

        /* counts mgmt, ctl, and data packets */
        struct traffic_stats tx_stats;
        struct traffic_stats rx_stats;

        struct iwl_power_mgr power_data;
        struct iwl_tt_mgmt thermal_throttle;

        /* station table variables */
        int num_stations;
        struct iwl_station_entry stations[IWLAGN_STATION_COUNT];
        unsigned long ucode_key_table;

        u8 mac80211_registered;

        /* Indication if ieee80211_ops->open has been called */
        u8 is_open;

        /* eeprom -- this is in the card's little endian byte order */
        u8 *eeprom;
        int    nvm_device_type;
        struct iwl_eeprom_calib_info *calib_info;

        enum nl80211_iftype iw_mode;

        /* Last Rx'd beacon timestamp */
        u64 timestamp;

        struct {
                __le32 flag;
                struct statistics_general_common common;
                struct statistics_rx_non_phy rx_non_phy;
                struct statistics_rx_phy rx_ofdm;
                struct statistics_rx_ht_phy rx_ofdm_ht;
                struct statistics_rx_phy rx_cck;
                struct statistics_tx tx;
#ifdef CONFIG_IWLWIFI_DEBUGFS
                struct statistics_bt_activity bt_activity;
                __le32 num_bt_kills, accum_num_bt_kills;
#endif
        } statistics;
#ifdef CONFIG_IWLWIFI_DEBUGFS
        struct {
                struct statistics_general_common common;
                struct statistics_rx_non_phy rx_non_phy;
                struct statistics_rx_phy rx_ofdm;
                struct statistics_rx_ht_phy rx_ofdm_ht;
                struct statistics_rx_phy rx_cck;
                struct statistics_tx tx;
                struct statistics_bt_activity bt_activity;
        } accum_stats, delta_stats, max_delta_stats;
#endif

        /*
         * reporting the number of tids has AGG on. 0 means
         * no AGGREGATION
         */
        u8 agg_tids_count;

        struct iwl_rx_phy_res last_phy_res;
        bool last_phy_res_valid;

        struct completion firmware_loading_complete;

        u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
        u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;

        /*
         * chain noise reset and gain commands are the
         * two extra calibration commands follows the standard
         * phy calibration commands
         */
        u8 phy_calib_chain_noise_reset_cmd;
        u8 phy_calib_chain_noise_gain_cmd;

        /* counts reply_tx error */
        struct reply_tx_error_statistics reply_tx_stats;
        struct reply_agg_tx_error_statistics reply_agg_tx_stats;
        /* notification wait support */
        struct list_head notif_waits;
        spinlock_t notif_wait_lock;
        wait_queue_head_t notif_waitq;

        /* remain-on-channel offload support */
        struct ieee80211_channel *hw_roc_channel;
        struct delayed_work hw_roc_disable_work;
        enum nl80211_channel_type hw_roc_chantype;
        int hw_roc_duration;
        bool hw_roc_setup;

        /* bt coex */
        u8 bt_enable_flag;
        u8 bt_status;
        u8 bt_traffic_load, last_bt_traffic_load;
        bool bt_ch_announce;
        bool bt_full_concurrent;
        bool bt_ant_couple_ok;
        __le32 kill_ack_mask;
        __le32 kill_cts_mask;
        __le16 bt_valid;
        u16 bt_on_thresh;
        u16 bt_duration;
        u16 dynamic_frag_thresh;
        u8 bt_ci_compliance;
        struct work_struct bt_traffic_change_work;
        bool bt_enable_pspoll;
        struct iwl_rxon_context *cur_rssi_ctx;
        bool bt_is_sco;

        struct work_struct restart;
        struct work_struct scan_completed;
        struct work_struct abort_scan;

        struct work_struct beacon_update;
        struct iwl_rxon_context *beacon_ctx;
        struct sk_buff *beacon_skb;
        void *beacon_cmd;

        struct work_struct tt_work;
        struct work_struct ct_enter;
        struct work_struct ct_exit;
        struct work_struct start_internal_scan;
        struct work_struct tx_flush;
        struct work_struct bt_full_concurrency;
        struct work_struct bt_runtime_config;

        struct delayed_work scan_check;

        /* TX Power */
        s8 tx_power_user_lmt;
        s8 tx_power_device_lmt;
        s8 tx_power_lmt_in_half_dbm; /* max tx power in half-dBm format */
        s8 tx_power_next;

#ifdef CONFIG_IWLWIFI_DEBUGFS
        /* debugfs */
        u16 tx_traffic_idx;
        u16 rx_traffic_idx;
        u8 *tx_traffic;
        u8 *rx_traffic;
        struct dentry *debugfs_dir;
        u32 dbgfs_sram_offset, dbgfs_sram_len;
        bool disable_ht40;
        void *wowlan_sram;
#endif /* CONFIG_IWLWIFI_DEBUGFS */

        struct work_struct txpower_work;
        u32 disable_sens_cal;
        u32 disable_chain_noise_cal;
        struct work_struct run_time_calib_work;
        struct timer_list statistics_periodic;
        struct timer_list ucode_trace;
        struct timer_list watchdog;

        struct iwl_event_log event_log;

        struct led_classdev led;
        unsigned long blink_on, blink_off;
        bool led_registered;
#ifdef CONFIG_IWLWIFI_DEVICE_SVTOOL
        struct iwl_testmode_trace testmode_trace;
        u32 tm_fixed_rate;
#endif

        /* WoWLAN GTK rekey data */
        u8 kck[NL80211_KCK_LEN], kek[NL80211_KEK_LEN];
        __le64 replay_ctr;
        __le16 last_seq_ctl;
        bool have_rekey_data;
}; /*iwl_priv */

extern struct iwl_mod_params iwlagn_mod_params;

static inline struct iwl_rxon_context *
iwl_rxon_ctx_from_vif(struct ieee80211_vif *vif)
{
        struct iwl_vif_priv *vif_priv = (void *)vif->drv_priv;

        return vif_priv->ctx;
}

#define for_each_context(priv, ctx)                             \
        for (ctx = &priv->contexts[IWL_RXON_CTX_BSS];           \
             ctx < &priv->contexts[NUM_IWL_RXON_CTX]; ctx++)    \
                if (priv->shrd->valid_contexts & BIT(ctx->ctxid))

static inline int iwl_is_associated_ctx(struct iwl_rxon_context *ctx)
{
        return (ctx->active.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
}

static inline int iwl_is_associated(struct iwl_priv *priv,
                                    enum iwl_rxon_context_id ctxid)
{
        return iwl_is_associated_ctx(&priv->contexts[ctxid]);
}

static inline int iwl_is_any_associated(struct iwl_priv *priv)
{
        struct iwl_rxon_context *ctx;
        for_each_context(priv, ctx)
                if (iwl_is_associated_ctx(ctx))
                        return true;
        return false;
}

static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
{
        if (ch_info == NULL)
                return 0;
        return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
}

static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
{
        return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
}

static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
{
        return ch_info->band == IEEE80211_BAND_5GHZ;
}

static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
{
        return ch_info->band == IEEE80211_BAND_2GHZ;
}

static inline int is_channel_passive(const struct iwl_channel_info *ch)
{
        return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
}

static inline int is_channel_ibss(const struct iwl_channel_info *ch)
{
        return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
}

#endif                          /* __iwl_dev_h__ */