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