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.4 2003/08/26 20:49:47 rob Exp $ */
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/param.h>
51 #include <sys/systm.h>
52 #include <sys/socket.h>
53 #include <sys/sockio.h>
54 #include <sys/malloc.h>
57 #include <net/if_media.h>
60 * Compile-time options:
62 * turn on implementation-level debug printfs.
63 * Useful for debugging newly-ported drivers.
66 static struct ifmedia_entry *ifmedia_match (struct ifmedia *ifm,
70 int ifmedia_debug = 0;
71 static void ifmedia_printword (int);
75 * Initialize if_media struct for a specific interface instance.
78 ifmedia_init(ifm, dontcare_mask, change_callback, status_callback)
81 ifm_change_cb_t change_callback;
82 ifm_stat_cb_t status_callback;
85 LIST_INIT(&ifm->ifm_list);
88 ifm->ifm_mask = dontcare_mask; /* IF don't-care bits */
89 ifm->ifm_change = change_callback;
90 ifm->ifm_status = status_callback;
94 ifmedia_removeall(ifm)
97 struct ifmedia_entry *entry;
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);
107 * Add a media configuration to the list of supported media
108 * for a specific interface instance.
111 ifmedia_add(ifm, mword, data, aux)
117 struct ifmedia_entry *entry;
122 printf("ifmedia_add: null ifm\n");
125 printf("Adding entry for ");
126 ifmedia_printword(mword);
130 entry = malloc(sizeof(*entry), M_IFADDR, M_NOWAIT);
132 panic("ifmedia_add: can't malloc entry");
134 entry->ifm_media = mword;
135 entry->ifm_data = data;
136 entry->ifm_aux = aux;
138 LIST_INSERT_HEAD(&ifm->ifm_list, entry, ifm_list);
142 * Add an array of media configurations to the list of
143 * supported media for a specific interface instance.
146 ifmedia_list_add(ifm, lp, count)
148 struct ifmedia_entry *lp;
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(ifm, target)
171 struct ifmedia_entry *match;
173 match = ifmedia_match(ifm, target, ifm->ifm_mask);
176 printf("ifmedia_set: no match for 0x%x/0x%x\n",
177 target, ~ifm->ifm_mask);
178 panic("ifmedia_set");
180 ifm->ifm_cur = match;
184 printf("ifmedia_set: target ");
185 ifmedia_printword(target);
186 printf("ifmedia_set: setting to ");
187 ifmedia_printword(ifm->ifm_cur->ifm_media);
193 * Device-independent media ioctl support function.
196 ifmedia_ioctl(ifp, ifr, ifm, cmd)
202 struct ifmedia_entry *match;
203 struct ifmediareq *ifmr = (struct ifmediareq *) ifr;
204 int error = 0, sticky;
206 if (ifp == NULL || ifr == NULL || ifm == NULL)
212 * Set the current media.
216 struct ifmedia_entry *oldentry;
218 int newmedia = ifr->ifr_media;
220 match = ifmedia_match(ifm, newmedia, ifm->ifm_mask);
225 "ifmedia_ioctl: no media found for 0x%x\n",
233 * If no change, we're done.
234 * XXX Automedia may invole software intervention.
235 * Keep going in case the the connected media changed.
236 * Similarly, if best match changed (kernel debugger?).
238 if ((IFM_SUBTYPE(newmedia) != IFM_AUTO) &&
239 (newmedia == ifm->ifm_media) &&
240 (match == ifm->ifm_cur))
244 * We found a match, now make the driver switch to it.
245 * Make sure to preserve our old media type in case the
246 * driver can't switch.
250 printf("ifmedia_ioctl: switching %s%d to ",
251 ifp->if_name, ifp->if_unit);
252 ifmedia_printword(match->ifm_media);
255 oldentry = ifm->ifm_cur;
256 oldmedia = ifm->ifm_media;
257 ifm->ifm_cur = match;
258 ifm->ifm_media = newmedia;
259 error = (*ifm->ifm_change)(ifp);
261 ifm->ifm_cur = oldentry;
262 ifm->ifm_media = oldmedia;
268 * Get list of available media and current media on interface.
272 struct ifmedia_entry *ep;
274 int usermax; /* user requested max */
276 kptr = NULL; /* XXX gcc */
278 ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
279 ifm->ifm_cur->ifm_media : IFM_NONE;
280 ifmr->ifm_mask = ifm->ifm_mask;
281 ifmr->ifm_status = 0;
282 (*ifm->ifm_status)(ifp, ifmr);
288 * If there are more interfaces on the list, count
289 * them. This allows the caller to set ifmr->ifm_count
290 * to 0 on the first call to know how much space to
293 LIST_FOREACH(ep, &ifm->ifm_list, ifm_list)
297 * Don't allow the user to ask for too many
298 * or a negative number.
300 if (ifmr->ifm_count > usermax)
301 ifmr->ifm_count = usermax;
302 else if (ifmr->ifm_count < 0)
305 if (ifmr->ifm_count != 0) {
306 kptr = (int *)malloc(ifmr->ifm_count * sizeof(int),
310 * Get the media words from the interface's list.
312 ep = LIST_FIRST(&ifm->ifm_list);
313 for (; ep != NULL && count < ifmr->ifm_count;
314 ep = LIST_NEXT(ep, ifm_list), count++)
315 kptr[count] = ep->ifm_media;
318 error = E2BIG; /* oops! */
324 * We do the copyout on E2BIG, because that's
325 * just our way of telling userland that there
326 * are more. This is the behavior I've observed
330 if ((error == 0 || error == E2BIG) && ifmr->ifm_count != 0) {
331 error = copyout((caddr_t)kptr,
332 (caddr_t)ifmr->ifm_ulist,
333 ifmr->ifm_count * sizeof(int));
339 if (ifmr->ifm_count != 0)
342 ifmr->ifm_count = count;
354 * Find media entry matching a given ifm word.
357 static struct ifmedia_entry *
358 ifmedia_match(ifm, target, mask)
363 struct ifmedia_entry *match, *next;
368 LIST_FOREACH(next, &ifm->ifm_list, ifm_list) {
369 if ((next->ifm_media & mask) == (target & mask)) {
370 #if defined(IFMEDIA_DEBUG) || defined(DIAGNOSTIC)
372 printf("ifmedia_match: multiple match for "
373 "0x%x/0x%x\n", target, mask);
384 struct ifmedia_description ifm_type_descriptions[] =
385 IFM_TYPE_DESCRIPTIONS;
387 struct ifmedia_description ifm_subtype_ethernet_descriptions[] =
388 IFM_SUBTYPE_ETHERNET_DESCRIPTIONS;
390 struct ifmedia_description ifm_subtype_ethernet_option_descriptions[] =
391 IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS;
393 struct ifmedia_description ifm_subtype_tokenring_descriptions[] =
394 IFM_SUBTYPE_TOKENRING_DESCRIPTIONS;
396 struct ifmedia_description ifm_subtype_tokenring_option_descriptions[] =
397 IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS;
399 struct ifmedia_description ifm_subtype_fddi_descriptions[] =
400 IFM_SUBTYPE_FDDI_DESCRIPTIONS;
402 struct ifmedia_description ifm_subtype_fddi_option_descriptions[] =
403 IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS;
405 struct ifmedia_description ifm_subtype_ieee80211_descriptions[] =
406 IFM_SUBTYPE_IEEE80211_DESCRIPTIONS;
408 struct ifmedia_description ifm_subtype_ieee80211_option_descriptions[] =
409 IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS;
411 struct ifmedia_description ifm_subtype_shared_descriptions[] =
412 IFM_SUBTYPE_SHARED_DESCRIPTIONS;
414 struct ifmedia_description ifm_shared_option_descriptions[] =
415 IFM_SHARED_OPTION_DESCRIPTIONS;
417 struct ifmedia_type_to_subtype {
418 struct ifmedia_description *subtypes;
419 struct ifmedia_description *options;
422 /* must be in the same order as IFM_TYPE_DESCRIPTIONS */
423 struct ifmedia_type_to_subtype ifmedia_types_to_subtypes[] = {
425 &ifm_subtype_ethernet_descriptions[0],
426 &ifm_subtype_ethernet_option_descriptions[0]
429 &ifm_subtype_tokenring_descriptions[0],
430 &ifm_subtype_tokenring_option_descriptions[0]
433 &ifm_subtype_fddi_descriptions[0],
434 &ifm_subtype_fddi_option_descriptions[0]
437 &ifm_subtype_ieee80211_descriptions[0],
438 &ifm_subtype_ieee80211_option_descriptions[0]
443 * print a media word.
446 ifmedia_printword(ifmw)
449 struct ifmedia_description *desc;
450 struct ifmedia_type_to_subtype *ttos;
453 /* Find the top-level interface type. */
454 for (desc = ifm_type_descriptions, ttos = ifmedia_types_to_subtypes;
455 desc->ifmt_string != NULL; desc++, ttos++)
456 if (IFM_TYPE(ifmw) == desc->ifmt_word)
458 if (desc->ifmt_string == NULL) {
459 printf("<unknown type>\n");
462 printf(desc->ifmt_string);
465 * Check for the shared subtype descriptions first, then the
466 * type-specific ones.
468 for (desc = ifm_subtype_shared_descriptions;
469 desc->ifmt_string != NULL; desc++)
470 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
473 for (desc = ttos->subtypes; desc->ifmt_string != NULL; desc++)
474 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
476 if (desc->ifmt_string == NULL) {
477 printf(" <unknown subtype>\n");
482 printf(" %s", desc->ifmt_string);
485 * Look for shared options.
487 for (desc = ifm_shared_option_descriptions;
488 desc->ifmt_string != NULL; desc++) {
489 if (ifmw & desc->ifmt_word) {
490 if (seen_option == 0)
492 printf("%s%s", seen_option++ ? "," : "",
498 * Look for subtype-specific options.
500 for (desc = ttos->options; desc->ifmt_string != NULL; desc++) {
501 if (ifmw & desc->ifmt_word) {
502 if (seen_option == 0)
504 printf("%s%s", seen_option++ ? "," : "",
508 printf("%s\n", seen_option ? ">" : "");
510 #endif /* IFMEDIA_DEBUG */