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