summaryrefslogtreecommitdiff
path: root/include/display_options.h
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2015-04-28 20:25:07 -0600
committerSimon Glass <sjg@chromium.org>2015-04-29 21:02:33 -0600
commit2ea09c836f65f52a35f5242d04f0a9e3e36b773d (patch)
tree58f5e14187339573d5d8962d55d99c705c027cdd /include/display_options.h
parent9a7d700ccacc71e9b05f01b6d0f3b95178fb7061 (diff)
downloadu-boot-2ea09c836f65f52a35f5242d04f0a9e3e36b773d.tar.gz
Move display_options functions to their own header
Before adding one more function, create a separate header to help reduce the size of common.h. Add the missing function comments and tidy up. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
Diffstat (limited to 'include/display_options.h')
-rw-r--r--include/display_options.h48
1 files changed, 48 insertions, 0 deletions
diff --git a/include/display_options.h b/include/display_options.h
new file mode 100644
index 0000000000..54bd41d10d
--- /dev/null
+++ b/include/display_options.h
@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2015 Google, Inc
+ *
+ * (C) Copyright 2000-2002
+ * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ */
+
+#ifndef __DISPLAY_OPTIONS_H
+#define __DISPLAY_OPTIONS_H
+
+/**
+ * print_size() - Print a size with a suffix
+ *
+ * Print sizes as "xxx KiB", "xxx.y KiB", "xxx MiB", "xxx.y MiB",
+ * xxx GiB, xxx.y GiB, etc as needed; allow for optional trailing string
+ * (like "\n")
+ *
+ * @size: Size to print
+ * @suffix String to print after the size
+ */
+void print_size(uint64_t size, const char *suffix);
+
+/**
+ * print_buffer() - Print data buffer in hex and ascii form
+ *
+ * Data reads are buffered so that each memory address is only read once.
+ * This is useful when displaying the contents of volatile registers.
+ *
+ * @addr: Starting address to display at start of line
+ * @data: pointer to data buffer
+ * @width: data value width. May be 1, 2, or 4.
+ * @count: number of values to display
+ * @linelen: Number of values to print per line; specify 0 for default length
+ */
+int print_buffer(ulong addr, const void *data, uint width, uint count,
+ uint linelen);
+
+/**
+ * display_options() - display the version string / build tag
+ *
+ * This displays the U-Boot version string. If a build tag is available this
+ * is displayed also.
+ */
+int display_options(void);
+
+#endif