blob: 2c84649fa8aee2ef5ebbd528c398d72aefb482df [file] [log] [blame]
wdenk153d5112002-08-30 11:07:04 +00001/*
2 * linux/lib/vsprintf.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
Simon Glass2189d5f2019-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 Glass3cce8a52011-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
wdenk153d5112002-08-30 11:07:04 +000016#include <common.h>
Rob Clark274325c2017-09-09 06:47:41 -040017#include <charset.h>
Heinrich Schuchardt256060e2018-01-10 18:06:08 +010018#include <efi_loader.h>
Dirk Behme47910502009-07-22 17:51:56 +020019#include <div64.h>
Alexey Brodkinf8c987f2018-06-05 17:17:57 +030020#include <hexdump.h>
Heinrich Schuchardt256060e2018-01-10 18:06:08 +010021#include <stdarg.h>
Simon Glassba06b3c2020-05-10 11:39:52 -060022#include <uuid.h>
Simon Glass2189d5f2019-11-14 12:57:20 -070023#include <vsprintf.h>
Heinrich Schuchardt256060e2018-01-10 18:06:08 +010024#include <linux/ctype.h>
25#include <linux/err.h>
26#include <linux/types.h>
27#include <linux/string.h>
28
wdenk153d5112002-08-30 11:07:04 +000029/* we use this so that we can do without the ctype library */
30#define is_digit(c) ((c) >= '0' && (c) <= '9')
31
32static int skip_atoi(const char **s)
33{
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +000034 int i = 0;
wdenk153d5112002-08-30 11:07:04 +000035
36 while (is_digit(**s))
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +000037 i = i * 10 + *((*s)++) - '0';
38
wdenk153d5112002-08-30 11:07:04 +000039 return i;
40}
41
Mike Frysinger6c6166f2009-02-16 23:21:36 -050042/* Decimal conversion is by far the most typical, and is used
43 * for /proc and /sys data. This directly impacts e.g. top performance
44 * with many processes running. We optimize it for speed
45 * using code from
46 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
47 * (with permission from the author, Douglas W. Jones). */
48
49/* Formats correctly any integer in [0,99999].
50 * Outputs from one to five digits depending on input.
51 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +000052static char *put_dec_trunc(char *buf, unsigned q)
Mike Frysinger6c6166f2009-02-16 23:21:36 -050053{
54 unsigned d3, d2, d1, d0;
55 d1 = (q>>4) & 0xf;
56 d2 = (q>>8) & 0xf;
57 d3 = (q>>12);
58
59 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
60 q = (d0 * 0xcd) >> 11;
61 d0 = d0 - 10*q;
62 *buf++ = d0 + '0'; /* least significant digit */
63 d1 = q + 9*d3 + 5*d2 + d1;
64 if (d1 != 0) {
65 q = (d1 * 0xcd) >> 11;
66 d1 = d1 - 10*q;
67 *buf++ = d1 + '0'; /* next digit */
68
69 d2 = q + 2*d2;
70 if ((d2 != 0) || (d3 != 0)) {
71 q = (d2 * 0xd) >> 7;
72 d2 = d2 - 10*q;
73 *buf++ = d2 + '0'; /* next digit */
74
75 d3 = q + 4*d3;
76 if (d3 != 0) {
77 q = (d3 * 0xcd) >> 11;
78 d3 = d3 - 10*q;
79 *buf++ = d3 + '0'; /* next digit */
80 if (q != 0)
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +000081 *buf++ = q + '0'; /* most sign. digit */
Mike Frysinger6c6166f2009-02-16 23:21:36 -050082 }
83 }
84 }
85 return buf;
86}
87/* Same with if's removed. Always emits five digits */
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +000088static char *put_dec_full(char *buf, unsigned q)
Mike Frysinger6c6166f2009-02-16 23:21:36 -050089{
90 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
91 /* but anyway, gcc produces better code with full-sized ints */
92 unsigned d3, d2, d1, d0;
93 d1 = (q>>4) & 0xf;
94 d2 = (q>>8) & 0xf;
95 d3 = (q>>12);
96
Wolfgang Denkc0a14ae2009-04-05 00:27:57 +020097 /*
98 * Possible ways to approx. divide by 10
99 * gcc -O2 replaces multiply with shifts and adds
100 * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
101 * (x * 0x67) >> 10: 1100111
102 * (x * 0x34) >> 9: 110100 - same
103 * (x * 0x1a) >> 8: 11010 - same
104 * (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
105 */
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500106
107 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
108 q = (d0 * 0xcd) >> 11;
109 d0 = d0 - 10*q;
110 *buf++ = d0 + '0';
111 d1 = q + 9*d3 + 5*d2 + d1;
112 q = (d1 * 0xcd) >> 11;
113 d1 = d1 - 10*q;
114 *buf++ = d1 + '0';
115
116 d2 = q + 2*d2;
117 q = (d2 * 0xd) >> 7;
118 d2 = d2 - 10*q;
119 *buf++ = d2 + '0';
120
121 d3 = q + 4*d3;
122 q = (d3 * 0xcd) >> 11; /* - shorter code */
123 /* q = (d3 * 0x67) >> 10; - would also work */
124 d3 = d3 - 10*q;
125 *buf++ = d3 + '0';
126 *buf++ = q + '0';
127 return buf;
128}
129/* No inlining helps gcc to use registers better */
Simon Glass6bf67252014-10-15 04:38:34 -0600130static noinline char *put_dec(char *buf, uint64_t num)
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500131{
132 while (1) {
133 unsigned rem;
134 if (num < 100000)
135 return put_dec_trunc(buf, num);
136 rem = do_div(num, 100000);
137 buf = put_dec_full(buf, rem);
138 }
139}
140
wdenk153d5112002-08-30 11:07:04 +0000141#define ZEROPAD 1 /* pad with zero */
142#define SIGN 2 /* unsigned/signed long */
143#define PLUS 4 /* show plus */
144#define SPACE 8 /* space if plus */
145#define LEFT 16 /* left justified */
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500146#define SMALL 32 /* Must be 32 == 0x20 */
147#define SPECIAL 64 /* 0x */
wdenk153d5112002-08-30 11:07:04 +0000148
Sonny Rao046a37b2011-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 Rao046a37b2011-11-02 09:52:08 +0000158
Daniel Schwierzeck7b64f662012-09-16 06:55:04 +0000159static char *number(char *buf, char *end, u64 num,
Sonny Rao046a37b2011-11-02 09:52:08 +0000160 int base, int size, int precision, int type)
wdenk153d5112002-08-30 11:07:04 +0000161{
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500162 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000163 static const char digits[16] = "0123456789ABCDEF";
Mike Frysinger6c6166f2009-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 Frysinger6c6166f2009-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 Schwierzeck7b64f662012-09-16 06:55:04 +0000178 if ((s64) num < 0) {
wdenk153d5112002-08-30 11:07:04 +0000179 sign = '-';
Daniel Schwierzeck7b64f662012-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 Frysinger6c6166f2009-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 Frysinger6c6166f2009-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 Frysinger6c6166f2009-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 Schwierzeck8acdae62012-09-16 06:55:03 +0000208
209 if (base == 16)
210 shift = 4;
211
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500212 do {
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000213 tmp[i++] = (digits[((unsigned char)num) & mask]
214 | locase);
Mike Frysinger6c6166f2009-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 Frysinger6c6166f2009-02-16 23:21:36 -0500224 /* leading space padding */
wdenk153d5112002-08-30 11:07:04 +0000225 size -= precision;
Sonny Rao046a37b2011-11-02 09:52:08 +0000226 if (!(type & (ZEROPAD + LEFT))) {
227 while (--size >= 0)
228 ADDCH(buf, ' ');
229 }
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500230 /* sign */
wdenk153d5112002-08-30 11:07:04 +0000231 if (sign)
Sonny Rao046a37b2011-11-02 09:52:08 +0000232 ADDCH(buf, sign);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500233 /* "0x" / "0" prefix */
234 if (need_pfx) {
Sonny Rao046a37b2011-11-02 09:52:08 +0000235 ADDCH(buf, '0');
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500236 if (base == 16)
Sonny Rao046a37b2011-11-02 09:52:08 +0000237 ADDCH(buf, 'X' | locase);
wdenk153d5112002-08-30 11:07:04 +0000238 }
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500239 /* zero or space padding */
240 if (!(type & LEFT)) {
241 char c = (type & ZEROPAD) ? '0' : ' ';
Sonny Rao046a37b2011-11-02 09:52:08 +0000242
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500243 while (--size >= 0)
Sonny Rao046a37b2011-11-02 09:52:08 +0000244 ADDCH(buf, c);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500245 }
246 /* hmm even more zero padding? */
247 while (i <= --precision)
Sonny Rao046a37b2011-11-02 09:52:08 +0000248 ADDCH(buf, '0');
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500249 /* actual digits of result */
250 while (--i >= 0)
Sonny Rao046a37b2011-11-02 09:52:08 +0000251 ADDCH(buf, tmp[i]);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500252 /* trailing space padding */
253 while (--size >= 0)
Sonny Rao046a37b2011-11-02 09:52:08 +0000254 ADDCH(buf, ' ');
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500255 return buf;
wdenk153d5112002-08-30 11:07:04 +0000256}
257
Heinrich Schuchardt04872382022-01-16 11:59:21 +0100258static char *string(char *buf, char *end, const char *s, int field_width,
Sonny Rao046a37b2011-11-02 09:52:08 +0000259 int precision, int flags)
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500260{
261 int len, i;
wdenk153d5112002-08-30 11:07:04 +0000262
Kim Phillips0eb25762012-10-29 13:34:36 +0000263 if (s == NULL)
Mike Frysinger6c6166f2009-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 Rao046a37b2011-11-02 09:52:08 +0000270 ADDCH(buf, ' ');
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500271 for (i = 0; i < len; ++i)
Sonny Rao046a37b2011-11-02 09:52:08 +0000272 ADDCH(buf, *s++);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500273 while (len < field_width--)
Sonny Rao046a37b2011-11-02 09:52:08 +0000274 ADDCH(buf, ' ');
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500275 return buf;
276}
277
Heinrich Schuchardtfbb3ea82018-08-31 21:31:25 +0200278/* U-Boot uses UTF-16 strings in the EFI context only. */
Simon Glass726cd982021-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 Clark274325c2017-09-09 06:47:41 -0400281{
Heinrich Schuchardt0e66c102019-02-10 11:11:26 +0100282 const u16 *str = s ? s : L"<NULL>";
283 ssize_t i, len = utf16_strnlen(str, precision);
Rob Clark274325c2017-09-09 06:47:41 -0400284
285 if (!(flags & LEFT))
Heinrich Schuchardt31bd7112018-08-31 21:31:29 +0200286 for (; len < field_width; --field_width)
Rob Clark274325c2017-09-09 06:47:41 -0400287 ADDCH(buf, ' ');
Heinrich Schuchardt0e66c102019-02-10 11:11:26 +0100288 for (i = 0; i < len && buf + utf16_utf8_strnlen(str, 1) <= end; ++i) {
289 s32 s = utf16_get(&str);
290
Heinrich Schuchardt60c44542019-02-15 22:20:53 +0100291 if (s < 0)
292 s = '?';
Heinrich Schuchardt0e66c102019-02-10 11:11:26 +0100293 utf8_put(s, &buf);
294 }
Heinrich Schuchardt31bd7112018-08-31 21:31:29 +0200295 for (; len < field_width; --field_width)
Rob Clark274325c2017-09-09 06:47:41 -0400296 ADDCH(buf, ' ');
297 return buf;
298}
299
Heinrich Schuchardt64b5ba42019-05-11 09:53:33 +0200300#if CONFIG_IS_ENABLED(EFI_DEVICE_PATH_TO_TEXT)
Heinrich Schuchardt256060e2018-01-10 18:06:08 +0100301static char *device_path_string(char *buf, char *end, void *dp, int field_width,
302 int precision, int flags)
303{
304 u16 *str;
305
Heinrich Schuchardt5f1ce1d2018-01-26 06:30:30 +0100306 /* If dp == NULL output the string '<NULL>' */
Heinrich Schuchardt256060e2018-01-10 18:06:08 +0100307 if (!dp)
Heinrich Schuchardt5f1ce1d2018-01-26 06:30:30 +0100308 return string16(buf, end, dp, field_width, precision, flags);
Heinrich Schuchardt256060e2018-01-10 18:06:08 +0100309
310 str = efi_dp_str((struct efi_device_path *)dp);
311 if (!str)
312 return ERR_PTR(-ENOMEM);
313
314 buf = string16(buf, end, str, field_width, precision, flags);
315 efi_free_pool(str);
316 return buf;
317}
318#endif
319
Sonny Rao046a37b2011-11-02 09:52:08 +0000320static char *mac_address_string(char *buf, char *end, u8 *addr, int field_width,
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500321 int precision, int flags)
322{
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000323 /* (6 * 2 hex digits), 5 colons and trailing zero */
324 char mac_addr[6 * 3];
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500325 char *p = mac_addr;
326 int i;
327
328 for (i = 0; i < 6; i++) {
Alexey Brodkinf8c987f2018-06-05 17:17:57 +0300329 p = hex_byte_pack(p, addr[i]);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500330 if (!(flags & SPECIAL) && i != 5)
331 *p++ = ':';
332 }
333 *p = '\0';
334
Sonny Rao046a37b2011-11-02 09:52:08 +0000335 return string(buf, end, mac_addr, field_width, precision,
336 flags & ~SPECIAL);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500337}
338
Sonny Rao046a37b2011-11-02 09:52:08 +0000339static char *ip6_addr_string(char *buf, char *end, u8 *addr, int field_width,
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500340 int precision, int flags)
341{
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000342 /* (8 * 4 hex digits), 7 colons and trailing zero */
343 char ip6_addr[8 * 5];
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500344 char *p = ip6_addr;
345 int i;
346
347 for (i = 0; i < 8; i++) {
Alexey Brodkinf8c987f2018-06-05 17:17:57 +0300348 p = hex_byte_pack(p, addr[2 * i]);
349 p = hex_byte_pack(p, addr[2 * i + 1]);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500350 if (!(flags & SPECIAL) && i != 7)
351 *p++ = ':';
352 }
353 *p = '\0';
354
Sonny Rao046a37b2011-11-02 09:52:08 +0000355 return string(buf, end, ip6_addr, field_width, precision,
356 flags & ~SPECIAL);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500357}
358
Sonny Rao046a37b2011-11-02 09:52:08 +0000359static char *ip4_addr_string(char *buf, char *end, u8 *addr, int field_width,
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500360 int precision, int flags)
361{
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000362 /* (4 * 3 decimal digits), 3 dots and trailing zero */
363 char ip4_addr[4 * 4];
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500364 char temp[3]; /* hold each IP quad in reverse order */
365 char *p = ip4_addr;
366 int i, digits;
367
368 for (i = 0; i < 4; i++) {
369 digits = put_dec_trunc(temp, addr[i]) - temp;
370 /* reverse the digits in the quad */
371 while (digits--)
372 *p++ = temp[digits];
373 if (i != 3)
374 *p++ = '.';
375 }
376 *p = '\0';
377
Sonny Rao046a37b2011-11-02 09:52:08 +0000378 return string(buf, end, ip4_addr, field_width, precision,
379 flags & ~SPECIAL);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500380}
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500381
Rob Clark22ada0c2017-09-09 06:47:42 -0400382#ifdef CONFIG_LIB_UUID
383/*
Heinrich Schuchardt3bad2562019-04-29 08:08:43 +0200384 * This works (roughly) the same way as Linux's.
Rob Clark22ada0c2017-09-09 06:47:42 -0400385 *
386 * %pUb: 01020304-0506-0708-090a-0b0c0d0e0f10
Heinrich Schuchardt3bad2562019-04-29 08:08:43 +0200387 * %pUB: 01020304-0506-0708-090A-0B0C0D0E0F10
Rob Clark22ada0c2017-09-09 06:47:42 -0400388 * %pUl: 04030201-0605-0807-090a-0b0c0d0e0f10
Heinrich Schuchardt3bad2562019-04-29 08:08:43 +0200389 * %pUL: 04030201-0605-0807-090A-0B0C0D0E0F10
Heinrich Schuchardt04872382022-01-16 11:59:21 +0100390 * %pUs: GUID text representation if known or fallback to %pUl
Rob Clark22ada0c2017-09-09 06:47:42 -0400391 */
392static char *uuid_string(char *buf, char *end, u8 *addr, int field_width,
393 int precision, int flags, const char *fmt)
394{
395 char uuid[UUID_STR_LEN + 1];
Heinrich Schuchardt3bad2562019-04-29 08:08:43 +0200396 int str_format;
Heinrich Schuchardt04872382022-01-16 11:59:21 +0100397 const char *str;
Rob Clark22ada0c2017-09-09 06:47:42 -0400398
399 switch (*(++fmt)) {
400 case 'L':
Heinrich Schuchardt3bad2562019-04-29 08:08:43 +0200401 str_format = UUID_STR_FORMAT_GUID | UUID_STR_UPPER_CASE;
402 break;
Rob Clark22ada0c2017-09-09 06:47:42 -0400403 case 'l':
404 str_format = UUID_STR_FORMAT_GUID;
405 break;
406 case 'B':
Heinrich Schuchardt3bad2562019-04-29 08:08:43 +0200407 str_format = UUID_STR_FORMAT_STD | UUID_STR_UPPER_CASE;
Rob Clark22ada0c2017-09-09 06:47:42 -0400408 break;
Heinrich Schuchardt04872382022-01-16 11:59:21 +0100409 case 's':
410 str = uuid_guid_get_str(addr);
411 if (str)
412 return string(buf, end, str,
413 field_width, precision, flags);
414 str_format = UUID_STR_FORMAT_GUID;
415 break;
Rob Clark22ada0c2017-09-09 06:47:42 -0400416 default:
Heinrich Schuchardt3bad2562019-04-29 08:08:43 +0200417 str_format = UUID_STR_FORMAT_STD;
Rob Clark22ada0c2017-09-09 06:47:42 -0400418 break;
419 }
420
Simon Glassd7ae1602018-06-18 08:08:20 -0600421 if (addr)
422 uuid_bin_to_str(addr, uuid, str_format);
423 else
424 strcpy(uuid, "<NULL>");
Rob Clark22ada0c2017-09-09 06:47:42 -0400425
426 return string(buf, end, uuid, field_width, precision, flags);
427}
428#endif
429
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500430/*
431 * Show a '%p' thing. A kernel extension is that the '%p' is followed
432 * by an extra set of alphanumeric characters that are extended format
433 * specifiers.
434 *
435 * Right now we handle:
436 *
437 * - 'M' For a 6-byte MAC address, it prints the address in the
438 * usual colon-separated hex notation
439 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
440 * decimal for v4 and colon separated network-order 16 bit hex for v6)
441 * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
442 * currently the same
443 *
Rasmus Villemoes23b542a2021-05-28 00:20:46 +0200444 * Note: IPv6 support is currently if(0)'ed out. If you ever need
445 * %pI6, please add an IPV6 Kconfig knob, make your code select or
446 * depend on that, and change the 0 below to CONFIG_IS_ENABLED(IPV6).
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500447 */
Sonny Rao046a37b2011-11-02 09:52:08 +0000448static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
449 int field_width, int precision, int flags)
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500450{
Thierry Reding1eebd142014-11-12 18:26:47 -0700451 u64 num = (uintptr_t)ptr;
452
Wolfgang Denkd266f662012-10-30 09:19:52 +0000453 /*
454 * Being a boot loader, we explicitly allow pointers to
455 * (physical) address null.
456 */
457#if 0
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500458 if (!ptr)
Sonny Rao046a37b2011-11-02 09:52:08 +0000459 return string(buf, end, "(null)", field_width, precision,
460 flags);
Wolfgang Denkd266f662012-10-30 09:19:52 +0000461#endif
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500462
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500463 switch (*fmt) {
Heinrich Schuchardt4ddcc4e2018-08-31 21:31:23 +0200464/* Device paths only exist in the EFI context. */
Heinrich Schuchardt64b5ba42019-05-11 09:53:33 +0200465#if CONFIG_IS_ENABLED(EFI_DEVICE_PATH_TO_TEXT) && !defined(API_BUILD)
Heinrich Schuchardt256060e2018-01-10 18:06:08 +0100466 case 'D':
467 return device_path_string(buf, end, ptr, field_width,
468 precision, flags);
469#endif
Thierry Reding1eebd142014-11-12 18:26:47 -0700470 case 'a':
471 flags |= SPECIAL | ZEROPAD;
472
473 switch (fmt[1]) {
474 case 'p':
475 default:
476 field_width = sizeof(phys_addr_t) * 2 + 2;
477 num = *(phys_addr_t *)ptr;
478 break;
479 }
480 break;
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500481 case 'm':
482 flags |= SPECIAL;
483 /* Fallthrough */
484 case 'M':
Sonny Rao046a37b2011-11-02 09:52:08 +0000485 return mac_address_string(buf, end, ptr, field_width,
486 precision, flags);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500487 case 'i':
488 flags |= SPECIAL;
489 /* Fallthrough */
490 case 'I':
Rasmus Villemoes23b542a2021-05-28 00:20:46 +0200491 /* %pI6 currently unused */
492 if (0 && fmt[1] == '6')
Sonny Rao046a37b2011-11-02 09:52:08 +0000493 return ip6_addr_string(buf, end, ptr, field_width,
494 precision, flags);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500495 if (fmt[1] == '4')
Sonny Rao046a37b2011-11-02 09:52:08 +0000496 return ip4_addr_string(buf, end, ptr, field_width,
497 precision, flags);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500498 flags &= ~SPECIAL;
499 break;
Rob Clark22ada0c2017-09-09 06:47:42 -0400500#ifdef CONFIG_LIB_UUID
501 case 'U':
502 return uuid_string(buf, end, ptr, field_width, precision,
503 flags, fmt);
504#endif
505 default:
506 break;
507 }
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500508 flags |= SMALL;
509 if (field_width == -1) {
510 field_width = 2*sizeof(void *);
511 flags |= ZEROPAD;
512 }
Thierry Reding1eebd142014-11-12 18:26:47 -0700513 return number(buf, end, num, 16, field_width, precision, flags);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500514}
515
Sonny Rao046a37b2011-11-02 09:52:08 +0000516static int vsnprintf_internal(char *buf, size_t size, const char *fmt,
517 va_list args)
wdenk153d5112002-08-30 11:07:04 +0000518{
Daniel Schwierzeck7b64f662012-09-16 06:55:04 +0000519 u64 num;
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500520 int base;
521 char *str;
wdenk153d5112002-08-30 11:07:04 +0000522
523 int flags; /* flags to number() */
524
525 int field_width; /* width of output field */
526 int precision; /* min. # of digits for integers; max
527 number of chars for from string */
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500528 int qualifier; /* 'h', 'l', or 'L' for integer fields */
529 /* 'z' support added 23/7/1999 S.H. */
530 /* 'z' changed to 'Z' --davidm 1/25/99 */
531 /* 't' added for ptrdiff_t */
Sonny Rao046a37b2011-11-02 09:52:08 +0000532 char *end = buf + size;
wdenk153d5112002-08-30 11:07:04 +0000533
Sonny Rao046a37b2011-11-02 09:52:08 +0000534 /* Make sure end is always >= buf - do we want this in U-Boot? */
535 if (end < buf) {
536 end = ((void *)-1);
537 size = end - buf;
538 }
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500539 str = buf;
540
541 for (; *fmt ; ++fmt) {
wdenk153d5112002-08-30 11:07:04 +0000542 if (*fmt != '%') {
Sonny Rao046a37b2011-11-02 09:52:08 +0000543 ADDCH(str, *fmt);
wdenk153d5112002-08-30 11:07:04 +0000544 continue;
545 }
546
547 /* process flags */
548 flags = 0;
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000549repeat:
wdenk153d5112002-08-30 11:07:04 +0000550 ++fmt; /* this also skips first '%' */
551 switch (*fmt) {
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000552 case '-':
553 flags |= LEFT;
554 goto repeat;
555 case '+':
556 flags |= PLUS;
557 goto repeat;
558 case ' ':
559 flags |= SPACE;
560 goto repeat;
561 case '#':
562 flags |= SPECIAL;
563 goto repeat;
564 case '0':
565 flags |= ZEROPAD;
566 goto repeat;
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500567 }
wdenk153d5112002-08-30 11:07:04 +0000568
569 /* get field width */
570 field_width = -1;
571 if (is_digit(*fmt))
572 field_width = skip_atoi(&fmt);
573 else if (*fmt == '*') {
574 ++fmt;
575 /* it's the next argument */
576 field_width = va_arg(args, int);
577 if (field_width < 0) {
578 field_width = -field_width;
579 flags |= LEFT;
580 }
581 }
582
583 /* get the precision */
584 precision = -1;
585 if (*fmt == '.') {
586 ++fmt;
587 if (is_digit(*fmt))
588 precision = skip_atoi(&fmt);
589 else if (*fmt == '*') {
590 ++fmt;
591 /* it's the next argument */
592 precision = va_arg(args, int);
593 }
594 if (precision < 0)
595 precision = 0;
596 }
597
598 /* get the conversion qualifier */
599 qualifier = -1;
Jean-Christophe PLAGNIOL-VILLARDf354b732008-07-14 14:11:45 +0200600 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500601 *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
wdenk153d5112002-08-30 11:07:04 +0000602 qualifier = *fmt;
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500603 ++fmt;
604 if (qualifier == 'l' && *fmt == 'l') {
605 qualifier = 'L';
James Yangbf052932008-01-10 16:02:07 -0600606 ++fmt;
607 }
wdenk153d5112002-08-30 11:07:04 +0000608 }
609
610 /* default base */
611 base = 10;
612
613 switch (*fmt) {
614 case 'c':
Sonny Rao046a37b2011-11-02 09:52:08 +0000615 if (!(flags & LEFT)) {
wdenk153d5112002-08-30 11:07:04 +0000616 while (--field_width > 0)
Sonny Rao046a37b2011-11-02 09:52:08 +0000617 ADDCH(str, ' ');
618 }
619 ADDCH(str, (unsigned char) va_arg(args, int));
wdenk153d5112002-08-30 11:07:04 +0000620 while (--field_width > 0)
Sonny Rao046a37b2011-11-02 09:52:08 +0000621 ADDCH(str, ' ');
wdenk153d5112002-08-30 11:07:04 +0000622 continue;
623
624 case 's':
Heinrich Schuchardtfbb3ea82018-08-31 21:31:25 +0200625/* U-Boot uses UTF-16 strings in the EFI context only. */
Simon Glass726cd982021-12-29 11:57:35 -0700626#if (CONFIG_IS_ENABLED(EFI_LOADER) || CONFIG_IS_ENABLED(EFI_APP)) && \
627 !defined(API_BUILD)
Heinrich Schuchardtfbb3ea82018-08-31 21:31:25 +0200628 if (qualifier == 'l') {
Rob Clark274325c2017-09-09 06:47:41 -0400629 str = string16(str, end, va_arg(args, u16 *),
630 field_width, precision, flags);
Heinrich Schuchardtfbb3ea82018-08-31 21:31:25 +0200631 } else
632#endif
633 {
Rob Clark274325c2017-09-09 06:47:41 -0400634 str = string(str, end, va_arg(args, char *),
635 field_width, precision, flags);
636 }
wdenk153d5112002-08-30 11:07:04 +0000637 continue;
638
639 case 'p':
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000640 str = pointer(fmt + 1, str, end,
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500641 va_arg(args, void *),
642 field_width, precision, flags);
Heinrich Schuchardt256060e2018-01-10 18:06:08 +0100643 if (IS_ERR(str))
644 return PTR_ERR(str);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500645 /* Skip all alphanumeric pointer suffixes */
646 while (isalnum(fmt[1]))
647 fmt++;
wdenk153d5112002-08-30 11:07:04 +0000648 continue;
649
wdenk153d5112002-08-30 11:07:04 +0000650 case 'n':
651 if (qualifier == 'l') {
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000652 long *ip = va_arg(args, long *);
wdenk153d5112002-08-30 11:07:04 +0000653 *ip = (str - buf);
654 } else {
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000655 int *ip = va_arg(args, int *);
wdenk153d5112002-08-30 11:07:04 +0000656 *ip = (str - buf);
657 }
658 continue;
659
660 case '%':
Sonny Rao046a37b2011-11-02 09:52:08 +0000661 ADDCH(str, '%');
wdenk153d5112002-08-30 11:07:04 +0000662 continue;
663
664 /* integer number formats - set up the flags and "break" */
665 case 'o':
666 base = 8;
667 break;
668
wdenk153d5112002-08-30 11:07:04 +0000669 case 'x':
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500670 flags |= SMALL;
671 case 'X':
wdenk153d5112002-08-30 11:07:04 +0000672 base = 16;
673 break;
674
675 case 'd':
676 case 'i':
677 flags |= SIGN;
678 case 'u':
679 break;
680
681 default:
Sonny Rao046a37b2011-11-02 09:52:08 +0000682 ADDCH(str, '%');
wdenk153d5112002-08-30 11:07:04 +0000683 if (*fmt)
Sonny Rao046a37b2011-11-02 09:52:08 +0000684 ADDCH(str, *fmt);
wdenk153d5112002-08-30 11:07:04 +0000685 else
686 --fmt;
687 continue;
688 }
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500689 if (qualifier == 'L') /* "quad" for 64 bit variables */
wdenkc40b2952004-03-13 23:29:43 +0000690 num = va_arg(args, unsigned long long);
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100691 else if (qualifier == 'l') {
wdenk153d5112002-08-30 11:07:04 +0000692 num = va_arg(args, unsigned long);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500693 if (flags & SIGN)
694 num = (signed long) num;
Jean-Christophe PLAGNIOL-VILLARDf354b732008-07-14 14:11:45 +0200695 } else if (qualifier == 'Z' || qualifier == 'z') {
696 num = va_arg(args, size_t);
697 } else if (qualifier == 't') {
698 num = va_arg(args, ptrdiff_t);
699 } else if (qualifier == 'h') {
wdenk153d5112002-08-30 11:07:04 +0000700 num = (unsigned short) va_arg(args, int);
701 if (flags & SIGN)
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500702 num = (signed short) num;
703 } else {
wdenk153d5112002-08-30 11:07:04 +0000704 num = va_arg(args, unsigned int);
Mike Frysinger6c6166f2009-02-16 23:21:36 -0500705 if (flags & SIGN)
706 num = (signed int) num;
707 }
Sonny Rao046a37b2011-11-02 09:52:08 +0000708 str = number(str, end, num, base, field_width, precision,
709 flags);
wdenk153d5112002-08-30 11:07:04 +0000710 }
Sonny Rao046a37b2011-11-02 09:52:08 +0000711
Sonny Rao046a37b2011-11-02 09:52:08 +0000712 if (size > 0) {
713 ADDCH(str, '\0');
714 if (str > end)
715 end[-1] = '\0';
Darwin Rambo686f60f2013-12-19 15:14:19 -0800716 --str;
Sonny Rao046a37b2011-11-02 09:52:08 +0000717 }
Sonny Rao046a37b2011-11-02 09:52:08 +0000718 /* the trailing null byte doesn't count towards the total */
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000719 return str - buf;
wdenk153d5112002-08-30 11:07:04 +0000720}
721
Sonny Rao046a37b2011-11-02 09:52:08 +0000722int vsnprintf(char *buf, size_t size, const char *fmt,
723 va_list args)
724{
725 return vsnprintf_internal(buf, size, fmt, args);
726}
727
Sonny Rao046a37b2011-11-02 09:52:08 +0000728int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
729{
730 int i;
731
732 i = vsnprintf(buf, size, fmt, args);
733
734 if (likely(i < size))
735 return i;
736 if (size != 0)
737 return size - 1;
738 return 0;
739}
740
Sonny Rao046a37b2011-11-02 09:52:08 +0000741int snprintf(char *buf, size_t size, const char *fmt, ...)
742{
743 va_list args;
744 int i;
745
746 va_start(args, fmt);
747 i = vsnprintf(buf, size, fmt, args);
748 va_end(args);
749
750 return i;
751}
752
Sonny Rao046a37b2011-11-02 09:52:08 +0000753int scnprintf(char *buf, size_t size, const char *fmt, ...)
754{
755 va_list args;
756 int i;
757
758 va_start(args, fmt);
759 i = vscnprintf(buf, size, fmt, args);
760 va_end(args);
761
762 return i;
763}
Sonny Rao046a37b2011-11-02 09:52:08 +0000764
765/**
766 * Format a string and place it in a buffer (va_list version)
767 *
768 * @param buf The buffer to place the result into
769 * @param fmt The format string to use
770 * @param args Arguments for the format string
771 *
772 * The function returns the number of characters written
773 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
774 * buffer overflows.
775 *
776 * If you're not already dealing with a va_list consider using sprintf().
777 */
778int vsprintf(char *buf, const char *fmt, va_list args)
779{
780 return vsnprintf_internal(buf, INT_MAX, fmt, args);
781}
782
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000783int sprintf(char *buf, const char *fmt, ...)
wdenk153d5112002-08-30 11:07:04 +0000784{
785 va_list args;
786 int i;
787
788 va_start(args, fmt);
Daniel Schwierzeck8acdae62012-09-16 06:55:03 +0000789 i = vsprintf(buf, fmt, args);
wdenk153d5112002-08-30 11:07:04 +0000790 va_end(args);
791 return i;
792}
793
Alex Kiernan4f1eed72018-04-19 04:32:55 +0000794#if CONFIG_IS_ENABLED(PRINTF)
Stefan Roese7d9cde12015-11-23 07:00:22 +0100795int printf(const char *fmt, ...)
796{
797 va_list args;
798 uint i;
Stefan Roese7d9cde12015-11-23 07:00:22 +0100799
800 va_start(args, fmt);
Rasmus Villemoes97587782021-05-28 00:20:44 +0200801 i = vprintf(fmt, args);
Stefan Roese7d9cde12015-11-23 07:00:22 +0100802 va_end(args);
803
Stefan Roese7d9cde12015-11-23 07:00:22 +0100804 return i;
805}
806
807int vprintf(const char *fmt, va_list args)
808{
809 uint i;
810 char printbuffer[CONFIG_SYS_PBSIZE];
811
812 /*
813 * For this to work, printbuffer must be larger than
814 * anything we ever want to print.
815 */
816 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
817
Heinrich Schuchardt256060e2018-01-10 18:06:08 +0100818 /* Handle error */
819 if (i <= 0)
820 return i;
Stefan Roese7d9cde12015-11-23 07:00:22 +0100821 /* Print the string */
822 puts(printbuffer);
823 return i;
824}
Alex Kiernan4f1eed72018-04-19 04:32:55 +0000825#endif
Simon Glass66312372015-02-27 22:06:32 -0700826
Simon Glass4a255ea2021-10-14 12:48:07 -0600827static char local_toa[22];
828
Simon Glass3cce8a52011-10-21 18:51:33 +0000829char *simple_itoa(ulong i)
830{
831 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
Simon Glass4a255ea2021-10-14 12:48:07 -0600832 char *p = &local_toa[21];
Simon Glass3cce8a52011-10-21 18:51:33 +0000833
834 *p-- = '\0';
835 do {
836 *p-- = '0' + i % 10;
837 i /= 10;
838 } while (i > 0);
839 return p + 1;
840}
Simon Glassb8bcaa32013-06-11 11:14:38 -0700841
Simon Glass4a255ea2021-10-14 12:48:07 -0600842char *simple_xtoa(ulong num)
843{
844 /* 16 digits plus nul terminator, good for 64-bit or smaller ints */
845 char *p = &local_toa[17];
846
847 *--p = '\0';
848 do {
849 p -= 2;
850 hex_byte_pack(p, num & 0xff);
851 num >>= 8;
852 } while (num > 0);
853
854 return p;
855}
856
Simon Glassb8bcaa32013-06-11 11:14:38 -0700857/* We don't seem to have %'d in U-Boot */
858void print_grouped_ull(unsigned long long int_val, int digits)
859{
860 char str[21], *s;
861 int grab = 3;
862
863 digits = (digits + 2) / 3;
864 sprintf(str, "%*llu", digits * 3, int_val);
865 for (s = str; *s; s += grab) {
866 if (s != str)
867 putc(s[-1] != ' ' ? ',' : ' ');
868 printf("%.*s", grab, s);
869 grab = 3;
870 }
871}
Heiko Schocher09c32802015-04-27 07:42:05 +0200872
873bool str2off(const char *p, loff_t *num)
874{
875 char *endptr;
876
877 *num = simple_strtoull(p, &endptr, 16);
878 return *p != '\0' && *endptr == '\0';
879}
880
881bool str2long(const char *p, ulong *num)
882{
883 char *endptr;
884
Simon Glass7e5f4602021-07-24 09:03:29 -0600885 *num = hextoul(p, &endptr);
Heiko Schocher09c32802015-04-27 07:42:05 +0200886 return *p != '\0' && *endptr == '\0';
887}
Simon Glass2189d5f2019-11-14 12:57:20 -0700888
889char *strmhz(char *buf, unsigned long hz)
890{
891 long l, n;
892 long m;
893
894 n = DIV_ROUND_CLOSEST(hz, 1000) / 1000L;
895 l = sprintf(buf, "%ld", n);
896
897 hz -= n * 1000000L;
898 m = DIV_ROUND_CLOSEST(hz, 1000L);
899 if (m != 0)
900 sprintf(buf + l, ".%03ld", m);
901
902 return buf;
903}