Merge tag 'efi-2022-01-rc2-2' of https://source.denx.de/u-boot/custodians/u-boot-efi
[platform/kernel/u-boot.git] / include / vsprintf.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2000-2009
4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5  */
6
7 #ifndef __VSPRINTF_H
8 #define __VSPRINTF_H
9
10 #include <stdarg.h>
11 #include <linux/types.h>
12
13 /**
14  * simple_strtoul - convert a string to an unsigned long
15  *
16  * @param cp    The string to be converted
17  * @param endp  Updated to point to the first character not converted
18  * @param base  The number base to use (0 for the default)
19  * @return value decoded from string (0 if invalid)
20  *
21  * Converts a string to an unsigned long. If there are invalid characters at
22  * the end these are ignored. In the worst case, if all characters are invalid,
23  * 0 is returned
24  *
25  * A hex prefix is supported (e.g. 0x123) regardless of the value of @base.
26  * If found, the base is set to hex (16).
27  *
28  * If @base is 0:
29  *    - an octal '0' prefix (e.g. 0777) sets the base to octal (8).
30  *    - otherwise the base defaults to decimal (10).
31  */
32 ulong simple_strtoul(const char *cp, char **endp, unsigned int base);
33
34 /**
35  * hex_strtoul - convert a string in hex to an unsigned long
36  *
37  * @param cp    The string to be converted
38  * @param endp  Updated to point to the first character not converted
39  * @return value decoded from string (0 if invalid)
40  *
41  * Converts a hex string to an unsigned long. If there are invalid characters at
42  * the end these are ignored. In the worst case, if all characters are invalid,
43  * 0 is returned
44  */
45 unsigned long hextoul(const char *cp, char **endp);
46
47 /**
48  * dec_strtoul - convert a string in decimal to an unsigned long
49  *
50  * @param cp    The string to be converted
51  * @param endp  Updated to point to the first character not converted
52  * @return value decoded from string (0 if invalid)
53  *
54  * Converts a decimal string to an unsigned long. If there are invalid
55  * characters at the end these are ignored. In the worst case, if all characters
56  * are invalid, 0 is returned
57  */
58 unsigned long dectoul(const char *cp, char **endp);
59
60 /**
61  * strict_strtoul - convert a string to an unsigned long strictly
62  * @param cp    The string to be converted
63  * @param base  The number base to use (0 for the default)
64  * @param res   The converted result value
65  * @return 0 if conversion is successful and *res is set to the converted
66  * value, otherwise it returns -EINVAL and *res is set to 0.
67  *
68  * strict_strtoul converts a string to an unsigned long only if the
69  * string is really an unsigned long string, any string containing
70  * any invalid char at the tail will be rejected and -EINVAL is returned,
71  * only a newline char at the tail is acceptible because people generally
72  * change a module parameter in the following way:
73  *
74  *      echo 1024 > /sys/module/e1000/parameters/copybreak
75  *
76  * echo will append a newline to the tail.
77  *
78  * A hex prefix is supported (e.g. 0x123) regardless of the value of @base.
79  * If found, the base is set to hex (16).
80  *
81  * If @base is 0:
82  *    - an octal '0' prefix (e.g. 0777) sets the base to octal (8).
83  *    - otherwise the base defaults to decimal (10).
84  *
85  * Copied this function from Linux 2.6.38 commit ID:
86  * 521cb40b0c44418a4fd36dc633f575813d59a43d
87  *
88  */
89 int strict_strtoul(const char *cp, unsigned int base, unsigned long *res);
90 unsigned long long simple_strtoull(const char *cp, char **endp,
91                                         unsigned int base);
92 long simple_strtol(const char *cp, char **endp, unsigned int base);
93 long long simple_strtoll(const char *cp, char **endp, unsigned int base);
94
95 /**
96  * trailing_strtol() - extract a trailing integer from a string
97  *
98  * Given a string this finds a trailing number on the string and returns it.
99  * For example, "abc123" would return 123.
100  *
101  * @str:        String to exxamine
102  * @return training number if found, else -1
103  */
104 long trailing_strtol(const char *str);
105
106 /**
107  * trailing_strtoln() - extract a trailing integer from a fixed-length string
108  *
109  * Given a fixed-length string this finds a trailing number on the string
110  * and returns it. For example, "abc123" would return 123. Only the
111  * characters between @str and @end - 1 are examined. If @end is NULL, it is
112  * set to str + strlen(str).
113  *
114  * @str:        String to exxamine
115  * @end:        Pointer to end of string to examine, or NULL to use the
116  *              whole string
117  * @return training number if found, else -1
118  */
119 long trailing_strtoln(const char *str, const char *end);
120
121 /**
122  * panic() - Print a message and reset/hang
123  *
124  * Prints a message on the console(s) and then resets. If CONFIG_PANIC_HANG is
125  * defined, then it will hang instead of resetting.
126  *
127  * @param fmt:  printf() format string for message, which should not include
128  *              \n, followed by arguments
129  */
130 void panic(const char *fmt, ...)
131                 __attribute__ ((format (__printf__, 1, 2), noreturn));
132
133 /**
134  * panic_str() - Print a message and reset/hang
135  *
136  * Prints a message on the console(s) and then resets. If CONFIG_PANIC_HANG is
137  * defined, then it will hang instead of resetting.
138  *
139  * This function can be used instead of panic() when your board does not
140  * already use printf(), * to keep code size small.
141  *
142  * @param fmt:  string to display, which should not include \n
143  */
144 void panic_str(const char *str) __attribute__ ((noreturn));
145
146 /**
147  * Format a string and place it in a buffer
148  *
149  * @param buf   The buffer to place the result into
150  * @param fmt   The format string to use
151  * @param ...   Arguments for the format string
152  *
153  * The function returns the number of characters written
154  * into @buf.
155  *
156  * See the vsprintf() documentation for format string extensions over C99.
157  */
158 int sprintf(char *buf, const char *fmt, ...)
159                 __attribute__ ((format (__printf__, 2, 3)));
160
161 /**
162  * Format a string and place it in a buffer (va_list version)
163  *
164  * @param buf   The buffer to place the result into
165  * @param fmt   The format string to use
166  * @param args  Arguments for the format string
167  * @return the number of characters which have been written into
168  * the @buf not including the trailing '\0'.
169  *
170  * If you're not already dealing with a va_list consider using scnprintf().
171  *
172  * See the vsprintf() documentation for format string extensions over C99.
173  */
174 int vsprintf(char *buf, const char *fmt, va_list args);
175
176 /**
177  * simple_itoa() - convert an unsigned integer to a string
178  *
179  * This returns a static string containing the decimal representation of the
180  * given value. The returned value may be overwritten by other calls to other
181  * simple_... functions, so should be used immediately
182  *
183  * @val: Value to convert
184  * @return string containing the decimal representation of @val
185  */
186 char *simple_itoa(ulong val);
187
188 /**
189  * simple_xtoa() - convert an unsigned integer to a hex string
190  *
191  * This returns a static string containing the hexadecimal representation of the
192  * given value. The returned value may be overwritten by other calls to other
193  * simple_... functions, so should be used immediately
194  *
195  * @val: Value to convert
196  * @return string containing the hexecimal representation of @val
197  */
198 char *simple_xtoa(ulong num);
199
200 /**
201  * Format a string and place it in a buffer
202  *
203  * @param buf   The buffer to place the result into
204  * @param size  The size of the buffer, including the trailing null space
205  * @param fmt   The format string to use
206  * @param ...   Arguments for the format string
207  * @return the number of characters which would be
208  * generated for the given input, excluding the trailing null,
209  * as per ISO C99.  If the return is greater than or equal to
210  * @size, the resulting string is truncated.
211  *
212  * See the vsprintf() documentation for format string extensions over C99.
213  */
214 int snprintf(char *buf, size_t size, const char *fmt, ...)
215                 __attribute__ ((format (__printf__, 3, 4)));
216
217 /**
218  * Format a string and place it in a buffer
219  *
220  * @param buf   The buffer to place the result into
221  * @param size  The size of the buffer, including the trailing null space
222  * @param fmt   The format string to use
223  * @param ...   Arguments for the format string
224  *
225  * The return value is the number of characters written into @buf not including
226  * the trailing '\0'. If @size is == 0 the function returns 0.
227  *
228  * See the vsprintf() documentation for format string extensions over C99.
229  */
230 int scnprintf(char *buf, size_t size, const char *fmt, ...)
231                 __attribute__ ((format (__printf__, 3, 4)));
232
233 /**
234  * Format a string and place it in a buffer (base function)
235  *
236  * @param buf   The buffer to place the result into
237  * @param size  The size of the buffer, including the trailing null space
238  * @param fmt   The format string to use
239  * @param args  Arguments for the format string
240  * @return The number characters which would be generated for the given
241  * input, excluding the trailing '\0', as per ISO C99. Note that fewer
242  * characters may be written if this number of characters is >= size.
243  *
244  * This function follows C99 vsnprintf, but has some extensions:
245  * %pS output the name of a text symbol
246  * %pF output the name of a function pointer
247  * %pR output the address range in a struct resource
248  *
249  * The function returns the number of characters which would be
250  * generated for the given input, excluding the trailing '\0',
251  * as per ISO C99.
252  *
253  * Call this function if you are already dealing with a va_list.
254  * You probably want snprintf() instead.
255  */
256 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
257
258 /**
259  * Format a string and place it in a buffer (va_list version)
260  *
261  * @param buf   The buffer to place the result into
262  * @param size  The size of the buffer, including the trailing null space
263  * @param fmt   The format string to use
264  * @param args  Arguments for the format string
265  * @return the number of characters which have been written into
266  * the @buf not including the trailing '\0'. If @size is == 0 the function
267  * returns 0.
268  *
269  * If you're not already dealing with a va_list consider using scnprintf().
270  *
271  * See the vsprintf() documentation for format string extensions over C99.
272  */
273 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
274
275 /**
276  * print_grouped_ull() - print a value with digits grouped by ','
277  *
278  * This prints a value with grouped digits, like 12,345,678 to make it easier
279  * to read.
280  *
281  * @val:        Value to print
282  * @digits:     Number of digiits to print
283  */
284 void print_grouped_ull(unsigned long long int_val, int digits);
285
286 bool str2off(const char *p, loff_t *num);
287 bool str2long(const char *p, ulong *num);
288
289 /**
290  * strmhz() - Convert a value to a Hz string
291  *
292  * This creates a string indicating the number of MHz of a value. For example,
293  * 2700000 produces "2.7".
294  * @buf: Buffer to hold output string, which must be large enough
295  * @hz: Value to convert
296  */
297 char *strmhz(char *buf, unsigned long hz);
298
299 /**
300  * str_to_upper() - Convert a string to upper case
301  *
302  * This simply uses toupper() on each character of the string.
303  *
304  * @in: String to convert (must be large enough to hold the output string)
305  * @out: Buffer to put converted string
306  * @len: Number of bytes available in @out (SIZE_MAX for all)
307  */
308 void str_to_upper(const char *in, char *out, size_t len);
309
310 /**
311  * sscanf - Unformat a buffer into a list of arguments
312  * @buf:        input buffer
313  * @fmt:        formatting of buffer
314  * @...:        resulting arguments
315  */
316 int sscanf(const char *buf, const char *fmt, ...);
317
318 #endif