ethtool.h 49 KB

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