00001 /* 00002 * Copyright (c) 2010, FIP AUTHORS 00003 * All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without 00006 * modification, are permitted provided that the following conditions are met: 00007 * 00008 * 1) Redistributions of source code must retain the above copyright notice, 00009 * this list of conditions and the following disclaimer. 00010 * 00011 * 2) Redistributions in binary form must reproduce the above copyright 00012 * notice, this list of conditions and the following disclaimer in the 00013 * documentation and/or other materials provided with the distribution. 00014 * 00015 * 3) Neither the name of the FIP AUTHORS nor the names of its contributors 00016 * may be used to endorse or promote products derived from this software 00017 * without specific prior written permission. 00018 * 00019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00021 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 00023 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00024 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 00025 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00026 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00027 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00028 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00029 * POSSIBILITY OF SUCH DAMAGE. 00030 */ 00031 /** 00032 * @addtogroup fip_timer 00033 * @{ 00034 */ 00035 /** 00036 * @file 00037 * FIP Timer Functions Header 00038 * 00039 * @author 00040 * Colin O'Flynn 00041 */ 00042 00043 #ifndef FIP_TIMER_H_ 00044 #define FIP_TIMER_H_ 00045 00046 /** 00047 * FIP's timer type holds the expiration time of a timer. Can be checked with 00048 * @ref fip_timer_isExpired32 to discover if the timer has expired or not. The 00049 * expiration values have several special types. All zeros indicates an infinite 00050 * time-out. The lowest bit is used as part of the roll-over detection. 00051 */ 00052 typedef uint16_t fip_timer16S_t; 00053 typedef uint32_t fip_timer32S_t; 00054 typedef uint32_t fip_timer32mS_t; 00055 00056 /** @todo Fix wrap-around by setting bit 1 in all timers */ 00057 00058 #define fip_timer_isExpired32(expireTime, currentTime) (((expireTime) & 0x01) && ((currentTime) > (expireTime))) 00059 #define fip_timer_isExpired16(expireTime, currentTime) (((expireTime) & 0x01) && ((currentTime) > (expireTime))) 00060 00061 00062 /** @todo is this true? */ 00063 #define TIMER_EXPIRED (1) 00064 00065 fip_timer16S_t fip_timer_getExpireTime16S(uint16_t time); 00066 fip_timer32S_t fip_timer_getExpireTime32S(uint32_t time); 00067 fip_timer32mS_t fip_timer_getExpireTime32miliS(uint32_t time); 00068 00069 #endif /* FIP_TIMER_H_ */ 00070 00071 /** @} */
1.5.7.1