Merge branch '2020-05-18-reduce-size-of-common.h'

[oweals/u-boot.git] / lib / trace.c

diff --git a/lib/trace.c b/lib/trace.c
index a13e5bf228b3889e89243278431d244187d97527..ea8c8e0d406ff86eb0ee0f5f4902b8b2197ecf90 100644 (file)
--- a/lib/trace.c
+++ b/lib/trace.c
@@ -5,6 +5,7 @@
 
 #include <common.h>
 #include <mapmem.h>
+#include <time.h>
 #include <trace.h>
 #include <asm/io.h>
 #include <asm/sections.h>
@@ -129,13 +130,13 @@ static void __attribute__((no_instrument_function)) add_textbase(void)
 }
 
 /**
- * This is called on every function entry
+ * __cyg_profile_func_enter() - record function entry
  *
  * We add to our tally for this function and add to the list of called
  * functions.
  *
- * @param func_ptr     Pointer to function being entered
- * @param caller       Pointer to function which called this function
+ * @func_ptr:  pointer to function being entered
+ * @caller:    pointer to function which called this function
  */
 void __attribute__((no_instrument_function)) __cyg_profile_func_enter(
                void *func_ptr, void *caller)
@@ -160,12 +161,10 @@ void __attribute__((no_instrument_function)) __cyg_profile_func_enter(
 }
 
 /**
- * This is called on every function exit
+ * __cyg_profile_func_exit() - record function exit
  *
- * We do nothing here.
- *
- * @param func_ptr     Pointer to function being entered
- * @param caller       Pointer to function which called this function
+ * @func_ptr:  pointer to function being entered
+ * @caller:    pointer to function which called this function
  */
 void __attribute__((no_instrument_function)) __cyg_profile_func_exit(
                void *func_ptr, void *caller)
@@ -179,23 +178,23 @@ void __attribute__((no_instrument_function)) __cyg_profile_func_exit(
 }
 
 /**
- * Produce a list of called functions
+ * trace_list_functions() - produce a list of called functions
  *
  * The information is written into the supplied buffer - a header followed
  * by a list of function records.
  *
- * @param buff         Buffer to place list into
- * @param buff_size    Size of buffer
- * @param needed       Returns size of buffer needed, which may be
- *                     greater than buff_size if we ran out of space.
- * @return 0 if ok, -1 if space was exhausted
+ * @buff:      buffer to place list into
+ * @buff_size: size of buffer
+ * @needed:    returns size of buffer needed, which may be
+ *             greater than buff_size if we ran out of space.
+ * Return:     0 if ok, -ENOSPC if space was exhausted
  */
-int trace_list_functions(void *buff, int buff_size, unsigned int *needed)
+int trace_list_functions(void *buff, size_t buff_size, size_t *needed)
 {
        struct trace_output_hdr *output_hdr = NULL;
        void *end, *ptr = buff;
-       int func;
-       int upto;
+       size_t func;
+       size_t upto;
 
        end = buff ? buff + buff_size : NULL;
 
@@ -206,7 +205,7 @@ int trace_list_functions(void *buff, int buff_size, unsigned int *needed)
 
        /* Add information about each function */
        for (func = upto = 0; func < hdr->func_count; func++) {
-               int calls = hdr->call_accum[func];
+               size_t calls = hdr->call_accum[func];
 
                if (!calls)
                        continue;
@@ -235,12 +234,24 @@ int trace_list_functions(void *buff, int buff_size, unsigned int *needed)
        return 0;
 }
 
-int trace_list_calls(void *buff, int buff_size, unsigned *needed)
+/**
+ * trace_list_functions() - produce a list of function calls
+ *
+ * The information is written into the supplied buffer - a header followed
+ * by a list of function records.
+ *
+ * @buff:      buffer to place list into
+ * @buff_size: size of buffer
+ * @needed:    returns size of buffer needed, which may be
+ *             greater than buff_size if we ran out of space.
+ * Return:     0 if ok, -ENOSPC if space was exhausted
+ */
+int trace_list_calls(void *buff, size_t buff_size, size_t *needed)
 {
        struct trace_output_hdr *output_hdr = NULL;
        void *end, *ptr = buff;
-       int rec, upto;
-       int count;
+       size_t rec, upto;
+       size_t count;
 
        end = buff ? buff + buff_size : NULL;
 
@@ -280,7 +291,9 @@ int trace_list_calls(void *buff, int buff_size, unsigned *needed)
        return 0;
 }
 
-/* Print basic information about tracing */
+/**
+ * trace_print_stats() - print basic information about tracing
+ */
 void trace_print_stats(void)
 {
        ulong count;
@@ -319,10 +332,11 @@ void __attribute__((no_instrument_function)) trace_set_enabled(int enabled)
 }
 
 /**
- * Init the tracing system ready for used, and enable it
+ * trace_init() - initialize the tracing system and enable it
  *
- * @param buff         Pointer to trace buffer
- * @param buff_size    Size of trace buffer
+ * @buff:      Pointer to trace buffer
+ * @buff_size: Size of trace buffer
+ * Return:     0 if ok
  */
 int __attribute__((no_instrument_function)) trace_init(void *buff,
                size_t buff_size)
@@ -376,7 +390,7 @@ int __attribute__((no_instrument_function)) trace_init(void *buff,
        add_textbase();
 
        puts("trace: enabled\n");
-       hdr->depth_limit = 15;
+       hdr->depth_limit = CONFIG_TRACE_CALL_DEPTH_LIMIT;
        trace_enabled = 1;
        trace_inited = 1;
 
@@ -384,6 +398,11 @@ int __attribute__((no_instrument_function)) trace_init(void *buff,
 }
 
 #ifdef CONFIG_TRACE_EARLY
+/**
+ * trace_early_init() - initialize the tracing system for early tracing
+ *
+ * Return:     0 if ok, -ENOSPC if not enough memory is available
+ */
 int __attribute__((no_instrument_function)) trace_early_init(void)
 {
        ulong func_count = gd->mon_len / FUNC_SITE_SIZE;
@@ -410,7 +429,7 @@ int __attribute__((no_instrument_function)) trace_early_init(void)
        hdr->ftrace = (struct trace_call *)((char *)hdr + needed);
        hdr->ftrace_size = (buff_size - needed) / sizeof(*hdr->ftrace);
        add_textbase();
-       hdr->depth_limit = 200;
+       hdr->depth_limit = CONFIG_TRACE_EARLY_CALL_DEPTH_LIMIT;
        printf("trace: early enable at %08x\n", CONFIG_TRACE_EARLY_ADDR);
 
        trace_enabled = 1;