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"
82 * DOC: Transport layer - what is it ?
84 * The transport layer is the layer that deals with the HW directly. It provides
85 * an abstraction of the underlying HW to the upper layer. The transport layer
86 * doesn't provide any policy, algorithm or anything of this kind, but only
87 * mechanisms to make the HW do something. It is not completely stateless but
89 * We will have an implementation for each different supported bus.
93 * DOC: Life cycle of the transport layer
95 * The transport layer has a very precise life cycle.
97 * 1) A helper function is called during the module initialization and
98 * registers the bus driver's ops with the transport's alloc function.
99 * 2) Bus's probe calls to the transport layer's allocation functions.
100 * Of course this function is bus specific.
101 * 3) This allocation functions will spawn the upper layer which will
104 * 4) At some point (i.e. mac80211's start call), the op_mode will call
105 * the following sequence:
109 * 5) Then when finished (or reset):
112 * 6) Eventually, the free function will be called.
115 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
116 #define FH_RSCSR_FRAME_INVALID 0x55550000
117 #define FH_RSCSR_FRAME_ALIGN 0x40
118 #define FH_RSCSR_RPA_EN BIT(25)
119 #define FH_RSCSR_RXQ_POS 16
120 #define FH_RSCSR_RXQ_MASK 0x3F0000
122 struct iwl_rx_packet {
124 * The first 4 bytes of the RX frame header contain both the RX frame
125 * size and some flags.
127 * 31: flag flush RB request
128 * 30: flag ignore TC (terminal counter) request
129 * 29: flag fast IRQ request
131 * 25: Offload enabled
134 * 22: Checksum enabled
137 * 13-00: RX frame size
140 struct iwl_cmd_header hdr;
144 static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt)
146 return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
149 static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt)
151 return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr);
155 * enum CMD_MODE - how to send the host commands ?
157 * @CMD_ASYNC: Return right away and don't wait for the response
158 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of
159 * the response. The caller needs to call iwl_free_resp when done.
160 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
161 * command queue, but after other high priority commands. Valid only
163 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
164 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
165 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
166 * (i.e. mark it as non-idle).
167 * @CMD_WANT_ASYNC_CALLBACK: the op_mode's async callback function must be
168 * called after this command completes. Valid only with CMD_ASYNC.
172 CMD_WANT_SKB = BIT(1),
173 CMD_SEND_IN_RFKILL = BIT(2),
174 CMD_HIGH_PRIO = BIT(3),
175 CMD_SEND_IN_IDLE = BIT(4),
176 CMD_MAKE_TRANS_IDLE = BIT(5),
177 CMD_WAKE_UP_TRANS = BIT(6),
178 CMD_WANT_ASYNC_CALLBACK = BIT(7),
181 #define DEF_CMD_PAYLOAD_SIZE 320
184 * struct iwl_device_cmd
186 * For allocation of the command and tx queues, this establishes the overall
187 * size of the largest command we send to uCode, except for commands that
188 * aren't fully copied and use other TFD space.
190 struct iwl_device_cmd {
193 struct iwl_cmd_header hdr; /* uCode API */
194 u8 payload[DEF_CMD_PAYLOAD_SIZE];
197 struct iwl_cmd_header_wide hdr_wide;
198 u8 payload_wide[DEF_CMD_PAYLOAD_SIZE -
199 sizeof(struct iwl_cmd_header_wide) +
200 sizeof(struct iwl_cmd_header)];
205 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
208 * number of transfer buffers (fragments) per transmit frame descriptor;
209 * this is just the driver's idea, the hardware supports 20
211 #define IWL_MAX_CMD_TBS_PER_TFD 2
214 * enum iwl_hcmd_dataflag - flag for each one of the chunks of the command
216 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
217 * ring. The transport layer doesn't map the command's buffer to DMA, but
218 * rather copies it to a previously allocated DMA buffer. This flag tells
219 * the transport layer not to copy the command, but to map the existing
220 * buffer (that is passed in) instead. This saves the memcpy and allows
221 * commands that are bigger than the fixed buffer to be submitted.
222 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
223 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
224 * chunk internally and free it again after the command completes. This
225 * can (currently) be used only once per command.
226 * Note that a TFD entry after a DUP one cannot be a normal copied one.
228 enum iwl_hcmd_dataflag {
229 IWL_HCMD_DFL_NOCOPY = BIT(0),
230 IWL_HCMD_DFL_DUP = BIT(1),
234 * struct iwl_host_cmd - Host command to the uCode
236 * @data: array of chunks that composes the data of the host command
237 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
238 * @_rx_page_order: (internally used to free response packet)
239 * @_rx_page_addr: (internally used to free response packet)
240 * @flags: can be CMD_*
241 * @len: array of the lengths of the chunks in data
242 * @dataflags: IWL_HCMD_DFL_*
243 * @id: command id of the host command, for wide commands encoding the
244 * version and group as well
246 struct iwl_host_cmd {
247 const void *data[IWL_MAX_CMD_TBS_PER_TFD];
248 struct iwl_rx_packet *resp_pkt;
249 unsigned long _rx_page_addr;
254 u16 len[IWL_MAX_CMD_TBS_PER_TFD];
255 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
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 {
268 unsigned int truesize;
271 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
273 return (void *)((unsigned long)page_address(r->_page) + r->_offset);
276 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
281 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
283 r->_page_stolen = true;
288 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
290 __free_pages(r->_page, r->_rx_page_order);
293 #define MAX_NO_RECLAIM_CMDS 6
295 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
298 * Maximum number of HW queues the transport layer
301 #define IWL_MAX_HW_QUEUES 32
302 #define IWL_MAX_TVQM_QUEUES 512
304 #define IWL_MAX_TID_COUNT 8
305 #define IWL_MGMT_TID 15
306 #define IWL_FRAME_LIMIT 64
307 #define IWL_MAX_RX_HW_QUEUES 16
310 * enum iwl_wowlan_status - WoWLAN image/device status
311 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
312 * @IWL_D3_STATUS_RESET: device was reset while suspended
320 * enum iwl_trans_status: transport status flags
321 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
322 * @STATUS_DEVICE_ENABLED: APM is enabled
323 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
324 * @STATUS_INT_ENABLED: interrupts are enabled
325 * @STATUS_RFKILL_HW: the actual HW state of the RF-kill switch
326 * @STATUS_RFKILL_OPMODE: RF-kill state reported to opmode
327 * @STATUS_FW_ERROR: the fw is in error state
328 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
330 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
331 * @STATUS_TRANS_DEAD: trans is dead - avoid any read/write operation
333 enum iwl_trans_status {
334 STATUS_SYNC_HCMD_ACTIVE,
335 STATUS_DEVICE_ENABLED,
339 STATUS_RFKILL_OPMODE,
341 STATUS_TRANS_GOING_IDLE,
347 iwl_trans_get_rb_size_order(enum iwl_amsdu_size rb_size)
351 return get_order(4 * 1024);
353 return get_order(8 * 1024);
355 return get_order(12 * 1024);
362 struct iwl_hcmd_names {
364 const char *const cmd_name;
367 #define HCMD_NAME(x) \
368 { .cmd_id = x, .cmd_name = #x }
370 struct iwl_hcmd_arr {
371 const struct iwl_hcmd_names *arr;
375 #define HCMD_ARR(x) \
376 { .arr = x, .size = ARRAY_SIZE(x) }
379 * struct iwl_trans_config - transport configuration
381 * @op_mode: pointer to the upper layer.
382 * @cmd_queue: the index of the command queue.
383 * Must be set before start_fw.
384 * @cmd_fifo: the fifo for host commands
385 * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue.
386 * @no_reclaim_cmds: Some devices erroneously don't set the
387 * SEQ_RX_FRAME bit on some notifications, this is the
388 * list of such notifications to filter. Max length is
389 * %MAX_NO_RECLAIM_CMDS.
390 * @n_no_reclaim_cmds: # of commands in list
391 * @rx_buf_size: RX buffer size needed for A-MSDUs
392 * if unset 4k will be the RX buffer size
393 * @bc_table_dword: set to true if the BC table expects the byte count to be
394 * in DWORD (as opposed to bytes)
395 * @scd_set_active: should the transport configure the SCD for HCMD queue
396 * @sw_csum_tx: transport should compute the TCP checksum
397 * @command_groups: array of command groups, each member is an array of the
398 * commands in the group; for debugging only
399 * @command_groups_size: number of command groups, to avoid illegal access
400 * @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until
401 * we get the ALIVE from the uCode
402 * @cb_data_offs: offset inside skb->cb to store transport data at, must have
403 * space for at least two pointers
405 struct iwl_trans_config {
406 struct iwl_op_mode *op_mode;
410 unsigned int cmd_q_wdg_timeout;
411 const u8 *no_reclaim_cmds;
412 unsigned int n_no_reclaim_cmds;
414 enum iwl_amsdu_size rx_buf_size;
418 const struct iwl_hcmd_arr *command_groups;
419 int command_groups_size;
426 struct iwl_trans_dump_data {
433 struct iwl_trans_txq_scd_cfg {
442 * struct iwl_trans_ops - transport specific operations
444 * All the handlers MUST be implemented
446 * @start_hw: starts the HW. If low_power is true, the NIC needs to be taken
447 * out of a low power state. From that point on, the HW can send
448 * interrupts. May sleep.
449 * @op_mode_leave: Turn off the HW RF kill indication if on
451 * @start_fw: allocates and inits all the resources for the transport
452 * layer. Also kick a fw image.
454 * @fw_alive: called when the fw sends alive notification. If the fw provides
455 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
457 * @stop_device: stops the whole device (embedded CPU put to reset) and stops
458 * the HW. If low_power is true, the NIC will be put in low power state.
459 * From that point on, the HW will be stopped but will still issue an
460 * interrupt if the HW RF kill switch is triggered.
461 * This callback must do the right thing and not crash even if %start_hw()
462 * was called but not &start_fw(). May sleep.
463 * @d3_suspend: put the device into the correct mode for WoWLAN during
464 * suspend. This is optional, if not implemented WoWLAN will not be
465 * supported. This callback may sleep.
466 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
467 * talk to the WoWLAN image to get its status. This is optional, if not
468 * implemented WoWLAN will not be supported. This callback may sleep.
469 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
470 * If RFkill is asserted in the middle of a SYNC host command, it must
471 * return -ERFKILL straight away.
472 * May sleep only if CMD_ASYNC is not set
473 * @tx: send an skb. The transport relies on the op_mode to zero the
474 * the ieee80211_tx_info->driver_data. If the MPDU is an A-MSDU, all
475 * the CSUM will be taken care of (TCP CSUM and IP header in case of
476 * IPv4). If the MPDU is a single MSDU, the op_mode must compute the IP
477 * header if it is IPv4.
479 * @reclaim: free packet until ssn. Returns a list of freed packets.
481 * @txq_enable: setup a queue. To setup an AC queue, use the
482 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
483 * this one. The op_mode must not configure the HCMD queue. The scheduler
484 * configuration may be %NULL, in which case the hardware will not be
485 * configured. If true is returned, the operation mode needs to increment
486 * the sequence number of the packets routed to this queue because of a
487 * hardware scheduler bug. May sleep.
488 * @txq_disable: de-configure a Tx queue to send AMPDUs
490 * @txq_set_shared_mode: change Tx queue shared/unshared marking
491 * @wait_tx_queues_empty: wait until tx queues are empty. May sleep.
492 * @wait_txq_empty: wait until specific tx queue is empty. May sleep.
493 * @freeze_txq_timer: prevents the timer of the queue from firing until the
494 * queue is set to awake. Must be atomic.
495 * @block_txq_ptrs: stop updating the write pointers of the Tx queues. Note
496 * that the transport needs to refcount the calls since this function
497 * will be called several times with block = true, and then the queues
498 * need to be unblocked only after the same number of calls with
500 * @write8: write a u8 to a register at offset ofs from the BAR
501 * @write32: write a u32 to a register at offset ofs from the BAR
502 * @read32: read a u32 register at offset ofs from the BAR
503 * @read_prph: read a DWORD from a periphery register
504 * @write_prph: write a DWORD to a periphery register
505 * @read_mem: read device's SRAM in DWORD
506 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
508 * @configure: configure parameters required by the transport layer from
509 * the op_mode. May be called several times before start_fw, can't be
511 * @set_pmi: set the power pmi state
512 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
513 * Sleeping is not allowed between grab_nic_access and
514 * release_nic_access.
515 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
516 * must be the same one that was sent before to the grab_nic_access.
517 * @set_bits_mask - set SRAM register according to value and mask.
518 * @ref: grab a reference to the transport/FW layers, disallowing
519 * certain low power states
520 * @unref: release a reference previously taken with @ref. Note that
521 * initially the reference count is 1, making an initial @unref
522 * necessary to allow low power states.
523 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last
524 * TX'ed commands and similar. The buffer will be vfree'd by the caller.
525 * Note that the transport must fill in the proper file headers.
527 struct iwl_trans_ops {
529 int (*start_hw)(struct iwl_trans *iwl_trans, bool low_power);
530 void (*op_mode_leave)(struct iwl_trans *iwl_trans);
531 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
533 int (*update_sf)(struct iwl_trans *trans,
534 struct iwl_sf_region *st_fwrd_space);
535 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
536 void (*stop_device)(struct iwl_trans *trans, bool low_power);
538 void (*d3_suspend)(struct iwl_trans *trans, bool test, bool reset);
539 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status,
540 bool test, bool reset);
542 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
544 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
545 struct iwl_device_cmd *dev_cmd, int queue);
546 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
547 struct sk_buff_head *skbs);
549 bool (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn,
550 const struct iwl_trans_txq_scd_cfg *cfg,
551 unsigned int queue_wdg_timeout);
552 void (*txq_disable)(struct iwl_trans *trans, int queue,
555 int (*txq_alloc)(struct iwl_trans *trans,
556 struct iwl_tx_queue_cfg_cmd *cmd,
558 unsigned int queue_wdg_timeout);
559 void (*txq_free)(struct iwl_trans *trans, int queue);
561 void (*txq_set_shared_mode)(struct iwl_trans *trans, u32 txq_id,
564 int (*wait_tx_queues_empty)(struct iwl_trans *trans, u32 txq_bm);
565 int (*wait_txq_empty)(struct iwl_trans *trans, int queue);
566 void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs,
568 void (*block_txq_ptrs)(struct iwl_trans *trans, bool block);
570 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
571 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
572 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
573 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
574 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
575 int (*read_mem)(struct iwl_trans *trans, u32 addr,
576 void *buf, int dwords);
577 int (*write_mem)(struct iwl_trans *trans, u32 addr,
578 const void *buf, int dwords);
579 void (*configure)(struct iwl_trans *trans,
580 const struct iwl_trans_config *trans_cfg);
581 void (*set_pmi)(struct iwl_trans *trans, bool state);
582 bool (*grab_nic_access)(struct iwl_trans *trans, unsigned long *flags);
583 void (*release_nic_access)(struct iwl_trans *trans,
584 unsigned long *flags);
585 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
587 void (*ref)(struct iwl_trans *trans);
588 void (*unref)(struct iwl_trans *trans);
589 int (*suspend)(struct iwl_trans *trans);
590 void (*resume)(struct iwl_trans *trans);
592 struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans,
593 const struct iwl_fw_dbg_trigger_tlv
598 * enum iwl_trans_state - state of the transport layer
600 * @IWL_TRANS_NO_FW: no fw has sent an alive response
601 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
603 enum iwl_trans_state {
605 IWL_TRANS_FW_ALIVE = 1,
609 * DOC: Platform power management
611 * There are two types of platform power management: system-wide
612 * (WoWLAN) and runtime.
614 * In system-wide power management the entire platform goes into a low
615 * power state (e.g. idle or suspend to RAM) at the same time and the
616 * device is configured as a wakeup source for the entire platform.
617 * This is usually triggered by userspace activity (e.g. the user
618 * presses the suspend button or a power management daemon decides to
619 * put the platform in low power mode). The device's behavior in this
620 * mode is dictated by the wake-on-WLAN configuration.
622 * In runtime power management, only the devices which are themselves
623 * idle enter a low power state. This is done at runtime, which means
624 * that the entire system is still running normally. This mode is
625 * usually triggered automatically by the device driver and requires
626 * the ability to enter and exit the low power modes in a very short
627 * time, so there is not much impact in usability.
629 * The terms used for the device's behavior are as follows:
631 * - D0: the device is fully powered and the host is awake;
632 * - D3: the device is in low power mode and only reacts to
633 * specific events (e.g. magic-packet received or scan
635 * - D0I3: the device is in low power mode and reacts to any
636 * activity (e.g. RX);
638 * These terms reflect the power modes in the firmware and are not to
639 * be confused with the physical device power state. The NIC can be
640 * in D0I3 mode even if, for instance, the PCI device is in D3 state.
644 * enum iwl_plat_pm_mode - platform power management mode
646 * This enumeration describes the device's platform power management
647 * behavior when in idle mode (i.e. runtime power management) or when
648 * in system-wide suspend (i.e WoWLAN).
650 * @IWL_PLAT_PM_MODE_DISABLED: power management is disabled for this
651 * device. At runtime, this means that nothing happens and the
652 * device always remains in active. In system-wide suspend mode,
653 * it means that the all connections will be closed automatically
654 * by mac80211 before the platform is suspended.
655 * @IWL_PLAT_PM_MODE_D3: the device goes into D3 mode (i.e. WoWLAN).
656 * For runtime power management, this mode is not officially
658 * @IWL_PLAT_PM_MODE_D0I3: the device goes into D0I3 mode.
660 enum iwl_plat_pm_mode {
661 IWL_PLAT_PM_MODE_DISABLED,
663 IWL_PLAT_PM_MODE_D0I3,
666 /* Max time to wait for trans to become idle/non-idle on d0i3
667 * enter/exit (in msecs).
669 #define IWL_TRANS_IDLE_TIMEOUT 2000
672 * struct iwl_trans - transport common data
674 * @ops - pointer to iwl_trans_ops
675 * @op_mode - pointer to the op_mode
676 * @cfg - pointer to the configuration
677 * @drv - pointer to iwl_drv
678 * @status: a bit-mask of transport status flags
679 * @dev - pointer to struct device * that represents the device
680 * @max_skb_frags: maximum number of fragments an SKB can have when transmitted.
681 * 0 indicates that frag SKBs (NETIF_F_SG) aren't supported.
682 * @hw_rf_id a u32 with the device RF ID
683 * @hw_id: a u32 with the ID of the device / sub-device.
684 * Set during transport allocation.
685 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
686 * @pm_support: set to true in start_hw if link pm is supported
687 * @ltr_enabled: set to true if the LTR is enabled
688 * @wide_cmd_header: true when ucode supports wide command header format
689 * @num_rx_queues: number of RX queues allocated by the transport;
690 * the transport must set this before calling iwl_drv_start()
691 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
692 * The user should use iwl_trans_{alloc,free}_tx_cmd.
693 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
694 * starting the firmware, used for tracing
695 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
696 * start of the 802.11 header in the @rx_mpdu_cmd
697 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
698 * @dbg_dest_tlv: points to the destination TLV for debug
699 * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
700 * @dbg_trigger_tlv: array of pointers to triggers TLVs for debug
701 * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
702 * @paging_req_addr: The location were the FW will upload / download the pages
703 * from. The address is set by the opmode
704 * @paging_db: Pointer to the opmode paging data base, the pointer is set by
706 * @paging_download_buf: Buffer used for copying all of the pages before
707 * downloading them to the FW. The buffer is allocated in the opmode
708 * @system_pm_mode: the system-wide power management mode in use.
709 * This mode is set dynamically, depending on the WoWLAN values
710 * configured from the userspace at runtime.
711 * @runtime_pm_mode: the runtime power management mode in use. This
712 * mode is set during the initialization phase and is not
713 * supposed to change during runtime.
716 const struct iwl_trans_ops *ops;
717 struct iwl_op_mode *op_mode;
718 const struct iwl_cfg *cfg;
720 enum iwl_trans_state state;
721 unsigned long status;
730 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
735 const struct iwl_hcmd_arr *command_groups;
736 int command_groups_size;
737 bool wide_cmd_header;
741 /* The following fields are internal only */
742 struct kmem_cache *dev_cmd_pool;
743 char dev_cmd_pool_name[50];
745 struct dentry *dbgfs_dir;
747 #ifdef CONFIG_LOCKDEP
748 struct lockdep_map sync_cmd_lockdep_map;
753 const struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
754 const struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
755 struct iwl_fw_dbg_trigger_tlv * const *dbg_trigger_tlv;
759 * Paging parameters - All of the parameters should be set by the
760 * opmode when paging is enabled
763 struct iwl_fw_paging *paging_db;
764 void *paging_download_buf;
766 enum iwl_plat_pm_mode system_pm_mode;
767 enum iwl_plat_pm_mode runtime_pm_mode;
770 /* pointer to trans specific struct */
771 /*Ensure that this pointer will always be aligned to sizeof pointer */
772 char trans_specific[0] __aligned(sizeof(void *));
775 const char *iwl_get_cmd_string(struct iwl_trans *trans, u32 id);
776 int iwl_cmd_groups_verify_sorted(const struct iwl_trans_config *trans);
778 static inline void iwl_trans_configure(struct iwl_trans *trans,
779 const struct iwl_trans_config *trans_cfg)
781 trans->op_mode = trans_cfg->op_mode;
783 trans->ops->configure(trans, trans_cfg);
784 WARN_ON(iwl_cmd_groups_verify_sorted(trans_cfg));
787 static inline int _iwl_trans_start_hw(struct iwl_trans *trans, bool low_power)
791 return trans->ops->start_hw(trans, low_power);
794 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
796 return trans->ops->start_hw(trans, true);
799 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans)
803 if (trans->ops->op_mode_leave)
804 trans->ops->op_mode_leave(trans);
806 trans->op_mode = NULL;
808 trans->state = IWL_TRANS_NO_FW;
811 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
815 trans->state = IWL_TRANS_FW_ALIVE;
817 trans->ops->fw_alive(trans, scd_addr);
820 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
821 const struct fw_img *fw,
826 WARN_ON_ONCE(!trans->rx_mpdu_cmd);
828 clear_bit(STATUS_FW_ERROR, &trans->status);
829 return trans->ops->start_fw(trans, fw, run_in_rfkill);
832 static inline int iwl_trans_update_sf(struct iwl_trans *trans,
833 struct iwl_sf_region *st_fwrd_space)
837 if (trans->ops->update_sf)
838 return trans->ops->update_sf(trans, st_fwrd_space);
843 static inline void _iwl_trans_stop_device(struct iwl_trans *trans,
848 trans->ops->stop_device(trans, low_power);
850 trans->state = IWL_TRANS_NO_FW;
853 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
855 _iwl_trans_stop_device(trans, true);
858 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test,
862 if (trans->ops->d3_suspend)
863 trans->ops->d3_suspend(trans, test, reset);
866 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
867 enum iwl_d3_status *status,
868 bool test, bool reset)
871 if (!trans->ops->d3_resume)
874 return trans->ops->d3_resume(trans, status, test, reset);
877 static inline void iwl_trans_ref(struct iwl_trans *trans)
880 trans->ops->ref(trans);
883 static inline void iwl_trans_unref(struct iwl_trans *trans)
885 if (trans->ops->unref)
886 trans->ops->unref(trans);
889 static inline int iwl_trans_suspend(struct iwl_trans *trans)
891 if (!trans->ops->suspend)
894 return trans->ops->suspend(trans);
897 static inline void iwl_trans_resume(struct iwl_trans *trans)
899 if (trans->ops->resume)
900 trans->ops->resume(trans);
903 static inline struct iwl_trans_dump_data *
904 iwl_trans_dump_data(struct iwl_trans *trans,
905 const struct iwl_fw_dbg_trigger_tlv *trigger)
907 if (!trans->ops->dump_data)
909 return trans->ops->dump_data(trans, trigger);
912 static inline struct iwl_device_cmd *
913 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
915 return kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
918 int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
920 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
921 struct iwl_device_cmd *dev_cmd)
923 kmem_cache_free(trans->dev_cmd_pool, dev_cmd);
926 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
927 struct iwl_device_cmd *dev_cmd, int queue)
929 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
932 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
933 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
937 return trans->ops->tx(trans, skb, dev_cmd, queue);
940 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
941 int ssn, struct sk_buff_head *skbs)
943 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
944 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
948 trans->ops->reclaim(trans, queue, ssn, skbs);
951 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue,
954 trans->ops->txq_disable(trans, queue, configure_scd);
958 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn,
959 const struct iwl_trans_txq_scd_cfg *cfg,
960 unsigned int queue_wdg_timeout)
964 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
965 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
969 return trans->ops->txq_enable(trans, queue, ssn,
970 cfg, queue_wdg_timeout);
974 iwl_trans_txq_free(struct iwl_trans *trans, int queue)
976 if (WARN_ON_ONCE(!trans->ops->txq_free))
979 trans->ops->txq_free(trans, queue);
983 iwl_trans_txq_alloc(struct iwl_trans *trans,
984 struct iwl_tx_queue_cfg_cmd *cmd,
986 unsigned int queue_wdg_timeout)
990 if (WARN_ON_ONCE(!trans->ops->txq_alloc))
993 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
994 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
998 return trans->ops->txq_alloc(trans, cmd, cmd_id, queue_wdg_timeout);
1001 static inline void iwl_trans_txq_set_shared_mode(struct iwl_trans *trans,
1002 int queue, bool shared_mode)
1004 if (trans->ops->txq_set_shared_mode)
1005 trans->ops->txq_set_shared_mode(trans, queue, shared_mode);
1008 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
1009 int fifo, int sta_id, int tid,
1010 int frame_limit, u16 ssn,
1011 unsigned int queue_wdg_timeout)
1013 struct iwl_trans_txq_scd_cfg cfg = {
1017 .frame_limit = frame_limit,
1018 .aggregate = sta_id >= 0,
1021 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout);
1025 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo,
1026 unsigned int queue_wdg_timeout)
1028 struct iwl_trans_txq_scd_cfg cfg = {
1031 .tid = IWL_MAX_TID_COUNT,
1032 .frame_limit = IWL_FRAME_LIMIT,
1036 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout);
1039 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans,
1043 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1044 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1048 if (trans->ops->freeze_txq_timer)
1049 trans->ops->freeze_txq_timer(trans, txqs, freeze);
1052 static inline void iwl_trans_block_txq_ptrs(struct iwl_trans *trans,
1055 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1056 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1060 if (trans->ops->block_txq_ptrs)
1061 trans->ops->block_txq_ptrs(trans, block);
1064 static inline int iwl_trans_wait_tx_queues_empty(struct iwl_trans *trans,
1067 if (WARN_ON_ONCE(!trans->ops->wait_tx_queues_empty))
1070 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1071 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1075 return trans->ops->wait_tx_queues_empty(trans, txqs);
1078 static inline int iwl_trans_wait_txq_empty(struct iwl_trans *trans, int queue)
1080 if (WARN_ON_ONCE(!trans->ops->wait_txq_empty))
1083 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1084 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1088 return trans->ops->wait_txq_empty(trans, queue);
1091 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
1093 trans->ops->write8(trans, ofs, val);
1096 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
1098 trans->ops->write32(trans, ofs, val);
1101 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
1103 return trans->ops->read32(trans, ofs);
1106 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
1108 return trans->ops->read_prph(trans, ofs);
1111 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
1114 return trans->ops->write_prph(trans, ofs, val);
1117 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
1118 void *buf, int dwords)
1120 return trans->ops->read_mem(trans, addr, buf, dwords);
1123 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
1125 if (__builtin_constant_p(bufsize)) \
1126 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
1127 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
1130 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
1134 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
1140 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
1141 const void *buf, int dwords)
1143 return trans->ops->write_mem(trans, addr, buf, dwords);
1146 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
1149 return iwl_trans_write_mem(trans, addr, &val, 1);
1152 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
1154 if (trans->ops->set_pmi)
1155 trans->ops->set_pmi(trans, state);
1159 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
1161 trans->ops->set_bits_mask(trans, reg, mask, value);
1164 #define iwl_trans_grab_nic_access(trans, flags) \
1165 __cond_lock(nic_access, \
1166 likely((trans)->ops->grab_nic_access(trans, flags)))
1168 static inline void __releases(nic_access)
1169 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
1171 trans->ops->release_nic_access(trans, flags);
1172 __release(nic_access);
1175 static inline void iwl_trans_fw_error(struct iwl_trans *trans)
1177 if (WARN_ON_ONCE(!trans->op_mode))
1180 /* prevent double restarts due to the same erroneous FW */
1181 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status))
1182 iwl_op_mode_nic_error(trans->op_mode);
1185 /*****************************************************
1186 * transport helper functions
1187 *****************************************************/
1188 struct iwl_trans *iwl_trans_alloc(unsigned int priv_size,
1190 const struct iwl_cfg *cfg,
1191 const struct iwl_trans_ops *ops);
1192 void iwl_trans_free(struct iwl_trans *trans);
1194 /*****************************************************
1195 * driver (transport) register/unregister functions
1196 ******************************************************/
1197 int __must_check iwl_pci_register_driver(void);
1198 void iwl_pci_unregister_driver(void);
1200 #endif /* __iwl_trans_h__ */