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.
7 * See file CREDITS for list of people who contributed to this
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of
13 * the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
29 /* The number of boot stage records available for the user */
30 #ifndef CONFIG_BOOTSTAGE_USER_COUNT
31 #define CONFIG_BOOTSTAGE_USER_COUNT 20
34 /* Flags for each bootstage record */
35 enum bootstage_flags
{
36 BOOTSTAGEF_ERROR
= 1 << 0, /* Error record */
37 BOOTSTAGEF_ALLOC
= 1 << 1, /* Allocate an id */
41 * A list of boot stages that we know about. Each of these indicates the
42 * state that we are at, and the action that we are about to perform. For
43 * errors, we issue an error for an item when it fails. Therefore the
50 * and an error condition where action 3 failed would be:
58 BOOTSTAGE_ID_START
= 0,
59 BOOTSTAGE_ID_CHECK_MAGIC
, /* Checking image magic */
60 BOOTSTAGE_ID_CHECK_HEADER
, /* Checking image header */
61 BOOTSTAGE_ID_CHECK_CHECKSUM
, /* Checking image checksum */
62 BOOTSTAGE_ID_CHECK_ARCH
, /* Checking architecture */
64 BOOTSTAGE_ID_CHECK_IMAGETYPE
= 5,/* Checking image type */
65 BOOTSTAGE_ID_DECOMP_IMAGE
, /* Decompressing image */
66 BOOTSTAGE_ID_KERNEL_LOADED
, /* Kernel has been loaded */
67 BOOTSTAGE_ID_DECOMP_UNIMPL
= 7, /* Odd decompression algorithm */
68 BOOTSTAGE_ID_CHECK_BOOT_OS
, /* Calling OS-specific boot function */
69 BOOTSTAGE_ID_BOOT_OS_RETURNED
, /* Tried to boot OS, but it returned */
70 BOOTSTAGE_ID_CHECK_RAMDISK
= 9, /* Checking ram disk */
72 BOOTSTAGE_ID_RD_MAGIC
, /* Checking ram disk magic */
73 BOOTSTAGE_ID_RD_HDR_CHECKSUM
, /* Checking ram disk heder checksum */
74 BOOTSTAGE_ID_RD_CHECKSUM
, /* Checking ram disk checksum */
75 BOOTSTAGE_ID_COPY_RAMDISK
= 12, /* Copying ram disk into place */
76 BOOTSTAGE_ID_RAMDISK
, /* Checking for valid ramdisk */
77 BOOTSTAGE_ID_NO_RAMDISK
, /* No ram disk found (not an error) */
79 BOOTSTAGE_ID_RUN_OS
= 15, /* Exiting U-Boot, entering OS */
81 BOOTSTAGE_ID_NEED_RESET
= 30,
82 BOOTSTAGE_ID_POST_FAIL
, /* Post failure */
83 BOOTSTAGE_ID_POST_FAIL_R
, /* Post failure reported after reloc */
86 * This set is reported ony by x86, and the meaning is different. In
87 * this case we are reporting completion of a particular stage.
88 * This should probably change in he x86 code (which doesn't report
89 * errors in any case), but discussion this can perhaps wait until we
90 * have a generic board implementation.
92 BOOTSTAGE_ID_BOARD_INIT_R
, /* We have relocated */
93 BOOTSTAGE_ID_BOARD_GLOBAL_DATA
, /* Global data is set up */
95 BOOTSTAGE_ID_BOARD_INIT_SEQ
, /* We completed the init sequence */
96 BOOTSTAGE_ID_BOARD_FLASH
, /* We have configured flash banks */
97 BOOTSTAGE_ID_BOARD_FLASH_37
, /* In case you didn't hear... */
98 BOOTSTAGE_ID_BOARD_ENV
, /* Environment is relocated & ready */
99 BOOTSTAGE_ID_BOARD_PCI
, /* PCI is up */
101 BOOTSTAGE_ID_BOARD_INTERRUPTS
, /* Exceptions / interrupts ready */
102 BOOTSTAGE_ID_BOARD_DONE
, /* Board init done, off to main loop */
103 /* ^^^ here ends the x86 sequence */
105 /* Boot stages related to loading a kernel from an IDE device */
106 BOOTSTAGE_ID_IDE_START
= 41,
107 BOOTSTAGE_ID_IDE_ADDR
,
108 BOOTSTAGE_ID_IDE_BOOT_DEVICE
,
109 BOOTSTAGE_ID_IDE_TYPE
,
111 BOOTSTAGE_ID_IDE_PART
,
112 BOOTSTAGE_ID_IDE_PART_INFO
,
113 BOOTSTAGE_ID_IDE_PART_TYPE
,
114 BOOTSTAGE_ID_IDE_PART_READ
,
115 BOOTSTAGE_ID_IDE_FORMAT
,
117 BOOTSTAGE_ID_IDE_CHECKSUM
, /* 50 */
118 BOOTSTAGE_ID_IDE_READ
,
120 /* Boot stages related to loading a kernel from an NAND device */
121 BOOTSTAGE_ID_NAND_PART
,
122 BOOTSTAGE_ID_NAND_SUFFIX
,
123 BOOTSTAGE_ID_NAND_BOOT_DEVICE
,
124 BOOTSTAGE_ID_NAND_HDR_READ
= 55,
125 BOOTSTAGE_ID_NAND_AVAILABLE
= 55,
126 BOOTSTAGE_ID_NAND_TYPE
= 57,
127 BOOTSTAGE_ID_NAND_READ
,
129 /* Boot stages related to loading a kernel from an network device */
130 BOOTSTAGE_ID_NET_CHECKSUM
= 60,
131 BOOTSTAGE_ID_NET_ETH_START
= 64,
132 BOOTSTAGE_ID_NET_ETH_INIT
,
134 BOOTSTAGE_ID_NET_START
= 80,
135 BOOTSTAGE_ID_NET_NETLOOP_OK
,
136 BOOTSTAGE_ID_NET_LOADED
,
137 BOOTSTAGE_ID_NET_DONE_ERR
,
138 BOOTSTAGE_ID_NET_DONE
,
141 * Boot stages related to loading a FIT image. Some of these are a
144 BOOTSTAGE_ID_FIT_FORMAT
= 100,
145 BOOTSTAGE_ID_FIT_NO_UNIT_NAME
,
146 BOOTSTAGE_ID_FIT_UNIT_NAME
,
147 BOOTSTAGE_ID_FIT_CONFIG
,
148 BOOTSTAGE_ID_FIT_CHECK_SUBIMAGE
,
149 BOOTSTAGE_ID_FIT_CHECK_HASH
= 104,
151 BOOTSTAGE_ID_FIT_CHECK_ARCH
,
152 BOOTSTAGE_ID_FIT_CHECK_KERNEL
,
153 BOOTSTAGE_ID_FIT_CHECKED
,
155 BOOTSTAGE_ID_FIT_KERNEL_INFO_ERR
= 107,
156 BOOTSTAGE_ID_FIT_KERNEL_INFO
,
157 BOOTSTAGE_ID_FIT_TYPE
,
159 BOOTSTAGE_ID_FIT_COMPRESSION
,
161 BOOTSTAGE_ID_FIT_LOADADDR
,
162 BOOTSTAGE_ID_OVERWRITTEN
,
164 BOOTSTAGE_ID_FIT_RD_FORMAT
= 120,
165 BOOTSTAGE_ID_FIT_RD_FORMAT_OK
,
166 BOOTSTAGE_ID_FIT_RD_NO_UNIT_NAME
,
167 BOOTSTAGE_ID_FIT_RD_UNIT_NAME
,
168 BOOTSTAGE_ID_FIT_RD_SUBNODE
,
170 BOOTSTAGE_ID_FIT_RD_CHECK
,
171 BOOTSTAGE_ID_FIT_RD_HASH
= 125,
172 BOOTSTAGE_ID_FIT_RD_CHECK_ALL
,
173 BOOTSTAGE_ID_FIT_RD_GET_DATA
,
174 BOOTSTAGE_ID_FIT_RD_CHECK_ALL_OK
= 127,
175 BOOTSTAGE_ID_FIT_RD_GET_DATA_OK
,
176 BOOTSTAGE_ID_FIT_RD_LOAD
,
178 BOOTSTAGE_ID_IDE_FIT_READ
= 140,
179 BOOTSTAGE_ID_IDE_FIT_READ_OK
,
181 BOOTSTAGE_ID_NAND_FIT_READ
= 150,
182 BOOTSTAGE_ID_NAND_FIT_READ_OK
,
185 * These boot stages are new, higher level, and not directly related
186 * to the old boot progress numbers. They are useful for recording
187 * rough boot timing information.
190 BOOTSTAGE_ID_START_UBOOT_F
,
191 BOOTSTAGE_ID_START_UBOOT_R
,
192 BOOTSTAGE_ID_USB_START
,
193 BOOTSTAGE_ID_ETH_START
,
194 BOOTSTAGE_ID_BOOTP_START
,
195 BOOTSTAGE_ID_BOOTP_STOP
,
196 BOOTSTAGE_ID_BOOTM_START
,
197 BOOTSTAGE_ID_BOOTM_HANDOFF
,
198 BOOTSTAGE_ID_MAIN_LOOP
,
199 BOOTSTAGE_KERNELREAD_START
,
200 BOOTSTAGE_KERNELREAD_STOP
,
202 BOOTSTAGE_ID_CPU_AWAKE
,
203 BOOTSTAGE_ID_MAIN_CPU_AWAKE
,
204 BOOTSTAGE_ID_MAIN_CPU_READY
,
206 /* a few spare for the user, from here */
208 BOOTSTAGE_ID_COUNT
= BOOTSTAGE_ID_USER
+ CONFIG_BOOTSTAGE_USER_COUNT
,
213 * Return the time since boot in microseconds, This is needed for bootstage
214 * and should be defined in CPU- or board-specific code. If undefined then
215 * millisecond resolution will be used (the standard get_timer()).
217 ulong
timer_get_boot_us(void);
220 * Board code can implement show_boot_progress() if needed.
222 * @param val Progress state (enum bootstage_id), or -id if an error
225 void show_boot_progress(int val
);
227 #ifdef CONFIG_BOOTSTAGE
228 /* This is the full bootstage implementation */
231 * Add a new bootstage record
233 * @param id Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC)
234 * @param name Name of record, or NULL for none
235 * @param flags Flags (BOOTSTAGEF_...)
236 * @param mark Time to record in this record, in microseconds
238 ulong
bootstage_add_record(enum bootstage_id id
, const char *name
,
239 int flags
, ulong mark
);
242 * Mark a time stamp for the current boot stage.
244 ulong
bootstage_mark(enum bootstage_id id
);
246 ulong
bootstage_error(enum bootstage_id id
);
248 ulong
bootstage_mark_name(enum bootstage_id id
, const char *name
);
251 * Mark the start of a bootstage activity. The end will be marked later with
252 * bootstage_accum() and at that point we accumulate the time taken. Calling
253 * this function turns the given id into a accumulator rather than and
254 * absolute mark in time. Accumulators record the total amount of time spent
255 * in an activty during boot.
257 * @param id Bootstage id to record this timestamp against
258 * @param name Textual name to display for this id in the report (maybe NULL)
259 * @return start timestamp in microseconds
261 uint32_t bootstage_start(enum bootstage_id id
, const char *name
);
264 * Mark the end of a bootstage activity
266 * After previously marking the start of an activity with bootstage_start(),
267 * call this function to mark the end. You can call these functions in pairs
268 * as many times as you like.
270 * @param id Bootstage id to record this timestamp against
271 * @return time spent in this iteration of the activity (i.e. the time now
272 * less the start time recorded in the last bootstage_start() call
275 uint32_t bootstage_accum(enum bootstage_id id
);
277 /* Print a report about boot time */
278 void bootstage_report(void);
281 * Add bootstage information to the device tree
283 * @return 0 if ok, -ve on error
285 int bootstage_fdt_add_report(void);
288 * Stash bootstage data into memory
290 * @param base Base address of memory buffer
291 * @param size Size of memory buffer
292 * @return 0 if stashed ok, -1 if out of space
294 int bootstage_stash(void *base
, int size
);
297 * Read bootstage data from memory
299 * Bootstage data is read from memory and placed in the bootstage table
300 * in the user records.
302 * @param base Base address of memory buffer
303 * @param size Size of memory buffer (-1 if unknown)
304 * @return 0 if unstashed ok, -1 if bootstage info not found, or out of space
306 int bootstage_unstash(void *base
, int size
);
310 * This is a dummy implementation which just calls show_boot_progress(),
311 * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
314 static inline ulong
bootstage_mark(enum bootstage_id id
)
316 show_boot_progress(id
);
320 static inline ulong
bootstage_error(enum bootstage_id id
)
322 show_boot_progress(-id
);
326 static inline ulong
bootstage_mark_name(enum bootstage_id id
, const char *name
)
331 static inline int bootstage_stash(void *base
, int size
)
333 return 0; /* Pretend to succeed */
336 static inline int bootstage_unstash(void *base
, int size
)
338 return 0; /* Pretend to succeed */
340 #endif /* CONFIG_BOOTSTAGE */