[J-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

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