1 /* $NetBSD: if_iwmvar.h,v 1.20 2020/05/22 20:27:16 thorpej Exp $ */ 2 /* OpenBSD: if_iwmvar.h,v 1.24 2016/09/21 13:53:18 stsp Exp */ 3 4 /* 5 * Copyright (c) 2014 genua mbh <info@genua.de> 6 * Copyright (c) 2014 Fixup Software Ltd. 7 * 8 * Permission to use, copy, modify, and distribute this software for any 9 * purpose with or without fee is hereby granted, provided that the above 10 * copyright notice and this permission notice appear in all copies. 11 * 12 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 13 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 14 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 15 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 16 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 17 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 18 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 19 */ 20 21 /*- 22 * Based on BSD-licensed source modules in the Linux iwlwifi driver, 23 * which were used as the reference documentation for this implementation. 24 * 25 * Driver version we are currently based off of is 26 * Linux 3.14.3 (tag id a2df521e42b1d9a23f620ac79dbfe8655a8391dd) 27 * 28 *********************************************************************** 29 * 30 * This file is provided under a dual BSD/GPLv2 license. When using or 31 * redistributing this file, you may do so under either license. 32 * 33 * GPL LICENSE SUMMARY 34 * 35 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved. 36 * 37 * This program is free software; you can redistribute it and/or modify 38 * it under the terms of version 2 of the GNU General Public License as 39 * published by the Free Software Foundation. 40 * 41 * This program is distributed in the hope that it will be useful, but 42 * WITHOUT ANY WARRANTY; without even the implied warranty of 43 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 44 * General Public License for more details. 45 * 46 * You should have received a copy of the GNU General Public License 47 * along with this program; if not, write to the Free Software 48 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 49 * USA 50 * 51 * The full GNU General Public License is included in this distribution 52 * in the file called COPYING. 53 * 54 * Contact Information: 55 * Intel Linux Wireless <ilw@linux.intel.com> 56 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 57 * 58 * 59 * BSD LICENSE 60 * 61 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved. 62 * All rights reserved. 63 * 64 * Redistribution and use in source and binary forms, with or without 65 * modification, are permitted provided that the following conditions 66 * are met: 67 * 68 * * Redistributions of source code must retain the above copyright 69 * notice, this list of conditions and the following disclaimer. 70 * * Redistributions in binary form must reproduce the above copyright 71 * notice, this list of conditions and the following disclaimer in 72 * the documentation and/or other materials provided with the 73 * distribution. 74 * * Neither the name Intel Corporation nor the names of its 75 * contributors may be used to endorse or promote products derived 76 * from this software without specific prior written permission. 77 * 78 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 79 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 80 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 81 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 82 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 83 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 84 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 85 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 86 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 87 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 88 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 89 */ 90 91 /*- 92 * Copyright (c) 2007-2010 Damien Bergamini <damien.bergamini@free.fr> 93 * 94 * Permission to use, copy, modify, and distribute this software for any 95 * purpose with or without fee is hereby granted, provided that the above 96 * copyright notice and this permission notice appear in all copies. 97 * 98 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 99 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 100 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 101 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 102 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 103 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 104 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 105 */ 106 107 struct iwm_rx_radiotap_header { 108 struct ieee80211_radiotap_header wr_ihdr; 109 uint64_t wr_tsft; 110 uint8_t wr_flags; 111 uint8_t wr_rate; 112 uint16_t wr_chan_freq; 113 uint16_t wr_chan_flags; 114 int8_t wr_dbm_antsignal; 115 int8_t wr_dbm_antnoise; 116 }; 117 118 #define IWM_RX_RADIOTAP_PRESENT \ 119 ((1 << IEEE80211_RADIOTAP_TSFT) | \ 120 (1 << IEEE80211_RADIOTAP_FLAGS) | \ 121 (1 << IEEE80211_RADIOTAP_RATE) | \ 122 (1 << IEEE80211_RADIOTAP_CHANNEL) | \ 123 (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL) | \ 124 (1 << IEEE80211_RADIOTAP_DBM_ANTNOISE)) 125 126 struct iwm_tx_radiotap_header { 127 struct ieee80211_radiotap_header wt_ihdr; 128 uint8_t wt_flags; 129 uint8_t wt_rate; 130 uint16_t wt_chan_freq; 131 uint16_t wt_chan_flags; 132 uint8_t wt_hwqueue; 133 }; 134 135 #define IWM_TX_RADIOTAP_PRESENT \ 136 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 137 (1 << IEEE80211_RADIOTAP_RATE) | \ 138 (1 << IEEE80211_RADIOTAP_CHANNEL)) 139 140 #define IWM_UCODE_SECT_MAX 16 141 #define IWM_FWDMASEGSZ (192*1024) 142 #define IWM_FWDMASEGSZ_8000 (320*1024) 143 144 /* 145 * fw_status is used to determine if we've already parsed the firmware file 146 * 147 * In addition to the following, status < 0 ==> -error 148 */ 149 #define IWM_FW_STATUS_NONE 0 150 #define IWM_FW_STATUS_INPROGRESS 1 151 #define IWM_FW_STATUS_DONE 2 152 153 enum iwm_ucode_type { 154 IWM_UCODE_TYPE_REGULAR, 155 IWM_UCODE_TYPE_INIT, 156 IWM_UCODE_TYPE_WOW, 157 IWM_UCODE_TYPE_REGULAR_USNIFFER, 158 IWM_UCODE_TYPE_MAX 159 }; 160 161 struct iwm_fw_info { 162 void *fw_rawdata; 163 size_t fw_rawsize; 164 int fw_status; 165 166 struct iwm_fw_sects { 167 struct iwm_fw_onesect { 168 void *fws_data; 169 uint32_t fws_len; 170 uint32_t fws_devoff; 171 172 void *fws_alloc; 173 size_t fws_allocsize; 174 } fw_sect[IWM_UCODE_SECT_MAX]; 175 size_t fw_totlen; 176 int fw_count; 177 int is_dual_cpus; 178 uint32_t paging_mem_size; 179 } fw_sects[IWM_UCODE_TYPE_MAX]; 180 }; 181 182 struct iwm_nvm_data { 183 int n_hw_addrs; 184 uint8_t hw_addr[ETHER_ADDR_LEN]; 185 186 uint8_t calib_version; 187 uint16_t calib_voltage; 188 189 uint16_t raw_temperature; 190 uint16_t kelvin_temperature; 191 uint16_t kelvin_voltage; 192 uint16_t xtal_calib[2]; 193 194 int sku_cap_band_24GHz_enable; 195 int sku_cap_band_52GHz_enable; 196 int sku_cap_11n_enable; 197 int sku_cap_amt_enable; 198 int sku_cap_ipan_enable; 199 int sku_cap_mimo_disable; 200 201 uint8_t radio_cfg_type; 202 uint8_t radio_cfg_step; 203 uint8_t radio_cfg_dash; 204 uint8_t radio_cfg_pnum; 205 uint8_t valid_tx_ant, valid_rx_ant; 206 207 uint16_t nvm_version; 208 uint8_t max_tx_pwr_half_dbm; 209 210 bool lar_enabled; 211 }; 212 213 /* max bufs per tfd the driver will use */ 214 #define IWM_MAX_CMD_TBS_PER_TFD 2 215 216 struct iwm_rx_packet; 217 struct iwm_host_cmd { 218 const void *data[IWM_MAX_CMD_TBS_PER_TFD]; 219 struct iwm_rx_packet *resp_pkt; 220 unsigned long _rx_page_addr; 221 uint32_t _rx_page_order; 222 int handler_status; 223 224 uint32_t flags; 225 uint16_t len[IWM_MAX_CMD_TBS_PER_TFD]; 226 uint8_t dataflags[IWM_MAX_CMD_TBS_PER_TFD]; 227 uint32_t id; 228 }; 229 230 /* 231 * DMA glue is from iwn 232 */ 233 234 struct iwm_dma_info { 235 bus_dma_tag_t tag; 236 bus_dmamap_t map; 237 bus_dma_segment_t seg; 238 bus_addr_t paddr; 239 void *vaddr; 240 bus_size_t size; 241 }; 242 243 /** 244 * struct iwm_fw_paging 245 * @fw_paging_block: dma memory info 246 * @fw_paging_size: page size 247 */ 248 struct iwm_fw_paging { 249 struct iwm_dma_info fw_paging_block; 250 uint32_t fw_paging_size; 251 }; 252 253 #define IWM_TX_RING_COUNT 256 254 #define IWM_TX_RING_LOMARK 192 255 #define IWM_TX_RING_HIMARK 224 256 257 struct iwm_tx_data { 258 bus_dmamap_t map; 259 bus_addr_t cmd_paddr; 260 bus_addr_t scratch_paddr; 261 struct mbuf *m; 262 struct iwm_node *in; 263 int done; 264 }; 265 266 struct iwm_tx_ring { 267 struct iwm_dma_info desc_dma; 268 struct iwm_dma_info cmd_dma; 269 struct iwm_tfd *desc; 270 struct iwm_device_cmd *cmd; 271 struct iwm_tx_data data[IWM_TX_RING_COUNT]; 272 int qid; 273 int queued; 274 int cur; 275 }; 276 277 #define IWM_RX_RING_COUNT 256 278 #define IWM_RBUF_COUNT (IWM_RX_RING_COUNT + 32) 279 /* Linux driver optionally uses 8k buffer */ 280 #define IWM_RBUF_SIZE 4096 281 282 struct iwm_rx_data { 283 struct mbuf *m; 284 bus_dmamap_t map; 285 }; 286 287 struct iwm_rx_ring { 288 struct iwm_dma_info desc_dma; 289 struct iwm_dma_info stat_dma; 290 struct iwm_dma_info buf_dma; 291 uint32_t *desc; 292 struct iwm_rb_status *stat; 293 struct iwm_rx_data data[IWM_RX_RING_COUNT]; 294 int cur; 295 }; 296 297 #define IWM_FLAG_USE_ICT __BIT(0) 298 #define IWM_FLAG_HW_INITED __BIT(1) 299 #define IWM_FLAG_STOPPED __BIT(2) 300 #define IWM_FLAG_RFKILL __BIT(3) 301 #define IWM_FLAG_SCANNING __BIT(4) 302 #define IWM_FLAG_ATTACHED __BIT(5) 303 #define IWM_FLAG_FW_LOADED __BIT(6) 304 305 struct iwm_ucode_status { 306 uint32_t uc_error_event_table; 307 uint32_t uc_umac_error_event_table; 308 uint32_t uc_log_event_table; 309 310 int uc_ok; 311 int uc_intr; 312 }; 313 314 /* sc_wantresp */ 315 #define IWM_CMD_RESP_IDLE -1 316 317 #define IWM_CMD_RESP_MAX PAGE_SIZE 318 319 /* lower blocks contain EEPROM image and calibration data */ 320 #define IWM_OTP_LOW_IMAGE_SIZE_FAMILY_7000 16384 321 #define IWM_OTP_LOW_IMAGE_SIZE_FAMILY_8000 32768 322 323 #define IWM_TE_SESSION_PROTECTION_MAX_TIME_MS 1000 324 #define IWM_TE_SESSION_PROTECTION_MIN_TIME_MS 400 325 326 enum IWM_CMD_MODE { 327 IWM_CMD_ASYNC = (1 << 0), 328 IWM_CMD_WANT_SKB = (1 << 1), 329 IWM_CMD_SEND_IN_RFKILL = (1 << 2), 330 }; 331 enum iwm_hcmd_dataflag { 332 IWM_HCMD_DFL_NOCOPY = (1 << 0), 333 IWM_HCMD_DFL_DUP = (1 << 1), 334 }; 335 336 #define IWM_NUM_PAPD_CH_GROUPS 9 337 #define IWM_NUM_TXP_CH_GROUPS 9 338 339 struct iwm_phy_db_entry { 340 uint16_t size; 341 uint8_t *data; 342 }; 343 344 struct iwm_phy_db { 345 struct iwm_phy_db_entry cfg; 346 struct iwm_phy_db_entry calib_nch; 347 struct iwm_phy_db_entry calib_ch_group_papd[IWM_NUM_PAPD_CH_GROUPS]; 348 struct iwm_phy_db_entry calib_ch_group_txp[IWM_NUM_TXP_CH_GROUPS]; 349 }; 350 351 struct iwm_phy_ctxt { 352 uint16_t id; 353 uint16_t color; 354 uint32_t ref; 355 struct ieee80211_channel *channel; 356 }; 357 358 struct iwm_bf_data { 359 int bf_enabled; /* filtering */ 360 int ba_enabled; /* abort */ 361 int ave_beacon_signal; 362 int last_cqm_event; 363 }; 364 365 struct iwm_softc { 366 device_t sc_dev; 367 struct ethercom sc_ec; 368 struct ieee80211com sc_ic; 369 370 int (*sc_newstate)(struct ieee80211com *, enum ieee80211_state, int); 371 372 struct ieee80211_amrr sc_amrr; 373 struct callout sc_calib_to; 374 struct callout sc_led_blink_to; 375 376 bus_space_tag_t sc_st; 377 bus_space_handle_t sc_sh; 378 pci_intr_handle_t *sc_pihp; 379 380 bus_size_t sc_sz; 381 bus_dma_tag_t sc_dmat; 382 pci_chipset_tag_t sc_pct; 383 pcitag_t sc_pcitag; 384 pcireg_t sc_pciid; 385 const void *sc_ih; 386 void *sc_soft_ih; 387 388 /* TX scheduler rings. */ 389 struct iwm_dma_info sched_dma; 390 uint32_t sched_base; 391 392 /* TX/RX rings. */ 393 struct iwm_tx_ring txq[IWM_MAX_QUEUES]; 394 struct iwm_rx_ring rxq; 395 int qfullmsk; 396 397 int sc_sf_state; 398 399 /* ICT table. */ 400 struct iwm_dma_info ict_dma; 401 int ict_cur; 402 403 int sc_hw_rev; 404 #define IWM_SILICON_A_STEP 0 405 #define IWM_SILICON_B_STEP 1 406 #define IWM_SILICON_C_STEP 2 407 #define IWM_SILICON_D_STEP 3 408 int sc_hw_id; 409 int sc_device_family; 410 #define IWM_DEVICE_FAMILY_7000 1 411 #define IWM_DEVICE_FAMILY_8000 2 412 413 struct iwm_dma_info kw_dma; 414 struct iwm_dma_info fw_dma; 415 416 int sc_fw_chunk_done; 417 int sc_init_complete; 418 419 struct iwm_ucode_status sc_uc; 420 enum iwm_ucode_type sc_uc_current; 421 char sc_fwver[32]; 422 423 int sc_capaflags; 424 int sc_capa_max_probe_len; 425 int sc_capa_n_scan_channels; 426 uint8_t sc_ucode_api[howmany(IWM_NUM_UCODE_TLV_API, NBBY)]; 427 uint8_t sc_enabled_capa[howmany(IWM_NUM_UCODE_TLV_CAPA, NBBY)]; 428 char sc_fw_mcc[3]; 429 430 int sc_intmask; 431 int sc_flags; 432 433 /* 434 * So why do we need a separate stopped flag and a generation? 435 * the former protects the device from issueing commands when it's 436 * stopped (duh). The latter protects against race from a very 437 * fast stop/unstop cycle where threads waiting for responses do 438 * not have a chance to run in between. Notably: we want to stop 439 * the device from interrupt context when it craps out, so we 440 * don't have the luxury of waiting for quiescense. 441 */ 442 int sc_generation; 443 444 int sc_cap_off; /* PCIe caps */ 445 446 const char *sc_fwname; 447 bus_size_t sc_fwdmasegsz; 448 struct iwm_fw_info sc_fw; 449 int sc_fw_phy_config; 450 struct iwm_tlv_calib_ctrl sc_default_calib[IWM_UCODE_TYPE_MAX]; 451 452 struct iwm_nvm_data sc_nvm; 453 struct iwm_phy_db sc_phy_db; 454 455 struct iwm_bf_data sc_bf; 456 457 int sc_tx_timer; 458 int sc_rx_ba_sessions; 459 460 int sc_scan_last_antenna; 461 int sc_mgmt_last_antenna; 462 463 int sc_fixed_ridx; 464 465 int sc_staid; 466 int sc_nodecolor; 467 468 uint8_t sc_cmd_resp[IWM_CMD_RESP_MAX]; 469 int sc_wantresp; 470 471 struct workqueue *sc_nswq; 472 473 struct iwm_rx_phy_info sc_last_phy_info; 474 int sc_ampdu_ref; 475 476 /* phy contexts. we only use the first one */ 477 struct iwm_phy_ctxt sc_phyctxt[IWM_NUM_PHY_CTX]; 478 479 struct iwm_notif_statistics sc_stats; 480 int sc_noise; 481 482 int sc_cmd_hold_nic_awake; 483 484 /* device needs host interrupt operation mode set */ 485 int host_interrupt_operation_mode; 486 /* should the MAC access REQ be asserted when a command is in flight. 487 * This is due to a HW bug in 7260, 3160 and 7265. */ 488 int apmg_wake_up_wa; 489 490 /* 491 * Paging parameters - All of the parameters should be set by the 492 * opmode when paging is enabled 493 */ 494 struct iwm_fw_paging fw_paging_db[IWM_NUM_OF_FW_PAGING_BLOCKS]; 495 uint16_t num_of_paging_blk; 496 uint16_t num_of_pages_in_last_blk; 497 498 struct sysctllog *sc_clog; 499 500 struct bpf_if *sc_drvbpf; 501 502 kmutex_t sc_media_mtx; /* XXX */ 503 504 union { 505 struct iwm_rx_radiotap_header th; 506 uint8_t pad[IEEE80211_RADIOTAP_HDRLEN]; 507 } sc_rxtapu; 508 #define sc_rxtap sc_rxtapu.th 509 int sc_rxtap_len; 510 511 union { 512 struct iwm_tx_radiotap_header th; 513 uint8_t pad[IEEE80211_RADIOTAP_HDRLEN]; 514 } sc_txtapu; 515 #define sc_txtap sc_txtapu.th 516 int sc_txtap_len; 517 }; 518 519 struct iwm_node { 520 struct ieee80211_node in_ni; 521 struct iwm_phy_ctxt *in_phyctxt; 522 523 uint16_t in_id; 524 uint16_t in_color; 525 526 struct iwm_lq_cmd in_lq; 527 struct ieee80211_amrr_node in_amn; 528 }; 529 #define IWM_STATION_ID 0 530 #define IWM_AUX_STA_ID 1 531 532 #define IWM_ICT_SIZE 4096 533 #define IWM_ICT_COUNT (IWM_ICT_SIZE / sizeof (uint32_t)) 534 #define IWM_ICT_PADDR_SHIFT 12 535