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_ASYNC: Return right away and don't wait for the response
193 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of
194 * the response. The caller needs to call iwl_free_resp when done.
195 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
196 * command queue, but after other high priority commands. valid only
198 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
199 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
200 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
201 * (i.e. mark it as non-idle).
205 CMD_WANT_SKB = BIT(1),
206 CMD_SEND_IN_RFKILL = BIT(2),
207 CMD_HIGH_PRIO = BIT(3),
208 CMD_SEND_IN_IDLE = BIT(4),
209 CMD_MAKE_TRANS_IDLE = BIT(5),
210 CMD_WAKE_UP_TRANS = BIT(6),
213 #define DEF_CMD_PAYLOAD_SIZE 320
216 * struct iwl_device_cmd
218 * For allocation of the command and tx queues, this establishes the overall
219 * size of the largest command we send to uCode, except for commands that
220 * aren't fully copied and use other TFD space.
222 struct iwl_device_cmd {
223 struct iwl_cmd_header hdr; /* uCode API */
224 u8 payload[DEF_CMD_PAYLOAD_SIZE];
227 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
230 * number of transfer buffers (fragments) per transmit frame descriptor;
231 * this is just the driver's idea, the hardware supports 20
233 #define IWL_MAX_CMD_TBS_PER_TFD 2
236 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
238 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
239 * ring. The transport layer doesn't map the command's buffer to DMA, but
240 * rather copies it to a previously allocated DMA buffer. This flag tells
241 * the transport layer not to copy the command, but to map the existing
242 * buffer (that is passed in) instead. This saves the memcpy and allows
243 * commands that are bigger than the fixed buffer to be submitted.
244 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
245 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
246 * chunk internally and free it again after the command completes. This
247 * can (currently) be used only once per command.
248 * Note that a TFD entry after a DUP one cannot be a normal copied one.
250 enum iwl_hcmd_dataflag {
251 IWL_HCMD_DFL_NOCOPY = BIT(0),
252 IWL_HCMD_DFL_DUP = BIT(1),
256 * struct iwl_host_cmd - Host command to the uCode
258 * @data: array of chunks that composes the data of the host command
259 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
260 * @_rx_page_order: (internally used to free response packet)
261 * @_rx_page_addr: (internally used to free response packet)
262 * @handler_status: return value of the handler of the command
263 * (put in setup_rx_handlers) - valid for SYNC mode only
264 * @flags: can be CMD_*
265 * @len: array of the lengths of the chunks in data
266 * @dataflags: IWL_HCMD_DFL_*
267 * @id: id of the host command
269 struct iwl_host_cmd {
270 const void *data[IWL_MAX_CMD_TBS_PER_TFD];
271 struct iwl_rx_packet *resp_pkt;
272 unsigned long _rx_page_addr;
277 u16 len[IWL_MAX_CMD_TBS_PER_TFD];
278 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
282 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
284 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
287 struct iwl_rx_cmd_buffer {
292 unsigned int truesize;
295 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
297 return (void *)((unsigned long)page_address(r->_page) + r->_offset);
300 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
305 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
307 r->_page_stolen = true;
312 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
314 __free_pages(r->_page, r->_rx_page_order);
317 #define MAX_NO_RECLAIM_CMDS 6
319 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
322 * Maximum number of HW queues the transport layer
325 #define IWL_MAX_HW_QUEUES 32
326 #define IWL_MAX_TID_COUNT 8
327 #define IWL_FRAME_LIMIT 64
330 * enum iwl_wowlan_status - WoWLAN image/device status
331 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
332 * @IWL_D3_STATUS_RESET: device was reset while suspended
340 * enum iwl_trans_status: transport status flags
341 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
342 * @STATUS_DEVICE_ENABLED: APM is enabled
343 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
344 * @STATUS_INT_ENABLED: interrupts are enabled
345 * @STATUS_RFKILL: the HW RFkill switch is in KILL position
346 * @STATUS_FW_ERROR: the fw is in error state
347 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
349 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
351 enum iwl_trans_status {
352 STATUS_SYNC_HCMD_ACTIVE,
353 STATUS_DEVICE_ENABLED,
358 STATUS_TRANS_GOING_IDLE,
363 * struct iwl_trans_config - transport configuration
365 * @op_mode: pointer to the upper layer.
366 * @cmd_queue: the index of the command queue.
367 * Must be set before start_fw.
368 * @cmd_fifo: the fifo for host commands
369 * @no_reclaim_cmds: Some devices erroneously don't set the
370 * SEQ_RX_FRAME bit on some notifications, this is the
371 * list of such notifications to filter. Max length is
372 * %MAX_NO_RECLAIM_CMDS.
373 * @n_no_reclaim_cmds: # of commands in list
374 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
375 * if unset 4k will be the RX buffer size
376 * @bc_table_dword: set to true if the BC table expects the byte count to be
377 * in DWORD (as opposed to bytes)
378 * @queue_watchdog_timeout: time (in ms) after which queues
379 * are considered stuck and will trigger device restart
380 * @command_names: array of command names, must be 256 entries
381 * (one for each command); for debugging only
383 struct iwl_trans_config {
384 struct iwl_op_mode *op_mode;
388 const u8 *no_reclaim_cmds;
389 unsigned int n_no_reclaim_cmds;
393 unsigned int queue_watchdog_timeout;
394 const char *const *command_names;
397 struct iwl_trans_dump_data {
404 struct iwl_trans_txq_scd_cfg {
412 * struct iwl_trans_ops - transport specific operations
414 * All the handlers MUST be implemented
416 * @start_hw: starts the HW- from that point on, the HW can send interrupts
418 * @op_mode_leave: Turn off the HW RF kill indication if on
420 * @start_fw: allocates and inits all the resources for the transport
421 * layer. Also kick a fw image.
423 * @fw_alive: called when the fw sends alive notification. If the fw provides
424 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
426 * @stop_device: stops the whole device (embedded CPU put to reset) and stops
427 * the HW. From that point on, the HW will be in low power but will still
428 * issue interrupt if the HW RF kill is triggered. This callback must do
429 * the right thing and not crash even if start_hw() was called but not
430 * start_fw(). May sleep
431 * @d3_suspend: put the device into the correct mode for WoWLAN during
432 * suspend. This is optional, if not implemented WoWLAN will not be
433 * supported. This callback may sleep.
434 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
435 * talk to the WoWLAN image to get its status. This is optional, if not
436 * implemented WoWLAN will not be supported. This callback may sleep.
437 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
438 * If RFkill is asserted in the middle of a SYNC host command, it must
439 * return -ERFKILL straight away.
440 * May sleep only if CMD_ASYNC is not set
443 * @reclaim: free packet until ssn. Returns a list of freed packets.
445 * @txq_enable: setup a queue. To setup an AC queue, use the
446 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
447 * this one. The op_mode must not configure the HCMD queue. The scheduler
448 * configuration may be %NULL, in which case the hardware will not be
449 * configured. May sleep.
450 * @txq_disable: de-configure a Tx queue to send AMPDUs
452 * @wait_tx_queue_empty: wait until tx queues are empty. May sleep.
453 * @dbgfs_register: add the dbgfs files under this directory. Files will be
454 * automatically deleted.
455 * @write8: write a u8 to a register at offset ofs from the BAR
456 * @write32: write a u32 to a register at offset ofs from the BAR
457 * @read32: read a u32 register at offset ofs from the BAR
458 * @read_prph: read a DWORD from a periphery register
459 * @write_prph: write a DWORD to a periphery register
460 * @read_mem: read device's SRAM in DWORD
461 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
463 * @configure: configure parameters required by the transport layer from
464 * the op_mode. May be called several times before start_fw, can't be
466 * @set_pmi: set the power pmi state
467 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
468 * Sleeping is not allowed between grab_nic_access and
469 * release_nic_access.
470 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
471 * must be the same one that was sent before to the grab_nic_access.
472 * @set_bits_mask - set SRAM register according to value and mask.
473 * @ref: grab a reference to the transport/FW layers, disallowing
474 * certain low power states
475 * @unref: release a reference previously taken with @ref. Note that
476 * initially the reference count is 1, making an initial @unref
477 * necessary to allow low power states.
478 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last
479 * TX'ed commands and similar. The buffer will be vfree'd by the caller.
480 * Note that the transport must fill in the proper file headers.
482 struct iwl_trans_ops {
484 int (*start_hw)(struct iwl_trans *iwl_trans);
485 void (*op_mode_leave)(struct iwl_trans *iwl_trans);
486 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
488 int (*update_sf)(struct iwl_trans *trans,
489 struct iwl_sf_region *st_fwrd_space);
490 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
491 void (*stop_device)(struct iwl_trans *trans);
493 void (*d3_suspend)(struct iwl_trans *trans, bool test);
494 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status,
497 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
499 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
500 struct iwl_device_cmd *dev_cmd, int queue);
501 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
502 struct sk_buff_head *skbs);
504 void (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn,
505 const struct iwl_trans_txq_scd_cfg *cfg);
506 void (*txq_disable)(struct iwl_trans *trans, int queue,
509 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
510 int (*wait_tx_queue_empty)(struct iwl_trans *trans, u32 txq_bm);
512 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
513 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
514 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
515 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
516 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
517 int (*read_mem)(struct iwl_trans *trans, u32 addr,
518 void *buf, int dwords);
519 int (*write_mem)(struct iwl_trans *trans, u32 addr,
520 const void *buf, int dwords);
521 void (*configure)(struct iwl_trans *trans,
522 const struct iwl_trans_config *trans_cfg);
523 void (*set_pmi)(struct iwl_trans *trans, bool state);
524 bool (*grab_nic_access)(struct iwl_trans *trans, bool silent,
525 unsigned long *flags);
526 void (*release_nic_access)(struct iwl_trans *trans,
527 unsigned long *flags);
528 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
530 void (*ref)(struct iwl_trans *trans);
531 void (*unref)(struct iwl_trans *trans);
533 #ifdef CONFIG_IWLWIFI_DEBUGFS
534 struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans);
539 * enum iwl_trans_state - state of the transport layer
541 * @IWL_TRANS_NO_FW: no fw has sent an alive response
542 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
544 enum iwl_trans_state {
546 IWL_TRANS_FW_ALIVE = 1,
550 * struct iwl_trans - transport common data
552 * @ops - pointer to iwl_trans_ops
553 * @op_mode - pointer to the op_mode
554 * @cfg - pointer to the configuration
555 * @status: a bit-mask of transport status flags
556 * @dev - pointer to struct device * that represents the device
557 * @hw_id: a u32 with the ID of the device / subdevice.
558 * Set during transport allocation.
559 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
560 * @pm_support: set to true in start_hw if link pm is supported
561 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
562 * The user should use iwl_trans_{alloc,free}_tx_cmd.
563 * @dev_cmd_headroom: room needed for the transport's private use before the
564 * device_cmd for Tx - for internal use only
565 * The user should use iwl_trans_{alloc,free}_tx_cmd.
566 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
567 * starting the firmware, used for tracing
568 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
569 * start of the 802.11 header in the @rx_mpdu_cmd
570 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
573 const struct iwl_trans_ops *ops;
574 struct iwl_op_mode *op_mode;
575 const struct iwl_cfg *cfg;
576 enum iwl_trans_state state;
577 unsigned long status;
584 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
588 /* The following fields are internal only */
589 struct kmem_cache *dev_cmd_pool;
590 size_t dev_cmd_headroom;
591 char dev_cmd_pool_name[50];
593 struct dentry *dbgfs_dir;
595 #ifdef CONFIG_LOCKDEP
596 struct lockdep_map sync_cmd_lockdep_map;
601 /* pointer to trans specific struct */
602 /*Ensure that this pointer will always be aligned to sizeof pointer */
603 char trans_specific[0] __aligned(sizeof(void *));
606 static inline void iwl_trans_configure(struct iwl_trans *trans,
607 const struct iwl_trans_config *trans_cfg)
609 trans->op_mode = trans_cfg->op_mode;
611 trans->ops->configure(trans, trans_cfg);
614 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
618 return trans->ops->start_hw(trans);
621 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans)
625 if (trans->ops->op_mode_leave)
626 trans->ops->op_mode_leave(trans);
628 trans->op_mode = NULL;
630 trans->state = IWL_TRANS_NO_FW;
633 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
637 trans->state = IWL_TRANS_FW_ALIVE;
639 trans->ops->fw_alive(trans, scd_addr);
642 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
643 const struct fw_img *fw,
648 WARN_ON_ONCE(!trans->rx_mpdu_cmd);
650 clear_bit(STATUS_FW_ERROR, &trans->status);
651 return trans->ops->start_fw(trans, fw, run_in_rfkill);
654 static inline int iwl_trans_update_sf(struct iwl_trans *trans,
655 struct iwl_sf_region *st_fwrd_space)
659 if (trans->ops->update_sf)
660 return trans->ops->update_sf(trans, st_fwrd_space);
665 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
669 trans->ops->stop_device(trans);
671 trans->state = IWL_TRANS_NO_FW;
674 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test)
677 trans->ops->d3_suspend(trans, test);
680 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
681 enum iwl_d3_status *status,
685 return trans->ops->d3_resume(trans, status, test);
688 static inline void iwl_trans_ref(struct iwl_trans *trans)
691 trans->ops->ref(trans);
694 static inline void iwl_trans_unref(struct iwl_trans *trans)
696 if (trans->ops->unref)
697 trans->ops->unref(trans);
700 #ifdef CONFIG_IWLWIFI_DEBUGFS
701 static inline struct iwl_trans_dump_data *
702 iwl_trans_dump_data(struct iwl_trans *trans)
704 if (!trans->ops->dump_data)
706 return trans->ops->dump_data(trans);
710 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
711 struct iwl_host_cmd *cmd)
715 if (unlikely(!(cmd->flags & CMD_SEND_IN_RFKILL) &&
716 test_bit(STATUS_RFKILL, &trans->status)))
719 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
722 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) {
723 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
727 if (!(cmd->flags & CMD_ASYNC))
728 lock_map_acquire_read(&trans->sync_cmd_lockdep_map);
730 ret = trans->ops->send_cmd(trans, cmd);
732 if (!(cmd->flags & CMD_ASYNC))
733 lock_map_release(&trans->sync_cmd_lockdep_map);
738 static inline struct iwl_device_cmd *
739 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
741 u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
743 if (unlikely(dev_cmd_ptr == NULL))
746 return (struct iwl_device_cmd *)
747 (dev_cmd_ptr + trans->dev_cmd_headroom);
750 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
751 struct iwl_device_cmd *dev_cmd)
753 u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom;
755 kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr);
758 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
759 struct iwl_device_cmd *dev_cmd, int queue)
761 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
764 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
765 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
767 return trans->ops->tx(trans, skb, dev_cmd, queue);
770 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
771 int ssn, struct sk_buff_head *skbs)
773 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
774 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
776 trans->ops->reclaim(trans, queue, ssn, skbs);
779 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue,
782 trans->ops->txq_disable(trans, queue, configure_scd);
786 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn,
787 const struct iwl_trans_txq_scd_cfg *cfg)
791 if (unlikely((trans->state != IWL_TRANS_FW_ALIVE)))
792 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
794 trans->ops->txq_enable(trans, queue, ssn, cfg);
797 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
798 int fifo, int sta_id, int tid,
799 int frame_limit, u16 ssn)
801 struct iwl_trans_txq_scd_cfg cfg = {
805 .frame_limit = frame_limit,
808 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg);
811 static inline void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue,
814 struct iwl_trans_txq_scd_cfg cfg = {
817 .tid = IWL_MAX_TID_COUNT,
818 .frame_limit = IWL_FRAME_LIMIT,
821 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg);
825 iwl_trans_txq_enable_no_scd(struct iwl_trans *trans, int queue, u16 ssn)
827 iwl_trans_txq_enable_cfg(trans, queue, ssn, NULL);
830 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans,
833 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
834 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
836 return trans->ops->wait_tx_queue_empty(trans, txq_bm);
839 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
842 return trans->ops->dbgfs_register(trans, dir);
845 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
847 trans->ops->write8(trans, ofs, val);
850 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
852 trans->ops->write32(trans, ofs, val);
855 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
857 return trans->ops->read32(trans, ofs);
860 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
862 return trans->ops->read_prph(trans, ofs);
865 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
868 return trans->ops->write_prph(trans, ofs, val);
871 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
872 void *buf, int dwords)
874 return trans->ops->read_mem(trans, addr, buf, dwords);
877 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
879 if (__builtin_constant_p(bufsize)) \
880 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
881 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
884 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
888 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
894 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
895 const void *buf, int dwords)
897 return trans->ops->write_mem(trans, addr, buf, dwords);
900 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
903 return iwl_trans_write_mem(trans, addr, &val, 1);
906 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
908 if (trans->ops->set_pmi)
909 trans->ops->set_pmi(trans, state);
913 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
915 trans->ops->set_bits_mask(trans, reg, mask, value);
918 #define iwl_trans_grab_nic_access(trans, silent, flags) \
919 __cond_lock(nic_access, \
920 likely((trans)->ops->grab_nic_access(trans, silent, flags)))
922 static inline void __releases(nic_access)
923 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
925 trans->ops->release_nic_access(trans, flags);
926 __release(nic_access);
929 static inline void iwl_trans_fw_error(struct iwl_trans *trans)
931 if (WARN_ON_ONCE(!trans->op_mode))
934 /* prevent double restarts due to the same erroneous FW */
935 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status))
936 iwl_op_mode_nic_error(trans->op_mode);
939 /*****************************************************
940 * driver (transport) register/unregister functions
941 ******************************************************/
942 int __must_check iwl_pci_register_driver(void);
943 void iwl_pci_unregister_driver(void);
945 static inline void trans_lockdep_init(struct iwl_trans *trans)
947 #ifdef CONFIG_LOCKDEP
948 static struct lock_class_key __key;
950 lockdep_init_map(&trans->sync_cmd_lockdep_map, "sync_cmd_lockdep_map",
955 #endif /* __iwl_trans_h__ */