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