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 - 2012 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 - 2012 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         unsigned int truesize;
 278 };
 279
 280 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
 281 {
 282         return (void *)((unsigned long)page_address(r->_page) + r->_offset);
 283 }
 284
 285 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
 286 {
 287         return r->_offset;
 288 }
 289
 290 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
 291 {
 292         r->_page_stolen = true;
 293         get_page(r->_page);
 294         return r->_page;
 295 }
 296
 297 #define MAX_NO_RECLAIM_CMDS     6
 298
 299 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
 300
 301 /*
 302  * Maximum number of HW queues the transport layer
 303  * currently supports
 304  */
 305 #define IWL_MAX_HW_QUEUES               32
 306 #define IWL_INVALID_STATION     255
 307 #define IWL_MAX_TID_COUNT       8
 308 #define IWL_FRAME_LIMIT 64
 309
 310 /**
 311  * struct iwl_trans_config - transport configuration
 312  *
 313  * @op_mode: pointer to the upper layer.
 314  * @cmd_queue: the index of the command queue.
 315  *      Must be set before start_fw.
 316  * @cmd_fifo: the fifo for host commands
 317  * @no_reclaim_cmds: Some devices erroneously don't set the
 318  *      SEQ_RX_FRAME bit on some notifications, this is the
 319  *      list of such notifications to filter. Max length is
 320  *      %MAX_NO_RECLAIM_CMDS.
 321  * @n_no_reclaim_cmds: # of commands in list
 322  * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
 323  *      if unset 4k will be the RX buffer size
 324  * @bc_table_dword: set to true if the BC table expects the byte count to be
 325  *      in DWORD (as opposed to bytes)
 326  * @queue_watchdog_timeout: time (in ms) after which queues
 327  *      are considered stuck and will trigger device restart
 328  * @command_names: array of command names, must be 256 entries
 329  *      (one for each command); for debugging only
 330  */
 331 struct iwl_trans_config {
 332         struct iwl_op_mode *op_mode;
 333
 334         u8 cmd_queue;
 335         u8 cmd_fifo;
 336         const u8 *no_reclaim_cmds;
 337         int n_no_reclaim_cmds;
 338
 339         bool rx_buf_size_8k;
 340         bool bc_table_dword;
 341         unsigned int queue_watchdog_timeout;
 342         const char **command_names;
 343 };
 344
 345 struct iwl_trans;
 346
 347 /**
 348  * struct iwl_trans_ops - transport specific operations
 349  *
 350  * All the handlers MUST be implemented
 351  *
 352  * @start_hw: starts the HW- from that point on, the HW can send interrupts
 353  *      May sleep
 354  * @stop_hw: stops the HW- from that point on, the HW will be in low power but
 355  *      will still issue interrupt if the HW RF kill is triggered unless
 356  *      op_mode_leaving is true.
 357  *      May sleep
 358  * @start_fw: allocates and inits all the resources for the transport
 359  *      layer. Also kick a fw image.
 360  *      May sleep
 361  * @fw_alive: called when the fw sends alive notification. If the fw provides
 362  *      the SCD base address in SRAM, then provide it here, or 0 otherwise.
 363  *      May sleep
 364  * @stop_device:stops the whole device (embedded CPU put to reset)
 365  *      May sleep
 366  * @wowlan_suspend: put the device into the correct mode for WoWLAN during
 367  *      suspend. This is optional, if not implemented WoWLAN will not be
 368  *      supported. This callback may sleep.
 369  * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
 370  *      If RFkill is asserted in the middle of a SYNC host command, it must
 371  *      return -ERFKILL straight away.
 372  *      May sleep only if CMD_SYNC is set
 373  * @tx: send an skb
 374  *      Must be atomic
 375  * @reclaim: free packet until ssn. Returns a list of freed packets.
 376  *      Must be atomic
 377  * @txq_enable: setup a queue. To setup an AC queue, use the
 378  *      iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
 379  *      this one. The op_mode must not configure the HCMD queue. May sleep.
 380  * @txq_disable: de-configure a Tx queue to send AMPDUs
 381  *      Must be atomic
 382  * @wait_tx_queue_empty: wait until all tx queues are empty
 383  *      May sleep
 384  * @dbgfs_register: add the dbgfs files under this directory. Files will be
 385  *      automatically deleted.
 386  * @suspend: stop the device unless WoWLAN is configured
 387  * @resume: resume activity of the device
 388  * @write8: write a u8 to a register at offset ofs from the BAR
 389  * @write32: write a u32 to a register at offset ofs from the BAR
 390  * @read32: read a u32 register at offset ofs from the BAR
 391  * @read_prph: read a DWORD from a periphery register
 392  * @write_prph: write a DWORD to a periphery register
 393  * @read_mem: read device's SRAM in DWORD
 394  * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
 395  *      will be zeroed.
 396  * @configure: configure parameters required by the transport layer from
 397  *      the op_mode. May be called several times before start_fw, can't be
 398  *      called after that.
 399  * @set_pmi: set the power pmi state
 400  * @grab_nic_access: wake the NIC to be able to access non-HBUS regs
 401  * @release_nic_access: let the NIC go to sleep
 402  */
 403 struct iwl_trans_ops {
 404
 405         int (*start_hw)(struct iwl_trans *iwl_trans);
 406         void (*stop_hw)(struct iwl_trans *iwl_trans, bool op_mode_leaving);
 407         int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
 408                         bool run_in_rfkill);
 409         void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
 410         void (*stop_device)(struct iwl_trans *trans);
 411
 412         void (*wowlan_suspend)(struct iwl_trans *trans);
 413
 414         int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
 415
 416         int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
 417                   struct iwl_device_cmd *dev_cmd, int queue);
 418         void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
 419                         struct sk_buff_head *skbs);
 420
 421         void (*txq_enable)(struct iwl_trans *trans, int queue, int fifo,
 422                            int sta_id, int tid, int frame_limit, u16 ssn);
 423         void (*txq_disable)(struct iwl_trans *trans, int queue);
 424
 425         int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
 426         int (*wait_tx_queue_empty)(struct iwl_trans *trans);
 427 #ifdef CONFIG_PM_SLEEP
 428         int (*suspend)(struct iwl_trans *trans);
 429         int (*resume)(struct iwl_trans *trans);
 430 #endif
 431         void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
 432         void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
 433         u32 (*read32)(struct iwl_trans *trans, u32 ofs);
 434         u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
 435         void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
 436         int (*read_mem)(struct iwl_trans *trans, u32 addr,
 437                         void *buf, int dwords);
 438         int (*write_mem)(struct iwl_trans *trans, u32 addr,
 439                          void *buf, int dwords);
 440         void (*configure)(struct iwl_trans *trans,
 441                           const struct iwl_trans_config *trans_cfg);
 442         void (*set_pmi)(struct iwl_trans *trans, bool state);
 443         bool (*grab_nic_access)(struct iwl_trans *trans, bool silent);
 444         void (*release_nic_access)(struct iwl_trans *trans);
 445 };
 446
 447 /**
 448  * enum iwl_trans_state - state of the transport layer
 449  *
 450  * @IWL_TRANS_NO_FW: no fw has sent an alive response
 451  * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
 452  */
 453 enum iwl_trans_state {
 454         IWL_TRANS_NO_FW = 0,
 455         IWL_TRANS_FW_ALIVE      = 1,
 456 };
 457
 458 /**
 459  * struct iwl_trans - transport common data
 460  *
 461  * @ops - pointer to iwl_trans_ops
 462  * @op_mode - pointer to the op_mode
 463  * @cfg - pointer to the configuration
 464  * @reg_lock - protect hw register access
 465  * @dev - pointer to struct device * that represents the device
 466  * @hw_id: a u32 with the ID of the device / subdevice.
 467  *      Set during transport allocation.
 468  * @hw_id_str: a string with info about HW ID. Set during transport allocation.
 469  * @pm_support: set to true in start_hw if link pm is supported
 470  * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
 471  *      The user should use iwl_trans_{alloc,free}_tx_cmd.
 472  * @dev_cmd_headroom: room needed for the transport's private use before the
 473  *      device_cmd for Tx - for internal use only
 474  *      The user should use iwl_trans_{alloc,free}_tx_cmd.
 475  * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
 476  *      starting the firmware, used for tracing
 477  * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
 478  *      start of the 802.11 header in the @rx_mpdu_cmd
 479  */
 480 struct iwl_trans {
 481         const struct iwl_trans_ops *ops;
 482         struct iwl_op_mode *op_mode;
 483         const struct iwl_cfg *cfg;
 484         enum iwl_trans_state state;
 485         spinlock_t reg_lock;
 486
 487         struct device *dev;
 488         u32 hw_rev;
 489         u32 hw_id;
 490         char hw_id_str[52];
 491
 492         u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
 493
 494         bool pm_support;
 495
 496         /* The following fields are internal only */
 497         struct kmem_cache *dev_cmd_pool;
 498         size_t dev_cmd_headroom;
 499         char dev_cmd_pool_name[50];
 500
 501         struct dentry *dbgfs_dir;
 502
 503         /* pointer to trans specific struct */
 504         /*Ensure that this pointer will always be aligned to sizeof pointer */
 505         char trans_specific[0] __aligned(sizeof(void *));
 506 };
 507
 508 static inline void iwl_trans_configure(struct iwl_trans *trans,
 509                                        const struct iwl_trans_config *trans_cfg)
 510 {
 511         trans->op_mode = trans_cfg->op_mode;
 512
 513         trans->ops->configure(trans, trans_cfg);
 514 }
 515
 516 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
 517 {
 518         might_sleep();
 519
 520         return trans->ops->start_hw(trans);
 521 }
 522
 523 static inline void iwl_trans_stop_hw(struct iwl_trans *trans,
 524                                      bool op_mode_leaving)
 525 {
 526         might_sleep();
 527
 528         trans->ops->stop_hw(trans, op_mode_leaving);
 529
 530         if (op_mode_leaving)
 531                 trans->op_mode = NULL;
 532
 533         trans->state = IWL_TRANS_NO_FW;
 534 }
 535
 536 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
 537 {
 538         might_sleep();
 539
 540         trans->state = IWL_TRANS_FW_ALIVE;
 541
 542         trans->ops->fw_alive(trans, scd_addr);
 543 }
 544
 545 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
 546                                      const struct fw_img *fw,
 547                                      bool run_in_rfkill)
 548 {
 549         might_sleep();
 550
 551         WARN_ON_ONCE(!trans->rx_mpdu_cmd);
 552
 553         return trans->ops->start_fw(trans, fw, run_in_rfkill);
 554 }
 555
 556 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
 557 {
 558         might_sleep();
 559
 560         trans->ops->stop_device(trans);
 561
 562         trans->state = IWL_TRANS_NO_FW;
 563 }
 564
 565 static inline void iwl_trans_wowlan_suspend(struct iwl_trans *trans)
 566 {
 567         might_sleep();
 568         trans->ops->wowlan_suspend(trans);
 569 }
 570
 571 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
 572                                 struct iwl_host_cmd *cmd)
 573 {
 574         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 575                   "%s bad state = %d", __func__, trans->state);
 576
 577         return trans->ops->send_cmd(trans, cmd);
 578 }
 579
 580 static inline struct iwl_device_cmd *
 581 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
 582 {
 583         u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
 584
 585         if (unlikely(dev_cmd_ptr == NULL))
 586                 return NULL;
 587
 588         return (struct iwl_device_cmd *)
 589                         (dev_cmd_ptr + trans->dev_cmd_headroom);
 590 }
 591
 592 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
 593                                          struct iwl_device_cmd *dev_cmd)
 594 {
 595         u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom;
 596
 597         kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr);
 598 }
 599
 600 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
 601                                struct iwl_device_cmd *dev_cmd, int queue)
 602 {
 603         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 604                   "%s bad state = %d", __func__, trans->state);
 605
 606         return trans->ops->tx(trans, skb, dev_cmd, queue);
 607 }
 608
 609 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
 610                                      int ssn, struct sk_buff_head *skbs)
 611 {
 612         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 613                   "%s bad state = %d", __func__, trans->state);
 614
 615         trans->ops->reclaim(trans, queue, ssn, skbs);
 616 }
 617
 618 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue)
 619 {
 620         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 621                   "%s bad state = %d", __func__, trans->state);
 622
 623         trans->ops->txq_disable(trans, queue);
 624 }
 625
 626 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
 627                                         int fifo, int sta_id, int tid,
 628                                         int frame_limit, u16 ssn)
 629 {
 630         might_sleep();
 631
 632         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 633                   "%s bad state = %d", __func__, trans->state);
 634
 635         trans->ops->txq_enable(trans, queue, fifo, sta_id, tid,
 636                                  frame_limit, ssn);
 637 }
 638
 639 static inline void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue,
 640                                            int fifo)
 641 {
 642         iwl_trans_txq_enable(trans, queue, fifo, IWL_INVALID_STATION,
 643                              IWL_MAX_TID_COUNT, IWL_FRAME_LIMIT, 0);
 644 }
 645
 646 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
 647 {
 648         WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
 649                   "%s bad state = %d", __func__, trans->state);
 650
 651         return trans->ops->wait_tx_queue_empty(trans);
 652 }
 653
 654 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
 655                                            struct dentry *dir)
 656 {
 657         return trans->ops->dbgfs_register(trans, dir);
 658 }
 659
 660 #ifdef CONFIG_PM_SLEEP
 661 static inline int iwl_trans_suspend(struct iwl_trans *trans)
 662 {
 663         return trans->ops->suspend(trans);
 664 }
 665
 666 static inline int iwl_trans_resume(struct iwl_trans *trans)
 667 {
 668         return trans->ops->resume(trans);
 669 }
 670 #endif
 671
 672 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
 673 {
 674         trans->ops->write8(trans, ofs, val);
 675 }
 676
 677 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
 678 {
 679         trans->ops->write32(trans, ofs, val);
 680 }
 681
 682 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
 683 {
 684         return trans->ops->read32(trans, ofs);
 685 }
 686
 687 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
 688 {
 689         return trans->ops->read_prph(trans, ofs);
 690 }
 691
 692 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
 693                                         u32 val)
 694 {
 695         return trans->ops->write_prph(trans, ofs, val);
 696 }
 697
 698 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
 699                                      void *buf, int dwords)
 700 {
 701         return trans->ops->read_mem(trans, addr, buf, dwords);
 702 }
 703
 704 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize)                   \
 705         do {                                                                  \
 706                 if (__builtin_constant_p(bufsize))                            \
 707                         BUILD_BUG_ON((bufsize) % sizeof(u32));                \
 708                 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
 709         } while (0)
 710
 711 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
 712 {
 713         u32 value;
 714
 715         if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
 716                 return 0xa5a5a5a5;
 717
 718         return value;
 719 }
 720
 721 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
 722                                       void *buf, int dwords)
 723 {
 724         return trans->ops->write_mem(trans, addr, buf, dwords);
 725 }
 726
 727 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
 728                                         u32 val)
 729 {
 730         return iwl_trans_write_mem(trans, addr, &val, 1);
 731 }
 732
 733 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
 734 {
 735         trans->ops->set_pmi(trans, state);
 736 }
 737
 738 #define iwl_trans_grab_nic_access(trans, silent)        \
 739         __cond_lock(nic_access,                         \
 740                     likely((trans)->ops->grab_nic_access(trans, silent)))
 741
 742 static inline void __releases(nic_access)
 743 iwl_trans_release_nic_access(struct iwl_trans *trans)
 744 {
 745         trans->ops->release_nic_access(trans);
 746         __release(nic_access);
 747 }
 748
 749 /*****************************************************
 750 * driver (transport) register/unregister functions
 751 ******************************************************/
 752 int __must_check iwl_pci_register_driver(void);
 753 void iwl_pci_unregister_driver(void);
 754
 755 #endif /* __iwl_trans_h__ */