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