• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * apConn.h
3  *
4  * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  *  * Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  *  * Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  *  * Neither the name Texas Instruments nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /** \file apConn.h
35  *  \brief AP Connection Module API
36  *
37  *  \see apConn.c
38  */
39 
40 /****************************************************************************
41  *                                                                          *
42  *   MODULE:  AP Connection	    		                                	*
43  *   PURPOSE: AP Connection Module API                              		*
44  *                                                                          *
45  ****************************************************************************/
46 
47 #ifndef _AP_CONNECTION_H_
48 #define _AP_CONNECTION_H_
49 
50 #include "802_11Defs.h"
51 #include "apConnApi.h"
52 #include "DrvMainModules.h"
53 
54 /* Typedefs */
55 /* This struct is used for ROAMING_TRIGGER_AP_DISCONNECT */
56 typedef struct
57 {
58 	TI_UINT16 uStatusCode;		/* status code of deauth/disassoc packet				   */
59 	TI_BOOL   bDeAuthenticate;	/* Whether this packet is DeAuth ( if DisAssoc than TI_FALSE) */
60 } APDisconnect_t;
61 
62 typedef union
63 {
64 	APDisconnect_t APDisconnect;
65 	ERate		   rate;
66 } roamingEventData_u;
67 
68 /* Structures */
69 
70 /* External data definitions */
71 
72 /* External functions definitions */
73 
74 /* Function prototypes */
75 
76 /* Called by Config Manager */
77 TI_HANDLE apConn_create(TI_HANDLE hOs);
78 TI_STATUS apConn_unload(TI_HANDLE hAPConnection);
79 void      apConn_init (TStadHandlesList *pStadHandles);
80 TI_STATUS apConn_SetDefaults (TI_HANDLE hAPConnection, apConnParams_t *pApConnParams);
81 
82 /* Called by SME and Site Manager */
83 TI_STATUS apConn_start(TI_HANDLE hAPConnection, TI_BOOL roamingEnabled);
84 TI_STATUS apConn_stop(TI_HANDLE hAPConnection, TI_BOOL removeKeys);
85 
86 void apConn_printStatistics(TI_HANDLE hAPConnection);
87 
88 
89 /* Called by Connection SM */
90 void apConn_ConnCompleteInd(TI_HANDLE hAPConnection, mgmtStatus_e status, TI_UINT32 uStatusCode);
91 
92 void apConn_DisconnCompleteInd(TI_HANDLE hAPConnection, mgmtStatus_e status, TI_UINT32 uStatusCode);
93 
94 /* Called by Current BSS, Rate Adaptation, RSN and other modules generating roaming events */
95 TI_STATUS apConn_reportRoamingEvent(TI_HANDLE hAPConnection,
96 									apConn_roamingTrigger_e roamingEventType,
97 									roamingEventData_u *pRoamingEventData);
98 
99 /* Called by XCC Manager */
100 void apConn_RoamHandoffFinished(TI_HANDLE hAPConnection);
101 void apConn_getRoamingStatistics(TI_HANDLE hAPConnection, TI_UINT8 *roamingCount, TI_UINT16 *roamingDelay);
102 void apConn_resetRoamingStatistics(TI_HANDLE hAPConnection);
103 
104 void apConn_updateNeighborAPsList(TI_HANDLE hAPConnection, neighborAPList_t *pListOfpriorityAps);
105 
106 /* Called by Switch Channel */
107 TI_STATUS apConn_indicateSwitchChannelInProgress(TI_HANDLE hAPConnection);
108 TI_STATUS apConn_indicateSwitchChannelFinished(TI_HANDLE hAPConnection);
109 
110 /* Called by Association SM */
111 TI_STATUS apConn_getVendorSpecificIE(TI_HANDLE hAPConnection, TI_UINT8 *pRequest, TI_UINT32 *len);
112 
113 
114 TI_BOOL apConn_isPsRequiredBeforeScan(TI_HANDLE hAPConnection);
115 
116 void apConn_setDeauthPacketReasonCode(TI_HANDLE hAPConnection, TI_UINT8 deauthReasonCode);
117 
118 #endif /*  _AP_CONNECTION_H_*/
119 
120