timer_ticks.h
62555016
 /*
  * $Id$
  *
  *
  * timer frequency and ticks conversions
  *
  * Copyright (C) 2005 iptelorg GmbH
  *
08aaf730
  * This file is part of SIP-router, a free SIP server.
62555016
  *
08aaf730
  * SIP-router is free software; you can redistribute it and/or modify
62555016
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
08aaf730
  * SIP-router is distributed in the hope that it will be useful,
62555016
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License 
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 /* History:
  * --------
  *  2005-07-27  complete re-design/re-implemnetation (andrei)
7fc49b59
  *  2007-07-02  added ticks comparison macros (andrei)
62555016
  */
 
08aaf730
 /**
  * @file
  * @brief SIP-router core :: timer frequency and ticks conversions
  * @ingroup core
  * Module: @ref core
  */
 
62555016
 #ifndef _timer_ticks_h
 #define _timer_ticks_h
 
08aaf730
 /** @brief how many ticks per second (must >1 and < 100 (on linux x86))
62555016
  * recomended values >=8, <=32 (a 2^k value is better/faster)*/
 #define TIMER_TICKS_HZ	16U
 
08aaf730
 /** @brief how many ticks per m milliseconds? (rounded up) */
62555016
 #define MS_TO_TICKS(m)  (((m)*TIMER_TICKS_HZ+999U)/1000U)
 
 
08aaf730
 /** @brief how many ticks per s seconds? */
62555016
 #define S_TO_TICKS(s)	((s)*TIMER_TICKS_HZ)
 
 
08aaf730
 /** @brief how many s pe per t ticks, integer value */
62555016
 #define TICKS_TO_S(t)	((t)/TIMER_TICKS_HZ)
 
08aaf730
 /** @brief how many ms per t ticks, integer value */
62555016
 #define TICKS_TO_MS(t) (((t)*1000U)/TIMER_TICKS_HZ)
 
 
08aaf730
 /** @brief ticks comparison operations: t1 OP t2, where OP can be <, >, <=, >= */
7fc49b59
 #define TICKS_CMP_OP(t1, t2, OP) \
 	(((s_ticks_t)((ticks_t)(t1)-(ticks_t)(t2))) OP (s_ticks_t)0)
08aaf730
 /** @brief t1 < t2 */
7fc49b59
 #define TICKS_LT(t1, t2)  TICKS_CMP_OP(t1, t2, <)
08aaf730
 /** @brief t1 <= t2 */
7fc49b59
 #define TICKS_LE(t1, t2)  TICKS_CMP_OP(t1, t2, <=)
08aaf730
 /** @brief t1 > t2 */
7fc49b59
 #define TICKS_GT(t1, t2)  TICKS_CMP_OP(t1, t2, >)
08aaf730
 /** @brief t1 >= t2 */
7fc49b59
 #define TICKS_GE(t1, t2)  TICKS_CMP_OP(t1, t2, >=)
 
 
ef9e3860
 typedef unsigned int ticks_t;/* type used to keep the ticks (must be 32 bits)*/
 typedef signed   int s_ticks_t; /* signed ticks type */
62555016
 
 #endif