if_media.h revision 53649
125428Speter/* $NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $ */ 250477Speter/* $FreeBSD: head/sys/net/if_media.h 53649 1999-11-24 02:40:12Z julian $ */ 325428Speter 425428Speter/* 525428Speter * Copyright (c) 1997 625428Speter * Jonathan Stone and Jason R. Thorpe. All rights reserved. 725428Speter * 825428Speter * This software is derived from information provided by Matt Thomas. 925428Speter * 1025428Speter * Redistribution and use in source and binary forms, with or without 1125428Speter * modification, are permitted provided that the following conditions 1225428Speter * are met: 1325428Speter * 1. Redistributions of source code must retain the above copyright 1425428Speter * notice, this list of conditions and the following disclaimer. 1525428Speter * 2. Redistributions in binary form must reproduce the above copyright 1625428Speter * notice, this list of conditions and the following disclaimer in the 1725428Speter * documentation and/or other materials provided with the distribution. 1825428Speter * 3. All advertising materials mentioning features or use of this software 1925428Speter * must display the following acknowledgement: 2025428Speter * This product includes software developed by Jonathan Stone 2125428Speter * and Jason R. Thorpe for the NetBSD Project. 2225428Speter * 4. The names of the authors may not be used to endorse or promote products 2325428Speter * derived from this software without specific prior written permission. 2425428Speter * 2525428Speter * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 2625428Speter * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 2725428Speter * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 2825428Speter * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 2925428Speter * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 3025428Speter * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 3125428Speter * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 3225428Speter * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 3325428Speter * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3425428Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3525428Speter * SUCH DAMAGE. 3625428Speter */ 3725428Speter 3825428Speter#ifndef _NET_IF_MEDIA_H_ 3925428Speter#define _NET_IF_MEDIA_H_ 4025428Speter 4125428Speter/* 4225428Speter * Prototypes and definitions for BSD/OS-compatible network interface 4325428Speter * media selection. 4425428Speter * 4525428Speter * Where it is safe to do so, this code strays slightly from the BSD/OS 4625428Speter * design. Software which uses the API (device drivers, basically) 4725428Speter * shouldn't notice any difference. 4825428Speter * 4925428Speter * Many thanks to Matt Thomas for providing the information necessary 5025428Speter * to implement this interface. 5125428Speter */ 5225428Speter 5325431Speter#ifdef KERNEL 5425428Speter 5525428Speter#include <sys/queue.h> 5625428Speter 5725428Speter/* 5825428Speter * Driver callbacks for media status and change requests. 5925428Speter */ 6025428Spetertypedef int (*ifm_change_cb_t) __P((struct ifnet *ifp)); 6125428Spetertypedef void (*ifm_stat_cb_t) __P((struct ifnet *ifp, struct ifmediareq *req)); 6225428Speter 6325428Speter/* 6425428Speter * In-kernel representation of a single supported media type. 6525428Speter */ 6625428Speterstruct ifmedia_entry { 6725428Speter LIST_ENTRY(ifmedia_entry) ifm_list; 6825428Speter int ifm_media; /* description of this media attachment */ 6925428Speter int ifm_data; /* for driver-specific use */ 7025428Speter void *ifm_aux; /* for driver-specific use */ 7125428Speter}; 7225428Speter 7325428Speter/* 7425428Speter * One of these goes into a network interface's softc structure. 7525428Speter * It is used to keep general media state. 7625428Speter */ 7725428Speterstruct ifmedia { 7825428Speter int ifm_mask; /* mask of changes we don't care about */ 7925428Speter int ifm_media; /* current user-set media word */ 8025428Speter struct ifmedia_entry *ifm_cur; /* currently selected media */ 8125428Speter LIST_HEAD(, ifmedia_entry) ifm_list; /* list of all supported media */ 8225428Speter ifm_change_cb_t ifm_change; /* media change driver callback */ 8325428Speter ifm_stat_cb_t ifm_status; /* media status driver callback */ 8425428Speter}; 8525428Speter 8625428Speter/* Initialize an interface's struct if_media field. */ 8725428Spetervoid ifmedia_init __P((struct ifmedia *ifm, int dontcare_mask, 8825428Speter ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback)); 8925428Speter 9045720Speter/* Remove all mediums from a struct ifmedia. */ 9145720Spetervoid ifmedia_removeall __P(( struct ifmedia *ifm)); 9245720Speter 9325428Speter/* Add one supported medium to a struct ifmedia. */ 9425428Spetervoid ifmedia_add __P((struct ifmedia *ifm, int mword, int data, void *aux)); 9525428Speter 9625428Speter/* Add an array (of ifmedia_entry) media to a struct ifmedia. */ 9725428Spetervoid ifmedia_list_add(struct ifmedia *mp, struct ifmedia_entry *lp, 9825428Speter int count); 9925428Speter 10025428Speter/* Set default media type on initialization. */ 10125428Spetervoid ifmedia_set __P((struct ifmedia *ifm, int mword)); 10225428Speter 10325428Speter/* Common ioctl function for getting/setting media, called by driver. */ 10425428Speterint ifmedia_ioctl __P((struct ifnet *ifp, struct ifreq *ifr, 10525428Speter struct ifmedia *ifm, u_long cmd)); 10625428Speter 10725431Speter#endif /*KERNEL */ 10825428Speter 10925428Speter/* 11025428Speter * if_media Options word: 11125428Speter * Bits Use 11225428Speter * ---- ------- 11353649Sjulian * 0-4 Media variant 11425428Speter * 5-7 Media type 11525428Speter * 8-15 Type specific options 11625428Speter * 16-19 RFU 11725428Speter * 20-27 Shared (global) options 11825428Speter * 28-31 Instance 11925428Speter */ 12025428Speter 12125428Speter/* 12225428Speter * Ethernet 12325428Speter */ 12425428Speter#define IFM_ETHER 0x00000020 12525428Speter#define IFM_10_T 3 /* 10BaseT - RJ45 */ 12625428Speter#define IFM_10_2 4 /* 10Base2 - Thinnet */ 12725428Speter#define IFM_10_5 5 /* 10Base5 - AUI */ 12825428Speter#define IFM_100_TX 6 /* 100BaseTX - RJ45 */ 12925428Speter#define IFM_100_FX 7 /* 100BaseFX - Fiber */ 13025428Speter#define IFM_100_T4 8 /* 100BaseT4 - 4 pair cat 3 */ 13125428Speter#define IFM_100_VG 9 /* 100VG-AnyLAN */ 13225428Speter#define IFM_100_T2 10 /* 100BaseT2 */ 13344521Swpaul#define IFM_1000_FX 11 /* 1000BaseFX - gigabit over fiber */ 13444521Swpaul#define IFM_10_STP 12 /* 10BaseT over shielded TP */ 13544521Swpaul#define IFM_10_FL 13 /* 10baseFL - Fiber */ 13644542Swpaul#define IFM_1000_SX 14 /* 1000BaseSX Multi-mode Fiber */ 13744542Swpaul#define IFM_1000_LX 15 /* 1000BaseLX Single-mode Fiber */ 13844542Swpaul#define IFM_1000_CX 16 /* 1000BaseCX 150ohm STP */ 13944542Swpaul#define IFM_1000_TX 17 /* 1000BaseTX 4 pair cat 5 */ 14053649Sjulian#define IFM_homePNA 18 /* HomePNA media for ethernet frames */ 14153649Sjulian/* note 31 is the max! */ 14225428Speter 14325428Speter/* 14425428Speter * Token ring 14525428Speter */ 14625428Speter#define IFM_TOKEN 0x00000040 14725428Speter#define IFM_TOK_STP4 3 /* Shielded twisted pair 4m - DB9 */ 14825428Speter#define IFM_TOK_STP16 4 /* Shielded twisted pair 16m - DB9 */ 14925428Speter#define IFM_TOK_UTP4 5 /* Unshielded twisted pair 4m - RJ45 */ 15025428Speter#define IFM_TOK_UTP16 6 /* Unshielded twisted pair 16m - RJ45 */ 15144165Sjulian#define IFM_TOK_STP100 7 /* Shielded twisted pair 100m - DB9 */ 15244165Sjulian#define IFM_TOK_UTP100 8 /* Unshielded twisted pair 100m - RJ45 */ 15325428Speter#define IFM_TOK_ETR 0x00000200 /* Early token release */ 15425428Speter#define IFM_TOK_SRCRT 0x00000400 /* Enable source routing features */ 15525428Speter#define IFM_TOK_ALLR 0x00000800 /* All routes / Single route bcast */ 15644165Sjulian#define IFM_TOK_DTR 0x00002000 /* Dedicated token ring */ 15744165Sjulian#define IFM_TOK_CLASSIC 0x00004000 /* Classic token ring */ 15844165Sjulian#define IFM_TOK_AUTO 0x00008000 /* Automatic Dedicate/Classic token ring */ 15925428Speter 16025428Speter/* 16125428Speter * FDDI 16225428Speter */ 16325428Speter#define IFM_FDDI 0x00000060 16425428Speter#define IFM_FDDI_SMF 3 /* Single-mode fiber */ 16525428Speter#define IFM_FDDI_MMF 4 /* Multi-mode fiber */ 16625428Speter#define IFM_FDDI_UTP 5 /* CDDI / UTP */ 16725428Speter#define IFM_FDDI_DA 0x00000100 /* Dual attach / single attach */ 16825428Speter 16925428Speter/* 17025428Speter * Shared media sub-types 17125428Speter */ 17225428Speter#define IFM_AUTO 0 /* Autoselect best media */ 17325428Speter#define IFM_MANUAL 1 /* Jumper/dipswitch selects media */ 17425428Speter#define IFM_NONE 2 /* Deselect all media */ 17525428Speter 17625428Speter/* 17725428Speter * Shared options 17825428Speter */ 17925428Speter#define IFM_FDX 0x00100000 /* Force full duplex */ 18025428Speter#define IFM_HDX 0x00200000 /* Force half duplex */ 18125428Speter#define IFM_FLAG0 0x01000000 /* Driver defined flag */ 18225428Speter#define IFM_FLAG1 0x02000000 /* Driver defined flag */ 18325428Speter#define IFM_FLAG2 0x04000000 /* Driver defined flag */ 18425428Speter#define IFM_LOOP 0x08000000 /* Put hardware in loopback */ 18525428Speter 18625428Speter/* 18725428Speter * Masks 18825428Speter */ 18925428Speter#define IFM_NMASK 0x000000e0 /* Network type */ 19053649Sjulian#define IFM_TMASK 0x0000001f /* Media sub-type */ 19125428Speter#define IFM_IMASK 0xf0000000 /* Instance */ 19225428Speter#define IFM_ISHIFT 28 /* Instance shift */ 19325428Speter#define IFM_OMASK 0x0000ff00 /* Type specific options */ 19425428Speter#define IFM_GMASK 0x0ff00000 /* Global options */ 19525428Speter 19625428Speter/* 19725428Speter * Status bits 19825428Speter */ 19925428Speter#define IFM_AVALID 0x00000001 /* Active bit valid */ 20025428Speter#define IFM_ACTIVE 0x00000002 /* Interface attached to working net */ 20125428Speter 20225428Speter/* 20325428Speter * Macros to extract various bits of information from the media word. 20425428Speter */ 20544165Sjulian#define IFM_TYPE(x) ((x) & IFM_NMASK) 20644165Sjulian#define IFM_SUBTYPE(x) ((x) & IFM_TMASK) 20744165Sjulian#define IFM_TYPE_OPTIONS(x) ((x) & IFM_OMASK) 20844165Sjulian#define IFM_INST(x) (((x) & IFM_IMASK) >> IFM_ISHIFT) 20944521Swpaul#define IFM_OPTIONS(x) ((x) & (IFM_OMASK|IFM_GMASK)) 21025428Speter 21144521Swpaul#define IFM_INST_MAX IFM_INST(IFM_IMASK) 21244521Swpaul 21325428Speter/* 21444521Swpaul * Macro to create a media word. 21544521Swpaul */ 21644521Swpaul#define IFM_MAKEWORD(type, subtype, options, instance) \ 21744521Swpaul ((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT)) 21844521Swpaul 21944521Swpaul/* 22025428Speter * NetBSD extension not defined in the BSDI API. This is used in various 22125428Speter * places to get the canonical description for a given type/subtype. 22225428Speter * 22325428Speter * NOTE: all but the top-level type descriptions must contain NO whitespace! 22425428Speter * Otherwise, parsing these in ifconfig(8) would be a nightmare. 22525428Speter */ 22625428Speterstruct ifmedia_description { 22725428Speter int ifmt_word; /* word value; may be masked */ 22825428Speter const char *ifmt_string; /* description */ 22925428Speter}; 23025428Speter 23125428Speter#define IFM_TYPE_DESCRIPTIONS { \ 23225428Speter { IFM_ETHER, "Ethernet" }, \ 23325428Speter { IFM_TOKEN, "Token ring" }, \ 23425428Speter { IFM_FDDI, "FDDI" }, \ 23525428Speter { 0, NULL }, \ 23625428Speter} 23725428Speter 23825428Speter#define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS { \ 23925428Speter { IFM_10_T, "10baseT/UTP" }, \ 24025428Speter { IFM_10_2, "10base2/BNC" }, \ 24125428Speter { IFM_10_5, "10base5/AUI" }, \ 24225428Speter { IFM_100_TX, "100baseTX" }, \ 24325428Speter { IFM_100_FX, "100baseFX" }, \ 24425428Speter { IFM_100_T4, "100baseT4" }, \ 24525428Speter { IFM_100_VG, "100baseVG" }, \ 24625428Speter { IFM_100_T2, "100baseT2" }, \ 24744521Swpaul { IFM_1000_FX, "1000baseFX" }, \ 24844521Swpaul { IFM_10_STP, "10baseSTP" }, \ 24944521Swpaul { IFM_10_FL, "10baseFL" }, \ 25044542Swpaul { IFM_1000_SX, "1000baseSX" }, \ 25144542Swpaul { IFM_1000_LX, "1000baseLX" }, \ 25244542Swpaul { IFM_1000_CX, "1000baseCX" }, \ 25344542Swpaul { IFM_1000_TX, "1000baseTX" }, \ 25453649Sjulian { IFM_homePNA, "homePNA" }, \ 25525428Speter { 0, NULL }, \ 25625428Speter} 25725428Speter 25825428Speter#define IFM_SUBTYPE_ETHERNET_ALIASES { \ 25925428Speter { IFM_10_T, "UTP" }, \ 26025428Speter { IFM_10_T, "10UTP" }, \ 26125428Speter { IFM_10_2, "BNC" }, \ 26225428Speter { IFM_10_2, "10BNC" }, \ 26325428Speter { IFM_10_5, "AUI" }, \ 26425428Speter { IFM_10_5, "10AUI" }, \ 26525428Speter { IFM_100_TX, "100TX" }, \ 26625428Speter { IFM_100_FX, "100FX" }, \ 26725428Speter { IFM_100_T4, "100T4" }, \ 26825428Speter { IFM_100_VG, "100VG" }, \ 26925428Speter { IFM_100_T2, "100T2" }, \ 27044521Swpaul { IFM_1000_FX, "1000FX" }, \ 27144521Swpaul { IFM_10_STP, "10STP" }, \ 27244521Swpaul { IFM_10_FL, "10FL" }, \ 27344542Swpaul { IFM_1000_FX, "1000SX" }, \ 27444542Swpaul { IFM_1000_FX, "1000LX" }, \ 27544542Swpaul { IFM_1000_FX, "1000CX" }, \ 27644542Swpaul { IFM_1000_FX, "1000TX" }, \ 27725428Speter { 0, NULL }, \ 27825428Speter} 27925428Speter 28025428Speter#define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS { \ 28125428Speter { 0, NULL }, \ 28225428Speter} 28325428Speter 28425428Speter#define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS { \ 28525428Speter { IFM_TOK_STP4, "DB9/4Mbit" }, \ 28625428Speter { IFM_TOK_STP16, "DB9/16Mbit" }, \ 28725428Speter { IFM_TOK_UTP4, "UTP/4Mbit" }, \ 28825428Speter { IFM_TOK_UTP16, "UTP/16Mbit" }, \ 28944165Sjulian { IFM_TOK_STP100, "STP/100Mbit" }, \ 29044165Sjulian { IFM_TOK_UTP100, "UTP/100Mbit" }, \ 29125428Speter { 0, NULL }, \ 29225428Speter} 29325428Speter 29425428Speter#define IFM_SUBTYPE_TOKENRING_ALIASES { \ 29525428Speter { IFM_TOK_STP4, "4STP" }, \ 29625428Speter { IFM_TOK_STP16, "16STP" }, \ 29725428Speter { IFM_TOK_UTP4, "4UTP" }, \ 29825428Speter { IFM_TOK_UTP16, "16UTP" }, \ 29944165Sjulian { IFM_TOK_STP100, "100STP" }, \ 30044165Sjulian { IFM_TOK_UTP100, "100UTP" }, \ 30125428Speter { 0, NULL }, \ 30225428Speter} 30325428Speter 30425428Speter#define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS { \ 30525428Speter { IFM_TOK_ETR, "EarlyTokenRelease" }, \ 30625428Speter { IFM_TOK_SRCRT, "SourceRouting" }, \ 30725428Speter { IFM_TOK_ALLR, "AllRoutes" }, \ 30844165Sjulian { IFM_TOK_DTR, "Dedicated" }, \ 30944165Sjulian { IFM_TOK_CLASSIC,"Classic" }, \ 31044165Sjulian { IFM_TOK_AUTO, " " }, \ 31125428Speter { 0, NULL }, \ 31225428Speter} 31325428Speter 31425428Speter#define IFM_SUBTYPE_FDDI_DESCRIPTIONS { \ 31525428Speter { IFM_FDDI_SMF, "Single-mode" }, \ 31625428Speter { IFM_FDDI_MMF, "Multi-mode" }, \ 31725428Speter { IFM_FDDI_UTP, "UTP" }, \ 31825428Speter { 0, NULL }, \ 31925428Speter} 32025428Speter 32125428Speter#define IFM_SUBTYPE_FDDI_ALIASES { \ 32225428Speter { IFM_FDDI_SMF, "SMF" }, \ 32325428Speter { IFM_FDDI_MMF, "MMF" }, \ 32425428Speter { IFM_FDDI_UTP, "CDDI" }, \ 32525428Speter { 0, NULL }, \ 32625428Speter} 32725428Speter 32825428Speter#define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS { \ 32925428Speter { IFM_FDDI_DA, "Dual-attach" }, \ 33025428Speter { 0, NULL }, \ 33125428Speter} 33225428Speter 33325428Speter#define IFM_SUBTYPE_SHARED_DESCRIPTIONS { \ 33425428Speter { IFM_AUTO, "autoselect" }, \ 33525428Speter { IFM_MANUAL, "manual" }, \ 33625428Speter { IFM_NONE, "none" }, \ 33725428Speter { 0, NULL }, \ 33825428Speter} 33925428Speter 34025428Speter#define IFM_SUBTYPE_SHARED_ALIASES { \ 34125428Speter { IFM_AUTO, "auto" }, \ 34225428Speter { 0, NULL }, \ 34325428Speter} 34425428Speter 34525428Speter#define IFM_SHARED_OPTION_DESCRIPTIONS { \ 34625428Speter { IFM_FDX, "full-duplex" }, \ 34725428Speter { IFM_HDX, "half-duplex" }, \ 34825428Speter { IFM_FLAG0, "flag0" }, \ 34925428Speter { IFM_FLAG1, "flag1" }, \ 35025428Speter { IFM_FLAG2, "flag2" }, \ 35125428Speter { IFM_LOOP, "hw-loopback" }, \ 35225428Speter { 0, NULL }, \ 35325428Speter} 35425428Speter 35525428Speter#endif /* _NET_IF_MEDIA_H_ */ 356