sys/net/if_media.c

   1 /*      $NetBSD: if_media.c,v 1.1 1997/03/17 02:55:15 thorpej Exp $     */
   2 /* $FreeBSD: src/sys/net/if_media.c,v 1.9.2.4 2001/07/04 00:12:38 brooks Exp $ */
   3 /* $DragonFly: src/sys/net/if_media.c,v 1.8 2005/11/28 17:13:45 dillon Exp $ */
   4
   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/param.h>
  51 #include <sys/systm.h>
  52 #include <sys/socket.h>
  53 #include <sys/sockio.h>
  54 #include <sys/malloc.h>
  55
  56 #include <net/if.h>
  57 #include <net/if_media.h>
  58
  59 /*
  60  * Compile-time options:
  61  * IFMEDIA_DEBUG:
  62  *      turn on implementation-level debug printfs.
  63  *      Useful for debugging newly-ported  drivers.
  64  */
  65
  66 static struct ifmedia_entry *ifmedia_match (struct ifmedia *ifm,
  67     int flags, int mask);
  68
  69 #ifdef IFMEDIA_DEBUG
  70 int     ifmedia_debug = 0;
  71 static  void ifmedia_printword (int);
  72 #endif
  73
  74 /*
  75  * Initialize if_media struct for a specific interface instance.
  76  */
  77 void
  78 ifmedia_init(ifm, dontcare_mask, change_callback, status_callback)
  79         struct ifmedia *ifm;
  80         int dontcare_mask;
  81         ifm_change_cb_t change_callback;
  82         ifm_stat_cb_t status_callback;
  83 {
  84
  85         LIST_INIT(&ifm->ifm_list);
  86         ifm->ifm_cur = NULL;
  87         ifm->ifm_media = 0;
  88         ifm->ifm_mask = dontcare_mask;          /* IF don't-care bits */
  89         ifm->ifm_change = change_callback;
  90         ifm->ifm_status = status_callback;
  91 }
  92
  93 void
  94 ifmedia_removeall(ifm)
  95         struct ifmedia *ifm;
  96 {
  97         struct ifmedia_entry *entry;
  98
  99         for (entry = LIST_FIRST(&ifm->ifm_list); entry;
 100              entry = LIST_FIRST(&ifm->ifm_list)) {
 101                 LIST_REMOVE(entry, ifm_list);
 102                 free(entry, M_IFADDR);
 103         }
 104 }
 105
 106 /*
 107  * Add a media configuration to the list of supported media
 108  * for a specific interface instance.
 109  */
 110 void
 111 ifmedia_add(ifm, mword, data, aux)
 112         struct ifmedia *ifm;
 113         int mword;
 114         int data;
 115         void *aux;
 116 {
 117         struct ifmedia_entry *entry;
 118
 119 #ifdef IFMEDIA_DEBUG
 120         if (ifmedia_debug) {
 121                 if (ifm == NULL) {
 122                         printf("ifmedia_add: null ifm\n");
 123                         return;
 124                 }
 125                 printf("Adding entry for ");
 126                 ifmedia_printword(mword);
 127         }
 128 #endif
 129
 130         entry = malloc(sizeof(*entry), M_IFADDR, M_INTWAIT);
 131         entry->ifm_media = mword;
 132         entry->ifm_data = data;
 133         entry->ifm_aux = aux;
 134
 135         LIST_INSERT_HEAD(&ifm->ifm_list, entry, ifm_list);
 136 }
 137
 138 /*
 139  * Add an array of media configurations to the list of
 140  * supported media for a specific interface instance.
 141  */
 142 void
 143 ifmedia_list_add(ifm, lp, count)
 144         struct ifmedia *ifm;
 145         struct ifmedia_entry *lp;
 146         int count;
 147 {
 148         int i;
 149
 150         for (i = 0; i < count; i++)
 151                 ifmedia_add(ifm, lp[i].ifm_media, lp[i].ifm_data,
 152                     lp[i].ifm_aux);
 153 }
 154
 155 /*
 156  * Set the default active media.
 157  *
 158  * Called by device-specific code which is assumed to have already
 159  * selected the default media in hardware.  We do _not_ call the
 160  * media-change callback.
 161  */
 162 void
 163 ifmedia_set(ifm, target)
 164         struct ifmedia *ifm;
 165         int target;
 166
 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  * Device-independent media ioctl support function, typically called
 191  * from the device network ioctl procedure.
 192  */
 193 int
 194 ifmedia_ioctl(ifp, ifr, ifm, cmd)
 195         struct ifnet *ifp;
 196         struct ifreq *ifr;
 197         struct ifmedia *ifm;
 198         u_long cmd;
 199 {
 200         struct ifmedia_entry *match;
 201         struct ifmediareq *ifmr = (struct ifmediareq *) ifr;
 202         int error = 0, sticky;
 203
 204         if (ifp == NULL || ifr == NULL || ifm == NULL)
 205                 return (EINVAL);
 206
 207         ASSERT_SERIALIZED(ifp->if_serializer);
 208
 209         switch (cmd) {
 210         /*
 211          * Set the current media.
 212          */
 213         case  SIOCSIFMEDIA:
 214         {
 215                 struct ifmedia_entry *oldentry;
 216                 int oldmedia;
 217                 int newmedia = ifr->ifr_media;
 218
 219                 match = ifmedia_match(ifm, newmedia, ifm->ifm_mask);
 220                 if (match == NULL) {
 221 #ifdef IFMEDIA_DEBUG
 222                         if (ifmedia_debug) {
 223                                 printf(
 224                                     "ifmedia_ioctl: no media found for 0x%x\n",
 225                                     newmedia);
 226                         }
 227 #endif
 228                         return (ENXIO);
 229                 }
 230
 231                 /*
 232                  * If no change, we're done.
 233                  * XXX Automedia may invole software intervention.
 234                  *     Keep going in case the the connected media changed.
 235                  *     Similarly, if best match changed (kernel debugger?).
 236                  */
 237                 if ((IFM_SUBTYPE(newmedia) != IFM_AUTO) &&
 238                     (newmedia == ifm->ifm_media) &&
 239                     (match == ifm->ifm_cur))
 240                         return 0;
 241
 242                 /*
 243                  * We found a match, now make the driver switch to it.
 244                  * Make sure to preserve our old media type in case the
 245                  * driver can't switch.
 246                  */
 247 #ifdef IFMEDIA_DEBUG
 248                 if (ifmedia_debug) {
 249                         printf("ifmedia_ioctl: switching %s to ",
 250                             ifp->if_xname);
 251                         ifmedia_printword(match->ifm_media);
 252                 }
 253 #endif
 254                 oldentry = ifm->ifm_cur;
 255                 oldmedia = ifm->ifm_media;
 256                 ifm->ifm_cur = match;
 257                 ifm->ifm_media = newmedia;
 258                 error = (*ifm->ifm_change)(ifp);
 259                 if (error) {
 260                         ifm->ifm_cur = oldentry;
 261                         ifm->ifm_media = oldmedia;
 262                 }
 263                 break;
 264         }
 265
 266         /*
 267          * Get list of available media and current media on interface.
 268          */
 269         case  SIOCGIFMEDIA:
 270         {
 271                 struct ifmedia_entry *ep;
 272                 int *kptr, count;
 273                 int usermax;    /* user requested max */
 274
 275                 kptr = NULL;            /* XXX gcc */
 276
 277                 ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
 278                     ifm->ifm_cur->ifm_media : IFM_NONE;
 279                 ifmr->ifm_mask = ifm->ifm_mask;
 280                 ifmr->ifm_status = 0;
 281                 (*ifm->ifm_status)(ifp, ifmr);
 282
 283                 count = 0;
 284                 usermax = 0;
 285
 286                 /*
 287                  * If there are more interfaces on the list, count
 288                  * them.  This allows the caller to set ifmr->ifm_count
 289                  * to 0 on the first call to know how much space to
 290                  * allocate.
 291                  */
 292                 LIST_FOREACH(ep, &ifm->ifm_list, ifm_list)
 293                         usermax++;
 294
 295                 /*
 296                  * Don't allow the user to ask for too many
 297                  * or a negative number.
 298                  */
 299                 if (ifmr->ifm_count > usermax)
 300                         ifmr->ifm_count = usermax;
 301                 else if (ifmr->ifm_count < 0)
 302                         return (EINVAL);
 303
 304                 if (ifmr->ifm_count != 0) {
 305                         kptr = (int *)malloc(ifmr->ifm_count * sizeof(int),
 306                             M_TEMP, M_WAITOK);
 307
 308                         /*
 309                          * Get the media words from the interface's list.
 310                          */
 311                         ep = LIST_FIRST(&ifm->ifm_list);
 312                         for (; ep != NULL && count < ifmr->ifm_count;
 313                             ep = LIST_NEXT(ep, ifm_list), count++)
 314                                 kptr[count] = ep->ifm_media;
 315
 316                         if (ep != NULL)
 317                                 error = E2BIG;  /* oops! */
 318                 } else {
 319                         count = usermax;
 320                 }
 321
 322                 /*
 323                  * We do the copyout on E2BIG, because that's
 324                  * just our way of telling userland that there
 325                  * are more.  This is the behavior I've observed
 326                  * under BSD/OS 3.0
 327                  */
 328                 sticky = error;
 329                 if ((error == 0 || error == E2BIG) && ifmr->ifm_count != 0) {
 330                         error = copyout((caddr_t)kptr,
 331                             (caddr_t)ifmr->ifm_ulist,
 332                             ifmr->ifm_count * sizeof(int));
 333                 }
 334
 335                 if (error == 0)
 336                         error = sticky;
 337
 338                 if (ifmr->ifm_count != 0)
 339                         free(kptr, M_TEMP);
 340
 341                 ifmr->ifm_count = count;
 342                 break;
 343         }
 344
 345         default:
 346                 return (EINVAL);
 347         }
 348
 349         return (error);
 350 }
 351
 352 /*
 353  * Find media entry matching a given ifm word.
 354  *
 355  */
 356 static struct ifmedia_entry *
 357 ifmedia_match(ifm, target, mask)
 358         struct ifmedia *ifm;
 359         int target;
 360         int mask;
 361 {
 362         struct ifmedia_entry *match, *next;
 363
 364         match = NULL;
 365         mask = ~mask;
 366
 367         LIST_FOREACH(next, &ifm->ifm_list, ifm_list) {
 368                 if ((next->ifm_media & mask) == (target & mask)) {
 369 #if defined(IFMEDIA_DEBUG) || defined(DIAGNOSTIC)
 370                         if (match) {
 371                                 printf("ifmedia_match: multiple match for "
 372                                     "0x%x/0x%x\n", target, mask);
 373                         }
 374 #endif
 375                         match = next;
 376                 }
 377         }
 378
 379         return match;
 380 }
 381
 382 #ifdef IFMEDIA_DEBUG
 383 struct ifmedia_description ifm_type_descriptions[] =
 384     IFM_TYPE_DESCRIPTIONS;
 385
 386 struct ifmedia_description ifm_subtype_ethernet_descriptions[] =
 387     IFM_SUBTYPE_ETHERNET_DESCRIPTIONS;
 388
 389 struct ifmedia_description ifm_subtype_ethernet_option_descriptions[] =
 390     IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS;
 391
 392 struct ifmedia_description ifm_subtype_tokenring_descriptions[] =
 393     IFM_SUBTYPE_TOKENRING_DESCRIPTIONS;
 394
 395 struct ifmedia_description ifm_subtype_tokenring_option_descriptions[] =
 396     IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS;
 397
 398 struct ifmedia_description ifm_subtype_fddi_descriptions[] =
 399     IFM_SUBTYPE_FDDI_DESCRIPTIONS;
 400
 401 struct ifmedia_description ifm_subtype_fddi_option_descriptions[] =
 402     IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS;
 403
 404 struct ifmedia_description ifm_subtype_ieee80211_descriptions[] =
 405     IFM_SUBTYPE_IEEE80211_DESCRIPTIONS;
 406
 407 struct ifmedia_description ifm_subtype_ieee80211_option_descriptions[] =
 408     IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS;
 409
 410 struct ifmedia_description ifm_subtype_shared_descriptions[] =
 411     IFM_SUBTYPE_SHARED_DESCRIPTIONS;
 412
 413 struct ifmedia_description ifm_shared_option_descriptions[] =
 414     IFM_SHARED_OPTION_DESCRIPTIONS;
 415
 416 struct ifmedia_type_to_subtype {
 417         struct ifmedia_description *subtypes;
 418         struct ifmedia_description *options;
 419 };
 420
 421 /* must be in the same order as IFM_TYPE_DESCRIPTIONS */
 422 struct ifmedia_type_to_subtype ifmedia_types_to_subtypes[] = {
 423         {
 424           &ifm_subtype_ethernet_descriptions[0],
 425           &ifm_subtype_ethernet_option_descriptions[0]
 426         },
 427         {
 428           &ifm_subtype_tokenring_descriptions[0],
 429           &ifm_subtype_tokenring_option_descriptions[0]
 430         },
 431         {
 432           &ifm_subtype_fddi_descriptions[0],
 433           &ifm_subtype_fddi_option_descriptions[0]
 434         },
 435         {
 436           &ifm_subtype_ieee80211_descriptions[0],
 437           &ifm_subtype_ieee80211_option_descriptions[0]
 438         },
 439 };
 440
 441 /*
 442  * print a media word.
 443  */
 444 static void
 445 ifmedia_printword(ifmw)
 446         int ifmw;
 447 {
 448         struct ifmedia_description *desc;
 449         struct ifmedia_type_to_subtype *ttos;
 450         int seen_option = 0;
 451
 452         /* Find the top-level interface type. */
 453         for (desc = ifm_type_descriptions, ttos = ifmedia_types_to_subtypes;
 454             desc->ifmt_string != NULL; desc++, ttos++)
 455                 if (IFM_TYPE(ifmw) == desc->ifmt_word)
 456                         break;
 457         if (desc->ifmt_string == NULL) {
 458                 printf("<unknown type>\n");
 459                 return;
 460         }
 461         printf(desc->ifmt_string);
 462
 463         /*
 464          * Check for the shared subtype descriptions first, then the
 465          * type-specific ones.
 466          */
 467         for (desc = ifm_subtype_shared_descriptions;
 468             desc->ifmt_string != NULL; desc++)
 469                 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
 470                         goto got_subtype;
 471
 472         for (desc = ttos->subtypes; desc->ifmt_string != NULL; desc++)
 473                 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
 474                         break;
 475         if (desc->ifmt_string == NULL) {
 476                 printf(" <unknown subtype>\n");
 477                 return;
 478         }
 479
 480  got_subtype:
 481         printf(" %s", desc->ifmt_string);
 482
 483         /*
 484          * Look for shared options.
 485          */
 486         for (desc = ifm_shared_option_descriptions;
 487             desc->ifmt_string != NULL; desc++) {
 488                 if (ifmw & desc->ifmt_word) {
 489                         if (seen_option == 0)
 490                                 printf(" <");
 491                         printf("%s%s", seen_option++ ? "," : "",
 492                             desc->ifmt_string);
 493                 }
 494         }
 495
 496         /*
 497          * Look for subtype-specific options.
 498          */
 499         for (desc = ttos->options; desc->ifmt_string != NULL; desc++) {
 500                 if (ifmw & desc->ifmt_word) {
 501                         if (seen_option == 0)
 502                                 printf(" <");
 503                         printf("%s%s", seen_option++ ? "," : "",
 504                             desc->ifmt_string);
 505                 }
 506         }
 507         printf("%s\n", seen_option ? ">" : "");
 508 }
 509 #endif /* IFMEDIA_DEBUG */