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_ENDFRAG 0x0300 // 0000 0000 0000 0011
156 #define FRAGCTL_MIDFRAG 0x0200 // 0000 0000 0000 0010
157 #define FRAGCTL_STAFRAG 0x0100 // 0000 0000 0000 0001
158 #define FRAGCTL_NONFRAG 0x0000 // 0000 0000 0000 0000
162 #define FIFOCTL_AUTO_FB_1 0x1000 // 0001 0000 0000 0000
163 #define FIFOCTL_AUTO_FB_0 0x0800 // 0000 1000 0000 0000
164 #define FIFOCTL_GRPACK 0x0400 // 0000 0100 0000 0000
165 #define FIFOCTL_11GA 0x0300 // 0000 0011 0000 0000
166 #define FIFOCTL_11GB 0x0200 // 0000 0010 0000 0000
167 #define FIFOCTL_11B 0x0100 // 0000 0001 0000 0000
168 #define FIFOCTL_11A 0x0000 // 0000 0000 0000 0000
169 #define FIFOCTL_RTS 0x0080 // 0000 0000 1000 0000
170 #define FIFOCTL_ISDMA0 0x0040 // 0000 0000 0100 0000
171 #define FIFOCTL_GENINT 0x0020 // 0000 0000 0010 0000
172 #define FIFOCTL_TMOEN 0x0010 // 0000 0000 0001 0000
173 #define FIFOCTL_LRETRY 0x0008 // 0000 0000 0000 1000
174 #define FIFOCTL_CRCDIS 0x0004 // 0000 0000 0000 0100
175 #define FIFOCTL_NEEDACK 0x0002 // 0000 0000 0000 0010
176 #define FIFOCTL_LHEAD 0x0001 // 0000 0000 0000 0001
178 //WMAC definition Frag Control
179 #define FRAGCTL_AES 0x0300 // 0000 0011 0000 0000
180 #define FRAGCTL_TKIP 0x0200 // 0000 0010 0000 0000
181 #define FRAGCTL_LEGACY 0x0100 // 0000 0001 0000 0000
182 #define FRAGCTL_NONENCRYPT 0x0000 // 0000 0000 0000 0000
183 #define FRAGCTL_ENDFRAG 0x0003 // 0000 0000 0000 0011
184 #define FRAGCTL_MIDFRAG 0x0002 // 0000 0000 0000 0010
185 #define FRAGCTL_STAFRAG 0x0001 // 0000 0000 0000 0001
186 #define FRAGCTL_NONFRAG 0x0000 // 0000 0000 0000 0000
188 #endif // #ifdef __BIG_ENDIAN
190 #define TYPE_TXDMA0 0
191 #define TYPE_AC0DMA 1
192 #define TYPE_ATIMDMA 2
193 #define TYPE_SYNCDMA 3
196 #define TYPE_BEACONDMA 4
198 #define TYPE_RXDMA0 0
199 #define TYPE_RXDMA1 1
204 // TD_INFO flags control bit
205 #define TD_FLAGS_NETIF_SKB 0x01 // check if need release skb
206 #define TD_FLAGS_PRIV_SKB 0x02 // check if called from private skb(hostap)
207 #define TD_FLAGS_PS_RETRY 0x04 // check if PS STA frame re-transmit
209 /*--------------------- Export Types ------------------------------*/
211 // ref_sk_buff is used for mapping the skb structure between pre-built driver-obj & running kernel.
212 // Since different kernel version (2.4x) may change skb structure, i.e. pre-built driver-obj
213 // may link to older skb that leads error.
215 typedef struct tagDEVICE_RD_INFO {
218 dma_addr_t curr_desc;
219 } DEVICE_RD_INFO, *PDEVICE_RD_INFO;
222 static inline PDEVICE_RD_INFO alloc_rd_info(void) {
224 ptr = kmalloc(sizeof(DEVICE_RD_INFO), GFP_ATOMIC);
228 memset(ptr,0,sizeof(DEVICE_RD_INFO));
235 typedef struct tagRDES0 {
236 unsigned short wResCount;
237 unsigned short wf1Owner ;
238 // unsigned short f15Reserved : 15;
239 // unsigned short f1Owner : 1;
240 } __attribute__ ((__packed__))
246 typedef struct tagRDES0 {
247 volatile unsigned short wResCount;
249 volatile u16 f15Reserved;
251 volatile u8 f8Reserved1;
252 volatile u8 f1Owner:1;
253 volatile u8 f7Reserved:7;
254 } __attribute__ ((__packed__));
255 } __attribute__ ((__packed__));
256 } __attribute__ ((__packed__))
261 typedef struct tagRDES0 {
262 unsigned short wResCount;
263 unsigned short f15Reserved : 15;
264 unsigned short f1Owner : 1;
265 } __attribute__ ((__packed__))
271 typedef struct tagRDES1 {
272 unsigned short wReqCount;
273 unsigned short wReserved;
274 } __attribute__ ((__packed__))
280 typedef struct tagSRxDesc {
281 volatile SRDES0 m_rd0RD0;
282 volatile SRDES1 m_rd1RD1;
283 volatile u32 buff_addr;
284 volatile u32 next_desc;
285 struct tagSRxDesc *next;//4 bytes
286 volatile PDEVICE_RD_INFO pRDInfo;//4 bytes
287 volatile u32 Reserved[2];//8 bytes
288 } __attribute__ ((__packed__))
290 typedef const SRxDesc *PCSRxDesc;
295 typedef struct tagTDES0 {
296 volatile unsigned char byTSR0;
297 volatile unsigned char byTSR1;
298 volatile unsigned short wOwner_Txtime;
299 // volatile unsigned short f15Txtime : 15;
300 // volatile unsigned short f1Owner:1;
301 } __attribute__ ((__packed__))
305 typedef struct tagTDES0 {
306 volatile unsigned char byTSR0;
307 volatile unsigned char byTSR1;
309 volatile u16 f15Txtime;
311 volatile u8 f8Reserved1;
312 volatile u8 f1Owner:1;
313 volatile u8 f7Reserved:7;
314 } __attribute__ ((__packed__));
315 } __attribute__ ((__packed__));
316 } __attribute__ ((__packed__))
321 typedef struct tagTDES0 {
322 volatile unsigned char byTSR0;
323 volatile unsigned char byTSR1;
324 volatile unsigned short f15Txtime : 15;
325 volatile unsigned short f1Owner:1;
326 } __attribute__ ((__packed__))
332 typedef struct tagTDES1 {
333 volatile unsigned short wReqCount;
334 volatile unsigned char byTCR;
335 volatile unsigned char byReserved;
336 } __attribute__ ((__packed__))
340 typedef struct tagDEVICE_TD_INFO{
345 dma_addr_t curr_desc;
346 unsigned long dwReqCount;
347 unsigned long dwHeaderLength;
348 unsigned char byFlags;
349 } DEVICE_TD_INFO, *PDEVICE_TD_INFO;
352 static inline PDEVICE_TD_INFO alloc_td_info(void) {
354 ptr = kmalloc(sizeof(DEVICE_TD_INFO),GFP_ATOMIC);
358 memset(ptr,0,sizeof(DEVICE_TD_INFO));
365 // transmit descriptor
367 typedef struct tagSTxDesc {
368 volatile STDES0 m_td0TD0;
369 volatile STDES1 m_td1TD1;
370 volatile u32 buff_addr;
371 volatile u32 next_desc;
372 struct tagSTxDesc* next; //4 bytes
373 volatile PDEVICE_TD_INFO pTDInfo;//4 bytes
374 volatile u32 Reserved[2];//8 bytes
375 } __attribute__ ((__packed__))
377 typedef const STxDesc *PCSTxDesc;
380 typedef struct tagSTxSyncDesc {
381 volatile STDES0 m_td0TD0;
382 volatile STDES1 m_td1TD1;
383 volatile u32 buff_addr; // pointer to logical buffer
384 volatile u32 next_desc; // pointer to next logical descriptor
385 volatile unsigned short m_wFIFOCtl;
386 volatile unsigned short m_wTimeStamp;
387 struct tagSTxSyncDesc* next; //4 bytes
388 volatile PDEVICE_TD_INFO pTDInfo;//4 bytes
389 volatile u32 m_dwReserved2;
390 } __attribute__ ((__packed__))
391 STxSyncDesc, *PSTxSyncDesc;
392 typedef const STxSyncDesc *PCSTxSyncDesc;
396 // RsvTime buffer header
398 typedef struct tagSRrvTime_gRTS {
399 unsigned short wRTSTxRrvTime_ba;
400 unsigned short wRTSTxRrvTime_aa;
401 unsigned short wRTSTxRrvTime_bb;
402 unsigned short wReserved;
403 unsigned short wTxRrvTime_b;
404 unsigned short wTxRrvTime_a;
405 }__attribute__ ((__packed__))
406 SRrvTime_gRTS, *PSRrvTime_gRTS;
407 typedef const SRrvTime_gRTS *PCSRrvTime_gRTS;
409 typedef struct tagSRrvTime_gCTS {
410 unsigned short wCTSTxRrvTime_ba;
411 unsigned short wReserved;
412 unsigned short wTxRrvTime_b;
413 unsigned short wTxRrvTime_a;
414 }__attribute__ ((__packed__))
415 SRrvTime_gCTS, *PSRrvTime_gCTS;
416 typedef const SRrvTime_gCTS *PCSRrvTime_gCTS;
418 typedef struct tagSRrvTime_ab {
419 unsigned short wRTSTxRrvTime;
420 unsigned short wTxRrvTime;
421 }__attribute__ ((__packed__))
422 SRrvTime_ab, *PSRrvTime_ab;
423 typedef const SRrvTime_ab *PCSRrvTime_ab;
425 typedef struct tagSRrvTime_atim {
426 unsigned short wCTSTxRrvTime_ba;
427 unsigned short wTxRrvTime_a;
428 }__attribute__ ((__packed__))
429 SRrvTime_atim, *PSRrvTime_atim;
430 typedef const SRrvTime_atim *PCSRrvTime_atim;
435 typedef struct tagSRTSData {
436 unsigned short wFrameControl;
437 unsigned short wDurationID;
438 unsigned char abyRA[ETH_ALEN];
439 unsigned char abyTA[ETH_ALEN];
440 }__attribute__ ((__packed__))
441 SRTSData, *PSRTSData;
442 typedef const SRTSData *PCSRTSData;
444 typedef struct tagSRTS_g {
445 unsigned char bySignalField_b;
446 unsigned char byServiceField_b;
447 unsigned short wTransmitLength_b;
448 unsigned char bySignalField_a;
449 unsigned char byServiceField_a;
450 unsigned short wTransmitLength_a;
451 unsigned short wDuration_ba;
452 unsigned short wDuration_aa;
453 unsigned short wDuration_bb;
454 unsigned short wReserved;
456 }__attribute__ ((__packed__))
458 typedef const SRTS_g *PCSRTS_g;
461 typedef struct tagSRTS_g_FB {
462 unsigned char bySignalField_b;
463 unsigned char byServiceField_b;
464 unsigned short wTransmitLength_b;
465 unsigned char bySignalField_a;
466 unsigned char byServiceField_a;
467 unsigned short wTransmitLength_a;
468 unsigned short wDuration_ba;
469 unsigned short wDuration_aa;
470 unsigned short wDuration_bb;
471 unsigned short wReserved;
472 unsigned short wRTSDuration_ba_f0;
473 unsigned short wRTSDuration_aa_f0;
474 unsigned short wRTSDuration_ba_f1;
475 unsigned short wRTSDuration_aa_f1;
477 }__attribute__ ((__packed__))
478 SRTS_g_FB, *PSRTS_g_FB;
479 typedef const SRTS_g_FB *PCSRTS_g_FB;
482 typedef struct tagSRTS_ab {
483 unsigned char bySignalField;
484 unsigned char byServiceField;
485 unsigned short wTransmitLength;
486 unsigned short wDuration;
487 unsigned short wReserved;
489 }__attribute__ ((__packed__))
491 typedef const SRTS_ab *PCSRTS_ab;
494 typedef struct tagSRTS_a_FB {
495 unsigned char bySignalField;
496 unsigned char byServiceField;
497 unsigned short wTransmitLength;
498 unsigned short wDuration;
499 unsigned short wReserved;
500 unsigned short wRTSDuration_f0;
501 unsigned short wRTSDuration_f1;
503 }__attribute__ ((__packed__))
504 SRTS_a_FB, *PSRTS_a_FB;
505 typedef const SRTS_a_FB *PCSRTS_a_FB;
511 typedef struct tagSCTSData {
512 unsigned short wFrameControl;
513 unsigned short wDurationID;
514 unsigned char abyRA[ETH_ALEN];
515 unsigned short wReserved;
516 }__attribute__ ((__packed__))
517 SCTSData, *PSCTSData;
519 typedef struct tagSCTS {
520 unsigned char bySignalField_b;
521 unsigned char byServiceField_b;
522 unsigned short wTransmitLength_b;
523 unsigned short wDuration_ba;
524 unsigned short wReserved;
526 }__attribute__ ((__packed__))
528 typedef const SCTS *PCSCTS;
530 typedef struct tagSCTS_FB {
531 unsigned char bySignalField_b;
532 unsigned char byServiceField_b;
533 unsigned short wTransmitLength_b;
534 unsigned short wDuration_ba;
535 unsigned short wReserved;
536 unsigned short wCTSDuration_ba_f0;
537 unsigned short wCTSDuration_ba_f1;
539 }__attribute__ ((__packed__))
541 typedef const SCTS_FB *PCSCTS_FB;
547 typedef struct tagSTxBufHead {
549 unsigned short wFIFOCtl;
550 unsigned short wTimeStamp;
551 unsigned short wFragCtl;
552 unsigned char byTxPower;
553 unsigned char wReserved;
554 }__attribute__ ((__packed__))
555 STxBufHead, *PSTxBufHead;
556 typedef const STxBufHead *PCSTxBufHead;
558 typedef struct tagSTxShortBufHead {
559 unsigned short wFIFOCtl;
560 unsigned short wTimeStamp;
561 }__attribute__ ((__packed__))
562 STxShortBufHead, *PSTxShortBufHead;
563 typedef const STxShortBufHead *PCSTxShortBufHead;
568 typedef struct tagSTxDataHead_g {
569 unsigned char bySignalField_b;
570 unsigned char byServiceField_b;
571 unsigned short wTransmitLength_b;
572 unsigned char bySignalField_a;
573 unsigned char byServiceField_a;
574 unsigned short wTransmitLength_a;
575 unsigned short wDuration_b;
576 unsigned short wDuration_a;
577 unsigned short wTimeStampOff_b;
578 unsigned short wTimeStampOff_a;
579 }__attribute__ ((__packed__))
580 STxDataHead_g, *PSTxDataHead_g;
581 typedef const STxDataHead_g *PCSTxDataHead_g;
583 typedef struct tagSTxDataHead_g_FB {
584 unsigned char bySignalField_b;
585 unsigned char byServiceField_b;
586 unsigned short wTransmitLength_b;
587 unsigned char bySignalField_a;
588 unsigned char byServiceField_a;
589 unsigned short wTransmitLength_a;
590 unsigned short wDuration_b;
591 unsigned short wDuration_a;
592 unsigned short wDuration_a_f0;
593 unsigned short wDuration_a_f1;
594 unsigned short wTimeStampOff_b;
595 unsigned short wTimeStampOff_a;
596 }__attribute__ ((__packed__))
597 STxDataHead_g_FB, *PSTxDataHead_g_FB;
598 typedef const STxDataHead_g_FB *PCSTxDataHead_g_FB;
601 typedef struct tagSTxDataHead_ab {
602 unsigned char bySignalField;
603 unsigned char byServiceField;
604 unsigned short wTransmitLength;
605 unsigned short wDuration;
606 unsigned short wTimeStampOff;
607 }__attribute__ ((__packed__))
608 STxDataHead_ab, *PSTxDataHead_ab;
609 typedef const STxDataHead_ab *PCSTxDataHead_ab;
612 typedef struct tagSTxDataHead_a_FB {
613 unsigned char bySignalField;
614 unsigned char byServiceField;
615 unsigned short wTransmitLength;
616 unsigned short wDuration;
617 unsigned short wTimeStampOff;
618 unsigned short wDuration_f0;
619 unsigned short wDuration_f1;
620 }__attribute__ ((__packed__))
621 STxDataHead_a_FB, *PSTxDataHead_a_FB;
622 typedef const STxDataHead_a_FB *PCSTxDataHead_a_FB;
625 // MICHDR data header
627 typedef struct tagSMICHDRHead {
631 }__attribute__ ((__packed__))
632 SMICHDRHead, *PSMICHDRHead;
633 typedef const SMICHDRHead *PCSMICHDRHead;
635 typedef struct tagSBEACONCtl {
640 }__attribute__ ((__packed__))
644 typedef struct tagSSecretKey {
646 unsigned char byHighByte;
647 }__attribute__ ((__packed__))
650 typedef struct tagSKeyEntry {
651 unsigned char abyAddrHi[2];
652 unsigned short wKCTL;
653 unsigned char abyAddrLo[4];
659 }__attribute__ ((__packed__))
661 /*--------------------- Export Macros ------------------------------*/
663 /*--------------------- Export Classes ----------------------------*/
665 /*--------------------- Export Variables --------------------------*/
667 /*--------------------- Export Functions --------------------------*/