Overhaul time support API

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

diff --git a/src/helper/time_support.h b/src/helper/time_support.h
index a8036766fcb303a0b28c3d8bb6820fbb21950975..9e8e61f19df6f9fd8933e8138cdafa8fb47a9db7 100644 (file)
--- a/src/helper/time_support.h
+++ b/src/helper/time_support.h
@@ -37,19 +37,27 @@
 # 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(void);
+int timeval_subtract(struct timeval *result, struct timeval *x, struct timeval *y);
+int timeval_add(struct timeval *result, struct timeval *x, struct timeval *y);
+int timeval_add_time(struct timeval *result, int sec, int usec);
 
-typedef struct duration_s
+/// @returns gettimeofday() timeval as 64-bit in ms
+long long timeval_ms(void);
+
+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 void 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 */