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