drivers/staging/rt2870/ap.h

   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     ap.h
  29
  30     Abstract:
  31     Miniport generic portion header file
  32
  33     Revision History:
  34     Who         When          What
  35     --------    ----------    ----------------------------------------------
  36     Paul Lin    08-01-2002    created
  37     James Tan   09-06-2002    modified (Revise NTCRegTable)
  38     John Chang  12-22-2004    modified for RT2561/2661. merge with STA driver
  39 */
  40 #ifndef __AP_H__
  41 #define __AP_H__
  42
  43
  44
  45 // ========================= AP RTMP.h ================================
  46
  47
  48
  49 // =============================================================
  50 //      Function Prototypes
  51 // =============================================================
  52
  53 // ap_data.c
  54
  55 BOOLEAN APBridgeToWirelessSta(
  56     IN  PRTMP_ADAPTER   pAd,
  57     IN  PUCHAR          pHeader,
  58     IN  UINT            HdrLen,
  59     IN  PUCHAR          pData,
  60     IN  UINT            DataLen,
  61     IN  ULONG           fromwdsidx);
  62
  63 BOOLEAN APHandleRxDoneInterrupt(
  64     IN  PRTMP_ADAPTER   pAd);
  65
  66 VOID    APSendPackets(
  67         IN      NDIS_HANDLE             MiniportAdapterContext,
  68         IN      PPNDIS_PACKET   ppPacketArray,
  69         IN      UINT                    NumberOfPackets);
  70
  71 NDIS_STATUS APSendPacket(
  72     IN  PRTMP_ADAPTER   pAd,
  73     IN  PNDIS_PACKET    pPacket);
  74
  75
  76 NDIS_STATUS APHardTransmit(
  77         IN      PRTMP_ADAPTER   pAd,
  78         IN      TX_BLK                  *pTxBlk,
  79         IN      UCHAR                   QueIdx);
  80
  81 VOID APRxEAPOLFrameIndicate(
  82         IN      PRTMP_ADAPTER   pAd,
  83         IN      MAC_TABLE_ENTRY *pEntry,
  84         IN      RX_BLK                  *pRxBlk,
  85         IN      UCHAR                   FromWhichBSSID);
  86
  87 NDIS_STATUS APCheckRxError(
  88         IN      PRTMP_ADAPTER   pAd,
  89         IN      PRT28XX_RXD_STRUC               pRxD,
  90         IN      UCHAR                   Wcid);
  91
  92 BOOLEAN APCheckClass2Class3Error(
  93     IN  PRTMP_ADAPTER   pAd,
  94         IN ULONG Wcid,
  95         IN  PHEADER_802_11  pHeader);
  96
  97 VOID APHandleRxPsPoll(
  98         IN      PRTMP_ADAPTER   pAd,
  99         IN      PUCHAR                  pAddr,
 100         IN      USHORT                  Aid,
 101     IN  BOOLEAN                 isActive);
 102
 103 VOID    RTMPDescriptorEndianChange(
 104     IN  PUCHAR          pData,
 105     IN  ULONG           DescriptorType);
 106
 107 VOID    RTMPFrameEndianChange(
 108     IN  PRTMP_ADAPTER   pAd,
 109     IN  PUCHAR          pData,
 110     IN  ULONG           Dir,
 111     IN  BOOLEAN         FromRxDoneInt);
 112
 113 // ap_assoc.c
 114
 115 VOID APAssocStateMachineInit(
 116     IN  PRTMP_ADAPTER   pAd,
 117     IN  STATE_MACHINE *S,
 118     OUT STATE_MACHINE_FUNC Trans[]);
 119
 120 VOID  APPeerAssocReqAction(
 121     IN  PRTMP_ADAPTER   pAd,
 122     IN  MLME_QUEUE_ELEM *Elem);
 123
 124 VOID  APPeerReassocReqAction(
 125     IN  PRTMP_ADAPTER   pAd,
 126     IN  MLME_QUEUE_ELEM *Elem);
 127
 128 VOID  APPeerDisassocReqAction(
 129     IN  PRTMP_ADAPTER   pAd,
 130     IN  MLME_QUEUE_ELEM *Elem);
 131
 132 VOID MbssKickOutStas(
 133         IN PRTMP_ADAPTER pAd,
 134         IN INT apidx,
 135         IN USHORT Reason);
 136
 137 VOID APMlmeKickOutSta(
 138     IN PRTMP_ADAPTER pAd,
 139         IN PUCHAR pStaAddr,
 140         IN UCHAR Wcid,
 141         IN USHORT Reason);
 142
 143 VOID APMlmeDisassocReqAction(
 144     IN PRTMP_ADAPTER pAd,
 145     IN MLME_QUEUE_ELEM *Elem);
 146
 147 VOID  APCls3errAction(
 148     IN  PRTMP_ADAPTER   pAd,
 149         IN      ULONG Wcid,
 150     IN  PHEADER_802_11  pHeader);
 151
 152
 153 USHORT APBuildAssociation(
 154     IN PRTMP_ADAPTER pAd,
 155     IN MAC_TABLE_ENTRY *pEntry,
 156     IN USHORT CapabilityInfo,
 157     IN UCHAR  MaxSupportedRateIn500Kbps,
 158     IN UCHAR  *RSN,
 159     IN UCHAR  *pRSNLen,
 160     IN BOOLEAN bWmmCapable,
 161     IN ULONG  RalinkIe,
 162 #ifdef DOT11N_DRAFT3
 163     IN EXT_CAP_INFO_ELEMENT ExtCapInfo,
 164 #endif // DOT11N_DRAFT3 //
 165         IN HT_CAPABILITY_IE             *pHtCapability,
 166         IN UCHAR                 HtCapabilityLen,
 167     OUT USHORT *pAid);
 168
 169 /*
 170 VOID    RTMPAddClientSec(
 171         IN      PRTMP_ADAPTER   pAd,
 172         IN      UCHAR   BssIdx,
 173         IN UCHAR                 KeyIdx,
 174         IN UCHAR                 CipherAlg,
 175         IN PUCHAR                pKey,
 176         IN PUCHAR                pTxMic,
 177         IN PUCHAR                pRxMic,
 178         IN MAC_TABLE_ENTRY *pEntry);
 179 */
 180
 181 // ap_auth.c
 182
 183 void APAuthStateMachineInit(
 184     IN PRTMP_ADAPTER pAd,
 185     IN STATE_MACHINE *Sm,
 186     OUT STATE_MACHINE_FUNC Trans[]);
 187
 188 VOID APMlmeDeauthReqAction(
 189     IN PRTMP_ADAPTER pAd,
 190     IN MLME_QUEUE_ELEM *Elem);
 191
 192 VOID APCls2errAction(
 193     IN PRTMP_ADAPTER pAd,
 194         IN      ULONG Wcid,
 195     IN  PHEADER_802_11  pHeader);
 196
 197 // ap_authrsp.c
 198
 199 VOID APAuthRspStateMachineInit(
 200     IN PRTMP_ADAPTER pAd,
 201     IN PSTATE_MACHINE Sm,
 202     IN STATE_MACHINE_FUNC Trans[]);
 203
 204 VOID APPeerAuthAtAuthRspIdleAction(
 205     IN  PRTMP_ADAPTER   pAd,
 206     IN  MLME_QUEUE_ELEM *Elem);
 207
 208 VOID APPeerDeauthReqAction(
 209     IN PRTMP_ADAPTER    pAd,
 210     IN MLME_QUEUE_ELEM *Elem);
 211
 212 VOID APPeerAuthSimpleRspGenAndSend(
 213     IN  PRTMP_ADAPTER   pAd,
 214     IN  PHEADER_802_11 pHdr80211,
 215     IN  USHORT Alg,
 216     IN  USHORT Seq,
 217     IN  USHORT StatusCode);
 218
 219 // ap_connect.c
 220
 221 BOOLEAN BeaconTransmitRequired(
 222         IN PRTMP_ADAPTER        pAd,
 223         IN INT                          apidx);
 224
 225 VOID APMakeBssBeacon(
 226     IN  PRTMP_ADAPTER   pAd,
 227         IN      INT                             apidx);
 228
 229 VOID  APUpdateBeaconFrame(
 230     IN  PRTMP_ADAPTER   pAd,
 231         IN      INT                             apidx);
 232
 233 VOID APMakeAllBssBeacon(
 234     IN  PRTMP_ADAPTER   pAd);
 235
 236 VOID  APUpdateAllBeaconFrame(
 237     IN  PRTMP_ADAPTER   pAd);
 238
 239
 240 // ap_sync.c
 241
 242 VOID APSyncStateMachineInit(
 243     IN PRTMP_ADAPTER pAd,
 244     IN STATE_MACHINE *Sm,
 245     OUT STATE_MACHINE_FUNC Trans[]);
 246
 247 VOID APScanTimeout(
 248         IN PVOID SystemSpecific1,
 249         IN PVOID FunctionContext,
 250         IN PVOID SystemSpecific2,
 251         IN PVOID SystemSpecific3);
 252
 253 VOID APInvalidStateWhenScan(
 254         IN PRTMP_ADAPTER pAd,
 255         IN MLME_QUEUE_ELEM *Elem);
 256
 257 VOID APScanTimeoutAction(
 258         IN PRTMP_ADAPTER pAd,
 259         IN MLME_QUEUE_ELEM *Elem);
 260
 261 VOID APPeerProbeReqAction(
 262     IN  PRTMP_ADAPTER pAd,
 263     IN  MLME_QUEUE_ELEM *Elem);
 264
 265 VOID APPeerBeaconAction(
 266     IN PRTMP_ADAPTER pAd,
 267     IN MLME_QUEUE_ELEM *Elem);
 268
 269 VOID APMlmeScanReqAction(
 270         IN PRTMP_ADAPTER pAd,
 271         IN MLME_QUEUE_ELEM *Elem);
 272
 273 VOID APPeerBeaconAtScanAction(
 274         IN PRTMP_ADAPTER pAd,
 275         IN MLME_QUEUE_ELEM *Elem);
 276
 277 VOID APScanCnclAction(
 278         IN PRTMP_ADAPTER pAd,
 279         IN MLME_QUEUE_ELEM *Elem);
 280
 281 VOID ApSiteSurvey(
 282         IN PRTMP_ADAPTER pAd);
 283
 284 VOID SupportRate(
 285         IN PUCHAR SupRate,
 286         IN UCHAR SupRateLen,
 287         IN PUCHAR ExtRate,
 288         IN UCHAR ExtRateLen,
 289         OUT PUCHAR *Rates,
 290         OUT PUCHAR RatesLen,
 291         OUT PUCHAR pMaxSupportRate);
 292
 293
 294 BOOLEAN ApScanRunning(
 295         IN PRTMP_ADAPTER pAd);
 296
 297 #ifdef DOT11N_DRAFT3
 298 VOID APOverlappingBSSScan(
 299         IN RTMP_ADAPTER *pAd);
 300 #endif // DOT11N_DRAFT3 //
 301
 302 // ap_wpa.c
 303
 304 VOID APWpaStateMachineInit(
 305     IN  PRTMP_ADAPTER   pAd,
 306     IN  STATE_MACHINE *Sm,
 307     OUT STATE_MACHINE_FUNC Trans[]);
 308
 309 // ap_mlme.c
 310
 311 VOID APMlmePeriodicExec(
 312     IN  PRTMP_ADAPTER   pAd);
 313
 314 VOID APMlmeSelectTxRateTable(
 315         IN PRTMP_ADAPTER                pAd,
 316         IN PMAC_TABLE_ENTRY             pEntry,
 317         IN PUCHAR                               *ppTable,
 318         IN PUCHAR                               pTableSize,
 319         IN PUCHAR                               pInitTxRateIdx);
 320
 321 VOID APMlmeSetTxRate(
 322         IN PRTMP_ADAPTER                pAd,
 323         IN PMAC_TABLE_ENTRY             pEntry,
 324         IN PRTMP_TX_RATE_SWITCH pTxRate);
 325
 326 VOID APMlmeDynamicTxRateSwitching(
 327     IN PRTMP_ADAPTER pAd);
 328
 329 VOID APQuickResponeForRateUpExec(
 330     IN PVOID SystemSpecific1,
 331     IN PVOID FunctionContext,
 332     IN PVOID SystemSpecific2,
 333     IN PVOID SystemSpecific3);
 334
 335 BOOLEAN APMsgTypeSubst(
 336     IN PRTMP_ADAPTER pAd,
 337     IN PFRAME_802_11 pFrame,
 338     OUT INT *Machine,
 339     OUT INT *MsgType);
 340
 341 VOID APQuickResponeForRateUpExec(
 342     IN PVOID SystemSpecific1,
 343     IN PVOID FunctionContext,
 344     IN PVOID SystemSpecific2,
 345     IN PVOID SystemSpecific3);
 346
 347 #ifdef RT2870
 348 VOID BeaconUpdateExec(
 349     IN PVOID SystemSpecific1,
 350     IN PVOID FunctionContext,
 351     IN PVOID SystemSpecific2,
 352     IN PVOID SystemSpecific3);
 353 #endif // RT2870 //
 354
 355 VOID RTMPSetPiggyBack(
 356         IN PRTMP_ADAPTER        pAd,
 357         IN BOOLEAN                      bPiggyBack);
 358
 359 VOID APAsicEvaluateRxAnt(
 360         IN PRTMP_ADAPTER        pAd);
 361
 362 VOID APAsicRxAntEvalTimeout(
 363         IN PRTMP_ADAPTER        pAd);
 364
 365 // ap.c
 366
 367 VOID APSwitchChannel(
 368         IN PRTMP_ADAPTER pAd,
 369         IN INT Channel);
 370
 371 NDIS_STATUS APInitialize(
 372     IN  PRTMP_ADAPTER   pAd);
 373
 374 VOID APShutdown(
 375     IN PRTMP_ADAPTER    pAd);
 376
 377 VOID APStartUp(
 378     IN  PRTMP_ADAPTER   pAd);
 379
 380 VOID APStop(
 381     IN  PRTMP_ADAPTER   pAd);
 382
 383 VOID APCleanupPsQueue(
 384     IN  PRTMP_ADAPTER   pAd,
 385     IN  PQUEUE_HEADER   pQueue);
 386
 387 VOID MacTableReset(
 388     IN  PRTMP_ADAPTER   pAd);
 389
 390 MAC_TABLE_ENTRY *MacTableInsertEntry(
 391     IN  PRTMP_ADAPTER   pAd,
 392     IN  PUCHAR          pAddr,
 393         IN      UCHAR                   apidx,
 394         IN BOOLEAN      CleanAll);
 395
 396 BOOLEAN MacTableDeleteEntry(
 397     IN  PRTMP_ADAPTER   pAd,
 398         IN USHORT wcid,
 399     IN  PUCHAR          pAddr);
 400
 401 MAC_TABLE_ENTRY *MacTableLookup(
 402     IN  PRTMP_ADAPTER   pAd,
 403     IN  PUCHAR          pAddr);
 404
 405 VOID MacTableMaintenance(
 406     IN PRTMP_ADAPTER pAd);
 407
 408 UINT32 MacTableAssocStaNumGet(
 409         IN PRTMP_ADAPTER pAd);
 410
 411 MAC_TABLE_ENTRY *APSsPsInquiry(
 412     IN  PRTMP_ADAPTER   pAd,
 413     IN  PUCHAR          pAddr,
 414     OUT SST             *Sst,
 415     OUT USHORT          *Aid,
 416     OUT UCHAR           *PsMode,
 417     OUT UCHAR           *Rate);
 418
 419 BOOLEAN APPsIndicate(
 420     IN  PRTMP_ADAPTER   pAd,
 421     IN  PUCHAR          pAddr,
 422         IN ULONG Wcid,
 423     IN  UCHAR           Psm);
 424
 425 VOID ApLogEvent(
 426     IN PRTMP_ADAPTER    pAd,
 427     IN PUCHAR           pAddr,
 428     IN USHORT           Event);
 429
 430 #ifdef DOT11_N_SUPPORT
 431 VOID APUpdateOperationMode(
 432     IN PRTMP_ADAPTER pAd);
 433 #endif // DOT11_N_SUPPORT //
 434
 435 VOID APUpdateCapabilityAndErpIe(
 436         IN PRTMP_ADAPTER pAd);
 437
 438 BOOLEAN ApCheckAccessControlList(
 439         IN PRTMP_ADAPTER pAd,
 440         IN PUCHAR        pAddr,
 441         IN UCHAR         Apidx);
 442
 443 VOID ApUpdateAccessControlList(
 444     IN PRTMP_ADAPTER pAd,
 445     IN UCHAR         Apidx);
 446
 447 VOID ApEnqueueNullFrame(
 448         IN PRTMP_ADAPTER pAd,
 449         IN PUCHAR        pAddr,
 450         IN UCHAR         TxRate,
 451         IN UCHAR         PID,
 452         IN UCHAR         apidx,
 453     IN BOOLEAN       bQosNull,
 454     IN BOOLEAN       bEOSP,
 455     IN UCHAR         OldUP);
 456
 457 VOID ApSendFrame(
 458     IN  PRTMP_ADAPTER   pAd,
 459     IN  PVOID           pBuffer,
 460     IN  ULONG           Length,
 461     IN  UCHAR           TxRate,
 462     IN  UCHAR           PID);
 463
 464 VOID ApEnqueueAckFrame(
 465     IN PRTMP_ADAPTER pAd,
 466     IN PUCHAR        pAddr,
 467     IN UCHAR         TxRate,
 468         IN UCHAR         apidx);
 469
 470 UCHAR APAutoSelectChannel(
 471         IN PRTMP_ADAPTER pAd,
 472         IN BOOLEAN Optimal);
 473
 474 // ap_sanity.c
 475
 476
 477 BOOLEAN PeerAssocReqCmmSanity(
 478     IN PRTMP_ADAPTER pAd,
 479         IN BOOLEAN isRessoc,
 480     IN VOID *Msg,
 481     IN ULONG MsgLen,
 482     OUT PUCHAR pAddr2,
 483     OUT USHORT *pCapabilityInfo,
 484     OUT USHORT *pListenInterval,
 485     OUT PUCHAR pApAddr,
 486     OUT UCHAR *pSsidLen,
 487     OUT char *Ssid,
 488     OUT UCHAR *pRatesLen,
 489     OUT UCHAR Rates[],
 490     OUT UCHAR *RSN,
 491     OUT UCHAR *pRSNLen,
 492     OUT BOOLEAN *pbWmmCapable,
 493 #ifdef WSC_AP_SUPPORT
 494     OUT BOOLEAN *pWscCapable,
 495 #endif // WSC_AP_SUPPORT //
 496     OUT ULONG  *pRalinkIe,
 497 #ifdef DOT11N_DRAFT3
 498     OUT EXT_CAP_INFO_ELEMENT    *pExtCapInfo,
 499 #endif // DOT11N_DRAFT3 //
 500     OUT UCHAR            *pHtCapabilityLen,
 501     OUT HT_CAPABILITY_IE *pHtCapability);
 502
 503 BOOLEAN PeerDisassocReqSanity(
 504     IN PRTMP_ADAPTER pAd,
 505     IN VOID *Msg,
 506     IN ULONG MsgLen,
 507     OUT PUCHAR pAddr2,
 508     OUT USHORT *Reason);
 509
 510 BOOLEAN PeerDeauthReqSanity(
 511     IN PRTMP_ADAPTER pAd,
 512     IN VOID *Msg,
 513     IN ULONG MsgLen,
 514     OUT PUCHAR pAddr2,
 515     OUT USHORT *Reason);
 516
 517 BOOLEAN APPeerAuthSanity(
 518     IN PRTMP_ADAPTER pAd,
 519     IN VOID *Msg,
 520     IN ULONG MsgLen,
 521         OUT PUCHAR pAddr1,
 522     OUT PUCHAR pAddr2,
 523     OUT USHORT *Alg,
 524     OUT USHORT *Seq,
 525     OUT USHORT *Status,
 526     CHAR *ChlgText);
 527
 528 BOOLEAN APPeerProbeReqSanity(
 529     IN PRTMP_ADAPTER pAd,
 530     IN VOID *Msg,
 531     IN ULONG MsgLen,
 532     OUT PUCHAR pAddr2,
 533     OUT CHAR Ssid[],
 534     OUT UCHAR *SsidLen);
 535
 536 BOOLEAN APPeerBeaconAndProbeRspSanity(
 537     IN PRTMP_ADAPTER pAd,
 538     IN VOID *Msg,
 539     IN ULONG MsgLen,
 540     OUT PUCHAR pAddr2,
 541     OUT PUCHAR pBssid,
 542     OUT CHAR Ssid[],
 543     OUT UCHAR *SsidLen,
 544     OUT UCHAR *BssType,
 545     OUT USHORT *BeaconPeriod,
 546     OUT UCHAR *Channel,
 547     OUT LARGE_INTEGER *Timestamp,
 548     OUT USHORT *CapabilityInfo,
 549     OUT UCHAR Rate[],
 550     OUT UCHAR *RateLen,
 551     OUT BOOLEAN *ExtendedRateIeExist,
 552     OUT UCHAR *Erp);
 553
 554 // ap_info.c
 555
 556
 557
 558 // ================== end of AP RTMP.h ========================
 559
 560
 561 #endif  // __AP_H__
 562