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