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