1 | /* $NetBSD: if_iwmvar.h,v 1.9 2015/11/06 14:22:17 nonaka Exp $ */ |
2 | /* OpenBSD: if_iwmvar.h,v 1.7 2015/03/02 13:51:10 jsg Exp */ |
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 { |
108 | struct ieee80211_radiotap_header ; |
109 | uint64_t ; |
110 | uint8_t ; |
111 | uint8_t ; |
112 | uint16_t ; |
113 | uint16_t ; |
114 | int8_t ; |
115 | int8_t ; |
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 { |
127 | struct ieee80211_radiotap_header ; |
128 | uint8_t ; |
129 | uint8_t ; |
130 | uint16_t ; |
131 | uint16_t ; |
132 | uint8_t ; |
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 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 | void *fw_rawdata; |
163 | size_t fw_rawsize; |
164 | int fw_status; |
165 | |
166 | struct iwm_fw_sects { |
167 | struct iwm_fw_onesect { |
168 | void *fws_data; |
169 | uint32_t fws_len; |
170 | uint32_t fws_devoff; |
171 | |
172 | void *fws_alloc; |
173 | size_t fws_allocsize; |
174 | } fw_sect[IWM_UCODE_SECT_MAX]; |
175 | size_t fw_totlen; |
176 | int fw_count; |
177 | } fw_sects[IWM_UCODE_TYPE_MAX]; |
178 | }; |
179 | |
180 | struct iwm_nvm_data { |
181 | int n_hw_addrs; |
182 | uint8_t hw_addr[ETHER_ADDR_LEN]; |
183 | |
184 | uint8_t calib_version; |
185 | uint16_t calib_voltage; |
186 | |
187 | uint16_t raw_temperature; |
188 | uint16_t kelvin_temperature; |
189 | uint16_t kelvin_voltage; |
190 | uint16_t xtal_calib[2]; |
191 | |
192 | int sku_cap_band_24GHz_enable; |
193 | int sku_cap_band_52GHz_enable; |
194 | int sku_cap_11n_enable; |
195 | int sku_cap_amt_enable; |
196 | int sku_cap_ipan_enable; |
197 | |
198 | uint8_t radio_cfg_type; |
199 | uint8_t radio_cfg_step; |
200 | uint8_t radio_cfg_dash; |
201 | uint8_t radio_cfg_pnum; |
202 | uint8_t valid_tx_ant, valid_rx_ant; |
203 | |
204 | uint16_t nvm_version; |
205 | uint8_t max_tx_pwr_half_dbm; |
206 | }; |
207 | |
208 | /* max bufs per tfd the driver will use */ |
209 | #define IWM_MAX_CMD_TBS_PER_TFD 2 |
210 | |
211 | struct iwm_rx_packet; |
212 | struct iwm_host_cmd { |
213 | const void *data[IWM_MAX_CMD_TBS_PER_TFD]; |
214 | struct iwm_rx_packet *resp_pkt; |
215 | unsigned long _rx_page_addr; |
216 | uint32_t _rx_page_order; |
217 | int handler_status; |
218 | |
219 | uint32_t flags; |
220 | uint16_t len[IWM_MAX_CMD_TBS_PER_TFD]; |
221 | uint8_t dataflags[IWM_MAX_CMD_TBS_PER_TFD]; |
222 | uint8_t id; |
223 | }; |
224 | |
225 | /* |
226 | * DMA glue is from iwn |
227 | */ |
228 | |
229 | struct iwm_dma_info { |
230 | bus_dma_tag_t tag; |
231 | bus_dmamap_t map; |
232 | bus_dma_segment_t seg; |
233 | bus_addr_t paddr; |
234 | void *vaddr; |
235 | bus_size_t size; |
236 | }; |
237 | |
238 | #define IWM_TX_RING_COUNT 256 |
239 | #define IWM_TX_RING_LOMARK 192 |
240 | #define IWM_TX_RING_HIMARK 224 |
241 | |
242 | struct iwm_tx_data { |
243 | bus_dmamap_t map; |
244 | bus_addr_t cmd_paddr; |
245 | bus_addr_t scratch_paddr; |
246 | struct mbuf *m; |
247 | struct iwm_node *in; |
248 | int done; |
249 | }; |
250 | |
251 | struct iwm_tx_ring { |
252 | struct iwm_dma_info desc_dma; |
253 | struct iwm_dma_info cmd_dma; |
254 | struct iwm_tfd *desc; |
255 | struct iwm_device_cmd *cmd; |
256 | struct iwm_tx_data data[IWM_TX_RING_COUNT]; |
257 | int qid; |
258 | int queued; |
259 | int cur; |
260 | }; |
261 | |
262 | #define IWM_RX_RING_COUNT 256 |
263 | #define IWM_RBUF_COUNT (IWM_RX_RING_COUNT + 32) |
264 | /* Linux driver optionally uses 8k buffer */ |
265 | #define IWM_RBUF_SIZE 4096 |
266 | |
267 | struct iwm_softc; |
268 | struct iwm_rbuf { |
269 | struct iwm_softc *sc; |
270 | void *vaddr; |
271 | bus_addr_t paddr; |
272 | }; |
273 | |
274 | struct iwm_rx_data { |
275 | struct mbuf *m; |
276 | bus_dmamap_t map; |
277 | int wantresp; |
278 | }; |
279 | |
280 | struct iwm_rx_ring { |
281 | struct iwm_dma_info desc_dma; |
282 | struct iwm_dma_info stat_dma; |
283 | struct iwm_dma_info buf_dma; |
284 | uint32_t *desc; |
285 | struct iwm_rb_status *stat; |
286 | struct iwm_rx_data data[IWM_RX_RING_COUNT]; |
287 | int cur; |
288 | }; |
289 | |
290 | #define IWM_FLAG_USE_ICT __BIT(0) |
291 | #define IWM_FLAG_HW_INITED __BIT(1) |
292 | #define IWM_FLAG_STOPPED __BIT(2) |
293 | #define IWM_FLAG_RFKILL __BIT(3) |
294 | #define IWM_FLAG_BUSY __BIT(4) |
295 | #define IWM_FLAG_ATTACHED __BIT(5) |
296 | #define IWM_FLAG_FW_LOADED __BIT(6) |
297 | |
298 | struct iwm_ucode_status { |
299 | uint32_t uc_error_event_table; |
300 | uint32_t uc_log_event_table; |
301 | |
302 | int uc_ok; |
303 | int uc_intr; |
304 | }; |
305 | |
306 | #define IWM_CMD_RESP_MAX PAGE_SIZE |
307 | |
308 | #define IWM_OTP_LOW_IMAGE_SIZE 2048 |
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 | /* |
330 | * iwlwifi/iwl-phy-db |
331 | */ |
332 | |
333 | #define IWM_NUM_PAPD_CH_GROUPS 4 |
334 | #define IWM_NUM_TXP_CH_GROUPS 9 |
335 | |
336 | struct iwm_phy_db_entry { |
337 | uint16_t size; |
338 | uint8_t *data; |
339 | }; |
340 | |
341 | struct iwm_phy_db { |
342 | struct iwm_phy_db_entry cfg; |
343 | struct iwm_phy_db_entry calib_nch; |
344 | struct iwm_phy_db_entry calib_ch_group_papd[IWM_NUM_PAPD_CH_GROUPS]; |
345 | struct iwm_phy_db_entry calib_ch_group_txp[IWM_NUM_TXP_CH_GROUPS]; |
346 | }; |
347 | |
348 | struct iwm_int_sta { |
349 | uint32_t sta_id; |
350 | uint32_t tfd_queue_msk; |
351 | }; |
352 | |
353 | struct iwm_mvm_phy_ctxt { |
354 | uint16_t id; |
355 | uint16_t color; |
356 | uint32_t ref; |
357 | struct ieee80211_channel *channel; |
358 | }; |
359 | |
360 | struct iwm_bf_data { |
361 | int bf_enabled; /* filtering */ |
362 | int ba_enabled; /* abort */ |
363 | int ave_beacon_signal; |
364 | int last_cqm_event; |
365 | }; |
366 | |
367 | struct iwm_softc { |
368 | device_t sc_dev; |
369 | struct ethercom sc_ec; |
370 | struct ieee80211com sc_ic; |
371 | |
372 | int (*sc_newstate)(struct ieee80211com *, enum ieee80211_state, int); |
373 | int sc_newstate_pending; |
374 | |
375 | struct ieee80211_amrr sc_amrr; |
376 | struct callout sc_calib_to; |
377 | |
378 | bus_space_tag_t sc_st; |
379 | bus_space_handle_t sc_sh; |
380 | pci_intr_handle_t *sc_pihp; |
381 | |
382 | bus_size_t sc_sz; |
383 | bus_dma_tag_t sc_dmat; |
384 | pci_chipset_tag_t sc_pct; |
385 | pcitag_t sc_pcitag; |
386 | pcireg_t sc_pciid; |
387 | const void *sc_ih; |
388 | |
389 | /* TX scheduler rings. */ |
390 | struct iwm_dma_info sched_dma; |
391 | uint32_t sched_base; |
392 | |
393 | /* TX/RX rings. */ |
394 | struct iwm_tx_ring txq[IWM_MVM_MAX_QUEUES]; |
395 | struct iwm_rx_ring rxq; |
396 | int qfullmsk; |
397 | |
398 | int sc_sf_state; |
399 | |
400 | /* ICT table. */ |
401 | struct iwm_dma_info ict_dma; |
402 | int ict_cur; |
403 | |
404 | int sc_hw_rev; |
405 | int sc_hw_id; |
406 | |
407 | struct iwm_dma_info kw_dma; |
408 | struct iwm_dma_info fw_dma; |
409 | |
410 | int sc_fw_chunk_done; |
411 | int sc_init_complete; |
412 | |
413 | struct iwm_ucode_status sc_uc; |
414 | enum iwm_ucode_type sc_uc_current; |
415 | int sc_fwver; |
416 | |
417 | int sc_capaflags; |
418 | int sc_capa_max_probe_len; |
419 | |
420 | int sc_intmask; |
421 | int sc_flags; |
422 | |
423 | /* |
424 | * So why do we need a separate stopped flag and a generation? |
425 | * the former protects the device from issueing commands when it's |
426 | * stopped (duh). The latter protects against race from a very |
427 | * fast stop/unstop cycle where threads waiting for responses do |
428 | * not have a chance to run in between. Notably: we want to stop |
429 | * the device from interrupt context when it craps out, so we |
430 | * don't have the luxury of waiting for quiescense. |
431 | */ |
432 | int sc_generation; |
433 | |
434 | int sc_cap_off; /* PCIe caps */ |
435 | |
436 | const char *sc_fwname; |
437 | bus_size_t sc_fwdmasegsz; |
438 | struct iwm_fw_info sc_fw; |
439 | int sc_fw_phy_config; |
440 | struct iwm_tlv_calib_ctrl sc_default_calib[IWM_UCODE_TYPE_MAX]; |
441 | |
442 | struct iwm_nvm_data sc_nvm; |
443 | struct iwm_phy_db sc_phy_db; |
444 | |
445 | struct iwm_bf_data sc_bf; |
446 | |
447 | int sc_tx_timer; |
448 | |
449 | struct iwm_scan_cmd *sc_scan_cmd; |
450 | size_t sc_scan_cmd_len; |
451 | int sc_scan_last_antenna; |
452 | int sc_scanband; |
453 | |
454 | int sc_auth_prot; |
455 | |
456 | int sc_fixed_ridx; |
457 | |
458 | int sc_staid; |
459 | int sc_nodecolor; |
460 | |
461 | uint8_t sc_cmd_resp[IWM_CMD_RESP_MAX]; |
462 | int sc_wantresp; |
463 | |
464 | struct workqueue *sc_nswq, *sc_eswq; |
465 | struct work sc_eswk; |
466 | |
467 | struct iwm_rx_phy_info sc_last_phy_info; |
468 | int sc_ampdu_ref; |
469 | |
470 | struct iwm_int_sta sc_aux_sta; |
471 | |
472 | /* phy contexts. we only use the first one */ |
473 | struct iwm_mvm_phy_ctxt sc_phyctxt[IWM_NUM_PHY_CTX]; |
474 | |
475 | struct iwm_notif_statistics sc_stats; |
476 | int sc_noise; |
477 | |
478 | int host_interrupt_operation_mode; |
479 | |
480 | struct sysctllog *sc_clog; |
481 | |
482 | struct bpf_if * sc_drvbpf; |
483 | |
484 | union { |
485 | struct iwm_rx_radiotap_header th; |
486 | uint8_t pad[IEEE80211_RADIOTAP_HDRLEN]; |
487 | } sc_rxtapu; |
488 | #define sc_rxtap sc_rxtapu.th |
489 | int sc_rxtap_len; |
490 | |
491 | union { |
492 | struct iwm_tx_radiotap_header th; |
493 | uint8_t pad[IEEE80211_RADIOTAP_HDRLEN]; |
494 | } sc_txtapu; |
495 | #define sc_txtap sc_txtapu.th |
496 | int sc_txtap_len; |
497 | }; |
498 | |
499 | struct iwm_node { |
500 | struct ieee80211_node in_ni; |
501 | struct iwm_mvm_phy_ctxt *in_phyctxt; |
502 | |
503 | uint16_t in_id; |
504 | uint16_t in_color; |
505 | int in_tsfid; |
506 | |
507 | /* status "bits" */ |
508 | int in_assoc; |
509 | |
510 | struct iwm_lq_cmd in_lq; |
511 | struct ieee80211_amrr_node in_amn; |
512 | |
513 | uint8_t in_ridx[IEEE80211_RATE_MAXSIZE]; |
514 | }; |
515 | #define IWM_STATION_ID 0 |
516 | |
517 | #define IWM_ICT_SIZE 4096 |
518 | #define IWM_ICT_COUNT (IWM_ICT_SIZE / sizeof (uint32_t)) |
519 | #define IWM_ICT_PADDR_SHIFT 12 |
520 | |