bsd/net/if_media.h

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