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