Merge branch 'fb' into devel
[linux-2.6] / drivers / net / wireless / iwlwifi / iwl-core.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) 2008 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  * Tomas Winkler <tomas.winkler@intel.com>
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30  *
31  * BSD LICENSE
32  *
33  * Copyright(c) 2005 - 2008 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_core_h__
64 #define __iwl_core_h__
65
66 /************************
67  * forward declarations *
68  ************************/
69 struct iwl_host_cmd;
70 struct iwl_cmd;
71
72
73 #define IWLWIFI_VERSION "1.2.26k"
74 #define DRV_COPYRIGHT   "Copyright(c) 2003-2008 Intel Corporation"
75
76 #define IWL_PCI_DEVICE(dev, subdev, cfg) \
77         .vendor = PCI_VENDOR_ID_INTEL,  .device = (dev), \
78         .subvendor = PCI_ANY_ID, .subdevice = (subdev), \
79         .driver_data = (kernel_ulong_t)&(cfg)
80
81 #define IWL_SKU_G       0x1
82 #define IWL_SKU_A       0x2
83 #define IWL_SKU_N       0x8
84
85 struct iwl_hcmd_ops {
86         int (*rxon_assoc)(struct iwl_priv *priv);
87 };
88 struct iwl_hcmd_utils_ops {
89         int (*enqueue_hcmd)(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
90 };
91
92 struct iwl_lib_ops {
93         /* iwlwifi driver (priv) init */
94         int (*init_drv)(struct iwl_priv *priv);
95         /* set hw dependant perameters */
96         int (*set_hw_params)(struct iwl_priv *priv);
97
98         void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
99                                         struct iwl4965_tx_queue *txq,
100                                         u16 byte_cnt);
101         /* nic init */
102         int (*hw_nic_init)(struct iwl_priv *priv);
103         /* alive notification */
104         int (*alive_notify)(struct iwl_priv *priv);
105         /* check validity of rtc data address */
106         int (*is_valid_rtc_data_addr)(u32 addr);
107         /* 1st ucode load */
108         int (*load_ucode)(struct iwl_priv *priv);
109         /* rfkill */
110         void (*radio_kill_sw)(struct iwl_priv *priv, int disable_radio);
111         /* eeprom operations (as defined in iwl-eeprom.h) */
112         struct iwl_eeprom_ops eeprom_ops;
113 };
114
115 struct iwl_ops {
116         const struct iwl_lib_ops *lib;
117         const struct iwl_hcmd_ops *hcmd;
118         const struct iwl_hcmd_utils_ops *utils;
119 };
120
121 struct iwl_mod_params {
122         int disable;            /* def: 0 = enable radio */
123         int sw_crypto;          /* def: 0 = using hardware encryption */
124         int debug;              /* def: 0 = minimal debug log messages */
125         int disable_hw_scan;    /* def: 0 = use h/w scan */
126         int num_of_queues;      /* def: HW dependent */
127         int enable_qos;         /* def: 1 = use quality of service */
128         int amsdu_size_8K;      /* def: 1 = enable 8K amsdu size */
129         int antenna;            /* def: 0 = both antennas (use diversity) */
130 };
131
132 struct iwl_cfg {
133         const char *name;
134         const char *fw_name;
135         unsigned int sku;
136         const struct iwl_ops *ops;
137         const struct iwl_mod_params *mod_params;
138 };
139
140 /***************************
141  *   L i b                 *
142  ***************************/
143
144 struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
145                 struct ieee80211_ops *hw_ops);
146
147 void iwlcore_clear_stations_table(struct iwl_priv *priv);
148 void iwlcore_reset_qos(struct iwl_priv *priv);
149 int iwlcore_set_rxon_channel(struct iwl_priv *priv,
150                                 enum ieee80211_band band,
151                                 u16 channel);
152
153 int iwl_setup(struct iwl_priv *priv);
154
155 /*****************************************************
156  *   S e n d i n g     H o s t     C o m m a n d s   *
157  *****************************************************/
158
159 const char *get_cmd_string(u8 cmd);
160 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
161                                    struct iwl_host_cmd *cmd);
162 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
163 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
164                                   u16 len, const void *data);
165 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
166                            const void *data,
167                            int (*callback)(struct iwl_priv *priv,
168                                            struct iwl_cmd *cmd,
169                                            struct sk_buff *skb));
170 /*************** DRIVER STATUS FUNCTIONS   *****/
171
172 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
173 #define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
174 #define STATUS_INT_ENABLED      2
175 #define STATUS_RF_KILL_HW       3
176 #define STATUS_RF_KILL_SW       4
177 #define STATUS_INIT             5
178 #define STATUS_ALIVE            6
179 #define STATUS_READY            7
180 #define STATUS_TEMPERATURE      8
181 #define STATUS_GEO_CONFIGURED   9
182 #define STATUS_EXIT_PENDING     10
183 #define STATUS_IN_SUSPEND       11
184 #define STATUS_STATISTICS       12
185 #define STATUS_SCANNING         13
186 #define STATUS_SCAN_ABORTING    14
187 #define STATUS_SCAN_HW          15
188 #define STATUS_POWER_PMI        16
189 #define STATUS_FW_ERROR         17
190 #define STATUS_CONF_PENDING     18
191
192
193 static inline int iwl_is_ready(struct iwl_priv *priv)
194 {
195         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
196          * set but EXIT_PENDING is not */
197         return test_bit(STATUS_READY, &priv->status) &&
198                test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
199                !test_bit(STATUS_EXIT_PENDING, &priv->status);
200 }
201
202 static inline int iwl_is_alive(struct iwl_priv *priv)
203 {
204         return test_bit(STATUS_ALIVE, &priv->status);
205 }
206
207 static inline int iwl_is_init(struct iwl_priv *priv)
208 {
209         return test_bit(STATUS_INIT, &priv->status);
210 }
211
212 static inline int iwl_is_rfkill(struct iwl_priv *priv)
213 {
214         return test_bit(STATUS_RF_KILL_HW, &priv->status) ||
215                test_bit(STATUS_RF_KILL_SW, &priv->status);
216 }
217
218 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
219 {
220
221         if (iwl_is_rfkill(priv))
222                 return 0;
223
224         return iwl_is_ready(priv);
225 }
226
227
228 enum iwlcore_card_notify {
229         IWLCORE_INIT_EVT = 0,
230         IWLCORE_START_EVT = 1,
231         IWLCORE_STOP_EVT = 2,
232         IWLCORE_REMOVE_EVT = 3,
233 };
234
235 int iwlcore_low_level_notify(struct iwl_priv *priv,
236                              enum iwlcore_card_notify notify);
237 extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
238 int iwl_send_lq_cmd(struct iwl_priv *priv,
239                     struct iwl_link_quality_cmd *lq, u8 flags);
240
241 static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
242 {
243         return priv->cfg->ops->hcmd->rxon_assoc(priv);
244 }
245
246 #endif /* __iwl_core_h__ */