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
157 /* iwl_cmd_header flags value */
158 #define IWL_CMD_FAILED_MSK 0x40
161 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
162 #define FH_RSCSR_FRAME_INVALID 0x55550000
163 #define FH_RSCSR_FRAME_ALIGN 0x40
165 struct iwl_rx_packet
{
167 * The first 4 bytes of the RX frame header contain both the RX frame
168 * size and some flags.
170 * 31: flag flush RB request
171 * 30: flag ignore TC (terminal counter) request
172 * 29: flag fast IRQ request
174 * 13-00: RX frame size
177 struct iwl_cmd_header hdr
;
182 * enum CMD_MODE - how to send the host commands ?
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
187 * 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.
193 * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
198 CMD_WANT_SKB
= BIT(1),
199 CMD_WANT_HCMD
= BIT(2),
200 CMD_ON_DEMAND
= BIT(3),
203 #define DEF_CMD_PAYLOAD_SIZE 320
206 * struct iwl_device_cmd
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.
212 struct iwl_device_cmd
{
213 struct iwl_cmd_header hdr
; /* uCode API */
214 u8 payload
[DEF_CMD_PAYLOAD_SIZE
];
217 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
219 #define IWL_MAX_CMD_TFDS 2
222 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
224 * IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
225 * 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.
230 enum iwl_hcmd_dataflag
{
231 IWL_HCMD_DFL_NOCOPY
= BIT(0),
235 * struct iwl_host_cmd - Host command to the uCode
237 * @data: array of chunks that composes the data of the host command
238 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
239 * @_rx_page_order: (internally used to free response packet)
240 * @_rx_page_addr: (internally used to free response packet)
241 * @handler_status: return value of the handler of the command
242 * (put in setup_rx_handlers) - valid for SYNC mode only
243 * @flags: can be CMD_*
244 * @len: array of the lenths of the chunks in data
245 * @dataflags: IWL_HCMD_DFL_*
246 * @id: id of the host command
248 struct iwl_host_cmd
{
249 const void *data
[IWL_MAX_CMD_TFDS
];
250 struct iwl_rx_packet
*resp_pkt
;
251 unsigned long _rx_page_addr
;
256 u16 len
[IWL_MAX_CMD_TFDS
];
257 u8 dataflags
[IWL_MAX_CMD_TFDS
];
261 static inline void iwl_free_resp(struct iwl_host_cmd
*cmd
)
263 free_pages(cmd
->_rx_page_addr
, cmd
->_rx_page_order
);
266 struct iwl_rx_cmd_buffer
{
270 unsigned int truesize
;
273 static inline void *rxb_addr(struct iwl_rx_cmd_buffer
*r
)
275 return (void *)((unsigned long)page_address(r
->_page
) + r
->_offset
);
278 static inline int rxb_offset(struct iwl_rx_cmd_buffer
*r
)
283 static inline struct page
*rxb_steal_page(struct iwl_rx_cmd_buffer
*r
)
285 r
->_page_stolen
= true;
290 #define MAX_NO_RECLAIM_CMDS 6
292 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
295 * Maximum number of HW queues the transport layer
298 #define IWL_MAX_HW_QUEUES 32
299 #define IWL_INVALID_STATION 255
300 #define IWL_MAX_TID_COUNT 8
301 #define IWL_FRAME_LIMIT 64
304 * struct iwl_trans_config - transport configuration
306 * @op_mode: pointer to the upper layer.
307 * @cmd_queue: the index of the command queue.
308 * Must be set before start_fw.
309 * @cmd_fifo: the fifo for host commands
310 * @no_reclaim_cmds: Some devices erroneously don't set the
311 * SEQ_RX_FRAME bit on some notifications, this is the
312 * list of such notifications to filter. Max length is
313 * %MAX_NO_RECLAIM_CMDS.
314 * @n_no_reclaim_cmds: # of commands in list
315 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
316 * if unset 4k will be the RX buffer size
317 * @queue_watchdog_timeout: time (in ms) after which queues
318 * are considered stuck and will trigger device restart
319 * @command_names: array of command names, must be 256 entries
320 * (one for each command); for debugging only
322 struct iwl_trans_config
{
323 struct iwl_op_mode
*op_mode
;
327 const u8
*no_reclaim_cmds
;
328 int n_no_reclaim_cmds
;
331 unsigned int queue_watchdog_timeout
;
332 const char **command_names
;
338 * struct iwl_trans_ops - transport specific operations
340 * All the handlers MUST be implemented
342 * @start_hw: starts the HW- from that point on, the HW can send interrupts
344 * @stop_hw: stops the HW- from that point on, the HW will be in low power but
345 * will still issue interrupt if the HW RF kill is triggered unless
346 * op_mode_leaving is true.
348 * @start_fw: allocates and inits all the resources for the transport
349 * layer. Also kick a fw image.
351 * @fw_alive: called when the fw sends alive notification
353 * @stop_device:stops the whole device (embedded CPU put to reset)
355 * @wowlan_suspend: put the device into the correct mode for WoWLAN during
356 * suspend. This is optional, if not implemented WoWLAN will not be
357 * supported. This callback may sleep.
358 * @send_cmd:send a host command
359 * May sleep only if CMD_SYNC is set
362 * @reclaim: free packet until ssn. Returns a list of freed packets.
364 * @txq_enable: setup a queue. To setup an AC queue, use the
365 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
366 * this one. The op_mode must not configure the HCMD queue. May sleep.
367 * @txq_disable: de-configure a Tx queue to send AMPDUs
369 * @wait_tx_queue_empty: wait until all tx queues are empty
371 * @dbgfs_register: add the dbgfs files under this directory. Files will be
372 * automatically deleted.
373 * @suspend: stop the device unless WoWLAN is configured
374 * @resume: resume activity of the device
375 * @write8: write a u8 to a register at offset ofs from the BAR
376 * @write32: write a u32 to a register at offset ofs from the BAR
377 * @read32: read a u32 register at offset ofs from the BAR
378 * @configure: configure parameters required by the transport layer from
379 * the op_mode. May be called several times before start_fw, can't be
381 * @set_pmi: set the power pmi state
383 struct iwl_trans_ops
{
385 int (*start_hw
)(struct iwl_trans
*iwl_trans
);
386 void (*stop_hw
)(struct iwl_trans
*iwl_trans
, bool op_mode_leaving
);
387 int (*start_fw
)(struct iwl_trans
*trans
, const struct fw_img
*fw
);
388 void (*fw_alive
)(struct iwl_trans
*trans
);
389 void (*stop_device
)(struct iwl_trans
*trans
);
391 void (*wowlan_suspend
)(struct iwl_trans
*trans
);
393 int (*send_cmd
)(struct iwl_trans
*trans
, struct iwl_host_cmd
*cmd
);
395 int (*tx
)(struct iwl_trans
*trans
, struct sk_buff
*skb
,
396 struct iwl_device_cmd
*dev_cmd
, int queue
);
397 void (*reclaim
)(struct iwl_trans
*trans
, int queue
, int ssn
,
398 struct sk_buff_head
*skbs
);
400 void (*txq_enable
)(struct iwl_trans
*trans
, int queue
, int fifo
,
401 int sta_id
, int tid
, int frame_limit
, u16 ssn
);
402 void (*txq_disable
)(struct iwl_trans
*trans
, int queue
);
404 int (*dbgfs_register
)(struct iwl_trans
*trans
, struct dentry
* dir
);
405 int (*wait_tx_queue_empty
)(struct iwl_trans
*trans
);
406 #ifdef CONFIG_PM_SLEEP
407 int (*suspend
)(struct iwl_trans
*trans
);
408 int (*resume
)(struct iwl_trans
*trans
);
410 void (*write8
)(struct iwl_trans
*trans
, u32 ofs
, u8 val
);
411 void (*write32
)(struct iwl_trans
*trans
, u32 ofs
, u32 val
);
412 u32 (*read32
)(struct iwl_trans
*trans
, u32 ofs
);
413 void (*configure
)(struct iwl_trans
*trans
,
414 const struct iwl_trans_config
*trans_cfg
);
415 void (*set_pmi
)(struct iwl_trans
*trans
, bool state
);
419 * enum iwl_trans_state - state of the transport layer
421 * @IWL_TRANS_NO_FW: no fw has sent an alive response
422 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
424 enum iwl_trans_state
{
426 IWL_TRANS_FW_ALIVE
= 1,
430 * struct iwl_trans - transport common data
432 * @ops - pointer to iwl_trans_ops
433 * @op_mode - pointer to the op_mode
434 * @cfg - pointer to the configuration
435 * @reg_lock - protect hw register access
436 * @dev - pointer to struct device * that represents the device
437 * @hw_id: a u32 with the ID of the device / subdevice.
438 * Set during transport allocation.
439 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
440 * @pm_support: set to true in start_hw if link pm is supported
441 * @wait_command_queue: the wait_queue for SYNC host commands
442 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
443 * The user should use iwl_trans_{alloc,free}_tx_cmd.
444 * @dev_cmd_headroom: room needed for the transport's private use before the
445 * device_cmd for Tx - for internal use only
446 * The user should use iwl_trans_{alloc,free}_tx_cmd.
449 const struct iwl_trans_ops
*ops
;
450 struct iwl_op_mode
*op_mode
;
451 const struct iwl_cfg
*cfg
;
452 enum iwl_trans_state state
;
462 wait_queue_head_t wait_command_queue
;
464 /* The following fields are internal only */
465 struct kmem_cache
*dev_cmd_pool
;
466 size_t dev_cmd_headroom
;
467 char dev_cmd_pool_name
[50];
469 struct dentry
*dbgfs_dir
;
471 /* pointer to trans specific struct */
472 /*Ensure that this pointer will always be aligned to sizeof pointer */
473 char trans_specific
[0] __aligned(sizeof(void *));
476 static inline void iwl_trans_configure(struct iwl_trans
*trans
,
477 const struct iwl_trans_config
*trans_cfg
)
480 * only set the op_mode for the moment. Later on, this function will do
483 trans
->op_mode
= trans_cfg
->op_mode
;
485 trans
->ops
->configure(trans
, trans_cfg
);
488 static inline int iwl_trans_start_hw(struct iwl_trans
*trans
)
492 return trans
->ops
->start_hw(trans
);
495 static inline void iwl_trans_stop_hw(struct iwl_trans
*trans
,
496 bool op_mode_leaving
)
500 trans
->ops
->stop_hw(trans
, op_mode_leaving
);
502 trans
->state
= IWL_TRANS_NO_FW
;
505 static inline void iwl_trans_fw_alive(struct iwl_trans
*trans
)
509 trans
->state
= IWL_TRANS_FW_ALIVE
;
511 trans
->ops
->fw_alive(trans
);
514 static inline int iwl_trans_start_fw(struct iwl_trans
*trans
,
515 const struct fw_img
*fw
)
519 return trans
->ops
->start_fw(trans
, fw
);
522 static inline void iwl_trans_stop_device(struct iwl_trans
*trans
)
526 trans
->ops
->stop_device(trans
);
528 trans
->state
= IWL_TRANS_NO_FW
;
531 static inline void iwl_trans_wowlan_suspend(struct iwl_trans
*trans
)
534 trans
->ops
->wowlan_suspend(trans
);
537 static inline int iwl_trans_send_cmd(struct iwl_trans
*trans
,
538 struct iwl_host_cmd
*cmd
)
540 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
541 "%s bad state = %d", __func__
, trans
->state
);
543 return trans
->ops
->send_cmd(trans
, cmd
);
546 static inline struct iwl_device_cmd
*
547 iwl_trans_alloc_tx_cmd(struct iwl_trans
*trans
)
549 u8
*dev_cmd_ptr
= kmem_cache_alloc(trans
->dev_cmd_pool
, GFP_ATOMIC
);
551 if (unlikely(dev_cmd_ptr
== NULL
))
554 return (struct iwl_device_cmd
*)
555 (dev_cmd_ptr
+ trans
->dev_cmd_headroom
);
558 static inline void iwl_trans_free_tx_cmd(struct iwl_trans
*trans
,
559 struct iwl_device_cmd
*dev_cmd
)
561 u8
*dev_cmd_ptr
= (u8
*)dev_cmd
- trans
->dev_cmd_headroom
;
563 kmem_cache_free(trans
->dev_cmd_pool
, dev_cmd_ptr
);
566 static inline int iwl_trans_tx(struct iwl_trans
*trans
, struct sk_buff
*skb
,
567 struct iwl_device_cmd
*dev_cmd
, int queue
)
569 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
570 "%s bad state = %d", __func__
, trans
->state
);
572 return trans
->ops
->tx(trans
, skb
, dev_cmd
, queue
);
575 static inline void iwl_trans_reclaim(struct iwl_trans
*trans
, int queue
,
576 int ssn
, struct sk_buff_head
*skbs
)
578 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
579 "%s bad state = %d", __func__
, trans
->state
);
581 trans
->ops
->reclaim(trans
, queue
, ssn
, skbs
);
584 static inline void iwl_trans_txq_disable(struct iwl_trans
*trans
, int queue
)
586 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
587 "%s bad state = %d", __func__
, trans
->state
);
589 trans
->ops
->txq_disable(trans
, queue
);
592 static inline void iwl_trans_txq_enable(struct iwl_trans
*trans
, int queue
,
593 int fifo
, int sta_id
, int tid
,
594 int frame_limit
, u16 ssn
)
598 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
599 "%s bad state = %d", __func__
, trans
->state
);
601 trans
->ops
->txq_enable(trans
, queue
, fifo
, sta_id
, tid
,
605 static inline void iwl_trans_ac_txq_enable(struct iwl_trans
*trans
, int queue
,
608 iwl_trans_txq_enable(trans
, queue
, fifo
, IWL_INVALID_STATION
,
609 IWL_MAX_TID_COUNT
, IWL_FRAME_LIMIT
, 0);
612 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans
*trans
)
614 WARN_ONCE(trans
->state
!= IWL_TRANS_FW_ALIVE
,
615 "%s bad state = %d", __func__
, trans
->state
);
617 return trans
->ops
->wait_tx_queue_empty(trans
);
620 static inline int iwl_trans_dbgfs_register(struct iwl_trans
*trans
,
623 return trans
->ops
->dbgfs_register(trans
, dir
);
626 #ifdef CONFIG_PM_SLEEP
627 static inline int iwl_trans_suspend(struct iwl_trans
*trans
)
629 return trans
->ops
->suspend(trans
);
632 static inline int iwl_trans_resume(struct iwl_trans
*trans
)
634 return trans
->ops
->resume(trans
);
638 static inline void iwl_trans_write8(struct iwl_trans
*trans
, u32 ofs
, u8 val
)
640 trans
->ops
->write8(trans
, ofs
, val
);
643 static inline void iwl_trans_write32(struct iwl_trans
*trans
, u32 ofs
, u32 val
)
645 trans
->ops
->write32(trans
, ofs
, val
);
648 static inline u32
iwl_trans_read32(struct iwl_trans
*trans
, u32 ofs
)
650 return trans
->ops
->read32(trans
, ofs
);
653 static inline void iwl_trans_set_pmi(struct iwl_trans
*trans
, bool state
)
655 trans
->ops
->set_pmi(trans
, state
);
658 /*****************************************************
659 * driver (transport) register/unregister functions
660 ******************************************************/
661 int __must_check
iwl_pci_register_driver(void);
662 void iwl_pci_unregister_driver(void);
664 #endif /* __iwl_trans_h__ */