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 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of version 2 of the GNU General Public License as
14 * published by the Free Software Foundation.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
26 * The full GNU General Public License is included in this distribution
27 * in the file called COPYING.
29 * Contact Information:
30 * Intel Linux Wireless <linuxwifi@intel.com>
31 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
35 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
36 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
37 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
38 * All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
44 * * Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * * Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in
48 * the documentation and/or other materials provided with the
50 * * Neither the name Intel Corporation nor the names of its
51 * contributors may be used to endorse or promote products derived
52 * from this software without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
55 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
56 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
57 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
58 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
59 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
60 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
61 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
62 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
63 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
66 *****************************************************************************/
67 #ifndef __iwl_trans_h__
68 #define __iwl_trans_h__
70 #include <linux/ieee80211.h>
71 #include <linux/mm.h> /* for page_address */
72 #include <linux/lockdep.h>
73 #include <linux/kernel.h>
75 #include "iwl-debug.h"
76 #include "iwl-config.h"
78 #include "iwl-op-mode.h"
79 #include "fw/api/cmdhdr.h"
80 #include "fw/api/txq.h"
83 * DOC: Transport layer - what is it ?
85 * The transport layer is the layer that deals with the HW directly. It provides
86 * an abstraction of the underlying HW to the upper layer. The transport layer
87 * doesn't provide any policy, algorithm or anything of this kind, but only
88 * mechanisms to make the HW do something. It is not completely stateless but
90 * We will have an implementation for each different supported bus.
94 * DOC: Life cycle of the transport layer
96 * The transport layer has a very precise life cycle.
98 * 1) A helper function is called during the module initialization and
99 * registers the bus driver's ops with the transport's alloc function.
100 * 2) Bus's probe calls to the transport layer's allocation functions.
101 * Of course this function is bus specific.
102 * 3) This allocation functions will spawn the upper layer which will
105 * 4) At some point (i.e. mac80211's start call), the op_mode will call
106 * the following sequence:
110 * 5) Then when finished (or reset):
113 * 6) Eventually, the free function will be called.
116 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
117 #define FH_RSCSR_FRAME_INVALID 0x55550000
118 #define FH_RSCSR_FRAME_ALIGN 0x40
119 #define FH_RSCSR_RPA_EN BIT(25)
120 #define FH_RSCSR_RADA_EN BIT(26)
121 #define FH_RSCSR_RXQ_POS 16
122 #define FH_RSCSR_RXQ_MASK 0x3F0000
124 struct iwl_rx_packet {
126 * The first 4 bytes of the RX frame header contain both the RX frame
127 * size and some flags.
129 * 31: flag flush RB request
130 * 30: flag ignore TC (terminal counter) request
131 * 29: flag fast IRQ request
134 * 25: Offload enabled
137 * 22: Checksum enabled
140 * 13-00: RX frame size
143 struct iwl_cmd_header hdr;
147 static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt)
149 return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
152 static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt)
154 return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr);
158 * enum CMD_MODE - how to send the host commands ?
160 * @CMD_ASYNC: Return right away and don't wait for the response
161 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of
162 * the response. The caller needs to call iwl_free_resp when done.
163 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
164 * command queue, but after other high priority commands. Valid only
166 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
167 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
168 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
169 * (i.e. mark it as non-idle).
170 * @CMD_WANT_ASYNC_CALLBACK: the op_mode's async callback function must be
171 * called after this command completes. Valid only with CMD_ASYNC.
175 CMD_WANT_SKB = BIT(1),
176 CMD_SEND_IN_RFKILL = BIT(2),
177 CMD_HIGH_PRIO = BIT(3),
178 CMD_SEND_IN_IDLE = BIT(4),
179 CMD_MAKE_TRANS_IDLE = BIT(5),
180 CMD_WAKE_UP_TRANS = BIT(6),
181 CMD_WANT_ASYNC_CALLBACK = BIT(7),
184 #define DEF_CMD_PAYLOAD_SIZE 320
187 * struct iwl_device_cmd
189 * For allocation of the command and tx queues, this establishes the overall
190 * size of the largest command we send to uCode, except for commands that
191 * aren't fully copied and use other TFD space.
193 struct iwl_device_cmd {
196 struct iwl_cmd_header hdr; /* uCode API */
197 u8 payload[DEF_CMD_PAYLOAD_SIZE];
200 struct iwl_cmd_header_wide hdr_wide;
201 u8 payload_wide[DEF_CMD_PAYLOAD_SIZE -
202 sizeof(struct iwl_cmd_header_wide) +
203 sizeof(struct iwl_cmd_header)];
208 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
211 * number of transfer buffers (fragments) per transmit frame descriptor;
212 * this is just the driver's idea, the hardware supports 20
214 #define IWL_MAX_CMD_TBS_PER_TFD 2
217 * enum iwl_hcmd_dataflag - flag for each one of the chunks of the command
219 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
220 * ring. The transport layer doesn't map the command's buffer to DMA, but
221 * rather copies it to a previously allocated DMA buffer. This flag tells
222 * the transport layer not to copy the command, but to map the existing
223 * buffer (that is passed in) instead. This saves the memcpy and allows
224 * commands that are bigger than the fixed buffer to be submitted.
225 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
226 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
227 * chunk internally and free it again after the command completes. This
228 * can (currently) be used only once per command.
229 * Note that a TFD entry after a DUP one cannot be a normal copied one.
231 enum iwl_hcmd_dataflag {
232 IWL_HCMD_DFL_NOCOPY = BIT(0),
233 IWL_HCMD_DFL_DUP = BIT(1),
237 * struct iwl_host_cmd - Host command to the uCode
239 * @data: array of chunks that composes the data of the host command
240 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
241 * @_rx_page_order: (internally used to free response packet)
242 * @_rx_page_addr: (internally used to free response packet)
243 * @flags: can be CMD_*
244 * @len: array of the lengths of the chunks in data
245 * @dataflags: IWL_HCMD_DFL_*
246 * @id: command id of the host command, for wide commands encoding the
247 * version and group as well
249 struct iwl_host_cmd {
250 const void *data[IWL_MAX_CMD_TBS_PER_TFD];
251 struct iwl_rx_packet *resp_pkt;
252 unsigned long _rx_page_addr;
257 u16 len[IWL_MAX_CMD_TBS_PER_TFD];
258 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
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 {
271 unsigned int truesize;
275 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
277 return (void *)((unsigned long)page_address(r->_page) + r->_offset);
280 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
285 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
287 r->_page_stolen = true;
292 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
294 __free_pages(r->_page, r->_rx_page_order);
297 #define MAX_NO_RECLAIM_CMDS 6
299 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
302 * Maximum number of HW queues the transport layer
305 #define IWL_MAX_HW_QUEUES 32
306 #define IWL_MAX_TVQM_QUEUES 512
308 #define IWL_MAX_TID_COUNT 8
309 #define IWL_MGMT_TID 15
310 #define IWL_FRAME_LIMIT 64
311 #define IWL_MAX_RX_HW_QUEUES 16
314 * enum iwl_wowlan_status - WoWLAN image/device status
315 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
316 * @IWL_D3_STATUS_RESET: device was reset while suspended
324 * enum iwl_trans_status: transport status flags
325 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
326 * @STATUS_DEVICE_ENABLED: APM is enabled
327 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
328 * @STATUS_INT_ENABLED: interrupts are enabled
329 * @STATUS_RFKILL_HW: the actual HW state of the RF-kill switch
330 * @STATUS_RFKILL_OPMODE: RF-kill state reported to opmode
331 * @STATUS_FW_ERROR: the fw is in error state
332 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
334 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
335 * @STATUS_TRANS_DEAD: trans is dead - avoid any read/write operation
337 enum iwl_trans_status {
338 STATUS_SYNC_HCMD_ACTIVE,
339 STATUS_DEVICE_ENABLED,
343 STATUS_RFKILL_OPMODE,
345 STATUS_TRANS_GOING_IDLE,
351 iwl_trans_get_rb_size_order(enum iwl_amsdu_size rb_size)
355 return get_order(2 * 1024);
357 return get_order(4 * 1024);
359 return get_order(8 * 1024);
361 return get_order(12 * 1024);
368 struct iwl_hcmd_names {
370 const char *const cmd_name;
373 #define HCMD_NAME(x) \
374 { .cmd_id = x, .cmd_name = #x }
376 struct iwl_hcmd_arr {
377 const struct iwl_hcmd_names *arr;
381 #define HCMD_ARR(x) \
382 { .arr = x, .size = ARRAY_SIZE(x) }
385 * struct iwl_trans_config - transport configuration
387 * @op_mode: pointer to the upper layer.
388 * @cmd_queue: the index of the command queue.
389 * Must be set before start_fw.
390 * @cmd_fifo: the fifo for host commands
391 * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue.
392 * @no_reclaim_cmds: Some devices erroneously don't set the
393 * SEQ_RX_FRAME bit on some notifications, this is the
394 * list of such notifications to filter. Max length is
395 * %MAX_NO_RECLAIM_CMDS.
396 * @n_no_reclaim_cmds: # of commands in list
397 * @rx_buf_size: RX buffer size needed for A-MSDUs
398 * if unset 4k will be the RX buffer size
399 * @bc_table_dword: set to true if the BC table expects the byte count to be
400 * in DWORD (as opposed to bytes)
401 * @scd_set_active: should the transport configure the SCD for HCMD queue
402 * @sw_csum_tx: transport should compute the TCP checksum
403 * @command_groups: array of command groups, each member is an array of the
404 * commands in the group; for debugging only
405 * @command_groups_size: number of command groups, to avoid illegal access
406 * @cb_data_offs: offset inside skb->cb to store transport data at, must have
407 * space for at least two pointers
409 struct iwl_trans_config {
410 struct iwl_op_mode *op_mode;
414 unsigned int cmd_q_wdg_timeout;
415 const u8 *no_reclaim_cmds;
416 unsigned int n_no_reclaim_cmds;
418 enum iwl_amsdu_size rx_buf_size;
422 const struct iwl_hcmd_arr *command_groups;
423 int command_groups_size;
428 struct iwl_trans_dump_data {
435 struct iwl_trans_txq_scd_cfg {
444 * struct iwl_trans_rxq_dma_data - RX queue DMA data
445 * @fr_bd_cb: DMA address of free BD cyclic buffer
446 * @fr_bd_wid: Initial write index of the free BD cyclic buffer
447 * @urbd_stts_wrptr: DMA address of urbd_stts_wrptr
448 * @ur_bd_cb: DMA address of used BD cyclic buffer
450 struct iwl_trans_rxq_dma_data {
458 * struct iwl_trans_ops - transport specific operations
460 * All the handlers MUST be implemented
462 * @start_hw: starts the HW. If low_power is true, the NIC needs to be taken
463 * out of a low power state. From that point on, the HW can send
464 * interrupts. May sleep.
465 * @op_mode_leave: Turn off the HW RF kill indication if on
467 * @start_fw: allocates and inits all the resources for the transport
468 * layer. Also kick a fw image.
470 * @fw_alive: called when the fw sends alive notification. If the fw provides
471 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
473 * @stop_device: stops the whole device (embedded CPU put to reset) and stops
474 * the HW. If low_power is true, the NIC will be put in low power state.
475 * From that point on, the HW will be stopped but will still issue an
476 * interrupt if the HW RF kill switch is triggered.
477 * This callback must do the right thing and not crash even if %start_hw()
478 * was called but not &start_fw(). May sleep.
479 * @d3_suspend: put the device into the correct mode for WoWLAN during
480 * suspend. This is optional, if not implemented WoWLAN will not be
481 * supported. This callback may sleep.
482 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
483 * talk to the WoWLAN image to get its status. This is optional, if not
484 * implemented WoWLAN will not be supported. This callback may sleep.
485 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
486 * If RFkill is asserted in the middle of a SYNC host command, it must
487 * return -ERFKILL straight away.
488 * May sleep only if CMD_ASYNC is not set
489 * @tx: send an skb. The transport relies on the op_mode to zero the
490 * the ieee80211_tx_info->driver_data. If the MPDU is an A-MSDU, all
491 * the CSUM will be taken care of (TCP CSUM and IP header in case of
492 * IPv4). If the MPDU is a single MSDU, the op_mode must compute the IP
493 * header if it is IPv4.
495 * @reclaim: free packet until ssn. Returns a list of freed packets.
497 * @txq_enable: setup a queue. To setup an AC queue, use the
498 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
499 * this one. The op_mode must not configure the HCMD queue. The scheduler
500 * configuration may be %NULL, in which case the hardware will not be
501 * configured. If true is returned, the operation mode needs to increment
502 * the sequence number of the packets routed to this queue because of a
503 * hardware scheduler bug. May sleep.
504 * @txq_disable: de-configure a Tx queue to send AMPDUs
506 * @txq_set_shared_mode: change Tx queue shared/unshared marking
507 * @wait_tx_queues_empty: wait until tx queues are empty. May sleep.
508 * @wait_txq_empty: wait until specific tx queue is empty. May sleep.
509 * @freeze_txq_timer: prevents the timer of the queue from firing until the
510 * queue is set to awake. Must be atomic.
511 * @block_txq_ptrs: stop updating the write pointers of the Tx queues. Note
512 * that the transport needs to refcount the calls since this function
513 * will be called several times with block = true, and then the queues
514 * need to be unblocked only after the same number of calls with
516 * @write8: write a u8 to a register at offset ofs from the BAR
517 * @write32: write a u32 to a register at offset ofs from the BAR
518 * @read32: read a u32 register at offset ofs from the BAR
519 * @read_prph: read a DWORD from a periphery register
520 * @write_prph: write a DWORD to a periphery register
521 * @read_mem: read device's SRAM in DWORD
522 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
524 * @configure: configure parameters required by the transport layer from
525 * the op_mode. May be called several times before start_fw, can't be
527 * @set_pmi: set the power pmi state
528 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
529 * Sleeping is not allowed between grab_nic_access and
530 * release_nic_access.
531 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
532 * must be the same one that was sent before to the grab_nic_access.
533 * @set_bits_mask - set SRAM register according to value and mask.
534 * @ref: grab a reference to the transport/FW layers, disallowing
535 * certain low power states
536 * @unref: release a reference previously taken with @ref. Note that
537 * initially the reference count is 1, making an initial @unref
538 * necessary to allow low power states.
539 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last
540 * TX'ed commands and similar. The buffer will be vfree'd by the caller.
541 * Note that the transport must fill in the proper file headers.
542 * @dump_regs: dump using IWL_ERR configuration space and memory mapped
543 * registers of the device to diagnose failure, e.g., when HW becomes
546 struct iwl_trans_ops {
548 int (*start_hw)(struct iwl_trans *iwl_trans, bool low_power);
549 void (*op_mode_leave)(struct iwl_trans *iwl_trans);
550 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
552 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
553 void (*stop_device)(struct iwl_trans *trans, bool low_power);
555 void (*d3_suspend)(struct iwl_trans *trans, bool test, bool reset);
556 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status,
557 bool test, bool reset);
559 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
561 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
562 struct iwl_device_cmd *dev_cmd, int queue);
563 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
564 struct sk_buff_head *skbs);
566 bool (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn,
567 const struct iwl_trans_txq_scd_cfg *cfg,
568 unsigned int queue_wdg_timeout);
569 void (*txq_disable)(struct iwl_trans *trans, int queue,
571 /* 22000 functions */
572 int (*txq_alloc)(struct iwl_trans *trans,
573 struct iwl_tx_queue_cfg_cmd *cmd,
574 int cmd_id, int size,
575 unsigned int queue_wdg_timeout);
576 void (*txq_free)(struct iwl_trans *trans, int queue);
577 int (*rxq_dma_data)(struct iwl_trans *trans, int queue,
578 struct iwl_trans_rxq_dma_data *data);
580 void (*txq_set_shared_mode)(struct iwl_trans *trans, u32 txq_id,
583 int (*wait_tx_queues_empty)(struct iwl_trans *trans, u32 txq_bm);
584 int (*wait_txq_empty)(struct iwl_trans *trans, int queue);
585 void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs,
587 void (*block_txq_ptrs)(struct iwl_trans *trans, bool block);
589 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
590 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
591 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
592 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
593 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
594 int (*read_mem)(struct iwl_trans *trans, u32 addr,
595 void *buf, int dwords);
596 int (*write_mem)(struct iwl_trans *trans, u32 addr,
597 const void *buf, int dwords);
598 void (*configure)(struct iwl_trans *trans,
599 const struct iwl_trans_config *trans_cfg);
600 void (*set_pmi)(struct iwl_trans *trans, bool state);
601 void (*sw_reset)(struct iwl_trans *trans);
602 bool (*grab_nic_access)(struct iwl_trans *trans, unsigned long *flags);
603 void (*release_nic_access)(struct iwl_trans *trans,
604 unsigned long *flags);
605 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
607 void (*ref)(struct iwl_trans *trans);
608 void (*unref)(struct iwl_trans *trans);
609 int (*suspend)(struct iwl_trans *trans);
610 void (*resume)(struct iwl_trans *trans);
612 struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans,
613 const struct iwl_fw_dbg_trigger_tlv
616 void (*dump_regs)(struct iwl_trans *trans);
620 * enum iwl_trans_state - state of the transport layer
622 * @IWL_TRANS_NO_FW: no fw has sent an alive response
623 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
625 enum iwl_trans_state {
627 IWL_TRANS_FW_ALIVE = 1,
631 * DOC: Platform power management
633 * There are two types of platform power management: system-wide
634 * (WoWLAN) and runtime.
636 * In system-wide power management the entire platform goes into a low
637 * power state (e.g. idle or suspend to RAM) at the same time and the
638 * device is configured as a wakeup source for the entire platform.
639 * This is usually triggered by userspace activity (e.g. the user
640 * presses the suspend button or a power management daemon decides to
641 * put the platform in low power mode). The device's behavior in this
642 * mode is dictated by the wake-on-WLAN configuration.
644 * In runtime power management, only the devices which are themselves
645 * idle enter a low power state. This is done at runtime, which means
646 * that the entire system is still running normally. This mode is
647 * usually triggered automatically by the device driver and requires
648 * the ability to enter and exit the low power modes in a very short
649 * time, so there is not much impact in usability.
651 * The terms used for the device's behavior are as follows:
653 * - D0: the device is fully powered and the host is awake;
654 * - D3: the device is in low power mode and only reacts to
655 * specific events (e.g. magic-packet received or scan
657 * - D0I3: the device is in low power mode and reacts to any
658 * activity (e.g. RX);
660 * These terms reflect the power modes in the firmware and are not to
661 * be confused with the physical device power state. The NIC can be
662 * in D0I3 mode even if, for instance, the PCI device is in D3 state.
666 * enum iwl_plat_pm_mode - platform power management mode
668 * This enumeration describes the device's platform power management
669 * behavior when in idle mode (i.e. runtime power management) or when
670 * in system-wide suspend (i.e WoWLAN).
672 * @IWL_PLAT_PM_MODE_DISABLED: power management is disabled for this
673 * device. At runtime, this means that nothing happens and the
674 * device always remains in active. In system-wide suspend mode,
675 * it means that the all connections will be closed automatically
676 * by mac80211 before the platform is suspended.
677 * @IWL_PLAT_PM_MODE_D3: the device goes into D3 mode (i.e. WoWLAN).
678 * For runtime power management, this mode is not officially
680 * @IWL_PLAT_PM_MODE_D0I3: the device goes into D0I3 mode.
682 enum iwl_plat_pm_mode {
683 IWL_PLAT_PM_MODE_DISABLED,
685 IWL_PLAT_PM_MODE_D0I3,
688 /* Max time to wait for trans to become idle/non-idle on d0i3
689 * enter/exit (in msecs).
691 #define IWL_TRANS_IDLE_TIMEOUT 2000
694 * struct iwl_trans - transport common data
696 * @ops - pointer to iwl_trans_ops
697 * @op_mode - pointer to the op_mode
698 * @cfg - pointer to the configuration
699 * @drv - pointer to iwl_drv
700 * @status: a bit-mask of transport status flags
701 * @dev - pointer to struct device * that represents the device
702 * @max_skb_frags: maximum number of fragments an SKB can have when transmitted.
703 * 0 indicates that frag SKBs (NETIF_F_SG) aren't supported.
704 * @hw_rf_id a u32 with the device RF ID
705 * @hw_id: a u32 with the ID of the device / sub-device.
706 * Set during transport allocation.
707 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
708 * @pm_support: set to true in start_hw if link pm is supported
709 * @ltr_enabled: set to true if the LTR is enabled
710 * @wide_cmd_header: true when ucode supports wide command header format
711 * @num_rx_queues: number of RX queues allocated by the transport;
712 * the transport must set this before calling iwl_drv_start()
713 * @iml_len: the length of the image loader
714 * @iml: a pointer to the image loader itself
715 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
716 * The user should use iwl_trans_{alloc,free}_tx_cmd.
717 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
718 * starting the firmware, used for tracing
719 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
720 * start of the 802.11 header in the @rx_mpdu_cmd
721 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
722 * @dbg_dest_tlv: points to the destination TLV for debug
723 * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
724 * @dbg_trigger_tlv: array of pointers to triggers TLVs for debug
725 * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
726 * @system_pm_mode: the system-wide power management mode in use.
727 * This mode is set dynamically, depending on the WoWLAN values
728 * configured from the userspace at runtime.
729 * @runtime_pm_mode: the runtime power management mode in use. This
730 * mode is set during the initialization phase and is not
731 * supposed to change during runtime.
734 const struct iwl_trans_ops *ops;
735 struct iwl_op_mode *op_mode;
736 const struct iwl_cfg *cfg;
738 enum iwl_trans_state state;
739 unsigned long status;
748 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
753 const struct iwl_hcmd_arr *command_groups;
754 int command_groups_size;
755 bool wide_cmd_header;
762 /* The following fields are internal only */
763 struct kmem_cache *dev_cmd_pool;
764 char dev_cmd_pool_name[50];
766 struct dentry *dbgfs_dir;
768 #ifdef CONFIG_LOCKDEP
769 struct lockdep_map sync_cmd_lockdep_map;
772 const struct iwl_fw_dbg_dest_tlv_v1 *dbg_dest_tlv;
773 const struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
774 struct iwl_fw_dbg_trigger_tlv * const *dbg_trigger_tlv;
778 enum iwl_plat_pm_mode system_pm_mode;
779 enum iwl_plat_pm_mode runtime_pm_mode;
782 /* pointer to trans specific struct */
783 /*Ensure that this pointer will always be aligned to sizeof pointer */
784 char trans_specific[0] __aligned(sizeof(void *));
787 const char *iwl_get_cmd_string(struct iwl_trans *trans, u32 id);
788 int iwl_cmd_groups_verify_sorted(const struct iwl_trans_config *trans);
790 static inline void iwl_trans_configure(struct iwl_trans *trans,
791 const struct iwl_trans_config *trans_cfg)
793 trans->op_mode = trans_cfg->op_mode;
795 trans->ops->configure(trans, trans_cfg);
796 WARN_ON(iwl_cmd_groups_verify_sorted(trans_cfg));
799 static inline int _iwl_trans_start_hw(struct iwl_trans *trans, bool low_power)
803 return trans->ops->start_hw(trans, low_power);
806 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
808 return trans->ops->start_hw(trans, true);
811 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans)
815 if (trans->ops->op_mode_leave)
816 trans->ops->op_mode_leave(trans);
818 trans->op_mode = NULL;
820 trans->state = IWL_TRANS_NO_FW;
823 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
827 trans->state = IWL_TRANS_FW_ALIVE;
829 trans->ops->fw_alive(trans, scd_addr);
832 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
833 const struct fw_img *fw,
838 WARN_ON_ONCE(!trans->rx_mpdu_cmd);
840 clear_bit(STATUS_FW_ERROR, &trans->status);
841 return trans->ops->start_fw(trans, fw, run_in_rfkill);
844 static inline void _iwl_trans_stop_device(struct iwl_trans *trans,
849 trans->ops->stop_device(trans, low_power);
851 trans->state = IWL_TRANS_NO_FW;
854 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
856 _iwl_trans_stop_device(trans, true);
859 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test,
863 if (trans->ops->d3_suspend)
864 trans->ops->d3_suspend(trans, test, reset);
867 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
868 enum iwl_d3_status *status,
869 bool test, bool reset)
872 if (!trans->ops->d3_resume)
875 return trans->ops->d3_resume(trans, status, test, reset);
878 static inline int iwl_trans_suspend(struct iwl_trans *trans)
880 if (!trans->ops->suspend)
883 return trans->ops->suspend(trans);
886 static inline void iwl_trans_resume(struct iwl_trans *trans)
888 if (trans->ops->resume)
889 trans->ops->resume(trans);
892 static inline struct iwl_trans_dump_data *
893 iwl_trans_dump_data(struct iwl_trans *trans,
894 const struct iwl_fw_dbg_trigger_tlv *trigger)
896 if (!trans->ops->dump_data)
898 return trans->ops->dump_data(trans, trigger);
901 static inline void iwl_trans_dump_regs(struct iwl_trans *trans)
903 if (trans->ops->dump_regs)
904 trans->ops->dump_regs(trans);
907 static inline struct iwl_device_cmd *
908 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
910 return kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
913 int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
915 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
916 struct iwl_device_cmd *dev_cmd)
918 kmem_cache_free(trans->dev_cmd_pool, dev_cmd);
921 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
922 struct iwl_device_cmd *dev_cmd, int queue)
924 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
927 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
928 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
932 return trans->ops->tx(trans, skb, dev_cmd, queue);
935 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
936 int ssn, struct sk_buff_head *skbs)
938 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
939 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
943 trans->ops->reclaim(trans, queue, ssn, skbs);
946 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue,
949 trans->ops->txq_disable(trans, queue, configure_scd);
953 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn,
954 const struct iwl_trans_txq_scd_cfg *cfg,
955 unsigned int queue_wdg_timeout)
959 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
960 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
964 return trans->ops->txq_enable(trans, queue, ssn,
965 cfg, queue_wdg_timeout);
969 iwl_trans_get_rxq_dma_data(struct iwl_trans *trans, int queue,
970 struct iwl_trans_rxq_dma_data *data)
972 if (WARN_ON_ONCE(!trans->ops->rxq_dma_data))
975 return trans->ops->rxq_dma_data(trans, queue, data);
979 iwl_trans_txq_free(struct iwl_trans *trans, int queue)
981 if (WARN_ON_ONCE(!trans->ops->txq_free))
984 trans->ops->txq_free(trans, queue);
988 iwl_trans_txq_alloc(struct iwl_trans *trans,
989 struct iwl_tx_queue_cfg_cmd *cmd,
990 int cmd_id, int size,
991 unsigned int wdg_timeout)
995 if (WARN_ON_ONCE(!trans->ops->txq_alloc))
998 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
999 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1003 return trans->ops->txq_alloc(trans, cmd, cmd_id, size, wdg_timeout);
1006 static inline void iwl_trans_txq_set_shared_mode(struct iwl_trans *trans,
1007 int queue, bool shared_mode)
1009 if (trans->ops->txq_set_shared_mode)
1010 trans->ops->txq_set_shared_mode(trans, queue, shared_mode);
1013 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
1014 int fifo, int sta_id, int tid,
1015 int frame_limit, u16 ssn,
1016 unsigned int queue_wdg_timeout)
1018 struct iwl_trans_txq_scd_cfg cfg = {
1022 .frame_limit = frame_limit,
1023 .aggregate = sta_id >= 0,
1026 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout);
1030 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo,
1031 unsigned int queue_wdg_timeout)
1033 struct iwl_trans_txq_scd_cfg cfg = {
1036 .tid = IWL_MAX_TID_COUNT,
1037 .frame_limit = IWL_FRAME_LIMIT,
1041 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout);
1044 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans,
1048 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1049 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1053 if (trans->ops->freeze_txq_timer)
1054 trans->ops->freeze_txq_timer(trans, txqs, freeze);
1057 static inline void iwl_trans_block_txq_ptrs(struct iwl_trans *trans,
1060 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1061 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1065 if (trans->ops->block_txq_ptrs)
1066 trans->ops->block_txq_ptrs(trans, block);
1069 static inline int iwl_trans_wait_tx_queues_empty(struct iwl_trans *trans,
1072 if (WARN_ON_ONCE(!trans->ops->wait_tx_queues_empty))
1075 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1076 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1080 return trans->ops->wait_tx_queues_empty(trans, txqs);
1083 static inline int iwl_trans_wait_txq_empty(struct iwl_trans *trans, int queue)
1085 if (WARN_ON_ONCE(!trans->ops->wait_txq_empty))
1088 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1089 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1093 return trans->ops->wait_txq_empty(trans, queue);
1096 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
1098 trans->ops->write8(trans, ofs, val);
1101 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
1103 trans->ops->write32(trans, ofs, val);
1106 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
1108 return trans->ops->read32(trans, ofs);
1111 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
1113 return trans->ops->read_prph(trans, ofs);
1116 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
1119 return trans->ops->write_prph(trans, ofs, val);
1122 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
1123 void *buf, int dwords)
1125 return trans->ops->read_mem(trans, addr, buf, dwords);
1128 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
1130 if (__builtin_constant_p(bufsize)) \
1131 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
1132 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
1135 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
1139 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
1145 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
1146 const void *buf, int dwords)
1148 return trans->ops->write_mem(trans, addr, buf, dwords);
1151 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
1154 return iwl_trans_write_mem(trans, addr, &val, 1);
1157 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
1159 if (trans->ops->set_pmi)
1160 trans->ops->set_pmi(trans, state);
1163 static inline void iwl_trans_sw_reset(struct iwl_trans *trans)
1165 if (trans->ops->sw_reset)
1166 trans->ops->sw_reset(trans);
1170 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
1172 trans->ops->set_bits_mask(trans, reg, mask, value);
1175 #define iwl_trans_grab_nic_access(trans, flags) \
1176 __cond_lock(nic_access, \
1177 likely((trans)->ops->grab_nic_access(trans, flags)))
1179 static inline void __releases(nic_access)
1180 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
1182 trans->ops->release_nic_access(trans, flags);
1183 __release(nic_access);
1186 static inline void iwl_trans_fw_error(struct iwl_trans *trans)
1188 if (WARN_ON_ONCE(!trans->op_mode))
1191 /* prevent double restarts due to the same erroneous FW */
1192 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status))
1193 iwl_op_mode_nic_error(trans->op_mode);
1196 /*****************************************************
1197 * transport helper functions
1198 *****************************************************/
1199 struct iwl_trans *iwl_trans_alloc(unsigned int priv_size,
1201 const struct iwl_cfg *cfg,
1202 const struct iwl_trans_ops *ops);
1203 void iwl_trans_free(struct iwl_trans *trans);
1204 void iwl_trans_ref(struct iwl_trans *trans);
1205 void iwl_trans_unref(struct iwl_trans *trans);
1207 /*****************************************************
1208 * driver (transport) register/unregister functions
1209 ******************************************************/
1210 int __must_check iwl_pci_register_driver(void);
1211 void iwl_pci_unregister_driver(void);
1213 #endif /* __iwl_trans_h__ */