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
  72  /*This file includes the declaration that are exported from the transport
  73  * layer */
  74
  75 struct iwl_priv;
  76 struct iwl_shared;
  77
  78 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
  79 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
  80 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
  81
  82 enum {
  83         CMD_SYNC = 0,
  84         CMD_ASYNC = BIT(0),
  85         CMD_WANT_SKB = BIT(1),
  86         CMD_ON_DEMAND = BIT(2),
  87 };
  88
  89 #define DEF_CMD_PAYLOAD_SIZE 320
  90
  91 /**
  92  * struct iwl_device_cmd
  93  *
  94  * For allocation of the command and tx queues, this establishes the overall
  95  * size of the largest command we send to uCode, except for commands that
  96  * aren't fully copied and use other TFD space.
  97  */
  98 struct iwl_device_cmd {
  99         struct iwl_cmd_header hdr;      /* uCode API */
 100         u8 payload[DEF_CMD_PAYLOAD_SIZE];
 101 } __packed;
 102
 103 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
 104
 105 #define IWL_MAX_CMD_TFDS        2
 106
 107 enum iwl_hcmd_dataflag {
 108         IWL_HCMD_DFL_NOCOPY     = BIT(0),
 109 };
 110
 111 /**
 112  * struct iwl_host_cmd - Host command to the uCode
 113  * @data: array of chunks that composes the data of the host command
 114  * @reply_page: pointer to the page that holds the response to the host command
 115  * @handler_status: return value of the handler of the command
 116  *      (put in setup_rx_handlers) - valid for SYNC mode only
 117  * @callback:
 118  * @flags: can be CMD_* note CMD_WANT_SKB is incompatible withe CMD_ASYNC
 119  * @len: array of the lenths of the chunks in data
 120  * @dataflags:
 121  * @id: id of the host command
 122  */
 123 struct iwl_host_cmd {
 124         const void *data[IWL_MAX_CMD_TFDS];
 125         unsigned long reply_page;
 126         int handler_status;
 127
 128         u32 flags;
 129         u16 len[IWL_MAX_CMD_TFDS];
 130         u8 dataflags[IWL_MAX_CMD_TFDS];
 131         u8 id;
 132 };
 133
 134 /**
 135  * struct iwl_trans_ops - transport specific operations
 136  * @request_irq: requests IRQ - will be called before the FW load in probe flow
 137  * @start_device: allocates and inits all the resources for the transport
 138  *                layer.
 139  * @prepare_card_hw: claim the ownership on the HW. Will be called during
 140  *                   probe.
 141  * @fw_alive: called when the fw sends alive notification
 142  * @wake_any_queue: wake all the queues of a specfic context IWL_RXON_CTX_*
 143  * @stop_device:stops the whole device (embedded CPU put to reset)
 144  * @send_cmd:send a host command
 145  * @tx: send an skb
 146  * @reclaim: free packet until ssn. Returns a list of freed packets.
 147  * @tx_agg_alloc: allocate resources for a TX BA session
 148  * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
 149  *                 ready and a successful ADDBA response has been received.
 150  * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
 151  * @kick_nic: remove the RESET from the embedded CPU and let it run
 152  * @free: release all the ressource for the transport layer itself such as
 153  *        irq, tasklet etc...
 154  * @stop_queue: stop a specific queue
 155  * @check_stuck_queue: check if a specific queue is stuck
 156  * @wait_tx_queue_empty: wait until all tx queues are empty
 157  * @dbgfs_register: add the dbgfs files under this directory. Files will be
 158  *      automatically deleted.
 159  * @suspend: stop the device unless WoWLAN is configured
 160  * @resume: resume activity of the device
 161  */
 162 struct iwl_trans_ops {
 163
 164         int (*request_irq)(struct iwl_trans *iwl_trans);
 165         int (*start_device)(struct iwl_trans *trans);
 166         void (*fw_alive)(struct iwl_trans *trans);
 167         int (*prepare_card_hw)(struct iwl_trans *trans);
 168         void (*stop_device)(struct iwl_trans *trans);
 169
 170         void (*wake_any_queue)(struct iwl_trans *trans,
 171                                enum iwl_rxon_context_id ctx,
 172                                const char *msg);
 173
 174         int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
 175
 176         int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
 177                 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
 178                 u8 sta_id, u8 tid);
 179         int (*reclaim)(struct iwl_trans *trans, int sta_id, int tid,
 180                         int txq_id, int ssn, u32 status,
 181                         struct sk_buff_head *skbs);
 182
 183         int (*tx_agg_disable)(struct iwl_trans *trans,
 184                               int sta_id, int tid);
 185         int (*tx_agg_alloc)(struct iwl_trans *trans,
 186                             int sta_id, int tid);
 187         void (*tx_agg_setup)(struct iwl_trans *trans,
 188                              enum iwl_rxon_context_id ctx, int sta_id, int tid,
 189                              int frame_limit, u16 ssn);
 190
 191         void (*kick_nic)(struct iwl_trans *trans);
 192
 193         void (*free)(struct iwl_trans *trans);
 194
 195         void (*stop_queue)(struct iwl_trans *trans, int q, const char *msg);
 196
 197         int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
 198         int (*check_stuck_queue)(struct iwl_trans *trans, int q);
 199         int (*wait_tx_queue_empty)(struct iwl_trans *trans);
 200 #ifdef CONFIG_PM_SLEEP
 201         int (*suspend)(struct iwl_trans *trans);
 202         int (*resume)(struct iwl_trans *trans);
 203 #endif
 204 };
 205
 206 /* one for each uCode image (inst/data, boot/init/runtime) */
 207 struct fw_desc {
 208         dma_addr_t p_addr;      /* hardware address */
 209         void *v_addr;           /* software address */
 210         u32 len;                /* size in bytes */
 211 };
 212
 213 struct fw_img {
 214         struct fw_desc code;    /* firmware code image */
 215         struct fw_desc data;    /* firmware data image */
 216 };
 217
 218 /* Opaque calibration results */
 219 struct iwl_calib_result {
 220         struct list_head list;
 221         size_t cmd_len;
 222         struct iwl_calib_hdr hdr;
 223         /* data follows */
 224 };
 225
 226 /**
 227  * struct iwl_trans - transport common data
 228  * @ops - pointer to iwl_trans_ops
 229  * @shrd - pointer to iwl_shared which holds shared data from the upper layer
 230  * @hcmd_lock: protects HCMD
 231  * @ucode_write_complete: indicates that the ucode has been copied.
 232  * @ucode_rt: run time ucode image
 233  * @ucode_init: init ucode image
 234  * @ucode_wowlan: wake on wireless ucode image (optional)
 235  * @nvm_device_type: indicates OTP or eeprom
 236  * @calib_results: list head for init calibration results
 237  */
 238 struct iwl_trans {
 239         const struct iwl_trans_ops *ops;
 240         struct iwl_shared *shrd;
 241         spinlock_t hcmd_lock;
 242
 243         u8 ucode_write_complete;        /* the image write is complete */
 244         struct fw_img ucode_rt;
 245         struct fw_img ucode_init;
 246         struct fw_img ucode_wowlan;
 247
 248         /* eeprom related variables */
 249         int    nvm_device_type;
 250
 251         /* init calibration results */
 252         struct list_head calib_results;
 253
 254         /* pointer to trans specific struct */
 255         /*Ensure that this pointer will always be aligned to sizeof pointer */
 256         char trans_specific[0] __attribute__((__aligned__(sizeof(void *))));
 257 };
 258
 259 static inline int iwl_trans_request_irq(struct iwl_trans *trans)
 260 {
 261         return trans->ops->request_irq(trans);
 262 }
 263
 264 static inline void iwl_trans_fw_alive(struct iwl_trans *trans)
 265 {
 266         trans->ops->fw_alive(trans);
 267 }
 268
 269 static inline int iwl_trans_start_device(struct iwl_trans *trans)
 270 {
 271         return trans->ops->start_device(trans);
 272 }
 273
 274 static inline int iwl_trans_prepare_card_hw(struct iwl_trans *trans)
 275 {
 276         return trans->ops->prepare_card_hw(trans);
 277 }
 278
 279 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
 280 {
 281         trans->ops->stop_device(trans);
 282 }
 283
 284 static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans,
 285                                             enum iwl_rxon_context_id ctx,
 286                                             const char *msg)
 287 {
 288         trans->ops->wake_any_queue(trans, ctx, msg);
 289 }
 290
 291
 292 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
 293                                 struct iwl_host_cmd *cmd)
 294 {
 295         return trans->ops->send_cmd(trans, cmd);
 296 }
 297
 298 int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id,
 299                            u32 flags, u16 len, const void *data);
 300
 301 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
 302                 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
 303                 u8 sta_id, u8 tid)
 304 {
 305         return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id, tid);
 306 }
 307
 308 static inline int iwl_trans_reclaim(struct iwl_trans *trans, int sta_id,
 309                                  int tid, int txq_id, int ssn, u32 status,
 310                                  struct sk_buff_head *skbs)
 311 {
 312         return trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn,
 313                                    status, skbs);
 314 }
 315
 316 static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans,
 317                                             int sta_id, int tid)
 318 {
 319         return trans->ops->tx_agg_disable(trans, sta_id, tid);
 320 }
 321
 322 static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans,
 323                                          int sta_id, int tid)
 324 {
 325         return trans->ops->tx_agg_alloc(trans, sta_id, tid);
 326 }
 327
 328
 329 static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans,
 330                                            enum iwl_rxon_context_id ctx,
 331                                            int sta_id, int tid,
 332                                            int frame_limit, u16 ssn)
 333 {
 334         trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit, ssn);
 335 }
 336
 337 static inline void iwl_trans_kick_nic(struct iwl_trans *trans)
 338 {
 339         trans->ops->kick_nic(trans);
 340 }
 341
 342 static inline void iwl_trans_free(struct iwl_trans *trans)
 343 {
 344         trans->ops->free(trans);
 345 }
 346
 347 static inline void iwl_trans_stop_queue(struct iwl_trans *trans, int q,
 348                                         const char *msg)
 349 {
 350         trans->ops->stop_queue(trans, q, msg);
 351 }
 352
 353 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
 354 {
 355         return trans->ops->wait_tx_queue_empty(trans);
 356 }
 357
 358 static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q)
 359 {
 360         return trans->ops->check_stuck_queue(trans, q);
 361 }
 362 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
 363                                             struct dentry *dir)
 364 {
 365         return trans->ops->dbgfs_register(trans, dir);
 366 }
 367
 368 #ifdef CONFIG_PM_SLEEP
 369 static inline int iwl_trans_suspend(struct iwl_trans *trans)
 370 {
 371         return trans->ops->suspend(trans);
 372 }
 373
 374 static inline int iwl_trans_resume(struct iwl_trans *trans)
 375 {
 376         return trans->ops->resume(trans);
 377 }
 378 #endif
 379
 380 /*****************************************************
 381 * Utils functions
 382 ******************************************************/
 383 int iwl_alloc_fw_desc(struct iwl_bus *bus, struct fw_desc *desc,
 384                       const void *data, size_t len);
 385 void iwl_dealloc_ucode(struct iwl_trans *trans);
 386
 387 int iwl_send_calib_results(struct iwl_trans *trans);
 388 int iwl_calib_set(struct iwl_trans *trans,
 389                   const struct iwl_calib_hdr *cmd, int len);
 390 void iwl_calib_free_results(struct iwl_trans *trans);
 391
 392 /*****************************************************
 393 * Transport layers implementations + their allocation function
 394 ******************************************************/
 395 struct pci_dev;
 396 struct pci_device_id;
 397 extern const struct iwl_trans_ops trans_ops_pcie;
 398 struct iwl_trans *iwl_trans_pcie_alloc(struct iwl_shared *shrd,
 399                                        struct pci_dev *pdev,
 400                                        const struct pci_device_id *ent);
 401
 402 extern const struct iwl_trans_ops trans_ops_idi;
 403 struct iwl_trans *iwl_trans_idi_alloc(struct iwl_shared *shrd,
 404                                       void *pdev_void,
 405                                       const void *ent_void);
 406 #endif /* __iwl_trans_h__ */