2
0

ethtool.h 101 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561
  1. /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
  2. /*
  3. * ethtool.h: Defines for Linux ethtool.
  4. *
  5. * Copyright (C) 1998 David S. Miller (davem@redhat.com)
  6. * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
  7. * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
  8. * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
  9. * christopher.leech@intel.com,
  10. * scott.feldman@intel.com)
  11. * Portions Copyright (C) Sun Microsystems 2008
  12. */
  13. #ifndef _LINUX_ETHTOOL_H
  14. #define _LINUX_ETHTOOL_H
  15. #include "net/eth.h"
  16. #include "standard-headers/linux/const.h"
  17. #include "standard-headers/linux/types.h"
  18. #include "standard-headers/linux/if_ether.h"
  19. #include <limits.h> /* for INT_MAX */
  20. /* All structures exposed to userland should be defined such that they
  21. * have the same layout for 32-bit and 64-bit userland.
  22. */
  23. /* Note on reserved space.
  24. * Reserved fields must not be accessed directly by user space because
  25. * they may be replaced by a different field in the future. They must
  26. * be initialized to zero before making the request, e.g. via memset
  27. * of the entire structure or implicitly by not being set in a structure
  28. * initializer.
  29. */
  30. /**
  31. * struct ethtool_cmd - DEPRECATED, link control and status
  32. * This structure is DEPRECATED, please use struct ethtool_link_settings.
  33. * @cmd: Command number = %ETHTOOL_GSET or %ETHTOOL_SSET
  34. * @supported: Bitmask of %SUPPORTED_* flags for the link modes,
  35. * physical connectors and other link features for which the
  36. * interface supports autonegotiation or auto-detection.
  37. * Read-only.
  38. * @advertising: Bitmask of %ADVERTISED_* flags for the link modes,
  39. * physical connectors and other link features that are
  40. * advertised through autonegotiation or enabled for
  41. * auto-detection.
  42. * @speed: Low bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN
  43. * @duplex: Duplex mode; one of %DUPLEX_*
  44. * @port: Physical connector type; one of %PORT_*
  45. * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
  46. * applicable. For clause 45 PHYs this is the PRTAD.
  47. * @transceiver: Historically used to distinguish different possible
  48. * PHY types, but not in a consistent way. Deprecated.
  49. * @autoneg: Enable/disable autonegotiation and auto-detection;
  50. * either %AUTONEG_DISABLE or %AUTONEG_ENABLE
  51. * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
  52. * protocols supported by the interface; 0 if unknown.
  53. * Read-only.
  54. * @maxtxpkt: Historically used to report TX IRQ coalescing; now
  55. * obsoleted by &struct ethtool_coalesce. Read-only; deprecated.
  56. * @maxrxpkt: Historically used to report RX IRQ coalescing; now
  57. * obsoleted by &struct ethtool_coalesce. Read-only; deprecated.
  58. * @speed_hi: High bits of the speed, 1Mb units, 0 to INT_MAX or SPEED_UNKNOWN
  59. * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
  60. * %ETH_TP_MDI_*. If the status is unknown or not applicable, the
  61. * value will be %ETH_TP_MDI_INVALID. Read-only.
  62. * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
  63. * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads
  64. * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
  65. * When written successfully, the link should be renegotiated if
  66. * necessary.
  67. * @lp_advertising: Bitmask of %ADVERTISED_* flags for the link modes
  68. * and other link features that the link partner advertised
  69. * through autonegotiation; 0 if unknown or not applicable.
  70. * Read-only.
  71. * @reserved: Reserved for future use; see the note on reserved space.
  72. *
  73. * The link speed in Mbps is split between @speed and @speed_hi. Use
  74. * the ethtool_cmd_speed() and ethtool_cmd_speed_set() functions to
  75. * access it.
  76. *
  77. * If autonegotiation is disabled, the speed and @duplex represent the
  78. * fixed link mode and are writable if the driver supports multiple
  79. * link modes. If it is enabled then they are read-only; if the link
  80. * is up they represent the negotiated link mode; if the link is down,
  81. * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
  82. * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
  83. *
  84. * Some hardware interfaces may have multiple PHYs and/or physical
  85. * connectors fitted or do not allow the driver to detect which are
  86. * fitted. For these interfaces @port and/or @phy_address may be
  87. * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
  88. * Otherwise, attempts to write different values may be ignored or
  89. * rejected.
  90. *
  91. * Users should assume that all fields not marked read-only are
  92. * writable and subject to validation by the driver. They should use
  93. * %ETHTOOL_GSET to get the current values before making specific
  94. * changes and then applying them with %ETHTOOL_SSET.
  95. *
  96. * Deprecated fields should be ignored by both users and drivers.
  97. */
  98. struct ethtool_cmd {
  99. uint32_t cmd;
  100. uint32_t supported;
  101. uint32_t advertising;
  102. uint16_t speed;
  103. uint8_t duplex;
  104. uint8_t port;
  105. uint8_t phy_address;
  106. uint8_t transceiver;
  107. uint8_t autoneg;
  108. uint8_t mdio_support;
  109. uint32_t maxtxpkt;
  110. uint32_t maxrxpkt;
  111. uint16_t speed_hi;
  112. uint8_t eth_tp_mdix;
  113. uint8_t eth_tp_mdix_ctrl;
  114. uint32_t lp_advertising;
  115. uint32_t reserved[2];
  116. };
  117. static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep,
  118. uint32_t speed)
  119. {
  120. ep->speed = (uint16_t)(speed & 0xFFFF);
  121. ep->speed_hi = (uint16_t)(speed >> 16);
  122. }
  123. static inline uint32_t ethtool_cmd_speed(const struct ethtool_cmd *ep)
  124. {
  125. return (ep->speed_hi << 16) | ep->speed;
  126. }
  127. /* Device supports clause 22 register access to PHY or peripherals
  128. * using the interface defined in "standard-headers/linux/mii.h". This should not be
  129. * set if there are known to be no such peripherals present or if
  130. * the driver only emulates clause 22 registers for compatibility.
  131. */
  132. #define ETH_MDIO_SUPPORTS_C22 1
  133. /* Device supports clause 45 register access to PHY or peripherals
  134. * using the interface defined in "standard-headers/linux/mii.h" and <linux/mdio.h>.
  135. * This should not be set if there are known to be no such peripherals
  136. * present.
  137. */
  138. #define ETH_MDIO_SUPPORTS_C45 2
  139. #define ETHTOOL_FWVERS_LEN 32
  140. #define ETHTOOL_BUSINFO_LEN 32
  141. #define ETHTOOL_EROMVERS_LEN 32
  142. /**
  143. * struct ethtool_drvinfo - general driver and device information
  144. * @cmd: Command number = %ETHTOOL_GDRVINFO
  145. * @driver: Driver short name. This should normally match the name
  146. * in its bus driver structure (e.g. pci_driver::name). Must
  147. * not be an empty string.
  148. * @version: Driver version string; may be an empty string
  149. * @fw_version: Firmware version string; driver defined; may be an
  150. * empty string
  151. * @erom_version: Expansion ROM version string; driver defined; may be
  152. * an empty string
  153. * @bus_info: Device bus address. This should match the dev_name()
  154. * string for the underlying bus device, if there is one. May be
  155. * an empty string.
  156. * @reserved2: Reserved for future use; see the note on reserved space.
  157. * @n_priv_flags: Number of flags valid for %ETHTOOL_GPFLAGS and
  158. * %ETHTOOL_SPFLAGS commands; also the number of strings in the
  159. * %ETH_SS_PRIV_FLAGS set
  160. * @n_stats: Number of uint64_t statistics returned by the %ETHTOOL_GSTATS
  161. * command; also the number of strings in the %ETH_SS_STATS set
  162. * @testinfo_len: Number of results returned by the %ETHTOOL_TEST
  163. * command; also the number of strings in the %ETH_SS_TEST set
  164. * @eedump_len: Size of EEPROM accessible through the %ETHTOOL_GEEPROM
  165. * and %ETHTOOL_SEEPROM commands, in bytes
  166. * @regdump_len: Size of register dump returned by the %ETHTOOL_GREGS
  167. * command, in bytes
  168. *
  169. * Users can use the %ETHTOOL_GSSET_INFO command to get the number of
  170. * strings in any string set (from Linux 2.6.34).
  171. */
  172. struct ethtool_drvinfo {
  173. uint32_t cmd;
  174. char driver[32];
  175. char version[32];
  176. char fw_version[ETHTOOL_FWVERS_LEN];
  177. char bus_info[ETHTOOL_BUSINFO_LEN];
  178. char erom_version[ETHTOOL_EROMVERS_LEN];
  179. char reserved2[12];
  180. uint32_t n_priv_flags;
  181. uint32_t n_stats;
  182. uint32_t testinfo_len;
  183. uint32_t eedump_len;
  184. uint32_t regdump_len;
  185. };
  186. #define SOPASS_MAX 6
  187. /**
  188. * struct ethtool_wolinfo - Wake-On-Lan configuration
  189. * @cmd: Command number = %ETHTOOL_GWOL or %ETHTOOL_SWOL
  190. * @supported: Bitmask of %WAKE_* flags for supported Wake-On-Lan modes.
  191. * Read-only.
  192. * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes.
  193. * @sopass: SecureOn(tm) password; meaningful only if %WAKE_MAGICSECURE
  194. * is set in @wolopts.
  195. */
  196. struct ethtool_wolinfo {
  197. uint32_t cmd;
  198. uint32_t supported;
  199. uint32_t wolopts;
  200. uint8_t sopass[SOPASS_MAX];
  201. };
  202. /* for passing single values */
  203. struct ethtool_value {
  204. uint32_t cmd;
  205. uint32_t data;
  206. };
  207. #define PFC_STORM_PREVENTION_AUTO 0xffff
  208. #define PFC_STORM_PREVENTION_DISABLE 0
  209. enum tunable_id {
  210. ETHTOOL_ID_UNSPEC,
  211. ETHTOOL_RX_COPYBREAK,
  212. ETHTOOL_TX_COPYBREAK,
  213. ETHTOOL_PFC_PREVENTION_TOUT, /* timeout in msecs */
  214. ETHTOOL_TX_COPYBREAK_BUF_SIZE,
  215. /*
  216. * Add your fresh new tunable attribute above and remember to update
  217. * tunable_strings[] in net/ethtool/common.c
  218. */
  219. __ETHTOOL_TUNABLE_COUNT,
  220. };
  221. enum tunable_type_id {
  222. ETHTOOL_TUNABLE_UNSPEC,
  223. ETHTOOL_TUNABLE_U8,
  224. ETHTOOL_TUNABLE_U16,
  225. ETHTOOL_TUNABLE_U32,
  226. ETHTOOL_TUNABLE_U64,
  227. ETHTOOL_TUNABLE_STRING,
  228. ETHTOOL_TUNABLE_S8,
  229. ETHTOOL_TUNABLE_S16,
  230. ETHTOOL_TUNABLE_S32,
  231. ETHTOOL_TUNABLE_S64,
  232. };
  233. struct ethtool_tunable {
  234. uint32_t cmd;
  235. uint32_t id;
  236. uint32_t type_id;
  237. uint32_t len;
  238. void *data[];
  239. };
  240. #define DOWNSHIFT_DEV_DEFAULT_COUNT 0xff
  241. #define DOWNSHIFT_DEV_DISABLE 0
  242. /* Time in msecs after which link is reported as down
  243. * 0 = lowest time supported by the PHY
  244. * 0xff = off, link down detection according to standard
  245. */
  246. #define ETHTOOL_PHY_FAST_LINK_DOWN_ON 0
  247. #define ETHTOOL_PHY_FAST_LINK_DOWN_OFF 0xff
  248. /* Energy Detect Power Down (EDPD) is a feature supported by some PHYs, where
  249. * the PHY's RX & TX blocks are put into a low-power mode when there is no
  250. * link detected (typically cable is un-plugged). For RX, only a minimal
  251. * link-detection is available, and for TX the PHY wakes up to send link pulses
  252. * to avoid any lock-ups in case the peer PHY may also be running in EDPD mode.
  253. *
  254. * Some PHYs may support configuration of the wake-up interval for TX pulses,
  255. * and some PHYs may support only disabling TX pulses entirely. For the latter
  256. * a special value is required (ETHTOOL_PHY_EDPD_NO_TX) so that this can be
  257. * configured from userspace (should the user want it).
  258. *
  259. * The interval units for TX wake-up are in milliseconds, since this should
  260. * cover a reasonable range of intervals:
  261. * - from 1 millisecond, which does not sound like much of a power-saver
  262. * - to ~65 seconds which is quite a lot to wait for a link to come up when
  263. * plugging a cable
  264. */
  265. #define ETHTOOL_PHY_EDPD_DFLT_TX_MSECS 0xffff
  266. #define ETHTOOL_PHY_EDPD_NO_TX 0xfffe
  267. #define ETHTOOL_PHY_EDPD_DISABLE 0
  268. enum phy_tunable_id {
  269. ETHTOOL_PHY_ID_UNSPEC,
  270. ETHTOOL_PHY_DOWNSHIFT,
  271. ETHTOOL_PHY_FAST_LINK_DOWN,
  272. ETHTOOL_PHY_EDPD,
  273. /*
  274. * Add your fresh new phy tunable attribute above and remember to update
  275. * phy_tunable_strings[] in net/ethtool/common.c
  276. */
  277. __ETHTOOL_PHY_TUNABLE_COUNT,
  278. };
  279. /**
  280. * struct ethtool_regs - hardware register dump
  281. * @cmd: Command number = %ETHTOOL_GREGS
  282. * @version: Dump format version. This is driver-specific and may
  283. * distinguish different chips/revisions. Drivers must use new
  284. * version numbers whenever the dump format changes in an
  285. * incompatible way.
  286. * @len: On entry, the real length of @data. On return, the number of
  287. * bytes used.
  288. * @data: Buffer for the register dump
  289. *
  290. * Users should use %ETHTOOL_GDRVINFO to find the maximum length of
  291. * a register dump for the interface. They must allocate the buffer
  292. * immediately following this structure.
  293. */
  294. struct ethtool_regs {
  295. uint32_t cmd;
  296. uint32_t version;
  297. uint32_t len;
  298. uint8_t data[];
  299. };
  300. /**
  301. * struct ethtool_eeprom - EEPROM dump
  302. * @cmd: Command number = %ETHTOOL_GEEPROM, %ETHTOOL_GMODULEEEPROM or
  303. * %ETHTOOL_SEEPROM
  304. * @magic: A 'magic cookie' value to guard against accidental changes.
  305. * The value passed in to %ETHTOOL_SEEPROM must match the value
  306. * returned by %ETHTOOL_GEEPROM for the same device. This is
  307. * unused when @cmd is %ETHTOOL_GMODULEEEPROM.
  308. * @offset: Offset within the EEPROM to begin reading/writing, in bytes
  309. * @len: On entry, number of bytes to read/write. On successful
  310. * return, number of bytes actually read/written. In case of
  311. * error, this may indicate at what point the error occurred.
  312. * @data: Buffer to read/write from
  313. *
  314. * Users may use %ETHTOOL_GDRVINFO or %ETHTOOL_GMODULEINFO to find
  315. * the length of an on-board or module EEPROM, respectively. They
  316. * must allocate the buffer immediately following this structure.
  317. */
  318. struct ethtool_eeprom {
  319. uint32_t cmd;
  320. uint32_t magic;
  321. uint32_t offset;
  322. uint32_t len;
  323. uint8_t data[];
  324. };
  325. /**
  326. * struct ethtool_eee - Energy Efficient Ethernet information
  327. * @cmd: ETHTOOL_{G,S}EEE
  328. * @supported: Mask of %SUPPORTED_* flags for the speed/duplex combinations
  329. * for which there is EEE support.
  330. * @advertised: Mask of %ADVERTISED_* flags for the speed/duplex combinations
  331. * advertised as eee capable.
  332. * @lp_advertised: Mask of %ADVERTISED_* flags for the speed/duplex
  333. * combinations advertised by the link partner as eee capable.
  334. * @eee_active: Result of the eee auto negotiation.
  335. * @eee_enabled: EEE configured mode (enabled/disabled).
  336. * @tx_lpi_enabled: Whether the interface should assert its tx lpi, given
  337. * that eee was negotiated.
  338. * @tx_lpi_timer: Time in microseconds the interface delays prior to asserting
  339. * its tx lpi (after reaching 'idle' state). Effective only when eee
  340. * was negotiated and tx_lpi_enabled was set.
  341. * @reserved: Reserved for future use; see the note on reserved space.
  342. */
  343. struct ethtool_eee {
  344. uint32_t cmd;
  345. uint32_t supported;
  346. uint32_t advertised;
  347. uint32_t lp_advertised;
  348. uint32_t eee_active;
  349. uint32_t eee_enabled;
  350. uint32_t tx_lpi_enabled;
  351. uint32_t tx_lpi_timer;
  352. uint32_t reserved[2];
  353. };
  354. /**
  355. * struct ethtool_modinfo - plugin module eeprom information
  356. * @cmd: %ETHTOOL_GMODULEINFO
  357. * @type: Standard the module information conforms to %ETH_MODULE_SFF_xxxx
  358. * @eeprom_len: Length of the eeprom
  359. * @reserved: Reserved for future use; see the note on reserved space.
  360. *
  361. * This structure is used to return the information to
  362. * properly size memory for a subsequent call to %ETHTOOL_GMODULEEEPROM.
  363. * The type code indicates the eeprom data format
  364. */
  365. struct ethtool_modinfo {
  366. uint32_t cmd;
  367. uint32_t type;
  368. uint32_t eeprom_len;
  369. uint32_t reserved[8];
  370. };
  371. /**
  372. * struct ethtool_coalesce - coalescing parameters for IRQs and stats updates
  373. * @cmd: ETHTOOL_{G,S}COALESCE
  374. * @rx_coalesce_usecs: How many usecs to delay an RX interrupt after
  375. * a packet arrives.
  376. * @rx_max_coalesced_frames: Maximum number of packets to receive
  377. * before an RX interrupt.
  378. * @rx_coalesce_usecs_irq: Same as @rx_coalesce_usecs, except that
  379. * this value applies while an IRQ is being serviced by the host.
  380. * @rx_max_coalesced_frames_irq: Same as @rx_max_coalesced_frames,
  381. * except that this value applies while an IRQ is being serviced
  382. * by the host.
  383. * @tx_coalesce_usecs: How many usecs to delay a TX interrupt after
  384. * a packet is sent.
  385. * @tx_max_coalesced_frames: Maximum number of packets to be sent
  386. * before a TX interrupt.
  387. * @tx_coalesce_usecs_irq: Same as @tx_coalesce_usecs, except that
  388. * this value applies while an IRQ is being serviced by the host.
  389. * @tx_max_coalesced_frames_irq: Same as @tx_max_coalesced_frames,
  390. * except that this value applies while an IRQ is being serviced
  391. * by the host.
  392. * @stats_block_coalesce_usecs: How many usecs to delay in-memory
  393. * statistics block updates. Some drivers do not have an
  394. * in-memory statistic block, and in such cases this value is
  395. * ignored. This value must not be zero.
  396. * @use_adaptive_rx_coalesce: Enable adaptive RX coalescing.
  397. * @use_adaptive_tx_coalesce: Enable adaptive TX coalescing.
  398. * @pkt_rate_low: Threshold for low packet rate (packets per second).
  399. * @rx_coalesce_usecs_low: How many usecs to delay an RX interrupt after
  400. * a packet arrives, when the packet rate is below @pkt_rate_low.
  401. * @rx_max_coalesced_frames_low: Maximum number of packets to be received
  402. * before an RX interrupt, when the packet rate is below @pkt_rate_low.
  403. * @tx_coalesce_usecs_low: How many usecs to delay a TX interrupt after
  404. * a packet is sent, when the packet rate is below @pkt_rate_low.
  405. * @tx_max_coalesced_frames_low: Maximum nuumber of packets to be sent before
  406. * a TX interrupt, when the packet rate is below @pkt_rate_low.
  407. * @pkt_rate_high: Threshold for high packet rate (packets per second).
  408. * @rx_coalesce_usecs_high: How many usecs to delay an RX interrupt after
  409. * a packet arrives, when the packet rate is above @pkt_rate_high.
  410. * @rx_max_coalesced_frames_high: Maximum number of packets to be received
  411. * before an RX interrupt, when the packet rate is above @pkt_rate_high.
  412. * @tx_coalesce_usecs_high: How many usecs to delay a TX interrupt after
  413. * a packet is sent, when the packet rate is above @pkt_rate_high.
  414. * @tx_max_coalesced_frames_high: Maximum number of packets to be sent before
  415. * a TX interrupt, when the packet rate is above @pkt_rate_high.
  416. * @rate_sample_interval: How often to do adaptive coalescing packet rate
  417. * sampling, measured in seconds. Must not be zero.
  418. *
  419. * Each pair of (usecs, max_frames) fields specifies that interrupts
  420. * should be coalesced until
  421. * (usecs > 0 && time_since_first_completion >= usecs) ||
  422. * (max_frames > 0 && completed_frames >= max_frames)
  423. *
  424. * It is illegal to set both usecs and max_frames to zero as this
  425. * would cause interrupts to never be generated. To disable
  426. * coalescing, set usecs = 0 and max_frames = 1.
  427. *
  428. * Some implementations ignore the value of max_frames and use the
  429. * condition time_since_first_completion >= usecs
  430. *
  431. * This is deprecated. Drivers for hardware that does not support
  432. * counting completions should validate that max_frames == !rx_usecs.
  433. *
  434. * Adaptive RX/TX coalescing is an algorithm implemented by some
  435. * drivers to improve latency under low packet rates and improve
  436. * throughput under high packet rates. Some drivers only implement
  437. * one of RX or TX adaptive coalescing. Anything not implemented by
  438. * the driver causes these values to be silently ignored.
  439. *
  440. * When the packet rate is below @pkt_rate_high but above
  441. * @pkt_rate_low (both measured in packets per second) the
  442. * normal {rx,tx}_* coalescing parameters are used.
  443. */
  444. struct ethtool_coalesce {
  445. uint32_t cmd;
  446. uint32_t rx_coalesce_usecs;
  447. uint32_t rx_max_coalesced_frames;
  448. uint32_t rx_coalesce_usecs_irq;
  449. uint32_t rx_max_coalesced_frames_irq;
  450. uint32_t tx_coalesce_usecs;
  451. uint32_t tx_max_coalesced_frames;
  452. uint32_t tx_coalesce_usecs_irq;
  453. uint32_t tx_max_coalesced_frames_irq;
  454. uint32_t stats_block_coalesce_usecs;
  455. uint32_t use_adaptive_rx_coalesce;
  456. uint32_t use_adaptive_tx_coalesce;
  457. uint32_t pkt_rate_low;
  458. uint32_t rx_coalesce_usecs_low;
  459. uint32_t rx_max_coalesced_frames_low;
  460. uint32_t tx_coalesce_usecs_low;
  461. uint32_t tx_max_coalesced_frames_low;
  462. uint32_t pkt_rate_high;
  463. uint32_t rx_coalesce_usecs_high;
  464. uint32_t rx_max_coalesced_frames_high;
  465. uint32_t tx_coalesce_usecs_high;
  466. uint32_t tx_max_coalesced_frames_high;
  467. uint32_t rate_sample_interval;
  468. };
  469. /**
  470. * struct ethtool_ringparam - RX/TX ring parameters
  471. * @cmd: Command number = %ETHTOOL_GRINGPARAM or %ETHTOOL_SRINGPARAM
  472. * @rx_max_pending: Maximum supported number of pending entries per
  473. * RX ring. Read-only.
  474. * @rx_mini_max_pending: Maximum supported number of pending entries
  475. * per RX mini ring. Read-only.
  476. * @rx_jumbo_max_pending: Maximum supported number of pending entries
  477. * per RX jumbo ring. Read-only.
  478. * @tx_max_pending: Maximum supported number of pending entries per
  479. * TX ring. Read-only.
  480. * @rx_pending: Current maximum number of pending entries per RX ring
  481. * @rx_mini_pending: Current maximum number of pending entries per RX
  482. * mini ring
  483. * @rx_jumbo_pending: Current maximum number of pending entries per RX
  484. * jumbo ring
  485. * @tx_pending: Current maximum supported number of pending entries
  486. * per TX ring
  487. *
  488. * If the interface does not have separate RX mini and/or jumbo rings,
  489. * @rx_mini_max_pending and/or @rx_jumbo_max_pending will be 0.
  490. *
  491. * There may also be driver-dependent minimum values for the number
  492. * of entries per ring.
  493. */
  494. struct ethtool_ringparam {
  495. uint32_t cmd;
  496. uint32_t rx_max_pending;
  497. uint32_t rx_mini_max_pending;
  498. uint32_t rx_jumbo_max_pending;
  499. uint32_t tx_max_pending;
  500. uint32_t rx_pending;
  501. uint32_t rx_mini_pending;
  502. uint32_t rx_jumbo_pending;
  503. uint32_t tx_pending;
  504. };
  505. /**
  506. * struct ethtool_channels - configuring number of network channel
  507. * @cmd: ETHTOOL_{G,S}CHANNELS
  508. * @max_rx: Read only. Maximum number of receive channel the driver support.
  509. * @max_tx: Read only. Maximum number of transmit channel the driver support.
  510. * @max_other: Read only. Maximum number of other channel the driver support.
  511. * @max_combined: Read only. Maximum number of combined channel the driver
  512. * support. Set of queues RX, TX or other.
  513. * @rx_count: Valid values are in the range 1 to the max_rx.
  514. * @tx_count: Valid values are in the range 1 to the max_tx.
  515. * @other_count: Valid values are in the range 1 to the max_other.
  516. * @combined_count: Valid values are in the range 1 to the max_combined.
  517. *
  518. * This can be used to configure RX, TX and other channels.
  519. */
  520. struct ethtool_channels {
  521. uint32_t cmd;
  522. uint32_t max_rx;
  523. uint32_t max_tx;
  524. uint32_t max_other;
  525. uint32_t max_combined;
  526. uint32_t rx_count;
  527. uint32_t tx_count;
  528. uint32_t other_count;
  529. uint32_t combined_count;
  530. };
  531. /**
  532. * struct ethtool_pauseparam - Ethernet pause (flow control) parameters
  533. * @cmd: Command number = %ETHTOOL_GPAUSEPARAM or %ETHTOOL_SPAUSEPARAM
  534. * @autoneg: Flag to enable autonegotiation of pause frame use
  535. * @rx_pause: Flag to enable reception of pause frames
  536. * @tx_pause: Flag to enable transmission of pause frames
  537. *
  538. * Drivers should reject a non-zero setting of @autoneg when
  539. * autoneogotiation is disabled (or not supported) for the link.
  540. *
  541. * If the link is autonegotiated, drivers should use
  542. * mii_advertise_flowctrl() or similar code to set the advertised
  543. * pause frame capabilities based on the @rx_pause and @tx_pause flags,
  544. * even if @autoneg is zero. They should also allow the advertised
  545. * pause frame capabilities to be controlled directly through the
  546. * advertising field of &struct ethtool_cmd.
  547. *
  548. * If @autoneg is non-zero, the MAC is configured to send and/or
  549. * receive pause frames according to the result of autonegotiation.
  550. * Otherwise, it is configured directly based on the @rx_pause and
  551. * @tx_pause flags.
  552. */
  553. struct ethtool_pauseparam {
  554. uint32_t cmd;
  555. uint32_t autoneg;
  556. uint32_t rx_pause;
  557. uint32_t tx_pause;
  558. };
  559. /* Link extended state */
  560. enum ethtool_link_ext_state {
  561. ETHTOOL_LINK_EXT_STATE_AUTONEG,
  562. ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE,
  563. ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH,
  564. ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY,
  565. ETHTOOL_LINK_EXT_STATE_NO_CABLE,
  566. ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE,
  567. ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE,
  568. ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE,
  569. ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED,
  570. ETHTOOL_LINK_EXT_STATE_OVERHEAT,
  571. ETHTOOL_LINK_EXT_STATE_MODULE,
  572. };
  573. /* More information in addition to ETHTOOL_LINK_EXT_STATE_AUTONEG. */
  574. enum ethtool_link_ext_substate_autoneg {
  575. ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED = 1,
  576. ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED,
  577. ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED,
  578. ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE,
  579. ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE,
  580. ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD,
  581. };
  582. /* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE.
  583. */
  584. enum ethtool_link_ext_substate_link_training {
  585. ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED = 1,
  586. ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT,
  587. ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY,
  588. ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT,
  589. };
  590. /* More information in addition to ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH.
  591. */
  592. enum ethtool_link_ext_substate_link_logical_mismatch {
  593. ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK = 1,
  594. ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK,
  595. ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS,
  596. ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED,
  597. ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED,
  598. };
  599. /* More information in addition to ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY.
  600. */
  601. enum ethtool_link_ext_substate_bad_signal_integrity {
  602. ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS = 1,
  603. ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE,
  604. ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_REFERENCE_CLOCK_LOST,
  605. ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_ALOS,
  606. };
  607. /* More information in addition to ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE. */
  608. enum ethtool_link_ext_substate_cable_issue {
  609. ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE = 1,
  610. ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE,
  611. };
  612. /* More information in addition to ETHTOOL_LINK_EXT_STATE_MODULE. */
  613. enum ethtool_link_ext_substate_module {
  614. ETHTOOL_LINK_EXT_SUBSTATE_MODULE_CMIS_NOT_READY = 1,
  615. };
  616. #define ETH_GSTRING_LEN 32
  617. /**
  618. * enum ethtool_stringset - string set ID
  619. * @ETH_SS_TEST: Self-test result names, for use with %ETHTOOL_TEST
  620. * @ETH_SS_STATS: Statistic names, for use with %ETHTOOL_GSTATS
  621. * @ETH_SS_PRIV_FLAGS: Driver private flag names, for use with
  622. * %ETHTOOL_GPFLAGS and %ETHTOOL_SPFLAGS
  623. * @ETH_SS_NTUPLE_FILTERS: Previously used with %ETHTOOL_GRXNTUPLE;
  624. * now deprecated
  625. * @ETH_SS_FEATURES: Device feature names
  626. * @ETH_SS_RSS_HASH_FUNCS: RSS hush function names
  627. * @ETH_SS_TUNABLES: tunable names
  628. * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS
  629. * @ETH_SS_PHY_TUNABLES: PHY tunable names
  630. * @ETH_SS_LINK_MODES: link mode names
  631. * @ETH_SS_MSG_CLASSES: debug message class names
  632. * @ETH_SS_WOL_MODES: wake-on-lan modes
  633. * @ETH_SS_SOF_TIMESTAMPING: SOF_TIMESTAMPING_* flags
  634. * @ETH_SS_TS_TX_TYPES: timestamping Tx types
  635. * @ETH_SS_TS_RX_FILTERS: timestamping Rx filters
  636. * @ETH_SS_UDP_TUNNEL_TYPES: UDP tunnel types
  637. * @ETH_SS_STATS_STD: standardized stats
  638. * @ETH_SS_STATS_ETH_PHY: names of IEEE 802.3 PHY statistics
  639. * @ETH_SS_STATS_ETH_MAC: names of IEEE 802.3 MAC statistics
  640. * @ETH_SS_STATS_ETH_CTRL: names of IEEE 802.3 MAC Control statistics
  641. * @ETH_SS_STATS_RMON: names of RMON statistics
  642. * @ETH_SS_STATS_PHY: names of PHY(dev) statistics
  643. * @ETH_SS_TS_FLAGS: hardware timestamping flags
  644. *
  645. * @ETH_SS_COUNT: number of defined string sets
  646. */
  647. enum ethtool_stringset {
  648. ETH_SS_TEST = 0,
  649. ETH_SS_STATS,
  650. ETH_SS_PRIV_FLAGS,
  651. ETH_SS_NTUPLE_FILTERS,
  652. ETH_SS_FEATURES,
  653. ETH_SS_RSS_HASH_FUNCS,
  654. ETH_SS_TUNABLES,
  655. ETH_SS_PHY_STATS,
  656. ETH_SS_PHY_TUNABLES,
  657. ETH_SS_LINK_MODES,
  658. ETH_SS_MSG_CLASSES,
  659. ETH_SS_WOL_MODES,
  660. ETH_SS_SOF_TIMESTAMPING,
  661. ETH_SS_TS_TX_TYPES,
  662. ETH_SS_TS_RX_FILTERS,
  663. ETH_SS_UDP_TUNNEL_TYPES,
  664. ETH_SS_STATS_STD,
  665. ETH_SS_STATS_ETH_PHY,
  666. ETH_SS_STATS_ETH_MAC,
  667. ETH_SS_STATS_ETH_CTRL,
  668. ETH_SS_STATS_RMON,
  669. ETH_SS_STATS_PHY,
  670. ETH_SS_TS_FLAGS,
  671. /* add new constants above here */
  672. ETH_SS_COUNT
  673. };
  674. /**
  675. * enum ethtool_mac_stats_src - source of ethtool MAC statistics
  676. * @ETHTOOL_MAC_STATS_SRC_AGGREGATE:
  677. * if device supports a MAC merge layer, this retrieves the aggregate
  678. * statistics of the eMAC and pMAC. Otherwise, it retrieves just the
  679. * statistics of the single (express) MAC.
  680. * @ETHTOOL_MAC_STATS_SRC_EMAC:
  681. * if device supports a MM layer, this retrieves the eMAC statistics.
  682. * Otherwise, it retrieves the statistics of the single (express) MAC.
  683. * @ETHTOOL_MAC_STATS_SRC_PMAC:
  684. * if device supports a MM layer, this retrieves the pMAC statistics.
  685. */
  686. enum ethtool_mac_stats_src {
  687. ETHTOOL_MAC_STATS_SRC_AGGREGATE,
  688. ETHTOOL_MAC_STATS_SRC_EMAC,
  689. ETHTOOL_MAC_STATS_SRC_PMAC,
  690. };
  691. /**
  692. * enum ethtool_module_power_mode_policy - plug-in module power mode policy
  693. * @ETHTOOL_MODULE_POWER_MODE_POLICY_HIGH: Module is always in high power mode.
  694. * @ETHTOOL_MODULE_POWER_MODE_POLICY_AUTO: Module is transitioned by the host
  695. * to high power mode when the first port using it is put administratively
  696. * up and to low power mode when the last port using it is put
  697. * administratively down.
  698. */
  699. enum ethtool_module_power_mode_policy {
  700. ETHTOOL_MODULE_POWER_MODE_POLICY_HIGH = 1,
  701. ETHTOOL_MODULE_POWER_MODE_POLICY_AUTO,
  702. };
  703. /**
  704. * enum ethtool_module_power_mode - plug-in module power mode
  705. * @ETHTOOL_MODULE_POWER_MODE_LOW: Module is in low power mode.
  706. * @ETHTOOL_MODULE_POWER_MODE_HIGH: Module is in high power mode.
  707. */
  708. enum ethtool_module_power_mode {
  709. ETHTOOL_MODULE_POWER_MODE_LOW = 1,
  710. ETHTOOL_MODULE_POWER_MODE_HIGH,
  711. };
  712. /**
  713. * enum ethtool_c33_pse_ext_state - groups of PSE extended states
  714. * functions. IEEE 802.3-2022 33.2.4.4 Variables
  715. *
  716. * @ETHTOOL_C33_PSE_EXT_STATE_ERROR_CONDITION: Group of error_condition states
  717. * @ETHTOOL_C33_PSE_EXT_STATE_MR_MPS_VALID: Group of mr_mps_valid states
  718. * @ETHTOOL_C33_PSE_EXT_STATE_MR_PSE_ENABLE: Group of mr_pse_enable states
  719. * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_DETECT_TED: Group of option_detect_ted
  720. * states
  721. * @ETHTOOL_C33_PSE_EXT_STATE_OPTION_VPORT_LIM: Group of option_vport_lim states
  722. * @ETHTOOL_C33_PSE_EXT_STATE_OVLD_DETECTED: Group of ovld_detected states
  723. * @ETHTOOL_C33_PSE_EXT_STATE_PD_DLL_POWER_TYPE: Group of pd_dll_power_type
  724. * states
  725. * @ETHTOOL_C33_PSE_EXT_STATE_POWER_NOT_AVAILABLE: Group of power_not_available
  726. * states
  727. * @ETHTOOL_C33_PSE_EXT_STATE_SHORT_DETECTED: Group of short_detected states
  728. */
  729. enum ethtool_c33_pse_ext_state {
  730. ETHTOOL_C33_PSE_EXT_STATE_ERROR_CONDITION = 1,
  731. ETHTOOL_C33_PSE_EXT_STATE_MR_MPS_VALID,
  732. ETHTOOL_C33_PSE_EXT_STATE_MR_PSE_ENABLE,
  733. ETHTOOL_C33_PSE_EXT_STATE_OPTION_DETECT_TED,
  734. ETHTOOL_C33_PSE_EXT_STATE_OPTION_VPORT_LIM,
  735. ETHTOOL_C33_PSE_EXT_STATE_OVLD_DETECTED,
  736. ETHTOOL_C33_PSE_EXT_STATE_PD_DLL_POWER_TYPE,
  737. ETHTOOL_C33_PSE_EXT_STATE_POWER_NOT_AVAILABLE,
  738. ETHTOOL_C33_PSE_EXT_STATE_SHORT_DETECTED,
  739. };
  740. /**
  741. * enum ethtool_c33_pse_ext_substate_mr_mps_valid - mr_mps_valid states
  742. * functions. IEEE 802.3-2022 33.2.4.4 Variables
  743. *
  744. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_DETECTED_UNDERLOAD: Underload
  745. * state
  746. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_CONNECTION_OPEN: Port is not
  747. * connected
  748. *
  749. * The PSE monitors either the DC or AC Maintain Power Signature
  750. * (MPS, see 33.2.9.1). This variable indicates the presence or absence of
  751. * a valid MPS.
  752. */
  753. enum ethtool_c33_pse_ext_substate_mr_mps_valid {
  754. ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_DETECTED_UNDERLOAD = 1,
  755. ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_MPS_VALID_CONNECTION_OPEN,
  756. };
  757. /**
  758. * enum ethtool_c33_pse_ext_substate_error_condition - error_condition states
  759. * functions. IEEE 802.3-2022 33.2.4.4 Variables
  760. *
  761. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_NON_EXISTING_PORT: Non-existing
  762. * port number
  763. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNDEFINED_PORT: Undefined port
  764. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_INTERNAL_HW_FAULT: Internal
  765. * hardware fault
  766. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_COMM_ERROR_AFTER_FORCE_ON:
  767. * Communication error after force on
  768. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNKNOWN_PORT_STATUS: Unknown
  769. * port status
  770. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_TURN_OFF: Host
  771. * crash turn off
  772. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_FORCE_SHUTDOWN:
  773. * Host crash force shutdown
  774. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_CONFIG_CHANGE: Configuration
  775. * change
  776. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_DETECTED_OVER_TEMP: Over
  777. * temperature detected
  778. *
  779. * error_condition is a variable indicating the status of
  780. * implementation-specific fault conditions or optionally other system faults
  781. * that prevent the PSE from meeting the specifications in Table 33–11 and that
  782. * require the PSE not to source power. These error conditions are different
  783. * from those monitored by the state diagrams in Figure 33–10.
  784. */
  785. enum ethtool_c33_pse_ext_substate_error_condition {
  786. ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_NON_EXISTING_PORT = 1,
  787. ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNDEFINED_PORT,
  788. ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_INTERNAL_HW_FAULT,
  789. ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_COMM_ERROR_AFTER_FORCE_ON,
  790. ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_UNKNOWN_PORT_STATUS,
  791. ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_TURN_OFF,
  792. ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_HOST_CRASH_FORCE_SHUTDOWN,
  793. ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_CONFIG_CHANGE,
  794. ETHTOOL_C33_PSE_EXT_SUBSTATE_ERROR_CONDITION_DETECTED_OVER_TEMP,
  795. };
  796. /**
  797. * enum ethtool_c33_pse_ext_substate_mr_pse_enable - mr_pse_enable states
  798. * functions. IEEE 802.3-2022 33.2.4.4 Variables
  799. *
  800. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_PSE_ENABLE_DISABLE_PIN_ACTIVE: Disable
  801. * pin active
  802. *
  803. * mr_pse_enable is control variable that selects PSE operation and test
  804. * functions.
  805. */
  806. enum ethtool_c33_pse_ext_substate_mr_pse_enable {
  807. ETHTOOL_C33_PSE_EXT_SUBSTATE_MR_PSE_ENABLE_DISABLE_PIN_ACTIVE = 1,
  808. };
  809. /**
  810. * enum ethtool_c33_pse_ext_substate_option_detect_ted - option_detect_ted
  811. * states functions. IEEE 802.3-2022 33.2.4.4 Variables
  812. *
  813. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_DET_IN_PROCESS: Detection
  814. * in process
  815. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_CONNECTION_CHECK_ERROR:
  816. * Connection check error
  817. *
  818. * option_detect_ted is a variable indicating if detection can be performed
  819. * by the PSE during the ted_timer interval.
  820. */
  821. enum ethtool_c33_pse_ext_substate_option_detect_ted {
  822. ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_DET_IN_PROCESS = 1,
  823. ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_DETECT_TED_CONNECTION_CHECK_ERROR,
  824. };
  825. /**
  826. * enum ethtool_c33_pse_ext_substate_option_vport_lim - option_vport_lim states
  827. * functions. IEEE 802.3-2022 33.2.4.4 Variables
  828. *
  829. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_HIGH_VOLTAGE: Main supply
  830. * voltage is high
  831. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_LOW_VOLTAGE: Main supply
  832. * voltage is low
  833. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_VOLTAGE_INJECTION: Voltage
  834. * injection into the port
  835. *
  836. * option_vport_lim is an optional variable indicates if VPSE is out of the
  837. * operating range during normal operating state.
  838. */
  839. enum ethtool_c33_pse_ext_substate_option_vport_lim {
  840. ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_HIGH_VOLTAGE = 1,
  841. ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_LOW_VOLTAGE,
  842. ETHTOOL_C33_PSE_EXT_SUBSTATE_OPTION_VPORT_LIM_VOLTAGE_INJECTION,
  843. };
  844. /**
  845. * enum ethtool_c33_pse_ext_substate_ovld_detected - ovld_detected states
  846. * functions. IEEE 802.3-2022 33.2.4.4 Variables
  847. *
  848. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_OVLD_DETECTED_OVERLOAD: Overload state
  849. *
  850. * ovld_detected is a variable indicating if the PSE output current has been
  851. * in an overload condition (see 33.2.7.6) for at least TCUT of a one-second
  852. * sliding time.
  853. */
  854. enum ethtool_c33_pse_ext_substate_ovld_detected {
  855. ETHTOOL_C33_PSE_EXT_SUBSTATE_OVLD_DETECTED_OVERLOAD = 1,
  856. };
  857. /**
  858. * enum ethtool_c33_pse_ext_substate_power_not_available - power_not_available
  859. * states functions. IEEE 802.3-2022 33.2.4.4 Variables
  860. *
  861. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_BUDGET_EXCEEDED: Power
  862. * budget exceeded for the controller
  863. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PORT_PW_LIMIT_EXCEEDS_CONTROLLER_BUDGET:
  864. * Configured port power limit exceeded controller power budget
  865. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PD_REQUEST_EXCEEDS_PORT_LIMIT:
  866. * Power request from PD exceeds port limit
  867. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_HW_PW_LIMIT: Power
  868. * denied due to Hardware power limit
  869. *
  870. * power_not_available is a variable that is asserted in an
  871. * implementation-dependent manner when the PSE is no longer capable of
  872. * sourcing sufficient power to support the attached PD. Sufficient power
  873. * is defined by classification; see 33.2.6.
  874. */
  875. enum ethtool_c33_pse_ext_substate_power_not_available {
  876. ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_BUDGET_EXCEEDED = 1,
  877. ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PORT_PW_LIMIT_EXCEEDS_CONTROLLER_BUDGET,
  878. ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_PD_REQUEST_EXCEEDS_PORT_LIMIT,
  879. ETHTOOL_C33_PSE_EXT_SUBSTATE_POWER_NOT_AVAILABLE_HW_PW_LIMIT,
  880. };
  881. /**
  882. * enum ethtool_c33_pse_ext_substate_short_detected - short_detected states
  883. * functions. IEEE 802.3-2022 33.2.4.4 Variables
  884. *
  885. * @ETHTOOL_C33_PSE_EXT_SUBSTATE_SHORT_DETECTED_SHORT_CONDITION: Short
  886. * condition was detected
  887. *
  888. * short_detected is a variable indicating if the PSE output current has been
  889. * in a short circuit condition for TLIM within a sliding window (see 33.2.7.7).
  890. */
  891. enum ethtool_c33_pse_ext_substate_short_detected {
  892. ETHTOOL_C33_PSE_EXT_SUBSTATE_SHORT_DETECTED_SHORT_CONDITION = 1,
  893. };
  894. /**
  895. * enum ethtool_pse_types - Types of PSE controller.
  896. * @ETHTOOL_PSE_UNKNOWN: Type of PSE controller is unknown
  897. * @ETHTOOL_PSE_PODL: PSE controller which support PoDL
  898. * @ETHTOOL_PSE_C33: PSE controller which support Clause 33 (PoE)
  899. */
  900. enum ethtool_pse_types {
  901. ETHTOOL_PSE_UNKNOWN = 1 << 0,
  902. ETHTOOL_PSE_PODL = 1 << 1,
  903. ETHTOOL_PSE_C33 = 1 << 2,
  904. };
  905. /**
  906. * enum ethtool_c33_pse_admin_state - operational state of the PoDL PSE
  907. * functions. IEEE 802.3-2022 30.9.1.1.2 aPSEAdminState
  908. * @ETHTOOL_C33_PSE_ADMIN_STATE_UNKNOWN: state of PSE functions is unknown
  909. * @ETHTOOL_C33_PSE_ADMIN_STATE_DISABLED: PSE functions are disabled
  910. * @ETHTOOL_C33_PSE_ADMIN_STATE_ENABLED: PSE functions are enabled
  911. */
  912. enum ethtool_c33_pse_admin_state {
  913. ETHTOOL_C33_PSE_ADMIN_STATE_UNKNOWN = 1,
  914. ETHTOOL_C33_PSE_ADMIN_STATE_DISABLED,
  915. ETHTOOL_C33_PSE_ADMIN_STATE_ENABLED,
  916. };
  917. /**
  918. * enum ethtool_c33_pse_pw_d_status - power detection status of the PSE.
  919. * IEEE 802.3-2022 30.9.1.1.3 aPoDLPSEPowerDetectionStatus:
  920. * @ETHTOOL_C33_PSE_PW_D_STATUS_UNKNOWN: PSE status is unknown
  921. * @ETHTOOL_C33_PSE_PW_D_STATUS_DISABLED: The enumeration "disabled"
  922. * indicates that the PSE State diagram is in the state DISABLED.
  923. * @ETHTOOL_C33_PSE_PW_D_STATUS_SEARCHING: The enumeration "searching"
  924. * indicates the PSE State diagram is in a state other than those
  925. * listed.
  926. * @ETHTOOL_C33_PSE_PW_D_STATUS_DELIVERING: The enumeration
  927. * "deliveringPower" indicates that the PSE State diagram is in the
  928. * state POWER_ON.
  929. * @ETHTOOL_C33_PSE_PW_D_STATUS_TEST: The enumeration "test" indicates that
  930. * the PSE State diagram is in the state TEST_MODE.
  931. * @ETHTOOL_C33_PSE_PW_D_STATUS_FAULT: The enumeration "fault" indicates that
  932. * the PSE State diagram is in the state TEST_ERROR.
  933. * @ETHTOOL_C33_PSE_PW_D_STATUS_OTHERFAULT: The enumeration "otherFault"
  934. * indicates that the PSE State diagram is in the state IDLE due to
  935. * the variable error_condition = true.
  936. */
  937. enum ethtool_c33_pse_pw_d_status {
  938. ETHTOOL_C33_PSE_PW_D_STATUS_UNKNOWN = 1,
  939. ETHTOOL_C33_PSE_PW_D_STATUS_DISABLED,
  940. ETHTOOL_C33_PSE_PW_D_STATUS_SEARCHING,
  941. ETHTOOL_C33_PSE_PW_D_STATUS_DELIVERING,
  942. ETHTOOL_C33_PSE_PW_D_STATUS_TEST,
  943. ETHTOOL_C33_PSE_PW_D_STATUS_FAULT,
  944. ETHTOOL_C33_PSE_PW_D_STATUS_OTHERFAULT,
  945. };
  946. /**
  947. * enum ethtool_podl_pse_admin_state - operational state of the PoDL PSE
  948. * functions. IEEE 802.3-2018 30.15.1.1.2 aPoDLPSEAdminState
  949. * @ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN: state of PoDL PSE functions are
  950. * unknown
  951. * @ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED: PoDL PSE functions are disabled
  952. * @ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED: PoDL PSE functions are enabled
  953. */
  954. enum ethtool_podl_pse_admin_state {
  955. ETHTOOL_PODL_PSE_ADMIN_STATE_UNKNOWN = 1,
  956. ETHTOOL_PODL_PSE_ADMIN_STATE_DISABLED,
  957. ETHTOOL_PODL_PSE_ADMIN_STATE_ENABLED,
  958. };
  959. /**
  960. * enum ethtool_podl_pse_pw_d_status - power detection status of the PoDL PSE.
  961. * IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPowerDetectionStatus:
  962. * @ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN: PoDL PSE
  963. * @ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED: "The enumeration “disabled” is
  964. * asserted true when the PoDL PSE state diagram variable mr_pse_enable is
  965. * false"
  966. * @ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING: "The enumeration “searching” is
  967. * asserted true when either of the PSE state diagram variables
  968. * pi_detecting or pi_classifying is true."
  969. * @ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING: "The enumeration “deliveringPower”
  970. * is asserted true when the PoDL PSE state diagram variable pi_powered is
  971. * true."
  972. * @ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP: "The enumeration “sleep” is asserted
  973. * true when the PoDL PSE state diagram variable pi_sleeping is true."
  974. * @ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE: "The enumeration “idle” is asserted true
  975. * when the logical combination of the PoDL PSE state diagram variables
  976. * pi_prebiased*!pi_sleeping is true."
  977. * @ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR: "The enumeration “error” is asserted
  978. * true when the PoDL PSE state diagram variable overload_held is true."
  979. */
  980. enum ethtool_podl_pse_pw_d_status {
  981. ETHTOOL_PODL_PSE_PW_D_STATUS_UNKNOWN = 1,
  982. ETHTOOL_PODL_PSE_PW_D_STATUS_DISABLED,
  983. ETHTOOL_PODL_PSE_PW_D_STATUS_SEARCHING,
  984. ETHTOOL_PODL_PSE_PW_D_STATUS_DELIVERING,
  985. ETHTOOL_PODL_PSE_PW_D_STATUS_SLEEP,
  986. ETHTOOL_PODL_PSE_PW_D_STATUS_IDLE,
  987. ETHTOOL_PODL_PSE_PW_D_STATUS_ERROR,
  988. };
  989. /**
  990. * enum ethtool_mm_verify_status - status of MAC Merge Verify function
  991. * @ETHTOOL_MM_VERIFY_STATUS_UNKNOWN:
  992. * verification status is unknown
  993. * @ETHTOOL_MM_VERIFY_STATUS_INITIAL:
  994. * the 802.3 Verify State diagram is in the state INIT_VERIFICATION
  995. * @ETHTOOL_MM_VERIFY_STATUS_VERIFYING:
  996. * the Verify State diagram is in the state VERIFICATION_IDLE,
  997. * SEND_VERIFY or WAIT_FOR_RESPONSE
  998. * @ETHTOOL_MM_VERIFY_STATUS_SUCCEEDED:
  999. * indicates that the Verify State diagram is in the state VERIFIED
  1000. * @ETHTOOL_MM_VERIFY_STATUS_FAILED:
  1001. * the Verify State diagram is in the state VERIFY_FAIL
  1002. * @ETHTOOL_MM_VERIFY_STATUS_DISABLED:
  1003. * verification of preemption operation is disabled
  1004. */
  1005. enum ethtool_mm_verify_status {
  1006. ETHTOOL_MM_VERIFY_STATUS_UNKNOWN,
  1007. ETHTOOL_MM_VERIFY_STATUS_INITIAL,
  1008. ETHTOOL_MM_VERIFY_STATUS_VERIFYING,
  1009. ETHTOOL_MM_VERIFY_STATUS_SUCCEEDED,
  1010. ETHTOOL_MM_VERIFY_STATUS_FAILED,
  1011. ETHTOOL_MM_VERIFY_STATUS_DISABLED,
  1012. };
  1013. /**
  1014. * enum ethtool_module_fw_flash_status - plug-in module firmware flashing status
  1015. * @ETHTOOL_MODULE_FW_FLASH_STATUS_STARTED: The firmware flashing process has
  1016. * started.
  1017. * @ETHTOOL_MODULE_FW_FLASH_STATUS_IN_PROGRESS: The firmware flashing process
  1018. * is in progress.
  1019. * @ETHTOOL_MODULE_FW_FLASH_STATUS_COMPLETED: The firmware flashing process was
  1020. * completed successfully.
  1021. * @ETHTOOL_MODULE_FW_FLASH_STATUS_ERROR: The firmware flashing process was
  1022. * stopped due to an error.
  1023. */
  1024. enum ethtool_module_fw_flash_status {
  1025. ETHTOOL_MODULE_FW_FLASH_STATUS_STARTED = 1,
  1026. ETHTOOL_MODULE_FW_FLASH_STATUS_IN_PROGRESS,
  1027. ETHTOOL_MODULE_FW_FLASH_STATUS_COMPLETED,
  1028. ETHTOOL_MODULE_FW_FLASH_STATUS_ERROR,
  1029. };
  1030. /**
  1031. * struct ethtool_gstrings - string set for data tagging
  1032. * @cmd: Command number = %ETHTOOL_GSTRINGS
  1033. * @string_set: String set ID; one of &enum ethtool_stringset
  1034. * @len: On return, the number of strings in the string set
  1035. * @data: Buffer for strings. Each string is null-padded to a size of
  1036. * %ETH_GSTRING_LEN.
  1037. *
  1038. * Users must use %ETHTOOL_GSSET_INFO to find the number of strings in
  1039. * the string set. They must allocate a buffer of the appropriate
  1040. * size immediately following this structure.
  1041. */
  1042. struct ethtool_gstrings {
  1043. uint32_t cmd;
  1044. uint32_t string_set;
  1045. uint32_t len;
  1046. uint8_t data[];
  1047. };
  1048. /**
  1049. * struct ethtool_sset_info - string set information
  1050. * @cmd: Command number = %ETHTOOL_GSSET_INFO
  1051. * @reserved: Reserved for future use; see the note on reserved space.
  1052. * @sset_mask: On entry, a bitmask of string sets to query, with bits
  1053. * numbered according to &enum ethtool_stringset. On return, a
  1054. * bitmask of those string sets queried that are supported.
  1055. * @data: Buffer for string set sizes. On return, this contains the
  1056. * size of each string set that was queried and supported, in
  1057. * order of ID.
  1058. *
  1059. * Example: The user passes in @sset_mask = 0x7 (sets 0, 1, 2) and on
  1060. * return @sset_mask == 0x6 (sets 1, 2). Then @data[0] contains the
  1061. * size of set 1 and @data[1] contains the size of set 2.
  1062. *
  1063. * Users must allocate a buffer of the appropriate size (4 * number of
  1064. * sets queried) immediately following this structure.
  1065. */
  1066. struct ethtool_sset_info {
  1067. uint32_t cmd;
  1068. uint32_t reserved;
  1069. uint64_t sset_mask;
  1070. uint32_t data[];
  1071. };
  1072. /**
  1073. * enum ethtool_test_flags - flags definition of ethtool_test
  1074. * @ETH_TEST_FL_OFFLINE: if set perform online and offline tests, otherwise
  1075. * only online tests.
  1076. * @ETH_TEST_FL_FAILED: Driver set this flag if test fails.
  1077. * @ETH_TEST_FL_EXTERNAL_LB: Application request to perform external loopback
  1078. * test.
  1079. * @ETH_TEST_FL_EXTERNAL_LB_DONE: Driver performed the external loopback test
  1080. */
  1081. enum ethtool_test_flags {
  1082. ETH_TEST_FL_OFFLINE = (1 << 0),
  1083. ETH_TEST_FL_FAILED = (1 << 1),
  1084. ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
  1085. ETH_TEST_FL_EXTERNAL_LB_DONE = (1 << 3),
  1086. };
  1087. /**
  1088. * struct ethtool_test - device self-test invocation
  1089. * @cmd: Command number = %ETHTOOL_TEST
  1090. * @flags: A bitmask of flags from &enum ethtool_test_flags. Some
  1091. * flags may be set by the user on entry; others may be set by
  1092. * the driver on return.
  1093. * @reserved: Reserved for future use; see the note on reserved space.
  1094. * @len: On return, the number of test results
  1095. * @data: Array of test results
  1096. *
  1097. * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
  1098. * number of test results that will be returned. They must allocate a
  1099. * buffer of the appropriate size (8 * number of results) immediately
  1100. * following this structure.
  1101. */
  1102. struct ethtool_test {
  1103. uint32_t cmd;
  1104. uint32_t flags;
  1105. uint32_t reserved;
  1106. uint32_t len;
  1107. uint64_t data[];
  1108. };
  1109. /**
  1110. * struct ethtool_stats - device-specific statistics
  1111. * @cmd: Command number = %ETHTOOL_GSTATS
  1112. * @n_stats: On return, the number of statistics
  1113. * @data: Array of statistics
  1114. *
  1115. * Users must use %ETHTOOL_GSSET_INFO or %ETHTOOL_GDRVINFO to find the
  1116. * number of statistics that will be returned. They must allocate a
  1117. * buffer of the appropriate size (8 * number of statistics)
  1118. * immediately following this structure.
  1119. */
  1120. struct ethtool_stats {
  1121. uint32_t cmd;
  1122. uint32_t n_stats;
  1123. uint64_t data[];
  1124. };
  1125. /**
  1126. * struct ethtool_perm_addr - permanent hardware address
  1127. * @cmd: Command number = %ETHTOOL_GPERMADDR
  1128. * @size: On entry, the size of the buffer. On return, the size of the
  1129. * address. The command fails if the buffer is too small.
  1130. * @data: Buffer for the address
  1131. *
  1132. * Users must allocate the buffer immediately following this structure.
  1133. * A buffer size of %MAX_ADDR_LEN should be sufficient for any address
  1134. * type.
  1135. */
  1136. struct ethtool_perm_addr {
  1137. uint32_t cmd;
  1138. uint32_t size;
  1139. uint8_t data[];
  1140. };
  1141. /* boolean flags controlling per-interface behavior characteristics.
  1142. * When reading, the flag indicates whether or not a certain behavior
  1143. * is enabled/present. When writing, the flag indicates whether
  1144. * or not the driver should turn on (set) or off (clear) a behavior.
  1145. *
  1146. * Some behaviors may read-only (unconditionally absent or present).
  1147. * If such is the case, return EINVAL in the set-flags operation if the
  1148. * flag differs from the read-only value.
  1149. */
  1150. enum ethtool_flags {
  1151. ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */
  1152. ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */
  1153. ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */
  1154. ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */
  1155. ETH_FLAG_RXHASH = (1 << 28),
  1156. };
  1157. /* The following structures are for supporting RX network flow
  1158. * classification and RX n-tuple configuration. Note, all multibyte
  1159. * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to
  1160. * be in network byte order.
  1161. */
  1162. /**
  1163. * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc.
  1164. * @ip4src: Source host
  1165. * @ip4dst: Destination host
  1166. * @psrc: Source port
  1167. * @pdst: Destination port
  1168. * @tos: Type-of-service
  1169. *
  1170. * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow.
  1171. */
  1172. struct ethtool_tcpip4_spec {
  1173. uint32_t ip4src;
  1174. uint32_t ip4dst;
  1175. uint16_t psrc;
  1176. uint16_t pdst;
  1177. uint8_t tos;
  1178. };
  1179. /**
  1180. * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4
  1181. * @ip4src: Source host
  1182. * @ip4dst: Destination host
  1183. * @spi: Security parameters index
  1184. * @tos: Type-of-service
  1185. *
  1186. * This can be used to specify an IPsec transport or tunnel over IPv4.
  1187. */
  1188. struct ethtool_ah_espip4_spec {
  1189. uint32_t ip4src;
  1190. uint32_t ip4dst;
  1191. uint32_t spi;
  1192. uint8_t tos;
  1193. };
  1194. #define ETH_RX_NFC_IP4 1
  1195. /**
  1196. * struct ethtool_usrip4_spec - general flow specification for IPv4
  1197. * @ip4src: Source host
  1198. * @ip4dst: Destination host
  1199. * @l4_4_bytes: First 4 bytes of transport (layer 4) header
  1200. * @tos: Type-of-service
  1201. * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0
  1202. * @proto: Transport protocol number; mask must be 0
  1203. */
  1204. struct ethtool_usrip4_spec {
  1205. uint32_t ip4src;
  1206. uint32_t ip4dst;
  1207. uint32_t l4_4_bytes;
  1208. uint8_t tos;
  1209. uint8_t ip_ver;
  1210. uint8_t proto;
  1211. };
  1212. /**
  1213. * struct ethtool_tcpip6_spec - flow specification for TCP/IPv6 etc.
  1214. * @ip6src: Source host
  1215. * @ip6dst: Destination host
  1216. * @psrc: Source port
  1217. * @pdst: Destination port
  1218. * @tclass: Traffic Class
  1219. *
  1220. * This can be used to specify a TCP/IPv6, UDP/IPv6 or SCTP/IPv6 flow.
  1221. */
  1222. struct ethtool_tcpip6_spec {
  1223. uint32_t ip6src[4];
  1224. uint32_t ip6dst[4];
  1225. uint16_t psrc;
  1226. uint16_t pdst;
  1227. uint8_t tclass;
  1228. };
  1229. /**
  1230. * struct ethtool_ah_espip6_spec - flow specification for IPsec/IPv6
  1231. * @ip6src: Source host
  1232. * @ip6dst: Destination host
  1233. * @spi: Security parameters index
  1234. * @tclass: Traffic Class
  1235. *
  1236. * This can be used to specify an IPsec transport or tunnel over IPv6.
  1237. */
  1238. struct ethtool_ah_espip6_spec {
  1239. uint32_t ip6src[4];
  1240. uint32_t ip6dst[4];
  1241. uint32_t spi;
  1242. uint8_t tclass;
  1243. };
  1244. /**
  1245. * struct ethtool_usrip6_spec - general flow specification for IPv6
  1246. * @ip6src: Source host
  1247. * @ip6dst: Destination host
  1248. * @l4_4_bytes: First 4 bytes of transport (layer 4) header
  1249. * @tclass: Traffic Class
  1250. * @l4_proto: Transport protocol number (nexthdr after any Extension Headers)
  1251. */
  1252. struct ethtool_usrip6_spec {
  1253. uint32_t ip6src[4];
  1254. uint32_t ip6dst[4];
  1255. uint32_t l4_4_bytes;
  1256. uint8_t tclass;
  1257. uint8_t l4_proto;
  1258. };
  1259. union ethtool_flow_union {
  1260. struct ethtool_tcpip4_spec tcp_ip4_spec;
  1261. struct ethtool_tcpip4_spec udp_ip4_spec;
  1262. struct ethtool_tcpip4_spec sctp_ip4_spec;
  1263. struct ethtool_ah_espip4_spec ah_ip4_spec;
  1264. struct ethtool_ah_espip4_spec esp_ip4_spec;
  1265. struct ethtool_usrip4_spec usr_ip4_spec;
  1266. struct ethtool_tcpip6_spec tcp_ip6_spec;
  1267. struct ethtool_tcpip6_spec udp_ip6_spec;
  1268. struct ethtool_tcpip6_spec sctp_ip6_spec;
  1269. struct ethtool_ah_espip6_spec ah_ip6_spec;
  1270. struct ethtool_ah_espip6_spec esp_ip6_spec;
  1271. struct ethtool_usrip6_spec usr_ip6_spec;
  1272. struct eth_header ether_spec;
  1273. uint8_t hdata[52];
  1274. };
  1275. /**
  1276. * struct ethtool_flow_ext - additional RX flow fields
  1277. * @h_dest: destination MAC address
  1278. * @vlan_etype: VLAN EtherType
  1279. * @vlan_tci: VLAN tag control information
  1280. * @data: user defined data
  1281. * @padding: Reserved for future use; see the note on reserved space.
  1282. *
  1283. * Note, @vlan_etype, @vlan_tci, and @data are only valid if %FLOW_EXT
  1284. * is set in &struct ethtool_rx_flow_spec @flow_type.
  1285. * @h_dest is valid if %FLOW_MAC_EXT is set.
  1286. */
  1287. struct ethtool_flow_ext {
  1288. uint8_t padding[2];
  1289. unsigned char h_dest[ETH_ALEN];
  1290. uint16_t vlan_etype;
  1291. uint16_t vlan_tci;
  1292. uint32_t data[2];
  1293. };
  1294. /**
  1295. * struct ethtool_rx_flow_spec - classification rule for RX flows
  1296. * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
  1297. * @h_u: Flow fields to match (dependent on @flow_type)
  1298. * @h_ext: Additional fields to match
  1299. * @m_u: Masks for flow field bits to be matched
  1300. * @m_ext: Masks for additional field bits to be matched
  1301. * Note, all additional fields must be ignored unless @flow_type
  1302. * includes the %FLOW_EXT or %FLOW_MAC_EXT flag
  1303. * (see &struct ethtool_flow_ext description).
  1304. * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC
  1305. * if packets should be discarded, or %RX_CLS_FLOW_WAKE if the
  1306. * packets should be used for Wake-on-LAN with %WAKE_FILTER
  1307. * @location: Location of rule in the table. Locations must be
  1308. * numbered such that a flow matching multiple rules will be
  1309. * classified according to the first (lowest numbered) rule.
  1310. */
  1311. struct ethtool_rx_flow_spec {
  1312. uint32_t flow_type;
  1313. union ethtool_flow_union h_u;
  1314. struct ethtool_flow_ext h_ext;
  1315. union ethtool_flow_union m_u;
  1316. struct ethtool_flow_ext m_ext;
  1317. uint64_t ring_cookie;
  1318. uint32_t location;
  1319. };
  1320. /* How rings are laid out when accessing virtual functions or
  1321. * offloaded queues is device specific. To allow users to do flow
  1322. * steering and specify these queues the ring cookie is partitioned
  1323. * into a 32bit queue index with an 8 bit virtual function id.
  1324. * This also leaves the 3bytes for further specifiers. It is possible
  1325. * future devices may support more than 256 virtual functions if
  1326. * devices start supporting PCIe w/ARI. However at the moment I
  1327. * do not know of any devices that support this so I do not reserve
  1328. * space for this at this time. If a future patch consumes the next
  1329. * byte it should be aware of this possibility.
  1330. */
  1331. #define ETHTOOL_RX_FLOW_SPEC_RING 0x00000000FFFFFFFFLL
  1332. #define ETHTOOL_RX_FLOW_SPEC_RING_VF 0x000000FF00000000LL
  1333. #define ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF 32
  1334. static inline uint64_t ethtool_get_flow_spec_ring(uint64_t ring_cookie)
  1335. {
  1336. return ETHTOOL_RX_FLOW_SPEC_RING & ring_cookie;
  1337. }
  1338. static inline uint64_t ethtool_get_flow_spec_ring_vf(uint64_t ring_cookie)
  1339. {
  1340. return (ETHTOOL_RX_FLOW_SPEC_RING_VF & ring_cookie) >>
  1341. ETHTOOL_RX_FLOW_SPEC_RING_VF_OFF;
  1342. }
  1343. /**
  1344. * struct ethtool_rxnfc - command to get or set RX flow classification rules
  1345. * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH,
  1346. * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE,
  1347. * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS
  1348. * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW
  1349. * @data: Command-dependent value
  1350. * @fs: Flow classification rule
  1351. * @rss_context: RSS context to be affected
  1352. * @rule_cnt: Number of rules to be affected
  1353. * @rule_locs: Array of used rule locations
  1354. *
  1355. * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating
  1356. * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following
  1357. * structure fields must not be used, except that if @flow_type includes
  1358. * the %FLOW_RSS flag, then @rss_context determines which RSS context to
  1359. * act on.
  1360. *
  1361. * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues
  1362. * on return.
  1363. *
  1364. * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined
  1365. * rules on return. If @data is non-zero on return then it is the
  1366. * size of the rule table, plus the flag %RX_CLS_LOC_SPECIAL if the
  1367. * driver supports any special location values. If that flag is not
  1368. * set in @data then special location values should not be used.
  1369. *
  1370. * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the location of an
  1371. * existing rule on entry and @fs contains the rule on return; if
  1372. * @fs.@flow_type includes the %FLOW_RSS flag, then @rss_context is
  1373. * filled with the RSS context ID associated with the rule.
  1374. *
  1375. * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the
  1376. * user buffer for @rule_locs on entry. On return, @data is the size
  1377. * of the rule table, @rule_cnt is the number of defined rules, and
  1378. * @rule_locs contains the locations of the defined rules. Drivers
  1379. * must use the second parameter to get_rxnfc() instead of @rule_locs.
  1380. *
  1381. * For %ETHTOOL_SRXCLSRLINS, @fs specifies the rule to add or update.
  1382. * @fs.@location either specifies the location to use or is a special
  1383. * location value with %RX_CLS_LOC_SPECIAL flag set. On return,
  1384. * @fs.@location is the actual rule location. If @fs.@flow_type
  1385. * includes the %FLOW_RSS flag, @rss_context is the RSS context ID to
  1386. * use for flow spreading traffic which matches this rule. The value
  1387. * from the rxfh indirection table will be added to @fs.@ring_cookie
  1388. * to choose which ring to deliver to.
  1389. *
  1390. * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the location of an
  1391. * existing rule on entry.
  1392. *
  1393. * A driver supporting the special location values for
  1394. * %ETHTOOL_SRXCLSRLINS may add the rule at any suitable unused
  1395. * location, and may remove a rule at a later location (lower
  1396. * priority) that matches exactly the same set of flows. The special
  1397. * values are %RX_CLS_LOC_ANY, selecting any location;
  1398. * %RX_CLS_LOC_FIRST, selecting the first suitable location (maximum
  1399. * priority); and %RX_CLS_LOC_LAST, selecting the last suitable
  1400. * location (minimum priority). Additional special values may be
  1401. * defined in future and drivers must return -%EINVAL for any
  1402. * unrecognised value.
  1403. */
  1404. struct ethtool_rxnfc {
  1405. uint32_t cmd;
  1406. uint32_t flow_type;
  1407. uint64_t data;
  1408. struct ethtool_rx_flow_spec fs;
  1409. union {
  1410. uint32_t rule_cnt;
  1411. uint32_t rss_context;
  1412. };
  1413. uint32_t rule_locs[];
  1414. };
  1415. /**
  1416. * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection
  1417. * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR
  1418. * @size: On entry, the array size of the user buffer, which may be zero.
  1419. * On return from %ETHTOOL_GRXFHINDIR, the array size of the hardware
  1420. * indirection table.
  1421. * @ring_index: RX ring/queue index for each hash value
  1422. *
  1423. * For %ETHTOOL_GRXFHINDIR, a @size of zero means that only the size
  1424. * should be returned. For %ETHTOOL_SRXFHINDIR, a @size of zero means
  1425. * the table should be reset to default values. This last feature
  1426. * is not supported by the original implementations.
  1427. */
  1428. struct ethtool_rxfh_indir {
  1429. uint32_t cmd;
  1430. uint32_t size;
  1431. uint32_t ring_index[];
  1432. };
  1433. /**
  1434. * struct ethtool_rxfh - command to get/set RX flow hash indir or/and hash key.
  1435. * @cmd: Specific command number - %ETHTOOL_GRSSH or %ETHTOOL_SRSSH
  1436. * @rss_context: RSS context identifier. Context 0 is the default for normal
  1437. * traffic; other contexts can be referenced as the destination for RX flow
  1438. * classification rules. %ETH_RXFH_CONTEXT_ALLOC is used with command
  1439. * %ETHTOOL_SRSSH to allocate a new RSS context; on return this field will
  1440. * contain the ID of the newly allocated context.
  1441. * @indir_size: On entry, the array size of the user buffer for the
  1442. * indirection table, which may be zero, or (for %ETHTOOL_SRSSH),
  1443. * %ETH_RXFH_INDIR_NO_CHANGE. On return from %ETHTOOL_GRSSH,
  1444. * the array size of the hardware indirection table.
  1445. * @key_size: On entry, the array size of the user buffer for the hash key,
  1446. * which may be zero. On return from %ETHTOOL_GRSSH, the size of the
  1447. * hardware hash key.
  1448. * @hfunc: Defines the current RSS hash function used by HW (or to be set to).
  1449. * Valid values are one of the %ETH_RSS_HASH_*.
  1450. * @input_xfrm: Defines how the input data is transformed. Valid values are one
  1451. * of %RXH_XFRM_*.
  1452. * @rsvd8: Reserved for future use; see the note on reserved space.
  1453. * @rsvd32: Reserved for future use; see the note on reserved space.
  1454. * @rss_config: RX ring/queue index for each hash value i.e., indirection table
  1455. * of @indir_size uint32_t elements, followed by hash key of @key_size
  1456. * bytes.
  1457. *
  1458. * For %ETHTOOL_GRSSH, a @indir_size and key_size of zero means that only the
  1459. * size should be returned. For %ETHTOOL_SRSSH, an @indir_size of
  1460. * %ETH_RXFH_INDIR_NO_CHANGE means that indir table setting is not requested
  1461. * and a @indir_size of zero means the indir table should be reset to default
  1462. * values (if @rss_context == 0) or that the RSS context should be deleted.
  1463. * An hfunc of zero means that hash function setting is not requested.
  1464. */
  1465. struct ethtool_rxfh {
  1466. uint32_t cmd;
  1467. uint32_t rss_context;
  1468. uint32_t indir_size;
  1469. uint32_t key_size;
  1470. uint8_t hfunc;
  1471. uint8_t input_xfrm;
  1472. uint8_t rsvd8[2];
  1473. uint32_t rsvd32;
  1474. uint32_t rss_config[];
  1475. };
  1476. #define ETH_RXFH_CONTEXT_ALLOC 0xffffffff
  1477. #define ETH_RXFH_INDIR_NO_CHANGE 0xffffffff
  1478. /**
  1479. * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter
  1480. * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW
  1481. * @h_u: Flow field values to match (dependent on @flow_type)
  1482. * @m_u: Masks for flow field value bits to be ignored
  1483. * @vlan_tag: VLAN tag to match
  1484. * @vlan_tag_mask: Mask for VLAN tag bits to be ignored
  1485. * @data: Driver-dependent data to match
  1486. * @data_mask: Mask for driver-dependent data bits to be ignored
  1487. * @action: RX ring/queue index to deliver to (non-negative) or other action
  1488. * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP)
  1489. *
  1490. * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where
  1491. * a field value and mask are both zero this is treated as if all mask
  1492. * bits are set i.e. the field is ignored.
  1493. */
  1494. struct ethtool_rx_ntuple_flow_spec {
  1495. uint32_t flow_type;
  1496. union {
  1497. struct ethtool_tcpip4_spec tcp_ip4_spec;
  1498. struct ethtool_tcpip4_spec udp_ip4_spec;
  1499. struct ethtool_tcpip4_spec sctp_ip4_spec;
  1500. struct ethtool_ah_espip4_spec ah_ip4_spec;
  1501. struct ethtool_ah_espip4_spec esp_ip4_spec;
  1502. struct ethtool_usrip4_spec usr_ip4_spec;
  1503. struct eth_header ether_spec;
  1504. uint8_t hdata[72];
  1505. } h_u, m_u;
  1506. uint16_t vlan_tag;
  1507. uint16_t vlan_tag_mask;
  1508. uint64_t data;
  1509. uint64_t data_mask;
  1510. int32_t action;
  1511. #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */
  1512. #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */
  1513. };
  1514. /**
  1515. * struct ethtool_rx_ntuple - command to set or clear RX flow filter
  1516. * @cmd: Command number - %ETHTOOL_SRXNTUPLE
  1517. * @fs: Flow filter specification
  1518. */
  1519. struct ethtool_rx_ntuple {
  1520. uint32_t cmd;
  1521. struct ethtool_rx_ntuple_flow_spec fs;
  1522. };
  1523. #define ETHTOOL_FLASH_MAX_FILENAME 128
  1524. enum ethtool_flash_op_type {
  1525. ETHTOOL_FLASH_ALL_REGIONS = 0,
  1526. };
  1527. /* for passing firmware flashing related parameters */
  1528. struct ethtool_flash {
  1529. uint32_t cmd;
  1530. uint32_t region;
  1531. char data[ETHTOOL_FLASH_MAX_FILENAME];
  1532. };
  1533. /**
  1534. * struct ethtool_dump - used for retrieving, setting device dump
  1535. * @cmd: Command number - %ETHTOOL_GET_DUMP_FLAG, %ETHTOOL_GET_DUMP_DATA, or
  1536. * %ETHTOOL_SET_DUMP
  1537. * @version: FW version of the dump, filled in by driver
  1538. * @flag: driver dependent flag for dump setting, filled in by driver during
  1539. * get and filled in by ethtool for set operation.
  1540. * flag must be initialized by macro ETH_FW_DUMP_DISABLE value when
  1541. * firmware dump is disabled.
  1542. * @len: length of dump data, used as the length of the user buffer on entry to
  1543. * %ETHTOOL_GET_DUMP_DATA and this is returned as dump length by driver
  1544. * for %ETHTOOL_GET_DUMP_FLAG command
  1545. * @data: data collected for get dump data operation
  1546. */
  1547. struct ethtool_dump {
  1548. uint32_t cmd;
  1549. uint32_t version;
  1550. uint32_t flag;
  1551. uint32_t len;
  1552. uint8_t data[];
  1553. };
  1554. #define ETH_FW_DUMP_DISABLE 0
  1555. /* for returning and changing feature sets */
  1556. /**
  1557. * struct ethtool_get_features_block - block with state of 32 features
  1558. * @available: mask of changeable features
  1559. * @requested: mask of features requested to be enabled if possible
  1560. * @active: mask of currently enabled features
  1561. * @never_changed: mask of features not changeable for any device
  1562. */
  1563. struct ethtool_get_features_block {
  1564. uint32_t available;
  1565. uint32_t requested;
  1566. uint32_t active;
  1567. uint32_t never_changed;
  1568. };
  1569. /**
  1570. * struct ethtool_gfeatures - command to get state of device's features
  1571. * @cmd: command number = %ETHTOOL_GFEATURES
  1572. * @size: On entry, the number of elements in the features[] array;
  1573. * on return, the number of elements in features[] needed to hold
  1574. * all features
  1575. * @features: state of features
  1576. */
  1577. struct ethtool_gfeatures {
  1578. uint32_t cmd;
  1579. uint32_t size;
  1580. struct ethtool_get_features_block features[];
  1581. };
  1582. /**
  1583. * struct ethtool_set_features_block - block with request for 32 features
  1584. * @valid: mask of features to be changed
  1585. * @requested: values of features to be changed
  1586. */
  1587. struct ethtool_set_features_block {
  1588. uint32_t valid;
  1589. uint32_t requested;
  1590. };
  1591. /**
  1592. * struct ethtool_sfeatures - command to request change in device's features
  1593. * @cmd: command number = %ETHTOOL_SFEATURES
  1594. * @size: array size of the features[] array
  1595. * @features: feature change masks
  1596. */
  1597. struct ethtool_sfeatures {
  1598. uint32_t cmd;
  1599. uint32_t size;
  1600. struct ethtool_set_features_block features[];
  1601. };
  1602. /**
  1603. * struct ethtool_ts_info - holds a device's timestamping and PHC association
  1604. * @cmd: command number = %ETHTOOL_GET_TS_INFO
  1605. * @so_timestamping: bit mask of the sum of the supported SO_TIMESTAMPING flags
  1606. * @phc_index: device index of the associated PHC, or -1 if there is none
  1607. * @tx_types: bit mask of the supported hwtstamp_tx_types enumeration values
  1608. * @tx_reserved: Reserved for future use; see the note on reserved space.
  1609. * @rx_filters: bit mask of the supported hwtstamp_rx_filters enumeration values
  1610. * @rx_reserved: Reserved for future use; see the note on reserved space.
  1611. *
  1612. * The bits in the 'tx_types' and 'rx_filters' fields correspond to
  1613. * the 'hwtstamp_tx_types' and 'hwtstamp_rx_filters' enumeration values,
  1614. * respectively. For example, if the device supports HWTSTAMP_TX_ON,
  1615. * then (1 << HWTSTAMP_TX_ON) in 'tx_types' will be set.
  1616. *
  1617. * Drivers should only report the filters they actually support without
  1618. * upscaling in the SIOCSHWTSTAMP ioctl. If the SIOCSHWSTAMP request for
  1619. * HWTSTAMP_FILTER_V1_SYNC is supported by HWTSTAMP_FILTER_V1_EVENT, then the
  1620. * driver should only report HWTSTAMP_FILTER_V1_EVENT in this op.
  1621. */
  1622. struct ethtool_ts_info {
  1623. uint32_t cmd;
  1624. uint32_t so_timestamping;
  1625. int32_t phc_index;
  1626. uint32_t tx_types;
  1627. uint32_t tx_reserved[3];
  1628. uint32_t rx_filters;
  1629. uint32_t rx_reserved[3];
  1630. };
  1631. /*
  1632. * %ETHTOOL_SFEATURES changes features present in features[].valid to the
  1633. * values of corresponding bits in features[].requested. Bits in .requested
  1634. * not set in .valid or not changeable are ignored.
  1635. *
  1636. * Returns %EINVAL when .valid contains undefined or never-changeable bits
  1637. * or size is not equal to required number of features words (32-bit blocks).
  1638. * Returns >= 0 if request was completed; bits set in the value mean:
  1639. * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not
  1640. * changeable (not present in %ETHTOOL_GFEATURES' features[].available)
  1641. * those bits were ignored.
  1642. * %ETHTOOL_F_WISH - some or all changes requested were recorded but the
  1643. * resulting state of bits masked by .valid is not equal to .requested.
  1644. * Probably there are other device-specific constraints on some features
  1645. * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered
  1646. * here as though ignored bits were cleared.
  1647. * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling
  1648. * compatibility functions. Requested offload state cannot be properly
  1649. * managed by kernel.
  1650. *
  1651. * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of
  1652. * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands
  1653. * for ETH_SS_FEATURES string set. First entry in the table corresponds to least
  1654. * significant bit in features[0] fields. Empty strings mark undefined features.
  1655. */
  1656. enum ethtool_sfeatures_retval_bits {
  1657. ETHTOOL_F_UNSUPPORTED__BIT,
  1658. ETHTOOL_F_WISH__BIT,
  1659. ETHTOOL_F_COMPAT__BIT,
  1660. };
  1661. #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT)
  1662. #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT)
  1663. #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT)
  1664. #define MAX_NUM_QUEUE 4096
  1665. /**
  1666. * struct ethtool_per_queue_op - apply sub command to the queues in mask.
  1667. * @cmd: ETHTOOL_PERQUEUE
  1668. * @sub_command: the sub command which apply to each queues
  1669. * @queue_mask: Bitmap of the queues which sub command apply to
  1670. * @data: A complete command structure following for each of the queues addressed
  1671. */
  1672. struct ethtool_per_queue_op {
  1673. uint32_t cmd;
  1674. uint32_t sub_command;
  1675. uint32_t queue_mask[__KERNEL_DIV_ROUND_UP(MAX_NUM_QUEUE, 32)];
  1676. char data[];
  1677. };
  1678. /**
  1679. * struct ethtool_fecparam - Ethernet Forward Error Correction parameters
  1680. * @cmd: Command number = %ETHTOOL_GFECPARAM or %ETHTOOL_SFECPARAM
  1681. * @active_fec: FEC mode which is active on the port, single bit set, GET only.
  1682. * @fec: Bitmask of configured FEC modes.
  1683. * @reserved: Reserved for future extensions, ignore on GET, write 0 for SET.
  1684. *
  1685. * Note that @reserved was never validated on input and ethtool user space
  1686. * left it uninitialized when calling SET. Hence going forward it can only be
  1687. * used to return a value to userspace with GET.
  1688. *
  1689. * FEC modes supported by the device can be read via %ETHTOOL_GLINKSETTINGS.
  1690. * FEC settings are configured by link autonegotiation whenever it's enabled.
  1691. * With autoneg on %ETHTOOL_GFECPARAM can be used to read the current mode.
  1692. *
  1693. * When autoneg is disabled %ETHTOOL_SFECPARAM controls the FEC settings.
  1694. * It is recommended that drivers only accept a single bit set in @fec.
  1695. * When multiple bits are set in @fec drivers may pick mode in an implementation
  1696. * dependent way. Drivers should reject mixing %ETHTOOL_FEC_AUTO_BIT with other
  1697. * FEC modes, because it's unclear whether in this case other modes constrain
  1698. * AUTO or are independent choices.
  1699. * Drivers must reject SET requests if they support none of the requested modes.
  1700. *
  1701. * If device does not support FEC drivers may use %ETHTOOL_FEC_NONE instead
  1702. * of returning %EOPNOTSUPP from %ETHTOOL_GFECPARAM.
  1703. *
  1704. * See enum ethtool_fec_config_bits for definition of valid bits for both
  1705. * @fec and @active_fec.
  1706. */
  1707. struct ethtool_fecparam {
  1708. uint32_t cmd;
  1709. /* bitmask of FEC modes */
  1710. uint32_t active_fec;
  1711. uint32_t fec;
  1712. uint32_t reserved;
  1713. };
  1714. /**
  1715. * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration
  1716. * @ETHTOOL_FEC_NONE_BIT: FEC mode configuration is not supported. Should not
  1717. * be used together with other bits. GET only.
  1718. * @ETHTOOL_FEC_AUTO_BIT: Select default/best FEC mode automatically, usually
  1719. * based link mode and SFP parameters read from module's
  1720. * EEPROM. This bit does _not_ mean autonegotiation.
  1721. * @ETHTOOL_FEC_OFF_BIT: No FEC Mode
  1722. * @ETHTOOL_FEC_RS_BIT: Reed-Solomon FEC Mode
  1723. * @ETHTOOL_FEC_BASER_BIT: Base-R/Reed-Solomon FEC Mode
  1724. * @ETHTOOL_FEC_LLRS_BIT: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet
  1725. * Consortium)
  1726. */
  1727. enum ethtool_fec_config_bits {
  1728. ETHTOOL_FEC_NONE_BIT,
  1729. ETHTOOL_FEC_AUTO_BIT,
  1730. ETHTOOL_FEC_OFF_BIT,
  1731. ETHTOOL_FEC_RS_BIT,
  1732. ETHTOOL_FEC_BASER_BIT,
  1733. ETHTOOL_FEC_LLRS_BIT,
  1734. };
  1735. #define ETHTOOL_FEC_NONE (1 << ETHTOOL_FEC_NONE_BIT)
  1736. #define ETHTOOL_FEC_AUTO (1 << ETHTOOL_FEC_AUTO_BIT)
  1737. #define ETHTOOL_FEC_OFF (1 << ETHTOOL_FEC_OFF_BIT)
  1738. #define ETHTOOL_FEC_RS (1 << ETHTOOL_FEC_RS_BIT)
  1739. #define ETHTOOL_FEC_BASER (1 << ETHTOOL_FEC_BASER_BIT)
  1740. #define ETHTOOL_FEC_LLRS (1 << ETHTOOL_FEC_LLRS_BIT)
  1741. /* CMDs currently supported */
  1742. #define ETHTOOL_GSET 0x00000001 /* DEPRECATED, Get settings.
  1743. * Please use ETHTOOL_GLINKSETTINGS
  1744. */
  1745. #define ETHTOOL_SSET 0x00000002 /* DEPRECATED, Set settings.
  1746. * Please use ETHTOOL_SLINKSETTINGS
  1747. */
  1748. #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */
  1749. #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */
  1750. #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */
  1751. #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */
  1752. #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */
  1753. #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */
  1754. #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */
  1755. /* Get link status for host, i.e. whether the interface *and* the
  1756. * physical port (if there is one) are up (ethtool_value). */
  1757. #define ETHTOOL_GLINK 0x0000000a
  1758. #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */
  1759. #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */
  1760. #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */
  1761. #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */
  1762. #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */
  1763. #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */
  1764. #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */
  1765. #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */
  1766. #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */
  1767. #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */
  1768. #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */
  1769. #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */
  1770. #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable
  1771. * (ethtool_value) */
  1772. #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable
  1773. * (ethtool_value). */
  1774. #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */
  1775. #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */
  1776. #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */
  1777. #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */
  1778. #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */
  1779. #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */
  1780. #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */
  1781. #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */
  1782. #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */
  1783. #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */
  1784. #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */
  1785. #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */
  1786. #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */
  1787. #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */
  1788. #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */
  1789. #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */
  1790. #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */
  1791. #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */
  1792. #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */
  1793. #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */
  1794. #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */
  1795. #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */
  1796. #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */
  1797. #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */
  1798. #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */
  1799. #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */
  1800. #define ETHTOOL_RESET 0x00000034 /* Reset hardware */
  1801. #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */
  1802. #define ETHTOOL_GRXNTUPLE 0x00000036 /* deprecated */
  1803. #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */
  1804. #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */
  1805. #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */
  1806. #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */
  1807. #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */
  1808. #define ETHTOOL_GCHANNELS 0x0000003c /* Get no of channels */
  1809. #define ETHTOOL_SCHANNELS 0x0000003d /* Set no of channels */
  1810. #define ETHTOOL_SET_DUMP 0x0000003e /* Set dump settings */
  1811. #define ETHTOOL_GET_DUMP_FLAG 0x0000003f /* Get dump settings */
  1812. #define ETHTOOL_GET_DUMP_DATA 0x00000040 /* Get dump data */
  1813. #define ETHTOOL_GET_TS_INFO 0x00000041 /* Get time stamping and PHC info */
  1814. #define ETHTOOL_GMODULEINFO 0x00000042 /* Get plug-in module information */
  1815. #define ETHTOOL_GMODULEEEPROM 0x00000043 /* Get plug-in module eeprom */
  1816. #define ETHTOOL_GEEE 0x00000044 /* Get EEE settings */
  1817. #define ETHTOOL_SEEE 0x00000045 /* Set EEE settings */
  1818. #define ETHTOOL_GRSSH 0x00000046 /* Get RX flow hash configuration */
  1819. #define ETHTOOL_SRSSH 0x00000047 /* Set RX flow hash configuration */
  1820. #define ETHTOOL_GTUNABLE 0x00000048 /* Get tunable configuration */
  1821. #define ETHTOOL_STUNABLE 0x00000049 /* Set tunable configuration */
  1822. #define ETHTOOL_GPHYSTATS 0x0000004a /* get PHY-specific statistics */
  1823. #define ETHTOOL_PERQUEUE 0x0000004b /* Set per queue options */
  1824. #define ETHTOOL_GLINKSETTINGS 0x0000004c /* Get ethtool_link_settings */
  1825. #define ETHTOOL_SLINKSETTINGS 0x0000004d /* Set ethtool_link_settings */
  1826. #define ETHTOOL_PHY_GTUNABLE 0x0000004e /* Get PHY tunable configuration */
  1827. #define ETHTOOL_PHY_STUNABLE 0x0000004f /* Set PHY tunable configuration */
  1828. #define ETHTOOL_GFECPARAM 0x00000050 /* Get FEC settings */
  1829. #define ETHTOOL_SFECPARAM 0x00000051 /* Set FEC settings */
  1830. /* compatibility with older code */
  1831. #define SPARC_ETH_GSET ETHTOOL_GSET
  1832. #define SPARC_ETH_SSET ETHTOOL_SSET
  1833. /* Link mode bit indices */
  1834. enum ethtool_link_mode_bit_indices {
  1835. ETHTOOL_LINK_MODE_10baseT_Half_BIT = 0,
  1836. ETHTOOL_LINK_MODE_10baseT_Full_BIT = 1,
  1837. ETHTOOL_LINK_MODE_100baseT_Half_BIT = 2,
  1838. ETHTOOL_LINK_MODE_100baseT_Full_BIT = 3,
  1839. ETHTOOL_LINK_MODE_1000baseT_Half_BIT = 4,
  1840. ETHTOOL_LINK_MODE_1000baseT_Full_BIT = 5,
  1841. ETHTOOL_LINK_MODE_Autoneg_BIT = 6,
  1842. ETHTOOL_LINK_MODE_TP_BIT = 7,
  1843. ETHTOOL_LINK_MODE_AUI_BIT = 8,
  1844. ETHTOOL_LINK_MODE_MII_BIT = 9,
  1845. ETHTOOL_LINK_MODE_FIBRE_BIT = 10,
  1846. ETHTOOL_LINK_MODE_BNC_BIT = 11,
  1847. ETHTOOL_LINK_MODE_10000baseT_Full_BIT = 12,
  1848. ETHTOOL_LINK_MODE_Pause_BIT = 13,
  1849. ETHTOOL_LINK_MODE_Asym_Pause_BIT = 14,
  1850. ETHTOOL_LINK_MODE_2500baseX_Full_BIT = 15,
  1851. ETHTOOL_LINK_MODE_Backplane_BIT = 16,
  1852. ETHTOOL_LINK_MODE_1000baseKX_Full_BIT = 17,
  1853. ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT = 18,
  1854. ETHTOOL_LINK_MODE_10000baseKR_Full_BIT = 19,
  1855. ETHTOOL_LINK_MODE_10000baseR_FEC_BIT = 20,
  1856. ETHTOOL_LINK_MODE_20000baseMLD2_Full_BIT = 21,
  1857. ETHTOOL_LINK_MODE_20000baseKR2_Full_BIT = 22,
  1858. ETHTOOL_LINK_MODE_40000baseKR4_Full_BIT = 23,
  1859. ETHTOOL_LINK_MODE_40000baseCR4_Full_BIT = 24,
  1860. ETHTOOL_LINK_MODE_40000baseSR4_Full_BIT = 25,
  1861. ETHTOOL_LINK_MODE_40000baseLR4_Full_BIT = 26,
  1862. ETHTOOL_LINK_MODE_56000baseKR4_Full_BIT = 27,
  1863. ETHTOOL_LINK_MODE_56000baseCR4_Full_BIT = 28,
  1864. ETHTOOL_LINK_MODE_56000baseSR4_Full_BIT = 29,
  1865. ETHTOOL_LINK_MODE_56000baseLR4_Full_BIT = 30,
  1866. ETHTOOL_LINK_MODE_25000baseCR_Full_BIT = 31,
  1867. /* Last allowed bit for __ETHTOOL_LINK_MODE_LEGACY_MASK is bit
  1868. * 31. Please do NOT define any SUPPORTED_* or ADVERTISED_*
  1869. * macro for bits > 31. The only way to use indices > 31 is to
  1870. * use the new ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API.
  1871. */
  1872. ETHTOOL_LINK_MODE_25000baseKR_Full_BIT = 32,
  1873. ETHTOOL_LINK_MODE_25000baseSR_Full_BIT = 33,
  1874. ETHTOOL_LINK_MODE_50000baseCR2_Full_BIT = 34,
  1875. ETHTOOL_LINK_MODE_50000baseKR2_Full_BIT = 35,
  1876. ETHTOOL_LINK_MODE_100000baseKR4_Full_BIT = 36,
  1877. ETHTOOL_LINK_MODE_100000baseSR4_Full_BIT = 37,
  1878. ETHTOOL_LINK_MODE_100000baseCR4_Full_BIT = 38,
  1879. ETHTOOL_LINK_MODE_100000baseLR4_ER4_Full_BIT = 39,
  1880. ETHTOOL_LINK_MODE_50000baseSR2_Full_BIT = 40,
  1881. ETHTOOL_LINK_MODE_1000baseX_Full_BIT = 41,
  1882. ETHTOOL_LINK_MODE_10000baseCR_Full_BIT = 42,
  1883. ETHTOOL_LINK_MODE_10000baseSR_Full_BIT = 43,
  1884. ETHTOOL_LINK_MODE_10000baseLR_Full_BIT = 44,
  1885. ETHTOOL_LINK_MODE_10000baseLRM_Full_BIT = 45,
  1886. ETHTOOL_LINK_MODE_10000baseER_Full_BIT = 46,
  1887. ETHTOOL_LINK_MODE_2500baseT_Full_BIT = 47,
  1888. ETHTOOL_LINK_MODE_5000baseT_Full_BIT = 48,
  1889. ETHTOOL_LINK_MODE_FEC_NONE_BIT = 49,
  1890. ETHTOOL_LINK_MODE_FEC_RS_BIT = 50,
  1891. ETHTOOL_LINK_MODE_FEC_BASER_BIT = 51,
  1892. ETHTOOL_LINK_MODE_50000baseKR_Full_BIT = 52,
  1893. ETHTOOL_LINK_MODE_50000baseSR_Full_BIT = 53,
  1894. ETHTOOL_LINK_MODE_50000baseCR_Full_BIT = 54,
  1895. ETHTOOL_LINK_MODE_50000baseLR_ER_FR_Full_BIT = 55,
  1896. ETHTOOL_LINK_MODE_50000baseDR_Full_BIT = 56,
  1897. ETHTOOL_LINK_MODE_100000baseKR2_Full_BIT = 57,
  1898. ETHTOOL_LINK_MODE_100000baseSR2_Full_BIT = 58,
  1899. ETHTOOL_LINK_MODE_100000baseCR2_Full_BIT = 59,
  1900. ETHTOOL_LINK_MODE_100000baseLR2_ER2_FR2_Full_BIT = 60,
  1901. ETHTOOL_LINK_MODE_100000baseDR2_Full_BIT = 61,
  1902. ETHTOOL_LINK_MODE_200000baseKR4_Full_BIT = 62,
  1903. ETHTOOL_LINK_MODE_200000baseSR4_Full_BIT = 63,
  1904. ETHTOOL_LINK_MODE_200000baseLR4_ER4_FR4_Full_BIT = 64,
  1905. ETHTOOL_LINK_MODE_200000baseDR4_Full_BIT = 65,
  1906. ETHTOOL_LINK_MODE_200000baseCR4_Full_BIT = 66,
  1907. ETHTOOL_LINK_MODE_100baseT1_Full_BIT = 67,
  1908. ETHTOOL_LINK_MODE_1000baseT1_Full_BIT = 68,
  1909. ETHTOOL_LINK_MODE_400000baseKR8_Full_BIT = 69,
  1910. ETHTOOL_LINK_MODE_400000baseSR8_Full_BIT = 70,
  1911. ETHTOOL_LINK_MODE_400000baseLR8_ER8_FR8_Full_BIT = 71,
  1912. ETHTOOL_LINK_MODE_400000baseDR8_Full_BIT = 72,
  1913. ETHTOOL_LINK_MODE_400000baseCR8_Full_BIT = 73,
  1914. ETHTOOL_LINK_MODE_FEC_LLRS_BIT = 74,
  1915. ETHTOOL_LINK_MODE_100000baseKR_Full_BIT = 75,
  1916. ETHTOOL_LINK_MODE_100000baseSR_Full_BIT = 76,
  1917. ETHTOOL_LINK_MODE_100000baseLR_ER_FR_Full_BIT = 77,
  1918. ETHTOOL_LINK_MODE_100000baseCR_Full_BIT = 78,
  1919. ETHTOOL_LINK_MODE_100000baseDR_Full_BIT = 79,
  1920. ETHTOOL_LINK_MODE_200000baseKR2_Full_BIT = 80,
  1921. ETHTOOL_LINK_MODE_200000baseSR2_Full_BIT = 81,
  1922. ETHTOOL_LINK_MODE_200000baseLR2_ER2_FR2_Full_BIT = 82,
  1923. ETHTOOL_LINK_MODE_200000baseDR2_Full_BIT = 83,
  1924. ETHTOOL_LINK_MODE_200000baseCR2_Full_BIT = 84,
  1925. ETHTOOL_LINK_MODE_400000baseKR4_Full_BIT = 85,
  1926. ETHTOOL_LINK_MODE_400000baseSR4_Full_BIT = 86,
  1927. ETHTOOL_LINK_MODE_400000baseLR4_ER4_FR4_Full_BIT = 87,
  1928. ETHTOOL_LINK_MODE_400000baseDR4_Full_BIT = 88,
  1929. ETHTOOL_LINK_MODE_400000baseCR4_Full_BIT = 89,
  1930. ETHTOOL_LINK_MODE_100baseFX_Half_BIT = 90,
  1931. ETHTOOL_LINK_MODE_100baseFX_Full_BIT = 91,
  1932. ETHTOOL_LINK_MODE_10baseT1L_Full_BIT = 92,
  1933. ETHTOOL_LINK_MODE_800000baseCR8_Full_BIT = 93,
  1934. ETHTOOL_LINK_MODE_800000baseKR8_Full_BIT = 94,
  1935. ETHTOOL_LINK_MODE_800000baseDR8_Full_BIT = 95,
  1936. ETHTOOL_LINK_MODE_800000baseDR8_2_Full_BIT = 96,
  1937. ETHTOOL_LINK_MODE_800000baseSR8_Full_BIT = 97,
  1938. ETHTOOL_LINK_MODE_800000baseVR8_Full_BIT = 98,
  1939. ETHTOOL_LINK_MODE_10baseT1S_Full_BIT = 99,
  1940. ETHTOOL_LINK_MODE_10baseT1S_Half_BIT = 100,
  1941. ETHTOOL_LINK_MODE_10baseT1S_P2MP_Half_BIT = 101,
  1942. ETHTOOL_LINK_MODE_10baseT1BRR_Full_BIT = 102,
  1943. /* must be last entry */
  1944. __ETHTOOL_LINK_MODE_MASK_NBITS
  1945. };
  1946. #define __ETHTOOL_LINK_MODE_LEGACY_MASK(base_name) \
  1947. (1UL << (ETHTOOL_LINK_MODE_ ## base_name ## _BIT))
  1948. /* DEPRECATED macros. Please migrate to
  1949. * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
  1950. * define any new SUPPORTED_* macro for bits > 31.
  1951. */
  1952. #define SUPPORTED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
  1953. #define SUPPORTED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
  1954. #define SUPPORTED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
  1955. #define SUPPORTED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
  1956. #define SUPPORTED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
  1957. #define SUPPORTED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
  1958. #define SUPPORTED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
  1959. #define SUPPORTED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
  1960. #define SUPPORTED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
  1961. #define SUPPORTED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
  1962. #define SUPPORTED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
  1963. #define SUPPORTED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
  1964. #define SUPPORTED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
  1965. #define SUPPORTED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
  1966. #define SUPPORTED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
  1967. #define SUPPORTED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
  1968. #define SUPPORTED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
  1969. #define SUPPORTED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
  1970. #define SUPPORTED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
  1971. #define SUPPORTED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
  1972. #define SUPPORTED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
  1973. #define SUPPORTED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
  1974. #define SUPPORTED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
  1975. #define SUPPORTED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
  1976. #define SUPPORTED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
  1977. #define SUPPORTED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
  1978. #define SUPPORTED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
  1979. #define SUPPORTED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
  1980. #define SUPPORTED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
  1981. #define SUPPORTED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
  1982. #define SUPPORTED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
  1983. /* Please do not define any new SUPPORTED_* macro for bits > 31, see
  1984. * notice above.
  1985. */
  1986. /*
  1987. * DEPRECATED macros. Please migrate to
  1988. * ETHTOOL_GLINKSETTINGS/ETHTOOL_SLINKSETTINGS API. Please do NOT
  1989. * define any new ADERTISE_* macro for bits > 31.
  1990. */
  1991. #define ADVERTISED_10baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Half)
  1992. #define ADVERTISED_10baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10baseT_Full)
  1993. #define ADVERTISED_100baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Half)
  1994. #define ADVERTISED_100baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(100baseT_Full)
  1995. #define ADVERTISED_1000baseT_Half __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Half)
  1996. #define ADVERTISED_1000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseT_Full)
  1997. #define ADVERTISED_Autoneg __ETHTOOL_LINK_MODE_LEGACY_MASK(Autoneg)
  1998. #define ADVERTISED_TP __ETHTOOL_LINK_MODE_LEGACY_MASK(TP)
  1999. #define ADVERTISED_AUI __ETHTOOL_LINK_MODE_LEGACY_MASK(AUI)
  2000. #define ADVERTISED_MII __ETHTOOL_LINK_MODE_LEGACY_MASK(MII)
  2001. #define ADVERTISED_FIBRE __ETHTOOL_LINK_MODE_LEGACY_MASK(FIBRE)
  2002. #define ADVERTISED_BNC __ETHTOOL_LINK_MODE_LEGACY_MASK(BNC)
  2003. #define ADVERTISED_10000baseT_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseT_Full)
  2004. #define ADVERTISED_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Pause)
  2005. #define ADVERTISED_Asym_Pause __ETHTOOL_LINK_MODE_LEGACY_MASK(Asym_Pause)
  2006. #define ADVERTISED_2500baseX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(2500baseX_Full)
  2007. #define ADVERTISED_Backplane __ETHTOOL_LINK_MODE_LEGACY_MASK(Backplane)
  2008. #define ADVERTISED_1000baseKX_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(1000baseKX_Full)
  2009. #define ADVERTISED_10000baseKX4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKX4_Full)
  2010. #define ADVERTISED_10000baseKR_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseKR_Full)
  2011. #define ADVERTISED_10000baseR_FEC __ETHTOOL_LINK_MODE_LEGACY_MASK(10000baseR_FEC)
  2012. #define ADVERTISED_20000baseMLD2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseMLD2_Full)
  2013. #define ADVERTISED_20000baseKR2_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(20000baseKR2_Full)
  2014. #define ADVERTISED_40000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseKR4_Full)
  2015. #define ADVERTISED_40000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseCR4_Full)
  2016. #define ADVERTISED_40000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseSR4_Full)
  2017. #define ADVERTISED_40000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(40000baseLR4_Full)
  2018. #define ADVERTISED_56000baseKR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseKR4_Full)
  2019. #define ADVERTISED_56000baseCR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseCR4_Full)
  2020. #define ADVERTISED_56000baseSR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseSR4_Full)
  2021. #define ADVERTISED_56000baseLR4_Full __ETHTOOL_LINK_MODE_LEGACY_MASK(56000baseLR4_Full)
  2022. /* Please do not define any new ADVERTISED_* macro for bits > 31, see
  2023. * notice above.
  2024. */
  2025. /* The following are all involved in forcing a particular link
  2026. * mode for the device for setting things. When getting the
  2027. * devices settings, these indicate the current mode and whether
  2028. * it was forced up into this mode or autonegotiated.
  2029. */
  2030. /* The forced speed, in units of 1Mb. All values 0 to INT_MAX are legal.
  2031. * Update drivers/net/phy/phy.c:phy_speed_to_str() and
  2032. * drivers/net/bonding/bond_3ad.c:__get_link_speed() when adding new values.
  2033. */
  2034. #define SPEED_10 10
  2035. #define SPEED_100 100
  2036. #define SPEED_1000 1000
  2037. #define SPEED_2500 2500
  2038. #define SPEED_5000 5000
  2039. #define SPEED_10000 10000
  2040. #define SPEED_14000 14000
  2041. #define SPEED_20000 20000
  2042. #define SPEED_25000 25000
  2043. #define SPEED_40000 40000
  2044. #define SPEED_50000 50000
  2045. #define SPEED_56000 56000
  2046. #define SPEED_100000 100000
  2047. #define SPEED_200000 200000
  2048. #define SPEED_400000 400000
  2049. #define SPEED_800000 800000
  2050. #define SPEED_UNKNOWN -1
  2051. static inline int ethtool_validate_speed(uint32_t speed)
  2052. {
  2053. return speed <= INT_MAX || speed == (uint32_t)SPEED_UNKNOWN;
  2054. }
  2055. /* Duplex, half or full. */
  2056. #define DUPLEX_HALF 0x00
  2057. #define DUPLEX_FULL 0x01
  2058. #define DUPLEX_UNKNOWN 0xff
  2059. static inline int ethtool_validate_duplex(uint8_t duplex)
  2060. {
  2061. switch (duplex) {
  2062. case DUPLEX_HALF:
  2063. case DUPLEX_FULL:
  2064. case DUPLEX_UNKNOWN:
  2065. return 1;
  2066. }
  2067. return 0;
  2068. }
  2069. #define MASTER_SLAVE_CFG_UNSUPPORTED 0
  2070. #define MASTER_SLAVE_CFG_UNKNOWN 1
  2071. #define MASTER_SLAVE_CFG_MASTER_PREFERRED 2
  2072. #define MASTER_SLAVE_CFG_SLAVE_PREFERRED 3
  2073. #define MASTER_SLAVE_CFG_MASTER_FORCE 4
  2074. #define MASTER_SLAVE_CFG_SLAVE_FORCE 5
  2075. #define MASTER_SLAVE_STATE_UNSUPPORTED 0
  2076. #define MASTER_SLAVE_STATE_UNKNOWN 1
  2077. #define MASTER_SLAVE_STATE_MASTER 2
  2078. #define MASTER_SLAVE_STATE_SLAVE 3
  2079. #define MASTER_SLAVE_STATE_ERR 4
  2080. /* These are used to throttle the rate of data on the phy interface when the
  2081. * native speed of the interface is higher than the link speed. These should
  2082. * not be used for phy interfaces which natively support multiple speeds (e.g.
  2083. * MII or SGMII).
  2084. */
  2085. /* No rate matching performed. */
  2086. #define RATE_MATCH_NONE 0
  2087. /* The phy sends pause frames to throttle the MAC. */
  2088. #define RATE_MATCH_PAUSE 1
  2089. /* The phy asserts CRS to prevent the MAC from transmitting. */
  2090. #define RATE_MATCH_CRS 2
  2091. /* The MAC is programmed with a sufficiently-large IPG. */
  2092. #define RATE_MATCH_OPEN_LOOP 3
  2093. /* Which connector port. */
  2094. #define PORT_TP 0x00
  2095. #define PORT_AUI 0x01
  2096. #define PORT_MII 0x02
  2097. #define PORT_FIBRE 0x03
  2098. #define PORT_BNC 0x04
  2099. #define PORT_DA 0x05
  2100. #define PORT_NONE 0xef
  2101. #define PORT_OTHER 0xff
  2102. /* Which transceiver to use. */
  2103. #define XCVR_INTERNAL 0x00 /* PHY and MAC are in the same package */
  2104. #define XCVR_EXTERNAL 0x01 /* PHY and MAC are in different packages */
  2105. #define XCVR_DUMMY1 0x02
  2106. #define XCVR_DUMMY2 0x03
  2107. #define XCVR_DUMMY3 0x04
  2108. /* Enable or disable autonegotiation. */
  2109. #define AUTONEG_DISABLE 0x00
  2110. #define AUTONEG_ENABLE 0x01
  2111. /* MDI or MDI-X status/control - if MDI/MDI_X/AUTO is set then
  2112. * the driver is required to renegotiate link
  2113. */
  2114. #define ETH_TP_MDI_INVALID 0x00 /* status: unknown; control: unsupported */
  2115. #define ETH_TP_MDI 0x01 /* status: MDI; control: force MDI */
  2116. #define ETH_TP_MDI_X 0x02 /* status: MDI-X; control: force MDI-X */
  2117. #define ETH_TP_MDI_AUTO 0x03 /* control: auto-select */
  2118. /* Wake-On-Lan options. */
  2119. #define WAKE_PHY (1 << 0)
  2120. #define WAKE_UCAST (1 << 1)
  2121. #define WAKE_MCAST (1 << 2)
  2122. #define WAKE_BCAST (1 << 3)
  2123. #define WAKE_ARP (1 << 4)
  2124. #define WAKE_MAGIC (1 << 5)
  2125. #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */
  2126. #define WAKE_FILTER (1 << 7)
  2127. #define WOL_MODE_COUNT 8
  2128. /* RSS hash function data
  2129. * XOR the corresponding source and destination fields of each specified
  2130. * protocol. Both copies of the XOR'ed fields are fed into the RSS and RXHASH
  2131. * calculation. Note that this XORing reduces the input set entropy and could
  2132. * be exploited to reduce the RSS queue spread.
  2133. */
  2134. #define RXH_XFRM_SYM_XOR (1 << 0)
  2135. #define RXH_XFRM_NO_CHANGE 0xff
  2136. /* L2-L4 network traffic flow types */
  2137. #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */
  2138. #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */
  2139. #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */
  2140. #define AH_ESP_V4_FLOW 0x04 /* hash only */
  2141. #define TCP_V6_FLOW 0x05 /* hash or spec (tcp_ip6_spec; nfc only) */
  2142. #define UDP_V6_FLOW 0x06 /* hash or spec (udp_ip6_spec; nfc only) */
  2143. #define SCTP_V6_FLOW 0x07 /* hash or spec (sctp_ip6_spec; nfc only) */
  2144. #define AH_ESP_V6_FLOW 0x08 /* hash only */
  2145. #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */
  2146. #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */
  2147. #define AH_V6_FLOW 0x0b /* hash or spec (ah_ip6_spec; nfc only) */
  2148. #define ESP_V6_FLOW 0x0c /* hash or spec (esp_ip6_spec; nfc only) */
  2149. #define IPV4_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */
  2150. #define IP_USER_FLOW IPV4_USER_FLOW
  2151. #define IPV6_USER_FLOW 0x0e /* spec only (usr_ip6_spec; nfc only) */
  2152. #define IPV4_FLOW 0x10 /* hash only */
  2153. #define IPV6_FLOW 0x11 /* hash only */
  2154. #define ETHER_FLOW 0x12 /* spec only (ether_spec) */
  2155. /* Used for GTP-U IPv4 and IPv6.
  2156. * The format of GTP packets only includes
  2157. * elements such as TEID and GTP version.
  2158. * It is primarily intended for data communication of the UE.
  2159. */
  2160. #define GTPU_V4_FLOW 0x13 /* hash only */
  2161. #define GTPU_V6_FLOW 0x14 /* hash only */
  2162. /* Use for GTP-C IPv4 and v6.
  2163. * The format of these GTP packets does not include TEID.
  2164. * Primarily expected to be used for communication
  2165. * to create sessions for UE data communication,
  2166. * commonly referred to as CSR (Create Session Request).
  2167. */
  2168. #define GTPC_V4_FLOW 0x15 /* hash only */
  2169. #define GTPC_V6_FLOW 0x16 /* hash only */
  2170. /* Use for GTP-C IPv4 and v6.
  2171. * Unlike GTPC_V4_FLOW, the format of these GTP packets includes TEID.
  2172. * After session creation, it becomes this packet.
  2173. * This is mainly used for requests to realize UE handover.
  2174. */
  2175. #define GTPC_TEID_V4_FLOW 0x17 /* hash only */
  2176. #define GTPC_TEID_V6_FLOW 0x18 /* hash only */
  2177. /* Use for GTP-U and extended headers for the PSC (PDU Session Container).
  2178. * The format of these GTP packets includes TEID and QFI.
  2179. * In 5G communication using UPF (User Plane Function),
  2180. * data communication with this extended header is performed.
  2181. */
  2182. #define GTPU_EH_V4_FLOW 0x19 /* hash only */
  2183. #define GTPU_EH_V6_FLOW 0x1a /* hash only */
  2184. /* Use for GTP-U IPv4 and v6 PSC (PDU Session Container) extended headers.
  2185. * This differs from GTPU_EH_V(4|6)_FLOW in that it is distinguished by
  2186. * UL/DL included in the PSC.
  2187. * There are differences in the data included based on Downlink/Uplink,
  2188. * and can be used to distinguish packets.
  2189. * The functions described so far are useful when you want to
  2190. * handle communication from the mobile network in UPF, PGW, etc.
  2191. */
  2192. #define GTPU_UL_V4_FLOW 0x1b /* hash only */
  2193. #define GTPU_UL_V6_FLOW 0x1c /* hash only */
  2194. #define GTPU_DL_V4_FLOW 0x1d /* hash only */
  2195. #define GTPU_DL_V6_FLOW 0x1e /* hash only */
  2196. /* Flag to enable additional fields in struct ethtool_rx_flow_spec */
  2197. #define FLOW_EXT 0x80000000
  2198. #define FLOW_MAC_EXT 0x40000000
  2199. /* Flag to enable RSS spreading of traffic matching rule (nfc only) */
  2200. #define FLOW_RSS 0x20000000
  2201. /* L3-L4 network traffic flow hash options */
  2202. #define RXH_L2DA (1 << 1)
  2203. #define RXH_VLAN (1 << 2)
  2204. #define RXH_L3_PROTO (1 << 3)
  2205. #define RXH_IP_SRC (1 << 4)
  2206. #define RXH_IP_DST (1 << 5)
  2207. #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */
  2208. #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */
  2209. #define RXH_GTP_TEID (1 << 8) /* teid in case of GTP */
  2210. #define RXH_DISCARD (1 << 31)
  2211. #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL
  2212. #define RX_CLS_FLOW_WAKE 0xfffffffffffffffeULL
  2213. /* Special RX classification rule insert location values */
  2214. #define RX_CLS_LOC_SPECIAL 0x80000000 /* flag */
  2215. #define RX_CLS_LOC_ANY 0xffffffff
  2216. #define RX_CLS_LOC_FIRST 0xfffffffe
  2217. #define RX_CLS_LOC_LAST 0xfffffffd
  2218. /* EEPROM Standards for plug in modules */
  2219. #define ETH_MODULE_SFF_8079 0x1
  2220. #define ETH_MODULE_SFF_8079_LEN 256
  2221. #define ETH_MODULE_SFF_8472 0x2
  2222. #define ETH_MODULE_SFF_8472_LEN 512
  2223. #define ETH_MODULE_SFF_8636 0x3
  2224. #define ETH_MODULE_SFF_8636_LEN 256
  2225. #define ETH_MODULE_SFF_8436 0x4
  2226. #define ETH_MODULE_SFF_8436_LEN 256
  2227. #define ETH_MODULE_SFF_8636_MAX_LEN 640
  2228. #define ETH_MODULE_SFF_8436_MAX_LEN 640
  2229. /* Reset flags */
  2230. /* The reset() operation must clear the flags for the components which
  2231. * were actually reset. On successful return, the flags indicate the
  2232. * components which were not reset, either because they do not exist
  2233. * in the hardware or because they cannot be reset independently. The
  2234. * driver must never reset any components that were not requested.
  2235. */
  2236. enum ethtool_reset_flags {
  2237. /* These flags represent components dedicated to the interface
  2238. * the command is addressed to. Shift any flag left by
  2239. * ETH_RESET_SHARED_SHIFT to reset a shared component of the
  2240. * same type.
  2241. */
  2242. ETH_RESET_MGMT = 1 << 0, /* Management processor */
  2243. ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */
  2244. ETH_RESET_DMA = 1 << 2, /* DMA engine */
  2245. ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */
  2246. ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */
  2247. ETH_RESET_MAC = 1 << 5, /* Media access controller */
  2248. ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */
  2249. ETH_RESET_RAM = 1 << 7, /* RAM shared between
  2250. * multiple components */
  2251. ETH_RESET_AP = 1 << 8, /* Application processor */
  2252. ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to
  2253. * this interface */
  2254. ETH_RESET_ALL = 0xffffffff, /* All components used by this
  2255. * interface, even if shared */
  2256. };
  2257. #define ETH_RESET_SHARED_SHIFT 16
  2258. /**
  2259. * struct ethtool_link_settings - link control and status
  2260. *
  2261. * IMPORTANT, Backward compatibility notice: When implementing new
  2262. * user-space tools, please first try %ETHTOOL_GLINKSETTINGS, and
  2263. * if it succeeds use %ETHTOOL_SLINKSETTINGS to change link
  2264. * settings; do not use %ETHTOOL_SSET if %ETHTOOL_GLINKSETTINGS
  2265. * succeeded: stick to %ETHTOOL_GLINKSETTINGS/%SLINKSETTINGS in
  2266. * that case. Conversely, if %ETHTOOL_GLINKSETTINGS fails, use
  2267. * %ETHTOOL_GSET to query and %ETHTOOL_SSET to change link
  2268. * settings; do not use %ETHTOOL_SLINKSETTINGS if
  2269. * %ETHTOOL_GLINKSETTINGS failed: stick to
  2270. * %ETHTOOL_GSET/%ETHTOOL_SSET in that case.
  2271. *
  2272. * @cmd: Command number = %ETHTOOL_GLINKSETTINGS or %ETHTOOL_SLINKSETTINGS
  2273. * @speed: Link speed (Mbps)
  2274. * @duplex: Duplex mode; one of %DUPLEX_*
  2275. * @port: Physical connector type; one of %PORT_*
  2276. * @phy_address: MDIO address of PHY (transceiver); 0 or 255 if not
  2277. * applicable. For clause 45 PHYs this is the PRTAD.
  2278. * @autoneg: Enable/disable autonegotiation and auto-detection;
  2279. * either %AUTONEG_DISABLE or %AUTONEG_ENABLE
  2280. * @mdio_support: Bitmask of %ETH_MDIO_SUPPORTS_* flags for the MDIO
  2281. * protocols supported by the interface; 0 if unknown.
  2282. * Read-only.
  2283. * @eth_tp_mdix: Ethernet twisted-pair MDI(-X) status; one of
  2284. * %ETH_TP_MDI_*. If the status is unknown or not applicable, the
  2285. * value will be %ETH_TP_MDI_INVALID. Read-only.
  2286. * @eth_tp_mdix_ctrl: Ethernet twisted pair MDI(-X) control; one of
  2287. * %ETH_TP_MDI_*. If MDI(-X) control is not implemented, reads
  2288. * yield %ETH_TP_MDI_INVALID and writes may be ignored or rejected.
  2289. * When written successfully, the link should be renegotiated if
  2290. * necessary.
  2291. * @link_mode_masks_nwords: Number of 32-bit words for each of the
  2292. * supported, advertising, lp_advertising link mode bitmaps. For
  2293. * %ETHTOOL_GLINKSETTINGS: on entry, number of words passed by user
  2294. * (>= 0); on return, if handshake in progress, negative if
  2295. * request size unsupported by kernel: absolute value indicates
  2296. * kernel expected size and all the other fields but cmd
  2297. * are 0; otherwise (handshake completed), strictly positive
  2298. * to indicate size used by kernel and cmd field stays
  2299. * %ETHTOOL_GLINKSETTINGS, all other fields populated by driver. For
  2300. * %ETHTOOL_SLINKSETTINGS: must be valid on entry, ie. a positive
  2301. * value returned previously by %ETHTOOL_GLINKSETTINGS, otherwise
  2302. * refused. For drivers: ignore this field (use kernel's
  2303. * __ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will
  2304. * be overwritten by kernel.
  2305. * @transceiver: Used to distinguish different possible PHY types,
  2306. * reported consistently by PHYLIB. Read-only.
  2307. * @master_slave_cfg: Master/slave port mode.
  2308. * @master_slave_state: Master/slave port state.
  2309. * @rate_matching: Rate adaptation performed by the PHY
  2310. * @reserved: Reserved for future use; see the note on reserved space.
  2311. * @link_mode_masks: Variable length bitmaps.
  2312. *
  2313. * If autonegotiation is disabled, the speed and @duplex represent the
  2314. * fixed link mode and are writable if the driver supports multiple
  2315. * link modes. If it is enabled then they are read-only; if the link
  2316. * is up they represent the negotiated link mode; if the link is down,
  2317. * the speed is 0, %SPEED_UNKNOWN or the highest enabled speed and
  2318. * @duplex is %DUPLEX_UNKNOWN or the best enabled duplex mode.
  2319. *
  2320. * Some hardware interfaces may have multiple PHYs and/or physical
  2321. * connectors fitted or do not allow the driver to detect which are
  2322. * fitted. For these interfaces @port and/or @phy_address may be
  2323. * writable, possibly dependent on @autoneg being %AUTONEG_DISABLE.
  2324. * Otherwise, attempts to write different values may be ignored or
  2325. * rejected.
  2326. *
  2327. * Deprecated %ethtool_cmd fields transceiver, maxtxpkt and maxrxpkt
  2328. * are not available in %ethtool_link_settings. These fields will be
  2329. * always set to zero in %ETHTOOL_GSET reply and %ETHTOOL_SSET will
  2330. * fail if any of them is set to non-zero value.
  2331. *
  2332. * Users should assume that all fields not marked read-only are
  2333. * writable and subject to validation by the driver. They should use
  2334. * %ETHTOOL_GLINKSETTINGS to get the current values before making specific
  2335. * changes and then applying them with %ETHTOOL_SLINKSETTINGS.
  2336. *
  2337. * Drivers that implement %get_link_ksettings and/or
  2338. * %set_link_ksettings should ignore the @cmd
  2339. * and @link_mode_masks_nwords fields (any change to them overwritten
  2340. * by kernel), and rely only on kernel's internal
  2341. * %__ETHTOOL_LINK_MODE_MASK_NBITS and
  2342. * %ethtool_link_mode_mask_t. Drivers that implement
  2343. * %set_link_ksettings() should validate all fields other than @cmd
  2344. * and @link_mode_masks_nwords that are not described as read-only or
  2345. * deprecated, and must ignore all fields described as read-only.
  2346. *
  2347. * @link_mode_masks is divided into three bitfields, each of length
  2348. * @link_mode_masks_nwords:
  2349. * - supported: Bitmap with each bit meaning given by
  2350. * %ethtool_link_mode_bit_indices for the link modes, physical
  2351. * connectors and other link features for which the interface
  2352. * supports autonegotiation or auto-detection. Read-only.
  2353. * - advertising: Bitmap with each bit meaning given by
  2354. * %ethtool_link_mode_bit_indices for the link modes, physical
  2355. * connectors and other link features that are advertised through
  2356. * autonegotiation or enabled for auto-detection.
  2357. * - lp_advertising: Bitmap with each bit meaning given by
  2358. * %ethtool_link_mode_bit_indices for the link modes, and other
  2359. * link features that the link partner advertised through
  2360. * autonegotiation; 0 if unknown or not applicable. Read-only.
  2361. */
  2362. struct ethtool_link_settings {
  2363. uint32_t cmd;
  2364. uint32_t speed;
  2365. uint8_t duplex;
  2366. uint8_t port;
  2367. uint8_t phy_address;
  2368. uint8_t autoneg;
  2369. uint8_t mdio_support;
  2370. uint8_t eth_tp_mdix;
  2371. uint8_t eth_tp_mdix_ctrl;
  2372. int8_t link_mode_masks_nwords;
  2373. uint8_t transceiver;
  2374. uint8_t master_slave_cfg;
  2375. uint8_t master_slave_state;
  2376. uint8_t rate_matching;
  2377. uint32_t reserved[7];
  2378. /* Linux builds with -Wflex-array-member-not-at-end but does
  2379. * not use the "link_mode_masks" member. Leave it defined for
  2380. * userspace for now, and when userspace wants to start using
  2381. * -Wfamnae, we'll need a new solution.
  2382. */
  2383. uint32_t link_mode_masks[];
  2384. /* layout of link_mode_masks fields:
  2385. * uint32_t map_supported[link_mode_masks_nwords];
  2386. * uint32_t map_advertising[link_mode_masks_nwords];
  2387. * uint32_t map_lp_advertising[link_mode_masks_nwords];
  2388. */
  2389. };
  2390. /**
  2391. * enum phy_upstream - Represents the upstream component a given PHY device
  2392. * is connected to, as in what is on the other end of the MII bus. Most PHYs
  2393. * will be attached to an Ethernet MAC controller, but in some cases, there's
  2394. * an intermediate PHY used as a media-converter, which will driver another
  2395. * MII interface as its output.
  2396. * @PHY_UPSTREAM_MAC: Upstream component is a MAC (a switch port,
  2397. * or ethernet controller)
  2398. * @PHY_UPSTREAM_PHY: Upstream component is a PHY (likely a media converter)
  2399. */
  2400. enum phy_upstream {
  2401. PHY_UPSTREAM_MAC,
  2402. PHY_UPSTREAM_PHY,
  2403. };
  2404. #endif /* _LINUX_ETHTOOL_H */