blob: 76c52378f8f7a04bc17913e3606ceefdbb0ecd25 [file] [log] [blame]
Emmanuel Grumbachc85eb612011-06-14 10:13:24 +03001/******************************************************************************
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 *
Wey-Yi Guy4e318262011-12-27 11:21:32 -08008 * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
Emmanuel Grumbachc85eb612011-06-14 10:13:24 +03009 *
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 *
Wey-Yi Guy4e318262011-12-27 11:21:32 -080033 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
Emmanuel Grumbachc85eb612011-06-14 10:13:24 +030034 * 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 *****************************************************************************/
Emmanuel Grumbach41c50542011-07-11 08:51:04 +030063#ifndef __iwl_trans_h__
64#define __iwl_trans_h__
Emmanuel Grumbach253a6342011-07-11 07:39:46 -070065
Emmanuel Grumbache6793782012-02-16 09:47:01 +020066#include <linux/ieee80211.h>
Johannes Berg930dfd52012-03-05 11:24:43 -080067#include <linux/mm.h> /* for page_address */
Emmanuel Grumbacha72b8b02011-08-25 23:11:13 -070068
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +020069#include "iwl-debug.h"
Johannes Berg6238b002012-04-02 15:04:33 +020070#include "iwl-config.h"
71#include "iwl-fw.h"
Emmanuel Grumbach87e56662011-08-25 23:10:50 -070072
Emmanuel Grumbach60396182012-02-06 16:41:58 +020073/**
74 * DOC: Transport layer - what is it ?
75 *
76 * The tranport layer is the layer that deals with the HW directly. It provides
77 * an abstraction of the underlying HW to the upper layer. The transport layer
78 * doesn't provide any policy, algorithm or anything of this kind, but only
79 * mechanisms to make the HW do something.It is not completely stateless but
80 * close to it.
81 * We will have an implementation for each different supported bus.
82 */
83
84/**
85 * DOC: Life cycle of the transport layer
86 *
87 * The transport layer has a very precise life cycle.
88 *
89 * 1) A helper function is called during the module initialization and
90 * registers the bus driver's ops with the transport's alloc function.
91 * 2) Bus's probe calls to the transport layer's allocation functions.
92 * Of course this function is bus specific.
93 * 3) This allocation functions will spawn the upper layer which will
94 * register mac80211.
95 *
96 * 4) At some point (i.e. mac80211's start call), the op_mode will call
97 * the following sequence:
98 * start_hw
99 * start_fw
100 *
101 * 5) Then when finished (or reset):
102 * stop_fw (a.k.a. stop device for the moment)
103 * stop_hw
104 *
105 * 6) Eventually, the free function will be called.
106 */
107
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200108/**
109 * DOC: Host command section
110 *
111 * A host command is a commaned issued by the upper layer to the fw. There are
112 * several versions of fw that have several APIs. The transport layer is
113 * completely agnostic to these differences.
114 * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode),
115 */
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700116#define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
117#define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
118#define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
Johannes Bergf8d7c1a2012-03-06 13:31:02 -0800119#define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
120#define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
121#define SEQ_TO_INDEX(s) ((s) & 0xff)
122#define INDEX_TO_SEQ(i) ((i) & 0xff)
123#define SEQ_RX_FRAME cpu_to_le16(0x8000)
124
125/**
126 * struct iwl_cmd_header
127 *
128 * This header format appears in the beginning of each command sent from the
129 * driver, and each response/notification received from uCode.
130 */
131struct iwl_cmd_header {
132 u8 cmd; /* Command ID: REPLY_RXON, etc. */
133 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
134 /*
135 * The driver sets up the sequence number to values of its choosing.
136 * uCode does not use this value, but passes it back to the driver
137 * when sending the response to each driver-originated command, so
138 * the driver can match the response to the command. Since the values
139 * don't get used by uCode, the driver may set up an arbitrary format.
140 *
141 * There is one exception: uCode sets bit 15 when it originates
142 * the response/notification, i.e. when the response/notification
143 * is not a direct response to a command sent by the driver. For
144 * example, uCode issues REPLY_RX when it sends a received frame
145 * to the driver; it is not a direct response to any driver command.
146 *
147 * The Linux driver uses the following format:
148 *
149 * 0:7 tfd index - position within TX queue
150 * 8:12 TX queue id
151 * 13:14 reserved
152 * 15 unsolicited RX or uCode-originated notification
153 */
154 __le16 sequence;
155} __packed;
156
Johannes Bergc08ce202012-05-16 22:54:26 +0200157/* iwl_cmd_header flags value */
158#define IWL_CMD_FAILED_MSK 0x40
159
Johannes Bergf8d7c1a2012-03-06 13:31:02 -0800160
161#define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
Johannes Berg0c197442012-03-15 13:26:43 -0700162#define FH_RSCSR_FRAME_INVALID 0x55550000
163#define FH_RSCSR_FRAME_ALIGN 0x40
Johannes Bergf8d7c1a2012-03-06 13:31:02 -0800164
165struct iwl_rx_packet {
166 /*
167 * The first 4 bytes of the RX frame header contain both the RX frame
168 * size and some flags.
169 * Bit fields:
170 * 31: flag flush RB request
171 * 30: flag ignore TC (terminal counter) request
172 * 29: flag fast IRQ request
173 * 28-14: Reserved
174 * 13-00: RX frame size
175 */
176 __le32 len_n_flags;
177 struct iwl_cmd_header hdr;
178 u8 data[];
179} __packed;
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700180
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200181/**
182 * enum CMD_MODE - how to send the host commands ?
183 *
184 * @CMD_SYNC: The caller will be stalled until the fw responds to the command
185 * @CMD_ASYNC: Return right away and don't want for the response
186 * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
Emmanuel Grumbach96791422012-07-24 01:58:32 +0300187 * response. The caller needs to call iwl_free_resp when done.
188 * @CMD_WANT_HCMD: The caller needs to get the HCMD that was sent in the
189 * response handler. Chunks flagged by %IWL_HCMD_DFL_NOCOPY won't be
190 * copied. The pointer passed to the response handler is in the transport
191 * ownership and don't need to be freed by the op_mode. This also means
192 * that the pointer is invalidated after the op_mode's handler returns.
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200193 * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
194 */
195enum CMD_MODE {
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700196 CMD_SYNC = 0,
197 CMD_ASYNC = BIT(0),
198 CMD_WANT_SKB = BIT(1),
Emmanuel Grumbach96791422012-07-24 01:58:32 +0300199 CMD_WANT_HCMD = BIT(2),
200 CMD_ON_DEMAND = BIT(3),
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700201};
202
203#define DEF_CMD_PAYLOAD_SIZE 320
204
205/**
206 * struct iwl_device_cmd
207 *
208 * For allocation of the command and tx queues, this establishes the overall
209 * size of the largest command we send to uCode, except for commands that
210 * aren't fully copied and use other TFD space.
211 */
212struct iwl_device_cmd {
213 struct iwl_cmd_header hdr; /* uCode API */
Emmanuel Grumbach132f98c2011-09-20 15:37:24 -0700214 u8 payload[DEF_CMD_PAYLOAD_SIZE];
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700215} __packed;
216
217#define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
218
219#define IWL_MAX_CMD_TFDS 2
220
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200221/**
222 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
223 *
Johannes Bergf4feb8a2012-10-19 14:24:43 +0200224 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200225 * ring. The transport layer doesn't map the command's buffer to DMA, but
226 * rather copies it to an previously allocated DMA buffer. This flag tells
227 * the transport layer not to copy the command, but to map the existing
228 * buffer. This can save memcpy and is worth with very big comamnds.
Johannes Bergf4feb8a2012-10-19 14:24:43 +0200229 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
230 * chunk internally and free it again after the command completes. This
231 * can (currently) be used only once per command.
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200232 */
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700233enum iwl_hcmd_dataflag {
234 IWL_HCMD_DFL_NOCOPY = BIT(0),
Johannes Bergf4feb8a2012-10-19 14:24:43 +0200235 IWL_HCMD_DFL_DUP = BIT(1),
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700236};
237
238/**
239 * struct iwl_host_cmd - Host command to the uCode
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200240 *
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700241 * @data: array of chunks that composes the data of the host command
Johannes Berg65b94a42012-03-05 11:24:38 -0800242 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
243 * @_rx_page_order: (internally used to free response packet)
244 * @_rx_page_addr: (internally used to free response packet)
Emmanuel Grumbach247c61d2011-09-20 15:37:23 -0700245 * @handler_status: return value of the handler of the command
246 * (put in setup_rx_handlers) - valid for SYNC mode only
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200247 * @flags: can be CMD_*
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700248 * @len: array of the lenths of the chunks in data
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200249 * @dataflags: IWL_HCMD_DFL_*
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700250 * @id: id of the host command
251 */
252struct iwl_host_cmd {
253 const void *data[IWL_MAX_CMD_TFDS];
Johannes Berg65b94a42012-03-05 11:24:38 -0800254 struct iwl_rx_packet *resp_pkt;
255 unsigned long _rx_page_addr;
256 u32 _rx_page_order;
Emmanuel Grumbach247c61d2011-09-20 15:37:23 -0700257 int handler_status;
258
Emmanuel Grumbach522376d2011-09-06 09:31:19 -0700259 u32 flags;
260 u16 len[IWL_MAX_CMD_TFDS];
261 u8 dataflags[IWL_MAX_CMD_TFDS];
262 u8 id;
263};
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300264
Johannes Berg65b94a42012-03-05 11:24:38 -0800265static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
266{
267 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
268}
269
Johannes Berg930dfd52012-03-05 11:24:43 -0800270struct iwl_rx_cmd_buffer {
271 struct page *_page;
Johannes Berg0c197442012-03-15 13:26:43 -0700272 int _offset;
273 bool _page_stolen;
Eric Dumazeted905422012-03-24 00:29:46 -0400274 unsigned int truesize;
Johannes Berg930dfd52012-03-05 11:24:43 -0800275};
276
277static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
278{
Johannes Berg0c197442012-03-15 13:26:43 -0700279 return (void *)((unsigned long)page_address(r->_page) + r->_offset);
280}
281
282static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
283{
284 return r->_offset;
Johannes Berg930dfd52012-03-05 11:24:43 -0800285}
286
287static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
288{
Johannes Berg0c197442012-03-15 13:26:43 -0700289 r->_page_stolen = true;
290 get_page(r->_page);
291 return r->_page;
Johannes Berg930dfd52012-03-05 11:24:43 -0800292}
293
Johannes Bergd663ee72012-03-10 13:00:07 -0800294#define MAX_NO_RECLAIM_CMDS 6
295
Gregory Greenmanff110c82012-05-16 22:54:24 +0200296#define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
297
Johannes Berg9eae88f2012-03-15 13:26:52 -0700298/*
299 * Maximum number of HW queues the transport layer
300 * currently supports
301 */
302#define IWL_MAX_HW_QUEUES 32
Emmanuel Grumbachb04db9a2012-06-21 11:53:44 +0300303#define IWL_INVALID_STATION 255
304#define IWL_MAX_TID_COUNT 8
305#define IWL_FRAME_LIMIT 64
Johannes Berg9eae88f2012-03-15 13:26:52 -0700306
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300307/**
Meenakshi Venkataraman92d743a2012-03-07 09:52:35 -0800308 * struct iwl_trans_config - transport configuration
309 *
310 * @op_mode: pointer to the upper layer.
Meenakshi Venkataramanc6f600f2012-03-08 11:29:12 -0800311 * @cmd_queue: the index of the command queue.
312 * Must be set before start_fw.
Emmanuel Grumbachb04db9a2012-06-21 11:53:44 +0300313 * @cmd_fifo: the fifo for host commands
Johannes Bergd663ee72012-03-10 13:00:07 -0800314 * @no_reclaim_cmds: Some devices erroneously don't set the
315 * SEQ_RX_FRAME bit on some notifications, this is the
316 * list of such notifications to filter. Max length is
317 * %MAX_NO_RECLAIM_CMDS.
318 * @n_no_reclaim_cmds: # of commands in list
Johannes Bergb2cf4102012-04-09 17:46:51 -0700319 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
320 * if unset 4k will be the RX buffer size
Johannes Berg7c5ba4a2012-04-09 17:46:54 -0700321 * @queue_watchdog_timeout: time (in ms) after which queues
322 * are considered stuck and will trigger device restart
Johannes Bergd9fb6462012-03-26 08:23:39 -0700323 * @command_names: array of command names, must be 256 entries
324 * (one for each command); for debugging only
Meenakshi Venkataraman92d743a2012-03-07 09:52:35 -0800325 */
326struct iwl_trans_config {
327 struct iwl_op_mode *op_mode;
Johannes Berg9eae88f2012-03-15 13:26:52 -0700328
Meenakshi Venkataramanc6f600f2012-03-08 11:29:12 -0800329 u8 cmd_queue;
Emmanuel Grumbachb04db9a2012-06-21 11:53:44 +0300330 u8 cmd_fifo;
Johannes Bergd663ee72012-03-10 13:00:07 -0800331 const u8 *no_reclaim_cmds;
332 int n_no_reclaim_cmds;
Johannes Bergb2cf4102012-04-09 17:46:51 -0700333
334 bool rx_buf_size_8k;
Johannes Berg7c5ba4a2012-04-09 17:46:54 -0700335 unsigned int queue_watchdog_timeout;
Johannes Bergd9fb6462012-03-26 08:23:39 -0700336 const char **command_names;
Meenakshi Venkataraman92d743a2012-03-07 09:52:35 -0800337};
338
Emmanuel Grumbach87ce05a2012-03-26 09:03:18 -0700339struct iwl_trans;
340
Meenakshi Venkataraman92d743a2012-03-07 09:52:35 -0800341/**
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300342 * struct iwl_trans_ops - transport specific operations
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200343 *
344 * All the handlers MUST be implemented
345 *
Emmanuel Grumbach57a1dc82012-01-08 13:22:16 +0200346 * @start_hw: starts the HW- from that point on, the HW can send interrupts
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200347 * May sleep
Emmanuel Grumbachcc56feb2012-01-08 13:37:59 +0200348 * @stop_hw: stops the HW- from that point on, the HW will be in low power but
Emmanuel Grumbach218733c2012-03-31 08:28:38 -0700349 * will still issue interrupt if the HW RF kill is triggered unless
350 * op_mode_leaving is true.
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200351 * May sleep
Emmanuel Grumbachcf614292012-01-08 16:33:58 +0200352 * @start_fw: allocates and inits all the resources for the transport
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200353 * layer. Also kick a fw image.
354 * May sleep
Emmanuel Grumbached6a3802012-01-02 16:10:08 +0200355 * @fw_alive: called when the fw sends alive notification
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200356 * May sleep
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300357 * @stop_device:stops the whole device (embedded CPU put to reset)
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200358 * May sleep
Johannes Berg2dd4f9f2012-03-05 11:24:35 -0800359 * @wowlan_suspend: put the device into the correct mode for WoWLAN during
360 * suspend. This is optional, if not implemented WoWLAN will not be
361 * supported. This callback may sleep.
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300362 * @send_cmd:send a host command
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200363 * May sleep only if CMD_SYNC is set
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300364 * @tx: send an skb
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200365 * Must be atomic
Emmanuel Grumbacha0eaad72011-08-25 23:11:00 -0700366 * @reclaim: free packet until ssn. Returns a list of freed packets.
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200367 * Must be atomic
Emmanuel Grumbachb04db9a2012-06-21 11:53:44 +0300368 * @txq_enable: setup a queue. To setup an AC queue, use the
369 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
370 * this one. The op_mode must not configure the HCMD queue. May sleep.
Emmanuel Grumbachd0624be2012-05-29 13:07:30 +0300371 * @txq_disable: de-configure a Tx queue to send AMPDUs
Johannes Bergb0b46192012-03-07 09:52:17 -0800372 * Must be atomic
Emmanuel Grumbach5f178cd2011-08-25 23:11:29 -0700373 * @wait_tx_queue_empty: wait until all tx queues are empty
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200374 * May sleep
Emmanuel Grumbach87e56662011-08-25 23:10:50 -0700375 * @dbgfs_register: add the dbgfs files under this directory. Files will be
376 * automatically deleted.
Emmanuel Grumbach57210f72011-08-25 23:10:52 -0700377 * @suspend: stop the device unless WoWLAN is configured
378 * @resume: resume activity of the device
Emmanuel Grumbach03905492012-01-03 13:48:07 +0200379 * @write8: write a u8 to a register at offset ofs from the BAR
380 * @write32: write a u32 to a register at offset ofs from the BAR
381 * @read32: read a u32 register at offset ofs from the BAR
Meenakshi Venkataramanc6f600f2012-03-08 11:29:12 -0800382 * @configure: configure parameters required by the transport layer from
Emmanuel Grumbach3dc420b2012-03-07 09:52:41 -0800383 * the op_mode. May be called several times before start_fw, can't be
384 * called after that.
Don Fry47107e82012-03-15 13:27:06 -0700385 * @set_pmi: set the power pmi state
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300386 */
387struct iwl_trans_ops {
388
Emmanuel Grumbach57a1dc82012-01-08 13:22:16 +0200389 int (*start_hw)(struct iwl_trans *iwl_trans);
Emmanuel Grumbach218733c2012-03-31 08:28:38 -0700390 void (*stop_hw)(struct iwl_trans *iwl_trans, bool op_mode_leaving);
Johannes Berg0692fe42012-03-06 13:30:37 -0800391 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw);
Emmanuel Grumbached6a3802012-01-02 16:10:08 +0200392 void (*fw_alive)(struct iwl_trans *trans);
Emmanuel Grumbach6d8f6ee2011-08-25 23:11:06 -0700393 void (*stop_device)(struct iwl_trans *trans);
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300394
Johannes Berg2dd4f9f2012-03-05 11:24:35 -0800395 void (*wowlan_suspend)(struct iwl_trans *trans);
396
Emmanuel Grumbach6d8f6ee2011-08-25 23:11:06 -0700397 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300398
Emmanuel Grumbache13c0c52011-08-25 23:11:24 -0700399 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
Johannes Berg9eae88f2012-03-15 13:26:52 -0700400 struct iwl_device_cmd *dev_cmd, int queue);
401 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
402 struct sk_buff_head *skbs);
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300403
Emmanuel Grumbach4beaf6c2012-05-29 11:29:10 +0300404 void (*txq_enable)(struct iwl_trans *trans, int queue, int fifo,
405 int sta_id, int tid, int frame_limit, u16 ssn);
Emmanuel Grumbachd0624be2012-05-29 13:07:30 +0300406 void (*txq_disable)(struct iwl_trans *trans, int queue);
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300407
Emmanuel Grumbach87e56662011-08-25 23:10:50 -0700408 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
Emmanuel Grumbach5f178cd2011-08-25 23:11:29 -0700409 int (*wait_tx_queue_empty)(struct iwl_trans *trans);
Johannes Bergc01a4042011-09-15 11:46:45 -0700410#ifdef CONFIG_PM_SLEEP
Emmanuel Grumbach57210f72011-08-25 23:10:52 -0700411 int (*suspend)(struct iwl_trans *trans);
412 int (*resume)(struct iwl_trans *trans);
Johannes Bergc01a4042011-09-15 11:46:45 -0700413#endif
Emmanuel Grumbach03905492012-01-03 13:48:07 +0200414 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
415 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
416 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
Meenakshi Venkataramanc6f600f2012-03-08 11:29:12 -0800417 void (*configure)(struct iwl_trans *trans,
418 const struct iwl_trans_config *trans_cfg);
Don Fry47107e82012-03-15 13:27:06 -0700419 void (*set_pmi)(struct iwl_trans *trans, bool state);
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300420};
421
Emmanuel Grumbach6fbfae82011-08-25 23:10:49 -0700422/**
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200423 * enum iwl_trans_state - state of the transport layer
424 *
425 * @IWL_TRANS_NO_FW: no fw has sent an alive response
426 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
427 */
428enum iwl_trans_state {
429 IWL_TRANS_NO_FW = 0,
430 IWL_TRANS_FW_ALIVE = 1,
431};
432
433/**
Emmanuel Grumbach6fbfae82011-08-25 23:10:49 -0700434 * struct iwl_trans - transport common data
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200435 *
Emmanuel Grumbach6fbfae82011-08-25 23:10:49 -0700436 * @ops - pointer to iwl_trans_ops
Emmanuel Grumbached277c92012-02-09 16:08:15 +0200437 * @op_mode - pointer to the op_mode
Emmanuel Grumbach035f7ff2012-03-26 08:57:01 -0700438 * @cfg - pointer to the configuration
Emmanuel Grumbach1042db22012-01-03 16:56:15 +0200439 * @reg_lock - protect hw register access
Emmanuel Grumbacha42a1842012-02-02 14:33:08 -0800440 * @dev - pointer to struct device * that represents the device
Emmanuel Grumbach99673ee2012-01-08 21:19:45 +0200441 * @hw_id: a u32 with the ID of the device / subdevice.
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200442 * Set during transport allocation.
Emmanuel Grumbach9ca85962012-01-08 21:19:45 +0200443 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
Emmanuel Grumbachf6d0e9b2012-01-08 21:19:45 +0200444 * @pm_support: set to true in start_hw if link pm is supported
Meenakshi Venkataraman69a10b22012-03-10 13:00:09 -0800445 * @wait_command_queue: the wait_queue for SYNC host commands
Emmanuel Grumbach59c647b2012-05-24 19:24:34 +0300446 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
447 * The user should use iwl_trans_{alloc,free}_tx_cmd.
448 * @dev_cmd_headroom: room needed for the transport's private use before the
449 * device_cmd for Tx - for internal use only
450 * The user should use iwl_trans_{alloc,free}_tx_cmd.
Johannes Bergf042c2e2012-09-05 22:34:44 +0200451 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
452 * starting the firmware, used for tracing
453 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
454 * start of the 802.11 header in the @rx_mpdu_cmd
Emmanuel Grumbach6fbfae82011-08-25 23:10:49 -0700455 */
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300456struct iwl_trans {
457 const struct iwl_trans_ops *ops;
Emmanuel Grumbached277c92012-02-09 16:08:15 +0200458 struct iwl_op_mode *op_mode;
Emmanuel Grumbach035f7ff2012-03-26 08:57:01 -0700459 const struct iwl_cfg *cfg;
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200460 enum iwl_trans_state state;
Emmanuel Grumbach1042db22012-01-03 16:56:15 +0200461 spinlock_t reg_lock;
Emmanuel Grumbache6bb4c92011-08-25 23:10:48 -0700462
Emmanuel Grumbacha42a1842012-02-02 14:33:08 -0800463 struct device *dev;
Emmanuel Grumbach08079a492012-01-09 16:23:00 +0200464 u32 hw_rev;
Emmanuel Grumbach99673ee2012-01-08 21:19:45 +0200465 u32 hw_id;
Emmanuel Grumbach9ca85962012-01-08 21:19:45 +0200466 char hw_id_str[52];
Emmanuel Grumbacha42a1842012-02-02 14:33:08 -0800467
Johannes Bergf042c2e2012-09-05 22:34:44 +0200468 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
469
Emmanuel Grumbachf6d0e9b2012-01-08 21:19:45 +0200470 bool pm_support;
Don Fry97b52cf2011-11-10 06:55:27 -0800471
Meenakshi Venkataraman69a10b22012-03-10 13:00:09 -0800472 wait_queue_head_t wait_command_queue;
473
Emmanuel Grumbach59c647b2012-05-24 19:24:34 +0300474 /* The following fields are internal only */
475 struct kmem_cache *dev_cmd_pool;
476 size_t dev_cmd_headroom;
Johannes Berg3ec45882012-07-12 13:56:28 +0200477 char dev_cmd_pool_name[50];
Emmanuel Grumbach59c647b2012-05-24 19:24:34 +0300478
Meenakshi Venkataraman9da987a2012-07-16 18:43:56 -0700479 struct dentry *dbgfs_dir;
480
Emmanuel Grumbache6bb4c92011-08-25 23:10:48 -0700481 /* pointer to trans specific struct */
482 /*Ensure that this pointer will always be aligned to sizeof pointer */
Emmanuel Grumbachcbe6ab42012-02-15 09:25:06 +0200483 char trans_specific[0] __aligned(sizeof(void *));
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300484};
485
Emmanuel Grumbached277c92012-02-09 16:08:15 +0200486static inline void iwl_trans_configure(struct iwl_trans *trans,
Meenakshi Venkataraman92d743a2012-03-07 09:52:35 -0800487 const struct iwl_trans_config *trans_cfg)
Emmanuel Grumbached277c92012-02-09 16:08:15 +0200488{
489 /*
490 * only set the op_mode for the moment. Later on, this function will do
491 * more
492 */
Meenakshi Venkataraman92d743a2012-03-07 09:52:35 -0800493 trans->op_mode = trans_cfg->op_mode;
Meenakshi Venkataramanc6f600f2012-03-08 11:29:12 -0800494
495 trans->ops->configure(trans, trans_cfg);
Emmanuel Grumbached277c92012-02-09 16:08:15 +0200496}
497
Emmanuel Grumbach57a1dc82012-01-08 13:22:16 +0200498static inline int iwl_trans_start_hw(struct iwl_trans *trans)
Emmanuel Grumbachbdfbf092011-07-08 08:46:16 -0700499{
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200500 might_sleep();
501
Emmanuel Grumbach57a1dc82012-01-08 13:22:16 +0200502 return trans->ops->start_hw(trans);
Emmanuel Grumbachbdfbf092011-07-08 08:46:16 -0700503}
504
Emmanuel Grumbach218733c2012-03-31 08:28:38 -0700505static inline void iwl_trans_stop_hw(struct iwl_trans *trans,
506 bool op_mode_leaving)
Emmanuel Grumbachcc56feb2012-01-08 13:37:59 +0200507{
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200508 might_sleep();
509
Emmanuel Grumbach218733c2012-03-31 08:28:38 -0700510 trans->ops->stop_hw(trans, op_mode_leaving);
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200511
512 trans->state = IWL_TRANS_NO_FW;
Emmanuel Grumbachcc56feb2012-01-08 13:37:59 +0200513}
514
Emmanuel Grumbached6a3802012-01-02 16:10:08 +0200515static inline void iwl_trans_fw_alive(struct iwl_trans *trans)
516{
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200517 might_sleep();
518
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200519 trans->state = IWL_TRANS_FW_ALIVE;
Emmanuel Grumbachb04db9a2012-06-21 11:53:44 +0300520
521 trans->ops->fw_alive(trans);
Emmanuel Grumbached6a3802012-01-02 16:10:08 +0200522}
523
Johannes Berg0692fe42012-03-06 13:30:37 -0800524static inline int iwl_trans_start_fw(struct iwl_trans *trans,
525 const struct fw_img *fw)
Emmanuel Grumbach0286cee2011-07-10 15:39:57 +0300526{
Emmanuel Grumbachcf614292012-01-08 16:33:58 +0200527 might_sleep();
528
Johannes Bergf042c2e2012-09-05 22:34:44 +0200529 WARN_ON_ONCE(!trans->rx_mpdu_cmd);
530
Emmanuel Grumbachcf614292012-01-08 16:33:58 +0200531 return trans->ops->start_fw(trans, fw);
Emmanuel Grumbach0286cee2011-07-10 15:39:57 +0300532}
533
Emmanuel Grumbache6bb4c92011-08-25 23:10:48 -0700534static inline void iwl_trans_stop_device(struct iwl_trans *trans)
Emmanuel Grumbachb3c2ce12011-07-07 15:50:10 +0300535{
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200536 might_sleep();
537
Emmanuel Grumbach6d8f6ee2011-08-25 23:11:06 -0700538 trans->ops->stop_device(trans);
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200539
540 trans->state = IWL_TRANS_NO_FW;
Emmanuel Grumbachb3c2ce12011-07-07 15:50:10 +0300541}
542
Johannes Berg2dd4f9f2012-03-05 11:24:35 -0800543static inline void iwl_trans_wowlan_suspend(struct iwl_trans *trans)
544{
545 might_sleep();
546 trans->ops->wowlan_suspend(trans);
547}
548
Emmanuel Grumbache6bb4c92011-08-25 23:10:48 -0700549static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
Emmanuel Grumbachbdfbf092011-07-08 08:46:16 -0700550 struct iwl_host_cmd *cmd)
551{
Johannes Bergf0d120a2012-03-10 13:00:08 -0800552 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
553 "%s bad state = %d", __func__, trans->state);
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200554
Emmanuel Grumbach6d8f6ee2011-08-25 23:11:06 -0700555 return trans->ops->send_cmd(trans, cmd);
Emmanuel Grumbachbdfbf092011-07-08 08:46:16 -0700556}
557
Emmanuel Grumbach59c647b2012-05-24 19:24:34 +0300558static inline struct iwl_device_cmd *
559iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
560{
561 u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
562
563 if (unlikely(dev_cmd_ptr == NULL))
564 return NULL;
565
566 return (struct iwl_device_cmd *)
567 (dev_cmd_ptr + trans->dev_cmd_headroom);
568}
569
570static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
571 struct iwl_device_cmd *dev_cmd)
572{
573 u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom;
574
575 kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr);
576}
577
Emmanuel Grumbache6bb4c92011-08-25 23:10:48 -0700578static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
Johannes Berg9eae88f2012-03-15 13:26:52 -0700579 struct iwl_device_cmd *dev_cmd, int queue)
Emmanuel Grumbacha0eaad72011-08-25 23:11:00 -0700580{
Johannes Bergf0d120a2012-03-10 13:00:08 -0800581 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
582 "%s bad state = %d", __func__, trans->state);
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200583
Johannes Berg9eae88f2012-03-15 13:26:52 -0700584 return trans->ops->tx(trans, skb, dev_cmd, queue);
Emmanuel Grumbacha0eaad72011-08-25 23:11:00 -0700585}
586
Johannes Berg9eae88f2012-03-15 13:26:52 -0700587static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
588 int ssn, struct sk_buff_head *skbs)
Emmanuel Grumbach48d42c42011-07-10 10:47:01 +0300589{
Johannes Bergf0d120a2012-03-10 13:00:08 -0800590 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
591 "%s bad state = %d", __func__, trans->state);
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200592
Johannes Berg9eae88f2012-03-15 13:26:52 -0700593 trans->ops->reclaim(trans, queue, ssn, skbs);
Emmanuel Grumbach48d42c42011-07-10 10:47:01 +0300594}
595
Emmanuel Grumbachd0624be2012-05-29 13:07:30 +0300596static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue)
Emmanuel Grumbach288712a2011-08-25 23:11:25 -0700597{
Johannes Bergf0d120a2012-03-10 13:00:08 -0800598 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
599 "%s bad state = %d", __func__, trans->state);
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200600
Emmanuel Grumbachd0624be2012-05-29 13:07:30 +0300601 trans->ops->txq_disable(trans, queue);
Emmanuel Grumbach288712a2011-08-25 23:11:25 -0700602}
603
Emmanuel Grumbach4beaf6c2012-05-29 11:29:10 +0300604static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
605 int fifo, int sta_id, int tid,
606 int frame_limit, u16 ssn)
Emmanuel Grumbach48d42c42011-07-10 10:47:01 +0300607{
Emmanuel Grumbach60396182012-02-06 16:41:58 +0200608 might_sleep();
609
Johannes Bergf0d120a2012-03-10 13:00:08 -0800610 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
611 "%s bad state = %d", __func__, trans->state);
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200612
Emmanuel Grumbach4beaf6c2012-05-29 11:29:10 +0300613 trans->ops->txq_enable(trans, queue, fifo, sta_id, tid,
Johannes Berg9eae88f2012-03-15 13:26:52 -0700614 frame_limit, ssn);
Emmanuel Grumbach48d42c42011-07-10 10:47:01 +0300615}
616
Emmanuel Grumbachb04db9a2012-06-21 11:53:44 +0300617static inline void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue,
618 int fifo)
619{
620 iwl_trans_txq_enable(trans, queue, fifo, IWL_INVALID_STATION,
621 IWL_MAX_TID_COUNT, IWL_FRAME_LIMIT, 0);
622}
623
Emmanuel Grumbach5f178cd2011-08-25 23:11:29 -0700624static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
625{
Johannes Bergf0d120a2012-03-10 13:00:08 -0800626 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
627 "%s bad state = %d", __func__, trans->state);
Emmanuel Grumbach69655eb2012-02-06 14:30:54 +0200628
Emmanuel Grumbach5f178cd2011-08-25 23:11:29 -0700629 return trans->ops->wait_tx_queue_empty(trans);
630}
631
Emmanuel Grumbach87e56662011-08-25 23:10:50 -0700632static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
633 struct dentry *dir)
634{
635 return trans->ops->dbgfs_register(trans, dir);
636}
637
Johannes Bergc01a4042011-09-15 11:46:45 -0700638#ifdef CONFIG_PM_SLEEP
Emmanuel Grumbach57210f72011-08-25 23:10:52 -0700639static inline int iwl_trans_suspend(struct iwl_trans *trans)
640{
641 return trans->ops->suspend(trans);
642}
643
644static inline int iwl_trans_resume(struct iwl_trans *trans)
645{
646 return trans->ops->resume(trans);
647}
Johannes Bergc01a4042011-09-15 11:46:45 -0700648#endif
Emmanuel Grumbach57210f72011-08-25 23:10:52 -0700649
Emmanuel Grumbach03905492012-01-03 13:48:07 +0200650static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
651{
652 trans->ops->write8(trans, ofs, val);
653}
654
655static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
656{
657 trans->ops->write32(trans, ofs, val);
658}
659
660static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
661{
662 return trans->ops->read32(trans, ofs);
663}
664
Don Fry47107e82012-03-15 13:27:06 -0700665static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
666{
667 trans->ops->set_pmi(trans, state);
668}
669
Emmanuel Grumbache6bb4c92011-08-25 23:10:48 -0700670/*****************************************************
Johannes Bergd1ff5252012-04-12 06:24:30 -0700671* driver (transport) register/unregister functions
Emmanuel Grumbachb52e7ea2012-02-02 14:16:59 -0800672******************************************************/
Emmanuel Grumbach36a79222012-02-27 13:53:32 -0800673int __must_check iwl_pci_register_driver(void);
674void iwl_pci_unregister_driver(void);
Emmanuel Grumbachb52e7ea2012-02-02 14:16:59 -0800675
Emmanuel Grumbach41c50542011-07-11 08:51:04 +0300676#endif /* __iwl_trans_h__ */