]> git.ipfire.org Git - people/ms/u-boot.git/blob - include/common.h
arm: mvebu: Move CONFIG_SYS_TEXT_BASE to an address < 16 MiB
[people/ms/u-boot.git] / include / common.h
1 /*
2 * (C) Copyright 2000-2009
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
5 * SPDX-License-Identifier: GPL-2.0+
6 */
7
8 #ifndef __COMMON_H_
9 #define __COMMON_H_ 1
10
11 #ifndef __ASSEMBLY__ /* put C only stuff in this section */
12
13 typedef unsigned char uchar;
14 typedef volatile unsigned long vu_long;
15 typedef volatile unsigned short vu_short;
16 typedef volatile unsigned char vu_char;
17
18 #include <config.h>
19 #include <asm-offsets.h>
20 #include <linux/bitops.h>
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/stringify.h>
24 #include <asm/ptrace.h>
25 #include <stdarg.h>
26 #include <linux/kernel.h>
27 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
28 #include <pci.h>
29 #endif
30 #if defined(CONFIG_8xx)
31 #include <asm/8xx_immap.h>
32 #if defined(CONFIG_MPC859) || defined(CONFIG_MPC859T) || \
33 defined(CONFIG_MPC866) || \
34 defined(CONFIG_MPC866P)
35 # define CONFIG_MPC866_FAMILY 1
36 #elif defined(CONFIG_MPC885)
37 # define CONFIG_MPC885_FAMILY 1
38 #endif
39 #if defined(CONFIG_MPC860) \
40 || defined(CONFIG_MPC860T) \
41 || defined(CONFIG_MPC866_FAMILY) \
42 || defined(CONFIG_MPC885_FAMILY)
43 # define CONFIG_MPC86x 1
44 #endif
45 #elif defined(CONFIG_5xx)
46 #include <asm/5xx_immap.h>
47 #elif defined(CONFIG_MPC5xxx)
48 #include <mpc5xxx.h>
49 #elif defined(CONFIG_MPC512X)
50 #include <asm/immap_512x.h>
51 #elif defined(CONFIG_MPC8260)
52 #if defined(CONFIG_MPC8247) \
53 || defined(CONFIG_MPC8272)
54 #define CONFIG_MPC8272_FAMILY 1
55 #endif
56 #include <asm/immap_8260.h>
57 #endif
58 #ifdef CONFIG_MPC86xx
59 #include <mpc86xx.h>
60 #include <asm/immap_86xx.h>
61 #endif
62 #ifdef CONFIG_MPC85xx
63 #include <mpc85xx.h>
64 #include <asm/immap_85xx.h>
65 #endif
66 #ifdef CONFIG_MPC83xx
67 #include <mpc83xx.h>
68 #include <asm/immap_83xx.h>
69 #endif
70 #ifdef CONFIG_4xx
71 #include <asm/ppc4xx.h>
72 #endif
73 #ifdef CONFIG_BLACKFIN
74 #include <asm/blackfin.h>
75 #endif
76 #ifdef CONFIG_SOC_DA8XX
77 #include <asm/arch/hardware.h>
78 #endif
79
80 #include <part.h>
81 #include <flash.h>
82 #include <image.h>
83
84 /* Bring in printf format macros if inttypes.h is included */
85 #define __STDC_FORMAT_MACROS
86
87 #ifdef __LP64__
88 #define CONFIG_SYS_SUPPORT_64BIT_DATA
89 #endif
90
91 #ifdef DEBUG
92 #define _DEBUG 1
93 #else
94 #define _DEBUG 0
95 #endif
96
97 #ifndef pr_fmt
98 #define pr_fmt(fmt) fmt
99 #endif
100
101 /*
102 * Output a debug text when condition "cond" is met. The "cond" should be
103 * computed by a preprocessor in the best case, allowing for the best
104 * optimization.
105 */
106 #define debug_cond(cond, fmt, args...) \
107 do { \
108 if (cond) \
109 printf(pr_fmt(fmt), ##args); \
110 } while (0)
111
112 #define debug(fmt, args...) \
113 debug_cond(_DEBUG, fmt, ##args)
114
115 /*
116 * An assertion is run-time check done in debug mode only. If DEBUG is not
117 * defined then it is skipped. If DEBUG is defined and the assertion fails,
118 * then it calls panic*( which may or may not reset/halt U-Boot (see
119 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
120 * before release, and after release it is hoped that they don't matter. But
121 * in any case these failing assertions cannot be fixed with a reset (which
122 * may just do the same assertion again).
123 */
124 void __assert_fail(const char *assertion, const char *file, unsigned line,
125 const char *function);
126 #define assert(x) \
127 ({ if (!(x) && _DEBUG) \
128 __assert_fail(#x, __FILE__, __LINE__, __func__); })
129
130 #define error(fmt, args...) do { \
131 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
132 ##args, __FILE__, __LINE__, __func__); \
133 } while (0)
134
135 #ifndef BUG
136 #define BUG() do { \
137 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
138 panic("BUG!"); \
139 } while (0)
140 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
141 #endif /* BUG */
142
143 /* Force a compilation error if condition is true */
144 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
145
146 typedef void (interrupt_handler_t)(void *);
147
148 #include <asm/u-boot.h> /* boot information for Linux kernel */
149 #include <asm/global_data.h> /* global data used for startup functions */
150
151 /*
152 * enable common handling for all TQM8xxL/M boards:
153 * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
154 * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
155 * and for the TQM885D board
156 */
157 #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
158 defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
159 defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
160 # ifndef CONFIG_TQM8xxM
161 # define CONFIG_TQM8xxM
162 # endif
163 #endif
164 #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
165 defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
166 defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
167 defined(CONFIG_TQM885D)
168 # ifndef CONFIG_TQM8xxL
169 # define CONFIG_TQM8xxL
170 # endif
171 #endif
172
173 #if defined(CONFIG_ENV_IS_EMBEDDED)
174 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
175 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
176 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
177 defined(CONFIG_ENV_IS_IN_NVRAM)
178 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
179 #else
180 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
181 #endif
182
183 /*
184 * Function Prototypes
185 */
186 int dram_init(void);
187
188 void hang (void) __attribute__ ((noreturn));
189
190 int timer_init(void);
191 int cpu_init(void);
192
193 /* */
194 phys_size_t initdram (int);
195
196 #include <display_options.h>
197
198 /* common/main.c */
199 void main_loop (void);
200 int run_command(const char *cmd, int flag);
201 int run_command_repeatable(const char *cmd, int flag);
202
203 /**
204 * Run a list of commands separated by ; or even \0
205 *
206 * Note that if 'len' is not -1, then the command does not need to be nul
207 * terminated, Memory will be allocated for the command in that case.
208 *
209 * @param cmd List of commands to run, each separated bu semicolon
210 * @param len Length of commands excluding terminator if known (-1 if not)
211 * @param flag Execution flags (CMD_FLAG_...)
212 * @return 0 on success, or != 0 on error.
213 */
214 int run_command_list(const char *cmd, int len, int flag);
215 extern char console_buffer[];
216
217 /* arch/$(ARCH)/lib/board.c */
218 void board_init_f(ulong);
219 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
220
221 /**
222 * board_init_f_mem() - Allocate global data and set stack position
223 *
224 * This function is called by each architecture very early in the start-up
225 * code to set up the environment for board_init_f(). It allocates space for
226 * global_data (see include/asm-generic/global_data.h) and places the stack
227 * below this.
228 *
229 * This function requires a stack[1] Normally this is at @top. The function
230 * starts allocating space from 64 bytes below @top. First it creates space
231 * for global_data. Then it calls arch_setup_gd() which sets gd to point to
232 * the global_data space and can reserve additional bytes of space if
233 * required). Finally it allocates early malloc() memory
234 * (CONFIG_SYS_MALLOC_F_LEN). The new top of the stack is just below this,
235 * and it returned by this function.
236 *
237 * [1] Strictly speaking it would be possible to implement this function
238 * in C on many archs such that it does not require a stack. However this
239 * does not seem hugely important as only 64 byte are wasted. The 64 bytes
240 * are used to handle the calling standard which generally requires pushing
241 * addresses or registers onto the stack. We should be able to get away with
242 * less if this becomes important.
243 *
244 * @top: Top of available memory, also normally the top of the stack
245 * @return: New stack location
246 */
247 ulong board_init_f_mem(ulong top);
248
249 /**
250 * arch_setup_gd() - Set up the global_data pointer
251 *
252 * This pointer is special in some architectures and cannot easily be assigned
253 * to. For example on x86 it is implemented by adding a specific record to its
254 * Global Descriptor Table! So we we provide a function to carry out this task.
255 * For most architectures this can simply be:
256 *
257 * gd = gd_ptr;
258 *
259 * @gd_ptr: Pointer to global data
260 */
261 void arch_setup_gd(gd_t *gd_ptr);
262
263 int checkboard(void);
264 int show_board_info(void);
265 int checkflash(void);
266 int checkdram(void);
267 int last_stage_init(void);
268 extern ulong monitor_flash_len;
269 int mac_read_from_eeprom(void);
270 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
271 int set_cpu_clk_info(void);
272 int mdm_init(void);
273 #if defined(CONFIG_DISPLAY_CPUINFO)
274 int print_cpuinfo(void);
275 #else
276 static inline int print_cpuinfo(void)
277 {
278 return 0;
279 }
280 #endif
281 int update_flash_size(int flash_size);
282 int arch_early_init_r(void);
283
284 /**
285 * arch_cpu_init_dm() - init CPU after driver model is available
286 *
287 * This is called immediately after driver model is available before
288 * relocation. This is similar to arch_cpu_init() but is able to reference
289 * devices
290 *
291 * @return 0 if OK, -ve on error
292 */
293 int arch_cpu_init_dm(void);
294
295 /**
296 * Reserve all necessary stacks
297 *
298 * This is used in generic board init sequence in common/board_f.c. Each
299 * architecture could provide this function to tailor the required stacks.
300 *
301 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
302 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
303 * require only this can leave it untouched.
304 *
305 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
306 * positions of the stack. The stack pointer(s) will be set to this later.
307 * gd->irq_sp is only required, if the architecture needs it.
308 *
309 * @return 0 if no error
310 */
311 __weak int arch_reserve_stacks(void);
312
313 /**
314 * Show the DRAM size in a board-specific way
315 *
316 * This is used by boards to display DRAM information in their own way.
317 *
318 * @param size Size of DRAM (which should be displayed along with other info)
319 */
320 void board_show_dram(phys_size_t size);
321
322 /**
323 * arch_fixup_fdt() - Write arch-specific information to fdt
324 *
325 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
326 *
327 * @blob: FDT blob to write to
328 * @return 0 if ok, or -ve FDT_ERR_... on failure
329 */
330 int arch_fixup_fdt(void *blob);
331
332 /* common/flash.c */
333 void flash_perror (int);
334
335 /* common/cmd_source.c */
336 int source (ulong addr, const char *fit_uname);
337
338 extern ulong load_addr; /* Default Load Address */
339 extern ulong save_addr; /* Default Save Address */
340 extern ulong save_size; /* Default Save Size */
341
342 /* common/cmd_doc.c */
343 void doc_probe(unsigned long physadr);
344
345 /* common/cmd_net.c */
346 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
347
348 /* common/cmd_fat.c */
349 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
350
351 /* common/cmd_ext2.c */
352 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
353
354 /* common/cmd_nvedit.c */
355 int env_init (void);
356 void env_relocate (void);
357 int envmatch (uchar *, int);
358
359 /* Avoid unfortunate conflict with libc's getenv() */
360 #ifdef CONFIG_SANDBOX
361 #define getenv uboot_getenv
362 #endif
363 char *getenv (const char *);
364 int getenv_f (const char *name, char *buf, unsigned len);
365 ulong getenv_ulong(const char *name, int base, ulong default_val);
366
367 /**
368 * getenv_hex() - Return an environment variable as a hex value
369 *
370 * Decode an environment as a hex number (it may or may not have a 0x
371 * prefix). If the environment variable cannot be found, or does not start
372 * with hex digits, the default value is returned.
373 *
374 * @varname: Variable to decode
375 * @default_val: Value to return on error
376 */
377 ulong getenv_hex(const char *varname, ulong default_val);
378
379 /*
380 * Read an environment variable as a boolean
381 * Return -1 if variable does not exist (default to true)
382 */
383 int getenv_yesno(const char *var);
384 int saveenv (void);
385 int setenv (const char *, const char *);
386 int setenv_ulong(const char *varname, ulong value);
387 int setenv_hex(const char *varname, ulong value);
388 /**
389 * setenv_addr - Set an environment variable to an address in hex
390 *
391 * @varname: Environment variable to set
392 * @addr: Value to set it to
393 * @return 0 if ok, 1 on error
394 */
395 static inline int setenv_addr(const char *varname, const void *addr)
396 {
397 return setenv_hex(varname, (ulong)addr);
398 }
399
400 #ifdef CONFIG_ARM
401 # include <asm/mach-types.h>
402 # include <asm/setup.h>
403 # include <asm/u-boot-arm.h> /* ARM version to be fixed! */
404 #endif /* CONFIG_ARM */
405 #ifdef CONFIG_X86 /* x86 version to be fixed! */
406 # include <asm/u-boot-x86.h>
407 #endif /* CONFIG_X86 */
408 #ifdef CONFIG_SANDBOX
409 # include <asm/u-boot-sandbox.h> /* TODO(sjg) what needs to be fixed? */
410 #endif
411 #ifdef CONFIG_NDS32
412 # include <asm/mach-types.h>
413 # include <asm/setup.h>
414 # include <asm/u-boot-nds32.h>
415 #endif /* CONFIG_NDS32 */
416 #ifdef CONFIG_MIPS
417 # include <asm/u-boot-mips.h>
418 #endif /* CONFIG_MIPS */
419 #ifdef CONFIG_ARC
420 # include <asm/u-boot-arc.h>
421 #endif /* CONFIG_ARC */
422
423 #ifdef CONFIG_AUTO_COMPLETE
424 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
425 #endif
426 int get_env_id (void);
427
428 void pci_init (void);
429 void pci_init_board(void);
430 void pciinfo (int, int);
431
432 #if defined(CONFIG_PCI) && defined(CONFIG_4xx)
433 int pci_pre_init (struct pci_controller *);
434 int is_pci_host (struct pci_controller *);
435 #endif
436
437 #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
438 # if defined(CONFIG_SYS_PCI_TARGET_INIT)
439 void pci_target_init (struct pci_controller *);
440 # endif
441 # if defined(CONFIG_SYS_PCI_MASTER_INIT)
442 void pci_master_init (struct pci_controller *);
443 # endif
444 #if defined(CONFIG_440SPE) || \
445 defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
446 defined(CONFIG_405EX)
447 void pcie_setup_hoses(int busno);
448 #endif
449 #endif
450
451 int misc_init_f (void);
452 int misc_init_r (void);
453
454 /* common/exports.c */
455 void jumptable_init(void);
456
457 /* common/kallsysm.c */
458 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
459
460 /* api/api.c */
461 void api_init (void);
462
463 /* common/memsize.c */
464 long get_ram_size (long *, long);
465 phys_size_t get_effective_memsize(void);
466
467 /* $(BOARD)/$(BOARD).c */
468 void reset_phy (void);
469 void fdc_hw_init (void);
470
471 /* $(BOARD)/eeprom.c */
472 void eeprom_init (void);
473 #ifndef CONFIG_SPI
474 int eeprom_probe (unsigned dev_addr, unsigned offset);
475 #endif
476 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
477 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
478
479 /*
480 * Set this up regardless of board
481 * type, to prevent errors.
482 */
483 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
484 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
485 #else
486 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
487 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
488 #endif
489 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
490
491 #if defined(CONFIG_SPI)
492 extern void spi_init_f (void);
493 extern void spi_init_r (void);
494 extern ssize_t spi_read (uchar *, int, uchar *, int);
495 extern ssize_t spi_write (uchar *, int, uchar *, int);
496 #endif
497
498 /* $(BOARD)/$(BOARD).c */
499 int board_early_init_f (void);
500 int board_late_init (void);
501 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
502 int board_early_init_r (void);
503 void board_poweroff (void);
504
505 #if defined(CONFIG_SYS_DRAM_TEST)
506 int testdram(void);
507 #endif /* CONFIG_SYS_DRAM_TEST */
508
509 /* $(CPU)/start.S */
510 #if defined(CONFIG_5xx) || \
511 defined(CONFIG_8xx)
512 uint get_immr (uint);
513 #endif
514 #if defined(CONFIG_MPC5xxx)
515 uint get_svr (void);
516 #endif
517 uint get_pvr (void);
518 uint get_svr (void);
519 uint rd_ic_cst (void);
520 void wr_ic_cst (uint);
521 void wr_ic_adr (uint);
522 uint rd_dc_cst (void);
523 void wr_dc_cst (uint);
524 void wr_dc_adr (uint);
525 int icache_status (void);
526 void icache_enable (void);
527 void icache_disable(void);
528 int dcache_status (void);
529 void dcache_enable (void);
530 void dcache_disable(void);
531 void mmu_disable(void);
532 #if defined(CONFIG_ARM)
533 void relocate_code(ulong);
534 #else
535 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
536 #endif
537 ulong get_endaddr (void);
538 void trap_init (ulong);
539 #if defined (CONFIG_4xx) || \
540 defined (CONFIG_MPC5xxx) || \
541 defined (CONFIG_MPC85xx) || \
542 defined (CONFIG_MPC86xx) || \
543 defined (CONFIG_MPC83xx)
544 unsigned char in8(unsigned int);
545 void out8(unsigned int, unsigned char);
546 unsigned short in16(unsigned int);
547 unsigned short in16r(unsigned int);
548 void out16(unsigned int, unsigned short value);
549 void out16r(unsigned int, unsigned short value);
550 unsigned long in32(unsigned int);
551 unsigned long in32r(unsigned int);
552 void out32(unsigned int, unsigned long value);
553 void out32r(unsigned int, unsigned long value);
554 void ppcDcbf(unsigned long value);
555 void ppcDcbi(unsigned long value);
556 void ppcSync(void);
557 void ppcDcbz(unsigned long value);
558 #endif
559 #if defined (CONFIG_MICROBLAZE)
560 unsigned short in16(unsigned int);
561 void out16(unsigned int, unsigned short value);
562 #endif
563
564 #if defined (CONFIG_MPC83xx)
565 void ppcDWload(unsigned int *addr, unsigned int *ret);
566 void ppcDWstore(unsigned int *addr, unsigned int *value);
567 void disable_addr_trans(void);
568 void enable_addr_trans(void);
569 #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
570 void ddr_enable_ecc(unsigned int dram_size);
571 #endif
572 #endif
573
574 /*
575 * Return the current value of a monotonically increasing microsecond timer.
576 * Granularity may be larger than 1us if hardware does not support this.
577 */
578 ulong timer_get_us(void);
579
580 /* $(CPU)/cpu.c */
581 static inline int cpumask_next(int cpu, unsigned int mask)
582 {
583 for (cpu++; !((1 << cpu) & mask); cpu++)
584 ;
585
586 return cpu;
587 }
588
589 #define for_each_cpu(iter, cpu, num_cpus, mask) \
590 for (iter = 0, cpu = cpumask_next(-1, mask); \
591 iter < num_cpus; \
592 iter++, cpu = cpumask_next(cpu, mask)) \
593
594 int cpu_numcores (void);
595 int cpu_num_dspcores(void);
596 u32 cpu_mask (void);
597 u32 cpu_dsp_mask(void);
598 int is_core_valid (unsigned int);
599 int probecpu (void);
600 int checkcpu (void);
601 int checkicache (void);
602 int checkdcache (void);
603 void upmconfig (unsigned int, unsigned int *, unsigned int);
604 ulong get_tbclk (void);
605 void reset_misc (void);
606 void reset_cpu (ulong addr);
607 #if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
608 void ft_cpu_setup(void *blob, bd_t *bd);
609 #ifdef CONFIG_PCI
610 void ft_pci_setup(void *blob, bd_t *bd);
611 #endif
612 #endif
613
614 void smp_set_core_boot_addr(unsigned long addr, int corenr);
615 void smp_kick_all_cpus(void);
616
617 /* $(CPU)/serial.c */
618 int serial_init (void);
619 void serial_setbrg (void);
620 void serial_putc (const char);
621 void serial_putc_raw(const char);
622 void serial_puts (const char *);
623 int serial_getc (void);
624 int serial_tstc (void);
625
626 /* These versions take a stdio_dev pointer */
627 struct stdio_dev;
628 int serial_stub_getc(struct stdio_dev *sdev);
629 int serial_stub_tstc(struct stdio_dev *sdev);
630
631 /* $(CPU)/speed.c */
632 int get_clocks (void);
633 int get_clocks_866 (void);
634 int sdram_adjust_866 (void);
635 int adjust_sdram_tbs_8xx (void);
636 #if defined(CONFIG_MPC8260)
637 int prt_8260_clks (void);
638 #elif defined(CONFIG_MPC5xxx)
639 int prt_mpc5xxx_clks (void);
640 #endif
641 #ifdef CONFIG_4xx
642 ulong get_OPB_freq (void);
643 ulong get_PCI_freq (void);
644 #endif
645 #if defined(CONFIG_S3C24X0) || \
646 defined(CONFIG_LH7A40X) || \
647 defined(CONFIG_EP93XX)
648 ulong get_FCLK (void);
649 ulong get_HCLK (void);
650 ulong get_PCLK (void);
651 ulong get_UCLK (void);
652 #endif
653 #if defined(CONFIG_LH7A40X)
654 ulong get_PLLCLK (void);
655 #endif
656 #if defined(CONFIG_IMX)
657 ulong get_systemPLLCLK(void);
658 ulong get_FCLK(void);
659 ulong get_HCLK(void);
660 ulong get_BCLK(void);
661 ulong get_PERCLK1(void);
662 ulong get_PERCLK2(void);
663 ulong get_PERCLK3(void);
664 #endif
665 ulong get_bus_freq (ulong);
666 int get_serial_clock(void);
667
668 #if defined(CONFIG_MPC85xx)
669 typedef MPC85xx_SYS_INFO sys_info_t;
670 void get_sys_info ( sys_info_t * );
671 # if defined(CONFIG_OF_LIBFDT)
672 void ft_fixup_cpu(void *, u64);
673 void ft_fixup_num_cores(void *);
674 # endif
675 #endif
676 #if defined(CONFIG_MPC86xx)
677 typedef MPC86xx_SYS_INFO sys_info_t;
678 void get_sys_info ( sys_info_t * );
679 static inline ulong get_ddr_freq(ulong dummy)
680 {
681 return get_bus_freq(dummy);
682 }
683 #else
684 ulong get_ddr_freq(ulong);
685 #endif
686
687 #if defined(CONFIG_4xx)
688 # if defined(CONFIG_440)
689 # if defined(CONFIG_440SPE)
690 unsigned long determine_sysper(void);
691 unsigned long determine_pci_clock_per(void);
692 # endif
693 # endif
694 typedef PPC4xx_SYS_INFO sys_info_t;
695 int ppc440spe_revB(void);
696 void get_sys_info ( sys_info_t * );
697 #endif
698
699 /* $(CPU)/cpu_init.c */
700 #if defined(CONFIG_8xx) || defined(CONFIG_MPC8260)
701 void cpu_init_f (volatile immap_t *immr);
702 #endif
703 #if defined(CONFIG_4xx) || defined(CONFIG_MCF52x2) || defined(CONFIG_MPC86xx)
704 void cpu_init_f (void);
705 #endif
706 #ifdef CONFIG_MPC85xx
707 ulong cpu_init_f(void);
708 #endif
709
710 int cpu_init_r (void);
711 #if defined(CONFIG_MPC8260)
712 int prt_8260_rsr (void);
713 #elif defined(CONFIG_MPC83xx)
714 int prt_83xx_rsr (void);
715 #endif
716
717 /* $(CPU)/interrupts.c */
718 int interrupt_init (void);
719 void timer_interrupt (struct pt_regs *);
720 void external_interrupt (struct pt_regs *);
721 void irq_install_handler(int, interrupt_handler_t *, void *);
722 void irq_free_handler (int);
723 void reset_timer (void);
724 ulong get_timer (ulong base);
725
726 /* Return value of monotonic microsecond timer */
727 unsigned long timer_get_us(void);
728
729 void enable_interrupts (void);
730 int disable_interrupts (void);
731
732 /* $(CPU)/.../commproc.c */
733 int dpram_init (void);
734 uint dpram_base(void);
735 uint dpram_base_align(uint align);
736 uint dpram_alloc(uint size);
737 uint dpram_alloc_align(uint size,uint align);
738 void bootcount_store (ulong);
739 ulong bootcount_load (void);
740 #define BOOTCOUNT_MAGIC 0xB001C041
741
742 /* $(CPU)/.../<eth> */
743 void mii_init (void);
744
745 /* $(CPU)/.../lcd.c */
746 ulong lcd_setmem (ulong);
747
748 /* $(CPU)/.../video.c */
749 ulong video_setmem (ulong);
750
751 /* arch/$(ARCH)/lib/cache.c */
752 void enable_caches(void);
753 void flush_cache (unsigned long, unsigned long);
754 void flush_dcache_all(void);
755 void flush_dcache_range(unsigned long start, unsigned long stop);
756 void invalidate_dcache_range(unsigned long start, unsigned long stop);
757 void invalidate_dcache_all(void);
758 void invalidate_icache_all(void);
759
760 enum {
761 /* Disable caches (else flush caches but leave them active) */
762 CBL_DISABLE_CACHES = 1 << 0,
763 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
764
765 CBL_ALL = 3,
766 };
767
768 /**
769 * Clean up ready for linux
770 *
771 * @param flags Flags to control what is done
772 */
773 int cleanup_before_linux_select(int flags);
774
775 /* arch/$(ARCH)/lib/ticks.S */
776 uint64_t get_ticks(void);
777 void wait_ticks (unsigned long);
778
779 /* arch/$(ARCH)/lib/time.c */
780 void __udelay (unsigned long);
781 ulong usec2ticks (unsigned long usec);
782 ulong ticks2usec (unsigned long ticks);
783 int init_timebase (void);
784
785 /* lib/gunzip.c */
786 int gunzip(void *, int, unsigned char *, unsigned long *);
787 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
788 int stoponerr, int offset);
789
790 /**
791 * gzwrite progress indicators: defined weak to allow board-specific
792 * overrides:
793 *
794 * gzwrite_progress_init called on startup
795 * gzwrite_progress called during decompress/write loop
796 * gzwrite_progress_finish called at end of loop to
797 * indicate success (retcode=0) or failure
798 */
799 void gzwrite_progress_init(u64 expected_size);
800
801 void gzwrite_progress(int iteration,
802 u64 bytes_written,
803 u64 total_bytes);
804
805 void gzwrite_progress_finish(int retcode,
806 u64 totalwritten,
807 u64 totalsize,
808 u32 expected_crc,
809 u32 calculated_crc);
810
811 /**
812 * decompress and write gzipped image from memory to block device
813 *
814 * @param src compressed image address
815 * @param len compressed image length in bytes
816 * @param dev block device descriptor
817 * @param szwritebuf bytes per write (pad to erase size)
818 * @param startoffs offset in bytes of first write
819 * @param szexpected expected uncompressed length
820 * may be zero to use gzip trailer
821 * for files under 4GiB
822 */
823 int gzwrite(unsigned char *src, int len,
824 struct block_dev_desc *dev,
825 unsigned long szwritebuf,
826 u64 startoffs,
827 u64 szexpected);
828
829 /* lib/qsort.c */
830 void qsort(void *base, size_t nmemb, size_t size,
831 int(*compar)(const void *, const void *));
832 int strcmp_compar(const void *, const void *);
833
834 /* lib/time.c */
835 void udelay (unsigned long);
836 void mdelay(unsigned long);
837
838 /* lib/uuid.c */
839 #include <uuid.h>
840
841 /* lib/vsprintf.c */
842 #include <vsprintf.h>
843
844 /* lib/strmhz.c */
845 char * strmhz(char *buf, unsigned long hz);
846
847 /* lib/crc32.c */
848 #include <u-boot/crc.h>
849
850 /* lib/rand.c */
851 #define RAND_MAX -1U
852 void srand(unsigned int seed);
853 unsigned int rand(void);
854 unsigned int rand_r(unsigned int *seedp);
855
856 /* common/console.c */
857 int console_init_f(void); /* Before relocation; uses the serial stuff */
858 int console_init_r(void); /* After relocation; uses the console stuff */
859 int console_assign(int file, const char *devname); /* Assign the console */
860 int ctrlc (void);
861 int had_ctrlc (void); /* have we had a Control-C since last clear? */
862 void clear_ctrlc (void); /* clear the Control-C condition */
863 int disable_ctrlc (int); /* 1 to disable, 0 to enable Control-C detect */
864 int confirm_yesno(void); /* 1 if input is "y", "Y", "yes" or "YES" */
865 /*
866 * STDIO based functions (can always be used)
867 */
868 /* serial stuff */
869 int serial_printf (const char *fmt, ...)
870 __attribute__ ((format (__printf__, 1, 2)));
871 /* stdin */
872 int getc(void);
873 int tstc(void);
874
875 /* stdout */
876 #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_SPL_SERIAL_SUPPORT)
877 #define putc(...) do { } while (0)
878 #define puts(...) do { } while (0)
879 #define printf(...) do { } while (0)
880 #define vprintf(...) do { } while (0)
881 #else
882 void putc(const char c);
883 void puts(const char *s);
884 int printf(const char *fmt, ...)
885 __attribute__ ((format (__printf__, 1, 2)));
886 int vprintf(const char *fmt, va_list args);
887 #endif
888
889 /* stderr */
890 #define eputc(c) fputc(stderr, c)
891 #define eputs(s) fputs(stderr, s)
892 #define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
893
894 /*
895 * FILE based functions (can only be used AFTER relocation!)
896 */
897 #define stdin 0
898 #define stdout 1
899 #define stderr 2
900 #define MAX_FILES 3
901
902 int fprintf(int file, const char *fmt, ...)
903 __attribute__ ((format (__printf__, 2, 3)));
904 void fputs(int file, const char *s);
905 void fputc(int file, const char c);
906 int ftstc(int file);
907 int fgetc(int file);
908
909 /* lib/gzip.c */
910 int gzip(void *dst, unsigned long *lenp,
911 unsigned char *src, unsigned long srclen);
912 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
913 unsigned long srclen, int stoponerr,
914 int (*func)(unsigned long, unsigned long));
915
916 /* lib/net_utils.c */
917 #include <net.h>
918 static inline struct in_addr getenv_ip(char *var)
919 {
920 return string_to_ip(getenv(var));
921 }
922
923 /*
924 * CONSOLE multiplexing.
925 */
926 #ifdef CONFIG_CONSOLE_MUX
927 #include <iomux.h>
928 #endif
929
930 int pcmcia_init (void);
931
932 #ifdef CONFIG_STATUS_LED
933 # include <status_led.h>
934 #endif
935
936 #include <bootstage.h>
937
938 #ifdef CONFIG_SHOW_ACTIVITY
939 void show_activity(int arg);
940 #endif
941
942 /* Multicore arch functions */
943 #ifdef CONFIG_MP
944 int cpu_status(int nr);
945 int cpu_reset(int nr);
946 int cpu_disable(int nr);
947 int cpu_release(int nr, int argc, char * const argv[]);
948 #endif
949
950 #endif /* __ASSEMBLY__ */
951
952 #ifdef CONFIG_PPC
953 /*
954 * Has to be included outside of the #ifndef __ASSEMBLY__ section.
955 * Otherwise might lead to compilation errors in assembler files.
956 */
957 #include <asm/cache.h>
958 #endif
959
960 /* Put only stuff here that the assembler can digest */
961
962 #ifdef CONFIG_POST
963 #define CONFIG_HAS_POST
964 #ifndef CONFIG_POST_ALT_LIST
965 #define CONFIG_POST_STD_LIST
966 #endif
967 #endif
968
969 #ifdef CONFIG_INIT_CRITICAL
970 #error CONFIG_INIT_CRITICAL is deprecated!
971 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
972 #endif
973
974 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
975
976 /*
977 * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture. It
978 * is used to align DMA buffers.
979 */
980 #ifndef __ASSEMBLY__
981 #include <asm/cache.h>
982 #endif
983
984 /*
985 * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the
986 * stack that meets the minimum architecture alignment requirements for DMA.
987 * Such a buffer is useful for DMA operations where flushing and invalidating
988 * the cache before and after a read and/or write operation is required for
989 * correct operations.
990 *
991 * When called the macro creates an array on the stack that is sized such
992 * that:
993 *
994 * 1) The beginning of the array can be advanced enough to be aligned.
995 *
996 * 2) The size of the aligned portion of the array is a multiple of the minimum
997 * architecture alignment required for DMA.
998 *
999 * 3) The aligned portion contains enough space for the original number of
1000 * elements requested.
1001 *
1002 * The macro then creates a pointer to the aligned portion of this array and
1003 * assigns to the pointer the address of the first element in the aligned
1004 * portion of the array.
1005 *
1006 * Calling the macro as:
1007 *
1008 * ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024);
1009 *
1010 * Will result in something similar to saying:
1011 *
1012 * uint32_t buffer[1024];
1013 *
1014 * The following differences exist:
1015 *
1016 * 1) The resulting buffer is guaranteed to be aligned to the value of
1017 * ARCH_DMA_MINALIGN.
1018 *
1019 * 2) The buffer variable created by the macro is a pointer to the specified
1020 * type, and NOT an array of the specified type. This can be very important
1021 * if you want the address of the buffer, which you probably do, to pass it
1022 * to the DMA hardware. The value of &buffer is different in the two cases.
1023 * In the macro case it will be the address of the pointer, not the address
1024 * of the space reserved for the buffer. However, in the second case it
1025 * would be the address of the buffer. So if you are replacing hard coded
1026 * stack buffers with this macro you need to make sure you remove the & from
1027 * the locations where you are taking the address of the buffer.
1028 *
1029 * Note that the size parameter is the number of array elements to allocate,
1030 * not the number of bytes.
1031 *
1032 * This macro can not be used outside of function scope, or for the creation
1033 * of a function scoped static buffer. It can not be used to create a cache
1034 * line aligned global buffer.
1035 */
1036 #define PAD_COUNT(s, pad) (((s) - 1) / (pad) + 1)
1037 #define PAD_SIZE(s, pad) (PAD_COUNT(s, pad) * pad)
1038 #define ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, pad) \
1039 char __##name[ROUND(PAD_SIZE((size) * sizeof(type), pad), align) \
1040 + (align - 1)]; \
1041 \
1042 type *name = (type *) ALIGN((uintptr_t)__##name, align)
1043 #define ALLOC_ALIGN_BUFFER(type, name, size, align) \
1044 ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, 1)
1045 #define ALLOC_CACHE_ALIGN_BUFFER_PAD(type, name, size, pad) \
1046 ALLOC_ALIGN_BUFFER_PAD(type, name, size, ARCH_DMA_MINALIGN, pad)
1047 #define ALLOC_CACHE_ALIGN_BUFFER(type, name, size) \
1048 ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
1049
1050 /*
1051 * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
1052 * purpose is to allow allocating aligned buffers outside of function scope.
1053 * Usage of this macro shall be avoided or used with extreme care!
1054 */
1055 #define DEFINE_ALIGN_BUFFER(type, name, size, align) \
1056 static char __##name[ALIGN(size * sizeof(type), align)] \
1057 __aligned(align); \
1058 \
1059 static type *name = (type *)__##name
1060 #define DEFINE_CACHE_ALIGN_BUFFER(type, name, size) \
1061 DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
1062
1063 /*
1064 * check_member() - Check the offset of a structure member
1065 *
1066 * @structure: Name of structure (e.g. global_data)
1067 * @member: Name of member (e.g. baudrate)
1068 * @offset: Expected offset in bytes
1069 */
1070 #define check_member(structure, member, offset) _Static_assert( \
1071 offsetof(struct structure, member) == offset, \
1072 "`struct " #structure "` offset for `" #member "` is not " #offset)
1073
1074 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
1075 #ifdef CONFIG_EFI_STUB
1076 #define ll_boot_init() false
1077 #else
1078 #define ll_boot_init() true
1079 #endif
1080
1081 /* Pull in stuff for the build system */
1082 #ifdef DO_DEPS_ONLY
1083 # include <environment.h>
1084 #endif
1085
1086 #endif /* __COMMON_H_ */