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 - 2011 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 - 2011 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  /*This file includes the declaration that are exported from the transport
  67  * layer */
  68
  69 struct iwl_priv;
  70 struct iwl_rxon_context;
  71 struct iwl_host_cmd;
  72
  73 /**
  74  * struct iwl_trans_ops - transport specific operations
  75  * @start_device: allocates and inits all the resources for the transport
  76  *                layer.
  77  * @prepare_card_hw: claim the ownership on the HW. Will be called during
  78  *                   probe.
  79  * @tx_start: starts and configures all the Tx fifo - usually done once the fw
  80  *           is alive.
  81  * @stop_device:stops the whole device (embedded CPU put to reset)
  82  * @rx_free: frees the rx memory
  83  * @tx_free: frees the tx memory
  84  * @send_cmd:send a host command
  85  * @send_cmd_pdu:send a host command: flags can be CMD_*
  86  * @get_tx_cmd: returns a pointer to a new Tx cmd for the upper layer use
  87  * @tx: send an skb
  88  * @txq_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
  89  *                 ready and a successful ADDBA response has been received.
  90  * @txq_agg_disable: de-configure a Tx queue to send AMPDUs
  91  * @kick_nic: remove the RESET from the embedded CPU and let it run
  92  * @sync_irq: the upper layer will typically disable interrupt and call this
  93  *            handler. After this handler returns, it is guaranteed that all
  94  *            the ISR / tasklet etc... have finished running and the transport
  95  *            layer shall not pass any Rx.
  96  * @free: release all the ressource for the transport layer itself such as
  97  *        irq, tasklet etc...
  98  */
  99 struct iwl_trans_ops {
 100
 101         int (*start_device)(struct iwl_priv *priv);
 102         int (*prepare_card_hw)(struct iwl_priv *priv);
 103         void (*stop_device)(struct iwl_priv *priv);
 104         void (*tx_start)(struct iwl_priv *priv);
 105         void (*tx_free)(struct iwl_priv *priv);
 106         void (*rx_free)(struct iwl_priv *priv);
 107
 108         int (*send_cmd)(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
 109
 110         int (*send_cmd_pdu)(struct iwl_priv *priv, u8 id, u32 flags, u16 len,
 111                      const void *data);
 112         struct iwl_tx_cmd * (*get_tx_cmd)(struct iwl_priv *priv, int txq_id);
 113         int (*tx)(struct iwl_priv *priv, struct sk_buff *skb,
 114                 struct iwl_tx_cmd *tx_cmd, int txq_id, __le16 fc, bool ampdu,
 115                 struct iwl_rxon_context *ctx);
 116
 117         int (*txq_agg_disable)(struct iwl_priv *priv, u16 txq_id,
 118                                   u16 ssn_idx, u8 tx_fifo);
 119         void (*txq_agg_setup)(struct iwl_priv *priv, int sta_id, int tid,
 120                                                 int frame_limit);
 121
 122         void (*kick_nic)(struct iwl_priv *priv);
 123
 124         void (*sync_irq)(struct iwl_priv *priv);
 125         void (*free)(struct iwl_priv *priv);
 126 };
 127
 128 struct iwl_trans {
 129         const struct iwl_trans_ops *ops;
 130         struct iwl_priv *priv;
 131 };
 132
 133 static inline int trans_start_device(struct iwl_trans *trans)
 134 {
 135         return trans->ops->start_device(trans->priv);
 136 }
 137
 138 static inline int trans_prepare_card_hw(struct iwl_trans *trans)
 139 {
 140         return trans->ops->prepare_card_hw(trans->priv);
 141 }
 142
 143 static inline void trans_stop_device(struct iwl_trans *trans)
 144 {
 145         trans->ops->stop_device(trans->priv);
 146 }
 147
 148 static inline void trans_tx_start(struct iwl_trans *trans)
 149 {
 150         trans->ops->tx_start(trans->priv);
 151 }
 152
 153 static inline void trans_rx_free(struct iwl_trans *trans)
 154 {
 155         trans->ops->rx_free(trans->priv);
 156 }
 157
 158 static inline void trans_tx_free(struct iwl_trans *trans)
 159 {
 160         trans->ops->tx_free(trans->priv);
 161 }
 162
 163 static inline int trans_send_cmd(struct iwl_trans *trans,
 164                                 struct iwl_host_cmd *cmd)
 165 {
 166         return trans->ops->send_cmd(trans->priv, cmd);
 167 }
 168
 169 static inline int trans_send_cmd_pdu(struct iwl_trans *trans, u8 id, u32 flags,
 170                                         u16 len, const void *data)
 171 {
 172         return trans->ops->send_cmd_pdu(trans->priv, id, flags, len, data);
 173 }
 174
 175 static inline struct iwl_tx_cmd *trans_get_tx_cmd(struct iwl_trans *trans,
 176                                         int txq_id)
 177 {
 178         return trans->ops->get_tx_cmd(trans->priv, txq_id);
 179 }
 180
 181 static inline int trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
 182                 struct iwl_tx_cmd *tx_cmd, int txq_id, __le16 fc, bool ampdu,
 183                 struct iwl_rxon_context *ctx)
 184 {
 185         return trans->ops->tx(trans->priv, skb, tx_cmd, txq_id, fc, ampdu, ctx);
 186 }
 187
 188 static inline int trans_txq_agg_disable(struct iwl_trans *trans, u16 txq_id,
 189                           u16 ssn_idx, u8 tx_fifo)
 190 {
 191         return trans->ops->txq_agg_disable(trans->priv, txq_id,
 192                                            ssn_idx, tx_fifo);
 193 }
 194
 195 static inline void trans_txq_agg_setup(struct iwl_trans *trans, int sta_id,
 196                                                 int tid, int frame_limit)
 197 {
 198         trans->ops->txq_agg_setup(trans->priv, sta_id, tid, frame_limit);
 199 }
 200
 201 static inline void trans_kick_nic(struct iwl_trans *trans)
 202 {
 203         trans->ops->kick_nic(trans->priv);
 204 }
 205
 206 static inline void trans_sync_irq(struct iwl_trans *trans)
 207 {
 208         trans->ops->sync_irq(trans->priv);
 209 }
 210
 211 static inline void trans_free(struct iwl_trans *trans)
 212 {
 213         trans->ops->free(trans->priv);
 214 }
 215
 216 int iwl_trans_register(struct iwl_trans *trans, struct iwl_priv *priv);
 217
 218 /*TODO: this functions should NOT be exported from trans module - export it
 219  * until the reclaim flow will be brought to the transport module too */
 220
 221 struct iwl_tx_queue;
 222 void iwlagn_txq_inval_byte_cnt_tbl(struct iwl_priv *priv,
 223                                           struct iwl_tx_queue *txq);
 224
 225 #endif /* __iwl_trans_h__ */