xref: /OK3568_Linux_fs/kernel/include/linux/mdio/mdio-xgene.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ */
2*4882a593Smuzhiyun /* Applied Micro X-Gene SoC MDIO Driver
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright (c) 2016, Applied Micro Circuits Corporation
5*4882a593Smuzhiyun  * Author: Iyappan Subramanian <isubramanian@apm.com>
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #ifndef __MDIO_XGENE_H__
9*4882a593Smuzhiyun #define __MDIO_XGENE_H__
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #define BLOCK_XG_MDIO_CSR_OFFSET	0x5000
12*4882a593Smuzhiyun #define BLOCK_DIAG_CSR_OFFSET		0xd000
13*4882a593Smuzhiyun #define XGENET_CONFIG_REG_ADDR		0x20
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #define MAC_ADDR_REG_OFFSET		0x00
16*4882a593Smuzhiyun #define MAC_COMMAND_REG_OFFSET		0x04
17*4882a593Smuzhiyun #define MAC_WRITE_REG_OFFSET		0x08
18*4882a593Smuzhiyun #define MAC_READ_REG_OFFSET		0x0c
19*4882a593Smuzhiyun #define MAC_COMMAND_DONE_REG_OFFSET	0x10
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun #define CLKEN_OFFSET			0x08
22*4882a593Smuzhiyun #define SRST_OFFSET			0x00
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #define MENET_CFG_MEM_RAM_SHUTDOWN_ADDR	0x70
25*4882a593Smuzhiyun #define MENET_BLOCK_MEM_RDY_ADDR	0x74
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun #define MAC_CONFIG_1_ADDR		0x00
28*4882a593Smuzhiyun #define MII_MGMT_COMMAND_ADDR		0x24
29*4882a593Smuzhiyun #define MII_MGMT_ADDRESS_ADDR		0x28
30*4882a593Smuzhiyun #define MII_MGMT_CONTROL_ADDR		0x2c
31*4882a593Smuzhiyun #define MII_MGMT_STATUS_ADDR		0x30
32*4882a593Smuzhiyun #define MII_MGMT_INDICATORS_ADDR	0x34
33*4882a593Smuzhiyun #define SOFT_RESET			BIT(31)
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #define MII_MGMT_CONFIG_ADDR            0x20
36*4882a593Smuzhiyun #define MII_MGMT_COMMAND_ADDR           0x24
37*4882a593Smuzhiyun #define MII_MGMT_ADDRESS_ADDR           0x28
38*4882a593Smuzhiyun #define MII_MGMT_CONTROL_ADDR           0x2c
39*4882a593Smuzhiyun #define MII_MGMT_STATUS_ADDR            0x30
40*4882a593Smuzhiyun #define MII_MGMT_INDICATORS_ADDR        0x34
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun #define MIIM_COMMAND_ADDR               0x20
43*4882a593Smuzhiyun #define MIIM_FIELD_ADDR                 0x24
44*4882a593Smuzhiyun #define MIIM_CONFIGURATION_ADDR         0x28
45*4882a593Smuzhiyun #define MIIM_LINKFAILVECTOR_ADDR        0x2c
46*4882a593Smuzhiyun #define MIIM_INDICATOR_ADDR             0x30
47*4882a593Smuzhiyun #define MIIMRD_FIELD_ADDR               0x34
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun #define MDIO_CSR_OFFSET			0x5000
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun #define REG_ADDR_POS			0
52*4882a593Smuzhiyun #define REG_ADDR_LEN			5
53*4882a593Smuzhiyun #define PHY_ADDR_POS			8
54*4882a593Smuzhiyun #define PHY_ADDR_LEN			5
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun #define HSTMIIMWRDAT_POS		0
57*4882a593Smuzhiyun #define HSTMIIMWRDAT_LEN		16
58*4882a593Smuzhiyun #define HSTPHYADX_POS			23
59*4882a593Smuzhiyun #define HSTPHYADX_LEN			5
60*4882a593Smuzhiyun #define HSTREGADX_POS			18
61*4882a593Smuzhiyun #define HSTREGADX_LEN			5
62*4882a593Smuzhiyun #define HSTLDCMD			BIT(3)
63*4882a593Smuzhiyun #define HSTMIIMCMD_POS			0
64*4882a593Smuzhiyun #define HSTMIIMCMD_LEN			3
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun #define BUSY_MASK			BIT(0)
67*4882a593Smuzhiyun #define READ_CYCLE_MASK			BIT(0)
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun enum xgene_enet_cmd {
70*4882a593Smuzhiyun 	XGENE_ENET_WR_CMD = BIT(31),
71*4882a593Smuzhiyun 	XGENE_ENET_RD_CMD = BIT(30)
72*4882a593Smuzhiyun };
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun enum {
75*4882a593Smuzhiyun 	MIIM_CMD_IDLE,
76*4882a593Smuzhiyun 	MIIM_CMD_LEGACY_WRITE,
77*4882a593Smuzhiyun 	MIIM_CMD_LEGACY_READ,
78*4882a593Smuzhiyun };
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun enum xgene_mdio_id {
81*4882a593Smuzhiyun 	XGENE_MDIO_RGMII = 1,
82*4882a593Smuzhiyun 	XGENE_MDIO_XFI
83*4882a593Smuzhiyun };
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun struct xgene_mdio_pdata {
86*4882a593Smuzhiyun 	struct clk *clk;
87*4882a593Smuzhiyun 	struct device *dev;
88*4882a593Smuzhiyun 	void __iomem *mac_csr_addr;
89*4882a593Smuzhiyun 	void __iomem *diag_csr_addr;
90*4882a593Smuzhiyun 	void __iomem *mdio_csr_addr;
91*4882a593Smuzhiyun 	struct mii_bus *mdio_bus;
92*4882a593Smuzhiyun 	int mdio_id;
93*4882a593Smuzhiyun 	spinlock_t mac_lock; /* mac lock */
94*4882a593Smuzhiyun };
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun /* Set the specified value into a bit-field defined by its starting position
97*4882a593Smuzhiyun  * and length within a single u64.
98*4882a593Smuzhiyun  */
xgene_enet_set_field_value(int pos,int len,u64 val)99*4882a593Smuzhiyun static inline u64 xgene_enet_set_field_value(int pos, int len, u64 val)
100*4882a593Smuzhiyun {
101*4882a593Smuzhiyun 	return (val & ((1ULL << len) - 1)) << pos;
102*4882a593Smuzhiyun }
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun #define SET_VAL(field, val) \
105*4882a593Smuzhiyun 		xgene_enet_set_field_value(field ## _POS, field ## _LEN, val)
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun #define SET_BIT(field) \
108*4882a593Smuzhiyun 		xgene_enet_set_field_value(field ## _POS, 1, 1)
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun /* Get the value from a bit-field defined by its starting position
111*4882a593Smuzhiyun  * and length within the specified u64.
112*4882a593Smuzhiyun  */
xgene_enet_get_field_value(int pos,int len,u64 src)113*4882a593Smuzhiyun static inline u64 xgene_enet_get_field_value(int pos, int len, u64 src)
114*4882a593Smuzhiyun {
115*4882a593Smuzhiyun 	return (src >> pos) & ((1ULL << len) - 1);
116*4882a593Smuzhiyun }
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun #define GET_VAL(field, src) \
119*4882a593Smuzhiyun 		xgene_enet_get_field_value(field ## _POS, field ## _LEN, src)
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun #define GET_BIT(field, src) \
122*4882a593Smuzhiyun 		xgene_enet_get_field_value(field ## _POS, 1, src)
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun u32 xgene_mdio_rd_mac(struct xgene_mdio_pdata *pdata, u32 rd_addr);
125*4882a593Smuzhiyun void xgene_mdio_wr_mac(struct xgene_mdio_pdata *pdata, u32 wr_addr, u32 data);
126*4882a593Smuzhiyun int xgene_mdio_rgmii_read(struct mii_bus *bus, int phy_id, int reg);
127*4882a593Smuzhiyun int xgene_mdio_rgmii_write(struct mii_bus *bus, int phy_id, int reg, u16 data);
128*4882a593Smuzhiyun struct phy_device *xgene_enet_phy_register(struct mii_bus *bus, int phy_addr);
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun #endif  /* __MDIO_XGENE_H__ */
131