dot11usrlib.h

PNE 3.3 wlan source code, running at more than vxworks6.x version

/* dot11UsrLib.h - Contains the definitions required by users of DOT11 lib  */

/* 
 * Copyright (c) 2004-2006 Wind River Systems, Inc. 
 *
 * The right to copy, distribute, modify or otherwise make use 
 * of this software may be licensed only pursuant to the terms 
 * of an applicable Wind River license agreement. 
 */

/* 
Modification History
--------------------
01n,27feb06,rb  Code inspection changes
01m,14feb06,rb  Removed redundant VLAN IOCTLs
01l,16nov05,rb  Added IOCTLs for mSSID feature
01k,12sep05,rb  Added WIOCSSCANTYPE
01j,25aug05,rb  Modified channel structures for 802.11d
01j,30aug05,rb  Removed legacy IOCTL definitions and added WIOCDPAIRWISEKEY
01i,19aug05,rb  Added macros for turbo mode
01h,04aug05,rb  Added WIOCGCHANNELLIST
01g,03aug05,rb  Added WIOCSUSERAUTHCALLBACK
01f,28apr05,rb  Added _BIT definition to dot11UsrLib.h; Moved encryption types
                 to usrLib
01e,27apr05,rb  Extended DOT11_STATS for SPR 108017
01d,25apr05,rb  Moved definitions needed for IOCTLs from dot11Lib.h to
                 dot11UsrLib.h
01c,14apr05,rb  Added support fr Transmit Power Scaling (WIOCSTXPOWERSCALE)
01b,09mar05,rb  Added WIOCGHWVERS
01a,21feb05,rb  Initial split from dot11Lib.h
*/

/*
DESCRIPTION

This file contains all of the definitions required to manage the Wind River 
Wirelss Ethernet Driver.

*/


#ifndef __INCdot11UsrLibh
#define __INCdot11UsrLibh
#ifdef  __cplusplus
extern "C" {
#endif /* __cplusplus */

#include <vxWorks.h>

/*****************************************************************************
* Public DOT11 Data structures and definitions
*****************************************************************************/
#ifndef _BIT
#define _BIT(x) (1<<(x))
#endif

/**************************************************************************
*  DOT11_SSID - Structure representing an SSID
***************************************************************************/
#define DOT11_SSID_LEN                  32
typedef char  DOT11_SSID[DOT11_SSID_LEN + 1];

/**************************************************************************
*  DOT11_ADDR - An 802.11 hardware address.   Same as MAC address.
***************************************************************************/
#define DOT11_ADDR_LEN                  6
typedef UINT8 DOT11_ADDR[DOT11_ADDR_LEN];

/**************************************************************************
* DOT11_RATES - A set of rates in IEEE format (units of 500 kb/s).  Rates
*                  are listed in ascending order.  If relevent, required
*                  rates are specified by setting bit 7, otherwise this
*                  bit is clear.
**************************************************************************/
#define DOT11_MAX_RATES            256
typedef struct
    {
    int      length;
    UINT8    rates[DOT11_MAX_RATES];
    } _WRS_PACK_ALIGN(1) DOT11_RATES;

/* Routines for manipulating rates according to the IEEE standard */
#define DOT11_RATE(x)              (((x) & 0x7f) / 2)
#define DOT11_RATE_MASK(x)         (((x) & 0x7f))
#define DOT11_IS_BRATE(x)          (((x) & 0x80) == 0x80)

/**************************************************************************
*  DOT11_KEY - An 802.11 Encryption Key. 
***************************************************************************/
typedef unsigned long int  DOT11_KEY_TYPE;

#define DOT11_KEY_TYPE_NONE           0
#define DOT11_KEY_TYPE_WEP40          DOT11_CIPHPOL_WEP40
#define DOT11_KEY_TYPE_WEP104         DOT11_CIPHPOL_WEP104
#define DOT11_KEY_TYPE_TKIP           DOT11_CIPHPOL_TKIP
#define DOT11_KEY_TYPE_AES            DOT11_CIPHPOL_AES

#define DOT11_KEY_TYPE_MAX            (DOT11_KEY_TYPE_AES + 1)

#define DOT11_WEP40_KEY_SIZE          5  /* Bytes */
#define DOT11_WEP104_KEY_SIZE         13 /* Bytes */
#define DOT11_AES_KEY_SIZE            16 /* Bytes */
#define DOT11_TKIP_KEY_SIZE           32 /* 16 Bytes key, 2x8 bytes MIC */

typedef struct
    {
    DOT11_KEY_TYPE keyType;
    INT32 keySlot;                      /* Keyslot key was installed to  */
    UINT8 macAddr[DOT11_ADDR_LEN];
    union
        {
        UINT8 wep40[DOT11_WEP40_KEY_SIZE];
        UINT8 wep104[DOT11_WEP104_KEY_SIZE];
        UINT8 aes[DOT11_AES_KEY_SIZE];
        UINT8 tkip[DOT11_TKIP_KEY_SIZE];
        } type;
    } DOT11_KEY;

/* This is the length of the pre-shared key for WPA and 802.11i.  */
#define DOT11_PSK_LEN                       64 /* bytes */
typedef UINT8 DOT11_PSK[DOT11_PSK_LEN];


#define DOT11_PASSPHRASE_LEN                63
typedef char DOT11_PASSPHRASE[DOT11_PASSPHRASE_LEN];

#define DOT11_HWVERS_BUF_LEN               256
typedef char DOT11_HWVERS_BUF[DOT11_HWVERS_BUF_LEN];

/****************************************************************************
* DOT11_CAPABILITIES - This is the Capabilities field of Management Frames as
*                      per 7.3.1.4 of IEEE 802.11(2003)
****************************************************************************/
typedef UINT16 DOT11_CAPABILITIES;

#define DOT11_CAP_ISESS                 _BIT(0)
#define DOT11_CAP_ISIBSS                _BIT(1)
#define DOT11_CAP_CFPOLLABLE            _BIT(2)
#define DOT11_CAP_CFPOLLREQ             _BIT(3)
#define DOT11_CAP_PRIVACY               _BIT(4)
#define DOT11_CAP_SHORT_PREAMBLE        _BIT(5)
#define DOT11_CAP_PBCC                  _BIT(6)
#define DOT11_CAP_CHANNEL_AGILITY       _BIT(7)
#define DOT11_CAP_SHORT_TIME_SLOT       _BIT(10)

/****************************************************************************
* DOT11_COUNTRY_CODES  - the list of available country codes that can be passed
*                        to WIOCSCOUNTRYCODE.  More country codes can be found
*                        in ISO 3166, but this is the current list supported 
*                        by the available hardware.
*****************************************************************************/

/* DOT11_COUNTRY_NONE can only be used as a default country on a station.  If
it is set as the default country, then 802.11d MUST be used to find the
current country.  If no country-advertising APs are found, then the station
will not transmit anything */ 

#define DOT11_COUNTRY_NONE                  0       

#define DOT11_COUNTRY_ALBANIA               8       
#define DOT11_COUNTRY_ALGERIA               12      
#define DOT11_COUNTRY_ARGENTINA             32      
#define DOT11_COUNTRY_ARMENIA               51      
#define DOT11_COUNTRY_AUSTRALIA             36      
#define DOT11_COUNTRY_AUSTRIA               40      
#define DOT11_COUNTRY_AZERBAIJAN            31      
#define DOT11_COUNTRY_BAHRAIN               48      
#define DOT11_COUNTRY_BELARUS               112     
#define DOT11_COUNTRY_BELGIUM               56      
#define DOT11_COUNTRY_BELIZE                84      
#define DOT11_COUNTRY_BOLIVIA               68      
#define DOT11_COUNTRY_BRAZIL                76      
#define DOT11_COUNTRY_BRUNEI_DARUSSALAM     96      
#define DOT11_COUNTRY_BULGARIA              100     
#define DOT11_COUNTRY_CANADA                124     
#define DOT11_COUNTRY_CHILE                 152     
#define DOT11_COUNTRY_CHINA                 156     
#define DOT11_COUNTRY_COLOMBIA              170     
#define DOT11_COUNTRY_COSTA_RICA            188     
#define DOT11_COUNTRY_CROATIA               191     
#define DOT11_COUNTRY_CYPRUS                196
#define DOT11_COUNTRY_CZECH                 203     
#define DOT11_COUNTRY_DENMARK               208     
#define DOT11_COUNTRY_DOMINICAN_REPUBLIC    214     
#define DOT11_COUNTRY_ECUADOR               218     
#define DOT11_COUNTRY_EGYPT                 818     
#define DOT11_COUNTRY_EL_SALVADOR           222     
#define DOT11_COUNTRY_ESTONIA               233     
#define DOT11_COUNTRY_FAEROE_ISLANDS        234     
#define DOT11_COUNTRY_FINLAND               246     
#define DOT11_COUNTRY_FRANCE                250     
#define DOT11_COUNTRY_FRANCE2               255     
#define DOT11_COUNTRY_GEORGIA               268     
#define DOT11_COUNTRY_GERMANY               276     
#define DOT11_COUNTRY_GREECE                300     
#define DOT11_COUNTRY_GUATEMALA             320     
#define DOT11_COUNTRY_HONDURAS              340     
#define DOT11_COUNTRY_HONG_KONG             344     
#define DOT11_COUNTRY_HUNGARY               348     
#define DOT11_COUNTRY_ICELAND               352     
#define DOT11_COUNTRY_INDIA                 356     
#define DOT11_COUNTRY_INDONESIA             360     
#define DOT11_COUNTRY_IRAN                  364     
#define DOT11_COUNTRY_IRAQ                  368     
#define DOT11_COUNTRY_IRELAND               372     
#define DOT11_COUNTRY_ISRAEL                376     
#define DOT11_COUNTRY_ITALY                 380     
#define DOT11_COUNTRY_JAMAICA               388     
#define DOT11_COUNTRY_JAPAN                 392     
#define DOT11_COUNTRY_JAPAN1                393     
#define DOT11_COUNTRY_JAPAN2                394     
#define DOT11_COUNTRY_JAPAN3                395     
#define DOT11_COUNTRY_JAPAN4                396     
#define DOT11_COUNTRY_JAPAN5                397     
#define DOT11_COUNTRY_JORDAN                400     
#define DOT11_COUNTRY_KAZAKHSTAN            398     
#define DOT11_COUNTRY_KENYA                 404     
#define DOT11_COUNTRY_KOREA_NORTH           408     
#define DOT11_COUNTRY_KOREA_ROC             410     
#define DOT11_COUNTRY_KOREA_ROC2            411     
#define DOT11_COUNTRY_KUWAIT                414     
#define DOT11_COUNTRY_LATVIA                428     
#define DOT11_COUNTRY_LEBANON               422     
#define DOT11_COUNTRY_LIBYA                 434     
#define DOT11_COUNTRY_LIECHTENSTEIN         438     
#define DOT11_COUNTRY_LITHUANIA             440     
#define DOT11_COUNTRY_LUXEMBOURG            442     
#define DOT11_COUNTRY_MACAU                 446     
#define DOT11_COUNTRY_MACEDONIA             807     
#define DOT11_COUNTRY_MALAYSIA              458     
#define DOT11_COUNTRY_MEXICO                484     
#define DOT11_COUNTRY_MONACO                492     
#define DOT11_COUNTRY_MOROCCO               504     
#define DOT11_COUNTRY_NETHERLANDS           528     
#define DOT11_COUNTRY_NEW_ZEALAND           554     
#define DOT11_COUNTRY_NICARAGUA             558     
#define DOT11_COUNTRY_NORWAY                578     
#define DOT11_COUNTRY_OMAN                  512     
#define DOT11_COUNTRY_PAKISTAN              586     
#define DOT11_COUNTRY_PANAMA                591     
#define DOT11_COUNTRY_PARAGUAY              600     
#define DOT11_COUNTRY_PERU                  604     
#define DOT11_COUNTRY_PHILIPPINES           608     
#define DOT11_COUNTRY_POLAND                616     
#define DOT11_COUNTRY_PORTUGAL              620     
#define DOT11_COUNTRY_PUERTO_RICO           630     
#define DOT11_COUNTRY_QATAR                 634     
#define DOT11_COUNTRY_ROMANIA               642     
#define DOT11_COUNTRY_RUSSIA                643     
#define DOT11_COUNTRY_SAUDI_ARABIA          682     
#define DOT11_COUNTRY_SINGAPORE             702     
#define DOT11_COUNTRY_SLOVAKIA              703     
#define DOT11_COUNTRY_SLOVENIA              705     
#define DOT11_COUNTRY_SOUTH_AFRICA          710     
#define DOT11_COUNTRY_SPAIN                 724     
#define DOT11_COUNTRY_SWEDEN                752     
#define DOT11_COUNTRY_SWITZERLAND           756     
#define DOT11_COUNTRY_SYRIA                 760     
#define DOT11_COUNTRY_TAIWAN                158     
#define DOT11_COUNTRY_THAILAND              764     
#define DOT11_COUNTRY_TRINIDAD_Y_TOBAGO     780     
#define DOT11_COUNTRY_TUNISIA               788     
#define DOT11_COUNTRY_TURKEY                792     
#define DOT11_COUNTRY_UAE                   784     
#define DOT11_COUNTRY_UKRAINE               804     
#define DOT11_COUNTRY_UNITED_KINGDOM        826     
#define DOT11_COUNTRY_UNITED_STATES         840     
#define DOT11_COUNTRY_URUGUAY               858     
#define DOT11_COUNTRY_UZBEKISTAN            860     
#define DOT11_COUNTRY_VENEZUELA             862     
#define DOT11_COUNTRY_VIET_NAM              704