ah.h revision 188968
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: head/sys/dev/ath/ath_hal/ah.h 188968 2009-02-23 23:41:12Z sam $ 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 * __ahdecl is analogous to _cdecl; it defines the calling 35 * convention used within the HAL. For most systems this 36 * can just default to be empty and the compiler will (should) 37 * use _cdecl. For systems where _cdecl is not compatible this 38 * must be defined. See linux/ah_osdep.h for an example. 39 */ 40#ifndef __ahdecl 41#define __ahdecl 42#endif 43 44/* 45 * Status codes that may be returned by the HAL. Note that 46 * interfaces that return a status code set it only when an 47 * error occurs--i.e. you cannot check it for success. 48 */ 49typedef enum { 50 HAL_OK = 0, /* No error */ 51 HAL_ENXIO = 1, /* No hardware present */ 52 HAL_ENOMEM = 2, /* Memory allocation failed */ 53 HAL_EIO = 3, /* Hardware didn't respond as expected */ 54 HAL_EEMAGIC = 4, /* EEPROM magic number invalid */ 55 HAL_EEVERSION = 5, /* EEPROM version invalid */ 56 HAL_EELOCKED = 6, /* EEPROM unreadable */ 57 HAL_EEBADSUM = 7, /* EEPROM checksum invalid */ 58 HAL_EEREAD = 8, /* EEPROM read problem */ 59 HAL_EEBADMAC = 9, /* EEPROM mac address invalid */ 60 HAL_EESIZE = 10, /* EEPROM size not supported */ 61 HAL_EEWRITE = 11, /* Attempt to change write-locked EEPROM */ 62 HAL_EINVAL = 12, /* Invalid parameter to function */ 63 HAL_ENOTSUPP = 13, /* Hardware revision not supported */ 64 HAL_ESELFTEST = 14, /* Hardware self-test failed */ 65 HAL_EINPROGRESS = 15, /* Operation incomplete */ 66 HAL_EEBADREG = 16, /* EEPROM invalid regulatory contents */ 67 HAL_EEBADCC = 17, /* EEPROM invalid country code */ 68} HAL_STATUS; 69 70typedef enum { 71 AH_FALSE = 0, /* NB: lots of code assumes false is zero */ 72 AH_TRUE = 1, 73} HAL_BOOL; 74 75typedef enum { 76 HAL_CAP_REG_DMN = 0, /* current regulatory domain */ 77 HAL_CAP_CIPHER = 1, /* hardware supports cipher */ 78 HAL_CAP_TKIP_MIC = 2, /* handle TKIP MIC in hardware */ 79 HAL_CAP_TKIP_SPLIT = 3, /* hardware TKIP uses split keys */ 80 HAL_CAP_PHYCOUNTERS = 4, /* hardware PHY error counters */ 81 HAL_CAP_DIVERSITY = 5, /* hardware supports fast diversity */ 82 HAL_CAP_KEYCACHE_SIZE = 6, /* number of entries in key cache */ 83 HAL_CAP_NUM_TXQUEUES = 7, /* number of hardware xmit queues */ 84 HAL_CAP_VEOL = 9, /* hardware supports virtual EOL */ 85 HAL_CAP_PSPOLL = 10, /* hardware has working PS-Poll support */ 86 HAL_CAP_DIAG = 11, /* hardware diagnostic support */ 87 HAL_CAP_COMPRESSION = 12, /* hardware supports compression */ 88 HAL_CAP_BURST = 13, /* hardware supports packet bursting */ 89 HAL_CAP_FASTFRAME = 14, /* hardware supoprts fast frames */ 90 HAL_CAP_TXPOW = 15, /* global tx power limit */ 91 HAL_CAP_TPC = 16, /* per-packet tx power control */ 92 HAL_CAP_PHYDIAG = 17, /* hardware phy error diagnostic */ 93 HAL_CAP_BSSIDMASK = 18, /* hardware supports bssid mask */ 94 HAL_CAP_MCAST_KEYSRCH = 19, /* hardware has multicast key search */ 95 HAL_CAP_TSF_ADJUST = 20, /* hardware has beacon tsf adjust */ 96 /* 21 was HAL_CAP_XR */ 97 HAL_CAP_WME_TKIPMIC = 22, /* hardware can support TKIP MIC when WMM is turned on */ 98 /* 23 was HAL_CAP_CHAN_HALFRATE */ 99 /* 24 was HAL_CAP_CHAN_QUARTERRATE */ 100 HAL_CAP_RFSILENT = 25, /* hardware has rfsilent support */ 101 HAL_CAP_TPC_ACK = 26, /* ack txpower with per-packet tpc */ 102 HAL_CAP_TPC_CTS = 27, /* cts txpower with per-packet tpc */ 103 HAL_CAP_11D = 28, /* 11d beacon support for changing cc */ 104 HAL_CAP_INTMIT = 29, /* interference mitigation */ 105 HAL_CAP_RXORN_FATAL = 30, /* HAL_INT_RXORN treated as fatal */ 106 HAL_CAP_HT = 31, /* hardware can support HT */ 107 HAL_CAP_TX_CHAINMASK = 32, /* mask of TX chains supported */ 108 HAL_CAP_RX_CHAINMASK = 33, /* mask of RX chains supported */ 109 HAL_CAP_RXTSTAMP_PREC = 34, /* rx desc tstamp precision (bits) */ 110 HAL_CAP_BB_HANG = 35, /* can baseband hang */ 111 HAL_CAP_MAC_HANG = 36, /* can MAC hang */ 112} HAL_CAPABILITY_TYPE; 113 114/* 115 * "States" for setting the LED. These correspond to 116 * the possible 802.11 operational states and there may 117 * be a many-to-one mapping between these states and the 118 * actual hardware state for the LED's (i.e. the hardware 119 * may have fewer states). 120 */ 121typedef enum { 122 HAL_LED_INIT = 0, 123 HAL_LED_SCAN = 1, 124 HAL_LED_AUTH = 2, 125 HAL_LED_ASSOC = 3, 126 HAL_LED_RUN = 4 127} HAL_LED_STATE; 128 129/* 130 * Transmit queue types/numbers. These are used to tag 131 * each transmit queue in the hardware and to identify a set 132 * of transmit queues for operations such as start/stop dma. 133 */ 134typedef enum { 135 HAL_TX_QUEUE_INACTIVE = 0, /* queue is inactive/unused */ 136 HAL_TX_QUEUE_DATA = 1, /* data xmit q's */ 137 HAL_TX_QUEUE_BEACON = 2, /* beacon xmit q */ 138 HAL_TX_QUEUE_CAB = 3, /* "crap after beacon" xmit q */ 139 HAL_TX_QUEUE_UAPSD = 4, /* u-apsd power save xmit q */ 140} HAL_TX_QUEUE; 141 142#define HAL_NUM_TX_QUEUES 10 /* max possible # of queues */ 143 144/* 145 * Transmit queue subtype. These map directly to 146 * WME Access Categories (except for UPSD). Refer 147 * to Table 5 of the WME spec. 148 */ 149typedef enum { 150 HAL_WME_AC_BK = 0, /* background access category */ 151 HAL_WME_AC_BE = 1, /* best effort access category*/ 152 HAL_WME_AC_VI = 2, /* video access category */ 153 HAL_WME_AC_VO = 3, /* voice access category */ 154 HAL_WME_UPSD = 4, /* uplink power save */ 155} HAL_TX_QUEUE_SUBTYPE; 156 157/* 158 * Transmit queue flags that control various 159 * operational parameters. 160 */ 161typedef enum { 162 /* 163 * Per queue interrupt enables. When set the associated 164 * interrupt may be delivered for packets sent through 165 * the queue. Without these enabled no interrupts will 166 * be delivered for transmits through the queue. 167 */ 168 HAL_TXQ_TXOKINT_ENABLE = 0x0001, /* enable TXOK interrupt */ 169 HAL_TXQ_TXERRINT_ENABLE = 0x0001, /* enable TXERR interrupt */ 170 HAL_TXQ_TXDESCINT_ENABLE = 0x0002, /* enable TXDESC interrupt */ 171 HAL_TXQ_TXEOLINT_ENABLE = 0x0004, /* enable TXEOL interrupt */ 172 HAL_TXQ_TXURNINT_ENABLE = 0x0008, /* enable TXURN interrupt */ 173 /* 174 * Enable hardware compression for packets sent through 175 * the queue. The compression buffer must be setup and 176 * packets must have a key entry marked in the tx descriptor. 177 */ 178 HAL_TXQ_COMPRESSION_ENABLE = 0x0010, /* enable h/w compression */ 179 /* 180 * Disable queue when veol is hit or ready time expires. 181 * By default the queue is disabled only on reaching the 182 * physical end of queue (i.e. a null link ptr in the 183 * descriptor chain). 184 */ 185 HAL_TXQ_RDYTIME_EXP_POLICY_ENABLE = 0x0020, 186 /* 187 * Schedule frames on delivery of a DBA (DMA Beacon Alert) 188 * event. Frames will be transmitted only when this timer 189 * fires, e.g to transmit a beacon in ap or adhoc modes. 190 */ 191 HAL_TXQ_DBA_GATED = 0x0040, /* schedule based on DBA */ 192 /* 193 * Each transmit queue has a counter that is incremented 194 * each time the queue is enabled and decremented when 195 * the list of frames to transmit is traversed (or when 196 * the ready time for the queue expires). This counter 197 * must be non-zero for frames to be scheduled for 198 * transmission. The following controls disable bumping 199 * this counter under certain conditions. Typically this 200 * is used to gate frames based on the contents of another 201 * queue (e.g. CAB traffic may only follow a beacon frame). 202 * These are meaningful only when frames are scheduled 203 * with a non-ASAP policy (e.g. DBA-gated). 204 */ 205 HAL_TXQ_CBR_DIS_QEMPTY = 0x0080, /* disable on this q empty */ 206 HAL_TXQ_CBR_DIS_BEMPTY = 0x0100, /* disable on beacon q empty */ 207 208 /* 209 * Fragment burst backoff policy. Normally the no backoff 210 * is done after a successful transmission, the next fragment 211 * is sent at SIFS. If this flag is set backoff is done 212 * after each fragment, regardless whether it was ack'd or 213 * not, after the backoff count reaches zero a normal channel 214 * access procedure is done before the next transmit (i.e. 215 * wait AIFS instead of SIFS). 216 */ 217 HAL_TXQ_FRAG_BURST_BACKOFF_ENABLE = 0x00800000, 218 /* 219 * Disable post-tx backoff following each frame. 220 */ 221 HAL_TXQ_BACKOFF_DISABLE = 0x00010000, /* disable post backoff */ 222 /* 223 * DCU arbiter lockout control. This controls how 224 * lower priority tx queues are handled with respect to 225 * to a specific queue when multiple queues have frames 226 * to send. No lockout means lower priority queues arbitrate 227 * concurrently with this queue. Intra-frame lockout 228 * means lower priority queues are locked out until the 229 * current frame transmits (e.g. including backoffs and bursting). 230 * Global lockout means nothing lower can arbitrary so 231 * long as there is traffic activity on this queue (frames, 232 * backoff, etc). 233 */ 234 HAL_TXQ_ARB_LOCKOUT_INTRA = 0x00020000, /* intra-frame lockout */ 235 HAL_TXQ_ARB_LOCKOUT_GLOBAL = 0x00040000, /* full lockout s */ 236 237 HAL_TXQ_IGNORE_VIRTCOL = 0x00080000, /* ignore virt collisions */ 238 HAL_TXQ_SEQNUM_INC_DIS = 0x00100000, /* disable seqnum increment */ 239} HAL_TX_QUEUE_FLAGS; 240 241typedef struct { 242 uint32_t tqi_ver; /* hal TXQ version */ 243 HAL_TX_QUEUE_SUBTYPE tqi_subtype; /* subtype if applicable */ 244 HAL_TX_QUEUE_FLAGS tqi_qflags; /* flags (see above) */ 245 uint32_t tqi_priority; /* (not used) */ 246 uint32_t tqi_aifs; /* aifs */ 247 uint32_t tqi_cwmin; /* cwMin */ 248 uint32_t tqi_cwmax; /* cwMax */ 249 uint16_t tqi_shretry; /* rts retry limit */ 250 uint16_t tqi_lgretry; /* long retry limit (not used)*/ 251 uint32_t tqi_cbrPeriod; /* CBR period (us) */ 252 uint32_t tqi_cbrOverflowLimit; /* threshold for CBROVF int */ 253 uint32_t tqi_burstTime; /* max burst duration (us) */ 254 uint32_t tqi_readyTime; /* frame schedule time (us) */ 255 uint32_t tqi_compBuf; /* comp buffer phys addr */ 256} HAL_TXQ_INFO; 257 258#define HAL_TQI_NONVAL 0xffff 259 260/* token to use for aifs, cwmin, cwmax */ 261#define HAL_TXQ_USEDEFAULT ((uint32_t) -1) 262 263/* compression definitions */ 264#define HAL_COMP_BUF_MAX_SIZE 9216 /* 9K */ 265#define HAL_COMP_BUF_ALIGN_SIZE 512 266 267/* 268 * Transmit packet types. This belongs in ah_desc.h, but 269 * is here so we can give a proper type to various parameters 270 * (and not require everyone include the file). 271 * 272 * NB: These values are intentionally assigned for 273 * direct use when setting up h/w descriptors. 274 */ 275typedef enum { 276 HAL_PKT_TYPE_NORMAL = 0, 277 HAL_PKT_TYPE_ATIM = 1, 278 HAL_PKT_TYPE_PSPOLL = 2, 279 HAL_PKT_TYPE_BEACON = 3, 280 HAL_PKT_TYPE_PROBE_RESP = 4, 281 HAL_PKT_TYPE_CHIRP = 5, 282 HAL_PKT_TYPE_GRP_POLL = 6, 283 HAL_PKT_TYPE_AMPDU = 7, 284} HAL_PKT_TYPE; 285 286/* Rx Filter Frame Types */ 287typedef enum { 288 HAL_RX_FILTER_UCAST = 0x00000001, /* Allow unicast frames */ 289 HAL_RX_FILTER_MCAST = 0x00000002, /* Allow multicast frames */ 290 HAL_RX_FILTER_BCAST = 0x00000004, /* Allow broadcast frames */ 291 HAL_RX_FILTER_CONTROL = 0x00000008, /* Allow control frames */ 292 HAL_RX_FILTER_BEACON = 0x00000010, /* Allow beacon frames */ 293 HAL_RX_FILTER_PROM = 0x00000020, /* Promiscuous mode */ 294 HAL_RX_FILTER_PROBEREQ = 0x00000080, /* Allow probe request frames */ 295 HAL_RX_FILTER_PHYERR = 0x00000100, /* Allow phy errors */ 296 HAL_RX_FILTER_PHYRADAR = 0x00000200, /* Allow phy radar errors */ 297 HAL_RX_FILTER_COMPBAR = 0x00000400, /* Allow compressed BAR */ 298} HAL_RX_FILTER; 299 300typedef enum { 301 HAL_PM_AWAKE = 0, 302 HAL_PM_FULL_SLEEP = 1, 303 HAL_PM_NETWORK_SLEEP = 2, 304 HAL_PM_UNDEFINED = 3 305} HAL_POWER_MODE; 306 307/* 308 * NOTE WELL: 309 * These are mapped to take advantage of the common locations for many of 310 * the bits on all of the currently supported MAC chips. This is to make 311 * the ISR as efficient as possible, while still abstracting HW differences. 312 * When new hardware breaks this commonality this enumerated type, as well 313 * as the HAL functions using it, must be modified. All values are directly 314 * mapped unless commented otherwise. 315 */ 316typedef enum { 317 HAL_INT_RX = 0x00000001, /* Non-common mapping */ 318 HAL_INT_RXDESC = 0x00000002, 319 HAL_INT_RXNOFRM = 0x00000008, 320 HAL_INT_RXEOL = 0x00000010, 321 HAL_INT_RXORN = 0x00000020, 322 HAL_INT_TX = 0x00000040, /* Non-common mapping */ 323 HAL_INT_TXDESC = 0x00000080, 324 HAL_INT_TXURN = 0x00000800, 325 HAL_INT_MIB = 0x00001000, 326 HAL_INT_RXPHY = 0x00004000, 327 HAL_INT_RXKCM = 0x00008000, 328 HAL_INT_SWBA = 0x00010000, 329 HAL_INT_BMISS = 0x00040000, 330 HAL_INT_BNR = 0x00100000, /* Non-common mapping */ 331 HAL_INT_TIM = 0x00200000, /* Non-common mapping */ 332 HAL_INT_DTIM = 0x00400000, /* Non-common mapping */ 333 HAL_INT_DTIMSYNC= 0x00800000, /* Non-common mapping */ 334 HAL_INT_GPIO = 0x01000000, 335 HAL_INT_CABEND = 0x02000000, /* Non-common mapping */ 336 HAL_INT_TSFOOR = 0x04000000, /* Non-common mapping */ 337 HAL_INT_CST = 0x10000000, /* Non-common mapping */ 338 HAL_INT_GTT = 0x20000000, /* Non-common mapping */ 339 HAL_INT_FATAL = 0x40000000, /* Non-common mapping */ 340#define HAL_INT_GLOBAL 0x80000000 /* Set/clear IER */ 341 HAL_INT_BMISC = HAL_INT_TIM 342 | HAL_INT_DTIM 343 | HAL_INT_DTIMSYNC 344 | HAL_INT_CABEND, 345 346 /* Interrupt bits that map directly to ISR/IMR bits */ 347 HAL_INT_COMMON = HAL_INT_RXNOFRM 348 | HAL_INT_RXDESC 349 | HAL_INT_RXEOL 350 | HAL_INT_RXORN 351 | HAL_INT_TXURN 352 | HAL_INT_TXDESC 353 | HAL_INT_MIB 354 | HAL_INT_RXPHY 355 | HAL_INT_RXKCM 356 | HAL_INT_SWBA 357 | HAL_INT_BMISS 358 | HAL_INT_GPIO, 359} HAL_INT; 360 361typedef enum { 362 HAL_RFGAIN_INACTIVE = 0, 363 HAL_RFGAIN_READ_REQUESTED = 1, 364 HAL_RFGAIN_NEED_CHANGE = 2 365} HAL_RFGAIN; 366 367typedef uint16_t HAL_CTRY_CODE; /* country code */ 368typedef uint16_t HAL_REG_DOMAIN; /* regulatory domain code */ 369 370#define HAL_ANTENNA_MIN_MODE 0 371#define HAL_ANTENNA_FIXED_A 1 372#define HAL_ANTENNA_FIXED_B 2 373#define HAL_ANTENNA_MAX_MODE 3 374 375typedef struct { 376 uint32_t ackrcv_bad; 377 uint32_t rts_bad; 378 uint32_t rts_good; 379 uint32_t fcs_bad; 380 uint32_t beacons; 381} HAL_MIB_STATS; 382 383enum { 384 HAL_MODE_11A = 0x001, /* 11a channels */ 385 HAL_MODE_TURBO = 0x002, /* 11a turbo-only channels */ 386 HAL_MODE_11B = 0x004, /* 11b channels */ 387 HAL_MODE_PUREG = 0x008, /* 11g channels (OFDM only) */ 388#ifdef notdef 389 HAL_MODE_11G = 0x010, /* 11g channels (OFDM/CCK) */ 390#else 391 HAL_MODE_11G = 0x008, /* XXX historical */ 392#endif 393 HAL_MODE_108G = 0x020, /* 11g+Turbo channels */ 394 HAL_MODE_108A = 0x040, /* 11a+Turbo channels */ 395 HAL_MODE_11A_HALF_RATE = 0x200, /* 11a half width channels */ 396 HAL_MODE_11A_QUARTER_RATE = 0x400, /* 11a quarter width channels */ 397 HAL_MODE_11G_HALF_RATE = 0x800, /* 11g half width channels */ 398 HAL_MODE_11G_QUARTER_RATE = 0x1000, /* 11g quarter width channels */ 399 HAL_MODE_11NG_HT20 = 0x008000, 400 HAL_MODE_11NA_HT20 = 0x010000, 401 HAL_MODE_11NG_HT40PLUS = 0x020000, 402 HAL_MODE_11NG_HT40MINUS = 0x040000, 403 HAL_MODE_11NA_HT40PLUS = 0x080000, 404 HAL_MODE_11NA_HT40MINUS = 0x100000, 405 HAL_MODE_ALL = 0xffffff 406}; 407 408typedef struct { 409 int rateCount; /* NB: for proper padding */ 410 uint8_t rateCodeToIndex[144]; /* back mapping */ 411 struct { 412 uint8_t valid; /* valid for rate control use */ 413 uint8_t phy; /* CCK/OFDM/XR */ 414 uint32_t rateKbps; /* transfer rate in kbs */ 415 uint8_t rateCode; /* rate for h/w descriptors */ 416 uint8_t shortPreamble; /* mask for enabling short 417 * preamble in CCK rate code */ 418 uint8_t dot11Rate; /* value for supported rates 419 * info element of MLME */ 420 uint8_t controlRate; /* index of next lower basic 421 * rate; used for dur. calcs */ 422 uint16_t lpAckDuration; /* long preamble ACK duration */ 423 uint16_t spAckDuration; /* short preamble ACK duration*/ 424 } info[32]; 425} HAL_RATE_TABLE; 426 427typedef struct { 428 u_int rs_count; /* number of valid entries */ 429 uint8_t rs_rates[32]; /* rates */ 430} HAL_RATE_SET; 431 432/* 433 * 802.11n specific structures and enums 434 */ 435typedef enum { 436 HAL_CHAINTYPE_TX = 1, /* Tx chain type */ 437 HAL_CHAINTYPE_RX = 2, /* RX chain type */ 438} HAL_CHAIN_TYPE; 439 440typedef struct { 441 u_int Tries; 442 u_int Rate; 443 u_int PktDuration; 444 u_int ChSel; 445 u_int RateFlags; 446#define HAL_RATESERIES_RTS_CTS 0x0001 /* use rts/cts w/this series */ 447#define HAL_RATESERIES_2040 0x0002 /* use ext channel for series */ 448#define HAL_RATESERIES_HALFGI 0x0004 /* use half-gi for series */ 449} HAL_11N_RATE_SERIES; 450 451typedef enum { 452 HAL_HT_MACMODE_20 = 0, /* 20 MHz operation */ 453 HAL_HT_MACMODE_2040 = 1, /* 20/40 MHz operation */ 454} HAL_HT_MACMODE; 455 456typedef enum { 457 HAL_HT_PHYMODE_20 = 0, /* 20 MHz operation */ 458 HAL_HT_PHYMODE_2040 = 1, /* 20/40 MHz operation */ 459} HAL_HT_PHYMODE; 460 461typedef enum { 462 HAL_HT_EXTPROTSPACING_20 = 0, /* 20 MHz spacing */ 463 HAL_HT_EXTPROTSPACING_25 = 1, /* 25 MHz spacing */ 464} HAL_HT_EXTPROTSPACING; 465 466 467typedef enum { 468 HAL_RX_CLEAR_CTL_LOW = 0x1, /* force control channel to appear busy */ 469 HAL_RX_CLEAR_EXT_LOW = 0x2, /* force extension channel to appear busy */ 470} HAL_HT_RXCLEAR; 471 472/* 473 * Antenna switch control. By default antenna selection 474 * enables multiple (2) antenna use. To force use of the 475 * A or B antenna only specify a fixed setting. Fixing 476 * the antenna will also disable any diversity support. 477 */ 478typedef enum { 479 HAL_ANT_VARIABLE = 0, /* variable by programming */ 480 HAL_ANT_FIXED_A = 1, /* fixed antenna A */ 481 HAL_ANT_FIXED_B = 2, /* fixed antenna B */ 482} HAL_ANT_SETTING; 483 484typedef enum { 485 HAL_M_STA = 1, /* infrastructure station */ 486 HAL_M_IBSS = 0, /* IBSS (adhoc) station */ 487 HAL_M_HOSTAP = 6, /* Software Access Point */ 488 HAL_M_MONITOR = 8 /* Monitor mode */ 489} HAL_OPMODE; 490 491typedef struct { 492 uint8_t kv_type; /* one of HAL_CIPHER */ 493 uint8_t kv_pad; 494 uint16_t kv_len; /* length in bits */ 495 uint8_t kv_val[16]; /* enough for 128-bit keys */ 496 uint8_t kv_mic[8]; /* TKIP MIC key */ 497 uint8_t kv_txmic[8]; /* TKIP TX MIC key (optional) */ 498} HAL_KEYVAL; 499 500typedef enum { 501 HAL_CIPHER_WEP = 0, 502 HAL_CIPHER_AES_OCB = 1, 503 HAL_CIPHER_AES_CCM = 2, 504 HAL_CIPHER_CKIP = 3, 505 HAL_CIPHER_TKIP = 4, 506 HAL_CIPHER_CLR = 5, /* no encryption */ 507 508 HAL_CIPHER_MIC = 127 /* TKIP-MIC, not a cipher */ 509} HAL_CIPHER; 510 511enum { 512 HAL_SLOT_TIME_6 = 6, /* NB: for turbo mode */ 513 HAL_SLOT_TIME_9 = 9, 514 HAL_SLOT_TIME_20 = 20, 515}; 516 517/* 518 * Per-station beacon timer state. Note that the specified 519 * beacon interval (given in TU's) can also include flags 520 * to force a TSF reset and to enable the beacon xmit logic. 521 * If bs_cfpmaxduration is non-zero the hardware is setup to 522 * coexist with a PCF-capable AP. 523 */ 524typedef struct { 525 uint32_t bs_nexttbtt; /* next beacon in TU */ 526 uint32_t bs_nextdtim; /* next DTIM in TU */ 527 uint32_t bs_intval; /* beacon interval+flags */ 528#define HAL_BEACON_PERIOD 0x0000ffff /* beacon interval period */ 529#define HAL_BEACON_ENA 0x00800000 /* beacon xmit enable */ 530#define HAL_BEACON_RESET_TSF 0x01000000 /* clear TSF */ 531 uint32_t bs_dtimperiod; 532 uint16_t bs_cfpperiod; /* CFP period in TU */ 533 uint16_t bs_cfpmaxduration; /* max CFP duration in TU */ 534 uint32_t bs_cfpnext; /* next CFP in TU */ 535 uint16_t bs_timoffset; /* byte offset to TIM bitmap */ 536 uint16_t bs_bmissthreshold; /* beacon miss threshold */ 537 uint32_t bs_sleepduration; /* max sleep duration */ 538} HAL_BEACON_STATE; 539 540/* 541 * Like HAL_BEACON_STATE but for non-station mode setup. 542 * NB: see above flag definitions for bt_intval. 543 */ 544typedef struct { 545 uint32_t bt_intval; /* beacon interval+flags */ 546 uint32_t bt_nexttbtt; /* next beacon in TU */ 547 uint32_t bt_nextatim; /* next ATIM in TU */ 548 uint32_t bt_nextdba; /* next DBA in 1/8th TU */ 549 uint32_t bt_nextswba; /* next SWBA in 1/8th TU */ 550 uint32_t bt_flags; /* timer enables */ 551#define HAL_BEACON_TBTT_EN 0x00000001 552#define HAL_BEACON_DBA_EN 0x00000002 553#define HAL_BEACON_SWBA_EN 0x00000004 554} HAL_BEACON_TIMERS; 555 556/* 557 * Per-node statistics maintained by the driver for use in 558 * optimizing signal quality and other operational aspects. 559 */ 560typedef struct { 561 uint32_t ns_avgbrssi; /* average beacon rssi */ 562 uint32_t ns_avgrssi; /* average data rssi */ 563 uint32_t ns_avgtxrssi; /* average tx rssi */ 564} HAL_NODE_STATS; 565 566#define HAL_RSSI_EP_MULTIPLIER (1<<7) /* pow2 to optimize out * and / */ 567 568struct ath_desc; 569struct ath_tx_status; 570struct ath_rx_status; 571struct ieee80211_channel; 572 573/* 574 * Hardware Access Layer (HAL) API. 575 * 576 * Clients of the HAL call ath_hal_attach to obtain a reference to an 577 * ath_hal structure for use with the device. Hardware-related operations 578 * that follow must call back into the HAL through interface, supplying 579 * the reference as the first parameter. Note that before using the 580 * reference returned by ath_hal_attach the caller should verify the 581 * ABI version number. 582 */ 583struct ath_hal { 584 uint32_t ah_magic; /* consistency check magic number */ 585 uint32_t ah_abi; /* HAL ABI version */ 586#define HAL_ABI_VERSION 0x08112800 /* YYMMDDnn */ 587 uint16_t ah_devid; /* PCI device ID */ 588 uint16_t ah_subvendorid; /* PCI subvendor ID */ 589 HAL_SOFTC ah_sc; /* back pointer to driver/os state */ 590 HAL_BUS_TAG ah_st; /* params for register r+w */ 591 HAL_BUS_HANDLE ah_sh; 592 HAL_CTRY_CODE ah_countryCode; 593 594 uint32_t ah_macVersion; /* MAC version id */ 595 uint16_t ah_macRev; /* MAC revision */ 596 uint16_t ah_phyRev; /* PHY revision */ 597 /* NB: when only one radio is present the rev is in 5Ghz */ 598 uint16_t ah_analog5GhzRev;/* 5GHz radio revision */ 599 uint16_t ah_analog2GhzRev;/* 2GHz radio revision */ 600 601 const HAL_RATE_TABLE *__ahdecl(*ah_getRateTable)(struct ath_hal *, 602 u_int mode); 603 void __ahdecl(*ah_detach)(struct ath_hal*); 604 605 /* Reset functions */ 606 HAL_BOOL __ahdecl(*ah_reset)(struct ath_hal *, HAL_OPMODE, 607 struct ieee80211_channel *, 608 HAL_BOOL bChannelChange, HAL_STATUS *status); 609 HAL_BOOL __ahdecl(*ah_phyDisable)(struct ath_hal *); 610 HAL_BOOL __ahdecl(*ah_disable)(struct ath_hal *); 611 void __ahdecl(*ah_setPCUConfig)(struct ath_hal *); 612 HAL_BOOL __ahdecl(*ah_perCalibration)(struct ath_hal*, 613 struct ieee80211_channel *, HAL_BOOL *); 614 HAL_BOOL __ahdecl(*ah_perCalibrationN)(struct ath_hal *, 615 struct ieee80211_channel *, u_int chainMask, 616 HAL_BOOL longCal, HAL_BOOL *isCalDone); 617 HAL_BOOL __ahdecl(*ah_resetCalValid)(struct ath_hal *, 618 const struct ieee80211_channel *); 619 HAL_BOOL __ahdecl(*ah_setTxPowerLimit)(struct ath_hal *, uint32_t); 620 621 /* Transmit functions */ 622 HAL_BOOL __ahdecl(*ah_updateTxTrigLevel)(struct ath_hal*, 623 HAL_BOOL incTrigLevel); 624 int __ahdecl(*ah_setupTxQueue)(struct ath_hal *, HAL_TX_QUEUE, 625 const HAL_TXQ_INFO *qInfo); 626 HAL_BOOL __ahdecl(*ah_setTxQueueProps)(struct ath_hal *, int q, 627 const HAL_TXQ_INFO *qInfo); 628 HAL_BOOL __ahdecl(*ah_getTxQueueProps)(struct ath_hal *, int q, 629 HAL_TXQ_INFO *qInfo); 630 HAL_BOOL __ahdecl(*ah_releaseTxQueue)(struct ath_hal *ah, u_int q); 631 HAL_BOOL __ahdecl(*ah_resetTxQueue)(struct ath_hal *ah, u_int q); 632 uint32_t __ahdecl(*ah_getTxDP)(struct ath_hal*, u_int); 633 HAL_BOOL __ahdecl(*ah_setTxDP)(struct ath_hal*, u_int, uint32_t txdp); 634 uint32_t __ahdecl(*ah_numTxPending)(struct ath_hal *, u_int q); 635 HAL_BOOL __ahdecl(*ah_startTxDma)(struct ath_hal*, u_int); 636 HAL_BOOL __ahdecl(*ah_stopTxDma)(struct ath_hal*, u_int); 637 HAL_BOOL __ahdecl(*ah_setupTxDesc)(struct ath_hal *, struct ath_desc *, 638 u_int pktLen, u_int hdrLen, 639 HAL_PKT_TYPE type, u_int txPower, 640 u_int txRate0, u_int txTries0, 641 u_int keyIx, u_int antMode, u_int flags, 642 u_int rtsctsRate, u_int rtsctsDuration, 643 u_int compicvLen, u_int compivLen, 644 u_int comp); 645 HAL_BOOL __ahdecl(*ah_setupXTxDesc)(struct ath_hal *, struct ath_desc*, 646 u_int txRate1, u_int txTries1, 647 u_int txRate2, u_int txTries2, 648 u_int txRate3, u_int txTries3); 649 HAL_BOOL __ahdecl(*ah_fillTxDesc)(struct ath_hal *, struct ath_desc *, 650 u_int segLen, HAL_BOOL firstSeg, 651 HAL_BOOL lastSeg, const struct ath_desc *); 652 HAL_STATUS __ahdecl(*ah_procTxDesc)(struct ath_hal *, 653 struct ath_desc *, struct ath_tx_status *); 654 void __ahdecl(*ah_getTxIntrQueue)(struct ath_hal *, uint32_t *); 655 void __ahdecl(*ah_reqTxIntrDesc)(struct ath_hal *, struct ath_desc*); 656 657 /* Receive Functions */ 658 uint32_t __ahdecl(*ah_getRxDP)(struct ath_hal*); 659 void __ahdecl(*ah_setRxDP)(struct ath_hal*, uint32_t rxdp); 660 void __ahdecl(*ah_enableReceive)(struct ath_hal*); 661 HAL_BOOL __ahdecl(*ah_stopDmaReceive)(struct ath_hal*); 662 void __ahdecl(*ah_startPcuReceive)(struct ath_hal*); 663 void __ahdecl(*ah_stopPcuReceive)(struct ath_hal*); 664 void __ahdecl(*ah_setMulticastFilter)(struct ath_hal*, 665 uint32_t filter0, uint32_t filter1); 666 HAL_BOOL __ahdecl(*ah_setMulticastFilterIndex)(struct ath_hal*, 667 uint32_t index); 668 HAL_BOOL __ahdecl(*ah_clrMulticastFilterIndex)(struct ath_hal*, 669 uint32_t index); 670 uint32_t __ahdecl(*ah_getRxFilter)(struct ath_hal*); 671 void __ahdecl(*ah_setRxFilter)(struct ath_hal*, uint32_t); 672 HAL_BOOL __ahdecl(*ah_setupRxDesc)(struct ath_hal *, struct ath_desc *, 673 uint32_t size, u_int flags); 674 HAL_STATUS __ahdecl(*ah_procRxDesc)(struct ath_hal *, 675 struct ath_desc *, uint32_t phyAddr, 676 struct ath_desc *next, uint64_t tsf, 677 struct ath_rx_status *); 678 void __ahdecl(*ah_rxMonitor)(struct ath_hal *, 679 const HAL_NODE_STATS *, 680 const struct ieee80211_channel *); 681 void __ahdecl(*ah_procMibEvent)(struct ath_hal *, 682 const HAL_NODE_STATS *); 683 684 /* Misc Functions */ 685 HAL_STATUS __ahdecl(*ah_getCapability)(struct ath_hal *, 686 HAL_CAPABILITY_TYPE, uint32_t capability, 687 uint32_t *result); 688 HAL_BOOL __ahdecl(*ah_setCapability)(struct ath_hal *, 689 HAL_CAPABILITY_TYPE, uint32_t capability, 690 uint32_t setting, HAL_STATUS *); 691 HAL_BOOL __ahdecl(*ah_getDiagState)(struct ath_hal *, int request, 692 const void *args, uint32_t argsize, 693 void **result, uint32_t *resultsize); 694 void __ahdecl(*ah_getMacAddress)(struct ath_hal *, uint8_t *); 695 HAL_BOOL __ahdecl(*ah_setMacAddress)(struct ath_hal *, const uint8_t*); 696 void __ahdecl(*ah_getBssIdMask)(struct ath_hal *, uint8_t *); 697 HAL_BOOL __ahdecl(*ah_setBssIdMask)(struct ath_hal *, const uint8_t*); 698 HAL_BOOL __ahdecl(*ah_setRegulatoryDomain)(struct ath_hal*, 699 uint16_t, HAL_STATUS *); 700 void __ahdecl(*ah_setLedState)(struct ath_hal*, HAL_LED_STATE); 701 void __ahdecl(*ah_writeAssocid)(struct ath_hal*, 702 const uint8_t *bssid, uint16_t assocId); 703 HAL_BOOL __ahdecl(*ah_gpioCfgOutput)(struct ath_hal *, uint32_t gpio); 704 HAL_BOOL __ahdecl(*ah_gpioCfgInput)(struct ath_hal *, uint32_t gpio); 705 uint32_t __ahdecl(*ah_gpioGet)(struct ath_hal *, uint32_t gpio); 706 HAL_BOOL __ahdecl(*ah_gpioSet)(struct ath_hal *, 707 uint32_t gpio, uint32_t val); 708 void __ahdecl(*ah_gpioSetIntr)(struct ath_hal*, u_int, uint32_t); 709 uint32_t __ahdecl(*ah_getTsf32)(struct ath_hal*); 710 uint64_t __ahdecl(*ah_getTsf64)(struct ath_hal*); 711 void __ahdecl(*ah_resetTsf)(struct ath_hal*); 712 HAL_BOOL __ahdecl(*ah_detectCardPresent)(struct ath_hal*); 713 void __ahdecl(*ah_updateMibCounters)(struct ath_hal*, 714 HAL_MIB_STATS*); 715 HAL_RFGAIN __ahdecl(*ah_getRfGain)(struct ath_hal*); 716 u_int __ahdecl(*ah_getDefAntenna)(struct ath_hal*); 717 void __ahdecl(*ah_setDefAntenna)(struct ath_hal*, u_int); 718 HAL_ANT_SETTING __ahdecl(*ah_getAntennaSwitch)(struct ath_hal*); 719 HAL_BOOL __ahdecl(*ah_setAntennaSwitch)(struct ath_hal*, 720 HAL_ANT_SETTING); 721 HAL_BOOL __ahdecl(*ah_setSifsTime)(struct ath_hal*, u_int); 722 u_int __ahdecl(*ah_getSifsTime)(struct ath_hal*); 723 HAL_BOOL __ahdecl(*ah_setSlotTime)(struct ath_hal*, u_int); 724 u_int __ahdecl(*ah_getSlotTime)(struct ath_hal*); 725 HAL_BOOL __ahdecl(*ah_setAckTimeout)(struct ath_hal*, u_int); 726 u_int __ahdecl(*ah_getAckTimeout)(struct ath_hal*); 727 HAL_BOOL __ahdecl(*ah_setAckCTSRate)(struct ath_hal*, u_int); 728 u_int __ahdecl(*ah_getAckCTSRate)(struct ath_hal*); 729 HAL_BOOL __ahdecl(*ah_setCTSTimeout)(struct ath_hal*, u_int); 730 u_int __ahdecl(*ah_getCTSTimeout)(struct ath_hal*); 731 HAL_BOOL __ahdecl(*ah_setDecompMask)(struct ath_hal*, uint16_t, int); 732 void __ahdecl(*ah_setCoverageClass)(struct ath_hal*, uint8_t, int); 733 734 /* Key Cache Functions */ 735 uint32_t __ahdecl(*ah_getKeyCacheSize)(struct ath_hal*); 736 HAL_BOOL __ahdecl(*ah_resetKeyCacheEntry)(struct ath_hal*, uint16_t); 737 HAL_BOOL __ahdecl(*ah_isKeyCacheEntryValid)(struct ath_hal *, 738 uint16_t); 739 HAL_BOOL __ahdecl(*ah_setKeyCacheEntry)(struct ath_hal*, 740 uint16_t, const HAL_KEYVAL *, 741 const uint8_t *, int); 742 HAL_BOOL __ahdecl(*ah_setKeyCacheEntryMac)(struct ath_hal*, 743 uint16_t, const uint8_t *); 744 745 /* Power Management Functions */ 746 HAL_BOOL __ahdecl(*ah_setPowerMode)(struct ath_hal*, 747 HAL_POWER_MODE mode, int setChip); 748 HAL_POWER_MODE __ahdecl(*ah_getPowerMode)(struct ath_hal*); 749 int16_t __ahdecl(*ah_getChanNoise)(struct ath_hal *, 750 const struct ieee80211_channel *); 751 752 /* Beacon Management Functions */ 753 void __ahdecl(*ah_setBeaconTimers)(struct ath_hal*, 754 const HAL_BEACON_TIMERS *); 755 /* NB: deprecated, use ah_setBeaconTimers instead */ 756 void __ahdecl(*ah_beaconInit)(struct ath_hal *, 757 uint32_t nexttbtt, uint32_t intval); 758 void __ahdecl(*ah_setStationBeaconTimers)(struct ath_hal*, 759 const HAL_BEACON_STATE *); 760 void __ahdecl(*ah_resetStationBeaconTimers)(struct ath_hal*); 761 762 /* Interrupt functions */ 763 HAL_BOOL __ahdecl(*ah_isInterruptPending)(struct ath_hal*); 764 HAL_BOOL __ahdecl(*ah_getPendingInterrupts)(struct ath_hal*, HAL_INT*); 765 HAL_INT __ahdecl(*ah_getInterrupts)(struct ath_hal*); 766 HAL_INT __ahdecl(*ah_setInterrupts)(struct ath_hal*, HAL_INT); 767}; 768 769/* 770 * Check the PCI vendor ID and device ID against Atheros' values 771 * and return a printable description for any Atheros hardware. 772 * AH_NULL is returned if the ID's do not describe Atheros hardware. 773 */ 774extern const char *__ahdecl ath_hal_probe(uint16_t vendorid, uint16_t devid); 775 776/* 777 * Attach the HAL for use with the specified device. The device is 778 * defined by the PCI device ID. The caller provides an opaque pointer 779 * to an upper-layer data structure (HAL_SOFTC) that is stored in the 780 * HAL state block for later use. Hardware register accesses are done 781 * using the specified bus tag and handle. On successful return a 782 * reference to a state block is returned that must be supplied in all 783 * subsequent HAL calls. Storage associated with this reference is 784 * dynamically allocated and must be freed by calling the ah_detach 785 * method when the client is done. If the attach operation fails a 786 * null (AH_NULL) reference will be returned and a status code will 787 * be returned if the status parameter is non-zero. 788 */ 789extern struct ath_hal * __ahdecl ath_hal_attach(uint16_t devid, HAL_SOFTC, 790 HAL_BUS_TAG, HAL_BUS_HANDLE, HAL_STATUS* status); 791 792extern const char *ath_hal_mac_name(struct ath_hal *); 793extern const char *ath_hal_rf_name(struct ath_hal *); 794 795/* 796 * Regulatory interfaces. Drivers should use ath_hal_init_channels to 797 * request a set of channels for a particular country code and/or 798 * regulatory domain. If CTRY_DEFAULT and SKU_NONE are specified then 799 * this list is constructed according to the contents of the EEPROM. 800 * ath_hal_getchannels acts similarly but does not alter the operating 801 * state; this can be used to collect information for a particular 802 * regulatory configuration. Finally ath_hal_set_channels installs a 803 * channel list constructed outside the driver. The HAL will adopt the 804 * channel list and setup internal state according to the specified 805 * regulatory configuration (e.g. conformance test limits). 806 * 807 * For all interfaces the channel list is returned in the supplied array. 808 * maxchans defines the maximum size of this array. nchans contains the 809 * actual number of channels returned. If a problem occurred then a 810 * status code != HAL_OK is returned. 811 */ 812struct ieee80211_channel; 813 814/* 815 * Return a list of channels according to the specified regulatory. 816 */ 817extern HAL_STATUS __ahdecl ath_hal_getchannels(struct ath_hal *, 818 struct ieee80211_channel *chans, u_int maxchans, int *nchans, 819 u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn, 820 HAL_BOOL enableExtendedChannels); 821 822/* 823 * Return a list of channels and install it as the current operating 824 * regulatory list. 825 */ 826extern HAL_STATUS __ahdecl ath_hal_init_channels(struct ath_hal *, 827 struct ieee80211_channel *chans, u_int maxchans, int *nchans, 828 u_int modeSelect, HAL_CTRY_CODE cc, HAL_REG_DOMAIN rd, 829 HAL_BOOL enableExtendedChannels); 830 831/* 832 * Install the list of channels as the current operating regulatory 833 * and setup related state according to the country code and sku. 834 */ 835extern HAL_STATUS __ahdecl ath_hal_set_channels(struct ath_hal *, 836 struct ieee80211_channel *chans, int nchans, 837 HAL_CTRY_CODE cc, HAL_REG_DOMAIN regDmn); 838 839/* 840 * Calibrate noise floor data following a channel scan or similar. 841 * This must be called prior retrieving noise floor data. 842 */ 843extern void __ahdecl ath_hal_process_noisefloor(struct ath_hal *ah); 844 845/* 846 * Return bit mask of wireless modes supported by the hardware. 847 */ 848extern u_int __ahdecl ath_hal_getwirelessmodes(struct ath_hal*); 849 850/* 851 * Calculate the transmit duration of a frame. 852 */ 853extern uint16_t __ahdecl ath_hal_computetxtime(struct ath_hal *, 854 const HAL_RATE_TABLE *rates, uint32_t frameLen, 855 uint16_t rateix, HAL_BOOL shortPreamble); 856#endif /* _ATH_AH_H_ */ 857