include/bootstage.h

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