net: export NET_ADDR_* values to user-space API
[linux/fpc-iii.git] / Documentation / ABI / testing / sysfs-class-net
blobd922060e455d5647e06c4f1182306d42c514a604
1 What:           /sys/class/net/<iface>/addr_assign_type
2 Date:           July 2010
3 KernelVersion:  3.2
4 Contact:        netdev@vger.kernel.org
5 Description:
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
12 What:           /sys/class/net/<iface>/addr_len
13 Date:           April 2005
14 KernelVersion:  2.6.12
15 Contact:        netdev@vger.kernel.org
16 Description:
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.
22 What:           /sys/class/net/<iface>/address
23 Date:           April 2005
24 KernelVersion:  2.6.12
25 Contact:        netdev@vger.kernel.org
26 Description:
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.
31 What:           /sys/class/net/<iface>/broadcast
32 Date:           April 2005
33 KernelVersion:  2.6.12
34 Contact:        netdev@vger.kernel.org
35 Description:
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.
40 What:           /sys/class/net/<iface>/carrier
41 Date:           April 2005
42 KernelVersion:  2.6.12
43 Contact:        netdev@vger.kernel.org
44 Description:
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
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.
54 What:           /sys/class/net/<iface>/dev_id
55 Date:           April 2008
56 KernelVersion:  2.6.26
57 Contact:        netdev@vger.kernel.org
58 Description:
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.
64 What:           /sys/class/net/<iface>/dormant
65 Date:           March 2006
66 KernelVersion:  2.6.17
67 Contact:        netdev@vger.kernel.org
68 Description:
69                 Indicates whether the interface is in dormant state. Possible
70                 values are:
71                 0: interface is not dormant
72                 1: interface is dormant
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.
79 What:           /sys/clas/net/<iface>/duplex
80 Date:           October 2009
81 KernelVersion:  2.6.33
82 Contact:        netdev@vger.kernel.org
83 Description:
84                 Indicates the interface latest or current duplex value. Possible
85                 values are:
86                 half: half duplex
87                 full: full duplex
89                 Note: This attribute is only valid for interfaces that implement
90                 the ethtool get_settings method (mostly Ethernet).
92 What:           /sys/class/net/<iface>/flags
93 Date:           April 2005
94 KernelVersion:  2.6.12
95 Contact:        netdev@vger.kernel.org
96 Description:
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.
101 What:           /sys/class/net/<iface>/ifalias
102 Date:           September 2008
103 KernelVersion:  2.6.28
104 Contact:        netdev@vger.kernel.org
105 Description:
106                 Indicates/stores an interface alias name as a string. This can
107                 be used for system management purposes.
109 What:           /sys/class/net/<iface>/ifindex
110 Date:           April 2005
111 KernelVersion:  2.6.12
112 Contact:        netdev@vger.kernel.org
113 Description:
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.
120 What:           /sys/class/net/<iface>/iflink
121 Date:           April 2005
122 KernelVersion:  2.6.12
123 Contact:        netdev@vger.kernel.org
124 Description:
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.
130 What:           /sys/class/net/<iface>/link_mode
131 Date:           March 2006
132 KernelVersion:  2.6.17
133 Contact:        netdev@vger.kernel.org
134 Description:
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
141 What:           /sys/class/net/<iface>/mtu
142 Date:           April 2005
143 KernelVersion:  2.6.12
144 Contact:        netdev@vger.kernel.org
145 Description:
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.
151 What:           /sys/calss/net/<iface>/netdev_group
152 Date:           January 2011
153 KernelVersion:  2.6.39
154 Contact:        netdev@vger.kernel.org
155 Description:
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).
162 What:           /sys/class/net/<iface>/operstate
163 Date:           March 2006
164 KernelVersion:  2.6.17
165 Contact:        netdev@vger.kernel.org
166 Description:
167                 Indicates the interface RFC2863 operational state as a string.
168                 Possible values are:
169                 "unknown", "notpresent", "down", "lowerlayerdown", "testing",
170                 "dormant", "up".
172 What:           /sys/class/net/<iface>/speed
173 Date:           October 2009
174 KernelVersion:  2.6.33
175 Contact:        netdev@vger.kernel.org
176 Description:
177                 Indicates the interface latest or current speed value. Value is
178                 an integer representing the link speed in Mbits/sec.
180                 Note: this attribute is only valid for interfaces that implement
181                 the ethtool get_settings method (mostly Ethernet ).
183 What:           /sys/class/net/<iface>/tx_queue_len
184 Date:           April 2005
185 KernelVersion:  2.6.12
186 Contact:        netdev@vger.kernel.org
187 Description:
188                 Indicates the interface transmit queue len in number of packets,
189                 as an integer value. Value depend on the type of interface,
190                 Ethernet network adapters have a default value of 1000 unless
191                 configured otherwise
193 What:           /sys/class/net/<iface>/type
194 Date:           April 2005
195 KernelVersion:  2.6.12
196 Contact:        netdev@vger.kernel.org
197 Description:
198                 Indicates the interface protocol type as a decimal value. See
199                 include/uapi/linux/if_arp.h for all possible values.