bsd/net/if_media.h

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