2 * Copyright (c) 2011, Google Inc. All rights reserved.
4 * See file CREDITS for list of people who contributed to this
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation; either version 2 of
10 * the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
25 * This module records the progress of boot and arbitrary commands, and
26 * permits accurate timestamping of each.
28 * TBD: Pass timings to kernel in the FDT
34 DECLARE_GLOBAL_DATA_PTR;
36 struct bootstage_record {
40 int flags; /* see enum bootstage_flags */
44 static struct bootstage_record record[BOOTSTAGE_ID_COUNT] = { {1} };
45 static int next_id = BOOTSTAGE_ID_USER;
48 BOOTSTAGE_VERSION = 0,
49 BOOTSTAGE_MAGIC = 0xb00757a3,
52 struct bootstage_hdr {
53 uint32_t version; /* BOOTSTAGE_VERSION */
54 uint32_t count; /* Number of records */
55 uint32_t size; /* Total data size (non-zero if valid) */
56 uint32_t magic; /* Unused */
59 int bootstage_relocate(void)
64 * Duplicate all strings. They may point to an old location in the
65 * program .text section that can eventually get trashed.
67 for (i = 0; i < BOOTSTAGE_ID_COUNT; i++)
69 record[i].name = strdup(record[i].name);
74 ulong bootstage_add_record(enum bootstage_id id, const char *name,
75 int flags, ulong mark)
77 struct bootstage_record *rec;
79 if (flags & BOOTSTAGEF_ALLOC)
82 if (id < BOOTSTAGE_ID_COUNT) {
85 /* Only record the first event for each */
94 /* Tell the board about this progress */
95 show_boot_progress(flags & BOOTSTAGEF_ERROR ? -id : id);
100 ulong bootstage_mark(enum bootstage_id id)
102 return bootstage_add_record(id, NULL, 0, timer_get_boot_us());
105 ulong bootstage_error(enum bootstage_id id)
107 return bootstage_add_record(id, NULL, BOOTSTAGEF_ERROR,
108 timer_get_boot_us());
111 ulong bootstage_mark_name(enum bootstage_id id, const char *name)
115 if (id == BOOTSTAGE_ID_ALLOC)
116 flags = BOOTSTAGEF_ALLOC;
117 return bootstage_add_record(id, name, flags, timer_get_boot_us());
120 uint32_t bootstage_start(enum bootstage_id id, const char *name)
122 struct bootstage_record *rec = &record[id];
124 rec->start_us = timer_get_boot_us();
126 return rec->start_us;
129 uint32_t bootstage_accum(enum bootstage_id id)
131 struct bootstage_record *rec = &record[id];
134 duration = (uint32_t)timer_get_boot_us() - rec->start_us;
135 rec->time_us += duration;
139 static void print_time(unsigned long us_time)
144 /* We don't seem to have %'d in U-Boot */
145 sprintf(str, "%12lu", us_time);
146 for (s = str + 3; *s; s += grab) {
148 putc(s[-1] != ' ' ? ',' : ' ');
149 printf("%.*s", grab, s);
155 * Get a record name as a printable string
157 * @param buf Buffer to put name if needed
158 * @param len Length of buffer
159 * @param rec Boot stage record to get the name from
160 * @return pointer to name, either from the record or pointing to buf.
162 static const char *get_record_name(char *buf, int len,
163 struct bootstage_record *rec)
167 else if (rec->id >= BOOTSTAGE_ID_USER)
168 snprintf(buf, len, "user_%d", rec->id - BOOTSTAGE_ID_USER);
170 snprintf(buf, len, "id=%d", rec->id);
175 static uint32_t print_time_record(enum bootstage_id id,
176 struct bootstage_record *rec, uint32_t prev)
182 print_time(rec->time_us);
184 print_time(rec->time_us);
185 print_time(rec->time_us - prev);
187 printf(" %s\n", get_record_name(buf, sizeof(buf), rec));
192 static int h_compare_record(const void *r1, const void *r2)
194 const struct bootstage_record *rec1 = r1, *rec2 = r2;
196 return rec1->time_us > rec2->time_us ? 1 : -1;
199 #ifdef CONFIG_OF_LIBFDT
201 * Add all bootstage timings to a device tree.
203 * @param blob Device tree blob
204 * @return 0 on success, != 0 on failure.
206 static int add_bootstages_devicetree(struct fdt_header *blob)
217 * Create the node for bootstage.
218 * The address of flat device tree is set up by the command bootm.
220 bootstage = fdt_add_subnode(blob, 0, "bootstage");
225 * Insert the timings to the device tree in the reverse order so
226 * that they can be printed in the Linux kernel in the right order.
228 for (id = BOOTSTAGE_ID_COUNT - 1, i = 0; id >= 0; id--, i++) {
229 struct bootstage_record *rec = &record[id];
232 if (id != BOOTSTAGE_ID_AWAKE && rec->time_us == 0)
235 node = fdt_add_subnode(blob, bootstage, simple_itoa(i));
239 /* add properties to the node. */
240 if (fdt_setprop_string(blob, node, "name",
241 get_record_name(buf, sizeof(buf), rec)))
244 /* Check if this is a 'mark' or 'accum' record */
245 if (fdt_setprop_cell(blob, node,
246 rec->start_us ? "accum" : "mark",
254 int bootstage_fdt_add_report(void)
256 if (add_bootstages_devicetree(working_fdt))
257 puts("bootstage: Failed to add to device tree\n");
263 void bootstage_report(void)
265 struct bootstage_record *rec = record;
269 puts("Timer summary in microseconds:\n");
270 printf("%11s%11s %s\n", "Mark", "Elapsed", "Stage");
272 /* Fake the first record - we could get it from early boot */
275 prev = print_time_record(BOOTSTAGE_ID_AWAKE, rec, 0);
277 /* Sort records by increasing time */
278 qsort(record, ARRAY_SIZE(record), sizeof(*rec), h_compare_record);
280 for (id = 0; id < BOOTSTAGE_ID_COUNT; id++, rec++) {
281 if (rec->time_us != 0 && !rec->start_us)
282 prev = print_time_record(rec->id, rec, prev);
284 if (next_id > BOOTSTAGE_ID_COUNT)
285 printf("(Overflowed internal boot id table by %d entries\n"
286 "- please increase CONFIG_BOOTSTAGE_USER_COUNT\n",
287 next_id - BOOTSTAGE_ID_COUNT);
289 puts("\nAccumulated time:\n");
290 for (id = 0, rec = record; id < BOOTSTAGE_ID_COUNT; id++, rec++) {
292 prev = print_time_record(id, rec, -1);
296 ulong __timer_get_boot_us(void)
298 static ulong base_time;
301 * We can't implement this properly. Return 0 on the first call and
302 * larger values after that.
305 return get_timer(base_time) * 1000;
306 base_time = get_timer(0);
310 ulong timer_get_boot_us(void)
311 __attribute__((weak, alias("__timer_get_boot_us")));
314 * Append data to a memory buffer
316 * Write data to the buffer if there is space. Whether there is space or not,
317 * the buffer pointer is incremented.
319 * @param ptrp Pointer to buffer, updated by this function
320 * @param end Pointer to end of buffer
321 * @param data Data to write to buffer
322 * @param size Size of data
324 static void append_data(char **ptrp, char *end, const void *data, int size)
332 memcpy(ptr, data, size);
335 int bootstage_stash(void *base, int size)
337 struct bootstage_hdr *hdr = (struct bootstage_hdr *)base;
338 struct bootstage_record *rec;
340 char *ptr = base, *end = ptr + size;
344 if (hdr + 1 > (struct bootstage_hdr *)end) {
345 debug("%s: Not enough space for bootstage hdr\n", __func__);
349 /* Write an arbitrary version number */
350 hdr->version = BOOTSTAGE_VERSION;
352 /* Count the number of records, and write that value first */
353 for (rec = record, id = count = 0; id < BOOTSTAGE_ID_COUNT;
355 if (rec->time_us != 0)
360 hdr->magic = BOOTSTAGE_MAGIC;
363 /* Write the records, silently stopping when we run out of space */
364 for (rec = record, id = 0; id < BOOTSTAGE_ID_COUNT; id++, rec++) {
365 if (rec->time_us != 0)
366 append_data(&ptr, end, rec, sizeof(*rec));
369 /* Write the name strings */
370 for (rec = record, id = 0; id < BOOTSTAGE_ID_COUNT; id++, rec++) {
371 if (rec->time_us != 0) {
374 name = get_record_name(buf, sizeof(buf), rec);
375 append_data(&ptr, end, name, strlen(name) + 1);
379 /* Check for buffer overflow */
381 debug("%s: Not enough space for bootstage stash\n", __func__);
385 /* Update total data size */
386 hdr->size = ptr - (char *)base;
387 printf("Stashed %d records\n", hdr->count);
392 int bootstage_unstash(void *base, int size)
394 struct bootstage_hdr *hdr = (struct bootstage_hdr *)base;
395 struct bootstage_record *rec;
396 char *ptr = base, *end = ptr + size;
401 end = (char *)(~(uintptr_t)0);
403 if (hdr + 1 > (struct bootstage_hdr *)end) {
404 debug("%s: Not enough space for bootstage hdr\n", __func__);
408 if (hdr->magic != BOOTSTAGE_MAGIC) {
409 debug("%s: Invalid bootstage magic\n", __func__);
413 if (ptr + hdr->size > end) {
414 debug("%s: Bootstage data runs past buffer end\n", __func__);
418 if (hdr->count * sizeof(*rec) > hdr->size) {
419 debug("%s: Bootstage has %d records needing %d bytes, but "
420 "only %d bytes is available\n", __func__, hdr->count,
421 hdr->count * sizeof(*rec), hdr->size);
425 if (hdr->version != BOOTSTAGE_VERSION) {
426 debug("%s: Bootstage data version %#0x unrecognised\n",
427 __func__, hdr->version);
431 if (next_id + hdr->count > BOOTSTAGE_ID_COUNT) {
432 debug("%s: Bootstage has %d records, we have space for %d\n"
433 "- please increase CONFIG_BOOTSTAGE_USER_COUNT\n",
434 __func__, hdr->count, BOOTSTAGE_ID_COUNT - next_id);
440 /* Read the records */
441 rec_size = hdr->count * sizeof(*record);
442 memcpy(record + next_id, ptr, rec_size);
444 /* Read the name strings */
446 for (rec = record + next_id, id = 0; id < hdr->count; id++, rec++) {
449 /* Assume no data corruption here */
450 ptr += strlen(ptr) + 1;
453 /* Mark the records as read */
454 next_id += hdr->count;
455 printf("Unstashed %d records\n", hdr->count);