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 <ilw@linux.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>
72 #include "iwl-debug.h"
73 #include "iwl-config.h"
75 #include "iwl-op-mode.h"
78 * DOC: Transport layer - what is it ?
80 * The transport layer is the layer that deals with the HW directly. It provides
81 * an abstraction of the underlying HW to the upper layer. The transport layer
82 * doesn't provide any policy, algorithm or anything of this kind, but only
83 * mechanisms to make the HW do something. It is not completely stateless but
85 * We will have an implementation for each different supported bus.
89 * DOC: Life cycle of the transport layer
91 * The transport layer has a very precise life cycle.
93 * 1) A helper function is called during the module initialization and
94 * registers the bus driver's ops with the transport's alloc function.
95 * 2) Bus's probe calls to the transport layer's allocation functions.
96 * Of course this function is bus specific.
97 * 3) This allocation functions will spawn the upper layer which will
100 * 4) At some point (i.e. mac80211's start call), the op_mode will call
101 * the following sequence:
105 * 5) Then when finished (or reset):
108 * 6) Eventually, the free function will be called.
112 * DOC: Host command section
114 * A host command is a command issued by the upper layer to the fw. There are
115 * several versions of fw that have several APIs. The transport layer is
116 * completely agnostic to these differences.
117 * The transport does provide helper functionality (i.e. SYNC / ASYNC mode),
119 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
120 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
121 #define SEQ_TO_INDEX(s) ((s) & 0xff)
122 #define INDEX_TO_SEQ(i) ((i) & 0xff)
123 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
126 * those functions retrieve specific information from
127 * the id field in the iwl_host_cmd struct which contains
128 * the command id, the group id and the version of the command
131 static inline u8
iwl_cmd_opcode(u32 cmdid
)
136 static inline u8
iwl_cmd_groupid(u32 cmdid
)
138 return ((cmdid
& 0xFF00) >> 8);
141 static inline u8
iwl_cmd_version(u32 cmdid
)
143 return ((cmdid
& 0xFF0000) >> 16);
146 static inline u32
iwl_cmd_id(u8 opcode
, u8 groupid
, u8 version
)
148 return opcode
+ (groupid
<< 8) + (version
<< 16);
151 /* due to the conversion, this group is special; new groups
152 * should be defined in the appropriate fw-api header files
154 #define IWL_ALWAYS_LONG_GROUP 1
157 * struct iwl_cmd_header
159 * This header format appears in the beginning of each command sent from the
160 * driver, and each response/notification received from uCode.
162 struct iwl_cmd_header
{
163 u8 cmd
; /* Command ID: REPLY_RXON, etc. */
166 * The driver sets up the sequence number to values of its choosing.
167 * uCode does not use this value, but passes it back to the driver
168 * when sending the response to each driver-originated command, so
169 * the driver can match the response to the command. Since the values
170 * don't get used by uCode, the driver may set up an arbitrary format.
172 * There is one exception: uCode sets bit 15 when it originates
173 * the response/notification, i.e. when the response/notification
174 * is not a direct response to a command sent by the driver. For
175 * example, uCode issues REPLY_RX when it sends a received frame
176 * to the driver; it is not a direct response to any driver command.
178 * The Linux driver uses the following format:
180 * 0:7 tfd index - position within TX queue
183 * 15 unsolicited RX or uCode-originated notification
189 * struct iwl_cmd_header_wide
191 * This header format appears in the beginning of each command sent from the
192 * driver, and each response/notification received from uCode.
193 * this is the wide version that contains more information about the command
194 * like length, version and command type
196 struct iwl_cmd_header_wide
{
205 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
206 #define FH_RSCSR_FRAME_INVALID 0x55550000
207 #define FH_RSCSR_FRAME_ALIGN 0x40
209 struct iwl_rx_packet
{
211 * The first 4 bytes of the RX frame header contain both the RX frame
212 * size and some flags.
214 * 31: flag flush RB request
215 * 30: flag ignore TC (terminal counter) request
216 * 29: flag fast IRQ request
218 * 13-00: RX frame size
221 struct iwl_cmd_header hdr
;
225 static inline u32
iwl_rx_packet_len(const struct iwl_rx_packet
*pkt
)
227 return le32_to_cpu(pkt
->len_n_flags
) & FH_RSCSR_FRAME_SIZE_MSK
;
230 static inline u32
iwl_rx_packet_payload_len(const struct iwl_rx_packet
*pkt
)
232 return iwl_rx_packet_len(pkt
) - sizeof(pkt
->hdr
);
236 * enum CMD_MODE - how to send the host commands ?
238 * @CMD_ASYNC: Return right away and don't wait for the response
239 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of
240 * the response. The caller needs to call iwl_free_resp when done.
241 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
242 * command queue, but after other high priority commands. Valid only
244 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
245 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
246 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
247 * (i.e. mark it as non-idle).
251 CMD_WANT_SKB
= BIT(1),
252 CMD_SEND_IN_RFKILL
= BIT(2),
253 CMD_HIGH_PRIO
= BIT(3),
254 CMD_SEND_IN_IDLE
= BIT(4),
255 CMD_MAKE_TRANS_IDLE
= BIT(5),
256 CMD_WAKE_UP_TRANS
= BIT(6),
259 #define DEF_CMD_PAYLOAD_SIZE 320
262 * struct iwl_device_cmd
264 * For allocation of the command and tx queues, this establishes the overall
265 * size of the largest command we send to uCode, except for commands that
266 * aren't fully copied and use other TFD space.
268 struct iwl_device_cmd
{
271 struct iwl_cmd_header hdr
; /* uCode API */
272 u8 payload
[DEF_CMD_PAYLOAD_SIZE
];
275 struct iwl_cmd_header_wide hdr_wide
;
276 u8 payload_wide
[DEF_CMD_PAYLOAD_SIZE
-
277 sizeof(struct iwl_cmd_header_wide
) +
278 sizeof(struct iwl_cmd_header
)];
283 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
286 * number of transfer buffers (fragments) per transmit frame descriptor;
287 * this is just the driver's idea, the hardware supports 20
289 #define IWL_MAX_CMD_TBS_PER_TFD 2
292 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
294 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
295 * ring. The transport layer doesn't map the command's buffer to DMA, but
296 * rather copies it to a previously allocated DMA buffer. This flag tells
297 * the transport layer not to copy the command, but to map the existing
298 * buffer (that is passed in) instead. This saves the memcpy and allows
299 * commands that are bigger than the fixed buffer to be submitted.
300 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
301 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
302 * chunk internally and free it again after the command completes. This
303 * can (currently) be used only once per command.
304 * Note that a TFD entry after a DUP one cannot be a normal copied one.
306 enum iwl_hcmd_dataflag
{
307 IWL_HCMD_DFL_NOCOPY
= BIT(0),
308 IWL_HCMD_DFL_DUP
= BIT(1),
312 * struct iwl_host_cmd - Host command to the uCode
314 * @data: array of chunks that composes the data of the host command
315 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
316 * @_rx_page_order: (internally used to free response packet)
317 * @_rx_page_addr: (internally used to free response packet)
318 * @flags: can be CMD_*
319 * @len: array of the lengths of the chunks in data
320 * @dataflags: IWL_HCMD_DFL_*
321 * @id: command id of the host command, for wide commands encoding the
322 * version and group as well
324 struct iwl_host_cmd
{
325 const void *data
[IWL_MAX_CMD_TBS_PER_TFD
];
326 struct iwl_rx_packet
*resp_pkt
;
327 unsigned long _rx_page_addr
;
332 u16 len
[IWL_MAX_CMD_TBS_PER_TFD
];
333 u8 dataflags
[IWL_MAX_CMD_TBS_PER_TFD
];
336 static inline void iwl_free_resp(struct iwl_host_cmd
*cmd
)
338 free_pages(cmd
->_rx_page_addr
, cmd
->_rx_page_order
);
341 struct iwl_rx_cmd_buffer
{
346 unsigned int truesize
;
349 static inline void *rxb_addr(struct iwl_rx_cmd_buffer
*r
)
351 return (void *)((unsigned long)page_address(r
->_page
) + r
->_offset
);
354 static inline int rxb_offset(struct iwl_rx_cmd_buffer
*r
)
359 static inline struct page
*rxb_steal_page(struct iwl_rx_cmd_buffer
*r
)
361 r
->_page_stolen
= true;
366 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer
*r
)
368 __free_pages(r
->_page
, r
->_rx_page_order
);
371 #define MAX_NO_RECLAIM_CMDS 6
373 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
376 * Maximum number of HW queues the transport layer
379 #define IWL_MAX_HW_QUEUES 32
380 #define IWL_MAX_TID_COUNT 8
381 #define IWL_FRAME_LIMIT 64
384 * enum iwl_wowlan_status - WoWLAN image/device status
385 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
386 * @IWL_D3_STATUS_RESET: device was reset while suspended
394 * enum iwl_trans_status: transport status flags
395 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
396 * @STATUS_DEVICE_ENABLED: APM is enabled
397 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
398 * @STATUS_INT_ENABLED: interrupts are enabled
399 * @STATUS_RFKILL: the HW RFkill switch is in KILL position
400 * @STATUS_FW_ERROR: the fw is in error state
401 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
403 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
405 enum iwl_trans_status
{
406 STATUS_SYNC_HCMD_ACTIVE
,
407 STATUS_DEVICE_ENABLED
,
412 STATUS_TRANS_GOING_IDLE
,
417 * struct iwl_trans_config - transport configuration
419 * @op_mode: pointer to the upper layer.
420 * @cmd_queue: the index of the command queue.
421 * Must be set before start_fw.
422 * @cmd_fifo: the fifo for host commands
423 * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue.
424 * @no_reclaim_cmds: Some devices erroneously don't set the
425 * SEQ_RX_FRAME bit on some notifications, this is the
426 * list of such notifications to filter. Max length is
427 * %MAX_NO_RECLAIM_CMDS.
428 * @n_no_reclaim_cmds: # of commands in list
429 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
430 * if unset 4k will be the RX buffer size
431 * @bc_table_dword: set to true if the BC table expects the byte count to be
432 * in DWORD (as opposed to bytes)
433 * @scd_set_active: should the transport configure the SCD for HCMD queue
434 * @wide_cmd_header: firmware supports wide host command header
435 * @command_names: array of command names, must be 256 entries
436 * (one for each command); for debugging only
437 * @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until
438 * we get the ALIVE from the uCode
440 struct iwl_trans_config
{
441 struct iwl_op_mode
*op_mode
;
445 unsigned int cmd_q_wdg_timeout
;
446 const u8
*no_reclaim_cmds
;
447 unsigned int n_no_reclaim_cmds
;
452 bool wide_cmd_header
;
453 const char *const *command_names
;
458 struct iwl_trans_dump_data
{
465 struct iwl_trans_txq_scd_cfg
{
474 * struct iwl_trans_ops - transport specific operations
476 * All the handlers MUST be implemented
478 * @start_hw: starts the HW. If low_power is true, the NIC needs to be taken
479 * out of a low power state. From that point on, the HW can send
480 * interrupts. May sleep.
481 * @op_mode_leave: Turn off the HW RF kill indication if on
483 * @start_fw: allocates and inits all the resources for the transport
484 * layer. Also kick a fw image.
486 * @fw_alive: called when the fw sends alive notification. If the fw provides
487 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
489 * @stop_device: stops the whole device (embedded CPU put to reset) and stops
490 * the HW. If low_power is true, the NIC will be put in low power state.
491 * From that point on, the HW will be stopped but will still issue an
492 * interrupt if the HW RF kill switch is triggered.
493 * This callback must do the right thing and not crash even if %start_hw()
494 * was called but not &start_fw(). May sleep.
495 * @d3_suspend: put the device into the correct mode for WoWLAN during
496 * suspend. This is optional, if not implemented WoWLAN will not be
497 * supported. This callback may sleep.
498 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
499 * talk to the WoWLAN image to get its status. This is optional, if not
500 * implemented WoWLAN will not be supported. This callback may sleep.
501 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
502 * If RFkill is asserted in the middle of a SYNC host command, it must
503 * return -ERFKILL straight away.
504 * May sleep only if CMD_ASYNC is not set
507 * @reclaim: free packet until ssn. Returns a list of freed packets.
509 * @txq_enable: setup a queue. To setup an AC queue, use the
510 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
511 * this one. The op_mode must not configure the HCMD queue. The scheduler
512 * configuration may be %NULL, in which case the hardware will not be
513 * configured. May sleep.
514 * @txq_disable: de-configure a Tx queue to send AMPDUs
516 * @wait_tx_queue_empty: wait until tx queues are empty. May sleep.
517 * @freeze_txq_timer: prevents the timer of the queue from firing until the
518 * queue is set to awake. Must be atomic.
519 * @dbgfs_register: add the dbgfs files under this directory. Files will be
520 * automatically deleted.
521 * @write8: write a u8 to a register at offset ofs from the BAR
522 * @write32: write a u32 to a register at offset ofs from the BAR
523 * @read32: read a u32 register at offset ofs from the BAR
524 * @read_prph: read a DWORD from a periphery register
525 * @write_prph: write a DWORD to a periphery register
526 * @read_mem: read device's SRAM in DWORD
527 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
529 * @configure: configure parameters required by the transport layer from
530 * the op_mode. May be called several times before start_fw, can't be
532 * @set_pmi: set the power pmi state
533 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
534 * Sleeping is not allowed between grab_nic_access and
535 * release_nic_access.
536 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
537 * must be the same one that was sent before to the grab_nic_access.
538 * @set_bits_mask - set SRAM register according to value and mask.
539 * @ref: grab a reference to the transport/FW layers, disallowing
540 * certain low power states
541 * @unref: release a reference previously taken with @ref. Note that
542 * initially the reference count is 1, making an initial @unref
543 * necessary to allow low power states.
544 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last
545 * TX'ed commands and similar. The buffer will be vfree'd by the caller.
546 * Note that the transport must fill in the proper file headers.
548 struct iwl_trans_ops
{
550 int (*start_hw
)(struct iwl_trans
*iwl_trans
, bool low_power
);
551 void (*op_mode_leave
)(struct iwl_trans
*iwl_trans
);
552 int (*start_fw
)(struct iwl_trans
*trans
, const struct fw_img
*fw
,
554 int (*update_sf
)(struct iwl_trans
*trans
,
555 struct iwl_sf_region
*st_fwrd_space
);
556 void (*fw_alive
)(struct iwl_trans
*trans
, u32 scd_addr
);
557 void (*stop_device
)(struct iwl_trans
*trans
, bool low_power
);
559 void (*d3_suspend
)(struct iwl_trans
*trans
, bool test
);
560 int (*d3_resume
)(struct iwl_trans
*trans
, enum iwl_d3_status
*status
,
563 int (*send_cmd
)(struct iwl_trans
*trans
, struct iwl_host_cmd
*cmd
);
565 int (*tx
)(struct iwl_trans
*trans
, struct sk_buff
*skb
,
566 struct iwl_device_cmd
*dev_cmd
, int queue
);
567 void (*reclaim
)(struct iwl_trans
*trans
, int queue
, int ssn
,
568 struct sk_buff_head
*skbs
);
570 void (*txq_enable
)(struct iwl_trans
*trans
, int queue
, u16 ssn
,
571 const struct iwl_trans_txq_scd_cfg
*cfg
,
572 unsigned int queue_wdg_timeout
);
573 void (*txq_disable
)(struct iwl_trans
*trans
, int queue
,
576 int (*dbgfs_register
)(struct iwl_trans
*trans
, struct dentry
* dir
);
577 int (*wait_tx_queue_empty
)(struct iwl_trans
*trans
, u32 txq_bm
);
578 void (*freeze_txq_timer
)(struct iwl_trans
*trans
, unsigned long txqs
,
581 void (*write8
)(struct iwl_trans
*trans
, u32 ofs
, u8 val
);
582 void (*write32
)(struct iwl_trans
*trans
, u32 ofs
, u32 val
);
583 u32 (*read32
)(struct iwl_trans
*trans
, u32 ofs
);
584 u32 (*read_prph
)(struct iwl_trans
*trans
, u32 ofs
);
585 void (*write_prph
)(struct iwl_trans
*trans
, u32 ofs
, u32 val
);
586 int (*read_mem
)(struct iwl_trans
*trans
, u32 addr
,
587 void *buf
, int dwords
);
588 int (*write_mem
)(struct iwl_trans
*trans
, u32 addr
,
589 const void *buf
, int dwords
);
590 void (*configure
)(struct iwl_trans
*trans
,
591 const struct iwl_trans_config
*trans_cfg
);
592 void (*set_pmi
)(struct iwl_trans
*trans
, bool state
);
593 bool (*grab_nic_access
)(struct iwl_trans
*trans
, bool silent
,
594 unsigned long *flags
);
595 void (*release_nic_access
)(struct iwl_trans
*trans
,
596 unsigned long *flags
);
597 void (*set_bits_mask
)(struct iwl_trans
*trans
, u32 reg
, u32 mask
,
599 void (*ref
)(struct iwl_trans
*trans
);
600 void (*unref
)(struct iwl_trans
*trans
);
601 int (*suspend
)(struct iwl_trans
*trans
);
602 void (*resume
)(struct iwl_trans
*trans
);
604 struct iwl_trans_dump_data
*(*dump_data
)(struct iwl_trans
*trans
);
608 * enum iwl_trans_state - state of the transport layer
610 * @IWL_TRANS_NO_FW: no fw has sent an alive response
611 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
613 enum iwl_trans_state
{
615 IWL_TRANS_FW_ALIVE
= 1,
619 * enum iwl_d0i3_mode - d0i3 mode
621 * @IWL_D0I3_MODE_OFF - d0i3 is disabled
622 * @IWL_D0I3_MODE_ON_IDLE - enter d0i3 when device is idle
623 * (e.g. no active references)
624 * @IWL_D0I3_MODE_ON_SUSPEND - enter d0i3 only on suspend
625 * (in case of 'any' trigger)
628 IWL_D0I3_MODE_OFF
= 0,
629 IWL_D0I3_MODE_ON_IDLE
,
630 IWL_D0I3_MODE_ON_SUSPEND
,
634 * struct iwl_trans - transport common data
636 * @ops - pointer to iwl_trans_ops
637 * @op_mode - pointer to the op_mode
638 * @cfg - pointer to the configuration
639 * @status: a bit-mask of transport status flags
640 * @dev - pointer to struct device * that represents the device
641 * @hw_id: a u32 with the ID of the device / sub-device.
642 * Set during transport allocation.
643 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
644 * @pm_support: set to true in start_hw if link pm is supported
645 * @ltr_enabled: set to true if the LTR is enabled
646 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
647 * The user should use iwl_trans_{alloc,free}_tx_cmd.
648 * @dev_cmd_headroom: room needed for the transport's private use before the
649 * device_cmd for Tx - for internal use only
650 * The user should use iwl_trans_{alloc,free}_tx_cmd.
651 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
652 * starting the firmware, used for tracing
653 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
654 * start of the 802.11 header in the @rx_mpdu_cmd
655 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
656 * @dbg_dest_tlv: points to the destination TLV for debug
657 * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
658 * @dbg_trigger_tlv: array of pointers to triggers TLVs for debug
659 * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
662 const struct iwl_trans_ops
*ops
;
663 struct iwl_op_mode
*op_mode
;
664 const struct iwl_cfg
*cfg
;
665 enum iwl_trans_state state
;
666 unsigned long status
;
673 u8 rx_mpdu_cmd
, rx_mpdu_cmd_hdr_size
;
678 /* The following fields are internal only */
679 struct kmem_cache
*dev_cmd_pool
;
680 size_t dev_cmd_headroom
;
681 char dev_cmd_pool_name
[50];
683 struct dentry
*dbgfs_dir
;
685 #ifdef CONFIG_LOCKDEP
686 struct lockdep_map sync_cmd_lockdep_map
;
691 const struct iwl_fw_dbg_dest_tlv
*dbg_dest_tlv
;
692 const struct iwl_fw_dbg_conf_tlv
*dbg_conf_tlv
[FW_DBG_CONF_MAX
];
693 struct iwl_fw_dbg_trigger_tlv
* const *dbg_trigger_tlv
;
696 enum iwl_d0i3_mode d0i3_mode
;
700 /* pointer to trans specific struct */
701 /*Ensure that this pointer will always be aligned to sizeof pointer */
702 char trans_specific
[0] __aligned(sizeof(void *));
705 static inline void iwl_trans_configure(struct iwl_trans
*trans
,
706 const struct iwl_trans_config
*trans_cfg
)
708 trans
->op_mode
= trans_cfg
->op_mode
;
710 trans
->ops
->configure(trans
, trans_cfg
);
713 static inline int _iwl_trans_start_hw(struct iwl_trans
*trans
, bool low_power
)
717 return trans
->ops
->start_hw(trans
, low_power
);
720 static inline int iwl_trans_start_hw(struct iwl_trans
*trans
)
722 return trans
->ops
->start_hw(trans
, true);
725 static inline void iwl_trans_op_mode_leave(struct iwl_trans
*trans
)
729 if (trans
->ops
->op_mode_leave
)
730 trans
->ops
->op_mode_leave(trans
);
732 trans
->op_mode
= NULL
;
734 trans
->state
= IWL_TRANS_NO_FW
;
737 static inline void iwl_trans_fw_alive(struct iwl_trans
*trans
, u32 scd_addr
)
741 trans
->state
= IWL_TRANS_FW_ALIVE
;
743 trans
->ops
->fw_alive(trans
, scd_addr
);
746 static inline int iwl_trans_start_fw(struct iwl_trans
*trans
,
747 const struct fw_img
*fw
,
752 WARN_ON_ONCE(!trans
->rx_mpdu_cmd
);
754 clear_bit(STATUS_FW_ERROR
, &trans
->status
);
755 return trans
->ops
->start_fw(trans
, fw
, run_in_rfkill
);
758 static inline int iwl_trans_update_sf(struct iwl_trans
*trans
,
759 struct iwl_sf_region
*st_fwrd_space
)
763 if (trans
->ops
->update_sf
)
764 return trans
->ops
->update_sf(trans
, st_fwrd_space
);
769 static inline void _iwl_trans_stop_device(struct iwl_trans
*trans
,
774 trans
->ops
->stop_device(trans
, low_power
);
776 trans
->state
= IWL_TRANS_NO_FW
;
779 static inline void iwl_trans_stop_device(struct iwl_trans
*trans
)
781 _iwl_trans_stop_device(trans
, true);
784 static inline void iwl_trans_d3_suspend(struct iwl_trans
*trans
, bool test
)
787 trans
->ops
->d3_suspend(trans
, test
);
790 static inline int iwl_trans_d3_resume(struct iwl_trans
*trans
,
791 enum iwl_d3_status
*status
,
795 return trans
->ops
->d3_resume(trans
, status
, test
);
798 static inline void iwl_trans_ref(struct iwl_trans
*trans
)
801 trans
->ops
->ref(trans
);
804 static inline void iwl_trans_unref(struct iwl_trans
*trans
)
806 if (trans
->ops
->unref
)
807 trans
->ops
->unref(trans
);
810 static inline int iwl_trans_suspend(struct iwl_trans
*trans
)
812 if (!trans
->ops
->suspend
)
815 return trans
->ops
->suspend(trans
);
818 static inline void iwl_trans_resume(struct iwl_trans
*trans
)
820 if (trans
->ops
->resume
)
821 trans
->ops
->resume(trans
);
824 static inline struct iwl_trans_dump_data
*
825 iwl_trans_dump_data(struct iwl_trans
*trans
)
827 if (!trans
->ops
->dump_data
)
829 return trans
->ops
->dump_data(trans
);
832 static inline int iwl_trans_send_cmd(struct iwl_trans
*trans
,
833 struct iwl_host_cmd
*cmd
)
837 if (unlikely(!(cmd
->flags
& CMD_SEND_IN_RFKILL
) &&
838 test_bit(STATUS_RFKILL
, &trans
->status
)))
841 if (unlikely(test_bit(STATUS_FW_ERROR
, &trans
->status
)))
844 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
)) {
845 IWL_ERR(trans
, "%s bad state = %d\n", __func__
, trans
->state
);
849 if (!(cmd
->flags
& CMD_ASYNC
))
850 lock_map_acquire_read(&trans
->sync_cmd_lockdep_map
);
852 ret
= trans
->ops
->send_cmd(trans
, cmd
);
854 if (!(cmd
->flags
& CMD_ASYNC
))
855 lock_map_release(&trans
->sync_cmd_lockdep_map
);
860 static inline struct iwl_device_cmd
*
861 iwl_trans_alloc_tx_cmd(struct iwl_trans
*trans
)
863 u8
*dev_cmd_ptr
= kmem_cache_alloc(trans
->dev_cmd_pool
, GFP_ATOMIC
);
865 if (unlikely(dev_cmd_ptr
== NULL
))
868 return (struct iwl_device_cmd
*)
869 (dev_cmd_ptr
+ trans
->dev_cmd_headroom
);
872 static inline void iwl_trans_free_tx_cmd(struct iwl_trans
*trans
,
873 struct iwl_device_cmd
*dev_cmd
)
875 u8
*dev_cmd_ptr
= (u8
*)dev_cmd
- trans
->dev_cmd_headroom
;
877 kmem_cache_free(trans
->dev_cmd_pool
, dev_cmd_ptr
);
880 static inline int iwl_trans_tx(struct iwl_trans
*trans
, struct sk_buff
*skb
,
881 struct iwl_device_cmd
*dev_cmd
, int queue
)
883 if (unlikely(test_bit(STATUS_FW_ERROR
, &trans
->status
)))
886 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
887 IWL_ERR(trans
, "%s bad state = %d\n", __func__
, trans
->state
);
889 return trans
->ops
->tx(trans
, skb
, dev_cmd
, queue
);
892 static inline void iwl_trans_reclaim(struct iwl_trans
*trans
, int queue
,
893 int ssn
, struct sk_buff_head
*skbs
)
895 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
896 IWL_ERR(trans
, "%s bad state = %d\n", __func__
, trans
->state
);
898 trans
->ops
->reclaim(trans
, queue
, ssn
, skbs
);
901 static inline void iwl_trans_txq_disable(struct iwl_trans
*trans
, int queue
,
904 trans
->ops
->txq_disable(trans
, queue
, configure_scd
);
908 iwl_trans_txq_enable_cfg(struct iwl_trans
*trans
, int queue
, u16 ssn
,
909 const struct iwl_trans_txq_scd_cfg
*cfg
,
910 unsigned int queue_wdg_timeout
)
914 if (unlikely((trans
->state
!= IWL_TRANS_FW_ALIVE
)))
915 IWL_ERR(trans
, "%s bad state = %d\n", __func__
, trans
->state
);
917 trans
->ops
->txq_enable(trans
, queue
, ssn
, cfg
, queue_wdg_timeout
);
920 static inline void iwl_trans_txq_enable(struct iwl_trans
*trans
, int queue
,
921 int fifo
, int sta_id
, int tid
,
922 int frame_limit
, u16 ssn
,
923 unsigned int queue_wdg_timeout
)
925 struct iwl_trans_txq_scd_cfg cfg
= {
929 .frame_limit
= frame_limit
,
930 .aggregate
= sta_id
>= 0,
933 iwl_trans_txq_enable_cfg(trans
, queue
, ssn
, &cfg
, queue_wdg_timeout
);
937 void iwl_trans_ac_txq_enable(struct iwl_trans
*trans
, int queue
, int fifo
,
938 unsigned int queue_wdg_timeout
)
940 struct iwl_trans_txq_scd_cfg cfg
= {
943 .tid
= IWL_MAX_TID_COUNT
,
944 .frame_limit
= IWL_FRAME_LIMIT
,
948 iwl_trans_txq_enable_cfg(trans
, queue
, 0, &cfg
, queue_wdg_timeout
);
951 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans
*trans
,
955 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
956 IWL_ERR(trans
, "%s bad state = %d\n", __func__
, trans
->state
);
958 if (trans
->ops
->freeze_txq_timer
)
959 trans
->ops
->freeze_txq_timer(trans
, txqs
, freeze
);
962 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans
*trans
,
965 if (unlikely(trans
->state
!= IWL_TRANS_FW_ALIVE
))
966 IWL_ERR(trans
, "%s bad state = %d\n", __func__
, trans
->state
);
968 return trans
->ops
->wait_tx_queue_empty(trans
, txqs
);
971 static inline int iwl_trans_dbgfs_register(struct iwl_trans
*trans
,
974 return trans
->ops
->dbgfs_register(trans
, dir
);
977 static inline void iwl_trans_write8(struct iwl_trans
*trans
, u32 ofs
, u8 val
)
979 trans
->ops
->write8(trans
, ofs
, val
);
982 static inline void iwl_trans_write32(struct iwl_trans
*trans
, u32 ofs
, u32 val
)
984 trans
->ops
->write32(trans
, ofs
, val
);
987 static inline u32
iwl_trans_read32(struct iwl_trans
*trans
, u32 ofs
)
989 return trans
->ops
->read32(trans
, ofs
);
992 static inline u32
iwl_trans_read_prph(struct iwl_trans
*trans
, u32 ofs
)
994 return trans
->ops
->read_prph(trans
, ofs
);
997 static inline void iwl_trans_write_prph(struct iwl_trans
*trans
, u32 ofs
,
1000 return trans
->ops
->write_prph(trans
, ofs
, val
);
1003 static inline int iwl_trans_read_mem(struct iwl_trans
*trans
, u32 addr
,
1004 void *buf
, int dwords
)
1006 return trans
->ops
->read_mem(trans
, addr
, buf
, dwords
);
1009 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
1011 if (__builtin_constant_p(bufsize)) \
1012 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
1013 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
1016 static inline u32
iwl_trans_read_mem32(struct iwl_trans
*trans
, u32 addr
)
1020 if (WARN_ON(iwl_trans_read_mem(trans
, addr
, &value
, 1)))
1026 static inline int iwl_trans_write_mem(struct iwl_trans
*trans
, u32 addr
,
1027 const void *buf
, int dwords
)
1029 return trans
->ops
->write_mem(trans
, addr
, buf
, dwords
);
1032 static inline u32
iwl_trans_write_mem32(struct iwl_trans
*trans
, u32 addr
,
1035 return iwl_trans_write_mem(trans
, addr
, &val
, 1);
1038 static inline void iwl_trans_set_pmi(struct iwl_trans
*trans
, bool state
)
1040 if (trans
->ops
->set_pmi
)
1041 trans
->ops
->set_pmi(trans
, state
);
1045 iwl_trans_set_bits_mask(struct iwl_trans
*trans
, u32 reg
, u32 mask
, u32 value
)
1047 trans
->ops
->set_bits_mask(trans
, reg
, mask
, value
);
1050 #define iwl_trans_grab_nic_access(trans, silent, flags) \
1051 __cond_lock(nic_access, \
1052 likely((trans)->ops->grab_nic_access(trans, silent, flags)))
1054 static inline void __releases(nic_access
)
1055 iwl_trans_release_nic_access(struct iwl_trans
*trans
, unsigned long *flags
)
1057 trans
->ops
->release_nic_access(trans
, flags
);
1058 __release(nic_access
);
1061 static inline void iwl_trans_fw_error(struct iwl_trans
*trans
)
1063 if (WARN_ON_ONCE(!trans
->op_mode
))
1066 /* prevent double restarts due to the same erroneous FW */
1067 if (!test_and_set_bit(STATUS_FW_ERROR
, &trans
->status
))
1068 iwl_op_mode_nic_error(trans
->op_mode
);
1071 /*****************************************************
1072 * transport helper functions
1073 *****************************************************/
1074 struct iwl_trans
*iwl_trans_alloc(unsigned int priv_size
,
1076 const struct iwl_cfg
*cfg
,
1077 const struct iwl_trans_ops
*ops
,
1078 size_t dev_cmd_headroom
);
1079 void iwl_trans_free(struct iwl_trans
*trans
);
1081 /*****************************************************
1082 * driver (transport) register/unregister functions
1083 ******************************************************/
1084 int __must_check
iwl_pci_register_driver(void);
1085 void iwl_pci_unregister_driver(void);
1087 #endif /* __iwl_trans_h__ */