File: ethtool-copy.h

package info (click to toggle)
python-ethtool 0.14-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 324 kB
  • sloc: ansic: 1,770; python: 1,509; makefile: 24; sh: 16
file content (375 lines) | stat: -rw-r--r-- 13,294 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
/*
 * ethtool.h: Defines for Linux ethtool.
 *
 * Copyright (C) 1998 David S. Miller (davem@redhat.com)
 * Copyright 2001 Jeff Garzik <jgarzik@mandrakesoft.com>
 * Portions Copyright 2001 Sun Microsystems (thockin@sun.com)
 * Portions Copyright 2002 Intel (eli.kupermann@intel.com,
 *                                christopher.leech@intel.com,
 *                                scott.feldman@intel.com)
 */

#ifndef _LINUX_ETHTOOL_H
#define _LINUX_ETHTOOL_H

#ifndef __unused
#define __unused __attribute__ ((unused))
#endif

/* This should work for both 32 and 64 bit userland. */
struct ethtool_cmd {
    u32 cmd;
    u32 supported;  /* Features this interface supports */
    u32 advertising;  /* Features this interface advertises */
    u16 speed;  /* The forced speed, 10Mb, 100Mb, gigabit */
    u8 duplex;  /* Duplex, half or full */
    u8 port;  /* Which connector port */
    u8 phy_address;
    u8 transceiver;  /* Which tranceiver to use */
    u8 autoneg;  /* Enable or disable autonegotiation */
    u32 maxtxpkt;  /* Tx pkts before generating tx int */
    u32 maxrxpkt;  /* Rx pkts before generating rx int */
    u32 reserved[4];
};

#define ETHTOOL_BUSINFO_LEN 32
/* these strings are set to whatever the driver author decides... */
struct ethtool_drvinfo {
    u32 cmd;
    char driver[32];  /* driver short name, "tulip", "eepro100" */
    char version[32];  /* driver version string */
    char fw_version[32];  /* firmware version string, if applicable */
    char bus_info[ETHTOOL_BUSINFO_LEN];  /* Bus info for this IF. */
    /* For PCI devices, use pci_dev->slot_name. */
    char reserved1[32];
    char reserved2[16];
    u32 n_stats;  /* number of u64's from ETHTOOL_GSTATS */
    u32 testinfo_len;
    u32 eedump_len;  /* Size of data from ETHTOOL_GEEPROM (bytes) */
    u32 regdump_len;  /* Size of data from ETHTOOL_GREGS (bytes) */
};

#define SOPASS_MAX 6
/* wake-on-lan settings */
struct ethtool_wolinfo {
    u32 cmd;
    u32 supported;
    u32 wolopts;
    u8 sopass[SOPASS_MAX];  /* SecureOn(tm) password */
};

/* for passing single values */
struct ethtool_value {
    u32 cmd;
    u32 data;
};

/* for passing big chunks of data */
struct ethtool_regs {
    u32 cmd;
    u32 version;  /* driver-specific, indicates different chips/revs */
    u32 len;  /* bytes */
    u8 data[0];
};

/* for passing EEPROM chunks */
struct ethtool_eeprom {
    u32 cmd;
    u32 magic;
    u32 offset;  /* in bytes */
    u32 len;  /* in bytes */
    u8 data[0];
};

/* for configuring coalescing parameters of chip */
struct ethtool_coalesce {
    u32 cmd;  /* ETHTOOL_{G,S}COALESCE */

    /* How many usecs to delay an RX interrupt after
     * a packet arrives.  If 0, only rx_max_coalesced_frames
     * is used.
     */
    u32 rx_coalesce_usecs;

    /* How many packets to delay an RX interrupt after
     * a packet arrives.  If 0, only rx_coalesce_usecs is
     * used.  It is illegal to set both usecs and max frames
     * to zero as this would cause RX interrupts to never be
     * generated.
     */
    u32 rx_max_coalesced_frames;

    /* Same as above two parameters, except that these values
     * apply while an IRQ is being services by the host.  Not
     * all cards support this feature and the values are ignored
     * in that case.
     */
    u32 rx_coalesce_usecs_irq;
    u32 rx_max_coalesced_frames_irq;

    /* How many usecs to delay a TX interrupt after
     * a packet is sent.  If 0, only tx_max_coalesced_frames
     * is used.
     */
    u32 tx_coalesce_usecs;

    /* How many packets to delay a TX interrupt after
     * a packet is sent.  If 0, only tx_coalesce_usecs is
     * used.  It is illegal to set both usecs and max frames
     * to zero as this would cause TX interrupts to never be
     * generated.
     */
    u32 tx_max_coalesced_frames;

    /* Same as above two parameters, except that these values
     * apply while an IRQ is being services by the host.  Not
     * all cards support this feature and the values are ignored
     * in that case.
     */
    u32 tx_coalesce_usecs_irq;
    u32 tx_max_coalesced_frames_irq;

    /* How many usecs to delay in-memory statistics
     * block updates.  Some drivers do not have an in-memory
     * statistic block, and in such cases this value is ignored.
     * This value must not be zero.
     */
    u32 stats_block_coalesce_usecs;

    /* Adaptive RX/TX coalescing is an algorithm implemented by
     * some drivers to improve latency under low packet rates and
     * improve throughput under high packet rates.  Some drivers
     * only implement one of RX or TX adaptive coalescing.  Anything
     * not implemented by the driver causes these values to be
     * silently ignored.
     */
    u32 use_adaptive_rx_coalesce;
    u32 use_adaptive_tx_coalesce;

    /* When the packet rate (measured in packets per second)
     * is below pkt_rate_low, the {rx,tx}_*_low parameters are
     * used.
     */
    u32 pkt_rate_low;
    u32 rx_coalesce_usecs_low;
    u32 rx_max_coalesced_frames_low;
    u32 tx_coalesce_usecs_low;
    u32 tx_max_coalesced_frames_low;

    /* When the packet rate is below pkt_rate_high but above
     * pkt_rate_low (both measured in packets per second) the
     * normal {rx,tx}_* coalescing parameters are used.
     */

    /* When the packet rate is (measured in packets per second)
     * is above pkt_rate_high, the {rx,tx}_*_high parameters are
     * used.
     */
    u32 pkt_rate_high;
    u32 rx_coalesce_usecs_high;
    u32 rx_max_coalesced_frames_high;
    u32 tx_coalesce_usecs_high;
    u32 tx_max_coalesced_frames_high;

    /* How often to do adaptive coalescing packet rate sampling,
     * measured in seconds.  Must not be zero.
     */
    u32 rate_sample_interval;
};

/* for configuring RX/TX ring parameters */
struct ethtool_ringparam {
    u32 cmd;  /* ETHTOOL_{G,S}RINGPARAM */

    /* Read only attributes.  These indicate the maximum number
     * of pending RX/TX ring entries the driver will allow the
     * user to set.
     */
    u32 rx_max_pending;
    u32 rx_mini_max_pending;
    u32 rx_jumbo_max_pending;
    u32 tx_max_pending;

    /* Values changeable by the user.  The valid values are
     * in the range 1 to the "*_max_pending" counterpart above.
     */
    u32 rx_pending;
    u32 rx_mini_pending;
    u32 rx_jumbo_pending;
    u32 tx_pending;
};

/* for configuring link flow control parameters */
struct ethtool_pauseparam {
    u32 cmd;  /* ETHTOOL_{G,S}PAUSEPARAM */

    /* If the link is being auto-negotiated (via ethtool_cmd.autoneg
     * being true) the user may set 'autonet' here non-zero to have the
     * pause parameters be auto-negotiated too.  In such a case, the
     * {rx,tx}_pause values below determine what capabilities are
     * advertised.
     *
     * If 'autoneg' is zero or the link is not being auto-negotiated,
     * then {rx,tx}_pause force the driver to use/not-use pause
     * flow control.
     */
    u32 autoneg;
    u32 rx_pause;
    u32 tx_pause;
};

#define ETH_GSTRING_LEN 32
enum ethtool_stringset {
    ETH_SS_TEST = 0,
    ETH_SS_STATS,
};

/* for passing string sets for data tagging */
struct ethtool_gstrings {
    u32 cmd;  /* ETHTOOL_GSTRINGS */
    u32 string_set;  /* string set id e.c. ETH_SS_TEST, etc*/
    u32 len;  /* number of strings in the string set */
    u8 data[0];
};

enum ethtool_test_flags {
    ETH_TEST_FL_OFFLINE = (1 << 0),  /* online / offline */
    ETH_TEST_FL_FAILED = (1 << 1),  /* test passed / failed */
};

/* for requesting NIC test and getting results*/
struct ethtool_test {
    u32 cmd;  /* ETHTOOL_TEST */
    u32 flags;  /* ETH_TEST_FL_xxx */
    u32 reserved;
    u32 len;  /* result length, in number of u64 elements */
    u64 data[0];
};

/* for dumping NIC-specific statistics */
struct ethtool_stats {
    u32 cmd;  /* ETHTOOL_GSTATS */
    u32 n_stats;  /* number of u64's being returned */
    u64 data[0];
};

/* CMDs currently supported */
#define ETHTOOL_GSET        0x00000001  /* Get settings. */
#define ETHTOOL_SSET        0x00000002  /* Set settings, privileged. */
#define ETHTOOL_GDRVINFO    0x00000003  /* Get driver info. */
#define ETHTOOL_GREGS       0x00000004  /* Get NIC registers, privileged. */
#define ETHTOOL_GWOL        0x00000005  /* Get wake-on-lan options. */
#define ETHTOOL_SWOL        0x00000006  /* Set wake-on-lan options, priv. */
#define ETHTOOL_GMSGLVL     0x00000007  /* Get driver message level */
#define ETHTOOL_SMSGLVL     0x00000008  /* Set driver msg level, priv. */
#define ETHTOOL_NWAY_RST    0x00000009  /* Restart autonegotiation, priv. */
#define ETHTOOL_GLINK       0x0000000a  /* Get link status (ethtool_value) */
#define ETHTOOL_GEEPROM     0x0000000b  /* Get EEPROM data */
#define ETHTOOL_SEEPROM     0x0000000c  /* Set EEPROM data, priv. */
#define ETHTOOL_GCOALESCE   0x0000000e  /* Get coalesce config */
#define ETHTOOL_SCOALESCE   0x0000000f  /* Set coalesce config, priv. */
#define ETHTOOL_GRINGPARAM  0x00000010  /* Get ring parameters */
#define ETHTOOL_SRINGPARAM  0x00000011  /* Set ring parameters, priv. */
#define ETHTOOL_GPAUSEPARAM 0x00000012  /* Get pause parameters */
#define ETHTOOL_SPAUSEPARAM 0x00000013  /* Set pause parameters, priv. */
#define ETHTOOL_GRXCSUM     0x00000014  /* Get RX hw csum enable (e.v.) */
#define ETHTOOL_SRXCSUM     0x00000015  /* Set RX hw csum enable (e.v.) */
#define ETHTOOL_GTXCSUM     0x00000016  /* Get TX hw csum enable (e.v.) */
#define ETHTOOL_STXCSUM     0x00000017  /* Set TX hw csum enable (e.v.) */
#define ETHTOOL_GSG         0x00000018  /* Get scatter-gather enable
                                         * (ethtool_value) */
#define ETHTOOL_SSG         0x00000019  /* Set scatter-gather enable
                                         * (ethtool_value), priv. */
#define ETHTOOL_TEST        0x0000001a  /* execute NIC self-test, priv. */
#define ETHTOOL_GSTRINGS    0x0000001b  /* get specified string set */
#define ETHTOOL_PHYS_ID     0x0000001c  /* identify the NIC */
#define ETHTOOL_GSTATS      0x0000001d  /* get NIC-specific statistics */
#define ETHTOOL_GTSO        0x0000001e  /* Get TSO enable (e.v.) */
#define ETHTOOL_STSO        0x0000001f  /* Set TSO enable (e.v.) */
#define ETHTOOL_GUFO        0x00000021  /* Get UFO enable (e.v.) */
#define ETHTOOL_SUFO        0x00000022  /* Set UFO enable (e.v.) */
#define ETHTOOL_GGSO        0x00000023  /* Get GSO enable (e.v.) */
#define ETHTOOL_SGSO        0x00000024  /* Set GSO enable (e.v.) */
#define ETHTOOL_GGRO        0x0000002b  /* Get GRO enable (e.v.) */
#define ETHTOOL_SGRO        0x0000002c  /* Set GRO enable (e.v.) */

/* compatibility with older code */
#define SPARC_ETH_GSET ETHTOOL_GSET
#define SPARC_ETH_SSET ETHTOOL_SSET

/* Indicates what features are supported by the interface. */
#define SUPPORTED_10baseT_Half     (1 << 0)
#define SUPPORTED_10baseT_Full     (1 << 1)
#define SUPPORTED_100baseT_Half    (1 << 2)
#define SUPPORTED_100baseT_Full    (1 << 3)
#define SUPPORTED_1000baseT_Half   (1 << 4)
#define SUPPORTED_1000baseT_Full   (1 << 5)
#define SUPPORTED_Autoneg          (1 << 6)
#define SUPPORTED_TP               (1 << 7)
#define SUPPORTED_AUI              (1 << 8)
#define SUPPORTED_MII              (1 << 9)
#define SUPPORTED_FIBRE            (1 << 10)
#define SUPPORTED_BNC              (1 << 11)
#define SUPPORTED_10000baseT_Full  (1 << 12)

/* Indicates what features are advertised by the interface. */
#define ADVERTISED_10baseT_Half    (1 << 0)
#define ADVERTISED_10baseT_Full    (1 << 1)
#define ADVERTISED_100baseT_Half   (1 << 2)
#define ADVERTISED_100baseT_Full   (1 << 3)
#define ADVERTISED_1000baseT_Half  (1 << 4)
#define ADVERTISED_1000baseT_Full  (1 << 5)
#define ADVERTISED_Autoneg         (1 << 6)
#define ADVERTISED_TP              (1 << 7)
#define ADVERTISED_AUI             (1 << 8)
#define ADVERTISED_MII             (1 << 9)
#define ADVERTISED_FIBRE           (1 << 10)
#define ADVERTISED_BNC             (1 << 11)
#define ADVERTISED_10000baseT_Full (1 << 12)

/* The following are all involved in forcing a particular link
 * mode for the device for setting things.  When getting the
 * devices settings, these indicate the current mode and whether
 * it was foced up into this mode or autonegotiated.
 */

/* The forced speed, 10Mb, 100Mb, gigabit, 10GbE. */
#define SPEED_10 10
#define SPEED_100 100
#define SPEED_1000 1000
#define SPEED_10000 10000

/* Duplex, half or full. */
#define DUPLEX_HALF 0x00
#define DUPLEX_FULL 0x01

/* Which connector port. */
#define PORT_TP 0x00
#define PORT_AUI 0x01
#define PORT_MII 0x02
#define PORT_FIBRE 0x03
#define PORT_BNC 0x04

/* Which tranceiver to use. */
#define XCVR_INTERNAL 0x00
#define XCVR_EXTERNAL 0x01
#define XCVR_DUMMY1 0x02
#define XCVR_DUMMY2 0x03
#define XCVR_DUMMY3 0x04

/* Enable or disable autonegotiation.  If this is set to enable,
 * the forced link modes above are completely ignored.
 */
#define AUTONEG_DISABLE 0x00
#define AUTONEG_ENABLE 0x01

/* Wake-On-Lan options. */
#define WAKE_PHY         (1 << 0)
#define WAKE_UCAST       (1 << 1)
#define WAKE_MCAST       (1 << 2)
#define WAKE_BCAST       (1 << 3)
#define WAKE_ARP         (1 << 4)
#define WAKE_MAGIC       (1 << 5)
#define WAKE_MAGICSECURE (1 << 6)  /* only meaningful if WAKE_MAGIC */

#endif /* _LINUX_ETHTOOL_H */