1 /*
2 * ethtool.h: Defines for Linux ethtool.
3 *
4 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
5 * Copyright 2001 Jeff Garzik <jgarzik@pobox.com>
6 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
7 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
8 * christopher.leech@intel.com,
9 * scott.feldman@intel.com)
10 * Portions Copyright (C) Sun Microsystems 2008
11 */
12 #ifndef _LINUX_ETHTOOL_H
13 #define _LINUX_ETHTOOL_H
14
15 #include <linux/compat.h>
16 #include <uapi/linux/ethtool.h>
17
18 #ifdef CONFIG_COMPAT
19
20 struct compat_ethtool_rx_flow_spec {
21 u32 flow_type;
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;
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 */
40
41 #include <linux/rculist.h>
42
43 extern int __ethtool_get_settings(struct net_device *dev,
44 struct ethtool_cmd *cmd);
45
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
62 enum {
63 ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
64 ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
65
66 /*
67 * Add your fresh new hash function bits above and remember to update
68 * rss_hash_func_strings[] in ethtool.c
69 */
70 ETH_RSS_HASH_FUNCS_COUNT
71 };
72
73 #define __ETH_RSS_HASH_BIT(bit) ((u32)1 << (bit))
74 #define __ETH_RSS_HASH(name) __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT)
75
76 #define ETH_RSS_HASH_TOP __ETH_RSS_HASH(TOP)
77 #define ETH_RSS_HASH_XOR __ETH_RSS_HASH(XOR)
78
79 #define ETH_RSS_HASH_UNKNOWN 0
80 #define ETH_RSS_HASH_NO_CHANGE 0
81
82 struct net_device;
83
84 /* Some generic methods drivers may use in their ethtool_ops */
85 u32 ethtool_op_get_link(struct net_device *dev);
86 int ethtool_op_get_ts_info(struct net_device *dev, struct ethtool_ts_info *eti);
87
88 /**
89 * ethtool_rxfh_indir_default - get default value for RX flow hash indirection
90 * @index: Index in RX flow hash indirection table
91 * @n_rx_rings: Number of RX rings to use
92 *
93 * This function provides the default policy for RX flow hash indirection.
94 */
ethtool_rxfh_indir_default(u32 index,u32 n_rx_rings)95 static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)
96 {
97 return index % n_rx_rings;
98 }
99
100 /**
101 * struct ethtool_ops - optional netdev operations
102 * @get_settings: Get various device settings including Ethernet link
103 * settings. The @cmd parameter is expected to have been cleared
104 * before get_settings is called. Returns a negative error code or
105 * zero.
106 * @set_settings: Set various device settings including Ethernet link
107 * settings. Returns a negative error code or zero.
108 * @get_drvinfo: Report driver/device information. Should only set the
109 * @driver, @version, @fw_version and @bus_info fields. If not
110 * implemented, the @driver and @bus_info fields will be filled in
111 * according to the netdev's parent device.
112 * @get_regs_len: Get buffer length required for @get_regs
113 * @get_regs: Get device registers
114 * @get_wol: Report whether Wake-on-Lan is enabled
115 * @set_wol: Turn Wake-on-Lan on or off. Returns a negative error code
116 * or zero.
117 * @get_msglevel: Report driver message level. This should be the value
118 * of the @msg_enable field used by netif logging functions.
119 * @set_msglevel: Set driver message level
120 * @nway_reset: Restart autonegotiation. Returns a negative error code
121 * or zero.
122 * @get_link: Report whether physical link is up. Will only be called if
123 * the netdev is up. Should usually be set to ethtool_op_get_link(),
124 * which uses netif_carrier_ok().
125 * @get_eeprom: Read data from the device EEPROM.
126 * Should fill in the magic field. Don't need to check len for zero
127 * or wraparound. Fill in the data argument with the eeprom values
128 * from offset to offset + len. Update len to the amount read.
129 * Returns an error or zero.
130 * @set_eeprom: Write data to the device EEPROM.
131 * Should validate the magic field. Don't need to check len for zero
132 * or wraparound. Update len to the amount written. Returns an error
133 * or zero.
134 * @get_coalesce: Get interrupt coalescing parameters. Returns a negative
135 * error code or zero.
136 * @set_coalesce: Set interrupt coalescing parameters. Returns a negative
137 * error code or zero.
138 * @get_ringparam: Report ring sizes
139 * @set_ringparam: Set ring sizes. Returns a negative error code or zero.
140 * @get_pauseparam: Report pause parameters
141 * @set_pauseparam: Set pause parameters. Returns a negative error code
142 * or zero.
143 * @self_test: Run specified self-tests
144 * @get_strings: Return a set of strings that describe the requested objects
145 * @set_phys_id: Identify the physical devices, e.g. by flashing an LED
146 * attached to it. The implementation may update the indicator
147 * asynchronously or synchronously, but in either case it must return
148 * quickly. It is initially called with the argument %ETHTOOL_ID_ACTIVE,
149 * and must either activate asynchronous updates and return zero, return
150 * a negative error or return a positive frequency for synchronous
151 * indication (e.g. 1 for one on/off cycle per second). If it returns
152 * a frequency then it will be called again at intervals with the
153 * argument %ETHTOOL_ID_ON or %ETHTOOL_ID_OFF and should set the state of
154 * the indicator accordingly. Finally, it is called with the argument
155 * %ETHTOOL_ID_INACTIVE and must deactivate the indicator. Returns a
156 * negative error code or zero.
157 * @get_ethtool_stats: Return extended statistics about the device.
158 * This is only useful if the device maintains statistics not
159 * included in &struct rtnl_link_stats64.
160 * @begin: Function to be called before any other operation. Returns a
161 * negative error code or zero.
162 * @complete: Function to be called after any other operation except
163 * @begin. Will be called even if the other operation failed.
164 * @get_priv_flags: Report driver-specific feature flags.
165 * @set_priv_flags: Set driver-specific feature flags. Returns a negative
166 * error code or zero.
167 * @get_sset_count: Get number of strings that @get_strings will write.
168 * @get_rxnfc: Get RX flow classification rules. Returns a negative
169 * error code or zero.
170 * @set_rxnfc: Set RX flow classification rules. Returns a negative
171 * error code or zero.
172 * @flash_device: Write a firmware image to device's flash memory.
173 * Returns a negative error code or zero.
174 * @reset: Reset (part of) the device, as specified by a bitmask of
175 * flags from &enum ethtool_reset_flags. Returns a negative
176 * error code or zero.
177 * @get_rxfh_key_size: Get the size of the RX flow hash key.
178 * Returns zero if not supported for this specific device.
179 * @get_rxfh_indir_size: Get the size of the RX flow hash indirection table.
180 * Returns zero if not supported for this specific device.
181 * @get_rxfh: Get the contents of the RX flow hash indirection table, hash key
182 * and/or hash function.
183 * Returns a negative error code or zero.
184 * @set_rxfh: Set the contents of the RX flow hash indirection table, hash
185 * key, and/or hash function. Arguments which are set to %NULL or zero
186 * will remain unchanged.
187 * Returns a negative error code or zero. An error code must be returned
188 * if at least one unsupported change was requested.
189 * @get_channels: Get number of channels.
190 * @set_channels: Set number of channels. Returns a negative error code or
191 * zero.
192 * @get_dump_flag: Get dump flag indicating current dump length, version,
193 * and flag of the device.
194 * @get_dump_data: Get dump data.
195 * @set_dump: Set dump specific flags to the device.
196 * @get_ts_info: Get the time stamping and PTP hardware clock capabilities.
197 * Drivers supporting transmit time stamps in software should set this to
198 * ethtool_op_get_ts_info().
199 * @get_module_info: Get the size and type of the eeprom contained within
200 * a plug-in module.
201 * @get_module_eeprom: Get the eeprom information from the plug-in module
202 * @get_eee: Get Energy-Efficient (EEE) supported and status.
203 * @set_eee: Set EEE status (enable/disable) as well as LPI timers.
204 *
205 * All operations are optional (i.e. the function pointer may be set
206 * to %NULL) and callers must take this into account. Callers must
207 * hold the RTNL lock.
208 *
209 * See the structures used by these operations for further documentation.
210 * Note that for all operations using a structure ending with a zero-
211 * length array, the array is allocated separately in the kernel and
212 * is passed to the driver as an additional parameter.
213 *
214 * See &struct net_device and &struct net_device_ops for documentation
215 * of the generic netdev features interface.
216 */
217 struct ethtool_ops {
218 int (*get_settings)(struct net_device *, struct ethtool_cmd *);
219 int (*set_settings)(struct net_device *, struct ethtool_cmd *);
220 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *);
221 int (*get_regs_len)(struct net_device *);
222 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *);
223 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *);
224 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *);
225 u32 (*get_msglevel)(struct net_device *);
226 void (*set_msglevel)(struct net_device *, u32);
227 int (*nway_reset)(struct net_device *);
228 u32 (*get_link)(struct net_device *);
229 int (*get_eeprom_len)(struct net_device *);
230 int (*get_eeprom)(struct net_device *,
231 struct ethtool_eeprom *, u8 *);
232 int (*set_eeprom)(struct net_device *,
233 struct ethtool_eeprom *, u8 *);
234 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *);
235 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *);
236 void (*get_ringparam)(struct net_device *,
237 struct ethtool_ringparam *);
238 int (*set_ringparam)(struct net_device *,
239 struct ethtool_ringparam *);
240 void (*get_pauseparam)(struct net_device *,
241 struct ethtool_pauseparam*);
242 int (*set_pauseparam)(struct net_device *,
243 struct ethtool_pauseparam*);
244 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *);
245 void (*get_strings)(struct net_device *, u32 stringset, u8 *);
246 int (*set_phys_id)(struct net_device *, enum ethtool_phys_id_state);
247 void (*get_ethtool_stats)(struct net_device *,
248 struct ethtool_stats *, u64 *);
249 int (*begin)(struct net_device *);
250 void (*complete)(struct net_device *);
251 u32 (*get_priv_flags)(struct net_device *);
252 int (*set_priv_flags)(struct net_device *, u32);
253 int (*get_sset_count)(struct net_device *, int);
254 int (*get_rxnfc)(struct net_device *,
255 struct ethtool_rxnfc *, u32 *rule_locs);
256 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *);
257 int (*flash_device)(struct net_device *, struct ethtool_flash *);
258 int (*reset)(struct net_device *, u32 *);
259 u32 (*get_rxfh_key_size)(struct net_device *);
260 u32 (*get_rxfh_indir_size)(struct net_device *);
261 int (*get_rxfh)(struct net_device *, u32 *indir, u8 *key,
262 u8 *hfunc);
263 int (*set_rxfh)(struct net_device *, const u32 *indir,
264 const u8 *key, const u8 hfunc);
265 void (*get_channels)(struct net_device *, struct ethtool_channels *);
266 int (*set_channels)(struct net_device *, struct ethtool_channels *);
267 int (*get_dump_flag)(struct net_device *, struct ethtool_dump *);
268 int (*get_dump_data)(struct net_device *,
269 struct ethtool_dump *, void *);
270 int (*set_dump)(struct net_device *, struct ethtool_dump *);
271 int (*get_ts_info)(struct net_device *, struct ethtool_ts_info *);
272 int (*get_module_info)(struct net_device *,
273 struct ethtool_modinfo *);
274 int (*get_module_eeprom)(struct net_device *,
275 struct ethtool_eeprom *, u8 *);
276 int (*get_eee)(struct net_device *, struct ethtool_eee *);
277 int (*set_eee)(struct net_device *, struct ethtool_eee *);
278 int (*get_tunable)(struct net_device *,
279 const struct ethtool_tunable *, void *);
280 int (*set_tunable)(struct net_device *,
281 const struct ethtool_tunable *, const void *);
282
283
284 };
285 #endif /* _LINUX_ETHTOOL_H */
286