1 /****************************************************************************** 2 * 3 * This file is provided under a dual BSD/GPLv2 license. When using or 4 * redistributing this file, you may do so under either license. 5 * 6 * GPL LICENSE SUMMARY 7 * 8 * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved. 9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH 10 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH 11 * 12 * This program is free software; you can redistribute it and/or modify 13 * it under the terms of version 2 of the GNU General Public License as 14 * published by the Free Software Foundation. 15 * 16 * This program is distributed in the hope that it will be useful, but 17 * WITHOUT ANY WARRANTY; without even the implied warranty of 18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 19 * General Public License for more details. 20 * 21 * You should have received a copy of the GNU General Public License 22 * along with this program; if not, write to the Free Software 23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 24 * USA 25 * 26 * The full GNU General Public License is included in this distribution 27 * in the file called COPYING. 28 * 29 * Contact Information: 30 * Intel Linux Wireless <linuxwifi@intel.com> 31 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 32 * 33 * BSD LICENSE 34 * 35 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved. 36 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH 37 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH 38 * All rights reserved. 39 * 40 * Redistribution and use in source and binary forms, with or without 41 * modification, are permitted provided that the following conditions 42 * are met: 43 * 44 * * Redistributions of source code must retain the above copyright 45 * notice, this list of conditions and the following disclaimer. 46 * * Redistributions in binary form must reproduce the above copyright 47 * notice, this list of conditions and the following disclaimer in 48 * the documentation and/or other materials provided with the 49 * distribution. 50 * * Neither the name Intel Corporation nor the names of its 51 * contributors may be used to endorse or promote products derived 52 * from this software without specific prior written permission. 53 * 54 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 55 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 56 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 57 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 58 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 59 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 60 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 61 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 62 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 63 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 65 * 66 *****************************************************************************/ 67 #ifndef __iwl_trans_h__ 68 #define __iwl_trans_h__ 69 70 #include <linux/ieee80211.h> 71 #include <linux/mm.h> /* for page_address */ 72 #include <linux/lockdep.h> 73 #include <linux/kernel.h> 74 75 #include "iwl-debug.h" 76 #include "iwl-config.h" 77 #include "fw/img.h" 78 #include "iwl-op-mode.h" 79 #include "fw/api/cmdhdr.h" 80 #include "fw/api/txq.h" 81 82 /** 83 * DOC: Transport layer - what is it ? 84 * 85 * The transport layer is the layer that deals with the HW directly. It provides 86 * an abstraction of the underlying HW to the upper layer. The transport layer 87 * doesn't provide any policy, algorithm or anything of this kind, but only 88 * mechanisms to make the HW do something. It is not completely stateless but 89 * close to it. 90 * We will have an implementation for each different supported bus. 91 */ 92 93 /** 94 * DOC: Life cycle of the transport layer 95 * 96 * The transport layer has a very precise life cycle. 97 * 98 * 1) A helper function is called during the module initialization and 99 * registers the bus driver's ops with the transport's alloc function. 100 * 2) Bus's probe calls to the transport layer's allocation functions. 101 * Of course this function is bus specific. 102 * 3) This allocation functions will spawn the upper layer which will 103 * register mac80211. 104 * 105 * 4) At some point (i.e. mac80211's start call), the op_mode will call 106 * the following sequence: 107 * start_hw 108 * start_fw 109 * 110 * 5) Then when finished (or reset): 111 * stop_device 112 * 113 * 6) Eventually, the free function will be called. 114 */ 115 116 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */ 117 #define FH_RSCSR_FRAME_INVALID 0x55550000 118 #define FH_RSCSR_FRAME_ALIGN 0x40 119 #define FH_RSCSR_RPA_EN BIT(25) 120 #define FH_RSCSR_RXQ_POS 16 121 #define FH_RSCSR_RXQ_MASK 0x3F0000 122 123 struct iwl_rx_packet { 124 /* 125 * The first 4 bytes of the RX frame header contain both the RX frame 126 * size and some flags. 127 * Bit fields: 128 * 31: flag flush RB request 129 * 30: flag ignore TC (terminal counter) request 130 * 29: flag fast IRQ request 131 * 28-26: Reserved 132 * 25: Offload enabled 133 * 24: RPF enabled 134 * 23: RSS enabled 135 * 22: Checksum enabled 136 * 21-16: RX queue 137 * 15-14: Reserved 138 * 13-00: RX frame size 139 */ 140 __le32 len_n_flags; 141 struct iwl_cmd_header hdr; 142 u8 data[]; 143 } __packed; 144 145 static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt) 146 { 147 return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK; 148 } 149 150 static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt) 151 { 152 return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr); 153 } 154 155 /** 156 * enum CMD_MODE - how to send the host commands ? 157 * 158 * @CMD_ASYNC: Return right away and don't wait for the response 159 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of 160 * the response. The caller needs to call iwl_free_resp when done. 161 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the 162 * command queue, but after other high priority commands. Valid only 163 * with CMD_ASYNC. 164 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle. 165 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle. 166 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans 167 * (i.e. mark it as non-idle). 168 * @CMD_WANT_ASYNC_CALLBACK: the op_mode's async callback function must be 169 * called after this command completes. Valid only with CMD_ASYNC. 170 */ 171 enum CMD_MODE { 172 CMD_ASYNC = BIT(0), 173 CMD_WANT_SKB = BIT(1), 174 CMD_SEND_IN_RFKILL = BIT(2), 175 CMD_HIGH_PRIO = BIT(3), 176 CMD_SEND_IN_IDLE = BIT(4), 177 CMD_MAKE_TRANS_IDLE = BIT(5), 178 CMD_WAKE_UP_TRANS = BIT(6), 179 CMD_WANT_ASYNC_CALLBACK = BIT(7), 180 }; 181 182 #define DEF_CMD_PAYLOAD_SIZE 320 183 184 /** 185 * struct iwl_device_cmd 186 * 187 * For allocation of the command and tx queues, this establishes the overall 188 * size of the largest command we send to uCode, except for commands that 189 * aren't fully copied and use other TFD space. 190 */ 191 struct iwl_device_cmd { 192 union { 193 struct { 194 struct iwl_cmd_header hdr; /* uCode API */ 195 u8 payload[DEF_CMD_PAYLOAD_SIZE]; 196 }; 197 struct { 198 struct iwl_cmd_header_wide hdr_wide; 199 u8 payload_wide[DEF_CMD_PAYLOAD_SIZE - 200 sizeof(struct iwl_cmd_header_wide) + 201 sizeof(struct iwl_cmd_header)]; 202 }; 203 }; 204 } __packed; 205 206 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd)) 207 208 /* 209 * number of transfer buffers (fragments) per transmit frame descriptor; 210 * this is just the driver's idea, the hardware supports 20 211 */ 212 #define IWL_MAX_CMD_TBS_PER_TFD 2 213 214 /** 215 * enum iwl_hcmd_dataflag - flag for each one of the chunks of the command 216 * 217 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's 218 * ring. The transport layer doesn't map the command's buffer to DMA, but 219 * rather copies it to a previously allocated DMA buffer. This flag tells 220 * the transport layer not to copy the command, but to map the existing 221 * buffer (that is passed in) instead. This saves the memcpy and allows 222 * commands that are bigger than the fixed buffer to be submitted. 223 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one. 224 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this 225 * chunk internally and free it again after the command completes. This 226 * can (currently) be used only once per command. 227 * Note that a TFD entry after a DUP one cannot be a normal copied one. 228 */ 229 enum iwl_hcmd_dataflag { 230 IWL_HCMD_DFL_NOCOPY = BIT(0), 231 IWL_HCMD_DFL_DUP = BIT(1), 232 }; 233 234 /** 235 * struct iwl_host_cmd - Host command to the uCode 236 * 237 * @data: array of chunks that composes the data of the host command 238 * @resp_pkt: response packet, if %CMD_WANT_SKB was set 239 * @_rx_page_order: (internally used to free response packet) 240 * @_rx_page_addr: (internally used to free response packet) 241 * @flags: can be CMD_* 242 * @len: array of the lengths of the chunks in data 243 * @dataflags: IWL_HCMD_DFL_* 244 * @id: command id of the host command, for wide commands encoding the 245 * version and group as well 246 */ 247 struct iwl_host_cmd { 248 const void *data[IWL_MAX_CMD_TBS_PER_TFD]; 249 struct iwl_rx_packet *resp_pkt; 250 unsigned long _rx_page_addr; 251 u32 _rx_page_order; 252 253 u32 flags; 254 u32 id; 255 u16 len[IWL_MAX_CMD_TBS_PER_TFD]; 256 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD]; 257 }; 258 259 static inline void iwl_free_resp(struct iwl_host_cmd *cmd) 260 { 261 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order); 262 } 263 264 struct iwl_rx_cmd_buffer { 265 struct page *_page; 266 int _offset; 267 bool _page_stolen; 268 u32 _rx_page_order; 269 unsigned int truesize; 270 }; 271 272 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r) 273 { 274 return (void *)((unsigned long)page_address(r->_page) + r->_offset); 275 } 276 277 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r) 278 { 279 return r->_offset; 280 } 281 282 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r) 283 { 284 r->_page_stolen = true; 285 get_page(r->_page); 286 return r->_page; 287 } 288 289 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r) 290 { 291 __free_pages(r->_page, r->_rx_page_order); 292 } 293 294 #define MAX_NO_RECLAIM_CMDS 6 295 296 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo)))) 297 298 /* 299 * Maximum number of HW queues the transport layer 300 * currently supports 301 */ 302 #define IWL_MAX_HW_QUEUES 32 303 #define IWL_MAX_TVQM_QUEUES 512 304 305 #define IWL_MAX_TID_COUNT 8 306 #define IWL_MGMT_TID 15 307 #define IWL_FRAME_LIMIT 64 308 #define IWL_MAX_RX_HW_QUEUES 16 309 310 /** 311 * enum iwl_wowlan_status - WoWLAN image/device status 312 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume 313 * @IWL_D3_STATUS_RESET: device was reset while suspended 314 */ 315 enum iwl_d3_status { 316 IWL_D3_STATUS_ALIVE, 317 IWL_D3_STATUS_RESET, 318 }; 319 320 /** 321 * enum iwl_trans_status: transport status flags 322 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed 323 * @STATUS_DEVICE_ENABLED: APM is enabled 324 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up) 325 * @STATUS_INT_ENABLED: interrupts are enabled 326 * @STATUS_RFKILL_HW: the actual HW state of the RF-kill switch 327 * @STATUS_RFKILL_OPMODE: RF-kill state reported to opmode 328 * @STATUS_FW_ERROR: the fw is in error state 329 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands 330 * are sent 331 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent 332 * @STATUS_TRANS_DEAD: trans is dead - avoid any read/write operation 333 */ 334 enum iwl_trans_status { 335 STATUS_SYNC_HCMD_ACTIVE, 336 STATUS_DEVICE_ENABLED, 337 STATUS_TPOWER_PMI, 338 STATUS_INT_ENABLED, 339 STATUS_RFKILL_HW, 340 STATUS_RFKILL_OPMODE, 341 STATUS_FW_ERROR, 342 STATUS_TRANS_GOING_IDLE, 343 STATUS_TRANS_IDLE, 344 STATUS_TRANS_DEAD, 345 }; 346 347 static inline int 348 iwl_trans_get_rb_size_order(enum iwl_amsdu_size rb_size) 349 { 350 switch (rb_size) { 351 case IWL_AMSDU_4K: 352 return get_order(4 * 1024); 353 case IWL_AMSDU_8K: 354 return get_order(8 * 1024); 355 case IWL_AMSDU_12K: 356 return get_order(12 * 1024); 357 default: 358 WARN_ON(1); 359 return -1; 360 } 361 } 362 363 struct iwl_hcmd_names { 364 u8 cmd_id; 365 const char *const cmd_name; 366 }; 367 368 #define HCMD_NAME(x) \ 369 { .cmd_id = x, .cmd_name = #x } 370 371 struct iwl_hcmd_arr { 372 const struct iwl_hcmd_names *arr; 373 int size; 374 }; 375 376 #define HCMD_ARR(x) \ 377 { .arr = x, .size = ARRAY_SIZE(x) } 378 379 /** 380 * struct iwl_trans_config - transport configuration 381 * 382 * @op_mode: pointer to the upper layer. 383 * @cmd_queue: the index of the command queue. 384 * Must be set before start_fw. 385 * @cmd_fifo: the fifo for host commands 386 * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue. 387 * @no_reclaim_cmds: Some devices erroneously don't set the 388 * SEQ_RX_FRAME bit on some notifications, this is the 389 * list of such notifications to filter. Max length is 390 * %MAX_NO_RECLAIM_CMDS. 391 * @n_no_reclaim_cmds: # of commands in list 392 * @rx_buf_size: RX buffer size needed for A-MSDUs 393 * if unset 4k will be the RX buffer size 394 * @bc_table_dword: set to true if the BC table expects the byte count to be 395 * in DWORD (as opposed to bytes) 396 * @scd_set_active: should the transport configure the SCD for HCMD queue 397 * @sw_csum_tx: transport should compute the TCP checksum 398 * @command_groups: array of command groups, each member is an array of the 399 * commands in the group; for debugging only 400 * @command_groups_size: number of command groups, to avoid illegal access 401 * @cb_data_offs: offset inside skb->cb to store transport data at, must have 402 * space for at least two pointers 403 */ 404 struct iwl_trans_config { 405 struct iwl_op_mode *op_mode; 406 407 u8 cmd_queue; 408 u8 cmd_fifo; 409 unsigned int cmd_q_wdg_timeout; 410 const u8 *no_reclaim_cmds; 411 unsigned int n_no_reclaim_cmds; 412 413 enum iwl_amsdu_size rx_buf_size; 414 bool bc_table_dword; 415 bool scd_set_active; 416 bool sw_csum_tx; 417 const struct iwl_hcmd_arr *command_groups; 418 int command_groups_size; 419 420 u8 cb_data_offs; 421 }; 422 423 struct iwl_trans_dump_data { 424 u32 len; 425 u8 data[]; 426 }; 427 428 struct iwl_trans; 429 430 struct iwl_trans_txq_scd_cfg { 431 u8 fifo; 432 u8 sta_id; 433 u8 tid; 434 bool aggregate; 435 int frame_limit; 436 }; 437 438 /** 439 * struct iwl_trans_ops - transport specific operations 440 * 441 * All the handlers MUST be implemented 442 * 443 * @start_hw: starts the HW. If low_power is true, the NIC needs to be taken 444 * out of a low power state. From that point on, the HW can send 445 * interrupts. May sleep. 446 * @op_mode_leave: Turn off the HW RF kill indication if on 447 * May sleep 448 * @start_fw: allocates and inits all the resources for the transport 449 * layer. Also kick a fw image. 450 * May sleep 451 * @fw_alive: called when the fw sends alive notification. If the fw provides 452 * the SCD base address in SRAM, then provide it here, or 0 otherwise. 453 * May sleep 454 * @stop_device: stops the whole device (embedded CPU put to reset) and stops 455 * the HW. If low_power is true, the NIC will be put in low power state. 456 * From that point on, the HW will be stopped but will still issue an 457 * interrupt if the HW RF kill switch is triggered. 458 * This callback must do the right thing and not crash even if %start_hw() 459 * was called but not &start_fw(). May sleep. 460 * @d3_suspend: put the device into the correct mode for WoWLAN during 461 * suspend. This is optional, if not implemented WoWLAN will not be 462 * supported. This callback may sleep. 463 * @d3_resume: resume the device after WoWLAN, enabling the opmode to 464 * talk to the WoWLAN image to get its status. This is optional, if not 465 * implemented WoWLAN will not be supported. This callback may sleep. 466 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted. 467 * If RFkill is asserted in the middle of a SYNC host command, it must 468 * return -ERFKILL straight away. 469 * May sleep only if CMD_ASYNC is not set 470 * @tx: send an skb. The transport relies on the op_mode to zero the 471 * the ieee80211_tx_info->driver_data. If the MPDU is an A-MSDU, all 472 * the CSUM will be taken care of (TCP CSUM and IP header in case of 473 * IPv4). If the MPDU is a single MSDU, the op_mode must compute the IP 474 * header if it is IPv4. 475 * Must be atomic 476 * @reclaim: free packet until ssn. Returns a list of freed packets. 477 * Must be atomic 478 * @txq_enable: setup a queue. To setup an AC queue, use the 479 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before 480 * this one. The op_mode must not configure the HCMD queue. The scheduler 481 * configuration may be %NULL, in which case the hardware will not be 482 * configured. If true is returned, the operation mode needs to increment 483 * the sequence number of the packets routed to this queue because of a 484 * hardware scheduler bug. May sleep. 485 * @txq_disable: de-configure a Tx queue to send AMPDUs 486 * Must be atomic 487 * @txq_set_shared_mode: change Tx queue shared/unshared marking 488 * @wait_tx_queues_empty: wait until tx queues are empty. May sleep. 489 * @wait_txq_empty: wait until specific tx queue is empty. May sleep. 490 * @freeze_txq_timer: prevents the timer of the queue from firing until the 491 * queue is set to awake. Must be atomic. 492 * @block_txq_ptrs: stop updating the write pointers of the Tx queues. Note 493 * that the transport needs to refcount the calls since this function 494 * will be called several times with block = true, and then the queues 495 * need to be unblocked only after the same number of calls with 496 * block = false. 497 * @write8: write a u8 to a register at offset ofs from the BAR 498 * @write32: write a u32 to a register at offset ofs from the BAR 499 * @read32: read a u32 register at offset ofs from the BAR 500 * @read_prph: read a DWORD from a periphery register 501 * @write_prph: write a DWORD to a periphery register 502 * @read_mem: read device's SRAM in DWORD 503 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory 504 * will be zeroed. 505 * @configure: configure parameters required by the transport layer from 506 * the op_mode. May be called several times before start_fw, can't be 507 * called after that. 508 * @set_pmi: set the power pmi state 509 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs. 510 * Sleeping is not allowed between grab_nic_access and 511 * release_nic_access. 512 * @release_nic_access: let the NIC go to sleep. The "flags" parameter 513 * must be the same one that was sent before to the grab_nic_access. 514 * @set_bits_mask - set SRAM register according to value and mask. 515 * @ref: grab a reference to the transport/FW layers, disallowing 516 * certain low power states 517 * @unref: release a reference previously taken with @ref. Note that 518 * initially the reference count is 1, making an initial @unref 519 * necessary to allow low power states. 520 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last 521 * TX'ed commands and similar. The buffer will be vfree'd by the caller. 522 * Note that the transport must fill in the proper file headers. 523 * @dump_regs: dump using IWL_ERR configuration space and memory mapped 524 * registers of the device to diagnose failure, e.g., when HW becomes 525 * inaccessible. 526 */ 527 struct iwl_trans_ops { 528 529 int (*start_hw)(struct iwl_trans *iwl_trans, bool low_power); 530 void (*op_mode_leave)(struct iwl_trans *iwl_trans); 531 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw, 532 bool run_in_rfkill); 533 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr); 534 void (*stop_device)(struct iwl_trans *trans, bool low_power); 535 536 void (*d3_suspend)(struct iwl_trans *trans, bool test, bool reset); 537 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status, 538 bool test, bool reset); 539 540 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd); 541 542 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb, 543 struct iwl_device_cmd *dev_cmd, int queue); 544 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn, 545 struct sk_buff_head *skbs); 546 547 bool (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn, 548 const struct iwl_trans_txq_scd_cfg *cfg, 549 unsigned int queue_wdg_timeout); 550 void (*txq_disable)(struct iwl_trans *trans, int queue, 551 bool configure_scd); 552 /* a000 functions */ 553 int (*txq_alloc)(struct iwl_trans *trans, 554 struct iwl_tx_queue_cfg_cmd *cmd, 555 int cmd_id, 556 unsigned int queue_wdg_timeout); 557 void (*txq_free)(struct iwl_trans *trans, int queue); 558 559 void (*txq_set_shared_mode)(struct iwl_trans *trans, u32 txq_id, 560 bool shared); 561 562 int (*wait_tx_queues_empty)(struct iwl_trans *trans, u32 txq_bm); 563 int (*wait_txq_empty)(struct iwl_trans *trans, int queue); 564 void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs, 565 bool freeze); 566 void (*block_txq_ptrs)(struct iwl_trans *trans, bool block); 567 568 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val); 569 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val); 570 u32 (*read32)(struct iwl_trans *trans, u32 ofs); 571 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs); 572 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val); 573 int (*read_mem)(struct iwl_trans *trans, u32 addr, 574 void *buf, int dwords); 575 int (*write_mem)(struct iwl_trans *trans, u32 addr, 576 const void *buf, int dwords); 577 void (*configure)(struct iwl_trans *trans, 578 const struct iwl_trans_config *trans_cfg); 579 void (*set_pmi)(struct iwl_trans *trans, bool state); 580 bool (*grab_nic_access)(struct iwl_trans *trans, unsigned long *flags); 581 void (*release_nic_access)(struct iwl_trans *trans, 582 unsigned long *flags); 583 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask, 584 u32 value); 585 void (*ref)(struct iwl_trans *trans); 586 void (*unref)(struct iwl_trans *trans); 587 int (*suspend)(struct iwl_trans *trans); 588 void (*resume)(struct iwl_trans *trans); 589 590 struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans, 591 const struct iwl_fw_dbg_trigger_tlv 592 *trigger); 593 594 void (*dump_regs)(struct iwl_trans *trans); 595 }; 596 597 /** 598 * enum iwl_trans_state - state of the transport layer 599 * 600 * @IWL_TRANS_NO_FW: no fw has sent an alive response 601 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response 602 */ 603 enum iwl_trans_state { 604 IWL_TRANS_NO_FW = 0, 605 IWL_TRANS_FW_ALIVE = 1, 606 }; 607 608 /** 609 * DOC: Platform power management 610 * 611 * There are two types of platform power management: system-wide 612 * (WoWLAN) and runtime. 613 * 614 * In system-wide power management the entire platform goes into a low 615 * power state (e.g. idle or suspend to RAM) at the same time and the 616 * device is configured as a wakeup source for the entire platform. 617 * This is usually triggered by userspace activity (e.g. the user 618 * presses the suspend button or a power management daemon decides to 619 * put the platform in low power mode). The device's behavior in this 620 * mode is dictated by the wake-on-WLAN configuration. 621 * 622 * In runtime power management, only the devices which are themselves 623 * idle enter a low power state. This is done at runtime, which means 624 * that the entire system is still running normally. This mode is 625 * usually triggered automatically by the device driver and requires 626 * the ability to enter and exit the low power modes in a very short 627 * time, so there is not much impact in usability. 628 * 629 * The terms used for the device's behavior are as follows: 630 * 631 * - D0: the device is fully powered and the host is awake; 632 * - D3: the device is in low power mode and only reacts to 633 * specific events (e.g. magic-packet received or scan 634 * results found); 635 * - D0I3: the device is in low power mode and reacts to any 636 * activity (e.g. RX); 637 * 638 * These terms reflect the power modes in the firmware and are not to 639 * be confused with the physical device power state. The NIC can be 640 * in D0I3 mode even if, for instance, the PCI device is in D3 state. 641 */ 642 643 /** 644 * enum iwl_plat_pm_mode - platform power management mode 645 * 646 * This enumeration describes the device's platform power management 647 * behavior when in idle mode (i.e. runtime power management) or when 648 * in system-wide suspend (i.e WoWLAN). 649 * 650 * @IWL_PLAT_PM_MODE_DISABLED: power management is disabled for this 651 * device. At runtime, this means that nothing happens and the 652 * device always remains in active. In system-wide suspend mode, 653 * it means that the all connections will be closed automatically 654 * by mac80211 before the platform is suspended. 655 * @IWL_PLAT_PM_MODE_D3: the device goes into D3 mode (i.e. WoWLAN). 656 * For runtime power management, this mode is not officially 657 * supported. 658 * @IWL_PLAT_PM_MODE_D0I3: the device goes into D0I3 mode. 659 */ 660 enum iwl_plat_pm_mode { 661 IWL_PLAT_PM_MODE_DISABLED, 662 IWL_PLAT_PM_MODE_D3, 663 IWL_PLAT_PM_MODE_D0I3, 664 }; 665 666 /* Max time to wait for trans to become idle/non-idle on d0i3 667 * enter/exit (in msecs). 668 */ 669 #define IWL_TRANS_IDLE_TIMEOUT 2000 670 671 /** 672 * struct iwl_trans - transport common data 673 * 674 * @ops - pointer to iwl_trans_ops 675 * @op_mode - pointer to the op_mode 676 * @cfg - pointer to the configuration 677 * @drv - pointer to iwl_drv 678 * @status: a bit-mask of transport status flags 679 * @dev - pointer to struct device * that represents the device 680 * @max_skb_frags: maximum number of fragments an SKB can have when transmitted. 681 * 0 indicates that frag SKBs (NETIF_F_SG) aren't supported. 682 * @hw_rf_id a u32 with the device RF ID 683 * @hw_id: a u32 with the ID of the device / sub-device. 684 * Set during transport allocation. 685 * @hw_id_str: a string with info about HW ID. Set during transport allocation. 686 * @pm_support: set to true in start_hw if link pm is supported 687 * @ltr_enabled: set to true if the LTR is enabled 688 * @wide_cmd_header: true when ucode supports wide command header format 689 * @num_rx_queues: number of RX queues allocated by the transport; 690 * the transport must set this before calling iwl_drv_start() 691 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only. 692 * The user should use iwl_trans_{alloc,free}_tx_cmd. 693 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before 694 * starting the firmware, used for tracing 695 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the 696 * start of the 802.11 header in the @rx_mpdu_cmd 697 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI) 698 * @dbg_dest_tlv: points to the destination TLV for debug 699 * @dbg_conf_tlv: array of pointers to configuration TLVs for debug 700 * @dbg_trigger_tlv: array of pointers to triggers TLVs for debug 701 * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv 702 * @system_pm_mode: the system-wide power management mode in use. 703 * This mode is set dynamically, depending on the WoWLAN values 704 * configured from the userspace at runtime. 705 * @runtime_pm_mode: the runtime power management mode in use. This 706 * mode is set during the initialization phase and is not 707 * supposed to change during runtime. 708 */ 709 struct iwl_trans { 710 const struct iwl_trans_ops *ops; 711 struct iwl_op_mode *op_mode; 712 const struct iwl_cfg *cfg; 713 struct iwl_drv *drv; 714 enum iwl_trans_state state; 715 unsigned long status; 716 717 struct device *dev; 718 u32 max_skb_frags; 719 u32 hw_rev; 720 u32 hw_rf_id; 721 u32 hw_id; 722 char hw_id_str[52]; 723 724 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size; 725 726 bool pm_support; 727 bool ltr_enabled; 728 729 const struct iwl_hcmd_arr *command_groups; 730 int command_groups_size; 731 bool wide_cmd_header; 732 733 u8 num_rx_queues; 734 735 /* The following fields are internal only */ 736 struct kmem_cache *dev_cmd_pool; 737 char dev_cmd_pool_name[50]; 738 739 struct dentry *dbgfs_dir; 740 741 #ifdef CONFIG_LOCKDEP 742 struct lockdep_map sync_cmd_lockdep_map; 743 #endif 744 745 const struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv; 746 const struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX]; 747 struct iwl_fw_dbg_trigger_tlv * const *dbg_trigger_tlv; 748 u8 dbg_dest_reg_num; 749 750 enum iwl_plat_pm_mode system_pm_mode; 751 enum iwl_plat_pm_mode runtime_pm_mode; 752 bool suspending; 753 754 /* pointer to trans specific struct */ 755 /*Ensure that this pointer will always be aligned to sizeof pointer */ 756 char trans_specific[0] __aligned(sizeof(void *)); 757 }; 758 759 const char *iwl_get_cmd_string(struct iwl_trans *trans, u32 id); 760 int iwl_cmd_groups_verify_sorted(const struct iwl_trans_config *trans); 761 762 static inline void iwl_trans_configure(struct iwl_trans *trans, 763 const struct iwl_trans_config *trans_cfg) 764 { 765 trans->op_mode = trans_cfg->op_mode; 766 767 trans->ops->configure(trans, trans_cfg); 768 WARN_ON(iwl_cmd_groups_verify_sorted(trans_cfg)); 769 } 770 771 static inline int _iwl_trans_start_hw(struct iwl_trans *trans, bool low_power) 772 { 773 might_sleep(); 774 775 return trans->ops->start_hw(trans, low_power); 776 } 777 778 static inline int iwl_trans_start_hw(struct iwl_trans *trans) 779 { 780 return trans->ops->start_hw(trans, true); 781 } 782 783 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans) 784 { 785 might_sleep(); 786 787 if (trans->ops->op_mode_leave) 788 trans->ops->op_mode_leave(trans); 789 790 trans->op_mode = NULL; 791 792 trans->state = IWL_TRANS_NO_FW; 793 } 794 795 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr) 796 { 797 might_sleep(); 798 799 trans->state = IWL_TRANS_FW_ALIVE; 800 801 trans->ops->fw_alive(trans, scd_addr); 802 } 803 804 static inline int iwl_trans_start_fw(struct iwl_trans *trans, 805 const struct fw_img *fw, 806 bool run_in_rfkill) 807 { 808 might_sleep(); 809 810 WARN_ON_ONCE(!trans->rx_mpdu_cmd); 811 812 clear_bit(STATUS_FW_ERROR, &trans->status); 813 return trans->ops->start_fw(trans, fw, run_in_rfkill); 814 } 815 816 static inline void _iwl_trans_stop_device(struct iwl_trans *trans, 817 bool low_power) 818 { 819 might_sleep(); 820 821 trans->ops->stop_device(trans, low_power); 822 823 trans->state = IWL_TRANS_NO_FW; 824 } 825 826 static inline void iwl_trans_stop_device(struct iwl_trans *trans) 827 { 828 _iwl_trans_stop_device(trans, true); 829 } 830 831 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test, 832 bool reset) 833 { 834 might_sleep(); 835 if (trans->ops->d3_suspend) 836 trans->ops->d3_suspend(trans, test, reset); 837 } 838 839 static inline int iwl_trans_d3_resume(struct iwl_trans *trans, 840 enum iwl_d3_status *status, 841 bool test, bool reset) 842 { 843 might_sleep(); 844 if (!trans->ops->d3_resume) 845 return 0; 846 847 return trans->ops->d3_resume(trans, status, test, reset); 848 } 849 850 static inline int iwl_trans_suspend(struct iwl_trans *trans) 851 { 852 if (!trans->ops->suspend) 853 return 0; 854 855 return trans->ops->suspend(trans); 856 } 857 858 static inline void iwl_trans_resume(struct iwl_trans *trans) 859 { 860 if (trans->ops->resume) 861 trans->ops->resume(trans); 862 } 863 864 static inline struct iwl_trans_dump_data * 865 iwl_trans_dump_data(struct iwl_trans *trans, 866 const struct iwl_fw_dbg_trigger_tlv *trigger) 867 { 868 if (!trans->ops->dump_data) 869 return NULL; 870 return trans->ops->dump_data(trans, trigger); 871 } 872 873 static inline void iwl_trans_dump_regs(struct iwl_trans *trans) 874 { 875 if (trans->ops->dump_regs) 876 trans->ops->dump_regs(trans); 877 } 878 879 static inline struct iwl_device_cmd * 880 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans) 881 { 882 return kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC); 883 } 884 885 int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd); 886 887 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans, 888 struct iwl_device_cmd *dev_cmd) 889 { 890 kmem_cache_free(trans->dev_cmd_pool, dev_cmd); 891 } 892 893 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb, 894 struct iwl_device_cmd *dev_cmd, int queue) 895 { 896 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status))) 897 return -EIO; 898 899 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 900 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 901 return -EIO; 902 } 903 904 return trans->ops->tx(trans, skb, dev_cmd, queue); 905 } 906 907 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue, 908 int ssn, struct sk_buff_head *skbs) 909 { 910 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 911 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 912 return; 913 } 914 915 trans->ops->reclaim(trans, queue, ssn, skbs); 916 } 917 918 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue, 919 bool configure_scd) 920 { 921 trans->ops->txq_disable(trans, queue, configure_scd); 922 } 923 924 static inline bool 925 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn, 926 const struct iwl_trans_txq_scd_cfg *cfg, 927 unsigned int queue_wdg_timeout) 928 { 929 might_sleep(); 930 931 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 932 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 933 return false; 934 } 935 936 return trans->ops->txq_enable(trans, queue, ssn, 937 cfg, queue_wdg_timeout); 938 } 939 940 static inline void 941 iwl_trans_txq_free(struct iwl_trans *trans, int queue) 942 { 943 if (WARN_ON_ONCE(!trans->ops->txq_free)) 944 return; 945 946 trans->ops->txq_free(trans, queue); 947 } 948 949 static inline int 950 iwl_trans_txq_alloc(struct iwl_trans *trans, 951 struct iwl_tx_queue_cfg_cmd *cmd, 952 int cmd_id, 953 unsigned int queue_wdg_timeout) 954 { 955 might_sleep(); 956 957 if (WARN_ON_ONCE(!trans->ops->txq_alloc)) 958 return -ENOTSUPP; 959 960 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 961 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 962 return -EIO; 963 } 964 965 return trans->ops->txq_alloc(trans, cmd, cmd_id, queue_wdg_timeout); 966 } 967 968 static inline void iwl_trans_txq_set_shared_mode(struct iwl_trans *trans, 969 int queue, bool shared_mode) 970 { 971 if (trans->ops->txq_set_shared_mode) 972 trans->ops->txq_set_shared_mode(trans, queue, shared_mode); 973 } 974 975 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue, 976 int fifo, int sta_id, int tid, 977 int frame_limit, u16 ssn, 978 unsigned int queue_wdg_timeout) 979 { 980 struct iwl_trans_txq_scd_cfg cfg = { 981 .fifo = fifo, 982 .sta_id = sta_id, 983 .tid = tid, 984 .frame_limit = frame_limit, 985 .aggregate = sta_id >= 0, 986 }; 987 988 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout); 989 } 990 991 static inline 992 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo, 993 unsigned int queue_wdg_timeout) 994 { 995 struct iwl_trans_txq_scd_cfg cfg = { 996 .fifo = fifo, 997 .sta_id = -1, 998 .tid = IWL_MAX_TID_COUNT, 999 .frame_limit = IWL_FRAME_LIMIT, 1000 .aggregate = false, 1001 }; 1002 1003 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout); 1004 } 1005 1006 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans, 1007 unsigned long txqs, 1008 bool freeze) 1009 { 1010 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1011 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1012 return; 1013 } 1014 1015 if (trans->ops->freeze_txq_timer) 1016 trans->ops->freeze_txq_timer(trans, txqs, freeze); 1017 } 1018 1019 static inline void iwl_trans_block_txq_ptrs(struct iwl_trans *trans, 1020 bool block) 1021 { 1022 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1023 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1024 return; 1025 } 1026 1027 if (trans->ops->block_txq_ptrs) 1028 trans->ops->block_txq_ptrs(trans, block); 1029 } 1030 1031 static inline int iwl_trans_wait_tx_queues_empty(struct iwl_trans *trans, 1032 u32 txqs) 1033 { 1034 if (WARN_ON_ONCE(!trans->ops->wait_tx_queues_empty)) 1035 return -ENOTSUPP; 1036 1037 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1038 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1039 return -EIO; 1040 } 1041 1042 return trans->ops->wait_tx_queues_empty(trans, txqs); 1043 } 1044 1045 static inline int iwl_trans_wait_txq_empty(struct iwl_trans *trans, int queue) 1046 { 1047 if (WARN_ON_ONCE(!trans->ops->wait_txq_empty)) 1048 return -ENOTSUPP; 1049 1050 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1051 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1052 return -EIO; 1053 } 1054 1055 return trans->ops->wait_txq_empty(trans, queue); 1056 } 1057 1058 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val) 1059 { 1060 trans->ops->write8(trans, ofs, val); 1061 } 1062 1063 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val) 1064 { 1065 trans->ops->write32(trans, ofs, val); 1066 } 1067 1068 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs) 1069 { 1070 return trans->ops->read32(trans, ofs); 1071 } 1072 1073 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs) 1074 { 1075 return trans->ops->read_prph(trans, ofs); 1076 } 1077 1078 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs, 1079 u32 val) 1080 { 1081 return trans->ops->write_prph(trans, ofs, val); 1082 } 1083 1084 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr, 1085 void *buf, int dwords) 1086 { 1087 return trans->ops->read_mem(trans, addr, buf, dwords); 1088 } 1089 1090 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \ 1091 do { \ 1092 if (__builtin_constant_p(bufsize)) \ 1093 BUILD_BUG_ON((bufsize) % sizeof(u32)); \ 1094 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\ 1095 } while (0) 1096 1097 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr) 1098 { 1099 u32 value; 1100 1101 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1))) 1102 return 0xa5a5a5a5; 1103 1104 return value; 1105 } 1106 1107 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr, 1108 const void *buf, int dwords) 1109 { 1110 return trans->ops->write_mem(trans, addr, buf, dwords); 1111 } 1112 1113 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr, 1114 u32 val) 1115 { 1116 return iwl_trans_write_mem(trans, addr, &val, 1); 1117 } 1118 1119 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state) 1120 { 1121 if (trans->ops->set_pmi) 1122 trans->ops->set_pmi(trans, state); 1123 } 1124 1125 static inline void 1126 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value) 1127 { 1128 trans->ops->set_bits_mask(trans, reg, mask, value); 1129 } 1130 1131 #define iwl_trans_grab_nic_access(trans, flags) \ 1132 __cond_lock(nic_access, \ 1133 likely((trans)->ops->grab_nic_access(trans, flags))) 1134 1135 static inline void __releases(nic_access) 1136 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags) 1137 { 1138 trans->ops->release_nic_access(trans, flags); 1139 __release(nic_access); 1140 } 1141 1142 static inline void iwl_trans_fw_error(struct iwl_trans *trans) 1143 { 1144 if (WARN_ON_ONCE(!trans->op_mode)) 1145 return; 1146 1147 /* prevent double restarts due to the same erroneous FW */ 1148 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status)) 1149 iwl_op_mode_nic_error(trans->op_mode); 1150 } 1151 1152 /***************************************************** 1153 * transport helper functions 1154 *****************************************************/ 1155 struct iwl_trans *iwl_trans_alloc(unsigned int priv_size, 1156 struct device *dev, 1157 const struct iwl_cfg *cfg, 1158 const struct iwl_trans_ops *ops); 1159 void iwl_trans_free(struct iwl_trans *trans); 1160 void iwl_trans_ref(struct iwl_trans *trans); 1161 void iwl_trans_unref(struct iwl_trans *trans); 1162 1163 /***************************************************** 1164 * driver (transport) register/unregister functions 1165 ******************************************************/ 1166 int __must_check iwl_pci_register_driver(void); 1167 void iwl_pci_unregister_driver(void); 1168 1169 #endif /* __iwl_trans_h__ */ 1170