path: root/drivers/net/mv643xx_eth.h

#ifndef __MV643XX_ETH_H__
#define __MV643XX_ETH_H__

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/spinlock.h>
#include <linux/workqueue.h>
#include <linux/mii.h>

#include <linux/mv643xx_eth.h>

#include <asm/dma-mapping.h>

/* Checksum offload for Tx works for most packets, but
 * fails if previous packet sent did not use hw csum
 */
#define	MV643XX_CHECKSUM_OFFLOAD_TX
#define	MV643XX_NAPI
#define	MV643XX_TX_FAST_REFILL
#undef	MV643XX_COAL

/*
 * Number of RX / TX descriptors on RX / TX rings.
 * Note that allocating RX descriptors is done by allocating the RX
 * ring AND a preallocated RX buffers (skb's) for each descriptor.
 * The TX descriptors only allocates the TX descriptors ring,
 * with no pre allocated TX buffers (skb's are allocated by higher layers.
 */

/* Default TX ring size is 1000 descriptors */
#define MV643XX_DEFAULT_TX_QUEUE_SIZE 1000

/* Default RX ring size is 400 descriptors */
#define MV643XX_DEFAULT_RX_QUEUE_SIZE 400

#define MV643XX_TX_COAL 100
#ifdef MV643XX_COAL
#define MV643XX_RX_COAL 100
#endif

#ifdef MV643XX_CHECKSUM_OFFLOAD_TX
#define MAX_DESCS_PER_SKB	(MAX_SKB_FRAGS + 1)
#else
#define MAX_DESCS_PER_SKB	1
#endif

#define ETH_VLAN_HLEN		4
#define ETH_FCS_LEN		4
#define ETH_HW_IP_ALIGN		2		/* hw aligns IP header */
#define ETH_WRAPPER_LEN		(ETH_HW_IP_ALIGN + ETH_HLEN + \
					ETH_VLAN_HLEN + ETH_FCS_LEN)
#define ETH_RX_SKB_SIZE		(dev->mtu + ETH_WRAPPER_LEN + dma_get_cache_alignment())

/****************************************/
/*        Ethernet Unit Registers  		*/
/****************************************/

#define PHY_ADDR_REG                                    0x0000
#define SMI_REG                                         0x0004
#define UNIT_DEFAULT_ADDR_REG                           0x0008
#define UNIT_DEFAULTID_REG                              0x000c
#define UNIT_INTERRUPT_CAUSE_REG                        0x0080
#define UNIT_INTERRUPT_MASK_REG                         0x0084
#define UNIT_INTERNAL_USE_REG                           0x04fc
#define UNIT_ERROR_ADDR_REG                             0x0094
#define BAR_0                                           0x0200
#define BAR_1                                           0x0208
#define BAR_2                                           0x0210
#define BAR_3                                           0x0218
#define BAR_4                                           0x0220
#define BAR_5                                           0x0228
#define SIZE_REG_0                                      0x0204
#define SIZE_REG_1                                      0x020c
#define SIZE_REG_2                                      0x0214
#define SIZE_REG_3                                      0x021c
#define SIZE_REG_4                                      0x0224
#define SIZE_REG_5                                      0x022c
#define HEADERS_RETARGET_BASE_REG                       0x0230
#define HEADERS_RETARGET_CONTROL_REG                    0x0234
#define HIGH_ADDR_REMAP_REG_0                           0x0280
#define HIGH_ADDR_REMAP_REG_1                           0x0284
#define HIGH_ADDR_REMAP_REG_2                           0x0288
#define HIGH_ADDR_REMAP_REG_3                           0x028c
#define BASE_ADDR_ENABLE_REG                            0x0290
#define ACCESS_PROTECTION_REG(port)                    (0x0294 + (port<<2))
#define MIB_COUNTERS_BASE(port)                        (0x1000 + (port<<7))
#define PORT_CONFIG_REG(port)                          (0x0400 + (port<<10))
#define PORT_CONFIG_EXTEND_REG(port)                   (0x0404 + (port<<10))
#define MII_SERIAL_PARAMETRS_REG(port)                 (0x0408 + (port<<10))
#define GMII_SERIAL_PARAMETRS_REG(port)                (0x040c + (port<<10))
#define VLAN_ETHERTYPE_REG(port)                       (0x0410 + (port<<10))
#define MAC_ADDR_LOW(port)                             (0x0414 + (port<<10))
#define MAC_ADDR_HIGH(port)                            (0x0418 + (port<<10))
#define SDMA_CONFIG_REG(port)                          (0x041c + (port<<10))
#define DSCP_0(port)                                   (0x0420 + (port<<10))
#define DSCP_1(port)                                   (0x0424 + (port<<10))
#define DSCP_2(port)                                   (0x0428 + (port<<10))
#define DSCP_3(port)                                   (0x042c + (port<<10))
#define DSCP_4(port)                                   (0x0430 + (port<<10))
#define DSCP_5(port)                                   (0x0434 + (port<<10))
#define DSCP_6(port)                                   (0x0438 + (port<<10))
#define PORT_SERIAL_CONTROL_REG(port)                  (0x043c + (port<<10))
#define VLAN_PRIORITY_TAG_TO_PRIORITY(port)            (0x0440 + (port<<10))
#define PORT_STATUS_REG(port)                          (0x0444 + (port<<10))
#define TRANSMIT_QUEUE_COMMAND_REG(port)               (0x0448 + (port<<10))
#define TX_QUEUE_FIXED_PRIORITY(port)                  (0x044c + (port<<10))
#define PORT_TX_TOKEN_BUCKET_RATE_CONFIG(port)         (0x0450 + (port<<10))
#define MAXIMUM_TRANSMIT_UNIT(port)                    (0x0458 + (port<<10))
#define PORT_MAXIMUM_TOKEN_BUCKET_SIZE(port)           (0x045c + (port<<10))
#define INTERRUPT_CAUSE_REG(port)                      (0x0460 + (port<<10))
#define INTERRUPT_CAUSE_EXTEND_REG(port)               (0x0464 + (port<<10))
#define INTERRUPT_MASK_REG(port)                       (0x0468 + (port<<10))
#define INTERRUPT_EXTEND_MASK_REG(port)                (0x046c + (port<<10))
#define RX_FIFO_URGENT_THRESHOLD_REG(port)             (0x0470 + (port<<10))
#define TX_FIFO_URGENT_THRESHOLD_REG(port)             (0x0474 + (port<<10))
#define RX_MINIMAL_FRAME_SIZE_REG(port)                (0x047c + (port<<10))
#define RX_DISCARDED_FRAMES_COUNTER(port)              (0x0484 + (port<<10))
#define PORT_DEBUG_0_REG(port)                         (0x048c + (port<<10))
#define PORT_DEBUG_1_REG(port)                         (0x0490 + (port<<10))
#define PORT_INTERNAL_ADDR_ERROR_REG(port)             (0x0494 + (port<<10))
#define INTERNAL_USE_REG(port)                         (0x04fc + (port<<10))
#define RECEIVE_QUEUE_COMMAND_REG(port)                (0x0680 + (port<<10))
#define CURRENT_SERVED_TX_DESC_PTR(port)               (0x0684 + (port<<10))
#define RX_CURRENT_QUEUE_DESC_PTR_0(port)              (0x060c + (port<<10))     
#define RX_CURRENT_QUEUE_DESC_PTR_1(port)              (0x061c + (port<<10))     
#define RX_CURRENT_QUEUE_DESC_PTR_2(port)              (0x062c + (port<<10))     
#define RX_CURRENT_QUEUE_DESC_PTR_3(port)              (0x063c + (port<<10))     
#define RX_CURRENT_QUEUE_DESC_PTR_4(port)              (0x064c + (port<<10))     
#define RX_CURRENT_QUEUE_DESC_PTR_5(port)              (0x065c + (port<<10))     
#define RX_CURRENT_QUEUE_DESC_PTR_6(port)              (0x066c + (port<<10))     
#define RX_CURRENT_QUEUE_DESC_PTR_7(port)              (0x067c + (port<<10))     
#define TX_CURRENT_QUEUE_DESC_PTR_0(port)              (0x06c0 + (port<<10))     
#define TX_CURRENT_QUEUE_DESC_PTR_1(port)              (0x06c4 + (port<<10))     
#define TX_CURRENT_QUEUE_DESC_PTR_2(port)              (0x06c8 + (port<<10))     
#define TX_CURRENT_QUEUE_DESC_PTR_3(port)              (0x06cc + (port<<10))     
#define TX_CURRENT_QUEUE_DESC_PTR_4(port)              (0x06d0 + (port<<10))     
#define TX_CURRENT_QUEUE_DESC_PTR_5(port)              (0x06d4 + (port<<10))     
#define TX_CURRENT_QUEUE_DESC_PTR_6(port)              (0x06d8 + (port<<10))     
#define TX_CURRENT_QUEUE_DESC_PTR_7(port)              (0x06dc + (port<<10))     
#define TX_QUEUE_0_TOKEN_BUCKET_COUNT(port)            (0x0700 + (port<<10))
#define TX_QUEUE_1_TOKEN_BUCKET_COUNT(port)            (0x0710 + (port<<10))
#define TX_QUEUE_2_TOKEN_BUCKET_COUNT(port)            (0x0720 + (port<<10))
#define TX_QUEUE_3_TOKEN_BUCKET_COUNT(port)            (0x0730 + (port<<10))
#define TX_QUEUE_4_TOKEN_BUCKET_COUNT(port)            (0x0740 + (port<<10))
#define TX_QUEUE_5_TOKEN_BUCKET_COUNT(port)            (0x0750 + (port<<10))
#define TX_QUEUE_6_TOKEN_BUCKET_COUNT(port)            (0x0760 + (port<<10))
#define TX_QUEUE_7_TOKEN_BUCKET_COUNT(port)            (0x0770 + (port<<10))
#define TX_QUEUE_0_TOKEN_BUCKET_CONFIG(port)           (0x0704 + (port<<10))
#define TX_QUEUE_1_TOKEN_BUCKET_CONFIG(port)           (0x0714 + (port<<10))
#define TX_QUEUE_2_TOKEN_BUCKET_CONFIG(port)           (0x0724 + (port<<10))
#define TX_QUEUE_3_TOKEN_BUCKET_CONFIG(port)           (0x0734 + (port<<10))
#define TX_QUEUE_4_TOKEN_BUCKET_CONFIG(port)           (0x0744 + (port<<10))
#define TX_QUEUE_5_TOKEN_BUCKET_CONFIG(port)           (0x0754 + (port<<10))
#define TX_QUEUE_6_TOKEN_BUCKET_CONFIG(port)           (0x0764 + (port<<10))
#define TX_QUEUE_7_TOKEN_BUCKET_CONFIG(port)           (0x0774 + (port<<10))
#define TX_QUEUE_0_ARBITER_CONFIG(port)                (0x0708 + (port<<10))
#define TX_QUEUE_1_ARBITER_CONFIG(port)                (0x0718 + (port<<10))
#define TX_QUEUE_2_ARBITER_CONFIG(port)                (0x0728 + (port<<10))
#define TX_QUEUE_3_ARBITER_CONFIG(port)                (0x0738 + (port<<10))
#define TX_QUEUE_4_ARBITER_CONFIG(port)                (0x0748 + (port<<10))
#define TX_QUEUE_5_ARBITER_CONFIG(port)                (0x0758 + (port<<10))
#define TX_QUEUE_6_ARBITER_CONFIG(port)                (0x0768 + (port<<10))
#define TX_QUEUE_7_ARBITER_CONFIG(port)                (0x0778 + (port<<10))
#define PORT_TX_TOKEN_BUCKET_COUNT(port)               (0x0780 + (port<<10))
#define DA_FILTER_SPECIAL_MULTICAST_TABLE_BASE(port)   (0x1400 + (port<<10))
#define DA_FILTER_OTHER_MULTICAST_TABLE_BASE(port)     (0x1500 + (port<<10))
#define DA_FILTER_UNICAST_TABLE_BASE(port)             (0x1600 + (port<<10))

/* These macros describe Ethernet Port configuration reg (Px_cR) bits */
#define UNICAST_NORMAL_MODE		0
#define UNICAST_PROMISCUOUS_MODE	(1<<0)
#define DEFAULT_RX_QUEUE_0		0
#define DEFAULT_RX_QUEUE_1		(1<<1)
#define DEFAULT_RX_QUEUE_2		(1<<2)
#define DEFAULT_RX_QUEUE_3		((1<<2) | (1<<1))
#define DEFAULT_RX_QUEUE_4		(1<<3)
#define DEFAULT_RX_QUEUE_5		((1<<3) | (1<<1))
#define DEFAULT_RX_QUEUE_6		((1<<3) | (1<<2))
#define DEFAULT_RX_QUEUE_7		((1<<3) | (1<<2) | (1<<1))
#define DEFAULT_RX_ARP_QUEUE_0	0
#define DEFAULT_RX_ARP_QUEUE_1	(1<<4)
#define DEFAULT_RX_ARP_QUEUE_2	(1<<5)
#define DEFAULT_RX_ARP_QUEUE_3	((1<<5) | (1<<4))
#define DEFAULT_RX_ARP_QUEUE_4	(1<<6)
#define DEFAULT_RX_ARP_QUEUE_5	((1<<6) | (1<<4))
#define DEFAULT_RX_ARP_QUEUE_6	((1<<6) | (1<<5))
#define DEFAULT_RX_ARP_QUEUE_7	((1<<6) | (1<<5) | (1<<4))
#define RECEIVE_BC_IF_NOT_IP_OR_ARP	0
#define REJECT_BC_IF_NOT_IP_OR_ARP	(1<<7)
#define RECEIVE_BC_IF_IP		0
#define REJECT_BC_IF_IP		(1<<8)
#define RECEIVE_BC_IF_ARP		0
#define REJECT_BC_IF_ARP		(1<<9)
#define TX_AM_NO_UPDATE_ERROR_SUMMARY (1<<12)
#define CAPTURE_TCP_FRAMES_DIS	0
#define CAPTURE_TCP_FRAMES_EN	(1<<14)
#define CAPTURE_UDP_FRAMES_DIS	0
#define CAPTURE_UDP_FRAMES_EN	(1<<15)
#define DEFAULT_RX_TCP_QUEUE_0	0
#define DEFAULT_RX_TCP_QUEUE_1	(1<<16)
#define DEFAULT_RX_TCP_QUEUE_2	(1<<17)
#define DEFAULT_RX_TCP_QUEUE_3	((1<<17) | (1<<16))
#define DEFAULT_RX_TCP_QUEUE_4	(1<<18)
#define DEFAULT_RX_TCP_QUEUE_5	((1<<18) | (1<<16))
#define DEFAULT_RX_TCP_QUEUE_6	((1<<18) | (1<<17))
#define DEFAULT_RX_TCP_QUEUE_7	((1<<18) | (1<<17) | (1<<16))
#define DEFAULT_RX_UDP_QUEUE_0	0
#define DEFAULT_RX_UDP_QUEUE_1	(1<<19)
#define DEFAULT_RX_UDP_QUEUE_2	(1<<20)
#define DEFAULT_RX_UDP_QUEUE_3	((1<<20) | (1<<19))
#define DEFAULT_RX_UDP_QUEUE_4	(1<<21)
#define DEFAULT_RX_UDP_QUEUE_5	((1<<21) | (1<<19))
#define DEFAULT_RX_UDP_QUEUE_6	((1<<21) | (1<<20))
#define DEFAULT_RX_UDP_QUEUE_7	((1<<21) | (1<<20) | (1<<19))
#define DEFAULT_RX_BPDU_QUEUE_0	0
#define DEFAULT_RX_BPDU_QUEUE_1	(1<<22)
#define DEFAULT_RX_BPDU_QUEUE_2	(1<<23)
#define DEFAULT_RX_BPDU_QUEUE_3	((1<<23) | (1<<22))
#define DEFAULT_RX_BPDU_QUEUE_4	(1<<24)
#define DEFAULT_RX_BPDU_QUEUE_5	((1<<24) | (1<<22))
#define DEFAULT_RX_BPDU_QUEUE_6	((1<<24) | (1<<23))
#define DEFAULT_RX_BPDU_QUEUE_7	((1<<24) | (1<<23) | (1<<22))

#define	PORT_CONFIG_DEFAULT_VALUE			\
		UNICAST_NORMAL_MODE		|	\
		DEFAULT_RX_QUEUE_0		|	\
		DEFAULT_RX_ARP_QUEUE_0	|	\
		RECEIVE_BC_IF_NOT_IP_OR_ARP	|	\
		RECEIVE_BC_IF_IP		|	\
		RECEIVE_BC_IF_ARP		|	\
		CAPTURE_TCP_FRAMES_DIS	|	\
		CAPTURE_UDP_FRAMES_DIS	|	\
		DEFAULT_RX_TCP_QUEUE_0	|	\
		DEFAULT_RX_UDP_QUEUE_0	|	\
		DEFAULT_RX_BPDU_QUEUE_0

/* These macros describe Ethernet Port configuration extend reg (Px_cXR) bits*/
#define CLASSIFY_EN				(1<<0)
#define SPAN_BPDU_PACKETS_AS_NORMAL		0
#define SPAN_BPDU_PACKETS_TO_RX_QUEUE_7	(1<<1)
#define PARTITION_DISABLE			0
#define PARTITION_ENABLE			(1<<2)

#define	PORT_CONFIG_EXTEND_DEFAULT_VALUE		\
		SPAN_BPDU_PACKETS_AS_NORMAL	|	\
		PARTITION_DISABLE

/* These macros describe Ethernet Port Sdma configuration reg (SDCR) bits */
#define RIFB			(1<<0)
#define RX_BURST_SIZE_1_64BIT		0
#define RX_BURST_SIZE_2_64BIT		(1<<1)
#define RX_BURST_SIZE_4_64BIT		(1<<2)
#define RX_BURST_SIZE_8_64BIT		((1<<2) | (1<<1))
#define RX_BURST_SIZE_16_64BIT		(1<<3)
#define BLM_RX_NO_SWAP			(1<<4)
#define BLM_RX_BYTE_SWAP			0
#define BLM_TX_NO_SWAP			(1<<5)
#define BLM_TX_BYTE_SWAP			0
#define DESCRIPTORS_BYTE_SWAP		(1<<6)
#define DESCRIPTORS_NO_SWAP			0
#define TX_BURST_SIZE_1_64BIT		0
#define TX_BURST_SIZE_2_64BIT		(1<<22)
#define TX_BURST_SIZE_4_64BIT		(1<<23)
#define TX_BURST_SIZE_8_64BIT		((1<<23) | (1<<22))
#define TX_BURST_SIZE_16_64BIT		(1<<24)

#define	IPG_INT_RX(value) ((value & 0x3fff) << 8)

#if defined(__BIG_ENDIAN)
#define	PORT_SDMA_CONFIG_DEFAULT_VALUE		\
		RX_BURST_SIZE_4_64BIT	|	\
		IPG_INT_RX(0)		|	\
		TX_BURST_SIZE_4_64BIT
#elif defined(__LITTLE_ENDIAN)
#define	PORT_SDMA_CONFIG_DEFAULT_VALUE		\
		RX_BURST_SIZE_4_64BIT	|	\
		BLM_RX_NO_SWAP		|	\
		BLM_TX_NO_SWAP		|	\
		IPG_INT_RX(0)		|	\
		TX_BURST_SIZE_4_64BIT
#else
#error One of __BIG_ENDIAN or __LITTLE_ENDIAN must be defined
#endif

/* These macros describe Ethernet Port serial control reg (PSCR) bits */
#define SERIAL_PORT_DISABLE			0
#define SERIAL_PORT_ENABLE			(1<<0)
#define FORCE_LINK_PASS			(1<<1)
#define DO_NOT_FORCE_LINK_PASS		0
#define ENABLE_AUTO_NEG_FOR_DUPLX		0
#define DISABLE_AUTO_NEG_FOR_DUPLX		(1<<2)
#define ENABLE_AUTO_NEG_FOR_FLOW_CTRL	0
#define DISABLE_AUTO_NEG_FOR_FLOW_CTRL	(1<<3)
#define ADV_NO_FLOW_CTRL			0
#define ADV_SYMMETRIC_FLOW_CTRL		(1<<4)
#define FORCE_FC_MODE_NO_PAUSE_DIS_TX	0
#define FORCE_FC_MODE_TX_PAUSE_DIS		(1<<5)
#define FORCE_BP_MODE_NO_JAM		0
#define FORCE_BP_MODE_JAM_TX		(1<<7)
#define FORCE_BP_MODE_JAM_TX_ON_RX_ERR	(1<<8)
#define SERIAL_PORT_CONTROL_RESERVED	(1<<9)
#define FORCE_LINK_FAIL			0
#define DO_NOT_FORCE_LINK_FAIL		(1<<10)
#define RETRANSMIT_16_ATTEMPTS		0
#define RETRANSMIT_FOREVER			(1<<11)
#define DISABLE_AUTO_NEG_SPEED_GMII		(1<<13)
#define ENABLE_AUTO_NEG_SPEED_GMII		0
#define DTE_ADV_0				0
#define DTE_ADV_1				(1<<14)
#define DISABLE_AUTO_NEG_BYPASS		0
#define ENABLE_AUTO_NEG_BYPASS		(1<<15)
#define AUTO_NEG_NO_CHANGE			0
#define RESTART_AUTO_NEG			(1<<16)
#define MAX_RX_PACKET_1518BYTE		0
#define MAX_RX_PACKET_1522BYTE		(1<<17)
#define MAX_RX_PACKET_1552BYTE		(1<<18)
#define MAX_RX_PACKET_9022BYTE		((1<<18) | (1<<17))
#define MAX_RX_PACKET_9192BYTE		(1<<19)
#define MAX_RX_PACKET_9700BYTE		((1<<19) | (1<<17))
#define SET_EXT_LOOPBACK			(1<<20)
#define CLR_EXT_LOOPBACK			0
#define SET_FULL_DUPLEX_MODE		(1<<21)
#define SET_HALF_DUPLEX_MODE		0
#define ENABLE_FLOW_CTRL_TX_RX_IN_FULL_DUPLEX (1<<22)
#define DISABLE_FLOW_CTRL_TX_RX_IN_FULL_DUPLEX 0
#define SET_GMII_SPEED_TO_10_100		0
#define SET_GMII_SPEED_TO_1000		(1<<23)
#define SET_MII_SPEED_TO_10			0
#define SET_MII_SPEED_TO_100		(1<<24)

#define MAX_RX_PACKET_MASK			(0x7<<17)

#define	PORT_SERIAL_CONTROL_DEFAULT_VALUE		\
		DO_NOT_FORCE_LINK_PASS	|	\
		ENABLE_AUTO_NEG_FOR_DUPLX	|	\
		DISABLE_AUTO_NEG_FOR_FLOW_CTRL |	\
		ADV_SYMMETRIC_FLOW_CTRL	|	\
		FORCE_FC_MODE_NO_PAUSE_DIS_TX |	\
		FORCE_BP_MODE_NO_JAM	|	\
		(1<<9)	/* reserved */			|	\
		DO_NOT_FORCE_LINK_FAIL	|	\
		RETRANSMIT_16_ATTEMPTS	|	\
		ENABLE_AUTO_NEG_SPEED_GMII	|	\
		DTE_ADV_0			|	\
		DISABLE_AUTO_NEG_BYPASS	|	\
		AUTO_NEG_NO_CHANGE		|	\
		MAX_RX_PACKET_9700BYTE	|	\
		CLR_EXT_LOOPBACK		|	\
		SET_FULL_DUPLEX_MODE	|	\
		ENABLE_FLOW_CTRL_TX_RX_IN_FULL_DUPLEX

/* These macros describe Ethernet Serial Status reg (PSR) bits */
#define PORT_STATUS_MODE_10_BIT		(1<<0)
#define PORT_STATUS_LINK_UP			(1<<1)
#define PORT_STATUS_FULL_DUPLEX		(1<<2)
#define PORT_STATUS_FLOW_CONTROL		(1<<3)
#define PORT_STATUS_GMII_1000		(1<<4)
#define PORT_STATUS_MII_100			(1<<5)
/* PSR bit 6 is undocumented */
#define PORT_STATUS_TX_IN_PROGRESS		(1<<7)
#define PORT_STATUS_AUTONEG_BYPASSED	(1<<8)
#define PORT_STATUS_PARTITION		(1<<9)
#define PORT_STATUS_TX_FIFO_EMPTY		(1<<10)
/* PSR bits 11-31 are reserved */

#define	PORT_DEFAULT_TRANSMIT_QUEUE_SIZE	800
#define	PORT_DEFAULT_RECEIVE_QUEUE_SIZE	400

#define DESC_SIZE				64

#define ETH_RX_QUEUES_ENABLED	(1 << 0)	/* use only Q0 for receive */
#define ETH_TX_QUEUES_ENABLED	(1 << 0)	/* use only Q0 for transmit */

#define ETH_INT_CAUSE_RX_DONE	(ETH_RX_QUEUES_ENABLED << 2)
#define ETH_INT_CAUSE_RX_ERROR	(ETH_RX_QUEUES_ENABLED << 9)
#define ETH_INT_CAUSE_RX	(ETH_INT_CAUSE_RX_DONE | ETH_INT_CAUSE_RX_ERROR)
#define ETH_INT_CAUSE_EXT	0x00000002
#define ETH_INT_UNMASK_ALL	(ETH_INT_CAUSE_RX | ETH_INT_CAUSE_EXT)

#define ETH_INT_CAUSE_TX_DONE	(ETH_TX_QUEUES_ENABLED << 0)
#define ETH_INT_CAUSE_TX_ERROR	(ETH_TX_QUEUES_ENABLED << 8)
#define ETH_INT_CAUSE_TX	(ETH_INT_CAUSE_TX_DONE | ETH_INT_CAUSE_TX_ERROR)
#define ETH_INT_CAUSE_PHY	0x00010000
#define ETH_INT_CAUSE_STATE	0x00100000
#define ETH_INT_UNMASK_ALL_EXT	(ETH_INT_CAUSE_TX | ETH_INT_CAUSE_PHY | \
					ETH_INT_CAUSE_STATE)

#define ETH_INT_MASK_ALL	0x00000000
#define ETH_INT_MASK_ALL_EXT	0x00000000

#define PHY_WAIT_ITERATIONS	1000	/* 1000 iterations * 10uS = 10mS max */
#define PHY_WAIT_MICRO_SECONDS	10

/* Buffer offset from buffer pointer */
#define RX_BUF_OFFSET				0x2

/* Gigabit Ethernet Unit Global Registers */

/* MIB Counters register definitions */
#define ETH_MIB_GOOD_OCTETS_RECEIVED_LOW	0x0
#define ETH_MIB_GOOD_OCTETS_RECEIVED_HIGH	0x4
#define ETH_MIB_BAD_OCTETS_RECEIVED		0x8
#define ETH_MIB_INTERNAL_MAC_TRANSMIT_ERR	0xc
#define ETH_MIB_GOOD_FRAMES_RECEIVED		0x10
#define ETH_MIB_BAD_FRAMES_RECEIVED		0x14
#define ETH_MIB_BROADCAST_FRAMES_RECEIVED	0x18
#define ETH_MIB_MULTICAST_FRAMES_RECEIVED	0x1c
#define ETH_MIB_FRAMES_64_OCTETS		0x20
#define ETH_MIB_FRAMES_65_TO_127_OCTETS		0x24
#define ETH_MIB_FRAMES_128_TO_255_OCTETS	0x28
#define ETH_MIB_FRAMES_256_TO_511_OCTETS	0x2c
#define ETH_MIB_FRAMES_512_TO_1023_OCTETS	0x30
#define ETH_MIB_FRAMES_1024_TO_MAX_OCTETS	0x34
#define ETH_MIB_GOOD_OCTETS_SENT_LOW		0x38
#define ETH_MIB_GOOD_OCTETS_SENT_HIGH		0x3c
#define ETH_MIB_GOOD_FRAMES_SENT		0x40
#define ETH_MIB_EXCESSIVE_COLLISION		0x44
#define ETH_MIB_MULTICAST_FRAMES_SENT		0x48
#define ETH_MIB_BROADCAST_FRAMES_SENT		0x4c
#define ETH_MIB_UNREC_MAC_CONTROL_RECEIVED	0x50
#define ETH_MIB_FC_SENT				0x54
#define ETH_MIB_GOOD_FC_RECEIVED		0x58
#define ETH_MIB_BAD_FC_RECEIVED			0x5c
#define ETH_MIB_UNDERSIZE_RECEIVED		0x60
#define ETH_MIB_FRAGMENTS_RECEIVED		0x64
#define ETH_MIB_OVERSIZE_RECEIVED		0x68
#define ETH_MIB_JABBER_RECEIVED			0x6c
#define ETH_MIB_MAC_RECEIVE_ERROR		0x70
#define ETH_MIB_BAD_CRC_EVENT			0x74
#define ETH_MIB_COLLISION			0x78
#define ETH_MIB_LATE_COLLISION			0x7c

/* Port serial status reg (PSR) */
#define ETH_INTERFACE_PCM			0x00000001
#define ETH_LINK_IS_UP				0x00000002
#define ETH_PORT_AT_FULL_DUPLEX			0x00000004
#define ETH_RX_FLOW_CTRL_ENABLED		0x00000008
#define ETH_GMII_SPEED_1000			0x00000010
#define ETH_MII_SPEED_100			0x00000020
#define ETH_TX_IN_PROGRESS			0x00000080
#define ETH_BYPASS_ACTIVE			0x00000100
#define ETH_PORT_AT_PARTITION_STATE		0x00000200
#define ETH_PORT_TX_FIFO_EMPTY			0x00000400

/* SMI reg */
#define ETH_SMI_BUSY		0x10000000	/* 0 - Write, 1 - Read	*/
#define ETH_SMI_READ_VALID	0x08000000	/* 0 - Write, 1 - Read	*/
#define ETH_SMI_OPCODE_WRITE	0		/* Completion of Read	*/
#define ETH_SMI_OPCODE_READ 	0x04000000	/* Operation is in progress */

/* Interrupt Cause Register Bit Definitions */

/* SDMA command status fields macros */

/* Tx & Rx descriptors status */
#define ETH_ERROR_SUMMARY			0x00000001

/* Tx & Rx descriptors command */
#define ETH_BUFFER_OWNED_BY_DMA			0x80000000

/* Tx descriptors status */
#define ETH_LC_ERROR				0
#define ETH_UR_ERROR				0x00000002
#define ETH_RL_ERROR				0x00000004
#define ETH_LLC_SNAP_FORMAT			0x00000200

/* Rx descriptors status */
#define ETH_OVERRUN_ERROR			0x00000002
#define ETH_MAX_FRAME_LENGTH_ERROR		0x00000004
#define ETH_RESOURCE_ERROR			0x00000006
#define ETH_VLAN_TAGGED				0x00080000
#define ETH_BPDU_FRAME				0x00100000
#define ETH_UDP_FRAME_OVER_IP_V_4		0x00200000
#define ETH_OTHER_FRAME_TYPE			0x00400000
#define ETH_LAYER_2_IS_ETH_V_2			0x00800000
#define ETH_FRAME_TYPE_IP_V_4			0x01000000
#define ETH_FRAME_HEADER_OK			0x02000000
#define ETH_RX_LAST_DESC			0x04000000
#define ETH_RX_FIRST_DESC			0x08000000
#define ETH_UNKNOWN_DESTINATION_ADDR		0x10000000
#define ETH_RX_ENABLE_INTERRUPT			0x20000000
#define ETH_LAYER_4_CHECKSUM_OK			0x40000000

/* Rx descriptors byte count */
#define ETH_FRAME_FRAGMENTED			0x00000004

/* Tx descriptors command */
#define ETH_LAYER_4_CHECKSUM_FIRST_DESC		0x00000400
#define ETH_FRAME_SET_TO_VLAN			0x00008000
#define ETH_UDP_FRAME				0x00010000
#define ETH_GEN_TCP_UDP_CHECKSUM		0x00020000
#define ETH_GEN_IP_V_4_CHECKSUM			0x00040000
#define ETH_ZERO_PADDING			0x00080000
#define ETH_TX_LAST_DESC			0x00100000
#define ETH_TX_FIRST_DESC			0x00200000
#define ETH_GEN_CRC				0x00400000
#define ETH_TX_ENABLE_INTERRUPT			0x00800000
#define ETH_AUTO_MODE				0x40000000

#define ETH_TX_IHL_SHIFT			11

/* typedefs */

typedef enum _eth_func_ret_status {
	ETH_OK,			/* Returned as expected.		*/
	ETH_ERROR,		/* Fundamental error.			*/
	ETH_RETRY,		/* Could not process request. Try later.*/
	ETH_END_OF_JOB,		/* Ring has nothing to process.		*/
	ETH_QUEUE_FULL,		/* Ring resource error.			*/
	ETH_QUEUE_LAST_RESOURCE	/* Ring resources about to exhaust.	*/
} ETH_FUNC_RET_STATUS;

typedef enum _eth_target {
	ETH_TARGET_DRAM,
	ETH_TARGET_DEVICE,
	ETH_TARGET_CBS,
	ETH_TARGET_PCI0,
	ETH_TARGET_PCI1
} ETH_TARGET;

/* These are for big-endian machines.  Little endian needs different
 * definitions.
 */
#if defined(__BIG_ENDIAN)
struct eth_rx_desc {
	u16 byte_cnt;		/* Descriptor buffer byte count		*/
	u16 buf_size;		/* Buffer size				*/
	u32 cmd_sts;		/* Descriptor command status		*/
	u32 next_desc_ptr;	/* Next descriptor pointer		*/
	u32 buf_ptr;		/* Descriptor buffer pointer		*/
};

struct eth_tx_desc {
	u16 byte_cnt;		/* buffer byte count			*/
	u16 l4i_chk;		/* CPU provided TCP checksum		*/
	u32 cmd_sts;		/* Command/status field			*/
	u32 next_desc_ptr;	/* Pointer to next descriptor		*/
	u32 buf_ptr;		/* pointer to buffer for this descriptor*/
};

#elif defined(__LITTLE_ENDIAN)
struct eth_rx_desc {
	u32 cmd_sts;		/* Descriptor command status		*/
	u16 buf_size;		/* Buffer size				*/
	u16 byte_cnt;		/* Descriptor buffer byte count		*/
	u32 buf_ptr;		/* Descriptor buffer pointer		*/
	u32 next_desc_ptr;	/* Next descriptor pointer		*/
};

struct eth_tx_desc {
	u32 cmd_sts;		/* Command/status field			*/
	u16 l4i_chk;		/* CPU provided TCP checksum		*/
	u16 byte_cnt;		/* buffer byte count			*/
	u32 buf_ptr;		/* pointer to buffer for this descriptor*/
	u32 next_desc_ptr;	/* Pointer to next descriptor		*/
};
#else
#error One of __BIG_ENDIAN or __LITTLE_ENDIAN must be defined
#endif

/* Unified struct for Rx and Tx operations. The user is not required to	*/
/* be familier with neither Tx nor Rx descriptors.			*/
struct pkt_info {
	unsigned short byte_cnt;	/* Descriptor buffer byte count	*/
	unsigned short l4i_chk;		/* Tx CPU provided TCP Checksum	*/
	unsigned int cmd_sts;		/* Descriptor command status	*/
	dma_addr_t buf_ptr;		/* Descriptor buffer pointer	*/
	struct sk_buff *return_info;	/* User resource return information */
};

/* Ethernet port specific information */

struct mv643xx_mib_counters {
	u64 good_octets_received;
	u32 bad_octets_received;
	u32 internal_mac_transmit_err;
	u32 good_frames_received;
	u32 bad_frames_received;
	u32 broadcast_frames_received;
	u32 multicast_frames_received;
	u32 frames_64_octets;
	u32 frames_65_to_127_octets;
	u32 frames_128_to_255_octets;
	u32 frames_256_to_511_octets;
	u32 frames_512_to_1023_octets;
	u32 frames_1024_to_max_octets;
	u64 good_octets_sent;
	u32 good_frames_sent;
	u32 excessive_collision;
	u32 multicast_frames_sent;
	u32 broadcast_frames_sent;
	u32 unrec_mac_control_received;
	u32 fc_sent;
	u32 good_fc_received;
	u32 bad_fc_received;
	u32 undersize_received;
	u32 fragments_received;
	u32 oversize_received;
	u32 jabber_received;
	u32 mac_receive_error;
	u32 bad_crc_event;
	u32 collision;
	u32 late_collision;
};

struct mv643xx_private {
	int port_num;			/* User Ethernet port number	*/

	u32 rx_sram_addr;		/* Base address of rx sram area */
	u32 rx_sram_size;		/* Size of rx sram area		*/
	u32 tx_sram_addr;		/* Base address of tx sram area */
	u32 tx_sram_size;		/* Size of tx sram area		*/

	int rx_resource_err;		/* Rx ring resource error flag */

	/* Tx/Rx rings managment indexes fields. For driver use */

	/* Next available and first returning Rx resource */
	int rx_curr_desc_q, rx_used_desc_q;

	/* Next available and first returning Tx resource */
	int tx_curr_desc_q, tx_used_desc_q;

#ifdef MV643XX_TX_FAST_REFILL
	u32 tx_clean_threshold;
#endif

	struct eth_rx_desc *p_rx_desc_area;
	dma_addr_t rx_desc_dma;
	int rx_desc_area_size;
	struct sk_buff **rx_skb;

	struct eth_tx_desc *p_tx_desc_area;
	dma_addr_t tx_desc_dma;
	int tx_desc_area_size;
	struct sk_buff **tx_skb;

	struct work_struct tx_timeout_task;

	struct net_device *dev;
	struct napi_struct napi;
	struct net_device_stats stats;
	struct mv643xx_mib_counters mib_counters;
	spinlock_t lock;
	/* Size of Tx Ring per queue */
	int tx_ring_size;
	/* Number of tx descriptors in use */
	int tx_desc_count;
	/* Size of Rx Ring per queue */
	int rx_ring_size;
	/* Number of rx descriptors in use */
	int rx_desc_count;

	/*
	 * Used in case RX Ring is empty, which can be caused when
	 * system does not have resources (skb's)
	 */
	struct timer_list timeout;

	u32 rx_int_coal;
	u32 tx_int_coal;
	struct mii_if_info mii;
};

/* Port operation control routines */
static void eth_port_init(struct mv643xx_private *mp);
static void eth_port_reset(unsigned int eth_port_num);
static void eth_port_start(struct net_device *dev);

/* PHY and MIB routines */
static void ethernet_phy_reset(unsigned int eth_port_num);

static void eth_port_write_smi_reg(unsigned int eth_port_num,
				   unsigned int phy_reg, unsigned int value);

static void eth_port_read_smi_reg(unsigned int eth_port_num,
				  unsigned int phy_reg, unsigned int *value);

static void eth_clear_mib_counters(unsigned int eth_port_num);

/* Port data flow control routines */
static ETH_FUNC_RET_STATUS eth_port_receive(struct mv643xx_private *mp,
					    struct pkt_info *p_pkt_info);
static ETH_FUNC_RET_STATUS eth_rx_return_buff(struct mv643xx_private *mp,
					      struct pkt_info *p_pkt_info);

#endif				/* __MV643XX_ETH_H__ */