don't add confusing source info to Jim

[fw/openocd] / src / helper / time_support.h

diff --git a/src/helper/time_support.h b/src/helper/time_support.h
index 49c41c9d03d6e4ffaa3862c16047e4f41fd219d0..fab432d38d1c0fac843c42238ab98bbbd85aa3fd 100644 (file)
--- a/src/helper/time_support.h
+++ b/src/helper/time_support.h
@@ -2,9 +2,12 @@
  *   Copyright (C) 2006 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                      *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -34,19 +37,26 @@
 # endif
 #endif
 
-extern int timeval_subtract(struct timeval *result, struct timeval *x, struct timeval *y);
-extern int timeval_add(struct timeval *result, struct timeval *x, struct timeval *y);
-extern int timeval_add_time(struct timeval *result, int sec, int usec);
-/* gettimeofday() timeval in 64 bit ms */
-extern long long timeval_ms();
+int timeval_subtract(struct timeval *result, struct timeval *x, struct timeval *y);
+int timeval_add_time(struct timeval *result, long sec, long usec);
+
+/// @returns gettimeofday() timeval as 64-bit in ms
+int64_t timeval_ms(void);
 
-typedef struct duration_s
+struct duration
 {
        struct timeval start;
-       struct timeval duration;
-} duration_t;
+       struct timeval elapsed;
+};
+
+/// Update the duration->start field to start the @a duration measurement.
+int duration_start(struct duration *duration);
+/// Update the duration->elapsed field to finish the @a duration measurment.
+int duration_measure(struct duration *duration);
 
-extern int duration_start_measure(duration_t *duration);
-extern int duration_stop_measure(duration_t *duration, char **text);
+/// @returns Elapsed time in seconds.
+float duration_elapsed(struct duration *duration);
+/// @returns KB/sec for the elapsed @a duration and @a count bytes.
+float duration_kbps(struct duration *duration, size_t count);
 
 #endif /* TIME_SUPPORT_H */