drivers/net/wireless/ath/ath9k/mac.h

   1 /*
   2  * Copyright (c) 2008-2009 Atheros Communications Inc.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef MAC_H
  18 #define MAC_H
  19
  20 #define RXSTATUS_RATE(ah, ads) (AR_SREV_5416_20_OR_LATER(ah) ?          \
  21                                 MS(ads->ds_rxstatus0, AR_RxRate) :      \
  22                                 (ads->ds_rxstatus3 >> 2) & 0xFF)
  23
  24 #define set11nTries(_series, _index) \
  25         (SM((_series)[_index].Tries, AR_XmitDataTries##_index))
  26
  27 #define set11nRate(_series, _index) \
  28         (SM((_series)[_index].Rate, AR_XmitRate##_index))
  29
  30 #define set11nPktDurRTSCTS(_series, _index)                             \
  31         (SM((_series)[_index].PktDuration, AR_PacketDur##_index) |      \
  32          ((_series)[_index].RateFlags & ATH9K_RATESERIES_RTS_CTS   ?    \
  33           AR_RTSCTSQual##_index : 0))
  34
  35 #define set11nRateFlags(_series, _index)                                \
  36         (((_series)[_index].RateFlags & ATH9K_RATESERIES_2040 ?         \
  37           AR_2040_##_index : 0)                                         \
  38          |((_series)[_index].RateFlags & ATH9K_RATESERIES_HALFGI ?      \
  39            AR_GI##_index : 0)                                           \
  40          |SM((_series)[_index].ChSel, AR_ChainSel##_index))
  41
  42 #define CCK_SIFS_TIME        10
  43 #define CCK_PREAMBLE_BITS   144
  44 #define CCK_PLCP_BITS        48
  45
  46 #define OFDM_SIFS_TIME        16
  47 #define OFDM_PREAMBLE_TIME    20
  48 #define OFDM_PLCP_BITS        22
  49 #define OFDM_SYMBOL_TIME      4
  50
  51 #define OFDM_SIFS_TIME_HALF     32
  52 #define OFDM_PREAMBLE_TIME_HALF 40
  53 #define OFDM_PLCP_BITS_HALF     22
  54 #define OFDM_SYMBOL_TIME_HALF   8
  55
  56 #define OFDM_SIFS_TIME_QUARTER      64
  57 #define OFDM_PREAMBLE_TIME_QUARTER  80
  58 #define OFDM_PLCP_BITS_QUARTER      22
  59 #define OFDM_SYMBOL_TIME_QUARTER    16
  60
  61 #define INIT_AIFS       2
  62 #define INIT_CWMIN      15
  63 #define INIT_CWMIN_11B  31
  64 #define INIT_CWMAX      1023
  65 #define INIT_SH_RETRY   10
  66 #define INIT_LG_RETRY   10
  67 #define INIT_SSH_RETRY  32
  68 #define INIT_SLG_RETRY  32
  69
  70 #define ATH9K_SLOT_TIME_6 6
  71 #define ATH9K_SLOT_TIME_9 9
  72 #define ATH9K_SLOT_TIME_20 20
  73
  74 #define ATH9K_TXERR_XRETRY         0x01
  75 #define ATH9K_TXERR_FILT           0x02
  76 #define ATH9K_TXERR_FIFO           0x04
  77 #define ATH9K_TXERR_XTXOP          0x08
  78 #define ATH9K_TXERR_TIMER_EXPIRED  0x10
  79 #define ATH9K_TX_ACKED             0x20
  80 #define ATH9K_TXERR_MASK                                                \
  81         (ATH9K_TXERR_XRETRY | ATH9K_TXERR_FILT | ATH9K_TXERR_FIFO |     \
  82          ATH9K_TXERR_XTXOP | ATH9K_TXERR_TIMER_EXPIRED)
  83
  84 #define ATH9K_TX_BA                0x01
  85 #define ATH9K_TX_PWRMGMT           0x02
  86 #define ATH9K_TX_DESC_CFG_ERR      0x04
  87 #define ATH9K_TX_DATA_UNDERRUN     0x08
  88 #define ATH9K_TX_DELIM_UNDERRUN    0x10
  89 #define ATH9K_TX_SW_FILTERED       0x80
  90
  91 /* 64 bytes */
  92 #define MIN_TX_FIFO_THRESHOLD   0x1
  93
  94 /*
  95  * Single stream device AR9285 and AR9271 require 2 KB
  96  * to work around a hardware issue, all other devices
  97  * have can use the max 4 KB limit.
  98  */
  99 #define MAX_TX_FIFO_THRESHOLD   ((4096 / 64) - 1)
 100
 101 struct ath_tx_status {
 102         u32 ts_tstamp;
 103         u16 ts_seqnum;
 104         u8 ts_status;
 105         u8 ts_ratecode;
 106         u8 ts_rateindex;
 107         int8_t ts_rssi;
 108         u8 ts_shortretry;
 109         u8 ts_longretry;
 110         u8 ts_virtcol;
 111         u8 ts_antenna;
 112         u8 ts_flags;
 113         int8_t ts_rssi_ctl0;
 114         int8_t ts_rssi_ctl1;
 115         int8_t ts_rssi_ctl2;
 116         int8_t ts_rssi_ext0;
 117         int8_t ts_rssi_ext1;
 118         int8_t ts_rssi_ext2;
 119         u8 pad[3];
 120         u32 ba_low;
 121         u32 ba_high;
 122         u32 evm0;
 123         u32 evm1;
 124         u32 evm2;
 125 };
 126
 127 struct ath_rx_status {
 128         u32 rs_tstamp;
 129         u16 rs_datalen;
 130         u8 rs_status;
 131         u8 rs_phyerr;
 132         int8_t rs_rssi;
 133         u8 rs_keyix;
 134         u8 rs_rate;
 135         u8 rs_antenna;
 136         u8 rs_more;
 137         int8_t rs_rssi_ctl0;
 138         int8_t rs_rssi_ctl1;
 139         int8_t rs_rssi_ctl2;
 140         int8_t rs_rssi_ext0;
 141         int8_t rs_rssi_ext1;
 142         int8_t rs_rssi_ext2;
 143         u8 rs_isaggr;
 144         u8 rs_moreaggr;
 145         u8 rs_num_delims;
 146         u8 rs_flags;
 147         u32 evm0;
 148         u32 evm1;
 149         u32 evm2;
 150         u32 evm3;
 151         u32 evm4;
 152 };
 153
 154 struct ath_htc_rx_status {
 155         u64 rs_tstamp;
 156         u16 rs_datalen;
 157         u8 rs_status;
 158         u8 rs_phyerr;
 159         int8_t rs_rssi;
 160         int8_t rs_rssi_ctl0;
 161         int8_t rs_rssi_ctl1;
 162         int8_t rs_rssi_ctl2;
 163         int8_t rs_rssi_ext0;
 164         int8_t rs_rssi_ext1;
 165         int8_t rs_rssi_ext2;
 166         u8 rs_keyix;
 167         u8 rs_rate;
 168         u8 rs_antenna;
 169         u8 rs_more;
 170         u8 rs_isaggr;
 171         u8 rs_moreaggr;
 172         u8 rs_num_delims;
 173         u8 rs_flags;
 174         u8 rs_dummy;
 175         u32 evm0;
 176         u32 evm1;
 177         u32 evm2;
 178 };
 179
 180 #define ATH9K_RXERR_CRC           0x01
 181 #define ATH9K_RXERR_PHY           0x02
 182 #define ATH9K_RXERR_FIFO          0x04
 183 #define ATH9K_RXERR_DECRYPT       0x08
 184 #define ATH9K_RXERR_MIC           0x10
 185
 186 #define ATH9K_RX_MORE             0x01
 187 #define ATH9K_RX_MORE_AGGR        0x02
 188 #define ATH9K_RX_GI               0x04
 189 #define ATH9K_RX_2040             0x08
 190 #define ATH9K_RX_DELIM_CRC_PRE    0x10
 191 #define ATH9K_RX_DELIM_CRC_POST   0x20
 192 #define ATH9K_RX_DECRYPT_BUSY     0x40
 193
 194 #define ATH9K_RXKEYIX_INVALID   ((u8)-1)
 195 #define ATH9K_TXKEYIX_INVALID   ((u32)-1)
 196
 197 enum ath9k_phyerr {
 198         ATH9K_PHYERR_UNDERRUN             = 0,  /* Transmit underrun */
 199         ATH9K_PHYERR_TIMING               = 1,  /* Timing error */
 200         ATH9K_PHYERR_PARITY               = 2,  /* Illegal parity */
 201         ATH9K_PHYERR_RATE                 = 3,  /* Illegal rate */
 202         ATH9K_PHYERR_LENGTH               = 4,  /* Illegal length */
 203         ATH9K_PHYERR_RADAR                = 5,  /* Radar detect */
 204         ATH9K_PHYERR_SERVICE              = 6,  /* Illegal service */
 205         ATH9K_PHYERR_TOR                  = 7,  /* Transmit override receive */
 206
 207         ATH9K_PHYERR_OFDM_TIMING          = 17,
 208         ATH9K_PHYERR_OFDM_SIGNAL_PARITY   = 18,
 209         ATH9K_PHYERR_OFDM_RATE_ILLEGAL    = 19,
 210         ATH9K_PHYERR_OFDM_LENGTH_ILLEGAL  = 20,
 211         ATH9K_PHYERR_OFDM_POWER_DROP      = 21,
 212         ATH9K_PHYERR_OFDM_SERVICE         = 22,
 213         ATH9K_PHYERR_OFDM_RESTART         = 23,
 214         ATH9K_PHYERR_FALSE_RADAR_EXT      = 24,
 215
 216         ATH9K_PHYERR_CCK_TIMING           = 25,
 217         ATH9K_PHYERR_CCK_HEADER_CRC       = 26,
 218         ATH9K_PHYERR_CCK_RATE_ILLEGAL     = 27,
 219         ATH9K_PHYERR_CCK_SERVICE          = 30,
 220         ATH9K_PHYERR_CCK_RESTART          = 31,
 221         ATH9K_PHYERR_CCK_LENGTH_ILLEGAL   = 32,
 222         ATH9K_PHYERR_CCK_POWER_DROP       = 33,
 223
 224         ATH9K_PHYERR_HT_CRC_ERROR         = 34,
 225         ATH9K_PHYERR_HT_LENGTH_ILLEGAL    = 35,
 226         ATH9K_PHYERR_HT_RATE_ILLEGAL      = 36,
 227
 228         ATH9K_PHYERR_MAX                  = 37,
 229 };
 230
 231 struct ath_desc {
 232         u32 ds_link;
 233         u32 ds_data;
 234         u32 ds_ctl0;
 235         u32 ds_ctl1;
 236         u32 ds_hw[20];
 237         void *ds_vdata;
 238 } __packed;
 239
 240 #define ATH9K_TXDESC_CLRDMASK           0x0001
 241 #define ATH9K_TXDESC_NOACK              0x0002
 242 #define ATH9K_TXDESC_RTSENA             0x0004
 243 #define ATH9K_TXDESC_CTSENA             0x0008
 244 /* ATH9K_TXDESC_INTREQ forces a tx interrupt to be generated for
 245  * the descriptor its marked on.  We take a tx interrupt to reap
 246  * descriptors when the h/w hits an EOL condition or
 247  * when the descriptor is specifically marked to generate
 248  * an interrupt with this flag. Descriptors should be
 249  * marked periodically to insure timely replenishing of the
 250  * supply needed for sending frames. Defering interrupts
 251  * reduces system load and potentially allows more concurrent
 252  * work to be done but if done to aggressively can cause
 253  * senders to backup. When the hardware queue is left too
 254  * large rate control information may also be too out of
 255  * date. An Alternative for this is TX interrupt mitigation
 256  * but this needs more testing. */
 257 #define ATH9K_TXDESC_INTREQ             0x0010
 258 #define ATH9K_TXDESC_VEOL               0x0020
 259 #define ATH9K_TXDESC_EXT_ONLY           0x0040
 260 #define ATH9K_TXDESC_EXT_AND_CTL        0x0080
 261 #define ATH9K_TXDESC_VMF                0x0100
 262 #define ATH9K_TXDESC_FRAG_IS_ON         0x0200
 263 #define ATH9K_TXDESC_CAB                0x0400
 264
 265 #define ATH9K_RXDESC_INTREQ             0x0020
 266
 267 struct ar5416_desc {
 268         u32 ds_link;
 269         u32 ds_data;
 270         u32 ds_ctl0;
 271         u32 ds_ctl1;
 272         union {
 273                 struct {
 274                         u32 ctl2;
 275                         u32 ctl3;
 276                         u32 ctl4;
 277                         u32 ctl5;
 278                         u32 ctl6;
 279                         u32 ctl7;
 280                         u32 ctl8;
 281                         u32 ctl9;
 282                         u32 ctl10;
 283                         u32 ctl11;
 284                         u32 status0;
 285                         u32 status1;
 286                         u32 status2;
 287                         u32 status3;
 288                         u32 status4;
 289                         u32 status5;
 290                         u32 status6;
 291                         u32 status7;
 292                         u32 status8;
 293                         u32 status9;
 294                 } tx;
 295                 struct {
 296                         u32 status0;
 297                         u32 status1;
 298                         u32 status2;
 299                         u32 status3;
 300                         u32 status4;
 301                         u32 status5;
 302                         u32 status6;
 303                         u32 status7;
 304                         u32 status8;
 305                 } rx;
 306         } u;
 307 } __packed;
 308
 309 #define AR5416DESC(_ds)         ((struct ar5416_desc *)(_ds))
 310 #define AR5416DESC_CONST(_ds)   ((const struct ar5416_desc *)(_ds))
 311
 312 #define ds_ctl2     u.tx.ctl2
 313 #define ds_ctl3     u.tx.ctl3
 314 #define ds_ctl4     u.tx.ctl4
 315 #define ds_ctl5     u.tx.ctl5
 316 #define ds_ctl6     u.tx.ctl6
 317 #define ds_ctl7     u.tx.ctl7
 318 #define ds_ctl8     u.tx.ctl8
 319 #define ds_ctl9     u.tx.ctl9
 320 #define ds_ctl10    u.tx.ctl10
 321 #define ds_ctl11    u.tx.ctl11
 322
 323 #define ds_txstatus0    u.tx.status0
 324 #define ds_txstatus1    u.tx.status1
 325 #define ds_txstatus2    u.tx.status2
 326 #define ds_txstatus3    u.tx.status3
 327 #define ds_txstatus4    u.tx.status4
 328 #define ds_txstatus5    u.tx.status5
 329 #define ds_txstatus6    u.tx.status6
 330 #define ds_txstatus7    u.tx.status7
 331 #define ds_txstatus8    u.tx.status8
 332 #define ds_txstatus9    u.tx.status9
 333
 334 #define ds_rxstatus0    u.rx.status0
 335 #define ds_rxstatus1    u.rx.status1
 336 #define ds_rxstatus2    u.rx.status2
 337 #define ds_rxstatus3    u.rx.status3
 338 #define ds_rxstatus4    u.rx.status4
 339 #define ds_rxstatus5    u.rx.status5
 340 #define ds_rxstatus6    u.rx.status6
 341 #define ds_rxstatus7    u.rx.status7
 342 #define ds_rxstatus8    u.rx.status8
 343
 344 #define AR_FrameLen         0x00000fff
 345 #define AR_VirtMoreFrag     0x00001000
 346 #define AR_TxCtlRsvd00      0x0000e000
 347 #define AR_XmitPower        0x003f0000
 348 #define AR_XmitPower_S      16
 349 #define AR_RTSEnable        0x00400000
 350 #define AR_VEOL             0x00800000
 351 #define AR_ClrDestMask      0x01000000
 352 #define AR_TxCtlRsvd01      0x1e000000
 353 #define AR_TxIntrReq        0x20000000
 354 #define AR_DestIdxValid     0x40000000
 355 #define AR_CTSEnable        0x80000000
 356
 357 #define AR_BufLen           0x00000fff
 358 #define AR_TxMore           0x00001000
 359 #define AR_DestIdx          0x000fe000
 360 #define AR_DestIdx_S        13
 361 #define AR_FrameType        0x00f00000
 362 #define AR_FrameType_S      20
 363 #define AR_NoAck            0x01000000
 364 #define AR_InsertTS         0x02000000
 365 #define AR_CorruptFCS       0x04000000
 366 #define AR_ExtOnly          0x08000000
 367 #define AR_ExtAndCtl        0x10000000
 368 #define AR_MoreAggr         0x20000000
 369 #define AR_IsAggr           0x40000000
 370
 371 #define AR_BurstDur         0x00007fff
 372 #define AR_BurstDur_S       0
 373 #define AR_DurUpdateEna     0x00008000
 374 #define AR_XmitDataTries0   0x000f0000
 375 #define AR_XmitDataTries0_S 16
 376 #define AR_XmitDataTries1   0x00f00000
 377 #define AR_XmitDataTries1_S 20
 378 #define AR_XmitDataTries2   0x0f000000
 379 #define AR_XmitDataTries2_S 24
 380 #define AR_XmitDataTries3   0xf0000000
 381 #define AR_XmitDataTries3_S 28
 382
 383 #define AR_XmitRate0        0x000000ff
 384 #define AR_XmitRate0_S      0
 385 #define AR_XmitRate1        0x0000ff00
 386 #define AR_XmitRate1_S      8
 387 #define AR_XmitRate2        0x00ff0000
 388 #define AR_XmitRate2_S      16
 389 #define AR_XmitRate3        0xff000000
 390 #define AR_XmitRate3_S      24
 391
 392 #define AR_PacketDur0       0x00007fff
 393 #define AR_PacketDur0_S     0
 394 #define AR_RTSCTSQual0      0x00008000
 395 #define AR_PacketDur1       0x7fff0000
 396 #define AR_PacketDur1_S     16
 397 #define AR_RTSCTSQual1      0x80000000
 398
 399 #define AR_PacketDur2       0x00007fff
 400 #define AR_PacketDur2_S     0
 401 #define AR_RTSCTSQual2      0x00008000
 402 #define AR_PacketDur3       0x7fff0000
 403 #define AR_PacketDur3_S     16
 404 #define AR_RTSCTSQual3      0x80000000
 405
 406 #define AR_AggrLen          0x0000ffff
 407 #define AR_AggrLen_S        0
 408 #define AR_TxCtlRsvd60      0x00030000
 409 #define AR_PadDelim         0x03fc0000
 410 #define AR_PadDelim_S       18
 411 #define AR_EncrType         0x0c000000
 412 #define AR_EncrType_S       26
 413 #define AR_TxCtlRsvd61      0xf0000000
 414
 415 #define AR_2040_0           0x00000001
 416 #define AR_GI0              0x00000002
 417 #define AR_ChainSel0        0x0000001c
 418 #define AR_ChainSel0_S      2
 419 #define AR_2040_1           0x00000020
 420 #define AR_GI1              0x00000040
 421 #define AR_ChainSel1        0x00000380
 422 #define AR_ChainSel1_S      7
 423 #define AR_2040_2           0x00000400
 424 #define AR_GI2              0x00000800
 425 #define AR_ChainSel2        0x00007000
 426 #define AR_ChainSel2_S      12
 427 #define AR_2040_3           0x00008000
 428 #define AR_GI3              0x00010000
 429 #define AR_ChainSel3        0x000e0000
 430 #define AR_ChainSel3_S      17
 431 #define AR_RTSCTSRate       0x0ff00000
 432 #define AR_RTSCTSRate_S     20
 433 #define AR_TxCtlRsvd70      0xf0000000
 434
 435 #define AR_TxRSSIAnt00      0x000000ff
 436 #define AR_TxRSSIAnt00_S    0
 437 #define AR_TxRSSIAnt01      0x0000ff00
 438 #define AR_TxRSSIAnt01_S    8
 439 #define AR_TxRSSIAnt02      0x00ff0000
 440 #define AR_TxRSSIAnt02_S    16
 441 #define AR_TxStatusRsvd00   0x3f000000
 442 #define AR_TxBaStatus       0x40000000
 443 #define AR_TxStatusRsvd01   0x80000000
 444
 445 /*
 446  * AR_FrmXmitOK - Frame transmission success flag. If set, the frame was
 447  * transmitted successfully. If clear, no ACK or BA was received to indicate
 448  * successful transmission when we were expecting an ACK or BA.
 449  */
 450 #define AR_FrmXmitOK            0x00000001
 451 #define AR_ExcessiveRetries     0x00000002
 452 #define AR_FIFOUnderrun         0x00000004
 453 #define AR_Filtered             0x00000008
 454 #define AR_RTSFailCnt           0x000000f0
 455 #define AR_RTSFailCnt_S         4
 456 #define AR_DataFailCnt          0x00000f00
 457 #define AR_DataFailCnt_S        8
 458 #define AR_VirtRetryCnt         0x0000f000
 459 #define AR_VirtRetryCnt_S       12
 460 #define AR_TxDelimUnderrun      0x00010000
 461 #define AR_TxDataUnderrun       0x00020000
 462 #define AR_DescCfgErr           0x00040000
 463 #define AR_TxTimerExpired       0x00080000
 464 #define AR_TxStatusRsvd10       0xfff00000
 465
 466 #define AR_SendTimestamp    ds_txstatus2
 467 #define AR_BaBitmapLow      ds_txstatus3
 468 #define AR_BaBitmapHigh     ds_txstatus4
 469
 470 #define AR_TxRSSIAnt10      0x000000ff
 471 #define AR_TxRSSIAnt10_S    0
 472 #define AR_TxRSSIAnt11      0x0000ff00
 473 #define AR_TxRSSIAnt11_S    8
 474 #define AR_TxRSSIAnt12      0x00ff0000
 475 #define AR_TxRSSIAnt12_S    16
 476 #define AR_TxRSSICombined   0xff000000
 477 #define AR_TxRSSICombined_S 24
 478
 479 #define AR_TxEVM0           ds_txstatus5
 480 #define AR_TxEVM1           ds_txstatus6
 481 #define AR_TxEVM2           ds_txstatus7
 482
 483 #define AR_TxDone           0x00000001
 484 #define AR_SeqNum           0x00001ffe
 485 #define AR_SeqNum_S         1
 486 #define AR_TxStatusRsvd80   0x0001e000
 487 #define AR_TxOpExceeded     0x00020000
 488 #define AR_TxStatusRsvd81   0x001c0000
 489 #define AR_FinalTxIdx       0x00600000
 490 #define AR_FinalTxIdx_S     21
 491 #define AR_TxStatusRsvd82   0x01800000
 492 #define AR_PowerMgmt        0x02000000
 493 #define AR_TxStatusRsvd83   0xfc000000
 494
 495 #define AR_RxCTLRsvd00  0xffffffff
 496
 497 #define AR_BufLen       0x00000fff
 498 #define AR_RxCtlRsvd00  0x00001000
 499 #define AR_RxIntrReq    0x00002000
 500 #define AR_RxCtlRsvd01  0xffffc000
 501
 502 #define AR_RxRSSIAnt00      0x000000ff
 503 #define AR_RxRSSIAnt00_S    0
 504 #define AR_RxRSSIAnt01      0x0000ff00
 505 #define AR_RxRSSIAnt01_S    8
 506 #define AR_RxRSSIAnt02      0x00ff0000
 507 #define AR_RxRSSIAnt02_S    16
 508 #define AR_RxRate           0xff000000
 509 #define AR_RxRate_S         24
 510 #define AR_RxStatusRsvd00   0xff000000
 511
 512 #define AR_DataLen          0x00000fff
 513 #define AR_RxMore           0x00001000
 514 #define AR_NumDelim         0x003fc000
 515 #define AR_NumDelim_S       14
 516 #define AR_RxStatusRsvd10   0xff800000
 517
 518 #define AR_RcvTimestamp     ds_rxstatus2
 519
 520 #define AR_GI               0x00000001
 521 #define AR_2040             0x00000002
 522 #define AR_Parallel40       0x00000004
 523 #define AR_Parallel40_S     2
 524 #define AR_RxStatusRsvd30   0x000000f8
 525 #define AR_RxAntenna        0xffffff00
 526 #define AR_RxAntenna_S      8
 527
 528 #define AR_RxRSSIAnt10            0x000000ff
 529 #define AR_RxRSSIAnt10_S          0
 530 #define AR_RxRSSIAnt11            0x0000ff00
 531 #define AR_RxRSSIAnt11_S          8
 532 #define AR_RxRSSIAnt12            0x00ff0000
 533 #define AR_RxRSSIAnt12_S          16
 534 #define AR_RxRSSICombined         0xff000000
 535 #define AR_RxRSSICombined_S       24
 536
 537 #define AR_RxEVM0           ds_rxstatus4
 538 #define AR_RxEVM1           ds_rxstatus5
 539 #define AR_RxEVM2           ds_rxstatus6
 540
 541 #define AR_RxDone           0x00000001
 542 #define AR_RxFrameOK        0x00000002
 543 #define AR_CRCErr           0x00000004
 544 #define AR_DecryptCRCErr    0x00000008
 545 #define AR_PHYErr           0x00000010
 546 #define AR_MichaelErr       0x00000020
 547 #define AR_PreDelimCRCErr   0x00000040
 548 #define AR_RxStatusRsvd70   0x00000080
 549 #define AR_RxKeyIdxValid    0x00000100
 550 #define AR_KeyIdx           0x0000fe00
 551 #define AR_KeyIdx_S         9
 552 #define AR_PHYErrCode       0x0000ff00
 553 #define AR_PHYErrCode_S     8
 554 #define AR_RxMoreAggr       0x00010000
 555 #define AR_RxAggr           0x00020000
 556 #define AR_PostDelimCRCErr  0x00040000
 557 #define AR_RxStatusRsvd71   0x3ff80000
 558 #define AR_DecryptBusyErr   0x40000000
 559 #define AR_KeyMiss          0x80000000
 560
 561 enum ath9k_tx_queue {
 562         ATH9K_TX_QUEUE_INACTIVE = 0,
 563         ATH9K_TX_QUEUE_DATA,
 564         ATH9K_TX_QUEUE_BEACON,
 565         ATH9K_TX_QUEUE_CAB,
 566         ATH9K_TX_QUEUE_UAPSD,
 567         ATH9K_TX_QUEUE_PSPOLL
 568 };
 569
 570 #define ATH9K_NUM_TX_QUEUES 10
 571
 572 enum ath9k_tx_queue_subtype {
 573         ATH9K_WME_AC_BK = 0,
 574         ATH9K_WME_AC_BE,
 575         ATH9K_WME_AC_VI,
 576         ATH9K_WME_AC_VO,
 577         ATH9K_WME_UPSD
 578 };
 579
 580 enum ath9k_tx_queue_flags {
 581         TXQ_FLAG_TXOKINT_ENABLE = 0x0001,
 582         TXQ_FLAG_TXERRINT_ENABLE = 0x0001,
 583         TXQ_FLAG_TXDESCINT_ENABLE = 0x0002,
 584         TXQ_FLAG_TXEOLINT_ENABLE = 0x0004,
 585         TXQ_FLAG_TXURNINT_ENABLE = 0x0008,
 586         TXQ_FLAG_BACKOFF_DISABLE = 0x0010,
 587         TXQ_FLAG_COMPRESSION_ENABLE = 0x0020,
 588         TXQ_FLAG_RDYTIME_EXP_POLICY_ENABLE = 0x0040,
 589         TXQ_FLAG_FRAG_BURST_BACKOFF_ENABLE = 0x0080,
 590 };
 591
 592 #define ATH9K_TXQ_USEDEFAULT ((u32) -1)
 593 #define ATH9K_TXQ_USE_LOCKOUT_BKOFF_DIS 0x00000001
 594
 595 #define ATH9K_DECOMP_MASK_SIZE     128
 596 #define ATH9K_READY_TIME_LO_BOUND  50
 597 #define ATH9K_READY_TIME_HI_BOUND  96
 598
 599 enum ath9k_pkt_type {
 600         ATH9K_PKT_TYPE_NORMAL = 0,
 601         ATH9K_PKT_TYPE_ATIM,
 602         ATH9K_PKT_TYPE_PSPOLL,
 603         ATH9K_PKT_TYPE_BEACON,
 604         ATH9K_PKT_TYPE_PROBE_RESP,
 605         ATH9K_PKT_TYPE_CHIRP,
 606         ATH9K_PKT_TYPE_GRP_POLL,
 607 };
 608
 609 struct ath9k_tx_queue_info {
 610         u32 tqi_ver;
 611         enum ath9k_tx_queue tqi_type;
 612         enum ath9k_tx_queue_subtype tqi_subtype;
 613         enum ath9k_tx_queue_flags tqi_qflags;
 614         u32 tqi_priority;
 615         u32 tqi_aifs;
 616         u32 tqi_cwmin;
 617         u32 tqi_cwmax;
 618         u16 tqi_shretry;
 619         u16 tqi_lgretry;
 620         u32 tqi_cbrPeriod;
 621         u32 tqi_cbrOverflowLimit;
 622         u32 tqi_burstTime;
 623         u32 tqi_readyTime;
 624         u32 tqi_physCompBuf;
 625         u32 tqi_intFlags;
 626 };
 627
 628 enum ath9k_rx_filter {
 629         ATH9K_RX_FILTER_UCAST = 0x00000001,
 630         ATH9K_RX_FILTER_MCAST = 0x00000002,
 631         ATH9K_RX_FILTER_BCAST = 0x00000004,
 632         ATH9K_RX_FILTER_CONTROL = 0x00000008,
 633         ATH9K_RX_FILTER_BEACON = 0x00000010,
 634         ATH9K_RX_FILTER_PROM = 0x00000020,
 635         ATH9K_RX_FILTER_PROBEREQ = 0x00000080,
 636         ATH9K_RX_FILTER_PHYERR = 0x00000100,
 637         ATH9K_RX_FILTER_MYBEACON = 0x00000200,
 638         ATH9K_RX_FILTER_COMP_BAR = 0x00000400,
 639         ATH9K_RX_FILTER_PSPOLL = 0x00004000,
 640         ATH9K_RX_FILTER_PHYRADAR = 0x00002000,
 641         ATH9K_RX_FILTER_MCAST_BCAST_ALL = 0x00008000,
 642 };
 643
 644 #define ATH9K_RATESERIES_RTS_CTS  0x0001
 645 #define ATH9K_RATESERIES_2040     0x0002
 646 #define ATH9K_RATESERIES_HALFGI   0x0004
 647
 648 struct ath9k_11n_rate_series {
 649         u32 Tries;
 650         u32 Rate;
 651         u32 PktDuration;
 652         u32 ChSel;
 653         u32 RateFlags;
 654 };
 655
 656 struct ath9k_keyval {
 657         u8 kv_type;
 658         u8 kv_pad;
 659         u16 kv_len;
 660         u8 kv_val[16]; /* TK */
 661         u8 kv_mic[8]; /* Michael MIC key */
 662         u8 kv_txmic[8]; /* Michael MIC TX key (used only if the hardware
 663                          * supports both MIC keys in the same key cache entry;
 664                          * in that case, kv_mic is the RX key) */
 665 };
 666
 667 enum ath9k_key_type {
 668         ATH9K_KEY_TYPE_CLEAR,
 669         ATH9K_KEY_TYPE_WEP,
 670         ATH9K_KEY_TYPE_AES,
 671         ATH9K_KEY_TYPE_TKIP,
 672 };
 673
 674 enum ath9k_cipher {
 675         ATH9K_CIPHER_WEP = 0,
 676         ATH9K_CIPHER_AES_OCB = 1,
 677         ATH9K_CIPHER_AES_CCM = 2,
 678         ATH9K_CIPHER_CKIP = 3,
 679         ATH9K_CIPHER_TKIP = 4,
 680         ATH9K_CIPHER_CLR = 5,
 681         ATH9K_CIPHER_MIC = 127
 682 };
 683
 684 struct ath_hw;
 685 struct ath9k_channel;
 686
 687 u32 ath9k_hw_gettxbuf(struct ath_hw *ah, u32 q);
 688 void ath9k_hw_puttxbuf(struct ath_hw *ah, u32 q, u32 txdp);
 689 void ath9k_hw_txstart(struct ath_hw *ah, u32 q);
 690 void ath9k_hw_cleartxdesc(struct ath_hw *ah, void *ds);
 691 u32 ath9k_hw_numtxpending(struct ath_hw *ah, u32 q);
 692 bool ath9k_hw_updatetxtriglevel(struct ath_hw *ah, bool bIncTrigLevel);
 693 bool ath9k_hw_stoptxdma(struct ath_hw *ah, u32 q);
 694 void ath9k_hw_gettxintrtxqs(struct ath_hw *ah, u32 *txqs);
 695 bool ath9k_hw_set_txq_props(struct ath_hw *ah, int q,
 696                             const struct ath9k_tx_queue_info *qinfo);
 697 bool ath9k_hw_get_txq_props(struct ath_hw *ah, int q,
 698                             struct ath9k_tx_queue_info *qinfo);
 699 int ath9k_hw_setuptxqueue(struct ath_hw *ah, enum ath9k_tx_queue type,
 700                           const struct ath9k_tx_queue_info *qinfo);
 701 bool ath9k_hw_releasetxqueue(struct ath_hw *ah, u32 q);
 702 bool ath9k_hw_resettxqueue(struct ath_hw *ah, u32 q);
 703 int ath9k_hw_rxprocdesc(struct ath_hw *ah, struct ath_desc *ds,
 704                         struct ath_rx_status *rs, u64 tsf);
 705 void ath9k_hw_setuprxdesc(struct ath_hw *ah, struct ath_desc *ds,
 706                           u32 size, u32 flags);
 707 bool ath9k_hw_setrxabort(struct ath_hw *ah, bool set);
 708 void ath9k_hw_putrxbuf(struct ath_hw *ah, u32 rxdp);
 709 void ath9k_hw_startpcureceive(struct ath_hw *ah);
 710 void ath9k_hw_stoppcurecv(struct ath_hw *ah);
 711 bool ath9k_hw_stopdmarecv(struct ath_hw *ah);
 712 int ath9k_hw_beaconq_setup(struct ath_hw *ah);
 713
 714 /* Interrupt Handling */
 715 bool ath9k_hw_intrpend(struct ath_hw *ah);
 716 enum ath9k_int ath9k_hw_set_interrupts(struct ath_hw *ah,
 717                                        enum ath9k_int ints);
 718
 719 void ar9002_hw_attach_mac_ops(struct ath_hw *ah);
 720
 721 #endif /* MAC_H */