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