Minor fixes to comments.
[AROS.git] / rom / timer / subtime.c
blobc5defb5260bb227df2c0bd6e4607c6d3a36067ff
1 /*
2 Copyright © 1995-2011, The AROS Development Team. All rights reserved.
3 $Id$
5 Desc: SubTime - subtract two timevals from each other.
6 Lang: english
7 */
9 #include <devices/timer.h>
11 #include "timer_macros.h"
13 /*****************************************************************************
15 NAME */
16 #include <devices/timer.h>
17 #include <proto/timer.h>
19 AROS_LH2(void, SubTime,
21 /* SYNOPSIS */
22 AROS_LHA(struct timeval *, dest, A0),
23 AROS_LHA(struct timeval *, src, A1),
25 /* LOCATION */
26 struct Device *, TimerBase, 8, Timer)
28 /* FUNCTION
29 SubTime() will subtract the src timeval from the destination
30 timeval, ie "dest - src --> dest".
32 INPUTS
33 dest - Destination timeval
34 src - Source timeval
36 RESULT
37 The timeval dest will contain the sum (dest - src).
39 NOTES
40 This function is safe to call from interrupts.
42 EXAMPLE
44 BUGS
45 May not preserve registers.
47 SEE ALSO
48 AddTime(), CmpTime()
50 INTERNALS
52 HISTORY
53 18-02-1997 iaint Implemented.
55 *****************************************************************************/
57 AROS_LIBFUNC_INIT
59 SUBTIME(dest, src);
61 AROS_LIBFUNC_EXIT
63 } /* SubTime */