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

   1 /******************************************************************************
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called LICENSE.GPL.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63 #ifndef __iwl_shared_h__
  64 #define __iwl_shared_h__
  65
  66 #include <linux/types.h>
  67 #include <linux/spinlock.h>
  68 #include <linux/mutex.h>
  69 #include <linux/gfp.h>
  70 #include <net/mac80211.h>
  71
  72 #include "iwl-commands.h"
  73
  74 /**
  75  * DOC: shared area - role and goal
  76  *
  77  * The shared area contains all the data exported by the upper layer to the
  78  * other layers. Since the bus and transport layer shouldn't dereference
  79  * iwl_priv, all the data needed by the upper layer and the transport / bus
  80  * layer must be here.
  81  * The shared area also holds pointer to all the other layers. This allows a
  82  * layer to call a function from another layer.
  83  *
  84  * NOTE: All the layers hold a pointer to the shared area which must be shrd.
  85  *      A few macros assume that (_m)->shrd points to the shared area no matter
  86  *      what _m is.
  87  *
  88  * gets notifications about enumeration, suspend, resume.
  89  * For the moment, the bus layer is not a linux kernel module as itself, and
  90  * the module_init function of the driver must call the bus specific
  91  * registration functions. These functions are listed at the end of this file.
  92  * For the moment, there is only one implementation of this interface: PCI-e.
  93  * This implementation is iwl-pci.c
  94  */
  95
  96 struct iwl_priv;
  97 struct iwl_trans;
  98 struct iwl_sensitivity_ranges;
  99 struct iwl_trans_ops;
 100
 101 #define DRV_NAME        "iwlwifi"
 102 #define IWLWIFI_VERSION "in-tree:"
 103 #define DRV_COPYRIGHT   "Copyright(c) 2003-2012 Intel Corporation"
 104 #define DRV_AUTHOR     "<ilw@linux.intel.com>"
 105
 106 extern struct iwl_mod_params iwlagn_mod_params;
 107
 108 #define IWL_DISABLE_HT_ALL      BIT(0)
 109 #define IWL_DISABLE_HT_TXAGG    BIT(1)
 110 #define IWL_DISABLE_HT_RXAGG    BIT(2)
 111
 112 /**
 113  * struct iwl_mod_params
 114  *
 115  * Holds the module parameters
 116  *
 117  * @sw_crypto: using hardware encryption, default = 0
 118  * @num_of_queues: number of tx queue, HW dependent
 119  * @disable_11n: disable 11n capabilities, default = 0,
 120  *      use IWL_DISABLE_HT_* constants
 121  * @amsdu_size_8K: enable 8K amsdu size, default = 1
 122  * @antenna: both antennas (use diversity), default = 0
 123  * @restart_fw: restart firmware, default = 1
 124  * @plcp_check: enable plcp health check, default = true
 125  * @ack_check: disable ack health check, default = false
 126  * @wd_disable: enable stuck queue check, default = 0
 127  * @bt_coex_active: enable bt coex, default = true
 128  * @led_mode: system default, default = 0
 129  * @no_sleep_autoadjust: disable autoadjust, default = true
 130  * @power_save: disable power save, default = false
 131  * @power_level: power level, default = 1
 132  * @debug_level: levels are IWL_DL_*
 133  * @ant_coupling: antenna coupling in dB, default = 0
 134  * @bt_ch_announce: BT channel inhibition, default = enable
 135  * @wanted_ucode_alternative: ucode alternative to use, default = 1
 136  * @auto_agg: enable agg. without check, default = true
 137  */
 138 struct iwl_mod_params {
 139         int sw_crypto;
 140         int num_of_queues;
 141         unsigned int disable_11n;
 142         int amsdu_size_8K;
 143         int antenna;
 144         int restart_fw;
 145         bool plcp_check;
 146         bool ack_check;
 147         int  wd_disable;
 148         bool bt_coex_active;
 149         int led_mode;
 150         bool no_sleep_autoadjust;
 151         bool power_save;
 152         int power_level;
 153         u32 debug_level;
 154         int ant_coupling;
 155         bool bt_ch_announce;
 156         int wanted_ucode_alternative;
 157         bool auto_agg;
 158 };
 159
 160 /**
 161  * struct iwl_hw_params
 162  *
 163  * Holds the module parameters
 164  *
 165  * @max_txq_num: Max # Tx queues supported
 166  * @num_ampdu_queues: num of ampdu queues
 167  * @tx_chains_num: Number of TX chains
 168  * @rx_chains_num: Number of RX chains
 169  * @valid_tx_ant: usable antennas for TX
 170  * @valid_rx_ant: usable antennas for RX
 171  * @ht40_channel: is 40MHz width possible: BIT(IEEE80211_BAND_XXX)
 172  * @sku: sku read from EEPROM
 173  * @rx_page_order: Rx buffer page order
 174  * @ct_kill_threshold: temperature threshold - in hw dependent unit
 175  * @ct_kill_exit_threshold: when to reeable the device - in hw dependent unit
 176  *      relevant for 1000, 6000 and up
 177  * @wd_timeout: TX queues watchdog timeout
 178  * @struct iwl_sensitivity_ranges: range of sensitivity values
 179  */
 180 struct iwl_hw_params {
 181         u8  max_txq_num;
 182         u8  num_ampdu_queues;
 183         u8  tx_chains_num;
 184         u8  rx_chains_num;
 185         u8  valid_tx_ant;
 186         u8  valid_rx_ant;
 187         u8  ht40_channel;
 188         bool shadow_reg_enable;
 189         u16 sku;
 190         u32 rx_page_order;
 191         u32 ct_kill_threshold;
 192         u32 ct_kill_exit_threshold;
 193         unsigned int wd_timeout;
 194
 195         const struct iwl_sensitivity_ranges *sens;
 196 };
 197
 198 /**
 199  * enum iwl_ucode_type
 200  *
 201  * The type of ucode currently loaded on the hardware.
 202  *
 203  * @IWL_UCODE_NONE: No ucode loaded
 204  * @IWL_UCODE_REGULAR: Normal runtime ucode
 205  * @IWL_UCODE_INIT: Initial ucode
 206  * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
 207  */
 208 enum iwl_ucode_type {
 209         IWL_UCODE_NONE,
 210         IWL_UCODE_REGULAR,
 211         IWL_UCODE_INIT,
 212         IWL_UCODE_WOWLAN,
 213 };
 214
 215 /**
 216  * struct iwl_notification_wait - notification wait entry
 217  * @list: list head for global list
 218  * @fn: function called with the notification
 219  * @cmd: command ID
 220  *
 221  * This structure is not used directly, to wait for a
 222  * notification declare it on the stack, and call
 223  * iwlagn_init_notification_wait() with appropriate
 224  * parameters. Then do whatever will cause the ucode
 225  * to notify the driver, and to wait for that then
 226  * call iwlagn_wait_notification().
 227  *
 228  * Each notification is one-shot. If at some point we
 229  * need to support multi-shot notifications (which
 230  * can't be allocated on the stack) we need to modify
 231  * the code for them.
 232  */
 233 struct iwl_notification_wait {
 234         struct list_head list;
 235
 236         void (*fn)(struct iwl_trans *trans, struct iwl_rx_packet *pkt,
 237                    void *data);
 238         void *fn_data;
 239
 240         u8 cmd;
 241         bool triggered, aborted;
 242 };
 243
 244 /**
 245  * enum iwl_pa_type - Power Amplifier type
 246  * @IWL_PA_SYSTEM:  based on uCode configuration
 247  * @IWL_PA_INTERNAL: use Internal only
 248  */
 249 enum iwl_pa_type {
 250         IWL_PA_SYSTEM = 0,
 251         IWL_PA_INTERNAL = 1,
 252 };
 253
 254 /*
 255  * LED mode
 256  *    IWL_LED_DEFAULT:  use device default
 257  *    IWL_LED_RF_STATE: turn LED on/off based on RF state
 258  *                      LED ON  = RF ON
 259  *                      LED OFF = RF OFF
 260  *    IWL_LED_BLINK:    adjust led blink rate based on blink table
 261  *    IWL_LED_DISABLE:  led disabled
 262  */
 263 enum iwl_led_mode {
 264         IWL_LED_DEFAULT,
 265         IWL_LED_RF_STATE,
 266         IWL_LED_BLINK,
 267         IWL_LED_DISABLE,
 268 };
 269
 270 /*
 271  * @max_ll_items: max number of OTP blocks
 272  * @shadow_ram_support: shadow support for OTP memory
 273  * @led_compensation: compensate on the led on/off time per HW according
 274  *      to the deviation to achieve the desired led frequency.
 275  *      The detail algorithm is described in iwl-led.c
 276  * @chain_noise_num_beacons: number of beacons used to compute chain noise
 277  * @adv_thermal_throttle: support advance thermal throttle
 278  * @support_ct_kill_exit: support ct kill exit condition
 279  * @support_wimax_coexist: support wimax/wifi co-exist
 280  * @plcp_delta_threshold: plcp error rate threshold used to trigger
 281  *      radio tuning when there is a high receiving plcp error rate
 282  * @chain_noise_scale: default chain noise scale used for gain computation
 283  * @wd_timeout: TX queues watchdog timeout
 284  * @max_event_log_size: size of event log buffer size for ucode event logging
 285  * @shadow_reg_enable: HW shadhow register bit
 286  * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
 287  * @no_idle_support: do not support idle mode
 288  * wd_disable: disable watchdog timer
 289  */
 290 struct iwl_base_params {
 291         int eeprom_size;
 292         int num_of_queues;      /* def: HW dependent */
 293         int num_of_ampdu_queues;/* def: HW dependent */
 294         /* for iwl_apm_init() */
 295         u32 pll_cfg_val;
 296
 297         const u16 max_ll_items;
 298         const bool shadow_ram_support;
 299         u16 led_compensation;
 300         bool adv_thermal_throttle;
 301         bool support_ct_kill_exit;
 302         const bool support_wimax_coexist;
 303         u8 plcp_delta_threshold;
 304         s32 chain_noise_scale;
 305         unsigned int wd_timeout;
 306         u32 max_event_log_size;
 307         const bool shadow_reg_enable;
 308         const bool hd_v2;
 309         const bool no_idle_support;
 310         const bool wd_disable;
 311 };
 312
 313 /**
 314  * struct iwl_cfg
 315  * @name: Offical name of the device
 316  * @fw_name_pre: Firmware filename prefix. The api version and extension
 317  *      (.ucode) will be added to filename before loading from disk. The
 318  *      filename is constructed as fw_name_pre<api>.ucode.
 319  * @ucode_api_max: Highest version of uCode API supported by driver.
 320  * @ucode_api_ok: oldest version of the uCode API that is OK to load
 321  *      without a warning, for use in transitions
 322  * @ucode_api_min: Lowest version of uCode API supported by driver.
 323  * @max_inst_size: The maximal length of the fw inst section
 324  * @max_data_size: The maximal length of the fw data section
 325  * @valid_tx_ant: valid transmit antenna
 326  * @valid_rx_ant: valid receive antenna
 327  * @eeprom_ver: EEPROM version
 328  * @eeprom_calib_ver: EEPROM calibration version
 329  * @lib: pointer to the lib ops
 330  * @additional_nic_config: additional nic configuration
 331  * @base_params: pointer to basic parameters
 332  * @ht_params: point to ht patameters
 333  * @bt_params: pointer to bt parameters
 334  * @pa_type: used by 6000 series only to identify the type of Power Amplifier
 335  * @need_temp_offset_calib: need to perform temperature offset calibration
 336  * @no_xtal_calib: some devices do not need crystal calibration data,
 337  *      don't send it to those
 338  * @scan_rx_antennas: available antenna for scan operation
 339  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
 340  * @adv_pm: advance power management
 341  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
 342  * @internal_wimax_coex: internal wifi/wimax combo device
 343  * @iq_invert: I/Q inversion
 344  * @temp_offset_v2: support v2 of temperature offset calibration
 345  *
 346  * We enable the driver to be backward compatible wrt API version. The
 347  * driver specifies which APIs it supports (with @ucode_api_max being the
 348  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
 349  * it has a supported API version.
 350  *
 351  * The ideal usage of this infrastructure is to treat a new ucode API
 352  * release as a new hardware revision.
 353  */
 354 struct iwl_cfg {
 355         /* params specific to an individual device within a device family */
 356         const char *name;
 357         const char *fw_name_pre;
 358         const unsigned int ucode_api_max;
 359         const unsigned int ucode_api_ok;
 360         const unsigned int ucode_api_min;
 361         const u32 max_data_size;
 362         const u32 max_inst_size;
 363         u8   valid_tx_ant;
 364         u8   valid_rx_ant;
 365         u16  eeprom_ver;
 366         u16  eeprom_calib_ver;
 367         const struct iwl_lib_ops *lib;
 368         void (*additional_nic_config)(struct iwl_priv *priv);
 369         /* params not likely to change within a device family */
 370         struct iwl_base_params *base_params;
 371         /* params likely to change within a device family */
 372         struct iwl_ht_params *ht_params;
 373         struct iwl_bt_params *bt_params;
 374         enum iwl_pa_type pa_type;         /* if used set to IWL_PA_SYSTEM */
 375         const bool need_temp_offset_calib; /* if used set to true */
 376         const bool no_xtal_calib;
 377         u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
 378         enum iwl_led_mode led_mode;
 379         const bool adv_pm;
 380         const bool rx_with_siso_diversity;
 381         const bool internal_wimax_coex;
 382         const bool iq_invert;
 383         const bool temp_offset_v2;
 384 };
 385
 386 /**
 387  * struct iwl_shared - shared fields for all the layers of the driver
 388  *
 389  * @ucode_owner: IWL_OWNERSHIP_*
 390  * @cmd_queue: command queue number
 391  * @status: STATUS_*
 392  * @wowlan: are we running wowlan uCode
 393  * @valid_contexts: microcode/device supports multiple contexts
 394  * @bus: pointer to the bus layer data
 395  * @cfg: see struct iwl_cfg
 396  * @priv: pointer to the upper layer data
 397  * @trans: pointer to the transport layer data
 398  * @nic: pointer to the nic data
 399  * @hw_params: see struct iwl_hw_params
 400  * @lock: protect general shared data
 401  * @mutex:
 402  * @wait_command_queue: the wait_queue for SYNC host command nad uCode load
 403  * @eeprom: pointer to the eeprom/OTP image
 404  * @ucode_type: indicator of loaded ucode image
 405  * @notif_waits: things waiting for notification
 406  * @notif_wait_lock: lock protecting notification
 407  * @notif_waitq: head of notification wait queue
 408  * @device_pointers: pointers to ucode event tables
 409  */
 410 struct iwl_shared {
 411 #define IWL_OWNERSHIP_DRIVER    0
 412 #define IWL_OWNERSHIP_TM        1
 413         u8 ucode_owner;
 414         u8 cmd_queue;
 415         unsigned long status;
 416         u8 valid_contexts;
 417
 418         const struct iwl_cfg *cfg;
 419         struct iwl_priv *priv;
 420         struct iwl_trans *trans;
 421         struct iwl_nic *nic;
 422         struct iwl_hw_params hw_params;
 423
 424         struct mutex mutex;
 425
 426         wait_queue_head_t wait_command_queue;
 427
 428         /* eeprom -- this is in the card's little endian byte order */
 429         u8 *eeprom;
 430
 431         /* ucode related variables */
 432         enum iwl_ucode_type ucode_type;
 433
 434         /* notification wait support */
 435         struct list_head notif_waits;
 436         spinlock_t notif_wait_lock;
 437         wait_queue_head_t notif_waitq;
 438
 439         struct {
 440                 u32 error_event_table;
 441                 u32 log_event_table;
 442         } device_pointers;
 443
 444 };
 445
 446 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
 447 #define priv(_m)        ((_m)->shrd->priv)
 448 #define cfg(_m)         ((_m)->shrd->cfg)
 449 #define nic(_m)         ((_m)->shrd->nic)
 450 #define trans(_m)       ((_m)->shrd->trans)
 451 #define hw_params(_m)   ((_m)->shrd->hw_params)
 452
 453 static inline bool iwl_have_debug_level(u32 level)
 454 {
 455         return iwlagn_mod_params.debug_level & level;
 456 }
 457
 458 enum iwl_rxon_context_id {
 459         IWL_RXON_CTX_BSS,
 460         IWL_RXON_CTX_PAN,
 461
 462         NUM_IWL_RXON_CTX
 463 };
 464
 465 int iwlagn_hw_valid_rtc_data_addr(u32 addr);
 466 void iwl_nic_config(struct iwl_priv *priv);
 467 const char *get_cmd_string(u8 cmd);
 468 bool iwl_check_for_ct_kill(struct iwl_priv *priv);
 469
 470
 471 /* notification wait support */
 472 void iwl_abort_notification_waits(struct iwl_shared *shrd);
 473 void __acquires(wait_entry)
 474 iwl_init_notification_wait(struct iwl_shared *shrd,
 475                               struct iwl_notification_wait *wait_entry,
 476                               u8 cmd,
 477                               void (*fn)(struct iwl_trans *trans,
 478                                          struct iwl_rx_packet *pkt,
 479                                          void *data),
 480                               void *fn_data);
 481 int __must_check __releases(wait_entry)
 482 iwl_wait_notification(struct iwl_shared *shrd,
 483                          struct iwl_notification_wait *wait_entry,
 484                          unsigned long timeout);
 485 void __releases(wait_entry)
 486 iwl_remove_notification(struct iwl_shared *shrd,
 487                            struct iwl_notification_wait *wait_entry);
 488
 489 #define IWL_CMD(x) case x: return #x
 490
 491 /*****************************************************
 492 * DRIVER STATUS FUNCTIONS
 493 ******************************************************/
 494 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
 495 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
 496 #define STATUS_INT_ENABLED      2
 497 #define STATUS_RF_KILL_HW       3
 498 #define STATUS_CT_KILL          4
 499 #define STATUS_INIT             5
 500 #define STATUS_ALIVE            6
 501 #define STATUS_READY            7
 502 #define STATUS_TEMPERATURE      8
 503 #define STATUS_GEO_CONFIGURED   9
 504 #define STATUS_EXIT_PENDING     10
 505 #define STATUS_STATISTICS       12
 506 #define STATUS_SCANNING         13
 507 #define STATUS_SCAN_ABORTING    14
 508 #define STATUS_SCAN_HW          15
 509 #define STATUS_POWER_PMI        16
 510 #define STATUS_FW_ERROR         17
 511 #define STATUS_DEVICE_ENABLED   18
 512 #define STATUS_CHANNEL_SWITCH_PENDING 19
 513 #define STATUS_SCAN_COMPLETE    20
 514
 515 static inline int iwl_is_ready(struct iwl_shared *shrd)
 516 {
 517         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
 518          * set but EXIT_PENDING is not */
 519         return test_bit(STATUS_READY, &shrd->status) &&
 520                test_bit(STATUS_GEO_CONFIGURED, &shrd->status) &&
 521                !test_bit(STATUS_EXIT_PENDING, &shrd->status);
 522 }
 523
 524 static inline int iwl_is_alive(struct iwl_shared *shrd)
 525 {
 526         return test_bit(STATUS_ALIVE, &shrd->status);
 527 }
 528
 529 static inline int iwl_is_init(struct iwl_shared *shrd)
 530 {
 531         return test_bit(STATUS_INIT, &shrd->status);
 532 }
 533
 534 static inline int iwl_is_rfkill_hw(struct iwl_shared *shrd)
 535 {
 536         return test_bit(STATUS_RF_KILL_HW, &shrd->status);
 537 }
 538
 539 static inline int iwl_is_rfkill(struct iwl_shared *shrd)
 540 {
 541         return iwl_is_rfkill_hw(shrd);
 542 }
 543
 544 static inline int iwl_is_ctkill(struct iwl_shared *shrd)
 545 {
 546         return test_bit(STATUS_CT_KILL, &shrd->status);
 547 }
 548
 549 static inline int iwl_is_ready_rf(struct iwl_shared *shrd)
 550 {
 551         if (iwl_is_rfkill(shrd))
 552                 return 0;
 553
 554         return iwl_is_ready(shrd);
 555 }
 556
 557 #endif /* #__iwl_shared_h__ */