sys/dev/netif/ath/hal/ath_hal/ah_internal.h

   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 195114 2009-06-27 20:06:56Z sam $
  18  * $DragonFly$
  19  */
  20 #ifndef _ATH_AH_INTERAL_H_
  21 #define _ATH_AH_INTERAL_H_
  22 /*
  23  * Atheros Device Hardware Access Layer (HAL).
  24  *
  25  * Internal definitions.
  26  */
  27 #define AH_NULL 0
  28 #define AH_MIN(a,b)     ((a)<(b)?(a):(b))
  29 #define AH_MAX(a,b)     ((a)>(b)?(a):(b))
  30
  31 #include <netproto/802_11/_ieee80211.h>
  32
  33 #ifndef NBBY
  34 #define NBBY    8                       /* number of bits/byte */
  35 #endif
  36
  37 #ifndef roundup
  38 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))  /* to any y */
  39 #endif
  40 #ifndef howmany
  41 #define howmany(x, y)   (((x)+((y)-1))/(y))
  42 #endif
  43
  44 #ifndef offsetof
  45 #define offsetof(type, field)   ((size_t)(&((type *)0)->field))
  46 #endif
  47
  48 typedef struct {
  49         uint16_t        start;          /* first register */
  50         uint16_t        end;            /* ending register or zero */
  51 } HAL_REGRANGE;
  52
  53 typedef struct {
  54         uint32_t        addr;           /* regiser address/offset */
  55         uint32_t        value;          /* value to write */
  56 } HAL_REGWRITE;
  57
  58 /*
  59  * Transmit power scale factor.
  60  *
  61  * NB: This is not public because we want to discourage the use of
  62  *     scaling; folks should use the tx power limit interface.
  63  */
  64 typedef enum {
  65         HAL_TP_SCALE_MAX        = 0,            /* no scaling (default) */
  66         HAL_TP_SCALE_50         = 1,            /* 50% of max (-3 dBm) */
  67         HAL_TP_SCALE_25         = 2,            /* 25% of max (-6 dBm) */
  68         HAL_TP_SCALE_12         = 3,            /* 12% of max (-9 dBm) */
  69         HAL_TP_SCALE_MIN        = 4,            /* min, but still on */
  70 } HAL_TP_SCALE;
  71
  72 typedef enum {
  73         HAL_CAP_RADAR           = 0,            /* Radar capability */
  74         HAL_CAP_AR              = 1,            /* AR capability */
  75 } HAL_PHYDIAG_CAPS;
  76
  77 /*
  78  * Each chip or class of chips registers to offer support.
  79  */
  80 struct ath_hal_chip {
  81         const char      *name;
  82         const char      *(*probe)(uint16_t vendorid, uint16_t devid);
  83         struct ath_hal  *(*attach)(uint16_t devid, HAL_SOFTC,
  84                             HAL_BUS_TAG, HAL_BUS_HANDLE, HAL_STATUS *error);
  85 };
  86 #ifndef AH_CHIP
  87 #define AH_CHIP(_name, _probe, _attach)                         \
  88 static struct ath_hal_chip _name##_chip = {                     \
  89         .name           = #_name,                               \
  90         .probe          = _probe,                               \
  91         .attach         = _attach                               \
  92 };                                                              \
  93 OS_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  */
 101 struct 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)                           \
 108 static struct ath_hal_rf _name##_rf = {                         \
 109         .name           = __STRING(_name),                      \
 110         .probe          = _probe,                               \
 111         .attach         = _attach                               \
 112 };                                                              \
 113 OS_DATA_SET(ah_rfs, _name##_rf)
 114 #endif
 115
 116 struct 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  */
 133 typedef 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
 157 typedef 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 } HAL_CAPABILITIES;
 213
 214 struct regDomain;
 215
 216 /*
 217  * The ``private area'' follows immediately after the ``public area''
 218  * in the data structure returned by ath_hal_attach.  Private data are
 219  * used by device-independent code such as the regulatory domain support.
 220  * In general, code within the HAL should never depend on data in the
 221  * public area.  Instead any public data needed internally should be
 222  * shadowed here.
 223  *
 224  * When declaring a device-specific ath_hal data structure this structure
 225  * is assumed to at the front; e.g.
 226  *
 227  *      struct ath_hal_5212 {
 228  *              struct ath_hal_private  ah_priv;
 229  *              ...
 230  *      };
 231  *
 232  * It might be better to manage the method pointers in this structure
 233  * using an indirect pointer to a read-only data structure but this would
 234  * disallow class-style method overriding.
 235  */
 236 struct ath_hal_private {
 237         struct ath_hal  h;                      /* public area */
 238
 239         /* NB: all methods go first to simplify initialization */
 240         HAL_BOOL        (*ah_getChannelEdges)(struct ath_hal*,
 241                                 uint16_t channelFlags,
 242                                 uint16_t *lowChannel, uint16_t *highChannel);
 243         u_int           (*ah_getWirelessModes)(struct ath_hal*);
 244         HAL_BOOL        (*ah_eepromRead)(struct ath_hal *, u_int off,
 245                                 uint16_t *data);
 246         HAL_BOOL        (*ah_eepromWrite)(struct ath_hal *, u_int off,
 247                                 uint16_t data);
 248         HAL_BOOL        (*ah_getChipPowerLimits)(struct ath_hal *,
 249                                 struct ieee80211_channel *);
 250         int16_t         (*ah_getNfAdjust)(struct ath_hal *,
 251                                 const HAL_CHANNEL_INTERNAL*);
 252         void            (*ah_getNoiseFloor)(struct ath_hal *,
 253                                 int16_t nfarray[]);
 254
 255         void            *ah_eeprom;             /* opaque EEPROM state */
 256         uint16_t        ah_eeversion;           /* EEPROM version */
 257         void            (*ah_eepromDetach)(struct ath_hal *);
 258         HAL_STATUS      (*ah_eepromGet)(struct ath_hal *, int, void *);
 259         HAL_BOOL        (*ah_eepromSet)(struct ath_hal *, int, int);
 260         uint16_t        (*ah_getSpurChan)(struct ath_hal *, int, HAL_BOOL);
 261         HAL_BOOL        (*ah_eepromDiag)(struct ath_hal *, int request,
 262                             const void *args, uint32_t argsize,
 263                             void **result, uint32_t *resultsize);
 264
 265         /*
 266          * Device revision information.
 267          */
 268         uint16_t        ah_devid;               /* PCI device ID */
 269         uint16_t        ah_subvendorid;         /* PCI subvendor ID */
 270         uint32_t        ah_macVersion;          /* MAC version id */
 271         uint16_t        ah_macRev;              /* MAC revision */
 272         uint16_t        ah_phyRev;              /* PHY revision */
 273         uint16_t        ah_analog5GhzRev;       /* 2GHz radio revision */
 274         uint16_t        ah_analog2GhzRev;       /* 5GHz radio revision */
 275         uint8_t         ah_ispcie;              /* PCIE, special treatment */
 276
 277         HAL_OPMODE      ah_opmode;              /* operating mode from reset */
 278         const struct ieee80211_channel *ah_curchan;/* operating channel */
 279         HAL_CAPABILITIES ah_caps;               /* device capabilities */
 280         uint32_t        ah_diagreg;             /* user-specified AR_DIAG_SW */
 281         int16_t         ah_powerLimit;          /* tx power cap */
 282         uint16_t        ah_maxPowerLevel;       /* calculated max tx power */
 283         u_int           ah_tpScale;             /* tx power scale factor */
 284         uint32_t        ah_11nCompat;           /* 11n compat controls */
 285
 286         /*
 287          * State for regulatory domain handling.
 288          */
 289         HAL_REG_DOMAIN  ah_currentRD;           /* EEPROM regulatory domain */
 290         HAL_CHANNEL_INTERNAL ah_channels[AH_MAXCHAN]; /* private chan state */
 291         u_int           ah_nchan;               /* valid items in ah_channels */
 292         const struct regDomain *ah_rd2GHz;      /* reg state for 2G band */
 293         const struct regDomain *ah_rd5GHz;      /* reg state for 5G band */
 294
 295         uint8_t         ah_coverageClass;       /* coverage class */
 296         /*
 297          * RF Silent handling; setup according to the EEPROM.
 298          */
 299         uint16_t        ah_rfsilent;            /* GPIO pin + polarity */
 300         HAL_BOOL        ah_rfkillEnabled;       /* enable/disable RfKill */
 301         /*
 302          * Diagnostic support for discriminating HIUERR reports.
 303          */
 304         uint32_t        ah_fatalState[6];       /* AR_ISR+shadow regs */
 305         int             ah_rxornIsFatal;        /* how to treat HAL_INT_RXORN */
 306 };
 307
 308 #define AH_PRIVATE(_ah) ((struct ath_hal_private *)(_ah))
 309
 310 #define ath_hal_getChannelEdges(_ah, _cf, _lc, _hc) \
 311         AH_PRIVATE(_ah)->ah_getChannelEdges(_ah, _cf, _lc, _hc)
 312 #define ath_hal_getWirelessModes(_ah) \
 313         AH_PRIVATE(_ah)->ah_getWirelessModes(_ah)
 314 #define ath_hal_eepromRead(_ah, _off, _data) \
 315         AH_PRIVATE(_ah)->ah_eepromRead(_ah, _off, _data)
 316 #define ath_hal_eepromWrite(_ah, _off, _data) \
 317         AH_PRIVATE(_ah)->ah_eepromWrite(_ah, _off, _data)
 318 #define ath_hal_gpioCfgOutput(_ah, _gpio, _type) \
 319         (_ah)->ah_gpioCfgOutput(_ah, _gpio, _type)
 320 #define ath_hal_gpioCfgInput(_ah, _gpio) \
 321         (_ah)->ah_gpioCfgInput(_ah, _gpio)
 322 #define ath_hal_gpioGet(_ah, _gpio) \
 323         (_ah)->ah_gpioGet(_ah, _gpio)
 324 #define ath_hal_gpioSet(_ah, _gpio, _val) \
 325         (_ah)->ah_gpioSet(_ah, _gpio, _val)
 326 #define ath_hal_gpioSetIntr(_ah, _gpio, _ilevel) \
 327         (_ah)->ah_gpioSetIntr(_ah, _gpio, _ilevel)
 328 #define ath_hal_getpowerlimits(_ah, _chan) \
 329         AH_PRIVATE(_ah)->ah_getChipPowerLimits(_ah, _chan)
 330 #define ath_hal_getNfAdjust(_ah, _c) \
 331         AH_PRIVATE(_ah)->ah_getNfAdjust(_ah, _c)
 332 #define ath_hal_getNoiseFloor(_ah, _nfArray) \
 333         AH_PRIVATE(_ah)->ah_getNoiseFloor(_ah, _nfArray)
 334 #define ath_hal_configPCIE(_ah, _reset) \
 335         (_ah)->ah_configPCIE(_ah, _reset)
 336 #define ath_hal_disablePCIE(_ah) \
 337         (_ah)->ah_disablePCIE(_ah)
 338 #define ath_hal_setInterrupts(_ah, _mask) \
 339         (_ah)->ah_setInterrupts(_ah, _mask)
 340
 341 #define ath_hal_eepromDetach(_ah) do {                          \
 342         if (AH_PRIVATE(_ah)->ah_eepromDetach != AH_NULL)        \
 343                 AH_PRIVATE(_ah)->ah_eepromDetach(_ah);          \
 344 } while (0)
 345 #define ath_hal_eepromGet(_ah, _param, _val) \
 346         AH_PRIVATE(_ah)->ah_eepromGet(_ah, _param, _val)
 347 #define ath_hal_eepromSet(_ah, _param, _val) \
 348         AH_PRIVATE(_ah)->ah_eepromSet(_ah, _param, _val)
 349 #define ath_hal_eepromGetFlag(_ah, _param) \
 350         (AH_PRIVATE(_ah)->ah_eepromGet(_ah, _param, AH_NULL) == HAL_OK)
 351 #define ath_hal_getSpurChan(_ah, _ix, _is2G) \
 352         AH_PRIVATE(_ah)->ah_getSpurChan(_ah, _ix, _is2G)
 353 #define ath_hal_eepromDiag(_ah, _request, _a, _asize, _r, _rsize) \
 354         AH_PRIVATE(_ah)->ah_eepromDiag(_ah, _request, _a, _asize,  _r, _rsize)
 355
 356 #ifndef _NET_IF_IEEE80211_H_
 357 /*
 358  * Stuff that would naturally come from _ieee80211.h
 359  */
 360 #define IEEE80211_ADDR_LEN              6
 361
 362 #define IEEE80211_WEP_IVLEN                     3       /* 24bit */
 363 #define IEEE80211_WEP_KIDLEN                    1       /* 1 octet */
 364 #define IEEE80211_WEP_CRCLEN                    4       /* CRC-32 */
 365
 366 #define IEEE80211_CRC_LEN                       4
 367
 368 #define IEEE80211_MAX_LEN                       (2300 + IEEE80211_CRC_LEN + \
 369     (IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN + IEEE80211_WEP_CRCLEN))
 370 #endif /* _NET_IF_IEEE80211_H_ */
 371
 372 #define HAL_TXQ_USE_LOCKOUT_BKOFF_DIS   0x00000001
 373
 374 #define INIT_AIFS               2
 375 #define INIT_CWMIN              15
 376 #define INIT_CWMIN_11B          31
 377 #define INIT_CWMAX              1023
 378 #define INIT_SH_RETRY           10
 379 #define INIT_LG_RETRY           10
 380 #define INIT_SSH_RETRY          32
 381 #define INIT_SLG_RETRY          32
 382
 383 typedef struct {
 384         uint32_t        tqi_ver;                /* HAL TXQ verson */
 385         HAL_TX_QUEUE    tqi_type;               /* hw queue type*/
 386         HAL_TX_QUEUE_SUBTYPE tqi_subtype;       /* queue subtype, if applicable */
 387         HAL_TX_QUEUE_FLAGS tqi_qflags;          /* queue flags */
 388         uint32_t        tqi_priority;
 389         uint32_t        tqi_aifs;               /* aifs */
 390         uint32_t        tqi_cwmin;              /* cwMin */
 391         uint32_t        tqi_cwmax;              /* cwMax */
 392         uint16_t        tqi_shretry;            /* frame short retry limit */
 393         uint16_t        tqi_lgretry;            /* frame long retry limit */
 394         uint32_t        tqi_cbrPeriod;
 395         uint32_t        tqi_cbrOverflowLimit;
 396         uint32_t        tqi_burstTime;
 397         uint32_t        tqi_readyTime;
 398         uint32_t        tqi_physCompBuf;
 399         uint32_t        tqi_intFlags;           /* flags for internal use */
 400 } HAL_TX_QUEUE_INFO;
 401
 402 extern  HAL_BOOL ath_hal_setTxQProps(struct ath_hal *ah,
 403                 HAL_TX_QUEUE_INFO *qi, const HAL_TXQ_INFO *qInfo);
 404 extern  HAL_BOOL ath_hal_getTxQProps(struct ath_hal *ah,
 405                 HAL_TXQ_INFO *qInfo, const HAL_TX_QUEUE_INFO *qi);
 406
 407 typedef enum {
 408         HAL_ANI_PRESENT,                        /* is ANI support present */
 409         HAL_ANI_NOISE_IMMUNITY_LEVEL,           /* set level */
 410         HAL_ANI_OFDM_WEAK_SIGNAL_DETECTION,     /* enable/disable */
 411         HAL_ANI_CCK_WEAK_SIGNAL_THR,            /* enable/disable */
 412         HAL_ANI_FIRSTEP_LEVEL,                  /* set level */
 413         HAL_ANI_SPUR_IMMUNITY_LEVEL,            /* set level */
 414         HAL_ANI_MODE = 6,       /* 0 => manual, 1 => auto (XXX do not change) */
 415         HAL_ANI_PHYERR_RESET,                   /* reset phy error stats */
 416 } HAL_ANI_CMD;
 417
 418 #define HAL_SPUR_VAL_MASK               0x3FFF
 419 #define HAL_SPUR_CHAN_WIDTH             87
 420 #define HAL_BIN_WIDTH_BASE_100HZ        3125
 421 #define HAL_BIN_WIDTH_TURBO_100HZ       6250
 422 #define HAL_MAX_BINS_ALLOWED            28
 423
 424 #define IS_CHAN_5GHZ(_c)        ((_c)->channel > 4900)
 425 #define IS_CHAN_2GHZ(_c)        (!IS_CHAN_5GHZ(_c))
 426
 427 #define IS_CHAN_IN_PUBLIC_SAFETY_BAND(_c) ((_c) > 4940 && (_c) < 4990)
 428
 429 /*
 430  * Deduce if the host cpu has big- or litt-endian byte order.
 431  */
 432 static __inline__ int
 433 isBigEndian(void)
 434 {
 435         union {
 436                 int32_t i;
 437                 char c[4];
 438         } u;
 439         u.i = 1;
 440         return (u.c[0] == 0);
 441 }
 442
 443 /* unalligned little endian access */
 444 #define LE_READ_2(p)                                                    \
 445         ((uint16_t)                                                     \
 446          ((((const uint8_t *)(p))[0]    ) | (((const uint8_t *)(p))[1]<< 8)))
 447 #define LE_READ_4(p)                                                    \
 448         ((uint32_t)                                                     \
 449          ((((const uint8_t *)(p))[0]    ) | (((const uint8_t *)(p))[1]<< 8) |\
 450           (((const uint8_t *)(p))[2]<<16) | (((const uint8_t *)(p))[3]<<24)))
 451
 452 /*
 453  * Register manipulation macros that expect bit field defines
 454  * to follow the convention that an _S suffix is appended for
 455  * a shift count, while the field mask has no suffix.
 456  */
 457 #define SM(_v, _f)      (((_v) << _f##_S) & (_f))
 458 #define MS(_v, _f)      (((_v) & (_f)) >> _f##_S)
 459 #define OS_REG_RMW_FIELD(_a, _r, _f, _v) \
 460         OS_REG_WRITE(_a, _r, \
 461                 (OS_REG_READ(_a, _r) &~ (_f)) | (((_v) << _f##_S) & (_f)))
 462 #define OS_REG_SET_BIT(_a, _r, _f) \
 463         OS_REG_WRITE(_a, _r, OS_REG_READ(_a, _r) | (_f))
 464 #define OS_REG_CLR_BIT(_a, _r, _f) \
 465         OS_REG_WRITE(_a, _r, OS_REG_READ(_a, _r) &~ (_f))
 466
 467 /* system-configurable parameters */
 468 extern  int ath_hal_dma_beacon_response_time;   /* in TU's */
 469 extern  int ath_hal_sw_beacon_response_time;    /* in TU's */
 470 extern  int ath_hal_additional_swba_backoff;    /* in TU's */
 471
 472 /* wait for the register contents to have the specified value */
 473 extern  HAL_BOOL ath_hal_wait(struct ath_hal *, u_int reg,
 474                 uint32_t mask, uint32_t val);
 475
 476 /* return the first n bits in val reversed */
 477 extern  uint32_t ath_hal_reverseBits(uint32_t val, uint32_t n);
 478
 479 /* printf interfaces */
 480 extern  void ath_hal_printf(struct ath_hal *, const char*, ...)
 481                 __printflike(2,3);
 482 extern  void ath_hal_vprintf(struct ath_hal *, const char*, __va_list)
 483                 __printflike(2, 0);
 484 extern  const char* ath_hal_ether_sprintf(const uint8_t *mac);
 485
 486 /* allocate and free memory */
 487 extern  void *ath_hal_malloc(size_t);
 488 extern  void ath_hal_free(void *);
 489
 490 /* common debugging interfaces */
 491 #ifdef AH_DEBUG
 492 #include "ah_debug.h"
 493 extern  int ath_hal_debug;
 494 extern  void HALDEBUG(struct ath_hal *ah, u_int mask, const char* fmt, ...)
 495         __printflike(3,4);
 496 #else
 497 #define HALDEBUG(_ah, __m, _fmt, ...)
 498 #endif /* AH_DEBUG */
 499
 500 /*
 501  * Register logging definitions shared with ardecode.
 502  */
 503 #include "ah_decode.h"
 504
 505 /*
 506  * Common assertion interface.  Note: it is a bad idea to generate
 507  * an assertion failure for any recoverable event.  Instead catch
 508  * the violation and, if possible, fix it up or recover from it; either
 509  * with an error return value or a diagnostic messages.  System software
 510  * does not panic unless the situation is hopeless.
 511  */
 512 #ifdef AH_ASSERT
 513 extern  void ath_hal_assert_failed(const char* filename,
 514                 int lineno, const char* msg);
 515
 516 #define HALASSERT(_x) do {                                      \
 517         if (!(_x)) {                                            \
 518                 ath_hal_assert_failed(__FILE__, __LINE__, #_x); \
 519         }                                                       \
 520 } while (0)
 521 #else
 522 #define HALASSERT(_x)
 523 #endif /* AH_ASSERT */
 524
 525 /*
 526  * Regulatory domain support.
 527  */
 528
 529 /*
 530  * Return the max allowed antenna gain and apply any regulatory
 531  * domain specific changes.
 532  */
 533 u_int   ath_hal_getantennareduction(struct ath_hal *ah,
 534             const struct ieee80211_channel *chan, u_int twiceGain);
 535
 536 /*
 537  * Return the test group for the specific channel based on
 538  * the current regulatory setup.
 539  */
 540 u_int   ath_hal_getctl(struct ath_hal *, const struct ieee80211_channel *);
 541
 542 /*
 543  * Map a public channel definition to the corresponding
 544  * internal data structure.  This implicitly specifies
 545  * whether or not the specified channel is ok to use
 546  * based on the current regulatory domain constraints.
 547  */
 548 #ifndef AH_DEBUG
 549 static OS_INLINE HAL_CHANNEL_INTERNAL *
 550 ath_hal_checkchannel(struct ath_hal *ah, const struct ieee80211_channel *c)
 551 {
 552         HAL_CHANNEL_INTERNAL *cc;
 553
 554         HALASSERT(c->ic_devdata < AH_PRIVATE(ah)->ah_nchan);
 555         cc = &AH_PRIVATE(ah)->ah_channels[c->ic_devdata];
 556         HALASSERT(c->ic_freq == cc->channel || IEEE80211_IS_CHAN_GSM(c));
 557         return cc;
 558 }
 559 #else
 560 /* NB: non-inline version that checks state */
 561 HAL_CHANNEL_INTERNAL *ath_hal_checkchannel(struct ath_hal *,
 562                 const struct ieee80211_channel *);
 563 #endif /* AH_DEBUG */
 564
 565 /*
 566  * Return the h/w frequency for a channel.  This may be
 567  * different from ic_freq if this is a GSM device that
 568  * takes 2.4GHz frequencies and down-converts them.
 569  */
 570 static OS_INLINE uint16_t
 571 ath_hal_gethwchannel(struct ath_hal *ah, const struct ieee80211_channel *c)
 572 {
 573         return ath_hal_checkchannel(ah, c)->channel;
 574 }
 575
 576 /*
 577  * Convert between microseconds and core system clocks.
 578  */
 579 extern  u_int ath_hal_mac_clks(struct ath_hal *ah, u_int usecs);
 580 extern  u_int ath_hal_mac_usec(struct ath_hal *ah, u_int clks);
 581
 582 /*
 583  * Generic get/set capability support.  Each chip overrides
 584  * this routine to support chip-specific capabilities.
 585  */
 586 extern  HAL_STATUS ath_hal_getcapability(struct ath_hal *ah,
 587                 HAL_CAPABILITY_TYPE type, uint32_t capability,
 588                 uint32_t *result);
 589 extern  HAL_BOOL ath_hal_setcapability(struct ath_hal *ah,
 590                 HAL_CAPABILITY_TYPE type, uint32_t capability,
 591                 uint32_t setting, HAL_STATUS *status);
 592
 593 /*
 594  * Diagnostic interface.  This is an open-ended interface that
 595  * is opaque to applications.  Diagnostic programs use this to
 596  * retrieve internal data structures, etc.  There is no guarantee
 597  * that calling conventions for calls other than HAL_DIAG_REVS
 598  * are stable between HAL releases; a diagnostic application must
 599  * use the HAL revision information to deal with ABI/API differences.
 600  *
 601  * NB: do not renumber these, certain codes are publicly used.
 602  */
 603 enum {
 604         HAL_DIAG_REVS           = 0,    /* MAC/PHY/Radio revs */
 605         HAL_DIAG_EEPROM         = 1,    /* EEPROM contents */
 606         HAL_DIAG_EEPROM_EXP_11A = 2,    /* EEPROM 5112 power exp for 11a */
 607         HAL_DIAG_EEPROM_EXP_11B = 3,    /* EEPROM 5112 power exp for 11b */
 608         HAL_DIAG_EEPROM_EXP_11G = 4,    /* EEPROM 5112 power exp for 11g */
 609         HAL_DIAG_ANI_CURRENT    = 5,    /* ANI current channel state */
 610         HAL_DIAG_ANI_OFDM       = 6,    /* ANI OFDM timing error stats */
 611         HAL_DIAG_ANI_CCK        = 7,    /* ANI CCK timing error stats */
 612         HAL_DIAG_ANI_STATS      = 8,    /* ANI statistics */
 613         HAL_DIAG_RFGAIN         = 9,    /* RfGain GAIN_VALUES */
 614         HAL_DIAG_RFGAIN_CURSTEP = 10,   /* RfGain GAIN_OPTIMIZATION_STEP */
 615         HAL_DIAG_PCDAC          = 11,   /* PCDAC table */
 616         HAL_DIAG_TXRATES        = 12,   /* Transmit rate table */
 617         HAL_DIAG_REGS           = 13,   /* Registers */
 618         HAL_DIAG_ANI_CMD        = 14,   /* ANI issue command (XXX do not change!) */
 619         HAL_DIAG_SETKEY         = 15,   /* Set keycache backdoor */
 620         HAL_DIAG_RESETKEY       = 16,   /* Reset keycache backdoor */
 621         HAL_DIAG_EEREAD         = 17,   /* Read EEPROM word */
 622         HAL_DIAG_EEWRITE        = 18,   /* Write EEPROM word */
 623         /* 19-26 removed, do not reuse */
 624         HAL_DIAG_RDWRITE        = 27,   /* Write regulatory domain */
 625         HAL_DIAG_RDREAD         = 28,   /* Get regulatory domain */
 626         HAL_DIAG_FATALERR       = 29,   /* Read cached interrupt state */
 627         HAL_DIAG_11NCOMPAT      = 30,   /* 11n compatibility tweaks */
 628         HAL_DIAG_ANI_PARAMS     = 31,   /* ANI noise immunity parameters */
 629         HAL_DIAG_CHECK_HANGS    = 32,   /* check h/w hangs */
 630         HAL_DIAG_SETREGS        = 33,   /* write registers */
 631 };
 632
 633 enum {
 634     HAL_BB_HANG_DFS             = 0x0001,
 635     HAL_BB_HANG_RIFS            = 0x0002,
 636     HAL_BB_HANG_RX_CLEAR        = 0x0004,
 637     HAL_BB_HANG_UNKNOWN         = 0x0080,
 638
 639     HAL_MAC_HANG_SIG1           = 0x0100,
 640     HAL_MAC_HANG_SIG2           = 0x0200,
 641     HAL_MAC_HANG_UNKNOWN        = 0x8000,
 642
 643     HAL_BB_HANGS = HAL_BB_HANG_DFS
 644                  | HAL_BB_HANG_RIFS
 645                  | HAL_BB_HANG_RX_CLEAR
 646                  | HAL_BB_HANG_UNKNOWN,
 647     HAL_MAC_HANGS = HAL_MAC_HANG_SIG1
 648                  | HAL_MAC_HANG_SIG2
 649                  | HAL_MAC_HANG_UNKNOWN,
 650 };
 651
 652 /*
 653  * Device revision information.
 654  */
 655 typedef struct {
 656         uint16_t        ah_devid;               /* PCI device ID */
 657         uint16_t        ah_subvendorid;         /* PCI subvendor ID */
 658         uint32_t        ah_macVersion;          /* MAC version id */
 659         uint16_t        ah_macRev;              /* MAC revision */
 660         uint16_t        ah_phyRev;              /* PHY revision */
 661         uint16_t        ah_analog5GhzRev;       /* 2GHz radio revision */
 662         uint16_t        ah_analog2GhzRev;       /* 5GHz radio revision */
 663 } HAL_REVS;
 664
 665 /*
 666  * Argument payload for HAL_DIAG_SETKEY.
 667  */
 668 typedef struct {
 669         HAL_KEYVAL      dk_keyval;
 670         uint16_t        dk_keyix;       /* key index */
 671         uint8_t         dk_mac[IEEE80211_ADDR_LEN];
 672         int             dk_xor;         /* XOR key data */
 673 } HAL_DIAG_KEYVAL;
 674
 675 /*
 676  * Argument payload for HAL_DIAG_EEWRITE.
 677  */
 678 typedef struct {
 679         uint16_t        ee_off;         /* eeprom offset */
 680         uint16_t        ee_data;        /* write data */
 681 } HAL_DIAG_EEVAL;
 682
 683
 684 typedef struct {
 685         u_int offset;           /* reg offset */
 686         uint32_t val;           /* reg value  */
 687 } HAL_DIAG_REGVAL;
 688
 689 /*
 690  * 11n compatibility tweaks.
 691  */
 692 #define HAL_DIAG_11N_SERVICES   0x00000003
 693 #define HAL_DIAG_11N_SERVICES_S 0
 694 #define HAL_DIAG_11N_TXSTOMP    0x0000000c
 695 #define HAL_DIAG_11N_TXSTOMP_S  2
 696
 697 typedef struct {
 698         int             maxNoiseImmunityLevel;  /* [0..4] */
 699         int             totalSizeDesired[5];
 700         int             coarseHigh[5];
 701         int             coarseLow[5];
 702         int             firpwr[5];
 703
 704         int             maxSpurImmunityLevel;   /* [0..7] */
 705         int             cycPwrThr1[8];
 706
 707         int             maxFirstepLevel;        /* [0..2] */
 708         int             firstep[3];
 709
 710         uint32_t        ofdmTrigHigh;
 711         uint32_t        ofdmTrigLow;
 712         int32_t         cckTrigHigh;
 713         int32_t         cckTrigLow;
 714         int32_t         rssiThrLow;
 715         int32_t         rssiThrHigh;
 716
 717         int             period;                 /* update listen period */
 718 } HAL_ANI_PARAMS;
 719
 720 extern  HAL_BOOL ath_hal_getdiagstate(struct ath_hal *ah, int request,
 721                         const void *args, uint32_t argsize,
 722                         void **result, uint32_t *resultsize);
 723
 724 /*
 725  * Setup a h/w rate table for use.
 726  */
 727 extern  void ath_hal_setupratetable(struct ath_hal *ah, HAL_RATE_TABLE *rt);
 728
 729 /*
 730  * Common routine for implementing getChanNoise api.
 731  */
 732 int16_t ath_hal_getChanNoise(struct ath_hal *, const struct ieee80211_channel *);
 733
 734 /*
 735  * Initialization support.
 736  */
 737 typedef struct {
 738         const uint32_t  *data;
 739         int             rows, cols;
 740 } HAL_INI_ARRAY;
 741
 742 #define HAL_INI_INIT(_ia, _data, _cols) do {                    \
 743         (_ia)->data = (const uint32_t *)(_data);                \
 744         (_ia)->rows = sizeof(_data) / sizeof((_data)[0]);       \
 745         (_ia)->cols = (_cols);                                  \
 746 } while (0)
 747 #define HAL_INI_VAL(_ia, _r, _c) \
 748         ((_ia)->data[((_r)*(_ia)->cols) + (_c)])
 749
 750 /*
 751  * OS_DELAY() does a PIO READ on the PCI bus which allows
 752  * other cards' DMA reads to complete in the middle of our reset.
 753  */
 754 #define DMA_YIELD(x) do {               \
 755         if ((++(x) % 64) == 0)          \
 756                 OS_DELAY(1);            \
 757 } while (0)
 758
 759 #define HAL_INI_WRITE_ARRAY(ah, regArray, col, regWr) do {              \
 760         int r;                                                          \
 761         for (r = 0; r < N(regArray); r++) {                             \
 762                 OS_REG_WRITE(ah, (regArray)[r][0], (regArray)[r][col]); \
 763                 DMA_YIELD(regWr);                                       \
 764         }                                                               \
 765 } while (0)
 766
 767 #define HAL_INI_WRITE_BANK(ah, regArray, bankData, regWr) do {          \
 768         int r;                                                          \
 769         for (r = 0; r < N(regArray); r++) {                             \
 770                 OS_REG_WRITE(ah, (regArray)[r][0], (bankData)[r]);      \
 771                 DMA_YIELD(regWr);                                       \
 772         }                                                               \
 773 } while (0)
 774
 775 extern  int ath_hal_ini_write(struct ath_hal *ah, const HAL_INI_ARRAY *ia,
 776                 int col, int regWr);
 777 extern  void ath_hal_ini_bank_setup(uint32_t data[], const HAL_INI_ARRAY *ia,
 778                 int col);
 779 extern  int ath_hal_ini_bank_write(struct ath_hal *ah, const HAL_INI_ARRAY *ia,
 780                 const uint32_t data[], int regWr);
 781
 782 #define CCK_SIFS_TIME           10
 783 #define CCK_PREAMBLE_BITS       144
 784 #define CCK_PLCP_BITS           48
 785
 786 #define OFDM_SIFS_TIME          16
 787 #define OFDM_PREAMBLE_TIME      20
 788 #define OFDM_PLCP_BITS          22
 789 #define OFDM_SYMBOL_TIME        4
 790
 791 #define OFDM_HALF_SIFS_TIME     32
 792 #define OFDM_HALF_PREAMBLE_TIME 40
 793 #define OFDM_HALF_PLCP_BITS     22
 794 #define OFDM_HALF_SYMBOL_TIME   8
 795
 796 #define OFDM_QUARTER_SIFS_TIME          64
 797 #define OFDM_QUARTER_PREAMBLE_TIME      80
 798 #define OFDM_QUARTER_PLCP_BITS          22
 799 #define OFDM_QUARTER_SYMBOL_TIME        16
 800
 801 #define TURBO_SIFS_TIME         8
 802 #define TURBO_PREAMBLE_TIME     14
 803 #define TURBO_PLCP_BITS         22
 804 #define TURBO_SYMBOL_TIME       4
 805
 806 #define WLAN_CTRL_FRAME_SIZE    (2+2+6+4)       /* ACK+FCS */
 807 #endif /* _ATH_AH_INTERAL_H_ */