/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ /* * ethtool.h: Defines for Linux ethtool. * * Copyright (C) 1998 David S. Miller ([email protected]) * Copyright 2001 Jeff Garzik <[email protected]> * Portions Copyright 2001 Sun Microsystems ([email protected]) * Portions Copyright 2002 Intel ([email protected], * [email protected], * [email protected]) * Portions Copyright (C) Sun Microsystems 2008 */ #ifndef _UAPI_LINUX_ETHTOOL_H #define _UAPI_LINUX_ETHTOOL_H #include <linux/const.h> #include <linux/types.h> #include <linux/if_ether.h> #ifndef __KERNEL__ #include <limits.h> /* for INT_MAX */ #endif /* All structures exposed to userland should be defined such that they * have the same layout for 32-bit and 64-bit userland. */ /* Note on reserved space. * Reserved fields must not be accessed directly by user space because * they may be replaced by a different field in the future. They must * be initialized to zero before making the request, e.g. via memset * of the entire structure or implicitly by not being set in a structure * initializer. */ /** * struct ethtool_cmd - DEPRECATED, link control and status * This structure is DEPRECATED, please use struct ethtool_link_settings. * @cmd: Command number = %ETHTOOL_GSET or %ETHTOOL_SSET * @supported: Bitmask of %SUPPORTED_* flags for the link modes, * physical connectors and other link features for which the * interface supports autonegotiation or auto-detection. * Read-only. * @advertising: Bitmask of %ADVERTISED_* flags for the link modes, * physical connectors and other link features that are * advertised through autonegotiation or enabled for * auto-detection. * @speed: Low bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN * @duplex: Duplex mode; one of %DUPLEX_* * @port: Physical connector type; one of %PORT_* * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not * applicable. For clause 45 PHYs this is the PRTAD. * @transceiver: Historically used to distinguish different possible * PHY types, but not in a consistent way. Deprecated. * @autoneg: Enable/disable autonegotiation and auto-detection; * either %AUTONEG_DISABLE or %AUTONEG_ENABLE * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO * protocols supported by the interface; 0 if unknown. * Read-only. * @maxtxpkt: Historically used to report TX IRQ coalescing; now * obsoleted by &struct ethtool_coalesce. Read-only; deprecated. * @maxrxpkt: Historically used to report RX IRQ coalescing; now * obsoleted by &struct ethtool_coalesce. Read-only; deprecated. * @speed_hi: High bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of * %ETH_TP_MDI_*. If the status is unknown or not applicable, the * value will be %ETH_TP_MDI_INVALID. Read-only. * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected. * When written successfully, the link should be renegotiated if * necessary. * @lp_advertising: Bitmask of %ADVERTISED_* flags for the link modes * and other link features that the link partner advertised * through autonegotiation; 0 if unknown or not applicable. * Read-only. * @reserved: Reserved for future use; see the note on reserved space. * * The link speed in Mbps is split between @speed and @speed_hi. Use * the ethtool_cmd_speed() and ethtool_cmd_speed_set() functions to * access it. * * If autonegotiation is disabled, the speed and @duplex represent the * fixed link mode and are writable if the driver supports multiple * link modes. If it is enabled then they are read-only; if the link * is up they represent the negotiated link mode; if the link is down, * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode. * * Some hardware interfaces may have multiple PHYs and/or physical * connectors fitted or do not allow the driver to detect which are * fitted. For these interfaces @port and/or @phy_address may be * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE. * Otherwise, attempts to write different values may be ignored or * rejected. * * Users should assume that all fields not marked read-only are * writable and subject to validation by the driver. They should use * %ETHTOOL_GSET to get the current values before making specific * changes and then applying them with %ETHTOOL_SSET. * * Deprecated fields should be ignored by both users and drivers. */ struct ethtool_cmd { … }; static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep, __u32 speed) { … } static inline __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep) { … } /* Device supports clause 22 register access to PHY or peripherals * using the interface defined in <linux/mii.h>. This should not be * set if there are known to be no such peripherals present or if * the driver only emulates clause 22 registers for compatibility. */ #define ETH_MDIO_SUPPORTS_C22 … /* Device supports clause 45 register access to PHY or peripherals * using the interface defined in <linux/mii.h> and <linux/mdio.h>. * This should not be set if there are known to be no such peripherals * present. */ #define ETH_MDIO_SUPPORTS_C45 … #define ETHTOOL_FWVERS_LEN … #define ETHTOOL_BUSINFO_LEN … #define ETHTOOL_EROMVERS_LEN … /** * struct ethtool_drvinfo - general driver and device information * @cmd: Command number = %ETHTOOL_GDRVINFO * @driver: Driver short name. This should normally match the name * in its bus driver structure (e.g. pci_driver::name). Must * not be an empty string. * @version: Driver version string; may be an empty string * @fw_version: Firmware version string; driver defined; may be an * empty string * @erom_version: Expansion ROM version string; driver defined; may be * an empty string * @bus_info: Device bus address. This should match the dev_name() * string for the underlying bus device, if there is one. May be * an empty string. * @reserved2: Reserved for future use; see the note on reserved space. * @n_priv_flags: Number of flags valid for %ETHTOOL_GPFLAGS and * %ETHTOOL_SPFLAGS commands; also the number of strings in the * %ETH_SS_PRIV_FLAGS set * @n_stats: Number of u64 statistics returned by the %ETHTOOL_GSTATS * command; also the number of strings in the %ETH_SS_STATS set * @testinfo_len: Number of results returned by the %ETHTOOL_TEST * command; also the number of strings in the %ETH_SS_TEST set * @eedump_len: Size of EEPROM accessible through the %ETHTOOL_GEEPROM * and %ETHTOOL_SEEPROM commands, in bytes * @regdump_len: Size of register dump returned by the %ETHTOOL_GREGS * command, in bytes * * Users can use the %ETHTOOL_GSSET_INFO command to get the number of * strings in any string set (from Linux 2.6.34). */ struct ethtool_drvinfo { … }; #define SOPASS_MAX … /** * struct ethtool_wolinfo - Wake-On-Lan configuration * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes. * Read-only. * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes. * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE * is set in @wolopts. */ struct ethtool_wolinfo { … }; /* for passing single values */ struct ethtool_value { … }; #define PFC_STORM_PREVENTION_AUTO … #define PFC_STORM_PREVENTION_DISABLE … enum tunable_id { … }; enum tunable_type_id { … }; struct ethtool_tunable { … }; #define DOWNSHIFT_DEV_DEFAULT_COUNT … #define DOWNSHIFT_DEV_DISABLE … /* Time in msecs after which link is reported as down * 0 = lowest time supported by the PHY * 0xff = off, link down detection according to standard */ #define ETHTOOL_PHY_FAST_LINK_DOWN_ON … #define ETHTOOL_PHY_FAST_LINK_DOWN_OFF … /* Energy Detect Power Down (EDPD) is a feature supported by some PHYs, where * the PHY's RX & TX blocks are put into a low-power mode when there is no * link detected (typically cable is un-plugged). For RX, only a minimal * link-detection is available, and for TX the PHY wakes up to send link pulses * to avoid any lock-ups in case the peer PHY may also be running in EDPD mode. * * Some PHYs may support configuration of the wake-up interval for TX pulses, * and some PHYs may support only disabling TX pulses entirely. For the latter * a special value is required (ETHTOOL_PHY_EDPD_NO_TX) so that this can be * configured from userspace (should the user want it). * * The interval units for TX wake-up are in milliseconds, since this should * cover a reasonable range of intervals: * - from 1 millisecond, which does not sound like much of a power-saver * - to ~65 seconds which is quite a lot to wait for a link to come up when * plugging a cable */ #define ETHTOOL_PHY_EDPD_DFLT_TX_MSECS … #define ETHTOOL_PHY_EDPD_NO_TX … #define ETHTOOL_PHY_EDPD_DISABLE … enum phy_tunable_id { … }; /** * struct ethtool_regs - hardware register dump * @cmd: Command number = %ETHTOOL_GREGS * @version: Dump format version. This is driver-specific and may * distinguish different chips/revisions. Drivers must use new * version numbers whenever the dump format changes in an * incompatible way. * @len: On entry, the real length of @data. On return, the number of * bytes used. * @data: Buffer for the register dump * * Users should use %ETHTOOL_GDRVINFO to find the maximum length of * a register dump for the interface. They must allocate the buffer * immediately following this structure. */ struct ethtool_regs { … }; /** * struct ethtool_eeprom - EEPROM dump * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or * %ETHTOOL_SEEPROM * @magic: A 'magic cookie' value to guard against accidental changes. * The value passed in to %ETHTOOL_SEEPROM must match the value * returned by %ETHTOOL_GEEPROM for the same device. This is * unused when @cmd is %ETHTOOL_GMODULEEEPROM. * @offset: Offset within the EEPROM to begin reading/writing, in bytes * @len: On entry, number of bytes to read/write. On successful * return, number of bytes actually read/written. In case of * error, this may indicate at what point the error occurred. * @data: Buffer to read/write from * * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find * the length of an on-board or module EEPROM, respectively. They * must allocate the buffer immediately following this structure. */ struct ethtool_eeprom { … }; /** * struct ethtool_eee - Energy Efficient Ethernet information * @cmd: ETHTOOL_{G,S}EEE * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations * for which there is EEE support. * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations * advertised as eee capable. * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex * combinations advertised by the link partner as eee capable. * @eee_active: Result of the eee auto negotiation. * @eee_enabled: EEE configured mode (enabled/disabled). * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given * that eee was negotiated. * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting * its tx lpi (after reaching 'idle' state). Effective only when eee * was negotiated and tx_lpi_enabled was set. * @reserved: Reserved for future use; see the note on reserved space. */ struct ethtool_eee { … }; /** * struct ethtool_modinfo - plugin module eeprom information * @cmd: %ETHTOOL_GMODULEINFO * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx * @eeprom_len: Length of the eeprom * @reserved: Reserved for future use; see the note on reserved space. * * This structure is used to return the information to * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM. * The type code indicates the eeprom data format */ struct ethtool_modinfo { … }; /** * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates * @cmd: ETHTOOL_{G,S}COALESCE * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after * a packet arrives. * @rx_max_coalesced_frames: Maximum number of packets to receive * before an RX interrupt. * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that * this value applies while an IRQ is being serviced by the host. * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames, * except that this value applies while an IRQ is being serviced * by the host. * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after * a packet is sent. * @tx_max_coalesced_frames: Maximum number of packets to be sent * before a TX interrupt. * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that * this value applies while an IRQ is being serviced by the host. * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames, * except that this value applies while an IRQ is being serviced * by the host. * @stats_block_coalesce_usecs: 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. * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing. * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing. * @pkt_rate_low: Threshold for low packet rate (packets per second). * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after * a packet arrives, when the packet rate is below @pkt_rate_low. * @rx_max_coalesced_frames_low: Maximum number of packets to be received * before an RX interrupt, when the packet rate is below @pkt_rate_low. * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after * a packet is sent, when the packet rate is below @pkt_rate_low. * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before * a TX interrupt, when the packet rate is below @pkt_rate_low. * @pkt_rate_high: Threshold for high packet rate (packets per second). * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after * a packet arrives, when the packet rate is above @pkt_rate_high. * @rx_max_coalesced_frames_high: Maximum number of packets to be received * before an RX interrupt, when the packet rate is above @pkt_rate_high. * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after * a packet is sent, when the packet rate is above @pkt_rate_high. * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before * a TX interrupt, when the packet rate is above @pkt_rate_high. * @rate_sample_interval: How often to do adaptive coalescing packet rate * sampling, measured in seconds. Must not be zero. * * Each pair of (usecs, max_frames) fields specifies that interrupts * should be coalesced until * (usecs > 0 && time_since_first_completion >= usecs) || * (max_frames > 0 && completed_frames >= max_frames) * * It is illegal to set both usecs and max_frames to zero as this * would cause interrupts to never be generated. To disable * coalescing, set usecs = 0 and max_frames = 1. * * Some implementations ignore the value of max_frames and use the * condition time_since_first_completion >= usecs * * This is deprecated. Drivers for hardware that does not support * counting completions should validate that max_frames == !rx_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. * * 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. */ struct ethtool_coalesce { … }; /** * struct ethtool_ringparam - RX/TX ring parameters * @cmd: Command number = %ETHTOOL_GRINGPARAM or %ETHTOOL_SRINGPARAM * @rx_max_pending: Maximum supported number of pending entries per * RX ring. Read-only. * @rx_mini_max_pending: Maximum supported number of pending entries * per RX mini ring. Read-only. * @rx_jumbo_max_pending: Maximum supported number of pending entries * per RX jumbo ring. Read-only. * @tx_max_pending: Maximum supported number of pending entries per * TX ring. Read-only. * @rx_pending: Current maximum number of pending entries per RX ring * @rx_mini_pending: Current maximum number of pending entries per RX * mini ring * @rx_jumbo_pending: Current maximum number of pending entries per RX * jumbo ring * @tx_pending: Current maximum supported number of pending entries * per TX ring * * If the interface does not have separate RX mini and/or jumbo rings, * @rx_mini_max_pending and/or @rx_jumbo_max_pending will be 0. * * There may also be driver-dependent minimum values for the number * of entries per ring. */ struct ethtool_ringparam { … }; /** * struct ethtool_channels - configuring number of network channel * @cmd: ETHTOOL_{G,S}CHANNELS * @max_rx: Read only. Maximum number of receive channel the driver support. * @max_tx: Read only. Maximum number of transmit channel the driver support. * @max_other: Read only. Maximum number of other channel the driver support. * @max_combined: Read only. Maximum number of combined channel the driver * support. Set of queues RX, TX or other. * @rx_count: Valid values are in the range 1 to the max_rx. * @tx_count: Valid values are in the range 1 to the max_tx. * @other_count: Valid values are in the range 1 to the max_other. * @combined_count: Valid values are in the range 1 to the max_combined. * * This can be used to configure RX, TX and other channels. */ struct ethtool_channels { … }; /** * struct ethtool_pauseparam - Ethernet pause (flow control) parameters * @cmd: Command number = %ETHTOOL_GPAUSEPARAM or %ETHTOOL_SPAUSEPARAM * @autoneg: Flag to enable autonegotiation of pause frame use * @rx_pause: Flag to enable reception of pause frames * @tx_pause: Flag to enable transmission of pause frames * * Drivers should reject a non-zero setting of @autoneg when * autoneogotiation is disabled (or not supported) for the link. * * If the link is autonegotiated, drivers should use * mii_advertise_flowctrl() or similar code to set the advertised * pause frame capabilities based on the @rx_pause and @tx_pause flags, * even if @autoneg is zero. They should also allow the advertised * pause frame capabilities to be controlled directly through the * advertising field of &struct ethtool_cmd. * * If @autoneg is non-zero, the MAC is configured to send and/or * receive pause frames according to the result of autonegotiation. * Otherwise, it is configured directly based on the @rx_pause and * @tx_pause flags. */ struct ethtool_pauseparam { … }; /* Link extended state */ enum ethtool_link_ext_state { … }; /* More information in addition to ETHTOOL_LINK_EXT_STATE_AUTONEG. */ enum ethtool_link_ext_substate_autoneg { … }; /* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE. */ enum ethtool_link_ext_substate_link_training { … }; /* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH. */ enum ethtool_link_ext_substate_link_logical_mismatch { … }; /* More information in addition to ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY. */ enum ethtool_link_ext_substate_bad_signal_integrity { … }; /* More information in addition to ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE. */ enum ethtool_link_ext_substate_cable_issue { … }; /* More information in addition to ETHTOOL_LINK_EXT_STATE_MODULE. */ enum ethtool_link_ext_substate_module { … }; #define ETH_GSTRING_LEN … /** * enum ethtool_stringset - string set ID * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with * %ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE; * now deprecated * @ETH_SS_FEATURES: Device feature names * @ETH_SS_RSS_HASH_FUNCS: RSS hush function names * @ETH_SS_TUNABLES: tunable names * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS * @ETH_SS_PHY_TUNABLES: PHY tunable names * @ETH_SS_LINK_MODES: link mode names * @ETH_SS_MSG_CLASSES: debug message class names * @ETH_SS_WOL_MODES: wake-on-lan modes * @ETH_SS_SOF_TIMESTAMPING: SOF_TIMESTAMPING_* flags * @ETH_SS_TS_TX_TYPES: timestamping Tx types * @ETH_SS_TS_RX_FILTERS: timestamping Rx filters * @ETH_SS_UDP_TUNNEL_TYPES: UDP tunnel types * @ETH_SS_STATS_STD: standardized stats * @ETH_SS_STATS_ETH_PHY: names of IEEE 802.3 PHY statistics * @ETH_SS_STATS_ETH_MAC: names of IEEE 802.3 MAC statistics * @ETH_SS_STATS_ETH_CTRL: names of IEEE 802.3 MAC Control statistics * @ETH_SS_STATS_RMON: names of RMON statistics * * @ETH_SS_COUNT: number of defined string sets */ enum ethtool_stringset { … }; /** * enum ethtool_mac_stats_src - source of ethtool MAC statistics * @ETHTOOL_MAC_STATS_SRC_AGGREGATE: * if device supports a MAC merge layer, this retrieves the aggregate * statistics of the eMAC and pMAC. Otherwise, it retrieves just the * statistics of the single (express) MAC. * @ETHTOOL_MAC_STATS_SRC_EMAC: * if device supports a MM layer, this retrieves the eMAC statistics. * Otherwise, it retrieves the statistics of the single (express) MAC. * @ETHTOOL_MAC_STATS_SRC_PMAC: * if device supports a MM layer, this retrieves the pMAC statistics. */ enum ethtool_mac_stats_src { … }; /** * enum ethtool_module_power_mode_policy - plug-in module power mode policy * @ETHTOOL_MODULE_POWER_MODE_POLICY_HIGH: Module is always in high power mode. * @ETHTOOL_MODULE_POWER_MODE_POLICY_AUTO: Module is transitioned by the host * to high power mode when the first port using it is put administratively * up and to low power mode when the last port using it is put * administratively down. */ enum ethtool_module_power_mode_policy { … }; /** * enum ethtool_module_power_mode - plug-in module power mode * @ETHTOOL_MODULE_POWER_MODE_LOW: Module is in low power mode. * @ETHTOOL_MODULE_POWER_MODE_HIGH: Module is in high power mode. */ enum ethtool_module_power_mode { … }; /** * enum ethtool_c33_pse_ext_state - groups of PSE extended states * functions. IEEE 802.3-2022 33.2.4.4 Variables * * @ETHTOOL_C33_PSE_EXT_STATE_ERROR_CONDITION: Group of error_condition states * @ETHTOOL_C33_PSE_EXT_STATE_MR_MPS_VALID: Group of mr_mps_valid states * @ETHTOOL_C33_PSE_EXT_STATE_MR_PSE_ENABLE: Group of mr_pse_enable states * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_DETECT_TED: Group of option_detect_ted * states * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_VPORT_LIM: Group of option_vport_lim states * @ETHTOOL_C33_PSE_EXT_STATE_OVLD_DETECTED: Group of ovld_detected states * @ETHTOOL_C33_PSE_EXT_STATE_PD_DLL_POWER_TYPE: Group of pd_dll_power_type * states * @ETHTOOL_C33_PSE_EXT_STATE_POWER_NOT_AVAILABLE: Group of power_not_available * states * @ETHTOOL_C33_PSE_EXT_STATE_SHORT_DETECTED: Group of short_detected states */ enum ethtool_c33_pse_ext_state { … }; /** * enum ethtool_c33_pse_ext_substate_mr_mps_valid - mr_mps_valid states * functions. IEEE 802.3-2022 33.2.4.4 Variables * * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_DETECTED_UNDERLOAD: Underload * state * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_CONNECTION_OPEN: Port is not * connected * * The PSE monitors either the DC or AC Maintain Power Signature * (MPS, see 33.2.9.1). This variable indicates the presence or absence of * a valid MPS. */ enum ethtool_c33_pse_ext_substate_mr_mps_valid { … }; /** * enum ethtool_c33_pse_ext_substate_error_condition - error_condition states * functions. IEEE 802.3-2022 33.2.4.4 Variables * * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_NON_EXISTING_PORT: Non-existing * port number * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNDEFINED_PORT: Undefined port * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_INTERNAL_HW_FAULT: Internal * hardware fault * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_COMM_ERROR_AFTER_FORCE_ON: * Communication error after force on * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNKNOWN_PORT_STATUS: Unknown * port status * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_TURN_OFF: Host * crash turn off * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_FORCE_SHUTDOWN: * Host crash force shutdown * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_CONFIG_CHANGE: Configuration * change * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_DETECTED_OVER_TEMP: Over * temperature detected * * error_condition is a variable indicating the status of * implementation-specific fault conditions or optionally other system faults * that prevent the PSE from meeting the specifications in Table 33–11 and that * require the PSE not to source power. These error conditions are different * from those monitored by the state diagrams in Figure 33–10. */ enum ethtool_c33_pse_ext_substate_error_condition { … }; /** * enum ethtool_c33_pse_ext_substate_mr_pse_enable - mr_pse_enable states * functions. IEEE 802.3-2022 33.2.4.4 Variables * * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_PSE_ENABLE_DISABLE_PIN_ACTIVE: Disable * pin active * * mr_pse_enable is control variable that selects PSE operation and test * functions. */ enum ethtool_c33_pse_ext_substate_mr_pse_enable { … }; /** * enum ethtool_c33_pse_ext_substate_option_detect_ted - option_detect_ted * states functions. IEEE 802.3-2022 33.2.4.4 Variables * * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_DET_IN_PROCESS: Detection * in process * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_CONNECTION_CHECK_ERROR: * Connection check error * * option_detect_ted is a variable indicating if detection can be performed * by the PSE during the ted_timer interval. */ enum ethtool_c33_pse_ext_substate_option_detect_ted { … }; /** * enum ethtool_c33_pse_ext_substate_option_vport_lim - option_vport_lim states * functions. IEEE 802.3-2022 33.2.4.4 Variables * * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_HIGH_VOLTAGE: Main supply * voltage is high * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_LOW_VOLTAGE: Main supply * voltage is low * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_VOLTAGE_INJECTION: Voltage * injection into the port * * option_vport_lim is an optional variable indicates if VPSE is out of the * operating range during normal operating state. */ enum ethtool_c33_pse_ext_substate_option_vport_lim { … }; /** * enum ethtool_c33_pse_ext_substate_ovld_detected - ovld_detected states * functions. IEEE 802.3-2022 33.2.4.4 Variables * * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OVLD_DETECTED_OVERLOAD: Overload state * * ovld_detected is a variable indicating if the PSE output current has been * in an overload condition (see 33.2.7.6) for at least TCUT of a one-second * sliding time. */ enum ethtool_c33_pse_ext_substate_ovld_detected { … }; /** * enum ethtool_c33_pse_ext_substate_power_not_available - power_not_available * states functions. IEEE 802.3-2022 33.2.4.4 Variables * * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_BUDGET_EXCEEDED: Power * budget exceeded for the controller * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PORT_PW_LIMIT_EXCEEDS_CONTROLLER_BUDGET: * Configured port power limit exceeded controller power budget * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PD_REQUEST_EXCEEDS_PORT_LIMIT: * Power request from PD exceeds port limit * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_HW_PW_LIMIT: Power * denied due to Hardware power limit * * power_not_available is a variable that is asserted in an * implementation-dependent manner when the PSE is no longer capable of * sourcing sufficient power to support the attached PD. Sufficient power * is defined by classification; see 33.2.6. */ enum ethtool_c33_pse_ext_substate_power_not_available { … }; /** * enum ethtool_c33_pse_ext_substate_short_detected - short_detected states * functions. IEEE 802.3-2022 33.2.4.4 Variables * * @ETHTOOL_C33_PSE_EXT_SUBSTATE_SHORT_DETECTED_SHORT_CONDITION: Short * condition was detected * * short_detected is a variable indicating if the PSE output current has been * in a short circuit condition for TLIM within a sliding window (see 33.2.7.7). */ enum ethtool_c33_pse_ext_substate_short_detected { … }; /** * enum ethtool_pse_types - Types of PSE controller. * @ETHTOOL_PSE_UNKNOWN: Type of PSE controller is unknown * @ETHTOOL_PSE_PODL: PSE controller which support PoDL * @ETHTOOL_PSE_C33: PSE controller which support Clause 33 (PoE) */ enum ethtool_pse_types { … }; /** * enum ethtool_c33_pse_admin_state - operational state of the PoDL PSE * functions. IEEE 802.3-2022 30.9.1.1.2 aPSEAdminState * @ETHTOOL_C33_PSE_ADMIN_STATE_UNKNOWN: state of PSE functions is unknown * @ETHTOOL_C33_PSE_ADMIN_STATE_DISABLED: PSE functions are disabled * @ETHTOOL_C33_PSE_ADMIN_STATE_ENABLED: PSE functions are enabled */ enum ethtool_c33_pse_admin_state { … }; /** * enum ethtool_c33_pse_pw_d_status - power detection status of the PSE. * IEEE 802.3-2022 30.9.1.1.3 aPoDLPSEPowerDetectionStatus: * @ETHTOOL_C33_PSE_PW_D_STATUS_UNKNOWN: PSE status is unknown * @ETHTOOL_C33_PSE_PW_D_STATUS_DISABLED: The enumeration "disabled" * indicates that the PSE State diagram is in the state DISABLED. * @ETHTOOL_C33_PSE_PW_D_STATUS_SEARCHING: The enumeration "searching" * indicates the PSE State diagram is in a state other than those * listed. * @ETHTOOL_C33_PSE_PW_D_STATUS_DELIVERING: The enumeration * "deliveringPower" indicates that the PSE State diagram is in the * state POWER_ON. * @ETHTOOL_C33_PSE_PW_D_STATUS_TEST: The enumeration "test" indicates that * the PSE State diagram is in the state TEST_MODE. * @ETHTOOL_C33_PSE_PW_D_STATUS_FAULT: The enumeration "fault" indicates that * the PSE State diagram is in the state TEST_ERROR. * @ETHTOOL_C33_PSE_PW_D_STATUS_OTHERFAULT: The enumeration "otherFault" * indicates that the PSE State diagram is in the state IDLE due to * the variable error_condition = true. */ enum ethtool_c33_pse_pw_d_status { … }; /** * enum ethtool_podl_pse_admin_state - operational state of the PoDL PSE * functions. IEEE 802.3-2018 30.15.1.1.2 aPoDLPSEAdminState * @ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN: state of PoDL PSE functions are * unknown * @ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED: PoDL PSE functions are disabled * @ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED: PoDL PSE functions are enabled */ enum ethtool_podl_pse_admin_state { … }; /** * enum ethtool_podl_pse_pw_d_status - power detection status of the PoDL PSE. * IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPowerDetectionStatus: * @ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN: PoDL PSE * @ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED: "The enumeration “disabled” is * asserted true when the PoDL PSE state diagram variable mr_pse_enable is * false" * @ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING: "The enumeration “searching” is * asserted true when either of the PSE state diagram variables * pi_detecting or pi_classifying is true." * @ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING: "The enumeration “deliveringPower” * is asserted true when the PoDL PSE state diagram variable pi_powered is * true." * @ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP: "The enumeration “sleep” is asserted * true when the PoDL PSE state diagram variable pi_sleeping is true." * @ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE: "The enumeration “idle” is asserted true * when the logical combination of the PoDL PSE state diagram variables * pi_prebiased*!pi_sleeping is true." * @ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR: "The enumeration “error” is asserted * true when the PoDL PSE state diagram variable overload_held is true." */ enum ethtool_podl_pse_pw_d_status { … }; /** * enum ethtool_mm_verify_status - status of MAC Merge Verify function * @ETHTOOL_MM_VERIFY_STATUS_UNKNOWN: * verification status is unknown * @ETHTOOL_MM_VERIFY_STATUS_INITIAL: * the 802.3 Verify State diagram is in the state INIT_VERIFICATION * @ETHTOOL_MM_VERIFY_STATUS_VERIFYING: * the Verify State diagram is in the state VERIFICATION_IDLE, * SEND_VERIFY or WAIT_FOR_RESPONSE * @ETHTOOL_MM_VERIFY_STATUS_SUCCEEDED: * indicates that the Verify State diagram is in the state VERIFIED * @ETHTOOL_MM_VERIFY_STATUS_FAILED: * the Verify State diagram is in the state VERIFY_FAIL * @ETHTOOL_MM_VERIFY_STATUS_DISABLED: * verification of preemption operation is disabled */ enum ethtool_mm_verify_status { … }; /** * enum ethtool_module_fw_flash_status - plug-in module firmware flashing status * @ETHTOOL_MODULE_FW_FLASH_STATUS_STARTED: The firmware flashing process has * started. * @ETHTOOL_MODULE_FW_FLASH_STATUS_IN_PROGRESS: The firmware flashing process * is in progress. * @ETHTOOL_MODULE_FW_FLASH_STATUS_COMPLETED: The firmware flashing process was * completed successfully. * @ETHTOOL_MODULE_FW_FLASH_STATUS_ERROR: The firmware flashing process was * stopped due to an error. */ enum ethtool_module_fw_flash_status { … }; /** * struct ethtool_gstrings - string set for data tagging * @cmd: Command number = %ETHTOOL_GSTRINGS * @string_set: String set ID; one of &enum ethtool_stringset * @len: On return, the number of strings in the string set * @data: Buffer for strings. Each string is null-padded to a size of * %ETH_GSTRING_LEN. * * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in * the string set. They must allocate a buffer of the appropriate * size immediately following this structure. */ struct ethtool_gstrings { … }; /** * struct ethtool_sset_info - string set information * @cmd: Command number = %ETHTOOL_GSSET_INFO * @reserved: Reserved for future use; see the note on reserved space. * @sset_mask: On entry, a bitmask of string sets to query, with bits * numbered according to &enum ethtool_stringset. On return, a * bitmask of those string sets queried that are supported. * @data: Buffer for string set sizes. On return, this contains the * size of each string set that was queried and supported, in * order of ID. * * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on * return @sset_mask == 0x6 (sets 1, 2). Then @data[0] contains the * size of set 1 and @data[1] contains the size of set 2. * * Users must allocate a buffer of the appropriate size (4 * number of * sets queried) immediately following this structure. */ struct ethtool_sset_info { … }; /** * enum ethtool_test_flags - flags definition of ethtool_test * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise * only online tests. * @ETH_TEST_FL_FAILED: Driver set this flag if test fails. * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback * test. * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test */ enum ethtool_test_flags { … }; /** * struct ethtool_test - device self-test invocation * @cmd: Command number = %ETHTOOL_TEST * @flags: A bitmask of flags from &enum ethtool_test_flags. Some * flags may be set by the user on entry; others may be set by * the driver on return. * @reserved: Reserved for future use; see the note on reserved space. * @len: On return, the number of test results * @data: Array of test results * * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the * number of test results that will be returned. They must allocate a * buffer of the appropriate size (8 * number of results) immediately * following this structure. */ struct ethtool_test { … }; /** * struct ethtool_stats - device-specific statistics * @cmd: Command number = %ETHTOOL_GSTATS * @n_stats: On return, the number of statistics * @data: Array of statistics * * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the * number of statistics that will be returned. They must allocate a * buffer of the appropriate size (8 * number of statistics) * immediately following this structure. */ struct ethtool_stats { … }; /** * struct ethtool_perm_addr - permanent hardware address * @cmd: Command number = %ETHTOOL_GPERMADDR * @size: On entry, the size of the buffer. On return, the size of the * address. The command fails if the buffer is too small. * @data: Buffer for the address * * Users must allocate the buffer immediately following this structure. * A buffer size of %MAX_ADDR_LEN should be sufficient for any address * type. */ struct ethtool_perm_addr { … }; /* boolean flags controlling per-interface behavior characteristics. * When reading, the flag indicates whether or not a certain behavior * is enabled/present. When writing, the flag indicates whether * or not the driver should turn on (set) or off (clear) a behavior. * * Some behaviors may read-only (unconditionally absent or present). * If such is the case, return EINVAL in the set-flags operation if the * flag differs from the read-only value. */ enum ethtool_flags { … }; /* The following structures are for supporting RX network flow * classification and RX n-tuple configuration. Note, all multibyte * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to * be in network byte order. */ /** * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc. * @ip4src: Source host * @ip4dst: Destination host * @psrc: Source port * @pdst: Destination port * @tos: Type-of-service * * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow. */ struct ethtool_tcpip4_spec { … }; /** * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4 * @ip4src: Source host * @ip4dst: Destination host * @spi: Security parameters index * @tos: Type-of-service * * This can be used to specify an IPsec transport or tunnel over IPv4. */ struct ethtool_ah_espip4_spec { … }; #define ETH_RX_NFC_IP4 … /** * struct ethtool_usrip4_spec - general flow specification for IPv4 * @ip4src: Source host * @ip4dst: Destination host * @l4_4_bytes: First 4 bytes of transport (layer 4) header * @tos: Type-of-service * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0 * @proto: Transport protocol number; mask must be 0 */ struct ethtool_usrip4_spec { … }; /** * struct ethtool_tcpip6_spec - flow specification for TCP/IPv6 etc. * @ip6src: Source host * @ip6dst: Destination host * @psrc: Source port * @pdst: Destination port * @tclass: Traffic Class * * This can be used to specify a TCP/IPv6, UDP/IPv6 or SCTP/IPv6 flow. */ struct ethtool_tcpip6_spec { … }; /** * struct ethtool_ah_espip6_spec - flow specification for IPsec/IPv6 * @ip6src: Source host * @ip6dst: Destination host * @spi: Security parameters index * @tclass: Traffic Class * * This can be used to specify an IPsec transport or tunnel over IPv6. */ struct ethtool_ah_espip6_spec { … }; /** * struct ethtool_usrip6_spec - general flow specification for IPv6 * @ip6src: Source host * @ip6dst: Destination host * @l4_4_bytes: First 4 bytes of transport (layer 4) header * @tclass: Traffic Class * @l4_proto: Transport protocol number (nexthdr after any Extension Headers) */ struct ethtool_usrip6_spec { … }; ethtool_flow_union; /** * struct ethtool_flow_ext - additional RX flow fields * @h_dest: destination MAC address * @vlan_etype: VLAN EtherType * @vlan_tci: VLAN tag control information * @data: user defined data * @padding: Reserved for future use; see the note on reserved space. * * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT * is set in &struct ethtool_rx_flow_spec @flow_type. * @h_dest is valid if %FLOW_MAC_EXT is set. */ struct ethtool_flow_ext { … }; /** * struct ethtool_rx_flow_spec - classification rule for RX flows * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW * @h_u: Flow fields to match (dependent on @flow_type) * @h_ext: Additional fields to match * @m_u: Masks for flow field bits to be matched * @m_ext: Masks for additional field bits to be matched * Note, all additional fields must be ignored unless @flow_type * includes the %FLOW_EXT or %FLOW_MAC_EXT flag * (see &struct ethtool_flow_ext description). * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC * if packets should be discarded, or %RX_CLS_FLOW_WAKE if the * packets should be used for Wake-on-LAN with %WAKE_FILTER * @location: Location of rule in the table. Locations must be * numbered such that a flow matching multiple rules will be * classified according to the first (lowest numbered) rule. */ struct ethtool_rx_flow_spec { … }; /* How rings are laid out when accessing virtual functions or * offloaded queues is device specific. To allow users to do flow * steering and specify these queues the ring cookie is partitioned * into a 32bit queue index with an 8 bit virtual function id. * This also leaves the 3bytes for further specifiers. It is possible * future devices may support more than 256 virtual functions if * devices start supporting PCIe w/ARI. However at the moment I * do not know of any devices that support this so I do not reserve * space for this at this time. If a future patch consumes the next * byte it should be aware of this possibility. */ #define ETHTOOL_RX_FLOW_SPEC_RING … #define ETHTOOL_RX_FLOW_SPEC_RING_VF … #define ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF … static inline __u64 ethtool_get_flow_spec_ring(__u64 ring_cookie) { … } static inline __u64 ethtool_get_flow_spec_ring_vf(__u64 ring_cookie) { … } /** * struct ethtool_rxnfc - command to get or set RX flow classification rules * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH, * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE, * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW * @data: Command-dependent value * @fs: Flow classification rule * @rss_context: RSS context to be affected * @rule_cnt: Number of rules to be affected * @rule_locs: Array of used rule locations * * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following * structure fields must not be used, except that if @flow_type includes * the %FLOW_RSS flag, then @rss_context determines which RSS context to * act on. * * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues * on return. * * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined * rules on return. If @data is non-zero on return then it is the * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the * driver supports any special location values. If that flag is not * set in @data then special location values should not be used. * * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an * existing rule on entry and @fs contains the rule on return; if * @fs.@flow_type includes the %FLOW_RSS flag, then @rss_context is * filled with the RSS context ID associated with the rule. * * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the * user buffer for @rule_locs on entry. On return, @data is the size * of the rule table, @rule_cnt is the number of defined rules, and * @rule_locs contains the locations of the defined rules. Drivers * must use the second parameter to get_rxnfc() instead of @rule_locs. * * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update. * @fs.@location either specifies the location to use or is a special * location value with %RX_CLS_LOC_SPECIAL flag set. On return, * @fs.@location is the actual rule location. If @fs.@flow_type * includes the %FLOW_RSS flag, @rss_context is the RSS context ID to * use for flow spreading traffic which matches this rule. The value * from the rxfh indirection table will be added to @fs.@ring_cookie * to choose which ring to deliver to. * * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an * existing rule on entry. * * A driver supporting the special location values for * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused * location, and may remove a rule at a later location (lower * priority) that matches exactly the same set of flows. The special * values are %RX_CLS_LOC_ANY, selecting any location; * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum * priority); and %RX_CLS_LOC_LAST, selecting the last suitable * location (minimum priority). Additional special values may be * defined in future and drivers must return -%EINVAL for any * unrecognised value. */ struct ethtool_rxnfc { … }; /** * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR * @size: On entry, the array size of the user buffer, which may be zero. * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware * indirection table. * @ring_index: RX ring/queue index for each hash value * * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means * the table should be reset to default values. This last feature * is not supported by the original implementations. */ struct ethtool_rxfh_indir { … }; /** * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key. * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH * @rss_context: RSS context identifier. Context 0 is the default for normal * traffic; other contexts can be referenced as the destination for RX flow * classification rules. %ETH_RXFH_CONTEXT_ALLOC is used with command * %ETHTOOL_SRSSH to allocate a new RSS context; on return this field will * contain the ID of the newly allocated context. * @indir_size: On entry, the array size of the user buffer for the * indirection table, which may be zero, or (for %ETHTOOL_SRSSH), * %ETH_RXFH_INDIR_NO_CHANGE. On return from %ETHTOOL_GRSSH, * the array size of the hardware indirection table. * @key_size: On entry, the array size of the user buffer for the hash key, * which may be zero. On return from %ETHTOOL_GRSSH, the size of the * hardware hash key. * @hfunc: Defines the current RSS hash function used by HW (or to be set to). * Valid values are one of the %ETH_RSS_HASH_*. * @input_xfrm: Defines how the input data is transformed. Valid values are one * of %RXH_XFRM_*. * @rsvd8: Reserved for future use; see the note on reserved space. * @rsvd32: Reserved for future use; see the note on reserved space. * @rss_config: RX ring/queue index for each hash value i.e., indirection table * of @indir_size __u32 elements, followed by hash key of @key_size * bytes. * * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the * size should be returned. For %ETHTOOL_SRSSH, an @indir_size of * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested * and a @indir_size of zero means the indir table should be reset to default * values (if @rss_context == 0) or that the RSS context should be deleted. * An hfunc of zero means that hash function setting is not requested. */ struct ethtool_rxfh { … }; #define ETH_RXFH_CONTEXT_ALLOC … #define ETH_RXFH_INDIR_NO_CHANGE … /** * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW * @h_u: Flow field values to match (dependent on @flow_type) * @m_u: Masks for flow field value bits to be ignored * @vlan_tag: VLAN tag to match * @vlan_tag_mask: Mask for VLAN tag bits to be ignored * @data: Driver-dependent data to match * @data_mask: Mask for driver-dependent data bits to be ignored * @action: RX ring/queue index to deliver to (non-negative) or other action * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP) * * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where * a field value and mask are both zero this is treated as if all mask * bits are set i.e. the field is ignored. */ struct ethtool_rx_ntuple_flow_spec { … }; /** * struct ethtool_rx_ntuple - command to set or clear RX flow filter * @cmd: Command number - %ETHTOOL_SRXNTUPLE * @fs: Flow filter specification */ struct ethtool_rx_ntuple { … }; #define ETHTOOL_FLASH_MAX_FILENAME … enum ethtool_flash_op_type { … }; /* for passing firmware flashing related parameters */ struct ethtool_flash { … }; /** * struct ethtool_dump - used for retrieving, setting device dump * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or * %ETHTOOL_SET_DUMP * @version: FW version of the dump, filled in by driver * @flag: driver dependent flag for dump setting, filled in by driver during * get and filled in by ethtool for set operation. * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when * firmware dump is disabled. * @len: length of dump data, used as the length of the user buffer on entry to * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver * for %ETHTOOL_GET_DUMP_FLAG command * @data: data collected for get dump data operation */ struct ethtool_dump { … }; #define ETH_FW_DUMP_DISABLE … /* for returning and changing feature sets */ /** * struct ethtool_get_features_block - block with state of 32 features * @available: mask of changeable features * @requested: mask of features requested to be enabled if possible * @active: mask of currently enabled features * @never_changed: mask of features not changeable for any device */ struct ethtool_get_features_block { … }; /** * struct ethtool_gfeatures - command to get state of device's features * @cmd: command number = %ETHTOOL_GFEATURES * @size: On entry, the number of elements in the features[] array; * on return, the number of elements in features[] needed to hold * all features * @features: state of features */ struct ethtool_gfeatures { … }; /** * struct ethtool_set_features_block - block with request for 32 features * @valid: mask of features to be changed * @requested: values of features to be changed */ struct ethtool_set_features_block { … }; /** * struct ethtool_sfeatures - command to request change in device's features * @cmd: command number = %ETHTOOL_SFEATURES * @size: array size of the features[] array * @features: feature change masks */ struct ethtool_sfeatures { … }; /** * struct ethtool_ts_info - holds a device's timestamping and PHC association * @cmd: command number = %ETHTOOL_GET_TS_INFO * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags * @phc_index: device index of the associated PHC, or -1 if there is none * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values * @tx_reserved: Reserved for future use; see the note on reserved space. * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values * @rx_reserved: Reserved for future use; see the note on reserved space. * * The bits in the 'tx_types' and 'rx_filters' fields correspond to * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values, * respectively. For example, if the device supports HWTSTAMP_TX_ON, * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set. * * Drivers should only report the filters they actually support without * upscaling in the SIOCSHWTSTAMP ioctl. If the SIOCSHWSTAMP request for * HWTSTAMP_FILTER_V1_SYNC is supported by HWTSTAMP_FILTER_V1_EVENT, then the * driver should only report HWTSTAMP_FILTER_V1_EVENT in this op. */ struct ethtool_ts_info { … }; /* * %ETHTOOL_SFEATURES changes features present in features[].valid to the * values of corresponding bits in features[].requested. Bits in .requested * not set in .valid or not changeable are ignored. * * Returns %EINVAL when .valid contains undefined or never-changeable bits * or size is not equal to required number of features words (32-bit blocks). * Returns >= 0 if request was completed; bits set in the value mean: * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not * changeable (not present in %ETHTOOL_GFEATURES' features[].available) * those bits were ignored. * %ETHTOOL_F_WISH - some or all changes requested were recorded but the * resulting state of bits masked by .valid is not equal to .requested. * Probably there are other device-specific constraints on some features * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered * here as though ignored bits were cleared. * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling * compatibility functions. Requested offload state cannot be properly * managed by kernel. * * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands * for ETH_SS_FEATURES string set. First entry in the table corresponds to least * significant bit in features[0] fields. Empty strings mark undefined features. */ enum ethtool_sfeatures_retval_bits { … }; #define ETHTOOL_F_UNSUPPORTED … #define ETHTOOL_F_WISH … #define ETHTOOL_F_COMPAT … #define MAX_NUM_QUEUE … /** * struct ethtool_per_queue_op - apply sub command to the queues in mask. * @cmd: ETHTOOL_PERQUEUE * @sub_command: the sub command which apply to each queues * @queue_mask: Bitmap of the queues which sub command apply to * @data: A complete command structure following for each of the queues addressed */ struct ethtool_per_queue_op { … }; /** * struct ethtool_fecparam - Ethernet Forward Error Correction parameters * @cmd: Command number = %ETHTOOL_GFECPARAM or %ETHTOOL_SFECPARAM * @active_fec: FEC mode which is active on the port, single bit set, GET only. * @fec: Bitmask of configured FEC modes. * @reserved: Reserved for future extensions, ignore on GET, write 0 for SET. * * Note that @reserved was never validated on input and ethtool user space * left it uninitialized when calling SET. Hence going forward it can only be * used to return a value to userspace with GET. * * FEC modes supported by the device can be read via %ETHTOOL_GLINKSETTINGS. * FEC settings are configured by link autonegotiation whenever it's enabled. * With autoneg on %ETHTOOL_GFECPARAM can be used to read the current mode. * * When autoneg is disabled %ETHTOOL_SFECPARAM controls the FEC settings. * It is recommended that drivers only accept a single bit set in @fec. * When multiple bits are set in @fec drivers may pick mode in an implementation * dependent way. Drivers should reject mixing %ETHTOOL_FEC_AUTO_BIT with other * FEC modes, because it's unclear whether in this case other modes constrain * AUTO or are independent choices. * Drivers must reject SET requests if they support none of the requested modes. * * If device does not support FEC drivers may use %ETHTOOL_FEC_NONE instead * of returning %EOPNOTSUPP from %ETHTOOL_GFECPARAM. * * See enum ethtool_fec_config_bits for definition of valid bits for both * @fec and @active_fec. */ struct ethtool_fecparam { … }; /** * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration * @ETHTOOL_FEC_NONE_BIT: FEC mode configuration is not supported. Should not * be used together with other bits. GET only. * @ETHTOOL_FEC_AUTO_BIT: Select default/best FEC mode automatically, usually * based link mode and SFP parameters read from module's * EEPROM. This bit does _not_ mean autonegotiation. * @ETHTOOL_FEC_OFF_BIT: No FEC Mode * @ETHTOOL_FEC_RS_BIT: Reed-Solomon FEC Mode * @ETHTOOL_FEC_BASER_BIT: Base-R/Reed-Solomon FEC Mode * @ETHTOOL_FEC_LLRS_BIT: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet * Consortium) */ enum ethtool_fec_config_bits { … }; #define ETHTOOL_FEC_NONE … #define ETHTOOL_FEC_AUTO … #define ETHTOOL_FEC_OFF … #define ETHTOOL_FEC_RS … #define ETHTOOL_FEC_BASER … #define ETHTOOL_FEC_LLRS … /* CMDs currently supported */ #define ETHTOOL_GSET … #define ETHTOOL_SSET … #define ETHTOOL_GDRVINFO … #define ETHTOOL_GREGS … #define ETHTOOL_GWOL … #define ETHTOOL_SWOL … #define ETHTOOL_GMSGLVL … #define ETHTOOL_SMSGLVL … #define ETHTOOL_NWAY_RST … /* Get link status for host, i.e. whether the interface *and* the * physical port (if there is one) are up (ethtool_value). */ #define ETHTOOL_GLINK … #define ETHTOOL_GEEPROM … #define ETHTOOL_SEEPROM … #define ETHTOOL_GCOALESCE … #define ETHTOOL_SCOALESCE … #define ETHTOOL_GRINGPARAM … #define ETHTOOL_SRINGPARAM … #define ETHTOOL_GPAUSEPARAM … #define ETHTOOL_SPAUSEPARAM … #define ETHTOOL_GRXCSUM … #define ETHTOOL_SRXCSUM … #define ETHTOOL_GTXCSUM … #define ETHTOOL_STXCSUM … #define ETHTOOL_GSG … #define ETHTOOL_SSG … #define ETHTOOL_TEST … #define ETHTOOL_GSTRINGS … #define ETHTOOL_PHYS_ID … #define ETHTOOL_GSTATS … #define ETHTOOL_GTSO … #define ETHTOOL_STSO … #define ETHTOOL_GPERMADDR … #define ETHTOOL_GUFO … #define ETHTOOL_SUFO … #define ETHTOOL_GGSO … #define ETHTOOL_SGSO … #define ETHTOOL_GFLAGS … #define ETHTOOL_SFLAGS … #define ETHTOOL_GPFLAGS … #define ETHTOOL_SPFLAGS … #define ETHTOOL_GRXFH … #define ETHTOOL_SRXFH … #define ETHTOOL_GGRO … #define ETHTOOL_SGRO … #define ETHTOOL_GRXRINGS … #define ETHTOOL_GRXCLSRLCNT … #define ETHTOOL_GRXCLSRULE … #define ETHTOOL_GRXCLSRLALL … #define ETHTOOL_SRXCLSRLDEL … #define ETHTOOL_SRXCLSRLINS … #define ETHTOOL_FLASHDEV … #define ETHTOOL_RESET … #define ETHTOOL_SRXNTUPLE … #define ETHTOOL_GRXNTUPLE … #define ETHTOOL_GSSET_INFO … #define ETHTOOL_GRXFHINDIR … #define ETHTOOL_SRXFHINDIR … #define ETHTOOL_GFEATURES … #define ETHTOOL_SFEATURES … #define ETHTOOL_GCHANNELS … #define ETHTOOL_SCHANNELS … #define ETHTOOL_SET_DUMP … #define ETHTOOL_GET_DUMP_FLAG … #define ETHTOOL_GET_DUMP_DATA … #define ETHTOOL_GET_TS_INFO … #define ETHTOOL_GMODULEINFO … #define ETHTOOL_GMODULEEEPROM … #define ETHTOOL_GEEE … #define ETHTOOL_SEEE … #define ETHTOOL_GRSSH … #define ETHTOOL_SRSSH … #define ETHTOOL_GTUNABLE … #define ETHTOOL_STUNABLE … #define ETHTOOL_GPHYSTATS … #define ETHTOOL_PERQUEUE … #define ETHTOOL_GLINKSETTINGS … #define ETHTOOL_SLINKSETTINGS … #define ETHTOOL_PHY_GTUNABLE … #define ETHTOOL_PHY_STUNABLE … #define ETHTOOL_GFECPARAM … #define ETHTOOL_SFECPARAM … /* compatibility with older code */ #define SPARC_ETH_GSET … #define SPARC_ETH_SSET … /* Link mode bit indices */ enum ethtool_link_mode_bit_indices { … }; #define __ETHTOOL_LINK_MODE_LEGACY_MASK(base_name) … /* DEPRECATED macros. Please migrate to * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT * define any new SUPPORTED_* macro for bits > 31. */ #define SUPPORTED_10baseT_Half … #define SUPPORTED_10baseT_Full … #define SUPPORTED_100baseT_Half … #define SUPPORTED_100baseT_Full … #define SUPPORTED_1000baseT_Half … #define SUPPORTED_1000baseT_Full … #define SUPPORTED_Autoneg … #define SUPPORTED_TP … #define SUPPORTED_AUI … #define SUPPORTED_MII … #define SUPPORTED_FIBRE … #define SUPPORTED_BNC … #define SUPPORTED_10000baseT_Full … #define SUPPORTED_Pause … #define SUPPORTED_Asym_Pause … #define SUPPORTED_2500baseX_Full … #define SUPPORTED_Backplane … #define SUPPORTED_1000baseKX_Full … #define SUPPORTED_10000baseKX4_Full … #define SUPPORTED_10000baseKR_Full … #define SUPPORTED_10000baseR_FEC … #define SUPPORTED_20000baseMLD2_Full … #define SUPPORTED_20000baseKR2_Full … #define SUPPORTED_40000baseKR4_Full … #define SUPPORTED_40000baseCR4_Full … #define SUPPORTED_40000baseSR4_Full … #define SUPPORTED_40000baseLR4_Full … #define SUPPORTED_56000baseKR4_Full … #define SUPPORTED_56000baseCR4_Full … #define SUPPORTED_56000baseSR4_Full … #define SUPPORTED_56000baseLR4_Full … /* Please do not define any new SUPPORTED_* macro for bits > 31, see * notice above. */ /* * DEPRECATED macros. Please migrate to * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT * define any new ADERTISE_* macro for bits > 31. */ #define ADVERTISED_10baseT_Half … #define ADVERTISED_10baseT_Full … #define ADVERTISED_100baseT_Half … #define ADVERTISED_100baseT_Full … #define ADVERTISED_1000baseT_Half … #define ADVERTISED_1000baseT_Full … #define ADVERTISED_Autoneg … #define ADVERTISED_TP … #define ADVERTISED_AUI … #define ADVERTISED_MII … #define ADVERTISED_FIBRE … #define ADVERTISED_BNC … #define ADVERTISED_10000baseT_Full … #define ADVERTISED_Pause … #define ADVERTISED_Asym_Pause … #define ADVERTISED_2500baseX_Full … #define ADVERTISED_Backplane … #define ADVERTISED_1000baseKX_Full … #define ADVERTISED_10000baseKX4_Full … #define ADVERTISED_10000baseKR_Full … #define ADVERTISED_10000baseR_FEC … #define ADVERTISED_20000baseMLD2_Full … #define ADVERTISED_20000baseKR2_Full … #define ADVERTISED_40000baseKR4_Full … #define ADVERTISED_40000baseCR4_Full … #define ADVERTISED_40000baseSR4_Full … #define ADVERTISED_40000baseLR4_Full … #define ADVERTISED_56000baseKR4_Full … #define ADVERTISED_56000baseCR4_Full … #define ADVERTISED_56000baseSR4_Full … #define ADVERTISED_56000baseLR4_Full … /* Please do not define any new ADVERTISED_* macro for bits > 31, see * notice above. */ /* 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 forced up into this mode or autonegotiated. */ /* The forced speed, in units of 1Mb. All values 0 to INT_MAX are legal. * Update drivers/net/phy/phy.c:phy_speed_to_str() and * drivers/net/bonding/bond_3ad.c:__get_link_speed() when adding new values. */ #define SPEED_10 … #define SPEED_100 … #define SPEED_1000 … #define SPEED_2500 … #define SPEED_5000 … #define SPEED_10000 … #define SPEED_14000 … #define SPEED_20000 … #define SPEED_25000 … #define SPEED_40000 … #define SPEED_50000 … #define SPEED_56000 … #define SPEED_100000 … #define SPEED_200000 … #define SPEED_400000 … #define SPEED_800000 … #define SPEED_UNKNOWN … static inline int ethtool_validate_speed(__u32 speed) { … } /* Duplex, half or full. */ #define DUPLEX_HALF … #define DUPLEX_FULL … #define DUPLEX_UNKNOWN … static inline int ethtool_validate_duplex(__u8 duplex) { … } #define MASTER_SLAVE_CFG_UNSUPPORTED … #define MASTER_SLAVE_CFG_UNKNOWN … #define MASTER_SLAVE_CFG_MASTER_PREFERRED … #define MASTER_SLAVE_CFG_SLAVE_PREFERRED … #define MASTER_SLAVE_CFG_MASTER_FORCE … #define MASTER_SLAVE_CFG_SLAVE_FORCE … #define MASTER_SLAVE_STATE_UNSUPPORTED … #define MASTER_SLAVE_STATE_UNKNOWN … #define MASTER_SLAVE_STATE_MASTER … #define MASTER_SLAVE_STATE_SLAVE … #define MASTER_SLAVE_STATE_ERR … /* These are used to throttle the rate of data on the phy interface when the * native speed of the interface is higher than the link speed. These should * not be used for phy interfaces which natively support multiple speeds (e.g. * MII or SGMII). */ /* No rate matching performed. */ #define RATE_MATCH_NONE … /* The phy sends pause frames to throttle the MAC. */ #define RATE_MATCH_PAUSE … /* The phy asserts CRS to prevent the MAC from transmitting. */ #define RATE_MATCH_CRS … /* The MAC is programmed with a sufficiently-large IPG. */ #define RATE_MATCH_OPEN_LOOP … /* Which connector port. */ #define PORT_TP … #define PORT_AUI … #define PORT_MII … #define PORT_FIBRE … #define PORT_BNC … #define PORT_DA … #define PORT_NONE … #define PORT_OTHER … /* Which transceiver to use. */ #define XCVR_INTERNAL … #define XCVR_EXTERNAL … #define XCVR_DUMMY1 … #define XCVR_DUMMY2 … #define XCVR_DUMMY3 … /* Enable or disable autonegotiation. */ #define AUTONEG_DISABLE … #define AUTONEG_ENABLE … /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then * the driver is required to renegotiate link */ #define ETH_TP_MDI_INVALID … #define ETH_TP_MDI … #define ETH_TP_MDI_X … #define ETH_TP_MDI_AUTO … /* Wake-On-Lan options. */ #define WAKE_PHY … #define WAKE_UCAST … #define WAKE_MCAST … #define WAKE_BCAST … #define WAKE_ARP … #define WAKE_MAGIC … #define WAKE_MAGICSECURE … #define WAKE_FILTER … #define WOL_MODE_COUNT … /* RSS hash function data * XOR the corresponding source and destination fields of each specified * protocol. Both copies of the XOR'ed fields are fed into the RSS and RXHASH * calculation. Note that this XORing reduces the input set entropy and could * be exploited to reduce the RSS queue spread. */ #define RXH_XFRM_SYM_XOR … #define RXH_XFRM_NO_CHANGE … /* L2-L4 network traffic flow types */ #define TCP_V4_FLOW … #define UDP_V4_FLOW … #define SCTP_V4_FLOW … #define AH_ESP_V4_FLOW … #define TCP_V6_FLOW … #define UDP_V6_FLOW … #define SCTP_V6_FLOW … #define AH_ESP_V6_FLOW … #define AH_V4_FLOW … #define ESP_V4_FLOW … #define AH_V6_FLOW … #define ESP_V6_FLOW … #define IPV4_USER_FLOW … #define IP_USER_FLOW … #define IPV6_USER_FLOW … #define IPV4_FLOW … #define IPV6_FLOW … #define ETHER_FLOW … /* Used for GTP-U IPv4 and IPv6. * The format of GTP packets only includes * elements such as TEID and GTP version. * It is primarily intended for data communication of the UE. */ #define GTPU_V4_FLOW … #define GTPU_V6_FLOW … /* Use for GTP-C IPv4 and v6. * The format of these GTP packets does not include TEID. * Primarily expected to be used for communication * to create sessions for UE data communication, * commonly referred to as CSR (Create Session Request). */ #define GTPC_V4_FLOW … #define GTPC_V6_FLOW … /* Use for GTP-C IPv4 and v6. * Unlike GTPC_V4_FLOW, the format of these GTP packets includes TEID. * After session creation, it becomes this packet. * This is mainly used for requests to realize UE handover. */ #define GTPC_TEID_V4_FLOW … #define GTPC_TEID_V6_FLOW … /* Use for GTP-U and extended headers for the PSC (PDU Session Container). * The format of these GTP packets includes TEID and QFI. * In 5G communication using UPF (User Plane Function), * data communication with this extended header is performed. */ #define GTPU_EH_V4_FLOW … #define GTPU_EH_V6_FLOW … /* Use for GTP-U IPv4 and v6 PSC (PDU Session Container) extended headers. * This differs from GTPU_EH_V(4|6)_FLOW in that it is distinguished by * UL/DL included in the PSC. * There are differences in the data included based on Downlink/Uplink, * and can be used to distinguish packets. * The functions described so far are useful when you want to * handle communication from the mobile network in UPF, PGW, etc. */ #define GTPU_UL_V4_FLOW … #define GTPU_UL_V6_FLOW … #define GTPU_DL_V4_FLOW … #define GTPU_DL_V6_FLOW … /* Flag to enable additional fields in struct ethtool_rx_flow_spec */ #define FLOW_EXT … #define FLOW_MAC_EXT … /* Flag to enable RSS spreading of traffic matching rule (nfc only) */ #define FLOW_RSS … /* L3-L4 network traffic flow hash options */ #define RXH_L2DA … #define RXH_VLAN … #define RXH_L3_PROTO … #define RXH_IP_SRC … #define RXH_IP_DST … #define RXH_L4_B_0_1 … #define RXH_L4_B_2_3 … #define RXH_GTP_TEID … #define RXH_DISCARD … #define RX_CLS_FLOW_DISC … #define RX_CLS_FLOW_WAKE … /* Special RX classification rule insert location values */ #define RX_CLS_LOC_SPECIAL … #define RX_CLS_LOC_ANY … #define RX_CLS_LOC_FIRST … #define RX_CLS_LOC_LAST … /* EEPROM Standards for plug in modules */ #define ETH_MODULE_SFF_8079 … #define ETH_MODULE_SFF_8079_LEN … #define ETH_MODULE_SFF_8472 … #define ETH_MODULE_SFF_8472_LEN … #define ETH_MODULE_SFF_8636 … #define ETH_MODULE_SFF_8636_LEN … #define ETH_MODULE_SFF_8436 … #define ETH_MODULE_SFF_8436_LEN … #define ETH_MODULE_SFF_8636_MAX_LEN … #define ETH_MODULE_SFF_8436_MAX_LEN … /* Reset flags */ /* The reset() operation must clear the flags for the components which * were actually reset. On successful return, the flags indicate the * components which were not reset, either because they do not exist * in the hardware or because they cannot be reset independently. The * driver must never reset any components that were not requested. */ enum ethtool_reset_flags { … }; #define ETH_RESET_SHARED_SHIFT … /** * struct ethtool_link_settings - link control and status * * IMPORTANT, Backward compatibility notice: When implementing new * user-space tools, please first try %ETHTOOL_GLINKSETTINGS, and * if it succeeds use %ETHTOOL_SLINKSETTINGS to change link * settings; do not use %ETHTOOL_SSET if %ETHTOOL_GLINKSETTINGS * succeeded: stick to %ETHTOOL_GLINKSETTINGS/%SLINKSETTINGS in * that case. Conversely, if %ETHTOOL_GLINKSETTINGS fails, use * %ETHTOOL_GSET to query and %ETHTOOL_SSET to change link * settings; do not use %ETHTOOL_SLINKSETTINGS if * %ETHTOOL_GLINKSETTINGS failed: stick to * %ETHTOOL_GSET/%ETHTOOL_SSET in that case. * * @cmd: Command number = %ETHTOOL_GLINKSETTINGS or %ETHTOOL_SLINKSETTINGS * @speed: Link speed (Mbps) * @duplex: Duplex mode; one of %DUPLEX_* * @port: Physical connector type; one of %PORT_* * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not * applicable. For clause 45 PHYs this is the PRTAD. * @autoneg: Enable/disable autonegotiation and auto-detection; * either %AUTONEG_DISABLE or %AUTONEG_ENABLE * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO * protocols supported by the interface; 0 if unknown. * Read-only. * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of * %ETH_TP_MDI_*. If the status is unknown or not applicable, the * value will be %ETH_TP_MDI_INVALID. Read-only. * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected. * When written successfully, the link should be renegotiated if * necessary. * @link_mode_masks_nwords: Number of 32-bit words for each of the * supported, advertising, lp_advertising link mode bitmaps. For * %ETHTOOL_GLINKSETTINGS: on entry, number of words passed by user * (>= 0); on return, if handshake in progress, negative if * request size unsupported by kernel: absolute value indicates * kernel expected size and all the other fields but cmd * are 0; otherwise (handshake completed), strictly positive * to indicate size used by kernel and cmd field stays * %ETHTOOL_GLINKSETTINGS, all other fields populated by driver. For * %ETHTOOL_SLINKSETTINGS: must be valid on entry, ie. a positive * value returned previously by %ETHTOOL_GLINKSETTINGS, otherwise * refused. For drivers: ignore this field (use kernel's * __ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will * be overwritten by kernel. * @transceiver: Used to distinguish different possible PHY types, * reported consistently by PHYLIB. Read-only. * @master_slave_cfg: Master/slave port mode. * @master_slave_state: Master/slave port state. * @rate_matching: Rate adaptation performed by the PHY * @reserved: Reserved for future use; see the note on reserved space. * @link_mode_masks: Variable length bitmaps. * * If autonegotiation is disabled, the speed and @duplex represent the * fixed link mode and are writable if the driver supports multiple * link modes. If it is enabled then they are read-only; if the link * is up they represent the negotiated link mode; if the link is down, * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode. * * Some hardware interfaces may have multiple PHYs and/or physical * connectors fitted or do not allow the driver to detect which are * fitted. For these interfaces @port and/or @phy_address may be * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE. * Otherwise, attempts to write different values may be ignored or * rejected. * * Deprecated %ethtool_cmd fields transceiver, maxtxpkt and maxrxpkt * are not available in %ethtool_link_settings. These fields will be * always set to zero in %ETHTOOL_GSET reply and %ETHTOOL_SSET will * fail if any of them is set to non-zero value. * * Users should assume that all fields not marked read-only are * writable and subject to validation by the driver. They should use * %ETHTOOL_GLINKSETTINGS to get the current values before making specific * changes and then applying them with %ETHTOOL_SLINKSETTINGS. * * Drivers that implement %get_link_ksettings and/or * %set_link_ksettings should ignore the @cmd * and @link_mode_masks_nwords fields (any change to them overwritten * by kernel), and rely only on kernel's internal * %__ETHTOOL_LINK_MODE_MASK_NBITS and * %ethtool_link_mode_mask_t. Drivers that implement * %set_link_ksettings() should validate all fields other than @cmd * and @link_mode_masks_nwords that are not described as read-only or * deprecated, and must ignore all fields described as read-only. * * @link_mode_masks is divided into three bitfields, each of length * @link_mode_masks_nwords: * - supported: Bitmap with each bit meaning given by * %ethtool_link_mode_bit_indices for the link modes, physical * connectors and other link features for which the interface * supports autonegotiation or auto-detection. Read-only. * - advertising: Bitmap with each bit meaning given by * %ethtool_link_mode_bit_indices for the link modes, physical * connectors and other link features that are advertised through * autonegotiation or enabled for auto-detection. * - lp_advertising: Bitmap with each bit meaning given by * %ethtool_link_mode_bit_indices for the link modes, and other * link features that the link partner advertised through * autonegotiation; 0 if unknown or not applicable. Read-only. */ struct ethtool_link_settings { … }; /** * enum phy_upstream - Represents the upstream component a given PHY device * is connected to, as in what is on the other end of the MII bus. Most PHYs * will be attached to an Ethernet MAC controller, but in some cases, there's * an intermediate PHY used as a media-converter, which will driver another * MII interface as its output. * @PHY_UPSTREAM_MAC: Upstream component is a MAC (a switch port, * or ethernet controller) * @PHY_UPSTREAM_PHY: Upstream component is a PHY (likely a media converter) */ enum phy_upstream { … }; #endif /* _UAPI_LINUX_ETHTOOL_H */
Codebase Browser
linux