TWD/MacServices/Export_Inc/MacServices_api.h
changeset 0 10c42ec6c05f
equal deleted inserted replaced
-1:000000000000 0:10c42ec6c05f
       
     1 /*
       
     2  * MacServices_api.h
       
     3  *
       
     4  * Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.      
       
     5  * All rights reserved.      
       
     6  * 
       
     7  * This program and the accompanying materials are made available under the 
       
     8  * terms of the Eclipse Public License v1.0 or BSD License which accompanies
       
     9  * this distribution. The Eclipse Public License is available at
       
    10  * http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.                                   
       
    11  *                                                                       
       
    12  * Redistribution and use in source and binary forms, with or without    
       
    13  * modification, are permitted provided that the following conditions    
       
    14  * are met:                                                              
       
    15  *                                                                       
       
    16  *  * Redistributions of source code must retain the above copyright     
       
    17  *    notice, this list of conditions and the following disclaimer.      
       
    18  *  * Redistributions in binary form must reproduce the above copyright  
       
    19  *    notice, this list of conditions and the following disclaimer in    
       
    20  *    the documentation and/or other materials provided with the         
       
    21  *    distribution.                                                      
       
    22  *  * Neither the name Texas Instruments nor the names of its            
       
    23  *    contributors may be used to endorse or promote products derived    
       
    24  *    from this software without specific prior written permission.      
       
    25  *                                                                       
       
    26  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS   
       
    27  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT     
       
    28  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
       
    29  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  
       
    30  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
       
    31  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT      
       
    32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
       
    33  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
       
    34  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT   
       
    35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
       
    36  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       
    37  */
       
    38 
       
    39 /** \file MacServicesApi.h
       
    40  *  \brief This file include public definitions for the MacServices module, comprising its API.
       
    41  *  \date 6-Oct-2005
       
    42  */
       
    43 
       
    44 #ifndef __MACSERVICESAPI_H__
       
    45 #define __MACSERVICESAPI_H__
       
    46 
       
    47 #include "osApi.h"
       
    48 
       
    49 /*
       
    50  ***********************************************************************
       
    51  *	Constant definitions.
       
    52  ***********************************************************************
       
    53  */
       
    54 
       
    55 /*
       
    56  ***********************************************************************
       
    57  *	Enums.
       
    58  ***********************************************************************
       
    59  */
       
    60 
       
    61 /*
       
    62  ***********************************************************************
       
    63  *	Typedefs.
       
    64  ***********************************************************************
       
    65  */
       
    66 
       
    67 
       
    68 
       
    69 /*
       
    70  ***********************************************************************
       
    71  *	Structure definitions.
       
    72  ***********************************************************************
       
    73  */
       
    74 
       
    75 /*
       
    76  ***********************************************************************
       
    77  *	External data definitions.
       
    78  ***********************************************************************
       
    79  */
       
    80 
       
    81 /*
       
    82  ***********************************************************************
       
    83  *	External functions definitions
       
    84  ***********************************************************************
       
    85  */
       
    86 /**
       
    87  * \date 6-Oct-2004\n
       
    88  * \brief Creates MacServices module
       
    89  *
       
    90  * Function Scope \e Public.\n
       
    91  * \param hOS - handle to the OS object.\n
       
    92  */
       
    93 TI_HANDLE MacServices_create( TI_HANDLE hOS );
       
    94 
       
    95 /**
       
    96  * \date 6-Oct-2004\n
       
    97  * \brief Destroys MacServices module
       
    98  *
       
    99  * Function Scope \e Public.\n
       
   100  * \param hMacServices - handle to the MacServices object.\n
       
   101  */
       
   102 void MacServices_destroy( TI_HANDLE hMacServices );
       
   103 
       
   104 /**
       
   105  * \date  6-Oct-2004\n
       
   106  * \brief Initializes the MacServices module
       
   107  *
       
   108  * Function Scope \e Public.\n
       
   109  * \param hMacServices - handle to the Mac Services object.\n
       
   110  * \param hReport - handle to the report object.\n
       
   111  * \param hTWD - handle to the HAL ctrl object.\n
       
   112  * \param hCmdBld - handle to the HAL ctrl object.\n
       
   113  * \param hEventMbpx - handle to the HAL ctrl object.\n
       
   114  */
       
   115 void MacServices_init (TI_HANDLE hMacServices, 
       
   116                        TI_HANDLE hReport, 
       
   117                        TI_HANDLE hTWD, 
       
   118                        TI_HANDLE hCmdBld, 
       
   119                        TI_HANDLE hEventMbox, 
       
   120                        TI_HANDLE hTimer);
       
   121 void MacServices_config (TI_HANDLE hMacServices, TTwdInitParams *pInitParams);
       
   122 void MacServices_restart (TI_HANDLE hMacServices);
       
   123 
       
   124 void MacServices_registerFailureEventCB (TI_HANDLE hMacServices, void * failureEventCB, TI_HANDLE hFailureEventObj);
       
   125 
       
   126 
       
   127 /***********************************************************************
       
   128  *	Scan SRV API functions
       
   129  ***********************************************************************/
       
   130 
       
   131 
       
   132 /**
       
   133  * \author Ronen Kalish\n
       
   134  * \date 29-Dec-2004\n
       
   135  * \brief Registers a complete callback for scan complete notifications.
       
   136  *
       
   137  * Function Scope \e Public.\n
       
   138  * \param hMacServices - handle to the MacServices object.\n
       
   139  * \param scanCompleteCB - the complete callback function.\n
       
   140  * \param hScanCompleteObj - handle to the object passed to the scan complete callback function.\n
       
   141  */
       
   142 void MacServices_scanSRV_registerScanCompleteCB( TI_HANDLE hMacServices, 
       
   143                                      TScanSrvCompleteCb scanCompleteCB, TI_HANDLE hScanCompleteObj );
       
   144 
       
   145 
       
   146 
       
   147 /**
       
   148  * \author Ronen Kalish\n
       
   149  * \date 29-Dec-2004\n
       
   150  * \brief Performs a scan
       
   151  *
       
   152  * Function Scope \e Public.\n
       
   153  * \param hMacServices - handle to the MacServices object.\n
       
   154  * \param scanParams - the scan specific parameters.\n
       
   155  * \param eScanTag - tag used for result and scan complete tracking
       
   156  * \param bHighPriority - whether to perform a high priority (overlaps DTIM) scan.\n
       
   157  * \param bDriverMode - whether to try to enter driver mode (with PS on) before issuing the scan command.\n
       
   158  * \param bScanOnDriverModeError - whether to proceed with the scan if requested to enter driver mode and failed.\n
       
   159  * \param bSendNullData - whether to send Null data when exiting driver mode on scan complete.\n
       
   160  * \param psRequest - Parameter sent to PowerSaveServer on PS request to indicate PS on or "keep current" 
       
   161  * \param commandResponseFunc - CB function which called after downloading the command. \n
       
   162  * \param commandResponseObj -  The CB function Obj (Notice : last 2 params are NULL in Legacy run). \n
       
   163   * \return TI_OK if successful (various, TBD codes if not).\n
       
   164  */
       
   165 TI_STATUS MacServices_scanSRV_scan( TI_HANDLE hMacServices, TScanParams *scanParams, EScanResultTag eScanTag,
       
   166                                     TI_BOOL bHighPriority, TI_BOOL bDriverMode, TI_BOOL bScanOnDriverModeError, 
       
   167 						E80211PsMode psRequest, TI_BOOL bSendNullData,
       
   168 						TCmdResponseCb commandResponseFunc, TI_HANDLE commandResponseObj );
       
   169 
       
   170 /**
       
   171  * \author Ronen Kalish\n
       
   172  * \date 29-Dec-2004\n
       
   173  * \brief Stops a scan in progress
       
   174  *
       
   175  * Function Scope \e Public.\n
       
   176  * \param hMacServices - handle to the MacServices object.\n
       
   177  * \param eScanTag - scan tag, used for scan complete and result tracking
       
   178  * \param bSendNullData - indicates whether to send Null data when exiting driver mode.\n
       
   179  * \param commandResponseFunc - CB function which called after downloading the command. \n
       
   180  * \param commandResponseObj -  The CB function Obj (Notice : last 2 params are NULL in Legacy run). \n
       
   181  * \return TI_OK if successful (various, TBD codes if not).\n
       
   182  */
       
   183 TI_STATUS MacServices_scanSRV_stopScan( TI_HANDLE hMacServices, EScanResultTag eScanTag, TI_BOOL bSendNullData,
       
   184                                         TCmdResponseCb commandResponseFunc, TI_HANDLE commandResponseObj );
       
   185 
       
   186 /**
       
   187  * \author Ronen Kalish\n
       
   188  * \date 17-Jan-2005\n
       
   189  * \brief Notifies the scan SRV of a FW reset (that had originally been reported by a different module).\n
       
   190  *
       
   191  * Function Scope \e Public.\n
       
   192  * \param hMacServices - handle to the MacServices object.\n
       
   193  * \return TI_OK if successful (various, TBD codes if not).\n
       
   194  */
       
   195 TI_STATUS MacServices_scanSRV_stopOnFWReset( TI_HANDLE hMacServices );
       
   196 
       
   197 /**
       
   198  * \author Ronen Kalish\n
       
   199  * \date 29-Dec-2004\n
       
   200  * \brief callback function used by the power manager to notify driver mode result
       
   201  *
       
   202  * Function Scope \e Public.\n
       
   203  * \param hScanSRV - handle to the scan SRV object.\n
       
   204  * \param psStatus - the power save request status.\n
       
   205  */
       
   206 void MacServices_scanSRV_powerSaveCB( TI_HANDLE hScanSRV, TI_UINT8 PSMode,TI_UINT8 psStatus );
       
   207 
       
   208 /**
       
   209  * \author Ronen Kalish\n
       
   210  * \date 29-Dec-2004\n
       
   211  * \brief Callback function used by the HAL ctrl to notify scan complete
       
   212  *
       
   213  * Function Scope \e Public.\n
       
   214  * \param hScanSRV - handle to the scan SRV object.\n
       
   215  * \param str - pointer to scan result buffer (holding SPS status for SPS scan only!).\n
       
   216  * \param strLen - scan result buffer length (should ALWAYS be 2, even for non SPS scans).\n
       
   217  */
       
   218 void MacServices_scanSRV_scanCompleteCB( TI_HANDLE hScanSRV, char* str, TI_UINT32 strLen );
       
   219 
       
   220 /**
       
   221  * \author Ronen Kalish\n
       
   222  * \date 29-Dec-2004\n
       
   223  * \brief called when a scan timer expires. Completes the scan and starts a recovery process.
       
   224  *
       
   225  * Function Scope \e Public.\n
       
   226  * \param hScanSRV - handle to the scan SRV object.\n
       
   227  */
       
   228 void MacServices_scanSRV_scanTimerExpired (TI_HANDLE hScanSRV, TI_BOOL bTwdInitOccured);
       
   229 
       
   230 void MacServices_scanSrv_UpdateDtimTbtt (TI_HANDLE hMacServices, 
       
   231                                          TI_UINT8  uDtimPeriod, 
       
   232                                          TI_UINT16 uBeaconInterval);
       
   233 
       
   234 #ifdef TI_DBG
       
   235 /**
       
   236  * \author Shirit Brook\n
       
   237  * \date God knows when...\n
       
   238  * \brief Prints Scan Server SM status.\n
       
   239  *
       
   240  * Function Scope \e Public.\n
       
   241  * \param hMacServices - handle to the Mac Services object.\n
       
   242  */
       
   243 void MacServices_scanSrv_printDebugStatus(TI_HANDLE hMacServices);
       
   244 #endif
       
   245 
       
   246 /*Power server API*/
       
   247 
       
   248 
       
   249 /**
       
   250   * \author Assaf Azulay
       
   251  * \date 24-Oct-2005\n
       
   252  * \brief request PS by User
       
   253  *
       
   254  * Function Scope \e Public.\n
       
   255  * Parameters:\n
       
   256  * 1) hPowerSrv 						- handle to the PowerSrv object.\n		
       
   257  * 2) psMode							- Power save/Active request.\n
       
   258  * 3) sendNullDataOnExit				- \n
       
   259  * 4) powerSaveCompleteCBObject		- handle to the Callback functin module.\n
       
   260  * 5) powerSaveCompleteCB				- Calback function - for success/faild notification.\n
       
   261  * 6) powerSavecmdResponseCB			- Calback function - for GWSI success/faild notification.\n
       
   262  * Return Value: TI_STATUS - TI_OK / PENDING / TI_NOK.\n
       
   263  * \b Description:\n
       
   264  * This function is a user mode request from the Power Save Server./n
       
   265  * it will create a Request from typ "USER_REQUEST" and will try to perform the user request for PS/Active./n
       
   266  * this will be done in respect of priority to Driver request./n
       
   267  */
       
   268 TI_STATUS MacServices_powerSrv_SetPsMode(TI_HANDLE 	                hMacServices,
       
   269                                 		 E80211PsMode	            psMode,
       
   270  									     TI_BOOL  						sendNullDataOnExit,
       
   271  						        		 void * 					powerSaveCompleteCBObject,
       
   272  						        		 TPowerSaveCompleteCb  		powerSaveCompleteCB,
       
   273  						        		 TPowerSaveResponseCb	    powerSavecmdResponseCB);
       
   274 
       
   275 
       
   276 /**
       
   277   * \author Assaf Azulay
       
   278  * \date 24-Oct-2005\n
       
   279  * \brief SW configure, use to override the current PowerMode (what ever it will be) to
       
   280  *        active/PS combined with awake/power-down. use for temporary change the system policy.
       
   281  *
       
   282  * Function Scope \e Public.\n
       
   283  * Parameters:\n
       
   284  * 1) TI_HANDLE - handle to the powerSrv object.\n
       
   285  * 2) powerSrv_RequestFor_802_11_PS_e - the driver mode obliged to be in 802.11 PS or not change.\n
       
   286  * 3) PowerCtrl_PowerLevel_e - the desired driver power level (allowed: AWAKE or POWER DOWN).\n
       
   287  * 4) TI_HANDLE theObjectHandle - the handle the object that need the PS success/fail notification.\n
       
   288  * 5) ps802_11_NotificationCB_t - the callback function.\n
       
   289  * 6) char* - the clinet name that ask for driver mode.\n
       
   290  * Return Value: TI_STATUS - if success (already in power save) then TI_OK,\n
       
   291  *                           if pend (wait to ACK form AP for the null data frame) then PENDING\n
       
   292  *                           if PS isn't enabled then POWER_SAVE_802_11_NOT_ALLOWED\n
       
   293  *                           else TI_NOK.\n
       
   294  * \b Description:\n
       
   295  * enter in to configuration of the driver that in higher priority from the user.\n
       
   296  * the configuration is:\n
       
   297  *  - to enter to802.11 PS or not (if not this isn't a request to get out from 802.11 PS).\n
       
   298  *  - to change the HW power level to awake or power-down if not already there.
       
   299  *    this is a must request.\n
       
   300 */
       
   301 TI_STATUS MacServices_powerSrv_ReservePS(	TI_HANDLE 	                hMacServices,
       
   302                                             E80211PsMode 	            psMode,
       
   303                                             TI_BOOL  						sendNullDataOnExit,
       
   304                                             void * 						powerSaveCBObject,
       
   305                                             TPowerSaveCompleteCb 		powerSaveCompleteCB);
       
   306 
       
   307 
       
   308 /**
       
   309  * \author Assaf Azulay
       
   310  * \date 24-Oct-2005\n
       
   311  * \brief end the temporary change of system policy, and returns to the user system policy.
       
   312  *
       
   313  * Function Scope \e Public.\n
       
   314  * Parameters:\n
       
   315  * 1) TI_HANDLE - handle to the powerSrv object.\n
       
   316  * 2) char* - the clinet name that ask for driver mode.\n
       
   317  * Return Value: TI_STATUS - TI_OK on success else TI_NOK.\n
       
   318  * \b Description:\n
       
   319  * enter in to configuration of the driver that in higher priority from the user.\n
       
   320  * the configuration is:\n
       
   321  * end the user mode configuration (driver mode priority) and returns the user configuration
       
   322  * (user mode priority).
       
   323 */
       
   324 TI_STATUS MacServices_powerSrv_ReleasePS( 	TI_HANDLE 	hMacServices,
       
   325 									TI_BOOL  						sendNullDataOnExit,
       
   326  						 			void *  						powerSaveCBObject,
       
   327  									TPowerSaveCompleteCb  			powerSaveCompleteCB);
       
   328 
       
   329 
       
   330 /**
       
   331  * \author Assaf Azulay
       
   332  * \date 24-Oct-2005\n
       
   333  * \brief reflects the actual state of the state machine
       
   334  *
       
   335  * Function Scope \e Public.\n
       
   336  * Parameters:\n
       
   337  * 1) TI_HANDLE - handle to the powerSrv object.\n
       
   338  * Return Value:\n 
       
   339  * TI_BOOL - thre is in PS false otherwise.\n
       
   340 */
       
   341 TI_BOOL MacServices_powerSrv_getPsStatus(TI_HANDLE hMacServices);
       
   342 
       
   343 
       
   344 /**
       
   345  * \author Assaf Azulay
       
   346  * \date 24-Oct-2005\n
       
   347  * \sets the rate as got from user else sets default value.\n
       
   348  *
       
   349  * Function Scope \e Public.\n
       
   350  * Parameters:\n
       
   351  * 1) TI_HANDLE 	- handle to the powerSrv object.\n
       
   352  * 2) TI_UINT16		- desierd rate .\n
       
   353  * Return Value:\n 
       
   354  * void.\n
       
   355 */
       
   356 void MacServices_powerSrv_SetRateModulation(TI_HANDLE hMacServices, TI_UINT16  rate);
       
   357 /**
       
   358  * \Return the alrweady seted rate.\n
       
   359  *
       
   360  * Function Scope \e Public.\n
       
   361  * Parameters:\n
       
   362  * TI_HANDLE 	- handle to the powerSrv object.\n
       
   363  * Return Value: TI_UINT16		- desierd rate .\n
       
   364  * void.\n
       
   365 */
       
   366 TI_UINT32 MacServices_powerSrv_GetRateModulation(TI_HANDLE hMacServices);
       
   367 
       
   368 
       
   369 
       
   370 
       
   371 /***********************************************************************
       
   372  *	Measurement SRV API functions
       
   373  ***********************************************************************/
       
   374 
       
   375 /**
       
   376  * \author Ronen Kalish\n
       
   377  * \date 09-November-2005\n
       
   378  * \brief Starts a measurement operation.\n
       
   379  *
       
   380  * Function Scope \e Public.\n
       
   381  * \param hMacServices - handle to the MacServices object.\n
       
   382  * \param pMsrRequest - a structure containing measurement parameters.\n
       
   383  * \param timeToRequestExpiryMs - the time (in milliseconds) the measurement SRV has to start the request.\n
       
   384  * \param cmdResponseCBFunc - callback function to used for command response.\n
       
   385  * \param cmdResponseCBObj - handle to pass to command response CB.\n
       
   386  * \param cmdCompleteCBFunc - callback function to be used for command complete.\n
       
   387  * \param cmdCompleteCBObj - handle to pass to command complete CB.\n
       
   388  * \return TI_OK if successful (various, TBD codes if not).\n
       
   389  */ 
       
   390 TI_STATUS MacServices_measurementSRV_startMeasurement( TI_HANDLE hMacServices, 
       
   391                                                        TMeasurementRequest* pMsrRequest,
       
   392 													   TI_UINT32 timeToRequestExpiryMs,
       
   393                                                        TCmdResponseCb cmdResponseCBFunc,
       
   394                                                        TI_HANDLE cmdResponseCBObj,
       
   395                                                        TMeasurementSrvCompleteCb cmdCompleteCBFunc,
       
   396                                                        TI_HANDLE cmdCompleteCBObj );
       
   397 
       
   398 /**
       
   399  * \author Ronen Kalish\n
       
   400  * \date 09-November-2005\n
       
   401  * \brief Stops a measurement operation in progress.\n
       
   402  *
       
   403  * Function Scope \e Public.\n
       
   404  * \param hMacServices - handle to the MacServices object.\n
       
   405  * \param bSendNullData - whether to send NULL data when exiting driver mode.\n
       
   406  * \param cmdResponseCBFunc - callback function to used for command response.\n
       
   407  * \param cmdResponseCBObj - handle to pass to command response CB.\n
       
   408  * \return TI_OK if successful (various, TBD codes if not).\n
       
   409  */
       
   410 TI_STATUS MacServices_measurementSRV_stopMeasurement( TI_HANDLE hMacServices,
       
   411 													  TI_BOOL bSendNullData,
       
   412                                                       TCmdResponseCb cmdResponseCBFunc,
       
   413                                                       TI_HANDLE cmdResponseCBObj );
       
   414 
       
   415 /**
       
   416  * \author Ronen Kalish\n
       
   417  * \date 09-November-2005\n
       
   418  * \brief Notifies the measurement SRV of a FW reset (recovery).\n
       
   419  *
       
   420  * Function Scope \e Public.\n
       
   421  * \param hMacServices - handle to the MacServices object.\n
       
   422  */
       
   423 void MacServices_measurementSRV_FWReset( TI_HANDLE hMacServices );
       
   424 
       
   425 /** 
       
   426  * \author Ronen Kalish\n
       
   427  * \date 09-November-2005\n
       
   428  * \brief callback function used by the power manager to notify driver mode result
       
   429  *
       
   430  * Function Scope \e Public.\n
       
   431  * \param hMeasurementSRV - handle to the measurement SRV object.\n
       
   432  * \param PSMode - the power save mode the STA is currently in.\n
       
   433  * \param psStatus - the power save request status.\n
       
   434  */
       
   435 void MacServices_measurementSRV_powerSaveCB( TI_HANDLE hMeasurementSRV, TI_UINT8 PSMode,TI_UINT8 psStatus );
       
   436 
       
   437 /** 
       
   438  * \author Ronen Kalish\n
       
   439  * \date 14-November-2005\n
       
   440  * \brief callback function used by the HAL for measure start event (sent when the FW 
       
   441  * has started measurement operation, i.e. switched channel and changed RX filters).\n
       
   442  *
       
   443  * Function Scope \e Public.\n
       
   444  * \param hMeasurementSRV - handle to the measurement SRV object.\n
       
   445  */
       
   446 void MacServices_measurementSRV_measureStartCB( TI_HANDLE hMeasurementSRV );
       
   447 
       
   448 /** 
       
   449  * \author Ronen Kalish\n
       
   450  * \date 14-November-2005\n
       
   451  * \brief callback function used by the HAL for measure stop event (sent when the FW 
       
   452  * has finished measurement operation, i.e. switched channel to serving channel and changed back RX filters).\n
       
   453  *
       
   454  * Function Scope \e Public.\n
       
   455  * \param hMeasurementSRV - handle to the measurement SRV object.\n
       
   456  */
       
   457 void MacServices_measurementSRV_measureCompleteCB( TI_HANDLE hMeasurementSRV );
       
   458 
       
   459 /** 
       
   460  * \author Ronen Kalish\n
       
   461  * \date 14-November-2005\n
       
   462  * \brief callback function used by the HAL for AP discovery stop event (sent when the FW 
       
   463  * has finished AP discovery operation).\n
       
   464  *
       
   465  * Function Scope \e Public.\n
       
   466  * \param hMeasurementSRV - handle to the measurement SRV object.\n
       
   467  */
       
   468 void MacServices_measurementSRV_apDiscoveryCompleteCB( TI_HANDLE hMeasurementSRV );
       
   469 
       
   470 /** 
       
   471  * \author Ronen Kalish\n
       
   472  * \date 16-November-2005\n
       
   473  * \brief Callback for channel load get param call.\n
       
   474  *
       
   475  * Function Scope \e Public.\n
       
   476  * \param hMeasurementSRV - handle to the measurement SRV object.\n
       
   477  * \param status - the get_param call status.\n
       
   478  * \param CB_buf - pointer to the results buffer (already on the measurement SRV object)
       
   479  */
       
   480 void MacServices_measurementSRV_channelLoadParamCB( TI_HANDLE hMeasurementSRV, TI_STATUS status, TI_UINT8* CB_buf );
       
   481 
       
   482 /** 
       
   483  * \date 03-January-2005\n
       
   484  * \brief Dummy callback for channel load get param call. Used to clear the channel load tracker.\n
       
   485  *
       
   486  * Function Scope \e Public.\n
       
   487  * \param hMeasurementSRV - handle to the measurement SRV object.\n
       
   488  * \param status - the get_param call status.\n
       
   489  * \param CB_buf - pointer to the results buffer (already on the measurement SRV object)
       
   490  */
       
   491 void MacServices_measurementSRV_dummyChannelLoadParamCB( TI_HANDLE hMeasurementSRV, TI_STATUS status, TI_UINT8* CB_buf );
       
   492 
       
   493 /** 
       
   494  * \author Ronen Kalish\n
       
   495  * \date 16-November-2005\n
       
   496  * \brief Callback for noise histogram get param call.\n
       
   497  *
       
   498  * Function Scope \e Public.\n
       
   499  * \param hMeasurementSRV - handle to the measurement SRV object.\n
       
   500  * \param status - the get_param call status.\n
       
   501  * \param CB_buf - pointer to the results buffer (already on the measurement SRV object)
       
   502  */
       
   503 void MacServices_measurementSRV_noiseHistCallBack(TI_HANDLE hMeasurementSRV, TI_STATUS status, TI_UINT8* CB_buf);
       
   504 
       
   505 /**
       
   506  * \author Ronen Kalish\n
       
   507  * \date 14-November-2005\n
       
   508  * \brief called when a measurement FW guard timer expires.
       
   509  *
       
   510  * Function Scope \e Public.\n
       
   511  * \param hMeasuremntSRV - handle to the measurement SRV object.\n
       
   512  */
       
   513 void MacServices_measurementSRV_startStopTimerExpired (TI_HANDLE hMeasurementSRV, TI_BOOL bTwdInitOccured);
       
   514 
       
   515 /**
       
   516  * \author Ronen Kalish\n
       
   517  * \date 15-November-2005\n
       
   518  * \brief called when a measurement type timer expires.\n
       
   519  *
       
   520  * Function Scope \e Public.\n
       
   521  * \param hMeasuremntSRV - handle to the measurement SRV object.\n
       
   522  */
       
   523 void MacServices_measurementSRV_requestTimerExpired (TI_HANDLE hMeasurementSRV, TI_BOOL bTwdInitOccured);
       
   524 
       
   525 #endif /* __MACSERVICESAPI_H__ */