ah_internal.h revision 218150
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_internal.h 218150 2011-02-01 03:51:35Z adrian $ 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#include <net80211/_ieee80211.h> 31 32#ifndef NBBY 33#define NBBY 8 /* number of bits/byte */ 34#endif 35 36#ifndef roundup 37#define roundup(x, y) ((((x)+((y)-1))/(y))*(y)) /* to any y */ 38#endif 39#ifndef howmany 40#define howmany(x, y) (((x)+((y)-1))/(y)) 41#endif 42 43#ifndef offsetof 44#define offsetof(type, field) ((size_t)(&((type *)0)->field)) 45#endif 46 47typedef struct { 48 uint16_t start; /* first register */ 49 uint16_t end; /* ending register or zero */ 50} HAL_REGRANGE; 51 52typedef struct { 53 uint32_t addr; /* regiser address/offset */ 54 uint32_t value; /* value to write */ 55} HAL_REGWRITE; 56 57/* 58 * Transmit power scale factor. 59 * 60 * NB: This is not public because we want to discourage the use of 61 * scaling; folks should use the tx power limit interface. 62 */ 63typedef enum { 64 HAL_TP_SCALE_MAX = 0, /* no scaling (default) */ 65 HAL_TP_SCALE_50 = 1, /* 50% of max (-3 dBm) */ 66 HAL_TP_SCALE_25 = 2, /* 25% of max (-6 dBm) */ 67 HAL_TP_SCALE_12 = 3, /* 12% of max (-9 dBm) */ 68 HAL_TP_SCALE_MIN = 4, /* min, but still on */ 69} HAL_TP_SCALE; 70 71typedef enum { 72 HAL_CAP_RADAR = 0, /* Radar capability */ 73 HAL_CAP_AR = 1, /* AR capability */ 74} HAL_PHYDIAG_CAPS; 75 76/* 77 * Each chip or class of chips registers to offer support. 78 */ 79struct ath_hal_chip { 80 const char *name; 81 const char *(*probe)(uint16_t vendorid, uint16_t devid); 82 struct ath_hal *(*attach)(uint16_t devid, HAL_SOFTC, 83 HAL_BUS_TAG, HAL_BUS_HANDLE, uint16_t *eepromdata, 84 HAL_STATUS *error); 85}; 86#ifndef AH_CHIP 87#define AH_CHIP(_name, _probe, _attach) \ 88static struct ath_hal_chip _name##_chip = { \ 89 .name = #_name, \ 90 .probe = _probe, \ 91 .attach = _attach \ 92}; \ 93OS_DATA_SET(ah_chips, _name##_chip) 94#endif 95 96/* 97 * Each RF backend registers to offer support; this is mostly 98 * used by multi-chip 5212 solutions. Single-chip solutions 99 * have a fixed idea about which RF to use. 100 */ 101struct ath_hal_rf { 102 const char *name; 103 HAL_BOOL (*probe)(struct ath_hal *ah); 104 HAL_BOOL (*attach)(struct ath_hal *ah, HAL_STATUS *ecode); 105}; 106#ifndef AH_RF 107#define AH_RF(_name, _probe, _attach) \ 108static struct ath_hal_rf _name##_rf = { \ 109 .name = __STRING(_name), \ 110 .probe = _probe, \ 111 .attach = _attach \ 112}; \ 113OS_DATA_SET(ah_rfs, _name##_rf) 114#endif 115 116struct ath_hal_rf *ath_hal_rfprobe(struct ath_hal *ah, HAL_STATUS *ecode); 117 118/* 119 * Maximum number of internal channels. Entries are per unique 120 * frequency so this might be need to be increased to handle all 121 * usage cases; typically no more than 32 are really needed but 122 * dynamically allocating the data structures is a bit painful 123 * right now. 124 */ 125#ifndef AH_MAXCHAN 126#define AH_MAXCHAN 96 127#endif 128 129/* 130 * Internal per-channel state. These are found 131 * using ic_devdata in the ieee80211_channel. 132 */ 133typedef struct { 134 uint16_t channel; /* h/w frequency, NB: may be mapped */ 135 uint8_t privFlags; 136#define CHANNEL_IQVALID 0x01 /* IQ calibration valid */ 137#define CHANNEL_ANI_INIT 0x02 /* ANI state initialized */ 138#define CHANNEL_ANI_SETUP 0x04 /* ANI state setup */ 139 uint8_t calValid; /* bitmask of cal types */ 140 int8_t iCoff; 141 int8_t qCoff; 142 int16_t rawNoiseFloor; 143 int16_t noiseFloorAdjust; 144 uint16_t mainSpur; /* cached spur value for this channel */ 145} HAL_CHANNEL_INTERNAL; 146 147/* channel requires noise floor check */ 148#define CHANNEL_NFCREQUIRED IEEE80211_CHAN_PRIV0 149 150/* all full-width channels */ 151#define IEEE80211_CHAN_ALLFULL \ 152 (IEEE80211_CHAN_ALL - (IEEE80211_CHAN_HALF | IEEE80211_CHAN_QUARTER)) 153#define IEEE80211_CHAN_ALLTURBOFULL \ 154 (IEEE80211_CHAN_ALLTURBO - \ 155 (IEEE80211_CHAN_HALF | IEEE80211_CHAN_QUARTER)) 156 157typedef struct { 158 uint32_t halChanSpreadSupport : 1, 159 halSleepAfterBeaconBroken : 1, 160 halCompressSupport : 1, 161 halBurstSupport : 1, 162 halFastFramesSupport : 1, 163 halChapTuningSupport : 1, 164 halTurboGSupport : 1, 165 halTurboPrimeSupport : 1, 166 halMicAesCcmSupport : 1, 167 halMicCkipSupport : 1, 168 halMicTkipSupport : 1, 169 halTkipMicTxRxKeySupport : 1, 170 halCipherAesCcmSupport : 1, 171 halCipherCkipSupport : 1, 172 halCipherTkipSupport : 1, 173 halPSPollBroken : 1, 174 halVEOLSupport : 1, 175 halBssIdMaskSupport : 1, 176 halMcastKeySrchSupport : 1, 177 halTsfAddSupport : 1, 178 halChanHalfRate : 1, 179 halChanQuarterRate : 1, 180 halHTSupport : 1, 181 halRfSilentSupport : 1, 182 halHwPhyCounterSupport : 1, 183 halWowSupport : 1, 184 halWowMatchPatternExact : 1, 185 halAutoSleepSupport : 1, 186 halFastCCSupport : 1, 187 halBtCoexSupport : 1; 188 uint32_t halRxStbcSupport : 1, 189 halTxStbcSupport : 1, 190 halGTTSupport : 1, 191 halCSTSupport : 1, 192 halRifsRxSupport : 1, 193 halRifsTxSupport : 1, 194 halExtChanDfsSupport : 1, 195 halForcePpmSupport : 1, 196 halEnhancedPmSupport : 1, 197 halMbssidAggrSupport : 1, 198 halBssidMatchSupport : 1; 199 uint32_t halWirelessModes; 200 uint16_t halTotalQueues; 201 uint16_t halKeyCacheSize; 202 uint16_t halLow5GhzChan, halHigh5GhzChan; 203 uint16_t halLow2GhzChan, halHigh2GhzChan; 204 int halTstampPrecision; 205 int halRtsAggrLimit; 206 uint8_t halTxChainMask; 207 uint8_t halRxChainMask; 208 uint8_t halNumGpioPins; 209 uint8_t halNumAntCfg2GHz; 210 uint8_t halNumAntCfg5GHz; 211 uint32_t halIntrMask; 212 uint8_t halTxStreams; 213 uint8_t halRxStreams; 214} HAL_CAPABILITIES; 215 216struct regDomain; 217 218/* 219 * The ``private area'' follows immediately after the ``public area'' 220 * in the data structure returned by ath_hal_attach. Private data are 221 * used by device-independent code such as the regulatory domain support. 222 * In general, code within the HAL should never depend on data in the 223 * public area. Instead any public data needed internally should be 224 * shadowed here. 225 * 226 * When declaring a device-specific ath_hal data structure this structure 227 * is assumed to at the front; e.g. 228 * 229 * struct ath_hal_5212 { 230 * struct ath_hal_private ah_priv; 231 * ... 232 * }; 233 * 234 * It might be better to manage the method pointers in this structure 235 * using an indirect pointer to a read-only data structure but this would 236 * disallow class-style method overriding. 237 */ 238struct ath_hal_private { 239 struct ath_hal h; /* public area */ 240 241 /* NB: all methods go first to simplify initialization */ 242 HAL_BOOL (*ah_getChannelEdges)(struct ath_hal*, 243 uint16_t channelFlags, 244 uint16_t *lowChannel, uint16_t *highChannel); 245 u_int (*ah_getWirelessModes)(struct ath_hal*); 246 HAL_BOOL (*ah_eepromRead)(struct ath_hal *, u_int off, 247 uint16_t *data); 248 HAL_BOOL (*ah_eepromWrite)(struct ath_hal *, u_int off, 249 uint16_t data); 250 HAL_BOOL (*ah_getChipPowerLimits)(struct ath_hal *, 251 struct ieee80211_channel *); 252 int16_t (*ah_getNfAdjust)(struct ath_hal *, 253 const HAL_CHANNEL_INTERNAL*); 254 void (*ah_getNoiseFloor)(struct ath_hal *, 255 int16_t nfarray[]); 256 257 void *ah_eeprom; /* opaque EEPROM state */ 258 uint16_t ah_eeversion; /* EEPROM version */ 259 void (*ah_eepromDetach)(struct ath_hal *); 260 HAL_STATUS (*ah_eepromGet)(struct ath_hal *, int, void *); 261 HAL_BOOL (*ah_eepromSet)(struct ath_hal *, int, int); 262 uint16_t (*ah_getSpurChan)(struct ath_hal *, int, HAL_BOOL); 263 HAL_BOOL (*ah_eepromDiag)(struct ath_hal *, int request, 264 const void *args, uint32_t argsize, 265 void **result, uint32_t *resultsize); 266 267 /* 268 * Device revision information. 269 */ 270 uint16_t ah_devid; /* PCI device ID */ 271 uint16_t ah_subvendorid; /* PCI subvendor ID */ 272 uint32_t ah_macVersion; /* MAC version id */ 273 uint16_t ah_macRev; /* MAC revision */ 274 uint16_t ah_phyRev; /* PHY revision */ 275 uint16_t ah_analog5GhzRev; /* 2GHz radio revision */ 276 uint16_t ah_analog2GhzRev; /* 5GHz radio revision */ 277 uint8_t ah_ispcie; /* PCIE, special treatment */ 278 279 HAL_OPMODE ah_opmode; /* operating mode from reset */ 280 const struct ieee80211_channel *ah_curchan;/* operating channel */ 281 HAL_CAPABILITIES ah_caps; /* device capabilities */ 282 uint32_t ah_diagreg; /* user-specified AR_DIAG_SW */ 283 int16_t ah_powerLimit; /* tx power cap */ 284 uint16_t ah_maxPowerLevel; /* calculated max tx power */ 285 u_int ah_tpScale; /* tx power scale factor */ 286 uint32_t ah_11nCompat; /* 11n compat controls */ 287 288 /* 289 * State for regulatory domain handling. 290 */ 291 HAL_REG_DOMAIN ah_currentRD; /* EEPROM regulatory domain */ 292 HAL_CHANNEL_INTERNAL ah_channels[AH_MAXCHAN]; /* private chan state */ 293 u_int ah_nchan; /* valid items in ah_channels */ 294 const struct regDomain *ah_rd2GHz; /* reg state for 2G band */ 295 const struct regDomain *ah_rd5GHz; /* reg state for 5G band */ 296 297 uint8_t ah_coverageClass; /* coverage class */ 298 /* 299 * RF Silent handling; setup according to the EEPROM. 300 */ 301 uint16_t ah_rfsilent; /* GPIO pin + polarity */ 302 HAL_BOOL ah_rfkillEnabled; /* enable/disable RfKill */ 303 /* 304 * Diagnostic support for discriminating HIUERR reports. 305 */ 306 uint32_t ah_fatalState[6]; /* AR_ISR+shadow regs */ 307 int ah_rxornIsFatal; /* how to treat HAL_INT_RXORN */ 308}; 309 310#define AH_PRIVATE(_ah) ((struct ath_hal_private *)(_ah)) 311 312#define ath_hal_getChannelEdges(_ah, _cf, _lc, _hc) \ 313 AH_PRIVATE(_ah)->ah_getChannelEdges(_ah, _cf, _lc, _hc) 314#define ath_hal_getWirelessModes(_ah) \ 315 AH_PRIVATE(_ah)->ah_getWirelessModes(_ah) 316#define ath_hal_eepromRead(_ah, _off, _data) \ 317 AH_PRIVATE(_ah)->ah_eepromRead(_ah, _off, _data) 318#define ath_hal_eepromWrite(_ah, _off, _data) \ 319 AH_PRIVATE(_ah)->ah_eepromWrite(_ah, _off, _data) 320#define ath_hal_gpioCfgOutput(_ah, _gpio, _type) \ 321 (_ah)->ah_gpioCfgOutput(_ah, _gpio, _type) 322#define ath_hal_gpioCfgInput(_ah, _gpio) \ 323 (_ah)->ah_gpioCfgInput(_ah, _gpio) 324#define ath_hal_gpioGet(_ah, _gpio) \ 325 (_ah)->ah_gpioGet(_ah, _gpio) 326#define ath_hal_gpioSet(_ah, _gpio, _val) \ 327 (_ah)->ah_gpioSet(_ah, _gpio, _val) 328#define ath_hal_gpioSetIntr(_ah, _gpio, _ilevel) \ 329 (_ah)->ah_gpioSetIntr(_ah, _gpio, _ilevel) 330#define ath_hal_getpowerlimits(_ah, _chan) \ 331 AH_PRIVATE(_ah)->ah_getChipPowerLimits(_ah, _chan) 332#define ath_hal_getNfAdjust(_ah, _c) \ 333 AH_PRIVATE(_ah)->ah_getNfAdjust(_ah, _c) 334#define ath_hal_getNoiseFloor(_ah, _nfArray) \ 335 AH_PRIVATE(_ah)->ah_getNoiseFloor(_ah, _nfArray) 336#define ath_hal_configPCIE(_ah, _reset) \ 337 (_ah)->ah_configPCIE(_ah, _reset) 338#define ath_hal_disablePCIE(_ah) \ 339 (_ah)->ah_disablePCIE(_ah) 340#define ath_hal_setInterrupts(_ah, _mask) \ 341 (_ah)->ah_setInterrupts(_ah, _mask) 342 343#define ath_hal_eepromDetach(_ah) do { \ 344 if (AH_PRIVATE(_ah)->ah_eepromDetach != AH_NULL) \ 345 AH_PRIVATE(_ah)->ah_eepromDetach(_ah); \ 346} while (0) 347#define ath_hal_eepromGet(_ah, _param, _val) \ 348 AH_PRIVATE(_ah)->ah_eepromGet(_ah, _param, _val) 349#define ath_hal_eepromSet(_ah, _param, _val) \ 350 AH_PRIVATE(_ah)->ah_eepromSet(_ah, _param, _val) 351#define ath_hal_eepromGetFlag(_ah, _param) \ 352 (AH_PRIVATE(_ah)->ah_eepromGet(_ah, _param, AH_NULL) == HAL_OK) 353#define ath_hal_getSpurChan(_ah, _ix, _is2G) \ 354 AH_PRIVATE(_ah)->ah_getSpurChan(_ah, _ix, _is2G) 355#define ath_hal_eepromDiag(_ah, _request, _a, _asize, _r, _rsize) \ 356 AH_PRIVATE(_ah)->ah_eepromDiag(_ah, _request, _a, _asize, _r, _rsize) 357 358#ifndef _NET_IF_IEEE80211_H_ 359/* 360 * Stuff that would naturally come from _ieee80211.h 361 */ 362#define IEEE80211_ADDR_LEN 6 363 364#define IEEE80211_WEP_IVLEN 3 /* 24bit */ 365#define IEEE80211_WEP_KIDLEN 1 /* 1 octet */ 366#define IEEE80211_WEP_CRCLEN 4 /* CRC-32 */ 367 368#define IEEE80211_CRC_LEN 4 369 370#define IEEE80211_MAX_LEN (2300 + IEEE80211_CRC_LEN + \ 371 (IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN + IEEE80211_WEP_CRCLEN)) 372#endif /* _NET_IF_IEEE80211_H_ */ 373 374#define HAL_TXQ_USE_LOCKOUT_BKOFF_DIS 0x00000001 375 376#define INIT_AIFS 2 377#define INIT_CWMIN 15 378#define INIT_CWMIN_11B 31 379#define INIT_CWMAX 1023 380#define INIT_SH_RETRY 10 381#define INIT_LG_RETRY 10 382#define INIT_SSH_RETRY 32 383#define INIT_SLG_RETRY 32 384 385typedef struct { 386 uint32_t tqi_ver; /* HAL TXQ verson */ 387 HAL_TX_QUEUE tqi_type; /* hw queue type*/ 388 HAL_TX_QUEUE_SUBTYPE tqi_subtype; /* queue subtype, if applicable */ 389 HAL_TX_QUEUE_FLAGS tqi_qflags; /* queue flags */ 390 uint32_t tqi_priority; 391 uint32_t tqi_aifs; /* aifs */ 392 uint32_t tqi_cwmin; /* cwMin */ 393 uint32_t tqi_cwmax; /* cwMax */ 394 uint16_t tqi_shretry; /* frame short retry limit */ 395 uint16_t tqi_lgretry; /* frame long retry limit */ 396 uint32_t tqi_cbrPeriod; 397 uint32_t tqi_cbrOverflowLimit; 398 uint32_t tqi_burstTime; 399 uint32_t tqi_readyTime; 400 uint32_t tqi_physCompBuf; 401 uint32_t tqi_intFlags; /* flags for internal use */ 402} HAL_TX_QUEUE_INFO; 403 404extern HAL_BOOL ath_hal_setTxQProps(struct ath_hal *ah, 405 HAL_TX_QUEUE_INFO *qi, const HAL_TXQ_INFO *qInfo); 406extern HAL_BOOL ath_hal_getTxQProps(struct ath_hal *ah, 407 HAL_TXQ_INFO *qInfo, const HAL_TX_QUEUE_INFO *qi); 408 409typedef enum { 410 HAL_ANI_PRESENT, /* is ANI support present */ 411 HAL_ANI_NOISE_IMMUNITY_LEVEL, /* set level */ 412 HAL_ANI_OFDM_WEAK_SIGNAL_DETECTION, /* enable/disable */ 413 HAL_ANI_CCK_WEAK_SIGNAL_THR, /* enable/disable */ 414 HAL_ANI_FIRSTEP_LEVEL, /* set level */ 415 HAL_ANI_SPUR_IMMUNITY_LEVEL, /* set level */ 416 HAL_ANI_MODE = 6, /* 0 => manual, 1 => auto (XXX do not change) */ 417 HAL_ANI_PHYERR_RESET, /* reset phy error stats */ 418} HAL_ANI_CMD; 419 420#define HAL_SPUR_VAL_MASK 0x3FFF 421#define HAL_SPUR_CHAN_WIDTH 87 422#define HAL_BIN_WIDTH_BASE_100HZ 3125 423#define HAL_BIN_WIDTH_TURBO_100HZ 6250 424#define HAL_MAX_BINS_ALLOWED 28 425 426#define IS_CHAN_5GHZ(_c) ((_c)->channel > 4900) 427#define IS_CHAN_2GHZ(_c) (!IS_CHAN_5GHZ(_c)) 428 429#define IS_CHAN_IN_PUBLIC_SAFETY_BAND(_c) ((_c) > 4940 && (_c) < 4990) 430 431/* 432 * Deduce if the host cpu has big- or litt-endian byte order. 433 */ 434static __inline__ int 435isBigEndian(void) 436{ 437 union { 438 int32_t i; 439 char c[4]; 440 } u; 441 u.i = 1; 442 return (u.c[0] == 0); 443} 444 445/* unalligned little endian access */ 446#define LE_READ_2(p) \ 447 ((uint16_t) \ 448 ((((const uint8_t *)(p))[0] ) | (((const uint8_t *)(p))[1]<< 8))) 449#define LE_READ_4(p) \ 450 ((uint32_t) \ 451 ((((const uint8_t *)(p))[0] ) | (((const uint8_t *)(p))[1]<< 8) |\ 452 (((const uint8_t *)(p))[2]<<16) | (((const uint8_t *)(p))[3]<<24))) 453 454/* 455 * Register manipulation macros that expect bit field defines 456 * to follow the convention that an _S suffix is appended for 457 * a shift count, while the field mask has no suffix. 458 */ 459#define SM(_v, _f) (((_v) << _f##_S) & (_f)) 460#define MS(_v, _f) (((_v) & (_f)) >> _f##_S) 461#define OS_REG_RMW_FIELD(_a, _r, _f, _v) \ 462 OS_REG_WRITE(_a, _r, \ 463 (OS_REG_READ(_a, _r) &~ (_f)) | (((_v) << _f##_S) & (_f))) 464#define OS_REG_SET_BIT(_a, _r, _f) \ 465 OS_REG_WRITE(_a, _r, OS_REG_READ(_a, _r) | (_f)) 466#define OS_REG_CLR_BIT(_a, _r, _f) \ 467 OS_REG_WRITE(_a, _r, OS_REG_READ(_a, _r) &~ (_f)) 468 469/* system-configurable parameters */ 470extern int ath_hal_dma_beacon_response_time; /* in TU's */ 471extern int ath_hal_sw_beacon_response_time; /* in TU's */ 472extern int ath_hal_additional_swba_backoff; /* in TU's */ 473 474/* wait for the register contents to have the specified value */ 475extern HAL_BOOL ath_hal_wait(struct ath_hal *, u_int reg, 476 uint32_t mask, uint32_t val); 477extern HAL_BOOL ath_hal_waitfor(struct ath_hal *, u_int reg, 478 uint32_t mask, uint32_t val, uint32_t timeout); 479 480/* return the first n bits in val reversed */ 481extern uint32_t ath_hal_reverseBits(uint32_t val, uint32_t n); 482 483/* printf interfaces */ 484extern void ath_hal_printf(struct ath_hal *, const char*, ...) 485 __printflike(2,3); 486extern void ath_hal_vprintf(struct ath_hal *, const char*, __va_list) 487 __printflike(2, 0); 488extern const char* ath_hal_ether_sprintf(const uint8_t *mac); 489 490/* allocate and free memory */ 491extern void *ath_hal_malloc(size_t); 492extern void ath_hal_free(void *); 493 494/* common debugging interfaces */ 495#ifdef AH_DEBUG 496#include "ah_debug.h" 497extern int ath_hal_debug; 498extern void HALDEBUG(struct ath_hal *ah, u_int mask, const char* fmt, ...) 499 __printflike(3,4); 500#else 501#define HALDEBUG(_ah, __m, _fmt, ...) 502#endif /* AH_DEBUG */ 503 504/* 505 * Register logging definitions shared with ardecode. 506 */ 507#include "ah_decode.h" 508 509/* 510 * Common assertion interface. Note: it is a bad idea to generate 511 * an assertion failure for any recoverable event. Instead catch 512 * the violation and, if possible, fix it up or recover from it; either 513 * with an error return value or a diagnostic messages. System software 514 * does not panic unless the situation is hopeless. 515 */ 516#ifdef AH_ASSERT 517extern void ath_hal_assert_failed(const char* filename, 518 int lineno, const char* msg); 519 520#define HALASSERT(_x) do { \ 521 if (!(_x)) { \ 522 ath_hal_assert_failed(__FILE__, __LINE__, #_x); \ 523 } \ 524} while (0) 525#else 526#define HALASSERT(_x) 527#endif /* AH_ASSERT */ 528 529/* 530 * Regulatory domain support. 531 */ 532 533/* 534 * Return the max allowed antenna gain and apply any regulatory 535 * domain specific changes. 536 */ 537u_int ath_hal_getantennareduction(struct ath_hal *ah, 538 const struct ieee80211_channel *chan, u_int twiceGain); 539 540/* 541 * Return the test group for the specific channel based on 542 * the current regulatory setup. 543 */ 544u_int ath_hal_getctl(struct ath_hal *, const struct ieee80211_channel *); 545 546/* 547 * Map a public channel definition to the corresponding 548 * internal data structure. This implicitly specifies 549 * whether or not the specified channel is ok to use 550 * based on the current regulatory domain constraints. 551 */ 552#ifndef AH_DEBUG 553static OS_INLINE HAL_CHANNEL_INTERNAL * 554ath_hal_checkchannel(struct ath_hal *ah, const struct ieee80211_channel *c) 555{ 556 HAL_CHANNEL_INTERNAL *cc; 557 558 HALASSERT(c->ic_devdata < AH_PRIVATE(ah)->ah_nchan); 559 cc = &AH_PRIVATE(ah)->ah_channels[c->ic_devdata]; 560 HALASSERT(c->ic_freq == cc->channel || IEEE80211_IS_CHAN_GSM(c)); 561 return cc; 562} 563#else 564/* NB: non-inline version that checks state */ 565HAL_CHANNEL_INTERNAL *ath_hal_checkchannel(struct ath_hal *, 566 const struct ieee80211_channel *); 567#endif /* AH_DEBUG */ 568 569/* 570 * Return the h/w frequency for a channel. This may be 571 * different from ic_freq if this is a GSM device that 572 * takes 2.4GHz frequencies and down-converts them. 573 */ 574static OS_INLINE uint16_t 575ath_hal_gethwchannel(struct ath_hal *ah, const struct ieee80211_channel *c) 576{ 577 return ath_hal_checkchannel(ah, c)->channel; 578} 579 580/* 581 * Convert between microseconds and core system clocks. 582 */ 583extern u_int ath_hal_mac_clks(struct ath_hal *ah, u_int usecs); 584extern u_int ath_hal_mac_usec(struct ath_hal *ah, u_int clks); 585 586/* 587 * Generic get/set capability support. Each chip overrides 588 * this routine to support chip-specific capabilities. 589 */ 590extern HAL_STATUS ath_hal_getcapability(struct ath_hal *ah, 591 HAL_CAPABILITY_TYPE type, uint32_t capability, 592 uint32_t *result); 593extern HAL_BOOL ath_hal_setcapability(struct ath_hal *ah, 594 HAL_CAPABILITY_TYPE type, uint32_t capability, 595 uint32_t setting, HAL_STATUS *status); 596 597/* The diagnostic codes used to be internally defined here -adrian */ 598#include "ah_diagcodes.h" 599 600enum { 601 HAL_BB_HANG_DFS = 0x0001, 602 HAL_BB_HANG_RIFS = 0x0002, 603 HAL_BB_HANG_RX_CLEAR = 0x0004, 604 HAL_BB_HANG_UNKNOWN = 0x0080, 605 606 HAL_MAC_HANG_SIG1 = 0x0100, 607 HAL_MAC_HANG_SIG2 = 0x0200, 608 HAL_MAC_HANG_UNKNOWN = 0x8000, 609 610 HAL_BB_HANGS = HAL_BB_HANG_DFS 611 | HAL_BB_HANG_RIFS 612 | HAL_BB_HANG_RX_CLEAR 613 | HAL_BB_HANG_UNKNOWN, 614 HAL_MAC_HANGS = HAL_MAC_HANG_SIG1 615 | HAL_MAC_HANG_SIG2 616 | HAL_MAC_HANG_UNKNOWN, 617}; 618 619/* 620 * Device revision information. 621 */ 622typedef struct { 623 uint16_t ah_devid; /* PCI device ID */ 624 uint16_t ah_subvendorid; /* PCI subvendor ID */ 625 uint32_t ah_macVersion; /* MAC version id */ 626 uint16_t ah_macRev; /* MAC revision */ 627 uint16_t ah_phyRev; /* PHY revision */ 628 uint16_t ah_analog5GhzRev; /* 2GHz radio revision */ 629 uint16_t ah_analog2GhzRev; /* 5GHz radio revision */ 630} HAL_REVS; 631 632/* 633 * Argument payload for HAL_DIAG_SETKEY. 634 */ 635typedef struct { 636 HAL_KEYVAL dk_keyval; 637 uint16_t dk_keyix; /* key index */ 638 uint8_t dk_mac[IEEE80211_ADDR_LEN]; 639 int dk_xor; /* XOR key data */ 640} HAL_DIAG_KEYVAL; 641 642/* 643 * Argument payload for HAL_DIAG_EEWRITE. 644 */ 645typedef struct { 646 uint16_t ee_off; /* eeprom offset */ 647 uint16_t ee_data; /* write data */ 648} HAL_DIAG_EEVAL; 649 650 651typedef struct { 652 u_int offset; /* reg offset */ 653 uint32_t val; /* reg value */ 654} HAL_DIAG_REGVAL; 655 656/* 657 * 11n compatibility tweaks. 658 */ 659#define HAL_DIAG_11N_SERVICES 0x00000003 660#define HAL_DIAG_11N_SERVICES_S 0 661#define HAL_DIAG_11N_TXSTOMP 0x0000000c 662#define HAL_DIAG_11N_TXSTOMP_S 2 663 664typedef struct { 665 int maxNoiseImmunityLevel; /* [0..4] */ 666 int totalSizeDesired[5]; 667 int coarseHigh[5]; 668 int coarseLow[5]; 669 int firpwr[5]; 670 671 int maxSpurImmunityLevel; /* [0..7] */ 672 int cycPwrThr1[8]; 673 674 int maxFirstepLevel; /* [0..2] */ 675 int firstep[3]; 676 677 uint32_t ofdmTrigHigh; 678 uint32_t ofdmTrigLow; 679 int32_t cckTrigHigh; 680 int32_t cckTrigLow; 681 int32_t rssiThrLow; 682 int32_t rssiThrHigh; 683 684 int period; /* update listen period */ 685} HAL_ANI_PARAMS; 686 687extern HAL_BOOL ath_hal_getdiagstate(struct ath_hal *ah, int request, 688 const void *args, uint32_t argsize, 689 void **result, uint32_t *resultsize); 690 691/* 692 * Setup a h/w rate table for use. 693 */ 694extern void ath_hal_setupratetable(struct ath_hal *ah, HAL_RATE_TABLE *rt); 695 696/* 697 * Common routine for implementing getChanNoise api. 698 */ 699int16_t ath_hal_getChanNoise(struct ath_hal *, const struct ieee80211_channel *); 700 701/* 702 * Initialization support. 703 */ 704typedef struct { 705 const uint32_t *data; 706 int rows, cols; 707} HAL_INI_ARRAY; 708 709#define HAL_INI_INIT(_ia, _data, _cols) do { \ 710 (_ia)->data = (const uint32_t *)(_data); \ 711 (_ia)->rows = sizeof(_data) / sizeof((_data)[0]); \ 712 (_ia)->cols = (_cols); \ 713} while (0) 714#define HAL_INI_VAL(_ia, _r, _c) \ 715 ((_ia)->data[((_r)*(_ia)->cols) + (_c)]) 716 717/* 718 * OS_DELAY() does a PIO READ on the PCI bus which allows 719 * other cards' DMA reads to complete in the middle of our reset. 720 */ 721#define DMA_YIELD(x) do { \ 722 if ((++(x) % 64) == 0) \ 723 OS_DELAY(1); \ 724} while (0) 725 726#define HAL_INI_WRITE_ARRAY(ah, regArray, col, regWr) do { \ 727 int r; \ 728 for (r = 0; r < N(regArray); r++) { \ 729 OS_REG_WRITE(ah, (regArray)[r][0], (regArray)[r][col]); \ 730 DMA_YIELD(regWr); \ 731 } \ 732} while (0) 733 734#define HAL_INI_WRITE_BANK(ah, regArray, bankData, regWr) do { \ 735 int r; \ 736 for (r = 0; r < N(regArray); r++) { \ 737 OS_REG_WRITE(ah, (regArray)[r][0], (bankData)[r]); \ 738 DMA_YIELD(regWr); \ 739 } \ 740} while (0) 741 742extern int ath_hal_ini_write(struct ath_hal *ah, const HAL_INI_ARRAY *ia, 743 int col, int regWr); 744extern void ath_hal_ini_bank_setup(uint32_t data[], const HAL_INI_ARRAY *ia, 745 int col); 746extern int ath_hal_ini_bank_write(struct ath_hal *ah, const HAL_INI_ARRAY *ia, 747 const uint32_t data[], int regWr); 748 749#define CCK_SIFS_TIME 10 750#define CCK_PREAMBLE_BITS 144 751#define CCK_PLCP_BITS 48 752 753#define OFDM_SIFS_TIME 16 754#define OFDM_PREAMBLE_TIME 20 755#define OFDM_PLCP_BITS 22 756#define OFDM_SYMBOL_TIME 4 757 758#define OFDM_HALF_SIFS_TIME 32 759#define OFDM_HALF_PREAMBLE_TIME 40 760#define OFDM_HALF_PLCP_BITS 22 761#define OFDM_HALF_SYMBOL_TIME 8 762 763#define OFDM_QUARTER_SIFS_TIME 64 764#define OFDM_QUARTER_PREAMBLE_TIME 80 765#define OFDM_QUARTER_PLCP_BITS 22 766#define OFDM_QUARTER_SYMBOL_TIME 16 767 768#define TURBO_SIFS_TIME 8 769#define TURBO_PREAMBLE_TIME 14 770#define TURBO_PLCP_BITS 22 771#define TURBO_SYMBOL_TIME 4 772 773#define WLAN_CTRL_FRAME_SIZE (2+2+6+4) /* ACK+FCS */ 774#endif /* _ATH_AH_INTERAL_H_ */ 775