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