improved automake config. make dist, VPATH builds, ...
[btb/d2x.git] / include / timer.h
1 /*
2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.  
11 COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
12 */
13 /*
14  * $Source: /cvs/cvsroot/d2x/include/timer.h,v $
15  * $Revision: 1.1.1.2 $
16  * $Author: bradleyb $
17  * $Date: 2001-01-19 03:34:09 $
18  *
19  * Header for timer functions
20  *
21  * $Log: not supported by cvs2svn $
22  * Revision 1.1.1.1  1999/06/14 22:02:21  donut
23  * Import of d1x 1.37 source.
24  *
25  * Revision 1.8  1994/12/10  12:27:23  john
26  * Added timer_get_approx_seconds.
27  * 
28  * Revision 1.7  1994/12/10  12:10:25  john
29  * Added types.h.
30  * 
31  * 
32  * 
33  * 
34  * Revision 1.6  1994/12/10  12:07:06  john
35  * Added tick counter variable.
36  * 
37  * Revision 1.5  1994/11/15  12:04:15  john
38  * Cleaned up timer code a bit... took out unused functions
39  * like timer_get_milliseconds, etc.
40  * 
41  * Revision 1.4  1994/04/28  23:50:08  john
42  * Changed calling for init_timer.  Made the function that the
43  * timer calls be a far function. All of this was done to make
44  * our timer system compatible with the HMI sound stuff.
45  * 
46  * Revision 1.3  1994/02/17  15:57:12  john
47  * Changed key libary to C.
48  * 
49  * Revision 1.2  1994/01/18  10:58:34  john
50  * Added timer_get_fixed_seconds
51  * 
52  * Revision 1.1  1993/07/10  13:10:41  matt
53  * Initial revision
54  * 
55  *
56  */
57
58
59 #ifndef _TIMER_H
60 #define _TIMER_H
61
62 #include "pstypes.h"
63 #include "fix.h"
64
65 //==========================================================================
66 // This installs the timer services and interrupts at the rate specified by
67 // count_val.  If 'function' isn't 0, the function pointed to by function will
68 // be called 'freq' times per second.  Should be > 19 and anything around
69 // 2-3000 is gonna start slowing down the system.  Count_val should be
70 // 1,193,180 divided by your target frequency. Use 0 for the normal 18.2 Hz
71 // interrupt rate.
72
73 #define TIMER_FREQUENCY 1193180
74 #define _far
75 #define __far
76 #define __interrupt
77
78 extern void timer_init();
79 extern void timer_close();
80 extern void timer_set_rate(int count_val);
81 extern void timer_set_function( void _far * function );
82
83 //==========================================================================
84 // These functions return the time since the timer was initialized in
85 // some various units. The total length of reading time varies for each
86 // one.  They will roll around after they read 2^32.
87 // There are milliseconds, milliseconds times 10, milliseconds times 100,
88 // and microseconds.  They time out after 1000 hrs, 100 hrs, 10 hrs, and
89 // 1 hr, respectively.
90
91 extern fix timer_get_fixed_seconds();   // Rolls about every 9 hours...
92 #ifdef __ENV_DJGPP__
93 extern fix timer_get_fixed_secondsX(); // Assume interrupts already disabled
94 extern fix timer_get_approx_seconds();          // Returns time since program started... accurate to 1/120th of a second
95 extern void timer_set_joyhandler( void (*joy_handler)() );
96 #else
97 #define timer_get_fixed_secondsX timer_get_fixed_seconds
98 #define timer_get_approx_seconds timer_get_fixed_seconds
99 #endif
100
101 //NOT_USED extern unsigned int timer_get_microseconds();
102 //NOT_USED extern unsigned int timer_get_milliseconds100();
103 //NOT_USED extern unsigned int timer_get_milliseconds10();
104 //NOT_USED extern unsigned int timer_get_milliseconds();
105 //NOT_USED extern unsigned int timer_get_millisecondsX();       // Assume interrupts disabled
106
107 //==========================================================================
108 // Use to access the BIOS ticker... ie...   i = TICKER
109 #ifndef __ENV_DJGPP__
110 #define TICKER (timer_get_fixed_seconds())
111 #endif
112
113 #ifdef __ENV_DJGPP__
114
115 #ifndef __GNUC__
116 #define TICKER (*(volatile int *)0x46C)
117 #else
118 #include <go32.h>
119 #include <sys/farptr.h>
120 #define TICKER _farpeekl(_dos_ds, 0x46c)
121 #endif
122 #define USECS_PER_READING( start, stop, frames ) (((stop-start)*54945)/frames)
123 #endif
124
125 #endif