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