1 /* $NetBSD: if_media.c,v 1.1 1997/03/17 02:55:15 thorpej Exp $ */
4 * SPDX-License-Identifier: BSD-4-Clause
7 * Jonathan Stone and Jason R. Thorpe. All rights reserved.
9 * This software is derived from information provided by Matt Thomas.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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
40 * BSD/OS-compatible network interface media selection.
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.
46 * Many thanks to Matt Thomas for providing the information necessary
47 * to implement this interface.
50 #include <sys/cdefs.h>
51 __FBSDID("$FreeBSD$");
53 #include "opt_ifmedia.h"
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>
64 #include <net/if_media.h>
67 * Compile-time options:
69 * turn on implementation-level debug printfs.
70 * Useful for debugging newly-ported drivers.
73 static struct ifmedia_entry *ifmedia_match(struct ifmedia *ifm,
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);
85 * Initialize if_media struct for a specific interface instance.
88 ifmedia_init(ifm, dontcare_mask, change_callback, status_callback)
91 ifm_change_cb_t change_callback;
92 ifm_stat_cb_t status_callback;
95 LIST_INIT(&ifm->ifm_list);
98 ifm->ifm_mask = dontcare_mask; /* IF don't-care bits */
99 ifm->ifm_change = change_callback;
100 ifm->ifm_status = status_callback;
104 ifmedia_removeall(ifm)
107 struct ifmedia_entry *entry;
109 for (entry = LIST_FIRST(&ifm->ifm_list); entry;
110 entry = LIST_FIRST(&ifm->ifm_list)) {
111 LIST_REMOVE(entry, ifm_list);
112 free(entry, M_IFADDR);
118 * Add a media configuration to the list of supported media
119 * for a specific interface instance.
122 ifmedia_add(ifm, mword, data, aux)
128 struct ifmedia_entry *entry;
133 printf("ifmedia_add: null ifm\n");
136 printf("Adding entry for ");
137 ifmedia_printword(mword);
141 entry = malloc(sizeof(*entry), M_IFADDR, M_NOWAIT);
143 panic("ifmedia_add: can't malloc entry");
145 entry->ifm_media = mword;
146 entry->ifm_data = data;
147 entry->ifm_aux = aux;
149 LIST_INSERT_HEAD(&ifm->ifm_list, entry, ifm_list);
153 * Add an array of media configurations to the list of
154 * supported media for a specific interface instance.
157 ifmedia_list_add(ifm, lp, count)
159 struct ifmedia_entry *lp;
164 for (i = 0; i < count; i++)
165 ifmedia_add(ifm, lp[i].ifm_media, lp[i].ifm_data,
170 * Set the default active media.
172 * Called by device-specific code which is assumed to have already
173 * selected the default media in hardware. We do _not_ call the
174 * media-change callback.
177 ifmedia_set(ifm, target)
182 struct ifmedia_entry *match;
184 match = ifmedia_match(ifm, target, ifm->ifm_mask);
187 printf("ifmedia_set: no match for 0x%x/0x%x\n",
188 target, ~ifm->ifm_mask);
189 panic("ifmedia_set");
191 ifm->ifm_cur = match;
195 printf("ifmedia_set: target ");
196 ifmedia_printword(target);
197 printf("ifmedia_set: setting to ");
198 ifmedia_printword(ifm->ifm_cur->ifm_media);
204 * Given a media word, return one suitable for an application
205 * using the original encoding.
208 compat_media(int media)
211 if (IFM_TYPE(media) == IFM_ETHER && IFM_SUBTYPE(media) > IFM_OTHER) {
212 media &= ~(IFM_ETH_XTYPE|IFM_TMASK);
219 * Device-independent media ioctl support function.
222 ifmedia_ioctl(ifp, ifr, ifm, cmd)
228 struct ifmedia_entry *match;
229 struct ifmediareq *ifmr = (struct ifmediareq *) ifr;
232 if (ifp == NULL || ifr == NULL || ifm == NULL)
237 * Set the current media.
241 struct ifmedia_entry *oldentry;
243 int newmedia = ifr->ifr_media;
245 match = ifmedia_match(ifm, newmedia, ifm->ifm_mask);
250 "ifmedia_ioctl: no media found for 0x%x\n",
258 * If no change, we're done.
259 * XXX Automedia may invole software intervention.
260 * Keep going in case the connected media changed.
261 * Similarly, if best match changed (kernel debugger?).
263 if ((IFM_SUBTYPE(newmedia) != IFM_AUTO) &&
264 (newmedia == ifm->ifm_media) &&
265 (match == ifm->ifm_cur))
269 * We found a match, now make the driver switch to it.
270 * Make sure to preserve our old media type in case the
271 * driver can't switch.
275 printf("ifmedia_ioctl: switching %s to ",
277 ifmedia_printword(match->ifm_media);
280 oldentry = ifm->ifm_cur;
281 oldmedia = ifm->ifm_media;
282 ifm->ifm_cur = match;
283 ifm->ifm_media = newmedia;
284 error = (*ifm->ifm_change)(ifp);
286 ifm->ifm_cur = oldentry;
287 ifm->ifm_media = oldmedia;
293 * Get list of available media and current media on interface.
298 struct ifmedia_entry *ep;
301 if (ifmr->ifm_count < 0)
304 if (cmd == SIOCGIFMEDIA) {
305 ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
306 compat_media(ifm->ifm_cur->ifm_media) : IFM_NONE;
308 ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
309 ifm->ifm_cur->ifm_media : IFM_NONE;
311 ifmr->ifm_mask = ifm->ifm_mask;
312 ifmr->ifm_status = 0;
313 (*ifm->ifm_status)(ifp, ifmr);
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
322 LIST_FOREACH(ep, &ifm->ifm_list, ifm_list)
323 if (i++ < ifmr->ifm_count) {
324 error = copyout(&ep->ifm_media,
325 ifmr->ifm_ulist + i - 1, sizeof(int));
329 if (error == 0 && i > ifmr->ifm_count)
330 error = ifmr->ifm_count ? E2BIG : 0;
343 * Find media entry matching a given ifm word.
346 static struct ifmedia_entry *
347 ifmedia_match(ifm, target, mask)
352 struct ifmedia_entry *match, *next;
357 LIST_FOREACH(next, &ifm->ifm_list, ifm_list) {
358 if ((next->ifm_media & mask) == (target & mask)) {
359 #if defined(IFMEDIA_DEBUG) || defined(DIAGNOSTIC)
361 printf("ifmedia_match: multiple match for "
362 "0x%x/0x%x\n", target, mask);
373 * Compute the interface `baudrate' from the media, for the interface
374 * metrics (used by routing daemons).
376 static const struct ifmedia_baudrate ifmedia_baudrate_descriptions[] =
377 IFM_BAUDRATE_DESCRIPTIONS;
380 ifmedia_baudrate(int mword)
384 for (i = 0; ifmedia_baudrate_descriptions[i].ifmb_word != 0; i++) {
385 if (IFM_TYPE_MATCH(mword, ifmedia_baudrate_descriptions[i].ifmb_word))
386 return (ifmedia_baudrate_descriptions[i].ifmb_baudrate);
394 static const struct ifmedia_description ifm_type_descriptions[] =
395 IFM_TYPE_DESCRIPTIONS;
397 static const struct ifmedia_description ifm_subtype_ethernet_descriptions[] =
398 IFM_SUBTYPE_ETHERNET_DESCRIPTIONS;
400 static const struct ifmedia_description
401 ifm_subtype_ethernet_option_descriptions[] =
402 IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS;
404 static const struct ifmedia_description ifm_subtype_ieee80211_descriptions[] =
405 IFM_SUBTYPE_IEEE80211_DESCRIPTIONS;
407 static const struct ifmedia_description
408 ifm_subtype_ieee80211_option_descriptions[] =
409 IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS;
411 static const struct ifmedia_description
412 ifm_subtype_ieee80211_mode_descriptions[] =
413 IFM_SUBTYPE_IEEE80211_MODE_DESCRIPTIONS;
415 static const struct ifmedia_description ifm_subtype_atm_descriptions[] =
416 IFM_SUBTYPE_ATM_DESCRIPTIONS;
418 static const struct ifmedia_description ifm_subtype_atm_option_descriptions[] =
419 IFM_SUBTYPE_ATM_OPTION_DESCRIPTIONS;
421 static const struct ifmedia_description ifm_subtype_shared_descriptions[] =
422 IFM_SUBTYPE_SHARED_DESCRIPTIONS;
424 static const struct ifmedia_description ifm_shared_option_descriptions[] =
425 IFM_SHARED_OPTION_DESCRIPTIONS;
427 struct ifmedia_type_to_subtype {
428 const struct ifmedia_description *subtypes;
429 const struct ifmedia_description *options;
430 const struct ifmedia_description *modes;
433 /* must be in the same order as IFM_TYPE_DESCRIPTIONS */
434 static const struct ifmedia_type_to_subtype ifmedia_types_to_subtypes[] = {
436 &ifm_subtype_ethernet_descriptions[0],
437 &ifm_subtype_ethernet_option_descriptions[0],
441 &ifm_subtype_ieee80211_descriptions[0],
442 &ifm_subtype_ieee80211_option_descriptions[0],
443 &ifm_subtype_ieee80211_mode_descriptions[0]
446 &ifm_subtype_atm_descriptions[0],
447 &ifm_subtype_atm_option_descriptions[0],
453 * print a media word.
456 ifmedia_printword(ifmw)
459 const struct ifmedia_description *desc;
460 const struct ifmedia_type_to_subtype *ttos;
463 /* Find the top-level interface type. */
464 for (desc = ifm_type_descriptions, ttos = ifmedia_types_to_subtypes;
465 desc->ifmt_string != NULL; desc++, ttos++)
466 if (IFM_TYPE(ifmw) == desc->ifmt_word)
468 if (desc->ifmt_string == NULL) {
469 printf("<unknown type>\n");
472 printf("%s", desc->ifmt_string);
475 for (desc = ttos->modes; desc && desc->ifmt_string != NULL; desc++)
476 if (IFM_MODE(ifmw) == desc->ifmt_word) {
477 if (desc->ifmt_string != NULL)
478 printf(" mode %s", desc->ifmt_string);
483 * Check for the shared subtype descriptions first, then the
484 * type-specific ones.
486 for (desc = ifm_subtype_shared_descriptions;
487 desc->ifmt_string != NULL; desc++)
488 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
491 for (desc = ttos->subtypes; desc->ifmt_string != NULL; desc++)
492 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
494 if (desc->ifmt_string == NULL) {
495 printf(" <unknown subtype>\n");
500 printf(" %s", desc->ifmt_string);
503 * Look for shared options.
505 for (desc = ifm_shared_option_descriptions;
506 desc->ifmt_string != NULL; desc++) {
507 if (ifmw & desc->ifmt_word) {
508 if (seen_option == 0)
510 printf("%s%s", seen_option++ ? "," : "",
516 * Look for subtype-specific options.
518 for (desc = ttos->options; desc->ifmt_string != NULL; desc++) {
519 if (ifmw & desc->ifmt_word) {
520 if (seen_option == 0)
522 printf("%s%s", seen_option++ ? "," : "",
526 printf("%s\n", seen_option ? ">" : "");
528 #endif /* IFMEDIA_DEBUG */