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