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 - 2014 Intel Mobile Communications GmbH 10 * 11 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of version 2 of the GNU General Public License as 13 * published by the Free Software Foundation. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program; if not, write to the Free Software 22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 23 * USA 24 * 25 * The full GNU General Public License is included in this distribution 26 * in the file called COPYING. 27 * 28 * Contact Information: 29 * Intel Linux Wireless <ilw@linux.intel.com> 30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 31 * 32 * BSD LICENSE 33 * 34 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved. 35 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH 36 * All rights reserved. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 42 * * Redistributions of source code must retain the above copyright 43 * notice, this list of conditions and the following disclaimer. 44 * * Redistributions in binary form must reproduce the above copyright 45 * notice, this list of conditions and the following disclaimer in 46 * the documentation and/or other materials provided with the 47 * distribution. 48 * * Neither the name Intel Corporation nor the names of its 49 * contributors may be used to endorse or promote products derived 50 * from this software without specific prior written permission. 51 * 52 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 53 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 54 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 55 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 56 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 57 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 58 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 59 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 62 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 63 * 64 *****************************************************************************/ 65#ifndef __iwl_trans_h__ 66#define __iwl_trans_h__ 67 68#include <linux/ieee80211.h> 69#include <linux/mm.h> /* for page_address */ 70#include <linux/lockdep.h> 71 72#include "iwl-debug.h" 73#include "iwl-config.h" 74#include "iwl-fw.h" 75#include "iwl-op-mode.h" 76 77/** 78 * DOC: Transport layer - what is it ? 79 * 80 * The tranport layer is the layer that deals with the HW directly. It provides 81 * an abstraction of the underlying HW to the upper layer. The transport layer 82 * doesn't provide any policy, algorithm or anything of this kind, but only 83 * mechanisms to make the HW do something.It is not completely stateless but 84 * close to it. 85 * We will have an implementation for each different supported bus. 86 */ 87 88/** 89 * DOC: Life cycle of the transport layer 90 * 91 * The transport layer has a very precise life cycle. 92 * 93 * 1) A helper function is called during the module initialization and 94 * registers the bus driver's ops with the transport's alloc function. 95 * 2) Bus's probe calls to the transport layer's allocation functions. 96 * Of course this function is bus specific. 97 * 3) This allocation functions will spawn the upper layer which will 98 * register mac80211. 99 * 100 * 4) At some point (i.e. mac80211's start call), the op_mode will call 101 * the following sequence: 102 * start_hw 103 * start_fw 104 * 105 * 5) Then when finished (or reset): 106 * stop_device 107 * 108 * 6) Eventually, the free function will be called. 109 */ 110 111/** 112 * DOC: Host command section 113 * 114 * A host command is a commaned issued by the upper layer to the fw. There are 115 * several versions of fw that have several APIs. The transport layer is 116 * completely agnostic to these differences. 117 * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode), 118 */ 119#define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f) 120#define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8) 121#define SEQ_TO_INDEX(s) ((s) & 0xff) 122#define INDEX_TO_SEQ(i) ((i) & 0xff) 123#define SEQ_RX_FRAME cpu_to_le16(0x8000) 124 125/** 126 * struct iwl_cmd_header 127 * 128 * This header format appears in the beginning of each command sent from the 129 * driver, and each response/notification received from uCode. 130 */ 131struct iwl_cmd_header { 132 u8 cmd; /* Command ID: REPLY_RXON, etc. */ 133 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */ 134 /* 135 * The driver sets up the sequence number to values of its choosing. 136 * uCode does not use this value, but passes it back to the driver 137 * when sending the response to each driver-originated command, so 138 * the driver can match the response to the command. Since the values 139 * don't get used by uCode, the driver may set up an arbitrary format. 140 * 141 * There is one exception: uCode sets bit 15 when it originates 142 * the response/notification, i.e. when the response/notification 143 * is not a direct response to a command sent by the driver. For 144 * example, uCode issues REPLY_RX when it sends a received frame 145 * to the driver; it is not a direct response to any driver command. 146 * 147 * The Linux driver uses the following format: 148 * 149 * 0:7 tfd index - position within TX queue 150 * 8:12 TX queue id 151 * 13:14 reserved 152 * 15 unsolicited RX or uCode-originated notification 153 */ 154 __le16 sequence; 155} __packed; 156 157/* iwl_cmd_header flags value */ 158#define IWL_CMD_FAILED_MSK 0x40 159 160 161#define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */ 162#define FH_RSCSR_FRAME_INVALID 0x55550000 163#define FH_RSCSR_FRAME_ALIGN 0x40 164 165struct iwl_rx_packet { 166 /* 167 * The first 4 bytes of the RX frame header contain both the RX frame 168 * size and some flags. 169 * Bit fields: 170 * 31: flag flush RB request 171 * 30: flag ignore TC (terminal counter) request 172 * 29: flag fast IRQ request 173 * 28-14: Reserved 174 * 13-00: RX frame size 175 */ 176 __le32 len_n_flags; 177 struct iwl_cmd_header hdr; 178 u8 data[]; 179} __packed; 180 181static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt) 182{ 183 return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK; 184} 185 186static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt) 187{ 188 return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr); 189} 190 191/** 192 * enum CMD_MODE - how to send the host commands ? 193 * 194 * @CMD_ASYNC: Return right away and don't wait for the response 195 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of 196 * the response. The caller needs to call iwl_free_resp when done. 197 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the 198 * command queue, but after other high priority commands. valid only 199 * with CMD_ASYNC. 200 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle. 201 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle. 202 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans 203 * (i.e. mark it as non-idle). 204 */ 205enum CMD_MODE { 206 CMD_ASYNC = BIT(0), 207 CMD_WANT_SKB = BIT(1), 208 CMD_SEND_IN_RFKILL = BIT(2), 209 CMD_HIGH_PRIO = BIT(3), 210 CMD_SEND_IN_IDLE = BIT(4), 211 CMD_MAKE_TRANS_IDLE = BIT(5), 212 CMD_WAKE_UP_TRANS = BIT(6), 213}; 214 215#define DEF_CMD_PAYLOAD_SIZE 320 216 217/** 218 * struct iwl_device_cmd 219 * 220 * For allocation of the command and tx queues, this establishes the overall 221 * size of the largest command we send to uCode, except for commands that 222 * aren't fully copied and use other TFD space. 223 */ 224struct iwl_device_cmd { 225 struct iwl_cmd_header hdr; /* uCode API */ 226 u8 payload[DEF_CMD_PAYLOAD_SIZE]; 227} __packed; 228 229#define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd)) 230 231/* 232 * number of transfer buffers (fragments) per transmit frame descriptor; 233 * this is just the driver's idea, the hardware supports 20 234 */ 235#define IWL_MAX_CMD_TBS_PER_TFD 2 236 237/** 238 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command 239 * 240 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's 241 * ring. The transport layer doesn't map the command's buffer to DMA, but 242 * rather copies it to a previously allocated DMA buffer. This flag tells 243 * the transport layer not to copy the command, but to map the existing 244 * buffer (that is passed in) instead. This saves the memcpy and allows 245 * commands that are bigger than the fixed buffer to be submitted. 246 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one. 247 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this 248 * chunk internally and free it again after the command completes. This 249 * can (currently) be used only once per command. 250 * Note that a TFD entry after a DUP one cannot be a normal copied one. 251 */ 252enum iwl_hcmd_dataflag { 253 IWL_HCMD_DFL_NOCOPY = BIT(0), 254 IWL_HCMD_DFL_DUP = BIT(1), 255}; 256 257/** 258 * struct iwl_host_cmd - Host command to the uCode 259 * 260 * @data: array of chunks that composes the data of the host command 261 * @resp_pkt: response packet, if %CMD_WANT_SKB was set 262 * @_rx_page_order: (internally used to free response packet) 263 * @_rx_page_addr: (internally used to free response packet) 264 * @handler_status: return value of the handler of the command 265 * (put in setup_rx_handlers) - valid for SYNC mode only 266 * @flags: can be CMD_* 267 * @len: array of the lengths of the chunks in data 268 * @dataflags: IWL_HCMD_DFL_* 269 * @id: id of the host command 270 */ 271struct iwl_host_cmd { 272 const void *data[IWL_MAX_CMD_TBS_PER_TFD]; 273 struct iwl_rx_packet *resp_pkt; 274 unsigned long _rx_page_addr; 275 u32 _rx_page_order; 276 int handler_status; 277 278 u32 flags; 279 u16 len[IWL_MAX_CMD_TBS_PER_TFD]; 280 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD]; 281 u8 id; 282}; 283 284static inline void iwl_free_resp(struct iwl_host_cmd *cmd) 285{ 286 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order); 287} 288 289struct iwl_rx_cmd_buffer { 290 struct page *_page; 291 int _offset; 292 bool _page_stolen; 293 u32 _rx_page_order; 294 unsigned int truesize; 295}; 296 297static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r) 298{ 299 return (void *)((unsigned long)page_address(r->_page) + r->_offset); 300} 301 302static inline int rxb_offset(struct iwl_rx_cmd_buffer *r) 303{ 304 return r->_offset; 305} 306 307static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r) 308{ 309 r->_page_stolen = true; 310 get_page(r->_page); 311 return r->_page; 312} 313 314static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r) 315{ 316 __free_pages(r->_page, r->_rx_page_order); 317} 318 319#define MAX_NO_RECLAIM_CMDS 6 320 321#define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo)))) 322 323/* 324 * Maximum number of HW queues the transport layer 325 * currently supports 326 */ 327#define IWL_MAX_HW_QUEUES 32 328#define IWL_MAX_TID_COUNT 8 329#define IWL_FRAME_LIMIT 64 330 331/** 332 * enum iwl_wowlan_status - WoWLAN image/device status 333 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume 334 * @IWL_D3_STATUS_RESET: device was reset while suspended 335 */ 336enum iwl_d3_status { 337 IWL_D3_STATUS_ALIVE, 338 IWL_D3_STATUS_RESET, 339}; 340 341/** 342 * enum iwl_trans_status: transport status flags 343 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed 344 * @STATUS_DEVICE_ENABLED: APM is enabled 345 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up) 346 * @STATUS_INT_ENABLED: interrupts are enabled 347 * @STATUS_RFKILL: the HW RFkill switch is in KILL position 348 * @STATUS_FW_ERROR: the fw is in error state 349 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands 350 * are sent 351 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent 352 */ 353enum iwl_trans_status { 354 STATUS_SYNC_HCMD_ACTIVE, 355 STATUS_DEVICE_ENABLED, 356 STATUS_TPOWER_PMI, 357 STATUS_INT_ENABLED, 358 STATUS_RFKILL, 359 STATUS_FW_ERROR, 360 STATUS_TRANS_GOING_IDLE, 361 STATUS_TRANS_IDLE, 362}; 363 364/** 365 * struct iwl_trans_config - transport configuration 366 * 367 * @op_mode: pointer to the upper layer. 368 * @cmd_queue: the index of the command queue. 369 * Must be set before start_fw. 370 * @cmd_fifo: the fifo for host commands 371 * @no_reclaim_cmds: Some devices erroneously don't set the 372 * SEQ_RX_FRAME bit on some notifications, this is the 373 * list of such notifications to filter. Max length is 374 * %MAX_NO_RECLAIM_CMDS. 375 * @n_no_reclaim_cmds: # of commands in list 376 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs, 377 * if unset 4k will be the RX buffer size 378 * @bc_table_dword: set to true if the BC table expects the byte count to be 379 * in DWORD (as opposed to bytes) 380 * @scd_set_active: should the transport configure the SCD for HCMD queue 381 * @queue_watchdog_timeout: time (in ms) after which queues 382 * are considered stuck and will trigger device restart 383 * @command_names: array of command names, must be 256 entries 384 * (one for each command); for debugging only 385 */ 386struct iwl_trans_config { 387 struct iwl_op_mode *op_mode; 388 389 u8 cmd_queue; 390 u8 cmd_fifo; 391 const u8 *no_reclaim_cmds; 392 unsigned int n_no_reclaim_cmds; 393 394 bool rx_buf_size_8k; 395 bool bc_table_dword; 396 bool scd_set_active; 397 unsigned int queue_watchdog_timeout; 398 const char *const *command_names; 399}; 400 401struct iwl_trans_dump_data { 402 u32 len; 403 u8 data[]; 404}; 405 406struct iwl_trans; 407 408struct iwl_trans_txq_scd_cfg { 409 u8 fifo; 410 s8 sta_id; 411 u8 tid; 412 bool aggregate; 413 int frame_limit; 414}; 415 416/** 417 * struct iwl_trans_ops - transport specific operations 418 * 419 * All the handlers MUST be implemented 420 * 421 * @start_hw: starts the HW- from that point on, the HW can send interrupts 422 * May sleep 423 * @op_mode_leave: Turn off the HW RF kill indication if on 424 * May sleep 425 * @start_fw: allocates and inits all the resources for the transport 426 * layer. Also kick a fw image. 427 * May sleep 428 * @fw_alive: called when the fw sends alive notification. If the fw provides 429 * the SCD base address in SRAM, then provide it here, or 0 otherwise. 430 * May sleep 431 * @stop_device: stops the whole device (embedded CPU put to reset) and stops 432 * the HW. From that point on, the HW will be in low power but will still 433 * issue interrupt if the HW RF kill is triggered. This callback must do 434 * the right thing and not crash even if start_hw() was called but not 435 * start_fw(). May sleep 436 * @d3_suspend: put the device into the correct mode for WoWLAN during 437 * suspend. This is optional, if not implemented WoWLAN will not be 438 * supported. This callback may sleep. 439 * @d3_resume: resume the device after WoWLAN, enabling the opmode to 440 * talk to the WoWLAN image to get its status. This is optional, if not 441 * implemented WoWLAN will not be supported. This callback may sleep. 442 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted. 443 * If RFkill is asserted in the middle of a SYNC host command, it must 444 * return -ERFKILL straight away. 445 * May sleep only if CMD_ASYNC is not set 446 * @tx: send an skb 447 * Must be atomic 448 * @reclaim: free packet until ssn. Returns a list of freed packets. 449 * Must be atomic 450 * @txq_enable: setup a queue. To setup an AC queue, use the 451 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before 452 * this one. The op_mode must not configure the HCMD queue. The scheduler 453 * configuration may be %NULL, in which case the hardware will not be 454 * configured. May sleep. 455 * @txq_disable: de-configure a Tx queue to send AMPDUs 456 * Must be atomic 457 * @wait_tx_queue_empty: wait until tx queues are empty. May sleep. 458 * @dbgfs_register: add the dbgfs files under this directory. Files will be 459 * automatically deleted. 460 * @write8: write a u8 to a register at offset ofs from the BAR 461 * @write32: write a u32 to a register at offset ofs from the BAR 462 * @read32: read a u32 register at offset ofs from the BAR 463 * @read_prph: read a DWORD from a periphery register 464 * @write_prph: write a DWORD to a periphery register 465 * @read_mem: read device's SRAM in DWORD 466 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory 467 * will be zeroed. 468 * @configure: configure parameters required by the transport layer from 469 * the op_mode. May be called several times before start_fw, can't be 470 * called after that. 471 * @set_pmi: set the power pmi state 472 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs. 473 * Sleeping is not allowed between grab_nic_access and 474 * release_nic_access. 475 * @release_nic_access: let the NIC go to sleep. The "flags" parameter 476 * must be the same one that was sent before to the grab_nic_access. 477 * @set_bits_mask - set SRAM register according to value and mask. 478 * @ref: grab a reference to the transport/FW layers, disallowing 479 * certain low power states 480 * @unref: release a reference previously taken with @ref. Note that 481 * initially the reference count is 1, making an initial @unref 482 * necessary to allow low power states. 483 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last 484 * TX'ed commands and similar. The buffer will be vfree'd by the caller. 485 * Note that the transport must fill in the proper file headers. 486 */ 487struct iwl_trans_ops { 488 489 int (*start_hw)(struct iwl_trans *iwl_trans); 490 void (*op_mode_leave)(struct iwl_trans *iwl_trans); 491 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw, 492 bool run_in_rfkill); 493 int (*update_sf)(struct iwl_trans *trans, 494 struct iwl_sf_region *st_fwrd_space); 495 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr); 496 void (*stop_device)(struct iwl_trans *trans); 497 498 void (*d3_suspend)(struct iwl_trans *trans, bool test); 499 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status, 500 bool test); 501 502 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd); 503 504 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb, 505 struct iwl_device_cmd *dev_cmd, int queue); 506 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn, 507 struct sk_buff_head *skbs); 508 509 void (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn, 510 const struct iwl_trans_txq_scd_cfg *cfg); 511 void (*txq_disable)(struct iwl_trans *trans, int queue, 512 bool configure_scd); 513 514 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir); 515 int (*wait_tx_queue_empty)(struct iwl_trans *trans, u32 txq_bm); 516 517 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val); 518 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val); 519 u32 (*read32)(struct iwl_trans *trans, u32 ofs); 520 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs); 521 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val); 522 int (*read_mem)(struct iwl_trans *trans, u32 addr, 523 void *buf, int dwords); 524 int (*write_mem)(struct iwl_trans *trans, u32 addr, 525 const void *buf, int dwords); 526 void (*configure)(struct iwl_trans *trans, 527 const struct iwl_trans_config *trans_cfg); 528 void (*set_pmi)(struct iwl_trans *trans, bool state); 529 bool (*grab_nic_access)(struct iwl_trans *trans, bool silent, 530 unsigned long *flags); 531 void (*release_nic_access)(struct iwl_trans *trans, 532 unsigned long *flags); 533 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask, 534 u32 value); 535 void (*ref)(struct iwl_trans *trans); 536 void (*unref)(struct iwl_trans *trans); 537 538#ifdef CONFIG_IWLWIFI_DEBUGFS 539 struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans); 540#endif 541}; 542 543/** 544 * enum iwl_trans_state - state of the transport layer 545 * 546 * @IWL_TRANS_NO_FW: no fw has sent an alive response 547 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response 548 */ 549enum iwl_trans_state { 550 IWL_TRANS_NO_FW = 0, 551 IWL_TRANS_FW_ALIVE = 1, 552}; 553 554/** 555 * struct iwl_trans - transport common data 556 * 557 * @ops - pointer to iwl_trans_ops 558 * @op_mode - pointer to the op_mode 559 * @cfg - pointer to the configuration 560 * @status: a bit-mask of transport status flags 561 * @dev - pointer to struct device * that represents the device 562 * @hw_id: a u32 with the ID of the device / subdevice. 563 * Set during transport allocation. 564 * @hw_id_str: a string with info about HW ID. Set during transport allocation. 565 * @pm_support: set to true in start_hw if link pm is supported 566 * @ltr_enabled: set to true if the LTR is enabled 567 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only. 568 * The user should use iwl_trans_{alloc,free}_tx_cmd. 569 * @dev_cmd_headroom: room needed for the transport's private use before the 570 * device_cmd for Tx - for internal use only 571 * The user should use iwl_trans_{alloc,free}_tx_cmd. 572 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before 573 * starting the firmware, used for tracing 574 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the 575 * start of the 802.11 header in the @rx_mpdu_cmd 576 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI) 577 */ 578struct iwl_trans { 579 const struct iwl_trans_ops *ops; 580 struct iwl_op_mode *op_mode; 581 const struct iwl_cfg *cfg; 582 enum iwl_trans_state state; 583 unsigned long status; 584 585 struct device *dev; 586 u32 hw_rev; 587 u32 hw_id; 588 char hw_id_str[52]; 589 590 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size; 591 592 bool pm_support; 593 bool ltr_enabled; 594 595 /* The following fields are internal only */ 596 struct kmem_cache *dev_cmd_pool; 597 size_t dev_cmd_headroom; 598 char dev_cmd_pool_name[50]; 599 600 struct dentry *dbgfs_dir; 601 602#ifdef CONFIG_LOCKDEP 603 struct lockdep_map sync_cmd_lockdep_map; 604#endif 605 606 u64 dflt_pwr_limit; 607 608 /* pointer to trans specific struct */ 609 /*Ensure that this pointer will always be aligned to sizeof pointer */ 610 char trans_specific[0] __aligned(sizeof(void *)); 611}; 612 613static inline void iwl_trans_configure(struct iwl_trans *trans, 614 const struct iwl_trans_config *trans_cfg) 615{ 616 trans->op_mode = trans_cfg->op_mode; 617 618 trans->ops->configure(trans, trans_cfg); 619} 620 621static inline int iwl_trans_start_hw(struct iwl_trans *trans) 622{ 623 might_sleep(); 624 625 return trans->ops->start_hw(trans); 626} 627 628static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans) 629{ 630 might_sleep(); 631 632 if (trans->ops->op_mode_leave) 633 trans->ops->op_mode_leave(trans); 634 635 trans->op_mode = NULL; 636 637 trans->state = IWL_TRANS_NO_FW; 638} 639 640static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr) 641{ 642 might_sleep(); 643 644 trans->state = IWL_TRANS_FW_ALIVE; 645 646 trans->ops->fw_alive(trans, scd_addr); 647} 648 649static inline int iwl_trans_start_fw(struct iwl_trans *trans, 650 const struct fw_img *fw, 651 bool run_in_rfkill) 652{ 653 might_sleep(); 654 655 WARN_ON_ONCE(!trans->rx_mpdu_cmd); 656 657 clear_bit(STATUS_FW_ERROR, &trans->status); 658 return trans->ops->start_fw(trans, fw, run_in_rfkill); 659} 660 661static inline int iwl_trans_update_sf(struct iwl_trans *trans, 662 struct iwl_sf_region *st_fwrd_space) 663{ 664 might_sleep(); 665 666 if (trans->ops->update_sf) 667 return trans->ops->update_sf(trans, st_fwrd_space); 668 669 return 0; 670} 671 672static inline void iwl_trans_stop_device(struct iwl_trans *trans) 673{ 674 might_sleep(); 675 676 trans->ops->stop_device(trans); 677 678 trans->state = IWL_TRANS_NO_FW; 679} 680 681static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test) 682{ 683 might_sleep(); 684 trans->ops->d3_suspend(trans, test); 685} 686 687static inline int iwl_trans_d3_resume(struct iwl_trans *trans, 688 enum iwl_d3_status *status, 689 bool test) 690{ 691 might_sleep(); 692 return trans->ops->d3_resume(trans, status, test); 693} 694 695static inline void iwl_trans_ref(struct iwl_trans *trans) 696{ 697 if (trans->ops->ref) 698 trans->ops->ref(trans); 699} 700 701static inline void iwl_trans_unref(struct iwl_trans *trans) 702{ 703 if (trans->ops->unref) 704 trans->ops->unref(trans); 705} 706 707#ifdef CONFIG_IWLWIFI_DEBUGFS 708static inline struct iwl_trans_dump_data * 709iwl_trans_dump_data(struct iwl_trans *trans) 710{ 711 if (!trans->ops->dump_data) 712 return NULL; 713 return trans->ops->dump_data(trans); 714} 715#endif 716 717static inline int iwl_trans_send_cmd(struct iwl_trans *trans, 718 struct iwl_host_cmd *cmd) 719{ 720 int ret; 721 722 if (unlikely(!(cmd->flags & CMD_SEND_IN_RFKILL) && 723 test_bit(STATUS_RFKILL, &trans->status))) 724 return -ERFKILL; 725 726 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status))) 727 return -EIO; 728 729 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) { 730 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 731 return -EIO; 732 } 733 734 if (!(cmd->flags & CMD_ASYNC)) 735 lock_map_acquire_read(&trans->sync_cmd_lockdep_map); 736 737 ret = trans->ops->send_cmd(trans, cmd); 738 739 if (!(cmd->flags & CMD_ASYNC)) 740 lock_map_release(&trans->sync_cmd_lockdep_map); 741 742 return ret; 743} 744 745static inline struct iwl_device_cmd * 746iwl_trans_alloc_tx_cmd(struct iwl_trans *trans) 747{ 748 u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC); 749 750 if (unlikely(dev_cmd_ptr == NULL)) 751 return NULL; 752 753 return (struct iwl_device_cmd *) 754 (dev_cmd_ptr + trans->dev_cmd_headroom); 755} 756 757static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans, 758 struct iwl_device_cmd *dev_cmd) 759{ 760 u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom; 761 762 kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr); 763} 764 765static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb, 766 struct iwl_device_cmd *dev_cmd, int queue) 767{ 768 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status))) 769 return -EIO; 770 771 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) 772 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 773 774 return trans->ops->tx(trans, skb, dev_cmd, queue); 775} 776 777static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue, 778 int ssn, struct sk_buff_head *skbs) 779{ 780 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) 781 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 782 783 trans->ops->reclaim(trans, queue, ssn, skbs); 784} 785 786static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue, 787 bool configure_scd) 788{ 789 trans->ops->txq_disable(trans, queue, configure_scd); 790} 791 792static inline void 793iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn, 794 const struct iwl_trans_txq_scd_cfg *cfg) 795{ 796 might_sleep(); 797 798 if (unlikely((trans->state != IWL_TRANS_FW_ALIVE))) 799 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 800 801 trans->ops->txq_enable(trans, queue, ssn, cfg); 802} 803 804static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue, 805 int fifo, int sta_id, int tid, 806 int frame_limit, u16 ssn) 807{ 808 struct iwl_trans_txq_scd_cfg cfg = { 809 .fifo = fifo, 810 .sta_id = sta_id, 811 .tid = tid, 812 .frame_limit = frame_limit, 813 .aggregate = sta_id >= 0, 814 }; 815 816 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg); 817} 818 819static inline void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, 820 int fifo) 821{ 822 struct iwl_trans_txq_scd_cfg cfg = { 823 .fifo = fifo, 824 .sta_id = -1, 825 .tid = IWL_MAX_TID_COUNT, 826 .frame_limit = IWL_FRAME_LIMIT, 827 .aggregate = false, 828 }; 829 830 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg); 831} 832 833static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans, 834 u32 txq_bm) 835{ 836 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) 837 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state); 838 839 return trans->ops->wait_tx_queue_empty(trans, txq_bm); 840} 841 842static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans, 843 struct dentry *dir) 844{ 845 return trans->ops->dbgfs_register(trans, dir); 846} 847 848static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val) 849{ 850 trans->ops->write8(trans, ofs, val); 851} 852 853static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val) 854{ 855 trans->ops->write32(trans, ofs, val); 856} 857 858static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs) 859{ 860 return trans->ops->read32(trans, ofs); 861} 862 863static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs) 864{ 865 return trans->ops->read_prph(trans, ofs); 866} 867 868static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs, 869 u32 val) 870{ 871 return trans->ops->write_prph(trans, ofs, val); 872} 873 874static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr, 875 void *buf, int dwords) 876{ 877 return trans->ops->read_mem(trans, addr, buf, dwords); 878} 879 880#define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \ 881 do { \ 882 if (__builtin_constant_p(bufsize)) \ 883 BUILD_BUG_ON((bufsize) % sizeof(u32)); \ 884 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\ 885 } while (0) 886 887static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr) 888{ 889 u32 value; 890 891 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1))) 892 return 0xa5a5a5a5; 893 894 return value; 895} 896 897static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr, 898 const void *buf, int dwords) 899{ 900 return trans->ops->write_mem(trans, addr, buf, dwords); 901} 902 903static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr, 904 u32 val) 905{ 906 return iwl_trans_write_mem(trans, addr, &val, 1); 907} 908 909static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state) 910{ 911 if (trans->ops->set_pmi) 912 trans->ops->set_pmi(trans, state); 913} 914 915static inline void 916iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value) 917{ 918 trans->ops->set_bits_mask(trans, reg, mask, value); 919} 920 921#define iwl_trans_grab_nic_access(trans, silent, flags) \ 922 __cond_lock(nic_access, \ 923 likely((trans)->ops->grab_nic_access(trans, silent, flags))) 924 925static inline void __releases(nic_access) 926iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags) 927{ 928 trans->ops->release_nic_access(trans, flags); 929 __release(nic_access); 930} 931 932static inline void iwl_trans_fw_error(struct iwl_trans *trans) 933{ 934 if (WARN_ON_ONCE(!trans->op_mode)) 935 return; 936 937 /* prevent double restarts due to the same erroneous FW */ 938 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status)) 939 iwl_op_mode_nic_error(trans->op_mode); 940} 941 942/***************************************************** 943* driver (transport) register/unregister functions 944******************************************************/ 945int __must_check iwl_pci_register_driver(void); 946void iwl_pci_unregister_driver(void); 947 948static inline void trans_lockdep_init(struct iwl_trans *trans) 949{ 950#ifdef CONFIG_LOCKDEP 951 static struct lock_class_key __key; 952 953 lockdep_init_map(&trans->sync_cmd_lockdep_map, "sync_cmd_lockdep_map", 954 &__key, 0); 955#endif 956} 957 958#endif /* __iwl_trans_h__ */ 959