CORE/MAC/src/pe/include/pmmGlobal.h

/*
 * Copyright (c) 2012-2013 The Linux Foundation. All rights reserved.
 *
 * Previously licensed under the ISC license by Qualcomm Atheros, Inc.
 *
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all
 * copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

/*
 * This file was originally distributed by Qualcomm Atheros, Inc.
 * under proprietary terms before Copyright ownership was assigned
 * to the Linux Foundation.
 */

/*
 *
 * Author:      Sandesh Goel
 * Date:        02/25/02
 * History:-
 * Date            Modified by    Modification Information
 * --------------------------------------------------------------------
 *
 */

#ifndef __PMM_GLOBAL_H__
#define __PMM_GLOBAL_H__

#include "sirApi.h"

typedef struct sPmmStaState
{
    /// Whether this STA is in powersave or not
    tANI_U8 powerSave : 1;
    /// Whether this STA is CF-pollable or not
    tANI_U8 cfPollable : 1;
    /// counter to indicate PS state update due to asynchronous PS Poll
    tANI_U8 psPollUpdate:2;

    /// Reserved
    tANI_U8 rsvd : 4;

    /// Index of the next STA in PS closest to this one
    tANI_U8 nextPS;
} tPmmStaState, *tpPmmStaState;


#define NO_STATE_CHANGE 0xFF

typedef enum ePmmState
{
    ePMM_STATE_INVALID,
    ePMM_STATE_READY,
    //BMPS
    ePMM_STATE_BMPS_WT_INIT_RSP,
    ePMM_STATE_BMPS_WT_SLEEP_RSP,
    ePMM_STATE_BMPS_SLEEP,
    ePMM_STATE_BMPS_WT_WAKEUP_RSP,
    ePMM_STATE_BMPS_WAKEUP,
    //IMPS
    ePMM_STATE_IMPS_WT_SLEEP_RSP,
    ePMM_STATE_IMPS_SLEEP,
    ePMM_STATE_IMPS_WT_WAKEUP_RSP,
    ePMM_STATE_IMPS_WAKEUP,
    //UAPSD
    ePMM_STATE_UAPSD_WT_SLEEP_RSP,
    ePMM_STATE_UAPSD_SLEEP,
    ePMM_STATE_UAPSD_WT_WAKEUP_RSP,

    //WOWLAN
    ePMM_STATE_WOWLAN,

    ePMM_STATE_ERROR,
    ePMM_STATE_LAST,
}tPmmState;

typedef struct sPmmStaInfo
{
    tANI_U16 assocId;
    tANI_U32 staTxAckCnt;
}tPmmStaInfo, *tpPmmStaInfo;

typedef struct sPmmTim
{
    tANI_U8 *pTim;                    /** Tim Bit Array*/
    tANI_U8 minAssocId;
    tANI_U8 maxAssocId;
    tANI_U8 dtimCount;
    /** Remaining Members are needed for LinkMonitaring of the STA in PS*/
    tANI_U8 numStaWithData;  /** Number of stations in power save, who have data pending*/
    tpPmmStaInfo    pStaInfo;   /** Points to 1st Instant of the Array of MaxSTA StaInfo */
} tPmmTim, *tpPmmTim;

typedef struct sAniSirPmm
{


    //tANI_U32 disModeBeforeSleeping;
    //tANI_U32 txMCastCtrl;
    //tANI_U32 nListenBeforeSleeping;
    //tANI_U32 txTrafficIdleThreshold;
    //tANI_U32 rxTrafficIdleThreshold;
    //tANI_U32 ledInfoBeforeSleeping;


    tANI_U64 BmpsmaxSleepTime;
    tANI_U64 BmpsavgSleepTime;
    tANI_U64 BmpsminSleepTime;
    tANI_U64 BmpscntSleep;

    tANI_U64 BmpsmaxTimeAwake;
    tANI_U64 BmpsavgTimeAwake;
    tANI_U64 BmpsminTimeAwake;
    tANI_U64 BmpscntAwake;

    tANI_U64 BmpsWakeupTimeStamp;
    tANI_U64 BmpsSleepTimeStamp;

    // debug statistics
    tANI_U64 BmpsPktDrpInSleepMode;
    tANI_U64 BmpsInitFailCnt;
    tANI_U64 BmpsSleeReqFailCnt;
    tANI_U64 BmpsWakeupReqFailCnt;
    tANI_U64 BmpsInvStateCnt;
    tANI_U64 BmpsWakeupIndCnt;
    tANI_U64 BmpsHalReqFailCnt;
    tANI_U64 BmpsReqInInvalidRoleCnt;

    /* Add wakeup and sleep time stamps here */
    tANI_U64 ImpsWakeupTimeStamp;
    tANI_U64 ImpsSleepTimeStamp;

    tANI_U64 ImpsMaxTimeAwake;
    tANI_U64 ImpsMinTimeAwake;
    tANI_U64 ImpsAvgTimeAwake;
    tANI_U64 ImpsCntAwake;

    tANI_U64 ImpsCntSleep;
    tANI_U64 ImpsMaxSleepTime;
    tANI_U64 ImpsMinSleepTime;
    tANI_U64 ImpsAvgSleepTime;

    tANI_U64 ImpsSleepErrCnt;
    tANI_U64 ImpsWakeupErrCnt;
    tANI_U64 ImpsLastErr;

    tANI_U64 ImpsInvalidStateCnt;
    tANI_U64 ImpsPktDrpInSleepMode;


   /// Next STA to be serviced in PS state
    tANI_U16 gPmmNextSta;

    /// Next CF-pollable STA to be serviced in PS state
    tANI_U16 gPmmNextCFPSta;

    /// Number of STAs in PS state
    tANI_U16 gPmmNumSta;

    tANI_U8  gPmmPsPollUpdate:1; // set when any sta state is update due to PS-Poll
    tANI_U8  rsvd: 7;

   /// STA Power management state array
    /**
     * An entry in this array records the power save state for an STA
     * It also points to the next closest STA in power save state.
     */

    tANI_U32 gPmmBeaconInterval;     //pmm keeps its won copy of beacon interval, default to 100ms
    tSirPowerSaveCfg gPmmCfg;  //pmm keeps a copy of Power Save config parameters sent to softmac.
    /// Current PM state of the station
    tPmmState gPmmState;
    /// Flag to track if we are in a missed beacon scenario
    tANI_U8 inMissedBeaconScenario;

    tPmmTim gPmmTim;


    //Reason for which PMC is sending an EXIT_BMPS_REQ to PE
    tExitBmpsReason   gPmmExitBmpsReasonCode;
    tANI_U8  sessionId;      //This sessio Id is added to know the bsstype , infra/btamp .......in power save mode

} tAniSirPmm, *tpAniSirPmm;

#endif