drivers/net/wireless/iwlwifi/iwl-trans.h

   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 - 2013 Intel Corporation. All rights reserved.
   9  *
  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.
  13  *
  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.
  18  *
  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,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called LICENSE.GPL.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  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
  45  *    distribution.
  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.
  49  *
  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.
  61  *
  62  *****************************************************************************/
  63 #ifndef __iwl_trans_h__
  64 #define __iwl_trans_h__
  65
  66 #include <linux/ieee80211.h>
  67 #include <linux/mm.h> /* for page_address */
  68
  69 #include "iwl-debug.h"
  70 #include "iwl-config.h"
  71 #include "iwl-fw.h"
  72
  73 /**
  74  * DOC: Transport layer - what is it ?
  75  *
  76  * The tranport layer is the layer that deals with the HW directly. It provides
  77  * an abstraction of the underlying HW to the upper layer. The transport layer
  78  * doesn't provide any policy, algorithm or anything of this kind, but only
  79  * mechanisms to make the HW do something.It is not completely stateless but
  80  * close to it.
  81  * We will have an implementation for each different supported bus.
  82  */
  83
  84 /**
  85  * DOC: Life cycle of the transport layer
  86  *
  87  * The transport layer has a very precise life cycle.
  88  *
  89  *      1) A helper function is called during the module initialization and
  90  *         registers the bus driver's ops with the transport's alloc function.
  91  *      2) Bus's probe calls to the transport layer's allocation functions.
  92  *         Of course this function is bus specific.
  93  *      3) This allocation functions will spawn the upper layer which will
  94  *         register mac80211.
  95  *
  96  *      4) At some point (i.e. mac80211's start call), the op_mode will call
  97  *         the following sequence:
  98  *         start_hw
  99  *         start_fw
 100  *
 101  *      5) Then when finished (or reset):
 102  *         stop_fw (a.k.a. stop device for the moment)
 103  *         stop_hw
 104  *
 105  *      6) Eventually, the free function will be called.
 106  */
 107
 108 /**
 109  * DOC: Host command section
 110  *
 111  * A host command is a commaned issued by the upper layer to the fw. There are
 112  * several versions of fw that have several APIs. The transport layer is
 113  * completely agnostic to these differences.
 114  * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode),
 115  */
 116 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
 117 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
 118 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
 119 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
 120 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
 121 #define SEQ_TO_INDEX(s) ((s) & 0xff)
 122 #define INDEX_TO_SEQ(i) ((i) & 0xff)
 123 #define SEQ_RX_FRAME    cpu_to_le16(0x8000)
 124
 125 /**
 126  * struct iwl_cmd_header
 127  *
 128  * This header format appears in the beginning of each command sent from the
 129  * driver, and each response/notification received from uCode.
 130  */
 131 struct iwl_cmd_header {
 132         u8 cmd;         /* Command ID:  REPLY_RXON, etc. */
 133         u8 flags;       /* 0:5 reserved, 6 abort, 7 internal */
 134         /*
 135          * The driver sets up the sequence number to values of its choosing.
 136          * uCode does not use this value, but passes it back to the driver
 137          * when sending the response to each driver-originated command, so
 138          * the driver can match the response to the command.  Since the values
 139          * don't get used by uCode, the driver may set up an arbitrary format.
 140          *
 141          * There is one exception:  uCode sets bit 15 when it originates
 142          * the response/notification, i.e. when the response/notification
 143          * is not a direct response to a command sent by the driver.  For
 144          * example, uCode issues REPLY_RX when it sends a received frame
 145          * to the driver; it is not a direct response to any driver command.
 146          *
 147          * The Linux driver uses the following format:
 148          *
 149          *  0:7         tfd index - position within TX queue
 150          *  8:12        TX queue id
 151          *  13:14       reserved
 152          *  15          unsolicited RX or uCode-originated notification
 153          */
 154         __le16 sequence;
 155 } __packed;
 156
 157 /* iwl_cmd_header flags value */
 158 #define IWL_CMD_FAILED_MSK 0x40
 159
 160
 161 #define FH_RSCSR_FRAME_SIZE_MSK         0x00003FFF      /* bits 0-13 */
 162 #define FH_RSCSR_FRAME_INVALID          0x55550000
 163 #define FH_RSCSR_FRAME_ALIGN            0x40
 164
 165 struct iwl_rx_packet {
 166         /*
 167          * The first 4 bytes of the RX frame header contain both the RX frame
 168          * size and some flags.
 169          * Bit fields:
 170          * 31:    flag flush RB request
 171          * 30:    flag ignore TC (terminal counter) request
 172          * 29:    flag fast IRQ request
 173          * 28-14: Reserved
 174          * 13-00: RX frame size
 175          */
 176         __le32 len_n_flags;
 177         struct iwl_cmd_header hdr;
 178         u8 data[];
 179 } __packed;
 180
 181 /**
 182  * enum CMD_MODE - how to send the host commands ?
 183  *
 184  * @CMD_SYNC: The caller will be stalled until the fw responds to the command
 185  * @CMD_ASYNC: Return right away and don't want for the response
 186  * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
 187  *      response. The caller needs to call iwl_free_resp when done.
 188  * @CMD_WANT_HCMD: The caller needs to get the HCMD that was sent in the
 189  *      response handler. Chunks flagged by %IWL_HCMD_DFL_NOCOPY won't be
 190  *      copied. The pointer passed to the response handler is in the transport
 191  *      ownership and don't need to be freed by the op_mode. This also means
 192  *      that the pointer is invalidated after the op_mode's handler returns.
 193  * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
 194  */
 195 enum CMD_MODE {
 196         CMD_SYNC                = 0,
 197         CMD_ASYNC               = BIT(0),
 198         CMD_WANT_SKB            = BIT(1),
 199         CMD_WANT_HCMD           = BIT(2),
 200         CMD_ON_DEMAND           = BIT(3),
 201 };
 202
 203 #define DEF_CMD_PAYLOAD_SIZE 320
 204
 205 /**
 206  * struct iwl_device_cmd
 207  *
 208  * For allocation of the command and tx queues, this establishes the overall
 209  * size of the largest command we send to uCode, except for commands that
 210  * aren't fully copied and use other TFD space.
 211  */
 212 struct iwl_device_cmd {
 213         struct iwl_cmd_header hdr;      /* uCode API */
 214         u8 payload[DEF_CMD_PAYLOAD_SIZE];
 215 } __packed;
 216
 217 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
 218
 219 #define IWL_MAX_CMD_TFDS        2
 220
 221 /**
 222  * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
 223  *
 224  * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
 225  *      ring. The transport layer doesn't map the command's buffer to DMA, but
 226  *      rather copies it to an previously allocated DMA buffer. This flag tells
 227  *      the transport layer not to copy the command, but to map the existing
 228  *      buffer (that is passed in) instead. This saves the memcpy and allows
 229  *      commands that are bigger than the fixed buffer to be submitted.
 230  *      Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
 231  * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
 232  *      chunk internally and free it again after the command completes. This
 233  *      can (currently) be used only once per command.
 234  *      Note that a TFD entry after a DUP one cannot be a normal copied one.
 235  */
 236 enum iwl_hcmd_dataflag {
 237         IWL_HCMD_DFL_NOCOPY     = BIT(0),
 238         IWL_HCMD_DFL_DUP        = BIT(1),
 239 };
 240
 241 /**
 242  * struct iwl_host_cmd - Host command to the uCode
 243  *
 244  * @data: array of chunks that composes the data of the host command
 245  * @resp_pkt: response packet, if %CMD_WANT_SKB was set
 246  * @_rx_page_order: (internally used to free response packet)
 247  * @_rx_page_addr: (internally used to free response packet)
 248  * @handler_status: return value of the handler of the command
 249  *      (put in setup_rx_handlers) - valid for SYNC mode only
 250  * @flags: can be CMD_*
 251  * @len: array of the lenths of the chunks in data
 252  * @dataflags: IWL_HCMD_DFL_*
 253  * @id: id of the host command
 254  */
 255 struct iwl_host_cmd {
 256         const void *data[IWL_MAX_CMD_TFDS];
 257         struct iwl_rx_packet *resp_pkt;
 258         unsigned long _rx_page_addr;
 259         u32 _rx_page_order;
 260         int handler_status;
 261
 262         u32 flags;
 263         u16 len[IWL_MAX_CMD_TFDS];
 264         u8 dataflags[IWL_MAX_CMD_TFDS];
 265         u8 id;
 266 };
 267
 268 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
 269 {
 270         free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
 271 }
 272
 273 struct iwl_rx_cmd_buffer {
 274         struct page *_page;
 275         int _offset;
 276         bool _page_stolen;
 277         u32 _rx_page_order;
 278         unsigned int truesize;
 279 };
 280
 281 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
 282 {
 283         return (void *)((unsigned long)page_address(r->_page) + r->_offset);
 284 }
 285
 286 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
 287 {
 288         return r->_offset;
 289 }
 290
 291 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
 292 {
 293         r->_page_stolen = true;
 294         get_page(r->_page);
 295         return r->_page;
 296 }
 297
 298 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
 299 {
 300         __free_pages(r->_page, r->_rx_page_order);
 301 }
 302
 303 #define MAX_NO_RECLAIM_CMDS     6
 304
 305 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
 306
 307 /*
 308  * Maximum number of HW queues the transport layer
 309  * currently supports
 310  */
 311 #define IWL_MAX_HW_QUEUES               32
 312 #define IWL_INVALID_STATION     255
 313 #define IWL_MAX_TID_COUNT       8
 314 #define IWL_FRAME_LIMIT 64
 315
 316 /**
 317  * enum iwl_wowlan_status - WoWLAN image/device status
 318  * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
 319  * @IWL_D3_STATUS_RESET: device was reset while suspended
 320  */
 321 enum iwl_d3_status {
 322         IWL_D3_STATUS_ALIVE,
 323         IWL_D3_STATUS_RESET,
 324 };
 325
 326 /**
 327  * struct iwl_trans_config - transport configuration
 328  *
 329  * @op_mode: pointer to the upper layer.
 330  * @cmd_queue: the index of the command queue.
 331  *      Must be set before start_fw.
 332  * @cmd_fifo: the fifo for host commands
 333  * @no_reclaim_cmds: Some devices erroneously don't set the
 334  *      SEQ_RX_FRAME bit on some notifications, this is the
 335  *      list of such notifications to filter. Max length is
 336  *      %MAX_NO_RECLAIM_CMDS.
 337  * @n_no_reclaim_cmds: # of commands in list
 338  * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
 339  *      if unset 4k will be the RX buffer size
 340  * @bc_table_dword: set to true if the BC table expects the byte count to be
 341  *      in DWORD (as opposed to bytes)
 342  * @queue_watchdog_timeout: time (in ms) after which queues
 343  *      are considered stuck and will trigger device restart
 344  * @command_names: array of command names, must be 256 entries
 345  *      (one for each command); for debugging only
 346  */
 347 struct iwl_trans_config {
 348         struct iwl_op_mode *op_mode;
 349
 350         u8 cmd_queue;
 351         u8 cmd_fifo;
 352         const u8 *no_reclaim_cmds;
 353         int n_no_reclaim_cmds;
 354
 355         bool rx_buf_size_8k;
 356         bool bc_table_dword;
 357         unsigned int queue_watchdog_timeout;
 358         const char **command_names;
 359 };
 360
 361 struct iwl_trans;
 362
 363 /**
 364  * struct iwl_trans_ops - transport specific operations
 365  *
 366  * All the handlers MUST be implemented
 367  *
 368  * @start_hw: starts the HW- from that point on, the HW can send interrupts
 369  *      May sleep
 370  * @stop_hw: stops the HW- from that point on, the HW will be in low power but
 371  *      will still issue interrupt if the HW RF kill is triggered unless
 372  *      op_mode_leaving is true.
 373  *      May sleep
 374  * @start_fw: allocates and inits all the resources for the transport
 375  *      layer. Also kick a fw image.
 376  *      May sleep
 377  * @fw_alive: called when the fw sends alive notification. If the fw provides
 378  *      the SCD base address in SRAM, then provide it here, or 0 otherwise.
 379  *      May sleep
 380  * @stop_device:stops the whole device (embedded CPU put to reset)
 381  *      May sleep
 382  * @d3_suspend: put the device into the correct mode for WoWLAN during
 383  *      suspend. This is optional, if not implemented WoWLAN will not be
 384  *      supported. This callback may sleep.
 385  * @d3_resume: resume the device after WoWLAN, enabling the opmode to
 386  *      talk to the WoWLAN image to get its status. This is optional, if not
 387  *      implemented WoWLAN will not be supported. This callback may sleep.
 388  * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
 389  *      If RFkill is asserted in the middle of a SYNC host command, it must
 390  *      return -ERFKILL straight away.
 391  *      May sleep only if CMD_SYNC is set
 392  * @tx: send an skb
 393  *      Must be atomic
 394  * @reclaim: free packet until ssn. Returns a list of freed packets.
 395  *      Must be atomic
 396  * @txq_enable: setup a queue. To setup an AC queue, use the
 397  *      iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
 398  *      this one. The op_mode must not configure the HCMD queue. May sleep.
 399  * @txq_disable: de-configure a Tx queue to send AMPDUs
 400  *      Must be atomic
 401  * @wait_tx_queue_empty: wait until all tx queues are empty
 402  *      May sleep
 403  * @dbgfs_register: add the dbgfs files under this directory. Files will be
 404  *      automatically deleted.
 405  * @suspend: stop the device unless WoWLAN is configured
 406  * @resume: resume activity of the device
 407  * @write8: write a u8 to a register at offset ofs from the BAR
 408  * @write32: write a u32 to a register at offset ofs from the BAR
 409  * @read32: read a u32 register at offset ofs from the BAR
 410  * @read_prph: read a DWORD from a periphery register
 411  * @write_prph: write a DWORD to a periphery register
 412  * @read_mem: read device's SRAM in DWORD
 413  * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
 414  *      will be zeroed.
 415  * @configure: configure parameters required by the transport layer from
 416  *      the op_mode. May be called several times before start_fw, can't be
 417  *      called after that.
 418  * @set_pmi: set the power pmi state
 419  * @grab_nic_access: wake the NIC to be able to access non-HBUS regs
 420  * @release_nic_access: let the NIC go to sleep
 421  * @set_bits_mask - set SRAM register according to value and mask.
 422  */
 423 struct iwl_trans_ops {
 424
 425         int (*start_hw)(struct iwl_trans *iwl_trans);
 426         void (*stop_hw)(struct iwl_trans *iwl_trans, bool op_mode_leaving);
 427         int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
 428                         bool run_in_rfkill);
 429         void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
 430         void (*stop_device)(struct iwl_trans *trans);
 431
 432         void (*d3_suspend)(struct iwl_trans *trans);
 433         int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status);
 434
 435         int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
 436
 437         int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
 438                   struct iwl_device_cmd *dev_cmd, int queue);
 439         void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
 440                         struct sk_buff_head *skbs);
 441
 442         void (*txq_enable)(struct iwl_trans *trans, int queue, int fifo,
 443                            int sta_id, int tid, int frame_limit, u16 ssn);
 444         void (*txq_disable)(struct iwl_trans *trans, int queue);
 445
 446         int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
 447         int (*wait_tx_queue_empty)(struct iwl_trans *trans);
 448 #ifdef CONFIG_PM_SLEEP
 449         int (*suspend)(struct iwl_trans *trans);
 450         int (*resume)(struct iwl_trans *trans);
 451 #endif
 452         void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
 453         void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
 454         u32 (*read32)(struct iwl_trans *trans, u32 ofs);
 455         u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
 456         void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
 457         int (*read_mem)(struct iwl_trans *trans, u32 addr,
 458                         void *buf, int dwords);
 459         int (*write_mem)(struct iwl_trans *trans, u32 addr,
 460                          void *buf, int dwords);
 461         void (*configure)(struct iwl_trans *trans,
 462                           const struct iwl_trans_config *trans_cfg);
 463         void (*set_pmi)(struct iwl_trans *trans, bool state);
 464         bool (*grab_nic_access)(struct iwl_trans *trans, bool silent);
 465         void (*release_nic_access)(struct iwl_trans *trans);
 466         void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
 467                               u32 value);
 468 };
 469
 470 /**
 471  * enum iwl_trans_state - state of the transport layer
 472  *
 473  * @IWL_TRANS_NO_FW: no fw has sent an alive response
 474  * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
 475  */
 476 enum iwl_trans_state {
 477         IWL_TRANS_NO_FW = 0,
 478         IWL_TRANS_FW_ALIVE      = 1,
 479 };
 480
 481 /**
 482  * struct iwl_trans - transport common data
 483  *
 484  * @ops - pointer to iwl_trans_ops
 485  * @op_mode - pointer to the op_mode
 486  * @cfg - pointer to the configuration
 487  * @reg_lock - protect hw register access
 488  * @dev - pointer to struct device * that represents the device
 489  * @hw_id: a u32 with the ID of the device / subdevice.
 490  *      Set during transport allocation.
 491  * @hw_id_str: a string with info about HW ID. Set during transport allocation.
 492  * @pm_support: set to true in start_hw if link pm is supported
 493  * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
 494  *      The user should use iwl_trans_{alloc,free}_tx_cmd.
 495  * @dev_cmd_headroom: room needed for the transport's private use before the
 496  *      device_cmd for Tx - for internal use only
 497  *      The user should use iwl_trans_{alloc,free}_tx_cmd.
 498  * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
 499  *      starting the firmware, used for tracing
 500  * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
 501  *      start of the 802.11 header in the @rx_mpdu_cmd
 502  */
 503 struct iwl_trans {
 504         const struct iwl_trans_ops *ops;
 505         struct iwl_op_mode *op_mode;
 506         const struct iwl_cfg *cfg;
 507         enum iwl_trans_state state;
 508         spinlock_t reg_lock;
 509
 510         struct device *dev;
 511         u32 hw_rev;
 512         u32 hw_id;
 513         char hw_id_str[52];
 514
 515         u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
 516
 517         bool pm_support;
 518
 519         /* The following fields are internal only */
 520         struct kmem_cache *dev_cmd_pool;
 521         size_t dev_cmd_headroom;
 522         char dev_cmd_pool_name[50];
 523
 524         struct dentry *dbgfs_dir;
 525
 526         /* pointer to trans specific struct */
 527         /*Ensure that this pointer will always be aligned to sizeof pointer */
 528         char trans_specific[0] __aligned(sizeof(void *));
 529 };
 530
 531 static inline void iwl_trans_configure(struct iwl_trans *trans,
 532                                        const struct iwl_trans_config *trans_cfg)
 533 {
 534         trans->op_mode = trans_cfg->op_mode;
 535
 536         trans->ops->configure(trans, trans_cfg);
 537 }
 538
 539 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
 540 {
 541         might_sleep();
 542
 543         return trans->ops->start_hw(trans);
 544 }
 545
 546 static inline void iwl_trans_stop_hw(struct iwl_trans *trans,
 547                                      bool op_mode_leaving)
 548 {
 549         might_sleep();
 550
 551         trans->ops->stop_hw(trans, op_mode_leaving);
 552
 553         if (op_mode_leaving)
 554                 trans->op_mode = NULL;
 555
 556         trans->state = IWL_TRANS_NO_FW;
 557 }
 558
 559 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
 560 {
 561         might_sleep();
 562
 563         trans->state = IWL_TRANS_FW_ALIVE;
 564
 565         trans->ops->fw_alive(trans, scd_addr);
 566 }
 567
 568 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
 569                                      const struct fw_img *fw,
 570                                      bool run_in_rfkill)
 571 {
 572         might_sleep();
 573
 574         WARN_ON_ONCE(!trans->rx_mpdu_cmd);
 575
 576         return trans->ops->start_fw(trans, fw, run_in_rfkill);
 577 }
 578
 579 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
 580 {
 581         might_sleep();
 582
 583         trans->ops->stop_device(trans);
 584
 585         trans->state = IWL_TRANS_NO_FW;
 586 }
 587
 588 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans)
 589 {
 590         might_sleep();
 591         trans->ops->d3_suspend(trans);
 592 }
 593
 594 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
 595                                       enum iwl_d3_status *status)
 596 {
 597         might_sleep();
 598         return trans->ops->d3_resume(trans, status);
 599 }
 600
 601 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
 602                                 struct iwl_host_cmd *cmd)
 603 {
 604         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 605                   "%s bad state = %d", __func__, trans->state);
 606
 607         return trans->ops->send_cmd(trans, cmd);
 608 }
 609
 610 static inline struct iwl_device_cmd *
 611 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
 612 {
 613         u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
 614
 615         if (unlikely(dev_cmd_ptr == NULL))
 616                 return NULL;
 617
 618         return (struct iwl_device_cmd *)
 619                         (dev_cmd_ptr + trans->dev_cmd_headroom);
 620 }
 621
 622 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
 623                                          struct iwl_device_cmd *dev_cmd)
 624 {
 625         u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom;
 626
 627         kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr);
 628 }
 629
 630 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
 631                                struct iwl_device_cmd *dev_cmd, int queue)
 632 {
 633         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 634                   "%s bad state = %d", __func__, trans->state);
 635
 636         return trans->ops->tx(trans, skb, dev_cmd, queue);
 637 }
 638
 639 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
 640                                      int ssn, struct sk_buff_head *skbs)
 641 {
 642         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 643                   "%s bad state = %d", __func__, trans->state);
 644
 645         trans->ops->reclaim(trans, queue, ssn, skbs);
 646 }
 647
 648 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue)
 649 {
 650         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 651                   "%s bad state = %d", __func__, trans->state);
 652
 653         trans->ops->txq_disable(trans, queue);
 654 }
 655
 656 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
 657                                         int fifo, int sta_id, int tid,
 658                                         int frame_limit, u16 ssn)
 659 {
 660         might_sleep();
 661
 662         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 663                   "%s bad state = %d", __func__, trans->state);
 664
 665         trans->ops->txq_enable(trans, queue, fifo, sta_id, tid,
 666                                  frame_limit, ssn);
 667 }
 668
 669 static inline void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue,
 670                                            int fifo)
 671 {
 672         iwl_trans_txq_enable(trans, queue, fifo, IWL_INVALID_STATION,
 673                              IWL_MAX_TID_COUNT, IWL_FRAME_LIMIT, 0);
 674 }
 675
 676 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
 677 {
 678         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 679                   "%s bad state = %d", __func__, trans->state);
 680
 681         return trans->ops->wait_tx_queue_empty(trans);
 682 }
 683
 684 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
 685                                            struct dentry *dir)
 686 {
 687         return trans->ops->dbgfs_register(trans, dir);
 688 }
 689
 690 #ifdef CONFIG_PM_SLEEP
 691 static inline int iwl_trans_suspend(struct iwl_trans *trans)
 692 {
 693         return trans->ops->suspend(trans);
 694 }
 695
 696 static inline int iwl_trans_resume(struct iwl_trans *trans)
 697 {
 698         return trans->ops->resume(trans);
 699 }
 700 #endif
 701
 702 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
 703 {
 704         trans->ops->write8(trans, ofs, val);
 705 }
 706
 707 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
 708 {
 709         trans->ops->write32(trans, ofs, val);
 710 }
 711
 712 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
 713 {
 714         return trans->ops->read32(trans, ofs);
 715 }
 716
 717 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
 718 {
 719         return trans->ops->read_prph(trans, ofs);
 720 }
 721
 722 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
 723                                         u32 val)
 724 {
 725         return trans->ops->write_prph(trans, ofs, val);
 726 }
 727
 728 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
 729                                      void *buf, int dwords)
 730 {
 731         return trans->ops->read_mem(trans, addr, buf, dwords);
 732 }
 733
 734 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize)                   \
 735         do {                                                                  \
 736                 if (__builtin_constant_p(bufsize))                            \
 737                         BUILD_BUG_ON((bufsize) % sizeof(u32));                \
 738                 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
 739         } while (0)
 740
 741 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
 742 {
 743         u32 value;
 744
 745         if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
 746                 return 0xa5a5a5a5;
 747
 748         return value;
 749 }
 750
 751 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
 752                                       void *buf, int dwords)
 753 {
 754         return trans->ops->write_mem(trans, addr, buf, dwords);
 755 }
 756
 757 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
 758                                         u32 val)
 759 {
 760         return iwl_trans_write_mem(trans, addr, &val, 1);
 761 }
 762
 763 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
 764 {
 765         trans->ops->set_pmi(trans, state);
 766 }
 767
 768 static inline void
 769 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
 770 {
 771         trans->ops->set_bits_mask(trans, reg, mask, value);
 772 }
 773
 774 #define iwl_trans_grab_nic_access(trans, silent)        \
 775         __cond_lock(nic_access,                         \
 776                     likely((trans)->ops->grab_nic_access(trans, silent)))
 777
 778 static inline void __releases(nic_access)
 779 iwl_trans_release_nic_access(struct iwl_trans *trans)
 780 {
 781         trans->ops->release_nic_access(trans);
 782         __release(nic_access);
 783 }
 784
 785 /*****************************************************
 786 * driver (transport) register/unregister functions
 787 ******************************************************/
 788 int __must_check iwl_pci_register_driver(void);
 789 void iwl_pci_unregister_driver(void);
 790
 791 #endif /* __iwl_trans_h__ */