net: mvpp2: Fix a typo in the license
[linux-2.6-block.git] / Documentation / ABI / testing / sysfs-class-net
CommitLineData
39f1a2f0
FF
1What: /sys/class/net/<iface>/addr_assign_type
2Date: July 2010
3KernelVersion: 3.2
4Contact: netdev@vger.kernel.org
5Description:
6 Indicates the address assignment type. Possible values are:
7 0: permanent address
8 1: randomly generated
9 2: stolen from another device
10 3: set using dev_set_mac_address
11
12What: /sys/class/net/<iface>/addr_len
13Date: April 2005
14KernelVersion: 2.6.12
15Contact: netdev@vger.kernel.org
16Description:
17 Indicates the hardware address size in bytes.
18 Values vary based on the lower-level protocol used by the
19 interface (Ethernet, FDDI, ATM, IEEE 802.15.4...). See
20 include/uapi/linux/if_*.h for actual values.
21
22What: /sys/class/net/<iface>/address
23Date: April 2005
24KernelVersion: 2.6.12
25Contact: netdev@vger.kernel.org
26Description:
27 Hardware address currently assigned to this interface.
28 Format is a string, e.g: 00:11:22:33:44:55 for an Ethernet MAC
29 address.
30
31What: /sys/class/net/<iface>/broadcast
32Date: April 2005
33KernelVersion: 2.6.12
34Contact: netdev@vger.kernel.org
35Description:
36 Hardware broadcast address for this interface. Format is a
37 string, e.g: ff:ff:ff:ff:ff:ff for an Ethernet broadcast MAC
38 address.
39
40What: /sys/class/net/<iface>/carrier
41Date: April 2005
42KernelVersion: 2.6.12
43Contact: netdev@vger.kernel.org
44Description:
45 Indicates the current physical link state of the interface.
46 Posssible values are:
47 0: physical link is down
48 1: physical link is up
49
50 Note: some special devices, e.g: bonding and team drivers will
51 allow this attribute to be written to force a link state for
52 operating correctly and designating another fallback interface.
53
54What: /sys/class/net/<iface>/dev_id
55Date: April 2008
56KernelVersion: 2.6.26
57Contact: netdev@vger.kernel.org
58Description:
59 Indicates the device unique identifier. Format is an hexadecimal
60 value. This is used to disambiguate interfaces which might be
61 stacked (e.g: VLAN interfaces) but still have the same MAC
62 address as their parent device.
63
64What: /sys/class/net/<iface>/dormant
65Date: March 2006
66KernelVersion: 2.6.17
67Contact: netdev@vger.kernel.org
68Description:
69 Indicates whether the interface is in dormant state. Possible
70 values are:
71 0: interface is not dormant
72 1: interface is dormant
73
74 This attribute can be used by supplicant software to signal that
75 the device is not usable unless some supplicant-based
76 authentication is performed (e.g: 802.1x). 'link_mode' attribute
77 will also reflect the dormant state.
78
79What: /sys/clas/net/<iface>/duplex
80Date: October 2009
81KernelVersion: 2.6.33
82Contact: netdev@vger.kernel.org
83Description:
84 Indicates the interface latest or current duplex value. Possible
85 values are:
86 half: half duplex
87 full: full duplex
88
89 Note: This attribute is only valid for interfaces that implement
90 the ethtool get_settings method (mostly Ethernet).
91
92What: /sys/class/net/<iface>/flags
93Date: April 2005
94KernelVersion: 2.6.12
95Contact: netdev@vger.kernel.org
96Description:
97 Indicates the interface flags as a bitmask in hexadecimal. See
98 include/uapi/linux/if.h for a list of all possible values and
99 the flags semantics.
100
101What: /sys/class/net/<iface>/ifalias
102Date: September 2008
103KernelVersion: 2.6.28
104Contact: netdev@vger.kernel.org
105Description:
106 Indicates/stores an interface alias name as a string. This can
107 be used for system management purposes.
108
109What: /sys/class/net/<iface>/ifindex
110Date: April 2005
111KernelVersion: 2.6.12
112Contact: netdev@vger.kernel.org
113Description:
114 Indicates the system-wide interface unique index identifier as a
115 decimal number. This attribute is used for mapping an interface
116 identifier to an interface name. It is used throughout the
117 networking stack for specifying the interface specific
118 requests/events.
119
120What: /sys/class/net/<iface>/iflink
121Date: April 2005
122KernelVersion: 2.6.12
123Contact: netdev@vger.kernel.org
124Description:
125 Indicates the system-wide interface unique index identifier a
126 the interface is linked to. Format is decimal. This attribute is
127 used to resolve interfaces chaining, linking and stacking.
128 Physical interfaces have the same 'ifindex' and 'iflink' values.
129
130What: /sys/class/net/<iface>/link_mode
131Date: March 2006
132KernelVersion: 2.6.17
133Contact: netdev@vger.kernel.org
134Description:
135 Indicates the interface link mode, as a decimal number. This
136 attribute should be used in conjunction with 'dormant' attribute
137 to determine the interface usability. Possible values:
138 0: default link mode
139 1: dormant link mode
140
141What: /sys/class/net/<iface>/mtu
142Date: April 2005
143KernelVersion: 2.6.12
144Contact: netdev@vger.kernel.org
145Description:
146 Indicates the interface currently configured MTU value, in
147 bytes, and in decimal format. Specific values depends on the
148 lower-level interface protocol used. Ethernet devices will show
149 a 'mtu' attribute value of 1500 unless changed.
150
151What: /sys/calss/net/<iface>/netdev_group
152Date: January 2011
153KernelVersion: 2.6.39
154Contact: netdev@vger.kernel.org
155Description:
156 Indicates the interface network device group, as a decimal
157 integer. Default value is 0 which corresponds to the initial
158 network devices group. The group can be changed to affect
159 routing decisions (see: net/ipv4/fib_rules and
160 net/ipv6/fib6_rules.c).
161
162What: /sys/class/net/<iface>/operstate
163Date: March 2006
164KernelVersion: 2.6.17
165Contact: netdev@vger.kernel.org
166Description:
167 Indicates the interface RFC2863 operational state as a string.
168 Possible values are:
169 "unknown", "notpresent", "down", "lowerlayerdown", "testing",
170 "dormant", "up".
171
79499bca
FF
172What: /sys/class/net/<iface>/phys_port_id
173Date: July 2013
174KernelVersion: 3.12
175Contact: netdev@vger.kernel.org
176Description:
177 Indicates the interface unique physical port identifier within
178 the NIC, as a string.
179
39f1a2f0
FF
180What: /sys/class/net/<iface>/speed
181Date: October 2009
182KernelVersion: 2.6.33
183Contact: netdev@vger.kernel.org
184Description:
185 Indicates the interface latest or current speed value. Value is
186 an integer representing the link speed in Mbits/sec.
187
188 Note: this attribute is only valid for interfaces that implement
189 the ethtool get_settings method (mostly Ethernet ).
190
191What: /sys/class/net/<iface>/tx_queue_len
192Date: April 2005
193KernelVersion: 2.6.12
194Contact: netdev@vger.kernel.org
195Description:
196 Indicates the interface transmit queue len in number of packets,
197 as an integer value. Value depend on the type of interface,
198 Ethernet network adapters have a default value of 1000 unless
199 configured otherwise
200
201What: /sys/class/net/<iface>/type
202Date: April 2005
203KernelVersion: 2.6.12
204Contact: netdev@vger.kernel.org
205Description:
206 Indicates the interface protocol type as a decimal value. See
207 include/uapi/linux/if_arp.h for all possible values.