xref: /openbmc/u-boot/lib/vsprintf.c (revision d66ff4ba)
1 /*
2  *  linux/lib/vsprintf.c
3  *
4  *  Copyright (C) 1991, 1992  Linus Torvalds
5  */
6 
7 /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
8 /*
9  * Wirzenius wrote this portably, Torvalds fucked it up :-)
10  *
11  * from hush: simple_itoa() was lifted from boa-0.93.15
12  */
13 
14 #include <common.h>
15 #include <charset.h>
16 #include <efi_loader.h>
17 #include <div64.h>
18 #include <hexdump.h>
19 #include <uuid.h>
20 #include <stdarg.h>
21 #include <linux/ctype.h>
22 #include <linux/err.h>
23 #include <linux/types.h>
24 #include <linux/string.h>
25 
26 #define noinline __attribute__((noinline))
27 
28 /* we use this so that we can do without the ctype library */
29 #define is_digit(c)	((c) >= '0' && (c) <= '9')
30 
31 static int skip_atoi(const char **s)
32 {
33 	int i = 0;
34 
35 	while (is_digit(**s))
36 		i = i * 10 + *((*s)++) - '0';
37 
38 	return i;
39 }
40 
41 /* 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. */
51 static char *put_dec_trunc(char *buf, unsigned q)
52 {
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)
80 					*buf++ = q + '0'; /* most sign. digit */
81 			}
82 		}
83 	}
84 	return buf;
85 }
86 /* Same with if's removed. Always emits five digits */
87 static char *put_dec_full(char *buf, unsigned q)
88 {
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 
96 	/*
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 	 */
105 
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 */
129 static noinline char *put_dec(char *buf, uint64_t num)
130 {
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 
140 #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 */
145 #define SMALL	32		/* Must be 32 == 0x20 */
146 #define SPECIAL	64		/* 0x */
147 
148 /*
149  * Macro to add a new character to our output string, but only if it will
150  * fit. The macro moves to the next character position in the output string.
151  */
152 #define ADDCH(str, ch) do { \
153 	if ((str) < end) \
154 		*(str) = (ch); \
155 	++str; \
156 	} while (0)
157 
158 static char *number(char *buf, char *end, u64 num,
159 		int base, int size, int precision, int type)
160 {
161 	/* we are called with base 8, 10 or 16, only, thus don't need "G..."  */
162 	static const char digits[16] = "0123456789ABCDEF";
163 
164 	char tmp[66];
165 	char sign;
166 	char locase;
167 	int need_pfx = ((type & SPECIAL) && base != 10);
168 	int i;
169 
170 	/* locase = 0 or 0x20. ORing digits or letters with 'locase'
171 	 * produces same digits or (maybe lowercased) letters */
172 	locase = (type & SMALL);
173 	if (type & LEFT)
174 		type &= ~ZEROPAD;
175 	sign = 0;
176 	if (type & SIGN) {
177 		if ((s64) num < 0) {
178 			sign = '-';
179 			num = -(s64) num;
180 			size--;
181 		} else if (type & PLUS) {
182 			sign = '+';
183 			size--;
184 		} else if (type & SPACE) {
185 			sign = ' ';
186 			size--;
187 		}
188 	}
189 	if (need_pfx) {
190 		size--;
191 		if (base == 16)
192 			size--;
193 	}
194 
195 	/* generate full string in tmp[], in reverse order */
196 	i = 0;
197 	if (num == 0)
198 		tmp[i++] = '0';
199 	/* Generic code, for any base:
200 	else do {
201 		tmp[i++] = (digits[do_div(num,base)] | locase);
202 	} while (num != 0);
203 	*/
204 	else if (base != 10) { /* 8 or 16 */
205 		int mask = base - 1;
206 		int shift = 3;
207 
208 		if (base == 16)
209 			shift = 4;
210 
211 		do {
212 			tmp[i++] = (digits[((unsigned char)num) & mask]
213 					| locase);
214 			num >>= shift;
215 		} while (num);
216 	} else { /* base 10 */
217 		i = put_dec(tmp, num) - tmp;
218 	}
219 
220 	/* printing 100 using %2d gives "100", not "00" */
221 	if (i > precision)
222 		precision = i;
223 	/* leading space padding */
224 	size -= precision;
225 	if (!(type & (ZEROPAD + LEFT))) {
226 		while (--size >= 0)
227 			ADDCH(buf, ' ');
228 	}
229 	/* sign */
230 	if (sign)
231 		ADDCH(buf, sign);
232 	/* "0x" / "0" prefix */
233 	if (need_pfx) {
234 		ADDCH(buf, '0');
235 		if (base == 16)
236 			ADDCH(buf, 'X' | locase);
237 	}
238 	/* zero or space padding */
239 	if (!(type & LEFT)) {
240 		char c = (type & ZEROPAD) ? '0' : ' ';
241 
242 		while (--size >= 0)
243 			ADDCH(buf, c);
244 	}
245 	/* hmm even more zero padding? */
246 	while (i <= --precision)
247 		ADDCH(buf, '0');
248 	/* actual digits of result */
249 	while (--i >= 0)
250 		ADDCH(buf, tmp[i]);
251 	/* trailing space padding */
252 	while (--size >= 0)
253 		ADDCH(buf, ' ');
254 	return buf;
255 }
256 
257 static char *string(char *buf, char *end, char *s, int field_width,
258 		int precision, int flags)
259 {
260 	int len, i;
261 
262 	if (s == NULL)
263 		s = "<NULL>";
264 
265 	len = strnlen(s, precision);
266 
267 	if (!(flags & LEFT))
268 		while (len < field_width--)
269 			ADDCH(buf, ' ');
270 	for (i = 0; i < len; ++i)
271 		ADDCH(buf, *s++);
272 	while (len < field_width--)
273 		ADDCH(buf, ' ');
274 	return buf;
275 }
276 
277 /* U-Boot uses UTF-16 strings in the EFI context only. */
278 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
279 static char *string16(char *buf, char *end, u16 *s, int field_width,
280 		int precision, int flags)
281 {
282 	u16 *str = s ? s : L"<NULL>";
283 	ssize_t len = utf16_strnlen(str, precision);
284 
285 	if (!(flags & LEFT))
286 		for (; len < field_width; --field_width)
287 			ADDCH(buf, ' ');
288 	utf16_utf8_strncpy(&buf, str, len);
289 	for (; len < field_width; --field_width)
290 		ADDCH(buf, ' ');
291 	return buf;
292 }
293 
294 static char *device_path_string(char *buf, char *end, void *dp, int field_width,
295 				int precision, int flags)
296 {
297 	u16 *str;
298 
299 	/* If dp == NULL output the string '<NULL>' */
300 	if (!dp)
301 		return string16(buf, end, dp, field_width, precision, flags);
302 
303 	str = efi_dp_str((struct efi_device_path *)dp);
304 	if (!str)
305 		return ERR_PTR(-ENOMEM);
306 
307 	buf = string16(buf, end, str, field_width, precision, flags);
308 	efi_free_pool(str);
309 	return buf;
310 }
311 #endif
312 
313 #ifdef CONFIG_CMD_NET
314 static char *mac_address_string(char *buf, char *end, u8 *addr, int field_width,
315 				int precision, int flags)
316 {
317 	/* (6 * 2 hex digits), 5 colons and trailing zero */
318 	char mac_addr[6 * 3];
319 	char *p = mac_addr;
320 	int i;
321 
322 	for (i = 0; i < 6; i++) {
323 		p = hex_byte_pack(p, addr[i]);
324 		if (!(flags & SPECIAL) && i != 5)
325 			*p++ = ':';
326 	}
327 	*p = '\0';
328 
329 	return string(buf, end, mac_addr, field_width, precision,
330 		      flags & ~SPECIAL);
331 }
332 
333 static char *ip6_addr_string(char *buf, char *end, u8 *addr, int field_width,
334 			 int precision, int flags)
335 {
336 	/* (8 * 4 hex digits), 7 colons and trailing zero */
337 	char ip6_addr[8 * 5];
338 	char *p = ip6_addr;
339 	int i;
340 
341 	for (i = 0; i < 8; i++) {
342 		p = hex_byte_pack(p, addr[2 * i]);
343 		p = hex_byte_pack(p, addr[2 * i + 1]);
344 		if (!(flags & SPECIAL) && i != 7)
345 			*p++ = ':';
346 	}
347 	*p = '\0';
348 
349 	return string(buf, end, ip6_addr, field_width, precision,
350 		      flags & ~SPECIAL);
351 }
352 
353 static char *ip4_addr_string(char *buf, char *end, u8 *addr, int field_width,
354 			 int precision, int flags)
355 {
356 	/* (4 * 3 decimal digits), 3 dots and trailing zero */
357 	char ip4_addr[4 * 4];
358 	char temp[3];	/* hold each IP quad in reverse order */
359 	char *p = ip4_addr;
360 	int i, digits;
361 
362 	for (i = 0; i < 4; i++) {
363 		digits = put_dec_trunc(temp, addr[i]) - temp;
364 		/* reverse the digits in the quad */
365 		while (digits--)
366 			*p++ = temp[digits];
367 		if (i != 3)
368 			*p++ = '.';
369 	}
370 	*p = '\0';
371 
372 	return string(buf, end, ip4_addr, field_width, precision,
373 		      flags & ~SPECIAL);
374 }
375 #endif
376 
377 #ifdef CONFIG_LIB_UUID
378 /*
379  * This works (roughly) the same way as linux's, but we currently always
380  * print lower-case (ie. we just keep %pUB and %pUL for compat with linux),
381  * mostly just because that is what uuid_bin_to_str() supports.
382  *
383  *   %pUb:   01020304-0506-0708-090a-0b0c0d0e0f10
384  *   %pUl:   04030201-0605-0807-090a-0b0c0d0e0f10
385  */
386 static char *uuid_string(char *buf, char *end, u8 *addr, int field_width,
387 			 int precision, int flags, const char *fmt)
388 {
389 	char uuid[UUID_STR_LEN + 1];
390 	int str_format = UUID_STR_FORMAT_STD;
391 
392 	switch (*(++fmt)) {
393 	case 'L':
394 	case 'l':
395 		str_format = UUID_STR_FORMAT_GUID;
396 		break;
397 	case 'B':
398 	case 'b':
399 		/* this is the default */
400 		break;
401 	default:
402 		break;
403 	}
404 
405 	if (addr)
406 		uuid_bin_to_str(addr, uuid, str_format);
407 	else
408 		strcpy(uuid, "<NULL>");
409 
410 	return string(buf, end, uuid, field_width, precision, flags);
411 }
412 #endif
413 
414 /*
415  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
416  * by an extra set of alphanumeric characters that are extended format
417  * specifiers.
418  *
419  * Right now we handle:
420  *
421  * - 'M' For a 6-byte MAC address, it prints the address in the
422  *       usual colon-separated hex notation
423  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
424  *       decimal for v4 and colon separated network-order 16 bit hex for v6)
425  * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
426  *       currently the same
427  *
428  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
429  * function pointers are really function descriptors, which contain a
430  * pointer to the real address.
431  */
432 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
433 		int field_width, int precision, int flags)
434 {
435 	u64 num = (uintptr_t)ptr;
436 
437 	/*
438 	 * Being a boot loader, we explicitly allow pointers to
439 	 * (physical) address null.
440 	 */
441 #if 0
442 	if (!ptr)
443 		return string(buf, end, "(null)", field_width, precision,
444 			      flags);
445 #endif
446 
447 	switch (*fmt) {
448 /* Device paths only exist in the EFI context. */
449 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
450 	case 'D':
451 		return device_path_string(buf, end, ptr, field_width,
452 					  precision, flags);
453 #endif
454 #ifdef CONFIG_CMD_NET
455 	case 'a':
456 		flags |= SPECIAL | ZEROPAD;
457 
458 		switch (fmt[1]) {
459 		case 'p':
460 		default:
461 			field_width = sizeof(phys_addr_t) * 2 + 2;
462 			num = *(phys_addr_t *)ptr;
463 			break;
464 		}
465 		break;
466 	case 'm':
467 		flags |= SPECIAL;
468 		/* Fallthrough */
469 	case 'M':
470 		return mac_address_string(buf, end, ptr, field_width,
471 					  precision, flags);
472 	case 'i':
473 		flags |= SPECIAL;
474 		/* Fallthrough */
475 	case 'I':
476 		if (fmt[1] == '6')
477 			return ip6_addr_string(buf, end, ptr, field_width,
478 					       precision, flags);
479 		if (fmt[1] == '4')
480 			return ip4_addr_string(buf, end, ptr, field_width,
481 					       precision, flags);
482 		flags &= ~SPECIAL;
483 		break;
484 #endif
485 #ifdef CONFIG_LIB_UUID
486 	case 'U':
487 		return uuid_string(buf, end, ptr, field_width, precision,
488 				   flags, fmt);
489 #endif
490 	default:
491 		break;
492 	}
493 	flags |= SMALL;
494 	if (field_width == -1) {
495 		field_width = 2*sizeof(void *);
496 		flags |= ZEROPAD;
497 	}
498 	return number(buf, end, num, 16, field_width, precision, flags);
499 }
500 
501 static int vsnprintf_internal(char *buf, size_t size, const char *fmt,
502 			      va_list args)
503 {
504 	u64 num;
505 	int base;
506 	char *str;
507 
508 	int flags;		/* flags to number() */
509 
510 	int field_width;	/* width of output field */
511 	int precision;		/* min. # of digits for integers; max
512 				   number of chars for from string */
513 	int qualifier;		/* 'h', 'l', or 'L' for integer fields */
514 				/* 'z' support added 23/7/1999 S.H.    */
515 				/* 'z' changed to 'Z' --davidm 1/25/99 */
516 				/* 't' added for ptrdiff_t */
517 	char *end = buf + size;
518 
519 	/* Make sure end is always >= buf - do we want this in U-Boot? */
520 	if (end < buf) {
521 		end = ((void *)-1);
522 		size = end - buf;
523 	}
524 	str = buf;
525 
526 	for (; *fmt ; ++fmt) {
527 		if (*fmt != '%') {
528 			ADDCH(str, *fmt);
529 			continue;
530 		}
531 
532 		/* process flags */
533 		flags = 0;
534 repeat:
535 			++fmt;		/* this also skips first '%' */
536 			switch (*fmt) {
537 			case '-':
538 				flags |= LEFT;
539 				goto repeat;
540 			case '+':
541 				flags |= PLUS;
542 				goto repeat;
543 			case ' ':
544 				flags |= SPACE;
545 				goto repeat;
546 			case '#':
547 				flags |= SPECIAL;
548 				goto repeat;
549 			case '0':
550 				flags |= ZEROPAD;
551 				goto repeat;
552 			}
553 
554 		/* get field width */
555 		field_width = -1;
556 		if (is_digit(*fmt))
557 			field_width = skip_atoi(&fmt);
558 		else if (*fmt == '*') {
559 			++fmt;
560 			/* it's the next argument */
561 			field_width = va_arg(args, int);
562 			if (field_width < 0) {
563 				field_width = -field_width;
564 				flags |= LEFT;
565 			}
566 		}
567 
568 		/* get the precision */
569 		precision = -1;
570 		if (*fmt == '.') {
571 			++fmt;
572 			if (is_digit(*fmt))
573 				precision = skip_atoi(&fmt);
574 			else if (*fmt == '*') {
575 				++fmt;
576 				/* it's the next argument */
577 				precision = va_arg(args, int);
578 			}
579 			if (precision < 0)
580 				precision = 0;
581 		}
582 
583 		/* get the conversion qualifier */
584 		qualifier = -1;
585 		if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
586 		    *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
587 			qualifier = *fmt;
588 			++fmt;
589 			if (qualifier == 'l' && *fmt == 'l') {
590 				qualifier = 'L';
591 				++fmt;
592 			}
593 		}
594 
595 		/* default base */
596 		base = 10;
597 
598 		switch (*fmt) {
599 		case 'c':
600 			if (!(flags & LEFT)) {
601 				while (--field_width > 0)
602 					ADDCH(str, ' ');
603 			}
604 			ADDCH(str, (unsigned char) va_arg(args, int));
605 			while (--field_width > 0)
606 				ADDCH(str, ' ');
607 			continue;
608 
609 		case 's':
610 /* U-Boot uses UTF-16 strings in the EFI context only. */
611 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
612 			if (qualifier == 'l') {
613 				str = string16(str, end, va_arg(args, u16 *),
614 					       field_width, precision, flags);
615 			} else
616 #endif
617 			{
618 				str = string(str, end, va_arg(args, char *),
619 					     field_width, precision, flags);
620 			}
621 			continue;
622 
623 		case 'p':
624 			str = pointer(fmt + 1, str, end,
625 					va_arg(args, void *),
626 					field_width, precision, flags);
627 			if (IS_ERR(str))
628 				return PTR_ERR(str);
629 			/* Skip all alphanumeric pointer suffixes */
630 			while (isalnum(fmt[1]))
631 				fmt++;
632 			continue;
633 
634 		case 'n':
635 			if (qualifier == 'l') {
636 				long *ip = va_arg(args, long *);
637 				*ip = (str - buf);
638 			} else {
639 				int *ip = va_arg(args, int *);
640 				*ip = (str - buf);
641 			}
642 			continue;
643 
644 		case '%':
645 			ADDCH(str, '%');
646 			continue;
647 
648 		/* integer number formats - set up the flags and "break" */
649 		case 'o':
650 			base = 8;
651 			break;
652 
653 		case 'x':
654 			flags |= SMALL;
655 		case 'X':
656 			base = 16;
657 			break;
658 
659 		case 'd':
660 		case 'i':
661 			flags |= SIGN;
662 		case 'u':
663 			break;
664 
665 		default:
666 			ADDCH(str, '%');
667 			if (*fmt)
668 				ADDCH(str, *fmt);
669 			else
670 				--fmt;
671 			continue;
672 		}
673 		if (qualifier == 'L')  /* "quad" for 64 bit variables */
674 			num = va_arg(args, unsigned long long);
675 		else if (qualifier == 'l') {
676 			num = va_arg(args, unsigned long);
677 			if (flags & SIGN)
678 				num = (signed long) num;
679 		} else if (qualifier == 'Z' || qualifier == 'z') {
680 			num = va_arg(args, size_t);
681 		} else if (qualifier == 't') {
682 			num = va_arg(args, ptrdiff_t);
683 		} else if (qualifier == 'h') {
684 			num = (unsigned short) va_arg(args, int);
685 			if (flags & SIGN)
686 				num = (signed short) num;
687 		} else {
688 			num = va_arg(args, unsigned int);
689 			if (flags & SIGN)
690 				num = (signed int) num;
691 		}
692 		str = number(str, end, num, base, field_width, precision,
693 			     flags);
694 	}
695 
696 	if (size > 0) {
697 		ADDCH(str, '\0');
698 		if (str > end)
699 			end[-1] = '\0';
700 		--str;
701 	}
702 	/* the trailing null byte doesn't count towards the total */
703 	return str - buf;
704 }
705 
706 int vsnprintf(char *buf, size_t size, const char *fmt,
707 			      va_list args)
708 {
709 	return vsnprintf_internal(buf, size, fmt, args);
710 }
711 
712 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
713 {
714 	int i;
715 
716 	i = vsnprintf(buf, size, fmt, args);
717 
718 	if (likely(i < size))
719 		return i;
720 	if (size != 0)
721 		return size - 1;
722 	return 0;
723 }
724 
725 int snprintf(char *buf, size_t size, const char *fmt, ...)
726 {
727 	va_list args;
728 	int i;
729 
730 	va_start(args, fmt);
731 	i = vsnprintf(buf, size, fmt, args);
732 	va_end(args);
733 
734 	return i;
735 }
736 
737 int scnprintf(char *buf, size_t size, const char *fmt, ...)
738 {
739 	va_list args;
740 	int i;
741 
742 	va_start(args, fmt);
743 	i = vscnprintf(buf, size, fmt, args);
744 	va_end(args);
745 
746 	return i;
747 }
748 
749 /**
750  * Format a string and place it in a buffer (va_list version)
751  *
752  * @param buf	The buffer to place the result into
753  * @param fmt	The format string to use
754  * @param args	Arguments for the format string
755  *
756  * The function returns the number of characters written
757  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
758  * buffer overflows.
759  *
760  * If you're not already dealing with a va_list consider using sprintf().
761  */
762 int vsprintf(char *buf, const char *fmt, va_list args)
763 {
764 	return vsnprintf_internal(buf, INT_MAX, fmt, args);
765 }
766 
767 int sprintf(char *buf, const char *fmt, ...)
768 {
769 	va_list args;
770 	int i;
771 
772 	va_start(args, fmt);
773 	i = vsprintf(buf, fmt, args);
774 	va_end(args);
775 	return i;
776 }
777 
778 #if CONFIG_IS_ENABLED(PRINTF)
779 int printf(const char *fmt, ...)
780 {
781 	va_list args;
782 	uint i;
783 	char printbuffer[CONFIG_SYS_PBSIZE];
784 
785 	va_start(args, fmt);
786 
787 	/*
788 	 * For this to work, printbuffer must be larger than
789 	 * anything we ever want to print.
790 	 */
791 	i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
792 	va_end(args);
793 
794 	/* Handle error */
795 	if (i <= 0)
796 		return i;
797 	/* Print the string */
798 	puts(printbuffer);
799 	return i;
800 }
801 
802 int vprintf(const char *fmt, va_list args)
803 {
804 	uint i;
805 	char printbuffer[CONFIG_SYS_PBSIZE];
806 
807 	/*
808 	 * For this to work, printbuffer must be larger than
809 	 * anything we ever want to print.
810 	 */
811 	i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
812 
813 	/* Handle error */
814 	if (i <= 0)
815 		return i;
816 	/* Print the string */
817 	puts(printbuffer);
818 	return i;
819 }
820 #endif
821 
822 char *simple_itoa(ulong i)
823 {
824 	/* 21 digits plus null terminator, good for 64-bit or smaller ints */
825 	static char local[22];
826 	char *p = &local[21];
827 
828 	*p-- = '\0';
829 	do {
830 		*p-- = '0' + i % 10;
831 		i /= 10;
832 	} while (i > 0);
833 	return p + 1;
834 }
835 
836 /* We don't seem to have %'d in U-Boot */
837 void print_grouped_ull(unsigned long long int_val, int digits)
838 {
839 	char str[21], *s;
840 	int grab = 3;
841 
842 	digits = (digits + 2) / 3;
843 	sprintf(str, "%*llu", digits * 3, int_val);
844 	for (s = str; *s; s += grab) {
845 		if (s != str)
846 			putc(s[-1] != ' ' ? ',' : ' ');
847 		printf("%.*s", grab, s);
848 		grab = 3;
849 	}
850 }
851 
852 bool str2off(const char *p, loff_t *num)
853 {
854 	char *endptr;
855 
856 	*num = simple_strtoull(p, &endptr, 16);
857 	return *p != '\0' && *endptr == '\0';
858 }
859 
860 bool str2long(const char *p, ulong *num)
861 {
862 	char *endptr;
863 
864 	*num = simple_strtoul(p, &endptr, 16);
865 	return *p != '\0' && *endptr == '\0';
866 }
867