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

   1 /******************************************************************************
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called LICENSE.GPL.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63 #ifndef __iwl_trans_h__
  64 #define __iwl_trans_h__
  65
  66 #include <linux/debugfs.h>
  67 #include <linux/skbuff.h>
  68
  69 #include "iwl-shared.h"
  70 #include "iwl-commands.h"
  71 #include "iwl-ucode.h"
  72 #include "iwl-debug.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: API needed by the transport layer from the op_mode
 111  *
 112  * TODO
 113  */
 114
 115 struct iwl_priv;
 116 struct iwl_shared;
 117
 118 /**
 119  * DOC: Host command section
 120  *
 121  * A host command is a commaned issued by the upper layer to the fw. There are
 122  * several versions of fw that have several APIs. The transport layer is
 123  * completely agnostic to these differences.
 124  * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode),
 125  */
 126 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
 127 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
 128 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
 129
 130 /**
 131  * enum CMD_MODE - how to send the host commands ?
 132  *
 133  * @CMD_SYNC: The caller will be stalled until the fw responds to the command
 134  * @CMD_ASYNC: Return right away and don't want for the response
 135  * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
 136  *      response.
 137  * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
 138  */
 139 enum CMD_MODE {
 140         CMD_SYNC = 0,
 141         CMD_ASYNC = BIT(0),
 142         CMD_WANT_SKB = BIT(1),
 143         CMD_ON_DEMAND = BIT(2),
 144 };
 145
 146 #define DEF_CMD_PAYLOAD_SIZE 320
 147
 148 /**
 149  * struct iwl_device_cmd
 150  *
 151  * For allocation of the command and tx queues, this establishes the overall
 152  * size of the largest command we send to uCode, except for commands that
 153  * aren't fully copied and use other TFD space.
 154  */
 155 struct iwl_device_cmd {
 156         struct iwl_cmd_header hdr;      /* uCode API */
 157         u8 payload[DEF_CMD_PAYLOAD_SIZE];
 158 } __packed;
 159
 160 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
 161
 162 #define IWL_MAX_CMD_TFDS        2
 163
 164 /**
 165  * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
 166  *
 167  * IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
 168  *      ring. The transport layer doesn't map the command's buffer to DMA, but
 169  *      rather copies it to an previously allocated DMA buffer. This flag tells
 170  *      the transport layer not to copy the command, but to map the existing
 171  *      buffer. This can save memcpy and is worth with very big comamnds.
 172  */
 173 enum iwl_hcmd_dataflag {
 174         IWL_HCMD_DFL_NOCOPY     = BIT(0),
 175 };
 176
 177 /**
 178  * struct iwl_host_cmd - Host command to the uCode
 179  *
 180  * @data: array of chunks that composes the data of the host command
 181  * @reply_page: pointer to the page that holds the response to the host command
 182  * @handler_status: return value of the handler of the command
 183  *      (put in setup_rx_handlers) - valid for SYNC mode only
 184  * @flags: can be CMD_*
 185  * @len: array of the lenths of the chunks in data
 186  * @dataflags: IWL_HCMD_DFL_*
 187  * @id: id of the host command
 188  */
 189 struct iwl_host_cmd {
 190         const void *data[IWL_MAX_CMD_TFDS];
 191         unsigned long reply_page;
 192         int handler_status;
 193
 194         u32 flags;
 195         u16 len[IWL_MAX_CMD_TFDS];
 196         u8 dataflags[IWL_MAX_CMD_TFDS];
 197         u8 id;
 198 };
 199
 200 /**
 201  * struct iwl_trans_ops - transport specific operations
 202  *
 203  * All the handlers MUST be implemented
 204  *
 205  * @start_hw: starts the HW- from that point on, the HW can send interrupts
 206  *      May sleep
 207  * @stop_hw: stops the HW- from that point on, the HW will be in low power but
 208  *      will still issue interrupt if the HW RF kill is triggered.
 209  *      May sleep
 210  * @start_fw: allocates and inits all the resources for the transport
 211  *      layer. Also kick a fw image.
 212  *      May sleep
 213  * @fw_alive: called when the fw sends alive notification
 214  *      May sleep
 215  * @wake_any_queue: wake all the queues of a specfic context IWL_RXON_CTX_*
 216  * @stop_device:stops the whole device (embedded CPU put to reset)
 217  *      May sleep
 218  * @send_cmd:send a host command
 219  *      May sleep only if CMD_SYNC is set
 220  * @tx: send an skb
 221  *      Must be atomic
 222  * @reclaim: free packet until ssn. Returns a list of freed packets.
 223  *      Must be atomic
 224  * @tx_agg_alloc: allocate resources for a TX BA session
 225  *      May sleep
 226  * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
 227  *      ready and a successful ADDBA response has been received.
 228  *      May sleep
 229  * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
 230  *      May sleep
 231  * @free: release all the ressource for the transport layer itself such as
 232  *      irq, tasklet etc... From this point on, the device may not issue
 233  *      any interrupt (incl. RFKILL).
 234  *      May sleep
 235  * @stop_queue: stop a specific queue
 236  * @check_stuck_queue: check if a specific queue is stuck
 237  * @wait_tx_queue_empty: wait until all tx queues are empty
 238  *      May sleep
 239  * @dbgfs_register: add the dbgfs files under this directory. Files will be
 240  *      automatically deleted.
 241  * @suspend: stop the device unless WoWLAN is configured
 242  * @resume: resume activity of the device
 243  * @write8: write a u8 to a register at offset ofs from the BAR
 244  * @write32: write a u32 to a register at offset ofs from the BAR
 245  * @read32: read a u32 register at offset ofs from the BAR
 246  */
 247 struct iwl_trans_ops {
 248
 249         int (*start_hw)(struct iwl_trans *iwl_trans);
 250         void (*stop_hw)(struct iwl_trans *iwl_trans);
 251         int (*start_fw)(struct iwl_trans *trans, struct fw_img *fw);
 252         void (*fw_alive)(struct iwl_trans *trans);
 253         void (*stop_device)(struct iwl_trans *trans);
 254
 255         void (*wake_any_queue)(struct iwl_trans *trans,
 256                                enum iwl_rxon_context_id ctx,
 257                                const char *msg);
 258
 259         int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
 260
 261         int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
 262                 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
 263                 u8 sta_id, u8 tid);
 264         int (*reclaim)(struct iwl_trans *trans, int sta_id, int tid,
 265                         int txq_id, int ssn, u32 status,
 266                         struct sk_buff_head *skbs);
 267
 268         int (*tx_agg_disable)(struct iwl_trans *trans,
 269                               int sta_id, int tid);
 270         int (*tx_agg_alloc)(struct iwl_trans *trans,
 271                             int sta_id, int tid);
 272         void (*tx_agg_setup)(struct iwl_trans *trans,
 273                              enum iwl_rxon_context_id ctx, int sta_id, int tid,
 274                              int frame_limit, u16 ssn);
 275
 276         void (*free)(struct iwl_trans *trans);
 277
 278         void (*stop_queue)(struct iwl_trans *trans, int q, const char *msg);
 279
 280         int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
 281         int (*check_stuck_queue)(struct iwl_trans *trans, int q);
 282         int (*wait_tx_queue_empty)(struct iwl_trans *trans);
 283 #ifdef CONFIG_PM_SLEEP
 284         int (*suspend)(struct iwl_trans *trans);
 285         int (*resume)(struct iwl_trans *trans);
 286 #endif
 287         void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
 288         void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
 289         u32 (*read32)(struct iwl_trans *trans, u32 ofs);
 290 };
 291
 292 /* Opaque calibration results */
 293 struct iwl_calib_result {
 294         struct list_head list;
 295         size_t cmd_len;
 296         struct iwl_calib_hdr hdr;
 297         /* data follows */
 298 };
 299
 300 /**
 301  * enum iwl_trans_state - state of the transport layer
 302  *
 303  * @IWL_TRANS_NO_FW: no fw has sent an alive response
 304  * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
 305  */
 306 enum iwl_trans_state {
 307         IWL_TRANS_NO_FW = 0,
 308         IWL_TRANS_FW_ALIVE      = 1,
 309 };
 310
 311 /**
 312  * struct iwl_trans - transport common data
 313  *
 314  * @ops - pointer to iwl_trans_ops
 315  * @shrd - pointer to iwl_shared which holds shared data from the upper layer
 316  * @hcmd_lock: protects HCMD
 317  * @reg_lock - protect hw register access
 318  * @dev - pointer to struct device * that represents the device
 319  * @irq - the irq number for the device
 320  * @hw_id: a u32 with the ID of the device / subdevice.
 321  *      Set during transport allocation.
 322  * @hw_id_str: a string with info about HW ID. Set during transport allocation.
 323  * @ucode_write_complete: indicates that the ucode has been copied.
 324  * @nvm_device_type: indicates OTP or eeprom
 325  * @pm_support: set to true in start_hw if link pm is supported
 326  * @calib_results: list head for init calibration results
 327  */
 328 struct iwl_trans {
 329         const struct iwl_trans_ops *ops;
 330         struct iwl_shared *shrd;
 331         enum iwl_trans_state state;
 332         spinlock_t hcmd_lock;
 333         spinlock_t reg_lock;
 334
 335         struct device *dev;
 336         unsigned int irq;
 337         u32 hw_rev;
 338         u32 hw_id;
 339         char hw_id_str[52];
 340
 341         u8 ucode_write_complete;
 342
 343         int    nvm_device_type;
 344         bool pm_support;
 345
 346         struct list_head calib_results;
 347
 348         /* pointer to trans specific struct */
 349         /*Ensure that this pointer will always be aligned to sizeof pointer */
 350         char trans_specific[0] __attribute__((__aligned__(sizeof(void *))));
 351 };
 352
 353 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
 354 {
 355         might_sleep();
 356
 357         return trans->ops->start_hw(trans);
 358 }
 359
 360 static inline void iwl_trans_stop_hw(struct iwl_trans *trans)
 361 {
 362         might_sleep();
 363
 364         trans->ops->stop_hw(trans);
 365
 366         trans->state = IWL_TRANS_NO_FW;
 367 }
 368
 369 static inline void iwl_trans_fw_alive(struct iwl_trans *trans)
 370 {
 371         might_sleep();
 372
 373         trans->ops->fw_alive(trans);
 374
 375         trans->state = IWL_TRANS_FW_ALIVE;
 376 }
 377
 378 static inline int iwl_trans_start_fw(struct iwl_trans *trans, struct fw_img *fw)
 379 {
 380         might_sleep();
 381
 382         return trans->ops->start_fw(trans, fw);
 383 }
 384
 385 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
 386 {
 387         might_sleep();
 388
 389         trans->ops->stop_device(trans);
 390
 391         trans->state = IWL_TRANS_NO_FW;
 392 }
 393
 394 static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans,
 395                                             enum iwl_rxon_context_id ctx,
 396                                             const char *msg)
 397 {
 398         if (trans->state != IWL_TRANS_FW_ALIVE)
 399                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 400
 401         trans->ops->wake_any_queue(trans, ctx, msg);
 402 }
 403
 404
 405 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
 406                                 struct iwl_host_cmd *cmd)
 407 {
 408         if (trans->state != IWL_TRANS_FW_ALIVE)
 409                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 410
 411         return trans->ops->send_cmd(trans, cmd);
 412 }
 413
 414 int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id,
 415                            u32 flags, u16 len, const void *data);
 416
 417 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
 418                 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
 419                 u8 sta_id, u8 tid)
 420 {
 421         if (trans->state != IWL_TRANS_FW_ALIVE)
 422                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 423
 424         return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id, tid);
 425 }
 426
 427 static inline int iwl_trans_reclaim(struct iwl_trans *trans, int sta_id,
 428                                  int tid, int txq_id, int ssn, u32 status,
 429                                  struct sk_buff_head *skbs)
 430 {
 431         if (trans->state != IWL_TRANS_FW_ALIVE)
 432                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 433
 434         return trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn,
 435                                    status, skbs);
 436 }
 437
 438 static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans,
 439                                             int sta_id, int tid)
 440 {
 441         might_sleep();
 442
 443         if (trans->state != IWL_TRANS_FW_ALIVE)
 444                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 445
 446         return trans->ops->tx_agg_disable(trans, sta_id, tid);
 447 }
 448
 449 static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans,
 450                                          int sta_id, int tid)
 451 {
 452         might_sleep();
 453
 454         if (trans->state != IWL_TRANS_FW_ALIVE)
 455                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 456
 457         return trans->ops->tx_agg_alloc(trans, sta_id, tid);
 458 }
 459
 460
 461 static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans,
 462                                            enum iwl_rxon_context_id ctx,
 463                                            int sta_id, int tid,
 464                                            int frame_limit, u16 ssn)
 465 {
 466         might_sleep();
 467
 468         if (trans->state != IWL_TRANS_FW_ALIVE)
 469                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 470
 471         trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit, ssn);
 472 }
 473
 474 static inline void iwl_trans_free(struct iwl_trans *trans)
 475 {
 476         trans->ops->free(trans);
 477 }
 478
 479 static inline void iwl_trans_stop_queue(struct iwl_trans *trans, int q,
 480                                         const char *msg)
 481 {
 482         if (trans->state != IWL_TRANS_FW_ALIVE)
 483                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 484
 485         trans->ops->stop_queue(trans, q, msg);
 486 }
 487
 488 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
 489 {
 490         if (trans->state != IWL_TRANS_FW_ALIVE)
 491                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 492
 493         return trans->ops->wait_tx_queue_empty(trans);
 494 }
 495
 496 static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q)
 497 {
 498         if (trans->state != IWL_TRANS_FW_ALIVE)
 499                 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
 500
 501         return trans->ops->check_stuck_queue(trans, q);
 502 }
 503 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
 504                                             struct dentry *dir)
 505 {
 506         return trans->ops->dbgfs_register(trans, dir);
 507 }
 508
 509 #ifdef CONFIG_PM_SLEEP
 510 static inline int iwl_trans_suspend(struct iwl_trans *trans)
 511 {
 512         return trans->ops->suspend(trans);
 513 }
 514
 515 static inline int iwl_trans_resume(struct iwl_trans *trans)
 516 {
 517         return trans->ops->resume(trans);
 518 }
 519 #endif
 520
 521 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
 522 {
 523         trans->ops->write8(trans, ofs, val);
 524 }
 525
 526 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
 527 {
 528         trans->ops->write32(trans, ofs, val);
 529 }
 530
 531 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
 532 {
 533         return trans->ops->read32(trans, ofs);
 534 }
 535
 536 /*****************************************************
 537 * Utils functions
 538 ******************************************************/
 539 int iwl_send_calib_results(struct iwl_trans *trans);
 540 int iwl_calib_set(struct iwl_trans *trans,
 541                   const struct iwl_calib_hdr *cmd, int len);
 542 void iwl_calib_free_results(struct iwl_trans *trans);
 543
 544 /*****************************************************
 545 * Transport layers implementations + their allocation function
 546 ******************************************************/
 547 struct pci_dev;
 548 struct pci_device_id;
 549 extern const struct iwl_trans_ops trans_ops_pcie;
 550 struct iwl_trans *iwl_trans_pcie_alloc(struct iwl_shared *shrd,
 551                                        struct pci_dev *pdev,
 552                                        const struct pci_device_id *ent);
 553
 554 extern const struct iwl_trans_ops trans_ops_idi;
 555 struct iwl_trans *iwl_trans_idi_alloc(struct iwl_shared *shrd,
 556                                       void *pdev_void,
 557                                       const void *ent_void);
 558 #endif /* __iwl_trans_h__ */