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         while ((entry = LIST_FIRST(&ifm->ifm_list)) != NULL) {
 106                 LIST_REMOVE(entry, ifm_list);
 107                 free(entry, M_IFADDR);
 108         }
 109         ifm->ifm_cur = NULL;
 110 }
 111
 112 /*
 113  * Add a media configuration to the list of supported media
 114  * for a specific interface instance.
 115  */
 116 void
 117 ifmedia_add(struct ifmedia *ifm, int mword, int data, void *aux)
 118 {
 119         struct ifmedia_entry *entry;
 120
 121 #ifdef IFMEDIA_DEBUG
 122         if (ifmedia_debug) {
 123                 if (ifm == NULL) {
 124                         printf("ifmedia_add: null ifm\n");
 125                         return;
 126                 }
 127                 printf("Adding entry for ");
 128                 ifmedia_printword(mword);
 129         }
 130 #endif
 131
 132         entry = malloc(sizeof(*entry), M_IFADDR, M_NOWAIT);
 133         if (entry == NULL)
 134                 panic("ifmedia_add: can't malloc entry");
 135
 136         entry->ifm_media = mword;
 137         entry->ifm_data = data;
 138         entry->ifm_aux = aux;
 139
 140         LIST_INSERT_HEAD(&ifm->ifm_list, entry, ifm_list);
 141 }
 142
 143 /*
 144  * Add an array of media configurations to the list of
 145  * supported media for a specific interface instance.
 146  */
 147 void
 148 ifmedia_list_add(struct ifmedia *ifm, struct ifmedia_entry *lp, int count)
 149 {
 150         int i;
 151
 152         for (i = 0; i < count; i++)
 153                 ifmedia_add(ifm, lp[i].ifm_media, lp[i].ifm_data,
 154                     lp[i].ifm_aux);
 155 }
 156
 157 /*
 158  * Set the default active media.
 159  *
 160  * Called by device-specific code which is assumed to have already
 161  * selected the default media in hardware.  We do _not_ call the
 162  * media-change callback.
 163  */
 164 void
 165 ifmedia_set(struct ifmedia *ifm, int target)
 166 {
 167         struct ifmedia_entry *match;
 168
 169         match = ifmedia_match(ifm, target, ifm->ifm_mask);
 170
 171         if (match == NULL) {
 172                 printf("ifmedia_set: no match for 0x%x/0x%x\n",
 173                     target, ~ifm->ifm_mask);
 174                 panic("ifmedia_set");
 175         }
 176         ifm->ifm_cur = match;
 177
 178 #ifdef IFMEDIA_DEBUG
 179         if (ifmedia_debug) {
 180                 printf("ifmedia_set: target ");
 181                 ifmedia_printword(target);
 182                 printf("ifmedia_set: setting to ");
 183                 ifmedia_printword(ifm->ifm_cur->ifm_media);
 184         }
 185 #endif
 186 }
 187
 188 /*
 189  * Given a media word, return one suitable for an application
 190  * using the original encoding.
 191  */
 192 static int
 193 compat_media(int media)
 194 {
 195
 196         if (IFM_TYPE(media) == IFM_ETHER && IFM_SUBTYPE(media) > IFM_OTHER) {
 197                 media &= ~(IFM_ETH_XTYPE|IFM_TMASK);
 198                 media |= IFM_OTHER;
 199         }
 200         return (media);
 201 }
 202
 203 /*
 204  * Device-independent media ioctl support function.
 205  */
 206 int
 207 ifmedia_ioctl(struct ifnet *ifp, struct ifreq *ifr, struct ifmedia *ifm,
 208     u_long cmd)
 209 {
 210         struct ifmedia_entry *match;
 211         struct ifmediareq *ifmr = (struct ifmediareq *) ifr;
 212         int error = 0;
 213
 214         if (ifp == NULL || ifr == NULL || ifm == NULL)
 215                 return (EINVAL);
 216
 217         switch (cmd) {
 218         /*
 219          * Set the current media.
 220          */
 221         case  SIOCSIFMEDIA:
 222         {
 223                 struct ifmedia_entry *oldentry;
 224                 int oldmedia;
 225                 int newmedia = ifr->ifr_media;
 226
 227                 match = ifmedia_match(ifm, newmedia, ifm->ifm_mask);
 228                 if (match == NULL) {
 229 #ifdef IFMEDIA_DEBUG
 230                         if (ifmedia_debug) {
 231                                 printf(
 232                                     "ifmedia_ioctl: no media found for 0x%x\n",
 233                                     newmedia);
 234                         }
 235 #endif
 236                         return (ENXIO);
 237                 }
 238
 239                 /*
 240                  * If no change, we're done.
 241                  * XXX Automedia may invole software intervention.
 242                  *     Keep going in case the connected media changed.
 243                  *     Similarly, if best match changed (kernel debugger?).
 244                  */
 245                 if (IFM_SUBTYPE(newmedia) != IFM_AUTO &&
 246                     newmedia == ifm->ifm_media && match == ifm->ifm_cur)
 247                         return (0);
 248
 249                 /*
 250                  * We found a match, now make the driver switch to it.
 251                  * Make sure to preserve our old media type in case the
 252                  * driver can't switch.
 253                  */
 254 #ifdef IFMEDIA_DEBUG
 255                 if (ifmedia_debug) {
 256                         printf("ifmedia_ioctl: switching %s to ",
 257                             ifp->if_xname);
 258                         ifmedia_printword(match->ifm_media);
 259                 }
 260 #endif
 261                 oldentry = ifm->ifm_cur;
 262                 oldmedia = ifm->ifm_media;
 263                 ifm->ifm_cur = match;
 264                 ifm->ifm_media = newmedia;
 265                 error = (*ifm->ifm_change)(ifp);
 266                 if (error) {
 267                         ifm->ifm_cur = oldentry;
 268                         ifm->ifm_media = oldmedia;
 269                 }
 270                 break;
 271         }
 272
 273         /*
 274          * Get list of available media and current media on interface.
 275          */
 276         case  SIOCGIFMEDIA:
 277         case  SIOCGIFXMEDIA:
 278         {
 279                 struct ifmedia_entry *ep;
 280                 int i;
 281
 282                 if (ifmr->ifm_count < 0)
 283                         return (EINVAL);
 284
 285                 if (cmd == SIOCGIFMEDIA) {
 286                         ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
 287                             compat_media(ifm->ifm_cur->ifm_media) : IFM_NONE;
 288                 } else {
 289                         ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
 290                             ifm->ifm_cur->ifm_media : IFM_NONE;
 291                 }
 292                 ifmr->ifm_mask = ifm->ifm_mask;
 293                 ifmr->ifm_status = 0;
 294                 (*ifm->ifm_status)(ifp, ifmr);
 295
 296                 /*
 297                  * If there are more interfaces on the list, count
 298                  * them.  This allows the caller to set ifmr->ifm_count
 299                  * to 0 on the first call to know how much space to
 300                  * allocate.
 301                  */
 302                 i = 0;
 303                 LIST_FOREACH(ep, &ifm->ifm_list, ifm_list)
 304                         if (i++ < ifmr->ifm_count) {
 305                                 error = copyout(&ep->ifm_media,
 306                                     ifmr->ifm_ulist + i - 1, sizeof(int));
 307                                 if (error)
 308                                         break;
 309                         }
 310                 if (error == 0 && i > ifmr->ifm_count)
 311                         error = ifmr->ifm_count ? E2BIG : 0;
 312                 ifmr->ifm_count = i;
 313                 break;
 314         }
 315
 316         default:
 317                 return (EINVAL);
 318         }
 319
 320         return (error);
 321 }
 322
 323 /*
 324  * Find media entry matching a given ifm word.
 325  *
 326  */
 327 static struct ifmedia_entry *
 328 ifmedia_match(struct ifmedia *ifm, int target, int mask)
 329 {
 330         struct ifmedia_entry *match, *next;
 331
 332         match = NULL;
 333         mask = ~mask;
 334
 335         LIST_FOREACH(next, &ifm->ifm_list, ifm_list) {
 336                 if ((next->ifm_media & mask) == (target & mask)) {
 337 #if defined(IFMEDIA_DEBUG) || defined(DIAGNOSTIC)
 338                         if (match) {
 339                                 printf("ifmedia_match: multiple match for "
 340                                     "0x%x/0x%x\n", target, mask);
 341                         }
 342 #endif
 343                         match = next;
 344                 }
 345         }
 346
 347         return (match);
 348 }
 349
 350 /*
 351  * Compute the interface `baudrate' from the media, for the interface
 352  * metrics (used by routing daemons).
 353  */
 354 static const struct ifmedia_baudrate ifmedia_baudrate_descriptions[] =
 355     IFM_BAUDRATE_DESCRIPTIONS;
 356
 357 uint64_t
 358 ifmedia_baudrate(int mword)
 359 {
 360         int i;
 361
 362         for (i = 0; ifmedia_baudrate_descriptions[i].ifmb_word != 0; i++) {
 363                 if (IFM_TYPE_MATCH(mword, ifmedia_baudrate_descriptions[i].
 364                     ifmb_word))
 365                         return (ifmedia_baudrate_descriptions[i].ifmb_baudrate);
 366         }
 367
 368         /* Not known. */
 369         return (0);
 370 }
 371
 372 #ifdef IFMEDIA_DEBUG
 373 static const struct ifmedia_description ifm_type_descriptions[] =
 374     IFM_TYPE_DESCRIPTIONS;
 375
 376 static const struct ifmedia_description ifm_subtype_ethernet_descriptions[] =
 377     IFM_SUBTYPE_ETHERNET_DESCRIPTIONS;
 378
 379 static const struct ifmedia_description
 380     ifm_subtype_ethernet_option_descriptions[] =
 381     IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS;
 382
 383 static const struct ifmedia_description ifm_subtype_ieee80211_descriptions[] =
 384     IFM_SUBTYPE_IEEE80211_DESCRIPTIONS;
 385
 386 static const struct ifmedia_description
 387     ifm_subtype_ieee80211_option_descriptions[] =
 388     IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS;
 389
 390 static const struct ifmedia_description
 391     ifm_subtype_ieee80211_mode_descriptions[] =
 392     IFM_SUBTYPE_IEEE80211_MODE_DESCRIPTIONS;
 393
 394 static const struct ifmedia_description ifm_subtype_atm_descriptions[] =
 395     IFM_SUBTYPE_ATM_DESCRIPTIONS;
 396
 397 static const struct ifmedia_description ifm_subtype_atm_option_descriptions[] =
 398     IFM_SUBTYPE_ATM_OPTION_DESCRIPTIONS;
 399
 400 static const struct ifmedia_description ifm_subtype_shared_descriptions[] =
 401     IFM_SUBTYPE_SHARED_DESCRIPTIONS;
 402
 403 static const struct ifmedia_description ifm_shared_option_descriptions[] =
 404     IFM_SHARED_OPTION_DESCRIPTIONS;
 405
 406 struct ifmedia_type_to_subtype {
 407         const struct ifmedia_description *subtypes;
 408         const struct ifmedia_description *options;
 409         const struct ifmedia_description *modes;
 410 };
 411
 412 /* must be in the same order as IFM_TYPE_DESCRIPTIONS */
 413 static const struct ifmedia_type_to_subtype ifmedia_types_to_subtypes[] = {
 414         {
 415           &ifm_subtype_ethernet_descriptions[0],
 416           &ifm_subtype_ethernet_option_descriptions[0],
 417           NULL,
 418         },
 419         {
 420           &ifm_subtype_ieee80211_descriptions[0],
 421           &ifm_subtype_ieee80211_option_descriptions[0],
 422           &ifm_subtype_ieee80211_mode_descriptions[0]
 423         },
 424         {
 425           &ifm_subtype_atm_descriptions[0],
 426           &ifm_subtype_atm_option_descriptions[0],
 427           NULL,
 428         },
 429 };
 430
 431 /*
 432  * print a media word.
 433  */
 434 static void
 435 ifmedia_printword(int ifmw)
 436 {
 437         const struct ifmedia_description *desc;
 438         const struct ifmedia_type_to_subtype *ttos;
 439         int seen_option = 0;
 440
 441         /* Find the top-level interface type. */
 442         for (desc = ifm_type_descriptions, ttos = ifmedia_types_to_subtypes;
 443             desc->ifmt_string != NULL; desc++, ttos++)
 444                 if (IFM_TYPE(ifmw) == desc->ifmt_word)
 445                         break;
 446         if (desc->ifmt_string == NULL) {
 447                 printf("<unknown type>\n");
 448                 return;
 449         }
 450         printf("%s", desc->ifmt_string);
 451
 452         /* Any mode. */
 453         for (desc = ttos->modes; desc && desc->ifmt_string != NULL; desc++)
 454                 if (IFM_MODE(ifmw) == desc->ifmt_word) {
 455                         if (desc->ifmt_string != NULL)
 456                                 printf(" mode %s", desc->ifmt_string);
 457                         break;
 458                 }
 459
 460         /*
 461          * Check for the shared subtype descriptions first, then the
 462          * type-specific ones.
 463          */
 464         for (desc = ifm_subtype_shared_descriptions;
 465             desc->ifmt_string != NULL; desc++)
 466                 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
 467                         goto got_subtype;
 468
 469         for (desc = ttos->subtypes; desc->ifmt_string != NULL; desc++)
 470                 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
 471                         break;
 472         if (desc->ifmt_string == NULL) {
 473                 printf(" <unknown subtype>\n");
 474                 return;
 475         }
 476
 477  got_subtype:
 478         printf(" %s", desc->ifmt_string);
 479
 480         /*
 481          * Look for shared options.
 482          */
 483         for (desc = ifm_shared_option_descriptions;
 484             desc->ifmt_string != NULL; desc++) {
 485                 if (ifmw & desc->ifmt_word) {
 486                         if (seen_option == 0)
 487                                 printf(" <");
 488                         printf("%s%s", seen_option++ ? "," : "",
 489                             desc->ifmt_string);
 490                 }
 491         }
 492
 493         /*
 494          * Look for subtype-specific options.
 495          */
 496         for (desc = ttos->options; desc->ifmt_string != NULL; desc++) {
 497                 if (ifmw & desc->ifmt_word) {
 498                         if (seen_option == 0)
 499                                 printf(" <");
 500                         printf("%s%s", seen_option++ ? "," : "",
 501                             desc->ifmt_string);
 502                 }
 503         }
 504         printf("%s\n", seen_option ? ">" : "");
 505 }
 506 #endif /* IFMEDIA_DEBUG */