ah.h revision 239632
1185377Ssam/* 2187831Ssam * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting 3185377Ssam * Copyright (c) 2002-2008 Atheros Communications, Inc. 4185377Ssam * 5185377Ssam * Permission to use, copy, modify, and/or distribute this software for any 6185377Ssam * purpose with or without fee is hereby granted, provided that the above 7185377Ssam * copyright notice and this permission notice appear in all copies. 8185377Ssam * 9185377Ssam * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10185377Ssam * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11185377Ssam * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12185377Ssam * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13185377Ssam * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14185377Ssam * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15185377Ssam * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16185377Ssam * 17187831Ssam * $FreeBSD: head/sys/dev/ath/ath_hal/ah.h 239632 2012-08-24 00:40:01Z adrian $ 18185377Ssam */ 19185377Ssam 20185377Ssam#ifndef _ATH_AH_H_ 21185377Ssam#define _ATH_AH_H_ 22185377Ssam/* 23185377Ssam * Atheros Hardware Access Layer 24185377Ssam * 25185377Ssam * Clients of the HAL call ath_hal_attach to obtain a reference to an ath_hal 26185377Ssam * structure for use with the device. Hardware-related operations that 27185377Ssam * follow must call back into the HAL through interface, supplying the 28185377Ssam * reference as the first parameter. 29185377Ssam */ 30185377Ssam 31185377Ssam#include "ah_osdep.h" 32185377Ssam 33185377Ssam/* 34220442Sadrian * The maximum number of TX/RX chains supported. 35220442Sadrian * This is intended to be used by various statistics gathering operations 36220442Sadrian * (NF, RSSI, EVM). 37220442Sadrian */ 38220442Sadrian#define AH_MIMO_MAX_CHAINS 3 39220442Sadrian#define AH_MIMO_MAX_EVM_PILOTS 6 40220442Sadrian 41220442Sadrian/* 42185377Ssam * __ahdecl is analogous to _cdecl; it defines the calling 43185377Ssam * convention used within the HAL. For most systems this 44185377Ssam * can just default to be empty and the compiler will (should) 45185377Ssam * use _cdecl. For systems where _cdecl is not compatible this 46185377Ssam * must be defined. See linux/ah_osdep.h for an example. 47185377Ssam */ 48185377Ssam#ifndef __ahdecl 49185377Ssam#define __ahdecl 50185377Ssam#endif 51185377Ssam 52185377Ssam/* 53185377Ssam * Status codes that may be returned by the HAL. Note that 54185377Ssam * interfaces that return a status code set it only when an 55185377Ssam * error occurs--i.e. you cannot check it for success. 56185377Ssam */ 57185377Ssamtypedef enum { 58185377Ssam HAL_OK = 0, /* No error */ 59185377Ssam HAL_ENXIO = 1, /* No hardware present */ 60185377Ssam HAL_ENOMEM = 2, /* Memory allocation failed */ 61185377Ssam HAL_EIO = 3, /* Hardware didn't respond as expected */ 62185377Ssam HAL_EEMAGIC = 4, /* EEPROM magic number invalid */ 63185377Ssam HAL_EEVERSION = 5, /* EEPROM version invalid */ 64185377Ssam HAL_EELOCKED = 6, /* EEPROM unreadable */ 65185377Ssam HAL_EEBADSUM = 7, /* EEPROM checksum invalid */ 66185377Ssam HAL_EEREAD = 8, /* EEPROM read problem */ 67185377Ssam HAL_EEBADMAC = 9, /* EEPROM mac address invalid */ 68185377Ssam HAL_EESIZE = 10, /* EEPROM size not supported */ 69185377Ssam HAL_EEWRITE = 11, /* Attempt to change write-locked EEPROM */ 70185377Ssam HAL_EINVAL = 12, /* Invalid parameter to function */ 71185377Ssam HAL_ENOTSUPP = 13, /* Hardware revision not supported */ 72185377Ssam HAL_ESELFTEST = 14, /* Hardware self-test failed */ 73185377Ssam HAL_EINPROGRESS = 15, /* Operation incomplete */ 74187831Ssam HAL_EEBADREG = 16, /* EEPROM invalid regulatory contents */ 75187831Ssam HAL_EEBADCC = 17, /* EEPROM invalid country code */ 76237874Sadrian HAL_INV_PMODE = 18, /* Couldn't bring out of sleep state */ 77185377Ssam} HAL_STATUS; 78185377Ssam 79185377Ssamtypedef enum { 80185377Ssam AH_FALSE = 0, /* NB: lots of code assumes false is zero */ 81185377Ssam AH_TRUE = 1, 82185377Ssam} HAL_BOOL; 83185377Ssam 84185377Ssamtypedef enum { 85185377Ssam HAL_CAP_REG_DMN = 0, /* current regulatory domain */ 86185377Ssam HAL_CAP_CIPHER = 1, /* hardware supports cipher */ 87185377Ssam HAL_CAP_TKIP_MIC = 2, /* handle TKIP MIC in hardware */ 88185377Ssam HAL_CAP_TKIP_SPLIT = 3, /* hardware TKIP uses split keys */ 89185377Ssam HAL_CAP_PHYCOUNTERS = 4, /* hardware PHY error counters */ 90185377Ssam HAL_CAP_DIVERSITY = 5, /* hardware supports fast diversity */ 91185377Ssam HAL_CAP_KEYCACHE_SIZE = 6, /* number of entries in key cache */ 92185377Ssam HAL_CAP_NUM_TXQUEUES = 7, /* number of hardware xmit queues */ 93185377Ssam HAL_CAP_VEOL = 9, /* hardware supports virtual EOL */ 94185377Ssam HAL_CAP_PSPOLL = 10, /* hardware has working PS-Poll support */ 95185377Ssam HAL_CAP_DIAG = 11, /* hardware diagnostic support */ 96185377Ssam HAL_CAP_COMPRESSION = 12, /* hardware supports compression */ 97185377Ssam HAL_CAP_BURST = 13, /* hardware supports packet bursting */ 98185377Ssam HAL_CAP_FASTFRAME = 14, /* hardware supoprts fast frames */ 99185377Ssam HAL_CAP_TXPOW = 15, /* global tx power limit */ 100185377Ssam HAL_CAP_TPC = 16, /* per-packet tx power control */ 101185377Ssam HAL_CAP_PHYDIAG = 17, /* hardware phy error diagnostic */ 102185377Ssam HAL_CAP_BSSIDMASK = 18, /* hardware supports bssid mask */ 103185377Ssam HAL_CAP_MCAST_KEYSRCH = 19, /* hardware has multicast key search */ 104185377Ssam HAL_CAP_TSF_ADJUST = 20, /* hardware has beacon tsf adjust */ 105185377Ssam /* 21 was HAL_CAP_XR */ 106185377Ssam HAL_CAP_WME_TKIPMIC = 22, /* hardware can support TKIP MIC when WMM is turned on */ 107185380Ssam /* 23 was HAL_CAP_CHAN_HALFRATE */ 108185380Ssam /* 24 was HAL_CAP_CHAN_QUARTERRATE */ 109185377Ssam HAL_CAP_RFSILENT = 25, /* hardware has rfsilent support */ 110185377Ssam HAL_CAP_TPC_ACK = 26, /* ack txpower with per-packet tpc */ 111185377Ssam HAL_CAP_TPC_CTS = 27, /* cts txpower with per-packet tpc */ 112185377Ssam HAL_CAP_11D = 28, /* 11d beacon support for changing cc */ 113237953Sadrian HAL_CAP_PCIE_PS = 29, 114221603Sadrian HAL_CAP_HT = 30, /* hardware can support HT */ 115221603Sadrian HAL_CAP_GTXTO = 31, /* hardware supports global tx timeout */ 116221603Sadrian HAL_CAP_FAST_CC = 32, /* hardware supports fast channel change */ 117221603Sadrian HAL_CAP_TX_CHAINMASK = 33, /* mask of TX chains supported */ 118221603Sadrian HAL_CAP_RX_CHAINMASK = 34, /* mask of RX chains supported */ 119221603Sadrian HAL_CAP_NUM_GPIO_PINS = 36, /* number of GPIO pins */ 120221581Sadrian 121221603Sadrian HAL_CAP_CST = 38, /* hardware supports carrier sense timeout */ 122221581Sadrian 123237953Sadrian HAL_CAP_RIFS_RX = 39, 124237953Sadrian HAL_CAP_RIFS_TX = 40, 125237953Sadrian HAL_CAP_FORCE_PPM = 41, 126221603Sadrian HAL_CAP_RTS_AGGR_LIMIT = 42, /* aggregation limit with RTS */ 127221603Sadrian HAL_CAP_4ADDR_AGGR = 43, /* hardware is capable of 4addr aggregation */ 128222584Sadrian HAL_CAP_DFS_DMN = 44, /* current DFS domain */ 129222584Sadrian HAL_CAP_EXT_CHAN_DFS = 45, /* DFS support for extension channel */ 130222584Sadrian HAL_CAP_COMBINED_RADAR_RSSI = 46, /* Is combined RSSI for radar accurate */ 131221603Sadrian 132221603Sadrian HAL_CAP_AUTO_SLEEP = 48, /* hardware can go to network sleep 133221603Sadrian automatically after waking up to receive TIM */ 134221603Sadrian HAL_CAP_MBSSID_AGGR_SUPPORT = 49, /* Support for mBSSID Aggregation */ 135221603Sadrian HAL_CAP_SPLIT_4KB_TRANS = 50, /* hardware supports descriptors straddling a 4k page boundary */ 136221603Sadrian HAL_CAP_REG_FLAG = 51, /* Regulatory domain flags */ 137237953Sadrian HAL_CAP_BB_RIFS_HANG = 52, 138237953Sadrian HAL_CAP_RIFS_RX_ENABLED = 53, 139237953Sadrian HAL_CAP_BB_DFS_HANG = 54, 140221603Sadrian 141221603Sadrian HAL_CAP_BT_COEX = 60, /* hardware is capable of bluetooth coexistence */ 142237953Sadrian HAL_CAP_DYNAMIC_SMPS = 61, /* Dynamic MIMO Power Save hardware support */ 143221603Sadrian 144237953Sadrian HAL_CAP_DS = 67, /* 2 stream */ 145237953Sadrian HAL_CAP_BB_RX_CLEAR_STUCK_HANG = 68, 146237953Sadrian HAL_CAP_MAC_HANG = 69, /* can MAC hang */ 147237955Sadrian HAL_CAP_MFP = 70, /* Management Frame Protection in hardware */ 148237953Sadrian 149237953Sadrian HAL_CAP_TS = 72, /* 3 stream */ 150237953Sadrian 151237953Sadrian HAL_CAP_ENHANCED_DMA_SUPPORT = 75, /* DMA FIFO support */ 152238280Sadrian HAL_CAP_NUM_TXMAPS = 76, /* Number of buffers in a transmit descriptor */ 153238280Sadrian HAL_CAP_TXDESCLEN = 77, /* Length of transmit descriptor */ 154238280Sadrian HAL_CAP_TXSTATUSLEN = 78, /* Length of transmit status descriptor */ 155238280Sadrian HAL_CAP_RXSTATUSLEN = 79, /* Length of transmit status descriptor */ 156238280Sadrian HAL_CAP_RXFIFODEPTH = 80, /* Receive hardware FIFO depth */ 157238280Sadrian HAL_CAP_RXBUFSIZE = 81, /* Receive Buffer Length */ 158238280Sadrian HAL_CAP_NUM_MR_RETRIES = 82, /* limit on multirate retries */ 159237953Sadrian 160237953Sadrian HAL_CAP_OL_PWRCTRL = 84, /* Open loop TX power control */ 161237953Sadrian 162237953Sadrian HAL_CAP_BB_PANIC_WATCHDOG = 92, 163237953Sadrian 164221603Sadrian HAL_CAP_HT20_SGI = 96, /* hardware supports HT20 short GI */ 165221603Sadrian 166239631Sadrian HAL_CAP_LDPC = 99, 167239631Sadrian 168221603Sadrian HAL_CAP_RXTSTAMP_PREC = 100, /* rx desc tstamp precision (bits) */ 169239631Sadrian 170239631Sadrian HAL_CAP_PHYRESTART_CLR_WAR = 106, /* in some cases, clear phy restart to fix bb hang */ 171239631Sadrian HAL_CAP_ENTERPRISE_MODE = 107, /* Enterprise mode features */ 172239631Sadrian HAL_CAP_LDPCWAR = 108, 173239631Sadrian HAL_CAP_CHANNEL_SWITCH_TIME_USEC = 109, /* Channel change time, usec */ 174239631Sadrian HAL_CAP_ENABLE_APM = 110, /* APM enabled */ 175239631Sadrian HAL_CAP_PCIE_LCR_EXTSYNC_EN = 111, 176239631Sadrian HAL_CAP_PCIE_LCR_OFFSET = 112, 177239631Sadrian 178222584Sadrian HAL_CAP_ENHANCED_DFS_SUPPORT = 117, /* hardware supports enhanced DFS */ 179239632Sadrian HAL_CAP_MCI = 118, 180239632Sadrian HAL_CAP_SMARTANTENNA = 119, 181239632Sadrian HAL_CAP_TRAFFIC_FAST_RECOVER = 120, 182239632Sadrian HAL_CAP_TX_DIVERSITY = 121, 183239632Sadrian HAL_CAP_CRDC = 122, 184221603Sadrian 185221581Sadrian /* The following are private to the FreeBSD HAL (224 onward) */ 186221581Sadrian 187221603Sadrian HAL_CAP_INTMIT = 229, /* interference mitigation */ 188221603Sadrian HAL_CAP_RXORN_FATAL = 230, /* HAL_INT_RXORN treated as fatal */ 189221603Sadrian HAL_CAP_BB_HANG = 235, /* can baseband hang */ 190221603Sadrian HAL_CAP_INTRMASK = 237, /* bitmask of supported interrupts */ 191221603Sadrian HAL_CAP_BSSIDMATCH = 238, /* hardware has disable bssid match */ 192221603Sadrian HAL_CAP_STREAMS = 239, /* how many 802.11n spatial streams are available */ 193221603Sadrian HAL_CAP_RXDESC_SELFLINK = 242, /* support a self-linked tail RX descriptor */ 194225444Sadrian HAL_CAP_LONG_RXDESC_TSF = 243, /* hardware supports 32bit TSF in RX descriptor */ 195226488Sadrian HAL_CAP_BB_READ_WAR = 244, /* baseband read WAR */ 196227410Sadrian HAL_CAP_SERIALISE_WAR = 245, /* serialise register access on PCI */ 197185377Ssam} HAL_CAPABILITY_TYPE; 198185377Ssam 199185377Ssam/* 200185377Ssam * "States" for setting the LED. These correspond to 201185377Ssam * the possible 802.11 operational states and there may 202185377Ssam * be a many-to-one mapping between these states and the 203185377Ssam * actual hardware state for the LED's (i.e. the hardware 204185377Ssam * may have fewer states). 205185377Ssam */ 206185377Ssamtypedef enum { 207185377Ssam HAL_LED_INIT = 0, 208185377Ssam HAL_LED_SCAN = 1, 209185377Ssam HAL_LED_AUTH = 2, 210185377Ssam HAL_LED_ASSOC = 3, 211185377Ssam HAL_LED_RUN = 4 212185377Ssam} HAL_LED_STATE; 213185377Ssam 214185377Ssam/* 215185377Ssam * Transmit queue types/numbers. These are used to tag 216185377Ssam * each transmit queue in the hardware and to identify a set 217185377Ssam * of transmit queues for operations such as start/stop dma. 218185377Ssam */ 219185377Ssamtypedef enum { 220185377Ssam HAL_TX_QUEUE_INACTIVE = 0, /* queue is inactive/unused */ 221185377Ssam HAL_TX_QUEUE_DATA = 1, /* data xmit q's */ 222185377Ssam HAL_TX_QUEUE_BEACON = 2, /* beacon xmit q */ 223185377Ssam HAL_TX_QUEUE_CAB = 3, /* "crap after beacon" xmit q */ 224185377Ssam HAL_TX_QUEUE_UAPSD = 4, /* u-apsd power save xmit q */ 225219790Sadrian HAL_TX_QUEUE_PSPOLL = 5, /* power save poll xmit q */ 226237874Sadrian HAL_TX_QUEUE_CFEND = 6, 227237874Sadrian HAL_TX_QUEUE_PAPRD = 7, 228185377Ssam} HAL_TX_QUEUE; 229185377Ssam 230185377Ssam#define HAL_NUM_TX_QUEUES 10 /* max possible # of queues */ 231185377Ssam 232237874Sadriantypedef enum { 233237874Sadrian HAL_RX_QUEUE_HP = 0, /* high priority recv queue */ 234238280Sadrian HAL_RX_QUEUE_LP = 1, /* low priority recv queue */ 235237874Sadrian} HAL_RX_QUEUE; 236237874Sadrian 237237874Sadrian#define HAL_NUM_RX_QUEUES 2 /* max possible # of queues */ 238237874Sadrian 239238857Sadrian#define HAL_TXFIFO_DEPTH 8 /* transmit fifo depth */ 240238857Sadrian 241185377Ssam/* 242185377Ssam * Transmit queue subtype. These map directly to 243185377Ssam * WME Access Categories (except for UPSD). Refer 244185377Ssam * to Table 5 of the WME spec. 245185377Ssam */ 246185377Ssamtypedef enum { 247185377Ssam HAL_WME_AC_BK = 0, /* background access category */ 248185377Ssam HAL_WME_AC_BE = 1, /* best effort access category*/ 249185377Ssam HAL_WME_AC_VI = 2, /* video access category */ 250185377Ssam HAL_WME_AC_VO = 3, /* voice access category */ 251185377Ssam HAL_WME_UPSD = 4, /* uplink power save */ 252185377Ssam} HAL_TX_QUEUE_SUBTYPE; 253185377Ssam 254185377Ssam/* 255185377Ssam * Transmit queue flags that control various 256185377Ssam * operational parameters. 257185377Ssam */ 258185377Ssamtypedef enum { 259185377Ssam /* 260185377Ssam * Per queue interrupt enables. When set the associated 261185377Ssam * interrupt may be delivered for packets sent through 262185377Ssam * the queue. Without these enabled no interrupts will 263185377Ssam * be delivered for transmits through the queue. 264185377Ssam */ 265185377Ssam HAL_TXQ_TXOKINT_ENABLE = 0x0001, /* enable TXOK interrupt */ 266185377Ssam HAL_TXQ_TXERRINT_ENABLE = 0x0001, /* enable TXERR interrupt */ 267185377Ssam HAL_TXQ_TXDESCINT_ENABLE = 0x0002, /* enable TXDESC interrupt */ 268185377Ssam HAL_TXQ_TXEOLINT_ENABLE = 0x0004, /* enable TXEOL interrupt */ 269185377Ssam HAL_TXQ_TXURNINT_ENABLE = 0x0008, /* enable TXURN interrupt */ 270185377Ssam /* 271185377Ssam * Enable hardware compression for packets sent through 272185377Ssam * the queue. The compression buffer must be setup and 273185377Ssam * packets must have a key entry marked in the tx descriptor. 274185377Ssam */ 275185377Ssam HAL_TXQ_COMPRESSION_ENABLE = 0x0010, /* enable h/w compression */ 276185377Ssam /* 277185377Ssam * Disable queue when veol is hit or ready time expires. 278185377Ssam * By default the queue is disabled only on reaching the 279185377Ssam * physical end of queue (i.e. a null link ptr in the 280185377Ssam * descriptor chain). 281185377Ssam */ 282185377Ssam HAL_TXQ_RDYTIME_EXP_POLICY_ENABLE = 0x0020, 283185377Ssam /* 284185377Ssam * Schedule frames on delivery of a DBA (DMA Beacon Alert) 285185377Ssam * event. Frames will be transmitted only when this timer 286185377Ssam * fires, e.g to transmit a beacon in ap or adhoc modes. 287185377Ssam */ 288185377Ssam HAL_TXQ_DBA_GATED = 0x0040, /* schedule based on DBA */ 289185377Ssam /* 290185377Ssam * Each transmit queue has a counter that is incremented 291185377Ssam * each time the queue is enabled and decremented when 292185377Ssam * the list of frames to transmit is traversed (or when 293185377Ssam * the ready time for the queue expires). This counter 294185377Ssam * must be non-zero for frames to be scheduled for 295185377Ssam * transmission. The following controls disable bumping 296185377Ssam * this counter under certain conditions. Typically this 297185377Ssam * is used to gate frames based on the contents of another 298185377Ssam * queue (e.g. CAB traffic may only follow a beacon frame). 299185377Ssam * These are meaningful only when frames are scheduled 300185377Ssam * with a non-ASAP policy (e.g. DBA-gated). 301185377Ssam */ 302185377Ssam HAL_TXQ_CBR_DIS_QEMPTY = 0x0080, /* disable on this q empty */ 303185377Ssam HAL_TXQ_CBR_DIS_BEMPTY = 0x0100, /* disable on beacon q empty */ 304185377Ssam 305185377Ssam /* 306185377Ssam * Fragment burst backoff policy. Normally the no backoff 307185377Ssam * is done after a successful transmission, the next fragment 308185377Ssam * is sent at SIFS. If this flag is set backoff is done 309185377Ssam * after each fragment, regardless whether it was ack'd or 310185377Ssam * not, after the backoff count reaches zero a normal channel 311185377Ssam * access procedure is done before the next transmit (i.e. 312185377Ssam * wait AIFS instead of SIFS). 313185377Ssam */ 314185377Ssam HAL_TXQ_FRAG_BURST_BACKOFF_ENABLE = 0x00800000, 315185377Ssam /* 316185377Ssam * Disable post-tx backoff following each frame. 317185377Ssam */ 318185377Ssam HAL_TXQ_BACKOFF_DISABLE = 0x00010000, /* disable post backoff */ 319185377Ssam /* 320185377Ssam * DCU arbiter lockout control. This controls how 321185377Ssam * lower priority tx queues are handled with respect to 322185377Ssam * to a specific queue when multiple queues have frames 323185377Ssam * to send. No lockout means lower priority queues arbitrate 324185377Ssam * concurrently with this queue. Intra-frame lockout 325185377Ssam * means lower priority queues are locked out until the 326185377Ssam * current frame transmits (e.g. including backoffs and bursting). 327185377Ssam * Global lockout means nothing lower can arbitrary so 328185377Ssam * long as there is traffic activity on this queue (frames, 329185377Ssam * backoff, etc). 330185377Ssam */ 331185377Ssam HAL_TXQ_ARB_LOCKOUT_INTRA = 0x00020000, /* intra-frame lockout */ 332185377Ssam HAL_TXQ_ARB_LOCKOUT_GLOBAL = 0x00040000, /* full lockout s */ 333185377Ssam 334185377Ssam HAL_TXQ_IGNORE_VIRTCOL = 0x00080000, /* ignore virt collisions */ 335185377Ssam HAL_TXQ_SEQNUM_INC_DIS = 0x00100000, /* disable seqnum increment */ 336185377Ssam} HAL_TX_QUEUE_FLAGS; 337185377Ssam 338185377Ssamtypedef struct { 339185377Ssam uint32_t tqi_ver; /* hal TXQ version */ 340185377Ssam HAL_TX_QUEUE_SUBTYPE tqi_subtype; /* subtype if applicable */ 341185377Ssam HAL_TX_QUEUE_FLAGS tqi_qflags; /* flags (see above) */ 342185377Ssam uint32_t tqi_priority; /* (not used) */ 343185377Ssam uint32_t tqi_aifs; /* aifs */ 344185377Ssam uint32_t tqi_cwmin; /* cwMin */ 345185377Ssam uint32_t tqi_cwmax; /* cwMax */ 346185377Ssam uint16_t tqi_shretry; /* rts retry limit */ 347185377Ssam uint16_t tqi_lgretry; /* long retry limit (not used)*/ 348185377Ssam uint32_t tqi_cbrPeriod; /* CBR period (us) */ 349185377Ssam uint32_t tqi_cbrOverflowLimit; /* threshold for CBROVF int */ 350185377Ssam uint32_t tqi_burstTime; /* max burst duration (us) */ 351185377Ssam uint32_t tqi_readyTime; /* frame schedule time (us) */ 352185377Ssam uint32_t tqi_compBuf; /* comp buffer phys addr */ 353185377Ssam} HAL_TXQ_INFO; 354185377Ssam 355185377Ssam#define HAL_TQI_NONVAL 0xffff 356185377Ssam 357185377Ssam/* token to use for aifs, cwmin, cwmax */ 358185377Ssam#define HAL_TXQ_USEDEFAULT ((uint32_t) -1) 359185377Ssam 360185377Ssam/* compression definitions */ 361185377Ssam#define HAL_COMP_BUF_MAX_SIZE 9216 /* 9K */ 362185377Ssam#define HAL_COMP_BUF_ALIGN_SIZE 512 363185377Ssam 364185377Ssam/* 365185377Ssam * Transmit packet types. This belongs in ah_desc.h, but 366185377Ssam * is here so we can give a proper type to various parameters 367185377Ssam * (and not require everyone include the file). 368185377Ssam * 369185377Ssam * NB: These values are intentionally assigned for 370185377Ssam * direct use when setting up h/w descriptors. 371185377Ssam */ 372185377Ssamtypedef enum { 373185377Ssam HAL_PKT_TYPE_NORMAL = 0, 374185377Ssam HAL_PKT_TYPE_ATIM = 1, 375185377Ssam HAL_PKT_TYPE_PSPOLL = 2, 376185377Ssam HAL_PKT_TYPE_BEACON = 3, 377185377Ssam HAL_PKT_TYPE_PROBE_RESP = 4, 378185377Ssam HAL_PKT_TYPE_CHIRP = 5, 379185377Ssam HAL_PKT_TYPE_GRP_POLL = 6, 380185377Ssam HAL_PKT_TYPE_AMPDU = 7, 381185377Ssam} HAL_PKT_TYPE; 382185377Ssam 383185377Ssam/* Rx Filter Frame Types */ 384185377Ssamtypedef enum { 385220022Sadrian /* 386220022Sadrian * These bits correspond to AR_RX_FILTER for all chips. 387220022Sadrian * Not all bits are supported by all chips. 388220022Sadrian */ 389185377Ssam HAL_RX_FILTER_UCAST = 0x00000001, /* Allow unicast frames */ 390185377Ssam HAL_RX_FILTER_MCAST = 0x00000002, /* Allow multicast frames */ 391185377Ssam HAL_RX_FILTER_BCAST = 0x00000004, /* Allow broadcast frames */ 392185377Ssam HAL_RX_FILTER_CONTROL = 0x00000008, /* Allow control frames */ 393185377Ssam HAL_RX_FILTER_BEACON = 0x00000010, /* Allow beacon frames */ 394185377Ssam HAL_RX_FILTER_PROM = 0x00000020, /* Promiscuous mode */ 395185377Ssam HAL_RX_FILTER_PROBEREQ = 0x00000080, /* Allow probe request frames */ 396220025Sadrian HAL_RX_FILTER_PHYERR = 0x00000100, /* Allow phy errors */ 397185377Ssam HAL_RX_FILTER_COMPBAR = 0x00000400, /* Allow compressed BAR */ 398220022Sadrian HAL_RX_FILTER_COMP_BA = 0x00000800, /* Allow compressed blockack */ 399220025Sadrian HAL_RX_FILTER_PHYRADAR = 0x00002000, /* Allow phy radar errors */ 400220022Sadrian HAL_RX_FILTER_PSPOLL = 0x00004000, /* Allow PS-POLL frames */ 401220022Sadrian HAL_RX_FILTER_MCAST_BCAST_ALL = 0x00008000, 402220022Sadrian /* Allow all mcast/bcast frames */ 403220022Sadrian 404220022Sadrian /* 405220022Sadrian * Magic RX filter flags that aren't targetting hardware bits 406220022Sadrian * but instead the HAL sets individual bits - eg PHYERR will result 407220022Sadrian * in OFDM/CCK timing error frames being received. 408220022Sadrian */ 409220022Sadrian HAL_RX_FILTER_BSSID = 0x40000000, /* Disable BSSID match */ 410185377Ssam} HAL_RX_FILTER; 411185377Ssam 412185377Ssamtypedef enum { 413185377Ssam HAL_PM_AWAKE = 0, 414185377Ssam HAL_PM_FULL_SLEEP = 1, 415185377Ssam HAL_PM_NETWORK_SLEEP = 2, 416185377Ssam HAL_PM_UNDEFINED = 3 417185377Ssam} HAL_POWER_MODE; 418185377Ssam 419185377Ssam/* 420185377Ssam * NOTE WELL: 421185377Ssam * These are mapped to take advantage of the common locations for many of 422185377Ssam * the bits on all of the currently supported MAC chips. This is to make 423185377Ssam * the ISR as efficient as possible, while still abstracting HW differences. 424185377Ssam * When new hardware breaks this commonality this enumerated type, as well 425185377Ssam * as the HAL functions using it, must be modified. All values are directly 426185377Ssam * mapped unless commented otherwise. 427185377Ssam */ 428185377Ssamtypedef enum { 429185377Ssam HAL_INT_RX = 0x00000001, /* Non-common mapping */ 430238349Sadrian HAL_INT_RXDESC = 0x00000002, /* Legacy mapping */ 431239605Sadrian HAL_INT_RXERR = 0x00000004, 432238349Sadrian HAL_INT_RXHP = 0x00000001, /* EDMA */ 433238349Sadrian HAL_INT_RXLP = 0x00000002, /* EDMA */ 434185377Ssam HAL_INT_RXNOFRM = 0x00000008, 435185377Ssam HAL_INT_RXEOL = 0x00000010, 436185377Ssam HAL_INT_RXORN = 0x00000020, 437185377Ssam HAL_INT_TX = 0x00000040, /* Non-common mapping */ 438185377Ssam HAL_INT_TXDESC = 0x00000080, 439208711Srpaulo HAL_INT_TIM_TIMER= 0x00000100, 440239605Sadrian HAL_INT_MCI = 0x00000200, 441239605Sadrian HAL_INT_BBPANIC = 0x00000400, 442185377Ssam HAL_INT_TXURN = 0x00000800, 443185377Ssam HAL_INT_MIB = 0x00001000, 444185377Ssam HAL_INT_RXPHY = 0x00004000, 445185377Ssam HAL_INT_RXKCM = 0x00008000, 446185377Ssam HAL_INT_SWBA = 0x00010000, 447239605Sadrian HAL_INT_BRSSI = 0x00020000, 448185377Ssam HAL_INT_BMISS = 0x00040000, 449192401Ssam HAL_INT_BNR = 0x00100000, 450185377Ssam HAL_INT_TIM = 0x00200000, /* Non-common mapping */ 451185377Ssam HAL_INT_DTIM = 0x00400000, /* Non-common mapping */ 452185377Ssam HAL_INT_DTIMSYNC= 0x00800000, /* Non-common mapping */ 453185377Ssam HAL_INT_GPIO = 0x01000000, 454185377Ssam HAL_INT_CABEND = 0x02000000, /* Non-common mapping */ 455185377Ssam HAL_INT_TSFOOR = 0x04000000, /* Non-common mapping */ 456192400Ssam HAL_INT_TBTT = 0x08000000, /* Non-common mapping */ 457239605Sadrian /* Atheros ref driver has a generic timer interrupt now..*/ 458239605Sadrian HAL_INT_GENTIMER = 0x08000000, /* Non-common mapping */ 459185377Ssam HAL_INT_CST = 0x10000000, /* Non-common mapping */ 460185377Ssam HAL_INT_GTT = 0x20000000, /* Non-common mapping */ 461185377Ssam HAL_INT_FATAL = 0x40000000, /* Non-common mapping */ 462185377Ssam#define HAL_INT_GLOBAL 0x80000000 /* Set/clear IER */ 463185377Ssam HAL_INT_BMISC = HAL_INT_TIM 464185377Ssam | HAL_INT_DTIM 465185377Ssam | HAL_INT_DTIMSYNC 466192400Ssam | HAL_INT_CABEND 467192400Ssam | HAL_INT_TBTT, 468185377Ssam 469185377Ssam /* Interrupt bits that map directly to ISR/IMR bits */ 470185377Ssam HAL_INT_COMMON = HAL_INT_RXNOFRM 471185377Ssam | HAL_INT_RXDESC 472185377Ssam | HAL_INT_RXEOL 473185377Ssam | HAL_INT_RXORN 474192396Ssam | HAL_INT_TXDESC 475185377Ssam | HAL_INT_TXURN 476185377Ssam | HAL_INT_MIB 477185377Ssam | HAL_INT_RXPHY 478185377Ssam | HAL_INT_RXKCM 479185377Ssam | HAL_INT_SWBA 480185377Ssam | HAL_INT_BMISS 481239605Sadrian | HAL_INT_BRSSI 482192397Ssam | HAL_INT_BNR 483185377Ssam | HAL_INT_GPIO, 484185377Ssam} HAL_INT; 485185377Ssam 486237622Sadrian/* 487237622Sadrian * MSI vector assignments 488237622Sadrian */ 489185377Ssamtypedef enum { 490237622Sadrian HAL_MSIVEC_MISC = 0, 491237622Sadrian HAL_MSIVEC_TX = 1, 492237622Sadrian HAL_MSIVEC_RXLP = 2, 493237622Sadrian HAL_MSIVEC_RXHP = 3, 494237622Sadrian} HAL_MSIVEC; 495237622Sadrian 496237622Sadriantypedef enum { 497237622Sadrian HAL_INT_LINE = 0, 498237622Sadrian HAL_INT_MSI = 1, 499237622Sadrian} HAL_INT_TYPE; 500237622Sadrian 501237622Sadrian/* For interrupt mitigation registers */ 502237622Sadriantypedef enum { 503237622Sadrian HAL_INT_RX_FIRSTPKT=0, 504237622Sadrian HAL_INT_RX_LASTPKT, 505237622Sadrian HAL_INT_TX_FIRSTPKT, 506237622Sadrian HAL_INT_TX_LASTPKT, 507237622Sadrian HAL_INT_THRESHOLD 508237622Sadrian} HAL_INT_MITIGATION; 509237622Sadrian 510237622Sadriantypedef enum { 511237611Sadrian HAL_GPIO_OUTPUT_MUX_AS_OUTPUT = 0, 512237611Sadrian HAL_GPIO_OUTPUT_MUX_PCIE_ATTENTION_LED = 1, 513237611Sadrian HAL_GPIO_OUTPUT_MUX_PCIE_POWER_LED = 2, 514237611Sadrian HAL_GPIO_OUTPUT_MUX_MAC_NETWORK_LED = 3, 515237611Sadrian HAL_GPIO_OUTPUT_MUX_MAC_POWER_LED = 4, 516237611Sadrian HAL_GPIO_OUTPUT_MUX_AS_WLAN_ACTIVE = 5, 517237611Sadrian HAL_GPIO_OUTPUT_MUX_AS_TX_FRAME = 6 518188974Ssam} HAL_GPIO_MUX_TYPE; 519188974Ssam 520188974Ssamtypedef enum { 521188974Ssam HAL_GPIO_INTR_LOW = 0, 522188974Ssam HAL_GPIO_INTR_HIGH = 1, 523188974Ssam HAL_GPIO_INTR_DISABLE = 2 524188974Ssam} HAL_GPIO_INTR_TYPE; 525188974Ssam 526188974Ssamtypedef enum { 527185377Ssam HAL_RFGAIN_INACTIVE = 0, 528185377Ssam HAL_RFGAIN_READ_REQUESTED = 1, 529185377Ssam HAL_RFGAIN_NEED_CHANGE = 2 530185377Ssam} HAL_RFGAIN; 531185377Ssam 532187831Ssamtypedef uint16_t HAL_CTRY_CODE; /* country code */ 533187831Ssamtypedef uint16_t HAL_REG_DOMAIN; /* regulatory domain code */ 534185377Ssam 535185377Ssam#define HAL_ANTENNA_MIN_MODE 0 536185377Ssam#define HAL_ANTENNA_FIXED_A 1 537185377Ssam#define HAL_ANTENNA_FIXED_B 2 538185377Ssam#define HAL_ANTENNA_MAX_MODE 3 539185377Ssam 540185377Ssamtypedef struct { 541185377Ssam uint32_t ackrcv_bad; 542185377Ssam uint32_t rts_bad; 543185377Ssam uint32_t rts_good; 544185377Ssam uint32_t fcs_bad; 545185377Ssam uint32_t beacons; 546185377Ssam} HAL_MIB_STATS; 547185377Ssam 548185377Ssamenum { 549185377Ssam HAL_MODE_11A = 0x001, /* 11a channels */ 550185377Ssam HAL_MODE_TURBO = 0x002, /* 11a turbo-only channels */ 551185377Ssam HAL_MODE_11B = 0x004, /* 11b channels */ 552185377Ssam HAL_MODE_PUREG = 0x008, /* 11g channels (OFDM only) */ 553185377Ssam#ifdef notdef 554185377Ssam HAL_MODE_11G = 0x010, /* 11g channels (OFDM/CCK) */ 555185377Ssam#else 556185377Ssam HAL_MODE_11G = 0x008, /* XXX historical */ 557185377Ssam#endif 558185377Ssam HAL_MODE_108G = 0x020, /* 11g+Turbo channels */ 559185377Ssam HAL_MODE_108A = 0x040, /* 11a+Turbo channels */ 560185380Ssam HAL_MODE_11A_HALF_RATE = 0x200, /* 11a half width channels */ 561185380Ssam HAL_MODE_11A_QUARTER_RATE = 0x400, /* 11a quarter width channels */ 562185380Ssam HAL_MODE_11G_HALF_RATE = 0x800, /* 11g half width channels */ 563185380Ssam HAL_MODE_11G_QUARTER_RATE = 0x1000, /* 11g quarter width channels */ 564185377Ssam HAL_MODE_11NG_HT20 = 0x008000, 565185377Ssam HAL_MODE_11NA_HT20 = 0x010000, 566185377Ssam HAL_MODE_11NG_HT40PLUS = 0x020000, 567185377Ssam HAL_MODE_11NG_HT40MINUS = 0x040000, 568185377Ssam HAL_MODE_11NA_HT40PLUS = 0x080000, 569185377Ssam HAL_MODE_11NA_HT40MINUS = 0x100000, 570185377Ssam HAL_MODE_ALL = 0xffffff 571185377Ssam}; 572185377Ssam 573185377Ssamtypedef struct { 574185377Ssam int rateCount; /* NB: for proper padding */ 575239289Sadrian uint8_t rateCodeToIndex[256]; /* back mapping */ 576185377Ssam struct { 577188770Ssam uint8_t valid; /* valid for rate control use */ 578188770Ssam uint8_t phy; /* CCK/OFDM/XR */ 579185377Ssam uint32_t rateKbps; /* transfer rate in kbs */ 580185377Ssam uint8_t rateCode; /* rate for h/w descriptors */ 581185377Ssam uint8_t shortPreamble; /* mask for enabling short 582185377Ssam * preamble in CCK rate code */ 583185377Ssam uint8_t dot11Rate; /* value for supported rates 584185377Ssam * info element of MLME */ 585185377Ssam uint8_t controlRate; /* index of next lower basic 586185377Ssam * rate; used for dur. calcs */ 587185377Ssam uint16_t lpAckDuration; /* long preamble ACK duration */ 588185377Ssam uint16_t spAckDuration; /* short preamble ACK duration*/ 589239289Sadrian } info[64]; 590185377Ssam} HAL_RATE_TABLE; 591185377Ssam 592185377Ssamtypedef struct { 593185377Ssam u_int rs_count; /* number of valid entries */ 594239289Sadrian uint8_t rs_rates[64]; /* rates */ 595185377Ssam} HAL_RATE_SET; 596185377Ssam 597185377Ssam/* 598185377Ssam * 802.11n specific structures and enums 599185377Ssam */ 600185377Ssamtypedef enum { 601185377Ssam HAL_CHAINTYPE_TX = 1, /* Tx chain type */ 602185377Ssam HAL_CHAINTYPE_RX = 2, /* RX chain type */ 603185377Ssam} HAL_CHAIN_TYPE; 604185377Ssam 605185377Ssamtypedef struct { 606185377Ssam u_int Tries; 607238840Sadrian u_int Rate; /* hardware rate code */ 608238840Sadrian u_int RateIndex; /* rate series table index */ 609185377Ssam u_int PktDuration; 610185377Ssam u_int ChSel; 611185377Ssam u_int RateFlags; 612185377Ssam#define HAL_RATESERIES_RTS_CTS 0x0001 /* use rts/cts w/this series */ 613185377Ssam#define HAL_RATESERIES_2040 0x0002 /* use ext channel for series */ 614185377Ssam#define HAL_RATESERIES_HALFGI 0x0004 /* use half-gi for series */ 615238841Sadrian#define HAL_RATESERIES_STBC 0x0008 /* use STBC for series */ 616238839Sadrian u_int tx_power_cap; 617185377Ssam} HAL_11N_RATE_SERIES; 618185377Ssam 619185377Ssamtypedef enum { 620185377Ssam HAL_HT_MACMODE_20 = 0, /* 20 MHz operation */ 621185377Ssam HAL_HT_MACMODE_2040 = 1, /* 20/40 MHz operation */ 622185377Ssam} HAL_HT_MACMODE; 623185377Ssam 624185377Ssamtypedef enum { 625185377Ssam HAL_HT_PHYMODE_20 = 0, /* 20 MHz operation */ 626185377Ssam HAL_HT_PHYMODE_2040 = 1, /* 20/40 MHz operation */ 627185377Ssam} HAL_HT_PHYMODE; 628185377Ssam 629185377Ssamtypedef enum { 630185377Ssam HAL_HT_EXTPROTSPACING_20 = 0, /* 20 MHz spacing */ 631185377Ssam HAL_HT_EXTPROTSPACING_25 = 1, /* 25 MHz spacing */ 632185377Ssam} HAL_HT_EXTPROTSPACING; 633185377Ssam 634185377Ssam 635185377Ssamtypedef enum { 636185377Ssam HAL_RX_CLEAR_CTL_LOW = 0x1, /* force control channel to appear busy */ 637185377Ssam HAL_RX_CLEAR_EXT_LOW = 0x2, /* force extension channel to appear busy */ 638185377Ssam} HAL_HT_RXCLEAR; 639185377Ssam 640185377Ssam/* 641185377Ssam * Antenna switch control. By default antenna selection 642185377Ssam * enables multiple (2) antenna use. To force use of the 643185377Ssam * A or B antenna only specify a fixed setting. Fixing 644185377Ssam * the antenna will also disable any diversity support. 645185377Ssam */ 646185377Ssamtypedef enum { 647185377Ssam HAL_ANT_VARIABLE = 0, /* variable by programming */ 648185377Ssam HAL_ANT_FIXED_A = 1, /* fixed antenna A */ 649185377Ssam HAL_ANT_FIXED_B = 2, /* fixed antenna B */ 650185377Ssam} HAL_ANT_SETTING; 651185377Ssam 652185377Ssamtypedef enum { 653185377Ssam HAL_M_STA = 1, /* infrastructure station */ 654185377Ssam HAL_M_IBSS = 0, /* IBSS (adhoc) station */ 655185377Ssam HAL_M_HOSTAP = 6, /* Software Access Point */ 656185377Ssam HAL_M_MONITOR = 8 /* Monitor mode */ 657185377Ssam} HAL_OPMODE; 658185377Ssam 659185377Ssamtypedef struct { 660185377Ssam uint8_t kv_type; /* one of HAL_CIPHER */ 661237874Sadrian uint8_t kv_apsd; /* Mask for APSD enabled ACs */ 662185377Ssam uint16_t kv_len; /* length in bits */ 663185377Ssam uint8_t kv_val[16]; /* enough for 128-bit keys */ 664185377Ssam uint8_t kv_mic[8]; /* TKIP MIC key */ 665185377Ssam uint8_t kv_txmic[8]; /* TKIP TX MIC key (optional) */ 666185377Ssam} HAL_KEYVAL; 667185377Ssam 668185377Ssamtypedef enum { 669185377Ssam HAL_CIPHER_WEP = 0, 670185377Ssam HAL_CIPHER_AES_OCB = 1, 671185377Ssam HAL_CIPHER_AES_CCM = 2, 672185377Ssam HAL_CIPHER_CKIP = 3, 673185377Ssam HAL_CIPHER_TKIP = 4, 674185377Ssam HAL_CIPHER_CLR = 5, /* no encryption */ 675185377Ssam 676185377Ssam HAL_CIPHER_MIC = 127 /* TKIP-MIC, not a cipher */ 677185377Ssam} HAL_CIPHER; 678185377Ssam 679185377Ssamenum { 680185377Ssam HAL_SLOT_TIME_6 = 6, /* NB: for turbo mode */ 681185377Ssam HAL_SLOT_TIME_9 = 9, 682185377Ssam HAL_SLOT_TIME_20 = 20, 683185377Ssam}; 684185377Ssam 685185377Ssam/* 686185377Ssam * Per-station beacon timer state. Note that the specified 687185377Ssam * beacon interval (given in TU's) can also include flags 688185377Ssam * to force a TSF reset and to enable the beacon xmit logic. 689185377Ssam * If bs_cfpmaxduration is non-zero the hardware is setup to 690185377Ssam * coexist with a PCF-capable AP. 691185377Ssam */ 692185377Ssamtypedef struct { 693185377Ssam uint32_t bs_nexttbtt; /* next beacon in TU */ 694185377Ssam uint32_t bs_nextdtim; /* next DTIM in TU */ 695185377Ssam uint32_t bs_intval; /* beacon interval+flags */ 696185377Ssam#define HAL_BEACON_PERIOD 0x0000ffff /* beacon interval period */ 697185377Ssam#define HAL_BEACON_ENA 0x00800000 /* beacon xmit enable */ 698185377Ssam#define HAL_BEACON_RESET_TSF 0x01000000 /* clear TSF */ 699185377Ssam uint32_t bs_dtimperiod; 700185377Ssam uint16_t bs_cfpperiod; /* CFP period in TU */ 701185377Ssam uint16_t bs_cfpmaxduration; /* max CFP duration in TU */ 702185377Ssam uint32_t bs_cfpnext; /* next CFP in TU */ 703185377Ssam uint16_t bs_timoffset; /* byte offset to TIM bitmap */ 704185377Ssam uint16_t bs_bmissthreshold; /* beacon miss threshold */ 705185377Ssam uint32_t bs_sleepduration; /* max sleep duration */ 706185377Ssam} HAL_BEACON_STATE; 707185377Ssam 708185377Ssam/* 709185377Ssam * Like HAL_BEACON_STATE but for non-station mode setup. 710185377Ssam * NB: see above flag definitions for bt_intval. 711185377Ssam */ 712185377Ssamtypedef struct { 713185377Ssam uint32_t bt_intval; /* beacon interval+flags */ 714185377Ssam uint32_t bt_nexttbtt; /* next beacon in TU */ 715185377Ssam uint32_t bt_nextatim; /* next ATIM in TU */ 716185377Ssam uint32_t bt_nextdba; /* next DBA in 1/8th TU */ 717185377Ssam uint32_t bt_nextswba; /* next SWBA in 1/8th TU */ 718185377Ssam uint32_t bt_flags; /* timer enables */ 719185377Ssam#define HAL_BEACON_TBTT_EN 0x00000001 720185377Ssam#define HAL_BEACON_DBA_EN 0x00000002 721185377Ssam#define HAL_BEACON_SWBA_EN 0x00000004 722185377Ssam} HAL_BEACON_TIMERS; 723185377Ssam 724185377Ssam/* 725185377Ssam * Per-node statistics maintained by the driver for use in 726185377Ssam * optimizing signal quality and other operational aspects. 727185377Ssam */ 728185377Ssamtypedef struct { 729185377Ssam uint32_t ns_avgbrssi; /* average beacon rssi */ 730185377Ssam uint32_t ns_avgrssi; /* average data rssi */ 731185377Ssam uint32_t ns_avgtxrssi; /* average tx rssi */ 732185377Ssam} HAL_NODE_STATS; 733185377Ssam 734185377Ssam#define HAL_RSSI_EP_MULTIPLIER (1<<7) /* pow2 to optimize out * and / */ 735185377Ssam 736185377Ssamstruct ath_desc; 737185377Ssamstruct ath_tx_status; 738185377Ssamstruct ath_rx_status; 739187831Ssamstruct ieee80211_channel; 740185377Ssam 741185377Ssam/* 742219773Sadrian * This is a channel survey sample entry. 743219773Sadrian * 744219773Sadrian * The AR5212 ANI routines fill these samples. The ANI code then uses it 745219773Sadrian * when calculating listen time; it is also exported via a diagnostic 746219773Sadrian * API. 747219773Sadrian */ 748219773Sadriantypedef struct { 749219773Sadrian uint32_t seq_num; 750219773Sadrian uint32_t tx_busy; 751219773Sadrian uint32_t rx_busy; 752219773Sadrian uint32_t chan_busy; 753234749Sadrian uint32_t ext_chan_busy; 754219773Sadrian uint32_t cycle_count; 755234749Sadrian /* XXX TODO */ 756234749Sadrian uint32_t ofdm_phyerr_count; 757234749Sadrian uint32_t cck_phyerr_count; 758219773Sadrian} HAL_SURVEY_SAMPLE; 759219773Sadrian 760219773Sadrian/* 761219773Sadrian * This provides 3.2 seconds of sample space given an 762219773Sadrian * ANI time of 1/10th of a second. This may not be enough! 763219773Sadrian */ 764219773Sadrian#define CHANNEL_SURVEY_SAMPLE_COUNT 32 765219773Sadrian 766219773Sadriantypedef struct { 767219773Sadrian HAL_SURVEY_SAMPLE samples[CHANNEL_SURVEY_SAMPLE_COUNT]; 768219773Sadrian uint32_t cur_sample; /* current sample in sequence */ 769219773Sadrian uint32_t cur_seq; /* current sequence number */ 770219773Sadrian} HAL_CHANNEL_SURVEY; 771219773Sadrian 772219773Sadrian/* 773222277Sadrian * ANI commands. 774222277Sadrian * 775222277Sadrian * These are used both internally and externally via the diagnostic 776222277Sadrian * API. 777222277Sadrian * 778222277Sadrian * Note that this is NOT the ANI commands being used via the INTMIT 779222277Sadrian * capability - that has a different mapping for some reason. 780222277Sadrian */ 781222277Sadriantypedef enum { 782222277Sadrian HAL_ANI_PRESENT = 0, /* is ANI support present */ 783222277Sadrian HAL_ANI_NOISE_IMMUNITY_LEVEL = 1, /* set level */ 784222277Sadrian HAL_ANI_OFDM_WEAK_SIGNAL_DETECTION = 2, /* enable/disable */ 785222277Sadrian HAL_ANI_CCK_WEAK_SIGNAL_THR = 3, /* enable/disable */ 786222277Sadrian HAL_ANI_FIRSTEP_LEVEL = 4, /* set level */ 787222277Sadrian HAL_ANI_SPUR_IMMUNITY_LEVEL = 5, /* set level */ 788222277Sadrian HAL_ANI_MODE = 6, /* 0 => manual, 1 => auto (XXX do not change) */ 789222277Sadrian HAL_ANI_PHYERR_RESET = 7, /* reset phy error stats */ 790237874Sadrian HAL_ANI_MRC_CCK = 8, 791222277Sadrian} HAL_ANI_CMD; 792222277Sadrian 793222277Sadrian/* 794222277Sadrian * This is the layout of the ANI INTMIT capability. 795222277Sadrian * 796222277Sadrian * Notice that the command values differ to HAL_ANI_CMD. 797222277Sadrian */ 798222277Sadriantypedef enum { 799222277Sadrian HAL_CAP_INTMIT_PRESENT = 0, 800222277Sadrian HAL_CAP_INTMIT_ENABLE = 1, 801222277Sadrian HAL_CAP_INTMIT_NOISE_IMMUNITY_LEVEL = 2, 802222277Sadrian HAL_CAP_INTMIT_OFDM_WEAK_SIGNAL_LEVEL = 3, 803222277Sadrian HAL_CAP_INTMIT_CCK_WEAK_SIGNAL_THR = 4, 804222277Sadrian HAL_CAP_INTMIT_FIRSTEP_LEVEL = 5, 805222277Sadrian HAL_CAP_INTMIT_SPUR_IMMUNITY_LEVEL = 6 806222277Sadrian} HAL_CAP_INTMIT_CMD; 807222277Sadrian 808237874Sadrian/* DFS defines */ 809222584Sadriantypedef struct { 810222584Sadrian int32_t pe_firpwr; /* FIR pwr out threshold */ 811222584Sadrian int32_t pe_rrssi; /* Radar rssi thresh */ 812222584Sadrian int32_t pe_height; /* Pulse height thresh */ 813222584Sadrian int32_t pe_prssi; /* Pulse rssi thresh */ 814222584Sadrian int32_t pe_inband; /* Inband thresh */ 815222584Sadrian 816222584Sadrian /* The following params are only for AR5413 and later */ 817222584Sadrian u_int32_t pe_relpwr; /* Relative power threshold in 0.5dB steps */ 818222584Sadrian u_int32_t pe_relstep; /* Pulse Relative step threshold in 0.5dB steps */ 819222584Sadrian u_int32_t pe_maxlen; /* Max length of radar sign in 0.8us units */ 820224244Sadrian int32_t pe_usefir128; /* Use the average in-band power measured over 128 cycles */ 821224244Sadrian int32_t pe_blockradar; /* 822222584Sadrian * Enable to block radar check if pkt detect is done via OFDM 823222584Sadrian * weak signal detect or pkt is detected immediately after tx 824222584Sadrian * to rx transition 825222584Sadrian */ 826224244Sadrian int32_t pe_enmaxrssi; /* 827222584Sadrian * Enable to use the max rssi instead of the last rssi during 828222584Sadrian * fine gain changes for radar detection 829222584Sadrian */ 830224244Sadrian int32_t pe_extchannel; /* Enable DFS on ext channel */ 831224244Sadrian int32_t pe_enabled; /* Whether radar detection is enabled */ 832231708Sadrian int32_t pe_enrelpwr; 833231708Sadrian int32_t pe_en_relstep_check; 834222584Sadrian} HAL_PHYERR_PARAM; 835222584Sadrian 836222584Sadrian#define HAL_PHYERR_PARAM_NOVAL 65535 837222584Sadrian 838224716Sadrian/* 839224716Sadrian * DFS operating mode flags. 840224716Sadrian */ 841224716Sadriantypedef enum { 842224716Sadrian HAL_DFS_UNINIT_DOMAIN = 0, /* Uninitialized dfs domain */ 843224716Sadrian HAL_DFS_FCC_DOMAIN = 1, /* FCC3 dfs domain */ 844224716Sadrian HAL_DFS_ETSI_DOMAIN = 2, /* ETSI dfs domain */ 845224716Sadrian HAL_DFS_MKK4_DOMAIN = 3, /* Japan dfs domain */ 846224716Sadrian} HAL_DFS_DOMAIN; 847222584Sadrian 848222277Sadrian/* 849239606Sadrian * MFP decryption options for initializing the MAC. 850239606Sadrian */ 851239606Sadrian 852239606Sadriantypedef enum { 853239606Sadrian HAL_MFP_QOSDATA = 0, /* Decrypt MFP frames like QoS data frames. All chips before Merlin. */ 854239606Sadrian HAL_MFP_PASSTHRU, /* Don't decrypt MFP frames at all. Passthrough */ 855239606Sadrian HAL_MFP_HW_CRYPTO /* hardware decryption enabled. Merlin can do it. */ 856239606Sadrian} HAL_MFP_OPT_T; 857239606Sadrian 858239606Sadrian/* 859222644Sadrian * Flag for setting QUIET period 860222644Sadrian */ 861222644Sadriantypedef enum { 862222644Sadrian HAL_QUIET_DISABLE = 0x0, 863222644Sadrian HAL_QUIET_ENABLE = 0x1, 864222644Sadrian HAL_QUIET_ADD_CURRENT_TSF = 0x2, /* add current TSF to next_start offset */ 865222644Sadrian HAL_QUIET_ADD_SWBA_RESP_TIME = 0x4, /* add beacon response time to next_start offset */ 866222644Sadrian} HAL_QUIET_FLAG; 867222644Sadrian 868222815Sadrian#define HAL_DFS_EVENT_PRICH 0x0000001 869224539Sadrian#define HAL_DFS_EVENT_EXTCH 0x0000002 870224539Sadrian#define HAL_DFS_EVENT_EXTEARLY 0x0000004 871224539Sadrian#define HAL_DFS_EVENT_ISDC 0x0000008 872222815Sadrian 873224633Sadrianstruct hal_dfs_event { 874222815Sadrian uint64_t re_full_ts; /* 64-bit full timestamp from interrupt time */ 875222815Sadrian uint32_t re_ts; /* Original 15 bit recv timestamp */ 876222815Sadrian uint8_t re_rssi; /* rssi of radar event */ 877222815Sadrian uint8_t re_dur; /* duration of radar pulse */ 878222815Sadrian uint32_t re_flags; /* Flags (see above) */ 879222815Sadrian}; 880224633Sadriantypedef struct hal_dfs_event HAL_DFS_EVENT; 881222815Sadrian 882237611Sadrian/* 883237611Sadrian * BT Co-existence definitions 884237611Sadrian */ 885237611Sadriantypedef enum { 886237611Sadrian HAL_BT_MODULE_CSR_BC4 = 0, /* CSR BlueCore v4 */ 887237611Sadrian HAL_BT_MODULE_JANUS = 1, /* Kite + Valkyrie combo */ 888237611Sadrian HAL_BT_MODULE_HELIUS = 2, /* Kiwi + Valkyrie combo */ 889237611Sadrian HAL_MAX_BT_MODULES 890237611Sadrian} HAL_BT_MODULE; 891237611Sadrian 892237611Sadriantypedef struct { 893237611Sadrian HAL_BT_MODULE bt_module; 894237611Sadrian u_int8_t bt_coex_config; 895237611Sadrian u_int8_t bt_gpio_bt_active; 896237611Sadrian u_int8_t bt_gpio_bt_priority; 897237611Sadrian u_int8_t bt_gpio_wlan_active; 898237611Sadrian u_int8_t bt_active_polarity; 899237611Sadrian HAL_BOOL bt_single_ant; 900237611Sadrian u_int8_t bt_dutyCycle; 901237611Sadrian u_int8_t bt_isolation; 902237611Sadrian u_int8_t bt_period; 903237611Sadrian} HAL_BT_COEX_INFO; 904237611Sadrian 905237611Sadriantypedef enum { 906237611Sadrian HAL_BT_COEX_MODE_LEGACY = 0, /* legacy rx_clear mode */ 907237611Sadrian HAL_BT_COEX_MODE_UNSLOTTED = 1, /* untimed/unslotted mode */ 908237611Sadrian HAL_BT_COEX_MODE_SLOTTED = 2, /* slotted mode */ 909237611Sadrian HAL_BT_COEX_MODE_DISALBED = 3, /* coexistence disabled */ 910237611Sadrian} HAL_BT_COEX_MODE; 911237611Sadrian 912237611Sadriantypedef enum { 913237611Sadrian HAL_BT_COEX_CFG_NONE, /* No bt coex enabled */ 914237611Sadrian HAL_BT_COEX_CFG_2WIRE_2CH, /* 2-wire with 2 chains */ 915237611Sadrian HAL_BT_COEX_CFG_2WIRE_CH1, /* 2-wire with ch1 */ 916237611Sadrian HAL_BT_COEX_CFG_2WIRE_CH0, /* 2-wire with ch0 */ 917237611Sadrian HAL_BT_COEX_CFG_3WIRE, /* 3-wire */ 918237611Sadrian HAL_BT_COEX_CFG_MCI /* MCI */ 919237611Sadrian} HAL_BT_COEX_CFG; 920237611Sadrian 921237611Sadriantypedef enum { 922237611Sadrian HAL_BT_COEX_SET_ACK_PWR = 0, /* Change ACK power setting */ 923237611Sadrian HAL_BT_COEX_LOWER_TX_PWR, /* Change transmit power */ 924237611Sadrian HAL_BT_COEX_ANTENNA_DIVERSITY, /* Enable RX diversity for Kite */ 925237611Sadrian} HAL_BT_COEX_SET_PARAMETER; 926237611Sadrian 927237611Sadrian#define HAL_BT_COEX_FLAG_LOW_ACK_PWR 0x00000001 928237611Sadrian#define HAL_BT_COEX_FLAG_LOWER_TX_PWR 0x00000002 929237611Sadrian/* Check Rx Diversity is allowed */ 930237611Sadrian#define HAL_BT_COEX_FLAG_ANT_DIV_ALLOW 0x00000004 931237611Sadrian/* Check Diversity is on or off */ 932237611Sadrian#define HAL_BT_COEX_FLAG_ANT_DIV_ENABLE 0x00000008 933237611Sadrian 934237611Sadrian#define HAL_BT_COEX_ANTDIV_CONTROL1_ENABLE 0x0b 935237611Sadrian/* main: LNA1, alt: LNA2 */ 936237611Sadrian#define HAL_BT_COEX_ANTDIV_CONTROL2_ENABLE 0x09 937237611Sadrian#define HAL_BT_COEX_ANTDIV_CONTROL1_FIXED_A 0x04 938237611Sadrian#define HAL_BT_COEX_ANTDIV_CONTROL2_FIXED_A 0x09 939237611Sadrian#define HAL_BT_COEX_ANTDIV_CONTROL1_FIXED_B 0x02 940237611Sadrian#define HAL_BT_COEX_ANTDIV_CONTROL2_FIXED_B 0x06 941237611Sadrian 942237611Sadrian#define HAL_BT_COEX_ISOLATION_FOR_NO_COEX 30 943237611Sadrian 944237611Sadrian#define HAL_BT_COEX_ANT_DIV_SWITCH_COM 0x66666666 945237611Sadrian 946237611Sadrian#define HAL_BT_COEX_HELIUS_CHAINMASK 0x02 947237611Sadrian 948237611Sadrian#define HAL_BT_COEX_LOW_ACK_POWER 0x0 949237611Sadrian#define HAL_BT_COEX_HIGH_ACK_POWER 0x3f3f3f 950237611Sadrian 951237611Sadriantypedef enum { 952237611Sadrian HAL_BT_COEX_NO_STOMP = 0, 953237611Sadrian HAL_BT_COEX_STOMP_ALL, 954237611Sadrian HAL_BT_COEX_STOMP_LOW, 955237611Sadrian HAL_BT_COEX_STOMP_NONE, 956237611Sadrian HAL_BT_COEX_STOMP_ALL_FORCE, 957237611Sadrian HAL_BT_COEX_STOMP_LOW_FORCE, 958237611Sadrian} HAL_BT_COEX_STOMP_TYPE; 959237611Sadrian 960237611Sadriantypedef struct { 961237611Sadrian /* extend rx_clear after tx/rx to protect the burst (in usec). */ 962237611Sadrian u_int8_t bt_time_extend; 963237611Sadrian 964237611Sadrian /* 965237611Sadrian * extend rx_clear as long as txsm is 966237611Sadrian * transmitting or waiting for ack. 967237611Sadrian */ 968237611Sadrian HAL_BOOL bt_txstate_extend; 969237611Sadrian 970237611Sadrian /* 971237611Sadrian * extend rx_clear so that when tx_frame 972237611Sadrian * is asserted, rx_clear will drop. 973237611Sadrian */ 974237611Sadrian HAL_BOOL bt_txframe_extend; 975237611Sadrian 976237611Sadrian /* 977237611Sadrian * coexistence mode 978237611Sadrian */ 979237611Sadrian HAL_BT_COEX_MODE bt_mode; 980237611Sadrian 981237611Sadrian /* 982237611Sadrian * treat BT high priority traffic as 983237611Sadrian * a quiet collision 984237611Sadrian */ 985237611Sadrian HAL_BOOL bt_quiet_collision; 986237611Sadrian 987237611Sadrian /* 988237611Sadrian * invert rx_clear as WLAN_ACTIVE 989237611Sadrian */ 990237611Sadrian HAL_BOOL bt_rxclear_polarity; 991237611Sadrian 992237611Sadrian /* 993237611Sadrian * slotted mode only. indicate the time in usec 994237611Sadrian * from the rising edge of BT_ACTIVE to the time 995237611Sadrian * BT_PRIORITY can be sampled to indicate priority. 996237611Sadrian */ 997237611Sadrian u_int8_t bt_priority_time; 998237611Sadrian 999237611Sadrian /* 1000237611Sadrian * slotted mode only. indicate the time in usec 1001237611Sadrian * from the rising edge of BT_ACTIVE to the time 1002237611Sadrian * BT_PRIORITY can be sampled to indicate tx/rx and 1003237611Sadrian * BT_FREQ is sampled. 1004237611Sadrian */ 1005237611Sadrian u_int8_t bt_first_slot_time; 1006237611Sadrian 1007237611Sadrian /* 1008237611Sadrian * slotted mode only. rx_clear and bt_ant decision 1009237611Sadrian * will be held the entire time that BT_ACTIVE is asserted, 1010237611Sadrian * otherwise the decision is made before every slot boundry. 1011237611Sadrian */ 1012237611Sadrian HAL_BOOL bt_hold_rxclear; 1013237611Sadrian} HAL_BT_COEX_CONFIG; 1014237611Sadrian 1015223459Sadriantypedef struct 1016223459Sadrian{ 1017223459Sadrian int ah_debug; /* only used if AH_DEBUG is defined */ 1018223459Sadrian int ah_ar5416_biasadj; /* enable AR2133 radio specific bias fiddling */ 1019223459Sadrian 1020223459Sadrian /* NB: these are deprecated; they exist for now for compatibility */ 1021223459Sadrian int ah_dma_beacon_response_time;/* in TU's */ 1022223459Sadrian int ah_sw_beacon_response_time; /* in TU's */ 1023223459Sadrian int ah_additional_swba_backoff; /* in TU's */ 1024227375Sadrian int ah_force_full_reset; /* force full chip reset rather then warm reset */ 1025227410Sadrian int ah_serialise_reg_war; /* force serialisation of register IO */ 1026224633Sadrian} HAL_OPS_CONFIG; 1027223459Sadrian 1028222644Sadrian/* 1029185377Ssam * Hardware Access Layer (HAL) API. 1030185377Ssam * 1031185377Ssam * Clients of the HAL call ath_hal_attach to obtain a reference to an 1032185377Ssam * ath_hal structure for use with the device. Hardware-related operations 1033185377Ssam * that follow must call back into the HAL through interface, supplying 1034185377Ssam * the reference as the first parameter. Note that before using the 1035185377Ssam * reference returned by ath_hal_attach the caller should verify the 1036185377Ssam * ABI version number. 1037185377Ssam */ 1038185377Ssamstruct ath_hal { 1039185377Ssam uint32_t ah_magic; /* consistency check magic number */ 1040185377Ssam uint16_t ah_devid; /* PCI device ID */ 1041185377Ssam uint16_t ah_subvendorid; /* PCI subvendor ID */ 1042185377Ssam HAL_SOFTC ah_sc; /* back pointer to driver/os state */ 1043185377Ssam HAL_BUS_TAG ah_st; /* params for register r+w */ 1044185377Ssam HAL_BUS_HANDLE ah_sh; 1045185377Ssam HAL_CTRY_CODE ah_countryCode; 1046185377Ssam 1047185377Ssam uint32_t ah_macVersion; /* MAC version id */ 1048185377Ssam uint16_t ah_macRev; /* MAC revision */ 1049185377Ssam uint16_t ah_phyRev; /* PHY revision */ 1050185377Ssam /* NB: when only one radio is present the rev is in 5Ghz */ 1051185377Ssam uint16_t ah_analog5GhzRev;/* 5GHz radio revision */ 1052185377Ssam uint16_t ah_analog2GhzRev;/* 2GHz radio revision */ 1053185377Ssam 1054217624Sadrian uint16_t *ah_eepromdata; /* eeprom buffer, if needed */ 1055217624Sadrian 1056227365Sadrian uint32_t ah_intrstate[8]; /* last int state */ 1057234088Sadrian uint32_t ah_syncstate; /* last sync intr state */ 1058227365Sadrian 1059223459Sadrian HAL_OPS_CONFIG ah_config; 1060185377Ssam const HAL_RATE_TABLE *__ahdecl(*ah_getRateTable)(struct ath_hal *, 1061185377Ssam u_int mode); 1062185377Ssam void __ahdecl(*ah_detach)(struct ath_hal*); 1063185377Ssam 1064185377Ssam /* Reset functions */ 1065185377Ssam HAL_BOOL __ahdecl(*ah_reset)(struct ath_hal *, HAL_OPMODE, 1066187831Ssam struct ieee80211_channel *, 1067187831Ssam HAL_BOOL bChannelChange, HAL_STATUS *status); 1068185377Ssam HAL_BOOL __ahdecl(*ah_phyDisable)(struct ath_hal *); 1069185377Ssam HAL_BOOL __ahdecl(*ah_disable)(struct ath_hal *); 1070235972Sadrian void __ahdecl(*ah_configPCIE)(struct ath_hal *, HAL_BOOL restore, 1071235972Sadrian HAL_BOOL power_off); 1072188979Ssam void __ahdecl(*ah_disablePCIE)(struct ath_hal *); 1073185377Ssam void __ahdecl(*ah_setPCUConfig)(struct ath_hal *); 1074187831Ssam HAL_BOOL __ahdecl(*ah_perCalibration)(struct ath_hal*, 1075187831Ssam struct ieee80211_channel *, HAL_BOOL *); 1076187831Ssam HAL_BOOL __ahdecl(*ah_perCalibrationN)(struct ath_hal *, 1077187831Ssam struct ieee80211_channel *, u_int chainMask, 1078187831Ssam HAL_BOOL longCal, HAL_BOOL *isCalDone); 1079187831Ssam HAL_BOOL __ahdecl(*ah_resetCalValid)(struct ath_hal *, 1080187831Ssam const struct ieee80211_channel *); 1081203930Srpaulo HAL_BOOL __ahdecl(*ah_setTxPower)(struct ath_hal *, 1082203930Srpaulo const struct ieee80211_channel *, uint16_t *); 1083185377Ssam HAL_BOOL __ahdecl(*ah_setTxPowerLimit)(struct ath_hal *, uint32_t); 1084203930Srpaulo HAL_BOOL __ahdecl(*ah_setBoardValues)(struct ath_hal *, 1085203930Srpaulo const struct ieee80211_channel *); 1086185377Ssam 1087185377Ssam /* Transmit functions */ 1088185377Ssam HAL_BOOL __ahdecl(*ah_updateTxTrigLevel)(struct ath_hal*, 1089185377Ssam HAL_BOOL incTrigLevel); 1090185377Ssam int __ahdecl(*ah_setupTxQueue)(struct ath_hal *, HAL_TX_QUEUE, 1091185377Ssam const HAL_TXQ_INFO *qInfo); 1092185377Ssam HAL_BOOL __ahdecl(*ah_setTxQueueProps)(struct ath_hal *, int q, 1093185377Ssam const HAL_TXQ_INFO *qInfo); 1094185377Ssam HAL_BOOL __ahdecl(*ah_getTxQueueProps)(struct ath_hal *, int q, 1095185377Ssam HAL_TXQ_INFO *qInfo); 1096185377Ssam HAL_BOOL __ahdecl(*ah_releaseTxQueue)(struct ath_hal *ah, u_int q); 1097185377Ssam HAL_BOOL __ahdecl(*ah_resetTxQueue)(struct ath_hal *ah, u_int q); 1098185377Ssam uint32_t __ahdecl(*ah_getTxDP)(struct ath_hal*, u_int); 1099185377Ssam HAL_BOOL __ahdecl(*ah_setTxDP)(struct ath_hal*, u_int, uint32_t txdp); 1100185377Ssam uint32_t __ahdecl(*ah_numTxPending)(struct ath_hal *, u_int q); 1101185377Ssam HAL_BOOL __ahdecl(*ah_startTxDma)(struct ath_hal*, u_int); 1102185377Ssam HAL_BOOL __ahdecl(*ah_stopTxDma)(struct ath_hal*, u_int); 1103185377Ssam HAL_BOOL __ahdecl(*ah_setupTxDesc)(struct ath_hal *, struct ath_desc *, 1104185377Ssam u_int pktLen, u_int hdrLen, 1105185377Ssam HAL_PKT_TYPE type, u_int txPower, 1106185377Ssam u_int txRate0, u_int txTries0, 1107185377Ssam u_int keyIx, u_int antMode, u_int flags, 1108185377Ssam u_int rtsctsRate, u_int rtsctsDuration, 1109185377Ssam u_int compicvLen, u_int compivLen, 1110185377Ssam u_int comp); 1111185377Ssam HAL_BOOL __ahdecl(*ah_setupXTxDesc)(struct ath_hal *, struct ath_desc*, 1112185377Ssam u_int txRate1, u_int txTries1, 1113185377Ssam u_int txRate2, u_int txTries2, 1114185377Ssam u_int txRate3, u_int txTries3); 1115185377Ssam HAL_BOOL __ahdecl(*ah_fillTxDesc)(struct ath_hal *, struct ath_desc *, 1116239051Sadrian HAL_DMA_ADDR *bufAddrList, uint32_t *segLenList, 1117239051Sadrian u_int descId, u_int qcuId, HAL_BOOL firstSeg, 1118185377Ssam HAL_BOOL lastSeg, const struct ath_desc *); 1119185377Ssam HAL_STATUS __ahdecl(*ah_procTxDesc)(struct ath_hal *, 1120185377Ssam struct ath_desc *, struct ath_tx_status *); 1121185377Ssam void __ahdecl(*ah_getTxIntrQueue)(struct ath_hal *, uint32_t *); 1122185377Ssam void __ahdecl(*ah_reqTxIntrDesc)(struct ath_hal *, struct ath_desc*); 1123217621Sadrian HAL_BOOL __ahdecl(*ah_getTxCompletionRates)(struct ath_hal *, 1124217621Sadrian const struct ath_desc *ds, int *rates, int *tries); 1125238607Sadrian void __ahdecl(*ah_setTxDescLink)(struct ath_hal *ah, void *ds, 1126238607Sadrian uint32_t link); 1127238607Sadrian void __ahdecl(*ah_getTxDescLink)(struct ath_hal *ah, void *ds, 1128238607Sadrian uint32_t *link); 1129238607Sadrian void __ahdecl(*ah_getTxDescLinkPtr)(struct ath_hal *ah, void *ds, 1130238607Sadrian uint32_t **linkptr); 1131238731Sadrian void __ahdecl(*ah_setupTxStatusRing)(struct ath_hal *, 1132238731Sadrian void *ts_start, uint32_t ts_paddr_start, 1133238731Sadrian uint16_t size); 1134185377Ssam 1135185377Ssam /* Receive Functions */ 1136238278Sadrian uint32_t __ahdecl(*ah_getRxDP)(struct ath_hal*, HAL_RX_QUEUE); 1137238278Sadrian void __ahdecl(*ah_setRxDP)(struct ath_hal*, uint32_t rxdp, HAL_RX_QUEUE); 1138185377Ssam void __ahdecl(*ah_enableReceive)(struct ath_hal*); 1139185377Ssam HAL_BOOL __ahdecl(*ah_stopDmaReceive)(struct ath_hal*); 1140185377Ssam void __ahdecl(*ah_startPcuReceive)(struct ath_hal*); 1141185377Ssam void __ahdecl(*ah_stopPcuReceive)(struct ath_hal*); 1142185377Ssam void __ahdecl(*ah_setMulticastFilter)(struct ath_hal*, 1143185377Ssam uint32_t filter0, uint32_t filter1); 1144185377Ssam HAL_BOOL __ahdecl(*ah_setMulticastFilterIndex)(struct ath_hal*, 1145185377Ssam uint32_t index); 1146185377Ssam HAL_BOOL __ahdecl(*ah_clrMulticastFilterIndex)(struct ath_hal*, 1147185377Ssam uint32_t index); 1148185377Ssam uint32_t __ahdecl(*ah_getRxFilter)(struct ath_hal*); 1149185377Ssam void __ahdecl(*ah_setRxFilter)(struct ath_hal*, uint32_t); 1150185377Ssam HAL_BOOL __ahdecl(*ah_setupRxDesc)(struct ath_hal *, struct ath_desc *, 1151185377Ssam uint32_t size, u_int flags); 1152185377Ssam HAL_STATUS __ahdecl(*ah_procRxDesc)(struct ath_hal *, 1153185377Ssam struct ath_desc *, uint32_t phyAddr, 1154185377Ssam struct ath_desc *next, uint64_t tsf, 1155185377Ssam struct ath_rx_status *); 1156185377Ssam void __ahdecl(*ah_rxMonitor)(struct ath_hal *, 1157187831Ssam const HAL_NODE_STATS *, 1158187831Ssam const struct ieee80211_channel *); 1159217684Sadrian void __ahdecl(*ah_aniPoll)(struct ath_hal *, 1160217684Sadrian const struct ieee80211_channel *); 1161185377Ssam void __ahdecl(*ah_procMibEvent)(struct ath_hal *, 1162185377Ssam const HAL_NODE_STATS *); 1163220600Sadrian void __ahdecl(*ah_rxAntCombDiversity)(struct ath_hal *, 1164220600Sadrian struct ath_rx_status *, 1165220600Sadrian unsigned long, int); 1166185377Ssam 1167185377Ssam /* Misc Functions */ 1168185377Ssam HAL_STATUS __ahdecl(*ah_getCapability)(struct ath_hal *, 1169185377Ssam HAL_CAPABILITY_TYPE, uint32_t capability, 1170185377Ssam uint32_t *result); 1171185377Ssam HAL_BOOL __ahdecl(*ah_setCapability)(struct ath_hal *, 1172185377Ssam HAL_CAPABILITY_TYPE, uint32_t capability, 1173185377Ssam uint32_t setting, HAL_STATUS *); 1174185377Ssam HAL_BOOL __ahdecl(*ah_getDiagState)(struct ath_hal *, int request, 1175185377Ssam const void *args, uint32_t argsize, 1176185377Ssam void **result, uint32_t *resultsize); 1177185377Ssam void __ahdecl(*ah_getMacAddress)(struct ath_hal *, uint8_t *); 1178185377Ssam HAL_BOOL __ahdecl(*ah_setMacAddress)(struct ath_hal *, const uint8_t*); 1179185377Ssam void __ahdecl(*ah_getBssIdMask)(struct ath_hal *, uint8_t *); 1180185377Ssam HAL_BOOL __ahdecl(*ah_setBssIdMask)(struct ath_hal *, const uint8_t*); 1181185377Ssam HAL_BOOL __ahdecl(*ah_setRegulatoryDomain)(struct ath_hal*, 1182185377Ssam uint16_t, HAL_STATUS *); 1183185377Ssam void __ahdecl(*ah_setLedState)(struct ath_hal*, HAL_LED_STATE); 1184185377Ssam void __ahdecl(*ah_writeAssocid)(struct ath_hal*, 1185185377Ssam const uint8_t *bssid, uint16_t assocId); 1186188974Ssam HAL_BOOL __ahdecl(*ah_gpioCfgOutput)(struct ath_hal *, 1187188974Ssam uint32_t gpio, HAL_GPIO_MUX_TYPE); 1188185377Ssam HAL_BOOL __ahdecl(*ah_gpioCfgInput)(struct ath_hal *, uint32_t gpio); 1189185377Ssam uint32_t __ahdecl(*ah_gpioGet)(struct ath_hal *, uint32_t gpio); 1190185377Ssam HAL_BOOL __ahdecl(*ah_gpioSet)(struct ath_hal *, 1191185377Ssam uint32_t gpio, uint32_t val); 1192185377Ssam void __ahdecl(*ah_gpioSetIntr)(struct ath_hal*, u_int, uint32_t); 1193185377Ssam uint32_t __ahdecl(*ah_getTsf32)(struct ath_hal*); 1194185377Ssam uint64_t __ahdecl(*ah_getTsf64)(struct ath_hal*); 1195185377Ssam void __ahdecl(*ah_resetTsf)(struct ath_hal*); 1196185377Ssam HAL_BOOL __ahdecl(*ah_detectCardPresent)(struct ath_hal*); 1197185377Ssam void __ahdecl(*ah_updateMibCounters)(struct ath_hal*, 1198185377Ssam HAL_MIB_STATS*); 1199185377Ssam HAL_RFGAIN __ahdecl(*ah_getRfGain)(struct ath_hal*); 1200185377Ssam u_int __ahdecl(*ah_getDefAntenna)(struct ath_hal*); 1201185377Ssam void __ahdecl(*ah_setDefAntenna)(struct ath_hal*, u_int); 1202185377Ssam HAL_ANT_SETTING __ahdecl(*ah_getAntennaSwitch)(struct ath_hal*); 1203185377Ssam HAL_BOOL __ahdecl(*ah_setAntennaSwitch)(struct ath_hal*, 1204185377Ssam HAL_ANT_SETTING); 1205185377Ssam HAL_BOOL __ahdecl(*ah_setSifsTime)(struct ath_hal*, u_int); 1206185377Ssam u_int __ahdecl(*ah_getSifsTime)(struct ath_hal*); 1207185377Ssam HAL_BOOL __ahdecl(*ah_setSlotTime)(struct ath_hal*, u_int); 1208185377Ssam u_int __ahdecl(*ah_getSlotTime)(struct ath_hal*); 1209185377Ssam HAL_BOOL __ahdecl(*ah_setAckTimeout)(struct ath_hal*, u_int); 1210185377Ssam u_int __ahdecl(*ah_getAckTimeout)(struct ath_hal*); 1211185377Ssam HAL_BOOL __ahdecl(*ah_setAckCTSRate)(struct ath_hal*, u_int); 1212185377Ssam u_int __ahdecl(*ah_getAckCTSRate)(struct ath_hal*); 1213185377Ssam HAL_BOOL __ahdecl(*ah_setCTSTimeout)(struct ath_hal*, u_int); 1214185377Ssam u_int __ahdecl(*ah_getCTSTimeout)(struct ath_hal*); 1215185377Ssam HAL_BOOL __ahdecl(*ah_setDecompMask)(struct ath_hal*, uint16_t, int); 1216185377Ssam void __ahdecl(*ah_setCoverageClass)(struct ath_hal*, uint8_t, int); 1217222644Sadrian HAL_STATUS __ahdecl(*ah_setQuiet)(struct ath_hal *ah, uint32_t period, 1218222644Sadrian uint32_t duration, uint32_t nextStart, 1219222644Sadrian HAL_QUIET_FLAG flag); 1220185377Ssam 1221222584Sadrian /* DFS functions */ 1222222584Sadrian void __ahdecl(*ah_enableDfs)(struct ath_hal *ah, 1223222584Sadrian HAL_PHYERR_PARAM *pe); 1224222584Sadrian void __ahdecl(*ah_getDfsThresh)(struct ath_hal *ah, 1225222584Sadrian HAL_PHYERR_PARAM *pe); 1226222815Sadrian HAL_BOOL __ahdecl(*ah_procRadarEvent)(struct ath_hal *ah, 1227222815Sadrian struct ath_rx_status *rxs, uint64_t fulltsf, 1228222815Sadrian const char *buf, HAL_DFS_EVENT *event); 1229224709Sadrian HAL_BOOL __ahdecl(*ah_isFastClockEnabled)(struct ath_hal *ah); 1230222584Sadrian 1231185377Ssam /* Key Cache Functions */ 1232185377Ssam uint32_t __ahdecl(*ah_getKeyCacheSize)(struct ath_hal*); 1233185377Ssam HAL_BOOL __ahdecl(*ah_resetKeyCacheEntry)(struct ath_hal*, uint16_t); 1234185377Ssam HAL_BOOL __ahdecl(*ah_isKeyCacheEntryValid)(struct ath_hal *, 1235185377Ssam uint16_t); 1236185377Ssam HAL_BOOL __ahdecl(*ah_setKeyCacheEntry)(struct ath_hal*, 1237185377Ssam uint16_t, const HAL_KEYVAL *, 1238185377Ssam const uint8_t *, int); 1239185377Ssam HAL_BOOL __ahdecl(*ah_setKeyCacheEntryMac)(struct ath_hal*, 1240185377Ssam uint16_t, const uint8_t *); 1241185377Ssam 1242185377Ssam /* Power Management Functions */ 1243185377Ssam HAL_BOOL __ahdecl(*ah_setPowerMode)(struct ath_hal*, 1244185377Ssam HAL_POWER_MODE mode, int setChip); 1245185377Ssam HAL_POWER_MODE __ahdecl(*ah_getPowerMode)(struct ath_hal*); 1246187831Ssam int16_t __ahdecl(*ah_getChanNoise)(struct ath_hal *, 1247187831Ssam const struct ieee80211_channel *); 1248185377Ssam 1249185377Ssam /* Beacon Management Functions */ 1250185377Ssam void __ahdecl(*ah_setBeaconTimers)(struct ath_hal*, 1251185377Ssam const HAL_BEACON_TIMERS *); 1252185377Ssam /* NB: deprecated, use ah_setBeaconTimers instead */ 1253185377Ssam void __ahdecl(*ah_beaconInit)(struct ath_hal *, 1254185377Ssam uint32_t nexttbtt, uint32_t intval); 1255185377Ssam void __ahdecl(*ah_setStationBeaconTimers)(struct ath_hal*, 1256185377Ssam const HAL_BEACON_STATE *); 1257185377Ssam void __ahdecl(*ah_resetStationBeaconTimers)(struct ath_hal*); 1258225444Sadrian uint64_t __ahdecl(*ah_getNextTBTT)(struct ath_hal *); 1259185377Ssam 1260218066Sadrian /* 802.11n Functions */ 1261218066Sadrian HAL_BOOL __ahdecl(*ah_chainTxDesc)(struct ath_hal *, 1262239053Sadrian struct ath_desc *, 1263239053Sadrian HAL_DMA_ADDR *bufAddrList, 1264239053Sadrian uint32_t *segLenList, 1265239053Sadrian u_int, u_int, HAL_PKT_TYPE, 1266239053Sadrian u_int, HAL_CIPHER, uint8_t, HAL_BOOL, 1267233895Sadrian HAL_BOOL, HAL_BOOL); 1268218066Sadrian HAL_BOOL __ahdecl(*ah_setupFirstTxDesc)(struct ath_hal *, 1269218066Sadrian struct ath_desc *, u_int, u_int, u_int, 1270218066Sadrian u_int, u_int, u_int, u_int, u_int); 1271218066Sadrian HAL_BOOL __ahdecl(*ah_setupLastTxDesc)(struct ath_hal *, 1272218066Sadrian struct ath_desc *, const struct ath_desc *); 1273218066Sadrian void __ahdecl(*ah_set11nRateScenario)(struct ath_hal *, 1274218066Sadrian struct ath_desc *, u_int, u_int, 1275218066Sadrian HAL_11N_RATE_SERIES [], u_int, u_int); 1276226767Sadrian void __ahdecl(*ah_set11nAggrFirst)(struct ath_hal *, 1277238838Sadrian struct ath_desc *, u_int); 1278218066Sadrian void __ahdecl(*ah_set11nAggrMiddle)(struct ath_hal *, 1279218066Sadrian struct ath_desc *, u_int); 1280226767Sadrian void __ahdecl(*ah_set11nAggrLast)(struct ath_hal *, 1281226767Sadrian struct ath_desc *); 1282218066Sadrian void __ahdecl(*ah_clr11nAggr)(struct ath_hal *, 1283218066Sadrian struct ath_desc *); 1284218066Sadrian void __ahdecl(*ah_set11nBurstDuration)(struct ath_hal *, 1285218066Sadrian struct ath_desc *, u_int); 1286234873Sadrian HAL_BOOL __ahdecl(*ah_getMibCycleCounts) (struct ath_hal *, 1287234873Sadrian HAL_SURVEY_SAMPLE *); 1288227374Sadrian 1289218066Sadrian uint32_t __ahdecl(*ah_get11nExtBusy)(struct ath_hal *); 1290218066Sadrian void __ahdecl(*ah_set11nMac2040)(struct ath_hal *, 1291218066Sadrian HAL_HT_MACMODE); 1292218066Sadrian HAL_HT_RXCLEAR __ahdecl(*ah_get11nRxClear)(struct ath_hal *ah); 1293218066Sadrian void __ahdecl(*ah_set11nRxClear)(struct ath_hal *, 1294218066Sadrian HAL_HT_RXCLEAR); 1295218066Sadrian 1296185377Ssam /* Interrupt functions */ 1297185377Ssam HAL_BOOL __ahdecl(*ah_isInterruptPending)(struct ath_hal*); 1298185377Ssam HAL_BOOL __ahdecl(*ah_getPendingInterrupts)(struct ath_hal*, HAL_INT*); 1299185377Ssam HAL_INT __ahdecl(*ah_getInterrupts)(struct ath_hal*); 1300185377Ssam HAL_INT __ahdecl(*ah_setInterrupts)(struct ath_hal*, HAL_INT); 1301185377Ssam}; 1302185377Ssam 1303185377Ssam/* 1304185377Ssam * Check the PCI vendor ID and device ID against Atheros' values 1305185377Ssam * and return a printable description for any Atheros hardware. 1306185377Ssam * AH_NULL is returned if the ID's do not describe Atheros hardware. 1307185377Ssam */ 1308185377Ssamextern const char *__ahdecl ath_hal_probe(uint16_t vendorid, uint16_t devid); 1309185377Ssam 1310185377Ssam/* 1311185377Ssam * Attach the HAL for use with the specified device. The device is 1312185377Ssam * defined by the PCI device ID. The caller provides an opaque pointer 1313185377Ssam * to an upper-layer data structure (HAL_SOFTC) that is stored in the 1314185377Ssam * HAL state block for later use. Hardware register accesses are done 1315185377Ssam * using the specified bus tag and handle. On successful return a 1316185377Ssam * reference to a state block is returned that must be supplied in all 1317185377Ssam * subsequent HAL calls. Storage associated with this reference is 1318185377Ssam * dynamically allocated and must be freed by calling the ah_detach 1319185377Ssam * method when the client is done. If the attach operation fails a 1320185377Ssam * null (AH_NULL) reference will be returned and a status code will 1321185377Ssam * be returned if the status parameter is non-zero. 1322185377Ssam */ 1323185377Ssamextern struct ath_hal * __ahdecl ath_hal_attach(uint16_t devid, HAL_SOFTC, 1324217624Sadrian HAL_BUS_TAG, HAL_BUS_HANDLE, uint16_t *eepromdata, HAL_STATUS* status); 1325185377Ssam 1326188968Ssamextern const char *ath_hal_mac_name(struct ath_hal *); 1327188968Ssamextern const char *ath_hal_rf_name(struct ath_hal *); 1328188968Ssam 1329185377Ssam/* 1330187831Ssam * Regulatory interfaces. Drivers should use ath_hal_init_channels to 1331187831Ssam * request a set of channels for a particular country code and/or 1332187831Ssam * regulatory domain. If CTRY_DEFAULT and SKU_NONE are specified then 1333187831Ssam * this list is constructed according to the contents of the EEPROM. 1334187831Ssam * ath_hal_getchannels acts similarly but does not alter the operating 1335187831Ssam * state; this can be used to collect information for a particular 1336187831Ssam * regulatory configuration. Finally ath_hal_set_channels installs a 1337187831Ssam * channel list constructed outside the driver. The HAL will adopt the 1338187831Ssam * channel list and setup internal state according to the specified 1339187831Ssam * regulatory configuration (e.g. conformance test limits). 1340185377Ssam * 1341187831Ssam * For all interfaces the channel list is returned in the supplied array. 1342187831Ssam * maxchans defines the maximum size of this array. nchans contains the 1343187831Ssam * actual number of channels returned. If a problem occurred then a 1344187831Ssam * status code != HAL_OK is returned. 1345185377Ssam */ 1346187831Ssamstruct ieee80211_channel; 1347185377Ssam 1348185377Ssam/* 1349187831Ssam * Return a list of channels according to the specified regulatory. 1350185377Ssam */ 1351187831Ssamextern HAL_STATUS __ahdecl ath_hal_getchannels(struct ath_hal *, 1352187831Ssam struct ieee80211_channel *chans, u_int maxchans, int *nchans, 1353187831Ssam u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn, 1354187831Ssam HAL_BOOL enableExtendedChannels); 1355185377Ssam 1356185377Ssam/* 1357187831Ssam * Return a list of channels and install it as the current operating 1358187831Ssam * regulatory list. 1359185377Ssam */ 1360187831Ssamextern HAL_STATUS __ahdecl ath_hal_init_channels(struct ath_hal *, 1361187831Ssam struct ieee80211_channel *chans, u_int maxchans, int *nchans, 1362187831Ssam u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN rd, 1363187831Ssam HAL_BOOL enableExtendedChannels); 1364185377Ssam 1365185377Ssam/* 1366187831Ssam * Install the list of channels as the current operating regulatory 1367187831Ssam * and setup related state according to the country code and sku. 1368185377Ssam */ 1369187831Ssamextern HAL_STATUS __ahdecl ath_hal_set_channels(struct ath_hal *, 1370187831Ssam struct ieee80211_channel *chans, int nchans, 1371187831Ssam HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn); 1372185377Ssam 1373185377Ssam/* 1374220443Sadrian * Fetch the ctl/ext noise floor values reported by a MIMO 1375220443Sadrian * radio. Returns 1 for valid results, 0 for invalid channel. 1376220443Sadrian */ 1377220443Sadrianextern int __ahdecl ath_hal_get_mimo_chan_noise(struct ath_hal *ah, 1378220444Sadrian const struct ieee80211_channel *chan, int16_t *nf_ctl, 1379220444Sadrian int16_t *nf_ext); 1380220443Sadrian 1381220443Sadrian/* 1382187831Ssam * Calibrate noise floor data following a channel scan or similar. 1383187831Ssam * This must be called prior retrieving noise floor data. 1384185377Ssam */ 1385187831Ssamextern void __ahdecl ath_hal_process_noisefloor(struct ath_hal *ah); 1386185377Ssam 1387185377Ssam/* 1388187831Ssam * Return bit mask of wireless modes supported by the hardware. 1389185377Ssam */ 1390187831Ssamextern u_int __ahdecl ath_hal_getwirelessmodes(struct ath_hal*); 1391185377Ssam 1392185377Ssam/* 1393218011Sadrian * Calculate the packet TX time for a legacy or 11n frame 1394185377Ssam */ 1395218011Sadrianextern uint32_t __ahdecl ath_hal_pkt_txtime(struct ath_hal *ah, 1396218011Sadrian const HAL_RATE_TABLE *rates, uint32_t frameLen, 1397218011Sadrian uint16_t rateix, HAL_BOOL isht40, HAL_BOOL shortPreamble); 1398218011Sadrian 1399218011Sadrian/* 1400218011Sadrian * Calculate the duration of an 11n frame. 1401218011Sadrian */ 1402218011Sadrianextern uint32_t __ahdecl ath_computedur_ht(uint32_t frameLen, uint16_t rate, 1403218011Sadrian int streams, HAL_BOOL isht40, HAL_BOOL isShortGI); 1404218011Sadrian 1405218011Sadrian/* 1406218011Sadrian * Calculate the transmit duration of a legacy frame. 1407218011Sadrian */ 1408187831Ssamextern uint16_t __ahdecl ath_hal_computetxtime(struct ath_hal *, 1409187831Ssam const HAL_RATE_TABLE *rates, uint32_t frameLen, 1410187831Ssam uint16_t rateix, HAL_BOOL shortPreamble); 1411225444Sadrian 1412225444Sadrian/* 1413225444Sadrian * Adjust the TSF. 1414225444Sadrian */ 1415225444Sadrianextern void __ahdecl ath_hal_adjusttsf(struct ath_hal *ah, int32_t tsfdelta); 1416225444Sadrian 1417225444Sadrian/* 1418225444Sadrian * Enable or disable CCA. 1419225444Sadrian */ 1420225444Sadrianvoid __ahdecl ath_hal_setcca(struct ath_hal *ah, int ena); 1421225444Sadrian 1422225444Sadrian/* 1423225444Sadrian * Get CCA setting. 1424225444Sadrian */ 1425225444Sadrianint __ahdecl ath_hal_getcca(struct ath_hal *ah); 1426225444Sadrian 1427230147Sadrian/* 1428230147Sadrian * Read EEPROM data from ah_eepromdata 1429230147Sadrian */ 1430230147SadrianHAL_BOOL __ahdecl ath_hal_EepromDataRead(struct ath_hal *ah, 1431230147Sadrian u_int off, uint16_t *data); 1432230147Sadrian 1433239606Sadrian/* 1434239606Sadrian * For now, simply pass through MFP frames. 1435239606Sadrian */ 1436239606Sadrianstatic inline u_int32_t 1437239606Sadrianath_hal_get_mfp_qos(struct ath_hal *ah) 1438239606Sadrian{ 1439239606Sadrian //return AH_PRIVATE(ah)->ah_mfp_qos; 1440239606Sadrian return HAL_MFP_QOSDATA; 1441239606Sadrian} 1442239606Sadrian 1443185377Ssam#endif /* _ATH_AH_H_ */ 1444