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
11 * Copyright(c) 2018 - 2019 Intel Corporation
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of version 2 of the GNU General Public License as
15 * published by the Free Software Foundation.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * The full GNU General Public License is included in this distribution
23 * in the file called COPYING.
25 * Contact Information:
26 * Intel Linux Wireless <linuxwifi@intel.com>
27 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
31 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
32 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
33 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
34 * Copyright(c) 2018 - 2019 Intel Corporation
35 * All rights reserved.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in
45 * the documentation and/or other materials provided with the
47 * * Neither the name Intel Corporation nor the names of its
48 * contributors may be used to endorse or promote products derived
49 * from this software without specific prior written permission.
51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63 *****************************************************************************/
64 #ifndef __iwl_trans_h__
65 #define __iwl_trans_h__
67 #include <linux/ieee80211.h>
68 #include <linux/mm.h> /* for page_address */
69 #include <linux/lockdep.h>
70 #include <linux/kernel.h>
72 #include "iwl-debug.h"
73 #include "iwl-config.h"
75 #include "iwl-op-mode.h"
76 #include "fw/api/cmdhdr.h"
77 #include "fw/api/txq.h"
78 #include "fw/api/dbg-tlv.h"
79 #include "iwl-dbg-tlv.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_RADA_EN BIT(26)
120 #define FH_RSCSR_RXQ_POS 16
121 #define FH_RSCSR_RXQ_MASK 0x3F0000
123 struct iwl_rx_packet {
125 * The first 4 bytes of the RX frame header contain both the RX frame
126 * size and some flags.
128 * 31: flag flush RB request
129 * 30: flag ignore TC (terminal counter) request
130 * 29: flag fast IRQ request
133 * 25: Offload enabled
136 * 22: Checksum enabled
139 * 13-00: RX frame size
142 struct iwl_cmd_header hdr;
146 static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt)
148 return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
151 static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt)
153 return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr);
157 * enum CMD_MODE - how to send the host commands ?
159 * @CMD_ASYNC: Return right away and don't wait for the response
160 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of
161 * the response. The caller needs to call iwl_free_resp when done.
162 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
163 * command queue, but after other high priority commands. Valid only
165 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
166 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
167 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
168 * (i.e. mark it as non-idle).
169 * @CMD_WANT_ASYNC_CALLBACK: the op_mode's async callback function must be
170 * called after this command completes. Valid only with CMD_ASYNC.
174 CMD_WANT_SKB = BIT(1),
175 CMD_SEND_IN_RFKILL = BIT(2),
176 CMD_HIGH_PRIO = BIT(3),
177 CMD_SEND_IN_IDLE = BIT(4),
178 CMD_MAKE_TRANS_IDLE = BIT(5),
179 CMD_WAKE_UP_TRANS = BIT(6),
180 CMD_WANT_ASYNC_CALLBACK = BIT(7),
183 #define DEF_CMD_PAYLOAD_SIZE 320
186 * struct iwl_device_cmd
188 * For allocation of the command and tx queues, this establishes the overall
189 * size of the largest command we send to uCode, except for commands that
190 * aren't fully copied and use other TFD space.
192 struct iwl_device_cmd {
195 struct iwl_cmd_header hdr; /* uCode API */
196 u8 payload[DEF_CMD_PAYLOAD_SIZE];
199 struct iwl_cmd_header_wide hdr_wide;
200 u8 payload_wide[DEF_CMD_PAYLOAD_SIZE -
201 sizeof(struct iwl_cmd_header_wide) +
202 sizeof(struct iwl_cmd_header)];
207 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
210 * number of transfer buffers (fragments) per transmit frame descriptor;
211 * this is just the driver's idea, the hardware supports 20
213 #define IWL_MAX_CMD_TBS_PER_TFD 2
216 * enum iwl_hcmd_dataflag - flag for each one of the chunks of the command
218 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
219 * ring. The transport layer doesn't map the command's buffer to DMA, but
220 * rather copies it to a previously allocated DMA buffer. This flag tells
221 * the transport layer not to copy the command, but to map the existing
222 * buffer (that is passed in) instead. This saves the memcpy and allows
223 * commands that are bigger than the fixed buffer to be submitted.
224 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
225 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
226 * chunk internally and free it again after the command completes. This
227 * can (currently) be used only once per command.
228 * Note that a TFD entry after a DUP one cannot be a normal copied one.
230 enum iwl_hcmd_dataflag {
231 IWL_HCMD_DFL_NOCOPY = BIT(0),
232 IWL_HCMD_DFL_DUP = BIT(1),
235 enum iwl_error_event_table_status {
236 IWL_ERROR_EVENT_TABLE_LMAC1 = BIT(0),
237 IWL_ERROR_EVENT_TABLE_LMAC2 = BIT(1),
238 IWL_ERROR_EVENT_TABLE_UMAC = BIT(2),
242 * struct iwl_host_cmd - Host command to the uCode
244 * @data: array of chunks that composes the data of the host command
245 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
246 * @_rx_page_order: (internally used to free response packet)
247 * @_rx_page_addr: (internally used to free response packet)
248 * @flags: can be CMD_*
249 * @len: array of the lengths of the chunks in data
250 * @dataflags: IWL_HCMD_DFL_*
251 * @id: command id of the host command, for wide commands encoding the
252 * version and group as well
254 struct iwl_host_cmd {
255 const void *data[IWL_MAX_CMD_TBS_PER_TFD];
256 struct iwl_rx_packet *resp_pkt;
257 unsigned long _rx_page_addr;
262 u16 len[IWL_MAX_CMD_TBS_PER_TFD];
263 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
266 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
268 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
271 struct iwl_rx_cmd_buffer {
276 unsigned int truesize;
279 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
281 return (void *)((unsigned long)page_address(r->_page) + r->_offset);
284 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
289 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
291 r->_page_stolen = true;
296 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
298 __free_pages(r->_page, r->_rx_page_order);
301 #define MAX_NO_RECLAIM_CMDS 6
303 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
306 * Maximum number of HW queues the transport layer
309 #define IWL_MAX_HW_QUEUES 32
310 #define IWL_MAX_TVQM_QUEUES 512
312 #define IWL_MAX_TID_COUNT 8
313 #define IWL_MGMT_TID 15
314 #define IWL_FRAME_LIMIT 64
315 #define IWL_MAX_RX_HW_QUEUES 16
318 * enum iwl_wowlan_status - WoWLAN image/device status
319 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
320 * @IWL_D3_STATUS_RESET: device was reset while suspended
328 * enum iwl_trans_status: transport status flags
329 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
330 * @STATUS_DEVICE_ENABLED: APM is enabled
331 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
332 * @STATUS_INT_ENABLED: interrupts are enabled
333 * @STATUS_RFKILL_HW: the actual HW state of the RF-kill switch
334 * @STATUS_RFKILL_OPMODE: RF-kill state reported to opmode
335 * @STATUS_FW_ERROR: the fw is in error state
336 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
338 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
339 * @STATUS_TRANS_DEAD: trans is dead - avoid any read/write operation
340 * @STATUS_FW_WAIT_DUMP: if set, wait until cleared before collecting dump
342 enum iwl_trans_status {
343 STATUS_SYNC_HCMD_ACTIVE,
344 STATUS_DEVICE_ENABLED,
348 STATUS_RFKILL_OPMODE,
350 STATUS_TRANS_GOING_IDLE,
357 iwl_trans_get_rb_size_order(enum iwl_amsdu_size rb_size)
361 return get_order(2 * 1024);
363 return get_order(4 * 1024);
365 return get_order(8 * 1024);
367 return get_order(12 * 1024);
374 struct iwl_hcmd_names {
376 const char *const cmd_name;
379 #define HCMD_NAME(x) \
380 { .cmd_id = x, .cmd_name = #x }
382 struct iwl_hcmd_arr {
383 const struct iwl_hcmd_names *arr;
387 #define HCMD_ARR(x) \
388 { .arr = x, .size = ARRAY_SIZE(x) }
391 * struct iwl_trans_config - transport configuration
393 * @op_mode: pointer to the upper layer.
394 * @cmd_queue: the index of the command queue.
395 * Must be set before start_fw.
396 * @cmd_fifo: the fifo for host commands
397 * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue.
398 * @no_reclaim_cmds: Some devices erroneously don't set the
399 * SEQ_RX_FRAME bit on some notifications, this is the
400 * list of such notifications to filter. Max length is
401 * %MAX_NO_RECLAIM_CMDS.
402 * @n_no_reclaim_cmds: # of commands in list
403 * @rx_buf_size: RX buffer size needed for A-MSDUs
404 * if unset 4k will be the RX buffer size
405 * @bc_table_dword: set to true if the BC table expects the byte count to be
406 * in DWORD (as opposed to bytes)
407 * @scd_set_active: should the transport configure the SCD for HCMD queue
408 * @sw_csum_tx: transport should compute the TCP checksum
409 * @command_groups: array of command groups, each member is an array of the
410 * commands in the group; for debugging only
411 * @command_groups_size: number of command groups, to avoid illegal access
412 * @cb_data_offs: offset inside skb->cb to store transport data at, must have
413 * space for at least two pointers
415 struct iwl_trans_config {
416 struct iwl_op_mode *op_mode;
420 unsigned int cmd_q_wdg_timeout;
421 const u8 *no_reclaim_cmds;
422 unsigned int n_no_reclaim_cmds;
424 enum iwl_amsdu_size rx_buf_size;
428 const struct iwl_hcmd_arr *command_groups;
429 int command_groups_size;
434 struct iwl_trans_dump_data {
441 struct iwl_trans_txq_scd_cfg {
450 * struct iwl_trans_rxq_dma_data - RX queue DMA data
451 * @fr_bd_cb: DMA address of free BD cyclic buffer
452 * @fr_bd_wid: Initial write index of the free BD cyclic buffer
453 * @urbd_stts_wrptr: DMA address of urbd_stts_wrptr
454 * @ur_bd_cb: DMA address of used BD cyclic buffer
456 struct iwl_trans_rxq_dma_data {
464 * struct iwl_trans_ops - transport specific operations
466 * All the handlers MUST be implemented
468 * @start_hw: starts the HW. If low_power is true, the NIC needs to be taken
469 * out of a low power state. From that point on, the HW can send
470 * interrupts. May sleep.
471 * @op_mode_leave: Turn off the HW RF kill indication if on
473 * @start_fw: allocates and inits all the resources for the transport
474 * layer. Also kick a fw image.
476 * @fw_alive: called when the fw sends alive notification. If the fw provides
477 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
479 * @stop_device: stops the whole device (embedded CPU put to reset) and stops
480 * the HW. If low_power is true, the NIC will be put in low power state.
481 * From that point on, the HW will be stopped but will still issue an
482 * interrupt if the HW RF kill switch is triggered.
483 * This callback must do the right thing and not crash even if %start_hw()
484 * was called but not &start_fw(). May sleep.
485 * @d3_suspend: put the device into the correct mode for WoWLAN during
486 * suspend. This is optional, if not implemented WoWLAN will not be
487 * supported. This callback may sleep.
488 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
489 * talk to the WoWLAN image to get its status. This is optional, if not
490 * implemented WoWLAN will not be supported. This callback may sleep.
491 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
492 * If RFkill is asserted in the middle of a SYNC host command, it must
493 * return -ERFKILL straight away.
494 * May sleep only if CMD_ASYNC is not set
495 * @tx: send an skb. The transport relies on the op_mode to zero the
496 * the ieee80211_tx_info->driver_data. If the MPDU is an A-MSDU, all
497 * the CSUM will be taken care of (TCP CSUM and IP header in case of
498 * IPv4). If the MPDU is a single MSDU, the op_mode must compute the IP
499 * header if it is IPv4.
501 * @reclaim: free packet until ssn. Returns a list of freed packets.
503 * @txq_enable: setup a queue. To setup an AC queue, use the
504 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
505 * this one. The op_mode must not configure the HCMD queue. The scheduler
506 * configuration may be %NULL, in which case the hardware will not be
507 * configured. If true is returned, the operation mode needs to increment
508 * the sequence number of the packets routed to this queue because of a
509 * hardware scheduler bug. May sleep.
510 * @txq_disable: de-configure a Tx queue to send AMPDUs
512 * @txq_set_shared_mode: change Tx queue shared/unshared marking
513 * @wait_tx_queues_empty: wait until tx queues are empty. May sleep.
514 * @wait_txq_empty: wait until specific tx queue is empty. May sleep.
515 * @freeze_txq_timer: prevents the timer of the queue from firing until the
516 * queue is set to awake. Must be atomic.
517 * @block_txq_ptrs: stop updating the write pointers of the Tx queues. Note
518 * that the transport needs to refcount the calls since this function
519 * will be called several times with block = true, and then the queues
520 * need to be unblocked only after the same number of calls with
522 * @write8: write a u8 to a register at offset ofs from the BAR
523 * @write32: write a u32 to a register at offset ofs from the BAR
524 * @read32: read a u32 register at offset ofs from the BAR
525 * @read_prph: read a DWORD from a periphery register
526 * @write_prph: write a DWORD to a periphery register
527 * @read_mem: read device's SRAM in DWORD
528 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
530 * @configure: configure parameters required by the transport layer from
531 * the op_mode. May be called several times before start_fw, can't be
533 * @set_pmi: set the power pmi state
534 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
535 * Sleeping is not allowed between grab_nic_access and
536 * release_nic_access.
537 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
538 * must be the same one that was sent before to the grab_nic_access.
539 * @set_bits_mask - set SRAM register according to value and mask.
540 * @ref: grab a reference to the transport/FW layers, disallowing
541 * certain low power states
542 * @unref: release a reference previously taken with @ref. Note that
543 * initially the reference count is 1, making an initial @unref
544 * necessary to allow low power states.
545 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last
546 * TX'ed commands and similar. The buffer will be vfree'd by the caller.
547 * Note that the transport must fill in the proper file headers.
548 * @debugfs_cleanup: used in the driver unload flow to make a proper cleanup
549 * of the trans debugfs
551 struct iwl_trans_ops {
553 int (*start_hw)(struct iwl_trans *iwl_trans, bool low_power);
554 void (*op_mode_leave)(struct iwl_trans *iwl_trans);
555 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
557 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
558 void (*stop_device)(struct iwl_trans *trans, bool low_power);
560 void (*d3_suspend)(struct iwl_trans *trans, bool test, bool reset);
561 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status,
562 bool test, bool reset);
564 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
566 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
567 struct iwl_device_cmd *dev_cmd, int queue);
568 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
569 struct sk_buff_head *skbs);
571 bool (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn,
572 const struct iwl_trans_txq_scd_cfg *cfg,
573 unsigned int queue_wdg_timeout);
574 void (*txq_disable)(struct iwl_trans *trans, int queue,
576 /* 22000 functions */
577 int (*txq_alloc)(struct iwl_trans *trans,
578 __le16 flags, u8 sta_id, u8 tid,
579 int cmd_id, int size,
580 unsigned int queue_wdg_timeout);
581 void (*txq_free)(struct iwl_trans *trans, int queue);
582 int (*rxq_dma_data)(struct iwl_trans *trans, int queue,
583 struct iwl_trans_rxq_dma_data *data);
585 void (*txq_set_shared_mode)(struct iwl_trans *trans, u32 txq_id,
588 int (*wait_tx_queues_empty)(struct iwl_trans *trans, u32 txq_bm);
589 int (*wait_txq_empty)(struct iwl_trans *trans, int queue);
590 void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs,
592 void (*block_txq_ptrs)(struct iwl_trans *trans, bool block);
594 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
595 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
596 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
597 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
598 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
599 int (*read_mem)(struct iwl_trans *trans, u32 addr,
600 void *buf, int dwords);
601 int (*write_mem)(struct iwl_trans *trans, u32 addr,
602 const void *buf, int dwords);
603 void (*configure)(struct iwl_trans *trans,
604 const struct iwl_trans_config *trans_cfg);
605 void (*set_pmi)(struct iwl_trans *trans, bool state);
606 void (*sw_reset)(struct iwl_trans *trans);
607 bool (*grab_nic_access)(struct iwl_trans *trans, unsigned long *flags);
608 void (*release_nic_access)(struct iwl_trans *trans,
609 unsigned long *flags);
610 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
612 void (*ref)(struct iwl_trans *trans);
613 void (*unref)(struct iwl_trans *trans);
614 int (*suspend)(struct iwl_trans *trans);
615 void (*resume)(struct iwl_trans *trans);
617 struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans,
619 void (*debugfs_cleanup)(struct iwl_trans *trans);
623 * enum iwl_trans_state - state of the transport layer
625 * @IWL_TRANS_NO_FW: no fw has sent an alive response
626 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
628 enum iwl_trans_state {
630 IWL_TRANS_FW_ALIVE = 1,
634 * DOC: Platform power management
636 * There are two types of platform power management: system-wide
637 * (WoWLAN) and runtime.
639 * In system-wide power management the entire platform goes into a low
640 * power state (e.g. idle or suspend to RAM) at the same time and the
641 * device is configured as a wakeup source for the entire platform.
642 * This is usually triggered by userspace activity (e.g. the user
643 * presses the suspend button or a power management daemon decides to
644 * put the platform in low power mode). The device's behavior in this
645 * mode is dictated by the wake-on-WLAN configuration.
647 * In runtime power management, only the devices which are themselves
648 * idle enter a low power state. This is done at runtime, which means
649 * that the entire system is still running normally. This mode is
650 * usually triggered automatically by the device driver and requires
651 * the ability to enter and exit the low power modes in a very short
652 * time, so there is not much impact in usability.
654 * The terms used for the device's behavior are as follows:
656 * - D0: the device is fully powered and the host is awake;
657 * - D3: the device is in low power mode and only reacts to
658 * specific events (e.g. magic-packet received or scan
660 * - D0I3: the device is in low power mode and reacts to any
661 * activity (e.g. RX);
663 * These terms reflect the power modes in the firmware and are not to
664 * be confused with the physical device power state. The NIC can be
665 * in D0I3 mode even if, for instance, the PCI device is in D3 state.
669 * enum iwl_plat_pm_mode - platform power management mode
671 * This enumeration describes the device's platform power management
672 * behavior when in idle mode (i.e. runtime power management) or when
673 * in system-wide suspend (i.e WoWLAN).
675 * @IWL_PLAT_PM_MODE_DISABLED: power management is disabled for this
676 * device. At runtime, this means that nothing happens and the
677 * device always remains in active. In system-wide suspend mode,
678 * it means that the all connections will be closed automatically
679 * by mac80211 before the platform is suspended.
680 * @IWL_PLAT_PM_MODE_D3: the device goes into D3 mode (i.e. WoWLAN).
681 * For runtime power management, this mode is not officially
683 * @IWL_PLAT_PM_MODE_D0I3: the device goes into D0I3 mode.
685 enum iwl_plat_pm_mode {
686 IWL_PLAT_PM_MODE_DISABLED,
688 IWL_PLAT_PM_MODE_D0I3,
691 /* Max time to wait for trans to become idle/non-idle on d0i3
692 * enter/exit (in msecs).
694 #define IWL_TRANS_IDLE_TIMEOUT 2000
696 /* Max time to wait for nmi interrupt */
697 #define IWL_TRANS_NMI_TIMEOUT (HZ / 4)
700 * struct iwl_dram_data
701 * @physical: page phy pointer
702 * @block: pointer to the allocated block/page
703 * @size: size of the block/page
705 struct iwl_dram_data {
712 * struct iwl_self_init_dram - dram data used by self init process
713 * @fw: lmac and umac dram data
714 * @fw_cnt: total number of items in array
715 * @paging: paging dram data
716 * @paging_cnt: total number of items in array
718 struct iwl_self_init_dram {
719 struct iwl_dram_data *fw;
721 struct iwl_dram_data *paging;
726 * struct iwl_trans - transport common data
728 * @ops - pointer to iwl_trans_ops
729 * @op_mode - pointer to the op_mode
730 * @cfg - pointer to the configuration
731 * @drv - pointer to iwl_drv
732 * @status: a bit-mask of transport status flags
733 * @dev - pointer to struct device * that represents the device
734 * @max_skb_frags: maximum number of fragments an SKB can have when transmitted.
735 * 0 indicates that frag SKBs (NETIF_F_SG) aren't supported.
736 * @hw_rf_id a u32 with the device RF ID
737 * @hw_id: a u32 with the ID of the device / sub-device.
738 * Set during transport allocation.
739 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
740 * @pm_support: set to true in start_hw if link pm is supported
741 * @ltr_enabled: set to true if the LTR is enabled
742 * @wide_cmd_header: true when ucode supports wide command header format
743 * @num_rx_queues: number of RX queues allocated by the transport;
744 * the transport must set this before calling iwl_drv_start()
745 * @iml_len: the length of the image loader
746 * @iml: a pointer to the image loader itself
747 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
748 * The user should use iwl_trans_{alloc,free}_tx_cmd.
749 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
750 * starting the firmware, used for tracing
751 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
752 * start of the 802.11 header in the @rx_mpdu_cmd
753 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
754 * @dbg_dest_tlv: points to the destination TLV for debug
755 * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
756 * @dbg_trigger_tlv: array of pointers to triggers TLVs for debug
757 * @dbg_n_dest_reg: num of reg_ops in %dbg_dest_tlv
758 * @num_blocks: number of blocks in fw_mon
759 * @fw_mon: address of the buffers for firmware monitor
760 * @system_pm_mode: the system-wide power management mode in use.
761 * This mode is set dynamically, depending on the WoWLAN values
762 * configured from the userspace at runtime.
763 * @runtime_pm_mode: the runtime power management mode in use. This
764 * mode is set during the initialization phase and is not
765 * supposed to change during runtime.
766 * @dbg_rec_on: true iff there is a fw debug recording currently active
767 * @lmac_error_event_table: addrs of lmacs error tables
768 * @umac_error_event_table: addr of umac error table
769 * @error_event_table_tlv_status: bitmap that indicates what error table
770 * pointers was recevied via TLV. use enum &iwl_error_event_table_status
773 const struct iwl_trans_ops *ops;
774 struct iwl_op_mode *op_mode;
775 const struct iwl_cfg *cfg;
777 enum iwl_trans_state state;
778 unsigned long status;
787 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
792 const struct iwl_hcmd_arr *command_groups;
793 int command_groups_size;
794 bool wide_cmd_header;
801 /* The following fields are internal only */
802 struct kmem_cache *dev_cmd_pool;
803 char dev_cmd_pool_name[50];
805 struct dentry *dbgfs_dir;
807 #ifdef CONFIG_LOCKDEP
808 struct lockdep_map sync_cmd_lockdep_map;
811 struct iwl_apply_point_data apply_points[IWL_FW_INI_APPLY_NUM];
812 struct iwl_apply_point_data apply_points_ext[IWL_FW_INI_APPLY_NUM];
814 bool external_ini_loaded;
817 const struct iwl_fw_dbg_dest_tlv_v1 *dbg_dest_tlv;
818 const struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
819 struct iwl_fw_dbg_trigger_tlv * const *dbg_trigger_tlv;
822 struct iwl_dram_data fw_mon[IWL_FW_INI_APPLY_NUM];
823 struct iwl_self_init_dram init_dram;
825 enum iwl_plat_pm_mode system_pm_mode;
826 enum iwl_plat_pm_mode runtime_pm_mode;
830 u32 lmac_error_event_table[2];
831 u32 umac_error_event_table;
832 unsigned int error_event_table_tlv_status;
833 wait_queue_head_t fw_halt_waitq;
835 /* pointer to trans specific struct */
836 /*Ensure that this pointer will always be aligned to sizeof pointer */
837 char trans_specific[0] __aligned(sizeof(void *));
840 const char *iwl_get_cmd_string(struct iwl_trans *trans, u32 id);
841 int iwl_cmd_groups_verify_sorted(const struct iwl_trans_config *trans);
843 static inline void iwl_trans_configure(struct iwl_trans *trans,
844 const struct iwl_trans_config *trans_cfg)
846 trans->op_mode = trans_cfg->op_mode;
848 trans->ops->configure(trans, trans_cfg);
849 WARN_ON(iwl_cmd_groups_verify_sorted(trans_cfg));
852 static inline int _iwl_trans_start_hw(struct iwl_trans *trans, bool low_power)
856 return trans->ops->start_hw(trans, low_power);
859 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
861 return trans->ops->start_hw(trans, true);
864 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans)
868 if (trans->ops->op_mode_leave)
869 trans->ops->op_mode_leave(trans);
871 trans->op_mode = NULL;
873 trans->state = IWL_TRANS_NO_FW;
876 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
880 trans->state = IWL_TRANS_FW_ALIVE;
882 trans->ops->fw_alive(trans, scd_addr);
885 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
886 const struct fw_img *fw,
891 WARN_ON_ONCE(!trans->rx_mpdu_cmd);
893 clear_bit(STATUS_FW_ERROR, &trans->status);
894 return trans->ops->start_fw(trans, fw, run_in_rfkill);
897 static inline void _iwl_trans_stop_device(struct iwl_trans *trans,
902 trans->ops->stop_device(trans, low_power);
904 trans->state = IWL_TRANS_NO_FW;
907 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
909 _iwl_trans_stop_device(trans, true);
912 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test,
916 if (trans->ops->d3_suspend)
917 trans->ops->d3_suspend(trans, test, reset);
920 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
921 enum iwl_d3_status *status,
922 bool test, bool reset)
925 if (!trans->ops->d3_resume)
928 return trans->ops->d3_resume(trans, status, test, reset);
931 static inline int iwl_trans_suspend(struct iwl_trans *trans)
933 if (!trans->ops->suspend)
936 return trans->ops->suspend(trans);
939 static inline void iwl_trans_resume(struct iwl_trans *trans)
941 if (trans->ops->resume)
942 trans->ops->resume(trans);
945 static inline struct iwl_trans_dump_data *
946 iwl_trans_dump_data(struct iwl_trans *trans, u32 dump_mask)
948 if (!trans->ops->dump_data)
950 return trans->ops->dump_data(trans, dump_mask);
953 static inline struct iwl_device_cmd *
954 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
956 return kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
959 int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
961 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
962 struct iwl_device_cmd *dev_cmd)
964 kmem_cache_free(trans->dev_cmd_pool, dev_cmd);
967 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
968 struct iwl_device_cmd *dev_cmd, int queue)
970 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
973 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
974 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
978 return trans->ops->tx(trans, skb, dev_cmd, queue);
981 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
982 int ssn, struct sk_buff_head *skbs)
984 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
985 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
989 trans->ops->reclaim(trans, queue, ssn, skbs);
992 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue,
995 trans->ops->txq_disable(trans, queue, configure_scd);
999 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn,
1000 const struct iwl_trans_txq_scd_cfg *cfg,
1001 unsigned int queue_wdg_timeout)
1005 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1006 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1010 return trans->ops->txq_enable(trans, queue, ssn,
1011 cfg, queue_wdg_timeout);
1015 iwl_trans_get_rxq_dma_data(struct iwl_trans *trans, int queue,
1016 struct iwl_trans_rxq_dma_data *data)
1018 if (WARN_ON_ONCE(!trans->ops->rxq_dma_data))
1021 return trans->ops->rxq_dma_data(trans, queue, data);
1025 iwl_trans_txq_free(struct iwl_trans *trans, int queue)
1027 if (WARN_ON_ONCE(!trans->ops->txq_free))
1030 trans->ops->txq_free(trans, queue);
1034 iwl_trans_txq_alloc(struct iwl_trans *trans,
1035 __le16 flags, u8 sta_id, u8 tid,
1036 int cmd_id, int size,
1037 unsigned int wdg_timeout)
1041 if (WARN_ON_ONCE(!trans->ops->txq_alloc))
1044 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1045 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1049 return trans->ops->txq_alloc(trans, flags, sta_id, tid,
1050 cmd_id, size, wdg_timeout);
1053 static inline void iwl_trans_txq_set_shared_mode(struct iwl_trans *trans,
1054 int queue, bool shared_mode)
1056 if (trans->ops->txq_set_shared_mode)
1057 trans->ops->txq_set_shared_mode(trans, queue, shared_mode);
1060 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
1061 int fifo, int sta_id, int tid,
1062 int frame_limit, u16 ssn,
1063 unsigned int queue_wdg_timeout)
1065 struct iwl_trans_txq_scd_cfg cfg = {
1069 .frame_limit = frame_limit,
1070 .aggregate = sta_id >= 0,
1073 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout);
1077 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo,
1078 unsigned int queue_wdg_timeout)
1080 struct iwl_trans_txq_scd_cfg cfg = {
1083 .tid = IWL_MAX_TID_COUNT,
1084 .frame_limit = IWL_FRAME_LIMIT,
1088 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout);
1091 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans,
1095 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1096 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1100 if (trans->ops->freeze_txq_timer)
1101 trans->ops->freeze_txq_timer(trans, txqs, freeze);
1104 static inline void iwl_trans_block_txq_ptrs(struct iwl_trans *trans,
1107 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1108 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1112 if (trans->ops->block_txq_ptrs)
1113 trans->ops->block_txq_ptrs(trans, block);
1116 static inline int iwl_trans_wait_tx_queues_empty(struct iwl_trans *trans,
1119 if (WARN_ON_ONCE(!trans->ops->wait_tx_queues_empty))
1122 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1123 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1127 return trans->ops->wait_tx_queues_empty(trans, txqs);
1130 static inline int iwl_trans_wait_txq_empty(struct iwl_trans *trans, int queue)
1132 if (WARN_ON_ONCE(!trans->ops->wait_txq_empty))
1135 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1136 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1140 return trans->ops->wait_txq_empty(trans, queue);
1143 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
1145 trans->ops->write8(trans, ofs, val);
1148 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
1150 trans->ops->write32(trans, ofs, val);
1153 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
1155 return trans->ops->read32(trans, ofs);
1158 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
1160 return trans->ops->read_prph(trans, ofs);
1163 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
1166 return trans->ops->write_prph(trans, ofs, val);
1169 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
1170 void *buf, int dwords)
1172 return trans->ops->read_mem(trans, addr, buf, dwords);
1175 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
1177 if (__builtin_constant_p(bufsize)) \
1178 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
1179 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
1182 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
1186 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
1192 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
1193 const void *buf, int dwords)
1195 return trans->ops->write_mem(trans, addr, buf, dwords);
1198 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
1201 return iwl_trans_write_mem(trans, addr, &val, 1);
1204 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
1206 if (trans->ops->set_pmi)
1207 trans->ops->set_pmi(trans, state);
1210 static inline void iwl_trans_sw_reset(struct iwl_trans *trans)
1212 if (trans->ops->sw_reset)
1213 trans->ops->sw_reset(trans);
1217 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
1219 trans->ops->set_bits_mask(trans, reg, mask, value);
1222 #define iwl_trans_grab_nic_access(trans, flags) \
1223 __cond_lock(nic_access, \
1224 likely((trans)->ops->grab_nic_access(trans, flags)))
1226 static inline void __releases(nic_access)
1227 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
1229 trans->ops->release_nic_access(trans, flags);
1230 __release(nic_access);
1233 static inline void iwl_trans_fw_error(struct iwl_trans *trans)
1235 if (WARN_ON_ONCE(!trans->op_mode))
1238 /* prevent double restarts due to the same erroneous FW */
1239 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status))
1240 iwl_op_mode_nic_error(trans->op_mode);
1242 if (test_and_clear_bit(STATUS_FW_WAIT_DUMP, &trans->status))
1243 wake_up(&trans->fw_halt_waitq);
1247 /*****************************************************
1248 * transport helper functions
1249 *****************************************************/
1250 struct iwl_trans *iwl_trans_alloc(unsigned int priv_size,
1252 const struct iwl_cfg *cfg,
1253 const struct iwl_trans_ops *ops);
1254 void iwl_trans_free(struct iwl_trans *trans);
1255 void iwl_trans_ref(struct iwl_trans *trans);
1256 void iwl_trans_unref(struct iwl_trans *trans);
1258 /*****************************************************
1259 * driver (transport) register/unregister functions
1260 ******************************************************/
1261 int __must_check iwl_pci_register_driver(void);
1262 void iwl_pci_unregister_driver(void);
1264 #endif /* __iwl_trans_h__ */