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 - 2014 Intel Corporation. All rights reserved.
9  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of version 2 of the GNU General Public License as
14  * published by the Free Software Foundation.
15  *
16  * This program is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * General Public License for more details.
20  *
21  * The full GNU General Public License is included in this distribution
22  * in the file called COPYING.
23  *
24  * Contact Information:
25  *  Intel Linux Wireless <linuxwifi@intel.com>
26  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27  *
28  * BSD LICENSE
29  *
30  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
31  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
32  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
33  * All rights reserved.
34  *
35  * Redistribution and use in source and binary forms, with or without
36  * modification, are permitted provided that the following conditions
37  * are met:
38  *
39  *  * Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  *  * Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in
43  *    the documentation and/or other materials provided with the
44  *    distribution.
45  *  * Neither the name Intel Corporation nor the names of its
46  *    contributors may be used to endorse or promote products derived
47  *    from this software without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
50  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
51  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
52  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
53  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
54  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
55  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
59  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  *****************************************************************************/
62 #ifndef __iwl_trans_h__
63 #define __iwl_trans_h__
64 
65 #include <linux/ieee80211.h>
66 #include <linux/mm.h> /* for page_address */
67 #include <linux/lockdep.h>
68 #include <linux/kernel.h>
69 
70 #include "iwl-debug.h"
71 #include "iwl-config.h"
72 #include "fw/img.h"
73 #include "iwl-op-mode.h"
74 #include "fw/api/cmdhdr.h"
75 #include "fw/api/txq.h"
76 #include "fw/api/dbg-tlv.h"
77 #include "iwl-dbg-tlv.h"
78 
79 /**
80  * DOC: Transport layer - what is it ?
81  *
82  * The transport layer is the layer that deals with the HW directly. It provides
83  * an abstraction of the underlying HW to the upper layer. The transport layer
84  * doesn't provide any policy, algorithm or anything of this kind, but only
85  * mechanisms to make the HW do something. It is not completely stateless but
86  * close to it.
87  * We will have an implementation for each different supported bus.
88  */
89 
90 /**
91  * DOC: Life cycle of the transport layer
92  *
93  * The transport layer has a very precise life cycle.
94  *
95  *	1) A helper function is called during the module initialization and
96  *	   registers the bus driver's ops with the transport's alloc function.
97  *	2) Bus's probe calls to the transport layer's allocation functions.
98  *	   Of course this function is bus specific.
99  *	3) This allocation functions will spawn the upper layer which will
100  *	   register mac80211.
101  *
102  *	4) At some point (i.e. mac80211's start call), the op_mode will call
103  *	   the following sequence:
104  *	   start_hw
105  *	   start_fw
106  *
107  *	5) Then when finished (or reset):
108  *	   stop_device
109  *
110  *	6) Eventually, the free function will be called.
111  */
112 
113 #define FH_RSCSR_FRAME_SIZE_MSK		0x00003FFF	/* bits 0-13 */
114 #define FH_RSCSR_FRAME_INVALID		0x55550000
115 #define FH_RSCSR_FRAME_ALIGN		0x40
116 #define FH_RSCSR_RPA_EN			BIT(25)
117 #define FH_RSCSR_RADA_EN		BIT(26)
118 #define FH_RSCSR_RXQ_POS		16
119 #define FH_RSCSR_RXQ_MASK		0x3F0000
120 
121 struct iwl_rx_packet {
122 	/*
123 	 * The first 4 bytes of the RX frame header contain both the RX frame
124 	 * size and some flags.
125 	 * Bit fields:
126 	 * 31:    flag flush RB request
127 	 * 30:    flag ignore TC (terminal counter) request
128 	 * 29:    flag fast IRQ request
129 	 * 28-27: Reserved
130 	 * 26:    RADA enabled
131 	 * 25:    Offload enabled
132 	 * 24:    RPF enabled
133 	 * 23:    RSS enabled
134 	 * 22:    Checksum enabled
135 	 * 21-16: RX queue
136 	 * 15-14: Reserved
137 	 * 13-00: RX frame size
138 	 */
139 	__le32 len_n_flags;
140 	struct iwl_cmd_header hdr;
141 	u8 data[];
142 } __packed;
143 
144 static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt)
145 {
146 	return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
147 }
148 
149 static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt)
150 {
151 	return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr);
152 }
153 
154 /**
155  * enum CMD_MODE - how to send the host commands ?
156  *
157  * @CMD_ASYNC: Return right away and don't wait for the response
158  * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of
159  *	the response. The caller needs to call iwl_free_resp when done.
160  * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
161  *	command queue, but after other high priority commands. Valid only
162  *	with CMD_ASYNC.
163  * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
164  * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
165  * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
166  *	(i.e. mark it as non-idle).
167  * @CMD_WANT_ASYNC_CALLBACK: the op_mode's async callback function must be
168  *	called after this command completes. Valid only with CMD_ASYNC.
169  */
170 enum CMD_MODE {
171 	CMD_ASYNC		= BIT(0),
172 	CMD_WANT_SKB		= BIT(1),
173 	CMD_SEND_IN_RFKILL	= BIT(2),
174 	CMD_HIGH_PRIO		= BIT(3),
175 	CMD_SEND_IN_IDLE	= BIT(4),
176 	CMD_MAKE_TRANS_IDLE	= BIT(5),
177 	CMD_WAKE_UP_TRANS	= BIT(6),
178 	CMD_WANT_ASYNC_CALLBACK	= BIT(7),
179 };
180 
181 #define DEF_CMD_PAYLOAD_SIZE 320
182 
183 /**
184  * struct iwl_device_cmd
185  *
186  * For allocation of the command and tx queues, this establishes the overall
187  * size of the largest command we send to uCode, except for commands that
188  * aren't fully copied and use other TFD space.
189  */
190 struct iwl_device_cmd {
191 	union {
192 		struct {
193 			struct iwl_cmd_header hdr;	/* uCode API */
194 			u8 payload[DEF_CMD_PAYLOAD_SIZE];
195 		};
196 		struct {
197 			struct iwl_cmd_header_wide hdr_wide;
198 			u8 payload_wide[DEF_CMD_PAYLOAD_SIZE -
199 					sizeof(struct iwl_cmd_header_wide) +
200 					sizeof(struct iwl_cmd_header)];
201 		};
202 	};
203 } __packed;
204 
205 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
206 
207 /*
208  * number of transfer buffers (fragments) per transmit frame descriptor;
209  * this is just the driver's idea, the hardware supports 20
210  */
211 #define IWL_MAX_CMD_TBS_PER_TFD	2
212 
213 /**
214  * enum iwl_hcmd_dataflag - flag for each one of the chunks of the command
215  *
216  * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
217  *	ring. The transport layer doesn't map the command's buffer to DMA, but
218  *	rather copies it to a previously allocated DMA buffer. This flag tells
219  *	the transport layer not to copy the command, but to map the existing
220  *	buffer (that is passed in) instead. This saves the memcpy and allows
221  *	commands that are bigger than the fixed buffer to be submitted.
222  *	Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
223  * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
224  *	chunk internally and free it again after the command completes. This
225  *	can (currently) be used only once per command.
226  *	Note that a TFD entry after a DUP one cannot be a normal copied one.
227  */
228 enum iwl_hcmd_dataflag {
229 	IWL_HCMD_DFL_NOCOPY	= BIT(0),
230 	IWL_HCMD_DFL_DUP	= BIT(1),
231 };
232 
233 /**
234  * struct iwl_host_cmd - Host command to the uCode
235  *
236  * @data: array of chunks that composes the data of the host command
237  * @resp_pkt: response packet, if %CMD_WANT_SKB was set
238  * @_rx_page_order: (internally used to free response packet)
239  * @_rx_page_addr: (internally used to free response packet)
240  * @flags: can be CMD_*
241  * @len: array of the lengths of the chunks in data
242  * @dataflags: IWL_HCMD_DFL_*
243  * @id: command id of the host command, for wide commands encoding the
244  *	version and group as well
245  */
246 struct iwl_host_cmd {
247 	const void *data[IWL_MAX_CMD_TBS_PER_TFD];
248 	struct iwl_rx_packet *resp_pkt;
249 	unsigned long _rx_page_addr;
250 	u32 _rx_page_order;
251 
252 	u32 flags;
253 	u32 id;
254 	u16 len[IWL_MAX_CMD_TBS_PER_TFD];
255 	u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
256 };
257 
258 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
259 {
260 	free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
261 }
262 
263 struct iwl_rx_cmd_buffer {
264 	struct page *_page;
265 	int _offset;
266 	bool _page_stolen;
267 	u32 _rx_page_order;
268 	unsigned int truesize;
269 	u8 status;
270 };
271 
272 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
273 {
274 	return (void *)((unsigned long)page_address(r->_page) + r->_offset);
275 }
276 
277 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
278 {
279 	return r->_offset;
280 }
281 
282 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
283 {
284 	r->_page_stolen = true;
285 	get_page(r->_page);
286 	return r->_page;
287 }
288 
289 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
290 {
291 	__free_pages(r->_page, r->_rx_page_order);
292 }
293 
294 #define MAX_NO_RECLAIM_CMDS	6
295 
296 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
297 
298 /*
299  * Maximum number of HW queues the transport layer
300  * currently supports
301  */
302 #define IWL_MAX_HW_QUEUES		32
303 #define IWL_MAX_TVQM_QUEUES		512
304 
305 #define IWL_MAX_TID_COUNT	8
306 #define IWL_MGMT_TID		15
307 #define IWL_FRAME_LIMIT	64
308 #define IWL_MAX_RX_HW_QUEUES	16
309 
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 
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_HW: the actual HW state of the RF-kill switch
327  * @STATUS_RFKILL_OPMODE: RF-kill state reported to opmode
328  * @STATUS_FW_ERROR: the fw is in error state
329  * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
330  *	are sent
331  * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
332  * @STATUS_TRANS_DEAD: trans is dead - avoid any read/write operation
333  */
334 enum iwl_trans_status {
335 	STATUS_SYNC_HCMD_ACTIVE,
336 	STATUS_DEVICE_ENABLED,
337 	STATUS_TPOWER_PMI,
338 	STATUS_INT_ENABLED,
339 	STATUS_RFKILL_HW,
340 	STATUS_RFKILL_OPMODE,
341 	STATUS_FW_ERROR,
342 	STATUS_TRANS_GOING_IDLE,
343 	STATUS_TRANS_IDLE,
344 	STATUS_TRANS_DEAD,
345 };
346 
347 static inline int
348 iwl_trans_get_rb_size_order(enum iwl_amsdu_size rb_size)
349 {
350 	switch (rb_size) {
351 	case IWL_AMSDU_2K:
352 		return get_order(2 * 1024);
353 	case IWL_AMSDU_4K:
354 		return get_order(4 * 1024);
355 	case IWL_AMSDU_8K:
356 		return get_order(8 * 1024);
357 	case IWL_AMSDU_12K:
358 		return get_order(12 * 1024);
359 	default:
360 		WARN_ON(1);
361 		return -1;
362 	}
363 }
364 
365 struct iwl_hcmd_names {
366 	u8 cmd_id;
367 	const char *const cmd_name;
368 };
369 
370 #define HCMD_NAME(x)	\
371 	{ .cmd_id = x, .cmd_name = #x }
372 
373 struct iwl_hcmd_arr {
374 	const struct iwl_hcmd_names *arr;
375 	int size;
376 };
377 
378 #define HCMD_ARR(x)	\
379 	{ .arr = x, .size = ARRAY_SIZE(x) }
380 
381 /**
382  * struct iwl_trans_config - transport configuration
383  *
384  * @op_mode: pointer to the upper layer.
385  * @cmd_queue: the index of the command queue.
386  *	Must be set before start_fw.
387  * @cmd_fifo: the fifo for host commands
388  * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue.
389  * @no_reclaim_cmds: Some devices erroneously don't set the
390  *	SEQ_RX_FRAME bit on some notifications, this is the
391  *	list of such notifications to filter. Max length is
392  *	%MAX_NO_RECLAIM_CMDS.
393  * @n_no_reclaim_cmds: # of commands in list
394  * @rx_buf_size: RX buffer size needed for A-MSDUs
395  *	if unset 4k will be the RX buffer size
396  * @bc_table_dword: set to true if the BC table expects the byte count to be
397  *	in DWORD (as opposed to bytes)
398  * @scd_set_active: should the transport configure the SCD for HCMD queue
399  * @sw_csum_tx: transport should compute the TCP checksum
400  * @command_groups: array of command groups, each member is an array of the
401  *	commands in the group; for debugging only
402  * @command_groups_size: number of command groups, to avoid illegal access
403  * @cb_data_offs: offset inside skb->cb to store transport data at, must have
404  *	space for at least two pointers
405  */
406 struct iwl_trans_config {
407 	struct iwl_op_mode *op_mode;
408 
409 	u8 cmd_queue;
410 	u8 cmd_fifo;
411 	unsigned int cmd_q_wdg_timeout;
412 	const u8 *no_reclaim_cmds;
413 	unsigned int n_no_reclaim_cmds;
414 
415 	enum iwl_amsdu_size rx_buf_size;
416 	bool bc_table_dword;
417 	bool scd_set_active;
418 	bool sw_csum_tx;
419 	const struct iwl_hcmd_arr *command_groups;
420 	int command_groups_size;
421 
422 	u8 cb_data_offs;
423 };
424 
425 struct iwl_trans_dump_data {
426 	u32 len;
427 	u8 data[];
428 };
429 
430 struct iwl_trans;
431 
432 struct iwl_trans_txq_scd_cfg {
433 	u8 fifo;
434 	u8 sta_id;
435 	u8 tid;
436 	bool aggregate;
437 	int frame_limit;
438 };
439 
440 /**
441  * struct iwl_trans_rxq_dma_data - RX queue DMA data
442  * @fr_bd_cb: DMA address of free BD cyclic buffer
443  * @fr_bd_wid: Initial write index of the free BD cyclic buffer
444  * @urbd_stts_wrptr: DMA address of urbd_stts_wrptr
445  * @ur_bd_cb: DMA address of used BD cyclic buffer
446  */
447 struct iwl_trans_rxq_dma_data {
448 	u64 fr_bd_cb;
449 	u32 fr_bd_wid;
450 	u64 urbd_stts_wrptr;
451 	u64 ur_bd_cb;
452 };
453 
454 /**
455  * struct iwl_trans_ops - transport specific operations
456  *
457  * All the handlers MUST be implemented
458  *
459  * @start_hw: starts the HW. If low_power is true, the NIC needs to be taken
460  *	out of a low power state. From that point on, the HW can send
461  *	interrupts. May sleep.
462  * @op_mode_leave: Turn off the HW RF kill indication if on
463  *	May sleep
464  * @start_fw: allocates and inits all the resources for the transport
465  *	layer. Also kick a fw image.
466  *	May sleep
467  * @fw_alive: called when the fw sends alive notification. If the fw provides
468  *	the SCD base address in SRAM, then provide it here, or 0 otherwise.
469  *	May sleep
470  * @stop_device: stops the whole device (embedded CPU put to reset) and stops
471  *	the HW. If low_power is true, the NIC will be put in low power state.
472  *	From that point on, the HW will be stopped but will still issue an
473  *	interrupt if the HW RF kill switch is triggered.
474  *	This callback must do the right thing and not crash even if %start_hw()
475  *	was called but not &start_fw(). May sleep.
476  * @d3_suspend: put the device into the correct mode for WoWLAN during
477  *	suspend. This is optional, if not implemented WoWLAN will not be
478  *	supported. This callback may sleep.
479  * @d3_resume: resume the device after WoWLAN, enabling the opmode to
480  *	talk to the WoWLAN image to get its status. This is optional, if not
481  *	implemented WoWLAN will not be supported. This callback may sleep.
482  * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
483  *	If RFkill is asserted in the middle of a SYNC host command, it must
484  *	return -ERFKILL straight away.
485  *	May sleep only if CMD_ASYNC is not set
486  * @tx: send an skb. The transport relies on the op_mode to zero the
487  *	the ieee80211_tx_info->driver_data. If the MPDU is an A-MSDU, all
488  *	the CSUM will be taken care of (TCP CSUM and IP header in case of
489  *	IPv4). If the MPDU is a single MSDU, the op_mode must compute the IP
490  *	header if it is IPv4.
491  *	Must be atomic
492  * @reclaim: free packet until ssn. Returns a list of freed packets.
493  *	Must be atomic
494  * @txq_enable: setup a queue. To setup an AC queue, use the
495  *	iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
496  *	this one. The op_mode must not configure the HCMD queue. The scheduler
497  *	configuration may be %NULL, in which case the hardware will not be
498  *	configured. If true is returned, the operation mode needs to increment
499  *	the sequence number of the packets routed to this queue because of a
500  *	hardware scheduler bug. May sleep.
501  * @txq_disable: de-configure a Tx queue to send AMPDUs
502  *	Must be atomic
503  * @txq_set_shared_mode: change Tx queue shared/unshared marking
504  * @wait_tx_queues_empty: wait until tx queues are empty. May sleep.
505  * @wait_txq_empty: wait until specific tx queue is empty. May sleep.
506  * @freeze_txq_timer: prevents the timer of the queue from firing until the
507  *	queue is set to awake. Must be atomic.
508  * @block_txq_ptrs: stop updating the write pointers of the Tx queues. Note
509  *	that the transport needs to refcount the calls since this function
510  *	will be called several times with block = true, and then the queues
511  *	need to be unblocked only after the same number of calls with
512  *	block = false.
513  * @write8: write a u8 to a register at offset ofs from the BAR
514  * @write32: write a u32 to a register at offset ofs from the BAR
515  * @read32: read a u32 register at offset ofs from the BAR
516  * @read_prph: read a DWORD from a periphery register
517  * @write_prph: write a DWORD to a periphery register
518  * @read_mem: read device's SRAM in DWORD
519  * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
520  *	will be zeroed.
521  * @configure: configure parameters required by the transport layer from
522  *	the op_mode. May be called several times before start_fw, can't be
523  *	called after that.
524  * @set_pmi: set the power pmi state
525  * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
526  *	Sleeping is not allowed between grab_nic_access and
527  *	release_nic_access.
528  * @release_nic_access: let the NIC go to sleep. The "flags" parameter
529  *	must be the same one that was sent before to the grab_nic_access.
530  * @set_bits_mask - set SRAM register according to value and mask.
531  * @ref: grab a reference to the transport/FW layers, disallowing
532  *	certain low power states
533  * @unref: release a reference previously taken with @ref. Note that
534  *	initially the reference count is 1, making an initial @unref
535  *	necessary to allow low power states.
536  * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last
537  *	TX'ed commands and similar. The buffer will be vfree'd by the caller.
538  *	Note that the transport must fill in the proper file headers.
539  * @debugfs_cleanup: used in the driver unload flow to make a proper cleanup
540  *	of the trans debugfs
541  */
542 struct iwl_trans_ops {
543 
544 	int (*start_hw)(struct iwl_trans *iwl_trans, bool low_power);
545 	void (*op_mode_leave)(struct iwl_trans *iwl_trans);
546 	int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
547 			bool run_in_rfkill);
548 	void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
549 	void (*stop_device)(struct iwl_trans *trans, bool low_power);
550 
551 	void (*d3_suspend)(struct iwl_trans *trans, bool test, bool reset);
552 	int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status,
553 			 bool test, bool reset);
554 
555 	int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
556 
557 	int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
558 		  struct iwl_device_cmd *dev_cmd, int queue);
559 	void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
560 			struct sk_buff_head *skbs);
561 
562 	bool (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn,
563 			   const struct iwl_trans_txq_scd_cfg *cfg,
564 			   unsigned int queue_wdg_timeout);
565 	void (*txq_disable)(struct iwl_trans *trans, int queue,
566 			    bool configure_scd);
567 	/* 22000 functions */
568 	int (*txq_alloc)(struct iwl_trans *trans,
569 			 __le16 flags, u8 sta_id, u8 tid,
570 			 int cmd_id, int size,
571 			 unsigned int queue_wdg_timeout);
572 	void (*txq_free)(struct iwl_trans *trans, int queue);
573 	int (*rxq_dma_data)(struct iwl_trans *trans, int queue,
574 			    struct iwl_trans_rxq_dma_data *data);
575 
576 	void (*txq_set_shared_mode)(struct iwl_trans *trans, u32 txq_id,
577 				    bool shared);
578 
579 	int (*wait_tx_queues_empty)(struct iwl_trans *trans, u32 txq_bm);
580 	int (*wait_txq_empty)(struct iwl_trans *trans, int queue);
581 	void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs,
582 				 bool freeze);
583 	void (*block_txq_ptrs)(struct iwl_trans *trans, bool block);
584 
585 	void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
586 	void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
587 	u32 (*read32)(struct iwl_trans *trans, u32 ofs);
588 	u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
589 	void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
590 	int (*read_mem)(struct iwl_trans *trans, u32 addr,
591 			void *buf, int dwords);
592 	int (*write_mem)(struct iwl_trans *trans, u32 addr,
593 			 const void *buf, int dwords);
594 	void (*configure)(struct iwl_trans *trans,
595 			  const struct iwl_trans_config *trans_cfg);
596 	void (*set_pmi)(struct iwl_trans *trans, bool state);
597 	void (*sw_reset)(struct iwl_trans *trans);
598 	bool (*grab_nic_access)(struct iwl_trans *trans, unsigned long *flags);
599 	void (*release_nic_access)(struct iwl_trans *trans,
600 				   unsigned long *flags);
601 	void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
602 			      u32 value);
603 	void (*ref)(struct iwl_trans *trans);
604 	void (*unref)(struct iwl_trans *trans);
605 	int  (*suspend)(struct iwl_trans *trans);
606 	void (*resume)(struct iwl_trans *trans);
607 
608 	struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans,
609 						 u32 dump_mask);
610 	void (*debugfs_cleanup)(struct iwl_trans *trans);
611 };
612 
613 /**
614  * enum iwl_trans_state - state of the transport layer
615  *
616  * @IWL_TRANS_NO_FW: no fw has sent an alive response
617  * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
618  */
619 enum iwl_trans_state {
620 	IWL_TRANS_NO_FW = 0,
621 	IWL_TRANS_FW_ALIVE	= 1,
622 };
623 
624 /**
625  * DOC: Platform power management
626  *
627  * There are two types of platform power management: system-wide
628  * (WoWLAN) and runtime.
629  *
630  * In system-wide power management the entire platform goes into a low
631  * power state (e.g. idle or suspend to RAM) at the same time and the
632  * device is configured as a wakeup source for the entire platform.
633  * This is usually triggered by userspace activity (e.g. the user
634  * presses the suspend button or a power management daemon decides to
635  * put the platform in low power mode).  The device's behavior in this
636  * mode is dictated by the wake-on-WLAN configuration.
637  *
638  * In runtime power management, only the devices which are themselves
639  * idle enter a low power state.  This is done at runtime, which means
640  * that the entire system is still running normally.  This mode is
641  * usually triggered automatically by the device driver and requires
642  * the ability to enter and exit the low power modes in a very short
643  * time, so there is not much impact in usability.
644  *
645  * The terms used for the device's behavior are as follows:
646  *
647  *	- D0: the device is fully powered and the host is awake;
648  *	- D3: the device is in low power mode and only reacts to
649  *		specific events (e.g. magic-packet received or scan
650  *		results found);
651  *	- D0I3: the device is in low power mode and reacts to any
652  *		activity (e.g. RX);
653  *
654  * These terms reflect the power modes in the firmware and are not to
655  * be confused with the physical device power state.  The NIC can be
656  * in D0I3 mode even if, for instance, the PCI device is in D3 state.
657  */
658 
659 /**
660  * enum iwl_plat_pm_mode - platform power management mode
661  *
662  * This enumeration describes the device's platform power management
663  * behavior when in idle mode (i.e. runtime power management) or when
664  * in system-wide suspend (i.e WoWLAN).
665  *
666  * @IWL_PLAT_PM_MODE_DISABLED: power management is disabled for this
667  *	device.  At runtime, this means that nothing happens and the
668  *	device always remains in active.  In system-wide suspend mode,
669  *	it means that the all connections will be closed automatically
670  *	by mac80211 before the platform is suspended.
671  * @IWL_PLAT_PM_MODE_D3: the device goes into D3 mode (i.e. WoWLAN).
672  *	For runtime power management, this mode is not officially
673  *	supported.
674  * @IWL_PLAT_PM_MODE_D0I3: the device goes into D0I3 mode.
675  */
676 enum iwl_plat_pm_mode {
677 	IWL_PLAT_PM_MODE_DISABLED,
678 	IWL_PLAT_PM_MODE_D3,
679 	IWL_PLAT_PM_MODE_D0I3,
680 };
681 
682 /* Max time to wait for trans to become idle/non-idle on d0i3
683  * enter/exit (in msecs).
684  */
685 #define IWL_TRANS_IDLE_TIMEOUT 2000
686 
687 /**
688  * struct iwl_dram_data
689  * @physical: page phy pointer
690  * @block: pointer to the allocated block/page
691  * @size: size of the block/page
692  */
693 struct iwl_dram_data {
694 	dma_addr_t physical;
695 	void *block;
696 	int size;
697 };
698 
699 /**
700  * struct iwl_trans - transport common data
701  *
702  * @ops - pointer to iwl_trans_ops
703  * @op_mode - pointer to the op_mode
704  * @cfg - pointer to the configuration
705  * @drv - pointer to iwl_drv
706  * @status: a bit-mask of transport status flags
707  * @dev - pointer to struct device * that represents the device
708  * @max_skb_frags: maximum number of fragments an SKB can have when transmitted.
709  *	0 indicates that frag SKBs (NETIF_F_SG) aren't supported.
710  * @hw_rf_id a u32 with the device RF ID
711  * @hw_id: a u32 with the ID of the device / sub-device.
712  *	Set during transport allocation.
713  * @hw_id_str: a string with info about HW ID. Set during transport allocation.
714  * @pm_support: set to true in start_hw if link pm is supported
715  * @ltr_enabled: set to true if the LTR is enabled
716  * @wide_cmd_header: true when ucode supports wide command header format
717  * @num_rx_queues: number of RX queues allocated by the transport;
718  *	the transport must set this before calling iwl_drv_start()
719  * @iml_len: the length of the image loader
720  * @iml: a pointer to the image loader itself
721  * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
722  *	The user should use iwl_trans_{alloc,free}_tx_cmd.
723  * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
724  *	starting the firmware, used for tracing
725  * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
726  *	start of the 802.11 header in the @rx_mpdu_cmd
727  * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
728  * @dbg_dest_tlv: points to the destination TLV for debug
729  * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
730  * @dbg_trigger_tlv: array of pointers to triggers TLVs for debug
731  * @dbg_n_dest_reg: num of reg_ops in %dbg_dest_tlv
732  * @num_blocks: number of blocks in fw_mon
733  * @fw_mon: address of the buffers for firmware monitor
734  * @system_pm_mode: the system-wide power management mode in use.
735  *	This mode is set dynamically, depending on the WoWLAN values
736  *	configured from the userspace at runtime.
737  * @runtime_pm_mode: the runtime power management mode in use.  This
738  *	mode is set during the initialization phase and is not
739  *	supposed to change during runtime.
740  * @dbg_rec_on: true iff there is a fw debug recording currently active
741  */
742 struct iwl_trans {
743 	const struct iwl_trans_ops *ops;
744 	struct iwl_op_mode *op_mode;
745 	const struct iwl_cfg *cfg;
746 	struct iwl_drv *drv;
747 	enum iwl_trans_state state;
748 	unsigned long status;
749 
750 	struct device *dev;
751 	u32 max_skb_frags;
752 	u32 hw_rev;
753 	u32 hw_rf_id;
754 	u32 hw_id;
755 	char hw_id_str[52];
756 
757 	u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
758 
759 	bool pm_support;
760 	bool ltr_enabled;
761 
762 	const struct iwl_hcmd_arr *command_groups;
763 	int command_groups_size;
764 	bool wide_cmd_header;
765 
766 	u8 num_rx_queues;
767 
768 	size_t iml_len;
769 	u8 *iml;
770 
771 	/* The following fields are internal only */
772 	struct kmem_cache *dev_cmd_pool;
773 	char dev_cmd_pool_name[50];
774 
775 	struct dentry *dbgfs_dir;
776 
777 #ifdef CONFIG_LOCKDEP
778 	struct lockdep_map sync_cmd_lockdep_map;
779 #endif
780 
781 	struct iwl_apply_point_data apply_points[IWL_FW_INI_APPLY_NUM];
782 	struct iwl_apply_point_data apply_points_ext[IWL_FW_INI_APPLY_NUM];
783 
784 	bool external_ini_loaded;
785 	bool ini_valid;
786 
787 	const struct iwl_fw_dbg_dest_tlv_v1 *dbg_dest_tlv;
788 	const struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
789 	struct iwl_fw_dbg_trigger_tlv * const *dbg_trigger_tlv;
790 	u8 dbg_n_dest_reg;
791 	int num_blocks;
792 	struct iwl_dram_data fw_mon[IWL_FW_INI_APPLY_NUM];
793 
794 	enum iwl_plat_pm_mode system_pm_mode;
795 	enum iwl_plat_pm_mode runtime_pm_mode;
796 	bool suspending;
797 	bool dbg_rec_on;
798 
799 	/* pointer to trans specific struct */
800 	/*Ensure that this pointer will always be aligned to sizeof pointer */
801 	char trans_specific[0] __aligned(sizeof(void *));
802 };
803 
804 const char *iwl_get_cmd_string(struct iwl_trans *trans, u32 id);
805 int iwl_cmd_groups_verify_sorted(const struct iwl_trans_config *trans);
806 
807 static inline void iwl_trans_configure(struct iwl_trans *trans,
808 				       const struct iwl_trans_config *trans_cfg)
809 {
810 	trans->op_mode = trans_cfg->op_mode;
811 
812 	trans->ops->configure(trans, trans_cfg);
813 	WARN_ON(iwl_cmd_groups_verify_sorted(trans_cfg));
814 }
815 
816 static inline int _iwl_trans_start_hw(struct iwl_trans *trans, bool low_power)
817 {
818 	might_sleep();
819 
820 	return trans->ops->start_hw(trans, low_power);
821 }
822 
823 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
824 {
825 	return trans->ops->start_hw(trans, true);
826 }
827 
828 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans)
829 {
830 	might_sleep();
831 
832 	if (trans->ops->op_mode_leave)
833 		trans->ops->op_mode_leave(trans);
834 
835 	trans->op_mode = NULL;
836 
837 	trans->state = IWL_TRANS_NO_FW;
838 }
839 
840 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
841 {
842 	might_sleep();
843 
844 	trans->state = IWL_TRANS_FW_ALIVE;
845 
846 	trans->ops->fw_alive(trans, scd_addr);
847 }
848 
849 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
850 				     const struct fw_img *fw,
851 				     bool run_in_rfkill)
852 {
853 	might_sleep();
854 
855 	WARN_ON_ONCE(!trans->rx_mpdu_cmd);
856 
857 	clear_bit(STATUS_FW_ERROR, &trans->status);
858 	return trans->ops->start_fw(trans, fw, run_in_rfkill);
859 }
860 
861 static inline void _iwl_trans_stop_device(struct iwl_trans *trans,
862 					  bool low_power)
863 {
864 	might_sleep();
865 
866 	trans->ops->stop_device(trans, low_power);
867 
868 	trans->state = IWL_TRANS_NO_FW;
869 }
870 
871 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
872 {
873 	_iwl_trans_stop_device(trans, true);
874 }
875 
876 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test,
877 					bool reset)
878 {
879 	might_sleep();
880 	if (trans->ops->d3_suspend)
881 		trans->ops->d3_suspend(trans, test, reset);
882 }
883 
884 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
885 				      enum iwl_d3_status *status,
886 				      bool test, bool reset)
887 {
888 	might_sleep();
889 	if (!trans->ops->d3_resume)
890 		return 0;
891 
892 	return trans->ops->d3_resume(trans, status, test, reset);
893 }
894 
895 static inline int iwl_trans_suspend(struct iwl_trans *trans)
896 {
897 	if (!trans->ops->suspend)
898 		return 0;
899 
900 	return trans->ops->suspend(trans);
901 }
902 
903 static inline void iwl_trans_resume(struct iwl_trans *trans)
904 {
905 	if (trans->ops->resume)
906 		trans->ops->resume(trans);
907 }
908 
909 static inline struct iwl_trans_dump_data *
910 iwl_trans_dump_data(struct iwl_trans *trans, u32 dump_mask)
911 {
912 	if (!trans->ops->dump_data)
913 		return NULL;
914 	return trans->ops->dump_data(trans, dump_mask);
915 }
916 
917 static inline struct iwl_device_cmd *
918 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
919 {
920 	return kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
921 }
922 
923 int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
924 
925 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
926 					 struct iwl_device_cmd *dev_cmd)
927 {
928 	kmem_cache_free(trans->dev_cmd_pool, dev_cmd);
929 }
930 
931 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
932 			       struct iwl_device_cmd *dev_cmd, int queue)
933 {
934 	if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
935 		return -EIO;
936 
937 	if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
938 		IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
939 		return -EIO;
940 	}
941 
942 	return trans->ops->tx(trans, skb, dev_cmd, queue);
943 }
944 
945 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
946 				     int ssn, struct sk_buff_head *skbs)
947 {
948 	if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
949 		IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
950 		return;
951 	}
952 
953 	trans->ops->reclaim(trans, queue, ssn, skbs);
954 }
955 
956 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue,
957 					 bool configure_scd)
958 {
959 	trans->ops->txq_disable(trans, queue, configure_scd);
960 }
961 
962 static inline bool
963 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn,
964 			 const struct iwl_trans_txq_scd_cfg *cfg,
965 			 unsigned int queue_wdg_timeout)
966 {
967 	might_sleep();
968 
969 	if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
970 		IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
971 		return false;
972 	}
973 
974 	return trans->ops->txq_enable(trans, queue, ssn,
975 				      cfg, queue_wdg_timeout);
976 }
977 
978 static inline int
979 iwl_trans_get_rxq_dma_data(struct iwl_trans *trans, int queue,
980 			   struct iwl_trans_rxq_dma_data *data)
981 {
982 	if (WARN_ON_ONCE(!trans->ops->rxq_dma_data))
983 		return -ENOTSUPP;
984 
985 	return trans->ops->rxq_dma_data(trans, queue, data);
986 }
987 
988 static inline void
989 iwl_trans_txq_free(struct iwl_trans *trans, int queue)
990 {
991 	if (WARN_ON_ONCE(!trans->ops->txq_free))
992 		return;
993 
994 	trans->ops->txq_free(trans, queue);
995 }
996 
997 static inline int
998 iwl_trans_txq_alloc(struct iwl_trans *trans,
999 		    __le16 flags, u8 sta_id, u8 tid,
1000 		    int cmd_id, int size,
1001 		    unsigned int wdg_timeout)
1002 {
1003 	might_sleep();
1004 
1005 	if (WARN_ON_ONCE(!trans->ops->txq_alloc))
1006 		return -ENOTSUPP;
1007 
1008 	if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1009 		IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1010 		return -EIO;
1011 	}
1012 
1013 	return trans->ops->txq_alloc(trans, flags, sta_id, tid,
1014 				     cmd_id, size, wdg_timeout);
1015 }
1016 
1017 static inline void iwl_trans_txq_set_shared_mode(struct iwl_trans *trans,
1018 						 int queue, bool shared_mode)
1019 {
1020 	if (trans->ops->txq_set_shared_mode)
1021 		trans->ops->txq_set_shared_mode(trans, queue, shared_mode);
1022 }
1023 
1024 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
1025 					int fifo, int sta_id, int tid,
1026 					int frame_limit, u16 ssn,
1027 					unsigned int queue_wdg_timeout)
1028 {
1029 	struct iwl_trans_txq_scd_cfg cfg = {
1030 		.fifo = fifo,
1031 		.sta_id = sta_id,
1032 		.tid = tid,
1033 		.frame_limit = frame_limit,
1034 		.aggregate = sta_id >= 0,
1035 	};
1036 
1037 	iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout);
1038 }
1039 
1040 static inline
1041 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo,
1042 			     unsigned int queue_wdg_timeout)
1043 {
1044 	struct iwl_trans_txq_scd_cfg cfg = {
1045 		.fifo = fifo,
1046 		.sta_id = -1,
1047 		.tid = IWL_MAX_TID_COUNT,
1048 		.frame_limit = IWL_FRAME_LIMIT,
1049 		.aggregate = false,
1050 	};
1051 
1052 	iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout);
1053 }
1054 
1055 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans,
1056 					      unsigned long txqs,
1057 					      bool freeze)
1058 {
1059 	if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1060 		IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1061 		return;
1062 	}
1063 
1064 	if (trans->ops->freeze_txq_timer)
1065 		trans->ops->freeze_txq_timer(trans, txqs, freeze);
1066 }
1067 
1068 static inline void iwl_trans_block_txq_ptrs(struct iwl_trans *trans,
1069 					    bool block)
1070 {
1071 	if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1072 		IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1073 		return;
1074 	}
1075 
1076 	if (trans->ops->block_txq_ptrs)
1077 		trans->ops->block_txq_ptrs(trans, block);
1078 }
1079 
1080 static inline int iwl_trans_wait_tx_queues_empty(struct iwl_trans *trans,
1081 						 u32 txqs)
1082 {
1083 	if (WARN_ON_ONCE(!trans->ops->wait_tx_queues_empty))
1084 		return -ENOTSUPP;
1085 
1086 	if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1087 		IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1088 		return -EIO;
1089 	}
1090 
1091 	return trans->ops->wait_tx_queues_empty(trans, txqs);
1092 }
1093 
1094 static inline int iwl_trans_wait_txq_empty(struct iwl_trans *trans, int queue)
1095 {
1096 	if (WARN_ON_ONCE(!trans->ops->wait_txq_empty))
1097 		return -ENOTSUPP;
1098 
1099 	if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1100 		IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1101 		return -EIO;
1102 	}
1103 
1104 	return trans->ops->wait_txq_empty(trans, queue);
1105 }
1106 
1107 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
1108 {
1109 	trans->ops->write8(trans, ofs, val);
1110 }
1111 
1112 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
1113 {
1114 	trans->ops->write32(trans, ofs, val);
1115 }
1116 
1117 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
1118 {
1119 	return trans->ops->read32(trans, ofs);
1120 }
1121 
1122 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
1123 {
1124 	return trans->ops->read_prph(trans, ofs);
1125 }
1126 
1127 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
1128 					u32 val)
1129 {
1130 	return trans->ops->write_prph(trans, ofs, val);
1131 }
1132 
1133 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
1134 				     void *buf, int dwords)
1135 {
1136 	return trans->ops->read_mem(trans, addr, buf, dwords);
1137 }
1138 
1139 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize)		      \
1140 	do {								      \
1141 		if (__builtin_constant_p(bufsize))			      \
1142 			BUILD_BUG_ON((bufsize) % sizeof(u32));		      \
1143 		iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
1144 	} while (0)
1145 
1146 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
1147 {
1148 	u32 value;
1149 
1150 	if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
1151 		return 0xa5a5a5a5;
1152 
1153 	return value;
1154 }
1155 
1156 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
1157 				      const void *buf, int dwords)
1158 {
1159 	return trans->ops->write_mem(trans, addr, buf, dwords);
1160 }
1161 
1162 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
1163 					u32 val)
1164 {
1165 	return iwl_trans_write_mem(trans, addr, &val, 1);
1166 }
1167 
1168 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
1169 {
1170 	if (trans->ops->set_pmi)
1171 		trans->ops->set_pmi(trans, state);
1172 }
1173 
1174 static inline void iwl_trans_sw_reset(struct iwl_trans *trans)
1175 {
1176 	if (trans->ops->sw_reset)
1177 		trans->ops->sw_reset(trans);
1178 }
1179 
1180 static inline void
1181 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
1182 {
1183 	trans->ops->set_bits_mask(trans, reg, mask, value);
1184 }
1185 
1186 #define iwl_trans_grab_nic_access(trans, flags)	\
1187 	__cond_lock(nic_access,				\
1188 		    likely((trans)->ops->grab_nic_access(trans, flags)))
1189 
1190 static inline void __releases(nic_access)
1191 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
1192 {
1193 	trans->ops->release_nic_access(trans, flags);
1194 	__release(nic_access);
1195 }
1196 
1197 static inline void iwl_trans_fw_error(struct iwl_trans *trans)
1198 {
1199 	if (WARN_ON_ONCE(!trans->op_mode))
1200 		return;
1201 
1202 	/* prevent double restarts due to the same erroneous FW */
1203 	if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status))
1204 		iwl_op_mode_nic_error(trans->op_mode);
1205 }
1206 
1207 /*****************************************************
1208  * transport helper functions
1209  *****************************************************/
1210 struct iwl_trans *iwl_trans_alloc(unsigned int priv_size,
1211 				  struct device *dev,
1212 				  const struct iwl_cfg *cfg,
1213 				  const struct iwl_trans_ops *ops);
1214 void iwl_trans_free(struct iwl_trans *trans);
1215 void iwl_trans_ref(struct iwl_trans *trans);
1216 void iwl_trans_unref(struct iwl_trans *trans);
1217 
1218 /*****************************************************
1219 * driver (transport) register/unregister functions
1220 ******************************************************/
1221 int __must_check iwl_pci_register_driver(void);
1222 void iwl_pci_unregister_driver(void);
1223 
1224 #endif /* __iwl_trans_h__ */
1225