New upstream snapshot.
[debian/madwifi.git] / net80211 / if_media.c
1 /*
2  * Copyright (c) 1997
3  *      Jonathan Stone and Jason R. Thorpe.  All rights reserved.
4  *
5  * This software is derived from information provided by Matt Thomas.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *      This product includes software developed by Jonathan Stone
18  *      and Jason R. Thorpe for the NetBSD Project.
19  * 4. The names of the authors may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $Id: if_media.c 4159 2011-08-03 01:22:41Z proski $
35  */
36
37 /*
38  * BSD/OS-compatible network interface media selection.
39  *
40  * Where it is safe to do so, this code strays slightly from the BSD/OS
41  * design.  Software which uses the API (device drivers, basically)
42  * shouldn't notice any difference.
43  *
44  * Many thanks to Matt Thomas for providing the information necessary
45  * to implement this interface.
46  */
47
48 #ifndef EXPORT_SYMTAB
49 #define EXPORT_SYMTAB
50 #endif
51
52 #if !defined(AUTOCONF_INCLUDED) && !defined(CONFIG_LOCALVERSION)
53 #include <linux/config.h>
54 #endif
55 #include <linux/version.h>
56 #include <linux/module.h>
57 #include <linux/kernel.h>
58 #include <linux/slab.h>
59 #include <linux/if.h>
60 #include <linux/netdevice.h>
61 #ifndef ifr_media
62 #define ifr_media       ifr_ifru.ifru_ivalue
63 #endif
64
65 #include <asm/uaccess.h>
66
67 #include "if_media.h"
68
69 /*
70  * Compile-time options:
71  * IFMEDIA_DEBUG:
72  *      turn on implementation-level debug printfs.
73  *      Useful for debugging newly-ported  drivers.
74  */
75
76 struct ifmedia_entry *ifmedia_match(struct ifmedia *, int, int);
77
78 #ifdef IFMEDIA_DEBUG
79 int ifmedia_debug = 0;
80 static void ifmedia_printword(int);
81 #endif
82
83 /*
84  * Initialize if_media struct for a specific interface instance.
85  */
86 void
87 ifmedia_init(struct ifmedia *ifm, int dontcare_mask,
88         ifm_change_cb_t change_callback, ifm_stat_cb_t status_callback)
89 {
90         LIST_INIT(&ifm->ifm_list);
91         ifm->ifm_cur = NULL;
92         ifm->ifm_media = 0;
93         ifm->ifm_mask = dontcare_mask;          /* IF don't-care bits */
94         ifm->ifm_change = change_callback;
95         ifm->ifm_status = status_callback;
96 }
97
98 void
99 ifmedia_removeall(struct ifmedia *ifm)
100 {
101         struct ifmedia_entry *entry;
102
103         for (entry = LIST_FIRST(&ifm->ifm_list); entry;
104              entry = LIST_FIRST(&ifm->ifm_list)) {
105                 LIST_REMOVE(entry, ifm_list);
106                 kfree(entry);
107         }
108 }
109
110 /*
111  * Add a media configuration to the list of supported media
112  * for a specific interface instance.
113  */
114 void
115 ifmedia_add(struct ifmedia *ifm, int mword, int data, void *aux)
116 {
117         register struct ifmedia_entry *entry;
118
119 #ifdef IFMEDIA_DEBUG
120         if (ifmedia_debug) {
121                 if (ifm == NULL) {
122                         printk("ifmedia_add: null ifm\n");
123                         return;
124                 }
125                 printk("Adding entry for ");
126                 ifmedia_printword(mword);
127         }
128 #endif
129
130         entry = kmalloc(sizeof(*entry), GFP_KERNEL);
131         if (entry == NULL)
132                 panic("ifmedia_add: can't malloc entry");
133
134         entry->ifm_media = mword;
135         entry->ifm_data = data;
136         entry->ifm_aux = aux;
137
138         LIST_INSERT_HEAD(&ifm->ifm_list, entry, ifm_list);
139 }
140
141 /*
142  * Add an array of media configurations to the list of
143  * supported media for a specific interface instance.
144  */
145 void
146 ifmedia_list_add(struct ifmedia *ifm, struct ifmedia_entry *lp, int count)
147 {
148         int i;
149
150         for (i = 0; i < count; i++)
151                 ifmedia_add(ifm, lp[i].ifm_media, lp[i].ifm_data, lp[i].ifm_aux);
152 }
153
154 /*
155  * Set the default active media. 
156  *
157  * Called by device-specific code which is assumed to have already
158  * selected the default media in hardware.  We do _not_ call the
159  * media-change callback.
160  */
161 void
162 ifmedia_set(struct ifmedia *ifm, int target)
163 {
164         struct ifmedia_entry *match;
165
166         match = ifmedia_match(ifm, target, ifm->ifm_mask);
167
168         if (match == NULL) {
169                 printk("ifmedia_set: no match for 0x%x/0x%x\n",
170                         target, ~ifm->ifm_mask);
171                 panic("ifmedia_set");
172         }
173         ifm->ifm_cur = match;
174
175 #ifdef IFMEDIA_DEBUG
176         if (ifmedia_debug) {
177                 printk("ifmedia_set: target ");
178                 ifmedia_printword(target);
179                 printk("ifmedia_set: setting to ");
180                 ifmedia_printword(ifm->ifm_cur->ifm_media);
181         }
182 #endif
183 }
184
185 /*
186  * Device-independent media ioctl support function.
187  */
188 int
189 ifmedia_ioctl(struct net_device *dev, struct ifreq *ifr,
190         struct ifmedia *ifm, u_long cmd)
191 {
192         struct ifmedia_entry *match;
193         struct ifmediareq *ifmr = (struct ifmediareq *) ifr;
194         int error = 0, sticky;
195
196         if (dev == NULL || ifr == NULL || ifm == NULL)
197                 return -EINVAL;
198
199         switch (cmd) {
200         /*
201          * Set the current media.
202          */
203         case  SIOCSIFMEDIA:
204         {
205                 struct ifmedia_entry *oldentry;
206                 int oldmedia;
207                 int newmedia = ifr->ifr_media;
208
209                 match = ifmedia_match(ifm, newmedia, ifm->ifm_mask);
210                 if (match == NULL) {
211 #ifdef IFMEDIA_DEBUG
212                         if (ifmedia_debug) {
213                                 printk("ifmedia_ioctl: no media found for 0x%x\n", 
214                                         newmedia);
215                         }
216 #endif
217                         return -ENXIO;
218                 }
219
220                 /*
221                  * If no change, we're done.
222                  * XXX Automedia may invole software intervention.
223                  *     Keep going in case the the connected media changed.
224                  *     Similarly, if best match changed (kernel debugger?).
225                  */
226                 if ((IFM_SUBTYPE(newmedia) != IFM_AUTO) &&
227                     (newmedia == ifm->ifm_media) &&
228                     (match == ifm->ifm_cur))
229                         return 0;
230
231                 /*
232                  * We found a match, now make the driver switch to it.
233                  * Make sure to preserve our old media type in case the
234                  * driver can't switch.
235                  */
236 #ifdef IFMEDIA_DEBUG
237                 if (ifmedia_debug) {
238                         printk("ifmedia_ioctl: switching %s to ", dev->name);
239                         ifmedia_printword(match->ifm_media);
240                 }
241 #endif
242                 oldentry = ifm->ifm_cur;
243                 oldmedia = ifm->ifm_media;
244                 ifm->ifm_cur = match;
245                 ifm->ifm_media = newmedia;
246                 error = (*ifm->ifm_change)(dev);
247                 if ((error < 0) && (error != -ENETRESET)) {
248                         ifm->ifm_cur = oldentry;
249                         ifm->ifm_media = oldmedia;
250                 }
251                 break;
252         }
253
254         /*
255          * Get list of available media and current media on interface.
256          */
257         case  SIOCGIFMEDIA: 
258         {
259                 struct ifmedia_entry *ep;
260                 int *kptr, count;
261                 int usermax;    /* user requested max */
262
263                 kptr = NULL;            /* XXX gcc */
264
265                 ifmr->ifm_active = ifmr->ifm_current = ifm->ifm_cur ?
266                         ifm->ifm_cur->ifm_media : IFM_NONE;
267                 ifmr->ifm_mask = ifm->ifm_mask;
268                 ifmr->ifm_status = 0;
269                 (*ifm->ifm_status)(dev, ifmr);
270
271                 count = 0;
272                 usermax = 0;
273
274                 /*
275                  * If there are more interfaces on the list, count
276                  * them.  This allows the caller to set ifmr->ifm_count
277                  * to 0 on the first call to know how much space to
278                  * allocate.
279                  */
280                 LIST_FOREACH(ep, &ifm->ifm_list, ifm_list)
281                         usermax++;
282
283                 /*
284                  * Don't allow the user to ask for too many
285                  * or a negative number.
286                  */
287                 if (ifmr->ifm_count > usermax)
288                         ifmr->ifm_count = usermax;
289                 else if (ifmr->ifm_count < 0)
290                         return (-EINVAL);
291
292                 if (ifmr->ifm_count != 0) {
293                         kptr = kmalloc(ifmr->ifm_count * sizeof(int),
294                                        GFP_KERNEL);
295
296                         if (kptr == NULL)
297                                 return (-ENOMEM);
298                         /*
299                          * Get the media words from the interface's list.
300                          */
301                         ep = LIST_FIRST(&ifm->ifm_list);
302                         for (; ep != NULL && count < ifmr->ifm_count;
303                             ep = LIST_NEXT(ep, ifm_list), count++)
304                                 kptr[count] = ep->ifm_media;
305
306                         if (ep != NULL)
307                                 error = -E2BIG; /* oops! */
308                 } else
309                         count = usermax;
310
311                 /*
312                  * We do the copyout on E2BIG, because that's
313                  * just our way of telling userland that there
314                  * are more.  This is the behavior I've observed
315                  * under BSD/OS 3.0
316                  */
317                 sticky = error;
318                 if ((error == 0 || error == -E2BIG) && ifmr->ifm_count != 0) {
319                         error = copy_to_user(ifmr->ifm_ulist,
320                                 kptr, ifmr->ifm_count * sizeof(int));
321                 }
322
323                 if (error == 0)
324                         error = sticky;
325
326                 if (ifmr->ifm_count != 0)
327                         kfree(kptr);
328
329                 ifmr->ifm_count = count;
330                 break;
331         }
332
333         default:
334                 return -EINVAL;
335         }
336
337         return error;
338 }
339
340 /*
341  * Find media entry matching a given ifm word.
342  *
343  */
344 struct ifmedia_entry *
345 ifmedia_match(struct ifmedia *ifm, int target, int mask)
346 {
347         struct ifmedia_entry *match, *next;
348
349         match = NULL;
350         mask = ~mask;
351
352         LIST_FOREACH(next, &ifm->ifm_list, ifm_list) {
353                 if ((next->ifm_media & mask) == (target & mask)) {
354 #if defined(IFMEDIA_DEBUG) || defined(DIAGNOSTIC)
355                         if (match)
356                                 printk("ifmedia_match: multiple match for "
357                                         "0x%x/0x%x\n", target, mask);
358 #endif
359                         match = next;
360                 }
361         }
362
363         return match;
364 }
365
366 #ifdef IFMEDIA_DEBUG
367 struct ifmedia_description ifm_type_descriptions[] =
368     IFM_TYPE_DESCRIPTIONS;
369
370 struct ifmedia_description ifm_subtype_ethernet_descriptions[] =
371     IFM_SUBTYPE_ETHERNET_DESCRIPTIONS;
372
373 struct ifmedia_description ifm_subtype_ethernet_option_descriptions[] =
374     IFM_SUBTYPE_ETHERNET_OPTION_DESCRIPTIONS;
375
376 struct ifmedia_description ifm_subtype_tokenring_descriptions[] =
377     IFM_SUBTYPE_TOKENRING_DESCRIPTIONS;
378
379 struct ifmedia_description ifm_subtype_tokenring_option_descriptions[] =
380     IFM_SUBTYPE_TOKENRING_OPTION_DESCRIPTIONS;
381
382 struct ifmedia_description ifm_subtype_fddi_descriptions[] =
383     IFM_SUBTYPE_FDDI_DESCRIPTIONS;
384
385 struct ifmedia_description ifm_subtype_fddi_option_descriptions[] =
386     IFM_SUBTYPE_FDDI_OPTION_DESCRIPTIONS;
387
388 struct ifmedia_description ifm_subtype_ieee80211_descriptions[] =
389     IFM_SUBTYPE_IEEE80211_DESCRIPTIONS;
390
391 struct ifmedia_description ifm_subtype_ieee80211_option_descriptions[] =
392     IFM_SUBTYPE_IEEE80211_OPTION_DESCRIPTIONS;
393
394 struct ifmedia_description ifm_subtype_ieee80211_mode_descriptions[] =
395     IFM_SUBTYPE_IEEE80211_MODE_DESCRIPTIONS;
396
397 struct ifmedia_description ifm_subtype_shared_descriptions[] =
398     IFM_SUBTYPE_SHARED_DESCRIPTIONS;
399
400 struct ifmedia_description ifm_shared_option_descriptions[] =
401     IFM_SHARED_OPTION_DESCRIPTIONS;
402
403 struct ifmedia_type_to_subtype {                /* XXX: right place for declaration? */
404         struct ifmedia_description *subtypes;
405         struct ifmedia_description *options;
406         struct ifmedia_description *modes;
407 };
408
409 /* must be in the same order as IFM_TYPE_DESCRIPTIONS */
410 struct ifmedia_type_to_subtype ifmedia_types_to_subtypes[] = {
411         { &ifm_subtype_ethernet_descriptions[0],
412           &ifm_subtype_ethernet_option_descriptions[0],
413           NULL, },
414         { &ifm_subtype_tokenring_descriptions[0],
415           &ifm_subtype_tokenring_option_descriptions[0],
416           NULL, },
417         { &ifm_subtype_fddi_descriptions[0],
418           &ifm_subtype_fddi_option_descriptions[0],
419           NULL, },
420         { &ifm_subtype_ieee80211_descriptions[0],
421           &ifm_subtype_ieee80211_option_descriptions[0],
422           &ifm_subtype_ieee80211_mode_descriptions[0] },
423 };
424
425 /*
426  * print a media word.
427  */
428 static void
429 ifmedia_printword(int ifmw)
430 {
431         struct ifmedia_description *desc;
432         struct ifmedia_type_to_subtype *ttos;
433         int seen_option = 0;
434
435         /* Find the top-level interface type. */
436         for (desc = ifm_type_descriptions, ttos = ifmedia_types_to_subtypes;
437             desc->ifmt_string != NULL; desc++, ttos++)
438                 if (IFM_TYPE(ifmw) == desc->ifmt_word)
439                         break;
440         if (desc->ifmt_string == NULL) {
441                 printk("<unknown type>\n");
442                 return;
443         }
444         printk(desc->ifmt_string);
445
446         /* Any mode. */
447         for (desc = ttos->modes; desc && desc->ifmt_string != NULL; desc++)
448                 if (IFM_MODE(ifmw) == desc->ifmt_word) {
449                         if (desc->ifmt_string != NULL)
450                                 printk(" mode %s", desc->ifmt_string);
451                         break;
452                 }
453
454         /*
455          * Check for the shared subtype descriptions first, then the
456          * type-specific ones.
457          */
458         for (desc = ifm_subtype_shared_descriptions;
459             desc->ifmt_string != NULL; desc++)
460                 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
461                         goto got_subtype;
462
463         for (desc = ttos->subtypes; desc->ifmt_string != NULL; desc++)
464                 if (IFM_SUBTYPE(ifmw) == desc->ifmt_word)
465                         break;
466         if (desc->ifmt_string == NULL) {
467                 printk(" <unknown subtype>\n");
468                 return;
469         }
470
471  got_subtype:
472         printk(" %s", desc->ifmt_string);
473
474         /*
475          * Look for shared options.
476          */
477         for (desc = ifm_shared_option_descriptions;
478             desc->ifmt_string != NULL; desc++) {
479                 if (ifmw & desc->ifmt_word) {
480                         if (seen_option == 0)
481                                 printk(" <");
482                         printk("%s%s", seen_option++ ? "," : "",
483                             desc->ifmt_string);
484                 }
485         }
486
487         /*
488          * Look for subtype-specific options.
489          */
490         for (desc = ttos->options; desc->ifmt_string != NULL; desc++) {
491                 if (ifmw & desc->ifmt_word) {
492                         if (seen_option == 0)
493                                 printk(" <");
494                         printk("%s%s", seen_option++ ? "," : "",
495                             desc->ifmt_string); 
496                 }
497         }
498         printk("%s\n", seen_option ? ">" : "");
499 }
500 #endif /* IFMEDIA_DEBUG */
501
502 EXPORT_SYMBOL(ifmedia_ioctl);