]>
Commit | Line | Data |
---|---|---|
e2211743 | 1 | /* |
3b74e7ec | 2 | * (C) Copyright 2000-2009 |
e2211743 WD |
3 | * Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
4 | * | |
3765b3e7 | 5 | * SPDX-License-Identifier: GPL-2.0+ |
e2211743 WD |
6 | */ |
7 | ||
8 | #ifndef __COMMON_H_ | |
d0b8feef | 9 | #define __COMMON_H_ 1 |
e2211743 | 10 | |
fcd3c87e WD |
11 | #ifndef __ASSEMBLY__ /* put C only stuff in this section */ |
12 | ||
e2211743 WD |
13 | typedef unsigned char uchar; |
14 | typedef volatile unsigned long vu_long; | |
180d3f74 | 15 | typedef volatile unsigned short vu_short; |
e2211743 WD |
16 | typedef volatile unsigned char vu_char; |
17 | ||
18 | #include <config.h> | |
25ddd1fb | 19 | #include <asm-offsets.h> |
e2211743 WD |
20 | #include <linux/bitops.h> |
21 | #include <linux/types.h> | |
22 | #include <linux/string.h> | |
9aed5080 | 23 | #include <linux/stringify.h> |
e2211743 WD |
24 | #include <asm/ptrace.h> |
25 | #include <stdarg.h> | |
cba1da49 | 26 | #include <linux/kernel.h> |
a821d08d | 27 | #if defined(CONFIG_PCI) && defined(CONFIG_4xx) |
e2211743 WD |
28 | #include <pci.h> |
29 | #endif | |
180d3f74 | 30 | #if defined(CONFIG_8xx) |
e2211743 | 31 | #include <asm/8xx_immap.h> |
03f9d7d1 MY |
32 | #if defined(CONFIG_MPC859) || defined(CONFIG_MPC859T) || \ |
33 | defined(CONFIG_MPC866) || \ | |
d4ca31c4 | 34 | defined(CONFIG_MPC866P) |
d0b8feef | 35 | # define CONFIG_MPC866_FAMILY 1 |
0ace4d9d | 36 | #elif defined(CONFIG_MPC885) |
d0b8feef | 37 | # define CONFIG_MPC885_FAMILY 1 |
180d3f74 WD |
38 | #endif |
39 | #if defined(CONFIG_MPC860) \ | |
40 | || defined(CONFIG_MPC860T) \ | |
1114257c WD |
41 | || defined(CONFIG_MPC866_FAMILY) \ |
42 | || defined(CONFIG_MPC885_FAMILY) | |
d0b8feef | 43 | # define CONFIG_MPC86x 1 |
2535d602 | 44 | #endif |
0db5bca8 WD |
45 | #elif defined(CONFIG_5xx) |
46 | #include <asm/5xx_immap.h> | |
7e6bf358 WD |
47 | #elif defined(CONFIG_MPC5xxx) |
48 | #include <mpc5xxx.h> | |
8993e54b | 49 | #elif defined(CONFIG_MPC512X) |
8993e54b | 50 | #include <asm/immap_512x.h> |
58dac327 | 51 | #elif defined(CONFIG_MPC8260) |
04a85b3b | 52 | #if defined(CONFIG_MPC8247) \ |
04a85b3b | 53 | || defined(CONFIG_MPC8272) |
d0b8feef | 54 | #define CONFIG_MPC8272_FAMILY 1 |
04a85b3b | 55 | #endif |
e2211743 WD |
56 | #include <asm/immap_8260.h> |
57 | #endif | |
debb7354 JL |
58 | #ifdef CONFIG_MPC86xx |
59 | #include <mpc86xx.h> | |
60 | #include <asm/immap_86xx.h> | |
61 | #endif | |
42d1f039 WD |
62 | #ifdef CONFIG_MPC85xx |
63 | #include <mpc85xx.h> | |
64 | #include <asm/immap_85xx.h> | |
65 | #endif | |
0f898604 | 66 | #ifdef CONFIG_MPC83xx |
f046ccd1 EL |
67 | #include <mpc83xx.h> |
68 | #include <asm/immap_83xx.h> | |
69 | #endif | |
e2211743 | 70 | #ifdef CONFIG_4xx |
b36df561 | 71 | #include <asm/ppc4xx.h> |
e2211743 | 72 | #endif |
6cfcce67 MF |
73 | #ifdef CONFIG_BLACKFIN |
74 | #include <asm/blackfin.h> | |
75 | #endif | |
2819e136 SN |
76 | #ifdef CONFIG_SOC_DA8XX |
77 | #include <asm/arch/hardware.h> | |
78 | #endif | |
e2211743 WD |
79 | |
80 | #include <part.h> | |
81 | #include <flash.h> | |
82 | #include <image.h> | |
83 | ||
4166ecb2 GB |
84 | /* Bring in printf format macros if inttypes.h is included */ |
85 | #define __STDC_FORMAT_MACROS | |
86 | ||
4d1fd7f1 YS |
87 | #ifdef __LP64__ |
88 | #define CONFIG_SYS_SUPPORT_64BIT_DATA | |
89 | #endif | |
90 | ||
21726a7a | 91 | #ifdef DEBUG |
88a85fb9 | 92 | #define _DEBUG 1 |
21726a7a | 93 | #else |
88a85fb9 | 94 | #define _DEBUG 0 |
21726a7a SG |
95 | #endif |
96 | ||
be25d875 TR |
97 | #ifndef pr_fmt |
98 | #define pr_fmt(fmt) fmt | |
99 | #endif | |
100 | ||
88a85fb9 MV |
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 | */ | |
be25d875 TR |
106 | #define debug_cond(cond, fmt, args...) \ |
107 | do { \ | |
108 | if (cond) \ | |
109 | printf(pr_fmt(fmt), ##args); \ | |
88a85fb9 MV |
110 | } while (0) |
111 | ||
112 | #define debug(fmt, args...) \ | |
113 | debug_cond(_DEBUG, fmt, ##args) | |
114 | ||
21726a7a SG |
115 | /* |
116 | * An assertion is run-time check done in debug mode only. If DEBUG is not | |
117 | * defined then it is skipped. If DEBUG is defined and the assertion fails, | |
118 | * then it calls panic*( which may or may not reset/halt U-Boot (see | |
119 | * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found | |
120 | * before release, and after release it is hoped that they don't matter. But | |
121 | * in any case these failing assertions cannot be fixed with a reset (which | |
122 | * may just do the same assertion again). | |
123 | */ | |
124 | void __assert_fail(const char *assertion, const char *file, unsigned line, | |
125 | const char *function); | |
126 | #define assert(x) \ | |
127 | ({ if (!(x) && _DEBUG) \ | |
128 | __assert_fail(#x, __FILE__, __LINE__, __func__); }) | |
129 | ||
594d57d0 | 130 | #define error(fmt, args...) do { \ |
be25d875 | 131 | printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \ |
594d57d0 MK |
132 | ##args, __FILE__, __LINE__, __func__); \ |
133 | } while (0) | |
134 | ||
cfa460ad | 135 | #ifndef BUG |
43835aac | 136 | #define BUG() do { \ |
511d0c72 | 137 | printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \ |
43835aac DZ |
138 | panic("BUG!"); \ |
139 | } while (0) | |
140 | #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0) | |
cfa460ad | 141 | #endif /* BUG */ |
43835aac | 142 | |
c00e17c7 HS |
143 | /* Force a compilation error if condition is true */ |
144 | #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)])) | |
145 | ||
c83bf6a2 | 146 | typedef void (interrupt_handler_t)(void *); |
e2211743 | 147 | |
c83bf6a2 | 148 | #include <asm/u-boot.h> /* boot information for Linux kernel */ |
e2211743 WD |
149 | #include <asm/global_data.h> /* global data used for startup functions */ |
150 | ||
71f95118 WD |
151 | /* |
152 | * enable common handling for all TQM8xxL/M boards: | |
11d9eec4 | 153 | * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards |
71f95118 | 154 | * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards |
11d9eec4 | 155 | * and for the TQM885D board |
71f95118 WD |
156 | */ |
157 | #if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \ | |
158 | defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \ | |
11d9eec4 | 159 | defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M) |
71f95118 WD |
160 | # ifndef CONFIG_TQM8xxM |
161 | # define CONFIG_TQM8xxM | |
162 | # endif | |
163 | #endif | |
e2211743 | 164 | #if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \ |
d126bfbd | 165 | defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \ |
11d9eec4 MK |
166 | defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \ |
167 | defined(CONFIG_TQM885D) | |
e2211743 WD |
168 | # ifndef CONFIG_TQM8xxL |
169 | # define CONFIG_TQM8xxL | |
170 | # endif | |
171 | #endif | |
172 | ||
3fbeeea6 HS |
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 | |
c7de829c | 182 | |
e2211743 WD |
183 | /* |
184 | * Function Prototypes | |
185 | */ | |
0267ba5d | 186 | int dram_init(void); |
e2211743 | 187 | |
c83bf6a2 | 188 | void hang (void) __attribute__ ((noreturn)); |
e2211743 | 189 | |
f6c019c4 WD |
190 | int timer_init(void); |
191 | int cpu_init(void); | |
192 | ||
e2211743 | 193 | /* */ |
9973e3c6 | 194 | phys_size_t initdram (int); |
c6da9ae8 | 195 | |
2ea09c83 | 196 | #include <display_options.h> |
e2211743 WD |
197 | |
198 | /* common/main.c */ | |
199 | void main_loop (void); | |
009dde19 | 200 | int run_command(const char *cmd, int flag); |
1d43bfd2 | 201 | int run_command_repeatable(const char *cmd, int flag); |
d51004a8 SG |
202 | |
203 | /** | |
204 | * Run a list of commands separated by ; or even \0 | |
205 | * | |
206 | * Note that if 'len' is not -1, then the command does not need to be nul | |
207 | * terminated, Memory will be allocated for the command in that case. | |
208 | * | |
209 | * @param cmd List of commands to run, each separated bu semicolon | |
210 | * @param len Length of commands excluding terminator if known (-1 if not) | |
211 | * @param flag Execution flags (CMD_FLAG_...) | |
212 | * @return 0 on success, or != 0 on error. | |
213 | */ | |
214 | int run_command_list(const char *cmd, int len, int flag); | |
e3150460 | 215 | extern char console_buffer[]; |
e2211743 | 216 | |
ea0364f1 | 217 | /* arch/$(ARCH)/lib/board.c */ |
0365ffcc MY |
218 | void board_init_f(ulong); |
219 | void board_init_r(gd_t *, ulong) __attribute__ ((noreturn)); | |
220 | int checkboard(void); | |
221 | int show_board_info(void); | |
222 | int checkflash(void); | |
223 | int checkdram(void); | |
224 | int last_stage_init(void); | |
3b57fe0a | 225 | extern ulong monitor_flash_len; |
bea3f28d | 226 | int mac_read_from_eeprom(void); |
6ab6b2af | 227 | extern u8 __dtb_dt_begin[]; /* embedded device tree blob */ |
8f5d4687 | 228 | int set_cpu_clk_info(void); |
9272a9b4 | 229 | int mdm_init(void); |
365475e6 | 230 | #if defined(CONFIG_DISPLAY_CPUINFO) |
1938f4a5 | 231 | int print_cpuinfo(void); |
365475e6 MY |
232 | #else |
233 | static inline int print_cpuinfo(void) | |
234 | { | |
235 | return 0; | |
236 | } | |
237 | #endif | |
c2240d4d | 238 | int update_flash_size(int flash_size); |
2c072c95 | 239 | int arch_early_init_r(void); |
e2211743 | 240 | |
d4c671cc SG |
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 | */ | |
250 | int arch_cpu_init_dm(void); | |
251 | ||
68145d4c AB |
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 | ||
15a33e49 SG |
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 | */ | |
ea11b401 | 277 | void board_show_dram(phys_size_t size); |
15a33e49 | 278 | |
13d06981 | 279 | /** |
e29607ed | 280 | * arch_fixup_fdt() - Write arch-specific information to fdt |
13d06981 | 281 | * |
e29607ed | 282 | * Defined in arch/$(ARCH)/lib/bootm-fdt.c |
13d06981 SG |
283 | * |
284 | * @blob: FDT blob to write to | |
285 | * @return 0 if ok, or -ve FDT_ERR_... on failure | |
286 | */ | |
e29607ed | 287 | int arch_fixup_fdt(void *blob); |
13d06981 | 288 | |
e2211743 WD |
289 | /* common/flash.c */ |
290 | void flash_perror (int); | |
291 | ||
74de7aef WD |
292 | /* common/cmd_source.c */ |
293 | int source (ulong addr, const char *fit_uname); | |
e2211743 | 294 | |
c83bf6a2 | 295 | extern ulong load_addr; /* Default Load Address */ |
1aec244a SG |
296 | extern ulong save_addr; /* Default Save Address */ |
297 | extern ulong save_size; /* Default Save Size */ | |
e2211743 | 298 | |
4394f9a8 WD |
299 | /* common/cmd_doc.c */ |
300 | void doc_probe(unsigned long physadr); | |
301 | ||
06283a64 JH |
302 | /* common/cmd_net.c */ |
303 | int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); | |
304 | ||
669df7e4 RH |
305 | /* common/cmd_fat.c */ |
306 | int do_fat_fsload(cmd_tbl_t *, int, int, char * const []); | |
307 | ||
308 | /* common/cmd_ext2.c */ | |
309 | int do_ext2load(cmd_tbl_t *, int, int, char * const []); | |
310 | ||
e2211743 WD |
311 | /* common/cmd_nvedit.c */ |
312 | int env_init (void); | |
313 | void env_relocate (void); | |
26a41790 | 314 | int envmatch (uchar *, int); |
20f86a0a SG |
315 | |
316 | /* Avoid unfortunate conflict with libc's getenv() */ | |
317 | #ifdef CONFIG_SANDBOX | |
318 | #define getenv uboot_getenv | |
319 | #endif | |
84b5e802 WD |
320 | char *getenv (const char *); |
321 | int getenv_f (const char *name, char *buf, unsigned len); | |
4a9b4131 | 322 | ulong getenv_ulong(const char *name, int base, ulong default_val); |
76b8f79c SG |
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 | */ | |
334 | ulong getenv_hex(const char *varname, ulong default_val); | |
335 | ||
ec8a252c JH |
336 | /* |
337 | * Read an environment variable as a boolean | |
338 | * Return -1 if variable does not exist (default to true) | |
339 | */ | |
340 | int getenv_yesno(const char *var); | |
c83bf6a2 | 341 | int saveenv (void); |
84b5e802 | 342 | int setenv (const char *, const char *); |
d67f10ce | 343 | int setenv_ulong(const char *varname, ulong value); |
bfc59966 SG |
344 | int setenv_hex(const char *varname, ulong value); |
345 | /** | |
346 | * setenv_addr - Set an environment variable to an address in hex | |
347 | * | |
1bce2aeb | 348 | * @varname: Environment variable to set |
bfc59966 SG |
349 | * @addr: Value to set it to |
350 | * @return 0 if ok, 1 on error | |
351 | */ | |
352 | static inline int setenv_addr(const char *varname, const void *addr) | |
353 | { | |
354 | return setenv_hex(varname, (ulong)addr); | |
355 | } | |
356 | ||
e2211743 | 357 | #ifdef CONFIG_ARM |
96085e34 | 358 | # include <asm/mach-types.h> |
b6e4c403 | 359 | # include <asm/setup.h> |
e2211743 WD |
360 | # include <asm/u-boot-arm.h> /* ARM version to be fixed! */ |
361 | #endif /* CONFIG_ARM */ | |
fea25720 GR |
362 | #ifdef CONFIG_X86 /* x86 version to be fixed! */ |
363 | # include <asm/u-boot-x86.h> | |
364 | #endif /* CONFIG_X86 */ | |
744d9859 SG |
365 | #ifdef CONFIG_SANDBOX |
366 | # include <asm/u-boot-sandbox.h> /* TODO(sjg) what needs to be fixed? */ | |
367 | #endif | |
e7083844 ML |
368 | #ifdef CONFIG_NDS32 |
369 | # include <asm/mach-types.h> | |
e3c58b02 | 370 | # include <asm/setup.h> |
e7083844 ML |
371 | # include <asm/u-boot-nds32.h> |
372 | #endif /* CONFIG_NDS32 */ | |
e034ea3b DS |
373 | #ifdef CONFIG_MIPS |
374 | # include <asm/u-boot-mips.h> | |
375 | #endif /* CONFIG_MIPS */ | |
bc5d5428 AB |
376 | #ifdef CONFIG_ARC |
377 | # include <asm/u-boot-arc.h> | |
378 | #endif /* CONFIG_ARC */ | |
e2211743 | 379 | |
04a85b3b WD |
380 | #ifdef CONFIG_AUTO_COMPLETE |
381 | int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf); | |
382 | #endif | |
2f70c49e | 383 | int get_env_id (void); |
04a85b3b | 384 | |
c83bf6a2 WD |
385 | void pci_init (void); |
386 | void pci_init_board(void); | |
387 | void pciinfo (int, int); | |
e2211743 | 388 | |
a821d08d | 389 | #if defined(CONFIG_PCI) && defined(CONFIG_4xx) |
c71103f9 MF |
390 | int pci_pre_init (struct pci_controller *); |
391 | int is_pci_host (struct pci_controller *); | |
466fff1a SR |
392 | #endif |
393 | ||
dbbd1257 | 394 | #if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX)) |
6d0f6bcf | 395 | # if defined(CONFIG_SYS_PCI_TARGET_INIT) |
c83bf6a2 | 396 | void pci_target_init (struct pci_controller *); |
e2211743 | 397 | # endif |
6d0f6bcf | 398 | # if defined(CONFIG_SYS_PCI_MASTER_INIT) |
c83bf6a2 | 399 | void pci_master_init (struct pci_controller *); |
e2211743 | 400 | # endif |
6f2eb3f3 SR |
401 | #if defined(CONFIG_440SPE) || \ |
402 | defined(CONFIG_460EX) || defined(CONFIG_460GT) || \ | |
403 | defined(CONFIG_405EX) | |
7f191393 | 404 | void pcie_setup_hoses(int busno); |
692519b1 | 405 | #endif |
e2211743 WD |
406 | #endif |
407 | ||
408 | int misc_init_f (void); | |
409 | int misc_init_r (void); | |
410 | ||
27b207fd WD |
411 | /* common/exports.c */ |
412 | void jumptable_init(void); | |
413 | ||
ecb1dc89 MF |
414 | /* common/kallsysm.c */ |
415 | const char *symbol_lookup(unsigned long addr, unsigned long *caddr); | |
416 | ||
500856eb RJ |
417 | /* api/api.c */ |
418 | void api_init (void); | |
419 | ||
c83bf6a2 | 420 | /* common/memsize.c */ |
a55d23cc | 421 | long get_ram_size (long *, long); |
e3866163 | 422 | phys_size_t get_effective_memsize(void); |
c83bf6a2 | 423 | |
e2211743 WD |
424 | /* $(BOARD)/$(BOARD).c */ |
425 | void reset_phy (void); | |
c83bf6a2 | 426 | void fdc_hw_init (void); |
e2211743 WD |
427 | |
428 | /* $(BOARD)/eeprom.c */ | |
429 | void eeprom_init (void); | |
6dd652fa WD |
430 | #ifndef CONFIG_SPI |
431 | int eeprom_probe (unsigned dev_addr, unsigned offset); | |
432 | #endif | |
e2211743 WD |
433 | int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt); |
434 | int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt); | |
e2211743 WD |
435 | |
436 | /* | |
437 | * Set this up regardless of board | |
438 | * type, to prevent errors. | |
439 | */ | |
6d0f6bcf JCPV |
440 | #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) |
441 | # define CONFIG_SYS_DEF_EEPROM_ADDR 0 | |
e2211743 | 442 | #else |
548738b4 | 443 | #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) |
6d0f6bcf | 444 | # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR |
548738b4 | 445 | #endif |
6d0f6bcf | 446 | #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */ |
e2211743 | 447 | |
bdccc4fe | 448 | #if defined(CONFIG_SPI) |
e2211743 WD |
449 | extern void spi_init_f (void); |
450 | extern void spi_init_r (void); | |
c83bf6a2 | 451 | extern ssize_t spi_read (uchar *, int, uchar *, int); |
e2211743 WD |
452 | extern ssize_t spi_write (uchar *, int, uchar *, int); |
453 | #endif | |
454 | ||
e2211743 | 455 | /* $(BOARD)/$(BOARD).c */ |
c837dcb1 WD |
456 | int board_early_init_f (void); |
457 | int board_late_init (void); | |
e2211743 | 458 | int board_postclk_init (void); /* after clocks/timebase, before env/serial */ |
c837dcb1 | 459 | int board_early_init_r (void); |
e2211743 WD |
460 | void board_poweroff (void); |
461 | ||
6d0f6bcf | 462 | #if defined(CONFIG_SYS_DRAM_TEST) |
e2211743 | 463 | int testdram(void); |
6d0f6bcf | 464 | #endif /* CONFIG_SYS_DRAM_TEST */ |
e2211743 WD |
465 | |
466 | /* $(CPU)/start.S */ | |
c83bf6a2 | 467 | #if defined(CONFIG_5xx) || \ |
0db5bca8 | 468 | defined(CONFIG_8xx) |
e2211743 WD |
469 | uint get_immr (uint); |
470 | #endif | |
36c72877 WD |
471 | #if defined(CONFIG_MPC5xxx) |
472 | uint get_svr (void); | |
473 | #endif | |
e2211743 | 474 | uint get_pvr (void); |
547b4cb2 | 475 | uint get_svr (void); |
e2211743 WD |
476 | uint rd_ic_cst (void); |
477 | void wr_ic_cst (uint); | |
478 | void wr_ic_adr (uint); | |
479 | uint rd_dc_cst (void); | |
480 | void wr_dc_cst (uint); | |
481 | void wr_dc_adr (uint); | |
482 | int icache_status (void); | |
483 | void icache_enable (void); | |
484 | void icache_disable(void); | |
485 | int dcache_status (void); | |
486 | void dcache_enable (void); | |
487 | void dcache_disable(void); | |
2c451f78 | 488 | void mmu_disable(void); |
5c6db120 BT |
489 | #if defined(CONFIG_ARM) |
490 | void relocate_code(ulong); | |
491 | #else | |
492 | void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn)); | |
959eaa74 | 493 | #endif |
e2211743 WD |
494 | ulong get_endaddr (void); |
495 | void trap_init (ulong); | |
496 | #if defined (CONFIG_4xx) || \ | |
eeb1b77b | 497 | defined (CONFIG_MPC5xxx) || \ |
cd94ba39 | 498 | defined (CONFIG_MPC85xx) || \ |
debb7354 | 499 | defined (CONFIG_MPC86xx) || \ |
0f898604 | 500 | defined (CONFIG_MPC83xx) |
c83bf6a2 WD |
501 | unsigned char in8(unsigned int); |
502 | void out8(unsigned int, unsigned char); | |
503 | unsigned short in16(unsigned int); | |
504 | unsigned short in16r(unsigned int); | |
505 | void out16(unsigned int, unsigned short value); | |
506 | void out16r(unsigned int, unsigned short value); | |
507 | unsigned long in32(unsigned int); | |
508 | unsigned long in32r(unsigned int); | |
509 | void out32(unsigned int, unsigned long value); | |
510 | void out32r(unsigned int, unsigned long value); | |
511 | void ppcDcbf(unsigned long value); | |
512 | void ppcDcbi(unsigned long value); | |
513 | void ppcSync(void); | |
0ac6f8b7 | 514 | void ppcDcbz(unsigned long value); |
e2211743 | 515 | #endif |
0643631a MS |
516 | #if defined (CONFIG_MICROBLAZE) |
517 | unsigned short in16(unsigned int); | |
518 | void out16(unsigned int, unsigned short value); | |
519 | #endif | |
e2211743 | 520 | |
0f898604 | 521 | #if defined (CONFIG_MPC83xx) |
90f30a71 DL |
522 | void ppcDWload(unsigned int *addr, unsigned int *ret); |
523 | void ppcDWstore(unsigned int *addr, unsigned int *value); | |
7c6db910 HS |
524 | void disable_addr_trans(void); |
525 | void enable_addr_trans(void); | |
526 | #if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER) | |
527 | void ddr_enable_ecc(unsigned int dram_size); | |
528 | #endif | |
90f30a71 DL |
529 | #endif |
530 | ||
fc9ae1ba RS |
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 | */ | |
535 | ulong timer_get_us(void); | |
536 | ||
e2211743 | 537 | /* $(CPU)/cpu.c */ |
fbb9ecf7 TT |
538 | static 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 | ||
0e870980 | 551 | int cpu_numcores (void); |
b8bf0adc | 552 | int cpu_num_dspcores(void); |
fbb9ecf7 | 553 | u32 cpu_mask (void); |
b8bf0adc | 554 | u32 cpu_dsp_mask(void); |
fbb9ecf7 | 555 | int is_core_valid (unsigned int); |
0e870980 | 556 | int probecpu (void); |
e2211743 WD |
557 | int checkcpu (void); |
558 | int checkicache (void); | |
559 | int checkdcache (void); | |
560 | void upmconfig (unsigned int, unsigned int *, unsigned int); | |
561 | ulong get_tbclk (void); | |
1fb4dab2 | 562 | void reset_misc (void); |
3ec924a3 | 563 | void reset_cpu (ulong addr); |
6a16e0df KP |
564 | #if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP) |
565 | void ft_cpu_setup(void *blob, bd_t *bd); | |
566 | #ifdef CONFIG_PCI | |
567 | void ft_pci_setup(void *blob, bd_t *bd); | |
568 | #endif | |
569 | #endif | |
570 | ||
ba6a1698 AP |
571 | void smp_set_core_boot_addr(unsigned long addr, int corenr); |
572 | void smp_kick_all_cpus(void); | |
e2211743 WD |
573 | |
574 | /* $(CPU)/serial.c */ | |
575 | int serial_init (void); | |
576 | void serial_setbrg (void); | |
577 | void serial_putc (const char); | |
756f586a | 578 | void serial_putc_raw(const char); |
e2211743 | 579 | void serial_puts (const char *); |
e2211743 WD |
580 | int serial_getc (void); |
581 | int serial_tstc (void); | |
582 | ||
709ea543 SG |
583 | /* These versions take a stdio_dev pointer */ |
584 | struct stdio_dev; | |
585 | int serial_stub_getc(struct stdio_dev *sdev); | |
586 | int serial_stub_tstc(struct stdio_dev *sdev); | |
587 | ||
e2211743 WD |
588 | /* $(CPU)/speed.c */ |
589 | int get_clocks (void); | |
c178d3da WD |
590 | int get_clocks_866 (void); |
591 | int sdram_adjust_866 (void); | |
e9132ea9 | 592 | int adjust_sdram_tbs_8xx (void); |
58dac327 | 593 | #if defined(CONFIG_MPC8260) |
e2211743 | 594 | int prt_8260_clks (void); |
f046ccd1 | 595 | #elif defined(CONFIG_MPC5xxx) |
945af8d7 WD |
596 | int prt_mpc5xxx_clks (void); |
597 | #endif | |
e2211743 WD |
598 | #ifdef CONFIG_4xx |
599 | ulong get_OPB_freq (void); | |
600 | ulong get_PCI_freq (void); | |
601 | #endif | |
ac67804f | 602 | #if defined(CONFIG_S3C24X0) || \ |
603 | defined(CONFIG_LH7A40X) || \ | |
fcfb632b | 604 | defined(CONFIG_EP93XX) |
e2211743 WD |
605 | ulong get_FCLK (void); |
606 | ulong get_HCLK (void); | |
607 | ulong get_PCLK (void); | |
608 | ulong get_UCLK (void); | |
609 | #endif | |
f39748ae WD |
610 | #if defined(CONFIG_LH7A40X) |
611 | ulong get_PLLCLK (void); | |
612 | #endif | |
281e00a3 WD |
613 | #if defined(CONFIG_IMX) |
614 | ulong get_systemPLLCLK(void); | |
615 | ulong get_FCLK(void); | |
616 | ulong get_HCLK(void); | |
617 | ulong get_BCLK(void); | |
618 | ulong get_PERCLK1(void); | |
619 | ulong get_PERCLK2(void); | |
620 | ulong get_PERCLK3(void); | |
621 | #endif | |
e2211743 | 622 | ulong get_bus_freq (ulong); |
550650dd | 623 | int get_serial_clock(void); |
e2211743 | 624 | |
42d1f039 WD |
625 | #if defined(CONFIG_MPC85xx) |
626 | typedef MPC85xx_SYS_INFO sys_info_t; | |
c83bf6a2 | 627 | void get_sys_info ( sys_info_t * ); |
871a57bb MY |
628 | # if defined(CONFIG_OF_LIBFDT) |
629 | void ft_fixup_cpu(void *, u64); | |
630 | void ft_fixup_num_cores(void *); | |
631 | # endif | |
42d1f039 | 632 | #endif |
debb7354 JL |
633 | #if defined(CONFIG_MPC86xx) |
634 | typedef MPC86xx_SYS_INFO sys_info_t; | |
635 | void get_sys_info ( sys_info_t * ); | |
5df4b0ad KG |
636 | static inline ulong get_ddr_freq(ulong dummy) |
637 | { | |
638 | return get_bus_freq(dummy); | |
639 | } | |
2f78eae5 YS |
640 | #else |
641 | ulong get_ddr_freq(ulong); | |
debb7354 | 642 | #endif |
42d1f039 | 643 | |
99bcad18 | 644 | #if defined(CONFIG_4xx) |
e2211743 | 645 | # if defined(CONFIG_440) |
6c5879f3 MB |
646 | # if defined(CONFIG_440SPE) |
647 | unsigned long determine_sysper(void); | |
648 | unsigned long determine_pci_clock_per(void); | |
649 | # endif | |
e2211743 | 650 | # endif |
087dfdb7 | 651 | typedef PPC4xx_SYS_INFO sys_info_t; |
f31d38b9 | 652 | int ppc440spe_revB(void); |
c83bf6a2 | 653 | void get_sys_info ( sys_info_t * ); |
e2211743 WD |
654 | #endif |
655 | ||
656 | /* $(CPU)/cpu_init.c */ | |
58dac327 | 657 | #if defined(CONFIG_8xx) || defined(CONFIG_MPC8260) |
e2211743 WD |
658 | void cpu_init_f (volatile immap_t *immr); |
659 | #endif | |
701e6401 | 660 | #if defined(CONFIG_4xx) || defined(CONFIG_MCF52x2) || defined(CONFIG_MPC86xx) |
e2211743 WD |
661 | void cpu_init_f (void); |
662 | #endif | |
701e6401 YS |
663 | #ifdef CONFIG_MPC85xx |
664 | ulong cpu_init_f(void); | |
665 | #endif | |
bf9e3b38 | 666 | |
e2211743 | 667 | int cpu_init_r (void); |
58dac327 | 668 | #if defined(CONFIG_MPC8260) |
e2211743 | 669 | int prt_8260_rsr (void); |
0f898604 | 670 | #elif defined(CONFIG_MPC83xx) |
9be39a67 | 671 | int prt_83xx_rsr (void); |
e2211743 WD |
672 | #endif |
673 | ||
674 | /* $(CPU)/interrupts.c */ | |
c83bf6a2 WD |
675 | int interrupt_init (void); |
676 | void timer_interrupt (struct pt_regs *); | |
e2211743 WD |
677 | void external_interrupt (struct pt_regs *); |
678 | void irq_install_handler(int, interrupt_handler_t *, void *); | |
679 | void irq_free_handler (int); | |
680 | void reset_timer (void); | |
681 | ulong get_timer (ulong base); | |
b2e16a85 SG |
682 | |
683 | /* Return value of monotonic microsecond timer */ | |
684 | unsigned long timer_get_us(void); | |
685 | ||
e2211743 WD |
686 | void enable_interrupts (void); |
687 | int disable_interrupts (void); | |
688 | ||
689 | /* $(CPU)/.../commproc.c */ | |
690 | int dpram_init (void); | |
691 | uint dpram_base(void); | |
692 | uint dpram_base_align(uint align); | |
693 | uint dpram_alloc(uint size); | |
694 | uint dpram_alloc_align(uint size,uint align); | |
bdccc4fe WD |
695 | void bootcount_store (ulong); |
696 | ulong bootcount_load (void); | |
697 | #define BOOTCOUNT_MAGIC 0xB001C041 | |
e2211743 WD |
698 | |
699 | /* $(CPU)/.../<eth> */ | |
c5bded3c | 700 | void mii_init (void); |
e2211743 WD |
701 | |
702 | /* $(CPU)/.../lcd.c */ | |
703 | ulong lcd_setmem (ulong); | |
704 | ||
e2211743 WD |
705 | /* $(CPU)/.../video.c */ |
706 | ulong video_setmem (ulong); | |
707 | ||
ea0364f1 | 708 | /* arch/$(ARCH)/lib/cache.c */ |
cba4b180 | 709 | void enable_caches(void); |
e2211743 | 710 | void flush_cache (unsigned long, unsigned long); |
2c451f78 | 711 | void flush_dcache_all(void); |
03d3bfb0 SR |
712 | void flush_dcache_range(unsigned long start, unsigned long stop); |
713 | void invalidate_dcache_range(unsigned long start, unsigned long stop); | |
2c451f78 A |
714 | void invalidate_dcache_all(void); |
715 | void invalidate_icache_all(void); | |
0db5bca8 | 716 | |
4d24a11e SG |
717 | enum { |
718 | /* Disable caches (else flush caches but leave them active) */ | |
719 | CBL_DISABLE_CACHES = 1 << 0, | |
720 | CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1, | |
721 | ||
722 | CBL_ALL = 3, | |
723 | }; | |
724 | ||
725 | /** | |
726 | * Clean up ready for linux | |
727 | * | |
728 | * @param flags Flags to control what is done | |
729 | */ | |
730 | int cleanup_before_linux_select(int flags); | |
731 | ||
ea0364f1 | 732 | /* arch/$(ARCH)/lib/ticks.S */ |
19ea4678 | 733 | uint64_t get_ticks(void); |
e2211743 WD |
734 | void wait_ticks (unsigned long); |
735 | ||
ea0364f1 | 736 | /* arch/$(ARCH)/lib/time.c */ |
3eb90bad | 737 | void __udelay (unsigned long); |
e2211743 WD |
738 | ulong usec2ticks (unsigned long usec); |
739 | ulong ticks2usec (unsigned long ticks); | |
740 | int init_timebase (void); | |
741 | ||
78acc472 | 742 | /* lib/gunzip.c */ |
87d93a1b WW |
743 | int gunzip(void *, int, unsigned char *, unsigned long *); |
744 | int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp, | |
745 | int stoponerr, int offset); | |
746 | ||
918e9ebb EN |
747 | /** |
748 | * gzwrite progress indicators: defined weak to allow board-specific | |
749 | * overrides: | |
750 | * | |
751 | * gzwrite_progress_init called on startup | |
752 | * gzwrite_progress called during decompress/write loop | |
753 | * gzwrite_progress_finish called at end of loop to | |
754 | * indicate success (retcode=0) or failure | |
755 | */ | |
756 | void gzwrite_progress_init(u64 expected_size); | |
757 | ||
758 | void gzwrite_progress(int iteration, | |
759 | u64 bytes_written, | |
760 | u64 total_bytes); | |
761 | ||
762 | void gzwrite_progress_finish(int retcode, | |
763 | u64 totalwritten, | |
764 | u64 totalsize, | |
765 | u32 expected_crc, | |
766 | u32 calculated_crc); | |
767 | ||
768 | /** | |
769 | * decompress and write gzipped image from memory to block device | |
770 | * | |
771 | * @param src compressed image address | |
772 | * @param len compressed image length in bytes | |
773 | * @param dev block device descriptor | |
774 | * @param szwritebuf bytes per write (pad to erase size) | |
775 | * @param startoffs offset in bytes of first write | |
776 | * @param szexpected expected uncompressed length | |
777 | * may be zero to use gzip trailer | |
778 | * for files under 4GiB | |
779 | */ | |
780 | int gzwrite(unsigned char *src, int len, | |
781 | struct block_dev_desc *dev, | |
782 | unsigned long szwritebuf, | |
783 | u64 startoffs, | |
784 | u64 szexpected); | |
785 | ||
54c6977e WD |
786 | /* lib/qsort.c */ |
787 | void qsort(void *base, size_t nmemb, size_t size, | |
788 | int(*compar)(const void *, const void *)); | |
560d424b | 789 | int strcmp_compar(const void *, const void *); |
54c6977e | 790 | |
78acc472 | 791 | /* lib/time.c */ |
3eb90bad | 792 | void udelay (unsigned long); |
c4c9fbeb | 793 | void mdelay(unsigned long); |
3eb90bad | 794 | |
e11938ea | 795 | /* lib/uuid.c */ |
d718ded0 | 796 | #include <uuid.h> |
e11938ea | 797 | |
78acc472 | 798 | /* lib/vsprintf.c */ |
9785c905 | 799 | #include <vsprintf.h> |
e2211743 | 800 | |
78acc472 | 801 | /* lib/strmhz.c */ |
55f7934d | 802 | char * strmhz(char *buf, unsigned long hz); |
0768b7a8 | 803 | |
78acc472 | 804 | /* lib/crc32.c */ |
449609f5 | 805 | #include <u-boot/crc.h> |
e2211743 | 806 | |
9acf1ca5 | 807 | /* lib/rand.c */ |
9acf1ca5 MW |
808 | #define RAND_MAX -1U |
809 | void srand(unsigned int seed); | |
810 | unsigned int rand(void); | |
811 | unsigned int rand_r(unsigned int *seedp); | |
9acf1ca5 | 812 | |
e2211743 | 813 | /* common/console.c */ |
e2211743 WD |
814 | int console_init_f(void); /* Before relocation; uses the serial stuff */ |
815 | int console_init_r(void); /* After relocation; uses the console stuff */ | |
d7be3056 | 816 | int console_assign(int file, const char *devname); /* Assign the console */ |
e2211743 WD |
817 | int ctrlc (void); |
818 | int had_ctrlc (void); /* have we had a Control-C since last clear? */ | |
819 | void clear_ctrlc (void); /* clear the Control-C condition */ | |
820 | int disable_ctrlc (int); /* 1 to disable, 0 to enable Control-C detect */ | |
a5dffa4b | 821 | int confirm_yesno(void); /* 1 if input is "y", "Y", "yes" or "YES" */ |
e2211743 WD |
822 | /* |
823 | * STDIO based functions (can always be used) | |
824 | */ | |
e2211743 | 825 | /* serial stuff */ |
d9c27253 | 826 | int serial_printf (const char *fmt, ...) |
dc4b0b38 | 827 | __attribute__ ((format (__printf__, 1, 2))); |
e2211743 WD |
828 | /* stdin */ |
829 | int getc(void); | |
830 | int tstc(void); | |
831 | ||
832 | /* stdout */ | |
833 | void putc(const char c); | |
834 | void puts(const char *s); | |
d9c27253 | 835 | int printf(const char *fmt, ...) |
dc4b0b38 | 836 | __attribute__ ((format (__printf__, 1, 2))); |
d9c27253 | 837 | int vprintf(const char *fmt, va_list args); |
e2211743 WD |
838 | |
839 | /* stderr */ | |
840 | #define eputc(c) fputc(stderr, c) | |
841 | #define eputs(s) fputs(stderr, s) | |
842 | #define eprintf(fmt,args...) fprintf(stderr,fmt ,##args) | |
843 | ||
844 | /* | |
845 | * FILE based functions (can only be used AFTER relocation!) | |
846 | */ | |
e2211743 WD |
847 | #define stdin 0 |
848 | #define stdout 1 | |
849 | #define stderr 2 | |
850 | #define MAX_FILES 3 | |
851 | ||
d9c27253 | 852 | int fprintf(int file, const char *fmt, ...) |
dc4b0b38 | 853 | __attribute__ ((format (__printf__, 2, 3))); |
e2211743 WD |
854 | void fputs(int file, const char *s); |
855 | void fputc(int file, const char c); | |
856 | int ftstc(int file); | |
857 | int fgetc(int file); | |
858 | ||
88d52c6a LW |
859 | /* lib/gzip.c */ |
860 | int gzip(void *dst, unsigned long *lenp, | |
861 | unsigned char *src, unsigned long srclen); | |
862 | int zzip(void *dst, unsigned long *lenp, unsigned char *src, | |
863 | unsigned long srclen, int stoponerr, | |
864 | int (*func)(unsigned long, unsigned long)); | |
865 | ||
4ef8d53c JH |
866 | /* lib/net_utils.c */ |
867 | #include <net.h> | |
049a95a7 | 868 | static inline struct in_addr getenv_ip(char *var) |
4ef8d53c JH |
869 | { |
870 | return string_to_ip(getenv(var)); | |
871 | } | |
872 | ||
16a28ef2 GJ |
873 | /* |
874 | * CONSOLE multiplexing. | |
875 | */ | |
876 | #ifdef CONFIG_CONSOLE_MUX | |
877 | #include <iomux.h> | |
878 | #endif | |
879 | ||
e2211743 WD |
880 | int pcmcia_init (void); |
881 | ||
fb364bec WD |
882 | #ifdef CONFIG_STATUS_LED |
883 | # include <status_led.h> | |
884 | #endif | |
097e1783 SG |
885 | |
886 | #include <bootstage.h> | |
e2211743 | 887 | |
48522bb5 JH |
888 | #ifdef CONFIG_SHOW_ACTIVITY |
889 | void show_activity(int arg); | |
890 | #endif | |
891 | ||
fcd3c87e WD |
892 | /* Multicore arch functions */ |
893 | #ifdef CONFIG_MP | |
894 | int cpu_status(int nr); | |
895 | int cpu_reset(int nr); | |
4194b366 | 896 | int cpu_disable(int nr); |
54841ab5 | 897 | int cpu_release(int nr, int argc, char * const argv[]); |
fcd3c87e WD |
898 | #endif |
899 | ||
900 | #endif /* __ASSEMBLY__ */ | |
901 | ||
13e95e42 SR |
902 | #ifdef CONFIG_PPC |
903 | /* | |
904 | * Has to be included outside of the #ifndef __ASSEMBLY__ section. | |
905 | * Otherwise might lead to compilation errors in assembler files. | |
906 | */ | |
907 | #include <asm/cache.h> | |
908 | #endif | |
909 | ||
fcd3c87e WD |
910 | /* Put only stuff here that the assembler can digest */ |
911 | ||
912 | #ifdef CONFIG_POST | |
913 | #define CONFIG_HAS_POST | |
800eb096 MZ |
914 | #ifndef CONFIG_POST_ALT_LIST |
915 | #define CONFIG_POST_STD_LIST | |
916 | #endif | |
fcd3c87e WD |
917 | #endif |
918 | ||
8aa1a2d1 | 919 | #ifdef CONFIG_INIT_CRITICAL |
2f6fa46d | 920 | #error CONFIG_INIT_CRITICAL is deprecated! |
8aa1a2d1 WD |
921 | #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README. |
922 | #endif | |
923 | ||
155cfb5e | 924 | #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1)) |
4b03ac8b | 925 | |
1e41f5ad AS |
926 | /* |
927 | * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture. It | |
928 | * is used to align DMA buffers. | |
929 | */ | |
930 | #ifndef __ASSEMBLY__ | |
931 | #include <asm/cache.h> | |
932 | #endif | |
933 | ||
46a6d51c A |
934 | /* |
935 | * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the | |
936 | * stack that meets the minimum architecture alignment requirements for DMA. | |
937 | * Such a buffer is useful for DMA operations where flushing and invalidating | |
938 | * the cache before and after a read and/or write operation is required for | |
939 | * correct operations. | |
940 | * | |
941 | * When called the macro creates an array on the stack that is sized such | |
942 | * that: | |
943 | * | |
944 | * 1) The beginning of the array can be advanced enough to be aligned. | |
945 | * | |
946 | * 2) The size of the aligned portion of the array is a multiple of the minimum | |
947 | * architecture alignment required for DMA. | |
948 | * | |
949 | * 3) The aligned portion contains enough space for the original number of | |
950 | * elements requested. | |
951 | * | |
952 | * The macro then creates a pointer to the aligned portion of this array and | |
953 | * assigns to the pointer the address of the first element in the aligned | |
954 | * portion of the array. | |
955 | * | |
956 | * Calling the macro as: | |
957 | * | |
958 | * ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024); | |
959 | * | |
960 | * Will result in something similar to saying: | |
961 | * | |
962 | * uint32_t buffer[1024]; | |
963 | * | |
964 | * The following differences exist: | |
965 | * | |
966 | * 1) The resulting buffer is guaranteed to be aligned to the value of | |
967 | * ARCH_DMA_MINALIGN. | |
968 | * | |
969 | * 2) The buffer variable created by the macro is a pointer to the specified | |
970 | * type, and NOT an array of the specified type. This can be very important | |
971 | * if you want the address of the buffer, which you probably do, to pass it | |
972 | * to the DMA hardware. The value of &buffer is different in the two cases. | |
973 | * In the macro case it will be the address of the pointer, not the address | |
974 | * of the space reserved for the buffer. However, in the second case it | |
975 | * would be the address of the buffer. So if you are replacing hard coded | |
976 | * stack buffers with this macro you need to make sure you remove the & from | |
977 | * the locations where you are taking the address of the buffer. | |
978 | * | |
979 | * Note that the size parameter is the number of array elements to allocate, | |
980 | * not the number of bytes. | |
981 | * | |
982 | * This macro can not be used outside of function scope, or for the creation | |
983 | * of a function scoped static buffer. It can not be used to create a cache | |
984 | * line aligned global buffer. | |
985 | */ | |
e8232fea | 986 | #define PAD_COUNT(s, pad) (((s) - 1) / (pad) + 1) |
ae1768a7 EE |
987 | #define PAD_SIZE(s, pad) (PAD_COUNT(s, pad) * pad) |
988 | #define ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, pad) \ | |
e8232fea | 989 | char __##name[ROUND(PAD_SIZE((size) * sizeof(type), pad), align) \ |
ae1768a7 | 990 | + (align - 1)]; \ |
de4d1135 MV |
991 | \ |
992 | type *name = (type *) ALIGN((uintptr_t)__##name, align) | |
ae1768a7 EE |
993 | #define ALLOC_ALIGN_BUFFER(type, name, size, align) \ |
994 | ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, 1) | |
995 | #define ALLOC_CACHE_ALIGN_BUFFER_PAD(type, name, size, pad) \ | |
996 | ALLOC_ALIGN_BUFFER_PAD(type, name, size, ARCH_DMA_MINALIGN, pad) | |
46a6d51c | 997 | #define ALLOC_CACHE_ALIGN_BUFFER(type, name, size) \ |
de4d1135 MV |
998 | ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN) |
999 | ||
1000 | /* | |
1001 | * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's | |
1002 | * purpose is to allow allocating aligned buffers outside of function scope. | |
1003 | * Usage of this macro shall be avoided or used with extreme care! | |
1004 | */ | |
1005 | #define DEFINE_ALIGN_BUFFER(type, name, size, align) \ | |
111396cc | 1006 | static char __##name[ALIGN(size * sizeof(type), align)] \ |
d7ea4d4d | 1007 | __aligned(align); \ |
46a6d51c | 1008 | \ |
de4d1135 MV |
1009 | static type *name = (type *)__##name |
1010 | #define DEFINE_CACHE_ALIGN_BUFFER(type, name, size) \ | |
1011 | DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN) | |
46a6d51c | 1012 | |
c9689ca3 SG |
1013 | /* |
1014 | * check_member() - Check the offset of a structure member | |
1015 | * | |
1016 | * @structure: Name of structure (e.g. global_data) | |
1017 | * @member: Name of member (e.g. baudrate) | |
1018 | * @offset: Expected offset in bytes | |
1019 | */ | |
1020 | #define check_member(structure, member, offset) _Static_assert( \ | |
1021 | offsetof(struct structure, member) == offset, \ | |
1022 | "`struct " #structure "` offset for `" #member "` is not " #offset) | |
1023 | ||
476476e7 SG |
1024 | /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */ |
1025 | #ifdef CONFIG_EFI_STUB | |
1026 | #define ll_boot_init() false | |
1027 | #else | |
1028 | #define ll_boot_init() true | |
1029 | #endif | |
1030 | ||
c3eb3fe4 MF |
1031 | /* Pull in stuff for the build system */ |
1032 | #ifdef DO_DEPS_ONLY | |
1033 | # include <environment.h> | |
1034 | #endif | |
1035 | ||
e2211743 | 1036 | #endif /* __COMMON_H_ */ |