drivers/net/wireless/iwlwifi/iwl-dev.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2008 Intel Corporation. All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  * The full GNU General Public License is included in this distribution in the
  19  * file called LICENSE.
  20  *
  21  * Contact Information:
  22  * James P. Ketrenos <ipw2100-admin@linux.intel.com>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  *****************************************************************************/
  26 /*
  27  * Please use this file (iwl-dev.h) for driver implementation definitions.
  28  * Please use iwl-commands.h for uCode API definitions.
  29  * Please use iwl-4965-hw.h for hardware-related definitions.
  30  */
  31
  32 #ifndef __iwl_dev_h__
  33 #define __iwl_dev_h__
  34
  35 #include <linux/pci.h> /* for struct pci_device_id */
  36 #include <linux/kernel.h>
  37 #include <net/ieee80211_radiotap.h>
  38
  39 #define DRV_NAME        "iwlagn"
  40 #include "iwl-rfkill.h"
  41 #include "iwl-eeprom.h"
  42 #include "iwl-4965-hw.h"
  43 #include "iwl-csr.h"
  44 #include "iwl-prph.h"
  45 #include "iwl-debug.h"
  46 #include "iwl-led.h"
  47 #include "iwl-power.h"
  48 #include "iwl-agn-rs.h"
  49
  50 /* configuration for the iwl4965 */
  51 extern struct iwl_cfg iwl4965_agn_cfg;
  52 extern struct iwl_cfg iwl5300_agn_cfg;
  53 extern struct iwl_cfg iwl5100_agn_cfg;
  54 extern struct iwl_cfg iwl5350_agn_cfg;
  55 extern struct iwl_cfg iwl5100_bg_cfg;
  56 extern struct iwl_cfg iwl5100_abg_cfg;
  57
  58 /* CT-KILL constants */
  59 #define CT_KILL_THRESHOLD       110 /* in Celsius */
  60
  61 /* Default noise level to report when noise measurement is not available.
  62  *   This may be because we're:
  63  *   1)  Not associated (4965, no beacon statistics being sent to driver)
  64  *   2)  Scanning (noise measurement does not apply to associated channel)
  65  *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
  66  * Use default noise value of -127 ... this is below the range of measurable
  67  *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
  68  *   Also, -127 works better than 0 when averaging frames with/without
  69  *   noise info (e.g. averaging might be done in app); measured dBm values are
  70  *   always negative ... using a negative value as the default keeps all
  71  *   averages within an s8's (used in some apps) range of negative values. */
  72 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
  73
  74 /*
  75  * RTS threshold here is total size [2347] minus 4 FCS bytes
  76  * Per spec:
  77  *   a value of 0 means RTS on all data/management packets
  78  *   a value > max MSDU size means no RTS
  79  * else RTS for data/management frames where MPDU is larger
  80  *   than RTS value.
  81  */
  82 #define DEFAULT_RTS_THRESHOLD     2347U
  83 #define MIN_RTS_THRESHOLD         0U
  84 #define MAX_RTS_THRESHOLD         2347U
  85 #define MAX_MSDU_SIZE             2304U
  86 #define MAX_MPDU_SIZE             2346U
  87 #define DEFAULT_BEACON_INTERVAL   100U
  88 #define DEFAULT_SHORT_RETRY_LIMIT 7U
  89 #define DEFAULT_LONG_RETRY_LIMIT  4U
  90
  91 struct iwl_rx_mem_buffer {
  92         dma_addr_t dma_addr;
  93         struct sk_buff *skb;
  94         struct list_head list;
  95 };
  96
  97 /*
  98  * Generic queue structure
  99  *
 100  * Contains common data for Rx and Tx queues
 101  */
 102 struct iwl_queue {
 103         int n_bd;              /* number of BDs in this queue */
 104         int write_ptr;       /* 1-st empty entry (index) host_w*/
 105         int read_ptr;         /* last used entry (index) host_r*/
 106         dma_addr_t dma_addr;   /* physical addr for BD's */
 107         int n_window;          /* safe queue window */
 108         u32 id;
 109         int low_mark;          /* low watermark, resume queue if free
 110                                 * space more than this */
 111         int high_mark;         /* high watermark, stop queue if free
 112                                 * space less than this */
 113 } __attribute__ ((packed));
 114
 115 #define MAX_NUM_OF_TBS          (20)
 116
 117 /* One for each TFD */
 118 struct iwl_tx_info {
 119         struct sk_buff *skb[MAX_NUM_OF_TBS];
 120 };
 121
 122 /**
 123  * struct iwl_tx_queue - Tx Queue for DMA
 124  * @q: generic Rx/Tx queue descriptor
 125  * @bd: base of circular buffer of TFDs
 126  * @cmd: array of command/Tx buffers
 127  * @dma_addr_cmd: physical address of cmd/tx buffer array
 128  * @txb: array of per-TFD driver data
 129  * @need_update: indicates need to update read/write index
 130  * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
 131  *
 132  * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
 133  * descriptors) and required locking structures.
 134  */
 135 struct iwl_tx_queue {
 136         struct iwl_queue q;
 137         struct iwl_tfd_frame *bd;
 138         struct iwl_cmd *cmd[TFD_TX_CMD_SLOTS];
 139         struct iwl_tx_info *txb;
 140         int need_update;
 141         int sched_retry;
 142         int active;
 143 };
 144
 145 #define IWL_NUM_SCAN_RATES         (2)
 146
 147 struct iwl4965_channel_tgd_info {
 148         u8 type;
 149         s8 max_power;
 150 };
 151
 152 struct iwl4965_channel_tgh_info {
 153         s64 last_radar_time;
 154 };
 155
 156 /*
 157  * One for each channel, holds all channel setup data
 158  * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
 159  *     with one another!
 160  */
 161 struct iwl_channel_info {
 162         struct iwl4965_channel_tgd_info tgd;
 163         struct iwl4965_channel_tgh_info tgh;
 164         struct iwl_eeprom_channel eeprom;       /* EEPROM regulatory limit */
 165         struct iwl_eeprom_channel fat_eeprom;   /* EEPROM regulatory limit for
 166                                                  * FAT channel */
 167
 168         u8 channel;       /* channel number */
 169         u8 flags;         /* flags copied from EEPROM */
 170         s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
 171         s8 curr_txpow;    /* (dBm) regulatory/spectrum/user (not h/w) limit */
 172         s8 min_power;     /* always 0 */
 173         s8 scan_power;    /* (dBm) regul. eeprom, direct scans, any rate */
 174
 175         u8 group_index;   /* 0-4, maps channel to group1/2/3/4/5 */
 176         u8 band_index;    /* 0-4, maps channel to band1/2/3/4/5 */
 177         enum ieee80211_band band;
 178
 179         /* FAT channel info */
 180         s8 fat_max_power_avg;   /* (dBm) regul. eeprom, normal Tx, any rate */
 181         s8 fat_curr_txpow;      /* (dBm) regulatory/spectrum/user (not h/w) */
 182         s8 fat_min_power;       /* always 0 */
 183         s8 fat_scan_power;      /* (dBm) eeprom, direct scans, any rate */
 184         u8 fat_flags;           /* flags copied from EEPROM */
 185         u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
 186 };
 187
 188 struct iwl4965_clip_group {
 189         /* maximum power level to prevent clipping for each rate, derived by
 190          *   us from this band's saturation power in EEPROM */
 191         const s8 clip_powers[IWL_MAX_RATES];
 192 };
 193
 194
 195 #define IWL_TX_FIFO_AC0 0
 196 #define IWL_TX_FIFO_AC1 1
 197 #define IWL_TX_FIFO_AC2 2
 198 #define IWL_TX_FIFO_AC3 3
 199 #define IWL_TX_FIFO_HCCA_1      5
 200 #define IWL_TX_FIFO_HCCA_2      6
 201 #define IWL_TX_FIFO_NONE        7
 202
 203 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
 204 #define IWL_MIN_NUM_QUEUES      4
 205
 206 /* Power management (not Tx power) structures */
 207
 208 enum iwl_pwr_src {
 209         IWL_PWR_SRC_VMAIN,
 210         IWL_PWR_SRC_VAUX,
 211 };
 212
 213 #define IEEE80211_DATA_LEN              2304
 214 #define IEEE80211_4ADDR_LEN             30
 215 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
 216 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
 217
 218 struct iwl_frame {
 219         union {
 220                 struct ieee80211_hdr frame;
 221                 struct iwl_tx_beacon_cmd beacon;
 222                 u8 raw[IEEE80211_FRAME_LEN];
 223                 u8 cmd[360];
 224         } u;
 225         struct list_head list;
 226 };
 227
 228 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
 229 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
 230 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
 231
 232 enum {
 233         /* CMD_SIZE_NORMAL = 0, */
 234         CMD_SIZE_HUGE = (1 << 0),
 235         /* CMD_SYNC = 0, */
 236         CMD_ASYNC = (1 << 1),
 237         /* CMD_NO_SKB = 0, */
 238         CMD_WANT_SKB = (1 << 2),
 239 };
 240
 241 struct iwl_cmd;
 242 struct iwl_priv;
 243
 244 struct iwl_cmd_meta {
 245         struct iwl_cmd_meta *source;
 246         union {
 247                 struct sk_buff *skb;
 248                 int (*callback)(struct iwl_priv *priv,
 249                                 struct iwl_cmd *cmd, struct sk_buff *skb);
 250         } __attribute__ ((packed)) u;
 251
 252         /* The CMD_SIZE_HUGE flag bit indicates that the command
 253          * structure is stored at the end of the shared queue memory. */
 254         u32 flags;
 255
 256 } __attribute__ ((packed));
 257
 258 #define IWL_CMD_MAX_PAYLOAD 320
 259
 260 /**
 261  * struct iwl_cmd
 262  *
 263  * For allocation of the command and tx queues, this establishes the overall
 264  * size of the largest command we send to uCode, except for a scan command
 265  * (which is relatively huge; space is allocated separately).
 266  */
 267 struct iwl_cmd {
 268         struct iwl_cmd_meta meta;       /* driver data */
 269         struct iwl_cmd_header hdr;      /* uCode API */
 270         union {
 271                 struct iwl_addsta_cmd addsta;
 272                 struct iwl_led_cmd led;
 273                 u32 flags;
 274                 u8 val8;
 275                 u16 val16;
 276                 u32 val32;
 277                 struct iwl4965_bt_cmd bt;
 278                 struct iwl_powertable_cmd powertable;
 279                 struct iwl_qosparam_cmd qosparam;
 280                 struct iwl_tx_cmd tx;
 281                 struct iwl4965_rxon_assoc_cmd rxon_assoc;
 282                 struct iwl_rem_sta_cmd rm_sta;
 283                 u8 *indirect;
 284                 u8 payload[IWL_CMD_MAX_PAYLOAD];
 285         } __attribute__ ((packed)) cmd;
 286 } __attribute__ ((packed));
 287
 288 struct iwl_host_cmd {
 289         u8 id;
 290         u16 len;
 291         struct iwl_cmd_meta meta;
 292         const void *data;
 293 };
 294
 295 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_cmd) - \
 296                               sizeof(struct iwl_cmd_meta))
 297
 298 /*
 299  * RX related structures and functions
 300  */
 301 #define RX_FREE_BUFFERS 64
 302 #define RX_LOW_WATERMARK 8
 303
 304 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
 305 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
 306 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
 307
 308 /**
 309  * struct iwl_rx_queue - Rx queue
 310  * @processed: Internal index to last handled Rx packet
 311  * @read: Shared index to newest available Rx buffer
 312  * @write: Shared index to oldest written Rx packet
 313  * @free_count: Number of pre-allocated buffers in rx_free
 314  * @rx_free: list of free SKBs for use
 315  * @rx_used: List of Rx buffers with no SKB
 316  * @need_update: flag to indicate we need to update read/write index
 317  *
 318  * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
 319  */
 320 struct iwl_rx_queue {
 321         __le32 *bd;
 322         dma_addr_t dma_addr;
 323         struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
 324         struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
 325         u32 processed;
 326         u32 read;
 327         u32 write;
 328         u32 free_count;
 329         struct list_head rx_free;
 330         struct list_head rx_used;
 331         int need_update;
 332         spinlock_t lock;
 333 };
 334
 335 #define IWL_SUPPORTED_RATES_IE_LEN         8
 336
 337 #define SCAN_INTERVAL 100
 338
 339 #define MAX_A_CHANNELS  252
 340 #define MIN_A_CHANNELS  7
 341
 342 #define MAX_B_CHANNELS  14
 343 #define MIN_B_CHANNELS  1
 344
 345 #define MAX_TID_COUNT        9
 346
 347 #define IWL_INVALID_RATE     0xFF
 348 #define IWL_INVALID_VALUE    -1
 349
 350 /**
 351  * struct iwl_ht_agg -- aggregation status while waiting for block-ack
 352  * @txq_id: Tx queue used for Tx attempt
 353  * @frame_count: # frames attempted by Tx command
 354  * @wait_for_ba: Expect block-ack before next Tx reply
 355  * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
 356  * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
 357  * @bitmap1: High order, one bit for each frame pending ACK in Tx window
 358  * @rate_n_flags: Rate at which Tx was attempted
 359  *
 360  * If REPLY_TX indicates that aggregation was attempted, driver must wait
 361  * for block ack (REPLY_COMPRESSED_BA).  This struct stores tx reply info
 362  * until block ack arrives.
 363  */
 364 struct iwl_ht_agg {
 365         u16 txq_id;
 366         u16 frame_count;
 367         u16 wait_for_ba;
 368         u16 start_idx;
 369         u64 bitmap;
 370         u32 rate_n_flags;
 371 #define IWL_AGG_OFF 0
 372 #define IWL_AGG_ON 1
 373 #define IWL_EMPTYING_HW_QUEUE_ADDBA 2
 374 #define IWL_EMPTYING_HW_QUEUE_DELBA 3
 375         u8 state;
 376 };
 377
 378
 379 struct iwl_tid_data {
 380         u16 seq_number;
 381         u16 tfds_in_queue;
 382         struct iwl_ht_agg agg;
 383 };
 384
 385 struct iwl_hw_key {
 386         enum ieee80211_key_alg alg;
 387         int keylen;
 388         u8 keyidx;
 389         u8 key[32];
 390 };
 391
 392 union iwl4965_ht_rate_supp {
 393         u16 rates;
 394         struct {
 395                 u8 siso_rate;
 396                 u8 mimo_rate;
 397         };
 398 };
 399
 400 #define CFG_HT_RX_AMPDU_FACTOR_DEF  (0x3)
 401 #define CFG_HT_MPDU_DENSITY_2USEC   (0x5)
 402 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC
 403
 404 struct iwl_ht_info {
 405         /* self configuration data */
 406         u8 is_ht;
 407         u8 supported_chan_width;
 408         u8 sm_ps;
 409         u8 is_green_field;
 410         u8 sgf;                 /* HT_SHORT_GI_* short guard interval */
 411         u8 max_amsdu_size;
 412         u8 ampdu_factor;
 413         u8 mpdu_density;
 414         struct ieee80211_mcs_info mcs;
 415         /* BSS related data */
 416         u8 control_channel;
 417         u8 extension_chan_offset;
 418         u8 tx_chan_width;
 419         u8 ht_protection;
 420         u8 non_GF_STA_present;
 421 };
 422
 423 union iwl_qos_capabity {
 424         struct {
 425                 u8 edca_count:4;        /* bit 0-3 */
 426                 u8 q_ack:1;             /* bit 4 */
 427                 u8 queue_request:1;     /* bit 5 */
 428                 u8 txop_request:1;      /* bit 6 */
 429                 u8 reserved:1;          /* bit 7 */
 430         } q_AP;
 431         struct {
 432                 u8 acvo_APSD:1;         /* bit 0 */
 433                 u8 acvi_APSD:1;         /* bit 1 */
 434                 u8 ac_bk_APSD:1;        /* bit 2 */
 435                 u8 ac_be_APSD:1;        /* bit 3 */
 436                 u8 q_ack:1;             /* bit 4 */
 437                 u8 max_len:2;           /* bit 5-6 */
 438                 u8 more_data_ack:1;     /* bit 7 */
 439         } q_STA;
 440         u8 val;
 441 };
 442
 443 /* QoS structures */
 444 struct iwl_qos_info {
 445         int qos_enable;
 446         int qos_active;
 447         union iwl_qos_capabity qos_cap;
 448         struct iwl_qosparam_cmd def_qos_parm;
 449 };
 450
 451 #define STA_PS_STATUS_WAKE             0
 452 #define STA_PS_STATUS_SLEEP            1
 453
 454 struct iwl_station_entry {
 455         struct iwl_addsta_cmd sta;
 456         struct iwl_tid_data tid[MAX_TID_COUNT];
 457         u8 used;
 458         u8 ps_status;
 459         struct iwl_hw_key keyinfo;
 460 };
 461
 462 /* one for each uCode image (inst/data, boot/init/runtime) */
 463 struct fw_desc {
 464         void *v_addr;           /* access by driver */
 465         dma_addr_t p_addr;      /* access by card's busmaster DMA */
 466         u32 len;                /* bytes */
 467 };
 468
 469 /* uCode file layout */
 470 struct iwl_ucode {
 471         __le32 ver;             /* major/minor/subminor */
 472         __le32 inst_size;       /* bytes of runtime instructions */
 473         __le32 data_size;       /* bytes of runtime data */
 474         __le32 init_size;       /* bytes of initialization instructions */
 475         __le32 init_data_size;  /* bytes of initialization data */
 476         __le32 boot_size;       /* bytes of bootstrap instructions */
 477         u8 data[0];             /* data in same order as "size" elements */
 478 };
 479
 480 struct iwl4965_ibss_seq {
 481         u8 mac[ETH_ALEN];
 482         u16 seq_num;
 483         u16 frag_num;
 484         unsigned long packet_time;
 485         struct list_head list;
 486 };
 487
 488 struct iwl_sensitivity_ranges {
 489         u16 min_nrg_cck;
 490         u16 max_nrg_cck;
 491
 492         u16 nrg_th_cck;
 493         u16 nrg_th_ofdm;
 494
 495         u16 auto_corr_min_ofdm;
 496         u16 auto_corr_min_ofdm_mrc;
 497         u16 auto_corr_min_ofdm_x1;
 498         u16 auto_corr_min_ofdm_mrc_x1;
 499
 500         u16 auto_corr_max_ofdm;
 501         u16 auto_corr_max_ofdm_mrc;
 502         u16 auto_corr_max_ofdm_x1;
 503         u16 auto_corr_max_ofdm_mrc_x1;
 504
 505         u16 auto_corr_max_cck;
 506         u16 auto_corr_max_cck_mrc;
 507         u16 auto_corr_min_cck;
 508         u16 auto_corr_min_cck_mrc;
 509 };
 510
 511
 512 #define IWL_FAT_CHANNEL_52 BIT(IEEE80211_BAND_5GHZ)
 513
 514 /**
 515  * struct iwl_hw_params
 516  * @max_txq_num: Max # Tx queues supported
 517  * @tx/rx_chains_num: Number of TX/RX chains
 518  * @valid_tx/rx_ant: usable antennas
 519  * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
 520  * @max_rxq_log: Log-base-2 of max_rxq_size
 521  * @rx_buf_size: Rx buffer size
 522  * @max_stations:
 523  * @bcast_sta_id:
 524  * @fat_channel: is 40MHz width possible in band 2.4
 525  * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
 526  * @sw_crypto: 0 for hw, 1 for sw
 527  * @max_xxx_size: for ucode uses
 528  * @ct_kill_threshold: temperature threshold
 529  * @calib_init_cfg: setup initial claibrations for the hw
 530  * @struct iwl_sensitivity_ranges: range of sensitivity values
 531  * @first_ampdu_q: first HW queue available for ampdu
 532  */
 533 struct iwl_hw_params {
 534         u16 max_txq_num;
 535         u8  tx_chains_num;
 536         u8  rx_chains_num;
 537         u8  valid_tx_ant;
 538         u8  valid_rx_ant;
 539         u16 max_rxq_size;
 540         u16 max_rxq_log;
 541         u32 rx_buf_size;
 542         u32 max_pkt_size;
 543         u8  max_stations;
 544         u8  bcast_sta_id;
 545         u8 fat_channel;
 546         u8 sw_crypto;
 547         u32 max_inst_size;
 548         u32 max_data_size;
 549         u32 max_bsm_size;
 550         u32 ct_kill_threshold; /* value in hw-dependent units */
 551         u32 calib_init_cfg;
 552         const struct iwl_sensitivity_ranges *sens;
 553         u8 first_ampdu_q;
 554 };
 555
 556 #define HT_SHORT_GI_20MHZ       (1 << 0)
 557 #define HT_SHORT_GI_40MHZ       (1 << 1)
 558
 559
 560 #define IWL_RX_HDR(x) ((struct iwl4965_rx_frame_hdr *)(\
 561                        x->u.rx_frame.stats.payload + \
 562                        x->u.rx_frame.stats.phy_count))
 563 #define IWL_RX_END(x) ((struct iwl4965_rx_frame_end *)(\
 564                        IWL_RX_HDR(x)->payload + \
 565                        le16_to_cpu(IWL_RX_HDR(x)->len)))
 566 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
 567 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
 568
 569 /******************************************************************************
 570  *
 571  * Functions implemented in core module which are forward declared here
 572  * for use by iwl-[4-5].c
 573  *
 574  * NOTE:  The implementation of these functions are not hardware specific
 575  * which is why they are in the core module files.
 576  *
 577  * Naming convention --
 578  * iwl_         <-- Is part of iwlwifi
 579  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
 580  * iwl4965_bg_      <-- Called from work queue context
 581  * iwl4965_mac_     <-- mac80211 callback
 582  *
 583  ****************************************************************************/
 584 struct iwl_addsta_cmd;
 585 extern int iwl_send_add_sta(struct iwl_priv *priv,
 586                             struct iwl_addsta_cmd *sta, u8 flags);
 587 extern u8 iwl_add_station_flags(struct iwl_priv *priv, const u8 *addr,
 588                         int is_ap, u8 flags, struct ieee80211_sta_ht_cap *ht_info);
 589 extern void iwl4965_update_chain_flags(struct iwl_priv *priv);
 590 extern int iwl4965_set_pwr_src(struct iwl_priv *priv, enum iwl_pwr_src src);
 591 extern const u8 iwl_bcast_addr[ETH_ALEN];
 592 extern int iwl_rxq_stop(struct iwl_priv *priv);
 593 extern void iwl_txq_ctx_stop(struct iwl_priv *priv);
 594 extern int iwl_queue_space(const struct iwl_queue *q);
 595 static inline int iwl_queue_used(const struct iwl_queue *q, int i)
 596 {
 597         return q->write_ptr > q->read_ptr ?
 598                 (i >= q->read_ptr && i < q->write_ptr) :
 599                 !(i < q->read_ptr && i >= q->write_ptr);
 600 }
 601
 602
 603 static inline u8 get_cmd_index(struct iwl_queue *q, u32 index, int is_huge)
 604 {
 605         /* This is for scan command, the big buffer at end of command array */
 606         if (is_huge)
 607                 return q->n_window;     /* must be power of 2 */
 608
 609         /* Otherwise, use normal size buffers */
 610         return index & (q->n_window - 1);
 611 }
 612
 613
 614 struct iwl_priv;
 615
 616
 617 /* Structures, enum, and defines specific to the 4965 */
 618
 619 #define IWL_KW_SIZE 0x1000      /*4k */
 620
 621 struct iwl_kw {
 622         dma_addr_t dma_addr;
 623         void *v_addr;
 624         size_t size;
 625 };
 626
 627 #define IWL_CHANNEL_WIDTH_20MHZ   0
 628 #define IWL_CHANNEL_WIDTH_40MHZ   1
 629
 630 #define IWL_OPERATION_MODE_AUTO     0
 631 #define IWL_OPERATION_MODE_HT_ONLY  1
 632 #define IWL_OPERATION_MODE_MIXED    2
 633 #define IWL_OPERATION_MODE_20MHZ    3
 634
 635 #define IWL_TX_CRC_SIZE 4
 636 #define IWL_TX_DELIMITER_SIZE 4
 637
 638 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
 639
 640 /* Sensitivity and chain noise calibration */
 641 #define INTERFERENCE_DATA_AVAILABLE     __constant_cpu_to_le32(1)
 642 #define INITIALIZATION_VALUE            0xFFFF
 643 #define CAL_NUM_OF_BEACONS              20
 644 #define MAXIMUM_ALLOWED_PATHLOSS        15
 645
 646 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
 647
 648 #define MAX_FA_OFDM  50
 649 #define MIN_FA_OFDM  5
 650 #define MAX_FA_CCK   50
 651 #define MIN_FA_CCK   5
 652
 653 #define AUTO_CORR_STEP_OFDM       1
 654
 655 #define AUTO_CORR_STEP_CCK     3
 656 #define AUTO_CORR_MAX_TH_CCK   160
 657
 658 #define NRG_DIFF               2
 659 #define NRG_STEP_CCK           2
 660 #define NRG_MARGIN             8
 661 #define MAX_NUMBER_CCK_NO_FA 100
 662
 663 #define AUTO_CORR_CCK_MIN_VAL_DEF    (125)
 664
 665 #define CHAIN_A             0
 666 #define CHAIN_B             1
 667 #define CHAIN_C             2
 668 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
 669 #define ALL_BAND_FILTER                 0xFF00
 670 #define IN_BAND_FILTER                  0xFF
 671 #define MIN_AVERAGE_NOISE_MAX_VALUE     0xFFFFFFFF
 672
 673 #define NRG_NUM_PREV_STAT_L     20
 674 #define NUM_RX_CHAINS           3
 675
 676 enum iwl4965_false_alarm_state {
 677         IWL_FA_TOO_MANY = 0,
 678         IWL_FA_TOO_FEW = 1,
 679         IWL_FA_GOOD_RANGE = 2,
 680 };
 681
 682 enum iwl4965_chain_noise_state {
 683         IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
 684         IWL_CHAIN_NOISE_ACCUMULATE,
 685         IWL_CHAIN_NOISE_CALIBRATED,
 686         IWL_CHAIN_NOISE_DONE,
 687 };
 688
 689 enum iwl4965_calib_enabled_state {
 690         IWL_CALIB_DISABLED = 0,  /* must be 0 */
 691         IWL_CALIB_ENABLED = 1,
 692 };
 693
 694 struct statistics_general_data {
 695         u32 beacon_silence_rssi_a;
 696         u32 beacon_silence_rssi_b;
 697         u32 beacon_silence_rssi_c;
 698         u32 beacon_energy_a;
 699         u32 beacon_energy_b;
 700         u32 beacon_energy_c;
 701 };
 702
 703 /* Opaque calibration results */
 704 struct iwl_calib_result {
 705         void *buf;
 706         size_t buf_len;
 707 };
 708
 709 enum ucode_type {
 710         UCODE_NONE = 0,
 711         UCODE_INIT,
 712         UCODE_RT
 713 };
 714
 715 /* Sensitivity calib data */
 716 struct iwl_sensitivity_data {
 717         u32 auto_corr_ofdm;
 718         u32 auto_corr_ofdm_mrc;
 719         u32 auto_corr_ofdm_x1;
 720         u32 auto_corr_ofdm_mrc_x1;
 721         u32 auto_corr_cck;
 722         u32 auto_corr_cck_mrc;
 723
 724         u32 last_bad_plcp_cnt_ofdm;
 725         u32 last_fa_cnt_ofdm;
 726         u32 last_bad_plcp_cnt_cck;
 727         u32 last_fa_cnt_cck;
 728
 729         u32 nrg_curr_state;
 730         u32 nrg_prev_state;
 731         u32 nrg_value[10];
 732         u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
 733         u32 nrg_silence_ref;
 734         u32 nrg_energy_idx;
 735         u32 nrg_silence_idx;
 736         u32 nrg_th_cck;
 737         s32 nrg_auto_corr_silence_diff;
 738         u32 num_in_cck_no_fa;
 739         u32 nrg_th_ofdm;
 740 };
 741
 742 /* Chain noise (differential Rx gain) calib data */
 743 struct iwl_chain_noise_data {
 744         u32 active_chains;
 745         u32 chain_noise_a;
 746         u32 chain_noise_b;
 747         u32 chain_noise_c;
 748         u32 chain_signal_a;
 749         u32 chain_signal_b;
 750         u32 chain_signal_c;
 751         u16 beacon_count;
 752         u8 disconn_array[NUM_RX_CHAINS];
 753         u8 delta_gain_code[NUM_RX_CHAINS];
 754         u8 radio_write;
 755         u8 state;
 756 };
 757
 758 #define EEPROM_SEM_TIMEOUT 10           /* milliseconds */
 759 #define EEPROM_SEM_RETRY_LIMIT 1000     /* number of attempts (not time) */
 760
 761
 762 enum {
 763         MEASUREMENT_READY = (1 << 0),
 764         MEASUREMENT_ACTIVE = (1 << 1),
 765 };
 766
 767
 768 #define IWL_MAX_NUM_QUEUES      20 /* FIXME: do dynamic allocation */
 769 #define IWL_CALIB_MAX  4
 770
 771 struct iwl_priv {
 772
 773         /* ieee device used by generic ieee processing code */
 774         struct ieee80211_hw *hw;
 775         struct ieee80211_channel *ieee_channels;
 776         struct ieee80211_rate *ieee_rates;
 777         struct iwl_cfg *cfg;
 778
 779         /* temporary frame storage list */
 780         struct list_head free_frames;
 781         int frames_count;
 782
 783         enum ieee80211_band band;
 784         int alloc_rxb_skb;
 785
 786         void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
 787                                        struct iwl_rx_mem_buffer *rxb);
 788
 789         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 790
 791 #ifdef CONFIG_IWLAGN_SPECTRUM_MEASUREMENT
 792         /* spectrum measurement report caching */
 793         struct iwl4965_spectrum_notification measure_report;
 794         u8 measurement_status;
 795 #endif
 796         /* ucode beacon time */
 797         u32 ucode_beacon_time;
 798
 799         /* we allocate array of iwl4965_channel_info for NIC's valid channels.
 800          *    Access via channel # using indirect index array */
 801         struct iwl_channel_info *channel_info;  /* channel info array */
 802         u8 channel_count;       /* # of channels */
 803
 804         /* each calibration channel group in the EEPROM has a derived
 805          * clip setting for each rate. */
 806         const struct iwl4965_clip_group clip_groups[5];
 807
 808         /* thermal calibration */
 809         s32 temperature;        /* degrees Kelvin */
 810         s32 last_temperature;
 811
 812         /* init calibration results */
 813         struct iwl_calib_result calib_results[IWL_CALIB_MAX];
 814
 815         /* Scan related variables */
 816         unsigned long last_scan_jiffies;
 817         unsigned long next_scan_jiffies;
 818         unsigned long scan_start;
 819         unsigned long scan_pass_start;
 820         unsigned long scan_start_tsf;
 821         int scan_bands;
 822         int one_direct_scan;
 823         u8 direct_ssid_len;
 824         u8 direct_ssid[IW_ESSID_MAX_SIZE];
 825         struct iwl_scan_cmd *scan;
 826         u32 scan_tx_ant[IEEE80211_NUM_BANDS];
 827
 828         /* spinlock */
 829         spinlock_t lock;        /* protect general shared data */
 830         spinlock_t hcmd_lock;   /* protect hcmd */
 831         struct mutex mutex;
 832
 833         /* basic pci-network driver stuff */
 834         struct pci_dev *pci_dev;
 835
 836         /* pci hardware address support */
 837         void __iomem *hw_base;
 838         u32  hw_rev;
 839         u32  hw_wa_rev;
 840         u8   rev_id;
 841
 842         /* uCode images, save to reload in case of failure */
 843         struct fw_desc ucode_code;      /* runtime inst */
 844         struct fw_desc ucode_data;      /* runtime data original */
 845         struct fw_desc ucode_data_backup;       /* runtime data save/restore */
 846         struct fw_desc ucode_init;      /* initialization inst */
 847         struct fw_desc ucode_init_data; /* initialization data */
 848         struct fw_desc ucode_boot;      /* bootstrap inst */
 849         enum ucode_type ucode_type;
 850         u8 ucode_write_complete;        /* the image write is complete */
 851
 852
 853         struct iwl_rxon_time_cmd rxon_timing;
 854
 855         /* We declare this const so it can only be
 856          * changed via explicit cast within the
 857          * routines that actually update the physical
 858          * hardware */
 859         const struct iwl_rxon_cmd active_rxon;
 860         struct iwl_rxon_cmd staging_rxon;
 861
 862         int error_recovering;
 863         struct iwl_rxon_cmd recovery_rxon;
 864
 865         /* 1st responses from initialize and runtime uCode images.
 866          * 4965's initialize alive response contains some calibration data. */
 867         struct iwl_init_alive_resp card_alive_init;
 868         struct iwl_alive_resp card_alive;
 869 #ifdef CONFIG_IWLWIFI_RFKILL
 870         struct rfkill *rfkill;
 871 #endif
 872
 873 #ifdef CONFIG_IWLWIFI_LEDS
 874         struct iwl_led led[IWL_LED_TRG_MAX];
 875         unsigned long last_blink_time;
 876         u8 last_blink_rate;
 877         u8 allow_blinking;
 878         u64 led_tpt;
 879 #endif
 880
 881         u16 active_rate;
 882         u16 active_rate_basic;
 883
 884         u8 assoc_station_added;
 885         u8 use_ant_b_for_management_frame;      /* Tx antenna selection */
 886         u8 start_calib;
 887         struct iwl_sensitivity_data sensitivity_data;
 888         struct iwl_chain_noise_data chain_noise_data;
 889         __le16 sensitivity_tbl[HD_TABLE_SIZE];
 890
 891         struct iwl_ht_info current_ht_config;
 892         u8 last_phy_res[100];
 893
 894         /* Rate scaling data */
 895         s8 data_retry_limit;
 896         u8 retry_rate;
 897
 898         wait_queue_head_t wait_command_queue;
 899
 900         int activity_timer_active;
 901
 902         /* Rx and Tx DMA processing queues */
 903         struct iwl_rx_queue rxq;
 904         struct iwl_tx_queue txq[IWL_MAX_NUM_QUEUES];
 905         unsigned long txq_ctx_active_msk;
 906         struct iwl_kw kw;       /* keep warm address */
 907         u32 scd_base_addr;      /* scheduler sram base address */
 908
 909         unsigned long status;
 910
 911         int last_rx_rssi;       /* From Rx packet statisitics */
 912         int last_rx_noise;      /* From beacon statistics */
 913
 914         /* counts mgmt, ctl, and data packets */
 915         struct traffic_stats {
 916                 u32 cnt;
 917                 u64 bytes;
 918         } tx_stats[3], rx_stats[3];
 919
 920         struct iwl_power_mgr power_data;
 921
 922         struct iwl_notif_statistics statistics;
 923         unsigned long last_statistics_time;
 924
 925         /* context information */
 926         u8 essid[IW_ESSID_MAX_SIZE];
 927         u8 essid_len;
 928         u16 rates_mask;
 929
 930         u32 power_mode;
 931         u32 antenna;
 932         u8 bssid[ETH_ALEN];
 933         u16 rts_threshold;
 934         u8 mac_addr[ETH_ALEN];
 935
 936         /*station table variables */
 937         spinlock_t sta_lock;
 938         int num_stations;
 939         struct iwl_station_entry stations[IWL_STATION_COUNT];
 940         struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
 941         u8 default_wep_key;
 942         u8 key_mapping_key;
 943         unsigned long ucode_key_table;
 944
 945         /* Indication if ieee80211_ops->open has been called */
 946         u8 is_open;
 947
 948         u8 mac80211_registered;
 949
 950         /* Rx'd packet timing information */
 951         u32 last_beacon_time;
 952         u64 last_tsf;
 953
 954         /* eeprom */
 955         u8 *eeprom;
 956         struct iwl_eeprom_calib_info *calib_info;
 957
 958         enum nl80211_iftype iw_mode;
 959
 960         struct sk_buff *ibss_beacon;
 961
 962         /* Last Rx'd beacon timestamp */
 963         u64 timestamp;
 964         u16 beacon_int;
 965         struct ieee80211_vif *vif;
 966
 967         struct iwl_hw_params hw_params;
 968         /* driver/uCode shared Tx Byte Counts and Rx status */
 969         void *shared_virt;
 970         int rb_closed_offset;
 971         /* Physical Pointer to Tx Byte Counts and Rx status */
 972         dma_addr_t shared_phys;
 973
 974         /* Current association information needed to configure the
 975          * hardware */
 976         u16 assoc_id;
 977         u16 assoc_capability;
 978
 979         struct iwl_qos_info qos_data;
 980
 981         struct workqueue_struct *workqueue;
 982
 983         struct work_struct up;
 984         struct work_struct restart;
 985         struct work_struct calibrated_work;
 986         struct work_struct scan_completed;
 987         struct work_struct rx_replenish;
 988         struct work_struct rf_kill;
 989         struct work_struct abort_scan;
 990         struct work_struct update_link_led;
 991         struct work_struct auth_work;
 992         struct work_struct report_work;
 993         struct work_struct request_scan;
 994         struct work_struct beacon_update;
 995         struct work_struct set_monitor;
 996
 997         struct tasklet_struct irq_tasklet;
 998
 999         struct delayed_work set_power_save;
1000         struct delayed_work init_alive_start;
1001         struct delayed_work alive_start;
1002         struct delayed_work scan_check;
1003         /* TX Power */
1004         s8 tx_power_user_lmt;
1005         s8 tx_power_channel_lmt;
1006
1007 #ifdef CONFIG_PM
1008         u32 pm_state[16];
1009 #endif
1010
1011 #ifdef CONFIG_IWLWIFI_DEBUG
1012         /* debugging info */
1013         u32 debug_level;
1014         u32 framecnt_to_us;
1015         atomic_t restrict_refcnt;
1016 #ifdef CONFIG_IWLWIFI_DEBUGFS
1017         /* debugfs */
1018         struct iwl_debugfs *dbgfs;
1019 #endif /* CONFIG_IWLWIFI_DEBUGFS */
1020 #endif /* CONFIG_IWLWIFI_DEBUG */
1021
1022         struct work_struct txpower_work;
1023         u32 disable_sens_cal;
1024         u32 disable_chain_noise_cal;
1025         u32 disable_tx_power_cal;
1026         struct work_struct run_time_calib_work;
1027         struct timer_list statistics_periodic;
1028 }; /*iwl_priv */
1029
1030 static inline void iwl_txq_ctx_activate(struct iwl_priv *priv, int txq_id)
1031 {
1032         set_bit(txq_id, &priv->txq_ctx_active_msk);
1033 }
1034
1035 static inline void iwl_txq_ctx_deactivate(struct iwl_priv *priv, int txq_id)
1036 {
1037         clear_bit(txq_id, &priv->txq_ctx_active_msk);
1038 }
1039
1040 #ifdef CONFIG_IWLWIFI_DEBUG
1041 const char *iwl_get_tx_fail_reason(u32 status);
1042 #else
1043 static inline const char *iwl_get_tx_fail_reason(u32 status) { return ""; }
1044 #endif
1045
1046
1047 static inline struct ieee80211_hdr *iwl_tx_queue_get_hdr(struct iwl_priv *priv,
1048                                                          int txq_id, int idx)
1049 {
1050         if (priv->txq[txq_id].txb[idx].skb[0])
1051                 return (struct ieee80211_hdr *)priv->txq[txq_id].
1052                                 txb[idx].skb[0]->data;
1053         return NULL;
1054 }
1055
1056
1057 static inline int iwl_is_associated(struct iwl_priv *priv)
1058 {
1059         return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1060 }
1061
1062 static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1063 {
1064         if (ch_info == NULL)
1065                 return 0;
1066         return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1067 }
1068
1069 static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1070 {
1071         return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1072 }
1073
1074 static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1075 {
1076         return ch_info->band == IEEE80211_BAND_5GHZ;
1077 }
1078
1079 static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1080 {
1081         return ch_info->band == IEEE80211_BAND_2GHZ;
1082 }
1083
1084 static inline int is_channel_passive(const struct iwl_channel_info *ch)
1085 {
1086         return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1087 }
1088
1089 static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1090 {
1091         return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1092 }
1093
1094 #ifdef CONFIG_IWLWIFI_DEBUG
1095 static inline void iwl_print_hex_dump(struct iwl_priv *priv, int level,
1096                                       void *p, u32 len)
1097 {
1098         if (!(priv->debug_level & level))
1099                 return;
1100
1101         print_hex_dump(KERN_DEBUG, "iwl data: ", DUMP_PREFIX_OFFSET, 16, 1,
1102                         p, len, 1);
1103 }
1104 #else
1105 static inline void iwl_print_hex_dump(struct iwl_priv *priv, int level,
1106                                       void *p, u32 len)
1107 {
1108 }
1109 #endif
1110
1111 extern const struct iwl_channel_info *iwl_get_channel_info(
1112         const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
1113
1114 /* Requires full declaration of iwl_priv before including */
1115
1116 #endif                          /* __iwl_dev_h__ */