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 struct gfar __iomem *regs = priv->gfargrp.regs;
141 u64 *extra = (u64 *) & priv->extra_stats;
143 if (priv->device_flags & FSL_GIANFAR_DEV_HAS_RMON) {
144 u32 __iomem *rmon = (u32 __iomem *) ®s->rmon;
145 struct gfar_stats *stats = (struct gfar_stats *) buf;
147 for (i = 0; i < GFAR_RMON_LEN; i++)
148 stats->rmon[i] = (u64) gfar_read(&rmon[i]);
150 for (i = 0; i < GFAR_EXTRA_STATS_LEN; i++)
151 stats->extra[i] = extra[i];
153 for (i = 0; i < GFAR_EXTRA_STATS_LEN; i++)
157 static int gfar_sset_count(struct net_device *dev, int sset)
159 struct gfar_private *priv = netdev_priv(dev);
163 if (priv->device_flags & FSL_GIANFAR_DEV_HAS_RMON)
164 return GFAR_STATS_LEN;
166 return GFAR_EXTRA_STATS_LEN;
172 /* Fills in the drvinfo structure with some basic info */
173 static void gfar_gdrvinfo(struct net_device *dev, struct
174 ethtool_drvinfo *drvinfo)
176 strncpy(drvinfo->driver, DRV_NAME, GFAR_INFOSTR_LEN);
177 strncpy(drvinfo->version, gfar_driver_version, GFAR_INFOSTR_LEN);
178 strncpy(drvinfo->fw_version, "N/A", GFAR_INFOSTR_LEN);
179 strncpy(drvinfo->bus_info, "N/A", GFAR_INFOSTR_LEN);
180 drvinfo->regdump_len = 0;
181 drvinfo->eedump_len = 0;
185 static int gfar_ssettings(struct net_device *dev, struct ethtool_cmd *cmd)
187 struct gfar_private *priv = netdev_priv(dev);
188 struct phy_device *phydev = priv->phydev;
193 return phy_ethtool_sset(phydev, cmd);
197 /* Return the current settings in the ethtool_cmd structure */
198 static int gfar_gsettings(struct net_device *dev, struct ethtool_cmd *cmd)
200 struct gfar_private *priv = netdev_priv(dev);
201 struct phy_device *phydev = priv->phydev;
202 struct gfar_priv_rx_q *rx_queue = NULL;
203 struct gfar_priv_tx_q *tx_queue = NULL;
207 tx_queue = priv->tx_queue;
208 rx_queue = priv->rx_queue;
210 cmd->maxtxpkt = get_icft_value(tx_queue->txic);
211 cmd->maxrxpkt = get_icft_value(rx_queue->rxic);
213 return phy_ethtool_gset(phydev, cmd);
216 /* Return the length of the register structure */
217 static int gfar_reglen(struct net_device *dev)
219 return sizeof (struct gfar);
222 /* Return a dump of the GFAR register space */
223 static void gfar_get_regs(struct net_device *dev, struct ethtool_regs *regs, void *regbuf)
226 struct gfar_private *priv = netdev_priv(dev);
227 u32 __iomem *theregs = (u32 __iomem *) priv->gfargrp.regs;
228 u32 *buf = (u32 *) regbuf;
230 for (i = 0; i < sizeof (struct gfar) / sizeof (u32); i++)
231 buf[i] = gfar_read(&theregs[i]);
234 /* Convert microseconds to ethernet clock ticks, which changes
235 * depending on what speed the controller is running at */
236 static unsigned int gfar_usecs2ticks(struct gfar_private *priv, unsigned int usecs)
240 /* The timer is different, depending on the interface speed */
241 switch (priv->phydev->speed) {
243 count = GFAR_GBIT_TIME;
246 count = GFAR_100_TIME;
250 count = GFAR_10_TIME;
254 /* Make sure we return a number greater than 0
256 return ((usecs * 1000 + count - 1) / count);
259 /* Convert ethernet clock ticks to microseconds */
260 static unsigned int gfar_ticks2usecs(struct gfar_private *priv, unsigned int ticks)
264 /* The timer is different, depending on the interface speed */
265 switch (priv->phydev->speed) {
267 count = GFAR_GBIT_TIME;
270 count = GFAR_100_TIME;
274 count = GFAR_10_TIME;
278 /* Make sure we return a number greater than 0 */
279 /* if ticks is > 0 */
280 return ((ticks * count) / 1000);
283 /* Get the coalescing parameters, and put them in the cvals
285 static int gfar_gcoalesce(struct net_device *dev, struct ethtool_coalesce *cvals)
287 struct gfar_private *priv = netdev_priv(dev);
288 struct gfar_priv_rx_q *rx_queue = NULL;
289 struct gfar_priv_tx_q *tx_queue = NULL;
290 unsigned long rxtime;
291 unsigned long rxcount;
292 unsigned long txtime;
293 unsigned long txcount;
295 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_COALESCE))
298 if (NULL == priv->phydev)
301 rx_queue = priv->rx_queue;
302 tx_queue = priv->tx_queue;
304 rxtime = get_ictt_value(rx_queue->rxic);
305 rxcount = get_icft_value(rx_queue->rxic);
306 txtime = get_ictt_value(tx_queue->txic);
307 txcount = get_icft_value(tx_queue->txic);
308 cvals->rx_coalesce_usecs = gfar_ticks2usecs(priv, rxtime);
309 cvals->rx_max_coalesced_frames = rxcount;
311 cvals->tx_coalesce_usecs = gfar_ticks2usecs(priv, txtime);
312 cvals->tx_max_coalesced_frames = txcount;
314 cvals->use_adaptive_rx_coalesce = 0;
315 cvals->use_adaptive_tx_coalesce = 0;
317 cvals->pkt_rate_low = 0;
318 cvals->rx_coalesce_usecs_low = 0;
319 cvals->rx_max_coalesced_frames_low = 0;
320 cvals->tx_coalesce_usecs_low = 0;
321 cvals->tx_max_coalesced_frames_low = 0;
323 /* When the packet rate is below pkt_rate_high but above
324 * pkt_rate_low (both measured in packets per second) the
325 * normal {rx,tx}_* coalescing parameters are used.
328 /* When the packet rate is (measured in packets per second)
329 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
332 cvals->pkt_rate_high = 0;
333 cvals->rx_coalesce_usecs_high = 0;
334 cvals->rx_max_coalesced_frames_high = 0;
335 cvals->tx_coalesce_usecs_high = 0;
336 cvals->tx_max_coalesced_frames_high = 0;
338 /* How often to do adaptive coalescing packet rate sampling,
339 * measured in seconds. Must not be zero.
341 cvals->rate_sample_interval = 0;
346 /* Change the coalescing values.
347 * Both cvals->*_usecs and cvals->*_frames have to be > 0
348 * in order for coalescing to be active
350 static int gfar_scoalesce(struct net_device *dev, struct ethtool_coalesce *cvals)
352 struct gfar_private *priv = netdev_priv(dev);
353 struct gfar __iomem *regs = priv->gfargrp.regs;
354 struct gfar_priv_tx_q *tx_queue = NULL;
355 struct gfar_priv_rx_q *rx_queue = NULL;
357 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_COALESCE))
360 tx_queue = priv->tx_queue;
361 rx_queue = priv->rx_queue;
363 /* Set up rx coalescing */
364 if ((cvals->rx_coalesce_usecs == 0) ||
365 (cvals->rx_max_coalesced_frames == 0))
366 rx_queue->rxcoalescing = 0;
368 rx_queue->rxcoalescing = 1;
370 if (NULL == priv->phydev)
373 /* Check the bounds of the values */
374 if (cvals->rx_coalesce_usecs > GFAR_MAX_COAL_USECS) {
375 pr_info("Coalescing is limited to %d microseconds\n",
376 GFAR_MAX_COAL_USECS);
380 if (cvals->rx_max_coalesced_frames > GFAR_MAX_COAL_FRAMES) {
381 pr_info("Coalescing is limited to %d frames\n",
382 GFAR_MAX_COAL_FRAMES);
386 rx_queue->rxic = mk_ic_value(cvals->rx_max_coalesced_frames,
387 gfar_usecs2ticks(priv, cvals->rx_coalesce_usecs));
389 /* Set up tx coalescing */
390 if ((cvals->tx_coalesce_usecs == 0) ||
391 (cvals->tx_max_coalesced_frames == 0))
392 tx_queue->txcoalescing = 0;
394 tx_queue->txcoalescing = 1;
396 /* Check the bounds of the values */
397 if (cvals->tx_coalesce_usecs > GFAR_MAX_COAL_USECS) {
398 pr_info("Coalescing is limited to %d microseconds\n",
399 GFAR_MAX_COAL_USECS);
403 if (cvals->tx_max_coalesced_frames > GFAR_MAX_COAL_FRAMES) {
404 pr_info("Coalescing is limited to %d frames\n",
405 GFAR_MAX_COAL_FRAMES);
409 tx_queue->txic = mk_ic_value(cvals->tx_max_coalesced_frames,
410 gfar_usecs2ticks(priv, cvals->tx_coalesce_usecs));
412 gfar_write(®s->rxic, 0);
413 if (rx_queue->rxcoalescing)
414 gfar_write(®s->rxic, rx_queue->rxic);
416 gfar_write(®s->txic, 0);
417 if (tx_queue->txcoalescing)
418 gfar_write(®s->txic, tx_queue->txic);
423 /* Fills in rvals with the current ring parameters. Currently,
424 * rx, rx_mini, and rx_jumbo rings are the same size, as mini and
425 * jumbo are ignored by the driver */
426 static void gfar_gringparam(struct net_device *dev, struct ethtool_ringparam *rvals)
428 struct gfar_private *priv = netdev_priv(dev);
429 struct gfar_priv_tx_q *tx_queue = NULL;
430 struct gfar_priv_rx_q *rx_queue = NULL;
432 tx_queue = priv->tx_queue;
433 rx_queue = priv->rx_queue;
435 rvals->rx_max_pending = GFAR_RX_MAX_RING_SIZE;
436 rvals->rx_mini_max_pending = GFAR_RX_MAX_RING_SIZE;
437 rvals->rx_jumbo_max_pending = GFAR_RX_MAX_RING_SIZE;
438 rvals->tx_max_pending = GFAR_TX_MAX_RING_SIZE;
440 /* Values changeable by the user. The valid values are
441 * in the range 1 to the "*_max_pending" counterpart above.
443 rvals->rx_pending = rx_queue->rx_ring_size;
444 rvals->rx_mini_pending = rx_queue->rx_ring_size;
445 rvals->rx_jumbo_pending = rx_queue->rx_ring_size;
446 rvals->tx_pending = tx_queue->tx_ring_size;
449 /* Change the current ring parameters, stopping the controller if
450 * necessary so that we don't mess things up while we're in
451 * motion. We wait for the ring to be clean before reallocating
453 static int gfar_sringparam(struct net_device *dev, struct ethtool_ringparam *rvals)
455 struct gfar_private *priv = netdev_priv(dev);
456 struct gfar_priv_tx_q *tx_queue = NULL;
457 struct gfar_priv_rx_q *rx_queue = NULL;
460 if (rvals->rx_pending > GFAR_RX_MAX_RING_SIZE)
463 if (!is_power_of_2(rvals->rx_pending)) {
464 printk("%s: Ring sizes must be a power of 2\n",
469 if (rvals->tx_pending > GFAR_TX_MAX_RING_SIZE)
472 if (!is_power_of_2(rvals->tx_pending)) {
473 printk("%s: Ring sizes must be a power of 2\n",
478 tx_queue = priv->tx_queue;
479 rx_queue = priv->rx_queue;
481 if (dev->flags & IFF_UP) {
484 /* Halt TX and RX, and process the frames which
485 * have already been received */
486 spin_lock_irqsave(&tx_queue->txlock, flags);
487 spin_lock(&rx_queue->rxlock);
491 spin_unlock(&rx_queue->rxlock);
492 spin_unlock_irqrestore(&tx_queue->txlock, flags);
494 gfar_clean_rx_ring(rx_queue, rx_queue->rx_ring_size);
496 /* Now we take down the rings to rebuild them */
500 /* Change the size */
501 rx_queue->rx_ring_size = rvals->rx_pending;
502 tx_queue->tx_ring_size = rvals->tx_pending;
503 tx_queue->num_txbdfree = tx_queue->tx_ring_size;
505 /* Rebuild the rings with the new size */
506 if (dev->flags & IFF_UP) {
507 err = startup_gfar(dev);
508 netif_wake_queue(dev);
513 static int gfar_set_rx_csum(struct net_device *dev, uint32_t data)
515 struct gfar_private *priv = netdev_priv(dev);
516 struct gfar_priv_rx_q *rx_queue = NULL;
517 struct gfar_priv_tx_q *tx_queue = NULL;
521 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_CSUM))
524 tx_queue = priv->tx_queue;
525 rx_queue = priv->rx_queue;
527 if (dev->flags & IFF_UP) {
528 /* Halt TX and RX, and process the frames which
529 * have already been received */
530 spin_lock_irqsave(&tx_queue->txlock, flags);
531 spin_lock(&rx_queue->rxlock);
535 spin_unlock(&rx_queue->rxlock);
536 spin_unlock_irqrestore(&tx_queue->txlock, flags);
538 gfar_clean_rx_ring(rx_queue, rx_queue->rx_ring_size);
540 /* Now we take down the rings to rebuild them */
544 spin_lock_irqsave(&priv->bflock, flags);
545 priv->rx_csum_enable = data;
546 spin_unlock_irqrestore(&priv->bflock, flags);
548 if (dev->flags & IFF_UP) {
549 err = startup_gfar(dev);
550 netif_wake_queue(dev);
555 static uint32_t gfar_get_rx_csum(struct net_device *dev)
557 struct gfar_private *priv = netdev_priv(dev);
559 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_CSUM))
562 return priv->rx_csum_enable;
565 static int gfar_set_tx_csum(struct net_device *dev, uint32_t data)
567 struct gfar_private *priv = netdev_priv(dev);
569 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_CSUM))
572 netif_tx_lock_bh(dev);
575 dev->features |= NETIF_F_IP_CSUM;
577 dev->features &= ~NETIF_F_IP_CSUM;
579 netif_tx_unlock_bh(dev);
584 static uint32_t gfar_get_tx_csum(struct net_device *dev)
586 struct gfar_private *priv = netdev_priv(dev);
588 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_CSUM))
591 return (dev->features & NETIF_F_IP_CSUM) != 0;
594 static uint32_t gfar_get_msglevel(struct net_device *dev)
596 struct gfar_private *priv = netdev_priv(dev);
597 return priv->msg_enable;
600 static void gfar_set_msglevel(struct net_device *dev, uint32_t data)
602 struct gfar_private *priv = netdev_priv(dev);
603 priv->msg_enable = data;
607 static void gfar_get_wol(struct net_device *dev, struct ethtool_wolinfo *wol)
609 struct gfar_private *priv = netdev_priv(dev);
611 if (priv->device_flags & FSL_GIANFAR_DEV_HAS_MAGIC_PACKET) {
612 wol->supported = WAKE_MAGIC;
613 wol->wolopts = priv->wol_en ? WAKE_MAGIC : 0;
615 wol->supported = wol->wolopts = 0;
619 static int gfar_set_wol(struct net_device *dev, struct ethtool_wolinfo *wol)
621 struct gfar_private *priv = netdev_priv(dev);
624 if (!(priv->device_flags & FSL_GIANFAR_DEV_HAS_MAGIC_PACKET) &&
628 if (wol->wolopts & ~WAKE_MAGIC)
631 spin_lock_irqsave(&priv->bflock, flags);
632 priv->wol_en = wol->wolopts & WAKE_MAGIC ? 1 : 0;
633 device_set_wakeup_enable(&dev->dev, priv->wol_en);
634 spin_unlock_irqrestore(&priv->bflock, flags);
640 const struct ethtool_ops gfar_ethtool_ops = {
641 .get_settings = gfar_gsettings,
642 .set_settings = gfar_ssettings,
643 .get_drvinfo = gfar_gdrvinfo,
644 .get_regs_len = gfar_reglen,
645 .get_regs = gfar_get_regs,
646 .get_link = ethtool_op_get_link,
647 .get_coalesce = gfar_gcoalesce,
648 .set_coalesce = gfar_scoalesce,
649 .get_ringparam = gfar_gringparam,
650 .set_ringparam = gfar_sringparam,
651 .get_strings = gfar_gstrings,
652 .get_sset_count = gfar_sset_count,
653 .get_ethtool_stats = gfar_fill_stats,
654 .get_rx_csum = gfar_get_rx_csum,
655 .get_tx_csum = gfar_get_tx_csum,
656 .set_rx_csum = gfar_set_rx_csum,
657 .set_tx_csum = gfar_set_tx_csum,
658 .set_sg = ethtool_op_set_sg,
659 .get_msglevel = gfar_get_msglevel,
660 .set_msglevel = gfar_set_msglevel,
662 .get_wol = gfar_get_wol,
663 .set_wol = gfar_set_wol,