ah_internal.h revision 185380
1/* 2 * Copyright (c) 2002-2008 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 * $Id: ah_internal.h,v 1.21 2008/11/27 22:29:27 sam Exp $ 18 */ 19#ifndef _ATH_AH_INTERAL_H_ 20#define _ATH_AH_INTERAL_H_ 21/* 22 * Atheros Device Hardware Access Layer (HAL). 23 * 24 * Internal definitions. 25 */ 26#define AH_NULL 0 27#define AH_MIN(a,b) ((a)<(b)?(a):(b)) 28#define AH_MAX(a,b) ((a)>(b)?(a):(b)) 29 30#ifndef NBBY 31#define NBBY 8 /* number of bits/byte */ 32#endif 33 34#ifndef roundup 35#define roundup(x, y) ((((x)+((y)-1))/(y))*(y)) /* to any y */ 36#endif 37#ifndef howmany 38#define howmany(x, y) (((x)+((y)-1))/(y)) 39#endif 40 41#ifndef offsetof 42#define offsetof(type, field) ((size_t)(&((type *)0)->field)) 43#endif 44 45/* 46 * Remove const in a way that keeps the compiler happy. 47 * This works for gcc but may require other magic for 48 * other compilers (not sure where this should reside). 49 * Note that uintptr_t is C99. 50 */ 51#ifndef __DECONST 52#ifndef _UINTPTR_T 53#if AH_WORDSIZE == 64 54typedef unsigned long int uintptr_t; 55#else 56typedef unsigned int uintptr_t; 57#endif 58#endif 59#define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var)) 60#endif 61 62typedef struct { 63 uint16_t start; /* first register */ 64 uint16_t end; /* ending register or zero */ 65} HAL_REGRANGE; 66 67/* 68 * Transmit power scale factor. 69 * 70 * NB: This is not public because we want to discourage the use of 71 * scaling; folks should use the tx power limit interface. 72 */ 73typedef enum { 74 HAL_TP_SCALE_MAX = 0, /* no scaling (default) */ 75 HAL_TP_SCALE_50 = 1, /* 50% of max (-3 dBm) */ 76 HAL_TP_SCALE_25 = 2, /* 25% of max (-6 dBm) */ 77 HAL_TP_SCALE_12 = 3, /* 12% of max (-9 dBm) */ 78 HAL_TP_SCALE_MIN = 4, /* min, but still on */ 79} HAL_TP_SCALE; 80 81typedef enum { 82 HAL_CAP_RADAR = 0, /* Radar capability */ 83 HAL_CAP_AR = 1, /* AR capability */ 84} HAL_PHYDIAG_CAPS; 85 86 87/* 88 * Internal form of a HAL_CHANNEL. Note that the structure 89 * must be defined such that you can cast references to a 90 * HAL_CHANNEL so don't shuffle the first two members. 91 */ 92typedef struct { 93 uint32_t channelFlags; 94 uint16_t channel; /* NB: must be first for casting */ 95 uint8_t privFlags; 96 int8_t maxRegTxPower; 97 int8_t maxTxPower; 98 int8_t minTxPower; /* as above... */ 99 100 HAL_BOOL bssSendHere; 101 uint8_t gainI; 102 HAL_BOOL iqCalValid; 103 uint8_t calValid; /* bitmask of cal types */ 104 int8_t iCoff; 105 int8_t qCoff; 106 int16_t rawNoiseFloor; 107 int16_t noiseFloorAdjust; 108 int8_t antennaMax; 109 uint32_t regDmnFlags; /* Flags for channel use in reg */ 110 uint32_t conformanceTestLimit; /* conformance test limit from reg domain */ 111 uint16_t mainSpur; /* cached spur value for this cahnnel */ 112} HAL_CHANNEL_INTERNAL; 113 114typedef struct { 115 uint32_t halChanSpreadSupport : 1, 116 halSleepAfterBeaconBroken : 1, 117 halCompressSupport : 1, 118 halBurstSupport : 1, 119 halFastFramesSupport : 1, 120 halChapTuningSupport : 1, 121 halTurboGSupport : 1, 122 halTurboPrimeSupport : 1, 123 halMicAesCcmSupport : 1, 124 halMicCkipSupport : 1, 125 halMicTkipSupport : 1, 126 halTkipMicTxRxKeySupport : 1, 127 halCipherAesCcmSupport : 1, 128 halCipherCkipSupport : 1, 129 halCipherTkipSupport : 1, 130 halPSPollBroken : 1, 131 halVEOLSupport : 1, 132 halBssIdMaskSupport : 1, 133 halMcastKeySrchSupport : 1, 134 halTsfAddSupport : 1, 135 halChanHalfRate : 1, 136 halChanQuarterRate : 1, 137 halHTSupport : 1, 138 halRfSilentSupport : 1, 139 halHwPhyCounterSupport : 1, 140 halWowSupport : 1, 141 halWowMatchPatternExact : 1, 142 halAutoSleepSupport : 1, 143 halFastCCSupport : 1, 144 halBtCoexSupport : 1; 145 uint32_t halRxStbcSupport : 1, 146 halTxStbcSupport : 1, 147 halGTTSupport : 1, 148 halCSTSupport : 1, 149 halRifsRxSupport : 1, 150 halRifsTxSupport : 1, 151 halExtChanDfsSupport : 1, 152 halForcePpmSupport : 1, 153 halEnhancedPmSupport : 1, 154 halMbssidAggrSupport : 1; 155 uint32_t halWirelessModes; 156 uint16_t halTotalQueues; 157 uint16_t halKeyCacheSize; 158 uint16_t halLow5GhzChan, halHigh5GhzChan; 159 uint16_t halLow2GhzChan, halHigh2GhzChan; 160 int halTstampPrecision; 161 int halRtsAggrLimit; 162 uint8_t halTxChainMask; 163 uint8_t halRxChainMask; 164 uint8_t halNumGpioPins; 165 uint8_t halNumAntCfg2GHz; 166 uint8_t halNumAntCfg5GHz; 167} HAL_CAPABILITIES; 168 169/* 170 * The ``private area'' follows immediately after the ``public area'' 171 * in the data structure returned by ath_hal_attach. Private data are 172 * used by device-independent code such as the regulatory domain support. 173 * In general, code within the HAL should never depend on data in the 174 * public area. Instead any public data needed internally should be 175 * shadowed here. 176 * 177 * When declaring a device-specific ath_hal data structure this structure 178 * is assumed to at the front; e.g. 179 * 180 * struct ath_hal_5212 { 181 * struct ath_hal_private ah_priv; 182 * ... 183 * }; 184 * 185 * It might be better to manage the method pointers in this structure 186 * using an indirect pointer to a read-only data structure but this would 187 * disallow class-style method overriding. 188 */ 189struct ath_hal_private { 190 struct ath_hal h; /* public area */ 191 192 /* NB: all methods go first to simplify initialization */ 193 HAL_BOOL (*ah_getChannelEdges)(struct ath_hal*, 194 uint16_t channelFlags, 195 uint16_t *lowChannel, uint16_t *highChannel); 196 u_int (*ah_getWirelessModes)(struct ath_hal*); 197 HAL_BOOL (*ah_eepromRead)(struct ath_hal *, u_int off, 198 uint16_t *data); 199 HAL_BOOL (*ah_eepromWrite)(struct ath_hal *, u_int off, 200 uint16_t data); 201 HAL_BOOL (*ah_gpioCfgOutput)(struct ath_hal *, uint32_t gpio); 202 HAL_BOOL (*ah_gpioCfgInput)(struct ath_hal *, uint32_t gpio); 203 uint32_t (*ah_gpioGet)(struct ath_hal *, uint32_t gpio); 204 HAL_BOOL (*ah_gpioSet)(struct ath_hal *, 205 uint32_t gpio, uint32_t val); 206 void (*ah_gpioSetIntr)(struct ath_hal*, u_int, uint32_t); 207 HAL_BOOL (*ah_getChipPowerLimits)(struct ath_hal *, 208 HAL_CHANNEL *, uint32_t); 209 int16_t (*ah_getNfAdjust)(struct ath_hal *, 210 const HAL_CHANNEL_INTERNAL*); 211 void (*ah_getNoiseFloor)(struct ath_hal *, 212 int16_t nfarray[]); 213 214 void *ah_eeprom; /* opaque EEPROM state */ 215 uint16_t ah_eeversion; /* EEPROM version */ 216 void (*ah_eepromDetach)(struct ath_hal *); 217 HAL_STATUS (*ah_eepromGet)(struct ath_hal *, int, void *); 218 HAL_BOOL (*ah_eepromSet)(struct ath_hal *, int, int); 219 uint16_t (*ah_getSpurChan)(struct ath_hal *, int, HAL_BOOL); 220 HAL_BOOL (*ah_eepromDiag)(struct ath_hal *, int request, 221 const void *args, uint32_t argsize, 222 void **result, uint32_t *resultsize); 223 224 /* 225 * Device revision information. 226 */ 227 uint16_t ah_devid; /* PCI device ID */ 228 uint16_t ah_subvendorid; /* PCI subvendor ID */ 229 uint32_t ah_macVersion; /* MAC version id */ 230 uint16_t ah_macRev; /* MAC revision */ 231 uint16_t ah_phyRev; /* PHY revision */ 232 uint16_t ah_analog5GhzRev; /* 2GHz radio revision */ 233 uint16_t ah_analog2GhzRev; /* 5GHz radio revision */ 234 235 236 HAL_OPMODE ah_opmode; /* operating mode from reset */ 237 HAL_CAPABILITIES ah_caps; /* device capabilities */ 238 uint32_t ah_diagreg; /* user-specified AR_DIAG_SW */ 239 int16_t ah_powerLimit; /* tx power cap */ 240 uint16_t ah_maxPowerLevel; /* calculated max tx power */ 241 u_int ah_tpScale; /* tx power scale factor */ 242 uint32_t ah_11nCompat; /* 11n compat controls */ 243 244 /* 245 * State for regulatory domain handling. 246 */ 247 HAL_REG_DOMAIN ah_currentRD; /* Current regulatory domain */ 248 HAL_CTRY_CODE ah_countryCode; /* current country code */ 249 HAL_CHANNEL_INTERNAL ah_channels[256]; /* calculated channel list */ 250 u_int ah_nchan; /* valid channels in list */ 251 HAL_CHANNEL_INTERNAL *ah_curchan; /* current channel */ 252 253 uint8_t ah_coverageClass; /* coverage class */ 254 HAL_BOOL ah_regdomainUpdate; /* regdomain is updated? */ 255 /* 256 * RF Silent handling; setup according to the EEPROM. 257 */ 258 uint16_t ah_rfsilent; /* GPIO pin + polarity */ 259 HAL_BOOL ah_rfkillEnabled; /* enable/disable RfKill */ 260 /* 261 * Diagnostic support for discriminating HIUERR reports. 262 */ 263 uint32_t ah_fatalState[6]; /* AR_ISR+shadow regs */ 264 int ah_rxornIsFatal; /* how to treat HAL_INT_RXORN */ 265}; 266 267#define AH_PRIVATE(_ah) ((struct ath_hal_private *)(_ah)) 268 269#define ath_hal_getChannelEdges(_ah, _cf, _lc, _hc) \ 270 AH_PRIVATE(_ah)->ah_getChannelEdges(_ah, _cf, _lc, _hc) 271#define ath_hal_getWirelessModes(_ah) \ 272 AH_PRIVATE(_ah)->ah_getWirelessModes(_ah) 273#define ath_hal_eepromRead(_ah, _off, _data) \ 274 AH_PRIVATE(_ah)->ah_eepromRead(_ah, _off, _data) 275#define ath_hal_eepromWrite(_ah, _off, _data) \ 276 AH_PRIVATE(_ah)->ah_eepromWrite(_ah, _off, _data) 277#define ath_hal_gpioCfgOutput(_ah, _gpio) \ 278 AH_PRIVATE(_ah)->ah_gpioCfgOutput(_ah, _gpio) 279#define ath_hal_gpioCfgInput(_ah, _gpio) \ 280 AH_PRIVATE(_ah)->ah_gpioCfgInput(_ah, _gpio) 281#define ath_hal_gpioGet(_ah, _gpio) \ 282 AH_PRIVATE(_ah)->ah_gpioGet(_ah, _gpio) 283#define ath_hal_gpioSet(_ah, _gpio, _val) \ 284 AH_PRIVATE(_ah)->ah_gpioGet(_ah, _gpio, _val) 285#define ath_hal_gpioSetIntr(_ah, _gpio, _ilevel) \ 286 AH_PRIVATE(_ah)->ah_gpioSetIntr(_ah, _gpio, _ilevel) 287#define ath_hal_getpowerlimits(_ah, _chans, _nchan) \ 288 AH_PRIVATE(_ah)->ah_getChipPowerLimits(_ah, _chans, _nchan) 289#define ath_hal_getNfAdjust(_ah, _c) \ 290 AH_PRIVATE(_ah)->ah_getNfAdjust(_ah, _c) 291#define ath_hal_getNoiseFloor(_ah, _nfArray) \ 292 AH_PRIVATE(_ah)->ah_getNoiseFloor(_ah, _nfArray) 293 294#define ath_hal_eepromDetach(_ah) \ 295 AH_PRIVATE(_ah)->ah_eepromDetach(_ah) 296#define ath_hal_eepromGet(_ah, _param, _val) \ 297 AH_PRIVATE(_ah)->ah_eepromGet(_ah, _param, _val) 298#define ath_hal_eepromSet(_ah, _param, _val) \ 299 AH_PRIVATE(_ah)->ah_eepromSet(_ah, _param, _val) 300#define ath_hal_eepromGetFlag(_ah, _param) \ 301 (AH_PRIVATE(_ah)->ah_eepromGet(_ah, _param, AH_NULL) == HAL_OK) 302#define ath_hal_getSpurChan(_ah, _ix, _is2G) \ 303 AH_PRIVATE(_ah)->ah_getSpurChan(_ah, _ix, _is2G) 304#define ath_hal_eepromDiag(_ah, _request, _a, _asize, _r, _rsize) \ 305 AH_PRIVATE(_ah)->ah_eepromDiag(_ah, _request, _a, _asize, _r, _rsize) 306 307#if !defined(_NET_IF_IEEE80211_H_) && !defined(_NET80211__IEEE80211_H_) 308/* 309 * Stuff that would naturally come from _ieee80211.h 310 */ 311#define IEEE80211_ADDR_LEN 6 312 313#define IEEE80211_WEP_KEYLEN 5 /* 40bit */ 314#define IEEE80211_WEP_IVLEN 3 /* 24bit */ 315#define IEEE80211_WEP_KIDLEN 1 /* 1 octet */ 316#define IEEE80211_WEP_CRCLEN 4 /* CRC-32 */ 317 318#define IEEE80211_CRC_LEN 4 319 320#define IEEE80211_MTU 1500 321#define IEEE80211_MAX_LEN (2300 + IEEE80211_CRC_LEN + \ 322 (IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN + IEEE80211_WEP_CRCLEN)) 323 324enum { 325 IEEE80211_T_DS, /* direct sequence spread spectrum */ 326 IEEE80211_T_FH, /* frequency hopping */ 327 IEEE80211_T_OFDM, /* frequency division multiplexing */ 328 IEEE80211_T_TURBO, /* high rate DS */ 329 IEEE80211_T_HT, /* HT - full GI */ 330}; 331#define IEEE80211_T_CCK IEEE80211_T_DS /* more common nomenclatur */ 332#endif /* _NET_IF_IEEE80211_H_ */ 333 334/* NB: these are defined privately until XR support is announced */ 335enum { 336 ATHEROS_T_XR = IEEE80211_T_HT+1, /* extended range */ 337}; 338 339#define HAL_TXQ_USE_LOCKOUT_BKOFF_DIS 0x00000001 340 341#define INIT_AIFS 2 342#define INIT_CWMIN 15 343#define INIT_CWMIN_11B 31 344#define INIT_CWMAX 1023 345#define INIT_SH_RETRY 10 346#define INIT_LG_RETRY 10 347#define INIT_SSH_RETRY 32 348#define INIT_SLG_RETRY 32 349 350typedef struct { 351 uint32_t tqi_ver; /* HAL TXQ verson */ 352 HAL_TX_QUEUE tqi_type; /* hw queue type*/ 353 HAL_TX_QUEUE_SUBTYPE tqi_subtype; /* queue subtype, if applicable */ 354 HAL_TX_QUEUE_FLAGS tqi_qflags; /* queue flags */ 355 uint32_t tqi_priority; 356 uint32_t tqi_aifs; /* aifs */ 357 uint32_t tqi_cwmin; /* cwMin */ 358 uint32_t tqi_cwmax; /* cwMax */ 359 uint16_t tqi_shretry; /* frame short retry limit */ 360 uint16_t tqi_lgretry; /* frame long retry limit */ 361 uint32_t tqi_cbrPeriod; 362 uint32_t tqi_cbrOverflowLimit; 363 uint32_t tqi_burstTime; 364 uint32_t tqi_readyTime; 365 uint32_t tqi_physCompBuf; 366 uint32_t tqi_intFlags; /* flags for internal use */ 367} HAL_TX_QUEUE_INFO; 368 369extern HAL_BOOL ath_hal_setTxQProps(struct ath_hal *ah, 370 HAL_TX_QUEUE_INFO *qi, const HAL_TXQ_INFO *qInfo); 371extern HAL_BOOL ath_hal_getTxQProps(struct ath_hal *ah, 372 HAL_TXQ_INFO *qInfo, const HAL_TX_QUEUE_INFO *qi); 373 374typedef enum { 375 HAL_ANI_PRESENT, /* is ANI support present */ 376 HAL_ANI_NOISE_IMMUNITY_LEVEL, /* set level */ 377 HAL_ANI_OFDM_WEAK_SIGNAL_DETECTION, /* enable/disable */ 378 HAL_ANI_CCK_WEAK_SIGNAL_THR, /* enable/disable */ 379 HAL_ANI_FIRSTEP_LEVEL, /* set level */ 380 HAL_ANI_SPUR_IMMUNITY_LEVEL, /* set level */ 381 HAL_ANI_MODE = 6, /* 0 => manual, 1 => auto (XXX do not change) */ 382 HAL_ANI_PHYERR_RESET, /* reset phy error stats */ 383} HAL_ANI_CMD; 384 385#define HAL_SPUR_VAL_MASK 0x3FFF 386#define HAL_SPUR_CHAN_WIDTH 87 387#define HAL_BIN_WIDTH_BASE_100HZ 3125 388#define HAL_BIN_WIDTH_TURBO_100HZ 6250 389#define HAL_MAX_BINS_ALLOWED 28 390 391/* 392 * A = 5GHZ|OFDM 393 * T = 5GHZ|OFDM|TURBO 394 * 395 * IS_CHAN_A(T) will return TRUE. This is probably 396 * not the default behavior we want. We should migrate to a better mask -- 397 * perhaps CHANNEL_ALL. 398 * 399 * For now, IS_CHAN_G() masks itself with CHANNEL_108G. 400 * 401 */ 402 403#define IS_CHAN_A(_c) (((_c)->channelFlags & CHANNEL_A) == CHANNEL_A) 404#define IS_CHAN_B(_c) (((_c)->channelFlags & CHANNEL_B) == CHANNEL_B) 405#define IS_CHAN_G(_c) (((_c)->channelFlags & (CHANNEL_108G|CHANNEL_G)) == CHANNEL_G) 406#define IS_CHAN_108G(_c)(((_c)->channelFlags & CHANNEL_108G) == CHANNEL_108G) 407#define IS_CHAN_T(_c) (((_c)->channelFlags & CHANNEL_T) == CHANNEL_T) 408#define IS_CHAN_PUREG(_c) \ 409 (((_c)->channelFlags & CHANNEL_PUREG) == CHANNEL_PUREG) 410 411#define IS_CHAN_TURBO(_c) (((_c)->channelFlags & CHANNEL_TURBO) != 0) 412#define IS_CHAN_CCK(_c) (((_c)->channelFlags & CHANNEL_CCK) != 0) 413#define IS_CHAN_OFDM(_c) (((_c)->channelFlags & CHANNEL_OFDM) != 0) 414#define IS_CHAN_5GHZ(_c) (((_c)->channelFlags & CHANNEL_5GHZ) != 0) 415#define IS_CHAN_2GHZ(_c) (((_c)->channelFlags & CHANNEL_2GHZ) != 0) 416#define IS_CHAN_PASSIVE(_c) (((_c)->channelFlags & CHANNEL_PASSIVE) != 0) 417#define IS_CHAN_HALF_RATE(_c) (((_c)->channelFlags & CHANNEL_HALF) != 0) 418#define IS_CHAN_QUARTER_RATE(_c) (((_c)->channelFlags & CHANNEL_QUARTER) != 0) 419 420#define IS_CHAN_IN_PUBLIC_SAFETY_BAND(_c) ((_c) > 4940 && (_c) < 4990) 421 422#define CHANNEL_HT40 (CHANNEL_HT40PLUS | CHANNEL_HT40MINUS) 423#define CHANNEL_HT (CHANNEL_HT20 | CHANNEL_HT40) 424#define IS_CHAN_HT(_c) (((_c)->channelFlags & CHANNEL_HT) != 0) 425#define IS_CHAN_HT20(_c) (((_c)->channelFlags & CHANNEL_HT) == CHANNEL_HT20) 426#define IS_CHAN_HT40(_c) (((_c)->channelFlags & CHANNEL_HT40) != 0) 427 428/* 429 * Deduce if the host cpu has big- or litt-endian byte order. 430 */ 431static __inline__ int 432isBigEndian(void) 433{ 434 union { 435 int32_t i; 436 char c[4]; 437 } u; 438 u.i = 1; 439 return (u.c[0] == 0); 440} 441 442/* unalligned little endian access */ 443#define LE_READ_2(p) \ 444 ((uint16_t) \ 445 ((((const uint8_t *)(p))[0] ) | (((const uint8_t *)(p))[1]<< 8))) 446#define LE_READ_4(p) \ 447 ((uint32_t) \ 448 ((((const uint8_t *)(p))[0] ) | (((const uint8_t *)(p))[1]<< 8) |\ 449 (((const uint8_t *)(p))[2]<<16) | (((const uint8_t *)(p))[3]<<24))) 450 451/* 452 * Register manipulation macros that expect bit field defines 453 * to follow the convention that an _S suffix is appended for 454 * a shift count, while the field mask has no suffix. 455 */ 456#define SM(_v, _f) (((_v) << _f##_S) & (_f)) 457#define MS(_v, _f) (((_v) & (_f)) >> _f##_S) 458#define OS_REG_RMW_FIELD(_a, _r, _f, _v) \ 459 OS_REG_WRITE(_a, _r, \ 460 (OS_REG_READ(_a, _r) &~ (_f)) | (((_v) << _f##_S) & (_f))) 461#define OS_REG_SET_BIT(_a, _r, _f) \ 462 OS_REG_WRITE(_a, _r, OS_REG_READ(_a, _r) | (_f)) 463#define OS_REG_CLR_BIT(_a, _r, _f) \ 464 OS_REG_WRITE(_a, _r, OS_REG_READ(_a, _r) &~ (_f)) 465 466/* 467 * Regulatory domain support. 468 */ 469 470/* 471 * Return the max allowed antenna gain based on the current 472 * regulatory domain. 473 */ 474extern u_int ath_hal_getantennareduction(struct ath_hal *, 475 HAL_CHANNEL *, u_int twiceGain); 476/* 477 * Return the test group for the specific channel based on 478 * the current regulator domain. 479 */ 480extern u_int ath_hal_getctl(struct ath_hal *, HAL_CHANNEL *); 481/* 482 * Return whether or not a noise floor check is required 483 * based on the current regulatory domain for the specified 484 * channel. 485 */ 486extern u_int ath_hal_getnfcheckrequired(struct ath_hal *, HAL_CHANNEL *); 487 488/* 489 * Map a public channel definition to the corresponding 490 * internal data structure. This implicitly specifies 491 * whether or not the specified channel is ok to use 492 * based on the current regulatory domain constraints. 493 */ 494extern HAL_CHANNEL_INTERNAL *ath_hal_checkchannel(struct ath_hal *, 495 const HAL_CHANNEL *); 496 497/* system-configurable parameters */ 498extern int ath_hal_dma_beacon_response_time; /* in TU's */ 499extern int ath_hal_sw_beacon_response_time; /* in TU's */ 500extern int ath_hal_additional_swba_backoff; /* in TU's */ 501 502/* wait for the register contents to have the specified value */ 503extern HAL_BOOL ath_hal_wait(struct ath_hal *, u_int reg, 504 uint32_t mask, uint32_t val); 505 506/* return the first n bits in val reversed */ 507extern uint32_t ath_hal_reverseBits(uint32_t val, uint32_t n); 508 509/* printf interfaces */ 510extern void ath_hal_printf(struct ath_hal *, const char*, ...) 511 __printflike(2,3); 512extern void ath_hal_vprintf(struct ath_hal *, const char*, __va_list) 513 __printflike(2, 0); 514extern const char* ath_hal_ether_sprintf(const uint8_t *mac); 515 516/* allocate and free memory */ 517extern void *ath_hal_malloc(size_t); 518extern void ath_hal_free(void *); 519 520/* common debugging interfaces */ 521#ifdef AH_DEBUG 522#include "ah_debug.h" 523extern int ath_hal_debug; 524extern void HALDEBUG(struct ath_hal *ah, u_int mask, const char* fmt, ...) 525 __printflike(3,4); 526#else 527#define HALDEBUG(_ah, __m, _fmt, ...) 528#endif /* AH_DEBUG */ 529 530/* 531 * Register logging definitions shared with ardecode. 532 */ 533#include "ah_decode.h" 534 535/* 536 * Common assertion interface. Note: it is a bad idea to generate 537 * an assertion failure for any recoverable event. Instead catch 538 * the violation and, if possible, fix it up or recover from it; either 539 * with an error return value or a diagnostic messages. System software 540 * does not panic unless the situation is hopeless. 541 */ 542#ifdef AH_ASSERT 543extern void ath_hal_assert_failed(const char* filename, 544 int lineno, const char* msg); 545 546#define HALASSERT(_x) do { \ 547 if (!(_x)) { \ 548 ath_hal_assert_failed(__FILE__, __LINE__, #_x); \ 549 } \ 550} while (0) 551#else 552#define HALASSERT(_x) 553#endif /* AH_ASSERT */ 554 555/* 556 * Convert between microseconds and core system clocks. 557 */ 558extern u_int ath_hal_mac_clks(struct ath_hal *ah, u_int usecs); 559extern u_int ath_hal_mac_usec(struct ath_hal *ah, u_int clks); 560 561/* 562 * Generic get/set capability support. Each chip overrides 563 * this routine to support chip-specific capabilities. 564 */ 565extern HAL_STATUS ath_hal_getcapability(struct ath_hal *ah, 566 HAL_CAPABILITY_TYPE type, uint32_t capability, 567 uint32_t *result); 568extern HAL_BOOL ath_hal_setcapability(struct ath_hal *ah, 569 HAL_CAPABILITY_TYPE type, uint32_t capability, 570 uint32_t setting, HAL_STATUS *status); 571 572/* 573 * Diagnostic interface. This is an open-ended interface that 574 * is opaque to applications. Diagnostic programs use this to 575 * retrieve internal data structures, etc. There is no guarantee 576 * that calling conventions for calls other than HAL_DIAG_REVS 577 * are stable between HAL releases; a diagnostic application must 578 * use the HAL revision information to deal with ABI/API differences. 579 * 580 * NB: do not renumber these, certain codes are publicly used. 581 */ 582enum { 583 HAL_DIAG_REVS = 0, /* MAC/PHY/Radio revs */ 584 HAL_DIAG_EEPROM = 1, /* EEPROM contents */ 585 HAL_DIAG_EEPROM_EXP_11A = 2, /* EEPROM 5112 power exp for 11a */ 586 HAL_DIAG_EEPROM_EXP_11B = 3, /* EEPROM 5112 power exp for 11b */ 587 HAL_DIAG_EEPROM_EXP_11G = 4, /* EEPROM 5112 power exp for 11g */ 588 HAL_DIAG_ANI_CURRENT = 5, /* ANI current channel state */ 589 HAL_DIAG_ANI_OFDM = 6, /* ANI OFDM timing error stats */ 590 HAL_DIAG_ANI_CCK = 7, /* ANI CCK timing error stats */ 591 HAL_DIAG_ANI_STATS = 8, /* ANI statistics */ 592 HAL_DIAG_RFGAIN = 9, /* RfGain GAIN_VALUES */ 593 HAL_DIAG_RFGAIN_CURSTEP = 10, /* RfGain GAIN_OPTIMIZATION_STEP */ 594 HAL_DIAG_PCDAC = 11, /* PCDAC table */ 595 HAL_DIAG_TXRATES = 12, /* Transmit rate table */ 596 HAL_DIAG_REGS = 13, /* Registers */ 597 HAL_DIAG_ANI_CMD = 14, /* ANI issue command (XXX do not change!) */ 598 HAL_DIAG_SETKEY = 15, /* Set keycache backdoor */ 599 HAL_DIAG_RESETKEY = 16, /* Reset keycache backdoor */ 600 HAL_DIAG_EEREAD = 17, /* Read EEPROM word */ 601 HAL_DIAG_EEWRITE = 18, /* Write EEPROM word */ 602 /* 19 was HAL_DIAG_TXCONT, 20-23 were for radar */ 603 HAL_DIAG_REGREAD = 24, /* Reg reads */ 604 HAL_DIAG_REGWRITE = 25, /* Reg writes */ 605 HAL_DIAG_GET_REGBASE = 26, /* Get register base */ 606 HAL_DIAG_RDWRITE = 27, /* Write regulatory domain */ 607 HAL_DIAG_RDREAD = 28, /* Get regulatory domain */ 608 HAL_DIAG_FATALERR = 29, /* Read cached interrupt state */ 609 HAL_DIAG_11NCOMPAT = 30, /* 11n compatibility tweaks */ 610 HAL_DIAG_ANI_PARAMS = 31, /* ANI noise immunity parameters */ 611 HAL_DIAG_CHECK_HANGS = 32, /* check h/w hangs */ 612}; 613 614enum { 615 HAL_BB_HANG_DFS = 0x0001, 616 HAL_BB_HANG_RIFS = 0x0002, 617 HAL_BB_HANG_RX_CLEAR = 0x0004, 618 HAL_BB_HANG_UNKNOWN = 0x0080, 619 620 HAL_MAC_HANG_SIG1 = 0x0100, 621 HAL_MAC_HANG_SIG2 = 0x0200, 622 HAL_MAC_HANG_UNKNOWN = 0x8000, 623 624 HAL_BB_HANGS = HAL_BB_HANG_DFS 625 | HAL_BB_HANG_RIFS 626 | HAL_BB_HANG_RX_CLEAR 627 | HAL_BB_HANG_UNKNOWN, 628 HAL_MAC_HANGS = HAL_MAC_HANG_SIG1 629 | HAL_MAC_HANG_SIG2 630 | HAL_MAC_HANG_UNKNOWN, 631}; 632 633/* 634 * Device revision information. 635 */ 636typedef struct { 637 uint16_t ah_devid; /* PCI device ID */ 638 uint16_t ah_subvendorid; /* PCI subvendor ID */ 639 uint32_t ah_macVersion; /* MAC version id */ 640 uint16_t ah_macRev; /* MAC revision */ 641 uint16_t ah_phyRev; /* PHY revision */ 642 uint16_t ah_analog5GhzRev; /* 2GHz radio revision */ 643 uint16_t ah_analog2GhzRev; /* 5GHz radio revision */ 644} HAL_REVS; 645 646/* 647 * Argument payload for HAL_DIAG_SETKEY. 648 */ 649typedef struct { 650 HAL_KEYVAL dk_keyval; 651 uint16_t dk_keyix; /* key index */ 652 uint8_t dk_mac[IEEE80211_ADDR_LEN]; 653 int dk_xor; /* XOR key data */ 654} HAL_DIAG_KEYVAL; 655 656/* 657 * Argument payload for HAL_DIAG_EEWRITE. 658 */ 659typedef struct { 660 uint16_t ee_off; /* eeprom offset */ 661 uint16_t ee_data; /* write data */ 662} HAL_DIAG_EEVAL; 663 664 665typedef struct { 666 u_int offset; /* reg offset */ 667 uint32_t val; /* reg value */ 668} HAL_DIAG_REGVAL; 669 670/* 671 * 11n compatibility tweaks. 672 */ 673#define HAL_DIAG_11N_SERVICES 0x00000003 674#define HAL_DIAG_11N_SERVICES_S 0 675#define HAL_DIAG_11N_TXSTOMP 0x0000000c 676#define HAL_DIAG_11N_TXSTOMP_S 2 677 678typedef struct { 679 int maxNoiseImmunityLevel; /* [0..4] */ 680 int totalSizeDesired[5]; 681 int coarseHigh[5]; 682 int coarseLow[5]; 683 int firpwr[5]; 684 685 int maxSpurImmunityLevel; /* [0..7] */ 686 int cycPwrThr1[8]; 687 688 int maxFirstepLevel; /* [0..2] */ 689 int firstep[3]; 690 691 uint32_t ofdmTrigHigh; 692 uint32_t ofdmTrigLow; 693 int32_t cckTrigHigh; 694 int32_t cckTrigLow; 695 int32_t rssiThrLow; 696 int32_t rssiThrHigh; 697 698 int period; /* update listen period */ 699} HAL_ANI_PARAMS; 700 701extern HAL_BOOL ath_hal_getdiagstate(struct ath_hal *ah, int request, 702 const void *args, uint32_t argsize, 703 void **result, uint32_t *resultsize); 704 705/* 706 * Setup a h/w rate table for use. 707 */ 708extern void ath_hal_setupratetable(struct ath_hal *ah, HAL_RATE_TABLE *rt); 709 710/* 711 * Common routine for implementing getChanNoise api. 712 */ 713extern int16_t ath_hal_getChanNoise(struct ath_hal *ah, HAL_CHANNEL *chan); 714 715/* 716 * Initialization support. 717 */ 718typedef struct { 719 const uint32_t *data; 720 int rows, cols; 721} HAL_INI_ARRAY; 722 723#define HAL_INI_INIT(_ia, _data, _cols) do { \ 724 (_ia)->data = (const uint32_t *)(_data); \ 725 (_ia)->rows = sizeof(_data) / sizeof((_data)[0]); \ 726 (_ia)->cols = (_cols); \ 727} while (0) 728#define HAL_INI_VAL(_ia, _r, _c) \ 729 ((_ia)->data[((_r)*(_ia)->cols) + (_c)]) 730 731/* 732 * OS_DELAY() does a PIO READ on the PCI bus which allows 733 * other cards' DMA reads to complete in the middle of our reset. 734 */ 735#define DMA_YIELD(x) do { \ 736 if ((++(x) % 64) == 0) \ 737 OS_DELAY(1); \ 738} while (0) 739 740#define HAL_INI_WRITE_ARRAY(ah, regArray, col, regWr) do { \ 741 int r; \ 742 for (r = 0; r < N(regArray); r++) { \ 743 OS_REG_WRITE(ah, (regArray)[r][0], (regArray)[r][col]); \ 744 DMA_YIELD(regWr); \ 745 } \ 746} while (0) 747 748#define HAL_INI_WRITE_BANK(ah, regArray, bankData, regWr) do { \ 749 int r; \ 750 for (r = 0; r < N(regArray); r++) { \ 751 OS_REG_WRITE(ah, (regArray)[r][0], (bankData)[r]); \ 752 DMA_YIELD(regWr); \ 753 } \ 754} while (0) 755 756extern int ath_hal_ini_write(struct ath_hal *ah, const HAL_INI_ARRAY *ia, 757 int col, int regWr); 758extern void ath_hal_ini_bank_setup(uint32_t data[], const HAL_INI_ARRAY *ia, 759 int col); 760extern int ath_hal_ini_bank_write(struct ath_hal *ah, const HAL_INI_ARRAY *ia, 761 const uint32_t data[], int regWr); 762 763#define WLAN_CTRL_FRAME_SIZE (2+2+6+4) /* ACK+FCS */ 764#endif /* _ATH_AH_INTERAL_H_ */ 765