sys/dev/netif/an/if_aironet_ieee.h

   1 /*
   2  * Copyright (c) 1997, 1998, 1999
   3  *      Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Bill Paul.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30  * THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * $FreeBSD: src/sys/dev/an/if_aironet_ieee.h,v 1.1.2.7 2003/02/01 03:25:12 ambrisko Exp $
  33  */
  34
  35 #ifndef _IF_AIRONET_IEEE_H
  36 #define _IF_AIRONET_IEEE_H
  37
  38 /*
  39  * This header defines a simple command interface to the FreeBSD
  40  * Aironet driver (an) driver, which is used to set certain
  41  * device-specific parameters which can't be easily managed through
  42  * ifconfig(8). No, sysctl(2) is not the answer. I said a _simple_
  43  * interface, didn't I.
  44  */
  45
  46 #ifndef SIOCSAIRONET
  47 #define SIOCSAIRONET    SIOCSIFGENERIC
  48 #endif
  49
  50 #ifndef SIOCGAIRONET
  51 #define SIOCGAIRONET    SIOCGIFGENERIC
  52 #endif
  53
  54 /*
  55  * This is a make-predend RID value used only by the driver
  56  * to allow the user to set the speed.
  57  */
  58 #define AN_RID_TX_SPEED         0x1234
  59
  60 /*
  61  * Technically I don't think there's a limit to a record
  62  * length. The largest record is the one that contains the CIS
  63  * data, which is 240 words long, so 256 should be a safe
  64  * value.
  65  */
  66 #define AN_MAX_DATALEN  512
  67
  68 struct an_req {
  69         u_int16_t       an_len;
  70         u_int16_t       an_type;
  71         u_int16_t       an_val[AN_MAX_DATALEN];
  72 };
  73
  74 /*
  75  * Private LTV records (interpreted only by the driver). This is
  76  * a minor kludge to allow reading the interface statistics from
  77  * the driver.
  78  */
  79 #define AN_RID_IFACE_STATS      0x0100
  80 #define AN_RID_MGMT_XMIT        0x0200
  81 #ifdef ANCACHE
  82 #define AN_RID_ZERO_CACHE       0x0300
  83 #define AN_RID_READ_CACHE       0x0400
  84 #endif
  85
  86 #define AN_FCTL_VERS            0x0002
  87 #define AN_FCTL_FTYPE           0x000C
  88 #define AN_FCTL_STYPE           0x00F0
  89 #define AN_FCTL_TODS            0x0100
  90 #define AN_FCTL_FROMDS          0x0200
  91 #define AN_FCTL_MOREFRAGS       0x0400
  92 #define AN_FCTL_RETRY           0x0800
  93 #define AN_FCTL_PM              0x1000
  94 #define AN_FCTL_MOREDATA        0x2000
  95 #define AN_FCTL_WEP             0x4000
  96 #define AN_FCTL_ORDER           0x8000
  97
  98 #define AN_FTYPE_MGMT           0x0000
  99 #define AN_FTYPE_CTL            0x0004
 100 #define AN_FTYPE_DATA           0x0008
 101
 102 #define AN_STYPE_MGMT_ASREQ     0x0000  /* association request */
 103 #define AN_STYPE_MGMT_ASRESP    0x0010  /* association response */
 104 #define AN_STYPE_MGMT_REASREQ   0x0020  /* reassociation request */
 105 #define AN_STYPE_MGMT_REASRESP  0x0030  /* reassociation response */
 106 #define AN_STYPE_MGMT_PROBEREQ  0x0040  /* probe request */
 107 #define AN_STYPE_MGMT_PROBERESP 0x0050  /* probe response */
 108 #define AN_STYPE_MGMT_BEACON    0x0080  /* beacon */
 109 #define AN_STYPE_MGMT_ATIM      0x0090  /* announcement traffic ind msg */
 110 #define AN_STYPE_MGMT_DISAS     0x00A0  /* disassociation */
 111 #define AN_STYPE_MGMT_AUTH      0x00B0  /* authentication */
 112 #define AN_STYPE_MGMT_DEAUTH    0x00C0  /* deauthentication */
 113
 114 /*
 115  * Aironet IEEE signal strength cache
 116  *
 117  * driver keeps cache of last
 118  * MAXANCACHE packets to arrive including signal strength info.
 119  * daemons may read this via ioctl
 120  *
 121  * Each entry in the wi_sigcache has a unique macsrc.
 122  */
 123 #ifdef ANCACHE
 124 #define MAXANCACHE      10
 125
 126 struct an_sigcache {
 127         char    macsrc[6];      /* unique MAC address for entry */
 128         int     ipsrc;          /* ip address associated with packet */
 129         int     signal;         /* signal strength of the packet */
 130         int     noise;          /* noise value */
 131         int     quality;        /* quality of the packet */
 132 };
 133 #endif
 134
 135 /*
 136  * The card provides an 8-bit signal strength value (RSSI), which can
 137  * be converted to a dBm power value (or a percent) using a table in
 138  * the card's firmware (when available).  The tables are slightly
 139  * different in individual cards, even of the same model.  If the
 140  * table is not available, the mapping can be approximated by dBm =
 141  * RSSI - 100.  This approximation can be seen by plotting a few
 142  * tables, and also matches some info on the Intersil web site (I
 143  * think they make the RF front end for the cards.  However, the linux
 144  * driver uses the approximation dBm = RSSI/2 - 95.  I think that is
 145  * just wrong.
 146  */
 147
 148 struct an_rssi_entry {
 149         u_int8_t        an_rss_pct;
 150         u_int8_t        an_rss_dbm;
 151 };
 152
 153
 154 struct an_ltv_key {
 155         u_int16_t       an_len;
 156         u_int16_t       an_type;
 157         u_int16_t       kindex;
 158         u_int8_t        mac[6];
 159         u_int16_t       klen;
 160         u_int8_t        key[16];  /* 128-bit keys */
 161 };
 162
 163 struct an_ltv_stats {
 164         u_int16_t               an_fudge;
 165         u_int16_t               an_len;                 /* 0x00 */
 166         u_int16_t               an_type;                /* 0xXX */
 167         u_int16_t               an_spacer;              /* 0x02 */
 168         u_int32_t               an_rx_overruns;         /* 0x04 */
 169         u_int32_t               an_rx_plcp_csum_errs;   /* 0x08 */
 170         u_int32_t               an_rx_plcp_format_errs; /* 0x0C */
 171         u_int32_t               an_rx_plcp_len_errs;    /* 0x10 */
 172         u_int32_t               an_rx_mac_crc_errs;     /* 0x14 */
 173         u_int32_t               an_rx_mac_crc_ok;       /* 0x18 */
 174         u_int32_t               an_rx_wep_errs;         /* 0x1C */
 175         u_int32_t               an_rx_wep_ok;           /* 0x20 */
 176         u_int32_t               an_retry_long;          /* 0x24 */
 177         u_int32_t               an_retry_short;         /* 0x28 */
 178         u_int32_t               an_retry_max;           /* 0x2C */
 179         u_int32_t               an_no_ack;              /* 0x30 */
 180         u_int32_t               an_no_cts;              /* 0x34 */
 181         u_int32_t               an_rx_ack_ok;           /* 0x38 */
 182         u_int32_t               an_rx_cts_ok;           /* 0x3C */
 183         u_int32_t               an_tx_ack_ok;           /* 0x40 */
 184         u_int32_t               an_tx_rts_ok;           /* 0x44 */
 185         u_int32_t               an_tx_cts_ok;           /* 0x48 */
 186         u_int32_t               an_tx_lmac_mcasts;      /* 0x4C */
 187         u_int32_t               an_tx_lmac_bcasts;      /* 0x50 */
 188         u_int32_t               an_tx_lmac_ucast_frags; /* 0x54 */
 189         u_int32_t               an_tx_lmac_ucasts;      /* 0x58 */
 190         u_int32_t               an_tx_beacons;          /* 0x5C */
 191         u_int32_t               an_rx_beacons;          /* 0x60 */
 192         u_int32_t               an_tx_single_cols;      /* 0x64 */
 193         u_int32_t               an_tx_multi_cols;       /* 0x68 */
 194         u_int32_t               an_tx_defers_no;        /* 0x6C */
 195         u_int32_t               an_tx_defers_prot;      /* 0x70 */
 196         u_int32_t               an_tx_defers_energy;    /* 0x74 */
 197         u_int32_t               an_rx_dups;             /* 0x78 */
 198         u_int32_t               an_rx_partial;          /* 0x7C */
 199         u_int32_t               an_tx_too_old;          /* 0x80 */
 200         u_int32_t               an_rx_too_old;          /* 0x84 */
 201         u_int32_t               an_lostsync_max_retries;/* 0x88 */
 202         u_int32_t               an_lostsync_missed_beacons;/* 0x8C */
 203         u_int32_t               an_lostsync_arl_exceeded;/*0x90 */
 204         u_int32_t               an_lostsync_deauthed;   /* 0x94 */
 205         u_int32_t               an_lostsync_disassociated;/*0x98 */
 206         u_int32_t               an_lostsync_tsf_timing; /* 0x9C */
 207         u_int32_t               an_tx_host_mcasts;      /* 0xA0 */
 208         u_int32_t               an_tx_host_bcasts;      /* 0xA4 */
 209         u_int32_t               an_tx_host_ucasts;      /* 0xA8 */
 210         u_int32_t               an_tx_host_failed;      /* 0xAC */
 211         u_int32_t               an_rx_host_mcasts;      /* 0xB0 */
 212         u_int32_t               an_rx_host_bcasts;      /* 0xB4 */
 213         u_int32_t               an_rx_host_ucasts;      /* 0xB8 */
 214         u_int32_t               an_rx_host_discarded;   /* 0xBC */
 215         u_int32_t               an_tx_hmac_mcasts;      /* 0xC0 */
 216         u_int32_t               an_tx_hmac_bcasts;      /* 0xC4 */
 217         u_int32_t               an_tx_hmac_ucasts;      /* 0xC8 */
 218         u_int32_t               an_tx_hmac_failed;      /* 0xCC */
 219         u_int32_t               an_rx_hmac_mcasts;      /* 0xD0 */
 220         u_int32_t               an_rx_hmac_bcasts;      /* 0xD4 */
 221         u_int32_t               an_rx_hmac_ucasts;      /* 0xD8 */
 222         u_int32_t               an_rx_hmac_discarded;   /* 0xDC */
 223         u_int32_t               an_tx_hmac_accepted;    /* 0xE0 */
 224         u_int32_t               an_ssid_mismatches;     /* 0xE4 */
 225         u_int32_t               an_ap_mismatches;       /* 0xE8 */
 226         u_int32_t               an_rates_mismatches;    /* 0xEC */
 227         u_int32_t               an_auth_rejects;        /* 0xF0 */
 228         u_int32_t               an_auth_timeouts;       /* 0xF4 */
 229         u_int32_t               an_assoc_rejects;       /* 0xF8 */
 230         u_int32_t               an_assoc_timeouts;      /* 0xFC */
 231         u_int32_t               an_reason_outside_table;/* 0x100 */
 232         u_int32_t               an_reason1;             /* 0x104 */
 233         u_int32_t               an_reason2;             /* 0x108 */
 234         u_int32_t               an_reason3;             /* 0x10C */
 235         u_int32_t               an_reason4;             /* 0x110 */
 236         u_int32_t               an_reason5;             /* 0x114 */
 237         u_int32_t               an_reason6;             /* 0x118 */
 238         u_int32_t               an_reason7;             /* 0x11C */
 239         u_int32_t               an_reason8;             /* 0x120 */
 240         u_int32_t               an_reason9;             /* 0x124 */
 241         u_int32_t               an_reason10;            /* 0x128 */
 242         u_int32_t               an_reason11;            /* 0x12C */
 243         u_int32_t               an_reason12;            /* 0x130 */
 244         u_int32_t               an_reason13;            /* 0x134 */
 245         u_int32_t               an_reason14;            /* 0x138 */
 246         u_int32_t               an_reason15;            /* 0x13C */
 247         u_int32_t               an_reason16;            /* 0x140 */
 248         u_int32_t               an_reason17;            /* 0x144 */
 249         u_int32_t               an_reason18;            /* 0x148 */
 250         u_int32_t               an_reason19;            /* 0x14C */
 251         u_int32_t               an_rx_mgmt_pkts;        /* 0x150 */
 252         u_int32_t               an_tx_mgmt_pkts;        /* 0x154 */
 253         u_int32_t               an_rx_refresh_pkts;     /* 0x158 */
 254         u_int32_t               an_tx_refresh_pkts;     /* 0x15C */
 255         u_int32_t               an_rx_poll_pkts;        /* 0x160 */
 256         u_int32_t               an_tx_poll_pkts;        /* 0x164 */
 257         u_int32_t               an_host_retries;        /* 0x168 */
 258         u_int32_t               an_lostsync_hostreq;    /* 0x16C */
 259         u_int32_t               an_host_tx_bytes;       /* 0x170 */
 260         u_int32_t               an_host_rx_bytes;       /* 0x174 */
 261         u_int32_t               an_uptime_usecs;        /* 0x178 */
 262         u_int32_t               an_uptime_secs;         /* 0x17C */
 263         u_int32_t               an_lostsync_better_ap;  /* 0x180 */
 264         u_int32_t               an_rsvd[10];
 265 };
 266
 267 /*
 268  * General configuration information.
 269  */
 270 struct an_ltv_genconfig {
 271         /* General configuration. */
 272         u_int16_t               an_len;                 /* 0x00 */
 273         u_int16_t               an_type;                /* XXXX */
 274         u_int16_t               an_opmode;              /* 0x02 */
 275         u_int16_t               an_rxmode;              /* 0x04 */
 276         u_int16_t               an_fragthresh;          /* 0x06 */
 277         u_int16_t               an_rtsthresh;           /* 0x08 */
 278         u_int8_t                an_macaddr[6];          /* 0x0A */
 279         u_int8_t                an_rates[8];            /* 0x10 */
 280         u_int16_t               an_shortretry_limit;    /* 0x18 */
 281         u_int16_t               an_longretry_limit;     /* 0x1A */
 282         u_int16_t               an_tx_msdu_lifetime;    /* 0x1C */
 283         u_int16_t               an_rx_msdu_lifetime;    /* 0x1E */
 284         u_int16_t               an_stationary;          /* 0x20 */
 285         u_int16_t               an_ordering;            /* 0x22 */
 286         u_int16_t               an_devtype;             /* 0x24 */
 287         u_int16_t               an_rsvd0[5];            /* 0x26 */
 288         /* Scanning associating. */
 289         u_int16_t               an_scanmode;            /* 0x30 */
 290         u_int16_t               an_probedelay;          /* 0x32 */
 291         u_int16_t               an_probe_energy_timeout;/* 0x34 */
 292         u_int16_t               an_probe_response_timeout;/*0x36 */
 293         u_int16_t               an_beacon_listen_timeout;/*0x38 */
 294         u_int16_t               an_ibss_join_net_timeout;/*0x3A */
 295         u_int16_t               an_auth_timeout;        /* 0x3C */
 296         u_int16_t               an_authtype;            /* 0x3E */
 297         u_int16_t               an_assoc_timeout;       /* 0x40 */
 298         u_int16_t               an_specified_ap_timeout;/* 0x42 */
 299         u_int16_t               an_offline_scan_interval;/*0x44 */
 300         u_int16_t               an_offline_scan_duration;/*0x46 */
 301         u_int16_t               an_link_loss_delay;     /* 0x48 */
 302         u_int16_t               an_max_beacon_lost_time;/* 0x4A */
 303         u_int16_t               an_refresh_interval;    /* 0x4C */
 304         u_int16_t               an_rsvd1;               /* 0x4E */
 305         /* Power save operation */
 306         u_int16_t               an_psave_mode;          /* 0x50 */
 307         u_int16_t               an_sleep_for_dtims;     /* 0x52 */
 308         u_int16_t               an_listen_interval;     /* 0x54 */
 309         u_int16_t               an_fast_listen_interval;/* 0x56 */
 310         u_int16_t               an_listen_decay;        /* 0x58 */
 311         u_int16_t               an_fast_listen_decay;   /* 0x5A */
 312         u_int16_t               an_rsvd2[2];            /* 0x5C */
 313         /* Ad-hoc (or AP) operation. */
 314         u_int16_t               an_beacon_period;       /* 0x60 */
 315         u_int16_t               an_atim_duration;       /* 0x62 */
 316         u_int16_t               an_rsvd3;               /* 0x64 */
 317         u_int16_t               an_ds_channel;          /* 0x66 */
 318         u_int16_t               an_rsvd4;               /* 0x68 */
 319         u_int16_t               an_dtim_period;         /* 0x6A */
 320         u_int16_t               an_rsvd5[2];            /* 0x6C */
 321         /* Radio operation. */
 322         u_int16_t               an_radiotype;           /* 0x70 */
 323         u_int16_t               an_diversity;           /* 0x72 */
 324         u_int16_t               an_tx_power;            /* 0x74 */
 325         u_int16_t               an_rss_thresh;          /* 0x76 */
 326         u_int16_t               an_modulation_type;     /* 0x78 */
 327         u_int16_t               an_short_preamble;      /* 0x7A */
 328         u_int16_t               an_home_product;        /* 0x7C */
 329         u_int16_t               an_rsvd6;               /* 0x7E */
 330         /* Aironet extensions. */
 331         u_int8_t                an_nodename[16];        /* 0x80 */
 332         u_int16_t               an_arl_thresh;          /* 0x90 */
 333         u_int16_t               an_arl_decay;           /* 0x92 */
 334         u_int16_t               an_arl_delay;           /* 0x94 */
 335         u_int8_t                an_rsvd7;               /* 0x96 */
 336         u_int8_t                an_rsvd8;               /* 0x97 */
 337         u_int8_t                an_magic_packet_action; /* 0x98 */
 338         u_int8_t                an_magic_packet_ctl;    /* 0x99 */
 339         u_int16_t               an_rsvd9;
 340 };
 341
 342 #define AN_OPMODE_IBSS_ADHOC                    0x0000
 343 #define AN_OPMODE_INFRASTRUCTURE_STATION        0x0001
 344 #define AN_OPMODE_AP                            0x0002
 345 #define AN_OPMODE_AP_REPEATER                   0x0003
 346 #define AN_OPMODE_UNMODIFIED_PAYLOAD            0x0100
 347 #define AN_OPMODE_AIRONET_EXTENSIONS            0x0200
 348 #define AN_OPMODE_AP_EXTENSIONS                 0x0400
 349
 350 #define AN_RXMODE_BC_MC_ADDR                    0x0000
 351 #define AN_RXMODE_BC_ADDR                       0x0001
 352 #define AN_RXMODE_ADDR                          0x0002
 353 #define AN_RXMODE_80211_MONITOR_CURBSS          0x0003
 354 #define AN_RXMODE_80211_MONITOR_ANYBSS          0x0004
 355 #define AN_RXMODE_LAN_MONITOR_CURBSS            0x0005
 356 #define AN_RXMODE_NO_8023_HEADER                0x0100
 357 #define AN_RXMODE_NORMALIZED_RSSI               0x0200
 358
 359 #define AN_RATE_1MBPS                           0x0002
 360 #define AN_RATE_2MBPS                           0x0004
 361 #define AN_RATE_5_5MBPS                         0x000B
 362 #define AN_RATE_11MBPS                          0x0016
 363
 364 #define AN_DEVTYPE_PC4500                       0x0065
 365 #define AN_DEVTYPE_PC4800                       0x006D
 366
 367 #define AN_SCANMODE_ACTIVE                      0x0000
 368 #define AN_SCANMODE_PASSIVE                     0x0001
 369 #define AN_SCANMODE_AIRONET_ACTIVE              0x0002
 370
 371 #define AN_AUTHTYPE_NONE                        0x0000
 372 #define AN_AUTHTYPE_OPEN                        0x0001
 373 #define AN_AUTHTYPE_SHAREDKEY                   0x0002
 374 #define AN_AUTHTYPE_MASK                        0x00ff
 375 #define AN_AUTHTYPE_ENABLE                      0x0100
 376 #define AN_AUTHTYPE_PRIVACY_IN_USE              0x0100
 377 #define AN_AUTHTYPE_ALLOW_UNENCRYPTED           0x0200
 378 #define AN_AUTHTYPE_LEAP                        0x1000
 379
 380 #define AN_PSAVE_NONE                           0x0000
 381 #define AN_PSAVE_CAM                            0x0001
 382 #define AN_PSAVE_PSP                            0x0002
 383 #define AN_PSAVE_PSP_CAM                        0x0003
 384
 385 #define AN_RADIOTYPE_80211_FH                   0x0001
 386 #define AN_RADIOTYPE_80211_DS                   0x0002
 387 #define AN_RADIOTYPE_LM2000_DS                  0x0004
 388
 389 #define AN_DIVERSITY_FACTORY_DEFAULT            0x0000
 390 #define AN_DIVERSITY_ANTENNA_1_ONLY             0x0001
 391 #define AN_DIVERSITY_ANTENNA_2_ONLY             0x0002
 392 #define AN_DIVERSITY_ANTENNA_1_AND_2            0x0003
 393
 394 #define AN_TXPOWER_FACTORY_DEFAULT              0x0000
 395 #define AN_TXPOWER_50MW                         50
 396 #define AN_TXPOWER_100MW                        100
 397 #define AN_TXPOWER_250MW                        250
 398
 399 #define AN_HOME_NETWORK                         0x0001
 400 #define AN_HOME_INSTALL_AP                      0x0002
 401
 402 /*
 403  * Valid SSID list. You can specify up to three SSIDs denoting
 404  * the service sets that you want to join. The first SSID always
 405  * defaults to "tsunami" which is a handy way to detect the
 406  * card.
 407  */
 408
 409 struct an_ltv_ssidlist {
 410         u_int16_t               an_len;
 411         u_int16_t               an_type;
 412         u_int16_t               an_ssid1_len;
 413         char                    an_ssid1[32];
 414         u_int16_t               an_ssid2_len;
 415         char                    an_ssid2[32];
 416         u_int16_t               an_ssid3_len;
 417         char                    an_ssid3[32];
 418 };
 419
 420 /*
 421  * Valid AP list.
 422  */
 423 struct an_ltv_aplist {
 424         u_int16_t               an_len;
 425         u_int16_t               an_type;
 426         u_int8_t                an_ap1[8];
 427         u_int8_t                an_ap2[8];
 428         u_int8_t                an_ap3[8];
 429         u_int8_t                an_ap4[8];
 430 };
 431
 432 /*
 433  * Driver name.
 434  */
 435 struct an_ltv_drvname {
 436         u_int16_t               an_len;
 437         u_int16_t               an_type;
 438         u_int8_t                an_drvname[16];
 439 };
 440
 441 /*
 442  * Frame encapsulation.
 443  */
 444 struct an_rid_encap {
 445         u_int16_t               an_len;
 446         u_int16_t               an_type;
 447         u_int16_t               an_ethertype_default;
 448         u_int16_t               an_action_default;
 449         u_int16_t               an_ethertype0;
 450         u_int16_t               an_action0;
 451         u_int16_t               an_ethertype1;
 452         u_int16_t               an_action1;
 453         u_int16_t               an_ethertype2;
 454         u_int16_t               an_action2;
 455         u_int16_t               an_ethertype3;
 456         u_int16_t               an_action3;
 457         u_int16_t               an_ethertype4;
 458         u_int16_t               an_action4;
 459         u_int16_t               an_ethertype5;
 460         u_int16_t               an_action5;
 461         u_int16_t               an_ethertype6;
 462         u_int16_t               an_action6;
 463 };
 464
 465 #define AN_ENCAP_ACTION_RX      0x0001
 466 #define AN_ENCAP_ACTION_TX      0x0002
 467
 468 #define AN_RXENCAP_NONE         0x0000
 469 #define AN_RXENCAP_RFC1024      0x0001
 470
 471 #define AN_TXENCAP_RFC1024      0x0000
 472 #define AN_TXENCAP_80211        0x0002
 473
 474 /*
 475  * Card capabilities (read only).
 476  */
 477 struct an_ltv_caps {
 478         u_int16_t               an_len;                 /* 0x00 */
 479         u_int16_t               an_type;                /* XXXX */
 480         u_int8_t                an_oui[3];              /* 0x02 */
 481         u_int8_t                an_rsvd0;               /* 0x05 */
 482         u_int16_t               an_prodnum;             /* 0x06 */
 483         u_int8_t                an_manufname[32];       /* 0x08 */
 484         u_int8_t                an_prodname[16];        /* 0x28 */
 485         u_int8_t                an_prodvers[8];         /* 0x38 */
 486         u_int8_t                an_oemaddr[6];          /* 0x40 */
 487         u_int8_t                an_aironetaddr[6];      /* 0x46 */
 488         u_int16_t               an_radiotype;           /* 0x4C */
 489         u_int16_t               an_regdomain;           /* 0x4E */
 490         u_int8_t                an_callid[6];           /* 0x50 */
 491         u_int8_t                an_rates[8];            /* 0x56 */
 492         u_int8_t                an_rx_diversity;        /* 0x5E */
 493         u_int8_t                an_tx_diversity;        /* 0x5F */
 494         u_int16_t               an_tx_powerlevels[8];   /* 0x60 */
 495         u_int16_t               an_hwrev;               /* 0x70 */
 496         u_int16_t               an_hwcaps;              /* 0x72 */
 497         u_int16_t               an_temprange;           /* 0x74 */
 498         u_int16_t               an_fwrev;               /* 0x76 */
 499         u_int16_t               an_fwsubrev;            /* 0x78 */
 500         u_int16_t               an_ifacerev;            /* 0x7A */
 501         u_int16_t               an_softcaps;            /* 0x7C */
 502         u_int16_t               an_bootblockrev;        /* 0x7E */
 503         u_int16_t               an_req_hw_support;      /* 0x80 */
 504         u_int16_t               an_unknown;             /* 0x82 */
 505 };
 506
 507 /*
 508  * Access point (read only)
 509  */
 510 struct an_ltv_apinfo {
 511         u_int16_t               an_len;
 512         u_int16_t               an_type;
 513         u_int16_t               an_tim_addr;
 514         u_int16_t               an_airo_addr;
 515 };
 516
 517 /*
 518  * Radio info (read only).
 519  */
 520 struct an_ltv_radioinfo {
 521         u_int16_t               an_len;
 522         u_int16_t               an_type;
 523         /* ??? */
 524 };
 525
 526 /*
 527  * RSSI map.  If available in the card's firmware, this can be used to
 528  * convert the 8-bit RSSI values from the card into dBm.
 529  */
 530 struct an_ltv_rssi_map {
 531         u_int16_t               an_len;
 532         u_int16_t               an_type;
 533         struct an_rssi_entry    an_entries[256];
 534 };
 535
 536 /*
 537  * Status (read only). Note: the manual claims this RID is 108 bytes
 538  * long (0x6A is the last datum, which is 2 bytes long) however when
 539  * this RID is read from the NIC, it returns a length of 110. To be
 540  * on the safe side, this structure is padded with an extra 16-bit
 541  * word. (There is a misprint in the manual which says the macaddr
 542  * field is 8 bytes long.)
 543  *
 544  * Also, the channel_set and current_channel fields appear to be
 545  * reversed. Either that, or the hop_period field is unused.
 546  */
 547 struct an_ltv_status {
 548         u_int16_t               an_len;                 /* 0x00 */
 549         u_int16_t               an_type;                /* 0xXX */
 550         u_int8_t                an_macaddr[6];          /* 0x02 */
 551         u_int16_t               an_opmode;              /* 0x08 */
 552         u_int16_t               an_errcode;             /* 0x0A */
 553         u_int16_t               an_signal_quality;      /* 0x0C */
 554         u_int16_t               an_ssidlen;             /* 0x0E */
 555         u_int8_t                an_ssid[32];            /* 0x10 */
 556         u_int8_t                an_ap_name[16];         /* 0x30 */
 557         u_int8_t                an_cur_bssid[6];        /* 0x40 */
 558         u_int8_t                an_prev_bssid1[6];      /* 0x46 */
 559         u_int8_t                an_prev_bssid2[6];      /* 0x4C */
 560         u_int8_t                an_prev_bssid3[6];      /* 0x52 */
 561         u_int16_t               an_beacon_period;       /* 0x58 */
 562         u_int16_t               an_dtim_period;         /* 0x5A */
 563         u_int16_t               an_atim_duration;       /* 0x5C */
 564         u_int16_t               an_hop_period;          /* 0x5E */
 565         u_int16_t               an_cur_channel;         /* 0x62 */
 566         u_int16_t               an_channel_set;         /* 0x60 */
 567         u_int16_t               an_hops_to_backbone;    /* 0x64 */
 568         u_int16_t               an_ap_total_load;       /* 0x66 */
 569         u_int16_t               an_our_generated_load;  /* 0x68 */
 570         u_int16_t               an_accumulated_arl;     /* 0x6A */
 571         u_int16_t               an_cur_signal_quality;  /* 0x6C */
 572         u_int16_t               an_current_tx_rate;     /* 0x6E */
 573         u_int16_t               an_ap_device;           /* 0x70 */
 574         u_int16_t               an_normalized_strength; /* 0x72 */
 575         u_int16_t               an_short_pre_in_use;    /* 0x74 */
 576         u_int8_t                an_ap_ip_addr[4];       /* 0x76 */
 577         u_int8_t                an_noise_prev_sec_pc;   /* 0x7A */
 578         u_int8_t                an_noise_prev_sec_db;   /* 0x7B */
 579         u_int8_t                an_avg_noise_prev_min_pc;       /* 0x7C */
 580         u_int8_t                an_avg_noise_prev_min_db;       /* 0x7D */
 581         u_int8_t                an_max_noise_prev_min_pc;       /* 0x7E */
 582         u_int8_t                an_max_noise_prev_min_db;       /* 0x7F */
 583         u_int16_t               an_spare[5];
 584 };
 585
 586 #define AN_STATUS_OPMODE_CONFIGURED             0x0001
 587 #define AN_STATUS_OPMODE_MAC_ENABLED            0x0002
 588 #define AN_STATUS_OPMODE_RX_ENABLED             0x0004
 589 #define AN_STATUS_OPMODE_IN_SYNC                0x0010
 590 #define AN_STATUS_OPMODE_ASSOCIATED             0x0020
 591 #define AN_STATUS_OPMODE_LEAP                   0x0040
 592 #define AN_STATUS_OPMODE_ERROR                  0x8000
 593
 594 /*
 595  * WEP Key
 596  */
 597 struct an_ltv_wepkey {
 598         u_int16_t               an_len;                 /* 0x00 */
 599         u_int16_t               an_type;                /* 0xXX */
 600         u_int16_t               an_key_index;           /* 0x02 */
 601         u_int8_t                an_mac_addr[6];         /* 0x04 */
 602         u_int16_t               an_key_len;             /* 0x0A */
 603         u_int8_t                an_key[13];             /* 0x0C */
 604 };
 605
 606 /*
 607  * Receive frame structure.
 608  */
 609 struct an_rxframe {
 610         u_int32_t               an_rx_time;             /* 0x00 */
 611         u_int16_t               an_rx_status;           /* 0x04 */
 612         u_int16_t               an_rx_payload_len;      /* 0x06 */
 613         u_int8_t                an_rsvd0;               /* 0x08 */
 614         u_int8_t                an_rx_signal_strength;  /* 0x09 */
 615         u_int8_t                an_rx_rate;             /* 0x0A */
 616         u_int8_t                an_rx_chan;             /* 0x0B */
 617         u_int8_t                an_rx_assoc_cnt;        /* 0x0C */
 618         u_int8_t                an_rsvd1[3];            /* 0x0D */
 619         u_int8_t                an_plcp_hdr[4];         /* 0x10 */
 620         u_int16_t               an_frame_ctl;           /* 0x14 */
 621         u_int16_t               an_duration;            /* 0x16 */
 622         u_int8_t                an_addr1[6];            /* 0x18 */
 623         u_int8_t                an_addr2[6];            /* 0x1E */
 624         u_int8_t                an_addr3[6];            /* 0x24 */
 625         u_int16_t               an_seq_ctl;             /* 0x2A */
 626         u_int8_t                an_addr4[6];            /* 0x2C */
 627         u_int8_t                an_gaplen;              /* 0x32 */
 628 } __attribute__ ((packed));
 629
 630
 631 /* Do not modify this unless you are modifying LEAP itself */
 632 #define LEAP_USERNAME_MAX 32
 633 #define LEAP_PASSWORD_MAX 32
 634
 635 /*
 636  * LEAP Username
 637  */
 638 struct an_ltv_leap_username {
 639         u_int16_t               an_len;                 /* 0x00 */
 640         u_int16_t               an_type;                /* 0xXX */
 641         u_int16_t               an_username_len;        /* 0x02 */
 642         u_int8_t                an_username[LEAP_USERNAME_MAX]; /* 0x04 */
 643 };
 644
 645 /*
 646  * LEAP Password
 647  */
 648 struct an_ltv_leap_password {
 649         u_int16_t               an_len;                 /* 0x00 */
 650         u_int16_t               an_type;                /* 0xXX */
 651         u_int16_t               an_password_len;        /* 0x02 */
 652         u_int8_t                an_password[LEAP_PASSWORD_MAX]; /* 0x04 */
 653 };
 654
 655 /*
 656  * These are all the LTV record types that we can read or write
 657  * from the Aironet. Not all of them are temendously useful, but I
 658  * list as many as I know about here for completeness.
 659  */
 660
 661 /*
 662  * Configuration (read/write)
 663  */
 664 #define AN_RID_GENCONFIG        0xFF10  /* General configuration info */
 665 #define AN_RID_SSIDLIST         0xFF11  /* Valid SSID list */
 666 #define AN_RID_APLIST           0xFF12  /* Valid AP list */
 667 #define AN_RID_DRVNAME          0xFF13  /* ID name of this node for diag */
 668 #define AN_RID_ENCAPPROTO       0xFF14  /* Payload encapsulation type */
 669 #define AN_RID_WEP_TEMP         0xFF15  /* Temporary Key */
 670 #define AN_RID_WEP_PERM         0xFF16  /* Perminant Key */
 671 #define AN_RID_ACTUALCFG        0xFF20  /* Current configuration settings */
 672
 673 /*
 674  * Reporting (read only)
 675  */
 676 #define AN_RID_CAPABILITIES     0xFF00  /* PC 4500/4800 capabilities */
 677 #define AN_RID_AP_INFO          0xFF01  /* Access point info */
 678 #define AN_RID_RADIO_INFO       0xFF02  /* Radio info */
 679 #define AN_RID_RSSI_MAP         0xFF04  /* RSSI <-> dBm table */
 680 #define AN_RID_STATUS           0xFF50  /* Current status info */
 681 #define AN_RID_BEACONS_HST      0xFF51
 682 #define AN_RID_BUSY_HST         0xFF52
 683 #define AN_RID_RETRIES_HST      0xFF53
 684
 685 /*
 686  * Statistics
 687  */
 688 #define AN_RID_16BITS_CUM       0xFF60  /* Cumulative 16-bit stats counters */
 689 #define AN_RID_16BITS_DELTA     0xFF61  /* 16-bit stats (since last clear) */
 690 #define AN_RID_16BITS_DELTACLR  0xFF62  /* 16-bit stats, clear on read */
 691 #define AN_RID_32BITS_CUM       0xFF68  /* Cumulative 32-bit stats counters */
 692 #define AN_RID_32BITS_DELTA     0xFF69  /* 32-bit stats (since last clear) */
 693 #define AN_RID_32BITS_DELTACLR  0xFF6A  /* 32-bit stats, clear on read */
 694
 695 /*
 696  * LEAP
 697  */
 698
 699 #define AN_RID_LEAPUSERNAME     0xFF23  /* Username */
 700 #define AN_RID_LEAPPASSWORD     0xFF24  /* Password */
 701
 702 /*
 703  * OTHER Unknonwn for now
 704  */
 705
 706 #define AN_RID_MOD              0xFF17
 707 #define AN_RID_OPTIONS          0xFF18
 708 #define AN_RID_FACTORY_CONFIG   0xFF18
 709
 710 /*
 711  *   FreeBSD fake RID
 712  */
 713
 714 #define AN_RID_MONITOR_MODE     0x0001  /* Set monitor mode for driver */
 715 #define AN_MONITOR                       1
 716 #define AN_MONITOR_ANY_BSS               2
 717 #define AN_MONITOR_INCLUDE_BEACON        4
 718 #define AN_MONITOR_AIRONET_HEADER        8
 719
 720 #define DLT_AIRONET_HEADER      120     /* Has been allocated at tcpdump.org */
 721
 722 /*
 723  * from the Linux driver from Cisco ... no copyright header.
 724  * Removed duplicated information that already existed in the FreeBSD driver
 725  * provides emulation of the Cisco extensions to the Linux Aironet driver.
 726  */
 727
 728 /*
 729  * Ioctl constants to be used in airo_ioctl.command
 730  */
 731
 732 #define AIROGCAP        0       /* Capability rid */
 733 #define AIROGCFG        1       /* USED A LOT  */
 734 #define AIROGSLIST      2       /* System ID list  */
 735 #define AIROGVLIST      3       /* List of specified AP's */
 736 #define AIROGDRVNAM     4       /* NOTUSED */
 737 #define AIROGEHTENC     5       /* NOTUSED */
 738 #define AIROGWEPKTMP    6
 739 #define AIROGWEPKNV     7
 740 #define AIROGSTAT       8
 741 #define AIROGSTATSC32   9
 742 #define AIROGSTATSD32   10
 743
 744 /*
 745  * Leave gap of 40 commands after AIROGSTATSD32
 746  */
 747
 748 #define AIROPCAP        AIROGSTATSD32   + 40
 749 #define AIROPVLIST      AIROPCAP        + 1
 750 #define AIROPSLIST      AIROPVLIST      + 1
 751 #define AIROPCFG        AIROPSLIST      + 1
 752 #define AIROPSIDS       AIROPCFG        + 1
 753 #define AIROPAPLIST     AIROPSIDS       + 1
 754 #define AIROPMACON      AIROPAPLIST     + 1     /* Enable mac  */
 755 #define AIROPMACOFF     AIROPMACON      + 1     /* Disable mac */
 756 #define AIROPSTCLR      AIROPMACOFF     + 1
 757 #define AIROPWEPKEY     AIROPSTCLR      + 1
 758 #define AIROPWEPKEYNV   AIROPWEPKEY     + 1
 759 #define AIROPLEAPPWD    AIROPWEPKEYNV   + 1
 760 #define AIROPLEAPUSR    AIROPLEAPPWD    + 1
 761
 762 /*
 763  * Another gap of 40 commands before flash codes
 764  */
 765
 766 #define AIROFLSHRST     AIROPWEPKEYNV   + 40
 767 #define AIROFLSHGCHR    AIROFLSHRST     + 1
 768 #define AIROFLSHSTFL    AIROFLSHGCHR    + 1
 769 #define AIROFLSHPCHR    AIROFLSHSTFL    + 1
 770 #define AIROFLPUTBUF    AIROFLSHPCHR    + 1
 771 #define AIRORESTART     AIROFLPUTBUF    + 1
 772
 773 /*
 774  * Struct to enable up to 65535 ioctl's
 775  */
 776
 777 #define AIROMAGIC       0xa55a
 778
 779 typedef struct aironet_ioctl {
 780   unsigned short command;       /* What to do */
 781   unsigned short len;           /* Len of data */
 782   unsigned char *data;          /* d-data */
 783 } airo_ioctl;
 784
 785 #endif