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  * struct iwl_cfg
 272  * @name: Offical name of the device
 273  * @fw_name_pre: Firmware filename prefix. The api version and extension
 274  *      (.ucode) will be added to filename before loading from disk. The
 275  *      filename is constructed as fw_name_pre<api>.ucode.
 276  * @ucode_api_max: Highest version of uCode API supported by driver.
 277  * @ucode_api_ok: oldest version of the uCode API that is OK to load
 278  *      without a warning, for use in transitions
 279  * @ucode_api_min: Lowest version of uCode API supported by driver.
 280  * @max_inst_size: The maximal length of the fw inst section
 281  * @max_data_size: The maximal length of the fw data section
 282  * @valid_tx_ant: valid transmit antenna
 283  * @valid_rx_ant: valid receive antenna
 284  * @eeprom_ver: EEPROM version
 285  * @eeprom_calib_ver: EEPROM calibration version
 286  * @lib: pointer to the lib ops
 287  * @additional_nic_config: additional nic configuration
 288  * @base_params: pointer to basic parameters
 289  * @ht_params: point to ht patameters
 290  * @bt_params: pointer to bt parameters
 291  * @pa_type: used by 6000 series only to identify the type of Power Amplifier
 292  * @need_temp_offset_calib: need to perform temperature offset calibration
 293  * @no_xtal_calib: some devices do not need crystal calibration data,
 294  *      don't send it to those
 295  * @scan_rx_antennas: available antenna for scan operation
 296  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
 297  * @adv_pm: advance power management
 298  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
 299  * @internal_wimax_coex: internal wifi/wimax combo device
 300  * @iq_invert: I/Q inversion
 301  * @temp_offset_v2: support v2 of temperature offset calibration
 302  *
 303  * We enable the driver to be backward compatible wrt API version. The
 304  * driver specifies which APIs it supports (with @ucode_api_max being the
 305  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
 306  * it has a supported API version.
 307  *
 308  * The ideal usage of this infrastructure is to treat a new ucode API
 309  * release as a new hardware revision.
 310  */
 311 struct iwl_cfg {
 312         /* params specific to an individual device within a device family */
 313         const char *name;
 314         const char *fw_name_pre;
 315         const unsigned int ucode_api_max;
 316         const unsigned int ucode_api_ok;
 317         const unsigned int ucode_api_min;
 318         const u32 max_data_size;
 319         const u32 max_inst_size;
 320         u8   valid_tx_ant;
 321         u8   valid_rx_ant;
 322         u16  eeprom_ver;
 323         u16  eeprom_calib_ver;
 324         const struct iwl_lib_ops *lib;
 325         void (*additional_nic_config)(struct iwl_priv *priv);
 326         /* params not likely to change within a device family */
 327         struct iwl_base_params *base_params;
 328         /* params likely to change within a device family */
 329         struct iwl_ht_params *ht_params;
 330         struct iwl_bt_params *bt_params;
 331         enum iwl_pa_type pa_type;         /* if used set to IWL_PA_SYSTEM */
 332         const bool need_temp_offset_calib; /* if used set to true */
 333         const bool no_xtal_calib;
 334         u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
 335         enum iwl_led_mode led_mode;
 336         const bool adv_pm;
 337         const bool rx_with_siso_diversity;
 338         const bool internal_wimax_coex;
 339         const bool iq_invert;
 340         const bool temp_offset_v2;
 341 };
 342
 343 /**
 344  * struct iwl_shared - shared fields for all the layers of the driver
 345  *
 346  * @ucode_owner: IWL_OWNERSHIP_*
 347  * @cmd_queue: command queue number
 348  * @status: STATUS_*
 349  * @wowlan: are we running wowlan uCode
 350  * @valid_contexts: microcode/device supports multiple contexts
 351  * @bus: pointer to the bus layer data
 352  * @cfg: see struct iwl_cfg
 353  * @priv: pointer to the upper layer data
 354  * @trans: pointer to the transport layer data
 355  * @nic: pointer to the nic data
 356  * @hw_params: see struct iwl_hw_params
 357  * @lock: protect general shared data
 358  * @mutex:
 359  * @wait_command_queue: the wait_queue for SYNC host command nad uCode load
 360  * @eeprom: pointer to the eeprom/OTP image
 361  * @ucode_type: indicator of loaded ucode image
 362  * @notif_waits: things waiting for notification
 363  * @notif_wait_lock: lock protecting notification
 364  * @notif_waitq: head of notification wait queue
 365  * @device_pointers: pointers to ucode event tables
 366  */
 367 struct iwl_shared {
 368 #define IWL_OWNERSHIP_DRIVER    0
 369 #define IWL_OWNERSHIP_TM        1
 370         u8 ucode_owner;
 371         u8 cmd_queue;
 372         unsigned long status;
 373         u8 valid_contexts;
 374
 375         const struct iwl_cfg *cfg;
 376         struct iwl_priv *priv;
 377         struct iwl_trans *trans;
 378         struct iwl_nic *nic;
 379         struct iwl_hw_params hw_params;
 380
 381         struct mutex mutex;
 382
 383         wait_queue_head_t wait_command_queue;
 384
 385         /* eeprom -- this is in the card's little endian byte order */
 386         u8 *eeprom;
 387
 388         /* ucode related variables */
 389         enum iwl_ucode_type ucode_type;
 390
 391         /* notification wait support */
 392         struct list_head notif_waits;
 393         spinlock_t notif_wait_lock;
 394         wait_queue_head_t notif_waitq;
 395
 396         struct {
 397                 u32 error_event_table;
 398                 u32 log_event_table;
 399         } device_pointers;
 400
 401 };
 402
 403 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
 404 #define priv(_m)        ((_m)->shrd->priv)
 405 #define cfg(_m)         ((_m)->shrd->cfg)
 406 #define nic(_m)         ((_m)->shrd->nic)
 407 #define trans(_m)       ((_m)->shrd->trans)
 408 #define hw_params(_m)   ((_m)->shrd->hw_params)
 409
 410 static inline bool iwl_have_debug_level(u32 level)
 411 {
 412         return iwlagn_mod_params.debug_level & level;
 413 }
 414
 415 /*
 416  * mac80211 queues, ACs, hardware queues, FIFOs.
 417  *
 418  * Cf. http://wireless.kernel.org/en/developers/Documentation/mac80211/queues
 419  *
 420  * Mac80211 uses the following numbers, which we get as from it
 421  * by way of skb_get_queue_mapping(skb):
 422  *
 423  *      VO      0
 424  *      VI      1
 425  *      BE      2
 426  *      BK      3
 427  *
 428  *
 429  * Regular (not A-MPDU) frames are put into hardware queues corresponding
 430  * to the FIFOs, see comments in iwl-prph.h. Aggregated frames get their
 431  * own queue per aggregation session (RA/TID combination), such queues are
 432  * set up to map into FIFOs too, for which we need an AC->FIFO mapping. In
 433  * order to map frames to the right queue, we also need an AC->hw queue
 434  * mapping. This is implemented here.
 435  *
 436  * Due to the way hw queues are set up (by the hw specific modules like
 437  * iwl-4965.c, iwl-5000.c etc.), the AC->hw queue mapping is the identity
 438  * mapping.
 439  */
 440
 441 static const u8 tid_to_ac[] = {
 442         IEEE80211_AC_BE,
 443         IEEE80211_AC_BK,
 444         IEEE80211_AC_BK,
 445         IEEE80211_AC_BE,
 446         IEEE80211_AC_VI,
 447         IEEE80211_AC_VI,
 448         IEEE80211_AC_VO,
 449         IEEE80211_AC_VO
 450 };
 451
 452 static inline int get_ac_from_tid(u16 tid)
 453 {
 454         if (likely(tid < ARRAY_SIZE(tid_to_ac)))
 455                 return tid_to_ac[tid];
 456
 457         /* no support for TIDs 8-15 yet */
 458         return -EINVAL;
 459 }
 460
 461 enum iwl_rxon_context_id {
 462         IWL_RXON_CTX_BSS,
 463         IWL_RXON_CTX_PAN,
 464
 465         NUM_IWL_RXON_CTX
 466 };
 467
 468 int iwlagn_hw_valid_rtc_data_addr(u32 addr);
 469 void iwl_nic_config(struct iwl_priv *priv);
 470 const char *get_cmd_string(u8 cmd);
 471 bool iwl_check_for_ct_kill(struct iwl_priv *priv);
 472
 473
 474 /* notification wait support */
 475 void iwl_abort_notification_waits(struct iwl_shared *shrd);
 476 void __acquires(wait_entry)
 477 iwl_init_notification_wait(struct iwl_shared *shrd,
 478                               struct iwl_notification_wait *wait_entry,
 479                               u8 cmd,
 480                               void (*fn)(struct iwl_trans *trans,
 481                                          struct iwl_rx_packet *pkt,
 482                                          void *data),
 483                               void *fn_data);
 484 int __must_check __releases(wait_entry)
 485 iwl_wait_notification(struct iwl_shared *shrd,
 486                          struct iwl_notification_wait *wait_entry,
 487                          unsigned long timeout);
 488 void __releases(wait_entry)
 489 iwl_remove_notification(struct iwl_shared *shrd,
 490                            struct iwl_notification_wait *wait_entry);
 491
 492 #define IWL_CMD(x) case x: return #x
 493 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
 494
 495 #define IWL_TRAFFIC_ENTRIES     (256)
 496 #define IWL_TRAFFIC_ENTRY_SIZE  (64)
 497
 498 /*****************************************************
 499 * DRIVER STATUS FUNCTIONS
 500 ******************************************************/
 501 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
 502 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
 503 #define STATUS_INT_ENABLED      2
 504 #define STATUS_RF_KILL_HW       3
 505 #define STATUS_CT_KILL          4
 506 #define STATUS_INIT             5
 507 #define STATUS_ALIVE            6
 508 #define STATUS_READY            7
 509 #define STATUS_TEMPERATURE      8
 510 #define STATUS_GEO_CONFIGURED   9
 511 #define STATUS_EXIT_PENDING     10
 512 #define STATUS_STATISTICS       12
 513 #define STATUS_SCANNING         13
 514 #define STATUS_SCAN_ABORTING    14
 515 #define STATUS_SCAN_HW          15
 516 #define STATUS_POWER_PMI        16
 517 #define STATUS_FW_ERROR         17
 518 #define STATUS_DEVICE_ENABLED   18
 519 #define STATUS_CHANNEL_SWITCH_PENDING 19
 520 #define STATUS_SCAN_COMPLETE    20
 521
 522 static inline int iwl_is_ready(struct iwl_shared *shrd)
 523 {
 524         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
 525          * set but EXIT_PENDING is not */
 526         return test_bit(STATUS_READY, &shrd->status) &&
 527                test_bit(STATUS_GEO_CONFIGURED, &shrd->status) &&
 528                !test_bit(STATUS_EXIT_PENDING, &shrd->status);
 529 }
 530
 531 static inline int iwl_is_alive(struct iwl_shared *shrd)
 532 {
 533         return test_bit(STATUS_ALIVE, &shrd->status);
 534 }
 535
 536 static inline int iwl_is_init(struct iwl_shared *shrd)
 537 {
 538         return test_bit(STATUS_INIT, &shrd->status);
 539 }
 540
 541 static inline int iwl_is_rfkill_hw(struct iwl_shared *shrd)
 542 {
 543         return test_bit(STATUS_RF_KILL_HW, &shrd->status);
 544 }
 545
 546 static inline int iwl_is_rfkill(struct iwl_shared *shrd)
 547 {
 548         return iwl_is_rfkill_hw(shrd);
 549 }
 550
 551 static inline int iwl_is_ctkill(struct iwl_shared *shrd)
 552 {
 553         return test_bit(STATUS_CT_KILL, &shrd->status);
 554 }
 555
 556 static inline int iwl_is_ready_rf(struct iwl_shared *shrd)
 557 {
 558         if (iwl_is_rfkill(shrd))
 559                 return 0;
 560
 561         return iwl_is_ready(shrd);
 562 }
 563
 564 #endif /* #__iwl_shared_h__ */