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