bsd/net/if_media.c

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