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.
6 * Copyright (c) 2011 The Chromium OS Authors.
8 * SPDX-License-Identifier: GPL-2.0+
14 /* Define this for host tools */
15 #ifndef CONFIG_BOOTSTAGE_USER_COUNT
16 #define CONFIG_BOOTSTAGE_USER_COUNT 20
19 /* Flags for each bootstage record */
20 enum bootstage_flags {
21 BOOTSTAGEF_ERROR = 1 << 0, /* Error record */
22 BOOTSTAGEF_ALLOC = 1 << 1, /* Allocate an id */
25 /* bootstate sub-IDs used for kernel and ramdisk ranges */
28 BOOTSTAGE_SUB_FORMAT_OK,
29 BOOTSTAGE_SUB_NO_UNIT_NAME,
30 BOOTSTAGE_SUB_UNIT_NAME,
31 BOOTSTAGE_SUB_SUBNODE,
34 BOOTSTAGE_SUB_HASH = 5,
35 BOOTSTAGE_SUB_CHECK_ARCH = 5,
36 BOOTSTAGE_SUB_CHECK_ALL,
37 BOOTSTAGE_SUB_GET_DATA,
38 BOOTSTAGE_SUB_CHECK_ALL_OK = 7,
39 BOOTSTAGE_SUB_GET_DATA_OK,
44 * A list of boot stages that we know about. Each of these indicates the
45 * state that we are at, and the action that we are about to perform. For
46 * errors, we issue an error for an item when it fails. Therefore the
53 * and an error condition where action 3 failed would be:
61 BOOTSTAGE_ID_START = 0,
62 BOOTSTAGE_ID_CHECK_MAGIC, /* Checking image magic */
63 BOOTSTAGE_ID_CHECK_HEADER, /* Checking image header */
64 BOOTSTAGE_ID_CHECK_CHECKSUM, /* Checking image checksum */
65 BOOTSTAGE_ID_CHECK_ARCH, /* Checking architecture */
67 BOOTSTAGE_ID_CHECK_IMAGETYPE = 5,/* Checking image type */
68 BOOTSTAGE_ID_DECOMP_IMAGE, /* Decompressing image */
69 BOOTSTAGE_ID_KERNEL_LOADED, /* Kernel has been loaded */
70 BOOTSTAGE_ID_DECOMP_UNIMPL = 7, /* Odd decompression algorithm */
71 BOOTSTAGE_ID_CHECK_BOOT_OS, /* Calling OS-specific boot function */
72 BOOTSTAGE_ID_BOOT_OS_RETURNED, /* Tried to boot OS, but it returned */
73 BOOTSTAGE_ID_CHECK_RAMDISK = 9, /* Checking ram disk */
75 BOOTSTAGE_ID_RD_MAGIC, /* Checking ram disk magic */
76 BOOTSTAGE_ID_RD_HDR_CHECKSUM, /* Checking ram disk heder checksum */
77 BOOTSTAGE_ID_RD_CHECKSUM, /* Checking ram disk checksum */
78 BOOTSTAGE_ID_COPY_RAMDISK = 12, /* Copying ram disk into place */
79 BOOTSTAGE_ID_RAMDISK, /* Checking for valid ramdisk */
80 BOOTSTAGE_ID_NO_RAMDISK, /* No ram disk found (not an error) */
82 BOOTSTAGE_ID_RUN_OS = 15, /* Exiting U-Boot, entering OS */
84 BOOTSTAGE_ID_NEED_RESET = 30,
85 BOOTSTAGE_ID_POST_FAIL, /* Post failure */
86 BOOTSTAGE_ID_POST_FAIL_R, /* Post failure reported after reloc */
89 * This set is reported only by x86, and the meaning is different. In
90 * this case we are reporting completion of a particular stage.
91 * This should probably change in the x86 code (which doesn't report
92 * errors in any case), but discussion this can perhaps wait until we
93 * have a generic board implementation.
95 BOOTSTAGE_ID_BOARD_INIT_R, /* We have relocated */
96 BOOTSTAGE_ID_BOARD_GLOBAL_DATA, /* Global data is set up */
98 BOOTSTAGE_ID_BOARD_INIT_SEQ, /* We completed the init sequence */
99 BOOTSTAGE_ID_BOARD_FLASH, /* We have configured flash banks */
100 BOOTSTAGE_ID_BOARD_FLASH_37, /* In case you didn't hear... */
101 BOOTSTAGE_ID_BOARD_ENV, /* Environment is relocated & ready */
102 BOOTSTAGE_ID_BOARD_PCI, /* PCI is up */
104 BOOTSTAGE_ID_BOARD_INTERRUPTS, /* Exceptions / interrupts ready */
105 BOOTSTAGE_ID_BOARD_DONE, /* Board init done, off to main loop */
106 /* ^^^ here ends the x86 sequence */
108 /* Boot stages related to loading a kernel from an IDE device */
109 BOOTSTAGE_ID_IDE_START = 41,
110 BOOTSTAGE_ID_IDE_ADDR,
111 BOOTSTAGE_ID_IDE_BOOT_DEVICE,
112 BOOTSTAGE_ID_IDE_TYPE,
114 BOOTSTAGE_ID_IDE_PART,
115 BOOTSTAGE_ID_IDE_PART_INFO,
116 BOOTSTAGE_ID_IDE_PART_TYPE,
117 BOOTSTAGE_ID_IDE_PART_READ,
118 BOOTSTAGE_ID_IDE_FORMAT,
120 BOOTSTAGE_ID_IDE_CHECKSUM, /* 50 */
121 BOOTSTAGE_ID_IDE_READ,
123 /* Boot stages related to loading a kernel from an NAND device */
124 BOOTSTAGE_ID_NAND_PART,
125 BOOTSTAGE_ID_NAND_SUFFIX,
126 BOOTSTAGE_ID_NAND_BOOT_DEVICE,
127 BOOTSTAGE_ID_NAND_HDR_READ = 55,
128 BOOTSTAGE_ID_NAND_AVAILABLE = 55,
129 BOOTSTAGE_ID_NAND_TYPE = 57,
130 BOOTSTAGE_ID_NAND_READ,
132 /* Boot stages related to loading a kernel from an network device */
133 BOOTSTAGE_ID_NET_CHECKSUM = 60,
134 BOOTSTAGE_ID_NET_ETH_START = 64,
135 BOOTSTAGE_ID_NET_ETH_INIT,
137 BOOTSTAGE_ID_NET_START = 80,
138 BOOTSTAGE_ID_NET_NETLOOP_OK,
139 BOOTSTAGE_ID_NET_LOADED,
140 BOOTSTAGE_ID_NET_DONE_ERR,
141 BOOTSTAGE_ID_NET_DONE,
143 BOOTSTAGE_ID_FIT_FDT_START = 90,
145 * Boot stages related to loading a FIT image. Some of these are a
148 BOOTSTAGE_ID_FIT_KERNEL_START = 100,
150 BOOTSTAGE_ID_FIT_CONFIG = 110,
151 BOOTSTAGE_ID_FIT_TYPE,
152 BOOTSTAGE_ID_FIT_KERNEL_INFO,
154 BOOTSTAGE_ID_FIT_COMPRESSION,
156 BOOTSTAGE_ID_FIT_LOADADDR,
157 BOOTSTAGE_ID_OVERWRITTEN,
159 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
160 BOOTSTAGE_ID_FIT_RD_START = 120, /* Ramdisk stages */
162 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
163 BOOTSTAGE_ID_FIT_SETUP_START = 130, /* x86 setup stages */
165 BOOTSTAGE_ID_IDE_FIT_READ = 140,
166 BOOTSTAGE_ID_IDE_FIT_READ_OK,
168 BOOTSTAGE_ID_NAND_FIT_READ = 150,
169 BOOTSTAGE_ID_NAND_FIT_READ_OK,
172 * These boot stages are new, higher level, and not directly related
173 * to the old boot progress numbers. They are useful for recording
174 * rough boot timing information.
177 BOOTSTAGE_ID_START_SPL,
178 BOOTSTAGE_ID_START_UBOOT_F,
179 BOOTSTAGE_ID_START_UBOOT_R,
180 BOOTSTAGE_ID_USB_START,
181 BOOTSTAGE_ID_ETH_START,
182 BOOTSTAGE_ID_BOOTP_START,
183 BOOTSTAGE_ID_BOOTP_STOP,
184 BOOTSTAGE_ID_BOOTM_START,
185 BOOTSTAGE_ID_BOOTM_HANDOFF,
186 BOOTSTAGE_ID_MAIN_LOOP,
187 BOOTSTAGE_KERNELREAD_START,
188 BOOTSTAGE_KERNELREAD_STOP,
189 BOOTSTAGE_ID_BOARD_INIT,
190 BOOTSTAGE_ID_BOARD_INIT_DONE,
192 BOOTSTAGE_ID_CPU_AWAKE,
193 BOOTSTAGE_ID_MAIN_CPU_AWAKE,
194 BOOTSTAGE_ID_MAIN_CPU_READY,
196 BOOTSTAGE_ID_ACCUM_LCD,
197 BOOTSTAGE_ID_ACCUM_SCSI,
198 BOOTSTAGE_ID_ACCUM_SPI,
199 BOOTSTAGE_ID_ACCUM_DECOMP,
201 /* a few spare for the user, from here */
203 BOOTSTAGE_ID_COUNT = BOOTSTAGE_ID_USER + CONFIG_BOOTSTAGE_USER_COUNT,
208 * Return the time since boot in microseconds, This is needed for bootstage
209 * and should be defined in CPU- or board-specific code. If undefined then
210 * millisecond resolution will be used (the standard get_timer()).
212 ulong timer_get_boot_us(void);
214 #if !defined(CONFIG_SPL_BUILD) && !defined(USE_HOSTCC)
216 * Board code can implement show_boot_progress() if needed.
218 * @param val Progress state (enum bootstage_id), or -id if an error
221 void show_boot_progress(int val);
223 #define show_boot_progress(val) do {} while (0)
226 #if defined(CONFIG_BOOTSTAGE) && !defined(CONFIG_SPL_BUILD) && \
228 /* This is the full bootstage implementation */
231 * Relocate existing bootstage records
233 * Call this after relocation has happened and after malloc has been initted.
234 * We need to copy any pointers in bootstage records that were added pre-
235 * relocation, since memory can be overritten later.
236 * @return Always returns 0, to indicate success
238 int bootstage_relocate(void);
241 * Add a new bootstage record
243 * @param id Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC)
244 * @param name Name of record, or NULL for none
245 * @param flags Flags (BOOTSTAGEF_...)
246 * @param mark Time to record in this record, in microseconds
248 ulong bootstage_add_record(enum bootstage_id id, const char *name,
249 int flags, ulong mark);
252 * Mark a time stamp for the current boot stage.
254 ulong bootstage_mark(enum bootstage_id id);
256 ulong bootstage_error(enum bootstage_id id);
258 ulong bootstage_mark_name(enum bootstage_id id, const char *name);
261 * Mark a time stamp in the given function and line number
263 * See BOOTSTAGE_MARKER() for a convenient macro.
265 * @param file Filename to record (NULL if none)
266 * @param func Function name to record
267 * @param linenum Line number to record
268 * @return recorded time stamp
270 ulong bootstage_mark_code(const char *file, const char *func,
274 * Mark the start of a bootstage activity. The end will be marked later with
275 * bootstage_accum() and at that point we accumulate the time taken. Calling
276 * this function turns the given id into a accumulator rather than and
277 * absolute mark in time. Accumulators record the total amount of time spent
278 * in an activty during boot.
280 * @param id Bootstage id to record this timestamp against
281 * @param name Textual name to display for this id in the report (maybe NULL)
282 * @return start timestamp in microseconds
284 uint32_t bootstage_start(enum bootstage_id id, const char *name);
287 * Mark the end of a bootstage activity
289 * After previously marking the start of an activity with bootstage_start(),
290 * call this function to mark the end. You can call these functions in pairs
291 * as many times as you like.
293 * @param id Bootstage id to record this timestamp against
294 * @return time spent in this iteration of the activity (i.e. the time now
295 * less the start time recorded in the last bootstage_start() call
298 uint32_t bootstage_accum(enum bootstage_id id);
300 /* Print a report about boot time */
301 void bootstage_report(void);
304 * Add bootstage information to the device tree
306 * @return 0 if ok, -ve on error
308 int bootstage_fdt_add_report(void);
311 * Stash bootstage data into memory
313 * @param base Base address of memory buffer
314 * @param size Size of memory buffer
315 * @return 0 if stashed ok, -1 if out of space
317 int bootstage_stash(void *base, int size);
320 * Read bootstage data from memory
322 * Bootstage data is read from memory and placed in the bootstage table
323 * in the user records.
325 * @param base Base address of memory buffer
326 * @param size Size of memory buffer (-1 if unknown)
327 * @return 0 if unstashed ok, -1 if bootstage info not found, or out of space
329 int bootstage_unstash(void *base, int size);
332 static inline ulong bootstage_add_record(enum bootstage_id id,
333 const char *name, int flags, ulong mark)
339 * This is a dummy implementation which just calls show_boot_progress(),
340 * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
343 static inline int bootstage_relocate(void)
348 static inline ulong bootstage_mark(enum bootstage_id id)
350 show_boot_progress(id);
354 static inline ulong bootstage_error(enum bootstage_id id)
356 show_boot_progress(-id);
360 static inline ulong bootstage_mark_name(enum bootstage_id id, const char *name)
362 show_boot_progress(id);
366 static inline ulong bootstage_mark_code(const char *file, const char *func,
372 static inline uint32_t bootstage_start(enum bootstage_id id, const char *name)
377 static inline uint32_t bootstage_accum(enum bootstage_id id)
382 static inline int bootstage_stash(void *base, int size)
384 return 0; /* Pretend to succeed */
387 static inline int bootstage_unstash(void *base, int size)
389 return 0; /* Pretend to succeed */
391 #endif /* CONFIG_BOOTSTAGE */
393 /* Helper macro for adding a bootstage to a line of code */
394 #define BOOTSTAGE_MARKER() \
395 bootstage_mark_code(__FILE__, __func__, __LINE__)