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