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_WANT_ASYNC_CALLBACK: the op_mode's async callback function must be 163 * called after this command completes. Valid only with CMD_ASYNC. 164 */ 165 enum CMD_MODE { 166 CMD_ASYNC = BIT(0), 167 CMD_WANT_SKB = BIT(1), 168 CMD_SEND_IN_RFKILL = BIT(2), 169 CMD_WANT_ASYNC_CALLBACK = BIT(3), 170 }; 171 172 #define DEF_CMD_PAYLOAD_SIZE 320 173 174 /** 175 * struct iwl_device_cmd 176 * 177 * For allocation of the command and tx queues, this establishes the overall 178 * size of the largest command we send to uCode, except for commands that 179 * aren't fully copied and use other TFD space. 180 */ 181 struct iwl_device_cmd { 182 union { 183 struct { 184 struct iwl_cmd_header hdr; /* uCode API */ 185 u8 payload[DEF_CMD_PAYLOAD_SIZE]; 186 }; 187 struct { 188 struct iwl_cmd_header_wide hdr_wide; 189 u8 payload_wide[DEF_CMD_PAYLOAD_SIZE - 190 sizeof(struct iwl_cmd_header_wide) + 191 sizeof(struct iwl_cmd_header)]; 192 }; 193 }; 194 } __packed; 195 196 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd)) 197 198 /* 199 * number of transfer buffers (fragments) per transmit frame descriptor; 200 * this is just the driver's idea, the hardware supports 20 201 */ 202 #define IWL_MAX_CMD_TBS_PER_TFD 2 203 204 /** 205 * enum iwl_hcmd_dataflag - flag for each one of the chunks of the command 206 * 207 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's 208 * ring. The transport layer doesn't map the command's buffer to DMA, but 209 * rather copies it to a previously allocated DMA buffer. This flag tells 210 * the transport layer not to copy the command, but to map the existing 211 * buffer (that is passed in) instead. This saves the memcpy and allows 212 * commands that are bigger than the fixed buffer to be submitted. 213 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one. 214 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this 215 * chunk internally and free it again after the command completes. This 216 * can (currently) be used only once per command. 217 * Note that a TFD entry after a DUP one cannot be a normal copied one. 218 */ 219 enum iwl_hcmd_dataflag { 220 IWL_HCMD_DFL_NOCOPY = BIT(0), 221 IWL_HCMD_DFL_DUP = BIT(1), 222 }; 223 224 enum iwl_error_event_table_status { 225 IWL_ERROR_EVENT_TABLE_LMAC1 = BIT(0), 226 IWL_ERROR_EVENT_TABLE_LMAC2 = BIT(1), 227 IWL_ERROR_EVENT_TABLE_UMAC = BIT(2), 228 }; 229 230 /** 231 * struct iwl_host_cmd - Host command to the uCode 232 * 233 * @data: array of chunks that composes the data of the host command 234 * @resp_pkt: response packet, if %CMD_WANT_SKB was set 235 * @_rx_page_order: (internally used to free response packet) 236 * @_rx_page_addr: (internally used to free response packet) 237 * @flags: can be CMD_* 238 * @len: array of the lengths of the chunks in data 239 * @dataflags: IWL_HCMD_DFL_* 240 * @id: command id of the host command, for wide commands encoding the 241 * version and group as well 242 */ 243 struct iwl_host_cmd { 244 const void *data[IWL_MAX_CMD_TBS_PER_TFD]; 245 struct iwl_rx_packet *resp_pkt; 246 unsigned long _rx_page_addr; 247 u32 _rx_page_order; 248 249 u32 flags; 250 u32 id; 251 u16 len[IWL_MAX_CMD_TBS_PER_TFD]; 252 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD]; 253 }; 254 255 static inline void iwl_free_resp(struct iwl_host_cmd *cmd) 256 { 257 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order); 258 } 259 260 struct iwl_rx_cmd_buffer { 261 struct page *_page; 262 int _offset; 263 bool _page_stolen; 264 u32 _rx_page_order; 265 unsigned int truesize; 266 }; 267 268 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r) 269 { 270 return (void *)((unsigned long)page_address(r->_page) + r->_offset); 271 } 272 273 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r) 274 { 275 return r->_offset; 276 } 277 278 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r) 279 { 280 r->_page_stolen = true; 281 get_page(r->_page); 282 return r->_page; 283 } 284 285 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r) 286 { 287 __free_pages(r->_page, r->_rx_page_order); 288 } 289 290 #define MAX_NO_RECLAIM_CMDS 6 291 292 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo)))) 293 294 /* 295 * Maximum number of HW queues the transport layer 296 * currently supports 297 */ 298 #define IWL_MAX_HW_QUEUES 32 299 #define IWL_MAX_TVQM_QUEUES 512 300 301 #define IWL_MAX_TID_COUNT 8 302 #define IWL_MGMT_TID 15 303 #define IWL_FRAME_LIMIT 64 304 #define IWL_MAX_RX_HW_QUEUES 16 305 306 /** 307 * enum iwl_wowlan_status - WoWLAN image/device status 308 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume 309 * @IWL_D3_STATUS_RESET: device was reset while suspended 310 */ 311 enum iwl_d3_status { 312 IWL_D3_STATUS_ALIVE, 313 IWL_D3_STATUS_RESET, 314 }; 315 316 /** 317 * enum iwl_trans_status: transport status flags 318 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed 319 * @STATUS_DEVICE_ENABLED: APM is enabled 320 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up) 321 * @STATUS_INT_ENABLED: interrupts are enabled 322 * @STATUS_RFKILL_HW: the actual HW state of the RF-kill switch 323 * @STATUS_RFKILL_OPMODE: RF-kill state reported to opmode 324 * @STATUS_FW_ERROR: the fw is in error state 325 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands 326 * are sent 327 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent 328 * @STATUS_TRANS_DEAD: trans is dead - avoid any read/write operation 329 */ 330 enum iwl_trans_status { 331 STATUS_SYNC_HCMD_ACTIVE, 332 STATUS_DEVICE_ENABLED, 333 STATUS_TPOWER_PMI, 334 STATUS_INT_ENABLED, 335 STATUS_RFKILL_HW, 336 STATUS_RFKILL_OPMODE, 337 STATUS_FW_ERROR, 338 STATUS_TRANS_GOING_IDLE, 339 STATUS_TRANS_IDLE, 340 STATUS_TRANS_DEAD, 341 }; 342 343 static inline int 344 iwl_trans_get_rb_size_order(enum iwl_amsdu_size rb_size) 345 { 346 switch (rb_size) { 347 case IWL_AMSDU_2K: 348 return get_order(2 * 1024); 349 case IWL_AMSDU_4K: 350 return get_order(4 * 1024); 351 case IWL_AMSDU_8K: 352 return get_order(8 * 1024); 353 case IWL_AMSDU_12K: 354 return get_order(12 * 1024); 355 default: 356 WARN_ON(1); 357 return -1; 358 } 359 } 360 361 static inline int 362 iwl_trans_get_rb_size(enum iwl_amsdu_size rb_size) 363 { 364 switch (rb_size) { 365 case IWL_AMSDU_2K: 366 return 2 * 1024; 367 case IWL_AMSDU_4K: 368 return 4 * 1024; 369 case IWL_AMSDU_8K: 370 return 8 * 1024; 371 case IWL_AMSDU_12K: 372 return 12 * 1024; 373 default: 374 WARN_ON(1); 375 return 0; 376 } 377 } 378 379 struct iwl_hcmd_names { 380 u8 cmd_id; 381 const char *const cmd_name; 382 }; 383 384 #define HCMD_NAME(x) \ 385 { .cmd_id = x, .cmd_name = #x } 386 387 struct iwl_hcmd_arr { 388 const struct iwl_hcmd_names *arr; 389 int size; 390 }; 391 392 #define HCMD_ARR(x) \ 393 { .arr = x, .size = ARRAY_SIZE(x) } 394 395 /** 396 * struct iwl_trans_config - transport configuration 397 * 398 * @op_mode: pointer to the upper layer. 399 * @cmd_queue: the index of the command queue. 400 * Must be set before start_fw. 401 * @cmd_fifo: the fifo for host commands 402 * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue. 403 * @no_reclaim_cmds: Some devices erroneously don't set the 404 * SEQ_RX_FRAME bit on some notifications, this is the 405 * list of such notifications to filter. Max length is 406 * %MAX_NO_RECLAIM_CMDS. 407 * @n_no_reclaim_cmds: # of commands in list 408 * @rx_buf_size: RX buffer size needed for A-MSDUs 409 * if unset 4k will be the RX buffer size 410 * @bc_table_dword: set to true if the BC table expects the byte count to be 411 * in DWORD (as opposed to bytes) 412 * @scd_set_active: should the transport configure the SCD for HCMD queue 413 * @sw_csum_tx: transport should compute the TCP checksum 414 * @command_groups: array of command groups, each member is an array of the 415 * commands in the group; for debugging only 416 * @command_groups_size: number of command groups, to avoid illegal access 417 * @cb_data_offs: offset inside skb->cb to store transport data at, must have 418 * space for at least two pointers 419 */ 420 struct iwl_trans_config { 421 struct iwl_op_mode *op_mode; 422 423 u8 cmd_queue; 424 u8 cmd_fifo; 425 unsigned int cmd_q_wdg_timeout; 426 const u8 *no_reclaim_cmds; 427 unsigned int n_no_reclaim_cmds; 428 429 enum iwl_amsdu_size rx_buf_size; 430 bool bc_table_dword; 431 bool scd_set_active; 432 bool sw_csum_tx; 433 const struct iwl_hcmd_arr *command_groups; 434 int command_groups_size; 435 436 u8 cb_data_offs; 437 }; 438 439 struct iwl_trans_dump_data { 440 u32 len; 441 u8 data[]; 442 }; 443 444 struct iwl_trans; 445 446 struct iwl_trans_txq_scd_cfg { 447 u8 fifo; 448 u8 sta_id; 449 u8 tid; 450 bool aggregate; 451 int frame_limit; 452 }; 453 454 /** 455 * struct iwl_trans_rxq_dma_data - RX queue DMA data 456 * @fr_bd_cb: DMA address of free BD cyclic buffer 457 * @fr_bd_wid: Initial write index of the free BD cyclic buffer 458 * @urbd_stts_wrptr: DMA address of urbd_stts_wrptr 459 * @ur_bd_cb: DMA address of used BD cyclic buffer 460 */ 461 struct iwl_trans_rxq_dma_data { 462 u64 fr_bd_cb; 463 u32 fr_bd_wid; 464 u64 urbd_stts_wrptr; 465 u64 ur_bd_cb; 466 }; 467 468 /** 469 * struct iwl_trans_ops - transport specific operations 470 * 471 * All the handlers MUST be implemented 472 * 473 * @start_hw: starts the HW. From that point on, the HW can send interrupts. 474 * May sleep. 475 * @op_mode_leave: Turn off the HW RF kill indication if on 476 * May sleep 477 * @start_fw: allocates and inits all the resources for the transport 478 * layer. Also kick a fw image. 479 * May sleep 480 * @fw_alive: called when the fw sends alive notification. If the fw provides 481 * the SCD base address in SRAM, then provide it here, or 0 otherwise. 482 * May sleep 483 * @stop_device: stops the whole device (embedded CPU put to reset) and stops 484 * the HW. From that point on, the HW will be stopped but will still issue 485 * an interrupt if the HW RF kill switch is triggered. 486 * This callback must do the right thing and not crash even if %start_hw() 487 * was called but not &start_fw(). May sleep. 488 * @d3_suspend: put the device into the correct mode for WoWLAN during 489 * suspend. This is optional, if not implemented WoWLAN will not be 490 * supported. This callback may sleep. 491 * @d3_resume: resume the device after WoWLAN, enabling the opmode to 492 * talk to the WoWLAN image to get its status. This is optional, if not 493 * implemented WoWLAN will not be supported. This callback may sleep. 494 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted. 495 * If RFkill is asserted in the middle of a SYNC host command, it must 496 * return -ERFKILL straight away. 497 * May sleep only if CMD_ASYNC is not set 498 * @tx: send an skb. The transport relies on the op_mode to zero the 499 * the ieee80211_tx_info->driver_data. If the MPDU is an A-MSDU, all 500 * the CSUM will be taken care of (TCP CSUM and IP header in case of 501 * IPv4). If the MPDU is a single MSDU, the op_mode must compute the IP 502 * header if it is IPv4. 503 * Must be atomic 504 * @reclaim: free packet until ssn. Returns a list of freed packets. 505 * Must be atomic 506 * @txq_enable: setup a queue. To setup an AC queue, use the 507 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before 508 * this one. The op_mode must not configure the HCMD queue. The scheduler 509 * configuration may be %NULL, in which case the hardware will not be 510 * configured. If true is returned, the operation mode needs to increment 511 * the sequence number of the packets routed to this queue because of a 512 * hardware scheduler bug. May sleep. 513 * @txq_disable: de-configure a Tx queue to send AMPDUs 514 * Must be atomic 515 * @txq_set_shared_mode: change Tx queue shared/unshared marking 516 * @wait_tx_queues_empty: wait until tx queues are empty. May sleep. 517 * @wait_txq_empty: wait until specific tx queue is empty. May sleep. 518 * @freeze_txq_timer: prevents the timer of the queue from firing until the 519 * queue is set to awake. Must be atomic. 520 * @block_txq_ptrs: stop updating the write pointers of the Tx queues. Note 521 * that the transport needs to refcount the calls since this function 522 * will be called several times with block = true, and then the queues 523 * need to be unblocked only after the same number of calls with 524 * block = false. 525 * @write8: write a u8 to a register at offset ofs from the BAR 526 * @write32: write a u32 to a register at offset ofs from the BAR 527 * @read32: read a u32 register at offset ofs from the BAR 528 * @read_prph: read a DWORD from a periphery register 529 * @write_prph: write a DWORD to a periphery register 530 * @read_mem: read device's SRAM in DWORD 531 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory 532 * will be zeroed. 533 * @configure: configure parameters required by the transport layer from 534 * the op_mode. May be called several times before start_fw, can't be 535 * called after that. 536 * @set_pmi: set the power pmi state 537 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs. 538 * Sleeping is not allowed between grab_nic_access and 539 * release_nic_access. 540 * @release_nic_access: let the NIC go to sleep. The "flags" parameter 541 * must be the same one that was sent before to the grab_nic_access. 542 * @set_bits_mask - set SRAM register according to value and mask. 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); 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); 557 558 int (*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 void (*set_q_ptrs)(struct iwl_trans *trans, int queue, int ptr); 570 571 bool (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn, 572 const struct iwl_trans_txq_scd_cfg *cfg, 573 unsigned int queue_wdg_timeout); 574 void (*txq_disable)(struct iwl_trans *trans, int queue, 575 bool configure_scd); 576 /* 22000 functions */ 577 int (*txq_alloc)(struct iwl_trans *trans, 578 __le16 flags, u8 sta_id, u8 tid, 579 int cmd_id, int size, 580 unsigned int queue_wdg_timeout); 581 void (*txq_free)(struct iwl_trans *trans, int queue); 582 int (*rxq_dma_data)(struct iwl_trans *trans, int queue, 583 struct iwl_trans_rxq_dma_data *data); 584 585 void (*txq_set_shared_mode)(struct iwl_trans *trans, u32 txq_id, 586 bool shared); 587 588 int (*wait_tx_queues_empty)(struct iwl_trans *trans, u32 txq_bm); 589 int (*wait_txq_empty)(struct iwl_trans *trans, int queue); 590 void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs, 591 bool freeze); 592 void (*block_txq_ptrs)(struct iwl_trans *trans, bool block); 593 594 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val); 595 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val); 596 u32 (*read32)(struct iwl_trans *trans, u32 ofs); 597 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs); 598 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val); 599 int (*read_mem)(struct iwl_trans *trans, u32 addr, 600 void *buf, int dwords); 601 int (*write_mem)(struct iwl_trans *trans, u32 addr, 602 const void *buf, int dwords); 603 void (*configure)(struct iwl_trans *trans, 604 const struct iwl_trans_config *trans_cfg); 605 void (*set_pmi)(struct iwl_trans *trans, bool state); 606 void (*sw_reset)(struct iwl_trans *trans); 607 bool (*grab_nic_access)(struct iwl_trans *trans, unsigned long *flags); 608 void (*release_nic_access)(struct iwl_trans *trans, 609 unsigned long *flags); 610 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask, 611 u32 value); 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 * In system-wide power management the entire platform goes into a low 636 * power state (e.g. idle or suspend to RAM) at the same time and the 637 * device is configured as a wakeup source for the entire platform. 638 * This is usually triggered by userspace activity (e.g. the user 639 * presses the suspend button or a power management daemon decides to 640 * put the platform in low power mode). The device's behavior in this 641 * mode is dictated by the wake-on-WLAN configuration. 642 * 643 * The terms used for the device's behavior are as follows: 644 * 645 * - D0: the device is fully powered and the host is awake; 646 * - D3: the device is in low power mode and only reacts to 647 * specific events (e.g. magic-packet received or scan 648 * results found); 649 * 650 * These terms reflect the power modes in the firmware and are not to 651 * be confused with the physical device power state. 652 */ 653 654 /** 655 * enum iwl_plat_pm_mode - platform power management mode 656 * 657 * This enumeration describes the device's platform power management 658 * behavior when in system-wide suspend (i.e WoWLAN). 659 * 660 * @IWL_PLAT_PM_MODE_DISABLED: power management is disabled for this 661 * device. In system-wide suspend mode, it means that the all 662 * connections will be closed automatically by mac80211 before 663 * the platform is suspended. 664 * @IWL_PLAT_PM_MODE_D3: the device goes into D3 mode (i.e. WoWLAN). 665 */ 666 enum iwl_plat_pm_mode { 667 IWL_PLAT_PM_MODE_DISABLED, 668 IWL_PLAT_PM_MODE_D3, 669 }; 670 671 /** 672 * enum iwl_ini_cfg_state 673 * @IWL_INI_CFG_STATE_NOT_LOADED: no debug cfg was given 674 * @IWL_INI_CFG_STATE_LOADED: debug cfg was found and loaded 675 * @IWL_INI_CFG_STATE_CORRUPTED: debug cfg was found and some of the TLVs 676 * are corrupted. The rest of the debug TLVs will still be used 677 */ 678 enum iwl_ini_cfg_state { 679 IWL_INI_CFG_STATE_NOT_LOADED, 680 IWL_INI_CFG_STATE_LOADED, 681 IWL_INI_CFG_STATE_CORRUPTED, 682 }; 683 684 /* Max time to wait for nmi interrupt */ 685 #define IWL_TRANS_NMI_TIMEOUT (HZ / 4) 686 687 /** 688 * struct iwl_dram_data 689 * @physical: page phy pointer 690 * @block: pointer to the allocated block/page 691 * @size: size of the block/page 692 */ 693 struct iwl_dram_data { 694 dma_addr_t physical; 695 void *block; 696 int size; 697 }; 698 699 /** 700 * struct iwl_fw_mon - fw monitor per allocation id 701 * @num_frags: number of fragments 702 * @frags: an array of DRAM buffer fragments 703 */ 704 struct iwl_fw_mon { 705 u32 num_frags; 706 struct iwl_dram_data *frags; 707 }; 708 709 /** 710 * struct iwl_self_init_dram - dram data used by self init process 711 * @fw: lmac and umac dram data 712 * @fw_cnt: total number of items in array 713 * @paging: paging dram data 714 * @paging_cnt: total number of items in array 715 */ 716 struct iwl_self_init_dram { 717 struct iwl_dram_data *fw; 718 int fw_cnt; 719 struct iwl_dram_data *paging; 720 int paging_cnt; 721 }; 722 723 /** 724 * struct iwl_trans_debug - transport debug related data 725 * 726 * @n_dest_reg: num of reg_ops in %dbg_dest_tlv 727 * @rec_on: true iff there is a fw debug recording currently active 728 * @dest_tlv: points to the destination TLV for debug 729 * @conf_tlv: array of pointers to configuration TLVs for debug 730 * @trigger_tlv: array of pointers to triggers TLVs for debug 731 * @lmac_error_event_table: addrs of lmacs error tables 732 * @umac_error_event_table: addr of umac error table 733 * @error_event_table_tlv_status: bitmap that indicates what error table 734 * pointers was recevied via TLV. uses enum &iwl_error_event_table_status 735 * @internal_ini_cfg: internal debug cfg state. Uses &enum iwl_ini_cfg_state 736 * @external_ini_cfg: external debug cfg state. Uses &enum iwl_ini_cfg_state 737 * @fw_mon_cfg: debug buffer allocation configuration 738 * @fw_mon_ini: DRAM buffer fragments per allocation id 739 * @fw_mon: DRAM buffer 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 * @active_regions: active regions 743 * @debug_info_tlv_list: list of debug info TLVs 744 * @time_point: array of debug time points 745 * @periodic_trig_list: periodic triggers list 746 * @domains_bitmap: bitmap of active domains other than 747 * &IWL_FW_INI_DOMAIN_ALWAYS_ON 748 */ 749 struct iwl_trans_debug { 750 u8 n_dest_reg; 751 bool rec_on; 752 753 const struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv; 754 const struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX]; 755 struct iwl_fw_dbg_trigger_tlv * const *trigger_tlv; 756 757 u32 lmac_error_event_table[2]; 758 u32 umac_error_event_table; 759 unsigned int error_event_table_tlv_status; 760 761 enum iwl_ini_cfg_state internal_ini_cfg; 762 enum iwl_ini_cfg_state external_ini_cfg; 763 764 struct iwl_fw_ini_allocation_tlv fw_mon_cfg[IWL_FW_INI_ALLOCATION_NUM]; 765 struct iwl_fw_mon fw_mon_ini[IWL_FW_INI_ALLOCATION_NUM]; 766 767 struct iwl_dram_data fw_mon; 768 769 bool hw_error; 770 enum iwl_fw_ini_buffer_location ini_dest; 771 772 struct iwl_ucode_tlv *active_regions[IWL_FW_INI_MAX_REGION_ID]; 773 struct list_head debug_info_tlv_list; 774 struct iwl_dbg_tlv_time_point_data 775 time_point[IWL_FW_INI_TIME_POINT_NUM]; 776 struct list_head periodic_trig_list; 777 778 u32 domains_bitmap; 779 }; 780 781 /** 782 * struct iwl_trans - transport common data 783 * 784 * @ops - pointer to iwl_trans_ops 785 * @op_mode - pointer to the op_mode 786 * @trans_cfg: the trans-specific configuration part 787 * @cfg - pointer to the configuration 788 * @drv - pointer to iwl_drv 789 * @status: a bit-mask of transport status flags 790 * @dev - pointer to struct device * that represents the device 791 * @max_skb_frags: maximum number of fragments an SKB can have when transmitted. 792 * 0 indicates that frag SKBs (NETIF_F_SG) aren't supported. 793 * @hw_rf_id a u32 with the device RF ID 794 * @hw_id: a u32 with the ID of the device / sub-device. 795 * Set during transport allocation. 796 * @hw_id_str: a string with info about HW ID. Set during transport allocation. 797 * @pm_support: set to true in start_hw if link pm is supported 798 * @ltr_enabled: set to true if the LTR is enabled 799 * @wide_cmd_header: true when ucode supports wide command header format 800 * @num_rx_queues: number of RX queues allocated by the transport; 801 * the transport must set this before calling iwl_drv_start() 802 * @iml_len: the length of the image loader 803 * @iml: a pointer to the image loader itself 804 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only. 805 * The user should use iwl_trans_{alloc,free}_tx_cmd. 806 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before 807 * starting the firmware, used for tracing 808 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the 809 * start of the 802.11 header in the @rx_mpdu_cmd 810 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI) 811 * @system_pm_mode: the system-wide power management mode in use. 812 * This mode is set dynamically, depending on the WoWLAN values 813 * configured from the userspace at runtime. 814 */ 815 struct iwl_trans { 816 const struct iwl_trans_ops *ops; 817 struct iwl_op_mode *op_mode; 818 const struct iwl_cfg_trans_params *trans_cfg; 819 const struct iwl_cfg *cfg; 820 struct iwl_drv *drv; 821 enum iwl_trans_state state; 822 unsigned long status; 823 824 struct device *dev; 825 u32 max_skb_frags; 826 u32 hw_rev; 827 u32 hw_rf_id; 828 u32 hw_id; 829 char hw_id_str[52]; 830 831 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size; 832 833 bool pm_support; 834 bool ltr_enabled; 835 836 const struct iwl_hcmd_arr *command_groups; 837 int command_groups_size; 838 bool wide_cmd_header; 839 840 u8 num_rx_queues; 841 842 size_t iml_len; 843 u8 *iml; 844 845 /* The following fields are internal only */ 846 struct kmem_cache *dev_cmd_pool; 847 char dev_cmd_pool_name[50]; 848 849 struct dentry *dbgfs_dir; 850 851 #ifdef CONFIG_LOCKDEP 852 struct lockdep_map sync_cmd_lockdep_map; 853 #endif 854 855 struct iwl_trans_debug dbg; 856 struct iwl_self_init_dram init_dram; 857 858 enum iwl_plat_pm_mode system_pm_mode; 859 860 /* pointer to trans specific struct */ 861 /*Ensure that this pointer will always be aligned to sizeof pointer */ 862 char trans_specific[0] __aligned(sizeof(void *)); 863 }; 864 865 const char *iwl_get_cmd_string(struct iwl_trans *trans, u32 id); 866 int iwl_cmd_groups_verify_sorted(const struct iwl_trans_config *trans); 867 868 static inline void iwl_trans_configure(struct iwl_trans *trans, 869 const struct iwl_trans_config *trans_cfg) 870 { 871 trans->op_mode = trans_cfg->op_mode; 872 873 trans->ops->configure(trans, trans_cfg); 874 WARN_ON(iwl_cmd_groups_verify_sorted(trans_cfg)); 875 } 876 877 static inline int iwl_trans_start_hw(struct iwl_trans *trans) 878 { 879 might_sleep(); 880 881 return trans->ops->start_hw(trans); 882 } 883 884 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans) 885 { 886 might_sleep(); 887 888 if (trans->ops->op_mode_leave) 889 trans->ops->op_mode_leave(trans); 890 891 trans->op_mode = NULL; 892 893 trans->state = IWL_TRANS_NO_FW; 894 } 895 896 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr) 897 { 898 might_sleep(); 899 900 trans->state = IWL_TRANS_FW_ALIVE; 901 902 trans->ops->fw_alive(trans, scd_addr); 903 } 904 905 static inline int iwl_trans_start_fw(struct iwl_trans *trans, 906 const struct fw_img *fw, 907 bool run_in_rfkill) 908 { 909 might_sleep(); 910 911 WARN_ON_ONCE(!trans->rx_mpdu_cmd); 912 913 clear_bit(STATUS_FW_ERROR, &trans->status); 914 return trans->ops->start_fw(trans, fw, run_in_rfkill); 915 } 916 917 static inline void iwl_trans_stop_device(struct iwl_trans *trans) 918 { 919 might_sleep(); 920 921 trans->ops->stop_device(trans); 922 923 trans->state = IWL_TRANS_NO_FW; 924 } 925 926 static inline int iwl_trans_d3_suspend(struct iwl_trans *trans, bool test, 927 bool reset) 928 { 929 might_sleep(); 930 if (!trans->ops->d3_suspend) 931 return 0; 932 933 return trans->ops->d3_suspend(trans, test, reset); 934 } 935 936 static inline int iwl_trans_d3_resume(struct iwl_trans *trans, 937 enum iwl_d3_status *status, 938 bool test, bool reset) 939 { 940 might_sleep(); 941 if (!trans->ops->d3_resume) 942 return 0; 943 944 return trans->ops->d3_resume(trans, status, test, reset); 945 } 946 947 static inline int iwl_trans_suspend(struct iwl_trans *trans) 948 { 949 if (!trans->ops->suspend) 950 return 0; 951 952 return trans->ops->suspend(trans); 953 } 954 955 static inline void iwl_trans_resume(struct iwl_trans *trans) 956 { 957 if (trans->ops->resume) 958 trans->ops->resume(trans); 959 } 960 961 static inline struct iwl_trans_dump_data * 962 iwl_trans_dump_data(struct iwl_trans *trans, u32 dump_mask) 963 { 964 if (!trans->ops->dump_data) 965 return NULL; 966 return trans->ops->dump_data(trans, dump_mask); 967 } 968 969 static inline struct iwl_device_cmd * 970 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans) 971 { 972 return kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC); 973 } 974 975 int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd); 976 977 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans, 978 struct iwl_device_cmd *dev_cmd) 979 { 980 kmem_cache_free(trans->dev_cmd_pool, dev_cmd); 981 } 982 983 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb, 984 struct iwl_device_cmd *dev_cmd, int queue) 985 { 986 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status))) 987 return -EIO; 988 989 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 990 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 991 return -EIO; 992 } 993 994 return trans->ops->tx(trans, skb, dev_cmd, queue); 995 } 996 997 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue, 998 int ssn, struct sk_buff_head *skbs) 999 { 1000 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1001 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1002 return; 1003 } 1004 1005 trans->ops->reclaim(trans, queue, ssn, skbs); 1006 } 1007 1008 static inline void iwl_trans_set_q_ptrs(struct iwl_trans *trans, int queue, 1009 int ptr) 1010 { 1011 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1012 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1013 return; 1014 } 1015 1016 trans->ops->set_q_ptrs(trans, queue, ptr); 1017 } 1018 1019 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue, 1020 bool configure_scd) 1021 { 1022 trans->ops->txq_disable(trans, queue, configure_scd); 1023 } 1024 1025 static inline bool 1026 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn, 1027 const struct iwl_trans_txq_scd_cfg *cfg, 1028 unsigned int queue_wdg_timeout) 1029 { 1030 might_sleep(); 1031 1032 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1033 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1034 return false; 1035 } 1036 1037 return trans->ops->txq_enable(trans, queue, ssn, 1038 cfg, queue_wdg_timeout); 1039 } 1040 1041 static inline int 1042 iwl_trans_get_rxq_dma_data(struct iwl_trans *trans, int queue, 1043 struct iwl_trans_rxq_dma_data *data) 1044 { 1045 if (WARN_ON_ONCE(!trans->ops->rxq_dma_data)) 1046 return -ENOTSUPP; 1047 1048 return trans->ops->rxq_dma_data(trans, queue, data); 1049 } 1050 1051 static inline void 1052 iwl_trans_txq_free(struct iwl_trans *trans, int queue) 1053 { 1054 if (WARN_ON_ONCE(!trans->ops->txq_free)) 1055 return; 1056 1057 trans->ops->txq_free(trans, queue); 1058 } 1059 1060 static inline int 1061 iwl_trans_txq_alloc(struct iwl_trans *trans, 1062 __le16 flags, u8 sta_id, u8 tid, 1063 int cmd_id, int size, 1064 unsigned int wdg_timeout) 1065 { 1066 might_sleep(); 1067 1068 if (WARN_ON_ONCE(!trans->ops->txq_alloc)) 1069 return -ENOTSUPP; 1070 1071 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1072 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1073 return -EIO; 1074 } 1075 1076 return trans->ops->txq_alloc(trans, flags, sta_id, tid, 1077 cmd_id, size, wdg_timeout); 1078 } 1079 1080 static inline void iwl_trans_txq_set_shared_mode(struct iwl_trans *trans, 1081 int queue, bool shared_mode) 1082 { 1083 if (trans->ops->txq_set_shared_mode) 1084 trans->ops->txq_set_shared_mode(trans, queue, shared_mode); 1085 } 1086 1087 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue, 1088 int fifo, int sta_id, int tid, 1089 int frame_limit, u16 ssn, 1090 unsigned int queue_wdg_timeout) 1091 { 1092 struct iwl_trans_txq_scd_cfg cfg = { 1093 .fifo = fifo, 1094 .sta_id = sta_id, 1095 .tid = tid, 1096 .frame_limit = frame_limit, 1097 .aggregate = sta_id >= 0, 1098 }; 1099 1100 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout); 1101 } 1102 1103 static inline 1104 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo, 1105 unsigned int queue_wdg_timeout) 1106 { 1107 struct iwl_trans_txq_scd_cfg cfg = { 1108 .fifo = fifo, 1109 .sta_id = -1, 1110 .tid = IWL_MAX_TID_COUNT, 1111 .frame_limit = IWL_FRAME_LIMIT, 1112 .aggregate = false, 1113 }; 1114 1115 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout); 1116 } 1117 1118 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans, 1119 unsigned long txqs, 1120 bool freeze) 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->freeze_txq_timer) 1128 trans->ops->freeze_txq_timer(trans, txqs, freeze); 1129 } 1130 1131 static inline void iwl_trans_block_txq_ptrs(struct iwl_trans *trans, 1132 bool block) 1133 { 1134 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1135 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1136 return; 1137 } 1138 1139 if (trans->ops->block_txq_ptrs) 1140 trans->ops->block_txq_ptrs(trans, block); 1141 } 1142 1143 static inline int iwl_trans_wait_tx_queues_empty(struct iwl_trans *trans, 1144 u32 txqs) 1145 { 1146 if (WARN_ON_ONCE(!trans->ops->wait_tx_queues_empty)) 1147 return -ENOTSUPP; 1148 1149 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1150 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1151 return -EIO; 1152 } 1153 1154 return trans->ops->wait_tx_queues_empty(trans, txqs); 1155 } 1156 1157 static inline int iwl_trans_wait_txq_empty(struct iwl_trans *trans, int queue) 1158 { 1159 if (WARN_ON_ONCE(!trans->ops->wait_txq_empty)) 1160 return -ENOTSUPP; 1161 1162 if (WARN_ON_ONCE(trans->state != IWL_TRANS_FW_ALIVE)) { 1163 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 1164 return -EIO; 1165 } 1166 1167 return trans->ops->wait_txq_empty(trans, queue); 1168 } 1169 1170 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val) 1171 { 1172 trans->ops->write8(trans, ofs, val); 1173 } 1174 1175 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val) 1176 { 1177 trans->ops->write32(trans, ofs, val); 1178 } 1179 1180 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs) 1181 { 1182 return trans->ops->read32(trans, ofs); 1183 } 1184 1185 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs) 1186 { 1187 return trans->ops->read_prph(trans, ofs); 1188 } 1189 1190 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs, 1191 u32 val) 1192 { 1193 return trans->ops->write_prph(trans, ofs, val); 1194 } 1195 1196 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr, 1197 void *buf, int dwords) 1198 { 1199 return trans->ops->read_mem(trans, addr, buf, dwords); 1200 } 1201 1202 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \ 1203 do { \ 1204 if (__builtin_constant_p(bufsize)) \ 1205 BUILD_BUG_ON((bufsize) % sizeof(u32)); \ 1206 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\ 1207 } while (0) 1208 1209 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr) 1210 { 1211 u32 value; 1212 1213 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1))) 1214 return 0xa5a5a5a5; 1215 1216 return value; 1217 } 1218 1219 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr, 1220 const void *buf, int dwords) 1221 { 1222 return trans->ops->write_mem(trans, addr, buf, dwords); 1223 } 1224 1225 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr, 1226 u32 val) 1227 { 1228 return iwl_trans_write_mem(trans, addr, &val, 1); 1229 } 1230 1231 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state) 1232 { 1233 if (trans->ops->set_pmi) 1234 trans->ops->set_pmi(trans, state); 1235 } 1236 1237 static inline void iwl_trans_sw_reset(struct iwl_trans *trans) 1238 { 1239 if (trans->ops->sw_reset) 1240 trans->ops->sw_reset(trans); 1241 } 1242 1243 static inline void 1244 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value) 1245 { 1246 trans->ops->set_bits_mask(trans, reg, mask, value); 1247 } 1248 1249 #define iwl_trans_grab_nic_access(trans, flags) \ 1250 __cond_lock(nic_access, \ 1251 likely((trans)->ops->grab_nic_access(trans, flags))) 1252 1253 static inline void __releases(nic_access) 1254 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags) 1255 { 1256 trans->ops->release_nic_access(trans, flags); 1257 __release(nic_access); 1258 } 1259 1260 static inline void iwl_trans_fw_error(struct iwl_trans *trans) 1261 { 1262 if (WARN_ON_ONCE(!trans->op_mode)) 1263 return; 1264 1265 /* prevent double restarts due to the same erroneous FW */ 1266 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status)) 1267 iwl_op_mode_nic_error(trans->op_mode); 1268 } 1269 1270 static inline bool iwl_trans_fw_running(struct iwl_trans *trans) 1271 { 1272 return trans->state == IWL_TRANS_FW_ALIVE; 1273 } 1274 1275 static inline void iwl_trans_sync_nmi(struct iwl_trans *trans) 1276 { 1277 if (trans->ops->sync_nmi) 1278 trans->ops->sync_nmi(trans); 1279 } 1280 1281 static inline bool iwl_trans_dbg_ini_valid(struct iwl_trans *trans) 1282 { 1283 return trans->dbg.internal_ini_cfg != IWL_INI_CFG_STATE_NOT_LOADED || 1284 trans->dbg.external_ini_cfg != IWL_INI_CFG_STATE_NOT_LOADED; 1285 } 1286 1287 /***************************************************** 1288 * transport helper functions 1289 *****************************************************/ 1290 struct iwl_trans *iwl_trans_alloc(unsigned int priv_size, 1291 struct device *dev, 1292 const struct iwl_trans_ops *ops); 1293 void iwl_trans_free(struct iwl_trans *trans); 1294 1295 /***************************************************** 1296 * driver (transport) register/unregister functions 1297 ******************************************************/ 1298 int __must_check iwl_pci_register_driver(void); 1299 void iwl_pci_unregister_driver(void); 1300 1301 #endif /* __iwl_trans_h__ */ 1302