Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * ethtool.h: Defines for Linux ethtool. | |
3 | * | |
4 | * Copyright (C) 1998 David S. Miller (davem@redhat.com) | |
5 | * Copyright 2001 Jeff Garzik <jgarzik@pobox.com> | |
6 | * Portions Copyright 2001 Sun Microsystems (thockin@sun.com) | |
7 | * Portions Copyright 2002 Intel (eli.kupermann@intel.com, | |
8 | * christopher.leech@intel.com, | |
9 | * scott.feldman@intel.com) | |
59089d8d | 10 | * Portions Copyright (C) Sun Microsystems 2008 |
1da177e4 | 11 | */ |
1da177e4 LT |
12 | #ifndef _LINUX_ETHTOOL_H |
13 | #define _LINUX_ETHTOOL_H | |
14 | ||
3a7da39d | 15 | #include <linux/compat.h> |
607ca46e | 16 | #include <uapi/linux/ethtool.h> |
3ae7c0b2 | 17 | |
3a7da39d BH |
18 | #ifdef CONFIG_COMPAT |
19 | ||
20 | struct compat_ethtool_rx_flow_spec { | |
21 | u32 flow_type; | |
127fe533 AD |
22 | union ethtool_flow_union h_u; |
23 | struct ethtool_flow_ext h_ext; | |
24 | union ethtool_flow_union m_u; | |
25 | struct ethtool_flow_ext m_ext; | |
3a7da39d BH |
26 | compat_u64 ring_cookie; |
27 | u32 location; | |
28 | }; | |
29 | ||
30 | struct compat_ethtool_rxnfc { | |
31 | u32 cmd; | |
32 | u32 flow_type; | |
33 | compat_u64 data; | |
34 | struct compat_ethtool_rx_flow_spec fs; | |
35 | u32 rule_cnt; | |
36 | u32 rule_locs[0]; | |
37 | }; | |
38 | ||
39 | #endif /* CONFIG_COMPAT */ | |
c3ce7e20 | 40 | |
a1467085 DM |
41 | #include <linux/rculist.h> |
42 | ||
4bc71cb9 JP |
43 | extern int __ethtool_get_settings(struct net_device *dev, |
44 | struct ethtool_cmd *cmd); | |
45 | ||
68f512f2 BH |
46 | /** |
47 | * enum ethtool_phys_id_state - indicator state for physical identification | |
48 | * @ETHTOOL_ID_INACTIVE: Physical ID indicator should be deactivated | |
49 | * @ETHTOOL_ID_ACTIVE: Physical ID indicator should be activated | |
50 | * @ETHTOOL_ID_ON: LED should be turned on (used iff %ETHTOOL_ID_ACTIVE | |
51 | * is not supported) | |
52 | * @ETHTOOL_ID_OFF: LED should be turned off (used iff %ETHTOOL_ID_ACTIVE | |
53 | * is not supported) | |
54 | */ | |
55 | enum ethtool_phys_id_state { | |
56 | ETHTOOL_ID_INACTIVE, | |
57 | ETHTOOL_ID_ACTIVE, | |
58 | ETHTOOL_ID_ON, | |
59 | ETHTOOL_ID_OFF | |
60 | }; | |
61 | ||
1da177e4 LT |
62 | struct net_device; |
63 | ||
64 | /* Some generic methods drivers may use in their ethtool_ops */ | |
65 | u32 ethtool_op_get_link(struct net_device *dev); | |
02eacbd0 | 66 | int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti); |
1da177e4 | 67 | |
278bc429 BH |
68 | /** |
69 | * ethtool_rxfh_indir_default - get default value for RX flow hash indirection | |
70 | * @index: Index in RX flow hash indirection table | |
71 | * @n_rx_rings: Number of RX rings to use | |
72 | * | |
73 | * This function provides the default policy for RX flow hash indirection. | |
74 | */ | |
75 | static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings) | |
76 | { | |
77 | return index % n_rx_rings; | |
78 | } | |
79 | ||
1da177e4 | 80 | /** |
8717d07b BH |
81 | * struct ethtool_ops - optional netdev operations |
82 | * @get_settings: Get various device settings including Ethernet link | |
8ae6daca DD |
83 | * settings. The @cmd parameter is expected to have been cleared |
84 | * before get_settings is called. Returns a negative error code or | |
85 | * zero. | |
8717d07b BH |
86 | * @set_settings: Set various device settings including Ethernet link |
87 | * settings. Returns a negative error code or zero. | |
88 | * @get_drvinfo: Report driver/device information. Should only set the | |
89 | * @driver, @version, @fw_version and @bus_info fields. If not | |
90 | * implemented, the @driver and @bus_info fields will be filled in | |
91 | * according to the netdev's parent device. | |
92 | * @get_regs_len: Get buffer length required for @get_regs | |
e20b5b61 BH |
93 | * @get_regs: Get device registers |
94 | * @get_wol: Report whether Wake-on-Lan is enabled | |
8717d07b BH |
95 | * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code |
96 | * or zero. | |
97 | * @get_msglevel: Report driver message level. This should be the value | |
98 | * of the @msg_enable field used by netif logging functions. | |
e20b5b61 | 99 | * @set_msglevel: Set driver message level |
8717d07b BH |
100 | * @nway_reset: Restart autonegotiation. Returns a negative error code |
101 | * or zero. | |
102 | * @get_link: Report whether physical link is up. Will only be called if | |
103 | * the netdev is up. Should usually be set to ethtool_op_get_link(), | |
104 | * which uses netif_carrier_ok(). | |
e20b5b61 | 105 | * @get_eeprom: Read data from the device EEPROM. |
1da177e4 LT |
106 | * Should fill in the magic field. Don't need to check len for zero |
107 | * or wraparound. Fill in the data argument with the eeprom values | |
108 | * from offset to offset + len. Update len to the amount read. | |
109 | * Returns an error or zero. | |
e20b5b61 | 110 | * @set_eeprom: Write data to the device EEPROM. |
1da177e4 LT |
111 | * Should validate the magic field. Don't need to check len for zero |
112 | * or wraparound. Update len to the amount written. Returns an error | |
113 | * or zero. | |
8717d07b BH |
114 | * @get_coalesce: Get interrupt coalescing parameters. Returns a negative |
115 | * error code or zero. | |
116 | * @set_coalesce: Set interrupt coalescing parameters. Returns a negative | |
117 | * error code or zero. | |
e20b5b61 | 118 | * @get_ringparam: Report ring sizes |
8717d07b | 119 | * @set_ringparam: Set ring sizes. Returns a negative error code or zero. |
e20b5b61 | 120 | * @get_pauseparam: Report pause parameters |
8717d07b BH |
121 | * @set_pauseparam: Set pause parameters. Returns a negative error code |
122 | * or zero. | |
e20b5b61 BH |
123 | * @self_test: Run specified self-tests |
124 | * @get_strings: Return a set of strings that describe the requested objects | |
68f512f2 BH |
125 | * @set_phys_id: Identify the physical devices, e.g. by flashing an LED |
126 | * attached to it. The implementation may update the indicator | |
127 | * asynchronously or synchronously, but in either case it must return | |
128 | * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE, | |
fce55922 AB |
129 | * and must either activate asynchronous updates and return zero, return |
130 | * a negative error or return a positive frequency for synchronous | |
131 | * indication (e.g. 1 for one on/off cycle per second). If it returns | |
132 | * a frequency then it will be called again at intervals with the | |
68f512f2 BH |
133 | * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of |
134 | * the indicator accordingly. Finally, it is called with the argument | |
135 | * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a | |
136 | * negative error code or zero. | |
8717d07b BH |
137 | * @get_ethtool_stats: Return extended statistics about the device. |
138 | * This is only useful if the device maintains statistics not | |
139 | * included in &struct rtnl_link_stats64. | |
140 | * @begin: Function to be called before any other operation. Returns a | |
141 | * negative error code or zero. | |
142 | * @complete: Function to be called after any other operation except | |
143 | * @begin. Will be called even if the other operation failed. | |
8717d07b BH |
144 | * @get_priv_flags: Report driver-specific feature flags. |
145 | * @set_priv_flags: Set driver-specific feature flags. Returns a negative | |
146 | * error code or zero. | |
147 | * @get_sset_count: Get number of strings that @get_strings will write. | |
148 | * @get_rxnfc: Get RX flow classification rules. Returns a negative | |
149 | * error code or zero. | |
150 | * @set_rxnfc: Set RX flow classification rules. Returns a negative | |
151 | * error code or zero. | |
152 | * @flash_device: Write a firmware image to device's flash memory. | |
153 | * Returns a negative error code or zero. | |
154 | * @reset: Reset (part of) the device, as specified by a bitmask of | |
155 | * flags from &enum ethtool_reset_flags. Returns a negative | |
156 | * error code or zero. | |
7850f63f BH |
157 | * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table. |
158 | * Returns zero if not supported for this specific device. | |
8717d07b | 159 | * @get_rxfh_indir: Get the contents of the RX flow hash indirection table. |
7850f63f | 160 | * Will not be called if @get_rxfh_indir_size returns zero. |
8717d07b BH |
161 | * Returns a negative error code or zero. |
162 | * @set_rxfh_indir: Set the contents of the RX flow hash indirection table. | |
7850f63f | 163 | * Will not be called if @get_rxfh_indir_size returns zero. |
8717d07b | 164 | * Returns a negative error code or zero. |
8b5933c3 | 165 | * @get_channels: Get number of channels. |
166 | * @set_channels: Set number of channels. Returns a negative error code or | |
167 | * zero. | |
29dd54b7 AC |
168 | * @get_dump_flag: Get dump flag indicating current dump length, version, |
169 | * and flag of the device. | |
170 | * @get_dump_data: Get dump data. | |
171 | * @set_dump: Set dump specific flags to the device. | |
c8f3a8c3 RC |
172 | * @get_ts_info: Get the time stamping and PTP hardware clock capabilities. |
173 | * Drivers supporting transmit time stamps in software should set this to | |
174 | * ethtool_op_get_ts_info(). | |
41c3cb6d SH |
175 | * @get_module_info: Get the size and type of the eeprom contained within |
176 | * a plug-in module. | |
177 | * @get_module_eeprom: Get the eeprom information from the plug-in module | |
80f12ecc YM |
178 | * @get_eee: Get Energy-Efficient (EEE) supported and status. |
179 | * @set_eee: Set EEE status (enable/disable) as well as LPI timers. | |
8717d07b BH |
180 | * |
181 | * All operations are optional (i.e. the function pointer may be set | |
182 | * to %NULL) and callers must take this into account. Callers must | |
b4f79e5c | 183 | * hold the RTNL lock. |
8717d07b BH |
184 | * |
185 | * See the structures used by these operations for further documentation. | |
6e201c85 BH |
186 | * Note that for all operations using a structure ending with a zero- |
187 | * length array, the array is allocated separately in the kernel and | |
188 | * is passed to the driver as an additional parameter. | |
8717d07b BH |
189 | * |
190 | * See &struct net_device and &struct net_device_ops for documentation | |
191 | * of the generic netdev features interface. | |
1da177e4 LT |
192 | */ |
193 | struct ethtool_ops { | |
194 | int (*get_settings)(struct net_device *, struct ethtool_cmd *); | |
195 | int (*set_settings)(struct net_device *, struct ethtool_cmd *); | |
196 | void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *); | |
197 | int (*get_regs_len)(struct net_device *); | |
198 | void (*get_regs)(struct net_device *, struct ethtool_regs *, void *); | |
199 | void (*get_wol)(struct net_device *, struct ethtool_wolinfo *); | |
200 | int (*set_wol)(struct net_device *, struct ethtool_wolinfo *); | |
201 | u32 (*get_msglevel)(struct net_device *); | |
202 | void (*set_msglevel)(struct net_device *, u32); | |
203 | int (*nway_reset)(struct net_device *); | |
204 | u32 (*get_link)(struct net_device *); | |
205 | int (*get_eeprom_len)(struct net_device *); | |
97f8aefb | 206 | int (*get_eeprom)(struct net_device *, |
207 | struct ethtool_eeprom *, u8 *); | |
208 | int (*set_eeprom)(struct net_device *, | |
209 | struct ethtool_eeprom *, u8 *); | |
1da177e4 LT |
210 | int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *); |
211 | int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *); | |
97f8aefb | 212 | void (*get_ringparam)(struct net_device *, |
213 | struct ethtool_ringparam *); | |
214 | int (*set_ringparam)(struct net_device *, | |
215 | struct ethtool_ringparam *); | |
216 | void (*get_pauseparam)(struct net_device *, | |
217 | struct ethtool_pauseparam*); | |
218 | int (*set_pauseparam)(struct net_device *, | |
219 | struct ethtool_pauseparam*); | |
1da177e4 LT |
220 | void (*self_test)(struct net_device *, struct ethtool_test *, u64 *); |
221 | void (*get_strings)(struct net_device *, u32 stringset, u8 *); | |
68f512f2 | 222 | int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state); |
97f8aefb | 223 | void (*get_ethtool_stats)(struct net_device *, |
224 | struct ethtool_stats *, u64 *); | |
1da177e4 LT |
225 | int (*begin)(struct net_device *); |
226 | void (*complete)(struct net_device *); | |
97f8aefb | 227 | u32 (*get_priv_flags)(struct net_device *); |
228 | int (*set_priv_flags)(struct net_device *, u32); | |
ff03d49f | 229 | int (*get_sset_count)(struct net_device *, int); |
97f8aefb | 230 | int (*get_rxnfc)(struct net_device *, |
815c7db5 | 231 | struct ethtool_rxnfc *, u32 *rule_locs); |
59089d8d | 232 | int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *); |
97f8aefb | 233 | int (*flash_device)(struct net_device *, struct ethtool_flash *); |
d73d3a8c | 234 | int (*reset)(struct net_device *, u32 *); |
7850f63f BH |
235 | u32 (*get_rxfh_indir_size)(struct net_device *); |
236 | int (*get_rxfh_indir)(struct net_device *, u32 *); | |
237 | int (*set_rxfh_indir)(struct net_device *, const u32 *); | |
8b5933c3 | 238 | void (*get_channels)(struct net_device *, struct ethtool_channels *); |
239 | int (*set_channels)(struct net_device *, struct ethtool_channels *); | |
29dd54b7 AC |
240 | int (*get_dump_flag)(struct net_device *, struct ethtool_dump *); |
241 | int (*get_dump_data)(struct net_device *, | |
242 | struct ethtool_dump *, void *); | |
243 | int (*set_dump)(struct net_device *, struct ethtool_dump *); | |
c8f3a8c3 | 244 | int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *); |
41c3cb6d SH |
245 | int (*get_module_info)(struct net_device *, |
246 | struct ethtool_modinfo *); | |
247 | int (*get_module_eeprom)(struct net_device *, | |
248 | struct ethtool_eeprom *, u8 *); | |
80f12ecc YM |
249 | int (*get_eee)(struct net_device *, struct ethtool_eee *); |
250 | int (*set_eee)(struct net_device *, struct ethtool_eee *); | |
41c3cb6d | 251 | |
8b5933c3 | 252 | |
1da177e4 | 253 | }; |
1da177e4 | 254 | #endif /* _LINUX_ETHTOOL_H */ |