1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3 * This file implements recording of each stage of the boot process. It is
4 * intended to implement timing of each stage, reporting this information
5 * to the user and passing it to the OS for logging / further analysis.
6 * Note that it requires timer_get_boot_us() to be defined by the board
7 *
8 * Copyright (c) 2011 The Chromium OS Authors.
9 */
10
11 #ifndef _BOOTSTAGE_H
12 #define _BOOTSTAGE_H
13
14 /* Flags for each bootstage record */
15 enum bootstage_flags {
16 BOOTSTAGEF_ERROR = 1 << 0, /* Error record */
17 BOOTSTAGEF_ALLOC = 1 << 1, /* Allocate an id */
18 };
19
20 /* bootstate sub-IDs used for kernel and ramdisk ranges */
21 enum {
22 BOOTSTAGE_SUB_FORMAT,
23 BOOTSTAGE_SUB_FORMAT_OK,
24 BOOTSTAGE_SUB_NO_UNIT_NAME,
25 BOOTSTAGE_SUB_UNIT_NAME,
26 BOOTSTAGE_SUB_SUBNODE,
27
28 BOOTSTAGE_SUB_CHECK,
29 BOOTSTAGE_SUB_HASH = 5,
30 BOOTSTAGE_SUB_CHECK_ARCH = 5,
31 BOOTSTAGE_SUB_CHECK_ALL,
32 BOOTSTAGE_SUB_GET_DATA,
33 BOOTSTAGE_SUB_CHECK_ALL_OK = 7,
34 BOOTSTAGE_SUB_GET_DATA_OK,
35 BOOTSTAGE_SUB_LOAD,
36 };
37
38 /*
39 * A list of boot stages that we know about. Each of these indicates the
40 * state that we are at, and the action that we are about to perform. For
41 * errors, we issue an error for an item when it fails. Therefore the
42 * normal sequence is:
43 *
44 * progress action1
45 * progress action2
46 * progress action3
47 *
48 * and an error condition where action 3 failed would be:
49 *
50 * progress action1
51 * progress action2
52 * progress action3
53 * error on action3
54 */
55 enum bootstage_id {
56 BOOTSTAGE_ID_START = 0,
57 BOOTSTAGE_ID_CHECK_MAGIC, /* Checking image magic */
58 BOOTSTAGE_ID_CHECK_HEADER, /* Checking image header */
59 BOOTSTAGE_ID_CHECK_CHECKSUM, /* Checking image checksum */
60 BOOTSTAGE_ID_CHECK_ARCH, /* Checking architecture */
61
62 BOOTSTAGE_ID_CHECK_IMAGETYPE = 5,/* Checking image type */
63 BOOTSTAGE_ID_DECOMP_IMAGE, /* Decompressing image */
64 BOOTSTAGE_ID_KERNEL_LOADED, /* Kernel has been loaded */
65 BOOTSTAGE_ID_DECOMP_UNIMPL = 7, /* Odd decompression algorithm */
66 BOOTSTAGE_ID_CHECK_BOOT_OS, /* Calling OS-specific boot function */
67 BOOTSTAGE_ID_BOOT_OS_RETURNED, /* Tried to boot OS, but it returned */
68 BOOTSTAGE_ID_CHECK_RAMDISK = 9, /* Checking ram disk */
69
70 BOOTSTAGE_ID_RD_MAGIC, /* Checking ram disk magic */
71 BOOTSTAGE_ID_RD_HDR_CHECKSUM, /* Checking ram disk heder checksum */
72 BOOTSTAGE_ID_RD_CHECKSUM, /* Checking ram disk checksum */
73 BOOTSTAGE_ID_COPY_RAMDISK = 12, /* Copying ram disk into place */
74 BOOTSTAGE_ID_RAMDISK, /* Checking for valid ramdisk */
75 BOOTSTAGE_ID_NO_RAMDISK, /* No ram disk found (not an error) */
76
77 BOOTSTAGE_ID_RUN_OS = 15, /* Exiting U-Boot, entering OS */
78
79 BOOTSTAGE_ID_NEED_RESET = 30,
80 BOOTSTAGE_ID_POST_FAIL, /* Post failure */
81 BOOTSTAGE_ID_POST_FAIL_R, /* Post failure reported after reloc */
82
83 /*
84 * This set is reported only by x86, and the meaning is different. In
85 * this case we are reporting completion of a particular stage.
86 * This should probably change in the x86 code (which doesn't report
87 * errors in any case), but discussion this can perhaps wait until we
88 * have a generic board implementation.
89 */
90 BOOTSTAGE_ID_BOARD_INIT_R, /* We have relocated */
91 BOOTSTAGE_ID_BOARD_GLOBAL_DATA, /* Global data is set up */
92
93 BOOTSTAGE_ID_BOARD_INIT_SEQ, /* We completed the init sequence */
94 BOOTSTAGE_ID_BOARD_FLASH, /* We have configured flash banks */
95 BOOTSTAGE_ID_BOARD_FLASH_37, /* In case you didn't hear... */
96 BOOTSTAGE_ID_BOARD_ENV, /* Environment is relocated & ready */
97 BOOTSTAGE_ID_BOARD_PCI, /* PCI is up */
98
99 BOOTSTAGE_ID_BOARD_INTERRUPTS, /* Exceptions / interrupts ready */
100 BOOTSTAGE_ID_BOARD_DONE, /* Board init done, off to main loop */
101 /* ^^^ here ends the x86 sequence */
102
103 /* Boot stages related to loading a kernel from an IDE device */
104 BOOTSTAGE_ID_IDE_START = 41,
105 BOOTSTAGE_ID_IDE_ADDR,
106 BOOTSTAGE_ID_IDE_BOOT_DEVICE,
107 BOOTSTAGE_ID_IDE_TYPE,
108
109 BOOTSTAGE_ID_IDE_PART,
110 BOOTSTAGE_ID_IDE_PART_INFO,
111 BOOTSTAGE_ID_IDE_PART_TYPE,
112 BOOTSTAGE_ID_IDE_PART_READ,
113 BOOTSTAGE_ID_IDE_FORMAT,
114
115 BOOTSTAGE_ID_IDE_CHECKSUM, /* 50 */
116 BOOTSTAGE_ID_IDE_READ,
117
118 /* Boot stages related to loading a kernel from an NAND device */
119 BOOTSTAGE_ID_NAND_PART,
120 BOOTSTAGE_ID_NAND_SUFFIX,
121 BOOTSTAGE_ID_NAND_BOOT_DEVICE,
122 BOOTSTAGE_ID_NAND_HDR_READ = 55,
123 BOOTSTAGE_ID_NAND_AVAILABLE = 55,
124 BOOTSTAGE_ID_NAND_TYPE = 57,
125 BOOTSTAGE_ID_NAND_READ,
126
127 /* Boot stages related to loading a kernel from an network device */
128 BOOTSTAGE_ID_NET_CHECKSUM = 60,
129 BOOTSTAGE_ID_NET_ETH_START = 64,
130 BOOTSTAGE_ID_NET_ETH_INIT,
131
132 BOOTSTAGE_ID_NET_START = 80,
133 BOOTSTAGE_ID_NET_NETLOOP_OK,
134 BOOTSTAGE_ID_NET_LOADED,
135 BOOTSTAGE_ID_NET_DONE_ERR,
136 BOOTSTAGE_ID_NET_DONE,
137
138 BOOTSTAGE_ID_FIT_FDT_START = 90,
139 /*
140 * Boot stages related to loading a FIT image. Some of these are a
141 * bit wonky.
142 */
143 BOOTSTAGE_ID_FIT_KERNEL_START = 100,
144
145 BOOTSTAGE_ID_FIT_CONFIG = 110,
146 BOOTSTAGE_ID_FIT_TYPE,
147 BOOTSTAGE_ID_FIT_KERNEL_INFO,
148
149 BOOTSTAGE_ID_FIT_COMPRESSION,
150 BOOTSTAGE_ID_FIT_OS,
151 BOOTSTAGE_ID_FIT_LOADADDR,
152 BOOTSTAGE_ID_OVERWRITTEN,
153
154 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
155 BOOTSTAGE_ID_FIT_RD_START = 120, /* Ramdisk stages */
156
157 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
158 BOOTSTAGE_ID_FIT_SETUP_START = 130, /* x86 setup stages */
159
160 BOOTSTAGE_ID_IDE_FIT_READ = 140,
161 BOOTSTAGE_ID_IDE_FIT_READ_OK,
162
163 BOOTSTAGE_ID_NAND_FIT_READ = 150,
164 BOOTSTAGE_ID_NAND_FIT_READ_OK,
165
166 BOOTSTAGE_ID_FIT_LOADABLE_START = 160, /* for Loadable Images */
167 /*
168 * These boot stages are new, higher level, and not directly related
169 * to the old boot progress numbers. They are useful for recording
170 * rough boot timing information.
171 */
172 BOOTSTAGE_ID_AWAKE,
173 BOOTSTAGE_ID_START_TPL,
174 BOOTSTAGE_ID_END_TPL,
175 BOOTSTAGE_ID_START_SPL,
176 BOOTSTAGE_ID_END_SPL,
177 BOOTSTAGE_ID_START_UBOOT_F,
178 BOOTSTAGE_ID_START_UBOOT_R,
179 BOOTSTAGE_ID_USB_START,
180 BOOTSTAGE_ID_ETH_START,
181 BOOTSTAGE_ID_BOOTP_START,
182 BOOTSTAGE_ID_BOOTP_STOP,
183 BOOTSTAGE_ID_BOOTM_START,
184 BOOTSTAGE_ID_BOOTM_HANDOFF,
185 BOOTSTAGE_ID_MAIN_LOOP,
186 BOOTSTAGE_ID_ENTER_CLI_LOOP,
187 BOOTSTAGE_KERNELREAD_START,
188 BOOTSTAGE_KERNELREAD_STOP,
189 BOOTSTAGE_ID_BOARD_INIT,
190 BOOTSTAGE_ID_BOARD_INIT_DONE,
191
192 BOOTSTAGE_ID_CPU_AWAKE,
193 BOOTSTAGE_ID_MAIN_CPU_AWAKE,
194 BOOTSTAGE_ID_MAIN_CPU_READY,
195
196 BOOTSTAGE_ID_ACCUM_LCD,
197 BOOTSTAGE_ID_ACCUM_SCSI,
198 BOOTSTAGE_ID_ACCUM_SPI,
199 BOOTSTAGE_ID_ACCUM_DECOMP,
200 BOOTSTAGE_ID_ACCUM_OF_LIVE,
201 BOOTSTAGE_ID_FPGA_INIT,
202 BOOTSTATE_ID_ACCUM_DM_SPL,
203 BOOTSTATE_ID_ACCUM_DM_F,
204 BOOTSTATE_ID_ACCUM_DM_R,
205
206 /* a few spare for the user, from here */
207 BOOTSTAGE_ID_USER,
208 BOOTSTAGE_ID_ALLOC,
209 };
210
211 /*
212 * Return the time since boot in microseconds, This is needed for bootstage
213 * and should be defined in CPU- or board-specific code. If undefined then
214 * you will get a link error.
215 */
216 ulong timer_get_boot_us(void);
217
218 #if defined(USE_HOSTCC)
219 #define show_boot_progress(val) do {} while (0)
220 #else
221 /**
222 * Board code can implement show_boot_progress() if needed.
223 *
224 * @param val Progress state (enum bootstage_id), or -id if an error
225 * has occurred.
226 */
227 void show_boot_progress(int val);
228 #endif
229
230 #if !defined(USE_HOSTCC)
231 #if CONFIG_IS_ENABLED(BOOTSTAGE)
232 #define ENABLE_BOOTSTAGE
233 #endif
234 #endif
235
236 #ifdef ENABLE_BOOTSTAGE
237
238 /* This is the full bootstage implementation */
239
240 /**
241 * Relocate existing bootstage records
242 *
243 * Call this after relocation has happened and after malloc has been initted.
244 * We need to copy any pointers in bootstage records that were added pre-
245 * relocation, since memory can be overwritten later.
246 * @return Always returns 0, to indicate success
247 */
248 int bootstage_relocate(void);
249
250 /**
251 * Add a new bootstage record
252 *
253 * @param id Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC)
254 * @param name Name of record, or NULL for none
255 * @param flags Flags (BOOTSTAGEF_...)
256 * @param mark Time to record in this record, in microseconds
257 */
258 ulong bootstage_add_record(enum bootstage_id id, const char *name,
259 int flags, ulong mark);
260
261 /**
262 * Mark a time stamp for the current boot stage.
263 */
264 ulong bootstage_mark(enum bootstage_id id);
265
266 ulong bootstage_error(enum bootstage_id id);
267
268 ulong bootstage_mark_name(enum bootstage_id id, const char *name);
269
270 /**
271 * Mark a time stamp in the given function and line number
272 *
273 * See BOOTSTAGE_MARKER() for a convenient macro.
274 *
275 * @param file Filename to record (NULL if none)
276 * @param func Function name to record
277 * @param linenum Line number to record
278 * @return recorded time stamp
279 */
280 ulong bootstage_mark_code(const char *file, const char *func,
281 int linenum);
282
283 /**
284 * Mark the start of a bootstage activity. The end will be marked later with
285 * bootstage_accum() and at that point we accumulate the time taken. Calling
286 * this function turns the given id into a accumulator rather than and
287 * absolute mark in time. Accumulators record the total amount of time spent
288 * in an activty during boot.
289 *
290 * @param id Bootstage id to record this timestamp against
291 * @param name Textual name to display for this id in the report (maybe NULL)
292 * @return start timestamp in microseconds
293 */
294 uint32_t bootstage_start(enum bootstage_id id, const char *name);
295
296 /**
297 * Mark the end of a bootstage activity
298 *
299 * After previously marking the start of an activity with bootstage_start(),
300 * call this function to mark the end. You can call these functions in pairs
301 * as many times as you like.
302 *
303 * @param id Bootstage id to record this timestamp against
304 * @return time spent in this iteration of the activity (i.e. the time now
305 * less the start time recorded in the last bootstage_start() call
306 * with this id.
307 */
308 uint32_t bootstage_accum(enum bootstage_id id);
309
310 /* Print a report about boot time */
311 void bootstage_report(void);
312
313 /**
314 * Add bootstage information to the device tree
315 *
316 * @return 0 if ok, -ve on error
317 */
318 int bootstage_fdt_add_report(void);
319
320 /**
321 * Stash bootstage data into memory
322 *
323 * @param base Base address of memory buffer
324 * @param size Size of memory buffer
325 * @return 0 if stashed ok, -1 if out of space
326 */
327 int bootstage_stash(void *base, int size);
328
329 /**
330 * Read bootstage data from memory
331 *
332 * Bootstage data is read from memory and placed in the bootstage table
333 * in the user records.
334 *
335 * @param base Base address of memory buffer
336 * @param size Size of memory buffer (-1 if unknown)
337 * @return 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if
338 * there is not space for read the stacked data, or other error if
339 * something else went wrong
340 */
341 int bootstage_unstash(const void *base, int size);
342
343 /**
344 * bootstage_get_size() - Get the size of the bootstage data
345 *
346 * @return size of boostage data in bytes
347 */
348 int bootstage_get_size(void);
349
350 /**
351 * bootstage_init() - Prepare bootstage for use
352 *
353 * @first: true if this is the first time bootstage is set up. This causes it
354 * to add a 'reset' record with a time of 0.
355 */
356 int bootstage_init(bool first);
357
358 #else
bootstage_add_record(enum bootstage_id id,const char * name,int flags,ulong mark)359 static inline ulong bootstage_add_record(enum bootstage_id id,
360 const char *name, int flags, ulong mark)
361 {
362 return 0;
363 }
364
365 /*
366 * This is a dummy implementation which just calls show_boot_progress(),
367 * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
368 */
369
bootstage_relocate(void)370 static inline int bootstage_relocate(void)
371 {
372 return 0;
373 }
374
bootstage_mark(enum bootstage_id id)375 static inline ulong bootstage_mark(enum bootstage_id id)
376 {
377 show_boot_progress(id);
378 return 0;
379 }
380
bootstage_error(enum bootstage_id id)381 static inline ulong bootstage_error(enum bootstage_id id)
382 {
383 show_boot_progress(-id);
384 return 0;
385 }
386
bootstage_mark_name(enum bootstage_id id,const char * name)387 static inline ulong bootstage_mark_name(enum bootstage_id id, const char *name)
388 {
389 show_boot_progress(id);
390 return 0;
391 }
392
bootstage_mark_code(const char * file,const char * func,int linenum)393 static inline ulong bootstage_mark_code(const char *file, const char *func,
394 int linenum)
395 {
396 return 0;
397 }
398
bootstage_start(enum bootstage_id id,const char * name)399 static inline uint32_t bootstage_start(enum bootstage_id id, const char *name)
400 {
401 return 0;
402 }
403
bootstage_accum(enum bootstage_id id)404 static inline uint32_t bootstage_accum(enum bootstage_id id)
405 {
406 return 0;
407 }
408
bootstage_stash(void * base,int size)409 static inline int bootstage_stash(void *base, int size)
410 {
411 return 0; /* Pretend to succeed */
412 }
413
bootstage_unstash(const void * base,int size)414 static inline int bootstage_unstash(const void *base, int size)
415 {
416 return 0; /* Pretend to succeed */
417 }
418
bootstage_get_size(void)419 static inline int bootstage_get_size(void)
420 {
421 return 0;
422 }
423
bootstage_init(bool first)424 static inline int bootstage_init(bool first)
425 {
426 return 0;
427 }
428
429 #endif /* ENABLE_BOOTSTAGE */
430
431 /* Helper macro for adding a bootstage to a line of code */
432 #define BOOTSTAGE_MARKER() \
433 bootstage_mark_code(__FILE__, __func__, __LINE__)
434
435 #endif
436