path: root/drivers/staging/rt2860/chip/rtmp_mac.h

/*
 *************************************************************************
 * Ralink Tech Inc.
 * 5F., No.36, Taiyuan St., Jhubei City,
 * Hsinchu County 302,
 * Taiwan, R.O.C.
 *
 * (c) Copyright 2002-2007, Ralink Technology, Inc.
 *
 * 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.,                                       *
 * 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 *                                                                       *
 *************************************************************************

	Module Name:
	rtmp_mac.h

	Abstract:
	Ralink Wireless Chip MAC related definition & structures

	Revision History:
	Who			When		  What
	Justin P. Mattock	11/07/2010	  Fix a comments, and typos
	--------	----------	  ----------------------------------------------
*/

#ifndef __RTMP_MAC_H__
#define __RTMP_MAC_H__

/* ================================================================================= */
/* TX / RX ring descriptor format */
/* ================================================================================= */

/* the first 24-byte in TXD is called TXINFO and will be DMAed to MAC block through TXFIFO. */
/* MAC block uses this TXINFO to control the transmission behavior of this frame. */
#define FIFO_MGMT                 0
#define FIFO_HCCA                 1
#define FIFO_EDCA                 2

/* */
/* TXD Wireless Information format for Tx ring and Mgmt Ring */
/* */
/*txop : for txop mode */
/* 0:txop for the MPDU frame will be handles by ASIC by register */
/* 1/2/3:the MPDU frame is send after PIFS/backoff/SIFS */
struct PACKED rt_txwi {
	/* Word 0 */
	/* ex: 00 03 00 40 means txop = 3, PHYMODE = 1 */
	u32 FRAG:1;		/* 1 to inform TKIP engine this is a fragment. */
	u32 MIMOps:1;	/* the remote peer is in dynamic MIMO-PS mode */
	u32 CFACK:1;
	u32 TS:1;

	u32 AMPDU:1;
	u32 MpduDensity:3;
	u32 txop:2;		/*FOR "THIS" frame. 0:HT TXOP rule , 1:PIFS TX ,2:Backoff, 3:sifs only when previous frame exchange is successful. */
	u32 rsv:6;

	u32 MCS:7;
	u32 BW:1;		/*channel bandwidth 20MHz or 40 MHz */
	u32 ShortGI:1;
	u32 STBC:2;		/* 1: STBC support MCS =0-7,   2,3 : RESERVE */
	u32 Ifs:1;		/* */
/*      u32          rsv2:2; //channel bandwidth 20MHz or 40 MHz */
	u32 rsv2:1;
	u32 TxBF:1;		/* 3*3 */
	u32 PHYMODE:2;
	/* Word1 */
	/* ex:  1c ff 38 00 means ACK=0, BAWinSize=7, MPDUtotalByteCount = 0x38 */
	u32 ACK:1;
	u32 NSEQ:1;
	u32 BAWinSize:6;
	u32 WirelessCliID:8;
	u32 MPDUtotalByteCount:12;
	u32 PacketId:4;
	/*Word2 */
	u32 IV;
	/*Word3 */
	u32 EIV;
};

/* */
/* RXWI wireless information format, in PBF. invisible in driver. */
/* */
struct PACKED rt_rxwi {
	/* Word 0 */
	u32 WirelessCliID:8;
	u32 KeyIndex:2;
	u32 BSSID:3;
	u32 UDF:3;
	u32 MPDUtotalByteCount:12;
	u32 TID:4;
	/* Word 1 */
	u32 FRAG:4;
	u32 SEQUENCE:12;
	u32 MCS:7;
	u32 BW:1;
	u32 ShortGI:1;
	u32 STBC:2;
	u32 rsv:3;
	u32 PHYMODE:2;	/* 1: this RX frame is unicast to me */
	/*Word2 */
	u32 RSSI0:8;
	u32 RSSI1:8;
	u32 RSSI2:8;
	u32 rsv1:8;
	/*Word3 */
	u32 SNR0:8;
	u32 SNR1:8;
	u32 FOFFSET:8;	/* RT35xx */
	u32 rsv2:8;
	/*u32                rsv2:16; */
};

/* ================================================================================= */
/* Register format */
/* ================================================================================= */

/* */
/* SCH/DMA registers - base address 0x0200 */
/* */
/* INT_SOURCE_CSR: Interrupt source register. Write one to clear corresponding bit */
/* */
#define DMA_CSR0		0x200
#define INT_SOURCE_CSR		0x200
typedef union _INT_SOURCE_CSR_STRUC {
	struct {
		u32 RxDelayINT:1;
		u32 TxDelayINT:1;
		u32 RxDone:1;
		u32 Ac0DmaDone:1;	/*4 */
		u32 Ac1DmaDone:1;
		u32 Ac2DmaDone:1;
		u32 Ac3DmaDone:1;
		u32 HccaDmaDone:1;	/* bit7 */
		u32 MgmtDmaDone:1;
		u32 MCUCommandINT:1;	/*bit 9 */
		u32 RxTxCoherent:1;
		u32 TBTTInt:1;
		u32 PreTBTT:1;
		u32 TXFifoStatusInt:1;	/*FIFO Statistics is full, sw should read 0x171c */
		u32 AutoWakeup:1;	/*bit14 */
		u32 GPTimer:1;
		u32 RxCoherent:1;	/*bit16 */
		u32 TxCoherent:1;
		u32: 14;
	} field;
	u32 word;
} INT_SOURCE_CSR_STRUC, *PINT_SOURCE_CSR_STRUC;

/* */
/* INT_MASK_CSR:   Interrupt MASK register.   1: the interrupt is mask OFF */
/* */
#define INT_MASK_CSR        0x204
typedef union _INT_MASK_CSR_STRUC {
	struct {
		u32 RXDelay_INT_MSK:1;
		u32 TxDelay:1;
		u32 RxDone:1;
		u32 Ac0DmaDone:1;
		u32 Ac1DmaDone:1;
		u32 Ac2DmaDone:1;
		u32 Ac3DmaDone:1;
		u32 HccaDmaDone:1;
		u32 MgmtDmaDone:1;
		u32 MCUCommandINT:1;
		u32: 20;
		u32 RxCoherent:1;
		u32 TxCoherent:1;
	} field;
	u32 word;
} INT_MASK_CSR_STRUC, *PINT_MASK_CSR_STRUC;

#define WPDMA_GLO_CFG	0x208
typedef union _WPDMA_GLO_CFG_STRUC {
	struct {
		u32 EnableTxDMA:1;
		u32 TxDMABusy:1;
		u32 EnableRxDMA:1;
		u32 RxDMABusy:1;
		u32 WPDMABurstSIZE:2;
		u32 EnTXWriteBackDDONE:1;
		u32 BigEndian:1;
		u32 RXHdrScater:8;
		u32 HDR_SEG_LEN:16;
	} field;
	u32 word;
} WPDMA_GLO_CFG_STRUC, *PWPDMA_GLO_CFG_STRUC;

#define WPDMA_RST_IDX	0x20c
typedef union _WPDMA_RST_IDX_STRUC {
	struct {
		u32 RST_DTX_IDX0:1;
		u32 RST_DTX_IDX1:1;
		u32 RST_DTX_IDX2:1;
		u32 RST_DTX_IDX3:1;
		u32 RST_DTX_IDX4:1;
		u32 RST_DTX_IDX5:1;
		u32 rsv:10;
		u32 RST_DRX_IDX0:1;
		u32: 15;
	} field;
	u32 word;
} WPDMA_RST_IDX_STRUC, *PWPDMA_RST_IDX_STRUC;
#define DELAY_INT_CFG  0x0210
typedef union _DELAY_INT_CFG_STRUC {
	struct {
		u32 RXMAX_PTIME:8;
		u32 RXMAX_PINT:7;
		u32 RXDLY_INT_EN:1;
		u32 TXMAX_PTIME:8;
		u32 TXMAX_PINT:7;
		u32 TXDLY_INT_EN:1;
	} field;
	u32 word;
} DELAY_INT_CFG_STRUC, *PDELAY_INT_CFG_STRUC;
#define WMM_AIFSN_CFG   0x0214
typedef union _AIFSN_CSR_STRUC {
	struct {
		u32 Aifsn0:4;	/* for AC_BE */
		u32 Aifsn1:4;	/* for AC_BK */
		u32 Aifsn2:4;	/* for AC_VI */
		u32 Aifsn3:4;	/* for AC_VO */
		u32 Rsv:16;
	} field;
	u32 word;
} AIFSN_CSR_STRUC, *PAIFSN_CSR_STRUC;
/* */
/* CWMIN_CSR: CWmin for each EDCA AC */
/* */
#define WMM_CWMIN_CFG   0x0218
typedef union _CWMIN_CSR_STRUC {
	struct {
		u32 Cwmin0:4;	/* for AC_BE */
		u32 Cwmin1:4;	/* for AC_BK */
		u32 Cwmin2:4;	/* for AC_VI */
		u32 Cwmin3:4;	/* for AC_VO */
		u32 Rsv:16;
	} field;
	u32 word;
} CWMIN_CSR_STRUC, *PCWMIN_CSR_STRUC;

/* */
/* CWMAX_CSR: CWmin for each EDCA AC */
/* */
#define WMM_CWMAX_CFG   0x021c
typedef union _CWMAX_CSR_STRUC {
	struct {
		u32 Cwmax0:4;	/* for AC_BE */
		u32 Cwmax1:4;	/* for AC_BK */
		u32 Cwmax2:4;	/* for AC_VI */
		u32 Cwmax3:4;	/* for AC_VO */
		u32 Rsv:16;
	} field;
	u32 word;
} CWMAX_CSR_STRUC, *PCWMAX_CSR_STRUC;

/* */
/* AC_TXOP_CSR0: AC_BK/AC_BE TXOP register */
/* */
#define WMM_TXOP0_CFG    0x0220
typedef union _AC_TXOP_CSR0_STRUC {
	struct {
		u16 Ac0Txop;	/* for AC_BK, in unit of 32us */
		u16 Ac1Txop;	/* for AC_BE, in unit of 32us */
	} field;
	u32 word;
} AC_TXOP_CSR0_STRUC, *PAC_TXOP_CSR0_STRUC;

/* */
/* AC_TXOP_CSR1: AC_VO/AC_VI TXOP register */
/* */
#define WMM_TXOP1_CFG    0x0224
typedef union _AC_TXOP_CSR1_STRUC {
	struct {
		u16 Ac2Txop;	/* for AC_VI, in unit of 32us */
		u16 Ac3Txop;	/* for AC_VO, in unit of 32us */
	} field;
	u32 word;
} AC_TXOP_CSR1_STRUC, *PAC_TXOP_CSR1_STRUC;

#define RINGREG_DIFF			0x10
#define GPIO_CTRL_CFG    0x0228	/*MAC_CSR13 */
#define MCU_CMD_CFG    0x022c
#define TX_BASE_PTR0     0x0230	/*AC_BK base address */
#define TX_MAX_CNT0      0x0234
#define TX_CTX_IDX0       0x0238
#define TX_DTX_IDX0      0x023c
#define TX_BASE_PTR1     0x0240	/*AC_BE base address */
#define TX_MAX_CNT1      0x0244
#define TX_CTX_IDX1       0x0248
#define TX_DTX_IDX1      0x024c
#define TX_BASE_PTR2     0x0250	/*AC_VI base address */
#define TX_MAX_CNT2      0x0254
#define TX_CTX_IDX2       0x0258
#define TX_DTX_IDX2      0x025c
#define TX_BASE_PTR3     0x0260	/*AC_VO base address */
#define TX_MAX_CNT3      0x0264
#define TX_CTX_IDX3       0x0268
#define TX_DTX_IDX3      0x026c
#define TX_BASE_PTR4     0x0270	/*HCCA base address */
#define TX_MAX_CNT4      0x0274
#define TX_CTX_IDX4       0x0278
#define TX_DTX_IDX4      0x027c
#define TX_BASE_PTR5     0x0280	/*MGMT base address */
#define  TX_MAX_CNT5     0x0284
#define TX_CTX_IDX5       0x0288
#define TX_DTX_IDX5      0x028c
#define TX_MGMTMAX_CNT      TX_MAX_CNT5
#define TX_MGMTCTX_IDX       TX_CTX_IDX5
#define TX_MGMTDTX_IDX      TX_DTX_IDX5
#define RX_BASE_PTR     0x0290	/*RX base address */
#define RX_MAX_CNT      0x0294
#define RX_CRX_IDX       0x0298
#define RX_DRX_IDX      0x029c

#define USB_DMA_CFG      0x02a0
typedef union _USB_DMA_CFG_STRUC {
	struct {
		u32 RxBulkAggTOut:8;	/*Rx Bulk Aggregation TimeOut  in unit of 33ns */
		u32 RxBulkAggLmt:8;	/*Rx Bulk Aggregation Limit  in unit of 256 bytes */
		u32 phyclear:1;	/*phy watch dog enable. write 1 */
		u32 rsv:2;
		u32 TxClear:1;	/*Clear USB DMA TX path */
		u32 TxopHalt:1;	/*Halt TXOP count down when TX buffer is full. */
		u32 RxBulkAggEn:1;	/*Enable Rx Bulk Aggregation */
		u32 RxBulkEn:1;	/*Enable USB DMA Rx */
		u32 TxBulkEn:1;	/*Enable USB DMA Tx */
		u32 EpoutValid:6;	/*OUT endpoint data valid */
		u32 RxBusy:1;	/*USB DMA RX FSM busy */
		u32 TxBusy:1;	/*USB DMA TX FSM busy */
	} field;
	u32 word;
} USB_DMA_CFG_STRUC, *PUSB_DMA_CFG_STRUC;

/* */
/*  3  PBF  registers */
/* */
/* */
/* Most are for debug. Driver doesn't touch PBF register. */
#define PBF_SYS_CTRL	 0x0400
#define PBF_CFG                 0x0408
#define PBF_MAX_PCNT	 0x040C
#define PBF_CTRL		0x0410
#define PBF_INT_STA	 0x0414
#define PBF_INT_ENA	 0x0418
#define TXRXQ_PCNT	 0x0438
#define PBF_DBG			 0x043c
#define PBF_CAP_CTRL     0x0440

#ifdef RT30xx
#ifdef RTMP_EFUSE_SUPPORT
/* eFuse registers */
#define EFUSE_CTRL				0x0580
#define EFUSE_DATA0				0x0590
#define EFUSE_DATA1				0x0594
#define EFUSE_DATA2				0x0598
#define EFUSE_DATA3				0x059c
#endif /* RTMP_EFUSE_SUPPORT // */
#endif /* RT30xx // */

#define OSC_CTRL		0x5a4
#define PCIE_PHY_TX_ATTENUATION_CTRL	0x05C8
#define LDO_CFG0				0x05d4
#define GPIO_SWITCH				0x05dc

/* */
/*  4  MAC  registers */
/* */
/* */
/*  4.1 MAC SYSTEM  configuration registers (offset:0x1000) */
/* */
#define MAC_CSR0            0x1000
typedef union _ASIC_VER_ID_STRUC {
	struct {
		u16 ASICRev;	/* reversion  : 0 */
		u16 ASICVer;	/* version : 2860 */
	} field;
	u32 word;
} ASIC_VER_ID_STRUC, *PASIC_VER_ID_STRUC;
#define MAC_SYS_CTRL            0x1004	/*MAC_CSR1 */
#define MAC_ADDR_DW0				0x1008	/* MAC ADDR DW0 */
#define MAC_ADDR_DW1			 0x100c	/* MAC ADDR DW1 */
/* */
/* MAC_CSR2: STA MAC register 0 */
/* */
typedef union _MAC_DW0_STRUC {
	struct {
		u8 Byte0;	/* MAC address byte 0 */
		u8 Byte1;	/* MAC address byte 1 */
		u8 Byte2;	/* MAC address byte 2 */
		u8 Byte3;	/* MAC address byte 3 */
	} field;
	u32 word;
} MAC_DW0_STRUC, *PMAC_DW0_STRUC;

/* */
/* MAC_CSR3: STA MAC register 1 */
/* */
typedef union _MAC_DW1_STRUC {
	struct {
		u8 Byte4;	/* MAC address byte 4 */
		u8 Byte5;	/* MAC address byte 5 */
		u8 U2MeMask;
		u8 Rsvd1;
	} field;
	u32 word;
} MAC_DW1_STRUC, *PMAC_DW1_STRUC;

#define MAC_BSSID_DW0				0x1010	/* MAC BSSID DW0 */
#define MAC_BSSID_DW1				0x1014	/* MAC BSSID DW1 */

/* */
/* MAC_CSR5: BSSID register 1 */
/* */
typedef union _MAC_CSR5_STRUC {
	struct {
		u8 Byte4;	/* BSSID byte 4 */
		u8 Byte5;	/* BSSID byte 5 */
		u16 BssIdMask:2;	/* 0: one BSSID, 10: 4 BSSID,  01: 2 BSSID , 11: 8BSSID */
		u16 MBssBcnNum:3;
		u16 Rsvd:11;
	} field;
	u32 word;
} MAC_CSR5_STRUC, *PMAC_CSR5_STRUC;

#define MAX_LEN_CFG              0x1018	/* rt2860b max 16k bytes. bit12:13 Maximum PSDU length (power factor) 0:2^13, 1:2^14, 2:2^15, 3:2^16 */
#define BBP_CSR_CFG			0x101c	/* */
/* */
/* BBP_CSR_CFG: BBP serial control register */
/* */
typedef union _BBP_CSR_CFG_STRUC {
	struct {
		u32 Value:8;	/* Register     value to program into BBP */
		u32 RegNum:8;	/* Selected     BBP     register */
		u32 fRead:1;	/* 0: Write BBP, 1: Read BBP */
		u32 Busy:1;	/* 1: ASIC is busy execute BBP programming. */
		u32 BBP_PAR_DUR:1;	/* 0: 4 MAC clock cycles  1: 8 MAC clock cycles */
		u32 BBP_RW_MODE:1;	/* 0: use serial mode  1:parallel */
		u32: 12;
	} field;
	u32 word;
} BBP_CSR_CFG_STRUC, *PBBP_CSR_CFG_STRUC;
#define RF_CSR_CFG0			0x1020
/* */
/* RF_CSR_CFG: RF control register */
/* */
typedef union _RF_CSR_CFG0_STRUC {
	struct {
		u32 RegIdAndContent:24;	/* Register value to program into BBP */
		u32 bitwidth:5;	/* Selected BBP register */
		u32 StandbyMode:1;	/* 0: high when stand by 1: low when standby */
		u32 Sel:1;	/* 0:RF_LE0 activate  1:RF_LE1 activate */
		u32 Busy:1;	/* 0: idle 1: 8busy */
	} field;
	u32 word;
} RF_CSR_CFG0_STRUC, *PRF_CSR_CFG0_STRUC;
#define RF_CSR_CFG1			0x1024
typedef union _RF_CSR_CFG1_STRUC {
	struct {
		u32 RegIdAndContent:24;	/* Register value to program into BBP */
		u32 RFGap:5;	/* Gap between BB_CONTROL_RF and RF_LE. 0: 3 system clock cycle (37.5usec) 1: 5 system clock cycle (62.5usec) */
		u32 rsv:7;	/* 0: idle 1: 8busy */
	} field;
	u32 word;
} RF_CSR_CFG1_STRUC, *PRF_CSR_CFG1_STRUC;
#define RF_CSR_CFG2			0x1028	/* */
typedef union _RF_CSR_CFG2_STRUC {
	struct {
		u32 RegIdAndContent:24;	/* Register value to program into BBP */
		u32 rsv:8;	/* 0: idle 1: 8busy */
	} field;
	u32 word;
} RF_CSR_CFG2_STRUC, *PRF_CSR_CFG2_STRUC;
#define LED_CFG				0x102c	/*  MAC_CSR14 */
typedef union _LED_CFG_STRUC {
	struct {
		u32 OnPeriod:8;	/* blinking on period unit 1ms */
		u32 OffPeriod:8;	/* blinking off period unit 1ms */
		u32 SlowBlinkPeriod:6;	/* slow blinking period. unit:1ms */
		u32 rsv:2;
		u32 RLedMode:2;	/* red Led Mode 0: off1: blinking upon TX2: periodic slow blinking3: always on */
		u32 GLedMode:2;	/* green Led Mode */
		u32 YLedMode:2;	/* yellow Led Mode */
		u32 LedPolar:1;	/* Led Polarity.  0: active low1: active high */
		u32: 1;
	} field;
	u32 word;
} LED_CFG_STRUC, *PLED_CFG_STRUC;
/* */
/*  4.2 MAC TIMING  configuration registers (offset:0x1100) */
/* */
#define XIFS_TIME_CFG             0x1100	/* MAC_CSR8  MAC_CSR9 */
typedef union _IFS_SLOT_CFG_STRUC {
	struct {
		u32 CckmSifsTime:8;	/*  unit 1us. Applied after CCK RX/TX */
		u32 OfdmSifsTime:8;	/*  unit 1us. Applied after OFDM RX/TX */
		u32 OfdmXifsTime:4;	/*OFDM SIFS. unit 1us. Applied after OFDM RX when MAC doesn't reference BBP signal BBRXEND */
		u32 EIFS:9;	/*  unit 1us */
		u32 BBRxendEnable:1;	/*  reference RXEND signal to begin XIFS defer */
		u32 rsv:2;
	} field;
	u32 word;
} IFS_SLOT_CFG_STRUC, *PIFS_SLOT_CFG_STRUC;

#define BKOFF_SLOT_CFG             0x1104	/*  mac_csr9 last 8 bits */
#define NAV_TIME_CFG             0x1108	/* NAV  (MAC_CSR15) */
#define CH_TIME_CFG             0x110C	/* Count as channel busy */
#define PBF_LIFE_TIMER             0x1110	/*TX/RX MPDU timestamp timer (free run)Unit: 1us */
#define BCN_TIME_CFG             0x1114	/* TXRX_CSR9 */

#define BCN_OFFSET0				0x042C
#define BCN_OFFSET1				0x0430

/* */
/* BCN_TIME_CFG : Synchronization control register */
/* */
typedef union _BCN_TIME_CFG_STRUC {
	struct {
		u32 BeaconInterval:16;	/* in unit of 1/16 TU */
		u32 bTsfTicking:1;	/* Enable TSF auto counting */
		u32 TsfSyncMode:2;	/* Enable TSF sync, 00: disable, 01: infra mode, 10: ad-hoc mode */
		u32 bTBTTEnable:1;
		u32 bBeaconGen:1;	/* Enable beacon generator */
		u32: 3;
		u32 TxTimestampCompensate:8;
	} field;
	u32 word;
} BCN_TIME_CFG_STRUC, *PBCN_TIME_CFG_STRUC;
#define TBTT_SYNC_CFG            0x1118	/* txrx_csr10 */
#define TSF_TIMER_DW0             0x111C	/* Local TSF timer lsb 32 bits. Read-only */
#define TSF_TIMER_DW1             0x1120	/* msb 32 bits. Read-only. */
#define TBTT_TIMER		0x1124	/* TImer remains till next TBTT. Read-only.  TXRX_CSR14 */
#define INT_TIMER_CFG			0x1128	/* */
#define INT_TIMER_EN			0x112c	/*  GP-timer and pre-tbtt Int enable */
#define CH_IDLE_STA			0x1130	/*  channel idle time */
#define CH_BUSY_STA			0x1134	/*  channle busy time */
/* */
/*  4.2 MAC POWER  configuration registers (offset:0x1200) */
/* */
#define MAC_STATUS_CFG             0x1200	/* old MAC_CSR12 */
#define PWR_PIN_CFG             0x1204	/* old MAC_CSR12 */
#define AUTO_WAKEUP_CFG             0x1208	/* old MAC_CSR10 */
/* */
/* AUTO_WAKEUP_CFG: Manual power control / status register */
/* */
typedef union _AUTO_WAKEUP_STRUC {
	struct {
		u32 AutoLeadTime:8;
		u32 NumofSleepingTbtt:7;	/* ForceWake has high privilege than PutToSleep when both set */
		u32 EnableAutoWakeup:1;	/* 0:sleep, 1:awake */
		u32: 16;
	} field;
	u32 word;
} AUTO_WAKEUP_STRUC, *PAUTO_WAKEUP_STRUC;
/* */
/*  4.3 MAC TX  configuration registers (offset:0x1300) */
/* */

#define EDCA_AC0_CFG	0x1300	/*AC_TXOP_CSR0 0x3474 */
#define EDCA_AC1_CFG	0x1304
#define EDCA_AC2_CFG	0x1308
#define EDCA_AC3_CFG	0x130c
typedef union _EDCA_AC_CFG_STRUC {
	struct {
		u32 AcTxop:8;	/*  in unit of 32us */
		u32 Aifsn:4;	/* # of slot time */
		u32 Cwmin:4;	/* */
		u32 Cwmax:4;	/*unit power of 2 */
		u32: 12;	/* */
	} field;
	u32 word;
} EDCA_AC_CFG_STRUC, *PEDCA_AC_CFG_STRUC;

#define EDCA_TID_AC_MAP	0x1310
#define TX_PWR_CFG_0	0x1314
#define TX_PWR_CFG_1	0x1318
#define TX_PWR_CFG_2	0x131C
#define TX_PWR_CFG_3	0x1320
#define TX_PWR_CFG_4	0x1324
#define TX_PIN_CFG		0x1328
#define TX_BAND_CFG	0x132c	/* 0x1 use upper 20MHz. 0 juse lower 20MHz */
#define TX_SW_CFG0		0x1330
#define TX_SW_CFG1		0x1334
#define TX_SW_CFG2		0x1338
#define TXOP_THRES_CFG		0x133c
#define TXOP_CTRL_CFG		0x1340
#define TX_RTS_CFG		0x1344

typedef union _TX_RTS_CFG_STRUC {
	struct {
		u32 AutoRtsRetryLimit:8;
		u32 RtsThres:16;	/* unit:byte */
		u32 RtsFbkEn:1;	/* enable rts rate fallback */
		u32 rsv:7;	/* 1: HT non-STBC control frame enable */
	} field;
	u32 word;
} TX_RTS_CFG_STRUC, *PTX_RTS_CFG_STRUC;
#define TX_TIMEOUT_CFG	0x1348
typedef union _TX_TIMEOUT_CFG_STRUC {
	struct {
		u32 rsv:4;
		u32 MpduLifeTime:4;	/*  expiration time = 2^(9+MPDU LIFE TIME)  us */
		u32 RxAckTimeout:8;	/* unit:slot. Used for TX precedure */
		u32 TxopTimeout:8;	/*TXOP timeout value for TXOP truncation.  It is recommended that (SLOT_TIME) > (TX_OP_TIMEOUT) > (RX_ACK_TIMEOUT) */
		u32 rsv2:8;	/* 1: HT non-STBC control frame enable */
	} field;
	u32 word;
} TX_TIMEOUT_CFG_STRUC, *PTX_TIMEOUT_CFG_STRUC;
#define TX_RTY_CFG	0x134c
typedef union PACKED _TX_RTY_CFG_STRUC {
	struct {
		u32 ShortRtyLimit:8;	/* short retry limit */
		u32 LongRtyLimit:8;	/* long retry limit */
		u32 LongRtyThre:12;	/* Long retry threshold */
		u32 NonAggRtyMode:1;	/* Non-Aggregate MPDU retry mode.  0:expired by retry limit, 1: expired by mpdu life timer */
		u32 AggRtyMode:1;	/* Aggregate MPDU retry mode.  0:expired by retry limit, 1: expired by mpdu life timer */
		u32 TxautoFBEnable:1;	/* Tx retry PHY rate auto fallback enable */
		u32 rsv:1;	/* 1: HT non-STBC control frame enable */
	} field;
	u32 word;
} TX_RTY_CFG_STRUC, *PTX_RTY_CFG_STRUC;
#define TX_LINK_CFG	0x1350
typedef union PACKED _TX_LINK_CFG_STRUC {
	struct PACKED {
		u32 RemoteMFBLifeTime:8;	/*remote MFB life time. unit : 32us */
		u32 MFBEnable:1;	/*  TX apply remote MFB 1:enable */
		u32 RemoteUMFSEnable:1;	/*  remote unsolicit  MFB enable.  0: not apply remote remote unsolicit (MFS=7) */
		u32 TxMRQEn:1;	/*  MCS request TX enable */
		u32 TxRDGEn:1;	/* RDG TX enable */
		u32 TxCFAckEn:1;	/*   Piggyback CF-ACK enable */
		u32 rsv:3;	/* */
		u32 RemotMFB:8;	/*  remote MCS feedback */
		u32 RemotMFS:8;	/*remote MCS feedback sequence number */
	} field;
	u32 word;
} TX_LINK_CFG_STRUC, *PTX_LINK_CFG_STRUC;
#define HT_FBK_CFG0	0x1354
typedef union PACKED _HT_FBK_CFG0_STRUC {
	struct {
		u32 HTMCS0FBK:4;
		u32 HTMCS1FBK:4;
		u32 HTMCS2FBK:4;
		u32 HTMCS3FBK:4;
		u32 HTMCS4FBK:4;
		u32 HTMCS5FBK:4;
		u32 HTMCS6FBK:4;
		u32 HTMCS7FBK:4;
	} field;
	u32 word;
} HT_FBK_CFG0_STRUC, *PHT_FBK_CFG0_STRUC;
#define HT_FBK_CFG1	0x1358
typedef union _HT_FBK_CFG1_STRUC {
	struct {
		u32 HTMCS8FBK:4;
		u32 HTMCS9FBK:4;
		u32 HTMCS10FBK:4;
		u32 HTMCS11FBK:4;
		u32 HTMCS12FBK:4;
		u32 HTMCS13FBK:4;
		u32 HTMCS14FBK:4;
		u32 HTMCS15FBK:4;
	} field;
	u32 word;
} HT_FBK_CFG1_STRUC, *PHT_FBK_CFG1_STRUC;
#define LG_FBK_CFG0	0x135c
typedef union _LG_FBK_CFG0_STRUC {
	struct {
		u32 OFDMMCS0FBK:4;	/*initial value is 0 */
		u32 OFDMMCS1FBK:4;	/*initial value is 0 */
		u32 OFDMMCS2FBK:4;	/*initial value is 1 */
		u32 OFDMMCS3FBK:4;	/*initial value is 2 */
		u32 OFDMMCS4FBK:4;	/*initial value is 3 */
		u32 OFDMMCS5FBK:4;	/*initial value is 4 */
		u32 OFDMMCS6FBK:4;	/*initial value is 5 */
		u32 OFDMMCS7FBK:4;	/*initial value is 6 */
	} field;
	u32 word;
} LG_FBK_CFG0_STRUC, *PLG_FBK_CFG0_STRUC;
#define LG_FBK_CFG1		0x1360
typedef union _LG_FBK_CFG1_STRUC {
	struct {
		u32 CCKMCS0FBK:4;	/*initial value is 0 */
		u32 CCKMCS1FBK:4;	/*initial value is 0 */
		u32 CCKMCS2FBK:4;	/*initial value is 1 */
		u32 CCKMCS3FBK:4;	/*initial value is 2 */
		u32 rsv:16;
	} field;
	u32 word;
} LG_FBK_CFG1_STRUC, *PLG_FBK_CFG1_STRUC;

/*======================================================= */
/*================ Protection Paramater================================ */
/*======================================================= */
#define CCK_PROT_CFG	0x1364	/*CCK Protection */
#define ASIC_SHORTNAV		1
#define ASIC_longNAV		2
#define ASIC_RTS		1
#define ASIC_CTS		2
typedef union _PROT_CFG_STRUC {
	struct {
		u32 ProtectRate:16;	/*Protection control frame rate for CCK TX(RTS/CTS/CFEnd). */
		u32 ProtectCtrl:2;	/*Protection control frame type for CCK TX. 1:RTS/CTS, 2:CTS-to-self, 0:None, 3:rsv */
		u32 ProtectNav:2;	/*TXOP protection type for CCK TX. 0:None, 1:ShortNAVprotect,  2:LongNAVProtect, 3:rsv */
		u32 TxopAllowCck:1;	/*CCK TXOP allowance.0:disallow. */
		u32 TxopAllowOfdm:1;	/*CCK TXOP allowance.0:disallow. */
		u32 TxopAllowMM20:1;	/*CCK TXOP allowance. 0:disallow. */
		u32 TxopAllowMM40:1;	/*CCK TXOP allowance.0:disallow. */
		u32 TxopAllowGF20:1;	/*CCK TXOP allowance.0:disallow. */
		u32 TxopAllowGF40:1;	/*CCK TXOP allowance.0:disallow. */
		u32 RTSThEn:1;	/*RTS threshold enable on CCK TX */
		u32 rsv:5;
	} field;
	u32 word;
} PROT_CFG_STRUC, *PPROT_CFG_STRUC;

#define OFDM_PROT_CFG	0x1368	/*OFDM Protection */
#define MM20_PROT_CFG	0x136C	/*MM20 Protection */
#define MM40_PROT_CFG	0x1370	/*MM40 Protection */
#define GF20_PROT_CFG	0x1374	/*GF20 Protection */
#define GF40_PROT_CFG	0x1378	/*GR40 Protection */
#define EXP_CTS_TIME	0x137C	/* */
#define EXP_ACK_TIME	0x1380	/* */

/* */
/*  4.4 MAC RX configuration registers (offset:0x1400) */
/* */
#define RX_FILTR_CFG	0x1400	/*TXRX_CSR0 */
#define AUTO_RSP_CFG	0x1404	/*TXRX_CSR4 */
/* */
/* TXRX_CSR4: Auto-Responder/ */
/* */
typedef union _AUTO_RSP_CFG_STRUC {
	struct {
		u32 AutoResponderEnable:1;
		u32 BACAckPolicyEnable:1;	/* 0:long, 1:short preamble */
		u32 CTS40MMode:1;	/* Response CTS 40MHz duplicate mode */
		u32 CTS40MRef:1;	/* Response CTS 40MHz duplicate mode */
		u32 AutoResponderPreamble:1;	/* 0:long, 1:short preamble */
		u32 rsv:1;	/* Power bit value in conrtrol frame */
		u32 DualCTSEn:1;	/* Power bit value in conrtrol frame */
		u32 AckCtsPsmBit:1;	/* Power bit value in conrtrol frame */
		u32: 24;
	} field;
	u32 word;
} AUTO_RSP_CFG_STRUC, *PAUTO_RSP_CFG_STRUC;

#define LEGACY_BASIC_RATE	0x1408	/*  TXRX_CSR5           0x3054 */
#define HT_BASIC_RATE		0x140c
#define HT_CTRL_CFG		0x1410
#define SIFS_COST_CFG		0x1414
#define RX_PARSER_CFG		0x1418	/*Set NAV for all received frames */

/* */
/*  4.5 MAC Security configuration (offset:0x1500) */
/* */
#define TX_SEC_CNT0		0x1500	/* */
#define RX_SEC_CNT0		0x1504	/* */
#define CCMP_FC_MUTE		0x1508	/* */
/* */
/*  4.6 HCCA/PSMP (offset:0x1600) */
/* */
#define TXOP_HLDR_ADDR0		0x1600
#define TXOP_HLDR_ADDR1		0x1604
#define TXOP_HLDR_ET		0x1608
#define QOS_CFPOLL_RA_DW0		0x160c
#define QOS_CFPOLL_A1_DW1		0x1610
#define QOS_CFPOLL_QC		0x1614
/* */
/*  4.7 MAC Statistis registers (offset:0x1700) */
/* */
#define RX_STA_CNT0		0x1700	/* */
#define RX_STA_CNT1		0x1704	/* */
#define RX_STA_CNT2		0x1708	/* */

/* */
/* RX_STA_CNT0_STRUC: RX PLCP error count & RX CRC error count */
/* */
typedef union _RX_STA_CNT0_STRUC {
	struct {
		u16 CrcErr;
		u16 PhyErr;
	} field;
	u32 word;
} RX_STA_CNT0_STRUC, *PRX_STA_CNT0_STRUC;

/* */
/* RX_STA_CNT1_STRUC: RX False CCA count & RX long frame count */
/* */
typedef union _RX_STA_CNT1_STRUC {
	struct {
		u16 FalseCca;
		u16 PlcpErr;
	} field;
	u32 word;
} RX_STA_CNT1_STRUC, *PRX_STA_CNT1_STRUC;

/* */
/* RX_STA_CNT2_STRUC: */
/* */
typedef union _RX_STA_CNT2_STRUC {
	struct {
		u16 RxDupliCount;
		u16 RxFifoOverflowCount;
	} field;
	u32 word;
} RX_STA_CNT2_STRUC, *PRX_STA_CNT2_STRUC;
#define TX_STA_CNT0		0x170C	/* */
/* */
/* STA_CSR3: TX Beacon count */
/* */
typedef union _TX_STA_CNT0_STRUC {
	struct {
		u16 TxFailCount;
		u16 TxBeaconCount;
	} field;
	u32 word;
} TX_STA_CNT0_STRUC, *PTX_STA_CNT0_STRUC;
#define TX_STA_CNT1		0x1710	/* */
/* */
/* TX_STA_CNT1: TX tx count */
/* */
typedef union _TX_STA_CNT1_STRUC {
	struct {
		u16 TxSuccess;
		u16 TxRetransmit;
	} field;
	u32 word;
} TX_STA_CNT1_STRUC, *PTX_STA_CNT1_STRUC;
#define TX_STA_CNT2		0x1714	/* */
/* */
/* TX_STA_CNT2: TX tx count */
/* */
typedef union _TX_STA_CNT2_STRUC {
	struct {
		u16 TxZeroLenCount;
		u16 TxUnderFlowCount;
	} field;
	u32 word;
} TX_STA_CNT2_STRUC, *PTX_STA_CNT2_STRUC;
#define TX_STA_FIFO		0x1718	/* */
/* */
/* TX_STA_FIFO_STRUC: TX Result for specific PID status fifo register */
/* */
typedef union PACKED _TX_STA_FIFO_STRUC {
	struct {
		u32 bValid:1;	/* 1:This register contains a valid TX result */
		u32 PidType:4;
		u32 TxSuccess:1;	/* Tx No retry success */
		u32 TxAggre:1;	/* Tx Retry Success */
		u32 TxAckRequired:1;	/* Tx fail */
		u32 wcid:8;	/*wireless client index */
/*              u32          SuccessRate:16; //include MCS, mode ,shortGI, BW settingSame format as TXWI Word 0 Bit 31-16. */
		u32 SuccessRate:13;	/*include MCS, mode ,shortGI, BW settingSame format as TXWI Word 0 Bit 31-16. */
		u32 TxBF:1;
		u32 Reserve:2;
	} field;
	u32 word;
} TX_STA_FIFO_STRUC, *PTX_STA_FIFO_STRUC;
/* Debug counter */
#define TX_AGG_CNT	0x171c
typedef union _TX_AGG_CNT_STRUC {
	struct {
		u16 NonAggTxCount;
		u16 AggTxCount;
	} field;
	u32 word;
} TX_AGG_CNT_STRUC, *PTX_AGG_CNT_STRUC;
/* Debug counter */
#define TX_AGG_CNT0	0x1720
typedef union _TX_AGG_CNT0_STRUC {
	struct {
		u16 AggSize1Count;
		u16 AggSize2Count;
	} field;
	u32 word;
} TX_AGG_CNT0_STRUC, *PTX_AGG_CNT0_STRUC;
/* Debug counter */
#define TX_AGG_CNT1	0x1724
typedef union _TX_AGG_CNT1_STRUC {
	struct {
		u16 AggSize3Count;
		u16 AggSize4Count;
	} field;
	u32 word;
} TX_AGG_CNT1_STRUC, *PTX_AGG_CNT1_STRUC;
#define TX_AGG_CNT2	0x1728
typedef union _TX_AGG_CNT2_STRUC {
	struct {
		u16 AggSize5Count;
		u16 AggSize6Count;
	} field;
	u32 word;
} TX_AGG_CNT2_STRUC, *PTX_AGG_CNT2_STRUC;
/* Debug counter */
#define TX_AGG_CNT3	0x172c
typedef union _TX_AGG_CNT3_STRUC {
	struct {
		u16 AggSize7Count;
		u16 AggSize8Count;
	} field;
	u32 word;
} TX_AGG_CNT3_STRUC, *PTX_AGG_CNT3_STRUC;
/* Debug counter */
#define TX_AGG_CNT4	0x1730
typedef union _TX_AGG_CNT4_STRUC {
	struct {
		u16 AggSize9Count;
		u16 AggSize10Count;
	} field;
	u32 word;
} TX_AGG_CNT4_STRUC, *PTX_AGG_CNT4_STRUC;
#define TX_AGG_CNT5	0x1734
typedef union _TX_AGG_CNT5_STRUC {
	struct {
		u16 AggSize11Count;
		u16 AggSize12Count;
	} field;
	u32 word;
} TX_AGG_CNT5_STRUC, *PTX_AGG_CNT5_STRUC;
#define TX_AGG_CNT6		0x1738
typedef union _TX_AGG_CNT6_STRUC {
	struct {
		u16 AggSize13Count;
		u16 AggSize14Count;
	} field;
	u32 word;
} TX_AGG_CNT6_STRUC, *PTX_AGG_CNT6_STRUC;
#define TX_AGG_CNT7		0x173c
typedef union _TX_AGG_CNT7_STRUC {
	struct {
		u16 AggSize15Count;
		u16 AggSize16Count;
	} field;
	u32 word;
} TX_AGG_CNT7_STRUC, *PTX_AGG_CNT7_STRUC;
#define MPDU_DENSITY_CNT		0x1740
typedef union _MPDU_DEN_CNT_STRUC {
	struct {
		u16 TXZeroDelCount;	/*TX zero length delimiter count */
		u16 RXZeroDelCount;	/*RX zero length delimiter count */
	} field;
	u32 word;
} MPDU_DEN_CNT_STRUC, *PMPDU_DEN_CNT_STRUC;
/* */
/* TXRX control registers - base address 0x3000 */
/* */
/* rt2860b  UNKNOWN reg use R/O Reg Addr 0x77d0 first.. */
#define TXRX_CSR1           0x77d0

/* */
/* Security key table memory, base address = 0x1000 */
/* */
#define MAC_WCID_BASE		0x1800	/*8-bytes(use only 6-bytes) * 256 entry = */
#define HW_WCID_ENTRY_SIZE   8
#define PAIRWISE_KEY_TABLE_BASE     0x4000	/* 32-byte * 256-entry =  -byte */
#define HW_KEY_ENTRY_SIZE           0x20
#define PAIRWISE_IVEIV_TABLE_BASE     0x6000	/* 8-byte * 256-entry =  -byte */
#define MAC_IVEIV_TABLE_BASE     0x6000	/* 8-byte * 256-entry =  -byte */
#define HW_IVEIV_ENTRY_SIZE   8
#define MAC_WCID_ATTRIBUTE_BASE     0x6800	/* 4-byte * 256-entry =  -byte */
#define HW_WCID_ATTRI_SIZE   4
#define WCID_RESERVED			0x6bfc
#define SHARED_KEY_TABLE_BASE       0x6c00	/* 32-byte * 16-entry = 512-byte */
#define SHARED_KEY_MODE_BASE       0x7000	/* 32-byte * 16-entry = 512-byte */
#define HW_SHARED_KEY_MODE_SIZE   4
#define SHAREDKEYTABLE			0
#define PAIRWISEKEYTABLE			1

typedef union _SHAREDKEY_MODE_STRUC {
	struct {
		u32 Bss0Key0CipherAlg:3;
		u32: 1;
		u32 Bss0Key1CipherAlg:3;
		u32: 1;
		u32 Bss0Key2CipherAlg:3;
		u32: 1;
		u32 Bss0Key3CipherAlg:3;
		u32: 1;
		u32 Bss1Key0CipherAlg:3;
		u32: 1;
		u32 Bss1Key1CipherAlg:3;
		u32: 1;
		u32 Bss1Key2CipherAlg:3;
		u32: 1;
		u32 Bss1Key3CipherAlg:3;
		u32: 1;
	} field;
	u32 word;
} SHAREDKEY_MODE_STRUC, *PSHAREDKEY_MODE_STRUC;

/* 8-byte per entry, 64-entry for pairwise key table */
struct rt_hw_wcid_entry {
	u8 Address[6];
	u8 Rsv[2];
};

/* ================================================================================= */
/* WCID  format */
/* ================================================================================= */
/*7.1   WCID  ENTRY  format  : 8bytes */
struct rt_wcid_entry {
	u8 RXBABitmap7;	/* bit0 for TID8, bit7 for TID 15 */
	u8 RXBABitmap0;	/* bit0 for TID0, bit7 for TID 7 */
	u8 MAC[6];		/* 0 for shared key table.  1 for pairwise key table */
};

/*8.1.1 SECURITY  KEY  format  : 8DW */
/* 32-byte per entry, total 16-entry for shared key table, 64-entry for pairwise key table */
struct rt_hw_key_entry {
	u8 Key[16];
	u8 TxMic[8];
	u8 RxMic[8];
};

/*8.1.2 IV/EIV  format  : 2DW */

/*8.1.3 RX attribute entry format  : 1DW */
struct rt_mac_attribute {
	u32 KeyTab:1;	/* 0 for shared key table.  1 for pairwise key table */
	u32 PairKeyMode:3;
	u32 BSSIDIdx:3;	/*multipleBSS index for the WCID */
	u32 RXWIUDF:3;
	u32 rsv:22;
};

/* ================================================================================= */
/* HOST-MCU communication data structure */
/* ================================================================================= */

/* */
/* H2M_MAILBOX_CSR: Host-to-MCU Mailbox */
/* */
typedef union _H2M_MAILBOX_STRUC {
	struct {
		u32 LowByte:8;
		u32 HighByte:8;
		u32 CmdToken:8;
		u32 Owner:8;
	} field;
	u32 word;
} H2M_MAILBOX_STRUC, *PH2M_MAILBOX_STRUC;

/* */
/* M2H_CMD_DONE_CSR: MCU-to-Host command complete indication */
/* */
typedef union _M2H_CMD_DONE_STRUC {
	struct {
		u32 CmdToken0;
		u32 CmdToken1;
		u32 CmdToken2;
		u32 CmdToken3;
	} field;
	u32 word;
} M2H_CMD_DONE_STRUC, *PM2H_CMD_DONE_STRUC;

/*NAV_TIME_CFG :NAV */
typedef union _NAV_TIME_CFG_STRUC {
	struct {
		u8 Sifs;	/* in unit of 1-us */
		u8 SlotTime;	/* in unit of 1-us */
		u16 Eifs:9;	/* in unit of 1-us */
		u16 ZeroSifs:1;	/* Applied zero SIFS timer after OFDM RX 0: disable */
		u16 rsv:6;
	} field;
	u32 word;
} NAV_TIME_CFG_STRUC, *PNAV_TIME_CFG_STRUC;

/* */
/* RX_FILTR_CFG:  /RX configuration register */
/* */
typedef union _RX_FILTR_CFG_STRUC {
	struct {
		u32 DropCRCErr:1;	/* Drop CRC error */
		u32 DropPhyErr:1;	/* Drop physical error */
		u32 DropNotToMe:1;	/* Drop not to me unicast frame */
		u32 DropNotMyBSSID:1;	/* Drop fram ToDs bit is true */

		u32 DropVerErr:1;	/* Drop version error frame */
		u32 DropMcast:1;	/* Drop multicast frames */
		u32 DropBcast:1;	/* Drop broadcast frames */
		u32 DropDuplicate:1;	/* Drop duplicate frame */

		u32 DropCFEndAck:1;	/* Drop Ps-Poll */
		u32 DropCFEnd:1;	/* Drop Ps-Poll */
		u32 DropAck:1;	/* Drop Ps-Poll */
		u32 DropCts:1;	/* Drop Ps-Poll */

		u32 DropRts:1;	/* Drop Ps-Poll */
		u32 DropPsPoll:1;	/* Drop Ps-Poll */
		u32 DropBA:1;	/* */
		u32 DropBAR:1;	/* */

		u32 DropRsvCntlType:1;
		u32: 15;
	} field;
	u32 word;
} RX_FILTR_CFG_STRUC, *PRX_FILTR_CFG_STRUC;

/* */
/* PHY_CSR4: RF serial control register */
/* */
typedef union _PHY_CSR4_STRUC {
	struct {
		u32 RFRegValue:24;	/* Register     value (include register id)     serial out to RF/IF     chip. */
		u32 NumberOfBits:5;	/* Number of bits used in RFRegValue (I:20,     RFMD:22) */
		u32 IFSelect:1;	/* 1: select IF to program,     0: select RF to program */
		u32 PLL_LD:1;	/* RF PLL_LD status */
		u32 Busy:1;	/* 1: ASIC is busy execute RF programming. */
	} field;
	u32 word;
} PHY_CSR4_STRUC, *PPHY_CSR4_STRUC;

/* */
/* SEC_CSR5: shared key table security mode register */
/* */
typedef union _SEC_CSR5_STRUC {
	struct {
		u32 Bss2Key0CipherAlg:3;
		u32: 1;
		u32 Bss2Key1CipherAlg:3;
		u32: 1;
		u32 Bss2Key2CipherAlg:3;
		u32: 1;
		u32 Bss2Key3CipherAlg:3;
		u32: 1;
		u32 Bss3Key0CipherAlg:3;
		u32: 1;
		u32 Bss3Key1CipherAlg:3;
		u32: 1;
		u32 Bss3Key2CipherAlg:3;
		u32: 1;
		u32 Bss3Key3CipherAlg:3;
		u32: 1;
	} field;
	u32 word;
} SEC_CSR5_STRUC, *PSEC_CSR5_STRUC;

/* */
/* HOST_CMD_CSR: For HOST to interrupt embedded processor */
/* */
typedef union _HOST_CMD_CSR_STRUC {
	struct {
		u32 HostCommand:8;
		u32 Rsv:24;
	} field;
	u32 word;
} HOST_CMD_CSR_STRUC, *PHOST_CMD_CSR_STRUC;

/* */
/* AIFSN_CSR: AIFSN for each EDCA AC */
/* */

/* */
/* E2PROM_CSR: EEPROM control register */
/* */
typedef union _E2PROM_CSR_STRUC {
	struct {
		u32 Reload:1;	/* Reload EEPROM content, write one to reload, self-cleared. */
		u32 EepromSK:1;
		u32 EepromCS:1;
		u32 EepromDI:1;
		u32 EepromDO:1;
		u32 Type:1;	/* 1: 93C46, 0:93C66 */
		u32 LoadStatus:1;	/* 1:loading, 0:done */
		u32 Rsvd:25;
	} field;
	u32 word;
} E2PROM_CSR_STRUC, *PE2PROM_CSR_STRUC;

/* */
/* QOS_CSR0: TXOP holder address0 register */
/* */
typedef union _QOS_CSR0_STRUC {
	struct {
		u8 Byte0;	/* MAC address byte 0 */
		u8 Byte1;	/* MAC address byte 1 */
		u8 Byte2;	/* MAC address byte 2 */
		u8 Byte3;	/* MAC address byte 3 */
	} field;
	u32 word;
} QOS_CSR0_STRUC, *PQOS_CSR0_STRUC;

/* */
/* QOS_CSR1: TXOP holder address1 register */
/* */
typedef union _QOS_CSR1_STRUC {
	struct {
		u8 Byte4;	/* MAC address byte 4 */
		u8 Byte5;	/* MAC address byte 5 */
		u8 Rsvd0;
		u8 Rsvd1;
	} field;
	u32 word;
} QOS_CSR1_STRUC, *PQOS_CSR1_STRUC;

#define	RF_CSR_CFG	0x500
typedef union _RF_CSR_CFG_STRUC {
	struct {
		u32 RF_CSR_DATA:8;	/* DATA */
		u32 TESTCSR_RFACC_REGNUM:5;	/* RF register ID */
		u32 Rsvd2:3;	/* Reserved */
		u32 RF_CSR_WR:1;	/* 0: read  1: write */
		u32 RF_CSR_KICK:1;	/* kick RF register read/write */
		u32 Rsvd1:14;	/* Reserved */
	} field;
	u32 word;
} RF_CSR_CFG_STRUC, *PRF_CSR_CFG_STRUC;

/* */
/* Other on-chip shared memory space, base = 0x2000 */
/* */

/* CIS space - base address = 0x2000 */
#define HW_CIS_BASE             0x2000

/* Carrier-sense CTS frame base address. It's where mac stores carrier-sense frame for carrier-sense function. */
#define HW_CS_CTS_BASE			0x7700
/* DFS CTS frame base address. It's where mac stores CTS frame for DFS. */
#define HW_DFS_CTS_BASE			0x7780
#define HW_CTS_FRAME_SIZE		0x80

/* 2004-11-08 john - since NULL frame won't be that long (256 byte). We steal 16 tail bytes */
/* to save debugging settings */
#define HW_DEBUG_SETTING_BASE   0x77f0	/* 0x77f0~0x77ff total 16 bytes */
#define HW_DEBUG_SETTING_BASE2   0x7770	/* 0x77f0~0x77ff total 16 bytes */

/* In order to support maximum 8 MBSS and its maximum length is 512 for each beacon */
/* Three section discontinue memory segments will be used. */
/* 1. The original region for BCN 0~3 */
/* 2. Extract memory from FCE table for BCN 4~5 */
/* 3. Extract memory from Pair-wise key table for BCN 6~7 */
/*        It occupied those memory of wcid 238~253 for BCN 6 */
/*                                                    and wcid 222~237 for BCN 7 */
#define HW_BEACON_MAX_SIZE      0x1000	/* unit: byte */
#define HW_BEACON_BASE0         0x7800
#define HW_BEACON_BASE1         0x7A00
#define HW_BEACON_BASE2         0x7C00
#define HW_BEACON_BASE3         0x7E00
#define HW_BEACON_BASE4         0x7200
#define HW_BEACON_BASE5         0x7400
#define HW_BEACON_BASE6         0x5DC0
#define HW_BEACON_BASE7         0x5BC0

#define HW_BEACON_MAX_COUNT     8
#define HW_BEACON_OFFSET		0x0200
#define HW_BEACON_CONTENT_LEN	(HW_BEACON_OFFSET - TXWI_SIZE)

/* HOST-MCU shared memory - base address = 0x2100 */
#define HOST_CMD_CSR		0x404
#define H2M_MAILBOX_CSR         0x7010
#define H2M_MAILBOX_CID         0x7014
#define H2M_MAILBOX_STATUS      0x701c
#define H2M_INT_SRC             0x7024
#define H2M_BBP_AGENT           0x7028
#define M2H_CMD_DONE_CSR        0x000c
#define MCU_TXOP_ARRAY_BASE     0x000c	/* TODO: to be provided by Albert */
#define MCU_TXOP_ENTRY_SIZE     32	/* TODO: to be provided by Albert */
#define MAX_NUM_OF_TXOP_ENTRY   16	/* TODO: must be same with 8051 firmware */
#define MCU_MBOX_VERSION        0x01	/* TODO: to be confirmed by Albert */
#define MCU_MBOX_VERSION_OFFSET 5	/* TODO: to be provided by Albert */

/* */
/* Host DMA registers - base address 0x200 .  TX0-3=EDCAQid0-3, TX4=HCCA, TX5=MGMT, */
/* */
/* */
/*  DMA RING DESCRIPTOR */
/* */
#define E2PROM_CSR          0x0004
#define IO_CNTL_CSR         0x77d0

/* ================================================================ */
/* Tx / Rx / Mgmt ring descriptor definition */
/* ================================================================ */

/* the following PID values are used to mark outgoing frame type in TXD->PID so that */
/* proper TX statistics can be collected based on these categories */
/* b3-2 of PID field - */
#define PID_MGMT			0x05
#define PID_BEACON			0x0c
#define PID_DATA_NORMALUCAST		0x02
#define PID_DATA_AMPDU		0x04
#define PID_DATA_NO_ACK		0x08
#define PID_DATA_NOT_NORM_ACK		0x03
/* value domain of pTxD->HostQId (4-bit: 0~15) */
#define QID_AC_BK               1	/* meet ACI definition in 802.11e */
#define QID_AC_BE               0	/* meet ACI definition in 802.11e */
#define QID_AC_VI               2
#define QID_AC_VO               3
#define QID_HCCA                4
#define NUM_OF_TX_RING          4
#define QID_MGMT                13
#define QID_RX                  14
#define QID_OTHER               15

#endif /* __RTMP_MAC_H__ // */