xref: /linux/drivers/net/ethernet/freescale/ucc_geth_ethtool.c (revision 7f71507851fc7764b36a3221839607d3a45c2025)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Copyright (c) 2007 Freescale Semiconductor, Inc. All rights reserved.
4  *
5  * Description: QE UCC Gigabit Ethernet Ethtool API Set
6  *
7  * Author: Li Yang <leoli@freescale.com>
8  *
9  * Limitation:
10  * Can only get/set settings of the first queue.
11  * Need to re-open the interface manually after changing some parameters.
12  */
13 
14 #include <linux/kernel.h>
15 #include <linux/errno.h>
16 #include <linux/stddef.h>
17 #include <linux/interrupt.h>
18 #include <linux/netdevice.h>
19 #include <linux/etherdevice.h>
20 #include <linux/skbuff.h>
21 #include <linux/spinlock.h>
22 #include <linux/mm.h>
23 #include <linux/delay.h>
24 #include <linux/dma-mapping.h>
25 #include <linux/ethtool.h>
26 #include <linux/mii.h>
27 #include <linux/phy.h>
28 
29 #include <asm/io.h>
30 #include <asm/irq.h>
31 #include <linux/uaccess.h>
32 #include <asm/types.h>
33 
34 #include "ucc_geth.h"
35 
36 static const char hw_stat_gstrings[][ETH_GSTRING_LEN] = {
37 	"tx-64-frames",
38 	"tx-65-127-frames",
39 	"tx-128-255-frames",
40 	"rx-64-frames",
41 	"rx-65-127-frames",
42 	"rx-128-255-frames",
43 	"tx-bytes-ok",
44 	"tx-pause-frames",
45 	"tx-multicast-frames",
46 	"tx-broadcast-frames",
47 	"rx-frames",
48 	"rx-bytes-ok",
49 	"rx-bytes-all",
50 	"rx-multicast-frames",
51 	"rx-broadcast-frames",
52 	"stats-counter-carry",
53 	"stats-counter-mask",
54 	"rx-dropped-frames",
55 };
56 
57 static const char tx_fw_stat_gstrings[][ETH_GSTRING_LEN] = {
58 	"tx-single-collision",
59 	"tx-multiple-collision",
60 	"tx-late-collision",
61 	"tx-aborted-frames",
62 	"tx-lost-frames",
63 	"tx-carrier-sense-errors",
64 	"tx-frames-ok",
65 	"tx-excessive-differ-frames",
66 	"tx-256-511-frames",
67 	"tx-512-1023-frames",
68 	"tx-1024-1518-frames",
69 	"tx-jumbo-frames",
70 };
71 
72 static const char rx_fw_stat_gstrings[][ETH_GSTRING_LEN] = {
73 	"rx-crc-errors",
74 	"rx-alignment-errors",
75 	"rx-in-range-length-errors",
76 	"rx-out-of-range-length-errors",
77 	"rx-too-long-frames",
78 	"rx-runt",
79 	"rx-very-long-event",
80 	"rx-symbol-errors",
81 	"rx-busy-drop-frames",
82 	"reserved",
83 	"reserved",
84 	"rx-mismatch-drop-frames",
85 	"rx-small-than-64",
86 	"rx-256-511-frames",
87 	"rx-512-1023-frames",
88 	"rx-1024-1518-frames",
89 	"rx-jumbo-frames",
90 	"rx-mac-error-loss",
91 	"rx-pause-frames",
92 	"reserved",
93 	"rx-vlan-removed",
94 	"rx-vlan-replaced",
95 	"rx-vlan-inserted",
96 	"rx-ip-checksum-errors",
97 };
98 
99 #define UEC_HW_STATS_LEN ARRAY_SIZE(hw_stat_gstrings)
100 #define UEC_TX_FW_STATS_LEN ARRAY_SIZE(tx_fw_stat_gstrings)
101 #define UEC_RX_FW_STATS_LEN ARRAY_SIZE(rx_fw_stat_gstrings)
102 
103 static int
104 uec_get_ksettings(struct net_device *netdev, struct ethtool_link_ksettings *cmd)
105 {
106 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
107 	struct phy_device *phydev = ugeth->phydev;
108 
109 	if (!phydev)
110 		return -ENODEV;
111 
112 	phy_ethtool_ksettings_get(phydev, cmd);
113 
114 	return 0;
115 }
116 
117 static int
118 uec_set_ksettings(struct net_device *netdev,
119 		  const struct ethtool_link_ksettings *cmd)
120 {
121 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
122 	struct phy_device *phydev = ugeth->phydev;
123 
124 	if (!phydev)
125 		return -ENODEV;
126 
127 	return phy_ethtool_ksettings_set(phydev, cmd);
128 }
129 
130 static void
131 uec_get_pauseparam(struct net_device *netdev,
132                      struct ethtool_pauseparam *pause)
133 {
134 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
135 
136 	pause->autoneg = ugeth->phydev->autoneg;
137 
138 	if (ugeth->ug_info->receiveFlowControl)
139 		pause->rx_pause = 1;
140 	if (ugeth->ug_info->transmitFlowControl)
141 		pause->tx_pause = 1;
142 }
143 
144 static int
145 uec_set_pauseparam(struct net_device *netdev,
146                      struct ethtool_pauseparam *pause)
147 {
148 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
149 	int ret = 0;
150 
151 	ugeth->ug_info->receiveFlowControl = pause->rx_pause;
152 	ugeth->ug_info->transmitFlowControl = pause->tx_pause;
153 
154 	if (ugeth->phydev->autoneg) {
155 		if (netif_running(netdev)) {
156 			/* FIXME: automatically restart */
157 			netdev_info(netdev, "Please re-open the interface\n");
158 		}
159 	} else {
160 		struct ucc_geth_info *ug_info = ugeth->ug_info;
161 
162 		ret = init_flow_control_params(ug_info->aufc,
163 					ug_info->receiveFlowControl,
164 					ug_info->transmitFlowControl,
165 					ug_info->pausePeriod,
166 					ug_info->extensionField,
167 					&ugeth->uccf->uf_regs->upsmr,
168 					&ugeth->ug_regs->uempr,
169 					&ugeth->ug_regs->maccfg1);
170 	}
171 
172 	return ret;
173 }
174 
175 static uint32_t
176 uec_get_msglevel(struct net_device *netdev)
177 {
178 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
179 	return ugeth->msg_enable;
180 }
181 
182 static void
183 uec_set_msglevel(struct net_device *netdev, uint32_t data)
184 {
185 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
186 	ugeth->msg_enable = data;
187 }
188 
189 static int
190 uec_get_regs_len(struct net_device *netdev)
191 {
192 	return sizeof(struct ucc_geth);
193 }
194 
195 static void
196 uec_get_regs(struct net_device *netdev,
197                struct ethtool_regs *regs, void *p)
198 {
199 	int i;
200 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
201 	u32 __iomem *ug_regs = (u32 __iomem *)ugeth->ug_regs;
202 	u32 *buff = p;
203 
204 	for (i = 0; i < sizeof(struct ucc_geth) / sizeof(u32); i++)
205 		buff[i] = in_be32(&ug_regs[i]);
206 }
207 
208 static void
209 uec_get_ringparam(struct net_device *netdev,
210 		  struct ethtool_ringparam *ring,
211 		  struct kernel_ethtool_ringparam *kernel_ring,
212 		  struct netlink_ext_ack *extack)
213 {
214 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
215 	struct ucc_geth_info *ug_info = ugeth->ug_info;
216 	int queue = 0;
217 
218 	ring->rx_max_pending = UCC_GETH_BD_RING_SIZE_MAX;
219 	ring->rx_mini_max_pending = UCC_GETH_BD_RING_SIZE_MAX;
220 	ring->rx_jumbo_max_pending = UCC_GETH_BD_RING_SIZE_MAX;
221 	ring->tx_max_pending = UCC_GETH_BD_RING_SIZE_MAX;
222 
223 	ring->rx_pending = ug_info->bdRingLenRx[queue];
224 	ring->rx_mini_pending = ug_info->bdRingLenRx[queue];
225 	ring->rx_jumbo_pending = ug_info->bdRingLenRx[queue];
226 	ring->tx_pending = ug_info->bdRingLenTx[queue];
227 }
228 
229 static int
230 uec_set_ringparam(struct net_device *netdev,
231 		  struct ethtool_ringparam *ring,
232 		  struct kernel_ethtool_ringparam *kernel_ring,
233 		  struct netlink_ext_ack *extack)
234 {
235 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
236 	struct ucc_geth_info *ug_info = ugeth->ug_info;
237 	int queue = 0, ret = 0;
238 
239 	if (ring->rx_pending < UCC_GETH_RX_BD_RING_SIZE_MIN) {
240 		netdev_info(netdev, "RxBD ring size must be no smaller than %d\n",
241 			    UCC_GETH_RX_BD_RING_SIZE_MIN);
242 		return -EINVAL;
243 	}
244 	if (ring->rx_pending % UCC_GETH_RX_BD_RING_SIZE_ALIGNMENT) {
245 		netdev_info(netdev, "RxBD ring size must be multiple of %d\n",
246 			    UCC_GETH_RX_BD_RING_SIZE_ALIGNMENT);
247 		return -EINVAL;
248 	}
249 	if (ring->tx_pending < UCC_GETH_TX_BD_RING_SIZE_MIN) {
250 		netdev_info(netdev, "TxBD ring size must be no smaller than %d\n",
251 			    UCC_GETH_TX_BD_RING_SIZE_MIN);
252 		return -EINVAL;
253 	}
254 
255 	if (netif_running(netdev))
256 		return -EBUSY;
257 
258 	ug_info->bdRingLenRx[queue] = ring->rx_pending;
259 	ug_info->bdRingLenTx[queue] = ring->tx_pending;
260 
261 	return ret;
262 }
263 
264 static int uec_get_sset_count(struct net_device *netdev, int sset)
265 {
266 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
267 	u32 stats_mode = ugeth->ug_info->statisticsMode;
268 	int len = 0;
269 
270 	switch (sset) {
271 	case ETH_SS_STATS:
272 		if (stats_mode & UCC_GETH_STATISTICS_GATHERING_MODE_HARDWARE)
273 			len += UEC_HW_STATS_LEN;
274 		if (stats_mode & UCC_GETH_STATISTICS_GATHERING_MODE_FIRMWARE_TX)
275 			len += UEC_TX_FW_STATS_LEN;
276 		if (stats_mode & UCC_GETH_STATISTICS_GATHERING_MODE_FIRMWARE_RX)
277 			len += UEC_RX_FW_STATS_LEN;
278 
279 		return len;
280 
281 	default:
282 		return -EOPNOTSUPP;
283 	}
284 }
285 
286 static void uec_get_strings(struct net_device *netdev, u32 stringset, u8 *buf)
287 {
288 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
289 	u32 stats_mode = ugeth->ug_info->statisticsMode;
290 	int i;
291 
292 	if (stats_mode & UCC_GETH_STATISTICS_GATHERING_MODE_HARDWARE)
293 		for (i = 0; i < UEC_HW_STATS_LEN; i++)
294 			ethtool_puts(&buf, hw_stat_gstrings[i]);
295 	if (stats_mode & UCC_GETH_STATISTICS_GATHERING_MODE_FIRMWARE_TX)
296 		for (i = 0; i < UEC_TX_FW_STATS_LEN; i++)
297 			ethtool_puts(&buf, tx_fw_stat_gstrings[i]);
298 	if (stats_mode & UCC_GETH_STATISTICS_GATHERING_MODE_FIRMWARE_RX)
299 		for (i = 0; i < UEC_RX_FW_STATS_LEN; i++)
300 			ethtool_puts(&buf, rx_fw_stat_gstrings[i]);
301 }
302 
303 static void uec_get_ethtool_stats(struct net_device *netdev,
304 		struct ethtool_stats *stats, uint64_t *data)
305 {
306 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
307 	u32 stats_mode = ugeth->ug_info->statisticsMode;
308 	u32 __iomem *base;
309 	int i, j = 0;
310 
311 	if (stats_mode & UCC_GETH_STATISTICS_GATHERING_MODE_HARDWARE) {
312 		if (ugeth->ug_regs)
313 			base = (u32 __iomem *)&ugeth->ug_regs->tx64;
314 		else
315 			base = NULL;
316 
317 		for (i = 0; i < UEC_HW_STATS_LEN; i++)
318 			data[j++] = base ? in_be32(&base[i]) : 0;
319 	}
320 	if (stats_mode & UCC_GETH_STATISTICS_GATHERING_MODE_FIRMWARE_TX) {
321 		base = (u32 __iomem *)ugeth->p_tx_fw_statistics_pram;
322 		for (i = 0; i < UEC_TX_FW_STATS_LEN; i++)
323 			data[j++] = base ? in_be32(&base[i]) : 0;
324 	}
325 	if (stats_mode & UCC_GETH_STATISTICS_GATHERING_MODE_FIRMWARE_RX) {
326 		base = (u32 __iomem *)ugeth->p_rx_fw_statistics_pram;
327 		for (i = 0; i < UEC_RX_FW_STATS_LEN; i++)
328 			data[j++] = base ? in_be32(&base[i]) : 0;
329 	}
330 }
331 
332 /* Report driver information */
333 static void
334 uec_get_drvinfo(struct net_device *netdev,
335                        struct ethtool_drvinfo *drvinfo)
336 {
337 	strscpy(drvinfo->driver, DRV_NAME, sizeof(drvinfo->driver));
338 	strscpy(drvinfo->bus_info, "QUICC ENGINE", sizeof(drvinfo->bus_info));
339 }
340 
341 #ifdef CONFIG_PM
342 
343 static void uec_get_wol(struct net_device *netdev, struct ethtool_wolinfo *wol)
344 {
345 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
346 	struct phy_device *phydev = ugeth->phydev;
347 
348 	if (phydev && phydev->irq)
349 		wol->supported |= WAKE_PHY;
350 	if (qe_alive_during_sleep())
351 		wol->supported |= WAKE_MAGIC;
352 
353 	wol->wolopts = ugeth->wol_en;
354 }
355 
356 static int uec_set_wol(struct net_device *netdev, struct ethtool_wolinfo *wol)
357 {
358 	struct ucc_geth_private *ugeth = netdev_priv(netdev);
359 	struct phy_device *phydev = ugeth->phydev;
360 
361 	if (wol->wolopts & ~(WAKE_PHY | WAKE_MAGIC))
362 		return -EINVAL;
363 	else if (wol->wolopts & WAKE_PHY && (!phydev || !phydev->irq))
364 		return -EINVAL;
365 	else if (wol->wolopts & WAKE_MAGIC && !qe_alive_during_sleep())
366 		return -EINVAL;
367 
368 	ugeth->wol_en = wol->wolopts;
369 	device_set_wakeup_enable(&netdev->dev, ugeth->wol_en);
370 
371 	return 0;
372 }
373 
374 #else
375 #define uec_get_wol NULL
376 #define uec_set_wol NULL
377 #endif /* CONFIG_PM */
378 
379 static const struct ethtool_ops uec_ethtool_ops = {
380 	.get_drvinfo            = uec_get_drvinfo,
381 	.get_regs_len           = uec_get_regs_len,
382 	.get_regs               = uec_get_regs,
383 	.get_msglevel           = uec_get_msglevel,
384 	.set_msglevel           = uec_set_msglevel,
385 	.nway_reset             = phy_ethtool_nway_reset,
386 	.get_link               = ethtool_op_get_link,
387 	.get_ringparam          = uec_get_ringparam,
388 	.set_ringparam          = uec_set_ringparam,
389 	.get_pauseparam         = uec_get_pauseparam,
390 	.set_pauseparam         = uec_set_pauseparam,
391 	.get_sset_count		= uec_get_sset_count,
392 	.get_strings            = uec_get_strings,
393 	.get_ethtool_stats      = uec_get_ethtool_stats,
394 	.get_wol		= uec_get_wol,
395 	.set_wol		= uec_set_wol,
396 	.get_ts_info		= ethtool_op_get_ts_info,
397 	.get_link_ksettings	= uec_get_ksettings,
398 	.set_link_ksettings	= uec_set_ksettings,
399 };
400 
401 void uec_set_ethtool_ops(struct net_device *netdev)
402 {
403 	netdev->ethtool_ops = &uec_ethtool_ops;
404 }
405