Merge from vendor branch LIBSTDC++:
[dragonfly.git] / sys / net / if_media.h
1 /*      $NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $     */
2 /* $FreeBSD: src/sys/net/if_media.h,v 1.9.2.4 2002/07/30 06:22:40 imp Exp $ */
3 /* $DragonFly: src/sys/net/if_media.h,v 1.2 2003/06/17 04:28:48 dillon Exp $ */
4
5 /*
6  * Copyright (c) 1997
7  *      Jonathan Stone and Jason R. Thorpe.  All rights reserved.
8  *
9  * This software is derived from information provided by Matt Thomas.
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  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *      This product includes software developed by Jonathan Stone
22  *      and Jason R. Thorpe for the NetBSD Project.
23  * 4. The names of the authors may not be used to endorse or promote products
24  *    derived from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
27  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
33  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
34  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  */
38
39 #ifndef _NET_IF_MEDIA_H_
40 #define _NET_IF_MEDIA_H_
41
42 /*
43  * Prototypes and definitions for BSD/OS-compatible network interface
44  * media selection.
45  *
46  * Where it is safe to do so, this code strays slightly from the BSD/OS
47  * design.  Software which uses the API (device drivers, basically)
48  * shouldn't notice any difference.
49  *
50  * Many thanks to Matt Thomas for providing the information necessary
51  * to implement this interface.
52  */
53
54 #ifdef _KERNEL
55
56 #include <sys/queue.h>
57
58 /*
59  * Driver callbacks for media status and change requests.
60  */
61 typedef int (*ifm_change_cb_t)(struct ifnet *ifp);
62 typedef void (*ifm_stat_cb_t)(struct ifnet *ifp, struct ifmediareq *req);
63
64 /*
65  * In-kernel representation of a single supported media type.
66  */
67 struct ifmedia_entry {
68         LIST_ENTRY(ifmedia_entry) ifm_list;
69         int     ifm_media;      /* description of this media attachment */
70         int     ifm_data;       /* for driver-specific use */
71         void    *ifm_aux;       /* for driver-specific use */
72 };
73
74 /*
75  * One of these goes into a network interface's softc structure.
76  * It is used to keep general media state.
77  */
78 struct ifmedia {
79         int     ifm_mask;       /* mask of changes we don't care about */
80         int     ifm_media;      /* current user-set media word */
81         struct ifmedia_entry *ifm_cur;  /* currently selected media */
82         LIST_HEAD(, ifmedia_entry) ifm_list; /* list of all supported media */
83         ifm_change_cb_t ifm_change;     /* media change driver callback */
84         ifm_stat_cb_t   ifm_status;     /* media status driver callback */
85 };
86
87 /* Initialize an interface's struct if_media field. */
88 void    ifmedia_init(struct ifmedia *ifm, int dontcare_mask,
89             ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback);
90
91 /* Remove all mediums from a struct ifmedia.  */
92 void    ifmedia_removeall( struct ifmedia *ifm);
93
94 /* Add one supported medium to a struct ifmedia. */
95 void    ifmedia_add(struct ifmedia *ifm, int mword, int data, void *aux);
96
97 /* Add an array (of ifmedia_entry) media to a struct ifmedia. */
98 void    ifmedia_list_add(struct ifmedia *mp, struct ifmedia_entry *lp,
99             int count);
100
101 /* Set default media type on initialization. */
102 void    ifmedia_set(struct ifmedia *ifm, int mword);
103
104 /* Common ioctl function for getting/setting media, called by driver. */
105 int     ifmedia_ioctl(struct ifnet *ifp, struct ifreq *ifr,
106             struct ifmedia *ifm, u_long cmd);
107
108 #endif /*_KERNEL */
109
110 /*
111  * if_media Options word:
112  *      Bits    Use
113  *      ----    -------
114  *      0-4     Media variant
115  *      5-7     Media type
116  *      8-15    Type specific options
117  *      16-19   RFU
118  *      20-27   Shared (global) options
119  *      28-31   Instance
120  */
121
122 /*
123  * Ethernet
124  */
125 #define IFM_ETHER       0x00000020
126 #define IFM_10_T        3               /* 10BaseT - RJ45 */
127 #define IFM_10_2        4               /* 10Base2 - Thinnet */
128 #define IFM_10_5        5               /* 10Base5 - AUI */
129 #define IFM_100_TX      6               /* 100BaseTX - RJ45 */
130 #define IFM_100_FX      7               /* 100BaseFX - Fiber */
131 #define IFM_100_T4      8               /* 100BaseT4 - 4 pair cat 3 */
132 #define IFM_100_VG      9               /* 100VG-AnyLAN */
133 #define IFM_100_T2      10              /* 100BaseT2 */
134 #define IFM_1000_FX     11              /* 1000BaseFX - gigabit over fiber */
135 #define IFM_10_STP      12              /* 10BaseT over shielded TP */
136 #define IFM_10_FL       13              /* 10baseFL - Fiber */
137 #define IFM_1000_SX     14              /* 1000BaseSX Multi-mode Fiber */
138 #define IFM_1000_LX     15              /* 1000BaseLX Single-mode Fiber */
139 #define IFM_1000_CX     16              /* 1000BaseCX 150ohm STP */
140 #define IFM_1000_TX     17              /* 1000BaseTX 4 pair cat 5 */
141 #define IFM_homePNA     18              /* HomePNA media for ethernet frames */
142 /* note 31 is the max! */
143
144 /*
145  * Token ring
146  */
147 #define IFM_TOKEN       0x00000040
148 #define IFM_TOK_STP4    3               /* Shielded twisted pair 4m - DB9 */
149 #define IFM_TOK_STP16   4               /* Shielded twisted pair 16m - DB9 */
150 #define IFM_TOK_UTP4    5               /* Unshielded twisted pair 4m - RJ45 */
151 #define IFM_TOK_UTP16   6               /* Unshielded twisted pair 16m - RJ45 */
152 #define IFM_TOK_STP100  7               /* Shielded twisted pair 100m - DB9 */
153 #define IFM_TOK_UTP100  8               /* Unshielded twisted pair 100m - RJ45 */
154 #define IFM_TOK_ETR     0x00000200      /* Early token release */
155 #define IFM_TOK_SRCRT   0x00000400      /* Enable source routing features */
156 #define IFM_TOK_ALLR    0x00000800      /* All routes / Single route bcast */
157 #define IFM_TOK_DTR     0x00002000      /* Dedicated token ring */
158 #define IFM_TOK_CLASSIC 0x00004000      /* Classic token ring */
159 #define IFM_TOK_AUTO    0x00008000      /* Automatic Dedicate/Classic token ring */
160
161 /*
162  * FDDI
163  */
164 #define IFM_FDDI        0x00000060
165 #define IFM_FDDI_SMF    3               /* Single-mode fiber */
166 #define IFM_FDDI_MMF    4               /* Multi-mode fiber */
167 #define IFM_FDDI_UTP    5               /* CDDI / UTP */
168 #define IFM_FDDI_DA     0x00000100      /* Dual attach / single attach */
169
170 /*
171  * IEEE 802.11 Wireless
172  */
173 #define IFM_IEEE80211   0x00000080
174 #define IFM_IEEE80211_FH1       3       /* Frequency Hopping 1Mbps */
175 #define IFM_IEEE80211_FH2       4       /* Frequency Hopping 2Mbps */
176 #define IFM_IEEE80211_DS1       5       /* Direct Sequence 1Mbps */
177 #define IFM_IEEE80211_DS2       6       /* Direct Sequence 2Mbps */
178 #define IFM_IEEE80211_DS5       7       /* Direct Sequence 5.5Mbps */
179 #define IFM_IEEE80211_DS11      8       /* Direct Sequence 11Mbps */
180 #define IFM_IEEE80211_DS22      9       /* Direct Sequence 22Mbps */
181 #define IFM_IEEE80211_ODFM6     10      /* ODFM 6Mbps */
182 #define IFM_IEEE80211_ODFM9     11      /* ODFM 9Mbps */
183 #define IFM_IEEE80211_ODFM12    12      /* ODFM 12Mbps */
184 #define IFM_IEEE80211_ODFM18    13      /* ODFM 18Mbps */
185 #define IFM_IEEE80211_ODFM24    14      /* ODFM 24Mbps */
186 #define IFM_IEEE80211_ODFM36    15      /* ODFM 36Mbps */
187 #define IFM_IEEE80211_ODFM48    16      /* ODFM 48Mbps */
188 #define IFM_IEEE80211_ODFM54    17      /* ODFM 54Mbps */
189 #define IFM_IEEE80211_ODFM72    18      /* ODFM 72Mbps */
190 #define IFM_IEEE80211_ADHOC     0x00000100      /* Operate in Adhoc mode */
191 #define IFM_IEEE80211_HOSTAP    0x00000200      /* Operate in Host AP mode */
192 #define IFM_IEEE80211_IBSS      0x00000400      /* Operate in IBSS mode */
193 #define IFM_IEEE80211_IBSSMASTER 0x00000800     /* Operate as an IBSS master */
194
195 /*
196  * Shared media sub-types
197  */
198 #define IFM_AUTO        0               /* Autoselect best media */
199 #define IFM_MANUAL      1               /* Jumper/dipswitch selects media */
200 #define IFM_NONE        2               /* Deselect all media */
201
202 /*
203  * Shared options
204  */
205 #define IFM_FDX         0x00100000      /* Force full duplex */
206 #define IFM_HDX         0x00200000      /* Force half duplex */
207 #define IFM_FLAG0       0x01000000      /* Driver defined flag */
208 #define IFM_FLAG1       0x02000000      /* Driver defined flag */
209 #define IFM_FLAG2       0x04000000      /* Driver defined flag */
210 #define IFM_LOOP        0x08000000      /* Put hardware in loopback */
211
212 /*
213  * Masks
214  */
215 #define IFM_NMASK       0x000000e0      /* Network type */
216 #define IFM_TMASK       0x0000001f      /* Media sub-type */
217 #define IFM_IMASK       0xf0000000      /* Instance */
218 #define IFM_ISHIFT      28              /* Instance shift */
219 #define IFM_OMASK       0x0000ff00      /* Type specific options */
220 #define IFM_GMASK       0x0ff00000      /* Global options */
221
222 /*
223  * Status bits
224  */
225 #define IFM_AVALID      0x00000001      /* Active bit valid */
226 #define IFM_ACTIVE      0x00000002      /* Interface attached to working net */
227
228 /*
229  * Macros to extract various bits of information from the media word.
230  */
231 #define IFM_TYPE(x)         ((x) & IFM_NMASK)
232 #define IFM_SUBTYPE(x)      ((x) & IFM_TMASK)
233 #define IFM_TYPE_OPTIONS(x) ((x) & IFM_OMASK)
234 #define IFM_INST(x)         (((x) & IFM_IMASK) >> IFM_ISHIFT)
235 #define IFM_OPTIONS(x)  ((x) & (IFM_OMASK|IFM_GMASK))
236
237 #define IFM_INST_MAX    IFM_INST(IFM_IMASK)
238
239 /*
240  * Macro to create a media word.
241  */
242 #define IFM_MAKEWORD(type, subtype, options, instance)                  \
243         ((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT))
244
245 /*
246  * NetBSD extension not defined in the BSDI API.  This is used in various
247  * places to get the canonical description for a given type/subtype.
248  *
249  * NOTE: all but the top-level type descriptions must contain NO whitespace!
250  * Otherwise, parsing these in ifconfig(8) would be a nightmare.
251  */
252 struct ifmedia_description {
253         int     ifmt_word;              /* word value; may be masked */
254         const char *ifmt_string;        /* description */
255 };
256
257 #define IFM_TYPE_DESCRIPTIONS {                                         \
258         { IFM_ETHER,            "Ethernet" },                           \
259         { IFM_TOKEN,            "Token ring" },                         \
260         { IFM_FDDI,             "FDDI" },                               \
261         { IFM_IEEE80211,        "IEEE 802.11 Wireless Ethernet" },      \
262         { 0, NULL },                                                    \
263 }
264
265 #define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS {                             \
266         { IFM_10_T,     "10baseT/UTP" },                                \
267         { IFM_10_2,     "10base2/BNC" },                                \
268         { IFM_10_5,     "10base5/AUI" },                                \
269         { IFM_100_TX,   "100baseTX" },                                  \
270         { IFM_100_FX,   "100baseFX" },                                  \
271         { IFM_100_T4,   "100baseT4" },                                  \
272         { IFM_100_VG,   "100baseVG" },                                  \
273         { IFM_100_T2,   "100baseT2" },                                  \
274         { IFM_1000_FX,  "1000baseFX" },                                 \
275         { IFM_10_STP,   "10baseSTP" },                                  \
276         { IFM_10_FL,    "10baseFL" },                                   \
277         { IFM_1000_SX,  "1000baseSX" },                                 \
278         { IFM_1000_LX,  "1000baseLX" },                                 \
279         { IFM_1000_CX,  "1000baseCX" },                                 \
280         { IFM_1000_TX,  "1000baseTX" },                                 \
281         { IFM_homePNA,  "homePNA" },                                    \
282         { 0, NULL },                                                    \
283 }
284
285 #define IFM_SUBTYPE_ETHERNET_ALIASES {                                  \
286         { IFM_10_T,     "UTP" },                                        \
287         { IFM_10_T,     "10UTP" },                                      \
288         { IFM_10_2,     "BNC" },                                        \
289         { IFM_10_2,     "10BNC" },                                      \
290         { IFM_10_5,     "AUI" },                                        \
291         { IFM_10_5,     "10AUI" },                                      \
292         { IFM_100_TX,   "100TX" },                                      \
293         { IFM_100_FX,   "100FX" },                                      \
294         { IFM_100_T4,   "100T4" },                                      \
295         { IFM_100_VG,   "100VG" },                                      \
296         { IFM_100_T2,   "100T2" },                                      \
297         { IFM_1000_FX,  "1000FX" },                                     \
298         { IFM_10_STP,   "10STP" },                                      \
299         { IFM_10_FL,    "10FL" },                                       \
300         { IFM_1000_FX,  "1000SX" },                                     \
301         { IFM_1000_FX,  "1000LX" },                                     \
302         { IFM_1000_FX,  "1000CX" },                                     \
303         { IFM_1000_FX,  "1000TX" },                                     \
304         { 0, NULL },                                                    \
305 }
306
307 #define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS {                      \
308         { 0, NULL },                                                    \
309 }
310
311 #define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS {                            \
312         { IFM_TOK_STP4, "DB9/4Mbit" },                                  \
313         { IFM_TOK_STP16, "DB9/16Mbit" },                                \
314         { IFM_TOK_UTP4, "UTP/4Mbit" },                                  \
315         { IFM_TOK_UTP16, "UTP/16Mbit" },                                \
316         { IFM_TOK_STP100, "STP/100Mbit" },                              \
317         { IFM_TOK_UTP100, "UTP/100Mbit" },                              \
318         { 0, NULL },                                                    \
319 }
320
321 #define IFM_SUBTYPE_TOKENRING_ALIASES {                                 \
322         { IFM_TOK_STP4, "4STP" },                                       \
323         { IFM_TOK_STP16, "16STP" },                                     \
324         { IFM_TOK_UTP4, "4UTP" },                                       \
325         { IFM_TOK_UTP16, "16UTP" },                                     \
326         { IFM_TOK_STP100, "100STP" },                                   \
327         { IFM_TOK_UTP100, "100UTP" },                                   \
328         { 0, NULL },                                                    \
329 }
330
331 #define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS {                     \
332         { IFM_TOK_ETR,  "EarlyTokenRelease" },                          \
333         { IFM_TOK_SRCRT, "SourceRouting" },                             \
334         { IFM_TOK_ALLR, "AllRoutes" },                                  \
335         { IFM_TOK_DTR,  "Dedicated" },                                  \
336         { IFM_TOK_CLASSIC,"Classic" },                                  \
337         { IFM_TOK_AUTO, " " },                                          \
338         { 0, NULL },                                                    \
339 }
340
341 #define IFM_SUBTYPE_FDDI_DESCRIPTIONS {                                 \
342         { IFM_FDDI_SMF, "Single-mode" },                                \
343         { IFM_FDDI_MMF, "Multi-mode" },                                 \
344         { IFM_FDDI_UTP, "UTP" },                                        \
345         { 0, NULL },                                                    \
346 }
347
348 #define IFM_SUBTYPE_FDDI_ALIASES {                                      \
349         { IFM_FDDI_SMF, "SMF" },                                        \
350         { IFM_FDDI_MMF, "MMF" },                                        \
351         { IFM_FDDI_UTP, "CDDI" },                                       \
352         { 0, NULL },                                                    \
353 }
354
355 #define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS {                          \
356         { IFM_FDDI_DA, "Dual-attach" },                                 \
357         { 0, NULL },                                                    \
358 }
359
360 #define IFM_SUBTYPE_IEEE80211_DESCRIPTIONS {                            \
361         { IFM_IEEE80211_FH1, "FH/1Mbps" },                              \
362         { IFM_IEEE80211_FH2, "FH/2Mbps" },                              \
363         { IFM_IEEE80211_DS1, "DS/1Mbps" },                              \
364         { IFM_IEEE80211_DS2, "DS/2Mbps" },                              \
365         { IFM_IEEE80211_DS5, "DS/5.5Mbps" },                            \
366         { IFM_IEEE80211_DS11, "DS/11Mbps" },                            \
367         { IFM_IEEE80211_DS22, "DS/22Mbps" },                            \
368         { IFM_IEEE80211_ODFM6, "ODFM/6Mbps" },                          \
369         { IFM_IEEE80211_ODFM9, "ODFM/9Mbps" },                          \
370         { IFM_IEEE80211_ODFM12, "ODFM/12Mbps" },                        \
371         { IFM_IEEE80211_ODFM18, "ODFM/18Mbps" },                        \
372         { IFM_IEEE80211_ODFM24, "ODFM/24Mbps" },                        \
373         { IFM_IEEE80211_ODFM36, "ODFM/36Mbps" },                        \
374         { IFM_IEEE80211_ODFM48, "ODFM/48Mbps" },                        \
375         { IFM_IEEE80211_ODFM54, "ODFM/54Mbps" },                        \
376         { IFM_IEEE80211_ODFM72, "ODFM/72Mbps" },                        \
377         { 0, NULL },                                                    \
378 }
379
380 #define IFM_SUBTYPE_IEEE80211_ALIASES {                                 \
381         { IFM_IEEE80211_FH1, "FH1" },                                   \
382         { IFM_IEEE80211_FH2, "FH2" },                                   \
383         { IFM_IEEE80211_FH1, "FrequencyHopping/1Mbps" },                \
384         { IFM_IEEE80211_FH2, "FrequencyHopping/2Mbps" },                \
385         { IFM_IEEE80211_DS1, "DS1" },                                   \
386         { IFM_IEEE80211_DS2, "DS2" },                                   \
387         { IFM_IEEE80211_DS5, "DS5.5" },                                 \
388         { IFM_IEEE80211_DS11, "DS11" },                                 \
389         { IFM_IEEE80211_DS22, "DS22" },                                 \
390         { IFM_IEEE80211_DS1, "DirectSequence/1Mbps" },                  \
391         { IFM_IEEE80211_DS2, "DirectSequence/2Mbps" },                  \
392         { IFM_IEEE80211_DS5, "DirectSequence/5.5Mbps" },                \
393         { IFM_IEEE80211_DS11, "DirectSequence/11Mbps" },                \
394         { IFM_IEEE80211_DS22, "DirectSequence/22Mbps" },                \
395         { IFM_IEEE80211_ODFM6, "ODFM6" },                               \
396         { IFM_IEEE80211_ODFM9, "ODFM9" },                               \
397         { IFM_IEEE80211_ODFM12, "ODFM12" },                             \
398         { IFM_IEEE80211_ODFM18, "ODFM18" },                             \
399         { IFM_IEEE80211_ODFM24, "ODFM24" },                             \
400         { IFM_IEEE80211_ODFM36, "ODFM36" },                             \
401         { IFM_IEEE80211_ODFM48, "ODFM48" },                             \
402         { IFM_IEEE80211_ODFM54, "ODFM54" },                             \
403         { IFM_IEEE80211_ODFM72, "ODFM72" },                             \
404         { 0, NULL },                                                    \
405 }
406
407 #define IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS {                     \
408         { IFM_IEEE80211_ADHOC, "adhoc" },                               \
409         { IFM_IEEE80211_HOSTAP, "hostap" },                             \
410         { IFM_IEEE80211_IBSS, "ibss" },                                 \
411         { IFM_IEEE80211_IBSSMASTER, "ibss-master" },                    \
412         { 0, NULL },                                                    \
413 }
414
415 #define IFM_SUBTYPE_SHARED_DESCRIPTIONS {                               \
416         { IFM_AUTO,     "autoselect" },                                 \
417         { IFM_MANUAL,   "manual" },                                     \
418         { IFM_NONE,     "none" },                                       \
419         { 0, NULL },                                                    \
420 }
421
422 #define IFM_SUBTYPE_SHARED_ALIASES {                                    \
423         { IFM_AUTO,     "auto" },                                       \
424         { 0, NULL },                                                    \
425 }
426
427 #define IFM_SHARED_OPTION_DESCRIPTIONS {                                \
428         { IFM_FDX,      "full-duplex" },                                \
429         { IFM_HDX,      "half-duplex" },                                \
430         { IFM_FLAG0,    "flag0" },                                      \
431         { IFM_FLAG1,    "flag1" },                                      \
432         { IFM_FLAG2,    "flag2" },                                      \
433         { IFM_LOOP,     "hw-loopback" },                                \
434         { 0, NULL },                                                    \
435 }
436
437 #endif  /* _NET_IF_MEDIA_H_ */