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
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)
85 CMD_WANT_SKB = BIT(1),
86 CMD_ON_DEMAND = BIT(2),
89 #define DEF_CMD_PAYLOAD_SIZE 320
92 * struct iwl_device_cmd
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.
98 struct iwl_device_cmd {
99 struct iwl_cmd_header hdr; /* uCode API */
100 u8 payload[DEF_CMD_PAYLOAD_SIZE];
103 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
105 #define IWL_MAX_CMD_TFDS 2
107 enum iwl_hcmd_dataflag {
108 IWL_HCMD_DFL_NOCOPY = BIT(0),
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
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
121 * @id: id of the host command
123 struct iwl_host_cmd {
124 const void *data[IWL_MAX_CMD_TFDS];
125 unsigned long reply_page;
129 u16 len[IWL_MAX_CMD_TFDS];
130 u8 dataflags[IWL_MAX_CMD_TFDS];
135 * struct iwl_trans_ops - transport specific operations
136 * @alloc: allocates the meta data (not the queues themselves)
137 * @request_irq: requests IRQ - will be called before the FW load in probe flow
138 * @start_device: allocates and inits all the resources for the transport
140 * @prepare_card_hw: claim the ownership on the HW. Will be called during
142 * @tx_start: starts and configures all the Tx fifo - usually done once the fw
144 * @wake_any_queue: wake all the queues of a specfic context IWL_RXON_CTX_*
145 * @stop_device:stops the whole device (embedded CPU put to reset)
146 * @send_cmd:send a host command
148 * @reclaim: free packet until ssn. Returns a list of freed packets.
149 * @tx_agg_alloc: allocate resources for a TX BA session
150 * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
151 * ready and a successful ADDBA response has been received.
152 * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
153 * @kick_nic: remove the RESET from the embedded CPU and let it run
154 * @free: release all the ressource for the transport layer itself such as
155 * irq, tasklet etc...
156 * @stop_queue: stop a specific queue
157 * @check_stuck_queue: check if a specific queue is stuck
158 * @wait_tx_queue_empty: wait until all tx queues are empty
159 * @dbgfs_register: add the dbgfs files under this directory. Files will be
160 * automatically deleted.
161 * @suspend: stop the device unless WoWLAN is configured
162 * @resume: resume activity of the device
164 struct iwl_trans_ops {
166 struct iwl_trans *(*alloc)(struct iwl_shared *shrd);
167 int (*request_irq)(struct iwl_trans *iwl_trans);
168 int (*start_device)(struct iwl_trans *trans);
169 int (*prepare_card_hw)(struct iwl_trans *trans);
170 void (*stop_device)(struct iwl_trans *trans);
171 void (*tx_start)(struct iwl_trans *trans);
173 void (*wake_any_queue)(struct iwl_trans *trans,
174 enum iwl_rxon_context_id ctx);
176 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
178 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
179 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
181 void (*reclaim)(struct iwl_trans *trans, int sta_id, int tid,
182 int txq_id, int ssn, u32 status,
183 struct sk_buff_head *skbs);
185 int (*tx_agg_disable)(struct iwl_trans *trans,
186 enum iwl_rxon_context_id ctx, int sta_id,
188 int (*tx_agg_alloc)(struct iwl_trans *trans,
189 enum iwl_rxon_context_id ctx, int sta_id, int tid,
191 void (*tx_agg_setup)(struct iwl_trans *trans,
192 enum iwl_rxon_context_id ctx, int sta_id, int tid,
195 void (*kick_nic)(struct iwl_trans *trans);
197 void (*free)(struct iwl_trans *trans);
199 void (*stop_queue)(struct iwl_trans *trans, int q);
201 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
202 int (*check_stuck_queue)(struct iwl_trans *trans, int q);
203 int (*wait_tx_queue_empty)(struct iwl_trans *trans);
204 #ifdef CONFIG_PM_SLEEP
205 int (*suspend)(struct iwl_trans *trans);
206 int (*resume)(struct iwl_trans *trans);
211 * struct iwl_trans - transport common data
212 * @ops - pointer to iwl_trans_ops
213 * @shrd - pointer to iwl_shared which holds shared data from the upper layer
214 * @hcmd_lock: protects HCMD
217 const struct iwl_trans_ops *ops;
218 struct iwl_shared *shrd;
219 spinlock_t hcmd_lock;
221 /* pointer to trans specific struct */
222 /*Ensure that this pointer will always be aligned to sizeof pointer */
223 char trans_specific[0] __attribute__((__aligned__(sizeof(void *))));
226 static inline int iwl_trans_request_irq(struct iwl_trans *trans)
228 return trans->ops->request_irq(trans);
231 static inline int iwl_trans_start_device(struct iwl_trans *trans)
233 return trans->ops->start_device(trans);
236 static inline int iwl_trans_prepare_card_hw(struct iwl_trans *trans)
238 return trans->ops->prepare_card_hw(trans);
241 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
243 trans->ops->stop_device(trans);
246 static inline void iwl_trans_tx_start(struct iwl_trans *trans)
248 trans->ops->tx_start(trans);
251 static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans,
252 enum iwl_rxon_context_id ctx)
254 trans->ops->wake_any_queue(trans, ctx);
258 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
259 struct iwl_host_cmd *cmd)
261 return trans->ops->send_cmd(trans, cmd);
264 int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id,
265 u32 flags, u16 len, const void *data);
267 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
268 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
271 return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id);
274 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int sta_id,
275 int tid, int txq_id, int ssn, u32 status,
276 struct sk_buff_head *skbs)
278 trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn, status, skbs);
281 static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans,
282 enum iwl_rxon_context_id ctx,
285 return trans->ops->tx_agg_disable(trans, ctx, sta_id, tid);
288 static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans,
289 enum iwl_rxon_context_id ctx,
290 int sta_id, int tid, u16 *ssn)
292 return trans->ops->tx_agg_alloc(trans, ctx, sta_id, tid, ssn);
296 static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans,
297 enum iwl_rxon_context_id ctx,
301 trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit);
304 static inline void iwl_trans_kick_nic(struct iwl_trans *trans)
306 trans->ops->kick_nic(trans);
309 static inline void iwl_trans_free(struct iwl_trans *trans)
311 trans->ops->free(trans);
314 static inline void iwl_trans_stop_queue(struct iwl_trans *trans, int q)
316 trans->ops->stop_queue(trans, q);
319 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
321 return trans->ops->wait_tx_queue_empty(trans);
324 static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q)
326 return trans->ops->check_stuck_queue(trans, q);
328 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
331 return trans->ops->dbgfs_register(trans, dir);
334 #ifdef CONFIG_PM_SLEEP
335 static inline int iwl_trans_suspend(struct iwl_trans *trans)
337 return trans->ops->suspend(trans);
340 static inline int iwl_trans_resume(struct iwl_trans *trans)
342 return trans->ops->resume(trans);
346 /*****************************************************
347 * Transport layers implementations
348 ******************************************************/
349 extern const struct iwl_trans_ops trans_ops_pcie;
351 #endif /* __iwl_trans_h__ */