1 /******************************************************************************
2 *
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
5 *
6 * GPL LICENSE SUMMARY
7 *
8 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
22 * USA
23 *
24 * The full GNU General Public License is included in this distribution
25 * in the file called COPYING.
26 *
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30 *
31 * BSD LICENSE
32 *
33 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 *
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
45 * distribution.
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 *
62 *****************************************************************************/
63 #ifndef __iwl_trans_h__
64 #define __iwl_trans_h__
65
66 #include <linux/ieee80211.h>
67 #include <linux/mm.h> /* for page_address */
68 #include <linux/lockdep.h>
69
70 #include "iwl-debug.h"
71 #include "iwl-config.h"
72 #include "iwl-fw.h"
73
74 /**
75 * DOC: Transport layer - what is it ?
76 *
77 * The tranport layer is the layer that deals with the HW directly. It provides
78 * an abstraction of the underlying HW to the upper layer. The transport layer
79 * doesn't provide any policy, algorithm or anything of this kind, but only
80 * mechanisms to make the HW do something.It is not completely stateless but
81 * close to it.
82 * We will have an implementation for each different supported bus.
83 */
84
85 /**
86 * DOC: Life cycle of the transport layer
87 *
88 * The transport layer has a very precise life cycle.
89 *
90 * 1) A helper function is called during the module initialization and
91 * registers the bus driver's ops with the transport's alloc function.
92 * 2) Bus's probe calls to the transport layer's allocation functions.
93 * Of course this function is bus specific.
94 * 3) This allocation functions will spawn the upper layer which will
95 * register mac80211.
96 *
97 * 4) At some point (i.e. mac80211's start call), the op_mode will call
98 * the following sequence:
99 * start_hw
100 * start_fw
101 *
102 * 5) Then when finished (or reset):
103 * stop_fw (a.k.a. stop device for the moment)
104 * stop_hw
105 *
106 * 6) Eventually, the free function will be called.
107 */
108
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 */
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
155 /* iwl_cmd_header flags value */
156 #define IWL_CMD_FAILED_MSK 0x40
157
158
159 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
160 #define FH_RSCSR_FRAME_INVALID 0x55550000
161 #define FH_RSCSR_FRAME_ALIGN 0x40
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;
178
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
183 * @CMD_ASYNC: Return right away and don't want for the response
184 * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
185 * response. The caller needs to call iwl_free_resp when done.
186 * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
187 */
188 enum CMD_MODE {
189 CMD_SYNC = 0,
190 CMD_ASYNC = BIT(0),
191 CMD_WANT_SKB = BIT(1),
192 CMD_ON_DEMAND = BIT(2),
193 };
194
195 #define DEF_CMD_PAYLOAD_SIZE 320
196
197 /**
198 * struct iwl_device_cmd
199 *
200 * For allocation of the command and tx queues, this establishes the overall
201 * size of the largest command we send to uCode, except for commands that
202 * aren't fully copied and use other TFD space.
203 */
204 struct iwl_device_cmd {
205 struct iwl_cmd_header hdr; /* uCode API */
206 u8 payload[DEF_CMD_PAYLOAD_SIZE];
207 } __packed;
208
209 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
210
211 /*
212 * number of transfer buffers (fragments) per transmit frame descriptor;
213 * this is just the driver's idea, the hardware supports 20
214 */
215 #define IWL_MAX_CMD_TBS_PER_TFD 2
216
217 /**
218 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
219 *
220 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
221 * ring. The transport layer doesn't map the command's buffer to DMA, but
222 * rather copies it to an previously allocated DMA buffer. This flag tells
223 * the transport layer not to copy the command, but to map the existing
224 * buffer (that is passed in) instead. This saves the memcpy and allows
225 * commands that are bigger than the fixed buffer to be submitted.
226 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
227 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
228 * chunk internally and free it again after the command completes. This
229 * can (currently) be used only once per command.
230 * Note that a TFD entry after a DUP one cannot be a normal copied one.
231 */
232 enum iwl_hcmd_dataflag {
233 IWL_HCMD_DFL_NOCOPY = BIT(0),
234 IWL_HCMD_DFL_DUP = BIT(1),
235 };
236
237 /**
238 * struct iwl_host_cmd - Host command to the uCode
239 *
240 * @data: array of chunks that composes the data of the host command
241 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
242 * @_rx_page_order: (internally used to free response packet)
243 * @_rx_page_addr: (internally used to free response packet)
244 * @handler_status: return value of the handler of the command
245 * (put in setup_rx_handlers) - valid for SYNC mode only
246 * @flags: can be CMD_*
247 * @len: array of the lenths of the chunks in data
248 * @dataflags: IWL_HCMD_DFL_*
249 * @id: id of the host command
250 */
251 struct iwl_host_cmd {
252 const void *data[IWL_MAX_CMD_TBS_PER_TFD];
253 struct iwl_rx_packet *resp_pkt;
254 unsigned long _rx_page_addr;
255 u32 _rx_page_order;
256 int handler_status;
257
258 u32 flags;
259 u16 len[IWL_MAX_CMD_TBS_PER_TFD];
260 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
261 u8 id;
262 };
263
iwl_free_resp(struct iwl_host_cmd * cmd)264 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
265 {
266 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
267 }
268
269 struct iwl_rx_cmd_buffer {
270 struct page *_page;
271 int _offset;
272 bool _page_stolen;
273 u32 _rx_page_order;
274 unsigned int truesize;
275 };
276
rxb_addr(struct iwl_rx_cmd_buffer * r)277 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
278 {
279 return (void *)((unsigned long)page_address(r->_page) + r->_offset);
280 }
281
rxb_offset(struct iwl_rx_cmd_buffer * r)282 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
283 {
284 return r->_offset;
285 }
286
rxb_steal_page(struct iwl_rx_cmd_buffer * r)287 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
288 {
289 r->_page_stolen = true;
290 get_page(r->_page);
291 return r->_page;
292 }
293
iwl_free_rxb(struct iwl_rx_cmd_buffer * r)294 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
295 {
296 __free_pages(r->_page, r->_rx_page_order);
297 }
298
299 #define MAX_NO_RECLAIM_CMDS 6
300
301 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
302
303 /*
304 * Maximum number of HW queues the transport layer
305 * currently supports
306 */
307 #define IWL_MAX_HW_QUEUES 32
308 #define IWL_MAX_TID_COUNT 8
309 #define IWL_FRAME_LIMIT 64
310
311 /**
312 * enum iwl_wowlan_status - WoWLAN image/device status
313 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
314 * @IWL_D3_STATUS_RESET: device was reset while suspended
315 */
316 enum iwl_d3_status {
317 IWL_D3_STATUS_ALIVE,
318 IWL_D3_STATUS_RESET,
319 };
320
321 /**
322 * struct iwl_trans_config - transport configuration
323 *
324 * @op_mode: pointer to the upper layer.
325 * @cmd_queue: the index of the command queue.
326 * Must be set before start_fw.
327 * @cmd_fifo: the fifo for host commands
328 * @no_reclaim_cmds: Some devices erroneously don't set the
329 * SEQ_RX_FRAME bit on some notifications, this is the
330 * list of such notifications to filter. Max length is
331 * %MAX_NO_RECLAIM_CMDS.
332 * @n_no_reclaim_cmds: # of commands in list
333 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
334 * if unset 4k will be the RX buffer size
335 * @bc_table_dword: set to true if the BC table expects the byte count to be
336 * in DWORD (as opposed to bytes)
337 * @queue_watchdog_timeout: time (in ms) after which queues
338 * are considered stuck and will trigger device restart
339 * @command_names: array of command names, must be 256 entries
340 * (one for each command); for debugging only
341 */
342 struct iwl_trans_config {
343 struct iwl_op_mode *op_mode;
344
345 u8 cmd_queue;
346 u8 cmd_fifo;
347 const u8 *no_reclaim_cmds;
348 int n_no_reclaim_cmds;
349
350 bool rx_buf_size_8k;
351 bool bc_table_dword;
352 unsigned int queue_watchdog_timeout;
353 const char **command_names;
354 };
355
356 struct iwl_trans;
357
358 /**
359 * struct iwl_trans_ops - transport specific operations
360 *
361 * All the handlers MUST be implemented
362 *
363 * @start_hw: starts the HW- from that point on, the HW can send interrupts
364 * May sleep
365 * @stop_hw: stops the HW- from that point on, the HW will be in low power but
366 * will still issue interrupt if the HW RF kill is triggered unless
367 * op_mode_leaving is true.
368 * May sleep
369 * @start_fw: allocates and inits all the resources for the transport
370 * layer. Also kick a fw image.
371 * May sleep
372 * @fw_alive: called when the fw sends alive notification. If the fw provides
373 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
374 * May sleep
375 * @stop_device:stops the whole device (embedded CPU put to reset)
376 * May sleep
377 * @d3_suspend: put the device into the correct mode for WoWLAN during
378 * suspend. This is optional, if not implemented WoWLAN will not be
379 * supported. This callback may sleep.
380 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
381 * talk to the WoWLAN image to get its status. This is optional, if not
382 * implemented WoWLAN will not be supported. This callback may sleep.
383 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
384 * If RFkill is asserted in the middle of a SYNC host command, it must
385 * return -ERFKILL straight away.
386 * May sleep only if CMD_SYNC is set
387 * @tx: send an skb
388 * Must be atomic
389 * @reclaim: free packet until ssn. Returns a list of freed packets.
390 * Must be atomic
391 * @txq_enable: setup a queue. To setup an AC queue, use the
392 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
393 * this one. The op_mode must not configure the HCMD queue. May sleep.
394 * @txq_disable: de-configure a Tx queue to send AMPDUs
395 * Must be atomic
396 * @wait_tx_queue_empty: wait until all tx queues are empty
397 * May sleep
398 * @dbgfs_register: add the dbgfs files under this directory. Files will be
399 * automatically deleted.
400 * @suspend: stop the device unless WoWLAN is configured
401 * @resume: resume activity of the device
402 * @write8: write a u8 to a register at offset ofs from the BAR
403 * @write32: write a u32 to a register at offset ofs from the BAR
404 * @read32: read a u32 register at offset ofs from the BAR
405 * @read_prph: read a DWORD from a periphery register
406 * @write_prph: write a DWORD to a periphery register
407 * @read_mem: read device's SRAM in DWORD
408 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
409 * will be zeroed.
410 * @configure: configure parameters required by the transport layer from
411 * the op_mode. May be called several times before start_fw, can't be
412 * called after that.
413 * @set_pmi: set the power pmi state
414 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
415 * Sleeping is not allowed between grab_nic_access and
416 * release_nic_access.
417 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
418 * must be the same one that was sent before to the grab_nic_access.
419 * @set_bits_mask - set SRAM register according to value and mask.
420 */
421 struct iwl_trans_ops {
422
423 int (*start_hw)(struct iwl_trans *iwl_trans);
424 void (*stop_hw)(struct iwl_trans *iwl_trans, bool op_mode_leaving);
425 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
426 bool run_in_rfkill);
427 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
428 void (*stop_device)(struct iwl_trans *trans);
429
430 void (*d3_suspend)(struct iwl_trans *trans);
431 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status);
432
433 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
434
435 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
436 struct iwl_device_cmd *dev_cmd, int queue);
437 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
438 struct sk_buff_head *skbs);
439
440 void (*txq_enable)(struct iwl_trans *trans, int queue, int fifo,
441 int sta_id, int tid, int frame_limit, u16 ssn);
442 void (*txq_disable)(struct iwl_trans *trans, int queue);
443
444 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
445 int (*wait_tx_queue_empty)(struct iwl_trans *trans);
446 #ifdef CONFIG_PM_SLEEP
447 int (*suspend)(struct iwl_trans *trans);
448 int (*resume)(struct iwl_trans *trans);
449 #endif
450 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
451 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
452 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
453 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
454 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
455 int (*read_mem)(struct iwl_trans *trans, u32 addr,
456 void *buf, int dwords);
457 int (*write_mem)(struct iwl_trans *trans, u32 addr,
458 void *buf, int dwords);
459 void (*configure)(struct iwl_trans *trans,
460 const struct iwl_trans_config *trans_cfg);
461 void (*set_pmi)(struct iwl_trans *trans, bool state);
462 bool (*grab_nic_access)(struct iwl_trans *trans, bool silent,
463 unsigned long *flags);
464 void (*release_nic_access)(struct iwl_trans *trans,
465 unsigned long *flags);
466 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
467 u32 value);
468 };
469
470 /**
471 * enum iwl_trans_state - state of the transport layer
472 *
473 * @IWL_TRANS_NO_FW: no fw has sent an alive response
474 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
475 */
476 enum iwl_trans_state {
477 IWL_TRANS_NO_FW = 0,
478 IWL_TRANS_FW_ALIVE = 1,
479 };
480
481 /**
482 * struct iwl_trans - transport common data
483 *
484 * @ops - pointer to iwl_trans_ops
485 * @op_mode - pointer to the op_mode
486 * @cfg - pointer to the configuration
487 * @dev - pointer to struct device * that represents the device
488 * @hw_id: a u32 with the ID of the device / subdevice.
489 * Set during transport allocation.
490 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
491 * @pm_support: set to true in start_hw if link pm is supported
492 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
493 * The user should use iwl_trans_{alloc,free}_tx_cmd.
494 * @dev_cmd_headroom: room needed for the transport's private use before the
495 * device_cmd for Tx - for internal use only
496 * The user should use iwl_trans_{alloc,free}_tx_cmd.
497 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
498 * starting the firmware, used for tracing
499 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
500 * start of the 802.11 header in the @rx_mpdu_cmd
501 */
502 struct iwl_trans {
503 const struct iwl_trans_ops *ops;
504 struct iwl_op_mode *op_mode;
505 const struct iwl_cfg *cfg;
506 enum iwl_trans_state state;
507
508 struct device *dev;
509 u32 hw_rev;
510 u32 hw_id;
511 char hw_id_str[52];
512
513 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
514
515 bool pm_support;
516
517 /* The following fields are internal only */
518 struct kmem_cache *dev_cmd_pool;
519 size_t dev_cmd_headroom;
520 char dev_cmd_pool_name[50];
521
522 struct dentry *dbgfs_dir;
523
524 #ifdef CONFIG_LOCKDEP
525 struct lockdep_map sync_cmd_lockdep_map;
526 #endif
527
528 /* pointer to trans specific struct */
529 /*Ensure that this pointer will always be aligned to sizeof pointer */
530 char trans_specific[0] __aligned(sizeof(void *));
531 };
532
iwl_trans_configure(struct iwl_trans * trans,const struct iwl_trans_config * trans_cfg)533 static inline void iwl_trans_configure(struct iwl_trans *trans,
534 const struct iwl_trans_config *trans_cfg)
535 {
536 trans->op_mode = trans_cfg->op_mode;
537
538 trans->ops->configure(trans, trans_cfg);
539 }
540
iwl_trans_start_hw(struct iwl_trans * trans)541 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
542 {
543 might_sleep();
544
545 return trans->ops->start_hw(trans);
546 }
547
iwl_trans_stop_hw(struct iwl_trans * trans,bool op_mode_leaving)548 static inline void iwl_trans_stop_hw(struct iwl_trans *trans,
549 bool op_mode_leaving)
550 {
551 might_sleep();
552
553 trans->ops->stop_hw(trans, op_mode_leaving);
554
555 if (op_mode_leaving)
556 trans->op_mode = NULL;
557
558 trans->state = IWL_TRANS_NO_FW;
559 }
560
iwl_trans_fw_alive(struct iwl_trans * trans,u32 scd_addr)561 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
562 {
563 might_sleep();
564
565 trans->state = IWL_TRANS_FW_ALIVE;
566
567 trans->ops->fw_alive(trans, scd_addr);
568 }
569
iwl_trans_start_fw(struct iwl_trans * trans,const struct fw_img * fw,bool run_in_rfkill)570 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
571 const struct fw_img *fw,
572 bool run_in_rfkill)
573 {
574 might_sleep();
575
576 WARN_ON_ONCE(!trans->rx_mpdu_cmd);
577
578 return trans->ops->start_fw(trans, fw, run_in_rfkill);
579 }
580
iwl_trans_stop_device(struct iwl_trans * trans)581 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
582 {
583 might_sleep();
584
585 trans->ops->stop_device(trans);
586
587 trans->state = IWL_TRANS_NO_FW;
588 }
589
iwl_trans_d3_suspend(struct iwl_trans * trans)590 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans)
591 {
592 might_sleep();
593 trans->ops->d3_suspend(trans);
594 }
595
iwl_trans_d3_resume(struct iwl_trans * trans,enum iwl_d3_status * status)596 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
597 enum iwl_d3_status *status)
598 {
599 might_sleep();
600 return trans->ops->d3_resume(trans, status);
601 }
602
iwl_trans_send_cmd(struct iwl_trans * trans,struct iwl_host_cmd * cmd)603 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
604 struct iwl_host_cmd *cmd)
605 {
606 int ret;
607
608 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
609 "%s bad state = %d", __func__, trans->state);
610
611 if (!(cmd->flags & CMD_ASYNC))
612 lock_map_acquire_read(&trans->sync_cmd_lockdep_map);
613
614 ret = trans->ops->send_cmd(trans, cmd);
615
616 if (!(cmd->flags & CMD_ASYNC))
617 lock_map_release(&trans->sync_cmd_lockdep_map);
618
619 return ret;
620 }
621
622 static inline struct iwl_device_cmd *
iwl_trans_alloc_tx_cmd(struct iwl_trans * trans)623 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
624 {
625 u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
626
627 if (unlikely(dev_cmd_ptr == NULL))
628 return NULL;
629
630 return (struct iwl_device_cmd *)
631 (dev_cmd_ptr + trans->dev_cmd_headroom);
632 }
633
iwl_trans_free_tx_cmd(struct iwl_trans * trans,struct iwl_device_cmd * dev_cmd)634 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
635 struct iwl_device_cmd *dev_cmd)
636 {
637 u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom;
638
639 kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr);
640 }
641
iwl_trans_tx(struct iwl_trans * trans,struct sk_buff * skb,struct iwl_device_cmd * dev_cmd,int queue)642 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
643 struct iwl_device_cmd *dev_cmd, int queue)
644 {
645 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
646 "%s bad state = %d", __func__, trans->state);
647
648 return trans->ops->tx(trans, skb, dev_cmd, queue);
649 }
650
iwl_trans_reclaim(struct iwl_trans * trans,int queue,int ssn,struct sk_buff_head * skbs)651 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
652 int ssn, struct sk_buff_head *skbs)
653 {
654 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
655 "%s bad state = %d", __func__, trans->state);
656
657 trans->ops->reclaim(trans, queue, ssn, skbs);
658 }
659
iwl_trans_txq_disable(struct iwl_trans * trans,int queue)660 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue)
661 {
662 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
663 "%s bad state = %d", __func__, trans->state);
664
665 trans->ops->txq_disable(trans, queue);
666 }
667
iwl_trans_txq_enable(struct iwl_trans * trans,int queue,int fifo,int sta_id,int tid,int frame_limit,u16 ssn)668 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
669 int fifo, int sta_id, int tid,
670 int frame_limit, u16 ssn)
671 {
672 might_sleep();
673
674 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
675 "%s bad state = %d", __func__, trans->state);
676
677 trans->ops->txq_enable(trans, queue, fifo, sta_id, tid,
678 frame_limit, ssn);
679 }
680
iwl_trans_ac_txq_enable(struct iwl_trans * trans,int queue,int fifo)681 static inline void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue,
682 int fifo)
683 {
684 iwl_trans_txq_enable(trans, queue, fifo, -1,
685 IWL_MAX_TID_COUNT, IWL_FRAME_LIMIT, 0);
686 }
687
iwl_trans_wait_tx_queue_empty(struct iwl_trans * trans)688 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
689 {
690 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
691 "%s bad state = %d", __func__, trans->state);
692
693 return trans->ops->wait_tx_queue_empty(trans);
694 }
695
iwl_trans_dbgfs_register(struct iwl_trans * trans,struct dentry * dir)696 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
697 struct dentry *dir)
698 {
699 return trans->ops->dbgfs_register(trans, dir);
700 }
701
702 #ifdef CONFIG_PM_SLEEP
iwl_trans_suspend(struct iwl_trans * trans)703 static inline int iwl_trans_suspend(struct iwl_trans *trans)
704 {
705 return trans->ops->suspend(trans);
706 }
707
iwl_trans_resume(struct iwl_trans * trans)708 static inline int iwl_trans_resume(struct iwl_trans *trans)
709 {
710 return trans->ops->resume(trans);
711 }
712 #endif
713
iwl_trans_write8(struct iwl_trans * trans,u32 ofs,u8 val)714 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
715 {
716 trans->ops->write8(trans, ofs, val);
717 }
718
iwl_trans_write32(struct iwl_trans * trans,u32 ofs,u32 val)719 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
720 {
721 trans->ops->write32(trans, ofs, val);
722 }
723
iwl_trans_read32(struct iwl_trans * trans,u32 ofs)724 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
725 {
726 return trans->ops->read32(trans, ofs);
727 }
728
iwl_trans_read_prph(struct iwl_trans * trans,u32 ofs)729 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
730 {
731 return trans->ops->read_prph(trans, ofs);
732 }
733
iwl_trans_write_prph(struct iwl_trans * trans,u32 ofs,u32 val)734 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
735 u32 val)
736 {
737 return trans->ops->write_prph(trans, ofs, val);
738 }
739
iwl_trans_read_mem(struct iwl_trans * trans,u32 addr,void * buf,int dwords)740 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
741 void *buf, int dwords)
742 {
743 return trans->ops->read_mem(trans, addr, buf, dwords);
744 }
745
746 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
747 do { \
748 if (__builtin_constant_p(bufsize)) \
749 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
750 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
751 } while (0)
752
iwl_trans_read_mem32(struct iwl_trans * trans,u32 addr)753 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
754 {
755 u32 value;
756
757 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
758 return 0xa5a5a5a5;
759
760 return value;
761 }
762
iwl_trans_write_mem(struct iwl_trans * trans,u32 addr,void * buf,int dwords)763 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
764 void *buf, int dwords)
765 {
766 return trans->ops->write_mem(trans, addr, buf, dwords);
767 }
768
iwl_trans_write_mem32(struct iwl_trans * trans,u32 addr,u32 val)769 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
770 u32 val)
771 {
772 return iwl_trans_write_mem(trans, addr, &val, 1);
773 }
774
iwl_trans_set_pmi(struct iwl_trans * trans,bool state)775 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
776 {
777 trans->ops->set_pmi(trans, state);
778 }
779
780 static inline void
iwl_trans_set_bits_mask(struct iwl_trans * trans,u32 reg,u32 mask,u32 value)781 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
782 {
783 trans->ops->set_bits_mask(trans, reg, mask, value);
784 }
785
786 #define iwl_trans_grab_nic_access(trans, silent, flags) \
787 __cond_lock(nic_access, \
788 likely((trans)->ops->grab_nic_access(trans, silent, flags)))
789
__releases(nic_access)790 static inline void __releases(nic_access)
791 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
792 {
793 trans->ops->release_nic_access(trans, flags);
794 __release(nic_access);
795 }
796
797 /*****************************************************
798 * driver (transport) register/unregister functions
799 ******************************************************/
800 int __must_check iwl_pci_register_driver(void);
801 void iwl_pci_unregister_driver(void);
802
trans_lockdep_init(struct iwl_trans * trans)803 static inline void trans_lockdep_init(struct iwl_trans *trans)
804 {
805 #ifdef CONFIG_LOCKDEP
806 static struct lock_class_key __key;
807
808 lockdep_init_map(&trans->sync_cmd_lockdep_map, "sync_cmd_lockdep_map",
809 &__key, 0);
810 #endif
811 }
812
813 #endif /* __iwl_trans_h__ */
814