include/linux/ethtool.h

1 /* SPDX-License-Identifier: GPL-2.0 */
44  * enum ethtool_phys_id_state - indicator state for physical identification
60 	ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
61 	ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
62 	ETH_RSS_HASH_CRC32_BIT, /* Configurable RSS hash function - Crc32 */
72  * struct kernel_ethtool_ringparam - RX/TX ring configuration
92  * enum ethtool_supported_ring_param - indicator caps for setting ring params
138 	 * In a simpler world it should be equal to netdev->carrier_down_count
140 	 * actually take the physical link down, not to mention NC-SI which,
151  * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
180  * ethtool_link_ksettings_zero_link_mode - clear link_ksettings link mode mask
185 	bitmap_zero((ptr)->link_modes.name, __ETHTOOL_LINK_MODE_MASK_NBITS)
188  * ethtool_link_ksettings_add_link_mode - set bit in link_ksettings
196 	__set_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
199  * ethtool_link_ksettings_del_link_mode - clear bit in link_ksettings
207 	__clear_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
210  * ethtool_link_ksettings_test_link_mode - test bit in ksettings link mode mask
219 	test_bit(ETHTOOL_LINK_MODE_ ## mode ## _BIT, (ptr)->link_modes.name)
234  * ethtool_intersect_link_masks - Given two link masks, AND them together
314 	while (n--)  in ethtool_stats_init()
372  * struct ethtool_pause_stats - statistics for IEEE 802.3x pause frames
398  * struct ethtool_fec_stats - statistics for IEEE 802.3 FEC
411  *	not entire FEC data blocks. This is a non-standard statistic.
416  * - @lanes: per-lane/PCS-instance counts as defined by the standard
417  * - @total: error counts for the entire port, for drivers incapable of reporting
418  *	per-lane stats
420  * Drivers should fill in either only total or per-lane statistics, core
431  * struct ethtool_rmon_hist_range - byte range for histogram statistics
443  * struct ethtool_rmon_stats - selected RMON (RFC 2819) statistics
455  * APIs, primarily the packet-length-based counters.
477  * struct ethtool_module_eeprom - EEPROM dump from specified page
499  * struct ethtool_module_power_mode_params - module power mode parameters
500  * @policy: The power mode policy enforced by the host for the plug-in module.
501  * @mode: The operational power mode of the plug-in module. Should be filled by
510  * struct ethtool_mm_state - 802.3 MAC merge layer state
531  *	set if the Verify function of the MM layer (which sends SMD-V
535  *	using positive rather than negative logic). The device should always
536  *	respond to received SMD-V requests as long as @pmac_enabled is set.
538  *	the minimum size of non-final mPacket fragments that the link partner
542  *	to the formula 64 * (1 + addFragSize) - 4), a value in a continuous and
545  *	the minimum size of non-final mPacket fragments that this device
561  * struct ethtool_mm_cfg - 802.3 MAC merge layer configuration
577  * struct ethtool_mm_stats - 802.3 MAC merge layer statistics
585  *	number of additional correct SMD-C mPackets received due to preemption
602  * struct ethtool_rxfh_param - RXFH (RSS) parameters
619  * @rss_delete: Set to non-ZERO to remove the @rss_context context.
635  * struct ethtool_ops - optional netdev operations
640  * @cap_rss_sym_xor_supported: indicates if the driver supports symmetric-xor
650  * @get_wol: Report whether Wake-on-Lan is enabled
651  * @set_wol: Turn Wake-on-Lan on or off.  Returns a negative error code
656  * @nway_reset: Restart autonegotiation.  Returns a negative error code
664  *	and link_ext_substate are unknown, return -ENODATA. If not implemented,
666  * @get_link_ext_stats: Read extra link-related counters.
679  * @get_coalesce: Get interrupt coalescing parameters.  Returns a negative
683  *	Returns a negative error code or zero.
685  * @set_ringparam: Set ring sizes.  Returns a negative error code or zero.
690  * @set_pauseparam: Set pause parameters.  Returns a negative error code
692  * @self_test: Run specified self-tests
699  *	a negative error or return a positive frequency for synchronous
705  *	negative error code or zero.
710  *	negative error code or zero.
713  * @get_priv_flags: Report driver-specific feature flags.
714  * @set_priv_flags: Set driver-specific feature flags.  Returns a negative
717  * @get_rxnfc: Get RX flow classification rules.  Returns a negative
719  * @set_rxnfc: Set RX flow classification rules.  Returns a negative
722  *	Returns a negative error code or zero.
724  *	flags from &enum ethtool_reset_flags.  Returns a negative
732  *	Returns a negative error code or zero.
736  *	Returns a negative error code or zero. An error code must be returned
739  * @set_channels: Set number of channels.  Returns a negative error code or
750  *	a plug-in module.
751  * @get_module_eeprom: Get the eeprom information from the plug-in module
752  * @get_eee: Get Energy-Efficient (EEE) supported and status.
758  *	a TX queue has this number, return -EINVAL. If only a RX queue or a TX
760  *	Returns a negative error code or zero.
763  *	a TX queue has this number, return -EINVAL. If only a RX queue or a TX
766  *	Returns a negative error code or zero.
770  *	any change to them will be overwritten by kernel. Returns a negative
775  *	any change to them will be overwritten by kernel. Returns a negative
778  *	Core will sum up per-lane stats to get the total.
789  * @get_module_eeprom_by_page: Get a region of plug-in module EEPROM data from
790  *	specified page. Returns a negative error code or the amount of bytes
796  *	Set %ranges to a pointer to zero-terminated array of byte ranges.
797  * @get_module_power_mode: Get the power mode policy for the plug-in module
799  *	plugged-in.
800  * @set_module_power_mode: Set the power mode policy for the plug-in module
811  * Note that for all operations using a structure ending with a zero-
972  * struct ethtool_phy_ops - Optional PHY device options
1005  * ethtool_set_ethtool_phy_ops - Set the ethtool_phy_ops singleton
1011  * ethtool_params_from_link_mode - Derive link parameters from a given link mode
1020  * ethtool_get_phc_vclocks - Derive phc vclocks information, and caller
1034  * ethtool_mm_frag_size_add_to_min - Translate (standard) additional fragment
1041 	return (ETH_ZLEN + ETH_FCS_LEN) * (1 + val_add) - ETH_FCS_LEN;  in ethtool_mm_frag_size_add_to_min()
1045  * ethtool_mm_frag_size_min_to_add - Translate (absolute) minimum fragment size
1053  * application of the 802.3 formula 64 * (1 + addFragSize) - 4. To be called
1071 	return -EINVAL;  in ethtool_mm_frag_size_min_to_add()
1075  * ethtool_get_ts_info_by_layer - Obtains time stamping capabilities from the MAC or PHY layer.
1078  * Returns zero on success, non-zero otherwise.
1083  * ethtool_sprintf - Write formatted string to ethtool string data
1093  * ethtool_puts - Write string to ethtool string data