[deliverable/linux.git] / include / linux / ethtool.h

/*
 * ethtool.h: Defines for Linux ethtool.
 *
 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
 *                                christopher.leech@intel.com,
 *                                scott.feldman@intel.com)
 */

#ifndef _LINUX_ETHTOOL_H
#define _LINUX_ETHTOOL_H


/* This should work for both 32 and 64 bit userland. */
struct ethtool_cmd {
	__u32	cmd;
	__u32	supported;	/* Features this interface supports */
	__u32	advertising;	/* Features this interface advertises */
	__u16	speed;		/* The forced speed, 10Mb, 100Mb, gigabit */
	__u8	duplex;		/* Duplex, half or full */
	__u8	port;		/* Which connector port */
	__u8	phy_address;
	__u8	transceiver;	/* Which transceiver to use */
	__u8	autoneg;	/* Enable or disable autonegotiation */
	__u32	maxtxpkt;	/* Tx pkts before generating tx int */
	__u32	maxrxpkt;	/* Rx pkts before generating rx int */
	__u32	reserved[4];
};

#define ETHTOOL_BUSINFO_LEN	32
/* these strings are set to whatever the driver author decides... */
struct ethtool_drvinfo {
	__u32	cmd;
	char	driver[32];	/* driver short name, "tulip", "eepro100" */
	char	version[32];	/* driver version string */
	char	fw_version[32];	/* firmware version string, if applicable */
	char	bus_info[ETHTOOL_BUSINFO_LEN];	/* Bus info for this IF. */
				/* For PCI devices, use pci_name(pci_dev). */
	char	reserved1[32];
	char	reserved2[16];
	__u32	n_stats;	/* number of u64's from ETHTOOL_GSTATS */
	__u32	testinfo_len;
	__u32	eedump_len;	/* Size of data from ETHTOOL_GEEPROM (bytes) */
	__u32	regdump_len;	/* Size of data from ETHTOOL_GREGS (bytes) */
};

#define SOPASS_MAX	6
/* wake-on-lan settings */
struct ethtool_wolinfo {
	__u32	cmd;
	__u32	supported;
	__u32	wolopts;
	__u8	sopass[SOPASS_MAX]; /* SecureOn(tm) password */
};

/* for passing single values */
struct ethtool_value {
	__u32	cmd;
	__u32	data;
};

/* for passing big chunks of data */
struct ethtool_regs {
	__u32	cmd;
	__u32	version; /* driver-specific, indicates different chips/revs */
	__u32	len; /* bytes */
	__u8	data[0];
};

/* for passing EEPROM chunks */
struct ethtool_eeprom {
	__u32	cmd;
	__u32	magic;
	__u32	offset; /* in bytes */
	__u32	len; /* in bytes */
	__u8	data[0];
};

/* for configuring coalescing parameters of chip */
struct ethtool_coalesce {
	__u32	cmd;	/* ETHTOOL_{G,S}COALESCE */

	/* How many usecs to delay an RX interrupt after
	 * a packet arrives.  If 0, only rx_max_coalesced_frames
	 * is used.
	 */
	__u32	rx_coalesce_usecs;

	/* How many packets to delay an RX interrupt after
	 * a packet arrives.  If 0, only rx_coalesce_usecs is
	 * used.  It is illegal to set both usecs and max frames
	 * to zero as this would cause RX interrupts to never be
	 * generated.
	 */
	__u32	rx_max_coalesced_frames;

	/* Same as above two parameters, except that these values
	 * apply while an IRQ is being serviced by the host.  Not
	 * all cards support this feature and the values are ignored
	 * in that case.
	 */
	__u32	rx_coalesce_usecs_irq;
	__u32	rx_max_coalesced_frames_irq;

	/* How many usecs to delay a TX interrupt after
	 * a packet is sent.  If 0, only tx_max_coalesced_frames
	 * is used.
	 */
	__u32	tx_coalesce_usecs;

	/* How many packets to delay a TX interrupt after
	 * a packet is sent.  If 0, only tx_coalesce_usecs is
	 * used.  It is illegal to set both usecs and max frames
	 * to zero as this would cause TX interrupts to never be
	 * generated.
	 */
	__u32	tx_max_coalesced_frames;

	/* Same as above two parameters, except that these values
	 * apply while an IRQ is being serviced by the host.  Not
	 * all cards support this feature and the values are ignored
	 * in that case.
	 */
	__u32	tx_coalesce_usecs_irq;
	__u32	tx_max_coalesced_frames_irq;

	/* How many usecs to delay in-memory statistics
	 * block updates.  Some drivers do not have an in-memory
	 * statistic block, and in such cases this value is ignored.
	 * This value must not be zero.
	 */
	__u32	stats_block_coalesce_usecs;

	/* Adaptive RX/TX coalescing is an algorithm implemented by
	 * some drivers to improve latency under low packet rates and
	 * improve throughput under high packet rates.  Some drivers
	 * only implement one of RX or TX adaptive coalescing.  Anything
	 * not implemented by the driver causes these values to be
	 * silently ignored.
	 */
	__u32	use_adaptive_rx_coalesce;
	__u32	use_adaptive_tx_coalesce;

	/* When the packet rate (measured in packets per second)
	 * is below pkt_rate_low, the {rx,tx}_*_low parameters are
	 * used.
	 */
	__u32	pkt_rate_low;
	__u32	rx_coalesce_usecs_low;
	__u32	rx_max_coalesced_frames_low;
	__u32	tx_coalesce_usecs_low;
	__u32	tx_max_coalesced_frames_low;

	/* When the packet rate is below pkt_rate_high but above
	 * pkt_rate_low (both measured in packets per second) the
	 * normal {rx,tx}_* coalescing parameters are used.
	 */

	/* When the packet rate is (measured in packets per second)
	 * is above pkt_rate_high, the {rx,tx}_*_high parameters are
	 * used.
	 */
	__u32	pkt_rate_high;
	__u32	rx_coalesce_usecs_high;
	__u32	rx_max_coalesced_frames_high;
	__u32	tx_coalesce_usecs_high;
	__u32	tx_max_coalesced_frames_high;

	/* How often to do adaptive coalescing packet rate sampling,
	 * measured in seconds.  Must not be zero.
	 */
	__u32	rate_sample_interval;
};

/* for configuring RX/TX ring parameters */
struct ethtool_ringparam {
	__u32	cmd;	/* ETHTOOL_{G,S}RINGPARAM */

	/* Read only attributes.  These indicate the maximum number
	 * of pending RX/TX ring entries the driver will allow the
	 * user to set.
	 */
	__u32	rx_max_pending;
	__u32	rx_mini_max_pending;
	__u32	rx_jumbo_max_pending;
	__u32	tx_max_pending;

	/* Values changeable by the user.  The valid values are
	 * in the range 1 to the "*_max_pending" counterpart above.
	 */
	__u32	rx_pending;
	__u32	rx_mini_pending;
	__u32	rx_jumbo_pending;
	__u32	tx_pending;
};

/* for configuring link flow control parameters */
struct ethtool_pauseparam {
	__u32	cmd;	/* ETHTOOL_{G,S}PAUSEPARAM */

	/* If the link is being auto-negotiated (via ethtool_cmd.autoneg
	 * being true) the user may set 'autonet' here non-zero to have the
	 * pause parameters be auto-negotiated too.  In such a case, the
	 * {rx,tx}_pause values below determine what capabilities are
	 * advertised.
	 *
	 * If 'autoneg' is zero or the link is not being auto-negotiated,
	 * then {rx,tx}_pause force the driver to use/not-use pause
	 * flow control.
	 */
	__u32	autoneg;
	__u32	rx_pause;
	__u32	tx_pause;
};

#define ETH_GSTRING_LEN		32
enum ethtool_stringset {
	ETH_SS_TEST		= 0,
	ETH_SS_STATS,
};

/* for passing string sets for data tagging */
struct ethtool_gstrings {
	__u32	cmd;		/* ETHTOOL_GSTRINGS */
	__u32	string_set;	/* string set id e.c. ETH_SS_TEST, etc*/
	__u32	len;		/* number of strings in the string set */
	__u8	data[0];
};

enum ethtool_test_flags {
	ETH_TEST_FL_OFFLINE	= (1 << 0),	/* online / offline */
	ETH_TEST_FL_FAILED	= (1 << 1),	/* test passed / failed */
};

/* for requesting NIC test and getting results*/
struct ethtool_test {
	__u32	cmd;		/* ETHTOOL_TEST */
	__u32	flags;		/* ETH_TEST_FL_xxx */
	__u32	reserved;
	__u32	len;		/* result length, in number of u64 elements */
	__u64	data[0];
};

/* for dumping NIC-specific statistics */
struct ethtool_stats {
	__u32	cmd;		/* ETHTOOL_GSTATS */
	__u32	n_stats;	/* number of u64's being returned */
	__u64	data[0];
};

struct ethtool_perm_addr {
	__u32	cmd;		/* ETHTOOL_GPERMADDR */
	__u32	size;
	__u8	data[0];
};

#ifdef __KERNEL__

struct net_device;

/* Some generic methods drivers may use in their ethtool_ops */
u32 ethtool_op_get_link(struct net_device *dev);
u32 ethtool_op_get_tx_csum(struct net_device *dev);
int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
u32 ethtool_op_get_sg(struct net_device *dev);
int ethtool_op_set_sg(struct net_device *dev, u32 data);
u32 ethtool_op_get_tso(struct net_device *dev);
int ethtool_op_set_tso(struct net_device *dev, u32 data);
int ethtool_op_get_perm_addr(struct net_device *dev, 
			     struct ethtool_perm_addr *addr, u8 *data);
u32 ethtool_op_get_ufo(struct net_device *dev);
int ethtool_op_set_ufo(struct net_device *dev, u32 data);

/**
 * &ethtool_ops - Alter and report network device settings
 * get_settings: Get device-specific settings
 * set_settings: Set device-specific settings
 * get_drvinfo: Report driver information
 * get_regs: Get device registers
 * get_wol: Report whether Wake-on-Lan is enabled
 * set_wol: Turn Wake-on-Lan on or off
 * get_msglevel: Report driver message level
 * set_msglevel: Set driver message level
 * nway_reset: Restart autonegotiation
 * get_link: Get link status
 * get_eeprom: Read data from the device EEPROM
 * set_eeprom: Write data to the device EEPROM
 * get_coalesce: Get interrupt coalescing parameters
 * set_coalesce: Set interrupt coalescing parameters
 * get_ringparam: Report ring sizes
 * set_ringparam: Set ring sizes
 * get_pauseparam: Report pause parameters
 * set_pauseparam: Set pause paramters
 * get_rx_csum: Report whether receive checksums are turned on or off
 * set_rx_csum: Turn receive checksum on or off
 * get_tx_csum: Report whether transmit checksums are turned on or off
 * set_tx_csum: Turn transmit checksums on or off
 * get_sg: Report whether scatter-gather is enabled
 * set_sg: Turn scatter-gather on or off
 * get_tso: Report whether TCP segmentation offload is enabled
 * set_tso: Turn TCP segmentation offload on or off
 * get_ufo: Report whether UDP fragmentation offload is enabled
 * set_ufo: Turn UDP fragmentation offload on or off
 * self_test: Run specified self-tests
 * get_strings: Return a set of strings that describe the requested objects 
 * phys_id: Identify the device
 * get_stats: Return statistics about the device
 * get_perm_addr: Gets the permanent hardware address
 * 
 * Description:
 *
 * get_settings:
 *	@get_settings is passed an &ethtool_cmd to fill in.  It returns
 *	an negative errno or zero.
 *
 * set_settings:
 *	@set_settings is passed an &ethtool_cmd and should attempt to set
 *	all the settings this device supports.  It may return an error value
 *	if something goes wrong (otherwise 0).
 *
 * get_eeprom:
 *	Should fill in the magic field.  Don't need to check len for zero
 *	or wraparound.  Fill in the data argument with the eeprom values
 *	from offset to offset + len.  Update len to the amount read.
 *	Returns an error or zero.
 *
 * set_eeprom:
 *	Should validate the magic field.  Don't need to check len for zero
 *	or wraparound.  Update len to the amount written.  Returns an error
 *	or zero.
 */
struct ethtool_ops {
	int	(*get_settings)(struct net_device *, struct ethtool_cmd *);
	int	(*set_settings)(struct net_device *, struct ethtool_cmd *);
	void	(*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
	int	(*get_regs_len)(struct net_device *);
	void	(*get_regs)(struct net_device *, struct ethtool_regs *, void *);
	void	(*get_wol)(struct net_device *, struct ethtool_wolinfo *);
	int	(*set_wol)(struct net_device *, struct ethtool_wolinfo *);
	u32	(*get_msglevel)(struct net_device *);
	void	(*set_msglevel)(struct net_device *, u32);
	int	(*nway_reset)(struct net_device *);
	u32	(*get_link)(struct net_device *);
	int	(*get_eeprom_len)(struct net_device *);
	int	(*get_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
	int	(*set_eeprom)(struct net_device *, struct ethtool_eeprom *, u8 *);
	int	(*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
	int	(*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
	void	(*get_ringparam)(struct net_device *, struct ethtool_ringparam *);
	int	(*set_ringparam)(struct net_device *, struct ethtool_ringparam *);
	void	(*get_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
	int	(*set_pauseparam)(struct net_device *, struct ethtool_pauseparam*);
	u32	(*get_rx_csum)(struct net_device *);
	int	(*set_rx_csum)(struct net_device *, u32);
	u32	(*get_tx_csum)(struct net_device *);
	int	(*set_tx_csum)(struct net_device *, u32);
	u32	(*get_sg)(struct net_device *);
	int	(*set_sg)(struct net_device *, u32);
	u32	(*get_tso)(struct net_device *);
	int	(*set_tso)(struct net_device *, u32);
	int	(*self_test_count)(struct net_device *);
	void	(*self_test)(struct net_device *, struct ethtool_test *, u64 *);
	void	(*get_strings)(struct net_device *, u32 stringset, u8 *);
	int	(*phys_id)(struct net_device *, u32);
	int	(*get_stats_count)(struct net_device *);
	void	(*get_ethtool_stats)(struct net_device *, struct ethtool_stats *, u64 *);
	int	(*get_perm_addr)(struct net_device *, struct ethtool_perm_addr *, u8 *);
	int	(*begin)(struct net_device *);
	void	(*complete)(struct net_device *);
	u32     (*get_ufo)(struct net_device *);
	int     (*set_ufo)(struct net_device *, u32);
};
#endif /* __KERNEL__ */

/* CMDs currently supported */
#define ETHTOOL_GSET		0x00000001 /* Get settings. */
#define ETHTOOL_SSET		0x00000002 /* Set settings. */
#define ETHTOOL_GDRVINFO	0x00000003 /* Get driver info. */
#define ETHTOOL_GREGS		0x00000004 /* Get NIC registers. */
#define ETHTOOL_GWOL		0x00000005 /* Get wake-on-lan options. */
#define ETHTOOL_SWOL		0x00000006 /* Set wake-on-lan options. */
#define ETHTOOL_GMSGLVL		0x00000007 /* Get driver message level */
#define ETHTOOL_SMSGLVL		0x00000008 /* Set driver msg level. */
#define ETHTOOL_NWAY_RST	0x00000009 /* Restart autonegotiation. */
#define ETHTOOL_GLINK		0x0000000a /* Get link status (ethtool_value) */
#define ETHTOOL_GEEPROM		0x0000000b /* Get EEPROM data */
#define ETHTOOL_SEEPROM		0x0000000c /* Set EEPROM data. */
#define ETHTOOL_GCOALESCE	0x0000000e /* Get coalesce config */
#define ETHTOOL_SCOALESCE	0x0000000f /* Set coalesce config. */
#define ETHTOOL_GRINGPARAM	0x00000010 /* Get ring parameters */
#define ETHTOOL_SRINGPARAM	0x00000011 /* Set ring parameters. */
#define ETHTOOL_GPAUSEPARAM	0x00000012 /* Get pause parameters */
#define ETHTOOL_SPAUSEPARAM	0x00000013 /* Set pause parameters. */
#define ETHTOOL_GRXCSUM		0x00000014 /* Get RX hw csum enable (ethtool_value) */
#define ETHTOOL_SRXCSUM		0x00000015 /* Set RX hw csum enable (ethtool_value) */
#define ETHTOOL_GTXCSUM		0x00000016 /* Get TX hw csum enable (ethtool_value) */
#define ETHTOOL_STXCSUM		0x00000017 /* Set TX hw csum enable (ethtool_value) */
#define ETHTOOL_GSG		0x00000018 /* Get scatter-gather enable
					    * (ethtool_value) */
#define ETHTOOL_SSG		0x00000019 /* Set scatter-gather enable
					    * (ethtool_value). */
#define ETHTOOL_TEST		0x0000001a /* execute NIC self-test. */
#define ETHTOOL_GSTRINGS	0x0000001b /* get specified string set */
#define ETHTOOL_PHYS_ID		0x0000001c /* identify the NIC */
#define ETHTOOL_GSTATS		0x0000001d /* get NIC-specific statistics */
#define ETHTOOL_GTSO		0x0000001e /* Get TSO enable (ethtool_value) */
#define ETHTOOL_STSO		0x0000001f /* Set TSO enable (ethtool_value) */
#define ETHTOOL_GPERMADDR	0x00000020 /* Get permanent hardware address */
#define ETHTOOL_GUFO		0x00000021 /* Get UFO enable (ethtool_value) */
#define ETHTOOL_SUFO		0x00000022 /* Set UFO enable (ethtool_value) */
#define ETHTOOL_GGSO		0x00000023 /* Get GSO enable (ethtool_value) */
#define ETHTOOL_SGSO		0x00000024 /* Set GSO enable (ethtool_value) */

/* compatibility with older code */
#define SPARC_ETH_GSET		ETHTOOL_GSET
#define SPARC_ETH_SSET		ETHTOOL_SSET

/* Indicates what features are supported by the interface. */
#define SUPPORTED_10baseT_Half		(1 << 0)
#define SUPPORTED_10baseT_Full		(1 << 1)
#define SUPPORTED_100baseT_Half		(1 << 2)
#define SUPPORTED_100baseT_Full		(1 << 3)
#define SUPPORTED_1000baseT_Half	(1 << 4)
#define SUPPORTED_1000baseT_Full	(1 << 5)
#define SUPPORTED_Autoneg		(1 << 6)
#define SUPPORTED_TP			(1 << 7)
#define SUPPORTED_AUI			(1 << 8)
#define SUPPORTED_MII			(1 << 9)
#define SUPPORTED_FIBRE			(1 << 10)
#define SUPPORTED_BNC			(1 << 11)
#define SUPPORTED_10000baseT_Full	(1 << 12)
#define SUPPORTED_Pause			(1 << 13)
#define SUPPORTED_Asym_Pause		(1 << 14)
#define SUPPORTED_2500baseX_Full	(1 << 15)

/* Indicates what features are advertised by the interface. */
#define ADVERTISED_10baseT_Half		(1 << 0)
#define ADVERTISED_10baseT_Full		(1 << 1)
#define ADVERTISED_100baseT_Half	(1 << 2)
#define ADVERTISED_100baseT_Full	(1 << 3)
#define ADVERTISED_1000baseT_Half	(1 << 4)
#define ADVERTISED_1000baseT_Full	(1 << 5)
#define ADVERTISED_Autoneg		(1 << 6)
#define ADVERTISED_TP			(1 << 7)
#define ADVERTISED_AUI			(1 << 8)
#define ADVERTISED_MII			(1 << 9)
#define ADVERTISED_FIBRE		(1 << 10)
#define ADVERTISED_BNC			(1 << 11)
#define ADVERTISED_10000baseT_Full	(1 << 12)
#define ADVERTISED_Pause		(1 << 13)
#define ADVERTISED_Asym_Pause		(1 << 14)
#define ADVERTISED_2500baseX_Full	(1 << 15)

/* The following are all involved in forcing a particular link
 * mode for the device for setting things.  When getting the
 * devices settings, these indicate the current mode and whether
 * it was foced up into this mode or autonegotiated.
 */

/* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
#define SPEED_10		10
#define SPEED_100		100
#define SPEED_1000		1000
#define SPEED_2500		2500
#define SPEED_10000		10000

/* Duplex, half or full. */
#define DUPLEX_HALF		0x00
#define DUPLEX_FULL		0x01

/* Which connector port. */
#define PORT_TP			0x00
#define PORT_AUI		0x01
#define PORT_MII		0x02
#define PORT_FIBRE		0x03
#define PORT_BNC		0x04

/* Which transceiver to use. */
#define XCVR_INTERNAL		0x00
#define XCVR_EXTERNAL		0x01
#define XCVR_DUMMY1		0x02
#define XCVR_DUMMY2		0x03
#define XCVR_DUMMY3		0x04

/* Enable or disable autonegotiation.  If this is set to enable,
 * the forced link modes above are completely ignored.
 */
#define AUTONEG_DISABLE		0x00
#define AUTONEG_ENABLE		0x01

/* Wake-On-Lan options. */
#define WAKE_PHY		(1 << 0)
#define WAKE_UCAST		(1 << 1)
#define WAKE_MCAST		(1 << 2)
#define WAKE_BCAST		(1 << 3)
#define WAKE_ARP		(1 << 4)
#define WAKE_MAGIC		(1 << 5)
#define WAKE_MAGICSECURE	(1 << 6) /* only meaningful if WAKE_MAGIC */

#endif /* _LINUX_ETHTOOL_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* ethtool.h: Defines for Linux ethtool.
	3	*
	4	* Copyright (C) 1998 David S. Miller (davem@redhat.com)
	5	* Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
	6	* Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
	7	* Portions Copyright 2002 Intel (eli.kupermann@intel.com,
	8	* christopher.leech@intel.com,
	9	* scott.feldman@intel.com)
	10	*/
	11
	12	#ifndef _LINUX_ETHTOOL_H
	13	#define _LINUX_ETHTOOL_H
	14
	15
	16	/* This should work for both 32 and 64 bit userland. */
	17	struct ethtool_cmd {
c3ce7e20 DW	18	__u32 cmd;
	19	__u32 supported; /* Features this interface supports */
	20	__u32 advertising; /* Features this interface advertises */
	21	__u16 speed; /* The forced speed, 10Mb, 100Mb, gigabit */
	22	__u8 duplex; /* Duplex, half or full */
	23	__u8 port; /* Which connector port */
	24	__u8 phy_address;
	25	__u8 transceiver; /* Which transceiver to use */
	26	__u8 autoneg; /* Enable or disable autonegotiation */
	27	__u32 maxtxpkt; /* Tx pkts before generating tx int */
	28	__u32 maxrxpkt; /* Rx pkts before generating rx int */
	29	__u32 reserved[4];
1da177e4 LT	30	};
	31
	32	#define ETHTOOL_BUSINFO_LEN 32
	33	/* these strings are set to whatever the driver author decides... */
	34	struct ethtool_drvinfo {
c3ce7e20	35	__u32 cmd;
1da177e4 LT	36	char driver[32]; /* driver short name, "tulip", "eepro100" */
	37	char version[32]; /* driver version string */
	38	char fw_version[32]; /* firmware version string, if applicable */
	39	char bus_info[ETHTOOL_BUSINFO_LEN]; /* Bus info for this IF. */
	40	/* For PCI devices, use pci_name(pci_dev). */
	41	char reserved1[32];
	42	char reserved2[16];
c3ce7e20 DW	43	__u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */
	44	__u32 testinfo_len;
	45	__u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */
	46	__u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */
1da177e4 LT	47	};
	48
	49	#define SOPASS_MAX 6
	50	/* wake-on-lan settings */
	51	struct ethtool_wolinfo {
c3ce7e20 DW	52	__u32 cmd;
	53	__u32 supported;
	54	__u32 wolopts;
	55	__u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */
1da177e4 LT	56	};
	57
	58	/* for passing single values */
	59	struct ethtool_value {
c3ce7e20 DW	60	__u32 cmd;
c3ce7e20 DW	61	__u32 data;
1da177e4 LT	62	};
	63
	64	/* for passing big chunks of data */
	65	struct ethtool_regs {
c3ce7e20 DW	66	__u32 cmd;
	67	__u32 version; /* driver-specific, indicates different chips/revs */
	68	__u32 len; /* bytes */
	69	__u8 data[0];
1da177e4 LT	70	};
	71
	72	/* for passing EEPROM chunks */
	73	struct ethtool_eeprom {
c3ce7e20 DW	74	__u32 cmd;
	75	__u32 magic;
	76	__u32 offset; /* in bytes */
	77	__u32 len; /* in bytes */
	78	__u8 data[0];
1da177e4 LT	79	};
	80
	81	/* for configuring coalescing parameters of chip */
	82	struct ethtool_coalesce {
c3ce7e20	83	__u32 cmd; /* ETHTOOL_{G,S}COALESCE */
1da177e4 LT	84
	85	/* How many usecs to delay an RX interrupt after
	86	* a packet arrives. If 0, only rx_max_coalesced_frames
	87	* is used.
	88	*/
c3ce7e20	89	__u32 rx_coalesce_usecs;
1da177e4 LT	90
	91	/* How many packets to delay an RX interrupt after
	92	* a packet arrives. If 0, only rx_coalesce_usecs is
	93	* used. It is illegal to set both usecs and max frames
	94	* to zero as this would cause RX interrupts to never be
	95	* generated.
	96	*/
c3ce7e20	97	__u32 rx_max_coalesced_frames;
1da177e4 LT	98
	99	/* Same as above two parameters, except that these values
	100	* apply while an IRQ is being serviced by the host. Not
	101	* all cards support this feature and the values are ignored
	102	* in that case.
	103	*/
c3ce7e20 DW	104	__u32 rx_coalesce_usecs_irq;
c3ce7e20 DW	105	__u32 rx_max_coalesced_frames_irq;
1da177e4 LT	106
	107	/* How many usecs to delay a TX interrupt after
	108	* a packet is sent. If 0, only tx_max_coalesced_frames
	109	* is used.
	110	*/
c3ce7e20	111	__u32 tx_coalesce_usecs;
1da177e4 LT	112
	113	/* How many packets to delay a TX interrupt after
	114	* a packet is sent. If 0, only tx_coalesce_usecs is
	115	* used. It is illegal to set both usecs and max frames
	116	* to zero as this would cause TX interrupts to never be
	117	* generated.
	118	*/
c3ce7e20	119	__u32 tx_max_coalesced_frames;
1da177e4 LT	120
	121	/* Same as above two parameters, except that these values
	122	* apply while an IRQ is being serviced by the host. Not
	123	* all cards support this feature and the values are ignored
	124	* in that case.
	125	*/
c3ce7e20 DW	126	__u32 tx_coalesce_usecs_irq;
c3ce7e20 DW	127	__u32 tx_max_coalesced_frames_irq;
1da177e4 LT	128
	129	/* How many usecs to delay in-memory statistics
	130	* block updates. Some drivers do not have an in-memory
	131	* statistic block, and in such cases this value is ignored.
	132	* This value must not be zero.
	133	*/
c3ce7e20	134	__u32 stats_block_coalesce_usecs;
1da177e4 LT	135
	136	/* Adaptive RX/TX coalescing is an algorithm implemented by
	137	* some drivers to improve latency under low packet rates and
	138	* improve throughput under high packet rates. Some drivers
	139	* only implement one of RX or TX adaptive coalescing. Anything
	140	* not implemented by the driver causes these values to be
	141	* silently ignored.
	142	*/
c3ce7e20 DW	143	__u32 use_adaptive_rx_coalesce;
c3ce7e20 DW	144	__u32 use_adaptive_tx_coalesce;
1da177e4 LT	145
	146	/* When the packet rate (measured in packets per second)
	147	* is below pkt_rate_low, the {rx,tx}_*_low parameters are
	148	* used.
	149	*/
c3ce7e20 DW	150	__u32 pkt_rate_low;
	151	__u32 rx_coalesce_usecs_low;
	152	__u32 rx_max_coalesced_frames_low;
	153	__u32 tx_coalesce_usecs_low;
	154	__u32 tx_max_coalesced_frames_low;
1da177e4 LT	155
	156	/* When the packet rate is below pkt_rate_high but above
	157	* pkt_rate_low (both measured in packets per second) the
	158	* normal {rx,tx}_* coalescing parameters are used.
	159	*/
	160
	161	/* When the packet rate is (measured in packets per second)
	162	* is above pkt_rate_high, the {rx,tx}_*_high parameters are
	163	* used.
	164	*/
c3ce7e20 DW	165	__u32 pkt_rate_high;
	166	__u32 rx_coalesce_usecs_high;
	167	__u32 rx_max_coalesced_frames_high;
	168	__u32 tx_coalesce_usecs_high;
	169	__u32 tx_max_coalesced_frames_high;
1da177e4 LT	170
	171	/* How often to do adaptive coalescing packet rate sampling,
	172	* measured in seconds. Must not be zero.
	173	*/
c3ce7e20	174	__u32 rate_sample_interval;
1da177e4 LT	175	};
	176
	177	/* for configuring RX/TX ring parameters */
	178	struct ethtool_ringparam {
c3ce7e20	179	__u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */
1da177e4 LT	180
	181	/* Read only attributes. These indicate the maximum number
	182	* of pending RX/TX ring entries the driver will allow the
	183	* user to set.
	184	*/
c3ce7e20 DW	185	__u32 rx_max_pending;
	186	__u32 rx_mini_max_pending;
	187	__u32 rx_jumbo_max_pending;
	188	__u32 tx_max_pending;
1da177e4 LT	189
	190	/* Values changeable by the user. The valid values are
	191	* in the range 1 to the "*_max_pending" counterpart above.
	192	*/
c3ce7e20 DW	193	__u32 rx_pending;
	194	__u32 rx_mini_pending;
	195	__u32 rx_jumbo_pending;
	196	__u32 tx_pending;
1da177e4 LT	197	};
	198
	199	/* for configuring link flow control parameters */
	200	struct ethtool_pauseparam {
c3ce7e20	201	__u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */
1da177e4 LT	202
	203	/* If the link is being auto-negotiated (via ethtool_cmd.autoneg
	204	* being true) the user may set 'autonet' here non-zero to have the
	205	* pause parameters be auto-negotiated too. In such a case, the
	206	* {rx,tx}_pause values below determine what capabilities are
	207	* advertised.
	208	*
	209	* If 'autoneg' is zero or the link is not being auto-negotiated,
	210	* then {rx,tx}_pause force the driver to use/not-use pause
	211	* flow control.
	212	*/
c3ce7e20 DW	213	__u32 autoneg;
	214	__u32 rx_pause;
	215	__u32 tx_pause;
1da177e4 LT	216	};
	217
	218	#define ETH_GSTRING_LEN 32
	219	enum ethtool_stringset {
	220	ETH_SS_TEST = 0,
	221	ETH_SS_STATS,
	222	};
	223
	224	/* for passing string sets for data tagging */
	225	struct ethtool_gstrings {
c3ce7e20 DW	226	__u32 cmd; /* ETHTOOL_GSTRINGS */
	227	__u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/
	228	__u32 len; /* number of strings in the string set */
	229	__u8 data[0];
1da177e4 LT	230	};
	231
	232	enum ethtool_test_flags {
	233	ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */
	234	ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */
	235	};
	236
	237	/* for requesting NIC test and getting results*/
	238	struct ethtool_test {
c3ce7e20 DW	239	__u32 cmd; /* ETHTOOL_TEST */
	240	__u32 flags; /* ETH_TEST_FL_xxx */
	241	__u32 reserved;
	242	__u32 len; /* result length, in number of u64 elements */
	243	__u64 data[0];
1da177e4 LT	244	};
	245
	246	/* for dumping NIC-specific statistics */
	247	struct ethtool_stats {
c3ce7e20 DW	248	__u32 cmd; /* ETHTOOL_GSTATS */
	249	__u32 n_stats; /* number of u64's being returned */
	250	__u64 data[0];
1da177e4 LT	251	};
1da177e4 LT	252
a6f9a705	253	struct ethtool_perm_addr {
c3ce7e20 DW	254	__u32 cmd; /* ETHTOOL_GPERMADDR */
	255	__u32 size;
	256	__u8 data[0];
a6f9a705 JW	257	};
a6f9a705 JW	258
c3ce7e20 DW	259	#ifdef __KERNEL__
c3ce7e20 DW	260
1da177e4 LT	261	struct net_device;
	262
	263	/* Some generic methods drivers may use in their ethtool_ops */
	264	u32 ethtool_op_get_link(struct net_device *dev);
	265	u32 ethtool_op_get_tx_csum(struct net_device *dev);
	266	int ethtool_op_set_tx_csum(struct net_device *dev, u32 data);
69f6a0fa	267	int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data);
1da177e4 LT	268	u32 ethtool_op_get_sg(struct net_device *dev);
	269	int ethtool_op_set_sg(struct net_device *dev, u32 data);
	270	u32 ethtool_op_get_tso(struct net_device *dev);
	271	int ethtool_op_set_tso(struct net_device *dev, u32 data);
a6f9a705 JW	272	int ethtool_op_get_perm_addr(struct net_device *dev,
a6f9a705 JW	273	struct ethtool_perm_addr addr, u8 data);
e89e9cf5 AR	274	u32 ethtool_op_get_ufo(struct net_device *dev);
e89e9cf5 AR	275	int ethtool_op_set_ufo(struct net_device *dev, u32 data);
1da177e4 LT	276
	277	/**
	278	* &ethtool_ops - Alter and report network device settings
	279	* get_settings: Get device-specific settings
	280	* set_settings: Set device-specific settings
	281	* get_drvinfo: Report driver information
	282	* get_regs: Get device registers
	283	* get_wol: Report whether Wake-on-Lan is enabled
	284	* set_wol: Turn Wake-on-Lan on or off
	285	* get_msglevel: Report driver message level
	286	* set_msglevel: Set driver message level
	287	* nway_reset: Restart autonegotiation
	288	* get_link: Get link status
	289	* get_eeprom: Read data from the device EEPROM
	290	* set_eeprom: Write data to the device EEPROM
	291	* get_coalesce: Get interrupt coalescing parameters
	292	* set_coalesce: Set interrupt coalescing parameters
	293	* get_ringparam: Report ring sizes
	294	* set_ringparam: Set ring sizes
	295	* get_pauseparam: Report pause parameters
	296	* set_pauseparam: Set pause paramters
	297	* get_rx_csum: Report whether receive checksums are turned on or off
	298	* set_rx_csum: Turn receive checksum on or off
	299	* get_tx_csum: Report whether transmit checksums are turned on or off
	300	* set_tx_csum: Turn transmit checksums on or off
	301	* get_sg: Report whether scatter-gather is enabled
	302	* set_sg: Turn scatter-gather on or off
	303	* get_tso: Report whether TCP segmentation offload is enabled
	304	* set_tso: Turn TCP segmentation offload on or off
e89e9cf5 AR	305	* get_ufo: Report whether UDP fragmentation offload is enabled
e89e9cf5 AR	306	* set_ufo: Turn UDP fragmentation offload on or off
1da177e4 LT	307	* self_test: Run specified self-tests
	308	* get_strings: Return a set of strings that describe the requested objects
	309	* phys_id: Identify the device
	310	* get_stats: Return statistics about the device
a6f9a705 JW	311	* get_perm_addr: Gets the permanent hardware address
a6f9a705 JW	312	*
1da177e4 LT	313	* Description:
	314	*
	315	* get_settings:
	316	* @get_settings is passed an &ethtool_cmd to fill in. It returns
	317	* an negative errno or zero.
	318	*
	319	* set_settings:
	320	* @set_settings is passed an &ethtool_cmd and should attempt to set
	321	* all the settings this device supports. It may return an error value
	322	* if something goes wrong (otherwise 0).
	323	*
	324	* get_eeprom:
	325	* Should fill in the magic field. Don't need to check len for zero
	326	* or wraparound. Fill in the data argument with the eeprom values
	327	* from offset to offset + len. Update len to the amount read.
	328	* Returns an error or zero.
	329	*
	330	* set_eeprom:
	331	* Should validate the magic field. Don't need to check len for zero
	332	* or wraparound. Update len to the amount written. Returns an error
	333	* or zero.
	334	*/
	335	struct ethtool_ops {
	336	int (get_settings)(struct net_device , struct ethtool_cmd *);
	337	int (set_settings)(struct net_device , struct ethtool_cmd *);
	338	void (get_drvinfo)(struct net_device , struct ethtool_drvinfo *);
	339	int (get_regs_len)(struct net_device );
	340	void (get_regs)(struct net_device , struct ethtool_regs , void );
	341	void (get_wol)(struct net_device , struct ethtool_wolinfo *);
	342	int (set_wol)(struct net_device , struct ethtool_wolinfo *);
	343	u32 (get_msglevel)(struct net_device );
	344	void (set_msglevel)(struct net_device , u32);
	345	int (nway_reset)(struct net_device );
	346	u32 (get_link)(struct net_device );
	347	int (get_eeprom_len)(struct net_device );
	348	int (get_eeprom)(struct net_device , struct ethtool_eeprom , u8 );
	349	int (set_eeprom)(struct net_device , struct ethtool_eeprom , u8 );
	350	int (get_coalesce)(struct net_device , struct ethtool_coalesce *);
	351	int (set_coalesce)(struct net_device , struct ethtool_coalesce *);
	352	void (get_ringparam)(struct net_device , struct ethtool_ringparam *);
	353	int (set_ringparam)(struct net_device , struct ethtool_ringparam *);
	354	void (get_pauseparam)(struct net_device , struct ethtool_pauseparam*);
	355	int (set_pauseparam)(struct net_device , struct ethtool_pauseparam*);
	356	u32 (get_rx_csum)(struct net_device );
	357	int (set_rx_csum)(struct net_device , u32);
	358	u32 (get_tx_csum)(struct net_device );
	359	int (set_tx_csum)(struct net_device , u32);
	360	u32 (get_sg)(struct net_device );
	361	int (set_sg)(struct net_device , u32);
	362	u32 (get_tso)(struct net_device );
	363	int (set_tso)(struct net_device , u32);
	364	int (self_test_count)(struct net_device );
	365	void (self_test)(struct net_device , struct ethtool_test , u64 );
	366	void (get_strings)(struct net_device , u32 stringset, u8 *);
	367	int (phys_id)(struct net_device , u32);
	368	int (get_stats_count)(struct net_device );
	369	void (get_ethtool_stats)(struct net_device , struct ethtool_stats , u64 );
a6f9a705	370	int (get_perm_addr)(struct net_device , struct ethtool_perm_addr , u8 );
1da177e4 LT	371	int (begin)(struct net_device );
1da177e4 LT	372	void (complete)(struct net_device );
e89e9cf5 AR	373	u32 (get_ufo)(struct net_device );
e89e9cf5 AR	374	int (set_ufo)(struct net_device , u32);
1da177e4	375	};
c3ce7e20	376	#endif /* __KERNEL__ */
1da177e4 LT	377
	378	/* CMDs currently supported */
	379	#define ETHTOOL_GSET 0x00000001 /* Get settings. */
	380	#define ETHTOOL_SSET 0x00000002 /* Set settings. */
	381	#define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
	382	#define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
	383	#define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
	384	#define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
	385	#define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
	386	#define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
	387	#define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
	388	#define ETHTOOL_GLINK 0x0000000a /* Get link status (ethtool_value) */
	389	#define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
	390	#define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
	391	#define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
	392	#define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
	393	#define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
	394	#define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
	395	#define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
	396	#define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
	397	#define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
	398	#define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
	399	#define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
	400	#define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
	401	#define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
	402	* (ethtool_value) */
	403	#define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
	404	* (ethtool_value). */
	405	#define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
	406	#define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
	407	#define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
	408	#define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
	409	#define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
	410	#define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
a6f9a705	411	#define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
e89e9cf5 AR	412	#define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
e89e9cf5 AR	413	#define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
37c3185a HX	414	#define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
37c3185a HX	415	#define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
1da177e4 LT	416
	417	/* compatibility with older code */
	418	#define SPARC_ETH_GSET ETHTOOL_GSET
	419	#define SPARC_ETH_SSET ETHTOOL_SSET
	420
	421	/* Indicates what features are supported by the interface. */
	422	#define SUPPORTED_10baseT_Half (1 << 0)
	423	#define SUPPORTED_10baseT_Full (1 << 1)
	424	#define SUPPORTED_100baseT_Half (1 << 2)
	425	#define SUPPORTED_100baseT_Full (1 << 3)
	426	#define SUPPORTED_1000baseT_Half (1 << 4)
	427	#define SUPPORTED_1000baseT_Full (1 << 5)
	428	#define SUPPORTED_Autoneg (1 << 6)
	429	#define SUPPORTED_TP (1 << 7)
	430	#define SUPPORTED_AUI (1 << 8)
	431	#define SUPPORTED_MII (1 << 9)
	432	#define SUPPORTED_FIBRE (1 << 10)
	433	#define SUPPORTED_BNC (1 << 11)
	434	#define SUPPORTED_10000baseT_Full (1 << 12)
00db8189 AF	435	#define SUPPORTED_Pause (1 << 13)
00db8189 AF	436	#define SUPPORTED_Asym_Pause (1 << 14)
427c2196	437	#define SUPPORTED_2500baseX_Full (1 << 15)
1da177e4 LT	438
	439	/* Indicates what features are advertised by the interface. */
	440	#define ADVERTISED_10baseT_Half (1 << 0)
	441	#define ADVERTISED_10baseT_Full (1 << 1)
	442	#define ADVERTISED_100baseT_Half (1 << 2)
	443	#define ADVERTISED_100baseT_Full (1 << 3)
	444	#define ADVERTISED_1000baseT_Half (1 << 4)
	445	#define ADVERTISED_1000baseT_Full (1 << 5)
	446	#define ADVERTISED_Autoneg (1 << 6)
	447	#define ADVERTISED_TP (1 << 7)
	448	#define ADVERTISED_AUI (1 << 8)
	449	#define ADVERTISED_MII (1 << 9)
	450	#define ADVERTISED_FIBRE (1 << 10)
	451	#define ADVERTISED_BNC (1 << 11)
	452	#define ADVERTISED_10000baseT_Full (1 << 12)
00db8189 AF	453	#define ADVERTISED_Pause (1 << 13)
00db8189 AF	454	#define ADVERTISED_Asym_Pause (1 << 14)
427c2196	455	#define ADVERTISED_2500baseX_Full (1 << 15)
1da177e4 LT	456
	457	/* The following are all involved in forcing a particular link
	458	* mode for the device for setting things. When getting the
	459	* devices settings, these indicate the current mode and whether
	460	* it was foced up into this mode or autonegotiated.
	461	*/
	462
5b0c76ad	463	/* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */
1da177e4 LT	464	#define SPEED_10 10
	465	#define SPEED_100 100
	466	#define SPEED_1000 1000
5b0c76ad	467	#define SPEED_2500 2500
1da177e4 LT	468	#define SPEED_10000 10000
	469
	470	/* Duplex, half or full. */
	471	#define DUPLEX_HALF 0x00
	472	#define DUPLEX_FULL 0x01
	473
	474	/* Which connector port. */
	475	#define PORT_TP 0x00
	476	#define PORT_AUI 0x01
	477	#define PORT_MII 0x02
	478	#define PORT_FIBRE 0x03
	479	#define PORT_BNC 0x04
	480
	481	/* Which transceiver to use. */
	482	#define XCVR_INTERNAL 0x00
	483	#define XCVR_EXTERNAL 0x01
	484	#define XCVR_DUMMY1 0x02
	485	#define XCVR_DUMMY2 0x03
	486	#define XCVR_DUMMY3 0x04
	487
	488	/* Enable or disable autonegotiation. If this is set to enable,
	489	* the forced link modes above are completely ignored.
	490	*/
	491	#define AUTONEG_DISABLE 0x00
	492	#define AUTONEG_ENABLE 0x01
	493
	494	/* Wake-On-Lan options. */
	495	#define WAKE_PHY (1 << 0)
	496	#define WAKE_UCAST (1 << 1)
	497	#define WAKE_MCAST (1 << 2)
	498	#define WAKE_BCAST (1 << 3)
	499	#define WAKE_ARP (1 << 4)
	500	#define WAKE_MAGIC (1 << 5)
	501	#define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
	502
	503	#endif /* _LINUX_ETHTOOL_H */