[J-u-boot.git] / include / bootstage.h

/*
 * This file implements recording of each stage of the boot process. It is
 * intended to implement timing of each stage, reporting this information
 * to the user and passing it to the OS for logging / further analysis.
 *
 * Copyright (c) 2011 The Chromium OS Authors.
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

#ifndef _BOOTSTAGE_H
#define _BOOTSTAGE_H

/* The number of boot stage records available for the user */
#ifndef CONFIG_BOOTSTAGE_USER_COUNT
#define CONFIG_BOOTSTAGE_USER_COUNT	20
#endif

/* Flags for each bootstage record */
enum bootstage_flags {
	BOOTSTAGEF_ERROR	= 1 << 0,	/* Error record */
	BOOTSTAGEF_ALLOC	= 1 << 1,	/* Allocate an id */
};

/*
 * A list of boot stages that we know about. Each of these indicates the
 * state that we are at, and the action that we are about to perform. For
 * errors, we issue an error for an item when it fails. Therefore the
 * normal sequence is:
 *
 * progress action1
 * progress action2
 * progress action3
 *
 * and an error condition where action 3 failed would be:
 *
 * progress action1
 * progress action2
 * progress action3
 * error on action3
 */
enum bootstage_id {
	BOOTSTAGE_ID_START = 0,
	BOOTSTAGE_ID_CHECK_MAGIC,	/* Checking image magic */
	BOOTSTAGE_ID_CHECK_HEADER,	/* Checking image header */
	BOOTSTAGE_ID_CHECK_CHECKSUM,	/* Checking image checksum */
	BOOTSTAGE_ID_CHECK_ARCH,	/* Checking architecture */

	BOOTSTAGE_ID_CHECK_IMAGETYPE = 5,/* Checking image type */
	BOOTSTAGE_ID_DECOMP_IMAGE,	/* Decompressing image */
	BOOTSTAGE_ID_KERNEL_LOADED,	/* Kernel has been loaded */
	BOOTSTAGE_ID_DECOMP_UNIMPL = 7,	/* Odd decompression algorithm */
	BOOTSTAGE_ID_CHECK_BOOT_OS,	/* Calling OS-specific boot function */
	BOOTSTAGE_ID_BOOT_OS_RETURNED,	/* Tried to boot OS, but it returned */
	BOOTSTAGE_ID_CHECK_RAMDISK = 9,	/* Checking ram disk */

	BOOTSTAGE_ID_RD_MAGIC,		/* Checking ram disk magic */
	BOOTSTAGE_ID_RD_HDR_CHECKSUM,	/* Checking ram disk heder checksum */
	BOOTSTAGE_ID_RD_CHECKSUM,	/* Checking ram disk checksum */
	BOOTSTAGE_ID_COPY_RAMDISK = 12,	/* Copying ram disk into place */
	BOOTSTAGE_ID_RAMDISK,		/* Checking for valid ramdisk */
	BOOTSTAGE_ID_NO_RAMDISK,	/* No ram disk found (not an error) */

	BOOTSTAGE_ID_RUN_OS	= 15,	/* Exiting U-Boot, entering OS */

	BOOTSTAGE_ID_NEED_RESET = 30,
	BOOTSTAGE_ID_POST_FAIL,		/* Post failure */
	BOOTSTAGE_ID_POST_FAIL_R,	/* Post failure reported after reloc */

	/*
	 * This set is reported ony by x86, and the meaning is different. In
	 * this case we are reporting completion of a particular stage.
	 * This should probably change in he x86 code (which doesn't report
	 * errors in any case), but discussion this can perhaps wait until we
	 * have a generic board implementation.
	 */
	BOOTSTAGE_ID_BOARD_INIT_R,	/* We have relocated */
	BOOTSTAGE_ID_BOARD_GLOBAL_DATA,	/* Global data is set up */

	BOOTSTAGE_ID_BOARD_INIT_SEQ,	/* We completed the init sequence */
	BOOTSTAGE_ID_BOARD_FLASH,	/* We have configured flash banks */
	BOOTSTAGE_ID_BOARD_FLASH_37,	/* In case you didn't hear... */
	BOOTSTAGE_ID_BOARD_ENV,		/* Environment is relocated & ready */
	BOOTSTAGE_ID_BOARD_PCI,		/* PCI is up */

	BOOTSTAGE_ID_BOARD_INTERRUPTS,	/* Exceptions / interrupts ready */
	BOOTSTAGE_ID_BOARD_DONE,	/* Board init done, off to main loop */
	/* ^^^ here ends the x86 sequence */

	/* Boot stages related to loading a kernel from an IDE device */
	BOOTSTAGE_ID_IDE_START = 41,
	BOOTSTAGE_ID_IDE_ADDR,
	BOOTSTAGE_ID_IDE_BOOT_DEVICE,
	BOOTSTAGE_ID_IDE_TYPE,

	BOOTSTAGE_ID_IDE_PART,
	BOOTSTAGE_ID_IDE_PART_INFO,
	BOOTSTAGE_ID_IDE_PART_TYPE,
	BOOTSTAGE_ID_IDE_PART_READ,
	BOOTSTAGE_ID_IDE_FORMAT,

	BOOTSTAGE_ID_IDE_CHECKSUM,	/* 50 */
	BOOTSTAGE_ID_IDE_READ,

	/* Boot stages related to loading a kernel from an NAND device */
	BOOTSTAGE_ID_NAND_PART,
	BOOTSTAGE_ID_NAND_SUFFIX,
	BOOTSTAGE_ID_NAND_BOOT_DEVICE,
	BOOTSTAGE_ID_NAND_HDR_READ = 55,
	BOOTSTAGE_ID_NAND_AVAILABLE = 55,
	BOOTSTAGE_ID_NAND_TYPE = 57,
	BOOTSTAGE_ID_NAND_READ,

	/* Boot stages related to loading a kernel from an network device */
	BOOTSTAGE_ID_NET_CHECKSUM = 60,
	BOOTSTAGE_ID_NET_ETH_START = 64,
	BOOTSTAGE_ID_NET_ETH_INIT,

	BOOTSTAGE_ID_NET_START = 80,
	BOOTSTAGE_ID_NET_NETLOOP_OK,
	BOOTSTAGE_ID_NET_LOADED,
	BOOTSTAGE_ID_NET_DONE_ERR,
	BOOTSTAGE_ID_NET_DONE,

	/*
	 * Boot stages related to loading a FIT image. Some of these are a
	 * bit wonky.
	 */
	BOOTSTAGE_ID_FIT_FORMAT = 100,
	BOOTSTAGE_ID_FIT_NO_UNIT_NAME,
	BOOTSTAGE_ID_FIT_UNIT_NAME,
	BOOTSTAGE_ID_FIT_CONFIG,
	BOOTSTAGE_ID_FIT_CHECK_SUBIMAGE,
	BOOTSTAGE_ID_FIT_CHECK_HASH = 104,

	BOOTSTAGE_ID_FIT_CHECK_ARCH,
	BOOTSTAGE_ID_FIT_CHECK_KERNEL,
	BOOTSTAGE_ID_FIT_CHECKED,

	BOOTSTAGE_ID_FIT_KERNEL_INFO_ERR = 107,
	BOOTSTAGE_ID_FIT_KERNEL_INFO,
	BOOTSTAGE_ID_FIT_TYPE,

	BOOTSTAGE_ID_FIT_COMPRESSION,
	BOOTSTAGE_ID_FIT_OS,
	BOOTSTAGE_ID_FIT_LOADADDR,
	BOOTSTAGE_ID_OVERWRITTEN,

	BOOTSTAGE_ID_FIT_RD_FORMAT = 120,
	BOOTSTAGE_ID_FIT_RD_FORMAT_OK,
	BOOTSTAGE_ID_FIT_RD_NO_UNIT_NAME,
	BOOTSTAGE_ID_FIT_RD_UNIT_NAME,
	BOOTSTAGE_ID_FIT_RD_SUBNODE,

	BOOTSTAGE_ID_FIT_RD_CHECK,
	BOOTSTAGE_ID_FIT_RD_HASH = 125,
	BOOTSTAGE_ID_FIT_RD_CHECK_ALL,
	BOOTSTAGE_ID_FIT_RD_GET_DATA,
	BOOTSTAGE_ID_FIT_RD_CHECK_ALL_OK = 127,
	BOOTSTAGE_ID_FIT_RD_GET_DATA_OK,
	BOOTSTAGE_ID_FIT_RD_LOAD,

	BOOTSTAGE_ID_IDE_FIT_READ = 140,
	BOOTSTAGE_ID_IDE_FIT_READ_OK,

	BOOTSTAGE_ID_NAND_FIT_READ = 150,
	BOOTSTAGE_ID_NAND_FIT_READ_OK,

	/*
	 * These boot stages are new, higher level, and not directly related
	 * to the old boot progress numbers. They are useful for recording
	 * rough boot timing information.
	 */
	BOOTSTAGE_ID_AWAKE,
	BOOTSTAGE_ID_START_SPL,
	BOOTSTAGE_ID_START_UBOOT_F,
	BOOTSTAGE_ID_START_UBOOT_R,
	BOOTSTAGE_ID_USB_START,
	BOOTSTAGE_ID_ETH_START,
	BOOTSTAGE_ID_BOOTP_START,
	BOOTSTAGE_ID_BOOTP_STOP,
	BOOTSTAGE_ID_BOOTM_START,
	BOOTSTAGE_ID_BOOTM_HANDOFF,
	BOOTSTAGE_ID_MAIN_LOOP,
	BOOTSTAGE_KERNELREAD_START,
	BOOTSTAGE_KERNELREAD_STOP,
	BOOTSTAGE_ID_BOARD_INIT,
	BOOTSTAGE_ID_BOARD_INIT_DONE,

	BOOTSTAGE_ID_CPU_AWAKE,
	BOOTSTAGE_ID_MAIN_CPU_AWAKE,
	BOOTSTAGE_ID_MAIN_CPU_READY,

	BOOTSTAGE_ID_ACCUM_LCD,

	/* a few spare for the user, from here */
	BOOTSTAGE_ID_USER,
	BOOTSTAGE_ID_COUNT = BOOTSTAGE_ID_USER + CONFIG_BOOTSTAGE_USER_COUNT,
	BOOTSTAGE_ID_ALLOC,
};

/*
 * Return the time since boot in microseconds, This is needed for bootstage
 * and should be defined in CPU- or board-specific code. If undefined then
 * millisecond resolution will be used (the standard get_timer()).
 */
ulong timer_get_boot_us(void);

#ifndef CONFIG_SPL_BUILD
/*
 * Board code can implement show_boot_progress() if needed.
 *
 * @param val	Progress state (enum bootstage_id), or -id if an error
 *		has occurred.
 */
void show_boot_progress(int val);
#else
#define show_boot_progress(val) do {} while (0)
#endif

#if defined(CONFIG_BOOTSTAGE) && !defined(CONFIG_SPL_BUILD)
/* This is the full bootstage implementation */

/**
 * Relocate existing bootstage records
 *
 * Call this after relocation has happened and after malloc has been initted.
 * We need to copy any pointers in bootstage records that were added pre-
 * relocation, since memory can be overritten later.
 * @return Always returns 0, to indicate success
 */
int bootstage_relocate(void);

/**
 * Add a new bootstage record
 *
 * @param id	Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC)
 * @param name	Name of record, or NULL for none
 * @param flags	Flags (BOOTSTAGEF_...)
 * @param mark	Time to record in this record, in microseconds
 */
ulong bootstage_add_record(enum bootstage_id id, const char *name,
			   int flags, ulong mark);

/*
 * Mark a time stamp for the current boot stage.
 */
ulong bootstage_mark(enum bootstage_id id);

ulong bootstage_error(enum bootstage_id id);

ulong bootstage_mark_name(enum bootstage_id id, const char *name);

/**
 * Mark the start of a bootstage activity. The end will be marked later with
 * bootstage_accum() and at that point we accumulate the time taken. Calling
 * this function turns the given id into a accumulator rather than and
 * absolute mark in time. Accumulators record the total amount of time spent
 * in an activty during boot.
 *
 * @param id	Bootstage id to record this timestamp against
 * @param name	Textual name to display for this id in the report (maybe NULL)
 * @return start timestamp in microseconds
 */
uint32_t bootstage_start(enum bootstage_id id, const char *name);

/**
 * Mark the end of a bootstage activity
 *
 * After previously marking the start of an activity with bootstage_start(),
 * call this function to mark the end. You can call these functions in pairs
 * as many times as you like.
 *
 * @param id	Bootstage id to record this timestamp against
 * @return time spent in this iteration of the activity (i.e. the time now
 *		less the start time recorded in the last bootstage_start() call
 *		with this id.
 */
uint32_t bootstage_accum(enum bootstage_id id);

/* Print a report about boot time */
void bootstage_report(void);

/**
 * Add bootstage information to the device tree
 *
 * @return 0 if ok, -ve on error
 */
int bootstage_fdt_add_report(void);

/*
 * Stash bootstage data into memory
 *
 * @param base	Base address of memory buffer
 * @param size	Size of memory buffer
 * @return 0 if stashed ok, -1 if out of space
 */
int bootstage_stash(void *base, int size);

/**
 * Read bootstage data from memory
 *
 * Bootstage data is read from memory and placed in the bootstage table
 * in the user records.
 *
 * @param base	Base address of memory buffer
 * @param size	Size of memory buffer (-1 if unknown)
 * @return 0 if unstashed ok, -1 if bootstage info not found, or out of space
 */
int bootstage_unstash(void *base, int size);

#else
static inline ulong bootstage_add_record(enum bootstage_id id,
		const char *name, int flags, ulong mark)
{
	return 0;
}

/*
 * This is a dummy implementation which just calls show_boot_progress(),
 * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
 */

static inline int bootstage_relocate(void)
{
	return 0;
}

static inline ulong bootstage_mark(enum bootstage_id id)
{
	show_boot_progress(id);
	return 0;
}

static inline ulong bootstage_error(enum bootstage_id id)
{
	show_boot_progress(-id);
	return 0;
}

static inline ulong bootstage_mark_name(enum bootstage_id id, const char *name)
{
	return 0;
}

static inline uint32_t bootstage_start(enum bootstage_id id, const char *name)
{
	return 0;
}

static inline uint32_t bootstage_accum(enum bootstage_id id)
{
	return 0;
}

static inline int bootstage_stash(void *base, int size)
{
	return 0;	/* Pretend to succeed */
}

static inline int bootstage_unstash(void *base, int size)
{
	return 0;	/* Pretend to succeed */
}
#endif /* CONFIG_BOOTSTAGE */

#endif
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.
	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
3a608ca0 SG	29	/* The number of boot stage records available for the user */
	30	#ifndef CONFIG_BOOTSTAGE_USER_COUNT
	31	#define CONFIG_BOOTSTAGE_USER_COUNT 20
	32	#endif
	33
094e06a5 SG	34	/* Flags for each bootstage record */
	35	enum bootstage_flags {
	36	BOOTSTAGEF_ERROR = 1 << 0, /* Error record */
	37	BOOTSTAGEF_ALLOC = 1 << 1, /* Allocate an id */
	38	};
	39
097e1783 SG	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 {
5dc88716 SG	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
5e410883 SG	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
097e1783	79	BOOTSTAGE_ID_RUN_OS = 15, /* Exiting U-Boot, entering OS */
8ade9506 SG	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 ony 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 he 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
90e153d7 SG	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,
cd24a6bf SG	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
c8e66db7 SG	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
aacc8c16 SG	140	/*
	141	* Boot stages related to loading a FIT image. Some of these are a
	142	* bit wonky.
	143	*/
	144	BOOTSTAGE_ID_FIT_FORMAT = 100,
	145	BOOTSTAGE_ID_FIT_NO_UNIT_NAME,
	146	BOOTSTAGE_ID_FIT_UNIT_NAME,
	147	BOOTSTAGE_ID_FIT_CONFIG,
	148	BOOTSTAGE_ID_FIT_CHECK_SUBIMAGE,
	149	BOOTSTAGE_ID_FIT_CHECK_HASH = 104,
	150
	151	BOOTSTAGE_ID_FIT_CHECK_ARCH,
	152	BOOTSTAGE_ID_FIT_CHECK_KERNEL,
	153	BOOTSTAGE_ID_FIT_CHECKED,
	154
	155	BOOTSTAGE_ID_FIT_KERNEL_INFO_ERR = 107,
	156	BOOTSTAGE_ID_FIT_KERNEL_INFO,
	157	BOOTSTAGE_ID_FIT_TYPE,
	158
	159	BOOTSTAGE_ID_FIT_COMPRESSION,
	160	BOOTSTAGE_ID_FIT_OS,
	161	BOOTSTAGE_ID_FIT_LOADADDR,
	162	BOOTSTAGE_ID_OVERWRITTEN,
	163
	164	BOOTSTAGE_ID_FIT_RD_FORMAT = 120,
	165	BOOTSTAGE_ID_FIT_RD_FORMAT_OK,
	166	BOOTSTAGE_ID_FIT_RD_NO_UNIT_NAME,
	167	BOOTSTAGE_ID_FIT_RD_UNIT_NAME,
	168	BOOTSTAGE_ID_FIT_RD_SUBNODE,
	169
	170	BOOTSTAGE_ID_FIT_RD_CHECK,
	171	BOOTSTAGE_ID_FIT_RD_HASH = 125,
	172	BOOTSTAGE_ID_FIT_RD_CHECK_ALL,
	173	BOOTSTAGE_ID_FIT_RD_GET_DATA,
	174	BOOTSTAGE_ID_FIT_RD_CHECK_ALL_OK = 127,
	175	BOOTSTAGE_ID_FIT_RD_GET_DATA_OK,
	176	BOOTSTAGE_ID_FIT_RD_LOAD,
	177
cd24a6bf SG	178	BOOTSTAGE_ID_IDE_FIT_READ = 140,
	179	BOOTSTAGE_ID_IDE_FIT_READ_OK,
	180
	181	BOOTSTAGE_ID_NAND_FIT_READ = 150,
	182	BOOTSTAGE_ID_NAND_FIT_READ_OK,
3a608ca0 SG	183
	184	/*
	185	* These boot stages are new, higher level, and not directly related
	186	* to the old boot progress numbers. They are useful for recording
	187	* rough boot timing information.
	188	*/
	189	BOOTSTAGE_ID_AWAKE,
996e95d4	190	BOOTSTAGE_ID_START_SPL,
3a608ca0 SG	191	BOOTSTAGE_ID_START_UBOOT_F,
	192	BOOTSTAGE_ID_START_UBOOT_R,
	193	BOOTSTAGE_ID_USB_START,
	194	BOOTSTAGE_ID_ETH_START,
	195	BOOTSTAGE_ID_BOOTP_START,
	196	BOOTSTAGE_ID_BOOTP_STOP,
	197	BOOTSTAGE_ID_BOOTM_START,
	198	BOOTSTAGE_ID_BOOTM_HANDOFF,
	199	BOOTSTAGE_ID_MAIN_LOOP,
	200	BOOTSTAGE_KERNELREAD_START,
	201	BOOTSTAGE_KERNELREAD_STOP,
996e95d4 SG	202	BOOTSTAGE_ID_BOARD_INIT,
996e95d4 SG	203	BOOTSTAGE_ID_BOARD_INIT_DONE,
3a608ca0 SG	204
	205	BOOTSTAGE_ID_CPU_AWAKE,
	206	BOOTSTAGE_ID_MAIN_CPU_AWAKE,
	207	BOOTSTAGE_ID_MAIN_CPU_READY,
	208
996e95d4 SG	209	BOOTSTAGE_ID_ACCUM_LCD,
996e95d4 SG	210
3a608ca0 SG	211	/* a few spare for the user, from here */
	212	BOOTSTAGE_ID_USER,
	213	BOOTSTAGE_ID_COUNT = BOOTSTAGE_ID_USER + CONFIG_BOOTSTAGE_USER_COUNT,
	214	BOOTSTAGE_ID_ALLOC,
097e1783 SG	215	};
097e1783 SG	216
3786980d SG	217	/*
	218	* Return the time since boot in microseconds, This is needed for bootstage
	219	* and should be defined in CPU- or board-specific code. If undefined then
	220	* millisecond resolution will be used (the standard get_timer()).
	221	*/
	222	ulong timer_get_boot_us(void);
	223
7ac2fe2d	224	#ifndef CONFIG_SPL_BUILD
097e1783 SG	225	/*
	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 IY	232	#else
	233	#define show_boot_progress(val) do {} while (0)
	234	#endif
770605e4	235
7ac2fe2d	236	#if defined(CONFIG_BOOTSTAGE) && !defined(CONFIG_SPL_BUILD)
770605e4 SG	237	/* This is the full bootstage implementation */
770605e4 SG	238
150678a5 DA	239	/**
	240	* Relocate existing bootstage records
	241	*
	242	* Call this after relocation has happened and after malloc has been initted.
	243	* We need to copy any pointers in bootstage records that were added pre-
	244	* relocation, since memory can be overritten later.
	245	* @return Always returns 0, to indicate success
	246	*/
	247	int bootstage_relocate(void);
	248
094e06a5 SG	249	/**
	250	* Add a new bootstage record
	251	*
	252	* @param id Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC)
	253	* @param name Name of record, or NULL for none
	254	* @param flags Flags (BOOTSTAGEF_...)
	255	* @param mark Time to record in this record, in microseconds
	256	*/
	257	ulong bootstage_add_record(enum bootstage_id id, const char *name,
	258	int flags, ulong mark);
	259
770605e4 SG	260	/*
	261	* Mark a time stamp for the current boot stage.
	262	*/
	263	ulong bootstage_mark(enum bootstage_id id);
	264
	265	ulong bootstage_error(enum bootstage_id id);
	266
3a608ca0 SG	267	ulong bootstage_mark_name(enum bootstage_id id, const char *name);
3a608ca0 SG	268
0e996773 SG	269	/**
	270	* Mark the start of a bootstage activity. The end will be marked later with
	271	* bootstage_accum() and at that point we accumulate the time taken. Calling
	272	* this function turns the given id into a accumulator rather than and
	273	* absolute mark in time. Accumulators record the total amount of time spent
	274	* in an activty during boot.
	275	*
	276	* @param id Bootstage id to record this timestamp against
	277	* @param name Textual name to display for this id in the report (maybe NULL)
	278	* @return start timestamp in microseconds
	279	*/
	280	uint32_t bootstage_start(enum bootstage_id id, const char *name);
	281
	282	/**
	283	* Mark the end of a bootstage activity
	284	*
	285	* After previously marking the start of an activity with bootstage_start(),
	286	* call this function to mark the end. You can call these functions in pairs
	287	* as many times as you like.
	288	*
	289	* @param id Bootstage id to record this timestamp against
	290	* @return time spent in this iteration of the activity (i.e. the time now
	291	* less the start time recorded in the last bootstage_start() call
	292	* with this id.
	293	*/
	294	uint32_t bootstage_accum(enum bootstage_id id);
	295
3a608ca0 SG	296	/* Print a report about boot time */
	297	void bootstage_report(void);
	298
94fd1316 SG	299	/**
	300	* Add bootstage information to the device tree
	301	*
	302	* @return 0 if ok, -ve on error
	303	*/
	304	int bootstage_fdt_add_report(void);
	305
fcf509b8 SG	306	/*
	307	* Stash bootstage data into memory
	308	*
	309	* @param base Base address of memory buffer
	310	* @param size Size of memory buffer
	311	* @return 0 if stashed ok, -1 if out of space
	312	*/
	313	int bootstage_stash(void *base, int size);
	314
	315	/**
	316	* Read bootstage data from memory
	317	*
	318	* Bootstage data is read from memory and placed in the bootstage table
	319	* in the user records.
	320	*
	321	* @param base Base address of memory buffer
	322	* @param size Size of memory buffer (-1 if unknown)
	323	* @return 0 if unstashed ok, -1 if bootstage info not found, or out of space
	324	*/
	325	int bootstage_unstash(void *base, int size);
	326
770605e4	327	#else
e802ee0f SG	328	static inline ulong bootstage_add_record(enum bootstage_id id,
	329	const char *name, int flags, ulong mark)
	330	{
	331	return 0;
	332	}
	333
770605e4 SG	334	/*
	335	* This is a dummy implementation which just calls show_boot_progress(),
	336	* and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
	337	*/
	338
150678a5 DA	339	static inline int bootstage_relocate(void)
	340	{
	341	return 0;
	342	}
	343
770605e4 SG	344	static inline ulong bootstage_mark(enum bootstage_id id)
	345	{
	346	show_boot_progress(id);
	347	return 0;
	348	}
	349
	350	static inline ulong bootstage_error(enum bootstage_id id)
5ddb118d	351	{
770605e4 SG	352	show_boot_progress(-id);
770605e4 SG	353	return 0;
5ddb118d	354	}
097e1783	355
3a608ca0 SG	356	static inline ulong bootstage_mark_name(enum bootstage_id id, const char *name)
	357	{
	358	return 0;
	359	}
	360
e802ee0f SG	361	static inline uint32_t bootstage_start(enum bootstage_id id, const char *name)
	362	{
	363	return 0;
	364	}
	365
	366	static inline uint32_t bootstage_accum(enum bootstage_id id)
	367	{
	368	return 0;
	369	}
	370
fcf509b8 SG	371	static inline int bootstage_stash(void *base, int size)
	372	{
	373	return 0; /* Pretend to succeed */
	374	}
3a608ca0	375
fcf509b8 SG	376	static inline int bootstage_unstash(void *base, int size)
	377	{
	378	return 0; /* Pretend to succeed */
	379	}
770605e4 SG	380	#endif /* CONFIG_BOOTSTAGE */
770605e4 SG	381
097e1783	382	#endif