1 /******************************************************************************
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.
8 * Copyright(c) 2007 - 2011 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
63 #ifndef __iwl_trans_h__
64 #define __iwl_trans_h__
66 #include <linux/debugfs.h>
67 #include <linux/skbuff.h>
69 #include "iwl-shared.h"
70 #include "iwl-commands.h"
72 /*This file includes the declaration that are exported from the transport
76 struct iwl_rxon_context;
81 * struct iwl_trans_ops - transport specific operations
82 * @alloc: allocates the meta data (not the queues themselves)
83 * @request_irq: requests IRQ - will be called before the FW load in probe flow
84 * @start_device: allocates and inits all the resources for the transport
86 * @prepare_card_hw: claim the ownership on the HW. Will be called during
88 * @tx_start: starts and configures all the Tx fifo - usually done once the fw
90 * @stop_device:stops the whole device (embedded CPU put to reset)
91 * @rx_free: frees the rx memory
92 * @tx_free: frees the tx memory
93 * @send_cmd:send a host command
94 * @send_cmd_pdu:send a host command: flags can be CMD_*
95 * @get_tx_cmd: returns a pointer to a new Tx cmd for the upper layer use
97 * @reclaim: free packet until ssn. Returns a list of freed packets.
98 * @txq_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
99 * ready and a successful ADDBA response has been received.
100 * @txq_agg_disable: de-configure a Tx queue to send AMPDUs
101 * @kick_nic: remove the RESET from the embedded CPU and let it run
102 * @disable_sync_irq: Disable and sync: after this handler returns, it is
103 * guaranteed that all the ISR / tasklet etc... have finished running
104 * and the transport layer shall not pass any Rx.
105 * @free: release all the ressource for the transport layer itself such as
106 * irq, tasklet etc...
107 * @dbgfs_register: add the dbgfs files under this directory. Files will be
108 * automatically deleted.
109 * @suspend: stop the device unless WoWLAN is configured
110 * @resume: resume activity of the device
112 struct iwl_trans_ops {
114 struct iwl_trans *(*alloc)(struct iwl_shared *shrd);
115 int (*request_irq)(struct iwl_trans *iwl_trans);
116 int (*start_device)(struct iwl_trans *trans);
117 int (*prepare_card_hw)(struct iwl_trans *trans);
118 void (*stop_device)(struct iwl_trans *trans);
119 void (*tx_start)(struct iwl_trans *trans);
120 void (*tx_free)(struct iwl_trans *trans);
121 void (*rx_free)(struct iwl_trans *trans);
123 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
125 int (*send_cmd_pdu)(struct iwl_trans *trans, u8 id, u32 flags, u16 len,
127 struct iwl_tx_cmd * (*get_tx_cmd)(struct iwl_trans *trans, int txq_id);
128 int (*tx)(struct iwl_priv *priv, struct sk_buff *skb,
129 struct iwl_tx_cmd *tx_cmd, int txq_id, __le16 fc, bool ampdu,
130 struct iwl_rxon_context *ctx);
131 void (*reclaim)(struct iwl_trans *trans, int txq_id, int ssn,
132 u32 status, struct sk_buff_head *skbs);
134 int (*txq_agg_disable)(struct iwl_priv *priv, u16 txq_id,
135 u16 ssn_idx, u8 tx_fifo);
136 void (*txq_agg_setup)(struct iwl_priv *priv, int sta_id, int tid,
139 void (*kick_nic)(struct iwl_trans *trans);
141 void (*disable_sync_irq)(struct iwl_trans *trans);
142 void (*free)(struct iwl_trans *trans);
144 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
145 int (*suspend)(struct iwl_trans *trans);
146 int (*resume)(struct iwl_trans *trans);
150 * struct iwl_trans - transport common data
151 * @ops - pointer to iwl_trans_ops
152 * @shrd - pointer to iwl_shared which holds shared data from the upper layer
153 * @hcmd_lock: protects HCMD
156 const struct iwl_trans_ops *ops;
157 struct iwl_shared *shrd;
158 spinlock_t hcmd_lock;
160 /* pointer to trans specific struct */
161 /*Ensure that this pointer will always be aligned to sizeof pointer */
162 char trans_specific[0] __attribute__((__aligned__(sizeof(void *))));
165 static inline int iwl_trans_request_irq(struct iwl_trans *trans)
167 return trans->ops->request_irq(trans);
170 static inline int iwl_trans_start_device(struct iwl_trans *trans)
172 return trans->ops->start_device(trans);
175 static inline int iwl_trans_prepare_card_hw(struct iwl_trans *trans)
177 return trans->ops->prepare_card_hw(trans);
180 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
182 trans->ops->stop_device(trans);
185 static inline void iwl_trans_tx_start(struct iwl_trans *trans)
187 trans->ops->tx_start(trans);
190 static inline void iwl_trans_rx_free(struct iwl_trans *trans)
192 trans->ops->rx_free(trans);
195 static inline void iwl_trans_tx_free(struct iwl_trans *trans)
197 trans->ops->tx_free(trans);
200 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
201 struct iwl_host_cmd *cmd)
203 return trans->ops->send_cmd(trans, cmd);
206 static inline int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id,
207 u32 flags, u16 len, const void *data)
209 return trans->ops->send_cmd_pdu(trans, id, flags, len, data);
212 static inline struct iwl_tx_cmd *iwl_trans_get_tx_cmd(struct iwl_trans *trans,
215 return trans->ops->get_tx_cmd(trans, txq_id);
218 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
219 struct iwl_tx_cmd *tx_cmd, int txq_id, __le16 fc, bool ampdu,
220 struct iwl_rxon_context *ctx)
222 return trans->ops->tx(priv(trans), skb, tx_cmd, txq_id, fc, ampdu, ctx);
225 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int txq_id,
227 struct sk_buff_head *skbs)
229 trans->ops->reclaim(trans, txq_id, ssn, status, skbs);
232 static inline int iwl_trans_txq_agg_disable(struct iwl_trans *trans, u16 txq_id,
233 u16 ssn_idx, u8 tx_fifo)
235 return trans->ops->txq_agg_disable(priv(trans), txq_id,
239 static inline void iwl_trans_txq_agg_setup(struct iwl_trans *trans, int sta_id,
240 int tid, int frame_limit)
242 trans->ops->txq_agg_setup(priv(trans), sta_id, tid, frame_limit);
245 static inline void iwl_trans_kick_nic(struct iwl_trans *trans)
247 trans->ops->kick_nic(trans);
250 static inline void iwl_trans_disable_sync_irq(struct iwl_trans *trans)
252 trans->ops->disable_sync_irq(trans);
255 static inline void iwl_trans_free(struct iwl_trans *trans)
257 trans->ops->free(trans);
260 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
263 return trans->ops->dbgfs_register(trans, dir);
266 static inline int iwl_trans_suspend(struct iwl_trans *trans)
268 return trans->ops->suspend(trans);
271 static inline int iwl_trans_resume(struct iwl_trans *trans)
273 return trans->ops->resume(trans);
276 /*****************************************************
277 * Transport layers implementations
278 ******************************************************/
279 extern const struct iwl_trans_ops trans_ops_pcie;
281 #endif /* __iwl_trans_h__ */