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

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * 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.
 * Note that it requires timer_get_boot_us() to be defined by the board
 *
 * Copyright (c) 2011 The Chromium OS Authors.
 */

#ifndef _BOOTSTAGE_H
#define _BOOTSTAGE_H

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

/* bootstate sub-IDs used for kernel and ramdisk ranges */
enum {
	BOOTSTAGE_SUB_FORMAT,
	BOOTSTAGE_SUB_FORMAT_OK,
	BOOTSTAGE_SUB_NO_UNIT_NAME,
	BOOTSTAGE_SUB_UNIT_NAME,
	BOOTSTAGE_SUB_SUBNODE,

	BOOTSTAGE_SUB_CHECK,
	BOOTSTAGE_SUB_HASH = 5,
	BOOTSTAGE_SUB_CHECK_ARCH = 5,
	BOOTSTAGE_SUB_CHECK_ALL,
	BOOTSTAGE_SUB_GET_DATA,
	BOOTSTAGE_SUB_CHECK_ALL_OK = 7,
	BOOTSTAGE_SUB_GET_DATA_OK,
	BOOTSTAGE_SUB_LOAD,
};

/*
 * 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 only by x86, and the meaning is different. In
	 * this case we are reporting completion of a particular stage.
	 * This should probably change in the 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,

	BOOTSTAGE_ID_FIT_FDT_START = 90,
	/*
	 * Boot stages related to loading a FIT image. Some of these are a
	 * bit wonky.
	 */
	BOOTSTAGE_ID_FIT_KERNEL_START = 100,

	BOOTSTAGE_ID_FIT_CONFIG = 110,
	BOOTSTAGE_ID_FIT_TYPE,
	BOOTSTAGE_ID_FIT_KERNEL_INFO,

	BOOTSTAGE_ID_FIT_COMPRESSION,
	BOOTSTAGE_ID_FIT_OS,
	BOOTSTAGE_ID_FIT_LOADADDR,
	BOOTSTAGE_ID_OVERWRITTEN,

	/* Next 10 IDs used by BOOTSTAGE_SUB_... */
	BOOTSTAGE_ID_FIT_RD_START = 120,	/* Ramdisk stages */

	/* Next 10 IDs used by BOOTSTAGE_SUB_... */
	BOOTSTAGE_ID_FIT_SETUP_START = 130,	/* x86 setup stages */

	BOOTSTAGE_ID_IDE_FIT_READ = 140,
	BOOTSTAGE_ID_IDE_FIT_READ_OK,

	BOOTSTAGE_ID_NAND_FIT_READ = 150,
	BOOTSTAGE_ID_NAND_FIT_READ_OK,

	BOOTSTAGE_ID_FIT_LOADABLE_START = 160,	/* for Loadable Images */
	/*
	 * 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_TPL,
	BOOTSTAGE_ID_END_TPL,
	BOOTSTAGE_ID_START_SPL,
	BOOTSTAGE_ID_END_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_ID_ENTER_CLI_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,
	BOOTSTAGE_ID_ACCUM_SCSI,
	BOOTSTAGE_ID_ACCUM_SPI,
	BOOTSTAGE_ID_ACCUM_DECOMP,
	BOOTSTAGE_ID_ACCUM_OF_LIVE,
	BOOTSTAGE_ID_FPGA_INIT,
	BOOTSTAGE_ID_ACCUM_DM_SPL,
	BOOTSTAGE_ID_ACCUM_DM_F,
	BOOTSTAGE_ID_ACCUM_DM_R,
	BOOTSTAGE_ID_ACCUM_FSP_M,
	BOOTSTAGE_ID_ACCUM_FSP_S,
	BOOTSTAGE_ID_ACCUM_MMAP_SPI,

	/* a few spare for the user, from here */
	BOOTSTAGE_ID_USER,
	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
 * you will get a link error.
 */
ulong timer_get_boot_us(void);

#if defined(USE_HOSTCC)
#define show_boot_progress(val) do {} while (0)
#else
/**
 * 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);
#endif

#if !defined(USE_HOSTCC)
#if CONFIG_IS_ENABLED(BOOTSTAGE)
#define ENABLE_BOOTSTAGE
#endif
#endif

#ifdef ENABLE_BOOTSTAGE

/* 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 overwritten 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 a time stamp in the given function and line number
 *
 * See BOOTSTAGE_MARKER() for a convenient macro.
 *
 * @param file		Filename to record (NULL if none)
 * @param func		Function name to record
 * @param linenum	Line number to record
 * @return recorded time stamp
 */
ulong bootstage_mark_code(const char *file, const char *func,
			  int linenum);

/**
 * 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, -ENOENT if bootstage info not found, -ENOSPC if
 *	there is not space for read the stacked data, or other error if
 *	something else went wrong
 */
int bootstage_unstash(const void *base, int size);

/**
 * bootstage_get_size() - Get the size of the bootstage data
 *
 * @return size of boostage data in bytes
 */
int bootstage_get_size(void);

/**
 * bootstage_init() - Prepare bootstage for use
 *
 * @first: true if this is the first time bootstage is set up. This causes it
 *	to add a 'reset' record with a time of 0.
 */
int bootstage_init(bool first);

#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)
{
	show_boot_progress(id);
	return 0;
}

static inline ulong bootstage_mark_code(const char *file, const char *func,
					int linenum)
{
	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(const void *base, int size)
{
	return 0;	/* Pretend to succeed */
}

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

static inline int bootstage_init(bool first)
{
	return 0;
}

#endif /* ENABLE_BOOTSTAGE */

/* Helper macro for adding a bootstage to a line of code */
#define BOOTSTAGE_MARKER()	\
		bootstage_mark_code(__FILE__, __func__, __LINE__)

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