source: rtems/c/src/libchip/network/if_media.h @ 01b6ca9

4.104.114.84.95
Last change on this file since 01b6ca9 was 01b6ca9, checked in by Joel Sherrill <joel.sherrill@…>, on 06/13/03 at 17:43:11

2003-06-13 Greg Menke <gregory.menke@…>

PR 405/bsps
PR 393/networking

  • network/dec21140.c: Fix leak also known as PR393.
  • network/elnk.c, network/if_media.h, network/mii.h: New files.
  • network/Makefile.am: Reflect new files.
  • Property mode set to 100644
File size: 14.8 KB
Line 
1/*      $NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $     */
2/* $FreeBSD: /repoman/r/ncvs/src/sys/net/if_media.h,v 1.18 2002/07/14 21:58:19 kbyanc 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)(struct ifnet *ifp);
61typedef void (*ifm_stat_cb_t)(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(struct ifmedia *ifm, int dontcare_mask,
88            ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback);
89
90/* Remove all mediums from a struct ifmedia.  */
91void    ifmedia_removeall( struct ifmedia *ifm);
92
93/* Add one supported medium to a struct ifmedia. */
94void    ifmedia_add(struct ifmedia *ifm, int mword, int data, void *aux);
95
96/* Add an array (of ifmedia_entry) media to a struct ifmedia. */
97void    ifmedia_list_add(struct ifmedia *mp, struct ifmedia_entry *lp,
98            int count);
99
100/* Set default media type on initialization. */
101void    ifmedia_set(struct ifmedia *ifm, int mword);
102
103/* Common ioctl function for getting/setting media, called by driver. */
104int     ifmedia_ioctl(struct ifnet *ifp, struct ifreq *ifr,
105            struct ifmedia *ifm, u_long cmd);
106
107#endif /*_KERNEL */
108
109/*
110 * if_media Options word:
111 *      Bits    Use
112 *      ----    -------
113 *      0-4     Media variant
114 *      5-7     Media type
115 *      8-15    Type specific options
116 *      16-19   RFU
117 *      20-27   Shared (global) options
118 *      28-31   Instance
119 */
120
121/*
122 * Ethernet
123 */
124#define IFM_ETHER       0x00000020
125#define IFM_10_T        3               /* 10BaseT - RJ45 */
126#define IFM_10_2        4               /* 10Base2 - Thinnet */
127#define IFM_10_5        5               /* 10Base5 - AUI */
128#define IFM_100_TX      6               /* 100BaseTX - RJ45 */
129#define IFM_100_FX      7               /* 100BaseFX - Fiber */
130#define IFM_100_T4      8               /* 100BaseT4 - 4 pair cat 3 */
131#define IFM_100_VG      9               /* 100VG-AnyLAN */
132#define IFM_100_T2      10              /* 100BaseT2 */
133#define IFM_1000_SX     11              /* 1000BaseSX - multi-mode fiber */
134#define IFM_10_STP      12              /* 10BaseT over shielded TP */
135#define IFM_10_FL       13              /* 10BaseFL - Fiber */
136#define IFM_1000_LX     14              /* 1000baseLX - single-mode fiber */
137#define IFM_1000_CX     15              /* 1000baseCX - 150ohm STP */
138#define IFM_1000_T      16              /* 1000baseT - 4 pair cat 5 */
139#define IFM_HPNA_1      17              /* HomePNA 1.0 (1Mb/s) */
140/* note 31 is the max! */
141
142#define IFM_ETH_MASTER  0x00000100      /* master mode (1000baseT) */
143
144/*
145 * Token ring
146 */
147#define IFM_TOKEN       0x00000040
148#define IFM_TOK_STP4    3               /* Shielded twisted pair 4m - DB9 */
149#define IFM_TOK_STP16   4               /* Shielded twisted pair 16m - DB9 */
150#define IFM_TOK_UTP4    5               /* Unshielded twisted pair 4m - RJ45 */
151#define IFM_TOK_UTP16   6               /* Unshielded twisted pair 16m - RJ45 */
152#define IFM_TOK_STP100  7               /* Shielded twisted pair 100m - DB9 */
153#define IFM_TOK_UTP100  8               /* Unshielded twisted pair 100m - RJ45 */
154#define IFM_TOK_ETR     0x00000200      /* Early token release */
155#define IFM_TOK_SRCRT   0x00000400      /* Enable source routing features */
156#define IFM_TOK_ALLR    0x00000800      /* All routes / Single route bcast */
157#define IFM_TOK_DTR     0x00002000      /* Dedicated token ring */
158#define IFM_TOK_CLASSIC 0x00004000      /* Classic token ring */
159#define IFM_TOK_AUTO    0x00008000      /* Automatic Dedicate/Classic token ring */
160
161/*
162 * FDDI
163 */
164#define IFM_FDDI        0x00000060
165#define IFM_FDDI_SMF    3               /* Single-mode fiber */
166#define IFM_FDDI_MMF    4               /* Multi-mode fiber */
167#define IFM_FDDI_UTP    5               /* CDDI / UTP */
168#define IFM_FDDI_DA     0x00000100      /* Dual attach / single attach */
169
170/*
171 * IEEE 802.11 Wireless
172 */
173#define IFM_IEEE80211   0x00000080
174#define IFM_IEEE80211_FH1       3       /* Frequency Hopping 1Mbps */
175#define IFM_IEEE80211_FH2       4       /* Frequency Hopping 2Mbps */
176#define IFM_IEEE80211_DS1       5       /* Direct Sequence 1Mbps */
177#define IFM_IEEE80211_DS2       6       /* Direct Sequence 2Mbps */
178#define IFM_IEEE80211_DS5       7       /* Direct Sequence 5.5Mbps */
179#define IFM_IEEE80211_DS11      8       /* Direct Sequence 11Mbps */
180#define IFM_IEEE80211_DS22      9       /* Direct Sequence 22Mbps */
181#define IFM_IEEE80211_ODFM6     10      /* ODFM 6Mbps */
182#define IFM_IEEE80211_ODFM9     11      /* ODFM 9Mbps */
183#define IFM_IEEE80211_ODFM12    12      /* ODFM 12Mbps */
184#define IFM_IEEE80211_ODFM18    13      /* ODFM 18Mbps */
185#define IFM_IEEE80211_ODFM24    14      /* ODFM 24Mbps */
186#define IFM_IEEE80211_ODFM36    15      /* ODFM 36Mbps */
187#define IFM_IEEE80211_ODFM48    16      /* ODFM 48Mbps */
188#define IFM_IEEE80211_ODFM54    17      /* ODFM 54Mbps */
189#define IFM_IEEE80211_ODFM72    18      /* ODFM 72Mbps */
190#define IFM_IEEE80211_ADHOC     0x00000100      /* Operate in Adhoc mode */
191#define IFM_IEEE80211_HOSTAP    0x00000200      /* Operate in Host AP mode */
192#define IFM_IEEE80211_IBSS      0x00000400      /* Operate in IBSS mode */
193#define IFM_IEEE80211_IBSSMASTER 0x00000800     /* Operate as an IBSS master */
194
195/*
196 * Shared media sub-types
197 */
198#define IFM_AUTO        0               /* Autoselect best media */
199#define IFM_MANUAL      1               /* Jumper/dipswitch selects media */
200#define IFM_NONE        2               /* Deselect all media */
201
202/*
203 * Shared options
204 */
205#define IFM_FDX         0x00100000      /* Force full duplex */
206#define IFM_HDX         0x00200000      /* Force half duplex */
207#define IFM_FLAG0       0x01000000      /* Driver defined flag */
208#define IFM_FLAG1       0x02000000      /* Driver defined flag */
209#define IFM_FLAG2       0x04000000      /* Driver defined flag */
210#define IFM_LOOP        0x08000000      /* Put hardware in loopback */
211
212/*
213 * Masks
214 */
215#define IFM_NMASK       0x000000e0      /* Network type */
216#define IFM_TMASK       0x0000001f      /* Media sub-type */
217#define IFM_IMASK       0xf0000000      /* Instance */
218#define IFM_ISHIFT      28              /* Instance shift */
219#define IFM_OMASK       0x0000ff00      /* Type specific options */
220#define IFM_GMASK       0x0ff00000      /* Global options */
221
222/*
223 * Status bits
224 */
225#define IFM_AVALID      0x00000001      /* Active bit valid */
226#define IFM_ACTIVE      0x00000002      /* Interface attached to working net */
227
228/*
229 * Macros to extract various bits of information from the media word.
230 */
231#define IFM_TYPE(x)         ((x) & IFM_NMASK)
232#define IFM_SUBTYPE(x)      ((x) & IFM_TMASK)
233#define IFM_TYPE_OPTIONS(x) ((x) & IFM_OMASK)
234#define IFM_INST(x)         (((x) & IFM_IMASK) >> IFM_ISHIFT)
235#define IFM_OPTIONS(x)  ((x) & (IFM_OMASK|IFM_GMASK))
236
237#define IFM_INST_MAX    IFM_INST(IFM_IMASK)
238
239/*
240 * Macro to create a media word.
241 */
242#define IFM_MAKEWORD(type, subtype, options, instance)                  \
243        ((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT))
244
245/*
246 * NetBSD extension not defined in the BSDI API.  This is used in various
247 * places to get the canonical description for a given type/subtype.
248 *
249 * NOTE: all but the top-level type descriptions must contain NO whitespace!
250 * Otherwise, parsing these in ifconfig(8) would be a nightmare.
251 */
252struct ifmedia_description {
253        int     ifmt_word;              /* word value; may be masked */
254        const char *ifmt_string;        /* description */
255};
256
257#define IFM_TYPE_DESCRIPTIONS {                                         \
258        { IFM_ETHER,            "Ethernet" },                           \
259        { IFM_TOKEN,            "Token ring" },                         \
260        { IFM_FDDI,             "FDDI" },                               \
261        { IFM_IEEE80211,        "IEEE 802.11 Wireless Ethernet" },      \
262        { 0, NULL },                                                    \
263}
264
265#define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS {                             \
266        { IFM_10_T,     "10baseT/UTP" },                                \
267        { IFM_10_2,     "10base2/BNC" },                                \
268        { IFM_10_5,     "10base5/AUI" },                                \
269        { IFM_100_TX,   "100baseTX" },                                  \
270        { IFM_100_FX,   "100baseFX" },                                  \
271        { IFM_100_T4,   "100baseT4" },                                  \
272        { IFM_100_VG,   "100baseVG" },                                  \
273        { IFM_100_T2,   "100baseT2" },                                  \
274        { IFM_10_STP,   "10baseSTP" },                                  \
275        { IFM_10_FL,    "10baseFL" },                                   \
276        { IFM_1000_SX,  "1000baseSX" },                                 \
277        { IFM_1000_LX,  "1000baseLX" },                                 \
278        { IFM_1000_CX,  "1000baseCX" },                                 \
279        { IFM_1000_T,   "1000baseTX" },                                 \
280        { IFM_1000_T,   "1000baseT" },                                  \
281        { IFM_HPNA_1,   "homePNA" },                                    \
282        { 0, NULL },                                                    \
283}
284
285#define IFM_SUBTYPE_ETHERNET_ALIASES {                                  \
286        { IFM_10_T,     "UTP" },                                        \
287        { IFM_10_T,     "10UTP" },                                      \
288        { IFM_10_2,     "BNC" },                                        \
289        { IFM_10_2,     "10BNC" },                                      \
290        { IFM_10_5,     "AUI" },                                        \
291        { IFM_10_5,     "10AUI" },                                      \
292        { IFM_100_TX,   "100TX" },                                      \
293        { IFM_100_T4,   "100T4" },                                      \
294        { IFM_100_VG,   "100VG" },                                      \
295        { IFM_100_T2,   "100T2" },                                      \
296        { IFM_10_STP,   "10STP" },                                      \
297        { IFM_10_FL,    "10FL" },                                       \
298        { IFM_1000_SX,  "1000SX" },                                     \
299        { IFM_1000_LX,  "1000LX" },                                     \
300        { IFM_1000_CX,  "1000CX" },                                     \
301        { IFM_1000_T,   "1000TX" },                                     \
302        { IFM_1000_T,   "1000T" },                                      \
303        { 0, NULL },                                                    \
304}
305
306#define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS {                      \
307        { 0, NULL },                                                    \
308}
309
310#define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS {                            \
311        { IFM_TOK_STP4, "DB9/4Mbit" },                                  \
312        { IFM_TOK_STP16, "DB9/16Mbit" },                                \
313        { IFM_TOK_UTP4, "UTP/4Mbit" },                                  \
314        { IFM_TOK_UTP16, "UTP/16Mbit" },                                \
315        { IFM_TOK_STP100, "STP/100Mbit" },                              \
316        { IFM_TOK_UTP100, "UTP/100Mbit" },                              \
317        { 0, NULL },                                                    \
318}
319
320#define IFM_SUBTYPE_TOKENRING_ALIASES {                                 \
321        { IFM_TOK_STP4, "4STP" },                                       \
322        { IFM_TOK_STP16, "16STP" },                                     \
323        { IFM_TOK_UTP4, "4UTP" },                                       \
324        { IFM_TOK_UTP16, "16UTP" },                                     \
325        { IFM_TOK_STP100, "100STP" },                                   \
326        { IFM_TOK_UTP100, "100UTP" },                                   \
327        { 0, NULL },                                                    \
328}
329
330#define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS {                     \
331        { IFM_TOK_ETR,  "EarlyTokenRelease" },                          \
332        { IFM_TOK_SRCRT, "SourceRouting" },                             \
333        { IFM_TOK_ALLR, "AllRoutes" },                                  \
334        { IFM_TOK_DTR,  "Dedicated" },                                  \
335        { IFM_TOK_CLASSIC,"Classic" },                                  \
336        { IFM_TOK_AUTO, " " },                                          \
337        { 0, NULL },                                                    \
338}
339
340#define IFM_SUBTYPE_FDDI_DESCRIPTIONS {                                 \
341        { IFM_FDDI_SMF, "Single-mode" },                                \
342        { IFM_FDDI_MMF, "Multi-mode" },                                 \
343        { IFM_FDDI_UTP, "UTP" },                                        \
344        { 0, NULL },                                                    \
345}
346
347#define IFM_SUBTYPE_FDDI_ALIASES {                                      \
348        { IFM_FDDI_SMF, "SMF" },                                        \
349        { IFM_FDDI_MMF, "MMF" },                                        \
350        { IFM_FDDI_UTP, "CDDI" },                                       \
351        { 0, NULL },                                                    \
352}
353
354#define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS {                          \
355        { IFM_FDDI_DA, "Dual-attach" },                                 \
356        { 0, NULL },                                                    \
357}
358
359#define IFM_SUBTYPE_IEEE80211_DESCRIPTIONS {                            \
360        { IFM_IEEE80211_FH1, "FH/1Mbps" },                              \
361        { IFM_IEEE80211_FH2, "FH/2Mbps" },                              \
362        { IFM_IEEE80211_DS1, "DS/1Mbps" },                              \
363        { IFM_IEEE80211_DS2, "DS/2Mbps" },                              \
364        { IFM_IEEE80211_DS5, "DS/5.5Mbps" },                            \
365        { IFM_IEEE80211_DS11, "DS/11Mbps" },                            \
366        { IFM_IEEE80211_DS22, "DS/22Mbps" },                            \
367        { IFM_IEEE80211_ODFM6, "ODFM/6Mbps" },                          \
368        { IFM_IEEE80211_ODFM9, "ODFM/9Mbps" },                          \
369        { IFM_IEEE80211_ODFM12, "ODFM/12Mbps" },                        \
370        { IFM_IEEE80211_ODFM18, "ODFM/18Mbps" },                        \
371        { IFM_IEEE80211_ODFM24, "ODFM/24Mbps" },                        \
372        { IFM_IEEE80211_ODFM36, "ODFM/36Mbps" },                        \
373        { IFM_IEEE80211_ODFM48, "ODFM/48Mbps" },                        \
374        { IFM_IEEE80211_ODFM54, "ODFM/54Mbps" },                        \
375        { IFM_IEEE80211_ODFM72, "ODFM/72Mbps" },                        \
376        { 0, NULL },                                                    \
377}
378
379#define IFM_SUBTYPE_IEEE80211_ALIASES {                                 \
380        { IFM_IEEE80211_FH1, "FH1" },                                   \
381        { IFM_IEEE80211_FH2, "FH2" },                                   \
382        { IFM_IEEE80211_FH1, "FrequencyHopping/1Mbps" },                \
383        { IFM_IEEE80211_FH2, "FrequencyHopping/2Mbps" },                \
384        { IFM_IEEE80211_DS1, "DS1" },                                   \
385        { IFM_IEEE80211_DS2, "DS2" },                                   \
386        { IFM_IEEE80211_DS5, "DS5.5" },                                 \
387        { IFM_IEEE80211_DS11, "DS11" },                                 \
388        { IFM_IEEE80211_DS22, "DS22" },                                 \
389        { IFM_IEEE80211_DS1, "DirectSequence/1Mbps" },                  \
390        { IFM_IEEE80211_DS2, "DirectSequence/2Mbps" },                  \
391        { IFM_IEEE80211_DS5, "DirectSequence/5.5Mbps" },                \
392        { IFM_IEEE80211_DS11, "DirectSequence/11Mbps" },                \
393        { IFM_IEEE80211_DS22, "DirectSequence/22Mbps" },                \
394        { IFM_IEEE80211_ODFM6, "ODFM6" },                               \
395        { IFM_IEEE80211_ODFM9, "ODFM9" },                               \
396        { IFM_IEEE80211_ODFM12, "ODFM12" },                             \
397        { IFM_IEEE80211_ODFM18, "ODFM18" },                             \
398        { IFM_IEEE80211_ODFM24, "ODFM24" },                             \
399        { IFM_IEEE80211_ODFM36, "ODFM36" },                             \
400        { IFM_IEEE80211_ODFM48, "ODFM48" },                             \
401        { IFM_IEEE80211_ODFM54, "ODFM54" },                             \
402        { IFM_IEEE80211_ODFM72, "ODFM72" },                             \
403        { 0, NULL },                                                    \
404}
405
406#define IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS {                     \
407        { IFM_IEEE80211_ADHOC, "adhoc" },                               \
408        { IFM_IEEE80211_HOSTAP, "hostap" },                             \
409        { IFM_IEEE80211_IBSS, "ibss" },                                 \
410        { IFM_IEEE80211_IBSSMASTER, "ibss-master" },                    \
411        { 0, NULL },                                                    \
412}
413
414#define IFM_SUBTYPE_SHARED_DESCRIPTIONS {                               \
415        { IFM_AUTO,     "autoselect" },                                 \
416        { IFM_MANUAL,   "manual" },                                     \
417        { IFM_NONE,     "none" },                                       \
418        { 0, NULL },                                                    \
419}
420
421#define IFM_SUBTYPE_SHARED_ALIASES {                                    \
422        { IFM_AUTO,     "auto" },                                       \
423        { 0, NULL },                                                    \
424}
425
426#define IFM_SHARED_OPTION_DESCRIPTIONS {                                \
427        { IFM_FDX,      "full-duplex" },                                \
428        { IFM_HDX,      "half-duplex" },                                \
429        { IFM_FLAG0,    "flag0" },                                      \
430        { IFM_FLAG1,    "flag1" },                                      \
431        { IFM_FLAG2,    "flag2" },                                      \
432        { IFM_LOOP,     "hw-loopback" },                                \
433        { 0, NULL },                                                    \
434}
435
436#endif  /* _NET_IF_MEDIA_H_ */
Note: See TracBrowser for help on using the repository browser.