share/man/man4/ifmedia.4

   1 .\"     $NetBSD: ifmedia.4,v 1.29 2009/04/10 17:07:15 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 1998, 1999, 2000, 2001, 2002, 2003, 2004
   4 .\"     The NetBSD Foundation, Inc.
   5 .\" All rights reserved.
   6 .\"
   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.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  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.
  26 .\"
  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.
  38 .\"
  39 .Dd September 30, 2014
  40 .Dt IFMEDIA 4
  41 .Os
  42 .Sh NAME
  43 .Nm ifmedia
  44 .Nd network interface media settings
  45 .Sh SYNOPSIS
  46 .In sys/socket.h
  47 .In net/if.h
  48 .In net/if_media.h
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 interface provides a consistent method for querying and setting
  53 network interface media and media options.  The media is typically
  54 set using the
  55 .Xr ifconfig 8
  56 command.
  57 .Pp
  58 There are currently four link types supported by
  59 .Nm :
  60 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211"
  61 .It Dv IFM_ATM
  62 Asynchronous Transfer Mode
  63 .It Dv IFM_CARP
  64 Common Address Redundancy Protocol
  65 .It Dv IFM_ETHER
  66 Ethernet
  67 .It Dv IFM_IEEE80211
  68 IEEE802.11 Wireless LAN
  69 .El
  70 .Pp
  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.
  74 .Pp
  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
  78 option.
  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"
  82 .It Dv IFM_AUTO
  83 Autoselect the best media.  [autoselect, auto]
  84 .It Dv IFM_MANUAL
  85 Jumper or switch on device selects media.  [manual]
  86 .It Dv IFM_NONE
  87 Deselect all media.  [none]
  88 .El
  89 .Pp
  90 The following media options are shared by all link types:
  91 .Bl -tag -offset indent -width ".Dv IFM_FLAG0"
  92 .It Dv IFM_FDX
  93 Place the device into full-duplex mode.  This option only has meaning
  94 if the device is normally not full-duplex.  [full-duplex]
  95 .It Dv IFM_HDX
  96 Place the device into half-duplex mode.  This option only has meaning
  97 if the device is normally not half-duplex.  [half-duplex]
  98 .It Dv IFM_FLAG0
  99 Driver-defined flag.  [flag0]
 100 .It Dv IFM_FLAG1
 101 Driver-defined flag.  [flag1]
 102 .It Dv IFM_FLAG2
 103 Driver-defined flag.  [flag2]
 104 .It Dv IFM_LOOP
 105 Place the device into hardware loopback mode.  [hw-loopback]
 106 .El
 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
 129 .\"...
 130 .El
 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"
 134 .It Dv IFM_HPNA_1
 135 HomePNA 1.0, 1Mb/s.  [homePNA]
 136 .It Dv IFM_10_T
 137 10BASE-T, 10Mb/s over unshielded twisted pair, RJ45 connector.  [10baseT/UTP,
 138 UTP, 10UTP]
 139 .It Dv IFM_10_2
 140 10BASE2, 10Mb/s over coaxial cable, BNC connector, also called Thinnet.
 141 [10base2/BNC, BNC, 10BNC]
 142 .It Dv IFM_10_5
 143 10BASE5, 10Mb/s over 15-wire cables, DB15 connector, also called AUI.
 144 [10base5/AUI, AUI, 10AUI]
 145 .It Dv IFM_10_STP
 146 10BASE-STP, 10Mb/s over shielded twisted pair, DB9 connector.  [10baseSTP,
 147 10STP]
 148 .It Dv IFM_10_FL
 149 10BASE-FL, 10Mb/s over fiber optic cables.  [10baseFL, 10FL]
 150 .It Dv IFM_100_TX
 151 100BASE-TX, 100Mb/s over unshielded twisted pair, RJ45 connector.  [100baseTX,
 152 100TX]
 153 .It Dv IFM_100_FX
 154 100BASE-FX, 100Mb/s over fiber optic cables.  [100baseFX, 100FX]
 155 .It Dv IFM_100_T4
 156 100BASE-T4, 100Mb/s over 4-wire (category 3) unshielded twisted pair, RJ45
 157 connector.  [100baseT4, 100T4]
 158 .It Dv IFM_100_T2
 159 100BASE-T2.  [100baseT2, 100T2]
 160 .It Dv IFM_100_VG
 161 100VG-AnyLAN.  [100baseVG, 100VG]
 162 .It Dv IFM_1000_SX
 163 1000BASE-SX, 1Gb/s over multi-mode fiber optic cables. (short waves)
 164 [1000baseSX, 1000SX]
 165 .It Dv IFM_1000_LX
 166 1000BASE-LX, 1Gb/s over single-mode fiber optic cables. (long waves)
 167 [1000baseLX, 1000LX]
 168 .It Dv IFM_1000_CX
 169 1000BASE-CX, 1Gb/s over shielded twisted pair. (twinax)
 170 [1000baseCX, 1000CX]
 171 .It Dv IFM_1000_T
 172 1000BASE-T, 1Gb/s over category 5 unshielded twisted pair, 802.3ab, RJ45
 173 connector.
 174 [1000baseT, 1000T]
 175 .It Dv IFM_10G_LR
 176 10GBASE-LR, 10Gb/s over single-mode fiber optic cables.
 177 [10Gbase-LR]
 178 .It Dv IFM_10G_SR
 179 10GBASE-SR, 10Gb/s over multi-mode fiber optic cables.
 180 [10Gbase-SR]
 181 .It Dv IFM_10G_CX4
 182 10GBASE-CX4, 10Gb/s over XAUI 4-lane PCS and copper cables.
 183 [10Gbase-CX4]
 184 .It Dv IFM_2500_SX
 185 2500BASE-SX, 2.5Gb/s over multi-mode fiber optic cables.
 186 [2500BaseSX, 2500SX]
 187 .\".It Dv IFM_10G_TWINAX
 188 .\".It Dv IFM_10G_TWINAX_LONG
 189 .\".It Dv IFM_10G_LRM
 190 .It Dv IFM_10G_T
 191 10GBASE-T, 10Gb/s over unshielded twisted pair, RJ45 connector.
 192 [10Gbase-T]
 193 .It Dv IFM_40G_CR4
 194 40GBASE-CR4, 40Gb/s over twin-ax copper cable.
 195 [40GBASE-CR4]
 196 .It Dv IFM_40G_SR4
 197 40GBASE-SR4, 40Gb/s over multi-mode fiber optic cables.
 198 [40GBASE-SR4]
 199 .It Dv IFM_40G_LR4
 200 40GBASE-LR4, 40Gb/s over single-mode fiber optic cables.
 201 [40GBASE-LR4]
 202 .El
 203 .Pp
 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 )
 210 if the media is
 211 .Dv IFM_AUTO .
 212 .It Dv IFM_ETH_TXPAUSE
 213 Configure the device to send PAUSE
 214 .Pf ( flow control )
 215 frames.
 216 This option has no effect
 217 .Pf ( shows current status only )
 218 if the media is
 219 .Dv IFM_AUTO .
 220 .It Dv IFM_ETH_RXPAUSE
 221 Configure the device to receive PAUSE
 222 .Pf ( flow control )
 223 frames.
 224 This option has no effect
 225 .Pf ( shows current status only )
 226 if the media is
 227 .Dv IFM_AUTO .
 228 .El
 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
 251 .\"...
 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]
 276 .El
 277 .Pp
 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
 281 Ad-hoc mode.  [adhoc]
 282 .Pp
 283 In some drivers, it may be used with the
 284 .Dv IFM_FLAG0
 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
 289 IBSS mode.  [ibss]
 290 .It Dv IFM_IEEE80211_MBSS
 291 MBSS mode.  [mesh]
 292 .It Dv IFM_IEEE80211_MONITOR
 293 Monitor mode.  [monitor]
 294 .It Dv IFM_IEEE80211_TURBO
 295 Turbo mode.  [turbo]
 296 .It Dv IFM_IEEE80211_WDS
 297 WDS mode.  [wds]
 298 .El
 299 .Pp
 300 The following operating modes are defined for IEEE802.11 Wireless LAN:
 301 .Bl -tag -offset indent -width ".Dv IFM_IEEE80211_11NA"
 302 .It Dv IFM_AUTO
 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]
 316 .El
 317 .Sh SEE ALSO
 318 .Xr netintro 4 ,
 319 .Xr ifconfig 8