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(struct ifmedia *ifm, int dontcare_mask,
89 ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback)
92 LIST_INIT(&ifm->ifm_list);
95 ifm->ifm_mask = dontcare_mask; /* IF don't-care bits */
96 ifm->ifm_change = change_callback;
97 ifm->ifm_status = status_callback;
101 ifmedia_removeall(struct ifmedia *ifm)
103 struct ifmedia_entry *entry;
105 for (entry = LIST_FIRST(&ifm->ifm_list); entry;
106 entry = LIST_FIRST(&ifm->ifm_list)) {
107 LIST_REMOVE(entry, ifm_list);
108 free(entry, M_IFADDR);
114 * Add a media configuration to the list of supported media
115 * for a specific interface instance.
118 ifmedia_add(struct ifmedia *ifm, int mword, int data, void *aux)
120 struct ifmedia_entry *entry;
125 printf("ifmedia_add: null ifm\n");
128 printf("Adding entry for ");
129 ifmedia_printword(mword);
133 entry = malloc(sizeof(*entry), M_IFADDR, M_NOWAIT);
135 panic("ifmedia_add: can't malloc entry");
137 entry->ifm_media = mword;
138 entry->ifm_data = data;
139 entry->ifm_aux = aux;
141 LIST_INSERT_HEAD(&ifm->ifm_list, entry, ifm_list);
145 * Add an array of media configurations to the list of
146 * supported media for a specific interface instance.
149 ifmedia_list_add(struct ifmedia *ifm, struct ifmedia_entry *lp, int count)
153 for (i = 0; i < count; i++)
154 ifmedia_add(ifm, lp[i].ifm_media, lp[i].ifm_data,
159 * Set the default active media.
161 * Called by device-specific code which is assumed to have already
162 * selected the default media in hardware. We do _not_ call the
163 * media-change callback.
166 ifmedia_set(struct ifmedia *ifm, int target)
168 struct ifmedia_entry *match;
170 match = ifmedia_match(ifm, target, ifm->ifm_mask);
173 printf("ifmedia_set: no match for 0x%x/0x%x\n",
174 target, ~ifm->ifm_mask);
175 panic("ifmedia_set");
177 ifm->ifm_cur = match;
181 printf("ifmedia_set: target ");
182 ifmedia_printword(target);
183 printf("ifmedia_set: setting to ");
184 ifmedia_printword(ifm->ifm_cur->ifm_media);
190 * Given a media word, return one suitable for an application
191 * using the original encoding.
194 compat_media(int media)
197 if (IFM_TYPE(media) == IFM_ETHER && IFM_SUBTYPE(media) > IFM_OTHER) {
198 media &= ~(IFM_ETH_XTYPE|IFM_TMASK);
205 * Device-independent media ioctl support function.
208 ifmedia_ioctl(struct ifnet *ifp, struct ifreq *ifr, struct ifmedia *ifm,
211 struct ifmedia_entry *match;
212 struct ifmediareq *ifmr = (struct ifmediareq *) ifr;
215 if (ifp == NULL || ifr == NULL || ifm == NULL)
220 * Set the current media.
224 struct ifmedia_entry *oldentry;
226 int newmedia = ifr->ifr_media;
228 match = ifmedia_match(ifm, newmedia, ifm->ifm_mask);
233 "ifmedia_ioctl: no media found for 0x%x\n",
241 * If no change, we're done.
242 * XXX Automedia may invole software intervention.
243 * Keep going in case the connected media changed.
244 * Similarly, if best match changed (kernel debugger?).
246 if ((IFM_SUBTYPE(newmedia) != IFM_AUTO) &&
247 (newmedia == ifm->ifm_media) &&
248 (match == ifm->ifm_cur))
252 * We found a match, now make the driver switch to it.
253 * Make sure to preserve our old media type in case the
254 * driver can't switch.
258 printf("ifmedia_ioctl: switching %s to ",
260 ifmedia_printword(match->ifm_media);
263 oldentry = ifm->ifm_cur;
264 oldmedia = ifm->ifm_media;
265 ifm->ifm_cur = match;
266 ifm->ifm_media = newmedia;
267 error = (*ifm->ifm_change)(ifp);
269 ifm->ifm_cur = oldentry;
270 ifm->ifm_media = oldmedia;
276 * Get list of available media and current media on interface.
281 struct ifmedia_entry *ep;
284 if (ifmr->ifm_count < 0)
287 if (cmd == SIOCGIFMEDIA) {
288 ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
289 compat_media(ifm->ifm_cur->ifm_media) : IFM_NONE;
291 ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
292 ifm->ifm_cur->ifm_media : IFM_NONE;
294 ifmr->ifm_mask = ifm->ifm_mask;
295 ifmr->ifm_status = 0;
296 (*ifm->ifm_status)(ifp, ifmr);
299 * If there are more interfaces on the list, count
300 * them. This allows the caller to set ifmr->ifm_count
301 * to 0 on the first call to know how much space to
305 LIST_FOREACH(ep, &ifm->ifm_list, ifm_list)
306 if (i++ < ifmr->ifm_count) {
307 error = copyout(&ep->ifm_media,
308 ifmr->ifm_ulist + i - 1, sizeof(int));
312 if (error == 0 && i > ifmr->ifm_count)
313 error = ifmr->ifm_count ? E2BIG : 0;
326 * Find media entry matching a given ifm word.
329 static struct ifmedia_entry *
330 ifmedia_match(struct ifmedia *ifm, int target, int mask)
332 struct ifmedia_entry *match, *next;
337 LIST_FOREACH(next, &ifm->ifm_list, ifm_list) {
338 if ((next->ifm_media & mask) == (target & mask)) {
339 #if defined(IFMEDIA_DEBUG) || defined(DIAGNOSTIC)
341 printf("ifmedia_match: multiple match for "
342 "0x%x/0x%x\n", target, mask);
353 * Compute the interface `baudrate' from the media, for the interface
354 * metrics (used by routing daemons).
356 static const struct ifmedia_baudrate ifmedia_baudrate_descriptions[] =
357 IFM_BAUDRATE_DESCRIPTIONS;
360 ifmedia_baudrate(int mword)
364 for (i = 0; ifmedia_baudrate_descriptions[i].ifmb_word != 0; i++) {
365 if (IFM_TYPE_MATCH(mword, ifmedia_baudrate_descriptions[i].ifmb_word))
366 return (ifmedia_baudrate_descriptions[i].ifmb_baudrate);
374 static const struct ifmedia_description ifm_type_descriptions[] =
375 IFM_TYPE_DESCRIPTIONS;
377 static const struct ifmedia_description ifm_subtype_ethernet_descriptions[] =
378 IFM_SUBTYPE_ETHERNET_DESCRIPTIONS;
380 static const struct ifmedia_description
381 ifm_subtype_ethernet_option_descriptions[] =
382 IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS;
384 static const struct ifmedia_description ifm_subtype_ieee80211_descriptions[] =
385 IFM_SUBTYPE_IEEE80211_DESCRIPTIONS;
387 static const struct ifmedia_description
388 ifm_subtype_ieee80211_option_descriptions[] =
389 IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS;
391 static const struct ifmedia_description
392 ifm_subtype_ieee80211_mode_descriptions[] =
393 IFM_SUBTYPE_IEEE80211_MODE_DESCRIPTIONS;
395 static const struct ifmedia_description ifm_subtype_atm_descriptions[] =
396 IFM_SUBTYPE_ATM_DESCRIPTIONS;
398 static const struct ifmedia_description ifm_subtype_atm_option_descriptions[] =
399 IFM_SUBTYPE_ATM_OPTION_DESCRIPTIONS;
401 static const struct ifmedia_description ifm_subtype_shared_descriptions[] =
402 IFM_SUBTYPE_SHARED_DESCRIPTIONS;
404 static const struct ifmedia_description ifm_shared_option_descriptions[] =
405 IFM_SHARED_OPTION_DESCRIPTIONS;
407 struct ifmedia_type_to_subtype {
408 const struct ifmedia_description *subtypes;
409 const struct ifmedia_description *options;
410 const struct ifmedia_description *modes;
413 /* must be in the same order as IFM_TYPE_DESCRIPTIONS */
414 static const struct ifmedia_type_to_subtype ifmedia_types_to_subtypes[] = {
416 &ifm_subtype_ethernet_descriptions[0],
417 &ifm_subtype_ethernet_option_descriptions[0],
421 &ifm_subtype_ieee80211_descriptions[0],
422 &ifm_subtype_ieee80211_option_descriptions[0],
423 &ifm_subtype_ieee80211_mode_descriptions[0]
426 &ifm_subtype_atm_descriptions[0],
427 &ifm_subtype_atm_option_descriptions[0],
433 * print a media word.
436 ifmedia_printword(int ifmw)
438 const struct ifmedia_description *desc;
439 const struct ifmedia_type_to_subtype *ttos;
442 /* Find the top-level interface type. */
443 for (desc = ifm_type_descriptions, ttos = ifmedia_types_to_subtypes;
444 desc->ifmt_string != NULL; desc++, ttos++)
445 if (IFM_TYPE(ifmw) == desc->ifmt_word)
447 if (desc->ifmt_string == NULL) {
448 printf("<unknown type>\n");
451 printf("%s", desc->ifmt_string);
454 for (desc = ttos->modes; desc && desc->ifmt_string != NULL; desc++)
455 if (IFM_MODE(ifmw) == desc->ifmt_word) {
456 if (desc->ifmt_string != NULL)
457 printf(" mode %s", desc->ifmt_string);
462 * Check for the shared subtype descriptions first, then the
463 * type-specific ones.
465 for (desc = ifm_subtype_shared_descriptions;
466 desc->ifmt_string != NULL; desc++)
467 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
470 for (desc = ttos->subtypes; desc->ifmt_string != NULL; desc++)
471 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
473 if (desc->ifmt_string == NULL) {
474 printf(" <unknown subtype>\n");
479 printf(" %s", desc->ifmt_string);
482 * Look for shared options.
484 for (desc = ifm_shared_option_descriptions;
485 desc->ifmt_string != NULL; desc++) {
486 if (ifmw & desc->ifmt_word) {
487 if (seen_option == 0)
489 printf("%s%s", seen_option++ ? "," : "",
495 * Look for subtype-specific options.
497 for (desc = ttos->options; desc->ifmt_string != NULL; desc++) {
498 if (ifmw & desc->ifmt_word) {
499 if (seen_option == 0)
501 printf("%s%s", seen_option++ ? "," : "",
505 printf("%s\n", seen_option ? ">" : "");
507 #endif /* IFMEDIA_DEBUG */