drivers/staging/vt6656/80211hdr.h

   1 /*
   2  * Copyright (c) 1996, 2003 VIA Networking Technologies, Inc.
   3  * All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * File: 80211hdr.h
  20  *
  21  * Purpose: 802.11 MAC headers related pre-defines and macros.
  22  *
  23  * Author: Lyndon Chen
  24  *
  25  * Date: Apr 8, 2002
  26  */
  27
  28 #ifndef __80211HDR_H__
  29 #define __80211HDR_H__
  30
  31 #include "ttype.h"
  32
  33 /*---------------------  Export Definitions -------------------------*/
  34
  35 /* bit type */
  36 #define BIT0    0x00000001
  37 #define BIT1    0x00000002
  38 #define BIT2    0x00000004
  39 #define BIT3    0x00000008
  40 #define BIT4    0x00000010
  41 #define BIT5    0x00000020
  42 #define BIT6    0x00000040
  43 #define BIT7    0x00000080
  44 #define BIT8    0x00000100
  45 #define BIT9    0x00000200
  46 #define BIT10   0x00000400
  47 #define BIT11   0x00000800
  48 #define BIT12   0x00001000
  49 #define BIT13   0x00002000
  50 #define BIT14   0x00004000
  51 #define BIT15   0x00008000
  52 #define BIT16   0x00010000
  53 #define BIT17   0x00020000
  54 #define BIT18   0x00040000
  55 #define BIT19   0x00080000
  56 #define BIT20   0x00100000
  57 #define BIT21   0x00200000
  58 #define BIT22   0x00400000
  59 #define BIT23   0x00800000
  60 #define BIT24   0x01000000
  61 #define BIT25   0x02000000
  62 #define BIT26   0x04000000
  63 #define BIT27   0x08000000
  64 #define BIT28   0x10000000
  65 #define BIT29   0x20000000
  66 #define BIT30   0x40000000
  67 #define BIT31   0x80000000
  68
  69 /* 802.11 frame related, defined as 802.11 spec */
  70 #define WLAN_ADDR_LEN               6
  71 #define WLAN_CRC_LEN                4
  72 #define WLAN_CRC32_LEN              4
  73 #define WLAN_FCS_LEN                4
  74 #define WLAN_BSSID_LEN              6
  75 #define WLAN_BSS_TS_LEN             8
  76 #define WLAN_HDR_ADDR2_LEN          16
  77 #define WLAN_HDR_ADDR3_LEN          24
  78 #define WLAN_HDR_ADDR4_LEN          30
  79 #define WLAN_IEHDR_LEN              2
  80 #define WLAN_SSID_MAXLEN            32
  81 /* #define WLAN_RATES_MAXLEN           255 */
  82 #define WLAN_RATES_MAXLEN           16
  83 #define WLAN_RATES_MAXLEN_11B       4
  84 #define WLAN_RSN_MAXLEN             32
  85 #define WLAN_DATA_MAXLEN            2312
  86 #define WLAN_A3FR_MAXLEN            (WLAN_HDR_ADDR3_LEN \
  87                                      + WLAN_DATA_MAXLEN \
  88                                      + WLAN_CRC_LEN)
  89
  90 #define WLAN_BEACON_FR_MAXLEN       WLAN_A3FR_MAXLEN
  91 #define WLAN_ATIM_FR_MAXLEN         (WLAN_HDR_ADDR3_LEN + 0)
  92 #define WLAN_NULLDATA_FR_MAXLEN     (WLAN_HDR_ADDR3_LEN + 0)
  93 #define WLAN_DISASSOC_FR_MAXLEN     (WLAN_HDR_ADDR3_LEN + 2)
  94 #define WLAN_ASSOCREQ_FR_MAXLEN     WLAN_A3FR_MAXLEN
  95 #define WLAN_ASSOCRESP_FR_MAXLEN    WLAN_A3FR_MAXLEN
  96 #define WLAN_REASSOCREQ_FR_MAXLEN   WLAN_A3FR_MAXLEN
  97 #define WLAN_REASSOCRESP_FR_MAXLEN  WLAN_A3FR_MAXLEN
  98 #define WLAN_PROBEREQ_FR_MAXLEN     WLAN_A3FR_MAXLEN
  99 #define WLAN_PROBERESP_FR_MAXLEN    WLAN_A3FR_MAXLEN
 100 #define WLAN_AUTHEN_FR_MAXLEN       WLAN_A3FR_MAXLEN
 101 #define WLAN_DEAUTHEN_FR_MAXLEN     (WLAN_HDR_ADDR3_LEN + 2)
 102
 103 #define WLAN_WEP_NKEYS              4
 104 #define WLAN_WEP40_KEYLEN           5
 105 #define WLAN_WEP104_KEYLEN          13
 106 #define WLAN_WEP232_KEYLEN          29
 107 /* #define WLAN_WEPMAX_KEYLEN          29 */
 108 #define WLAN_WEPMAX_KEYLEN          32
 109 #define WLAN_CHALLENGE_IE_MAXLEN    255
 110 #define WLAN_CHALLENGE_IE_LEN       130
 111 #define WLAN_CHALLENGE_LEN          128
 112 #define WLAN_WEP_IV_LEN             4
 113 #define WLAN_WEP_ICV_LEN            4
 114 #define WLAN_FRAGS_MAX              16
 115
 116 /* Frame Type */
 117 #define WLAN_TYPE_MGR 0x00
 118 #define WLAN_TYPE_CTL  0x01
 119 #define WLAN_TYPE_DATA 0x02
 120
 121 #define WLAN_FTYPE_MGMT 0x00
 122 #define WLAN_FTYPE_CTL  0x01
 123 #define WLAN_FTYPE_DATA 0x02
 124
 125 /* Frame Subtypes */
 126 #define WLAN_FSTYPE_ASSOCREQ        0x00
 127 #define WLAN_FSTYPE_ASSOCRESP       0x01
 128 #define WLAN_FSTYPE_REASSOCREQ      0x02
 129 #define WLAN_FSTYPE_REASSOCRESP     0x03
 130 #define WLAN_FSTYPE_PROBEREQ        0x04
 131 #define WLAN_FSTYPE_PROBERESP       0x05
 132 #define WLAN_FSTYPE_BEACON          0x08
 133 #define WLAN_FSTYPE_ATIM            0x09
 134 #define WLAN_FSTYPE_DISASSOC        0x0a
 135 #define WLAN_FSTYPE_AUTHEN          0x0b
 136 #define WLAN_FSTYPE_DEAUTHEN        0x0c
 137 #define WLAN_FSTYPE_ACTION          0x0d
 138
 139 /* Control */
 140 #define WLAN_FSTYPE_PSPOLL          0x0a
 141 #define WLAN_FSTYPE_RTS             0x0b
 142 #define WLAN_FSTYPE_CTS             0x0c
 143 #define WLAN_FSTYPE_ACK             0x0d
 144 #define WLAN_FSTYPE_CFEND           0x0e
 145 #define WLAN_FSTYPE_CFENDCFACK      0x0f
 146
 147 /* Data */
 148 #define WLAN_FSTYPE_DATAONLY        0x00
 149 #define WLAN_FSTYPE_DATA_CFACK      0x01
 150 #define WLAN_FSTYPE_DATA_CFPOLL     0x02
 151 #define WLAN_FSTYPE_DATA_CFACK_CFPOLL   0x03
 152 #define WLAN_FSTYPE_NULL            0x04
 153 #define WLAN_FSTYPE_CFACK           0x05
 154 #define WLAN_FSTYPE_CFPOLL          0x06
 155 #define WLAN_FSTYPE_CFACK_CFPOLL    0x07
 156
 157 #ifdef __BIG_ENDIAN
 158
 159 /* GET & SET Frame Control bit */
 160 #define WLAN_GET_FC_PRVER(n)    ((((WORD)(n) >> 8) & (BIT0 | BIT1))
 161 #define WLAN_GET_FC_FTYPE(n)    ((((WORD)(n) >> 8) & (BIT2 | BIT3)) >> 2)
 162 #define WLAN_GET_FC_FSTYPE(n)   ((((WORD)(n) >> 8) \
 163                                   & (BIT4|BIT5|BIT6|BIT7)) >> 4)
 164 #define WLAN_GET_FC_TODS(n)     ((((WORD)(n) << 8) & (BIT8)) >> 8)
 165 #define WLAN_GET_FC_FROMDS(n)   ((((WORD)(n) << 8) & (BIT9)) >> 9)
 166 #define WLAN_GET_FC_MOREFRAG(n) ((((WORD)(n) << 8) & (BIT10)) >> 10)
 167 #define WLAN_GET_FC_RETRY(n)    ((((WORD)(n) << 8) & (BIT11)) >> 11)
 168 #define WLAN_GET_FC_PWRMGT(n)   ((((WORD)(n) << 8) & (BIT12)) >> 12)
 169 #define WLAN_GET_FC_MOREDATA(n) ((((WORD)(n) << 8) & (BIT13)) >> 13)
 170 #define WLAN_GET_FC_ISWEP(n)    ((((WORD)(n) << 8) & (BIT14)) >> 14)
 171 #define WLAN_GET_FC_ORDER(n)    ((((WORD)(n) << 8) & (BIT15)) >> 15)
 172
 173 /* Sequence Field bit */
 174 #define WLAN_GET_SEQ_FRGNUM(n) (((WORD)(n) >> 8) & (BIT0|BIT1|BIT2|BIT3))
 175 #define WLAN_GET_SEQ_SEQNUM(n) ((((WORD)(n) >> 8) \
 176                                  & (~(BIT0|BIT1|BIT2|BIT3))) >> 4)
 177
 178 /* Capability Field bit */
 179 #define WLAN_GET_CAP_INFO_ESS(n)           (((n) >> 8) & BIT0)
 180 #define WLAN_GET_CAP_INFO_IBSS(n)          ((((n) >> 8) & BIT1) >> 1)
 181 #define WLAN_GET_CAP_INFO_CFPOLLABLE(n)    ((((n) >> 8) & BIT2) >> 2)
 182 #define WLAN_GET_CAP_INFO_CFPOLLREQ(n)     ((((n) >> 8) & BIT3) >> 3)
 183 #define WLAN_GET_CAP_INFO_PRIVACY(n)       ((((n) >> 8) & BIT4) >> 4)
 184 #define WLAN_GET_CAP_INFO_SHORTPREAMBLE(n) ((((n) >> 8) & BIT5) >> 5)
 185 #define WLAN_GET_CAP_INFO_PBCC(n)          ((((n) >> 8) & BIT6) >> 6)
 186 #define WLAN_GET_CAP_INFO_AGILITY(n)       ((((n) >> 8) & BIT7) >> 7)
 187 #define WLAN_GET_CAP_INFO_SPECTRUMMNG(n)   ((((n))      & BIT8) >> 10)
 188 #define WLAN_GET_CAP_INFO_SHORTSLOTTIME(n) ((((n))      & BIT10) >> 10)
 189 #define WLAN_GET_CAP_INFO_DSSSOFDM(n)      ((((n))      & BIT13) >> 13)
 190 #define WLAN_GET_CAP_INFO_GRPACK(n)        ((((n))      & BIT14) >> 14)
 191
 192 #else
 193
 194 /* GET & SET Frame Control bit */
 195 #define WLAN_GET_FC_PRVER(n)    (((WORD)(n)) & (BIT0 | BIT1))
 196 #define WLAN_GET_FC_FTYPE(n)    ((((WORD)(n)) & (BIT2 | BIT3)) >> 2)
 197 #define WLAN_GET_FC_FSTYPE(n)   ((((WORD)(n)) & (BIT4|BIT5|BIT6|BIT7)) >> 4)
 198 #define WLAN_GET_FC_TODS(n)     ((((WORD)(n)) & (BIT8)) >> 8)
 199 #define WLAN_GET_FC_FROMDS(n)   ((((WORD)(n)) & (BIT9)) >> 9)
 200 #define WLAN_GET_FC_MOREFRAG(n) ((((WORD)(n)) & (BIT10)) >> 10)
 201 #define WLAN_GET_FC_RETRY(n)    ((((WORD)(n)) & (BIT11)) >> 11)
 202 #define WLAN_GET_FC_PWRMGT(n)   ((((WORD)(n)) & (BIT12)) >> 12)
 203 #define WLAN_GET_FC_MOREDATA(n) ((((WORD)(n)) & (BIT13)) >> 13)
 204 #define WLAN_GET_FC_ISWEP(n)    ((((WORD)(n)) & (BIT14)) >> 14)
 205 #define WLAN_GET_FC_ORDER(n)    ((((WORD)(n)) & (BIT15)) >> 15)
 206
 207 /* Sequence Field bit */
 208 #define WLAN_GET_SEQ_FRGNUM(n) (((WORD)(n)) & (BIT0|BIT1|BIT2|BIT3))
 209 #define WLAN_GET_SEQ_SEQNUM(n) ((((WORD)(n)) & (~(BIT0|BIT1|BIT2|BIT3))) >> 4)
 210
 211 /* Capability Field bit */
 212 #define WLAN_GET_CAP_INFO_ESS(n)           ((n) & BIT0)
 213 #define WLAN_GET_CAP_INFO_IBSS(n)          (((n) & BIT1) >> 1)
 214 #define WLAN_GET_CAP_INFO_CFPOLLABLE(n)    (((n) & BIT2) >> 2)
 215 #define WLAN_GET_CAP_INFO_CFPOLLREQ(n)     (((n) & BIT3) >> 3)
 216 #define WLAN_GET_CAP_INFO_PRIVACY(n)       (((n) & BIT4) >> 4)
 217 #define WLAN_GET_CAP_INFO_SHORTPREAMBLE(n) (((n) & BIT5) >> 5)
 218 #define WLAN_GET_CAP_INFO_PBCC(n)          (((n) & BIT6) >> 6)
 219 #define WLAN_GET_CAP_INFO_AGILITY(n)       (((n) & BIT7) >> 7)
 220 #define WLAN_GET_CAP_INFO_SPECTRUMMNG(n)   (((n) & BIT8) >> 10)
 221 #define WLAN_GET_CAP_INFO_SHORTSLOTTIME(n) (((n) & BIT10) >> 10)
 222 #define WLAN_GET_CAP_INFO_DSSSOFDM(n)      (((n) & BIT13) >> 13)
 223 #define WLAN_GET_CAP_INFO_GRPACK(n)        (((n) & BIT14) >> 14)
 224
 225 #endif /* #ifdef __BIG_ENDIAN */
 226
 227 #define WLAN_SET_CAP_INFO_ESS(n)           (n)
 228 #define WLAN_SET_CAP_INFO_IBSS(n)          ((n) << 1)
 229 #define WLAN_SET_CAP_INFO_CFPOLLABLE(n)    ((n) << 2)
 230 #define WLAN_SET_CAP_INFO_CFPOLLREQ(n)     ((n) << 3)
 231 #define WLAN_SET_CAP_INFO_PRIVACY(n)       ((n) << 4)
 232 #define WLAN_SET_CAP_INFO_SHORTPREAMBLE(n) ((n) << 5)
 233 #define WLAN_SET_CAP_INFO_SPECTRUMMNG(n)   ((n) << 8)
 234 #define WLAN_SET_CAP_INFO_PBCC(n)          ((n) << 6)
 235 #define WLAN_SET_CAP_INFO_AGILITY(n)       ((n) << 7)
 236 #define WLAN_SET_CAP_INFO_SHORTSLOTTIME(n) ((n) << 10)
 237 #define WLAN_SET_CAP_INFO_DSSSOFDM(n)      ((n) << 13)
 238 #define WLAN_SET_CAP_INFO_GRPACK(n)        ((n) << 14)
 239
 240 #define WLAN_SET_FC_PRVER(n)    ((WORD)(n))
 241 #define WLAN_SET_FC_FTYPE(n)    (((WORD)(n)) << 2)
 242 #define WLAN_SET_FC_FSTYPE(n)   (((WORD)(n)) << 4)
 243 #define WLAN_SET_FC_TODS(n)     (((WORD)(n)) << 8)
 244 #define WLAN_SET_FC_FROMDS(n)   (((WORD)(n)) << 9)
 245 #define WLAN_SET_FC_MOREFRAG(n) (((WORD)(n)) << 10)
 246 #define WLAN_SET_FC_RETRY(n)    (((WORD)(n)) << 11)
 247 #define WLAN_SET_FC_PWRMGT(n)   (((WORD)(n)) << 12)
 248 #define WLAN_SET_FC_MOREDATA(n) (((WORD)(n)) << 13)
 249 #define WLAN_SET_FC_ISWEP(n)    (((WORD)(n)) << 14)
 250 #define WLAN_SET_FC_ORDER(n)    (((WORD)(n)) << 15)
 251
 252 #define WLAN_SET_SEQ_FRGNUM(n) ((WORD)(n))
 253 #define WLAN_SET_SEQ_SEQNUM(n) (((WORD)(n)) << 4)
 254
 255 /* ERP Field bit */
 256
 257 #define WLAN_GET_ERP_NONERP_PRESENT(n)     ((n) & BIT0)
 258 #define WLAN_GET_ERP_USE_PROTECTION(n)     (((n) & BIT1) >> 1)
 259 #define WLAN_GET_ERP_BARKER_MODE(n)        (((n) & BIT2) >> 2)
 260
 261 #define WLAN_SET_ERP_NONERP_PRESENT(n)     (n)
 262 #define WLAN_SET_ERP_USE_PROTECTION(n)     ((n) << 1)
 263 #define WLAN_SET_ERP_BARKER_MODE(n)        ((n) << 2)
 264
 265 /* Support & Basic Rates field */
 266 #define WLAN_MGMT_IS_BASICRATE(b)    ((b) & BIT7)
 267 #define WLAN_MGMT_GET_RATE(b)        ((b) & ~BIT7)
 268
 269 /* TIM field */
 270 #define WLAN_MGMT_IS_MULTICAST_TIM(b)   ((b) & BIT0)
 271 #define WLAN_MGMT_GET_TIM_OFFSET(b)     (((b) & ~BIT0) >> 1)
 272
 273 /* 3-Addr & 4-Addr */
 274 #define WLAN_HDR_A3_DATA_PTR(p) (((PBYTE)(p)) + WLAN_HDR_ADDR3_LEN)
 275 #define WLAN_HDR_A4_DATA_PTR(p) (((PBYTE)(p)) + WLAN_HDR_ADDR4_LEN)
 276
 277 /* IEEE ADDR */
 278 #define IEEE_ADDR_UNIVERSAL         0x02
 279 #define IEEE_ADDR_GROUP             0x01
 280
 281 typedef struct {
 282     BYTE            abyAddr[6];
 283 } IEEE_ADDR, *PIEEE_ADDR;
 284
 285 /* 802.11 Header Format */
 286
 287 typedef struct tagWLAN_80211HDR_A2 {
 288
 289     WORD    wFrameCtl;
 290     WORD    wDurationID;
 291     BYTE    abyAddr1[WLAN_ADDR_LEN];
 292     BYTE    abyAddr2[WLAN_ADDR_LEN];
 293
 294 } __attribute__ ((__packed__))
 295 WLAN_80211HDR_A2, *PWLAN_80211HDR_A2;
 296
 297 typedef struct tagWLAN_80211HDR_A3 {
 298
 299     WORD    wFrameCtl;
 300     WORD    wDurationID;
 301     BYTE    abyAddr1[WLAN_ADDR_LEN];
 302     BYTE    abyAddr2[WLAN_ADDR_LEN];
 303     BYTE    abyAddr3[WLAN_ADDR_LEN];
 304     WORD    wSeqCtl;
 305
 306 } __attribute__ ((__packed__))
 307 WLAN_80211HDR_A3, *PWLAN_80211HDR_A3;
 308
 309 typedef struct tagWLAN_80211HDR_A4 {
 310
 311     WORD    wFrameCtl;
 312     WORD    wDurationID;
 313     BYTE    abyAddr1[WLAN_ADDR_LEN];
 314     BYTE    abyAddr2[WLAN_ADDR_LEN];
 315     BYTE    abyAddr3[WLAN_ADDR_LEN];
 316     WORD    wSeqCtl;
 317     BYTE    abyAddr4[WLAN_ADDR_LEN];
 318
 319 } __attribute__ ((__packed__))
 320 WLAN_80211HDR_A4, *PWLAN_80211HDR_A4;
 321
 322 typedef union tagUWLAN_80211HDR {
 323
 324     WLAN_80211HDR_A2        sA2;
 325     WLAN_80211HDR_A3        sA3;
 326     WLAN_80211HDR_A4        sA4;
 327
 328 } UWLAN_80211HDR, *PUWLAN_80211HDR;
 329
 330 /*---------------------  Export Classes  ----------------------------*/
 331
 332 /*---------------------  Export Variables  --------------------------*/
 333
 334 /*---------------------  Export Functions  --------------------------*/
 335
 336 #endif /* __80211HDR_H__ */