cm-kernel /drivers/net/wireless/tiwlan1251/common/src/core/data_ctrl/Ctrl/TrafficMonitor/TrafficMonitor.h

Language C/C++ Header Lines 153
MD5 Hash a76900dcc9f6ca2f403e61854f858696 Estimated Cost $1,557 (why?)
Repository git://github.com/CyanogenMod/cm-kernel.git View Raw File View Project SPDX
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/****************************************************************************
**+-----------------------------------------------------------------------+**
**|                                                                       |**
**| Copyright(c) 1998 - 2008 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.  |**
**|                                                                       |**
**+-----------------------------------------------------------------------+**
****************************************************************************/

/***************************************************************************/
/*                                                                         */                                                                        
/*    MODULE:       TrafficMonitor.h                                       */
/*    PURPOSE:  TrafficMonitor module Header file                          */
/*                                                                         */                                                                        
/***************************************************************************/
#ifndef _TRAFFIC_MONITOR_H
#define _TRAFFIC_MONITOR_H


#include "osTIType.h"
#include "GeneralUtilApi.h"
#include "TrafficMonitorAPI.h"

/* time interval to load for the down limit alert Timer *
 *(TrafficMonitor_t->TrafficMonTimer)                   */
#define MIN_MONITOR_INTERVAL  50 /*mSec*/

/*The max number of Alert Element that the traffic monitor will be able to Manage.*/
#define MAX_MONITORED_REQ     32

/* The max number of Alert element that can                *
 * be associated to other alert element for reset condition*/
#define MAX_RST_ELMENT_PER_ALERT 3

/* BW Window in MS. changing this number must take NUM_OF_SLIDING_WINDOWS into consideration  */ 
#define BW_WINDOW_MS			1000

#define NUM_OF_SLIDING_WINDOWS 8							/* Must be power of 2 !!!							 */
#define CYCLIC_COUNTER_ELEMENT (NUM_OF_SLIDING_WINDOWS - 1)	/* Note that it is aligned to NUM_OF_SLIDING_WINDOWS */

#define SIZE_OF_WINDOW_MS	   ( BW_WINDOW_MS / NUM_OF_SLIDING_WINDOWS) /* 125 Ms */

/* BandWidth_t 
	This struct is used for the sliding windows algorithm used to calculate the band width */
typedef struct
{
	UINT32           uCurrentWindow;
	UINT32			 auFirstEventsTS[NUM_OF_SLIDING_WINDOWS];			
    UINT32           auWindowCounter[NUM_OF_SLIDING_WINDOWS];
}BandWidth_t;


/* The traffic manger class structure */
typedef struct
{
    BOOL                Active;
    TI_HANDLE           NotificationRegList;
    TI_HANDLE           hOs;
    TI_HANDLE           TrafficMonTimer;
    TI_HANDLE           hRxData;
    TI_HANDLE           hTxData;
   
    TI_HANDLE           TxRegReqHandle;
    TI_HANDLE           RxRegReqHandle;
    
    BandWidth_t         DirectTxFrameBW;
    BandWidth_t         DirectRxFrameBW;
    
    UINT8		        trafficDownTestIntervalPercent;	/* Percentage of max down events test interval     */
                                                        /*to use in our "traffic down" timer               */    
    BOOL                DownTimerEnabled;	/* Indicates whether the "down traffic" timer is active or not */
    
}TrafficMonitor_t;


/* Function definition that used for event Aggregation/filtering/etc.. */
typedef VOID (*TraffActionFunc_t)(TI_HANDLE TraffElem,int Count); 
                
/* This enum holds the event providers that are optional in the system */
typedef enum
{
        TX_TRAFF_MODULE                                 = 0,
        RX_TRAFF_MODULE                         = 1,
    MAX_NUM_MONITORED_MODULES, /* Don't move this enum this index defines the 
                                  number of module that can be monitored.*/                   
}MonModuleTypes_t;



/*
 *      Alert State option enum 
 *  0.  disabled
 *  1.  ON but not active
 *  2.  ON and active
 */
typedef enum {
    ALERT_WAIT_FOR_RESET = 0,          /* Event has been triggered, awaiting reset event to occur */
        ALERT_OFF,
    ALERT_ON
}TraffAlertState_t;


/* Basic Alert element structure */
typedef struct AlertElement_t
{
    /*initial param*/
    TraffAlertState_t   CurrentState; 
    int                             EventCounter;
    int                             Threshold;
    UINT32                              TimeOut;  
    TraffDirection_t    Direction;
    TraffTrigger_t      Trigger;
    BOOL                Enabled;
    int                             LastCounte;
        TraffEevntCall_t        CallBack;
    TI_HANDLE           Context ;
    UINT32              Cookie;    
    UINT32              TimeIntervalMs;               
    BOOL                AutoCreated;
    BOOL                RstWasAssigned;
    TraffActionFunc_t   ActionFunc;
    UINT32              MonitorMask[MAX_NUM_MONITORED_MODULES];
    struct AlertElement_t  *ResetElment[MAX_RST_ELMENT_PER_ALERT];     
}TrafficAlertElement_t;

#endif
Back to Top