]>
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 | * | |
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 | *****************************************************************************/ | |
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 EG |
75 | struct iwl_priv; |
76 | struct iwl_rxon_context; | |
77 | struct iwl_host_cmd; | |
e6bb4c9c | 78 | struct iwl_shared; |
dfa2bdba | 79 | struct iwl_device_cmd; |
41c50542 EG |
80 | |
81 | /** | |
82 | * struct iwl_trans_ops - transport specific operations | |
e6bb4c9c EG |
83 | * @alloc: allocates the meta data (not the queues themselves) |
84 | * @request_irq: requests IRQ - will be called before the FW load in probe flow | |
41c50542 EG |
85 | * @start_device: allocates and inits all the resources for the transport |
86 | * layer. | |
87 | * @prepare_card_hw: claim the ownership on the HW. Will be called during | |
88 | * probe. | |
89 | * @tx_start: starts and configures all the Tx fifo - usually done once the fw | |
90 | * is alive. | |
e13c0c59 | 91 | * @wake_any_queue: wake all the queues of a specfic context IWL_RXON_CTX_* |
41c50542 | 92 | * @stop_device:stops the whole device (embedded CPU put to reset) |
41c50542 EG |
93 | * @send_cmd:send a host command |
94 | * @send_cmd_pdu:send a host command: flags can be CMD_* | |
41c50542 | 95 | * @tx: send an skb |
a0eaad71 | 96 | * @reclaim: free packet until ssn. Returns a list of freed packets. |
288712a6 | 97 | * @tx_agg_alloc: allocate resources for a TX BA session |
c91bd124 | 98 | * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is |
41c50542 | 99 | * ready and a successful ADDBA response has been received. |
7f01d567 | 100 | * @tx_agg_disable: de-configure a Tx queue to send AMPDUs |
41c50542 | 101 | * @kick_nic: remove the RESET from the embedded CPU and let it run |
41c50542 EG |
102 | * @free: release all the ressource for the transport layer itself such as |
103 | * irq, tasklet etc... | |
e20d4341 | 104 | * @stop_queue: stop a specific queue |
f22be624 | 105 | * @check_stuck_queue: check if a specific queue is stuck |
5f178cd2 | 106 | * @wait_tx_queue_empty: wait until all tx queues are empty |
87e5666c EG |
107 | * @dbgfs_register: add the dbgfs files under this directory. Files will be |
108 | * automatically deleted. | |
57210f7c EG |
109 | * @suspend: stop the device unless WoWLAN is configured |
110 | * @resume: resume activity of the device | |
41c50542 EG |
111 | */ |
112 | struct iwl_trans_ops { | |
113 | ||
e6bb4c9c EG |
114 | struct iwl_trans *(*alloc)(struct iwl_shared *shrd); |
115 | int (*request_irq)(struct iwl_trans *iwl_trans); | |
6d8f6eeb EG |
116 | int (*start_device)(struct iwl_trans *trans); |
117 | int (*prepare_card_hw)(struct iwl_trans *trans); | |
118 | void (*stop_device)(struct iwl_trans *trans); | |
119 | void (*tx_start)(struct iwl_trans *trans); | |
41c50542 | 120 | |
e13c0c59 EG |
121 | void (*wake_any_queue)(struct iwl_trans *trans, u8 ctx); |
122 | ||
6d8f6eeb | 123 | int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd); |
41c50542 | 124 | |
6d8f6eeb | 125 | int (*send_cmd_pdu)(struct iwl_trans *trans, u8 id, u32 flags, u16 len, |
41c50542 | 126 | const void *data); |
e13c0c59 EG |
127 | int (*tx)(struct iwl_trans *trans, struct sk_buff *skb, |
128 | struct iwl_device_cmd *dev_cmd, u8 ctx, u8 sta_id); | |
464021ff EG |
129 | void (*reclaim)(struct iwl_trans *trans, int sta_id, int tid, |
130 | int txq_id, int ssn, u32 status, | |
131 | struct sk_buff_head *skbs); | |
41c50542 | 132 | |
7f01d567 | 133 | int (*tx_agg_disable)(struct iwl_trans *trans, |
c91bd124 EG |
134 | enum iwl_rxon_context_id ctx, int sta_id, |
135 | int tid); | |
288712a6 EG |
136 | int (*tx_agg_alloc)(struct iwl_trans *trans, |
137 | enum iwl_rxon_context_id ctx, int sta_id, int tid, | |
138 | u16 *ssn); | |
c91bd124 EG |
139 | void (*tx_agg_setup)(struct iwl_trans *trans, |
140 | enum iwl_rxon_context_id ctx, int sta_id, int tid, | |
141 | int frame_limit); | |
41c50542 | 142 | |
6d8f6eeb | 143 | void (*kick_nic)(struct iwl_trans *trans); |
41c50542 | 144 | |
6d8f6eeb | 145 | void (*free)(struct iwl_trans *trans); |
87e5666c | 146 | |
e20d4341 EG |
147 | void (*stop_queue)(struct iwl_trans *trans, int q); |
148 | ||
87e5666c | 149 | int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir); |
f22be624 | 150 | int (*check_stuck_queue)(struct iwl_trans *trans, int q); |
5f178cd2 EG |
151 | int (*wait_tx_queue_empty)(struct iwl_trans *trans); |
152 | ||
57210f7c EG |
153 | int (*suspend)(struct iwl_trans *trans); |
154 | int (*resume)(struct iwl_trans *trans); | |
41c50542 EG |
155 | }; |
156 | ||
6fbfae8e EG |
157 | /** |
158 | * struct iwl_trans - transport common data | |
159 | * @ops - pointer to iwl_trans_ops | |
160 | * @shrd - pointer to iwl_shared which holds shared data from the upper layer | |
72012474 | 161 | * @hcmd_lock: protects HCMD |
6fbfae8e | 162 | */ |
41c50542 EG |
163 | struct iwl_trans { |
164 | const struct iwl_trans_ops *ops; | |
e6bb4c9c | 165 | struct iwl_shared *shrd; |
72012474 | 166 | spinlock_t hcmd_lock; |
e6bb4c9c EG |
167 | |
168 | /* pointer to trans specific struct */ | |
169 | /*Ensure that this pointer will always be aligned to sizeof pointer */ | |
170 | char trans_specific[0] __attribute__((__aligned__(sizeof(void *)))); | |
41c50542 EG |
171 | }; |
172 | ||
e6bb4c9c EG |
173 | static inline int iwl_trans_request_irq(struct iwl_trans *trans) |
174 | { | |
175 | return trans->ops->request_irq(trans); | |
176 | } | |
177 | ||
178 | static inline int iwl_trans_start_device(struct iwl_trans *trans) | |
bdfbf092 | 179 | { |
6d8f6eeb | 180 | return trans->ops->start_device(trans); |
bdfbf092 EG |
181 | } |
182 | ||
e6bb4c9c | 183 | static inline int iwl_trans_prepare_card_hw(struct iwl_trans *trans) |
0286cee0 | 184 | { |
6d8f6eeb | 185 | return trans->ops->prepare_card_hw(trans); |
0286cee0 EG |
186 | } |
187 | ||
e6bb4c9c | 188 | static inline void iwl_trans_stop_device(struct iwl_trans *trans) |
bdfbf092 | 189 | { |
6d8f6eeb | 190 | trans->ops->stop_device(trans); |
bdfbf092 EG |
191 | } |
192 | ||
e6bb4c9c | 193 | static inline void iwl_trans_tx_start(struct iwl_trans *trans) |
b3c2ce13 | 194 | { |
6d8f6eeb | 195 | trans->ops->tx_start(trans); |
b3c2ce13 EG |
196 | } |
197 | ||
e13c0c59 EG |
198 | static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans, u8 ctx) |
199 | { | |
200 | trans->ops->wake_any_queue(trans, ctx); | |
201 | } | |
202 | ||
203 | ||
e6bb4c9c | 204 | static inline int iwl_trans_send_cmd(struct iwl_trans *trans, |
bdfbf092 EG |
205 | struct iwl_host_cmd *cmd) |
206 | { | |
6d8f6eeb | 207 | return trans->ops->send_cmd(trans, cmd); |
bdfbf092 EG |
208 | } |
209 | ||
e6bb4c9c EG |
210 | static inline int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id, |
211 | u32 flags, u16 len, const void *data) | |
bdfbf092 | 212 | { |
6d8f6eeb | 213 | return trans->ops->send_cmd_pdu(trans, id, flags, len, data); |
bdfbf092 | 214 | } |
c85eb619 | 215 | |
e6bb4c9c | 216 | static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb, |
e13c0c59 | 217 | struct iwl_device_cmd *dev_cmd, u8 ctx, u8 sta_id) |
47c1b496 | 218 | { |
e13c0c59 | 219 | return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id); |
47c1b496 EG |
220 | } |
221 | ||
464021ff EG |
222 | static inline void iwl_trans_reclaim(struct iwl_trans *trans, int sta_id, |
223 | int tid, int txq_id, int ssn, u32 status, | |
a0eaad71 EG |
224 | struct sk_buff_head *skbs) |
225 | { | |
464021ff | 226 | trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn, status, skbs); |
a0eaad71 EG |
227 | } |
228 | ||
7f01d567 EG |
229 | static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans, |
230 | enum iwl_rxon_context_id ctx, | |
231 | int sta_id, int tid) | |
48d42c42 | 232 | { |
7f01d567 | 233 | return trans->ops->tx_agg_disable(trans, ctx, sta_id, tid); |
48d42c42 EG |
234 | } |
235 | ||
288712a6 EG |
236 | static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans, |
237 | enum iwl_rxon_context_id ctx, | |
238 | int sta_id, int tid, u16 *ssn) | |
239 | { | |
240 | return trans->ops->tx_agg_alloc(trans, ctx, sta_id, tid, ssn); | |
241 | } | |
242 | ||
243 | ||
c91bd124 | 244 | static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans, |
ba562f71 EG |
245 | enum iwl_rxon_context_id ctx, |
246 | int sta_id, int tid, | |
247 | int frame_limit) | |
48d42c42 | 248 | { |
c91bd124 | 249 | trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit); |
48d42c42 EG |
250 | } |
251 | ||
e6bb4c9c | 252 | static inline void iwl_trans_kick_nic(struct iwl_trans *trans) |
56d90f4c | 253 | { |
6d8f6eeb | 254 | trans->ops->kick_nic(trans); |
56d90f4c EG |
255 | } |
256 | ||
e6bb4c9c | 257 | static inline void iwl_trans_free(struct iwl_trans *trans) |
34c1b7ba | 258 | { |
6d8f6eeb | 259 | trans->ops->free(trans); |
34c1b7ba EG |
260 | } |
261 | ||
e20d4341 EG |
262 | static inline void iwl_trans_stop_queue(struct iwl_trans *trans, int q) |
263 | { | |
264 | trans->ops->stop_queue(trans, q); | |
265 | } | |
266 | ||
5f178cd2 EG |
267 | static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans) |
268 | { | |
269 | return trans->ops->wait_tx_queue_empty(trans); | |
270 | } | |
271 | ||
f22be624 EG |
272 | static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q) |
273 | { | |
274 | return trans->ops->check_stuck_queue(trans, q); | |
275 | } | |
87e5666c EG |
276 | static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans, |
277 | struct dentry *dir) | |
278 | { | |
279 | return trans->ops->dbgfs_register(trans, dir); | |
280 | } | |
281 | ||
57210f7c EG |
282 | static inline int iwl_trans_suspend(struct iwl_trans *trans) |
283 | { | |
284 | return trans->ops->suspend(trans); | |
285 | } | |
286 | ||
287 | static inline int iwl_trans_resume(struct iwl_trans *trans) | |
288 | { | |
289 | return trans->ops->resume(trans); | |
290 | } | |
291 | ||
e6bb4c9c EG |
292 | /***************************************************** |
293 | * Transport layers implementations | |
294 | ******************************************************/ | |
295 | extern const struct iwl_trans_ops trans_ops_pcie; | |
48d42c42 | 296 | |
41c50542 | 297 | #endif /* __iwl_trans_h__ */ |