iwl-trans.h 25 KB
Newer Older
1
2
3
4
5
6
7
/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
Johannes Berg's avatar
Johannes Berg committed
8
 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved.
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
 * USA
 *
 * The full GNU General Public License is included in this distribution
25
 * in the file called COPYING.
26
27
28
29
30
31
32
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
Johannes Berg's avatar
Johannes Berg committed
33
 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
63
64
#ifndef __iwl_trans_h__
#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
72
#include "iwl-config.h"
#include "iwl-fw.h"
73

74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/**
 * DOC: Transport layer - what is it ?
 *
 * The tranport layer is the layer that deals with the HW directly. It provides
 * an abstraction of the underlying HW to the upper layer. The transport layer
 * doesn't provide any policy, algorithm or anything of this kind, but only
 * mechanisms to make the HW do something.It is not completely stateless but
 * close to it.
 * We will have an implementation for each different supported bus.
 */

/**
 * DOC: Life cycle of the transport layer
 *
 * The transport layer has a very precise life cycle.
 *
 *	1) A helper function is called during the module initialization and
 *	   registers the bus driver's ops with the transport's alloc function.
 *	2) Bus's probe calls to the transport layer's allocation functions.
 *	   Of course this function is bus specific.
 *	3) This allocation functions will spawn the upper layer which will
 *	   register mac80211.
 *
 *	4) At some point (i.e. mac80211's start call), the op_mode will call
 *	   the following sequence:
 *	   start_hw
 *	   start_fw
 *
 *	5) Then when finished (or reset):
 *	   stop_fw (a.k.a. stop device for the moment)
 *	   stop_hw
 *
 *	6) Eventually, the free function will be called.
 */

/**
 * DOC: Host command section
 *
 * A host command is a commaned issued by the upper layer to the fw. There are
 * several versions of fw that have several APIs. The transport layer is
 * completely agnostic to these differences.
 * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode),
 */
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
#define SEQ_TO_QUEUE(s)	(((s) >> 8) & 0x1f)
#define QUEUE_TO_SEQ(q)	(((q) & 0x1f) << 8)
#define SEQ_TO_INDEX(s)	((s) & 0xff)
#define INDEX_TO_SEQ(i)	((i) & 0xff)
#define SEQ_RX_FRAME	cpu_to_le16(0x8000)

/**
 * struct iwl_cmd_header
 *
 * This header format appears in the beginning of each command sent from the
 * driver, and each response/notification received from uCode.
 */
struct iwl_cmd_header {
	u8 cmd;		/* Command ID:  REPLY_RXON, etc. */
	u8 flags;	/* 0:5 reserved, 6 abort, 7 internal */
	/*
	 * The driver sets up the sequence number to values of its choosing.
	 * uCode does not use this value, but passes it back to the driver
	 * when sending the response to each driver-originated command, so
	 * the driver can match the response to the command.  Since the values
	 * don't get used by uCode, the driver may set up an arbitrary format.
	 *
	 * There is one exception:  uCode sets bit 15 when it originates
	 * the response/notification, i.e. when the response/notification
	 * is not a direct response to a command sent by the driver.  For
	 * example, uCode issues REPLY_RX when it sends a received frame
	 * to the driver; it is not a direct response to any driver command.
	 *
	 * The Linux driver uses the following format:
	 *
	 *  0:7		tfd index - position within TX queue
	 *  8:12	TX queue id
	 *  13:14	reserved
	 *  15		unsolicited RX or uCode-originated notification
	 */
	__le16 sequence;
} __packed;

155
156
157
/* iwl_cmd_header flags value */
#define IWL_CMD_FAILED_MSK 0x40

158
159

#define FH_RSCSR_FRAME_SIZE_MSK		0x00003FFF	/* bits 0-13 */
160
161
#define FH_RSCSR_FRAME_INVALID		0x55550000
#define FH_RSCSR_FRAME_ALIGN		0x40
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

struct iwl_rx_packet {
	/*
	 * The first 4 bytes of the RX frame header contain both the RX frame
	 * size and some flags.
	 * Bit fields:
	 * 31:    flag flush RB request
	 * 30:    flag ignore TC (terminal counter) request
	 * 29:    flag fast IRQ request
	 * 28-14: Reserved
	 * 13-00: RX frame size
	 */
	__le32 len_n_flags;
	struct iwl_cmd_header hdr;
	u8 data[];
} __packed;
178

179
180
181
182
/**
 * enum CMD_MODE - how to send the host commands ?
 *
 * @CMD_SYNC: The caller will be stalled until the fw responds to the command
183
 * @CMD_ASYNC: Return right away and don't wait 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
187
 */
enum CMD_MODE {
188
189
190
	CMD_SYNC		= 0,
	CMD_ASYNC		= BIT(0),
	CMD_WANT_SKB		= BIT(1),
191
	CMD_SEND_IN_RFKILL	= BIT(2),
192
193
194
195
196
197
198
199
200
201
202
203
204
};

#define DEF_CMD_PAYLOAD_SIZE 320

/**
 * struct iwl_device_cmd
 *
 * For allocation of the command and tx queues, this establishes the overall
 * size of the largest command we send to uCode, except for commands that
 * aren't fully copied and use other TFD space.
 */
struct iwl_device_cmd {
	struct iwl_cmd_header hdr;	/* uCode API */
205
	u8 payload[DEF_CMD_PAYLOAD_SIZE];
206
207
208
209
} __packed;

#define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))

210
211
212
213
214
/*
 * number of transfer buffers (fragments) per transmit frame descriptor;
 * this is just the driver's idea, the hardware supports 20
 */
#define IWL_MAX_CMD_TBS_PER_TFD	2
215

216
217
218
/**
 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
 *
219
 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
220
 *	ring. The transport layer doesn't map the command's buffer to DMA, but
221
 *	rather copies it to a previously allocated DMA buffer. This flag tells
222
 *	the transport layer not to copy the command, but to map the existing
223
224
225
 *	buffer (that is passed in) instead. This saves the memcpy and allows
 *	commands that are bigger than the fixed buffer to be submitted.
 *	Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
226
227
228
 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
 *	chunk internally and free it again after the command completes. This
 *	can (currently) be used only once per command.
229
 *	Note that a TFD entry after a DUP one cannot be a normal copied one.
230
 */
231
232
enum iwl_hcmd_dataflag {
	IWL_HCMD_DFL_NOCOPY	= BIT(0),
233
	IWL_HCMD_DFL_DUP	= BIT(1),
234
235
236
237
};

/**
 * struct iwl_host_cmd - Host command to the uCode
238
 *
239
 * @data: array of chunks that composes the data of the host command
240
241
242
 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
 * @_rx_page_order: (internally used to free response packet)
 * @_rx_page_addr: (internally used to free response packet)
243
244
 * @handler_status: return value of the handler of the command
 *	(put in setup_rx_handlers) - valid for SYNC mode only
245
 * @flags: can be CMD_*
246
 * @len: array of the lengths of the chunks in data
247
 * @dataflags: IWL_HCMD_DFL_*
248
249
250
 * @id: id of the host command
 */
struct iwl_host_cmd {
251
	const void *data[IWL_MAX_CMD_TBS_PER_TFD];
252
253
254
	struct iwl_rx_packet *resp_pkt;
	unsigned long _rx_page_addr;
	u32 _rx_page_order;
255
256
	int handler_status;

257
	u32 flags;
258
259
	u16 len[IWL_MAX_CMD_TBS_PER_TFD];
	u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
260
261
	u8 id;
};
262

263
264
265
266
267
static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
{
	free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
}

268
269
struct iwl_rx_cmd_buffer {
	struct page *_page;
270
271
	int _offset;
	bool _page_stolen;
272
	u32 _rx_page_order;
273
	unsigned int truesize;
274
275
276
277
};

static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
{
278
279
280
281
282
283
	return (void *)((unsigned long)page_address(r->_page) + r->_offset);
}

static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
{
	return r->_offset;
284
285
286
287
}

static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
{
288
289
290
	r->_page_stolen = true;
	get_page(r->_page);
	return r->_page;
291
292
}

293
294
295
296
297
static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
{
	__free_pages(r->_page, r->_rx_page_order);
}

298
299
#define MAX_NO_RECLAIM_CMDS	6

300
301
#define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))

302
303
304
305
306
/*
 * Maximum number of HW queues the transport layer
 * currently supports
 */
#define IWL_MAX_HW_QUEUES		32
307
308
#define IWL_MAX_TID_COUNT	8
#define IWL_FRAME_LIMIT	64
309

310
311
312
313
314
315
316
317
318
319
/**
 * enum iwl_wowlan_status - WoWLAN image/device status
 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
 * @IWL_D3_STATUS_RESET: device was reset while suspended
 */
enum iwl_d3_status {
	IWL_D3_STATUS_ALIVE,
	IWL_D3_STATUS_RESET,
};

320
321
322
323
/**
 * struct iwl_trans_config - transport configuration
 *
 * @op_mode: pointer to the upper layer.
324
325
 * @cmd_queue: the index of the command queue.
 *	Must be set before start_fw.
326
 * @cmd_fifo: the fifo for host commands
327
328
329
330
331
 * @no_reclaim_cmds: Some devices erroneously don't set the
 *	SEQ_RX_FRAME bit on some notifications, this is the
 *	list of such notifications to filter. Max length is
 *	%MAX_NO_RECLAIM_CMDS.
 * @n_no_reclaim_cmds: # of commands in list
332
333
 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
 *	if unset 4k will be the RX buffer size
334
335
 * @bc_table_dword: set to true if the BC table expects the byte count to be
 *	in DWORD (as opposed to bytes)
336
337
 * @queue_watchdog_timeout: time (in ms) after which queues
 *	are considered stuck and will trigger device restart
Johannes Berg's avatar
Johannes Berg committed
338
339
 * @command_names: array of command names, must be 256 entries
 *	(one for each command); for debugging only
340
341
342
 */
struct iwl_trans_config {
	struct iwl_op_mode *op_mode;
343

344
	u8 cmd_queue;
345
	u8 cmd_fifo;
346
	const u8 *no_reclaim_cmds;
347
	unsigned int n_no_reclaim_cmds;
348
349

	bool rx_buf_size_8k;
350
	bool bc_table_dword;
351
	unsigned int queue_watchdog_timeout;
Johannes Berg's avatar
Johannes Berg committed
352
	const char **command_names;
353
354
};

355
356
struct iwl_trans;

357
358
/**
 * struct iwl_trans_ops - transport specific operations
359
360
361
 *
 * All the handlers MUST be implemented
 *
362
 * @start_hw: starts the HW- from that point on, the HW can send interrupts
363
 *	May sleep
364
 * @stop_hw: stops the HW- from that point on, the HW will be in low power but
365
366
 *	will still issue interrupt if the HW RF kill is triggered unless
 *	op_mode_leaving is true.
367
 *	May sleep
368
 * @start_fw: allocates and inits all the resources for the transport
369
370
 *	layer. Also kick a fw image.
 *	May sleep
371
372
 * @fw_alive: called when the fw sends alive notification. If the fw provides
 *	the SCD base address in SRAM, then provide it here, or 0 otherwise.
373
 *	May sleep
374
 * @stop_device:stops the whole device (embedded CPU put to reset)
375
 *	May sleep
376
 * @d3_suspend: put the device into the correct mode for WoWLAN during
377
378
 *	suspend. This is optional, if not implemented WoWLAN will not be
 *	supported. This callback may sleep.
379
380
381
 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
 *	talk to the WoWLAN image to get its status. This is optional, if not
 *	implemented WoWLAN will not be supported. This callback may sleep.
382
383
384
 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
 *	If RFkill is asserted in the middle of a SYNC host command, it must
 *	return -ERFKILL straight away.
385
 *	May sleep only if CMD_SYNC is set
386
 * @tx: send an skb
387
 *	Must be atomic
388
 * @reclaim: free packet until ssn. Returns a list of freed packets.
389
 *	Must be atomic
390
391
392
 * @txq_enable: setup a queue. To setup an AC queue, use the
 *	iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
 *	this one. The op_mode must not configure the HCMD queue. May sleep.
393
 * @txq_disable: de-configure a Tx queue to send AMPDUs
394
 *	Must be atomic
395
 * @wait_tx_queue_empty: wait until all tx queues are empty
396
 *	May sleep
397
398
 * @dbgfs_register: add the dbgfs files under this directory. Files will be
 *	automatically deleted.
399
400
401
 * @write8: write a u8 to a register at offset ofs from the BAR
 * @write32: write a u32 to a register at offset ofs from the BAR
 * @read32: read a u32 register at offset ofs from the BAR
402
403
 * @read_prph: read a DWORD from a periphery register
 * @write_prph: write a DWORD to a periphery register
404
 * @read_mem: read device's SRAM in DWORD
405
406
 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
 *	will be zeroed.
407
 * @configure: configure parameters required by the transport layer from
408
409
 *	the op_mode. May be called several times before start_fw, can't be
 *	called after that.
Don Fry's avatar
Don Fry committed
410
 * @set_pmi: set the power pmi state
411
412
413
414
415
 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
 *	Sleeping is not allowed between grab_nic_access and
 *	release_nic_access.
 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
 *	must be the same one that was sent before to the grab_nic_access.
416
 * @set_bits_mask - set SRAM register according to value and mask.
417
418
419
 */
struct iwl_trans_ops {

420
	int (*start_hw)(struct iwl_trans *iwl_trans);
421
	void (*stop_hw)(struct iwl_trans *iwl_trans, bool op_mode_leaving);
422
423
	int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
			bool run_in_rfkill);
424
	void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
425
	void (*stop_device)(struct iwl_trans *trans);
426

427
428
429
	void (*d3_suspend)(struct iwl_trans *trans, bool test);
	int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status,
			 bool test);
430

431
	int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
432

433
	int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
434
435
436
437
		  struct iwl_device_cmd *dev_cmd, int queue);
	void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
			struct sk_buff_head *skbs);

438
439
	void (*txq_enable)(struct iwl_trans *trans, int queue, int fifo,
			   int sta_id, int tid, int frame_limit, u16 ssn);
440
	void (*txq_disable)(struct iwl_trans *trans, int queue);
441

442
	int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
443
	int (*wait_tx_queue_empty)(struct iwl_trans *trans);
444

445
446
447
	void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
	void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
	u32 (*read32)(struct iwl_trans *trans, u32 ofs);
448
449
	u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
	void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
450
451
452
	int (*read_mem)(struct iwl_trans *trans, u32 addr,
			void *buf, int dwords);
	int (*write_mem)(struct iwl_trans *trans, u32 addr,
453
			 const void *buf, int dwords);
454
455
	void (*configure)(struct iwl_trans *trans,
			  const struct iwl_trans_config *trans_cfg);
Don Fry's avatar
Don Fry committed
456
	void (*set_pmi)(struct iwl_trans *trans, bool state);
457
458
459
460
	bool (*grab_nic_access)(struct iwl_trans *trans, bool silent,
				unsigned long *flags);
	void (*release_nic_access)(struct iwl_trans *trans,
				   unsigned long *flags);
461
462
	void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
			      u32 value);
463
464
};

465
466
467
468
469
470
471
472
473
474
475
/**
 * enum iwl_trans_state - state of the transport layer
 *
 * @IWL_TRANS_NO_FW: no fw has sent an alive response
 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
 */
enum iwl_trans_state {
	IWL_TRANS_NO_FW = 0,
	IWL_TRANS_FW_ALIVE	= 1,
};

476
477
/**
 * struct iwl_trans - transport common data
478
 *
479
 * @ops - pointer to iwl_trans_ops
480
 * @op_mode - pointer to the op_mode
481
 * @cfg - pointer to the configuration
482
 * @dev - pointer to struct device * that represents the device
483
 * @hw_id: a u32 with the ID of the device / subdevice.
484
 *	Set during transport allocation.
485
 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
486
 * @pm_support: set to true in start_hw if link pm is supported
487
488
489
490
491
 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
 *	The user should use iwl_trans_{alloc,free}_tx_cmd.
 * @dev_cmd_headroom: room needed for the transport's private use before the
 *	device_cmd for Tx - for internal use only
 *	The user should use iwl_trans_{alloc,free}_tx_cmd.
492
493
494
495
 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
 *	starting the firmware, used for tracing
 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
 *	start of the 802.11 header in the @rx_mpdu_cmd
496
 */
497
498
struct iwl_trans {
	const struct iwl_trans_ops *ops;
499
	struct iwl_op_mode *op_mode;
500
	const struct iwl_cfg *cfg;
501
	enum iwl_trans_state state;
502

503
	struct device *dev;
504
	u32 hw_rev;
505
	u32 hw_id;
506
	char hw_id_str[52];
507

508
509
	u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;

510
	bool pm_support;
511

512
513
514
	/* The following fields are internal only */
	struct kmem_cache *dev_cmd_pool;
	size_t dev_cmd_headroom;
515
	char dev_cmd_pool_name[50];
516

517
518
	struct dentry *dbgfs_dir;

519
520
521
522
#ifdef CONFIG_LOCKDEP
	struct lockdep_map sync_cmd_lockdep_map;
#endif

523
524
	/* pointer to trans specific struct */
	/*Ensure that this pointer will always be aligned to sizeof pointer */
525
	char trans_specific[0] __aligned(sizeof(void *));
526
527
};

528
static inline void iwl_trans_configure(struct iwl_trans *trans,
529
				       const struct iwl_trans_config *trans_cfg)
530
{
531
	trans->op_mode = trans_cfg->op_mode;
532
533

	trans->ops->configure(trans, trans_cfg);
534
535
}

536
static inline int iwl_trans_start_hw(struct iwl_trans *trans)
537
{
538
539
	might_sleep();

540
	return trans->ops->start_hw(trans);
541
542
}

543
544
static inline void iwl_trans_stop_hw(struct iwl_trans *trans,
				     bool op_mode_leaving)
545
{
546
547
	might_sleep();

548
	trans->ops->stop_hw(trans, op_mode_leaving);
549

550
551
552
	if (op_mode_leaving)
		trans->op_mode = NULL;

553
	trans->state = IWL_TRANS_NO_FW;
554
555
}

556
static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
557
{
558
559
	might_sleep();

560
	trans->state = IWL_TRANS_FW_ALIVE;
561

562
	trans->ops->fw_alive(trans, scd_addr);
563
564
}

565
static inline int iwl_trans_start_fw(struct iwl_trans *trans,
566
567
				     const struct fw_img *fw,
				     bool run_in_rfkill)
568
{
569
570
	might_sleep();

571
572
	WARN_ON_ONCE(!trans->rx_mpdu_cmd);

573
	return trans->ops->start_fw(trans, fw, run_in_rfkill);
574
575
}

576
static inline void iwl_trans_stop_device(struct iwl_trans *trans)
577
{
578
579
	might_sleep();

580
	trans->ops->stop_device(trans);
581
582

	trans->state = IWL_TRANS_NO_FW;
583
584
}

585
static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test)
586
587
{
	might_sleep();
588
	trans->ops->d3_suspend(trans, test);
589
590
591
}

static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
592
593
				      enum iwl_d3_status *status,
				      bool test)
594
595
{
	might_sleep();
596
	return trans->ops->d3_resume(trans, status, test);
597
598
}

599
static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
600
				     struct iwl_host_cmd *cmd)
601
{
602
603
	int ret;

604
605
	WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
		  "%s bad state = %d", __func__, trans->state);
606

607
608
609
610
611
612
613
614
615
	if (!(cmd->flags & CMD_ASYNC))
		lock_map_acquire_read(&trans->sync_cmd_lockdep_map);

	ret = trans->ops->send_cmd(trans, cmd);

	if (!(cmd->flags & CMD_ASYNC))
		lock_map_release(&trans->sync_cmd_lockdep_map);

	return ret;
616
617
}

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
static inline struct iwl_device_cmd *
iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
{
	u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);

	if (unlikely(dev_cmd_ptr == NULL))
		return NULL;

	return (struct iwl_device_cmd *)
			(dev_cmd_ptr + trans->dev_cmd_headroom);
}

static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
					 struct iwl_device_cmd *dev_cmd)
{
	u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom;

	kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr);
}

638
static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
639
			       struct iwl_device_cmd *dev_cmd, int queue)
640
{
641
642
	WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
		  "%s bad state = %d", __func__, trans->state);
643

644
	return trans->ops->tx(trans, skb, dev_cmd, queue);
645
646
}

647
648
static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
				     int ssn, struct sk_buff_head *skbs)
649
{
650
651
	WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
		  "%s bad state = %d", __func__, trans->state);
652

653
	trans->ops->reclaim(trans, queue, ssn, skbs);
654
655
}

656
static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue)
657
{
658
659
	WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
		  "%s bad state = %d", __func__, trans->state);
660

661
	trans->ops->txq_disable(trans, queue);
662
663
}

664
665
666
static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
					int fifo, int sta_id, int tid,
					int frame_limit, u16 ssn)
667
{
668
669
	might_sleep();

670
671
	WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
		  "%s bad state = %d", __func__, trans->state);
672

673
	trans->ops->txq_enable(trans, queue, fifo, sta_id, tid,
674
				 frame_limit, ssn);
675
676
}

677
678
679
static inline void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue,
					   int fifo)
{
680
	iwl_trans_txq_enable(trans, queue, fifo, -1,
681
682
683
			     IWL_MAX_TID_COUNT, IWL_FRAME_LIMIT, 0);
}

684
685
static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
{
686
687
	WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
		  "%s bad state = %d", __func__, trans->state);
688

689
690
691
	return trans->ops->wait_tx_queue_empty(trans);
}

692
static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
693
					   struct dentry *dir)
694
695
696
697
{
	return trans->ops->dbgfs_register(trans, dir);
}

698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
{
	trans->ops->write8(trans, ofs, val);
}

static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
{
	trans->ops->write32(trans, ofs, val);
}

static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
{
	return trans->ops->read32(trans, ofs);
}

713
714
715
716
717
718
719
720
721
722
723
static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
{
	return trans->ops->read_prph(trans, ofs);
}

static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
					u32 val)
{
	return trans->ops->write_prph(trans, ofs, val);
}

724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
				     void *buf, int dwords)
{
	return trans->ops->read_mem(trans, addr, buf, dwords);
}

#define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize)		      \
	do {								      \
		if (__builtin_constant_p(bufsize))			      \
			BUILD_BUG_ON((bufsize) % sizeof(u32));		      \
		iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
	} while (0)

static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
{
	u32 value;

	if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
		return 0xa5a5a5a5;

	return value;
}

static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
748
				      const void *buf, int dwords)
749
750
751
752
753
754
755
756
757
758
{
	return trans->ops->write_mem(trans, addr, buf, dwords);
}

static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
					u32 val)
{
	return iwl_trans_write_mem(trans, addr, &val, 1);
}

Don Fry's avatar
Don Fry committed
759
760
761
762
763
static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
{
	trans->ops->set_pmi(trans, state);
}

764
765
766
767
768
769
static inline void
iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
{
	trans->ops->set_bits_mask(trans, reg, mask, value);
}

770
#define iwl_trans_grab_nic_access(trans, silent, flags)	\
771
	__cond_lock(nic_access,				\
772
		    likely((trans)->ops->grab_nic_access(trans, silent, flags)))
773

774
static inline void __releases(nic_access)
775
iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
776
{
777
	trans->ops->release_nic_access(trans, flags);
778
	__release(nic_access);
779
780
}

781
/*****************************************************
782
* driver (transport) register/unregister functions
783
******************************************************/
Emmanuel Grumbach's avatar
Emmanuel Grumbach committed
784
785
int __must_check iwl_pci_register_driver(void);
void iwl_pci_unregister_driver(void);
786

787
788
789
790
791
792
793
794
795
796
static inline void trans_lockdep_init(struct iwl_trans *trans)
{
#ifdef CONFIG_LOCKDEP
	static struct lock_class_key __key;

	lockdep_init_map(&trans->sync_cmd_lockdep_map, "sync_cmd_lockdep_map",
			 &__key, 0);
#endif
}

797
#endif /* __iwl_trans_h__ */