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 - 2012 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 - 2012 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 * @start_hw: starts the HW- from that point on, the HW can send interrupts
137 * @stop_hw: stops the HW- from that point on, the HW will be in low power but
138 * will still issue interrupt if the HW RF kill is triggered.
139 * @start_device: allocates and inits all the resources for the transport
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
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 * @write8: write a u8 to a register at offset ofs from the BAR
162 * @write32: write a u32 to a register at offset ofs from the BAR
163 * @read32: read a u32 register at offset ofs from the BAR
165 struct iwl_trans_ops {
167 int (*start_hw)(struct iwl_trans *iwl_trans);
168 void (*stop_hw)(struct iwl_trans *iwl_trans);
169 int (*start_device)(struct iwl_trans *trans);
170 void (*fw_alive)(struct iwl_trans *trans);
171 void (*stop_device)(struct iwl_trans *trans);
173 void (*wake_any_queue)(struct iwl_trans *trans,
174 enum iwl_rxon_context_id ctx,
177 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
179 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
180 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
182 int (*reclaim)(struct iwl_trans *trans, int sta_id, int tid,
183 int txq_id, int ssn, u32 status,
184 struct sk_buff_head *skbs);
186 int (*tx_agg_disable)(struct iwl_trans *trans,
187 int sta_id, int tid);
188 int (*tx_agg_alloc)(struct iwl_trans *trans,
189 int sta_id, int tid);
190 void (*tx_agg_setup)(struct iwl_trans *trans,
191 enum iwl_rxon_context_id ctx, int sta_id, int tid,
192 int frame_limit, u16 ssn);
194 void (*kick_nic)(struct iwl_trans *trans);
196 void (*free)(struct iwl_trans *trans);
198 void (*stop_queue)(struct iwl_trans *trans, int q, const char *msg);
200 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
201 int (*check_stuck_queue)(struct iwl_trans *trans, int q);
202 int (*wait_tx_queue_empty)(struct iwl_trans *trans);
203 #ifdef CONFIG_PM_SLEEP
204 int (*suspend)(struct iwl_trans *trans);
205 int (*resume)(struct iwl_trans *trans);
207 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
208 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
209 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
212 /* one for each uCode image (inst/data, boot/init/runtime) */
214 dma_addr_t p_addr; /* hardware address */
215 void *v_addr; /* software address */
216 u32 len; /* size in bytes */
220 struct fw_desc code; /* firmware code image */
221 struct fw_desc data; /* firmware data image */
224 /* Opaque calibration results */
225 struct iwl_calib_result {
226 struct list_head list;
228 struct iwl_calib_hdr hdr;
233 * struct iwl_trans - transport common data
234 * @ops - pointer to iwl_trans_ops
235 * @shrd - pointer to iwl_shared which holds shared data from the upper layer
236 * @hcmd_lock: protects HCMD
237 * @reg_lock - protect hw register access
238 * @dev - pointer to struct device * that represents the device
239 * @irq - the irq number for the device
240 * @ucode_write_complete: indicates that the ucode has been copied.
241 * @ucode_rt: run time ucode image
242 * @ucode_init: init ucode image
243 * @ucode_wowlan: wake on wireless ucode image (optional)
244 * @nvm_device_type: indicates OTP or eeprom
245 * @calib_results: list head for init calibration results
248 const struct iwl_trans_ops *ops;
249 struct iwl_shared *shrd;
250 spinlock_t hcmd_lock;
256 u8 ucode_write_complete; /* the image write is complete */
257 struct fw_img ucode_rt;
258 struct fw_img ucode_init;
259 struct fw_img ucode_wowlan;
261 /* eeprom related variables */
264 /* init calibration results */
265 struct list_head calib_results;
267 /* pointer to trans specific struct */
268 /*Ensure that this pointer will always be aligned to sizeof pointer */
269 char trans_specific[0] __attribute__((__aligned__(sizeof(void *))));
272 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
274 return trans->ops->start_hw(trans);
277 static inline void iwl_trans_stop_hw(struct iwl_trans *trans)
279 trans->ops->stop_hw(trans);
282 static inline void iwl_trans_fw_alive(struct iwl_trans *trans)
284 trans->ops->fw_alive(trans);
287 static inline int iwl_trans_start_device(struct iwl_trans *trans)
289 return trans->ops->start_device(trans);
292 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
294 trans->ops->stop_device(trans);
297 static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans,
298 enum iwl_rxon_context_id ctx,
301 trans->ops->wake_any_queue(trans, ctx, msg);
305 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
306 struct iwl_host_cmd *cmd)
308 return trans->ops->send_cmd(trans, cmd);
311 int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id,
312 u32 flags, u16 len, const void *data);
314 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
315 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
318 return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id, tid);
321 static inline int iwl_trans_reclaim(struct iwl_trans *trans, int sta_id,
322 int tid, int txq_id, int ssn, u32 status,
323 struct sk_buff_head *skbs)
325 return trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn,
329 static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans,
332 return trans->ops->tx_agg_disable(trans, sta_id, tid);
335 static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans,
338 return trans->ops->tx_agg_alloc(trans, sta_id, tid);
342 static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans,
343 enum iwl_rxon_context_id ctx,
345 int frame_limit, u16 ssn)
347 trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit, ssn);
350 static inline void iwl_trans_kick_nic(struct iwl_trans *trans)
352 trans->ops->kick_nic(trans);
355 static inline void iwl_trans_free(struct iwl_trans *trans)
357 trans->ops->free(trans);
360 static inline void iwl_trans_stop_queue(struct iwl_trans *trans, int q,
363 trans->ops->stop_queue(trans, q, msg);
366 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
368 return trans->ops->wait_tx_queue_empty(trans);
371 static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q)
373 return trans->ops->check_stuck_queue(trans, q);
375 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
378 return trans->ops->dbgfs_register(trans, dir);
381 #ifdef CONFIG_PM_SLEEP
382 static inline int iwl_trans_suspend(struct iwl_trans *trans)
384 return trans->ops->suspend(trans);
387 static inline int iwl_trans_resume(struct iwl_trans *trans)
389 return trans->ops->resume(trans);
393 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
395 trans->ops->write8(trans, ofs, val);
398 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
400 trans->ops->write32(trans, ofs, val);
403 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
405 return trans->ops->read32(trans, ofs);
408 /*****************************************************
410 ******************************************************/
411 int iwl_alloc_fw_desc(struct iwl_trans *trans, struct fw_desc *desc,
412 const void *data, size_t len);
413 void iwl_dealloc_ucode(struct iwl_trans *trans);
415 int iwl_send_calib_results(struct iwl_trans *trans);
416 int iwl_calib_set(struct iwl_trans *trans,
417 const struct iwl_calib_hdr *cmd, int len);
418 void iwl_calib_free_results(struct iwl_trans *trans);
420 /*****************************************************
421 * Transport layers implementations + their allocation function
422 ******************************************************/
424 struct pci_device_id;
425 extern const struct iwl_trans_ops trans_ops_pcie;
426 struct iwl_trans *iwl_trans_pcie_alloc(struct iwl_shared *shrd,
427 struct pci_dev *pdev,
428 const struct pci_device_id *ent);
430 extern const struct iwl_trans_ops trans_ops_idi;
431 struct iwl_trans *iwl_trans_idi_alloc(struct iwl_shared *shrd,
433 const void *ent_void);
434 #endif /* __iwl_trans_h__ */