]>
Commit | Line | Data |
---|---|---|
097e1783 SG |
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. | |
c87dc38d | 5 | * Note that it requires timer_get_boot_us() to be defined by the board |
097e1783 SG |
6 | * |
7 | * Copyright (c) 2011 The Chromium OS Authors. | |
097e1783 | 8 | * |
1a459660 | 9 | * SPDX-License-Identifier: GPL-2.0+ |
097e1783 SG |
10 | */ |
11 | ||
12 | #ifndef _BOOTSTAGE_H | |
13 | #define _BOOTSTAGE_H | |
14 | ||
ee2b2434 | 15 | /* Define this for host tools */ |
3a608ca0 SG |
16 | #ifndef CONFIG_BOOTSTAGE_USER_COUNT |
17 | #define CONFIG_BOOTSTAGE_USER_COUNT 20 | |
18 | #endif | |
19 | ||
094e06a5 SG |
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 | ||
a2cc9bf4 SG |
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 | ||
097e1783 SG |
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 { | |
5dc88716 SG |
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 | ||
5e410883 SG |
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 | ||
097e1783 | 83 | BOOTSTAGE_ID_RUN_OS = 15, /* Exiting U-Boot, entering OS */ |
8ade9506 SG |
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 | /* | |
1b15fac1 | 90 | * This set is reported only by x86, and the meaning is different. In |
8ade9506 | 91 | * this case we are reporting completion of a particular stage. |
1b15fac1 | 92 | * This should probably change in the x86 code (which doesn't report |
8ade9506 SG |
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 | ||
90e153d7 SG |
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, | |
cd24a6bf SG |
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 | ||
c8e66db7 SG |
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 | ||
a2cc9bf4 | 144 | BOOTSTAGE_ID_FIT_FDT_START = 90, |
aacc8c16 SG |
145 | /* |
146 | * Boot stages related to loading a FIT image. Some of these are a | |
147 | * bit wonky. | |
148 | */ | |
a2cc9bf4 | 149 | BOOTSTAGE_ID_FIT_KERNEL_START = 100, |
13167dac SG |
150 | |
151 | BOOTSTAGE_ID_FIT_CONFIG = 110, | |
aacc8c16 | 152 | BOOTSTAGE_ID_FIT_TYPE, |
13167dac | 153 | BOOTSTAGE_ID_FIT_KERNEL_INFO, |
aacc8c16 SG |
154 | |
155 | BOOTSTAGE_ID_FIT_COMPRESSION, | |
156 | BOOTSTAGE_ID_FIT_OS, | |
157 | BOOTSTAGE_ID_FIT_LOADADDR, | |
158 | BOOTSTAGE_ID_OVERWRITTEN, | |
159 | ||
a2cc9bf4 SG |
160 | /* Next 10 IDs used by BOOTSTAGE_SUB_... */ |
161 | BOOTSTAGE_ID_FIT_RD_START = 120, /* Ramdisk stages */ | |
aacc8c16 | 162 | |
90268b87 SG |
163 | /* Next 10 IDs used by BOOTSTAGE_SUB_... */ |
164 | BOOTSTAGE_ID_FIT_SETUP_START = 130, /* x86 setup stages */ | |
165 | ||
cd24a6bf SG |
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, | |
3a608ca0 | 171 | |
84a07dbf | 172 | BOOTSTAGE_ID_FIT_LOADABLE_START = 160, /* for Loadable Images */ |
3a608ca0 SG |
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, | |
996e95d4 | 179 | BOOTSTAGE_ID_START_SPL, |
824bb1b4 | 180 | BOOTSTAGE_ID_END_SPL, |
3a608ca0 SG |
181 | BOOTSTAGE_ID_START_UBOOT_F, |
182 | BOOTSTAGE_ID_START_UBOOT_R, | |
183 | BOOTSTAGE_ID_USB_START, | |
184 | BOOTSTAGE_ID_ETH_START, | |
185 | BOOTSTAGE_ID_BOOTP_START, | |
186 | BOOTSTAGE_ID_BOOTP_STOP, | |
187 | BOOTSTAGE_ID_BOOTM_START, | |
188 | BOOTSTAGE_ID_BOOTM_HANDOFF, | |
189 | BOOTSTAGE_ID_MAIN_LOOP, | |
190 | BOOTSTAGE_KERNELREAD_START, | |
191 | BOOTSTAGE_KERNELREAD_STOP, | |
996e95d4 SG |
192 | BOOTSTAGE_ID_BOARD_INIT, |
193 | BOOTSTAGE_ID_BOARD_INIT_DONE, | |
3a608ca0 SG |
194 | |
195 | BOOTSTAGE_ID_CPU_AWAKE, | |
196 | BOOTSTAGE_ID_MAIN_CPU_AWAKE, | |
197 | BOOTSTAGE_ID_MAIN_CPU_READY, | |
198 | ||
996e95d4 | 199 | BOOTSTAGE_ID_ACCUM_LCD, |
abbdb262 | 200 | BOOTSTAGE_ID_ACCUM_SCSI, |
28b5404c SG |
201 | BOOTSTAGE_ID_ACCUM_SPI, |
202 | BOOTSTAGE_ID_ACCUM_DECOMP, | |
a132f770 | 203 | BOOTSTAGE_ID_ACCUM_OF_LIVE, |
62afc601 | 204 | BOOTSTAGE_ID_FPGA_INIT, |
824bb1b4 | 205 | BOOTSTATE_ID_ACCUM_DM_SPL, |
63c5bf48 SG |
206 | BOOTSTATE_ID_ACCUM_DM_F, |
207 | BOOTSTATE_ID_ACCUM_DM_R, | |
996e95d4 | 208 | |
3a608ca0 SG |
209 | /* a few spare for the user, from here */ |
210 | BOOTSTAGE_ID_USER, | |
211 | BOOTSTAGE_ID_COUNT = BOOTSTAGE_ID_USER + CONFIG_BOOTSTAGE_USER_COUNT, | |
212 | BOOTSTAGE_ID_ALLOC, | |
097e1783 SG |
213 | }; |
214 | ||
3786980d SG |
215 | /* |
216 | * Return the time since boot in microseconds, This is needed for bootstage | |
217 | * and should be defined in CPU- or board-specific code. If undefined then | |
c87dc38d | 218 | * you will get a link error. |
3786980d SG |
219 | */ |
220 | ulong timer_get_boot_us(void); | |
221 | ||
496c5483 HS |
222 | #if defined(USE_HOSTCC) |
223 | #define show_boot_progress(val) do {} while (0) | |
224 | #else | |
cbcd6970 | 225 | /** |
097e1783 SG |
226 | * Board code can implement show_boot_progress() if needed. |
227 | * | |
228 | * @param val Progress state (enum bootstage_id), or -id if an error | |
229 | * has occurred. | |
230 | */ | |
231 | void show_boot_progress(int val); | |
7ac2fe2d | 232 | #endif |
770605e4 | 233 | |
824bb1b4 SG |
234 | #if !defined(USE_HOSTCC) |
235 | #if CONFIG_IS_ENABLED(BOOTSTAGE) | |
236 | #define ENABLE_BOOTSTAGE | |
237 | #endif | |
238 | #endif | |
239 | ||
240 | #ifdef ENABLE_BOOTSTAGE | |
241 | ||
770605e4 SG |
242 | /* This is the full bootstage implementation */ |
243 | ||
150678a5 DA |
244 | /** |
245 | * Relocate existing bootstage records | |
246 | * | |
247 | * Call this after relocation has happened and after malloc has been initted. | |
248 | * We need to copy any pointers in bootstage records that were added pre- | |
cbcd6970 | 249 | * relocation, since memory can be overwritten later. |
150678a5 DA |
250 | * @return Always returns 0, to indicate success |
251 | */ | |
252 | int bootstage_relocate(void); | |
253 | ||
094e06a5 SG |
254 | /** |
255 | * Add a new bootstage record | |
256 | * | |
257 | * @param id Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC) | |
258 | * @param name Name of record, or NULL for none | |
259 | * @param flags Flags (BOOTSTAGEF_...) | |
260 | * @param mark Time to record in this record, in microseconds | |
261 | */ | |
262 | ulong bootstage_add_record(enum bootstage_id id, const char *name, | |
263 | int flags, ulong mark); | |
264 | ||
cbcd6970 | 265 | /** |
770605e4 SG |
266 | * Mark a time stamp for the current boot stage. |
267 | */ | |
268 | ulong bootstage_mark(enum bootstage_id id); | |
269 | ||
270 | ulong bootstage_error(enum bootstage_id id); | |
271 | ||
3a608ca0 SG |
272 | ulong bootstage_mark_name(enum bootstage_id id, const char *name); |
273 | ||
fb7db41c SG |
274 | /** |
275 | * Mark a time stamp in the given function and line number | |
276 | * | |
277 | * See BOOTSTAGE_MARKER() for a convenient macro. | |
278 | * | |
279 | * @param file Filename to record (NULL if none) | |
280 | * @param func Function name to record | |
281 | * @param linenum Line number to record | |
282 | * @return recorded time stamp | |
283 | */ | |
284 | ulong bootstage_mark_code(const char *file, const char *func, | |
285 | int linenum); | |
286 | ||
0e996773 SG |
287 | /** |
288 | * Mark the start of a bootstage activity. The end will be marked later with | |
289 | * bootstage_accum() and at that point we accumulate the time taken. Calling | |
290 | * this function turns the given id into a accumulator rather than and | |
291 | * absolute mark in time. Accumulators record the total amount of time spent | |
292 | * in an activty during boot. | |
293 | * | |
294 | * @param id Bootstage id to record this timestamp against | |
295 | * @param name Textual name to display for this id in the report (maybe NULL) | |
296 | * @return start timestamp in microseconds | |
297 | */ | |
298 | uint32_t bootstage_start(enum bootstage_id id, const char *name); | |
299 | ||
300 | /** | |
301 | * Mark the end of a bootstage activity | |
302 | * | |
303 | * After previously marking the start of an activity with bootstage_start(), | |
304 | * call this function to mark the end. You can call these functions in pairs | |
305 | * as many times as you like. | |
306 | * | |
307 | * @param id Bootstage id to record this timestamp against | |
308 | * @return time spent in this iteration of the activity (i.e. the time now | |
309 | * less the start time recorded in the last bootstage_start() call | |
310 | * with this id. | |
311 | */ | |
312 | uint32_t bootstage_accum(enum bootstage_id id); | |
313 | ||
3a608ca0 SG |
314 | /* Print a report about boot time */ |
315 | void bootstage_report(void); | |
316 | ||
94fd1316 SG |
317 | /** |
318 | * Add bootstage information to the device tree | |
319 | * | |
320 | * @return 0 if ok, -ve on error | |
321 | */ | |
322 | int bootstage_fdt_add_report(void); | |
323 | ||
cbcd6970 | 324 | /** |
fcf509b8 SG |
325 | * Stash bootstage data into memory |
326 | * | |
327 | * @param base Base address of memory buffer | |
328 | * @param size Size of memory buffer | |
329 | * @return 0 if stashed ok, -1 if out of space | |
330 | */ | |
331 | int bootstage_stash(void *base, int size); | |
332 | ||
333 | /** | |
334 | * Read bootstage data from memory | |
335 | * | |
336 | * Bootstage data is read from memory and placed in the bootstage table | |
337 | * in the user records. | |
338 | * | |
339 | * @param base Base address of memory buffer | |
340 | * @param size Size of memory buffer (-1 if unknown) | |
e003310a SG |
341 | * @return 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if |
342 | * there is not space for read the stacked data, or other error if | |
343 | * something else went wrong | |
fcf509b8 | 344 | */ |
9d2542d0 | 345 | int bootstage_unstash(const void *base, int size); |
fcf509b8 | 346 | |
25e7dc6a SG |
347 | /** |
348 | * bootstage_get_size() - Get the size of the bootstage data | |
349 | * | |
350 | * @return size of boostage data in bytes | |
351 | */ | |
352 | int bootstage_get_size(void); | |
353 | ||
b383d6c0 SG |
354 | /** |
355 | * bootstage_init() - Prepare bootstage for use | |
356 | * | |
357 | * @first: true if this is the first time bootstage is set up. This causes it | |
358 | * to add a 'reset' record with a time of 0. | |
359 | */ | |
360 | int bootstage_init(bool first); | |
361 | ||
770605e4 | 362 | #else |
e802ee0f SG |
363 | static inline ulong bootstage_add_record(enum bootstage_id id, |
364 | const char *name, int flags, ulong mark) | |
365 | { | |
366 | return 0; | |
367 | } | |
368 | ||
770605e4 SG |
369 | /* |
370 | * This is a dummy implementation which just calls show_boot_progress(), | |
371 | * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined | |
372 | */ | |
373 | ||
150678a5 DA |
374 | static inline int bootstage_relocate(void) |
375 | { | |
376 | return 0; | |
377 | } | |
378 | ||
770605e4 SG |
379 | static inline ulong bootstage_mark(enum bootstage_id id) |
380 | { | |
381 | show_boot_progress(id); | |
382 | return 0; | |
383 | } | |
384 | ||
385 | static inline ulong bootstage_error(enum bootstage_id id) | |
5ddb118d | 386 | { |
770605e4 SG |
387 | show_boot_progress(-id); |
388 | return 0; | |
5ddb118d | 389 | } |
097e1783 | 390 | |
3a608ca0 SG |
391 | static inline ulong bootstage_mark_name(enum bootstage_id id, const char *name) |
392 | { | |
7f442e36 | 393 | show_boot_progress(id); |
3a608ca0 SG |
394 | return 0; |
395 | } | |
396 | ||
fb7db41c SG |
397 | static inline ulong bootstage_mark_code(const char *file, const char *func, |
398 | int linenum) | |
399 | { | |
400 | return 0; | |
401 | } | |
402 | ||
e802ee0f SG |
403 | static inline uint32_t bootstage_start(enum bootstage_id id, const char *name) |
404 | { | |
405 | return 0; | |
406 | } | |
407 | ||
408 | static inline uint32_t bootstage_accum(enum bootstage_id id) | |
409 | { | |
410 | return 0; | |
411 | } | |
412 | ||
fcf509b8 SG |
413 | static inline int bootstage_stash(void *base, int size) |
414 | { | |
415 | return 0; /* Pretend to succeed */ | |
416 | } | |
3a608ca0 | 417 | |
9d2542d0 | 418 | static inline int bootstage_unstash(const void *base, int size) |
fcf509b8 SG |
419 | { |
420 | return 0; /* Pretend to succeed */ | |
421 | } | |
b383d6c0 | 422 | |
25e7dc6a SG |
423 | static inline int bootstage_get_size(void) |
424 | { | |
425 | return 0; | |
426 | } | |
427 | ||
b383d6c0 SG |
428 | static inline int bootstage_init(bool first) |
429 | { | |
430 | return 0; | |
431 | } | |
824bb1b4 SG |
432 | |
433 | #endif /* ENABLE_BOOTSTAGE */ | |
770605e4 | 434 | |
fb7db41c SG |
435 | /* Helper macro for adding a bootstage to a line of code */ |
436 | #define BOOTSTAGE_MARKER() \ | |
437 | bootstage_mark_code(__FILE__, __func__, __LINE__) | |
438 | ||
097e1783 | 439 | #endif |