ar5210reg.h

atheros ar5001 5002 driver

/*
 *  Copyright (c) 2001 Atheros Communications, Inc., All Rights Reserved
 */

/* ar5210reg.h Register definitions for Atheros AR5210 chipset */

#ident  "ACI $Header: //depot/sw/branches/ART_V45/sw/src/dk/mdk/common/include/ar5210reg.h#1 $"

// DMA Control and Interrupt Registers
#define F2_TXDP0            0x0000  // MAC transmit descriptor queue 0 pointer
#define F2_TXDP1            0x0004  // MAC transmit descriptor queue 1 pointer

#define F2_CR               0x0008  // MAC Control Register - only write values of 1 have effect
#define F2_CR_TXE0           0x00000001 // Transmit queue 0 enable
#define F2_CR_TXE1           0x00000002 // Transmit queue 1 enable
#define F2_CR_RXE            0x00000004 // Receive enable
#define F2_CR_TXD0           0x00000008 // Transmit queue 0 disable
#define F2_CR_TXD1           0x00000010 // Transmit queue 1 disable
#define F2_CR_RXD            0x00000020 // Receive disable
#define F2_CR_SWI            0x00000040 // One-shot software interrupt

#define F2_RXDP             0x000C  // MAC receive queue descriptor pointer

#define F2_CFG              0x0014  // MAC configuration and status register
#define F2_CFG_SWTD          0x00000001 // byteswap tx descriptor words
#define F2_CFG_SWTB          0x00000002 // byteswap tx data buffer words
#define F2_CFG_SWRD          0x00000004 // byteswap rx descriptor words
#define F2_CFG_SWRB          0x00000008 // byteswap rx data buffer words
#define F2_CFG_SWRG          0x00000010 // byteswap register access data words
#define F2_CFG_PHOK          0x00000100 // PHY OK status
#define F2_CFG_EEBS          0x00000200 // EEPROM busy
#define F2_CFG_TXCNT_M       0x00007800 // Mask of Number of tx descriptors in DMA transmit queues
#define F2_CFG_TXCNT_S       11         // Shift for Number of tx descriptors in DMA transmit queues
#define F2_CFG_TXFSTAT       0x00008000 // DMA transmit status
#define F2_CFG_TXFSTRT       0x00010000 // DMA transmit re-enable after filtered stop

#define F2_ISR              0x001c  // MAC interrupt service register
#define F2_ISR_RXOK          0x00000001 // At least one frame received sans errors
#define F2_ISR_RXDESC        0x00000002 // Receive interrupt request
#define F2_ISR_RXERR         0x00000004 // Receive error interrupt
#define F2_ISR_RXNOPKT       0x00000008 // No frame received within timeout clock
#define F2_ISR_RXEOL         0x00000010 // Received descriptor empty interrupt
#define F2_ISR_RXORN         0x00000020 // Receive FIFO overrun interrupt
#define F2_ISR_TXOK          0x00000040 // Transmit okay interrupt
#define F2_ISR_TXDESC        0x00000080 // Transmit interrupt request
#define F2_ISR_TXERR         0x00000100 // Transmit error interrupt
#define F2_ISR_TXNOPKT       0x00000200 // No frame transmitted interrupt
#define F2_ISR_TXEOL         0x00000400 // Transmit descriptor empty interrupt
#define F2_ISR_TXURN         0x00000800 // Transmit FIFO underrun interrupt
#define F2_ISR_MIB           0x00001000 // MIB interrupt - see MIBC
#define F2_ISR_SWI           0x00002000 // Software interrupt
#define F2_ISR_RXPHY         0x00004000 // PHY receive error interrupt
#define F2_ISR_RXKCM         0x00008000 // Key-cache miss interrupt
#define F2_ISR_SWBA          0x00010000 // Software beacon alert interrupt
#define F2_ISR_BRSSI         0x00020000 // Beacon threshold interrupt
#define F2_ISR_BMISS         0x00040000 // Beacon missed interrupt
#define F2_ISR_F2ERR         0x00080000 // An unexpected MAC error has occurred
#define F2_ISR_MCABT         0x00100000 // Master cycle abort interrupt
#define F2_ISR_SSERR         0x00200000 // SERR interrupt
#define F2_ISR_DPERR         0x00400000 // PCI bus parity error
#define F2_ISR_GPIO          0x01000000 // GPIO Interrupt
#define F2_ISR_RESV0         0xFE000000 // Reserved

#define F2_IMR              0x0020  // MAC interrupt mask register
#define F2_IMR_RXOK          0x00000001 // At least one frame received sans errors
#define F2_IMR_RXDESC        0x00000002 // Receive interrupt request
#define F2_IMR_RXERR         0x00000004 // Receive error interrupt
#define F2_IMR_RXNOPKT       0x00000008 // No frame received within timeout clock
#define F2_IMR_RXEOL         0x00000010 // Received descriptor empty interrupt
#define F2_IMR_RXORN         0x00000020 // Receive FIFO overrun interrupt
#define F2_IMR_TXOK          0x00000040 // Transmit okay interrupt
#define F2_IMR_TXDESC        0x00000080 // Transmit interrupt request
#define F2_IMR_TXERR         0x00000100 // Transmit error interrupt
#define F2_IMR_TXNOPKT       0x00000200 // No frame transmitted interrupt
#define F2_IMR_TXEOL         0x00000400 // Transmit descriptor empty interrupt
#define F2_IMR_TXURN         0x00000800 // Transmit FIFO underrun interrupt
#define F2_IMR_MIB           0x00001000 // MIB interrupt - see MIBC
#define F2_IMR_SWI           0x00002000 // Software interrupt
#define F2_IMR_RXPHY         0x00004000 // PHY receive error interrupt
#define F2_IMR_RXKCM         0x00008000 // Key-cache miss interrupt
#define F2_IMR_SWBA          0x00010000 // Software beacon alert interrupt
#define F2_IMR_BRSSI         0x00020000 // Beacon threshold interrupt
#define F2_IMR_BMISS         0x00040000 // Beacon missed interrupt
#define F2_IMR_F2ERR         0x00080000 // An unexpected MAC error has occurred
#define F2_IMR_MCABT         0x00100000 // Master cycle abort interrupt
#define F2_IMR_SSERR         0x00200000 // SERR interrupt
#define F2_IMR_DPERR         0x00400000 // PCI bus parity error
#define F2_IMR_GPIO          0x01000000 // GPIO Interrupt
#define F2_IMR_RESV0         0xFE000000 // Reserved

#define F2_IER              0x0024  // MAC Interrupt enable register
#define F2_IER_ENABLE        0x00000001 // Global interrupt enable
#define F2_IER_DISABLE       0x00000000 // Global interrupt disable

#define F2_BCR              0x0028  // MAC beacon control register
#define F2_BCR_APMODE        0x00000000 // 0 for access point mode
#define F2_BCR_STAMODE       0x00000001 // 1 for station/adhoc mode 
#define F2_BCR_BDMAE         0x00000002 // beacon DMA enable
#define F2_BCR_TQ1PV         0x00000004 // TXQ1 packet valid (non-beacon)
#define F2_BCR_TQ1V          0x00000008 // TXQ1 valid, contains valid tx chain
#define F2_BCR_BCGET         0x00000010 // Force a get beacon from TXQ1

#define F2_BSR              0x002c  // MAC beacon status register
#define F2_BSR_BDLYSW        0x00000001 // beacon tx delayed because of TXDP1 not enabled
#define F2_BSR_BDLYDMA       0x00000002 // beacon tx delayed because DMA engine lagged
#define F2_BSR_TXQ1F         0x00000004 // DMA is fetching from TXQ1
#define F2_BSR_ATIMDLY       0x00000008 // ATIMs not ready at start of ATIM window
#define F2_BSR_SNPBCMD       0x00000010 // Snapped BCR AP/Adhoc bit
#define F2_BSR_SNPBDMAE      0x00000020 // Snapped BCR beacon DMA enable bit
#define F2_BSR_SNPTQ1FV      0x00000040 // Snapped BCR AltQ non-beacon valid bit
#define F2_BSR_SNPTQ1V       0x00000080 // Snapped BCR AltQ valid bit
#define F2_BSR_SNP_VALID     0x00000100 // Snapped BCR values are valid
#define F2_BSR_SWBACNT_M     0x00FF0000 // Mask of software beacon alert count
#define F2_BSR_SWBACNT_S     16         // Shift for software beacon alert count

#define F2_TXCFG            0x0030  // MAC tx DMA size config register
#define F2_TXCFG_TXFSTP      0x00000008 // Transmit DMA stop on filtered enable
#define F2_TXCFG_TXFULL      0x00000070 // DMA tx descriptor queue full threshold
#define F2_TXCFG_CONT_EN     0x00000080 // Enable continuous transmit mode
#define F2_RXCFG            0x0034  // MAC rx DMA size config register
#define F2_RXCFG_ZLFDMA      0x00000010 // Enable DMA of zero-length frame
#define F2_DMASIZE_4B        0x00000000 // DMA size 4 bytes 
#define F2_DMASIZE_8B        0x00000001 // DMA size 8 bytes 
#define F2_DMASIZE_16B       0x00000002 // DMA size 16 bytes 
#define F2_DMASIZE_32B       0x00000003 // DMA size 32 bytes 
#define F2_DMASIZE_64B       0x00000004 // DMA size 64 bytes 
#define F2_DMASIZE_128B      0x00000005 // DMA size 128 bytes 
#define F2_DMASIZE_256B      0x00000006 // DMA size 256 bytes 
#define F2_DMASIZE_512B      0x00000007 // DMA size 512 bytes 

#define F2_MIBC             0x0040  // MAC MIB control register
#define F2_MIBC_COW          0x00000001 // counter overflow warning
#define F2_MIBC_FMC          0x00000002 // freeze MIB counters
#define F2_MIBC_CMC          0x00000004 // clear MIB counters
#define F2_MIBC_MCS          0x00000008 // MIB counter strobe, increment all

#define F2_TOPS             0x0044  // MAC timeout prescale count
#define F2_TOPS_MASK         0x0000FFFF // Mask for timeout prescale

#define F2_RXNPTO           0x0048  // MAC no frame received timeout
#define F2_RXNPTO_MASK       0x000003FF // Mask for no frame received timeout

#define F2_TXNPTO           0x004C  // MAC no frame trasmitted timeout
#define F2_TXNPTO_MASK       0x000003FF // Mask for no frame transmitted timeout

#define F2_RPGTO            0x0050  // MAC receive frame gap timeout
#define F2_RPGTO_MASK        0x000003FF // Mask for receive frame gap timeout

#define F2_RPCNT            0x0054 // MAC receive frame count limit
#define F2_RPCNT_MASK        0x0000001F // Mask for receive frame count limit
  
#define F2_F2MISC           0x0058 // MAC miscellaneous control/status register
#define F2_MISC_LED_DELAY_M  0x001C0000 // Mask for LED decay rate
#define F2_MISC_LED_DELAY_S  18         // Shift for LED decay rate
#define F2_MISC_LED_BLINK_M  0x00E00000 // Mask for LED blink rate
#define F2_MISC_LED_BLINK_S  21         // Shift for LED blink rate

// DMA & PCI Registers in PCI space (usable during sleep)
#define F2_RC               0x4000  // Warm reset control register
#define F2_RC_PCU            0x00000001 // PCU reset 
#define F2_RC_DMA            0x00000002 // DMA & MMR reset
#define F2_RC_F2             0x00000004 // MAC reset
#define F2_RC_D2             0x00000008 // Baseband reset
#define F2_RC_PCI            0x00000010 // PCI-core reset

#define F2_SCR              0x4004  // Sleep control register
#define F2_SCR_SLDUR_MASK    0x0000ffff // sleep duration mask, units of 128us
#define F2_SCR_SLE_MASK      0x00030000 // sleep enable mask
#define F2_SCR_SLE_FWAKE     0x00000000 // force wake
#define F2_SCR_SLE_FSLEEP    0x00010000 // force sleep
#define F2_SCR_SLE_NORMAL    0x00020000 // sleep logic normal operation
#define F2_SCR_SLE_UNITS     0x00000008 // SCR units/TU

#define F2_INTPEND          0x4008  // Interrupt Pending register
#define F2_INTPEND_TRUE      0x00000001 // interrupt pending

#define F2_SFR              0x400C  // Sleep force register
#define F2_SFR_SLEEP         0x00000001 // force sleep

#define F2_PCICFG           0x4010  // PCI configuration register
#define F2_PCICFG_EEAE       0x00000001 // enable software access to EEPROM 
#define F2_PCICFG_CLKRUNEN   0x00000004 // enable PCI CLKRUN function
#define F2_PCICFG_LED_PEND   0x00000020 // LED0&1 provide pending status
#define F2_PCICFG_LED_ACT    0x00000040 // LED0&1 provide activity status
#define F2_PCICFG_SL_INTEN   0x00000800 // enable interrupt line assertion when asleep
#define F2_PCICFG_BCTL		 0x00001000 // LED blink rate ctrl (0 = bytes/s, 1 = frames/s)
#define F2_PCICFG_SPWR_DN    0x00010000 // mask for sleep/awake indication

#define F2_NUM_GPIO         6		// Six numbered 0 to 5.

#define F2_GPIOCR           0x4014  // GPIO control register
#define F2_GPIOCR_CR_SHIFT   2          // Each CR is 2 bits
#define F2_GPIOCR_0_CR_N     0x00000000 // Input only mode for GPIODO[0]
#define F2_GPIOCR_0_CR_0     0x00000001 // Output only if GPIODO[0] = 0
#define F2_GPIOCR_0_CR_1     0x00000002 // Output only if GPIODO[0] = 1
#define F2_GPIOCR_0_CR_A     0x00000003 // Always output
#define F2_GPIOCR_1_CR_N     0x00000000 // Input only mode for GPIODO[1]
#define F2_GPIOCR_1_CR_0     0x00000004 // Output only if GPIODO[1] = 0
#define F2_GPIOCR_1_CR_1     0x00000008 // Output only if GPIODO[1] = 1
#define F2_GPIOCR_1_CR_A     0x0000000C // Always output
#define F2_GPIOCR_2_CR_N     0x00000000 // Input only mode for GPIODO[2]
#define F2_GPIOCR_2_CR_0     0x00000010 // Output only if GPIODO[2] = 0
#define F2_GPIOCR_2_CR_1     0x00000020 // Output only if GPIODO[2] = 1
#define F2_GPIOCR_2_CR_A     0x00000030 // Always output
#define F2_GPIOCR_3_CR_N     0x00000000 // Input only mode for GPIODO[3]
#define F2_GPIOCR_3_CR_0     0x00000040 // Output only if GPIODO[3] = 0
#define F2_GPIOCR_3_CR_1     0x00000080 // Output only if GPIODO[3] = 1
#define F2_GPIOCR_3_CR_A     0x000000C0 // Always output
#define F2_GPIOCR_4_CR_N     0x00000000 // Input only mode for GPIODO[4]
#define F2_GPIOCR_4_CR_0     0x00000100 // Output only if GPIODO[4] = 0
#define F2_GPIOCR_4_CR_1     0x00000200 // Output only if GPIODO[4] = 1
#define F2_GPIOCR_4_CR_A     0x00000300 // Always output
#define F2_GPIOCR_5_CR_N     0x00000000 // Input only mode for GPIODO[5]
#define F2_GPIOCR_5_CR_0     0x00000400 // Output only if GPIODO[5] = 0
#define F2_GPIOCR_5_CR_1     0x00000800 // Output only if GPIODO[5] = 1
#define F2_GPIOCR_5_CR_A     0x00000C00 // Always output
#define F2_GPIOCR_INT_SEL0   0x00000000 // Select Interrupt Pin GPIO_0
#define F2_GPIOCR_INT_SEL1   0x00001000 // Select Interrupt Pin GPIO_1 
#define F2_GPIOCR_INT_SEL2   0x00002000 // Select Interrupt Pin GPIO_2 
#define F2_GPIOCR_INT_SEL3   0x00003000 // Select Interrupt Pin GPIO_3 
#define F2_GPIOCR_INT_SEL4   0x00004000 // Select Interrupt Pin GPIO_4 
#define F2_GPIOCR_INT_SEL5   0x00005000 // Select Interrupt Pin GPIO_5
#define F2_GPIOCR_INT_EN     0x00008000 // Enable GPIO Interrupt
#define F2_GPIOCR_INT_SELL   0x00000000 // Generate Interrupt if selected pin is low
#define F2_GPIOCR_INT_SELH   0x00010000 // Generate Interrupt if selected pin is high

#define F2_GPIODO           0x4018  // GPIO data output access register
#define F2_GPIODI           0x401C  // GPIO data input access register