if_media.h revision 1.60 1 /* $NetBSD: if_media.h,v 1.60 2017/10/04 07:07:16 msaitoh Exp $ */
2
3 /*-
4 * Copyright (c) 1998, 2000, 2001 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 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 /*
34 * Copyright (c) 1997
35 * Jonathan Stone and Jason R. Thorpe. All rights reserved.
36 *
37 * This software is derived from information provided by Matt Thomas.
38 *
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
41 * are met:
42 * 1. Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * 2. Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in the
46 * documentation and/or other materials provided with the distribution.
47 * 3. All advertising materials mentioning features or use of this software
48 * must display the following acknowledgement:
49 * This product includes software developed by Jonathan Stone
50 * and Jason R. Thorpe for the NetBSD Project.
51 * 4. The names of the authors may not be used to endorse or promote products
52 * derived from this software without specific prior written permission.
53 *
54 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
55 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
56 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
57 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
58 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
59 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
60 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
61 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
62 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * SUCH DAMAGE.
65 */
66
67 #ifndef _NET_IF_MEDIA_H_
68 #define _NET_IF_MEDIA_H_
69
70 /*
71 * Prototypes and definitions for BSD/OS-compatible network interface
72 * media selection.
73 *
74 * Where it is safe to do so, this code strays slightly from the BSD/OS
75 * design. Software which uses the API (device drivers, basically)
76 * shouldn't notice any difference.
77 *
78 * Many thanks to Matt Thomas for providing the information necessary
79 * to implement this interface.
80 */
81
82 #ifdef _KERNEL
83 #include <sys/queue.h>
84 #endif /*_KERNEL */
85
86 /*
87 * if_media Options word:
88 * Bits Use
89 * ---- -------
90 * 0-4 Media subtype MAX SUBTYPE == 31!
91 * 5-7 Media type
92 * 8-15 Type specific options
93 * 16-18 Mode (for multi-mode devices)
94 * 19 RFU (not used)
95 * 20-27 Shared (global) options
96 * 28-31 Instance
97 *
98 * 3 2 1
99 * 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
100 * +-------+---------------+-+-----+---------------+-----+---------+
101 * | | |R| | | | |STA|
102 * | IMASK | GMASK |F|MMASK| OMASK |NMASK| +---|
103 * | | |U| | | | TMASK |
104 * +-------+---------------+-+-----+---------------+-----+---------+
105 * <-----> <---> <--->
106 * IFM_INST() IFM_MODE() IFM_TYPE()
107 *
108 * <-------------> <-------------> <------->
109 * IFM_OPTIONS() IFM_SUBTYPE()
110 */
111
112 /*
113 * Masks
114 */
115 #define IFM_NMASK 0x000000e0 /* Network type */
116 #define IFM_TMASK 0x0000001f /* Media sub-type */
117 #define IFM_IMASK 0xf0000000 /* Instance */
118 #define IFM_ISHIFT 28 /* Instance shift */
119 #define IFM_OMASK 0x0000ff00 /* Type specific options */
120 #define IFM_MMASK 0x00070000 /* Mode */
121 #define IFM_MSHIFT 16 /* Mode shift */
122 #define IFM_GMASK 0x0ff00000 /* Global options */
123
124 /*
125 * Macros to extract various bits of information from the media word.
126 */
127 #define IFM_TYPE(x) ((x) & IFM_NMASK)
128 #define IFM_SUBTYPE(x) ((x) & IFM_TMASK)
129 #define IFM_INST(x) (((x) & IFM_IMASK) >> IFM_ISHIFT)
130 #define IFM_OPTIONS(x) ((x) & (IFM_OMASK | IFM_GMASK))
131 #define IFM_MODE(x) ((x) & IFM_MMASK)
132
133 #define IFM_TYPE_MATCH(dt, t) \
134 (IFM_TYPE((dt)) == 0 || IFM_TYPE((dt)) == IFM_TYPE((t)))
135
136 #define IFM_INST_MAX IFM_INST(IFM_IMASK)
137 #define IFM_INST_ANY ((u_int) -1)
138
139 /* Mask of "status valid" bits, for ifconfig(8). */
140 #define IFM_STATUS_VALID IFM_AVALID
141
142 /* List of "status valid" bits, for ifconfig(8). */
143 #define IFM_STATUS_VALID_LIST { \
144 IFM_AVALID, \
145 0, \
146 }
147
148 /*
149 * Macro to create a media word.
150 */
151 #define IFM_MAKEWORD(type, subtype, options, instance) \
152 ((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT))
153 #define IFM_MAKEMODE(mode) \
154 (((mode) << IFM_MSHIFT) & IFM_MMASK)
155
156 /*
157 * Media type (IFM_NMASK).
158 */
159 #define IFM_GENERIC 0x00000000 /* Only used for link status reporting */
160 #define IFM_ETHER 0x00000020
161 #define IFM_TOKEN 0x00000040
162 #define IFM_FDDI 0x00000060
163 #define IFM_IEEE80211 0x00000080
164 #define IFM_CARP 0x000000c0 /* Common Address Redundancy Protocol */
165
166 #define IFM_NMIN IFM_ETHER /* lowest Network type */
167 #define IFM_NMAX IFM_NMASK /* highest Network type */
168
169 /*
170 * Shared media sub-types (IFM_TMASK)
171 */
172 #define IFM_AUTO 0 /* Autoselect best media */
173 #define IFM_MANUAL 1 /* Jumper/dipswitch selects media */
174 #define IFM_NONE 2 /* Deselect all media */
175
176 /*
177 * Status bits (IFM_TMASK)
178 */
179 #define IFM_AVALID 0x00000001 /* Active bit valid */
180 #define IFM_ACTIVE 0x00000002 /* Interface attached to working net */
181
182 /*
183 * Shared (global) options (IFM_GMASK)
184 */
185 #define IFM_FDX 0x00100000 /* Force full duplex */
186 #define IFM_HDX 0x00200000 /* Force half duplex */
187 #define IFM_FLOW 0x00400000 /* enable hardware flow control */
188 #define IFM_FLAG0 0x01000000 /* Driver defined flag */
189 #define IFM_FLAG1 0x02000000 /* Driver defined flag */
190 #define IFM_FLAG2 0x04000000 /* Driver defined flag */
191 #define IFM_LOOP 0x08000000 /* Put hardware in loopback */
192
193 /*
194 * 0: Generic (IFM_GENERIC). Only used for link status reporting.
195 * No any media specific flag.
196 */
197
198 /*
199 * 1: Ethernet (IFM_ETHER)
200 */
201 #define IFM_10_T 3 /* 10BaseT - RJ45 */
202 #define IFM_10_2 4 /* 10Base2 - Thinnet */
203 #define IFM_10_5 5 /* 10Base5 - AUI */
204 #define IFM_100_TX 6 /* 100BaseTX - RJ45 */
205 #define IFM_100_FX 7 /* 100BaseFX - Fiber */
206 #define IFM_100_T4 8 /* 100BaseT4 - 4 pair cat 3 */
207 #define IFM_100_VG 9 /* 100VG-AnyLAN */
208 #define IFM_100_T2 10 /* 100BaseT2 */
209 #define IFM_1000_SX 11 /* 1000BaseSX - multi-mode fiber */
210 #define IFM_10_STP 12 /* 10BaseT over shielded TP */
211 #define IFM_10_FL 13 /* 10BaseFL - Fiber */
212 #define IFM_1000_LX 14 /* 1000baseLX - single-mode fiber */
213 #define IFM_1000_CX 15 /* 1000baseCX - 150ohm STP */
214 #define IFM_1000_T 16 /* 1000baseT - 4 pair cat 5 */
215 #define IFM_HPNA_1 17 /* HomePNA 1.0 (1Mb/s) */
216 #define IFM_10G_LR 18 /* 10GbaseLR - single-mode fiber */
217 #define IFM_10G_SR 19 /* 10GBase-SR 850nm Multi-mode */
218 #define IFM_10G_CX4 20 /* 10GBase CX4 copper */
219 #define IFM_2500_SX 21 /* 2500baseSX - multi-mode fiber */
220 #define IFM_1000_BX10 22 /* 1000base-BX10 */
221 #define IFM_10G_TWINAX 23 /* 10GBase Twinax copper */
222 #define IFM_10G_TWINAX_LONG 24 /* 10GBase Twinax Long copper */
223 #define IFM_10G_LRM 25 /* 10GBase-LRM 850nm Multi-mode */
224 #define IFM_10G_T 26 /* 10GBase-T - RJ45 */
225 #define IFM_1000_KX 27 /* 1000base-KX backplane */
226 #define IFM_2500_KX 28 /* 2500base-KX backplane */
227 /* IFM_OMASK bits */
228 #define IFM_ETH_MASTER 0x00000100 /* master mode (1000baseT) */
229 #define IFM_ETH_RXPAUSE 0x00000200 /* receive PAUSE frames */
230 #define IFM_ETH_TXPAUSE 0x00000400 /* transmit PAUSE frames */
231
232 /* Ethernet flow control mask */
233 #define IFM_ETH_FMASK (IFM_FLOW | IFM_ETH_RXPAUSE | IFM_ETH_TXPAUSE)
234
235 /*
236 * 2: Token ring (IFM_TOKEN)
237 */
238 #define IFM_TOK_STP4 3 /* Shielded twisted pair 4m - DB9 */
239 #define IFM_TOK_STP16 4 /* Shielded twisted pair 16m - DB9 */
240 #define IFM_TOK_UTP4 5 /* Unshielded twisted pair 4m - RJ45 */
241 #define IFM_TOK_UTP16 6 /* Unshielded twisted pair 16m - RJ45 */
242 /* IFM_OMASK bits */
243 #define IFM_TOK_ETR 0x00000200 /* Early token release */
244 #define IFM_TOK_SRCRT 0x00000400 /* Enable source routing features */
245 #define IFM_TOK_ALLR 0x00000800 /* All routes / Single route bcast */
246
247 /*
248 * 3: FDDI (IFM_FDDI)
249 */
250 #define IFM_FDDI_SMF 3 /* Single-mode fiber */
251 #define IFM_FDDI_MMF 4 /* Multi-mode fiber */
252 #define IFM_FDDI_UTP 5 /* CDDI / UTP */
253 #define IFM_FDDI_DA 0x00000100 /* Dual attach / single attach */
254
255 /*
256 * 4: IEEE 802.11 Wireless (IFM_IEEE80211)
257 */
258 #define IFM_IEEE80211_FH1 3 /* Frequency Hopping 1Mbps */
259 #define IFM_IEEE80211_FH2 4 /* Frequency Hopping 2Mbps */
260 #define IFM_IEEE80211_DS2 5 /* Direct Sequence 2Mbps */
261 #define IFM_IEEE80211_DS5 6 /* Direct Sequence 5Mbps*/
262 #define IFM_IEEE80211_DS11 7 /* Direct Sequence 11Mbps*/
263 #define IFM_IEEE80211_DS1 8 /* Direct Sequence 1Mbps */
264 #define IFM_IEEE80211_DS22 9 /* Direct Sequence 22Mbps */
265 #define IFM_IEEE80211_OFDM6 10 /* OFDM 6Mbps */
266 #define IFM_IEEE80211_OFDM9 11 /* OFDM 9Mbps */
267 #define IFM_IEEE80211_OFDM12 12 /* OFDM 12Mbps */
268 #define IFM_IEEE80211_OFDM18 13 /* OFDM 18Mbps */
269 #define IFM_IEEE80211_OFDM24 14 /* OFDM 24Mbps */
270 #define IFM_IEEE80211_OFDM36 15 /* OFDM 36Mbps */
271 #define IFM_IEEE80211_OFDM48 16 /* OFDM 48Mbps */
272 #define IFM_IEEE80211_OFDM54 17 /* OFDM 54Mbps */
273 #define IFM_IEEE80211_OFDM72 18 /* OFDM 72Mbps */
274 #define IFM_IEEE80211_DS354k 19 /* Direct Sequence 354Kbps */
275 #define IFM_IEEE80211_DS512k 20 /* Direct Sequence 512Kbps */
276 #define IFM_IEEE80211_OFDM3 21 /* OFDM 3Mbps */
277 #define IFM_IEEE80211_OFDM4 22 /* OFDM 4.5Mbps */
278 #define IFM_IEEE80211_OFDM27 23 /* OFDM 27Mbps */
279 /* NB: not enough bits to express MCS fully */
280 #define IFM_IEEE80211_MCS 24 /* HT MCS rate */
281
282 /* IFM_OMASK bits */
283 #define IFM_IEEE80211_ADHOC 0x00000100 /* Operate in Adhoc mode */
284 #define IFM_IEEE80211_HOSTAP 0x00000200 /* Operate in Host AP mode */
285 #define IFM_IEEE80211_MONITOR 0x00000400 /* Operate in Monitor mode */
286 #define IFM_IEEE80211_TURBO 0x00000800 /* Operate in Turbo mode */
287 #define IFM_IEEE80211_IBSS 0x00001000 /* Operate in IBSS mode */
288 #define IFM_IEEE80211_WDS 0x00002000 /* Operate as an WDS master */
289 #define IFM_IEEE80211_MBSS 0x00004000 /* Operate in MBSS mode */
290
291 /* Operating mode (IFM_MMASK) for multi-mode devices */
292 #define IFM_IEEE80211_11A 0x00010000 /* 5 GHz, OFDM mode */
293 #define IFM_IEEE80211_11B 0x00020000 /* Direct Sequence mode */
294 #define IFM_IEEE80211_11G 0x00030000 /* 2 GHz, CCK mode */
295 #define IFM_IEEE80211_FH 0x00040000 /* 2 GHz, GFSK mode */
296 #define IFM_IEEE80211_11NA 0x00050000 /* 5Ghz, HT mode */
297 #define IFM_IEEE80211_11NG 0x00060000 /* 2Ghz, HT mode */
298
299
300 /*
301 * 6: Common Address Redundancy Protocol (IFM_CARP)
302 * No any media specific flag.
303 */
304
305 /*
306 * NetBSD extension not defined in the BSDI API. This is used in various
307 * places to get the canonical description for a given type/subtype.
308 *
309 * In the subtype and mediaopt descriptions, the valid TYPE bits are OR'd
310 * in to indicate which TYPE the subtype/option corresponds to. If no
311 * TYPE is present, it is a shared media/mediaopt.
312 *
313 * Note that these are parsed case-insensitive.
314 *
315 * Order is important. The first matching entry is the canonical name
316 * for a media type; subsequent matches are aliases.
317 */
318 struct ifmedia_description {
319 int ifmt_word; /* word value; may be masked */
320 const char *ifmt_string; /* description */
321 };
322
323 #define IFM_TYPE_DESCRIPTIONS { \
324 { IFM_ETHER, "Ethernet" }, \
325 { IFM_ETHER, "ether" }, \
326 { IFM_TOKEN, "TokenRing" }, \
327 { IFM_TOKEN, "token" }, \
328 { IFM_FDDI, "FDDI" }, \
329 { IFM_IEEE80211, "IEEE802.11" }, \
330 { IFM_CARP, "CARP" }, \
331 { 0, NULL }, \
332 }
333
334 #define IFM_SUBTYPE_DESCRIPTIONS { \
335 { IFM_AUTO, "autoselect" }, \
336 { IFM_AUTO, "auto" }, \
337 { IFM_MANUAL, "manual" }, \
338 { IFM_NONE, "none" }, \
339 \
340 { IFM_ETHER | IFM_10_T, "10baseT" }, \
341 { IFM_ETHER | IFM_10_T, "10baseT/UTP" }, \
342 { IFM_ETHER | IFM_10_T, "UTP" }, \
343 { IFM_ETHER | IFM_10_T, "10UTP" }, \
344 { IFM_ETHER | IFM_10_T, "10BASE-T" }, \
345 { IFM_ETHER | IFM_10_2, "10base2" }, \
346 { IFM_ETHER | IFM_10_2, "10base2/BNC" }, \
347 { IFM_ETHER | IFM_10_2, "BNC" }, \
348 { IFM_ETHER | IFM_10_2, "10BNC" }, \
349 { IFM_ETHER | IFM_10_2, "10BASE2" }, \
350 { IFM_ETHER | IFM_10_5, "10base5" }, \
351 { IFM_ETHER | IFM_10_5, "10base5/AUI" }, \
352 { IFM_ETHER | IFM_10_5, "AUI" }, \
353 { IFM_ETHER | IFM_10_5, "10AUI" }, \
354 { IFM_ETHER | IFM_10_5, "10BASE5" }, \
355 { IFM_ETHER | IFM_100_TX, "100baseTX" }, \
356 { IFM_ETHER | IFM_100_TX, "100TX" }, \
357 { IFM_ETHER | IFM_100_TX, "100BASE-TX" }, \
358 { IFM_ETHER | IFM_100_FX, "100baseFX" }, \
359 { IFM_ETHER | IFM_100_FX, "100FX" }, \
360 { IFM_ETHER | IFM_100_FX, "100BASE-FX" }, \
361 { IFM_ETHER | IFM_100_T4, "100baseT4" }, \
362 { IFM_ETHER | IFM_100_T4, "100T4" }, \
363 { IFM_ETHER | IFM_100_T4, "100BASE-T4" }, \
364 { IFM_ETHER | IFM_100_VG, "100baseVG" }, \
365 { IFM_ETHER | IFM_100_VG, "100VG" }, \
366 { IFM_ETHER | IFM_100_VG, "100VG-AnyLAN" }, \
367 { IFM_ETHER | IFM_100_T2, "100baseT2" }, \
368 { IFM_ETHER | IFM_100_T2, "100T2" }, \
369 { IFM_ETHER | IFM_100_T2, "100BASE-T2" }, \
370 { IFM_ETHER | IFM_1000_SX, "1000baseSX" }, \
371 { IFM_ETHER | IFM_1000_SX, "1000SX" }, \
372 { IFM_ETHER | IFM_1000_SX, "1000BASE-SX" }, \
373 { IFM_ETHER | IFM_10_STP, "10baseSTP" }, \
374 { IFM_ETHER | IFM_10_STP, "STP" }, \
375 { IFM_ETHER | IFM_10_STP, "10STP" }, \
376 { IFM_ETHER | IFM_10_STP, "10BASE-STP" }, \
377 { IFM_ETHER | IFM_10_FL, "10baseFL" }, \
378 { IFM_ETHER | IFM_10_FL, "FL" }, \
379 { IFM_ETHER | IFM_10_FL, "10FL" }, \
380 { IFM_ETHER | IFM_10_FL, "10BASE-FL" }, \
381 { IFM_ETHER | IFM_1000_LX, "1000baseLX" }, \
382 { IFM_ETHER | IFM_1000_LX, "1000LX" }, \
383 { IFM_ETHER | IFM_1000_LX, "1000BASE-LX" }, \
384 { IFM_ETHER | IFM_1000_CX, "1000baseCX" }, \
385 { IFM_ETHER | IFM_1000_CX, "1000CX" }, \
386 { IFM_ETHER | IFM_1000_CX, "1000BASE-CX" }, \
387 { IFM_ETHER | IFM_1000_BX10, "1000BASE-BX10" }, \
388 { IFM_ETHER | IFM_1000_KX, "1000BASE-KX" }, \
389 { IFM_ETHER | IFM_1000_KX, "1000baseKX" }, \
390 { IFM_ETHER | IFM_1000_T, "1000baseT" }, \
391 { IFM_ETHER | IFM_1000_T, "1000T" }, \
392 { IFM_ETHER | IFM_1000_T, "1000BASE-T" }, \
393 { IFM_ETHER | IFM_HPNA_1, "HomePNA1" }, \
394 { IFM_ETHER | IFM_HPNA_1, "HPNA1" }, \
395 { IFM_ETHER | IFM_2500_KX | IFM_FDX, "2500BASE-KX" }, \
396 { IFM_ETHER | IFM_2500_KX | IFM_FDX, "2500baseKX" }, \
397 { IFM_ETHER | IFM_10G_LR | IFM_FDX, "10GbaseLR" }, \
398 { IFM_ETHER | IFM_10G_LR | IFM_FDX, "10GLR" }, \
399 { IFM_ETHER | IFM_10G_LR | IFM_FDX, "10GBASE-LR" }, \
400 { IFM_ETHER | IFM_10G_SR | IFM_FDX, "10GbaseSR" }, \
401 { IFM_ETHER | IFM_10G_SR | IFM_FDX, "10GSR" }, \
402 { IFM_ETHER | IFM_10G_SR | IFM_FDX, "10GBASE-SR" }, \
403 { IFM_ETHER | IFM_10G_LRM | IFM_FDX, "10Gbase-LRM" }, \
404 { IFM_ETHER | IFM_10G_TWINAX | IFM_FDX, "10Gbase-Twinax" }, \
405 { IFM_ETHER | IFM_10G_TWINAX_LONG | IFM_FDX, "10Gbase-Twinax-Long" },\
406 { IFM_ETHER | IFM_10G_T | IFM_FDX, "10Gbase-T" }, \
407 { IFM_ETHER | IFM_10G_CX4 | IFM_FDX, "10GbaseCX4" }, \
408 { IFM_ETHER | IFM_10G_CX4 | IFM_FDX, "10GCX4" }, \
409 { IFM_ETHER | IFM_10G_CX4 | IFM_FDX, "10GBASE-CX4" }, \
410 { IFM_ETHER | IFM_2500_SX | IFM_FDX, "2500baseSX" }, \
411 { IFM_ETHER | IFM_2500_SX | IFM_FDX, "2500SX" }, \
412 \
413 { IFM_TOKEN | IFM_TOK_STP4, "DB9/4Mbit" }, \
414 { IFM_TOKEN | IFM_TOK_STP4, "4STP" }, \
415 { IFM_TOKEN | IFM_TOK_STP16, "DB9/16Mbit" }, \
416 { IFM_TOKEN | IFM_TOK_STP16, "16STP" }, \
417 { IFM_TOKEN | IFM_TOK_UTP4, "UTP/4Mbit" }, \
418 { IFM_TOKEN | IFM_TOK_UTP4, "4UTP" }, \
419 { IFM_TOKEN | IFM_TOK_UTP16, "UTP/16Mbit" }, \
420 { IFM_TOKEN | IFM_TOK_UTP16, "16UTP" }, \
421 \
422 { IFM_FDDI | IFM_FDDI_SMF, "Single-mode" }, \
423 { IFM_FDDI | IFM_FDDI_SMF, "SMF" }, \
424 { IFM_FDDI | IFM_FDDI_MMF, "Multi-mode" }, \
425 { IFM_FDDI | IFM_FDDI_MMF, "MMF" }, \
426 { IFM_FDDI | IFM_FDDI_UTP, "UTP" }, \
427 { IFM_FDDI | IFM_FDDI_UTP, "CDDI" }, \
428 \
429 /* \
430 * Short-hand for common media+option combos. \
431 */ \
432 { IFM_ETHER | IFM_10_T | IFM_FDX, "10baseT-FDX" }, \
433 { IFM_ETHER | IFM_10_T | IFM_FDX, "10BASE-T-FDX" }, \
434 { IFM_ETHER | IFM_100_TX | IFM_FDX, "100baseTX-FDX" }, \
435 { IFM_ETHER | IFM_100_TX | IFM_FDX, "100BASE-TX-FDX" }, \
436 { IFM_ETHER | IFM_1000_T | IFM_FDX, "1000baseT-FDX" }, \
437 \
438 /* \
439 * IEEE 802.11 \
440 */ \
441 { IFM_IEEE80211 | IFM_IEEE80211_FH1, "FH1" }, \
442 { IFM_IEEE80211 | IFM_IEEE80211_FH2, "FH2" }, \
443 { IFM_IEEE80211 | IFM_IEEE80211_DS1, "DS1" }, \
444 { IFM_IEEE80211 | IFM_IEEE80211_DS2, "DS2" }, \
445 { IFM_IEEE80211 | IFM_IEEE80211_DS5, "DS5" }, \
446 { IFM_IEEE80211 | IFM_IEEE80211_DS11, "DS11" }, \
447 { IFM_IEEE80211 | IFM_IEEE80211_DS22, "DS22" }, \
448 { IFM_IEEE80211 | IFM_IEEE80211_OFDM6, "OFDM6" }, \
449 { IFM_IEEE80211 | IFM_IEEE80211_OFDM9, "OFDM9" }, \
450 { IFM_IEEE80211 | IFM_IEEE80211_OFDM12, "OFDM12" }, \
451 { IFM_IEEE80211 | IFM_IEEE80211_OFDM18, "OFDM18" }, \
452 { IFM_IEEE80211 | IFM_IEEE80211_OFDM24, "OFDM24" }, \
453 { IFM_IEEE80211 | IFM_IEEE80211_OFDM36, "OFDM36" }, \
454 { IFM_IEEE80211 | IFM_IEEE80211_OFDM48, "OFDM48" }, \
455 { IFM_IEEE80211 | IFM_IEEE80211_OFDM54, "OFDM54" }, \
456 { IFM_IEEE80211 | IFM_IEEE80211_OFDM72, "OFDM72" }, \
457 { IFM_IEEE80211 | IFM_IEEE80211_DS354k, "DS/354Kbps" }, \
458 { IFM_IEEE80211 | IFM_IEEE80211_DS512k, "DS/512Kbps" }, \
459 { IFM_IEEE80211 | IFM_IEEE80211_OFDM3, "OFDM/3Mbps" }, \
460 { IFM_IEEE80211 | IFM_IEEE80211_OFDM4, "OFDM/4.5Mbps" }, \
461 { IFM_IEEE80211 | IFM_IEEE80211_OFDM27, "OFDM/27Mbps" }, \
462 \
463 { 0, NULL }, \
464 }
465
466 #define IFM_MODE_DESCRIPTIONS { \
467 { IFM_AUTO, "autoselect" }, \
468 { IFM_AUTO, "auto" }, \
469 { IFM_IEEE80211 | IFM_IEEE80211_11A, "11a" }, \
470 { IFM_IEEE80211 | IFM_IEEE80211_11B, "11b" }, \
471 { IFM_IEEE80211 | IFM_IEEE80211_11G, "11g" }, \
472 { IFM_IEEE80211 | IFM_IEEE80211_FH, "fh" }, \
473 { IFM_IEEE80211 | IFM_IEEE80211_11NA, "11na" }, \
474 { IFM_IEEE80211 | IFM_IEEE80211_11NG, "11ng" }, \
475 { 0, NULL }, \
476 }
477
478 #define IFM_OPTION_DESCRIPTIONS { \
479 { IFM_FDX, "full-duplex" }, \
480 { IFM_FDX, "fdx" }, \
481 { IFM_HDX, "half-duplex" }, \
482 { IFM_HDX, "hdx" }, \
483 { IFM_FLOW, "flowcontrol" }, \
484 { IFM_FLOW, "flow" }, \
485 { IFM_FLAG0, "flag0" }, \
486 { IFM_FLAG1, "flag1" }, \
487 { IFM_FLAG2, "flag2" }, \
488 { IFM_LOOP, "loopback" }, \
489 { IFM_LOOP, "hw-loopback"}, \
490 { IFM_LOOP, "loop" }, \
491 \
492 { IFM_ETHER | IFM_ETH_MASTER, "master" }, \
493 { IFM_ETHER | IFM_ETH_RXPAUSE, "rxpause" }, \
494 { IFM_ETHER | IFM_ETH_TXPAUSE, "txpause" }, \
495 \
496 { IFM_TOKEN | IFM_TOK_ETR, "EarlyTokenRelease" }, \
497 { IFM_TOKEN | IFM_TOK_ETR, "ETR" }, \
498 { IFM_TOKEN | IFM_TOK_SRCRT, "SourceRouting" }, \
499 { IFM_TOKEN | IFM_TOK_SRCRT, "SRCRT" }, \
500 { IFM_TOKEN | IFM_TOK_ALLR, "AllRoutes" }, \
501 { IFM_TOKEN | IFM_TOK_ALLR, "ALLR" }, \
502 \
503 { IFM_FDDI | IFM_FDDI_DA, "dual-attach" }, \
504 { IFM_FDDI | IFM_FDDI_DA, "das" }, \
505 \
506 { IFM_IEEE80211 | IFM_IEEE80211_ADHOC, "adhoc" }, \
507 { IFM_IEEE80211 | IFM_IEEE80211_HOSTAP, "hostap" }, \
508 { IFM_IEEE80211 | IFM_IEEE80211_MONITOR,"monitor" }, \
509 { IFM_IEEE80211 | IFM_IEEE80211_TURBO, "turbo" }, \
510 { IFM_IEEE80211 | IFM_IEEE80211_IBSS, "ibss" }, \
511 { IFM_IEEE80211 | IFM_IEEE80211_WDS, "wds" }, \
512 { IFM_IEEE80211 | IFM_IEEE80211_MBSS, "mesh" }, \
513 \
514 { 0, NULL }, \
515 }
516
517 /*
518 * Baudrate descriptions for the various media types.
519 */
520 struct ifmedia_baudrate {
521 int ifmb_word; /* media word */
522 uint64_t ifmb_baudrate; /* corresponding baudrate */
523 };
524
525 #define IFM_BAUDRATE_DESCRIPTIONS { \
526 { IFM_ETHER | IFM_10_T, IF_Mbps(10) }, \
527 { IFM_ETHER | IFM_10_2, IF_Mbps(10) }, \
528 { IFM_ETHER | IFM_10_5, IF_Mbps(10) }, \
529 { IFM_ETHER | IFM_100_TX, IF_Mbps(100) }, \
530 { IFM_ETHER | IFM_100_FX, IF_Mbps(100) }, \
531 { IFM_ETHER | IFM_100_T4, IF_Mbps(100) }, \
532 { IFM_ETHER | IFM_100_VG, IF_Mbps(100) }, \
533 { IFM_ETHER | IFM_100_T2, IF_Mbps(100) }, \
534 { IFM_ETHER | IFM_1000_SX, IF_Mbps(1000) }, \
535 { IFM_ETHER | IFM_10_STP, IF_Mbps(10) }, \
536 { IFM_ETHER | IFM_10_FL, IF_Mbps(10) }, \
537 { IFM_ETHER | IFM_1000_LX, IF_Mbps(1000) }, \
538 { IFM_ETHER | IFM_1000_CX, IF_Mbps(1000) }, \
539 { IFM_ETHER | IFM_1000_T, IF_Mbps(1000) }, \
540 { IFM_ETHER | IFM_HPNA_1, IF_Mbps(1) }, \
541 { IFM_ETHER | IFM_10G_LR, IF_Gbps(10ULL) }, \
542 { IFM_ETHER | IFM_10G_SR, IF_Gbps(10ULL) }, \
543 { IFM_ETHER | IFM_10G_CX4, IF_Gbps(10ULL) }, \
544 { IFM_ETHER | IFM_2500_SX, IF_Mbps(2500ULL) }, \
545 { IFM_ETHER | IFM_1000_BX10, IF_Mbps(1000ULL) }, \
546 { IFM_ETHER | IFM_10G_TWINAX, IF_Gbps(10) }, \
547 { IFM_ETHER | IFM_10G_TWINAX_LONG, IF_Gbps(10) }, \
548 { IFM_ETHER | IFM_10G_LRM, IF_Gbps(10) }, \
549 { IFM_ETHER | IFM_10G_T, IF_Gbps(10) }, \
550 { IFM_ETHER | IFM_1000_KX, IF_Mbps(1000ULL) }, \
551 { IFM_ETHER | IFM_2500_KX, IF_Mbps(2500ULL) }, \
552 \
553 { IFM_TOKEN | IFM_TOK_STP4, IF_Mbps(4) }, \
554 { IFM_TOKEN | IFM_TOK_STP16, IF_Mbps(16) }, \
555 { IFM_TOKEN | IFM_TOK_UTP4, IF_Mbps(4) }, \
556 { IFM_TOKEN | IFM_TOK_UTP16, IF_Mbps(16) }, \
557 \
558 { IFM_FDDI | IFM_FDDI_SMF, IF_Mbps(100) }, \
559 { IFM_FDDI | IFM_FDDI_MMF, IF_Mbps(100) }, \
560 { IFM_FDDI | IFM_FDDI_UTP, IF_Mbps(100) }, \
561 \
562 { IFM_IEEE80211 | IFM_IEEE80211_FH1, IF_Mbps(1) }, \
563 { IFM_IEEE80211 | IFM_IEEE80211_FH2, IF_Mbps(2) }, \
564 { IFM_IEEE80211 | IFM_IEEE80211_DS2, IF_Mbps(2) }, \
565 { IFM_IEEE80211 | IFM_IEEE80211_DS5, IF_Kbps(5500) }, \
566 { IFM_IEEE80211 | IFM_IEEE80211_DS11, IF_Mbps(11) }, \
567 { IFM_IEEE80211 | IFM_IEEE80211_DS1, IF_Mbps(1) }, \
568 { IFM_IEEE80211 | IFM_IEEE80211_DS22, IF_Mbps(22) }, \
569 { IFM_IEEE80211 | IFM_IEEE80211_OFDM6, IF_Mbps(6) }, \
570 { IFM_IEEE80211 | IFM_IEEE80211_OFDM9, IF_Mbps(9) }, \
571 { IFM_IEEE80211 | IFM_IEEE80211_OFDM12, IF_Mbps(12) }, \
572 { IFM_IEEE80211 | IFM_IEEE80211_OFDM18, IF_Mbps(18) }, \
573 { IFM_IEEE80211 | IFM_IEEE80211_OFDM24, IF_Mbps(24) }, \
574 { IFM_IEEE80211 | IFM_IEEE80211_OFDM36, IF_Mbps(36) }, \
575 { IFM_IEEE80211 | IFM_IEEE80211_OFDM48, IF_Mbps(48) }, \
576 { IFM_IEEE80211 | IFM_IEEE80211_OFDM54, IF_Mbps(54) }, \
577 { IFM_IEEE80211 | IFM_IEEE80211_OFDM72, IF_Mbps(72) }, \
578 \
579 { 0, 0 }, \
580 }
581
582 /*
583 * Status bit descriptions for the various media types.
584 */
585 struct ifmedia_status_description {
586 int ifms_type;
587 int ifms_valid;
588 int ifms_bit;
589 const char *ifms_string[2];
590 };
591
592 #define IFM_STATUS_DESC(ifms, bit) \
593 (ifms)->ifms_string[((ifms)->ifms_bit & (bit)) ? 1 : 0]
594
595 #define IFM_STATUS_DESCRIPTIONS { \
596 { IFM_GENERIC, IFM_AVALID, IFM_ACTIVE, \
597 { "no network", "active" } }, \
598 \
599 { IFM_ETHER, IFM_AVALID, IFM_ACTIVE, \
600 { "no carrier", "active" } }, \
601 \
602 { IFM_FDDI, IFM_AVALID, IFM_ACTIVE, \
603 { "no ring", "inserted" } }, \
604 \
605 { IFM_TOKEN, IFM_AVALID, IFM_ACTIVE, \
606 { "no ring", "inserted" } }, \
607 \
608 { IFM_IEEE80211, IFM_AVALID, IFM_ACTIVE, \
609 { "no network", "active" } }, \
610 \
611 { IFM_CARP, IFM_AVALID, IFM_ACTIVE, \
612 { "backup", "master" } }, \
613 \
614 { 0, 0, 0, \
615 { NULL, NULL } }, \
616 }
617
618 #ifdef _KERNEL
619 /*
620 * Driver callbacks for media status and change requests.
621 */
622 typedef int (*ifm_change_cb_t)(struct ifnet *);
623 typedef void (*ifm_stat_cb_t)(struct ifnet *, struct ifmediareq *);
624
625 /*
626 * In-kernel representation of a single supported media type.
627 */
628 struct ifmedia_entry {
629 TAILQ_ENTRY(ifmedia_entry) ifm_list;
630 u_int ifm_media; /* description of this media attachment */
631 u_int ifm_data; /* for driver-specific use */
632 void *ifm_aux; /* for driver-specific use */
633 };
634
635 /*
636 * One of these goes into a network interface's softc structure.
637 * It is used to keep general media state.
638 */
639 struct ifmedia {
640 u_int ifm_mask; /* mask of changes we don't care about */
641 u_int ifm_media; /* current user-set media word */
642 struct ifmedia_entry *ifm_cur; /* currently selected media */
643 TAILQ_HEAD(, ifmedia_entry) ifm_list; /* list of all supported media */
644 ifm_change_cb_t ifm_change; /* media change driver callback */
645 ifm_stat_cb_t ifm_status; /* media status driver callback */
646 };
647
648 /* Initialize an interface's struct if_media field. */
649 void ifmedia_init(struct ifmedia *, int, ifm_change_cb_t, ifm_stat_cb_t);
650
651 int ifmedia_change(struct ifmedia *, struct ifnet *);
652
653 /* Add one supported medium to a struct ifmedia. */
654 void ifmedia_add(struct ifmedia *, int, int, void *);
655
656 /* Add an array (of ifmedia_entry) media to a struct ifmedia. */
657 void ifmedia_list_add(struct ifmedia *, struct ifmedia_entry *, int);
658
659 /* Set default media type on initialization. */
660 void ifmedia_set(struct ifmedia *ifm, int mword);
661
662 /* Common ioctl function for getting/setting media, called by driver. */
663 int ifmedia_ioctl(struct ifnet *, struct ifreq *, struct ifmedia *, u_long);
664
665 /* Look up a media entry. */
666 struct ifmedia_entry *ifmedia_match(struct ifmedia *, u_int, u_int);
667
668 /* Delete all media for a given media instance */
669 void ifmedia_delete_instance(struct ifmedia *, u_int);
670
671 /* Compute baudrate for a given media. */
672 uint64_t ifmedia_baudrate(int);
673
674 /* Remove all media */
675 void ifmedia_removeall(struct ifmedia *);
676
677 #else
678 /* Functions for converting media to/from strings, in libutil/if_media.c */
679 const char *get_media_type_string(int);
680 const char *get_media_subtype_string(int);
681 const char *get_media_mode_string(int);
682 const char *get_media_option_string(int *);
683 int get_media_mode(int, const char *);
684 int get_media_subtype(int, const char *);
685 int get_media_options(int, const char *, char **);
686 int lookup_media_word(struct ifmedia_description *, int, const char *);
687 #endif /* _KERNEL */
688
689 #endif /* !_NET_IF_MEDIA_H_ */
690