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