share/man/man4/ifmedia.4

   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.5 2007/09/13 10:33:10 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 6, 2007
  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
  51 The
  52 .Nm
  53 interface provides a consistent method for querying and setting
  54 network interface media and media options.  The media is typically
  55 set using the
  56 .Xr ifconfig 8
  57 command.
  58 .Pp
  59 There are currently four link types supported by
  60 .Nm :
  61 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211"
  62 .It Dv IFM_ATM
  63 Asynchronous Transfer Mode
  64 .It Dv IFM_CARP
  65 Common Address Redundancy Protocol
  66 .It Dv IFM_ETHER
  67 Ethernet
  68 .It Dv IFM_IEEE80211
  69 IEEE802.11 Wireless LAN
  70 .El
  71 .Pp
  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.
  75 .Pp
  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
  79 option.
  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"
  83 .It Dv IFM_AUTO
  84 Autoselect the best media.  [autoselect, auto]
  85 .It Dv IFM_MANUAL
  86 Jumper or switch on device selects media.  [manual]
  87 .It Dv IFM_NONE
  88 Deselect all media.  [none]
  89 .El
  90 .Pp
  91 The following media options are shared by all link types:
  92 .Bl -tag -offset indent -width ".Dv IFM_FLAG0"
  93 .It Dv IFM_FDX
  94 Place the device into full-duplex mode.  This option only has meaning
  95 if the device is normally not full-duplex.  [full-duplex]
  96 .It Dv IFM_HDX
  97 Place the device into half-duplex mode.  This option only has meaning
  98 if the device is normally not half-duplex.  [half-duplex]
  99 .It Dv IFM_FLAG0
 100 Driver-defined flag.  [flag0]
 101 .It Dv IFM_FLAG1
 102 Driver-defined flag.  [flag1]
 103 .It Dv IFM_FLAG2
 104 Driver-defined flag.  [flag2]
 105 .It Dv IFM_LOOP
 106 Place the device into hardware loopback mode.  [hw-loopback]
 107 .El
 108 .Sh MEDIA TYPES AND OPTIONS FOR ASYNCHRONOUS TRANSFER MODE
 109 The following media types are defined for Asynchronous Transfer Mode:
 110 .Bl -tag -offset indent -width ".Dv IFM_ATM_TAXI_100"
 111 .It Dv IFM_ATM_UNKNOWN
 112 Unknown media type.  [Unknown, UNKNOWN]
 113 .It Dv IFM_ATM_UTP_25
 114 25Mb/s over unshielded twisted pair.  [UTP/25.6MBit, UTP-25]
 115 .It Dv IFM_ATM_TAXI_100
 116 AMD TAXI, 100Mb/s over multi-mode fiber optic cables.  [Taxi/100MBit, TAXI-100]
 117 .It Dv IFM_ATM_TAXI_140
 118 AMD TAXI, 140Mb/s over multi-node fiber optic cables.  [Taxi/140MBit, TAXI-140]
 119 .It Dv IFM_ATM_MM_155
 120 155Mb/s over multi-mode fiber optic cables. [Multi-mode/155MBit, MM-155]
 121 .It Dv IFM_ATM_SM_155
 122 155Mb/s over single-mode fiber optic cables. [Single-mode/155MBit, SM-155]
 123 .It Dv IFM_ATM_UTP_155
 124 155Mb/s over unshielded twisted pair. [UTP/155Mbit, UTP-155]
 125 .It Dv IFM_ATM_MM_622
 126 622Mb/s over multi-mode fiber optic cables. [Multi-mode/622MBit, MM-622]
 127 .It Dv IFM_ATM_SM_622
 128 622Mb/s over single-mode fiber optic cables. [Single-mode/622MBit, SM-622]
 129 .\".It Dv IFM_ATM_VIRTUAL
 130 .\"...
 131 .El
 132 .Sh MEDIA TYPES AND OPTIONS FOR ETHERNET
 133 The following media types are defined for Ethernet:
 134 .Bl -tag -offset indent -width ".Dv IFM_1000_FX"
 135 .It Dv IFM_HPNA_1
 136 HomePNA 1.0, 1Mb/s.  [homePNA]
 137 .It Dv IFM_10_T
 138 10BASE-T, 10Mb/s over unshielded twisted pair, RJ45 connector.  [10baseT/UTP,
 139 UTP, 10UTP]
 140 .It Dv IFM_10_2
 141 10BASE2, 10Mb/s over coaxial cable, BNC connector, also called Thinnet.
 142 [10base2/BNC, BNC, 10BNC]
 143 .It Dv IFM_10_5
 144 10BASE5, 10Mb/s over 15-wire cables, DB15 connector, also called AUI.
 145 [10base5/AUI, AUI, 10AUI]
 146 .It Dv IFM_10_STP
 147 10BASE-STP, 10Mb/s over shielded twisted pair, DB9 connector.  [10baseSTP,
 148 10STP]
 149 .It Dv IFM_10_FL
 150 10BASE-FL, 10Mb/s over fiber optic cables.  [10baseFL, 10FL]
 151 .It Dv IFM_100_TX
 152 100BASE-TX, 100Mb/s over unshielded twisted pair, RJ45 connector.  [100baseTX,
 153 100TX]
 154 .It Dv IFM_100_FX
 155 100BASE-FX, 100Mb/s over fiber optic cables.  [100baseFX, 100FX]
 156 .It Dv IFM_100_T4
 157 100BASE-T4, 100Mb/s over 4-wire (category 3) unshielded twisted pair, RJ45
 158 connector.  [100baseT4, 100T4]
 159 .It Dv IFM_100_T2
 160 100BASE-T2.  [100baseT2, 100T2]
 161 .It Dv IFM_100_VG
 162 100VG-AnyLAN.  [100baseVG, 100VG]
 163 .It Dv IFM_1000_SX
 164 1000BASE-SX, 1Gb/s over multi-mode fiber optic cables.  [1000baseSX, 1000SX]
 165 .It Dv IFM_1000_LX
 166 1000BASE-LX, 1Gb/s over single-mode fiber optic cables.  [1000baseLX, 1000LX]
 167 .It Dv IFM_1000_CX
 168 1000BASE-CX, 1Gb/s over shielded twisted pair.  [1000baseCX, 1000CX]
 169 .It Dv IFM_1000_T
 170 1000BASE-T, 1Gb/s over category 5 unshielded twisted pair, RJ45 connector.
 171 [1000baseT, 1000T]
 172 .El
 173 .Pp
 174 The following media options defined for Ethernet:
 175 .Bl -tag -offset indent -width ".Dv IFM_ETH_TXPAUSE"
 176 .It Dv IFM_ETH_MASTER
 177 Configure a 1000BASE-T PHY as the clock master for a 1000BASE-T link.
 178 This option has no effect
 179 .Pf ( shows current status only )
 180 if the media is
 181 .Dv IFM_AUTO .
 182 .It Dv IFM_ETH_TXPAUSE
 183 Configure the device to send PAUSE
 184 .Pf ( flow control )
 185 frames.
 186 This option has no effect
 187 .Pf ( shows current status only )
 188 if the media is
 189 .Dv IFM_AUTO .
 190 .It Dv IFM_ETH_RXPAUSE
 191 Configure the device to receive PAUSE
 192 .Pf ( flow control )
 193 frames.
 194 This option has no effect
 195 .Pf ( shows current status only )
 196 if the media is
 197 .Dv IFM_AUTO .
 198 .El
 199 .Sh MEDIA TYPES AND OPTIONS FOR IEEE802.11 WIRELESS LAN
 200 The following media types are defined for IEEE802.11 Wireless LAN:
 201 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_OFDM12"
 202 .It Dv IFM_IEEE80211_FH1
 203 Frequency Hopping 1Mbps.  [FH/1Mbps, FH1, FrequencyHopping/1Mbps]
 204 .It Dv IFM_IEEE80211_FH2
 205 Frequency Hopping 2Mbps.  [FH/2Mbps, FH2, FrequencyHopping/2Mbps]
 206 .It Dv IFM_IEEE80211_DS1
 207 Direct Sequence 1Mbps.  [DS/1Mbps, DS1, DirectSequence/1Mbps]
 208 .It Dv IFM_IEEE80211_DS2
 209 Direct Sequence 2Mbps.  [DS/2Mbps, DS2, DirectSequence/2Mbps]
 210 .It Dv IFM_IEEE80211_DS5
 211 Direct Sequence 5Mbps.  [DS/5.5Mbps, DS5, DirectSequence/5.5Mbps]
 212 .It Dv IFM_IEEE80211_DS11
 213 Direct Sequence 11Mbps.  [DS/11Mbps, DS11, DirectSequence/11Mbps]
 214 .It Dv IFM_IEEE80211_DS22
 215 Direct Sequence 22Mbps.  [DS/22Mbps, DS22, DirectSequence/22Mbps]
 216 .It Dv IFM_IEEE80211_OFDM6
 217 Orthogonal Frequency Division Multiplexing 6Mbps.  [OFDM/6Mbps, OFDM6]
 218 .It Dv IFM_IEEE80211_OFDM9
 219 Orthogonal Frequency Division Multiplexing 9Mbps.  [OFDM/9Mbps, OFDM9]
 220 .It Dv IFM_IEEE80211_OFDM12
 221 Orthogonal Frequency Division Multiplexing 12Mbps.  [OFDM/12Mbps, OFDM12]
 222 .It Dv IFM_IEEE80211_OFDM18
 223 Orthogonal Frequency Division Multiplexing 18Mbps.  [OFDM/18Mbps, OFDM18]
 224 .It Dv IFM_IEEE80211_OFDM24
 225 Orthogonal Frequency Division Multiplexing 24Mbps.  [OFDM/24Mbps, OFDM24]
 226 .It Dv IFM_IEEE80211_OFDM36
 227 Orthogonal Frequency Division Multiplexing 36Mbps.  [OFDM/36Mbps, OFDM36]
 228 .It Dv IFM_IEEE80211_OFDM48
 229 Orthogonal Frequency Division Multiplexing 48Mbps.  [OFDM/48Mbps, OFDM48]
 230 .It Dv IFM_IEEE80211_OFDM54
 231 Orthogonal Frequency Division Multiplexing 54Mbps.  [OFDM/54Mbps, OFDM54]
 232 .It Dv IFM_IEEE80211_OFDM72
 233 Orthogonal Frequency Division Multiplexing 72Mbps.  [OFDM/72Mbps, OFDM72]
 234 .El
 235 .Pp
 236 The following media options are defined for IEEE802.11 Wireless LAN:
 237 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_IBSSMASTER"
 238 .It Dv IFM_IEEE80211_ADHOC
 239 Ad-hoc mode.  [adhoc]
 240 .br
 241 In some drivers, it may be used with the
 242 .Dv IFM_FLAG0
 243 [flag0] media option to specify non-standard ad-hoc demo mode.
 244 .It Dv IFM_IEEE80211_HOSTAP
 245 Access Point mode.  [hostap]
 246 .It Dv IFM_IEEE80211_IBSS
 247 IBSS mode.  [ibss]
 248 .It Dv IFM_IEEE80211_IBSSMASTER
 249 Operate as an IBSS master.  [ibss-master]
 250 .It Dv IFM_IEEE80211_MONITOR
 251 Monitor mode.  [monitor]
 252 .It Dv IFM_IEEE80211_TURBO
 253 Turbo mode.  [turbo]
 254 .El
 255 .Pp
 256 The following operating modes are defined for IEEE802.11 Wireless LAN:
 257 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_11A"
 258 .It Dv IFM_AUTO
 259 Autoselect the best mode.  [autoselect, auto]
 260 .It Dv IFM_IEEE80211_11A
 261 Orthogonal Frequency Division Multiplexing, 5GHz.  [11a]
 262 .It Dv IFM_IEEE80211_11B
 263 Direct Sequence mode.  [11b]
 264 .It Dv IFM_IEEE80211_11G
 265 Orthogonal Frequency Division Multiplexing, 2GHz.  [11g]
 266 .It Dv IFM_IEEE80211_FH
 267 Gaussian Frequency Shift Keying, 2GHz.  [fh]
 268 .El
 269 .Sh SEE ALSO
 270 .Xr netintro 4 ,
 271 .Xr ifconfig 8