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_SECTION_MAX 16 141 142 /* 143 * fw_status is used to determine if we've already parsed the firmware file 144 * 145 * In addition to the following, status < 0 ==> -error 146 */ 147 #define IWM_FW_STATUS_NONE 0 148 #define IWM_FW_STATUS_INPROGRESS 1 149 #define IWM_FW_STATUS_DONE 2 150 151 /** 152 * enum iwm_ucode_type 153 * 154 * The type of ucode. 155 * 156 * @IWM_UCODE_REGULAR: Normal runtime ucode 157 * @IWM_UCODE_INIT: Initial ucode 158 * @IWM_UCODE_WOWLAN: Wake on Wireless enabled ucode 159 * @IWM_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image 160 */ 161 enum iwm_ucode_type { 162 IWM_UCODE_REGULAR, 163 IWM_UCODE_INIT, 164 IWM_UCODE_WOWLAN, 165 IWM_UCODE_REGULAR_USNIFFER, 166 IWM_UCODE_TYPE_MAX 167 }; 168 169 /* one for each uCode image (inst/data, init/runtime/wowlan) */ 170 struct iwm_fw_desc { 171 const void *data; /* vmalloc'ed data */ 172 uint32_t len; /* size in bytes */ 173 uint32_t offset; /* offset in the device */ 174 }; 175 176 struct iwm_fw_info { 177 const struct firmware *fw_fp; 178 int fw_status; 179 180 struct iwm_fw_sects { 181 struct iwm_fw_desc fw_sect[IWM_UCODE_SECTION_MAX]; 182 int fw_count; 183 int is_dual_cpus; 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 192 struct 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 219 struct iwm_rx_packet; 220 struct 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 237 typedef caddr_t iwm_caddr_t; 238 typedef void *iwm_hookarg_t; 239 240 struct 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 /** 250 * struct iwm_fw_paging 251 * @fw_paging_block: dma memory info 252 * @fw_paging_size: page size 253 */ 254 struct iwm_fw_paging { 255 struct iwm_dma_info fw_paging_block; 256 uint32_t fw_paging_size; 257 }; 258 259 #define IWM_TX_RING_COUNT 256 260 #define IWM_TX_RING_LOMARK 192 261 #define IWM_TX_RING_HIMARK 224 262 263 struct iwm_tx_data { 264 bus_dmamap_t map; 265 bus_addr_t cmd_paddr; 266 bus_addr_t scratch_paddr; 267 struct mbuf *m; 268 struct iwm_node *in; 269 int done; 270 }; 271 272 struct iwm_tx_ring { 273 struct iwm_dma_info desc_dma; 274 struct iwm_dma_info cmd_dma; 275 struct iwm_tfd *desc; 276 struct iwm_device_cmd *cmd; 277 bus_dma_tag_t data_dmat; 278 struct iwm_tx_data data[IWM_TX_RING_COUNT]; 279 int qid; 280 int queued; 281 int cur; 282 }; 283 284 #define IWM_RX_RING_COUNT 256 285 #define IWM_RBUF_COUNT (IWM_RX_RING_COUNT + 32) 286 /* Linux driver optionally uses 8k buffer */ 287 #define IWM_RBUF_SIZE 4096 288 289 #define IWM_MAX_SCATTER 20 290 291 struct iwm_rx_data { 292 struct mbuf *m; 293 bus_dmamap_t map; 294 }; 295 296 struct iwm_rx_ring { 297 struct iwm_dma_info desc_dma; 298 struct iwm_dma_info stat_dma; 299 struct iwm_dma_info buf_dma; 300 uint32_t *desc; 301 struct iwm_rb_status *stat; 302 struct iwm_rx_data data[IWM_RX_RING_COUNT]; 303 bus_dmamap_t spare_map; /* for iwm_rx_addbuf() */ 304 bus_dma_tag_t data_dmat; 305 int cur; 306 }; 307 308 #define IWM_CMD_RESP_MAX PAGE_SIZE 309 310 #define IWM_MVM_TE_SESSION_PROTECTION_MAX_TIME_MS 500 311 #define IWM_MVM_TE_SESSION_PROTECTION_MIN_TIME_MS 400 312 313 /* 314 * Command headers are in iwl-trans.h, which is full of all 315 * kinds of other junk, so we just replicate the structures here. 316 * First the software bits: 317 */ 318 enum IWM_CMD_MODE { 319 IWM_CMD_SYNC = 0, 320 IWM_CMD_ASYNC = (1 << 0), 321 IWM_CMD_WANT_SKB = (1 << 1), 322 IWM_CMD_SEND_IN_RFKILL = (1 << 2), 323 }; 324 enum iwm_hcmd_dataflag { 325 IWM_HCMD_DFL_NOCOPY = (1 << 0), 326 IWM_HCMD_DFL_DUP = (1 << 1), 327 }; 328 329 struct iwm_int_sta { 330 uint32_t sta_id; 331 uint32_t tfd_queue_msk; 332 }; 333 334 struct iwm_mvm_phy_ctxt { 335 uint16_t id; 336 uint16_t color; 337 uint32_t ref; 338 struct ieee80211_channel *channel; 339 }; 340 341 struct iwm_bf_data { 342 int bf_enabled; /* filtering */ 343 int ba_enabled; /* abort */ 344 int ave_beacon_signal; 345 int last_cqm_event; 346 }; 347 348 struct iwm_vap { 349 struct ieee80211vap iv_vap; 350 int is_uploaded; 351 352 int (*iv_newstate)(struct ieee80211vap *, 353 enum ieee80211_state, int); 354 }; 355 #define IWM_VAP(_vap) ((struct iwm_vap *)(_vap)) 356 357 struct iwm_node { 358 struct ieee80211_node in_ni; 359 struct iwm_mvm_phy_ctxt *in_phyctxt; 360 361 /* status "bits" */ 362 int in_assoc; 363 364 struct iwm_lq_cmd in_lq; 365 366 uint8_t in_ridx[IEEE80211_RATE_MAXSIZE]; 367 }; 368 #define IWM_NODE(_ni) ((struct iwm_node *)(_ni)) 369 370 #define IWM_STATION_ID 0 371 #define IWM_AUX_STA_ID 1 372 373 #define IWM_DEFAULT_MACID 0 374 #define IWM_DEFAULT_COLOR 0 375 #define IWM_DEFAULT_TSFID 0 376 377 #define IWM_ICT_SIZE 4096 378 #define IWM_ICT_COUNT (IWM_ICT_SIZE / sizeof (uint32_t)) 379 #define IWM_ICT_PADDR_SHIFT 12 380 381 struct iwm_cfg; 382 383 struct iwm_softc { 384 device_t sc_dev; 385 uint32_t sc_debug; 386 int sc_attached; 387 388 struct mtx sc_mtx; 389 struct mbufq sc_snd; 390 struct ieee80211com sc_ic; 391 struct ieee80211_ratectl_tx_status sc_txs; 392 393 int sc_flags; 394 #define IWM_FLAG_USE_ICT (1 << 0) 395 #define IWM_FLAG_HW_INITED (1 << 1) 396 #define IWM_FLAG_STOPPED (1 << 2) 397 #define IWM_FLAG_RFKILL (1 << 3) 398 #define IWM_FLAG_BUSY (1 << 4) 399 #define IWM_FLAG_SCANNING (1 << 5) 400 #define IWM_FLAG_SCAN_RUNNING (1 << 6) 401 402 struct intr_config_hook sc_preinit_hook; 403 struct callout sc_watchdog_to; 404 struct callout sc_led_blink_to; 405 406 struct task init_task; 407 408 struct resource *sc_irq; 409 struct resource *sc_mem; 410 bus_space_tag_t sc_st; 411 bus_space_handle_t sc_sh; 412 bus_size_t sc_sz; 413 bus_dma_tag_t sc_dmat; 414 void *sc_ih; 415 416 /* TX scheduler rings. */ 417 struct iwm_dma_info sched_dma; 418 uint32_t scd_base_addr; 419 420 /* TX/RX rings. */ 421 struct iwm_tx_ring txq[IWM_MVM_MAX_QUEUES]; 422 struct iwm_rx_ring rxq; 423 int qfullmsk; 424 425 int sc_sf_state; 426 427 /* ICT table. */ 428 struct iwm_dma_info ict_dma; 429 int ict_cur; 430 431 int sc_hw_rev; 432 int sc_hw_id; 433 434 struct iwm_dma_info kw_dma; 435 struct iwm_dma_info fw_dma; 436 437 int sc_fw_chunk_done; 438 439 enum iwm_ucode_type cur_ucode; 440 int ucode_loaded; 441 char sc_fwver[32]; 442 443 int sc_capaflags; 444 int sc_capa_max_probe_len; 445 int sc_capa_n_scan_channels; 446 uint32_t sc_ucode_api; 447 uint8_t sc_enabled_capa[howmany(IWM_NUM_UCODE_TLV_CAPA, NBBY)]; 448 char sc_fw_mcc[3]; 449 450 int sc_intmask; 451 452 /* 453 * So why do we need a separate stopped flag and a generation? 454 * the former protects the device from issuing commands when it's 455 * stopped (duh). The latter protects against race from a very 456 * fast stop/unstop cycle where threads waiting for responses do 457 * not have a chance to run in between. Notably: we want to stop 458 * the device from interrupt context when it craps out, so we 459 * don't have the luxury of waiting for quiescense. 460 */ 461 int sc_generation; 462 463 struct iwm_fw_info sc_fw; 464 struct iwm_tlv_calib_ctrl sc_default_calib[IWM_UCODE_TYPE_MAX]; 465 466 const struct iwm_cfg *cfg; 467 struct iwm_nvm_data *nvm_data; 468 struct iwm_phy_db *sc_phy_db; 469 470 struct iwm_bf_data sc_bf; 471 472 int sc_tx_timer; 473 474 int sc_scan_last_antenna; 475 476 int sc_fixed_ridx; 477 478 int sc_staid; 479 int sc_nodecolor; 480 481 uint8_t sc_cmd_resp[IWM_CMD_RESP_MAX]; 482 int sc_wantresp; 483 484 struct task sc_es_task; 485 486 struct iwm_rx_phy_info sc_last_phy_info; 487 int sc_ampdu_ref; 488 489 struct iwm_int_sta sc_aux_sta; 490 491 /* phy contexts. we only use the first one */ 492 struct iwm_mvm_phy_ctxt sc_phyctxt[IWM_NUM_PHY_CTX]; 493 494 struct iwm_notif_statistics sc_stats; 495 int sc_noise; 496 497 caddr_t sc_drvbpf; 498 499 struct iwm_rx_radiotap_header sc_rxtap; 500 struct iwm_tx_radiotap_header sc_txtap; 501 502 int sc_max_rssi; 503 504 struct iwm_notif_wait_data *sc_notif_wait; 505 506 int cmd_hold_nic_awake; 507 508 /* Firmware status */ 509 uint32_t error_event_table; 510 uint32_t log_event_table; 511 uint32_t umac_error_event_table; 512 int support_umac_log; 513 514 /* 515 * Paging parameters - All of the parameters should be set by the 516 * opmode when paging is enabled 517 */ 518 struct iwm_fw_paging fw_paging_db[IWM_NUM_OF_FW_PAGING_BLOCKS]; 519 uint16_t num_of_paging_blk; 520 uint16_t num_of_pages_in_last_blk; 521 }; 522 523 #define IWM_LOCK_INIT(_sc) \ 524 mtx_init(&(_sc)->sc_mtx, device_get_nameunit((_sc)->sc_dev), \ 525 MTX_NETWORK_LOCK, MTX_DEF); 526 #define IWM_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 527 #define IWM_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 528 #define IWM_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->sc_mtx) 529