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 - 2014 Intel Corporation. All rights reserved.
   9  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of version 2 of the GNU General Public License as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  23  * USA
  24  *
  25  * The full GNU General Public License is included in this distribution
  26  * in the file called COPYING.
  27  *
  28  * Contact Information:
  29  *  Intel Linux Wireless <ilw@linux.intel.com>
  30  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  31  *
  32  * BSD LICENSE
  33  *
  34  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
  35  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  36  * All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  *
  42  *  * Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  *  * Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in
  46  *    the documentation and/or other materials provided with the
  47  *    distribution.
  48  *  * Neither the name Intel Corporation nor the names of its
  49  *    contributors may be used to endorse or promote products derived
  50  *    from this software without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  58  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  59  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  60  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  61  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  62  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  63  *
  64  *****************************************************************************/
  65 #ifndef __iwl_trans_h__
  66 #define __iwl_trans_h__
  67
  68 #include <linux/ieee80211.h>
  69 #include <linux/mm.h> /* for page_address */
  70 #include <linux/lockdep.h>
  71
  72 #include "iwl-debug.h"
  73 #include "iwl-config.h"
  74 #include "iwl-fw.h"
  75 #include "iwl-op-mode.h"
  76
  77 /**
  78  * DOC: Transport layer - what is it ?
  79  *
  80  * The transport layer is the layer that deals with the HW directly. It provides
  81  * an abstraction of the underlying HW to the upper layer. The transport layer
  82  * doesn't provide any policy, algorithm or anything of this kind, but only
  83  * mechanisms to make the HW do something. It is not completely stateless but
  84  * close to it.
  85  * We will have an implementation for each different supported bus.
  86  */
  87
  88 /**
  89  * DOC: Life cycle of the transport layer
  90  *
  91  * The transport layer has a very precise life cycle.
  92  *
  93  *      1) A helper function is called during the module initialization and
  94  *         registers the bus driver's ops with the transport's alloc function.
  95  *      2) Bus's probe calls to the transport layer's allocation functions.
  96  *         Of course this function is bus specific.
  97  *      3) This allocation functions will spawn the upper layer which will
  98  *         register mac80211.
  99  *
 100  *      4) At some point (i.e. mac80211's start call), the op_mode will call
 101  *         the following sequence:
 102  *         start_hw
 103  *         start_fw
 104  *
 105  *      5) Then when finished (or reset):
 106  *         stop_device
 107  *
 108  *      6) Eventually, the free function will be called.
 109  */
 110
 111 /**
 112  * DOC: Host command section
 113  *
 114  * A host command is a command issued by the upper layer to the fw. There are
 115  * several versions of fw that have several APIs. The transport layer is
 116  * completely agnostic to these differences.
 117  * The transport does provide helper functionality (i.e. SYNC / ASYNC mode),
 118  */
 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 static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt)
 182 {
 183         return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
 184 }
 185
 186 static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt)
 187 {
 188         return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr);
 189 }
 190
 191 /**
 192  * enum CMD_MODE - how to send the host commands ?
 193  *
 194  * @CMD_ASYNC: Return right away and don't wait for the response
 195  * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of
 196  *      the response. The caller needs to call iwl_free_resp when done.
 197  * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
 198  *      command queue, but after other high priority commands. Valid only
 199  *      with CMD_ASYNC.
 200  * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
 201  * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
 202  * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
 203  *      (i.e. mark it as non-idle).
 204  */
 205 enum CMD_MODE {
 206         CMD_ASYNC               = BIT(0),
 207         CMD_WANT_SKB            = BIT(1),
 208         CMD_SEND_IN_RFKILL      = BIT(2),
 209         CMD_HIGH_PRIO           = BIT(3),
 210         CMD_SEND_IN_IDLE        = BIT(4),
 211         CMD_MAKE_TRANS_IDLE     = BIT(5),
 212         CMD_WAKE_UP_TRANS       = BIT(6),
 213 };
 214
 215 #define DEF_CMD_PAYLOAD_SIZE 320
 216
 217 /**
 218  * struct iwl_device_cmd
 219  *
 220  * For allocation of the command and tx queues, this establishes the overall
 221  * size of the largest command we send to uCode, except for commands that
 222  * aren't fully copied and use other TFD space.
 223  */
 224 struct iwl_device_cmd {
 225         struct iwl_cmd_header hdr;      /* uCode API */
 226         u8 payload[DEF_CMD_PAYLOAD_SIZE];
 227 } __packed;
 228
 229 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
 230
 231 /*
 232  * number of transfer buffers (fragments) per transmit frame descriptor;
 233  * this is just the driver's idea, the hardware supports 20
 234  */
 235 #define IWL_MAX_CMD_TBS_PER_TFD 2
 236
 237 /**
 238  * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
 239  *
 240  * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
 241  *      ring. The transport layer doesn't map the command's buffer to DMA, but
 242  *      rather copies it to a previously allocated DMA buffer. This flag tells
 243  *      the transport layer not to copy the command, but to map the existing
 244  *      buffer (that is passed in) instead. This saves the memcpy and allows
 245  *      commands that are bigger than the fixed buffer to be submitted.
 246  *      Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
 247  * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
 248  *      chunk internally and free it again after the command completes. This
 249  *      can (currently) be used only once per command.
 250  *      Note that a TFD entry after a DUP one cannot be a normal copied one.
 251  */
 252 enum iwl_hcmd_dataflag {
 253         IWL_HCMD_DFL_NOCOPY     = BIT(0),
 254         IWL_HCMD_DFL_DUP        = BIT(1),
 255 };
 256
 257 /**
 258  * struct iwl_host_cmd - Host command to the uCode
 259  *
 260  * @data: array of chunks that composes the data of the host command
 261  * @resp_pkt: response packet, if %CMD_WANT_SKB was set
 262  * @_rx_page_order: (internally used to free response packet)
 263  * @_rx_page_addr: (internally used to free response packet)
 264  * @handler_status: return value of the handler of the command
 265  *      (put in setup_rx_handlers) - valid for SYNC mode only
 266  * @flags: can be CMD_*
 267  * @len: array of the lengths of the chunks in data
 268  * @dataflags: IWL_HCMD_DFL_*
 269  * @id: id of the host command
 270  */
 271 struct iwl_host_cmd {
 272         const void *data[IWL_MAX_CMD_TBS_PER_TFD];
 273         struct iwl_rx_packet *resp_pkt;
 274         unsigned long _rx_page_addr;
 275         u32 _rx_page_order;
 276         int handler_status;
 277
 278         u32 flags;
 279         u16 len[IWL_MAX_CMD_TBS_PER_TFD];
 280         u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
 281         u8 id;
 282 };
 283
 284 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
 285 {
 286         free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
 287 }
 288
 289 struct iwl_rx_cmd_buffer {
 290         struct page *_page;
 291         int _offset;
 292         bool _page_stolen;
 293         u32 _rx_page_order;
 294         unsigned int truesize;
 295 };
 296
 297 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
 298 {
 299         return (void *)((unsigned long)page_address(r->_page) + r->_offset);
 300 }
 301
 302 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
 303 {
 304         return r->_offset;
 305 }
 306
 307 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
 308 {
 309         r->_page_stolen = true;
 310         get_page(r->_page);
 311         return r->_page;
 312 }
 313
 314 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
 315 {
 316         __free_pages(r->_page, r->_rx_page_order);
 317 }
 318
 319 #define MAX_NO_RECLAIM_CMDS     6
 320
 321 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
 322
 323 /*
 324  * Maximum number of HW queues the transport layer
 325  * currently supports
 326  */
 327 #define IWL_MAX_HW_QUEUES               32
 328 #define IWL_MAX_TID_COUNT       8
 329 #define IWL_FRAME_LIMIT 64
 330
 331 /**
 332  * enum iwl_wowlan_status - WoWLAN image/device status
 333  * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
 334  * @IWL_D3_STATUS_RESET: device was reset while suspended
 335  */
 336 enum iwl_d3_status {
 337         IWL_D3_STATUS_ALIVE,
 338         IWL_D3_STATUS_RESET,
 339 };
 340
 341 /**
 342  * enum iwl_trans_status: transport status flags
 343  * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
 344  * @STATUS_DEVICE_ENABLED: APM is enabled
 345  * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
 346  * @STATUS_INT_ENABLED: interrupts are enabled
 347  * @STATUS_RFKILL: the HW RFkill switch is in KILL position
 348  * @STATUS_FW_ERROR: the fw is in error state
 349  * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
 350  *      are sent
 351  * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
 352  */
 353 enum iwl_trans_status {
 354         STATUS_SYNC_HCMD_ACTIVE,
 355         STATUS_DEVICE_ENABLED,
 356         STATUS_TPOWER_PMI,
 357         STATUS_INT_ENABLED,
 358         STATUS_RFKILL,
 359         STATUS_FW_ERROR,
 360         STATUS_TRANS_GOING_IDLE,
 361         STATUS_TRANS_IDLE,
 362 };
 363
 364 /**
 365  * struct iwl_trans_config - transport configuration
 366  *
 367  * @op_mode: pointer to the upper layer.
 368  * @cmd_queue: the index of the command queue.
 369  *      Must be set before start_fw.
 370  * @cmd_fifo: the fifo for host commands
 371  * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue.
 372  * @no_reclaim_cmds: Some devices erroneously don't set the
 373  *      SEQ_RX_FRAME bit on some notifications, this is the
 374  *      list of such notifications to filter. Max length is
 375  *      %MAX_NO_RECLAIM_CMDS.
 376  * @n_no_reclaim_cmds: # of commands in list
 377  * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
 378  *      if unset 4k will be the RX buffer size
 379  * @bc_table_dword: set to true if the BC table expects the byte count to be
 380  *      in DWORD (as opposed to bytes)
 381  * @scd_set_active: should the transport configure the SCD for HCMD queue
 382  * @command_names: array of command names, must be 256 entries
 383  *      (one for each command); for debugging only
 384  * @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until
 385  *      we get the ALIVE from the uCode
 386  */
 387 struct iwl_trans_config {
 388         struct iwl_op_mode *op_mode;
 389
 390         u8 cmd_queue;
 391         u8 cmd_fifo;
 392         unsigned int cmd_q_wdg_timeout;
 393         const u8 *no_reclaim_cmds;
 394         unsigned int n_no_reclaim_cmds;
 395
 396         bool rx_buf_size_8k;
 397         bool bc_table_dword;
 398         bool scd_set_active;
 399         const char *const *command_names;
 400
 401         u32 sdio_adma_addr;
 402 };
 403
 404 struct iwl_trans_dump_data {
 405         u32 len;
 406         u8 data[];
 407 };
 408
 409 struct iwl_trans;
 410
 411 struct iwl_trans_txq_scd_cfg {
 412         u8 fifo;
 413         s8 sta_id;
 414         u8 tid;
 415         bool aggregate;
 416         int frame_limit;
 417 };
 418
 419 /**
 420  * struct iwl_trans_ops - transport specific operations
 421  *
 422  * All the handlers MUST be implemented
 423  *
 424  * @start_hw: starts the HW- from that point on, the HW can send interrupts
 425  *      May sleep
 426  * @op_mode_leave: Turn off the HW RF kill indication if on
 427  *      May sleep
 428  * @start_fw: allocates and inits all the resources for the transport
 429  *      layer. Also kick a fw image.
 430  *      May sleep
 431  * @fw_alive: called when the fw sends alive notification. If the fw provides
 432  *      the SCD base address in SRAM, then provide it here, or 0 otherwise.
 433  *      May sleep
 434  * @stop_device: stops the whole device (embedded CPU put to reset) and stops
 435  *      the HW. From that point on, the HW will be in low power but will still
 436  *      issue interrupt if the HW RF kill is triggered. This callback must do
 437  *      the right thing and not crash even if start_hw() was called but not
 438  *      start_fw(). May sleep
 439  * @d3_suspend: put the device into the correct mode for WoWLAN during
 440  *      suspend. This is optional, if not implemented WoWLAN will not be
 441  *      supported. This callback may sleep.
 442  * @d3_resume: resume the device after WoWLAN, enabling the opmode to
 443  *      talk to the WoWLAN image to get its status. This is optional, if not
 444  *      implemented WoWLAN will not be supported. This callback may sleep.
 445  * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
 446  *      If RFkill is asserted in the middle of a SYNC host command, it must
 447  *      return -ERFKILL straight away.
 448  *      May sleep only if CMD_ASYNC is not set
 449  * @tx: send an skb
 450  *      Must be atomic
 451  * @reclaim: free packet until ssn. Returns a list of freed packets.
 452  *      Must be atomic
 453  * @txq_enable: setup a queue. To setup an AC queue, use the
 454  *      iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
 455  *      this one. The op_mode must not configure the HCMD queue. The scheduler
 456  *      configuration may be %NULL, in which case the hardware will not be
 457  *      configured. May sleep.
 458  * @txq_disable: de-configure a Tx queue to send AMPDUs
 459  *      Must be atomic
 460  * @wait_tx_queue_empty: wait until tx queues are empty. May sleep.
 461  * @freeze_txq_timer: prevents the timer of the queue from firing until the
 462  *      queue is set to awake. Must be atomic.
 463  * @dbgfs_register: add the dbgfs files under this directory. Files will be
 464  *      automatically deleted.
 465  * @write8: write a u8 to a register at offset ofs from the BAR
 466  * @write32: write a u32 to a register at offset ofs from the BAR
 467  * @read32: read a u32 register at offset ofs from the BAR
 468  * @read_prph: read a DWORD from a periphery register
 469  * @write_prph: write a DWORD to a periphery register
 470  * @read_mem: read device's SRAM in DWORD
 471  * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
 472  *      will be zeroed.
 473  * @configure: configure parameters required by the transport layer from
 474  *      the op_mode. May be called several times before start_fw, can't be
 475  *      called after that.
 476  * @set_pmi: set the power pmi state
 477  * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
 478  *      Sleeping is not allowed between grab_nic_access and
 479  *      release_nic_access.
 480  * @release_nic_access: let the NIC go to sleep. The "flags" parameter
 481  *      must be the same one that was sent before to the grab_nic_access.
 482  * @set_bits_mask - set SRAM register according to value and mask.
 483  * @ref: grab a reference to the transport/FW layers, disallowing
 484  *      certain low power states
 485  * @unref: release a reference previously taken with @ref. Note that
 486  *      initially the reference count is 1, making an initial @unref
 487  *      necessary to allow low power states.
 488  * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last
 489  *      TX'ed commands and similar. The buffer will be vfree'd by the caller.
 490  *      Note that the transport must fill in the proper file headers.
 491  */
 492 struct iwl_trans_ops {
 493
 494         int (*start_hw)(struct iwl_trans *iwl_trans);
 495         void (*op_mode_leave)(struct iwl_trans *iwl_trans);
 496         int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
 497                         bool run_in_rfkill);
 498         int (*update_sf)(struct iwl_trans *trans,
 499                          struct iwl_sf_region *st_fwrd_space);
 500         void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
 501         void (*stop_device)(struct iwl_trans *trans);
 502
 503         void (*d3_suspend)(struct iwl_trans *trans, bool test);
 504         int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status,
 505                          bool test);
 506
 507         int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
 508
 509         int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
 510                   struct iwl_device_cmd *dev_cmd, int queue);
 511         void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
 512                         struct sk_buff_head *skbs);
 513
 514         void (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn,
 515                            const struct iwl_trans_txq_scd_cfg *cfg,
 516                            unsigned int queue_wdg_timeout);
 517         void (*txq_disable)(struct iwl_trans *trans, int queue,
 518                             bool configure_scd);
 519
 520         int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
 521         int (*wait_tx_queue_empty)(struct iwl_trans *trans, u32 txq_bm);
 522         void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs,
 523                                  bool freeze);
 524
 525         void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
 526         void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
 527         u32 (*read32)(struct iwl_trans *trans, u32 ofs);
 528         u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
 529         void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
 530         int (*read_mem)(struct iwl_trans *trans, u32 addr,
 531                         void *buf, int dwords);
 532         int (*write_mem)(struct iwl_trans *trans, u32 addr,
 533                          const void *buf, int dwords);
 534         void (*configure)(struct iwl_trans *trans,
 535                           const struct iwl_trans_config *trans_cfg);
 536         void (*set_pmi)(struct iwl_trans *trans, bool state);
 537         bool (*grab_nic_access)(struct iwl_trans *trans, bool silent,
 538                                 unsigned long *flags);
 539         void (*release_nic_access)(struct iwl_trans *trans,
 540                                    unsigned long *flags);
 541         void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
 542                               u32 value);
 543         void (*ref)(struct iwl_trans *trans);
 544         void (*unref)(struct iwl_trans *trans);
 545         void (*suspend)(struct iwl_trans *trans);
 546         void (*resume)(struct iwl_trans *trans);
 547
 548         struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans);
 549 };
 550
 551 /**
 552  * enum iwl_trans_state - state of the transport layer
 553  *
 554  * @IWL_TRANS_NO_FW: no fw has sent an alive response
 555  * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
 556  */
 557 enum iwl_trans_state {
 558         IWL_TRANS_NO_FW = 0,
 559         IWL_TRANS_FW_ALIVE      = 1,
 560 };
 561
 562 /**
 563  * enum iwl_d0i3_mode - d0i3 mode
 564  *
 565  * @IWL_D0I3_MODE_OFF - d0i3 is disabled
 566  * @IWL_D0I3_MODE_ON_IDLE - enter d0i3 when device is idle
 567  *      (e.g. no active references)
 568  * @IWL_D0I3_MODE_ON_SUSPEND - enter d0i3 only on suspend
 569  *      (in case of 'any' trigger)
 570  */
 571 enum iwl_d0i3_mode {
 572         IWL_D0I3_MODE_OFF = 0,
 573         IWL_D0I3_MODE_ON_IDLE,
 574         IWL_D0I3_MODE_ON_SUSPEND,
 575 };
 576
 577 /**
 578  * struct iwl_trans - transport common data
 579  *
 580  * @ops - pointer to iwl_trans_ops
 581  * @op_mode - pointer to the op_mode
 582  * @cfg - pointer to the configuration
 583  * @status: a bit-mask of transport status flags
 584  * @dev - pointer to struct device * that represents the device
 585  * @hw_id: a u32 with the ID of the device / sub-device.
 586  *      Set during transport allocation.
 587  * @hw_id_str: a string with info about HW ID. Set during transport allocation.
 588  * @pm_support: set to true in start_hw if link pm is supported
 589  * @ltr_enabled: set to true if the LTR is enabled
 590  * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
 591  *      The user should use iwl_trans_{alloc,free}_tx_cmd.
 592  * @dev_cmd_headroom: room needed for the transport's private use before the
 593  *      device_cmd for Tx - for internal use only
 594  *      The user should use iwl_trans_{alloc,free}_tx_cmd.
 595  * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
 596  *      starting the firmware, used for tracing
 597  * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
 598  *      start of the 802.11 header in the @rx_mpdu_cmd
 599  * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
 600  * @dbg_dest_tlv: points to the destination TLV for debug
 601  * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
 602  * @dbg_trigger_tlv: array of pointers to triggers TLVs for debug
 603  * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
 604  */
 605 struct iwl_trans {
 606         const struct iwl_trans_ops *ops;
 607         struct iwl_op_mode *op_mode;
 608         const struct iwl_cfg *cfg;
 609         enum iwl_trans_state state;
 610         unsigned long status;
 611
 612         struct device *dev;
 613         u32 hw_rev;
 614         u32 hw_id;
 615         char hw_id_str[52];
 616
 617         u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
 618
 619         bool pm_support;
 620         bool ltr_enabled;
 621
 622         /* The following fields are internal only */
 623         struct kmem_cache *dev_cmd_pool;
 624         size_t dev_cmd_headroom;
 625         char dev_cmd_pool_name[50];
 626
 627         struct dentry *dbgfs_dir;
 628
 629 #ifdef CONFIG_LOCKDEP
 630         struct lockdep_map sync_cmd_lockdep_map;
 631 #endif
 632
 633         u64 dflt_pwr_limit;
 634
 635         const struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
 636         const struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
 637         struct iwl_fw_dbg_trigger_tlv * const *dbg_trigger_tlv;
 638         u8 dbg_dest_reg_num;
 639
 640         enum iwl_d0i3_mode d0i3_mode;
 641
 642         /* pointer to trans specific struct */
 643         /*Ensure that this pointer will always be aligned to sizeof pointer */
 644         char trans_specific[0] __aligned(sizeof(void *));
 645 };
 646
 647 static inline void iwl_trans_configure(struct iwl_trans *trans,
 648                                        const struct iwl_trans_config *trans_cfg)
 649 {
 650         trans->op_mode = trans_cfg->op_mode;
 651
 652         trans->ops->configure(trans, trans_cfg);
 653 }
 654
 655 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
 656 {
 657         might_sleep();
 658
 659         return trans->ops->start_hw(trans);
 660 }
 661
 662 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans)
 663 {
 664         might_sleep();
 665
 666         if (trans->ops->op_mode_leave)
 667                 trans->ops->op_mode_leave(trans);
 668
 669         trans->op_mode = NULL;
 670
 671         trans->state = IWL_TRANS_NO_FW;
 672 }
 673
 674 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
 675 {
 676         might_sleep();
 677
 678         trans->state = IWL_TRANS_FW_ALIVE;
 679
 680         trans->ops->fw_alive(trans, scd_addr);
 681 }
 682
 683 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
 684                                      const struct fw_img *fw,
 685                                      bool run_in_rfkill)
 686 {
 687         might_sleep();
 688
 689         WARN_ON_ONCE(!trans->rx_mpdu_cmd);
 690
 691         clear_bit(STATUS_FW_ERROR, &trans->status);
 692         return trans->ops->start_fw(trans, fw, run_in_rfkill);
 693 }
 694
 695 static inline int iwl_trans_update_sf(struct iwl_trans *trans,
 696                                       struct iwl_sf_region *st_fwrd_space)
 697 {
 698         might_sleep();
 699
 700         if (trans->ops->update_sf)
 701                 return trans->ops->update_sf(trans, st_fwrd_space);
 702
 703         return 0;
 704 }
 705
 706 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
 707 {
 708         might_sleep();
 709
 710         trans->ops->stop_device(trans);
 711
 712         trans->state = IWL_TRANS_NO_FW;
 713 }
 714
 715 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test)
 716 {
 717         might_sleep();
 718         trans->ops->d3_suspend(trans, test);
 719 }
 720
 721 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
 722                                       enum iwl_d3_status *status,
 723                                       bool test)
 724 {
 725         might_sleep();
 726         return trans->ops->d3_resume(trans, status, test);
 727 }
 728
 729 static inline void iwl_trans_ref(struct iwl_trans *trans)
 730 {
 731         if (trans->ops->ref)
 732                 trans->ops->ref(trans);
 733 }
 734
 735 static inline void iwl_trans_unref(struct iwl_trans *trans)
 736 {
 737         if (trans->ops->unref)
 738                 trans->ops->unref(trans);
 739 }
 740
 741 static inline void iwl_trans_suspend(struct iwl_trans *trans)
 742 {
 743         if (trans->ops->suspend)
 744                 trans->ops->suspend(trans);
 745 }
 746
 747 static inline void iwl_trans_resume(struct iwl_trans *trans)
 748 {
 749         if (trans->ops->resume)
 750                 trans->ops->resume(trans);
 751 }
 752
 753 static inline struct iwl_trans_dump_data *
 754 iwl_trans_dump_data(struct iwl_trans *trans)
 755 {
 756         if (!trans->ops->dump_data)
 757                 return NULL;
 758         return trans->ops->dump_data(trans);
 759 }
 760
 761 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
 762                                      struct iwl_host_cmd *cmd)
 763 {
 764         int ret;
 765
 766         if (unlikely(!(cmd->flags & CMD_SEND_IN_RFKILL) &&
 767                      test_bit(STATUS_RFKILL, &trans->status)))
 768                 return -ERFKILL;
 769
 770         if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
 771                 return -EIO;
 772
 773         if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) {
 774                 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
 775                 return -EIO;
 776         }
 777
 778         if (!(cmd->flags & CMD_ASYNC))
 779                 lock_map_acquire_read(&trans->sync_cmd_lockdep_map);
 780
 781         ret = trans->ops->send_cmd(trans, cmd);
 782
 783         if (!(cmd->flags & CMD_ASYNC))
 784                 lock_map_release(&trans->sync_cmd_lockdep_map);
 785
 786         return ret;
 787 }
 788
 789 static inline struct iwl_device_cmd *
 790 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
 791 {
 792         u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
 793
 794         if (unlikely(dev_cmd_ptr == NULL))
 795                 return NULL;
 796
 797         return (struct iwl_device_cmd *)
 798                         (dev_cmd_ptr + trans->dev_cmd_headroom);
 799 }
 800
 801 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
 802                                          struct iwl_device_cmd *dev_cmd)
 803 {
 804         u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom;
 805
 806         kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr);
 807 }
 808
 809 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
 810                                struct iwl_device_cmd *dev_cmd, int queue)
 811 {
 812         if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
 813                 return -EIO;
 814
 815         if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
 816                 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
 817
 818         return trans->ops->tx(trans, skb, dev_cmd, queue);
 819 }
 820
 821 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
 822                                      int ssn, struct sk_buff_head *skbs)
 823 {
 824         if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
 825                 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
 826
 827         trans->ops->reclaim(trans, queue, ssn, skbs);
 828 }
 829
 830 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue,
 831                                          bool configure_scd)
 832 {
 833         trans->ops->txq_disable(trans, queue, configure_scd);
 834 }
 835
 836 static inline void
 837 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn,
 838                          const struct iwl_trans_txq_scd_cfg *cfg,
 839                          unsigned int queue_wdg_timeout)
 840 {
 841         might_sleep();
 842
 843         if (unlikely((trans->state != IWL_TRANS_FW_ALIVE)))
 844                 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
 845
 846         trans->ops->txq_enable(trans, queue, ssn, cfg, queue_wdg_timeout);
 847 }
 848
 849 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
 850                                         int fifo, int sta_id, int tid,
 851                                         int frame_limit, u16 ssn,
 852                                         unsigned int queue_wdg_timeout)
 853 {
 854         struct iwl_trans_txq_scd_cfg cfg = {
 855                 .fifo = fifo,
 856                 .sta_id = sta_id,
 857                 .tid = tid,
 858                 .frame_limit = frame_limit,
 859                 .aggregate = sta_id >= 0,
 860         };
 861
 862         iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout);
 863 }
 864
 865 static inline
 866 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo,
 867                              unsigned int queue_wdg_timeout)
 868 {
 869         struct iwl_trans_txq_scd_cfg cfg = {
 870                 .fifo = fifo,
 871                 .sta_id = -1,
 872                 .tid = IWL_MAX_TID_COUNT,
 873                 .frame_limit = IWL_FRAME_LIMIT,
 874                 .aggregate = false,
 875         };
 876
 877         iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout);
 878 }
 879
 880 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans,
 881                                               unsigned long txqs,
 882                                               bool freeze)
 883 {
 884         if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
 885                 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
 886
 887         if (trans->ops->freeze_txq_timer)
 888                 trans->ops->freeze_txq_timer(trans, txqs, freeze);
 889 }
 890
 891 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans,
 892                                                 u32 txqs)
 893 {
 894         if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
 895                 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
 896
 897         return trans->ops->wait_tx_queue_empty(trans, txqs);
 898 }
 899
 900 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
 901                                            struct dentry *dir)
 902 {
 903         return trans->ops->dbgfs_register(trans, dir);
 904 }
 905
 906 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
 907 {
 908         trans->ops->write8(trans, ofs, val);
 909 }
 910
 911 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
 912 {
 913         trans->ops->write32(trans, ofs, val);
 914 }
 915
 916 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
 917 {
 918         return trans->ops->read32(trans, ofs);
 919 }
 920
 921 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
 922 {
 923         return trans->ops->read_prph(trans, ofs);
 924 }
 925
 926 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
 927                                         u32 val)
 928 {
 929         return trans->ops->write_prph(trans, ofs, val);
 930 }
 931
 932 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
 933                                      void *buf, int dwords)
 934 {
 935         return trans->ops->read_mem(trans, addr, buf, dwords);
 936 }
 937
 938 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize)                   \
 939         do {                                                                  \
 940                 if (__builtin_constant_p(bufsize))                            \
 941                         BUILD_BUG_ON((bufsize) % sizeof(u32));                \
 942                 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
 943         } while (0)
 944
 945 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
 946 {
 947         u32 value;
 948
 949         if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
 950                 return 0xa5a5a5a5;
 951
 952         return value;
 953 }
 954
 955 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
 956                                       const void *buf, int dwords)
 957 {
 958         return trans->ops->write_mem(trans, addr, buf, dwords);
 959 }
 960
 961 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
 962                                         u32 val)
 963 {
 964         return iwl_trans_write_mem(trans, addr, &val, 1);
 965 }
 966
 967 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
 968 {
 969         if (trans->ops->set_pmi)
 970                 trans->ops->set_pmi(trans, state);
 971 }
 972
 973 static inline void
 974 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
 975 {
 976         trans->ops->set_bits_mask(trans, reg, mask, value);
 977 }
 978
 979 #define iwl_trans_grab_nic_access(trans, silent, flags) \
 980         __cond_lock(nic_access,                         \
 981                     likely((trans)->ops->grab_nic_access(trans, silent, flags)))
 982
 983 static inline void __releases(nic_access)
 984 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
 985 {
 986         trans->ops->release_nic_access(trans, flags);
 987         __release(nic_access);
 988 }
 989
 990 static inline void iwl_trans_fw_error(struct iwl_trans *trans)
 991 {
 992         if (WARN_ON_ONCE(!trans->op_mode))
 993                 return;
 994
 995         /* prevent double restarts due to the same erroneous FW */
 996         if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status))
 997                 iwl_op_mode_nic_error(trans->op_mode);
 998 }
 999
1000 /*****************************************************
1001 * driver (transport) register/unregister functions
1002 ******************************************************/
1003 int __must_check iwl_pci_register_driver(void);
1004 void iwl_pci_unregister_driver(void);
1005
1006 static inline void trans_lockdep_init(struct iwl_trans *trans)
1007 {
1008 #ifdef CONFIG_LOCKDEP
1009         static struct lock_class_key __key;
1010
1011         lockdep_init_map(&trans->sync_cmd_lockdep_map, "sync_cmd_lockdep_map",
1012                          &__key, 0);
1013 #endif
1014 }
1015
1016 #endif /* __iwl_trans_h__ */