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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
|
/*
* Copyright (c) 2011, Google Inc. All rights reserved.
*
* SPDX-License-Identifier: GPL-2.0+
*/
/*
* This module records the progress of boot and arbitrary commands, and
* permits accurate timestamping of each.
*/
#include <common.h>
#include <libfdt.h>
#include <malloc.h>
#include <linux/compiler.h>
DECLARE_GLOBAL_DATA_PTR;
enum {
RECORD_COUNT = CONFIG_BOOTSTAGE_RECORD_COUNT,
};
struct bootstage_record {
ulong time_us;
uint32_t start_us;
const char *name;
int flags; /* see enum bootstage_flags */
enum bootstage_id id;
};
struct bootstage_data {
uint rec_count;
uint next_id;
struct bootstage_record record[RECORD_COUNT];
};
enum {
BOOTSTAGE_VERSION = 0,
BOOTSTAGE_MAGIC = 0xb00757a3,
BOOTSTAGE_DIGITS = 9,
};
struct bootstage_hdr {
uint32_t version; /* BOOTSTAGE_VERSION */
uint32_t count; /* Number of records */
uint32_t size; /* Total data size (non-zero if valid) */
uint32_t magic; /* Unused */
};
int bootstage_relocate(void)
{
struct bootstage_data *data = gd->bootstage;
int i;
/*
* Duplicate all strings. They may point to an old location in the
* program .text section that can eventually get trashed.
*/
debug("Relocating %d records\n", data->rec_count);
for (i = 0; i < data->rec_count; i++)
data->record[i].name = strdup(data->record[i].name);
return 0;
}
struct bootstage_record *find_id(struct bootstage_data *data,
enum bootstage_id id)
{
struct bootstage_record *rec;
struct bootstage_record *end;
for (rec = data->record, end = rec + data->rec_count; rec < end;
rec++) {
if (rec->id == id)
return rec;
}
return NULL;
}
struct bootstage_record *ensure_id(struct bootstage_data *data,
enum bootstage_id id)
{
struct bootstage_record *rec;
rec = find_id(data, id);
if (!rec && data->rec_count < RECORD_COUNT) {
rec = &data->record[data->rec_count++];
rec->id = id;
return rec;
}
return rec;
}
ulong bootstage_add_record(enum bootstage_id id, const char *name,
int flags, ulong mark)
{
struct bootstage_data *data = gd->bootstage;
struct bootstage_record *rec;
if (flags & BOOTSTAGEF_ALLOC)
id = data->next_id++;
/* Only record the first event for each */
rec = find_id(data, id);
if (!rec && data->rec_count < RECORD_COUNT) {
rec = &data->record[data->rec_count++];
rec->time_us = mark;
rec->name = name;
rec->flags = flags;
rec->id = id;
}
/* Tell the board about this progress */
show_boot_progress(flags & BOOTSTAGEF_ERROR ? -id : id);
return mark;
}
ulong bootstage_mark(enum bootstage_id id)
{
return bootstage_add_record(id, NULL, 0, timer_get_boot_us());
}
ulong bootstage_error(enum bootstage_id id)
{
return bootstage_add_record(id, NULL, BOOTSTAGEF_ERROR,
timer_get_boot_us());
}
ulong bootstage_mark_name(enum bootstage_id id, const char *name)
{
int flags = 0;
if (id == BOOTSTAGE_ID_ALLOC)
flags = BOOTSTAGEF_ALLOC;
return bootstage_add_record(id, name, flags, timer_get_boot_us());
}
ulong bootstage_mark_code(const char *file, const char *func, int linenum)
{
char *str, *p;
__maybe_unused char *end;
int len = 0;
/* First work out the length we need to allocate */
if (linenum != -1)
len = 11;
if (func)
len += strlen(func);
if (file)
len += strlen(file);
str = malloc(len + 1);
p = str;
end = p + len;
if (file)
p += snprintf(p, end - p, "%s,", file);
if (linenum != -1)
p += snprintf(p, end - p, "%d", linenum);
if (func)
p += snprintf(p, end - p, ": %s", func);
return bootstage_mark_name(BOOTSTAGE_ID_ALLOC, str);
}
uint32_t bootstage_start(enum bootstage_id id, const char *name)
{
struct bootstage_data *data = gd->bootstage;
struct bootstage_record *rec = ensure_id(data, id);
ulong start_us = timer_get_boot_us();
if (rec) {
rec->start_us = start_us;
rec->name = name;
}
return start_us;
}
uint32_t bootstage_accum(enum bootstage_id id)
{
struct bootstage_data *data = gd->bootstage;
struct bootstage_record *rec = ensure_id(data, id);
uint32_t duration;
if (!rec)
return 0;
duration = (uint32_t)timer_get_boot_us() - rec->start_us;
rec->time_us += duration;
return duration;
}
/**
* Get a record name as a printable string
*
* @param buf Buffer to put name if needed
* @param len Length of buffer
* @param rec Boot stage record to get the name from
* @return pointer to name, either from the record or pointing to buf.
*/
static const char *get_record_name(char *buf, int len,
struct bootstage_record *rec)
{
if (rec->name)
return rec->name;
else if (rec->id >= BOOTSTAGE_ID_USER)
snprintf(buf, len, "user_%d", rec->id - BOOTSTAGE_ID_USER);
else
snprintf(buf, len, "id=%d", rec->id);
return buf;
}
static uint32_t print_time_record(struct bootstage_record *rec, uint32_t prev)
{
char buf[20];
if (prev == -1U) {
printf("%11s", "");
print_grouped_ull(rec->time_us, BOOTSTAGE_DIGITS);
} else {
print_grouped_ull(rec->time_us, BOOTSTAGE_DIGITS);
print_grouped_ull(rec->time_us - prev, BOOTSTAGE_DIGITS);
}
printf(" %s\n", get_record_name(buf, sizeof(buf), rec));
return rec->time_us;
}
static int h_compare_record(const void *r1, const void *r2)
{
const struct bootstage_record *rec1 = r1, *rec2 = r2;
return rec1->time_us > rec2->time_us ? 1 : -1;
}
#ifdef CONFIG_OF_LIBFDT
/**
* Add all bootstage timings to a device tree.
*
* @param blob Device tree blob
* @return 0 on success, != 0 on failure.
*/
static int add_bootstages_devicetree(struct fdt_header *blob)
{
struct bootstage_data *data = gd->bootstage;
int bootstage;
char buf[20];
int recnum;
int i;
if (!blob)
return 0;
/*
* Create the node for bootstage.
* The address of flat device tree is set up by the command bootm.
*/
bootstage = fdt_add_subnode(blob, 0, "bootstage");
if (bootstage < 0)
return -1;
/*
* Insert the timings to the device tree in the reverse order so
* that they can be printed in the Linux kernel in the right order.
*/
for (recnum = data->rec_count - 1, i = 0; recnum >= 0; recnum--, i++) {
struct bootstage_record *rec = &data->record[recnum];
int node;
if (rec->id != BOOTSTAGE_ID_AWAKE && rec->time_us == 0)
continue;
node = fdt_add_subnode(blob, bootstage, simple_itoa(i));
if (node < 0)
break;
/* add properties to the node. */
if (fdt_setprop_string(blob, node, "name",
get_record_name(buf, sizeof(buf), rec)))
return -1;
/* Check if this is a 'mark' or 'accum' record */
if (fdt_setprop_cell(blob, node,
rec->start_us ? "accum" : "mark",
rec->time_us))
return -1;
}
return 0;
}
int bootstage_fdt_add_report(void)
{
if (add_bootstages_devicetree(working_fdt))
puts("bootstage: Failed to add to device tree\n");
return 0;
}
#endif
void bootstage_report(void)
{
struct bootstage_data *data = gd->bootstage;
struct bootstage_record *rec = data->record;
uint32_t prev;
int i;
printf("Timer summary in microseconds (%d records):\n",
data->rec_count);
printf("%11s%11s %s\n", "Mark", "Elapsed", "Stage");
prev = print_time_record(rec, 0);
/* Sort records by increasing time */
qsort(data->record, data->rec_count, sizeof(*rec), h_compare_record);
for (i = 1, rec++; i < data->rec_count; i++, rec++) {
if (rec->id && !rec->start_us)
prev = print_time_record(rec, prev);
}
if (data->rec_count > RECORD_COUNT)
printf("Overflowed internal boot id table by %d entries\n"
"- please increase CONFIG_BOOTSTAGE_RECORD_COUNT\n",
data->rec_count - RECORD_COUNT);
puts("\nAccumulated time:\n");
for (i = 0, rec = data->record; i < data->rec_count; i++, rec++) {
if (rec->start_us)
prev = print_time_record(rec, -1);
}
}
/**
* Append data to a memory buffer
*
* Write data to the buffer if there is space. Whether there is space or not,
* the buffer pointer is incremented.
*
* @param ptrp Pointer to buffer, updated by this function
* @param end Pointer to end of buffer
* @param data Data to write to buffer
* @param size Size of data
*/
static void append_data(char **ptrp, char *end, const void *data, int size)
{
char *ptr = *ptrp;
*ptrp += size;
if (*ptrp > end)
return;
memcpy(ptr, data, size);
}
int bootstage_stash(void *base, int size)
{
struct bootstage_data *data = gd->bootstage;
struct bootstage_hdr *hdr = (struct bootstage_hdr *)base;
struct bootstage_record *rec;
char buf[20];
char *ptr = base, *end = ptr + size;
uint32_t count;
int i;
if (hdr + 1 > (struct bootstage_hdr *)end) {
debug("%s: Not enough space for bootstage hdr\n", __func__);
return -1;
}
/* Write an arbitrary version number */
hdr->version = BOOTSTAGE_VERSION;
/* Count the number of records, and write that value first */
for (rec = data->record, i = count = 0; i < data->rec_count;
i++, rec++) {
if (rec->id != 0)
count++;
}
hdr->count = count;
hdr->size = 0;
hdr->magic = BOOTSTAGE_MAGIC;
ptr += sizeof(*hdr);
/* Write the records, silently stopping when we run out of space */
for (rec = data->record, i = 0; i < data->rec_count; i++, rec++) {
if (rec->time_us != 0)
append_data(&ptr, end, rec, sizeof(*rec));
}
/* Write the name strings */
for (rec = data->record, i = 0; i < data->rec_count; i++, rec++) {
if (rec->time_us != 0) {
const char *name;
name = get_record_name(buf, sizeof(buf), rec);
append_data(&ptr, end, name, strlen(name) + 1);
}
}
/* Check for buffer overflow */
if (ptr > end) {
debug("%s: Not enough space for bootstage stash\n", __func__);
return -1;
}
/* Update total data size */
hdr->size = ptr - (char *)base;
printf("Stashed %d records\n", hdr->count);
return 0;
}
int bootstage_unstash(void *base, int size)
{
struct bootstage_data *data = gd->bootstage;
struct bootstage_hdr *hdr = (struct bootstage_hdr *)base;
struct bootstage_record *rec;
char *ptr = base, *end = ptr + size;
uint rec_size;
int i;
if (size == -1)
end = (char *)(~(uintptr_t)0);
if (hdr + 1 > (struct bootstage_hdr *)end) {
debug("%s: Not enough space for bootstage hdr\n", __func__);
return -1;
}
if (hdr->magic != BOOTSTAGE_MAGIC) {
debug("%s: Invalid bootstage magic\n", __func__);
return -1;
}
if (ptr + hdr->size > end) {
debug("%s: Bootstage data runs past buffer end\n", __func__);
return -1;
}
if (hdr->count * sizeof(*rec) > hdr->size) {
debug("%s: Bootstage has %d records needing %lu bytes, but "
"only %d bytes is available\n", __func__, hdr->count,
(ulong)hdr->count * sizeof(*rec), hdr->size);
return -1;
}
if (hdr->version != BOOTSTAGE_VERSION) {
debug("%s: Bootstage data version %#0x unrecognised\n",
__func__, hdr->version);
return -1;
}
if (data->rec_count + hdr->count > RECORD_COUNT) {
debug("%s: Bootstage has %d records, we have space for %d\n"
"- please increase CONFIG_BOOTSTAGE_USER_COUNT\n",
__func__, hdr->count, RECORD_COUNT - data->rec_count);
return -1;
}
ptr += sizeof(*hdr);
/* Read the records */
rec_size = hdr->count * sizeof(*data->record);
memcpy(data->record + data->rec_count, ptr, rec_size);
/* Read the name strings */
ptr += rec_size;
for (rec = data->record + data->next_id, i = 0; i < hdr->count;
i++, rec++) {
rec->name = ptr;
/* Assume no data corruption here */
ptr += strlen(ptr) + 1;
}
/* Mark the records as read */
data->rec_count += hdr->count;
printf("Unstashed %d records\n", hdr->count);
return 0;
}
int bootstage_init(bool first)
{
struct bootstage_data *data;
int size = sizeof(struct bootstage_data);
gd->bootstage = (struct bootstage_data *)malloc(size);
if (!gd->bootstage)
return -ENOMEM;
data = gd->bootstage;
memset(data, '\0', size);
if (first) {
data->next_id = BOOTSTAGE_ID_USER;
bootstage_add_record(BOOTSTAGE_ID_AWAKE, "reset", 0, 0);
}
return 0;
}
|