Doc fixes.
[bertos.git] / os / hptime.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief Portable abstraction for high-resolution time handling (interface)
34  *
35  * \author Bernardo Innocenti <bernie@develer.com>
36  */
37 #ifndef HPTIME_H
38 #define HPTIME_H
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif /* __cplusplus */
43
44 #ifdef _WIN32
45
46         /** our type for "high precision absolute time" */
47         typedef __int64 hptime_t;
48
49         #define HPTIME_TICKS_PER_SECOND         (10000000I64)
50         #define HPTIME_TICKS_PER_MILLISEC       (10000I64)
51         #define HPTIME_TICKS_PER_MICRO          (10I64)
52
53 #elif defined(__unix__) || (defined(__APPLE__) && defined(__MACH__))
54
55         #include <stdint.h> /* int64_t */
56
57         #ifndef DEVLIB_MTIME_DEFINED
58                 #define DEVLIB_MTIME_DEFINED 1 /* Resolve conflict with <cfg/compiler.h> */
59                 typedef int32_t mtime_t;
60                 #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
61                 #define MTIME_INFINITE 0x7FFFFFFFL
62         #endif
63
64         /** Type for "high precision absolute time". */
65         typedef int64_t hptime_t;
66
67         #define HPTIME_TICKS_PER_SECOND         (1000000LL)
68         #define HPTIME_TICKS_PER_MILLISEC       (1000LL)
69         #define HPTIME_TICKS_PER_MICRO          (1LL)
70
71 #else /* !__unix__ */
72         #error OS dependent support code missing for this OS
73 #endif /* !__unix__ */
74
75 /**
76  * Return the current time with the maximum precision made available from the hosting OS
77  */
78 extern hptime_t hptime_get(void);
79
80 #ifdef __cplusplus
81 }
82 #endif /* __cplusplus */
83
84 #endif /* HPTIME_H */