/*

 * TIWha.h

 *

 * Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.      

 * All rights reserved.      

 * 

 * This program and the accompanying materials are made available under the 

 * terms of the Eclipse Public License v1.0 or BSD License which accompanies

 * this distribution. The Eclipse Public License is available at

 * http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.                                   

 *                                                                       

 * 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  TIWha.h 

 *  \brief  Interface between the sandbox to the BSP of Omap2430

 *

 *  \see   

 */

#ifndef TIWha_H

#define TIWha_H

/* Includes that are rquired for using MWlanDfcClient */

#include <kernel/kernel.h>

#include <wlandfc.h>

#include <wlandfcclient.h>

#include <wlanpddiface.h>

/* Other driver includes*/

#include "TIWhaDef.h" /*struct and definitions neded for the TI WLAN driver*/

#include "TWDriver.h" /*interface with the HW abstraction of the WLAN driver*/

#include "TIWhaUtils.h"

#include "TIWlanHpaCB.h"

extern void Assert( const TInt8*, TInt, TBool );

/*

 * This is a class for Failure Indication DFC implementation

 */

class TIFailureDfcClient : public MWlanDfcClient

{

    public:        

        /** 

    	* \fn     TIFailureDfcClient

    	* \brief  Constructor

    	*

        * Create a MWlanDfc object.

    	* 

    	* \note

    	* \param  	aOsa

    	* return   handle to TIFailureDfcClient class.

    	* \sa

    	*/

        TIFailureDfcClient(MWlanOsa& aOsa);

        /** 

    	* \fn     OnDfc

    	* \brief  Call TIWhaAdaptCB::FailureIndicationDFC in order to handle the failure indication

        * from a different context

    	* 

    	* \note

    	* \param   aCtx - Relevant Context

    	* return   void

    	* \sa

    	*/

        virtual void OnDfc( TInt aCtx ); 

        /* A pointer to the relevant wlan DFC object */

        MWlanDfc* pFailureDfc;

};

/*

 * This is a class for Sync bus connection DFC implementation

 */

class TIConnectDfcClient : public MWlanDfcClient

{

    public:

        /** 

    	* \fn     TIConnectDfcClient

    	* \brief  Constructor

    	*     	

        * Create a MWlanDfc object.

    	* 

    	* \note

    	* \param  	aOsa

    	* return   handle to TIConnectDfcClient class.

    	* \sa

    	*/

        TIConnectDfcClient(MWlanOsa& aOsa);

        /** 

    	* \fn     OnDfc

    	* \brief  Call TIWhaAdaptCB::ConnectBus() in order to finish the bus connection procees

    	* 

    	* \note

    	* \param  	aCtx - Relevant Context

    	* return   void

    	* \sa

    	*/

        virtual void OnDfc( TInt aCtx ); 

        /* A pointer to the relevant wlan DFC object */

        MWlanDfc* pConnectDfc;

};

/**

* This is a class for TI WLAN driver implementation

*/

class TIWha :     public WHA::Wha , public DPhysicalDevice , public MWlanPddIface

{

public:  

	/** 

	* \fn     TIWha

	* \brief  Constructor

	* 

	*  TIWha constructor

	* 

	* \note   

	* \param  	aOsa

	* \param  aHpa

	* \param  aSpia

	* return   handle to TIWha class. 

	* \sa     

	*/ 

	TIWha(MWlanOsa& aOsa, WlanHpa& aHpa, WlanSpia& aSpia);

			/** 

	* \fn     TIWha

	* \brief  Constructor

	* 

	*  TIWha constructor

	* 

	* \note   

	* 

	* return   handle to TIWha class. 

	* \sa     

	*/ 

    TIWha();

	/** 

	 * \fn     ~TIWha

	 * \brief  destructor

	 * 

	 * Destroy TIWha object

	 * 

	 * \note   

	 * \param  

	 * \return   

	 * \sa     

	 */ 

	virtual ~TIWha();

	/* Call constructor */

	static Wha* Create( MWlanOsa& aOsa, 

	                    WlanHpa& aHpa, 

	                    const SHwBusAccessLayer& aTransPortLayer );

	/* Call destructor */

	static void Destroy( Wha* aWha );

	/** 

	 * \fn     WhaCb

	 * \brief  attach call back to LDD form the WLAN driver

	 * 

	 * \note   	in case error indication was received - return Null. That way we avoid calls to UMAC.

	 * \param  

	 * \return pointer to the Call Back function in the WHA (LDD)  

	 * \sa     

	 */ 	

    WHA::MWhaCb* WhaCb() {return iWhaCb;}

	/** 

	* \fn     FailureIndicationCb

	* \brief  Generic Error Indicatin function to the UMAC

	* 

	* sends the UMAC Error indications as agreed.

	* 

	* \note   

	* \param EFailureEvent  - the kind of error

	* \return 

	* \sa     

	*/         

	void FailureIndicationCb ( EFailureEvent failureEvent);    

    /** 

     * \fn     ConnectionTimeOut

     * \brief  change rate management parameters after the connection phase

     * 

     * \note    

     * \return  

     * \sa      

     */    

    void ConnectionTimeOut ();

    /** 

     * \fn     SetTxFailLowThreshold

     * \brief  Set new Tx Fail rate to FW

     * 

     * \note    

     * \return  

     * \sa      

     */    

    void SetTxFailLowThreshold( TI_UINT8 uTxFailLowTh);

   /** 

 * \fn     InitializeAfterTimer

 * \brief  start second part of initialization after timer expired

 *          

 * \note    

 * \param  

 * \return  

 * \sa      

 */ 

    void InitializeAfterTimer();

    /** 

     * \fn     RxMemFailTimerCb

     * \brief  call RxXfer in case memory allocation failed, so we will try again

     *          

     * \note    

     * \param  

     * \return  

     * \sa      

     */ 

    void RxMemFailTimerCb();

/*******************************************************************************

 *                                                                             *

 * WLAN Symbian HAL API command methods below.                                     *

 *                                                                             *

 *******************************************************************************/

    /** 

     * \fn     Initialize

     * \brief  Downloads the firmware code to the WLAN device

     * (reference wlanwha.h) 

     *          

     * \note    

     * \param  aData firmware data

     * \param  aLength length of the data in bytes

     * \return  

     * \sa      

     */ 

	void Initialize(

				   const void* aData, 

				   TUint32 aLength );

    /** 

     * \fn     Configure

     * \brief  Method configures the WLAN device after the WHA layer has send the EInitializeResponse event.

     * (reference wlanwha.h) 

     *          

     * \note    

     * \param  aData firmware data. The content is vendor specific.

     * \param  aWhaSettings output data that holds the capabilities

     * \return  

     * \sa      

     */ 

	void Configure(

		const WHA::SConfigureData&, 

		WHA::SSettings& aWhaSettings );

    /** 

     * \fn     Configure

     * \brief  Command will cause the WHA layer to release all OS resources and stop

	 * its operation. (reference wlanwha.h) 

     *          

     * \note    

     * \param  aSynchronous should command be executed synchronously (ETrue) or not (EFalse) 

     * \return Command was executed synchronously and no command response event is sent

     * \sa      

     */ 

 	WHA::TStatus Release( TBool aSynchronous );

    /** 

     * \fn     Scan

     * \brief  When the WLAN device receives this command, it goes into a scanning mode.

     * (reference wlanwha.h) 

     *          

     * \note    

     * \param  aMaxTransmitRate specifies the transmission rate of the probe request in case of a active scan

     * \param  aBand selects the used frequency band. 

     * \param aNumOfChannels number of channels provided in the command

	 * \param aChannels specifies the scanned channels

	 * \param aScanType specifies the scan type:0 foreground scan, 1 background scan, 2 forced background scan

	 * \param aNumOfProbeRequests number of probe requests (per SSID): sent to one (1) channel, Zero (0) means that none is send, 

	 * which means that a passive scan is to be done.  

	 * \param aNumOfSSID number of SSID provided in the scan command (this is zero (0) in broadcast scan)

	 * \param aSsid Array of the SSID to be probed in scan

     * \return 

     * \sa      

     */ 

	void Scan(  WHA::TRate                  aMaxTransmitRate, 

				WHA::TBand                  aBand,

				TUint8                      aNumOfChannels,

				const WHA::SChannels*   aChannels, 

				WHA::TScanType          aScanType,

				TUint8                      aNumOfProbeRequests,

				TBool                       aSplitScan,

				TUint8                      aNumOfSSID,

				const WHA::SSSID*       aSsid);

     /** 

     * \fn     StopScan

     * \brief  This method stops a previously started scan process in the WLAN device.

     * (reference wlanwha.h) 

     *          

     * \note    

     * \param 

     * \return

     * \sa      

     */ 

   void StopScan();

    /** 

    * \fn     Join

    * \brief  The WLAN host driver uses this method to command the WLAN device to 

	* join a BSS or an IBSS or to start an IBSS.(reference wlanwha.h) 

    *          

    * \note    

    * \param aMode specifies the operation mode of the station: 0 for IBSS, 1 for BSS

	* \param aBSSID specifies the BSSID of the BSS or IBSS to be joined or the IBSS to be started

	* \param aSSID specifies the SSID of the IBSS to join or start

	* \param aBand selects the used frequency band. Only 1 bit is used to select the band

	* \param aChannel specifies the channel number to join.

    * \param aBeaconInterval specifies the time between TBTTs in TUs

	* \param aBasicRateSet defines the BSS basic rate set

	* \param aAtimWindow ATIM window of IBSS

    * \param aPreambleType Specifies the PLCP preamble type used: 0 for long preamble, 1 for short preamble

    * \param aProbeForJoin specifies if a probe request should be send with the specified SSID when joining to the network. 

    * \return

    * \sa      

    */ 

	void Join(

			 WHA::TOperationMode aMode,

			 const WHA::TMacAddress& aBSSID,

			 const WHA::SSSID& aSSID, 

			 WHA::TBand aBand,

			 WHA::TChannelNumber aChannel,

			 TUint32 aBeaconInterval,

			 WHA::TRate aBasicRateSet,

			 TUint16 aAtimWindow,

			 WHA::TPreamble aPreambleType,

			 TBool aProbeForJoin );

    /** 

    * \fn     SetPsMode

    * \brief  The WLAN host driver uses this method to manipulate the WLAN devices 

	* 802.11 power management mode in infrastructure mode.(reference wlanwha.h) 

    *          

    * \note    

    * \param aPsMode desired 802.11 power management mode:0 - 802.11 power save disable, 1 - 802.11 power save enable

    * \return

    * \sa      

    */ 

	void SetPsMode( WHA::TPsMode aPsMode );

    /** 

    * \fn     SetBssParameters

    * \brief  The WLAN host driver uses this method to fix connection parameters 

	* after the initial connection setup (reference wlanwha.h) 

    *          

    * \note    

    * \param aDTIM specifies the DTIM interval in multiples of beacons

    * \param aAID specifies the AID received during the association process

    * \return

    * \sa      

    */ 

	void SetBssParameters(

						 TUint8 aDTIM, 

						 TUint16 aAID );

    /** 

    * \fn     Measure

    * \brief  This method starts radio measurements in the WLAN device.

    * (reference wlanwha.h) 

    *          

    * \note    

    * \param aTxPowerLevel used transmission power level during the measurement process. 

	* \param aBand selects the used frequency band. Only 1 bit is used to select the band

	* \param aChannel specifies the channel number.

    * \param aActivationDelay number of TBTTs until interval specified by the aMeasurementOffset starts.

    * \param aMeasurementOffset Time after the activation delay in TUs

	* \param aNumberOfMeasurementTypes number of measurement types to activate at parallel

	* \param aParameterSet specific measurement parameter set

    * \return

    * \sa      

    */ 

	void Measure(

				WHA::TPowerLevel aTxPowerLevel,

				WHA::TBand aBand,

				WHA::TChannelNumber aChannel,

				TUint8 aActivationDelay,

				TUint8 aMeasurementOffset,

				TUint8 aNumberOfMeasurementTypes,

				const WHA::SParameterSet* aParameterSet );

    /** 

    * \fn     StopMeasure

    * \brief  This method stops all previously started measurement processes in the WLAN device. 

    * (reference wlanwha.h) 

    *          

    * \note    

    * \param 

    * \return

    * \sa      

    */ 

	void StopMeasure();

    /** 

    * \fn     ReadMib

    * \brief  The WLAN host driver uses this method to read configuration 

	* information and statistics from the WLAN vendor specific solution. 

    * (reference wlanwha.h) 

    *          

    * \note    

    * \param aMib ID of the MIB to be accessed

    * \return

    * \sa      

    */ 

 	void ReadMib( WHA::TMib aMib );

    /** 

    * \fn     WriteMib

    * \brief  The WLAN host driver uses this method to write configuration 

	* information to the WLAN vendor specific solution

    * (reference wlanwha.h) 

    *          

    * \note    

    * \param aMib ID of the MIB to be written

	* \param aLength length of the MIB

	* \param aData pointer to the MIB data

	* \param aMore more MIBS are written after this command (ETrue) or not (EFalse) 

	* \return ESuccess: Command was executed synchronously and no command response event is sent

	*         EPending: Command is executed asynchronously and corresponding command response event 

    *                   will be sent upon command completion

    * \sa      

    */ 

	WHA::TStatus WriteMib(

						 WHA::TMib aMib,

						 TUint16 aLength,

						 const void* aData,

						 TBool aMore  );

    /** 

    * \fn     AddKey

    * \brief  This method adds a new (or replaces an old) encryption key to WLAN device

    * (reference wlanwha.h) 

    *          

    * \note    

    * \param aType type of the key to be added

	* \param aKey pointer to buffer specifying the key material, 

	* \param aEntryIndex

	* \return 

    * \sa      

    */ 

	void AddKey(

			   WHA::TKeyType aType, 

			   const void* aKey,

			   TUint8 aEntryIndex );

    /** 

    * \fn     RemoveKey

    * \brief  This method removes encryption keys from active key set. 

    * (reference wlanwha.h) 

    *          

    * \note    

    * \param aEntryIndex index of the key to remove from the set, Valid range: 0-8

    * \return 

    * \sa      

    */ 

	void RemoveKey( TUint8 aEntryIndex );

    /** 

    * \fn     ConfigureQueue

    * \brief  The WLAN host driver uses this method to configure QoS parameters of transmission queues 

    * (reference wlanwha.h) 

    *          

    * \note    

    * \param aQueueId ID for the queue

    * \param aMaxLifeTime dot11MaxTransmitMsduLifetime to be used for the specified queue. 

    * \param aPsScheme PS scheme of the specified queue: 0 Regular PS, 1 U-APSD, 2 Legacy PSPOLL,3 S-APSD [optional]

    * \param aSAPSDConfig

    * \param aQueueId ID for the queue

    * \param aAckPolicy ACK frame policy of the specified queue: 0 - normal, 1 - Tx no ACK [optional],2 - block ACK [optional]