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