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 | |
e679378d | 66 | #include <linux/ieee80211.h> |
930dfd5f | 67 | #include <linux/mm.h> /* for page_address */ |
a72b8b08 EG |
68 | |
69 | #include "iwl-shared.h" | |
69655ebf | 70 | #include "iwl-debug.h" |
87e5666c | 71 | |
60396183 EG |
72 | /** |
73 | * DOC: Transport layer - what is it ? | |
74 | * | |
75 | * The tranport layer is the layer that deals with the HW directly. It provides | |
76 | * an abstraction of the underlying HW to the upper layer. The transport layer | |
77 | * doesn't provide any policy, algorithm or anything of this kind, but only | |
78 | * mechanisms to make the HW do something.It is not completely stateless but | |
79 | * close to it. | |
80 | * We will have an implementation for each different supported bus. | |
81 | */ | |
82 | ||
83 | /** | |
84 | * DOC: Life cycle of the transport layer | |
85 | * | |
86 | * The transport layer has a very precise life cycle. | |
87 | * | |
88 | * 1) A helper function is called during the module initialization and | |
89 | * registers the bus driver's ops with the transport's alloc function. | |
90 | * 2) Bus's probe calls to the transport layer's allocation functions. | |
91 | * Of course this function is bus specific. | |
92 | * 3) This allocation functions will spawn the upper layer which will | |
93 | * register mac80211. | |
94 | * | |
95 | * 4) At some point (i.e. mac80211's start call), the op_mode will call | |
96 | * the following sequence: | |
97 | * start_hw | |
98 | * start_fw | |
99 | * | |
100 | * 5) Then when finished (or reset): | |
101 | * stop_fw (a.k.a. stop device for the moment) | |
102 | * stop_hw | |
103 | * | |
104 | * 6) Eventually, the free function will be called. | |
105 | */ | |
106 | ||
41c50542 | 107 | struct iwl_priv; |
e6bb4c9c | 108 | struct iwl_shared; |
ed277c93 | 109 | struct iwl_op_mode; |
e679378d EG |
110 | struct fw_img; |
111 | struct sk_buff; | |
112 | struct dentry; | |
522376d2 | 113 | |
60396183 EG |
114 | /** |
115 | * DOC: Host command section | |
116 | * | |
117 | * A host command is a commaned issued by the upper layer to the fw. There are | |
118 | * several versions of fw that have several APIs. The transport layer is | |
119 | * completely agnostic to these differences. | |
120 | * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode), | |
121 | */ | |
522376d2 EG |
122 | #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4) |
123 | #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ) | |
124 | #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4) | |
f8d7c1a1 JB |
125 | #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f) |
126 | #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8) | |
127 | #define SEQ_TO_INDEX(s) ((s) & 0xff) | |
128 | #define INDEX_TO_SEQ(i) ((i) & 0xff) | |
129 | #define SEQ_RX_FRAME cpu_to_le16(0x8000) | |
130 | ||
131 | /** | |
132 | * struct iwl_cmd_header | |
133 | * | |
134 | * This header format appears in the beginning of each command sent from the | |
135 | * driver, and each response/notification received from uCode. | |
136 | */ | |
137 | struct iwl_cmd_header { | |
138 | u8 cmd; /* Command ID: REPLY_RXON, etc. */ | |
139 | u8 flags; /* 0:5 reserved, 6 abort, 7 internal */ | |
140 | /* | |
141 | * The driver sets up the sequence number to values of its choosing. | |
142 | * uCode does not use this value, but passes it back to the driver | |
143 | * when sending the response to each driver-originated command, so | |
144 | * the driver can match the response to the command. Since the values | |
145 | * don't get used by uCode, the driver may set up an arbitrary format. | |
146 | * | |
147 | * There is one exception: uCode sets bit 15 when it originates | |
148 | * the response/notification, i.e. when the response/notification | |
149 | * is not a direct response to a command sent by the driver. For | |
150 | * example, uCode issues REPLY_RX when it sends a received frame | |
151 | * to the driver; it is not a direct response to any driver command. | |
152 | * | |
153 | * The Linux driver uses the following format: | |
154 | * | |
155 | * 0:7 tfd index - position within TX queue | |
156 | * 8:12 TX queue id | |
157 | * 13:14 reserved | |
158 | * 15 unsolicited RX or uCode-originated notification | |
159 | */ | |
160 | __le16 sequence; | |
161 | } __packed; | |
162 | ||
163 | ||
164 | #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */ | |
0c19744c JB |
165 | #define FH_RSCSR_FRAME_INVALID 0x55550000 |
166 | #define FH_RSCSR_FRAME_ALIGN 0x40 | |
f8d7c1a1 JB |
167 | |
168 | struct iwl_rx_packet { | |
169 | /* | |
170 | * The first 4 bytes of the RX frame header contain both the RX frame | |
171 | * size and some flags. | |
172 | * Bit fields: | |
173 | * 31: flag flush RB request | |
174 | * 30: flag ignore TC (terminal counter) request | |
175 | * 29: flag fast IRQ request | |
176 | * 28-14: Reserved | |
177 | * 13-00: RX frame size | |
178 | */ | |
179 | __le32 len_n_flags; | |
180 | struct iwl_cmd_header hdr; | |
181 | u8 data[]; | |
182 | } __packed; | |
522376d2 | 183 | |
60396183 EG |
184 | /** |
185 | * enum CMD_MODE - how to send the host commands ? | |
186 | * | |
187 | * @CMD_SYNC: The caller will be stalled until the fw responds to the command | |
188 | * @CMD_ASYNC: Return right away and don't want for the response | |
189 | * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the | |
190 | * response. | |
191 | * @CMD_ON_DEMAND: This command is sent by the test mode pipe. | |
192 | */ | |
193 | enum CMD_MODE { | |
522376d2 EG |
194 | CMD_SYNC = 0, |
195 | CMD_ASYNC = BIT(0), | |
196 | CMD_WANT_SKB = BIT(1), | |
197 | CMD_ON_DEMAND = BIT(2), | |
198 | }; | |
199 | ||
200 | #define DEF_CMD_PAYLOAD_SIZE 320 | |
201 | ||
202 | /** | |
203 | * struct iwl_device_cmd | |
204 | * | |
205 | * For allocation of the command and tx queues, this establishes the overall | |
206 | * size of the largest command we send to uCode, except for commands that | |
207 | * aren't fully copied and use other TFD space. | |
208 | */ | |
209 | struct iwl_device_cmd { | |
210 | struct iwl_cmd_header hdr; /* uCode API */ | |
132f98c2 | 211 | u8 payload[DEF_CMD_PAYLOAD_SIZE]; |
522376d2 EG |
212 | } __packed; |
213 | ||
214 | #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd)) | |
215 | ||
216 | #define IWL_MAX_CMD_TFDS 2 | |
217 | ||
60396183 EG |
218 | /** |
219 | * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command | |
220 | * | |
221 | * IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's | |
222 | * ring. The transport layer doesn't map the command's buffer to DMA, but | |
223 | * rather copies it to an previously allocated DMA buffer. This flag tells | |
224 | * the transport layer not to copy the command, but to map the existing | |
225 | * buffer. This can save memcpy and is worth with very big comamnds. | |
226 | */ | |
522376d2 EG |
227 | enum iwl_hcmd_dataflag { |
228 | IWL_HCMD_DFL_NOCOPY = BIT(0), | |
229 | }; | |
230 | ||
231 | /** | |
232 | * struct iwl_host_cmd - Host command to the uCode | |
60396183 | 233 | * |
522376d2 | 234 | * @data: array of chunks that composes the data of the host command |
65b94a4a JB |
235 | * @resp_pkt: response packet, if %CMD_WANT_SKB was set |
236 | * @_rx_page_order: (internally used to free response packet) | |
237 | * @_rx_page_addr: (internally used to free response packet) | |
247c61d6 EG |
238 | * @handler_status: return value of the handler of the command |
239 | * (put in setup_rx_handlers) - valid for SYNC mode only | |
60396183 | 240 | * @flags: can be CMD_* |
522376d2 | 241 | * @len: array of the lenths of the chunks in data |
60396183 | 242 | * @dataflags: IWL_HCMD_DFL_* |
522376d2 EG |
243 | * @id: id of the host command |
244 | */ | |
245 | struct iwl_host_cmd { | |
246 | const void *data[IWL_MAX_CMD_TFDS]; | |
65b94a4a JB |
247 | struct iwl_rx_packet *resp_pkt; |
248 | unsigned long _rx_page_addr; | |
249 | u32 _rx_page_order; | |
247c61d6 EG |
250 | int handler_status; |
251 | ||
522376d2 EG |
252 | u32 flags; |
253 | u16 len[IWL_MAX_CMD_TFDS]; | |
254 | u8 dataflags[IWL_MAX_CMD_TFDS]; | |
255 | u8 id; | |
256 | }; | |
41c50542 | 257 | |
65b94a4a JB |
258 | static inline void iwl_free_resp(struct iwl_host_cmd *cmd) |
259 | { | |
260 | free_pages(cmd->_rx_page_addr, cmd->_rx_page_order); | |
261 | } | |
262 | ||
930dfd5f JB |
263 | struct iwl_rx_cmd_buffer { |
264 | struct page *_page; | |
0c19744c JB |
265 | int _offset; |
266 | bool _page_stolen; | |
930dfd5f JB |
267 | }; |
268 | ||
269 | static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r) | |
270 | { | |
0c19744c JB |
271 | return (void *)((unsigned long)page_address(r->_page) + r->_offset); |
272 | } | |
273 | ||
274 | static inline int rxb_offset(struct iwl_rx_cmd_buffer *r) | |
275 | { | |
276 | return r->_offset; | |
930dfd5f JB |
277 | } |
278 | ||
279 | static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r) | |
280 | { | |
0c19744c JB |
281 | r->_page_stolen = true; |
282 | get_page(r->_page); | |
283 | return r->_page; | |
930dfd5f JB |
284 | } |
285 | ||
d663ee73 JB |
286 | #define MAX_NO_RECLAIM_CMDS 6 |
287 | ||
9eae88fa JB |
288 | /* |
289 | * Maximum number of HW queues the transport layer | |
290 | * currently supports | |
291 | */ | |
292 | #define IWL_MAX_HW_QUEUES 32 | |
293 | ||
92d743ae MV |
294 | /** |
295 | * struct iwl_trans_config - transport configuration | |
296 | * | |
297 | * @op_mode: pointer to the upper layer. | |
9eae88fa JB |
298 | * @queue_to_fifo: queue to FIFO mapping to set up by |
299 | * default | |
300 | * @n_queue_to_fifo: number of queues to set up | |
c6f600fc MV |
301 | * @cmd_queue: the index of the command queue. |
302 | * Must be set before start_fw. | |
d663ee73 JB |
303 | * @no_reclaim_cmds: Some devices erroneously don't set the |
304 | * SEQ_RX_FRAME bit on some notifications, this is the | |
305 | * list of such notifications to filter. Max length is | |
306 | * %MAX_NO_RECLAIM_CMDS. | |
307 | * @n_no_reclaim_cmds: # of commands in list | |
b2cf410c JB |
308 | * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs, |
309 | * if unset 4k will be the RX buffer size | |
92d743ae MV |
310 | */ |
311 | struct iwl_trans_config { | |
312 | struct iwl_op_mode *op_mode; | |
9eae88fa JB |
313 | const u8 *queue_to_fifo; |
314 | u8 n_queue_to_fifo; | |
315 | ||
c6f600fc | 316 | u8 cmd_queue; |
d663ee73 JB |
317 | const u8 *no_reclaim_cmds; |
318 | int n_no_reclaim_cmds; | |
b2cf410c JB |
319 | |
320 | bool rx_buf_size_8k; | |
92d743ae MV |
321 | }; |
322 | ||
41c50542 EG |
323 | /** |
324 | * struct iwl_trans_ops - transport specific operations | |
60396183 EG |
325 | * |
326 | * All the handlers MUST be implemented | |
327 | * | |
57a1dc89 | 328 | * @start_hw: starts the HW- from that point on, the HW can send interrupts |
60396183 | 329 | * May sleep |
cc56feb2 EG |
330 | * @stop_hw: stops the HW- from that point on, the HW will be in low power but |
331 | * will still issue interrupt if the HW RF kill is triggered. | |
60396183 | 332 | * May sleep |
cf614297 | 333 | * @start_fw: allocates and inits all the resources for the transport |
60396183 EG |
334 | * layer. Also kick a fw image. |
335 | * May sleep | |
ed6a3803 | 336 | * @fw_alive: called when the fw sends alive notification |
60396183 | 337 | * May sleep |
41c50542 | 338 | * @stop_device:stops the whole device (embedded CPU put to reset) |
60396183 | 339 | * May sleep |
2dd4f9f7 JB |
340 | * @wowlan_suspend: put the device into the correct mode for WoWLAN during |
341 | * suspend. This is optional, if not implemented WoWLAN will not be | |
342 | * supported. This callback may sleep. | |
41c50542 | 343 | * @send_cmd:send a host command |
60396183 | 344 | * May sleep only if CMD_SYNC is set |
41c50542 | 345 | * @tx: send an skb |
60396183 | 346 | * Must be atomic |
a0eaad71 | 347 | * @reclaim: free packet until ssn. Returns a list of freed packets. |
60396183 | 348 | * Must be atomic |
c91bd124 | 349 | * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is |
60396183 EG |
350 | * ready and a successful ADDBA response has been received. |
351 | * May sleep | |
7f01d567 | 352 | * @tx_agg_disable: de-configure a Tx queue to send AMPDUs |
b0b46192 | 353 | * Must be atomic |
41c50542 | 354 | * @free: release all the ressource for the transport layer itself such as |
60396183 EG |
355 | * irq, tasklet etc... From this point on, the device may not issue |
356 | * any interrupt (incl. RFKILL). | |
357 | * May sleep | |
f22be624 | 358 | * @check_stuck_queue: check if a specific queue is stuck |
5f178cd2 | 359 | * @wait_tx_queue_empty: wait until all tx queues are empty |
60396183 | 360 | * May sleep |
87e5666c EG |
361 | * @dbgfs_register: add the dbgfs files under this directory. Files will be |
362 | * automatically deleted. | |
57210f7c EG |
363 | * @suspend: stop the device unless WoWLAN is configured |
364 | * @resume: resume activity of the device | |
03905495 EG |
365 | * @write8: write a u8 to a register at offset ofs from the BAR |
366 | * @write32: write a u32 to a register at offset ofs from the BAR | |
367 | * @read32: read a u32 register at offset ofs from the BAR | |
c6f600fc | 368 | * @configure: configure parameters required by the transport layer from |
3dc420be EG |
369 | * the op_mode. May be called several times before start_fw, can't be |
370 | * called after that. | |
47107e84 | 371 | * @set_pmi: set the power pmi state |
41c50542 EG |
372 | */ |
373 | struct iwl_trans_ops { | |
374 | ||
57a1dc89 | 375 | int (*start_hw)(struct iwl_trans *iwl_trans); |
cc56feb2 | 376 | void (*stop_hw)(struct iwl_trans *iwl_trans); |
0692fe41 | 377 | int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw); |
ed6a3803 | 378 | void (*fw_alive)(struct iwl_trans *trans); |
6d8f6eeb | 379 | void (*stop_device)(struct iwl_trans *trans); |
41c50542 | 380 | |
2dd4f9f7 JB |
381 | void (*wowlan_suspend)(struct iwl_trans *trans); |
382 | ||
6d8f6eeb | 383 | int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd); |
41c50542 | 384 | |
e13c0c59 | 385 | int (*tx)(struct iwl_trans *trans, struct sk_buff *skb, |
9eae88fa JB |
386 | struct iwl_device_cmd *dev_cmd, int queue); |
387 | void (*reclaim)(struct iwl_trans *trans, int queue, int ssn, | |
388 | struct sk_buff_head *skbs); | |
389 | ||
390 | void (*tx_agg_setup)(struct iwl_trans *trans, int queue, int fifo, | |
391 | int sta_id, int tid, int frame_limit, u16 ssn); | |
392 | void (*tx_agg_disable)(struct iwl_trans *trans, int queue); | |
41c50542 | 393 | |
6d8f6eeb | 394 | void (*free)(struct iwl_trans *trans); |
87e5666c EG |
395 | |
396 | int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir); | |
f22be624 | 397 | int (*check_stuck_queue)(struct iwl_trans *trans, int q); |
5f178cd2 | 398 | int (*wait_tx_queue_empty)(struct iwl_trans *trans); |
c01a4047 | 399 | #ifdef CONFIG_PM_SLEEP |
57210f7c EG |
400 | int (*suspend)(struct iwl_trans *trans); |
401 | int (*resume)(struct iwl_trans *trans); | |
c01a4047 | 402 | #endif |
03905495 EG |
403 | void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val); |
404 | void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val); | |
405 | u32 (*read32)(struct iwl_trans *trans, u32 ofs); | |
c6f600fc MV |
406 | void (*configure)(struct iwl_trans *trans, |
407 | const struct iwl_trans_config *trans_cfg); | |
47107e84 | 408 | void (*set_pmi)(struct iwl_trans *trans, bool state); |
41c50542 EG |
409 | }; |
410 | ||
69655ebf EG |
411 | /** |
412 | * enum iwl_trans_state - state of the transport layer | |
413 | * | |
414 | * @IWL_TRANS_NO_FW: no fw has sent an alive response | |
415 | * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response | |
416 | */ | |
417 | enum iwl_trans_state { | |
418 | IWL_TRANS_NO_FW = 0, | |
419 | IWL_TRANS_FW_ALIVE = 1, | |
420 | }; | |
421 | ||
6fbfae8e EG |
422 | /** |
423 | * struct iwl_trans - transport common data | |
60396183 | 424 | * |
6fbfae8e | 425 | * @ops - pointer to iwl_trans_ops |
ed277c93 | 426 | * @op_mode - pointer to the op_mode |
6fbfae8e | 427 | * @shrd - pointer to iwl_shared which holds shared data from the upper layer |
1042db2a | 428 | * @reg_lock - protect hw register access |
a42a1844 | 429 | * @dev - pointer to struct device * that represents the device |
99673ee5 | 430 | * @hw_id: a u32 with the ID of the device / subdevice. |
60396183 | 431 | * Set during transport allocation. |
9ca85961 | 432 | * @hw_id_str: a string with info about HW ID. Set during transport allocation. |
45c30dba | 433 | * @nvm_device_type: indicates OTP or eeprom |
f6d0e9be | 434 | * @pm_support: set to true in start_hw if link pm is supported |
69a10b29 | 435 | * @wait_command_queue: the wait_queue for SYNC host commands |
6fbfae8e | 436 | */ |
41c50542 EG |
437 | struct iwl_trans { |
438 | const struct iwl_trans_ops *ops; | |
ed277c93 | 439 | struct iwl_op_mode *op_mode; |
e6bb4c9c | 440 | struct iwl_shared *shrd; |
69655ebf | 441 | enum iwl_trans_state state; |
1042db2a | 442 | spinlock_t reg_lock; |
e6bb4c9c | 443 | |
a42a1844 | 444 | struct device *dev; |
08079a49 | 445 | u32 hw_rev; |
99673ee5 | 446 | u32 hw_id; |
9ca85961 | 447 | char hw_id_str[52]; |
a42a1844 | 448 | |
97b52cfd | 449 | int nvm_device_type; |
f6d0e9be | 450 | bool pm_support; |
97b52cfd | 451 | |
69a10b29 MV |
452 | wait_queue_head_t wait_command_queue; |
453 | ||
e6bb4c9c EG |
454 | /* pointer to trans specific struct */ |
455 | /*Ensure that this pointer will always be aligned to sizeof pointer */ | |
cbe6ab4e | 456 | char trans_specific[0] __aligned(sizeof(void *)); |
41c50542 EG |
457 | }; |
458 | ||
ed277c93 | 459 | static inline void iwl_trans_configure(struct iwl_trans *trans, |
92d743ae | 460 | const struct iwl_trans_config *trans_cfg) |
ed277c93 EG |
461 | { |
462 | /* | |
463 | * only set the op_mode for the moment. Later on, this function will do | |
464 | * more | |
465 | */ | |
92d743ae | 466 | trans->op_mode = trans_cfg->op_mode; |
c6f600fc MV |
467 | |
468 | trans->ops->configure(trans, trans_cfg); | |
ed277c93 EG |
469 | } |
470 | ||
57a1dc89 | 471 | static inline int iwl_trans_start_hw(struct iwl_trans *trans) |
e6bb4c9c | 472 | { |
60396183 EG |
473 | might_sleep(); |
474 | ||
57a1dc89 | 475 | return trans->ops->start_hw(trans); |
e6bb4c9c EG |
476 | } |
477 | ||
cc56feb2 EG |
478 | static inline void iwl_trans_stop_hw(struct iwl_trans *trans) |
479 | { | |
60396183 EG |
480 | might_sleep(); |
481 | ||
cc56feb2 | 482 | trans->ops->stop_hw(trans); |
69655ebf EG |
483 | |
484 | trans->state = IWL_TRANS_NO_FW; | |
cc56feb2 EG |
485 | } |
486 | ||
ed6a3803 EG |
487 | static inline void iwl_trans_fw_alive(struct iwl_trans *trans) |
488 | { | |
60396183 EG |
489 | might_sleep(); |
490 | ||
ed6a3803 | 491 | trans->ops->fw_alive(trans); |
69655ebf EG |
492 | |
493 | trans->state = IWL_TRANS_FW_ALIVE; | |
ed6a3803 EG |
494 | } |
495 | ||
0692fe41 JB |
496 | static inline int iwl_trans_start_fw(struct iwl_trans *trans, |
497 | const struct fw_img *fw) | |
bdfbf092 | 498 | { |
cf614297 EG |
499 | might_sleep(); |
500 | ||
501 | return trans->ops->start_fw(trans, fw); | |
bdfbf092 EG |
502 | } |
503 | ||
e6bb4c9c | 504 | static inline void iwl_trans_stop_device(struct iwl_trans *trans) |
bdfbf092 | 505 | { |
60396183 EG |
506 | might_sleep(); |
507 | ||
6d8f6eeb | 508 | trans->ops->stop_device(trans); |
69655ebf EG |
509 | |
510 | trans->state = IWL_TRANS_NO_FW; | |
bdfbf092 EG |
511 | } |
512 | ||
2dd4f9f7 JB |
513 | static inline void iwl_trans_wowlan_suspend(struct iwl_trans *trans) |
514 | { | |
515 | might_sleep(); | |
516 | trans->ops->wowlan_suspend(trans); | |
517 | } | |
518 | ||
e6bb4c9c | 519 | static inline int iwl_trans_send_cmd(struct iwl_trans *trans, |
bdfbf092 EG |
520 | struct iwl_host_cmd *cmd) |
521 | { | |
f0d120af JB |
522 | WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE, |
523 | "%s bad state = %d", __func__, trans->state); | |
69655ebf | 524 | |
6d8f6eeb | 525 | return trans->ops->send_cmd(trans, cmd); |
bdfbf092 EG |
526 | } |
527 | ||
e6bb4c9c | 528 | static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb, |
9eae88fa | 529 | struct iwl_device_cmd *dev_cmd, int queue) |
a0eaad71 | 530 | { |
f0d120af JB |
531 | WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE, |
532 | "%s bad state = %d", __func__, trans->state); | |
69655ebf | 533 | |
9eae88fa | 534 | return trans->ops->tx(trans, skb, dev_cmd, queue); |
a0eaad71 EG |
535 | } |
536 | ||
9eae88fa JB |
537 | static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue, |
538 | int ssn, struct sk_buff_head *skbs) | |
48d42c42 | 539 | { |
f0d120af JB |
540 | WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE, |
541 | "%s bad state = %d", __func__, trans->state); | |
69655ebf | 542 | |
9eae88fa | 543 | trans->ops->reclaim(trans, queue, ssn, skbs); |
48d42c42 EG |
544 | } |
545 | ||
9eae88fa | 546 | static inline void iwl_trans_tx_agg_disable(struct iwl_trans *trans, int queue) |
288712a6 | 547 | { |
f0d120af JB |
548 | WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE, |
549 | "%s bad state = %d", __func__, trans->state); | |
69655ebf | 550 | |
9eae88fa | 551 | trans->ops->tx_agg_disable(trans, queue); |
288712a6 EG |
552 | } |
553 | ||
9eae88fa JB |
554 | static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans, int queue, |
555 | int fifo, int sta_id, int tid, | |
556 | int frame_limit, u16 ssn) | |
48d42c42 | 557 | { |
60396183 EG |
558 | might_sleep(); |
559 | ||
f0d120af JB |
560 | WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE, |
561 | "%s bad state = %d", __func__, trans->state); | |
69655ebf | 562 | |
9eae88fa JB |
563 | trans->ops->tx_agg_setup(trans, queue, fifo, sta_id, tid, |
564 | frame_limit, ssn); | |
48d42c42 EG |
565 | } |
566 | ||
e6bb4c9c | 567 | static inline void iwl_trans_free(struct iwl_trans *trans) |
34c1b7ba | 568 | { |
6d8f6eeb | 569 | trans->ops->free(trans); |
34c1b7ba EG |
570 | } |
571 | ||
5f178cd2 EG |
572 | static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans) |
573 | { | |
f0d120af JB |
574 | WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE, |
575 | "%s bad state = %d", __func__, trans->state); | |
69655ebf | 576 | |
5f178cd2 EG |
577 | return trans->ops->wait_tx_queue_empty(trans); |
578 | } | |
579 | ||
f22be624 EG |
580 | static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q) |
581 | { | |
f0d120af JB |
582 | WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE, |
583 | "%s bad state = %d", __func__, trans->state); | |
69655ebf | 584 | |
f22be624 EG |
585 | return trans->ops->check_stuck_queue(trans, q); |
586 | } | |
87e5666c EG |
587 | static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans, |
588 | struct dentry *dir) | |
589 | { | |
590 | return trans->ops->dbgfs_register(trans, dir); | |
591 | } | |
592 | ||
c01a4047 | 593 | #ifdef CONFIG_PM_SLEEP |
57210f7c EG |
594 | static inline int iwl_trans_suspend(struct iwl_trans *trans) |
595 | { | |
596 | return trans->ops->suspend(trans); | |
597 | } | |
598 | ||
599 | static inline int iwl_trans_resume(struct iwl_trans *trans) | |
600 | { | |
601 | return trans->ops->resume(trans); | |
602 | } | |
c01a4047 | 603 | #endif |
57210f7c | 604 | |
03905495 EG |
605 | static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val) |
606 | { | |
607 | trans->ops->write8(trans, ofs, val); | |
608 | } | |
609 | ||
610 | static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val) | |
611 | { | |
612 | trans->ops->write32(trans, ofs, val); | |
613 | } | |
614 | ||
615 | static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs) | |
616 | { | |
617 | return trans->ops->read32(trans, ofs); | |
618 | } | |
619 | ||
47107e84 DF |
620 | static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state) |
621 | { | |
622 | trans->ops->set_pmi(trans, state); | |
623 | } | |
624 | ||
b52e7ea1 EG |
625 | /***************************************************** |
626 | * Transport layers implementations + their allocation function | |
627 | ******************************************************/ | |
628 | struct pci_dev; | |
629 | struct pci_device_id; | |
630 | extern const struct iwl_trans_ops trans_ops_pcie; | |
631 | struct iwl_trans *iwl_trans_pcie_alloc(struct iwl_shared *shrd, | |
632 | struct pci_dev *pdev, | |
633 | const struct pci_device_id *ent); | |
36a79223 EG |
634 | int __must_check iwl_pci_register_driver(void); |
635 | void iwl_pci_unregister_driver(void); | |
b52e7ea1 EG |
636 | |
637 | extern const struct iwl_trans_ops trans_ops_idi; | |
638 | struct iwl_trans *iwl_trans_idi_alloc(struct iwl_shared *shrd, | |
639 | void *pdev_void, | |
640 | const void *ent_void); | |
41c50542 | 641 | #endif /* __iwl_trans_h__ */ |