xref: /openbmc/u-boot/include/display_options.h (revision e8f80a5a)
1*83d290c5STom Rini /* SPDX-License-Identifier: GPL-2.0+ */
22ea09c83SSimon Glass /*
32ea09c83SSimon Glass  * Copyright (c) 2015 Google, Inc
42ea09c83SSimon Glass  *
52ea09c83SSimon Glass  * (C) Copyright 2000-2002
62ea09c83SSimon Glass  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
72ea09c83SSimon Glass  */
82ea09c83SSimon Glass 
92ea09c83SSimon Glass #ifndef __DISPLAY_OPTIONS_H
102ea09c83SSimon Glass #define __DISPLAY_OPTIONS_H
112ea09c83SSimon Glass 
122ea09c83SSimon Glass /**
132ea09c83SSimon Glass  * print_size() - Print a size with a suffix
142ea09c83SSimon Glass  *
152ea09c83SSimon Glass  * Print sizes as "xxx KiB", "xxx.y KiB", "xxx MiB", "xxx.y MiB",
162ea09c83SSimon Glass  * xxx GiB, xxx.y GiB, etc as needed; allow for optional trailing string
172ea09c83SSimon Glass  * (like "\n")
182ea09c83SSimon Glass  *
192ea09c83SSimon Glass  * @size:	Size to print
202ea09c83SSimon Glass  * @suffix	String to print after the size
212ea09c83SSimon Glass  */
222ea09c83SSimon Glass void print_size(uint64_t size, const char *suffix);
232ea09c83SSimon Glass 
242ea09c83SSimon Glass /**
2533eac2dcSSimon Glass  * print_freq() - Print a frequency with a suffix
2633eac2dcSSimon Glass  *
2733eac2dcSSimon Glass  * Print frequencies as "x.xx GHz", "xxx KHz", etc as needed; allow for
2833eac2dcSSimon Glass  * optional trailing string (like "\n")
2933eac2dcSSimon Glass  *
3033eac2dcSSimon Glass  * @freq:	Frequency to print in Hz
3133eac2dcSSimon Glass  * @suffix	String to print after the frequency
3233eac2dcSSimon Glass  */
3333eac2dcSSimon Glass void print_freq(uint64_t freq, const char *suffix);
3433eac2dcSSimon Glass 
3533eac2dcSSimon Glass /**
362ea09c83SSimon Glass  * print_buffer() - Print data buffer in hex and ascii form
372ea09c83SSimon Glass  *
382ea09c83SSimon Glass  * Data reads are buffered so that each memory address is only read once.
392ea09c83SSimon Glass  * This is useful when displaying the contents of volatile registers.
402ea09c83SSimon Glass  *
412ea09c83SSimon Glass  * @addr:	Starting address to display at start of line
422ea09c83SSimon Glass  * @data:	pointer to data buffer
432ea09c83SSimon Glass  * @width:	data value width.  May be 1, 2, or 4.
442ea09c83SSimon Glass  * @count:	number of values to display
452ea09c83SSimon Glass  * @linelen:	Number of values to print per line; specify 0 for default length
462ea09c83SSimon Glass  */
472ea09c83SSimon Glass int print_buffer(ulong addr, const void *data, uint width, uint count,
482ea09c83SSimon Glass 		 uint linelen);
492ea09c83SSimon Glass 
502ea09c83SSimon Glass /**
512ea09c83SSimon Glass  * display_options() - display the version string / build tag
522ea09c83SSimon Glass  *
532ea09c83SSimon Glass  * This displays the U-Boot version string. If a build tag is available this
542ea09c83SSimon Glass  * is displayed also.
552ea09c83SSimon Glass  */
562ea09c83SSimon Glass int display_options(void);
572ea09c83SSimon Glass 
586c519f2dSSimon Glass /* Suggested length of the buffer to pass to display_options_get_banner() */
596c519f2dSSimon Glass #define DISPLAY_OPTIONS_BANNER_LENGTH	200
606c519f2dSSimon Glass 
616c519f2dSSimon Glass /**
626c519f2dSSimon Glass  * display_options_get_banner() - Get the U-Boot banner as a string
636c519f2dSSimon Glass  *
646c519f2dSSimon Glass  * This returns the U-Boot banner string
656c519f2dSSimon Glass  *
666c519f2dSSimon Glass  * @newlines: true to include two newlines at the start
676c519f2dSSimon Glass  * @buf: place to put string
686c519f2dSSimon Glass  * @size: Size of buf (string is truncated to fit)
696c519f2dSSimon Glass  * @return buf
706c519f2dSSimon Glass  */
716c519f2dSSimon Glass char *display_options_get_banner(bool newlines, char *buf, int size);
726c519f2dSSimon Glass 
736c519f2dSSimon Glass /* This function is used for testing only */
746c519f2dSSimon Glass char *display_options_get_banner_priv(bool newlines, const char *build_tag,
756c519f2dSSimon Glass 				      char *buf, int size);
766c519f2dSSimon Glass 
772ea09c83SSimon Glass #endif
78