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