]> git.ipfire.org Git - people/ms/u-boot.git/blob - include/bootstage.h
bootstage: Record the time taken to set up driver model
[people/ms/u-boot.git] / include / bootstage.h
1 /*
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
6 *
7 * Copyright (c) 2011 The Chromium OS Authors.
8 *
9 * SPDX-License-Identifier: GPL-2.0+
10 */
11
12 #ifndef _BOOTSTAGE_H
13 #define _BOOTSTAGE_H
14
15 /* Define this for host tools */
16 #ifndef CONFIG_BOOTSTAGE_USER_COUNT
17 #define CONFIG_BOOTSTAGE_USER_COUNT 20
18 #endif
19
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 */
24 };
25
26 /* bootstate sub-IDs used for kernel and ramdisk ranges */
27 enum {
28 BOOTSTAGE_SUB_FORMAT,
29 BOOTSTAGE_SUB_FORMAT_OK,
30 BOOTSTAGE_SUB_NO_UNIT_NAME,
31 BOOTSTAGE_SUB_UNIT_NAME,
32 BOOTSTAGE_SUB_SUBNODE,
33
34 BOOTSTAGE_SUB_CHECK,
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,
41 BOOTSTAGE_SUB_LOAD,
42 };
43
44 /*
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
48 * normal sequence is:
49 *
50 * progress action1
51 * progress action2
52 * progress action3
53 *
54 * and an error condition where action 3 failed would be:
55 *
56 * progress action1
57 * progress action2
58 * progress action3
59 * error on action3
60 */
61 enum bootstage_id {
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 */
67
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 */
75
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) */
82
83 BOOTSTAGE_ID_RUN_OS = 15, /* Exiting U-Boot, entering OS */
84
85 BOOTSTAGE_ID_NEED_RESET = 30,
86 BOOTSTAGE_ID_POST_FAIL, /* Post failure */
87 BOOTSTAGE_ID_POST_FAIL_R, /* Post failure reported after reloc */
88
89 /*
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.
95 */
96 BOOTSTAGE_ID_BOARD_INIT_R, /* We have relocated */
97 BOOTSTAGE_ID_BOARD_GLOBAL_DATA, /* Global data is set up */
98
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 */
104
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 */
108
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,
114
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,
120
121 BOOTSTAGE_ID_IDE_CHECKSUM, /* 50 */
122 BOOTSTAGE_ID_IDE_READ,
123
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,
132
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,
137
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,
143
144 BOOTSTAGE_ID_FIT_FDT_START = 90,
145 /*
146 * Boot stages related to loading a FIT image. Some of these are a
147 * bit wonky.
148 */
149 BOOTSTAGE_ID_FIT_KERNEL_START = 100,
150
151 BOOTSTAGE_ID_FIT_CONFIG = 110,
152 BOOTSTAGE_ID_FIT_TYPE,
153 BOOTSTAGE_ID_FIT_KERNEL_INFO,
154
155 BOOTSTAGE_ID_FIT_COMPRESSION,
156 BOOTSTAGE_ID_FIT_OS,
157 BOOTSTAGE_ID_FIT_LOADADDR,
158 BOOTSTAGE_ID_OVERWRITTEN,
159
160 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
161 BOOTSTAGE_ID_FIT_RD_START = 120, /* Ramdisk stages */
162
163 /* Next 10 IDs used by BOOTSTAGE_SUB_... */
164 BOOTSTAGE_ID_FIT_SETUP_START = 130, /* x86 setup stages */
165
166 BOOTSTAGE_ID_IDE_FIT_READ = 140,
167 BOOTSTAGE_ID_IDE_FIT_READ_OK,
168
169 BOOTSTAGE_ID_NAND_FIT_READ = 150,
170 BOOTSTAGE_ID_NAND_FIT_READ_OK,
171
172 BOOTSTAGE_ID_FIT_LOADABLE_START = 160, /* for Loadable Images */
173 /*
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.
177 */
178 BOOTSTAGE_ID_AWAKE,
179 BOOTSTAGE_ID_START_SPL,
180 BOOTSTAGE_ID_START_UBOOT_F,
181 BOOTSTAGE_ID_START_UBOOT_R,
182 BOOTSTAGE_ID_USB_START,
183 BOOTSTAGE_ID_ETH_START,
184 BOOTSTAGE_ID_BOOTP_START,
185 BOOTSTAGE_ID_BOOTP_STOP,
186 BOOTSTAGE_ID_BOOTM_START,
187 BOOTSTAGE_ID_BOOTM_HANDOFF,
188 BOOTSTAGE_ID_MAIN_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_FPGA_INIT,
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_COUNT = BOOTSTAGE_ID_USER + CONFIG_BOOTSTAGE_USER_COUNT,
209 BOOTSTAGE_ID_ALLOC,
210 };
211
212 /*
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 * you will get a link error.
216 */
217 ulong timer_get_boot_us(void);
218
219 #if defined(USE_HOSTCC)
220 #define show_boot_progress(val) do {} while (0)
221 #else
222 /**
223 * Board code can implement show_boot_progress() if needed.
224 *
225 * @param val Progress state (enum bootstage_id), or -id if an error
226 * has occurred.
227 */
228 void show_boot_progress(int val);
229 #endif
230
231 #if defined(CONFIG_BOOTSTAGE) && !defined(CONFIG_SPL_BUILD) && \
232 !defined(USE_HOSTCC)
233 /* This is the full bootstage implementation */
234
235 /**
236 * Relocate existing bootstage records
237 *
238 * Call this after relocation has happened and after malloc has been initted.
239 * We need to copy any pointers in bootstage records that were added pre-
240 * relocation, since memory can be overwritten later.
241 * @return Always returns 0, to indicate success
242 */
243 int bootstage_relocate(void);
244
245 /**
246 * Add a new bootstage record
247 *
248 * @param id Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC)
249 * @param name Name of record, or NULL for none
250 * @param flags Flags (BOOTSTAGEF_...)
251 * @param mark Time to record in this record, in microseconds
252 */
253 ulong bootstage_add_record(enum bootstage_id id, const char *name,
254 int flags, ulong mark);
255
256 /**
257 * Mark a time stamp for the current boot stage.
258 */
259 ulong bootstage_mark(enum bootstage_id id);
260
261 ulong bootstage_error(enum bootstage_id id);
262
263 ulong bootstage_mark_name(enum bootstage_id id, const char *name);
264
265 /**
266 * Mark a time stamp in the given function and line number
267 *
268 * See BOOTSTAGE_MARKER() for a convenient macro.
269 *
270 * @param file Filename to record (NULL if none)
271 * @param func Function name to record
272 * @param linenum Line number to record
273 * @return recorded time stamp
274 */
275 ulong bootstage_mark_code(const char *file, const char *func,
276 int linenum);
277
278 /**
279 * Mark the start of a bootstage activity. The end will be marked later with
280 * bootstage_accum() and at that point we accumulate the time taken. Calling
281 * this function turns the given id into a accumulator rather than and
282 * absolute mark in time. Accumulators record the total amount of time spent
283 * in an activty during boot.
284 *
285 * @param id Bootstage id to record this timestamp against
286 * @param name Textual name to display for this id in the report (maybe NULL)
287 * @return start timestamp in microseconds
288 */
289 uint32_t bootstage_start(enum bootstage_id id, const char *name);
290
291 /**
292 * Mark the end of a bootstage activity
293 *
294 * After previously marking the start of an activity with bootstage_start(),
295 * call this function to mark the end. You can call these functions in pairs
296 * as many times as you like.
297 *
298 * @param id Bootstage id to record this timestamp against
299 * @return time spent in this iteration of the activity (i.e. the time now
300 * less the start time recorded in the last bootstage_start() call
301 * with this id.
302 */
303 uint32_t bootstage_accum(enum bootstage_id id);
304
305 /* Print a report about boot time */
306 void bootstage_report(void);
307
308 /**
309 * Add bootstage information to the device tree
310 *
311 * @return 0 if ok, -ve on error
312 */
313 int bootstage_fdt_add_report(void);
314
315 /**
316 * Stash bootstage data into memory
317 *
318 * @param base Base address of memory buffer
319 * @param size Size of memory buffer
320 * @return 0 if stashed ok, -1 if out of space
321 */
322 int bootstage_stash(void *base, int size);
323
324 /**
325 * Read bootstage data from memory
326 *
327 * Bootstage data is read from memory and placed in the bootstage table
328 * in the user records.
329 *
330 * @param base Base address of memory buffer
331 * @param size Size of memory buffer (-1 if unknown)
332 * @return 0 if unstashed ok, -1 if bootstage info not found, or out of space
333 */
334 int bootstage_unstash(void *base, int size);
335
336 /**
337 * bootstage_get_size() - Get the size of the bootstage data
338 *
339 * @return size of boostage data in bytes
340 */
341 int bootstage_get_size(void);
342
343 /**
344 * bootstage_init() - Prepare bootstage for use
345 *
346 * @first: true if this is the first time bootstage is set up. This causes it
347 * to add a 'reset' record with a time of 0.
348 */
349 int bootstage_init(bool first);
350
351 #else
352 static inline ulong bootstage_add_record(enum bootstage_id id,
353 const char *name, int flags, ulong mark)
354 {
355 return 0;
356 }
357
358 /*
359 * This is a dummy implementation which just calls show_boot_progress(),
360 * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
361 */
362
363 static inline int bootstage_relocate(void)
364 {
365 return 0;
366 }
367
368 static inline ulong bootstage_mark(enum bootstage_id id)
369 {
370 show_boot_progress(id);
371 return 0;
372 }
373
374 static inline ulong bootstage_error(enum bootstage_id id)
375 {
376 show_boot_progress(-id);
377 return 0;
378 }
379
380 static inline ulong bootstage_mark_name(enum bootstage_id id, const char *name)
381 {
382 show_boot_progress(id);
383 return 0;
384 }
385
386 static inline ulong bootstage_mark_code(const char *file, const char *func,
387 int linenum)
388 {
389 return 0;
390 }
391
392 static inline uint32_t bootstage_start(enum bootstage_id id, const char *name)
393 {
394 return 0;
395 }
396
397 static inline uint32_t bootstage_accum(enum bootstage_id id)
398 {
399 return 0;
400 }
401
402 static inline int bootstage_stash(void *base, int size)
403 {
404 return 0; /* Pretend to succeed */
405 }
406
407 static inline int bootstage_unstash(void *base, int size)
408 {
409 return 0; /* Pretend to succeed */
410 }
411
412 static inline int bootstage_get_size(void)
413 {
414 return 0;
415 }
416
417 static inline int bootstage_init(bool first)
418 {
419 return 0;
420 }
421 #endif /* CONFIG_BOOTSTAGE */
422
423 /* Helper macro for adding a bootstage to a line of code */
424 #define BOOTSTAGE_MARKER() \
425 bootstage_mark_code(__FILE__, __func__, __LINE__)
426
427 #endif