summaryrefslogtreecommitdiff
path: root/include/common.h (plain)
blob: 85e6e4f22174d081a840b6fb4983c4602d998eba
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
13typedef unsigned char uchar;
14typedef volatile unsigned long vu_long;
15typedef volatile unsigned short vu_short;
16typedef 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 */
124void __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
146typedef 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
187void hang (void) __attribute__ ((noreturn));
188
189int timer_init(void);
190int cpu_init(void);
191
192/* */
193phys_size_t initdram (int);
194int display_options (void);
195
196/**
197 * print_size() - Print a size with a suffic
198 *
199 * print sizes as "xxx KiB", "xxx.y KiB", "xxx MiB", "xxx.y MiB",
200 * xxx GiB, xxx.y GiB, etc as needed; allow for optional trailing string
201 * (like "\n")
202 *
203 * @size: Size to print
204 * @suffix String to print after the size
205 */
206void print_size(uint64_t size, const char *suffix);
207
208int print_buffer(ulong addr, const void *data, uint width, uint count,
209 uint linelen);
210
211/* common/main.c */
212void main_loop (void);
213int run_command(const char *cmd, int flag);
214int run_command_repeatable(const char *cmd, int flag);
215
216/**
217 * Run a list of commands separated by ; or even \0
218 *
219 * Note that if 'len' is not -1, then the command does not need to be nul
220 * terminated, Memory will be allocated for the command in that case.
221 *
222 * @param cmd List of commands to run, each separated bu semicolon
223 * @param len Length of commands excluding terminator if known (-1 if not)
224 * @param flag Execution flags (CMD_FLAG_...)
225 * @return 0 on success, or != 0 on error.
226 */
227int run_command_list(const char *cmd, int len, int flag);
228extern char console_buffer[];
229
230/* arch/$(ARCH)/lib/board.c */
231void board_init_f(ulong);
232void board_init_r (gd_t *, ulong) __attribute__ ((noreturn));
233int checkboard (void);
234int checkflash (void);
235int checkdram (void);
236int last_stage_init(void);
237extern ulong monitor_flash_len;
238int mac_read_from_eeprom(void);
239extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
240int set_cpu_clk_info(void);
241int mdm_init(void);
242#if defined(CONFIG_DISPLAY_CPUINFO)
243int print_cpuinfo(void);
244#else
245static inline int print_cpuinfo(void)
246{
247 return 0;
248}
249#endif
250int update_flash_size(int flash_size);
251int arch_early_init_r(void);
252
253/**
254 * Show the DRAM size in a board-specific way
255 *
256 * This is used by boards to display DRAM information in their own way.
257 *
258 * @param size Size of DRAM (which should be displayed along with other info)
259 */
260void board_show_dram(ulong size);
261
262/**
263 * arch_fixup_fdt() - Write arch-specific information to fdt
264 *
265 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
266 *
267 * @blob: FDT blob to write to
268 * @return 0 if ok, or -ve FDT_ERR_... on failure
269 */
270int arch_fixup_fdt(void *blob);
271
272/* common/flash.c */
273void flash_perror (int);
274
275/* common/cmd_source.c */
276int source (ulong addr, const char *fit_uname);
277
278extern ulong load_addr; /* Default Load Address */
279extern ulong save_addr; /* Default Save Address */
280extern ulong save_size; /* Default Save Size */
281
282/* common/cmd_doc.c */
283void doc_probe(unsigned long physadr);
284
285/* common/cmd_net.c */
286int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
287
288/* common/cmd_fat.c */
289int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
290
291/* common/cmd_ext2.c */
292int do_ext2load(cmd_tbl_t *, int, int, char * const []);
293
294/* common/cmd_nvedit.c */
295int env_init (void);
296void env_relocate (void);
297int envmatch (uchar *, int);
298
299/* Avoid unfortunate conflict with libc's getenv() */
300#ifdef CONFIG_SANDBOX
301#define getenv uboot_getenv
302#endif
303char *getenv (const char *);
304int getenv_f (const char *name, char *buf, unsigned len);
305ulong getenv_ulong(const char *name, int base, ulong default_val);
306
307/**
308 * getenv_hex() - Return an environment variable as a hex value
309 *
310 * Decode an environment as a hex number (it may or may not have a 0x
311 * prefix). If the environment variable cannot be found, or does not start
312 * with hex digits, the default value is returned.
313 *
314 * @varname: Variable to decode
315 * @default_val: Value to return on error
316 */
317ulong getenv_hex(const char *varname, ulong default_val);
318
319/*
320 * Read an environment variable as a boolean
321 * Return -1 if variable does not exist (default to true)
322 */
323int getenv_yesno(const char *var);
324int saveenv (void);
325int setenv (const char *, const char *);
326int setenv_ulong(const char *varname, ulong value);
327int setenv_hex(const char *varname, ulong value);
328/**
329 * setenv_addr - Set an environment variable to an address in hex
330 *
331 * @varname: Environment variable to set
332 * @addr: Value to set it to
333 * @return 0 if ok, 1 on error
334 */
335static inline int setenv_addr(const char *varname, const void *addr)
336{
337 return setenv_hex(varname, (ulong)addr);
338}
339
340#ifdef CONFIG_ARM
341# include <asm/mach-types.h>
342# include <asm/setup.h>
343# include <asm/u-boot-arm.h> /* ARM version to be fixed! */
344#endif /* CONFIG_ARM */
345#ifdef CONFIG_X86 /* x86 version to be fixed! */
346# include <asm/u-boot-x86.h>
347#endif /* CONFIG_X86 */
348#ifdef CONFIG_SANDBOX
349# include <asm/u-boot-sandbox.h> /* TODO(sjg) what needs to be fixed? */
350#endif
351#ifdef CONFIG_NDS32
352# include <asm/mach-types.h>
353# include <asm/setup.h>
354# include <asm/u-boot-nds32.h>
355#endif /* CONFIG_NDS32 */
356#ifdef CONFIG_MIPS
357# include <asm/u-boot-mips.h>
358#endif /* CONFIG_MIPS */
359#ifdef CONFIG_ARC
360# include <asm/u-boot-arc.h>
361#endif /* CONFIG_ARC */
362
363#ifdef CONFIG_AUTO_COMPLETE
364int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
365#endif
366int get_env_id (void);
367
368void pci_init (void);
369void pci_init_board(void);
370void pciinfo (int, int);
371
372#if defined(CONFIG_PCI) && defined(CONFIG_4xx)
373 int pci_pre_init (struct pci_controller *);
374 int is_pci_host (struct pci_controller *);
375#endif
376
377#if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
378# if defined(CONFIG_SYS_PCI_TARGET_INIT)
379 void pci_target_init (struct pci_controller *);
380# endif
381# if defined(CONFIG_SYS_PCI_MASTER_INIT)
382 void pci_master_init (struct pci_controller *);
383# endif
384#if defined(CONFIG_440SPE) || \
385 defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
386 defined(CONFIG_405EX)
387 void pcie_setup_hoses(int busno);
388#endif
389#endif
390
391int misc_init_f (void);
392int misc_init_r (void);
393
394/* common/exports.c */
395void jumptable_init(void);
396
397/* common/kallsysm.c */
398const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
399
400/* api/api.c */
401void api_init (void);
402
403/* common/memsize.c */
404long get_ram_size (long *, long);
405phys_size_t get_effective_memsize(void);
406
407/* $(BOARD)/$(BOARD).c */
408void reset_phy (void);
409void fdc_hw_init (void);
410
411/* $(BOARD)/eeprom.c */
412void eeprom_init (void);
413#ifndef CONFIG_SPI
414int eeprom_probe (unsigned dev_addr, unsigned offset);
415#endif
416int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
417int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
418
419/*
420 * Set this up regardless of board
421 * type, to prevent errors.
422 */
423#if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
424# define CONFIG_SYS_DEF_EEPROM_ADDR 0
425#else
426#if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
427# define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
428#endif
429#endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
430
431#if defined(CONFIG_SPI)
432extern void spi_init_f (void);
433extern void spi_init_r (void);
434extern ssize_t spi_read (uchar *, int, uchar *, int);
435extern ssize_t spi_write (uchar *, int, uchar *, int);
436#endif
437
438#ifdef CONFIG_EVB64260
439void evb64260_init(void);
440void debug_led(int, int);
441void display_mem_map(void);
442void perform_soft_reset(void);
443#endif
444
445/* $(BOARD)/$(BOARD).c */
446int board_early_init_f (void);
447int board_late_init (void);
448int board_postclk_init (void); /* after clocks/timebase, before env/serial */
449int board_early_init_r (void);
450void board_poweroff (void);
451
452#if defined(CONFIG_SYS_DRAM_TEST)
453int testdram(void);
454#endif /* CONFIG_SYS_DRAM_TEST */
455
456/* $(CPU)/start.S */
457#if defined(CONFIG_5xx) || \
458 defined(CONFIG_8xx)
459uint get_immr (uint);
460#endif
461uint get_pir (void);
462#if defined(CONFIG_MPC5xxx)
463uint get_svr (void);
464#endif
465uint get_pvr (void);
466uint get_svr (void);
467uint rd_ic_cst (void);
468void wr_ic_cst (uint);
469void wr_ic_adr (uint);
470uint rd_dc_cst (void);
471void wr_dc_cst (uint);
472void wr_dc_adr (uint);
473int icache_status (void);
474void icache_enable (void);
475void icache_disable(void);
476int dcache_status (void);
477void dcache_enable (void);
478void dcache_disable(void);
479void mmu_disable(void);
480#if defined(CONFIG_ARM)
481void relocate_code(ulong);
482#else
483void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
484#endif
485ulong get_endaddr (void);
486void trap_init (ulong);
487#if defined (CONFIG_4xx) || \
488 defined (CONFIG_MPC5xxx) || \
489 defined (CONFIG_74xx_7xx) || \
490 defined (CONFIG_74x) || \
491 defined (CONFIG_75x) || \
492 defined (CONFIG_74xx) || \
493 defined (CONFIG_MPC85xx) || \
494 defined (CONFIG_MPC86xx) || \
495 defined (CONFIG_MPC83xx)
496unsigned char in8(unsigned int);
497void out8(unsigned int, unsigned char);
498unsigned short in16(unsigned int);
499unsigned short in16r(unsigned int);
500void out16(unsigned int, unsigned short value);
501void out16r(unsigned int, unsigned short value);
502unsigned long in32(unsigned int);
503unsigned long in32r(unsigned int);
504void out32(unsigned int, unsigned long value);
505void out32r(unsigned int, unsigned long value);
506void ppcDcbf(unsigned long value);
507void ppcDcbi(unsigned long value);
508void ppcSync(void);
509void ppcDcbz(unsigned long value);
510#endif
511#if defined (CONFIG_MICROBLAZE)
512unsigned short in16(unsigned int);
513void out16(unsigned int, unsigned short value);
514#endif
515
516#if defined (CONFIG_MPC83xx)
517void ppcDWload(unsigned int *addr, unsigned int *ret);
518void ppcDWstore(unsigned int *addr, unsigned int *value);
519void disable_addr_trans(void);
520void enable_addr_trans(void);
521#if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
522void ddr_enable_ecc(unsigned int dram_size);
523#endif
524#endif
525
526/*
527 * Return the current value of a monotonically increasing microsecond timer.
528 * Granularity may be larger than 1us if hardware does not support this.
529 */
530ulong timer_get_us(void);
531
532/* $(CPU)/cpu.c */
533static inline int cpumask_next(int cpu, unsigned int mask)
534{
535 for (cpu++; !((1 << cpu) & mask); cpu++)
536 ;
537
538 return cpu;
539}
540
541#define for_each_cpu(iter, cpu, num_cpus, mask) \
542 for (iter = 0, cpu = cpumask_next(-1, mask); \
543 iter < num_cpus; \
544 iter++, cpu = cpumask_next(cpu, mask)) \
545
546int cpu_numcores (void);
547u32 cpu_mask (void);
548int is_core_valid (unsigned int);
549int probecpu (void);
550int checkcpu (void);
551int checkicache (void);
552int checkdcache (void);
553void upmconfig (unsigned int, unsigned int *, unsigned int);
554ulong get_tbclk (void);
555void reset_misc (void);
556void reset_cpu (ulong addr);
557#if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
558void ft_cpu_setup(void *blob, bd_t *bd);
559#ifdef CONFIG_PCI
560void ft_pci_setup(void *blob, bd_t *bd);
561#endif
562#endif
563
564void smp_set_core_boot_addr(unsigned long addr, int corenr);
565void smp_kick_all_cpus(void);
566
567/* $(CPU)/serial.c */
568int serial_init (void);
569void serial_setbrg (void);
570void serial_putc (const char);
571void serial_putc_raw(const char);
572void serial_puts (const char *);
573int serial_getc (void);
574int serial_tstc (void);
575
576/* These versions take a stdio_dev pointer */
577struct stdio_dev;
578int serial_stub_getc(struct stdio_dev *sdev);
579int serial_stub_tstc(struct stdio_dev *sdev);
580
581/* $(CPU)/speed.c */
582int get_clocks (void);
583int get_clocks_866 (void);
584int sdram_adjust_866 (void);
585int adjust_sdram_tbs_8xx (void);
586#if defined(CONFIG_MPC8260)
587int prt_8260_clks (void);
588#elif defined(CONFIG_MPC5xxx)
589int prt_mpc5xxx_clks (void);
590#endif
591#ifdef CONFIG_4xx
592ulong get_OPB_freq (void);
593ulong get_PCI_freq (void);
594#endif
595#if defined(CONFIG_S3C24X0) || \
596 defined(CONFIG_LH7A40X) || \
597 defined(CONFIG_EP93XX)
598ulong get_FCLK (void);
599ulong get_HCLK (void);
600ulong get_PCLK (void);
601ulong get_UCLK (void);
602#endif
603#if defined(CONFIG_LH7A40X)
604ulong get_PLLCLK (void);
605#endif
606#if defined(CONFIG_IMX)
607ulong get_systemPLLCLK(void);
608ulong get_FCLK(void);
609ulong get_HCLK(void);
610ulong get_BCLK(void);
611ulong get_PERCLK1(void);
612ulong get_PERCLK2(void);
613ulong get_PERCLK3(void);
614#endif
615ulong get_bus_freq (ulong);
616int get_serial_clock(void);
617
618#if defined(CONFIG_MPC85xx)
619typedef MPC85xx_SYS_INFO sys_info_t;
620void get_sys_info ( sys_info_t * );
621# if defined(CONFIG_OF_LIBFDT)
622 void ft_fixup_cpu(void *, u64);
623 void ft_fixup_num_cores(void *);
624# endif
625#endif
626#if defined(CONFIG_MPC86xx)
627typedef MPC86xx_SYS_INFO sys_info_t;
628void get_sys_info ( sys_info_t * );
629static inline ulong get_ddr_freq(ulong dummy)
630{
631 return get_bus_freq(dummy);
632}
633#else
634ulong get_ddr_freq(ulong);
635#endif
636
637#if defined(CONFIG_4xx)
638# if defined(CONFIG_440)
639# if defined(CONFIG_440SPE)
640 unsigned long determine_sysper(void);
641 unsigned long determine_pci_clock_per(void);
642# endif
643# endif
644typedef PPC4xx_SYS_INFO sys_info_t;
645int ppc440spe_revB(void);
646void get_sys_info ( sys_info_t * );
647#endif
648
649/* $(CPU)/cpu_init.c */
650#if defined(CONFIG_8xx) || defined(CONFIG_MPC8260)
651void cpu_init_f (volatile immap_t *immr);
652#endif
653#if defined(CONFIG_4xx) || defined(CONFIG_MCF52x2) || defined(CONFIG_MPC86xx)
654void cpu_init_f (void);
655#endif
656#ifdef CONFIG_MPC85xx
657ulong cpu_init_f(void);
658#endif
659
660int cpu_init_r (void);
661#if defined(CONFIG_MPC8260)
662int prt_8260_rsr (void);
663#elif defined(CONFIG_MPC83xx)
664int prt_83xx_rsr (void);
665#endif
666
667/* $(CPU)/interrupts.c */
668int interrupt_init (void);
669void timer_interrupt (struct pt_regs *);
670void external_interrupt (struct pt_regs *);
671void irq_install_handler(int, interrupt_handler_t *, void *);
672void irq_free_handler (int);
673void reset_timer (void);
674ulong get_timer (ulong base);
675
676/* Return value of monotonic microsecond timer */
677unsigned long timer_get_us(void);
678
679void enable_interrupts (void);
680int disable_interrupts (void);
681
682/* $(CPU)/.../commproc.c */
683int dpram_init (void);
684uint dpram_base(void);
685uint dpram_base_align(uint align);
686uint dpram_alloc(uint size);
687uint dpram_alloc_align(uint size,uint align);
688void bootcount_store (ulong);
689ulong bootcount_load (void);
690#define BOOTCOUNT_MAGIC 0xB001C041
691
692/* $(CPU)/.../<eth> */
693void mii_init (void);
694
695/* $(CPU)/.../lcd.c */
696ulong lcd_setmem (ulong);
697
698/* $(CPU)/.../video.c */
699ulong video_setmem (ulong);
700
701/* arch/$(ARCH)/lib/cache.c */
702void enable_caches(void);
703void flush_cache (unsigned long, unsigned long);
704void flush_dcache_all(void);
705void flush_dcache_range(unsigned long start, unsigned long stop);
706void invalidate_dcache_range(unsigned long start, unsigned long stop);
707void invalidate_dcache_all(void);
708void invalidate_icache_all(void);
709
710/* arch/$(ARCH)/lib/ticks.S */
711uint64_t get_ticks(void);
712void wait_ticks (unsigned long);
713
714/* arch/$(ARCH)/lib/time.c */
715void __udelay (unsigned long);
716ulong usec2ticks (unsigned long usec);
717ulong ticks2usec (unsigned long ticks);
718int init_timebase (void);
719
720/* lib/gunzip.c */
721int gunzip(void *, int, unsigned char *, unsigned long *);
722int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
723 int stoponerr, int offset);
724
725/* lib/qsort.c */
726void qsort(void *base, size_t nmemb, size_t size,
727 int(*compar)(const void *, const void *));
728int strcmp_compar(const void *, const void *);
729
730/* lib/time.c */
731void udelay (unsigned long);
732void mdelay(unsigned long);
733
734/* lib/uuid.c */
735#include <uuid.h>
736
737/* lib/vsprintf.c */
738#include <vsprintf.h>
739
740/* lib/strmhz.c */
741char * strmhz(char *buf, unsigned long hz);
742
743/* lib/crc32.c */
744#include <u-boot/crc.h>
745
746/* lib/rand.c */
747#define RAND_MAX -1U
748void srand(unsigned int seed);
749unsigned int rand(void);
750unsigned int rand_r(unsigned int *seedp);
751
752/* common/console.c */
753int console_init_f(void); /* Before relocation; uses the serial stuff */
754int console_init_m(void);
755int console_init_r(void); /* After relocation; uses the console stuff */
756int console_assign(int file, const char *devname); /* Assign the console */
757int ctrlc (void);
758int had_ctrlc (void); /* have we had a Control-C since last clear? */
759void clear_ctrlc (void); /* clear the Control-C condition */
760int disable_ctrlc (int); /* 1 to disable, 0 to enable Control-C detect */
761int confirm_yesno(void); /* 1 if input is "y", "Y", "yes" or "YES" */
762/*
763 * STDIO based functions (can always be used)
764 */
765/* serial stuff */
766int serial_printf (const char *fmt, ...)
767 __attribute__ ((format (__printf__, 1, 2)));
768/* stdin */
769int getc(void);
770int tstc(void);
771
772/* stdout */
773void putc(const char c);
774void puts(const char *s);
775int printf(const char *fmt, ...)
776 __attribute__ ((format (__printf__, 1, 2)));
777int vprintf(const char *fmt, va_list args);
778
779#ifdef CONFIG_SILENT_CONSOLE
780extern void flush_print_buf(void);
781extern void destory_print_buf(void);
782#endif
783
784/* stderr */
785#define eputc(c) fputc(stderr, c)
786#define eputs(s) fputs(stderr, s)
787#define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
788
789/*
790 * FILE based functions (can only be used AFTER relocation!)
791 */
792#define stdin 0
793#define stdout 1
794#define stderr 2
795#define MAX_FILES 3
796
797int fprintf(int file, const char *fmt, ...)
798 __attribute__ ((format (__printf__, 2, 3)));
799void fputs(int file, const char *s);
800void fputc(int file, const char c);
801int ftstc(int file);
802int fgetc(int file);
803
804/* lib/gzip.c */
805int gzip(void *dst, unsigned long *lenp,
806 unsigned char *src, unsigned long srclen);
807int zzip(void *dst, unsigned long *lenp, unsigned char *src,
808 unsigned long srclen, int stoponerr,
809 int (*func)(unsigned long, unsigned long));
810
811/* lib/net_utils.c */
812#include <net.h>
813static inline IPaddr_t getenv_IPaddr(char *var)
814{
815 return string_to_ip(getenv(var));
816}
817
818/*
819 * CONSOLE multiplexing.
820 */
821#ifdef CONFIG_CONSOLE_MUX
822#include <iomux.h>
823#endif
824
825int pcmcia_init (void);
826
827#ifdef CONFIG_STATUS_LED
828# include <status_led.h>
829#endif
830
831#include <bootstage.h>
832
833#ifdef CONFIG_SHOW_ACTIVITY
834void show_activity(int arg);
835#endif
836
837/* Multicore arch functions */
838#ifdef CONFIG_MP
839int cpu_status(int nr);
840int cpu_reset(int nr);
841int cpu_disable(int nr);
842int cpu_release(int nr, int argc, char * const argv[]);
843#endif
844
845/* Define a null map_sysmem() if the architecture doesn't use it */
846# ifndef CONFIG_ARCH_MAP_SYSMEM
847static inline void *map_sysmem(phys_addr_t paddr, unsigned long len)
848{
849 return (void *)(uintptr_t)paddr;
850}
851
852static inline void unmap_sysmem(const void *vaddr)
853{
854}
855
856static inline phys_addr_t map_to_sysmem(const void *ptr)
857{
858 return (phys_addr_t)(uintptr_t)ptr;
859}
860# endif
861
862#endif /* __ASSEMBLY__ */
863
864#ifdef CONFIG_PPC
865/*
866 * Has to be included outside of the #ifndef __ASSEMBLY__ section.
867 * Otherwise might lead to compilation errors in assembler files.
868 */
869#include <asm/cache.h>
870#endif
871
872/* Put only stuff here that the assembler can digest */
873
874#ifdef CONFIG_POST
875#define CONFIG_HAS_POST
876#ifndef CONFIG_POST_ALT_LIST
877#define CONFIG_POST_STD_LIST
878#endif
879#endif
880
881#ifdef CONFIG_INIT_CRITICAL
882#error CONFIG_INIT_CRITICAL is deprecated!
883#error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
884#endif
885
886#define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
887
888/*
889 * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture. It
890 * is used to align DMA buffers.
891 */
892#ifndef __ASSEMBLY__
893#include <asm/cache.h>
894#endif
895
896/*
897 * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the
898 * stack that meets the minimum architecture alignment requirements for DMA.
899 * Such a buffer is useful for DMA operations where flushing and invalidating
900 * the cache before and after a read and/or write operation is required for
901 * correct operations.
902 *
903 * When called the macro creates an array on the stack that is sized such
904 * that:
905 *
906 * 1) The beginning of the array can be advanced enough to be aligned.
907 *
908 * 2) The size of the aligned portion of the array is a multiple of the minimum
909 * architecture alignment required for DMA.
910 *
911 * 3) The aligned portion contains enough space for the original number of
912 * elements requested.
913 *
914 * The macro then creates a pointer to the aligned portion of this array and
915 * assigns to the pointer the address of the first element in the aligned
916 * portion of the array.
917 *
918 * Calling the macro as:
919 *
920 * ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024);
921 *
922 * Will result in something similar to saying:
923 *
924 * uint32_t buffer[1024];
925 *
926 * The following differences exist:
927 *
928 * 1) The resulting buffer is guaranteed to be aligned to the value of
929 * ARCH_DMA_MINALIGN.
930 *
931 * 2) The buffer variable created by the macro is a pointer to the specified
932 * type, and NOT an array of the specified type. This can be very important
933 * if you want the address of the buffer, which you probably do, to pass it
934 * to the DMA hardware. The value of &buffer is different in the two cases.
935 * In the macro case it will be the address of the pointer, not the address
936 * of the space reserved for the buffer. However, in the second case it
937 * would be the address of the buffer. So if you are replacing hard coded
938 * stack buffers with this macro you need to make sure you remove the & from
939 * the locations where you are taking the address of the buffer.
940 *
941 * Note that the size parameter is the number of array elements to allocate,
942 * not the number of bytes.
943 *
944 * This macro can not be used outside of function scope, or for the creation
945 * of a function scoped static buffer. It can not be used to create a cache
946 * line aligned global buffer.
947 */
948#define PAD_COUNT(s, pad) (((s) - 1) / (pad) + 1)
949#define PAD_SIZE(s, pad) (PAD_COUNT(s, pad) * pad)
950#define ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, pad) \
951 char __##name[ROUND(PAD_SIZE((size) * sizeof(type), pad), align) \
952 + (align - 1)]; \
953 \
954 type *name = (type *) ALIGN((uintptr_t)__##name, align)
955#define ALLOC_ALIGN_BUFFER(type, name, size, align) \
956 ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, 1)
957#define ALLOC_CACHE_ALIGN_BUFFER_PAD(type, name, size, pad) \
958 ALLOC_ALIGN_BUFFER_PAD(type, name, size, ARCH_DMA_MINALIGN, pad)
959#define ALLOC_CACHE_ALIGN_BUFFER(type, name, size) \
960 ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
961
962/*
963 * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
964 * purpose is to allow allocating aligned buffers outside of function scope.
965 * Usage of this macro shall be avoided or used with extreme care!
966 */
967#define DEFINE_ALIGN_BUFFER(type, name, size, align) \
968 static char __##name[ALIGN(size * sizeof(type), align)] \
969 __aligned(align); \
970 \
971 static type *name = (type *)__##name
972#define DEFINE_CACHE_ALIGN_BUFFER(type, name, size) \
973 DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
974
975/* Pull in stuff for the build system */
976#ifdef DO_DEPS_ONLY
977# include <environment.h>
978#endif
979
980#endif /* __COMMON_H_ */
981