1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
/* Copyright 2012 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* Printf-like functionality for Chrome EC */
#include "console.h"
#include "printf.h"
#include "timer.h"
#include "util.h"
static const char error_str[] = "ERROR";
#define MAX_FORMAT 1024 /* Maximum chars in a single format field */
#ifndef CONFIG_DEBUG_PRINTF
static inline int divmod(uint64_t *n, int d)
{
return uint64divmod(n, d);
}
#else /* CONFIG_DEBUG_PRINTF */
/* if we are optimizing for size, remove the 64-bit support */
#define NO_UINT64_SUPPORT
static inline int divmod(uint32_t *n, int d)
{
int r = *n % d;
*n /= d;
return r;
}
#endif
/**
* Convert the lowest nibble of a number to hex
*
* @param c Number to extract lowest nibble from
*
* @return The corresponding ASCII character ('0' - 'f').
*/
static int hexdigit(int c)
{
/* Strip off just the last nibble */
c &= 0x0f;
return c > 9 ? (c + 'a' - 10) : (c + '0');
}
/* Flags for vfnprintf() flags */
#define PF_LEFT BIT(0) /* Left-justify */
#define PF_PADZERO BIT(1) /* Pad with 0's not spaces */
#define PF_SIGN BIT(2) /* Add sign (+) for a positive number */
/* Deactivate the PF_64BIT flag is 64-bit support is disabled. */
#ifdef NO_UINT64_SUPPORT
#define PF_64BIT 0
#else
#define PF_64BIT BIT(3) /* Number is 64-bit */
#endif
/*
* Print the buffer as a string of bytes in hex.
* Returns 0 on success or an error on failure.
*/
static int print_hex_buffer(int (*addchar)(void *context, int c),
void *context, const char *vstr, int precision,
int pad_width, int flags)
{
/*
* Divide pad_width instead of multiplying precision to avoid overflow
* error in the condition. The "/2" and "2*" can be optimized by
* the compiler.
*/
if ((pad_width / 2) >= precision)
pad_width -= 2 * precision;
else
pad_width = 0;
while (pad_width > 0 && !(flags & PF_LEFT)) {
if (addchar(context, flags & PF_PADZERO ? '0' : ' '))
return EC_ERROR_OVERFLOW;
pad_width--;
}
for (; precision; precision--, vstr++) {
if (addchar(context, hexdigit(*vstr >> 4)) ||
addchar(context, hexdigit(*vstr)))
return EC_ERROR_OVERFLOW;
}
while (pad_width > 0 && (flags & PF_LEFT)) {
if (addchar(context, ' '))
return EC_ERROR_OVERFLOW;
pad_width--;
}
return EC_SUCCESS;
}
int vfnprintf(int (*addchar)(void *context, int c), void *context,
const char *format, va_list args)
{
/*
* Longest uint64 in decimal = 20
* Longest uint32 in binary = 32
* + sign bit
* + terminating null
*/
char intbuf[34];
int flags;
int pad_width;
int precision;
char *vstr;
int vlen;
while (*format) {
int c = *format++;
char sign = 0;
/* Copy normal characters */
if (c != '%') {
if (addchar(context, c))
return EC_ERROR_OVERFLOW;
continue;
}
/* Zero flags, now that we're in a format */
flags = 0;
/* Get first format character */
c = *format++;
/* Send "%" for "%%" input */
if (c == '%' || c == '\0') {
if (addchar(context, '%'))
return EC_ERROR_OVERFLOW;
if (c == '\0')
break;
continue;
}
/* Handle %c */
if (c == 'c') {
c = va_arg(args, int);
if (addchar(context, c))
return EC_ERROR_OVERFLOW;
continue;
}
/* Handle left-justification ("%-5s") */
if (c == '-') {
flags |= PF_LEFT;
c = *format++;
}
/* Handle positive sign (%+d) */
if (c == '+') {
flags |= PF_SIGN;
c = *format++;
}
/* Handle padding with 0's */
if (c == '0') {
flags |= PF_PADZERO;
c = *format++;
}
/* Count padding length */
pad_width = 0;
if (c == '*') {
pad_width = va_arg(args, int);
c = *format++;
} else {
while (c >= '0' && c <= '9') {
pad_width = (10 * pad_width) + c - '0';
c = *format++;
}
}
if (pad_width < 0 || pad_width > MAX_FORMAT) {
/* Sanity check for precision failed */
format = error_str;
continue;
}
/* Count precision */
precision = -1;
if (c == '.') {
c = *format++;
if (c == '*') {
precision = va_arg(args, int);
c = *format++;
} else {
precision = 0;
while (c >= '0' && c <= '9') {
precision = (10 * precision) + c - '0';
c = *format++;
}
}
if (precision < 0 || precision > MAX_FORMAT) {
/* Sanity check for precision failed */
format = error_str;
continue;
}
}
if (c == 's') {
vstr = va_arg(args, char *);
if (vstr == NULL)
vstr = "(NULL)";
} else {
int base = 10;
#ifdef NO_UINT64_SUPPORT
uint32_t v;
#else
uint64_t v;
#endif
int ptrspec;
void *ptrval;
/* Handle length */
if (c == 'l') {
flags |= PF_64BIT;
c = *format++;
}
if (c == 'p') {
ptrspec = *format++;
ptrval = va_arg(args, void *);
/* %pT - print a timestamp. */
if (ptrspec == 'T' &&
!IS_ENABLED(NO_UINT64_SUPPORT)) {
flags |= PF_64BIT;
/* NULL uses the current time. */
if (ptrval == NULL)
v = get_time().val;
else
v = *(uint64_t *)ptrval;
if (IS_ENABLED(
CONFIG_CONSOLE_VERBOSE)) {
precision = 6;
} else {
precision = 3;
v /= 1000;
}
} else if (ptrspec == 'h') {
/* %ph - Print a hex byte buffer. */
struct hex_buffer_params *hexbuf =
ptrval;
int rc;
rc = print_hex_buffer(addchar,
context,
hexbuf->buffer,
hexbuf->size,
0,
0);
if (rc != EC_SUCCESS)
return rc;
continue;
} else if (ptrspec == 'P') {
/* %pP - Print a raw pointer. */
v = (unsigned long)ptrval;
if (sizeof(unsigned long) ==
sizeof(uint64_t))
flags |= PF_64BIT;
} else {
return EC_ERROR_INVAL;
}
} else if (flags & PF_64BIT) {
v = va_arg(args, uint64_t);
} else {
v = va_arg(args, uint32_t);
}
switch (c) {
#ifdef CONFIG_PRINTF_LEGACY_LI_FORMAT
case 'i':
/* force 32-bit for compatibility */
flags &= ~PF_64BIT;
/* fall-through */
#endif /* CONFIG_PRINTF_LEGACY_LI_FORMAT */
case 'd':
if (flags & PF_64BIT) {
if ((int64_t)v < 0) {
sign = '-';
if (v != (1ULL << 63))
v = -v;
} else if (flags & PF_SIGN) {
sign = '+';
}
} else {
if ((int)v < 0) {
sign = '-';
if (v != (1ULL << 31))
v = -(int)v;
} else if (flags & PF_SIGN) {
sign = '+';
}
}
break;
case 'u':
case 'T':
break;
case 'X':
case 'x':
case 'p':
base = 16;
break;
case 'b':
base = 2;
break;
default:
format = error_str;
}
if (format == error_str)
continue; /* Bad format specifier */
/*
* Convert integer to string, starting at end of
* buffer and working backwards.
*/
vstr = intbuf + sizeof(intbuf) - 1;
*(vstr) = '\0';
/*
* Fixed-point precision must fit in our buffer.
* Leave space for "0." and the terminating null.
*/
if (precision > (int)(sizeof(intbuf) - 3))
precision = sizeof(intbuf) - 3;
/*
* Handle digits to right of decimal for fixed point
* numbers.
*/
for (vlen = 0; vlen < precision; vlen++)
*(--vstr) = '0' + divmod(&v, 10);
if (precision >= 0)
*(--vstr) = '.';
if (!v)
*(--vstr) = '0';
while (v) {
int digit = divmod(&v, base);
if (digit < 10)
*(--vstr) = '0' + digit;
else if (c == 'X')
*(--vstr) = 'A' + digit - 10;
else
*(--vstr) = 'a' + digit - 10;
}
if (sign)
*(--vstr) = sign;
/*
* Precision field was interpreted by fixed-point
* logic, so clear it.
*/
precision = -1;
}
/* No padding strings to wider than the precision */
if (precision >= 0 && pad_width > precision)
pad_width = precision;
if (precision < 0) {
/* If precision is unset, print everything */
vlen = strlen(vstr);
precision = MAX(vlen, pad_width);
} else {
/*
* If precision is set, ensure that we do not
* overrun it
*/
vlen = strnlen(vstr, precision);
}
while (vlen < pad_width && !(flags & PF_LEFT)) {
if (addchar(context, flags & PF_PADZERO ? '0' : ' '))
return EC_ERROR_OVERFLOW;
vlen++;
}
while (--precision >= 0 && *vstr)
if (addchar(context, *vstr++))
return EC_ERROR_OVERFLOW;
while (vlen < pad_width && flags & PF_LEFT) {
if (addchar(context, ' '))
return EC_ERROR_OVERFLOW;
vlen++;
}
}
/* If we're still here, we consumed all output */
return EC_SUCCESS;
}
/* Context for snprintf() */
struct snprintf_context {
char *str;
int size;
};
/**
* Add a character to the string context.
*
* @param context Context receiving character
* @param c Character to add
* @return 0 if character added, 1 if character dropped because no space.
*/
static int snprintf_addchar(void *context, int c)
{
struct snprintf_context *ctx = (struct snprintf_context *)context;
if (!ctx->size)
return 1;
*(ctx->str++) = c;
ctx->size--;
return 0;
}
int snprintf(char *str, int size, const char *format, ...)
{
va_list args;
int rv;
va_start(args, format);
rv = vsnprintf(str, size, format, args);
va_end(args);
return rv;
}
int vsnprintf(char *str, int size, const char *format, va_list args)
{
struct snprintf_context ctx;
int rv;
if (!str || !format || size <= 0)
return -EC_ERROR_INVAL;
ctx.str = str;
ctx.size = size - 1; /* Reserve space for terminating '\0' */
rv = vfnprintf(snprintf_addchar, &ctx, format, args);
/* Terminate string */
*ctx.str = '\0';
return (rv == EC_SUCCESS) ? (ctx.str - str) : -rv;
}
|