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 | * | |
51368bf7 | 8 | * Copyright(c) 2007 - 2014 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 | |
410dc5aa | 25 | * in the file called COPYING. |
c85eb619 EG |
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 | * | |
51368bf7 | 33 | * Copyright(c) 2005 - 2014 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 */ |
2bfb5092 | 68 | #include <linux/lockdep.h> |
a72b8b08 | 69 | |
69655ebf | 70 | #include "iwl-debug.h" |
6238b008 JB |
71 | #include "iwl-config.h" |
72 | #include "iwl-fw.h" | |
2a988e98 | 73 | #include "iwl-op-mode.h" |
87e5666c | 74 | |
60396183 EG |
75 | /** |
76 | * DOC: Transport layer - what is it ? | |
77 | * | |
78 | * The tranport layer is the layer that deals with the HW directly. It provides | |
79 | * an abstraction of the underlying HW to the upper layer. The transport layer | |
80 | * doesn't provide any policy, algorithm or anything of this kind, but only | |
81 | * mechanisms to make the HW do something.It is not completely stateless but | |
82 | * close to it. | |
83 | * We will have an implementation for each different supported bus. | |
84 | */ | |
85 | ||
86 | /** | |
87 | * DOC: Life cycle of the transport layer | |
88 | * | |
89 | * The transport layer has a very precise life cycle. | |
90 | * | |
91 | * 1) A helper function is called during the module initialization and | |
92 | * registers the bus driver's ops with the transport's alloc function. | |
93 | * 2) Bus's probe calls to the transport layer's allocation functions. | |
94 | * Of course this function is bus specific. | |
95 | * 3) This allocation functions will spawn the upper layer which will | |
96 | * register mac80211. | |
97 | * | |
98 | * 4) At some point (i.e. mac80211's start call), the op_mode will call | |
99 | * the following sequence: | |
100 | * start_hw | |
101 | * start_fw | |
102 | * | |
103 | * 5) Then when finished (or reset): | |
a4082843 | 104 | * stop_device |
60396183 EG |
105 | * |
106 | * 6) Eventually, the free function will be called. | |
107 | */ | |
108 | ||
60396183 EG |
109 | /** |
110 | * DOC: Host command section | |
111 | * | |
112 | * A host command is a commaned issued by the upper layer to the fw. There are | |
113 | * several versions of fw that have several APIs. The transport layer is | |
114 | * completely agnostic to these differences. | |
115 | * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode), | |
116 | */ | |
f8d7c1a1 JB |
117 | #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f) |
118 | #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8) | |
119 | #define SEQ_TO_INDEX(s) ((s) & 0xff) | |
120 | #define INDEX_TO_SEQ(i) ((i) & 0xff) | |
121 | #define SEQ_RX_FRAME cpu_to_le16(0x8000) | |
122 | ||
123 | /** | |
124 | * struct iwl_cmd_header | |
125 | * | |
126 | * This header format appears in the beginning of each command sent from the | |
127 | * driver, and each response/notification received from uCode. | |
128 | */ | |
129 | struct iwl_cmd_header { | |
130 | u8 cmd; /* Command ID: REPLY_RXON, etc. */ | |
131 | u8 flags; /* 0:5 reserved, 6 abort, 7 internal */ | |
132 | /* | |
133 | * The driver sets up the sequence number to values of its choosing. | |
134 | * uCode does not use this value, but passes it back to the driver | |
135 | * when sending the response to each driver-originated command, so | |
136 | * the driver can match the response to the command. Since the values | |
137 | * don't get used by uCode, the driver may set up an arbitrary format. | |
138 | * | |
139 | * There is one exception: uCode sets bit 15 when it originates | |
140 | * the response/notification, i.e. when the response/notification | |
141 | * is not a direct response to a command sent by the driver. For | |
142 | * example, uCode issues REPLY_RX when it sends a received frame | |
143 | * to the driver; it is not a direct response to any driver command. | |
144 | * | |
145 | * The Linux driver uses the following format: | |
146 | * | |
147 | * 0:7 tfd index - position within TX queue | |
148 | * 8:12 TX queue id | |
149 | * 13:14 reserved | |
150 | * 15 unsolicited RX or uCode-originated notification | |
151 | */ | |
152 | __le16 sequence; | |
153 | } __packed; | |
154 | ||
c08ce20c JB |
155 | /* iwl_cmd_header flags value */ |
156 | #define IWL_CMD_FAILED_MSK 0x40 | |
157 | ||
f8d7c1a1 JB |
158 | |
159 | #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */ | |
0c19744c JB |
160 | #define FH_RSCSR_FRAME_INVALID 0x55550000 |
161 | #define FH_RSCSR_FRAME_ALIGN 0x40 | |
f8d7c1a1 JB |
162 | |
163 | struct iwl_rx_packet { | |
164 | /* | |
165 | * The first 4 bytes of the RX frame header contain both the RX frame | |
166 | * size and some flags. | |
167 | * Bit fields: | |
168 | * 31: flag flush RB request | |
169 | * 30: flag ignore TC (terminal counter) request | |
170 | * 29: flag fast IRQ request | |
171 | * 28-14: Reserved | |
172 | * 13-00: RX frame size | |
173 | */ | |
174 | __le32 len_n_flags; | |
175 | struct iwl_cmd_header hdr; | |
176 | u8 data[]; | |
177 | } __packed; | |
522376d2 | 178 | |
60396183 EG |
179 | /** |
180 | * enum CMD_MODE - how to send the host commands ? | |
181 | * | |
182 | * @CMD_SYNC: The caller will be stalled until the fw responds to the command | |
e89044d7 | 183 | * @CMD_ASYNC: Return right away and don't wait for the response |
60396183 | 184 | * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the |
96791422 | 185 | * response. The caller needs to call iwl_free_resp when done. |
60396183 EG |
186 | */ |
187 | enum CMD_MODE { | |
4a4ee101 JB |
188 | CMD_SYNC = 0, |
189 | CMD_ASYNC = BIT(0), | |
190 | CMD_WANT_SKB = BIT(1), | |
4f59334b | 191 | CMD_SEND_IN_RFKILL = BIT(2), |
522376d2 EG |
192 | }; |
193 | ||
194 | #define DEF_CMD_PAYLOAD_SIZE 320 | |
195 | ||
196 | /** | |
197 | * struct iwl_device_cmd | |
198 | * | |
199 | * For allocation of the command and tx queues, this establishes the overall | |
200 | * size of the largest command we send to uCode, except for commands that | |
201 | * aren't fully copied and use other TFD space. | |
202 | */ | |
203 | struct iwl_device_cmd { | |
204 | struct iwl_cmd_header hdr; /* uCode API */ | |
132f98c2 | 205 | u8 payload[DEF_CMD_PAYLOAD_SIZE]; |
522376d2 EG |
206 | } __packed; |
207 | ||
208 | #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd)) | |
209 | ||
1afbfb60 JB |
210 | /* |
211 | * number of transfer buffers (fragments) per transmit frame descriptor; | |
212 | * this is just the driver's idea, the hardware supports 20 | |
213 | */ | |
214 | #define IWL_MAX_CMD_TBS_PER_TFD 2 | |
522376d2 | 215 | |
60396183 EG |
216 | /** |
217 | * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command | |
218 | * | |
f4feb8ac | 219 | * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's |
60396183 | 220 | * ring. The transport layer doesn't map the command's buffer to DMA, but |
e89044d7 | 221 | * rather copies it to a previously allocated DMA buffer. This flag tells |
60396183 | 222 | * the transport layer not to copy the command, but to map the existing |
3e2c1592 JB |
223 | * buffer (that is passed in) instead. This saves the memcpy and allows |
224 | * commands that are bigger than the fixed buffer to be submitted. | |
225 | * Note that a TFD entry after a NOCOPY one cannot be a normal copied one. | |
f4feb8ac JB |
226 | * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this |
227 | * chunk internally and free it again after the command completes. This | |
228 | * can (currently) be used only once per command. | |
3e2c1592 | 229 | * Note that a TFD entry after a DUP one cannot be a normal copied one. |
60396183 | 230 | */ |
522376d2 EG |
231 | enum iwl_hcmd_dataflag { |
232 | IWL_HCMD_DFL_NOCOPY = BIT(0), | |
f4feb8ac | 233 | IWL_HCMD_DFL_DUP = BIT(1), |
522376d2 EG |
234 | }; |
235 | ||
236 | /** | |
237 | * struct iwl_host_cmd - Host command to the uCode | |
60396183 | 238 | * |
522376d2 | 239 | * @data: array of chunks that composes the data of the host command |
65b94a4a JB |
240 | * @resp_pkt: response packet, if %CMD_WANT_SKB was set |
241 | * @_rx_page_order: (internally used to free response packet) | |
242 | * @_rx_page_addr: (internally used to free response packet) | |
247c61d6 EG |
243 | * @handler_status: return value of the handler of the command |
244 | * (put in setup_rx_handlers) - valid for SYNC mode only | |
60396183 | 245 | * @flags: can be CMD_* |
e89044d7 | 246 | * @len: array of the lengths of the chunks in data |
60396183 | 247 | * @dataflags: IWL_HCMD_DFL_* |
522376d2 EG |
248 | * @id: id of the host command |
249 | */ | |
250 | struct iwl_host_cmd { | |
1afbfb60 | 251 | const void *data[IWL_MAX_CMD_TBS_PER_TFD]; |
65b94a4a JB |
252 | struct iwl_rx_packet *resp_pkt; |
253 | unsigned long _rx_page_addr; | |
254 | u32 _rx_page_order; | |
247c61d6 EG |
255 | int handler_status; |
256 | ||
522376d2 | 257 | u32 flags; |
1afbfb60 JB |
258 | u16 len[IWL_MAX_CMD_TBS_PER_TFD]; |
259 | u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD]; | |
522376d2 EG |
260 | u8 id; |
261 | }; | |
41c50542 | 262 | |
65b94a4a JB |
263 | static inline void iwl_free_resp(struct iwl_host_cmd *cmd) |
264 | { | |
265 | free_pages(cmd->_rx_page_addr, cmd->_rx_page_order); | |
266 | } | |
267 | ||
930dfd5f JB |
268 | struct iwl_rx_cmd_buffer { |
269 | struct page *_page; | |
0c19744c JB |
270 | int _offset; |
271 | bool _page_stolen; | |
d13f1862 | 272 | u32 _rx_page_order; |
ed90542b | 273 | unsigned int truesize; |
930dfd5f JB |
274 | }; |
275 | ||
276 | static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r) | |
277 | { | |
0c19744c JB |
278 | return (void *)((unsigned long)page_address(r->_page) + r->_offset); |
279 | } | |
280 | ||
281 | static inline int rxb_offset(struct iwl_rx_cmd_buffer *r) | |
282 | { | |
283 | return r->_offset; | |
930dfd5f JB |
284 | } |
285 | ||
286 | static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r) | |
287 | { | |
0c19744c JB |
288 | r->_page_stolen = true; |
289 | get_page(r->_page); | |
290 | return r->_page; | |
930dfd5f JB |
291 | } |
292 | ||
d13f1862 EG |
293 | static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r) |
294 | { | |
295 | __free_pages(r->_page, r->_rx_page_order); | |
296 | } | |
297 | ||
d663ee73 JB |
298 | #define MAX_NO_RECLAIM_CMDS 6 |
299 | ||
ff110c8f GG |
300 | #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo)))) |
301 | ||
9eae88fa JB |
302 | /* |
303 | * Maximum number of HW queues the transport layer | |
304 | * currently supports | |
305 | */ | |
306 | #define IWL_MAX_HW_QUEUES 32 | |
b04db9ac EG |
307 | #define IWL_MAX_TID_COUNT 8 |
308 | #define IWL_FRAME_LIMIT 64 | |
9eae88fa | 309 | |
ddaf5a5b JB |
310 | /** |
311 | * enum iwl_wowlan_status - WoWLAN image/device status | |
312 | * @IWL_D3_STATUS_ALIVE: firmware is still running after resume | |
313 | * @IWL_D3_STATUS_RESET: device was reset while suspended | |
314 | */ | |
315 | enum iwl_d3_status { | |
316 | IWL_D3_STATUS_ALIVE, | |
317 | IWL_D3_STATUS_RESET, | |
318 | }; | |
319 | ||
eb7ff77e AN |
320 | /** |
321 | * enum iwl_trans_status: transport status flags | |
322 | * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed | |
323 | * @STATUS_DEVICE_ENABLED: APM is enabled | |
324 | * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up) | |
325 | * @STATUS_INT_ENABLED: interrupts are enabled | |
326 | * @STATUS_RFKILL: the HW RFkill switch is in KILL position | |
327 | * @STATUS_FW_ERROR: the fw is in error state | |
328 | */ | |
329 | enum iwl_trans_status { | |
330 | STATUS_SYNC_HCMD_ACTIVE, | |
331 | STATUS_DEVICE_ENABLED, | |
332 | STATUS_TPOWER_PMI, | |
333 | STATUS_INT_ENABLED, | |
334 | STATUS_RFKILL, | |
335 | STATUS_FW_ERROR, | |
336 | }; | |
337 | ||
92d743ae MV |
338 | /** |
339 | * struct iwl_trans_config - transport configuration | |
340 | * | |
341 | * @op_mode: pointer to the upper layer. | |
c6f600fc MV |
342 | * @cmd_queue: the index of the command queue. |
343 | * Must be set before start_fw. | |
b04db9ac | 344 | * @cmd_fifo: the fifo for host commands |
d663ee73 JB |
345 | * @no_reclaim_cmds: Some devices erroneously don't set the |
346 | * SEQ_RX_FRAME bit on some notifications, this is the | |
347 | * list of such notifications to filter. Max length is | |
348 | * %MAX_NO_RECLAIM_CMDS. | |
349 | * @n_no_reclaim_cmds: # of commands in list | |
b2cf410c JB |
350 | * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs, |
351 | * if unset 4k will be the RX buffer size | |
046db346 EG |
352 | * @bc_table_dword: set to true if the BC table expects the byte count to be |
353 | * in DWORD (as opposed to bytes) | |
7c5ba4a8 JB |
354 | * @queue_watchdog_timeout: time (in ms) after which queues |
355 | * are considered stuck and will trigger device restart | |
d9fb6465 JB |
356 | * @command_names: array of command names, must be 256 entries |
357 | * (one for each command); for debugging only | |
92d743ae MV |
358 | */ |
359 | struct iwl_trans_config { | |
360 | struct iwl_op_mode *op_mode; | |
9eae88fa | 361 | |
c6f600fc | 362 | u8 cmd_queue; |
b04db9ac | 363 | u8 cmd_fifo; |
d663ee73 | 364 | const u8 *no_reclaim_cmds; |
84cf0e62 | 365 | unsigned int n_no_reclaim_cmds; |
b2cf410c JB |
366 | |
367 | bool rx_buf_size_8k; | |
046db346 | 368 | bool bc_table_dword; |
7c5ba4a8 | 369 | unsigned int queue_watchdog_timeout; |
d9fb6465 | 370 | const char **command_names; |
92d743ae MV |
371 | }; |
372 | ||
87ce05a2 EG |
373 | struct iwl_trans; |
374 | ||
41c50542 EG |
375 | /** |
376 | * struct iwl_trans_ops - transport specific operations | |
60396183 EG |
377 | * |
378 | * All the handlers MUST be implemented | |
379 | * | |
57a1dc89 | 380 | * @start_hw: starts the HW- from that point on, the HW can send interrupts |
60396183 | 381 | * May sleep |
a4082843 | 382 | * @op_mode_leave: Turn off the HW RF kill indication if on |
60396183 | 383 | * May sleep |
cf614297 | 384 | * @start_fw: allocates and inits all the resources for the transport |
60396183 EG |
385 | * layer. Also kick a fw image. |
386 | * May sleep | |
adca1235 EG |
387 | * @fw_alive: called when the fw sends alive notification. If the fw provides |
388 | * the SCD base address in SRAM, then provide it here, or 0 otherwise. | |
60396183 | 389 | * May sleep |
a4082843 AN |
390 | * @stop_device: stops the whole device (embedded CPU put to reset) and stops |
391 | * the HW. From that point on, the HW will be in low power but will still | |
392 | * issue interrupt if the HW RF kill is triggered. This callback must do | |
393 | * the right thing and not crash even if start_hw() was called but not | |
394 | * start_fw(). May sleep | |
ddaf5a5b | 395 | * @d3_suspend: put the device into the correct mode for WoWLAN during |
2dd4f9f7 JB |
396 | * suspend. This is optional, if not implemented WoWLAN will not be |
397 | * supported. This callback may sleep. | |
ddaf5a5b JB |
398 | * @d3_resume: resume the device after WoWLAN, enabling the opmode to |
399 | * talk to the WoWLAN image to get its status. This is optional, if not | |
400 | * implemented WoWLAN will not be supported. This callback may sleep. | |
f946b529 EG |
401 | * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted. |
402 | * If RFkill is asserted in the middle of a SYNC host command, it must | |
403 | * return -ERFKILL straight away. | |
60396183 | 404 | * May sleep only if CMD_SYNC is set |
41c50542 | 405 | * @tx: send an skb |
60396183 | 406 | * Must be atomic |
a0eaad71 | 407 | * @reclaim: free packet until ssn. Returns a list of freed packets. |
60396183 | 408 | * Must be atomic |
b04db9ac EG |
409 | * @txq_enable: setup a queue. To setup an AC queue, use the |
410 | * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before | |
411 | * this one. The op_mode must not configure the HCMD queue. May sleep. | |
d0624be6 | 412 | * @txq_disable: de-configure a Tx queue to send AMPDUs |
b0b46192 | 413 | * Must be atomic |
5f178cd2 | 414 | * @wait_tx_queue_empty: wait until all tx queues are empty |
60396183 | 415 | * May sleep |
87e5666c EG |
416 | * @dbgfs_register: add the dbgfs files under this directory. Files will be |
417 | * automatically deleted. | |
03905495 EG |
418 | * @write8: write a u8 to a register at offset ofs from the BAR |
419 | * @write32: write a u32 to a register at offset ofs from the BAR | |
420 | * @read32: read a u32 register at offset ofs from the BAR | |
6a06b6c1 EG |
421 | * @read_prph: read a DWORD from a periphery register |
422 | * @write_prph: write a DWORD to a periphery register | |
4fd442db | 423 | * @read_mem: read device's SRAM in DWORD |
01387ffd EG |
424 | * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory |
425 | * will be zeroed. | |
c6f600fc | 426 | * @configure: configure parameters required by the transport layer from |
3dc420be EG |
427 | * the op_mode. May be called several times before start_fw, can't be |
428 | * called after that. | |
47107e84 | 429 | * @set_pmi: set the power pmi state |
e56b04ef LE |
430 | * @grab_nic_access: wake the NIC to be able to access non-HBUS regs. |
431 | * Sleeping is not allowed between grab_nic_access and | |
432 | * release_nic_access. | |
433 | * @release_nic_access: let the NIC go to sleep. The "flags" parameter | |
434 | * must be the same one that was sent before to the grab_nic_access. | |
e139dc4a | 435 | * @set_bits_mask - set SRAM register according to value and mask. |
41c50542 EG |
436 | */ |
437 | struct iwl_trans_ops { | |
438 | ||
57a1dc89 | 439 | int (*start_hw)(struct iwl_trans *iwl_trans); |
a4082843 | 440 | void (*op_mode_leave)(struct iwl_trans *iwl_trans); |
6ae02f3e EG |
441 | int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw, |
442 | bool run_in_rfkill); | |
adca1235 | 443 | void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr); |
6d8f6eeb | 444 | void (*stop_device)(struct iwl_trans *trans); |
41c50542 | 445 | |
debff618 JB |
446 | void (*d3_suspend)(struct iwl_trans *trans, bool test); |
447 | int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status, | |
448 | bool test); | |
2dd4f9f7 | 449 | |
6d8f6eeb | 450 | int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd); |
41c50542 | 451 | |
e13c0c59 | 452 | int (*tx)(struct iwl_trans *trans, struct sk_buff *skb, |
9eae88fa JB |
453 | struct iwl_device_cmd *dev_cmd, int queue); |
454 | void (*reclaim)(struct iwl_trans *trans, int queue, int ssn, | |
455 | struct sk_buff_head *skbs); | |
456 | ||
4beaf6c2 EG |
457 | void (*txq_enable)(struct iwl_trans *trans, int queue, int fifo, |
458 | int sta_id, int tid, int frame_limit, u16 ssn); | |
d0624be6 | 459 | void (*txq_disable)(struct iwl_trans *trans, int queue); |
41c50542 | 460 | |
87e5666c | 461 | int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir); |
5f178cd2 | 462 | int (*wait_tx_queue_empty)(struct iwl_trans *trans); |
5fdda047 | 463 | |
03905495 EG |
464 | void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val); |
465 | void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val); | |
466 | u32 (*read32)(struct iwl_trans *trans, u32 ofs); | |
6a06b6c1 EG |
467 | u32 (*read_prph)(struct iwl_trans *trans, u32 ofs); |
468 | void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val); | |
4fd442db EG |
469 | int (*read_mem)(struct iwl_trans *trans, u32 addr, |
470 | void *buf, int dwords); | |
471 | int (*write_mem)(struct iwl_trans *trans, u32 addr, | |
bf0fd5da | 472 | const void *buf, int dwords); |
c6f600fc MV |
473 | void (*configure)(struct iwl_trans *trans, |
474 | const struct iwl_trans_config *trans_cfg); | |
47107e84 | 475 | void (*set_pmi)(struct iwl_trans *trans, bool state); |
e56b04ef LE |
476 | bool (*grab_nic_access)(struct iwl_trans *trans, bool silent, |
477 | unsigned long *flags); | |
478 | void (*release_nic_access)(struct iwl_trans *trans, | |
479 | unsigned long *flags); | |
e139dc4a LE |
480 | void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask, |
481 | u32 value); | |
41c50542 EG |
482 | }; |
483 | ||
69655ebf EG |
484 | /** |
485 | * enum iwl_trans_state - state of the transport layer | |
486 | * | |
487 | * @IWL_TRANS_NO_FW: no fw has sent an alive response | |
488 | * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response | |
489 | */ | |
490 | enum iwl_trans_state { | |
491 | IWL_TRANS_NO_FW = 0, | |
492 | IWL_TRANS_FW_ALIVE = 1, | |
493 | }; | |
494 | ||
6fbfae8e EG |
495 | /** |
496 | * struct iwl_trans - transport common data | |
60396183 | 497 | * |
6fbfae8e | 498 | * @ops - pointer to iwl_trans_ops |
ed277c93 | 499 | * @op_mode - pointer to the op_mode |
035f7ff2 | 500 | * @cfg - pointer to the configuration |
eb7ff77e | 501 | * @status: a bit-mask of transport status flags |
a42a1844 | 502 | * @dev - pointer to struct device * that represents the device |
99673ee5 | 503 | * @hw_id: a u32 with the ID of the device / subdevice. |
60396183 | 504 | * Set during transport allocation. |
9ca85961 | 505 | * @hw_id_str: a string with info about HW ID. Set during transport allocation. |
f6d0e9be | 506 | * @pm_support: set to true in start_hw if link pm is supported |
59c647b6 EG |
507 | * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only. |
508 | * The user should use iwl_trans_{alloc,free}_tx_cmd. | |
509 | * @dev_cmd_headroom: room needed for the transport's private use before the | |
510 | * device_cmd for Tx - for internal use only | |
511 | * The user should use iwl_trans_{alloc,free}_tx_cmd. | |
f042c2eb JB |
512 | * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before |
513 | * starting the firmware, used for tracing | |
514 | * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the | |
515 | * start of the 802.11 header in the @rx_mpdu_cmd | |
6fbfae8e | 516 | */ |
41c50542 EG |
517 | struct iwl_trans { |
518 | const struct iwl_trans_ops *ops; | |
ed277c93 | 519 | struct iwl_op_mode *op_mode; |
035f7ff2 | 520 | const struct iwl_cfg *cfg; |
69655ebf | 521 | enum iwl_trans_state state; |
eb7ff77e | 522 | unsigned long status; |
e6bb4c9c | 523 | |
a42a1844 | 524 | struct device *dev; |
08079a49 | 525 | u32 hw_rev; |
99673ee5 | 526 | u32 hw_id; |
9ca85961 | 527 | char hw_id_str[52]; |
a42a1844 | 528 | |
f042c2eb JB |
529 | u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size; |
530 | ||
f6d0e9be | 531 | bool pm_support; |
97b52cfd | 532 | |
59c647b6 EG |
533 | /* The following fields are internal only */ |
534 | struct kmem_cache *dev_cmd_pool; | |
535 | size_t dev_cmd_headroom; | |
3ec45882 | 536 | char dev_cmd_pool_name[50]; |
59c647b6 | 537 | |
9da987ac MV |
538 | struct dentry *dbgfs_dir; |
539 | ||
2bfb5092 JB |
540 | #ifdef CONFIG_LOCKDEP |
541 | struct lockdep_map sync_cmd_lockdep_map; | |
542 | #endif | |
543 | ||
e6bb4c9c EG |
544 | /* pointer to trans specific struct */ |
545 | /*Ensure that this pointer will always be aligned to sizeof pointer */ | |
cbe6ab4e | 546 | char trans_specific[0] __aligned(sizeof(void *)); |
41c50542 EG |
547 | }; |
548 | ||
ed277c93 | 549 | static inline void iwl_trans_configure(struct iwl_trans *trans, |
92d743ae | 550 | const struct iwl_trans_config *trans_cfg) |
ed277c93 | 551 | { |
92d743ae | 552 | trans->op_mode = trans_cfg->op_mode; |
c6f600fc MV |
553 | |
554 | trans->ops->configure(trans, trans_cfg); | |
ed277c93 EG |
555 | } |
556 | ||
57a1dc89 | 557 | static inline int iwl_trans_start_hw(struct iwl_trans *trans) |
e6bb4c9c | 558 | { |
60396183 EG |
559 | might_sleep(); |
560 | ||
57a1dc89 | 561 | return trans->ops->start_hw(trans); |
e6bb4c9c EG |
562 | } |
563 | ||
a4082843 | 564 | static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans) |
cc56feb2 | 565 | { |
60396183 EG |
566 | might_sleep(); |
567 | ||
a4082843 AN |
568 | if (trans->ops->op_mode_leave) |
569 | trans->ops->op_mode_leave(trans); | |
69655ebf | 570 | |
a4082843 | 571 | trans->op_mode = NULL; |
b4991f3f | 572 | |
69655ebf | 573 | trans->state = IWL_TRANS_NO_FW; |
cc56feb2 EG |
574 | } |
575 | ||
adca1235 | 576 | static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr) |
ed6a3803 | 577 | { |
60396183 EG |
578 | might_sleep(); |
579 | ||
69655ebf | 580 | trans->state = IWL_TRANS_FW_ALIVE; |
b04db9ac | 581 | |
adca1235 | 582 | trans->ops->fw_alive(trans, scd_addr); |
ed6a3803 EG |
583 | } |
584 | ||
0692fe41 | 585 | static inline int iwl_trans_start_fw(struct iwl_trans *trans, |
6ae02f3e EG |
586 | const struct fw_img *fw, |
587 | bool run_in_rfkill) | |
bdfbf092 | 588 | { |
cf614297 EG |
589 | might_sleep(); |
590 | ||
f042c2eb JB |
591 | WARN_ON_ONCE(!trans->rx_mpdu_cmd); |
592 | ||
efbf6e3b | 593 | clear_bit(STATUS_FW_ERROR, &trans->status); |
6ae02f3e | 594 | return trans->ops->start_fw(trans, fw, run_in_rfkill); |
bdfbf092 EG |
595 | } |
596 | ||
e6bb4c9c | 597 | static inline void iwl_trans_stop_device(struct iwl_trans *trans) |
bdfbf092 | 598 | { |
60396183 EG |
599 | might_sleep(); |
600 | ||
6d8f6eeb | 601 | trans->ops->stop_device(trans); |
69655ebf EG |
602 | |
603 | trans->state = IWL_TRANS_NO_FW; | |
bdfbf092 EG |
604 | } |
605 | ||
debff618 | 606 | static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test) |
ddaf5a5b JB |
607 | { |
608 | might_sleep(); | |
debff618 | 609 | trans->ops->d3_suspend(trans, test); |
ddaf5a5b JB |
610 | } |
611 | ||
612 | static inline int iwl_trans_d3_resume(struct iwl_trans *trans, | |
debff618 JB |
613 | enum iwl_d3_status *status, |
614 | bool test) | |
2dd4f9f7 JB |
615 | { |
616 | might_sleep(); | |
debff618 | 617 | return trans->ops->d3_resume(trans, status, test); |
2dd4f9f7 JB |
618 | } |
619 | ||
e6bb4c9c | 620 | static inline int iwl_trans_send_cmd(struct iwl_trans *trans, |
2bfb5092 | 621 | struct iwl_host_cmd *cmd) |
bdfbf092 | 622 | { |
2bfb5092 JB |
623 | int ret; |
624 | ||
fba1c627 EG |
625 | if (unlikely(!(cmd->flags & CMD_SEND_IN_RFKILL) && |
626 | test_bit(STATUS_RFKILL, &trans->status))) | |
627 | return -ERFKILL; | |
628 | ||
3fc07953 AN |
629 | if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status))) |
630 | return -EIO; | |
631 | ||
f39a52bf | 632 | if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) { |
8ca95995 EG |
633 | IWL_ERR(trans, "%s bad state = %d", __func__, trans->state); |
634 | return -EIO; | |
635 | } | |
69655ebf | 636 | |
2bfb5092 JB |
637 | if (!(cmd->flags & CMD_ASYNC)) |
638 | lock_map_acquire_read(&trans->sync_cmd_lockdep_map); | |
639 | ||
640 | ret = trans->ops->send_cmd(trans, cmd); | |
641 | ||
642 | if (!(cmd->flags & CMD_ASYNC)) | |
643 | lock_map_release(&trans->sync_cmd_lockdep_map); | |
644 | ||
645 | return ret; | |
bdfbf092 EG |
646 | } |
647 | ||
59c647b6 EG |
648 | static inline struct iwl_device_cmd * |
649 | iwl_trans_alloc_tx_cmd(struct iwl_trans *trans) | |
650 | { | |
651 | u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC); | |
652 | ||
653 | if (unlikely(dev_cmd_ptr == NULL)) | |
654 | return NULL; | |
655 | ||
656 | return (struct iwl_device_cmd *) | |
657 | (dev_cmd_ptr + trans->dev_cmd_headroom); | |
658 | } | |
659 | ||
660 | static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans, | |
661 | struct iwl_device_cmd *dev_cmd) | |
662 | { | |
663 | u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom; | |
664 | ||
665 | kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr); | |
666 | } | |
667 | ||
e6bb4c9c | 668 | static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb, |
9eae88fa | 669 | struct iwl_device_cmd *dev_cmd, int queue) |
a0eaad71 | 670 | { |
3fc07953 AN |
671 | if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status))) |
672 | return -EIO; | |
673 | ||
f39a52bf SG |
674 | if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) |
675 | IWL_ERR(trans, "%s bad state = %d", __func__, trans->state); | |
69655ebf | 676 | |
9eae88fa | 677 | return trans->ops->tx(trans, skb, dev_cmd, queue); |
a0eaad71 EG |
678 | } |
679 | ||
9eae88fa JB |
680 | static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue, |
681 | int ssn, struct sk_buff_head *skbs) | |
48d42c42 | 682 | { |
f39a52bf SG |
683 | if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) |
684 | IWL_ERR(trans, "%s bad state = %d", __func__, trans->state); | |
69655ebf | 685 | |
9eae88fa | 686 | trans->ops->reclaim(trans, queue, ssn, skbs); |
48d42c42 EG |
687 | } |
688 | ||
d0624be6 | 689 | static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue) |
288712a6 | 690 | { |
d0624be6 | 691 | trans->ops->txq_disable(trans, queue); |
288712a6 EG |
692 | } |
693 | ||
4beaf6c2 EG |
694 | static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue, |
695 | int fifo, int sta_id, int tid, | |
696 | int frame_limit, u16 ssn) | |
48d42c42 | 697 | { |
60396183 EG |
698 | might_sleep(); |
699 | ||
f39a52bf SG |
700 | if (unlikely((trans->state != IWL_TRANS_FW_ALIVE))) |
701 | IWL_ERR(trans, "%s bad state = %d", __func__, trans->state); | |
69655ebf | 702 | |
4beaf6c2 | 703 | trans->ops->txq_enable(trans, queue, fifo, sta_id, tid, |
9eae88fa | 704 | frame_limit, ssn); |
48d42c42 EG |
705 | } |
706 | ||
b04db9ac EG |
707 | static inline void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, |
708 | int fifo) | |
709 | { | |
881acd89 | 710 | iwl_trans_txq_enable(trans, queue, fifo, -1, |
b04db9ac EG |
711 | IWL_MAX_TID_COUNT, IWL_FRAME_LIMIT, 0); |
712 | } | |
713 | ||
5f178cd2 EG |
714 | static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans) |
715 | { | |
f39a52bf SG |
716 | if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) |
717 | IWL_ERR(trans, "%s bad state = %d", __func__, trans->state); | |
69655ebf | 718 | |
5f178cd2 EG |
719 | return trans->ops->wait_tx_queue_empty(trans); |
720 | } | |
721 | ||
87e5666c | 722 | static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans, |
4fd442db | 723 | struct dentry *dir) |
87e5666c EG |
724 | { |
725 | return trans->ops->dbgfs_register(trans, dir); | |
726 | } | |
727 | ||
03905495 EG |
728 | static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val) |
729 | { | |
730 | trans->ops->write8(trans, ofs, val); | |
731 | } | |
732 | ||
733 | static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val) | |
734 | { | |
735 | trans->ops->write32(trans, ofs, val); | |
736 | } | |
737 | ||
738 | static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs) | |
739 | { | |
740 | return trans->ops->read32(trans, ofs); | |
741 | } | |
742 | ||
6a06b6c1 EG |
743 | static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs) |
744 | { | |
745 | return trans->ops->read_prph(trans, ofs); | |
746 | } | |
747 | ||
748 | static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs, | |
749 | u32 val) | |
750 | { | |
751 | return trans->ops->write_prph(trans, ofs, val); | |
752 | } | |
753 | ||
4fd442db EG |
754 | static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr, |
755 | void *buf, int dwords) | |
756 | { | |
757 | return trans->ops->read_mem(trans, addr, buf, dwords); | |
758 | } | |
759 | ||
760 | #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \ | |
761 | do { \ | |
762 | if (__builtin_constant_p(bufsize)) \ | |
763 | BUILD_BUG_ON((bufsize) % sizeof(u32)); \ | |
764 | iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\ | |
765 | } while (0) | |
766 | ||
767 | static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr) | |
768 | { | |
769 | u32 value; | |
770 | ||
771 | if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1))) | |
772 | return 0xa5a5a5a5; | |
773 | ||
774 | return value; | |
775 | } | |
776 | ||
777 | static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr, | |
bf0fd5da | 778 | const void *buf, int dwords) |
4fd442db EG |
779 | { |
780 | return trans->ops->write_mem(trans, addr, buf, dwords); | |
781 | } | |
782 | ||
783 | static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr, | |
784 | u32 val) | |
785 | { | |
786 | return iwl_trans_write_mem(trans, addr, &val, 1); | |
787 | } | |
788 | ||
47107e84 DF |
789 | static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state) |
790 | { | |
128cb89e AN |
791 | if (trans->ops->set_pmi) |
792 | trans->ops->set_pmi(trans, state); | |
47107e84 DF |
793 | } |
794 | ||
e139dc4a LE |
795 | static inline void |
796 | iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value) | |
797 | { | |
798 | trans->ops->set_bits_mask(trans, reg, mask, value); | |
799 | } | |
800 | ||
e56b04ef | 801 | #define iwl_trans_grab_nic_access(trans, silent, flags) \ |
abae2386 | 802 | __cond_lock(nic_access, \ |
e56b04ef | 803 | likely((trans)->ops->grab_nic_access(trans, silent, flags))) |
7a65d170 | 804 | |
abae2386 | 805 | static inline void __releases(nic_access) |
e56b04ef | 806 | iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags) |
7a65d170 | 807 | { |
e56b04ef | 808 | trans->ops->release_nic_access(trans, flags); |
abae2386 | 809 | __release(nic_access); |
7a65d170 EG |
810 | } |
811 | ||
2a988e98 AN |
812 | static inline void iwl_trans_fw_error(struct iwl_trans *trans) |
813 | { | |
814 | if (WARN_ON_ONCE(!trans->op_mode)) | |
815 | return; | |
816 | ||
817 | /* prevent double restarts due to the same erroneous FW */ | |
818 | if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status)) | |
819 | iwl_op_mode_nic_error(trans->op_mode); | |
820 | } | |
821 | ||
b52e7ea1 | 822 | /***************************************************** |
d1ff5253 | 823 | * driver (transport) register/unregister functions |
b52e7ea1 | 824 | ******************************************************/ |
36a79223 EG |
825 | int __must_check iwl_pci_register_driver(void); |
826 | void iwl_pci_unregister_driver(void); | |
b52e7ea1 | 827 | |
2bfb5092 JB |
828 | static inline void trans_lockdep_init(struct iwl_trans *trans) |
829 | { | |
830 | #ifdef CONFIG_LOCKDEP | |
831 | static struct lock_class_key __key; | |
832 | ||
833 | lockdep_init_map(&trans->sync_cmd_lockdep_map, "sync_cmd_lockdep_map", | |
834 | &__key, 0); | |
835 | #endif | |
836 | } | |
837 | ||
41c50542 | 838 | #endif /* __iwl_trans_h__ */ |