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