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-shared.h"
70 #include "iwl-debug.h"
73 * DOC: Transport layer - what is it ?
75 * The tranport layer is the layer that deals with the HW directly. It provides
76 * an abstraction of the underlying HW to the upper layer. The transport layer
77 * doesn't provide any policy, algorithm or anything of this kind, but only
78 * mechanisms to make the HW do something.It is not completely stateless but
80 * We will have an implementation for each different supported bus.
84 * DOC: Life cycle of the transport layer
86 * The transport layer has a very precise life cycle.
88 * 1) A helper function is called during the module initialization and
89 * registers the bus driver's ops with the transport's alloc function.
90 * 2) Bus's probe calls to the transport layer's allocation functions.
91 * Of course this function is bus specific.
92 * 3) This allocation functions will spawn the upper layer which will
95 * 4) At some point (i.e. mac80211's start call), the op_mode will call
96 * the following sequence:
100 * 5) Then when finished (or reset):
101 * stop_fw (a.k.a. stop device for the moment)
104 * 6) Eventually, the free function will be called.
115 * DOC: Host command section
117 * A host command is a commaned issued by the upper layer to the fw. There are
118 * several versions of fw that have several APIs. The transport layer is
119 * completely agnostic to these differences.
120 * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode),
122 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
123 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
124 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
125 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
126 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
127 #define SEQ_TO_INDEX(s) ((s) & 0xff)
128 #define INDEX_TO_SEQ(i) ((i) & 0xff)
129 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
132 * struct iwl_cmd_header
134 * This header format appears in the beginning of each command sent from the
135 * driver, and each response/notification received from uCode.
137 struct iwl_cmd_header {
138 u8 cmd; /* Command ID: REPLY_RXON, etc. */
139 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
141 * The driver sets up the sequence number to values of its choosing.
142 * uCode does not use this value, but passes it back to the driver
143 * when sending the response to each driver-originated command, so
144 * the driver can match the response to the command. Since the values
145 * don't get used by uCode, the driver may set up an arbitrary format.
147 * There is one exception: uCode sets bit 15 when it originates
148 * the response/notification, i.e. when the response/notification
149 * is not a direct response to a command sent by the driver. For
150 * example, uCode issues REPLY_RX when it sends a received frame
151 * to the driver; it is not a direct response to any driver command.
153 * The Linux driver uses the following format:
155 * 0:7 tfd index - position within TX queue
158 * 15 unsolicited RX or uCode-originated notification
164 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
165 #define FH_RSCSR_FRAME_INVALID 0x55550000
166 #define FH_RSCSR_FRAME_ALIGN 0x40
168 struct iwl_rx_packet {
170 * The first 4 bytes of the RX frame header contain both the RX frame
171 * size and some flags.
173 * 31: flag flush RB request
174 * 30: flag ignore TC (terminal counter) request
175 * 29: flag fast IRQ request
177 * 13-00: RX frame size
180 struct iwl_cmd_header hdr;
185 * enum CMD_MODE - how to send the host commands ?
187 * @CMD_SYNC: The caller will be stalled until the fw responds to the command
188 * @CMD_ASYNC: Return right away and don't want for the response
189 * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
191 * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
196 CMD_WANT_SKB = BIT(1),
197 CMD_ON_DEMAND = BIT(2),
200 #define DEF_CMD_PAYLOAD_SIZE 320
203 * struct iwl_device_cmd
205 * For allocation of the command and tx queues, this establishes the overall
206 * size of the largest command we send to uCode, except for commands that
207 * aren't fully copied and use other TFD space.
209 struct iwl_device_cmd {
210 struct iwl_cmd_header hdr; /* uCode API */
211 u8 payload[DEF_CMD_PAYLOAD_SIZE];
214 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
216 #define IWL_MAX_CMD_TFDS 2
219 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
221 * IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
222 * ring. The transport layer doesn't map the command's buffer to DMA, but
223 * rather copies it to an previously allocated DMA buffer. This flag tells
224 * the transport layer not to copy the command, but to map the existing
225 * buffer. This can save memcpy and is worth with very big comamnds.
227 enum iwl_hcmd_dataflag {
228 IWL_HCMD_DFL_NOCOPY = BIT(0),
232 * struct iwl_host_cmd - Host command to the uCode
234 * @data: array of chunks that composes the data of the host command
235 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
236 * @_rx_page_order: (internally used to free response packet)
237 * @_rx_page_addr: (internally used to free response packet)
238 * @handler_status: return value of the handler of the command
239 * (put in setup_rx_handlers) - valid for SYNC mode only
240 * @flags: can be CMD_*
241 * @len: array of the lenths of the chunks in data
242 * @dataflags: IWL_HCMD_DFL_*
243 * @id: id of the host command
245 struct iwl_host_cmd {
246 const void *data[IWL_MAX_CMD_TFDS];
247 struct iwl_rx_packet *resp_pkt;
248 unsigned long _rx_page_addr;
253 u16 len[IWL_MAX_CMD_TFDS];
254 u8 dataflags[IWL_MAX_CMD_TFDS];
258 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
260 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
263 struct iwl_rx_cmd_buffer {
269 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
271 return (void *)((unsigned long)page_address(r->_page) + r->_offset);
274 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
279 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
281 r->_page_stolen = true;
286 #define MAX_NO_RECLAIM_CMDS 6
289 * Maximum number of HW queues the transport layer
292 #define IWL_MAX_HW_QUEUES 32
295 * struct iwl_trans_config - transport configuration
297 * @op_mode: pointer to the upper layer.
298 * @queue_to_fifo: queue to FIFO mapping to set up by
300 * @n_queue_to_fifo: number of queues to set up
301 * @cmd_queue: the index of the command queue.
302 * Must be set before start_fw.
303 * @no_reclaim_cmds: Some devices erroneously don't set the
304 * SEQ_RX_FRAME bit on some notifications, this is the
305 * list of such notifications to filter. Max length is
306 * %MAX_NO_RECLAIM_CMDS.
307 * @n_no_reclaim_cmds: # of commands in list
308 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
309 * if unset 4k will be the RX buffer size
310 * @queue_watchdog_timeout: time (in ms) after which queues
311 * are considered stuck and will trigger device restart
313 struct iwl_trans_config {
314 struct iwl_op_mode *op_mode;
315 const u8 *queue_to_fifo;
319 const u8 *no_reclaim_cmds;
320 int n_no_reclaim_cmds;
323 unsigned int queue_watchdog_timeout;
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.
336 * @start_fw: allocates and inits all the resources for the transport
337 * layer. Also kick a fw image.
339 * @fw_alive: called when the fw sends alive notification
341 * @stop_device:stops the whole device (embedded CPU put to reset)
343 * @wowlan_suspend: put the device into the correct mode for WoWLAN during
344 * suspend. This is optional, if not implemented WoWLAN will not be
345 * supported. This callback may sleep.
346 * @send_cmd:send a host command
347 * May sleep only if CMD_SYNC is set
350 * @reclaim: free packet until ssn. Returns a list of freed packets.
352 * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
353 * ready and a successful ADDBA response has been received.
355 * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
357 * @free: release all the ressource for the transport layer itself such as
358 * irq, tasklet etc... From this point on, the device may not issue
359 * any interrupt (incl. RFKILL).
361 * @wait_tx_queue_empty: wait until all tx queues are empty
363 * @dbgfs_register: add the dbgfs files under this directory. Files will be
364 * automatically deleted.
365 * @suspend: stop the device unless WoWLAN is configured
366 * @resume: resume activity of the device
367 * @write8: write a u8 to a register at offset ofs from the BAR
368 * @write32: write a u32 to a register at offset ofs from the BAR
369 * @read32: read a u32 register at offset ofs from the BAR
370 * @configure: configure parameters required by the transport layer from
371 * the op_mode. May be called several times before start_fw, can't be
373 * @set_pmi: set the power pmi state
375 struct iwl_trans_ops {
377 int (*start_hw)(struct iwl_trans *iwl_trans);
378 void (*stop_hw)(struct iwl_trans *iwl_trans);
379 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw);
380 void (*fw_alive)(struct iwl_trans *trans);
381 void (*stop_device)(struct iwl_trans *trans);
383 void (*wowlan_suspend)(struct iwl_trans *trans);
385 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
387 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
388 struct iwl_device_cmd *dev_cmd, int queue);
389 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
390 struct sk_buff_head *skbs);
392 void (*tx_agg_setup)(struct iwl_trans *trans, int queue, int fifo,
393 int sta_id, int tid, int frame_limit, u16 ssn);
394 void (*tx_agg_disable)(struct iwl_trans *trans, int queue);
396 void (*free)(struct iwl_trans *trans);
398 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
399 int (*wait_tx_queue_empty)(struct iwl_trans *trans);
400 #ifdef CONFIG_PM_SLEEP
401 int (*suspend)(struct iwl_trans *trans);
402 int (*resume)(struct iwl_trans *trans);
404 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
405 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
406 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
407 void (*configure)(struct iwl_trans *trans,
408 const struct iwl_trans_config *trans_cfg);
409 void (*set_pmi)(struct iwl_trans *trans, bool state);
413 * enum iwl_trans_state - state of the transport layer
415 * @IWL_TRANS_NO_FW: no fw has sent an alive response
416 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
418 enum iwl_trans_state {
420 IWL_TRANS_FW_ALIVE = 1,
424 * struct iwl_trans - transport common data
426 * @ops - pointer to iwl_trans_ops
427 * @op_mode - pointer to the op_mode
428 * @shrd - pointer to iwl_shared which holds shared data from the upper layer
429 * @reg_lock - protect hw register access
430 * @dev - pointer to struct device * that represents the device
431 * @hw_id: a u32 with the ID of the device / subdevice.
432 * Set during transport allocation.
433 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
434 * @nvm_device_type: indicates OTP or eeprom
435 * @pm_support: set to true in start_hw if link pm is supported
436 * @wait_command_queue: the wait_queue for SYNC host commands
439 const struct iwl_trans_ops *ops;
440 struct iwl_op_mode *op_mode;
441 struct iwl_shared *shrd;
442 enum iwl_trans_state state;
453 wait_queue_head_t wait_command_queue;
455 /* pointer to trans specific struct */
456 /*Ensure that this pointer will always be aligned to sizeof pointer */
457 char trans_specific[0] __aligned(sizeof(void *));
460 static inline void iwl_trans_configure(struct iwl_trans *trans,
461 const struct iwl_trans_config *trans_cfg)
464 * only set the op_mode for the moment. Later on, this function will do
467 trans->op_mode = trans_cfg->op_mode;
469 trans->ops->configure(trans, trans_cfg);
472 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
476 return trans->ops->start_hw(trans);
479 static inline void iwl_trans_stop_hw(struct iwl_trans *trans)
483 trans->ops->stop_hw(trans);
485 trans->state = IWL_TRANS_NO_FW;
488 static inline void iwl_trans_fw_alive(struct iwl_trans *trans)
492 trans->ops->fw_alive(trans);
494 trans->state = IWL_TRANS_FW_ALIVE;
497 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
498 const struct fw_img *fw)
502 return trans->ops->start_fw(trans, fw);
505 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
509 trans->ops->stop_device(trans);
511 trans->state = IWL_TRANS_NO_FW;
514 static inline void iwl_trans_wowlan_suspend(struct iwl_trans *trans)
517 trans->ops->wowlan_suspend(trans);
520 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
521 struct iwl_host_cmd *cmd)
523 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
524 "%s bad state = %d", __func__, trans->state);
526 return trans->ops->send_cmd(trans, cmd);
529 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
530 struct iwl_device_cmd *dev_cmd, int queue)
532 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
533 "%s bad state = %d", __func__, trans->state);
535 return trans->ops->tx(trans, skb, dev_cmd, queue);
538 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
539 int ssn, struct sk_buff_head *skbs)
541 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
542 "%s bad state = %d", __func__, trans->state);
544 trans->ops->reclaim(trans, queue, ssn, skbs);
547 static inline void iwl_trans_tx_agg_disable(struct iwl_trans *trans, int queue)
549 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
550 "%s bad state = %d", __func__, trans->state);
552 trans->ops->tx_agg_disable(trans, queue);
555 static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans, int queue,
556 int fifo, int sta_id, int tid,
557 int frame_limit, u16 ssn)
561 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
562 "%s bad state = %d", __func__, trans->state);
564 trans->ops->tx_agg_setup(trans, queue, fifo, sta_id, tid,
568 static inline void iwl_trans_free(struct iwl_trans *trans)
570 trans->ops->free(trans);
573 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
575 WARN_ONCE(trans->state != IWL_TRANS_FW_ALIVE,
576 "%s bad state = %d", __func__, trans->state);
578 return trans->ops->wait_tx_queue_empty(trans);
581 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
584 return trans->ops->dbgfs_register(trans, dir);
587 #ifdef CONFIG_PM_SLEEP
588 static inline int iwl_trans_suspend(struct iwl_trans *trans)
590 return trans->ops->suspend(trans);
593 static inline int iwl_trans_resume(struct iwl_trans *trans)
595 return trans->ops->resume(trans);
599 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
601 trans->ops->write8(trans, ofs, val);
604 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
606 trans->ops->write32(trans, ofs, val);
609 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
611 return trans->ops->read32(trans, ofs);
614 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
616 trans->ops->set_pmi(trans, state);
619 /*****************************************************
620 * Transport layers implementations + their allocation function
621 ******************************************************/
623 struct pci_device_id;
624 extern const struct iwl_trans_ops trans_ops_pcie;
625 struct iwl_trans *iwl_trans_pcie_alloc(struct iwl_shared *shrd,
626 struct pci_dev *pdev,
627 const struct pci_device_id *ent);
628 int __must_check iwl_pci_register_driver(void);
629 void iwl_pci_unregister_driver(void);
631 extern const struct iwl_trans_ops trans_ops_idi;
632 struct iwl_trans *iwl_trans_idi_alloc(struct iwl_shared *shrd,
634 const void *ent_void);
635 #endif /* __iwl_trans_h__ */