/* * Copyright (c) 1996, 2003 VIA Networking Technologies, Inc. * All rights reserved. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * * File: desc.h * * Purpose:The header file of descriptor * * Revision History: * * Author: Tevin Chen * * Date: May 21, 1996 * */ #ifndef __DESC_H__ #define __DESC_H__ #include #include #include "linux/ieee80211.h" #define B_OWNED_BY_CHIP 1 #define B_OWNED_BY_HOST 0 /* Bits in the RSR register */ #define RSR_ADDRBROAD 0x80 #define RSR_ADDRMULTI 0x40 #define RSR_ADDRUNI 0x00 #define RSR_IVLDTYP 0x20 #define RSR_IVLDLEN 0x10 /* invalid len (> 2312 byte) */ #define RSR_BSSIDOK 0x08 #define RSR_CRCOK 0x04 #define RSR_BCNSSIDOK 0x02 #define RSR_ADDROK 0x01 /* Bits in the new RSR register */ #define NEWRSR_DECRYPTOK 0x10 #define NEWRSR_CFPIND 0x08 #define NEWRSR_HWUTSF 0x04 #define NEWRSR_BCNHITAID 0x02 #define NEWRSR_BCNHITAID0 0x01 /* Bits in the TSR0 register */ #define TSR0_PWRSTS1_2 0xC0 #define TSR0_PWRSTS7 0x20 #define TSR0_NCR 0x1F /* Bits in the TSR1 register */ #define TSR1_TERR 0x80 #define TSR1_PWRSTS4_6 0x70 #define TSR1_RETRYTMO 0x08 #define TSR1_TMO 0x04 #define TSR1_PWRSTS3 0x02 #define ACK_DATA 0x01 /* Bits in the TCR register */ #define EDMSDU 0x04 /* end of sdu */ #define TCR_EDP 0x02 /* end of packet */ #define TCR_STP 0x01 /* start of packet */ /* max transmit or receive buffer size */ #define CB_MAX_BUF_SIZE 2900U /* NOTE: must be multiple of 4 */ #define CB_MAX_TX_BUF_SIZE CB_MAX_BUF_SIZE #define CB_MAX_RX_BUF_SIZE_NORMAL CB_MAX_BUF_SIZE #define CB_BEACON_BUF_SIZE 512U #define CB_MAX_RX_DESC 128 #define CB_MIN_RX_DESC 16 #define CB_MAX_TX_DESC 64 #define CB_MIN_TX_DESC 16 #define CB_MAX_RECEIVED_PACKETS 16 /* * limit our receive routine to indicating * this many at a time for 2 reasons: * 1. driver flow control to protocol layer * 2. limit the time used in ISR routine */ #define CB_EXTRA_RD_NUM 32 #define CB_RD_NUM 32 #define CB_TD_NUM 32 /* * max number of physical segments in a single NDIS packet. Above this * threshold, the packet is copied into a single physically contiguous buffer */ #define CB_MAX_SEGMENT 4 #define CB_MIN_MAP_REG_NUM 4 #define CB_MAX_MAP_REG_NUM CB_MAX_TX_DESC #define CB_PROTOCOL_RESERVED_SECTION 16 /* * if retrys excess 15 times , tx will abort, and if tx fifo underflow, * tx will fail, we should try to resend it */ #define CB_MAX_TX_ABORT_RETRY 3 /* WMAC definition FIFO Control */ #define FIFOCTL_AUTO_FB_1 0x1000 #define FIFOCTL_AUTO_FB_0 0x0800 #define FIFOCTL_GRPACK 0x0400 #define FIFOCTL_11GA 0x0300 #define FIFOCTL_11GB 0x0200 #define FIFOCTL_11B 0x0100 #define FIFOCTL_11A 0x0000 #define FIFOCTL_RTS 0x0080 #define FIFOCTL_ISDMA0 0x0040 #define FIFOCTL_GENINT 0x0020 #define FIFOCTL_TMOEN 0x0010 #define FIFOCTL_LRETRY 0x0008 #define FIFOCTL_CRCDIS 0x0004 #define FIFOCTL_NEEDACK 0x0002 #define FIFOCTL_LHEAD 0x0001 /* WMAC definition Frag Control */ #define FRAGCTL_AES 0x0300 #define FRAGCTL_TKIP 0x0200 #define FRAGCTL_LEGACY 0x0100 #define FRAGCTL_NONENCRYPT 0x0000 #define FRAGCTL_ENDFRAG 0x0003 #define FRAGCTL_MIDFRAG 0x0002 #define FRAGCTL_STAFRAG 0x0001 #define FRAGCTL_NONFRAG 0x0000 #define TYPE_TXDMA0 0 #define TYPE_AC0DMA 1 #define TYPE_ATIMDMA 2 #define TYPE_SYNCDMA 3 #define TYPE_MAXTD 2 #define TYPE_BEACONDMA 4 #define TYPE_RXDMA0 0 #define TYPE_RXDMA1 1 #define TYPE_MAXRD 2 /* TD_INFO flags control bit */ #define TD_FLAGS_NETIF_SKB 0x01 /* check if need release skb */ #define TD_FLAGS_PRIV_SKB 0x02 /* check if called from private skb (hostap) */ #define TD_FLAGS_PS_RETRY 0x04 /* check if PS STA frame re-transmit */ /* * ref_sk_buff is used for mapping the skb structure between pre-built * driver-obj & running kernel. Since different kernel version (2.4x) may * change skb structure, i.e. pre-built driver-obj may link to older skb that * leads error. */ typedef struct tagDEVICE_RD_INFO { struct sk_buff *skb; dma_addr_t skb_dma; dma_addr_t curr_desc; } DEVICE_RD_INFO, *PDEVICE_RD_INFO; #ifdef __BIG_ENDIAN typedef struct tagRDES0 { volatile unsigned short wResCount; union { volatile u16 f15Reserved; struct { volatile u8 f8Reserved1; volatile u8 f1Owner:1; volatile u8 f7Reserved:7; } __attribute__ ((__packed__)); } __attribute__ ((__packed__)); } __attribute__ ((__packed__)) SRDES0, *PSRDES0; #else typedef struct tagRDES0 { unsigned short wResCount; unsigned short f15Reserved:15; unsigned short f1Owner:1; } __attribute__ ((__packed__)) SRDES0; #endif typedef struct tagRDES1 { unsigned short wReqCount; unsigned short wReserved; } __attribute__ ((__packed__)) SRDES1; /* Rx descriptor*/ typedef struct tagSRxDesc { volatile SRDES0 m_rd0RD0; volatile SRDES1 m_rd1RD1; volatile u32 buff_addr; volatile u32 next_desc; struct tagSRxDesc *next __aligned(8); volatile PDEVICE_RD_INFO pRDInfo __aligned(8); } __attribute__ ((__packed__)) SRxDesc, *PSRxDesc; typedef const SRxDesc *PCSRxDesc; #ifdef __BIG_ENDIAN typedef struct tagTDES0 { volatile unsigned char byTSR0; volatile unsigned char byTSR1; union { volatile u16 f15Txtime; struct { volatile u8 f8Reserved1; volatile u8 f1Owner:1; volatile u8 f7Reserved:7; } __attribute__ ((__packed__)); } __attribute__ ((__packed__)); } __attribute__ ((__packed__)) STDES0, PSTDES0; #else typedef struct tagTDES0 { volatile unsigned char byTSR0; volatile unsigned char byTSR1; volatile unsigned short f15Txtime:15; volatile unsigned short f1Owner:1; } __attribute__ ((__packed__)) STDES0; #endif typedef struct tagTDES1 { volatile unsigned short wReqCount; volatile unsigned char byTCR; volatile unsigned char byReserved; } __attribute__ ((__packed__)) STDES1; typedef struct tagDEVICE_TD_INFO { void *mic_hdr; struct sk_buff *skb; unsigned char *buf; dma_addr_t skb_dma; dma_addr_t buf_dma; dma_addr_t curr_desc; unsigned long dwReqCount; unsigned long dwHeaderLength; unsigned char byFlags; } DEVICE_TD_INFO, *PDEVICE_TD_INFO; /* transmit descriptor */ typedef struct tagSTxDesc { volatile STDES0 m_td0TD0; volatile STDES1 m_td1TD1; volatile u32 buff_addr; volatile u32 next_desc; struct tagSTxDesc *next __aligned(8); volatile PDEVICE_TD_INFO pTDInfo __aligned(8); } __attribute__ ((__packed__)) STxDesc, *PSTxDesc; typedef const STxDesc *PCSTxDesc; typedef struct tagSTxSyncDesc { volatile STDES0 m_td0TD0; volatile STDES1 m_td1TD1; volatile u32 buff_addr; /* pointer to logical buffer */ volatile u32 next_desc; /* pointer to next logical descriptor */ volatile unsigned short m_wFIFOCtl; volatile unsigned short m_wTimeStamp; struct tagSTxSyncDesc *next __aligned(8); volatile PDEVICE_TD_INFO pTDInfo __aligned(8); } __attribute__ ((__packed__)) STxSyncDesc, *PSTxSyncDesc; typedef const STxSyncDesc *PCSTxSyncDesc; /* RsvTime buffer header */ typedef struct tagSRrvTime_atim { unsigned short wCTSTxRrvTime_ba; unsigned short wTxRrvTime_a; } __attribute__ ((__packed__)) SRrvTime_atim, *PSRrvTime_atim; typedef const SRrvTime_atim *PCSRrvTime_atim; /* Length, Service, and Signal fields of Phy for Tx */ struct vnt_phy_field { u8 signal; u8 service; __le16 len; } __packed; union vnt_phy_field_swap { struct vnt_phy_field field_read; u16 swap[2]; u32 field_write; }; /* Tx FIFO header */ typedef struct tagSTxBufHead { u32 adwTxKey[4]; unsigned short wFIFOCtl; unsigned short wTimeStamp; unsigned short wFragCtl; unsigned char byTxPower; unsigned char wReserved; } __attribute__ ((__packed__)) STxBufHead, *PSTxBufHead; typedef const STxBufHead *PCSTxBufHead; typedef struct tagSBEACONCtl { u32 BufReady:1; u32 TSF:15; u32 BufLen:11; u32 Reserved:5; } __attribute__ ((__packed__)) SBEACONCtl; typedef struct tagSSecretKey { u32 dwLowDword; unsigned char byHighByte; } __attribute__ ((__packed__)) SSecretKey; typedef struct tagSKeyEntry { unsigned char abyAddrHi[2]; unsigned short wKCTL; unsigned char abyAddrLo[4]; u32 dwKey0[4]; u32 dwKey1[4]; u32 dwKey2[4]; u32 dwKey3[4]; u32 dwKey4[4]; } __attribute__ ((__packed__)) SKeyEntry; #endif /* __DESC_H__ */