664a31e496
is an application space macro and the applications are supposed to be free to use it as they please (but cannot). This is consistant with the other BSD's who made this change quite some time ago. More commits to come.
356 lines
12 KiB
C
356 lines
12 KiB
C
/* $NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $ */
|
|
/* $FreeBSD$ */
|
|
|
|
/*
|
|
* Copyright (c) 1997
|
|
* Jonathan Stone and Jason R. Thorpe. All rights reserved.
|
|
*
|
|
* This software is derived from information provided by Matt Thomas.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
* This product includes software developed by Jonathan Stone
|
|
* and Jason R. Thorpe for the NetBSD Project.
|
|
* 4. The names of the authors may not be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef _NET_IF_MEDIA_H_
|
|
#define _NET_IF_MEDIA_H_
|
|
|
|
/*
|
|
* Prototypes and definitions for BSD/OS-compatible network interface
|
|
* media selection.
|
|
*
|
|
* Where it is safe to do so, this code strays slightly from the BSD/OS
|
|
* design. Software which uses the API (device drivers, basically)
|
|
* shouldn't notice any difference.
|
|
*
|
|
* Many thanks to Matt Thomas for providing the information necessary
|
|
* to implement this interface.
|
|
*/
|
|
|
|
#ifdef _KERNEL
|
|
|
|
#include <sys/queue.h>
|
|
|
|
/*
|
|
* Driver callbacks for media status and change requests.
|
|
*/
|
|
typedef int (*ifm_change_cb_t) __P((struct ifnet *ifp));
|
|
typedef void (*ifm_stat_cb_t) __P((struct ifnet *ifp, struct ifmediareq *req));
|
|
|
|
/*
|
|
* In-kernel representation of a single supported media type.
|
|
*/
|
|
struct ifmedia_entry {
|
|
LIST_ENTRY(ifmedia_entry) ifm_list;
|
|
int ifm_media; /* description of this media attachment */
|
|
int ifm_data; /* for driver-specific use */
|
|
void *ifm_aux; /* for driver-specific use */
|
|
};
|
|
|
|
/*
|
|
* One of these goes into a network interface's softc structure.
|
|
* It is used to keep general media state.
|
|
*/
|
|
struct ifmedia {
|
|
int ifm_mask; /* mask of changes we don't care about */
|
|
int ifm_media; /* current user-set media word */
|
|
struct ifmedia_entry *ifm_cur; /* currently selected media */
|
|
LIST_HEAD(, ifmedia_entry) ifm_list; /* list of all supported media */
|
|
ifm_change_cb_t ifm_change; /* media change driver callback */
|
|
ifm_stat_cb_t ifm_status; /* media status driver callback */
|
|
};
|
|
|
|
/* Initialize an interface's struct if_media field. */
|
|
void ifmedia_init __P((struct ifmedia *ifm, int dontcare_mask,
|
|
ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback));
|
|
|
|
/* Remove all mediums from a struct ifmedia. */
|
|
void ifmedia_removeall __P(( struct ifmedia *ifm));
|
|
|
|
/* Add one supported medium to a struct ifmedia. */
|
|
void ifmedia_add __P((struct ifmedia *ifm, int mword, int data, void *aux));
|
|
|
|
/* Add an array (of ifmedia_entry) media to a struct ifmedia. */
|
|
void ifmedia_list_add(struct ifmedia *mp, struct ifmedia_entry *lp,
|
|
int count);
|
|
|
|
/* Set default media type on initialization. */
|
|
void ifmedia_set __P((struct ifmedia *ifm, int mword));
|
|
|
|
/* Common ioctl function for getting/setting media, called by driver. */
|
|
int ifmedia_ioctl __P((struct ifnet *ifp, struct ifreq *ifr,
|
|
struct ifmedia *ifm, u_long cmd));
|
|
|
|
#endif /*_KERNEL */
|
|
|
|
/*
|
|
* if_media Options word:
|
|
* Bits Use
|
|
* ---- -------
|
|
* 0-4 Media variant
|
|
* 5-7 Media type
|
|
* 8-15 Type specific options
|
|
* 16-19 RFU
|
|
* 20-27 Shared (global) options
|
|
* 28-31 Instance
|
|
*/
|
|
|
|
/*
|
|
* Ethernet
|
|
*/
|
|
#define IFM_ETHER 0x00000020
|
|
#define IFM_10_T 3 /* 10BaseT - RJ45 */
|
|
#define IFM_10_2 4 /* 10Base2 - Thinnet */
|
|
#define IFM_10_5 5 /* 10Base5 - AUI */
|
|
#define IFM_100_TX 6 /* 100BaseTX - RJ45 */
|
|
#define IFM_100_FX 7 /* 100BaseFX - Fiber */
|
|
#define IFM_100_T4 8 /* 100BaseT4 - 4 pair cat 3 */
|
|
#define IFM_100_VG 9 /* 100VG-AnyLAN */
|
|
#define IFM_100_T2 10 /* 100BaseT2 */
|
|
#define IFM_1000_FX 11 /* 1000BaseFX - gigabit over fiber */
|
|
#define IFM_10_STP 12 /* 10BaseT over shielded TP */
|
|
#define IFM_10_FL 13 /* 10baseFL - Fiber */
|
|
#define IFM_1000_SX 14 /* 1000BaseSX Multi-mode Fiber */
|
|
#define IFM_1000_LX 15 /* 1000BaseLX Single-mode Fiber */
|
|
#define IFM_1000_CX 16 /* 1000BaseCX 150ohm STP */
|
|
#define IFM_1000_TX 17 /* 1000BaseTX 4 pair cat 5 */
|
|
#define IFM_homePNA 18 /* HomePNA media for ethernet frames */
|
|
/* note 31 is the max! */
|
|
|
|
/*
|
|
* Token ring
|
|
*/
|
|
#define IFM_TOKEN 0x00000040
|
|
#define IFM_TOK_STP4 3 /* Shielded twisted pair 4m - DB9 */
|
|
#define IFM_TOK_STP16 4 /* Shielded twisted pair 16m - DB9 */
|
|
#define IFM_TOK_UTP4 5 /* Unshielded twisted pair 4m - RJ45 */
|
|
#define IFM_TOK_UTP16 6 /* Unshielded twisted pair 16m - RJ45 */
|
|
#define IFM_TOK_STP100 7 /* Shielded twisted pair 100m - DB9 */
|
|
#define IFM_TOK_UTP100 8 /* Unshielded twisted pair 100m - RJ45 */
|
|
#define IFM_TOK_ETR 0x00000200 /* Early token release */
|
|
#define IFM_TOK_SRCRT 0x00000400 /* Enable source routing features */
|
|
#define IFM_TOK_ALLR 0x00000800 /* All routes / Single route bcast */
|
|
#define IFM_TOK_DTR 0x00002000 /* Dedicated token ring */
|
|
#define IFM_TOK_CLASSIC 0x00004000 /* Classic token ring */
|
|
#define IFM_TOK_AUTO 0x00008000 /* Automatic Dedicate/Classic token ring */
|
|
|
|
/*
|
|
* FDDI
|
|
*/
|
|
#define IFM_FDDI 0x00000060
|
|
#define IFM_FDDI_SMF 3 /* Single-mode fiber */
|
|
#define IFM_FDDI_MMF 4 /* Multi-mode fiber */
|
|
#define IFM_FDDI_UTP 5 /* CDDI / UTP */
|
|
#define IFM_FDDI_DA 0x00000100 /* Dual attach / single attach */
|
|
|
|
/*
|
|
* Shared media sub-types
|
|
*/
|
|
#define IFM_AUTO 0 /* Autoselect best media */
|
|
#define IFM_MANUAL 1 /* Jumper/dipswitch selects media */
|
|
#define IFM_NONE 2 /* Deselect all media */
|
|
|
|
/*
|
|
* Shared options
|
|
*/
|
|
#define IFM_FDX 0x00100000 /* Force full duplex */
|
|
#define IFM_HDX 0x00200000 /* Force half duplex */
|
|
#define IFM_FLAG0 0x01000000 /* Driver defined flag */
|
|
#define IFM_FLAG1 0x02000000 /* Driver defined flag */
|
|
#define IFM_FLAG2 0x04000000 /* Driver defined flag */
|
|
#define IFM_LOOP 0x08000000 /* Put hardware in loopback */
|
|
|
|
/*
|
|
* Masks
|
|
*/
|
|
#define IFM_NMASK 0x000000e0 /* Network type */
|
|
#define IFM_TMASK 0x0000001f /* Media sub-type */
|
|
#define IFM_IMASK 0xf0000000 /* Instance */
|
|
#define IFM_ISHIFT 28 /* Instance shift */
|
|
#define IFM_OMASK 0x0000ff00 /* Type specific options */
|
|
#define IFM_GMASK 0x0ff00000 /* Global options */
|
|
|
|
/*
|
|
* Status bits
|
|
*/
|
|
#define IFM_AVALID 0x00000001 /* Active bit valid */
|
|
#define IFM_ACTIVE 0x00000002 /* Interface attached to working net */
|
|
|
|
/*
|
|
* Macros to extract various bits of information from the media word.
|
|
*/
|
|
#define IFM_TYPE(x) ((x) & IFM_NMASK)
|
|
#define IFM_SUBTYPE(x) ((x) & IFM_TMASK)
|
|
#define IFM_TYPE_OPTIONS(x) ((x) & IFM_OMASK)
|
|
#define IFM_INST(x) (((x) & IFM_IMASK) >> IFM_ISHIFT)
|
|
#define IFM_OPTIONS(x) ((x) & (IFM_OMASK|IFM_GMASK))
|
|
|
|
#define IFM_INST_MAX IFM_INST(IFM_IMASK)
|
|
|
|
/*
|
|
* Macro to create a media word.
|
|
*/
|
|
#define IFM_MAKEWORD(type, subtype, options, instance) \
|
|
((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT))
|
|
|
|
/*
|
|
* NetBSD extension not defined in the BSDI API. This is used in various
|
|
* places to get the canonical description for a given type/subtype.
|
|
*
|
|
* NOTE: all but the top-level type descriptions must contain NO whitespace!
|
|
* Otherwise, parsing these in ifconfig(8) would be a nightmare.
|
|
*/
|
|
struct ifmedia_description {
|
|
int ifmt_word; /* word value; may be masked */
|
|
const char *ifmt_string; /* description */
|
|
};
|
|
|
|
#define IFM_TYPE_DESCRIPTIONS { \
|
|
{ IFM_ETHER, "Ethernet" }, \
|
|
{ IFM_TOKEN, "Token ring" }, \
|
|
{ IFM_FDDI, "FDDI" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS { \
|
|
{ IFM_10_T, "10baseT/UTP" }, \
|
|
{ IFM_10_2, "10base2/BNC" }, \
|
|
{ IFM_10_5, "10base5/AUI" }, \
|
|
{ IFM_100_TX, "100baseTX" }, \
|
|
{ IFM_100_FX, "100baseFX" }, \
|
|
{ IFM_100_T4, "100baseT4" }, \
|
|
{ IFM_100_VG, "100baseVG" }, \
|
|
{ IFM_100_T2, "100baseT2" }, \
|
|
{ IFM_1000_FX, "1000baseFX" }, \
|
|
{ IFM_10_STP, "10baseSTP" }, \
|
|
{ IFM_10_FL, "10baseFL" }, \
|
|
{ IFM_1000_SX, "1000baseSX" }, \
|
|
{ IFM_1000_LX, "1000baseLX" }, \
|
|
{ IFM_1000_CX, "1000baseCX" }, \
|
|
{ IFM_1000_TX, "1000baseTX" }, \
|
|
{ IFM_homePNA, "homePNA" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_ETHERNET_ALIASES { \
|
|
{ IFM_10_T, "UTP" }, \
|
|
{ IFM_10_T, "10UTP" }, \
|
|
{ IFM_10_2, "BNC" }, \
|
|
{ IFM_10_2, "10BNC" }, \
|
|
{ IFM_10_5, "AUI" }, \
|
|
{ IFM_10_5, "10AUI" }, \
|
|
{ IFM_100_TX, "100TX" }, \
|
|
{ IFM_100_FX, "100FX" }, \
|
|
{ IFM_100_T4, "100T4" }, \
|
|
{ IFM_100_VG, "100VG" }, \
|
|
{ IFM_100_T2, "100T2" }, \
|
|
{ IFM_1000_FX, "1000FX" }, \
|
|
{ IFM_10_STP, "10STP" }, \
|
|
{ IFM_10_FL, "10FL" }, \
|
|
{ IFM_1000_FX, "1000SX" }, \
|
|
{ IFM_1000_FX, "1000LX" }, \
|
|
{ IFM_1000_FX, "1000CX" }, \
|
|
{ IFM_1000_FX, "1000TX" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS { \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS { \
|
|
{ IFM_TOK_STP4, "DB9/4Mbit" }, \
|
|
{ IFM_TOK_STP16, "DB9/16Mbit" }, \
|
|
{ IFM_TOK_UTP4, "UTP/4Mbit" }, \
|
|
{ IFM_TOK_UTP16, "UTP/16Mbit" }, \
|
|
{ IFM_TOK_STP100, "STP/100Mbit" }, \
|
|
{ IFM_TOK_UTP100, "UTP/100Mbit" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_TOKENRING_ALIASES { \
|
|
{ IFM_TOK_STP4, "4STP" }, \
|
|
{ IFM_TOK_STP16, "16STP" }, \
|
|
{ IFM_TOK_UTP4, "4UTP" }, \
|
|
{ IFM_TOK_UTP16, "16UTP" }, \
|
|
{ IFM_TOK_STP100, "100STP" }, \
|
|
{ IFM_TOK_UTP100, "100UTP" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS { \
|
|
{ IFM_TOK_ETR, "EarlyTokenRelease" }, \
|
|
{ IFM_TOK_SRCRT, "SourceRouting" }, \
|
|
{ IFM_TOK_ALLR, "AllRoutes" }, \
|
|
{ IFM_TOK_DTR, "Dedicated" }, \
|
|
{ IFM_TOK_CLASSIC,"Classic" }, \
|
|
{ IFM_TOK_AUTO, " " }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_FDDI_DESCRIPTIONS { \
|
|
{ IFM_FDDI_SMF, "Single-mode" }, \
|
|
{ IFM_FDDI_MMF, "Multi-mode" }, \
|
|
{ IFM_FDDI_UTP, "UTP" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_FDDI_ALIASES { \
|
|
{ IFM_FDDI_SMF, "SMF" }, \
|
|
{ IFM_FDDI_MMF, "MMF" }, \
|
|
{ IFM_FDDI_UTP, "CDDI" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS { \
|
|
{ IFM_FDDI_DA, "Dual-attach" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_SHARED_DESCRIPTIONS { \
|
|
{ IFM_AUTO, "autoselect" }, \
|
|
{ IFM_MANUAL, "manual" }, \
|
|
{ IFM_NONE, "none" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SUBTYPE_SHARED_ALIASES { \
|
|
{ IFM_AUTO, "auto" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#define IFM_SHARED_OPTION_DESCRIPTIONS { \
|
|
{ IFM_FDX, "full-duplex" }, \
|
|
{ IFM_HDX, "half-duplex" }, \
|
|
{ IFM_FLAG0, "flag0" }, \
|
|
{ IFM_FLAG1, "flag1" }, \
|
|
{ IFM_FLAG2, "flag2" }, \
|
|
{ IFM_LOOP, "hw-loopback" }, \
|
|
{ 0, NULL }, \
|
|
}
|
|
|
|
#endif /* _NET_IF_MEDIA_H_ */
|