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_root: root instance for Driver Model 188 */ 189 struct udevice *dm_root; 190 /** 191 * @dm_root_f: pre-relocation root instance 192 */ 193 struct udevice *dm_root_f; 194 /** 195 * @uclass_root_s: 196 * head of core tree when uclasses are not in read-only memory. 197 * 198 * When uclasses are in read-only memory, @uclass_root_s is not used and 199 * @uclass_root points to the root node generated by dtoc. 200 */ 201 struct list_head uclass_root_s; 202 /** 203 * @uclass_root: 204 * pointer to head of core tree, if uclasses are in read-only memory and 205 * cannot be adjusted to use @uclass_root as a list head. 206 * 207 * When not in read-only memory, @uclass_root_s is used to hold the 208 * uclass root, and @uclass_root points to the address of 209 * @uclass_root_s. 210 */ 211 struct list_head *uclass_root; 212 # if CONFIG_IS_ENABLED(OF_PLATDATA_DRIVER_RT) 213 /** @dm_driver_rt: Dynamic info about the driver */ 214 struct driver_rt *dm_driver_rt; 215 # endif 216 #if CONFIG_IS_ENABLED(OF_PLATDATA_RT) 217 /** @dm_udevice_rt: Dynamic info about the udevice */ 218 struct udevice_rt *dm_udevice_rt; 219 /** 220 * @dm_priv_base: Base address of the priv/plat region used when 221 * udevices and uclasses are in read-only memory. This is NULL if not 222 * used 223 */ 224 void *dm_priv_base; 225 # endif 226 #endif 227 #ifdef CONFIG_TIMER 228 /** 229 * @timer: timer instance for Driver Model 230 */ 231 struct udevice *timer; 232 #endif 233 /** 234 * @fdt_blob: U-Boot's own device tree, NULL if none 235 */ 236 const void *fdt_blob; 237 /** 238 * @new_fdt: relocated device tree 239 */ 240 void *new_fdt; 241 /** 242 * @fdt_size: space reserved for relocated device space 243 */ 244 unsigned long fdt_size; 245 #if CONFIG_IS_ENABLED(OF_LIVE) 246 /** 247 * @of_root: root node of the live tree 248 */ 249 struct device_node *of_root; 250 #endif 251 252 #if CONFIG_IS_ENABLED(MULTI_DTB_FIT) 253 /** 254 * @multi_dtb_fit: pointer to uncompressed multi-dtb FIT image 255 */ 256 const void *multi_dtb_fit; 257 #endif 258 /** 259 * @jt: jump table 260 * 261 * The jump table contains pointers to exported functions. A pointer to 262 * the jump table is passed to standalone applications. 263 */ 264 struct jt_funcs *jt; 265 /** 266 * @env_buf: buffer for env_get() before reloc 267 */ 268 char env_buf[32]; 269 #ifdef CONFIG_TRACE 270 /** 271 * @trace_buff: trace buffer 272 * 273 * When tracing function in U-Boot this field points to the buffer 274 * recording the function calls. 275 */ 276 void *trace_buff; 277 #endif 278 #if defined(CONFIG_SYS_I2C) 279 /** 280 * @cur_i2c_bus: currently used I2C bus 281 */ 282 int cur_i2c_bus; 283 #endif 284 /** 285 * @timebase_h: high 32 bits of timer 286 */ 287 unsigned int timebase_h; 288 /** 289 * @timebase_l: low 32 bits of timer 290 */ 291 unsigned int timebase_l; 292 #if CONFIG_VAL(SYS_MALLOC_F_LEN) 293 /** 294 * @malloc_base: base address of early malloc() 295 */ 296 unsigned long malloc_base; 297 /** 298 * @malloc_limit: limit address of early malloc() 299 */ 300 unsigned long malloc_limit; 301 /** 302 * @malloc_ptr: current address of early malloc() 303 */ 304 unsigned long malloc_ptr; 305 #endif 306 #ifdef CONFIG_PCI 307 /** 308 * @hose: PCI hose for early use 309 */ 310 struct pci_controller *hose; 311 /** 312 * @pci_ram_top: top of region accessible to PCI 313 */ 314 phys_addr_t pci_ram_top; 315 #endif 316 #ifdef CONFIG_PCI_BOOTDELAY 317 /** 318 * @pcidelay_done: delay time before scanning of PIC hose expired 319 * 320 * If CONFIG_PCI_BOOTDELAY=y, pci_hose_scan() waits for the number of 321 * milliseconds defined by environment variable pcidelay before 322 * scanning. Once this delay has expired the flag @pcidelay_done 323 * is set to 1. 324 */ 325 int pcidelay_done; 326 #endif 327 /** 328 * @cur_serial_dev: current serial device 329 */ 330 struct udevice *cur_serial_dev; 331 /** 332 * @arch: architecture-specific data 333 */ 334 struct arch_global_data arch; 335 #ifdef CONFIG_CONSOLE_RECORD 336 /** 337 * @console_out: output buffer for console recording 338 * 339 * This buffer is used to collect output during console recording. 340 */ 341 struct membuff console_out; 342 /** 343 * @console_in: input buffer for console recording 344 * 345 * If console recording is activated, this buffer can be used to 346 * emulate input. 347 */ 348 struct membuff console_in; 349 #endif 350 #ifdef CONFIG_DM_VIDEO 351 /** 352 * @video_top: top of video frame buffer area 353 */ 354 ulong video_top; 355 /** 356 * @video_bottom: bottom of video frame buffer area 357 */ 358 ulong video_bottom; 359 #endif 360 #ifdef CONFIG_BOOTSTAGE 361 /** 362 * @bootstage: boot stage information 363 */ 364 struct bootstage_data *bootstage; 365 /** 366 * @new_bootstage: relocated boot stage information 367 */ 368 struct bootstage_data *new_bootstage; 369 #endif 370 #ifdef CONFIG_LOG 371 /** 372 * @log_drop_count: number of dropped log messages 373 * 374 * This counter is incremented for each log message which can not 375 * be processed because logging is not yet available as signaled by 376 * flag %GD_FLG_LOG_READY in @flags. 377 */ 378 int log_drop_count; 379 /** 380 * @default_log_level: default logging level 381 * 382 * For logging devices without filters @default_log_level defines the 383 * logging level, cf. &enum log_level_t. 384 */ 385 int default_log_level; 386 /** 387 * @log_head: list of logging devices 388 */ 389 struct list_head log_head; 390 /** 391 * @log_fmt: bit mask for logging format 392 * 393 * The @log_fmt bit mask selects the fields to be shown in log messages. 394 * &enum log_fmt defines the bits of the bit mask. 395 */ 396 int log_fmt; 397 398 /** 399 * @processing_msg: a log message is being processed 400 * 401 * This flag is used to suppress the creation of additional messages 402 * while another message is being processed. 403 */ 404 bool processing_msg; 405 /** 406 * @logc_prev: logging category of previous message 407 * 408 * This value is used as logging category for continuation messages. 409 */ 410 int logc_prev; 411 /** 412 * @logl_prev: logging level of the previous message 413 * 414 * This value is used as logging level for continuation messages. 415 */ 416 int logl_prev; 417 /** 418 * @log_cont: Previous log line did not finished wtih \n 419 * 420 * This allows for chained log messages on the same line 421 */ 422 bool log_cont; 423 #endif 424 #if CONFIG_IS_ENABLED(BLOBLIST) 425 /** 426 * @bloblist: blob list information 427 */ 428 struct bloblist_hdr *bloblist; 429 /** 430 * @new_bloblist: relocated blob list information 431 */ 432 struct bloblist_hdr *new_bloblist; 433 #endif 434 #if CONFIG_IS_ENABLED(HANDOFF) 435 /** 436 * @spl_handoff: SPL hand-off information 437 */ 438 struct spl_handoff *spl_handoff; 439 #endif 440 #if defined(CONFIG_TRANSLATION_OFFSET) 441 /** 442 * @translation_offset: optional translation offset 443 * 444 * See CONFIG_TRANSLATION_OFFSET. 445 */ 446 fdt_addr_t translation_offset; 447 #endif 448 #if CONFIG_IS_ENABLED(WDT) 449 /** 450 * @watchdog_dev: watchdog device 451 */ 452 struct udevice *watchdog_dev; 453 #endif 454 #ifdef CONFIG_GENERATE_ACPI_TABLE 455 /** 456 * @acpi_ctx: ACPI context pointer 457 */ 458 struct acpi_ctx *acpi_ctx; 459 #endif 460 #if CONFIG_IS_ENABLED(GENERATE_SMBIOS_TABLE) 461 /** 462 * @smbios_version: Points to SMBIOS type 0 version 463 */ 464 char *smbios_version; 465 #endif 466 }; 467 468 /** 469 * gd_board_type() - retrieve board type 470 * 471 * Return: global board type 472 */ 473 #ifdef CONFIG_BOARD_TYPES 474 #define gd_board_type() gd->board_type 475 #else 476 #define gd_board_type() 0 477 #endif 478 479 /* These macros help avoid #ifdefs in the code */ 480 #if CONFIG_IS_ENABLED(OF_LIVE) 481 #define gd_of_root() gd->of_root 482 #define gd_of_root_ptr() &gd->of_root 483 #define gd_set_of_root(_root) gd->of_root = (_root) 484 #else 485 #define gd_of_root() NULL 486 #define gd_of_root_ptr() NULL 487 #define gd_set_of_root(_root) 488 #endif 489 490 #if CONFIG_IS_ENABLED(OF_PLATDATA_DRIVER_RT) 491 #define gd_set_dm_driver_rt(dyn) gd->dm_driver_rt = dyn 492 #define gd_dm_driver_rt() gd->dm_driver_rt 493 #else 494 #define gd_set_dm_driver_rt(dyn) 495 #define gd_dm_driver_rt() NULL 496 #endif 497 498 #if CONFIG_IS_ENABLED(OF_PLATDATA_RT) 499 #define gd_set_dm_udevice_rt(dyn) gd->dm_udevice_rt = dyn 500 #define gd_dm_udevice_rt() gd->dm_udevice_rt 501 #define gd_set_dm_priv_base(dyn) gd->dm_priv_base = dyn 502 #define gd_dm_priv_base() gd->dm_priv_base 503 #else 504 #define gd_set_dm_udevice_rt(dyn) 505 #define gd_dm_udevice_rt() NULL 506 #define gd_set_dm_priv_base(dyn) 507 #define gd_dm_priv_base() NULL 508 #endif 509 510 #ifdef CONFIG_GENERATE_ACPI_TABLE 511 #define gd_acpi_ctx() gd->acpi_ctx 512 #else 513 #define gd_acpi_ctx() NULL 514 #endif 515 516 /** 517 * enum gd_flags - global data flags 518 * 519 * See field flags of &struct global_data. 520 */ 521 enum gd_flags { 522 /** 523 * @GD_FLG_RELOC: code was relocated to RAM 524 */ 525 GD_FLG_RELOC = 0x00001, 526 /** 527 * @GD_FLG_DEVINIT: devices have been initialized 528 */ 529 GD_FLG_DEVINIT = 0x00002, 530 /** 531 * @GD_FLG_SILENT: silent mode 532 */ 533 GD_FLG_SILENT = 0x00004, 534 /** 535 * @GD_FLG_POSTFAIL: critical POST test failed 536 */ 537 GD_FLG_POSTFAIL = 0x00008, 538 /** 539 * @GD_FLG_POSTSTOP: POST sequence aborted 540 */ 541 GD_FLG_POSTSTOP = 0x00010, 542 /** 543 * @GD_FLG_LOGINIT: log Buffer has been initialized 544 */ 545 GD_FLG_LOGINIT = 0x00020, 546 /** 547 * @GD_FLG_DISABLE_CONSOLE: disable console (in & out) 548 */ 549 GD_FLG_DISABLE_CONSOLE = 0x00040, 550 /** 551 * @GD_FLG_ENV_READY: environment imported into hash table 552 */ 553 GD_FLG_ENV_READY = 0x00080, 554 /** 555 * @GD_FLG_SERIAL_READY: pre-relocation serial console ready 556 */ 557 GD_FLG_SERIAL_READY = 0x00100, 558 /** 559 * @GD_FLG_FULL_MALLOC_INIT: full malloc() is ready 560 */ 561 GD_FLG_FULL_MALLOC_INIT = 0x00200, 562 /** 563 * @GD_FLG_SPL_INIT: spl_init() has been called 564 */ 565 GD_FLG_SPL_INIT = 0x00400, 566 /** 567 * @GD_FLG_SKIP_RELOC: don't relocate 568 */ 569 GD_FLG_SKIP_RELOC = 0x00800, 570 /** 571 * @GD_FLG_RECORD: record console 572 */ 573 GD_FLG_RECORD = 0x01000, 574 /** 575 * @GD_FLG_ENV_DEFAULT: default variable flag 576 */ 577 GD_FLG_ENV_DEFAULT = 0x02000, 578 /** 579 * @GD_FLG_SPL_EARLY_INIT: early SPL initialization is done 580 */ 581 GD_FLG_SPL_EARLY_INIT = 0x04000, 582 /** 583 * @GD_FLG_LOG_READY: log system is ready for use 584 */ 585 GD_FLG_LOG_READY = 0x08000, 586 /** 587 * @GD_FLG_WDT_READY: watchdog is ready for use 588 */ 589 GD_FLG_WDT_READY = 0x10000, 590 /** 591 * @GD_FLG_SKIP_LL_INIT: don't perform low-level initialization 592 */ 593 GD_FLG_SKIP_LL_INIT = 0x20000, 594 /** 595 * @GD_FLG_SMP_READY: SMP initialization is complete 596 */ 597 GD_FLG_SMP_READY = 0x40000, 598 }; 599 600 #endif /* __ASSEMBLY__ */ 601 602 #endif /* __ASM_GENERIC_GBL_DATA_H */ 603