Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
FreeBSD/Linux Kernel Cross Reference
sys/net/if_media.h
Version:
- FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
SearchContext: - none - 3 - 10
1 /* $NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $ */ 2 /* $FreeBSD$ */ 3 4 /* 5 * Copyright (c) 1997 6 * Jonathan Stone and Jason R. Thorpe. All rights reserved. 7 * 8 * This software is derived from information provided by Matt Thomas. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by Jonathan Stone 21 * and Jason R. Thorpe for the NetBSD Project. 22 * 4. The names of the authors may not be used to endorse or promote products 23 * derived from this software without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 26 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 27 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 28 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 30 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 31 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 32 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35 * SUCH DAMAGE. 36 */ 37 38 #ifndef _NET_IF_MEDIA_H_ 39 #define _NET_IF_MEDIA_H_ 40 41 /* 42 * Prototypes and definitions for BSD/OS-compatible network interface 43 * media selection. 44 * 45 * Where it is safe to do so, this code strays slightly from the BSD/OS 46 * design. Software which uses the API (device drivers, basically) 47 * shouldn't notice any difference. 48 * 49 * Many thanks to Matt Thomas for providing the information necessary 50 * to implement this interface. 51 */ 52 53 #ifdef KERNEL 54 55 #include <sys/queue.h> 56 57 /* 58 * Driver callbacks for media status and change requests. 59 */ 60 typedef int (*ifm_change_cb_t) __P((struct ifnet *ifp)); 61 typedef void (*ifm_stat_cb_t) __P((struct ifnet *ifp, struct ifmediareq *req)); 62 63 /* 64 * In-kernel representation of a single supported media type. 65 */ 66 struct ifmedia_entry { 67 LIST_ENTRY(ifmedia_entry) ifm_list; 68 int ifm_media; /* description of this media attachment */ 69 int ifm_data; /* for driver-specific use */ 70 void *ifm_aux; /* for driver-specific use */ 71 }; 72 73 /* 74 * One of these goes into a network interface's softc structure. 75 * It is used to keep general media state. 76 */ 77 struct ifmedia { 78 int ifm_mask; /* mask of changes we don't care about */ 79 int ifm_media; /* current user-set media word */ 80 struct ifmedia_entry *ifm_cur; /* currently selected media */ 81 LIST_HEAD(, ifmedia_entry) ifm_list; /* list of all supported media */ 82 ifm_change_cb_t ifm_change; /* media change driver callback */ 83 ifm_stat_cb_t ifm_status; /* media status driver callback */ 84 }; 85 86 /* Initialize an interface's struct if_media field. */ 87 void ifmedia_init __P((struct ifmedia *ifm, int dontcare_mask, 88 ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback)); 89 90 /* Add one supported medium to a struct ifmedia. */ 91 void ifmedia_add __P((struct ifmedia *ifm, int mword, int data, void *aux)); 92 93 /* Add an array (of ifmedia_entry) media to a struct ifmedia. */ 94 void ifmedia_list_add(struct ifmedia *mp, struct ifmedia_entry *lp, 95 int count); 96 97 /* Set default media type on initialization. */ 98 void ifmedia_set __P((struct ifmedia *ifm, int mword)); 99 100 /* Common ioctl function for getting/setting media, called by driver. */ 101 int ifmedia_ioctl __P((struct ifnet *ifp, struct ifreq *ifr, 102 struct ifmedia *ifm, u_long cmd)); 103 104 #endif /*KERNEL */ 105 106 /* 107 * if_media Options word: 108 * Bits Use 109 * ---- ------- 110 * 0-4 Media variant 111 * 5-7 Media type 112 * 8-15 Type specific options 113 * 16-19 RFU 114 * 20-27 Shared (global) options 115 * 28-31 Instance 116 */ 117 118 /* 119 * Ethernet 120 */ 121 #define IFM_ETHER 0x00000020 122 #define IFM_10_T 3 /* 10BaseT - RJ45 */ 123 #define IFM_10_2 4 /* 10Base2 - Thinnet */ 124 #define IFM_10_5 5 /* 10Base5 - AUI */ 125 #define IFM_100_TX 6 /* 100BaseTX - RJ45 */ 126 #define IFM_100_FX 7 /* 100BaseFX - Fiber */ 127 #define IFM_100_T4 8 /* 100BaseT4 - 4 pair cat 3 */ 128 #define IFM_100_VG 9 /* 100VG-AnyLAN */ 129 #define IFM_100_T2 10 /* 100BaseT2 */ 130 #define IFM_1000_FX 11 /* 1000BaseFX - gigabit over fiber */ 131 #define IFM_10_STP 12 /* 10BaseT over shielded TP */ 132 #define IFM_10_FL 13 /* 10baseFL - Fiber */ 133 #define IFM_1000_SX 14 /* 1000BaseSX Multi-mode Fiber */ 134 #define IFM_1000_LX 15 /* 1000BaseLX Single-mode Fiber */ 135 #define IFM_1000_CX 16 /* 1000BaseCX 150ohm STP */ 136 #define IFM_1000_TX 17 /* 1000BaseTX 4 pair cat 5 */ 137 #define IFM_homePNA 18 /* HomePNA media for ethernet frames */ 138 /* note 31 is the max! */ 139 140 /* 141 * Token ring 142 */ 143 #define IFM_TOKEN 0x00000040 144 #define IFM_TOK_STP4 3 /* Shielded twisted pair 4m - DB9 */ 145 #define IFM_TOK_STP16 4 /* Shielded twisted pair 16m - DB9 */ 146 #define IFM_TOK_UTP4 5 /* Unshielded twisted pair 4m - RJ45 */ 147 #define IFM_TOK_UTP16 6 /* Unshielded twisted pair 16m - RJ45 */ 148 #define IFM_TOK_STP100 7 /* Shielded twisted pair 100m - DB9 */ 149 #define IFM_TOK_UTP100 8 /* Unshielded twisted pair 100m - RJ45 */ 150 #define IFM_TOK_ETR 0x00000200 /* Early token release */ 151 #define IFM_TOK_SRCRT 0x00000400 /* Enable source routing features */ 152 #define IFM_TOK_ALLR 0x00000800 /* All routes / Single route bcast */ 153 #define IFM_TOK_DTR 0x00002000 /* Dedicated token ring */ 154 #define IFM_TOK_CLASSIC 0x00004000 /* Classic token ring */ 155 #define IFM_TOK_AUTO 0x00008000 /* Automatic Dedicate/Classic token ring */ 156 157 /* 158 * FDDI 159 */ 160 #define IFM_FDDI 0x00000060 161 #define IFM_FDDI_SMF 3 /* Single-mode fiber */ 162 #define IFM_FDDI_MMF 4 /* Multi-mode fiber */ 163 #define IFM_FDDI_UTP 5 /* CDDI / UTP */ 164 #define IFM_FDDI_DA 0x00000100 /* Dual attach / single attach */ 165 166 /* 167 * Shared media sub-types 168 */ 169 #define IFM_AUTO 0 /* Autoselect best media */ 170 #define IFM_MANUAL 1 /* Jumper/dipswitch selects media */ 171 #define IFM_NONE 2 /* Deselect all media */ 172 173 /* 174 * Shared options 175 */ 176 #define IFM_FDX 0x00100000 /* Force full duplex */ 177 #define IFM_HDX 0x00200000 /* Force half duplex */ 178 #define IFM_FLAG0 0x01000000 /* Driver defined flag */ 179 #define IFM_FLAG1 0x02000000 /* Driver defined flag */ 180 #define IFM_FLAG2 0x04000000 /* Driver defined flag */ 181 #define IFM_LOOP 0x08000000 /* Put hardware in loopback */ 182 183 /* 184 * Masks 185 */ 186 #define IFM_NMASK 0x000000e0 /* Network type */ 187 #define IFM_TMASK 0x0000001f /* Media sub-type */ 188 #define IFM_IMASK 0xf0000000 /* Instance */ 189 #define IFM_ISHIFT 28 /* Instance shift */ 190 #define IFM_OMASK 0x0000ff00 /* Type specific options */ 191 #define IFM_GMASK 0x0ff00000 /* Global options */ 192 193 /* 194 * Status bits 195 */ 196 #define IFM_AVALID 0x00000001 /* Active bit valid */ 197 #define IFM_ACTIVE 0x00000002 /* Interface attached to working net */ 198 199 /* 200 * Macros to extract various bits of information from the media word. 201 */ 202 #define IFM_TYPE(x) ((x) & IFM_NMASK) 203 #define IFM_SUBTYPE(x) ((x) & IFM_TMASK) 204 #define IFM_TYPE_OPTIONS(x) ((x) & IFM_OMASK) 205 #define IFM_INST(x) (((x) & IFM_IMASK) >> IFM_ISHIFT) 206 #define IFM_OPTIONS(x) ((x) & (IFM_OMASK|IFM_GMASK)) 207 208 #define IFM_INST_MAX IFM_INST(IFM_IMASK) 209 210 /* 211 * Macro to create a media word. 212 */ 213 #define IFM_MAKEWORD(type, subtype, options, instance) \ 214 ((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT)) 215 216 /* 217 * NetBSD extension not defined in the BSDI API. This is used in various 218 * places to get the canonical description for a given type/subtype. 219 * 220 * NOTE: all but the top-level type descriptions must contain NO whitespace! 221 * Otherwise, parsing these in ifconfig(8) would be a nightmare. 222 */ 223 struct ifmedia_description { 224 int ifmt_word; /* word value; may be masked */ 225 const char *ifmt_string; /* description */ 226 }; 227 228 #define IFM_TYPE_DESCRIPTIONS { \ 229 { IFM_ETHER, "Ethernet" }, \ 230 { IFM_TOKEN, "Token ring" }, \ 231 { IFM_FDDI, "FDDI" }, \ 232 { 0, NULL }, \ 233 } 234 235 #define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS { \ 236 { IFM_10_T, "10baseT/UTP" }, \ 237 { IFM_10_2, "10base2/BNC" }, \ 238 { IFM_10_5, "10base5/AUI" }, \ 239 { IFM_100_TX, "100baseTX" }, \ 240 { IFM_100_FX, "100baseFX" }, \ 241 { IFM_100_T4, "100baseT4" }, \ 242 { IFM_100_VG, "100baseVG" }, \ 243 { IFM_100_T2, "100baseT2" }, \ 244 { IFM_1000_FX, "1000baseFX" }, \ 245 { IFM_10_STP, "10baseSTP" }, \ 246 { IFM_10_FL, "10baseFL" }, \ 247 { IFM_1000_SX, "1000baseSX" }, \ 248 { IFM_1000_LX, "1000baseLX" }, \ 249 { IFM_1000_CX, "1000baseCX" }, \ 250 { IFM_1000_TX, "1000baseTX" }, \ 251 { IFM_homePNA, "homePNA" }, \ 252 { 0, NULL }, \ 253 } 254 255 #define IFM_SUBTYPE_ETHERNET_ALIASES { \ 256 { IFM_10_T, "UTP" }, \ 257 { IFM_10_T, "10UTP" }, \ 258 { IFM_10_2, "BNC" }, \ 259 { IFM_10_2, "10BNC" }, \ 260 { IFM_10_5, "AUI" }, \ 261 { IFM_10_5, "10AUI" }, \ 262 { IFM_100_TX, "100TX" }, \ 263 { IFM_100_FX, "100FX" }, \ 264 { IFM_100_T4, "100T4" }, \ 265 { IFM_100_VG, "100VG" }, \ 266 { IFM_100_T2, "100T2" }, \ 267 { IFM_1000_FX, "1000FX" }, \ 268 { IFM_10_STP, "10STP" }, \ 269 { IFM_10_FL, "10FL" }, \ 270 { IFM_1000_FX, "1000SX" }, \ 271 { IFM_1000_FX, "1000LX" }, \ 272 { IFM_1000_FX, "1000CX" }, \ 273 { IFM_1000_FX, "1000TX" }, \ 274 { 0, NULL }, \ 275 } 276 277 #define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS { \ 278 { 0, NULL }, \ 279 } 280 281 #define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS { \ 282 { IFM_TOK_STP4, "DB9/4Mbit" }, \ 283 { IFM_TOK_STP16, "DB9/16Mbit" }, \ 284 { IFM_TOK_UTP4, "UTP/4Mbit" }, \ 285 { IFM_TOK_UTP16, "UTP/16Mbit" }, \ 286 { IFM_TOK_STP100, "STP/100Mbit" }, \ 287 { IFM_TOK_UTP100, "UTP/100Mbit" }, \ 288 { 0, NULL }, \ 289 } 290 291 #define IFM_SUBTYPE_TOKENRING_ALIASES { \ 292 { IFM_TOK_STP4, "4STP" }, \ 293 { IFM_TOK_STP16, "16STP" }, \ 294 { IFM_TOK_UTP4, "4UTP" }, \ 295 { IFM_TOK_UTP16, "16UTP" }, \ 296 { IFM_TOK_STP100, "100STP" }, \ 297 { IFM_TOK_UTP100, "100UTP" }, \ 298 { 0, NULL }, \ 299 } 300 301 #define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS { \ 302 { IFM_TOK_ETR, "EarlyTokenRelease" }, \ 303 { IFM_TOK_SRCRT, "SourceRouting" }, \ 304 { IFM_TOK_ALLR, "AllRoutes" }, \ 305 { IFM_TOK_DTR, "Dedicated" }, \ 306 { IFM_TOK_CLASSIC,"Classic" }, \ 307 { IFM_TOK_AUTO, "Auto-mode" }, \ 308 { 0, NULL }, \ 309 } 310 311 #define IFM_SUBTYPE_FDDI_DESCRIPTIONS { \ 312 { IFM_FDDI_SMF, "Single-mode" }, \ 313 { IFM_FDDI_MMF, "Multi-mode" }, \ 314 { IFM_FDDI_UTP, "UTP" }, \ 315 { 0, NULL }, \ 316 } 317 318 #define IFM_SUBTYPE_FDDI_ALIASES { \ 319 { IFM_FDDI_SMF, "SMF" }, \ 320 { IFM_FDDI_MMF, "MMF" }, \ 321 { IFM_FDDI_UTP, "CDDI" }, \ 322 { 0, NULL }, \ 323 } 324 325 #define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS { \ 326 { IFM_FDDI_DA, "Dual-attach" }, \ 327 { 0, NULL }, \ 328 } 329 330 #define IFM_SUBTYPE_SHARED_DESCRIPTIONS { \ 331 { IFM_AUTO, "autoselect" }, \ 332 { IFM_MANUAL, "manual" }, \ 333 { IFM_NONE, "none" }, \ 334 { 0, NULL }, \ 335 } 336 337 #define IFM_SUBTYPE_SHARED_ALIASES { \ 338 { IFM_AUTO, "auto" }, \ 339 { 0, NULL }, \ 340 } 341 342 #define IFM_SHARED_OPTION_DESCRIPTIONS { \ 343 { IFM_FDX, "full-duplex" }, \ 344 { IFM_HDX, "half-duplex" }, \ 345 { IFM_FLAG0, "flag0" }, \ 346 { IFM_FLAG1, "flag1" }, \ 347 { IFM_FLAG2, "flag2" }, \ 348 { IFM_LOOP, "hw-loopback" }, \ 349 { 0, NULL }, \ 350 } 351 352 #endif /* _NET_IF_MEDIA_H_ */
Cache object: c6203e790137d0c6a597e7ee6961947a
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]