1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2 /* 3 * Copyright (C) 2005-2014, 2018-2022 Intel Corporation 4 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH 5 * Copyright (C) 2016-2017 Intel Deutschland GmbH 6 */ 7 #ifndef __iwl_trans_h__ 8 #define __iwl_trans_h__ 9 10 #include <linux/ieee80211.h> 11 #include <linux/mm.h> /* for page_address */ 12 #include <linux/lockdep.h> 13 #include <linux/kernel.h> 14 15 #include "iwl-debug.h" 16 #include "iwl-config.h" 17 #include "fw/img.h" 18 #include "iwl-op-mode.h" 19 #include <linux/firmware.h> 20 #include "fw/api/cmdhdr.h" 21 #include "fw/api/txq.h" 22 #include "fw/api/dbg-tlv.h" 23 #include "iwl-dbg-tlv.h" 24 25 /** 26 * DOC: Transport layer - what is it ? 27 * 28 * The transport layer is the layer that deals with the HW directly. It provides 29 * an abstraction of the underlying HW to the upper layer. The transport layer 30 * doesn't provide any policy, algorithm or anything of this kind, but only 31 * mechanisms to make the HW do something. It is not completely stateless but 32 * close to it. 33 * We will have an implementation for each different supported bus. 34 */ 35 36 /** 37 * DOC: Life cycle of the transport layer 38 * 39 * The transport layer has a very precise life cycle. 40 * 41 * 1) A helper function is called during the module initialization and 42 * registers the bus driver's ops with the transport's alloc function. 43 * 2) Bus's probe calls to the transport layer's allocation functions. 44 * Of course this function is bus specific. 45 * 3) This allocation functions will spawn the upper layer which will 46 * register mac80211. 47 * 48 * 4) At some point (i.e. mac80211's start call), the op_mode will call 49 * the following sequence: 50 * start_hw 51 * start_fw 52 * 53 * 5) Then when finished (or reset): 54 * stop_device 55 * 56 * 6) Eventually, the free function will be called. 57 */ 58 59 #define IWL_TRANS_FW_DBG_DOMAIN(trans) IWL_FW_INI_DOMAIN_ALWAYS_ON 60 61 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */ 62 #define FH_RSCSR_FRAME_INVALID 0x55550000 63 #define FH_RSCSR_FRAME_ALIGN 0x40 64 #define FH_RSCSR_RPA_EN BIT(25) 65 #define FH_RSCSR_RADA_EN BIT(26) 66 #define FH_RSCSR_RXQ_POS 16 67 #define FH_RSCSR_RXQ_MASK 0x3F0000 68 69 struct iwl_rx_packet { 70 /* 71 * The first 4 bytes of the RX frame header contain both the RX frame 72 * size and some flags. 73 * Bit fields: 74 * 31: flag flush RB request 75 * 30: flag ignore TC (terminal counter) request 76 * 29: flag fast IRQ request 77 * 28-27: Reserved 78 * 26: RADA enabled 79 * 25: Offload enabled 80 * 24: RPF enabled 81 * 23: RSS enabled 82 * 22: Checksum enabled 83 * 21-16: RX queue 84 * 15-14: Reserved 85 * 13-00: RX frame size 86 */ 87 __le32 len_n_flags; 88 struct iwl_cmd_header hdr; 89 u8 data[]; 90 } __packed; 91 92 static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt) 93 { 94 return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK; 95 } 96 97 static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt) 98 { 99 return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr); 100 } 101 102 /** 103 * enum CMD_MODE - how to send the host commands ? 104 * 105 * @CMD_ASYNC: Return right away and don't wait for the response 106 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of 107 * the response. The caller needs to call iwl_free_resp when done. 108 * @CMD_WANT_ASYNC_CALLBACK: the op_mode's async callback function must be 109 * called after this command completes. Valid only with CMD_ASYNC. 110 * @CMD_SEND_IN_D3: Allow the command to be sent in D3 mode, relevant to 111 * SUSPEND and RESUME commands. We are in D3 mode when we set 112 * trans->system_pm_mode to IWL_PLAT_PM_MODE_D3. 113 */ 114 enum CMD_MODE { 115 CMD_ASYNC = BIT(0), 116 CMD_WANT_SKB = BIT(1), 117 CMD_SEND_IN_RFKILL = BIT(2), 118 CMD_WANT_ASYNC_CALLBACK = BIT(3), 119 CMD_SEND_IN_D3 = BIT(4), 120 }; 121 122 #define DEF_CMD_PAYLOAD_SIZE 320 123 124 /** 125 * struct iwl_device_cmd 126 * 127 * For allocation of the command and tx queues, this establishes the overall 128 * size of the largest command we send to uCode, except for commands that 129 * aren't fully copied and use other TFD space. 130 */ 131 struct iwl_device_cmd { 132 union { 133 struct { 134 struct iwl_cmd_header hdr; /* uCode API */ 135 u8 payload[DEF_CMD_PAYLOAD_SIZE]; 136 }; 137 struct { 138 struct iwl_cmd_header_wide hdr_wide; 139 u8 payload_wide[DEF_CMD_PAYLOAD_SIZE - 140 sizeof(struct iwl_cmd_header_wide) + 141 sizeof(struct iwl_cmd_header)]; 142 }; 143 }; 144 } __packed; 145 146 /** 147 * struct iwl_device_tx_cmd - buffer for TX command 148 * @hdr: the header 149 * @payload: the payload placeholder 150 * 151 * The actual structure is sized dynamically according to need. 152 */ 153 struct iwl_device_tx_cmd { 154 struct iwl_cmd_header hdr; 155 u8 payload[]; 156 } __packed; 157 158 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd)) 159 160 /* 161 * number of transfer buffers (fragments) per transmit frame descriptor; 162 * this is just the driver's idea, the hardware supports 20 163 */ 164 #define IWL_MAX_CMD_TBS_PER_TFD 2 165 166 /* We need 2 entries for the TX command and header, and another one might 167 * be needed for potential data in the SKB's head. The remaining ones can 168 * be used for frags. 169 */ 170 #define IWL_TRANS_MAX_FRAGS(trans) ((trans)->txqs.tfd.max_tbs - 3) 171 172 /** 173 * enum iwl_hcmd_dataflag - flag for each one of the chunks of the command 174 * 175 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's 176 * ring. The transport layer doesn't map the command's buffer to DMA, but 177 * rather copies it to a previously allocated DMA buffer. This flag tells 178 * the transport layer not to copy the command, but to map the existing 179 * buffer (that is passed in) instead. This saves the memcpy and allows 180 * commands that are bigger than the fixed buffer to be submitted. 181 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one. 182 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this 183 * chunk internally and free it again after the command completes. This 184 * can (currently) be used only once per command. 185 * Note that a TFD entry after a DUP one cannot be a normal copied one. 186 */ 187 enum iwl_hcmd_dataflag { 188 IWL_HCMD_DFL_NOCOPY = BIT(0), 189 IWL_HCMD_DFL_DUP = BIT(1), 190 }; 191 192 enum iwl_error_event_table_status { 193 IWL_ERROR_EVENT_TABLE_LMAC1 = BIT(0), 194 IWL_ERROR_EVENT_TABLE_LMAC2 = BIT(1), 195 IWL_ERROR_EVENT_TABLE_UMAC = BIT(2), 196 IWL_ERROR_EVENT_TABLE_TCM1 = BIT(3), 197 IWL_ERROR_EVENT_TABLE_TCM2 = BIT(4), 198 IWL_ERROR_EVENT_TABLE_RCM1 = BIT(5), 199 IWL_ERROR_EVENT_TABLE_RCM2 = BIT(6), 200 }; 201 202 /** 203 * struct iwl_host_cmd - Host command to the uCode 204 * 205 * @data: array of chunks that composes the data of the host command 206 * @resp_pkt: response packet, if %CMD_WANT_SKB was set 207 * @_rx_page_order: (internally used to free response packet) 208 * @_rx_page_addr: (internally used to free response packet) 209 * @flags: can be CMD_* 210 * @len: array of the lengths of the chunks in data 211 * @dataflags: IWL_HCMD_DFL_* 212 * @id: command id of the host command, for wide commands encoding the 213 * version and group as well 214 */ 215 struct iwl_host_cmd { 216 const void *data[IWL_MAX_CMD_TBS_PER_TFD]; 217 struct iwl_rx_packet *resp_pkt; 218 unsigned long _rx_page_addr; 219 u32 _rx_page_order; 220 221 u32 flags; 222 u32 id; 223 u16 len[IWL_MAX_CMD_TBS_PER_TFD]; 224 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD]; 225 }; 226 227 static inline void iwl_free_resp(struct iwl_host_cmd *cmd) 228 { 229 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order); 230 } 231 232 struct iwl_rx_cmd_buffer { 233 struct page *_page; 234 int _offset; 235 bool _page_stolen; 236 u32 _rx_page_order; 237 unsigned int truesize; 238 }; 239 240 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r) 241 { 242 return (void *)((unsigned long)page_address(r->_page) + r->_offset); 243 } 244 245 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r) 246 { 247 return r->_offset; 248 } 249 250 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r) 251 { 252 r->_page_stolen = true; 253 get_page(r->_page); 254 return r->_page; 255 } 256 257 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r) 258 { 259 __free_pages(r->_page, r->_rx_page_order); 260 } 261 262 #define MAX_NO_RECLAIM_CMDS 6 263 264 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo)))) 265 266 /* 267 * Maximum number of HW queues the transport layer 268 * currently supports 269 */ 270 #define IWL_MAX_HW_QUEUES 32 271 #define IWL_MAX_TVQM_QUEUES 512 272 273 #define IWL_MAX_TID_COUNT 8 274 #define IWL_MGMT_TID 15 275 #define IWL_FRAME_LIMIT 64 276 #define IWL_MAX_RX_HW_QUEUES 16 277 #define IWL_9000_MAX_RX_HW_QUEUES 6 278 279 /** 280 * enum iwl_wowlan_status - WoWLAN image/device status 281 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume 282 * @IWL_D3_STATUS_RESET: device was reset while suspended 283 */ 284 enum iwl_d3_status { 285 IWL_D3_STATUS_ALIVE, 286 IWL_D3_STATUS_RESET, 287 }; 288 289 /** 290 * enum iwl_trans_status: transport status flags 291 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed 292 * @STATUS_DEVICE_ENABLED: APM is enabled 293 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up) 294 * @STATUS_INT_ENABLED: interrupts are enabled 295 * @STATUS_RFKILL_HW: the actual HW state of the RF-kill switch 296 * @STATUS_RFKILL_OPMODE: RF-kill state reported to opmode 297 * @STATUS_FW_ERROR: the fw is in error state 298 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands 299 * are sent 300 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent 301 * @STATUS_TRANS_DEAD: trans is dead - avoid any read/write operation 302 * @STATUS_SUPPRESS_CMD_ERROR_ONCE: suppress "FW error in SYNC CMD" once, 303 * e.g. for testing 304 */ 305 enum iwl_trans_status { 306 STATUS_SYNC_HCMD_ACTIVE, 307 STATUS_DEVICE_ENABLED, 308 STATUS_TPOWER_PMI, 309 STATUS_INT_ENABLED, 310 STATUS_RFKILL_HW, 311 STATUS_RFKILL_OPMODE, 312 STATUS_FW_ERROR, 313 STATUS_TRANS_GOING_IDLE, 314 STATUS_TRANS_IDLE, 315 STATUS_TRANS_DEAD, 316 STATUS_SUPPRESS_CMD_ERROR_ONCE, 317 }; 318 319 static inline int 320 iwl_trans_get_rb_size_order(enum iwl_amsdu_size rb_size) 321 { 322 switch (rb_size) { 323 case IWL_AMSDU_2K: 324 return get_order(2 * 1024); 325 case IWL_AMSDU_4K: 326 return get_order(4 * 1024); 327 case IWL_AMSDU_8K: 328 return get_order(8 * 1024); 329 case IWL_AMSDU_12K: 330 return get_order(16 * 1024); 331 default: 332 WARN_ON(1); 333 return -1; 334 } 335 } 336 337 static inline int 338 iwl_trans_get_rb_size(enum iwl_amsdu_size rb_size) 339 { 340 switch (rb_size) { 341 case IWL_AMSDU_2K: 342 return 2 * 1024; 343 case IWL_AMSDU_4K: 344 return 4 * 1024; 345 case IWL_AMSDU_8K: 346 return 8 * 1024; 347 case IWL_AMSDU_12K: 348 return 16 * 1024; 349 default: 350 WARN_ON(1); 351 return 0; 352 } 353 } 354 355 struct iwl_hcmd_names { 356 u8 cmd_id; 357 const char *const cmd_name; 358 }; 359 360 #define HCMD_NAME(x) \ 361 { .cmd_id = x, .cmd_name = #x } 362 363 struct iwl_hcmd_arr { 364 const struct iwl_hcmd_names *arr; 365 int size; 366 }; 367 368 #define HCMD_ARR(x) \ 369 { .arr = x, .size = ARRAY_SIZE(x) } 370 371 /** 372 * struct iwl_dump_sanitize_ops - dump sanitization operations 373 * @frob_txf: Scrub the TX FIFO data 374 * @frob_hcmd: Scrub a host command, the %hcmd pointer is to the header 375 * but that might be short or long (&struct iwl_cmd_header or 376 * &struct iwl_cmd_header_wide) 377 * @frob_mem: Scrub memory data 378 */ 379 struct iwl_dump_sanitize_ops { 380 void (*frob_txf)(void *ctx, void *buf, size_t buflen); 381 void (*frob_hcmd)(void *ctx, void *hcmd, size_t buflen); 382 void (*frob_mem)(void *ctx, u32 mem_addr, void *mem, size_t buflen); 383 }; 384 385 /** 386 * struct iwl_trans_config - transport configuration 387 * 388 * @op_mode: pointer to the upper layer. 389 * @cmd_queue: the index of the command queue. 390 * Must be set before start_fw. 391 * @cmd_fifo: the fifo for host commands 392 * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue. 393 * @no_reclaim_cmds: Some devices erroneously don't set the 394 * SEQ_RX_FRAME bit on some notifications, this is the 395 * list of such notifications to filter. Max length is 396 * %MAX_NO_RECLAIM_CMDS. 397 * @n_no_reclaim_cmds: # of commands in list 398 * @rx_buf_size: RX buffer size needed for A-MSDUs 399 * if unset 4k will be the RX buffer size 400 * @bc_table_dword: set to true if the BC table expects the byte count to be 401 * in DWORD (as opposed to bytes) 402 * @scd_set_active: should the transport configure the SCD for HCMD queue 403 * @command_groups: array of command groups, each member is an array of the 404 * commands in the group; for debugging only 405 * @command_groups_size: number of command groups, to avoid illegal access 406 * @cb_data_offs: offset inside skb->cb to store transport data at, must have 407 * space for at least two pointers 408 * @fw_reset_handshake: firmware supports reset flow handshake 409 * @queue_alloc_cmd_ver: queue allocation command version, set to 0 410 * for using the older SCD_QUEUE_CFG, set to the version of 411 * SCD_QUEUE_CONFIG_CMD otherwise. 412 */ 413 struct iwl_trans_config { 414 struct iwl_op_mode *op_mode; 415 416 u8 cmd_queue; 417 u8 cmd_fifo; 418 unsigned int cmd_q_wdg_timeout; 419 const u8 *no_reclaim_cmds; 420 unsigned int n_no_reclaim_cmds; 421 422 enum iwl_amsdu_size rx_buf_size; 423 bool bc_table_dword; 424 bool scd_set_active; 425 const struct iwl_hcmd_arr *command_groups; 426 int command_groups_size; 427 428 u8 cb_data_offs; 429 bool fw_reset_handshake; 430 u8 queue_alloc_cmd_ver; 431 }; 432 433 struct iwl_trans_dump_data { 434 u32 len; 435 u8 data[]; 436 }; 437 438 struct iwl_trans; 439 440 struct iwl_trans_txq_scd_cfg { 441 u8 fifo; 442 u8 sta_id; 443 u8 tid; 444 bool aggregate; 445 int frame_limit; 446 }; 447 448 /** 449 * struct iwl_trans_rxq_dma_data - RX queue DMA data 450 * @fr_bd_cb: DMA address of free BD cyclic buffer 451 * @fr_bd_wid: Initial write index of the free BD cyclic buffer 452 * @urbd_stts_wrptr: DMA address of urbd_stts_wrptr 453 * @ur_bd_cb: DMA address of used BD cyclic buffer 454 */ 455 struct iwl_trans_rxq_dma_data { 456 u64 fr_bd_cb; 457 u32 fr_bd_wid; 458 u64 urbd_stts_wrptr; 459 u64 ur_bd_cb; 460 }; 461 462 /* maximal number of DRAM MAP entries supported by FW */ 463 #define IPC_DRAM_MAP_ENTRY_NUM_MAX 64 464 465 /** 466 * struct iwl_pnvm_image - contains info about the parsed pnvm image 467 * @chunks: array of pointers to pnvm payloads and their sizes 468 * @n_chunks: the number of the pnvm payloads. 469 */ 470 struct iwl_pnvm_image { 471 struct { 472 const void *data; 473 u32 len; 474 } chunks[IPC_DRAM_MAP_ENTRY_NUM_MAX]; 475 u32 n_chunks; 476 }; 477 478 /** 479 * struct iwl_trans_ops - transport specific operations 480 * 481 * All the handlers MUST be implemented 482 * 483 * @start_hw: starts the HW. From that point on, the HW can send interrupts. 484 * May sleep. 485 * @op_mode_leave: Turn off the HW RF kill indication if on 486 * May sleep 487 * @start_fw: allocates and inits all the resources for the transport 488 * layer. Also kick a fw image. 489 * May sleep 490 * @fw_alive: called when the fw sends alive notification. If the fw provides 491 * the SCD base address in SRAM, then provide it here, or 0 otherwise. 492 * May sleep 493 * @stop_device: stops the whole device (embedded CPU put to reset) and stops 494 * the HW. From that point on, the HW will be stopped but will still issue 495 * an interrupt if the HW RF kill switch is triggered. 496 * This callback must do the right thing and not crash even if %start_hw() 497 * was called but not &start_fw(). May sleep. 498 * @d3_suspend: put the device into the correct mode for WoWLAN during 499 * suspend. This is optional, if not implemented WoWLAN will not be 500 * supported. This callback may sleep. 501 * @d3_resume: resume the device after WoWLAN, enabling the opmode to 502 * talk to the WoWLAN image to get its status. This is optional, if not 503 * implemented WoWLAN will not be supported. This callback may sleep. 504 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted. 505 * If RFkill is asserted in the middle of a SYNC host command, it must 506 * return -ERFKILL straight away. 507 * May sleep only if CMD_ASYNC is not set 508 * @tx: send an skb. The transport relies on the op_mode to zero the 509 * the ieee80211_tx_info->driver_data. If the MPDU is an A-MSDU, all 510 * the CSUM will be taken care of (TCP CSUM and IP header in case of 511 * IPv4). If the MPDU is a single MSDU, the op_mode must compute the IP 512 * header if it is IPv4. 513 * Must be atomic 514 * @reclaim: free packet until ssn. Returns a list of freed packets. 515 * Must be atomic 516 * @txq_enable: setup a queue. To setup an AC queue, use the 517 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before 518 * this one. The op_mode must not configure the HCMD queue. The scheduler 519 * configuration may be %NULL, in which case the hardware will not be 520 * configured. If true is returned, the operation mode needs to increment 521 * the sequence number of the packets routed to this queue because of a 522 * hardware scheduler bug. May sleep. 523 * @txq_disable: de-configure a Tx queue to send AMPDUs 524 * Must be atomic 525 * @txq_set_shared_mode: change Tx queue shared/unshared marking 526 * @wait_tx_queues_empty: wait until tx queues are empty. May sleep. 527 * @wait_txq_empty: wait until specific tx queue is empty. May sleep. 528 * @freeze_txq_timer: prevents the timer of the queue from firing until the 529 * queue is set to awake. Must be atomic. 530 * @block_txq_ptrs: stop updating the write pointers of the Tx queues. Note 531 * that the transport needs to refcount the calls since this function 532 * will be called several times with block = true, and then the queues 533 * need to be unblocked only after the same number of calls with 534 * block = false. 535 * @write8: write a u8 to a register at offset ofs from the BAR 536 * @write32: write a u32 to a register at offset ofs from the BAR 537 * @read32: read a u32 register at offset ofs from the BAR 538 * @read_prph: read a DWORD from a periphery register 539 * @write_prph: write a DWORD to a periphery register 540 * @read_mem: read device's SRAM in DWORD 541 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory 542 * will be zeroed. 543 * @read_config32: read a u32 value from the device's config space at 544 * the given offset. 545 * @configure: configure parameters required by the transport layer from 546 * the op_mode. May be called several times before start_fw, can't be 547 * called after that. 548 * @set_pmi: set the power pmi state 549 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs. 550 * Sleeping is not allowed between grab_nic_access and 551 * release_nic_access. 552 * @release_nic_access: let the NIC go to sleep. The "flags" parameter 553 * must be the same one that was sent before to the grab_nic_access. 554 * @set_bits_mask - set SRAM register according to value and mask. 555 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last 556 * TX'ed commands and similar. The buffer will be vfree'd by the caller. 557 * Note that the transport must fill in the proper file headers. 558 * @debugfs_cleanup: used in the driver unload flow to make a proper cleanup 559 * of the trans debugfs 560 * @load_pnvm: save the pnvm data in DRAM 561 * @set_pnvm: set the pnvm data in the prph scratch buffer, inside the 562 * context info. 563 * @interrupts: disable/enable interrupts to transport 564 */ 565 struct iwl_trans_ops { 566 567 int (*start_hw)(struct iwl_trans *iwl_trans); 568 void (*op_mode_leave)(struct iwl_trans *iwl_trans); 569 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw, 570 bool run_in_rfkill); 571 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr); 572 void (*stop_device)(struct iwl_trans *trans); 573 574 int (*d3_suspend)(struct iwl_trans *trans, bool test, bool reset); 575 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status, 576 bool test, bool reset); 577 578 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd); 579 580 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb, 581 struct iwl_device_tx_cmd *dev_cmd, int queue); 582 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn, 583 struct sk_buff_head *skbs); 584 585 void (*set_q_ptrs)(struct iwl_trans *trans, int queue, int ptr); 586 587 bool (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn, 588 const struct iwl_trans_txq_scd_cfg *cfg, 589 unsigned int queue_wdg_timeout); 590 void (*txq_disable)(struct iwl_trans *trans, int queue, 591 bool configure_scd); 592 /* 22000 functions */ 593 int (*txq_alloc)(struct iwl_trans *trans, u32 flags, 594 u32 sta_mask, u8 tid, 595 int size, unsigned int queue_wdg_timeout); 596 void (*txq_free)(struct iwl_trans *trans, int queue); 597 int (*rxq_dma_data)(struct iwl_trans *trans, int queue, 598 struct iwl_trans_rxq_dma_data *data); 599 600 void (*txq_set_shared_mode)(struct iwl_trans *trans, u32 txq_id, 601 bool shared); 602 603 int (*wait_tx_queues_empty)(struct iwl_trans *trans, u32 txq_bm); 604 int (*wait_txq_empty)(struct iwl_trans *trans, int queue); 605 void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs, 606 bool freeze); 607 void (*block_txq_ptrs)(struct iwl_trans *trans, bool block); 608 609 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val); 610 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val); 611 u32 (*read32)(struct iwl_trans *trans, u32 ofs); 612 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs); 613 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val); 614 int (*read_mem)(struct iwl_trans *trans, u32 addr, 615 void *buf, int dwords); 616 int (*write_mem)(struct iwl_trans *trans, u32 addr, 617 const void *buf, int dwords); 618 int (*read_config32)(struct iwl_trans *trans, u32 ofs, u32 *val); 619 void (*configure)(struct iwl_trans *trans, 620 const struct iwl_trans_config *trans_cfg); 621 void (*set_pmi)(struct iwl_trans *trans, bool state); 622 int (*sw_reset)(struct iwl_trans *trans, bool retake_ownership); 623 bool (*grab_nic_access)(struct iwl_trans *trans); 624 void (*release_nic_access)(struct iwl_trans *trans); 625 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask, 626 u32 value); 627 628 struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans, 629 u32 dump_mask, 630 const struct iwl_dump_sanitize_ops *sanitize_ops, 631 void *sanitize_ctx); 632 void (*debugfs_cleanup)(struct iwl_trans *trans); 633 void (*sync_nmi)(struct iwl_trans *trans); 634 int (*load_pnvm)(struct iwl_trans *trans, 635 const struct iwl_pnvm_image *pnvm_payloads); 636 void (*set_pnvm)(struct iwl_trans *trans); 637 int (*set_reduce_power)(struct iwl_trans *trans, 638 const void *data, u32 len); 639 void (*interrupts)(struct iwl_trans *trans, bool enable); 640 int (*imr_dma_data)(struct iwl_trans *trans, 641 u32 dst_addr, u64 src_addr, 642 u32 byte_cnt); 643 644 }; 645 646 /** 647 * enum iwl_trans_state - state of the transport layer 648 * 649 * @IWL_TRANS_NO_FW: firmware wasn't started yet, or crashed 650 * @IWL_TRANS_FW_STARTED: FW was started, but not alive yet 651 * @IWL_TRANS_FW_ALIVE: FW has sent an alive response 652 */ 653 enum iwl_trans_state { 654 IWL_TRANS_NO_FW, 655 IWL_TRANS_FW_STARTED, 656 IWL_TRANS_FW_ALIVE, 657 }; 658 659 /** 660 * DOC: Platform power management 661 * 662 * In system-wide power management the entire platform goes into a low 663 * power state (e.g. idle or suspend to RAM) at the same time and the 664 * device is configured as a wakeup source for the entire platform. 665 * This is usually triggered by userspace activity (e.g. the user 666 * presses the suspend button or a power management daemon decides to 667 * put the platform in low power mode). The device's behavior in this 668 * mode is dictated by the wake-on-WLAN configuration. 669 * 670 * The terms used for the device's behavior are as follows: 671 * 672 * - D0: the device is fully powered and the host is awake; 673 * - D3: the device is in low power mode and only reacts to 674 * specific events (e.g. magic-packet received or scan 675 * results found); 676 * 677 * These terms reflect the power modes in the firmware and are not to 678 * be confused with the physical device power state. 679 */ 680 681 /** 682 * enum iwl_plat_pm_mode - platform power management mode 683 * 684 * This enumeration describes the device's platform power management 685 * behavior when in system-wide suspend (i.e WoWLAN). 686 * 687 * @IWL_PLAT_PM_MODE_DISABLED: power management is disabled for this 688 * device. In system-wide suspend mode, it means that the all 689 * connections will be closed automatically by mac80211 before 690 * the platform is suspended. 691 * @IWL_PLAT_PM_MODE_D3: the device goes into D3 mode (i.e. WoWLAN). 692 */ 693 enum iwl_plat_pm_mode { 694 IWL_PLAT_PM_MODE_DISABLED, 695 IWL_PLAT_PM_MODE_D3, 696 }; 697 698 /** 699 * enum iwl_ini_cfg_state 700 * @IWL_INI_CFG_STATE_NOT_LOADED: no debug cfg was given 701 * @IWL_INI_CFG_STATE_LOADED: debug cfg was found and loaded 702 * @IWL_INI_CFG_STATE_CORRUPTED: debug cfg was found and some of the TLVs 703 * are corrupted. The rest of the debug TLVs will still be used 704 */ 705 enum iwl_ini_cfg_state { 706 IWL_INI_CFG_STATE_NOT_LOADED, 707 IWL_INI_CFG_STATE_LOADED, 708 IWL_INI_CFG_STATE_CORRUPTED, 709 }; 710 711 /* Max time to wait for nmi interrupt */ 712 #define IWL_TRANS_NMI_TIMEOUT (HZ / 4) 713 714 /** 715 * struct iwl_dram_data 716 * @physical: page phy pointer 717 * @block: pointer to the allocated block/page 718 * @size: size of the block/page 719 */ 720 struct iwl_dram_data { 721 dma_addr_t physical; 722 void *block; 723 int size; 724 }; 725 726 /** 727 * struct iwl_fw_mon - fw monitor per allocation id 728 * @num_frags: number of fragments 729 * @frags: an array of DRAM buffer fragments 730 */ 731 struct iwl_fw_mon { 732 u32 num_frags; 733 struct iwl_dram_data *frags; 734 }; 735 736 /** 737 * struct iwl_self_init_dram - dram data used by self init process 738 * @fw: lmac and umac dram data 739 * @fw_cnt: total number of items in array 740 * @paging: paging dram data 741 * @paging_cnt: total number of items in array 742 */ 743 struct iwl_self_init_dram { 744 struct iwl_dram_data *fw; 745 int fw_cnt; 746 struct iwl_dram_data *paging; 747 int paging_cnt; 748 }; 749 750 /** 751 * struct iwl_imr_data - imr dram data used during debug process 752 * @imr_enable: imr enable status received from fw 753 * @imr_size: imr dram size received from fw 754 * @sram_addr: sram address from debug tlv 755 * @sram_size: sram size from debug tlv 756 * @imr2sram_remainbyte`: size remained after each dma transfer 757 * @imr_curr_addr: current dst address used during dma transfer 758 * @imr_base_addr: imr address received from fw 759 */ 760 struct iwl_imr_data { 761 u32 imr_enable; 762 u32 imr_size; 763 u32 sram_addr; 764 u32 sram_size; 765 u32 imr2sram_remainbyte; 766 u64 imr_curr_addr; 767 __le64 imr_base_addr; 768 }; 769 770 #define IWL_TRANS_CURRENT_PC_NAME_MAX_BYTES 32 771 772 /** 773 * struct iwl_pc_data - program counter details 774 * @pc_name: cpu name 775 * @pc_address: cpu program counter 776 */ 777 struct iwl_pc_data { 778 u8 pc_name[IWL_TRANS_CURRENT_PC_NAME_MAX_BYTES]; 779 u32 pc_address; 780 }; 781 782 /** 783 * struct iwl_trans_debug - transport debug related data 784 * 785 * @n_dest_reg: num of reg_ops in %dbg_dest_tlv 786 * @rec_on: true iff there is a fw debug recording currently active 787 * @dest_tlv: points to the destination TLV for debug 788 * @conf_tlv: array of pointers to configuration TLVs for debug 789 * @trigger_tlv: array of pointers to triggers TLVs for debug 790 * @lmac_error_event_table: addrs of lmacs error tables 791 * @umac_error_event_table: addr of umac error table 792 * @tcm_error_event_table: address(es) of TCM error table(s) 793 * @rcm_error_event_table: address(es) of RCM error table(s) 794 * @error_event_table_tlv_status: bitmap that indicates what error table 795 * pointers was recevied via TLV. uses enum &iwl_error_event_table_status 796 * @internal_ini_cfg: internal debug cfg state. Uses &enum iwl_ini_cfg_state 797 * @external_ini_cfg: external debug cfg state. Uses &enum iwl_ini_cfg_state 798 * @fw_mon_cfg: debug buffer allocation configuration 799 * @fw_mon_ini: DRAM buffer fragments per allocation id 800 * @fw_mon: DRAM buffer for firmware monitor 801 * @hw_error: equals true if hw error interrupt was received from the FW 802 * @ini_dest: debug monitor destination uses &enum iwl_fw_ini_buffer_location 803 * @active_regions: active regions 804 * @debug_info_tlv_list: list of debug info TLVs 805 * @time_point: array of debug time points 806 * @periodic_trig_list: periodic triggers list 807 * @domains_bitmap: bitmap of active domains other than &IWL_FW_INI_DOMAIN_ALWAYS_ON 808 * @ucode_preset: preset based on ucode 809 * @dump_file_name_ext: dump file name extension 810 * @dump_file_name_ext_valid: dump file name extension if valid or not 811 * @num_pc: number of program counter for cpu 812 * @pc_data: details of the program counter 813 */ 814 struct iwl_trans_debug { 815 u8 n_dest_reg; 816 bool rec_on; 817 818 const struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv; 819 const struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX]; 820 struct iwl_fw_dbg_trigger_tlv * const *trigger_tlv; 821 822 u32 lmac_error_event_table[2]; 823 u32 umac_error_event_table; 824 u32 tcm_error_event_table[2]; 825 u32 rcm_error_event_table[2]; 826 unsigned int error_event_table_tlv_status; 827 828 enum iwl_ini_cfg_state internal_ini_cfg; 829 enum iwl_ini_cfg_state external_ini_cfg; 830 831 struct iwl_fw_ini_allocation_tlv fw_mon_cfg[IWL_FW_INI_ALLOCATION_NUM]; 832 struct iwl_fw_mon fw_mon_ini[IWL_FW_INI_ALLOCATION_NUM]; 833 834 struct iwl_dram_data fw_mon; 835 836 bool hw_error; 837 enum iwl_fw_ini_buffer_location ini_dest; 838 839 u64 unsupported_region_msk; 840 struct iwl_ucode_tlv *active_regions[IWL_FW_INI_MAX_REGION_ID]; 841 struct list_head debug_info_tlv_list; 842 struct iwl_dbg_tlv_time_point_data 843 time_point[IWL_FW_INI_TIME_POINT_NUM]; 844 struct list_head periodic_trig_list; 845 846 u32 domains_bitmap; 847 u32 ucode_preset; 848 bool restart_required; 849 u32 last_tp_resetfw; 850 struct iwl_imr_data imr_data; 851 u8 dump_file_name_ext[IWL_FW_INI_MAX_NAME]; 852 bool dump_file_name_ext_valid; 853 u32 num_pc; 854 struct iwl_pc_data *pc_data; 855 }; 856 857 struct iwl_dma_ptr { 858 dma_addr_t dma; 859 void *addr; 860 size_t size; 861 }; 862 863 struct iwl_cmd_meta { 864 /* only for SYNC commands, iff the reply skb is wanted */ 865 struct iwl_host_cmd *source; 866 u32 flags; 867 u32 tbs; 868 }; 869 870 /* 871 * The FH will write back to the first TB only, so we need to copy some data 872 * into the buffer regardless of whether it should be mapped or not. 873 * This indicates how big the first TB must be to include the scratch buffer 874 * and the assigned PN. 875 * Since PN location is 8 bytes at offset 12, it's 20 now. 876 * If we make it bigger then allocations will be bigger and copy slower, so 877 * that's probably not useful. 878 */ 879 #define IWL_FIRST_TB_SIZE 20 880 #define IWL_FIRST_TB_SIZE_ALIGN ALIGN(IWL_FIRST_TB_SIZE, 64) 881 882 struct iwl_pcie_txq_entry { 883 void *cmd; 884 struct sk_buff *skb; 885 /* buffer to free after command completes */ 886 const void *free_buf; 887 struct iwl_cmd_meta meta; 888 }; 889 890 struct iwl_pcie_first_tb_buf { 891 u8 buf[IWL_FIRST_TB_SIZE_ALIGN]; 892 }; 893 894 /** 895 * struct iwl_txq - Tx Queue for DMA 896 * @q: generic Rx/Tx queue descriptor 897 * @tfds: transmit frame descriptors (DMA memory) 898 * @first_tb_bufs: start of command headers, including scratch buffers, for 899 * the writeback -- this is DMA memory and an array holding one buffer 900 * for each command on the queue 901 * @first_tb_dma: DMA address for the first_tb_bufs start 902 * @entries: transmit entries (driver state) 903 * @lock: queue lock 904 * @stuck_timer: timer that fires if queue gets stuck 905 * @trans: pointer back to transport (for timer) 906 * @need_update: indicates need to update read/write index 907 * @ampdu: true if this queue is an ampdu queue for an specific RA/TID 908 * @wd_timeout: queue watchdog timeout (jiffies) - per queue 909 * @frozen: tx stuck queue timer is frozen 910 * @frozen_expiry_remainder: remember how long until the timer fires 911 * @bc_tbl: byte count table of the queue (relevant only for gen2 transport) 912 * @write_ptr: 1-st empty entry (index) host_w 913 * @read_ptr: last used entry (index) host_r 914 * @dma_addr: physical addr for BD's 915 * @n_window: safe queue window 916 * @id: queue id 917 * @low_mark: low watermark, resume queue if free space more than this 918 * @high_mark: high watermark, stop queue if free space less than this 919 * 920 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame 921 * descriptors) and required locking structures. 922 * 923 * Note the difference between TFD_QUEUE_SIZE_MAX and n_window: the hardware 924 * always assumes 256 descriptors, so TFD_QUEUE_SIZE_MAX is always 256 (unless 925 * there might be HW changes in the future). For the normal TX 926 * queues, n_window, which is the size of the software queue data 927 * is also 256; however, for the command queue, n_window is only 928 * 32 since we don't need so many commands pending. Since the HW 929 * still uses 256 BDs for DMA though, TFD_QUEUE_SIZE_MAX stays 256. 930 * This means that we end up with the following: 931 * HW entries: | 0 | ... | N * 32 | ... | N * 32 + 31 | ... | 255 | 932 * SW entries: | 0 | ... | 31 | 933 * where N is a number between 0 and 7. This means that the SW 934 * data is a window overlayed over the HW queue. 935 */ 936 struct iwl_txq { 937 void *tfds; 938 struct iwl_pcie_first_tb_buf *first_tb_bufs; 939 dma_addr_t first_tb_dma; 940 struct iwl_pcie_txq_entry *entries; 941 /* lock for syncing changes on the queue */ 942 spinlock_t lock; 943 unsigned long frozen_expiry_remainder; 944 struct timer_list stuck_timer; 945 struct iwl_trans *trans; 946 bool need_update; 947 bool frozen; 948 bool ampdu; 949 int block; 950 unsigned long wd_timeout; 951 struct sk_buff_head overflow_q; 952 struct iwl_dma_ptr bc_tbl; 953 954 int write_ptr; 955 int read_ptr; 956 dma_addr_t dma_addr; 957 int n_window; 958 u32 id; 959 int low_mark; 960 int high_mark; 961 962 bool overflow_tx; 963 }; 964 965 /** 966 * struct iwl_trans_txqs - transport tx queues data 967 * 968 * @bc_table_dword: true if the BC table expects DWORD (as opposed to bytes) 969 * @page_offs: offset from skb->cb to mac header page pointer 970 * @dev_cmd_offs: offset from skb->cb to iwl_device_tx_cmd pointer 971 * @queue_used - bit mask of used queues 972 * @queue_stopped - bit mask of stopped queues 973 * @scd_bc_tbls: gen1 pointer to the byte count table of the scheduler 974 * @queue_alloc_cmd_ver: queue allocation command version 975 */ 976 struct iwl_trans_txqs { 977 unsigned long queue_used[BITS_TO_LONGS(IWL_MAX_TVQM_QUEUES)]; 978 unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_TVQM_QUEUES)]; 979 struct iwl_txq *txq[IWL_MAX_TVQM_QUEUES]; 980 struct dma_pool *bc_pool; 981 size_t bc_tbl_size; 982 bool bc_table_dword; 983 u8 page_offs; 984 u8 dev_cmd_offs; 985 struct iwl_tso_hdr_page __percpu *tso_hdr_page; 986 987 struct { 988 u8 fifo; 989 u8 q_id; 990 unsigned int wdg_timeout; 991 } cmd; 992 993 struct { 994 u8 max_tbs; 995 u16 size; 996 u8 addr_size; 997 } tfd; 998 999 struct iwl_dma_ptr scd_bc_tbls; 1000 1001 u8 queue_alloc_cmd_ver; 1002 }; 1003 1004 /** 1005 * struct iwl_trans - transport common data 1006 * 1007 * @csme_own - true if we couldn't get ownership on the device 1008 * @ops - pointer to iwl_trans_ops 1009 * @op_mode - pointer to the op_mode 1010 * @trans_cfg: the trans-specific configuration part 1011 * @cfg - pointer to the configuration 1012 * @drv - pointer to iwl_drv 1013 * @status: a bit-mask of transport status flags 1014 * @dev - pointer to struct device * that represents the device 1015 * @max_skb_frags: maximum number of fragments an SKB can have when transmitted. 1016 * 0 indicates that frag SKBs (NETIF_F_SG) aren't supported. 1017 * @hw_rf_id a u32 with the device RF ID 1018 * @hw_crf_id a u32 with the device CRF ID 1019 * @hw_wfpm_id a u32 with the device wfpm ID 1020 * @hw_id: a u32 with the ID of the device / sub-device. 1021 * Set during transport allocation. 1022 * @hw_id_str: a string with info about HW ID. Set during transport allocation. 1023 * @hw_rev_step: The mac step of the HW 1024 * @pm_support: set to true in start_hw if link pm is supported 1025 * @ltr_enabled: set to true if the LTR is enabled 1026 * @wide_cmd_header: true when ucode supports wide command header format 1027 * @wait_command_queue: wait queue for sync commands 1028 * @num_rx_queues: number of RX queues allocated by the transport; 1029 * the transport must set this before calling iwl_drv_start() 1030 * @iml_len: the length of the image loader 1031 * @iml: a pointer to the image loader itself 1032 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only. 1033 * The user should use iwl_trans_{alloc,free}_tx_cmd. 1034 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before 1035 * starting the firmware, used for tracing 1036 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the 1037 * start of the 802.11 header in the @rx_mpdu_cmd 1038 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI) 1039 * @system_pm_mode: the system-wide power management mode in use. 1040 * This mode is set dynamically, depending on the WoWLAN values 1041 * configured from the userspace at runtime. 1042 * @iwl_trans_txqs: transport tx queues data. 1043 * @mbx_addr_0_step: step address data 0 1044 * @mbx_addr_1_step: step address data 1 1045 */ 1046 struct iwl_trans { 1047 bool csme_own; 1048 const struct iwl_trans_ops *ops; 1049 struct iwl_op_mode *op_mode; 1050 const struct iwl_cfg_trans_params *trans_cfg; 1051 const struct iwl_cfg *cfg; 1052 struct iwl_drv *drv; 1053 enum iwl_trans_state state; 1054 unsigned long status; 1055 1056 struct device *dev; 1057 u32 max_skb_frags; 1058 u32 hw_rev; 1059 u32 hw_rev_step; 1060 u32 hw_rf_id; 1061 u32 hw_crf_id; 1062 u32 hw_cnv_id; 1063 u32 hw_wfpm_id; 1064 u32 hw_id; 1065 char hw_id_str[52]; 1066 u32 sku_id[3]; 1067 1068 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size; 1069 1070 bool pm_support; 1071 bool ltr_enabled; 1072 u8 pnvm_loaded:1; 1073 u8 reduce_power_loaded:1; 1074 1075 const struct iwl_hcmd_arr *command_groups; 1076 int command_groups_size; 1077 bool wide_cmd_header; 1078 1079 wait_queue_head_t wait_command_queue; 1080 u8 num_rx_queues; 1081 1082 size_t iml_len; 1083 u8 *iml; 1084 1085 /* The following fields are internal only */ 1086 struct kmem_cache *dev_cmd_pool; 1087 char dev_cmd_pool_name[50]; 1088 1089 struct dentry *dbgfs_dir; 1090 1091 #ifdef CONFIG_LOCKDEP 1092 struct lockdep_map sync_cmd_lockdep_map; 1093 #endif 1094 1095 struct iwl_trans_debug dbg; 1096 struct iwl_self_init_dram init_dram; 1097 1098 enum iwl_plat_pm_mode system_pm_mode; 1099 1100 const char *name; 1101 struct iwl_trans_txqs txqs; 1102 u32 mbx_addr_0_step; 1103 u32 mbx_addr_1_step; 1104 1105 /* pointer to trans specific struct */ 1106 /*Ensure that this pointer will always be aligned to sizeof pointer */ 1107 char trans_specific[] __aligned(sizeof(void *)); 1108 }; 1109 1110 const char *iwl_get_cmd_string(struct iwl_trans *trans, u32 id); 1111 int iwl_cmd_groups_verify_sorted(const struct iwl_trans_config *trans); 1112 1113 static inline void iwl_trans_configure(struct iwl_trans *trans, 1114 const struct iwl_trans_config *trans_cfg) 1115 { 1116 trans->op_mode = trans_cfg->op_mode; 1117 1118 trans->ops->configure(trans, trans_cfg); 1119 WARN_ON(iwl_cmd_groups_verify_sorted(trans_cfg)); 1120 } 1121 1122 static inline int iwl_trans_start_hw(struct iwl_trans *trans) 1123 { 1124 might_sleep(); 1125 1126 return trans->ops->start_hw(trans); 1127 } 1128 1129 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans) 1130 { 1131 might_sleep(); 1132 1133 if (trans->ops->op_mode_leave) 1134 trans->ops->op_mode_leave(trans); 1135 1136 trans->op_mode = NULL; 1137 1138 trans->state = IWL_TRANS_NO_FW; 1139 } 1140 1141 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr) 1142 { 1143 might_sleep(); 1144 1145 trans->state = IWL_TRANS_FW_ALIVE; 1146 1147 trans->ops->fw_alive(trans, scd_addr); 1148 } 1149 1150 static inline int iwl_trans_start_fw(struct iwl_trans *trans, 1151 const struct fw_img *fw, 1152 bool run_in_rfkill) 1153 { 1154 int ret; 1155 1156 might_sleep(); 1157 1158 WARN_ON_ONCE(!trans->rx_mpdu_cmd); 1159 1160 clear_bit(STATUS_FW_ERROR, &trans->status); 1161 ret = trans->ops->start_fw(trans, fw, run_in_rfkill); 1162 if (ret == 0) 1163 trans->state = IWL_TRANS_FW_STARTED; 1164 1165 return ret; 1166 } 1167 1168 static inline void iwl_trans_stop_device(struct iwl_trans *trans) 1169 { 1170 might_sleep(); 1171 1172 trans->ops->stop_device(trans); 1173 1174 trans->state = IWL_TRANS_NO_FW; 1175 } 1176 1177 static inline int iwl_trans_d3_suspend(struct iwl_trans *trans, bool test, 1178 bool reset) 1179 { 1180 might_sleep(); 1181 if (!trans->ops->d3_suspend) 1182 return -EOPNOTSUPP; 1183 1184 return trans->ops->d3_suspend(trans, test, reset); 1185 } 1186 1187 static inline int iwl_trans_d3_resume(struct iwl_trans *trans, 1188 enum iwl_d3_status *status, 1189 bool test, bool reset) 1190 { 1191 might_sleep(); 1192 if (!trans->ops->d3_resume) 1193 return -EOPNOTSUPP; 1194 1195 return trans->ops->d3_resume(trans, status, test, reset); 1196 } 1197 1198 static inline struct iwl_trans_dump_data * 1199 iwl_trans_dump_data(struct iwl_trans *trans, u32 dump_mask, 1200 const struct iwl_dump_sanitize_ops *sanitize_ops, 1201 void *sanitize_ctx) 1202 { 1203 if (!trans->ops->dump_data) 1204 return NULL; 1205 return trans->ops->dump_data(trans, dump_mask, 1206 sanitize_ops, sanitize_ctx); 1207 } 1208 1209 static inline struct iwl_device_tx_cmd * 1210 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans) 1211 { 1212 return kmem_cache_zalloc(trans->dev_cmd_pool, GFP_ATOMIC); 1213 } 1214 1215 int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd); 1216 1217 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans, 1218 struct iwl_device_tx_cmd *dev_cmd) 1219 { 1220 kmem_cache_free(trans->dev_cmd_pool, dev_cmd); 1221 } 1222 1223 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb, 1224 struct iwl_device_tx_cmd *dev_cmd, int queue) 1225 { 1226 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status))) 1227 return -EIO; 1228 1229 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1230 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1231 return -EIO; 1232 } 1233 1234 return trans->ops->tx(trans, skb, dev_cmd, queue); 1235 } 1236 1237 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue, 1238 int ssn, struct sk_buff_head *skbs) 1239 { 1240 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1241 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1242 return; 1243 } 1244 1245 trans->ops->reclaim(trans, queue, ssn, skbs); 1246 } 1247 1248 static inline void iwl_trans_set_q_ptrs(struct iwl_trans *trans, int queue, 1249 int ptr) 1250 { 1251 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1252 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1253 return; 1254 } 1255 1256 trans->ops->set_q_ptrs(trans, queue, ptr); 1257 } 1258 1259 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue, 1260 bool configure_scd) 1261 { 1262 trans->ops->txq_disable(trans, queue, configure_scd); 1263 } 1264 1265 static inline bool 1266 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn, 1267 const struct iwl_trans_txq_scd_cfg *cfg, 1268 unsigned int queue_wdg_timeout) 1269 { 1270 might_sleep(); 1271 1272 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1273 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1274 return false; 1275 } 1276 1277 return trans->ops->txq_enable(trans, queue, ssn, 1278 cfg, queue_wdg_timeout); 1279 } 1280 1281 static inline int 1282 iwl_trans_get_rxq_dma_data(struct iwl_trans *trans, int queue, 1283 struct iwl_trans_rxq_dma_data *data) 1284 { 1285 if (WARN_ON_ONCE(!trans->ops->rxq_dma_data)) 1286 return -ENOTSUPP; 1287 1288 return trans->ops->rxq_dma_data(trans, queue, data); 1289 } 1290 1291 static inline void 1292 iwl_trans_txq_free(struct iwl_trans *trans, int queue) 1293 { 1294 if (WARN_ON_ONCE(!trans->ops->txq_free)) 1295 return; 1296 1297 trans->ops->txq_free(trans, queue); 1298 } 1299 1300 static inline int 1301 iwl_trans_txq_alloc(struct iwl_trans *trans, 1302 u32 flags, u32 sta_mask, u8 tid, 1303 int size, unsigned int wdg_timeout) 1304 { 1305 might_sleep(); 1306 1307 if (WARN_ON_ONCE(!trans->ops->txq_alloc)) 1308 return -ENOTSUPP; 1309 1310 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1311 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1312 return -EIO; 1313 } 1314 1315 return trans->ops->txq_alloc(trans, flags, sta_mask, tid, 1316 size, wdg_timeout); 1317 } 1318 1319 static inline void iwl_trans_txq_set_shared_mode(struct iwl_trans *trans, 1320 int queue, bool shared_mode) 1321 { 1322 if (trans->ops->txq_set_shared_mode) 1323 trans->ops->txq_set_shared_mode(trans, queue, shared_mode); 1324 } 1325 1326 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue, 1327 int fifo, int sta_id, int tid, 1328 int frame_limit, u16 ssn, 1329 unsigned int queue_wdg_timeout) 1330 { 1331 struct iwl_trans_txq_scd_cfg cfg = { 1332 .fifo = fifo, 1333 .sta_id = sta_id, 1334 .tid = tid, 1335 .frame_limit = frame_limit, 1336 .aggregate = sta_id >= 0, 1337 }; 1338 1339 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout); 1340 } 1341 1342 static inline 1343 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo, 1344 unsigned int queue_wdg_timeout) 1345 { 1346 struct iwl_trans_txq_scd_cfg cfg = { 1347 .fifo = fifo, 1348 .sta_id = -1, 1349 .tid = IWL_MAX_TID_COUNT, 1350 .frame_limit = IWL_FRAME_LIMIT, 1351 .aggregate = false, 1352 }; 1353 1354 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout); 1355 } 1356 1357 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans, 1358 unsigned long txqs, 1359 bool freeze) 1360 { 1361 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1362 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1363 return; 1364 } 1365 1366 if (trans->ops->freeze_txq_timer) 1367 trans->ops->freeze_txq_timer(trans, txqs, freeze); 1368 } 1369 1370 static inline void iwl_trans_block_txq_ptrs(struct iwl_trans *trans, 1371 bool block) 1372 { 1373 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1374 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1375 return; 1376 } 1377 1378 if (trans->ops->block_txq_ptrs) 1379 trans->ops->block_txq_ptrs(trans, block); 1380 } 1381 1382 static inline int iwl_trans_wait_tx_queues_empty(struct iwl_trans *trans, 1383 u32 txqs) 1384 { 1385 if (WARN_ON_ONCE(!trans->ops->wait_tx_queues_empty)) 1386 return -ENOTSUPP; 1387 1388 /* No need to wait if the firmware is not alive */ 1389 if (trans->state != IWL_TRANS_FW_ALIVE) { 1390 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1391 return -EIO; 1392 } 1393 1394 return trans->ops->wait_tx_queues_empty(trans, txqs); 1395 } 1396 1397 static inline int iwl_trans_wait_txq_empty(struct iwl_trans *trans, int queue) 1398 { 1399 if (WARN_ON_ONCE(!trans->ops->wait_txq_empty)) 1400 return -ENOTSUPP; 1401 1402 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1403 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1404 return -EIO; 1405 } 1406 1407 return trans->ops->wait_txq_empty(trans, queue); 1408 } 1409 1410 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val) 1411 { 1412 trans->ops->write8(trans, ofs, val); 1413 } 1414 1415 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val) 1416 { 1417 trans->ops->write32(trans, ofs, val); 1418 } 1419 1420 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs) 1421 { 1422 return trans->ops->read32(trans, ofs); 1423 } 1424 1425 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs) 1426 { 1427 return trans->ops->read_prph(trans, ofs); 1428 } 1429 1430 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs, 1431 u32 val) 1432 { 1433 return trans->ops->write_prph(trans, ofs, val); 1434 } 1435 1436 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr, 1437 void *buf, int dwords) 1438 { 1439 return trans->ops->read_mem(trans, addr, buf, dwords); 1440 } 1441 1442 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \ 1443 do { \ 1444 if (__builtin_constant_p(bufsize)) \ 1445 BUILD_BUG_ON((bufsize) % sizeof(u32)); \ 1446 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\ 1447 } while (0) 1448 1449 static inline int iwl_trans_write_imr_mem(struct iwl_trans *trans, 1450 u32 dst_addr, u64 src_addr, 1451 u32 byte_cnt) 1452 { 1453 if (trans->ops->imr_dma_data) 1454 return trans->ops->imr_dma_data(trans, dst_addr, src_addr, byte_cnt); 1455 return 0; 1456 } 1457 1458 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr) 1459 { 1460 u32 value; 1461 1462 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1))) 1463 return 0xa5a5a5a5; 1464 1465 return value; 1466 } 1467 1468 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr, 1469 const void *buf, int dwords) 1470 { 1471 return trans->ops->write_mem(trans, addr, buf, dwords); 1472 } 1473 1474 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr, 1475 u32 val) 1476 { 1477 return iwl_trans_write_mem(trans, addr, &val, 1); 1478 } 1479 1480 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state) 1481 { 1482 if (trans->ops->set_pmi) 1483 trans->ops->set_pmi(trans, state); 1484 } 1485 1486 static inline int iwl_trans_sw_reset(struct iwl_trans *trans, 1487 bool retake_ownership) 1488 { 1489 if (trans->ops->sw_reset) 1490 return trans->ops->sw_reset(trans, retake_ownership); 1491 return 0; 1492 } 1493 1494 static inline void 1495 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value) 1496 { 1497 trans->ops->set_bits_mask(trans, reg, mask, value); 1498 } 1499 1500 #define iwl_trans_grab_nic_access(trans) \ 1501 __cond_lock(nic_access, \ 1502 likely((trans)->ops->grab_nic_access(trans))) 1503 1504 static inline void __releases(nic_access) 1505 iwl_trans_release_nic_access(struct iwl_trans *trans) 1506 { 1507 trans->ops->release_nic_access(trans); 1508 __release(nic_access); 1509 } 1510 1511 static inline void iwl_trans_fw_error(struct iwl_trans *trans, bool sync) 1512 { 1513 if (WARN_ON_ONCE(!trans->op_mode)) 1514 return; 1515 1516 /* prevent double restarts due to the same erroneous FW */ 1517 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status)) { 1518 iwl_op_mode_nic_error(trans->op_mode, sync); 1519 trans->state = IWL_TRANS_NO_FW; 1520 } 1521 } 1522 1523 static inline bool iwl_trans_fw_running(struct iwl_trans *trans) 1524 { 1525 return trans->state == IWL_TRANS_FW_ALIVE; 1526 } 1527 1528 static inline void iwl_trans_sync_nmi(struct iwl_trans *trans) 1529 { 1530 if (trans->ops->sync_nmi) 1531 trans->ops->sync_nmi(trans); 1532 } 1533 1534 void iwl_trans_sync_nmi_with_addr(struct iwl_trans *trans, u32 inta_addr, 1535 u32 sw_err_bit); 1536 1537 static inline int iwl_trans_load_pnvm(struct iwl_trans *trans, 1538 const struct iwl_pnvm_image *pnvm_data) 1539 { 1540 return trans->ops->load_pnvm(trans, pnvm_data); 1541 } 1542 1543 static inline void iwl_trans_set_pnvm(struct iwl_trans *trans) 1544 { 1545 if (trans->ops->set_pnvm) 1546 trans->ops->set_pnvm(trans); 1547 } 1548 1549 static inline int iwl_trans_set_reduce_power(struct iwl_trans *trans, 1550 const void *data, u32 len) 1551 { 1552 if (trans->ops->set_reduce_power) { 1553 int ret = trans->ops->set_reduce_power(trans, data, len); 1554 1555 if (ret) 1556 return ret; 1557 } 1558 1559 trans->reduce_power_loaded = true; 1560 return 0; 1561 } 1562 1563 static inline bool iwl_trans_dbg_ini_valid(struct iwl_trans *trans) 1564 { 1565 return trans->dbg.internal_ini_cfg != IWL_INI_CFG_STATE_NOT_LOADED || 1566 trans->dbg.external_ini_cfg != IWL_INI_CFG_STATE_NOT_LOADED; 1567 } 1568 1569 static inline void iwl_trans_interrupts(struct iwl_trans *trans, bool enable) 1570 { 1571 if (trans->ops->interrupts) 1572 trans->ops->interrupts(trans, enable); 1573 } 1574 1575 /***************************************************** 1576 * transport helper functions 1577 *****************************************************/ 1578 struct iwl_trans *iwl_trans_alloc(unsigned int priv_size, 1579 struct device *dev, 1580 const struct iwl_trans_ops *ops, 1581 const struct iwl_cfg_trans_params *cfg_trans); 1582 int iwl_trans_init(struct iwl_trans *trans); 1583 void iwl_trans_free(struct iwl_trans *trans); 1584 1585 /***************************************************** 1586 * driver (transport) register/unregister functions 1587 ******************************************************/ 1588 int __must_check iwl_pci_register_driver(void); 1589 void iwl_pci_unregister_driver(void); 1590 void iwl_trans_pcie_remove(struct iwl_trans *trans, bool rescan); 1591 1592 #endif /* __iwl_trans_h__ */ 1593