net: correct the description of ip_to_string()

[J-u-boot.git] / include / display_options.h

diff --git a/include/display_options.h b/include/display_options.h
index ac44c459b3bf1e44c1b69e92d2fc16b4b87bf649..66e596077370a88ef341c179145b71598ad2fe37 100644 (file)
--- a/include/display_options.h
+++ b/include/display_options.h
@@ -1,15 +1,16 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * Copyright (c) 2015 Google, Inc
  *
  * (C) Copyright 2000-2002
  * Wolfgang Denk, DENX Software Engineering, [email protected].
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef __DISPLAY_OPTIONS_H
 #define __DISPLAY_OPTIONS_H
 
+#include <linux/types.h>
+
 /**
  * print_size() - Print a size with a suffix
  *
@@ -25,7 +26,7 @@ void print_size(uint64_t size, const char *suffix);
 /**
  * print_freq() - Print a frequency with a suffix
  *
- * Print frequencies as "x.xx GHz", "xxx KHz", etc as needed; allow for
+ * Print frequencies as "x.xx GHz", "xxx kHz", etc as needed; allow for
  * optional trailing string (like "\n")
  *
  * @freq:      Frequency to print in Hz
@@ -48,6 +49,31 @@ void print_freq(uint64_t freq, const char *suffix);
 int print_buffer(ulong addr, const void *data, uint width, uint count,
                 uint linelen);
 
+/*
+ * Maximum length of an output line is when width == 1
+ *     9 for address,
+ *     a space, two hex digits and an ASCII character for each byte
+ *     2 spaces between the hex and ASCII
+ *     \0 terminator
+ */
+#define HEXDUMP_MAX_BUF_LENGTH(bytes)  (9 + (bytes) * 4 + 3)
+
+/**
+ * hexdump_line() - Print out a single line of a hex dump
+ *
+ * @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
+ * @out:       Output buffer to hold the dump
+ * @size:      Size of output buffer in bytes
+ * Return: number of bytes processed, if OK, -ENOSPC if buffer too small
+ *
+ */
+int hexdump_line(ulong addr, const void *data, uint width, uint count,
+                uint linelen, char *out, int size);
+
 /**
  * display_options() - display the version string / build tag
  *
@@ -56,4 +82,23 @@ int print_buffer(ulong addr, const void *data, uint width, uint count,
  */
 int display_options(void);
 
+/* Suggested length of the buffer to pass to display_options_get_banner() */
+#define DISPLAY_OPTIONS_BANNER_LENGTH  200
+
+/**
+ * display_options_get_banner() - Get the U-Boot banner as a string
+ *
+ * This returns the U-Boot banner string
+ *
+ * @newlines: true to include two newlines at the start
+ * @buf: place to put string
+ * @size: Size of buf (string is truncated to fit)
+ * Return: buf
+ */
+char *display_options_get_banner(bool newlines, char *buf, int size);
+
+/* This function is used for testing only */
+char *display_options_get_banner_priv(bool newlines, const char *build_tag,
+                                     char *buf, int size);
+
 #endif