SAFE public projects git trees. - safe/jmp/linux-2.6/blob - net/wireless/wext.c

   1 /*
   2  * This file implement the Wireless Extensions APIs.
   3  *
   4  * Authors :    Jean Tourrilhes - HPL - <jt@hpl.hp.com>
   5  * Copyright (c) 1997-2007 Jean Tourrilhes, All Rights Reserved.
   6  *
   7  * (As all part of the Linux kernel, this file is GPL)
   8  */
   9
  10 /************************** DOCUMENTATION **************************/
  11 /*
  12  * API definition :
  13  * --------------
  14  * See <linux/wireless.h> for details of the APIs and the rest.
  15  *
  16  * History :
  17  * -------
  18  *
  19  * v1 - 5.12.01 - Jean II
  20  *      o Created this file.
  21  *
  22  * v2 - 13.12.01 - Jean II
  23  *      o Move /proc/net/wireless stuff from net/core/dev.c to here
  24  *      o Make Wireless Extension IOCTLs go through here
  25  *      o Added iw_handler handling ;-)
  26  *      o Added standard ioctl description
  27  *      o Initial dumb commit strategy based on orinoco.c
  28  *
  29  * v3 - 19.12.01 - Jean II
  30  *      o Make sure we don't go out of standard_ioctl[] in ioctl_standard_call
  31  *      o Add event dispatcher function
  32  *      o Add event description
  33  *      o Propagate events as rtnetlink IFLA_WIRELESS option
  34  *      o Generate event on selected SET requests
  35  *
  36  * v4 - 18.04.02 - Jean II
  37  *      o Fix stupid off by one in iw_ioctl_description : IW_ESSID_MAX_SIZE + 1
  38  *
  39  * v5 - 21.06.02 - Jean II
  40  *      o Add IW_PRIV_TYPE_ADDR in priv_type_size (+cleanup)
  41  *      o Reshuffle IW_HEADER_TYPE_XXX to map IW_PRIV_TYPE_XXX changes
  42  *      o Add IWEVCUSTOM for driver specific event/scanning token
  43  *      o Turn on WE_STRICT_WRITE by default + kernel warning
  44  *      o Fix WE_STRICT_WRITE in ioctl_export_private() (32 => iw_num)
  45  *      o Fix off-by-one in test (extra_size <= IFNAMSIZ)
  46  *
  47  * v6 - 9.01.03 - Jean II
  48  *      o Add common spy support : iw_handler_set_spy(), wireless_spy_update()
  49  *      o Add enhanced spy support : iw_handler_set_thrspy() and event.
  50  *      o Add WIRELESS_EXT version display in /proc/net/wireless
  51  *
  52  * v6 - 18.06.04 - Jean II
  53  *      o Change get_spydata() method for added safety
  54  *      o Remove spy #ifdef, they are always on -> cleaner code
  55  *      o Allow any size GET request if user specifies length > max
  56  *              and if request has IW_DESCR_FLAG_NOMAX flag or is SIOCGIWPRIV
  57  *      o Start migrating get_wireless_stats to struct iw_handler_def
  58  *      o Add wmb() in iw_handler_set_spy() for non-coherent archs/cpus
  59  * Based on patch from Pavel Roskin <proski@gnu.org> :
  60  *      o Fix kernel data leak to user space in private handler handling
  61  *
  62  * v7 - 18.3.05 - Jean II
  63  *      o Remove (struct iw_point *)->pointer from events and streams
  64  *      o Remove spy_offset from struct iw_handler_def
  65  *      o Start deprecating dev->get_wireless_stats, output a warning
  66  *      o If IW_QUAL_DBM is set, show dBm values in /proc/net/wireless
  67  *      o Don't loose INVALID/DBM flags when clearing UPDATED flags (iwstats)
  68  *
  69  * v8 - 17.02.06 - Jean II
  70  *      o RtNetlink requests support (SET/GET)
  71  *
  72  * v8b - 03.08.06 - Herbert Xu
  73  *      o Fix Wireless Event locking issues.
  74  *
  75  * v9 - 14.3.06 - Jean II
  76  *      o Change length in ESSID and NICK to strlen() instead of strlen()+1
  77  *      o Make standard_ioctl_num and standard_event_num unsigned
  78  *      o Remove (struct net_device *)->get_wireless_stats()
  79  *
  80  * v10 - 16.3.07 - Jean II
  81  *      o Prevent leaking of kernel space in stream on 64 bits.
  82  */
  83
  84 /***************************** INCLUDES *****************************/
  85
  86 #include <linux/module.h>
  87 #include <linux/types.h>                /* off_t */
  88 #include <linux/netdevice.h>            /* struct ifreq, dev_get_by_name() */
  89 #include <linux/proc_fs.h>
  90 #include <linux/rtnetlink.h>            /* rtnetlink stuff */
  91 #include <linux/seq_file.h>
  92 #include <linux/init.h>                 /* for __init */
  93 #include <linux/if_arp.h>               /* ARPHRD_ETHER */
  94 #include <linux/etherdevice.h>          /* compare_ether_addr */
  95 #include <linux/interrupt.h>
  96 #include <net/net_namespace.h>
  97
  98 #include <linux/wireless.h>             /* Pretty obvious */
  99 #include <net/iw_handler.h>             /* New driver API */
 100 #include <net/netlink.h>
 101 #include <net/wext.h>
 102
 103 #include <asm/uaccess.h>                /* copy_to_user() */
 104
 105 /************************* GLOBAL VARIABLES *************************/
 106 /*
 107  * You should not use global variables, because of re-entrancy.
 108  * On our case, it's only const, so it's OK...
 109  */
 110 /*
 111  * Meta-data about all the standard Wireless Extension request we
 112  * know about.
 113  */
 114 static const struct iw_ioctl_description standard_ioctl[] = {
 115         [SIOCSIWCOMMIT  - SIOCIWFIRST] = {
 116                 .header_type    = IW_HEADER_TYPE_NULL,
 117         },
 118         [SIOCGIWNAME    - SIOCIWFIRST] = {
 119                 .header_type    = IW_HEADER_TYPE_CHAR,
 120                 .flags          = IW_DESCR_FLAG_DUMP,
 121         },
 122         [SIOCSIWNWID    - SIOCIWFIRST] = {
 123                 .header_type    = IW_HEADER_TYPE_PARAM,
 124                 .flags          = IW_DESCR_FLAG_EVENT,
 125         },
 126         [SIOCGIWNWID    - SIOCIWFIRST] = {
 127                 .header_type    = IW_HEADER_TYPE_PARAM,
 128                 .flags          = IW_DESCR_FLAG_DUMP,
 129         },
 130         [SIOCSIWFREQ    - SIOCIWFIRST] = {
 131                 .header_type    = IW_HEADER_TYPE_FREQ,
 132                 .flags          = IW_DESCR_FLAG_EVENT,
 133         },
 134         [SIOCGIWFREQ    - SIOCIWFIRST] = {
 135                 .header_type    = IW_HEADER_TYPE_FREQ,
 136                 .flags          = IW_DESCR_FLAG_DUMP,
 137         },
 138         [SIOCSIWMODE    - SIOCIWFIRST] = {
 139                 .header_type    = IW_HEADER_TYPE_UINT,
 140                 .flags          = IW_DESCR_FLAG_EVENT,
 141         },
 142         [SIOCGIWMODE    - SIOCIWFIRST] = {
 143                 .header_type    = IW_HEADER_TYPE_UINT,
 144                 .flags          = IW_DESCR_FLAG_DUMP,
 145         },
 146         [SIOCSIWSENS    - SIOCIWFIRST] = {
 147                 .header_type    = IW_HEADER_TYPE_PARAM,
 148         },
 149         [SIOCGIWSENS    - SIOCIWFIRST] = {
 150                 .header_type    = IW_HEADER_TYPE_PARAM,
 151         },
 152         [SIOCSIWRANGE   - SIOCIWFIRST] = {
 153                 .header_type    = IW_HEADER_TYPE_NULL,
 154         },
 155         [SIOCGIWRANGE   - SIOCIWFIRST] = {
 156                 .header_type    = IW_HEADER_TYPE_POINT,
 157                 .token_size     = 1,
 158                 .max_tokens     = sizeof(struct iw_range),
 159                 .flags          = IW_DESCR_FLAG_DUMP,
 160         },
 161         [SIOCSIWPRIV    - SIOCIWFIRST] = {
 162                 .header_type    = IW_HEADER_TYPE_NULL,
 163         },
 164         [SIOCGIWPRIV    - SIOCIWFIRST] = { /* (handled directly by us) */
 165                 .header_type    = IW_HEADER_TYPE_POINT,
 166                 .token_size     = sizeof(struct iw_priv_args),
 167                 .max_tokens     = 16,
 168                 .flags          = IW_DESCR_FLAG_NOMAX,
 169         },
 170         [SIOCSIWSTATS   - SIOCIWFIRST] = {
 171                 .header_type    = IW_HEADER_TYPE_NULL,
 172         },
 173         [SIOCGIWSTATS   - SIOCIWFIRST] = { /* (handled directly by us) */
 174                 .header_type    = IW_HEADER_TYPE_POINT,
 175                 .token_size     = 1,
 176                 .max_tokens     = sizeof(struct iw_statistics),
 177                 .flags          = IW_DESCR_FLAG_DUMP,
 178         },
 179         [SIOCSIWSPY     - SIOCIWFIRST] = {
 180                 .header_type    = IW_HEADER_TYPE_POINT,
 181                 .token_size     = sizeof(struct sockaddr),
 182                 .max_tokens     = IW_MAX_SPY,
 183         },
 184         [SIOCGIWSPY     - SIOCIWFIRST] = {
 185                 .header_type    = IW_HEADER_TYPE_POINT,
 186                 .token_size     = sizeof(struct sockaddr) +
 187                                   sizeof(struct iw_quality),
 188                 .max_tokens     = IW_MAX_SPY,
 189         },
 190         [SIOCSIWTHRSPY  - SIOCIWFIRST] = {
 191                 .header_type    = IW_HEADER_TYPE_POINT,
 192                 .token_size     = sizeof(struct iw_thrspy),
 193                 .min_tokens     = 1,
 194                 .max_tokens     = 1,
 195         },
 196         [SIOCGIWTHRSPY  - SIOCIWFIRST] = {
 197                 .header_type    = IW_HEADER_TYPE_POINT,
 198                 .token_size     = sizeof(struct iw_thrspy),
 199                 .min_tokens     = 1,
 200                 .max_tokens     = 1,
 201         },
 202         [SIOCSIWAP      - SIOCIWFIRST] = {
 203                 .header_type    = IW_HEADER_TYPE_ADDR,
 204         },
 205         [SIOCGIWAP      - SIOCIWFIRST] = {
 206                 .header_type    = IW_HEADER_TYPE_ADDR,
 207                 .flags          = IW_DESCR_FLAG_DUMP,
 208         },
 209         [SIOCSIWMLME    - SIOCIWFIRST] = {
 210                 .header_type    = IW_HEADER_TYPE_POINT,
 211                 .token_size     = 1,
 212                 .min_tokens     = sizeof(struct iw_mlme),
 213                 .max_tokens     = sizeof(struct iw_mlme),
 214         },
 215         [SIOCGIWAPLIST  - SIOCIWFIRST] = {
 216                 .header_type    = IW_HEADER_TYPE_POINT,
 217                 .token_size     = sizeof(struct sockaddr) +
 218                                   sizeof(struct iw_quality),
 219                 .max_tokens     = IW_MAX_AP,
 220                 .flags          = IW_DESCR_FLAG_NOMAX,
 221         },
 222         [SIOCSIWSCAN    - SIOCIWFIRST] = {
 223                 .header_type    = IW_HEADER_TYPE_POINT,
 224                 .token_size     = 1,
 225                 .min_tokens     = 0,
 226                 .max_tokens     = sizeof(struct iw_scan_req),
 227         },
 228         [SIOCGIWSCAN    - SIOCIWFIRST] = {
 229                 .header_type    = IW_HEADER_TYPE_POINT,
 230                 .token_size     = 1,
 231                 .max_tokens     = IW_SCAN_MAX_DATA,
 232                 .flags          = IW_DESCR_FLAG_NOMAX,
 233         },
 234         [SIOCSIWESSID   - SIOCIWFIRST] = {
 235                 .header_type    = IW_HEADER_TYPE_POINT,
 236                 .token_size     = 1,
 237                 .max_tokens     = IW_ESSID_MAX_SIZE,
 238                 .flags          = IW_DESCR_FLAG_EVENT,
 239         },
 240         [SIOCGIWESSID   - SIOCIWFIRST] = {
 241                 .header_type    = IW_HEADER_TYPE_POINT,
 242                 .token_size     = 1,
 243                 .max_tokens     = IW_ESSID_MAX_SIZE,
 244                 .flags          = IW_DESCR_FLAG_DUMP,
 245         },
 246         [SIOCSIWNICKN   - SIOCIWFIRST] = {
 247                 .header_type    = IW_HEADER_TYPE_POINT,
 248                 .token_size     = 1,
 249                 .max_tokens     = IW_ESSID_MAX_SIZE,
 250         },
 251         [SIOCGIWNICKN   - SIOCIWFIRST] = {
 252                 .header_type    = IW_HEADER_TYPE_POINT,
 253                 .token_size     = 1,
 254                 .max_tokens     = IW_ESSID_MAX_SIZE,
 255         },
 256         [SIOCSIWRATE    - SIOCIWFIRST] = {
 257                 .header_type    = IW_HEADER_TYPE_PARAM,
 258         },
 259         [SIOCGIWRATE    - SIOCIWFIRST] = {
 260                 .header_type    = IW_HEADER_TYPE_PARAM,
 261         },
 262         [SIOCSIWRTS     - SIOCIWFIRST] = {
 263                 .header_type    = IW_HEADER_TYPE_PARAM,
 264         },
 265         [SIOCGIWRTS     - SIOCIWFIRST] = {
 266                 .header_type    = IW_HEADER_TYPE_PARAM,
 267         },
 268         [SIOCSIWFRAG    - SIOCIWFIRST] = {
 269                 .header_type    = IW_HEADER_TYPE_PARAM,
 270         },
 271         [SIOCGIWFRAG    - SIOCIWFIRST] = {
 272                 .header_type    = IW_HEADER_TYPE_PARAM,
 273         },
 274         [SIOCSIWTXPOW   - SIOCIWFIRST] = {
 275                 .header_type    = IW_HEADER_TYPE_PARAM,
 276         },
 277         [SIOCGIWTXPOW   - SIOCIWFIRST] = {
 278                 .header_type    = IW_HEADER_TYPE_PARAM,
 279         },
 280         [SIOCSIWRETRY   - SIOCIWFIRST] = {
 281                 .header_type    = IW_HEADER_TYPE_PARAM,
 282         },
 283         [SIOCGIWRETRY   - SIOCIWFIRST] = {
 284                 .header_type    = IW_HEADER_TYPE_PARAM,
 285         },
 286         [SIOCSIWENCODE  - SIOCIWFIRST] = {
 287                 .header_type    = IW_HEADER_TYPE_POINT,
 288                 .token_size     = 1,
 289                 .max_tokens     = IW_ENCODING_TOKEN_MAX,
 290                 .flags          = IW_DESCR_FLAG_EVENT | IW_DESCR_FLAG_RESTRICT,
 291         },
 292         [SIOCGIWENCODE  - SIOCIWFIRST] = {
 293                 .header_type    = IW_HEADER_TYPE_POINT,
 294                 .token_size     = 1,
 295                 .max_tokens     = IW_ENCODING_TOKEN_MAX,
 296                 .flags          = IW_DESCR_FLAG_DUMP | IW_DESCR_FLAG_RESTRICT,
 297         },
 298         [SIOCSIWPOWER   - SIOCIWFIRST] = {
 299                 .header_type    = IW_HEADER_TYPE_PARAM,
 300         },
 301         [SIOCGIWPOWER   - SIOCIWFIRST] = {
 302                 .header_type    = IW_HEADER_TYPE_PARAM,
 303         },
 304         [SIOCSIWGENIE   - SIOCIWFIRST] = {
 305                 .header_type    = IW_HEADER_TYPE_POINT,
 306                 .token_size     = 1,
 307                 .max_tokens     = IW_GENERIC_IE_MAX,
 308         },
 309         [SIOCGIWGENIE   - SIOCIWFIRST] = {
 310                 .header_type    = IW_HEADER_TYPE_POINT,
 311                 .token_size     = 1,
 312                 .max_tokens     = IW_GENERIC_IE_MAX,
 313         },
 314         [SIOCSIWAUTH    - SIOCIWFIRST] = {
 315                 .header_type    = IW_HEADER_TYPE_PARAM,
 316         },
 317         [SIOCGIWAUTH    - SIOCIWFIRST] = {
 318                 .header_type    = IW_HEADER_TYPE_PARAM,
 319         },
 320         [SIOCSIWENCODEEXT - SIOCIWFIRST] = {
 321                 .header_type    = IW_HEADER_TYPE_POINT,
 322                 .token_size     = 1,
 323                 .min_tokens     = sizeof(struct iw_encode_ext),
 324                 .max_tokens     = sizeof(struct iw_encode_ext) +
 325                                   IW_ENCODING_TOKEN_MAX,
 326         },
 327         [SIOCGIWENCODEEXT - SIOCIWFIRST] = {
 328                 .header_type    = IW_HEADER_TYPE_POINT,
 329                 .token_size     = 1,
 330                 .min_tokens     = sizeof(struct iw_encode_ext),
 331                 .max_tokens     = sizeof(struct iw_encode_ext) +
 332                                   IW_ENCODING_TOKEN_MAX,
 333         },
 334         [SIOCSIWPMKSA - SIOCIWFIRST] = {
 335                 .header_type    = IW_HEADER_TYPE_POINT,
 336                 .token_size     = 1,
 337                 .min_tokens     = sizeof(struct iw_pmksa),
 338                 .max_tokens     = sizeof(struct iw_pmksa),
 339         },
 340 };
 341 static const unsigned standard_ioctl_num = ARRAY_SIZE(standard_ioctl);
 342
 343 /*
 344  * Meta-data about all the additional standard Wireless Extension events
 345  * we know about.
 346  */
 347 static const struct iw_ioctl_description standard_event[] = {
 348         [IWEVTXDROP     - IWEVFIRST] = {
 349                 .header_type    = IW_HEADER_TYPE_ADDR,
 350         },
 351         [IWEVQUAL       - IWEVFIRST] = {
 352                 .header_type    = IW_HEADER_TYPE_QUAL,
 353         },
 354         [IWEVCUSTOM     - IWEVFIRST] = {
 355                 .header_type    = IW_HEADER_TYPE_POINT,
 356                 .token_size     = 1,
 357                 .max_tokens     = IW_CUSTOM_MAX,
 358         },
 359         [IWEVREGISTERED - IWEVFIRST] = {
 360                 .header_type    = IW_HEADER_TYPE_ADDR,
 361         },
 362         [IWEVEXPIRED    - IWEVFIRST] = {
 363                 .header_type    = IW_HEADER_TYPE_ADDR,
 364         },
 365         [IWEVGENIE      - IWEVFIRST] = {
 366                 .header_type    = IW_HEADER_TYPE_POINT,
 367                 .token_size     = 1,
 368                 .max_tokens     = IW_GENERIC_IE_MAX,
 369         },
 370         [IWEVMICHAELMICFAILURE  - IWEVFIRST] = {
 371                 .header_type    = IW_HEADER_TYPE_POINT,
 372                 .token_size     = 1,
 373                 .max_tokens     = sizeof(struct iw_michaelmicfailure),
 374         },
 375         [IWEVASSOCREQIE - IWEVFIRST] = {
 376                 .header_type    = IW_HEADER_TYPE_POINT,
 377                 .token_size     = 1,
 378                 .max_tokens     = IW_GENERIC_IE_MAX,
 379         },
 380         [IWEVASSOCRESPIE        - IWEVFIRST] = {
 381                 .header_type    = IW_HEADER_TYPE_POINT,
 382                 .token_size     = 1,
 383                 .max_tokens     = IW_GENERIC_IE_MAX,
 384         },
 385         [IWEVPMKIDCAND  - IWEVFIRST] = {
 386                 .header_type    = IW_HEADER_TYPE_POINT,
 387                 .token_size     = 1,
 388                 .max_tokens     = sizeof(struct iw_pmkid_cand),
 389         },
 390 };
 391 static const unsigned standard_event_num = ARRAY_SIZE(standard_event);
 392
 393 /* Size (in bytes) of the various private data types */
 394 static const char iw_priv_type_size[] = {
 395         0,                              /* IW_PRIV_TYPE_NONE */
 396         1,                              /* IW_PRIV_TYPE_BYTE */
 397         1,                              /* IW_PRIV_TYPE_CHAR */
 398         0,                              /* Not defined */
 399         sizeof(__u32),                  /* IW_PRIV_TYPE_INT */
 400         sizeof(struct iw_freq),         /* IW_PRIV_TYPE_FLOAT */
 401         sizeof(struct sockaddr),        /* IW_PRIV_TYPE_ADDR */
 402         0,                              /* Not defined */
 403 };
 404
 405 /* Size (in bytes) of various events */
 406 static const int event_type_size[] = {
 407         IW_EV_LCP_LEN,                  /* IW_HEADER_TYPE_NULL */
 408         0,
 409         IW_EV_CHAR_LEN,                 /* IW_HEADER_TYPE_CHAR */
 410         0,
 411         IW_EV_UINT_LEN,                 /* IW_HEADER_TYPE_UINT */
 412         IW_EV_FREQ_LEN,                 /* IW_HEADER_TYPE_FREQ */
 413         IW_EV_ADDR_LEN,                 /* IW_HEADER_TYPE_ADDR */
 414         0,
 415         IW_EV_POINT_LEN,                /* Without variable payload */
 416         IW_EV_PARAM_LEN,                /* IW_HEADER_TYPE_PARAM */
 417         IW_EV_QUAL_LEN,                 /* IW_HEADER_TYPE_QUAL */
 418 };
 419
 420 /* Size (in bytes) of various events, as packed */
 421 static const int event_type_pk_size[] = {
 422         IW_EV_LCP_PK_LEN,               /* IW_HEADER_TYPE_NULL */
 423         0,
 424         IW_EV_CHAR_PK_LEN,              /* IW_HEADER_TYPE_CHAR */
 425         0,
 426         IW_EV_UINT_PK_LEN,              /* IW_HEADER_TYPE_UINT */
 427         IW_EV_FREQ_PK_LEN,              /* IW_HEADER_TYPE_FREQ */
 428         IW_EV_ADDR_PK_LEN,              /* IW_HEADER_TYPE_ADDR */
 429         0,
 430         IW_EV_POINT_PK_LEN,             /* Without variable payload */
 431         IW_EV_PARAM_PK_LEN,             /* IW_HEADER_TYPE_PARAM */
 432         IW_EV_QUAL_PK_LEN,              /* IW_HEADER_TYPE_QUAL */
 433 };
 434
 435 /************************ COMMON SUBROUTINES ************************/
 436 /*
 437  * Stuff that may be used in various place or doesn't fit in one
 438  * of the section below.
 439  */
 440
 441 /* ---------------------------------------------------------------- */
 442 /*
 443  * Return the driver handler associated with a specific Wireless Extension.
 444  */
 445 static iw_handler get_handler(struct net_device *dev, unsigned int cmd)
 446 {
 447         /* Don't "optimise" the following variable, it will crash */
 448         unsigned int    index;          /* *MUST* be unsigned */
 449
 450         /* Check if we have some wireless handlers defined */
 451         if (dev->wireless_handlers == NULL)
 452                 return NULL;
 453
 454         /* Try as a standard command */
 455         index = cmd - SIOCIWFIRST;
 456         if (index < dev->wireless_handlers->num_standard)
 457                 return dev->wireless_handlers->standard[index];
 458
 459         /* Try as a private command */
 460         index = cmd - SIOCIWFIRSTPRIV;
 461         if (index < dev->wireless_handlers->num_private)
 462                 return dev->wireless_handlers->private[index];
 463
 464         /* Not found */
 465         return NULL;
 466 }
 467
 468 /* ---------------------------------------------------------------- */
 469 /*
 470  * Get statistics out of the driver
 471  */
 472 static struct iw_statistics *get_wireless_stats(struct net_device *dev)
 473 {
 474         /* New location */
 475         if ((dev->wireless_handlers != NULL) &&
 476            (dev->wireless_handlers->get_wireless_stats != NULL))
 477                 return dev->wireless_handlers->get_wireless_stats(dev);
 478
 479         /* Not found */
 480         return NULL;
 481 }
 482
 483 /* ---------------------------------------------------------------- */
 484 /*
 485  * Call the commit handler in the driver
 486  * (if exist and if conditions are right)
 487  *
 488  * Note : our current commit strategy is currently pretty dumb,
 489  * but we will be able to improve on that...
 490  * The goal is to try to agreagate as many changes as possible
 491  * before doing the commit. Drivers that will define a commit handler
 492  * are usually those that need a reset after changing parameters, so
 493  * we want to minimise the number of reset.
 494  * A cool idea is to use a timer : at each "set" command, we re-set the
 495  * timer, when the timer eventually fires, we call the driver.
 496  * Hopefully, more on that later.
 497  *
 498  * Also, I'm waiting to see how many people will complain about the
 499  * netif_running(dev) test. I'm open on that one...
 500  * Hopefully, the driver will remember to do a commit in "open()" ;-)
 501  */
 502 static int call_commit_handler(struct net_device *dev)
 503 {
 504         if ((netif_running(dev)) &&
 505            (dev->wireless_handlers->standard[0] != NULL))
 506                 /* Call the commit handler on the driver */
 507                 return dev->wireless_handlers->standard[0](dev, NULL,
 508                                                            NULL, NULL);
 509         else
 510                 return 0;               /* Command completed successfully */
 511 }
 512
 513 /* ---------------------------------------------------------------- */
 514 /*
 515  * Calculate size of private arguments
 516  */
 517 static inline int get_priv_size(__u16   args)
 518 {
 519         int     num = args & IW_PRIV_SIZE_MASK;
 520         int     type = (args & IW_PRIV_TYPE_MASK) >> 12;
 521
 522         return num * iw_priv_type_size[type];
 523 }
 524
 525 /* ---------------------------------------------------------------- */
 526 /*
 527  * Re-calculate the size of private arguments
 528  */
 529 static inline int adjust_priv_size(__u16                args,
 530                                    union iwreq_data *   wrqu)
 531 {
 532         int     num = wrqu->data.length;
 533         int     max = args & IW_PRIV_SIZE_MASK;
 534         int     type = (args & IW_PRIV_TYPE_MASK) >> 12;
 535
 536         /* Make sure the driver doesn't goof up */
 537         if (max < num)
 538                 num = max;
 539
 540         return num * iw_priv_type_size[type];
 541 }
 542
 543 /* ---------------------------------------------------------------- */
 544 /*
 545  * Standard Wireless Handler : get wireless stats
 546  *      Allow programatic access to /proc/net/wireless even if /proc
 547  *      doesn't exist... Also more efficient...
 548  */
 549 static int iw_handler_get_iwstats(struct net_device *           dev,
 550                                   struct iw_request_info *      info,
 551                                   union iwreq_data *            wrqu,
 552                                   char *                        extra)
 553 {
 554         /* Get stats from the driver */
 555         struct iw_statistics *stats;
 556
 557         stats = get_wireless_stats(dev);
 558         if (stats) {
 559                 /* Copy statistics to extra */
 560                 memcpy(extra, stats, sizeof(struct iw_statistics));
 561                 wrqu->data.length = sizeof(struct iw_statistics);
 562
 563                 /* Check if we need to clear the updated flag */
 564                 if (wrqu->data.flags != 0)
 565                         stats->qual.updated &= ~IW_QUAL_ALL_UPDATED;
 566                 return 0;
 567         } else
 568                 return -EOPNOTSUPP;
 569 }
 570
 571 /* ---------------------------------------------------------------- */
 572 /*
 573  * Standard Wireless Handler : get iwpriv definitions
 574  * Export the driver private handler definition
 575  * They will be picked up by tools like iwpriv...
 576  */
 577 static int iw_handler_get_private(struct net_device *           dev,
 578                                   struct iw_request_info *      info,
 579                                   union iwreq_data *            wrqu,
 580                                   char *                        extra)
 581 {
 582         /* Check if the driver has something to export */
 583         if ((dev->wireless_handlers->num_private_args == 0) ||
 584            (dev->wireless_handlers->private_args == NULL))
 585                 return -EOPNOTSUPP;
 586
 587         /* Check if there is enough buffer up there */
 588         if (wrqu->data.length < dev->wireless_handlers->num_private_args) {
 589                 /* User space can't know in advance how large the buffer
 590                  * needs to be. Give it a hint, so that we can support
 591                  * any size buffer we want somewhat efficiently... */
 592                 wrqu->data.length = dev->wireless_handlers->num_private_args;
 593                 return -E2BIG;
 594         }
 595
 596         /* Set the number of available ioctls. */
 597         wrqu->data.length = dev->wireless_handlers->num_private_args;
 598
 599         /* Copy structure to the user buffer. */
 600         memcpy(extra, dev->wireless_handlers->private_args,
 601                sizeof(struct iw_priv_args) * wrqu->data.length);
 602
 603         return 0;
 604 }
 605
 606
 607 /******************** /proc/net/wireless SUPPORT ********************/
 608 /*
 609  * The /proc/net/wireless file is a human readable user-space interface
 610  * exporting various wireless specific statistics from the wireless devices.
 611  * This is the most popular part of the Wireless Extensions ;-)
 612  *
 613  * This interface is a pure clone of /proc/net/dev (in net/core/dev.c).
 614  * The content of the file is basically the content of "struct iw_statistics".
 615  */
 616
 617 #ifdef CONFIG_PROC_FS
 618
 619 /* ---------------------------------------------------------------- */
 620 /*
 621  * Print one entry (line) of /proc/net/wireless
 622  */
 623 static void wireless_seq_printf_stats(struct seq_file *seq,
 624                                       struct net_device *dev)
 625 {
 626         /* Get stats from the driver */
 627         struct iw_statistics *stats = get_wireless_stats(dev);
 628
 629         if (stats) {
 630                 seq_printf(seq, "%6s: %04x  %3d%c  %3d%c  %3d%c  %6d %6d %6d "
 631                                 "%6d %6d   %6d\n",
 632                            dev->name, stats->status, stats->qual.qual,
 633                            stats->qual.updated & IW_QUAL_QUAL_UPDATED
 634                            ? '.' : ' ',
 635                            ((__s32) stats->qual.level) -
 636                            ((stats->qual.updated & IW_QUAL_DBM) ? 0x100 : 0),
 637                            stats->qual.updated & IW_QUAL_LEVEL_UPDATED
 638                            ? '.' : ' ',
 639                            ((__s32) stats->qual.noise) -
 640                            ((stats->qual.updated & IW_QUAL_DBM) ? 0x100 : 0),
 641                            stats->qual.updated & IW_QUAL_NOISE_UPDATED
 642                            ? '.' : ' ',
 643                            stats->discard.nwid, stats->discard.code,
 644                            stats->discard.fragment, stats->discard.retries,
 645                            stats->discard.misc, stats->miss.beacon);
 646                 stats->qual.updated &= ~IW_QUAL_ALL_UPDATED;
 647         }
 648 }
 649
 650 /* ---------------------------------------------------------------- */
 651 /*
 652  * Print info for /proc/net/wireless (print all entries)
 653  */
 654 static int wireless_seq_show(struct seq_file *seq, void *v)
 655 {
 656         if (v == SEQ_START_TOKEN)
 657                 seq_printf(seq, "Inter-| sta-|   Quality        |   Discarded "
 658                                 "packets               | Missed | WE\n"
 659                                 " face | tus | link level noise |  nwid  "
 660                                 "crypt   frag  retry   misc | beacon | %d\n",
 661                            WIRELESS_EXT);
 662         else
 663                 wireless_seq_printf_stats(seq, v);
 664         return 0;
 665 }
 666
 667 static const struct seq_operations wireless_seq_ops = {
 668         .start = dev_seq_start,
 669         .next  = dev_seq_next,
 670         .stop  = dev_seq_stop,
 671         .show  = wireless_seq_show,
 672 };
 673
 674 static int wireless_seq_open(struct inode *inode, struct file *file)
 675 {
 676         struct seq_file *seq;
 677         int res;
 678         res = seq_open(file, &wireless_seq_ops);
 679         if (!res) {
 680                 seq = file->private_data;
 681                 seq->private = get_proc_net(inode);
 682                 if (!seq->private) {
 683                         seq_release(inode, file);
 684                         res = -ENXIO;
 685                 }
 686         }
 687         return res;
 688 }
 689
 690 static int wireless_seq_release(struct inode *inode, struct file *file)
 691 {
 692         struct seq_file *seq = file->private_data;
 693         struct net *net = seq->private;
 694         put_net(net);
 695         return seq_release(inode, file);
 696 }
 697
 698 static const struct file_operations wireless_seq_fops = {
 699         .owner   = THIS_MODULE,
 700         .open    = wireless_seq_open,
 701         .read    = seq_read,
 702         .llseek  = seq_lseek,
 703         .release = wireless_seq_release,
 704 };
 705
 706 int wext_proc_init(struct net *net)
 707 {
 708         /* Create /proc/net/wireless entry */
 709         if (!proc_net_fops_create(net, "wireless", S_IRUGO, &wireless_seq_fops))
 710                 return -ENOMEM;
 711
 712         return 0;
 713 }
 714
 715 void wext_proc_exit(struct net *net)
 716 {
 717         proc_net_remove(net, "wireless");
 718 }
 719 #endif  /* CONFIG_PROC_FS */
 720
 721 /************************** IOCTL SUPPORT **************************/
 722 /*
 723  * The original user space API to configure all those Wireless Extensions
 724  * is through IOCTLs.
 725  * In there, we check if we need to call the new driver API (iw_handler)
 726  * or just call the driver ioctl handler.
 727  */
 728
 729 /* ---------------------------------------------------------------- */
 730 /*
 731  * Wrapper to call a standard Wireless Extension handler.
 732  * We do various checks and also take care of moving data between
 733  * user space and kernel space.
 734  */
 735 static int ioctl_standard_call(struct net_device *      dev,
 736                                struct ifreq *           ifr,
 737                                unsigned int             cmd,
 738                                iw_handler               handler)
 739 {
 740         struct iwreq *                          iwr = (struct iwreq *) ifr;
 741         const struct iw_ioctl_description *     descr;
 742         struct iw_request_info                  info;
 743         int                                     ret = -EINVAL;
 744
 745         /* Get the description of the IOCTL */
 746         if ((cmd - SIOCIWFIRST) >= standard_ioctl_num)
 747                 return -EOPNOTSUPP;
 748         descr = &(standard_ioctl[cmd - SIOCIWFIRST]);
 749
 750         /* Prepare the call */
 751         info.cmd = cmd;
 752         info.flags = 0;
 753
 754         /* Check if we have a pointer to user space data or not */
 755         if (descr->header_type != IW_HEADER_TYPE_POINT) {
 756
 757                 /* No extra arguments. Trivial to handle */
 758                 ret = handler(dev, &info, &(iwr->u), NULL);
 759
 760                 /* Generate an event to notify listeners of the change */
 761                 if ((descr->flags & IW_DESCR_FLAG_EVENT) &&
 762                    ((ret == 0) || (ret == -EIWCOMMIT)))
 763                         wireless_send_event(dev, cmd, &(iwr->u), NULL);
 764         } else {
 765                 char *  extra;
 766                 int     extra_size;
 767                 int     user_length = 0;
 768                 int     err;
 769                 int     essid_compat = 0;
 770
 771                 /* Calculate space needed by arguments. Always allocate
 772                  * for max space. Easier, and won't last long... */
 773                 extra_size = descr->max_tokens * descr->token_size;
 774
 775                 /* Check need for ESSID compatibility for WE < 21 */
 776                 switch (cmd) {
 777                 case SIOCSIWESSID:
 778                 case SIOCGIWESSID:
 779                 case SIOCSIWNICKN:
 780                 case SIOCGIWNICKN:
 781                         if (iwr->u.data.length == descr->max_tokens + 1)
 782                                 essid_compat = 1;
 783                         else if (IW_IS_SET(cmd) && (iwr->u.data.length != 0)) {
 784                                 char essid[IW_ESSID_MAX_SIZE + 1];
 785
 786                                 err = copy_from_user(essid, iwr->u.data.pointer,
 787                                                      iwr->u.data.length *
 788                                                      descr->token_size);
 789                                 if (err)
 790                                         return -EFAULT;
 791
 792                                 if (essid[iwr->u.data.length - 1] == '\0')
 793                                         essid_compat = 1;
 794                         }
 795                         break;
 796                 default:
 797                         break;
 798                 }
 799
 800                 iwr->u.data.length -= essid_compat;
 801
 802                 /* Check what user space is giving us */
 803                 if (IW_IS_SET(cmd)) {
 804                         /* Check NULL pointer */
 805                         if ((iwr->u.data.pointer == NULL) &&
 806                            (iwr->u.data.length != 0))
 807                                 return -EFAULT;
 808                         /* Check if number of token fits within bounds */
 809                         if (iwr->u.data.length > descr->max_tokens)
 810                                 return -E2BIG;
 811                         if (iwr->u.data.length < descr->min_tokens)
 812                                 return -EINVAL;
 813                 } else {
 814                         /* Check NULL pointer */
 815                         if (iwr->u.data.pointer == NULL)
 816                                 return -EFAULT;
 817                         /* Save user space buffer size for checking */
 818                         user_length = iwr->u.data.length;
 819
 820                         /* Don't check if user_length > max to allow forward
 821                          * compatibility. The test user_length < min is
 822                          * implied by the test at the end. */
 823
 824                         /* Support for very large requests */
 825                         if ((descr->flags & IW_DESCR_FLAG_NOMAX) &&
 826                            (user_length > descr->max_tokens)) {
 827                                 /* Allow userspace to GET more than max so
 828                                  * we can support any size GET requests.
 829                                  * There is still a limit : -ENOMEM. */
 830                                 extra_size = user_length * descr->token_size;
 831                                 /* Note : user_length is originally a __u16,
 832                                  * and token_size is controlled by us,
 833                                  * so extra_size won't get negative and
 834                                  * won't overflow... */
 835                         }
 836                 }
 837
 838                 /* Create the kernel buffer */
 839                 /*    kzalloc ensures NULL-termination for essid_compat */
 840                 extra = kzalloc(extra_size, GFP_KERNEL);
 841                 if (extra == NULL)
 842                         return -ENOMEM;
 843
 844                 /* If it is a SET, get all the extra data in here */
 845                 if (IW_IS_SET(cmd) && (iwr->u.data.length != 0)) {
 846                         err = copy_from_user(extra, iwr->u.data.pointer,
 847                                              iwr->u.data.length *
 848                                              descr->token_size);
 849                         if (err) {
 850                                 kfree(extra);
 851                                 return -EFAULT;
 852                         }
 853                 }
 854
 855                 /* Call the handler */
 856                 ret = handler(dev, &info, &(iwr->u), extra);
 857
 858                 iwr->u.data.length += essid_compat;
 859
 860                 /* If we have something to return to the user */
 861                 if (!ret && IW_IS_GET(cmd)) {
 862                         /* Check if there is enough buffer up there */
 863                         if (user_length < iwr->u.data.length) {
 864                                 kfree(extra);
 865                                 return -E2BIG;
 866                         }
 867
 868                         err = copy_to_user(iwr->u.data.pointer, extra,
 869                                            iwr->u.data.length *
 870                                            descr->token_size);
 871                         if (err)
 872                                 ret =  -EFAULT;
 873                 }
 874
 875                 /* Generate an event to notify listeners of the change */
 876                 if ((descr->flags & IW_DESCR_FLAG_EVENT) &&
 877                    ((ret == 0) || (ret == -EIWCOMMIT))) {
 878                         if (descr->flags & IW_DESCR_FLAG_RESTRICT)
 879                                 /* If the event is restricted, don't
 880                                  * export the payload */
 881                                 wireless_send_event(dev, cmd, &(iwr->u), NULL);
 882                         else
 883                                 wireless_send_event(dev, cmd, &(iwr->u),
 884                                                     extra);
 885                 }
 886
 887                 /* Cleanup - I told you it wasn't that long ;-) */
 888                 kfree(extra);
 889         }
 890
 891         /* Call commit handler if needed and defined */
 892         if (ret == -EIWCOMMIT)
 893                 ret = call_commit_handler(dev);
 894
 895         /* Here, we will generate the appropriate event if needed */
 896
 897         return ret;
 898 }
 899
 900 /* ---------------------------------------------------------------- */
 901 /*
 902  * Wrapper to call a private Wireless Extension handler.
 903  * We do various checks and also take care of moving data between
 904  * user space and kernel space.
 905  * It's not as nice and slimline as the standard wrapper. The cause
 906  * is struct iw_priv_args, which was not really designed for the
 907  * job we are going here.
 908  *
 909  * IMPORTANT : This function prevent to set and get data on the same
 910  * IOCTL and enforce the SET/GET convention. Not doing it would be
 911  * far too hairy...
 912  * If you need to set and get data at the same time, please don't use
 913  * a iw_handler but process it in your ioctl handler (i.e. use the
 914  * old driver API).
 915  */
 916 static int ioctl_private_call(struct net_device *dev, struct ifreq *ifr,
 917                               unsigned int cmd, iw_handler handler)
 918 {
 919         struct iwreq *                  iwr = (struct iwreq *) ifr;
 920         const struct iw_priv_args *     descr = NULL;
 921         struct iw_request_info          info;
 922         int                             extra_size = 0;
 923         int                             i;
 924         int                             ret = -EINVAL;
 925
 926         /* Get the description of the IOCTL */
 927         for (i = 0; i < dev->wireless_handlers->num_private_args; i++)
 928                 if (cmd == dev->wireless_handlers->private_args[i].cmd) {
 929                         descr = &(dev->wireless_handlers->private_args[i]);
 930                         break;
 931                 }
 932
 933         /* Compute the size of the set/get arguments */
 934         if (descr != NULL) {
 935                 if (IW_IS_SET(cmd)) {
 936                         int     offset = 0;     /* For sub-ioctls */
 937                         /* Check for sub-ioctl handler */
 938                         if (descr->name[0] == '\0')
 939                                 /* Reserve one int for sub-ioctl index */
 940                                 offset = sizeof(__u32);
 941
 942                         /* Size of set arguments */
 943                         extra_size = get_priv_size(descr->set_args);
 944
 945                         /* Does it fits in iwr ? */
 946                         if ((descr->set_args & IW_PRIV_SIZE_FIXED) &&
 947                            ((extra_size + offset) <= IFNAMSIZ))
 948                                 extra_size = 0;
 949                 } else {
 950                         /* Size of get arguments */
 951                         extra_size = get_priv_size(descr->get_args);
 952
 953                         /* Does it fits in iwr ? */
 954                         if ((descr->get_args & IW_PRIV_SIZE_FIXED) &&
 955                            (extra_size <= IFNAMSIZ))
 956                                 extra_size = 0;
 957                 }
 958         }
 959
 960         /* Prepare the call */
 961         info.cmd = cmd;
 962         info.flags = 0;
 963
 964         /* Check if we have a pointer to user space data or not. */
 965         if (extra_size == 0) {
 966                 /* No extra arguments. Trivial to handle */
 967                 ret = handler(dev, &info, &(iwr->u), (char *) &(iwr->u));
 968         } else {
 969                 char *  extra;
 970                 int     err;
 971
 972                 /* Check what user space is giving us */
 973                 if (IW_IS_SET(cmd)) {
 974                         /* Check NULL pointer */
 975                         if ((iwr->u.data.pointer == NULL) &&
 976                            (iwr->u.data.length != 0))
 977                                 return -EFAULT;
 978
 979                         /* Does it fits within bounds ? */
 980                         if (iwr->u.data.length > (descr->set_args &
 981                                                  IW_PRIV_SIZE_MASK))
 982                                 return -E2BIG;
 983                 } else if (iwr->u.data.pointer == NULL)
 984                         return -EFAULT;
 985
 986                 /* Always allocate for max space. Easier, and won't last
 987                  * long... */
 988                 extra = kmalloc(extra_size, GFP_KERNEL);
 989                 if (extra == NULL)
 990                         return -ENOMEM;
 991
 992                 /* If it is a SET, get all the extra data in here */
 993                 if (IW_IS_SET(cmd) && (iwr->u.data.length != 0)) {
 994                         err = copy_from_user(extra, iwr->u.data.pointer,
 995                                              extra_size);
 996                         if (err) {
 997                                 kfree(extra);
 998                                 return -EFAULT;
 999                         }
1000                 }
1001
1002                 /* Call the handler */
1003                 ret = handler(dev, &info, &(iwr->u), extra);
1004
1005                 /* If we have something to return to the user */
1006                 if (!ret && IW_IS_GET(cmd)) {
1007
1008                         /* Adjust for the actual length if it's variable,
1009                          * avoid leaking kernel bits outside. */
1010                         if (!(descr->get_args & IW_PRIV_SIZE_FIXED)) {
1011                                 extra_size = adjust_priv_size(descr->get_args,
1012                                                               &(iwr->u));
1013                         }
1014
1015                         err = copy_to_user(iwr->u.data.pointer, extra,
1016                                            extra_size);
1017                         if (err)
1018                                 ret =  -EFAULT;
1019                 }
1020
1021                 /* Cleanup - I told you it wasn't that long ;-) */
1022                 kfree(extra);
1023         }
1024
1025
1026         /* Call commit handler if needed and defined */
1027         if (ret == -EIWCOMMIT)
1028                 ret = call_commit_handler(dev);
1029
1030         return ret;
1031 }
1032
1033 /* ---------------------------------------------------------------- */
1034 /*
1035  * Main IOCTl dispatcher.
1036  * Check the type of IOCTL and call the appropriate wrapper...
1037  */
1038 static int wireless_process_ioctl(struct net *net, struct ifreq *ifr, unsigned int cmd)
1039 {
1040         struct net_device *dev;
1041         iw_handler      handler;
1042
1043         /* Permissions are already checked in dev_ioctl() before calling us.
1044          * The copy_to/from_user() of ifr is also dealt with in there */
1045
1046         /* Make sure the device exist */
1047         if ((dev = __dev_get_by_name(net, ifr->ifr_name)) == NULL)
1048                 return -ENODEV;
1049
1050         /* A bunch of special cases, then the generic case...
1051          * Note that 'cmd' is already filtered in dev_ioctl() with
1052          * (cmd >= SIOCIWFIRST && cmd <= SIOCIWLAST) */
1053         if (cmd == SIOCGIWSTATS)
1054                 return ioctl_standard_call(dev, ifr, cmd,
1055                                            &iw_handler_get_iwstats);
1056
1057         if (cmd == SIOCGIWPRIV && dev->wireless_handlers)
1058                 return ioctl_standard_call(dev, ifr, cmd,
1059                                            &iw_handler_get_private);
1060
1061         /* Basic check */
1062         if (!netif_device_present(dev))
1063                 return -ENODEV;
1064
1065         /* New driver API : try to find the handler */
1066         handler = get_handler(dev, cmd);
1067         if (handler) {
1068                 /* Standard and private are not the same */
1069                 if (cmd < SIOCIWFIRSTPRIV)
1070                         return ioctl_standard_call(dev, ifr, cmd, handler);
1071                 else
1072                         return ioctl_private_call(dev, ifr, cmd, handler);
1073         }
1074         /* Old driver API : call driver ioctl handler */
1075         if (dev->do_ioctl)
1076                 return dev->do_ioctl(dev, ifr, cmd);
1077         return -EOPNOTSUPP;
1078 }
1079
1080 /* entry point from dev ioctl */
1081 int wext_handle_ioctl(struct net *net, struct ifreq *ifr, unsigned int cmd,
1082                       void __user *arg)
1083 {
1084         int ret;
1085
1086         /* If command is `set a parameter', or
1087          * `get the encoding parameters', check if
1088          * the user has the right to do it */
1089         if ((IW_IS_SET(cmd) || cmd == SIOCGIWENCODE || cmd == SIOCGIWENCODEEXT)
1090             && !capable(CAP_NET_ADMIN))
1091                 return -EPERM;
1092
1093         dev_load(net, ifr->ifr_name);
1094         rtnl_lock();
1095         ret = wireless_process_ioctl(net, ifr, cmd);
1096         rtnl_unlock();
1097         if (IW_IS_GET(cmd) && copy_to_user(arg, ifr, sizeof(struct ifreq)))
1098                 return -EFAULT;
1099         return ret;
1100 }
1101
1102 /************************* EVENT PROCESSING *************************/
1103 /*
1104  * Process events generated by the wireless layer or the driver.
1105  * Most often, the event will be propagated through rtnetlink
1106  */
1107
1108 /* ---------------------------------------------------------------- */
1109 /*
1110  * Locking...
1111  * ----------
1112  *
1113  * Thanks to Herbert Xu <herbert@gondor.apana.org.au> for fixing
1114  * the locking issue in here and implementing this code !
1115  *
1116  * The issue : wireless_send_event() is often called in interrupt context,
1117  * while the Netlink layer can never be called in interrupt context.
1118  * The fully formed RtNetlink events are queued, and then a tasklet is run
1119  * to feed those to Netlink.
1120  * The skb_queue is interrupt safe, and its lock is not held while calling
1121  * Netlink, so there is no possibility of dealock.
1122  * Jean II
1123  */
1124
1125 static struct sk_buff_head wireless_nlevent_queue;
1126
1127 static int __init wireless_nlevent_init(void)
1128 {
1129         skb_queue_head_init(&wireless_nlevent_queue);
1130         return 0;
1131 }
1132
1133 subsys_initcall(wireless_nlevent_init);
1134
1135 static void wireless_nlevent_process(unsigned long data)
1136 {
1137         struct sk_buff *skb;
1138
1139         while ((skb = skb_dequeue(&wireless_nlevent_queue)))
1140                 rtnl_notify(skb, 0, RTNLGRP_LINK, NULL, GFP_ATOMIC);
1141 }
1142
1143 static DECLARE_TASKLET(wireless_nlevent_tasklet, wireless_nlevent_process, 0);
1144
1145 /* ---------------------------------------------------------------- */
1146 /*
1147  * Fill a rtnetlink message with our event data.
1148  * Note that we propage only the specified event and don't dump the
1149  * current wireless config. Dumping the wireless config is far too
1150  * expensive (for each parameter, the driver need to query the hardware).
1151  */
1152 static int rtnetlink_fill_iwinfo(struct sk_buff *skb, struct net_device *dev,
1153                                  int type, char *event, int event_len)
1154 {
1155         struct ifinfomsg *r;
1156         struct nlmsghdr  *nlh;
1157
1158         nlh = nlmsg_put(skb, 0, 0, type, sizeof(*r), 0);
1159         if (nlh == NULL)
1160                 return -EMSGSIZE;
1161
1162         r = nlmsg_data(nlh);
1163         r->ifi_family = AF_UNSPEC;
1164         r->__ifi_pad = 0;
1165         r->ifi_type = dev->type;
1166         r->ifi_index = dev->ifindex;
1167         r->ifi_flags = dev_get_flags(dev);
1168         r->ifi_change = 0;      /* Wireless changes don't affect those flags */
1169
1170         /* Add the wireless events in the netlink packet */
1171         NLA_PUT(skb, IFLA_WIRELESS, event_len, event);
1172
1173         return nlmsg_end(skb, nlh);
1174
1175 nla_put_failure:
1176         nlmsg_cancel(skb, nlh);
1177         return -EMSGSIZE;
1178 }
1179
1180 /* ---------------------------------------------------------------- */
1181 /*
1182  * Create and broadcast and send it on the standard rtnetlink socket
1183  * This is a pure clone rtmsg_ifinfo() in net/core/rtnetlink.c
1184  * Andrzej Krzysztofowicz mandated that I used a IFLA_XXX field
1185  * within a RTM_NEWLINK event.
1186  */
1187 static void rtmsg_iwinfo(struct net_device *dev, char *event, int event_len)
1188 {
1189         struct sk_buff *skb;
1190         int err;
1191
1192         skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_ATOMIC);
1193         if (!skb)
1194                 return;
1195
1196         err = rtnetlink_fill_iwinfo(skb, dev, RTM_NEWLINK, event, event_len);
1197         if (err < 0) {
1198                 WARN_ON(err == -EMSGSIZE);
1199                 kfree_skb(skb);
1200                 return;
1201         }
1202
1203         NETLINK_CB(skb).dst_group = RTNLGRP_LINK;
1204         skb_queue_tail(&wireless_nlevent_queue, skb);
1205         tasklet_schedule(&wireless_nlevent_tasklet);
1206 }
1207
1208 /* ---------------------------------------------------------------- */
1209 /*
1210  * Main event dispatcher. Called from other parts and drivers.
1211  * Send the event on the appropriate channels.
1212  * May be called from interrupt context.
1213  */
1214 void wireless_send_event(struct net_device *    dev,
1215                          unsigned int           cmd,
1216                          union iwreq_data *     wrqu,
1217                          char *                 extra)
1218 {
1219         const struct iw_ioctl_description *     descr = NULL;
1220         int extra_len = 0;
1221         struct iw_event  *event;                /* Mallocated whole event */
1222         int event_len;                          /* Its size */
1223         int hdr_len;                            /* Size of the event header */
1224         int wrqu_off = 0;                       /* Offset in wrqu */
1225         /* Don't "optimise" the following variable, it will crash */
1226         unsigned        cmd_index;              /* *MUST* be unsigned */
1227
1228         /* Get the description of the Event */
1229         if (cmd <= SIOCIWLAST) {
1230                 cmd_index = cmd - SIOCIWFIRST;
1231                 if (cmd_index < standard_ioctl_num)
1232                         descr = &(standard_ioctl[cmd_index]);
1233         } else {
1234                 cmd_index = cmd - IWEVFIRST;
1235                 if (cmd_index < standard_event_num)
1236                         descr = &(standard_event[cmd_index]);
1237         }
1238         /* Don't accept unknown events */
1239         if (descr == NULL) {
1240                 /* Note : we don't return an error to the driver, because
1241                  * the driver would not know what to do about it. It can't
1242                  * return an error to the user, because the event is not
1243                  * initiated by a user request.
1244                  * The best the driver could do is to log an error message.
1245                  * We will do it ourselves instead...
1246                  */
1247                 printk(KERN_ERR "%s (WE) : Invalid/Unknown Wireless Event (0x%04X)\n",
1248                        dev->name, cmd);
1249                 return;
1250         }
1251
1252         /* Check extra parameters and set extra_len */
1253         if (descr->header_type == IW_HEADER_TYPE_POINT) {
1254                 /* Check if number of token fits within bounds */
1255                 if (wrqu->data.length > descr->max_tokens) {
1256                         printk(KERN_ERR "%s (WE) : Wireless Event too big (%d)\n", dev->name, wrqu->data.length);
1257                         return;
1258                 }
1259                 if (wrqu->data.length < descr->min_tokens) {
1260                         printk(KERN_ERR "%s (WE) : Wireless Event too small (%d)\n", dev->name, wrqu->data.length);
1261                         return;
1262                 }
1263                 /* Calculate extra_len - extra is NULL for restricted events */
1264                 if (extra != NULL)
1265                         extra_len = wrqu->data.length * descr->token_size;
1266                 /* Always at an offset in wrqu */
1267                 wrqu_off = IW_EV_POINT_OFF;
1268         }
1269
1270         /* Total length of the event */
1271         hdr_len = event_type_size[descr->header_type];
1272         event_len = hdr_len + extra_len;
1273
1274         /* Create temporary buffer to hold the event */
1275         event = kmalloc(event_len, GFP_ATOMIC);
1276         if (event == NULL)
1277                 return;
1278
1279         /* Fill event */
1280         event->len = event_len;
1281         event->cmd = cmd;
1282         memcpy(&event->u, ((char *) wrqu) + wrqu_off, hdr_len - IW_EV_LCP_LEN);
1283         if (extra)
1284                 memcpy(((char *) event) + hdr_len, extra, extra_len);
1285
1286         /* Send via the RtNetlink event channel */
1287         rtmsg_iwinfo(dev, (char *) event, event_len);
1288
1289         /* Cleanup */
1290         kfree(event);
1291
1292         return;         /* Always success, I guess ;-) */
1293 }
1294 EXPORT_SYMBOL(wireless_send_event);
1295
1296 /********************** ENHANCED IWSPY SUPPORT **********************/
1297 /*
1298  * In the old days, the driver was handling spy support all by itself.
1299  * Now, the driver can delegate this task to Wireless Extensions.
1300  * It needs to use those standard spy iw_handler in struct iw_handler_def,
1301  * push data to us via wireless_spy_update() and include struct iw_spy_data
1302  * in its private part (and export it in net_device->wireless_data->spy_data).
1303  * One of the main advantage of centralising spy support here is that
1304  * it becomes much easier to improve and extend it without having to touch
1305  * the drivers. One example is the addition of the Spy-Threshold events.
1306  */
1307
1308 /* ---------------------------------------------------------------- */
1309 /*
1310  * Return the pointer to the spy data in the driver.
1311  * Because this is called on the Rx path via wireless_spy_update(),
1312  * we want it to be efficient...
1313  */
1314 static inline struct iw_spy_data *get_spydata(struct net_device *dev)
1315 {
1316         /* This is the new way */
1317         if (dev->wireless_data)
1318                 return dev->wireless_data->spy_data;
1319         return NULL;
1320 }
1321
1322 /*------------------------------------------------------------------*/
1323 /*
1324  * Standard Wireless Handler : set Spy List
1325  */
1326 int iw_handler_set_spy(struct net_device *      dev,
1327                        struct iw_request_info * info,
1328                        union iwreq_data *       wrqu,
1329                        char *                   extra)
1330 {
1331         struct iw_spy_data *    spydata = get_spydata(dev);
1332         struct sockaddr *       address = (struct sockaddr *) extra;
1333
1334         /* Make sure driver is not buggy or using the old API */
1335         if (!spydata)
1336                 return -EOPNOTSUPP;
1337
1338         /* Disable spy collection while we copy the addresses.
1339          * While we copy addresses, any call to wireless_spy_update()
1340          * will NOP. This is OK, as anyway the addresses are changing. */
1341         spydata->spy_number = 0;
1342
1343         /* We want to operate without locking, because wireless_spy_update()
1344          * most likely will happen in the interrupt handler, and therefore
1345          * have its own locking constraints and needs performance.
1346          * The rtnl_lock() make sure we don't race with the other iw_handlers.
1347          * This make sure wireless_spy_update() "see" that the spy list
1348          * is temporarily disabled. */
1349         smp_wmb();
1350
1351         /* Are there are addresses to copy? */
1352         if (wrqu->data.length > 0) {
1353                 int i;
1354
1355                 /* Copy addresses */
1356                 for (i = 0; i < wrqu->data.length; i++)
1357                         memcpy(spydata->spy_address[i], address[i].sa_data,
1358                                ETH_ALEN);
1359                 /* Reset stats */
1360                 memset(spydata->spy_stat, 0,
1361                        sizeof(struct iw_quality) * IW_MAX_SPY);
1362         }
1363
1364         /* Make sure above is updated before re-enabling */
1365         smp_wmb();
1366
1367         /* Enable addresses */
1368         spydata->spy_number = wrqu->data.length;
1369
1370         return 0;
1371 }
1372 EXPORT_SYMBOL(iw_handler_set_spy);
1373
1374 /*------------------------------------------------------------------*/
1375 /*
1376  * Standard Wireless Handler : get Spy List
1377  */
1378 int iw_handler_get_spy(struct net_device *      dev,
1379                        struct iw_request_info * info,
1380                        union iwreq_data *       wrqu,
1381                        char *                   extra)
1382 {
1383         struct iw_spy_data *    spydata = get_spydata(dev);
1384         struct sockaddr *       address = (struct sockaddr *) extra;
1385         int                     i;
1386
1387         /* Make sure driver is not buggy or using the old API */
1388         if (!spydata)
1389                 return -EOPNOTSUPP;
1390
1391         wrqu->data.length = spydata->spy_number;
1392
1393         /* Copy addresses. */
1394         for (i = 0; i < spydata->spy_number; i++)       {
1395                 memcpy(address[i].sa_data, spydata->spy_address[i], ETH_ALEN);
1396                 address[i].sa_family = AF_UNIX;
1397         }
1398         /* Copy stats to the user buffer (just after). */
1399         if (spydata->spy_number > 0)
1400                 memcpy(extra  + (sizeof(struct sockaddr) *spydata->spy_number),
1401                        spydata->spy_stat,
1402                        sizeof(struct iw_quality) * spydata->spy_number);
1403         /* Reset updated flags. */
1404         for (i = 0; i < spydata->spy_number; i++)
1405                 spydata->spy_stat[i].updated &= ~IW_QUAL_ALL_UPDATED;
1406         return 0;
1407 }
1408 EXPORT_SYMBOL(iw_handler_get_spy);
1409
1410 /*------------------------------------------------------------------*/
1411 /*
1412  * Standard Wireless Handler : set spy threshold
1413  */
1414 int iw_handler_set_thrspy(struct net_device *   dev,
1415                           struct iw_request_info *info,
1416                           union iwreq_data *    wrqu,
1417                           char *                extra)
1418 {
1419         struct iw_spy_data *    spydata = get_spydata(dev);
1420         struct iw_thrspy *      threshold = (struct iw_thrspy *) extra;
1421
1422         /* Make sure driver is not buggy or using the old API */
1423         if (!spydata)
1424                 return -EOPNOTSUPP;
1425
1426         /* Just do it */
1427         memcpy(&(spydata->spy_thr_low), &(threshold->low),
1428                2 * sizeof(struct iw_quality));
1429
1430         /* Clear flag */
1431         memset(spydata->spy_thr_under, '\0', sizeof(spydata->spy_thr_under));
1432
1433         return 0;
1434 }
1435 EXPORT_SYMBOL(iw_handler_set_thrspy);
1436
1437 /*------------------------------------------------------------------*/
1438 /*
1439  * Standard Wireless Handler : get spy threshold
1440  */
1441 int iw_handler_get_thrspy(struct net_device *   dev,
1442                           struct iw_request_info *info,
1443                           union iwreq_data *    wrqu,
1444                           char *                extra)
1445 {
1446         struct iw_spy_data *    spydata = get_spydata(dev);
1447         struct iw_thrspy *      threshold = (struct iw_thrspy *) extra;
1448
1449         /* Make sure driver is not buggy or using the old API */
1450         if (!spydata)
1451                 return -EOPNOTSUPP;
1452
1453         /* Just do it */
1454         memcpy(&(threshold->low), &(spydata->spy_thr_low),
1455                2 * sizeof(struct iw_quality));
1456
1457         return 0;
1458 }
1459 EXPORT_SYMBOL(iw_handler_get_thrspy);
1460
1461 /*------------------------------------------------------------------*/
1462 /*
1463  * Prepare and send a Spy Threshold event
1464  */
1465 static void iw_send_thrspy_event(struct net_device *    dev,
1466                                  struct iw_spy_data *   spydata,
1467                                  unsigned char *        address,
1468                                  struct iw_quality *    wstats)
1469 {
1470         union iwreq_data        wrqu;
1471         struct iw_thrspy        threshold;
1472
1473         /* Init */
1474         wrqu.data.length = 1;
1475         wrqu.data.flags = 0;
1476         /* Copy address */
1477         memcpy(threshold.addr.sa_data, address, ETH_ALEN);
1478         threshold.addr.sa_family = ARPHRD_ETHER;
1479         /* Copy stats */
1480         memcpy(&(threshold.qual), wstats, sizeof(struct iw_quality));
1481         /* Copy also thresholds */
1482         memcpy(&(threshold.low), &(spydata->spy_thr_low),
1483                2 * sizeof(struct iw_quality));
1484
1485         /* Send event to user space */
1486         wireless_send_event(dev, SIOCGIWTHRSPY, &wrqu, (char *) &threshold);
1487 }
1488
1489 /* ---------------------------------------------------------------- */
1490 /*
1491  * Call for the driver to update the spy data.
1492  * For now, the spy data is a simple array. As the size of the array is
1493  * small, this is good enough. If we wanted to support larger number of
1494  * spy addresses, we should use something more efficient...
1495  */
1496 void wireless_spy_update(struct net_device *    dev,
1497                          unsigned char *        address,
1498                          struct iw_quality *    wstats)
1499 {
1500         struct iw_spy_data *    spydata = get_spydata(dev);
1501         int                     i;
1502         int                     match = -1;
1503
1504         /* Make sure driver is not buggy or using the old API */
1505         if (!spydata)
1506                 return;
1507
1508         /* Update all records that match */
1509         for (i = 0; i < spydata->spy_number; i++)
1510                 if (!compare_ether_addr(address, spydata->spy_address[i])) {
1511                         memcpy(&(spydata->spy_stat[i]), wstats,
1512                                sizeof(struct iw_quality));
1513                         match = i;
1514                 }
1515
1516         /* Generate an event if we cross the spy threshold.
1517          * To avoid event storms, we have a simple hysteresis : we generate
1518          * event only when we go under the low threshold or above the
1519          * high threshold. */
1520         if (match >= 0) {
1521                 if (spydata->spy_thr_under[match]) {
1522                         if (wstats->level > spydata->spy_thr_high.level) {
1523                                 spydata->spy_thr_under[match] = 0;
1524                                 iw_send_thrspy_event(dev, spydata,
1525                                                      address, wstats);
1526                         }
1527                 } else {
1528                         if (wstats->level < spydata->spy_thr_low.level) {
1529                                 spydata->spy_thr_under[match] = 1;
1530                                 iw_send_thrspy_event(dev, spydata,
1531                                                      address, wstats);
1532                         }
1533                 }
1534         }
1535 }
1536 EXPORT_SYMBOL(wireless_spy_update);