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