bootstage: Convert progress numbers 1-9 into enums
[oweals/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  *
6  * Copyright (c) 2011 The Chromium OS Authors.
7  * See file CREDITS for list of people who contributed to this
8  * project.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License as
12  * published by the Free Software Foundation; either version 2 of
13  * the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23  * MA 02111-1307 USA
24  */
25
26 #ifndef _BOOTSTAGE_H
27 #define _BOOTSTAGE_H
28
29 /*
30  * A list of boot stages that we know about. Each of these indicates the
31  * state that we are at, and the action that we are about to perform. For
32  * errors, we issue an error for an item when it fails. Therefore the
33  * normal sequence is:
34  *
35  * progress action1
36  * progress action2
37  * progress action3
38  *
39  * and an error condition where action 3 failed would be:
40  *
41  * progress action1
42  * progress action2
43  * progress action3
44  * error on action3
45  */
46 enum bootstage_id {
47         BOOTSTAGE_ID_START = 0,
48         BOOTSTAGE_ID_CHECK_MAGIC,       /* Checking image magic */
49         BOOTSTAGE_ID_CHECK_HEADER,      /* Checking image header */
50         BOOTSTAGE_ID_CHECK_CHECKSUM,    /* Checking image checksum */
51         BOOTSTAGE_ID_CHECK_ARCH,        /* Checking architecture */
52
53         BOOTSTAGE_ID_CHECK_IMAGETYPE = 5,/* Checking image type */
54         BOOTSTAGE_ID_DECOMP_IMAGE,      /* Decompressing image */
55         BOOTSTAGE_ID_KERNEL_LOADED,     /* Kernel has been loaded */
56         BOOTSTAGE_ID_DECOMP_UNIMPL = 7, /* Odd decompression algorithm */
57         BOOTSTAGE_ID_CHECK_BOOT_OS,     /* Calling OS-specific boot function */
58         BOOTSTAGE_ID_BOOT_OS_RETURNED,  /* Tried to boot OS, but it returned */
59         BOOTSTAGE_ID_CHECK_RAMDISK = 9, /* Checking ram disk */
60
61         BOOTSTAGE_ID_RUN_OS     = 15,   /* Exiting U-Boot, entering OS */
62 };
63
64 /*
65  * Board code can implement show_boot_progress() if needed.
66  *
67  * @param val   Progress state (enum bootstage_id), or -id if an error
68  *              has occurred.
69  */
70 void show_boot_progress(int val);
71 static inline void show_boot_error(int val)
72 {
73         show_boot_progress(-val);
74 }
75
76 #endif