1 /******************************************************************************
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.
8 * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24 * The full GNU General Public License is included in this distribution
25 * in the file called COPYING.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 *****************************************************************************/
63 #ifndef __iwl_trans_h__
64 #define __iwl_trans_h__
66 #include <linux/ieee80211.h>
67 #include <linux/mm.h> /* for page_address */
68 #include <linux/lockdep.h>
70 #include "iwl-debug.h"
71 #include "iwl-config.h"
73 #include "iwl-op-mode.h"
76 * DOC: Transport layer - what is it ?
78 * The tranport layer is the layer that deals with the HW directly. It provides
79 * an abstraction of the underlying HW to the upper layer. The transport layer
80 * doesn't provide any policy, algorithm or anything of this kind, but only
81 * mechanisms to make the HW do something.It is not completely stateless but
83 * We will have an implementation for each different supported bus.
87 * DOC: Life cycle of the transport layer
89 * The transport layer has a very precise life cycle.
91 * 1) A helper function is called during the module initialization and
92 * registers the bus driver's ops with the transport's alloc function.
93 * 2) Bus's probe calls to the transport layer's allocation functions.
94 * Of course this function is bus specific.
95 * 3) This allocation functions will spawn the upper layer which will
98 * 4) At some point (i.e. mac80211's start call), the op_mode will call
99 * the following sequence:
103 * 5) Then when finished (or reset):
106 * 6) Eventually, the free function will be called.
110 * DOC: Host command section
112 * A host command is a commaned issued by the upper layer to the fw. There are
113 * several versions of fw that have several APIs. The transport layer is
114 * completely agnostic to these differences.
115 * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode),
117 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
118 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
119 #define SEQ_TO_INDEX(s) ((s) & 0xff)
120 #define INDEX_TO_SEQ(i) ((i) & 0xff)
121 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
124 * struct iwl_cmd_header
126 * This header format appears in the beginning of each command sent from the
127 * driver, and each response/notification received from uCode.
129 struct iwl_cmd_header
{
130 u8 cmd
; /* Command ID: REPLY_RXON, etc. */
131 u8 flags
; /* 0:5 reserved, 6 abort, 7 internal */
133 * The driver sets up the sequence number to values of its choosing.
134 * uCode does not use this value, but passes it back to the driver
135 * when sending the response to each driver-originated command, so
136 * the driver can match the response to the command. Since the values
137 * don't get used by uCode, the driver may set up an arbitrary format.
139 * There is one exception: uCode sets bit 15 when it originates
140 * the response/notification, i.e. when the response/notification
141 * is not a direct response to a command sent by the driver. For
142 * example, uCode issues REPLY_RX when it sends a received frame
143 * to the driver; it is not a direct response to any driver command.
145 * The Linux driver uses the following format:
147 * 0:7 tfd index - position within TX queue
150 * 15 unsolicited RX or uCode-originated notification
155 /* iwl_cmd_header flags value */
156 #define IWL_CMD_FAILED_MSK 0x40
159 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
160 #define FH_RSCSR_FRAME_INVALID 0x55550000
161 #define FH_RSCSR_FRAME_ALIGN 0x40
163 struct iwl_rx_packet
{
165 * The first 4 bytes of the RX frame header contain both the RX frame
166 * size and some flags.
168 * 31: flag flush RB request
169 * 30: flag ignore TC (terminal counter) request
170 * 29: flag fast IRQ request
172 * 13-00: RX frame size
175 struct iwl_cmd_header hdr
;
180 * enum CMD_MODE - how to send the host commands ?
182 * @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.
190 CMD_WANT_SKB
= BIT(1),
191 CMD_SEND_IN_RFKILL
= BIT(2),
194 #define DEF_CMD_PAYLOAD_SIZE 320
197 * struct iwl_device_cmd
199 * For allocation of the command and tx queues, this establishes the overall
200 * size of the largest command we send to uCode, except for commands that
201 * aren't fully copied and use other TFD space.
203 struct iwl_device_cmd
{
204 struct iwl_cmd_header hdr
; /* uCode API */
205 u8 payload
[DEF_CMD_PAYLOAD_SIZE
];
208 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
211 * number of transfer buffers (fragments) per transmit frame descriptor;
212 * this is just the driver's idea, the hardware supports 20
214 #define IWL_MAX_CMD_TBS_PER_TFD 2
217 * 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 * buffer (that is passed in) instead. This saves the memcpy and allows
224 * commands that are bigger than the fixed buffer to be submitted.
225 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
226 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
227 * chunk internally and free it again after the command completes. This
228 * can (currently) be used only once per command.
229 * Note that a TFD entry after a DUP one cannot be a normal copied one.
231 enum iwl_hcmd_dataflag
{
232 IWL_HCMD_DFL_NOCOPY
= BIT(0),
233 IWL_HCMD_DFL_DUP
= BIT(1),
237 * struct iwl_host_cmd - Host command to the uCode
239 * @data: array of chunks that composes the data of the host command
240 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
241 * @_rx_page_order: (internally used to free response packet)
242 * @_rx_page_addr: (internally used to free response packet)
243 * @handler_status: return value of the handler of the command
244 * (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 * @id: id of the host command
250 struct iwl_host_cmd
{
251 const void *data
[IWL_MAX_CMD_TBS_PER_TFD
];
252 struct iwl_rx_packet
*resp_pkt
;
253 unsigned long _rx_page_addr
;
258 u16 len
[IWL_MAX_CMD_TBS_PER_TFD
];
259 u8 dataflags
[IWL_MAX_CMD_TBS_PER_TFD
];
263 static inline void iwl_free_resp(struct iwl_host_cmd
*cmd
)
265 free_pages(cmd
->_rx_page_addr
, cmd
->_rx_page_order
);
268 struct iwl_rx_cmd_buffer
{
273 unsigned int truesize
;
276 static inline void *rxb_addr(struct iwl_rx_cmd_buffer
*r
)
278 return (void *)((unsigned long)page_address(r
->_page
) + r
->_offset
);
281 static inline int rxb_offset(struct iwl_rx_cmd_buffer
*r
)
286 static inline struct page
*rxb_steal_page(struct iwl_rx_cmd_buffer
*r
)
288 r
->_page_stolen
= true;
293 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer
*r
)
295 __free_pages(r
->_page
, r
->_rx_page_order
);
298 #define MAX_NO_RECLAIM_CMDS 6
300 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
303 * Maximum number of HW queues the transport layer
306 #define IWL_MAX_HW_QUEUES 32
307 #define IWL_MAX_TID_COUNT 8
308 #define IWL_FRAME_LIMIT 64
311 * enum iwl_wowlan_status - WoWLAN image/device status
312 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
313 * @IWL_D3_STATUS_RESET: device was reset while suspended
321 * enum iwl_trans_status: transport status flags
322 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
323 * @STATUS_DEVICE_ENABLED: APM is enabled
324 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
325 * @STATUS_INT_ENABLED: interrupts are enabled
326 * @STATUS_RFKILL: the HW RFkill switch is in KILL position
327 * @STATUS_FW_ERROR: the fw is in error state
329 enum iwl_trans_status
{
330 STATUS_SYNC_HCMD_ACTIVE
,
331 STATUS_DEVICE_ENABLED
,
339 * struct iwl_trans_config - transport configuration
341 * @op_mode: pointer to the upper layer.
342 * @cmd_queue: the index of the command queue.
343 * Must be set before start_fw.
344 * @cmd_fifo: the fifo for host commands
345 * @no_reclaim_cmds: Some devices erroneously don't set the
346 * SEQ_RX_FRAME bit on some notifications, this is the
347 * list of such notifications to filter. Max length is
348 * %MAX_NO_RECLAIM_CMDS.
349 * @n_no_reclaim_cmds: # of commands in list
350 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
351 * if unset 4k will be the RX buffer size
352 * @bc_table_dword: set to true if the BC table expects the byte count to be
353 * in DWORD (as opposed to bytes)
354 * @queue_watchdog_timeout: time (in ms) after which queues
355 * are considered stuck and will trigger device restart
356 * @command_names: array of command names, must be 256 entries
357 * (one for each command); for debugging only
359 struct iwl_trans_config
{
360 struct iwl_op_mode
*op_mode
;
364 const u8
*no_reclaim_cmds
;
365 unsigned int n_no_reclaim_cmds
;
369 unsigned int queue_watchdog_timeout
;
370 const char **command_names
;
376 * struct iwl_trans_ops - transport specific operations
378 * All the handlers MUST be implemented
380 * @start_hw: starts the HW- from that point on, the HW can send interrupts
382 * @op_mode_leave: Turn off the HW RF kill indication if on
384 * @start_fw: allocates and inits all the resources for the transport
385 * layer. Also kick a fw image.
387 * @fw_alive: called when the fw sends alive notification. If the fw provides
388 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
390 * @stop_device: stops the whole device (embedded CPU put to reset) and stops
391 * the HW. From that point on, the HW will be in low power but will still
392 * issue interrupt if the HW RF kill is triggered. This callback must do
393 * the right thing and not crash even if start_hw() was called but not
394 * start_fw(). May sleep
395 * @d3_suspend: put the device into the correct mode for WoWLAN during
396 * suspend. This is optional, if not implemented WoWLAN will not be
397 * supported. This callback may sleep.
398 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
399 * talk to the WoWLAN image to get its status. This is optional, if not
400 * implemented WoWLAN will not be supported. This callback may sleep.
401 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
402 * If RFkill is asserted in the middle of a SYNC host command, it must
403 * return -ERFKILL straight away.
404 * May sleep only if CMD_SYNC is set
407 * @reclaim: free packet until ssn. Returns a list of freed packets.
409 * @txq_enable: setup a queue. To setup an AC queue, use the
410 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
411 * this one. The op_mode must not configure the HCMD queue. May sleep.
412 * @txq_disable: de-configure a Tx queue to send AMPDUs
414 * @wait_tx_queue_empty: wait until all tx queues are empty
416 * @dbgfs_register: add the dbgfs files under this directory. Files will be
417 * automatically deleted.
418 * @write8: write a u8 to a register at offset ofs from the BAR
419 * @write32: write a u32 to a register at offset ofs from the BAR
420 * @read32: read a u32 register at offset ofs from the BAR
421 * @read_prph: read a DWORD from a periphery register
422 * @write_prph: write a DWORD to a periphery register
423 * @read_mem: read device's SRAM in DWORD
424 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
426 * @configure: configure parameters required by the transport layer from
427 * the op_mode. May be called several times before start_fw, can't be
429 * @set_pmi: set the power pmi state
430 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
431 * Sleeping is not allowed between grab_nic_access and
432 * release_nic_access.
433 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
434 * must be the same one that was sent before to the grab_nic_access.
435 * @set_bits_mask - set SRAM register according to value and mask.
437 struct iwl_trans_ops
{
439 int (*start_hw
)(struct iwl_trans
*iwl_trans
);
440 void (*op_mode_leave
)(struct iwl_trans
*iwl_trans
);
441 int (*start_fw
)(struct iwl_trans
*trans
, const struct fw_img
*fw
,
443 void (*fw_alive
)(struct iwl_trans
*trans
, u32 scd_addr
);
444 void (*stop_device
)(struct iwl_trans
*trans
);
446 void (*d3_suspend
)(struct iwl_trans
*trans
, bool test
);
447 int (*d3_resume
)(struct iwl_trans
*trans
, enum iwl_d3_status
*status
,
450 int (*send_cmd
)(struct iwl_trans
*trans
, struct iwl_host_cmd
*cmd
);
452 int (*tx
)(struct iwl_trans
*trans
, struct sk_buff
*skb
,
453 struct iwl_device_cmd
*dev_cmd
, int queue
);
454 void (*reclaim
)(struct iwl_trans
*trans
, int queue
, int ssn
,
455 struct sk_buff_head
*skbs
);
457 void (*txq_enable
)(struct iwl_trans
*trans
, int queue
, int fifo
,
458 int sta_id
, int tid
, int frame_limit
, u16 ssn
);
459 void (*txq_disable
)(struct iwl_trans
*trans
, int queue
);
461 int (*dbgfs_register
)(struct iwl_trans
*trans
, struct dentry
* dir
);
462 int (*wait_tx_queue_empty
)(struct iwl_trans
*trans
);
464 void (*write8
)(struct iwl_trans
*trans
, u32 ofs
, u8 val
);
465 void (*write32
)(struct iwl_trans
*trans
, u32 ofs
, u32 val
);
466 u32 (*read32
)(struct iwl_trans
*trans
, u32 ofs
);
467 u32 (*read_prph
)(struct iwl_trans
*trans
, u32 ofs
);
468 void (*write_prph
)(struct iwl_trans
*trans
, u32 ofs
, u32 val
);
469 int (*read_mem
)(struct iwl_trans
*trans
, u32 addr
,
470 void *buf
, int dwords
);
471 int (*write_mem
)(struct iwl_trans
*trans
, u32 addr
,
472 const void *buf
, int dwords
);
473 void (*configure
)(struct iwl_trans
*trans
,
474 const struct iwl_trans_config
*trans_cfg
);
475 void (*set_pmi
)(struct iwl_trans
*trans
, bool state
);
476 bool (*grab_nic_access
)(struct iwl_trans
*trans
, bool silent
,
477 unsigned long *flags
);
478 void (*release_nic_access
)(struct iwl_trans
*trans
,
479 unsigned long *flags
);
480 void (*set_bits_mask
)(struct iwl_trans
*trans
, u32 reg
, u32 mask
,
485 * enum iwl_trans_state - state of the transport layer
487 * @IWL_TRANS_NO_FW: no fw has sent an alive response
488 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
490 enum iwl_trans_state
{
492 IWL_TRANS_FW_ALIVE
= 1,
496 * struct iwl_trans - transport common data
498 * @ops - pointer to iwl_trans_ops
499 * @op_mode - pointer to the op_mode
500 * @cfg - pointer to the configuration
501 * @status: a bit-mask of transport status flags
502 * @dev - pointer to struct device * that represents the device
503 * @hw_id: a u32 with the ID of the device / subdevice.
504 * Set during transport allocation.
505 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
506 * @pm_support: set to true in start_hw if link pm is supported
507 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
508 * The user should use iwl_trans_{alloc,free}_tx_cmd.
509 * @dev_cmd_headroom: room needed for the transport's private use before the
510 * device_cmd for Tx - for internal use only
511 * The user should use iwl_trans_{alloc,free}_tx_cmd.
512 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
513 * starting the firmware, used for tracing
514 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
515 * start of the 802.11 header in the @rx_mpdu_cmd
518 const struct iwl_trans_ops
*ops
;
519 struct iwl_op_mode
*op_mode
;
520 const struct iwl_cfg
*cfg
;
521 enum iwl_trans_state state
;
522 unsigned long status
;
529 u8 rx_mpdu_cmd
, rx_mpdu_cmd_hdr_size
;
533 /* The following fields are internal only */
534 struct kmem_cache
*dev_cmd_pool
;
535 size_t dev_cmd_headroom
;
536 char dev_cmd_pool_name
[50];
538 struct dentry
*dbgfs_dir
;
540 #ifdef CONFIG_LOCKDEP
541 struct lockdep_map sync_cmd_lockdep_map
;
544 /* pointer to trans specific struct */
545 /*Ensure that this pointer will always be aligned to sizeof pointer */
546 char trans_specific
[0] __aligned(sizeof(void *));
549 static inline void iwl_trans_configure(struct iwl_trans
*trans
,
550 const struct iwl_trans_config
*trans_cfg
)
552 trans
->op_mode
= trans_cfg
->op_mode
;
554 trans
->ops
->configure(trans
, trans_cfg
);
557 static inline int iwl_trans_start_hw(struct iwl_trans
*trans
)
561 return trans
->ops
->start_hw(trans
);
564 static inline void iwl_trans_op_mode_leave(struct iwl_trans
*trans
)
568 if (trans
->ops
->op_mode_leave
)
569 trans
->ops
->op_mode_leave(trans
);
571 trans
->op_mode
= NULL
;
573 trans
->state
= IWL_TRANS_NO_FW
;
576 static inline void iwl_trans_fw_alive(struct iwl_trans
*trans
, u32 scd_addr
)
580 trans
->state
= IWL_TRANS_FW_ALIVE
;
582 trans
->ops
->fw_alive(trans
, scd_addr
);
585 static inline int iwl_trans_start_fw(struct iwl_trans
*trans
,
586 const struct fw_img
*fw
,
591 WARN_ON_ONCE(!trans
->rx_mpdu_cmd
);
593 clear_bit(STATUS_FW_ERROR
, &trans
->status
);
594 return trans
->ops
->start_fw(trans
, fw
, run_in_rfkill
);
597 static inline void iwl_trans_stop_device(struct iwl_trans
*trans
)
601 trans
->ops
->stop_device(trans
);
603 trans
->state
= IWL_TRANS_NO_FW
;
606 static inline void iwl_trans_d3_suspend(struct iwl_trans
*trans
, bool test
)
609 trans
->ops
->d3_suspend(trans
, test
);
612 static inline int iwl_trans_d3_resume(struct iwl_trans
*trans
,
613 enum iwl_d3_status
*status
,
617 return trans
->ops
->d3_resume(trans
, status
, test
);
620 static inline int iwl_trans_send_cmd(struct iwl_trans
*trans
,
621 struct iwl_host_cmd
*cmd
)
625 if (unlikely(!(cmd
->flags
& CMD_SEND_IN_RFKILL
) &&
626 test_bit(STATUS_RFKILL
, &trans
->status
)))
629 if (unlikely(test_bit(STATUS_FW_ERROR
, &trans
->status
)))
632 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
)) {
633 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
637 if (!(cmd
->flags
& CMD_ASYNC
))
638 lock_map_acquire_read(&trans
->sync_cmd_lockdep_map
);
640 ret
= trans
->ops
->send_cmd(trans
, cmd
);
642 if (!(cmd
->flags
& CMD_ASYNC
))
643 lock_map_release(&trans
->sync_cmd_lockdep_map
);
648 static inline struct iwl_device_cmd
*
649 iwl_trans_alloc_tx_cmd(struct iwl_trans
*trans
)
651 u8
*dev_cmd_ptr
= kmem_cache_alloc(trans
->dev_cmd_pool
, GFP_ATOMIC
);
653 if (unlikely(dev_cmd_ptr
== NULL
))
656 return (struct iwl_device_cmd
*)
657 (dev_cmd_ptr
+ trans
->dev_cmd_headroom
);
660 static inline void iwl_trans_free_tx_cmd(struct iwl_trans
*trans
,
661 struct iwl_device_cmd
*dev_cmd
)
663 u8
*dev_cmd_ptr
= (u8
*)dev_cmd
- trans
->dev_cmd_headroom
;
665 kmem_cache_free(trans
->dev_cmd_pool
, dev_cmd_ptr
);
668 static inline int iwl_trans_tx(struct iwl_trans
*trans
, struct sk_buff
*skb
,
669 struct iwl_device_cmd
*dev_cmd
, int queue
)
671 if (unlikely(test_bit(STATUS_FW_ERROR
, &trans
->status
)))
674 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
675 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
677 return trans
->ops
->tx(trans
, skb
, dev_cmd
, queue
);
680 static inline void iwl_trans_reclaim(struct iwl_trans
*trans
, int queue
,
681 int ssn
, struct sk_buff_head
*skbs
)
683 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
684 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
686 trans
->ops
->reclaim(trans
, queue
, ssn
, skbs
);
689 static inline void iwl_trans_txq_disable(struct iwl_trans
*trans
, int queue
)
691 trans
->ops
->txq_disable(trans
, queue
);
694 static inline void iwl_trans_txq_enable(struct iwl_trans
*trans
, int queue
,
695 int fifo
, int sta_id
, int tid
,
696 int frame_limit
, u16 ssn
)
700 if (unlikely((trans
->state
!= IWL_TRANS_FW_ALIVE
)))
701 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
703 trans
->ops
->txq_enable(trans
, queue
, fifo
, sta_id
, tid
,
707 static inline void iwl_trans_ac_txq_enable(struct iwl_trans
*trans
, int queue
,
710 iwl_trans_txq_enable(trans
, queue
, fifo
, -1,
711 IWL_MAX_TID_COUNT
, IWL_FRAME_LIMIT
, 0);
714 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans
*trans
)
716 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
717 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
719 return trans
->ops
->wait_tx_queue_empty(trans
);
722 static inline int iwl_trans_dbgfs_register(struct iwl_trans
*trans
,
725 return trans
->ops
->dbgfs_register(trans
, dir
);
728 static inline void iwl_trans_write8(struct iwl_trans
*trans
, u32 ofs
, u8 val
)
730 trans
->ops
->write8(trans
, ofs
, val
);
733 static inline void iwl_trans_write32(struct iwl_trans
*trans
, u32 ofs
, u32 val
)
735 trans
->ops
->write32(trans
, ofs
, val
);
738 static inline u32
iwl_trans_read32(struct iwl_trans
*trans
, u32 ofs
)
740 return trans
->ops
->read32(trans
, ofs
);
743 static inline u32
iwl_trans_read_prph(struct iwl_trans
*trans
, u32 ofs
)
745 return trans
->ops
->read_prph(trans
, ofs
);
748 static inline void iwl_trans_write_prph(struct iwl_trans
*trans
, u32 ofs
,
751 return trans
->ops
->write_prph(trans
, ofs
, val
);
754 static inline int iwl_trans_read_mem(struct iwl_trans
*trans
, u32 addr
,
755 void *buf
, int dwords
)
757 return trans
->ops
->read_mem(trans
, addr
, buf
, dwords
);
760 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
762 if (__builtin_constant_p(bufsize)) \
763 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
764 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
767 static inline u32
iwl_trans_read_mem32(struct iwl_trans
*trans
, u32 addr
)
771 if (WARN_ON(iwl_trans_read_mem(trans
, addr
, &value
, 1)))
777 static inline int iwl_trans_write_mem(struct iwl_trans
*trans
, u32 addr
,
778 const void *buf
, int dwords
)
780 return trans
->ops
->write_mem(trans
, addr
, buf
, dwords
);
783 static inline u32
iwl_trans_write_mem32(struct iwl_trans
*trans
, u32 addr
,
786 return iwl_trans_write_mem(trans
, addr
, &val
, 1);
789 static inline void iwl_trans_set_pmi(struct iwl_trans
*trans
, bool state
)
791 if (trans
->ops
->set_pmi
)
792 trans
->ops
->set_pmi(trans
, state
);
796 iwl_trans_set_bits_mask(struct iwl_trans
*trans
, u32 reg
, u32 mask
, u32 value
)
798 trans
->ops
->set_bits_mask(trans
, reg
, mask
, value
);
801 #define iwl_trans_grab_nic_access(trans, silent, flags) \
802 __cond_lock(nic_access, \
803 likely((trans)->ops->grab_nic_access(trans, silent, flags)))
805 static inline void __releases(nic_access
)
806 iwl_trans_release_nic_access(struct iwl_trans
*trans
, unsigned long *flags
)
808 trans
->ops
->release_nic_access(trans
, flags
);
809 __release(nic_access
);
812 static inline void iwl_trans_fw_error(struct iwl_trans
*trans
)
814 if (WARN_ON_ONCE(!trans
->op_mode
))
817 /* prevent double restarts due to the same erroneous FW */
818 if (!test_and_set_bit(STATUS_FW_ERROR
, &trans
->status
))
819 iwl_op_mode_nic_error(trans
->op_mode
);
822 /*****************************************************
823 * driver (transport) register/unregister functions
824 ******************************************************/
825 int __must_check
iwl_pci_register_driver(void);
826 void iwl_pci_unregister_driver(void);
828 static inline void trans_lockdep_init(struct iwl_trans
*trans
)
830 #ifdef CONFIG_LOCKDEP
831 static struct lock_class_key __key
;
833 lockdep_init_map(&trans
->sync_cmd_lockdep_map
, "sync_cmd_lockdep_map",
838 #endif /* __iwl_trans_h__ */