atomtimer.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2010, Kelvin Lawson. All rights reserved.
00003  *
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions
00006  * are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. No personal names or organizations' names associated with the
00014  *    Atomthreads project may be used to endorse or promote products
00015  *    derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT AND CONTRIBUTORS
00018  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
00019  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00020  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 #ifndef __ATOM_TIMER_H
00031 #define __ATOM_TIMER_H
00032 
00033 #include "atomport.h"
00034 
00035 
00036 /* Callback function prototype */
00037 typedef void ( * TIMER_CB_FUNC ) ( POINTER cb_data ) ;
00038 
00039 /* Data structures */
00040 
00041 /* Timer descriptor */
00042 typedef struct atom_timer
00043 {
00044     TIMER_CB_FUNC   cb_func;    /* Callback function */
00045     POINTER         cb_data;    /* Pointer to callback parameter/data */
00046     uint32_t        cb_ticks;   /* Ticks until callback */
00047 
00048     /* Internal data */
00049     struct atom_timer *next_timer;      /* Next timer in doubly-linked list */
00050 
00051 } ATOM_TIMER;
00052 
00053 /* Function prototypes */
00054 
00055 extern uint8_t atomTimerRegister (ATOM_TIMER *timer_ptr);
00056 extern uint8_t atomTimerCancel (ATOM_TIMER *timer_ptr);
00057 extern uint8_t atomTimerDelay (uint32_t ticks);
00058 extern uint32_t atomTimeGet (void);
00059 extern void atomTimeSet (uint32_t new_time);
00060 
00061 #endif /* __ATOM_TIMER_H */

Generated on Fri Jun 4 01:00:01 2010 for atomthreads by  doxygen 1.6.1