[apple/xnu.git] / bsd / net / if_media.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*	$NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $	*/
/* $FreeBSD: src/sys/net/if_media.h,v 1.9.2.1 2001/07/04 00:12:38 brooks Exp $ */

/*
 * 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_
#include <sys/appleapiopts.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_PRIVATE
#include <sys/queue.h>

/*
 * Driver callbacks for media status and change requests.
 */
typedef	int (*ifm_change_cb_t)(struct ifnet *ifp);
typedef	void (*ifm_stat_cb_t)(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(struct ifmedia *ifm, int dontcare_mask,
	    ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback);

/* Add one supported medium to a struct ifmedia. */
void	ifmedia_add(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(struct ifmedia *ifm, int mword);

/* Common ioctl function for getting/setting media, called by driver. */
int	ifmedia_ioctl(struct ifnet *ifp, struct ifreq *ifr,
	    struct ifmedia *ifm, uint32_t cmd);

#endif /* KERNEL_PRIVATE */

/*
 * if_media Options word:
 *	Bits	Use
 *	----	-------
 *	0-4	    Media subtype
 *	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_SX	11		/* 1000BaseSX - multi-mode fiber */
#define IFM_10_STP	12		/* 10BaseT over shielded TP */
#define IFM_10_FL	13		/* 10baseFL - Fiber */
#define	IFM_1000_LX	14		/* 1000baseLX - single-mode fiber */
#define	IFM_1000_CX	15		/* 1000baseCX - 150ohm STP */
#define	IFM_1000_T	16		/* 1000baseT - 4 pair cat 5 */
#ifdef PRIVATE
#define	IFM_1000_TX	IFM_1000_T	/* For compatibility */
#endif /* PRIVATE */
#define	IFM_HPNA_1	17		/* HomePNA 1.0 (1Mb/s) */
#define	IFM_10G_SR	18		/* 10GbaseSR - multi-mode fiber */
#define	IFM_10G_LR	19		/* 10GbaseLR - single-mode fiber */
#define	IFM_10G_CX4	20		/* 10GbaseCX4 - copper */
#define	IFM_10G_T	21		/* 10GbaseT - 4 pair cat 6 */

/*
 * 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 */

/*
 * IEEE 802.11 Wireless
 */
#define	IFM_IEEE80211	0x00000080
#define	IFM_IEEE80211_FH1	3	/* Frequency Hopping 1Mbps */
#define	IFM_IEEE80211_FH2	4	/* Frequency Hopping 2Mbps */
#define	IFM_IEEE80211_DS2	5	/* Direct Sequence 2Mbps */
#define	IFM_IEEE80211_DS5	6	/* Direct Sequence 5Mbps*/
#define	IFM_IEEE80211_DS11	7	/* Direct Sequence 11Mbps*/
#define	IFM_IEEE80211_DS1	8	/* Direct Sequence 1Mbps */
#define IFM_IEEE80211_DS22	9	/* Direct Sequence 22Mbps */
#define	IFM_IEEE80211_ADHOC	0x00000100	/* Operate in Adhoc mode */

/*
 * 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_FLOW	0x00400000	/* enable hardware flow control */
#define IFM_EEE		0x00800000	/* Driver defined flag */
#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"       },                \
    { IFM_IEEE80211, "IEEE802.11" },                \
    { 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_SX,  "1000baseSX"  },                \
    { IFM_10_STP,   "10baseSTP"   },                \
    { IFM_10_FL,    "10baseFL"    },                \
    { IFM_1000_LX,  "1000baseLX"  },                \
    { IFM_1000_CX,  "1000baseCX"  },                \
    { IFM_1000_T,   "1000baseT"   },                \
    { IFM_HPNA_1,   "HomePNA1"    },                \
    { IFM_10G_SR,   "10GbaseSR"   },                \
    { IFM_10G_LR,   "10GbaseLR"   },                \
    { IFM_10G_CX4,  "10GbaseCX4"  },                \
    { IFM_10G_T,    "10GbaseT"    },                \
    { 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_SX,  "1000SX" },                     \
    { IFM_10_STP,   "STP"    },                     \
    { IFM_10_STP,   "10STP"  },                     \
    { IFM_10_FL,    "FL"     },                     \
    { IFM_10_FL,    "10FL"   },                     \
    { IFM_1000_LX,  "1000LX" },                     \
    { IFM_1000_CX,  "1000CX" },                     \
    { IFM_1000_T,   "1000T"  },                     \
    { IFM_HPNA_1,   "HPNA1"  },                     \
    { IFM_10G_SR,   "10GSR"  },                     \
    { IFM_10G_LR,   "10GLR"  },                     \
    { IFM_10G_CX4,  "10GCX4" },                     \
    { IFM_10G_T,    "10GT"   },                     \
    { 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" },                \
    { 0, NULL },                                    \
}

#define IFM_SUBTYPE_TOKENRING_ALIASES {             \
    { IFM_TOK_STP4,  "4STP" },                      \
    { IFM_TOK_STP16, "16STP" },                     \
    { IFM_TOK_UTP4,  "4UTP" },                      \
    { IFM_TOK_UTP16, "16UTP" },                     \
    { 0, NULL },                                    \
}

#define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS { \
    { IFM_TOK_ETR,   "EarlyTokenRelease" },         \
    { IFM_TOK_SRCRT, "SourceRouting" },             \
    { IFM_TOK_ALLR,  "AllRoutes" },                 \
    { 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_IEEE80211_DESCRIPTIONS {        \
    { IFM_IEEE80211_FH1,  "FH1"  },                 \
    { IFM_IEEE80211_FH2,  "FH2"  },                 \
    { IFM_IEEE80211_DS1,  "DS1"  },                 \
    { IFM_IEEE80211_DS2,  "DS2"  },                 \
    { IFM_IEEE80211_DS5,  "DS5"  },                 \
    { IFM_IEEE80211_DS11, "DS11" },                 \
    { IFM_IEEE80211_DS22, "DS22" },                 \
    { 0, NULL },                                    \
}

#define IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS { \
    { IFM_IEEE80211_ADHOC,  "adhoc" },              \
    { 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_FLOW,     "flow-control" },               \
    { IFM_EEE,	    "energy-efficient-ethernet" },  \
    { IFM_FLAG0,    "flag0" },                      \
    { IFM_FLAG1,    "flag1" },                      \
    { IFM_FLAG2,    "flag2" },                      \
    { IFM_LOOP,     "hw-loopback" },                \
    { 0, NULL },                                    \
}

#endif	/* _NET_IF_MEDIA_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
1c79356b A	28	/* $NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $ */
9bccf70c	29	/* $FreeBSD: src/sys/net/if_media.h,v 1.9.2.1 2001/07/04 00:12:38 brooks Exp $ */
1c79356b A	30
	31	/*
	32	* Copyright (c) 1997
	33	* Jonathan Stone and Jason R. Thorpe. All rights reserved.
	34	*
	35	* This software is derived from information provided by Matt Thomas.
	36	*
	37	* Redistribution and use in source and binary forms, with or without
	38	* modification, are permitted provided that the following conditions
	39	* are met:
	40	* 1. Redistributions of source code must retain the above copyright
	41	* notice, this list of conditions and the following disclaimer.
	42	* 2. Redistributions in binary form must reproduce the above copyright
	43	* notice, this list of conditions and the following disclaimer in the
	44	* documentation and/or other materials provided with the distribution.
	45	* 3. All advertising materials mentioning features or use of this software
	46	* must display the following acknowledgement:
	47	* This product includes software developed by Jonathan Stone
	48	* and Jason R. Thorpe for the NetBSD Project.
	49	* 4. The names of the authors may not be used to endorse or promote products
	50	* derived from this software without specific prior written permission.
	51	*
	52	* THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
	53	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	54	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	55	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	56	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
	57	* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	58	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
	59	* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	60	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	61	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	62	* SUCH DAMAGE.
	63	*/
	64
	65	#ifndef _NET_IF_MEDIA_H_
	66	#define _NET_IF_MEDIA_H_
9bccf70c	67	#include <sys/appleapiopts.h>
1c79356b A	68
	69	/*
	70	* Prototypes and definitions for BSD/OS-compatible network interface
	71	* media selection.
	72	*
	73	* Where it is safe to do so, this code strays slightly from the BSD/OS
	74	* design. Software which uses the API (device drivers, basically)
	75	* shouldn't notice any difference.
	76	*
	77	* Many thanks to Matt Thomas for providing the information necessary
	78	* to implement this interface.
	79	*/
	80
91447636	81	#ifdef KERNEL_PRIVATE
1c79356b A	82	#include <sys/queue.h>
	83
	84	/*
	85	* Driver callbacks for media status and change requests.
	86	*/
91447636 A	87	typedef int (ifm_change_cb_t)(struct ifnet ifp);
91447636 A	88	typedef void (ifm_stat_cb_t)(struct ifnet ifp, struct ifmediareq *req);
1c79356b A	89
	90	/*
	91	* In-kernel representation of a single supported media type.
	92	*/
	93	struct ifmedia_entry {
	94	LIST_ENTRY(ifmedia_entry) ifm_list;
	95	int ifm_media; /* description of this media attachment */
	96	int ifm_data; /* for driver-specific use */
	97	void ifm_aux; / for driver-specific use */
	98	};
	99
	100	/*
	101	* One of these goes into a network interface's softc structure.
	102	* It is used to keep general media state.
	103	*/
	104	struct ifmedia {
	105	int ifm_mask; /* mask of changes we don't care about */
	106	int ifm_media; /* current user-set media word */
	107	struct ifmedia_entry ifm_cur; / currently selected media */
	108	LIST_HEAD(, ifmedia_entry) ifm_list; /* list of all supported media */
	109	ifm_change_cb_t ifm_change; /* media change driver callback */
	110	ifm_stat_cb_t ifm_status; /* media status driver callback */
	111	};
	112
	113	/* Initialize an interface's struct if_media field. */
91447636 A	114	void ifmedia_init(struct ifmedia *ifm, int dontcare_mask,
91447636 A	115	ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback);
1c79356b A	116
1c79356b A	117	/* Add one supported medium to a struct ifmedia. */
91447636	118	void ifmedia_add(struct ifmedia ifm, int mword, int data, void aux);
1c79356b A	119
	120	/* Add an array (of ifmedia_entry) media to a struct ifmedia. */
	121	void ifmedia_list_add(struct ifmedia mp, struct ifmedia_entry lp,
	122	int count);
	123
	124	/* Set default media type on initialization. */
91447636	125	void ifmedia_set(struct ifmedia *ifm, int mword);
1c79356b A	126
1c79356b A	127	/* Common ioctl function for getting/setting media, called by driver. */
91447636	128	int ifmedia_ioctl(struct ifnet ifp, struct ifreq ifr,
b0d623f7	129	struct ifmedia *ifm, uint32_t cmd);
1c79356b	130
91447636	131	#endif /* KERNEL_PRIVATE */
1c79356b A	132
	133	/*
	134	* if_media Options word:
	135	* Bits Use
	136	* ---- -------
	137	* 0-4 Media subtype
	138	* 5-7 Media type
	139	* 8-15 Type specific options
	140	* 16-19 RFU
	141	* 20-27 Shared (global) options
	142	* 28-31 Instance
	143	*/
	144
	145	/*
	146	* Ethernet
	147	*/
	148	#define IFM_ETHER 0x00000020
	149	#define IFM_10_T 3 /* 10BaseT - RJ45 */
	150	#define IFM_10_2 4 /* 10Base2 - Thinnet */
	151	#define IFM_10_5 5 /* 10Base5 - AUI */
	152	#define IFM_100_TX 6 /* 100BaseTX - RJ45 */
	153	#define IFM_100_FX 7 /* 100BaseFX - Fiber */
	154	#define IFM_100_T4 8 /* 100BaseT4 - 4 pair cat 3 */
	155	#define IFM_100_VG 9 /* 100VG-AnyLAN */
	156	#define IFM_100_T2 10 /* 100BaseT2 */
	157	#define IFM_1000_SX 11 /* 1000BaseSX - multi-mode fiber */
9bccf70c A	158	#define IFM_10_STP 12 /* 10BaseT over shielded TP */
9bccf70c A	159	#define IFM_10_FL 13 /* 10baseFL - Fiber */
1c79356b A	160	#define IFM_1000_LX 14 /* 1000baseLX - single-mode fiber */
1c79356b A	161	#define IFM_1000_CX 15 /* 1000baseCX - 150ohm STP */
91447636 A	162	#define IFM_1000_T 16 /* 1000baseT - 4 pair cat 5 */
	163	#ifdef PRIVATE
	164	#define IFM_1000_TX IFM_1000_T /* For compatibility */
	165	#endif /* PRIVATE */
1c79356b	166	#define IFM_HPNA_1 17 /* HomePNA 1.0 (1Mb/s) */
91447636 A	167	#define IFM_10G_SR 18 /* 10GbaseSR - multi-mode fiber */
91447636 A	168	#define IFM_10G_LR 19 /* 10GbaseLR - single-mode fiber */
b0d623f7 A	169	#define IFM_10G_CX4 20 /* 10GbaseCX4 - copper */
b0d623f7 A	170	#define IFM_10G_T 21 /* 10GbaseT - 4 pair cat 6 */
1c79356b A	171
	172	/*
	173	* Token ring
	174	*/
	175	#define IFM_TOKEN 0x00000040
	176	#define IFM_TOK_STP4 3 /* Shielded twisted pair 4m - DB9 */
	177	#define IFM_TOK_STP16 4 /* Shielded twisted pair 16m - DB9 */
	178	#define IFM_TOK_UTP4 5 /* Unshielded twisted pair 4m - RJ45 */
	179	#define IFM_TOK_UTP16 6 /* Unshielded twisted pair 16m - RJ45 */
9bccf70c A	180	#define IFM_TOK_STP100 7 /* Shielded twisted pair 100m - DB9 */
9bccf70c A	181	#define IFM_TOK_UTP100 8 /* Unshielded twisted pair 100m - RJ45 */
1c79356b A	182	#define IFM_TOK_ETR 0x00000200 /* Early token release */
	183	#define IFM_TOK_SRCRT 0x00000400 /* Enable source routing features */
	184	#define IFM_TOK_ALLR 0x00000800 /* All routes / Single route bcast */
9bccf70c A	185	#define IFM_TOK_DTR 0x00002000 /* Dedicated token ring */
	186	#define IFM_TOK_CLASSIC 0x00004000 /* Classic token ring */
	187	#define IFM_TOK_AUTO 0x00008000 /* Automatic Dedicate/Classic token ring */
1c79356b A	188
	189	/*
	190	* FDDI
	191	*/
	192	#define IFM_FDDI 0x00000060
	193	#define IFM_FDDI_SMF 3 /* Single-mode fiber */
	194	#define IFM_FDDI_MMF 4 /* Multi-mode fiber */
	195	#define IFM_FDDI_UTP 5 /* CDDI / UTP */
	196	#define IFM_FDDI_DA 0x00000100 /* Dual attach / single attach */
	197
	198	/*
	199	* IEEE 802.11 Wireless
	200	*/
	201	#define IFM_IEEE80211 0x00000080
	202	#define IFM_IEEE80211_FH1 3 /* Frequency Hopping 1Mbps */
	203	#define IFM_IEEE80211_FH2 4 /* Frequency Hopping 2Mbps */
	204	#define IFM_IEEE80211_DS2 5 /* Direct Sequence 2Mbps */
	205	#define IFM_IEEE80211_DS5 6 /* Direct Sequence 5Mbps*/
	206	#define IFM_IEEE80211_DS11 7 /* Direct Sequence 11Mbps*/
	207	#define IFM_IEEE80211_DS1 8 /* Direct Sequence 1Mbps */
9bccf70c	208	#define IFM_IEEE80211_DS22 9 /* Direct Sequence 22Mbps */
1c79356b A	209	#define IFM_IEEE80211_ADHOC 0x00000100 /* Operate in Adhoc mode */
	210
	211	/*
	212	* Shared media sub-types
	213	*/
	214	#define IFM_AUTO 0 /* Autoselect best media */
	215	#define IFM_MANUAL 1 /* Jumper/dipswitch selects media */
	216	#define IFM_NONE 2 /* Deselect all media */
	217
	218	/*
	219	* Shared options
	220	*/
	221	#define IFM_FDX 0x00100000 /* Force full duplex */
	222	#define IFM_HDX 0x00200000 /* Force half duplex */
	223	#define IFM_FLOW 0x00400000 /* enable hardware flow control */
6d2010ae	224	#define IFM_EEE 0x00800000 /* Driver defined flag */
1c79356b A	225	#define IFM_FLAG0 0x01000000 /* Driver defined flag */
	226	#define IFM_FLAG1 0x02000000 /* Driver defined flag */
	227	#define IFM_FLAG2 0x04000000 /* Driver defined flag */
	228	#define IFM_LOOP 0x08000000 /* Put hardware in loopback */
	229
	230	/*
	231	* Masks
	232	*/
	233	#define IFM_NMASK 0x000000e0 /* Network type */
	234	#define IFM_TMASK 0x0000001f /* Media sub-type */
	235	#define IFM_IMASK 0xf0000000 /* Instance */
	236	#define IFM_ISHIFT 28 /* Instance shift */
	237	#define IFM_OMASK 0x0000ff00 /* Type specific options */
	238	#define IFM_GMASK 0x0ff00000 /* Global options */
	239
	240	/*
	241	* Status bits
	242	*/
	243	#define IFM_AVALID 0x00000001 /* Active bit valid */
	244	#define IFM_ACTIVE 0x00000002 /* Interface attached to working net */
	245
	246	/*
	247	* Macros to extract various bits of information from the media word.
	248	*/
9bccf70c A	249	#define IFM_TYPE(x) ((x) & IFM_NMASK)
	250	#define IFM_SUBTYPE(x) ((x) & IFM_TMASK)
	251	#define IFM_TYPE_OPTIONS(x) ((x) & IFM_OMASK)
	252	#define IFM_INST(x) (((x) & IFM_IMASK) >> IFM_ISHIFT)
	253	#define IFM_OPTIONS(x) ((x) & (IFM_OMASK\|IFM_GMASK))
	254
	255	#define IFM_INST_MAX IFM_INST(IFM_IMASK)
	256
	257	/*
	258	* Macro to create a media word.
	259	*/
	260	#define IFM_MAKEWORD(type, subtype, options, instance) \
	261	((type) \| (subtype) \| (options) \| ((instance) << IFM_ISHIFT))
1c79356b A	262
	263	/*
	264	* NetBSD extension not defined in the BSDI API. This is used in various
	265	* places to get the canonical description for a given type/subtype.
	266	*
	267	* NOTE: all but the top-level type descriptions must contain NO whitespace!
	268	* Otherwise, parsing these in ifconfig(8) would be a nightmare.
	269	*/
	270	struct ifmedia_description {
	271	int ifmt_word; /* word value; may be masked */
	272	const char ifmt_string; / description */
	273	};
	274
	275	#define IFM_TYPE_DESCRIPTIONS { \
	276	{ IFM_ETHER, "Ethernet" }, \
	277	{ IFM_TOKEN, "Token ring" }, \
	278	{ IFM_FDDI, "FDDI" }, \
	279	{ IFM_IEEE80211, "IEEE802.11" }, \
	280	{ 0, NULL }, \
	281	}
	282
	283	#define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS { \
	284	{ IFM_10_T, "10baseT/UTP" }, \
	285	{ IFM_10_2, "10base2/BNC" }, \
	286	{ IFM_10_5, "10base5/AUI" }, \
	287	{ IFM_100_TX, "100baseTX" }, \
	288	{ IFM_100_FX, "100baseFX" }, \
	289	{ IFM_100_T4, "100baseT4" }, \
	290	{ IFM_100_VG, "100baseVG" }, \
	291	{ IFM_100_T2, "100baseT2" }, \
	292	{ IFM_1000_SX, "1000baseSX" }, \
	293	{ IFM_10_STP, "10baseSTP" }, \
	294	{ IFM_10_FL, "10baseFL" }, \
	295	{ IFM_1000_LX, "1000baseLX" }, \
	296	{ IFM_1000_CX, "1000baseCX" }, \
91447636	297	{ IFM_1000_T, "1000baseT" }, \
1c79356b	298	{ IFM_HPNA_1, "HomePNA1" }, \
91447636 A	299	{ IFM_10G_SR, "10GbaseSR" }, \
91447636 A	300	{ IFM_10G_LR, "10GbaseLR" }, \
b0d623f7 A	301	{ IFM_10G_CX4, "10GbaseCX4" }, \
b0d623f7 A	302	{ IFM_10G_T, "10GbaseT" }, \
1c79356b A	303	{ 0, NULL }, \
	304	}
	305
	306	#define IFM_SUBTYPE_ETHERNET_ALIASES { \
	307	{ IFM_10_T, "UTP" }, \
	308	{ IFM_10_T, "10UTP" }, \
	309	{ IFM_10_2, "BNC" }, \
	310	{ IFM_10_2, "10BNC" }, \
	311	{ IFM_10_5, "AUI" }, \
	312	{ IFM_10_5, "10AUI" }, \
	313	{ IFM_100_TX, "100TX" }, \
	314	{ IFM_100_FX, "100FX" }, \
	315	{ IFM_100_T4, "100T4" }, \
	316	{ IFM_100_VG, "100VG" }, \
	317	{ IFM_100_T2, "100T2" }, \
	318	{ IFM_1000_SX, "1000SX" }, \
	319	{ IFM_10_STP, "STP" }, \
	320	{ IFM_10_STP, "10STP" }, \
	321	{ IFM_10_FL, "FL" }, \
	322	{ IFM_10_FL, "10FL" }, \
	323	{ IFM_1000_LX, "1000LX" }, \
	324	{ IFM_1000_CX, "1000CX" }, \
91447636	325	{ IFM_1000_T, "1000T" }, \
1c79356b	326	{ IFM_HPNA_1, "HPNA1" }, \
91447636 A	327	{ IFM_10G_SR, "10GSR" }, \
91447636 A	328	{ IFM_10G_LR, "10GLR" }, \
b0d623f7 A	329	{ IFM_10G_CX4, "10GCX4" }, \
b0d623f7 A	330	{ IFM_10G_T, "10GT" }, \
1c79356b A	331	{ 0, NULL }, \
	332	}
	333
	334	#define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS { \
	335	{ 0, NULL }, \
	336	}
	337
	338	#define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS { \
	339	{ IFM_TOK_STP4, "DB9/4Mbit" }, \
	340	{ IFM_TOK_STP16, "DB9/16Mbit" }, \
	341	{ IFM_TOK_UTP4, "UTP/4Mbit" }, \
	342	{ IFM_TOK_UTP16, "UTP/16Mbit" }, \
	343	{ 0, NULL }, \
	344	}
	345
	346	#define IFM_SUBTYPE_TOKENRING_ALIASES { \
	347	{ IFM_TOK_STP4, "4STP" }, \
	348	{ IFM_TOK_STP16, "16STP" }, \
	349	{ IFM_TOK_UTP4, "4UTP" }, \
	350	{ IFM_TOK_UTP16, "16UTP" }, \
	351	{ 0, NULL }, \
	352	}
	353
	354	#define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS { \
	355	{ IFM_TOK_ETR, "EarlyTokenRelease" }, \
	356	{ IFM_TOK_SRCRT, "SourceRouting" }, \
	357	{ IFM_TOK_ALLR, "AllRoutes" }, \
	358	{ 0, NULL }, \
	359	}
	360
	361	#define IFM_SUBTYPE_FDDI_DESCRIPTIONS { \
	362	{ IFM_FDDI_SMF, "Single-mode" }, \
	363	{ IFM_FDDI_MMF, "Multi-mode" }, \
	364	{ IFM_FDDI_UTP, "UTP" }, \
	365	{ 0, NULL }, \
	366	}
	367
	368	#define IFM_SUBTYPE_FDDI_ALIASES { \
	369	{ IFM_FDDI_SMF, "SMF" }, \
	370	{ IFM_FDDI_MMF, "MMF" }, \
	371	{ IFM_FDDI_UTP, "CDDI" }, \
	372	{ 0, NULL }, \
	373	}
	374
	375	#define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS { \
	376	{ IFM_FDDI_DA, "Dual-attach" }, \
	377	{ 0, NULL }, \
	378	}
	379
	380	#define IFM_SUBTYPE_IEEE80211_DESCRIPTIONS { \
	381	{ IFM_IEEE80211_FH1, "FH1" }, \
	382	{ IFM_IEEE80211_FH2, "FH2" }, \
	383	{ IFM_IEEE80211_DS1, "DS1" }, \
	384	{ IFM_IEEE80211_DS2, "DS2" }, \
	385	{ IFM_IEEE80211_DS5, "DS5" }, \
	386	{ IFM_IEEE80211_DS11, "DS11" }, \
9bccf70c	387	{ IFM_IEEE80211_DS22, "DS22" }, \
1c79356b A	388	{ 0, NULL }, \
	389	}
	390
	391	#define IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS { \
	392	{ IFM_IEEE80211_ADHOC, "adhoc" }, \
	393	{ 0, NULL }, \
	394	}
	395
	396	#define IFM_SUBTYPE_SHARED_DESCRIPTIONS { \
	397	{ IFM_AUTO, "autoselect" }, \
	398	{ IFM_MANUAL, "manual" }, \
	399	{ IFM_NONE, "none" }, \
	400	{ 0, NULL }, \
	401	}
	402
	403	#define IFM_SUBTYPE_SHARED_ALIASES { \
	404	{ IFM_AUTO, "auto" }, \
	405	{ 0, NULL }, \
	406	}
	407
	408	#define IFM_SHARED_OPTION_DESCRIPTIONS { \
	409	{ IFM_FDX, "full-duplex" }, \
	410	{ IFM_HDX, "half-duplex" }, \
	411	{ IFM_FLOW, "flow-control" }, \
060df5ea	412	{ IFM_EEE, "energy-efficient-ethernet" }, \
1c79356b A	413	{ IFM_FLAG0, "flag0" }, \
	414	{ IFM_FLAG1, "flag1" }, \
	415	{ IFM_FLAG2, "flag2" }, \
	416	{ IFM_LOOP, "hw-loopback" }, \
	417	{ 0, NULL }, \
	418	}
	419
	420	#endif /* _NET_IF_MEDIA_H_ */