2 * Copyright (c) 1996, 2003 VIA Networking Technologies, Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 * Purpose:The header file of descriptor
34 #include <linux/types.h>
39 /*--------------------- Export Definitions -------------------------*/
41 #define B_OWNED_BY_CHIP 1 //
42 #define B_OWNED_BY_HOST 0 //
45 // Bits in the RSR register
47 #define RSR_ADDRBROAD 0x80 // 1000 0000
48 #define RSR_ADDRMULTI 0x40 // 0100 0000
49 #define RSR_ADDRUNI 0x00 // 0000 0000
50 #define RSR_IVLDTYP 0x20 // 0010 0000 , invalid packet type
51 #define RSR_IVLDLEN 0x10 // 0001 0000 , invalid len (> 2312 byte)
52 #define RSR_BSSIDOK 0x08 // 0000 1000
53 #define RSR_CRCOK 0x04 // 0000 0100
54 #define RSR_BCNSSIDOK 0x02 // 0000 0010
55 #define RSR_ADDROK 0x01 // 0000 0001
58 // Bits in the new RSR register
60 #define NEWRSR_DECRYPTOK 0x10 // 0001 0000
61 #define NEWRSR_CFPIND 0x08 // 0000 1000
62 #define NEWRSR_HWUTSF 0x04 // 0000 0100
63 #define NEWRSR_BCNHITAID 0x02 // 0000 0010
64 #define NEWRSR_BCNHITAID0 0x01 // 0000 0001
67 // Bits in the TSR0 register
69 #define TSR0_PWRSTS1_2 0xC0 // 1100 0000
70 #define TSR0_PWRSTS7 0x20 // 0010 0000
71 #define TSR0_NCR 0x1F // 0001 1111
74 // Bits in the TSR1 register
76 #define TSR1_TERR 0x80 // 1000 0000
77 #define TSR1_PWRSTS4_6 0x70 // 0111 0000
78 #define TSR1_RETRYTMO 0x08 // 0000 1000
79 #define TSR1_TMO 0x04 // 0000 0100
80 #define TSR1_PWRSTS3 0x02 // 0000 0010
81 #define ACK_DATA 0x01 // 0000 0000
84 // Bits in the TCR register
86 #define EDMSDU 0x04 // 0000 0100 end of sdu
87 #define TCR_EDP 0x02 // 0000 0010 end of packet
88 #define TCR_STP 0x01 // 0000 0001 start of packet
90 // max transmit or receive buffer size
91 #define CB_MAX_BUF_SIZE 2900U // max buffer size
92 // NOTE: must be multiple of 4
93 #define CB_MAX_TX_BUF_SIZE CB_MAX_BUF_SIZE // max Tx buffer size
94 #define CB_MAX_RX_BUF_SIZE_NORMAL CB_MAX_BUF_SIZE // max Rx buffer size when not use Multi-RD
96 #define CB_BEACON_BUF_SIZE 512U // default beacon buffer size
98 #define CB_MAX_RX_DESC 128 // max # of descriptor
99 #define CB_MIN_RX_DESC 16 // min # of rx descriptor
100 #define CB_MAX_TX_DESC 64 // max # of descriptor
101 #define CB_MIN_TX_DESC 16 // min # of tx descriptor
103 #define CB_MAX_RECEIVED_PACKETS 16 // max # of received packets at one time
104 // limit our receive routine to indicating
105 // this many at a time for 2 reasons:
106 // 1. driver flow control to protocol layer
107 // 2. limit the time used in ISR routine
109 #define CB_EXTRA_RD_NUM 32 // default # of Extra RD
110 #define CB_RD_NUM 32 // default # of RD
111 #define CB_TD_NUM 32 // default # of TD
114 // max number of physical segments
115 // in a single NDIS packet. Above this threshold, the packet
116 // is copied into a single physically contiguous buffer
117 #define CB_MAX_SEGMENT 4
119 #define CB_MIN_MAP_REG_NUM 4
120 #define CB_MAX_MAP_REG_NUM CB_MAX_TX_DESC
122 #define CB_PROTOCOL_RESERVED_SECTION 16
126 // if retrys excess 15 times , tx will abort, and
127 // if tx fifo underflow, tx will fail
128 // we should try to resend it
129 #define CB_MAX_TX_ABORT_RETRY 3
133 // WMAC definition FIFO Control
134 #define FIFOCTL_AUTO_FB_1 0x0010 // 0001 0000 0000 0000
135 #define FIFOCTL_AUTO_FB_0 0x0008 // 0000 1000 0000 0000
136 #define FIFOCTL_GRPACK 0x0004 // 0000 0100 0000 0000
137 #define FIFOCTL_11GA 0x0003 // 0000 0011 0000 0000
138 #define FIFOCTL_11GB 0x0002 // 0000 0010 0000 0000
139 #define FIFOCTL_11B 0x0001 // 0000 0001 0000 0000
140 #define FIFOCTL_11A 0x0000 // 0000 0000 0000 0000
141 #define FIFOCTL_RTS 0x8000 // 0000 0000 1000 0000
142 #define FIFOCTL_ISDMA0 0x4000 // 0000 0000 0100 0000
143 #define FIFOCTL_GENINT 0x2000 // 0000 0000 0010 0000
144 #define FIFOCTL_TMOEN 0x1000 // 0000 0000 0001 0000
145 #define FIFOCTL_LRETRY 0x0800 // 0000 0000 0000 1000
146 #define FIFOCTL_CRCDIS 0x0400 // 0000 0000 0000 0100
147 #define FIFOCTL_NEEDACK 0x0200 // 0000 0000 0000 0010
148 #define FIFOCTL_LHEAD 0x0100 // 0000 0000 0000 0001
150 //WMAC definition Frag Control
151 #define FRAGCTL_AES 0x0003 // 0000 0011 0000 0000
152 #define FRAGCTL_TKIP 0x0002 // 0000 0010 0000 0000
153 #define FRAGCTL_LEGACY 0x0001 // 0000 0001 0000 0000
154 #define FRAGCTL_NONENCRYPT 0x0000 // 0000 0000 0000 0000
155 //#define FRAGCTL_AC3 0x0C00 // 0000 0000 0000 1100
156 //#define FRAGCTL_AC2 0x0800 // 0000 0000 0000 1000
157 //#define FRAGCTL_AC1 0x0400 // 0000 0000 0000 0100
158 //#define FRAGCTL_AC0 0x0000 // 0000 0000 0000 0000
159 #define FRAGCTL_ENDFRAG 0x0300 // 0000 0000 0000 0011
160 #define FRAGCTL_MIDFRAG 0x0200 // 0000 0000 0000 0010
161 #define FRAGCTL_STAFRAG 0x0100 // 0000 0000 0000 0001
162 #define FRAGCTL_NONFRAG 0x0000 // 0000 0000 0000 0000
166 #define FIFOCTL_AUTO_FB_1 0x1000 // 0001 0000 0000 0000
167 #define FIFOCTL_AUTO_FB_0 0x0800 // 0000 1000 0000 0000
168 #define FIFOCTL_GRPACK 0x0400 // 0000 0100 0000 0000
169 #define FIFOCTL_11GA 0x0300 // 0000 0011 0000 0000
170 #define FIFOCTL_11GB 0x0200 // 0000 0010 0000 0000
171 #define FIFOCTL_11B 0x0100 // 0000 0001 0000 0000
172 #define FIFOCTL_11A 0x0000 // 0000 0000 0000 0000
173 #define FIFOCTL_RTS 0x0080 // 0000 0000 1000 0000
174 #define FIFOCTL_ISDMA0 0x0040 // 0000 0000 0100 0000
175 #define FIFOCTL_GENINT 0x0020 // 0000 0000 0010 0000
176 #define FIFOCTL_TMOEN 0x0010 // 0000 0000 0001 0000
177 #define FIFOCTL_LRETRY 0x0008 // 0000 0000 0000 1000
178 #define FIFOCTL_CRCDIS 0x0004 // 0000 0000 0000 0100
179 #define FIFOCTL_NEEDACK 0x0002 // 0000 0000 0000 0010
180 #define FIFOCTL_LHEAD 0x0001 // 0000 0000 0000 0001
182 //WMAC definition Frag Control
183 #define FRAGCTL_AES 0x0300 // 0000 0011 0000 0000
184 #define FRAGCTL_TKIP 0x0200 // 0000 0010 0000 0000
185 #define FRAGCTL_LEGACY 0x0100 // 0000 0001 0000 0000
186 #define FRAGCTL_NONENCRYPT 0x0000 // 0000 0000 0000 0000
187 //#define FRAGCTL_AC3 0x000C // 0000 0000 0000 1100
188 //#define FRAGCTL_AC2 0x0008 // 0000 0000 0000 1000
189 //#define FRAGCTL_AC1 0x0004 // 0000 0000 0000 0100
190 //#define FRAGCTL_AC0 0x0000 // 0000 0000 0000 0000
191 #define FRAGCTL_ENDFRAG 0x0003 // 0000 0000 0000 0011
192 #define FRAGCTL_MIDFRAG 0x0002 // 0000 0000 0000 0010
193 #define FRAGCTL_STAFRAG 0x0001 // 0000 0000 0000 0001
194 #define FRAGCTL_NONFRAG 0x0000 // 0000 0000 0000 0000
196 #endif // #ifdef __BIG_ENDIAN
198 //#define TYPE_AC0DMA 0
199 //#define TYPE_TXDMA0 1
200 #define TYPE_TXDMA0 0
201 #define TYPE_AC0DMA 1
202 #define TYPE_ATIMDMA 2
203 #define TYPE_SYNCDMA 3
206 #define TYPE_BEACONDMA 4
208 #define TYPE_RXDMA0 0
209 #define TYPE_RXDMA1 1
214 // TD_INFO flags control bit
215 #define TD_FLAGS_NETIF_SKB 0x01 // check if need release skb
216 #define TD_FLAGS_PRIV_SKB 0x02 // check if called from private skb(hostap)
217 #define TD_FLAGS_PS_RETRY 0x04 // check if PS STA frame re-transmit
218 //#define TD_FLAGS_NETIF_SKB 0x04
220 /*--------------------- Export Types ------------------------------*/
222 // ref_sk_buff is used for mapping the skb structure between pre-built driver-obj & running kernel.
223 // Since different kernel version (2.4x) may change skb structure, i.e. pre-built driver-obj
224 // may link to older skb that leads error.
226 typedef struct tagDEVICE_RD_INFO
{
229 dma_addr_t curr_desc
;
230 } DEVICE_RD_INFO
, *PDEVICE_RD_INFO
;
233 static inline PDEVICE_RD_INFO alloc_rd_info(void) {
235 if ((ptr = kmalloc(sizeof(DEVICE_RD_INFO), GFP_ATOMIC)) == NULL)
238 memset(ptr,0,sizeof(DEVICE_RD_INFO));
245 typedef struct tagRDES0 {
248 // WORD f15Reserved : 15;
250 } __attribute__ ((__packed__))
256 typedef struct tagRDES0
{
257 volatile WORD wResCount
;
259 volatile U16 f15Reserved
;
261 volatile U8 f8Reserved1
;
262 volatile U8 f1Owner
:1;
263 volatile U8 f7Reserved
:7;
264 } __attribute__ ((__packed__
));
265 } __attribute__ ((__packed__
));
266 } __attribute__ ((__packed__
))
271 typedef struct tagRDES0
{
273 WORD f15Reserved
: 15;
275 } __attribute__ ((__packed__
))
281 typedef struct tagRDES1
{
284 } __attribute__ ((__packed__
))
290 typedef struct tagSRxDesc
{
291 volatile SRDES0 m_rd0RD0
;
292 volatile SRDES1 m_rd1RD1
;
293 volatile U32 buff_addr
;
294 volatile U32 next_desc
;
295 struct tagSRxDesc
*next
;//4 bytes
296 volatile PDEVICE_RD_INFO pRDInfo
;//4 bytes
297 volatile U32 Reserved
[2];//8 bytes
298 } __attribute__ ((__packed__
))
300 typedef const SRxDesc
*PCSRxDesc
;
305 typedef struct tagTDES0 {
306 volatile BYTE byTSR0;
307 volatile BYTE byTSR1;
308 volatile WORD wOwner_Txtime;
309 // volatile WORD f15Txtime : 15;
310 // volatile WORD f1Owner:1;
311 } __attribute__ ((__packed__))
315 typedef struct tagTDES0
{
316 volatile BYTE byTSR0
;
317 volatile BYTE byTSR1
;
319 volatile U16 f15Txtime
;
321 volatile U8 f8Reserved1
;
322 volatile U8 f1Owner
:1;
323 volatile U8 f7Reserved
:7;
324 } __attribute__ ((__packed__
));
325 } __attribute__ ((__packed__
));
326 } __attribute__ ((__packed__
))
331 typedef struct tagTDES0
{
332 volatile BYTE byTSR0
;
333 volatile BYTE byTSR1
;
334 volatile WORD f15Txtime
: 15;
335 volatile WORD f1Owner
:1;
336 } __attribute__ ((__packed__
))
342 typedef struct tagTDES1
{
343 volatile WORD wReqCount
;
345 volatile BYTE byReserved
;
346 } __attribute__ ((__packed__
))
350 typedef struct tagDEVICE_TD_INFO
{
355 dma_addr_t curr_desc
;
357 DWORD dwHeaderLength
;
359 } DEVICE_TD_INFO
, *PDEVICE_TD_INFO
;
362 static inline PDEVICE_TD_INFO alloc_td_info(void) {
364 if ((ptr = kmalloc(sizeof(DEVICE_TD_INFO),GFP_ATOMIC))==NULL)
367 memset(ptr,0,sizeof(DEVICE_TD_INFO));
374 // transmit descriptor
376 typedef struct tagSTxDesc
{
377 volatile STDES0 m_td0TD0
;
378 volatile STDES1 m_td1TD1
;
379 volatile U32 buff_addr
;
380 volatile U32 next_desc
;
381 struct tagSTxDesc
* next
; //4 bytes
382 volatile PDEVICE_TD_INFO pTDInfo
;//4 bytes
383 volatile U32 Reserved
[2];//8 bytes
384 } __attribute__ ((__packed__
))
386 typedef const STxDesc
*PCSTxDesc
;
389 typedef struct tagSTxSyncDesc
{
390 volatile STDES0 m_td0TD0
;
391 volatile STDES1 m_td1TD1
;
392 volatile DWORD buff_addr
; // pointer to logical buffer
393 volatile DWORD next_desc
; // pointer to next logical descriptor
394 volatile WORD m_wFIFOCtl
;
395 volatile WORD m_wTimeStamp
;
396 struct tagSTxSyncDesc
* next
; //4 bytes
397 volatile PDEVICE_TD_INFO pTDInfo
;//4 bytes
398 volatile DWORD m_dwReserved2
;
399 } __attribute__ ((__packed__
))
400 STxSyncDesc
, *PSTxSyncDesc
;
401 typedef const STxSyncDesc
*PCSTxSyncDesc
;
405 // RsvTime buffer header
407 typedef struct tagSRrvTime_gRTS
{
408 WORD wRTSTxRrvTime_ba
;
409 WORD wRTSTxRrvTime_aa
;
410 WORD wRTSTxRrvTime_bb
;
414 }__attribute__ ((__packed__
))
415 SRrvTime_gRTS
, *PSRrvTime_gRTS
;
416 typedef const SRrvTime_gRTS
*PCSRrvTime_gRTS
;
418 typedef struct tagSRrvTime_gCTS
{
419 WORD wCTSTxRrvTime_ba
;
423 }__attribute__ ((__packed__
))
424 SRrvTime_gCTS
, *PSRrvTime_gCTS
;
425 typedef const SRrvTime_gCTS
*PCSRrvTime_gCTS
;
427 typedef struct tagSRrvTime_ab
{
430 }__attribute__ ((__packed__
))
431 SRrvTime_ab
, *PSRrvTime_ab
;
432 typedef const SRrvTime_ab
*PCSRrvTime_ab
;
434 typedef struct tagSRrvTime_atim
{
435 WORD wCTSTxRrvTime_ba
;
437 }__attribute__ ((__packed__
))
438 SRrvTime_atim
, *PSRrvTime_atim
;
439 typedef const SRrvTime_atim
*PCSRrvTime_atim
;
444 typedef struct tagSRTSData
{
447 BYTE abyRA
[U_ETHER_ADDR_LEN
];
448 BYTE abyTA
[U_ETHER_ADDR_LEN
];
449 }__attribute__ ((__packed__
))
450 SRTSData
, *PSRTSData
;
451 typedef const SRTSData
*PCSRTSData
;
453 typedef struct tagSRTS_g
{
454 BYTE bySignalField_b
;
455 BYTE byServiceField_b
;
456 WORD wTransmitLength_b
;
457 BYTE bySignalField_a
;
458 BYTE byServiceField_a
;
459 WORD wTransmitLength_a
;
465 }__attribute__ ((__packed__
))
467 typedef const SRTS_g
*PCSRTS_g
;
470 typedef struct tagSRTS_g_FB
{
471 BYTE bySignalField_b
;
472 BYTE byServiceField_b
;
473 WORD wTransmitLength_b
;
474 BYTE bySignalField_a
;
475 BYTE byServiceField_a
;
476 WORD wTransmitLength_a
;
481 WORD wRTSDuration_ba_f0
;
482 WORD wRTSDuration_aa_f0
;
483 WORD wRTSDuration_ba_f1
;
484 WORD wRTSDuration_aa_f1
;
486 }__attribute__ ((__packed__
))
487 SRTS_g_FB
, *PSRTS_g_FB
;
488 typedef const SRTS_g_FB
*PCSRTS_g_FB
;
491 typedef struct tagSRTS_ab
{
494 WORD wTransmitLength
;
498 }__attribute__ ((__packed__
))
500 typedef const SRTS_ab
*PCSRTS_ab
;
503 typedef struct tagSRTS_a_FB
{
506 WORD wTransmitLength
;
509 WORD wRTSDuration_f0
;
510 WORD wRTSDuration_f1
;
512 }__attribute__ ((__packed__
))
513 SRTS_a_FB
, *PSRTS_a_FB
;
514 typedef const SRTS_a_FB
*PCSRTS_a_FB
;
520 typedef struct tagSCTSData
{
523 BYTE abyRA
[U_ETHER_ADDR_LEN
];
525 }__attribute__ ((__packed__
))
526 SCTSData
, *PSCTSData
;
528 typedef struct tagSCTS
{
529 BYTE bySignalField_b
;
530 BYTE byServiceField_b
;
531 WORD wTransmitLength_b
;
535 }__attribute__ ((__packed__
))
537 typedef const SCTS
*PCSCTS
;
539 typedef struct tagSCTS_FB
{
540 BYTE bySignalField_b
;
541 BYTE byServiceField_b
;
542 WORD wTransmitLength_b
;
545 WORD wCTSDuration_ba_f0
;
546 WORD wCTSDuration_ba_f1
;
548 }__attribute__ ((__packed__
))
550 typedef const SCTS_FB
*PCSCTS_FB
;
556 typedef struct tagSTxBufHead
{
563 }__attribute__ ((__packed__
))
564 STxBufHead
, *PSTxBufHead
;
565 typedef const STxBufHead
*PCSTxBufHead
;
567 typedef struct tagSTxShortBufHead
{
570 }__attribute__ ((__packed__
))
571 STxShortBufHead
, *PSTxShortBufHead
;
572 typedef const STxShortBufHead
*PCSTxShortBufHead
;
577 typedef struct tagSTxDataHead_g
{
578 BYTE bySignalField_b
;
579 BYTE byServiceField_b
;
580 WORD wTransmitLength_b
;
581 BYTE bySignalField_a
;
582 BYTE byServiceField_a
;
583 WORD wTransmitLength_a
;
586 WORD wTimeStampOff_b
;
587 WORD wTimeStampOff_a
;
588 }__attribute__ ((__packed__
))
589 STxDataHead_g
, *PSTxDataHead_g
;
590 typedef const STxDataHead_g
*PCSTxDataHead_g
;
592 typedef struct tagSTxDataHead_g_FB
{
593 BYTE bySignalField_b
;
594 BYTE byServiceField_b
;
595 WORD wTransmitLength_b
;
596 BYTE bySignalField_a
;
597 BYTE byServiceField_a
;
598 WORD wTransmitLength_a
;
603 WORD wTimeStampOff_b
;
604 WORD wTimeStampOff_a
;
605 }__attribute__ ((__packed__
))
606 STxDataHead_g_FB
, *PSTxDataHead_g_FB
;
607 typedef const STxDataHead_g_FB
*PCSTxDataHead_g_FB
;
610 typedef struct tagSTxDataHead_ab
{
613 WORD wTransmitLength
;
616 }__attribute__ ((__packed__
))
617 STxDataHead_ab
, *PSTxDataHead_ab
;
618 typedef const STxDataHead_ab
*PCSTxDataHead_ab
;
621 typedef struct tagSTxDataHead_a_FB
{
624 WORD wTransmitLength
;
629 }__attribute__ ((__packed__
))
630 STxDataHead_a_FB
, *PSTxDataHead_a_FB
;
631 typedef const STxDataHead_a_FB
*PCSTxDataHead_a_FB
;
634 // MICHDR data header
636 typedef struct tagSMICHDRHead
{
640 }__attribute__ ((__packed__
))
641 SMICHDRHead
, *PSMICHDRHead
;
642 typedef const SMICHDRHead
*PCSMICHDRHead
;
644 typedef struct tagSBEACONCtl
{
649 }__attribute__ ((__packed__
))
653 typedef struct tagSSecretKey
{
656 }__attribute__ ((__packed__
))
659 typedef struct tagSKeyEntry
{
668 }__attribute__ ((__packed__
))
670 /*--------------------- Export Macros ------------------------------*/
672 /*--------------------- Export Classes ----------------------------*/
674 /*--------------------- Export Variables --------------------------*/
676 /*--------------------- Export Functions --------------------------*/