[deliverable/linux.git] / drivers / net / ethernet / apm / xgene / xgene_enet_hw.h

/* Applied Micro X-Gene SoC Ethernet Driver
 *
 * Copyright (c) 2014, Applied Micro Circuits Corporation
 * Authors: Iyappan Subramanian <isubramanian@apm.com>
 *	    Ravi Patel <rapatel@apm.com>
 *	    Keyur Chudgar <kchudgar@apm.com>
 *
 * 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef __XGENE_ENET_HW_H__
#define __XGENE_ENET_HW_H__

#include "xgene_enet_main.h"

struct xgene_enet_pdata;
struct xgene_enet_stats;
struct xgene_enet_desc_ring;

/* clears and then set bits */
static inline void xgene_set_bits(u32 *dst, u32 val, u32 start, u32 len)
{
	u32 end = start + len - 1;
	u32 mask = GENMASK(end, start);

	*dst &= ~mask;
	*dst |= (val << start) & mask;
}

static inline u32 xgene_get_bits(u32 val, u32 start, u32 end)
{
	return (val & GENMASK(end, start)) >> start;
}

enum xgene_enet_rm {
	RM0,
	RM1,
	RM3 = 3
};

#define CSR_RING_ID		0x0008
#define OVERWRITE		BIT(31)
#define IS_BUFFER_POOL		BIT(20)
#define PREFETCH_BUF_EN		BIT(21)
#define CSR_RING_ID_BUF		0x000c
#define CSR_RING_NE_INT_MODE	0x017c
#define CSR_RING_CONFIG		0x006c
#define CSR_RING_WR_BASE	0x0070
#define NUM_RING_CONFIG		5
#define BUFPOOL_MODE		3
#define INC_DEC_CMD_ADDR	0x002c
#define UDP_HDR_SIZE		2
#define BUF_LEN_CODE_2K		0x5000

#define CREATE_MASK(pos, len)		GENMASK((pos)+(len)-1, (pos))
#define CREATE_MASK_ULL(pos, len)	GENMASK_ULL((pos)+(len)-1, (pos))

/* Empty slot soft signature */
#define EMPTY_SLOT_INDEX	1
#define EMPTY_SLOT		~0ULL

#define WORK_DESC_SIZE		32
#define BUFPOOL_DESC_SIZE	16

#define RING_OWNER_MASK		GENMASK(9, 6)
#define RING_BUFNUM_MASK	GENMASK(5, 0)

#define SELTHRSH_POS		3
#define SELTHRSH_LEN		3
#define RINGADDRL_POS		5
#define RINGADDRL_LEN		27
#define RINGADDRH_POS		0
#define RINGADDRH_LEN		6
#define RINGSIZE_POS		23
#define RINGSIZE_LEN		3
#define RINGTYPE_POS		19
#define RINGTYPE_LEN		2
#define RINGMODE_POS		20
#define RINGMODE_LEN		3
#define RECOMTIMEOUTL_POS	28
#define RECOMTIMEOUTL_LEN	3
#define RECOMTIMEOUTH_POS	0
#define RECOMTIMEOUTH_LEN	2
#define NUMMSGSINQ_POS		1
#define NUMMSGSINQ_LEN		16
#define ACCEPTLERR		BIT(19)
#define QCOHERENT		BIT(4)
#define RECOMBBUF		BIT(27)

#define MAC_OFFSET			0x30

#define BLOCK_ETH_CSR_OFFSET		0x2000
#define BLOCK_ETH_RING_IF_OFFSET	0x9000
#define BLOCK_ETH_CLKRST_CSR_OFFSET	0xc000
#define BLOCK_ETH_DIAG_CSR_OFFSET	0xD000

#define BLOCK_ETH_MAC_OFFSET		0x0000
#define BLOCK_ETH_MAC_CSR_OFFSET	0x2800

#define CLKEN_ADDR			0xc208
#define SRST_ADDR			0xc200

#define MAC_ADDR_REG_OFFSET		0x00
#define MAC_COMMAND_REG_OFFSET		0x04
#define MAC_WRITE_REG_OFFSET		0x08
#define MAC_READ_REG_OFFSET		0x0c
#define MAC_COMMAND_DONE_REG_OFFSET	0x10

#define MII_MGMT_CONFIG_ADDR		0x20
#define MII_MGMT_COMMAND_ADDR		0x24
#define MII_MGMT_ADDRESS_ADDR		0x28
#define MII_MGMT_CONTROL_ADDR		0x2c
#define MII_MGMT_STATUS_ADDR		0x30
#define MII_MGMT_INDICATORS_ADDR	0x34

#define BUSY_MASK			BIT(0)
#define READ_CYCLE_MASK			BIT(0)
#define PHY_CONTROL_SET(dst, val)	xgene_set_bits(dst, val, 0, 16)

#define ENET_SPARE_CFG_REG_ADDR		0x0750
#define RSIF_CONFIG_REG_ADDR		0x0010
#define RSIF_RAM_DBG_REG0_ADDR		0x0048
#define RGMII_REG_0_ADDR		0x07e0
#define CFG_LINK_AGGR_RESUME_0_ADDR	0x07c8
#define DEBUG_REG_ADDR			0x0700
#define CFG_BYPASS_ADDR			0x0294
#define CLE_BYPASS_REG0_0_ADDR		0x0490
#define CLE_BYPASS_REG1_0_ADDR		0x0494
#define CFG_RSIF_FPBUFF_TIMEOUT_EN	BIT(31)
#define RESUME_TX			BIT(0)
#define CFG_SPEED_1250			BIT(24)
#define TX_PORT0			BIT(0)
#define CFG_BYPASS_UNISEC_TX		BIT(2)
#define CFG_BYPASS_UNISEC_RX		BIT(1)
#define CFG_CLE_BYPASS_EN0		BIT(31)
#define CFG_TXCLK_MUXSEL0_SET(dst, val)	xgene_set_bits(dst, val, 29, 3)

#define CFG_CLE_IP_PROTOCOL0_SET(dst, val)	xgene_set_bits(dst, val, 16, 2)
#define CFG_CLE_DSTQID0_SET(dst, val)		xgene_set_bits(dst, val, 0, 12)
#define CFG_CLE_FPSEL0_SET(dst, val)		xgene_set_bits(dst, val, 16, 4)
#define CFG_MACMODE_SET(dst, val)		xgene_set_bits(dst, val, 18, 2)
#define CFG_WAITASYNCRD_SET(dst, val)		xgene_set_bits(dst, val, 0, 16)
#define CFG_CLE_DSTQID0(val)		(val & GENMASK(11, 0))
#define CFG_CLE_FPSEL0(val)		((val << 16) & GENMASK(19, 16))
#define ICM_CONFIG0_REG_0_ADDR		0x0400
#define ICM_CONFIG2_REG_0_ADDR		0x0410
#define RX_DV_GATE_REG_0_ADDR		0x05fc
#define TX_DV_GATE_EN0			BIT(2)
#define RX_DV_GATE_EN0			BIT(1)
#define RESUME_RX0			BIT(0)
#define ENET_CFGSSQMIWQASSOC_ADDR		0xe0
#define ENET_CFGSSQMIFPQASSOC_ADDR		0xdc
#define ENET_CFGSSQMIQMLITEFPQASSOC_ADDR	0xf0
#define ENET_CFGSSQMIQMLITEWQASSOC_ADDR		0xf4
#define ENET_CFG_MEM_RAM_SHUTDOWN_ADDR		0x70
#define ENET_BLOCK_MEM_RDY_ADDR			0x74
#define MAC_CONFIG_1_ADDR			0x00
#define MAC_CONFIG_2_ADDR			0x04
#define MAX_FRAME_LEN_ADDR			0x10
#define INTERFACE_CONTROL_ADDR			0x38
#define STATION_ADDR0_ADDR			0x40
#define STATION_ADDR1_ADDR			0x44
#define PHY_ADDR_SET(dst, val)			xgene_set_bits(dst, val, 8, 5)
#define REG_ADDR_SET(dst, val)			xgene_set_bits(dst, val, 0, 5)
#define ENET_INTERFACE_MODE2_SET(dst, val)	xgene_set_bits(dst, val, 8, 2)
#define MGMT_CLOCK_SEL_SET(dst, val)		xgene_set_bits(dst, val, 0, 3)
#define SOFT_RESET1			BIT(31)
#define TX_EN				BIT(0)
#define RX_EN				BIT(2)
#define ENET_LHD_MODE			BIT(25)
#define ENET_GHD_MODE			BIT(26)
#define FULL_DUPLEX2			BIT(0)
#define SCAN_AUTO_INCR			BIT(5)
#define TBYT_ADDR			0x38
#define TPKT_ADDR			0x39
#define TDRP_ADDR			0x45
#define TFCS_ADDR			0x47
#define TUND_ADDR			0x4a

#define TSO_IPPROTO_TCP			1

#define USERINFO_POS			0
#define USERINFO_LEN			32
#define FPQNUM_POS			32
#define FPQNUM_LEN			12
#define LERR_POS			60
#define LERR_LEN			3
#define STASH_POS			52
#define STASH_LEN			2
#define BUFDATALEN_POS			48
#define BUFDATALEN_LEN			12
#define DATAADDR_POS			0
#define DATAADDR_LEN			42
#define COHERENT_POS			63
#define HENQNUM_POS			48
#define HENQNUM_LEN			12
#define TYPESEL_POS			44
#define TYPESEL_LEN			4
#define ETHHDR_POS			12
#define ETHHDR_LEN			8
#define IC_POS				35	/* Insert CRC */
#define TCPHDR_POS			0
#define TCPHDR_LEN			6
#define IPHDR_POS			6
#define IPHDR_LEN			6
#define EC_POS				22	/* Enable checksum */
#define EC_LEN				1
#define IS_POS				24	/* IP protocol select */
#define IS_LEN				1
#define TYPE_ETH_WORK_MESSAGE_POS	44

struct xgene_enet_raw_desc {
	__le64 m0;
	__le64 m1;
	__le64 m2;
	__le64 m3;
};

struct xgene_enet_raw_desc16 {
	__le64 m0;
	__le64 m1;
};

static inline void xgene_enet_mark_desc_slot_empty(void *desc_slot_ptr)
{
	__le64 *desc_slot = desc_slot_ptr;

	desc_slot[EMPTY_SLOT_INDEX] = cpu_to_le64(EMPTY_SLOT);
}

static inline bool xgene_enet_is_desc_slot_empty(void *desc_slot_ptr)
{
	__le64 *desc_slot = desc_slot_ptr;

	return (desc_slot[EMPTY_SLOT_INDEX] == cpu_to_le64(EMPTY_SLOT));
}

enum xgene_enet_ring_cfgsize {
	RING_CFGSIZE_512B,
	RING_CFGSIZE_2KB,
	RING_CFGSIZE_16KB,
	RING_CFGSIZE_64KB,
	RING_CFGSIZE_512KB,
	RING_CFGSIZE_INVALID
};

enum xgene_enet_ring_type {
	RING_DISABLED,
	RING_REGULAR,
	RING_BUFPOOL
};

enum xgene_ring_owner {
	RING_OWNER_ETH0,
	RING_OWNER_ETH1,
	RING_OWNER_CPU = 15,
	RING_OWNER_INVALID
};

enum xgene_enet_ring_bufnum {
	RING_BUFNUM_REGULAR = 0x0,
	RING_BUFNUM_BUFPOOL = 0x20,
	RING_BUFNUM_INVALID
};

enum xgene_enet_cmd {
	XGENE_ENET_WR_CMD = BIT(31),
	XGENE_ENET_RD_CMD = BIT(30)
};

enum xgene_enet_err_code {
	HBF_READ_DATA = 3,
	HBF_LL_READ = 4,
	BAD_WORK_MSG = 6,
	BUFPOOL_TIMEOUT = 15,
	INGRESS_CRC = 16,
	INGRESS_CHECKSUM = 17,
	INGRESS_TRUNC_FRAME = 18,
	INGRESS_PKT_LEN = 19,
	INGRESS_PKT_UNDER = 20,
	INGRESS_FIFO_OVERRUN = 21,
	INGRESS_CHECKSUM_COMPUTE = 26,
	ERR_CODE_INVALID
};

static inline enum xgene_ring_owner xgene_enet_ring_owner(u16 id)
{
	return (id & RING_OWNER_MASK) >> 6;
}

static inline u8 xgene_enet_ring_bufnum(u16 id)
{
	return id & RING_BUFNUM_MASK;
}

static inline bool xgene_enet_is_bufpool(u16 id)
{
	return ((id & RING_BUFNUM_MASK) >= 0x20) ? true : false;
}

static inline u16 xgene_enet_get_numslots(u16 id, u32 size)
{
	bool is_bufpool = xgene_enet_is_bufpool(id);

	return (is_bufpool) ? size / BUFPOOL_DESC_SIZE :
		      size / WORK_DESC_SIZE;
}

void xgene_enet_parse_error(struct xgene_enet_desc_ring *ring,
			    struct xgene_enet_pdata *pdata,
			    enum xgene_enet_err_code status);

int xgene_enet_mdio_config(struct xgene_enet_pdata *pdata);
void xgene_enet_mdio_remove(struct xgene_enet_pdata *pdata);
bool xgene_ring_mgr_init(struct xgene_enet_pdata *p);

extern struct xgene_mac_ops xgene_gmac_ops;
extern struct xgene_port_ops xgene_gport_ops;
extern struct xgene_ring_ops xgene_ring1_ops;

#endif /* __XGENE_ENET_HW_H__ */
Commit	Line	Data
e6ad7673 IS	1	/* Applied Micro X-Gene SoC Ethernet Driver
	2	*
	3	* Copyright (c) 2014, Applied Micro Circuits Corporation
	4	* Authors: Iyappan Subramanian <isubramanian@apm.com>
	5	* Ravi Patel <rapatel@apm.com>
	6	* Keyur Chudgar <kchudgar@apm.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public License as published by the
	10	* Free Software Foundation; either version 2 of the License, or (at your
	11	* option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	20	*/
	21
	22	#ifndef __XGENE_ENET_HW_H__
	23	#define __XGENE_ENET_HW_H__
	24
	25	#include "xgene_enet_main.h"
	26
	27	struct xgene_enet_pdata;
	28	struct xgene_enet_stats;
81cefb81	29	struct xgene_enet_desc_ring;
e6ad7673 IS	30
	31	/* clears and then set bits */
	32	static inline void xgene_set_bits(u32 *dst, u32 val, u32 start, u32 len)
	33	{
	34	u32 end = start + len - 1;
	35	u32 mask = GENMASK(end, start);
	36
	37	*dst &= ~mask;
	38	*dst \|= (val << start) & mask;
	39	}
	40
	41	static inline u32 xgene_get_bits(u32 val, u32 start, u32 end)
	42	{
	43	return (val & GENMASK(end, start)) >> start;
	44	}
	45
0148d38d IS	46	enum xgene_enet_rm {
0148d38d IS	47	RM0,
32f784b5	48	RM1,
0148d38d IS	49	RM3 = 3
	50	};
	51
e6ad7673 IS	52	#define CSR_RING_ID 0x0008
	53	#define OVERWRITE BIT(31)
	54	#define IS_BUFFER_POOL BIT(20)
	55	#define PREFETCH_BUF_EN BIT(21)
	56	#define CSR_RING_ID_BUF 0x000c
	57	#define CSR_RING_NE_INT_MODE 0x017c
	58	#define CSR_RING_CONFIG 0x006c
	59	#define CSR_RING_WR_BASE 0x0070
	60	#define NUM_RING_CONFIG 5
	61	#define BUFPOOL_MODE 3
e6ad7673 IS	62	#define INC_DEC_CMD_ADDR 0x002c
	63	#define UDP_HDR_SIZE 2
	64	#define BUF_LEN_CODE_2K 0x5000
	65
	66	#define CREATE_MASK(pos, len) GENMASK((pos)+(len)-1, (pos))
	67	#define CREATE_MASK_ULL(pos, len) GENMASK_ULL((pos)+(len)-1, (pos))
	68
	69	/* Empty slot soft signature */
	70	#define EMPTY_SLOT_INDEX 1
	71	#define EMPTY_SLOT ~0ULL
	72
	73	#define WORK_DESC_SIZE 32
	74	#define BUFPOOL_DESC_SIZE 16
	75
	76	#define RING_OWNER_MASK GENMASK(9, 6)
	77	#define RING_BUFNUM_MASK GENMASK(5, 0)
	78
	79	#define SELTHRSH_POS 3
	80	#define SELTHRSH_LEN 3
	81	#define RINGADDRL_POS 5
	82	#define RINGADDRL_LEN 27
	83	#define RINGADDRH_POS 0
	84	#define RINGADDRH_LEN 6
	85	#define RINGSIZE_POS 23
	86	#define RINGSIZE_LEN 3
	87	#define RINGTYPE_POS 19
	88	#define RINGTYPE_LEN 2
	89	#define RINGMODE_POS 20
	90	#define RINGMODE_LEN 3
	91	#define RECOMTIMEOUTL_POS 28
	92	#define RECOMTIMEOUTL_LEN 3
	93	#define RECOMTIMEOUTH_POS 0
	94	#define RECOMTIMEOUTH_LEN 2
	95	#define NUMMSGSINQ_POS 1
	96	#define NUMMSGSINQ_LEN 16
	97	#define ACCEPTLERR BIT(19)
	98	#define QCOHERENT BIT(4)
	99	#define RECOMBBUF BIT(27)
	100
ca626454 KC	101	#define MAC_OFFSET 0x30
ca626454 KC	102
e6ad7673 IS	103	#define BLOCK_ETH_CSR_OFFSET 0x2000
e6ad7673 IS	104	#define BLOCK_ETH_RING_IF_OFFSET 0x9000
bc1b7c13	105	#define BLOCK_ETH_CLKRST_CSR_OFFSET 0xc000
e6ad7673 IS	106	#define BLOCK_ETH_DIAG_CSR_OFFSET 0xD000
	107
	108	#define BLOCK_ETH_MAC_OFFSET 0x0000
e6ad7673 IS	109	#define BLOCK_ETH_MAC_CSR_OFFSET 0x2800
e6ad7673 IS	110
c3f4465d IS	111	#define CLKEN_ADDR 0xc208
	112	#define SRST_ADDR 0xc200
	113
e6ad7673 IS	114	#define MAC_ADDR_REG_OFFSET 0x00
	115	#define MAC_COMMAND_REG_OFFSET 0x04
	116	#define MAC_WRITE_REG_OFFSET 0x08
	117	#define MAC_READ_REG_OFFSET 0x0c
	118	#define MAC_COMMAND_DONE_REG_OFFSET 0x10
	119
e6ad7673 IS	120	#define MII_MGMT_CONFIG_ADDR 0x20
	121	#define MII_MGMT_COMMAND_ADDR 0x24
	122	#define MII_MGMT_ADDRESS_ADDR 0x28
	123	#define MII_MGMT_CONTROL_ADDR 0x2c
	124	#define MII_MGMT_STATUS_ADDR 0x30
	125	#define MII_MGMT_INDICATORS_ADDR 0x34
	126
	127	#define BUSY_MASK BIT(0)
	128	#define READ_CYCLE_MASK BIT(0)
	129	#define PHY_CONTROL_SET(dst, val) xgene_set_bits(dst, val, 0, 16)
	130
	131	#define ENET_SPARE_CFG_REG_ADDR 0x0750
	132	#define RSIF_CONFIG_REG_ADDR 0x0010
	133	#define RSIF_RAM_DBG_REG0_ADDR 0x0048
	134	#define RGMII_REG_0_ADDR 0x07e0
	135	#define CFG_LINK_AGGR_RESUME_0_ADDR 0x07c8
	136	#define DEBUG_REG_ADDR 0x0700
	137	#define CFG_BYPASS_ADDR 0x0294
	138	#define CLE_BYPASS_REG0_0_ADDR 0x0490
	139	#define CLE_BYPASS_REG1_0_ADDR 0x0494
	140	#define CFG_RSIF_FPBUFF_TIMEOUT_EN BIT(31)
	141	#define RESUME_TX BIT(0)
	142	#define CFG_SPEED_1250 BIT(24)
	143	#define TX_PORT0 BIT(0)
	144	#define CFG_BYPASS_UNISEC_TX BIT(2)
	145	#define CFG_BYPASS_UNISEC_RX BIT(1)
	146	#define CFG_CLE_BYPASS_EN0 BIT(31)
	147	#define CFG_TXCLK_MUXSEL0_SET(dst, val) xgene_set_bits(dst, val, 29, 3)
	148
	149	#define CFG_CLE_IP_PROTOCOL0_SET(dst, val) xgene_set_bits(dst, val, 16, 2)
	150	#define CFG_CLE_DSTQID0_SET(dst, val) xgene_set_bits(dst, val, 0, 12)
	151	#define CFG_CLE_FPSEL0_SET(dst, val) xgene_set_bits(dst, val, 16, 4)
	152	#define CFG_MACMODE_SET(dst, val) xgene_set_bits(dst, val, 18, 2)
	153	#define CFG_WAITASYNCRD_SET(dst, val) xgene_set_bits(dst, val, 0, 16)
32f784b5 IS	154	#define CFG_CLE_DSTQID0(val) (val & GENMASK(11, 0))
32f784b5 IS	155	#define CFG_CLE_FPSEL0(val) ((val << 16) & GENMASK(19, 16))
e6ad7673 IS	156	#define ICM_CONFIG0_REG_0_ADDR 0x0400
	157	#define ICM_CONFIG2_REG_0_ADDR 0x0410
	158	#define RX_DV_GATE_REG_0_ADDR 0x05fc
	159	#define TX_DV_GATE_EN0 BIT(2)
	160	#define RX_DV_GATE_EN0 BIT(1)
	161	#define RESUME_RX0 BIT(0)
	162	#define ENET_CFGSSQMIWQASSOC_ADDR 0xe0
	163	#define ENET_CFGSSQMIFPQASSOC_ADDR 0xdc
	164	#define ENET_CFGSSQMIQMLITEFPQASSOC_ADDR 0xf0
	165	#define ENET_CFGSSQMIQMLITEWQASSOC_ADDR 0xf4
	166	#define ENET_CFG_MEM_RAM_SHUTDOWN_ADDR 0x70
	167	#define ENET_BLOCK_MEM_RDY_ADDR 0x74
	168	#define MAC_CONFIG_1_ADDR 0x00
	169	#define MAC_CONFIG_2_ADDR 0x04
	170	#define MAX_FRAME_LEN_ADDR 0x10
	171	#define INTERFACE_CONTROL_ADDR 0x38
	172	#define STATION_ADDR0_ADDR 0x40
	173	#define STATION_ADDR1_ADDR 0x44
	174	#define PHY_ADDR_SET(dst, val) xgene_set_bits(dst, val, 8, 5)
	175	#define REG_ADDR_SET(dst, val) xgene_set_bits(dst, val, 0, 5)
	176	#define ENET_INTERFACE_MODE2_SET(dst, val) xgene_set_bits(dst, val, 8, 2)
	177	#define MGMT_CLOCK_SEL_SET(dst, val) xgene_set_bits(dst, val, 0, 3)
	178	#define SOFT_RESET1 BIT(31)
	179	#define TX_EN BIT(0)
	180	#define RX_EN BIT(2)
	181	#define ENET_LHD_MODE BIT(25)
	182	#define ENET_GHD_MODE BIT(26)
	183	#define FULL_DUPLEX2 BIT(0)
	184	#define SCAN_AUTO_INCR BIT(5)
	185	#define TBYT_ADDR 0x38
	186	#define TPKT_ADDR 0x39
	187	#define TDRP_ADDR 0x45
	188	#define TFCS_ADDR 0x47
	189	#define TUND_ADDR 0x4a
	190
	191	#define TSO_IPPROTO_TCP 1
e6ad7673 IS	192
	193	#define USERINFO_POS 0
	194	#define USERINFO_LEN 32
	195	#define FPQNUM_POS 32
	196	#define FPQNUM_LEN 12
	197	#define LERR_POS 60
	198	#define LERR_LEN 3
	199	#define STASH_POS 52
	200	#define STASH_LEN 2
	201	#define BUFDATALEN_POS 48
	202	#define BUFDATALEN_LEN 12
	203	#define DATAADDR_POS 0
	204	#define DATAADDR_LEN 42
	205	#define COHERENT_POS 63
	206	#define HENQNUM_POS 48
	207	#define HENQNUM_LEN 12
	208	#define TYPESEL_POS 44
	209	#define TYPESEL_LEN 4
	210	#define ETHHDR_POS 12
	211	#define ETHHDR_LEN 8
	212	#define IC_POS 35 /* Insert CRC */
	213	#define TCPHDR_POS 0
	214	#define TCPHDR_LEN 6
	215	#define IPHDR_POS 6
	216	#define IPHDR_LEN 6
	217	#define EC_POS 22 /* Enable checksum */
	218	#define EC_LEN 1
	219	#define IS_POS 24 /* IP protocol select */
	220	#define IS_LEN 1
	221	#define TYPE_ETH_WORK_MESSAGE_POS 44
	222
	223	struct xgene_enet_raw_desc {
	224	__le64 m0;
	225	__le64 m1;
	226	__le64 m2;
	227	__le64 m3;
	228	};
	229
	230	struct xgene_enet_raw_desc16 {
	231	__le64 m0;
	232	__le64 m1;
	233	};
	234
	235	static inline void xgene_enet_mark_desc_slot_empty(void *desc_slot_ptr)
	236	{
	237	__le64 *desc_slot = desc_slot_ptr;
	238
	239	desc_slot[EMPTY_SLOT_INDEX] = cpu_to_le64(EMPTY_SLOT);
	240	}
	241
	242	static inline bool xgene_enet_is_desc_slot_empty(void *desc_slot_ptr)
	243	{
	244	__le64 *desc_slot = desc_slot_ptr;
	245
	246	return (desc_slot[EMPTY_SLOT_INDEX] == cpu_to_le64(EMPTY_SLOT));
	247	}
	248
	249	enum xgene_enet_ring_cfgsize {
	250	RING_CFGSIZE_512B,
	251	RING_CFGSIZE_2KB,
	252	RING_CFGSIZE_16KB,
	253	RING_CFGSIZE_64KB,
	254	RING_CFGSIZE_512KB,
	255	RING_CFGSIZE_INVALID
256	};
257
258	enum xgene_enet_ring_type {
259	RING_DISABLED,
260	RING_REGULAR,
261	RING_BUFPOOL
262	};
263
264	enum xgene_ring_owner {
265	RING_OWNER_ETH0,
ed9b7da0	266	RING_OWNER_ETH1,
e6ad7673 IS	267	RING_OWNER_CPU = 15,
	268	RING_OWNER_INVALID
	269	};
	270
	271	enum xgene_enet_ring_bufnum {
	272	RING_BUFNUM_REGULAR = 0x0,
	273	RING_BUFNUM_BUFPOOL = 0x20,
	274	RING_BUFNUM_INVALID
	275	};
	276
	277	enum xgene_enet_cmd {
	278	XGENE_ENET_WR_CMD = BIT(31),
	279	XGENE_ENET_RD_CMD = BIT(30)
	280	};
	281
	282	enum xgene_enet_err_code {
	283	HBF_READ_DATA = 3,
	284	HBF_LL_READ = 4,
	285	BAD_WORK_MSG = 6,
	286	BUFPOOL_TIMEOUT = 15,
	287	INGRESS_CRC = 16,
	288	INGRESS_CHECKSUM = 17,
	289	INGRESS_TRUNC_FRAME = 18,
	290	INGRESS_PKT_LEN = 19,
	291	INGRESS_PKT_UNDER = 20,
	292	INGRESS_FIFO_OVERRUN = 21,
	293	INGRESS_CHECKSUM_COMPUTE = 26,
	294	ERR_CODE_INVALID
	295	};
	296
	297	static inline enum xgene_ring_owner xgene_enet_ring_owner(u16 id)
	298	{
	299	return (id & RING_OWNER_MASK) >> 6;
	300	}
	301
	302	static inline u8 xgene_enet_ring_bufnum(u16 id)
	303	{
	304	return id & RING_BUFNUM_MASK;
	305	}
	306
	307	static inline bool xgene_enet_is_bufpool(u16 id)
	308	{
	309	return ((id & RING_BUFNUM_MASK) >= 0x20) ? true : false;
	310	}
	311
	312	static inline u16 xgene_enet_get_numslots(u16 id, u32 size)
	313	{
	314	bool is_bufpool = xgene_enet_is_bufpool(id);
	315
	316	return (is_bufpool) ? size / BUFPOOL_DESC_SIZE :
	317	size / WORK_DESC_SIZE;
	318	}
	319
e6ad7673 IS	320	void xgene_enet_parse_error(struct xgene_enet_desc_ring *ring,
	321	struct xgene_enet_pdata *pdata,
	322	enum xgene_enet_err_code status);
	323
e6ad7673 IS	324	int xgene_enet_mdio_config(struct xgene_enet_pdata *pdata);
e6ad7673 IS	325	void xgene_enet_mdio_remove(struct xgene_enet_pdata *pdata);
c3f4465d	326	bool xgene_ring_mgr_init(struct xgene_enet_pdata *p);
e6ad7673	327
d0eb7458 IS	328	extern struct xgene_mac_ops xgene_gmac_ops;
d0eb7458 IS	329	extern struct xgene_port_ops xgene_gport_ops;
81cefb81	330	extern struct xgene_ring_ops xgene_ring1_ops;
d0eb7458	331
e6ad7673	332	#endif /* __XGENE_ENET_HW_H__ */