xref: /linux/drivers/net/phy/aquantia/aquantia.h (revision 2a52ca7c98960aafb0eca9ef96b2d0c932171357)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* HWMON driver for Aquantia PHY
3  *
4  * Author: Nikita Yushchenko <nikita.yoush@cogentembedded.com>
5  * Author: Andrew Lunn <andrew@lunn.ch>
6  * Author: Heiner Kallweit <hkallweit1@gmail.com>
7  */
8 
9 #include <linux/device.h>
10 #include <linux/phy.h>
11 
12 /* Vendor specific 1, MDIO_MMD_VEND1 */
13 #define VEND1_GLOBAL_SC				0x0
14 #define VEND1_GLOBAL_SC_SOFT_RESET		BIT(15)
15 #define VEND1_GLOBAL_SC_LOW_POWER		BIT(11)
16 
17 #define VEND1_GLOBAL_FW_ID			0x0020
18 #define VEND1_GLOBAL_FW_ID_MAJOR		GENMASK(15, 8)
19 #define VEND1_GLOBAL_FW_ID_MINOR		GENMASK(7, 0)
20 
21 #define VEND1_GLOBAL_MAILBOX_INTERFACE1			0x0200
22 #define VEND1_GLOBAL_MAILBOX_INTERFACE1_EXECUTE		BIT(15)
23 #define VEND1_GLOBAL_MAILBOX_INTERFACE1_WRITE		BIT(14)
24 #define VEND1_GLOBAL_MAILBOX_INTERFACE1_CRC_RESET	BIT(12)
25 #define VEND1_GLOBAL_MAILBOX_INTERFACE1_BUSY		BIT(8)
26 
27 #define VEND1_GLOBAL_MAILBOX_INTERFACE2			0x0201
28 #define VEND1_GLOBAL_MAILBOX_INTERFACE3			0x0202
29 #define VEND1_GLOBAL_MAILBOX_INTERFACE3_MSW_ADDR_MASK	GENMASK(15, 0)
30 #define VEND1_GLOBAL_MAILBOX_INTERFACE3_MSW_ADDR(x)	FIELD_PREP(VEND1_GLOBAL_MAILBOX_INTERFACE3_MSW_ADDR_MASK, (u16)((x) >> 16))
31 #define VEND1_GLOBAL_MAILBOX_INTERFACE4			0x0203
32 #define VEND1_GLOBAL_MAILBOX_INTERFACE4_LSW_ADDR_MASK	GENMASK(15, 2)
33 #define VEND1_GLOBAL_MAILBOX_INTERFACE4_LSW_ADDR(x)	FIELD_PREP(VEND1_GLOBAL_MAILBOX_INTERFACE4_LSW_ADDR_MASK, (u16)(x))
34 
35 #define VEND1_GLOBAL_MAILBOX_INTERFACE5			0x0204
36 #define VEND1_GLOBAL_MAILBOX_INTERFACE5_MSW_DATA_MASK	GENMASK(15, 0)
37 #define VEND1_GLOBAL_MAILBOX_INTERFACE5_MSW_DATA(x)	FIELD_PREP(VEND1_GLOBAL_MAILBOX_INTERFACE5_MSW_DATA_MASK, (u16)((x) >> 16))
38 #define VEND1_GLOBAL_MAILBOX_INTERFACE6			0x0205
39 #define VEND1_GLOBAL_MAILBOX_INTERFACE6_LSW_DATA_MASK	GENMASK(15, 0)
40 #define VEND1_GLOBAL_MAILBOX_INTERFACE6_LSW_DATA(x)	FIELD_PREP(VEND1_GLOBAL_MAILBOX_INTERFACE6_LSW_DATA_MASK, (u16)(x))
41 
42 /* The following registers all have similar layouts; first the registers... */
43 #define VEND1_GLOBAL_CFG_10M			0x0310
44 #define VEND1_GLOBAL_CFG_100M			0x031b
45 #define VEND1_GLOBAL_CFG_1G			0x031c
46 #define VEND1_GLOBAL_CFG_2_5G			0x031d
47 #define VEND1_GLOBAL_CFG_5G			0x031e
48 #define VEND1_GLOBAL_CFG_10G			0x031f
49 /* ...and now the fields */
50 #define VEND1_GLOBAL_CFG_SERDES_MODE		GENMASK(2, 0)
51 #define VEND1_GLOBAL_CFG_SERDES_MODE_XFI	0
52 #define VEND1_GLOBAL_CFG_SERDES_MODE_SGMII	3
53 #define VEND1_GLOBAL_CFG_SERDES_MODE_OCSGMII	4
54 #define VEND1_GLOBAL_CFG_SERDES_MODE_XFI5G	6
55 #define VEND1_GLOBAL_CFG_RATE_ADAPT		GENMASK(8, 7)
56 #define VEND1_GLOBAL_CFG_RATE_ADAPT_NONE	0
57 #define VEND1_GLOBAL_CFG_RATE_ADAPT_USX		1
58 #define VEND1_GLOBAL_CFG_RATE_ADAPT_PAUSE	2
59 
60 /* Vendor specific 1, MDIO_MMD_VEND2 */
61 #define VEND1_GLOBAL_CONTROL2			0xc001
62 #define VEND1_GLOBAL_CONTROL2_UP_RUN_STALL_RST	BIT(15)
63 #define VEND1_GLOBAL_CONTROL2_UP_RUN_STALL_OVD	BIT(6)
64 #define VEND1_GLOBAL_CONTROL2_UP_RUN_STALL	BIT(0)
65 
66 #define VEND1_GLOBAL_LED_PROV			0xc430
67 #define AQR_LED_PROV(x)				(VEND1_GLOBAL_LED_PROV + (x))
68 #define VEND1_GLOBAL_LED_PROV_LINK2500		BIT(14)
69 #define VEND1_GLOBAL_LED_PROV_LINK5000		BIT(15)
70 #define VEND1_GLOBAL_LED_PROV_FORCE_ON		BIT(8)
71 #define VEND1_GLOBAL_LED_PROV_LINK10000		BIT(7)
72 #define VEND1_GLOBAL_LED_PROV_LINK1000		BIT(6)
73 #define VEND1_GLOBAL_LED_PROV_LINK100		BIT(5)
74 #define VEND1_GLOBAL_LED_PROV_RX_ACT		BIT(3)
75 #define VEND1_GLOBAL_LED_PROV_TX_ACT		BIT(2)
76 #define VEND1_GLOBAL_LED_PROV_ACT_STRETCH	GENMASK(0, 1)
77 
78 #define VEND1_GLOBAL_LED_PROV_LINK_MASK		(VEND1_GLOBAL_LED_PROV_LINK100 | \
79 						 VEND1_GLOBAL_LED_PROV_LINK1000 | \
80 						 VEND1_GLOBAL_LED_PROV_LINK10000 | \
81 						 VEND1_GLOBAL_LED_PROV_LINK5000 | \
82 						 VEND1_GLOBAL_LED_PROV_LINK2500)
83 
84 #define VEND1_GLOBAL_LED_DRIVE			0xc438
85 #define VEND1_GLOBAL_LED_DRIVE_VDD		BIT(1)
86 #define AQR_LED_DRIVE(x)			(VEND1_GLOBAL_LED_DRIVE + (x))
87 
88 #define VEND1_THERMAL_PROV_HIGH_TEMP_FAIL	0xc421
89 #define VEND1_THERMAL_PROV_LOW_TEMP_FAIL	0xc422
90 #define VEND1_THERMAL_PROV_HIGH_TEMP_WARN	0xc423
91 #define VEND1_THERMAL_PROV_LOW_TEMP_WARN	0xc424
92 #define VEND1_THERMAL_STAT1			0xc820
93 #define VEND1_THERMAL_STAT2			0xc821
94 #define VEND1_THERMAL_STAT2_VALID		BIT(0)
95 #define VEND1_GENERAL_STAT1			0xc830
96 #define VEND1_GENERAL_STAT1_HIGH_TEMP_FAIL	BIT(14)
97 #define VEND1_GENERAL_STAT1_LOW_TEMP_FAIL	BIT(13)
98 #define VEND1_GENERAL_STAT1_HIGH_TEMP_WARN	BIT(12)
99 #define VEND1_GENERAL_STAT1_LOW_TEMP_WARN	BIT(11)
100 
101 #define VEND1_GLOBAL_GEN_STAT2			0xc831
102 #define VEND1_GLOBAL_GEN_STAT2_OP_IN_PROG	BIT(15)
103 
104 #define VEND1_GLOBAL_RSVD_STAT1			0xc885
105 #define VEND1_GLOBAL_RSVD_STAT1_FW_BUILD_ID	GENMASK(7, 4)
106 #define VEND1_GLOBAL_RSVD_STAT1_PROV_ID		GENMASK(3, 0)
107 
108 #define VEND1_GLOBAL_RSVD_STAT9			0xc88d
109 #define VEND1_GLOBAL_RSVD_STAT9_MODE		GENMASK(7, 0)
110 #define VEND1_GLOBAL_RSVD_STAT9_1000BT2		0x23
111 
112 /* MDIO_MMD_C22EXT */
113 #define MDIO_C22EXT_STAT_SGMII_RX_GOOD_FRAMES		0xd292
114 #define MDIO_C22EXT_STAT_SGMII_RX_BAD_FRAMES		0xd294
115 #define MDIO_C22EXT_STAT_SGMII_RX_FALSE_CARRIER		0xd297
116 #define MDIO_C22EXT_STAT_SGMII_TX_GOOD_FRAMES		0xd313
117 #define MDIO_C22EXT_STAT_SGMII_TX_BAD_FRAMES		0xd315
118 #define MDIO_C22EXT_STAT_SGMII_TX_FALSE_CARRIER		0xd317
119 #define MDIO_C22EXT_STAT_SGMII_TX_COLLISIONS		0xd318
120 #define MDIO_C22EXT_STAT_SGMII_TX_LINE_COLLISIONS	0xd319
121 #define MDIO_C22EXT_STAT_SGMII_TX_FRAME_ALIGN_ERR	0xd31a
122 #define MDIO_C22EXT_STAT_SGMII_TX_RUNT_FRAMES		0xd31b
123 
124 #define VEND1_GLOBAL_INT_STD_STATUS		0xfc00
125 #define VEND1_GLOBAL_INT_VEND_STATUS		0xfc01
126 
127 #define VEND1_GLOBAL_INT_STD_MASK		0xff00
128 #define VEND1_GLOBAL_INT_STD_MASK_PMA1		BIT(15)
129 #define VEND1_GLOBAL_INT_STD_MASK_PMA2		BIT(14)
130 #define VEND1_GLOBAL_INT_STD_MASK_PCS1		BIT(13)
131 #define VEND1_GLOBAL_INT_STD_MASK_PCS2		BIT(12)
132 #define VEND1_GLOBAL_INT_STD_MASK_PCS3		BIT(11)
133 #define VEND1_GLOBAL_INT_STD_MASK_PHY_XS1	BIT(10)
134 #define VEND1_GLOBAL_INT_STD_MASK_PHY_XS2	BIT(9)
135 #define VEND1_GLOBAL_INT_STD_MASK_AN1		BIT(8)
136 #define VEND1_GLOBAL_INT_STD_MASK_AN2		BIT(7)
137 #define VEND1_GLOBAL_INT_STD_MASK_GBE		BIT(6)
138 #define VEND1_GLOBAL_INT_STD_MASK_ALL		BIT(0)
139 
140 #define VEND1_GLOBAL_INT_VEND_MASK		0xff01
141 #define VEND1_GLOBAL_INT_VEND_MASK_PMA		BIT(15)
142 #define VEND1_GLOBAL_INT_VEND_MASK_PCS		BIT(14)
143 #define VEND1_GLOBAL_INT_VEND_MASK_PHY_XS	BIT(13)
144 #define VEND1_GLOBAL_INT_VEND_MASK_AN		BIT(12)
145 #define VEND1_GLOBAL_INT_VEND_MASK_GBE		BIT(11)
146 #define VEND1_GLOBAL_INT_VEND_MASK_GLOBAL1	BIT(2)
147 #define VEND1_GLOBAL_INT_VEND_MASK_GLOBAL2	BIT(1)
148 #define VEND1_GLOBAL_INT_VEND_MASK_GLOBAL3	BIT(0)
149 
150 #define AQR_MAX_LEDS				3
151 
152 struct aqr107_hw_stat {
153 	const char *name;
154 	int reg;
155 	int size;
156 };
157 
158 #define SGMII_STAT(n, r, s) { n, MDIO_C22EXT_STAT_SGMII_ ## r, s }
159 static const struct aqr107_hw_stat aqr107_hw_stats[] = {
160 	SGMII_STAT("sgmii_rx_good_frames",	    RX_GOOD_FRAMES,	26),
161 	SGMII_STAT("sgmii_rx_bad_frames",	    RX_BAD_FRAMES,	26),
162 	SGMII_STAT("sgmii_rx_false_carrier_events", RX_FALSE_CARRIER,	 8),
163 	SGMII_STAT("sgmii_tx_good_frames",	    TX_GOOD_FRAMES,	26),
164 	SGMII_STAT("sgmii_tx_bad_frames",	    TX_BAD_FRAMES,	26),
165 	SGMII_STAT("sgmii_tx_false_carrier_events", TX_FALSE_CARRIER,	 8),
166 	SGMII_STAT("sgmii_tx_collisions",	    TX_COLLISIONS,	 8),
167 	SGMII_STAT("sgmii_tx_line_collisions",	    TX_LINE_COLLISIONS,	 8),
168 	SGMII_STAT("sgmii_tx_frame_alignment_err",  TX_FRAME_ALIGN_ERR,	16),
169 	SGMII_STAT("sgmii_tx_runt_frames",	    TX_RUNT_FRAMES,	22),
170 };
171 
172 #define AQR107_SGMII_STAT_SZ ARRAY_SIZE(aqr107_hw_stats)
173 
174 struct aqr107_priv {
175 	u64 sgmii_stats[AQR107_SGMII_STAT_SZ];
176 	unsigned long leds_active_low;
177 };
178 
179 #if IS_REACHABLE(CONFIG_HWMON)
180 int aqr_hwmon_probe(struct phy_device *phydev);
181 #else
182 static inline int aqr_hwmon_probe(struct phy_device *phydev) { return 0; }
183 #endif
184 
185 int aqr_firmware_load(struct phy_device *phydev);
186 
187 int aqr_phy_led_blink_set(struct phy_device *phydev, u8 index,
188 			  unsigned long *delay_on,
189 			  unsigned long *delay_off);
190 int aqr_phy_led_brightness_set(struct phy_device *phydev,
191 			       u8 index, enum led_brightness value);
192 int aqr_phy_led_hw_is_supported(struct phy_device *phydev, u8 index,
193 				unsigned long rules);
194 int aqr_phy_led_hw_control_get(struct phy_device *phydev, u8 index,
195 			       unsigned long *rules);
196 int aqr_phy_led_hw_control_set(struct phy_device *phydev, u8 index,
197 			       unsigned long rules);
198 int aqr_phy_led_active_low_set(struct phy_device *phydev, int index, bool enable);
199 int aqr_phy_led_polarity_set(struct phy_device *phydev, int index,
200 			     unsigned long modes);
201