timer.h

Go to the documentation of this file.

/* Copyright (c) 2007 Axel Wachtler
   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 of the authors 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. */

/*$Id: timer_8h_source.html,v 1.1.1.4 2013/04/09 21:11:39 awachtler Exp $ */
#ifndef TIMER_H
#define TIMER_H
/* === includes ============================================================ */
#include <stdint.h>

/* === macros ============================================================== */
#define MSEC(v) ((time_t)(v / (1.0e3 * TIMER_TICK)))

#define USEC(v) ((time_t)(v / (1.0e6 * TIMER_TICK)))



/* === types =============================================================== */

/* === prototypes ========================================================== */
#ifdef __cplusplus
extern "C" {
#endif

typedef uint32_t time_t;


typedef struct time_stamp_tag
{
    time_t  time_sec;
    time_t  time_usec;
} time_stamp_t;


typedef uint32_t timer_arg_t;

typedef uint16_t timer_hdl_t;

typedef time_t (timer_handler_t)(timer_arg_t p);

#define NONE_TIMER (0)

/* === Prototypes ================================ */
void timer_init(void);

timer_hdl_t timer_start(timer_handler_t *thfunc, time_t duration,
                        timer_arg_t arg);


timer_hdl_t timer_restart(timer_hdl_t th, time_t duration);

timer_hdl_t timer_stop(timer_hdl_t th);

time_t timer_systime(void);


void timer_set_systime(time_t sec);

void timer_get_tstamp(time_stamp_t *ts);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* TIMER_H */