2 * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer,
10 * without modification.
11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13 * redistribution must be conditioned upon including a substantially
14 * similar Disclaimer requirement for further binary redistribution.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27 * THE POSSIBILITY OF SUCH DAMAGES.
33 * Ioctl-related defintions for the Atheros Wireless LAN controller driver.
35 #ifndef _DEV_ATH_ATHIOCTL_H
36 #define _DEV_ATH_ATHIOCTL_H
38 struct ath_tx_aggr_stats {
39 u_int32_t aggr_pkts[64];
40 u_int32_t aggr_single_pkt;
41 u_int32_t aggr_nonbaw_pkt;
42 u_int32_t aggr_aggr_pkt;
43 u_int32_t aggr_baw_closed_single_pkt;
44 u_int32_t aggr_low_hwq_single_pkt;
45 u_int32_t aggr_sched_nopkt;
46 u_int32_t aggr_rts_aggr_limited;
49 struct ath_intr_stats {
50 u_int32_t sync_intr[32];
54 u_int32_t ast_watchdog; /* device reset by watchdog */
55 u_int32_t ast_hardware; /* fatal hardware error interrupts */
56 u_int32_t ast_bmiss; /* beacon miss interrupts */
57 u_int32_t ast_bmiss_phantom;/* beacon miss interrupts */
58 u_int32_t ast_bstuck; /* beacon stuck interrupts */
59 u_int32_t ast_rxorn; /* rx overrun interrupts */
60 u_int32_t ast_rxeol; /* rx eol interrupts */
61 u_int32_t ast_txurn; /* tx underrun interrupts */
62 u_int32_t ast_mib; /* mib interrupts */
63 u_int32_t ast_intrcoal; /* interrupts coalesced */
64 u_int32_t ast_tx_packets; /* packet sent on the interface */
65 u_int32_t ast_tx_mgmt; /* management frames transmitted */
66 u_int32_t ast_tx_discard; /* frames discarded prior to assoc */
67 u_int32_t ast_tx_qstop; /* output stopped 'cuz no buffer */
68 u_int32_t ast_tx_encap; /* tx encapsulation failed */
69 u_int32_t ast_tx_nonode; /* tx failed 'cuz no node */
70 u_int32_t ast_tx_nombuf; /* tx failed 'cuz no mbuf */
71 u_int32_t ast_tx_nomcl; /* tx failed 'cuz no cluster */
72 u_int32_t ast_tx_linear; /* tx linearized to cluster */
73 u_int32_t ast_tx_nodata; /* tx discarded empty frame */
74 u_int32_t ast_tx_busdma; /* tx failed for dma resrcs */
75 u_int32_t ast_tx_xretries;/* tx failed 'cuz too many retries */
76 u_int32_t ast_tx_fifoerr; /* tx failed 'cuz FIFO underrun */
77 u_int32_t ast_tx_filtered;/* tx failed 'cuz xmit filtered */
78 u_int32_t ast_tx_shortretry;/* tx on-chip retries (short) */
79 u_int32_t ast_tx_longretry;/* tx on-chip retries (long) */
80 u_int32_t ast_tx_badrate; /* tx failed 'cuz bogus xmit rate */
81 u_int32_t ast_tx_noack; /* tx frames with no ack marked */
82 u_int32_t ast_tx_rts; /* tx frames with rts enabled */
83 u_int32_t ast_tx_cts; /* tx frames with cts enabled */
84 u_int32_t ast_tx_shortpre;/* tx frames with short preamble */
85 u_int32_t ast_tx_altrate; /* tx frames with alternate rate */
86 u_int32_t ast_tx_protect; /* tx frames with protection */
87 u_int32_t ast_tx_ctsburst;/* tx frames with cts and bursting */
88 u_int32_t ast_tx_ctsext; /* tx frames with cts extension */
89 u_int32_t ast_rx_nombuf; /* rx setup failed 'cuz no mbuf */
90 u_int32_t ast_rx_busdma; /* rx setup failed for dma resrcs */
91 u_int32_t ast_rx_orn; /* rx failed 'cuz of desc overrun */
92 u_int32_t ast_rx_crcerr; /* rx failed 'cuz of bad CRC */
93 u_int32_t ast_rx_fifoerr; /* rx failed 'cuz of FIFO overrun */
94 u_int32_t ast_rx_badcrypt;/* rx failed 'cuz decryption */
95 u_int32_t ast_rx_badmic; /* rx failed 'cuz MIC failure */
96 u_int32_t ast_rx_phyerr; /* rx failed 'cuz of PHY err */
97 u_int32_t ast_rx_phy[64]; /* rx PHY error per-code counts */
98 u_int32_t ast_rx_tooshort;/* rx discarded 'cuz frame too short */
99 u_int32_t ast_rx_toobig; /* rx discarded 'cuz frame too large */
100 u_int32_t ast_rx_packets; /* packet recv on the interface */
101 u_int32_t ast_rx_mgt; /* management frames received */
102 u_int32_t ast_rx_ctl; /* rx discarded 'cuz ctl frame */
103 int8_t ast_tx_rssi; /* tx rssi of last ack */
104 int8_t ast_rx_rssi; /* rx rssi from histogram */
105 u_int8_t ast_tx_rate; /* IEEE rate of last unicast tx */
106 u_int32_t ast_be_xmit; /* beacons transmitted */
107 u_int32_t ast_be_nombuf; /* beacon setup failed 'cuz no mbuf */
108 u_int32_t ast_per_cal; /* periodic calibration calls */
109 u_int32_t ast_per_calfail;/* periodic calibration failed */
110 u_int32_t ast_per_rfgain; /* periodic calibration rfgain reset */
111 u_int32_t ast_rate_calls; /* rate control checks */
112 u_int32_t ast_rate_raise; /* rate control raised xmit rate */
113 u_int32_t ast_rate_drop; /* rate control dropped xmit rate */
114 u_int32_t ast_ant_defswitch;/* rx/default antenna switches */
115 u_int32_t ast_ant_txswitch;/* tx antenna switches */
116 u_int32_t ast_ant_rx[8]; /* rx frames with antenna */
117 u_int32_t ast_ant_tx[8]; /* tx frames with antenna */
118 u_int32_t ast_cabq_xmit; /* cabq frames transmitted */
119 u_int32_t ast_cabq_busy; /* cabq found busy */
120 u_int32_t ast_tx_raw; /* tx frames through raw api */
121 u_int32_t ast_ff_txok; /* fast frames tx'd successfully */
122 u_int32_t ast_ff_txerr; /* fast frames tx'd w/ error */
123 u_int32_t ast_ff_rx; /* fast frames rx'd */
124 u_int32_t ast_ff_flush; /* fast frames flushed from staging q */
125 u_int32_t ast_tx_qfull; /* tx dropped 'cuz of queue limit */
126 int8_t ast_rx_noise; /* rx noise floor */
127 u_int32_t ast_tx_nobuf; /* tx dropped 'cuz no ath buffer */
128 u_int32_t ast_tdma_update;/* TDMA slot timing updates */
129 u_int32_t ast_tdma_timers;/* TDMA slot update set beacon timers */
130 u_int32_t ast_tdma_tsf; /* TDMA slot update set TSF */
131 u_int16_t ast_tdma_tsfadjp;/* TDMA slot adjust+ (usec, smoothed)*/
132 u_int16_t ast_tdma_tsfadjm;/* TDMA slot adjust- (usec, smoothed)*/
133 u_int32_t ast_tdma_ack; /* TDMA tx failed 'cuz ACK required */
134 u_int32_t ast_tx_raw_fail;/* raw tx failed 'cuz h/w down */
135 u_int32_t ast_tx_nofrag; /* tx dropped 'cuz no ath frag buffer */
136 u_int32_t ast_be_missed; /* missed beacons */
137 u_int32_t ast_ani_cal; /* ANI calibrations performed */
138 u_int32_t ast_rx_agg; /* number of aggregate frames RX'ed */
139 u_int32_t ast_rx_halfgi; /* RX half-GI */
140 u_int32_t ast_rx_2040; /* RX 40mhz frame */
141 u_int32_t ast_rx_pre_crc_err; /* RX pre-delimiter CRC error */
142 u_int32_t ast_rx_post_crc_err; /* RX post-delimiter CRC error */
143 u_int32_t ast_rx_decrypt_busy_err; /* RX decrypt engine busy error */
144 u_int32_t ast_rx_hi_rx_chain;
145 u_int32_t ast_tx_htprotect; /* HT tx frames with protection */
146 u_int32_t ast_rx_hitqueueend; /* RX hit descr queue end */
147 u_int32_t ast_tx_timeout; /* Global TX timeout */
148 u_int32_t ast_tx_cst; /* Carrier sense timeout */
149 u_int32_t ast_tx_xtxop; /* tx exceeded TXOP */
150 u_int32_t ast_tx_timerexpired; /* tx exceeded TX_TIMER */
151 u_int32_t ast_tx_desccfgerr; /* tx desc cfg error */
152 u_int32_t ast_tx_swretries; /* software TX retries */
153 u_int32_t ast_tx_swretrymax; /* software TX retry max limit reach */
154 u_int32_t ast_tx_data_underrun;
155 u_int32_t ast_tx_delim_underrun;
156 u_int32_t ast_tx_aggr_failall; /* aggregate TX failed in its entirety */
157 u_int32_t ast_tx_getnobuf;
158 u_int32_t ast_tx_getbusybuf;
159 u_int32_t ast_tx_intr;
160 u_int32_t ast_rx_intr;
161 u_int32_t ast_tx_aggr_ok; /* aggregate TX ok */
162 u_int32_t ast_tx_aggr_fail; /* aggregate TX failed */
163 u_int32_t ast_tx_mcastq_overflow; /* multicast queue overflow */
164 u_int32_t ast_rx_keymiss;
165 u_int32_t ast_tx_swfiltered;
166 u_int32_t ast_tx_node_psq_overflow;
167 u_int32_t ast_rx_stbc; /* RX STBC frame */
168 u_int32_t ast_tx_nodeq_overflow; /* node sw queue overflow */
169 u_int32_t ast_tx_ldpc; /* TX LDPC frame */
170 u_int32_t ast_tx_stbc; /* TX STBC frame */
171 u_int32_t ast_pad[10];
174 #define SIOCGATHSTATS _IOWR('i', 137, struct ifreq)
175 #define SIOCZATHSTATS _IOWR('i', 139, struct ifreq)
176 #define SIOCGATHAGSTATS _IOWR('i', 141, struct ifreq)
179 char ad_name[IFNAMSIZ]; /* if name, e.g. "ath0" */
181 #define ATH_DIAG_DYN 0x8000 /* allocate buffer in caller */
182 #define ATH_DIAG_IN 0x4000 /* copy in parameters */
183 #define ATH_DIAG_OUT 0x0000 /* copy out results (always) */
184 #define ATH_DIAG_ID 0x0fff
185 u_int16_t ad_in_size; /* pack to fit, yech */
191 #define SIOCGATHDIAG _IOWR('i', 138, struct ath_diag)
192 #define SIOCGATHPHYERR _IOWR('i', 140, struct ath_diag)
196 * The rate control ioctl has to support multiple potential rate
197 * control classes. For now, instead of trying to support an
198 * abstraction for this in the API, let's just use a TLV
199 * representation for the payload and let userspace sort it out.
201 struct ath_rateioctl_tlv {
203 uint16_t tlv_len; /* length excluding TLV header */
207 * This is purely the six byte MAC address.
209 #define ATH_RATE_TLV_MACADDR 0xaab0
212 * The rate control modules may decide to push a mapping table
213 * of rix -> net80211 ratecode as part of the update.
215 #define ATH_RATE_TLV_RATETABLE_NENTRIES 64
216 struct ath_rateioctl_rt {
219 uint8_t ratecode[ATH_RATE_TLV_RATETABLE_NENTRIES];
221 #define ATH_RATE_TLV_RATETABLE 0xaab1
224 * This is the sample node statistics structure.
225 * More in ath_rate/sample/sample.h.
227 #define ATH_RATE_TLV_SAMPLENODE 0xaab2
229 struct ath_rateioctl {
230 char if_name[IFNAMSIZ]; /* if name */
232 uint8_t macaddr[IEEE80211_ADDR_LEN];
238 #define SIOCGATHNODERATESTATS _IOWR('i', 149, struct ath_rateioctl)
239 #define SIOCGATHRATESTATS _IOWR('i', 150, struct ath_rateioctl)
242 * Radio capture format.
244 #define ATH_RX_RADIOTAP_PRESENT_BASE ( \
245 (1 << IEEE80211_RADIOTAP_TSFT) | \
246 (1 << IEEE80211_RADIOTAP_FLAGS) | \
247 (1 << IEEE80211_RADIOTAP_RATE) | \
248 (1 << IEEE80211_RADIOTAP_ANTENNA) | \
249 (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL) | \
250 (1 << IEEE80211_RADIOTAP_DBM_ANTNOISE) | \
251 (1 << IEEE80211_RADIOTAP_XCHANNEL) | \
254 #ifdef ATH_ENABLE_RADIOTAP_VENDOR_EXT
255 #define ATH_RX_RADIOTAP_PRESENT \
256 (ATH_RX_RADIOTAP_PRESENT_BASE | \
257 (1 << IEEE80211_RADIOTAP_VENDOREXT) | \
258 (1 << IEEE80211_RADIOTAP_EXT) | \
261 #define ATH_RX_RADIOTAP_PRESENT ATH_RX_RADIOTAP_PRESENT_BASE
262 #endif /* ATH_ENABLE_RADIOTAP_PRESENT */
264 #ifdef ATH_ENABLE_RADIOTAP_VENDOR_EXT
266 * This is higher than the vendor bitmap used inside
267 * the Atheros reference codebase.
271 #define ATH_RADIOTAP_VENDOR_HEADER 8
274 * Using four chains makes all the fields in the
275 * per-chain info header be 4-byte aligned.
277 #define ATH_RADIOTAP_MAX_CHAINS 4
280 * AR9380 and later chips are 3x3, which requires
281 * 5 EVM DWORDs in HT40 mode.
283 #define ATH_RADIOTAP_MAX_EVM 5
286 * The vendor radiotap header data needs to be:
288 * + Aligned to a 4 byte address
289 * + .. so all internal fields are 4 bytes aligned;
290 * + .. and no 64 bit fields are allowed.
292 * So padding is required to ensure this is the case.
294 * Note that because of the lack of alignment with the
295 * vendor header (6 bytes), the first field must be
296 * two bytes so it can be accessed by alignment-strict
297 * platform (eg MIPS.)
299 struct ath_radiotap_vendor_hdr { /* 30 bytes */
300 uint8_t vh_version; /* 1 */
301 uint8_t vh_rx_chainmask; /* 1 */
303 /* At this point it should be 4 byte aligned */
304 uint32_t evm[ATH_RADIOTAP_MAX_EVM]; /* 5 * 4 = 20 */
306 uint8_t rssi_ctl[ATH_RADIOTAP_MAX_CHAINS]; /* 4 * 4 = 16 */
307 uint8_t rssi_ext[ATH_RADIOTAP_MAX_CHAINS]; /* 4 * 4 = 16 */
309 uint8_t vh_phyerr_code; /* Phy error code, or 0xff */
310 uint8_t vh_rs_status; /* RX status */
311 uint8_t vh_rssi; /* Raw RSSI */
312 uint8_t vh_flags; /* General flags */
313 #define ATH_VENDOR_PKT_RX 0x01
314 #define ATH_VENDOR_PKT_TX 0x02
315 #define ATH_VENDOR_PKT_RXPHYERR 0x04
316 #define ATH_VENDOR_PKT_ISAGGR 0x08
317 #define ATH_VENDOR_PKT_MOREAGGR 0x10
319 uint8_t vh_rx_hwrate; /* hardware RX ratecode */
320 uint8_t vh_rs_flags; /* RX HAL flags */
321 uint8_t vh_pad[2]; /* pad to DWORD boundary */
323 #endif /* ATH_ENABLE_RADIOTAP_VENDOR_EXT */
325 struct ath_rx_radiotap_header {
326 struct ieee80211_radiotap_header wr_ihdr;
328 #ifdef ATH_ENABLE_RADIOTAP_VENDOR_EXT
329 /* Vendor extension header bitmap */
330 uint32_t wr_ext_bitmap; /* 4 */
333 * This padding is needed because:
334 * + the radiotap header is 8 bytes;
335 * + the extension bitmap is 4 bytes;
336 * + the tsf is 8 bytes, so it must start on an 8 byte
340 #endif /* ATH_ENABLE_RADIOTAP_VENDOR_EXT */
342 /* Normal radiotap fields */
350 u_int32_t wr_chan_flags;
351 u_int16_t wr_chan_freq;
352 u_int8_t wr_chan_ieee;
353 int8_t wr_chan_maxpow;
355 #ifdef ATH_ENABLE_RADIOTAP_VENDOR_EXT
357 * Vendor header section, as required by the
358 * presence of the vendor extension bit and bitmap
361 * XXX This must be aligned to a 4 byte address?
362 * XXX or 8 byte address?
364 struct ieee80211_radiotap_vendor_header wr_vh; /* 6 bytes */
367 * Because of the lack of alignment enforced by the above
368 * header, this vendor section won't be aligned in any
369 * useful way. So, this will include a two-byte version
370 * value which will force the structure to be 4-byte aligned.
372 struct ath_radiotap_vendor_hdr wr_v;
373 #endif /* ATH_ENABLE_RADIOTAP_VENDOR_EXT */
376 #define ATH_TX_RADIOTAP_PRESENT ( \
377 (1 << IEEE80211_RADIOTAP_TSFT) | \
378 (1 << IEEE80211_RADIOTAP_FLAGS) | \
379 (1 << IEEE80211_RADIOTAP_RATE) | \
380 (1 << IEEE80211_RADIOTAP_DBM_TX_POWER) | \
381 (1 << IEEE80211_RADIOTAP_ANTENNA) | \
382 (1 << IEEE80211_RADIOTAP_XCHANNEL) | \
385 struct ath_tx_radiotap_header {
386 struct ieee80211_radiotap_header wt_ihdr;
392 u_int32_t wt_chan_flags;
393 u_int16_t wt_chan_freq;
394 u_int8_t wt_chan_ieee;
395 int8_t wt_chan_maxpow;
402 #define DFS_SET_THRESH 2
403 #define DFS_GET_THRESH 3
404 #define DFS_RADARDETECTS 6
407 * DFS ioctl parameter types
409 #define DFS_PARAM_FIRPWR 1
410 #define DFS_PARAM_RRSSI 2
411 #define DFS_PARAM_HEIGHT 3
412 #define DFS_PARAM_PRSSI 4
413 #define DFS_PARAM_INBAND 5
414 #define DFS_PARAM_NOL 6 /* XXX not used in FreeBSD */
415 #define DFS_PARAM_RELSTEP_EN 7
416 #define DFS_PARAM_RELSTEP 8
417 #define DFS_PARAM_RELPWR_EN 9
418 #define DFS_PARAM_RELPWR 10
419 #define DFS_PARAM_MAXLEN 11
420 #define DFS_PARAM_USEFIR128 12
421 #define DFS_PARAM_BLOCKRADAR 13
422 #define DFS_PARAM_MAXRSSI_EN 14
424 /* FreeBSD-specific start at 32 */
425 #define DFS_PARAM_ENABLE 32
426 #define DFS_PARAM_EN_EXTCH 33
429 * Spectral ioctl parameter types
431 #define SPECTRAL_PARAM_FFT_PERIOD 1
432 #define SPECTRAL_PARAM_SS_PERIOD 2
433 #define SPECTRAL_PARAM_SS_COUNT 3
434 #define SPECTRAL_PARAM_SS_SHORT_RPT 4
435 #define SPECTRAL_PARAM_ENABLED 5
436 #define SPECTRAL_PARAM_ACTIVE 6
439 * Spectral control parameters
441 #define SIOCGATHSPECTRAL _IOWR('i', 151, struct ath_diag)
443 #define SPECTRAL_CONTROL_ENABLE 2
444 #define SPECTRAL_CONTROL_DISABLE 3
445 #define SPECTRAL_CONTROL_START 4
446 #define SPECTRAL_CONTROL_STOP 5
447 #define SPECTRAL_CONTROL_GET_PARAMS 6
448 #define SPECTRAL_CONTROL_SET_PARAMS 7
449 #define SPECTRAL_CONTROL_ENABLE_AT_RESET 8
450 #define SPECTRAL_CONTROL_DISABLE_AT_RESET 9
452 #endif /* _DEV_ATH_ATHIOCTL_H */