/*++
THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE.
Copyright (c) 1995-1998  Microsoft Corporation

Module Name:

    cs8900hw.h

Abstract:

    The main program for an CS8900 miniport driver.

Notes:

--*/

#ifndef _CS8900HARDWARE_
#define _CS8900HARDWARE_

/////////////////////////////////////////////////////////////////////////////////////////////
// Registers : CS8900A
/////////////////////////////////////////////////////////////////////////////////////////////

/* Packet page base address */
#define IO_PACKET_PAGE_BASE_ADDR        0xA7000300

/*
 * Bus interface registers
 */
#define PKTPG_EISA_NUM				0x0000
#define PKTPG_PRODUCT_ID			0x0002
#define PKTPG_IO_BASE				0x0020
#define PKTPG_INT_NUM				0x0022
#define PKTPG_DMA_CHANNEL_NUMBER	0x0024
#define PKTPG_DMA_START_OF_FRAME	0x0026
#define PKTPG_DMA_FRAME_COUNT		0x0028
#define PKTPG_RX_DMA_BYTE_COUNT		0x002a
#define PKTPG_MEM_BASE				0x002c
#define PKTPG_BOOT_PROM_BASE_ADDR	0x0030
#define PKTPG_BOOT_PROM_ADDR_MASK	0x0034
#define PKTPG_EEPROM_CMD			0x0040
#define PKTPG_EEPROM_DATA			0x0042
#define PKTPG_RX_FRAME_BYTE_COUNT	0x0050

/*
 * Status and control registers
 */
#define PKTPG_ISQ					0x0120
#define PKTPG_RX_CFG				0x0102
#define PKTPG_RX_EVENT				0x0124
#define PKTPG_RX_CTL				0x0104
#define PKTPG_TX_CFG				0x0106
#define PKTPG_TX_EVENT				0x0128
#define PKTPG_TX_CMD_ST				0x0108
#define PKTPG_BUF_CFG				0x010a
#define PKTPG_BUF_EVENT				0x012c
#define PKTPG_RX_MISS				0x0130
#define PKTPG_TX_COL				0x0132
#define PKTPG_LINE_CTL				0x0112
#define PKTPG_LINE_ST				0x0134
#define PKTPG_SELF_CTL				0x0114
#define PKTPG_SELF_ST				0x0136
#define PKTPG_BUS_CTL				0x0116
#define PKTPG_BUS_ST				0x0138
#define PKTPG_TEST_CTL				0x0118
#define PKTPG_AUI_TIME_DOMAIN_REF	0x013c

#define PKTPG_INTERRUPT_NUMBER		0x0022

#define SELF_ST_INITD				0x0080
#define SELF_ST_SIBUSY				0x0100
/*
 * Initiate transmit registers
 */
#define PKTPG_TX_CMD_REQ			0x0144
#define PKTPG_TX_LENGTH				0x0146

/*
 * Address filter registers
 */
#define PKTPG_LOGICAL_ADDR_FILTER	0x0150
#define PKTPG_IND_ADDR				0x0158
#define PKTPG_INDIVISUAL_ADDR		0x0158
/*
 * Frame locations
 */
#define PKTPG_RX_STATUS				0x0400
#define PKTPG_RX_LENGTH				0x0402
#define PKTPG_RX_FRAME				0x0404
#define PKTPG_TX_FRAME				0x0a00

/*
 * Bit masks
 */
#define SELF_CTL_RESET				0x0040
#define SELF_CTL_LOW_BITS			0x0015

#define SELF_ST_INIT_DONE			0x0080
#define SELF_ST_SI_BUSY				0x0100

/* Bus Status Register */

#define BUS_ST_TX_BID_ERR			0x0080
#define BUS_ST_RDY4TXNOW			0x0100

/* Bus Control Register */

#define BUS_CTL_LOW_BITS			0x0017
#define	BUS_CTL_USE_SA				0x0200
#define BUS_CTL_MEM_MODE			0x0400
#define BUS_CTL_IOCHRDY				0x1000
#define BUS_CTL_INT_ENBL			0x8000
#define BUS_CTL_ENABLE_IRQ			0x8000

/* Line Control Register */
#define	LINE_CTL_RX_ON				0x0040
#define	LINE_CTL_TX_ON				0x0080
#define	LINE_CTL_AUI_ONLY			0x0100
#define	LINE_CTL_10BASET			0x0000

#define TX_CMD_START_5				0x0000
#define TX_CMD_START_381			0x0040
#define TX_CMD_START_1021			0x0080
#define TX_CMD_START_ALL			0x00c0
#define TX_CMD_FORCE				0x0100
#define TX_CMD_ONECOLL				0x0200
#define TX_CMD_NO_CRC				0x1000
#define TX_CMD_NO_PAD				0x2000
#define TX_CMD_LOW_BITS				0x0009

#define ISQ_REG_NUM					0x003f
#define ISQ_REG_CONTENT				0xffc0

#define RX_EVENT_RX_OK				0x0100
#define RX_EVENT_HASHED				0x0200
#define RX_EVENT_IND_ADDR			0x0400
#define RX_EVENT_BROADCAST			0x0800

#define RX_CTL_RX_OK_A				0x0100
#define RX_CTL_IND_A				0x0400
#define RX_CTL_BCAST_A				0x0800
#define RX_CTL_LOW_BITS				0x0005

#define RX_CFG_SKIP					0x0040
#define RX_CFG_RX_OK_IE				0x0100
#define RX_CFG_LOW_BITS				0x0003

#define RX_CFG_RX_OK_I_E			0x0100
#define RX_CTL_RX_OK_A				0x0100
#define RX_CTL_IND_ADDR_A			0x0400
#define RX_CTL_BROADCAST_A			0x0800

#define BUF_EVENT_RDY_4_TX			0x0100

#define BUF_CFG_RDY_4_TX_I_E		0x0100
#define BUF_CFG_LOW_BITS			0x000b

#define TX_CFG_LOSS_OF_CRC_I_E		0x0040
#define TX_CFG_SQE_ERROR_I_E		0x0080
#define TX_CFG_TX_OK_I_E			0x0100
#define TX_CFG_OUT_OF_WINDOW_I_E	0x0200
#define TX_CFG_JABBER_I_E			0x0400
#define TX_CFG_ANYCOLL_I_E			0x0800
#define TX_CFG_16_COLL_I_E			0x8000
#define TX_CFG_ALL_IE				0x8fc0
#define TX_CFG_LOW_BITS				0x0007

#define TX_CFG_ALL					0x8fc0

#define TX_EVENT_LOSS_OF_CRS		0x0040
#define TX_EVENT_SQE_ERROR			0x0080
#define TX_EVENT_TX_OK				0x0100
#define TX_EVENT_OUT_OF_WINDOW		0x0200
#define TX_EVENT_JABBER				0x0400
#define TX_EVENT_NUM_TX_COLL		0x7800
#define TX_EVENT_16_COLL			0x8000

/* One of the values of 0, 1, 2, 3 */
#define INTERRUPT_NUMBER			0x0000

#define LINE_CTL_10_BASE_T			0x0000
#define LINE_CTL_AUI_ONLY			0x0100
#define LINE_CTL_RX_ON				0x0040
#define LINE_CTL_TX_ON				0x0080
#define LINE_CTL_MOD_BACKOFF		0x0800
#define LINE_CTL_LOW_BITS			0x0013

#define TEST_CTL_FDX				0x4000
#define TEST_CTL_LOW_BITS			0x0019

/*
 * Register numbers
 */
#define	REG_NUM_MASK				0x003F
#define REG_NUM_RX_EVENT			0x0004
#define REG_NUM_TX_EVENT			0x0008
#define REG_NUM_BUF_EVENT			0x000c
#define REG_NUM_RX_MISS				0x0010
#define REG_NUM_TX_COL				0x0012

/*
 * I/O mode register mapping
 */
#define IO_RX_TX_DATA_0				0x0000
#define IO_RX_TX_DATA_1				0x0002
#define IO_TX_CMD					0x0004
#define IO_TX_LENGTH				0x0006
#define IO_ISQ						0x0008
#define IO_PACKET_PAGE_POINTER		0x000a
#define IO_PACKET_PAGE_DATA_0		0x000c
#define IO_PACKET_PAGE_DATA_1		0x000e

#define	PORT_RXTX_DATA				(IO_PACKET_PAGE_BASE_ADDR+0x0000)
#define	PORT_RXTX_DATA_1			(IO_PACKET_PAGE_BASE_ADDR+0x0002)
#define	PORT_TX_CMD					(IO_PACKET_PAGE_BASE_ADDR+0x0004)
#define	PORT_TX_LENGTH				(IO_PACKET_PAGE_BASE_ADDR+0x0006)
#define	PORT_ISQ					(IO_PACKET_PAGE_BASE_ADDR+0x0008)
#define	PORT_PKTPG_PTR				(IO_PACKET_PAGE_BASE_ADDR+0x000A)
#define	PORT_PKTPG_DATA				(IO_PACKET_PAGE_BASE_ADDR+0x000C)
#define	PORT_PKTPG_DATA_1			(IO_PACKET_PAGE_BASE_ADDR+0x000E)


/**********************************************************************
 * Inline functions
 *********************************************************************/

extern volatile unsigned char* 	ioPacketPage;
extern volatile struct gpioreg	*gpioRegs;

void SetD_SlowIO(ULONG regaddrs, unsigned short regvalue);
unsigned short GetD_SlowIO(ULONG regaddrs);

/*
 * Read data from I/O port.
 */
#define readIoPort(offset) ((unsigned short)GetD_SlowIO((unsigned long)&EthCommand[(offset)]))

/*
 * Write data to I/O port.
 */

#define writeIoPort(offset, data) \
	(SetD_SlowIO((unsigned long)&EthCommand[(offset)], (data)))
	

#if	1
#define CS8900_Tacs	(0x0)	// 0clk
#define CS8900_Tcos	(0x3)	// 4clk
#define CS8900_Tacc	(0x7)	// 14clk
#define CS8900_Tcoh	(0x1)	// 1clk
#define CS8900_Tah	(0x3)	// 4clk
#define CS8900_Tacp	(0x3)	// 6clk
//#define CS8900_PMC	(0x0)	// normal(1data)
#define CS8900_PMC	(0x3)	// 16data), hzh
#else
#define CS8900_Tacs	(0x3)	// 4clk
#define CS8900_Tcos	(0x3)	// 4clk
#define CS8900_Tacc	(0x7)	// 14clk
#define CS8900_Tcoh	(0x3)	// 1clk
#define CS8900_Tah	(0x3)	// 4clk
#define CS8900_Tacp	(0x3)	// 6clk
#define CS8900_PMC	(0x3)	// normal(1data)
#endif


/////////////////////////////////////////////////////////////////////////////////////////////
// Definitions for supporting clone adapters.
/////////////////////////////////////////////////////////////////////////////////////////////

//
// Default value for Adapter->IoBaseAddr
//
#define DEFAULT_IOBASEADDR (PVOID)0x300

//
// Default value for Adapter->InterruptNumber
//
#define DEFAULT_INTERRUPTNUMBER 3


//
// Default value for Adapter->MulticastListMax
//
#define DEFAULT_MULTICASTLISTMAX 8


#endif // _CS8900HARDWARE_
