1 .\" $NetBSD: ifmedia.4,v 1.26 2005/10/03 18:08:03 rpaulo Exp $
2 .\" $DragonFly: src/share/man/man4/ifmedia.4,v 1.1 2006/09/10 04:14:01 swildner Exp $
4 .\" Copyright (c) 1998, 1999, 2000, 2001, 2002, 2003, 2004
5 .\" The NetBSD Foundation, Inc.
6 .\" All rights reserved.
8 .\" This code is derived from software contributed to The NetBSD Foundation
9 .\" by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
10 .\" NASA Ames Research Center.
12 .\" Redistribution and use in source and binary forms, with or without
13 .\" modification, are permitted provided that the following conditions
15 .\" 1. Redistributions of source code must retain the above copyright
16 .\" notice, this list of conditions and the following disclaimer.
17 .\" 2. Redistributions in binary form must reproduce the above copyright
18 .\" notice, this list of conditions and the following disclaimer in the
19 .\" documentation and/or other materials provided with the distribution.
20 .\" 3. All advertising materials mentioning features or use of this software
21 .\" must display the following acknowledgement:
22 .\" This product includes software developed by the NetBSD
23 .\" Foundation, Inc. and its contributors.
24 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
25 .\" contributors may be used to endorse or promote products derived
26 .\" from this software without specific prior written permission.
28 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 .\" POSSIBILITY OF SUCH DAMAGE.
45 .Nd network interface media settings
53 interface provides a consistent method for querying and setting
54 network interface media and media options. The media is typically
59 There are currently four link types supported by
61 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211"
69 IEEE802.11 Wireless LAN
72 The following sections describe the possible media settings for each
73 link type. Not all of these are supported by every device; refer to
74 your device's manual page for more information.
76 The lists below provide the possible names of each media type or option.
77 The first name in the list is the canonical name of the media type or
78 option. Additional names are acceptable aliases for the media type or
80 .Sh COMMON MEDIA TYPES AND OPTIONS
81 The following media types are shared by all link types:
82 .Bl -tag -offset indent -width ".Dv IFM_MANUAL"
84 Autoselect the best media. [autoselect, auto]
86 Jumper or switch on device selects media. [manual]
88 Deselect all media. [none]
91 The following media options are shared by all link types:
92 .Bl -tag -offset indent -width ".Dv IFM_FLAG0"
94 Place the device into full-duplex mode. This option only has meaning
95 if the device is normally not full-duplex. [full-duplex]
97 Place the device into half-duplex mode. This option only has meaning
98 if the device is normally not half-duplex. [half-duplex]
100 Driver-defined flag. [flag0]
102 Driver-defined flag. [flag1]
104 Driver-defined flag. [flag2]
106 Place the device into hardware loopback mode. [hw-loopback]
108 .Sh MEDIA TYPES AND OPTIONS FOR ETHERNET
109 The following media types are defined for Ethernet:
110 .Bl -tag -offset indent -width ".Dv IFM_1000_FX"
112 HomePNA 1.0, 1Mb/s. [homePNA]
114 10BASE-T, 10Mb/s over unshielded twisted pair, RJ45 connector. [10baseT/UTP,
117 10BASE2, 10Mb/s over coaxial cable, BNC connector, also called Thinnet.
118 [10base2/BNC, BNC, 10BNC]
120 10BASE5, 10Mb/s over 15-wire cables, DB15 connector, also called AUI.
121 [10base5/AUI, AUI, 10AUI]
123 10BASE-STP, 10Mb/s over shielded twisted pair, DB9 connector. [10baseSTP,
126 10BASE-FL, 10Mb/s over fiber optic cables. [10baseFL, 10FL]
128 100BASE-TX, 100Mb/s over unshielded twisted pair, RJ45 connector. [100baseTX,
131 100BASE-FX, 100Mb/s over fiber optic cables. [100baseFX, 100FX]
133 100BASE-T4, 100Mb/s over 4-wire (category 3) unshielded twisted pair, RJ45
134 connector. [100baseT4, 100T4]
136 100BASE-T2. [100baseT2, 100T2]
138 100VG-AnyLAN. [100baseVG, 100VG]
140 1000BASE-SX, 1Gb/s over multi-mode fiber optic cables. [1000baseSX, 1000SX]
142 1000BASE-LX, 1Gb/s over single-mode fiber optic cables. [1000baseLX, 1000LX]
144 1000BASE-CX, 1Gb/s over shielded twisted pair. [1000baseCX, 1000CX]
146 1000BASE-T, 1Gb/s over category 5 unshielded twisted pair, RJ45 connector.
150 The following media options defined for Ethernet:
151 .Bl -tag -offset indent -width ".Dv IFM_ETH_TXPAUSE"
152 .It Dv IFM_ETH_MASTER
153 Configure a 1000BASE-T PHY as the clock master for a 1000BASE-T link.
154 This option has no effect
155 .Pf ( shows current status only )
158 .It Dv IFM_ETH_TXPAUSE
159 Configure the device to send PAUSE
162 This option has no effect
163 .Pf ( shows current status only )
166 .It Dv IFM_ETH_RXPAUSE
167 Configure the device to receive PAUSE
170 This option has no effect
171 .Pf ( shows current status only )
175 .Sh MEDIA TYPES AND OPTIONS FOR TOKEN RING
176 The following media types are defined for Token Ring:
177 .Bl -tag -offset indent -width ".Dv IFM_TOK_UTP100"
179 4Mb/s, shielded twisted pair, DB9 connector. [DB9/4Mbit, 4STP]
181 16Mb/s, shielded twisted pair, DB9 connector. [DB9/16Mbit, 16STP]
182 .It Dv IFM_TOK_STP100
183 100Mb/s, shielded twisted pair, DB9 connector. [STP/100Mbit, 100STP]
185 4Mb/s, unshielded twisted pair, RJ45 connector. [UTP/4Mbit, 4UTP]
187 16Mb/s, unshielded twisted pair, RJ45 connector. [UTP/16Mbit, 16UTP]
188 .It Dv IFM_TOK_UTP100
189 100Mb/s, unshielded twisted pair, RJ45 connector. [UTP/100Mbit, 100UTP]
192 The following media options are defined for Token Ring:
193 .Bl -tag -offset indent -width ".Dv IFM_TOK_CLASSIC"
195 Early token release. [EarlyTokenRelease]
197 Enable source routing features. [SourceRouting]
199 All routes vs. single route broadcast. [AllRoutes]
201 Dedicated token ring. [Dedicated]
202 .It Dv IFM_TOK_CLASSIC
203 Classic token ring. [Classic]
205 .Sh MEDIA TYPES AND OPTIONS FOR FDDI
206 The following media types are defined for FDDI:
207 .Bl -tag -offset indent -width ".Dv IFM_FDDI_SMF"
209 Single-mode fiber. [Single-mode, SMF]
211 Multi-mode fiber. [Multi-mode, MMF]
213 Unshielded twisted pair, RJ45 connector. [UTP, CDDI]
216 The following media options are defined for FDDI:
217 .Bl -tag -offset indent -width ".Dv IFM_FDDI_DA"
219 Dual-attached station vs. Single-attached station. [Dual-attach]
221 .Sh MEDIA TYPES AND OPTIONS FOR IEEE802.11 WIRELESS LAN
222 The following media types are defined for IEEE802.11 Wireless LAN:
223 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_OFDM12"
224 .It Dv IFM_IEEE80211_FH1
225 Frequency Hopping 1Mbps. [FH/1Mbps, FH1, FrequencyHopping/1Mbps]
226 .It Dv IFM_IEEE80211_FH2
227 Frequency Hopping 2Mbps. [FH/2Mbps, FH2, FrequencyHopping/2Mbps]
228 .It Dv IFM_IEEE80211_DS1
229 Direct Sequence 1Mbps. [DS/1Mbps, DS1, DirectSequence/1Mbps]
230 .It Dv IFM_IEEE80211_DS2
231 Direct Sequence 2Mbps. [DS/2Mbps, DS2, DirectSequence/2Mbps]
232 .It Dv IFM_IEEE80211_DS5
233 Direct Sequence 5Mbps. [DS/5.5Mbps, DS5, DirectSequence/5.5Mbps]
234 .It Dv IFM_IEEE80211_DS11
235 Direct Sequence 11Mbps. [DS/11Mbps, DS11, DirectSequence/11Mbps]
236 .It Dv IFM_IEEE80211_DS22
237 Direct Sequence 22Mbps. [DS/22Mbps, DS22, DirectSequence/22Mbps]
238 .It Dv IFM_IEEE80211_OFDM6
239 Orthogonal Frequency Division Multiplexing 6Mbps. [OFDM/6Mbps, OFDM6]
240 .It Dv IFM_IEEE80211_OFDM9
241 Orthogonal Frequency Division Multiplexing 9Mbps. [OFDM/9Mbps, OFDM9]
242 .It Dv IFM_IEEE80211_OFDM12
243 Orthogonal Frequency Division Multiplexing 12Mbps. [OFDM/12Mbps, OFDM12]
244 .It Dv IFM_IEEE80211_OFDM18
245 Orthogonal Frequency Division Multiplexing 18Mbps. [OFDM/18Mbps, OFDM18]
246 .It Dv IFM_IEEE80211_OFDM24
247 Orthogonal Frequency Division Multiplexing 24Mbps. [OFDM/24Mbps, OFDM24]
248 .It Dv IFM_IEEE80211_OFDM36
249 Orthogonal Frequency Division Multiplexing 36Mbps. [OFDM/36Mbps, OFDM36]
250 .It Dv IFM_IEEE80211_OFDM48
251 Orthogonal Frequency Division Multiplexing 48Mbps. [OFDM/48Mbps, OFDM48]
252 .It Dv IFM_IEEE80211_OFDM54
253 Orthogonal Frequency Division Multiplexing 54Mbps. [OFDM/54Mbps, OFDM54]
254 .It Dv IFM_IEEE80211_OFDM72
255 Orthogonal Frequency Division Multiplexing 72Mbps. [OFDM/72Mbps, OFDM72]
258 The following media options are defined for IEEE802.11 Wireless LAN:
259 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_IBSSMASTER"
260 .It Dv IFM_IEEE80211_ADHOC
263 In some drivers, it may be used with the
265 [flag0] media option to specify non-standard ad-hoc demo mode.
266 .It Dv IFM_IEEE80211_HOSTAP
267 Access Point mode. [hostap]
268 .It Dv IFM_IEEE80211_IBSS
270 .It Dv IFM_IEEE80211_IBSSMASTER
271 Operate as an IBSS master. [ibss-master]
272 .It Dv IFM_IEEE80211_MONITOR
273 Monitor mode. [monitor]
274 .It Dv IFM_IEEE80211_TURBO
278 The following operating modes are defined for IEEE802.11 Wireless LAN:
279 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_11A"
281 Autoselect the best mode. [autoselect, auto]
282 .It Dv IFM_IEEE80211_11A
283 Orthogonal Frequency Division Multiplexing, 5GHz. [11a]
284 .It Dv IFM_IEEE80211_11B
285 Direct Sequence mode. [11b]
286 .It Dv IFM_IEEE80211_11G
287 Orthogonal Frequency Division Multiplexing, 2GHz. [11g]
288 .It Dv IFM_IEEE80211_FH
289 Gaussian Frequency Shift Keying, 2GHz. [fh]