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