ethtool.h 48 KB

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