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