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