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/ieee80211.h>
67 #include <linux/mm.h> /* for page_address */
69 #include "iwl-debug.h"
70 #include "iwl-config.h"
74 * DOC: Transport layer - what is it ?
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
81 * We will have an implementation for each different supported bus.
85 * DOC: Life cycle of the transport layer
87 * The transport layer has a very precise life cycle.
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
96 * 4) At some point (i.e. mac80211's start call), the op_mode will call
97 * the following sequence:
101 * 5) Then when finished (or reset):
102 * stop_fw (a.k.a. stop device for the moment)
105 * 6) Eventually, the free function will be called.
109 * DOC: Host command section
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),
116 #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)
119 #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)
126 * struct iwl_cmd_header
128 * This header format appears in the beginning of each command sent from the
129 * driver, and each response/notification received from uCode.
131 struct iwl_cmd_header
{
132 u8 cmd
; /* Command ID: REPLY_RXON, etc. */
133 u8 flags
; /* 0:5 reserved, 6 abort, 7 internal */
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.
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.
147 * The Linux driver uses the following format:
149 * 0:7 tfd index - position within TX queue
152 * 15 unsolicited RX or uCode-originated notification
158 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
159 #define FH_RSCSR_FRAME_INVALID 0x55550000
160 #define FH_RSCSR_FRAME_ALIGN 0x40
162 struct iwl_rx_packet
{
164 * The first 4 bytes of the RX frame header contain both the RX frame
165 * size and some flags.
167 * 31: flag flush RB request
168 * 30: flag ignore TC (terminal counter) request
169 * 29: flag fast IRQ request
171 * 13-00: RX frame size
174 struct iwl_cmd_header hdr
;
179 * enum CMD_MODE - how to send the host commands ?
181 * @CMD_SYNC: The caller will be stalled until the fw responds to the command
182 * @CMD_ASYNC: Return right away and don't want for the response
183 * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
185 * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
190 CMD_WANT_SKB
= BIT(1),
191 CMD_ON_DEMAND
= BIT(2),
194 #define DEF_CMD_PAYLOAD_SIZE 320
197 * struct iwl_device_cmd
199 * For allocation of the command and tx queues, this establishes the overall
200 * size of the largest command we send to uCode, except for commands that
201 * aren't fully copied and use other TFD space.
203 struct iwl_device_cmd
{
204 struct iwl_cmd_header hdr
; /* uCode API */
205 u8 payload
[DEF_CMD_PAYLOAD_SIZE
];
208 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
210 #define IWL_MAX_CMD_TFDS 2
213 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
215 * IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
216 * ring. The transport layer doesn't map the command's buffer to DMA, but
217 * rather copies it to an previously allocated DMA buffer. This flag tells
218 * the transport layer not to copy the command, but to map the existing
219 * buffer. This can save memcpy and is worth with very big comamnds.
221 enum iwl_hcmd_dataflag
{
222 IWL_HCMD_DFL_NOCOPY
= BIT(0),
226 * struct iwl_host_cmd - Host command to the uCode
228 * @data: array of chunks that composes the data of the host command
229 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
230 * @_rx_page_order: (internally used to free response packet)
231 * @_rx_page_addr: (internally used to free response packet)
232 * @handler_status: return value of the handler of the command
233 * (put in setup_rx_handlers) - valid for SYNC mode only
234 * @flags: can be CMD_*
235 * @len: array of the lenths of the chunks in data
236 * @dataflags: IWL_HCMD_DFL_*
237 * @id: id of the host command
239 struct iwl_host_cmd
{
240 const void *data
[IWL_MAX_CMD_TFDS
];
241 struct iwl_rx_packet
*resp_pkt
;
242 unsigned long _rx_page_addr
;
247 u16 len
[IWL_MAX_CMD_TFDS
];
248 u8 dataflags
[IWL_MAX_CMD_TFDS
];
252 static inline void iwl_free_resp(struct iwl_host_cmd
*cmd
)
254 free_pages(cmd
->_rx_page_addr
, cmd
->_rx_page_order
);
257 struct iwl_rx_cmd_buffer
{
261 unsigned int truesize
;
264 static inline void *rxb_addr(struct iwl_rx_cmd_buffer
*r
)
266 return (void *)((unsigned long)page_address(r
->_page
) + r
->_offset
);
269 static inline int rxb_offset(struct iwl_rx_cmd_buffer
*r
)
274 static inline struct page
*rxb_steal_page(struct iwl_rx_cmd_buffer
*r
)
276 r
->_page_stolen
= true;
281 #define MAX_NO_RECLAIM_CMDS 6
284 * Maximum number of HW queues the transport layer
287 #define IWL_MAX_HW_QUEUES 32
290 * struct iwl_trans_config - transport configuration
292 * @op_mode: pointer to the upper layer.
293 * @queue_to_fifo: queue to FIFO mapping to set up by
295 * @n_queue_to_fifo: number of queues to set up
296 * @cmd_queue: the index of the command queue.
297 * Must be set before start_fw.
298 * @no_reclaim_cmds: Some devices erroneously don't set the
299 * SEQ_RX_FRAME bit on some notifications, this is the
300 * list of such notifications to filter. Max length is
301 * %MAX_NO_RECLAIM_CMDS.
302 * @n_no_reclaim_cmds: # of commands in list
303 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
304 * if unset 4k will be the RX buffer size
305 * @queue_watchdog_timeout: time (in ms) after which queues
306 * are considered stuck and will trigger device restart
307 * @command_names: array of command names, must be 256 entries
308 * (one for each command); for debugging only
310 struct iwl_trans_config
{
311 struct iwl_op_mode
*op_mode
;
312 const u8
*queue_to_fifo
;
316 const u8
*no_reclaim_cmds
;
317 int n_no_reclaim_cmds
;
320 unsigned int queue_watchdog_timeout
;
321 const char **command_names
;
327 * struct iwl_trans_ops - transport specific operations
329 * All the handlers MUST be implemented
331 * @start_hw: starts the HW- from that point on, the HW can send interrupts
333 * @stop_hw: stops the HW- from that point on, the HW will be in low power but
334 * will still issue interrupt if the HW RF kill is triggered unless
335 * op_mode_leaving is true.
337 * @start_fw: allocates and inits all the resources for the transport
338 * layer. Also kick a fw image.
340 * @fw_alive: called when the fw sends alive notification
342 * @stop_device:stops the whole device (embedded CPU put to reset)
344 * @wowlan_suspend: put the device into the correct mode for WoWLAN during
345 * suspend. This is optional, if not implemented WoWLAN will not be
346 * supported. This callback may sleep.
347 * @send_cmd:send a host command
348 * May sleep only if CMD_SYNC is set
351 * @reclaim: free packet until ssn. Returns a list of freed packets.
353 * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
354 * ready and a successful ADDBA response has been received.
356 * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
358 * @wait_tx_queue_empty: wait until all tx queues are empty
360 * @dbgfs_register: add the dbgfs files under this directory. Files will be
361 * automatically deleted.
362 * @suspend: stop the device unless WoWLAN is configured
363 * @resume: resume activity of the device
364 * @write8: write a u8 to a register at offset ofs from the BAR
365 * @write32: write a u32 to a register at offset ofs from the BAR
366 * @read32: read a u32 register at offset ofs from the BAR
367 * @configure: configure parameters required by the transport layer from
368 * the op_mode. May be called several times before start_fw, can't be
370 * @set_pmi: set the power pmi state
372 struct iwl_trans_ops
{
374 int (*start_hw
)(struct iwl_trans
*iwl_trans
);
375 void (*stop_hw
)(struct iwl_trans
*iwl_trans
, bool op_mode_leaving
);
376 int (*start_fw
)(struct iwl_trans
*trans
, const struct fw_img
*fw
);
377 void (*fw_alive
)(struct iwl_trans
*trans
);
378 void (*stop_device
)(struct iwl_trans
*trans
);
380 void (*wowlan_suspend
)(struct iwl_trans
*trans
);
382 int (*send_cmd
)(struct iwl_trans
*trans
, struct iwl_host_cmd
*cmd
);
384 int (*tx
)(struct iwl_trans
*trans
, struct sk_buff
*skb
,
385 struct iwl_device_cmd
*dev_cmd
, int queue
);
386 void (*reclaim
)(struct iwl_trans
*trans
, int queue
, int ssn
,
387 struct sk_buff_head
*skbs
);
389 void (*tx_agg_setup
)(struct iwl_trans
*trans
, int queue
, int fifo
,
390 int sta_id
, int tid
, int frame_limit
, u16 ssn
);
391 void (*tx_agg_disable
)(struct iwl_trans
*trans
, int queue
);
393 int (*dbgfs_register
)(struct iwl_trans
*trans
, struct dentry
* dir
);
394 int (*wait_tx_queue_empty
)(struct iwl_trans
*trans
);
395 #ifdef CONFIG_PM_SLEEP
396 int (*suspend
)(struct iwl_trans
*trans
);
397 int (*resume
)(struct iwl_trans
*trans
);
399 void (*write8
)(struct iwl_trans
*trans
, u32 ofs
, u8 val
);
400 void (*write32
)(struct iwl_trans
*trans
, u32 ofs
, u32 val
);
401 u32 (*read32
)(struct iwl_trans
*trans
, u32 ofs
);
402 void (*configure
)(struct iwl_trans
*trans
,
403 const struct iwl_trans_config
*trans_cfg
);
404 void (*set_pmi
)(struct iwl_trans
*trans
, bool state
);
408 * enum iwl_trans_state - state of the transport layer
410 * @IWL_TRANS_NO_FW: no fw has sent an alive response
411 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
413 enum iwl_trans_state
{
415 IWL_TRANS_FW_ALIVE
= 1,
419 * struct iwl_trans - transport common data
421 * @ops - pointer to iwl_trans_ops
422 * @op_mode - pointer to the op_mode
423 * @cfg - pointer to the configuration
424 * @reg_lock - protect hw register access
425 * @dev - pointer to struct device * that represents the device
426 * @hw_id: a u32 with the ID of the device / subdevice.
427 * Set during transport allocation.
428 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
429 * @pm_support: set to true in start_hw if link pm is supported
430 * @wait_command_queue: the wait_queue for SYNC host commands
433 const struct iwl_trans_ops
*ops
;
434 struct iwl_op_mode
*op_mode
;
435 const struct iwl_cfg
*cfg
;
436 enum iwl_trans_state state
;
446 wait_queue_head_t wait_command_queue
;
448 /* pointer to trans specific struct */
449 /*Ensure that this pointer will always be aligned to sizeof pointer */
450 char trans_specific
[0] __aligned(sizeof(void *));
453 static inline void iwl_trans_configure(struct iwl_trans
*trans
,
454 const struct iwl_trans_config
*trans_cfg
)
457 * only set the op_mode for the moment. Later on, this function will do
460 trans
->op_mode
= trans_cfg
->op_mode
;
462 trans
->ops
->configure(trans
, trans_cfg
);
465 static inline int iwl_trans_start_hw(struct iwl_trans
*trans
)
469 return trans
->ops
->start_hw(trans
);
472 static inline void iwl_trans_stop_hw(struct iwl_trans
*trans
,
473 bool op_mode_leaving
)
477 trans
->ops
->stop_hw(trans
, op_mode_leaving
);
479 trans
->state
= IWL_TRANS_NO_FW
;
482 static inline void iwl_trans_fw_alive(struct iwl_trans
*trans
)
486 trans
->ops
->fw_alive(trans
);
488 trans
->state
= IWL_TRANS_FW_ALIVE
;
491 static inline int iwl_trans_start_fw(struct iwl_trans
*trans
,
492 const struct fw_img
*fw
)
496 return trans
->ops
->start_fw(trans
, fw
);
499 static inline void iwl_trans_stop_device(struct iwl_trans
*trans
)
503 trans
->ops
->stop_device(trans
);
505 trans
->state
= IWL_TRANS_NO_FW
;
508 static inline void iwl_trans_wowlan_suspend(struct iwl_trans
*trans
)
511 trans
->ops
->wowlan_suspend(trans
);
514 static inline int iwl_trans_send_cmd(struct iwl_trans
*trans
,
515 struct iwl_host_cmd
*cmd
)
517 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
518 "%s bad state = %d", __func__
, trans
->state
);
520 return trans
->ops
->send_cmd(trans
, cmd
);
523 static inline int iwl_trans_tx(struct iwl_trans
*trans
, struct sk_buff
*skb
,
524 struct iwl_device_cmd
*dev_cmd
, int queue
)
526 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
527 "%s bad state = %d", __func__
, trans
->state
);
529 return trans
->ops
->tx(trans
, skb
, dev_cmd
, queue
);
532 static inline void iwl_trans_reclaim(struct iwl_trans
*trans
, int queue
,
533 int ssn
, struct sk_buff_head
*skbs
)
535 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
536 "%s bad state = %d", __func__
, trans
->state
);
538 trans
->ops
->reclaim(trans
, queue
, ssn
, skbs
);
541 static inline void iwl_trans_tx_agg_disable(struct iwl_trans
*trans
, int queue
)
543 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
544 "%s bad state = %d", __func__
, trans
->state
);
546 trans
->ops
->tx_agg_disable(trans
, queue
);
549 static inline void iwl_trans_tx_agg_setup(struct iwl_trans
*trans
, int queue
,
550 int fifo
, int sta_id
, int tid
,
551 int frame_limit
, u16 ssn
)
555 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
556 "%s bad state = %d", __func__
, trans
->state
);
558 trans
->ops
->tx_agg_setup(trans
, queue
, fifo
, sta_id
, tid
,
562 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans
*trans
)
564 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
565 "%s bad state = %d", __func__
, trans
->state
);
567 return trans
->ops
->wait_tx_queue_empty(trans
);
570 static inline int iwl_trans_dbgfs_register(struct iwl_trans
*trans
,
573 return trans
->ops
->dbgfs_register(trans
, dir
);
576 #ifdef CONFIG_PM_SLEEP
577 static inline int iwl_trans_suspend(struct iwl_trans
*trans
)
579 return trans
->ops
->suspend(trans
);
582 static inline int iwl_trans_resume(struct iwl_trans
*trans
)
584 return trans
->ops
->resume(trans
);
588 static inline void iwl_trans_write8(struct iwl_trans
*trans
, u32 ofs
, u8 val
)
590 trans
->ops
->write8(trans
, ofs
, val
);
593 static inline void iwl_trans_write32(struct iwl_trans
*trans
, u32 ofs
, u32 val
)
595 trans
->ops
->write32(trans
, ofs
, val
);
598 static inline u32
iwl_trans_read32(struct iwl_trans
*trans
, u32 ofs
)
600 return trans
->ops
->read32(trans
, ofs
);
603 static inline void iwl_trans_set_pmi(struct iwl_trans
*trans
, bool state
)
605 trans
->ops
->set_pmi(trans
, state
);
608 /*****************************************************
609 * driver (transport) register/unregister functions
610 ******************************************************/
611 int __must_check
iwl_pci_register_driver(void);
612 void iwl_pci_unregister_driver(void);
614 #endif /* __iwl_trans_h__ */