Home | History | Annotate | Line # | Download | only in net
if_media.h revision 1.52
      1 /*	$NetBSD: if_media.h,v 1.52 2009/08/12 11:17:17 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 
     84 #include <sys/queue.h>
     85 
     86 /*
     87  * Driver callbacks for media status and change requests.
     88  */
     89 typedef	int (*ifm_change_cb_t)(struct ifnet *);
     90 typedef	void (*ifm_stat_cb_t)(struct ifnet *, struct ifmediareq *);
     91 
     92 /*
     93  * In-kernel representation of a single supported media type.
     94  */
     95 struct ifmedia_entry {
     96 	TAILQ_ENTRY(ifmedia_entry) ifm_list;
     97 	u_int	ifm_media;	/* description of this media attachment */
     98 	u_int	ifm_data;	/* for driver-specific use */
     99 	void	*ifm_aux;	/* for driver-specific use */
    100 };
    101 
    102 /*
    103  * One of these goes into a network interface's softc structure.
    104  * It is used to keep general media state.
    105  */
    106 struct ifmedia {
    107 	u_int	ifm_mask;	/* mask of changes we don't care about */
    108 	u_int	ifm_media;	/* current user-set media word */
    109 	struct ifmedia_entry *ifm_cur;	/* currently selected media */
    110 	TAILQ_HEAD(, ifmedia_entry) ifm_list; /* list of all supported media */
    111 	ifm_change_cb_t	ifm_change;	/* media change driver callback */
    112 	ifm_stat_cb_t	ifm_status;	/* media status driver callback */
    113 };
    114 
    115 /* Initialize an interface's struct if_media field. */
    116 void	ifmedia_init(struct ifmedia *, int, ifm_change_cb_t, ifm_stat_cb_t);
    117 
    118 int ifmedia_change(struct ifmedia *, struct ifnet *);
    119 
    120 /* Add one supported medium to a struct ifmedia. */
    121 void	ifmedia_add(struct ifmedia *, int, int, void *);
    122 
    123 /* Add an array (of ifmedia_entry) media to a struct ifmedia. */
    124 void	ifmedia_list_add(struct ifmedia *, struct ifmedia_entry *, int);
    125 
    126 /* Set default media type on initialization. */
    127 void	ifmedia_set(struct ifmedia *ifm, int mword);
    128 
    129 /* Common ioctl function for getting/setting media, called by driver. */
    130 int	ifmedia_ioctl(struct ifnet *, struct ifreq *, struct ifmedia *, u_long);
    131 
    132 /* Look up a media entry. */
    133 struct ifmedia_entry *ifmedia_match(struct ifmedia *, u_int, u_int);
    134 
    135 /* Delete all media for a given media instance */
    136 void	ifmedia_delete_instance(struct ifmedia *, u_int);
    137 
    138 /* Compute baudrate for a given media. */
    139 u_quad_t	ifmedia_baudrate(int);
    140 
    141 /* Remove all media */
    142 void		ifmedia_removeall(struct ifmedia *);
    143 
    144 #endif /*_KERNEL */
    145 
    146 /*
    147  * if_media Options word:
    148  *	Bits	Use
    149  *	----	-------
    150  *	0-4	Media subtype		MAX SUBTYPE == 31!
    151  *	5-7	Media type
    152  *	8-15	Type specific options
    153  *	16-18	Mode (for multi-mode devices)
    154  *	19	RFU
    155  *	20-27	Shared (global) options
    156  *	28-31	Instance
    157  */
    158 
    159 /*
    160  * Ethernet
    161  */
    162 #define	IFM_ETHER	0x00000020
    163 #define	IFM_10_T	3		/* 10BaseT - RJ45 */
    164 #define	IFM_10_2	4		/* 10Base2 - Thinnet */
    165 #define	IFM_10_5	5		/* 10Base5 - AUI */
    166 #define	IFM_100_TX	6		/* 100BaseTX - RJ45 */
    167 #define	IFM_100_FX	7		/* 100BaseFX - Fiber */
    168 #define	IFM_100_T4	8		/* 100BaseT4 - 4 pair cat 3 */
    169 #define	IFM_100_VG	9		/* 100VG-AnyLAN */
    170 #define	IFM_100_T2	10		/* 100BaseT2 */
    171 #define	IFM_1000_SX	11		/* 1000BaseSX - multi-mode fiber */
    172 #define	IFM_10_STP	12		/* 10BaseT over shielded TP */
    173 #define	IFM_10_FL	13		/* 10BaseFL - Fiber */
    174 #define	IFM_1000_LX	14		/* 1000baseLX - single-mode fiber */
    175 #define	IFM_1000_CX	15		/* 1000baseCX - 150ohm STP */
    176 #define	IFM_1000_T	16		/* 1000baseT - 4 pair cat 5 */
    177 #define	IFM_HPNA_1	17		/* HomePNA 1.0 (1Mb/s) */
    178 #define	IFM_10G_LR	18		/* 10GbaseLR - single-mode fiber */
    179 #define	IFM_10G_SR	19		/* 10GBase-SR 850nm Multi-mode */
    180 #define	IFM_10G_CX4	20		/* 10GBase CX4 copper */
    181 #define	IFM_2500_SX	21		/* 2500baseSX - multi-mode fiber */
    182 #define	IFM_1000_BX10	22		/* 1000base-BX10 */
    183 
    184 #define	IFM_ETH_MASTER	0x00000100	/* master mode (1000baseT) */
    185 #define	IFM_ETH_RXPAUSE	0x00000200	/* receive PAUSE frames */
    186 #define	IFM_ETH_TXPAUSE	0x00000400	/* transmit PAUSE frames */
    187 
    188 /*
    189  * Token ring
    190  */
    191 #define	IFM_TOKEN	0x00000040
    192 #define	IFM_TOK_STP4	3		/* Shielded twisted pair 4m - DB9 */
    193 #define	IFM_TOK_STP16	4		/* Shielded twisted pair 16m - DB9 */
    194 #define	IFM_TOK_UTP4	5		/* Unshielded twisted pair 4m - RJ45 */
    195 #define	IFM_TOK_UTP16	6		/* Unshielded twisted pair 16m - RJ45 */
    196 #define	IFM_TOK_ETR	0x00000200	/* Early token release */
    197 #define	IFM_TOK_SRCRT	0x00000400	/* Enable source routing features */
    198 #define	IFM_TOK_ALLR	0x00000800	/* All routes / Single route bcast */
    199 
    200 /*
    201  * FDDI
    202  */
    203 #define	IFM_FDDI	0x00000060
    204 #define	IFM_FDDI_SMF	3		/* Single-mode fiber */
    205 #define	IFM_FDDI_MMF	4		/* Multi-mode fiber */
    206 #define	IFM_FDDI_UTP	5		/* CDDI / UTP */
    207 #define	IFM_FDDI_DA	0x00000100	/* Dual attach / single attach */
    208 
    209 /*
    210  * IEEE 802.11 Wireless
    211  */
    212 #define	IFM_IEEE80211	0x00000080
    213 #define	IFM_IEEE80211_FH1	3	/* Frequency Hopping 1Mbps */
    214 #define	IFM_IEEE80211_FH2	4	/* Frequency Hopping 2Mbps */
    215 #define	IFM_IEEE80211_DS2	5	/* Direct Sequence 2Mbps */
    216 #define	IFM_IEEE80211_DS5	6	/* Direct Sequence 5Mbps*/
    217 #define	IFM_IEEE80211_DS11	7	/* Direct Sequence 11Mbps*/
    218 #define	IFM_IEEE80211_DS1	8	/* Direct Sequence 1Mbps */
    219 #define	IFM_IEEE80211_DS22	9	/* Direct Sequence 22Mbps */
    220 #define	IFM_IEEE80211_OFDM6	10	/* OFDM 6Mbps */
    221 #define	IFM_IEEE80211_OFDM9	11	/* OFDM 9Mbps */
    222 #define	IFM_IEEE80211_OFDM12	12	/* OFDM 12Mbps */
    223 #define	IFM_IEEE80211_OFDM18	13	/* OFDM 18Mbps */
    224 #define	IFM_IEEE80211_OFDM24	14	/* OFDM 24Mbps */
    225 #define	IFM_IEEE80211_OFDM36	15	/* OFDM 36Mbps */
    226 #define	IFM_IEEE80211_OFDM48	16	/* OFDM 48Mbps */
    227 #define	IFM_IEEE80211_OFDM54	17	/* OFDM 54Mbps */
    228 #define	IFM_IEEE80211_OFDM72	18	/* OFDM 72Mbps */
    229 #define	IFM_IEEE80211_DS354k	19	/* Direct Sequence 354Kbps */
    230 #define	IFM_IEEE80211_DS512k	20	/* Direct Sequence 512Kbps */
    231 #define	IFM_IEEE80211_OFDM3	21	/* OFDM 3Mbps */
    232 #define	IFM_IEEE80211_OFDM4	22	/* OFDM 4.5Mbps */
    233 #define	IFM_IEEE80211_OFDM27	23	/* OFDM 27Mbps */
    234 /* NB: not enough bits to express MCS fully */
    235 #define	IFM_IEEE80211_MCS	24	/* HT MCS rate */
    236 
    237 #define	IFM_IEEE80211_ADHOC	0x00000100	/* Operate in Adhoc mode */
    238 #define	IFM_IEEE80211_HOSTAP	0x00000200	/* Operate in Host AP mode */
    239 #define	IFM_IEEE80211_MONITOR	0x00000400	/* Operate in Monitor mode */
    240 #define	IFM_IEEE80211_TURBO	0x00000800	/* Operate in Turbo mode */
    241 #define	IFM_IEEE80211_IBSS	0x00001000	/* Operate in IBSS mode */
    242 #define	IFM_IEEE80211_WDS 	0x00002000	/* Operate as an WDS master */
    243 
    244 /* operating mode for multi-mode devices */
    245 #define	IFM_IEEE80211_11A	0x00010000	/* 5 GHz, OFDM mode */
    246 #define	IFM_IEEE80211_11B	0x00020000	/* Direct Sequence mode */
    247 #define	IFM_IEEE80211_11G	0x00030000	/* 2 GHz, CCK mode */
    248 #define	IFM_IEEE80211_FH	0x00040000	/* 2 GHz, GFSK mode */
    249 #define	IFM_IEEE80211_11NA	0x00050000	/* 5Ghz, HT mode */
    250 #define	IFM_IEEE80211_11NG	0x00060000	/* 2Ghz, HT mode */
    251 
    252 
    253 /*
    254  * Common Address Redundancy Protocol
    255  */
    256 #define	IFM_CARP		0x000000c0
    257 
    258 /*
    259  * Shared media sub-types
    260  */
    261 #define	IFM_AUTO	0		/* Autoselect best media */
    262 #define	IFM_MANUAL	1		/* Jumper/dipswitch selects media */
    263 #define	IFM_NONE	2		/* Deselect all media */
    264 
    265 /*
    266  * Shared options
    267  */
    268 #define	IFM_FDX		0x00100000	/* Force full duplex */
    269 #define	IFM_HDX		0x00200000	/* Force half duplex */
    270 #define	IFM_FLOW	0x00400000	/* enable hardware flow control */
    271 #define	IFM_FLAG0	0x01000000	/* Driver defined flag */
    272 #define	IFM_FLAG1	0x02000000	/* Driver defined flag */
    273 #define	IFM_FLAG2	0x04000000	/* Driver defined flag */
    274 #define	IFM_LOOP	0x08000000	/* Put hardware in loopback */
    275 
    276 /*
    277  * Masks
    278  */
    279 #define	IFM_NMASK	0x000000e0	/* Network type */
    280 #define	IFM_TMASK	0x0000001f	/* Media sub-type */
    281 #define	IFM_IMASK	0xf0000000	/* Instance */
    282 #define	IFM_ISHIFT	28		/* Instance shift */
    283 #define	IFM_OMASK	0x0000ff00	/* Type specific options */
    284 #define	IFM_MMASK	0x00070000	/* Mode */
    285 #define	IFM_MSHIFT	16		/* Mode shift */
    286 #define	IFM_GMASK	0x0ff00000	/* Global options */
    287 
    288 	/* Ethernet flow control mask */
    289 #define	IFM_ETH_FMASK	(IFM_FLOW | IFM_ETH_RXPAUSE | IFM_ETH_TXPAUSE)
    290 
    291 #define	IFM_NMIN	IFM_ETHER	/* lowest Network type */
    292 #define	IFM_NMAX	IFM_NMASK	/* highest Network type */
    293 
    294 /*
    295  * Status bits
    296  */
    297 #define	IFM_AVALID	0x00000001	/* Active bit valid */
    298 #define	IFM_ACTIVE	0x00000002	/* Interface attached to working net */
    299 
    300 /* Mask of "status valid" bits, for ifconfig(8). */
    301 #define	IFM_STATUS_VALID IFM_AVALID
    302 
    303 /* List of "status valid" bits, for ifconfig(8). */
    304 #define	IFM_STATUS_VALID_LIST {						\
    305 	IFM_AVALID,							\
    306 	0,								\
    307 }
    308 
    309 /*
    310  * Macros to extract various bits of information from the media word.
    311  */
    312 #define	IFM_TYPE(x)	((x) & IFM_NMASK)
    313 #define	IFM_SUBTYPE(x)	((x) & IFM_TMASK)
    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 #define	IFM_INST_ANY	((u_int) -1)
    320 
    321 /*
    322  * Macro to create a media word.
    323  */
    324 #define	IFM_MAKEWORD(type, subtype, options, instance)			\
    325 	((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT))
    326 #define	IFM_MAKEMODE(mode) \
    327 	(((mode) << IFM_MSHIFT) & IFM_MMASK)
    328 
    329 /*
    330  * NetBSD extension not defined in the BSDI API.  This is used in various
    331  * places to get the canonical description for a given type/subtype.
    332  *
    333  * In the subtype and mediaopt descriptions, the valid TYPE bits are OR'd
    334  * in to indicate which TYPE the subtype/option corresponds to.  If no
    335  * TYPE is present, it is a shared media/mediaopt.
    336  *
    337  * Note that these are parsed case-insensitive.
    338  *
    339  * Order is important.  The first matching entry is the canonical name
    340  * for a media type; subsequent matches are aliases.
    341  */
    342 struct ifmedia_description {
    343 	int	ifmt_word;		/* word value; may be masked */
    344 	const char *ifmt_string;	/* description */
    345 };
    346 
    347 #define	IFM_TYPE_DESCRIPTIONS {						\
    348 	{ IFM_ETHER,			"Ethernet" },			\
    349 	{ IFM_ETHER,			"ether" },			\
    350 	{ IFM_TOKEN,			"TokenRing" },			\
    351 	{ IFM_TOKEN,			"token" },			\
    352 	{ IFM_FDDI,			"FDDI" },			\
    353 	{ IFM_IEEE80211,		"IEEE802.11" },			\
    354 	{ IFM_CARP,			"CARP" },			\
    355 	{ 0, NULL },							\
    356 }
    357 
    358 #define	IFM_TYPE_MATCH(dt, t)						\
    359 	(IFM_TYPE((dt)) == 0 || IFM_TYPE((dt)) == IFM_TYPE((t)))
    360 
    361 #define	IFM_SUBTYPE_DESCRIPTIONS {					\
    362 	{ IFM_AUTO,			"autoselect" },			\
    363 	{ IFM_AUTO,			"auto" },			\
    364 	{ IFM_MANUAL,			"manual" },			\
    365 	{ IFM_NONE,			"none" },			\
    366 									\
    367 	{ IFM_ETHER | IFM_10_T,		"10baseT" },			\
    368 	{ IFM_ETHER | IFM_10_T,		"10baseT/UTP" },		\
    369 	{ IFM_ETHER | IFM_10_T,		"UTP" },			\
    370 	{ IFM_ETHER | IFM_10_T,		"10UTP" },			\
    371 	{ IFM_ETHER | IFM_10_T,		"10BASE-T" },			\
    372 	{ IFM_ETHER | IFM_10_2,		"10base2" },			\
    373 	{ IFM_ETHER | IFM_10_2,		"10base2/BNC" },		\
    374 	{ IFM_ETHER | IFM_10_2,		"BNC" },			\
    375 	{ IFM_ETHER | IFM_10_2,		"10BNC" },			\
    376 	{ IFM_ETHER | IFM_10_2,		"10BASE2" },			\
    377 	{ IFM_ETHER | IFM_10_5,		"10base5" },			\
    378 	{ IFM_ETHER | IFM_10_5,		"10base5/AUI" },		\
    379 	{ IFM_ETHER | IFM_10_5,		"AUI" },			\
    380 	{ IFM_ETHER | IFM_10_5,		"10AUI" },			\
    381 	{ IFM_ETHER | IFM_10_5,		"10BASE5" },			\
    382 	{ IFM_ETHER | IFM_100_TX,	"100baseTX" },			\
    383 	{ IFM_ETHER | IFM_100_TX,	"100TX" },			\
    384 	{ IFM_ETHER | IFM_100_TX,	"100BASE-TX" },			\
    385 	{ IFM_ETHER | IFM_100_FX,	"100baseFX" },			\
    386 	{ IFM_ETHER | IFM_100_FX,	"100FX" },			\
    387 	{ IFM_ETHER | IFM_100_FX,	"100BASE-FX" },			\
    388 	{ IFM_ETHER | IFM_100_T4,	"100baseT4" },			\
    389 	{ IFM_ETHER | IFM_100_T4,	"100T4" },			\
    390 	{ IFM_ETHER | IFM_100_T4,	"100BASE-T4" },			\
    391 	{ IFM_ETHER | IFM_100_VG,	"100baseVG" },			\
    392 	{ IFM_ETHER | IFM_100_VG,	"100VG" },			\
    393 	{ IFM_ETHER | IFM_100_VG,	"100VG-AnyLAN" },		\
    394 	{ IFM_ETHER | IFM_100_T2,	"100baseT2" },			\
    395 	{ IFM_ETHER | IFM_100_T2,	"100T2" },			\
    396 	{ IFM_ETHER | IFM_100_T2,	"100BASE-T2" },			\
    397 	{ IFM_ETHER | IFM_1000_SX,	"1000baseSX" },			\
    398 	{ IFM_ETHER | IFM_1000_SX,	"1000SX" },			\
    399 	{ IFM_ETHER | IFM_1000_SX,	"1000BASE-SX" },		\
    400 	{ IFM_ETHER | IFM_10_STP,	"10baseSTP" },			\
    401 	{ IFM_ETHER | IFM_10_STP,	"STP" },			\
    402 	{ IFM_ETHER | IFM_10_STP,	"10STP" },			\
    403 	{ IFM_ETHER | IFM_10_STP,	"10BASE-STP" },			\
    404 	{ IFM_ETHER | IFM_10_FL,	"10baseFL" },			\
    405 	{ IFM_ETHER | IFM_10_FL,	"FL" },				\
    406 	{ IFM_ETHER | IFM_10_FL,	"10FL" },			\
    407 	{ IFM_ETHER | IFM_10_FL,	"10BASE-FL" },			\
    408 	{ IFM_ETHER | IFM_1000_LX,	"1000baseLX" },			\
    409 	{ IFM_ETHER | IFM_1000_LX,	"1000LX" },			\
    410 	{ IFM_ETHER | IFM_1000_LX,	"1000BASE-LX" },		\
    411 	{ IFM_ETHER | IFM_1000_CX,	"1000baseCX" },			\
    412 	{ IFM_ETHER | IFM_1000_CX,	"1000CX" },			\
    413 	{ IFM_ETHER | IFM_1000_CX,	"1000BASE-CX" },		\
    414 	{ IFM_ETHER | IFM_1000_BX10,	"1000BASE-BX10" },		\
    415 	{ IFM_ETHER | IFM_1000_T,	"1000baseT" },			\
    416 	{ IFM_ETHER | IFM_1000_T,	"1000T" },			\
    417 	{ IFM_ETHER | IFM_1000_T,	"1000BASE-T" },			\
    418 	{ IFM_ETHER | IFM_HPNA_1,	"HomePNA1" },			\
    419 	{ IFM_ETHER | IFM_HPNA_1,	"HPNA1" },			\
    420 	{ IFM_ETHER | IFM_10G_LR,	"10GbaseLR" },			\
    421 	{ IFM_ETHER | IFM_10G_LR,	"10GLR" },			\
    422 	{ IFM_ETHER | IFM_10G_LR,	"10GBASE-LR" },			\
    423 	{ IFM_ETHER | IFM_10G_SR,	"10GbaseSR" },			\
    424 	{ IFM_ETHER | IFM_10G_SR,	"10GSR" },			\
    425 	{ IFM_ETHER | IFM_10G_SR,	"10GBASE-SR" },			\
    426 	{ IFM_ETHER | IFM_10G_CX4,	"10GbaseCX4" },			\
    427 	{ IFM_ETHER | IFM_10G_CX4,	"10GCX4" },			\
    428 	{ IFM_ETHER | IFM_10G_CX4,	"10GBASE-CX4" },		\
    429 	{ IFM_ETHER | IFM_2500_SX,	"2500baseSX" },			\
    430 	{ IFM_ETHER | IFM_2500_SX,	"2500SX" },			\
    431 									\
    432 	{ IFM_TOKEN | IFM_TOK_STP4,	"DB9/4Mbit" },			\
    433 	{ IFM_TOKEN | IFM_TOK_STP4,	"4STP" },			\
    434 	{ IFM_TOKEN | IFM_TOK_STP16,	"DB9/16Mbit" },			\
    435 	{ IFM_TOKEN | IFM_TOK_STP16,	"16STP" },			\
    436 	{ IFM_TOKEN | IFM_TOK_UTP4,	"UTP/4Mbit" },			\
    437 	{ IFM_TOKEN | IFM_TOK_UTP4,	"4UTP" },			\
    438 	{ IFM_TOKEN | IFM_TOK_UTP16,	"UTP/16Mbit" },			\
    439 	{ IFM_TOKEN | IFM_TOK_UTP16,	"16UTP" },			\
    440 									\
    441 	{ IFM_FDDI | IFM_FDDI_SMF,	"Single-mode" },		\
    442 	{ IFM_FDDI | IFM_FDDI_SMF,	"SMF" },			\
    443 	{ IFM_FDDI | IFM_FDDI_MMF,	"Multi-mode" },			\
    444 	{ IFM_FDDI | IFM_FDDI_MMF,	"MMF" },			\
    445 	{ IFM_FDDI | IFM_FDDI_UTP,	"UTP" },			\
    446 	{ IFM_FDDI | IFM_FDDI_UTP,	"CDDI" },			\
    447 									\
    448 	/*								\
    449 	 * Short-hand for common media+option combos.			\
    450 	 */								\
    451 	{ IFM_ETHER | IFM_10_T | IFM_FDX,	"10baseT-FDX" },	\
    452 	{ IFM_ETHER | IFM_10_T | IFM_FDX,	"10BASE-T-FDX" },	\
    453 	{ IFM_ETHER | IFM_100_TX | IFM_FDX,	"100baseTX-FDX" },	\
    454 	{ IFM_ETHER | IFM_100_TX | IFM_FDX,	"100BASE-TX-FDX" },	\
    455 									\
    456 	/*								\
    457 	 * IEEE 802.11							\
    458 	 */								\
    459 	{ IFM_IEEE80211 | IFM_IEEE80211_FH1,	"FH1" },		\
    460 	{ IFM_IEEE80211 | IFM_IEEE80211_FH2,	"FH2" },		\
    461 	{ IFM_IEEE80211 | IFM_IEEE80211_DS1,	"DS1" },		\
    462 	{ IFM_IEEE80211 | IFM_IEEE80211_DS2,	"DS2" },		\
    463 	{ IFM_IEEE80211 | IFM_IEEE80211_DS5,	"DS5" },		\
    464 	{ IFM_IEEE80211 | IFM_IEEE80211_DS11,	"DS11" },		\
    465 	{ IFM_IEEE80211 | IFM_IEEE80211_DS22,	"DS22" },		\
    466 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM6,	"OFDM6" },		\
    467 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM9,	"OFDM9" },		\
    468 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM12,	"OFDM12" },		\
    469 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM18,	"OFDM18" },		\
    470 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM24,	"OFDM24" },		\
    471 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM36,	"OFDM36" },		\
    472 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM48,	"OFDM48" },		\
    473 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM54,	"OFDM54" },		\
    474 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM72,	"OFDM72" },		\
    475 	{ IFM_IEEE80211 | IFM_IEEE80211_DS354k, "DS/354Kbps" },         \
    476 	{ IFM_IEEE80211 | IFM_IEEE80211_DS512k, "DS/512Kbps" },         \
    477 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM3,  "OFDM/3Mbps" },         \
    478 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM4,  "OFDM/4.5Mbps" },       \
    479 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM27, "OFDM/27Mbps" },        \
    480 									\
    481 	{ 0, NULL },							\
    482 }
    483 
    484 #define IFM_MODE_DESCRIPTIONS {						\
    485 	{ IFM_AUTO,				"autoselect" },		\
    486 	{ IFM_AUTO,				"auto" },		\
    487 	{ IFM_IEEE80211 | IFM_IEEE80211_11A,	"11a" },		\
    488 	{ IFM_IEEE80211 | IFM_IEEE80211_11B,	"11b" },		\
    489 	{ IFM_IEEE80211 | IFM_IEEE80211_11G,	"11g" },		\
    490 	{ IFM_IEEE80211 | IFM_IEEE80211_FH,	"fh" },			\
    491 	{ IFM_IEEE80211 | IFM_IEEE80211_11NA,	"11na" },		\
    492 	{ IFM_IEEE80211 | IFM_IEEE80211_11NG,	"11ng" },		\
    493 	{ 0, NULL },							\
    494 }
    495 
    496 #define	IFM_OPTION_DESCRIPTIONS {					\
    497 	{ IFM_FDX,			"full-duplex" },		\
    498 	{ IFM_FDX,			"fdx" },			\
    499 	{ IFM_HDX,			"half-duplex" },		\
    500 	{ IFM_HDX,			"hdx" },			\
    501 	{ IFM_FLOW,			"flowcontrol" },		\
    502 	{ IFM_FLOW,			"flow" },			\
    503 	{ IFM_FLAG0,			"flag0" },			\
    504 	{ IFM_FLAG1,			"flag1" },			\
    505 	{ IFM_FLAG2,			"flag2" },			\
    506 	{ IFM_LOOP,			"loopback" },			\
    507 	{ IFM_LOOP,			"hw-loopback"},			\
    508 	{ IFM_LOOP,			"loop" },			\
    509 									\
    510 	{ IFM_ETHER | IFM_ETH_MASTER,	"master" },			\
    511 	{ IFM_ETHER | IFM_ETH_RXPAUSE,	"rxpause" },			\
    512 	{ IFM_ETHER | IFM_ETH_TXPAUSE,	"txpause" },			\
    513 									\
    514 	{ IFM_TOKEN | IFM_TOK_ETR,	"EarlyTokenRelease" },		\
    515 	{ IFM_TOKEN | IFM_TOK_ETR,	"ETR" },			\
    516 	{ IFM_TOKEN | IFM_TOK_SRCRT,	"SourceRouting" },		\
    517 	{ IFM_TOKEN | IFM_TOK_SRCRT,	"SRCRT" },			\
    518 	{ IFM_TOKEN | IFM_TOK_ALLR,	"AllRoutes" },			\
    519 	{ IFM_TOKEN | IFM_TOK_ALLR,	"ALLR" },			\
    520 									\
    521 	{ IFM_FDDI | IFM_FDDI_DA,	"dual-attach" },		\
    522 	{ IFM_FDDI | IFM_FDDI_DA,	"das" },			\
    523 									\
    524 	{ IFM_IEEE80211 | IFM_IEEE80211_ADHOC,	"adhoc" },		\
    525 	{ IFM_IEEE80211 | IFM_IEEE80211_HOSTAP,	"hostap" },		\
    526 	{ IFM_IEEE80211 | IFM_IEEE80211_MONITOR,"monitor" },		\
    527 	{ IFM_IEEE80211 | IFM_IEEE80211_TURBO,	"turbo" },		\
    528 	{ IFM_IEEE80211 | IFM_IEEE80211_IBSS,	"ibss" },		\
    529 	{ IFM_IEEE80211 | IFM_IEEE80211_WDS, 	"wds" },		\
    530 									\
    531 	{ 0, NULL },							\
    532 }
    533 
    534 /*
    535  * Baudrate descriptions for the various media types.
    536  */
    537 struct ifmedia_baudrate {
    538 	int	ifmb_word;		/* media word */
    539 	u_quad_t	ifmb_baudrate;		/* corresponding baudrate */
    540 };
    541 
    542 #define	IFM_BAUDRATE_DESCRIPTIONS {					\
    543 	{ IFM_ETHER | IFM_10_T,		IF_Mbps(10) },			\
    544 	{ IFM_ETHER | IFM_10_2,		IF_Mbps(10) },			\
    545 	{ IFM_ETHER | IFM_10_5,		IF_Mbps(10) },			\
    546 	{ IFM_ETHER | IFM_100_TX,	IF_Mbps(100) },			\
    547 	{ IFM_ETHER | IFM_100_FX,	IF_Mbps(100) },			\
    548 	{ IFM_ETHER | IFM_100_T4,	IF_Mbps(100) },			\
    549 	{ IFM_ETHER | IFM_100_VG,	IF_Mbps(100) },			\
    550 	{ IFM_ETHER | IFM_100_T2,	IF_Mbps(100) },			\
    551 	{ IFM_ETHER | IFM_1000_SX,	IF_Mbps(1000) },		\
    552 	{ IFM_ETHER | IFM_10_STP,	IF_Mbps(10) },			\
    553 	{ IFM_ETHER | IFM_10_FL,	IF_Mbps(10) },			\
    554 	{ IFM_ETHER | IFM_1000_LX,	IF_Mbps(1000) },		\
    555 	{ IFM_ETHER | IFM_1000_CX,	IF_Mbps(1000) },		\
    556 	{ IFM_ETHER | IFM_1000_T,	IF_Mbps(1000) },		\
    557 	{ IFM_ETHER | IFM_HPNA_1,	IF_Mbps(1) },			\
    558 	{ IFM_ETHER | IFM_10G_LR,	IF_Gbps(10ULL) },		\
    559 	{ IFM_ETHER | IFM_10G_SR,	IF_Gbps(10ULL) },		\
    560 	{ IFM_ETHER | IFM_10G_CX4,	IF_Gbps(10ULL) },		\
    561 	{ IFM_ETHER | IFM_2500_SX,	IF_Mbps(2500ULL) },		\
    562 									\
    563 	{ IFM_TOKEN | IFM_TOK_STP4,	IF_Mbps(4) },			\
    564 	{ IFM_TOKEN | IFM_TOK_STP16,	IF_Mbps(16) },			\
    565 	{ IFM_TOKEN | IFM_TOK_UTP4,	IF_Mbps(4) },			\
    566 	{ IFM_TOKEN | IFM_TOK_UTP16,	IF_Mbps(16) },			\
    567 									\
    568 	{ IFM_FDDI | IFM_FDDI_SMF,	IF_Mbps(100) },			\
    569 	{ IFM_FDDI | IFM_FDDI_MMF,	IF_Mbps(100) },			\
    570 	{ IFM_FDDI | IFM_FDDI_UTP,	IF_Mbps(100) },			\
    571 									\
    572 	{ IFM_IEEE80211 | IFM_IEEE80211_FH1,	IF_Mbps(1) },		\
    573 	{ IFM_IEEE80211 | IFM_IEEE80211_FH2,	IF_Mbps(2) },		\
    574 	{ IFM_IEEE80211 | IFM_IEEE80211_DS2,	IF_Mbps(2) },		\
    575 	{ IFM_IEEE80211 | IFM_IEEE80211_DS5,	IF_Kbps(5500) },	\
    576 	{ IFM_IEEE80211 | IFM_IEEE80211_DS11,	IF_Mbps(11) },		\
    577 	{ IFM_IEEE80211 | IFM_IEEE80211_DS1,	IF_Mbps(1) },		\
    578 	{ IFM_IEEE80211 | IFM_IEEE80211_DS22,	IF_Mbps(22) },		\
    579 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM6,	IF_Mbps(6) },		\
    580 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM9,	IF_Mbps(9) },		\
    581 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM12,	IF_Mbps(12) },		\
    582 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM18,	IF_Mbps(18) },		\
    583 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM24,	IF_Mbps(24) },		\
    584 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM36,	IF_Mbps(36) },		\
    585 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM48,	IF_Mbps(48) },		\
    586 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM54,	IF_Mbps(54) },		\
    587 	{ IFM_IEEE80211 | IFM_IEEE80211_OFDM72,	IF_Mbps(72) },		\
    588 									\
    589 	{ 0, 0 },							\
    590 }
    591 
    592 /*
    593  * Status bit descriptions for the various media types.
    594  */
    595 struct ifmedia_status_description {
    596 	int	ifms_type;
    597 	int	ifms_valid;
    598 	int	ifms_bit;
    599 	const char *ifms_string[2];
    600 };
    601 
    602 #define	IFM_STATUS_DESC(ifms, bit)					\
    603 	(ifms)->ifms_string[((ifms)->ifms_bit & (bit)) ? 1 : 0]
    604 
    605 #define	IFM_STATUS_DESCRIPTIONS {					\
    606 	{ IFM_ETHER,		IFM_AVALID,	IFM_ACTIVE,		\
    607 	  { "no carrier", "active" } },					\
    608 									\
    609 	{ IFM_FDDI,		IFM_AVALID,	IFM_ACTIVE,		\
    610 	  { "no ring", "inserted" } },					\
    611 									\
    612 	{ IFM_TOKEN,		IFM_AVALID,	IFM_ACTIVE,		\
    613 	  { "no ring", "inserted" } },					\
    614 									\
    615 	{ IFM_IEEE80211,	IFM_AVALID,	IFM_ACTIVE,		\
    616 	  { "no network", "active" } },					\
    617 									\
    618 	{ IFM_CARP,		IFM_AVALID,	IFM_ACTIVE,		\
    619 	    { "backup", "master" } },					\
    620 									\
    621 	{ 0,			0,		0,			\
    622 	  { NULL, NULL } },						\
    623 }
    624 
    625 #ifndef _KERNEL
    626 /* Functions for converting media to/from strings, in libutil/if_media.c */
    627 const char *get_media_type_string(int);
    628 const char *get_media_subtype_string(int);
    629 const char *get_media_mode_string(int);
    630 const char *get_media_option_string(int *);
    631 int get_media_mode(int, const char *);
    632 int get_media_subtype(int, const char *);
    633 int get_media_options(int, const char *, char **);
    634 int lookup_media_word(struct ifmedia_description *, int, const char *);
    635 #endif /* _KERNEL */
    636 
    637 #endif /* !_NET_IF_MEDIA_H_ */
    638