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
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
25 * The full GNU General Public License is included in this distribution
26 * in the file called COPYING.
28 * Contact Information:
29 * Intel Linux Wireless <linuxwifi@intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
34 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
35 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
36 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
42 * * Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * * Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in
46 * the documentation and/or other materials provided with the
48 * * Neither the name Intel Corporation nor the names of its
49 * contributors may be used to endorse or promote products derived
50 * from this software without specific prior written permission.
52 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64 *****************************************************************************/
65 #ifndef __iwl_trans_h__
66 #define __iwl_trans_h__
68 #include <linux/ieee80211.h>
69 #include <linux/mm.h> /* for page_address */
70 #include <linux/lockdep.h>
71 #include <linux/kernel.h>
73 #include "iwl-debug.h"
74 #include "iwl-config.h"
76 #include "iwl-op-mode.h"
79 * DOC: Transport layer - what is it ?
81 * The transport layer is the layer that deals with the HW directly. It provides
82 * an abstraction of the underlying HW to the upper layer. The transport layer
83 * doesn't provide any policy, algorithm or anything of this kind, but only
84 * mechanisms to make the HW do something. It is not completely stateless but
86 * We will have an implementation for each different supported bus.
90 * DOC: Life cycle of the transport layer
92 * The transport layer has a very precise life cycle.
94 * 1) A helper function is called during the module initialization and
95 * registers the bus driver's ops with the transport's alloc function.
96 * 2) Bus's probe calls to the transport layer's allocation functions.
97 * Of course this function is bus specific.
98 * 3) This allocation functions will spawn the upper layer which will
101 * 4) At some point (i.e. mac80211's start call), the op_mode will call
102 * the following sequence:
106 * 5) Then when finished (or reset):
109 * 6) Eventually, the free function will be called.
113 * DOC: Host command section
115 * A host command is a command issued by the upper layer to the fw. There are
116 * several versions of fw that have several APIs. The transport layer is
117 * completely agnostic to these differences.
118 * The transport does provide helper functionality (i.e. SYNC / ASYNC mode),
120 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
121 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
122 #define SEQ_TO_INDEX(s) ((s) & 0xff)
123 #define INDEX_TO_SEQ(i) ((i) & 0xff)
124 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
127 * those functions retrieve specific information from
128 * the id field in the iwl_host_cmd struct which contains
129 * the command id, the group id and the version of the command
132 static inline u8 iwl_cmd_opcode(u32 cmdid)
137 static inline u8 iwl_cmd_groupid(u32 cmdid)
139 return ((cmdid & 0xFF00) >> 8);
142 static inline u8 iwl_cmd_version(u32 cmdid)
144 return ((cmdid & 0xFF0000) >> 16);
147 static inline u32 iwl_cmd_id(u8 opcode, u8 groupid, u8 version)
149 return opcode + (groupid << 8) + (version << 16);
152 /* make u16 wide id out of u8 group and opcode */
153 #define WIDE_ID(grp, opcode) ((grp << 8) | opcode)
155 /* due to the conversion, this group is special; new groups
156 * should be defined in the appropriate fw-api header files
158 #define IWL_ALWAYS_LONG_GROUP 1
161 * struct iwl_cmd_header
163 * This header format appears in the beginning of each command sent from the
164 * driver, and each response/notification received from uCode.
166 struct iwl_cmd_header {
167 u8 cmd; /* Command ID: REPLY_RXON, etc. */
170 * The driver sets up the sequence number to values of its choosing.
171 * uCode does not use this value, but passes it back to the driver
172 * when sending the response to each driver-originated command, so
173 * the driver can match the response to the command. Since the values
174 * don't get used by uCode, the driver may set up an arbitrary format.
176 * There is one exception: uCode sets bit 15 when it originates
177 * the response/notification, i.e. when the response/notification
178 * is not a direct response to a command sent by the driver. For
179 * example, uCode issues REPLY_RX when it sends a received frame
180 * to the driver; it is not a direct response to any driver command.
182 * The Linux driver uses the following format:
184 * 0:7 tfd index - position within TX queue
187 * 15 unsolicited RX or uCode-originated notification
193 * struct iwl_cmd_header_wide
195 * This header format appears in the beginning of each command sent from the
196 * driver, and each response/notification received from uCode.
197 * this is the wide version that contains more information about the command
198 * like length, version and command type
200 struct iwl_cmd_header_wide {
209 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
210 #define FH_RSCSR_FRAME_INVALID 0x55550000
211 #define FH_RSCSR_FRAME_ALIGN 0x40
213 struct iwl_rx_packet {
215 * The first 4 bytes of the RX frame header contain both the RX frame
216 * size and some flags.
218 * 31: flag flush RB request
219 * 30: flag ignore TC (terminal counter) request
220 * 29: flag fast IRQ request
222 * 13-00: RX frame size
225 struct iwl_cmd_header hdr;
229 static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt)
231 return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
234 static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt)
236 return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr);
240 * enum CMD_MODE - how to send the host commands ?
242 * @CMD_ASYNC: Return right away and don't wait for the response
243 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of
244 * the response. The caller needs to call iwl_free_resp when done.
245 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
246 * command queue, but after other high priority commands. Valid only
248 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
249 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
250 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
251 * (i.e. mark it as non-idle).
252 * @CMD_WANT_ASYNC_CALLBACK: the op_mode's async callback function must be
253 * called after this command completes. Valid only with CMD_ASYNC.
254 * @CMD_TB_BITMAP_POS: Position of the first bit for the TB bitmap. We need to
255 * check that we leave enough room for the TBs bitmap which needs 20 bits.
259 CMD_WANT_SKB = BIT(1),
260 CMD_SEND_IN_RFKILL = BIT(2),
261 CMD_HIGH_PRIO = BIT(3),
262 CMD_SEND_IN_IDLE = BIT(4),
263 CMD_MAKE_TRANS_IDLE = BIT(5),
264 CMD_WAKE_UP_TRANS = BIT(6),
265 CMD_WANT_ASYNC_CALLBACK = BIT(7),
267 CMD_TB_BITMAP_POS = 11,
270 #define DEF_CMD_PAYLOAD_SIZE 320
273 * struct iwl_device_cmd
275 * For allocation of the command and tx queues, this establishes the overall
276 * size of the largest command we send to uCode, except for commands that
277 * aren't fully copied and use other TFD space.
279 struct iwl_device_cmd {
282 struct iwl_cmd_header hdr; /* uCode API */
283 u8 payload[DEF_CMD_PAYLOAD_SIZE];
286 struct iwl_cmd_header_wide hdr_wide;
287 u8 payload_wide[DEF_CMD_PAYLOAD_SIZE -
288 sizeof(struct iwl_cmd_header_wide) +
289 sizeof(struct iwl_cmd_header)];
294 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
297 * number of transfer buffers (fragments) per transmit frame descriptor;
298 * this is just the driver's idea, the hardware supports 20
300 #define IWL_MAX_CMD_TBS_PER_TFD 2
303 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
305 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
306 * ring. The transport layer doesn't map the command's buffer to DMA, but
307 * rather copies it to a previously allocated DMA buffer. This flag tells
308 * the transport layer not to copy the command, but to map the existing
309 * buffer (that is passed in) instead. This saves the memcpy and allows
310 * commands that are bigger than the fixed buffer to be submitted.
311 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
312 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
313 * chunk internally and free it again after the command completes. This
314 * can (currently) be used only once per command.
315 * Note that a TFD entry after a DUP one cannot be a normal copied one.
317 enum iwl_hcmd_dataflag {
318 IWL_HCMD_DFL_NOCOPY = BIT(0),
319 IWL_HCMD_DFL_DUP = BIT(1),
323 * struct iwl_host_cmd - Host command to the uCode
325 * @data: array of chunks that composes the data of the host command
326 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
327 * @_rx_page_order: (internally used to free response packet)
328 * @_rx_page_addr: (internally used to free response packet)
329 * @flags: can be CMD_*
330 * @len: array of the lengths of the chunks in data
331 * @dataflags: IWL_HCMD_DFL_*
332 * @id: command id of the host command, for wide commands encoding the
333 * version and group as well
335 struct iwl_host_cmd {
336 const void *data[IWL_MAX_CMD_TBS_PER_TFD];
337 struct iwl_rx_packet *resp_pkt;
338 unsigned long _rx_page_addr;
343 u16 len[IWL_MAX_CMD_TBS_PER_TFD];
344 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
347 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
349 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
352 struct iwl_rx_cmd_buffer {
357 unsigned int truesize;
360 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
362 return (void *)((unsigned long)page_address(r->_page) + r->_offset);
365 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
370 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
372 r->_page_stolen = true;
377 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
379 __free_pages(r->_page, r->_rx_page_order);
382 #define MAX_NO_RECLAIM_CMDS 6
385 * The first entry in driver_data array in ieee80211_tx_info
386 * that can be used by the transport.
388 #define IWL_TRANS_FIRST_DRIVER_DATA 2
389 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
392 * Maximum number of HW queues the transport layer
395 #define IWL_MAX_HW_QUEUES 32
396 #define IWL_MAX_TID_COUNT 8
397 #define IWL_FRAME_LIMIT 64
398 #define IWL_MAX_RX_HW_QUEUES 16
401 * enum iwl_wowlan_status - WoWLAN image/device status
402 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
403 * @IWL_D3_STATUS_RESET: device was reset while suspended
411 * enum iwl_trans_status: transport status flags
412 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
413 * @STATUS_DEVICE_ENABLED: APM is enabled
414 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
415 * @STATUS_INT_ENABLED: interrupts are enabled
416 * @STATUS_RFKILL: the HW RFkill switch is in KILL position
417 * @STATUS_FW_ERROR: the fw is in error state
418 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
420 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
421 * @STATUS_TRANS_DEAD: trans is dead - avoid any read/write operation
423 enum iwl_trans_status {
424 STATUS_SYNC_HCMD_ACTIVE,
425 STATUS_DEVICE_ENABLED,
430 STATUS_TRANS_GOING_IDLE,
436 iwl_trans_get_rb_size_order(enum iwl_amsdu_size rb_size)
440 return get_order(4 * 1024);
442 return get_order(8 * 1024);
444 return get_order(12 * 1024);
451 struct iwl_hcmd_names {
453 const char *const cmd_name;
456 #define HCMD_NAME(x) \
457 { .cmd_id = x, .cmd_name = #x }
459 struct iwl_hcmd_arr {
460 const struct iwl_hcmd_names *arr;
464 #define HCMD_ARR(x) \
465 { .arr = x, .size = ARRAY_SIZE(x) }
468 * struct iwl_trans_config - transport configuration
470 * @op_mode: pointer to the upper layer.
471 * @cmd_queue: the index of the command queue.
472 * Must be set before start_fw.
473 * @cmd_fifo: the fifo for host commands
474 * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue.
475 * @no_reclaim_cmds: Some devices erroneously don't set the
476 * SEQ_RX_FRAME bit on some notifications, this is the
477 * list of such notifications to filter. Max length is
478 * %MAX_NO_RECLAIM_CMDS.
479 * @n_no_reclaim_cmds: # of commands in list
480 * @rx_buf_size: RX buffer size needed for A-MSDUs
481 * if unset 4k will be the RX buffer size
482 * @bc_table_dword: set to true if the BC table expects the byte count to be
483 * in DWORD (as opposed to bytes)
484 * @scd_set_active: should the transport configure the SCD for HCMD queue
485 * @wide_cmd_header: firmware supports wide host command header
486 * @sw_csum_tx: transport should compute the TCP checksum
487 * @command_groups: array of command groups, each member is an array of the
488 * commands in the group; for debugging only
489 * @command_groups_size: number of command groups, to avoid illegal access
490 * @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until
491 * we get the ALIVE from the uCode
493 struct iwl_trans_config {
494 struct iwl_op_mode *op_mode;
498 unsigned int cmd_q_wdg_timeout;
499 const u8 *no_reclaim_cmds;
500 unsigned int n_no_reclaim_cmds;
502 enum iwl_amsdu_size rx_buf_size;
505 bool wide_cmd_header;
507 const struct iwl_hcmd_arr *command_groups;
508 int command_groups_size;
513 struct iwl_trans_dump_data {
520 struct iwl_trans_txq_scd_cfg {
529 * struct iwl_trans_ops - transport specific operations
531 * All the handlers MUST be implemented
533 * @start_hw: starts the HW. If low_power is true, the NIC needs to be taken
534 * out of a low power state. From that point on, the HW can send
535 * interrupts. May sleep.
536 * @op_mode_leave: Turn off the HW RF kill indication if on
538 * @start_fw: allocates and inits all the resources for the transport
539 * layer. Also kick a fw image.
541 * @fw_alive: called when the fw sends alive notification. If the fw provides
542 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
544 * @stop_device: stops the whole device (embedded CPU put to reset) and stops
545 * the HW. If low_power is true, the NIC will be put in low power state.
546 * From that point on, the HW will be stopped but will still issue an
547 * interrupt if the HW RF kill switch is triggered.
548 * This callback must do the right thing and not crash even if %start_hw()
549 * was called but not &start_fw(). May sleep.
550 * @d3_suspend: put the device into the correct mode for WoWLAN during
551 * suspend. This is optional, if not implemented WoWLAN will not be
552 * supported. This callback may sleep.
553 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
554 * talk to the WoWLAN image to get its status. This is optional, if not
555 * implemented WoWLAN will not be supported. This callback may sleep.
556 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
557 * If RFkill is asserted in the middle of a SYNC host command, it must
558 * return -ERFKILL straight away.
559 * May sleep only if CMD_ASYNC is not set
560 * @tx: send an skb. The transport relies on the op_mode to zero the
561 * the ieee80211_tx_info->driver_data. If the MPDU is an A-MSDU, all
562 * the CSUM will be taken care of (TCP CSUM and IP header in case of
563 * IPv4). If the MPDU is a single MSDU, the op_mode must compute the IP
564 * header if it is IPv4.
566 * @reclaim: free packet until ssn. Returns a list of freed packets.
568 * @txq_enable: setup a queue. To setup an AC queue, use the
569 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
570 * this one. The op_mode must not configure the HCMD queue. The scheduler
571 * configuration may be %NULL, in which case the hardware will not be
572 * configured. May sleep.
573 * @txq_disable: de-configure a Tx queue to send AMPDUs
575 * @wait_tx_queue_empty: wait until tx queues are empty. May sleep.
576 * @freeze_txq_timer: prevents the timer of the queue from firing until the
577 * queue is set to awake. Must be atomic.
578 * @block_txq_ptrs: stop updating the write pointers of the Tx queues. Note
579 * that the transport needs to refcount the calls since this function
580 * will be called several times with block = true, and then the queues
581 * need to be unblocked only after the same number of calls with
583 * @write8: write a u8 to a register at offset ofs from the BAR
584 * @write32: write a u32 to a register at offset ofs from the BAR
585 * @read32: read a u32 register at offset ofs from the BAR
586 * @read_prph: read a DWORD from a periphery register
587 * @write_prph: write a DWORD to a periphery register
588 * @read_mem: read device's SRAM in DWORD
589 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
591 * @configure: configure parameters required by the transport layer from
592 * the op_mode. May be called several times before start_fw, can't be
594 * @set_pmi: set the power pmi state
595 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
596 * Sleeping is not allowed between grab_nic_access and
597 * release_nic_access.
598 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
599 * must be the same one that was sent before to the grab_nic_access.
600 * @set_bits_mask - set SRAM register according to value and mask.
601 * @ref: grab a reference to the transport/FW layers, disallowing
602 * certain low power states
603 * @unref: release a reference previously taken with @ref. Note that
604 * initially the reference count is 1, making an initial @unref
605 * necessary to allow low power states.
606 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last
607 * TX'ed commands and similar. The buffer will be vfree'd by the caller.
608 * Note that the transport must fill in the proper file headers.
610 struct iwl_trans_ops {
612 int (*start_hw)(struct iwl_trans *iwl_trans, bool low_power);
613 void (*op_mode_leave)(struct iwl_trans *iwl_trans);
614 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
616 int (*update_sf)(struct iwl_trans *trans,
617 struct iwl_sf_region *st_fwrd_space);
618 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
619 void (*stop_device)(struct iwl_trans *trans, bool low_power);
621 void (*d3_suspend)(struct iwl_trans *trans, bool test);
622 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status,
625 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
627 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
628 struct iwl_device_cmd *dev_cmd, int queue);
629 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
630 struct sk_buff_head *skbs);
632 void (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn,
633 const struct iwl_trans_txq_scd_cfg *cfg,
634 unsigned int queue_wdg_timeout);
635 void (*txq_disable)(struct iwl_trans *trans, int queue,
638 int (*wait_tx_queue_empty)(struct iwl_trans *trans, u32 txq_bm);
639 void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs,
641 void (*block_txq_ptrs)(struct iwl_trans *trans, bool block);
643 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
644 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
645 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
646 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
647 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
648 int (*read_mem)(struct iwl_trans *trans, u32 addr,
649 void *buf, int dwords);
650 int (*write_mem)(struct iwl_trans *trans, u32 addr,
651 const void *buf, int dwords);
652 void (*configure)(struct iwl_trans *trans,
653 const struct iwl_trans_config *trans_cfg);
654 void (*set_pmi)(struct iwl_trans *trans, bool state);
655 bool (*grab_nic_access)(struct iwl_trans *trans, unsigned long *flags);
656 void (*release_nic_access)(struct iwl_trans *trans,
657 unsigned long *flags);
658 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
660 void (*ref)(struct iwl_trans *trans);
661 void (*unref)(struct iwl_trans *trans);
662 int (*suspend)(struct iwl_trans *trans);
663 void (*resume)(struct iwl_trans *trans);
665 struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans,
666 const struct iwl_fw_dbg_trigger_tlv
671 * enum iwl_trans_state - state of the transport layer
673 * @IWL_TRANS_NO_FW: no fw has sent an alive response
674 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
676 enum iwl_trans_state {
678 IWL_TRANS_FW_ALIVE = 1,
682 * DOC: Platform power management
684 * There are two types of platform power management: system-wide
685 * (WoWLAN) and runtime.
687 * In system-wide power management the entire platform goes into a low
688 * power state (e.g. idle or suspend to RAM) at the same time and the
689 * device is configured as a wakeup source for the entire platform.
690 * This is usually triggered by userspace activity (e.g. the user
691 * presses the suspend button or a power management daemon decides to
692 * put the platform in low power mode). The device's behavior in this
693 * mode is dictated by the wake-on-WLAN configuration.
695 * In runtime power management, only the devices which are themselves
696 * idle enter a low power state. This is done at runtime, which means
697 * that the entire system is still running normally. This mode is
698 * usually triggered automatically by the device driver and requires
699 * the ability to enter and exit the low power modes in a very short
700 * time, so there is not much impact in usability.
702 * The terms used for the device's behavior are as follows:
704 * - D0: the device is fully powered and the host is awake;
705 * - D3: the device is in low power mode and only reacts to
706 * specific events (e.g. magic-packet received or scan
708 * - D0I3: the device is in low power mode and reacts to any
709 * activity (e.g. RX);
711 * These terms reflect the power modes in the firmware and are not to
712 * be confused with the physical device power state. The NIC can be
713 * in D0I3 mode even if, for instance, the PCI device is in D3 state.
717 * enum iwl_plat_pm_mode - platform power management mode
719 * This enumeration describes the device's platform power management
720 * behavior when in idle mode (i.e. runtime power management) or when
721 * in system-wide suspend (i.e WoWLAN).
723 * @IWL_PLAT_PM_MODE_DISABLED: power management is disabled for this
724 * device. At runtime, this means that nothing happens and the
725 * device always remains in active. In system-wide suspend mode,
726 * it means that the all connections will be closed automatically
727 * by mac80211 before the platform is suspended.
728 * @IWL_PLAT_PM_MODE_D3: the device goes into D3 mode (i.e. WoWLAN).
729 * For runtime power management, this mode is not officially
731 * @IWL_PLAT_PM_MODE_D0I3: the device goes into D0I3 mode.
733 enum iwl_plat_pm_mode {
734 IWL_PLAT_PM_MODE_DISABLED,
736 IWL_PLAT_PM_MODE_D0I3,
740 * struct iwl_trans - transport common data
742 * @ops - pointer to iwl_trans_ops
743 * @op_mode - pointer to the op_mode
744 * @cfg - pointer to the configuration
745 * @status: a bit-mask of transport status flags
746 * @dev - pointer to struct device * that represents the device
747 * @max_skb_frags: maximum number of fragments an SKB can have when transmitted.
748 * 0 indicates that frag SKBs (NETIF_F_SG) aren't supported.
749 * @hw_id: a u32 with the ID of the device / sub-device.
750 * Set during transport allocation.
751 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
752 * @pm_support: set to true in start_hw if link pm is supported
753 * @ltr_enabled: set to true if the LTR is enabled
754 * @num_rx_queues: number of RX queues allocated by the transport;
755 * the transport must set this before calling iwl_drv_start()
756 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
757 * The user should use iwl_trans_{alloc,free}_tx_cmd.
758 * @dev_cmd_headroom: room needed for the transport's private use before the
759 * device_cmd for Tx - for internal use only
760 * The user should use iwl_trans_{alloc,free}_tx_cmd.
761 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
762 * starting the firmware, used for tracing
763 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
764 * start of the 802.11 header in the @rx_mpdu_cmd
765 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
766 * @dbg_dest_tlv: points to the destination TLV for debug
767 * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
768 * @dbg_trigger_tlv: array of pointers to triggers TLVs for debug
769 * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
770 * @paging_req_addr: The location were the FW will upload / download the pages
771 * from. The address is set by the opmode
772 * @paging_db: Pointer to the opmode paging data base, the pointer is set by
774 * @paging_download_buf: Buffer used for copying all of the pages before
775 * downloading them to the FW. The buffer is allocated in the opmode
776 * @system_pm_mode: the system-wide power management mode in use.
777 * This mode is set dynamically, depending on the WoWLAN values
778 * configured from the userspace at runtime.
779 * @runtime_pm_mode: the runtime power management mode in use. This
780 * mode is set during the initialization phase and is not
781 * supposed to change during runtime.
784 const struct iwl_trans_ops *ops;
785 struct iwl_op_mode *op_mode;
786 const struct iwl_cfg *cfg;
787 enum iwl_trans_state state;
788 unsigned long status;
796 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
801 const struct iwl_hcmd_arr *command_groups;
802 int command_groups_size;
806 /* The following fields are internal only */
807 struct kmem_cache *dev_cmd_pool;
808 size_t dev_cmd_headroom;
809 char dev_cmd_pool_name[50];
811 struct dentry *dbgfs_dir;
813 #ifdef CONFIG_LOCKDEP
814 struct lockdep_map sync_cmd_lockdep_map;
819 const struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
820 const struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
821 struct iwl_fw_dbg_trigger_tlv * const *dbg_trigger_tlv;
825 * Paging parameters - All of the parameters should be set by the
826 * opmode when paging is enabled
829 struct iwl_fw_paging *paging_db;
830 void *paging_download_buf;
832 enum iwl_plat_pm_mode system_pm_mode;
833 enum iwl_plat_pm_mode runtime_pm_mode;
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 int iwl_trans_update_sf(struct iwl_trans *trans,
898 struct iwl_sf_region *st_fwrd_space)
902 if (trans->ops->update_sf)
903 return trans->ops->update_sf(trans, st_fwrd_space);
908 static inline void _iwl_trans_stop_device(struct iwl_trans *trans,
913 trans->ops->stop_device(trans, low_power);
915 trans->state = IWL_TRANS_NO_FW;
918 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
920 _iwl_trans_stop_device(trans, true);
923 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test)
926 if (trans->ops->d3_suspend)
927 trans->ops->d3_suspend(trans, test);
930 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
931 enum iwl_d3_status *status,
935 if (!trans->ops->d3_resume)
938 return trans->ops->d3_resume(trans, status, test);
941 static inline void iwl_trans_ref(struct iwl_trans *trans)
944 trans->ops->ref(trans);
947 static inline void iwl_trans_unref(struct iwl_trans *trans)
949 if (trans->ops->unref)
950 trans->ops->unref(trans);
953 static inline int iwl_trans_suspend(struct iwl_trans *trans)
955 if (!trans->ops->suspend)
958 return trans->ops->suspend(trans);
961 static inline void iwl_trans_resume(struct iwl_trans *trans)
963 if (trans->ops->resume)
964 trans->ops->resume(trans);
967 static inline struct iwl_trans_dump_data *
968 iwl_trans_dump_data(struct iwl_trans *trans,
969 const struct iwl_fw_dbg_trigger_tlv *trigger)
971 if (!trans->ops->dump_data)
973 return trans->ops->dump_data(trans, trigger);
976 static inline struct iwl_device_cmd *
977 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
979 u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
981 if (unlikely(dev_cmd_ptr == NULL))
984 return (struct iwl_device_cmd *)
985 (dev_cmd_ptr + trans->dev_cmd_headroom);
988 int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
990 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
991 struct iwl_device_cmd *dev_cmd)
993 u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom;
995 kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr);
998 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
999 struct iwl_device_cmd *dev_cmd, int queue)
1001 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
1004 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1005 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1009 return trans->ops->tx(trans, skb, dev_cmd, queue);
1012 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
1013 int ssn, struct sk_buff_head *skbs)
1015 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1016 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1020 trans->ops->reclaim(trans, queue, ssn, skbs);
1023 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue,
1026 trans->ops->txq_disable(trans, queue, configure_scd);
1030 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn,
1031 const struct iwl_trans_txq_scd_cfg *cfg,
1032 unsigned int queue_wdg_timeout)
1036 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1037 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1041 trans->ops->txq_enable(trans, queue, ssn, cfg, queue_wdg_timeout);
1044 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
1045 int fifo, int sta_id, int tid,
1046 int frame_limit, u16 ssn,
1047 unsigned int queue_wdg_timeout)
1049 struct iwl_trans_txq_scd_cfg cfg = {
1053 .frame_limit = frame_limit,
1054 .aggregate = sta_id >= 0,
1057 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout);
1061 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo,
1062 unsigned int queue_wdg_timeout)
1064 struct iwl_trans_txq_scd_cfg cfg = {
1067 .tid = IWL_MAX_TID_COUNT,
1068 .frame_limit = IWL_FRAME_LIMIT,
1072 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout);
1075 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans,
1079 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1080 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1084 if (trans->ops->freeze_txq_timer)
1085 trans->ops->freeze_txq_timer(trans, txqs, freeze);
1088 static inline void iwl_trans_block_txq_ptrs(struct iwl_trans *trans,
1091 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1092 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1096 if (trans->ops->block_txq_ptrs)
1097 trans->ops->block_txq_ptrs(trans, block);
1100 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans,
1103 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) {
1104 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
1108 return trans->ops->wait_tx_queue_empty(trans, txqs);
1111 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
1113 trans->ops->write8(trans, ofs, val);
1116 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
1118 trans->ops->write32(trans, ofs, val);
1121 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
1123 return trans->ops->read32(trans, ofs);
1126 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
1128 return trans->ops->read_prph(trans, ofs);
1131 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
1134 return trans->ops->write_prph(trans, ofs, val);
1137 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
1138 void *buf, int dwords)
1140 return trans->ops->read_mem(trans, addr, buf, dwords);
1143 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
1145 if (__builtin_constant_p(bufsize)) \
1146 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
1147 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
1150 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
1154 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
1160 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
1161 const void *buf, int dwords)
1163 return trans->ops->write_mem(trans, addr, buf, dwords);
1166 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
1169 return iwl_trans_write_mem(trans, addr, &val, 1);
1172 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
1174 if (trans->ops->set_pmi)
1175 trans->ops->set_pmi(trans, state);
1179 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
1181 trans->ops->set_bits_mask(trans, reg, mask, value);
1184 #define iwl_trans_grab_nic_access(trans, flags) \
1185 __cond_lock(nic_access, \
1186 likely((trans)->ops->grab_nic_access(trans, flags)))
1188 static inline void __releases(nic_access)
1189 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
1191 trans->ops->release_nic_access(trans, flags);
1192 __release(nic_access);
1195 static inline void iwl_trans_fw_error(struct iwl_trans *trans)
1197 if (WARN_ON_ONCE(!trans->op_mode))
1200 /* prevent double restarts due to the same erroneous FW */
1201 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status))
1202 iwl_op_mode_nic_error(trans->op_mode);
1205 /*****************************************************
1206 * transport helper functions
1207 *****************************************************/
1208 struct iwl_trans *iwl_trans_alloc(unsigned int priv_size,
1210 const struct iwl_cfg *cfg,
1211 const struct iwl_trans_ops *ops,
1212 size_t dev_cmd_headroom);
1213 void iwl_trans_free(struct iwl_trans *trans);
1215 /*****************************************************
1216 * driver (transport) register/unregister functions
1217 ******************************************************/
1218 int __must_check iwl_pci_register_driver(void);
1219 void iwl_pci_unregister_driver(void);
1221 #endif /* __iwl_trans_h__ */