if_media.h revision 1.21
1 /* $NetBSD: if_media.h,v 1.21 2000/02/16 18:03:14 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 2000 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 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 /* 41 * Copyright (c) 1997 42 * Jonathan Stone and Jason R. Thorpe. All rights reserved. 43 * 44 * This software is derived from information provided by Matt Thomas. 45 * 46 * Redistribution and use in source and binary forms, with or without 47 * modification, are permitted provided that the following conditions 48 * are met: 49 * 1. Redistributions of source code must retain the above copyright 50 * notice, this list of conditions and the following disclaimer. 51 * 2. Redistributions in binary form must reproduce the above copyright 52 * notice, this list of conditions and the following disclaimer in the 53 * documentation and/or other materials provided with the distribution. 54 * 3. All advertising materials mentioning features or use of this software 55 * must display the following acknowledgement: 56 * This product includes software developed by Jonathan Stone 57 * and Jason R. Thorpe for the NetBSD Project. 58 * 4. The names of the authors may not be used to endorse or promote products 59 * derived from this software without specific prior written permission. 60 * 61 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 62 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 63 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 64 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 65 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 66 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 67 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 68 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 69 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 70 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 71 * SUCH DAMAGE. 72 */ 73 74 #ifndef _NET_IF_MEDIA_H_ 75 #define _NET_IF_MEDIA_H_ 76 77 /* 78 * Prototypes and definitions for BSD/OS-compatible network interface 79 * media selection. 80 * 81 * Where it is safe to do so, this code strays slightly from the BSD/OS 82 * design. Software which uses the API (device drivers, basically) 83 * shouldn't notice any difference. 84 * 85 * Many thanks to Matt Thomas for providing the information necessary 86 * to implement this interface. 87 */ 88 89 #ifdef _KERNEL 90 91 #include <sys/queue.h> 92 93 /* 94 * Driver callbacks for media status and change requests. 95 */ 96 typedef int (*ifm_change_cb_t) __P((struct ifnet *ifp)); 97 typedef void (*ifm_stat_cb_t) __P((struct ifnet *ifp, struct ifmediareq *req)); 98 99 /* 100 * In-kernel representation of a single supported media type. 101 */ 102 struct ifmedia_entry { 103 TAILQ_ENTRY(ifmedia_entry) ifm_list; 104 int ifm_media; /* description of this media attachment */ 105 int ifm_data; /* for driver-specific use */ 106 void *ifm_aux; /* for driver-specific use */ 107 }; 108 109 /* 110 * One of these goes into a network interface's softc structure. 111 * It is used to keep general media state. 112 */ 113 struct ifmedia { 114 int ifm_mask; /* mask of changes we don't care about */ 115 int ifm_media; /* current user-set media word */ 116 struct ifmedia_entry *ifm_cur; /* currently selected media */ 117 TAILQ_HEAD(, ifmedia_entry) ifm_list; /* list of all supported media */ 118 ifm_change_cb_t ifm_change; /* media change driver callback */ 119 ifm_stat_cb_t ifm_status; /* media status driver callback */ 120 }; 121 122 /* Initialize an interface's struct if_media field. */ 123 void ifmedia_init __P((struct ifmedia *ifm, int dontcare_mask, 124 ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback)); 125 126 /* Add one supported medium to a struct ifmedia. */ 127 void ifmedia_add __P((struct ifmedia *ifm, int mword, int data, void *aux)); 128 129 /* Add an array (of ifmedia_entry) media to a struct ifmedia. */ 130 void ifmedia_list_add(struct ifmedia *mp, struct ifmedia_entry *lp, 131 int count); 132 133 /* Set default media type on initialization. */ 134 void ifmedia_set __P((struct ifmedia *ifm, int mword)); 135 136 /* Common ioctl function for getting/setting media, called by driver. */ 137 int ifmedia_ioctl __P((struct ifnet *ifp, struct ifreq *ifr, 138 struct ifmedia *ifm, u_long cmd)); 139 140 /* Look up a media entry. */ 141 struct ifmedia_entry *ifmedia_match __P((struct ifmedia *ifm, int flags, 142 int mask)); 143 144 /* Delete all media for a given media instance */ 145 void ifmedia_delete_instance __P((struct ifmedia *, int)); 146 147 #endif /*_KERNEL */ 148 149 /* 150 * if_media Options word: 151 * Bits Use 152 * ---- ------- 153 * 0-4 Media subtype MAX SUBTYPE == 31! 154 * 5-7 Media type 155 * 8-15 Type specific options 156 * 16-19 RFU 157 * 20-27 Shared (global) options 158 * 28-31 Instance 159 */ 160 161 /* 162 * Ethernet 163 */ 164 #define IFM_ETHER 0x00000020 165 #define IFM_10_T 3 /* 10BaseT - RJ45 */ 166 #define IFM_10_2 4 /* 10Base2 - Thinnet */ 167 #define IFM_10_5 5 /* 10Base5 - AUI */ 168 #define IFM_100_TX 6 /* 100BaseTX - RJ45 */ 169 #define IFM_100_FX 7 /* 100BaseFX - Fiber */ 170 #define IFM_100_T4 8 /* 100BaseT4 - 4 pair cat 3 */ 171 #define IFM_100_VG 9 /* 100VG-AnyLAN */ 172 #define IFM_100_T2 10 /* 100BaseT2 */ 173 #define IFM_1000_SX 11 /* 1000BaseSX - multi-mode fiber */ 174 #define IFM_10_STP 12 /* 10BaseT over shielded TP */ 175 #define IFM_10_FL 13 /* 10BaseFL - Fiber */ 176 #define IFM_1000_LX 14 /* 1000baseLX - single-mode fiber */ 177 #define IFM_1000_CX 15 /* 1000baseCX - 150ohm STP */ 178 #define IFM_1000_TX 16 /* 1000baseTX - 4 pair cat 5 */ 179 #define IFM_HPNA_1 17 /* HomePNA 1.0 (1Mb/s) */ 180 181 /* 182 * Token ring 183 */ 184 #define IFM_TOKEN 0x00000040 185 #define IFM_TOK_STP4 3 /* Shielded twisted pair 4m - DB9 */ 186 #define IFM_TOK_STP16 4 /* Shielded twisted pair 16m - DB9 */ 187 #define IFM_TOK_UTP4 5 /* Unshielded twisted pair 4m - RJ45 */ 188 #define IFM_TOK_UTP16 6 /* Unshielded twisted pair 16m - RJ45 */ 189 #define IFM_TOK_ETR 0x00000200 /* Early token release */ 190 #define IFM_TOK_SRCRT 0x00000400 /* Enable source routing features */ 191 #define IFM_TOK_ALLR 0x00000800 /* All routes / Single route bcast */ 192 193 /* 194 * FDDI 195 */ 196 #define IFM_FDDI 0x00000060 197 #define IFM_FDDI_SMF 3 /* Single-mode fiber */ 198 #define IFM_FDDI_MMF 4 /* Multi-mode fiber */ 199 #define IFM_FDDI_UTP 5 /* CDDI / UTP */ 200 #define IFM_FDDI_DA 0x00000100 /* Dual attach / single attach */ 201 202 /* 203 * IEEE 802.11 Wireless 204 */ 205 #define IFM_IEEE80211 0x00000080 206 #define IFM_IEEE80211_FH1 3 /* Frequency Hopping 1Mbps */ 207 #define IFM_IEEE80211_FH2 4 /* Frequency Hopping 2Mbps */ 208 #define IFM_IEEE80211_DS2 5 /* Direct Sequence 2Mbps */ 209 #define IFM_IEEE80211_DS5 6 /* Direct Sequence 5Mbps*/ 210 #define IFM_IEEE80211_DS11 7 /* Direct Sequence 11Mbps*/ 211 #define IFM_IEEE80211_ADHOC 0x00000100 /* Operate in Adhoc mode */ 212 213 /* 214 * Shared media sub-types 215 */ 216 #define IFM_AUTO 0 /* Autoselect best media */ 217 #define IFM_MANUAL 1 /* Jumper/dipswitch selects media */ 218 #define IFM_NONE 2 /* Deselect all media */ 219 220 /* 221 * Shared options 222 */ 223 #define IFM_FDX 0x00100000 /* Force full duplex */ 224 #define IFM_HDX 0x00200000 /* Force half duplex */ 225 #define IFM_FLOW 0x00400000 /* enable hardware flow control */ 226 #define IFM_FLAG0 0x01000000 /* Driver defined flag */ 227 #define IFM_FLAG1 0x02000000 /* Driver defined flag */ 228 #define IFM_FLAG2 0x04000000 /* Driver defined flag */ 229 #define IFM_LOOP 0x08000000 /* Put hardware in loopback */ 230 231 /* 232 * Masks 233 */ 234 #define IFM_NMASK 0x000000e0 /* Network type */ 235 #define IFM_TMASK 0x0000001f /* Media sub-type */ 236 #define IFM_IMASK 0xf0000000 /* Instance */ 237 #define IFM_ISHIFT 28 /* Instance shift */ 238 #define IFM_OMASK 0x0000ff00 /* Type specific options */ 239 #define IFM_GMASK 0x0ff00000 /* Global options */ 240 241 #define IFM_NMIN IFM_ETHER /* lowest Network type */ 242 #define IFM_NMAX IFM_NMASK /* highest Network type */ 243 244 /* 245 * Status bits 246 */ 247 #define IFM_AVALID 0x00000001 /* Active bit valid */ 248 #define IFM_ACTIVE 0x00000002 /* Interface attached to working net */ 249 250 /* Mask of "status valid" bits, for ifconfig(8). */ 251 #define IFM_STATUS_VALID IFM_AVALID 252 253 /* List of "status valid" bits, for ifconfig(8). */ 254 #define IFM_STATUS_VALID_LIST { \ 255 IFM_AVALID, \ 256 0, \ 257 } 258 259 /* 260 * Macros to extract various bits of information from the media word. 261 */ 262 #define IFM_TYPE(x) ((x) & IFM_NMASK) 263 #define IFM_SUBTYPE(x) ((x) & IFM_TMASK) 264 #define IFM_INST(x) (((x) & IFM_IMASK) >> IFM_ISHIFT) 265 #define IFM_OPTIONS(x) ((x) & (IFM_OMASK|IFM_GMASK)) 266 267 #define IFM_INST_MAX IFM_INST(IFM_IMASK) 268 #define IFM_INST_ANY -1 269 270 /* 271 * Macro to create a media word. 272 */ 273 #define IFM_MAKEWORD(type, subtype, options, instance) \ 274 ((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT)) 275 276 /* 277 * NetBSD extension not defined in the BSDI API. This is used in various 278 * places to get the canonical description for a given type/subtype. 279 * 280 * In the subtype and mediaopt descriptions, the valid TYPE bits are OR'd 281 * in to indicate which TYPE the subtype/option corresponds to. If no 282 * TYPE is present, it is a shared media/mediaopt. 283 * 284 * Note that these are parsed case-insensitive. 285 * 286 * Order is important. The first matching entry is the canonical name 287 * for a media type; subsequent matches are aliases. 288 */ 289 struct ifmedia_description { 290 int ifmt_word; /* word value; may be masked */ 291 const char *ifmt_string; /* description */ 292 }; 293 294 #define IFM_TYPE_DESCRIPTIONS { \ 295 { IFM_ETHER, "Ethernet" }, \ 296 { IFM_ETHER, "ether" }, \ 297 { IFM_TOKEN, "TokenRing" }, \ 298 { IFM_TOKEN, "token" }, \ 299 { IFM_FDDI, "FDDI" }, \ 300 { IFM_IEEE80211, "IEEE802.11" }, \ 301 { 0, NULL }, \ 302 } 303 304 #define IFM_TYPE_MATCH(dt, t) \ 305 (IFM_TYPE((dt)) == 0 || IFM_TYPE((dt)) == IFM_TYPE((t))) 306 307 #define IFM_SUBTYPE_DESCRIPTIONS { \ 308 { IFM_AUTO, "autoselect" }, \ 309 { IFM_AUTO, "auto" }, \ 310 { IFM_MANUAL, "manual" }, \ 311 { IFM_NONE, "none" }, \ 312 \ 313 { IFM_ETHER|IFM_10_T, "10baseT" }, \ 314 { IFM_ETHER|IFM_10_T, "10baseT/UTP" }, \ 315 { IFM_ETHER|IFM_10_T, "UTP" }, \ 316 { IFM_ETHER|IFM_10_T, "10UTP" }, \ 317 { IFM_ETHER|IFM_10_2, "10base2" }, \ 318 { IFM_ETHER|IFM_10_2, "10base2/BNC" }, \ 319 { IFM_ETHER|IFM_10_2, "BNC" }, \ 320 { IFM_ETHER|IFM_10_2, "10BNC" }, \ 321 { IFM_ETHER|IFM_10_5, "10base5" }, \ 322 { IFM_ETHER|IFM_10_5, "10base5/AUI" }, \ 323 { IFM_ETHER|IFM_10_5, "AUI" }, \ 324 { IFM_ETHER|IFM_10_5, "10AUI" }, \ 325 { IFM_ETHER|IFM_100_TX, "100baseTX" }, \ 326 { IFM_ETHER|IFM_100_TX, "100TX" }, \ 327 { IFM_ETHER|IFM_100_FX, "100baseFX" }, \ 328 { IFM_ETHER|IFM_100_FX, "100FX" }, \ 329 { IFM_ETHER|IFM_100_T4, "100baseT4" }, \ 330 { IFM_ETHER|IFM_100_T4, "100T4" }, \ 331 { IFM_ETHER|IFM_100_VG, "100baseVG" }, \ 332 { IFM_ETHER|IFM_100_VG, "100VG" }, \ 333 { IFM_ETHER|IFM_100_T2, "100baseT2" }, \ 334 { IFM_ETHER|IFM_100_T2, "100T2" }, \ 335 { IFM_ETHER|IFM_1000_SX, "1000baseSX" }, \ 336 { IFM_ETHER|IFM_1000_SX, "1000SX" }, \ 337 { IFM_ETHER|IFM_10_STP, "10baseSTP" }, \ 338 { IFM_ETHER|IFM_10_STP, "STP" }, \ 339 { IFM_ETHER|IFM_10_STP, "10STP" }, \ 340 { IFM_ETHER|IFM_10_FL, "10baseFL" }, \ 341 { IFM_ETHER|IFM_10_FL, "FL" }, \ 342 { IFM_ETHER|IFM_10_FL, "10FL" }, \ 343 { IFM_ETHER|IFM_1000_LX, "1000baseLX" }, \ 344 { IFM_ETHER|IFM_1000_LX, "1000LX" }, \ 345 { IFM_ETHER|IFM_1000_CX, "1000baseCX" }, \ 346 { IFM_ETHER|IFM_1000_CX, "1000CX" }, \ 347 { IFM_ETHER|IFM_1000_TX, "1000baseTX" }, \ 348 { IFM_ETHER|IFM_1000_TX, "1000TX" }, \ 349 { IFM_ETHER|IFM_HPNA_1, "HomePNA1" }, \ 350 { IFM_ETHER|IFM_HPNA_1, "HPNA1" }, \ 351 \ 352 { IFM_TOKEN|IFM_TOK_STP4, "DB9/4Mbit" }, \ 353 { IFM_TOKEN|IFM_TOK_STP4, "4STP" }, \ 354 { IFM_TOKEN|IFM_TOK_STP16, "DB9/16Mbit" }, \ 355 { IFM_TOKEN|IFM_TOK_STP16, "16STP" }, \ 356 { IFM_TOKEN|IFM_TOK_UTP4, "UTP/4Mbit" }, \ 357 { IFM_TOKEN|IFM_TOK_UTP4, "4UTP" }, \ 358 { IFM_TOKEN|IFM_TOK_UTP16, "UTP/16Mbit" }, \ 359 { IFM_TOKEN|IFM_TOK_UTP16, "16UTP" }, \ 360 \ 361 { IFM_FDDI|IFM_FDDI_SMF, "Single-mode" }, \ 362 { IFM_FDDI|IFM_FDDI_SMF, "SMF" }, \ 363 { IFM_FDDI|IFM_FDDI_MMF, "Multi-mode" }, \ 364 { IFM_FDDI|IFM_FDDI_MMF, "MMF" }, \ 365 { IFM_FDDI|IFM_FDDI_UTP, "UTP" }, \ 366 { IFM_FDDI|IFM_FDDI_UTP, "CDDI" }, \ 367 \ 368 /* \ 369 * Short-hand for common media+option combos. \ 370 */ \ 371 { IFM_ETHER|IFM_10_T|IFM_FDX, "10baseT-FDX" }, \ 372 { IFM_ETHER|IFM_100_TX|IFM_FDX, "100baseTX-FDX" }, \ 373 \ 374 /* \ 375 * IEEE 802.11 \ 376 */ \ 377 { IFM_IEEE80211|IFM_IEEE80211_FH1, "FH1" }, \ 378 { IFM_IEEE80211|IFM_IEEE80211_FH2, "FH2" }, \ 379 { IFM_IEEE80211|IFM_IEEE80211_DS2, "DS2" }, \ 380 { IFM_IEEE80211|IFM_IEEE80211_DS5, "DS5" }, \ 381 { IFM_IEEE80211|IFM_IEEE80211_DS11, "DS11" }, \ 382 \ 383 { 0, NULL }, \ 384 } 385 386 #define IFM_OPTION_DESCRIPTIONS { \ 387 { IFM_FDX, "full-duplex" }, \ 388 { IFM_FDX, "fdx" }, \ 389 { IFM_HDX, "half-duplex" }, \ 390 { IFM_HDX, "hdx" }, \ 391 { IFM_FLAG0, "flag0" }, \ 392 { IFM_FLAG1, "flag1" }, \ 393 { IFM_FLAG2, "flag2" }, \ 394 { IFM_LOOP, "loopback" }, \ 395 { IFM_LOOP, "hw-loopback"}, \ 396 { IFM_LOOP, "loop" }, \ 397 \ 398 { IFM_TOKEN|IFM_TOK_ETR, "EarlyTokenRelease" }, \ 399 { IFM_TOKEN|IFM_TOK_ETR, "ETR" }, \ 400 { IFM_TOKEN|IFM_TOK_SRCRT, "SourceRouting" }, \ 401 { IFM_TOKEN|IFM_TOK_SRCRT, "SRCRT" }, \ 402 { IFM_TOKEN|IFM_TOK_ALLR, "AllRoutes" }, \ 403 { IFM_TOKEN|IFM_TOK_ALLR, "ALLR" }, \ 404 \ 405 { IFM_FDDI|IFM_FDDI_DA, "dual-attach" }, \ 406 { IFM_FDDI|IFM_FDDI_DA, "das" }, \ 407 \ 408 { IFM_IEEE80211|IFM_IEEE80211_ADHOC, "adhoc" }, \ 409 \ 410 { 0, NULL }, \ 411 } 412 413 /* 414 * Status bit descriptions for the various media types. 415 */ 416 struct ifmedia_status_description { 417 int ifms_type; 418 int ifms_valid; 419 int ifms_bit; 420 const char *ifms_string[2]; 421 }; 422 423 #define IFM_STATUS_DESC(ifms, bit) \ 424 (ifms)->ifms_string[((ifms)->ifms_bit & (bit)) ? 1 : 0] 425 426 #define IFM_STATUS_DESCRIPTIONS { \ 427 { IFM_ETHER, IFM_AVALID, IFM_ACTIVE, \ 428 { "no carrier", "active" } }, \ 429 \ 430 { IFM_FDDI, IFM_AVALID, IFM_ACTIVE, \ 431 { "no ring", "inserted" } }, \ 432 \ 433 { IFM_TOKEN, IFM_AVALID, IFM_ACTIVE, \ 434 { "no ring", "inserted" } }, \ 435 \ 436 { IFM_IEEE80211, IFM_AVALID, IFM_ACTIVE, \ 437 { "no network", "active" } }, \ 438 \ 439 { 0, 0, 0, \ 440 { NULL, NULL } }, \ 441 } 442 443 #endif /* _NET_IF_MEDIA_H_ */ 444
Indexes created Sun Sep 28 12:09:53 GMT 2025