bsd/net/if_media.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, 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 #include <sys/queue.h>
  83
  84 /*
  85  * Driver callbacks for media status and change requests.
  86  */
  87 typedef int (*ifm_change_cb_t)(struct ifnet *ifp);
  88 typedef void (*ifm_stat_cb_t)(struct ifnet *ifp, struct ifmediareq *req);
  89
  90 /*
  91  * In-kernel representation of a single supported media type.
  92  */
  93 struct ifmedia_entry {
  94         LIST_ENTRY(ifmedia_entry) ifm_list;
  95         int     ifm_media;      /* description of this media attachment */
  96         int     ifm_data;       /* for driver-specific use */
  97         void    *ifm_aux;       /* for driver-specific use */
  98 };
  99
 100 /*
 101  * One of these goes into a network interface's softc structure.
 102  * It is used to keep general media state.
 103  */
 104 struct ifmedia {
 105         int     ifm_mask;       /* mask of changes we don't care about */
 106         int     ifm_media;      /* current user-set media word */
 107         struct ifmedia_entry *ifm_cur;  /* currently selected media */
 108         LIST_HEAD(, ifmedia_entry) ifm_list; /* list of all supported media */
 109         ifm_change_cb_t ifm_change;     /* media change driver callback */
 110         ifm_stat_cb_t   ifm_status;     /* media status driver callback */
 111 };
 112
 113 /* Initialize an interface's struct if_media field. */
 114 void    ifmedia_init(struct ifmedia *ifm, int dontcare_mask,
 115             ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback);
 116
 117 /* Add one supported medium to a struct ifmedia. */
 118 void    ifmedia_add(struct ifmedia *ifm, int mword, int data, void *aux);
 119
 120 /* Add an array (of ifmedia_entry) media to a struct ifmedia. */
 121 void    ifmedia_list_add(struct ifmedia *mp, struct ifmedia_entry *lp,
 122             int count);
 123
 124 /* Set default media type on initialization. */
 125 void    ifmedia_set(struct ifmedia *ifm, int mword);
 126
 127 /* Common ioctl function for getting/setting media, called by driver. */
 128 int     ifmedia_ioctl(struct ifnet *ifp, struct ifreq *ifr,
 129             struct ifmedia *ifm, uint32_t cmd);
 130
 131 #endif /* KERNEL_PRIVATE */
 132
 133 /*
 134  * if_media Options word:
 135  *      Bits    Use
 136  *      ----    -------
 137  *      0-4         Media subtype
 138  *      5-7     Media type
 139  *      8-15    Type specific options
 140  *      16-19   RFU
 141  *      20-27   Shared (global) options
 142  *      28-31   Instance
 143  */
 144
 145 /*
 146  * Ethernet
 147  */
 148 #define IFM_ETHER       0x00000020
 149 #define IFM_10_T        3               /* 10BaseT - RJ45 */
 150 #define IFM_10_2        4               /* 10Base2 - Thinnet */
 151 #define IFM_10_5        5               /* 10Base5 - AUI */
 152 #define IFM_100_TX      6               /* 100BaseTX - RJ45 */
 153 #define IFM_100_FX      7               /* 100BaseFX - Fiber */
 154 #define IFM_100_T4      8               /* 100BaseT4 - 4 pair cat 3 */
 155 #define IFM_100_VG      9               /* 100VG-AnyLAN */
 156 #define IFM_100_T2      10              /* 100BaseT2 */
 157 #define IFM_1000_SX     11              /* 1000BaseSX - multi-mode fiber */
 158 #define IFM_10_STP      12              /* 10BaseT over shielded TP */
 159 #define IFM_10_FL       13              /* 10baseFL - Fiber */
 160 #define IFM_1000_LX     14              /* 1000baseLX - single-mode fiber */
 161 #define IFM_1000_CX     15              /* 1000baseCX - 150ohm STP */
 162 #define IFM_1000_T      16              /* 1000baseT - 4 pair cat 5 */
 163 #ifdef PRIVATE
 164 #define IFM_1000_TX     IFM_1000_T      /* For compatibility */
 165 #endif /* PRIVATE */
 166 #define IFM_HPNA_1      17              /* HomePNA 1.0 (1Mb/s) */
 167 #define IFM_10G_SR      18              /* 10GbaseSR - multi-mode fiber */
 168 #define IFM_10G_LR      19              /* 10GbaseLR - single-mode fiber */
 169 #define IFM_10G_CX4     20              /* 10GbaseCX4 - copper */
 170 #define IFM_10G_T       21              /* 10GbaseT - 4 pair cat 6 */
 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_EEE         0x00800000      /* Support energy efficient ethernet */
 225 #define IFM_FLAG0       0x01000000      /* Driver defined flag */
 226 #define IFM_FLAG1       0x02000000      /* Driver defined flag */
 227 #define IFM_FLAG2       0x04000000      /* Driver defined flag */
 228 #define IFM_LOOP        0x08000000      /* Put hardware in loopback */
 229
 230 /*
 231  * Masks
 232  */
 233 #define IFM_NMASK       0x000000e0      /* Network type */
 234 #define IFM_TMASK       0x0000001f      /* Media sub-type */
 235 #define IFM_IMASK       0xf0000000      /* Instance */
 236 #define IFM_ISHIFT      28              /* Instance shift */
 237 #define IFM_OMASK       0x0000ff00      /* Type specific options */
 238 #define IFM_GMASK       0x0ff00000      /* Global options */
 239
 240 /*
 241  * Status bits
 242  */
 243 #define IFM_AVALID      0x00000001      /* Active bit valid */
 244 #define IFM_ACTIVE      0x00000002      /* Interface attached to working net */
 245
 246 /*
 247  * Macros to extract various bits of information from the media word.
 248  */
 249 #define IFM_TYPE(x)         ((x) & IFM_NMASK)
 250 #define IFM_SUBTYPE(x)      ((x) & IFM_TMASK)
 251 #define IFM_TYPE_OPTIONS(x) ((x) & IFM_OMASK)
 252 #define IFM_INST(x)         (((x) & IFM_IMASK) >> IFM_ISHIFT)
 253 #define IFM_OPTIONS(x)  ((x) & (IFM_OMASK|IFM_GMASK))
 254
 255 #define IFM_INST_MAX    IFM_INST(IFM_IMASK)
 256
 257 /*
 258  * Macro to create a media word.
 259  */
 260 #define IFM_MAKEWORD(type, subtype, options, instance)                  \
 261         ((type) | (subtype) | (options) | ((instance) << IFM_ISHIFT))
 262
 263 /*
 264  * NetBSD extension not defined in the BSDI API.  This is used in various
 265  * places to get the canonical description for a given type/subtype.
 266  *
 267  * NOTE: all but the top-level type descriptions must contain NO whitespace!
 268  * Otherwise, parsing these in ifconfig(8) would be a nightmare.
 269  */
 270 struct ifmedia_description {
 271         int     ifmt_word;              /* word value; may be masked */
 272         const char *ifmt_string;        /* description */
 273 };
 274
 275 #define IFM_TYPE_DESCRIPTIONS {                     \
 276     { IFM_ETHER,     "Ethernet"   },                \
 277     { IFM_TOKEN,     "Token ring" },                \
 278     { IFM_FDDI,      "FDDI"       },                \
 279     { IFM_IEEE80211, "IEEE802.11" },                \
 280     { 0, NULL },                                    \
 281 }
 282
 283 #define IFM_SUBTYPE_ETHERNET_DESCRIPTIONS {         \
 284     { IFM_10_T,     "10baseT/UTP" },                \
 285     { IFM_10_2,     "10base2/BNC" },                \
 286     { IFM_10_5,     "10base5/AUI" },                \
 287     { IFM_100_TX,   "100baseTX"   },                \
 288     { IFM_100_FX,   "100baseFX"   },                \
 289     { IFM_100_T4,   "100baseT4"   },                \
 290     { IFM_100_VG,   "100baseVG"   },                \
 291     { IFM_100_T2,   "100baseT2"   },                \
 292     { IFM_1000_SX,  "1000baseSX"  },                \
 293     { IFM_10_STP,   "10baseSTP"   },                \
 294     { IFM_10_FL,    "10baseFL"    },                \
 295     { IFM_1000_LX,  "1000baseLX"  },                \
 296     { IFM_1000_CX,  "1000baseCX"  },                \
 297     { IFM_1000_T,   "1000baseT"   },                \
 298     { IFM_HPNA_1,   "HomePNA1"    },                \
 299     { IFM_10G_SR,   "10GbaseSR"   },                \
 300     { IFM_10G_LR,   "10GbaseLR"   },                \
 301     { IFM_10G_CX4,  "10GbaseCX4"  },                \
 302     { IFM_10G_T,    "10GbaseT"    },                \
 303     { 0, NULL },                                    \
 304 }
 305
 306 #define IFM_SUBTYPE_ETHERNET_ALIASES {              \
 307     { IFM_10_T,     "UTP"    },                     \
 308     { IFM_10_T,     "10UTP"  },                     \
 309     { IFM_10_2,     "BNC"    },                     \
 310     { IFM_10_2,     "10BNC"  },                     \
 311     { IFM_10_5,     "AUI"    },                     \
 312     { IFM_10_5,     "10AUI"  },                     \
 313     { IFM_100_TX,   "100TX"  },                     \
 314     { IFM_100_FX,   "100FX"  },                     \
 315     { IFM_100_T4,   "100T4"  },                     \
 316     { IFM_100_VG,   "100VG"  },                     \
 317     { IFM_100_T2,   "100T2"  },                     \
 318     { IFM_1000_SX,  "1000SX" },                     \
 319     { IFM_10_STP,   "STP"    },                     \
 320     { IFM_10_STP,   "10STP"  },                     \
 321     { IFM_10_FL,    "FL"     },                     \
 322     { IFM_10_FL,    "10FL"   },                     \
 323     { IFM_1000_LX,  "1000LX" },                     \
 324     { IFM_1000_CX,  "1000CX" },                     \
 325     { IFM_1000_T,   "1000T"  },                     \
 326     { IFM_HPNA_1,   "HPNA1"  },                     \
 327     { IFM_10G_SR,   "10GSR"  },                     \
 328     { IFM_10G_LR,   "10GLR"  },                     \
 329     { IFM_10G_CX4,  "10GCX4" },                     \
 330     { IFM_10G_T,    "10GT"   },                     \
 331     { 0, NULL },                                    \
 332 }
 333
 334 #define IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS {  \
 335     { 0, NULL },                                    \
 336 }
 337
 338 #define IFM_SUBTYPE_TOKENRING_DESCRIPTIONS {        \
 339     { IFM_TOK_STP4,  "DB9/4Mbit" },                 \
 340     { IFM_TOK_STP16, "DB9/16Mbit" },                \
 341     { IFM_TOK_UTP4,  "UTP/4Mbit" },                 \
 342     { IFM_TOK_UTP16, "UTP/16Mbit" },                \
 343     { 0, NULL },                                    \
 344 }
 345
 346 #define IFM_SUBTYPE_TOKENRING_ALIASES {             \
 347     { IFM_TOK_STP4,  "4STP" },                      \
 348     { IFM_TOK_STP16, "16STP" },                     \
 349     { IFM_TOK_UTP4,  "4UTP" },                      \
 350     { IFM_TOK_UTP16, "16UTP" },                     \
 351     { 0, NULL },                                    \
 352 }
 353
 354 #define IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS { \
 355     { IFM_TOK_ETR,   "EarlyTokenRelease" },         \
 356     { IFM_TOK_SRCRT, "SourceRouting" },             \
 357     { IFM_TOK_ALLR,  "AllRoutes" },                 \
 358     { 0, NULL },                                    \
 359 }
 360
 361 #define IFM_SUBTYPE_FDDI_DESCRIPTIONS {             \
 362     { IFM_FDDI_SMF, "Single-mode" },                \
 363     { IFM_FDDI_MMF, "Multi-mode" },                 \
 364     { IFM_FDDI_UTP, "UTP" },                        \
 365     { 0, NULL },                                    \
 366 }
 367
 368 #define IFM_SUBTYPE_FDDI_ALIASES {                  \
 369     { IFM_FDDI_SMF, "SMF" },                        \
 370     { IFM_FDDI_MMF, "MMF" },                        \
 371     { IFM_FDDI_UTP, "CDDI" },                       \
 372     { 0, NULL },                                    \
 373 }
 374
 375 #define IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS {      \
 376     { IFM_FDDI_DA,  "Dual-attach" },                \
 377     { 0, NULL },                                    \
 378 }
 379
 380 #define IFM_SUBTYPE_IEEE80211_DESCRIPTIONS {        \
 381     { IFM_IEEE80211_FH1,  "FH1"  },                 \
 382     { IFM_IEEE80211_FH2,  "FH2"  },                 \
 383     { IFM_IEEE80211_DS1,  "DS1"  },                 \
 384     { IFM_IEEE80211_DS2,  "DS2"  },                 \
 385     { IFM_IEEE80211_DS5,  "DS5"  },                 \
 386     { IFM_IEEE80211_DS11, "DS11" },                 \
 387     { IFM_IEEE80211_DS22, "DS22" },                 \
 388     { 0, NULL },                                    \
 389 }
 390
 391 #define IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS { \
 392     { IFM_IEEE80211_ADHOC,  "adhoc" },              \
 393     { 0, NULL },                                    \
 394 }
 395
 396 #define IFM_SUBTYPE_SHARED_DESCRIPTIONS {           \
 397     { IFM_AUTO,     "autoselect" },                 \
 398     { IFM_MANUAL,   "manual" },                     \
 399     { IFM_NONE,     "none" },                       \
 400     { 0, NULL },                                    \
 401 }
 402
 403 #define IFM_SUBTYPE_SHARED_ALIASES {                \
 404     { IFM_AUTO,     "auto" },                       \
 405     { 0, NULL },                                    \
 406 }
 407
 408 #define IFM_SHARED_OPTION_DESCRIPTIONS {            \
 409     { IFM_FDX,      "full-duplex" },                \
 410     { IFM_HDX,      "half-duplex" },                \
 411     { IFM_FLOW,     "flow-control" },               \
 412     { IFM_EEE,      "energy-efficient-ethernet" },  \
 413     { IFM_FLAG0,    "flag0" },                      \
 414     { IFM_FLAG1,    "flag1" },                      \
 415     { IFM_FLAG2,    "flag2" },                      \
 416     { IFM_LOOP,     "hw-loopback" },                \
 417     { 0, NULL },                                    \
 418 }
 419
 420 #endif  /* _NET_IF_MEDIA_H_ */