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

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