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 $ 3.\" 4.\" Copyright (c) 1998, 1999, 2000, 2001, 2002, 2003, 2004 5.\" The NetBSD Foundation, Inc. 6.\" All rights reserved. 7.\" 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. 11.\" 12.\" Redistribution and use in source and binary forms, with or without 13.\" modification, are permitted provided that the following conditions 14.\" are met: 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. 27.\" 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. 39.\" 40.Dd September 9, 2006 41.Dt IFMEDIA 4 42.Os 43.Sh NAME 44.Nm ifmedia 45.Nd network interface media settings 46.Sh SYNOPSIS 47.In sys/socket.h 48.In net/if.h 49.In net/if_media.h 50.Sh DESCRIPTION 51The 52.Nm 53interface provides a consistent method for querying and setting 54network interface media and media options. The media is typically 55set using the 56.Xr ifconfig 8 57command. 58.Pp 59There are currently four link types supported by 60.Nm : 61.Bl -tag -offset indent -width ".Dv IFM_IEEE80211" 62.It Dv IFM_ETHER 63Ethernet 64.It Dv IFM_TOKEN 65Token Ring 66.It Dv IFM_FDDI 67FDDI 68.It Dv IFM_IEEE80211 69IEEE802.11 Wireless LAN 70.El 71.Pp 72The following sections describe the possible media settings for each 73link type. Not all of these are supported by every device; refer to 74your device's manual page for more information. 75.Pp 76The lists below provide the possible names of each media type or option. 77The first name in the list is the canonical name of the media type or 78option. Additional names are acceptable aliases for the media type or 79option. 80.Sh COMMON MEDIA TYPES AND OPTIONS 81The following media types are shared by all link types: 82.Bl -tag -offset indent -width ".Dv IFM_MANUAL" 83.It Dv IFM_AUTO 84Autoselect the best media. [autoselect, auto] 85.It Dv IFM_MANUAL 86Jumper or switch on device selects media. [manual] 87.It Dv IFM_NONE 88Deselect all media. [none] 89.El 90.Pp 91The following media options are shared by all link types: 92.Bl -tag -offset indent -width ".Dv IFM_FLAG0" 93.It Dv IFM_FDX 94Place the device into full-duplex mode. This option only has meaning 95if the device is normally not full-duplex. [full-duplex] 96.It Dv IFM_HDX 97Place the device into half-duplex mode. This option only has meaning 98if the device is normally not half-duplex. [half-duplex] 99.It Dv IFM_FLAG0 100Driver-defined flag. [flag0] 101.It Dv IFM_FLAG1 102Driver-defined flag. [flag1] 103.It Dv IFM_FLAG2 104Driver-defined flag. [flag2] 105.It Dv IFM_LOOP 106Place the device into hardware loopback mode. [hw-loopback] 107.El 108.Sh MEDIA TYPES AND OPTIONS FOR ETHERNET 109The following media types are defined for Ethernet: 110.Bl -tag -offset indent -width ".Dv IFM_1000_FX" 111.It Dv IFM_HPNA_1 112HomePNA 1.0, 1Mb/s. [homePNA] 113.It Dv IFM_10_T 11410BASE-T, 10Mb/s over unshielded twisted pair, RJ45 connector. [10baseT/UTP, 115UTP, 10UTP] 116.It Dv IFM_10_2 11710BASE2, 10Mb/s over coaxial cable, BNC connector, also called Thinnet. 118[10base2/BNC, BNC, 10BNC] 119.It Dv IFM_10_5 12010BASE5, 10Mb/s over 15-wire cables, DB15 connector, also called AUI. 121[10base5/AUI, AUI, 10AUI] 122.It Dv IFM_10_STP 12310BASE-STP, 10Mb/s over shielded twisted pair, DB9 connector. [10baseSTP, 12410STP] 125.It Dv IFM_10_FL 12610BASE-FL, 10Mb/s over fiber optic cables. [10baseFL, 10FL] 127.It Dv IFM_100_TX 128100BASE-TX, 100Mb/s over unshielded twisted pair, RJ45 connector. [100baseTX, 129100TX] 130.It Dv IFM_100_FX 131100BASE-FX, 100Mb/s over fiber optic cables. [100baseFX, 100FX] 132.It Dv IFM_100_T4 133100BASE-T4, 100Mb/s over 4-wire (category 3) unshielded twisted pair, RJ45 134connector. [100baseT4, 100T4] 135.It Dv IFM_100_T2 136100BASE-T2. [100baseT2, 100T2] 137.It Dv IFM_100_VG 138100VG-AnyLAN. [100baseVG, 100VG] 139.It Dv IFM_1000_SX 1401000BASE-SX, 1Gb/s over multi-mode fiber optic cables. [1000baseSX, 1000SX] 141.It Dv IFM_1000_LX 1421000BASE-LX, 1Gb/s over single-mode fiber optic cables. [1000baseLX, 1000LX] 143.It Dv IFM_1000_CX 1441000BASE-CX, 1Gb/s over shielded twisted pair. [1000baseCX, 1000CX] 145.It Dv IFM_1000_T 1461000BASE-T, 1Gb/s over category 5 unshielded twisted pair, RJ45 connector. 147[1000baseT, 1000T] 148.El 149.Pp 150The following media options defined for Ethernet: 151.Bl -tag -offset indent -width ".Dv IFM_ETH_TXPAUSE" 152.It Dv IFM_ETH_MASTER 153Configure a 1000BASE-T PHY as the clock master for a 1000BASE-T link. 154This option has no effect 155.Pf ( shows current status only ) 156if the media is 157.Dv IFM_AUTO . 158.It Dv IFM_ETH_TXPAUSE 159Configure the device to send PAUSE 160.Pf ( flow control ) 161frames. 162This option has no effect 163.Pf ( shows current status only ) 164if the media is 165.Dv IFM_AUTO . 166.It Dv IFM_ETH_RXPAUSE 167Configure the device to receive PAUSE 168.Pf ( flow control ) 169frames. 170This option has no effect 171.Pf ( shows current status only ) 172if the media is 173.Dv IFM_AUTO . 174.El 175.Sh MEDIA TYPES AND OPTIONS FOR TOKEN RING 176The following media types are defined for Token Ring: 177.Bl -tag -offset indent -width ".Dv IFM_TOK_UTP100" 178.It Dv IFM_TOK_STP4 1794Mb/s, shielded twisted pair, DB9 connector. [DB9/4Mbit, 4STP] 180.It Dv IFM_TOK_STP16 18116Mb/s, shielded twisted pair, DB9 connector. [DB9/16Mbit, 16STP] 182.It Dv IFM_TOK_STP100 183100Mb/s, shielded twisted pair, DB9 connector. [STP/100Mbit, 100STP] 184.It Dv IFM_TOK_UTP4 1854Mb/s, unshielded twisted pair, RJ45 connector. [UTP/4Mbit, 4UTP] 186.It Dv IFM_TOK_UTP16 18716Mb/s, unshielded twisted pair, RJ45 connector. [UTP/16Mbit, 16UTP] 188.It Dv IFM_TOK_UTP100 189100Mb/s, unshielded twisted pair, RJ45 connector. [UTP/100Mbit, 100UTP] 190.El 191.Pp 192The following media options are defined for Token Ring: 193.Bl -tag -offset indent -width ".Dv IFM_TOK_CLASSIC" 194.It Dv IFM_TOK_ETR 195Early token release. [EarlyTokenRelease] 196.It Dv IFM_TOK_SRCRT 197Enable source routing features. [SourceRouting] 198.It Dv IFM_TOK_ALLR 199All routes vs. single route broadcast. [AllRoutes] 200.It Dv IFM_TOK_DTR 201Dedicated token ring. [Dedicated] 202.It Dv IFM_TOK_CLASSIC 203Classic token ring. [Classic] 204.El 205.Sh MEDIA TYPES AND OPTIONS FOR FDDI 206The following media types are defined for FDDI: 207.Bl -tag -offset indent -width ".Dv IFM_FDDI_SMF" 208.It Dv IFM_FDDI_SMF 209Single-mode fiber. [Single-mode, SMF] 210.It Dv IFM_FDDI_MMF 211Multi-mode fiber. [Multi-mode, MMF] 212.It Dv IFM_FDDI_UTP 213Unshielded twisted pair, RJ45 connector. [UTP, CDDI] 214.El 215.Pp 216The following media options are defined for FDDI: 217.Bl -tag -offset indent -width ".Dv IFM_FDDI_DA" 218.It Dv IFM_FDDI_DA 219Dual-attached station vs. Single-attached station. [Dual-attach] 220.El 221.Sh MEDIA TYPES AND OPTIONS FOR IEEE802.11 WIRELESS LAN 222The 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 225Frequency Hopping 1Mbps. [FH/1Mbps, FH1, FrequencyHopping/1Mbps] 226.It Dv IFM_IEEE80211_FH2 227Frequency Hopping 2Mbps. [FH/2Mbps, FH2, FrequencyHopping/2Mbps] 228.It Dv IFM_IEEE80211_DS1 229Direct Sequence 1Mbps. [DS/1Mbps, DS1, DirectSequence/1Mbps] 230.It Dv IFM_IEEE80211_DS2 231Direct Sequence 2Mbps. [DS/2Mbps, DS2, DirectSequence/2Mbps] 232.It Dv IFM_IEEE80211_DS5 233Direct Sequence 5Mbps. [DS/5.5Mbps, DS5, DirectSequence/5.5Mbps] 234.It Dv IFM_IEEE80211_DS11 235Direct Sequence 11Mbps. [DS/11Mbps, DS11, DirectSequence/11Mbps] 236.It Dv IFM_IEEE80211_DS22 237Direct Sequence 22Mbps. [DS/22Mbps, DS22, DirectSequence/22Mbps] 238.It Dv IFM_IEEE80211_OFDM6 239Orthogonal Frequency Division Multiplexing 6Mbps. [OFDM/6Mbps, OFDM6] 240.It Dv IFM_IEEE80211_OFDM9 241Orthogonal Frequency Division Multiplexing 9Mbps. [OFDM/9Mbps, OFDM9] 242.It Dv IFM_IEEE80211_OFDM12 243Orthogonal Frequency Division Multiplexing 12Mbps. [OFDM/12Mbps, OFDM12] 244.It Dv IFM_IEEE80211_OFDM18 245Orthogonal Frequency Division Multiplexing 18Mbps. [OFDM/18Mbps, OFDM18] 246.It Dv IFM_IEEE80211_OFDM24 247Orthogonal Frequency Division Multiplexing 24Mbps. [OFDM/24Mbps, OFDM24] 248.It Dv IFM_IEEE80211_OFDM36 249Orthogonal Frequency Division Multiplexing 36Mbps. [OFDM/36Mbps, OFDM36] 250.It Dv IFM_IEEE80211_OFDM48 251Orthogonal Frequency Division Multiplexing 48Mbps. [OFDM/48Mbps, OFDM48] 252.It Dv IFM_IEEE80211_OFDM54 253Orthogonal Frequency Division Multiplexing 54Mbps. [OFDM/54Mbps, OFDM54] 254.It Dv IFM_IEEE80211_OFDM72 255Orthogonal Frequency Division Multiplexing 72Mbps. [OFDM/72Mbps, OFDM72] 256.El 257.Pp 258The 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 261Ad-hoc mode. [adhoc] 262.br 263In some drivers, it may be used with the 264.Dv IFM_FLAG0 265[flag0] media option to specify non-standard ad-hoc demo mode. 266.It Dv IFM_IEEE80211_HOSTAP 267Access Point mode. [hostap] 268.It Dv IFM_IEEE80211_IBSS 269IBSS mode. [ibss] 270.It Dv IFM_IEEE80211_IBSSMASTER 271Operate as an IBSS master. [ibss-master] 272.It Dv IFM_IEEE80211_MONITOR 273Monitor mode. [monitor] 274.It Dv IFM_IEEE80211_TURBO 275Turbo mode. [turbo] 276.El 277.Pp 278The following operating modes are defined for IEEE802.11 Wireless LAN: 279.Bl -tag -offset indent -width ".Dv IFM_IEEE80211_11A" 280.It Dv IFM_AUTO 281Autoselect the best mode. [autoselect, auto] 282.It Dv IFM_IEEE80211_11A 283Orthogonal Frequency Division Multiplexing, 5GHz. [11a] 284.It Dv IFM_IEEE80211_11B 285Direct Sequence mode. [11b] 286.It Dv IFM_IEEE80211_11G 287Orthogonal Frequency Division Multiplexing, 2GHz. [11g] 288.It Dv IFM_IEEE80211_FH 289Gaussian Frequency Shift Keying, 2GHz. [fh] 290.El 291.Sh SEE ALSO 292.Xr netintro 4 , 293.Xr ifconfig 8 294