18e99ea8dSJohannes Berg /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 28e99ea8dSJohannes Berg /* 385b17a33SJohannes Berg * Copyright (C) 2005-2014, 2018-2022 Intel Corporation 48e99ea8dSJohannes Berg * Copyright (C) 2013-2015 Intel Mobile Communications GmbH 58e99ea8dSJohannes Berg * Copyright (C) 2016-2017 Intel Deutschland GmbH 68e99ea8dSJohannes Berg */ 7e705c121SKalle Valo #ifndef __iwl_trans_h__ 8e705c121SKalle Valo #define __iwl_trans_h__ 9e705c121SKalle Valo 10e705c121SKalle Valo #include <linux/ieee80211.h> 11e705c121SKalle Valo #include <linux/mm.h> /* for page_address */ 12e705c121SKalle Valo #include <linux/lockdep.h> 1339bdb17eSSharon Dvir #include <linux/kernel.h> 14e705c121SKalle Valo 15e705c121SKalle Valo #include "iwl-debug.h" 16e705c121SKalle Valo #include "iwl-config.h" 17d962f9b1SJohannes Berg #include "fw/img.h" 18e705c121SKalle Valo #include "iwl-op-mode.h" 1969725928SLuca Coelho #include <linux/firmware.h> 20d172a5efSJohannes Berg #include "fw/api/cmdhdr.h" 21d172a5efSJohannes Berg #include "fw/api/txq.h" 22f14cda6fSSara Sharon #include "fw/api/dbg-tlv.h" 23f14cda6fSSara Sharon #include "iwl-dbg-tlv.h" 24e705c121SKalle Valo 25e705c121SKalle Valo /** 26e705c121SKalle Valo * DOC: Transport layer - what is it ? 27e705c121SKalle Valo * 28e705c121SKalle Valo * The transport layer is the layer that deals with the HW directly. It provides 29e705c121SKalle Valo * an abstraction of the underlying HW to the upper layer. The transport layer 30e705c121SKalle Valo * doesn't provide any policy, algorithm or anything of this kind, but only 31e705c121SKalle Valo * mechanisms to make the HW do something. It is not completely stateless but 32e705c121SKalle Valo * close to it. 33e705c121SKalle Valo * We will have an implementation for each different supported bus. 34e705c121SKalle Valo */ 35e705c121SKalle Valo 36e705c121SKalle Valo /** 37e705c121SKalle Valo * DOC: Life cycle of the transport layer 38e705c121SKalle Valo * 39e705c121SKalle Valo * The transport layer has a very precise life cycle. 40e705c121SKalle Valo * 41e705c121SKalle Valo * 1) A helper function is called during the module initialization and 42e705c121SKalle Valo * registers the bus driver's ops with the transport's alloc function. 43e705c121SKalle Valo * 2) Bus's probe calls to the transport layer's allocation functions. 44e705c121SKalle Valo * Of course this function is bus specific. 45e705c121SKalle Valo * 3) This allocation functions will spawn the upper layer which will 46e705c121SKalle Valo * register mac80211. 47e705c121SKalle Valo * 48e705c121SKalle Valo * 4) At some point (i.e. mac80211's start call), the op_mode will call 49e705c121SKalle Valo * the following sequence: 50e705c121SKalle Valo * start_hw 51e705c121SKalle Valo * start_fw 52e705c121SKalle Valo * 53e705c121SKalle Valo * 5) Then when finished (or reset): 54e705c121SKalle Valo * stop_device 55e705c121SKalle Valo * 56e705c121SKalle Valo * 6) Eventually, the free function will be called. 57e705c121SKalle Valo */ 58e705c121SKalle Valo 59e701da0cSLuca Coelho #define IWL_TRANS_FW_DBG_DOMAIN(trans) IWL_FW_INI_DOMAIN_ALWAYS_ON 60e701da0cSLuca Coelho 61e705c121SKalle Valo #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */ 62e705c121SKalle Valo #define FH_RSCSR_FRAME_INVALID 0x55550000 63e705c121SKalle Valo #define FH_RSCSR_FRAME_ALIGN 0x40 64fbe41127SSara Sharon #define FH_RSCSR_RPA_EN BIT(25) 659d0fc5a5SDavid Spinadel #define FH_RSCSR_RADA_EN BIT(26) 66ab2e696bSSara Sharon #define FH_RSCSR_RXQ_POS 16 67ab2e696bSSara Sharon #define FH_RSCSR_RXQ_MASK 0x3F0000 68e705c121SKalle Valo 69e705c121SKalle Valo struct iwl_rx_packet { 70e705c121SKalle Valo /* 71e705c121SKalle Valo * The first 4 bytes of the RX frame header contain both the RX frame 72e705c121SKalle Valo * size and some flags. 73e705c121SKalle Valo * Bit fields: 74e705c121SKalle Valo * 31: flag flush RB request 75e705c121SKalle Valo * 30: flag ignore TC (terminal counter) request 76e705c121SKalle Valo * 29: flag fast IRQ request 779d0fc5a5SDavid Spinadel * 28-27: Reserved 789d0fc5a5SDavid Spinadel * 26: RADA enabled 79fbe41127SSara Sharon * 25: Offload enabled 80ab2e696bSSara Sharon * 24: RPF enabled 81ab2e696bSSara Sharon * 23: RSS enabled 82ab2e696bSSara Sharon * 22: Checksum enabled 83ab2e696bSSara Sharon * 21-16: RX queue 84ab2e696bSSara Sharon * 15-14: Reserved 85e705c121SKalle Valo * 13-00: RX frame size 86e705c121SKalle Valo */ 87e705c121SKalle Valo __le32 len_n_flags; 88e705c121SKalle Valo struct iwl_cmd_header hdr; 89e705c121SKalle Valo u8 data[]; 90e705c121SKalle Valo } __packed; 91e705c121SKalle Valo 92e705c121SKalle Valo static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt) 93e705c121SKalle Valo { 94e705c121SKalle Valo return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK; 95e705c121SKalle Valo } 96e705c121SKalle Valo 97e705c121SKalle Valo static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt) 98e705c121SKalle Valo { 99e705c121SKalle Valo return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr); 100e705c121SKalle Valo } 101e705c121SKalle Valo 102e705c121SKalle Valo /** 103e705c121SKalle Valo * enum CMD_MODE - how to send the host commands ? 104e705c121SKalle Valo * 105e705c121SKalle Valo * @CMD_ASYNC: Return right away and don't wait for the response 106e705c121SKalle Valo * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of 107e705c121SKalle Valo * the response. The caller needs to call iwl_free_resp when done. 108dcbb4746SEmmanuel Grumbach * @CMD_WANT_ASYNC_CALLBACK: the op_mode's async callback function must be 109dcbb4746SEmmanuel Grumbach * called after this command completes. Valid only with CMD_ASYNC. 110708a39aaSHaim Dreyfuss * @CMD_SEND_IN_D3: Allow the command to be sent in D3 mode, relevant to 111708a39aaSHaim Dreyfuss * SUSPEND and RESUME commands. We are in D3 mode when we set 112708a39aaSHaim Dreyfuss * trans->system_pm_mode to IWL_PLAT_PM_MODE_D3. 113e705c121SKalle Valo */ 114e705c121SKalle Valo enum CMD_MODE { 115e705c121SKalle Valo CMD_ASYNC = BIT(0), 116e705c121SKalle Valo CMD_WANT_SKB = BIT(1), 117e705c121SKalle Valo CMD_SEND_IN_RFKILL = BIT(2), 118043fa901SEmmanuel Grumbach CMD_WANT_ASYNC_CALLBACK = BIT(3), 119708a39aaSHaim Dreyfuss CMD_SEND_IN_D3 = BIT(4), 120e705c121SKalle Valo }; 121e705c121SKalle Valo 122e705c121SKalle Valo #define DEF_CMD_PAYLOAD_SIZE 320 123e705c121SKalle Valo 124e705c121SKalle Valo /** 125e705c121SKalle Valo * struct iwl_device_cmd 126e705c121SKalle Valo * 127e705c121SKalle Valo * For allocation of the command and tx queues, this establishes the overall 128e705c121SKalle Valo * size of the largest command we send to uCode, except for commands that 129e705c121SKalle Valo * aren't fully copied and use other TFD space. 130e705c121SKalle Valo */ 131e705c121SKalle Valo struct iwl_device_cmd { 132e705c121SKalle Valo union { 133e705c121SKalle Valo struct { 134e705c121SKalle Valo struct iwl_cmd_header hdr; /* uCode API */ 135e705c121SKalle Valo u8 payload[DEF_CMD_PAYLOAD_SIZE]; 136e705c121SKalle Valo }; 137e705c121SKalle Valo struct { 138e705c121SKalle Valo struct iwl_cmd_header_wide hdr_wide; 139e705c121SKalle Valo u8 payload_wide[DEF_CMD_PAYLOAD_SIZE - 140e705c121SKalle Valo sizeof(struct iwl_cmd_header_wide) + 141e705c121SKalle Valo sizeof(struct iwl_cmd_header)]; 142e705c121SKalle Valo }; 143e705c121SKalle Valo }; 144e705c121SKalle Valo } __packed; 145e705c121SKalle Valo 146a89c72ffSJohannes Berg /** 147a89c72ffSJohannes Berg * struct iwl_device_tx_cmd - buffer for TX command 148a89c72ffSJohannes Berg * @hdr: the header 149a89c72ffSJohannes Berg * @payload: the payload placeholder 150a89c72ffSJohannes Berg * 151a89c72ffSJohannes Berg * The actual structure is sized dynamically according to need. 152a89c72ffSJohannes Berg */ 153a89c72ffSJohannes Berg struct iwl_device_tx_cmd { 154a89c72ffSJohannes Berg struct iwl_cmd_header hdr; 155a89c72ffSJohannes Berg u8 payload[]; 156a89c72ffSJohannes Berg } __packed; 157a89c72ffSJohannes Berg 158e705c121SKalle Valo #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd)) 159e705c121SKalle Valo 160e705c121SKalle Valo /* 161e705c121SKalle Valo * number of transfer buffers (fragments) per transmit frame descriptor; 162e705c121SKalle Valo * this is just the driver's idea, the hardware supports 20 163e705c121SKalle Valo */ 164e705c121SKalle Valo #define IWL_MAX_CMD_TBS_PER_TFD 2 165e705c121SKalle Valo 166885375d0SMordechay Goodstein /* We need 2 entries for the TX command and header, and another one might 167885375d0SMordechay Goodstein * be needed for potential data in the SKB's head. The remaining ones can 168885375d0SMordechay Goodstein * be used for frags. 169885375d0SMordechay Goodstein */ 170885375d0SMordechay Goodstein #define IWL_TRANS_MAX_FRAGS(trans) ((trans)->txqs.tfd.max_tbs - 3) 171885375d0SMordechay Goodstein 172e705c121SKalle Valo /** 173b8aed81cSJohannes Berg * enum iwl_hcmd_dataflag - flag for each one of the chunks of the command 174e705c121SKalle Valo * 175e705c121SKalle Valo * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's 176e705c121SKalle Valo * ring. The transport layer doesn't map the command's buffer to DMA, but 177e705c121SKalle Valo * rather copies it to a previously allocated DMA buffer. This flag tells 178e705c121SKalle Valo * the transport layer not to copy the command, but to map the existing 179e705c121SKalle Valo * buffer (that is passed in) instead. This saves the memcpy and allows 180e705c121SKalle Valo * commands that are bigger than the fixed buffer to be submitted. 181e705c121SKalle Valo * Note that a TFD entry after a NOCOPY one cannot be a normal copied one. 182e705c121SKalle Valo * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this 183e705c121SKalle Valo * chunk internally and free it again after the command completes. This 184e705c121SKalle Valo * can (currently) be used only once per command. 185e705c121SKalle Valo * Note that a TFD entry after a DUP one cannot be a normal copied one. 186e705c121SKalle Valo */ 187e705c121SKalle Valo enum iwl_hcmd_dataflag { 188e705c121SKalle Valo IWL_HCMD_DFL_NOCOPY = BIT(0), 189e705c121SKalle Valo IWL_HCMD_DFL_DUP = BIT(1), 190e705c121SKalle Valo }; 191e705c121SKalle Valo 19222463857SShahar S Matityahu enum iwl_error_event_table_status { 19322463857SShahar S Matityahu IWL_ERROR_EVENT_TABLE_LMAC1 = BIT(0), 19422463857SShahar S Matityahu IWL_ERROR_EVENT_TABLE_LMAC2 = BIT(1), 19522463857SShahar S Matityahu IWL_ERROR_EVENT_TABLE_UMAC = BIT(2), 19657417e1bSJohannes Berg IWL_ERROR_EVENT_TABLE_TCM1 = BIT(3), 19757417e1bSJohannes Berg IWL_ERROR_EVENT_TABLE_TCM2 = BIT(4), 1984cd177b4SJohannes Berg IWL_ERROR_EVENT_TABLE_RCM1 = BIT(5), 1994cd177b4SJohannes Berg IWL_ERROR_EVENT_TABLE_RCM2 = BIT(6), 20022463857SShahar S Matityahu }; 20122463857SShahar S Matityahu 202e705c121SKalle Valo /** 203e705c121SKalle Valo * struct iwl_host_cmd - Host command to the uCode 204e705c121SKalle Valo * 205e705c121SKalle Valo * @data: array of chunks that composes the data of the host command 206e705c121SKalle Valo * @resp_pkt: response packet, if %CMD_WANT_SKB was set 207e705c121SKalle Valo * @_rx_page_order: (internally used to free response packet) 208e705c121SKalle Valo * @_rx_page_addr: (internally used to free response packet) 209e705c121SKalle Valo * @flags: can be CMD_* 210e705c121SKalle Valo * @len: array of the lengths of the chunks in data 211e705c121SKalle Valo * @dataflags: IWL_HCMD_DFL_* 212e705c121SKalle Valo * @id: command id of the host command, for wide commands encoding the 213e705c121SKalle Valo * version and group as well 214e705c121SKalle Valo */ 215e705c121SKalle Valo struct iwl_host_cmd { 216e705c121SKalle Valo const void *data[IWL_MAX_CMD_TBS_PER_TFD]; 217e705c121SKalle Valo struct iwl_rx_packet *resp_pkt; 218e705c121SKalle Valo unsigned long _rx_page_addr; 219e705c121SKalle Valo u32 _rx_page_order; 220e705c121SKalle Valo 221e705c121SKalle Valo u32 flags; 222e705c121SKalle Valo u32 id; 223e705c121SKalle Valo u16 len[IWL_MAX_CMD_TBS_PER_TFD]; 224e705c121SKalle Valo u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD]; 225e705c121SKalle Valo }; 226e705c121SKalle Valo 227e705c121SKalle Valo static inline void iwl_free_resp(struct iwl_host_cmd *cmd) 228e705c121SKalle Valo { 229e705c121SKalle Valo free_pages(cmd->_rx_page_addr, cmd->_rx_page_order); 230e705c121SKalle Valo } 231e705c121SKalle Valo 232e705c121SKalle Valo struct iwl_rx_cmd_buffer { 233e705c121SKalle Valo struct page *_page; 234e705c121SKalle Valo int _offset; 235e705c121SKalle Valo bool _page_stolen; 236e705c121SKalle Valo u32 _rx_page_order; 237e705c121SKalle Valo unsigned int truesize; 238e705c121SKalle Valo }; 239e705c121SKalle Valo 240e705c121SKalle Valo static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r) 241e705c121SKalle Valo { 242e705c121SKalle Valo return (void *)((unsigned long)page_address(r->_page) + r->_offset); 243e705c121SKalle Valo } 244e705c121SKalle Valo 245e705c121SKalle Valo static inline int rxb_offset(struct iwl_rx_cmd_buffer *r) 246e705c121SKalle Valo { 247e705c121SKalle Valo return r->_offset; 248e705c121SKalle Valo } 249e705c121SKalle Valo 250e705c121SKalle Valo static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r) 251e705c121SKalle Valo { 252e705c121SKalle Valo r->_page_stolen = true; 253e705c121SKalle Valo get_page(r->_page); 254e705c121SKalle Valo return r->_page; 255e705c121SKalle Valo } 256e705c121SKalle Valo 257e705c121SKalle Valo static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r) 258e705c121SKalle Valo { 259e705c121SKalle Valo __free_pages(r->_page, r->_rx_page_order); 260e705c121SKalle Valo } 261e705c121SKalle Valo 262e705c121SKalle Valo #define MAX_NO_RECLAIM_CMDS 6 263e705c121SKalle Valo 264e705c121SKalle Valo #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo)))) 265e705c121SKalle Valo 266e705c121SKalle Valo /* 267e705c121SKalle Valo * Maximum number of HW queues the transport layer 268e705c121SKalle Valo * currently supports 269e705c121SKalle Valo */ 270e705c121SKalle Valo #define IWL_MAX_HW_QUEUES 32 271e982bc2cSSara Sharon #define IWL_MAX_TVQM_QUEUES 512 272e982bc2cSSara Sharon 273e705c121SKalle Valo #define IWL_MAX_TID_COUNT 8 274c65f4e03SSara Sharon #define IWL_MGMT_TID 15 275e705c121SKalle Valo #define IWL_FRAME_LIMIT 64 276e705c121SKalle Valo #define IWL_MAX_RX_HW_QUEUES 16 2770cd38f4dSMordechay Goodstein #define IWL_9000_MAX_RX_HW_QUEUES 6 278e705c121SKalle Valo 279e705c121SKalle Valo /** 280e705c121SKalle Valo * enum iwl_wowlan_status - WoWLAN image/device status 281e705c121SKalle Valo * @IWL_D3_STATUS_ALIVE: firmware is still running after resume 282e705c121SKalle Valo * @IWL_D3_STATUS_RESET: device was reset while suspended 283e705c121SKalle Valo */ 284e705c121SKalle Valo enum iwl_d3_status { 285e705c121SKalle Valo IWL_D3_STATUS_ALIVE, 286e705c121SKalle Valo IWL_D3_STATUS_RESET, 287e705c121SKalle Valo }; 288e705c121SKalle Valo 289e705c121SKalle Valo /** 290e705c121SKalle Valo * enum iwl_trans_status: transport status flags 291e705c121SKalle Valo * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed 292e705c121SKalle Valo * @STATUS_DEVICE_ENABLED: APM is enabled 293e705c121SKalle Valo * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up) 294e705c121SKalle Valo * @STATUS_INT_ENABLED: interrupts are enabled 295326477e4SJohannes Berg * @STATUS_RFKILL_HW: the actual HW state of the RF-kill switch 296326477e4SJohannes Berg * @STATUS_RFKILL_OPMODE: RF-kill state reported to opmode 297e705c121SKalle Valo * @STATUS_FW_ERROR: the fw is in error state 298e705c121SKalle Valo * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands 299e705c121SKalle Valo * are sent 300e705c121SKalle Valo * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent 301e705c121SKalle Valo * @STATUS_TRANS_DEAD: trans is dead - avoid any read/write operation 3024b992db6SJohannes Berg * @STATUS_SUPPRESS_CMD_ERROR_ONCE: suppress "FW error in SYNC CMD" once, 3034b992db6SJohannes Berg * e.g. for testing 304e705c121SKalle Valo */ 305e705c121SKalle Valo enum iwl_trans_status { 306e705c121SKalle Valo STATUS_SYNC_HCMD_ACTIVE, 307e705c121SKalle Valo STATUS_DEVICE_ENABLED, 308e705c121SKalle Valo STATUS_TPOWER_PMI, 309e705c121SKalle Valo STATUS_INT_ENABLED, 310326477e4SJohannes Berg STATUS_RFKILL_HW, 311326477e4SJohannes Berg STATUS_RFKILL_OPMODE, 312e705c121SKalle Valo STATUS_FW_ERROR, 313e705c121SKalle Valo STATUS_TRANS_GOING_IDLE, 314e705c121SKalle Valo STATUS_TRANS_IDLE, 315e705c121SKalle Valo STATUS_TRANS_DEAD, 3164b992db6SJohannes Berg STATUS_SUPPRESS_CMD_ERROR_ONCE, 317e705c121SKalle Valo }; 318e705c121SKalle Valo 3196c4fbcbcSEmmanuel Grumbach static inline int 3206c4fbcbcSEmmanuel Grumbach iwl_trans_get_rb_size_order(enum iwl_amsdu_size rb_size) 3216c4fbcbcSEmmanuel Grumbach { 3226c4fbcbcSEmmanuel Grumbach switch (rb_size) { 3231a4968d1SGolan Ben Ami case IWL_AMSDU_2K: 3241a4968d1SGolan Ben Ami return get_order(2 * 1024); 3256c4fbcbcSEmmanuel Grumbach case IWL_AMSDU_4K: 3266c4fbcbcSEmmanuel Grumbach return get_order(4 * 1024); 3276c4fbcbcSEmmanuel Grumbach case IWL_AMSDU_8K: 3286c4fbcbcSEmmanuel Grumbach return get_order(8 * 1024); 3296c4fbcbcSEmmanuel Grumbach case IWL_AMSDU_12K: 3303fa965c2SJohannes Berg return get_order(16 * 1024); 3316c4fbcbcSEmmanuel Grumbach default: 3326c4fbcbcSEmmanuel Grumbach WARN_ON(1); 3336c4fbcbcSEmmanuel Grumbach return -1; 3346c4fbcbcSEmmanuel Grumbach } 3356c4fbcbcSEmmanuel Grumbach } 3366c4fbcbcSEmmanuel Grumbach 33780084e35SJohannes Berg static inline int 33880084e35SJohannes Berg iwl_trans_get_rb_size(enum iwl_amsdu_size rb_size) 33980084e35SJohannes Berg { 34080084e35SJohannes Berg switch (rb_size) { 34180084e35SJohannes Berg case IWL_AMSDU_2K: 34280084e35SJohannes Berg return 2 * 1024; 34380084e35SJohannes Berg case IWL_AMSDU_4K: 34480084e35SJohannes Berg return 4 * 1024; 34580084e35SJohannes Berg case IWL_AMSDU_8K: 34680084e35SJohannes Berg return 8 * 1024; 34780084e35SJohannes Berg case IWL_AMSDU_12K: 3483fa965c2SJohannes Berg return 16 * 1024; 34980084e35SJohannes Berg default: 35080084e35SJohannes Berg WARN_ON(1); 35180084e35SJohannes Berg return 0; 35280084e35SJohannes Berg } 35380084e35SJohannes Berg } 35480084e35SJohannes Berg 35539bdb17eSSharon Dvir struct iwl_hcmd_names { 35639bdb17eSSharon Dvir u8 cmd_id; 35739bdb17eSSharon Dvir const char *const cmd_name; 35839bdb17eSSharon Dvir }; 35939bdb17eSSharon Dvir 36039bdb17eSSharon Dvir #define HCMD_NAME(x) \ 36139bdb17eSSharon Dvir { .cmd_id = x, .cmd_name = #x } 36239bdb17eSSharon Dvir 36339bdb17eSSharon Dvir struct iwl_hcmd_arr { 36439bdb17eSSharon Dvir const struct iwl_hcmd_names *arr; 36539bdb17eSSharon Dvir int size; 36639bdb17eSSharon Dvir }; 36739bdb17eSSharon Dvir 36839bdb17eSSharon Dvir #define HCMD_ARR(x) \ 36939bdb17eSSharon Dvir { .arr = x, .size = ARRAY_SIZE(x) } 37039bdb17eSSharon Dvir 371e705c121SKalle Valo /** 372fdb70083SJohannes Berg * struct iwl_dump_sanitize_ops - dump sanitization operations 373fdb70083SJohannes Berg * @frob_txf: Scrub the TX FIFO data 374fdb70083SJohannes Berg * @frob_hcmd: Scrub a host command, the %hcmd pointer is to the header 375fdb70083SJohannes Berg * but that might be short or long (&struct iwl_cmd_header or 376fdb70083SJohannes Berg * &struct iwl_cmd_header_wide) 377fdb70083SJohannes Berg * @frob_mem: Scrub memory data 378fdb70083SJohannes Berg */ 379fdb70083SJohannes Berg struct iwl_dump_sanitize_ops { 380fdb70083SJohannes Berg void (*frob_txf)(void *ctx, void *buf, size_t buflen); 381fdb70083SJohannes Berg void (*frob_hcmd)(void *ctx, void *hcmd, size_t buflen); 382fdb70083SJohannes Berg void (*frob_mem)(void *ctx, u32 mem_addr, void *mem, size_t buflen); 383fdb70083SJohannes Berg }; 384fdb70083SJohannes Berg 385fdb70083SJohannes Berg /** 386e705c121SKalle Valo * struct iwl_trans_config - transport configuration 387e705c121SKalle Valo * 388e705c121SKalle Valo * @op_mode: pointer to the upper layer. 389e705c121SKalle Valo * @cmd_queue: the index of the command queue. 390e705c121SKalle Valo * Must be set before start_fw. 391e705c121SKalle Valo * @cmd_fifo: the fifo for host commands 392e705c121SKalle Valo * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue. 393e705c121SKalle Valo * @no_reclaim_cmds: Some devices erroneously don't set the 394e705c121SKalle Valo * SEQ_RX_FRAME bit on some notifications, this is the 395e705c121SKalle Valo * list of such notifications to filter. Max length is 396e705c121SKalle Valo * %MAX_NO_RECLAIM_CMDS. 397e705c121SKalle Valo * @n_no_reclaim_cmds: # of commands in list 3986c4fbcbcSEmmanuel Grumbach * @rx_buf_size: RX buffer size needed for A-MSDUs 399e705c121SKalle Valo * if unset 4k will be the RX buffer size 400e705c121SKalle Valo * @bc_table_dword: set to true if the BC table expects the byte count to be 401e705c121SKalle Valo * in DWORD (as opposed to bytes) 402e705c121SKalle Valo * @scd_set_active: should the transport configure the SCD for HCMD queue 40339bdb17eSSharon Dvir * @command_groups: array of command groups, each member is an array of the 40439bdb17eSSharon Dvir * commands in the group; for debugging only 40539bdb17eSSharon Dvir * @command_groups_size: number of command groups, to avoid illegal access 40621cb3222SJohannes Berg * @cb_data_offs: offset inside skb->cb to store transport data at, must have 40721cb3222SJohannes Berg * space for at least two pointers 408906d4eb8SJohannes Berg * @fw_reset_handshake: firmware supports reset flow handshake 409227f2597SJohannes Berg * @queue_alloc_cmd_ver: queue allocation command version, set to 0 410227f2597SJohannes Berg * for using the older SCD_QUEUE_CFG, set to the version of 411227f2597SJohannes Berg * SCD_QUEUE_CONFIG_CMD otherwise. 412e705c121SKalle Valo */ 413e705c121SKalle Valo struct iwl_trans_config { 414e705c121SKalle Valo struct iwl_op_mode *op_mode; 415e705c121SKalle Valo 416e705c121SKalle Valo u8 cmd_queue; 417e705c121SKalle Valo u8 cmd_fifo; 418e705c121SKalle Valo unsigned int cmd_q_wdg_timeout; 419e705c121SKalle Valo const u8 *no_reclaim_cmds; 420e705c121SKalle Valo unsigned int n_no_reclaim_cmds; 421e705c121SKalle Valo 4226c4fbcbcSEmmanuel Grumbach enum iwl_amsdu_size rx_buf_size; 423e705c121SKalle Valo bool bc_table_dword; 424e705c121SKalle Valo bool scd_set_active; 42539bdb17eSSharon Dvir const struct iwl_hcmd_arr *command_groups; 42639bdb17eSSharon Dvir int command_groups_size; 427e705c121SKalle Valo 42821cb3222SJohannes Berg u8 cb_data_offs; 429906d4eb8SJohannes Berg bool fw_reset_handshake; 430227f2597SJohannes Berg u8 queue_alloc_cmd_ver; 431e705c121SKalle Valo }; 432e705c121SKalle Valo 433e705c121SKalle Valo struct iwl_trans_dump_data { 434e705c121SKalle Valo u32 len; 435e705c121SKalle Valo u8 data[]; 436e705c121SKalle Valo }; 437e705c121SKalle Valo 438e705c121SKalle Valo struct iwl_trans; 439e705c121SKalle Valo 440e705c121SKalle Valo struct iwl_trans_txq_scd_cfg { 441e705c121SKalle Valo u8 fifo; 4422a2e9d10SLiad Kaufman u8 sta_id; 443e705c121SKalle Valo u8 tid; 444e705c121SKalle Valo bool aggregate; 445e705c121SKalle Valo int frame_limit; 446e705c121SKalle Valo }; 447e705c121SKalle Valo 4486b35ff91SSara Sharon /** 44992536c96SSara Sharon * struct iwl_trans_rxq_dma_data - RX queue DMA data 45092536c96SSara Sharon * @fr_bd_cb: DMA address of free BD cyclic buffer 45192536c96SSara Sharon * @fr_bd_wid: Initial write index of the free BD cyclic buffer 45292536c96SSara Sharon * @urbd_stts_wrptr: DMA address of urbd_stts_wrptr 45392536c96SSara Sharon * @ur_bd_cb: DMA address of used BD cyclic buffer 45492536c96SSara Sharon */ 45592536c96SSara Sharon struct iwl_trans_rxq_dma_data { 45692536c96SSara Sharon u64 fr_bd_cb; 45792536c96SSara Sharon u32 fr_bd_wid; 45892536c96SSara Sharon u64 urbd_stts_wrptr; 45992536c96SSara Sharon u64 ur_bd_cb; 46092536c96SSara Sharon }; 46192536c96SSara Sharon 46292536c96SSara Sharon /** 463e705c121SKalle Valo * struct iwl_trans_ops - transport specific operations 464e705c121SKalle Valo * 465e705c121SKalle Valo * All the handlers MUST be implemented 466e705c121SKalle Valo * 467bab3cb92SEmmanuel Grumbach * @start_hw: starts the HW. From that point on, the HW can send interrupts. 468bab3cb92SEmmanuel Grumbach * May sleep. 469e705c121SKalle Valo * @op_mode_leave: Turn off the HW RF kill indication if on 470e705c121SKalle Valo * May sleep 471e705c121SKalle Valo * @start_fw: allocates and inits all the resources for the transport 472e705c121SKalle Valo * layer. Also kick a fw image. 473e705c121SKalle Valo * May sleep 474e705c121SKalle Valo * @fw_alive: called when the fw sends alive notification. If the fw provides 475e705c121SKalle Valo * the SCD base address in SRAM, then provide it here, or 0 otherwise. 476e705c121SKalle Valo * May sleep 477e705c121SKalle Valo * @stop_device: stops the whole device (embedded CPU put to reset) and stops 478bab3cb92SEmmanuel Grumbach * the HW. From that point on, the HW will be stopped but will still issue 479bab3cb92SEmmanuel Grumbach * an interrupt if the HW RF kill switch is triggered. 480e705c121SKalle Valo * This callback must do the right thing and not crash even if %start_hw() 481e705c121SKalle Valo * was called but not &start_fw(). May sleep. 482e705c121SKalle Valo * @d3_suspend: put the device into the correct mode for WoWLAN during 483e705c121SKalle Valo * suspend. This is optional, if not implemented WoWLAN will not be 484e705c121SKalle Valo * supported. This callback may sleep. 485e705c121SKalle Valo * @d3_resume: resume the device after WoWLAN, enabling the opmode to 486e705c121SKalle Valo * talk to the WoWLAN image to get its status. This is optional, if not 487e705c121SKalle Valo * implemented WoWLAN will not be supported. This callback may sleep. 488e705c121SKalle Valo * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted. 489e705c121SKalle Valo * If RFkill is asserted in the middle of a SYNC host command, it must 490e705c121SKalle Valo * return -ERFKILL straight away. 491e705c121SKalle Valo * May sleep only if CMD_ASYNC is not set 4923f73b8caSEmmanuel Grumbach * @tx: send an skb. The transport relies on the op_mode to zero the 4936eb5e529SEmmanuel Grumbach * the ieee80211_tx_info->driver_data. If the MPDU is an A-MSDU, all 4946eb5e529SEmmanuel Grumbach * the CSUM will be taken care of (TCP CSUM and IP header in case of 4956eb5e529SEmmanuel Grumbach * IPv4). If the MPDU is a single MSDU, the op_mode must compute the IP 4966eb5e529SEmmanuel Grumbach * header if it is IPv4. 497e705c121SKalle Valo * Must be atomic 498e705c121SKalle Valo * @reclaim: free packet until ssn. Returns a list of freed packets. 499e705c121SKalle Valo * Must be atomic 500e705c121SKalle Valo * @txq_enable: setup a queue. To setup an AC queue, use the 501e705c121SKalle Valo * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before 502e705c121SKalle Valo * this one. The op_mode must not configure the HCMD queue. The scheduler 503e705c121SKalle Valo * configuration may be %NULL, in which case the hardware will not be 504dcfbd67bSEmmanuel Grumbach * configured. If true is returned, the operation mode needs to increment 505dcfbd67bSEmmanuel Grumbach * the sequence number of the packets routed to this queue because of a 506dcfbd67bSEmmanuel Grumbach * hardware scheduler bug. May sleep. 507e705c121SKalle Valo * @txq_disable: de-configure a Tx queue to send AMPDUs 508e705c121SKalle Valo * Must be atomic 50942db09c1SLiad Kaufman * @txq_set_shared_mode: change Tx queue shared/unshared marking 510d6d517b7SSara Sharon * @wait_tx_queues_empty: wait until tx queues are empty. May sleep. 511d6d517b7SSara Sharon * @wait_txq_empty: wait until specific tx queue is empty. May sleep. 512e705c121SKalle Valo * @freeze_txq_timer: prevents the timer of the queue from firing until the 513e705c121SKalle Valo * queue is set to awake. Must be atomic. 5140cd58eaaSEmmanuel Grumbach * @block_txq_ptrs: stop updating the write pointers of the Tx queues. Note 5150cd58eaaSEmmanuel Grumbach * that the transport needs to refcount the calls since this function 5160cd58eaaSEmmanuel Grumbach * will be called several times with block = true, and then the queues 5170cd58eaaSEmmanuel Grumbach * need to be unblocked only after the same number of calls with 5180cd58eaaSEmmanuel Grumbach * block = false. 519e705c121SKalle Valo * @write8: write a u8 to a register at offset ofs from the BAR 520e705c121SKalle Valo * @write32: write a u32 to a register at offset ofs from the BAR 521e705c121SKalle Valo * @read32: read a u32 register at offset ofs from the BAR 522e705c121SKalle Valo * @read_prph: read a DWORD from a periphery register 523e705c121SKalle Valo * @write_prph: write a DWORD to a periphery register 524e705c121SKalle Valo * @read_mem: read device's SRAM in DWORD 525e705c121SKalle Valo * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory 526e705c121SKalle Valo * will be zeroed. 527f696a7eeSLuca Coelho * @read_config32: read a u32 value from the device's config space at 528f696a7eeSLuca Coelho * the given offset. 529e705c121SKalle Valo * @configure: configure parameters required by the transport layer from 530e705c121SKalle Valo * the op_mode. May be called several times before start_fw, can't be 531e705c121SKalle Valo * called after that. 532e705c121SKalle Valo * @set_pmi: set the power pmi state 533e705c121SKalle Valo * @grab_nic_access: wake the NIC to be able to access non-HBUS regs. 534e705c121SKalle Valo * Sleeping is not allowed between grab_nic_access and 535e705c121SKalle Valo * release_nic_access. 536e705c121SKalle Valo * @release_nic_access: let the NIC go to sleep. The "flags" parameter 537e705c121SKalle Valo * must be the same one that was sent before to the grab_nic_access. 538e705c121SKalle Valo * @set_bits_mask - set SRAM register according to value and mask. 539e705c121SKalle Valo * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last 540e705c121SKalle Valo * TX'ed commands and similar. The buffer will be vfree'd by the caller. 541e705c121SKalle Valo * Note that the transport must fill in the proper file headers. 542f7805b33SLior Cohen * @debugfs_cleanup: used in the driver unload flow to make a proper cleanup 543f7805b33SLior Cohen * of the trans debugfs 544a182dfabSLuca Coelho * @set_pnvm: set the pnvm data in the prph scratch buffer, inside the 545a182dfabSLuca Coelho * context info. 5463161a34dSMordechay Goodstein * @interrupts: disable/enable interrupts to transport 547e705c121SKalle Valo */ 548e705c121SKalle Valo struct iwl_trans_ops { 549e705c121SKalle Valo 550bab3cb92SEmmanuel Grumbach int (*start_hw)(struct iwl_trans *iwl_trans); 551e705c121SKalle Valo void (*op_mode_leave)(struct iwl_trans *iwl_trans); 552e705c121SKalle Valo int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw, 553e705c121SKalle Valo bool run_in_rfkill); 554e705c121SKalle Valo void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr); 555bab3cb92SEmmanuel Grumbach void (*stop_device)(struct iwl_trans *trans); 556e705c121SKalle Valo 557e5f3f215SHaim Dreyfuss int (*d3_suspend)(struct iwl_trans *trans, bool test, bool reset); 558e705c121SKalle Valo int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status, 55923ae6128SMatti Gottlieb bool test, bool reset); 560e705c121SKalle Valo 561e705c121SKalle Valo int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd); 562e705c121SKalle Valo 563e705c121SKalle Valo int (*tx)(struct iwl_trans *trans, struct sk_buff *skb, 564a89c72ffSJohannes Berg struct iwl_device_tx_cmd *dev_cmd, int queue); 565e705c121SKalle Valo void (*reclaim)(struct iwl_trans *trans, int queue, int ssn, 566e705c121SKalle Valo struct sk_buff_head *skbs); 567e705c121SKalle Valo 568ba7136f3SAlex Malamud void (*set_q_ptrs)(struct iwl_trans *trans, int queue, int ptr); 569ba7136f3SAlex Malamud 570dcfbd67bSEmmanuel Grumbach bool (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn, 571e705c121SKalle Valo const struct iwl_trans_txq_scd_cfg *cfg, 572e705c121SKalle Valo unsigned int queue_wdg_timeout); 573e705c121SKalle Valo void (*txq_disable)(struct iwl_trans *trans, int queue, 574e705c121SKalle Valo bool configure_scd); 5752f7a3863SLuca Coelho /* 22000 functions */ 576227f2597SJohannes Berg int (*txq_alloc)(struct iwl_trans *trans, u32 flags, 577227f2597SJohannes Berg u32 sta_mask, u8 tid, 57885b17a33SJohannes Berg int size, unsigned int queue_wdg_timeout); 5796b35ff91SSara Sharon void (*txq_free)(struct iwl_trans *trans, int queue); 58092536c96SSara Sharon int (*rxq_dma_data)(struct iwl_trans *trans, int queue, 58192536c96SSara Sharon struct iwl_trans_rxq_dma_data *data); 582e705c121SKalle Valo 58342db09c1SLiad Kaufman void (*txq_set_shared_mode)(struct iwl_trans *trans, u32 txq_id, 58442db09c1SLiad Kaufman bool shared); 58542db09c1SLiad Kaufman 586a1a57877SSara Sharon int (*wait_tx_queues_empty)(struct iwl_trans *trans, u32 txq_bm); 587d6d517b7SSara Sharon int (*wait_txq_empty)(struct iwl_trans *trans, int queue); 588e705c121SKalle Valo void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs, 589e705c121SKalle Valo bool freeze); 5900cd58eaaSEmmanuel Grumbach void (*block_txq_ptrs)(struct iwl_trans *trans, bool block); 591e705c121SKalle Valo 592e705c121SKalle Valo void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val); 593e705c121SKalle Valo void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val); 594e705c121SKalle Valo u32 (*read32)(struct iwl_trans *trans, u32 ofs); 595e705c121SKalle Valo u32 (*read_prph)(struct iwl_trans *trans, u32 ofs); 596e705c121SKalle Valo void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val); 597e705c121SKalle Valo int (*read_mem)(struct iwl_trans *trans, u32 addr, 598e705c121SKalle Valo void *buf, int dwords); 599e705c121SKalle Valo int (*write_mem)(struct iwl_trans *trans, u32 addr, 600e705c121SKalle Valo const void *buf, int dwords); 601f696a7eeSLuca Coelho int (*read_config32)(struct iwl_trans *trans, u32 ofs, u32 *val); 602e705c121SKalle Valo void (*configure)(struct iwl_trans *trans, 603e705c121SKalle Valo const struct iwl_trans_config *trans_cfg); 604e705c121SKalle Valo void (*set_pmi)(struct iwl_trans *trans, bool state); 60515bf5ac6SJohannes Berg int (*sw_reset)(struct iwl_trans *trans, bool retake_ownership); 6061ed08f6fSJohannes Berg bool (*grab_nic_access)(struct iwl_trans *trans); 6071ed08f6fSJohannes Berg void (*release_nic_access)(struct iwl_trans *trans); 608e705c121SKalle Valo void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask, 609e705c121SKalle Valo u32 value); 610e705c121SKalle Valo 611e705c121SKalle Valo struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans, 612fdb70083SJohannes Berg u32 dump_mask, 613fdb70083SJohannes Berg const struct iwl_dump_sanitize_ops *sanitize_ops, 614fdb70083SJohannes Berg void *sanitize_ctx); 615f7805b33SLior Cohen void (*debugfs_cleanup)(struct iwl_trans *trans); 616d1967ce6SShahar S Matityahu void (*sync_nmi)(struct iwl_trans *trans); 617a182dfabSLuca Coelho int (*set_pnvm)(struct iwl_trans *trans, const void *data, u32 len); 6189dad325fSLuca Coelho int (*set_reduce_power)(struct iwl_trans *trans, 6199dad325fSLuca Coelho const void *data, u32 len); 6203161a34dSMordechay Goodstein void (*interrupts)(struct iwl_trans *trans, bool enable); 621c0941aceSMukesh Sisodiya int (*imr_dma_data)(struct iwl_trans *trans, 622c0941aceSMukesh Sisodiya u32 dst_addr, u64 src_addr, 623c0941aceSMukesh Sisodiya u32 byte_cnt); 624c0941aceSMukesh Sisodiya 625e705c121SKalle Valo }; 626e705c121SKalle Valo 627e705c121SKalle Valo /** 628e705c121SKalle Valo * enum iwl_trans_state - state of the transport layer 629e705c121SKalle Valo * 630b2ed841eSJohannes Berg * @IWL_TRANS_NO_FW: firmware wasn't started yet, or crashed 631b2ed841eSJohannes Berg * @IWL_TRANS_FW_STARTED: FW was started, but not alive yet 632b2ed841eSJohannes Berg * @IWL_TRANS_FW_ALIVE: FW has sent an alive response 633e705c121SKalle Valo */ 634e705c121SKalle Valo enum iwl_trans_state { 635b2ed841eSJohannes Berg IWL_TRANS_NO_FW, 636b2ed841eSJohannes Berg IWL_TRANS_FW_STARTED, 637b2ed841eSJohannes Berg IWL_TRANS_FW_ALIVE, 638e705c121SKalle Valo }; 639e705c121SKalle Valo 640e705c121SKalle Valo /** 641b7282643SLuca Coelho * DOC: Platform power management 642e705c121SKalle Valo * 643b7282643SLuca Coelho * In system-wide power management the entire platform goes into a low 644b7282643SLuca Coelho * power state (e.g. idle or suspend to RAM) at the same time and the 645b7282643SLuca Coelho * device is configured as a wakeup source for the entire platform. 646b7282643SLuca Coelho * This is usually triggered by userspace activity (e.g. the user 647b7282643SLuca Coelho * presses the suspend button or a power management daemon decides to 648b7282643SLuca Coelho * put the platform in low power mode). The device's behavior in this 649b7282643SLuca Coelho * mode is dictated by the wake-on-WLAN configuration. 650b7282643SLuca Coelho * 651b7282643SLuca Coelho * The terms used for the device's behavior are as follows: 652b7282643SLuca Coelho * 653b7282643SLuca Coelho * - D0: the device is fully powered and the host is awake; 654b7282643SLuca Coelho * - D3: the device is in low power mode and only reacts to 655b7282643SLuca Coelho * specific events (e.g. magic-packet received or scan 656b7282643SLuca Coelho * results found); 657b7282643SLuca Coelho * 658b7282643SLuca Coelho * These terms reflect the power modes in the firmware and are not to 659f60e2750SEmmanuel Grumbach * be confused with the physical device power state. 660e705c121SKalle Valo */ 661b7282643SLuca Coelho 662b7282643SLuca Coelho /** 663b7282643SLuca Coelho * enum iwl_plat_pm_mode - platform power management mode 664b7282643SLuca Coelho * 665b7282643SLuca Coelho * This enumeration describes the device's platform power management 666f60e2750SEmmanuel Grumbach * behavior when in system-wide suspend (i.e WoWLAN). 667b7282643SLuca Coelho * 668b7282643SLuca Coelho * @IWL_PLAT_PM_MODE_DISABLED: power management is disabled for this 669f60e2750SEmmanuel Grumbach * device. In system-wide suspend mode, it means that the all 670f60e2750SEmmanuel Grumbach * connections will be closed automatically by mac80211 before 671f60e2750SEmmanuel Grumbach * the platform is suspended. 672b7282643SLuca Coelho * @IWL_PLAT_PM_MODE_D3: the device goes into D3 mode (i.e. WoWLAN). 673b7282643SLuca Coelho */ 674b7282643SLuca Coelho enum iwl_plat_pm_mode { 675b7282643SLuca Coelho IWL_PLAT_PM_MODE_DISABLED, 676b7282643SLuca Coelho IWL_PLAT_PM_MODE_D3, 677e705c121SKalle Valo }; 678e705c121SKalle Valo 679341bd290SShahar S Matityahu /** 680341bd290SShahar S Matityahu * enum iwl_ini_cfg_state 681341bd290SShahar S Matityahu * @IWL_INI_CFG_STATE_NOT_LOADED: no debug cfg was given 682341bd290SShahar S Matityahu * @IWL_INI_CFG_STATE_LOADED: debug cfg was found and loaded 683341bd290SShahar S Matityahu * @IWL_INI_CFG_STATE_CORRUPTED: debug cfg was found and some of the TLVs 684341bd290SShahar S Matityahu * are corrupted. The rest of the debug TLVs will still be used 685341bd290SShahar S Matityahu */ 686341bd290SShahar S Matityahu enum iwl_ini_cfg_state { 687341bd290SShahar S Matityahu IWL_INI_CFG_STATE_NOT_LOADED, 688341bd290SShahar S Matityahu IWL_INI_CFG_STATE_LOADED, 689341bd290SShahar S Matityahu IWL_INI_CFG_STATE_CORRUPTED, 690341bd290SShahar S Matityahu }; 691341bd290SShahar S Matityahu 692b8a7547dSShahar S Matityahu /* Max time to wait for nmi interrupt */ 693b8a7547dSShahar S Matityahu #define IWL_TRANS_NMI_TIMEOUT (HZ / 4) 694b8a7547dSShahar S Matityahu 69588964b2eSSara Sharon /** 69688964b2eSSara Sharon * struct iwl_dram_data 69788964b2eSSara Sharon * @physical: page phy pointer 69888964b2eSSara Sharon * @block: pointer to the allocated block/page 69988964b2eSSara Sharon * @size: size of the block/page 70088964b2eSSara Sharon */ 70188964b2eSSara Sharon struct iwl_dram_data { 70288964b2eSSara Sharon dma_addr_t physical; 70388964b2eSSara Sharon void *block; 70488964b2eSSara Sharon int size; 70588964b2eSSara Sharon }; 7064cbb8e50SLuciano Coelho 707e705c121SKalle Valo /** 708593fae3eSShahar S Matityahu * struct iwl_fw_mon - fw monitor per allocation id 709593fae3eSShahar S Matityahu * @num_frags: number of fragments 710593fae3eSShahar S Matityahu * @frags: an array of DRAM buffer fragments 711593fae3eSShahar S Matityahu */ 712593fae3eSShahar S Matityahu struct iwl_fw_mon { 713593fae3eSShahar S Matityahu u32 num_frags; 714593fae3eSShahar S Matityahu struct iwl_dram_data *frags; 715593fae3eSShahar S Matityahu }; 716593fae3eSShahar S Matityahu 717593fae3eSShahar S Matityahu /** 718505a00c0SShahar S Matityahu * struct iwl_self_init_dram - dram data used by self init process 719505a00c0SShahar S Matityahu * @fw: lmac and umac dram data 720505a00c0SShahar S Matityahu * @fw_cnt: total number of items in array 721505a00c0SShahar S Matityahu * @paging: paging dram data 722505a00c0SShahar S Matityahu * @paging_cnt: total number of items in array 723505a00c0SShahar S Matityahu */ 724505a00c0SShahar S Matityahu struct iwl_self_init_dram { 725505a00c0SShahar S Matityahu struct iwl_dram_data *fw; 726505a00c0SShahar S Matityahu int fw_cnt; 727505a00c0SShahar S Matityahu struct iwl_dram_data *paging; 728505a00c0SShahar S Matityahu int paging_cnt; 729505a00c0SShahar S Matityahu }; 730505a00c0SShahar S Matityahu 731505a00c0SShahar S Matityahu /** 732c0941aceSMukesh Sisodiya * struct iwl_imr_data - imr dram data used during debug process 733c0941aceSMukesh Sisodiya * @imr_enable: imr enable status received from fw 734c0941aceSMukesh Sisodiya * @imr_size: imr dram size received from fw 735c0941aceSMukesh Sisodiya * @sram_addr: sram address from debug tlv 736c0941aceSMukesh Sisodiya * @sram_size: sram size from debug tlv 737c0941aceSMukesh Sisodiya * @imr2sram_remainbyte`: size remained after each dma transfer 738c0941aceSMukesh Sisodiya * @imr_curr_addr: current dst address used during dma transfer 739c0941aceSMukesh Sisodiya * @imr_base_addr: imr address received from fw 740c0941aceSMukesh Sisodiya */ 741c0941aceSMukesh Sisodiya struct iwl_imr_data { 742c0941aceSMukesh Sisodiya u32 imr_enable; 743c0941aceSMukesh Sisodiya u32 imr_size; 744c0941aceSMukesh Sisodiya u32 sram_addr; 745c0941aceSMukesh Sisodiya u32 sram_size; 746c0941aceSMukesh Sisodiya u32 imr2sram_remainbyte; 747c0941aceSMukesh Sisodiya u64 imr_curr_addr; 748c0941aceSMukesh Sisodiya __le64 imr_base_addr; 749c0941aceSMukesh Sisodiya }; 750c0941aceSMukesh Sisodiya 751c0941aceSMukesh Sisodiya /** 75291c28b83SShahar S Matityahu * struct iwl_trans_debug - transport debug related data 75391c28b83SShahar S Matityahu * 75491c28b83SShahar S Matityahu * @n_dest_reg: num of reg_ops in %dbg_dest_tlv 75591c28b83SShahar S Matityahu * @rec_on: true iff there is a fw debug recording currently active 75691c28b83SShahar S Matityahu * @dest_tlv: points to the destination TLV for debug 75791c28b83SShahar S Matityahu * @conf_tlv: array of pointers to configuration TLVs for debug 75891c28b83SShahar S Matityahu * @trigger_tlv: array of pointers to triggers TLVs for debug 75991c28b83SShahar S Matityahu * @lmac_error_event_table: addrs of lmacs error tables 76091c28b83SShahar S Matityahu * @umac_error_event_table: addr of umac error table 76157417e1bSJohannes Berg * @tcm_error_event_table: address(es) of TCM error table(s) 7624cd177b4SJohannes Berg * @rcm_error_event_table: address(es) of RCM error table(s) 76391c28b83SShahar S Matityahu * @error_event_table_tlv_status: bitmap that indicates what error table 76491c28b83SShahar S Matityahu * pointers was recevied via TLV. uses enum &iwl_error_event_table_status 765341bd290SShahar S Matityahu * @internal_ini_cfg: internal debug cfg state. Uses &enum iwl_ini_cfg_state 766341bd290SShahar S Matityahu * @external_ini_cfg: external debug cfg state. Uses &enum iwl_ini_cfg_state 767593fae3eSShahar S Matityahu * @fw_mon_cfg: debug buffer allocation configuration 768593fae3eSShahar S Matityahu * @fw_mon_ini: DRAM buffer fragments per allocation id 76969f0e505SShahar S Matityahu * @fw_mon: DRAM buffer for firmware monitor 77091c28b83SShahar S Matityahu * @hw_error: equals true if hw error interrupt was received from the FW 771029c25f3SShahar S Matityahu * @ini_dest: debug monitor destination uses &enum iwl_fw_ini_buffer_location 7723b589d56SShahar S Matityahu * @active_regions: active regions 773677d25b2SShahar S Matityahu * @debug_info_tlv_list: list of debug info TLVs 774a9248de4SShahar S Matityahu * @time_point: array of debug time points 77560e8abd9SShahar S Matityahu * @periodic_trig_list: periodic triggers list 776f21baf24SMukesh Sisodiya * @domains_bitmap: bitmap of active domains other than &IWL_FW_INI_DOMAIN_ALWAYS_ON 777f21baf24SMukesh Sisodiya * @ucode_preset: preset based on ucode 77891c28b83SShahar S Matityahu */ 77991c28b83SShahar S Matityahu struct iwl_trans_debug { 78091c28b83SShahar S Matityahu u8 n_dest_reg; 78191c28b83SShahar S Matityahu bool rec_on; 78291c28b83SShahar S Matityahu 78391c28b83SShahar S Matityahu const struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv; 78491c28b83SShahar S Matityahu const struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX]; 78591c28b83SShahar S Matityahu struct iwl_fw_dbg_trigger_tlv * const *trigger_tlv; 78691c28b83SShahar S Matityahu 78791c28b83SShahar S Matityahu u32 lmac_error_event_table[2]; 78891c28b83SShahar S Matityahu u32 umac_error_event_table; 78957417e1bSJohannes Berg u32 tcm_error_event_table[2]; 7904cd177b4SJohannes Berg u32 rcm_error_event_table[2]; 79191c28b83SShahar S Matityahu unsigned int error_event_table_tlv_status; 79291c28b83SShahar S Matityahu 793341bd290SShahar S Matityahu enum iwl_ini_cfg_state internal_ini_cfg; 794341bd290SShahar S Matityahu enum iwl_ini_cfg_state external_ini_cfg; 79591c28b83SShahar S Matityahu 796593fae3eSShahar S Matityahu struct iwl_fw_ini_allocation_tlv fw_mon_cfg[IWL_FW_INI_ALLOCATION_NUM]; 797593fae3eSShahar S Matityahu struct iwl_fw_mon fw_mon_ini[IWL_FW_INI_ALLOCATION_NUM]; 798593fae3eSShahar S Matityahu 79969f0e505SShahar S Matityahu struct iwl_dram_data fw_mon; 80091c28b83SShahar S Matityahu 80191c28b83SShahar S Matityahu bool hw_error; 802029c25f3SShahar S Matityahu enum iwl_fw_ini_buffer_location ini_dest; 8033b589d56SShahar S Matityahu 804beb44c0cSMordechay Goodstein u64 unsupported_region_msk; 8053b589d56SShahar S Matityahu struct iwl_ucode_tlv *active_regions[IWL_FW_INI_MAX_REGION_ID]; 806677d25b2SShahar S Matityahu struct list_head debug_info_tlv_list; 807a9248de4SShahar S Matityahu struct iwl_dbg_tlv_time_point_data 808a9248de4SShahar S Matityahu time_point[IWL_FW_INI_TIME_POINT_NUM]; 80960e8abd9SShahar S Matityahu struct list_head periodic_trig_list; 810cf29c5b6SShahar S Matityahu 811cf29c5b6SShahar S Matityahu u32 domains_bitmap; 812f21baf24SMukesh Sisodiya u32 ucode_preset; 813ddb6b76bSMukesh Sisodiya bool restart_required; 814ddb6b76bSMukesh Sisodiya u32 last_tp_resetfw; 815c0941aceSMukesh Sisodiya struct iwl_imr_data imr_data; 81691c28b83SShahar S Matityahu }; 81791c28b83SShahar S Matityahu 8184807e736SMordechay Goodstein struct iwl_dma_ptr { 8194807e736SMordechay Goodstein dma_addr_t dma; 8204807e736SMordechay Goodstein void *addr; 8214807e736SMordechay Goodstein size_t size; 8224807e736SMordechay Goodstein }; 8234807e736SMordechay Goodstein 8244807e736SMordechay Goodstein struct iwl_cmd_meta { 8254807e736SMordechay Goodstein /* only for SYNC commands, iff the reply skb is wanted */ 8264807e736SMordechay Goodstein struct iwl_host_cmd *source; 8274807e736SMordechay Goodstein u32 flags; 8284807e736SMordechay Goodstein u32 tbs; 8294807e736SMordechay Goodstein }; 8304807e736SMordechay Goodstein 8314807e736SMordechay Goodstein /* 8324807e736SMordechay Goodstein * The FH will write back to the first TB only, so we need to copy some data 8334807e736SMordechay Goodstein * into the buffer regardless of whether it should be mapped or not. 8344807e736SMordechay Goodstein * This indicates how big the first TB must be to include the scratch buffer 8354807e736SMordechay Goodstein * and the assigned PN. 8364807e736SMordechay Goodstein * Since PN location is 8 bytes at offset 12, it's 20 now. 8374807e736SMordechay Goodstein * If we make it bigger then allocations will be bigger and copy slower, so 8384807e736SMordechay Goodstein * that's probably not useful. 8394807e736SMordechay Goodstein */ 8404807e736SMordechay Goodstein #define IWL_FIRST_TB_SIZE 20 8414807e736SMordechay Goodstein #define IWL_FIRST_TB_SIZE_ALIGN ALIGN(IWL_FIRST_TB_SIZE, 64) 8424807e736SMordechay Goodstein 8434807e736SMordechay Goodstein struct iwl_pcie_txq_entry { 8444807e736SMordechay Goodstein void *cmd; 8454807e736SMordechay Goodstein struct sk_buff *skb; 8464807e736SMordechay Goodstein /* buffer to free after command completes */ 8474807e736SMordechay Goodstein const void *free_buf; 8484807e736SMordechay Goodstein struct iwl_cmd_meta meta; 8494807e736SMordechay Goodstein }; 8504807e736SMordechay Goodstein 8514807e736SMordechay Goodstein struct iwl_pcie_first_tb_buf { 8524807e736SMordechay Goodstein u8 buf[IWL_FIRST_TB_SIZE_ALIGN]; 8534807e736SMordechay Goodstein }; 8544807e736SMordechay Goodstein 8554807e736SMordechay Goodstein /** 8564807e736SMordechay Goodstein * struct iwl_txq - Tx Queue for DMA 8574807e736SMordechay Goodstein * @q: generic Rx/Tx queue descriptor 8584807e736SMordechay Goodstein * @tfds: transmit frame descriptors (DMA memory) 8594807e736SMordechay Goodstein * @first_tb_bufs: start of command headers, including scratch buffers, for 8604807e736SMordechay Goodstein * the writeback -- this is DMA memory and an array holding one buffer 8614807e736SMordechay Goodstein * for each command on the queue 8624807e736SMordechay Goodstein * @first_tb_dma: DMA address for the first_tb_bufs start 8634807e736SMordechay Goodstein * @entries: transmit entries (driver state) 8644807e736SMordechay Goodstein * @lock: queue lock 8654807e736SMordechay Goodstein * @stuck_timer: timer that fires if queue gets stuck 8664807e736SMordechay Goodstein * @trans: pointer back to transport (for timer) 8674807e736SMordechay Goodstein * @need_update: indicates need to update read/write index 8684807e736SMordechay Goodstein * @ampdu: true if this queue is an ampdu queue for an specific RA/TID 8694807e736SMordechay Goodstein * @wd_timeout: queue watchdog timeout (jiffies) - per queue 8704807e736SMordechay Goodstein * @frozen: tx stuck queue timer is frozen 8714807e736SMordechay Goodstein * @frozen_expiry_remainder: remember how long until the timer fires 8724807e736SMordechay Goodstein * @bc_tbl: byte count table of the queue (relevant only for gen2 transport) 8734807e736SMordechay Goodstein * @write_ptr: 1-st empty entry (index) host_w 8744807e736SMordechay Goodstein * @read_ptr: last used entry (index) host_r 8754807e736SMordechay Goodstein * @dma_addr: physical addr for BD's 8764807e736SMordechay Goodstein * @n_window: safe queue window 8774807e736SMordechay Goodstein * @id: queue id 8784807e736SMordechay Goodstein * @low_mark: low watermark, resume queue if free space more than this 8794807e736SMordechay Goodstein * @high_mark: high watermark, stop queue if free space less than this 8804807e736SMordechay Goodstein * 8814807e736SMordechay Goodstein * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame 8824807e736SMordechay Goodstein * descriptors) and required locking structures. 8834807e736SMordechay Goodstein * 8844807e736SMordechay Goodstein * Note the difference between TFD_QUEUE_SIZE_MAX and n_window: the hardware 8854807e736SMordechay Goodstein * always assumes 256 descriptors, so TFD_QUEUE_SIZE_MAX is always 256 (unless 8864807e736SMordechay Goodstein * there might be HW changes in the future). For the normal TX 8874807e736SMordechay Goodstein * queues, n_window, which is the size of the software queue data 8884807e736SMordechay Goodstein * is also 256; however, for the command queue, n_window is only 8894807e736SMordechay Goodstein * 32 since we don't need so many commands pending. Since the HW 8904807e736SMordechay Goodstein * still uses 256 BDs for DMA though, TFD_QUEUE_SIZE_MAX stays 256. 8914807e736SMordechay Goodstein * This means that we end up with the following: 8924807e736SMordechay Goodstein * HW entries: | 0 | ... | N * 32 | ... | N * 32 + 31 | ... | 255 | 8934807e736SMordechay Goodstein * SW entries: | 0 | ... | 31 | 8944807e736SMordechay Goodstein * where N is a number between 0 and 7. This means that the SW 8954807e736SMordechay Goodstein * data is a window overlayed over the HW queue. 8964807e736SMordechay Goodstein */ 8974807e736SMordechay Goodstein struct iwl_txq { 8984807e736SMordechay Goodstein void *tfds; 8994807e736SMordechay Goodstein struct iwl_pcie_first_tb_buf *first_tb_bufs; 9004807e736SMordechay Goodstein dma_addr_t first_tb_dma; 9014807e736SMordechay Goodstein struct iwl_pcie_txq_entry *entries; 9024807e736SMordechay Goodstein /* lock for syncing changes on the queue */ 9034807e736SMordechay Goodstein spinlock_t lock; 9044807e736SMordechay Goodstein unsigned long frozen_expiry_remainder; 9054807e736SMordechay Goodstein struct timer_list stuck_timer; 9064807e736SMordechay Goodstein struct iwl_trans *trans; 9074807e736SMordechay Goodstein bool need_update; 9084807e736SMordechay Goodstein bool frozen; 9094807e736SMordechay Goodstein bool ampdu; 9104807e736SMordechay Goodstein int block; 9114807e736SMordechay Goodstein unsigned long wd_timeout; 9124807e736SMordechay Goodstein struct sk_buff_head overflow_q; 9134807e736SMordechay Goodstein struct iwl_dma_ptr bc_tbl; 9144807e736SMordechay Goodstein 9154807e736SMordechay Goodstein int write_ptr; 9164807e736SMordechay Goodstein int read_ptr; 9174807e736SMordechay Goodstein dma_addr_t dma_addr; 9184807e736SMordechay Goodstein int n_window; 9194807e736SMordechay Goodstein u32 id; 9204807e736SMordechay Goodstein int low_mark; 9214807e736SMordechay Goodstein int high_mark; 9224807e736SMordechay Goodstein 9234807e736SMordechay Goodstein bool overflow_tx; 9244807e736SMordechay Goodstein }; 9254f4822b7SMordechay Goodstein 9264f4822b7SMordechay Goodstein /** 9274f4822b7SMordechay Goodstein * struct iwl_trans_txqs - transport tx queues data 9284f4822b7SMordechay Goodstein * 9298e3b79f8SMordechay Goodstein * @bc_table_dword: true if the BC table expects DWORD (as opposed to bytes) 93022852fadSMordechay Goodstein * @page_offs: offset from skb->cb to mac header page pointer 93122852fadSMordechay Goodstein * @dev_cmd_offs: offset from skb->cb to iwl_device_tx_cmd pointer 9324f4822b7SMordechay Goodstein * @queue_used - bit mask of used queues 9334f4822b7SMordechay Goodstein * @queue_stopped - bit mask of stopped queues 9340179bfffSMordechay Goodstein * @scd_bc_tbls: gen1 pointer to the byte count table of the scheduler 935227f2597SJohannes Berg * @queue_alloc_cmd_ver: queue allocation command version 9364f4822b7SMordechay Goodstein */ 9374f4822b7SMordechay Goodstein struct iwl_trans_txqs { 9384f4822b7SMordechay Goodstein unsigned long queue_used[BITS_TO_LONGS(IWL_MAX_TVQM_QUEUES)]; 9394f4822b7SMordechay Goodstein unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_TVQM_QUEUES)]; 9404f4822b7SMordechay Goodstein struct iwl_txq *txq[IWL_MAX_TVQM_QUEUES]; 941a26014e2SMordechay Goodstein struct dma_pool *bc_pool; 942a26014e2SMordechay Goodstein size_t bc_tbl_size; 9438e3b79f8SMordechay Goodstein bool bc_table_dword; 94422852fadSMordechay Goodstein u8 page_offs; 94522852fadSMordechay Goodstein u8 dev_cmd_offs; 9464246465eSJohannes Berg struct iwl_tso_hdr_page __percpu *tso_hdr_page; 9478e3b79f8SMordechay Goodstein 9484f4822b7SMordechay Goodstein struct { 9494f4822b7SMordechay Goodstein u8 fifo; 9504f4822b7SMordechay Goodstein u8 q_id; 9514f4822b7SMordechay Goodstein unsigned int wdg_timeout; 9524f4822b7SMordechay Goodstein } cmd; 9534f4822b7SMordechay Goodstein 954885375d0SMordechay Goodstein struct { 955885375d0SMordechay Goodstein u8 max_tbs; 956885375d0SMordechay Goodstein u16 size; 957885375d0SMordechay Goodstein u8 addr_size; 958885375d0SMordechay Goodstein } tfd; 9590179bfffSMordechay Goodstein 9600179bfffSMordechay Goodstein struct iwl_dma_ptr scd_bc_tbls; 961227f2597SJohannes Berg 962227f2597SJohannes Berg u8 queue_alloc_cmd_ver; 9634f4822b7SMordechay Goodstein }; 9644f4822b7SMordechay Goodstein 96591c28b83SShahar S Matityahu /** 966e705c121SKalle Valo * struct iwl_trans - transport common data 967e705c121SKalle Valo * 9686d19a5ebSEmmanuel Grumbach * @csme_own - true if we couldn't get ownership on the device 969e705c121SKalle Valo * @ops - pointer to iwl_trans_ops 970e705c121SKalle Valo * @op_mode - pointer to the op_mode 971286ca8ebSLuca Coelho * @trans_cfg: the trans-specific configuration part 972e705c121SKalle Valo * @cfg - pointer to the configuration 9736f482e37SSara Sharon * @drv - pointer to iwl_drv 974e705c121SKalle Valo * @status: a bit-mask of transport status flags 975e705c121SKalle Valo * @dev - pointer to struct device * that represents the device 976e705c121SKalle Valo * @max_skb_frags: maximum number of fragments an SKB can have when transmitted. 977e705c121SKalle Valo * 0 indicates that frag SKBs (NETIF_F_SG) aren't supported. 9781afb0ae4SHaim Dreyfuss * @hw_rf_id a u32 with the device RF ID 9793a27a1a1SMukesh Sisodiya * @hw_crf_id a u32 with the device CRF ID 9803a27a1a1SMukesh Sisodiya * @hw_cdb_id a u32 with the device CDB ID 981e705c121SKalle Valo * @hw_id: a u32 with the ID of the device / sub-device. 982e705c121SKalle Valo * Set during transport allocation. 983e705c121SKalle Valo * @hw_id_str: a string with info about HW ID. Set during transport allocation. 98455c6d8f8SMike Golant * @hw_rev_step: The mac step of the HW 985e705c121SKalle Valo * @pm_support: set to true in start_hw if link pm is supported 986e705c121SKalle Valo * @ltr_enabled: set to true if the LTR is enabled 987b7d96bcaSLuca Coelho * @wide_cmd_header: true when ucode supports wide command header format 98813f028b4SMordechay Goodstein * @wait_command_queue: wait queue for sync commands 989e705c121SKalle Valo * @num_rx_queues: number of RX queues allocated by the transport; 990e705c121SKalle Valo * the transport must set this before calling iwl_drv_start() 991132db31cSGolan Ben-Ami * @iml_len: the length of the image loader 992132db31cSGolan Ben-Ami * @iml: a pointer to the image loader itself 993e705c121SKalle Valo * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only. 994e705c121SKalle Valo * The user should use iwl_trans_{alloc,free}_tx_cmd. 995e705c121SKalle Valo * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before 996e705c121SKalle Valo * starting the firmware, used for tracing 997e705c121SKalle Valo * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the 998e705c121SKalle Valo * start of the 802.11 header in the @rx_mpdu_cmd 999e705c121SKalle Valo * @dflt_pwr_limit: default power limit fetched from the platform (ACPI) 1000b7282643SLuca Coelho * @system_pm_mode: the system-wide power management mode in use. 1001b7282643SLuca Coelho * This mode is set dynamically, depending on the WoWLAN values 1002b7282643SLuca Coelho * configured from the userspace at runtime. 10034f4822b7SMordechay Goodstein * @iwl_trans_txqs: transport tx queues data. 1004*09b4c35dSAyala Barazani * @mbx_addr_0_step: step address data 0 1005*09b4c35dSAyala Barazani * @mbx_addr_1_step: step address data 1 1006e705c121SKalle Valo */ 1007e705c121SKalle Valo struct iwl_trans { 10086d19a5ebSEmmanuel Grumbach bool csme_own; 1009e705c121SKalle Valo const struct iwl_trans_ops *ops; 1010e705c121SKalle Valo struct iwl_op_mode *op_mode; 1011286ca8ebSLuca Coelho const struct iwl_cfg_trans_params *trans_cfg; 1012e705c121SKalle Valo const struct iwl_cfg *cfg; 10136f482e37SSara Sharon struct iwl_drv *drv; 1014e705c121SKalle Valo enum iwl_trans_state state; 1015e705c121SKalle Valo unsigned long status; 1016e705c121SKalle Valo 1017e705c121SKalle Valo struct device *dev; 1018e705c121SKalle Valo u32 max_skb_frags; 1019e705c121SKalle Valo u32 hw_rev; 102055c6d8f8SMike Golant u32 hw_rev_step; 10211afb0ae4SHaim Dreyfuss u32 hw_rf_id; 10223a27a1a1SMukesh Sisodiya u32 hw_crf_id; 10233a27a1a1SMukesh Sisodiya u32 hw_cdb_id; 1024e705c121SKalle Valo u32 hw_id; 1025e705c121SKalle Valo char hw_id_str[52]; 102690824f2fSLuca Coelho u32 sku_id[3]; 1027e705c121SKalle Valo 1028e705c121SKalle Valo u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size; 1029e705c121SKalle Valo 1030e705c121SKalle Valo bool pm_support; 1031e705c121SKalle Valo bool ltr_enabled; 103269725928SLuca Coelho u8 pnvm_loaded:1; 10339dad325fSLuca Coelho u8 reduce_power_loaded:1; 1034e705c121SKalle Valo 103539bdb17eSSharon Dvir const struct iwl_hcmd_arr *command_groups; 103639bdb17eSSharon Dvir int command_groups_size; 1037b7d96bcaSLuca Coelho bool wide_cmd_header; 103839bdb17eSSharon Dvir 103913f028b4SMordechay Goodstein wait_queue_head_t wait_command_queue; 1040e705c121SKalle Valo u8 num_rx_queues; 1041e705c121SKalle Valo 1042132db31cSGolan Ben-Ami size_t iml_len; 1043132db31cSGolan Ben-Ami u8 *iml; 1044132db31cSGolan Ben-Ami 1045e705c121SKalle Valo /* The following fields are internal only */ 1046e705c121SKalle Valo struct kmem_cache *dev_cmd_pool; 1047e705c121SKalle Valo char dev_cmd_pool_name[50]; 1048e705c121SKalle Valo 1049e705c121SKalle Valo struct dentry *dbgfs_dir; 1050e705c121SKalle Valo 1051e705c121SKalle Valo #ifdef CONFIG_LOCKDEP 1052e705c121SKalle Valo struct lockdep_map sync_cmd_lockdep_map; 1053e705c121SKalle Valo #endif 1054e705c121SKalle Valo 105591c28b83SShahar S Matityahu struct iwl_trans_debug dbg; 1056505a00c0SShahar S Matityahu struct iwl_self_init_dram init_dram; 1057e705c121SKalle Valo 1058b7282643SLuca Coelho enum iwl_plat_pm_mode system_pm_mode; 1059700b3799SShahar S Matityahu 10600b295a1eSLuca Coelho const char *name; 10614f4822b7SMordechay Goodstein struct iwl_trans_txqs txqs; 1062*09b4c35dSAyala Barazani u32 mbx_addr_0_step; 1063*09b4c35dSAyala Barazani u32 mbx_addr_1_step; 10640b295a1eSLuca Coelho 1065e705c121SKalle Valo /* pointer to trans specific struct */ 1066e705c121SKalle Valo /*Ensure that this pointer will always be aligned to sizeof pointer */ 106745c21a0eSGustavo A. R. Silva char trans_specific[] __aligned(sizeof(void *)); 1068e705c121SKalle Valo }; 1069e705c121SKalle Valo 107039bdb17eSSharon Dvir const char *iwl_get_cmd_string(struct iwl_trans *trans, u32 id); 107139bdb17eSSharon Dvir int iwl_cmd_groups_verify_sorted(const struct iwl_trans_config *trans); 107239bdb17eSSharon Dvir 1073e705c121SKalle Valo static inline void iwl_trans_configure(struct iwl_trans *trans, 1074e705c121SKalle Valo const struct iwl_trans_config *trans_cfg) 1075e705c121SKalle Valo { 1076e705c121SKalle Valo trans->op_mode = trans_cfg->op_mode; 1077e705c121SKalle Valo 1078e705c121SKalle Valo trans->ops->configure(trans, trans_cfg); 107939bdb17eSSharon Dvir WARN_ON(iwl_cmd_groups_verify_sorted(trans_cfg)); 1080e705c121SKalle Valo } 1081e705c121SKalle Valo 1082bab3cb92SEmmanuel Grumbach static inline int iwl_trans_start_hw(struct iwl_trans *trans) 1083e705c121SKalle Valo { 1084e705c121SKalle Valo might_sleep(); 1085e705c121SKalle Valo 1086bab3cb92SEmmanuel Grumbach return trans->ops->start_hw(trans); 1087e705c121SKalle Valo } 1088e705c121SKalle Valo 1089e705c121SKalle Valo static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans) 1090e705c121SKalle Valo { 1091e705c121SKalle Valo might_sleep(); 1092e705c121SKalle Valo 1093e705c121SKalle Valo if (trans->ops->op_mode_leave) 1094e705c121SKalle Valo trans->ops->op_mode_leave(trans); 1095e705c121SKalle Valo 1096e705c121SKalle Valo trans->op_mode = NULL; 1097e705c121SKalle Valo 1098e705c121SKalle Valo trans->state = IWL_TRANS_NO_FW; 1099e705c121SKalle Valo } 1100e705c121SKalle Valo 1101e705c121SKalle Valo static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr) 1102e705c121SKalle Valo { 1103e705c121SKalle Valo might_sleep(); 1104e705c121SKalle Valo 1105e705c121SKalle Valo trans->state = IWL_TRANS_FW_ALIVE; 1106e705c121SKalle Valo 1107e705c121SKalle Valo trans->ops->fw_alive(trans, scd_addr); 1108e705c121SKalle Valo } 1109e705c121SKalle Valo 1110e705c121SKalle Valo static inline int iwl_trans_start_fw(struct iwl_trans *trans, 1111e705c121SKalle Valo const struct fw_img *fw, 1112e705c121SKalle Valo bool run_in_rfkill) 1113e705c121SKalle Valo { 1114b2ed841eSJohannes Berg int ret; 1115b2ed841eSJohannes Berg 1116e705c121SKalle Valo might_sleep(); 1117e705c121SKalle Valo 1118e705c121SKalle Valo WARN_ON_ONCE(!trans->rx_mpdu_cmd); 1119e705c121SKalle Valo 1120e705c121SKalle Valo clear_bit(STATUS_FW_ERROR, &trans->status); 1121b2ed841eSJohannes Berg ret = trans->ops->start_fw(trans, fw, run_in_rfkill); 1122b2ed841eSJohannes Berg if (ret == 0) 1123b2ed841eSJohannes Berg trans->state = IWL_TRANS_FW_STARTED; 1124b2ed841eSJohannes Berg 1125b2ed841eSJohannes Berg return ret; 1126e705c121SKalle Valo } 1127e705c121SKalle Valo 1128bab3cb92SEmmanuel Grumbach static inline void iwl_trans_stop_device(struct iwl_trans *trans) 1129e705c121SKalle Valo { 1130e705c121SKalle Valo might_sleep(); 1131e705c121SKalle Valo 1132bab3cb92SEmmanuel Grumbach trans->ops->stop_device(trans); 1133e705c121SKalle Valo 1134e705c121SKalle Valo trans->state = IWL_TRANS_NO_FW; 1135e705c121SKalle Valo } 1136e705c121SKalle Valo 1137e5f3f215SHaim Dreyfuss static inline int iwl_trans_d3_suspend(struct iwl_trans *trans, bool test, 113823ae6128SMatti Gottlieb bool reset) 1139e705c121SKalle Valo { 1140e705c121SKalle Valo might_sleep(); 1141e5f3f215SHaim Dreyfuss if (!trans->ops->d3_suspend) 1142e5f3f215SHaim Dreyfuss return 0; 1143e5f3f215SHaim Dreyfuss 1144e5f3f215SHaim Dreyfuss return trans->ops->d3_suspend(trans, test, reset); 1145e705c121SKalle Valo } 1146e705c121SKalle Valo 1147e705c121SKalle Valo static inline int iwl_trans_d3_resume(struct iwl_trans *trans, 1148e705c121SKalle Valo enum iwl_d3_status *status, 114923ae6128SMatti Gottlieb bool test, bool reset) 1150e705c121SKalle Valo { 1151e705c121SKalle Valo might_sleep(); 1152e705c121SKalle Valo if (!trans->ops->d3_resume) 1153e705c121SKalle Valo return 0; 1154e705c121SKalle Valo 115523ae6128SMatti Gottlieb return trans->ops->d3_resume(trans, status, test, reset); 1156e705c121SKalle Valo } 1157e705c121SKalle Valo 1158e705c121SKalle Valo static inline struct iwl_trans_dump_data * 1159fdb70083SJohannes Berg iwl_trans_dump_data(struct iwl_trans *trans, u32 dump_mask, 1160fdb70083SJohannes Berg const struct iwl_dump_sanitize_ops *sanitize_ops, 1161fdb70083SJohannes Berg void *sanitize_ctx) 1162e705c121SKalle Valo { 1163e705c121SKalle Valo if (!trans->ops->dump_data) 1164e705c121SKalle Valo return NULL; 1165fdb70083SJohannes Berg return trans->ops->dump_data(trans, dump_mask, 1166fdb70083SJohannes Berg sanitize_ops, sanitize_ctx); 1167e705c121SKalle Valo } 1168e705c121SKalle Valo 1169a89c72ffSJohannes Berg static inline struct iwl_device_tx_cmd * 1170e705c121SKalle Valo iwl_trans_alloc_tx_cmd(struct iwl_trans *trans) 1171e705c121SKalle Valo { 1172a89c72ffSJohannes Berg return kmem_cache_zalloc(trans->dev_cmd_pool, GFP_ATOMIC); 1173e705c121SKalle Valo } 1174e705c121SKalle Valo 117592fe8343SEmmanuel Grumbach int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd); 117692fe8343SEmmanuel Grumbach 1177e705c121SKalle Valo static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans, 1178a89c72ffSJohannes Berg struct iwl_device_tx_cmd *dev_cmd) 1179e705c121SKalle Valo { 11801ea423b0SLuca Coelho kmem_cache_free(trans->dev_cmd_pool, dev_cmd); 1181e705c121SKalle Valo } 1182e705c121SKalle Valo 1183e705c121SKalle Valo static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb, 1184a89c72ffSJohannes Berg struct iwl_device_tx_cmd *dev_cmd, int queue) 1185e705c121SKalle Valo { 1186e705c121SKalle Valo if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status))) 1187e705c121SKalle Valo return -EIO; 1188e705c121SKalle Valo 1189e5d15cb5SEliad Peller if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1190e705c121SKalle Valo IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1191e5d15cb5SEliad Peller return -EIO; 1192e5d15cb5SEliad Peller } 1193e705c121SKalle Valo 1194e705c121SKalle Valo return trans->ops->tx(trans, skb, dev_cmd, queue); 1195e705c121SKalle Valo } 1196e705c121SKalle Valo 1197e705c121SKalle Valo static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue, 1198e705c121SKalle Valo int ssn, struct sk_buff_head *skbs) 1199e705c121SKalle Valo { 1200e5d15cb5SEliad Peller if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1201e705c121SKalle Valo IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1202e5d15cb5SEliad Peller return; 1203e5d15cb5SEliad Peller } 1204e705c121SKalle Valo 1205e705c121SKalle Valo trans->ops->reclaim(trans, queue, ssn, skbs); 1206e705c121SKalle Valo } 1207e705c121SKalle Valo 1208ba7136f3SAlex Malamud static inline void iwl_trans_set_q_ptrs(struct iwl_trans *trans, int queue, 1209ba7136f3SAlex Malamud int ptr) 1210ba7136f3SAlex Malamud { 1211ba7136f3SAlex Malamud if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1212ba7136f3SAlex Malamud IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1213ba7136f3SAlex Malamud return; 1214ba7136f3SAlex Malamud } 1215ba7136f3SAlex Malamud 1216ba7136f3SAlex Malamud trans->ops->set_q_ptrs(trans, queue, ptr); 1217ba7136f3SAlex Malamud } 1218ba7136f3SAlex Malamud 1219e705c121SKalle Valo static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue, 1220e705c121SKalle Valo bool configure_scd) 1221e705c121SKalle Valo { 1222e705c121SKalle Valo trans->ops->txq_disable(trans, queue, configure_scd); 1223e705c121SKalle Valo } 1224e705c121SKalle Valo 1225dcfbd67bSEmmanuel Grumbach static inline bool 1226e705c121SKalle Valo iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn, 1227e705c121SKalle Valo const struct iwl_trans_txq_scd_cfg *cfg, 1228e705c121SKalle Valo unsigned int queue_wdg_timeout) 1229e705c121SKalle Valo { 1230e705c121SKalle Valo might_sleep(); 1231e705c121SKalle Valo 1232e5d15cb5SEliad Peller if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1233e705c121SKalle Valo IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1234dcfbd67bSEmmanuel Grumbach return false; 1235e5d15cb5SEliad Peller } 1236e705c121SKalle Valo 1237dcfbd67bSEmmanuel Grumbach return trans->ops->txq_enable(trans, queue, ssn, 1238dcfbd67bSEmmanuel Grumbach cfg, queue_wdg_timeout); 1239e705c121SKalle Valo } 1240e705c121SKalle Valo 124192536c96SSara Sharon static inline int 124292536c96SSara Sharon iwl_trans_get_rxq_dma_data(struct iwl_trans *trans, int queue, 124392536c96SSara Sharon struct iwl_trans_rxq_dma_data *data) 124492536c96SSara Sharon { 124592536c96SSara Sharon if (WARN_ON_ONCE(!trans->ops->rxq_dma_data)) 124692536c96SSara Sharon return -ENOTSUPP; 124792536c96SSara Sharon 124892536c96SSara Sharon return trans->ops->rxq_dma_data(trans, queue, data); 124992536c96SSara Sharon } 125092536c96SSara Sharon 12516b35ff91SSara Sharon static inline void 12526b35ff91SSara Sharon iwl_trans_txq_free(struct iwl_trans *trans, int queue) 12536b35ff91SSara Sharon { 12546b35ff91SSara Sharon if (WARN_ON_ONCE(!trans->ops->txq_free)) 12556b35ff91SSara Sharon return; 12566b35ff91SSara Sharon 12576b35ff91SSara Sharon trans->ops->txq_free(trans, queue); 12586b35ff91SSara Sharon } 12596b35ff91SSara Sharon 12606b35ff91SSara Sharon static inline int 12616b35ff91SSara Sharon iwl_trans_txq_alloc(struct iwl_trans *trans, 1262227f2597SJohannes Berg u32 flags, u32 sta_mask, u8 tid, 126385b17a33SJohannes Berg int size, unsigned int wdg_timeout) 12646b35ff91SSara Sharon { 12656b35ff91SSara Sharon might_sleep(); 12666b35ff91SSara Sharon 12676b35ff91SSara Sharon if (WARN_ON_ONCE(!trans->ops->txq_alloc)) 12686b35ff91SSara Sharon return -ENOTSUPP; 12696b35ff91SSara Sharon 12706b35ff91SSara Sharon if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 12716b35ff91SSara Sharon IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 12726b35ff91SSara Sharon return -EIO; 12736b35ff91SSara Sharon } 12746b35ff91SSara Sharon 1275227f2597SJohannes Berg return trans->ops->txq_alloc(trans, flags, sta_mask, tid, 127685b17a33SJohannes Berg size, wdg_timeout); 12776b35ff91SSara Sharon } 12786b35ff91SSara Sharon 127942db09c1SLiad Kaufman static inline void iwl_trans_txq_set_shared_mode(struct iwl_trans *trans, 128042db09c1SLiad Kaufman int queue, bool shared_mode) 128142db09c1SLiad Kaufman { 128242db09c1SLiad Kaufman if (trans->ops->txq_set_shared_mode) 128342db09c1SLiad Kaufman trans->ops->txq_set_shared_mode(trans, queue, shared_mode); 128442db09c1SLiad Kaufman } 128542db09c1SLiad Kaufman 1286e705c121SKalle Valo static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue, 1287e705c121SKalle Valo int fifo, int sta_id, int tid, 1288e705c121SKalle Valo int frame_limit, u16 ssn, 1289e705c121SKalle Valo unsigned int queue_wdg_timeout) 1290e705c121SKalle Valo { 1291e705c121SKalle Valo struct iwl_trans_txq_scd_cfg cfg = { 1292e705c121SKalle Valo .fifo = fifo, 1293e705c121SKalle Valo .sta_id = sta_id, 1294e705c121SKalle Valo .tid = tid, 1295e705c121SKalle Valo .frame_limit = frame_limit, 1296e705c121SKalle Valo .aggregate = sta_id >= 0, 1297e705c121SKalle Valo }; 1298e705c121SKalle Valo 1299e705c121SKalle Valo iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout); 1300e705c121SKalle Valo } 1301e705c121SKalle Valo 1302e705c121SKalle Valo static inline 1303e705c121SKalle Valo void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo, 1304e705c121SKalle Valo unsigned int queue_wdg_timeout) 1305e705c121SKalle Valo { 1306e705c121SKalle Valo struct iwl_trans_txq_scd_cfg cfg = { 1307e705c121SKalle Valo .fifo = fifo, 1308e705c121SKalle Valo .sta_id = -1, 1309e705c121SKalle Valo .tid = IWL_MAX_TID_COUNT, 1310e705c121SKalle Valo .frame_limit = IWL_FRAME_LIMIT, 1311e705c121SKalle Valo .aggregate = false, 1312e705c121SKalle Valo }; 1313e705c121SKalle Valo 1314e705c121SKalle Valo iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout); 1315e705c121SKalle Valo } 1316e705c121SKalle Valo 1317e705c121SKalle Valo static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans, 1318e705c121SKalle Valo unsigned long txqs, 1319e705c121SKalle Valo bool freeze) 1320e705c121SKalle Valo { 1321e5d15cb5SEliad Peller if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1322e705c121SKalle Valo IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1323e5d15cb5SEliad Peller return; 1324e5d15cb5SEliad Peller } 1325e705c121SKalle Valo 1326e705c121SKalle Valo if (trans->ops->freeze_txq_timer) 1327e705c121SKalle Valo trans->ops->freeze_txq_timer(trans, txqs, freeze); 1328e705c121SKalle Valo } 1329e705c121SKalle Valo 13300cd58eaaSEmmanuel Grumbach static inline void iwl_trans_block_txq_ptrs(struct iwl_trans *trans, 13310cd58eaaSEmmanuel Grumbach bool block) 13320cd58eaaSEmmanuel Grumbach { 1333e5d15cb5SEliad Peller if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 13340cd58eaaSEmmanuel Grumbach IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1335e5d15cb5SEliad Peller return; 1336e5d15cb5SEliad Peller } 13370cd58eaaSEmmanuel Grumbach 13380cd58eaaSEmmanuel Grumbach if (trans->ops->block_txq_ptrs) 13390cd58eaaSEmmanuel Grumbach trans->ops->block_txq_ptrs(trans, block); 13400cd58eaaSEmmanuel Grumbach } 13410cd58eaaSEmmanuel Grumbach 1342a1a57877SSara Sharon static inline int iwl_trans_wait_tx_queues_empty(struct iwl_trans *trans, 1343e705c121SKalle Valo u32 txqs) 1344e705c121SKalle Valo { 1345d6d517b7SSara Sharon if (WARN_ON_ONCE(!trans->ops->wait_tx_queues_empty)) 1346d6d517b7SSara Sharon return -ENOTSUPP; 1347d6d517b7SSara Sharon 13482b84e632SEmmanuel Grumbach /* No need to wait if the firmware is not alive */ 13492b84e632SEmmanuel Grumbach if (trans->state != IWL_TRANS_FW_ALIVE) { 1350e705c121SKalle Valo IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1351e5d15cb5SEliad Peller return -EIO; 1352e5d15cb5SEliad Peller } 1353e705c121SKalle Valo 1354a1a57877SSara Sharon return trans->ops->wait_tx_queues_empty(trans, txqs); 1355e705c121SKalle Valo } 1356e705c121SKalle Valo 1357d6d517b7SSara Sharon static inline int iwl_trans_wait_txq_empty(struct iwl_trans *trans, int queue) 1358d6d517b7SSara Sharon { 1359d6d517b7SSara Sharon if (WARN_ON_ONCE(!trans->ops->wait_txq_empty)) 1360d6d517b7SSara Sharon return -ENOTSUPP; 1361d6d517b7SSara Sharon 1362d6d517b7SSara Sharon if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1363d6d517b7SSara Sharon IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1364d6d517b7SSara Sharon return -EIO; 1365d6d517b7SSara Sharon } 1366d6d517b7SSara Sharon 1367d6d517b7SSara Sharon return trans->ops->wait_txq_empty(trans, queue); 1368d6d517b7SSara Sharon } 1369d6d517b7SSara Sharon 1370e705c121SKalle Valo static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val) 1371e705c121SKalle Valo { 1372e705c121SKalle Valo trans->ops->write8(trans, ofs, val); 1373e705c121SKalle Valo } 1374e705c121SKalle Valo 1375e705c121SKalle Valo static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val) 1376e705c121SKalle Valo { 1377e705c121SKalle Valo trans->ops->write32(trans, ofs, val); 1378e705c121SKalle Valo } 1379e705c121SKalle Valo 1380e705c121SKalle Valo static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs) 1381e705c121SKalle Valo { 1382e705c121SKalle Valo return trans->ops->read32(trans, ofs); 1383e705c121SKalle Valo } 1384e705c121SKalle Valo 1385e705c121SKalle Valo static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs) 1386e705c121SKalle Valo { 1387e705c121SKalle Valo return trans->ops->read_prph(trans, ofs); 1388e705c121SKalle Valo } 1389e705c121SKalle Valo 1390e705c121SKalle Valo static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs, 1391e705c121SKalle Valo u32 val) 1392e705c121SKalle Valo { 1393e705c121SKalle Valo return trans->ops->write_prph(trans, ofs, val); 1394e705c121SKalle Valo } 1395e705c121SKalle Valo 1396e705c121SKalle Valo static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr, 1397e705c121SKalle Valo void *buf, int dwords) 1398e705c121SKalle Valo { 1399e705c121SKalle Valo return trans->ops->read_mem(trans, addr, buf, dwords); 1400e705c121SKalle Valo } 1401e705c121SKalle Valo 1402e705c121SKalle Valo #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \ 1403e705c121SKalle Valo do { \ 1404e705c121SKalle Valo if (__builtin_constant_p(bufsize)) \ 1405e705c121SKalle Valo BUILD_BUG_ON((bufsize) % sizeof(u32)); \ 1406e705c121SKalle Valo iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\ 1407e705c121SKalle Valo } while (0) 1408e705c121SKalle Valo 1409c0941aceSMukesh Sisodiya static inline int iwl_trans_write_imr_mem(struct iwl_trans *trans, 1410c0941aceSMukesh Sisodiya u32 dst_addr, u64 src_addr, 1411c0941aceSMukesh Sisodiya u32 byte_cnt) 1412c0941aceSMukesh Sisodiya { 1413c0941aceSMukesh Sisodiya if (trans->ops->imr_dma_data) 1414c0941aceSMukesh Sisodiya return trans->ops->imr_dma_data(trans, dst_addr, src_addr, byte_cnt); 1415c0941aceSMukesh Sisodiya return 0; 1416c0941aceSMukesh Sisodiya } 1417c0941aceSMukesh Sisodiya 1418e705c121SKalle Valo static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr) 1419e705c121SKalle Valo { 1420e705c121SKalle Valo u32 value; 1421e705c121SKalle Valo 1422e705c121SKalle Valo if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1))) 1423e705c121SKalle Valo return 0xa5a5a5a5; 1424e705c121SKalle Valo 1425e705c121SKalle Valo return value; 1426e705c121SKalle Valo } 1427e705c121SKalle Valo 1428e705c121SKalle Valo static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr, 1429e705c121SKalle Valo const void *buf, int dwords) 1430e705c121SKalle Valo { 1431e705c121SKalle Valo return trans->ops->write_mem(trans, addr, buf, dwords); 1432e705c121SKalle Valo } 1433e705c121SKalle Valo 1434e705c121SKalle Valo static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr, 1435e705c121SKalle Valo u32 val) 1436e705c121SKalle Valo { 1437e705c121SKalle Valo return iwl_trans_write_mem(trans, addr, &val, 1); 1438e705c121SKalle Valo } 1439e705c121SKalle Valo 1440e705c121SKalle Valo static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state) 1441e705c121SKalle Valo { 1442e705c121SKalle Valo if (trans->ops->set_pmi) 1443e705c121SKalle Valo trans->ops->set_pmi(trans, state); 1444e705c121SKalle Valo } 1445e705c121SKalle Valo 144615bf5ac6SJohannes Berg static inline int iwl_trans_sw_reset(struct iwl_trans *trans, 144715bf5ac6SJohannes Berg bool retake_ownership) 1448870c2a11SGolan Ben Ami { 1449870c2a11SGolan Ben Ami if (trans->ops->sw_reset) 145015bf5ac6SJohannes Berg return trans->ops->sw_reset(trans, retake_ownership); 145115bf5ac6SJohannes Berg return 0; 1452870c2a11SGolan Ben Ami } 1453870c2a11SGolan Ben Ami 1454e705c121SKalle Valo static inline void 1455e705c121SKalle Valo iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value) 1456e705c121SKalle Valo { 1457e705c121SKalle Valo trans->ops->set_bits_mask(trans, reg, mask, value); 1458e705c121SKalle Valo } 1459e705c121SKalle Valo 14601ed08f6fSJohannes Berg #define iwl_trans_grab_nic_access(trans) \ 1461e705c121SKalle Valo __cond_lock(nic_access, \ 14621ed08f6fSJohannes Berg likely((trans)->ops->grab_nic_access(trans))) 1463e705c121SKalle Valo 1464e705c121SKalle Valo static inline void __releases(nic_access) 14651ed08f6fSJohannes Berg iwl_trans_release_nic_access(struct iwl_trans *trans) 1466e705c121SKalle Valo { 14671ed08f6fSJohannes Berg trans->ops->release_nic_access(trans); 1468e705c121SKalle Valo __release(nic_access); 1469e705c121SKalle Valo } 1470e705c121SKalle Valo 1471b8221b0fSJohannes Berg static inline void iwl_trans_fw_error(struct iwl_trans *trans, bool sync) 1472e705c121SKalle Valo { 1473e705c121SKalle Valo if (WARN_ON_ONCE(!trans->op_mode)) 1474e705c121SKalle Valo return; 1475e705c121SKalle Valo 1476e705c121SKalle Valo /* prevent double restarts due to the same erroneous FW */ 1477152fdc0fSJohannes Berg if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status)) { 1478b8221b0fSJohannes Berg iwl_op_mode_nic_error(trans->op_mode, sync); 1479152fdc0fSJohannes Berg trans->state = IWL_TRANS_NO_FW; 1480152fdc0fSJohannes Berg } 1481e705c121SKalle Valo } 1482e705c121SKalle Valo 1483068893b7SShahar S Matityahu static inline bool iwl_trans_fw_running(struct iwl_trans *trans) 1484068893b7SShahar S Matityahu { 1485068893b7SShahar S Matityahu return trans->state == IWL_TRANS_FW_ALIVE; 1486068893b7SShahar S Matityahu } 1487068893b7SShahar S Matityahu 1488d1967ce6SShahar S Matityahu static inline void iwl_trans_sync_nmi(struct iwl_trans *trans) 1489d1967ce6SShahar S Matityahu { 1490d1967ce6SShahar S Matityahu if (trans->ops->sync_nmi) 1491d1967ce6SShahar S Matityahu trans->ops->sync_nmi(trans); 1492d1967ce6SShahar S Matityahu } 1493d1967ce6SShahar S Matityahu 14943161a34dSMordechay Goodstein void iwl_trans_sync_nmi_with_addr(struct iwl_trans *trans, u32 inta_addr, 14953161a34dSMordechay Goodstein u32 sw_err_bit); 14963161a34dSMordechay Goodstein 1497a182dfabSLuca Coelho static inline int iwl_trans_set_pnvm(struct iwl_trans *trans, 1498a182dfabSLuca Coelho const void *data, u32 len) 1499a182dfabSLuca Coelho { 150069725928SLuca Coelho if (trans->ops->set_pnvm) { 150169725928SLuca Coelho int ret = trans->ops->set_pnvm(trans, data, len); 150269725928SLuca Coelho 150369725928SLuca Coelho if (ret) 150469725928SLuca Coelho return ret; 150569725928SLuca Coelho } 150669725928SLuca Coelho 150769725928SLuca Coelho trans->pnvm_loaded = true; 1508a182dfabSLuca Coelho 1509a182dfabSLuca Coelho return 0; 1510a182dfabSLuca Coelho } 1511a182dfabSLuca Coelho 15129dad325fSLuca Coelho static inline int iwl_trans_set_reduce_power(struct iwl_trans *trans, 15139dad325fSLuca Coelho const void *data, u32 len) 15149dad325fSLuca Coelho { 15159dad325fSLuca Coelho if (trans->ops->set_reduce_power) { 15169dad325fSLuca Coelho int ret = trans->ops->set_reduce_power(trans, data, len); 15179dad325fSLuca Coelho 15189dad325fSLuca Coelho if (ret) 15199dad325fSLuca Coelho return ret; 15209dad325fSLuca Coelho } 15219dad325fSLuca Coelho 15229dad325fSLuca Coelho trans->reduce_power_loaded = true; 15239dad325fSLuca Coelho return 0; 15249dad325fSLuca Coelho } 15259dad325fSLuca Coelho 1526a1af4c48SShahar S Matityahu static inline bool iwl_trans_dbg_ini_valid(struct iwl_trans *trans) 1527a1af4c48SShahar S Matityahu { 1528341bd290SShahar S Matityahu return trans->dbg.internal_ini_cfg != IWL_INI_CFG_STATE_NOT_LOADED || 1529341bd290SShahar S Matityahu trans->dbg.external_ini_cfg != IWL_INI_CFG_STATE_NOT_LOADED; 1530a1af4c48SShahar S Matityahu } 1531a1af4c48SShahar S Matityahu 15323161a34dSMordechay Goodstein static inline void iwl_trans_interrupts(struct iwl_trans *trans, bool enable) 15333161a34dSMordechay Goodstein { 15343161a34dSMordechay Goodstein if (trans->ops->interrupts) 15353161a34dSMordechay Goodstein trans->ops->interrupts(trans, enable); 15363161a34dSMordechay Goodstein } 15373161a34dSMordechay Goodstein 1538e705c121SKalle Valo /***************************************************** 1539e705c121SKalle Valo * transport helper functions 1540e705c121SKalle Valo *****************************************************/ 1541e705c121SKalle Valo struct iwl_trans *iwl_trans_alloc(unsigned int priv_size, 1542e705c121SKalle Valo struct device *dev, 1543a89c72ffSJohannes Berg const struct iwl_trans_ops *ops, 1544fda1bd0dSMordechay Goodstein const struct iwl_cfg_trans_params *cfg_trans); 1545d12455fdSJohannes Berg int iwl_trans_init(struct iwl_trans *trans); 1546e705c121SKalle Valo void iwl_trans_free(struct iwl_trans *trans); 1547e705c121SKalle Valo 1548e705c121SKalle Valo /***************************************************** 1549e705c121SKalle Valo * driver (transport) register/unregister functions 1550e705c121SKalle Valo ******************************************************/ 1551e705c121SKalle Valo int __must_check iwl_pci_register_driver(void); 1552e705c121SKalle Valo void iwl_pci_unregister_driver(void); 1553b8133439SAvraham Stern void iwl_trans_pcie_remove(struct iwl_trans *trans, bool rescan); 1554e705c121SKalle Valo 1555e705c121SKalle Valo #endif /* __iwl_trans_h__ */ 1556