Commit | Line | Data |
---|---|---|
607ca46e DH |
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 | * Portions Copyright (C) Sun Microsystems 2008 | |
11 | */ | |
12 | ||
13 | #ifndef _UAPI_LINUX_ETHTOOL_H | |
14 | #define _UAPI_LINUX_ETHTOOL_H | |
15 | ||
16 | #include <linux/types.h> | |
17 | #include <linux/if_ether.h> | |
18 | ||
bf8fc60a BH |
19 | /* All structures exposed to userland should be defined such that they |
20 | * have the same layout for 32-bit and 64-bit userland. | |
21 | */ | |
22 | ||
23 | /** | |
24 | * struct ethtool_cmd - link control and status | |
25 | * @cmd: Command number = %ETHTOOL_GSET or %ETHTOOL_SSET | |
26 | * @supported: Bitmask of %SUPPORTED_* flags for the link modes, | |
27 | * physical connectors and other link features for which the | |
28 | * interface supports autonegotiation or auto-detection. | |
29 | * Read-only. | |
30 | * @advertising: Bitmask of %ADVERTISED_* flags for the link modes, | |
31 | * physical connectors and other link features that are | |
32 | * advertised through autonegotiation or enabled for | |
33 | * auto-detection. | |
34 | * @speed: Low bits of the speed | |
35 | * @duplex: Duplex mode; one of %DUPLEX_* | |
36 | * @port: Physical connector type; one of %PORT_* | |
37 | * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not | |
38 | * applicable. For clause 45 PHYs this is the PRTAD. | |
39 | * @transceiver: Historically used to distinguish different possible | |
40 | * PHY types, but not in a consistent way. Deprecated. | |
41 | * @autoneg: Enable/disable autonegotiation and auto-detection; | |
42 | * either %AUTONEG_DISABLE or %AUTONEG_ENABLE | |
43 | * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO | |
44 | * protocols supported by the interface; 0 if unknown. | |
45 | * Read-only. | |
46 | * @maxtxpkt: Historically used to report TX IRQ coalescing; now | |
47 | * obsoleted by &struct ethtool_coalesce. Read-only; deprecated. | |
48 | * @maxrxpkt: Historically used to report RX IRQ coalescing; now | |
49 | * obsoleted by &struct ethtool_coalesce. Read-only; deprecated. | |
50 | * @speed_hi: High bits of the speed | |
51 | * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of | |
52 | * %ETH_TP_MDI_*. If the status is unknown or not applicable, the | |
53 | * value will be %ETH_TP_MDI_INVALID. Read-only. | |
54 | * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of | |
55 | * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads | |
56 | * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected. | |
57 | * When written successfully, the link should be renegotiated if | |
58 | * necessary. | |
59 | * @lp_advertising: Bitmask of %ADVERTISED_* flags for the link modes | |
60 | * and other link features that the link partner advertised | |
61 | * through autonegotiation; 0 if unknown or not applicable. | |
62 | * Read-only. | |
63 | * | |
64 | * The link speed in Mbps is split between @speed and @speed_hi. Use | |
65 | * the ethtool_cmd_speed() and ethtool_cmd_speed_set() functions to | |
66 | * access it. | |
67 | * | |
68 | * If autonegotiation is disabled, the speed and @duplex represent the | |
69 | * fixed link mode and are writable if the driver supports multiple | |
70 | * link modes. If it is enabled then they are read-only; if the link | |
71 | * is up they represent the negotiated link mode; if the link is down, | |
72 | * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and | |
73 | * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode. | |
74 | * | |
75 | * Some hardware interfaces may have multiple PHYs and/or physical | |
76 | * connectors fitted or do not allow the driver to detect which are | |
77 | * fitted. For these interfaces @port and/or @phy_address may be | |
78 | * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE. | |
79 | * Otherwise, attempts to write different values may be ignored or | |
80 | * rejected. | |
81 | * | |
82 | * Users should assume that all fields not marked read-only are | |
83 | * writable and subject to validation by the driver. They should use | |
84 | * %ETHTOOL_GSET to get the current values before making specific | |
85 | * changes and then applying them with %ETHTOOL_SSET. | |
86 | * | |
87 | * Drivers that implement set_settings() should validate all fields | |
88 | * other than @cmd that are not described as read-only or deprecated, | |
89 | * and must ignore all fields described as read-only. | |
90 | * | |
91 | * Deprecated fields should be ignored by both users and drivers. | |
92 | */ | |
607ca46e DH |
93 | struct ethtool_cmd { |
94 | __u32 cmd; | |
bf8fc60a BH |
95 | __u32 supported; |
96 | __u32 advertising; | |
97 | __u16 speed; | |
98 | __u8 duplex; | |
99 | __u8 port; | |
100 | __u8 phy_address; | |
101 | __u8 transceiver; | |
102 | __u8 autoneg; | |
103 | __u8 mdio_support; | |
104 | __u32 maxtxpkt; | |
105 | __u32 maxrxpkt; | |
106 | __u16 speed_hi; | |
107 | __u8 eth_tp_mdix; | |
108 | __u8 eth_tp_mdix_ctrl; | |
109 | __u32 lp_advertising; | |
607ca46e DH |
110 | __u32 reserved[2]; |
111 | }; | |
112 | ||
113 | static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep, | |
114 | __u32 speed) | |
115 | { | |
116 | ||
117 | ep->speed = (__u16)speed; | |
118 | ep->speed_hi = (__u16)(speed >> 16); | |
119 | } | |
120 | ||
121 | static inline __u32 ethtool_cmd_speed(const struct ethtool_cmd *ep) | |
122 | { | |
123 | return (ep->speed_hi << 16) | ep->speed; | |
124 | } | |
125 | ||
126 | /* Device supports clause 22 register access to PHY or peripherals | |
127 | * using the interface defined in <linux/mii.h>. This should not be | |
128 | * set if there are known to be no such peripherals present or if | |
129 | * the driver only emulates clause 22 registers for compatibility. | |
130 | */ | |
131 | #define ETH_MDIO_SUPPORTS_C22 1 | |
132 | ||
133 | /* Device supports clause 45 register access to PHY or peripherals | |
134 | * using the interface defined in <linux/mii.h> and <linux/mdio.h>. | |
135 | * This should not be set if there are known to be no such peripherals | |
136 | * present. | |
137 | */ | |
138 | #define ETH_MDIO_SUPPORTS_C45 2 | |
139 | ||
140 | #define ETHTOOL_FWVERS_LEN 32 | |
141 | #define ETHTOOL_BUSINFO_LEN 32 | |
daba1b6b BH |
142 | |
143 | /** | |
144 | * struct ethtool_drvinfo - general driver and device information | |
145 | * @cmd: Command number = %ETHTOOL_GDRVINFO | |
146 | * @driver: Driver short name. This should normally match the name | |
147 | * in its bus driver structure (e.g. pci_driver::name). Must | |
148 | * not be an empty string. | |
149 | * @version: Driver version string; may be an empty string | |
150 | * @fw_version: Firmware version string; may be an empty string | |
151 | * @bus_info: Device bus address. This should match the dev_name() | |
152 | * string for the underlying bus device, if there is one. May be | |
153 | * an empty string. | |
154 | * @n_priv_flags: Number of flags valid for %ETHTOOL_GPFLAGS and | |
155 | * %ETHTOOL_SPFLAGS commands; also the number of strings in the | |
156 | * %ETH_SS_PRIV_FLAGS set | |
157 | * @n_stats: Number of u64 statistics returned by the %ETHTOOL_GSTATS | |
158 | * command; also the number of strings in the %ETH_SS_STATS set | |
159 | * @testinfo_len: Number of results returned by the %ETHTOOL_TEST | |
160 | * command; also the number of strings in the %ETH_SS_TEST set | |
161 | * @eedump_len: Size of EEPROM accessible through the %ETHTOOL_GEEPROM | |
162 | * and %ETHTOOL_SEEPROM commands, in bytes | |
163 | * @regdump_len: Size of register dump returned by the %ETHTOOL_GREGS | |
164 | * command, in bytes | |
165 | * | |
166 | * Users can use the %ETHTOOL_GSSET_INFO command to get the number of | |
167 | * strings in any string set (from Linux 2.6.34). | |
168 | * | |
169 | * Drivers should set at most @driver, @version, @fw_version and | |
170 | * @bus_info in their get_drvinfo() implementation. The ethtool | |
171 | * core fills in the other fields using other driver operations. | |
172 | */ | |
607ca46e DH |
173 | struct ethtool_drvinfo { |
174 | __u32 cmd; | |
daba1b6b BH |
175 | char driver[32]; |
176 | char version[32]; | |
177 | char fw_version[ETHTOOL_FWVERS_LEN]; | |
178 | char bus_info[ETHTOOL_BUSINFO_LEN]; | |
607ca46e DH |
179 | char reserved1[32]; |
180 | char reserved2[12]; | |
daba1b6b BH |
181 | __u32 n_priv_flags; |
182 | __u32 n_stats; | |
607ca46e | 183 | __u32 testinfo_len; |
daba1b6b BH |
184 | __u32 eedump_len; |
185 | __u32 regdump_len; | |
607ca46e DH |
186 | }; |
187 | ||
188 | #define SOPASS_MAX 6 | |
02d59f3f BH |
189 | |
190 | /** | |
191 | * struct ethtool_wolinfo - Wake-On-Lan configuration | |
192 | * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL | |
193 | * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes. | |
194 | * Read-only. | |
195 | * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes. | |
196 | * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE | |
197 | * is set in @wolopts. | |
198 | */ | |
607ca46e DH |
199 | struct ethtool_wolinfo { |
200 | __u32 cmd; | |
201 | __u32 supported; | |
202 | __u32 wolopts; | |
02d59f3f | 203 | __u8 sopass[SOPASS_MAX]; |
607ca46e DH |
204 | }; |
205 | ||
206 | /* for passing single values */ | |
207 | struct ethtool_value { | |
208 | __u32 cmd; | |
209 | __u32 data; | |
210 | }; | |
211 | ||
09fb8bb0 BH |
212 | /** |
213 | * struct ethtool_regs - hardware register dump | |
214 | * @cmd: Command number = %ETHTOOL_GREGS | |
215 | * @version: Dump format version. This is driver-specific and may | |
216 | * distinguish different chips/revisions. Drivers must use new | |
217 | * version numbers whenever the dump format changes in an | |
218 | * incompatible way. | |
219 | * @len: On entry, the real length of @data. On return, the number of | |
220 | * bytes used. | |
221 | * @data: Buffer for the register dump | |
222 | * | |
223 | * Users should use %ETHTOOL_GDRVINFO to find the maximum length of | |
224 | * a register dump for the interface. They must allocate the buffer | |
225 | * immediately following this structure. | |
226 | */ | |
607ca46e DH |
227 | struct ethtool_regs { |
228 | __u32 cmd; | |
09fb8bb0 BH |
229 | __u32 version; |
230 | __u32 len; | |
607ca46e DH |
231 | __u8 data[0]; |
232 | }; | |
233 | ||
c8364a63 BH |
234 | /** |
235 | * struct ethtool_eeprom - EEPROM dump | |
236 | * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or | |
237 | * %ETHTOOL_SEEPROM | |
238 | * @magic: A 'magic cookie' value to guard against accidental changes. | |
239 | * The value passed in to %ETHTOOL_SEEPROM must match the value | |
240 | * returned by %ETHTOOL_GEEPROM for the same device. This is | |
241 | * unused when @cmd is %ETHTOOL_GMODULEEEPROM. | |
242 | * @offset: Offset within the EEPROM to begin reading/writing, in bytes | |
243 | * @len: On entry, number of bytes to read/write. On successful | |
244 | * return, number of bytes actually read/written. In case of | |
245 | * error, this may indicate at what point the error occurred. | |
246 | * @data: Buffer to read/write from | |
247 | * | |
248 | * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find | |
249 | * the length of an on-board or module EEPROM, respectively. They | |
250 | * must allocate the buffer immediately following this structure. | |
251 | */ | |
607ca46e DH |
252 | struct ethtool_eeprom { |
253 | __u32 cmd; | |
254 | __u32 magic; | |
c8364a63 BH |
255 | __u32 offset; |
256 | __u32 len; | |
607ca46e DH |
257 | __u8 data[0]; |
258 | }; | |
259 | ||
260 | /** | |
261 | * struct ethtool_eee - Energy Efficient Ethernet information | |
262 | * @cmd: ETHTOOL_{G,S}EEE | |
263 | * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations | |
264 | * for which there is EEE support. | |
265 | * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations | |
266 | * advertised as eee capable. | |
267 | * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex | |
268 | * combinations advertised by the link partner as eee capable. | |
269 | * @eee_active: Result of the eee auto negotiation. | |
270 | * @eee_enabled: EEE configured mode (enabled/disabled). | |
271 | * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given | |
272 | * that eee was negotiated. | |
273 | * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting | |
274 | * its tx lpi (after reaching 'idle' state). Effective only when eee | |
275 | * was negotiated and tx_lpi_enabled was set. | |
276 | */ | |
277 | struct ethtool_eee { | |
278 | __u32 cmd; | |
279 | __u32 supported; | |
280 | __u32 advertised; | |
281 | __u32 lp_advertised; | |
282 | __u32 eee_active; | |
283 | __u32 eee_enabled; | |
284 | __u32 tx_lpi_enabled; | |
285 | __u32 tx_lpi_timer; | |
286 | __u32 reserved[2]; | |
287 | }; | |
288 | ||
289 | /** | |
290 | * struct ethtool_modinfo - plugin module eeprom information | |
291 | * @cmd: %ETHTOOL_GMODULEINFO | |
292 | * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx | |
293 | * @eeprom_len: Length of the eeprom | |
294 | * | |
295 | * This structure is used to return the information to | |
296 | * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM. | |
297 | * The type code indicates the eeprom data format | |
298 | */ | |
299 | struct ethtool_modinfo { | |
300 | __u32 cmd; | |
301 | __u32 type; | |
302 | __u32 eeprom_len; | |
303 | __u32 reserved[8]; | |
304 | }; | |
305 | ||
306 | /** | |
307 | * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates | |
308 | * @cmd: ETHTOOL_{G,S}COALESCE | |
309 | * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after | |
310 | * a packet arrives. | |
311 | * @rx_max_coalesced_frames: Maximum number of packets to receive | |
312 | * before an RX interrupt. | |
313 | * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that | |
314 | * this value applies while an IRQ is being serviced by the host. | |
315 | * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames, | |
316 | * except that this value applies while an IRQ is being serviced | |
317 | * by the host. | |
318 | * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after | |
319 | * a packet is sent. | |
320 | * @tx_max_coalesced_frames: Maximum number of packets to be sent | |
321 | * before a TX interrupt. | |
322 | * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that | |
323 | * this value applies while an IRQ is being serviced by the host. | |
324 | * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames, | |
325 | * except that this value applies while an IRQ is being serviced | |
326 | * by the host. | |
327 | * @stats_block_coalesce_usecs: How many usecs to delay in-memory | |
328 | * statistics block updates. Some drivers do not have an | |
329 | * in-memory statistic block, and in such cases this value is | |
330 | * ignored. This value must not be zero. | |
331 | * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing. | |
332 | * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing. | |
333 | * @pkt_rate_low: Threshold for low packet rate (packets per second). | |
334 | * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after | |
335 | * a packet arrives, when the packet rate is below @pkt_rate_low. | |
336 | * @rx_max_coalesced_frames_low: Maximum number of packets to be received | |
337 | * before an RX interrupt, when the packet rate is below @pkt_rate_low. | |
338 | * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after | |
339 | * a packet is sent, when the packet rate is below @pkt_rate_low. | |
340 | * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before | |
341 | * a TX interrupt, when the packet rate is below @pkt_rate_low. | |
342 | * @pkt_rate_high: Threshold for high packet rate (packets per second). | |
343 | * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after | |
344 | * a packet arrives, when the packet rate is above @pkt_rate_high. | |
345 | * @rx_max_coalesced_frames_high: Maximum number of packets to be received | |
346 | * before an RX interrupt, when the packet rate is above @pkt_rate_high. | |
347 | * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after | |
348 | * a packet is sent, when the packet rate is above @pkt_rate_high. | |
349 | * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before | |
350 | * a TX interrupt, when the packet rate is above @pkt_rate_high. | |
351 | * @rate_sample_interval: How often to do adaptive coalescing packet rate | |
352 | * sampling, measured in seconds. Must not be zero. | |
353 | * | |
354 | * Each pair of (usecs, max_frames) fields specifies this exit | |
355 | * condition for interrupt coalescing: | |
356 | * (usecs > 0 && time_since_first_completion >= usecs) || | |
357 | * (max_frames > 0 && completed_frames >= max_frames) | |
358 | * It is illegal to set both usecs and max_frames to zero as this | |
359 | * would cause interrupts to never be generated. To disable | |
360 | * coalescing, set usecs = 0 and max_frames = 1. | |
361 | * | |
362 | * Some implementations ignore the value of max_frames and use the | |
363 | * condition: | |
364 | * time_since_first_completion >= usecs | |
365 | * This is deprecated. Drivers for hardware that does not support | |
366 | * counting completions should validate that max_frames == !rx_usecs. | |
367 | * | |
368 | * Adaptive RX/TX coalescing is an algorithm implemented by some | |
369 | * drivers to improve latency under low packet rates and improve | |
370 | * throughput under high packet rates. Some drivers only implement | |
371 | * one of RX or TX adaptive coalescing. Anything not implemented by | |
372 | * the driver causes these values to be silently ignored. | |
373 | * | |
374 | * When the packet rate is below @pkt_rate_high but above | |
375 | * @pkt_rate_low (both measured in packets per second) the | |
376 | * normal {rx,tx}_* coalescing parameters are used. | |
377 | */ | |
378 | struct ethtool_coalesce { | |
379 | __u32 cmd; | |
380 | __u32 rx_coalesce_usecs; | |
381 | __u32 rx_max_coalesced_frames; | |
382 | __u32 rx_coalesce_usecs_irq; | |
383 | __u32 rx_max_coalesced_frames_irq; | |
384 | __u32 tx_coalesce_usecs; | |
385 | __u32 tx_max_coalesced_frames; | |
386 | __u32 tx_coalesce_usecs_irq; | |
387 | __u32 tx_max_coalesced_frames_irq; | |
388 | __u32 stats_block_coalesce_usecs; | |
389 | __u32 use_adaptive_rx_coalesce; | |
390 | __u32 use_adaptive_tx_coalesce; | |
391 | __u32 pkt_rate_low; | |
392 | __u32 rx_coalesce_usecs_low; | |
393 | __u32 rx_max_coalesced_frames_low; | |
394 | __u32 tx_coalesce_usecs_low; | |
395 | __u32 tx_max_coalesced_frames_low; | |
396 | __u32 pkt_rate_high; | |
397 | __u32 rx_coalesce_usecs_high; | |
398 | __u32 rx_max_coalesced_frames_high; | |
399 | __u32 tx_coalesce_usecs_high; | |
400 | __u32 tx_max_coalesced_frames_high; | |
401 | __u32 rate_sample_interval; | |
402 | }; | |
403 | ||
af440a8a BH |
404 | /** |
405 | * struct ethtool_ringparam - RX/TX ring parameters | |
406 | * @cmd: Command number = %ETHTOOL_GRINGPARAM or %ETHTOOL_SRINGPARAM | |
407 | * @rx_max_pending: Maximum supported number of pending entries per | |
408 | * RX ring. Read-only. | |
409 | * @rx_mini_max_pending: Maximum supported number of pending entries | |
410 | * per RX mini ring. Read-only. | |
411 | * @rx_jumbo_max_pending: Maximum supported number of pending entries | |
412 | * per RX jumbo ring. Read-only. | |
413 | * @tx_max_pending: Maximum supported number of pending entries per | |
414 | * TX ring. Read-only. | |
415 | * @rx_pending: Current maximum number of pending entries per RX ring | |
416 | * @rx_mini_pending: Current maximum number of pending entries per RX | |
417 | * mini ring | |
418 | * @rx_jumbo_pending: Current maximum number of pending entries per RX | |
419 | * jumbo ring | |
420 | * @tx_pending: Current maximum supported number of pending entries | |
421 | * per TX ring | |
422 | * | |
423 | * If the interface does not have separate RX mini and/or jumbo rings, | |
424 | * @rx_mini_max_pending and/or @rx_jumbo_max_pending will be 0. | |
425 | * | |
426 | * There may also be driver-dependent minimum values for the number | |
427 | * of entries per ring. | |
428 | */ | |
607ca46e | 429 | struct ethtool_ringparam { |
af440a8a | 430 | __u32 cmd; |
607ca46e DH |
431 | __u32 rx_max_pending; |
432 | __u32 rx_mini_max_pending; | |
433 | __u32 rx_jumbo_max_pending; | |
434 | __u32 tx_max_pending; | |
607ca46e DH |
435 | __u32 rx_pending; |
436 | __u32 rx_mini_pending; | |
437 | __u32 rx_jumbo_pending; | |
438 | __u32 tx_pending; | |
439 | }; | |
440 | ||
441 | /** | |
442 | * struct ethtool_channels - configuring number of network channel | |
443 | * @cmd: ETHTOOL_{G,S}CHANNELS | |
444 | * @max_rx: Read only. Maximum number of receive channel the driver support. | |
445 | * @max_tx: Read only. Maximum number of transmit channel the driver support. | |
446 | * @max_other: Read only. Maximum number of other channel the driver support. | |
447 | * @max_combined: Read only. Maximum number of combined channel the driver | |
448 | * support. Set of queues RX, TX or other. | |
449 | * @rx_count: Valid values are in the range 1 to the max_rx. | |
450 | * @tx_count: Valid values are in the range 1 to the max_tx. | |
451 | * @other_count: Valid values are in the range 1 to the max_other. | |
452 | * @combined_count: Valid values are in the range 1 to the max_combined. | |
453 | * | |
454 | * This can be used to configure RX, TX and other channels. | |
455 | */ | |
456 | ||
457 | struct ethtool_channels { | |
458 | __u32 cmd; | |
459 | __u32 max_rx; | |
460 | __u32 max_tx; | |
461 | __u32 max_other; | |
462 | __u32 max_combined; | |
463 | __u32 rx_count; | |
464 | __u32 tx_count; | |
465 | __u32 other_count; | |
466 | __u32 combined_count; | |
467 | }; | |
468 | ||
6a7a1081 BH |
469 | /** |
470 | * struct ethtool_pauseparam - Ethernet pause (flow control) parameters | |
471 | * @cmd: Command number = %ETHTOOL_GPAUSEPARAM or %ETHTOOL_SPAUSEPARAM | |
472 | * @autoneg: Flag to enable autonegotiation of pause frame use | |
473 | * @rx_pause: Flag to enable reception of pause frames | |
474 | * @tx_pause: Flag to enable transmission of pause frames | |
475 | * | |
476 | * Drivers should reject a non-zero setting of @autoneg when | |
477 | * autoneogotiation is disabled (or not supported) for the link. | |
478 | * | |
479 | * If the link is autonegotiated, drivers should use | |
480 | * mii_advertise_flowctrl() or similar code to set the advertised | |
481 | * pause frame capabilities based on the @rx_pause and @tx_pause flags, | |
482 | * even if @autoneg is zero. They should also allow the advertised | |
483 | * pause frame capabilities to be controlled directly through the | |
484 | * advertising field of &struct ethtool_cmd. | |
485 | * | |
486 | * If @autoneg is non-zero, the MAC is configured to send and/or | |
487 | * receive pause frames according to the result of autonegotiation. | |
488 | * Otherwise, it is configured directly based on the @rx_pause and | |
489 | * @tx_pause flags. | |
490 | */ | |
607ca46e | 491 | struct ethtool_pauseparam { |
6a7a1081 | 492 | __u32 cmd; |
607ca46e DH |
493 | __u32 autoneg; |
494 | __u32 rx_pause; | |
495 | __u32 tx_pause; | |
496 | }; | |
497 | ||
498 | #define ETH_GSTRING_LEN 32 | |
fe5df1b9 BH |
499 | |
500 | /** | |
501 | * enum ethtool_stringset - string set ID | |
502 | * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST | |
503 | * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS | |
504 | * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with | |
505 | * %ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS | |
506 | * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE; | |
507 | * now deprecated | |
508 | * @ETH_SS_FEATURES: Device feature names | |
509 | */ | |
607ca46e DH |
510 | enum ethtool_stringset { |
511 | ETH_SS_TEST = 0, | |
512 | ETH_SS_STATS, | |
513 | ETH_SS_PRIV_FLAGS, | |
fe5df1b9 | 514 | ETH_SS_NTUPLE_FILTERS, |
607ca46e DH |
515 | ETH_SS_FEATURES, |
516 | }; | |
517 | ||
fe5df1b9 BH |
518 | /** |
519 | * struct ethtool_gstrings - string set for data tagging | |
520 | * @cmd: Command number = %ETHTOOL_GSTRINGS | |
521 | * @string_set: String set ID; one of &enum ethtool_stringset | |
522 | * @len: On return, the number of strings in the string set | |
523 | * @data: Buffer for strings. Each string is null-padded to a size of | |
524 | * %ETH_GSTRING_LEN. | |
525 | * | |
526 | * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in | |
527 | * the string set. They must allocate a buffer of the appropriate | |
528 | * size immediately following this structure. | |
529 | */ | |
607ca46e | 530 | struct ethtool_gstrings { |
fe5df1b9 BH |
531 | __u32 cmd; |
532 | __u32 string_set; | |
533 | __u32 len; | |
607ca46e DH |
534 | __u8 data[0]; |
535 | }; | |
536 | ||
fe5df1b9 BH |
537 | /** |
538 | * struct ethtool_sset_info - string set information | |
539 | * @cmd: Command number = %ETHTOOL_GSSET_INFO | |
540 | * @sset_mask: On entry, a bitmask of string sets to query, with bits | |
541 | * numbered according to &enum ethtool_stringset. On return, a | |
542 | * bitmask of those string sets queried that are supported. | |
543 | * @data: Buffer for string set sizes. On return, this contains the | |
544 | * size of each string set that was queried and supported, in | |
545 | * order of ID. | |
546 | * | |
547 | * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on | |
548 | * return @sset_mask == 0x6 (sets 1, 2). Then @data[0] contains the | |
549 | * size of set 1 and @data[1] contains the size of set 2. | |
550 | * | |
551 | * Users must allocate a buffer of the appropriate size (4 * number of | |
552 | * sets queried) immediately following this structure. | |
553 | */ | |
607ca46e | 554 | struct ethtool_sset_info { |
fe5df1b9 | 555 | __u32 cmd; |
607ca46e | 556 | __u32 reserved; |
fe5df1b9 BH |
557 | __u64 sset_mask; |
558 | __u32 data[0]; | |
607ca46e DH |
559 | }; |
560 | ||
561 | /** | |
562 | * enum ethtool_test_flags - flags definition of ethtool_test | |
563 | * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise | |
564 | * only online tests. | |
565 | * @ETH_TEST_FL_FAILED: Driver set this flag if test fails. | |
566 | * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback | |
567 | * test. | |
568 | * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test | |
569 | */ | |
570 | ||
571 | enum ethtool_test_flags { | |
572 | ETH_TEST_FL_OFFLINE = (1 << 0), | |
573 | ETH_TEST_FL_FAILED = (1 << 1), | |
574 | ETH_TEST_FL_EXTERNAL_LB = (1 << 2), | |
575 | ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3), | |
576 | }; | |
577 | ||
578 | /* for requesting NIC test and getting results*/ | |
579 | struct ethtool_test { | |
580 | __u32 cmd; /* ETHTOOL_TEST */ | |
581 | __u32 flags; /* ETH_TEST_FL_xxx */ | |
582 | __u32 reserved; | |
583 | __u32 len; /* result length, in number of u64 elements */ | |
584 | __u64 data[0]; | |
585 | }; | |
586 | ||
587 | /* for dumping NIC-specific statistics */ | |
588 | struct ethtool_stats { | |
589 | __u32 cmd; /* ETHTOOL_GSTATS */ | |
590 | __u32 n_stats; /* number of u64's being returned */ | |
591 | __u64 data[0]; | |
592 | }; | |
593 | ||
594 | struct ethtool_perm_addr { | |
595 | __u32 cmd; /* ETHTOOL_GPERMADDR */ | |
596 | __u32 size; | |
597 | __u8 data[0]; | |
598 | }; | |
599 | ||
600 | /* boolean flags controlling per-interface behavior characteristics. | |
601 | * When reading, the flag indicates whether or not a certain behavior | |
602 | * is enabled/present. When writing, the flag indicates whether | |
603 | * or not the driver should turn on (set) or off (clear) a behavior. | |
604 | * | |
605 | * Some behaviors may read-only (unconditionally absent or present). | |
606 | * If such is the case, return EINVAL in the set-flags operation if the | |
607 | * flag differs from the read-only value. | |
608 | */ | |
609 | enum ethtool_flags { | |
610 | ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */ | |
611 | ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */ | |
612 | ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */ | |
613 | ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */ | |
614 | ETH_FLAG_RXHASH = (1 << 28), | |
615 | }; | |
616 | ||
617 | /* The following structures are for supporting RX network flow | |
618 | * classification and RX n-tuple configuration. Note, all multibyte | |
619 | * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to | |
620 | * be in network byte order. | |
621 | */ | |
622 | ||
623 | /** | |
624 | * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc. | |
625 | * @ip4src: Source host | |
626 | * @ip4dst: Destination host | |
627 | * @psrc: Source port | |
628 | * @pdst: Destination port | |
629 | * @tos: Type-of-service | |
630 | * | |
631 | * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow. | |
632 | */ | |
633 | struct ethtool_tcpip4_spec { | |
634 | __be32 ip4src; | |
635 | __be32 ip4dst; | |
636 | __be16 psrc; | |
637 | __be16 pdst; | |
638 | __u8 tos; | |
639 | }; | |
640 | ||
641 | /** | |
642 | * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4 | |
643 | * @ip4src: Source host | |
644 | * @ip4dst: Destination host | |
645 | * @spi: Security parameters index | |
646 | * @tos: Type-of-service | |
647 | * | |
648 | * This can be used to specify an IPsec transport or tunnel over IPv4. | |
649 | */ | |
650 | struct ethtool_ah_espip4_spec { | |
651 | __be32 ip4src; | |
652 | __be32 ip4dst; | |
653 | __be32 spi; | |
654 | __u8 tos; | |
655 | }; | |
656 | ||
657 | #define ETH_RX_NFC_IP4 1 | |
658 | ||
659 | /** | |
660 | * struct ethtool_usrip4_spec - general flow specification for IPv4 | |
661 | * @ip4src: Source host | |
662 | * @ip4dst: Destination host | |
663 | * @l4_4_bytes: First 4 bytes of transport (layer 4) header | |
664 | * @tos: Type-of-service | |
665 | * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0 | |
666 | * @proto: Transport protocol number; mask must be 0 | |
667 | */ | |
668 | struct ethtool_usrip4_spec { | |
669 | __be32 ip4src; | |
670 | __be32 ip4dst; | |
671 | __be32 l4_4_bytes; | |
672 | __u8 tos; | |
673 | __u8 ip_ver; | |
674 | __u8 proto; | |
675 | }; | |
676 | ||
677 | union ethtool_flow_union { | |
678 | struct ethtool_tcpip4_spec tcp_ip4_spec; | |
679 | struct ethtool_tcpip4_spec udp_ip4_spec; | |
680 | struct ethtool_tcpip4_spec sctp_ip4_spec; | |
681 | struct ethtool_ah_espip4_spec ah_ip4_spec; | |
682 | struct ethtool_ah_espip4_spec esp_ip4_spec; | |
683 | struct ethtool_usrip4_spec usr_ip4_spec; | |
684 | struct ethhdr ether_spec; | |
d4676eac | 685 | __u8 hdata[52]; |
607ca46e DH |
686 | }; |
687 | ||
dc2e5734 YB |
688 | /** |
689 | * struct ethtool_flow_ext - additional RX flow fields | |
690 | * @h_dest: destination MAC address | |
691 | * @vlan_etype: VLAN EtherType | |
692 | * @vlan_tci: VLAN tag control information | |
693 | * @data: user defined data | |
694 | * | |
695 | * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT | |
696 | * is set in &struct ethtool_rx_flow_spec @flow_type. | |
697 | * @h_dest is valid if %FLOW_MAC_EXT is set. | |
698 | */ | |
607ca46e | 699 | struct ethtool_flow_ext { |
d4676eac | 700 | __u8 padding[2]; |
dc2e5734 | 701 | unsigned char h_dest[ETH_ALEN]; |
d4676eac YB |
702 | __be16 vlan_etype; |
703 | __be16 vlan_tci; | |
704 | __be32 data[2]; | |
607ca46e DH |
705 | }; |
706 | ||
707 | /** | |
708 | * struct ethtool_rx_flow_spec - classification rule for RX flows | |
709 | * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW | |
710 | * @h_u: Flow fields to match (dependent on @flow_type) | |
711 | * @h_ext: Additional fields to match | |
712 | * @m_u: Masks for flow field bits to be matched | |
713 | * @m_ext: Masks for additional field bits to be matched | |
714 | * Note, all additional fields must be ignored unless @flow_type | |
dc2e5734 YB |
715 | * includes the %FLOW_EXT or %FLOW_MAC_EXT flag |
716 | * (see &struct ethtool_flow_ext description). | |
607ca46e DH |
717 | * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC |
718 | * if packets should be discarded | |
719 | * @location: Location of rule in the table. Locations must be | |
720 | * numbered such that a flow matching multiple rules will be | |
721 | * classified according to the first (lowest numbered) rule. | |
722 | */ | |
723 | struct ethtool_rx_flow_spec { | |
724 | __u32 flow_type; | |
725 | union ethtool_flow_union h_u; | |
726 | struct ethtool_flow_ext h_ext; | |
727 | union ethtool_flow_union m_u; | |
728 | struct ethtool_flow_ext m_ext; | |
729 | __u64 ring_cookie; | |
730 | __u32 location; | |
731 | }; | |
732 | ||
733 | /** | |
734 | * struct ethtool_rxnfc - command to get or set RX flow classification rules | |
735 | * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH, | |
736 | * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE, | |
737 | * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS | |
738 | * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW | |
739 | * @data: Command-dependent value | |
740 | * @fs: Flow classification rule | |
741 | * @rule_cnt: Number of rules to be affected | |
742 | * @rule_locs: Array of used rule locations | |
743 | * | |
744 | * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating | |
745 | * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following | |
746 | * structure fields must not be used. | |
747 | * | |
748 | * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues | |
749 | * on return. | |
750 | * | |
751 | * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined | |
752 | * rules on return. If @data is non-zero on return then it is the | |
753 | * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the | |
754 | * driver supports any special location values. If that flag is not | |
755 | * set in @data then special location values should not be used. | |
756 | * | |
757 | * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an | |
758 | * existing rule on entry and @fs contains the rule on return. | |
759 | * | |
760 | * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the | |
761 | * user buffer for @rule_locs on entry. On return, @data is the size | |
762 | * of the rule table, @rule_cnt is the number of defined rules, and | |
763 | * @rule_locs contains the locations of the defined rules. Drivers | |
764 | * must use the second parameter to get_rxnfc() instead of @rule_locs. | |
765 | * | |
766 | * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update. | |
767 | * @fs.@location either specifies the location to use or is a special | |
768 | * location value with %RX_CLS_LOC_SPECIAL flag set. On return, | |
769 | * @fs.@location is the actual rule location. | |
770 | * | |
771 | * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an | |
772 | * existing rule on entry. | |
773 | * | |
774 | * A driver supporting the special location values for | |
775 | * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused | |
776 | * location, and may remove a rule at a later location (lower | |
777 | * priority) that matches exactly the same set of flows. The special | |
778 | * values are: %RX_CLS_LOC_ANY, selecting any location; | |
779 | * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum | |
780 | * priority); and %RX_CLS_LOC_LAST, selecting the last suitable | |
781 | * location (minimum priority). Additional special values may be | |
782 | * defined in future and drivers must return -%EINVAL for any | |
783 | * unrecognised value. | |
784 | */ | |
785 | struct ethtool_rxnfc { | |
786 | __u32 cmd; | |
787 | __u32 flow_type; | |
788 | __u64 data; | |
789 | struct ethtool_rx_flow_spec fs; | |
790 | __u32 rule_cnt; | |
791 | __u32 rule_locs[0]; | |
792 | }; | |
793 | ||
794 | ||
795 | /** | |
796 | * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection | |
797 | * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR | |
798 | * @size: On entry, the array size of the user buffer, which may be zero. | |
799 | * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware | |
800 | * indirection table. | |
801 | * @ring_index: RX ring/queue index for each hash value | |
802 | * | |
803 | * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size | |
804 | * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means | |
805 | * the table should be reset to default values. This last feature | |
806 | * is not supported by the original implementations. | |
807 | */ | |
808 | struct ethtool_rxfh_indir { | |
809 | __u32 cmd; | |
810 | __u32 size; | |
811 | __u32 ring_index[0]; | |
812 | }; | |
813 | ||
814 | /** | |
815 | * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter | |
816 | * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW | |
817 | * @h_u: Flow field values to match (dependent on @flow_type) | |
818 | * @m_u: Masks for flow field value bits to be ignored | |
819 | * @vlan_tag: VLAN tag to match | |
820 | * @vlan_tag_mask: Mask for VLAN tag bits to be ignored | |
821 | * @data: Driver-dependent data to match | |
822 | * @data_mask: Mask for driver-dependent data bits to be ignored | |
823 | * @action: RX ring/queue index to deliver to (non-negative) or other action | |
824 | * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP) | |
825 | * | |
826 | * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where | |
827 | * a field value and mask are both zero this is treated as if all mask | |
828 | * bits are set i.e. the field is ignored. | |
829 | */ | |
830 | struct ethtool_rx_ntuple_flow_spec { | |
831 | __u32 flow_type; | |
832 | union { | |
833 | struct ethtool_tcpip4_spec tcp_ip4_spec; | |
834 | struct ethtool_tcpip4_spec udp_ip4_spec; | |
835 | struct ethtool_tcpip4_spec sctp_ip4_spec; | |
836 | struct ethtool_ah_espip4_spec ah_ip4_spec; | |
837 | struct ethtool_ah_espip4_spec esp_ip4_spec; | |
838 | struct ethtool_usrip4_spec usr_ip4_spec; | |
839 | struct ethhdr ether_spec; | |
840 | __u8 hdata[72]; | |
841 | } h_u, m_u; | |
842 | ||
843 | __u16 vlan_tag; | |
844 | __u16 vlan_tag_mask; | |
845 | __u64 data; | |
846 | __u64 data_mask; | |
847 | ||
848 | __s32 action; | |
849 | #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */ | |
850 | #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */ | |
851 | }; | |
852 | ||
853 | /** | |
854 | * struct ethtool_rx_ntuple - command to set or clear RX flow filter | |
855 | * @cmd: Command number - %ETHTOOL_SRXNTUPLE | |
856 | * @fs: Flow filter specification | |
857 | */ | |
858 | struct ethtool_rx_ntuple { | |
859 | __u32 cmd; | |
860 | struct ethtool_rx_ntuple_flow_spec fs; | |
861 | }; | |
862 | ||
863 | #define ETHTOOL_FLASH_MAX_FILENAME 128 | |
864 | enum ethtool_flash_op_type { | |
865 | ETHTOOL_FLASH_ALL_REGIONS = 0, | |
866 | }; | |
867 | ||
868 | /* for passing firmware flashing related parameters */ | |
869 | struct ethtool_flash { | |
870 | __u32 cmd; | |
871 | __u32 region; | |
872 | char data[ETHTOOL_FLASH_MAX_FILENAME]; | |
873 | }; | |
874 | ||
875 | /** | |
876 | * struct ethtool_dump - used for retrieving, setting device dump | |
877 | * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or | |
878 | * %ETHTOOL_SET_DUMP | |
879 | * @version: FW version of the dump, filled in by driver | |
880 | * @flag: driver dependent flag for dump setting, filled in by driver during | |
881 | * get and filled in by ethtool for set operation. | |
882 | * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when | |
883 | * firmware dump is disabled. | |
884 | * @len: length of dump data, used as the length of the user buffer on entry to | |
885 | * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver | |
886 | * for %ETHTOOL_GET_DUMP_FLAG command | |
887 | * @data: data collected for get dump data operation | |
888 | */ | |
889 | ||
890 | #define ETH_FW_DUMP_DISABLE 0 | |
891 | ||
892 | struct ethtool_dump { | |
893 | __u32 cmd; | |
894 | __u32 version; | |
895 | __u32 flag; | |
896 | __u32 len; | |
897 | __u8 data[0]; | |
898 | }; | |
899 | ||
900 | /* for returning and changing feature sets */ | |
901 | ||
902 | /** | |
903 | * struct ethtool_get_features_block - block with state of 32 features | |
904 | * @available: mask of changeable features | |
905 | * @requested: mask of features requested to be enabled if possible | |
906 | * @active: mask of currently enabled features | |
907 | * @never_changed: mask of features not changeable for any device | |
908 | */ | |
909 | struct ethtool_get_features_block { | |
910 | __u32 available; | |
911 | __u32 requested; | |
912 | __u32 active; | |
913 | __u32 never_changed; | |
914 | }; | |
915 | ||
916 | /** | |
917 | * struct ethtool_gfeatures - command to get state of device's features | |
918 | * @cmd: command number = %ETHTOOL_GFEATURES | |
919 | * @size: in: number of elements in the features[] array; | |
920 | * out: number of elements in features[] needed to hold all features | |
921 | * @features: state of features | |
922 | */ | |
923 | struct ethtool_gfeatures { | |
924 | __u32 cmd; | |
925 | __u32 size; | |
926 | struct ethtool_get_features_block features[0]; | |
927 | }; | |
928 | ||
929 | /** | |
930 | * struct ethtool_set_features_block - block with request for 32 features | |
931 | * @valid: mask of features to be changed | |
932 | * @requested: values of features to be changed | |
933 | */ | |
934 | struct ethtool_set_features_block { | |
935 | __u32 valid; | |
936 | __u32 requested; | |
937 | }; | |
938 | ||
939 | /** | |
940 | * struct ethtool_sfeatures - command to request change in device's features | |
941 | * @cmd: command number = %ETHTOOL_SFEATURES | |
942 | * @size: array size of the features[] array | |
943 | * @features: feature change masks | |
944 | */ | |
945 | struct ethtool_sfeatures { | |
946 | __u32 cmd; | |
947 | __u32 size; | |
948 | struct ethtool_set_features_block features[0]; | |
949 | }; | |
950 | ||
951 | /** | |
952 | * struct ethtool_ts_info - holds a device's timestamping and PHC association | |
953 | * @cmd: command number = %ETHTOOL_GET_TS_INFO | |
954 | * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags | |
955 | * @phc_index: device index of the associated PHC, or -1 if there is none | |
956 | * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values | |
957 | * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values | |
958 | * | |
959 | * The bits in the 'tx_types' and 'rx_filters' fields correspond to | |
960 | * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values, | |
961 | * respectively. For example, if the device supports HWTSTAMP_TX_ON, | |
962 | * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set. | |
963 | */ | |
964 | struct ethtool_ts_info { | |
965 | __u32 cmd; | |
966 | __u32 so_timestamping; | |
967 | __s32 phc_index; | |
968 | __u32 tx_types; | |
969 | __u32 tx_reserved[3]; | |
970 | __u32 rx_filters; | |
971 | __u32 rx_reserved[3]; | |
972 | }; | |
973 | ||
974 | /* | |
975 | * %ETHTOOL_SFEATURES changes features present in features[].valid to the | |
976 | * values of corresponding bits in features[].requested. Bits in .requested | |
977 | * not set in .valid or not changeable are ignored. | |
978 | * | |
979 | * Returns %EINVAL when .valid contains undefined or never-changeable bits | |
980 | * or size is not equal to required number of features words (32-bit blocks). | |
981 | * Returns >= 0 if request was completed; bits set in the value mean: | |
982 | * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not | |
983 | * changeable (not present in %ETHTOOL_GFEATURES' features[].available) | |
984 | * those bits were ignored. | |
985 | * %ETHTOOL_F_WISH - some or all changes requested were recorded but the | |
986 | * resulting state of bits masked by .valid is not equal to .requested. | |
987 | * Probably there are other device-specific constraints on some features | |
988 | * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered | |
989 | * here as though ignored bits were cleared. | |
990 | * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling | |
991 | * compatibility functions. Requested offload state cannot be properly | |
992 | * managed by kernel. | |
993 | * | |
994 | * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of | |
995 | * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands | |
996 | * for ETH_SS_FEATURES string set. First entry in the table corresponds to least | |
997 | * significant bit in features[0] fields. Empty strings mark undefined features. | |
998 | */ | |
999 | enum ethtool_sfeatures_retval_bits { | |
1000 | ETHTOOL_F_UNSUPPORTED__BIT, | |
1001 | ETHTOOL_F_WISH__BIT, | |
1002 | ETHTOOL_F_COMPAT__BIT, | |
1003 | }; | |
1004 | ||
1005 | #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT) | |
1006 | #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT) | |
1007 | #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT) | |
1008 | ||
1009 | ||
1010 | /* CMDs currently supported */ | |
1011 | #define ETHTOOL_GSET 0x00000001 /* Get settings. */ | |
1012 | #define ETHTOOL_SSET 0x00000002 /* Set settings. */ | |
1013 | #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */ | |
1014 | #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */ | |
1015 | #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */ | |
1016 | #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */ | |
1017 | #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */ | |
1018 | #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */ | |
1019 | #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */ | |
1020 | /* Get link status for host, i.e. whether the interface *and* the | |
1021 | * physical port (if there is one) are up (ethtool_value). */ | |
1022 | #define ETHTOOL_GLINK 0x0000000a | |
1023 | #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */ | |
1024 | #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */ | |
1025 | #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */ | |
1026 | #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */ | |
1027 | #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */ | |
1028 | #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */ | |
1029 | #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */ | |
1030 | #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */ | |
1031 | #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */ | |
1032 | #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */ | |
1033 | #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */ | |
1034 | #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */ | |
1035 | #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable | |
1036 | * (ethtool_value) */ | |
1037 | #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable | |
1038 | * (ethtool_value). */ | |
1039 | #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */ | |
1040 | #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */ | |
1041 | #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */ | |
1042 | #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */ | |
1043 | #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */ | |
1044 | #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */ | |
1045 | #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */ | |
1046 | #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */ | |
1047 | #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */ | |
1048 | #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */ | |
1049 | #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */ | |
1050 | #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */ | |
1051 | #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */ | |
1052 | #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */ | |
1053 | #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */ | |
1054 | ||
1055 | #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */ | |
1056 | #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */ | |
1057 | #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */ | |
1058 | #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */ | |
1059 | #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */ | |
1060 | #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */ | |
1061 | #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */ | |
1062 | #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */ | |
1063 | #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */ | |
1064 | #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */ | |
1065 | #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */ | |
1066 | #define ETHTOOL_RESET 0x00000034 /* Reset hardware */ | |
1067 | #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */ | |
1068 | #define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */ | |
1069 | #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */ | |
1070 | #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */ | |
1071 | #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */ | |
1072 | ||
1073 | #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */ | |
1074 | #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */ | |
1075 | #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */ | |
1076 | #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */ | |
1077 | #define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */ | |
1078 | #define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */ | |
1079 | #define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */ | |
1080 | #define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */ | |
1081 | #define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */ | |
1082 | #define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */ | |
1083 | #define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */ | |
1084 | #define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */ | |
1085 | ||
1086 | /* compatibility with older code */ | |
1087 | #define SPARC_ETH_GSET ETHTOOL_GSET | |
1088 | #define SPARC_ETH_SSET ETHTOOL_SSET | |
1089 | ||
607ca46e DH |
1090 | #define SUPPORTED_10baseT_Half (1 << 0) |
1091 | #define SUPPORTED_10baseT_Full (1 << 1) | |
1092 | #define SUPPORTED_100baseT_Half (1 << 2) | |
1093 | #define SUPPORTED_100baseT_Full (1 << 3) | |
1094 | #define SUPPORTED_1000baseT_Half (1 << 4) | |
1095 | #define SUPPORTED_1000baseT_Full (1 << 5) | |
1096 | #define SUPPORTED_Autoneg (1 << 6) | |
1097 | #define SUPPORTED_TP (1 << 7) | |
1098 | #define SUPPORTED_AUI (1 << 8) | |
1099 | #define SUPPORTED_MII (1 << 9) | |
1100 | #define SUPPORTED_FIBRE (1 << 10) | |
1101 | #define SUPPORTED_BNC (1 << 11) | |
1102 | #define SUPPORTED_10000baseT_Full (1 << 12) | |
1103 | #define SUPPORTED_Pause (1 << 13) | |
1104 | #define SUPPORTED_Asym_Pause (1 << 14) | |
1105 | #define SUPPORTED_2500baseX_Full (1 << 15) | |
1106 | #define SUPPORTED_Backplane (1 << 16) | |
1107 | #define SUPPORTED_1000baseKX_Full (1 << 17) | |
1108 | #define SUPPORTED_10000baseKX4_Full (1 << 18) | |
1109 | #define SUPPORTED_10000baseKR_Full (1 << 19) | |
1110 | #define SUPPORTED_10000baseR_FEC (1 << 20) | |
1111 | #define SUPPORTED_20000baseMLD2_Full (1 << 21) | |
1112 | #define SUPPORTED_20000baseKR2_Full (1 << 22) | |
1113 | #define SUPPORTED_40000baseKR4_Full (1 << 23) | |
1114 | #define SUPPORTED_40000baseCR4_Full (1 << 24) | |
1115 | #define SUPPORTED_40000baseSR4_Full (1 << 25) | |
1116 | #define SUPPORTED_40000baseLR4_Full (1 << 26) | |
1117 | ||
607ca46e DH |
1118 | #define ADVERTISED_10baseT_Half (1 << 0) |
1119 | #define ADVERTISED_10baseT_Full (1 << 1) | |
1120 | #define ADVERTISED_100baseT_Half (1 << 2) | |
1121 | #define ADVERTISED_100baseT_Full (1 << 3) | |
1122 | #define ADVERTISED_1000baseT_Half (1 << 4) | |
1123 | #define ADVERTISED_1000baseT_Full (1 << 5) | |
1124 | #define ADVERTISED_Autoneg (1 << 6) | |
1125 | #define ADVERTISED_TP (1 << 7) | |
1126 | #define ADVERTISED_AUI (1 << 8) | |
1127 | #define ADVERTISED_MII (1 << 9) | |
1128 | #define ADVERTISED_FIBRE (1 << 10) | |
1129 | #define ADVERTISED_BNC (1 << 11) | |
1130 | #define ADVERTISED_10000baseT_Full (1 << 12) | |
1131 | #define ADVERTISED_Pause (1 << 13) | |
1132 | #define ADVERTISED_Asym_Pause (1 << 14) | |
1133 | #define ADVERTISED_2500baseX_Full (1 << 15) | |
1134 | #define ADVERTISED_Backplane (1 << 16) | |
1135 | #define ADVERTISED_1000baseKX_Full (1 << 17) | |
1136 | #define ADVERTISED_10000baseKX4_Full (1 << 18) | |
1137 | #define ADVERTISED_10000baseKR_Full (1 << 19) | |
1138 | #define ADVERTISED_10000baseR_FEC (1 << 20) | |
1139 | #define ADVERTISED_20000baseMLD2_Full (1 << 21) | |
1140 | #define ADVERTISED_20000baseKR2_Full (1 << 22) | |
1141 | #define ADVERTISED_40000baseKR4_Full (1 << 23) | |
1142 | #define ADVERTISED_40000baseCR4_Full (1 << 24) | |
1143 | #define ADVERTISED_40000baseSR4_Full (1 << 25) | |
1144 | #define ADVERTISED_40000baseLR4_Full (1 << 26) | |
1145 | ||
1146 | /* The following are all involved in forcing a particular link | |
1147 | * mode for the device for setting things. When getting the | |
1148 | * devices settings, these indicate the current mode and whether | |
1149 | * it was forced up into this mode or autonegotiated. | |
1150 | */ | |
1151 | ||
1152 | /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */ | |
1153 | #define SPEED_10 10 | |
1154 | #define SPEED_100 100 | |
1155 | #define SPEED_1000 1000 | |
1156 | #define SPEED_2500 2500 | |
1157 | #define SPEED_10000 10000 | |
1158 | #define SPEED_UNKNOWN -1 | |
1159 | ||
1160 | /* Duplex, half or full. */ | |
1161 | #define DUPLEX_HALF 0x00 | |
1162 | #define DUPLEX_FULL 0x01 | |
1163 | #define DUPLEX_UNKNOWN 0xff | |
1164 | ||
1165 | /* Which connector port. */ | |
1166 | #define PORT_TP 0x00 | |
1167 | #define PORT_AUI 0x01 | |
1168 | #define PORT_MII 0x02 | |
1169 | #define PORT_FIBRE 0x03 | |
1170 | #define PORT_BNC 0x04 | |
1171 | #define PORT_DA 0x05 | |
1172 | #define PORT_NONE 0xef | |
1173 | #define PORT_OTHER 0xff | |
1174 | ||
1175 | /* Which transceiver to use. */ | |
7ec87211 FF |
1176 | #define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */ |
1177 | #define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */ | |
607ca46e DH |
1178 | #define XCVR_DUMMY1 0x02 |
1179 | #define XCVR_DUMMY2 0x03 | |
1180 | #define XCVR_DUMMY3 0x04 | |
1181 | ||
bf8fc60a | 1182 | /* Enable or disable autonegotiation. */ |
607ca46e DH |
1183 | #define AUTONEG_DISABLE 0x00 |
1184 | #define AUTONEG_ENABLE 0x01 | |
1185 | ||
1186 | /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then | |
1187 | * the driver is required to renegotiate link | |
1188 | */ | |
1189 | #define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */ | |
1190 | #define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */ | |
1191 | #define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */ | |
1192 | #define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */ | |
1193 | ||
1194 | /* Wake-On-Lan options. */ | |
1195 | #define WAKE_PHY (1 << 0) | |
1196 | #define WAKE_UCAST (1 << 1) | |
1197 | #define WAKE_MCAST (1 << 2) | |
1198 | #define WAKE_BCAST (1 << 3) | |
1199 | #define WAKE_ARP (1 << 4) | |
1200 | #define WAKE_MAGIC (1 << 5) | |
1201 | #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */ | |
1202 | ||
1203 | /* L2-L4 network traffic flow types */ | |
1204 | #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */ | |
1205 | #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */ | |
1206 | #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */ | |
1207 | #define AH_ESP_V4_FLOW 0x04 /* hash only */ | |
1208 | #define TCP_V6_FLOW 0x05 /* hash only */ | |
1209 | #define UDP_V6_FLOW 0x06 /* hash only */ | |
1210 | #define SCTP_V6_FLOW 0x07 /* hash only */ | |
1211 | #define AH_ESP_V6_FLOW 0x08 /* hash only */ | |
1212 | #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */ | |
1213 | #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */ | |
1214 | #define AH_V6_FLOW 0x0b /* hash only */ | |
1215 | #define ESP_V6_FLOW 0x0c /* hash only */ | |
1216 | #define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */ | |
1217 | #define IPV4_FLOW 0x10 /* hash only */ | |
1218 | #define IPV6_FLOW 0x11 /* hash only */ | |
1219 | #define ETHER_FLOW 0x12 /* spec only (ether_spec) */ | |
1220 | /* Flag to enable additional fields in struct ethtool_rx_flow_spec */ | |
1221 | #define FLOW_EXT 0x80000000 | |
d4676eac | 1222 | #define FLOW_MAC_EXT 0x40000000 |
607ca46e DH |
1223 | |
1224 | /* L3-L4 network traffic flow hash options */ | |
1225 | #define RXH_L2DA (1 << 1) | |
1226 | #define RXH_VLAN (1 << 2) | |
1227 | #define RXH_L3_PROTO (1 << 3) | |
1228 | #define RXH_IP_SRC (1 << 4) | |
1229 | #define RXH_IP_DST (1 << 5) | |
1230 | #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */ | |
1231 | #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */ | |
1232 | #define RXH_DISCARD (1 << 31) | |
1233 | ||
1234 | #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL | |
1235 | ||
1236 | /* Special RX classification rule insert location values */ | |
1237 | #define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */ | |
1238 | #define RX_CLS_LOC_ANY 0xffffffff | |
1239 | #define RX_CLS_LOC_FIRST 0xfffffffe | |
1240 | #define RX_CLS_LOC_LAST 0xfffffffd | |
1241 | ||
1242 | /* EEPROM Standards for plug in modules */ | |
1243 | #define ETH_MODULE_SFF_8079 0x1 | |
1244 | #define ETH_MODULE_SFF_8079_LEN 256 | |
1245 | #define ETH_MODULE_SFF_8472 0x2 | |
1246 | #define ETH_MODULE_SFF_8472_LEN 512 | |
1247 | ||
1248 | /* Reset flags */ | |
1249 | /* The reset() operation must clear the flags for the components which | |
1250 | * were actually reset. On successful return, the flags indicate the | |
1251 | * components which were not reset, either because they do not exist | |
1252 | * in the hardware or because they cannot be reset independently. The | |
1253 | * driver must never reset any components that were not requested. | |
1254 | */ | |
1255 | enum ethtool_reset_flags { | |
1256 | /* These flags represent components dedicated to the interface | |
1257 | * the command is addressed to. Shift any flag left by | |
1258 | * ETH_RESET_SHARED_SHIFT to reset a shared component of the | |
1259 | * same type. | |
1260 | */ | |
1261 | ETH_RESET_MGMT = 1 << 0, /* Management processor */ | |
1262 | ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */ | |
1263 | ETH_RESET_DMA = 1 << 2, /* DMA engine */ | |
1264 | ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */ | |
1265 | ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */ | |
1266 | ETH_RESET_MAC = 1 << 5, /* Media access controller */ | |
1267 | ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */ | |
1268 | ETH_RESET_RAM = 1 << 7, /* RAM shared between | |
1269 | * multiple components */ | |
1270 | ||
1271 | ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to | |
1272 | * this interface */ | |
1273 | ETH_RESET_ALL = 0xffffffff, /* All components used by this | |
1274 | * interface, even if shared */ | |
1275 | }; | |
1276 | #define ETH_RESET_SHARED_SHIFT 16 | |
1277 | ||
1278 | #endif /* _UAPI_LINUX_ETHTOOL_H */ |