sys/net/if_media.h

   1 /*      $NetBSD: if_media.h,v 1.3 1997/03/26 01:19:27 thorpej Exp $     */
   2 /* $FreeBSD$ */
   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  */
  60 typedef int (*ifm_change_cb_t) __P((struct ifnet *ifp));
  61 typedef 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  */
  66 struct 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  */
  77 struct 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. */
  87 void    ifmedia_init __P((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.  */
  91 void    ifmedia_removeall __P(( struct ifmedia *ifm));
  92
  93 /* Add one supported medium to a struct ifmedia. */
  94 void    ifmedia_add __P((struct ifmedia *ifm, int mword, int data, void *aux));
  95
  96 /* Add an array (of ifmedia_entry) media to a struct ifmedia. */
  97 void    ifmedia_list_add(struct ifmedia *mp, struct ifmedia_entry *lp,
  98             int count);
  99
 100 /* Set default media type on initialization. */
 101 void    ifmedia_set __P((struct ifmedia *ifm, int mword));
 102
 103 /* Common ioctl function for getting/setting media, called by driver. */
 104 int     ifmedia_ioctl __P((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_FX     11              /* 1000BaseFX - gigabit over fiber */
 134 #define IFM_10_STP      12              /* 10BaseT over shielded TP */
 135 #define IFM_10_FL       13              /* 10baseFL - Fiber */
 136 #define IFM_1000_SX     14              /* 1000BaseSX Multi-mode Fiber */
 137 #define IFM_1000_LX     15              /* 1000BaseLX Single-mode Fiber */
 138 #define IFM_1000_CX     16              /* 1000BaseCX 150ohm STP */
 139 #define IFM_1000_TX     17              /* 1000BaseTX 4 pair cat 5 */
 140 #define IFM_homePNA     18              /* HomePNA media for ethernet frames */
 141 /* note 31 is the max! */
 142
 143 /*
 144  * Token ring
 145  */
 146 #define IFM_TOKEN       0x00000040
 147 #define IFM_TOK_STP4    3               /* Shielded twisted pair 4m - DB9 */
 148 #define IFM_TOK_STP16   4               /* Shielded twisted pair 16m - DB9 */
 149 #define IFM_TOK_UTP4    5               /* Unshielded twisted pair 4m - RJ45 */
 150 #define IFM_TOK_UTP16   6               /* Unshielded twisted pair 16m - RJ45 */
 151 #define IFM_TOK_STP100  7               /* Shielded twisted pair 100m - DB9 */
 152 #define IFM_TOK_UTP100  8               /* Unshielded twisted pair 100m - RJ45 */
 153 #define IFM_TOK_ETR     0x00000200      /* Early token release */
 154 #define IFM_TOK_SRCRT   0x00000400      /* Enable source routing features */
 155 #define IFM_TOK_ALLR    0x00000800      /* All routes / Single route bcast */
 156 #define IFM_TOK_DTR     0x00002000      /* Dedicated token ring */
 157 #define IFM_TOK_CLASSIC 0x00004000      /* Classic token ring */
 158 #define IFM_TOK_AUTO    0x00008000      /* Automatic Dedicate/Classic token ring */
 159
 160 /*
 161  * FDDI
 162  */
 163 #define IFM_FDDI        0x00000060
 164 #define IFM_FDDI_SMF    3               /* Single-mode fiber */
 165 #define IFM_FDDI_MMF    4               /* Multi-mode fiber */
 166 #define IFM_FDDI_UTP    5               /* CDDI / UTP */
 167 #define IFM_FDDI_DA     0x00000100      /* Dual attach / single attach */
 168
 169 /*
 170  * Shared media sub-types
 171  */
 172 #define IFM_AUTO        0               /* Autoselect best media */
 173 #define IFM_MANUAL      1               /* Jumper/dipswitch selects media */
 174 #define IFM_NONE        2               /* Deselect all media */
 175
 176 /*
 177  * Shared options
 178  */
 179 #define IFM_FDX         0x00100000      /* Force full duplex */
 180 #define IFM_HDX         0x00200000      /* Force half duplex */
 181 #define IFM_FLAG0       0x01000000      /* Driver defined flag */
 182 #define IFM_FLAG1       0x02000000      /* Driver defined flag */
 183 #define IFM_FLAG2       0x04000000      /* Driver defined flag */
 184 #define IFM_LOOP        0x08000000      /* Put hardware in loopback */
 185
 186 /*
 187  * Masks
 188  */
 189 #define IFM_NMASK       0x000000e0      /* Network type */
 190 #define IFM_TMASK       0x0000001f      /* Media sub-type */
 191 #define IFM_IMASK       0xf0000000      /* Instance */
 192 #define IFM_ISHIFT      28              /* Instance shift */
 193 #define IFM_OMASK       0x0000ff00      /* Type specific options */
 194 #define IFM_GMASK       0x0ff00000      /* Global options */
 195
 196 /*
 197  * Status bits
 198  */
 199 #define IFM_AVALID      0x00000001      /* Active bit valid */
 200 #define IFM_ACTIVE      0x00000002      /* Interface attached to working net */
 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  */
 226 struct 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         { 0, NULL },                                                    \
 236 }
 237
 238 #define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS {                             \
 239         { IFM_10_T,     "10baseT/UTP" },                                \
 240         { IFM_10_2,     "10base2/BNC" },                                \
 241         { IFM_10_5,     "10base5/AUI" },                                \
 242         { IFM_100_TX,   "100baseTX" },                                  \
 243         { IFM_100_FX,   "100baseFX" },                                  \
 244         { IFM_100_T4,   "100baseT4" },                                  \
 245         { IFM_100_VG,   "100baseVG" },                                  \
 246         { IFM_100_T2,   "100baseT2" },                                  \
 247         { IFM_1000_FX,  "1000baseFX" },                                 \
 248         { IFM_10_STP,   "10baseSTP" },                                  \
 249         { IFM_10_FL,    "10baseFL" },                                   \
 250         { IFM_1000_SX,  "1000baseSX" },                                 \
 251         { IFM_1000_LX,  "1000baseLX" },                                 \
 252         { IFM_1000_CX,  "1000baseCX" },                                 \
 253         { IFM_1000_TX,  "1000baseTX" },                                 \
 254         { IFM_homePNA,  "homePNA" },                                    \
 255         { 0, NULL },                                                    \
 256 }
 257
 258 #define IFM_SUBTYPE_ETHERNET_ALIASES {                                  \
 259         { IFM_10_T,     "UTP" },                                        \
 260         { IFM_10_T,     "10UTP" },                                      \
 261         { IFM_10_2,     "BNC" },                                        \
 262         { IFM_10_2,     "10BNC" },                                      \
 263         { IFM_10_5,     "AUI" },                                        \
 264         { IFM_10_5,     "10AUI" },                                      \
 265         { IFM_100_TX,   "100TX" },                                      \
 266         { IFM_100_FX,   "100FX" },                                      \
 267         { IFM_100_T4,   "100T4" },                                      \
 268         { IFM_100_VG,   "100VG" },                                      \
 269         { IFM_100_T2,   "100T2" },                                      \
 270         { IFM_1000_FX,  "1000FX" },                                     \
 271         { IFM_10_STP,   "10STP" },                                      \
 272         { IFM_10_FL,    "10FL" },                                       \
 273         { IFM_1000_FX,  "1000SX" },                                     \
 274         { IFM_1000_FX,  "1000LX" },                                     \
 275         { IFM_1000_FX,  "1000CX" },                                     \
 276         { IFM_1000_FX,  "1000TX" },                                     \
 277         { 0, NULL },                                                    \
 278 }
 279
 280 #define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS {                      \
 281         { 0, NULL },                                                    \
 282 }
 283
 284 #define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS {                            \
 285         { IFM_TOK_STP4, "DB9/4Mbit" },                                  \
 286         { IFM_TOK_STP16, "DB9/16Mbit" },                                \
 287         { IFM_TOK_UTP4, "UTP/4Mbit" },                                  \
 288         { IFM_TOK_UTP16, "UTP/16Mbit" },                                \
 289         { IFM_TOK_STP100, "STP/100Mbit" },                              \
 290         { IFM_TOK_UTP100, "UTP/100Mbit" },                              \
 291         { 0, NULL },                                                    \
 292 }
 293
 294 #define IFM_SUBTYPE_TOKENRING_ALIASES {                                 \
 295         { IFM_TOK_STP4, "4STP" },                                       \
 296         { IFM_TOK_STP16, "16STP" },                                     \
 297         { IFM_TOK_UTP4, "4UTP" },                                       \
 298         { IFM_TOK_UTP16, "16UTP" },                                     \
 299         { IFM_TOK_STP100, "100STP" },                                   \
 300         { IFM_TOK_UTP100, "100UTP" },                                   \
 301         { 0, NULL },                                                    \
 302 }
 303
 304 #define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS {                     \
 305         { IFM_TOK_ETR,  "EarlyTokenRelease" },                          \
 306         { IFM_TOK_SRCRT, "SourceRouting" },                             \
 307         { IFM_TOK_ALLR, "AllRoutes" },                                  \
 308         { IFM_TOK_DTR,  "Dedicated" },                                  \
 309         { IFM_TOK_CLASSIC,"Classic" },                                  \
 310         { IFM_TOK_AUTO, " " },                                          \
 311         { 0, NULL },                                                    \
 312 }
 313
 314 #define IFM_SUBTYPE_FDDI_DESCRIPTIONS {                                 \
 315         { IFM_FDDI_SMF, "Single-mode" },                                \
 316         { IFM_FDDI_MMF, "Multi-mode" },                                 \
 317         { IFM_FDDI_UTP, "UTP" },                                        \
 318         { 0, NULL },                                                    \
 319 }
 320
 321 #define IFM_SUBTYPE_FDDI_ALIASES {                                      \
 322         { IFM_FDDI_SMF, "SMF" },                                        \
 323         { IFM_FDDI_MMF, "MMF" },                                        \
 324         { IFM_FDDI_UTP, "CDDI" },                                       \
 325         { 0, NULL },                                                    \
 326 }
 327
 328 #define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS {                          \
 329         { IFM_FDDI_DA, "Dual-attach" },                                 \
 330         { 0, NULL },                                                    \
 331 }
 332
 333 #define IFM_SUBTYPE_SHARED_DESCRIPTIONS {                               \
 334         { IFM_AUTO,     "autoselect" },                                 \
 335         { IFM_MANUAL,   "manual" },                                     \
 336         { IFM_NONE,     "none" },                                       \
 337         { 0, NULL },                                                    \
 338 }
 339
 340 #define IFM_SUBTYPE_SHARED_ALIASES {                                    \
 341         { IFM_AUTO,     "auto" },                                       \
 342         { 0, NULL },                                                    \
 343 }
 344
 345 #define IFM_SHARED_OPTION_DESCRIPTIONS {                                \
 346         { IFM_FDX,      "full-duplex" },                                \
 347         { IFM_HDX,      "half-duplex" },                                \
 348         { IFM_FLAG0,    "flag0" },                                      \
 349         { IFM_FLAG1,    "flag1" },                                      \
 350         { IFM_FLAG2,    "flag2" },                                      \
 351         { IFM_LOOP,     "hw-loopback" },                                \
 352         { 0, NULL },                                                    \
 353 }
 354
 355 #endif  /* _NET_IF_MEDIA_H_ */