misc changes/cleanup/ bug fixes

[keystone-rtos/netapi.git] / ti / runtime / netapi / src / timer_loc.h

diff --git a/ti/runtime/netapi/src/timer_loc.h b/ti/runtime/netapi/src/timer_loc.h
index 5bcdbc1c8c3d5a70a91bad6413a40e4795ba752b..a0535aa8dad0323b3fe07312f7e485d62d6e9dc3 100644 (file)
--- a/ti/runtime/netapi/src/timer_loc.h
+++ b/ti/runtime/netapi/src/timer_loc.h
@@ -32,18 +32,20 @@ typedef struct TIM_LIST_tAG
 } TIM_LIST_T;
 
 
+//the timer group context
 typedef struct TIMER_GROUP_Tag
 {
   NETAPI_T  h;       //back pointer
-  int n_cells;       //#of cells (hash entries
+  int n_cells;       //#of cells (hash entries)
   int n_timers;      //# of timer objects
-  int cell_width;    //size of each cell (mask)
+  int cell_width;    //size of each cell in ticks
   TIM_LIST_T free;   //free list of timer objects
-  TIM_LIST_T * cells;//active timers
-  unsigned long long last_polled;
-  NETAPI_TIMER_CB_T cb;
-  int local;
-  int exp2cancel;
+  TIM_LIST_T * cells;//active timers hash table
+  unsigned long long last_polled;  //in ticks
+  NETAPI_TIMER_CB_T cb; //timer callback
+  int local;   //1 => local timer, 0 =>global timer
+  int exp2cancel; //1=> expect to cancel, 0=> expect to fire
+  int tol;     //in ticks  [FUTURE]
 } TIMER_GROUP_T;
 
 /**********************INTERNAL API*******************/