include/bootstage.h

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