include/asm-generic/global_data.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (c) 2012 The Chromium OS Authors.
   4  * (C) Copyright 2002-2010
   5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   6  */
   7
   8 #ifndef __ASM_GENERIC_GBL_DATA_H
   9 #define __ASM_GENERIC_GBL_DATA_H
  10 /*
  11  * The following data structure is placed in some memory which is
  12  * available very early after boot (like DPRAM on MPC8xx/MPC82xx, or
  13  * some locked parts of the data cache) to allow for a minimum set of
  14  * global variables during system initialization (until we have set
  15  * up the memory controller so that we can use RAM).
  16  *
  17  * Keep it *SMALL* and remember to set GENERATED_GBL_DATA_SIZE > sizeof(gd_t)
  18  *
  19  * Each architecture has its own private fields. For now all are private
  20  */
  21
  22 #ifndef __ASSEMBLY__
  23 #include <event_internal.h>
  24 #include <fdtdec.h>
  25 #include <membuff.h>
  26 #include <linux/list.h>
  27 #include <linux/build_bug.h>
  28 #include <asm-offsets.h>
  29
  30 struct acpi_ctx;
  31 struct driver_rt;
  32
  33 typedef struct global_data gd_t;
  34
  35 /**
  36  * struct global_data - global data structure
  37  */
  38 struct global_data {
  39         /**
  40          * @bd: board information
  41          */
  42         struct bd_info *bd;
  43         /**
  44          * @flags: global data flags
  45          *
  46          * See &enum gd_flags
  47          */
  48         unsigned long flags;
  49         /**
  50          * @baudrate: baud rate of the serial interface
  51          */
  52         unsigned int baudrate;
  53         /**
  54          * @cpu_clk: CPU clock rate in Hz
  55          */
  56         unsigned long cpu_clk;
  57         /**
  58          * @bus_clk: platform clock rate in Hz
  59          */
  60         unsigned long bus_clk;
  61         /**
  62          * @pci_clk: PCI clock rate in Hz
  63          */
  64         /* We cannot bracket this with CONFIG_PCI due to mpc5xxx */
  65         unsigned long pci_clk;
  66         /**
  67          * @mem_clk: memory clock rate in Hz
  68          */
  69         unsigned long mem_clk;
  70 #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO)
  71         /**
  72          * @fb_base: base address of frame buffer memory
  73          */
  74         unsigned long fb_base;
  75 #endif
  76 #if defined(CONFIG_POST)
  77         /**
  78          * @post_log_word: active POST tests
  79          *
  80          * @post_log_word is a bit mask defining which POST tests are recorded
  81          * (see constants POST_*).
  82          */
  83         unsigned long post_log_word;
  84         /**
  85          * @post_log_res: POST results
  86          *
  87          * @post_log_res is a bit mask with the POST results. A bit with value 1
  88          * indicates successful execution.
  89          */
  90         unsigned long post_log_res;
  91         /**
  92          * @post_init_f_time: time in ms when post_init_f() started
  93          */
  94         unsigned long post_init_f_time;
  95 #endif
  96 #ifdef CONFIG_BOARD_TYPES
  97         /**
  98          * @board_type: board type
  99          *
 100          * If a U-Boot configuration supports multiple board types, the actual
 101          * board type may be stored in this field.
 102          */
 103         unsigned long board_type;
 104 #endif
 105         /**
 106          * @have_console: console is available
 107          *
 108          * A value of 1 indicates that serial_init() was called and a console
 109          * is available.
 110          * A value of 0 indicates that console input and output drivers shall
 111          * not be called.
 112          */
 113         unsigned long have_console;
 114 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
 115         /**
 116          * @precon_buf_idx: pre-console buffer index
 117          *
 118          * @precon_buf_idx indicates the current position of the buffer used to
 119          * collect output before the console becomes available
 120          */
 121         unsigned long precon_buf_idx;
 122 #endif
 123         /**
 124          * @env_addr: address of environment structure
 125          *
 126          * @env_addr contains the address of the structure holding the
 127          * environment variables.
 128          */
 129         unsigned long env_addr;
 130         /**
 131          * @env_valid: environment is valid
 132          *
 133          * See &enum env_valid
 134          */
 135         unsigned long env_valid;
 136         /**
 137          * @env_has_init: bit mask indicating environment locations
 138          *
 139          * &enum env_location defines which bit relates to which location
 140          */
 141         unsigned long env_has_init;
 142         /**
 143          * @env_load_prio: priority of the loaded environment
 144          */
 145         int env_load_prio;
 146         /**
 147          * @ram_base: base address of RAM used by U-Boot
 148          */
 149         unsigned long ram_base;
 150         /**
 151          * @ram_top: top address of RAM used by U-Boot
 152          */
 153         phys_addr_t ram_top;
 154         /**
 155          * @relocaddr: start address of U-Boot in RAM
 156          *
 157          * After relocation this field indicates the address to which U-Boot
 158          * has been relocated. It can be displayed using the bdinfo command.
 159          * Its value is needed to display the source code when debugging with
 160          * GDB using the 'add-symbol-file u-boot <relocaddr>' command.
 161          */
 162         unsigned long relocaddr;
 163         /**
 164          * @ram_size: RAM size in bytes
 165          */
 166         phys_size_t ram_size;
 167         /**
 168          * @mon_len: monitor length in bytes
 169          */
 170         unsigned long mon_len;
 171         /**
 172          * @irq_sp: IRQ stack pointer
 173          */
 174         unsigned long irq_sp;
 175         /**
 176          * @start_addr_sp: initial stack pointer address
 177          */
 178         unsigned long start_addr_sp;
 179         /**
 180          * @reloc_off: relocation offset
 181          */
 182         unsigned long reloc_off;
 183         /**
 184          * @new_gd: pointer to relocated global data
 185          */
 186         struct global_data *new_gd;
 187
 188 #ifdef CONFIG_DM
 189         /**
 190          * @dm_root: root instance for Driver Model
 191          */
 192         struct udevice *dm_root;
 193         /**
 194          * @dm_root_f: pre-relocation root instance
 195          */
 196         struct udevice *dm_root_f;
 197         /**
 198          * @uclass_root_s:
 199          * head of core tree when uclasses are not in read-only memory.
 200          *
 201          * When uclasses are in read-only memory, @uclass_root_s is not used and
 202          * @uclass_root points to the root node generated by dtoc.
 203          */
 204         struct list_head uclass_root_s;
 205         /**
 206          * @uclass_root:
 207          * pointer to head of core tree, if uclasses are in read-only memory and
 208          * cannot be adjusted to use @uclass_root as a list head.
 209          *
 210          * When not in read-only memory, @uclass_root_s is used to hold the
 211          * uclass root, and @uclass_root points to the address of
 212          * @uclass_root_s.
 213          */
 214         struct list_head *uclass_root;
 215 # if CONFIG_IS_ENABLED(OF_PLATDATA_DRIVER_RT)
 216         /** @dm_driver_rt: Dynamic info about the driver */
 217         struct driver_rt *dm_driver_rt;
 218 # endif
 219 #if CONFIG_IS_ENABLED(OF_PLATDATA_RT)
 220         /** @dm_udevice_rt: Dynamic info about the udevice */
 221         struct udevice_rt *dm_udevice_rt;
 222         /**
 223          * @dm_priv_base: Base address of the priv/plat region used when
 224          * udevices and uclasses are in read-only memory. This is NULL if not
 225          * used
 226          */
 227         void *dm_priv_base;
 228 # endif
 229 #endif
 230 #ifdef CONFIG_TIMER
 231         /**
 232          * @timer: timer instance for Driver Model
 233          */
 234         struct udevice *timer;
 235 #endif
 236         /**
 237          * @fdt_blob: U-Boot's own device tree, NULL if none
 238          */
 239         const void *fdt_blob;
 240         /**
 241          * @new_fdt: relocated device tree
 242          */
 243         void *new_fdt;
 244         /**
 245          * @fdt_size: space reserved for relocated device space
 246          */
 247         unsigned long fdt_size;
 248         /**
 249          * @fdt_src: Source of FDT
 250          */
 251         enum fdt_source_t fdt_src;
 252 #if CONFIG_IS_ENABLED(OF_LIVE)
 253         /**
 254          * @of_root: root node of the live tree
 255          */
 256         struct device_node *of_root;
 257 #endif
 258
 259 #if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
 260         /**
 261          * @multi_dtb_fit: pointer to uncompressed multi-dtb FIT image
 262          */
 263         const void *multi_dtb_fit;
 264 #endif
 265         /**
 266          * @jt: jump table
 267          *
 268          * The jump table contains pointers to exported functions. A pointer to
 269          * the jump table is passed to standalone applications.
 270          */
 271         struct jt_funcs *jt;
 272         /**
 273          * @env_buf: buffer for env_get() before reloc
 274          */
 275         char env_buf[32];
 276 #ifdef CONFIG_TRACE
 277         /**
 278          * @trace_buff: trace buffer
 279          *
 280          * When tracing function in U-Boot this field points to the buffer
 281          * recording the function calls.
 282          */
 283         void *trace_buff;
 284 #endif
 285 #if CONFIG_IS_ENABLED(SYS_I2C_LEGACY)
 286         /**
 287          * @cur_i2c_bus: currently used I2C bus
 288          */
 289         int cur_i2c_bus;
 290 #endif
 291         /**
 292          * @timebase_h: high 32 bits of timer
 293          */
 294         unsigned int timebase_h;
 295         /**
 296          * @timebase_l: low 32 bits of timer
 297          */
 298         unsigned int timebase_l;
 299 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
 300         /**
 301          * @malloc_base: base address of early malloc()
 302          */
 303         unsigned long malloc_base;
 304         /**
 305          * @malloc_limit: limit address of early malloc()
 306          */
 307         unsigned long malloc_limit;
 308         /**
 309          * @malloc_ptr: current address of early malloc()
 310          */
 311         unsigned long malloc_ptr;
 312 #endif
 313 #ifdef CONFIG_PCI
 314         /**
 315          * @hose: PCI hose for early use
 316          */
 317         struct pci_controller *hose;
 318         /**
 319          * @pci_ram_top: top of region accessible to PCI
 320          */
 321         phys_addr_t pci_ram_top;
 322 #endif
 323 #ifdef CONFIG_PCI_BOOTDELAY
 324         /**
 325          * @pcidelay_done: delay time before scanning of PIC hose expired
 326          *
 327          * If CONFIG_PCI_BOOTDELAY=y, pci_hose_scan() waits for the number of
 328          * milliseconds defined by environment variable pcidelay before
 329          * scanning. Once this delay has expired the flag @pcidelay_done
 330          * is set to 1.
 331          */
 332         int pcidelay_done;
 333 #endif
 334         /**
 335          * @cur_serial_dev: current serial device
 336          */
 337         struct udevice *cur_serial_dev;
 338         /**
 339          * @arch: architecture-specific data
 340          */
 341         struct arch_global_data arch;
 342 #ifdef CONFIG_CONSOLE_RECORD
 343         /**
 344          * @console_out: output buffer for console recording
 345          *
 346          * This buffer is used to collect output during console recording.
 347          */
 348         struct membuff console_out;
 349         /**
 350          * @console_in: input buffer for console recording
 351          *
 352          * If console recording is activated, this buffer can be used to
 353          * emulate input.
 354          */
 355         struct membuff console_in;
 356 #endif
 357 #ifdef CONFIG_DM_VIDEO
 358         /**
 359          * @video_top: top of video frame buffer area
 360          */
 361         ulong video_top;
 362         /**
 363          * @video_bottom: bottom of video frame buffer area
 364          */
 365         ulong video_bottom;
 366 #endif
 367 #ifdef CONFIG_BOOTSTAGE
 368         /**
 369          * @bootstage: boot stage information
 370          */
 371         struct bootstage_data *bootstage;
 372         /**
 373          * @new_bootstage: relocated boot stage information
 374          */
 375         struct bootstage_data *new_bootstage;
 376 #endif
 377 #ifdef CONFIG_LOG
 378         /**
 379          * @log_drop_count: number of dropped log messages
 380          *
 381          * This counter is incremented for each log message which can not
 382          * be processed because logging is not yet available as signaled by
 383          * flag %GD_FLG_LOG_READY in @flags.
 384          */
 385         int log_drop_count;
 386         /**
 387          * @default_log_level: default logging level
 388          *
 389          * For logging devices without filters @default_log_level defines the
 390          * logging level, cf. &enum log_level_t.
 391          */
 392         int default_log_level;
 393         /**
 394          * @log_head: list of logging devices
 395          */
 396         struct list_head log_head;
 397         /**
 398          * @log_fmt: bit mask for logging format
 399          *
 400          * The @log_fmt bit mask selects the fields to be shown in log messages.
 401          * &enum log_fmt defines the bits of the bit mask.
 402          */
 403         int log_fmt;
 404
 405         /**
 406          * @processing_msg: a log message is being processed
 407          *
 408          * This flag is used to suppress the creation of additional messages
 409          * while another message is being processed.
 410          */
 411         bool processing_msg;
 412         /**
 413          * @logc_prev: logging category of previous message
 414          *
 415          * This value is used as logging category for continuation messages.
 416          */
 417         int logc_prev;
 418         /**
 419          * @logl_prev: logging level of the previous message
 420          *
 421          * This value is used as logging level for continuation messages.
 422          */
 423         int logl_prev;
 424         /**
 425          * @log_cont: Previous log line did not finished wtih \n
 426          *
 427          * This allows for chained log messages on the same line
 428          */
 429         bool log_cont;
 430 #endif
 431 #if CONFIG_IS_ENABLED(BLOBLIST)
 432         /**
 433          * @bloblist: blob list information
 434          */
 435         struct bloblist_hdr *bloblist;
 436         /**
 437          * @new_bloblist: relocated blob list information
 438          */
 439         struct bloblist_hdr *new_bloblist;
 440 #endif
 441 #if CONFIG_IS_ENABLED(HANDOFF)
 442         /**
 443          * @spl_handoff: SPL hand-off information
 444          */
 445         struct spl_handoff *spl_handoff;
 446 #endif
 447 #if defined(CONFIG_TRANSLATION_OFFSET)
 448         /**
 449          * @translation_offset: optional translation offset
 450          *
 451          * See CONFIG_TRANSLATION_OFFSET.
 452          */
 453         fdt_addr_t translation_offset;
 454 #endif
 455 #ifdef CONFIG_GENERATE_ACPI_TABLE
 456         /**
 457          * @acpi_ctx: ACPI context pointer
 458          */
 459         struct acpi_ctx *acpi_ctx;
 460         /**
 461          * @acpi_start: Start address of ACPI tables
 462          */
 463         ulong acpi_start;
 464 #endif
 465 #if CONFIG_IS_ENABLED(GENERATE_SMBIOS_TABLE)
 466         /**
 467          * @smbios_version: Points to SMBIOS type 0 version
 468          */
 469         char *smbios_version;
 470 #endif
 471 #if CONFIG_IS_ENABLED(EVENT)
 472         /**
 473          * @event_state: Points to the current state of events
 474          */
 475         struct event_state event_state;
 476 #endif
 477 };
 478 #ifndef DO_DEPS_ONLY
 479 static_assert(sizeof(struct global_data) == GD_SIZE);
 480 #endif
 481
 482 /**
 483  * gd_board_type() - retrieve board type
 484  *
 485  * Return: global board type
 486  */
 487 #ifdef CONFIG_BOARD_TYPES
 488 #define gd_board_type()         gd->board_type
 489 #else
 490 #define gd_board_type()         0
 491 #endif
 492
 493 /* These macros help avoid #ifdefs in the code */
 494 #if CONFIG_IS_ENABLED(OF_LIVE)
 495 #define gd_of_root()            gd->of_root
 496 #define gd_of_root_ptr()        &gd->of_root
 497 #define gd_set_of_root(_root)   gd->of_root = (_root)
 498 #else
 499 #define gd_of_root()            NULL
 500 #define gd_of_root_ptr()        NULL
 501 #define gd_set_of_root(_root)
 502 #endif
 503
 504 #if CONFIG_IS_ENABLED(OF_PLATDATA_DRIVER_RT)
 505 #define gd_set_dm_driver_rt(dyn)        gd->dm_driver_rt = dyn
 506 #define gd_dm_driver_rt()               gd->dm_driver_rt
 507 #else
 508 #define gd_set_dm_driver_rt(dyn)
 509 #define gd_dm_driver_rt()               NULL
 510 #endif
 511
 512 #if CONFIG_IS_ENABLED(OF_PLATDATA_RT)
 513 #define gd_set_dm_udevice_rt(dyn)       gd->dm_udevice_rt = dyn
 514 #define gd_dm_udevice_rt()              gd->dm_udevice_rt
 515 #define gd_set_dm_priv_base(dyn)        gd->dm_priv_base = dyn
 516 #define gd_dm_priv_base()               gd->dm_priv_base
 517 #else
 518 #define gd_set_dm_udevice_rt(dyn)
 519 #define gd_dm_udevice_rt()              NULL
 520 #define gd_set_dm_priv_base(dyn)
 521 #define gd_dm_priv_base()               NULL
 522 #endif
 523
 524 #ifdef CONFIG_GENERATE_ACPI_TABLE
 525 #define gd_acpi_ctx()           gd->acpi_ctx
 526 #define gd_acpi_start()         gd->acpi_start
 527 #define gd_set_acpi_start(addr) gd->acpi_start = addr
 528 #else
 529 #define gd_acpi_ctx()           NULL
 530 #define gd_acpi_start()         0UL
 531 #define gd_set_acpi_start(addr)
 532 #endif
 533
 534 #if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
 535 #define gd_multi_dtb_fit()      gd->multi_dtb_fit
 536 #define gd_set_multi_dtb_fit(_dtb)      gd->multi_dtb_fit = _dtb
 537 #else
 538 #define gd_multi_dtb_fit()      NULL
 539 #define gd_set_multi_dtb_fit(_dtb)
 540 #endif
 541
 542 #if CONFIG_IS_ENABLED(EVENT_DYNAMIC)
 543 #define gd_event_state()        ((struct event_state *)&gd->event_state)
 544 #else
 545 #define gd_event_state()        NULL
 546 #endif
 547
 548 /**
 549  * enum gd_flags - global data flags
 550  *
 551  * See field flags of &struct global_data.
 552  */
 553 enum gd_flags {
 554         /**
 555          * @GD_FLG_RELOC: code was relocated to RAM
 556          */
 557         GD_FLG_RELOC = 0x00001,
 558         /**
 559          * @GD_FLG_DEVINIT: devices have been initialized
 560          */
 561         GD_FLG_DEVINIT = 0x00002,
 562         /**
 563          * @GD_FLG_SILENT: silent mode
 564          */
 565         GD_FLG_SILENT = 0x00004,
 566         /**
 567          * @GD_FLG_POSTFAIL: critical POST test failed
 568          */
 569         GD_FLG_POSTFAIL = 0x00008,
 570         /**
 571          * @GD_FLG_POSTSTOP: POST sequence aborted
 572          */
 573         GD_FLG_POSTSTOP = 0x00010,
 574         /**
 575          * @GD_FLG_LOGINIT: log Buffer has been initialized
 576          */
 577         GD_FLG_LOGINIT = 0x00020,
 578         /**
 579          * @GD_FLG_DISABLE_CONSOLE: disable console (in & out)
 580          */
 581         GD_FLG_DISABLE_CONSOLE = 0x00040,
 582         /**
 583          * @GD_FLG_ENV_READY: environment imported into hash table
 584          */
 585         GD_FLG_ENV_READY = 0x00080,
 586         /**
 587          * @GD_FLG_SERIAL_READY: pre-relocation serial console ready
 588          */
 589         GD_FLG_SERIAL_READY = 0x00100,
 590         /**
 591          * @GD_FLG_FULL_MALLOC_INIT: full malloc() is ready
 592          */
 593         GD_FLG_FULL_MALLOC_INIT = 0x00200,
 594         /**
 595          * @GD_FLG_SPL_INIT: spl_init() has been called
 596          */
 597         GD_FLG_SPL_INIT = 0x00400,
 598         /**
 599          * @GD_FLG_SKIP_RELOC: don't relocate
 600          */
 601         GD_FLG_SKIP_RELOC = 0x00800,
 602         /**
 603          * @GD_FLG_RECORD: record console
 604          */
 605         GD_FLG_RECORD = 0x01000,
 606         /**
 607          * @GD_FLG_RECORD_OVF: record console overflow
 608          */
 609         GD_FLG_RECORD_OVF = 0x02000,
 610         /**
 611          * @GD_FLG_ENV_DEFAULT: default variable flag
 612          */
 613         GD_FLG_ENV_DEFAULT = 0x04000,
 614         /**
 615          * @GD_FLG_SPL_EARLY_INIT: early SPL initialization is done
 616          */
 617         GD_FLG_SPL_EARLY_INIT = 0x08000,
 618         /**
 619          * @GD_FLG_LOG_READY: log system is ready for use
 620          */
 621         GD_FLG_LOG_READY = 0x10000,
 622         /**
 623          * @GD_FLG_WDT_READY: watchdog is ready for use
 624          */
 625         GD_FLG_WDT_READY = 0x20000,
 626         /**
 627          * @GD_FLG_SKIP_LL_INIT: don't perform low-level initialization
 628          */
 629         GD_FLG_SKIP_LL_INIT = 0x40000,
 630         /**
 631          * @GD_FLG_SMP_READY: SMP initialization is complete
 632          */
 633         GD_FLG_SMP_READY = 0x80000,
 634 };
 635
 636 #endif /* __ASSEMBLY__ */
 637
 638 #endif /* __ASM_GENERIC_GBL_DATA_H */