if_iwmvar.h revision 1.10
1 /* $NetBSD: if_iwmvar.h,v 1.10 2016/12/18 02:18:29 nonaka 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 (at) 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 (at) 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 (at) 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 uint8_t wt_hwqueue; 133 } __packed; 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 /* 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 void *fw_rawdata; 165 size_t fw_rawsize; 166 int fw_status; 167 168 struct iwm_fw_sects { 169 struct iwm_fw_onesect { 170 void *fws_data; 171 uint32_t fws_len; 172 uint32_t fws_devoff; 173 174 void *fws_alloc; 175 size_t fws_allocsize; 176 } fw_sect[IWM_UCODE_SECT_MAX]; 177 size_t fw_totlen; 178 int fw_count; 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 211 /* max bufs per tfd the driver will use */ 212 #define IWM_MAX_CMD_TBS_PER_TFD 2 213 214 struct iwm_rx_packet; 215 struct iwm_host_cmd { 216 const void *data[IWM_MAX_CMD_TBS_PER_TFD]; 217 struct iwm_rx_packet *resp_pkt; 218 unsigned long _rx_page_addr; 219 uint32_t _rx_page_order; 220 int handler_status; 221 222 uint32_t flags; 223 uint16_t len[IWM_MAX_CMD_TBS_PER_TFD]; 224 uint8_t dataflags[IWM_MAX_CMD_TBS_PER_TFD]; 225 uint32_t id; 226 }; 227 228 /* 229 * DMA glue is from iwn 230 */ 231 232 struct iwm_dma_info { 233 bus_dma_tag_t tag; 234 bus_dmamap_t map; 235 bus_dma_segment_t seg; 236 bus_addr_t paddr; 237 void *vaddr; 238 bus_size_t size; 239 }; 240 241 #define IWM_TX_RING_COUNT 256 242 #define IWM_TX_RING_LOMARK 192 243 #define IWM_TX_RING_HIMARK 224 244 245 struct iwm_tx_data { 246 bus_dmamap_t map; 247 bus_addr_t cmd_paddr; 248 bus_addr_t scratch_paddr; 249 struct mbuf *m; 250 struct iwm_node *in; 251 int done; 252 }; 253 254 struct iwm_tx_ring { 255 struct iwm_dma_info desc_dma; 256 struct iwm_dma_info cmd_dma; 257 struct iwm_tfd *desc; 258 struct iwm_device_cmd *cmd; 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 struct iwm_rx_data { 271 struct mbuf *m; 272 bus_dmamap_t map; 273 }; 274 275 struct iwm_rx_ring { 276 struct iwm_dma_info desc_dma; 277 struct iwm_dma_info stat_dma; 278 struct iwm_dma_info buf_dma; 279 uint32_t *desc; 280 struct iwm_rb_status *stat; 281 struct iwm_rx_data data[IWM_RX_RING_COUNT]; 282 int cur; 283 }; 284 285 #define IWM_FLAG_USE_ICT __BIT(0) 286 #define IWM_FLAG_HW_INITED __BIT(1) 287 #define IWM_FLAG_STOPPED __BIT(2) 288 #define IWM_FLAG_RFKILL __BIT(3) 289 #define IWM_FLAG_SCANNING __BIT(4) 290 #define IWM_FLAG_ATTACHED __BIT(5) 291 #define IWM_FLAG_FW_LOADED __BIT(6) 292 293 struct iwm_ucode_status { 294 uint32_t uc_error_event_table; 295 uint32_t uc_umac_error_event_table; 296 uint32_t uc_log_event_table; 297 298 int uc_ok; 299 int uc_intr; 300 }; 301 302 /* sc_wantresp */ 303 #define IWM_CMD_RESP_IDLE -1 304 305 #define IWM_CMD_RESP_MAX PAGE_SIZE 306 307 /* lower blocks contain EEPROM image and calibration data */ 308 #define IWM_OTP_LOW_IMAGE_SIZE_FAMILY_7000 16384 309 #define IWM_OTP_LOW_IMAGE_SIZE_FAMILY_8000 32768 310 311 #define IWM_TE_SESSION_PROTECTION_MAX_TIME_MS 1000 312 #define IWM_TE_SESSION_PROTECTION_MIN_TIME_MS 400 313 314 enum IWM_CMD_MODE { 315 IWM_CMD_ASYNC = (1 << 0), 316 IWM_CMD_WANT_SKB = (1 << 1), 317 IWM_CMD_SEND_IN_RFKILL = (1 << 2), 318 }; 319 enum iwm_hcmd_dataflag { 320 IWM_HCMD_DFL_NOCOPY = (1 << 0), 321 IWM_HCMD_DFL_DUP = (1 << 1), 322 }; 323 324 #define IWM_NUM_PAPD_CH_GROUPS 9 325 #define IWM_NUM_TXP_CH_GROUPS 9 326 327 struct iwm_phy_db_entry { 328 uint16_t size; 329 uint8_t *data; 330 }; 331 332 struct iwm_phy_db { 333 struct iwm_phy_db_entry cfg; 334 struct iwm_phy_db_entry calib_nch; 335 struct iwm_phy_db_entry calib_ch_group_papd[IWM_NUM_PAPD_CH_GROUPS]; 336 struct iwm_phy_db_entry calib_ch_group_txp[IWM_NUM_TXP_CH_GROUPS]; 337 }; 338 339 struct iwm_phy_ctxt { 340 uint16_t id; 341 uint16_t color; 342 uint32_t ref; 343 struct ieee80211_channel *channel; 344 }; 345 346 struct iwm_bf_data { 347 int bf_enabled; /* filtering */ 348 int ba_enabled; /* abort */ 349 int ave_beacon_signal; 350 int last_cqm_event; 351 }; 352 353 struct iwm_softc { 354 device_t sc_dev; 355 struct ethercom sc_ec; 356 struct ieee80211com sc_ic; 357 358 int (*sc_newstate)(struct ieee80211com *, enum ieee80211_state, int); 359 int sc_newstate_pending; 360 361 struct ieee80211_amrr sc_amrr; 362 struct callout sc_calib_to; 363 struct callout sc_led_blink_to; 364 365 bus_space_tag_t sc_st; 366 bus_space_handle_t sc_sh; 367 pci_intr_handle_t *sc_pihp; 368 369 bus_size_t sc_sz; 370 bus_dma_tag_t sc_dmat; 371 pci_chipset_tag_t sc_pct; 372 pcitag_t sc_pcitag; 373 pcireg_t sc_pciid; 374 const void *sc_ih; 375 376 /* TX scheduler rings. */ 377 struct iwm_dma_info sched_dma; 378 uint32_t sched_base; 379 380 /* TX/RX rings. */ 381 struct iwm_tx_ring txq[IWM_MAX_QUEUES]; 382 struct iwm_rx_ring rxq; 383 int qfullmsk; 384 385 int sc_sf_state; 386 387 /* ICT table. */ 388 struct iwm_dma_info ict_dma; 389 int ict_cur; 390 391 int sc_hw_rev; 392 #define IWM_SILICON_A_STEP 0 393 #define IWM_SILICON_B_STEP 1 394 #define IWM_SILICON_C_STEP 2 395 #define IWM_SILICON_D_STEP 3 396 int sc_hw_id; 397 int sc_device_family; 398 #define IWM_DEVICE_FAMILY_7000 1 399 #define IWM_DEVICE_FAMILY_8000 2 400 401 struct iwm_dma_info kw_dma; 402 struct iwm_dma_info fw_dma; 403 404 int sc_fw_chunk_done; 405 int sc_init_complete; 406 407 struct iwm_ucode_status sc_uc; 408 enum iwm_ucode_type sc_uc_current; 409 char sc_fwver[32]; 410 411 int sc_capaflags; 412 int sc_capa_max_probe_len; 413 int sc_capa_n_scan_channels; 414 uint32_t sc_ucode_api; 415 uint8_t sc_enabled_capa[howmany(IWM_NUM_UCODE_TLV_CAPA, NBBY)]; 416 char sc_fw_mcc[3]; 417 418 int sc_intmask; 419 int sc_flags; 420 421 /* 422 * So why do we need a separate stopped flag and a generation? 423 * the former protects the device from issueing commands when it's 424 * stopped (duh). The latter protects against race from a very 425 * fast stop/unstop cycle where threads waiting for responses do 426 * not have a chance to run in between. Notably: we want to stop 427 * the device from interrupt context when it craps out, so we 428 * don't have the luxury of waiting for quiescense. 429 */ 430 int sc_generation; 431 432 int sc_cap_off; /* PCIe caps */ 433 434 const char *sc_fwname; 435 bus_size_t sc_fwdmasegsz; 436 struct iwm_fw_info sc_fw; 437 int sc_fw_phy_config; 438 struct iwm_tlv_calib_ctrl sc_default_calib[IWM_UCODE_TYPE_MAX]; 439 440 struct iwm_nvm_data sc_nvm; 441 struct iwm_phy_db sc_phy_db; 442 443 struct iwm_bf_data sc_bf; 444 445 int sc_tx_timer; 446 int sc_rx_ba_sessions; 447 448 int sc_scan_last_antenna; 449 450 int sc_fixed_ridx; 451 452 int sc_staid; 453 int sc_nodecolor; 454 455 uint8_t sc_cmd_resp[IWM_CMD_RESP_MAX]; 456 int sc_wantresp; 457 458 struct workqueue *sc_nswq, *sc_eswq; 459 struct work sc_eswk; 460 461 struct iwm_rx_phy_info sc_last_phy_info; 462 int sc_ampdu_ref; 463 464 /* phy contexts. we only use the first one */ 465 struct iwm_phy_ctxt sc_phyctxt[IWM_NUM_PHY_CTX]; 466 467 struct iwm_notif_statistics sc_stats; 468 int sc_noise; 469 470 int host_interrupt_operation_mode; 471 472 struct sysctllog *sc_clog; 473 474 struct bpf_if * sc_drvbpf; 475 476 union { 477 struct iwm_rx_radiotap_header th; 478 uint8_t pad[IEEE80211_RADIOTAP_HDRLEN]; 479 } sc_rxtapu; 480 #define sc_rxtap sc_rxtapu.th 481 int sc_rxtap_len; 482 483 union { 484 struct iwm_tx_radiotap_header th; 485 uint8_t pad[IEEE80211_RADIOTAP_HDRLEN]; 486 } sc_txtapu; 487 #define sc_txtap sc_txtapu.th 488 int sc_txtap_len; 489 }; 490 491 struct iwm_node { 492 struct ieee80211_node in_ni; 493 struct iwm_phy_ctxt *in_phyctxt; 494 495 uint16_t in_id; 496 uint16_t in_color; 497 498 struct iwm_lq_cmd in_lq; 499 struct ieee80211_amrr_node in_amn; 500 }; 501 #define IWM_STATION_ID 0 502 #define IWM_AUX_STA_ID 1 503 504 #define IWM_ICT_SIZE 4096 505 #define IWM_ICT_COUNT (IWM_ICT_SIZE / sizeof (uint32_t)) 506 #define IWM_ICT_PADDR_SHIFT 12 507
Indexes created Fri Sep 26 20:09:58 GMT 2025