Emmanuel Grumbach | 48f20d3 | 2011-08-25 23:10:36 -0700 | [diff] [blame] | 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 - 2011 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 - 2011 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 | |
Emmanuel Grumbach | e6bb4c9 | 2011-08-25 23:10:48 -0700 | [diff] [blame] | 66 | /*This files includes all the types / functions that are exported by the |
| 67 | * upper layer to the bus and transport layer */ |
| 68 | |
Emmanuel Grumbach | 48f20d3 | 2011-08-25 23:10:36 -0700 | [diff] [blame] | 69 | struct iwl_cfg; |
Emmanuel Grumbach | cac988a | 2011-08-25 23:10:37 -0700 | [diff] [blame] | 70 | struct iwl_bus; |
Emmanuel Grumbach | 48f20d3 | 2011-08-25 23:10:36 -0700 | [diff] [blame] | 71 | struct iwl_priv; |
Emmanuel Grumbach | d618912 | 2011-08-25 23:10:39 -0700 | [diff] [blame] | 72 | struct iwl_sensitivity_ranges; |
Emmanuel Grumbach | e6bb4c9 | 2011-08-25 23:10:48 -0700 | [diff] [blame] | 73 | struct iwl_trans_ops; |
Emmanuel Grumbach | 48f20d3 | 2011-08-25 23:10:36 -0700 | [diff] [blame] | 74 | |
| 75 | extern struct iwl_mod_params iwlagn_mod_params; |
| 76 | |
| 77 | struct iwl_mod_params { |
| 78 | int sw_crypto; /* def: 0 = using hardware encryption */ |
| 79 | int num_of_queues; /* def: HW dependent */ |
| 80 | int disable_11n; /* def: 0 = 11n capabilities enabled */ |
| 81 | int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */ |
| 82 | int antenna; /* def: 0 = both antennas (use diversity) */ |
| 83 | int restart_fw; /* def: 1 = restart firmware */ |
| 84 | bool plcp_check; /* def: true = enable plcp health check */ |
| 85 | bool ack_check; /* def: false = disable ack health check */ |
| 86 | bool wd_disable; /* def: false = enable stuck queue check */ |
| 87 | bool bt_coex_active; /* def: true = enable bt coex */ |
| 88 | int led_mode; /* def: 0 = system default */ |
| 89 | bool no_sleep_autoadjust; /* def: true = disable autoadjust */ |
| 90 | bool power_save; /* def: false = disable power save */ |
| 91 | int power_level; /* def: 1 = power level */ |
| 92 | u32 debug_level; /* levels are IWL_DL_* */ |
| 93 | int ant_coupling; |
Wey-Yi Guy | fee84f0d | 2011-08-25 23:10:57 -0700 | [diff] [blame^] | 94 | bool bt_ch_announce; /* def: enable = BT channel inhibition */ |
Emmanuel Grumbach | 48f20d3 | 2011-08-25 23:10:36 -0700 | [diff] [blame] | 95 | int wanted_ucode_alternative; |
Wey-Yi Guy | dd5b6d0 | 2011-08-25 23:10:55 -0700 | [diff] [blame] | 96 | bool auto_agg; /* def: true = enable agg. without check */ |
Emmanuel Grumbach | 48f20d3 | 2011-08-25 23:10:36 -0700 | [diff] [blame] | 97 | }; |
| 98 | |
Emmanuel Grumbach | cac988a | 2011-08-25 23:10:37 -0700 | [diff] [blame] | 99 | /** |
Emmanuel Grumbach | d618912 | 2011-08-25 23:10:39 -0700 | [diff] [blame] | 100 | * struct iwl_hw_params |
| 101 | * @max_txq_num: Max # Tx queues supported |
| 102 | * @scd_bc_tbls_size: size of scheduler byte count tables |
| 103 | * @tfd_size: TFD size |
| 104 | * @tx/rx_chains_num: Number of TX/RX chains |
| 105 | * @valid_tx/rx_ant: usable antennas |
| 106 | * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2) |
| 107 | * @max_rxq_log: Log-base-2 of max_rxq_size |
| 108 | * @rx_page_order: Rx buffer page order |
| 109 | * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR |
| 110 | * @max_stations: |
| 111 | * @ht40_channel: is 40MHz width possible in band 2.4 |
| 112 | * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ) |
| 113 | * @sw_crypto: 0 for hw, 1 for sw |
| 114 | * @max_xxx_size: for ucode uses |
| 115 | * @ct_kill_threshold: temperature threshold |
| 116 | * @beacon_time_tsf_bits: number of valid tsf bits for beacon time |
| 117 | * @calib_init_cfg: setup initial calibrations for the hw |
| 118 | * @calib_rt_cfg: setup runtime calibrations for the hw |
| 119 | * @struct iwl_sensitivity_ranges: range of sensitivity values |
| 120 | */ |
| 121 | struct iwl_hw_params { |
| 122 | u8 max_txq_num; |
| 123 | u16 scd_bc_tbls_size; |
| 124 | u32 tfd_size; |
| 125 | u8 tx_chains_num; |
| 126 | u8 rx_chains_num; |
| 127 | u8 valid_tx_ant; |
| 128 | u8 valid_rx_ant; |
| 129 | u16 max_rxq_size; |
| 130 | u16 max_rxq_log; |
| 131 | u32 rx_page_order; |
| 132 | u8 max_stations; |
| 133 | u8 ht40_channel; |
| 134 | u8 max_beacon_itrvl; /* in 1024 ms */ |
| 135 | u32 max_inst_size; |
| 136 | u32 max_data_size; |
| 137 | u32 ct_kill_threshold; /* value in hw-dependent units */ |
| 138 | u32 ct_kill_exit_threshold; /* value in hw-dependent units */ |
| 139 | /* for 1000, 6000 series and up */ |
| 140 | u16 beacon_time_tsf_bits; |
| 141 | u32 calib_init_cfg; |
| 142 | u32 calib_rt_cfg; |
| 143 | const struct iwl_sensitivity_ranges *sens; |
| 144 | }; |
| 145 | |
| 146 | /** |
Emmanuel Grumbach | cac988a | 2011-08-25 23:10:37 -0700 | [diff] [blame] | 147 | * struct iwl_shared - shared fields for all the layers of the driver |
| 148 | * |
Emmanuel Grumbach | 8f470ce | 2011-08-25 23:10:38 -0700 | [diff] [blame] | 149 | * @dbg_level_dev: dbg level set per device. Prevails on |
| 150 | * iwlagn_mod_params.debug_level if set (!= 0) |
Emmanuel Grumbach | cefeaa5 | 2011-08-25 23:10:40 -0700 | [diff] [blame] | 151 | * @cmd_queue: command queue number |
Emmanuel Grumbach | 63013ae | 2011-08-25 23:10:42 -0700 | [diff] [blame] | 152 | * @status: STATUS_* |
Emmanuel Grumbach | cac988a | 2011-08-25 23:10:37 -0700 | [diff] [blame] | 153 | * @bus: pointer to the bus layer data |
| 154 | * @priv: pointer to the upper layer data |
Emmanuel Grumbach | d618912 | 2011-08-25 23:10:39 -0700 | [diff] [blame] | 155 | * @hw_params: see struct iwl_hw_params |
Emmanuel Grumbach | 74e28e4 | 2011-08-25 23:10:41 -0700 | [diff] [blame] | 156 | * @workqueue: the workqueue used by all the layers of the driver |
Emmanuel Grumbach | 10b15e6 | 2011-08-25 23:10:43 -0700 | [diff] [blame] | 157 | * @lock: protect general shared data |
Emmanuel Grumbach | f39c95e | 2011-08-25 23:10:47 -0700 | [diff] [blame] | 158 | * @sta_lock: protects the station table. |
| 159 | * If lock and sta_lock are needed, lock must be acquired first. |
Emmanuel Grumbach | 6ac2f83 | 2011-08-25 23:10:44 -0700 | [diff] [blame] | 160 | * @mutex: |
Emmanuel Grumbach | cac988a | 2011-08-25 23:10:37 -0700 | [diff] [blame] | 161 | */ |
| 162 | struct iwl_shared { |
Emmanuel Grumbach | 8f470ce | 2011-08-25 23:10:38 -0700 | [diff] [blame] | 163 | #ifdef CONFIG_IWLWIFI_DEBUG |
| 164 | u32 dbg_level_dev; |
| 165 | #endif /* CONFIG_IWLWIFI_DEBUG */ |
| 166 | |
Emmanuel Grumbach | cefeaa5 | 2011-08-25 23:10:40 -0700 | [diff] [blame] | 167 | u8 cmd_queue; |
Emmanuel Grumbach | 63013ae | 2011-08-25 23:10:42 -0700 | [diff] [blame] | 168 | unsigned long status; |
Emmanuel Grumbach | 57210f7 | 2011-08-25 23:10:52 -0700 | [diff] [blame] | 169 | bool wowlan; |
Emmanuel Grumbach | cefeaa5 | 2011-08-25 23:10:40 -0700 | [diff] [blame] | 170 | |
Emmanuel Grumbach | cac988a | 2011-08-25 23:10:37 -0700 | [diff] [blame] | 171 | struct iwl_bus *bus; |
| 172 | struct iwl_priv *priv; |
Emmanuel Grumbach | e6bb4c9 | 2011-08-25 23:10:48 -0700 | [diff] [blame] | 173 | struct iwl_trans *trans; |
Emmanuel Grumbach | d618912 | 2011-08-25 23:10:39 -0700 | [diff] [blame] | 174 | struct iwl_hw_params hw_params; |
Emmanuel Grumbach | 74e28e4 | 2011-08-25 23:10:41 -0700 | [diff] [blame] | 175 | |
| 176 | struct workqueue_struct *workqueue; |
Emmanuel Grumbach | 10b15e6 | 2011-08-25 23:10:43 -0700 | [diff] [blame] | 177 | spinlock_t lock; |
Emmanuel Grumbach | f39c95e | 2011-08-25 23:10:47 -0700 | [diff] [blame] | 178 | spinlock_t sta_lock; |
Emmanuel Grumbach | 6ac2f83 | 2011-08-25 23:10:44 -0700 | [diff] [blame] | 179 | struct mutex mutex; |
Emmanuel Grumbach | cac988a | 2011-08-25 23:10:37 -0700 | [diff] [blame] | 180 | }; |
| 181 | |
| 182 | /*Whatever _m is (iwl_trans, iwl_priv, iwl_bus, these macros will work */ |
| 183 | #define priv(_m) ((_m)->shrd->priv) |
| 184 | #define bus(_m) ((_m)->shrd->bus) |
Emmanuel Grumbach | e6bb4c9 | 2011-08-25 23:10:48 -0700 | [diff] [blame] | 185 | #define trans(_m) ((_m)->shrd->trans) |
Emmanuel Grumbach | d618912 | 2011-08-25 23:10:39 -0700 | [diff] [blame] | 186 | #define hw_params(_m) ((_m)->shrd->hw_params) |
Emmanuel Grumbach | cac988a | 2011-08-25 23:10:37 -0700 | [diff] [blame] | 187 | |
Emmanuel Grumbach | 8f470ce | 2011-08-25 23:10:38 -0700 | [diff] [blame] | 188 | #ifdef CONFIG_IWLWIFI_DEBUG |
| 189 | /* |
| 190 | * iwl_get_debug_level: Return active debug level for device |
| 191 | * |
| 192 | * Using sysfs it is possible to set per device debug level. This debug |
| 193 | * level will be used if set, otherwise the global debug level which can be |
| 194 | * set via module parameter is used. |
| 195 | */ |
| 196 | static inline u32 iwl_get_debug_level(struct iwl_shared *shrd) |
| 197 | { |
| 198 | if (shrd->dbg_level_dev) |
| 199 | return shrd->dbg_level_dev; |
| 200 | else |
| 201 | return iwlagn_mod_params.debug_level; |
| 202 | } |
| 203 | #else |
| 204 | static inline u32 iwl_get_debug_level(struct iwl_shared *shrd) |
| 205 | { |
| 206 | return iwlagn_mod_params.debug_level; |
| 207 | } |
| 208 | #endif |
| 209 | |
Emmanuel Grumbach | 5a878bf | 2011-08-25 23:10:51 -0700 | [diff] [blame] | 210 | struct iwl_rx_mem_buffer { |
| 211 | dma_addr_t page_dma; |
| 212 | struct page *page; |
| 213 | struct list_head list; |
| 214 | }; |
| 215 | |
| 216 | #define rxb_addr(r) page_address(r->page) |
| 217 | |
Emmanuel Grumbach | 48f20d3 | 2011-08-25 23:10:36 -0700 | [diff] [blame] | 218 | #ifdef CONFIG_PM |
| 219 | int iwl_suspend(struct iwl_priv *priv); |
| 220 | int iwl_resume(struct iwl_priv *priv); |
| 221 | #endif /* !CONFIG_PM */ |
| 222 | |
Emmanuel Grumbach | e6bb4c9 | 2011-08-25 23:10:48 -0700 | [diff] [blame] | 223 | int iwl_probe(struct iwl_bus *bus, const struct iwl_trans_ops *trans_ops, |
| 224 | struct iwl_cfg *cfg); |
Emmanuel Grumbach | 48f20d3 | 2011-08-25 23:10:36 -0700 | [diff] [blame] | 225 | void __devexit iwl_remove(struct iwl_priv * priv); |
| 226 | |
| 227 | #endif /* #__iwl_shared_h__ */ |