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