1/*
2 * Copyright (c) 2000-2013 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
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.
14 *
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
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/* $NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $ */
29/* $FreeBSD: src/sys/net/if_media.h,v 1.9.2.1 2001/07/04 00:12:38 brooks Exp $ */
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_
67#include <sys/appleapiopts.h>
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
81#ifdef KERNEL_PRIVATE
82/* sigh; some modules are lazy and thus rely on this */
83#include <sys/queue.h>
84#endif /* KERNEL_PRIVATE */
85
86/*
87 * if_media Options word:
88 * Bits Use
89 * ---- -------
90 * 0-4 Media subtype
91 * 5-7 Media type
92 * 8-15 Type specific options
93 * 16-19 RFU
94 * 20-27 Shared (global) options
95 * 28-31 Instance
96 */
97
98/*
99 * Ethernet
100 */
101#define IFM_ETHER 0x00000020
102#define IFM_10_T 3 /* 10BaseT - RJ45 */
103#define IFM_10_2 4 /* 10Base2 - Thinnet */
104#define IFM_10_5 5 /* 10Base5 - AUI */
105#define IFM_100_TX 6 /* 100BaseTX - RJ45 */
106#define IFM_100_FX 7 /* 100BaseFX - Fiber */
107#define IFM_100_T4 8 /* 100BaseT4 - 4 pair cat 3 */
108#define IFM_100_VG 9 /* 100VG-AnyLAN */
109#define IFM_100_T2 10 /* 100BaseT2 */
110#define IFM_1000_SX 11 /* 1000BaseSX - multi-mode fiber */
111#define IFM_10_STP 12 /* 10BaseT over shielded TP */
112#define IFM_10_FL 13 /* 10baseFL - Fiber */
113#define IFM_1000_LX 14 /* 1000baseLX - single-mode fiber */
114#define IFM_1000_CX 15 /* 1000baseCX - 150ohm STP */
115#define IFM_1000_T 16 /* 1000baseT - 4 pair cat 5 */
116#ifdef PRIVATE
117#define IFM_1000_TX IFM_1000_T /* For compatibility */
118#endif /* PRIVATE */
119#define IFM_HPNA_1 17 /* HomePNA 1.0 (1Mb/s) */
120#define IFM_10G_SR 18 /* 10GbaseSR - multi-mode fiber */
121#define IFM_10G_LR 19 /* 10GbaseLR - single-mode fiber */
122#define IFM_10G_CX4 20 /* 10GbaseCX4 - copper */
123#define IFM_10G_T 21 /* 10GbaseT - 4 pair cat 6 */
124#define IFM_2500_T 22 /* 2500baseT - 4 pair cat 5 */
125#define IFM_5000_T 23 /* 5000baseT - 4 pair cat 5 */
126
127/*
128 * Token ring
129 */
130#define IFM_TOKEN 0x00000040
131#define IFM_TOK_STP4 3 /* Shielded twisted pair 4m - DB9 */
132#define IFM_TOK_STP16 4 /* Shielded twisted pair 16m - DB9 */
133#define IFM_TOK_UTP4 5 /* Unshielded twisted pair 4m - RJ45 */
134#define IFM_TOK_UTP16 6 /* Unshielded twisted pair 16m - RJ45 */
135#define IFM_TOK_STP100 7 /* Shielded twisted pair 100m - DB9 */
136#define IFM_TOK_UTP100 8 /* Unshielded twisted pair 100m - RJ45 */
137#define IFM_TOK_ETR 0x00000200 /* Early token release */
138#define IFM_TOK_SRCRT 0x00000400 /* Enable source routing features */
139#define IFM_TOK_ALLR 0x00000800 /* All routes / Single route bcast */
140#define IFM_TOK_DTR 0x00002000 /* Dedicated token ring */
141#define IFM_TOK_CLASSIC 0x00004000 /* Classic token ring */
142#define IFM_TOK_AUTO 0x00008000 /* Automatic Dedicate/Classic token ring */
143
144/*
145 * FDDI
146 */
147#define IFM_FDDI 0x00000060
148#define IFM_FDDI_SMF 3 /* Single-mode fiber */
149#define IFM_FDDI_MMF 4 /* Multi-mode fiber */
150#define IFM_FDDI_UTP 5 /* CDDI / UTP */
151#define IFM_FDDI_DA 0x00000100 /* Dual attach / single attach */
152
153/*
154 * IEEE 802.11 Wireless
155 */
156#define IFM_IEEE80211 0x00000080
157#define IFM_IEEE80211_FH1 3 /* Frequency Hopping 1Mbps */
158#define IFM_IEEE80211_FH2 4 /* Frequency Hopping 2Mbps */
159#define IFM_IEEE80211_DS2 5 /* Direct Sequence 2Mbps */
160#define IFM_IEEE80211_DS5 6 /* Direct Sequence 5Mbps*/
161#define IFM_IEEE80211_DS11 7 /* Direct Sequence 11Mbps*/
162#define IFM_IEEE80211_DS1 8 /* Direct Sequence 1Mbps */
163#define IFM_IEEE80211_DS22 9 /* Direct Sequence 22Mbps */
164#define IFM_IEEE80211_ADHOC 0x00000100 /* Operate in Adhoc mode */
165
166/*
167 * Shared media sub-types
168 */
169#define IFM_AUTO 0 /* Autoselect best media */
170#define IFM_MANUAL 1 /* Jumper/dipswitch selects media */
171#define IFM_NONE 2 /* Deselect all media */
172
173/*
174 * Shared options
175 */
176#define IFM_FDX 0x00100000 /* Force full duplex */
177#define IFM_HDX 0x00200000 /* Force half duplex */
178#define IFM_FLOW 0x00400000 /* enable hardware flow control */
179#define IFM_EEE 0x00800000 /* Support energy efficient ethernet */
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 0x0000001f /* 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#define IFM_WAKESAMENET 0x00000004 /* No link transition while asleep */
201
202/*
203 * Macros to extract various bits of information from the media word.
204 */
205#define IFM_TYPE(x) ((x) & IFM_NMASK)
206#define IFM_SUBTYPE(x) ((x) & IFM_TMASK)
207#define IFM_TYPE_OPTIONS(x) ((x) & IFM_OMASK)
208#define IFM_INST(x) (((x) & IFM_IMASK) >> IFM_ISHIFT)
209#define IFM_OPTIONS(x) ((x) & (IFM_OMASK|IFM_GMASK))
210
211#define IFM_INST_MAX IFM_INST(IFM_IMASK)
212
213/*
214 * Macro to create a media word.
215 */
216#define IFM_MAKEWORD(type, subtype, options, instance) \
217 ((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT))
218
219/*
220 * NetBSD extension not defined in the BSDI API. This is used in various
221 * places to get the canonical description for a given type/subtype.
222 *
223 * NOTE: all but the top-level type descriptions must contain NO whitespace!
224 * Otherwise, parsing these in ifconfig(8) would be a nightmare.
225 */
226struct ifmedia_description {
227 int ifmt_word; /* word value; may be masked */
228 const char *ifmt_string; /* description */
229};
230
231#define IFM_TYPE_DESCRIPTIONS { \
232 { IFM_ETHER, "Ethernet" }, \
233 { IFM_TOKEN, "Token ring" }, \
234 { IFM_FDDI, "FDDI" }, \
235 { IFM_IEEE80211, "IEEE802.11" }, \
236 { 0, NULL }, \
237}
238
239#define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS { \
240 { IFM_10_T, "10baseT/UTP" }, \
241 { IFM_10_2, "10base2/BNC" }, \
242 { IFM_10_5, "10base5/AUI" }, \
243 { IFM_100_TX, "100baseTX" }, \
244 { IFM_100_FX, "100baseFX" }, \
245 { IFM_100_T4, "100baseT4" }, \
246 { IFM_100_VG, "100baseVG" }, \
247 { IFM_100_T2, "100baseT2" }, \
248 { IFM_1000_SX, "1000baseSX" }, \
249 { IFM_10_STP, "10baseSTP" }, \
250 { IFM_10_FL, "10baseFL" }, \
251 { IFM_1000_LX, "1000baseLX" }, \
252 { IFM_1000_CX, "1000baseCX" }, \
253 { IFM_1000_T, "1000baseT" }, \
254 { IFM_HPNA_1, "HomePNA1" }, \
255 { IFM_10G_SR, "10GbaseSR" }, \
256 { IFM_10G_LR, "10GbaseLR" }, \
257 { IFM_10G_CX4, "10GbaseCX4" }, \
258 { IFM_10G_T, "10GbaseT" }, \
259 { IFM_2500_T, "2500baseT" }, \
260 { IFM_5000_T, "5000baseT" }, \
261 { 0, NULL }, \
262}
263
264#define IFM_SUBTYPE_ETHERNET_ALIASES { \
265 { IFM_10_T, "UTP" }, \
266 { IFM_10_T, "10UTP" }, \
267 { IFM_10_2, "BNC" }, \
268 { IFM_10_2, "10BNC" }, \
269 { IFM_10_5, "AUI" }, \
270 { IFM_10_5, "10AUI" }, \
271 { IFM_100_TX, "100TX" }, \
272 { IFM_100_FX, "100FX" }, \
273 { IFM_100_T4, "100T4" }, \
274 { IFM_100_VG, "100VG" }, \
275 { IFM_100_T2, "100T2" }, \
276 { IFM_1000_SX, "1000SX" }, \
277 { IFM_10_STP, "STP" }, \
278 { IFM_10_STP, "10STP" }, \
279 { IFM_10_FL, "FL" }, \
280 { IFM_10_FL, "10FL" }, \
281 { IFM_1000_LX, "1000LX" }, \
282 { IFM_1000_CX, "1000CX" }, \
283 { IFM_1000_T, "1000T" }, \
284 { IFM_HPNA_1, "HPNA1" }, \
285 { IFM_10G_SR, "10GSR" }, \
286 { IFM_10G_LR, "10GLR" }, \
287 { IFM_10G_CX4, "10GCX4" }, \
288 { IFM_10G_T, "10GT" }, \
289 { 0, NULL }, \
290}
291
292#define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS { \
293 { 0, NULL }, \
294}
295
296#define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS { \
297 { IFM_TOK_STP4, "DB9/4Mbit" }, \
298 { IFM_TOK_STP16, "DB9/16Mbit" }, \
299 { IFM_TOK_UTP4, "UTP/4Mbit" }, \
300 { IFM_TOK_UTP16, "UTP/16Mbit" }, \
301 { 0, NULL }, \
302}
303
304#define IFM_SUBTYPE_TOKENRING_ALIASES { \
305 { IFM_TOK_STP4, "4STP" }, \
306 { IFM_TOK_STP16, "16STP" }, \
307 { IFM_TOK_UTP4, "4UTP" }, \
308 { IFM_TOK_UTP16, "16UTP" }, \
309 { 0, NULL }, \
310}
311
312#define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS { \
313 { IFM_TOK_ETR, "EarlyTokenRelease" }, \
314 { IFM_TOK_SRCRT, "SourceRouting" }, \
315 { IFM_TOK_ALLR, "AllRoutes" }, \
316 { 0, NULL }, \
317}
318
319#define IFM_SUBTYPE_FDDI_DESCRIPTIONS { \
320 { IFM_FDDI_SMF, "Single-mode" }, \
321 { IFM_FDDI_MMF, "Multi-mode" }, \
322 { IFM_FDDI_UTP, "UTP" }, \
323 { 0, NULL }, \
324}
325
326#define IFM_SUBTYPE_FDDI_ALIASES { \
327 { IFM_FDDI_SMF, "SMF" }, \
328 { IFM_FDDI_MMF, "MMF" }, \
329 { IFM_FDDI_UTP, "CDDI" }, \
330 { 0, NULL }, \
331}
332
333#define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS { \
334 { IFM_FDDI_DA, "Dual-attach" }, \
335 { 0, NULL }, \
336}
337
338#define IFM_SUBTYPE_IEEE80211_DESCRIPTIONS { \
339 { IFM_IEEE80211_FH1, "FH1" }, \
340 { IFM_IEEE80211_FH2, "FH2" }, \
341 { IFM_IEEE80211_DS1, "DS1" }, \
342 { IFM_IEEE80211_DS2, "DS2" }, \
343 { IFM_IEEE80211_DS5, "DS5" }, \
344 { IFM_IEEE80211_DS11, "DS11" }, \
345 { IFM_IEEE80211_DS22, "DS22" }, \
346 { 0, NULL }, \
347}
348
349#define IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS { \
350 { IFM_IEEE80211_ADHOC, "adhoc" }, \
351 { 0, NULL }, \
352}
353
354#define IFM_SUBTYPE_SHARED_DESCRIPTIONS { \
355 { IFM_AUTO, "autoselect" }, \
356 { IFM_MANUAL, "manual" }, \
357 { IFM_NONE, "none" }, \
358 { 0, NULL }, \
359}
360
361#define IFM_SUBTYPE_SHARED_ALIASES { \
362 { IFM_AUTO, "auto" }, \
363 { 0, NULL }, \
364}
365
366#define IFM_SHARED_OPTION_DESCRIPTIONS { \
367 { IFM_FDX, "full-duplex" }, \
368 { IFM_HDX, "half-duplex" }, \
369 { IFM_FLOW, "flow-control" }, \
370 { IFM_EEE, "energy-efficient-ethernet" }, \
371 { IFM_FLAG0, "flag0" }, \
372 { IFM_FLAG1, "flag1" }, \
373 { IFM_FLAG2, "flag2" }, \
374 { IFM_LOOP, "hw-loopback" }, \
375 { 0, NULL }, \
376}
377
378#endif /* _NET_IF_MEDIA_H_ */
379