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