2 * drivers/net/gianfar_ethtool.c
4 * Gianfar Ethernet Driver
5 * Ethtool support for Gianfar Enet
6 * Based on e1000 ethtool support
9 * Maintainer: Kumar Gala
10 * Modifier: Sandeep Gopalpet <sandeep.kumar@freescale.com>
12 * Copyright 2003-2006, 2008-2009 Freescale Semiconductor, Inc.
14 * This software may be used and distributed according to
15 * the terms of the GNU Public License, Version 2, incorporated herein
19 #include <linux/kernel.h>
20 #include <linux/string.h>
21 #include <linux/errno.h>
22 #include <linux/slab.h>
23 #include <linux/interrupt.h>
24 #include <linux/init.h>
25 #include <linux/delay.h>
26 #include <linux/netdevice.h>
27 #include <linux/etherdevice.h>
28 #include <linux/skbuff.h>
29 #include <linux/spinlock.h>
34 #include <asm/uaccess.h>
35 #include <linux/module.h>
36 #include <linux/crc32.h>
37 #include <asm/types.h>
38 #include <linux/ethtool.h>
39 #include <linux/mii.h>
40 #include <linux/phy.h>
44 extern void gfar_start(struct net_device *dev);
45 extern int gfar_clean_rx_ring(struct gfar_priv_rx_q *rx_queue, int rx_work_limit);
47 #define GFAR_MAX_COAL_USECS 0xffff
48 #define GFAR_MAX_COAL_FRAMES 0xff
49 static void gfar_fill_stats(struct net_device *dev, struct ethtool_stats *dummy,
51 static void gfar_gstrings(struct net_device *dev, u32 stringset, u8 * buf);
52 static int gfar_gcoalesce(struct net_device *dev, struct ethtool_coalesce *cvals);
53 static int gfar_scoalesce(struct net_device *dev, struct ethtool_coalesce *cvals);
54 static void gfar_gringparam(struct net_device *dev, struct ethtool_ringparam *rvals);
55 static int gfar_sringparam(struct net_device *dev, struct ethtool_ringparam *rvals);
56 static void gfar_gdrvinfo(struct net_device *dev, struct ethtool_drvinfo *drvinfo);
58 static char stat_gstrings[][ETH_GSTRING_LEN] = {
59 "rx-dropped-by-kernel",
60 "rx-large-frame-errors",
61 "rx-short-frame-errors",
62 "rx-non-octet-errors",
67 "rx-truncated-frames",
71 "rx-skb-missing-errors",
74 "tx-rx-65-127-frames",
75 "tx-rx-128-255-frames",
76 "tx-rx-256-511-frames",
77 "tx-rx-512-1023-frames",
78 "tx-rx-1024-1518-frames",
79 "tx-rx-1519-1522-good-vlan",
83 "receive-multicast-packet",
84 "receive-broadcast-packet",
85 "rx-control-frame-packets",
86 "rx-pause-frame-packets",
89 "rx-frame-length-error",
91 "rx-carrier-sense-error",
92 "rx-undersize-packets",
93 "rx-oversize-packets",
94 "rx-fragmented-frames",
99 "tx-multicast-packets",
100 "tx-broadcast-packets",
101 "tx-pause-control-frames",
102 "tx-deferral-packets",
103 "tx-excessive-deferral-packets",
104 "tx-single-collision-packets",
105 "tx-multiple-collision-packets",
106 "tx-late-collision-packets",
107 "tx-excessive-collision-packets",
108 "tx-total-collision",
114 "tx-oversize-frames",
115 "tx-undersize-frames",
116 "tx-fragmented-frames",
119 /* Fill in a buffer with the strings which correspond to the
121 static void gfar_gstrings(struct net_device *dev, u32 stringset, u8 * buf)
123 struct gfar_private *priv = netdev_priv(dev);
125 if (priv->device_flags & FSL_GIANFAR_DEV_HAS_RMON)
126 memcpy(buf, stat_gstrings, GFAR_STATS_LEN * ETH_GSTRING_LEN);
128 memcpy(buf, stat_gstrings,
129 GFAR_EXTRA_STATS_LEN * ETH_GSTRING_LEN);
132 /* Fill in an array of 64-bit statistics from various sources.
133 * This array will be appended to the end of the ethtool_stats
134 * structure, and returned to user space
136 static void gfar_fill_stats(struct net_device *dev, struct ethtool_stats *dummy, u64 * buf)
139 struct gfar_private *priv = netdev_priv(dev);
140 u64 *extra = (u64 *) & priv->extra_stats;
142 if (priv->device_flags & FSL_GIANFAR_DEV_HAS_RMON) {
143 u32 __iomem *rmon = (u32 __iomem *) & priv->regs->rmon;
144 struct gfar_stats *stats = (struct gfar_stats *) buf;
146 for (i = 0; i < GFAR_RMON_LEN; i++)
147 stats->rmon[i] = (u64) gfar_read(&rmon[i]);
149 for (i = 0; i < GFAR_EXTRA_STATS_LEN; i++)
150 stats->extra[i] = extra[i];
152 for (i = 0; i < GFAR_EXTRA_STATS_LEN; i++)
156 static int gfar_sset_count(struct net_device *dev, int sset)
158 struct gfar_private *priv = netdev_priv(dev);
162 if (priv->device_flags & FSL_GIANFAR_DEV_HAS_RMON)
163 return GFAR_STATS_LEN;
165 return GFAR_EXTRA_STATS_LEN;
171 /* Fills in the drvinfo structure with some basic info */
172 static void gfar_gdrvinfo(struct net_device *dev, struct
173 ethtool_drvinfo *drvinfo)
175 strncpy(drvinfo->driver, DRV_NAME, GFAR_INFOSTR_LEN);
176 strncpy(drvinfo->version, gfar_driver_version, GFAR_INFOSTR_LEN);
177 strncpy(drvinfo->fw_version, "N/A", GFAR_INFOSTR_LEN);
178 strncpy(drvinfo->bus_info, "N/A", GFAR_INFOSTR_LEN);
179 drvinfo->regdump_len = 0;
180 drvinfo->eedump_len = 0;
184 static int gfar_ssettings(struct net_device *dev, struct ethtool_cmd *cmd)
186 struct gfar_private *priv = netdev_priv(dev);
187 struct phy_device *phydev = priv->phydev;
192 return phy_ethtool_sset(phydev, cmd);
196 /* Return the current settings in the ethtool_cmd structure */
197 static int gfar_gsettings(struct net_device *dev, struct ethtool_cmd *cmd)
199 struct gfar_private *priv = netdev_priv(dev);
200 struct phy_device *phydev = priv->phydev;
201 struct gfar_priv_rx_q *rx_queue = NULL;
202 struct gfar_priv_tx_q *tx_queue = NULL;
206 tx_queue = priv->tx_queue;
207 rx_queue = priv->rx_queue;
209 cmd->maxtxpkt = get_icft_value(tx_queue->txic);
210 cmd->maxrxpkt = get_icft_value(rx_queue->rxic);
212 return phy_ethtool_gset(phydev, cmd);
215 /* Return the length of the register structure */
216 static int gfar_reglen(struct net_device *dev)
218 return sizeof (struct gfar);
221 /* Return a dump of the GFAR register space */
222 static void gfar_get_regs(struct net_device *dev, struct ethtool_regs *regs, void *regbuf)
225 struct gfar_private *priv = netdev_priv(dev);
226 u32 __iomem *theregs = (u32 __iomem *) priv->regs;
227 u32 *buf = (u32 *) regbuf;
229 for (i = 0; i < sizeof (struct gfar) / sizeof (u32); i++)
230 buf[i] = gfar_read(&theregs[i]);
233 /* Convert microseconds to ethernet clock ticks, which changes
234 * depending on what speed the controller is running at */
235 static unsigned int gfar_usecs2ticks(struct gfar_private *priv, unsigned int usecs)
239 /* The timer is different, depending on the interface speed */
240 switch (priv->phydev->speed) {
242 count = GFAR_GBIT_TIME;
245 count = GFAR_100_TIME;
249 count = GFAR_10_TIME;
253 /* Make sure we return a number greater than 0
255 return ((usecs * 1000 + count - 1) / count);
258 /* Convert ethernet clock ticks to microseconds */
259 static unsigned int gfar_ticks2usecs(struct gfar_private *priv, unsigned int ticks)
263 /* The timer is different, depending on the interface speed */
264 switch (priv->phydev->speed) {
266 count = GFAR_GBIT_TIME;
269 count = GFAR_100_TIME;
273 count = GFAR_10_TIME;
277 /* Make sure we return a number greater than 0 */
278 /* if ticks is > 0 */
279 return ((ticks * count) / 1000);
282 /* Get the coalescing parameters, and put them in the cvals
284 static int gfar_gcoalesce(struct net_device *dev, struct ethtool_coalesce *cvals)
286 struct gfar_private *priv = netdev_priv(dev);
287 struct gfar_priv_rx_q *rx_queue = NULL;
288 struct gfar_priv_tx_q *tx_queue = NULL;
289 unsigned long rxtime;
290 unsigned long rxcount;
291 unsigned long txtime;
292 unsigned long txcount;
294 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_COALESCE))
297 if (NULL == priv->phydev)
300 rx_queue = priv->rx_queue;
301 tx_queue = priv->tx_queue;
303 rxtime = get_ictt_value(rx_queue->rxic);
304 rxcount = get_icft_value(rx_queue->rxic);
305 txtime = get_ictt_value(tx_queue->txic);
306 txcount = get_icft_value(tx_queue->txic);
307 cvals->rx_coalesce_usecs = gfar_ticks2usecs(priv, rxtime);
308 cvals->rx_max_coalesced_frames = rxcount;
310 cvals->tx_coalesce_usecs = gfar_ticks2usecs(priv, txtime);
311 cvals->tx_max_coalesced_frames = txcount;
313 cvals->use_adaptive_rx_coalesce = 0;
314 cvals->use_adaptive_tx_coalesce = 0;
316 cvals->pkt_rate_low = 0;
317 cvals->rx_coalesce_usecs_low = 0;
318 cvals->rx_max_coalesced_frames_low = 0;
319 cvals->tx_coalesce_usecs_low = 0;
320 cvals->tx_max_coalesced_frames_low = 0;
322 /* When the packet rate is below pkt_rate_high but above
323 * pkt_rate_low (both measured in packets per second) the
324 * normal {rx,tx}_* coalescing parameters are used.
327 /* When the packet rate is (measured in packets per second)
328 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
331 cvals->pkt_rate_high = 0;
332 cvals->rx_coalesce_usecs_high = 0;
333 cvals->rx_max_coalesced_frames_high = 0;
334 cvals->tx_coalesce_usecs_high = 0;
335 cvals->tx_max_coalesced_frames_high = 0;
337 /* How often to do adaptive coalescing packet rate sampling,
338 * measured in seconds. Must not be zero.
340 cvals->rate_sample_interval = 0;
345 /* Change the coalescing values.
346 * Both cvals->*_usecs and cvals->*_frames have to be > 0
347 * in order for coalescing to be active
349 static int gfar_scoalesce(struct net_device *dev, struct ethtool_coalesce *cvals)
351 struct gfar_private *priv = netdev_priv(dev);
352 struct gfar_priv_tx_q *tx_queue = NULL;
353 struct gfar_priv_rx_q *rx_queue = NULL;
355 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_COALESCE))
358 tx_queue = priv->tx_queue;
359 rx_queue = priv->rx_queue;
361 /* Set up rx coalescing */
362 if ((cvals->rx_coalesce_usecs == 0) ||
363 (cvals->rx_max_coalesced_frames == 0))
364 rx_queue->rxcoalescing = 0;
366 rx_queue->rxcoalescing = 1;
368 if (NULL == priv->phydev)
371 /* Check the bounds of the values */
372 if (cvals->rx_coalesce_usecs > GFAR_MAX_COAL_USECS) {
373 pr_info("Coalescing is limited to %d microseconds\n",
374 GFAR_MAX_COAL_USECS);
378 if (cvals->rx_max_coalesced_frames > GFAR_MAX_COAL_FRAMES) {
379 pr_info("Coalescing is limited to %d frames\n",
380 GFAR_MAX_COAL_FRAMES);
384 rx_queue->rxic = mk_ic_value(cvals->rx_max_coalesced_frames,
385 gfar_usecs2ticks(priv, cvals->rx_coalesce_usecs));
387 /* Set up tx coalescing */
388 if ((cvals->tx_coalesce_usecs == 0) ||
389 (cvals->tx_max_coalesced_frames == 0))
390 tx_queue->txcoalescing = 0;
392 tx_queue->txcoalescing = 1;
394 /* Check the bounds of the values */
395 if (cvals->tx_coalesce_usecs > GFAR_MAX_COAL_USECS) {
396 pr_info("Coalescing is limited to %d microseconds\n",
397 GFAR_MAX_COAL_USECS);
401 if (cvals->tx_max_coalesced_frames > GFAR_MAX_COAL_FRAMES) {
402 pr_info("Coalescing is limited to %d frames\n",
403 GFAR_MAX_COAL_FRAMES);
407 tx_queue->txic = mk_ic_value(cvals->tx_max_coalesced_frames,
408 gfar_usecs2ticks(priv, cvals->tx_coalesce_usecs));
410 gfar_write(&priv->regs->rxic, 0);
411 if (rx_queue->rxcoalescing)
412 gfar_write(&priv->regs->rxic, rx_queue->rxic);
414 gfar_write(&priv->regs->txic, 0);
415 if (tx_queue->txcoalescing)
416 gfar_write(&priv->regs->txic, tx_queue->txic);
421 /* Fills in rvals with the current ring parameters. Currently,
422 * rx, rx_mini, and rx_jumbo rings are the same size, as mini and
423 * jumbo are ignored by the driver */
424 static void gfar_gringparam(struct net_device *dev, struct ethtool_ringparam *rvals)
426 struct gfar_private *priv = netdev_priv(dev);
427 struct gfar_priv_tx_q *tx_queue = NULL;
428 struct gfar_priv_rx_q *rx_queue = NULL;
430 tx_queue = priv->tx_queue;
431 rx_queue = priv->rx_queue;
433 rvals->rx_max_pending = GFAR_RX_MAX_RING_SIZE;
434 rvals->rx_mini_max_pending = GFAR_RX_MAX_RING_SIZE;
435 rvals->rx_jumbo_max_pending = GFAR_RX_MAX_RING_SIZE;
436 rvals->tx_max_pending = GFAR_TX_MAX_RING_SIZE;
438 /* Values changeable by the user. The valid values are
439 * in the range 1 to the "*_max_pending" counterpart above.
441 rvals->rx_pending = rx_queue->rx_ring_size;
442 rvals->rx_mini_pending = rx_queue->rx_ring_size;
443 rvals->rx_jumbo_pending = rx_queue->rx_ring_size;
444 rvals->tx_pending = tx_queue->tx_ring_size;
447 /* Change the current ring parameters, stopping the controller if
448 * necessary so that we don't mess things up while we're in
449 * motion. We wait for the ring to be clean before reallocating
451 static int gfar_sringparam(struct net_device *dev, struct ethtool_ringparam *rvals)
453 struct gfar_private *priv = netdev_priv(dev);
454 struct gfar_priv_tx_q *tx_queue = NULL;
455 struct gfar_priv_rx_q *rx_queue = NULL;
458 if (rvals->rx_pending > GFAR_RX_MAX_RING_SIZE)
461 if (!is_power_of_2(rvals->rx_pending)) {
462 printk("%s: Ring sizes must be a power of 2\n",
467 if (rvals->tx_pending > GFAR_TX_MAX_RING_SIZE)
470 if (!is_power_of_2(rvals->tx_pending)) {
471 printk("%s: Ring sizes must be a power of 2\n",
476 tx_queue = priv->tx_queue;
477 rx_queue = priv->rx_queue;
479 if (dev->flags & IFF_UP) {
482 /* Halt TX and RX, and process the frames which
483 * have already been received */
484 spin_lock_irqsave(&tx_queue->txlock, flags);
485 spin_lock(&rx_queue->rxlock);
489 spin_unlock(&rx_queue->rxlock);
490 spin_unlock_irqrestore(&tx_queue->txlock, flags);
492 gfar_clean_rx_ring(rx_queue, rx_queue->rx_ring_size);
494 /* Now we take down the rings to rebuild them */
498 /* Change the size */
499 rx_queue->rx_ring_size = rvals->rx_pending;
500 tx_queue->tx_ring_size = rvals->tx_pending;
501 tx_queue->num_txbdfree = tx_queue->tx_ring_size;
503 /* Rebuild the rings with the new size */
504 if (dev->flags & IFF_UP) {
505 err = startup_gfar(dev);
506 netif_wake_queue(dev);
511 static int gfar_set_rx_csum(struct net_device *dev, uint32_t data)
513 struct gfar_private *priv = netdev_priv(dev);
514 struct gfar_priv_rx_q *rx_queue = NULL;
515 struct gfar_priv_tx_q *tx_queue = NULL;
519 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_CSUM))
522 tx_queue = priv->tx_queue;
523 rx_queue = priv->rx_queue;
525 if (dev->flags & IFF_UP) {
526 /* Halt TX and RX, and process the frames which
527 * have already been received */
528 spin_lock_irqsave(&tx_queue->txlock, flags);
529 spin_lock(&rx_queue->rxlock);
533 spin_unlock(&rx_queue->rxlock);
534 spin_unlock_irqrestore(&tx_queue->txlock, flags);
536 gfar_clean_rx_ring(rx_queue, rx_queue->rx_ring_size);
538 /* Now we take down the rings to rebuild them */
542 spin_lock_irqsave(&priv->bflock, flags);
543 priv->rx_csum_enable = data;
544 spin_unlock_irqrestore(&priv->bflock, flags);
546 if (dev->flags & IFF_UP) {
547 err = startup_gfar(dev);
548 netif_wake_queue(dev);
553 static uint32_t gfar_get_rx_csum(struct net_device *dev)
555 struct gfar_private *priv = netdev_priv(dev);
557 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_CSUM))
560 return priv->rx_csum_enable;
563 static int gfar_set_tx_csum(struct net_device *dev, uint32_t data)
565 struct gfar_private *priv = netdev_priv(dev);
567 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_CSUM))
570 netif_tx_lock_bh(dev);
573 dev->features |= NETIF_F_IP_CSUM;
575 dev->features &= ~NETIF_F_IP_CSUM;
577 netif_tx_unlock_bh(dev);
582 static uint32_t gfar_get_tx_csum(struct net_device *dev)
584 struct gfar_private *priv = netdev_priv(dev);
586 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_CSUM))
589 return (dev->features & NETIF_F_IP_CSUM) != 0;
592 static uint32_t gfar_get_msglevel(struct net_device *dev)
594 struct gfar_private *priv = netdev_priv(dev);
595 return priv->msg_enable;
598 static void gfar_set_msglevel(struct net_device *dev, uint32_t data)
600 struct gfar_private *priv = netdev_priv(dev);
601 priv->msg_enable = data;
605 static void gfar_get_wol(struct net_device *dev, struct ethtool_wolinfo *wol)
607 struct gfar_private *priv = netdev_priv(dev);
609 if (priv->device_flags & FSL_GIANFAR_DEV_HAS_MAGIC_PACKET) {
610 wol->supported = WAKE_MAGIC;
611 wol->wolopts = priv->wol_en ? WAKE_MAGIC : 0;
613 wol->supported = wol->wolopts = 0;
617 static int gfar_set_wol(struct net_device *dev, struct ethtool_wolinfo *wol)
619 struct gfar_private *priv = netdev_priv(dev);
622 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_MAGIC_PACKET) &&
626 if (wol->wolopts & ~WAKE_MAGIC)
629 spin_lock_irqsave(&priv->bflock, flags);
630 priv->wol_en = wol->wolopts & WAKE_MAGIC ? 1 : 0;
631 device_set_wakeup_enable(&dev->dev, priv->wol_en);
632 spin_unlock_irqrestore(&priv->bflock, flags);
638 const struct ethtool_ops gfar_ethtool_ops = {
639 .get_settings = gfar_gsettings,
640 .set_settings = gfar_ssettings,
641 .get_drvinfo = gfar_gdrvinfo,
642 .get_regs_len = gfar_reglen,
643 .get_regs = gfar_get_regs,
644 .get_link = ethtool_op_get_link,
645 .get_coalesce = gfar_gcoalesce,
646 .set_coalesce = gfar_scoalesce,
647 .get_ringparam = gfar_gringparam,
648 .set_ringparam = gfar_sringparam,
649 .get_strings = gfar_gstrings,
650 .get_sset_count = gfar_sset_count,
651 .get_ethtool_stats = gfar_fill_stats,
652 .get_rx_csum = gfar_get_rx_csum,
653 .get_tx_csum = gfar_get_tx_csum,
654 .set_rx_csum = gfar_set_rx_csum,
655 .set_tx_csum = gfar_set_tx_csum,
656 .set_sg = ethtool_op_set_sg,
657 .get_msglevel = gfar_get_msglevel,
658 .set_msglevel = gfar_set_msglevel,
660 .get_wol = gfar_get_wol,
661 .set_wol = gfar_set_wol,