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 $ */
6 * Jonathan Stone and Jason R. Thorpe. All rights reserved.
8 * This software is derived from information provided by Matt Thomas.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by Jonathan Stone
21 * and Jason R. Thorpe for the NetBSD Project.
22 * 4. The names of the authors may not be used to endorse or promote products
23 * derived from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
26 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
32 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * BSD/OS-compatible network interface media selection.
41 * Where it is safe to do so, this code strays slightly from the BSD/OS
42 * design. Software which uses the API (device drivers, basically)
43 * shouldn't notice any difference.
45 * Many thanks to Matt Thomas for providing the information necessary
46 * to implement this interface.
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/socket.h>
52 #include <sys/sockio.h>
53 #include <sys/malloc.h>
56 #include <net/if_var.h>
57 #include <net/if_media.h>
60 * Compile-time options:
62 * turn on implementation-level debug kprintfs.
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(struct ifmedia *ifm, int dontcare_mask,
79 ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback)
82 LIST_INIT(&ifm->ifm_list);
84 ifm->ifm_media = IFM_NONE;
85 ifm->ifm_mask = dontcare_mask; /* IF don't-care bits */
86 ifm->ifm_change = change_callback;
87 ifm->ifm_status = status_callback;
91 ifmedia_removeall(struct ifmedia *ifm)
93 struct ifmedia_entry *entry;
95 while ((entry = LIST_FIRST(&ifm->ifm_list)) != NULL) {
96 LIST_REMOVE(entry, ifm_list);
97 kfree(entry, M_IFADDR);
100 ifm->ifm_media = IFM_NONE;
104 * Add a media configuration to the list of supported media
105 * for a specific interface instance.
108 ifmedia_add(struct ifmedia *ifm, int mword, int data, void *aux)
110 struct ifmedia_entry *entry;
115 kprintf("ifmedia_add: null ifm\n");
118 kprintf("Adding entry for ");
119 ifmedia_printword(mword);
123 entry = kmalloc(sizeof(*entry), M_IFADDR, M_INTWAIT);
124 entry->ifm_media = mword;
125 entry->ifm_data = data;
126 entry->ifm_aux = aux;
128 LIST_INSERT_HEAD(&ifm->ifm_list, entry, ifm_list);
132 ifmedia_add_nodup(struct ifmedia *ifm, int mword, int data, void *aux)
134 struct ifmedia_entry *match;
136 match = ifmedia_match(ifm, mword, ifm->ifm_mask);
139 ifmedia_add(ifm, mword, data, aux);
144 * Add an array of media configurations to the list of
145 * supported media for a specific interface instance.
148 ifmedia_list_add(struct ifmedia *ifm, 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(struct ifmedia *ifm, int target)
168 struct ifmedia_entry *match;
170 match = ifmedia_match(ifm, target, ifm->ifm_mask);
172 kprintf("ifmedia_set: no match for 0x%x/0x%x\n",
173 target, ~ifm->ifm_mask);
174 panic("ifmedia_set");
176 ifm->ifm_cur = match;
177 ifm->ifm_media = target;
181 kprintf("ifmedia_set: target ");
182 ifmedia_printword(target);
183 kprintf("ifmedia_set: setting to ");
184 ifmedia_printword(ifm->ifm_cur->ifm_media);
190 ifmedia_tryset(struct ifmedia *ifm, int target)
192 struct ifmedia_entry *match;
194 match = ifmedia_match(ifm, target, ifm->ifm_mask);
197 ifmedia_set(ifm, target);
202 * Device-independent media ioctl support function, typically called
203 * from the device network ioctl procedure.
206 ifmedia_ioctl(struct ifnet *ifp, struct ifreq *ifr,
207 struct ifmedia *ifm, u_long cmd)
209 struct ifmedia_entry *match;
210 struct ifmediareq *ifmr = (struct ifmediareq *) ifr;
211 int error = 0, sticky;
213 if (ifp == NULL || ifr == NULL || ifm == NULL)
216 ASSERT_IFNET_SERIALIZED_ALL(ifp);
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 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 kprintf("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.
280 struct ifmedia_entry *ep;
282 int usermax; /* user requested max */
284 kptr = NULL; /* XXX gcc */
288 * ifm_cur may not contain certain media options, e.g.
289 * flow control options, so ifm_media should be used
292 ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
293 ifm->ifm_media : IFM_NONE;
294 ifmr->ifm_mask = ifm->ifm_mask;
295 ifmr->ifm_status = 0;
296 (*ifm->ifm_status)(ifp, ifmr);
302 * If there are more interfaces on the list, count
303 * them. This allows the caller to set ifmr->ifm_count
304 * to 0 on the first call to know how much space to
307 LIST_FOREACH(ep, &ifm->ifm_list, ifm_list)
311 * Don't allow the user to ask for too many
312 * or a negative number.
314 if (ifmr->ifm_count > usermax)
315 ifmr->ifm_count = usermax;
316 else if (ifmr->ifm_count < 0)
319 if (ifmr->ifm_count != 0) {
320 kptr = (int *)kmalloc(ifmr->ifm_count * sizeof(int),
324 * Get the media words from the interface's list.
326 ep = LIST_FIRST(&ifm->ifm_list);
327 for (; ep != NULL && count < ifmr->ifm_count;
328 ep = LIST_NEXT(ep, ifm_list), count++)
329 kptr[count] = ep->ifm_media;
332 error = E2BIG; /* oops! */
338 * We do the copyout on E2BIG, because that's
339 * just our way of telling userland that there
340 * are more. This is the behavior I've observed
344 if ((error == 0 || error == E2BIG) && ifmr->ifm_count != 0) {
345 error = copyout((caddr_t)kptr,
346 (caddr_t)ifmr->ifm_ulist,
347 ifmr->ifm_count * sizeof(int));
353 if (ifmr->ifm_count != 0)
356 ifmr->ifm_count = count;
368 * Find media entry matching a given ifm word.
371 static struct ifmedia_entry *
372 ifmedia_match(struct ifmedia *ifm, int target, int mask)
374 struct ifmedia_entry *match, *next;
379 LIST_FOREACH(next, &ifm->ifm_list, ifm_list) {
380 if ((next->ifm_media & mask) == (target & mask)) {
381 #if defined(IFMEDIA_DEBUG) || defined(DIAGNOSTIC)
383 kprintf("ifmedia_match: multiple match for "
384 "0x%x/0x%x\n", target, mask);
394 struct ifmedia_baudrate ifmedia_baudrate_descriptions[] =
395 IFM_BAUDRATE_DESCRIPTIONS;
398 ifmedia_baudrate(int mword)
402 for (i = 0; ifmedia_baudrate_descriptions[i].ifmb_word != 0; i++) {
403 if ((mword & (IFM_NMASK|IFM_TMASK)) ==
404 ifmedia_baudrate_descriptions[i].ifmb_word)
405 return (ifmedia_baudrate_descriptions[i].ifmb_baudrate);
413 ifmedia_str2ethfc(const char *str)
415 if (strcmp(str, IFM_ETH_FC_FULL) == 0)
416 return (IFM_ETH_RXPAUSE | IFM_ETH_TXPAUSE);
417 if (strcmp(str, IFM_ETH_FC_RXPAUSE) == 0)
418 return IFM_ETH_RXPAUSE;
419 if (strcmp(str, IFM_ETH_FC_TXPAUSE) == 0)
420 return IFM_ETH_TXPAUSE;
422 if (strcmp(str, IFM_ETH_FC_FORCE_FULL) == 0)
423 return (IFM_ETH_RXPAUSE | IFM_ETH_TXPAUSE | IFM_ETH_FORCEPAUSE);
424 if (strcmp(str, IFM_ETH_FC_FORCE_RXPAUSE) == 0)
425 return (IFM_ETH_RXPAUSE | IFM_ETH_FORCEPAUSE);
426 if (strcmp(str, IFM_ETH_FC_FORCE_TXPAUSE) == 0)
427 return (IFM_ETH_TXPAUSE | IFM_ETH_FORCEPAUSE);
428 if (strcmp(str, IFM_ETH_FC_FORCE_NONE) == 0)
429 return IFM_ETH_FORCEPAUSE;
435 struct ifmedia_description ifm_type_descriptions[] =
436 IFM_TYPE_DESCRIPTIONS;
438 struct ifmedia_description ifm_subtype_ethernet_descriptions[] =
439 IFM_SUBTYPE_ETHERNET_DESCRIPTIONS;
441 struct ifmedia_description ifm_subtype_ethernet_option_descriptions[] =
442 IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS;
444 struct ifmedia_description ifm_subtype_ieee80211_descriptions[] =
445 IFM_SUBTYPE_IEEE80211_DESCRIPTIONS;
447 struct ifmedia_description ifm_subtype_ieee80211_option_descriptions[] =
448 IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS;
450 struct ifmedia_description ifm_subtype_shared_descriptions[] =
451 IFM_SUBTYPE_SHARED_DESCRIPTIONS;
453 struct ifmedia_description ifm_shared_option_descriptions[] =
454 IFM_SHARED_OPTION_DESCRIPTIONS;
456 struct ifmedia_type_to_subtype {
457 struct ifmedia_description *subtypes;
458 struct ifmedia_description *options;
461 /* must be in the same order as IFM_TYPE_DESCRIPTIONS */
462 struct ifmedia_type_to_subtype ifmedia_types_to_subtypes[] = {
464 &ifm_subtype_ethernet_descriptions[0],
465 &ifm_subtype_ethernet_option_descriptions[0]
468 &ifm_subtype_ieee80211_descriptions[0],
469 &ifm_subtype_ieee80211_option_descriptions[0]
474 * print a media word.
477 ifmedia_printword(int ifmw)
479 struct ifmedia_description *desc;
480 struct ifmedia_type_to_subtype *ttos;
483 /* Find the top-level interface type. */
484 for (desc = ifm_type_descriptions, ttos = ifmedia_types_to_subtypes;
485 desc->ifmt_string != NULL; desc++, ttos++)
486 if (IFM_TYPE(ifmw) == desc->ifmt_word)
488 if (desc->ifmt_string == NULL) {
489 kprintf("<unknown type>\n");
492 kprintf(desc->ifmt_string);
495 * Check for the shared subtype descriptions first, then the
496 * type-specific ones.
498 for (desc = ifm_subtype_shared_descriptions;
499 desc->ifmt_string != NULL; desc++)
500 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
503 for (desc = ttos->subtypes; desc->ifmt_string != NULL; desc++)
504 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
506 if (desc->ifmt_string == NULL) {
507 kprintf(" <unknown subtype>\n");
512 kprintf(" %s", desc->ifmt_string);
515 * Look for shared options.
517 for (desc = ifm_shared_option_descriptions;
518 desc->ifmt_string != NULL; desc++) {
519 if (ifmw & desc->ifmt_word) {
520 if (seen_option == 0)
522 kprintf("%s%s", seen_option++ ? "," : "",
528 * Look for subtype-specific options.
530 for (desc = ttos->options; desc->ifmt_string != NULL; desc++) {
531 if (ifmw & desc->ifmt_word) {
532 if (seen_option == 0)
534 kprintf("%s%s", seen_option++ ? "," : "",
538 kprintf("%s\n", seen_option ? ">" : "");
540 #endif /* IFMEDIA_DEBUG */