OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [rtos/] [freertos-6.1.1/] [Demo/] [Common/] [ethernet/] [FreeTCPIP/] [sys/] [timer.h] - Blame information for rev 606

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 606 jeremybenn
/** \addtogroup sys
2
 * @{ */
3
 
4
/**
5
 * \defgroup timer Timer library
6
 *
7
 * The Contiki kernel does not provide support for timed
8
 * events. Rather, an application that wants to use timers needs to
9
 * explicitly use the timer library.
10
 *
11
 * The timer library provides functions for setting, resetting and
12
 * restarting timers, and for checking if a timer has expired. An
13
 * application must "manually" check if its timers have expired; this
14
 * is not done automatically.
15
 *
16
 * A timer is declared as a \c struct \c timer and all access to the
17
 * timer is made by a pointer to the declared timer.
18
 *
19
 * \note The timer library is not able to post events when a timer
20
 * expires. The \ref etimer "Event timers" should be used for this
21
 * purpose.
22
 *
23
 * \note The timer library uses the \ref clock "Clock library" to
24
 * measure time. Intervals should be specified in the format used by
25
 * the clock library.
26
 *
27
 * \sa \ref etimer "Event timers"
28
 *
29
 * @{
30
 */
31
 
32
/**
33
 * \file
34
 * Timer library header file.
35
 * \author
36
 * Adam Dunkels <adam@sics.se>
37
 */
38
 
39
/*
40
 * Copyright (c) 2004, Swedish Institute of Computer Science.
41
 * All rights reserved.
42
 *
43
 * Redistribution and use in source and binary forms, with or without
44
 * modification, are permitted provided that the following conditions
45
 * are met:
46
 * 1. Redistributions of source code must retain the above copyright
47
 *    notice, this list of conditions and the following disclaimer.
48
 * 2. Redistributions in binary form must reproduce the above copyright
49
 *    notice, this list of conditions and the following disclaimer in the
50
 *    documentation and/or other materials provided with the distribution.
51
 * 3. Neither the name of the Institute nor the names of its contributors
52
 *    may be used to endorse or promote products derived from this software
53
 *    without specific prior written permission.
54
 *
55
 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
56
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
57
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
58
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
59
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
60
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
61
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
62
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
63
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
64
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
65
 * SUCH DAMAGE.
66
 *
67
 * This file is part of the Contiki operating system.
68
 *
69
 * Author: Adam Dunkels <adam@sics.se>
70
 *
71
 * $Id: timer.h 2 2011-07-17 20:13:17Z filepang@gmail.com $
72
 */
73
#ifndef __TIMER_H__
74
#define __TIMER_H__
75
 
76
#include "sys/clock.h"
77
 
78
/**
79
 * A timer.
80
 *
81
 * This structure is used for declaring a timer. The timer must be set
82
 * with timer_set() before it can be used.
83
 *
84
 * \hideinitializer
85
 */
86
struct timer
87
{
88
        clock_time_t    start;
89
        clock_time_t    interval;
90
};
91
 
92
void                    timer_set( struct timer *t, clock_time_t interval );
93
void                    timer_reset( struct timer *t );
94
void                    timer_restart( struct timer *t );
95
int                             timer_expired( struct timer *t );
96
clock_time_t    timer_remaining( struct timer *t );
97
#endif /* __TIMER_H__ */
98
 
99
/** @} */
100
 
101
/** @} */

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.