release/src-rt-6.x.4708/cfe/cfe/include/cfe_timer.h

   1 /*  *********************************************************************
   2     *  Broadcom Common Firmware Environment (CFE)
   3     *
   4     *  Timer defs and prototypes                File: cfe_timer.h
   5     *
   6     *  Definitions, prototypes, and macros related to the timer.
   7     *
   8     *  Author:  Mitch Lichtenberg (mpl@broadcom.com)
   9     *
  10     *********************************************************************
  11     *
  12     *  Copyright 2000,2001,2002,2003
  13     *  Broadcom Corporation. All rights reserved.
  14     *
  15     *  This software is furnished under license and may be used and
  16     *  copied only in accordance with the following terms and
  17     *  conditions.  Subject to these conditions, you may download,
  18     *  copy, install, use, modify and distribute modified or unmodified
  19     *  copies of this software in source and/or binary form.  No title
  20     *  or ownership is transferred hereby.
  21     *
  22     *  1) Any source code used, modified or distributed must reproduce
  23     *     and retain this copyright notice and list of conditions
  24     *     as they appear in the source file.
  25     *
  26     *  2) No right is granted to use any trade name, trademark, or
  27     *     logo of Broadcom Corporation.  The "Broadcom Corporation"
  28     *     name may not be used to endorse or promote products derived
  29     *     from this software without the prior written permission of
  30     *     Broadcom Corporation.
  31     *
  32     *  3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR
  33     *     IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED
  34     *     WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  35     *     PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT
  36     *     SHALL BROADCOM BE LIABLE FOR ANY DAMAGES WHATSOEVER, AND IN
  37     *     PARTICULAR, BROADCOM SHALL NOT BE LIABLE FOR DIRECT, INDIRECT,
  38     *     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  39     *     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  40     *     GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  41     *     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  42     *     OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  43     *     TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF
  44     *     THE POSSIBILITY OF SUCH DAMAGE.
  45     ********************************************************************* */
  46
  47 #ifndef _CFE_TIMER_T
  48 #define _CFE_TIMER_T
  49
  50 void cfe_bg_init(void);
  51 void cfe_bg_add(void (*func)(void *),void *arg);
  52 void cfe_bg_remove(void (*func)(void *));
  53
  54 void background(void);
  55
  56 #define POLL() background()
  57
  58 typedef int64_t cfe_timer_t;
  59
  60 void cfe_timer_init(void);
  61 extern volatile int64_t cfe_ticks;
  62 extern int cfe_cpu_speed;
  63
  64 void cfe_sleep(int ticks);
  65 void cfe_usleep(int usec);
  66 void cfe_nsleep(int nsec);
  67
  68 #define CFE_HZ 10                       /* ticks per second */
  69
  70 #define TIMER_SET(x,v)  x = cfe_ticks + (v)
  71 #define TIMER_EXPIRED(x) ((x) && (cfe_ticks > (x)))
  72 #define TIMER_CLEAR(x) x = 0
  73 #define TIMER_RUNNING(x) ((x) != 0)
  74
  75 #endif