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
;
179 static inline u32
iwl_rx_packet_len(const struct iwl_rx_packet
*pkt
)
181 return le32_to_cpu(pkt
->len_n_flags
) & FH_RSCSR_FRAME_SIZE_MSK
;
184 static inline u32
iwl_rx_packet_payload_len(const struct iwl_rx_packet
*pkt
)
186 return iwl_rx_packet_len(pkt
) - sizeof(pkt
->hdr
);
190 * enum CMD_MODE - how to send the host commands ?
192 * @CMD_SYNC: The caller will be stalled until the fw responds to the command
193 * @CMD_ASYNC: Return right away and don't wait for the response
194 * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
195 * response. The caller needs to call iwl_free_resp when done.
196 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
197 * command queue, but after other high priority commands. valid only
199 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
200 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
201 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
202 * (i.e. mark it as non-idle).
207 CMD_WANT_SKB
= BIT(1),
208 CMD_SEND_IN_RFKILL
= BIT(2),
209 CMD_HIGH_PRIO
= BIT(3),
210 CMD_SEND_IN_IDLE
= BIT(4),
211 CMD_MAKE_TRANS_IDLE
= BIT(5),
212 CMD_WAKE_UP_TRANS
= BIT(6),
215 #define DEF_CMD_PAYLOAD_SIZE 320
218 * struct iwl_device_cmd
220 * For allocation of the command and tx queues, this establishes the overall
221 * size of the largest command we send to uCode, except for commands that
222 * aren't fully copied and use other TFD space.
224 struct iwl_device_cmd
{
225 struct iwl_cmd_header hdr
; /* uCode API */
226 u8 payload
[DEF_CMD_PAYLOAD_SIZE
];
229 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
232 * number of transfer buffers (fragments) per transmit frame descriptor;
233 * this is just the driver's idea, the hardware supports 20
235 #define IWL_MAX_CMD_TBS_PER_TFD 2
238 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
240 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
241 * ring. The transport layer doesn't map the command's buffer to DMA, but
242 * rather copies it to a previously allocated DMA buffer. This flag tells
243 * the transport layer not to copy the command, but to map the existing
244 * buffer (that is passed in) instead. This saves the memcpy and allows
245 * commands that are bigger than the fixed buffer to be submitted.
246 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
247 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
248 * chunk internally and free it again after the command completes. This
249 * can (currently) be used only once per command.
250 * Note that a TFD entry after a DUP one cannot be a normal copied one.
252 enum iwl_hcmd_dataflag
{
253 IWL_HCMD_DFL_NOCOPY
= BIT(0),
254 IWL_HCMD_DFL_DUP
= BIT(1),
258 * struct iwl_host_cmd - Host command to the uCode
260 * @data: array of chunks that composes the data of the host command
261 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
262 * @_rx_page_order: (internally used to free response packet)
263 * @_rx_page_addr: (internally used to free response packet)
264 * @handler_status: return value of the handler of the command
265 * (put in setup_rx_handlers) - valid for SYNC mode only
266 * @flags: can be CMD_*
267 * @len: array of the lengths of the chunks in data
268 * @dataflags: IWL_HCMD_DFL_*
269 * @id: id of the host command
271 struct iwl_host_cmd
{
272 const void *data
[IWL_MAX_CMD_TBS_PER_TFD
];
273 struct iwl_rx_packet
*resp_pkt
;
274 unsigned long _rx_page_addr
;
279 u16 len
[IWL_MAX_CMD_TBS_PER_TFD
];
280 u8 dataflags
[IWL_MAX_CMD_TBS_PER_TFD
];
284 static inline void iwl_free_resp(struct iwl_host_cmd
*cmd
)
286 free_pages(cmd
->_rx_page_addr
, cmd
->_rx_page_order
);
289 struct iwl_rx_cmd_buffer
{
294 unsigned int truesize
;
297 static inline void *rxb_addr(struct iwl_rx_cmd_buffer
*r
)
299 return (void *)((unsigned long)page_address(r
->_page
) + r
->_offset
);
302 static inline int rxb_offset(struct iwl_rx_cmd_buffer
*r
)
307 static inline struct page
*rxb_steal_page(struct iwl_rx_cmd_buffer
*r
)
309 r
->_page_stolen
= true;
314 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer
*r
)
316 __free_pages(r
->_page
, r
->_rx_page_order
);
319 #define MAX_NO_RECLAIM_CMDS 6
321 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
324 * Maximum number of HW queues the transport layer
327 #define IWL_MAX_HW_QUEUES 32
328 #define IWL_MAX_TID_COUNT 8
329 #define IWL_FRAME_LIMIT 64
332 * enum iwl_wowlan_status - WoWLAN image/device status
333 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
334 * @IWL_D3_STATUS_RESET: device was reset while suspended
342 * enum iwl_trans_status: transport status flags
343 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
344 * @STATUS_DEVICE_ENABLED: APM is enabled
345 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
346 * @STATUS_INT_ENABLED: interrupts are enabled
347 * @STATUS_RFKILL: the HW RFkill switch is in KILL position
348 * @STATUS_FW_ERROR: the fw is in error state
349 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
351 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
353 enum iwl_trans_status
{
354 STATUS_SYNC_HCMD_ACTIVE
,
355 STATUS_DEVICE_ENABLED
,
360 STATUS_TRANS_GOING_IDLE
,
365 * struct iwl_trans_config - transport configuration
367 * @op_mode: pointer to the upper layer.
368 * @cmd_queue: the index of the command queue.
369 * Must be set before start_fw.
370 * @cmd_fifo: the fifo for host commands
371 * @no_reclaim_cmds: Some devices erroneously don't set the
372 * SEQ_RX_FRAME bit on some notifications, this is the
373 * list of such notifications to filter. Max length is
374 * %MAX_NO_RECLAIM_CMDS.
375 * @n_no_reclaim_cmds: # of commands in list
376 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
377 * if unset 4k will be the RX buffer size
378 * @bc_table_dword: set to true if the BC table expects the byte count to be
379 * in DWORD (as opposed to bytes)
380 * @queue_watchdog_timeout: time (in ms) after which queues
381 * are considered stuck and will trigger device restart
382 * @command_names: array of command names, must be 256 entries
383 * (one for each command); for debugging only
385 struct iwl_trans_config
{
386 struct iwl_op_mode
*op_mode
;
390 const u8
*no_reclaim_cmds
;
391 unsigned int n_no_reclaim_cmds
;
395 unsigned int queue_watchdog_timeout
;
396 const char *const *command_names
;
402 * struct iwl_trans_ops - transport specific operations
404 * All the handlers MUST be implemented
406 * @start_hw: starts the HW- from that point on, the HW can send interrupts
408 * @op_mode_leave: Turn off the HW RF kill indication if on
410 * @start_fw: allocates and inits all the resources for the transport
411 * layer. Also kick a fw image.
413 * @fw_alive: called when the fw sends alive notification. If the fw provides
414 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
416 * @stop_device: stops the whole device (embedded CPU put to reset) and stops
417 * the HW. From that point on, the HW will be in low power but will still
418 * issue interrupt if the HW RF kill is triggered. This callback must do
419 * the right thing and not crash even if start_hw() was called but not
420 * start_fw(). May sleep
421 * @d3_suspend: put the device into the correct mode for WoWLAN during
422 * suspend. This is optional, if not implemented WoWLAN will not be
423 * supported. This callback may sleep.
424 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
425 * talk to the WoWLAN image to get its status. This is optional, if not
426 * implemented WoWLAN will not be supported. This callback may sleep.
427 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
428 * If RFkill is asserted in the middle of a SYNC host command, it must
429 * return -ERFKILL straight away.
430 * May sleep only if CMD_SYNC is set
433 * @reclaim: free packet until ssn. Returns a list of freed packets.
435 * @txq_enable: setup a queue. To setup an AC queue, use the
436 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
437 * this one. The op_mode must not configure the HCMD queue. May sleep.
438 * @txq_disable: de-configure a Tx queue to send AMPDUs
440 * @wait_tx_queue_empty: wait until tx queues are empty. May sleep.
441 * @dbgfs_register: add the dbgfs files under this directory. Files will be
442 * automatically deleted.
443 * @write8: write a u8 to a register at offset ofs from the BAR
444 * @write32: write a u32 to a register at offset ofs from the BAR
445 * @read32: read a u32 register at offset ofs from the BAR
446 * @read_prph: read a DWORD from a periphery register
447 * @write_prph: write a DWORD to a periphery register
448 * @read_mem: read device's SRAM in DWORD
449 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
451 * @configure: configure parameters required by the transport layer from
452 * the op_mode. May be called several times before start_fw, can't be
454 * @set_pmi: set the power pmi state
455 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
456 * Sleeping is not allowed between grab_nic_access and
457 * release_nic_access.
458 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
459 * must be the same one that was sent before to the grab_nic_access.
460 * @set_bits_mask - set SRAM register according to value and mask.
461 * @ref: grab a reference to the transport/FW layers, disallowing
462 * certain low power states
463 * @unref: release a reference previously taken with @ref. Note that
464 * initially the reference count is 1, making an initial @unref
465 * necessary to allow low power states.
466 * @dump_data: fill a data dump with debug data, maybe containing last
467 * TX'ed commands and similar. When called with a NULL buffer and
468 * zero buffer length, provide only the (estimated) required buffer
469 * length. Return the used buffer length.
470 * Note that the transport must fill in the proper file headers.
472 struct iwl_trans_ops
{
474 int (*start_hw
)(struct iwl_trans
*iwl_trans
);
475 void (*op_mode_leave
)(struct iwl_trans
*iwl_trans
);
476 int (*start_fw
)(struct iwl_trans
*trans
, const struct fw_img
*fw
,
478 void (*fw_alive
)(struct iwl_trans
*trans
, u32 scd_addr
);
479 void (*stop_device
)(struct iwl_trans
*trans
);
481 void (*d3_suspend
)(struct iwl_trans
*trans
, bool test
);
482 int (*d3_resume
)(struct iwl_trans
*trans
, enum iwl_d3_status
*status
,
485 int (*send_cmd
)(struct iwl_trans
*trans
, struct iwl_host_cmd
*cmd
);
487 int (*tx
)(struct iwl_trans
*trans
, struct sk_buff
*skb
,
488 struct iwl_device_cmd
*dev_cmd
, int queue
);
489 void (*reclaim
)(struct iwl_trans
*trans
, int queue
, int ssn
,
490 struct sk_buff_head
*skbs
);
492 void (*txq_enable
)(struct iwl_trans
*trans
, int queue
, int fifo
,
493 int sta_id
, int tid
, int frame_limit
, u16 ssn
);
494 void (*txq_disable
)(struct iwl_trans
*trans
, int queue
);
496 int (*dbgfs_register
)(struct iwl_trans
*trans
, struct dentry
* dir
);
497 int (*wait_tx_queue_empty
)(struct iwl_trans
*trans
, u32 txq_bm
);
499 void (*write8
)(struct iwl_trans
*trans
, u32 ofs
, u8 val
);
500 void (*write32
)(struct iwl_trans
*trans
, u32 ofs
, u32 val
);
501 u32 (*read32
)(struct iwl_trans
*trans
, u32 ofs
);
502 u32 (*read_prph
)(struct iwl_trans
*trans
, u32 ofs
);
503 void (*write_prph
)(struct iwl_trans
*trans
, u32 ofs
, u32 val
);
504 int (*read_mem
)(struct iwl_trans
*trans
, u32 addr
,
505 void *buf
, int dwords
);
506 int (*write_mem
)(struct iwl_trans
*trans
, u32 addr
,
507 const void *buf
, int dwords
);
508 void (*configure
)(struct iwl_trans
*trans
,
509 const struct iwl_trans_config
*trans_cfg
);
510 void (*set_pmi
)(struct iwl_trans
*trans
, bool state
);
511 bool (*grab_nic_access
)(struct iwl_trans
*trans
, bool silent
,
512 unsigned long *flags
);
513 void (*release_nic_access
)(struct iwl_trans
*trans
,
514 unsigned long *flags
);
515 void (*set_bits_mask
)(struct iwl_trans
*trans
, u32 reg
, u32 mask
,
517 void (*ref
)(struct iwl_trans
*trans
);
518 void (*unref
)(struct iwl_trans
*trans
);
520 #ifdef CONFIG_IWLWIFI_DEBUGFS
521 u32 (*dump_data
)(struct iwl_trans
*trans
, void *buf
, u32 buflen
);
526 * enum iwl_trans_state - state of the transport layer
528 * @IWL_TRANS_NO_FW: no fw has sent an alive response
529 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
531 enum iwl_trans_state
{
533 IWL_TRANS_FW_ALIVE
= 1,
537 * struct iwl_trans - transport common data
539 * @ops - pointer to iwl_trans_ops
540 * @op_mode - pointer to the op_mode
541 * @cfg - pointer to the configuration
542 * @status: a bit-mask of transport status flags
543 * @dev - pointer to struct device * that represents the device
544 * @hw_id: a u32 with the ID of the device / subdevice.
545 * Set during transport allocation.
546 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
547 * @pm_support: set to true in start_hw if link pm is supported
548 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
549 * The user should use iwl_trans_{alloc,free}_tx_cmd.
550 * @dev_cmd_headroom: room needed for the transport's private use before the
551 * device_cmd for Tx - for internal use only
552 * The user should use iwl_trans_{alloc,free}_tx_cmd.
553 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
554 * starting the firmware, used for tracing
555 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
556 * start of the 802.11 header in the @rx_mpdu_cmd
557 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
560 const struct iwl_trans_ops
*ops
;
561 struct iwl_op_mode
*op_mode
;
562 const struct iwl_cfg
*cfg
;
563 enum iwl_trans_state state
;
564 unsigned long status
;
571 u8 rx_mpdu_cmd
, rx_mpdu_cmd_hdr_size
;
575 /* The following fields are internal only */
576 struct kmem_cache
*dev_cmd_pool
;
577 size_t dev_cmd_headroom
;
578 char dev_cmd_pool_name
[50];
580 struct dentry
*dbgfs_dir
;
582 #ifdef CONFIG_LOCKDEP
583 struct lockdep_map sync_cmd_lockdep_map
;
588 /* pointer to trans specific struct */
589 /*Ensure that this pointer will always be aligned to sizeof pointer */
590 char trans_specific
[0] __aligned(sizeof(void *));
593 static inline void iwl_trans_configure(struct iwl_trans
*trans
,
594 const struct iwl_trans_config
*trans_cfg
)
596 trans
->op_mode
= trans_cfg
->op_mode
;
598 trans
->ops
->configure(trans
, trans_cfg
);
601 static inline int iwl_trans_start_hw(struct iwl_trans
*trans
)
605 return trans
->ops
->start_hw(trans
);
608 static inline void iwl_trans_op_mode_leave(struct iwl_trans
*trans
)
612 if (trans
->ops
->op_mode_leave
)
613 trans
->ops
->op_mode_leave(trans
);
615 trans
->op_mode
= NULL
;
617 trans
->state
= IWL_TRANS_NO_FW
;
620 static inline void iwl_trans_fw_alive(struct iwl_trans
*trans
, u32 scd_addr
)
624 trans
->state
= IWL_TRANS_FW_ALIVE
;
626 trans
->ops
->fw_alive(trans
, scd_addr
);
629 static inline int iwl_trans_start_fw(struct iwl_trans
*trans
,
630 const struct fw_img
*fw
,
635 WARN_ON_ONCE(!trans
->rx_mpdu_cmd
);
637 clear_bit(STATUS_FW_ERROR
, &trans
->status
);
638 return trans
->ops
->start_fw(trans
, fw
, run_in_rfkill
);
641 static inline void iwl_trans_stop_device(struct iwl_trans
*trans
)
645 trans
->ops
->stop_device(trans
);
647 trans
->state
= IWL_TRANS_NO_FW
;
650 static inline void iwl_trans_d3_suspend(struct iwl_trans
*trans
, bool test
)
653 trans
->ops
->d3_suspend(trans
, test
);
656 static inline int iwl_trans_d3_resume(struct iwl_trans
*trans
,
657 enum iwl_d3_status
*status
,
661 return trans
->ops
->d3_resume(trans
, status
, test
);
664 static inline void iwl_trans_ref(struct iwl_trans
*trans
)
667 trans
->ops
->ref(trans
);
670 static inline void iwl_trans_unref(struct iwl_trans
*trans
)
672 if (trans
->ops
->unref
)
673 trans
->ops
->unref(trans
);
676 #ifdef CONFIG_IWLWIFI_DEBUGFS
677 static inline u32
iwl_trans_dump_data(struct iwl_trans
*trans
,
678 void *buf
, u32 buflen
)
680 if (!trans
->ops
->dump_data
)
682 return trans
->ops
->dump_data(trans
, buf
, buflen
);
686 static inline int iwl_trans_send_cmd(struct iwl_trans
*trans
,
687 struct iwl_host_cmd
*cmd
)
691 if (unlikely(!(cmd
->flags
& CMD_SEND_IN_RFKILL
) &&
692 test_bit(STATUS_RFKILL
, &trans
->status
)))
695 if (unlikely(test_bit(STATUS_FW_ERROR
, &trans
->status
)))
698 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
)) {
699 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
703 if (!(cmd
->flags
& CMD_ASYNC
))
704 lock_map_acquire_read(&trans
->sync_cmd_lockdep_map
);
706 ret
= trans
->ops
->send_cmd(trans
, cmd
);
708 if (!(cmd
->flags
& CMD_ASYNC
))
709 lock_map_release(&trans
->sync_cmd_lockdep_map
);
714 static inline struct iwl_device_cmd
*
715 iwl_trans_alloc_tx_cmd(struct iwl_trans
*trans
)
717 u8
*dev_cmd_ptr
= kmem_cache_alloc(trans
->dev_cmd_pool
, GFP_ATOMIC
);
719 if (unlikely(dev_cmd_ptr
== NULL
))
722 return (struct iwl_device_cmd
*)
723 (dev_cmd_ptr
+ trans
->dev_cmd_headroom
);
726 static inline void iwl_trans_free_tx_cmd(struct iwl_trans
*trans
,
727 struct iwl_device_cmd
*dev_cmd
)
729 u8
*dev_cmd_ptr
= (u8
*)dev_cmd
- trans
->dev_cmd_headroom
;
731 kmem_cache_free(trans
->dev_cmd_pool
, dev_cmd_ptr
);
734 static inline int iwl_trans_tx(struct iwl_trans
*trans
, struct sk_buff
*skb
,
735 struct iwl_device_cmd
*dev_cmd
, int queue
)
737 if (unlikely(test_bit(STATUS_FW_ERROR
, &trans
->status
)))
740 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
741 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
743 return trans
->ops
->tx(trans
, skb
, dev_cmd
, queue
);
746 static inline void iwl_trans_reclaim(struct iwl_trans
*trans
, int queue
,
747 int ssn
, struct sk_buff_head
*skbs
)
749 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
750 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
752 trans
->ops
->reclaim(trans
, queue
, ssn
, skbs
);
755 static inline void iwl_trans_txq_disable(struct iwl_trans
*trans
, int queue
)
757 trans
->ops
->txq_disable(trans
, queue
);
760 static inline void iwl_trans_txq_enable(struct iwl_trans
*trans
, int queue
,
761 int fifo
, int sta_id
, int tid
,
762 int frame_limit
, u16 ssn
)
766 if (unlikely((trans
->state
!= IWL_TRANS_FW_ALIVE
)))
767 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
769 trans
->ops
->txq_enable(trans
, queue
, fifo
, sta_id
, tid
,
773 static inline void iwl_trans_ac_txq_enable(struct iwl_trans
*trans
, int queue
,
776 iwl_trans_txq_enable(trans
, queue
, fifo
, -1,
777 IWL_MAX_TID_COUNT
, IWL_FRAME_LIMIT
, 0);
780 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans
*trans
,
783 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
784 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
786 return trans
->ops
->wait_tx_queue_empty(trans
, txq_bm
);
789 static inline int iwl_trans_dbgfs_register(struct iwl_trans
*trans
,
792 return trans
->ops
->dbgfs_register(trans
, dir
);
795 static inline void iwl_trans_write8(struct iwl_trans
*trans
, u32 ofs
, u8 val
)
797 trans
->ops
->write8(trans
, ofs
, val
);
800 static inline void iwl_trans_write32(struct iwl_trans
*trans
, u32 ofs
, u32 val
)
802 trans
->ops
->write32(trans
, ofs
, val
);
805 static inline u32
iwl_trans_read32(struct iwl_trans
*trans
, u32 ofs
)
807 return trans
->ops
->read32(trans
, ofs
);
810 static inline u32
iwl_trans_read_prph(struct iwl_trans
*trans
, u32 ofs
)
812 return trans
->ops
->read_prph(trans
, ofs
);
815 static inline void iwl_trans_write_prph(struct iwl_trans
*trans
, u32 ofs
,
818 return trans
->ops
->write_prph(trans
, ofs
, val
);
821 static inline int iwl_trans_read_mem(struct iwl_trans
*trans
, u32 addr
,
822 void *buf
, int dwords
)
824 return trans
->ops
->read_mem(trans
, addr
, buf
, dwords
);
827 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
829 if (__builtin_constant_p(bufsize)) \
830 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
831 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
834 static inline u32
iwl_trans_read_mem32(struct iwl_trans
*trans
, u32 addr
)
838 if (WARN_ON(iwl_trans_read_mem(trans
, addr
, &value
, 1)))
844 static inline int iwl_trans_write_mem(struct iwl_trans
*trans
, u32 addr
,
845 const void *buf
, int dwords
)
847 return trans
->ops
->write_mem(trans
, addr
, buf
, dwords
);
850 static inline u32
iwl_trans_write_mem32(struct iwl_trans
*trans
, u32 addr
,
853 return iwl_trans_write_mem(trans
, addr
, &val
, 1);
856 static inline void iwl_trans_set_pmi(struct iwl_trans
*trans
, bool state
)
858 if (trans
->ops
->set_pmi
)
859 trans
->ops
->set_pmi(trans
, state
);
863 iwl_trans_set_bits_mask(struct iwl_trans
*trans
, u32 reg
, u32 mask
, u32 value
)
865 trans
->ops
->set_bits_mask(trans
, reg
, mask
, value
);
868 #define iwl_trans_grab_nic_access(trans, silent, flags) \
869 __cond_lock(nic_access, \
870 likely((trans)->ops->grab_nic_access(trans, silent, flags)))
872 static inline void __releases(nic_access
)
873 iwl_trans_release_nic_access(struct iwl_trans
*trans
, unsigned long *flags
)
875 trans
->ops
->release_nic_access(trans
, flags
);
876 __release(nic_access
);
879 static inline void iwl_trans_fw_error(struct iwl_trans
*trans
)
881 if (WARN_ON_ONCE(!trans
->op_mode
))
884 /* prevent double restarts due to the same erroneous FW */
885 if (!test_and_set_bit(STATUS_FW_ERROR
, &trans
->status
))
886 iwl_op_mode_nic_error(trans
->op_mode
);
889 /*****************************************************
890 * driver (transport) register/unregister functions
891 ******************************************************/
892 int __must_check
iwl_pci_register_driver(void);
893 void iwl_pci_unregister_driver(void);
895 static inline void trans_lockdep_init(struct iwl_trans
*trans
)
897 #ifdef CONFIG_LOCKDEP
898 static struct lock_class_key __key
;
900 lockdep_init_map(&trans
->sync_cmd_lockdep_map
, "sync_cmd_lockdep_map",
905 #endif /* __iwl_trans_h__ */