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