1 .\" $NetBSD: ifmedia.4,v 1.29 2009/04/10 17:07:15 joerg Exp $
3 .\" Copyright (c) 1998, 1999, 2000, 2001, 2002, 2003, 2004
4 .\" The NetBSD Foundation, Inc.
5 .\" All rights reserved.
7 .\" This code is derived from software contributed to The NetBSD Foundation
8 .\" by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9 .\" NASA Ames Research Center.
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
19 .\" 3. All advertising materials mentioning features or use of this software
20 .\" must display the following acknowledgement:
21 .\" This product includes software developed by the NetBSD
22 .\" Foundation, Inc. and its contributors.
23 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
24 .\" contributors may be used to endorse or promote products derived
25 .\" from this software without specific prior written permission.
27 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 .\" POSSIBILITY OF SUCH DAMAGE.
39 .Dd September 30, 2014
44 .Nd network interface media settings
52 interface provides a consistent method for querying and setting
53 network interface media and media options. The media is typically
58 There are currently four link types supported by
60 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211"
62 Asynchronous Transfer Mode
64 Common Address Redundancy Protocol
68 IEEE802.11 Wireless LAN
71 The following sections describe the possible media settings for each
72 link type. Not all of these are supported by every device; refer to
73 your device's manual page for more information.
75 The lists below provide the possible names of each media type or option.
76 The first name in the list is the canonical name of the media type or
77 option. Additional names are acceptable aliases for the media type or
79 .Sh COMMON MEDIA TYPES AND OPTIONS
80 The following media types are shared by all link types:
81 .Bl -tag -offset indent -width ".Dv IFM_MANUAL"
83 Autoselect the best media. [autoselect, auto]
85 Jumper or switch on device selects media. [manual]
87 Deselect all media. [none]
90 The following media options are shared by all link types:
91 .Bl -tag -offset indent -width ".Dv IFM_FLAG0"
93 Place the device into full-duplex mode. This option only has meaning
94 if the device is normally not full-duplex. [full-duplex]
96 Place the device into half-duplex mode. This option only has meaning
97 if the device is normally not half-duplex. [half-duplex]
99 Driver-defined flag. [flag0]
101 Driver-defined flag. [flag1]
103 Driver-defined flag. [flag2]
105 Place the device into hardware loopback mode. [hw-loopback]
107 .Sh MEDIA TYPES AND OPTIONS FOR ASYNCHRONOUS TRANSFER MODE
108 The following media types are defined for Asynchronous Transfer Mode:
109 .Bl -tag -offset indent -width ".Dv IFM_ATM_TAXI_100"
110 .It Dv IFM_ATM_UNKNOWN
111 Unknown media type. [Unknown, UNKNOWN]
112 .It Dv IFM_ATM_UTP_25
113 25Mb/s over unshielded twisted pair. [UTP/25.6MBit, UTP-25]
114 .It Dv IFM_ATM_TAXI_100
115 AMD TAXI, 100Mb/s over multi-mode fiber optic cables. [Taxi/100MBit, TAXI-100]
116 .It Dv IFM_ATM_TAXI_140
117 AMD TAXI, 140Mb/s over multi-node fiber optic cables. [Taxi/140MBit, TAXI-140]
118 .It Dv IFM_ATM_MM_155
119 155Mb/s over multi-mode fiber optic cables. [Multi-mode/155MBit, MM-155]
120 .It Dv IFM_ATM_SM_155
121 155Mb/s over single-mode fiber optic cables. [Single-mode/155MBit, SM-155]
122 .It Dv IFM_ATM_UTP_155
123 155Mb/s over unshielded twisted pair. [UTP/155Mbit, UTP-155]
124 .It Dv IFM_ATM_MM_622
125 622Mb/s over multi-mode fiber optic cables. [Multi-mode/622MBit, MM-622]
126 .It Dv IFM_ATM_SM_622
127 622Mb/s over single-mode fiber optic cables. [Single-mode/622MBit, SM-622]
128 .\".It Dv IFM_ATM_VIRTUAL
131 .Sh MEDIA TYPES AND OPTIONS FOR ETHERNET
132 The following media types are defined for Ethernet:
133 .Bl -tag -offset indent -width ".Dv IFM_1000_FX"
135 HomePNA 1.0, 1Mb/s. [homePNA]
137 10BASE-T, 10Mb/s over unshielded twisted pair, RJ45 connector. [10baseT/UTP,
140 10BASE2, 10Mb/s over coaxial cable, BNC connector, also called Thinnet.
141 [10base2/BNC, BNC, 10BNC]
143 10BASE5, 10Mb/s over 15-wire cables, DB15 connector, also called AUI.
144 [10base5/AUI, AUI, 10AUI]
146 10BASE-STP, 10Mb/s over shielded twisted pair, DB9 connector. [10baseSTP,
149 10BASE-FL, 10Mb/s over fiber optic cables. [10baseFL, 10FL]
151 100BASE-TX, 100Mb/s over unshielded twisted pair, RJ45 connector. [100baseTX,
154 100BASE-FX, 100Mb/s over fiber optic cables. [100baseFX, 100FX]
156 100BASE-T4, 100Mb/s over 4-wire (category 3) unshielded twisted pair, RJ45
157 connector. [100baseT4, 100T4]
159 100BASE-T2. [100baseT2, 100T2]
161 100VG-AnyLAN. [100baseVG, 100VG]
163 1000BASE-SX, 1Gb/s over multi-mode fiber optic cables. (short waves)
166 1000BASE-LX, 1Gb/s over single-mode fiber optic cables. (long waves)
169 1000BASE-CX, 1Gb/s over shielded twisted pair. (twinax)
172 1000BASE-T, 1Gb/s over category 5 unshielded twisted pair, 802.3ab, RJ45
176 10GBASE-LR, 10Gb/s over single-mode fiber optic cables.
179 10GBASE-SR, 10Gb/s over multi-mode fiber optic cables.
182 10GBASE-CX4, 10Gb/s over XAUI 4-lane PCS and copper cables.
185 2500BASE-SX, 2.5Gb/s over multi-mode fiber optic cables.
187 .\".It Dv IFM_10G_TWINAX
188 .\".It Dv IFM_10G_TWINAX_LONG
189 .\".It Dv IFM_10G_LRM
191 10GBASE-T, 10Gb/s over unshielded twisted pair, RJ45 connector.
194 40GBASE-CR4, 40Gb/s over twin-ax copper cable.
197 40GBASE-SR4, 40Gb/s over multi-mode fiber optic cables.
200 40GBASE-LR4, 40Gb/s over single-mode fiber optic cables.
204 The following media options defined for Ethernet:
205 .Bl -tag -offset indent -width ".Dv IFM_ETH_TXPAUSE"
206 .It Dv IFM_ETH_MASTER
207 Configure a 1000BASE-T PHY as the clock master for a 1000BASE-T link.
208 This option has no effect
209 .Pf ( shows current status only )
212 .It Dv IFM_ETH_TXPAUSE
213 Configure the device to send PAUSE
216 This option has no effect
217 .Pf ( shows current status only )
220 .It Dv IFM_ETH_RXPAUSE
221 Configure the device to receive PAUSE
224 This option has no effect
225 .Pf ( shows current status only )
229 .Sh MEDIA TYPES AND OPTIONS FOR IEEE802.11 WIRELESS LAN
230 The following media types are defined for IEEE802.11 Wireless LAN:
231 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_OFDM12"
232 .It Dv IFM_IEEE80211_FH1
233 Frequency Hopping 1Mbps. [FH/1Mbps, FH1, FrequencyHopping/1Mbps]
234 .It Dv IFM_IEEE80211_FH2
235 Frequency Hopping 2Mbps. [FH/2Mbps, FH2, FrequencyHopping/2Mbps]
236 .It Dv IFM_IEEE80211_DS354k
237 Direct Sequence 354Kbps. [DS/354Kbps, DS354K, DirectSequence/354Kbps]
238 .It Dv IFM_IEEE80211_DS512k
239 Direct Sequence 512Kbps. [DS/512Kbps, DS512K, DirectSequence/512Kbps]
240 .It Dv IFM_IEEE80211_DS1
241 Direct Sequence 1Mbps. [DS/1Mbps, DS1, DirectSequence/1Mbps, CCK1]
242 .It Dv IFM_IEEE80211_DS2
243 Direct Sequence 2Mbps. [DS/2Mbps, DS2, DirectSequence/2Mbps, CCK2]
244 .It Dv IFM_IEEE80211_DS5
245 Direct Sequence 5Mbps. [DS/5.5Mbps, DS5, DirectSequence/5.5Mbps, CCK5.5]
246 .It Dv IFM_IEEE80211_DS11
247 Direct Sequence 11Mbps. [DS/11Mbps, DS11, DirectSequence/11Mbps, CCK11]
248 .It Dv IFM_IEEE80211_DS22
249 Direct Sequence 22Mbps. [DS/22Mbps, DS22, DirectSequence/22Mbps]
250 .\".It Dv IFM_IEEE80211_MCS
252 .It Dv IFM_IEEE80211_OFDM3
253 Orthogonal Frequency Division Multiplexing 3Mbps. [OFDM/3Mbps OFDM3]
254 .It Dv IFM_IEEE80211_OFDM4
255 Orthogonal Frequency Division Multiplexing 4.5Mbps. [OFDM/4.5Mbps OFDM4.5]
256 .It Dv IFM_IEEE80211_OFDM6
257 Orthogonal Frequency Division Multiplexing 6Mbps. [OFDM/6Mbps, OFDM6]
258 .It Dv IFM_IEEE80211_OFDM9
259 Orthogonal Frequency Division Multiplexing 9Mbps. [OFDM/9Mbps, OFDM9]
260 .It Dv IFM_IEEE80211_OFDM12
261 Orthogonal Frequency Division Multiplexing 12Mbps. [OFDM/12Mbps, OFDM12]
262 .It Dv IFM_IEEE80211_OFDM18
263 Orthogonal Frequency Division Multiplexing 18Mbps. [OFDM/18Mbps, OFDM18]
264 .It Dv IFM_IEEE80211_OFDM24
265 Orthogonal Frequency Division Multiplexing 24Mbps. [OFDM/24Mbps, OFDM24]
266 .It Dv IFM_IEEE80211_OFDM27
267 Orthogonal Frequency Division Multiplexing 27Mbps. [OFDM/27Mbps, OFDM27]
268 .It Dv IFM_IEEE80211_OFDM36
269 Orthogonal Frequency Division Multiplexing 36Mbps. [OFDM/36Mbps, OFDM36]
270 .It Dv IFM_IEEE80211_OFDM48
271 Orthogonal Frequency Division Multiplexing 48Mbps. [OFDM/48Mbps, OFDM48]
272 .It Dv IFM_IEEE80211_OFDM54
273 Orthogonal Frequency Division Multiplexing 54Mbps. [OFDM/54Mbps, OFDM54]
274 .It Dv IFM_IEEE80211_OFDM72
275 Orthogonal Frequency Division Multiplexing 72Mbps. [OFDM/72Mbps, OFDM72]
278 The following media options are defined for IEEE802.11 Wireless LAN:
279 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_MONITOR"
280 .It Dv IFM_IEEE80211_ADHOC
283 In some drivers, it may be used with the
285 [flag0] media option to specify non-standard ad-hoc demo mode.
286 .It Dv IFM_IEEE80211_HOSTAP
287 Access Point mode. [hostap]
288 .It Dv IFM_IEEE80211_IBSS
290 .It Dv IFM_IEEE80211_MBSS
292 .It Dv IFM_IEEE80211_MONITOR
293 Monitor mode. [monitor]
294 .It Dv IFM_IEEE80211_TURBO
296 .It Dv IFM_IEEE80211_WDS
300 The following operating modes are defined for IEEE802.11 Wireless LAN:
301 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_11NA"
303 Autoselect the best mode. [autoselect, auto]
304 .It Dv IFM_IEEE80211_11A
305 Orthogonal Frequency Division Multiplexing, 5GHz. [11a]
306 .It Dv IFM_IEEE80211_11NA
307 High Throughput, 5GHz. [11na]
308 .It Dv IFM_IEEE80211_11B
309 Direct Sequence mode. [11b]
310 .It Dv IFM_IEEE80211_11G
311 Complementary Code Keying, 2GHz. [11g]
312 .It Dv IFM_IEEE80211_11NG
313 High Throughput, 2GHz. [11ng]
314 .It Dv IFM_IEEE80211_FH
315 Gaussian Frequency Shift Keying, 2GHz. [fh]