]>
Commit | Line | Data |
---|---|---|
c85eb619 EG |
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 | * | |
4e318262 | 8 | * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved. |
c85eb619 EG |
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 | * | |
4e318262 | 33 | * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved. |
c85eb619 EG |
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 | *****************************************************************************/ | |
41c50542 EG |
63 | #ifndef __iwl_trans_h__ |
64 | #define __iwl_trans_h__ | |
253a634c | 65 | |
87e5666c | 66 | #include <linux/debugfs.h> |
a72b8b08 EG |
67 | #include <linux/skbuff.h> |
68 | ||
69 | #include "iwl-shared.h" | |
70 | #include "iwl-commands.h" | |
87e5666c | 71 | |
253a634c EG |
72 | /*This file includes the declaration that are exported from the transport |
73 | * layer */ | |
74 | ||
41c50542 | 75 | struct iwl_priv; |
e6bb4c9c | 76 | struct iwl_shared; |
522376d2 EG |
77 | |
78 | #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4) | |
79 | #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ) | |
80 | #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4) | |
81 | ||
82 | enum { | |
83 | CMD_SYNC = 0, | |
84 | CMD_ASYNC = BIT(0), | |
85 | CMD_WANT_SKB = BIT(1), | |
86 | CMD_ON_DEMAND = BIT(2), | |
87 | }; | |
88 | ||
89 | #define DEF_CMD_PAYLOAD_SIZE 320 | |
90 | ||
91 | /** | |
92 | * struct iwl_device_cmd | |
93 | * | |
94 | * For allocation of the command and tx queues, this establishes the overall | |
95 | * size of the largest command we send to uCode, except for commands that | |
96 | * aren't fully copied and use other TFD space. | |
97 | */ | |
98 | struct iwl_device_cmd { | |
99 | struct iwl_cmd_header hdr; /* uCode API */ | |
132f98c2 | 100 | u8 payload[DEF_CMD_PAYLOAD_SIZE]; |
522376d2 EG |
101 | } __packed; |
102 | ||
103 | #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd)) | |
104 | ||
105 | #define IWL_MAX_CMD_TFDS 2 | |
106 | ||
107 | enum iwl_hcmd_dataflag { | |
108 | IWL_HCMD_DFL_NOCOPY = BIT(0), | |
109 | }; | |
110 | ||
111 | /** | |
112 | * struct iwl_host_cmd - Host command to the uCode | |
113 | * @data: array of chunks that composes the data of the host command | |
114 | * @reply_page: pointer to the page that holds the response to the host command | |
247c61d6 EG |
115 | * @handler_status: return value of the handler of the command |
116 | * (put in setup_rx_handlers) - valid for SYNC mode only | |
522376d2 EG |
117 | * @callback: |
118 | * @flags: can be CMD_* note CMD_WANT_SKB is incompatible withe CMD_ASYNC | |
119 | * @len: array of the lenths of the chunks in data | |
120 | * @dataflags: | |
121 | * @id: id of the host command | |
122 | */ | |
123 | struct iwl_host_cmd { | |
124 | const void *data[IWL_MAX_CMD_TFDS]; | |
125 | unsigned long reply_page; | |
247c61d6 EG |
126 | int handler_status; |
127 | ||
522376d2 EG |
128 | u32 flags; |
129 | u16 len[IWL_MAX_CMD_TFDS]; | |
130 | u8 dataflags[IWL_MAX_CMD_TFDS]; | |
131 | u8 id; | |
132 | }; | |
41c50542 EG |
133 | |
134 | /** | |
135 | * struct iwl_trans_ops - transport specific operations | |
e6bb4c9c | 136 | * @request_irq: requests IRQ - will be called before the FW load in probe flow |
41c50542 EG |
137 | * @start_device: allocates and inits all the resources for the transport |
138 | * layer. | |
139 | * @prepare_card_hw: claim the ownership on the HW. Will be called during | |
140 | * probe. | |
ed6a3803 | 141 | * @fw_alive: called when the fw sends alive notification |
e13c0c59 | 142 | * @wake_any_queue: wake all the queues of a specfic context IWL_RXON_CTX_* |
41c50542 | 143 | * @stop_device:stops the whole device (embedded CPU put to reset) |
41c50542 | 144 | * @send_cmd:send a host command |
41c50542 | 145 | * @tx: send an skb |
a0eaad71 | 146 | * @reclaim: free packet until ssn. Returns a list of freed packets. |
288712a6 | 147 | * @tx_agg_alloc: allocate resources for a TX BA session |
c91bd124 | 148 | * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is |
41c50542 | 149 | * ready and a successful ADDBA response has been received. |
7f01d567 | 150 | * @tx_agg_disable: de-configure a Tx queue to send AMPDUs |
41c50542 | 151 | * @kick_nic: remove the RESET from the embedded CPU and let it run |
41c50542 EG |
152 | * @free: release all the ressource for the transport layer itself such as |
153 | * irq, tasklet etc... | |
e20d4341 | 154 | * @stop_queue: stop a specific queue |
f22be624 | 155 | * @check_stuck_queue: check if a specific queue is stuck |
5f178cd2 | 156 | * @wait_tx_queue_empty: wait until all tx queues are empty |
87e5666c EG |
157 | * @dbgfs_register: add the dbgfs files under this directory. Files will be |
158 | * automatically deleted. | |
57210f7c EG |
159 | * @suspend: stop the device unless WoWLAN is configured |
160 | * @resume: resume activity of the device | |
41c50542 EG |
161 | */ |
162 | struct iwl_trans_ops { | |
163 | ||
e6bb4c9c | 164 | int (*request_irq)(struct iwl_trans *iwl_trans); |
6d8f6eeb | 165 | int (*start_device)(struct iwl_trans *trans); |
ed6a3803 | 166 | void (*fw_alive)(struct iwl_trans *trans); |
6d8f6eeb EG |
167 | int (*prepare_card_hw)(struct iwl_trans *trans); |
168 | void (*stop_device)(struct iwl_trans *trans); | |
41c50542 | 169 | |
14991a9d | 170 | void (*wake_any_queue)(struct iwl_trans *trans, |
81a3de1c EG |
171 | enum iwl_rxon_context_id ctx, |
172 | const char *msg); | |
e13c0c59 | 173 | |
6d8f6eeb | 174 | int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd); |
41c50542 | 175 | |
e13c0c59 | 176 | int (*tx)(struct iwl_trans *trans, struct sk_buff *skb, |
14991a9d | 177 | struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx, |
34b5321e | 178 | u8 sta_id, u8 tid); |
76bc10fc | 179 | int (*reclaim)(struct iwl_trans *trans, int sta_id, int tid, |
464021ff EG |
180 | int txq_id, int ssn, u32 status, |
181 | struct sk_buff_head *skbs); | |
41c50542 | 182 | |
7f01d567 | 183 | int (*tx_agg_disable)(struct iwl_trans *trans, |
bc237730 | 184 | int sta_id, int tid); |
288712a6 | 185 | int (*tx_agg_alloc)(struct iwl_trans *trans, |
3c69b595 | 186 | int sta_id, int tid); |
c91bd124 EG |
187 | void (*tx_agg_setup)(struct iwl_trans *trans, |
188 | enum iwl_rxon_context_id ctx, int sta_id, int tid, | |
822e8b2a | 189 | int frame_limit, u16 ssn); |
41c50542 | 190 | |
6d8f6eeb | 191 | void (*kick_nic)(struct iwl_trans *trans); |
41c50542 | 192 | |
6d8f6eeb | 193 | void (*free)(struct iwl_trans *trans); |
87e5666c | 194 | |
81a3de1c | 195 | void (*stop_queue)(struct iwl_trans *trans, int q, const char *msg); |
e20d4341 | 196 | |
87e5666c | 197 | int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir); |
f22be624 | 198 | int (*check_stuck_queue)(struct iwl_trans *trans, int q); |
5f178cd2 | 199 | int (*wait_tx_queue_empty)(struct iwl_trans *trans); |
c01a4047 | 200 | #ifdef CONFIG_PM_SLEEP |
57210f7c EG |
201 | int (*suspend)(struct iwl_trans *trans); |
202 | int (*resume)(struct iwl_trans *trans); | |
c01a4047 | 203 | #endif |
41c50542 EG |
204 | }; |
205 | ||
de7f5f92 DF |
206 | /* one for each uCode image (inst/data, boot/init/runtime) */ |
207 | struct fw_desc { | |
208 | dma_addr_t p_addr; /* hardware address */ | |
209 | void *v_addr; /* software address */ | |
210 | u32 len; /* size in bytes */ | |
211 | }; | |
212 | ||
213 | struct fw_img { | |
214 | struct fw_desc code; /* firmware code image */ | |
215 | struct fw_desc data; /* firmware data image */ | |
216 | }; | |
217 | ||
45c30dba DF |
218 | /* Opaque calibration results */ |
219 | struct iwl_calib_result { | |
220 | struct list_head list; | |
221 | size_t cmd_len; | |
222 | struct iwl_calib_hdr hdr; | |
223 | /* data follows */ | |
224 | }; | |
225 | ||
6fbfae8e EG |
226 | /** |
227 | * struct iwl_trans - transport common data | |
228 | * @ops - pointer to iwl_trans_ops | |
229 | * @shrd - pointer to iwl_shared which holds shared data from the upper layer | |
72012474 | 230 | * @hcmd_lock: protects HCMD |
a42a1844 EG |
231 | * @dev - pointer to struct device * that represents the device |
232 | * @irq - the irq number for the device | |
5703ddb0 | 233 | * @ucode_write_complete: indicates that the ucode has been copied. |
de7f5f92 DF |
234 | * @ucode_rt: run time ucode image |
235 | * @ucode_init: init ucode image | |
236 | * @ucode_wowlan: wake on wireless ucode image (optional) | |
45c30dba DF |
237 | * @nvm_device_type: indicates OTP or eeprom |
238 | * @calib_results: list head for init calibration results | |
6fbfae8e | 239 | */ |
41c50542 EG |
240 | struct iwl_trans { |
241 | const struct iwl_trans_ops *ops; | |
e6bb4c9c | 242 | struct iwl_shared *shrd; |
72012474 | 243 | spinlock_t hcmd_lock; |
e6bb4c9c | 244 | |
a42a1844 EG |
245 | struct device *dev; |
246 | unsigned int irq; | |
247 | ||
5703ddb0 | 248 | u8 ucode_write_complete; /* the image write is complete */ |
de7f5f92 DF |
249 | struct fw_img ucode_rt; |
250 | struct fw_img ucode_init; | |
251 | struct fw_img ucode_wowlan; | |
5703ddb0 | 252 | |
97b52cfd DF |
253 | /* eeprom related variables */ |
254 | int nvm_device_type; | |
255 | ||
45c30dba DF |
256 | /* init calibration results */ |
257 | struct list_head calib_results; | |
258 | ||
e6bb4c9c EG |
259 | /* pointer to trans specific struct */ |
260 | /*Ensure that this pointer will always be aligned to sizeof pointer */ | |
261 | char trans_specific[0] __attribute__((__aligned__(sizeof(void *)))); | |
41c50542 EG |
262 | }; |
263 | ||
e6bb4c9c EG |
264 | static inline int iwl_trans_request_irq(struct iwl_trans *trans) |
265 | { | |
266 | return trans->ops->request_irq(trans); | |
267 | } | |
268 | ||
ed6a3803 EG |
269 | static inline void iwl_trans_fw_alive(struct iwl_trans *trans) |
270 | { | |
271 | trans->ops->fw_alive(trans); | |
272 | } | |
273 | ||
e6bb4c9c | 274 | static inline int iwl_trans_start_device(struct iwl_trans *trans) |
bdfbf092 | 275 | { |
6d8f6eeb | 276 | return trans->ops->start_device(trans); |
bdfbf092 EG |
277 | } |
278 | ||
e6bb4c9c | 279 | static inline int iwl_trans_prepare_card_hw(struct iwl_trans *trans) |
0286cee0 | 280 | { |
6d8f6eeb | 281 | return trans->ops->prepare_card_hw(trans); |
0286cee0 EG |
282 | } |
283 | ||
e6bb4c9c | 284 | static inline void iwl_trans_stop_device(struct iwl_trans *trans) |
bdfbf092 | 285 | { |
6d8f6eeb | 286 | trans->ops->stop_device(trans); |
bdfbf092 EG |
287 | } |
288 | ||
14991a9d | 289 | static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans, |
81a3de1c EG |
290 | enum iwl_rxon_context_id ctx, |
291 | const char *msg) | |
e13c0c59 | 292 | { |
81a3de1c | 293 | trans->ops->wake_any_queue(trans, ctx, msg); |
e13c0c59 EG |
294 | } |
295 | ||
296 | ||
e6bb4c9c | 297 | static inline int iwl_trans_send_cmd(struct iwl_trans *trans, |
bdfbf092 EG |
298 | struct iwl_host_cmd *cmd) |
299 | { | |
6d8f6eeb | 300 | return trans->ops->send_cmd(trans, cmd); |
bdfbf092 EG |
301 | } |
302 | ||
370ad313 JB |
303 | int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id, |
304 | u32 flags, u16 len, const void *data); | |
c85eb619 | 305 | |
e6bb4c9c | 306 | static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb, |
14991a9d | 307 | struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx, |
34b5321e | 308 | u8 sta_id, u8 tid) |
47c1b496 | 309 | { |
34b5321e | 310 | return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id, tid); |
47c1b496 EG |
311 | } |
312 | ||
76bc10fc | 313 | static inline int iwl_trans_reclaim(struct iwl_trans *trans, int sta_id, |
464021ff | 314 | int tid, int txq_id, int ssn, u32 status, |
a0eaad71 EG |
315 | struct sk_buff_head *skbs) |
316 | { | |
76bc10fc EG |
317 | return trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn, |
318 | status, skbs); | |
a0eaad71 EG |
319 | } |
320 | ||
7f01d567 | 321 | static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans, |
7f01d567 | 322 | int sta_id, int tid) |
48d42c42 | 323 | { |
bc237730 | 324 | return trans->ops->tx_agg_disable(trans, sta_id, tid); |
48d42c42 EG |
325 | } |
326 | ||
288712a6 | 327 | static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans, |
3c69b595 | 328 | int sta_id, int tid) |
288712a6 | 329 | { |
3c69b595 | 330 | return trans->ops->tx_agg_alloc(trans, sta_id, tid); |
288712a6 EG |
331 | } |
332 | ||
333 | ||
c91bd124 | 334 | static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans, |
ba562f71 EG |
335 | enum iwl_rxon_context_id ctx, |
336 | int sta_id, int tid, | |
822e8b2a | 337 | int frame_limit, u16 ssn) |
48d42c42 | 338 | { |
822e8b2a | 339 | trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit, ssn); |
48d42c42 EG |
340 | } |
341 | ||
e6bb4c9c | 342 | static inline void iwl_trans_kick_nic(struct iwl_trans *trans) |
56d90f4c | 343 | { |
6d8f6eeb | 344 | trans->ops->kick_nic(trans); |
56d90f4c EG |
345 | } |
346 | ||
e6bb4c9c | 347 | static inline void iwl_trans_free(struct iwl_trans *trans) |
34c1b7ba | 348 | { |
6d8f6eeb | 349 | trans->ops->free(trans); |
34c1b7ba EG |
350 | } |
351 | ||
81a3de1c EG |
352 | static inline void iwl_trans_stop_queue(struct iwl_trans *trans, int q, |
353 | const char *msg) | |
e20d4341 | 354 | { |
81a3de1c | 355 | trans->ops->stop_queue(trans, q, msg); |
e20d4341 EG |
356 | } |
357 | ||
5f178cd2 EG |
358 | static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans) |
359 | { | |
360 | return trans->ops->wait_tx_queue_empty(trans); | |
361 | } | |
362 | ||
f22be624 EG |
363 | static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q) |
364 | { | |
365 | return trans->ops->check_stuck_queue(trans, q); | |
366 | } | |
87e5666c EG |
367 | static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans, |
368 | struct dentry *dir) | |
369 | { | |
370 | return trans->ops->dbgfs_register(trans, dir); | |
371 | } | |
372 | ||
c01a4047 | 373 | #ifdef CONFIG_PM_SLEEP |
57210f7c EG |
374 | static inline int iwl_trans_suspend(struct iwl_trans *trans) |
375 | { | |
376 | return trans->ops->suspend(trans); | |
377 | } | |
378 | ||
379 | static inline int iwl_trans_resume(struct iwl_trans *trans) | |
380 | { | |
381 | return trans->ops->resume(trans); | |
382 | } | |
c01a4047 | 383 | #endif |
57210f7c | 384 | |
e6bb4c9c | 385 | /***************************************************** |
b52e7ea1 | 386 | * Utils functions |
e6bb4c9c | 387 | ******************************************************/ |
de7f5f92 DF |
388 | int iwl_alloc_fw_desc(struct iwl_bus *bus, struct fw_desc *desc, |
389 | const void *data, size_t len); | |
390 | void iwl_dealloc_ucode(struct iwl_trans *trans); | |
391 | ||
45c30dba DF |
392 | int iwl_send_calib_results(struct iwl_trans *trans); |
393 | int iwl_calib_set(struct iwl_trans *trans, | |
394 | const struct iwl_calib_hdr *cmd, int len); | |
395 | void iwl_calib_free_results(struct iwl_trans *trans); | |
396 | ||
b52e7ea1 EG |
397 | /***************************************************** |
398 | * Transport layers implementations + their allocation function | |
399 | ******************************************************/ | |
400 | struct pci_dev; | |
401 | struct pci_device_id; | |
402 | extern const struct iwl_trans_ops trans_ops_pcie; | |
403 | struct iwl_trans *iwl_trans_pcie_alloc(struct iwl_shared *shrd, | |
404 | struct pci_dev *pdev, | |
405 | const struct pci_device_id *ent); | |
406 | ||
407 | extern const struct iwl_trans_ops trans_ops_idi; | |
408 | struct iwl_trans *iwl_trans_idi_alloc(struct iwl_shared *shrd, | |
409 | void *pdev_void, | |
410 | const void *ent_void); | |
41c50542 | 411 | #endif /* __iwl_trans_h__ */ |