From fc58b7ee667fb81df9a747df3da83ca5b0b8c304 Mon Sep 17 00:00:00 2001
From: Jordan Crouse <jordan.crouse@amd.com>
Date: Thu, 28 Aug 2008 23:12:34 +0000
Subject: [PATCH]: libpayload:  Document time functions

No code changes.

Signed-off-by: Jordan Crouse <jordan.crouse@amd.com>
Acked-by: Jordan Crouse <jordan.crouse@amd.com>


git-svn-id: svn://svn.coreboot.org/coreboot/trunk@3553 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
---
 payloads/libpayload/libc/time.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'payloads')

diff --git a/payloads/libpayload/libc/time.c b/payloads/libpayload/libc/time.c
index a04534554c..b49879b9d8 100644
--- a/payloads/libpayload/libc/time.c
+++ b/payloads/libpayload/libc/time.c
@@ -27,6 +27,10 @@
  * SUCH DAMAGE.
  */
 
+/** @file libc/time.c
+ * @brief General Time Functions
+ */
+
 #include <config.h>
 #include <libpayload.h>
 #include <arch/rdtsc.h>
@@ -110,6 +114,12 @@ static void gettimeofday_init(void)
 }
 #endif
 
+/**
+ * Return the current time broken into a timeval structure
+ * @param tv A pointer to a timeval structure
+ * @param tz Added for compatability - not used
+ * @return 0 for success
+ */
 int gettimeofday(struct timeval *tv, void *tz)
 {
 	/* Call the gtod init when we need it - this keeps
-- 
cgit v1.2.3