Merge git://git.kernel.org/pub/scm/linux/kernel/git/mason/btrfs-unstable
[linux-2.6] / drivers / staging / rt3070 / rt2870.h
1 /*
2  *************************************************************************
3  * Ralink Tech Inc.
4  * 5F., No.36, Taiyuan St., Jhubei City,
5  * Hsinchu County 302,
6  * Taiwan, R.O.C.
7  *
8  * (c) Copyright 2002-2007, Ralink Technology, Inc.
9  *
10  * This program is free software; you can redistribute it and/or modify  *
11  * it under the terms of the GNU General Public License as published by  *
12  * the Free Software Foundation; either version 2 of the License, or     *
13  * (at your option) any later version.                                   *
14  *                                                                       *
15  * This program is distributed in the hope that it will be useful,       *
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
18  * GNU General Public License for more details.                          *
19  *                                                                       *
20  * You should have received a copy of the GNU General Public License     *
21  * along with this program; if not, write to the                         *
22  * Free Software Foundation, Inc.,                                       *
23  * 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
24  *                                                                       *
25  *************************************************************************
26  */
27
28 #ifndef __RT2870_H__
29 #define __RT2870_H__
30
31 //usb header files
32 #include <linux/usb.h>
33
34 /* rtmp_def.h */
35 //
36 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
37 #define BULKAGGRE_ZISE          100
38 #define RT28XX_DRVDATA_SET(_a)                                             usb_set_intfdata(_a, pAd);
39 #define RT28XX_PUT_DEVICE                                                  usb_put_dev
40 #define RTUSB_ALLOC_URB(iso)                                               usb_alloc_urb(iso, GFP_ATOMIC)
41 #define RTUSB_SUBMIT_URB(pUrb)                                             usb_submit_urb(pUrb, GFP_ATOMIC)
42 #define RTUSB_URB_ALLOC_BUFFER(pUsb_Dev, BufSize, pDma_addr)               usb_buffer_alloc(pUsb_Dev, BufSize, GFP_ATOMIC, pDma_addr)
43 #define RTUSB_URB_FREE_BUFFER(pUsb_Dev, BufSize, pTransferBuf, Dma_addr)   usb_buffer_free(pUsb_Dev, BufSize, pTransferBuf, Dma_addr)
44 #else
45 #define BULKAGGRE_ZISE          60
46 #define RT28XX_DRVDATA_SET(_a)
47 #define RT28XX_PUT_DEVICE(dev_p)
48 #define RTUSB_ALLOC_URB(iso)                                               usb_alloc_urb(iso)
49 #define RTUSB_SUBMIT_URB(pUrb)                                             usb_submit_urb(pUrb)
50 #define RTUSB_URB_ALLOC_BUFFER(pUsb_Dev, BufSize, pDma_addr)               kmalloc(BufSize, GFP_ATOMIC)
51 #define RTUSB_URB_FREE_BUFFER(pUsb_Dev, BufSize, pTransferBuf, Dma_addr)   kfree(pTransferBuf)
52 #endif
53
54 #define RXBULKAGGRE_ZISE        12
55 #define MAX_TXBULK_LIMIT        (LOCAL_TXBUF_SIZE*(BULKAGGRE_ZISE-1))
56 #define MAX_TXBULK_SIZE         (LOCAL_TXBUF_SIZE*BULKAGGRE_ZISE)
57 #define MAX_RXBULK_SIZE         (LOCAL_TXBUF_SIZE*RXBULKAGGRE_ZISE)
58 #define MAX_MLME_HANDLER_MEMORY 20
59 #define BUFFER_SIZE                             2400    //2048
60 #define TX_RING                                 0xa
61 #define PRIO_RING                               0xc
62
63
64 // Flags for Bulkflags control for bulk out data
65 //
66 #define fRTUSB_BULK_OUT_DATA_NULL                               0x00000001
67 #define fRTUSB_BULK_OUT_RTS                                             0x00000002
68 #define fRTUSB_BULK_OUT_MLME                                    0x00000004
69
70 #define fRTUSB_BULK_OUT_DATA_NORMAL                             0x00010000
71 #define fRTUSB_BULK_OUT_DATA_NORMAL_2                   0x00020000
72 #define fRTUSB_BULK_OUT_DATA_NORMAL_3                   0x00040000
73 #define fRTUSB_BULK_OUT_DATA_NORMAL_4                   0x00080000
74 #define fRTUSB_BULK_OUT_DATA_NORMAL_5                   0x00100000
75
76 #define fRTUSB_BULK_OUT_PSPOLL                                  0x00000020
77 #define fRTUSB_BULK_OUT_DATA_FRAG                               0x00000040
78 #define fRTUSB_BULK_OUT_DATA_FRAG_2                             0x00000080
79 #define fRTUSB_BULK_OUT_DATA_FRAG_3                             0x00000100
80 #define fRTUSB_BULK_OUT_DATA_FRAG_4                             0x00000200
81
82 #ifdef RALINK_ATE
83 #define fRTUSB_BULK_OUT_DATA_ATE                                0x00100000
84 #endif // RALINK_ATE //
85
86 #define RT2870_USB_DEVICES      \
87 {       \
88         {USB_DEVICE(0x148F,0x2770)}, /* Ralink */               \
89         {USB_DEVICE(0x148F,0x2870)}, /* Ralink */               \
90         {USB_DEVICE(0x148F,0x3070)}, /* Ralink 3070 */  \
91         {USB_DEVICE(0x148F,0x3071)}, /* Ralink 3071 */  \
92         {USB_DEVICE(0x148F,0x3072)}, /* Ralink 3072 */  \
93         {USB_DEVICE(0x0B05,0x1731)}, /* Asus */                 \
94         {USB_DEVICE(0x0B05,0x1732)}, /* Asus */                 \
95         {USB_DEVICE(0x0B05,0x1742)}, /* Asus */                 \
96         {USB_DEVICE(0x0DF6,0x0017)}, /* Sitecom */              \
97         {USB_DEVICE(0x0DF6,0x002B)}, /* Sitecom */              \
98         {USB_DEVICE(0x0DF6,0x002C)}, /* Sitecom */              \
99         {USB_DEVICE(0x0DF6,0x003E)}, /* Sitecom 3070 */ \
100         {USB_DEVICE(0x0DF6,0x002D)}, /* Sitecom */              \
101         {USB_DEVICE(0x0DF6,0x0039)}, /* Sitecom 2770 */ \
102         {USB_DEVICE(0x14B2,0x3C06)}, /* Conceptronic */ \
103         {USB_DEVICE(0x14B2,0x3C28)}, /* Conceptronic */ \
104         {USB_DEVICE(0x2019,0xED06)}, /* Planex Communications, Inc. */          \
105         {USB_DEVICE(0x2019,0xAB25)}, /* Planex Communications, Inc. RT3070 */           \
106         {USB_DEVICE(0x07D1,0x3C09)}, /* D-Link */               \
107         {USB_DEVICE(0x07D1,0x3C11)}, /* D-Link */               \
108         {USB_DEVICE(0x2001,0x3C09)}, /* D-Link */               \
109         {USB_DEVICE(0x2001,0x3C0A)}, /* D-Link 3072*/   \
110         {USB_DEVICE(0x14B2,0x3C07)}, /* AL */                   \
111         {USB_DEVICE(0x14B2,0x3C12)}, /* AL 3070 */              \
112         {USB_DEVICE(0x050D,0x8053)}, /* Belkin */               \
113         {USB_DEVICE(0x14B2,0x3C23)}, /* Airlink */              \
114         {USB_DEVICE(0x14B2,0x3C27)}, /* Airlink */              \
115         {USB_DEVICE(0x07AA,0x002F)}, /* Corega */               \
116         {USB_DEVICE(0x07AA,0x003C)}, /* Corega */               \
117         {USB_DEVICE(0x07AA,0x003F)}, /* Corega */               \
118         {USB_DEVICE(0x18C5,0x0012)}, /* Corega 3070 */  \
119         {USB_DEVICE(0x1044,0x800B)}, /* Gigabyte */             \
120         {USB_DEVICE(0x1044,0x800D)}, /* Gigabyte GN-WB32L 3070 */               \
121         {USB_DEVICE(0x15A9,0x0006)}, /* Sparklan */             \
122         {USB_DEVICE(0x083A,0xB522)}, /* SMC */                  \
123         {USB_DEVICE(0x083A,0xA618)}, /* SMC */                  \
124         {USB_DEVICE(0x083A,0x8522)}, /* Arcadyan */             \
125         {USB_DEVICE(0x083A,0x7512)}, /* Arcadyan 2770 */                \
126         {USB_DEVICE(0x083A,0x7522)}, /* Arcadyan */             \
127         {USB_DEVICE(0x083A,0x7511)}, /* Arcadyan 3070 */ \
128         {USB_DEVICE(0x0CDE,0x0022)}, /* ZCOM */                 \
129         {USB_DEVICE(0x0586,0x3416)}, /* Zyxel */                \
130         {USB_DEVICE(0x0CDE,0x0025)}, /* Zyxel */                \
131         {USB_DEVICE(0x1740,0x9701)}, /* EnGenius */             \
132         {USB_DEVICE(0x1740,0x9702)}, /* EnGenius */             \
133         {USB_DEVICE(0x1740,0x9703)}, /* EnGenius 3070 */                \
134         {USB_DEVICE(0x0471,0x200f)}, /* Philips */              \
135         {USB_DEVICE(0x14B2,0x3C25)}, /* Draytek */              \
136         {USB_DEVICE(0x13D3,0x3247)}, /* AzureWave */    \
137         {USB_DEVICE(0x13D3,0x3273)}, /* AzureWave 3070*/        \
138         {USB_DEVICE(0x083A,0x6618)}, /* Accton */               \
139         {USB_DEVICE(0x15c5,0x0008)}, /* Amit */                 \
140         {USB_DEVICE(0x0E66,0x0001)}, /* Hawking */              \
141         {USB_DEVICE(0x0E66,0x0003)}, /* Hawking */              \
142         {USB_DEVICE(0x129B,0x1828)}, /* Siemens */              \
143         {USB_DEVICE(0x157E,0x300E)}, /* U-Media */              \
144         {USB_DEVICE(0x050d,0x805c)},                                    \
145         {USB_DEVICE(0x1482,0x3C09)}, /* Abocom*/                \
146         {USB_DEVICE(0x14B2,0x3C09)}, /* Alpha */                \
147         {USB_DEVICE(0x04E8,0x2018)}, /* samsung */      \
148         {USB_DEVICE(0x07B8,0x3070)}, /* AboCom 3070 */  \
149         {USB_DEVICE(0x07B8,0x3071)}, /* AboCom 3071 */  \
150         {USB_DEVICE(0x07B8,0x3072)}, /* Abocom 3072 */  \
151         {USB_DEVICE(0x7392,0x7711)}, /* Edimax 3070 */  \
152         {USB_DEVICE(0x5A57,0x0280)}, /* Zinwell */              \
153         {USB_DEVICE(0x5A57,0x0282)}, /* Zinwell */              \
154         {USB_DEVICE(0x1A32,0x0304)}, /* Quanta 3070 */          \
155         {USB_DEVICE(0x0789,0x0162)}, /* Logitec 2870 */         \
156         {USB_DEVICE(0x0789,0x0163)}, /* Logitec 2870 */         \
157         {USB_DEVICE(0x0789,0x0164)}, /* Logitec 2870 */         \
158         {USB_DEVICE(0x1EDA,0x2310)}, /* AirTies 3070 */         \
159         { }/* Terminating entry */                      \
160 }
161
162 #define FREE_HTTX_RING(_p, _b, _t)                      \
163 {                                                                               \
164         if ((_t)->ENextBulkOutPosition == (_t)->CurWritePosition)                               \
165         {                                                                                                                                       \
166                 (_t)->bRingEmpty = TRUE;                        \
167         }                                                                                                                                       \
168         /*NdisInterlockedDecrement(&(_p)->TxCount); */\
169 }
170
171 //
172 // RXINFO appends at the end of each rx packet.
173 //
174 #ifdef RT_BIG_ENDIAN
175 typedef struct  PACKED _RXINFO_STRUC {
176         UINT32          PlcpSignal:12;
177         UINT32          LastAMSDU:1;
178         UINT32          CipherAlg:1;
179         UINT32          PlcpRssil:1;
180         UINT32          Decrypted:1;
181         UINT32          AMPDU:1;                // To be moved
182         UINT32          L2PAD:1;
183         UINT32          RSSI:1;
184         UINT32          HTC:1;
185         UINT32          AMSDU:1;                // rx with 802.3 header, not 802.11 header.
186         UINT32          CipherErr:2;        // 0: decryption okay, 1:ICV error, 2:MIC error, 3:KEY not valid
187         UINT32          Crc:1;              // 1: CRC error
188         UINT32          MyBss:1;        // 1: this frame belongs to the same BSSID
189         UINT32          Bcast:1;            // 1: this is a broadcast frame
190         UINT32          Mcast:1;            // 1: this is a multicast frame
191         UINT32          U2M:1;              // 1: this RX frame is unicast to me
192         UINT32          FRAG:1;
193         UINT32          NULLDATA:1;
194         UINT32          DATA:1;
195         UINT32          BA:1;
196 }       RXINFO_STRUC, *PRXINFO_STRUC, RT28XX_RXD_STRUC, *PRT28XX_RXD_STRUC;
197 #else
198 typedef struct  PACKED _RXINFO_STRUC {
199         UINT32          BA:1;
200         UINT32          DATA:1;
201         UINT32          NULLDATA:1;
202         UINT32          FRAG:1;
203         UINT32          U2M:1;              // 1: this RX frame is unicast to me
204         UINT32          Mcast:1;            // 1: this is a multicast frame
205         UINT32          Bcast:1;            // 1: this is a broadcast frame
206         UINT32          MyBss:1;        // 1: this frame belongs to the same BSSID
207         UINT32          Crc:1;              // 1: CRC error
208         UINT32          CipherErr:2;        // 0: decryption okay, 1:ICV error, 2:MIC error, 3:KEY not valid
209         UINT32          AMSDU:1;                // rx with 802.3 header, not 802.11 header.
210         UINT32          HTC:1;
211         UINT32          RSSI:1;
212         UINT32          L2PAD:1;
213         UINT32          AMPDU:1;                // To be moved
214         UINT32          Decrypted:1;
215         UINT32          PlcpRssil:1;
216         UINT32          CipherAlg:1;
217         UINT32          LastAMSDU:1;
218         UINT32          PlcpSignal:12;
219 }       RXINFO_STRUC, *PRXINFO_STRUC, RT28XX_RXD_STRUC, *PRT28XX_RXD_STRUC;
220 #endif
221
222
223 //
224 // TXINFO
225 //
226 #ifdef RT_BIG_ENDIAN
227 typedef struct  _TXINFO_STRUC {
228         // Word 0
229         UINT32          USBDMATxburst:1;//used ONLY in USB bulk Aggre. Force USB DMA transmit frame from current selected endpoint
230         UINT32          USBDMANextVLD:1;        //used ONLY in USB bulk Aggregation, NextValid
231         UINT32          rsv2:2;  // Software use.
232         UINT32          SwUseLastRound:1; // Software use.
233         UINT32          QSEL:2; // select on-chip FIFO ID for 2nd-stage output scheduler.0:MGMT, 1:HCCA 2:EDCA
234         UINT32          WIV:1;  // Wireless Info Valid. 1 if Driver already fill WI,  o if DMA needs to copy WI to correctposition
235         UINT32          rsv:8;
236         UINT32          USBDMATxPktLen:16;      //used ONLY in USB bulk Aggregation,  Total byte counts of all sub-frame.
237 }       TXINFO_STRUC, *PTXINFO_STRUC;
238 #else
239 typedef struct  _TXINFO_STRUC {
240         // Word 0
241         UINT32          USBDMATxPktLen:16;      //used ONLY in USB bulk Aggregation,  Total byte counts of all sub-frame.
242         UINT32          rsv:8;
243         UINT32          WIV:1;  // Wireless Info Valid. 1 if Driver already fill WI,  o if DMA needs to copy WI to correctposition
244         UINT32          QSEL:2; // select on-chip FIFO ID for 2nd-stage output scheduler.0:MGMT, 1:HCCA 2:EDCA
245         UINT32          SwUseLastRound:1; // Software use.
246         UINT32          rsv2:2;  // Software use.
247         UINT32          USBDMANextVLD:1;        //used ONLY in USB bulk Aggregation, NextValid
248         UINT32          USBDMATxburst:1;//used ONLY in USB bulk Aggre. Force USB DMA transmit frame from current selected endpoint
249 }       TXINFO_STRUC, *PTXINFO_STRUC;
250 #endif
251
252 #define TXINFO_SIZE                             4
253 #define RXINFO_SIZE                             4
254 #define TXPADDING_SIZE                  11
255
256 //
257 // Management ring buffer format
258 //
259 typedef struct  _MGMT_STRUC     {
260         BOOLEAN         Valid;
261         PUCHAR          pBuffer;
262         ULONG           Length;
263 }       MGMT_STRUC, *PMGMT_STRUC;
264
265
266 /* ----------------- EEPROM Related MACRO ----------------- */
267 #ifdef RT30xx
268 #define RT28xx_EEPROM_READ16(pAd, offset, var)                                  \
269         do {                                                                                                            \
270                 RTUSBReadEEPROM(pAd, offset, (PUCHAR)&(var), 2);                \
271                 if(!pAd->bUseEfuse)                                                                             \
272                         var = le2cpu16(var);                                                            \
273         }while(0)
274
275 #define RT28xx_EEPROM_WRITE16(pAd, offset, var)                                 \
276         do{                                                                                                                     \
277                 USHORT _tmpVar=var;                                                                             \
278                 if(!pAd->bUseEfuse)                                                                     \
279                 _tmpVar = cpu2le16(var);                                                                \
280                 RTUSBWriteEEPROM(pAd, offset, (PUCHAR)&(_tmpVar), 2);   \
281         }while(0)
282 #endif // RT30xx //
283 #ifndef RT30xx
284 #define RT28xx_EEPROM_READ16(pAd, offset, var)                                  \
285         do {                                                                                                            \
286                 RTUSBReadEEPROM(pAd, offset, (PUCHAR)&(var), 2);                \
287                         var = le2cpu16(var);                                                            \
288         }while(0)
289
290 #define RT28xx_EEPROM_WRITE16(pAd, offset, var)                                 \
291         do{                                                                                                                     \
292                 USHORT _tmpVar=var;                                                                             \
293                 _tmpVar = cpu2le16(var);                                                                \
294                 RTUSBWriteEEPROM(pAd, offset, (PUCHAR)&(_tmpVar), 2);   \
295         }while(0)
296 #endif // RT30xx //
297
298 /* ----------------- TASK/THREAD Related MACRO ----------------- */
299 #define RT28XX_TASK_THREAD_INIT(pAd, Status)            \
300         Status = CreateThreads(net_dev);
301
302
303 /* ----------------- Frimware Related MACRO ----------------- */
304 #define RT28XX_WRITE_FIRMWARE(_pAd, _pFwImage, _FwLen)          \
305         RTUSBFirmwareWrite(_pAd, _pFwImage, _FwLen)
306
307 /* ----------------- TX Related MACRO ----------------- */
308 #define RT28XX_START_DEQUEUE(pAd, QueIdx, irqFlags)                             \
309                         {                                                                                                       \
310                                 RTMP_IRQ_LOCK(&pAd->DeQueueLock[QueIdx], irqFlags);             \
311                                 if (pAd->DeQueueRunning[QueIdx])                                                \
312                                 {                                                                                                               \
313                                         RTMP_IRQ_UNLOCK(&pAd->DeQueueLock[QueIdx], irqFlags);\
314                                         printk("DeQueueRunning[%d]= TRUE!\n", QueIdx);          \
315                                         continue;                                                                                       \
316                                 }                                                                                                               \
317                                 else                                                                                                    \
318                                 {                                                                                                               \
319                                         pAd->DeQueueRunning[QueIdx] = TRUE;                                     \
320                                         RTMP_IRQ_UNLOCK(&pAd->DeQueueLock[QueIdx], irqFlags);\
321                                 }                                                                                                               \
322                         }
323 #define RT28XX_STOP_DEQUEUE(pAd, QueIdx, irqFlags)                                              \
324                         do{                                                                                                                     \
325                                 RTMP_IRQ_LOCK(&pAd->DeQueueLock[QueIdx], irqFlags);             \
326                                 pAd->DeQueueRunning[QueIdx] = FALSE;                                    \
327                                 RTMP_IRQ_UNLOCK(&pAd->DeQueueLock[QueIdx], irqFlags);   \
328                         }while(0)
329
330
331 #define RT28XX_HAS_ENOUGH_FREE_DESC(pAd, pTxBlk, freeNum, pPacket) \
332                 (RTUSBFreeDescriptorRequest(pAd, pTxBlk->QueIdx, (pTxBlk->TotalFrameLen + GET_OS_PKT_LEN(pPacket))) == NDIS_STATUS_SUCCESS)
333
334 #define RT28XX_RELEASE_DESC_RESOURCE(pAd, QueIdx)                       \
335                 do{}while(0)
336
337 #define NEED_QUEUE_BACK_FOR_AGG(_pAd, _QueIdx, _freeNum, _TxFrameType)          \
338                 ((_TxFrameType == TX_RALINK_FRAME) && (RTUSBNeedQueueBackForAgg(_pAd, _QueIdx)))
339
340
341
342 #define fRTMP_ADAPTER_NEED_STOP_TX              \
343                 (fRTMP_ADAPTER_NIC_NOT_EXIST | fRTMP_ADAPTER_HALT_IN_PROGRESS | \
344                  fRTMP_ADAPTER_RESET_IN_PROGRESS | fRTMP_ADAPTER_BULKOUT_RESET | \
345                  fRTMP_ADAPTER_RADIO_OFF | fRTMP_ADAPTER_REMOVE_IN_PROGRESS)
346
347
348 #define HAL_WriteSubTxResource(pAd, pTxBlk, bIsLast, pFreeNumber)       \
349                         RtmpUSB_WriteSubTxResource(pAd, pTxBlk, bIsLast, pFreeNumber)
350
351 #define HAL_WriteTxResource(pAd, pTxBlk,bIsLast, pFreeNumber)   \
352                         RtmpUSB_WriteSingleTxResource(pAd, pTxBlk,bIsLast, pFreeNumber)
353
354 #define HAL_WriteFragTxResource(pAd, pTxBlk, fragNum, pFreeNumber) \
355                         RtmpUSB_WriteFragTxResource(pAd, pTxBlk, fragNum, pFreeNumber)
356
357 #define HAL_WriteMultiTxResource(pAd, pTxBlk,frameNum, pFreeNumber)     \
358                         RtmpUSB_WriteMultiTxResource(pAd, pTxBlk,frameNum, pFreeNumber)
359
360 #define HAL_FinalWriteTxResource(pAd, pTxBlk, totalMPDUSize, TxIdx)     \
361                         RtmpUSB_FinalWriteTxResource(pAd, pTxBlk, totalMPDUSize, TxIdx)
362
363 #define HAL_LastTxIdx(pAd, QueIdx,TxIdx) \
364                         /*RtmpUSBDataLastTxIdx(pAd, QueIdx,TxIdx)*/
365
366 #define HAL_KickOutTx(pAd, pTxBlk, QueIdx)      \
367                         RtmpUSBDataKickOut(pAd, pTxBlk, QueIdx)
368
369
370 #define HAL_KickOutMgmtTx(pAd, QueIdx, pPacket, pSrcBufVA, SrcBufLen)   \
371                         RtmpUSBMgmtKickOut(pAd, QueIdx, pPacket, pSrcBufVA, SrcBufLen)
372
373 #define HAL_KickOutNullFrameTx(_pAd, _QueIdx, _pNullFrame, _frameLen)   \
374                         RtmpUSBNullFrameKickOut(_pAd, _QueIdx, _pNullFrame, _frameLen)
375
376 #define RTMP_PKT_TAIL_PADDING   11 // 3(max 4 byte padding) + 4 (last packet padding) + 4 (MaxBulkOutsize align padding)
377
378 extern UCHAR EpToQueue[6];
379
380
381 #ifdef RT2870
382 #define GET_TXRING_FREENO(_pAd, _QueIdx)        (_QueIdx) //(_pAd->TxRing[_QueIdx].TxSwFreeIdx)
383 #define GET_MGMTRING_FREENO(_pAd)                       (_pAd->MgmtRing.TxSwFreeIdx)
384 #endif // RT2870 //
385
386
387 /* ----------------- RX Related MACRO ----------------- */
388 //#define RT28XX_RX_ERROR_CHECK                         RTMPCheckRxWI
389
390 #define RT28XX_RV_ALL_BUF_END(bBulkReceive)             \
391         /* We return STATUS_MORE_PROCESSING_REQUIRED so that the completion */  \
392         /* routine (IofCompleteRequest) will stop working on the irp. */                \
393         if (bBulkReceive == TRUE)       RTUSBBulkReceive(pAd);
394
395
396 /* ----------------- ASIC Related MACRO ----------------- */
397 // reset MAC of a station entry to 0xFFFFFFFFFFFF
398 #define RT28XX_STA_ENTRY_MAC_RESET(pAd, Wcid)                                   \
399         {       RT_SET_ASIC_WCID        SetAsicWcid;                                            \
400                 SetAsicWcid.WCID = Wcid;                                                                \
401                 SetAsicWcid.SetTid = 0xffffffff;                                                \
402                 SetAsicWcid.DeleteTid = 0xffffffff;                                             \
403                 RTUSBEnqueueInternalCmd(pAd, CMDTHREAD_SET_ASIC_WCID,   \
404                                 &SetAsicWcid, sizeof(RT_SET_ASIC_WCID));        }
405
406 // add this entry into ASIC RX WCID search table
407 #define RT28XX_STA_ENTRY_ADD(pAd, pEntry)                                                       \
408         RTUSBEnqueueInternalCmd(pAd, CMDTHREAD_SET_CLIENT_MAC_ENTRY,    \
409                                                         pEntry, sizeof(MAC_TABLE_ENTRY));
410
411 // add by johnli, fix "in_interrupt" error when call "MacTableDeleteEntry" in Rx tasklet
412 // Set MAC register value according operation mode
413 #define RT28XX_UPDATE_PROTECT(pAd)      \
414         RTUSBEnqueueInternalCmd(pAd, CMDTHREAD_UPDATE_PROTECT, NULL, 0);
415 // end johnli
416
417 // remove Pair-wise key material from ASIC
418 // yet implement
419 #define RT28XX_STA_ENTRY_KEY_DEL(pAd, BssIdx, Wcid)
420
421 // add Client security information into ASIC WCID table and IVEIV table
422 #define RT28XX_STA_SECURITY_INFO_ADD(pAd, apidx, KeyID, pEntry)                                         \
423         {       RT28XX_STA_ENTRY_MAC_RESET(pAd, pEntry->Aid);                                                           \
424                 if (pEntry->Aid >= 1) {                                                                                                         \
425                         RT_SET_ASIC_WCID_ATTRI  SetAsicWcidAttri;                                                               \
426                         SetAsicWcidAttri.WCID = pEntry->Aid;                                                                    \
427                         if ((pEntry->AuthMode <= Ndis802_11AuthModeAutoSwitch) &&                               \
428                                 (pEntry->WepStatus == Ndis802_11Encryption1Enabled))                            \
429                         {                                                                                                                                               \
430                                 SetAsicWcidAttri.Cipher = pAd->SharedKey[apidx][KeyID].CipherAlg;       \
431                         }                                                                                                                                               \
432                         else if (pEntry->AuthMode == Ndis802_11AuthModeWPANone)                                 \
433                         {                                                                                                                                               \
434                                 SetAsicWcidAttri.Cipher = pAd->SharedKey[apidx][KeyID].CipherAlg;       \
435                         }                                                                                                                                               \
436                         else SetAsicWcidAttri.Cipher = 0;                                                                               \
437             DBGPRINT(RT_DEBUG_TRACE, ("aid cipher = %ld\n",SetAsicWcidAttri.Cipher));       \
438                         RTUSBEnqueueInternalCmd(pAd, CMDTHREAD_SET_ASIC_WCID_CIPHER,                    \
439                                                         &SetAsicWcidAttri, sizeof(RT_SET_ASIC_WCID_ATTRI)); } }
440
441 // Insert the BA bitmap to ASIC for the Wcid entry
442 #define RT28XX_ADD_BA_SESSION_TO_ASIC(_pAd, _Aid, _TID)                                 \
443                 do{                                                                                                                             \
444                         RT_SET_ASIC_WCID        SetAsicWcid;                                                    \
445                         SetAsicWcid.WCID = (_Aid);                                                                      \
446                         SetAsicWcid.SetTid = (0x10000<<(_TID));                                         \
447                         SetAsicWcid.DeleteTid = 0xffffffff;                                                     \
448                         RTUSBEnqueueInternalCmd((_pAd), CMDTHREAD_SET_ASIC_WCID, &SetAsicWcid, sizeof(RT_SET_ASIC_WCID));       \
449                 }while(0)
450
451 // Remove the BA bitmap from ASIC for the Wcid entry
452 #define RT28XX_DEL_BA_SESSION_FROM_ASIC(_pAd, _Wcid, _TID)                              \
453                 do{                                                                                                                             \
454                         RT_SET_ASIC_WCID        SetAsicWcid;                                                    \
455                         SetAsicWcid.WCID = (_Wcid);                                                                     \
456                         SetAsicWcid.SetTid = (0xffffffff);                                                      \
457                         SetAsicWcid.DeleteTid = (0x10000<<(_TID) );                                     \
458                         RTUSBEnqueueInternalCmd((_pAd), CMDTHREAD_SET_ASIC_WCID, &SetAsicWcid, sizeof(RT_SET_ASIC_WCID));       \
459                 }while(0)
460
461
462 /* ----------------- PCI/USB Related MACRO ----------------- */
463 #define RT28XX_HANDLE_DEV_ASSIGN(handle, dev_p)                 \
464         ((POS_COOKIE)handle)->pUsb_Dev = dev_p;
465
466 // no use
467 #define RT28XX_UNMAP()
468 #define RT28XX_IRQ_REQUEST(net_dev)
469 #define RT28XX_IRQ_RELEASE(net_dev)
470 #define RT28XX_IRQ_INIT(pAd)
471 #define RT28XX_IRQ_ENABLE(pAd)
472
473
474 /* ----------------- MLME Related MACRO ----------------- */
475 #define RT28XX_MLME_HANDLER(pAd)                        RTUSBMlmeUp(pAd)
476
477 #define RT28XX_MLME_PRE_SANITY_CHECK(pAd)                                                               \
478         {       if ((pAd->CommonCfg.bHardwareRadio == TRUE) &&                                  \
479                         (!RTMP_TEST_FLAG(pAd, fRTMP_ADAPTER_NIC_NOT_EXIST)) &&          \
480                         (!RTMP_TEST_FLAG(pAd, fRTMP_ADAPTER_HALT_IN_PROGRESS))) {       \
481                         RTUSBEnqueueInternalCmd(pAd, CMDTHREAD_CHECK_GPIO, NULL, 0); } }
482
483 #define RT28XX_MLME_STA_QUICK_RSP_WAKE_UP(pAd)  \
484         {       RTUSBEnqueueInternalCmd(pAd, CMDTHREAD_QKERIODIC_EXECUT, NULL, 0);      \
485                 RTUSBMlmeUp(pAd); }
486
487 #define RT28XX_MLME_RESET_STATE_MACHINE(pAd)    \
488                         MlmeEnqueue(pAd, MLME_CNTL_STATE_MACHINE, MT2_RESET_CONF, 0, NULL);     \
489                         RTUSBMlmeUp(pAd);
490
491 #define RT28XX_HANDLE_COUNTER_MEASURE(_pAd, _pEntry)            \
492         {       RTUSBEnqueueInternalCmd(_pAd, CMDTHREAD_802_11_COUNTER_MEASURE, _pEntry, sizeof(MAC_TABLE_ENTRY));      \
493                 RTUSBMlmeUp(_pAd);                                                                      \
494         }
495
496
497 /* ----------------- Power Save Related MACRO ----------------- */
498 #define RT28XX_PS_POLL_ENQUEUE(pAd)                                             \
499         {       RTUSB_SET_BULK_FLAG(pAd, fRTUSB_BULK_OUT_PSPOLL);       \
500                 RTUSBKickBulkOut(pAd); }
501
502 #define RT28xx_CHIP_NAME            "RT2870"
503 #define USB_CYC_CFG                 0x02a4
504 #define NT_SUCCESS(status)                      (((status) > 0) ? (1):(0))
505 #define InterlockedIncrement            atomic_inc
506 #define NdisInterlockedIncrement        atomic_inc
507 #define InterlockedDecrement            atomic_dec
508 #define NdisInterlockedDecrement        atomic_dec
509 #define InterlockedExchange                     atomic_set
510 //#define NdisMSendComplete                     RTMP_SendComplete
511 #define NdisMCancelTimer                        RTMPCancelTimer
512 #define NdisAllocMemory(_ptr, _size, _flag)     \
513                                                                         do{_ptr = kmalloc((_size),(_flag));}while(0)
514 #define NdisFreeMemory(a, b, c)         kfree((a))
515 #define NdisMSleep                                      RTMPusecDelay           /* unit: microsecond */
516
517
518 #define USBD_TRANSFER_DIRECTION_OUT             0
519 #define USBD_TRANSFER_DIRECTION_IN              0
520 #define USBD_SHORT_TRANSFER_OK                  0
521 #define PURB                    purbb_t
522
523 #define RTUSB_FREE_URB(pUrb)    usb_free_urb(pUrb)
524
525 //#undef MlmeAllocateMemory
526 //#undef MlmeFreeMemory
527
528 typedef struct usb_device       * PUSB_DEV;
529
530 /* MACRO for linux usb */
531 typedef struct urb *purbb_t;
532 typedef struct usb_ctrlrequest devctrlrequest;
533 #define PIRP            PVOID
534 #define PMDL            PVOID
535 #define NDIS_OID        UINT
536 #ifndef USB_ST_NOERROR
537 #define USB_ST_NOERROR     0
538 #endif
539
540 // vendor-specific control operations
541 #define CONTROL_TIMEOUT_JIFFIES ( (100 * HZ) / 1000)
542 #define UNLINK_TIMEOUT_MS               3
543
544 /* unlink urb   */
545 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,7)
546 #define RTUSB_UNLINK_URB(pUrb)          usb_kill_urb(pUrb)
547 #else
548 #define RTUSB_UNLINK_URB(pUrb)          usb_unlink_urb(pUrb)
549 #endif
550
551 // Prototypes of completion funuc.
552 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)
553 #define RTUSBBulkOutDataPacketComplete(purb, pt_regs)    RTUSBBulkOutDataPacketComplete(purb)
554 #define RTUSBBulkOutMLMEPacketComplete(pUrb, pt_regs)    RTUSBBulkOutMLMEPacketComplete(pUrb)
555 #define RTUSBBulkOutNullFrameComplete(pUrb, pt_regs)     RTUSBBulkOutNullFrameComplete(pUrb)
556 #define RTUSBBulkOutRTSFrameComplete(pUrb, pt_regs)      RTUSBBulkOutRTSFrameComplete(pUrb)
557 #define RTUSBBulkOutPsPollComplete(pUrb, pt_regs)        RTUSBBulkOutPsPollComplete(pUrb)
558 #define RTUSBBulkRxComplete(pUrb, pt_regs)               RTUSBBulkRxComplete(pUrb)
559 #endif
560
561
562 VOID RTUSBBulkOutDataPacketComplete(purbb_t purb, struct pt_regs *pt_regs);
563 VOID RTUSBBulkOutMLMEPacketComplete(purbb_t pUrb, struct pt_regs *pt_regs);
564 VOID RTUSBBulkOutNullFrameComplete(purbb_t pUrb, struct pt_regs *pt_regs);
565 VOID RTUSBBulkOutRTSFrameComplete(purbb_t pUrb, struct pt_regs *pt_regs);
566 VOID RTUSBBulkOutPsPollComplete(purbb_t pUrb, struct pt_regs *pt_regs);
567 VOID RTUSBBulkRxComplete(purbb_t pUrb, struct pt_regs *pt_regs);
568
569
570 #define RTUSBMlmeUp(pAd)                \
571 {                                                                   \
572         POS_COOKIE pObj = (POS_COOKIE) pAd->OS_Cookie;  \
573         if(pObj->MLMEThr_pid>0)             \
574         up(&(pAd->mlme_semaphore)); \
575 }
576
577 #define RTUSBCMDUp(pAd)                 \
578 {                                                                           \
579         POS_COOKIE pObj = (POS_COOKIE) pAd->OS_Cookie;  \
580         if(pObj->RTUSBCmdThr_pid>0)                 \
581             up(&(pAd->RTUSBCmd_semaphore)); \
582 }
583
584
585 static inline NDIS_STATUS RTMPAllocateMemory(
586         OUT PVOID *ptr,
587         IN size_t size)
588 {
589         *ptr = kmalloc(size, GFP_ATOMIC);
590         if(*ptr)
591                 return NDIS_STATUS_SUCCESS;
592         else
593                 return NDIS_STATUS_RESOURCES;
594 }
595
596 /* rtmp.h */
597 #define BEACON_RING_SIZE                2
598 #define DEVICE_VENDOR_REQUEST_OUT       0x40
599 #define DEVICE_VENDOR_REQUEST_IN        0xc0
600 #define INTERFACE_VENDOR_REQUEST_OUT    0x41
601 #define INTERFACE_VENDOR_REQUEST_IN     0xc1
602 #define MGMTPIPEIDX                                             0       // EP6 is highest priority
603
604 #define BULKOUT_MGMT_RESET_FLAG                         0x80
605
606 #define RTUSB_SET_BULK_FLAG(_M, _F)                             ((_M)->BulkFlags |= (_F))
607 #define RTUSB_CLEAR_BULK_FLAG(_M, _F)                   ((_M)->BulkFlags &= ~(_F))
608 #define RTUSB_TEST_BULK_FLAG(_M, _F)                    (((_M)->BulkFlags & (_F)) != 0)
609
610 #define EnqueueCmd(cmdq, cmdqelmt)              \
611 {                                                                               \
612         if (cmdq->size == 0)                            \
613                 cmdq->head = cmdqelmt;                  \
614         else                                                            \
615                 cmdq->tail->next = cmdqelmt;    \
616         cmdq->tail = cmdqelmt;                          \
617         cmdqelmt->next = NULL;                          \
618         cmdq->size++;                                           \
619 }
620
621 typedef struct   _RT_SET_ASIC_WCID {
622         ULONG WCID;          // mechanism for rekeying: 0:disable, 1: time-based, 2: packet-based
623         ULONG SetTid;        // time-based: seconds, packet-based: kilo-packets
624         ULONG DeleteTid;        // time-based: seconds, packet-based: kilo-packets
625 } RT_SET_ASIC_WCID,*PRT_SET_ASIC_WCID;
626
627 typedef struct   _RT_SET_ASIC_WCID_ATTRI {
628         ULONG   WCID;          // mechanism for rekeying: 0:disable, 1: time-based, 2: packet-based
629         ULONG   Cipher;        // ASIC Cipher definition
630         UCHAR   Addr[ETH_LENGTH_OF_ADDRESS];
631 } RT_SET_ASIC_WCID_ATTRI,*PRT_SET_ASIC_WCID_ATTRI;
632
633 typedef struct _MLME_MEMORY_STRUCT {
634         PVOID                           AllocVa;    //Pointer to the base virtual address of the allocated memory
635         struct _MLME_MEMORY_STRUCT      *Next;      //Pointer to the next virtual address of the allocated memory
636 }   MLME_MEMORY_STRUCT, *PMLME_MEMORY_STRUCT;
637
638 typedef struct  _MLME_MEMORY_HANDLER {
639         BOOLEAN                 MemRunning;         //The flag of the Mlme memory handler's status
640         UINT                    MemoryCount;        //Total nonpaged system-space memory not size
641         UINT                    InUseCount;         //Nonpaged system-space memory in used counts
642         UINT                    UnUseCount;         //Nonpaged system-space memory available counts
643         INT                    PendingCount;       //Nonpaged system-space memory for free counts
644         PMLME_MEMORY_STRUCT     pInUseHead;         //Pointer to the first nonpaed memory not used
645         PMLME_MEMORY_STRUCT     pInUseTail;         //Pointer to the last nonpaged memory not used
646         PMLME_MEMORY_STRUCT     pUnUseHead;         //Pointer to the first nonpaged memory in used
647         PMLME_MEMORY_STRUCT     pUnUseTail;         //Pointer to the last nonpaged memory in used
648         PULONG                  MemFreePending[MAX_MLME_HANDLER_MEMORY];   //an array to keep pending free-memory's pointer (32bits)
649 }   MLME_MEMORY_HANDLER, *PMLME_MEMORY_HANDLER;
650
651 typedef struct _CmdQElmt        {
652         UINT                            command;
653         PVOID                           buffer;
654         ULONG                           bufferlength;
655         BOOLEAN                         CmdFromNdis;
656         BOOLEAN                         SetOperation;
657         struct _CmdQElmt        *next;
658 }       CmdQElmt, *PCmdQElmt;
659
660 typedef struct  _CmdQ   {
661         UINT            size;
662         CmdQElmt        *head;
663         CmdQElmt        *tail;
664         UINT32          CmdQState;
665 }CmdQ, *PCmdQ;
666
667 //
668 // For WPA SUPPLICANT: WIRELESS EXT support wireless events: v14 or newer
669 //
670 #if WIRELESS_EXT >= 14
671 //#define WPA_SUPPLICANT_SUPPORT  1
672 #endif
673
674 /* oid.h */
675 // Cipher suite type for mixed mode group cipher, P802.11i-2004
676 typedef enum _RT_802_11_CIPHER_SUITE_TYPE {
677         Cipher_Type_NONE,
678         Cipher_Type_WEP40,
679         Cipher_Type_TKIP,
680         Cipher_Type_RSVD,
681         Cipher_Type_CCMP,
682         Cipher_Type_WEP104
683 } RT_802_11_CIPHER_SUITE_TYPE, *PRT_802_11_CIPHER_SUITE_TYPE;
684
685 //CMDTHREAD_MULTI_READ_MAC
686 //CMDTHREAD_MULTI_WRITE_MAC
687 //CMDTHREAD_VENDOR_EEPROM_READ
688 //CMDTHREAD_VENDOR_EEPROM_WRITE
689 typedef struct  _CMDHandler_TLV {
690         USHORT          Offset;
691         USHORT          Length;
692         UCHAR           DataFirst;
693 }       CMDHandler_TLV, *PCMDHandler_TLV;
694
695 // New for MeetingHouse Api support
696 #define CMDTHREAD_VENDOR_RESET                      0x0D730101  // cmd
697 #define CMDTHREAD_VENDOR_UNPLUG                     0x0D730102  // cmd
698 #define CMDTHREAD_VENDOR_SWITCH_FUNCTION            0x0D730103  // cmd
699 #define CMDTHREAD_MULTI_WRITE_MAC                   0x0D730107  // cmd
700 #define CMDTHREAD_MULTI_READ_MAC                    0x0D730108  // cmd
701 #define CMDTHREAD_VENDOR_EEPROM_WRITE               0x0D73010A  // cmd
702 #define CMDTHREAD_VENDOR_EEPROM_READ                0x0D73010B  // cmd
703 #define CMDTHREAD_VENDOR_ENTER_TESTMODE             0x0D73010C  // cmd
704 #define CMDTHREAD_VENDOR_EXIT_TESTMODE              0x0D73010D  // cmd
705 #define CMDTHREAD_VENDOR_WRITE_BBP                  0x0D730119  // cmd
706 #define CMDTHREAD_VENDOR_READ_BBP                   0x0D730118  // cmd
707 #define CMDTHREAD_VENDOR_WRITE_RF                   0x0D73011A  // cmd
708 #define CMDTHREAD_VENDOR_FLIP_IQ                    0x0D73011D  // cmd
709 #define CMDTHREAD_RESET_BULK_OUT                    0x0D730210  // cmd
710 #define CMDTHREAD_RESET_BULK_IN                     0x0D730211  // cmd
711 #define CMDTHREAD_SET_PSM_BIT_SAVE                  0x0D730212  // cmd
712 #define CMDTHREAD_SET_RADIO                         0x0D730214  // cmd
713 #define CMDTHREAD_UPDATE_TX_RATE                    0x0D730216  // cmd
714 #define CMDTHREAD_802_11_ADD_KEY_WEP                0x0D730218  // cmd
715 #define CMDTHREAD_RESET_FROM_ERROR                  0x0D73021A  // cmd
716 #define CMDTHREAD_LINK_DOWN                         0x0D73021B  // cmd
717 #define CMDTHREAD_RESET_FROM_NDIS                   0x0D73021C  // cmd
718 #define CMDTHREAD_CHECK_GPIO                        0x0D730215  // cmd
719 #define CMDTHREAD_FORCE_WAKE_UP                     0x0D730222  // cmd
720 #define CMDTHREAD_SET_BW                            0x0D730225  // cmd
721 #define CMDTHREAD_SET_ASIC_WCID                     0x0D730226  // cmd
722 #define CMDTHREAD_SET_ASIC_WCID_CIPHER              0x0D730227  // cmd
723 #define CMDTHREAD_QKERIODIC_EXECUT                  0x0D73023D  // cmd
724 #define RT_CMD_SET_KEY_TABLE                        0x0D730228  // cmd
725 #define RT_CMD_SET_RX_WCID_TABLE                    0x0D730229  // cmd
726 #define CMDTHREAD_SET_CLIENT_MAC_ENTRY              0x0D73023E  // cmd
727 #define CMDTHREAD_802_11_QUERY_HARDWARE_REGISTER    0x0D710105  // cmd
728 #define CMDTHREAD_802_11_SET_PHY_MODE               0x0D79010C  // cmd
729 #define CMDTHREAD_802_11_SET_STA_CONFIG             0x0D790111  // cmd
730 #define CMDTHREAD_802_11_SET_PREAMBLE               0x0D790101  // cmd
731 #define CMDTHREAD_802_11_COUNTER_MEASURE                        0x0D790102      // cmd
732 // add by johnli, fix "in_interrupt" error when call "MacTableDeleteEntry" in Rx tasklet
733 #define CMDTHREAD_UPDATE_PROTECT                                        0x0D790103      // cmd
734 // end johnli
735
736 #define WPA1AKMBIT          0x01
737 #define WPA2AKMBIT          0x02
738 #define WPA1PSKAKMBIT   0x04
739 #define WPA2PSKAKMBIT   0x08
740 #define TKIPBIT         0x01
741 #define CCMPBIT         0x02
742
743
744 #define RT28XX_STA_FORCE_WAKEUP(pAd, bFromTx) \
745     RT28xxUsbStaAsicForceWakeup(pAd, bFromTx);
746
747 #define RT28XX_STA_SLEEP_THEN_AUTO_WAKEUP(pAd, TbttNumToNextWakeUp) \
748     RT28xxUsbStaAsicSleepThenAutoWakeup(pAd, TbttNumToNextWakeUp);
749
750 #define RT28XX_MLME_RADIO_ON(pAd) \
751     RT28xxUsbMlmeRadioOn(pAd);
752
753 #define RT28XX_MLME_RADIO_OFF(pAd) \
754     RT28xxUsbMlmeRadioOFF(pAd);
755
756 #endif //__RT2870_H__