summaryrefslogtreecommitdiff
path: root/wilink_6_1/stad/src/Sta_Management/siteMgrApi.h
blob: 9abe5d679fd3e112ec1daa92277dba8a00b5a092 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
 * siteMgrApi.h
 *
 * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved.      
 * All rights reserved.                                                  
 *                                                                       
 * Redistribution and use in source and binary forms, with or without    
 * modification, are permitted provided that the following conditions    
 * are met:                                                              
 *                                                                       
 *  * Redistributions of source code must retain the above copyright     
 *    notice, this list of conditions and the following disclaimer.      
 *  * Redistributions in binary form must reproduce the above copyright  
 *    notice, this list of conditions and the following disclaimer in    
 *    the documentation and/or other materials provided with the         
 *    distribution.                                                      
 *  * Neither the name Texas Instruments nor the names of its            
 *    contributors may be used to endorse or promote products derived    
 *    from this software without specific prior written permission.      
 *                                                                       
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS   
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT     
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT      
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT   
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** \file siteMgrApi.h
 *  \brief site manager module API
 *
 *  \see siteMgr.c
 */

/***************************************************************************/
/*                                                                                                  */
/*    MODULE:   siteMgrApi.h                                                                */
/*    PURPOSE:  site manager module API                                         */
/*                                                                                                  */
/***************************************************************************/
#ifndef __SITE_MGR_API_H__
#define __SITE_MGR_API_H__

#include "tidef.h"
#include "paramOut.h"
#include "802_11Defs.h"
#include "mlmeApi.h"
#include "siteHash.h"
#include "ScanCncn.h"
#include "bssTypes.h"
#include "DrvMainModules.h"
#include "scanResultTable.h"


#define SPECIAL_BG_CHANNEL              14

/* Rx quality triggers indexes */
typedef enum
{
    TRIGGER_EVENT_LOW_RSSI   = 0,
    TRIGGER_EVENT_LOW_SNR    = 1,
    TRIGGER_EVENT_HIGH_TX_PW = 2,
    TRIGGER_EVENT_LOW_TX_PW  = 3,
    TRIGGER_EVENT_BG_SCAN    = 4,
    TRIGGER_EVENT_USER_0     = 5,
    TRIGGER_EVENT_USER_1     = 6,
    TRIGGER_EVENT_MAX        = 7

}ETriggerEventIndex;


typedef enum
{
    /* SiteMgr section */   
    SITE_MGR_POWER_CONSTRAINT_PARAM     = 0x01,
    SITE_MGR_BEACON_INTERVAL_PARAM      = 0x02,
    SITE_MGR_SITE_CAPABILITY_PARAM      = 0x05,
    SITE_MGR_RGSTRY_BASIC_RATE_SET_MASK = 0x08,
    SITE_MGR_BEACON_RECV                = 0x09,
    SITE_MGR_DTIM_PERIOD_PARAM          = 0x0A,

    /* Previous Primary Site */
    SITE_MGR_PREV_SITE_BSSID_PARAM      = 0x0B,
    SITE_MGR_PREV_SITE_SSID_PARAM       = 0x0C,
    SITE_MGR_PREV_SITE_CHANNEL_PARAM    = 0x0D,
    SITE_MGR_DESIRED_RSSI_GAP_THR_PARAM = 0x0E,
    SITE_MGR_PRIORITY_PARAM             = 0x0F

} ESiteMgrParam;


/* Site manager interface functions prototypes */

TI_HANDLE siteMgr_create(TI_HANDLE hOs);

void      siteMgr_init (TStadHandlesList *pStadHandles);

TI_STATUS siteMgr_SetDefaults (TI_HANDLE       hSiteMgr,
                               siteMgrInitParams_t     *pSiteMgrInitParams);

TI_STATUS siteMgr_unLoad(TI_HANDLE hSiteMgr);

TI_STATUS siteMgr_setParam(TI_HANDLE        hSiteMgr,
                        paramInfo_t     *pParam);

TI_STATUS siteMgr_getParamWSC(TI_HANDLE hSiteMgr, TIWLN_SIMPLE_CONFIG_MODE *wscParam);
TI_STATUS siteMgr_getParam(TI_HANDLE        hSiteMgr, 
                        paramInfo_t     *pParam);

TI_STATUS siteMgr_join(TI_HANDLE    hSiteMgr);

TI_STATUS siteMgr_removeSelfSite(TI_HANDLE  hSiteMgr);

TI_STATUS siteMgr_disSelectSite(TI_HANDLE   hSiteMgr);

TI_STATUS systemConfig(siteMgr_t *pSiteMgr);

TI_STATUS siteMgr_start(TI_HANDLE   hSiteMgr);

TI_STATUS siteMgr_stop(TI_HANDLE    hSiteMgr);

TI_STATUS siteMgr_resetSiteTable(TI_HANDLE  hSiteMgr, siteTablesParams_t*   pSiteTableParams);

TI_STATUS siteMgr_updatePrimarySiteFailStatus(TI_HANDLE hSiteMgr, 
                                           TI_BOOL bRemoveSite);

TI_BOOL siteMgr_isCurrentBand24(TI_HANDLE  hSiteMgr);

TI_BOOL siteMgr_isThereCountryIEforCurrentBand(TI_HANDLE   hSiteMgr);

TI_STATUS pbccAlgorithm(TI_HANDLE hSiteMgr);

TI_STATUS siteMgr_assocReport(TI_HANDLE hSiteMgr, TI_UINT16 capabilities, TI_BOOL bCiscoAP);

void siteMgr_setCurrentTable(TI_HANDLE hSiteMgr, ERadioBand radioBand);

void siteMgr_updateRates(TI_HANDLE hSiteMgr, TI_BOOL dot11a, TI_BOOL updateToOS);

void siteMgr_bandParamsConfig(TI_HANDLE hSiteMgr, TI_BOOL updateToOS);

void siteMgr_ConfigRate(TI_HANDLE hSiteMgr);

TI_STATUS siteMgr_getWMEParamsSite(TI_HANDLE hSiteMgr, dot11_ACParameters_t **pWME_ACParameters_t);

TI_STATUS siteMgr_setWMEParamsSite(TI_HANDLE hSiteMgr,dot11_WME_PARAM_t *pDot11_WME_PARAM);

void siteMgr_resetChannelList(TI_HANDLE hSiteMgr);

void siteMgr_IsERP_Needed(TI_HANDLE hSiteMgr,TI_BOOL *useProtection,TI_BOOL *NonErpPresent,TI_BOOL *barkerPreambleType);

TI_STATUS siteMgr_updateNewApList (TI_HANDLE hSiteMgr);

TI_STATUS siteMgr_CopyToPrimarySite (TI_HANDLE hSiteMgr, TSiteEntry *pCandidate);

TI_STATUS siteMgr_overwritePrimarySite(TI_HANDLE hSiteMgr, bssEntry_t *newAP, TI_BOOL requiredToStorePrevSite);

void siteMgr_changeBandParams (TI_HANDLE hSiteMgr, ERadioBand radioBand);

TI_BOOL siteMgr_SelectRateMatch (TI_HANDLE hSiteMgr, TSiteEntry *pCurrentSite);

siteEntry_t *addSelfSite(TI_HANDLE hSiteMgr);

TI_STATUS siteMgr_updateSite(TI_HANDLE			hSiteMgr,
						  TMacAddr		*bssid,
						  mlmeFrameInfo_t	*pFrameInfo,
						  TI_UINT8				rxChannel,
                          ERadioBand       band,
						  TI_BOOL				measuring);

TI_STATUS siteMgr_IbssMerge(TI_HANDLE       hSiteMgr,
                          TMacAddr      	our_bssid,
						  TMacAddr      	new_bssid,
                          mlmeFrameInfo_t   *pFrameInfo,
                          TI_UINT8          rxChannel,
                          ERadioBand        band);

TI_STATUS siteMgr_saveProbeRespBuffer(TI_HANDLE hSiteMgr, TMacAddr	*bssid, TI_UINT8 *pProbeRespBuffer, TI_UINT32 length);

TI_STATUS siteMgr_saveBeaconBuffer(TI_HANDLE hSiteMgr, TMacAddr *bssid, TI_UINT8 *pBeaconBuffer, TI_UINT32 length);


#ifdef REPORT_LOG
void siteMgr_printPrimarySiteDesc(TI_HANDLE hSiteMgr );
#endif

#endif /* __SITE_MGR_API_H__ */