1 /* 2 * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting 3 * Copyright (c) 2002-2008 Atheros Communications, Inc. 4 * 5 * Permission to use, copy, modify, and/or distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 * 17 * $FreeBSD$ 18 */ 19 20 #ifndef _ATH_AH_H_ 21 #define _ATH_AH_H_ 22 /* 23 * Atheros Hardware Access Layer 24 * 25 * Clients of the HAL call ath_hal_attach to obtain a reference to an ath_hal 26 * structure for use with the device. Hardware-related operations that 27 * follow must call back into the HAL through interface, supplying the 28 * reference as the first parameter. 29 */ 30 31 #include "ah_osdep.h" 32 33 /* 34 * The maximum number of TX/RX chains supported. 35 * This is intended to be used by various statistics gathering operations 36 * (NF, RSSI, EVM). 37 */ 38 #define AH_MAX_CHAINS 3 39 #define AH_MIMO_MAX_EVM_PILOTS 6 40 41 /* 42 * __ahdecl is analogous to _cdecl; it defines the calling 43 * convention used within the HAL. For most systems this 44 * can just default to be empty and the compiler will (should) 45 * use _cdecl. For systems where _cdecl is not compatible this 46 * must be defined. See linux/ah_osdep.h for an example. 47 */ 48 #ifndef __ahdecl 49 #define __ahdecl 50 #endif 51 52 /* 53 * Status codes that may be returned by the HAL. Note that 54 * interfaces that return a status code set it only when an 55 * error occurs--i.e. you cannot check it for success. 56 */ 57 typedef enum { 58 HAL_OK = 0, /* No error */ 59 HAL_ENXIO = 1, /* No hardware present */ 60 HAL_ENOMEM = 2, /* Memory allocation failed */ 61 HAL_EIO = 3, /* Hardware didn't respond as expected */ 62 HAL_EEMAGIC = 4, /* EEPROM magic number invalid */ 63 HAL_EEVERSION = 5, /* EEPROM version invalid */ 64 HAL_EELOCKED = 6, /* EEPROM unreadable */ 65 HAL_EEBADSUM = 7, /* EEPROM checksum invalid */ 66 HAL_EEREAD = 8, /* EEPROM read problem */ 67 HAL_EEBADMAC = 9, /* EEPROM mac address invalid */ 68 HAL_EESIZE = 10, /* EEPROM size not supported */ 69 HAL_EEWRITE = 11, /* Attempt to change write-locked EEPROM */ 70 HAL_EINVAL = 12, /* Invalid parameter to function */ 71 HAL_ENOTSUPP = 13, /* Hardware revision not supported */ 72 HAL_ESELFTEST = 14, /* Hardware self-test failed */ 73 HAL_EINPROGRESS = 15, /* Operation incomplete */ 74 HAL_EEBADREG = 16, /* EEPROM invalid regulatory contents */ 75 HAL_EEBADCC = 17, /* EEPROM invalid country code */ 76 HAL_INV_PMODE = 18, /* Couldn't bring out of sleep state */ 77 } HAL_STATUS; 78 79 typedef enum { 80 AH_FALSE = 0, /* NB: lots of code assumes false is zero */ 81 AH_TRUE = 1, 82 } HAL_BOOL; 83 84 typedef enum { 85 HAL_CAP_REG_DMN = 0, /* current regulatory domain */ 86 HAL_CAP_CIPHER = 1, /* hardware supports cipher */ 87 HAL_CAP_TKIP_MIC = 2, /* handle TKIP MIC in hardware */ 88 HAL_CAP_TKIP_SPLIT = 3, /* hardware TKIP uses split keys */ 89 HAL_CAP_PHYCOUNTERS = 4, /* hardware PHY error counters */ 90 HAL_CAP_DIVERSITY = 5, /* hardware supports fast diversity */ 91 HAL_CAP_KEYCACHE_SIZE = 6, /* number of entries in key cache */ 92 HAL_CAP_NUM_TXQUEUES = 7, /* number of hardware xmit queues */ 93 HAL_CAP_VEOL = 9, /* hardware supports virtual EOL */ 94 HAL_CAP_PSPOLL = 10, /* hardware has working PS-Poll support */ 95 HAL_CAP_DIAG = 11, /* hardware diagnostic support */ 96 HAL_CAP_COMPRESSION = 12, /* hardware supports compression */ 97 HAL_CAP_BURST = 13, /* hardware supports packet bursting */ 98 HAL_CAP_FASTFRAME = 14, /* hardware supoprts fast frames */ 99 HAL_CAP_TXPOW = 15, /* global tx power limit */ 100 HAL_CAP_TPC = 16, /* per-packet tx power control */ 101 HAL_CAP_PHYDIAG = 17, /* hardware phy error diagnostic */ 102 HAL_CAP_BSSIDMASK = 18, /* hardware supports bssid mask */ 103 HAL_CAP_MCAST_KEYSRCH = 19, /* hardware has multicast key search */ 104 HAL_CAP_TSF_ADJUST = 20, /* hardware has beacon tsf adjust */ 105 /* 21 was HAL_CAP_XR */ 106 HAL_CAP_WME_TKIPMIC = 22, /* hardware can support TKIP MIC when WMM is turned on */ 107 /* 23 was HAL_CAP_CHAN_HALFRATE */ 108 /* 24 was HAL_CAP_CHAN_QUARTERRATE */ 109 HAL_CAP_RFSILENT = 25, /* hardware has rfsilent support */ 110 HAL_CAP_TPC_ACK = 26, /* ack txpower with per-packet tpc */ 111 HAL_CAP_TPC_CTS = 27, /* cts txpower with per-packet tpc */ 112 HAL_CAP_11D = 28, /* 11d beacon support for changing cc */ 113 HAL_CAP_PCIE_PS = 29, 114 HAL_CAP_HT = 30, /* hardware can support HT */ 115 HAL_CAP_GTXTO = 31, /* hardware supports global tx timeout */ 116 HAL_CAP_FAST_CC = 32, /* hardware supports fast channel change */ 117 HAL_CAP_TX_CHAINMASK = 33, /* mask of TX chains supported */ 118 HAL_CAP_RX_CHAINMASK = 34, /* mask of RX chains supported */ 119 HAL_CAP_NUM_GPIO_PINS = 36, /* number of GPIO pins */ 120 121 HAL_CAP_CST = 38, /* hardware supports carrier sense timeout */ 122 123 HAL_CAP_RIFS_RX = 39, 124 HAL_CAP_RIFS_TX = 40, 125 HAL_CAP_FORCE_PPM = 41, 126 HAL_CAP_RTS_AGGR_LIMIT = 42, /* aggregation limit with RTS */ 127 HAL_CAP_4ADDR_AGGR = 43, /* hardware is capable of 4addr aggregation */ 128 HAL_CAP_DFS_DMN = 44, /* current DFS domain */ 129 HAL_CAP_EXT_CHAN_DFS = 45, /* DFS support for extension channel */ 130 HAL_CAP_COMBINED_RADAR_RSSI = 46, /* Is combined RSSI for radar accurate */ 131 132 HAL_CAP_AUTO_SLEEP = 48, /* hardware can go to network sleep 133 automatically after waking up to receive TIM */ 134 HAL_CAP_MBSSID_AGGR_SUPPORT = 49, /* Support for mBSSID Aggregation */ 135 HAL_CAP_SPLIT_4KB_TRANS = 50, /* hardware supports descriptors straddling a 4k page boundary */ 136 HAL_CAP_REG_FLAG = 51, /* Regulatory domain flags */ 137 HAL_CAP_BB_RIFS_HANG = 52, 138 HAL_CAP_RIFS_RX_ENABLED = 53, 139 HAL_CAP_BB_DFS_HANG = 54, 140 141 HAL_CAP_BT_COEX = 60, /* hardware is capable of bluetooth coexistence */ 142 HAL_CAP_DYNAMIC_SMPS = 61, /* Dynamic MIMO Power Save hardware support */ 143 144 HAL_CAP_DS = 67, /* 2 stream */ 145 HAL_CAP_BB_RX_CLEAR_STUCK_HANG = 68, 146 HAL_CAP_MAC_HANG = 69, /* can MAC hang */ 147 HAL_CAP_MFP = 70, /* Management Frame Protection in hardware */ 148 149 HAL_CAP_TS = 72, /* 3 stream */ 150 151 HAL_CAP_ENHANCED_DMA_SUPPORT = 75, /* DMA FIFO support */ 152 HAL_CAP_NUM_TXMAPS = 76, /* Number of buffers in a transmit descriptor */ 153 HAL_CAP_TXDESCLEN = 77, /* Length of transmit descriptor */ 154 HAL_CAP_TXSTATUSLEN = 78, /* Length of transmit status descriptor */ 155 HAL_CAP_RXSTATUSLEN = 79, /* Length of transmit status descriptor */ 156 HAL_CAP_RXFIFODEPTH = 80, /* Receive hardware FIFO depth */ 157 HAL_CAP_RXBUFSIZE = 81, /* Receive Buffer Length */ 158 HAL_CAP_NUM_MR_RETRIES = 82, /* limit on multirate retries */ 159 160 HAL_CAP_OL_PWRCTRL = 84, /* Open loop TX power control */ 161 162 HAL_CAP_BB_PANIC_WATCHDOG = 92, 163 164 HAL_CAP_HT20_SGI = 96, /* hardware supports HT20 short GI */ 165 166 HAL_CAP_LDPC = 99, 167 168 HAL_CAP_RXTSTAMP_PREC = 100, /* rx desc tstamp precision (bits) */ 169 170 HAL_CAP_PHYRESTART_CLR_WAR = 106, /* in some cases, clear phy restart to fix bb hang */ 171 HAL_CAP_ENTERPRISE_MODE = 107, /* Enterprise mode features */ 172 HAL_CAP_LDPCWAR = 108, 173 HAL_CAP_CHANNEL_SWITCH_TIME_USEC = 109, /* Channel change time, usec */ 174 HAL_CAP_ENABLE_APM = 110, /* APM enabled */ 175 HAL_CAP_PCIE_LCR_EXTSYNC_EN = 111, 176 HAL_CAP_PCIE_LCR_OFFSET = 112, 177 178 HAL_CAP_ENHANCED_DFS_SUPPORT = 117, /* hardware supports enhanced DFS */ 179 HAL_CAP_MCI = 118, 180 HAL_CAP_SMARTANTENNA = 119, 181 HAL_CAP_TRAFFIC_FAST_RECOVER = 120, 182 HAL_CAP_TX_DIVERSITY = 121, 183 HAL_CAP_CRDC = 122, 184 185 /* The following are private to the FreeBSD HAL (224 onward) */ 186 187 HAL_CAP_INTMIT = 229, /* interference mitigation */ 188 HAL_CAP_RXORN_FATAL = 230, /* HAL_INT_RXORN treated as fatal */ 189 HAL_CAP_BB_HANG = 235, /* can baseband hang */ 190 HAL_CAP_INTRMASK = 237, /* bitmask of supported interrupts */ 191 HAL_CAP_BSSIDMATCH = 238, /* hardware has disable bssid match */ 192 HAL_CAP_STREAMS = 239, /* how many 802.11n spatial streams are available */ 193 HAL_CAP_RXDESC_SELFLINK = 242, /* support a self-linked tail RX descriptor */ 194 HAL_CAP_LONG_RXDESC_TSF = 243, /* hardware supports 32bit TSF in RX descriptor */ 195 HAL_CAP_BB_READ_WAR = 244, /* baseband read WAR */ 196 HAL_CAP_SERIALISE_WAR = 245, /* serialise register access on PCI */ 197 } HAL_CAPABILITY_TYPE; 198 199 /* 200 * "States" for setting the LED. These correspond to 201 * the possible 802.11 operational states and there may 202 * be a many-to-one mapping between these states and the 203 * actual hardware state for the LED's (i.e. the hardware 204 * may have fewer states). 205 */ 206 typedef enum { 207 HAL_LED_INIT = 0, 208 HAL_LED_SCAN = 1, 209 HAL_LED_AUTH = 2, 210 HAL_LED_ASSOC = 3, 211 HAL_LED_RUN = 4 212 } HAL_LED_STATE; 213 214 /* 215 * Transmit queue types/numbers. These are used to tag 216 * each transmit queue in the hardware and to identify a set 217 * of transmit queues for operations such as start/stop dma. 218 */ 219 typedef enum { 220 HAL_TX_QUEUE_INACTIVE = 0, /* queue is inactive/unused */ 221 HAL_TX_QUEUE_DATA = 1, /* data xmit q's */ 222 HAL_TX_QUEUE_BEACON = 2, /* beacon xmit q */ 223 HAL_TX_QUEUE_CAB = 3, /* "crap after beacon" xmit q */ 224 HAL_TX_QUEUE_UAPSD = 4, /* u-apsd power save xmit q */ 225 HAL_TX_QUEUE_PSPOLL = 5, /* power save poll xmit q */ 226 HAL_TX_QUEUE_CFEND = 6, 227 HAL_TX_QUEUE_PAPRD = 7, 228 } HAL_TX_QUEUE; 229 230 #define HAL_NUM_TX_QUEUES 10 /* max possible # of queues */ 231 232 typedef enum { 233 HAL_RX_QUEUE_HP = 0, /* high priority recv queue */ 234 HAL_RX_QUEUE_LP = 1, /* low priority recv queue */ 235 } HAL_RX_QUEUE; 236 237 #define HAL_NUM_RX_QUEUES 2 /* max possible # of queues */ 238 239 #define HAL_TXFIFO_DEPTH 8 /* transmit fifo depth */ 240 241 /* 242 * Transmit queue subtype. These map directly to 243 * WME Access Categories (except for UPSD). Refer 244 * to Table 5 of the WME spec. 245 */ 246 typedef enum { 247 HAL_WME_AC_BK = 0, /* background access category */ 248 HAL_WME_AC_BE = 1, /* best effort access category*/ 249 HAL_WME_AC_VI = 2, /* video access category */ 250 HAL_WME_AC_VO = 3, /* voice access category */ 251 HAL_WME_UPSD = 4, /* uplink power save */ 252 } HAL_TX_QUEUE_SUBTYPE; 253 254 /* 255 * Transmit queue flags that control various 256 * operational parameters. 257 */ 258 typedef enum { 259 /* 260 * Per queue interrupt enables. When set the associated 261 * interrupt may be delivered for packets sent through 262 * the queue. Without these enabled no interrupts will 263 * be delivered for transmits through the queue. 264 */ 265 HAL_TXQ_TXOKINT_ENABLE = 0x0001, /* enable TXOK interrupt */ 266 HAL_TXQ_TXERRINT_ENABLE = 0x0001, /* enable TXERR interrupt */ 267 HAL_TXQ_TXDESCINT_ENABLE = 0x0002, /* enable TXDESC interrupt */ 268 HAL_TXQ_TXEOLINT_ENABLE = 0x0004, /* enable TXEOL interrupt */ 269 HAL_TXQ_TXURNINT_ENABLE = 0x0008, /* enable TXURN interrupt */ 270 /* 271 * Enable hardware compression for packets sent through 272 * the queue. The compression buffer must be setup and 273 * packets must have a key entry marked in the tx descriptor. 274 */ 275 HAL_TXQ_COMPRESSION_ENABLE = 0x0010, /* enable h/w compression */ 276 /* 277 * Disable queue when veol is hit or ready time expires. 278 * By default the queue is disabled only on reaching the 279 * physical end of queue (i.e. a null link ptr in the 280 * descriptor chain). 281 */ 282 HAL_TXQ_RDYTIME_EXP_POLICY_ENABLE = 0x0020, 283 /* 284 * Schedule frames on delivery of a DBA (DMA Beacon Alert) 285 * event. Frames will be transmitted only when this timer 286 * fires, e.g to transmit a beacon in ap or adhoc modes. 287 */ 288 HAL_TXQ_DBA_GATED = 0x0040, /* schedule based on DBA */ 289 /* 290 * Each transmit queue has a counter that is incremented 291 * each time the queue is enabled and decremented when 292 * the list of frames to transmit is traversed (or when 293 * the ready time for the queue expires). This counter 294 * must be non-zero for frames to be scheduled for 295 * transmission. The following controls disable bumping 296 * this counter under certain conditions. Typically this 297 * is used to gate frames based on the contents of another 298 * queue (e.g. CAB traffic may only follow a beacon frame). 299 * These are meaningful only when frames are scheduled 300 * with a non-ASAP policy (e.g. DBA-gated). 301 */ 302 HAL_TXQ_CBR_DIS_QEMPTY = 0x0080, /* disable on this q empty */ 303 HAL_TXQ_CBR_DIS_BEMPTY = 0x0100, /* disable on beacon q empty */ 304 305 /* 306 * Fragment burst backoff policy. Normally the no backoff 307 * is done after a successful transmission, the next fragment 308 * is sent at SIFS. If this flag is set backoff is done 309 * after each fragment, regardless whether it was ack'd or 310 * not, after the backoff count reaches zero a normal channel 311 * access procedure is done before the next transmit (i.e. 312 * wait AIFS instead of SIFS). 313 */ 314 HAL_TXQ_FRAG_BURST_BACKOFF_ENABLE = 0x00800000, 315 /* 316 * Disable post-tx backoff following each frame. 317 */ 318 HAL_TXQ_BACKOFF_DISABLE = 0x00010000, /* disable post backoff */ 319 /* 320 * DCU arbiter lockout control. This controls how 321 * lower priority tx queues are handled with respect to 322 * to a specific queue when multiple queues have frames 323 * to send. No lockout means lower priority queues arbitrate 324 * concurrently with this queue. Intra-frame lockout 325 * means lower priority queues are locked out until the 326 * current frame transmits (e.g. including backoffs and bursting). 327 * Global lockout means nothing lower can arbitrary so 328 * long as there is traffic activity on this queue (frames, 329 * backoff, etc). 330 */ 331 HAL_TXQ_ARB_LOCKOUT_INTRA = 0x00020000, /* intra-frame lockout */ 332 HAL_TXQ_ARB_LOCKOUT_GLOBAL = 0x00040000, /* full lockout s */ 333 334 HAL_TXQ_IGNORE_VIRTCOL = 0x00080000, /* ignore virt collisions */ 335 HAL_TXQ_SEQNUM_INC_DIS = 0x00100000, /* disable seqnum increment */ 336 } HAL_TX_QUEUE_FLAGS; 337 338 typedef struct { 339 uint32_t tqi_ver; /* hal TXQ version */ 340 HAL_TX_QUEUE_SUBTYPE tqi_subtype; /* subtype if applicable */ 341 HAL_TX_QUEUE_FLAGS tqi_qflags; /* flags (see above) */ 342 uint32_t tqi_priority; /* (not used) */ 343 uint32_t tqi_aifs; /* aifs */ 344 uint32_t tqi_cwmin; /* cwMin */ 345 uint32_t tqi_cwmax; /* cwMax */ 346 uint16_t tqi_shretry; /* rts retry limit */ 347 uint16_t tqi_lgretry; /* long retry limit (not used)*/ 348 uint32_t tqi_cbrPeriod; /* CBR period (us) */ 349 uint32_t tqi_cbrOverflowLimit; /* threshold for CBROVF int */ 350 uint32_t tqi_burstTime; /* max burst duration (us) */ 351 uint32_t tqi_readyTime; /* frame schedule time (us) */ 352 uint32_t tqi_compBuf; /* comp buffer phys addr */ 353 } HAL_TXQ_INFO; 354 355 #define HAL_TQI_NONVAL 0xffff 356 357 /* token to use for aifs, cwmin, cwmax */ 358 #define HAL_TXQ_USEDEFAULT ((uint32_t) -1) 359 360 /* compression definitions */ 361 #define HAL_COMP_BUF_MAX_SIZE 9216 /* 9K */ 362 #define HAL_COMP_BUF_ALIGN_SIZE 512 363 364 /* 365 * Transmit packet types. This belongs in ah_desc.h, but 366 * is here so we can give a proper type to various parameters 367 * (and not require everyone include the file). 368 * 369 * NB: These values are intentionally assigned for 370 * direct use when setting up h/w descriptors. 371 */ 372 typedef enum { 373 HAL_PKT_TYPE_NORMAL = 0, 374 HAL_PKT_TYPE_ATIM = 1, 375 HAL_PKT_TYPE_PSPOLL = 2, 376 HAL_PKT_TYPE_BEACON = 3, 377 HAL_PKT_TYPE_PROBE_RESP = 4, 378 HAL_PKT_TYPE_CHIRP = 5, 379 HAL_PKT_TYPE_GRP_POLL = 6, 380 HAL_PKT_TYPE_AMPDU = 7, 381 } HAL_PKT_TYPE; 382 383 /* Rx Filter Frame Types */ 384 typedef enum { 385 /* 386 * These bits correspond to AR_RX_FILTER for all chips. 387 * Not all bits are supported by all chips. 388 */ 389 HAL_RX_FILTER_UCAST = 0x00000001, /* Allow unicast frames */ 390 HAL_RX_FILTER_MCAST = 0x00000002, /* Allow multicast frames */ 391 HAL_RX_FILTER_BCAST = 0x00000004, /* Allow broadcast frames */ 392 HAL_RX_FILTER_CONTROL = 0x00000008, /* Allow control frames */ 393 HAL_RX_FILTER_BEACON = 0x00000010, /* Allow beacon frames */ 394 HAL_RX_FILTER_PROM = 0x00000020, /* Promiscuous mode */ 395 HAL_RX_FILTER_PROBEREQ = 0x00000080, /* Allow probe request frames */ 396 HAL_RX_FILTER_PHYERR = 0x00000100, /* Allow phy errors */ 397 HAL_RX_FILTER_COMPBAR = 0x00000400, /* Allow compressed BAR */ 398 HAL_RX_FILTER_COMP_BA = 0x00000800, /* Allow compressed blockack */ 399 HAL_RX_FILTER_PHYRADAR = 0x00002000, /* Allow phy radar errors */ 400 HAL_RX_FILTER_PSPOLL = 0x00004000, /* Allow PS-POLL frames */ 401 HAL_RX_FILTER_MCAST_BCAST_ALL = 0x00008000, 402 /* Allow all mcast/bcast frames */ 403 404 /* 405 * Magic RX filter flags that aren't targetting hardware bits 406 * but instead the HAL sets individual bits - eg PHYERR will result 407 * in OFDM/CCK timing error frames being received. 408 */ 409 HAL_RX_FILTER_BSSID = 0x40000000, /* Disable BSSID match */ 410 } HAL_RX_FILTER; 411 412 typedef enum { 413 HAL_PM_AWAKE = 0, 414 HAL_PM_FULL_SLEEP = 1, 415 HAL_PM_NETWORK_SLEEP = 2, 416 HAL_PM_UNDEFINED = 3 417 } HAL_POWER_MODE; 418 419 /* 420 * NOTE WELL: 421 * These are mapped to take advantage of the common locations for many of 422 * the bits on all of the currently supported MAC chips. This is to make 423 * the ISR as efficient as possible, while still abstracting HW differences. 424 * When new hardware breaks this commonality this enumerated type, as well 425 * as the HAL functions using it, must be modified. All values are directly 426 * mapped unless commented otherwise. 427 */ 428 typedef enum { 429 HAL_INT_RX = 0x00000001, /* Non-common mapping */ 430 HAL_INT_RXDESC = 0x00000002, /* Legacy mapping */ 431 HAL_INT_RXERR = 0x00000004, 432 HAL_INT_RXHP = 0x00000001, /* EDMA */ 433 HAL_INT_RXLP = 0x00000002, /* EDMA */ 434 HAL_INT_RXNOFRM = 0x00000008, 435 HAL_INT_RXEOL = 0x00000010, 436 HAL_INT_RXORN = 0x00000020, 437 HAL_INT_TX = 0x00000040, /* Non-common mapping */ 438 HAL_INT_TXDESC = 0x00000080, 439 HAL_INT_TIM_TIMER= 0x00000100, 440 HAL_INT_MCI = 0x00000200, 441 HAL_INT_BBPANIC = 0x00000400, 442 HAL_INT_TXURN = 0x00000800, 443 HAL_INT_MIB = 0x00001000, 444 HAL_INT_RXPHY = 0x00004000, 445 HAL_INT_RXKCM = 0x00008000, 446 HAL_INT_SWBA = 0x00010000, 447 HAL_INT_BRSSI = 0x00020000, 448 HAL_INT_BMISS = 0x00040000, 449 HAL_INT_BNR = 0x00100000, 450 HAL_INT_TIM = 0x00200000, /* Non-common mapping */ 451 HAL_INT_DTIM = 0x00400000, /* Non-common mapping */ 452 HAL_INT_DTIMSYNC= 0x00800000, /* Non-common mapping */ 453 HAL_INT_GPIO = 0x01000000, 454 HAL_INT_CABEND = 0x02000000, /* Non-common mapping */ 455 HAL_INT_TSFOOR = 0x04000000, /* Non-common mapping */ 456 HAL_INT_TBTT = 0x08000000, /* Non-common mapping */ 457 /* Atheros ref driver has a generic timer interrupt now..*/ 458 HAL_INT_GENTIMER = 0x08000000, /* Non-common mapping */ 459 HAL_INT_CST = 0x10000000, /* Non-common mapping */ 460 HAL_INT_GTT = 0x20000000, /* Non-common mapping */ 461 HAL_INT_FATAL = 0x40000000, /* Non-common mapping */ 462 #define HAL_INT_GLOBAL 0x80000000 /* Set/clear IER */ 463 HAL_INT_BMISC = HAL_INT_TIM 464 | HAL_INT_DTIM 465 | HAL_INT_DTIMSYNC 466 | HAL_INT_CABEND 467 | HAL_INT_TBTT, 468 469 /* Interrupt bits that map directly to ISR/IMR bits */ 470 HAL_INT_COMMON = HAL_INT_RXNOFRM 471 | HAL_INT_RXDESC 472 | HAL_INT_RXEOL 473 | HAL_INT_RXORN 474 | HAL_INT_TXDESC 475 | HAL_INT_TXURN 476 | HAL_INT_MIB 477 | HAL_INT_RXPHY 478 | HAL_INT_RXKCM 479 | HAL_INT_SWBA 480 | HAL_INT_BMISS 481 | HAL_INT_BRSSI 482 | HAL_INT_BNR 483 | HAL_INT_GPIO, 484 } HAL_INT; 485 486 /* 487 * MSI vector assignments 488 */ 489 typedef enum { 490 HAL_MSIVEC_MISC = 0, 491 HAL_MSIVEC_TX = 1, 492 HAL_MSIVEC_RXLP = 2, 493 HAL_MSIVEC_RXHP = 3, 494 } HAL_MSIVEC; 495 496 typedef enum { 497 HAL_INT_LINE = 0, 498 HAL_INT_MSI = 1, 499 } HAL_INT_TYPE; 500 501 /* For interrupt mitigation registers */ 502 typedef enum { 503 HAL_INT_RX_FIRSTPKT=0, 504 HAL_INT_RX_LASTPKT, 505 HAL_INT_TX_FIRSTPKT, 506 HAL_INT_TX_LASTPKT, 507 HAL_INT_THRESHOLD 508 } HAL_INT_MITIGATION; 509 510 typedef enum { 511 HAL_GPIO_OUTPUT_MUX_AS_OUTPUT = 0, 512 HAL_GPIO_OUTPUT_MUX_PCIE_ATTENTION_LED = 1, 513 HAL_GPIO_OUTPUT_MUX_PCIE_POWER_LED = 2, 514 HAL_GPIO_OUTPUT_MUX_MAC_NETWORK_LED = 3, 515 HAL_GPIO_OUTPUT_MUX_MAC_POWER_LED = 4, 516 HAL_GPIO_OUTPUT_MUX_AS_WLAN_ACTIVE = 5, 517 HAL_GPIO_OUTPUT_MUX_AS_TX_FRAME = 6 518 } HAL_GPIO_MUX_TYPE; 519 520 typedef enum { 521 HAL_GPIO_INTR_LOW = 0, 522 HAL_GPIO_INTR_HIGH = 1, 523 HAL_GPIO_INTR_DISABLE = 2 524 } HAL_GPIO_INTR_TYPE; 525 526 typedef enum { 527 HAL_RFGAIN_INACTIVE = 0, 528 HAL_RFGAIN_READ_REQUESTED = 1, 529 HAL_RFGAIN_NEED_CHANGE = 2 530 } HAL_RFGAIN; 531 532 typedef uint16_t HAL_CTRY_CODE; /* country code */ 533 typedef uint16_t HAL_REG_DOMAIN; /* regulatory domain code */ 534 535 #define HAL_ANTENNA_MIN_MODE 0 536 #define HAL_ANTENNA_FIXED_A 1 537 #define HAL_ANTENNA_FIXED_B 2 538 #define HAL_ANTENNA_MAX_MODE 3 539 540 typedef struct { 541 uint32_t ackrcv_bad; 542 uint32_t rts_bad; 543 uint32_t rts_good; 544 uint32_t fcs_bad; 545 uint32_t beacons; 546 } HAL_MIB_STATS; 547 548 enum { 549 HAL_MODE_11A = 0x001, /* 11a channels */ 550 HAL_MODE_TURBO = 0x002, /* 11a turbo-only channels */ 551 HAL_MODE_11B = 0x004, /* 11b channels */ 552 HAL_MODE_PUREG = 0x008, /* 11g channels (OFDM only) */ 553 #ifdef notdef 554 HAL_MODE_11G = 0x010, /* 11g channels (OFDM/CCK) */ 555 #else 556 HAL_MODE_11G = 0x008, /* XXX historical */ 557 #endif 558 HAL_MODE_108G = 0x020, /* 11g+Turbo channels */ 559 HAL_MODE_108A = 0x040, /* 11a+Turbo channels */ 560 HAL_MODE_11A_HALF_RATE = 0x200, /* 11a half width channels */ 561 HAL_MODE_11A_QUARTER_RATE = 0x400, /* 11a quarter width channels */ 562 HAL_MODE_11G_HALF_RATE = 0x800, /* 11g half width channels */ 563 HAL_MODE_11G_QUARTER_RATE = 0x1000, /* 11g quarter width channels */ 564 HAL_MODE_11NG_HT20 = 0x008000, 565 HAL_MODE_11NA_HT20 = 0x010000, 566 HAL_MODE_11NG_HT40PLUS = 0x020000, 567 HAL_MODE_11NG_HT40MINUS = 0x040000, 568 HAL_MODE_11NA_HT40PLUS = 0x080000, 569 HAL_MODE_11NA_HT40MINUS = 0x100000, 570 HAL_MODE_ALL = 0xffffff 571 }; 572 573 typedef struct { 574 int rateCount; /* NB: for proper padding */ 575 uint8_t rateCodeToIndex[256]; /* back mapping */ 576 struct { 577 uint8_t valid; /* valid for rate control use */ 578 uint8_t phy; /* CCK/OFDM/XR */ 579 uint32_t rateKbps; /* transfer rate in kbs */ 580 uint8_t rateCode; /* rate for h/w descriptors */ 581 uint8_t shortPreamble; /* mask for enabling short 582 * preamble in CCK rate code */ 583 uint8_t dot11Rate; /* value for supported rates 584 * info element of MLME */ 585 uint8_t controlRate; /* index of next lower basic 586 * rate; used for dur. calcs */ 587 uint16_t lpAckDuration; /* long preamble ACK duration */ 588 uint16_t spAckDuration; /* short preamble ACK duration*/ 589 } info[64]; 590 } HAL_RATE_TABLE; 591 592 typedef struct { 593 u_int rs_count; /* number of valid entries */ 594 uint8_t rs_rates[64]; /* rates */ 595 } HAL_RATE_SET; 596 597 /* 598 * 802.11n specific structures and enums 599 */ 600 typedef enum { 601 HAL_CHAINTYPE_TX = 1, /* Tx chain type */ 602 HAL_CHAINTYPE_RX = 2, /* RX chain type */ 603 } HAL_CHAIN_TYPE; 604 605 typedef struct { 606 u_int Tries; 607 u_int Rate; /* hardware rate code */ 608 u_int RateIndex; /* rate series table index */ 609 u_int PktDuration; 610 u_int ChSel; 611 u_int RateFlags; 612 #define HAL_RATESERIES_RTS_CTS 0x0001 /* use rts/cts w/this series */ 613 #define HAL_RATESERIES_2040 0x0002 /* use ext channel for series */ 614 #define HAL_RATESERIES_HALFGI 0x0004 /* use half-gi for series */ 615 #define HAL_RATESERIES_STBC 0x0008 /* use STBC for series */ 616 u_int tx_power_cap; 617 } HAL_11N_RATE_SERIES; 618 619 typedef enum { 620 HAL_HT_MACMODE_20 = 0, /* 20 MHz operation */ 621 HAL_HT_MACMODE_2040 = 1, /* 20/40 MHz operation */ 622 } HAL_HT_MACMODE; 623 624 typedef enum { 625 HAL_HT_PHYMODE_20 = 0, /* 20 MHz operation */ 626 HAL_HT_PHYMODE_2040 = 1, /* 20/40 MHz operation */ 627 } HAL_HT_PHYMODE; 628 629 typedef enum { 630 HAL_HT_EXTPROTSPACING_20 = 0, /* 20 MHz spacing */ 631 HAL_HT_EXTPROTSPACING_25 = 1, /* 25 MHz spacing */ 632 } HAL_HT_EXTPROTSPACING; 633 634 635 typedef enum { 636 HAL_RX_CLEAR_CTL_LOW = 0x1, /* force control channel to appear busy */ 637 HAL_RX_CLEAR_EXT_LOW = 0x2, /* force extension channel to appear busy */ 638 } HAL_HT_RXCLEAR; 639 640 /* 641 * Antenna switch control. By default antenna selection 642 * enables multiple (2) antenna use. To force use of the 643 * A or B antenna only specify a fixed setting. Fixing 644 * the antenna will also disable any diversity support. 645 */ 646 typedef enum { 647 HAL_ANT_VARIABLE = 0, /* variable by programming */ 648 HAL_ANT_FIXED_A = 1, /* fixed antenna A */ 649 HAL_ANT_FIXED_B = 2, /* fixed antenna B */ 650 } HAL_ANT_SETTING; 651 652 typedef enum { 653 HAL_M_STA = 1, /* infrastructure station */ 654 HAL_M_IBSS = 0, /* IBSS (adhoc) station */ 655 HAL_M_HOSTAP = 6, /* Software Access Point */ 656 HAL_M_MONITOR = 8 /* Monitor mode */ 657 } HAL_OPMODE; 658 659 typedef struct { 660 uint8_t kv_type; /* one of HAL_CIPHER */ 661 uint8_t kv_apsd; /* Mask for APSD enabled ACs */ 662 uint16_t kv_len; /* length in bits */ 663 uint8_t kv_val[16]; /* enough for 128-bit keys */ 664 uint8_t kv_mic[8]; /* TKIP MIC key */ 665 uint8_t kv_txmic[8]; /* TKIP TX MIC key (optional) */ 666 } HAL_KEYVAL; 667 668 typedef enum { 669 HAL_CIPHER_WEP = 0, 670 HAL_CIPHER_AES_OCB = 1, 671 HAL_CIPHER_AES_CCM = 2, 672 HAL_CIPHER_CKIP = 3, 673 HAL_CIPHER_TKIP = 4, 674 HAL_CIPHER_CLR = 5, /* no encryption */ 675 676 HAL_CIPHER_MIC = 127 /* TKIP-MIC, not a cipher */ 677 } HAL_CIPHER; 678 679 enum { 680 HAL_SLOT_TIME_6 = 6, /* NB: for turbo mode */ 681 HAL_SLOT_TIME_9 = 9, 682 HAL_SLOT_TIME_20 = 20, 683 }; 684 685 /* 686 * Per-station beacon timer state. Note that the specified 687 * beacon interval (given in TU's) can also include flags 688 * to force a TSF reset and to enable the beacon xmit logic. 689 * If bs_cfpmaxduration is non-zero the hardware is setup to 690 * coexist with a PCF-capable AP. 691 */ 692 typedef struct { 693 uint32_t bs_nexttbtt; /* next beacon in TU */ 694 uint32_t bs_nextdtim; /* next DTIM in TU */ 695 uint32_t bs_intval; /* beacon interval+flags */ 696 #define HAL_BEACON_PERIOD 0x0000ffff /* beacon interval period */ 697 #define HAL_BEACON_ENA 0x00800000 /* beacon xmit enable */ 698 #define HAL_BEACON_RESET_TSF 0x01000000 /* clear TSF */ 699 uint32_t bs_dtimperiod; 700 uint16_t bs_cfpperiod; /* CFP period in TU */ 701 uint16_t bs_cfpmaxduration; /* max CFP duration in TU */ 702 uint32_t bs_cfpnext; /* next CFP in TU */ 703 uint16_t bs_timoffset; /* byte offset to TIM bitmap */ 704 uint16_t bs_bmissthreshold; /* beacon miss threshold */ 705 uint32_t bs_sleepduration; /* max sleep duration */ 706 } HAL_BEACON_STATE; 707 708 /* 709 * Like HAL_BEACON_STATE but for non-station mode setup. 710 * NB: see above flag definitions for bt_intval. 711 */ 712 typedef struct { 713 uint32_t bt_intval; /* beacon interval+flags */ 714 uint32_t bt_nexttbtt; /* next beacon in TU */ 715 uint32_t bt_nextatim; /* next ATIM in TU */ 716 uint32_t bt_nextdba; /* next DBA in 1/8th TU */ 717 uint32_t bt_nextswba; /* next SWBA in 1/8th TU */ 718 uint32_t bt_flags; /* timer enables */ 719 #define HAL_BEACON_TBTT_EN 0x00000001 720 #define HAL_BEACON_DBA_EN 0x00000002 721 #define HAL_BEACON_SWBA_EN 0x00000004 722 } HAL_BEACON_TIMERS; 723 724 /* 725 * Per-node statistics maintained by the driver for use in 726 * optimizing signal quality and other operational aspects. 727 */ 728 typedef struct { 729 uint32_t ns_avgbrssi; /* average beacon rssi */ 730 uint32_t ns_avgrssi; /* average data rssi */ 731 uint32_t ns_avgtxrssi; /* average tx rssi */ 732 } HAL_NODE_STATS; 733 734 #define HAL_RSSI_EP_MULTIPLIER (1<<7) /* pow2 to optimize out * and / */ 735 736 struct ath_desc; 737 struct ath_tx_status; 738 struct ath_rx_status; 739 struct ieee80211_channel; 740 741 /* 742 * This is a channel survey sample entry. 743 * 744 * The AR5212 ANI routines fill these samples. The ANI code then uses it 745 * when calculating listen time; it is also exported via a diagnostic 746 * API. 747 */ 748 typedef struct { 749 uint32_t seq_num; 750 uint32_t tx_busy; 751 uint32_t rx_busy; 752 uint32_t chan_busy; 753 uint32_t ext_chan_busy; 754 uint32_t cycle_count; 755 /* XXX TODO */ 756 uint32_t ofdm_phyerr_count; 757 uint32_t cck_phyerr_count; 758 } HAL_SURVEY_SAMPLE; 759 760 /* 761 * This provides 3.2 seconds of sample space given an 762 * ANI time of 1/10th of a second. This may not be enough! 763 */ 764 #define CHANNEL_SURVEY_SAMPLE_COUNT 32 765 766 typedef struct { 767 HAL_SURVEY_SAMPLE samples[CHANNEL_SURVEY_SAMPLE_COUNT]; 768 uint32_t cur_sample; /* current sample in sequence */ 769 uint32_t cur_seq; /* current sequence number */ 770 } HAL_CHANNEL_SURVEY; 771 772 /* 773 * ANI commands. 774 * 775 * These are used both internally and externally via the diagnostic 776 * API. 777 * 778 * Note that this is NOT the ANI commands being used via the INTMIT 779 * capability - that has a different mapping for some reason. 780 */ 781 typedef enum { 782 HAL_ANI_PRESENT = 0, /* is ANI support present */ 783 HAL_ANI_NOISE_IMMUNITY_LEVEL = 1, /* set level */ 784 HAL_ANI_OFDM_WEAK_SIGNAL_DETECTION = 2, /* enable/disable */ 785 HAL_ANI_CCK_WEAK_SIGNAL_THR = 3, /* enable/disable */ 786 HAL_ANI_FIRSTEP_LEVEL = 4, /* set level */ 787 HAL_ANI_SPUR_IMMUNITY_LEVEL = 5, /* set level */ 788 HAL_ANI_MODE = 6, /* 0 => manual, 1 => auto (XXX do not change) */ 789 HAL_ANI_PHYERR_RESET = 7, /* reset phy error stats */ 790 HAL_ANI_MRC_CCK = 8, 791 } HAL_ANI_CMD; 792 793 /* 794 * This is the layout of the ANI INTMIT capability. 795 * 796 * Notice that the command values differ to HAL_ANI_CMD. 797 */ 798 typedef enum { 799 HAL_CAP_INTMIT_PRESENT = 0, 800 HAL_CAP_INTMIT_ENABLE = 1, 801 HAL_CAP_INTMIT_NOISE_IMMUNITY_LEVEL = 2, 802 HAL_CAP_INTMIT_OFDM_WEAK_SIGNAL_LEVEL = 3, 803 HAL_CAP_INTMIT_CCK_WEAK_SIGNAL_THR = 4, 804 HAL_CAP_INTMIT_FIRSTEP_LEVEL = 5, 805 HAL_CAP_INTMIT_SPUR_IMMUNITY_LEVEL = 6 806 } HAL_CAP_INTMIT_CMD; 807 808 /* DFS defines */ 809 typedef struct { 810 int32_t pe_firpwr; /* FIR pwr out threshold */ 811 int32_t pe_rrssi; /* Radar rssi thresh */ 812 int32_t pe_height; /* Pulse height thresh */ 813 int32_t pe_prssi; /* Pulse rssi thresh */ 814 int32_t pe_inband; /* Inband thresh */ 815 816 /* The following params are only for AR5413 and later */ 817 u_int32_t pe_relpwr; /* Relative power threshold in 0.5dB steps */ 818 u_int32_t pe_relstep; /* Pulse Relative step threshold in 0.5dB steps */ 819 u_int32_t pe_maxlen; /* Max length of radar sign in 0.8us units */ 820 int32_t pe_usefir128; /* Use the average in-band power measured over 128 cycles */ 821 int32_t pe_blockradar; /* 822 * Enable to block radar check if pkt detect is done via OFDM 823 * weak signal detect or pkt is detected immediately after tx 824 * to rx transition 825 */ 826 int32_t pe_enmaxrssi; /* 827 * Enable to use the max rssi instead of the last rssi during 828 * fine gain changes for radar detection 829 */ 830 int32_t pe_extchannel; /* Enable DFS on ext channel */ 831 int32_t pe_enabled; /* Whether radar detection is enabled */ 832 int32_t pe_enrelpwr; 833 int32_t pe_en_relstep_check; 834 } HAL_PHYERR_PARAM; 835 836 #define HAL_PHYERR_PARAM_NOVAL 65535 837 838 /* 839 * DFS operating mode flags. 840 */ 841 typedef enum { 842 HAL_DFS_UNINIT_DOMAIN = 0, /* Uninitialized dfs domain */ 843 HAL_DFS_FCC_DOMAIN = 1, /* FCC3 dfs domain */ 844 HAL_DFS_ETSI_DOMAIN = 2, /* ETSI dfs domain */ 845 HAL_DFS_MKK4_DOMAIN = 3, /* Japan dfs domain */ 846 } HAL_DFS_DOMAIN; 847 848 /* 849 * MFP decryption options for initializing the MAC. 850 */ 851 852 typedef enum { 853 HAL_MFP_QOSDATA = 0, /* Decrypt MFP frames like QoS data frames. All chips before Merlin. */ 854 HAL_MFP_PASSTHRU, /* Don't decrypt MFP frames at all. Passthrough */ 855 HAL_MFP_HW_CRYPTO /* hardware decryption enabled. Merlin can do it. */ 856 } HAL_MFP_OPT_T; 857 858 /* LNA config supported */ 859 typedef enum { 860 HAL_ANT_DIV_COMB_LNA1_MINUS_LNA2 = 0, 861 HAL_ANT_DIV_COMB_LNA2 = 1, 862 HAL_ANT_DIV_COMB_LNA1 = 2, 863 HAL_ANT_DIV_COMB_LNA1_PLUS_LNA2 = 3, 864 } HAL_ANT_DIV_COMB_LNA_CONF; 865 866 typedef struct { 867 u_int8_t main_lna_conf; 868 u_int8_t alt_lna_conf; 869 u_int8_t fast_div_bias; 870 u_int8_t main_gaintb; 871 u_int8_t alt_gaintb; 872 u_int8_t antdiv_configgroup; 873 int8_t lna1_lna2_delta; 874 } HAL_ANT_COMB_CONFIG; 875 876 #define DEFAULT_ANTDIV_CONFIG_GROUP 0x00 877 #define HAL_ANTDIV_CONFIG_GROUP_1 0x01 878 #define HAL_ANTDIV_CONFIG_GROUP_2 0x02 879 #define HAL_ANTDIV_CONFIG_GROUP_3 0x03 880 881 /* 882 * Flag for setting QUIET period 883 */ 884 typedef enum { 885 HAL_QUIET_DISABLE = 0x0, 886 HAL_QUIET_ENABLE = 0x1, 887 HAL_QUIET_ADD_CURRENT_TSF = 0x2, /* add current TSF to next_start offset */ 888 HAL_QUIET_ADD_SWBA_RESP_TIME = 0x4, /* add beacon response time to next_start offset */ 889 } HAL_QUIET_FLAG; 890 891 #define HAL_DFS_EVENT_PRICH 0x0000001 892 #define HAL_DFS_EVENT_EXTCH 0x0000002 893 #define HAL_DFS_EVENT_EXTEARLY 0x0000004 894 #define HAL_DFS_EVENT_ISDC 0x0000008 895 896 struct hal_dfs_event { 897 uint64_t re_full_ts; /* 64-bit full timestamp from interrupt time */ 898 uint32_t re_ts; /* Original 15 bit recv timestamp */ 899 uint8_t re_rssi; /* rssi of radar event */ 900 uint8_t re_dur; /* duration of radar pulse */ 901 uint32_t re_flags; /* Flags (see above) */ 902 }; 903 typedef struct hal_dfs_event HAL_DFS_EVENT; 904 905 /* 906 * BT Co-existence definitions 907 */ 908 typedef enum { 909 HAL_BT_MODULE_CSR_BC4 = 0, /* CSR BlueCore v4 */ 910 HAL_BT_MODULE_JANUS = 1, /* Kite + Valkyrie combo */ 911 HAL_BT_MODULE_HELIUS = 2, /* Kiwi + Valkyrie combo */ 912 HAL_MAX_BT_MODULES 913 } HAL_BT_MODULE; 914 915 typedef struct { 916 HAL_BT_MODULE bt_module; 917 u_int8_t bt_coex_config; 918 u_int8_t bt_gpio_bt_active; 919 u_int8_t bt_gpio_bt_priority; 920 u_int8_t bt_gpio_wlan_active; 921 u_int8_t bt_active_polarity; 922 HAL_BOOL bt_single_ant; 923 u_int8_t bt_dutyCycle; 924 u_int8_t bt_isolation; 925 u_int8_t bt_period; 926 } HAL_BT_COEX_INFO; 927 928 typedef enum { 929 HAL_BT_COEX_MODE_LEGACY = 0, /* legacy rx_clear mode */ 930 HAL_BT_COEX_MODE_UNSLOTTED = 1, /* untimed/unslotted mode */ 931 HAL_BT_COEX_MODE_SLOTTED = 2, /* slotted mode */ 932 HAL_BT_COEX_MODE_DISALBED = 3, /* coexistence disabled */ 933 } HAL_BT_COEX_MODE; 934 935 typedef enum { 936 HAL_BT_COEX_CFG_NONE, /* No bt coex enabled */ 937 HAL_BT_COEX_CFG_2WIRE_2CH, /* 2-wire with 2 chains */ 938 HAL_BT_COEX_CFG_2WIRE_CH1, /* 2-wire with ch1 */ 939 HAL_BT_COEX_CFG_2WIRE_CH0, /* 2-wire with ch0 */ 940 HAL_BT_COEX_CFG_3WIRE, /* 3-wire */ 941 HAL_BT_COEX_CFG_MCI /* MCI */ 942 } HAL_BT_COEX_CFG; 943 944 typedef enum { 945 HAL_BT_COEX_SET_ACK_PWR = 0, /* Change ACK power setting */ 946 HAL_BT_COEX_LOWER_TX_PWR, /* Change transmit power */ 947 HAL_BT_COEX_ANTENNA_DIVERSITY, /* Enable RX diversity for Kite */ 948 } HAL_BT_COEX_SET_PARAMETER; 949 950 #define HAL_BT_COEX_FLAG_LOW_ACK_PWR 0x00000001 951 #define HAL_BT_COEX_FLAG_LOWER_TX_PWR 0x00000002 952 /* Check Rx Diversity is allowed */ 953 #define HAL_BT_COEX_FLAG_ANT_DIV_ALLOW 0x00000004 954 /* Check Diversity is on or off */ 955 #define HAL_BT_COEX_FLAG_ANT_DIV_ENABLE 0x00000008 956 957 #define HAL_BT_COEX_ANTDIV_CONTROL1_ENABLE 0x0b 958 /* main: LNA1, alt: LNA2 */ 959 #define HAL_BT_COEX_ANTDIV_CONTROL2_ENABLE 0x09 960 #define HAL_BT_COEX_ANTDIV_CONTROL1_FIXED_A 0x04 961 #define HAL_BT_COEX_ANTDIV_CONTROL2_FIXED_A 0x09 962 #define HAL_BT_COEX_ANTDIV_CONTROL1_FIXED_B 0x02 963 #define HAL_BT_COEX_ANTDIV_CONTROL2_FIXED_B 0x06 964 965 #define HAL_BT_COEX_ISOLATION_FOR_NO_COEX 30 966 967 #define HAL_BT_COEX_ANT_DIV_SWITCH_COM 0x66666666 968 969 #define HAL_BT_COEX_HELIUS_CHAINMASK 0x02 970 971 #define HAL_BT_COEX_LOW_ACK_POWER 0x0 972 #define HAL_BT_COEX_HIGH_ACK_POWER 0x3f3f3f 973 974 typedef enum { 975 HAL_BT_COEX_NO_STOMP = 0, 976 HAL_BT_COEX_STOMP_ALL, 977 HAL_BT_COEX_STOMP_LOW, 978 HAL_BT_COEX_STOMP_NONE, 979 HAL_BT_COEX_STOMP_ALL_FORCE, 980 HAL_BT_COEX_STOMP_LOW_FORCE, 981 } HAL_BT_COEX_STOMP_TYPE; 982 983 typedef struct { 984 /* extend rx_clear after tx/rx to protect the burst (in usec). */ 985 u_int8_t bt_time_extend; 986 987 /* 988 * extend rx_clear as long as txsm is 989 * transmitting or waiting for ack. 990 */ 991 HAL_BOOL bt_txstate_extend; 992 993 /* 994 * extend rx_clear so that when tx_frame 995 * is asserted, rx_clear will drop. 996 */ 997 HAL_BOOL bt_txframe_extend; 998 999 /* 1000 * coexistence mode 1001 */ 1002 HAL_BT_COEX_MODE bt_mode; 1003 1004 /* 1005 * treat BT high priority traffic as 1006 * a quiet collision 1007 */ 1008 HAL_BOOL bt_quiet_collision; 1009 1010 /* 1011 * invert rx_clear as WLAN_ACTIVE 1012 */ 1013 HAL_BOOL bt_rxclear_polarity; 1014 1015 /* 1016 * slotted mode only. indicate the time in usec 1017 * from the rising edge of BT_ACTIVE to the time 1018 * BT_PRIORITY can be sampled to indicate priority. 1019 */ 1020 u_int8_t bt_priority_time; 1021 1022 /* 1023 * slotted mode only. indicate the time in usec 1024 * from the rising edge of BT_ACTIVE to the time 1025 * BT_PRIORITY can be sampled to indicate tx/rx and 1026 * BT_FREQ is sampled. 1027 */ 1028 u_int8_t bt_first_slot_time; 1029 1030 /* 1031 * slotted mode only. rx_clear and bt_ant decision 1032 * will be held the entire time that BT_ACTIVE is asserted, 1033 * otherwise the decision is made before every slot boundry. 1034 */ 1035 HAL_BOOL bt_hold_rxclear; 1036 } HAL_BT_COEX_CONFIG; 1037 1038 typedef struct 1039 { 1040 int ah_debug; /* only used if AH_DEBUG is defined */ 1041 int ah_ar5416_biasadj; /* enable AR2133 radio specific bias fiddling */ 1042 1043 /* NB: these are deprecated; they exist for now for compatibility */ 1044 int ah_dma_beacon_response_time;/* in TU's */ 1045 int ah_sw_beacon_response_time; /* in TU's */ 1046 int ah_additional_swba_backoff; /* in TU's */ 1047 int ah_force_full_reset; /* force full chip reset rather then warm reset */ 1048 int ah_serialise_reg_war; /* force serialisation of register IO */ 1049 } HAL_OPS_CONFIG; 1050 1051 /* 1052 * Hardware Access Layer (HAL) API. 1053 * 1054 * Clients of the HAL call ath_hal_attach to obtain a reference to an 1055 * ath_hal structure for use with the device. Hardware-related operations 1056 * that follow must call back into the HAL through interface, supplying 1057 * the reference as the first parameter. Note that before using the 1058 * reference returned by ath_hal_attach the caller should verify the 1059 * ABI version number. 1060 */ 1061 struct ath_hal { 1062 uint32_t ah_magic; /* consistency check magic number */ 1063 uint16_t ah_devid; /* PCI device ID */ 1064 uint16_t ah_subvendorid; /* PCI subvendor ID */ 1065 HAL_SOFTC ah_sc; /* back pointer to driver/os state */ 1066 HAL_BUS_TAG ah_st; /* params for register r+w */ 1067 HAL_BUS_HANDLE ah_sh; 1068 HAL_CTRY_CODE ah_countryCode; 1069 1070 uint32_t ah_macVersion; /* MAC version id */ 1071 uint16_t ah_macRev; /* MAC revision */ 1072 uint16_t ah_phyRev; /* PHY revision */ 1073 /* NB: when only one radio is present the rev is in 5Ghz */ 1074 uint16_t ah_analog5GhzRev;/* 5GHz radio revision */ 1075 uint16_t ah_analog2GhzRev;/* 2GHz radio revision */ 1076 1077 uint16_t *ah_eepromdata; /* eeprom buffer, if needed */ 1078 1079 uint32_t ah_intrstate[8]; /* last int state */ 1080 uint32_t ah_syncstate; /* last sync intr state */ 1081 1082 HAL_OPS_CONFIG ah_config; 1083 const HAL_RATE_TABLE *__ahdecl(*ah_getRateTable)(struct ath_hal *, 1084 u_int mode); 1085 void __ahdecl(*ah_detach)(struct ath_hal*); 1086 1087 /* Reset functions */ 1088 HAL_BOOL __ahdecl(*ah_reset)(struct ath_hal *, HAL_OPMODE, 1089 struct ieee80211_channel *, 1090 HAL_BOOL bChannelChange, HAL_STATUS *status); 1091 HAL_BOOL __ahdecl(*ah_phyDisable)(struct ath_hal *); 1092 HAL_BOOL __ahdecl(*ah_disable)(struct ath_hal *); 1093 void __ahdecl(*ah_configPCIE)(struct ath_hal *, HAL_BOOL restore, 1094 HAL_BOOL power_off); 1095 void __ahdecl(*ah_disablePCIE)(struct ath_hal *); 1096 void __ahdecl(*ah_setPCUConfig)(struct ath_hal *); 1097 HAL_BOOL __ahdecl(*ah_perCalibration)(struct ath_hal*, 1098 struct ieee80211_channel *, HAL_BOOL *); 1099 HAL_BOOL __ahdecl(*ah_perCalibrationN)(struct ath_hal *, 1100 struct ieee80211_channel *, u_int chainMask, 1101 HAL_BOOL longCal, HAL_BOOL *isCalDone); 1102 HAL_BOOL __ahdecl(*ah_resetCalValid)(struct ath_hal *, 1103 const struct ieee80211_channel *); 1104 HAL_BOOL __ahdecl(*ah_setTxPower)(struct ath_hal *, 1105 const struct ieee80211_channel *, uint16_t *); 1106 HAL_BOOL __ahdecl(*ah_setTxPowerLimit)(struct ath_hal *, uint32_t); 1107 HAL_BOOL __ahdecl(*ah_setBoardValues)(struct ath_hal *, 1108 const struct ieee80211_channel *); 1109 1110 /* Transmit functions */ 1111 HAL_BOOL __ahdecl(*ah_updateTxTrigLevel)(struct ath_hal*, 1112 HAL_BOOL incTrigLevel); 1113 int __ahdecl(*ah_setupTxQueue)(struct ath_hal *, HAL_TX_QUEUE, 1114 const HAL_TXQ_INFO *qInfo); 1115 HAL_BOOL __ahdecl(*ah_setTxQueueProps)(struct ath_hal *, int q, 1116 const HAL_TXQ_INFO *qInfo); 1117 HAL_BOOL __ahdecl(*ah_getTxQueueProps)(struct ath_hal *, int q, 1118 HAL_TXQ_INFO *qInfo); 1119 HAL_BOOL __ahdecl(*ah_releaseTxQueue)(struct ath_hal *ah, u_int q); 1120 HAL_BOOL __ahdecl(*ah_resetTxQueue)(struct ath_hal *ah, u_int q); 1121 uint32_t __ahdecl(*ah_getTxDP)(struct ath_hal*, u_int); 1122 HAL_BOOL __ahdecl(*ah_setTxDP)(struct ath_hal*, u_int, uint32_t txdp); 1123 uint32_t __ahdecl(*ah_numTxPending)(struct ath_hal *, u_int q); 1124 HAL_BOOL __ahdecl(*ah_startTxDma)(struct ath_hal*, u_int); 1125 HAL_BOOL __ahdecl(*ah_stopTxDma)(struct ath_hal*, u_int); 1126 HAL_BOOL __ahdecl(*ah_setupTxDesc)(struct ath_hal *, struct ath_desc *, 1127 u_int pktLen, u_int hdrLen, 1128 HAL_PKT_TYPE type, u_int txPower, 1129 u_int txRate0, u_int txTries0, 1130 u_int keyIx, u_int antMode, u_int flags, 1131 u_int rtsctsRate, u_int rtsctsDuration, 1132 u_int compicvLen, u_int compivLen, 1133 u_int comp); 1134 HAL_BOOL __ahdecl(*ah_setupXTxDesc)(struct ath_hal *, struct ath_desc*, 1135 u_int txRate1, u_int txTries1, 1136 u_int txRate2, u_int txTries2, 1137 u_int txRate3, u_int txTries3); 1138 HAL_BOOL __ahdecl(*ah_fillTxDesc)(struct ath_hal *, struct ath_desc *, 1139 HAL_DMA_ADDR *bufAddrList, uint32_t *segLenList, 1140 u_int descId, u_int qcuId, HAL_BOOL firstSeg, 1141 HAL_BOOL lastSeg, const struct ath_desc *); 1142 HAL_STATUS __ahdecl(*ah_procTxDesc)(struct ath_hal *, 1143 struct ath_desc *, struct ath_tx_status *); 1144 void __ahdecl(*ah_getTxIntrQueue)(struct ath_hal *, uint32_t *); 1145 void __ahdecl(*ah_reqTxIntrDesc)(struct ath_hal *, struct ath_desc*); 1146 HAL_BOOL __ahdecl(*ah_getTxCompletionRates)(struct ath_hal *, 1147 const struct ath_desc *ds, int *rates, int *tries); 1148 void __ahdecl(*ah_setTxDescLink)(struct ath_hal *ah, void *ds, 1149 uint32_t link); 1150 void __ahdecl(*ah_getTxDescLink)(struct ath_hal *ah, void *ds, 1151 uint32_t *link); 1152 void __ahdecl(*ah_getTxDescLinkPtr)(struct ath_hal *ah, void *ds, 1153 uint32_t **linkptr); 1154 void __ahdecl(*ah_setupTxStatusRing)(struct ath_hal *, 1155 void *ts_start, uint32_t ts_paddr_start, 1156 uint16_t size); 1157 1158 /* Receive Functions */ 1159 uint32_t __ahdecl(*ah_getRxDP)(struct ath_hal*, HAL_RX_QUEUE); 1160 void __ahdecl(*ah_setRxDP)(struct ath_hal*, uint32_t rxdp, HAL_RX_QUEUE); 1161 void __ahdecl(*ah_enableReceive)(struct ath_hal*); 1162 HAL_BOOL __ahdecl(*ah_stopDmaReceive)(struct ath_hal*); 1163 void __ahdecl(*ah_startPcuReceive)(struct ath_hal*); 1164 void __ahdecl(*ah_stopPcuReceive)(struct ath_hal*); 1165 void __ahdecl(*ah_setMulticastFilter)(struct ath_hal*, 1166 uint32_t filter0, uint32_t filter1); 1167 HAL_BOOL __ahdecl(*ah_setMulticastFilterIndex)(struct ath_hal*, 1168 uint32_t index); 1169 HAL_BOOL __ahdecl(*ah_clrMulticastFilterIndex)(struct ath_hal*, 1170 uint32_t index); 1171 uint32_t __ahdecl(*ah_getRxFilter)(struct ath_hal*); 1172 void __ahdecl(*ah_setRxFilter)(struct ath_hal*, uint32_t); 1173 HAL_BOOL __ahdecl(*ah_setupRxDesc)(struct ath_hal *, struct ath_desc *, 1174 uint32_t size, u_int flags); 1175 HAL_STATUS __ahdecl(*ah_procRxDesc)(struct ath_hal *, 1176 struct ath_desc *, uint32_t phyAddr, 1177 struct ath_desc *next, uint64_t tsf, 1178 struct ath_rx_status *); 1179 void __ahdecl(*ah_rxMonitor)(struct ath_hal *, 1180 const HAL_NODE_STATS *, 1181 const struct ieee80211_channel *); 1182 void __ahdecl(*ah_aniPoll)(struct ath_hal *, 1183 const struct ieee80211_channel *); 1184 void __ahdecl(*ah_procMibEvent)(struct ath_hal *, 1185 const HAL_NODE_STATS *); 1186 void __ahdecl(*ah_rxAntCombDiversity)(struct ath_hal *, 1187 struct ath_rx_status *, 1188 unsigned long, int); 1189 1190 /* Misc Functions */ 1191 HAL_STATUS __ahdecl(*ah_getCapability)(struct ath_hal *, 1192 HAL_CAPABILITY_TYPE, uint32_t capability, 1193 uint32_t *result); 1194 HAL_BOOL __ahdecl(*ah_setCapability)(struct ath_hal *, 1195 HAL_CAPABILITY_TYPE, uint32_t capability, 1196 uint32_t setting, HAL_STATUS *); 1197 HAL_BOOL __ahdecl(*ah_getDiagState)(struct ath_hal *, int request, 1198 const void *args, uint32_t argsize, 1199 void **result, uint32_t *resultsize); 1200 void __ahdecl(*ah_getMacAddress)(struct ath_hal *, uint8_t *); 1201 HAL_BOOL __ahdecl(*ah_setMacAddress)(struct ath_hal *, const uint8_t*); 1202 void __ahdecl(*ah_getBssIdMask)(struct ath_hal *, uint8_t *); 1203 HAL_BOOL __ahdecl(*ah_setBssIdMask)(struct ath_hal *, const uint8_t*); 1204 HAL_BOOL __ahdecl(*ah_setRegulatoryDomain)(struct ath_hal*, 1205 uint16_t, HAL_STATUS *); 1206 void __ahdecl(*ah_setLedState)(struct ath_hal*, HAL_LED_STATE); 1207 void __ahdecl(*ah_writeAssocid)(struct ath_hal*, 1208 const uint8_t *bssid, uint16_t assocId); 1209 HAL_BOOL __ahdecl(*ah_gpioCfgOutput)(struct ath_hal *, 1210 uint32_t gpio, HAL_GPIO_MUX_TYPE); 1211 HAL_BOOL __ahdecl(*ah_gpioCfgInput)(struct ath_hal *, uint32_t gpio); 1212 uint32_t __ahdecl(*ah_gpioGet)(struct ath_hal *, uint32_t gpio); 1213 HAL_BOOL __ahdecl(*ah_gpioSet)(struct ath_hal *, 1214 uint32_t gpio, uint32_t val); 1215 void __ahdecl(*ah_gpioSetIntr)(struct ath_hal*, u_int, uint32_t); 1216 uint32_t __ahdecl(*ah_getTsf32)(struct ath_hal*); 1217 uint64_t __ahdecl(*ah_getTsf64)(struct ath_hal*); 1218 void __ahdecl(*ah_resetTsf)(struct ath_hal*); 1219 HAL_BOOL __ahdecl(*ah_detectCardPresent)(struct ath_hal*); 1220 void __ahdecl(*ah_updateMibCounters)(struct ath_hal*, 1221 HAL_MIB_STATS*); 1222 HAL_RFGAIN __ahdecl(*ah_getRfGain)(struct ath_hal*); 1223 u_int __ahdecl(*ah_getDefAntenna)(struct ath_hal*); 1224 void __ahdecl(*ah_setDefAntenna)(struct ath_hal*, u_int); 1225 HAL_ANT_SETTING __ahdecl(*ah_getAntennaSwitch)(struct ath_hal*); 1226 HAL_BOOL __ahdecl(*ah_setAntennaSwitch)(struct ath_hal*, 1227 HAL_ANT_SETTING); 1228 HAL_BOOL __ahdecl(*ah_setSifsTime)(struct ath_hal*, u_int); 1229 u_int __ahdecl(*ah_getSifsTime)(struct ath_hal*); 1230 HAL_BOOL __ahdecl(*ah_setSlotTime)(struct ath_hal*, u_int); 1231 u_int __ahdecl(*ah_getSlotTime)(struct ath_hal*); 1232 HAL_BOOL __ahdecl(*ah_setAckTimeout)(struct ath_hal*, u_int); 1233 u_int __ahdecl(*ah_getAckTimeout)(struct ath_hal*); 1234 HAL_BOOL __ahdecl(*ah_setAckCTSRate)(struct ath_hal*, u_int); 1235 u_int __ahdecl(*ah_getAckCTSRate)(struct ath_hal*); 1236 HAL_BOOL __ahdecl(*ah_setCTSTimeout)(struct ath_hal*, u_int); 1237 u_int __ahdecl(*ah_getCTSTimeout)(struct ath_hal*); 1238 HAL_BOOL __ahdecl(*ah_setDecompMask)(struct ath_hal*, uint16_t, int); 1239 void __ahdecl(*ah_setCoverageClass)(struct ath_hal*, uint8_t, int); 1240 HAL_STATUS __ahdecl(*ah_setQuiet)(struct ath_hal *ah, uint32_t period, 1241 uint32_t duration, uint32_t nextStart, 1242 HAL_QUIET_FLAG flag); 1243 1244 /* DFS functions */ 1245 void __ahdecl(*ah_enableDfs)(struct ath_hal *ah, 1246 HAL_PHYERR_PARAM *pe); 1247 void __ahdecl(*ah_getDfsThresh)(struct ath_hal *ah, 1248 HAL_PHYERR_PARAM *pe); 1249 HAL_BOOL __ahdecl(*ah_getDfsDefaultThresh)(struct ath_hal *ah, 1250 HAL_PHYERR_PARAM *pe); 1251 HAL_BOOL __ahdecl(*ah_procRadarEvent)(struct ath_hal *ah, 1252 struct ath_rx_status *rxs, uint64_t fulltsf, 1253 const char *buf, HAL_DFS_EVENT *event); 1254 HAL_BOOL __ahdecl(*ah_isFastClockEnabled)(struct ath_hal *ah); 1255 1256 /* Key Cache Functions */ 1257 uint32_t __ahdecl(*ah_getKeyCacheSize)(struct ath_hal*); 1258 HAL_BOOL __ahdecl(*ah_resetKeyCacheEntry)(struct ath_hal*, uint16_t); 1259 HAL_BOOL __ahdecl(*ah_isKeyCacheEntryValid)(struct ath_hal *, 1260 uint16_t); 1261 HAL_BOOL __ahdecl(*ah_setKeyCacheEntry)(struct ath_hal*, 1262 uint16_t, const HAL_KEYVAL *, 1263 const uint8_t *, int); 1264 HAL_BOOL __ahdecl(*ah_setKeyCacheEntryMac)(struct ath_hal*, 1265 uint16_t, const uint8_t *); 1266 1267 /* Power Management Functions */ 1268 HAL_BOOL __ahdecl(*ah_setPowerMode)(struct ath_hal*, 1269 HAL_POWER_MODE mode, int setChip); 1270 HAL_POWER_MODE __ahdecl(*ah_getPowerMode)(struct ath_hal*); 1271 int16_t __ahdecl(*ah_getChanNoise)(struct ath_hal *, 1272 const struct ieee80211_channel *); 1273 1274 /* Beacon Management Functions */ 1275 void __ahdecl(*ah_setBeaconTimers)(struct ath_hal*, 1276 const HAL_BEACON_TIMERS *); 1277 /* NB: deprecated, use ah_setBeaconTimers instead */ 1278 void __ahdecl(*ah_beaconInit)(struct ath_hal *, 1279 uint32_t nexttbtt, uint32_t intval); 1280 void __ahdecl(*ah_setStationBeaconTimers)(struct ath_hal*, 1281 const HAL_BEACON_STATE *); 1282 void __ahdecl(*ah_resetStationBeaconTimers)(struct ath_hal*); 1283 uint64_t __ahdecl(*ah_getNextTBTT)(struct ath_hal *); 1284 1285 /* 802.11n Functions */ 1286 HAL_BOOL __ahdecl(*ah_chainTxDesc)(struct ath_hal *, 1287 struct ath_desc *, 1288 HAL_DMA_ADDR *bufAddrList, 1289 uint32_t *segLenList, 1290 u_int, u_int, HAL_PKT_TYPE, 1291 u_int, HAL_CIPHER, uint8_t, HAL_BOOL, 1292 HAL_BOOL, HAL_BOOL); 1293 HAL_BOOL __ahdecl(*ah_setupFirstTxDesc)(struct ath_hal *, 1294 struct ath_desc *, u_int, u_int, u_int, 1295 u_int, u_int, u_int, u_int, u_int); 1296 HAL_BOOL __ahdecl(*ah_setupLastTxDesc)(struct ath_hal *, 1297 struct ath_desc *, const struct ath_desc *); 1298 void __ahdecl(*ah_set11nRateScenario)(struct ath_hal *, 1299 struct ath_desc *, u_int, u_int, 1300 HAL_11N_RATE_SERIES [], u_int, u_int); 1301 void __ahdecl(*ah_set11nAggrFirst)(struct ath_hal *, 1302 struct ath_desc *, u_int); 1303 void __ahdecl(*ah_set11nAggrMiddle)(struct ath_hal *, 1304 struct ath_desc *, u_int); 1305 void __ahdecl(*ah_set11nAggrLast)(struct ath_hal *, 1306 struct ath_desc *); 1307 void __ahdecl(*ah_clr11nAggr)(struct ath_hal *, 1308 struct ath_desc *); 1309 void __ahdecl(*ah_set11nBurstDuration)(struct ath_hal *, 1310 struct ath_desc *, u_int); 1311 HAL_BOOL __ahdecl(*ah_getMibCycleCounts) (struct ath_hal *, 1312 HAL_SURVEY_SAMPLE *); 1313 1314 uint32_t __ahdecl(*ah_get11nExtBusy)(struct ath_hal *); 1315 void __ahdecl(*ah_set11nMac2040)(struct ath_hal *, 1316 HAL_HT_MACMODE); 1317 HAL_HT_RXCLEAR __ahdecl(*ah_get11nRxClear)(struct ath_hal *ah); 1318 void __ahdecl(*ah_set11nRxClear)(struct ath_hal *, 1319 HAL_HT_RXCLEAR); 1320 1321 /* Interrupt functions */ 1322 HAL_BOOL __ahdecl(*ah_isInterruptPending)(struct ath_hal*); 1323 HAL_BOOL __ahdecl(*ah_getPendingInterrupts)(struct ath_hal*, HAL_INT*); 1324 HAL_INT __ahdecl(*ah_getInterrupts)(struct ath_hal*); 1325 HAL_INT __ahdecl(*ah_setInterrupts)(struct ath_hal*, HAL_INT); 1326 }; 1327 1328 /* 1329 * Check the PCI vendor ID and device ID against Atheros' values 1330 * and return a printable description for any Atheros hardware. 1331 * AH_NULL is returned if the ID's do not describe Atheros hardware. 1332 */ 1333 extern const char *__ahdecl ath_hal_probe(uint16_t vendorid, uint16_t devid); 1334 1335 /* 1336 * Attach the HAL for use with the specified device. The device is 1337 * defined by the PCI device ID. The caller provides an opaque pointer 1338 * to an upper-layer data structure (HAL_SOFTC) that is stored in the 1339 * HAL state block for later use. Hardware register accesses are done 1340 * using the specified bus tag and handle. On successful return a 1341 * reference to a state block is returned that must be supplied in all 1342 * subsequent HAL calls. Storage associated with this reference is 1343 * dynamically allocated and must be freed by calling the ah_detach 1344 * method when the client is done. If the attach operation fails a 1345 * null (AH_NULL) reference will be returned and a status code will 1346 * be returned if the status parameter is non-zero. 1347 */ 1348 extern struct ath_hal * __ahdecl ath_hal_attach(uint16_t devid, HAL_SOFTC, 1349 HAL_BUS_TAG, HAL_BUS_HANDLE, uint16_t *eepromdata, HAL_STATUS* status); 1350 1351 extern const char *ath_hal_mac_name(struct ath_hal *); 1352 extern const char *ath_hal_rf_name(struct ath_hal *); 1353 1354 /* 1355 * Regulatory interfaces. Drivers should use ath_hal_init_channels to 1356 * request a set of channels for a particular country code and/or 1357 * regulatory domain. If CTRY_DEFAULT and SKU_NONE are specified then 1358 * this list is constructed according to the contents of the EEPROM. 1359 * ath_hal_getchannels acts similarly but does not alter the operating 1360 * state; this can be used to collect information for a particular 1361 * regulatory configuration. Finally ath_hal_set_channels installs a 1362 * channel list constructed outside the driver. The HAL will adopt the 1363 * channel list and setup internal state according to the specified 1364 * regulatory configuration (e.g. conformance test limits). 1365 * 1366 * For all interfaces the channel list is returned in the supplied array. 1367 * maxchans defines the maximum size of this array. nchans contains the 1368 * actual number of channels returned. If a problem occurred then a 1369 * status code != HAL_OK is returned. 1370 */ 1371 struct ieee80211_channel; 1372 1373 /* 1374 * Return a list of channels according to the specified regulatory. 1375 */ 1376 extern HAL_STATUS __ahdecl ath_hal_getchannels(struct ath_hal *, 1377 struct ieee80211_channel *chans, u_int maxchans, int *nchans, 1378 u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn, 1379 HAL_BOOL enableExtendedChannels); 1380 1381 /* 1382 * Return a list of channels and install it as the current operating 1383 * regulatory list. 1384 */ 1385 extern HAL_STATUS __ahdecl ath_hal_init_channels(struct ath_hal *, 1386 struct ieee80211_channel *chans, u_int maxchans, int *nchans, 1387 u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN rd, 1388 HAL_BOOL enableExtendedChannels); 1389 1390 /* 1391 * Install the list of channels as the current operating regulatory 1392 * and setup related state according to the country code and sku. 1393 */ 1394 extern HAL_STATUS __ahdecl ath_hal_set_channels(struct ath_hal *, 1395 struct ieee80211_channel *chans, int nchans, 1396 HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn); 1397 1398 /* 1399 * Fetch the ctl/ext noise floor values reported by a MIMO 1400 * radio. Returns 1 for valid results, 0 for invalid channel. 1401 */ 1402 extern int __ahdecl ath_hal_get_mimo_chan_noise(struct ath_hal *ah, 1403 const struct ieee80211_channel *chan, int16_t *nf_ctl, 1404 int16_t *nf_ext); 1405 1406 /* 1407 * Calibrate noise floor data following a channel scan or similar. 1408 * This must be called prior retrieving noise floor data. 1409 */ 1410 extern void __ahdecl ath_hal_process_noisefloor(struct ath_hal *ah); 1411 1412 /* 1413 * Return bit mask of wireless modes supported by the hardware. 1414 */ 1415 extern u_int __ahdecl ath_hal_getwirelessmodes(struct ath_hal*); 1416 1417 /* 1418 * Get the HAL wireless mode for the given channel. 1419 */ 1420 extern int ath_hal_get_curmode(struct ath_hal *ah, 1421 const struct ieee80211_channel *chan); 1422 1423 /* 1424 * Calculate the packet TX time for a legacy or 11n frame 1425 */ 1426 extern uint32_t __ahdecl ath_hal_pkt_txtime(struct ath_hal *ah, 1427 const HAL_RATE_TABLE *rates, uint32_t frameLen, 1428 uint16_t rateix, HAL_BOOL isht40, HAL_BOOL shortPreamble); 1429 1430 /* 1431 * Calculate the duration of an 11n frame. 1432 */ 1433 extern uint32_t __ahdecl ath_computedur_ht(uint32_t frameLen, uint16_t rate, 1434 int streams, HAL_BOOL isht40, HAL_BOOL isShortGI); 1435 1436 /* 1437 * Calculate the transmit duration of a legacy frame. 1438 */ 1439 extern uint16_t __ahdecl ath_hal_computetxtime(struct ath_hal *, 1440 const HAL_RATE_TABLE *rates, uint32_t frameLen, 1441 uint16_t rateix, HAL_BOOL shortPreamble); 1442 1443 /* 1444 * Adjust the TSF. 1445 */ 1446 extern void __ahdecl ath_hal_adjusttsf(struct ath_hal *ah, int32_t tsfdelta); 1447 1448 /* 1449 * Enable or disable CCA. 1450 */ 1451 void __ahdecl ath_hal_setcca(struct ath_hal *ah, int ena); 1452 1453 /* 1454 * Get CCA setting. 1455 */ 1456 int __ahdecl ath_hal_getcca(struct ath_hal *ah); 1457 1458 /* 1459 * Read EEPROM data from ah_eepromdata 1460 */ 1461 HAL_BOOL __ahdecl ath_hal_EepromDataRead(struct ath_hal *ah, 1462 u_int off, uint16_t *data); 1463 1464 /* 1465 * For now, simply pass through MFP frames. 1466 */ 1467 static inline u_int32_t 1468 ath_hal_get_mfp_qos(struct ath_hal *ah) 1469 { 1470 //return AH_PRIVATE(ah)->ah_mfp_qos; 1471 return HAL_MFP_QOSDATA; 1472 } 1473 1474 #endif /* _ATH_AH_H_ */ 1475