if_iwmvar.h revision 330174
1/* $OpenBSD: if_iwmvar.h,v 1.7 2015/03/02 13:51:10 jsg Exp $ */ 2/* $FreeBSD: stable/11/sys/dev/iwm/if_iwmvar.h 330174 2018-03-01 05:52:27Z eadler $ */ 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 107struct 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} __packed; 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 126struct 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} __packed; 133 134#define IWM_TX_RADIOTAP_PRESENT \ 135 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 136 (1 << IEEE80211_RADIOTAP_RATE) | \ 137 (1 << IEEE80211_RADIOTAP_CHANNEL)) 138 139 140#define IWM_UCODE_SECTION_MAX 16 141#define IWM_FWDMASEGSZ (192*1024) 142#define IWM_FWDMASEGSZ_8000 (320*1024) 143/* sanity check value */ 144#define IWM_FWMAXSIZE (2*1024*1024) 145 146/* 147 * fw_status is used to determine if we've already parsed the firmware file 148 * 149 * In addition to the following, status < 0 ==> -error 150 */ 151#define IWM_FW_STATUS_NONE 0 152#define IWM_FW_STATUS_INPROGRESS 1 153#define IWM_FW_STATUS_DONE 2 154 155/** 156 * enum iwm_ucode_type 157 * 158 * The type of ucode. 159 * 160 * @IWM_UCODE_REGULAR: Normal runtime ucode 161 * @IWM_UCODE_INIT: Initial ucode 162 * @IWM_UCODE_WOWLAN: Wake on Wireless enabled ucode 163 * @IWM_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image 164 */ 165enum iwm_ucode_type { 166 IWM_UCODE_REGULAR, 167 IWM_UCODE_INIT, 168 IWM_UCODE_WOWLAN, 169 IWM_UCODE_REGULAR_USNIFFER, 170 IWM_UCODE_TYPE_MAX 171}; 172 173struct iwm_fw_info { 174 const struct firmware *fw_fp; 175 int fw_status; 176 177 struct iwm_fw_sects { 178 struct iwm_fw_onesect { 179 const void *fws_data; 180 uint32_t fws_len; 181 uint32_t fws_devoff; 182 } fw_sect[IWM_UCODE_SECTION_MAX]; 183 int fw_count; 184 uint32_t paging_mem_size; 185 } fw_sects[IWM_UCODE_TYPE_MAX]; 186 187 uint32_t phy_config; 188 uint8_t valid_tx_ant; 189 uint8_t valid_rx_ant; 190}; 191 192struct iwm_nvm_data { 193 int n_hw_addrs; 194 uint8_t hw_addr[IEEE80211_ADDR_LEN]; 195 196 int sku_cap_band_24GHz_enable; 197 int sku_cap_band_52GHz_enable; 198 int sku_cap_11n_enable; 199 int sku_cap_amt_enable; 200 int sku_cap_ipan_enable; 201 202 uint8_t radio_cfg_type; 203 uint8_t radio_cfg_step; 204 uint8_t radio_cfg_dash; 205 uint8_t radio_cfg_pnum; 206 uint8_t valid_tx_ant, valid_rx_ant; 207#define IWM_NUM_CHANNELS 39 208#define IWM_NUM_CHANNELS_8000 51 209 210 uint16_t nvm_version; 211 uint8_t max_tx_pwr_half_dbm; 212 213 uint16_t nvm_ch_flags[]; 214}; 215 216/* max bufs per tfd the driver will use */ 217#define IWM_MAX_CMD_TBS_PER_TFD 2 218 219struct iwm_rx_packet; 220struct iwm_host_cmd { 221 const void *data[IWM_MAX_CMD_TBS_PER_TFD]; 222 struct iwm_rx_packet *resp_pkt; 223 unsigned long _rx_page_addr; 224 uint32_t _rx_page_order; 225 int handler_status; 226 227 uint32_t flags; 228 uint32_t id; 229 uint16_t len[IWM_MAX_CMD_TBS_PER_TFD]; 230 uint8_t dataflags[IWM_MAX_CMD_TBS_PER_TFD]; 231}; 232 233/* 234 * DMA glue is from iwn 235 */ 236 237typedef caddr_t iwm_caddr_t; 238typedef void *iwm_hookarg_t; 239 240struct iwm_dma_info { 241 bus_dma_tag_t tag; 242 bus_dmamap_t map; 243 bus_dma_segment_t seg; 244 bus_addr_t paddr; 245 void *vaddr; 246 bus_size_t size; 247}; 248 249#define IWM_TX_RING_COUNT 256 250#define IWM_TX_RING_LOMARK 192 251#define IWM_TX_RING_HIMARK 224 252 253struct iwm_tx_data { 254 bus_dmamap_t map; 255 bus_addr_t cmd_paddr; 256 bus_addr_t scratch_paddr; 257 struct mbuf *m; 258 struct iwm_node *in; 259 int done; 260}; 261 262struct iwm_tx_ring { 263 struct iwm_dma_info desc_dma; 264 struct iwm_dma_info cmd_dma; 265 struct iwm_tfd *desc; 266 struct iwm_device_cmd *cmd; 267 bus_dma_tag_t data_dmat; 268 struct iwm_tx_data data[IWM_TX_RING_COUNT]; 269 int qid; 270 int queued; 271 int cur; 272}; 273 274#define IWM_RX_RING_COUNT 256 275#define IWM_RBUF_COUNT (IWM_RX_RING_COUNT + 32) 276/* Linux driver optionally uses 8k buffer */ 277#define IWM_RBUF_SIZE 4096 278 279#define IWM_MAX_SCATTER 20 280 281struct iwm_rx_data { 282 struct mbuf *m; 283 bus_dmamap_t map; 284}; 285 286struct iwm_rx_ring { 287 struct iwm_dma_info desc_dma; 288 struct iwm_dma_info stat_dma; 289 struct iwm_dma_info buf_dma; 290 uint32_t *desc; 291 struct iwm_rb_status *stat; 292 struct iwm_rx_data data[IWM_RX_RING_COUNT]; 293 bus_dmamap_t spare_map; /* for iwm_rx_addbuf() */ 294 bus_dma_tag_t data_dmat; 295 int cur; 296}; 297 298struct iwm_ucode_status { 299 uint32_t uc_error_event_table; 300 uint32_t uc_umac_error_event_table; 301 uint32_t uc_log_event_table; 302 303 int uc_ok; 304 int uc_intr; 305}; 306 307#define IWM_CMD_RESP_MAX PAGE_SIZE 308 309#define IWM_MVM_TE_SESSION_PROTECTION_MAX_TIME_MS 500 310#define IWM_MVM_TE_SESSION_PROTECTION_MIN_TIME_MS 400 311 312/* 313 * Command headers are in iwl-trans.h, which is full of all 314 * kinds of other junk, so we just replicate the structures here. 315 * First the software bits: 316 */ 317enum IWM_CMD_MODE { 318 IWM_CMD_SYNC = 0, 319 IWM_CMD_ASYNC = (1 << 0), 320 IWM_CMD_WANT_SKB = (1 << 1), 321 IWM_CMD_SEND_IN_RFKILL = (1 << 2), 322}; 323enum iwm_hcmd_dataflag { 324 IWM_HCMD_DFL_NOCOPY = (1 << 0), 325 IWM_HCMD_DFL_DUP = (1 << 1), 326}; 327 328struct iwm_int_sta { 329 uint32_t sta_id; 330 uint32_t tfd_queue_msk; 331}; 332 333struct iwm_mvm_phy_ctxt { 334 uint16_t id; 335 uint16_t color; 336 uint32_t ref; 337 struct ieee80211_channel *channel; 338}; 339 340struct iwm_bf_data { 341 int bf_enabled; /* filtering */ 342 int ba_enabled; /* abort */ 343 int ave_beacon_signal; 344 int last_cqm_event; 345}; 346 347struct iwm_vap { 348 struct ieee80211vap iv_vap; 349 int is_uploaded; 350 351 int (*iv_newstate)(struct ieee80211vap *, 352 enum ieee80211_state, int); 353}; 354#define IWM_VAP(_vap) ((struct iwm_vap *)(_vap)) 355 356struct iwm_node { 357 struct ieee80211_node in_ni; 358 struct iwm_mvm_phy_ctxt *in_phyctxt; 359 360 /* status "bits" */ 361 int in_assoc; 362 363 struct iwm_lq_cmd in_lq; 364 365 uint8_t in_ridx[IEEE80211_RATE_MAXSIZE]; 366}; 367#define IWM_NODE(_ni) ((struct iwm_node *)(_ni)) 368 369#define IWM_STATION_ID 0 370#define IWM_AUX_STA_ID 1 371 372#define IWM_DEFAULT_MACID 0 373#define IWM_DEFAULT_COLOR 0 374#define IWM_DEFAULT_TSFID 0 375 376#define IWM_ICT_SIZE 4096 377#define IWM_ICT_COUNT (IWM_ICT_SIZE / sizeof (uint32_t)) 378#define IWM_ICT_PADDR_SHIFT 12 379 380enum iwm_device_family { 381 IWM_DEVICE_FAMILY_UNDEFINED, 382 IWM_DEVICE_FAMILY_7000, 383 IWM_DEVICE_FAMILY_8000, 384}; 385 386/** 387 * struct iwm_cfg 388 * @fw_name: Firmware filename. 389 * @host_interrupt_operation_mode: device needs host interrupt operation 390 * mode set 391 * @nvm_hw_section_num: the ID of the HW NVM section 392 */ 393struct iwm_cfg { 394 const char *fw_name; 395 uint16_t eeprom_size; 396 enum iwm_device_family device_family; 397 int host_interrupt_operation_mode; 398 uint8_t nvm_hw_section_num; 399}; 400 401struct iwm_softc { 402 device_t sc_dev; 403 uint32_t sc_debug; 404 int sc_attached; 405 406 struct mtx sc_mtx; 407 struct mbufq sc_snd; 408 struct ieee80211com sc_ic; 409 410 int sc_flags; 411#define IWM_FLAG_USE_ICT (1 << 0) 412#define IWM_FLAG_HW_INITED (1 << 1) 413#define IWM_FLAG_STOPPED (1 << 2) 414#define IWM_FLAG_RFKILL (1 << 3) 415#define IWM_FLAG_BUSY (1 << 4) 416#define IWM_FLAG_SCANNING (1 << 5) 417#define IWM_FLAG_SCAN_RUNNING (1 << 6) 418 419 struct intr_config_hook sc_preinit_hook; 420 struct callout sc_watchdog_to; 421 struct callout sc_led_blink_to; 422 423 struct task init_task; 424 425 struct resource *sc_irq; 426 struct resource *sc_mem; 427 bus_space_tag_t sc_st; 428 bus_space_handle_t sc_sh; 429 bus_size_t sc_sz; 430 bus_dma_tag_t sc_dmat; 431 void *sc_ih; 432 433 /* TX scheduler rings. */ 434 struct iwm_dma_info sched_dma; 435 uint32_t sched_base; 436 437 /* TX/RX rings. */ 438 struct iwm_tx_ring txq[IWM_MVM_MAX_QUEUES]; 439 struct iwm_rx_ring rxq; 440 int qfullmsk; 441 442 int sc_sf_state; 443 444 /* ICT table. */ 445 struct iwm_dma_info ict_dma; 446 int ict_cur; 447 448 int sc_hw_rev; 449 int sc_hw_id; 450 451 struct iwm_dma_info kw_dma; 452 struct iwm_dma_info fw_dma; 453 454 int sc_fw_chunk_done; 455 456 struct iwm_ucode_status sc_uc; 457 enum iwm_ucode_type sc_uc_current; 458 char sc_fwver[32]; 459 460 int sc_capaflags; 461 int sc_capa_max_probe_len; 462 int sc_capa_n_scan_channels; 463 uint32_t sc_ucode_api; 464 uint8_t sc_enabled_capa[howmany(IWM_NUM_UCODE_TLV_CAPA, NBBY)]; 465 char sc_fw_mcc[3]; 466 467 int sc_intmask; 468 469 /* 470 * So why do we need a separate stopped flag and a generation? 471 * the former protects the device from issuing commands when it's 472 * stopped (duh). The latter protects against race from a very 473 * fast stop/unstop cycle where threads waiting for responses do 474 * not have a chance to run in between. Notably: we want to stop 475 * the device from interrupt context when it craps out, so we 476 * don't have the luxury of waiting for quiescense. 477 */ 478 int sc_generation; 479 480 bus_size_t sc_fwdmasegsz; 481 struct iwm_fw_info sc_fw; 482 struct iwm_tlv_calib_ctrl sc_default_calib[IWM_UCODE_TYPE_MAX]; 483 484 const struct iwm_cfg *cfg; 485 struct iwm_nvm_data *nvm_data; 486 struct iwm_phy_db *sc_phy_db; 487 488 struct iwm_bf_data sc_bf; 489 490 int sc_tx_timer; 491 492 int sc_scan_last_antenna; 493 494 int sc_fixed_ridx; 495 496 int sc_staid; 497 int sc_nodecolor; 498 499 uint8_t sc_cmd_resp[IWM_CMD_RESP_MAX]; 500 int sc_wantresp; 501 502 struct task sc_es_task; 503 504 struct iwm_rx_phy_info sc_last_phy_info; 505 int sc_ampdu_ref; 506 507 struct iwm_int_sta sc_aux_sta; 508 509 /* phy contexts. we only use the first one */ 510 struct iwm_mvm_phy_ctxt sc_phyctxt[IWM_NUM_PHY_CTX]; 511 512 struct iwm_notif_statistics sc_stats; 513 int sc_noise; 514 515 caddr_t sc_drvbpf; 516 517 struct iwm_rx_radiotap_header sc_rxtap; 518 struct iwm_tx_radiotap_header sc_txtap; 519 520 int sc_max_rssi; 521 522 struct iwm_notif_wait_data *sc_notif_wait; 523}; 524 525#define IWM_LOCK_INIT(_sc) \ 526 mtx_init(&(_sc)->sc_mtx, device_get_nameunit((_sc)->sc_dev), \ 527 MTX_NETWORK_LOCK, MTX_DEF); 528#define IWM_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 529#define IWM_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 530#define IWM_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->sc_mtx) 531