2 * This file implements recording of each stage of the boot process. It is
3 * intended to implement timing of each stage, reporting this information
4 * to the user and passing it to the OS for logging / further analysis.
5 * Note that it requires timer_get_boot_us() to be defined by the board
7 * Copyright (c) 2011 The Chromium OS Authors.
9 * SPDX-License-Identifier: GPL-2.0+
15 /* Define this for host tools */
16 #ifndef CONFIG_BOOTSTAGE_USER_COUNT
17 #define CONFIG_BOOTSTAGE_USER_COUNT 20
20 /* Flags for each bootstage record */
21 enum bootstage_flags {
22 BOOTSTAGEF_ERROR = 1 << 0, /* Error record */
23 BOOTSTAGEF_ALLOC = 1 << 1, /* Allocate an id */
26 /* bootstate sub-IDs used for kernel and ramdisk ranges */
29 BOOTSTAGE_SUB_FORMAT_OK,
30 BOOTSTAGE_SUB_NO_UNIT_NAME,
31 BOOTSTAGE_SUB_UNIT_NAME,
32 BOOTSTAGE_SUB_SUBNODE,
35 BOOTSTAGE_SUB_HASH = 5,
36 BOOTSTAGE_SUB_CHECK_ARCH = 5,
37 BOOTSTAGE_SUB_CHECK_ALL,
38 BOOTSTAGE_SUB_GET_DATA,
39 BOOTSTAGE_SUB_CHECK_ALL_OK = 7,
40 BOOTSTAGE_SUB_GET_DATA_OK,
45 * A list of boot stages that we know about. Each of these indicates the
46 * state that we are at, and the action that we are about to perform. For
47 * errors, we issue an error for an item when it fails. Therefore the
54 * and an error condition where action 3 failed would be:
62 BOOTSTAGE_ID_START = 0,
63 BOOTSTAGE_ID_CHECK_MAGIC, /* Checking image magic */
64 BOOTSTAGE_ID_CHECK_HEADER, /* Checking image header */
65 BOOTSTAGE_ID_CHECK_CHECKSUM, /* Checking image checksum */
66 BOOTSTAGE_ID_CHECK_ARCH, /* Checking architecture */
68 BOOTSTAGE_ID_CHECK_IMAGETYPE = 5,/* Checking image type */
69 BOOTSTAGE_ID_DECOMP_IMAGE, /* Decompressing image */
70 BOOTSTAGE_ID_KERNEL_LOADED, /* Kernel has been loaded */
71 BOOTSTAGE_ID_DECOMP_UNIMPL = 7, /* Odd decompression algorithm */
72 BOOTSTAGE_ID_CHECK_BOOT_OS, /* Calling OS-specific boot function */
73 BOOTSTAGE_ID_BOOT_OS_RETURNED, /* Tried to boot OS, but it returned */
74 BOOTSTAGE_ID_CHECK_RAMDISK = 9, /* Checking ram disk */
76 BOOTSTAGE_ID_RD_MAGIC, /* Checking ram disk magic */
77 BOOTSTAGE_ID_RD_HDR_CHECKSUM, /* Checking ram disk heder checksum */
78 BOOTSTAGE_ID_RD_CHECKSUM, /* Checking ram disk checksum */
79 BOOTSTAGE_ID_COPY_RAMDISK = 12, /* Copying ram disk into place */
80 BOOTSTAGE_ID_RAMDISK, /* Checking for valid ramdisk */
81 BOOTSTAGE_ID_NO_RAMDISK, /* No ram disk found (not an error) */
83 BOOTSTAGE_ID_RUN_OS = 15, /* Exiting U-Boot, entering OS */
85 BOOTSTAGE_ID_NEED_RESET = 30,
86 BOOTSTAGE_ID_POST_FAIL, /* Post failure */
87 BOOTSTAGE_ID_POST_FAIL_R, /* Post failure reported after reloc */
90 * This set is reported only by x86, and the meaning is different. In
91 * this case we are reporting completion of a particular stage.
92 * This should probably change in the x86 code (which doesn't report
93 * errors in any case), but discussion this can perhaps wait until we
94 * have a generic board implementation.
96 BOOTSTAGE_ID_BOARD_INIT_R, /* We have relocated */
97 BOOTSTAGE_ID_BOARD_GLOBAL_DATA, /* Global data is set up */
99 BOOTSTAGE_ID_BOARD_INIT_SEQ, /* We completed the init sequence */
100 BOOTSTAGE_ID_BOARD_FLASH, /* We have configured flash banks */
101 BOOTSTAGE_ID_BOARD_FLASH_37, /* In case you didn't hear... */
102 BOOTSTAGE_ID_BOARD_ENV, /* Environment is relocated & ready */
103 BOOTSTAGE_ID_BOARD_PCI, /* PCI is up */
105 BOOTSTAGE_ID_BOARD_INTERRUPTS, /* Exceptions / interrupts ready */
106 BOOTSTAGE_ID_BOARD_DONE, /* Board init done, off to main loop */
107 /* ^^^ here ends the x86 sequence */
109 /* Boot stages related to loading a kernel from an IDE device */
110 BOOTSTAGE_ID_IDE_START = 41,
111 BOOTSTAGE_ID_IDE_ADDR,
112 BOOTSTAGE_ID_IDE_BOOT_DEVICE,
113 BOOTSTAGE_ID_IDE_TYPE,
115 BOOTSTAGE_ID_IDE_PART,
116 BOOTSTAGE_ID_IDE_PART_INFO,
117 BOOTSTAGE_ID_IDE_PART_TYPE,
118 BOOTSTAGE_ID_IDE_PART_READ,
119 BOOTSTAGE_ID_IDE_FORMAT,
121 BOOTSTAGE_ID_IDE_CHECKSUM, /* 50 */
122 BOOTSTAGE_ID_IDE_READ,
124 /* Boot stages related to loading a kernel from an NAND device */
125 BOOTSTAGE_ID_NAND_PART,
126 BOOTSTAGE_ID_NAND_SUFFIX,
127 BOOTSTAGE_ID_NAND_BOOT_DEVICE,
128 BOOTSTAGE_ID_NAND_HDR_READ = 55,
129 BOOTSTAGE_ID_NAND_AVAILABLE = 55,
130 BOOTSTAGE_ID_NAND_TYPE = 57,
131 BOOTSTAGE_ID_NAND_READ,
133 /* Boot stages related to loading a kernel from an network device */
134 BOOTSTAGE_ID_NET_CHECKSUM = 60,
135 BOOTSTAGE_ID_NET_ETH_START = 64,
136 BOOTSTAGE_ID_NET_ETH_INIT,
138 BOOTSTAGE_ID_NET_START = 80,
139 BOOTSTAGE_ID_NET_NETLOOP_OK,
140 BOOTSTAGE_ID_NET_LOADED,
141 BOOTSTAGE_ID_NET_DONE_ERR,
142 BOOTSTAGE_ID_NET_DONE,
144 BOOTSTAGE_ID_FIT_FDT_START = 90,
146 * Boot stages related to loading a FIT image. Some of these are a
149 BOOTSTAGE_ID_FIT_KERNEL_START = 100,
151 BOOTSTAGE_ID_FIT_CONFIG = 110,
152 BOOTSTAGE_ID_FIT_TYPE,
153 BOOTSTAGE_ID_FIT_KERNEL_INFO,
155 BOOTSTAGE_ID_FIT_COMPRESSION,
157 BOOTSTAGE_ID_FIT_LOADADDR,
158 BOOTSTAGE_ID_OVERWRITTEN,
160 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
161 BOOTSTAGE_ID_FIT_RD_START = 120, /* Ramdisk stages */
163 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
164 BOOTSTAGE_ID_FIT_SETUP_START = 130, /* x86 setup stages */
166 BOOTSTAGE_ID_IDE_FIT_READ = 140,
167 BOOTSTAGE_ID_IDE_FIT_READ_OK,
169 BOOTSTAGE_ID_NAND_FIT_READ = 150,
170 BOOTSTAGE_ID_NAND_FIT_READ_OK,
172 BOOTSTAGE_ID_FIT_LOADABLE_START = 160, /* for Loadable Images */
174 * These boot stages are new, higher level, and not directly related
175 * to the old boot progress numbers. They are useful for recording
176 * rough boot timing information.
179 BOOTSTAGE_ID_START_SPL,
180 BOOTSTAGE_ID_END_SPL,
181 BOOTSTAGE_ID_START_UBOOT_F,
182 BOOTSTAGE_ID_START_UBOOT_R,
183 BOOTSTAGE_ID_USB_START,
184 BOOTSTAGE_ID_ETH_START,
185 BOOTSTAGE_ID_BOOTP_START,
186 BOOTSTAGE_ID_BOOTP_STOP,
187 BOOTSTAGE_ID_BOOTM_START,
188 BOOTSTAGE_ID_BOOTM_HANDOFF,
189 BOOTSTAGE_ID_MAIN_LOOP,
190 BOOTSTAGE_KERNELREAD_START,
191 BOOTSTAGE_KERNELREAD_STOP,
192 BOOTSTAGE_ID_BOARD_INIT,
193 BOOTSTAGE_ID_BOARD_INIT_DONE,
195 BOOTSTAGE_ID_CPU_AWAKE,
196 BOOTSTAGE_ID_MAIN_CPU_AWAKE,
197 BOOTSTAGE_ID_MAIN_CPU_READY,
199 BOOTSTAGE_ID_ACCUM_LCD,
200 BOOTSTAGE_ID_ACCUM_SCSI,
201 BOOTSTAGE_ID_ACCUM_SPI,
202 BOOTSTAGE_ID_ACCUM_DECOMP,
203 BOOTSTAGE_ID_ACCUM_OF_LIVE,
204 BOOTSTAGE_ID_FPGA_INIT,
205 BOOTSTATE_ID_ACCUM_DM_SPL,
206 BOOTSTATE_ID_ACCUM_DM_F,
207 BOOTSTATE_ID_ACCUM_DM_R,
209 /* a few spare for the user, from here */
211 BOOTSTAGE_ID_COUNT = BOOTSTAGE_ID_USER + CONFIG_BOOTSTAGE_USER_COUNT,
216 * Return the time since boot in microseconds, This is needed for bootstage
217 * and should be defined in CPU- or board-specific code. If undefined then
218 * you will get a link error.
220 ulong timer_get_boot_us(void);
222 #if defined(USE_HOSTCC)
223 #define show_boot_progress(val) do {} while (0)
226 * Board code can implement show_boot_progress() if needed.
228 * @param val Progress state (enum bootstage_id), or -id if an error
231 void show_boot_progress(int val);
234 #if !defined(USE_HOSTCC)
235 #if CONFIG_IS_ENABLED(BOOTSTAGE)
236 #define ENABLE_BOOTSTAGE
240 #ifdef ENABLE_BOOTSTAGE
242 /* This is the full bootstage implementation */
245 * Relocate existing bootstage records
247 * Call this after relocation has happened and after malloc has been initted.
248 * We need to copy any pointers in bootstage records that were added pre-
249 * relocation, since memory can be overwritten later.
250 * @return Always returns 0, to indicate success
252 int bootstage_relocate(void);
255 * Add a new bootstage record
257 * @param id Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC)
258 * @param name Name of record, or NULL for none
259 * @param flags Flags (BOOTSTAGEF_...)
260 * @param mark Time to record in this record, in microseconds
262 ulong bootstage_add_record(enum bootstage_id id, const char *name,
263 int flags, ulong mark);
266 * Mark a time stamp for the current boot stage.
268 ulong bootstage_mark(enum bootstage_id id);
270 ulong bootstage_error(enum bootstage_id id);
272 ulong bootstage_mark_name(enum bootstage_id id, const char *name);
275 * Mark a time stamp in the given function and line number
277 * See BOOTSTAGE_MARKER() for a convenient macro.
279 * @param file Filename to record (NULL if none)
280 * @param func Function name to record
281 * @param linenum Line number to record
282 * @return recorded time stamp
284 ulong bootstage_mark_code(const char *file, const char *func,
288 * Mark the start of a bootstage activity. The end will be marked later with
289 * bootstage_accum() and at that point we accumulate the time taken. Calling
290 * this function turns the given id into a accumulator rather than and
291 * absolute mark in time. Accumulators record the total amount of time spent
292 * in an activty during boot.
294 * @param id Bootstage id to record this timestamp against
295 * @param name Textual name to display for this id in the report (maybe NULL)
296 * @return start timestamp in microseconds
298 uint32_t bootstage_start(enum bootstage_id id, const char *name);
301 * Mark the end of a bootstage activity
303 * After previously marking the start of an activity with bootstage_start(),
304 * call this function to mark the end. You can call these functions in pairs
305 * as many times as you like.
307 * @param id Bootstage id to record this timestamp against
308 * @return time spent in this iteration of the activity (i.e. the time now
309 * less the start time recorded in the last bootstage_start() call
312 uint32_t bootstage_accum(enum bootstage_id id);
314 /* Print a report about boot time */
315 void bootstage_report(void);
318 * Add bootstage information to the device tree
320 * @return 0 if ok, -ve on error
322 int bootstage_fdt_add_report(void);
325 * Stash bootstage data into memory
327 * @param base Base address of memory buffer
328 * @param size Size of memory buffer
329 * @return 0 if stashed ok, -1 if out of space
331 int bootstage_stash(void *base, int size);
334 * Read bootstage data from memory
336 * Bootstage data is read from memory and placed in the bootstage table
337 * in the user records.
339 * @param base Base address of memory buffer
340 * @param size Size of memory buffer (-1 if unknown)
341 * @return 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if
342 * there is not space for read the stacked data, or other error if
343 * something else went wrong
345 int bootstage_unstash(const void *base, int size);
348 * bootstage_get_size() - Get the size of the bootstage data
350 * @return size of boostage data in bytes
352 int bootstage_get_size(void);
355 * bootstage_init() - Prepare bootstage for use
357 * @first: true if this is the first time bootstage is set up. This causes it
358 * to add a 'reset' record with a time of 0.
360 int bootstage_init(bool first);
363 static inline ulong bootstage_add_record(enum bootstage_id id,
364 const char *name, int flags, ulong mark)
370 * This is a dummy implementation which just calls show_boot_progress(),
371 * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
374 static inline int bootstage_relocate(void)
379 static inline ulong bootstage_mark(enum bootstage_id id)
381 show_boot_progress(id);
385 static inline ulong bootstage_error(enum bootstage_id id)
387 show_boot_progress(-id);
391 static inline ulong bootstage_mark_name(enum bootstage_id id, const char *name)
393 show_boot_progress(id);
397 static inline ulong bootstage_mark_code(const char *file, const char *func,
403 static inline uint32_t bootstage_start(enum bootstage_id id, const char *name)
408 static inline uint32_t bootstage_accum(enum bootstage_id id)
413 static inline int bootstage_stash(void *base, int size)
415 return 0; /* Pretend to succeed */
418 static inline int bootstage_unstash(const void *base, int size)
420 return 0; /* Pretend to succeed */
423 static inline int bootstage_get_size(void)
428 static inline int bootstage_init(bool first)
433 #endif /* ENABLE_BOOTSTAGE */
435 /* Helper macro for adding a bootstage to a line of code */
436 #define BOOTSTAGE_MARKER() \
437 bootstage_mark_code(__FILE__, __func__, __LINE__)