Make #include guard naming consistent

[openocd] / src / helper / time_support.h

diff --git a/src/helper/time_support.h b/src/helper/time_support.h
index 8594eb226e63e43b41dad67eab52222bcf22aff7..58c8c48bb1a9abc1ba66ecf2a5cefb5c5867dc58 100644 (file)
--- a/src/helper/time_support.h
+++ b/src/helper/time_support.h
@@ -2,7 +2,7 @@
  *   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                                  *
@@ -19,12 +19,11 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
-#ifndef TIME_SUPPORT_H
-#define TIME_SUPPORT_H
+
+#ifndef OPENOCD_HELPER_TIME_SUPPORT_H
+#define OPENOCD_HELPER_TIME_SUPPORT_H
 
 #ifdef TIME_WITH_SYS_TIME
 # include <sys/time.h>
@@ -37,19 +36,25 @@
 # 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_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(const struct duration *duration);
+/** @returns KB/sec for the elapsed @a duration and @a count bytes. */
+float duration_kbps(const struct duration *duration, size_t count);
 
-#endif /* TIME_SUPPORT_H */
+#endif /* OPENOCD_HELPER_TIME_SUPPORT_H */