wilink_6_1/stad/src/AirLink_Managment/requestHandler.h

/*
 * requestHandler.h
 *
 * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved.      
 * All rights reserved.                                                  
 *                                                                       
 * Redistribution and use in source and binary forms, with or without    
 * modification, are permitted provided that the following conditions    
 * are met:                                                              
 *                                                                       
 *  * Redistributions of source code must retain the above copyright     
 *    notice, this list of conditions and the following disclaimer.      
 *  * Redistributions in binary form must reproduce the above copyright  
 *    notice, this list of conditions and the following disclaimer in    
 *    the documentation and/or other materials provided with the         
 *    distribution.                                                      
 *  * Neither the name Texas Instruments nor the names of its            
 *    contributors may be used to endorse or promote products derived    
 *    from this software without specific prior written permission.      
 *                                                                       
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS   
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT     
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT      
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT   
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** \file requestHandler.h
 *  \brief Request Handler module interface header file
 *
 *  \see requestHandler.c
 */

/***************************************************************************/
/*                                                                          */
/*    MODULE:   requestHandler.h                                            */
/*    PURPOSE:  Request Handler module interface header file                */
/*                                                                          */
/***************************************************************************/
#ifndef __REQUEST_HANDLER_H__
#define __REQUEST_HANDLER_H__

#include "paramOut.h"
#include "802_11Defs.h"
#include "measurementMgrApi.h"


typedef struct 
{
    EMeasurementType            Type;
    TI_BOOL                     isParallel; 
    TI_UINT16                   frameToken; 
    TI_UINT16                   measurementToken;
    TI_UINT8                    channelNumber;
    TI_UINT16                   DurationTime;
    TI_UINT8                    ActualDurationTime;
    EMeasurementScanMode        ScanMode;
} MeasurementRequest_t;


/* Functions Pointers Definitions */
typedef TI_STATUS (*parserRequestIEHdr_t)   (TI_UINT8 *pData, TI_UINT16 *reqestLen,
                                             TI_UINT16 *measurementToken);

typedef struct 
{
    /* Function to the Pointer */
    parserRequestIEHdr_t    parserRequestIEHdr;

    /* General Params */
    MeasurementRequest_t    reqArr[MAX_NUM_REQ];
    TI_UINT8                numOfWaitingRequests;   
    TI_INT8                 activeRequestID;

    /* Handlers */
    TI_HANDLE               hReport;
    TI_HANDLE               hOs;
} requestHandler_t;



TI_HANDLE requestHandler_create(TI_HANDLE hOs);

TI_STATUS RequestHandler_config(TI_HANDLE   hRequestHandler,
                                TI_HANDLE       hReport,
                                TI_HANDLE       hOs);

TI_STATUS requestHandler_setParam(TI_HANDLE hRequestHandler,
                                  paramInfo_t   *pParam);

TI_STATUS requestHandler_getParam(TI_HANDLE     hRequestHandler,
                                            paramInfo_t *pParam);

TI_STATUS requestHandler_destroy(TI_HANDLE hRequestHandler);

TI_STATUS requestHandler_insertRequests(TI_HANDLE hRequestHandler,
                                        EMeasurementMode measurementMode,
                                        TMeasurementFrameRequest measurementFrameReq);

TI_STATUS requestHandler_getNextReq(TI_HANDLE hRequestHandler,
                                    TI_BOOL   isForActivation,
                                    MeasurementRequest_t *pRequest[],
                                    TI_UINT8*     numOfRequests);

TI_STATUS requestHandler_getCurrentExpiredReq(TI_HANDLE hRequestHandler,
                                              TI_UINT8 requestIndex,
                                              MeasurementRequest_t **pRequest);

TI_STATUS requestHandler_clearRequests(TI_HANDLE hRequestHandler);

TI_STATUS requestHandler_getFrameToken(TI_HANDLE hRequestHandler,TI_UINT16 *frameToken );

TI_STATUS requestHandler_setRequestParserFunction(TI_HANDLE hRequestHandler, 
                                                  parserRequestIEHdr_t parserRequestIEHdr);


#endif /* __REQUEST_HANDLER_H__*/