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
 151         BOOTSTAGE_ID_FIT_COMPRESSION,
 152         BOOTSTAGE_ID_FIT_OS,
 153         BOOTSTAGE_ID_FIT_LOADADDR,
 154         BOOTSTAGE_ID_OVERWRITTEN,
 155
 156         /* Next 10 IDs used by BOOTSTAGE_SUB_... */
 157         BOOTSTAGE_ID_FIT_RD_START = 120,        /* Ramdisk stages */
 158
 159         /* Next 10 IDs used by BOOTSTAGE_SUB_... */
 160         BOOTSTAGE_ID_FIT_SETUP_START = 130,     /* x86 setup stages */
 161
 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,
 167
 168         BOOTSTAGE_ID_FIT_LOADABLE_START = 160,  /* for Loadable Images */
 169
 170         BOOTSTAGE_ID_FIT_SPL_START = 170,       /* for SPL Images */
 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_TPL,
 178         BOOTSTAGE_ID_END_TPL,
 179         BOOTSTAGE_ID_START_SPL,
 180         BOOTSTAGE_ID_END_SPL,
 181         BOOTSTAGE_ID_START_VPL,
 182         BOOTSTAGE_ID_END_VPL,
 183         BOOTSTAGE_ID_START_UBOOT_F,
 184         BOOTSTAGE_ID_START_UBOOT_R,
 185         BOOTSTAGE_ID_USB_START,
 186         BOOTSTAGE_ID_ETH_START,
 187         BOOTSTAGE_ID_BOOTP_START,
 188         BOOTSTAGE_ID_BOOTP_STOP,
 189         BOOTSTAGE_ID_BOOTM_START,
 190         BOOTSTAGE_ID_BOOTM_HANDOFF,
 191         BOOTSTAGE_ID_MAIN_LOOP,
 192         BOOTSTAGE_ID_ENTER_CLI_LOOP,
 193         BOOTSTAGE_KERNELREAD_START,
 194         BOOTSTAGE_KERNELREAD_STOP,
 195         BOOTSTAGE_ID_BOARD_INIT,
 196         BOOTSTAGE_ID_BOARD_INIT_DONE,
 197
 198         BOOTSTAGE_ID_CPU_AWAKE,
 199         BOOTSTAGE_ID_MAIN_CPU_AWAKE,
 200         BOOTSTAGE_ID_MAIN_CPU_READY,
 201
 202         BOOTSTAGE_ID_ACCUM_LCD,
 203         BOOTSTAGE_ID_ACCUM_SCSI,
 204         BOOTSTAGE_ID_ACCUM_SPI,
 205         BOOTSTAGE_ID_ACCUM_DECOMP,
 206         BOOTSTAGE_ID_ACCUM_OF_LIVE,
 207         BOOTSTAGE_ID_FPGA_INIT,
 208         BOOTSTAGE_ID_ACCUM_DM_SPL,
 209         BOOTSTAGE_ID_ACCUM_DM_F,
 210         BOOTSTAGE_ID_ACCUM_DM_R,
 211         BOOTSTAGE_ID_ACCUM_FSP_M,
 212         BOOTSTAGE_ID_ACCUM_FSP_S,
 213         BOOTSTAGE_ID_ACCUM_MMAP_SPI,
 214
 215         /* a few spare for the user, from here */
 216         BOOTSTAGE_ID_USER,
 217         BOOTSTAGE_ID_ALLOC,
 218 };
 219
 220 /*
 221  * Return the time since boot in microseconds, This is needed for bootstage
 222  * and should be defined in CPU- or board-specific code. If undefined then
 223  * you will get a link error.
 224  */
 225 ulong timer_get_boot_us(void);
 226
 227 #if defined(USE_HOSTCC) || !CONFIG_IS_ENABLED(SHOW_BOOT_PROGRESS)
 228 #define show_boot_progress(val) do {} while (0)
 229 #else
 230 /**
 231  * Board code can implement show_boot_progress() if needed.
 232  *
 233  * @param val   Progress state (enum bootstage_id), or -id if an error
 234  *              has occurred.
 235  */
 236 void show_boot_progress(int val);
 237 #endif
 238
 239 #if !defined(USE_HOSTCC)
 240 #if CONFIG_IS_ENABLED(BOOTSTAGE)
 241 #define ENABLE_BOOTSTAGE
 242 #endif
 243 #endif
 244
 245 #ifdef ENABLE_BOOTSTAGE
 246
 247 #include <mapmem.h>
 248
 249 /* This is the full bootstage implementation */
 250
 251 /**
 252  * Relocate existing bootstage records
 253  *
 254  * Call this after relocation has happened and after malloc has been initted.
 255  * We need to copy any pointers in bootstage records that were added pre-
 256  * relocation, since memory can be overwritten later.
 257  * Return: Always returns 0, to indicate success
 258  */
 259 int bootstage_relocate(void);
 260
 261 /**
 262  * Add a new bootstage record
 263  *
 264  * @param id    Bootstage ID to use (ignored if flags & BOOTSTAGEF_ALLOC)
 265  * @param name  Name of record, or NULL for none
 266  * @param flags Flags (BOOTSTAGEF_...)
 267  * @param mark  Time to record in this record, in microseconds
 268  */
 269 ulong bootstage_add_record(enum bootstage_id id, const char *name,
 270                            int flags, ulong mark);
 271
 272 /**
 273  * Mark a time stamp for the current boot stage.
 274  */
 275 #define bootstage_mark(id)      bootstage_mark_name(id, __func__)
 276 #define bootstage_error(id)     bootstage_error_name(id, __func__)
 277
 278 /**
 279  * bootstage_mark_name - record bootstage with passing id and name
 280  * @id: Bootstage id to record this timestamp against
 281  * @name: Textual name to display for this id in the report
 282  *
 283  * Return: recorded time stamp
 284  */
 285 ulong bootstage_mark_name(enum bootstage_id id, const char *name);
 286
 287 /**
 288  * bootstage_error_name - record bootstage error with passing id and name
 289  * @id: Bootstage id to record this timestamp against
 290  * @name: Textual name to display for this id in the report
 291  *
 292  * Return: recorded time stamp
 293  */
 294 ulong bootstage_error_name(enum bootstage_id id, const char *name);
 295
 296 /**
 297  * Mark a time stamp in the given function and line number
 298  *
 299  * See BOOTSTAGE_MARKER() for a convenient macro.
 300  *
 301  * @param file          Filename to record (NULL if none)
 302  * @param func          Function name to record
 303  * @param linenum       Line number to record
 304  * Return: recorded time stamp
 305  */
 306 ulong bootstage_mark_code(const char *file, const char *func,
 307                           int linenum);
 308
 309 /**
 310  * Mark the start of a bootstage activity. The end will be marked later with
 311  * bootstage_accum() and at that point we accumulate the time taken. Calling
 312  * this function turns the given id into a accumulator rather than and
 313  * absolute mark in time. Accumulators record the total amount of time spent
 314  * in an activty during boot.
 315  *
 316  * @param id    Bootstage id to record this timestamp against
 317  * @param name  Textual name to display for this id in the report (maybe NULL)
 318  * Return: start timestamp in microseconds
 319  */
 320 uint32_t bootstage_start(enum bootstage_id id, const char *name);
 321
 322 /**
 323  * Mark the end of a bootstage activity
 324  *
 325  * After previously marking the start of an activity with bootstage_start(),
 326  * call this function to mark the end. You can call these functions in pairs
 327  * as many times as you like.
 328  *
 329  * @param id    Bootstage id to record this timestamp against
 330  * Return: time spent in this iteration of the activity (i.e. the time now
 331  *              less the start time recorded in the last bootstage_start() call
 332  *              with this id.
 333  */
 334 uint32_t bootstage_accum(enum bootstage_id id);
 335
 336 /* Print a report about boot time */
 337 void bootstage_report(void);
 338
 339 /**
 340  * Add bootstage information to the device tree
 341  *
 342  * Return: 0 if ok, -ve on error
 343  */
 344 int bootstage_fdt_add_report(void);
 345
 346 /**
 347  * Stash bootstage data into memory
 348  *
 349  * @param base  Base address of memory buffer
 350  * @param size  Size of memory buffer
 351  * Return: 0 if stashed ok, -1 if out of space
 352  */
 353 int bootstage_stash(void *base, int size);
 354
 355 /**
 356  * Read bootstage data from memory
 357  *
 358  * Bootstage data is read from memory and placed in the bootstage table
 359  * in the user records.
 360  *
 361  * @param base  Base address of memory buffer
 362  * @param size  Size of memory buffer (-1 if unknown)
 363  * Return: 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if
 364  *      there is not space for read the stashed data, or other error if
 365  *      something else went wrong
 366  */
 367 int bootstage_unstash(const void *base, int size);
 368
 369 /**
 370  * bootstage_get_size() - Get the size of the bootstage data
 371  *
 372  * Return: size of boostage data in bytes
 373  */
 374 int bootstage_get_size(void);
 375
 376 /**
 377  * bootstage_init() - Prepare bootstage for use
 378  *
 379  * @first: true if this is the first time bootstage is set up. This causes it
 380  *      to add a 'reset' record with a time of 0.
 381  */
 382 int bootstage_init(bool first);
 383
 384 #else
 385 static inline ulong bootstage_add_record(enum bootstage_id id,
 386                 const char *name, int flags, ulong mark)
 387 {
 388         return 0;
 389 }
 390
 391 /*
 392  * This is a dummy implementation which just calls show_boot_progress(),
 393  * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
 394  */
 395
 396 static inline int bootstage_relocate(void)
 397 {
 398         return 0;
 399 }
 400
 401 static inline ulong bootstage_mark(enum bootstage_id id)
 402 {
 403         show_boot_progress(id);
 404         return 0;
 405 }
 406
 407 static inline ulong bootstage_error(enum bootstage_id id)
 408 {
 409         show_boot_progress(-id);
 410         return 0;
 411 }
 412
 413 static inline ulong bootstage_mark_name(enum bootstage_id id, const char *name)
 414 {
 415         show_boot_progress(id);
 416         return 0;
 417 }
 418
 419 static inline ulong bootstage_mark_code(const char *file, const char *func,
 420                                         int linenum)
 421 {
 422         return 0;
 423 }
 424
 425 static inline uint32_t bootstage_start(enum bootstage_id id, const char *name)
 426 {
 427         return 0;
 428 }
 429
 430 static inline uint32_t bootstage_accum(enum bootstage_id id)
 431 {
 432         return 0;
 433 }
 434
 435 static inline int bootstage_stash(void *base, int size)
 436 {
 437         return 0;       /* Pretend to succeed */
 438 }
 439
 440 static inline int bootstage_unstash(const void *base, int size)
 441 {
 442         return 0;       /* Pretend to succeed */
 443 }
 444
 445 static inline int bootstage_get_size(void)
 446 {
 447         return 0;
 448 }
 449
 450 static inline int bootstage_init(bool first)
 451 {
 452         return 0;
 453 }
 454
 455 #endif /* ENABLE_BOOTSTAGE */
 456
 457 /* helpers for SPL */
 458 int _bootstage_stash_default(void);
 459 int _bootstage_unstash_default(void);
 460
 461 static inline int bootstage_stash_default(void)
 462 {
 463         if (CONFIG_IS_ENABLED(BOOTSTAGE) && IS_ENABLED(CONFIG_BOOTSTAGE_STASH))
 464                 return _bootstage_stash_default();
 465
 466         return 0;
 467 }
 468
 469 static inline int bootstage_unstash_default(void)
 470 {
 471         if (CONFIG_IS_ENABLED(BOOTSTAGE) && IS_ENABLED(CONFIG_BOOTSTAGE_STASH))
 472                 return _bootstage_unstash_default();
 473
 474         return 0;
 475 }
 476
 477 /* Helper macro for adding a bootstage to a line of code */
 478 #define BOOTSTAGE_MARKER()      \
 479                 bootstage_mark_code(__FILE__, __func__, __LINE__)
 480
 481 #endif