From: Simon Glass <sjg@chromium.org>
Date: Mon, 22 May 2017 11:05:26 +0000 (-0600)
Subject: bootstage: Fix up code style and comments
X-Git-Url: http://git.dujemihanovic.xyz/?a=commitdiff_plain;h=cbcd6970ad802b8b6c5acf79d42a870256b62fbb;p=u-boot.git

bootstage: Fix up code style and comments

There are several code style and comment nits. Fix them and also remove
the comment about passing bootstage to the kernel being TBD. This is
already supported.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

diff --git a/common/bootstage.c b/common/bootstage.c
index 5026705a86..a959026946 100644
--- a/common/bootstage.c
+++ b/common/bootstage.c
@@ -8,8 +8,6 @@
 /*
  * This module records the progress of boot and arbitrary commands, and
  * permits accurate timestamping of each.
-  *
- * TBD: Pass timings to kernel in the FDT
  */
 
 #include <common.h>
@@ -84,6 +82,7 @@ ulong bootstage_add_record(enum bootstage_id id, const char *name,
 
 	/* Tell the board about this progress */
 	show_boot_progress(flags & BOOTSTAGEF_ERROR ? -id : id);
+
 	return mark;
 }
 
@@ -105,6 +104,7 @@ ulong bootstage_mark_name(enum bootstage_id id, const char *name)
 
 	if (id == BOOTSTAGE_ID_ALLOC)
 		flags = BOOTSTAGEF_ALLOC;
+
 	return bootstage_add_record(id, name, flags, timer_get_boot_us());
 }
 
@@ -142,6 +142,7 @@ uint32_t bootstage_start(enum bootstage_id id, const char *name)
 
 	rec->start_us = timer_get_boot_us();
 	rec->name = name;
+
 	return rec->start_us;
 }
 
@@ -153,6 +154,7 @@ uint32_t bootstage_accum(enum bootstage_id id)
 
 	duration = (uint32_t)timer_get_boot_us() - rec->start_us;
 	rec->time_us += duration;
+
 	return duration;
 }
 
diff --git a/include/bootstage.h b/include/bootstage.h
index e1aec1b549..41bd61785c 100644
--- a/include/bootstage.h
+++ b/include/bootstage.h
@@ -217,7 +217,7 @@ ulong timer_get_boot_us(void);
 #if defined(USE_HOSTCC)
 #define show_boot_progress(val) do {} while (0)
 #else
-/*
+/**
  * Board code can implement show_boot_progress() if needed.
  *
  * @param val	Progress state (enum bootstage_id), or -id if an error
@@ -235,7 +235,7 @@ void show_boot_progress(int val);
  *
  * Call this after relocation has happened and after malloc has been initted.
  * We need to copy any pointers in bootstage records that were added pre-
- * relocation, since memory can be overritten later.
+ * relocation, since memory can be overwritten later.
  * @return Always returns 0, to indicate success
  */
 int bootstage_relocate(void);
@@ -251,7 +251,7 @@ int bootstage_relocate(void);
 ulong bootstage_add_record(enum bootstage_id id, const char *name,
 			   int flags, ulong mark);
 
-/*
+/**
  * Mark a time stamp for the current boot stage.
  */
 ulong bootstage_mark(enum bootstage_id id);
@@ -310,7 +310,7 @@ void bootstage_report(void);
  */
 int bootstage_fdt_add_report(void);
 
-/*
+/**
  * Stash bootstage data into memory
  *
  * @param base	Base address of memory buffer