openocd: fix some minor typo
[fw/openocd] / src / helper / time_support.h
1 /***************************************************************************
2  *   Copyright (C) 2006 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
6  *   oyvind.harboe@zylin.com                                               *
7  *                                                                         *
8  *   Copyright (C) 2008 by Spencer Oliver                                  *
9  *   spen@spen-soft.co.uk                                                  *
10  *                                                                         *
11  *   This program is free software; you can redistribute it and/or modify  *
12  *   it under the terms of the GNU General Public License as published by  *
13  *   the Free Software Foundation; either version 2 of the License, or     *
14  *   (at your option) any later version.                                   *
15  *                                                                         *
16  *   This program is distributed in the hope that it will be useful,       *
17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
19  *   GNU General Public License for more details.                          *
20  *                                                                         *
21  *   You should have received a copy of the GNU General Public License     *
22  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
23  ***************************************************************************/
24
25 #ifndef OPENOCD_HELPER_TIME_SUPPORT_H
26 #define OPENOCD_HELPER_TIME_SUPPORT_H
27
28 #include <time.h>
29 #include "types.h"
30
31 #ifdef HAVE_SYS_TIME_H
32 #include <sys/time.h>
33 #endif
34
35 int timeval_subtract(struct timeval *result, struct timeval *x, struct timeval *y);
36 int timeval_add_time(struct timeval *result, long sec, long usec);
37 int timeval_compare(const struct timeval *x, const struct timeval *y);
38
39 /** @returns gettimeofday() timeval as 64-bit in ms */
40 int64_t timeval_ms(void);
41
42 struct duration {
43         struct timeval start;
44         struct timeval elapsed;
45 };
46
47 /** Update the duration->start field to start the @a duration measurement. */
48 int duration_start(struct duration *duration);
49 /** Update the duration->elapsed field to finish the @a duration measurement. */
50 int duration_measure(struct duration *duration);
51
52 /** @returns Elapsed time in seconds. */
53 float duration_elapsed(const struct duration *duration);
54 /** @returns KB/sec for the elapsed @a duration and @a count bytes. */
55 float duration_kbps(const struct duration *duration, size_t count);
56
57 #endif /* OPENOCD_HELPER_TIME_SUPPORT_H */