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