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