if_media.h revision 50477
1/* $NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $ */ 2/* $FreeBSD: head/sys/net/if_media.h 50477 1999-08-28 01:08:13Z peter $ */ 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 */ 60typedef int (*ifm_change_cb_t) __P((struct ifnet *ifp)); 61typedef 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 */ 66struct 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 */ 77struct 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. */ 87void ifmedia_init __P((struct ifmedia *ifm, int dontcare_mask, 88 ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback)); 89 90/* Remove all mediums from a struct ifmedia. */ 91void ifmedia_removeall __P(( struct ifmedia *ifm)); 92 93/* Add one supported medium to a struct ifmedia. */ 94void ifmedia_add __P((struct ifmedia *ifm, int mword, int data, void *aux)); 95 96/* Add an array (of ifmedia_entry) media to a struct ifmedia. */ 97void ifmedia_list_add(struct ifmedia *mp, struct ifmedia_entry *lp, 98 int count); 99 100/* Set default media type on initialization. */ 101void ifmedia_set __P((struct ifmedia *ifm, int mword)); 102 103/* Common ioctl function for getting/setting media, called by driver. */ 104int ifmedia_ioctl __P((struct ifnet *ifp, struct ifreq *ifr, 105 struct ifmedia *ifm, u_long cmd)); 106 107#endif /*KERNEL */ 108 109/* 110 * if_media Options word: 111 * Bits Use 112 * ---- ------- 113 * 0-3 Media variant 114 * 4 RFU 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 142/* 143 * Token ring 144 */ 145#define IFM_TOKEN 0x00000040 146#define IFM_TOK_STP4 3 /* Shielded twisted pair 4m - DB9 */ 147#define IFM_TOK_STP16 4 /* Shielded twisted pair 16m - DB9 */ 148#define IFM_TOK_UTP4 5 /* Unshielded twisted pair 4m - RJ45 */ 149#define IFM_TOK_UTP16 6 /* Unshielded twisted pair 16m - RJ45 */ 150#define IFM_TOK_STP100 7 /* Shielded twisted pair 100m - DB9 */ 151#define IFM_TOK_UTP100 8 /* Unshielded twisted pair 100m - RJ45 */ 152#define IFM_TOK_ETR 0x00000200 /* Early token release */ 153#define IFM_TOK_SRCRT 0x00000400 /* Enable source routing features */ 154#define IFM_TOK_ALLR 0x00000800 /* All routes / Single route bcast */ 155#define IFM_TOK_DTR 0x00002000 /* Dedicated token ring */ 156#define IFM_TOK_CLASSIC 0x00004000 /* Classic token ring */ 157#define IFM_TOK_AUTO 0x00008000 /* Automatic Dedicate/Classic token ring */ 158 159/* 160 * FDDI 161 */ 162#define IFM_FDDI 0x00000060 163#define IFM_FDDI_SMF 3 /* Single-mode fiber */ 164#define IFM_FDDI_MMF 4 /* Multi-mode fiber */ 165#define IFM_FDDI_UTP 5 /* CDDI / UTP */ 166#define IFM_FDDI_DA 0x00000100 /* Dual attach / single attach */ 167 168/* 169 * Shared media sub-types 170 */ 171#define IFM_AUTO 0 /* Autoselect best media */ 172#define IFM_MANUAL 1 /* Jumper/dipswitch selects media */ 173#define IFM_NONE 2 /* Deselect all media */ 174 175/* 176 * Shared options 177 */ 178#define IFM_FDX 0x00100000 /* Force full duplex */ 179#define IFM_HDX 0x00200000 /* Force half duplex */ 180#define IFM_FLAG0 0x01000000 /* Driver defined flag */ 181#define IFM_FLAG1 0x02000000 /* Driver defined flag */ 182#define IFM_FLAG2 0x04000000 /* Driver defined flag */ 183#define IFM_LOOP 0x08000000 /* Put hardware in loopback */ 184 185/* 186 * Masks 187 */ 188#define IFM_NMASK 0x000000e0 /* Network type */ 189#define IFM_TMASK 0x0000000f /* Media sub-type */ 190#define IFM_IMASK 0xf0000000 /* Instance */ 191#define IFM_ISHIFT 28 /* Instance shift */ 192#define IFM_OMASK 0x0000ff00 /* Type specific options */ 193#define IFM_GMASK 0x0ff00000 /* Global options */ 194 195/* 196 * Status bits 197 */ 198#define IFM_AVALID 0x00000001 /* Active bit valid */ 199#define IFM_ACTIVE 0x00000002 /* Interface attached to working net */ 200 201/* 202 * Macros to extract various bits of information from the media word. 203 */ 204#define IFM_TYPE(x) ((x) & IFM_NMASK) 205#define IFM_SUBTYPE(x) ((x) & IFM_TMASK) 206#define IFM_TYPE_OPTIONS(x) ((x) & IFM_OMASK) 207#define IFM_INST(x) (((x) & IFM_IMASK) >> IFM_ISHIFT) 208#define IFM_OPTIONS(x) ((x) & (IFM_OMASK|IFM_GMASK)) 209 210#define IFM_INST_MAX IFM_INST(IFM_IMASK) 211 212/* 213 * Macro to create a media word. 214 */ 215#define IFM_MAKEWORD(type, subtype, options, instance) \ 216 ((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT)) 217 218/* 219 * NetBSD extension not defined in the BSDI API. This is used in various 220 * places to get the canonical description for a given type/subtype. 221 * 222 * NOTE: all but the top-level type descriptions must contain NO whitespace! 223 * Otherwise, parsing these in ifconfig(8) would be a nightmare. 224 */ 225struct ifmedia_description { 226 int ifmt_word; /* word value; may be masked */ 227 const char *ifmt_string; /* description */ 228}; 229 230#define IFM_TYPE_DESCRIPTIONS { \ 231 { IFM_ETHER, "Ethernet" }, \ 232 { IFM_TOKEN, "Token ring" }, \ 233 { IFM_FDDI, "FDDI" }, \ 234 { 0, NULL }, \ 235} 236 237#define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS { \ 238 { IFM_10_T, "10baseT/UTP" }, \ 239 { IFM_10_2, "10base2/BNC" }, \ 240 { IFM_10_5, "10base5/AUI" }, \ 241 { IFM_100_TX, "100baseTX" }, \ 242 { IFM_100_FX, "100baseFX" }, \ 243 { IFM_100_T4, "100baseT4" }, \ 244 { IFM_100_VG, "100baseVG" }, \ 245 { IFM_100_T2, "100baseT2" }, \ 246 { IFM_1000_FX, "1000baseFX" }, \ 247 { IFM_10_STP, "10baseSTP" }, \ 248 { IFM_10_FL, "10baseFL" }, \ 249 { IFM_1000_SX, "1000baseSX" }, \ 250 { IFM_1000_LX, "1000baseLX" }, \ 251 { IFM_1000_CX, "1000baseCX" }, \ 252 { IFM_1000_TX, "1000baseTX" }, \ 253 { 0, NULL }, \ 254} 255 256#define IFM_SUBTYPE_ETHERNET_ALIASES { \ 257 { IFM_10_T, "UTP" }, \ 258 { IFM_10_T, "10UTP" }, \ 259 { IFM_10_2, "BNC" }, \ 260 { IFM_10_2, "10BNC" }, \ 261 { IFM_10_5, "AUI" }, \ 262 { IFM_10_5, "10AUI" }, \ 263 { IFM_100_TX, "100TX" }, \ 264 { IFM_100_FX, "100FX" }, \ 265 { IFM_100_T4, "100T4" }, \ 266 { IFM_100_VG, "100VG" }, \ 267 { IFM_100_T2, "100T2" }, \ 268 { IFM_1000_FX, "1000FX" }, \ 269 { IFM_10_STP, "10STP" }, \ 270 { IFM_10_FL, "10FL" }, \ 271 { IFM_1000_FX, "1000SX" }, \ 272 { IFM_1000_FX, "1000LX" }, \ 273 { IFM_1000_FX, "1000CX" }, \ 274 { IFM_1000_FX, "1000TX" }, \ 275 { 0, NULL }, \ 276} 277 278#define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS { \ 279 { 0, NULL }, \ 280} 281 282#define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS { \ 283 { IFM_TOK_STP4, "DB9/4Mbit" }, \ 284 { IFM_TOK_STP16, "DB9/16Mbit" }, \ 285 { IFM_TOK_UTP4, "UTP/4Mbit" }, \ 286 { IFM_TOK_UTP16, "UTP/16Mbit" }, \ 287 { IFM_TOK_STP100, "STP/100Mbit" }, \ 288 { IFM_TOK_UTP100, "UTP/100Mbit" }, \ 289 { 0, NULL }, \ 290} 291 292#define IFM_SUBTYPE_TOKENRING_ALIASES { \ 293 { IFM_TOK_STP4, "4STP" }, \ 294 { IFM_TOK_STP16, "16STP" }, \ 295 { IFM_TOK_UTP4, "4UTP" }, \ 296 { IFM_TOK_UTP16, "16UTP" }, \ 297 { IFM_TOK_STP100, "100STP" }, \ 298 { IFM_TOK_UTP100, "100UTP" }, \ 299 { 0, NULL }, \ 300} 301 302#define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS { \ 303 { IFM_TOK_ETR, "EarlyTokenRelease" }, \ 304 { IFM_TOK_SRCRT, "SourceRouting" }, \ 305 { IFM_TOK_ALLR, "AllRoutes" }, \ 306 { IFM_TOK_DTR, "Dedicated" }, \ 307 { IFM_TOK_CLASSIC,"Classic" }, \ 308 { IFM_TOK_AUTO, " " }, \ 309 { 0, NULL }, \ 310} 311 312#define IFM_SUBTYPE_FDDI_DESCRIPTIONS { \ 313 { IFM_FDDI_SMF, "Single-mode" }, \ 314 { IFM_FDDI_MMF, "Multi-mode" }, \ 315 { IFM_FDDI_UTP, "UTP" }, \ 316 { 0, NULL }, \ 317} 318 319#define IFM_SUBTYPE_FDDI_ALIASES { \ 320 { IFM_FDDI_SMF, "SMF" }, \ 321 { IFM_FDDI_MMF, "MMF" }, \ 322 { IFM_FDDI_UTP, "CDDI" }, \ 323 { 0, NULL }, \ 324} 325 326#define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS { \ 327 { IFM_FDDI_DA, "Dual-attach" }, \ 328 { 0, NULL }, \ 329} 330 331#define IFM_SUBTYPE_SHARED_DESCRIPTIONS { \ 332 { IFM_AUTO, "autoselect" }, \ 333 { IFM_MANUAL, "manual" }, \ 334 { IFM_NONE, "none" }, \ 335 { 0, NULL }, \ 336} 337 338#define IFM_SUBTYPE_SHARED_ALIASES { \ 339 { IFM_AUTO, "auto" }, \ 340 { 0, NULL }, \ 341} 342 343#define IFM_SHARED_OPTION_DESCRIPTIONS { \ 344 { IFM_FDX, "full-duplex" }, \ 345 { IFM_HDX, "half-duplex" }, \ 346 { IFM_FLAG0, "flag0" }, \ 347 { IFM_FLAG1, "flag1" }, \ 348 { IFM_FLAG2, "flag2" }, \ 349 { IFM_LOOP, "hw-loopback" }, \ 350 { 0, NULL }, \ 351} 352 353#endif /* _NET_IF_MEDIA_H_ */ 354