common.h: Introduce DEFINE_CACHE_ALIGN_BUFFER
[platform/kernel/u-boot.git] / include / common.h
1 /*
2  * (C) Copyright 2000-2009
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * See file CREDITS for list of people who contributed to this
6  * project.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation; either version 2 of
11  * the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  */
23
24 #ifndef __COMMON_H_
25 #define __COMMON_H_     1
26
27 #undef  _LINUX_CONFIG_H
28 #define _LINUX_CONFIG_H 1       /* avoid reading Linux autoconf.h file  */
29
30 #ifndef __ASSEMBLY__            /* put C only stuff in this section */
31
32 typedef unsigned char           uchar;
33 typedef volatile unsigned long  vu_long;
34 typedef volatile unsigned short vu_short;
35 typedef volatile unsigned char  vu_char;
36
37 #include <config.h>
38 #include <asm-offsets.h>
39 #include <linux/bitops.h>
40 #include <linux/types.h>
41 #include <linux/string.h>
42 #include <linux/compiler.h>
43 #include <asm/ptrace.h>
44 #include <stdarg.h>
45 #if defined(CONFIG_PCI) && (defined(CONFIG_4xx) && !defined(CONFIG_AP1000))
46 #include <pci.h>
47 #endif
48 #if defined(CONFIG_8xx)
49 #include <asm/8xx_immap.h>
50 #if defined(CONFIG_MPC852)      || defined(CONFIG_MPC852T)      || \
51     defined(CONFIG_MPC859)      || defined(CONFIG_MPC859T)      || \
52     defined(CONFIG_MPC859DSL)   || \
53     defined(CONFIG_MPC866)      || defined(CONFIG_MPC866T)      || \
54     defined(CONFIG_MPC866P)
55 # define CONFIG_MPC866_FAMILY 1
56 #elif defined(CONFIG_MPC870) \
57    || defined(CONFIG_MPC875) \
58    || defined(CONFIG_MPC880) \
59    || defined(CONFIG_MPC885)
60 # define CONFIG_MPC885_FAMILY   1
61 #endif
62 #if   defined(CONFIG_MPC860)       \
63    || defined(CONFIG_MPC860T)      \
64    || defined(CONFIG_MPC866_FAMILY) \
65    || defined(CONFIG_MPC885_FAMILY)
66 # define CONFIG_MPC86x 1
67 #endif
68 #elif defined(CONFIG_5xx)
69 #include <asm/5xx_immap.h>
70 #elif defined(CONFIG_MPC5xxx)
71 #include <mpc5xxx.h>
72 #elif defined(CONFIG_MPC512X)
73 #include <asm/immap_512x.h>
74 #elif defined(CONFIG_MPC8220)
75 #include <asm/immap_8220.h>
76 #elif defined(CONFIG_8260)
77 #if   defined(CONFIG_MPC8247) \
78    || defined(CONFIG_MPC8248) \
79    || defined(CONFIG_MPC8271) \
80    || defined(CONFIG_MPC8272)
81 #define CONFIG_MPC8272_FAMILY   1
82 #endif
83 #if defined(CONFIG_MPC8272_FAMILY)
84 #define CONFIG_MPC8260  1
85 #endif
86 #include <asm/immap_8260.h>
87 #endif
88 #ifdef CONFIG_MPC86xx
89 #include <mpc86xx.h>
90 #include <asm/immap_86xx.h>
91 #endif
92 #ifdef CONFIG_MPC85xx
93 #include <mpc85xx.h>
94 #include <asm/immap_85xx.h>
95 #endif
96 #ifdef CONFIG_MPC83xx
97 #include <mpc83xx.h>
98 #include <asm/immap_83xx.h>
99 #endif
100 #ifdef  CONFIG_4xx
101 #include <asm/ppc4xx.h>
102 #endif
103 #ifdef CONFIG_HYMOD
104 #include <board/hymod/hymod.h>
105 #endif
106 #ifdef CONFIG_ARM
107 #define asmlinkage      /* nothing */
108 #endif
109 #ifdef CONFIG_BLACKFIN
110 #include <asm/blackfin.h>
111 #endif
112 #ifdef CONFIG_SOC_DA8XX
113 #include <asm/arch/hardware.h>
114 #endif
115
116 #include <part.h>
117 #include <flash.h>
118 #include <image.h>
119
120 #ifdef DEBUG
121 #define _DEBUG  1
122 #else
123 #define _DEBUG  0
124 #endif
125
126 /*
127  * Output a debug text when condition "cond" is met. The "cond" should be
128  * computed by a preprocessor in the best case, allowing for the best
129  * optimization.
130  */
131 #define debug_cond(cond, fmt, args...)          \
132         do {                                    \
133                 if (cond)                       \
134                         printf(fmt, ##args);    \
135         } while (0)
136
137 #define debug(fmt, args...)                     \
138         debug_cond(_DEBUG, fmt, ##args)
139
140 /*
141  * An assertion is run-time check done in debug mode only. If DEBUG is not
142  * defined then it is skipped. If DEBUG is defined and the assertion fails,
143  * then it calls panic*( which may or may not reset/halt U-Boot (see
144  * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
145  * before release, and after release it is hoped that they don't matter. But
146  * in any case these failing assertions cannot be fixed with a reset (which
147  * may just do the same assertion again).
148  */
149 void __assert_fail(const char *assertion, const char *file, unsigned line,
150                    const char *function);
151 #define assert(x) \
152         ({ if (!(x) && _DEBUG) \
153                 __assert_fail(#x, __FILE__, __LINE__, __func__); })
154
155 #define error(fmt, args...) do {                                        \
156                 printf("ERROR: " fmt "\nat %s:%d/%s()\n",               \
157                         ##args, __FILE__, __LINE__, __func__);          \
158 } while (0)
159
160 #ifndef BUG
161 #define BUG() do { \
162         printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
163         panic("BUG!"); \
164 } while (0)
165 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
166 #endif /* BUG */
167
168 /* Force a compilation error if condition is true */
169 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
170
171 typedef void (interrupt_handler_t)(void *);
172
173 #include <asm/u-boot.h> /* boot information for Linux kernel */
174 #include <asm/global_data.h>    /* global data used for startup functions */
175
176 /*
177  * enable common handling for all TQM8xxL/M boards:
178  * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
179  * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
180  *                  and for the TQM885D board
181  */
182 #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
183     defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
184     defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
185 # ifndef CONFIG_TQM8xxM
186 #  define CONFIG_TQM8xxM
187 # endif
188 #endif
189 #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
190     defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
191     defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
192     defined(CONFIG_TQM885D)
193 # ifndef CONFIG_TQM8xxL
194 #  define CONFIG_TQM8xxL
195 # endif
196 #endif
197
198 #ifndef CONFIG_SERIAL_MULTI
199
200 #if defined(CONFIG_8xx_CONS_SMC1) || defined(CONFIG_8xx_CONS_SMC2) \
201  || defined(CONFIG_8xx_CONS_SCC1) || defined(CONFIG_8xx_CONS_SCC2) \
202  || defined(CONFIG_8xx_CONS_SCC3) || defined(CONFIG_8xx_CONS_SCC4)
203
204 #define CONFIG_SERIAL_MULTI     1
205
206 #endif
207
208 #endif /* CONFIG_SERIAL_MULTI */
209
210 /*
211  * General Purpose Utilities
212  */
213 #define min(X, Y)                               \
214         ({ typeof (X) __x = (X);                \
215                 typeof (Y) __y = (Y);           \
216                 (__x < __y) ? __x : __y; })
217
218 #define max(X, Y)                               \
219         ({ typeof (X) __x = (X);                \
220                 typeof (Y) __y = (Y);           \
221                 (__x > __y) ? __x : __y; })
222
223 #define MIN(x, y)  min(x, y)
224 #define MAX(x, y)  max(x, y)
225
226 /*
227  * Return the absolute value of a number.
228  *
229  * This handles unsigned and signed longs, ints, shorts and chars.  For all
230  * input types abs() returns a signed long.
231  *
232  * For 64-bit types, use abs64()
233  */
234 #define abs(x) ({                                               \
235                 long ret;                                       \
236                 if (sizeof(x) == sizeof(long)) {                \
237                         long __x = (x);                         \
238                         ret = (__x < 0) ? -__x : __x;           \
239                 } else {                                        \
240                         int __x = (x);                          \
241                         ret = (__x < 0) ? -__x : __x;           \
242                 }                                               \
243                 ret;                                            \
244         })
245
246 #define abs64(x) ({                             \
247                 s64 __x = (x);                  \
248                 (__x < 0) ? -__x : __x;         \
249         })
250
251 #if defined(CONFIG_ENV_IS_EMBEDDED)
252 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
253 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
254         (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
255       defined(CONFIG_ENV_IS_IN_NVRAM)
256 #define TOTAL_MALLOC_LEN        (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
257 #else
258 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
259 #endif
260
261 /**
262  * container_of - cast a member of a structure out to the containing structure
263  * @ptr:        the pointer to the member.
264  * @type:       the type of the container struct this is embedded in.
265  * @member:     the name of the member within the struct.
266  *
267  */
268 #define container_of(ptr, type, member) ({                      \
269         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
270         (type *)( (char *)__mptr - offsetof(type,member) );})
271
272 /*
273  * Function Prototypes
274  */
275
276 void    hang            (void) __attribute__ ((noreturn));
277
278 int     timer_init(void);
279 int     cpu_init(void);
280
281 /* */
282 phys_size_t initdram (int);
283 int     display_options (void);
284 void    print_size(unsigned long long, const char *);
285 int     print_buffer (ulong addr, void* data, uint width, uint count, uint linelen);
286
287 /* common/main.c */
288 void    main_loop       (void);
289 int run_command(const char *cmd, int flag);
290 int     readline        (const char *const prompt);
291 int     readline_into_buffer(const char *const prompt, char *buffer,
292                         int timeout);
293 int     parse_line (char *, char *[]);
294 void    init_cmd_timeout(void);
295 void    reset_cmd_timeout(void);
296 #ifdef CONFIG_MENU
297 int     abortboot(int bootdelay);
298 #endif
299 extern char console_buffer[];
300
301 /* arch/$(ARCH)/lib/board.c */
302 void    board_init_f  (ulong) __attribute__ ((noreturn));
303 void    board_init_r  (gd_t *, ulong) __attribute__ ((noreturn));
304 int     checkboard    (void);
305 int     checkflash    (void);
306 int     checkdram     (void);
307 int     last_stage_init(void);
308 extern ulong monitor_flash_len;
309 int mac_read_from_eeprom(void);
310 extern u8 _binary_dt_dtb_start[];       /* embedded device tree blob */
311 int set_cpu_clk_info(void);
312
313 /* common/flash.c */
314 void flash_perror (int);
315
316 /* common/cmd_source.c */
317 int     source (ulong addr, const char *fit_uname);
318
319 extern ulong load_addr;         /* Default Load Address */
320 extern ulong save_addr;         /* Default Save Address */
321 extern ulong save_size;         /* Default Save Size */
322
323 /* common/cmd_doc.c */
324 void    doc_probe(unsigned long physadr);
325
326 /* common/cmd_net.c */
327 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
328
329 /* common/cmd_fat.c */
330 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
331
332 /* common/cmd_ext2.c */
333 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
334
335 /* common/cmd_nvedit.c */
336 int     env_init     (void);
337 void    env_relocate (void);
338 int     envmatch     (uchar *, int);
339 char    *getenv      (const char *);
340 int     getenv_f     (const char *name, char *buf, unsigned len);
341 ulong getenv_ulong(const char *name, int base, ulong default_val);
342 int     saveenv      (void);
343 #ifdef CONFIG_PPC               /* ARM version to be fixed! */
344 int inline setenv    (const char *, const char *);
345 #else
346 int     setenv       (const char *, const char *);
347 int setenv_ulong(const char *varname, ulong value);
348 int setenv_addr(const char *varname, const void *addr);
349 #endif /* CONFIG_PPC */
350 #ifdef CONFIG_ARM
351 # include <asm/mach-types.h>
352 # include <asm/setup.h>
353 # include <asm/u-boot-arm.h>    /* ARM version to be fixed! */
354 #endif /* CONFIG_ARM */
355 #ifdef CONFIG_X86               /* x86 version to be fixed! */
356 # include <asm/u-boot-x86.h>
357 #endif /* CONFIG_X86 */
358 #ifdef CONFIG_SANDBOX
359 # include <asm/u-boot-sandbox.h>        /* TODO(sjg) what needs to be fixed? */
360 #endif
361 #ifdef CONFIG_NDS32
362 # include <asm/mach-types.h>
363 # include <asm/u-boot-nds32.h>
364 #endif /* CONFIG_NDS32 */
365 #ifdef CONFIG_MIPS
366 # include <asm/u-boot-mips.h>
367 #endif /* CONFIG_MIPS */
368
369 #ifdef CONFIG_AUTO_COMPLETE
370 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
371 #endif
372 int get_env_id (void);
373
374 void    pci_init      (void);
375 void    pci_init_board(void);
376 void    pciinfo       (int, int);
377
378 #if defined(CONFIG_PCI) && (defined(CONFIG_4xx) && !defined(CONFIG_AP1000))
379     int    pci_pre_init        (struct pci_controller *);
380     int    is_pci_host         (struct pci_controller *);
381 #endif
382
383 #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
384 #   if defined(CONFIG_SYS_PCI_TARGET_INIT)
385         void    pci_target_init      (struct pci_controller *);
386 #   endif
387 #   if defined(CONFIG_SYS_PCI_MASTER_INIT)
388         void    pci_master_init      (struct pci_controller *);
389 #   endif
390 #if defined(CONFIG_440SPE) || \
391     defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
392     defined(CONFIG_405EX)
393    void pcie_setup_hoses(int busno);
394 #endif
395 #endif
396
397 int     misc_init_f   (void);
398 int     misc_init_r   (void);
399
400 /* common/exports.c */
401 void    jumptable_init(void);
402
403 /* common/kallsysm.c */
404 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
405
406 /* api/api.c */
407 void    api_init (void);
408
409 /* common/memsize.c */
410 long    get_ram_size  (long *, long);
411
412 /* $(BOARD)/$(BOARD).c */
413 void    reset_phy     (void);
414 void    fdc_hw_init   (void);
415
416 /* $(BOARD)/eeprom.c */
417 void eeprom_init  (void);
418 #ifndef CONFIG_SPI
419 int  eeprom_probe (unsigned dev_addr, unsigned offset);
420 #endif
421 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
422 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
423 #ifdef CONFIG_LWMON
424 extern uchar pic_read  (uchar reg);
425 extern void  pic_write (uchar reg, uchar val);
426 #endif
427
428 /*
429  * Set this up regardless of board
430  * type, to prevent errors.
431  */
432 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
433 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
434 #else
435 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
436 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
437 #endif
438 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
439
440 #if defined(CONFIG_SPI)
441 extern void spi_init_f (void);
442 extern void spi_init_r (void);
443 extern ssize_t spi_read  (uchar *, int, uchar *, int);
444 extern ssize_t spi_write (uchar *, int, uchar *, int);
445 #endif
446
447 #ifdef CONFIG_RPXCLASSIC
448 void rpxclassic_init (void);
449 #endif
450
451 void rpxlite_init (void);
452
453 #ifdef CONFIG_MBX
454 /* $(BOARD)/mbx8xx.c */
455 void    mbx_init (void);
456 void    board_serial_init (void);
457 void    board_ether_init (void);
458 #endif
459
460 #ifdef CONFIG_HERMES
461 /* $(BOARD)/hermes.c */
462 void hermes_start_lxt980 (int speed);
463 #endif
464
465 #ifdef CONFIG_EVB64260
466 void  evb64260_init(void);
467 void  debug_led(int, int);
468 void  display_mem_map(void);
469 void  perform_soft_reset(void);
470 #endif
471
472 /* $(BOARD)/$(BOARD).c */
473 int board_early_init_f (void);
474 int board_late_init (void);
475 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
476 int board_early_init_r (void);
477 void board_poweroff (void);
478
479 #if defined(CONFIG_SYS_DRAM_TEST)
480 int testdram(void);
481 #endif /* CONFIG_SYS_DRAM_TEST */
482
483 /* $(CPU)/start.S */
484 #if defined(CONFIG_5xx) || \
485     defined(CONFIG_8xx)
486 uint    get_immr      (uint);
487 #endif
488 uint    get_pir       (void);
489 #if defined(CONFIG_MPC5xxx)
490 uint    get_svr       (void);
491 #endif
492 uint    get_pvr       (void);
493 uint    get_svr       (void);
494 uint    rd_ic_cst     (void);
495 void    wr_ic_cst     (uint);
496 void    wr_ic_adr     (uint);
497 uint    rd_dc_cst     (void);
498 void    wr_dc_cst     (uint);
499 void    wr_dc_adr     (uint);
500 int     icache_status (void);
501 void    icache_enable (void);
502 void    icache_disable(void);
503 int     dcache_status (void);
504 void    dcache_enable (void);
505 void    dcache_disable(void);
506 void    mmu_disable(void);
507 void    relocate_code (ulong, gd_t *, ulong) __attribute__ ((noreturn));
508 ulong   get_endaddr   (void);
509 void    trap_init     (ulong);
510 #if defined (CONFIG_4xx)        || \
511     defined (CONFIG_MPC5xxx)    || \
512     defined (CONFIG_74xx_7xx)   || \
513     defined (CONFIG_74x)        || \
514     defined (CONFIG_75x)        || \
515     defined (CONFIG_74xx)       || \
516     defined (CONFIG_MPC8220)    || \
517     defined (CONFIG_MPC85xx)    || \
518     defined (CONFIG_MPC86xx)    || \
519     defined (CONFIG_MPC83xx)
520 unsigned char   in8(unsigned int);
521 void            out8(unsigned int, unsigned char);
522 unsigned short  in16(unsigned int);
523 unsigned short  in16r(unsigned int);
524 void            out16(unsigned int, unsigned short value);
525 void            out16r(unsigned int, unsigned short value);
526 unsigned long   in32(unsigned int);
527 unsigned long   in32r(unsigned int);
528 void            out32(unsigned int, unsigned long value);
529 void            out32r(unsigned int, unsigned long value);
530 void            ppcDcbf(unsigned long value);
531 void            ppcDcbi(unsigned long value);
532 void            ppcSync(void);
533 void            ppcDcbz(unsigned long value);
534 #endif
535 #if defined (CONFIG_MICROBLAZE)
536 unsigned short  in16(unsigned int);
537 void            out16(unsigned int, unsigned short value);
538 #endif
539
540 #if defined (CONFIG_MPC83xx)
541 void            ppcDWload(unsigned int *addr, unsigned int *ret);
542 void            ppcDWstore(unsigned int *addr, unsigned int *value);
543 void disable_addr_trans(void);
544 void enable_addr_trans(void);
545 #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
546 void ddr_enable_ecc(unsigned int dram_size);
547 #endif
548 #endif
549
550 /* $(CPU)/cpu.c */
551 static inline int cpumask_next(int cpu, unsigned int mask)
552 {
553         for (cpu++; !((1 << cpu) & mask); cpu++)
554                 ;
555
556         return cpu;
557 }
558
559 #define for_each_cpu(iter, cpu, num_cpus, mask) \
560         for (iter = 0, cpu = cpumask_next(-1, mask); \
561                 iter < num_cpus; \
562                 iter++, cpu = cpumask_next(cpu, mask)) \
563
564 int     cpu_numcores  (void);
565 u32     cpu_mask      (void);
566 int     is_core_valid (unsigned int);
567 int     probecpu      (void);
568 int     checkcpu      (void);
569 int     checkicache   (void);
570 int     checkdcache   (void);
571 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
572 ulong   get_tbclk     (void);
573 void    reset_cpu     (ulong addr);
574 #if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
575 void ft_cpu_setup(void *blob, bd_t *bd);
576 #ifdef CONFIG_PCI
577 void ft_pci_setup(void *blob, bd_t *bd);
578 #endif
579 #endif
580
581
582 /* $(CPU)/serial.c */
583 int     serial_init   (void);
584 void    serial_setbrg (void);
585 void    serial_putc   (const char);
586 void    serial_putc_raw(const char);
587 void    serial_puts   (const char *);
588 int     serial_getc   (void);
589 int     serial_tstc   (void);
590
591 void    _serial_setbrg (const int);
592 void    _serial_putc   (const char, const int);
593 void    _serial_putc_raw(const char, const int);
594 void    _serial_puts   (const char *, const int);
595 int     _serial_getc   (const int);
596 int     _serial_tstc   (const int);
597
598 /* $(CPU)/speed.c */
599 int     get_clocks (void);
600 int     get_clocks_866 (void);
601 int     sdram_adjust_866 (void);
602 int     adjust_sdram_tbs_8xx (void);
603 #if defined(CONFIG_8260)
604 int     prt_8260_clks (void);
605 #elif defined(CONFIG_MPC5xxx)
606 int     prt_mpc5xxx_clks (void);
607 #endif
608 #if defined(CONFIG_MPC512X)
609 int     prt_mpc512xxx_clks (void);
610 #endif
611 #if defined(CONFIG_MPC8220)
612 int     prt_mpc8220_clks (void);
613 #endif
614 #ifdef CONFIG_4xx
615 ulong   get_OPB_freq (void);
616 ulong   get_PCI_freq (void);
617 #endif
618 #if defined(CONFIG_S3C24X0) || \
619     defined(CONFIG_LH7A40X) || \
620     defined(CONFIG_S3C6400) || \
621     defined(CONFIG_EP93XX)
622 ulong   get_FCLK (void);
623 ulong   get_HCLK (void);
624 ulong   get_PCLK (void);
625 ulong   get_UCLK (void);
626 #endif
627 #if defined(CONFIG_LH7A40X)
628 ulong   get_PLLCLK (void);
629 #endif
630 #if defined CONFIG_INCA_IP
631 uint    incaip_get_cpuclk (void);
632 #endif
633 #if defined(CONFIG_IMX)
634 ulong get_systemPLLCLK(void);
635 ulong get_FCLK(void);
636 ulong get_HCLK(void);
637 ulong get_BCLK(void);
638 ulong get_PERCLK1(void);
639 ulong get_PERCLK2(void);
640 ulong get_PERCLK3(void);
641 #endif
642 ulong   get_bus_freq  (ulong);
643 int get_serial_clock(void);
644
645 #if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx)
646 ulong get_ddr_freq(ulong);
647 #endif
648 #if defined(CONFIG_MPC85xx)
649 typedef MPC85xx_SYS_INFO sys_info_t;
650 void    get_sys_info  ( sys_info_t * );
651 #endif
652 #if defined(CONFIG_MPC86xx)
653 typedef MPC86xx_SYS_INFO sys_info_t;
654 void   get_sys_info  ( sys_info_t * );
655 static inline ulong get_ddr_freq(ulong dummy)
656 {
657         return get_bus_freq(dummy);
658 }
659 #endif
660
661 #if defined(CONFIG_4xx) || defined(CONFIG_IOP480)
662 #  if defined(CONFIG_440)
663 #       if defined(CONFIG_440SPE)
664          unsigned long determine_sysper(void);
665          unsigned long determine_pci_clock_per(void);
666 #       endif
667 #  endif
668 typedef PPC4xx_SYS_INFO sys_info_t;
669 int     ppc440spe_revB(void);
670 void    get_sys_info  ( sys_info_t * );
671 #endif
672
673 /* $(CPU)/cpu_init.c */
674 #if defined(CONFIG_8xx) || defined(CONFIG_8260)
675 void    cpu_init_f    (volatile immap_t *immr);
676 #endif
677 #if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2) ||defined(CONFIG_MPC86xx)
678 void    cpu_init_f    (void);
679 #endif
680
681 int     cpu_init_r    (void);
682 #if defined(CONFIG_8260)
683 int     prt_8260_rsr  (void);
684 #elif defined(CONFIG_MPC83xx)
685 int     prt_83xx_rsr  (void);
686 #endif
687
688 /* $(CPU)/interrupts.c */
689 int     interrupt_init     (void);
690 void    timer_interrupt    (struct pt_regs *);
691 void    external_interrupt (struct pt_regs *);
692 void    irq_install_handler(int, interrupt_handler_t *, void *);
693 void    irq_free_handler   (int);
694 void    reset_timer        (void);
695 ulong   get_timer          (ulong base);
696 void    enable_interrupts  (void);
697 int     disable_interrupts (void);
698
699 /* $(CPU)/.../commproc.c */
700 int     dpram_init (void);
701 uint    dpram_base(void);
702 uint    dpram_base_align(uint align);
703 uint    dpram_alloc(uint size);
704 uint    dpram_alloc_align(uint size,uint align);
705 void    bootcount_store (ulong);
706 ulong   bootcount_load (void);
707 #define BOOTCOUNT_MAGIC         0xB001C041
708
709 /* $(CPU)/.../<eth> */
710 void mii_init (void);
711
712 /* $(CPU)/.../lcd.c */
713 ulong   lcd_setmem (ulong);
714
715 /* $(CPU)/.../video.c */
716 ulong   video_setmem (ulong);
717
718 /* arch/$(ARCH)/lib/cache.c */
719 void    enable_caches(void);
720 void    flush_cache   (unsigned long, unsigned long);
721 void    flush_dcache_all(void);
722 void    flush_dcache_range(unsigned long start, unsigned long stop);
723 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
724 void    invalidate_dcache_all(void);
725 void    invalidate_icache_all(void);
726
727 /* arch/$(ARCH)/lib/ticks.S */
728 unsigned long long get_ticks(void);
729 void    wait_ticks    (unsigned long);
730
731 /* arch/$(ARCH)/lib/time.c */
732 void    __udelay      (unsigned long);
733 ulong   usec2ticks    (unsigned long usec);
734 ulong   ticks2usec    (unsigned long ticks);
735 int     init_timebase (void);
736
737 /* lib/gunzip.c */
738 int gunzip(void *, int, unsigned char *, unsigned long *);
739 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
740                                                 int stoponerr, int offset);
741
742 /* lib/qsort.c */
743 void qsort(void *base, size_t nmemb, size_t size,
744            int(*compar)(const void *, const void *));
745 int strcmp_compar(const void *, const void *);
746
747 /* lib/time.c */
748 void    udelay        (unsigned long);
749 void mdelay(unsigned long);
750
751 /* lib/uuid.c */
752 void uuid_str_to_bin(const char *uuid, unsigned char *out);
753 int uuid_str_valid(const char *uuid);
754
755 /* lib/vsprintf.c */
756 #include <vsprintf.h>
757
758 /* lib/strmhz.c */
759 char *  strmhz(char *buf, unsigned long hz);
760
761 /* lib/crc32.c */
762 #include <u-boot/crc.h>
763
764 /* lib/rand.c */
765 #if defined(CONFIG_RANDOM_MACADDR) || \
766         defined(CONFIG_BOOTP_RANDOM_DELAY) || \
767         defined(CONFIG_CMD_LINK_LOCAL)
768 #define RAND_MAX -1U
769 void srand(unsigned int seed);
770 unsigned int rand(void);
771 unsigned int rand_r(unsigned int *seedp);
772 #endif
773
774 /* common/console.c */
775 int     console_init_f(void);   /* Before relocation; uses the serial  stuff    */
776 int     console_init_r(void);   /* After  relocation; uses the console stuff    */
777 int     console_assign(int file, const char *devname);  /* Assign the console   */
778 int     ctrlc (void);
779 int     had_ctrlc (void);       /* have we had a Control-C since last clear? */
780 void    clear_ctrlc (void);     /* clear the Control-C condition */
781 int     disable_ctrlc (int);    /* 1 to disable, 0 to enable Control-C detect */
782
783 /*
784  * STDIO based functions (can always be used)
785  */
786 /* serial stuff */
787 int     serial_printf (const char *fmt, ...)
788                 __attribute__ ((format (__printf__, 1, 2)));
789 /* stdin */
790 int     getc(void);
791 int     tstc(void);
792
793 /* stdout */
794 void    putc(const char c);
795 void    puts(const char *s);
796 int     printf(const char *fmt, ...)
797                 __attribute__ ((format (__printf__, 1, 2)));
798 int     vprintf(const char *fmt, va_list args);
799
800 /* stderr */
801 #define eputc(c)                fputc(stderr, c)
802 #define eputs(s)                fputs(stderr, s)
803 #define eprintf(fmt,args...)    fprintf(stderr,fmt ,##args)
804
805 /*
806  * FILE based functions (can only be used AFTER relocation!)
807  */
808 #define stdin           0
809 #define stdout          1
810 #define stderr          2
811 #define MAX_FILES       3
812
813 int     fprintf(int file, const char *fmt, ...)
814                 __attribute__ ((format (__printf__, 2, 3)));
815 void    fputs(int file, const char *s);
816 void    fputc(int file, const char c);
817 int     ftstc(int file);
818 int     fgetc(int file);
819
820 /* lib/net_utils.c */
821 #include <net.h>
822 static inline IPaddr_t getenv_IPaddr(char *var)
823 {
824         return string_to_ip(getenv(var));
825 }
826
827 /*
828  * CONSOLE multiplexing.
829  */
830 #ifdef CONFIG_CONSOLE_MUX
831 #include <iomux.h>
832 #endif
833
834 int     pcmcia_init (void);
835
836 #ifdef CONFIG_STATUS_LED
837 # include <status_led.h>
838 #endif
839
840 #include <bootstage.h>
841
842 #ifdef CONFIG_SHOW_ACTIVITY
843 void show_activity(int arg);
844 #endif
845
846 /* Multicore arch functions */
847 #ifdef CONFIG_MP
848 int cpu_status(int nr);
849 int cpu_reset(int nr);
850 int cpu_disable(int nr);
851 int cpu_release(int nr, int argc, char * const argv[]);
852 #endif
853
854 #endif /* __ASSEMBLY__ */
855
856 #ifdef CONFIG_PPC
857 /*
858  * Has to be included outside of the #ifndef __ASSEMBLY__ section.
859  * Otherwise might lead to compilation errors in assembler files.
860  */
861 #include <asm/cache.h>
862 #endif
863
864 /* Put only stuff here that the assembler can digest */
865
866 #ifdef CONFIG_POST
867 #define CONFIG_HAS_POST
868 #ifndef CONFIG_POST_ALT_LIST
869 #define CONFIG_POST_STD_LIST
870 #endif
871 #endif
872
873 #ifdef CONFIG_INIT_CRITICAL
874 #error CONFIG_INIT_CRITICAL is deprecated!
875 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
876 #endif
877
878 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
879
880 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
881 #define DIV_ROUND(n,d)          (((n) + ((d)/2)) / (d))
882 #define DIV_ROUND_UP(n,d)       (((n) + (d) - 1) / (d))
883 #define roundup(x, y)           ((((x) + ((y) - 1)) / (y)) * (y))
884
885 #define ALIGN(x,a)              __ALIGN_MASK((x),(typeof(x))(a)-1)
886 #define __ALIGN_MASK(x,mask)    (((x)+(mask))&~(mask))
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 ALLOC_ALIGN_BUFFER(type, name, size, align)                     \
949         char __##name[ROUND(size * sizeof(type), align) + (align - 1)]; \
950                                                                         \
951         type *name = (type *) ALIGN((uintptr_t)__##name, align)
952 #define ALLOC_CACHE_ALIGN_BUFFER(type, name, size)                      \
953         ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
954
955 /*
956  * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
957  * purpose is to allow allocating aligned buffers outside of function scope.
958  * Usage of this macro shall be avoided or used with extreme care!
959  */
960 #define DEFINE_ALIGN_BUFFER(type, name, size, align)                    \
961         static char __##name[roundup(size * sizeof(type), align)]       \
962                         __aligned(align);                               \
963                                                                         \
964         static type *name = (type *)__##name
965 #define DEFINE_CACHE_ALIGN_BUFFER(type, name, size)                     \
966         DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
967
968 /* Pull in stuff for the build system */
969 #ifdef DO_DEPS_ONLY
970 # include <environment.h>
971 #endif
972
973 #endif  /* __COMMON_H_ */