blob: 27ea9c907a32cbc936481d19b3dc8a66c994a92e [file] [log] [blame]
wdenk153d5112002-08-30 11:07:04 +00001/*
2 * linux/lib/vsprintf.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
Simon Glassf5c208d2019-11-14 12:57:20 -07005 * (C) Copyright 2000-2009
6 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenk153d5112002-08-30 11:07:04 +00007 */
8
9/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
10/*
11 * Wirzenius wrote this portably, Torvalds fucked it up :-)
Simon Glass931948a2011-10-21 18:51:33 +000012 *
13 * from hush: simple_itoa() was lifted from boa-0.93.15
wdenk153d5112002-08-30 11:07:04 +000014 */
15
Rob Clark8adf37f2017-09-09 06:47:41 -040016#include <charset.h>
Heinrich Schuchardt218d3892018-01-10 18:06:08 +010017#include <efi_loader.h>
18#include <div64.h>
Alexey Brodkin2d2fa492018-06-05 17:17:57 +030019#include <hexdump.h>
Heinrich Schuchardt218d3892018-01-10 18:06:08 +010020#include <stdarg.h>
Simon Glass6f044982020-05-10 11:39:52 -060021#include <uuid.h>
Simon Glassf5c208d2019-11-14 12:57:20 -070022#include <vsprintf.h>
Heinrich Schuchardt218d3892018-01-10 18:06:08 +010023#include <linux/ctype.h>
24#include <linux/err.h>
25#include <linux/types.h>
26#include <linux/string.h>
wdenk153d5112002-08-30 11:07:04 +000027
wdenk153d5112002-08-30 11:07:04 +000028/* we use this so that we can do without the ctype library */
29#define is_digit(c) ((c) >= '0' && (c) <= '9')
30
31static int skip_atoi(const char **s)
32{
Daniel Schwierzeckfc147852012-09-16 06:55:03 +000033 int i = 0;
wdenk153d5112002-08-30 11:07:04 +000034
35 while (is_digit(**s))
Daniel Schwierzeckfc147852012-09-16 06:55:03 +000036 i = i * 10 + *((*s)++) - '0';
37
wdenk153d5112002-08-30 11:07:04 +000038 return i;
39}
40
Mike Frysinger2b745dc2009-02-16 23:21:36 -050041/* Decimal conversion is by far the most typical, and is used
42 * for /proc and /sys data. This directly impacts e.g. top performance
43 * with many processes running. We optimize it for speed
44 * using code from
45 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
46 * (with permission from the author, Douglas W. Jones). */
47
48/* Formats correctly any integer in [0,99999].
49 * Outputs from one to five digits depending on input.
50 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
Daniel Schwierzeckfc147852012-09-16 06:55:03 +000051static char *put_dec_trunc(char *buf, unsigned q)
Mike Frysinger2b745dc2009-02-16 23:21:36 -050052{
53 unsigned d3, d2, d1, d0;
54 d1 = (q>>4) & 0xf;
55 d2 = (q>>8) & 0xf;
56 d3 = (q>>12);
57
58 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
59 q = (d0 * 0xcd) >> 11;
60 d0 = d0 - 10*q;
61 *buf++ = d0 + '0'; /* least significant digit */
62 d1 = q + 9*d3 + 5*d2 + d1;
63 if (d1 != 0) {
64 q = (d1 * 0xcd) >> 11;
65 d1 = d1 - 10*q;
66 *buf++ = d1 + '0'; /* next digit */
67
68 d2 = q + 2*d2;
69 if ((d2 != 0) || (d3 != 0)) {
70 q = (d2 * 0xd) >> 7;
71 d2 = d2 - 10*q;
72 *buf++ = d2 + '0'; /* next digit */
73
74 d3 = q + 4*d3;
75 if (d3 != 0) {
76 q = (d3 * 0xcd) >> 11;
77 d3 = d3 - 10*q;
78 *buf++ = d3 + '0'; /* next digit */
79 if (q != 0)
Daniel Schwierzeckfc147852012-09-16 06:55:03 +000080 *buf++ = q + '0'; /* most sign. digit */
Mike Frysinger2b745dc2009-02-16 23:21:36 -050081 }
82 }
83 }
84 return buf;
85}
86/* Same with if's removed. Always emits five digits */
Daniel Schwierzeckfc147852012-09-16 06:55:03 +000087static char *put_dec_full(char *buf, unsigned q)
Mike Frysinger2b745dc2009-02-16 23:21:36 -050088{
89 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
90 /* but anyway, gcc produces better code with full-sized ints */
91 unsigned d3, d2, d1, d0;
92 d1 = (q>>4) & 0xf;
93 d2 = (q>>8) & 0xf;
94 d3 = (q>>12);
95
Wolfgang Denke366f152009-04-05 00:27:57 +020096 /*
97 * Possible ways to approx. divide by 10
98 * gcc -O2 replaces multiply with shifts and adds
99 * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
100 * (x * 0x67) >> 10: 1100111
101 * (x * 0x34) >> 9: 110100 - same
102 * (x * 0x1a) >> 8: 11010 - same
103 * (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
104 */
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500105
106 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
107 q = (d0 * 0xcd) >> 11;
108 d0 = d0 - 10*q;
109 *buf++ = d0 + '0';
110 d1 = q + 9*d3 + 5*d2 + d1;
111 q = (d1 * 0xcd) >> 11;
112 d1 = d1 - 10*q;
113 *buf++ = d1 + '0';
114
115 d2 = q + 2*d2;
116 q = (d2 * 0xd) >> 7;
117 d2 = d2 - 10*q;
118 *buf++ = d2 + '0';
119
120 d3 = q + 4*d3;
121 q = (d3 * 0xcd) >> 11; /* - shorter code */
122 /* q = (d3 * 0x67) >> 10; - would also work */
123 d3 = d3 - 10*q;
124 *buf++ = d3 + '0';
125 *buf++ = q + '0';
126 return buf;
127}
128/* No inlining helps gcc to use registers better */
Simon Glassd1c377f2014-10-15 04:38:34 -0600129static noinline char *put_dec(char *buf, uint64_t num)
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500130{
131 while (1) {
132 unsigned rem;
133 if (num < 100000)
134 return put_dec_trunc(buf, num);
135 rem = do_div(num, 100000);
136 buf = put_dec_full(buf, rem);
137 }
138}
139
wdenk153d5112002-08-30 11:07:04 +0000140#define ZEROPAD 1 /* pad with zero */
141#define SIGN 2 /* unsigned/signed long */
142#define PLUS 4 /* show plus */
143#define SPACE 8 /* space if plus */
144#define LEFT 16 /* left justified */
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500145#define SMALL 32 /* Must be 32 == 0x20 */
146#define SPECIAL 64 /* 0x */
Simon Glassf3c30ac2023-01-17 10:47:30 -0700147#define ERRSTR 128 /* %dE showing error string if enabled */
wdenk153d5112002-08-30 11:07:04 +0000148
Sonny Raocd55bde2011-11-02 09:52:08 +0000149/*
150 * Macro to add a new character to our output string, but only if it will
151 * fit. The macro moves to the next character position in the output string.
152 */
153#define ADDCH(str, ch) do { \
154 if ((str) < end) \
155 *(str) = (ch); \
156 ++str; \
157 } while (0)
Sonny Raocd55bde2011-11-02 09:52:08 +0000158
Daniel Schwierzecka3e5c522012-09-16 06:55:04 +0000159static char *number(char *buf, char *end, u64 num,
Sonny Raocd55bde2011-11-02 09:52:08 +0000160 int base, int size, int precision, int type)
wdenk153d5112002-08-30 11:07:04 +0000161{
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500162 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000163 static const char digits[16] = "0123456789ABCDEF";
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500164
165 char tmp[66];
166 char sign;
167 char locase;
168 int need_pfx = ((type & SPECIAL) && base != 10);
wdenk153d5112002-08-30 11:07:04 +0000169 int i;
170
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500171 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
172 * produces same digits or (maybe lowercased) letters */
173 locase = (type & SMALL);
wdenk153d5112002-08-30 11:07:04 +0000174 if (type & LEFT)
175 type &= ~ZEROPAD;
wdenk153d5112002-08-30 11:07:04 +0000176 sign = 0;
177 if (type & SIGN) {
Daniel Schwierzecka3e5c522012-09-16 06:55:04 +0000178 if ((s64) num < 0) {
wdenk153d5112002-08-30 11:07:04 +0000179 sign = '-';
Daniel Schwierzecka3e5c522012-09-16 06:55:04 +0000180 num = -(s64) num;
wdenk153d5112002-08-30 11:07:04 +0000181 size--;
182 } else if (type & PLUS) {
183 sign = '+';
184 size--;
185 } else if (type & SPACE) {
186 sign = ' ';
187 size--;
188 }
189 }
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500190 if (need_pfx) {
191 size--;
wdenk153d5112002-08-30 11:07:04 +0000192 if (base == 16)
wdenk153d5112002-08-30 11:07:04 +0000193 size--;
194 }
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500195
196 /* generate full string in tmp[], in reverse order */
wdenk153d5112002-08-30 11:07:04 +0000197 i = 0;
198 if (num == 0)
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500199 tmp[i++] = '0';
200 /* Generic code, for any base:
201 else do {
202 tmp[i++] = (digits[do_div(num,base)] | locase);
203 } while (num != 0);
204 */
205 else if (base != 10) { /* 8 or 16 */
206 int mask = base - 1;
207 int shift = 3;
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000208
209 if (base == 16)
210 shift = 4;
211
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500212 do {
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000213 tmp[i++] = (digits[((unsigned char)num) & mask]
214 | locase);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500215 num >>= shift;
216 } while (num);
217 } else { /* base 10 */
218 i = put_dec(tmp, num) - tmp;
219 }
220
221 /* printing 100 using %2d gives "100", not "00" */
wdenk153d5112002-08-30 11:07:04 +0000222 if (i > precision)
223 precision = i;
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500224 /* leading space padding */
wdenk153d5112002-08-30 11:07:04 +0000225 size -= precision;
Sonny Raocd55bde2011-11-02 09:52:08 +0000226 if (!(type & (ZEROPAD + LEFT))) {
227 while (--size >= 0)
228 ADDCH(buf, ' ');
229 }
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500230 /* sign */
wdenk153d5112002-08-30 11:07:04 +0000231 if (sign)
Sonny Raocd55bde2011-11-02 09:52:08 +0000232 ADDCH(buf, sign);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500233 /* "0x" / "0" prefix */
234 if (need_pfx) {
Sonny Raocd55bde2011-11-02 09:52:08 +0000235 ADDCH(buf, '0');
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500236 if (base == 16)
Sonny Raocd55bde2011-11-02 09:52:08 +0000237 ADDCH(buf, 'X' | locase);
wdenk153d5112002-08-30 11:07:04 +0000238 }
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500239 /* zero or space padding */
240 if (!(type & LEFT)) {
241 char c = (type & ZEROPAD) ? '0' : ' ';
Sonny Raocd55bde2011-11-02 09:52:08 +0000242
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500243 while (--size >= 0)
Sonny Raocd55bde2011-11-02 09:52:08 +0000244 ADDCH(buf, c);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500245 }
246 /* hmm even more zero padding? */
247 while (i <= --precision)
Sonny Raocd55bde2011-11-02 09:52:08 +0000248 ADDCH(buf, '0');
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500249 /* actual digits of result */
250 while (--i >= 0)
Sonny Raocd55bde2011-11-02 09:52:08 +0000251 ADDCH(buf, tmp[i]);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500252 /* trailing space padding */
253 while (--size >= 0)
Sonny Raocd55bde2011-11-02 09:52:08 +0000254 ADDCH(buf, ' ');
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500255 return buf;
wdenk153d5112002-08-30 11:07:04 +0000256}
257
Heinrich Schuchardtc7ea52c2022-01-16 11:59:21 +0100258static char *string(char *buf, char *end, const char *s, int field_width,
Sonny Raocd55bde2011-11-02 09:52:08 +0000259 int precision, int flags)
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500260{
261 int len, i;
wdenk153d5112002-08-30 11:07:04 +0000262
Kim Phillips75541502012-10-29 13:34:36 +0000263 if (s == NULL)
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500264 s = "<NULL>";
265
266 len = strnlen(s, precision);
267
268 if (!(flags & LEFT))
269 while (len < field_width--)
Sonny Raocd55bde2011-11-02 09:52:08 +0000270 ADDCH(buf, ' ');
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500271 for (i = 0; i < len; ++i)
Sonny Raocd55bde2011-11-02 09:52:08 +0000272 ADDCH(buf, *s++);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500273 while (len < field_width--)
Sonny Raocd55bde2011-11-02 09:52:08 +0000274 ADDCH(buf, ' ');
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500275 return buf;
276}
277
Heinrich Schuchardt5ae135f2018-08-31 21:31:25 +0200278/* U-Boot uses UTF-16 strings in the EFI context only. */
Simon Glass7c159432021-12-29 11:57:35 -0700279static __maybe_unused char *string16(char *buf, char *end, u16 *s,
280 int field_width, int precision, int flags)
Rob Clark8adf37f2017-09-09 06:47:41 -0400281{
Simon Glass276af332022-01-23 12:55:14 -0700282 const u16 *str = s ? s : u"<NULL>";
Heinrich Schuchardt876a6362019-02-10 11:11:26 +0100283 ssize_t i, len = utf16_strnlen(str, precision);
Rob Clark8adf37f2017-09-09 06:47:41 -0400284
285 if (!(flags & LEFT))
Heinrich Schuchardt795ca042018-08-31 21:31:29 +0200286 for (; len < field_width; --field_width)
Rob Clark8adf37f2017-09-09 06:47:41 -0400287 ADDCH(buf, ' ');
Heinrich Schuchardt21885f42022-01-29 16:43:20 +0100288 if (buf < end)
289 *buf = 0;
290 for (i = 0; i < len; ++i) {
291 int slen = utf16_utf8_strnlen(str, 1);
Heinrich Schuchardt876a6362019-02-10 11:11:26 +0100292 s32 s = utf16_get(&str);
293
Heinrich Schuchardtc6dc1f12019-02-15 22:20:53 +0100294 if (s < 0)
295 s = '?';
Heinrich Schuchardt21885f42022-01-29 16:43:20 +0100296 if (buf + slen < end) {
297 utf8_put(s, &buf);
298 if (buf < end)
299 *buf = 0;
300 } else {
301 buf += slen;
302 }
Heinrich Schuchardt876a6362019-02-10 11:11:26 +0100303 }
Heinrich Schuchardt795ca042018-08-31 21:31:29 +0200304 for (; len < field_width; --field_width)
Rob Clark8adf37f2017-09-09 06:47:41 -0400305 ADDCH(buf, ' ');
Heinrich Schuchardt21885f42022-01-29 16:43:20 +0100306
Rob Clark8adf37f2017-09-09 06:47:41 -0400307 return buf;
308}
Heinrich Schuchardt218d3892018-01-10 18:06:08 +0100309
Heinrich Schuchardt3db35912019-05-11 09:53:33 +0200310#if CONFIG_IS_ENABLED(EFI_DEVICE_PATH_TO_TEXT)
Heinrich Schuchardt218d3892018-01-10 18:06:08 +0100311static char *device_path_string(char *buf, char *end, void *dp, int field_width,
312 int precision, int flags)
313{
314 u16 *str;
315
Heinrich Schuchardt3b47f332018-01-26 06:30:30 +0100316 /* If dp == NULL output the string '<NULL>' */
Heinrich Schuchardt218d3892018-01-10 18:06:08 +0100317 if (!dp)
Heinrich Schuchardt3b47f332018-01-26 06:30:30 +0100318 return string16(buf, end, dp, field_width, precision, flags);
Heinrich Schuchardt218d3892018-01-10 18:06:08 +0100319
320 str = efi_dp_str((struct efi_device_path *)dp);
321 if (!str)
322 return ERR_PTR(-ENOMEM);
323
324 buf = string16(buf, end, str, field_width, precision, flags);
325 efi_free_pool(str);
326 return buf;
327}
328#endif
Rob Clark8adf37f2017-09-09 06:47:41 -0400329
Sonny Raocd55bde2011-11-02 09:52:08 +0000330static char *mac_address_string(char *buf, char *end, u8 *addr, int field_width,
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500331 int precision, int flags)
wdenk153d5112002-08-30 11:07:04 +0000332{
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000333 /* (6 * 2 hex digits), 5 colons and trailing zero */
334 char mac_addr[6 * 3];
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500335 char *p = mac_addr;
336 int i;
337
338 for (i = 0; i < 6; i++) {
Alexey Brodkin2d2fa492018-06-05 17:17:57 +0300339 p = hex_byte_pack(p, addr[i]);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500340 if (!(flags & SPECIAL) && i != 5)
341 *p++ = ':';
342 }
343 *p = '\0';
344
Sonny Raocd55bde2011-11-02 09:52:08 +0000345 return string(buf, end, mac_addr, field_width, precision,
346 flags & ~SPECIAL);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500347}
348
Sonny Raocd55bde2011-11-02 09:52:08 +0000349static char *ip6_addr_string(char *buf, char *end, u8 *addr, int field_width,
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500350 int precision, int flags)
351{
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000352 /* (8 * 4 hex digits), 7 colons and trailing zero */
353 char ip6_addr[8 * 5];
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500354 char *p = ip6_addr;
355 int i;
356
357 for (i = 0; i < 8; i++) {
Alexey Brodkin2d2fa492018-06-05 17:17:57 +0300358 p = hex_byte_pack(p, addr[2 * i]);
359 p = hex_byte_pack(p, addr[2 * i + 1]);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500360 if (!(flags & SPECIAL) && i != 7)
361 *p++ = ':';
362 }
363 *p = '\0';
364
Sonny Raocd55bde2011-11-02 09:52:08 +0000365 return string(buf, end, ip6_addr, field_width, precision,
366 flags & ~SPECIAL);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500367}
368
Sonny Raocd55bde2011-11-02 09:52:08 +0000369static char *ip4_addr_string(char *buf, char *end, u8 *addr, int field_width,
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500370 int precision, int flags)
371{
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000372 /* (4 * 3 decimal digits), 3 dots and trailing zero */
373 char ip4_addr[4 * 4];
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500374 char temp[3]; /* hold each IP quad in reverse order */
375 char *p = ip4_addr;
376 int i, digits;
377
378 for (i = 0; i < 4; i++) {
379 digits = put_dec_trunc(temp, addr[i]) - temp;
380 /* reverse the digits in the quad */
381 while (digits--)
382 *p++ = temp[digits];
383 if (i != 3)
384 *p++ = '.';
385 }
386 *p = '\0';
387
Sonny Raocd55bde2011-11-02 09:52:08 +0000388 return string(buf, end, ip4_addr, field_width, precision,
389 flags & ~SPECIAL);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500390}
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500391
Rob Clarkc82342f2017-09-09 06:47:42 -0400392#ifdef CONFIG_LIB_UUID
393/*
Heinrich Schuchardt6f035662019-04-29 08:08:43 +0200394 * This works (roughly) the same way as Linux's.
Rob Clarkc82342f2017-09-09 06:47:42 -0400395 *
396 * %pUb: 01020304-0506-0708-090a-0b0c0d0e0f10
Heinrich Schuchardt6f035662019-04-29 08:08:43 +0200397 * %pUB: 01020304-0506-0708-090A-0B0C0D0E0F10
Rob Clarkc82342f2017-09-09 06:47:42 -0400398 * %pUl: 04030201-0605-0807-090a-0b0c0d0e0f10
Heinrich Schuchardt6f035662019-04-29 08:08:43 +0200399 * %pUL: 04030201-0605-0807-090A-0B0C0D0E0F10
Heinrich Schuchardtc7ea52c2022-01-16 11:59:21 +0100400 * %pUs: GUID text representation if known or fallback to %pUl
Rob Clarkc82342f2017-09-09 06:47:42 -0400401 */
402static char *uuid_string(char *buf, char *end, u8 *addr, int field_width,
403 int precision, int flags, const char *fmt)
404{
405 char uuid[UUID_STR_LEN + 1];
Heinrich Schuchardt6f035662019-04-29 08:08:43 +0200406 int str_format;
Heinrich Schuchardtc7ea52c2022-01-16 11:59:21 +0100407 const char *str;
Rob Clarkc82342f2017-09-09 06:47:42 -0400408
409 switch (*(++fmt)) {
410 case 'L':
Heinrich Schuchardt6f035662019-04-29 08:08:43 +0200411 str_format = UUID_STR_FORMAT_GUID | UUID_STR_UPPER_CASE;
412 break;
Rob Clarkc82342f2017-09-09 06:47:42 -0400413 case 'l':
414 str_format = UUID_STR_FORMAT_GUID;
415 break;
416 case 'B':
Heinrich Schuchardt6f035662019-04-29 08:08:43 +0200417 str_format = UUID_STR_FORMAT_STD | UUID_STR_UPPER_CASE;
Rob Clarkc82342f2017-09-09 06:47:42 -0400418 break;
Heinrich Schuchardtc7ea52c2022-01-16 11:59:21 +0100419 case 's':
420 str = uuid_guid_get_str(addr);
421 if (str)
422 return string(buf, end, str,
423 field_width, precision, flags);
424 str_format = UUID_STR_FORMAT_GUID;
425 break;
Rob Clarkc82342f2017-09-09 06:47:42 -0400426 default:
Heinrich Schuchardt6f035662019-04-29 08:08:43 +0200427 str_format = UUID_STR_FORMAT_STD;
Rob Clarkc82342f2017-09-09 06:47:42 -0400428 break;
429 }
430
Simon Glass62f32552018-06-18 08:08:20 -0600431 if (addr)
432 uuid_bin_to_str(addr, uuid, str_format);
433 else
434 strcpy(uuid, "<NULL>");
Rob Clarkc82342f2017-09-09 06:47:42 -0400435
436 return string(buf, end, uuid, field_width, precision, flags);
437}
438#endif
439
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500440/*
441 * Show a '%p' thing. A kernel extension is that the '%p' is followed
442 * by an extra set of alphanumeric characters that are extended format
443 * specifiers.
444 *
445 * Right now we handle:
446 *
447 * - 'M' For a 6-byte MAC address, it prints the address in the
448 * usual colon-separated hex notation
449 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
450 * decimal for v4 and colon separated network-order 16 bit hex for v6)
451 * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
452 * currently the same
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500453 */
Sonny Raocd55bde2011-11-02 09:52:08 +0000454static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
455 int field_width, int precision, int flags)
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500456{
Thierry Reding3e336c82014-11-12 18:26:47 -0700457 u64 num = (uintptr_t)ptr;
458
Wolfgang Denk88a8b012012-10-30 09:19:52 +0000459 /*
460 * Being a boot loader, we explicitly allow pointers to
461 * (physical) address null.
462 */
463#if 0
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500464 if (!ptr)
Sonny Raocd55bde2011-11-02 09:52:08 +0000465 return string(buf, end, "(null)", field_width, precision,
466 flags);
Wolfgang Denk88a8b012012-10-30 09:19:52 +0000467#endif
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500468
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500469 switch (*fmt) {
Heinrich Schuchardtd2cc0a72018-08-31 21:31:23 +0200470/* Device paths only exist in the EFI context. */
Heinrich Schuchardt3db35912019-05-11 09:53:33 +0200471#if CONFIG_IS_ENABLED(EFI_DEVICE_PATH_TO_TEXT) && !defined(API_BUILD)
Heinrich Schuchardt218d3892018-01-10 18:06:08 +0100472 case 'D':
473 return device_path_string(buf, end, ptr, field_width,
474 precision, flags);
475#endif
Thierry Reding3e336c82014-11-12 18:26:47 -0700476 case 'a':
477 flags |= SPECIAL | ZEROPAD;
478
479 switch (fmt[1]) {
480 case 'p':
481 default:
482 field_width = sizeof(phys_addr_t) * 2 + 2;
483 num = *(phys_addr_t *)ptr;
484 break;
485 }
486 break;
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500487 case 'm':
488 flags |= SPECIAL;
489 /* Fallthrough */
490 case 'M':
Sonny Raocd55bde2011-11-02 09:52:08 +0000491 return mac_address_string(buf, end, ptr, field_width,
492 precision, flags);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500493 case 'i':
494 flags |= SPECIAL;
495 /* Fallthrough */
496 case 'I':
Viacheslav Mitrofanovce3cf462022-12-02 12:18:03 +0300497 if (IS_ENABLED(CONFIG_IPV6) && fmt[1] == '6')
Sonny Raocd55bde2011-11-02 09:52:08 +0000498 return ip6_addr_string(buf, end, ptr, field_width,
499 precision, flags);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500500 if (fmt[1] == '4')
Sonny Raocd55bde2011-11-02 09:52:08 +0000501 return ip4_addr_string(buf, end, ptr, field_width,
502 precision, flags);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500503 flags &= ~SPECIAL;
504 break;
Rob Clarkc82342f2017-09-09 06:47:42 -0400505#ifdef CONFIG_LIB_UUID
506 case 'U':
507 return uuid_string(buf, end, ptr, field_width, precision,
508 flags, fmt);
509#endif
510 default:
511 break;
512 }
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500513 flags |= SMALL;
514 if (field_width == -1) {
515 field_width = 2*sizeof(void *);
516 flags |= ZEROPAD;
517 }
Thierry Reding3e336c82014-11-12 18:26:47 -0700518 return number(buf, end, num, 16, field_width, precision, flags);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500519}
520
Sonny Raocd55bde2011-11-02 09:52:08 +0000521static int vsnprintf_internal(char *buf, size_t size, const char *fmt,
522 va_list args)
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500523{
Daniel Schwierzecka3e5c522012-09-16 06:55:04 +0000524 u64 num;
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500525 int base;
526 char *str;
wdenk153d5112002-08-30 11:07:04 +0000527
528 int flags; /* flags to number() */
529
530 int field_width; /* width of output field */
531 int precision; /* min. # of digits for integers; max
532 number of chars for from string */
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500533 int qualifier; /* 'h', 'l', or 'L' for integer fields */
534 /* 'z' support added 23/7/1999 S.H. */
535 /* 'z' changed to 'Z' --davidm 1/25/99 */
536 /* 't' added for ptrdiff_t */
Sonny Raocd55bde2011-11-02 09:52:08 +0000537 char *end = buf + size;
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500538
Sonny Raocd55bde2011-11-02 09:52:08 +0000539 /* Make sure end is always >= buf - do we want this in U-Boot? */
540 if (end < buf) {
541 end = ((void *)-1);
542 size = end - buf;
543 }
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500544 str = buf;
wdenk153d5112002-08-30 11:07:04 +0000545
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500546 for (; *fmt ; ++fmt) {
wdenk153d5112002-08-30 11:07:04 +0000547 if (*fmt != '%') {
Sonny Raocd55bde2011-11-02 09:52:08 +0000548 ADDCH(str, *fmt);
wdenk153d5112002-08-30 11:07:04 +0000549 continue;
550 }
551
552 /* process flags */
553 flags = 0;
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000554repeat:
wdenk153d5112002-08-30 11:07:04 +0000555 ++fmt; /* this also skips first '%' */
556 switch (*fmt) {
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000557 case '-':
558 flags |= LEFT;
559 goto repeat;
560 case '+':
561 flags |= PLUS;
562 goto repeat;
563 case ' ':
564 flags |= SPACE;
565 goto repeat;
566 case '#':
567 flags |= SPECIAL;
568 goto repeat;
569 case '0':
570 flags |= ZEROPAD;
571 goto repeat;
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500572 }
wdenk153d5112002-08-30 11:07:04 +0000573
574 /* get field width */
575 field_width = -1;
576 if (is_digit(*fmt))
577 field_width = skip_atoi(&fmt);
578 else if (*fmt == '*') {
579 ++fmt;
580 /* it's the next argument */
581 field_width = va_arg(args, int);
582 if (field_width < 0) {
583 field_width = -field_width;
584 flags |= LEFT;
585 }
586 }
587
588 /* get the precision */
589 precision = -1;
590 if (*fmt == '.') {
591 ++fmt;
592 if (is_digit(*fmt))
593 precision = skip_atoi(&fmt);
594 else if (*fmt == '*') {
595 ++fmt;
596 /* it's the next argument */
597 precision = va_arg(args, int);
598 }
599 if (precision < 0)
600 precision = 0;
601 }
602
603 /* get the conversion qualifier */
604 qualifier = -1;
Jean-Christophe PLAGNIOL-VILLARD0f720692008-07-14 14:11:45 +0200605 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500606 *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
wdenk153d5112002-08-30 11:07:04 +0000607 qualifier = *fmt;
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500608 ++fmt;
609 if (qualifier == 'l' && *fmt == 'l') {
610 qualifier = 'L';
James Yang7fc40152008-01-10 16:02:07 -0600611 ++fmt;
612 }
wdenk153d5112002-08-30 11:07:04 +0000613 }
614
615 /* default base */
616 base = 10;
617
618 switch (*fmt) {
619 case 'c':
Sonny Raocd55bde2011-11-02 09:52:08 +0000620 if (!(flags & LEFT)) {
wdenk153d5112002-08-30 11:07:04 +0000621 while (--field_width > 0)
Sonny Raocd55bde2011-11-02 09:52:08 +0000622 ADDCH(str, ' ');
623 }
624 ADDCH(str, (unsigned char) va_arg(args, int));
wdenk153d5112002-08-30 11:07:04 +0000625 while (--field_width > 0)
Sonny Raocd55bde2011-11-02 09:52:08 +0000626 ADDCH(str, ' ');
wdenk153d5112002-08-30 11:07:04 +0000627 continue;
628
629 case 's':
Heinrich Schuchardt5ae135f2018-08-31 21:31:25 +0200630/* U-Boot uses UTF-16 strings in the EFI context only. */
Simon Glassfe90a5a2023-02-05 15:39:40 -0700631#if (CONFIG_IS_ENABLED(EFI_LOADER) || IS_ENABLED(CONFIG_EFI_APP)) && \
Simon Glass7c159432021-12-29 11:57:35 -0700632 !defined(API_BUILD)
Heinrich Schuchardt5ae135f2018-08-31 21:31:25 +0200633 if (qualifier == 'l') {
Rob Clark8adf37f2017-09-09 06:47:41 -0400634 str = string16(str, end, va_arg(args, u16 *),
635 field_width, precision, flags);
Heinrich Schuchardt5ae135f2018-08-31 21:31:25 +0200636 } else
637#endif
638 {
Rob Clark8adf37f2017-09-09 06:47:41 -0400639 str = string(str, end, va_arg(args, char *),
640 field_width, precision, flags);
641 }
wdenk153d5112002-08-30 11:07:04 +0000642 continue;
643
644 case 'p':
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000645 str = pointer(fmt + 1, str, end,
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500646 va_arg(args, void *),
647 field_width, precision, flags);
Heinrich Schuchardt218d3892018-01-10 18:06:08 +0100648 if (IS_ERR(str))
649 return PTR_ERR(str);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500650 /* Skip all alphanumeric pointer suffixes */
651 while (isalnum(fmt[1]))
652 fmt++;
wdenk153d5112002-08-30 11:07:04 +0000653 continue;
654
wdenk153d5112002-08-30 11:07:04 +0000655 case 'n':
656 if (qualifier == 'l') {
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000657 long *ip = va_arg(args, long *);
wdenk153d5112002-08-30 11:07:04 +0000658 *ip = (str - buf);
659 } else {
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000660 int *ip = va_arg(args, int *);
wdenk153d5112002-08-30 11:07:04 +0000661 *ip = (str - buf);
662 }
663 continue;
664
665 case '%':
Sonny Raocd55bde2011-11-02 09:52:08 +0000666 ADDCH(str, '%');
wdenk153d5112002-08-30 11:07:04 +0000667 continue;
668
669 /* integer number formats - set up the flags and "break" */
670 case 'o':
671 base = 8;
672 break;
673
wdenk153d5112002-08-30 11:07:04 +0000674 case 'x':
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500675 flags |= SMALL;
Heinrich Schuchardt15a21552023-04-01 08:13:42 +0200676 /* fallthrough */
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500677 case 'X':
wdenk153d5112002-08-30 11:07:04 +0000678 base = 16;
679 break;
680
681 case 'd':
Simon Glassc8d8cdd2023-07-30 11:15:13 -0600682 if (fmt[1] == 'E') {
Simon Glassf3c30ac2023-01-17 10:47:30 -0700683 flags |= ERRSTR;
Simon Glassc8d8cdd2023-07-30 11:15:13 -0600684 fmt++;
685 }
Heinrich Schuchardt15a21552023-04-01 08:13:42 +0200686 /* fallthrough */
wdenk153d5112002-08-30 11:07:04 +0000687 case 'i':
688 flags |= SIGN;
Heinrich Schuchardt15a21552023-04-01 08:13:42 +0200689 /* fallthrough */
wdenk153d5112002-08-30 11:07:04 +0000690 case 'u':
691 break;
692
693 default:
Sonny Raocd55bde2011-11-02 09:52:08 +0000694 ADDCH(str, '%');
wdenk153d5112002-08-30 11:07:04 +0000695 if (*fmt)
Sonny Raocd55bde2011-11-02 09:52:08 +0000696 ADDCH(str, *fmt);
wdenk153d5112002-08-30 11:07:04 +0000697 else
698 --fmt;
699 continue;
700 }
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500701 if (qualifier == 'L') /* "quad" for 64 bit variables */
wdenkf602aa02004-03-13 23:29:43 +0000702 num = va_arg(args, unsigned long long);
Heiko Schocher0f602e12009-12-03 11:21:21 +0100703 else if (qualifier == 'l') {
wdenk153d5112002-08-30 11:07:04 +0000704 num = va_arg(args, unsigned long);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500705 if (flags & SIGN)
706 num = (signed long) num;
Jean-Christophe PLAGNIOL-VILLARD0f720692008-07-14 14:11:45 +0200707 } else if (qualifier == 'Z' || qualifier == 'z') {
708 num = va_arg(args, size_t);
709 } else if (qualifier == 't') {
710 num = va_arg(args, ptrdiff_t);
711 } else if (qualifier == 'h') {
wdenk153d5112002-08-30 11:07:04 +0000712 num = (unsigned short) va_arg(args, int);
713 if (flags & SIGN)
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500714 num = (signed short) num;
715 } else {
wdenk153d5112002-08-30 11:07:04 +0000716 num = va_arg(args, unsigned int);
Mike Frysinger2b745dc2009-02-16 23:21:36 -0500717 if (flags & SIGN)
718 num = (signed int) num;
719 }
Sonny Raocd55bde2011-11-02 09:52:08 +0000720 str = number(str, end, num, base, field_width, precision,
721 flags);
Simon Glassf3c30ac2023-01-17 10:47:30 -0700722 if (IS_ENABLED(CONFIG_ERRNO_STR) && (flags & ERRSTR)) {
723 const char *p;
724
725 ADDCH(str, ':');
726 ADDCH(str, ' ');
727 for (p = errno_str(num); *p; p++)
728 ADDCH(str, *p);
Simon Glassf3c30ac2023-01-17 10:47:30 -0700729 }
Sonny Raocd55bde2011-11-02 09:52:08 +0000730 }
731
Sonny Raocd55bde2011-11-02 09:52:08 +0000732 if (size > 0) {
733 ADDCH(str, '\0');
734 if (str > end)
735 end[-1] = '\0';
Darwin Rambo6958ede2013-12-19 15:14:19 -0800736 --str;
wdenk153d5112002-08-30 11:07:04 +0000737 }
Sonny Raocd55bde2011-11-02 09:52:08 +0000738 /* the trailing null byte doesn't count towards the total */
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000739 return str - buf;
wdenk153d5112002-08-30 11:07:04 +0000740}
741
Sonny Raocd55bde2011-11-02 09:52:08 +0000742int vsnprintf(char *buf, size_t size, const char *fmt,
743 va_list args)
744{
745 return vsnprintf_internal(buf, size, fmt, args);
746}
747
Sonny Raocd55bde2011-11-02 09:52:08 +0000748int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
749{
750 int i;
751
752 i = vsnprintf(buf, size, fmt, args);
753
754 if (likely(i < size))
755 return i;
756 if (size != 0)
757 return size - 1;
758 return 0;
759}
760
Sonny Raocd55bde2011-11-02 09:52:08 +0000761int snprintf(char *buf, size_t size, const char *fmt, ...)
762{
763 va_list args;
764 int i;
765
766 va_start(args, fmt);
767 i = vsnprintf(buf, size, fmt, args);
768 va_end(args);
769
770 return i;
771}
772
Sonny Raocd55bde2011-11-02 09:52:08 +0000773int scnprintf(char *buf, size_t size, const char *fmt, ...)
774{
775 va_list args;
776 int i;
777
778 va_start(args, fmt);
779 i = vscnprintf(buf, size, fmt, args);
780 va_end(args);
781
782 return i;
783}
Sonny Raocd55bde2011-11-02 09:52:08 +0000784
785/**
786 * Format a string and place it in a buffer (va_list version)
787 *
788 * @param buf The buffer to place the result into
789 * @param fmt The format string to use
790 * @param args Arguments for the format string
791 *
792 * The function returns the number of characters written
793 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
794 * buffer overflows.
795 *
796 * If you're not already dealing with a va_list consider using sprintf().
797 */
798int vsprintf(char *buf, const char *fmt, va_list args)
799{
800 return vsnprintf_internal(buf, INT_MAX, fmt, args);
801}
802
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000803int sprintf(char *buf, const char *fmt, ...)
wdenk153d5112002-08-30 11:07:04 +0000804{
805 va_list args;
806 int i;
807
808 va_start(args, fmt);
Daniel Schwierzeckfc147852012-09-16 06:55:03 +0000809 i = vsprintf(buf, fmt, args);
wdenk153d5112002-08-30 11:07:04 +0000810 va_end(args);
811 return i;
812}
813
Alex Kiernand07d0a02018-04-19 04:32:55 +0000814#if CONFIG_IS_ENABLED(PRINTF)
Stefan Roese363ab7b2015-11-23 07:00:22 +0100815int printf(const char *fmt, ...)
816{
817 va_list args;
818 uint i;
Stefan Roese363ab7b2015-11-23 07:00:22 +0100819
820 va_start(args, fmt);
Rasmus Villemoes008b0e12021-05-28 00:20:44 +0200821 i = vprintf(fmt, args);
Stefan Roese363ab7b2015-11-23 07:00:22 +0100822 va_end(args);
823
Stefan Roese363ab7b2015-11-23 07:00:22 +0100824 return i;
825}
826
827int vprintf(const char *fmt, va_list args)
828{
829 uint i;
830 char printbuffer[CONFIG_SYS_PBSIZE];
831
832 /*
833 * For this to work, printbuffer must be larger than
834 * anything we ever want to print.
835 */
836 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
837
Heinrich Schuchardt218d3892018-01-10 18:06:08 +0100838 /* Handle error */
839 if (i <= 0)
840 return i;
Stefan Roese363ab7b2015-11-23 07:00:22 +0100841 /* Print the string */
842 puts(printbuffer);
843 return i;
844}
Alex Kiernand07d0a02018-04-19 04:32:55 +0000845#endif
Simon Glass509dbf92015-02-27 22:06:32 -0700846
Simon Glass1f467182021-10-14 12:48:07 -0600847static char local_toa[22];
848
Simon Glass931948a2011-10-21 18:51:33 +0000849char *simple_itoa(ulong i)
850{
851 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
Simon Glass1f467182021-10-14 12:48:07 -0600852 char *p = &local_toa[21];
Simon Glass931948a2011-10-21 18:51:33 +0000853
854 *p-- = '\0';
855 do {
856 *p-- = '0' + i % 10;
857 i /= 10;
858 } while (i > 0);
859 return p + 1;
860}
Simon Glassb09cfd82013-06-11 11:14:38 -0700861
Simon Glass1f467182021-10-14 12:48:07 -0600862char *simple_xtoa(ulong num)
863{
864 /* 16 digits plus nul terminator, good for 64-bit or smaller ints */
865 char *p = &local_toa[17];
866
867 *--p = '\0';
868 do {
869 p -= 2;
870 hex_byte_pack(p, num & 0xff);
871 num >>= 8;
872 } while (num > 0);
873
874 return p;
875}
876
Simon Glassb09cfd82013-06-11 11:14:38 -0700877/* We don't seem to have %'d in U-Boot */
878void print_grouped_ull(unsigned long long int_val, int digits)
879{
880 char str[21], *s;
881 int grab = 3;
882
883 digits = (digits + 2) / 3;
884 sprintf(str, "%*llu", digits * 3, int_val);
885 for (s = str; *s; s += grab) {
886 if (s != str)
887 putc(s[-1] != ' ' ? ',' : ' ');
888 printf("%.*s", grab, s);
889 grab = 3;
890 }
891}
Heiko Schocher7e5a16c2015-04-27 07:42:05 +0200892
893bool str2off(const char *p, loff_t *num)
894{
895 char *endptr;
896
897 *num = simple_strtoull(p, &endptr, 16);
898 return *p != '\0' && *endptr == '\0';
899}
900
901bool str2long(const char *p, ulong *num)
902{
903 char *endptr;
904
Simon Glass3ff49ec2021-07-24 09:03:29 -0600905 *num = hextoul(p, &endptr);
Heiko Schocher7e5a16c2015-04-27 07:42:05 +0200906 return *p != '\0' && *endptr == '\0';
907}
Simon Glassf5c208d2019-11-14 12:57:20 -0700908
909char *strmhz(char *buf, unsigned long hz)
910{
911 long l, n;
912 long m;
913
914 n = DIV_ROUND_CLOSEST(hz, 1000) / 1000L;
915 l = sprintf(buf, "%ld", n);
916
917 hz -= n * 1000000L;
918 m = DIV_ROUND_CLOSEST(hz, 1000L);
919 if (m != 0)
920 sprintf(buf + l, ".%03ld", m);
921
922 return buf;
923}