sys/dev/ath/ath_hal/ar5212/ar5212desc.h

   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  * $FreeBSD$
  18  */
  19 #ifndef _ATH_AR5212_DESC_H_
  20 #define _ATH_AR5212_DESC_H_
  21
  22 /*
  23  * Hardware-specific descriptor structures.
  24  */
  25
  26 /*
  27  * AR5212-specific tx/rx descriptor definition.
  28  */
  29 struct ar5212_desc {
  30         uint32_t        ds_link;        /* link pointer */
  31         uint32_t        ds_data;        /* data buffer pointer */
  32         uint32_t        ds_ctl0;        /* DMA control 0 */
  33         uint32_t        ds_ctl1;        /* DMA control 1 */
  34         union {
  35                 struct {                /* xmit format */
  36                         uint32_t        ctl2;   /* DMA control 2 */
  37                         uint32_t        ctl3;   /* DMA control 3 */
  38                         uint32_t        status0;/* DMA status 0 */
  39                         uint32_t        status1;/* DMA status 1 */
  40                 } tx;
  41                 struct {                /* recv format */
  42                         uint32_t        status0;/* DMA status 0 */
  43                         uint32_t        status1;/* DMA status 1 */
  44                 } rx;
  45         } u;
  46 } __packed;
  47 #define AR5212DESC(_ds) ((struct ar5212_desc *)(_ds))
  48 #define AR5212DESC_CONST(_ds)   ((const struct ar5212_desc *)(_ds))
  49
  50 #define ds_ctl2         u.tx.ctl2
  51 #define ds_ctl3         u.tx.ctl3
  52 #define ds_txstatus0    u.tx.status0
  53 #define ds_txstatus1    u.tx.status1
  54 #define ds_rxstatus0    u.rx.status0
  55 #define ds_rxstatus1    u.rx.status1
  56
  57 /* TX ds_ctl0 */
  58 #define AR_FrameLen             0x00000fff      /* frame length */
  59 /* bits 12-15 are reserved */
  60 #define AR_XmitPower            0x003f0000      /* transmit power control */
  61 #define AR_XmitPower_S          16
  62 #define AR_RTSCTSEnable         0x00400000      /* RTS/CTS protocol enable */
  63 #define AR_VEOL                 0x00800000      /* virtual end-of-list */
  64 #define AR_ClearDestMask        0x01000000      /* Clear destination mask bit */
  65 #define AR_AntModeXmit          0x1e000000      /* TX antenna seslection */
  66 #define AR_AntModeXmit_S        25
  67 #define AR_TxInterReq           0x20000000      /* TX interrupt request */
  68 #define AR_DestIdxValid         0x40000000      /* destination index valid */
  69 #define AR_CTSEnable            0x80000000      /* precede frame with CTS */
  70
  71 /* TX ds_ctl1 */
  72 #define AR_BufLen               0x00000fff      /* data buffer length */
  73 #define AR_More                 0x00001000      /* more desc in this frame */
  74 #define AR_DestIdx              0x000fe000      /* destination table index */
  75 #define AR_DestIdx_S            13
  76 #define AR_FrmType              0x00f00000      /* frame type indication */
  77 #define AR_FrmType_S            20
  78 #define AR_NoAck                0x01000000      /* No ACK flag */
  79 #define AR_CompProc             0x06000000      /* compression processing */
  80 #define AR_CompProc_S           25
  81 #define AR_CompIVLen            0x18000000      /* length of frame IV */
  82 #define AR_CompIVLen_S          27
  83 #define AR_CompICVLen           0x60000000      /* length of frame ICV */
  84 #define AR_CompICVLen_S         29
  85 /* bit 31 is reserved */
  86
  87 /* TX ds_ctl2 */
  88 #define AR_RTSCTSDuration       0x00007fff      /* RTS/CTS duration */
  89 #define AR_RTSCTSDuration_S     0
  90 #define AR_DurUpdateEna         0x00008000      /* frame duration update ctl */
  91 #define AR_XmitDataTries0       0x000f0000      /* series 0 max attempts */
  92 #define AR_XmitDataTries0_S     16
  93 #define AR_XmitDataTries1       0x00f00000      /* series 1 max attempts */
  94 #define AR_XmitDataTries1_S     20
  95 #define AR_XmitDataTries2       0x0f000000      /* series 2 max attempts */
  96 #define AR_XmitDataTries2_S     24
  97 #define AR_XmitDataTries3       0xf0000000      /* series 3 max attempts */
  98 #define AR_XmitDataTries3_S     28
  99
 100 /* TX ds_ctl3 */
 101 #define AR_XmitRate0            0x0000001f      /* series 0 tx rate */
 102 #define AR_XmitRate0_S          0
 103 #define AR_XmitRate1            0x000003e0      /* series 1 tx rate */
 104 #define AR_XmitRate1_S          5
 105 #define AR_XmitRate2            0x00007c00      /* series 2 tx rate */
 106 #define AR_XmitRate2_S          10
 107 #define AR_XmitRate3            0x000f8000      /* series 3 tx rate */
 108 #define AR_XmitRate3_S          15
 109 #define AR_RTSCTSRate           0x01f00000      /* RTS or CTS rate */
 110 #define AR_RTSCTSRate_S         20
 111 /* bits 25-31 are reserved */
 112
 113 /* RX ds_ctl1 */
 114 /*      AR_BufLen               0x00000fff         data buffer length */
 115 /* bit 12 is reserved */
 116 #define AR_RxInterReq           0x00002000      /* RX interrupt request */
 117 /* bits 14-31 are reserved */
 118
 119 /* TX ds_txstatus0 */
 120 #define AR_FrmXmitOK            0x00000001      /* TX success */
 121 #define AR_ExcessiveRetries     0x00000002      /* excessive retries */
 122 #define AR_FIFOUnderrun         0x00000004      /* TX FIFO underrun */
 123 #define AR_Filtered             0x00000008      /* TX filter indication */
 124 #define AR_RTSFailCnt           0x000000f0      /* RTS failure count */
 125 #define AR_RTSFailCnt_S         4
 126 #define AR_DataFailCnt          0x00000f00      /* Data failure count */
 127 #define AR_DataFailCnt_S        8
 128 #define AR_VirtCollCnt          0x0000f000      /* virtual collision count */
 129 #define AR_VirtCollCnt_S        12
 130 #define AR_SendTimestamp        0xffff0000      /* TX timestamp */
 131 #define AR_SendTimestamp_S      16
 132
 133 /* RX ds_rxstatus0 */
 134 #define AR_DataLen              0x00000fff      /* RX data length */
 135 /*      AR_More                 0x00001000         more desc in this frame */
 136 #define AR_DecompCRCErr         0x00002000      /* decompression CRC error */
 137 /* bit 14 is reserved */
 138 #define AR_RcvRate              0x000f8000      /* reception rate */
 139 #define AR_RcvRate_S            15
 140 #define AR_RcvSigStrength       0x0ff00000      /* receive signal strength */
 141 #define AR_RcvSigStrength_S     20
 142 #define AR_RcvAntenna           0xf0000000      /* receive antenaa */
 143 #define AR_RcvAntenna_S         28
 144
 145 /* TX ds_txstatus1 */
 146 #define AR_Done                 0x00000001      /* descripter complete */
 147 #define AR_SeqNum               0x00001ffe      /* TX sequence number */
 148 #define AR_SeqNum_S             1
 149 #define AR_AckSigStrength       0x001fe000      /* strength of ACK */
 150 #define AR_AckSigStrength_S     13
 151 #define AR_FinalTSIndex         0x00600000      /* final TX attempt series ix */
 152 #define AR_FinalTSIndex_S       21
 153 #define AR_CompSuccess          0x00800000      /* compression status */
 154 #define AR_XmitAtenna           0x01000000      /* transmit antenna */
 155 /* bits 25-31 are reserved */
 156
 157 /* RX ds_rxstatus1 */
 158 /*      AR_Done                 0x00000001         descripter complete */
 159 #define AR_FrmRcvOK             0x00000002      /* frame reception success */
 160 #define AR_CRCErr               0x00000004      /* CRC error */
 161 #define AR_DecryptCRCErr        0x00000008      /* Decryption CRC fiailure */
 162 #define AR_PHYErr               0x00000010      /* PHY error */
 163 #define AR_MichaelErr           0x00000020      /* Michae MIC decrypt error */
 164 /* bits 6-7 are reserved */
 165 #define AR_KeyIdxValid          0x00000100      /* decryption key index valid */
 166 #define AR_KeyIdx               0x0000fe00      /* Decryption key index */
 167 #define AR_KeyIdx_S             9
 168 #define AR_RcvTimestamp         0x7fff0000      /* timestamp */
 169 #define AR_RcvTimestamp_S       16
 170 #define AR_KeyCacheMiss         0x80000000      /* key cache miss indication */
 171
 172 /* NB: phy error code overlays key index and valid fields */
 173 #define AR_PHYErrCode           0x0000ff00      /* PHY error code */
 174 #define AR_PHYErrCode_S         8
 175
 176 #endif /* _ATH_AR5212_DESC_H_ */