sys/net/if_media.c

   1 /*      $NetBSD: if_media.c,v 1.1 1997/03/17 02:55:15 thorpej Exp $     */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-4-Clause
   5  *
   6  * Copyright (c) 1997
   7  *      Jonathan Stone and Jason R. Thorpe.  All rights reserved.
   8  *
   9  * This software is derived from information provided by Matt Thomas.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by Jonathan Stone
  22  *      and Jason R. Thorpe for the NetBSD Project.
  23  * 4. The names of the authors may not be used to endorse or promote products
  24  *    derived from this software without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  27  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  28  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  33  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  34  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  */
  38
  39 /*
  40  * BSD/OS-compatible network interface media selection.
  41  *
  42  * Where it is safe to do so, this code strays slightly from the BSD/OS
  43  * design.  Software which uses the API (device drivers, basically)
  44  * shouldn't notice any difference.
  45  *
  46  * Many thanks to Matt Thomas for providing the information necessary
  47  * to implement this interface.
  48  */
  49
  50 #include <sys/cdefs.h>
  51 __FBSDID("$FreeBSD$");
  52
  53 #include "opt_ifmedia.h"
  54
  55 #include <sys/param.h>
  56 #include <sys/systm.h>
  57 #include <sys/socket.h>
  58 #include <sys/sockio.h>
  59 #include <sys/malloc.h>
  60 #include <sys/module.h>
  61 #include <sys/sysctl.h>
  62
  63 #include <net/if.h>
  64 #include <net/if_media.h>
  65
  66 /*
  67  * Compile-time options:
  68  * IFMEDIA_DEBUG:
  69  *      turn on implementation-level debug printfs.
  70  *      Useful for debugging newly-ported  drivers.
  71  */
  72
  73 static struct ifmedia_entry *ifmedia_match(struct ifmedia *ifm,
  74     int flags, int mask);
  75
  76 #ifdef IFMEDIA_DEBUG
  77 #include <net/if_var.h>
  78 int     ifmedia_debug = 0;
  79 SYSCTL_INT(_debug, OID_AUTO, ifmedia, CTLFLAG_RW, &ifmedia_debug,
  80             0, "if_media debugging msgs");
  81 static  void ifmedia_printword(int);
  82 #endif
  83
  84 /*
  85  * Initialize if_media struct for a specific interface instance.
  86  */
  87 void
  88 ifmedia_init(struct ifmedia *ifm, int dontcare_mask,
  89     ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback)
  90 {
  91
  92         LIST_INIT(&ifm->ifm_list);
  93         ifm->ifm_cur = NULL;
  94         ifm->ifm_media = 0;
  95         ifm->ifm_mask = dontcare_mask;          /* IF don't-care bits */
  96         ifm->ifm_change = change_callback;
  97         ifm->ifm_status = status_callback;
  98 }
  99
 100 void
 101 ifmedia_removeall(struct ifmedia *ifm)
 102 {
 103         struct ifmedia_entry *entry;
 104
 105         for (entry = LIST_FIRST(&ifm->ifm_list); entry;
 106              entry = LIST_FIRST(&ifm->ifm_list)) {
 107                 LIST_REMOVE(entry, ifm_list);
 108                 free(entry, M_IFADDR);
 109         }
 110         ifm->ifm_cur = NULL;
 111 }
 112
 113 /*
 114  * Add a media configuration to the list of supported media
 115  * for a specific interface instance.
 116  */
 117 void
 118 ifmedia_add(struct ifmedia *ifm, int mword, int data, void *aux)
 119 {
 120         struct ifmedia_entry *entry;
 121
 122 #ifdef IFMEDIA_DEBUG
 123         if (ifmedia_debug) {
 124                 if (ifm == NULL) {
 125                         printf("ifmedia_add: null ifm\n");
 126                         return;
 127                 }
 128                 printf("Adding entry for ");
 129                 ifmedia_printword(mword);
 130         }
 131 #endif
 132
 133         entry = malloc(sizeof(*entry), M_IFADDR, M_NOWAIT);
 134         if (entry == NULL)
 135                 panic("ifmedia_add: can't malloc entry");
 136
 137         entry->ifm_media = mword;
 138         entry->ifm_data = data;
 139         entry->ifm_aux = aux;
 140
 141         LIST_INSERT_HEAD(&ifm->ifm_list, entry, ifm_list);
 142 }
 143
 144 /*
 145  * Add an array of media configurations to the list of
 146  * supported media for a specific interface instance.
 147  */
 148 void
 149 ifmedia_list_add(struct ifmedia *ifm, struct ifmedia_entry *lp, int count)
 150 {
 151         int i;
 152
 153         for (i = 0; i < count; i++)
 154                 ifmedia_add(ifm, lp[i].ifm_media, lp[i].ifm_data,
 155                     lp[i].ifm_aux);
 156 }
 157
 158 /*
 159  * Set the default active media.
 160  *
 161  * Called by device-specific code which is assumed to have already
 162  * selected the default media in hardware.  We do _not_ call the
 163  * media-change callback.
 164  */
 165 void
 166 ifmedia_set(struct ifmedia *ifm, int target)
 167 {
 168         struct ifmedia_entry *match;
 169
 170         match = ifmedia_match(ifm, target, ifm->ifm_mask);
 171
 172         if (match == NULL) {
 173                 printf("ifmedia_set: no match for 0x%x/0x%x\n",
 174                     target, ~ifm->ifm_mask);
 175                 panic("ifmedia_set");
 176         }
 177         ifm->ifm_cur = match;
 178
 179 #ifdef IFMEDIA_DEBUG
 180         if (ifmedia_debug) {
 181                 printf("ifmedia_set: target ");
 182                 ifmedia_printword(target);
 183                 printf("ifmedia_set: setting to ");
 184                 ifmedia_printword(ifm->ifm_cur->ifm_media);
 185         }
 186 #endif
 187 }
 188
 189 /*
 190  * Given a media word, return one suitable for an application
 191  * using the original encoding.
 192  */
 193 static int
 194 compat_media(int media)
 195 {
 196
 197         if (IFM_TYPE(media) == IFM_ETHER && IFM_SUBTYPE(media) > IFM_OTHER) {
 198                 media &= ~(IFM_ETH_XTYPE|IFM_TMASK);
 199                 media |= IFM_OTHER;
 200         }
 201         return (media);
 202 }
 203
 204 /*
 205  * Device-independent media ioctl support function.
 206  */
 207 int
 208 ifmedia_ioctl(struct ifnet *ifp, struct ifreq *ifr, struct ifmedia *ifm,
 209     u_long cmd)
 210 {
 211         struct ifmedia_entry *match;
 212         struct ifmediareq *ifmr = (struct ifmediareq *) ifr;
 213         int error = 0;
 214
 215         if (ifp == NULL || ifr == NULL || ifm == NULL)
 216                 return(EINVAL);
 217
 218         switch (cmd) {
 219
 220         /*
 221          * Set the current media.
 222          */
 223         case  SIOCSIFMEDIA:
 224         {
 225                 struct ifmedia_entry *oldentry;
 226                 int oldmedia;
 227                 int newmedia = ifr->ifr_media;
 228
 229                 match = ifmedia_match(ifm, newmedia, ifm->ifm_mask);
 230                 if (match == NULL) {
 231 #ifdef IFMEDIA_DEBUG
 232                         if (ifmedia_debug) {
 233                                 printf(
 234                                     "ifmedia_ioctl: no media found for 0x%x\n",
 235                                     newmedia);
 236                         }
 237 #endif
 238                         return (ENXIO);
 239                 }
 240
 241                 /*
 242                  * If no change, we're done.
 243                  * XXX Automedia may invole software intervention.
 244                  *     Keep going in case the connected media changed.
 245                  *     Similarly, if best match changed (kernel debugger?).
 246                  */
 247                 if ((IFM_SUBTYPE(newmedia) != IFM_AUTO) &&
 248                     (newmedia == ifm->ifm_media) &&
 249                     (match == ifm->ifm_cur))
 250                         return 0;
 251
 252                 /*
 253                  * We found a match, now make the driver switch to it.
 254                  * Make sure to preserve our old media type in case the
 255                  * driver can't switch.
 256                  */
 257 #ifdef IFMEDIA_DEBUG
 258                 if (ifmedia_debug) {
 259                         printf("ifmedia_ioctl: switching %s to ",
 260                             ifp->if_xname);
 261                         ifmedia_printword(match->ifm_media);
 262                 }
 263 #endif
 264                 oldentry = ifm->ifm_cur;
 265                 oldmedia = ifm->ifm_media;
 266                 ifm->ifm_cur = match;
 267                 ifm->ifm_media = newmedia;
 268                 error = (*ifm->ifm_change)(ifp);
 269                 if (error) {
 270                         ifm->ifm_cur = oldentry;
 271                         ifm->ifm_media = oldmedia;
 272                 }
 273                 break;
 274         }
 275
 276         /*
 277          * Get list of available media and current media on interface.
 278          */
 279         case  SIOCGIFMEDIA:
 280         case  SIOCGIFXMEDIA:
 281         {
 282                 struct ifmedia_entry *ep;
 283                 int i;
 284
 285                 if (ifmr->ifm_count < 0)
 286                         return (EINVAL);
 287
 288                 if (cmd == SIOCGIFMEDIA) {
 289                         ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
 290                             compat_media(ifm->ifm_cur->ifm_media) : IFM_NONE;
 291                 } else {
 292                         ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
 293                             ifm->ifm_cur->ifm_media : IFM_NONE;
 294                 }
 295                 ifmr->ifm_mask = ifm->ifm_mask;
 296                 ifmr->ifm_status = 0;
 297                 (*ifm->ifm_status)(ifp, ifmr);
 298
 299                 /*
 300                  * If there are more interfaces on the list, count
 301                  * them.  This allows the caller to set ifmr->ifm_count
 302                  * to 0 on the first call to know how much space to
 303                  * allocate.
 304                  */
 305                 i = 0;
 306                 LIST_FOREACH(ep, &ifm->ifm_list, ifm_list)
 307                         if (i++ < ifmr->ifm_count) {
 308                                 error = copyout(&ep->ifm_media,
 309                                     ifmr->ifm_ulist + i - 1, sizeof(int));
 310                                 if (error)
 311                                         break;
 312                         }
 313                 if (error == 0 && i > ifmr->ifm_count)
 314                         error = ifmr->ifm_count ? E2BIG : 0;
 315                 ifmr->ifm_count = i;
 316                 break;
 317         }
 318
 319         default:
 320                 return (EINVAL);
 321         }
 322
 323         return (error);
 324 }
 325
 326 /*
 327  * Find media entry matching a given ifm word.
 328  *
 329  */
 330 static struct ifmedia_entry *
 331 ifmedia_match(struct ifmedia *ifm, int target, int mask)
 332 {
 333         struct ifmedia_entry *match, *next;
 334
 335         match = NULL;
 336         mask = ~mask;
 337
 338         LIST_FOREACH(next, &ifm->ifm_list, ifm_list) {
 339                 if ((next->ifm_media & mask) == (target & mask)) {
 340 #if defined(IFMEDIA_DEBUG) || defined(DIAGNOSTIC)
 341                         if (match) {
 342                                 printf("ifmedia_match: multiple match for "
 343                                     "0x%x/0x%x\n", target, mask);
 344                         }
 345 #endif
 346                         match = next;
 347                 }
 348         }
 349
 350         return match;
 351 }
 352
 353 /*
 354  * Compute the interface `baudrate' from the media, for the interface
 355  * metrics (used by routing daemons).
 356  */
 357 static const struct ifmedia_baudrate ifmedia_baudrate_descriptions[] =
 358     IFM_BAUDRATE_DESCRIPTIONS;
 359
 360 uint64_t
 361 ifmedia_baudrate(int mword)
 362 {
 363         int i;
 364
 365         for (i = 0; ifmedia_baudrate_descriptions[i].ifmb_word != 0; i++) {
 366                 if (IFM_TYPE_MATCH(mword, ifmedia_baudrate_descriptions[i].ifmb_word))
 367                         return (ifmedia_baudrate_descriptions[i].ifmb_baudrate);
 368         }
 369
 370         /* Not known. */
 371         return (0);
 372 }
 373
 374 #ifdef IFMEDIA_DEBUG
 375 static const struct ifmedia_description ifm_type_descriptions[] =
 376     IFM_TYPE_DESCRIPTIONS;
 377
 378 static const struct ifmedia_description ifm_subtype_ethernet_descriptions[] =
 379     IFM_SUBTYPE_ETHERNET_DESCRIPTIONS;
 380
 381 static const struct ifmedia_description
 382     ifm_subtype_ethernet_option_descriptions[] =
 383     IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS;
 384
 385 static const struct ifmedia_description ifm_subtype_ieee80211_descriptions[] =
 386     IFM_SUBTYPE_IEEE80211_DESCRIPTIONS;
 387
 388 static const struct ifmedia_description
 389     ifm_subtype_ieee80211_option_descriptions[] =
 390     IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS;
 391
 392 static const struct ifmedia_description
 393     ifm_subtype_ieee80211_mode_descriptions[] =
 394     IFM_SUBTYPE_IEEE80211_MODE_DESCRIPTIONS;
 395
 396 static const struct ifmedia_description ifm_subtype_atm_descriptions[] =
 397     IFM_SUBTYPE_ATM_DESCRIPTIONS;
 398
 399 static const struct ifmedia_description ifm_subtype_atm_option_descriptions[] =
 400     IFM_SUBTYPE_ATM_OPTION_DESCRIPTIONS;
 401
 402 static const struct ifmedia_description ifm_subtype_shared_descriptions[] =
 403     IFM_SUBTYPE_SHARED_DESCRIPTIONS;
 404
 405 static const struct ifmedia_description ifm_shared_option_descriptions[] =
 406     IFM_SHARED_OPTION_DESCRIPTIONS;
 407
 408 struct ifmedia_type_to_subtype {
 409         const struct ifmedia_description *subtypes;
 410         const struct ifmedia_description *options;
 411         const struct ifmedia_description *modes;
 412 };
 413
 414 /* must be in the same order as IFM_TYPE_DESCRIPTIONS */
 415 static const struct ifmedia_type_to_subtype ifmedia_types_to_subtypes[] = {
 416         {
 417           &ifm_subtype_ethernet_descriptions[0],
 418           &ifm_subtype_ethernet_option_descriptions[0],
 419           NULL,
 420         },
 421         {
 422           &ifm_subtype_ieee80211_descriptions[0],
 423           &ifm_subtype_ieee80211_option_descriptions[0],
 424           &ifm_subtype_ieee80211_mode_descriptions[0]
 425         },
 426         {
 427           &ifm_subtype_atm_descriptions[0],
 428           &ifm_subtype_atm_option_descriptions[0],
 429           NULL,
 430         },
 431 };
 432
 433 /*
 434  * print a media word.
 435  */
 436 static void
 437 ifmedia_printword(int ifmw)
 438 {
 439         const struct ifmedia_description *desc;
 440         const struct ifmedia_type_to_subtype *ttos;
 441         int seen_option = 0;
 442
 443         /* Find the top-level interface type. */
 444         for (desc = ifm_type_descriptions, ttos = ifmedia_types_to_subtypes;
 445             desc->ifmt_string != NULL; desc++, ttos++)
 446                 if (IFM_TYPE(ifmw) == desc->ifmt_word)
 447                         break;
 448         if (desc->ifmt_string == NULL) {
 449                 printf("<unknown type>\n");
 450                 return;
 451         }
 452         printf("%s", desc->ifmt_string);
 453
 454         /* Any mode. */
 455         for (desc = ttos->modes; desc && desc->ifmt_string != NULL; desc++)
 456                 if (IFM_MODE(ifmw) == desc->ifmt_word) {
 457                         if (desc->ifmt_string != NULL)
 458                                 printf(" mode %s", desc->ifmt_string);
 459                         break;
 460                 }
 461
 462         /*
 463          * Check for the shared subtype descriptions first, then the
 464          * type-specific ones.
 465          */
 466         for (desc = ifm_subtype_shared_descriptions;
 467             desc->ifmt_string != NULL; desc++)
 468                 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
 469                         goto got_subtype;
 470
 471         for (desc = ttos->subtypes; desc->ifmt_string != NULL; desc++)
 472                 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
 473                         break;
 474         if (desc->ifmt_string == NULL) {
 475                 printf(" <unknown subtype>\n");
 476                 return;
 477         }
 478
 479  got_subtype:
 480         printf(" %s", desc->ifmt_string);
 481
 482         /*
 483          * Look for shared options.
 484          */
 485         for (desc = ifm_shared_option_descriptions;
 486             desc->ifmt_string != NULL; desc++) {
 487                 if (ifmw & desc->ifmt_word) {
 488                         if (seen_option == 0)
 489                                 printf(" <");
 490                         printf("%s%s", seen_option++ ? "," : "",
 491                             desc->ifmt_string);
 492                 }
 493         }
 494
 495         /*
 496          * Look for subtype-specific options.
 497          */
 498         for (desc = ttos->options; desc->ifmt_string != NULL; desc++) {
 499                 if (ifmw & desc->ifmt_word) {
 500                         if (seen_option == 0)
 501                                 printf(" <");
 502                         printf("%s%s", seen_option++ ? "," : "",
 503                             desc->ifmt_string);
 504                 }
 505         }
 506         printf("%s\n", seen_option ? ">" : "");
 507 }
 508 #endif /* IFMEDIA_DEBUG */