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