1 /* $OpenBSD: if_iwmvar.h,v 1.7 2015/03/02 13:51:10 jsg Exp $ */
5 * Copyright (c) 2014 genua mbh <info@genua.de>
6 * Copyright (c) 2014 Fixup Software Ltd.
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.
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.
22 * Based on BSD-licensed source modules in the Linux iwlwifi driver,
23 * which were used as the reference documentation for this implementation.
25 * Driver version we are currently based off of is
26 * Linux 3.14.3 (tag id a2df521e42b1d9a23f620ac79dbfe8655a8391dd)
28 ***********************************************************************
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.
35 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved.
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.
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.
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,
51 * The full GNU General Public License is included in this distribution
52 * in the file called COPYING.
54 * Contact Information:
55 * Intel Linux Wireless <ilw@linux.intel.com>
56 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
61 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
62 * All rights reserved.
64 * Redistribution and use in source and binary forms, with or without
65 * modification, are permitted provided that the following conditions
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
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.
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.
92 * Copyright (c) 2007-2010 Damien Bergamini <damien.bergamini@free.fr>
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.
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.
107 struct iwm_rx_radiotap_header {
108 struct ieee80211_radiotap_header wr_ihdr;
112 uint16_t wr_chan_freq;
113 uint16_t wr_chan_flags;
114 int8_t wr_dbm_antsignal;
115 int8_t wr_dbm_antnoise;
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))
126 struct iwm_tx_radiotap_header {
127 struct ieee80211_radiotap_header wt_ihdr;
130 uint16_t wt_chan_freq;
131 uint16_t wt_chan_flags;
134 #define IWM_TX_RADIOTAP_PRESENT \
135 ((1 << IEEE80211_RADIOTAP_FLAGS) | \
136 (1 << IEEE80211_RADIOTAP_RATE) | \
137 (1 << IEEE80211_RADIOTAP_CHANNEL))
140 #define IWM_UCODE_SECTION_MAX 16
143 * fw_status is used to determine if we've already parsed the firmware file
145 * In addition to the following, status < 0 ==> -error
147 #define IWM_FW_STATUS_NONE 0
148 #define IWM_FW_STATUS_INPROGRESS 1
149 #define IWM_FW_STATUS_DONE 2
152 * enum iwm_ucode_type
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
161 enum iwm_ucode_type {
165 IWM_UCODE_REGULAR_USNIFFER,
169 struct iwm_ucode_capabilities {
170 uint32_t max_probe_length;
171 uint32_t n_scan_channels;
173 uint8_t enabled_api[howmany(IWM_NUM_UCODE_TLV_API, NBBY)];
174 uint8_t enabled_capa[howmany(IWM_NUM_UCODE_TLV_CAPA, NBBY)];
178 fw_has_api(const struct iwm_ucode_capabilities *capabilities,
181 return isset(capabilities->enabled_api, api);
185 fw_has_capa(const struct iwm_ucode_capabilities *capabilities,
188 return isset(capabilities->enabled_capa, capa);
191 /* one for each uCode image (inst/data, init/runtime/wowlan) */
193 const void *data; /* vmalloc'ed data */
194 uint32_t len; /* size in bytes */
195 uint32_t offset; /* offset in the device */
199 const struct firmware *fw_fp;
202 struct iwm_fw_sects {
203 struct iwm_fw_desc fw_sect[IWM_UCODE_SECTION_MAX];
206 uint32_t paging_mem_size;
207 } fw_sects[IWM_UCODE_TYPE_MAX];
210 uint8_t valid_tx_ant;
211 uint8_t valid_rx_ant;
214 struct iwm_nvm_data {
216 uint8_t hw_addr[IEEE80211_ADDR_LEN];
218 int sku_cap_band_24GHz_enable;
219 int sku_cap_band_52GHz_enable;
220 int sku_cap_11n_enable;
221 int sku_cap_amt_enable;
222 int sku_cap_ipan_enable;
224 uint8_t radio_cfg_type;
225 uint8_t radio_cfg_step;
226 uint8_t radio_cfg_dash;
227 uint8_t radio_cfg_pnum;
228 uint8_t valid_tx_ant, valid_rx_ant;
229 #define IWM_NUM_CHANNELS 39
230 #define IWM_NUM_CHANNELS_8000 51
232 uint16_t nvm_version;
233 uint8_t max_tx_pwr_half_dbm;
235 boolean_t lar_enabled;
236 uint16_t nvm_ch_flags[];
239 /* max bufs per tfd the driver will use */
240 #define IWM_MAX_CMD_TBS_PER_TFD 2
242 struct iwm_rx_packet;
243 struct iwm_host_cmd {
244 const void *data[IWM_MAX_CMD_TBS_PER_TFD];
245 struct iwm_rx_packet *resp_pkt;
246 unsigned long _rx_page_addr;
247 uint32_t _rx_page_order;
252 uint16_t len[IWM_MAX_CMD_TBS_PER_TFD];
253 uint8_t dataflags[IWM_MAX_CMD_TBS_PER_TFD];
257 * DMA glue is from iwn
260 typedef caddr_t iwm_caddr_t;
261 typedef void *iwm_hookarg_t;
263 struct iwm_dma_info {
266 bus_dma_segment_t seg;
273 * struct iwm_fw_paging
274 * @fw_paging_block: dma memory info
275 * @fw_paging_size: page size
277 struct iwm_fw_paging {
278 struct iwm_dma_info fw_paging_block;
279 uint32_t fw_paging_size;
282 #define IWM_TX_RING_COUNT 256
283 #define IWM_TX_RING_LOMARK 192
284 #define IWM_TX_RING_HIMARK 224
288 bus_addr_t cmd_paddr;
289 bus_addr_t scratch_paddr;
296 struct iwm_dma_info desc_dma;
297 struct iwm_dma_info cmd_dma;
298 struct iwm_tfd *desc;
299 struct iwm_device_cmd *cmd;
300 bus_dma_tag_t data_dmat;
301 struct iwm_tx_data data[IWM_TX_RING_COUNT];
307 #define IWM_RX_RING_COUNT 256
308 /* Linux driver optionally uses 8k buffer */
309 #define IWM_RBUF_SIZE 4096
311 #define IWM_MAX_SCATTER 20
319 struct iwm_dma_info desc_dma;
320 struct iwm_dma_info stat_dma;
321 struct iwm_dma_info buf_dma;
323 struct iwm_rb_status *stat;
324 struct iwm_rx_data data[IWM_RX_RING_COUNT];
325 bus_dmamap_t spare_map; /* for iwm_rx_addbuf() */
326 bus_dma_tag_t data_dmat;
330 #define IWM_CMD_RESP_MAX PAGE_SIZE
332 #define IWM_MVM_TE_SESSION_PROTECTION_MAX_TIME_MS 500
333 #define IWM_MVM_TE_SESSION_PROTECTION_MIN_TIME_MS 400
336 * Command headers are in iwl-trans.h, which is full of all
337 * kinds of other junk, so we just replicate the structures here.
338 * First the software bits:
342 IWM_CMD_ASYNC = (1 << 0),
343 IWM_CMD_WANT_SKB = (1 << 1),
344 IWM_CMD_SEND_IN_RFKILL = (1 << 2),
346 enum iwm_hcmd_dataflag {
347 IWM_HCMD_DFL_NOCOPY = (1 << 0),
348 IWM_HCMD_DFL_DUP = (1 << 1),
353 uint32_t tfd_queue_msk;
356 struct iwm_mvm_phy_ctxt {
360 struct ieee80211_channel *channel;
364 int bf_enabled; /* filtering */
365 int ba_enabled; /* abort */
366 int ave_beacon_signal;
371 struct ieee80211vap iv_vap;
374 int (*iv_newstate)(struct ieee80211vap *,
375 enum ieee80211_state, int);
377 struct iwm_mvm_phy_ctxt *phy_ctxt;
384 * QoS data from net80211, need to store this here
385 * as net80211 has a separate callback but we need
386 * to have the data for the MAC context
393 } queue_params[WME_NUM_AC];
395 /* indicates that this interface requires PS to be disabled */
396 boolean_t ps_disabled;
398 #define IWM_VAP(_vap) ((struct iwm_vap *)(_vap))
401 struct ieee80211_node in_ni;
406 struct iwm_lq_cmd in_lq;
408 uint8_t in_ridx[IEEE80211_RATE_MAXSIZE];
410 #define IWM_NODE(_ni) ((struct iwm_node *)(_ni))
412 #define IWM_STATION_ID 0
413 #define IWM_AUX_STA_ID 1
415 #define IWM_DEFAULT_MACID 0
416 #define IWM_DEFAULT_COLOR 0
417 #define IWM_DEFAULT_TSFID 0
419 #define IWM_ICT_SIZE 4096
420 #define IWM_ICT_COUNT (IWM_ICT_SIZE / sizeof (uint32_t))
421 #define IWM_ICT_PADDR_SHIFT 12
432 struct ieee80211com sc_ic;
433 struct ieee80211_ratectl_tx_status sc_txs;
436 #define IWM_FLAG_USE_ICT (1 << 0)
437 #define IWM_FLAG_HW_INITED (1 << 1)
438 #define IWM_FLAG_STOPPED (1 << 2)
439 #define IWM_FLAG_RFKILL (1 << 3)
440 #define IWM_FLAG_BUSY (1 << 4)
441 #define IWM_FLAG_SCANNING (1 << 5)
442 #define IWM_FLAG_SCAN_RUNNING (1 << 6)
444 struct intr_config_hook sc_preinit_hook;
445 struct callout sc_watchdog_to;
446 struct callout sc_led_blink_to;
448 struct task init_task;
450 struct resource *sc_irq;
451 struct resource *sc_mem;
452 bus_space_tag_t sc_st;
453 bus_space_handle_t sc_sh;
455 bus_dma_tag_t sc_dmat;
458 /* TX scheduler rings. */
459 struct iwm_dma_info sched_dma;
460 uint32_t scd_base_addr;
463 struct iwm_tx_ring txq[IWM_MVM_MAX_QUEUES];
464 struct iwm_rx_ring rxq;
470 struct iwm_dma_info ict_dma;
476 struct iwm_dma_info kw_dma;
477 struct iwm_dma_info fw_dma;
479 int sc_fw_chunk_done;
481 enum iwm_ucode_type cur_ucode;
485 struct iwm_ucode_capabilities ucode_capa;
491 * So why do we need a separate stopped flag and a generation?
492 * the former protects the device from issuing commands when it's
493 * stopped (duh). The latter protects against race from a very
494 * fast stop/unstop cycle where threads waiting for responses do
495 * not have a chance to run in between. Notably: we want to stop
496 * the device from interrupt context when it craps out, so we
497 * don't have the luxury of waiting for quiescense.
501 struct iwm_fw_info sc_fw;
502 struct iwm_tlv_calib_ctrl sc_default_calib[IWM_UCODE_TYPE_MAX];
504 const struct iwm_cfg *cfg;
505 struct iwm_nvm_data *nvm_data;
506 struct iwm_phy_db *sc_phy_db;
508 struct iwm_bf_data sc_bf;
512 int sc_scan_last_antenna;
519 uint8_t sc_cmd_resp[IWM_CMD_RESP_MAX];
522 struct task sc_es_task;
524 struct iwm_rx_phy_info sc_last_phy_info;
527 struct iwm_int_sta sc_aux_sta;
529 /* phy contexts. we only use the first one */
530 struct iwm_mvm_phy_ctxt sc_phyctxt[IWM_NUM_PHY_CTX];
532 struct iwm_notif_statistics_v10 sc_stats;
537 struct iwm_rx_radiotap_header sc_rxtap;
538 struct iwm_tx_radiotap_header sc_txtap;
542 struct iwm_notif_wait_data *sc_notif_wait;
544 int cmd_hold_nic_awake;
546 /* Firmware status */
547 uint32_t error_event_table;
548 uint32_t log_event_table;
549 uint32_t umac_error_event_table;
550 int support_umac_log;
553 * Paging parameters - All of the parameters should be set by the
554 * opmode when paging is enabled
556 struct iwm_fw_paging fw_paging_db[IWM_NUM_OF_FW_PAGING_BLOCKS];
557 uint16_t num_of_paging_blk;
558 uint16_t num_of_pages_in_last_blk;
560 boolean_t last_ebs_successful;
562 /* last smart fifo state that was successfully sent to firmware */
563 enum iwm_sf_state sf_state;
565 /* Indicate if device power save is allowed */
566 boolean_t sc_ps_disabled;
569 #define IWM_LOCK_INIT(_sc) \
570 mtx_init(&(_sc)->sc_mtx, device_get_nameunit((_sc)->sc_dev), \
571 MTX_NETWORK_LOCK, MTX_DEF);
572 #define IWM_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
573 #define IWM_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
574 #define IWM_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->sc_mtx)