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 /* one for each uCode image (inst/data, boot/init/runtime) */
 135 struct fw_desc {
 136         dma_addr_t p_addr;      /* hardware address */
 137         void *v_addr;           /* software address */
 138         u32 len;                /* size in bytes */
 139 };
 140
 141 struct fw_img {
 142         struct fw_desc code;    /* firmware code image */
 143         struct fw_desc data;    /* firmware data image */
 144 };
 145
 146 /**
 147  * struct iwl_trans_ops - transport specific operations
 148  * @start_hw: starts the HW- from that point on, the HW can send interrupts
 149  * @stop_hw: stops the HW- from that point on, the HW will be in low power but
 150  *      will still issue interrupt if the HW RF kill is triggered.
 151  * @start_fw: allocates and inits all the resources for the transport
 152  *      layer. Also kick a fw image. This handler may sleep.
 153  * @fw_alive: called when the fw sends alive notification
 154  * @wake_any_queue: wake all the queues of a specfic context IWL_RXON_CTX_*
 155  * @stop_device:stops the whole device (embedded CPU put to reset)
 156  * @send_cmd:send a host command
 157  * @tx: send an skb
 158  * @reclaim: free packet until ssn. Returns a list of freed packets.
 159  * @tx_agg_alloc: allocate resources for a TX BA session
 160  * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
 161  *                 ready and a successful ADDBA response has been received.
 162  * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
 163  * @free: release all the ressource for the transport layer itself such as
 164  *        irq, tasklet etc...
 165  * @stop_queue: stop a specific queue
 166  * @check_stuck_queue: check if a specific queue is stuck
 167  * @wait_tx_queue_empty: wait until all tx queues are empty
 168  * @dbgfs_register: add the dbgfs files under this directory. Files will be
 169  *      automatically deleted.
 170  * @suspend: stop the device unless WoWLAN is configured
 171  * @resume: resume activity of the device
 172  * @write8: write a u8 to a register at offset ofs from the BAR
 173  * @write32: write a u32 to a register at offset ofs from the BAR
 174  * @read32: read a u32 register at offset ofs from the BAR
 175  */
 176 struct iwl_trans_ops {
 177
 178         int (*start_hw)(struct iwl_trans *iwl_trans);
 179         void (*stop_hw)(struct iwl_trans *iwl_trans);
 180         int (*start_fw)(struct iwl_trans *trans, struct fw_img *fw);
 181         void (*fw_alive)(struct iwl_trans *trans);
 182         void (*stop_device)(struct iwl_trans *trans);
 183
 184         void (*wake_any_queue)(struct iwl_trans *trans,
 185                                enum iwl_rxon_context_id ctx,
 186                                const char *msg);
 187
 188         int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
 189
 190         int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
 191                 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
 192                 u8 sta_id, u8 tid);
 193         int (*reclaim)(struct iwl_trans *trans, int sta_id, int tid,
 194                         int txq_id, int ssn, u32 status,
 195                         struct sk_buff_head *skbs);
 196
 197         int (*tx_agg_disable)(struct iwl_trans *trans,
 198                               int sta_id, int tid);
 199         int (*tx_agg_alloc)(struct iwl_trans *trans,
 200                             int sta_id, int tid);
 201         void (*tx_agg_setup)(struct iwl_trans *trans,
 202                              enum iwl_rxon_context_id ctx, int sta_id, int tid,
 203                              int frame_limit, u16 ssn);
 204
 205         void (*free)(struct iwl_trans *trans);
 206
 207         void (*stop_queue)(struct iwl_trans *trans, int q, const char *msg);
 208
 209         int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
 210         int (*check_stuck_queue)(struct iwl_trans *trans, int q);
 211         int (*wait_tx_queue_empty)(struct iwl_trans *trans);
 212 #ifdef CONFIG_PM_SLEEP
 213         int (*suspend)(struct iwl_trans *trans);
 214         int (*resume)(struct iwl_trans *trans);
 215 #endif
 216         void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
 217         void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
 218         u32 (*read32)(struct iwl_trans *trans, u32 ofs);
 219 };
 220
 221 /* Opaque calibration results */
 222 struct iwl_calib_result {
 223         struct list_head list;
 224         size_t cmd_len;
 225         struct iwl_calib_hdr hdr;
 226         /* data follows */
 227 };
 228
 229 /**
 230  * struct iwl_trans - transport common data
 231  * @ops - pointer to iwl_trans_ops
 232  * @shrd - pointer to iwl_shared which holds shared data from the upper layer
 233  * @hcmd_lock: protects HCMD
 234  * @reg_lock - protect hw register access
 235  * @dev - pointer to struct device * that represents the device
 236  * @irq - the irq number for the device
 237  * @ucode_write_complete: indicates that the ucode has been copied.
 238  * @ucode_rt: run time ucode image
 239  * @ucode_init: init ucode image
 240  * @ucode_wowlan: wake on wireless ucode image (optional)
 241  * @nvm_device_type: indicates OTP or eeprom
 242  * @calib_results: list head for init calibration results
 243  */
 244 struct iwl_trans {
 245         const struct iwl_trans_ops *ops;
 246         struct iwl_shared *shrd;
 247         spinlock_t hcmd_lock;
 248         spinlock_t reg_lock;
 249
 250         struct device *dev;
 251         unsigned int irq;
 252
 253         u8 ucode_write_complete;        /* the image write is complete */
 254         struct fw_img ucode_rt;
 255         struct fw_img ucode_init;
 256         struct fw_img ucode_wowlan;
 257
 258         /* eeprom related variables */
 259         int    nvm_device_type;
 260
 261         /* init calibration results */
 262         struct list_head calib_results;
 263
 264         /* pointer to trans specific struct */
 265         /*Ensure that this pointer will always be aligned to sizeof pointer */
 266         char trans_specific[0] __attribute__((__aligned__(sizeof(void *))));
 267 };
 268
 269 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
 270 {
 271         return trans->ops->start_hw(trans);
 272 }
 273
 274 static inline void iwl_trans_stop_hw(struct iwl_trans *trans)
 275 {
 276         trans->ops->stop_hw(trans);
 277 }
 278
 279 static inline void iwl_trans_fw_alive(struct iwl_trans *trans)
 280 {
 281         trans->ops->fw_alive(trans);
 282 }
 283
 284 static inline int iwl_trans_start_fw(struct iwl_trans *trans, struct fw_img *fw)
 285 {
 286         might_sleep();
 287
 288         return trans->ops->start_fw(trans, fw);
 289 }
 290
 291 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
 292 {
 293         trans->ops->stop_device(trans);
 294 }
 295
 296 static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans,
 297                                             enum iwl_rxon_context_id ctx,
 298                                             const char *msg)
 299 {
 300         trans->ops->wake_any_queue(trans, ctx, msg);
 301 }
 302
 303
 304 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
 305                                 struct iwl_host_cmd *cmd)
 306 {
 307         return trans->ops->send_cmd(trans, cmd);
 308 }
 309
 310 int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id,
 311                            u32 flags, u16 len, const void *data);
 312
 313 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
 314                 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
 315                 u8 sta_id, u8 tid)
 316 {
 317         return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id, tid);
 318 }
 319
 320 static inline int iwl_trans_reclaim(struct iwl_trans *trans, int sta_id,
 321                                  int tid, int txq_id, int ssn, u32 status,
 322                                  struct sk_buff_head *skbs)
 323 {
 324         return trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn,
 325                                    status, skbs);
 326 }
 327
 328 static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans,
 329                                             int sta_id, int tid)
 330 {
 331         return trans->ops->tx_agg_disable(trans, sta_id, tid);
 332 }
 333
 334 static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans,
 335                                          int sta_id, int tid)
 336 {
 337         return trans->ops->tx_agg_alloc(trans, sta_id, tid);
 338 }
 339
 340
 341 static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans,
 342                                            enum iwl_rxon_context_id ctx,
 343                                            int sta_id, int tid,
 344                                            int frame_limit, u16 ssn)
 345 {
 346         trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit, ssn);
 347 }
 348
 349 static inline void iwl_trans_free(struct iwl_trans *trans)
 350 {
 351         trans->ops->free(trans);
 352 }
 353
 354 static inline void iwl_trans_stop_queue(struct iwl_trans *trans, int q,
 355                                         const char *msg)
 356 {
 357         trans->ops->stop_queue(trans, q, msg);
 358 }
 359
 360 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
 361 {
 362         return trans->ops->wait_tx_queue_empty(trans);
 363 }
 364
 365 static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q)
 366 {
 367         return trans->ops->check_stuck_queue(trans, q);
 368 }
 369 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
 370                                             struct dentry *dir)
 371 {
 372         return trans->ops->dbgfs_register(trans, dir);
 373 }
 374
 375 #ifdef CONFIG_PM_SLEEP
 376 static inline int iwl_trans_suspend(struct iwl_trans *trans)
 377 {
 378         return trans->ops->suspend(trans);
 379 }
 380
 381 static inline int iwl_trans_resume(struct iwl_trans *trans)
 382 {
 383         return trans->ops->resume(trans);
 384 }
 385 #endif
 386
 387 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
 388 {
 389         trans->ops->write8(trans, ofs, val);
 390 }
 391
 392 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
 393 {
 394         trans->ops->write32(trans, ofs, val);
 395 }
 396
 397 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
 398 {
 399         return trans->ops->read32(trans, ofs);
 400 }
 401
 402 /*****************************************************
 403 * Utils functions
 404 ******************************************************/
 405 int iwl_alloc_fw_desc(struct iwl_trans *trans, struct fw_desc *desc,
 406                       const void *data, size_t len);
 407 void iwl_dealloc_ucode(struct iwl_trans *trans);
 408
 409 int iwl_send_calib_results(struct iwl_trans *trans);
 410 int iwl_calib_set(struct iwl_trans *trans,
 411                   const struct iwl_calib_hdr *cmd, int len);
 412 void iwl_calib_free_results(struct iwl_trans *trans);
 413
 414 /*****************************************************
 415 * Transport layers implementations + their allocation function
 416 ******************************************************/
 417 struct pci_dev;
 418 struct pci_device_id;
 419 extern const struct iwl_trans_ops trans_ops_pcie;
 420 struct iwl_trans *iwl_trans_pcie_alloc(struct iwl_shared *shrd,
 421                                        struct pci_dev *pdev,
 422                                        const struct pci_device_id *ent);
 423
 424 extern const struct iwl_trans_ops trans_ops_idi;
 425 struct iwl_trans *iwl_trans_idi_alloc(struct iwl_shared *shrd,
 426                                       void *pdev_void,
 427                                       const void *ent_void);
 428 #endif /* __iwl_trans_h__ */