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 #include <linux/kconfig.h>
15
16 /* Flags for each bootstage record */
17 enum bootstage_flags {
18 BOOTSTAGEF_ERROR = 1 << 0, /* Error record */
19 BOOTSTAGEF_ALLOC = 1 << 1, /* Allocate an id */
20 };
21
22 /* bootstate sub-IDs used for kernel and ramdisk ranges */
23 enum {
24 BOOTSTAGE_SUB_FORMAT,
25 BOOTSTAGE_SUB_FORMAT_OK,
26 BOOTSTAGE_SUB_NO_UNIT_NAME,
27 BOOTSTAGE_SUB_UNIT_NAME,
28 BOOTSTAGE_SUB_SUBNODE,
29
30 BOOTSTAGE_SUB_CHECK,
31 BOOTSTAGE_SUB_HASH = 5,
32 BOOTSTAGE_SUB_CHECK_ARCH = 5,
33 BOOTSTAGE_SUB_CHECK_ALL,
34 BOOTSTAGE_SUB_GET_DATA,
35 BOOTSTAGE_SUB_CHECK_ALL_OK = 7,
36 BOOTSTAGE_SUB_GET_DATA_OK,
37 BOOTSTAGE_SUB_LOAD,
38 };
39
40 /*
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
44 * normal sequence is:
45 *
46 * progress action1
47 * progress action2
48 * progress action3
49 *
50 * and an error condition where action 3 failed would be:
51 *
52 * progress action1
53 * progress action2
54 * progress action3
55 * error on action3
56 */
57 enum bootstage_id {
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 */
63
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 */
71
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) */
78
79 BOOTSTAGE_ID_RUN_OS = 15, /* Exiting U-Boot, entering OS */
80
81 BOOTSTAGE_ID_NEED_RESET = 30,
82 BOOTSTAGE_ID_POST_FAIL, /* Post failure */
83 BOOTSTAGE_ID_POST_FAIL_R, /* Post failure reported after reloc */
84
85 /*
86 * This set is reported only 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 the 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.
91 */
92 BOOTSTAGE_ID_BOARD_INIT_R, /* We have relocated */
93 BOOTSTAGE_ID_BOARD_GLOBAL_DATA, /* Global data is set up */
94
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 */
100
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 */
104
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,
110
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,
116
117 BOOTSTAGE_ID_IDE_CHECKSUM, /* 50 */
118 BOOTSTAGE_ID_IDE_READ,
119
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,
128
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,
133
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,
139
140 BOOTSTAGE_ID_FIT_FDT_START = 90,
141 /*
142 * Boot stages related to loading a FIT image. Some of these are a
143 * bit wonky.
144 */
145 BOOTSTAGE_ID_FIT_KERNEL_START = 100,
146
147 BOOTSTAGE_ID_FIT_CONFIG = 110,
148 BOOTSTAGE_ID_FIT_TYPE,
149 BOOTSTAGE_ID_FIT_KERNEL_INFO,
150
151 BOOTSTAGE_ID_FIT_COMPRESSION,
152 BOOTSTAGE_ID_FIT_OS,
153 BOOTSTAGE_ID_FIT_LOADADDR,
154 BOOTSTAGE_ID_OVERWRITTEN,
155
156 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
157 BOOTSTAGE_ID_FIT_RD_START = 120, /* Ramdisk stages */
158
159 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
160 BOOTSTAGE_ID_FIT_SETUP_START = 130, /* x86 setup stages */
161
162 BOOTSTAGE_ID_IDE_FIT_READ = 140,
163 BOOTSTAGE_ID_IDE_FIT_READ_OK,
164
165 BOOTSTAGE_ID_NAND_FIT_READ = 150,
166 BOOTSTAGE_ID_NAND_FIT_READ_OK,
167
168 BOOTSTAGE_ID_FIT_LOADABLE_START = 160, /* for Loadable Images */
169 /*
170 * These boot stages are new, higher level, and not directly related
171 * to the old boot progress numbers. They are useful for recording
172 * rough boot timing information.
173 */
174 BOOTSTAGE_ID_AWAKE,
175 BOOTSTAGE_ID_START_TPL,
176 BOOTSTAGE_ID_END_TPL,
177 BOOTSTAGE_ID_START_SPL,
178 BOOTSTAGE_ID_END_SPL,
179 BOOTSTAGE_ID_START_UBOOT_F,
180 BOOTSTAGE_ID_START_UBOOT_R,
181 BOOTSTAGE_ID_USB_START,
182 BOOTSTAGE_ID_ETH_START,
183 BOOTSTAGE_ID_BOOTP_START,
184 BOOTSTAGE_ID_BOOTP_STOP,
185 BOOTSTAGE_ID_BOOTM_START,
186 BOOTSTAGE_ID_BOOTM_HANDOFF,
187 BOOTSTAGE_ID_MAIN_LOOP,
188 BOOTSTAGE_ID_ENTER_CLI_LOOP,
189 BOOTSTAGE_KERNELREAD_START,
190 BOOTSTAGE_KERNELREAD_STOP,
191 BOOTSTAGE_ID_BOARD_INIT,
192 BOOTSTAGE_ID_BOARD_INIT_DONE,
193
194 BOOTSTAGE_ID_CPU_AWAKE,
195 BOOTSTAGE_ID_MAIN_CPU_AWAKE,
196 BOOTSTAGE_ID_MAIN_CPU_READY,
197
198 BOOTSTAGE_ID_ACCUM_LCD,
199 BOOTSTAGE_ID_ACCUM_SCSI,
200 BOOTSTAGE_ID_ACCUM_SPI,
201 BOOTSTAGE_ID_ACCUM_DECOMP,
202 BOOTSTAGE_ID_ACCUM_OF_LIVE,
203 BOOTSTAGE_ID_FPGA_INIT,
204 BOOTSTAGE_ID_ACCUM_DM_SPL,
205 BOOTSTAGE_ID_ACCUM_DM_F,
206 BOOTSTAGE_ID_ACCUM_DM_R,
207 BOOTSTAGE_ID_ACCUM_FSP_M,
208 BOOTSTAGE_ID_ACCUM_FSP_S,
209 BOOTSTAGE_ID_ACCUM_MMAP_SPI,
210
211 /* a few spare for the user, from here */
212 BOOTSTAGE_ID_USER,
213 BOOTSTAGE_ID_ALLOC,
214 };
215
216 /*
217 * Return the time since boot in microseconds, This is needed for bootstage
218 * and should be defined in CPU- or board-specific code. If undefined then
219 * you will get a link error.
220 */
221 ulong timer_get_boot_us(void);
222
223 #if defined(USE_HOSTCC) || !CONFIG_IS_ENABLED(SHOW_BOOT_PROGRESS)
224 #define show_boot_progress(val) do {} while (0)
225 #else
226 /**
227 * Board code can implement show_boot_progress() if needed.
228 *
229 * @param val Progress state (enum bootstage_id), or -id if an error
230 * has occurred.
231 */
232 void show_boot_progress(int val);
233 #endif
234
235 #if !defined(USE_HOSTCC)
236 #if CONFIG_IS_ENABLED(BOOTSTAGE)
237 #define ENABLE_BOOTSTAGE
238 #endif
239 #endif
240
241 #ifdef ENABLE_BOOTSTAGE
242
243 /* This is the full bootstage implementation */
244
245 /**
246 * Relocate existing bootstage records
247 *
248 * Call this after relocation has happened and after malloc has been initted.
249 * We need to copy any pointers in bootstage records that were added pre-
250 * relocation, since memory can be overwritten later.
251 * @return Always returns 0, to indicate success
252 */
253 int bootstage_relocate(void);
254
255 /**
256 * Add a new bootstage record
257 *
258 * @param id Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC)
259 * @param name Name of record, or NULL for none
260 * @param flags Flags (BOOTSTAGEF_...)
261 * @param mark Time to record in this record, in microseconds
262 */
263 ulong bootstage_add_record(enum bootstage_id id, const char *name,
264 int flags, ulong mark);
265
266 /**
267 * Mark a time stamp for the current boot stage.
268 */
269 ulong bootstage_mark(enum bootstage_id id);
270
271 ulong bootstage_error(enum bootstage_id id);
272
273 ulong bootstage_mark_name(enum bootstage_id id, const char *name);
274
275 /**
276 * Mark a time stamp in the given function and line number
277 *
278 * See BOOTSTAGE_MARKER() for a convenient macro.
279 *
280 * @param file Filename to record (NULL if none)
281 * @param func Function name to record
282 * @param linenum Line number to record
283 * @return recorded time stamp
284 */
285 ulong bootstage_mark_code(const char *file, const char *func,
286 int linenum);
287
288 /**
289 * Mark the start of a bootstage activity. The end will be marked later with
290 * bootstage_accum() and at that point we accumulate the time taken. Calling
291 * this function turns the given id into a accumulator rather than and
292 * absolute mark in time. Accumulators record the total amount of time spent
293 * in an activty during boot.
294 *
295 * @param id Bootstage id to record this timestamp against
296 * @param name Textual name to display for this id in the report (maybe NULL)
297 * @return start timestamp in microseconds
298 */
299 uint32_t bootstage_start(enum bootstage_id id, const char *name);
300
301 /**
302 * Mark the end of a bootstage activity
303 *
304 * After previously marking the start of an activity with bootstage_start(),
305 * call this function to mark the end. You can call these functions in pairs
306 * as many times as you like.
307 *
308 * @param id Bootstage id to record this timestamp against
309 * @return time spent in this iteration of the activity (i.e. the time now
310 * less the start time recorded in the last bootstage_start() call
311 * with this id.
312 */
313 uint32_t bootstage_accum(enum bootstage_id id);
314
315 /* Print a report about boot time */
316 void bootstage_report(void);
317
318 /**
319 * Add bootstage information to the device tree
320 *
321 * @return 0 if ok, -ve on error
322 */
323 int bootstage_fdt_add_report(void);
324
325 /**
326 * Stash bootstage data into memory
327 *
328 * @param base Base address of memory buffer
329 * @param size Size of memory buffer
330 * @return 0 if stashed ok, -1 if out of space
331 */
332 int bootstage_stash(void *base, int size);
333
334 /**
335 * Read bootstage data from memory
336 *
337 * Bootstage data is read from memory and placed in the bootstage table
338 * in the user records.
339 *
340 * @param base Base address of memory buffer
341 * @param size Size of memory buffer (-1 if unknown)
342 * @return 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if
343 * there is not space for read the stashed data, or other error if
344 * something else went wrong
345 */
346 int bootstage_unstash(const void *base, int size);
347
348 /**
349 * bootstage_get_size() - Get the size of the bootstage data
350 *
351 * @return size of boostage data in bytes
352 */
353 int bootstage_get_size(void);
354
355 /**
356 * bootstage_init() - Prepare bootstage for use
357 *
358 * @first: true if this is the first time bootstage is set up. This causes it
359 * to add a 'reset' record with a time of 0.
360 */
361 int bootstage_init(bool first);
362
363 #else
bootstage_add_record(enum bootstage_id id,const char * name,int flags,ulong mark)364 static inline ulong bootstage_add_record(enum bootstage_id id,
365 const char *name, int flags, ulong mark)
366 {
367 return 0;
368 }
369
370 /*
371 * This is a dummy implementation which just calls show_boot_progress(),
372 * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
373 */
374
bootstage_relocate(void)375 static inline int bootstage_relocate(void)
376 {
377 return 0;
378 }
379
bootstage_mark(enum bootstage_id id)380 static inline ulong bootstage_mark(enum bootstage_id id)
381 {
382 show_boot_progress(id);
383 return 0;
384 }
385
bootstage_error(enum bootstage_id id)386 static inline ulong bootstage_error(enum bootstage_id id)
387 {
388 show_boot_progress(-id);
389 return 0;
390 }
391
bootstage_mark_name(enum bootstage_id id,const char * name)392 static inline ulong bootstage_mark_name(enum bootstage_id id, const char *name)
393 {
394 show_boot_progress(id);
395 return 0;
396 }
397
bootstage_mark_code(const char * file,const char * func,int linenum)398 static inline ulong bootstage_mark_code(const char *file, const char *func,
399 int linenum)
400 {
401 return 0;
402 }
403
bootstage_start(enum bootstage_id id,const char * name)404 static inline uint32_t bootstage_start(enum bootstage_id id, const char *name)
405 {
406 return 0;
407 }
408
bootstage_accum(enum bootstage_id id)409 static inline uint32_t bootstage_accum(enum bootstage_id id)
410 {
411 return 0;
412 }
413
bootstage_stash(void * base,int size)414 static inline int bootstage_stash(void *base, int size)
415 {
416 return 0; /* Pretend to succeed */
417 }
418
bootstage_unstash(const void * base,int size)419 static inline int bootstage_unstash(const void *base, int size)
420 {
421 return 0; /* Pretend to succeed */
422 }
423
bootstage_get_size(void)424 static inline int bootstage_get_size(void)
425 {
426 return 0;
427 }
428
bootstage_init(bool first)429 static inline int bootstage_init(bool first)
430 {
431 return 0;
432 }
433
434 #endif /* ENABLE_BOOTSTAGE */
435
436 /* Helper macro for adding a bootstage to a line of code */
437 #define BOOTSTAGE_MARKER() \
438 bootstage_mark_code(__FILE__, __func__, __LINE__)
439
440 #endif
441