Staging: comedi: remove C99 comments in APCI1710_82x54.c
[linux-2.6] / drivers / staging / rt2860 / sta / sanity.c
1 /*
2  *************************************************************************
3  * Ralink Tech Inc.
4  * 5F., No.36, Taiyuan St., Jhubei City,
5  * Hsinchu County 302,
6  * Taiwan, R.O.C.
7  *
8  * (c) Copyright 2002-2007, Ralink Technology, Inc.
9  *
10  * This program is free software; you can redistribute it and/or modify  *
11  * it under the terms of the GNU General Public License as published by  *
12  * the Free Software Foundation; either version 2 of the License, or     *
13  * (at your option) any later version.                                   *
14  *                                                                       *
15  * This program is distributed in the hope that it will be useful,       *
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
18  * GNU General Public License for more details.                          *
19  *                                                                       *
20  * You should have received a copy of the GNU General Public License     *
21  * along with this program; if not, write to the                         *
22  * Free Software Foundation, Inc.,                                       *
23  * 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
24  *                                                                       *
25  *************************************************************************
26
27         Module Name:
28         sanity.c
29
30         Abstract:
31
32         Revision History:
33         Who                     When                    What
34         --------        ----------              ----------------------------------------------
35         John Chang  2004-09-01      add WMM support
36 */
37 #include "../rt_config.h"
38
39 extern UCHAR    CISCO_OUI[];
40
41 extern UCHAR    WPA_OUI[];
42 extern UCHAR    RSN_OUI[];
43 extern UCHAR    WME_INFO_ELEM[];
44 extern UCHAR    WME_PARM_ELEM[];
45 extern UCHAR    Ccx2QosInfo[];
46 extern UCHAR    RALINK_OUI[];
47 extern UCHAR    BROADCOM_OUI[];
48
49 /*
50     ==========================================================================
51     Description:
52         MLME message sanity check
53     Return:
54         TRUE if all parameters are OK, FALSE otherwise
55     ==========================================================================
56  */
57 BOOLEAN MlmeStartReqSanity(
58     IN PRTMP_ADAPTER pAd,
59     IN VOID *Msg,
60     IN ULONG MsgLen,
61     OUT CHAR Ssid[],
62     OUT UCHAR *pSsidLen)
63 {
64     MLME_START_REQ_STRUCT *Info;
65
66     Info = (MLME_START_REQ_STRUCT *)(Msg);
67
68     if (Info->SsidLen > MAX_LEN_OF_SSID)
69     {
70         DBGPRINT(RT_DEBUG_TRACE, ("MlmeStartReqSanity fail - wrong SSID length\n"));
71         return FALSE;
72     }
73
74     *pSsidLen = Info->SsidLen;
75     NdisMoveMemory(Ssid, Info->Ssid, *pSsidLen);
76
77     return TRUE;
78 }
79
80 /*
81     ==========================================================================
82     Description:
83         MLME message sanity check
84     Return:
85         TRUE if all parameters are OK, FALSE otherwise
86
87     IRQL = DISPATCH_LEVEL
88
89     ==========================================================================
90  */
91 BOOLEAN PeerAssocRspSanity(
92     IN PRTMP_ADAPTER pAd,
93     IN VOID *pMsg,
94     IN ULONG MsgLen,
95     OUT PUCHAR pAddr2,
96     OUT USHORT *pCapabilityInfo,
97     OUT USHORT *pStatus,
98     OUT USHORT *pAid,
99     OUT UCHAR SupRate[],
100     OUT UCHAR *pSupRateLen,
101     OUT UCHAR ExtRate[],
102     OUT UCHAR *pExtRateLen,
103     OUT HT_CAPABILITY_IE                *pHtCapability,
104     OUT ADD_HT_INFO_IE          *pAddHtInfo,    // AP might use this additional ht info IE
105     OUT UCHAR                   *pHtCapabilityLen,
106     OUT UCHAR                   *pAddHtInfoLen,
107     OUT UCHAR                   *pNewExtChannelOffset,
108     OUT PEDCA_PARM pEdcaParm,
109     OUT UCHAR *pCkipFlag)
110 {
111     CHAR          IeType, *Ptr;
112     PFRAME_802_11 pFrame = (PFRAME_802_11)pMsg;
113     PEID_STRUCT   pEid;
114     ULONG         Length = 0;
115
116         *pNewExtChannelOffset = 0xff;
117         *pHtCapabilityLen = 0;
118         *pAddHtInfoLen = 0;
119     COPY_MAC_ADDR(pAddr2, pFrame->Hdr.Addr2);
120     Ptr = pFrame->Octet;
121     Length += LENGTH_802_11;
122
123     NdisMoveMemory(pCapabilityInfo, &pFrame->Octet[0], 2);
124     Length += 2;
125     NdisMoveMemory(pStatus,         &pFrame->Octet[2], 2);
126     Length += 2;
127     *pCkipFlag = 0;
128     *pExtRateLen = 0;
129     pEdcaParm->bValid = FALSE;
130
131     if (*pStatus != MLME_SUCCESS)
132         return TRUE;
133
134     NdisMoveMemory(pAid, &pFrame->Octet[4], 2);
135     Length += 2;
136
137     // Aid already swaped byte order in RTMPFrameEndianChange() for big endian platform
138     *pAid = (*pAid) & 0x3fff; // AID is low 14-bit
139
140     // -- get supported rates from payload and advance the pointer
141     IeType = pFrame->Octet[6];
142     *pSupRateLen = pFrame->Octet[7];
143     if ((IeType != IE_SUPP_RATES) || (*pSupRateLen > MAX_LEN_OF_SUPPORTED_RATES))
144     {
145         DBGPRINT(RT_DEBUG_TRACE, ("PeerAssocRspSanity fail - wrong SupportedRates IE\n"));
146         return FALSE;
147     }
148     else
149         NdisMoveMemory(SupRate, &pFrame->Octet[8], *pSupRateLen);
150
151     Length = Length + 2 + *pSupRateLen;
152
153     // many AP implement proprietary IEs in non-standard order, we'd better
154     // tolerate mis-ordered IEs to get best compatibility
155     pEid = (PEID_STRUCT) &pFrame->Octet[8 + (*pSupRateLen)];
156
157     // get variable fields from payload and advance the pointer
158     while ((Length + 2 + pEid->Len) <= MsgLen)
159     {
160         switch (pEid->Eid)
161         {
162             case IE_EXT_SUPP_RATES:
163                 if (pEid->Len <= MAX_LEN_OF_SUPPORTED_RATES)
164                 {
165                     NdisMoveMemory(ExtRate, pEid->Octet, pEid->Len);
166                     *pExtRateLen = pEid->Len;
167                 }
168                 break;
169
170              case IE_HT_CAP:
171             case IE_HT_CAP2:
172                         if (pEid->Len >= SIZE_HT_CAP_IE)  //Note: allow extension.!!
173                         {
174                                 NdisMoveMemory(pHtCapability, pEid->Octet, SIZE_HT_CAP_IE);
175
176                                 *(USHORT *)(&pHtCapability->HtCapInfo) = cpu2le16(*(USHORT *)(&pHtCapability->HtCapInfo));
177                                 *(USHORT *)(&pHtCapability->ExtHtCapInfo) = cpu2le16(*(USHORT *)(&pHtCapability->ExtHtCapInfo));
178
179                                 *pHtCapabilityLen = SIZE_HT_CAP_IE;
180                         }
181                         else
182                         {
183                                 DBGPRINT(RT_DEBUG_WARN, ("PeerAssocRspSanity - wrong IE_HT_CAP. \n"));
184                         }
185
186                 break;
187 #ifdef DOT11_N_SUPPORT
188             case IE_ADD_HT:
189             case IE_ADD_HT2:
190                         if (pEid->Len >= sizeof(ADD_HT_INFO_IE))
191                         {
192                                 // This IE allows extension, but we can ignore extra bytes beyond our knowledge , so only
193                                 // copy first sizeof(ADD_HT_INFO_IE)
194                                 NdisMoveMemory(pAddHtInfo, pEid->Octet, sizeof(ADD_HT_INFO_IE));
195
196                                 *(USHORT *)(&pAddHtInfo->AddHtInfo2) = cpu2le16(*(USHORT *)(&pAddHtInfo->AddHtInfo2));
197                                 *(USHORT *)(&pAddHtInfo->AddHtInfo3) = cpu2le16(*(USHORT *)(&pAddHtInfo->AddHtInfo3));
198
199                                 *pAddHtInfoLen = SIZE_ADD_HT_INFO_IE;
200                         }
201                         else
202                         {
203                                 DBGPRINT(RT_DEBUG_WARN, ("PeerAssocRspSanity - wrong IE_ADD_HT. \n"));
204                         }
205
206                 break;
207             case IE_SECONDARY_CH_OFFSET:
208                         if (pEid->Len == 1)
209                         {
210                                 *pNewExtChannelOffset = pEid->Octet[0];
211                         }
212                         else
213                         {
214                                 DBGPRINT(RT_DEBUG_WARN, ("PeerAssocRspSanity - wrong IE_SECONDARY_CH_OFFSET. \n"));
215                         }
216 #endif // DOT11_N_SUPPORT //
217                 break;
218             case IE_AIRONET_CKIP:
219                 // 0. Check Aironet IE length, it must be larger or equal to 28
220                 //    Cisco's AP VxWork version(will not be supported) used this IE length as 28
221                 //    Cisco's AP IOS version used this IE length as 30
222                 if (pEid->Len < (CKIP_NEGOTIATION_LENGTH - 2))
223                 break;
224
225                 // 1. Copy CKIP flag byte to buffer for process
226                 *pCkipFlag = *(pEid->Octet + 8);
227                 break;
228
229             case IE_AIRONET_IPADDRESS:
230                 if (pEid->Len != 0x0A)
231                 break;
232
233                 // Get Cisco Aironet IP information
234                 if (NdisEqualMemory(pEid->Octet, CISCO_OUI, 3) == 1)
235                     NdisMoveMemory(pAd->StaCfg.AironetIPAddress, pEid->Octet + 4, 4);
236                 break;
237
238             // CCX2, WMM use the same IE value
239             // case IE_CCX_V2:
240             case IE_VENDOR_SPECIFIC:
241                 // handle WME PARAMTER ELEMENT
242                 if (NdisEqualMemory(pEid->Octet, WME_PARM_ELEM, 6) && (pEid->Len == 24))
243                 {
244                     PUCHAR ptr;
245                     int i;
246
247                     // parsing EDCA parameters
248                     pEdcaParm->bValid          = TRUE;
249                     pEdcaParm->bQAck           = FALSE; // pEid->Octet[0] & 0x10;
250                     pEdcaParm->bQueueRequest   = FALSE; // pEid->Octet[0] & 0x20;
251                     pEdcaParm->bTxopRequest    = FALSE; // pEid->Octet[0] & 0x40;
252                     //pEdcaParm->bMoreDataAck    = FALSE; // pEid->Octet[0] & 0x80;
253                     pEdcaParm->EdcaUpdateCount = pEid->Octet[6] & 0x0f;
254                     pEdcaParm->bAPSDCapable    = (pEid->Octet[6] & 0x80) ? 1 : 0;
255                     ptr = &pEid->Octet[8];
256                     for (i=0; i<4; i++)
257                     {
258                         UCHAR aci = (*ptr & 0x60) >> 5; // b5~6 is AC INDEX
259                         pEdcaParm->bACM[aci]  = (((*ptr) & 0x10) == 0x10);   // b5 is ACM
260                         pEdcaParm->Aifsn[aci] = (*ptr) & 0x0f;               // b0~3 is AIFSN
261                         pEdcaParm->Cwmin[aci] = *(ptr+1) & 0x0f;             // b0~4 is Cwmin
262                         pEdcaParm->Cwmax[aci] = *(ptr+1) >> 4;               // b5~8 is Cwmax
263                         pEdcaParm->Txop[aci]  = *(ptr+2) + 256 * (*(ptr+3)); // in unit of 32-us
264                         ptr += 4; // point to next AC
265                     }
266                 }
267
268                 // handle CCX IE
269                 else
270                 {
271                     // 0. Check the size and CCX admin control
272                     if (pAd->StaCfg.CCXControl.field.Enable == 0)
273                         break;
274                     if (pEid->Len != 5)
275                         break;
276
277                     // Turn CCX2 if matched
278                     if (NdisEqualMemory(pEid->Octet, Ccx2IeInfo, 5) == 1)
279                         pAd->StaCfg.CCXEnable = TRUE;
280                     break;
281                 }
282                 break;
283
284             default:
285                 DBGPRINT(RT_DEBUG_TRACE, ("PeerAssocRspSanity - ignore unrecognized EID = %d\n", pEid->Eid));
286                 break;
287         }
288
289         Length = Length + 2 + pEid->Len;
290         pEid = (PEID_STRUCT)((UCHAR*)pEid + 2 + pEid->Len);
291     }
292
293     // Force CCX2 enable to TRUE for those AP didn't replay CCX v2 IE, we still force it to be on
294     if (pAd->StaCfg.CCXControl.field.Enable == 1)
295         pAd->StaCfg.CCXEnable = TRUE;
296
297     return TRUE;
298 }
299
300 /*
301     ==========================================================================
302     Description:
303         MLME message sanity check
304     Return:
305         TRUE if all parameters are OK, FALSE otherwise
306
307         IRQL = DISPATCH_LEVEL
308
309     ==========================================================================
310  */
311 BOOLEAN PeerProbeReqSanity(
312     IN PRTMP_ADAPTER pAd,
313     IN VOID *Msg,
314     IN ULONG MsgLen,
315     OUT PUCHAR pAddr2,
316     OUT CHAR Ssid[],
317     OUT UCHAR *pSsidLen)
318 {
319     UCHAR         Idx;
320     UCHAR             RateLen;
321     CHAR          IeType;
322     PFRAME_802_11 pFrame = (PFRAME_802_11)Msg;
323
324     COPY_MAC_ADDR(pAddr2, pFrame->Hdr.Addr2);
325
326     if ((pFrame->Octet[0] != IE_SSID) || (pFrame->Octet[1] > MAX_LEN_OF_SSID))
327     {
328         DBGPRINT(RT_DEBUG_TRACE, ("PeerProbeReqSanity fail - wrong SSID IE(Type=%d,Len=%d)\n",pFrame->Octet[0],pFrame->Octet[1]));
329         return FALSE;
330     }
331
332     *pSsidLen = pFrame->Octet[1];
333     NdisMoveMemory(Ssid, &pFrame->Octet[2], *pSsidLen);
334
335     Idx = *pSsidLen + 2;
336
337     // -- get supported rates from payload and advance the pointer
338     IeType = pFrame->Octet[Idx];
339     RateLen = pFrame->Octet[Idx + 1];
340     if (IeType != IE_SUPP_RATES)
341     {
342         DBGPRINT(RT_DEBUG_TRACE, ("PeerProbeReqSanity fail - wrong SupportRates IE(Type=%d,Len=%d)\n",pFrame->Octet[Idx],pFrame->Octet[Idx+1]));
343         return FALSE;
344     }
345     else
346     {
347         if ((pAd->CommonCfg.PhyMode == PHY_11G) && (RateLen < 8))
348             return (FALSE);
349     }
350
351     return TRUE;
352 }
353
354 /*
355     ==========================================================================
356     Description:
357
358         IRQL = DISPATCH_LEVEL
359
360     ==========================================================================
361  */
362 BOOLEAN GetTimBit(
363     IN CHAR *Ptr,
364     IN USHORT Aid,
365     OUT UCHAR *TimLen,
366     OUT UCHAR *BcastFlag,
367     OUT UCHAR *DtimCount,
368     OUT UCHAR *DtimPeriod,
369     OUT UCHAR *MessageToMe)
370 {
371     UCHAR          BitCntl, N1, N2, MyByte, MyBit;
372     CHAR          *IdxPtr;
373
374     IdxPtr = Ptr;
375
376     IdxPtr ++;
377     *TimLen = *IdxPtr;
378
379     // get DTIM Count from TIM element
380     IdxPtr ++;
381     *DtimCount = *IdxPtr;
382
383     // get DTIM Period from TIM element
384     IdxPtr++;
385     *DtimPeriod = *IdxPtr;
386
387     // get Bitmap Control from TIM element
388     IdxPtr++;
389     BitCntl = *IdxPtr;
390
391     if ((*DtimCount == 0) && (BitCntl & 0x01))
392         *BcastFlag = TRUE;
393     else
394         *BcastFlag = FALSE;
395
396     // Parse Partial Virtual Bitmap from TIM element
397     N1 = BitCntl & 0xfe;    // N1 is the first bitmap byte#
398     N2 = *TimLen - 4 + N1;  // N2 is the last bitmap byte#
399
400     if ((Aid < (N1 << 3)) || (Aid >= ((N2 + 1) << 3)))
401         *MessageToMe = FALSE;
402     else
403     {
404         MyByte = (Aid >> 3) - N1;                       // my byte position in the bitmap byte-stream
405         MyBit = Aid % 16 - ((MyByte & 0x01)? 8:0);
406
407         IdxPtr += (MyByte + 1);
408
409         //if (*IdxPtr)
410         //    DBGPRINT(RT_DEBUG_WARN, ("TIM bitmap = 0x%02x\n", *IdxPtr));
411
412         if (*IdxPtr & (0x01 << MyBit))
413             *MessageToMe = TRUE;
414         else
415             *MessageToMe = FALSE;
416     }
417
418     return TRUE;
419 }
420