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