1 /******************************************************************************* 2 **+--------------------------------------------------------------------------+** 3 **| |** 4 **| Copyright 1998-2008 Texas Instruments, Inc. - http://www.ti.com/ |** 5 **| |** 6 **| Licensed under the Apache License, Version 2.0 (the "License"); |** 7 **| you may not use this file except in compliance with the License. |** 8 **| You may obtain a copy of the License at |** 9 **| |** 10 **| http://www.apache.org/licenses/LICENSE-2.0 |** 11 **| |** 12 **| Unless required by applicable law or agreed to in writing, software |** 13 **| distributed under the License is distributed on an "AS IS" BASIS, |** 14 **| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |** 15 **| See the License for the specific language governing permissions and |** 16 **| limitations under the License. |** 17 **| |** 18 **+--------------------------------------------------------------------------+** 19 *******************************************************************************/ 20 21 22 /*--------------------------------------------------------------------------*/ 23 /* Module: TI_AdapterApiC.H*/ 24 /**/ 25 /* Purpose: This module contains "C" interface for TI WLAN Utility Adapter.*/ 26 /**/ 27 /*--------------------------------------------------------------------------*/ 28 #ifndef _TI_ADAPTER_API_H 29 #define _TI_ADAPTER_API_H 30 31 #include "paramOut.h" 32 #include "roamingMngrTypes.h" 33 #include "tiwlnif.h" 34 #include "TI_IPC_Api.h" 35 36 37 #include "TI_AdapterQOS.h" 38 #include "TI_AdapterGWSI.h" 39 #include "TI_AdapterSEC.h" 40 #include "TI_AdapterSG.h" 41 #include "TI_AdapterPM.h" 42 43 #ifdef EXC_MODULE_INCLUDED 44 #include "TI_AdapterEXC.h" 45 #define EXC_SUPPORT_H ADAPTER_EXC 46 #else 47 #define EXC_SUPPORT_H 48 #endif /*EXC_MODULE_INCLUDED*/ 49 50 #ifdef TI_DBG 51 #include "TI_AdapterDBG.h" 52 #endif/* TI_DBG*/ 53 54 55 #ifdef __cplusplus 56 extern "C" { 57 #endif 58 59 60 /****************************************************************************** 61 62 Name: TI_AdapterInit 63 Desc: Create and initialize the Utility Adapter object 64 Params: pszDeviceName - Pointer to a null-terminated string that contains 65 the name of the specific WLAN device, If this parameter 66 is NULL, TI_AdapterInit() returns a handle to the adapter 67 object that will work with first founded WLAN device. 68 69 Return: If the function succeeds, the return value is a handle to the 70 specified Adapter. If the function fails, the return value is NULL. 71 72 ******************************************************************************/ 73 TI_HANDLE TI_AdapterInit (tiCHAR* pszDeviceName ); 74 75 /****************************************************************************** 76 77 Name: TI_AdapterDeinit 78 Desc: This function destroys the Utility Adapter object. 79 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 80 Return: TI_RESULT_OK on success. Any other value indicates an error. 81 82 ******************************************************************************/ 83 tiINT32 TI_AdapterDeinit (TI_HANDLE hAdapter ); 84 85 /****************************************************************************** 86 87 Name: TI_GetApiVersion 88 Desc: This function retrieves the API version information. 89 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 90 Return: TI_RESULT_OK on success. Any other value indicates an error. 91 92 ******************************************************************************/ 93 tiINT32 TI_GetApiVersion (TI_HANDLE hAdapter, tiUINT32* puApiVersion); 94 95 96 /****************************************************************************** 97 98 Name: TI_GetDriverVersion 99 Desc: This function retrieves the driver and firmware version information. 100 PdrvVersion points to a TIWLN_VERSION structure, which is defined in 101 tiwlnif.h. 102 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 103 pdrvVersion - A pointer to TIWLN_VERSION_EX structure. 104 Return: TI_RESULT_OK on success. Any other value indicates an error. 105 106 ******************************************************************************/ 107 tiINT32 TI_GetDriverVersion (TI_HANDLE hAdapter, 108 TIWLN_VERSION_EX* pdrvVersion ); 109 110 111 /****************************************************************************** 112 113 Name: TI_GetCurrentAddress 114 Desc: This function retrieves the MAC Address of the wireless card. 115 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 116 pCurrentAddr - A pointer to OS_802_11_MAC_ADDRESS that contains the 117 MAC Address. 118 Return: TI_RESULT_OK on success. Any other value indicates an error. 119 120 ******************************************************************************/ 121 tiINT32 TI_GetCurrentAddress (TI_HANDLE hAdapter, 122 OS_802_11_MAC_ADDRESS* pCurrentAddr); 123 124 125 126 /****************************************************************************** 127 128 Name: TI_GetDriverCapabilities 129 Desc: This function retrieves the driver capabilities list. 130 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 131 pDrvCapabilities - A pointer to a OS_802_11_DRIVER_CAPABILITIES 132 structure that contains the WiLink� 4.0 driver 133 capabilities. 134 Return: TI_RESULT_OK on success. Any other value indicates an error. 135 136 ******************************************************************************/ 137 tiINT32 TI_GetDriverCapabilities(TI_HANDLE hAdapter, 138 OS_802_11_DRIVER_CAPABILITIES* pDrvCapabilities); 139 140 /****************************************************************************** 141 142 Name: TI_SetBSSID 143 Desc: Specify the BSSID to connect. 144 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 145 pAddrBSSID - A pointer to an OS_802_11_MAC_ADDRESS structure. 146 Return: TI_RESULT_OK on success. Any other value indicates an error. 147 148 ******************************************************************************/ 149 tiINT32 TI_SetBSSID (TI_HANDLE hAdapter, 150 OS_802_11_MAC_ADDRESS *pAddrBSSID); 151 152 /****************************************************************************** 153 154 Name: TI_GetBSSID 155 Desc: This function retrieves the BSSID of the current connection 156 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 157 pAddrBSSID - A pointer to an OS_802_11_MAC_ADDRESS structure. 158 Return: TI_RESULT_OK on success. Any other value indicates an error. 159 160 ******************************************************************************/ 161 tiINT32 TI_GetBSSID (TI_HANDLE hAdapter, 162 OS_802_11_MAC_ADDRESS *pAddrBSSID); 163 164 /****************************************************************************** 165 166 Name: TI_GetBSSIDList 167 Desc: This function retrieves the BSSID list from the driver after a scan 168 operation completes. ppBSSIDlist points to an OS_802_11_BSSID_LIST_EX 169 structure, which is defined in osDot11.h. 170 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 171 pAddrBSSID - A pointer to an OS_802_11_BSSID_LIST structure. 172 Return: TI_RESULT_OK on success. Any other value indicates an error. 173 174 ******************************************************************************/ 175 tiINT32 TI_GetBSSIDList (TI_HANDLE hAdapter, 176 OS_802_11_BSSID_LIST_EX** ppBSSIDlist ); 177 178 179 180 /****************************************************************************** 181 182 Name: TI_GetFullBSSIDList 183 Desc: This function is almost the same as TI_SetBSSIDList, the only 184 difference is that is retrieves more information than TI_SetBSSIDList. 185 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 186 ppBSSIDlist - A pointer to an OS_802_11_BSSID_LIST structure. 187 Return: TI_RESULT_OK on success. Any other value indicates an error. 188 189 ******************************************************************************/ 190 tiINT32 TI_GetFullBSSIDList (TI_HANDLE hAdapter, 191 OS_802_11_BSSID_LIST_EX** ppBSSIDlist ); 192 193 /****************************************************************************** 194 195 Name: TI_GetSelectedBSSIDInfo 196 Desc: Retrieves the BSSID information from the driver after a scan operation 197 completes and select was performed. The information structure is 198 published in OS_802_11_BSSID_EX format (see TI_GetBSSIDList() command). 199 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 200 pSelectedBSSIDInfo - A pointer to a structure to be filled with the 201 selected BSSID information. 202 Return: TI_RESULT_OK on success. Any other value indicates an error. 203 204 ******************************************************************************/ 205 tiINT32 TI_GetSelectedBSSIDInfo (TI_HANDLE hAdapter, 206 OS_802_11_BSSID_EX *pSelectedBSSIDInfo); 207 208 /****************************************************************************** 209 210 Name: TI_GetPrimaryBSSIDInfo 211 Desc: Retrieves the primary BSSID information from the driver, i.e. the BSSID 212 The STA is currently connected to. The information structure is 213 published in OS_802_11_BSSID_EX format (see TI_GetBSSIDList() command). 214 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 215 pSelectedBSSIDInfo - A pointer to a structure to be filled with the 216 selected BSSID information. 217 Return: TI_RESULT_OK on success. Any other value indicates an error. 218 219 ******************************************************************************/ 220 tiINT32 TI_GetPrimaryBSSIDInfo (TI_HANDLE hAdapter, 221 OS_802_11_BSSID_EX *pSelectedBSSIDInfo); 222 223 /****************************************************************************** 224 225 Name: TI_SetDesiredChannel 226 Desc: This function sets the desired operating channel. uDesiredChannel 227 points to a channel number, which can range from 1 to 14, 228 36,40,44,48,52,56,60,64 depended from mode. 229 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 230 uDesiredChannel - A pointer to a tiUINT32 that contains the channel 231 number. 232 Return: TI_RESULT_OK on success. Any other value indicates an error. 233 234 ******************************************************************************/ 235 tiINT32 TI_SetDesiredChannel (TI_HANDLE hAdapter, 236 tiUINT32 uDesiredChannel); 237 238 /****************************************************************************** 239 240 Name: TI_GetDesiredChannel 241 Desc: This function retrieves the desired operating channel. 242 puDesiredChannel points to a channel number, which can range from 243 1 to 14, 36,40,44,48,52,56,60,64 depended on mode (a/b/g). 244 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 245 puDesiredChannel - A pointer to a tiUINT32 that contains the channel 246 number. 247 Return: TI_RESULT_OK on success. Any other value indicates an error. 248 249 ******************************************************************************/ 250 tiINT32 TI_GetDesiredChannel (TI_HANDLE hAdapter, 251 tiUINT32* puDesiredChannel); 252 253 /****************************************************************************** 254 255 Name: TI_GetCurrentChannel 256 Desc: This function retrieves the current operating channel. 257 puDesiredChannel points to a channel number, which can range from 258 1 to 14, 36,40,44,48,52,56,60,64 depended on mode (a/b/g). 259 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 260 puCurrentChannel - A pointer to a tiUINT32 that contains the current 261 channel number. 262 Return: TI_RESULT_OK on success. Any other value indicates an error. 263 264 ******************************************************************************/ 265 tiINT32 TI_GetCurrentChannel (TI_HANDLE hAdapter, 266 tiUINT32* puCurrentChannel); 267 268 /****************************************************************************** 269 270 Name: TI_GetDesiredRate 271 Desc: This function retrieves the desired transmission rate for the adapter. 272 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 273 puDesiredRate - A pointer to a tiUINT32 that contains the desired 274 transmission rate 275 Return: TI_RESULT_OK on success. Any other value indicates an error. 276 277 ******************************************************************************/ 278 tiINT32 TI_GetDesiredRate (TI_HANDLE hAdapter, 279 tiUINT32* puDesiredRate); 280 /****************************************************************************** 281 282 Name: TI_GetCurrentRate 283 Desc: This function retrieves the current transmission rate for the 284 adapter. The adapter may change the desired rate if using AUTO rate. 285 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 286 puCurrentRate - A pointer to a tiUINT32 that contains the current 287 transmission rate 288 Return: TI_RESULT_OK on success. Any other value indicates an error. 289 290 ******************************************************************************/ 291 tiINT32 TI_GetCurrentRate (TI_HANDLE hAdapter, 292 tiUINT32* puCurrentRate); 293 294 /****************************************************************************** 295 296 Name: TI_SetFragmentThreshold 297 Desc: This function sets the current fragmentation threshold. 298 Only packets that are greater than the fragmentation threshold are 299 fragmented. 300 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 301 uFragmentThreshold - a pointer to a tiUINT32 that contains the 302 fragmentation threshold in bytes. 303 Return: TI_RESULT_OK on success. Any other value indicates an error. 304 305 ******************************************************************************/ 306 tiINT32 TI_SetFragmentThreshold (TI_HANDLE hAdapter, 307 tiUINT32 uFragmentThreshold ); 308 309 /****************************************************************************** 310 311 Name: TI_GetFragmentThreshold 312 Desc: This function retrieves the current fragmentation threshold. 313 Only packets that are greater than the fragmentation threshold 314 are fragmented. 315 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 316 uFragmentThreshold - A pointer to a tiUINT32 that contains the 317 fragmentation threshold in bytes. 318 Return: TI_RESULT_OK on success. Any other value indicates an error. 319 320 ******************************************************************************/ 321 tiINT32 TI_GetFragmentThreshold (TI_HANDLE hAdapter, 322 tiUINT32* puFragmentThreshold); 323 324 /****************************************************************************** 325 326 Name: TI_SetBSSType 327 Desc: This function sets the network mode, either Infrastructure or Ad Hoc. 328 uBSSType points to an OS_802_11_NETWORK_MODE enum, which is defined in 329 osDot11.h. 330 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 331 uBSSType - Points to the network mode (OS_802_11_NETWORK_MODE enum): 332 os802_11IBSS - for Ad Hoc mode. 333 os802_11Infrastructure - for infrastructure mode. 334 os802_11AutoUnknown - for automatic mode in which the 335 adapter can switch between Ad Hoc and 336 infrastructure modes as required. 337 Return: TI_RESULT_OK on success. Any other value indicates an error. 338 339 ******************************************************************************/ 340 tiINT32 TI_SetBSSType (TI_HANDLE hAdapter, 341 OS_802_11_NETWORK_MODE uBSSType ); 342 343 /****************************************************************************** 344 345 Name: TI_GetBSSType 346 Desc: This function retrieves the network mode. For more information see 347 TI_SetBSSID(). 348 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 349 puBSSType - A pointer to the network mode (OS_802_11_NETWORK_MODE enum): 350 see TI_SetBSSType. 351 Return: TI_RESULT_OK on success. Any other value indicates an error. 352 353 ******************************************************************************/ 354 tiINT32 TI_GetBSSType (TI_HANDLE hAdapter, 355 OS_802_11_NETWORK_MODE* puBSSType); 356 357 358 359 /****************************************************************************** 360 361 Name: TI_SetBeaconFilterDesiredState 362 Desc: 363 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 364 uBeaconFilterMode - 365 Return: TI_RESULT_OK on success. Any other value indicates an error. 366 367 ******************************************************************************/ 368 tiINT32 TI_SetBeaconFilterDesiredState(TI_HANDLE hAdapter, 369 OS_802_11_BEACON_FILTER_MODE uBeaconFilterMode ); 370 371 /****************************************************************************** 372 373 Name: TI_GetBeaconFilterDesiredState 374 Desc: 375 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 376 uBeaconFilterMode - 377 Return: TI_RESULT_OK on success. Any other value indicates an error. 378 379 ******************************************************************************/ 380 tiINT32 TI_GetBeaconFilterDesiredState(TI_HANDLE hAdapter, 381 tiUINT8* uBeaconFilterMode ); 382 383 /****************************************************************************** 384 385 Name: TI_SetRTSThreshold 386 Desc: This function sets the current RTS (Request to Send) threshold. 387 The value specifies the packet size, in bytes, beyond which the WLAN 388 invokes its RTS/CTS mechanism. Packets that exceed the specified RTS 389 threshold trigger the RTS/CTS mechanism. The NIC transmits smaller 390 packets without RTS/CTS. 391 An RTS threshold value of 0 indicates that the NIC should transmit all 392 packets with RTS/CTS. 393 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 394 uRTSThreshold - Contains the RTS Threshold in bytes. 395 Return: TI_RESULT_OK on success. Any other value indicates an error. 396 397 ******************************************************************************/ 398 tiINT32 TI_SetRTSThreshold (TI_HANDLE hAdapter, 399 tiUINT32 uRTSThreshold ); 400 401 /****************************************************************************** 402 403 Name: TI_GetRTSThreshold 404 Desc: This function retrieves the current RTS (Request to Send) threshold. 405 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 406 puRTSThreshold - A pointer to a tiUINT32 that contains the RTS 407 Threshold in bytes. 408 Return: TI_RESULT_OK on success. Any other value indicates an error. 409 410 ******************************************************************************/ 411 tiINT32 TI_GetRTSThreshold (TI_HANDLE hAdapter, 412 tiUINT32* puRTSThreshold ); 413 414 /****************************************************************************** 415 416 Name: TI_SetShortPreamble 417 Desc: This function sets the current preamble length. 418 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 419 uShortPreamble - Indicates the preamble length. A value of 0 specifies long 420 preambles and a value of 1 specifies short preambles. 421 Return: TI_RESULT_OK on success. Any other value indicates an error. 422 423 ******************************************************************************/ 424 tiINT32 TI_SetShortPreamble (TI_HANDLE hAdapter, 425 tiUINT32 uShortPreamble ); 426 427 /****************************************************************************** 428 429 Name: TI_GetShortPreamble 430 Desc: This function retrieves the current preamble length. A value of 0 431 (zero) in puShortPreamble specifies long preambles and a value of 432 1 (one) specifies short preambles. 433 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 434 puShortPreamble - A pointer to a tiUINT32 that indicates the 435 preamble length. 436 Return: TI_RESULT_OK on success. Any other value indicates an error. 437 438 ******************************************************************************/ 439 tiINT32 TI_GetShortPreamble (TI_HANDLE hAdapter, 440 tiUINT32* puShortPreamble); 441 442 443 /****************************************************************************** 444 445 Name: TI_SetSSID 446 Desc: This function sets desired SSID. 447 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 448 pSSIDname - Pointer to a null-terminated string that contains a 449 desired SSID 450 Return: TI_RESULT_OK on success. Any other value indicates an error. 451 452 ******************************************************************************/ 453 tiINT32 TI_SetSSID (TI_HANDLE hAdapter, 454 tiUINT8* pSSIDname ); 455 456 /****************************************************************************** 457 458 Name: TI_GetDesiredSSID 459 Desc: This function retrieves the desired SSID. 460 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 461 pSSID - Pointer to a null-terminated string that contains a desired 462 SSID. 463 Return: TI_RESULT_OK on success. Any other value indicates an error. 464 465 ******************************************************************************/ 466 tiINT32 TI_GetDesiredSSID (TI_HANDLE hAdapter, 467 OS_802_11_SSID* pSSID ); 468 469 /****************************************************************************** 470 471 Name: TI_GetCurrentSSID 472 Desc: This function retrieves the current SSID. 473 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 474 pSSID - Pointer to a null-terminated string that contains a current 475 SSID. 476 Return: TI_RESULT_OK on success. Any other value indicates an error. 477 478 ******************************************************************************/ 479 tiINT32 TI_GetCurrentSSID (TI_HANDLE hAdapter, 480 OS_802_11_SSID* pSSID ); 481 482 /****************************************************************************** 483 484 Name: TI_GetStatistics 485 Desc: This function retrieves driver statistics. pStatistics points to a 486 TIWLN_STATISTICS structure, which is defined in tiwlnif.h. The 487 OS_802_11* types are defined in osDot11.h. 488 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 489 pStatistics - A pointer to a TIWLN_STATISTICS structure. 490 Return: TI_RESULT_OK on success. Any other value indicates an error. 491 492 ******************************************************************************/ 493 tiINT32 TI_GetStatistics (TI_HANDLE hAdapter, 494 TIWLN_STATISTICS* pStatistics ); 495 496 /****************************************************************************** 497 498 Name: TI_GetTxStatistics 499 Desc: This function retrieves driver statistics. pStatistics points to a 500 TIWLN_TX_STATISTICS structure, which is defined in tiwlnif.h. The 501 OS_802_11* types are defined in osDot11.h. The TIWLN_TX_STATISTICS 502 structure includes the structure txDataCounters_t. 503 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 504 pTxStatistics - A pointer to a TIWLN_TX_STATISTICS structure. 505 clearStatsFlag - Indication whether to clear the statistic counters 506 upon read. 507 Return: TI_RESULT_OK on success. Any other value indicates an error. 508 509 ******************************************************************************/ 510 tiINT32 TI_GetTxStatistics (TI_HANDLE hAdapter, 511 TIWLN_TX_STATISTICS* pTxStatistics, 512 UINT32 clearStatsFlag ); 513 514 /****************************************************************************** 515 516 Name: TI_EnableDisableRxDataFilters 517 Desc: This function enables or disables the Rx Data Filter feature. 518 519 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 520 enable - 0 to disable the feature, any other value to enable 521 Return: TI_RESULT_OK on success. Any other value indicates an error. 522 523 ******************************************************************************/ 524 tiINT32 TI_EnableDisableRxDataFilters(TI_HANDLE hAdapter, 525 tiBOOL enabled); 526 527 528 /****************************************************************************** 529 530 Name: TI_AddRxDataFilter 531 Desc: This function adds the given filter to the WLAN driver's list of 532 data filters. 533 534 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 535 pRequest - A pointer to the data filter request. 536 Return: TI_RESULT_OK on success, RX_FILTER_ALREADY_EXISTS if filter 537 already exists. Any other value indicates an error. 538 539 ******************************************************************************/ 540 tiINT32 TI_AddRxDataFilter (TI_HANDLE hAdapter, 541 TIWLAN_DATA_FILTER_REQUEST * pRequest); 542 543 544 /****************************************************************************** 545 546 Name: TI_GetRxDataFiltersStatistics 547 Desc: This function adds the given filter to the WLAN driver's list of 548 data filters. 549 550 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 551 pRequest - A pointer to the data filter request. 552 Return: TI_RESULT_OK on success. Any other value indicates an error. 553 554 ******************************************************************************/ 555 tiINT32 TI_GetRxDataFiltersStatistics(TI_HANDLE hAdapter, 556 TIWLAN_DATA_FILTER_STATISTICS * pStatistics); 557 558 559 /****************************************************************************** 560 561 Name: TI_GetPowerConsumptionStatistics 562 Desc: This function retrieves the power consumption statisticts from the FW. 563 564 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 565 pStatistics - A pointer to the statistics data structure. 566 Return: TI_RESULT_OK on success. Any other value indicates an error. 567 568 ******************************************************************************/ 569 tiINT32 TI_GetPowerConsumptionStatistics(TI_HANDLE hAdapter, PowerConsumptionTimeStat_t * pStatistics); 570 571 572 573 /****************************************************************************** 574 575 Name: TI_RemoveRxDataFilter 576 Desc: This function removes a previously added filter with the given 577 details from the WLAN driver's list of data filters. Note that the 578 request must be identical to the one given when the filter was added. 579 580 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 581 pRequest - A pointer to the data filter request. 582 Return: TI_RESULT_OK on success, RX_FILTER_DOES_NOT_EXIST if filter 583 doesn't exist. Any other value indicates an error. 584 585 ******************************************************************************/ 586 tiINT32 TI_RemoveRxDataFilter (TI_HANDLE hAdapter, 587 TIWLAN_DATA_FILTER_REQUEST * pRequest); 588 589 590 /****************************************************************************** 591 592 Name: TI_SetSupportedRates 593 Desc: This function sets the transmission rates supported by the driver. 594 This is the list of basic and supported rates. Basic rates have MSB 595 set to 1 (one). 596 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 597 pSupportedRatesLst - A pointer to a buffer that contains list of rates. 598 uBufLength - Contains a size of buffer. 599 Return: TI_RESULT_OK on success. Any other value indicates an error. 600 601 ******************************************************************************/ 602 tiINT32 TI_SetSupportedRates (TI_HANDLE hAdapter, 603 tiUINT8* pSupportedRatesLst, 604 tiUINT32 uBufLength ); 605 606 /****************************************************************************** 607 608 Name: TI_GetSupportedRates 609 Desc: This function retrieves the transmission rates supported by the driver. 610 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 611 pSupportedRatesLst - A pointer to a buffer that contains list of rates. 612 uBufLength - Contains a size of buffer 613 Return: TI_RESULT_OK on success. Any other value indicates an error. 614 615 ******************************************************************************/ 616 tiINT32 TI_GetSupportedRates (TI_HANDLE hAdapter, 617 tiUINT8* pSupportedRatesLst, 618 tiUINT32 uBufLength ); 619 620 621 /****************************************************************************** 622 623 Name: TI_SetIBSSProtection 624 Desc: Sets the 802.11g extended rate protection (ERP) configuration of 625 the driver. Configuration of ERP is only possible when the adapter 626 is operating in Ad Hoc mode. In infrastructure mode, the driver uses 627 the ERP method supported by the AP. 628 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 629 uProtection - Indicates the 802.11g protections. 630 Return: TI_RESULT_OK on success. Any other value indicates an error. 631 Note: This function supported only on WiLink� 4.0 - based designs. 632 633 ******************************************************************************/ 634 tiINT32 TI_SetIBSSProtection (TI_HANDLE hAdapter, 635 tiUINT32 uProtection ); 636 637 /****************************************************************************** 638 639 Name: TI_GetIBSSProtection 640 Desc: Returns the 802.11g extended rate protection (ERP) configuration of 641 the driver. For more information see TI_SetIBSSProtection(). 642 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 643 puProtection - A pointer to a tiUINT32 that indicates the 802.11g 644 protections. 645 Return: TI_RESULT_OK on success. Any other value indicates an error. 646 647 ******************************************************************************/ 648 tiINT32 TI_GetIBSSProtection (TI_HANDLE hAdapter, 649 tiUINT32* puProtection); 650 651 /****************************************************************************** 652 653 Name: TI_GetDriverState 654 Desc: This function returns a driver's state. 655 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 656 puDriverState - A pointer to a driverState_e that indicates the 657 driver state: 658 DRIVER_STATE_IDLE = 0, 659 DRIVER_STATE_SCANNING = 1, 660 DRIVER_STATE_SELECTING = 2, 661 DRIVER_STATE_CONNECTING = 3, 662 DRIVER_STATE_CONNECTED = 4, 663 DRIVER_STATE_DISCONNECTED = 5, 664 Return: TI_RESULT_OK on success. Any other value indicates an error. 665 666 ******************************************************************************/ 667 tiINT32 TI_GetDriverState (TI_HANDLE hAdapter, 668 driverState_e* puDriverState ); 669 670 /****************************************************************************** 671 672 Name: TI_SetShortSlot 673 Desc: Sets the 802.11g slot time. 674 A value of 0 (zero) in uShortSlot indicates a long slot time (20 uSec) 675 A value of 1 (one) in uShortSlot indicates a short slot time (9 uSec). 676 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 677 uShortSlot - Indicates the 802.11g slot time. 678 Return: TI_RESULT_OK on success. Any other value indicates an error. 679 Note: This function supported only on WiLink� 4.0 - based designs. 680 681 ******************************************************************************/ 682 tiINT32 TI_SetShortSlot (TI_HANDLE hAdapter, 683 tiUINT32 uShortSlot ); 684 685 /****************************************************************************** 686 687 Name: TI_GetShortSlot 688 Desc: Returns the 802.11g slot time. Refer to TI_SetShortSlot. 689 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 690 puShortSlot - pointer to a tiUINT32 that indicates the 802.11g slot 691 time. 692 Return: TI_RESULT_OK on success. Any other value indicates an error. 693 694 ******************************************************************************/ 695 tiINT32 TI_GetShortSlot (TI_HANDLE hAdapter, 696 tiUINT32* puShortSlot ); 697 698 /****************************************************************************** 699 700 Name: TI_SetTxPowerDbm 701 Desc: This function sets the maximum station transmit power in Dbm. The station 702 also takes into consideration two additional power level settings 703 AP-IE and Chip ID. The final setting is the minimum of among these 704 three settings. 705 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 706 uTxPower - Contains a station power level 707 Return: TI_RESULT_OK on success. Any other value indicates an error. 708 709 ******************************************************************************/ 710 tiINT32 TI_SetTxPowerDbm (TI_HANDLE hAdapter, 711 tiUINT8 uTxPower); 712 713 /****************************************************************************** 714 715 Name: TI_GetTxPowerLevel 716 Desc: Retrieve the current station power level table. 717 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 718 puTxPower - A pointer to a tiCHAR that contains the station power 719 level table. 720 Return: TI_RESULT_OK on success. Any other value indicates an error. 721 722 ******************************************************************************/ 723 tiINT32 TI_GetTxPowerLevel (TI_HANDLE hAdapter, 724 tiCHAR* puTxPower); 725 726 /****************************************************************************** 727 728 Name: TI_GetTxPowerDbm 729 Desc: Retrieve the current Tx Power in Dbm/10 value. 730 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 731 puTxPower - A pointer to a tiCHAR that contains the station TX power 732 in Dbm value. 733 Return: TI_RESULT_OK on success. Any other value indicates an error. 734 735 ******************************************************************************/ 736 tiINT32 TI_GetTxPowerDbm (TI_HANDLE hAdapter, 737 tiCHAR* puTxPower); 738 739 /****************************************************************************** 740 741 Name: TI_GetSupportedNetworkTypes 742 Desc: This function retrieves the supported network types. 743 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 744 pNetTypeLst - Pointer to the buffer that contains list of supported 745 network types. 746 uMaxNetTypes - Maximum number of types that will contains in the 747 buffer pNetTypeLst. 748 Return: TI_RESULT_OK on success. Any other value indicates an error. 749 750 ******************************************************************************/ 751 tiINT32 TI_GetSupportedNetworkTypes (TI_HANDLE hAdapter, 752 OS_802_11_NETWORK_TYPE* pNetTypeLst, 753 tiUINT32 uMaxNetTypes); 754 755 /****************************************************************************** 756 757 Name: TI_SetNetworkTypeInUse 758 Desc: This function sets the network type. 759 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 760 uNetType - Contains network type: 761 os802_11FH, 762 os802_11DS, 763 os802_11OFDM5, 764 os802_11OFDM24, 765 os802_11OFDM24_AND_5 766 Return: TI_RESULT_OK on success. Any other value indicates an error. 767 768 ******************************************************************************/ 769 tiINT32 TI_SetNetworkTypeInUse (TI_HANDLE hAdapter, 770 OS_802_11_NETWORK_TYPE uNetType ); 771 772 /****************************************************************************** 773 774 Name: TI_GetNetworkTypeInUse 775 Desc: This function retrieves the current network type in use. 776 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 777 puNetType - Pointer to the buffer that contains value of network type. 778 Return: TI_RESULT_OK on success. Any other value indicates an error. 779 780 ******************************************************************************/ 781 tiINT32 TI_GetNetworkTypeInUse (TI_HANDLE hAdapter, 782 OS_802_11_NETWORK_TYPE* puNetType ); 783 784 785 /****************************************************************************** 786 787 Name: TI_GetNumberOfAntennas 788 Desc: This function retrieves the number of antennas. 789 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 790 puNumberOfAntennas - 791 Return: TI_RESULT_OK on success. Any other value indicates an error. 792 793 ******************************************************************************/ 794 tiINT32 TI_GetNumberOfAntennas (TI_HANDLE hAdapter, 795 tiUINT32* puNumberOfAntennas ); 796 797 /****************************************************************************** 798 799 Name: TI_SetAntennaDiversityParams 800 Desc: This function sets various antenna diversity parameters. 801 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 802 pAntennaDiversityOptions - Pointer to antenna diversity parameters 803 structure holding required parameters: 804 enableRxDiversity - specifies whether antenna diversity should 805 be enables for reception. 806 rxSelectedAntenna - specifies which antenna to use for reception. 807 enableTxDiversity - specifies whether antenna diversity should 808 be enables for transmission. 809 txSelectedAntenna - specifies which antenna to use for 810 transmission. 811 rxTxSharedAnts - specifies whether to share reception and 812 transmission antennas. 813 Return: TI_RESULT_OK on success. Any other value indicates an error. 814 815 ******************************************************************************/ 816 tiINT32 TI_SetAntennaDiversityParams(TI_HANDLE hAdapter, 817 PTIWLAN_ANT_DIVERSITY pAntennaDiversityOptions); 818 819 820 /****************************************************************************** 821 822 Name: TI_GetRegDomainTable 823 Desc: This function retrieves the regularity domain table. 824 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 825 pRegDomainTable - Pointer to TIWLAN_REGDOMAINS structure which includes 826 regulatory domains table and its size. 827 Return: TI_RESULT_OK on success. Any other value indicates an error. 828 829 ******************************************************************************/ 830 tiINT32 TI_GetRegDomainTable(TI_HANDLE hAdapter, 831 TIWLN_REGDOMAINS* pRegDomainTable); 832 833 /****************************************************************************** 834 835 Name: TI_EnableDisable_802_11d 836 Desc: This function enables or disables the 802.11d protocol. 837 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 838 enableDisable_802_11d - Enable or Disable value 839 Return: TI_RESULT_OK on success. Any other value indicates an error. 840 841 ******************************************************************************/ 842 tiINT32 TI_EnableDisable_802_11d (TI_HANDLE hAdapter, 843 tiUINT8 enableDisable_802_11d); 844 845 /****************************************************************************** 846 847 Name: TI_Get_802_11d 848 Desc: This function retrieves whether the 802.11d protocol in enabled or 849 disabled. 850 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 851 enableDisable_802_11d - A pointer to a tiUINT8 which returns an 852 Enable or Disable value. 853 Return: TI_RESULT_OK on success. Any other value indicates an error. 854 855 ******************************************************************************/ 856 tiINT32 TI_Get_802_11d (TI_HANDLE hAdapter, 857 tiUINT8 *enableDisable_802_11d); 858 859 /****************************************************************************** 860 861 Name: TI_EnableDisable_802_11h 862 Desc: This function enables or disables the 802.11h protocol. 863 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 864 enableDisable_802_11h - Enable or Disable value 865 Return: TI_RESULT_OK on success. Any other value indicates an error. 866 867 ******************************************************************************/ 868 tiINT32 TI_EnableDisable_802_11h (TI_HANDLE hAdapter, 869 tiUINT8 enableDisable_802_11h); 870 871 /****************************************************************************** 872 873 Name: TI_Get_802_11h 874 Desc: This function retrieves whether the 802.11h protocol in enabled or 875 disabled. 876 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 877 enableDisable_802_11h - A pointer to a tiUINT8 which returns an 878 Enable or Disable value. 879 Return: TI_RESULT_OK on success. Any other value indicates an error. 880 881 ******************************************************************************/ 882 tiINT32 TI_Get_802_11h (TI_HANDLE hAdapter, 883 tiUINT8 *enableDisable_802_11h); 884 885 /****************************************************************************** 886 887 Name: TI_Set_countryIeFor2_4_Ghz 888 Desc: 889 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 890 countryIe - 891 Return: TI_RESULT_OK on success. Any other value indicates an error. 892 893 ******************************************************************************/ 894 tiINT32 TI_Set_countryIeFor2_4_Ghz (TI_HANDLE hAdapter, 895 country_t countryIe); 896 897 /****************************************************************************** 898 899 Name: TI_Get_countryIeFor2_4_Ghz 900 Desc: 901 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 902 countryString - 903 Return: TI_RESULT_OK on success. Any other value indicates an error. 904 905 ******************************************************************************/ 906 tiINT32 TI_Get_countryIeFor2_4_Ghz (TI_HANDLE hAdapter, 907 tiUINT8 **countryString); 908 909 /****************************************************************************** 910 911 Name: TI_Set_countryIeFor5_Ghz 912 Desc: 913 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 914 countryIe - 915 Return: TI_RESULT_OK on success. Any other value indicates an error. 916 917 ******************************************************************************/ 918 tiINT32 TI_Set_countryIeFor5_Ghz (TI_HANDLE hAdapter, 919 country_t countryIe); 920 921 /****************************************************************************** 922 923 Name: TI_Get_countryIeFor5_Ghz 924 Desc: 925 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 926 countryString - 927 Return: TI_RESULT_OK on success. Any other value indicates an error. 928 929 ******************************************************************************/ 930 tiINT32 TI_Get_countryIeFor5_Ghz (TI_HANDLE hAdapter, 931 tiUINT8 **countryString); 932 933 /****************************************************************************** 934 935 Name: TI_Set_minMaxDfsChannels 936 Desc: 937 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 938 DFS_ChannelRange - Minimum and maximum cahnnel numbers for which 939 DFS is used 940 Return: TI_RESULT_OK on success. Any other value indicates an error. 941 942 ******************************************************************************/ 943 tiINT32 TI_Set_minMaxDfsChannels (TI_HANDLE hAdapter, 944 DFS_ChannelRange_t DFS_ChannelRange); 945 946 /****************************************************************************** 947 948 Name: TI_Get_minMaxDfsChannels 949 Desc: 950 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 951 DFS_ChannelRange - Minimum and maximum cahnnel numbers for which 952 DFS is used 953 Return: TI_RESULT_OK on success. Any other value indicates an error. 954 955 ******************************************************************************/ 956 tiINT32 TI_Get_minMaxDfsChannels (TI_HANDLE hAdapter, 957 DFS_ChannelRange_t *DFS_ChannelRange); 958 959 /****************************************************************************** 960 961 Name: TI_Start 962 Desc: This command starts the driver operation. The driver will start 963 scanning and will try to connect according to its configuration. 964 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 965 Return: TI_RESULT_OK on success. Any other value indicates an error. 966 Note: Used for Linux only. 967 968 ******************************************************************************/ 969 tiINT32 TI_Start (TI_HANDLE hAdapter); 970 971 /****************************************************************************** 972 973 Name: TI_Stop 974 Desc: This command blocks the driver's API and turns off the WiLink� 4.0 975 HW. The driver will be kept loaded and will keep its configuration 976 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 977 Return: TI_RESULT_OK on success. Any other value indicates an error. 978 Note: Used for Linux only. 979 980 ******************************************************************************/ 981 tiINT32 TI_Stop (TI_HANDLE hAdapter); 982 983 /****************************************************************************** 984 985 Name: TI_StartSM 986 Desc: This command starts the Supplicant Manager module operation. 987 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 988 Return: TI_RESULT_OK on success. Any other value indicates an error. 989 990 ******************************************************************************/ 991 tiINT32 TI_StartSM (TI_HANDLE hAdapter); 992 993 /****************************************************************************** 994 995 Name: TI_StopSM 996 Desc: This command stops the supplicant manager operation. 997 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 998 Return: TI_RESULT_OK on success. Any other value indicates an error. 999 1000 ******************************************************************************/ 1001 tiINT32 TI_StopSM (TI_HANDLE hAdapter); 1002 1003 /****************************************************************************** 1004 1005 Name: TI_GetRSSI 1006 Desc: This function returns the current RSSI. 1007 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1008 pRSSI - The current RSSI level. 1009 Return: TI_RESULT_OK on success. Any other value indicates an error. 1010 1011 ******************************************************************************/ 1012 tiINT32 TI_GetRSSI (TI_HANDLE hAdapter, 1013 tiINT32* pRSSI); 1014 1015 /****************************************************************************** 1016 1017 Name: TI_GetSNR 1018 Desc: This function returns the current SNR. 1019 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1020 pSNR - The current SNR level. 1021 Return: TI_RESULT_OK on success. Any other value indicates an error. 1022 1023 ******************************************************************************/ 1024 tiINT32 TI_GetSNR (TI_HANDLE hAdapter, 1025 tiUINT32* pSNR); 1026 1027 /****************************************************************************** 1028 1029 Name: TI_Disassociate 1030 Desc: This command sets Junk SSID to the Driver. It makes the WiLink� 4.0 1031 to disassociate any current AP and to return to idle state. The 1032 Driver does not attempt to connect to any other AP until a valid 1033 SSID is set. 1034 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1035 Return: TI_RESULT_OK on success. Any other value indicates an error. 1036 1037 ******************************************************************************/ 1038 tiINT32 TI_Disassociate (TI_HANDLE hAdapter); 1039 1040 1041 1042 /****************************************************************************** 1043 1044 Name: TI_RegisterEvent 1045 Desc: This function registers a driver event, which will trigger the 1046 specified callback function. 1047 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1048 pEventParams - Information about the event to which you are registering. 1049 Return: TI_RESULT_OK on success. Any other value indicates an error. 1050 1051 ******************************************************************************/ 1052 tiINT32 TI_RegisterEvent (TI_HANDLE hAdapter, 1053 IPC_EVENT_PARAMS* pEventParams ); 1054 1055 /****************************************************************************** 1056 1057 Name: TI_UnRegisterEvent 1058 Desc: This function un-registers a driver event. 1059 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1060 pEventParams - Information about the event to which you are 1061 registering. 1062 Return: TI_RESULT_OK on success. Any other value indicates an error. 1063 1064 ******************************************************************************/ 1065 tiINT32 TI_UnRegisterEvent (TI_HANDLE hAdapter, 1066 IPC_EVENT_PARAMS* pEventParams ); 1067 1068 /****************************************************************************** 1069 1070 Name: TI_StartScan 1071 Desc: Starts a scan operation. The user can define the scan parameters. 1072 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1073 pScanParams - The parameters for the requested scan. 1074 Return: TI_RESULT_OK on success. Any other value indicates an error. 1075 Note: up to 16 scanned channels. 1076 1077 ******************************************************************************/ 1078 tiINT32 TI_StartScan (TI_HANDLE hAdapter, 1079 scan_Params_t *pScanParams); 1080 1081 /****************************************************************************** 1082 1083 Name: TI_StopScan 1084 Desc: Send a command to the WiLink� 4.0 driver to terminate the scan process. 1085 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1086 Return: TI_RESULT_OK on success. Any other value indicates an error. 1087 1088 ******************************************************************************/ 1089 tiINT32 TI_StopScan (TI_HANDLE hAdapter); 1090 1091 /****************************************************************************** 1092 1093 Name: TI_SetScanPolicy 1094 Desc: Sends a command buffer to the driver scan manager logic. 1095 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1096 buffer - A pointer to the buffer holding the scan policy. 1097 bufferLength - The length of the above buffer. 1098 Return: TI_RESULT_OK on success. Any other value indicates an error. 1099 1100 ******************************************************************************/ 1101 tiINT32 TI_SetScanPolicy (TI_HANDLE hAdapter, 1102 UINT8* buffer, 1103 UINT16 bufferLength); 1104 1105 /****************************************************************************** 1106 1107 Name: TI_GetScanBssList 1108 Desc: Retrieves the scan manager tracking BSS list. This function should 1109 be used for debug purposes only. 1110 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1111 bssList - A pointer to a buffer in which the BSS list will be stored. 1112 Return: TI_RESULT_OK on success. Any other value indicates an error. 1113 1114 ******************************************************************************/ 1115 tiINT32 TI_GetScanBssList (TI_HANDLE hAdapter, 1116 bssList_t* bssList); 1117 1118 1119 1120 1121 1122 1123 /* ****************************************** */ 1124 /****************************************************************************** 1125 1126 Name: TI_WLAN_IsDriverRun 1127 Desc: This command returns the driver status, running or Idle. 1128 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1129 pbStatus - The Driver status, running or IDLE. 1130 Return: TI_RESULT_OK on success. Any other value indicates an error. 1131 1132 ******************************************************************************/ 1133 tiINT32 TI_WLAN_IsDriverRun (TI_HANDLE hAdapter, 1134 tiBOOL* pbStatus); 1135 1136 /****************************************************************************** 1137 1138 Name: TI_Set4XState 1139 Desc: This command sets the 4X state. 1140 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1141 bStatus - TRUE-4X enabled, FALSE � disabled.. 1142 Return: TI_RESULT_OK on success. Any other value indicates an error. 1143 Note: NOT SUPPORTED !!! 1144 1145 ******************************************************************************/ 1146 tiINT32 TI_Set4XState (TI_HANDLE hAdapter, 1147 tiBOOL bStatus); 1148 1149 /****************************************************************************** 1150 1151 Name: TI_Get4XState 1152 Desc: This command returns 4X status. 1153 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1154 pbStatus - . 1155 Return: TI_RESULT_OK on success. Any other value indicates an error. 1156 1157 ******************************************************************************/ 1158 tiINT32 TI_Get4XState (TI_HANDLE hAdapter, 1159 tiBOOL* pbStatus); 1160 1161 1162 /****************************************************************************** 1163 1164 Name: TI_SetExtRatesIE 1165 Desc: This command sets the Draft number. 1166 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1167 uExtRatesIE - The Draft number: 5 or earlier, 6 or later.. 1168 Return: TI_RESULT_OK on success. Any other value indicates an error. 1169 1170 ******************************************************************************/ 1171 tiINT32 TI_SetExtRatesIE (TI_HANDLE hAdapter, 1172 tiUINT32 uExtRatesIE); 1173 1174 /****************************************************************************** 1175 1176 Name: TI_GetExtRatesIE 1177 Desc: This command returns the Draft number. 1178 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1179 puExtRatesIE - The Draft number: 5 or earlier, 6 or later.. 1180 Return: TI_RESULT_OK on success. Any other value indicates an error. 1181 1182 ******************************************************************************/ 1183 tiINT32 TI_GetExtRatesIE (TI_HANDLE hAdapter, 1184 tiUINT32* puExtRatesIE); 1185 1186 /****************************************************************************** 1187 1188 Name: TI_SetEarlyWakeupMode 1189 Desc: This command sets the Early Wakeup mode. 1190 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1191 uEarlyWakeup - The early Wakeup mode: 0 - disabled, 1 - enabled 1192 Return: TI_RESULT_OK on success. Any other value indicates an error. 1193 1194 ******************************************************************************/ 1195 tiINT32 TI_SetEarlyWakeupMode (TI_HANDLE hAdapter, 1196 tiUINT8 uEarlyWakeup); 1197 1198 /****************************************************************************** 1199 1200 Name: TI_GetEarlyWakeupMode 1201 Desc: This command returns the Early Wakeup mode. 1202 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1203 uEarlyWakeup - The early Wakeup mode: 0 - disabled, 1 - enabled 1204 Return: TI_RESULT_OK on success. Any other value indicates an error. 1205 1206 ******************************************************************************/ 1207 tiINT32 TI_GetEarlyWakeupMode (TI_HANDLE hAdapter, 1208 tiUINT8* uEarlyWakeup); 1209 1210 1211 /****************************************************************************** 1212 1213 Name: TI_SetRoamingConfiguration 1214 Desc: The TI_SetRoamingConfiguration() function sends a command buffer to 1215 the driver roaming manager logic. 1216 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1217 buffer - The command buffer. 1218 bufferLength - The roam command buffer length (bytes). 1219 Return: TI_RESULT_OK on success. Any other value indicates an error. 1220 1221 ******************************************************************************/ 1222 tiINT32 TI_SetRoamingConfiguration (TI_HANDLE hAdapter, 1223 UINT8* buffer, 1224 UINT16 bufferLength); 1225 1226 /****************************************************************************** 1227 1228 Name: TI_GetRoamingConfiguration 1229 Desc: The TI_SetRoamingConfiguration() function sends a command buffer to 1230 the driver roaming manager logic. 1231 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1232 buffer - The command buffer. 1233 bufferLength - The roam command buffer length (bytes). 1234 Return: TI_RESULT_OK on success. Any other value indicates an error. 1235 1236 ******************************************************************************/ 1237 tiINT32 TI_GetRoamingConfiguration (TI_HANDLE hAdapter, 1238 UINT8* buffer, 1239 UINT16 bufferLength); 1240 1241 1242 1243 1244 /* PLT */ 1245 /****************************************************************************** 1246 1247 Name: TI_PLT_ReadRegister 1248 Desc: This command reads a firmware register value. 1249 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1250 uRegisterAddr - Register address. 1251 puRegisterData - Pointer to the register data. 1252 Return: TI_RESULT_OK on success. Any other value indicates an error. 1253 1254 ******************************************************************************/ 1255 tiINT32 TI_PLT_ReadRegister (TI_HANDLE hAdapter, 1256 UINT32 uRegisterAddr, 1257 PUINT32 puRegisterData ); 1258 1259 /****************************************************************************** 1260 1261 Name: TI_PLT_WriteRegister 1262 Desc: This command writes a firmware register value. 1263 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1264 uRegisterAddr - Register address. 1265 uRegisterData - register data. 1266 Return: TI_RESULT_OK on success. Any other value indicates an error. 1267 1268 ******************************************************************************/ 1269 tiINT32 TI_PLT_WriteRegister (TI_HANDLE hAdapter, 1270 UINT32 uRegisterAddr, 1271 UINT32 uRegisterData ); 1272 /****************************************************************************** 1273 1274 Name: TI_PLT_RxPerStart 1275 Desc: Start or resume the PER measurement. 1276 This function will put the device in promiscuous mode, and resume counters update. 1277 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1278 Return: TI_RESULT_OK on success. Any other value indicates an error. 1279 1280 ******************************************************************************/ 1281 tiINT32 TI_PLT_RxPerStart (TI_HANDLE hAdapter); 1282 1283 /****************************************************************************** 1284 1285 Name: TI_PLT_RxPerStop 1286 Desc: Stop Rx PER measurements. 1287 This function stop counters update and make it is safe to read the PER test result. 1288 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1289 Return: TI_RESULT_OK on success. Any other value indicates an error. 1290 1291 ******************************************************************************/ 1292 tiINT32 TI_PLT_RxPerStop (TI_HANDLE hAdapter); 1293 1294 /****************************************************************************** 1295 1296 Name: TI_PLT_RxPerClear 1297 Desc: Clear the Rx PER test results. 1298 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1299 Return: TI_RESULT_OK on success. Any other value indicates an error. 1300 1301 ******************************************************************************/ 1302 tiINT32 TI_PLT_RxPerClear (TI_HANDLE hAdapter); 1303 1304 /****************************************************************************** 1305 1306 Name: TI_PLT_RxPerGetResults 1307 Desc: Get the last Rx PER test results. 1308 The RX PER test is conducted in order to evaluate the PER of received packets and is basically done by measuring the ratio between the amount of packets received with FCS errors and the total amount of packets received at a certain period of time. 1309 You can Start and Stop the frame accumulation several times, and read the total frame count after the last Stop command. 1310 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1311 pPltRxPer - The PLT PER results. 1312 Return: TI_RESULT_OK on success. Any other value indicates an error. 1313 1314 ******************************************************************************/ 1315 tiINT32 TI_PLT_RxPerGetResults (TI_HANDLE hAdapter, 1316 PltRxPer_t* pPltRxPer ); 1317 /****************************************************************************** 1318 1319 Name: TI_PLT_TxCW 1320 Desc: Generate carrier wave in a specific channel and band.. 1321 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1322 pPltTxCW - The Carrier wave channel and band. 1323 Return: TI_RESULT_OK on success. Any other value indicates an error. 1324 1325 ******************************************************************************/ 1326 tiINT32 TI_PLT_TxCW (TI_HANDLE hAdapter, 1327 TestCmdChannelBand_t* pPltTxCW); 1328 /****************************************************************************** 1329 1330 Name: TI_PLT_TxContiues 1331 Desc: Continuous transmit series of numbers with a valid MAC header ( 1332 "CAFE BABE" & "DEAD BEEF" as MAC address). However there is no 802.11 air access compliance. 1333 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1334 pPltTxContinues - Infrmation about continuess transmition. 1335 Return: TI_RESULT_OK on success. Any other value indicates an error. 1336 1337 ******************************************************************************/ 1338 tiINT32 TI_PLT_TxContiues (TI_HANDLE hAdapter, 1339 PltTxContinues_t* pPltTxContinues); 1340 /****************************************************************************** 1341 1342 Name: TI_PLT_TxStop 1343 Desc: Stop packet transmission initiated by the TI_PLT_TxCW() and TI_PLT_TxContiues() functions. 1344 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1345 Return: TI_RESULT_OK on success. Any other value indicates an error. 1346 1347 ******************************************************************************/ 1348 tiINT32 TI_PLT_TxStop (TI_HANDLE hAdapter); 1349 1350 /****************************************************************************** 1351 1352 Name: TI_PLT_ReadMIB 1353 Desc: Reads a PLT MIB. 1354 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1355 pMib - Holds the MIB structure. 1356 Return: TI_RESULT_OK on success. Any other value indicates an error. 1357 1358 ******************************************************************************/ 1359 tiINT32 TI_PLT_ReadMIB (TI_HANDLE hAdapter, 1360 PLT_MIB_t* pMib); 1361 /****************************************************************************** 1362 1363 Name: TI_PLT_WriteMIB 1364 Desc: Writes a PLT MIB. 1365 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1366 pMib - Holds the MIB structure. 1367 Return: TI_RESULT_OK on success. Any other value indicates an error. 1368 1369 ******************************************************************************/ 1370 tiINT32 TI_PLT_WriteMIB (TI_HANDLE hAdapter, 1371 PLT_MIB_t* pMib); 1372 1373 /****************************************************************************** 1374 TX Calibration functions 1375 ******************************************************************************/ 1376 1377 /****************************************************************************** 1378 Name: TI_PLT_TxCalGainGet 1379 Desc: Retrieves the TX chain gain settings. 1380 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1381 pPLTGainGet - Holds the return gain results. 1382 Return: TI_RESULT_OK on success. Any other value indicates an error. 1383 1384 ******************************************************************************/ 1385 tiINT32 TI_PLT_TxCalGainGet (TI_HANDLE hAdapter, 1386 PltGainGet_t* pPLTGainGet); 1387 1388 /****************************************************************************** 1389 1390 Name: TI_PLT_TxCalGainAdjust 1391 Desc: Changes the TX chain gain settings. 1392 Value is provided in 0.25 dB steps. (e.g. 0xfe is -0.5dB ; 0x10 is +4 dB) 1393 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1394 uTxGainChange - the TX gain change from current value in 2's complement. 1395 Value is defined in steps of 0.25dB. 1396 Return: TI_RESULT_OK on success. Any other value indicates an error. 1397 1398 ******************************************************************************/ 1399 tiINT32 TI_PLT_TxCalGainAdjust (TI_HANDLE hAdapter, 1400 tiINT32 uTxGainChange); 1401 1402 /****************************************************************************** 1403 1404 Name: TI_PLT_TxCalStart 1405 Desc: This PLT function handles all the activities required before initiating the TX calibration procedure. 1406 As part of it activities it should make sure that CLPC is disabled and the gain control loop is open. 1407 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1408 pPLTTxCal - Band, Channel, Reference Tx power. 1409 Return: TI_RESULT_OK on success. Any other value indicates an error. 1410 1411 ******************************************************************************/ 1412 tiINT32 TI_PLT_TxCalStart (TI_HANDLE hAdapter, 1413 PltTxCalibrationRequest_t* pPLTTxCal); 1414 1415 /****************************************************************************** 1416 1417 Name: TI_PLT_TxCalStop 1418 Desc: This PLT function is a cleanup functions for the radio to be able to resume normal operation. 1419 As part of its activities it should put the CLPC mode back into operation. 1420 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1421 Return: TI_RESULT_OK on success. Any other value indicates an error. 1422 1423 ******************************************************************************/ 1424 tiINT32 TI_PLT_TxCalStop (TI_HANDLE hAdapter); 1425 1426 /****************************************************************************** 1427 1428 Name: TI_PLT_TxCalStop 1429 Desc: This PLT function provides the all information required by the upper 1430 driver in order to update the NVS image. It received a parameter 1431 defining the type of update information required and provides an array 1432 of elements defining the data bytes to be written to the NVS image and 1433 the byte offset in which they should be written. 1434 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1435 pPLT_NVSUpdateBuffer - The data to be updated in the NVS file. 1436 Return: TI_RESULT_OK on success. Any other value indicates an error. 1437 1438 ******************************************************************************/ 1439 tiINT32 TI_PLT_RxTxCalNVSUpdateBuffer (TI_HANDLE hAdapter, 1440 PltNvsResultsBuffer_t* pPLT_NVSUpdateBuffer); 1441 1442 1443 /****************************************************************************** 1444 1445 Name: TI_PLT_TxCalGainAdjust 1446 Desc: This PLT function perform a RSSI measurement on the selected channel, 1447 and returns the data bytes to be written to the NVS image and 1448 the byte offset in which they should be written. 1449 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1450 pPltRxCalibration_t - The input and output parametrs needed for the RX calibration. 1451 Return: TI_RESULT_OK on success. Any other value indicates an error. 1452 1453 ******************************************************************************/ 1454 tiINT32 TI_PLT_RxCal(TI_HANDLE hAdapter, 1455 PltRxCalibrationRequest_t* pPltRxCalibration_t); 1456 1457 1458 /****************************************************************************** 1459 1460 Name: TI_PLT_RadioTune 1461 Desc: Generate carrier wave in a specific channel and band.. 1462 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1463 TestCmdChannelBand_t - The channel and band. 1464 Return: TI_RESULT_OK on success. Any other value indicates an error. 1465 1466 ******************************************************************************/ 1467 tiINT32 TI_PLT_RadioTune (TI_HANDLE hAdapter, 1468 TestCmdChannelBand_t* pChannelBand); 1469 1470 #ifdef _WINDOWS 1471 #endif 1472 1473 1474 /****************************************************************************** 1475 1476 Name: TI_PLT_TxPowerRef 1477 Desc: Set Tx power reference. 1478 Params: hAdapter - The Adapter handle returned by TI_AdapterInit(). 1479 uTxPower - Tx power in Dbm/10. 1480 Return: TI_RESULT_OK on success. Any other value indicates an error. 1481 1482 ******************************************************************************/ 1483 tiINT32 TI_PLT_TxPowerRef (TI_HANDLE hAdapter, 1484 tiUINT32 uTxPower); 1485 1486 1487 1488 #ifdef TI_DBG 1489 #ifdef DRIVER_PROFILING 1490 tiINT32 TI_ProfileReport (TI_HANDLE hAdapter); 1491 tiINT32 TI_CpuEstimatorCommand (TI_HANDLE hAdapter, tiUINT8 uType, tiUINT32 uData); 1492 #endif 1493 #endif 1494 1495 tiINT32 TI_Open_EAPOL_Interface ( TI_HANDLE hAdapter); 1496 tiINT32 TI_Close_EAPOL_Interface ( TI_HANDLE hAdapter); 1497 tiINT32 TI_Send_EAPOL_Packet ( TI_HANDLE hAdapter, tiVOID* pData, tiUINT32 uSize ); 1498 tiINT32 TI_GetAssociationInfo (TI_HANDLE hAdapter, OS_802_11_ASSOCIATION_INFORMATION** ppInfo ); 1499 1500 tiINT32 TI_AddKey (TI_HANDLE hAdapter, OS_802_11_KEY* pKey ); 1501 tiINT32 TI_RemoveKey (TI_HANDLE hAdapter, OS_802_11_REMOVE_KEY* pRemoveKey); 1502 1503 /****************************************************************************** 1504 1505 Add support for EXC API functions 1506 1507 ******************************************************************************/ 1508 EXC_SUPPORT_H 1509 1510 /*****************************************************************************/ 1511 1512 1513 1514 #ifdef __cplusplus 1515 } 1516 #endif 1517 1518 tiBOOL TI_CheckAdapterObject(void *pObj); 1519 1520 #endif /* _TI_ADAPTER_API_H*/ 1521 1522