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