]>
Commit | Line | Data |
---|---|---|
83d290c5 | 1 | # SPDX-License-Identifier: GPL-2.0+ |
c609719b | 2 | # |
eca3aeb3 | 3 | # (C) Copyright 2000 - 2013 |
c609719b | 4 | # Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
c609719b WD |
5 | |
6 | Summary: | |
7 | ======== | |
8 | ||
24ee89b9 | 9 | This directory contains the source code for U-Boot, a boot loader for |
e86e5a07 WD |
10 | Embedded boards based on PowerPC, ARM, MIPS and several other |
11 | processors, which can be installed in a boot ROM and used to | |
12 | initialize and test the hardware or to download and run application | |
13 | code. | |
c609719b WD |
14 | |
15 | The development of U-Boot is closely related to Linux: some parts of | |
24ee89b9 WD |
16 | the source code originate in the Linux source tree, we have some |
17 | header files in common, and special provision has been made to | |
c609719b WD |
18 | support booting of Linux images. |
19 | ||
20 | Some attention has been paid to make this software easily | |
21 | configurable and extendable. For instance, all monitor commands are | |
22 | implemented with the same call interface, so that it's very easy to | |
23 | add new commands. Also, instead of permanently adding rarely used | |
24 | code (for instance hardware test utilities) to the monitor, you can | |
25 | load and run it dynamically. | |
26 | ||
27 | ||
28 | Status: | |
29 | ======= | |
30 | ||
31 | In general, all boards for which a configuration option exists in the | |
24ee89b9 | 32 | Makefile have been tested to some extent and can be considered |
c609719b WD |
33 | "working". In fact, many of them are used in production systems. |
34 | ||
7207b366 RD |
35 | In case of problems see the CHANGELOG file to find out who contributed |
36 | the specific port. In addition, there are various MAINTAINERS files | |
37 | scattered throughout the U-Boot source identifying the people or | |
38 | companies responsible for various boards and subsystems. | |
c609719b | 39 | |
7207b366 RD |
40 | Note: As of August, 2010, there is no longer a CHANGELOG file in the |
41 | actual U-Boot source tree; however, it can be created dynamically | |
42 | from the Git log using: | |
adb9d851 RD |
43 | |
44 | make CHANGELOG | |
45 | ||
c609719b WD |
46 | |
47 | Where to get help: | |
48 | ================== | |
49 | ||
24ee89b9 | 50 | In case you have questions about, problems with or contributions for |
7207b366 | 51 | U-Boot, you should send a message to the U-Boot mailing list at |
0c32565f PT |
52 | <u-boot@lists.denx.de>. There is also an archive of previous traffic |
53 | on the mailing list - please search the archive before asking FAQ's. | |
6681bbb5 NH |
54 | Please see https://lists.denx.de/pipermail/u-boot and |
55 | https://marc.info/?l=u-boot | |
c609719b | 56 | |
218ca724 WD |
57 | Where to get source code: |
58 | ========================= | |
59 | ||
7207b366 | 60 | The U-Boot source code is maintained in the Git repository at |
a3bbd0b9 HS |
61 | https://source.denx.de/u-boot/u-boot.git ; you can browse it online at |
62 | https://source.denx.de/u-boot/u-boot | |
218ca724 | 63 | |
c4bd51e2 | 64 | The "Tags" links on this page allow you to download tarballs of |
11ccc33f | 65 | any version you might be interested in. Official releases are also |
c4bd51e2 NH |
66 | available from the DENX file server through HTTPS or FTP. |
67 | https://ftp.denx.de/pub/u-boot/ | |
68 | ftp://ftp.denx.de/pub/u-boot/ | |
218ca724 WD |
69 | |
70 | ||
c609719b WD |
71 | Where we come from: |
72 | =================== | |
73 | ||
74 | - start from 8xxrom sources | |
047f6ec0 | 75 | - create PPCBoot project (https://sourceforge.net/projects/ppcboot) |
c609719b WD |
76 | - clean up code |
77 | - make it easier to add custom boards | |
78 | - make it possible to add other [PowerPC] CPUs | |
79 | - extend functions, especially: | |
80 | * Provide extended interface to Linux boot loader | |
81 | * S-Record download | |
82 | * network boot | |
9e5616de | 83 | * ATA disk / SCSI ... boot |
047f6ec0 | 84 | - create ARMBoot project (https://sourceforge.net/projects/armboot) |
c609719b | 85 | - add other CPU families (starting with ARM) |
047f6ec0 NH |
86 | - create U-Boot project (https://sourceforge.net/projects/u-boot) |
87 | - current project page: see https://www.denx.de/wiki/U-Boot | |
24ee89b9 WD |
88 | |
89 | ||
90 | Names and Spelling: | |
91 | =================== | |
92 | ||
93 | The "official" name of this project is "Das U-Boot". The spelling | |
94 | "U-Boot" shall be used in all written text (documentation, comments | |
95 | in source files etc.). Example: | |
96 | ||
97 | This is the README file for the U-Boot project. | |
98 | ||
99 | File names etc. shall be based on the string "u-boot". Examples: | |
100 | ||
101 | include/asm-ppc/u-boot.h | |
102 | ||
103 | #include <asm/u-boot.h> | |
104 | ||
105 | Variable names, preprocessor constants etc. shall be either based on | |
106 | the string "u_boot" or on "U_BOOT". Example: | |
107 | ||
108 | U_BOOT_VERSION u_boot_logo | |
109 | IH_OS_U_BOOT u_boot_hush_start | |
c609719b WD |
110 | |
111 | ||
93f19cc0 WD |
112 | Versioning: |
113 | =========== | |
114 | ||
360d883a TW |
115 | Starting with the release in October 2008, the names of the releases |
116 | were changed from numerical release numbers without deeper meaning | |
117 | into a time stamp based numbering. Regular releases are identified by | |
118 | names consisting of the calendar year and month of the release date. | |
119 | Additional fields (if present) indicate release candidates or bug fix | |
120 | releases in "stable" maintenance trees. | |
121 | ||
122 | Examples: | |
c0f40859 | 123 | U-Boot v2009.11 - Release November 2009 |
360d883a | 124 | U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree |
0de21ecb | 125 | U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release |
93f19cc0 WD |
126 | |
127 | ||
c609719b WD |
128 | Directory Hierarchy: |
129 | ==================== | |
130 | ||
6e73ed00 | 131 | /arch Architecture-specific files |
6eae68e4 | 132 | /arc Files generic to ARC architecture |
8d321b81 | 133 | /arm Files generic to ARM architecture |
8d321b81 | 134 | /m68k Files generic to m68k architecture |
8d321b81 | 135 | /microblaze Files generic to microblaze architecture |
8d321b81 | 136 | /mips Files generic to MIPS architecture |
8d321b81 | 137 | /nios2 Files generic to Altera NIOS2 architecture |
a47a12be | 138 | /powerpc Files generic to PowerPC architecture |
3fafced7 | 139 | /riscv Files generic to RISC-V architecture |
7207b366 | 140 | /sandbox Files generic to HW-independent "sandbox" |
8d321b81 | 141 | /sh Files generic to SH architecture |
33c7731b | 142 | /x86 Files generic to x86 architecture |
e4eb313a | 143 | /xtensa Files generic to Xtensa architecture |
6e73ed00 SG |
144 | /api Machine/arch-independent API for external apps |
145 | /board Board-dependent files | |
19a91f24 | 146 | /boot Support for images and booting |
740f7e5c | 147 | /cmd U-Boot commands functions |
6e73ed00 | 148 | /common Misc architecture-independent functions |
7207b366 | 149 | /configs Board default configuration files |
8d321b81 | 150 | /disk Code for disk drive partition handling |
6e73ed00 SG |
151 | /doc Documentation (a mix of ReST and READMEs) |
152 | /drivers Device drivers | |
153 | /dts Makefile for building internal U-Boot fdt. | |
154 | /env Environment support | |
8d321b81 PT |
155 | /examples Example code for standalone applications, etc. |
156 | /fs Filesystem code (cramfs, ext2, jffs2, etc.) | |
157 | /include Header Files | |
7207b366 RD |
158 | /lib Library routines generic to all architectures |
159 | /Licenses Various license files | |
8d321b81 PT |
160 | /net Networking code |
161 | /post Power On Self Test | |
7207b366 RD |
162 | /scripts Various build scripts and Makefiles |
163 | /test Various unit test files | |
6e73ed00 | 164 | /tools Tools to build and sign FIT images, etc. |
c609719b | 165 | |
c609719b WD |
166 | Software Configuration: |
167 | ======================= | |
168 | ||
c609719b WD |
169 | Selection of Processor Architecture and Board Type: |
170 | --------------------------------------------------- | |
171 | ||
172 | For all supported boards there are ready-to-use default | |
ab584d67 | 173 | configurations available; just type "make <board_name>_defconfig". |
c609719b WD |
174 | |
175 | Example: For a TQM823L module type: | |
176 | ||
177 | cd u-boot | |
ab584d67 | 178 | make TQM823L_defconfig |
c609719b | 179 | |
7207b366 RD |
180 | Note: If you're looking for the default configuration file for a board |
181 | you're sure used to be there but is now missing, check the file | |
182 | doc/README.scrapyard for a list of no longer supported boards. | |
c609719b | 183 | |
75b3c3aa SG |
184 | Sandbox Environment: |
185 | -------------------- | |
186 | ||
187 | U-Boot can be built natively to run on a Linux host using the 'sandbox' | |
188 | board. This allows feature development which is not board- or architecture- | |
189 | specific to be undertaken on a native platform. The sandbox is also used to | |
190 | run some of U-Boot's tests. | |
191 | ||
bbb140ed | 192 | See doc/arch/sandbox.rst for more details. |
75b3c3aa SG |
193 | |
194 | ||
db910353 SG |
195 | Board Initialisation Flow: |
196 | -------------------------- | |
197 | ||
198 | This is the intended start-up flow for boards. This should apply for both | |
7207b366 RD |
199 | SPL and U-Boot proper (i.e. they both follow the same rules). |
200 | ||
201 | Note: "SPL" stands for "Secondary Program Loader," which is explained in | |
202 | more detail later in this file. | |
203 | ||
204 | At present, SPL mostly uses a separate code path, but the function names | |
205 | and roles of each function are the same. Some boards or architectures | |
206 | may not conform to this. At least most ARM boards which use | |
207 | CONFIG_SPL_FRAMEWORK conform to this. | |
208 | ||
209 | Execution typically starts with an architecture-specific (and possibly | |
210 | CPU-specific) start.S file, such as: | |
211 | ||
212 | - arch/arm/cpu/armv7/start.S | |
213 | - arch/powerpc/cpu/mpc83xx/start.S | |
214 | - arch/mips/cpu/start.S | |
db910353 | 215 | |
7207b366 RD |
216 | and so on. From there, three functions are called; the purpose and |
217 | limitations of each of these functions are described below. | |
db910353 SG |
218 | |
219 | lowlevel_init(): | |
220 | - purpose: essential init to permit execution to reach board_init_f() | |
221 | - no global_data or BSS | |
222 | - there is no stack (ARMv7 may have one but it will soon be removed) | |
223 | - must not set up SDRAM or use console | |
224 | - must only do the bare minimum to allow execution to continue to | |
225 | board_init_f() | |
226 | - this is almost never needed | |
227 | - return normally from this function | |
228 | ||
229 | board_init_f(): | |
230 | - purpose: set up the machine ready for running board_init_r(): | |
231 | i.e. SDRAM and serial UART | |
232 | - global_data is available | |
233 | - stack is in SRAM | |
234 | - BSS is not available, so you cannot use global/static variables, | |
235 | only stack variables and global_data | |
236 | ||
237 | Non-SPL-specific notes: | |
238 | - dram_init() is called to set up DRAM. If already done in SPL this | |
239 | can do nothing | |
240 | ||
241 | SPL-specific notes: | |
242 | - you can override the entire board_init_f() function with your own | |
243 | version as needed. | |
244 | - preloader_console_init() can be called here in extremis | |
245 | - should set up SDRAM, and anything needed to make the UART work | |
499696e4 | 246 | - there is no need to clear BSS, it will be done by crt0.S |
1425465a AD |
247 | - for specific scenarios on certain architectures an early BSS *can* |
248 | be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing | |
249 | of BSS prior to entering board_init_f()) but doing so is discouraged. | |
250 | Instead it is strongly recommended to architect any code changes | |
251 | or additions such to not depend on the availability of BSS during | |
252 | board_init_f() as indicated in other sections of this README to | |
253 | maintain compatibility and consistency across the entire code base. | |
db910353 SG |
254 | - must return normally from this function (don't call board_init_r() |
255 | directly) | |
256 | ||
257 | Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at | |
258 | this point the stack and global_data are relocated to below | |
259 | CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of | |
260 | memory. | |
261 | ||
262 | board_init_r(): | |
263 | - purpose: main execution, common code | |
264 | - global_data is available | |
265 | - SDRAM is available | |
266 | - BSS is available, all static/global variables can be used | |
267 | - execution eventually continues to main_loop() | |
268 | ||
269 | Non-SPL-specific notes: | |
270 | - U-Boot is relocated to the top of memory and is now running from | |
271 | there. | |
272 | ||
273 | SPL-specific notes: | |
274 | - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and | |
63b2316c AK |
275 | CONFIG_SYS_FSL_HAS_CCI400 |
276 | ||
277 | Defined For SoC that has cache coherent interconnect | |
278 | CCN-400 | |
7f6c2cbc | 279 | |
c055cee1 AK |
280 | CONFIG_SYS_FSL_HAS_CCN504 |
281 | ||
282 | Defined for SoC that has cache coherent interconnect CCN-504 | |
283 | ||
c609719b WD |
284 | The following options need to be configured: |
285 | ||
2628114e KP |
286 | - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. |
287 | ||
288 | - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. | |
6ccec449 | 289 | |
66412c63 | 290 | - 85xx CPU Options: |
ffd06e02 YS |
291 | CONFIG_SYS_PPC64 |
292 | ||
293 | Specifies that the core is a 64-bit PowerPC implementation (implements | |
294 | the "64" category of the Power ISA). This is necessary for ePAPR | |
295 | compliance, among other possible reasons. | |
296 | ||
33eee330 SW |
297 | CONFIG_SYS_FSL_ERRATUM_A004510 |
298 | ||
299 | Enables a workaround for erratum A004510. If set, | |
300 | then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and | |
301 | CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. | |
302 | ||
303 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV | |
304 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) | |
305 | ||
306 | Defines one or two SoC revisions (low 8 bits of SVR) | |
307 | for which the A004510 workaround should be applied. | |
308 | ||
309 | The rest of SVR is either not relevant to the decision | |
310 | of whether the erratum is present (e.g. p2040 versus | |
311 | p2041) or is implied by the build target, which controls | |
312 | whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. | |
313 | ||
314 | See Freescale App Note 4493 for more information about | |
315 | this erratum. | |
316 | ||
317 | CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY | |
318 | ||
319 | This is the value to write into CCSR offset 0x18600 | |
320 | according to the A004510 workaround. | |
321 | ||
b135991a PJ |
322 | CONFIG_SYS_FSL_SINGLE_SOURCE_CLK |
323 | Single Source Clock is clocking mode present in some of FSL SoC's. | |
324 | In this mode, a single differential clock is used to supply | |
325 | clocks to the sysclock, ddrclock and usbclock. | |
326 | ||
6cb461b4 | 327 | - Generic CPU options: |
6cb461b4 | 328 | |
5614e71b YS |
329 | CONFIG_SYS_FSL_DDR |
330 | Freescale DDR driver in use. This type of DDR controller is | |
1c58857a | 331 | found in mpc83xx, mpc85xx as well as some ARM core SoCs. |
5614e71b YS |
332 | |
333 | CONFIG_SYS_FSL_DDR_ADDR | |
334 | Freescale DDR memory-mapped register base. | |
335 | ||
1c40707e PK |
336 | CONFIG_SYS_FSL_IFC_CLK_DIV |
337 | Defines divider of platform clock(clock input to IFC controller). | |
338 | ||
add63f94 PK |
339 | CONFIG_SYS_FSL_LBC_CLK_DIV |
340 | Defines divider of platform clock(clock input to eLBC controller). | |
341 | ||
6b9e309a YS |
342 | CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY |
343 | Physical address from the view of DDR controllers. It is the | |
344 | same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But | |
345 | it could be different for ARM SoCs. | |
346 | ||
92bbd64e | 347 | - MIPS CPU options: |
92bbd64e DS |
348 | CONFIG_XWAY_SWAP_BYTES |
349 | ||
350 | Enable compilation of tools/xway-swap-bytes needed for Lantiq | |
351 | XWAY SoCs for booting from NOR flash. The U-Boot image needs to | |
352 | be swapped if a flash programmer is used. | |
353 | ||
b67d8816 CR |
354 | - ARM options: |
355 | CONFIG_SYS_EXCEPTION_VECTORS_HIGH | |
356 | ||
357 | Select high exception vectors of the ARM core, e.g., do not | |
358 | clear the V bit of the c1 register of CP15. | |
359 | ||
207774b2 YS |
360 | COUNTER_FREQUENCY |
361 | Generic timer clock source frequency. | |
362 | ||
363 | COUNTER_FREQUENCY_REAL | |
364 | Generic timer clock source frequency if the real clock is | |
365 | different from COUNTER_FREQUENCY, and can only be determined | |
366 | at run time. | |
367 | ||
73c38934 SW |
368 | - Tegra SoC options: |
369 | CONFIG_TEGRA_SUPPORT_NON_SECURE | |
370 | ||
371 | Support executing U-Boot in non-secure (NS) mode. Certain | |
372 | impossible actions will be skipped if the CPU is in NS mode, | |
373 | such as ARM architectural timer initialization. | |
374 | ||
5da627a4 | 375 | - Linux Kernel Interface: |
5da627a4 WD |
376 | CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] |
377 | ||
b445bbb4 | 378 | When transferring memsize parameter to Linux, some versions |
5da627a4 WD |
379 | expect it to be in bytes, others in MB. |
380 | Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. | |
381 | ||
fec6d9ee | 382 | CONFIG_OF_LIBFDT |
f57f70aa WD |
383 | |
384 | New kernel versions are expecting firmware settings to be | |
213bf8c8 GVB |
385 | passed using flattened device trees (based on open firmware |
386 | concepts). | |
387 | ||
388 | CONFIG_OF_LIBFDT | |
389 | * New libfdt-based support | |
390 | * Adds the "fdt" command | |
3bb342fc | 391 | * The bootm command automatically updates the fdt |
213bf8c8 | 392 | |
f57f70aa WD |
393 | OF_TBCLK - The timebase frequency. |
394 | ||
11ccc33f MZ |
395 | boards with QUICC Engines require OF_QE to set UCC MAC |
396 | addresses | |
3bb342fc | 397 | |
3887c3fb HS |
398 | CONFIG_OF_IDE_FIXUP |
399 | ||
400 | U-Boot can detect if an IDE device is present or not. | |
401 | If not, and this new config option is activated, U-Boot | |
402 | removes the ATA node from the DTS before booting Linux, | |
403 | so the Linux IDE driver does not probe the device and | |
404 | crash. This is needed for buggy hardware (uc101) where | |
405 | no pull down resistor is connected to the signal IDE5V_DD7. | |
406 | ||
0b2f4eca NG |
407 | - vxWorks boot parameters: |
408 | ||
409 | bootvx constructs a valid bootline using the following | |
9e98b7e3 BM |
410 | environments variables: bootdev, bootfile, ipaddr, netmask, |
411 | serverip, gatewayip, hostname, othbootargs. | |
0b2f4eca NG |
412 | It loads the vxWorks image pointed bootfile. |
413 | ||
81a05d9b | 414 | Note: If a "bootargs" environment is defined, it will override |
0b2f4eca NG |
415 | the defaults discussed just above. |
416 | ||
93bc2193 | 417 | - Cache Configuration for ARM: |
93bc2193 A |
418 | CONFIG_SYS_PL310_BASE - Physical base address of PL310 |
419 | controller register space | |
420 | ||
6705d81e | 421 | - Serial Ports: |
6705d81e WD |
422 | CONFIG_PL011_CLOCK |
423 | ||
424 | If you have Amba PrimeCell PL011 UARTs, set this variable to | |
425 | the clock speed of the UARTs. | |
426 | ||
427 | CONFIG_PL01x_PORTS | |
428 | ||
429 | If you have Amba PrimeCell PL010 or PL011 UARTs on your board, | |
430 | define this to a list of base addresses for each (supported) | |
431 | port. See e.g. include/configs/versatile.h | |
432 | ||
d57dee57 KM |
433 | CONFIG_SERIAL_HW_FLOW_CONTROL |
434 | ||
435 | Define this variable to enable hw flow control in serial driver. | |
436 | Current user of this option is drivers/serial/nsl16550.c driver | |
6705d81e | 437 | |
302a6487 SG |
438 | - Removal of commands |
439 | If no commands are needed to boot, you can disable | |
440 | CONFIG_CMDLINE to remove them. In this case, the command line | |
441 | will not be available, and when U-Boot wants to execute the | |
442 | boot command (on start-up) it will call board_run_command() | |
443 | instead. This can reduce image size significantly for very | |
444 | simple boot procedures. | |
445 | ||
a5ecbe62 WD |
446 | - Regular expression support: |
447 | CONFIG_REGEX | |
93e14596 WD |
448 | If this variable is defined, U-Boot is linked against |
449 | the SLRE (Super Light Regular Expression) library, | |
450 | which adds regex support to some commands, as for | |
451 | example "env grep" and "setexpr". | |
a5ecbe62 | 452 | |
c609719b | 453 | - Watchdog: |
933ada56 RV |
454 | CONFIG_SYS_WATCHDOG_FREQ |
455 | Some platforms automatically call WATCHDOG_RESET() | |
456 | from the timer interrupt handler every | |
457 | CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the | |
458 | board configuration file, a default of CONFIG_SYS_HZ/2 | |
459 | (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ | |
460 | to 0 disables calling WATCHDOG_RESET() from the timer | |
461 | interrupt. | |
462 | ||
c609719b WD |
463 | - Real-Time Clock: |
464 | ||
602ad3b3 | 465 | When CONFIG_CMD_DATE is selected, the type of the RTC |
c609719b WD |
466 | has to be selected, too. Define exactly one of the |
467 | following options: | |
468 | ||
c609719b | 469 | CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC |
4e8b7544 | 470 | CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC |
c609719b | 471 | CONFIG_RTC_MC146818 - use MC146818 RTC |
1cb8e980 | 472 | CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC |
c609719b | 473 | CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC |
7f70e853 | 474 | CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC |
412921d2 | 475 | CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC |
3bac3513 | 476 | CONFIG_RTC_DS164x - use Dallas DS164x RTC |
9536dfcc | 477 | CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC |
4c0d4c3b | 478 | CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC |
2bd3cab3 | 479 | CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 |
71d19f30 HS |
480 | CONFIG_SYS_RV3029_TCR - enable trickle charger on |
481 | RV3029 RTC. | |
c609719b | 482 | |
b37c7e5e WD |
483 | Note that if the RTC uses I2C, then the I2C interface |
484 | must also be configured. See I2C Support, below. | |
485 | ||
e92739d3 PT |
486 | - GPIO Support: |
487 | CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO | |
e92739d3 | 488 | |
5dec49ca CP |
489 | The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of |
490 | chip-ngpio pairs that tell the PCA953X driver the number of | |
491 | pins supported by a particular chip. | |
492 | ||
e92739d3 PT |
493 | Note that if the GPIO device uses I2C, then the I2C interface |
494 | must also be configured. See I2C Support, below. | |
495 | ||
aa53233a SG |
496 | - I/O tracing: |
497 | When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O | |
498 | accesses and can checksum them or write a list of them out | |
499 | to memory. See the 'iotrace' command for details. This is | |
500 | useful for testing device drivers since it can confirm that | |
501 | the driver behaves the same way before and after a code | |
502 | change. Currently this is supported on sandbox and arm. To | |
503 | add support for your architecture, add '#include <iotrace.h>' | |
504 | to the bottom of arch/<arch>/include/asm/io.h and test. | |
505 | ||
506 | Example output from the 'iotrace stats' command is below. | |
507 | Note that if the trace buffer is exhausted, the checksum will | |
508 | still continue to operate. | |
509 | ||
510 | iotrace is enabled | |
511 | Start: 10000000 (buffer start address) | |
512 | Size: 00010000 (buffer size) | |
513 | Offset: 00000120 (current buffer offset) | |
514 | Output: 10000120 (start + offset) | |
515 | Count: 00000018 (number of trace records) | |
516 | CRC32: 9526fb66 (CRC32 of all trace records) | |
517 | ||
c609719b WD |
518 | - Timestamp Support: |
519 | ||
43d9616c WD |
520 | When CONFIG_TIMESTAMP is selected, the timestamp |
521 | (date and time) of an image is printed by image | |
522 | commands like bootm or iminfo. This option is | |
602ad3b3 | 523 | automatically enabled when you select CONFIG_CMD_DATE . |
c609719b | 524 | |
923c46f9 KP |
525 | - Partition Labels (disklabels) Supported: |
526 | Zero or more of the following: | |
527 | CONFIG_MAC_PARTITION Apple's MacOS partition table. | |
923c46f9 KP |
528 | CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. |
529 | CONFIG_EFI_PARTITION GPT partition table, common when EFI is the | |
530 | bootloader. Note 2TB partition limit; see | |
531 | disk/part_efi.c | |
c649e3c9 | 532 | CONFIG_SCSI) you must configure support for at |
923c46f9 | 533 | least one non-MTD partition type as well. |
c609719b | 534 | |
c609719b | 535 | - NETWORK Support (PCI): |
ce5207e1 KM |
536 | CONFIG_E1000_SPI |
537 | Utility code for direct access to the SPI bus on Intel 8257x. | |
538 | This does not do anything useful unless you set at least one | |
539 | of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. | |
540 | ||
c609719b WD |
541 | CONFIG_NATSEMI |
542 | Support for National dp83815 chips. | |
543 | ||
544 | CONFIG_NS8382X | |
545 | Support for National dp8382[01] gigabit chips. | |
546 | ||
45219c46 | 547 | - NETWORK Support (other): |
efdd7319 RH |
548 | CONFIG_CALXEDA_XGMAC |
549 | Support for the Calxeda XGMAC device | |
550 | ||
3bb46d23 | 551 | CONFIG_LAN91C96 |
45219c46 WD |
552 | Support for SMSC's LAN91C96 chips. |
553 | ||
45219c46 WD |
554 | CONFIG_LAN91C96_USE_32_BIT |
555 | Define this to enable 32 bit addressing | |
556 | ||
dc02bada HS |
557 | CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT |
558 | Define this if you have more then 3 PHYs. | |
559 | ||
b3dbf4a5 ML |
560 | CONFIG_FTGMAC100 |
561 | Support for Faraday's FTGMAC100 Gigabit SoC Ethernet | |
562 | ||
563 | CONFIG_FTGMAC100_EGIGA | |
564 | Define this to use GE link update with gigabit PHY. | |
565 | Define this if FTGMAC100 is connected to gigabit PHY. | |
566 | If your system has 10/100 PHY only, it might not occur | |
567 | wrong behavior. Because PHY usually return timeout or | |
568 | useless data when polling gigabit status and gigabit | |
569 | control registers. This behavior won't affect the | |
570 | correctnessof 10/100 link speed update. | |
571 | ||
3d0075fa YS |
572 | CONFIG_SH_ETHER |
573 | Support for Renesas on-chip Ethernet controller | |
574 | ||
575 | CONFIG_SH_ETHER_USE_PORT | |
576 | Define the number of ports to be used | |
577 | ||
578 | CONFIG_SH_ETHER_PHY_ADDR | |
579 | Define the ETH PHY's address | |
580 | ||
68260aab YS |
581 | CONFIG_SH_ETHER_CACHE_WRITEBACK |
582 | If this option is set, the driver enables cache flush. | |
583 | ||
5e124724 | 584 | - TPM Support: |
90899cc0 CC |
585 | CONFIG_TPM |
586 | Support TPM devices. | |
587 | ||
0766ad2f CR |
588 | CONFIG_TPM_TIS_INFINEON |
589 | Support for Infineon i2c bus TPM devices. Only one device | |
1b393db5 TWHT |
590 | per system is supported at this time. |
591 | ||
1b393db5 TWHT |
592 | CONFIG_TPM_TIS_I2C_BURST_LIMITATION |
593 | Define the burst count bytes upper limit | |
594 | ||
3aa74088 CR |
595 | CONFIG_TPM_ST33ZP24 |
596 | Support for STMicroelectronics TPM devices. Requires DM_TPM support. | |
597 | ||
598 | CONFIG_TPM_ST33ZP24_I2C | |
599 | Support for STMicroelectronics ST33ZP24 I2C devices. | |
600 | Requires TPM_ST33ZP24 and I2C. | |
601 | ||
b75fdc11 CR |
602 | CONFIG_TPM_ST33ZP24_SPI |
603 | Support for STMicroelectronics ST33ZP24 SPI devices. | |
604 | Requires TPM_ST33ZP24 and SPI. | |
605 | ||
c01939c7 DE |
606 | CONFIG_TPM_ATMEL_TWI |
607 | Support for Atmel TWI TPM device. Requires I2C support. | |
608 | ||
90899cc0 | 609 | CONFIG_TPM_TIS_LPC |
5e124724 VB |
610 | Support for generic parallel port TPM devices. Only one device |
611 | per system is supported at this time. | |
612 | ||
613 | CONFIG_TPM_TIS_BASE_ADDRESS | |
614 | Base address where the generic TPM device is mapped | |
615 | to. Contemporary x86 systems usually map it at | |
616 | 0xfed40000. | |
617 | ||
be6c1529 RP |
618 | CONFIG_TPM |
619 | Define this to enable the TPM support library which provides | |
620 | functional interfaces to some TPM commands. | |
621 | Requires support for a TPM device. | |
622 | ||
623 | CONFIG_TPM_AUTH_SESSIONS | |
624 | Define this to enable authorized functions in the TPM library. | |
625 | Requires CONFIG_TPM and CONFIG_SHA1. | |
626 | ||
c609719b WD |
627 | - USB Support: |
628 | At the moment only the UHCI host controller is | |
064b55cf | 629 | supported (PIP405, MIP405); define |
c609719b WD |
630 | CONFIG_USB_UHCI to enable it. |
631 | define CONFIG_USB_KEYBOARD to enable the USB Keyboard | |
30d56fae | 632 | and define CONFIG_USB_STORAGE to enable the USB |
c609719b WD |
633 | storage devices. |
634 | Note: | |
635 | Supported are USB Keyboards and USB Floppy drives | |
636 | (TEAC FD-05PUB). | |
4d13cbad | 637 | |
6e9e0626 OT |
638 | CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 |
639 | HW module registers. | |
640 | ||
16c8d5e7 WD |
641 | - USB Device: |
642 | Define the below if you wish to use the USB console. | |
643 | Once firmware is rebuilt from a serial console issue the | |
644 | command "setenv stdin usbtty; setenv stdout usbtty" and | |
11ccc33f | 645 | attach your USB cable. The Unix command "dmesg" should print |
16c8d5e7 WD |
646 | it has found a new device. The environment variable usbtty |
647 | can be set to gserial or cdc_acm to enable your device to | |
386eda02 | 648 | appear to a USB host as a Linux gserial device or a |
16c8d5e7 WD |
649 | Common Device Class Abstract Control Model serial device. |
650 | If you select usbtty = gserial you should be able to enumerate | |
651 | a Linux host by | |
652 | # modprobe usbserial vendor=0xVendorID product=0xProductID | |
653 | else if using cdc_acm, simply setting the environment | |
654 | variable usbtty to be cdc_acm should suffice. The following | |
655 | might be defined in YourBoardName.h | |
386eda02 | 656 | |
16c8d5e7 WD |
657 | CONFIG_USB_DEVICE |
658 | Define this to build a UDC device | |
659 | ||
660 | CONFIG_USB_TTY | |
661 | Define this to have a tty type of device available to | |
662 | talk to the UDC device | |
386eda02 | 663 | |
f9da0f89 VK |
664 | CONFIG_USBD_HS |
665 | Define this to enable the high speed support for usb | |
666 | device and usbtty. If this feature is enabled, a routine | |
667 | int is_usbd_high_speed(void) | |
668 | also needs to be defined by the driver to dynamically poll | |
669 | whether the enumeration has succeded at high speed or full | |
670 | speed. | |
671 | ||
386eda02 | 672 | If you have a USB-IF assigned VendorID then you may wish to |
16c8d5e7 | 673 | define your own vendor specific values either in BoardName.h |
386eda02 | 674 | or directly in usbd_vendor_info.h. If you don't define |
16c8d5e7 WD |
675 | CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, |
676 | CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot | |
677 | should pretend to be a Linux device to it's target host. | |
678 | ||
679 | CONFIG_USBD_MANUFACTURER | |
680 | Define this string as the name of your company for | |
681 | - CONFIG_USBD_MANUFACTURER "my company" | |
386eda02 | 682 | |
16c8d5e7 WD |
683 | CONFIG_USBD_PRODUCT_NAME |
684 | Define this string as the name of your product | |
685 | - CONFIG_USBD_PRODUCT_NAME "acme usb device" | |
686 | ||
687 | CONFIG_USBD_VENDORID | |
688 | Define this as your assigned Vendor ID from the USB | |
689 | Implementors Forum. This *must* be a genuine Vendor ID | |
690 | to avoid polluting the USB namespace. | |
691 | - CONFIG_USBD_VENDORID 0xFFFF | |
386eda02 | 692 | |
16c8d5e7 WD |
693 | CONFIG_USBD_PRODUCTID |
694 | Define this as the unique Product ID | |
695 | for your device | |
696 | - CONFIG_USBD_PRODUCTID 0xFFFF | |
4d13cbad | 697 | |
d70a560f IG |
698 | - ULPI Layer Support: |
699 | The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via | |
700 | the generic ULPI layer. The generic layer accesses the ULPI PHY | |
701 | via the platform viewport, so you need both the genric layer and | |
702 | the viewport enabled. Currently only Chipidea/ARC based | |
703 | viewport is supported. | |
704 | To enable the ULPI layer support, define CONFIG_USB_ULPI and | |
705 | CONFIG_USB_ULPI_VIEWPORT in your board configuration file. | |
6d365ea0 LS |
706 | If your ULPI phy needs a different reference clock than the |
707 | standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to | |
708 | the appropriate value in Hz. | |
c609719b | 709 | |
71f95118 | 710 | - MMC Support: |
afb35666 YS |
711 | CONFIG_SH_MMCIF |
712 | Support for Renesas on-chip MMCIF controller | |
713 | ||
714 | CONFIG_SH_MMCIF_ADDR | |
715 | Define the base address of MMCIF registers | |
716 | ||
717 | CONFIG_SH_MMCIF_CLK | |
718 | Define the clock frequency for MMCIF | |
719 | ||
b3ba6e94 | 720 | - USB Device Firmware Update (DFU) class support: |
bb4059a5 | 721 | CONFIG_DFU_OVER_USB |
b3ba6e94 TR |
722 | This enables the USB portion of the DFU USB class |
723 | ||
c6631764 PA |
724 | CONFIG_DFU_NAND |
725 | This enables support for exposing NAND devices via DFU. | |
726 | ||
a9479f04 AM |
727 | CONFIG_DFU_RAM |
728 | This enables support for exposing RAM via DFU. | |
729 | Note: DFU spec refer to non-volatile memory usage, but | |
730 | allow usages beyond the scope of spec - here RAM usage, | |
731 | one that would help mostly the developer. | |
732 | ||
e7e75c70 HS |
733 | CONFIG_SYS_DFU_DATA_BUF_SIZE |
734 | Dfu transfer uses a buffer before writing data to the | |
735 | raw storage device. Make the size (in bytes) of this buffer | |
736 | configurable. The size of this buffer is also configurable | |
737 | through the "dfu_bufsiz" environment variable. | |
738 | ||
ea2453d5 PA |
739 | CONFIG_SYS_DFU_MAX_FILE_SIZE |
740 | When updating files rather than the raw storage device, | |
741 | we use a static buffer to copy the file into and then write | |
742 | the buffer once we've been given the whole file. Define | |
743 | this to the maximum filesize (in bytes) for the buffer. | |
744 | Default is 4 MiB if undefined. | |
745 | ||
001a8319 HS |
746 | DFU_DEFAULT_POLL_TIMEOUT |
747 | Poll timeout [ms], is the timeout a device can send to the | |
748 | host. The host must wait for this timeout before sending | |
749 | a subsequent DFU_GET_STATUS request to the device. | |
750 | ||
751 | DFU_MANIFEST_POLL_TIMEOUT | |
752 | Poll timeout [ms], which the device sends to the host when | |
753 | entering dfuMANIFEST state. Host waits this timeout, before | |
754 | sending again an USB request to the device. | |
755 | ||
c609719b | 756 | - Keyboard Support: |
39f615ed SG |
757 | See Kconfig help for available keyboard drivers. |
758 | ||
17ea1177 | 759 | - MII/PHY support: |
17ea1177 WD |
760 | CONFIG_PHY_CLOCK_FREQ (ppc4xx) |
761 | ||
762 | The clock frequency of the MII bus | |
763 | ||
17ea1177 WD |
764 | CONFIG_PHY_CMD_DELAY (ppc4xx) |
765 | ||
766 | Some PHY like Intel LXT971A need extra delay after | |
767 | command issued before MII status register can be read | |
768 | ||
c609719b WD |
769 | - IP address: |
770 | CONFIG_IPADDR | |
771 | ||
772 | Define a default value for the IP address to use for | |
11ccc33f | 773 | the default Ethernet interface, in case this is not |
c609719b | 774 | determined through e.g. bootp. |
1ebcd654 | 775 | (Environment variable "ipaddr") |
c609719b WD |
776 | |
777 | - Server IP address: | |
778 | CONFIG_SERVERIP | |
779 | ||
11ccc33f | 780 | Defines a default value for the IP address of a TFTP |
c609719b | 781 | server to contact when using the "tftboot" command. |
1ebcd654 | 782 | (Environment variable "serverip") |
c609719b | 783 | |
1ebcd654 WD |
784 | - Gateway IP address: |
785 | CONFIG_GATEWAYIP | |
786 | ||
787 | Defines a default value for the IP address of the | |
788 | default router where packets to other networks are | |
789 | sent to. | |
790 | (Environment variable "gatewayip") | |
791 | ||
792 | - Subnet mask: | |
793 | CONFIG_NETMASK | |
794 | ||
795 | Defines a default value for the subnet mask (or | |
796 | routing prefix) which is used to determine if an IP | |
797 | address belongs to the local subnet or needs to be | |
798 | forwarded through a router. | |
799 | (Environment variable "netmask") | |
800 | ||
c609719b WD |
801 | - BOOTP Recovery Mode: |
802 | CONFIG_BOOTP_RANDOM_DELAY | |
803 | ||
804 | If you have many targets in a network that try to | |
805 | boot using BOOTP, you may want to avoid that all | |
806 | systems send out BOOTP requests at precisely the same | |
807 | moment (which would happen for instance at recovery | |
808 | from a power failure, when all systems will try to | |
809 | boot, thus flooding the BOOTP server. Defining | |
810 | CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be | |
811 | inserted before sending out BOOTP requests. The | |
6c33c785 | 812 | following delays are inserted then: |
c609719b WD |
813 | |
814 | 1st BOOTP request: delay 0 ... 1 sec | |
815 | 2nd BOOTP request: delay 0 ... 2 sec | |
816 | 3rd BOOTP request: delay 0 ... 4 sec | |
817 | 4th and following | |
818 | BOOTP requests: delay 0 ... 8 sec | |
819 | ||
92ac8acc TR |
820 | CONFIG_BOOTP_ID_CACHE_SIZE |
821 | ||
822 | BOOTP packets are uniquely identified using a 32-bit ID. The | |
823 | server will copy the ID from client requests to responses and | |
824 | U-Boot will use this to determine if it is the destination of | |
825 | an incoming response. Some servers will check that addresses | |
826 | aren't in use before handing them out (usually using an ARP | |
827 | ping) and therefore take up to a few hundred milliseconds to | |
828 | respond. Network congestion may also influence the time it | |
829 | takes for a response to make it back to the client. If that | |
830 | time is too long, U-Boot will retransmit requests. In order | |
831 | to allow earlier responses to still be accepted after these | |
832 | retransmissions, U-Boot's BOOTP client keeps a small cache of | |
833 | IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this | |
834 | cache. The default is to keep IDs for up to four outstanding | |
835 | requests. Increasing this will allow U-Boot to accept offers | |
836 | from a BOOTP client in networks with unusually high latency. | |
837 | ||
fe389a82 | 838 | - DHCP Advanced Options: |
2c00e099 | 839 | |
d22c338e JH |
840 | - Link-local IP address negotiation: |
841 | Negotiate with other link-local clients on the local network | |
842 | for an address that doesn't require explicit configuration. | |
843 | This is especially useful if a DHCP server cannot be guaranteed | |
844 | to exist in all environments that the device must operate. | |
845 | ||
846 | See doc/README.link-local for more information. | |
847 | ||
24acb83d PK |
848 | - MAC address from environment variables |
849 | ||
850 | FDT_SEQ_MACADDR_FROM_ENV | |
851 | ||
852 | Fix-up device tree with MAC addresses fetched sequentially from | |
853 | environment variables. This config work on assumption that | |
854 | non-usable ethernet node of device-tree are either not present | |
855 | or their status has been marked as "disabled". | |
856 | ||
a3d991bd | 857 | - CDP Options: |
6e592385 | 858 | CONFIG_CDP_DEVICE_ID |
a3d991bd WD |
859 | |
860 | The device id used in CDP trigger frames. | |
861 | ||
862 | CONFIG_CDP_DEVICE_ID_PREFIX | |
863 | ||
864 | A two character string which is prefixed to the MAC address | |
865 | of the device. | |
866 | ||
867 | CONFIG_CDP_PORT_ID | |
868 | ||
869 | A printf format string which contains the ascii name of | |
870 | the port. Normally is set to "eth%d" which sets | |
11ccc33f | 871 | eth0 for the first Ethernet, eth1 for the second etc. |
a3d991bd WD |
872 | |
873 | CONFIG_CDP_CAPABILITIES | |
874 | ||
875 | A 32bit integer which indicates the device capabilities; | |
876 | 0x00000010 for a normal host which does not forwards. | |
877 | ||
878 | CONFIG_CDP_VERSION | |
879 | ||
880 | An ascii string containing the version of the software. | |
881 | ||
882 | CONFIG_CDP_PLATFORM | |
883 | ||
884 | An ascii string containing the name of the platform. | |
885 | ||
886 | CONFIG_CDP_TRIGGER | |
887 | ||
888 | A 32bit integer sent on the trigger. | |
889 | ||
890 | CONFIG_CDP_POWER_CONSUMPTION | |
891 | ||
892 | A 16bit integer containing the power consumption of the | |
893 | device in .1 of milliwatts. | |
894 | ||
895 | CONFIG_CDP_APPLIANCE_VLAN_TYPE | |
896 | ||
897 | A byte containing the id of the VLAN. | |
898 | ||
79267edd | 899 | - Status LED: CONFIG_LED_STATUS |
c609719b WD |
900 | |
901 | Several configurations allow to display the current | |
902 | status using a LED. For instance, the LED will blink | |
903 | fast while running U-Boot code, stop blinking as | |
904 | soon as a reply to a BOOTP request was received, and | |
905 | start blinking slow once the Linux kernel is running | |
906 | (supported by a status LED driver in the Linux | |
79267edd | 907 | kernel). Defining CONFIG_LED_STATUS enables this |
c609719b WD |
908 | feature in U-Boot. |
909 | ||
1df7bbba IG |
910 | Additional options: |
911 | ||
79267edd | 912 | CONFIG_LED_STATUS_GPIO |
1df7bbba IG |
913 | The status LED can be connected to a GPIO pin. |
914 | In such cases, the gpio_led driver can be used as a | |
79267edd | 915 | status LED backend implementation. Define CONFIG_LED_STATUS_GPIO |
1df7bbba IG |
916 | to include the gpio_led driver in the U-Boot binary. |
917 | ||
9dfdcdfe IG |
918 | CONFIG_GPIO_LED_INVERTED_TABLE |
919 | Some GPIO connected LEDs may have inverted polarity in which | |
920 | case the GPIO high value corresponds to LED off state and | |
921 | GPIO low value corresponds to LED on state. | |
922 | In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined | |
923 | with a list of GPIO LEDs that have inverted polarity. | |
924 | ||
55dabcc8 | 925 | - I2C Support: |
3f4978c7 | 926 | CONFIG_SYS_NUM_I2C_BUSES |
945a18e6 | 927 | Hold the number of i2c buses you want to use. |
3f4978c7 HS |
928 | |
929 | CONFIG_SYS_I2C_DIRECT_BUS | |
930 | define this, if you don't use i2c muxes on your hardware. | |
931 | if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can | |
932 | omit this define. | |
933 | ||
934 | CONFIG_SYS_I2C_MAX_HOPS | |
935 | define how many muxes are maximal consecutively connected | |
936 | on one i2c bus. If you not use i2c muxes, omit this | |
937 | define. | |
938 | ||
939 | CONFIG_SYS_I2C_BUSES | |
b445bbb4 | 940 | hold a list of buses you want to use, only used if |
3f4978c7 HS |
941 | CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example |
942 | a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and | |
943 | CONFIG_SYS_NUM_I2C_BUSES = 9: | |
944 | ||
945 | CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ | |
946 | {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ | |
947 | {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ | |
948 | {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ | |
949 | {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ | |
950 | {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ | |
951 | {1, {I2C_NULL_HOP}}, \ | |
952 | {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ | |
953 | {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ | |
954 | } | |
955 | ||
956 | which defines | |
957 | bus 0 on adapter 0 without a mux | |
ea818dbb HS |
958 | bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 |
959 | bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 | |
960 | bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 | |
961 | bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 | |
962 | bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 | |
3f4978c7 | 963 | bus 6 on adapter 1 without a mux |
ea818dbb HS |
964 | bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 |
965 | bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 | |
3f4978c7 HS |
966 | |
967 | If you do not have i2c muxes on your board, omit this define. | |
968 | ||
ce3b5d69 | 969 | - Legacy I2C Support: |
ea818dbb | 970 | If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) |
b37c7e5e WD |
971 | then the following macros need to be defined (examples are |
972 | from include/configs/lwmon.h): | |
c609719b WD |
973 | |
974 | I2C_INIT | |
975 | ||
b37c7e5e | 976 | (Optional). Any commands necessary to enable the I2C |
43d9616c | 977 | controller or configure ports. |
c609719b | 978 | |
ba56f625 | 979 | eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) |
b37c7e5e | 980 | |
c609719b WD |
981 | I2C_ACTIVE |
982 | ||
983 | The code necessary to make the I2C data line active | |
984 | (driven). If the data line is open collector, this | |
985 | define can be null. | |
986 | ||
b37c7e5e WD |
987 | eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) |
988 | ||
c609719b WD |
989 | I2C_TRISTATE |
990 | ||
991 | The code necessary to make the I2C data line tri-stated | |
992 | (inactive). If the data line is open collector, this | |
993 | define can be null. | |
994 | ||
b37c7e5e WD |
995 | eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) |
996 | ||
c609719b WD |
997 | I2C_READ |
998 | ||
472d5460 YS |
999 | Code that returns true if the I2C data line is high, |
1000 | false if it is low. | |
c609719b | 1001 | |
b37c7e5e WD |
1002 | eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) |
1003 | ||
c609719b WD |
1004 | I2C_SDA(bit) |
1005 | ||
472d5460 YS |
1006 | If <bit> is true, sets the I2C data line high. If it |
1007 | is false, it clears it (low). | |
c609719b | 1008 | |
b37c7e5e | 1009 | eg: #define I2C_SDA(bit) \ |
2535d602 | 1010 | if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ |
ba56f625 | 1011 | else immr->im_cpm.cp_pbdat &= ~PB_SDA |
b37c7e5e | 1012 | |
c609719b WD |
1013 | I2C_SCL(bit) |
1014 | ||
472d5460 YS |
1015 | If <bit> is true, sets the I2C clock line high. If it |
1016 | is false, it clears it (low). | |
c609719b | 1017 | |
b37c7e5e | 1018 | eg: #define I2C_SCL(bit) \ |
2535d602 | 1019 | if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ |
ba56f625 | 1020 | else immr->im_cpm.cp_pbdat &= ~PB_SCL |
b37c7e5e | 1021 | |
c609719b WD |
1022 | I2C_DELAY |
1023 | ||
1024 | This delay is invoked four times per clock cycle so this | |
1025 | controls the rate of data transfer. The data rate thus | |
b37c7e5e | 1026 | is 1 / (I2C_DELAY * 4). Often defined to be something |
945af8d7 WD |
1027 | like: |
1028 | ||
b37c7e5e | 1029 | #define I2C_DELAY udelay(2) |
c609719b | 1030 | |
793b5726 MF |
1031 | CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA |
1032 | ||
1033 | If your arch supports the generic GPIO framework (asm/gpio.h), | |
1034 | then you may alternatively define the two GPIOs that are to be | |
1035 | used as SCL / SDA. Any of the previous I2C_xxx macros will | |
1036 | have GPIO-based defaults assigned to them as appropriate. | |
1037 | ||
1038 | You should define these to the GPIO value as given directly to | |
1039 | the generic GPIO functions. | |
1040 | ||
bb99ad6d BW |
1041 | CONFIG_I2C_MULTI_BUS |
1042 | ||
1043 | This option allows the use of multiple I2C buses, each of which | |
c0f40859 WD |
1044 | must have a controller. At any point in time, only one bus is |
1045 | active. To switch to a different bus, use the 'i2c dev' command. | |
bb99ad6d BW |
1046 | Note that bus numbering is zero-based. |
1047 | ||
6d0f6bcf | 1048 | CONFIG_SYS_I2C_NOPROBES |
bb99ad6d BW |
1049 | |
1050 | This option specifies a list of I2C devices that will be skipped | |
c0f40859 | 1051 | when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS |
0f89c54b PT |
1052 | is set, specify a list of bus-device pairs. Otherwise, specify |
1053 | a 1D array of device addresses | |
bb99ad6d BW |
1054 | |
1055 | e.g. | |
1056 | #undef CONFIG_I2C_MULTI_BUS | |
c0f40859 | 1057 | #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} |
bb99ad6d BW |
1058 | |
1059 | will skip addresses 0x50 and 0x68 on a board with one I2C bus | |
1060 | ||
c0f40859 | 1061 | #define CONFIG_I2C_MULTI_BUS |
945a18e6 | 1062 | #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} |
bb99ad6d BW |
1063 | |
1064 | will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 | |
1065 | ||
6d0f6bcf | 1066 | CONFIG_SYS_RTC_BUS_NUM |
0dc018ec SR |
1067 | |
1068 | If defined, then this indicates the I2C bus number for the RTC. | |
1069 | If not defined, then U-Boot assumes that RTC is on I2C bus 0. | |
1070 | ||
2ac6985a AD |
1071 | CONFIG_SOFT_I2C_READ_REPEATED_START |
1072 | ||
1073 | defining this will force the i2c_read() function in | |
1074 | the soft_i2c driver to perform an I2C repeated start | |
1075 | between writing the address pointer and reading the | |
1076 | data. If this define is omitted the default behaviour | |
1077 | of doing a stop-start sequence will be used. Most I2C | |
1078 | devices can use either method, but some require one or | |
1079 | the other. | |
be5e6181 | 1080 | |
c609719b WD |
1081 | - SPI Support: CONFIG_SPI |
1082 | ||
1083 | Enables SPI driver (so far only tested with | |
1084 | SPI EEPROM, also an instance works with Crystal A/D and | |
1085 | D/As on the SACSng board) | |
1086 | ||
f659b573 HS |
1087 | CONFIG_SYS_SPI_MXC_WAIT |
1088 | Timeout for waiting until spi transfer completed. | |
1089 | default: (CONFIG_SYS_HZ/100) /* 10 ms */ | |
1090 | ||
0133502e | 1091 | - FPGA Support: CONFIG_FPGA |
c609719b | 1092 | |
0133502e MF |
1093 | Enables FPGA subsystem. |
1094 | ||
1095 | CONFIG_FPGA_<vendor> | |
1096 | ||
1097 | Enables support for specific chip vendors. | |
1098 | (ALTERA, XILINX) | |
c609719b | 1099 | |
0133502e | 1100 | CONFIG_FPGA_<family> |
c609719b | 1101 | |
0133502e MF |
1102 | Enables support for FPGA family. |
1103 | (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) | |
1104 | ||
6d0f6bcf | 1105 | CONFIG_SYS_FPGA_CHECK_BUSY |
c609719b | 1106 | |
43d9616c WD |
1107 | Enable checks on FPGA configuration interface busy |
1108 | status by the configuration function. This option | |
1109 | will require a board or device specific function to | |
1110 | be written. | |
c609719b WD |
1111 | |
1112 | CONFIG_FPGA_DELAY | |
1113 | ||
1114 | If defined, a function that provides delays in the FPGA | |
1115 | configuration driver. | |
1116 | ||
6d0f6bcf | 1117 | CONFIG_SYS_FPGA_CHECK_ERROR |
c609719b | 1118 | |
43d9616c WD |
1119 | Check for configuration errors during FPGA bitfile |
1120 | loading. For example, abort during Virtex II | |
1121 | configuration if the INIT_B line goes low (which | |
1122 | indicated a CRC error). | |
c609719b | 1123 | |
6d0f6bcf | 1124 | CONFIG_SYS_FPGA_WAIT_INIT |
c609719b | 1125 | |
b445bbb4 JM |
1126 | Maximum time to wait for the INIT_B line to de-assert |
1127 | after PROB_B has been de-asserted during a Virtex II | |
43d9616c | 1128 | FPGA configuration sequence. The default time is 500 |
11ccc33f | 1129 | ms. |
c609719b | 1130 | |
6d0f6bcf | 1131 | CONFIG_SYS_FPGA_WAIT_BUSY |
c609719b | 1132 | |
b445bbb4 | 1133 | Maximum time to wait for BUSY to de-assert during |
11ccc33f | 1134 | Virtex II FPGA configuration. The default is 5 ms. |
c609719b | 1135 | |
6d0f6bcf | 1136 | CONFIG_SYS_FPGA_WAIT_CONFIG |
c609719b | 1137 | |
43d9616c | 1138 | Time to wait after FPGA configuration. The default is |
11ccc33f | 1139 | 200 ms. |
c609719b | 1140 | |
c609719b WD |
1141 | - Vendor Parameter Protection: |
1142 | ||
43d9616c WD |
1143 | U-Boot considers the values of the environment |
1144 | variables "serial#" (Board Serial Number) and | |
7152b1d0 | 1145 | "ethaddr" (Ethernet Address) to be parameters that |
43d9616c WD |
1146 | are set once by the board vendor / manufacturer, and |
1147 | protects these variables from casual modification by | |
1148 | the user. Once set, these variables are read-only, | |
1149 | and write or delete attempts are rejected. You can | |
11ccc33f | 1150 | change this behaviour: |
c609719b WD |
1151 | |
1152 | If CONFIG_ENV_OVERWRITE is #defined in your config | |
1153 | file, the write protection for vendor parameters is | |
47cd00fa | 1154 | completely disabled. Anybody can change or delete |
c609719b WD |
1155 | these parameters. |
1156 | ||
92ac5208 JH |
1157 | Alternatively, if you define _both_ an ethaddr in the |
1158 | default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default | |
11ccc33f | 1159 | Ethernet address is installed in the environment, |
c609719b WD |
1160 | which can be changed exactly ONCE by the user. [The |
1161 | serial# is unaffected by this, i. e. it remains | |
1162 | read-only.] | |
1163 | ||
2598090b JH |
1164 | The same can be accomplished in a more flexible way |
1165 | for any variable by configuring the type of access | |
1166 | to allow for those variables in the ".flags" variable | |
1167 | or define CONFIG_ENV_FLAGS_LIST_STATIC. | |
1168 | ||
c609719b WD |
1169 | - Protected RAM: |
1170 | CONFIG_PRAM | |
1171 | ||
1172 | Define this variable to enable the reservation of | |
1173 | "protected RAM", i. e. RAM which is not overwritten | |
1174 | by U-Boot. Define CONFIG_PRAM to hold the number of | |
1175 | kB you want to reserve for pRAM. You can overwrite | |
1176 | this default value by defining an environment | |
1177 | variable "pram" to the number of kB you want to | |
1178 | reserve. Note that the board info structure will | |
1179 | still show the full amount of RAM. If pRAM is | |
1180 | reserved, a new environment variable "mem" will | |
1181 | automatically be defined to hold the amount of | |
1182 | remaining RAM in a form that can be passed as boot | |
1183 | argument to Linux, for instance like that: | |
1184 | ||
fe126d8b | 1185 | setenv bootargs ... mem=\${mem} |
c609719b WD |
1186 | saveenv |
1187 | ||
1188 | This way you can tell Linux not to use this memory, | |
1189 | either, which results in a memory region that will | |
1190 | not be affected by reboots. | |
1191 | ||
1192 | *WARNING* If your board configuration uses automatic | |
1193 | detection of the RAM size, you must make sure that | |
1194 | this memory test is non-destructive. So far, the | |
1195 | following board configurations are known to be | |
1196 | "pRAM-clean": | |
1197 | ||
5b8e76c3 | 1198 | IVMS8, IVML24, SPD8xx, |
1b0757ec | 1199 | HERMES, IP860, RPXlite, LWMON, |
2eb48ff7 | 1200 | FLAGADM |
c609719b WD |
1201 | |
1202 | - Error Recovery: | |
c609719b WD |
1203 | Note: |
1204 | ||
8bde7f77 WD |
1205 | In the current implementation, the local variables |
1206 | space and global environment variables space are | |
1207 | separated. Local variables are those you define by | |
1208 | simply typing `name=value'. To access a local | |
1209 | variable later on, you have write `$name' or | |
1210 | `${name}'; to execute the contents of a variable | |
1211 | directly type `$name' at the command prompt. | |
c609719b | 1212 | |
43d9616c WD |
1213 | Global environment variables are those you use |
1214 | setenv/printenv to work with. To run a command stored | |
1215 | in such a variable, you need to use the run command, | |
1216 | and you must not use the '$' sign to access them. | |
c609719b WD |
1217 | |
1218 | To store commands and special characters in a | |
1219 | variable, please use double quotation marks | |
1220 | surrounding the whole text of the variable, instead | |
1221 | of the backslashes before semicolons and special | |
1222 | symbols. | |
1223 | ||
a8c7c708 | 1224 | - Default Environment: |
c609719b WD |
1225 | CONFIG_EXTRA_ENV_SETTINGS |
1226 | ||
43d9616c WD |
1227 | Define this to contain any number of null terminated |
1228 | strings (variable = value pairs) that will be part of | |
7152b1d0 | 1229 | the default environment compiled into the boot image. |
2262cfee | 1230 | |
43d9616c WD |
1231 | For example, place something like this in your |
1232 | board's config file: | |
c609719b WD |
1233 | |
1234 | #define CONFIG_EXTRA_ENV_SETTINGS \ | |
1235 | "myvar1=value1\0" \ | |
1236 | "myvar2=value2\0" | |
1237 | ||
43d9616c WD |
1238 | Warning: This method is based on knowledge about the |
1239 | internal format how the environment is stored by the | |
1240 | U-Boot code. This is NOT an official, exported | |
1241 | interface! Although it is unlikely that this format | |
7152b1d0 | 1242 | will change soon, there is no guarantee either. |
c609719b WD |
1243 | You better know what you are doing here. |
1244 | ||
43d9616c WD |
1245 | Note: overly (ab)use of the default environment is |
1246 | discouraged. Make sure to check other ways to preset | |
74de7aef | 1247 | the environment like the "source" command or the |
43d9616c | 1248 | boot command first. |
c609719b | 1249 | |
06fd8538 SG |
1250 | CONFIG_DELAY_ENVIRONMENT |
1251 | ||
1252 | Normally the environment is loaded when the board is | |
b445bbb4 | 1253 | initialised so that it is available to U-Boot. This inhibits |
06fd8538 SG |
1254 | that so that the environment is not available until |
1255 | explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL | |
1256 | this is instead controlled by the value of | |
1257 | /config/load-environment. | |
1258 | ||
4cf2609b WD |
1259 | CONFIG_STANDALONE_LOAD_ADDR |
1260 | ||
6feff899 WD |
1261 | This option defines a board specific value for the |
1262 | address where standalone program gets loaded, thus | |
1263 | overwriting the architecture dependent default | |
4cf2609b WD |
1264 | settings. |
1265 | ||
cccfc2ab DZ |
1266 | - Automatic software updates via TFTP server |
1267 | CONFIG_UPDATE_TFTP | |
1268 | CONFIG_UPDATE_TFTP_CNT_MAX | |
1269 | CONFIG_UPDATE_TFTP_MSEC_MAX | |
1270 | ||
1271 | These options enable and control the auto-update feature; | |
1272 | for a more detailed description refer to doc/README.update. | |
1273 | ||
1274 | - MTD Support (mtdparts command, UBI support) | |
ff94bc40 HS |
1275 | CONFIG_MTD_UBI_WL_THRESHOLD |
1276 | This parameter defines the maximum difference between the highest | |
1277 | erase counter value and the lowest erase counter value of eraseblocks | |
1278 | of UBI devices. When this threshold is exceeded, UBI starts performing | |
1279 | wear leveling by means of moving data from eraseblock with low erase | |
1280 | counter to eraseblocks with high erase counter. | |
1281 | ||
1282 | The default value should be OK for SLC NAND flashes, NOR flashes and | |
1283 | other flashes which have eraseblock life-cycle 100000 or more. | |
1284 | However, in case of MLC NAND flashes which typically have eraseblock | |
1285 | life-cycle less than 10000, the threshold should be lessened (e.g., | |
1286 | to 128 or 256, although it does not have to be power of 2). | |
1287 | ||
1288 | default: 4096 | |
c654b517 | 1289 | |
ff94bc40 HS |
1290 | CONFIG_MTD_UBI_BEB_LIMIT |
1291 | This option specifies the maximum bad physical eraseblocks UBI | |
1292 | expects on the MTD device (per 1024 eraseblocks). If the | |
1293 | underlying flash does not admit of bad eraseblocks (e.g. NOR | |
1294 | flash), this value is ignored. | |
1295 | ||
1296 | NAND datasheets often specify the minimum and maximum NVM | |
1297 | (Number of Valid Blocks) for the flashes' endurance lifetime. | |
1298 | The maximum expected bad eraseblocks per 1024 eraseblocks | |
1299 | then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", | |
1300 | which gives 20 for most NANDs (MaxNVB is basically the total | |
1301 | count of eraseblocks on the chip). | |
1302 | ||
1303 | To put it differently, if this value is 20, UBI will try to | |
1304 | reserve about 1.9% of physical eraseblocks for bad blocks | |
1305 | handling. And that will be 1.9% of eraseblocks on the entire | |
1306 | NAND chip, not just the MTD partition UBI attaches. This means | |
1307 | that if you have, say, a NAND flash chip admits maximum 40 bad | |
1308 | eraseblocks, and it is split on two MTD partitions of the same | |
1309 | size, UBI will reserve 40 eraseblocks when attaching a | |
1310 | partition. | |
1311 | ||
1312 | default: 20 | |
1313 | ||
1314 | CONFIG_MTD_UBI_FASTMAP | |
1315 | Fastmap is a mechanism which allows attaching an UBI device | |
1316 | in nearly constant time. Instead of scanning the whole MTD device it | |
1317 | only has to locate a checkpoint (called fastmap) on the device. | |
1318 | The on-flash fastmap contains all information needed to attach | |
1319 | the device. Using fastmap makes only sense on large devices where | |
1320 | attaching by scanning takes long. UBI will not automatically install | |
1321 | a fastmap on old images, but you can set the UBI parameter | |
1322 | CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note | |
1323 | that fastmap-enabled images are still usable with UBI implementations | |
1324 | without fastmap support. On typical flash devices the whole fastmap | |
1325 | fits into one PEB. UBI will reserve PEBs to hold two fastmaps. | |
1326 | ||
1327 | CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT | |
1328 | Set this parameter to enable fastmap automatically on images | |
1329 | without a fastmap. | |
1330 | default: 0 | |
1331 | ||
0195a7bb HS |
1332 | CONFIG_MTD_UBI_FM_DEBUG |
1333 | Enable UBI fastmap debug | |
1334 | default: 0 | |
1335 | ||
6a11cf48 | 1336 | - SPL framework |
04e5ae79 WD |
1337 | CONFIG_SPL |
1338 | Enable building of SPL globally. | |
6a11cf48 | 1339 | |
8c80eb3b AA |
1340 | CONFIG_SPL_PANIC_ON_RAW_IMAGE |
1341 | When defined, SPL will panic() if the image it has | |
1342 | loaded does not have a signature. | |
1343 | Defining this is useful when code which loads images | |
1344 | in SPL cannot guarantee that absolutely all read errors | |
1345 | will be caught. | |
1346 | An example is the LPC32XX MLC NAND driver, which will | |
1347 | consider that a completely unreadable NAND block is bad, | |
1348 | and thus should be skipped silently. | |
1349 | ||
861a86f4 TR |
1350 | CONFIG_SPL_DISPLAY_PRINT |
1351 | For ARM, enable an optional function to print more information | |
1352 | about the running system. | |
1353 | ||
06f60ae3 SW |
1354 | CONFIG_SPL_MPC83XX_WAIT_FOR_NAND |
1355 | Set this for NAND SPL on PPC mpc83xx targets, so that | |
1356 | start.S waits for the rest of the SPL to load before | |
1357 | continuing (the hardware starts execution after just | |
1358 | loading the first page rather than the full 4K). | |
1359 | ||
6f4e7d3c TG |
1360 | CONFIG_SPL_UBI |
1361 | Support for a lightweight UBI (fastmap) scanner and | |
1362 | loader | |
1363 | ||
95579793 TR |
1364 | CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, |
1365 | CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, | |
1366 | CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, | |
1367 | CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, | |
1368 | CONFIG_SYS_NAND_ECCBYTES | |
1369 | Defines the size and behavior of the NAND that SPL uses | |
7d4b7955 | 1370 | to read U-Boot |
95579793 | 1371 | |
7d4b7955 SW |
1372 | CONFIG_SYS_NAND_U_BOOT_DST |
1373 | Location in memory to load U-Boot to | |
1374 | ||
1375 | CONFIG_SYS_NAND_U_BOOT_SIZE | |
1376 | Size of image to load | |
95579793 TR |
1377 | |
1378 | CONFIG_SYS_NAND_U_BOOT_START | |
7d4b7955 | 1379 | Entry point in loaded image to jump to |
95579793 TR |
1380 | |
1381 | CONFIG_SYS_NAND_HW_ECC_OOBFIRST | |
1382 | Define this if you need to first read the OOB and then the | |
b445bbb4 | 1383 | data. This is used, for example, on davinci platforms. |
95579793 | 1384 | |
c57b953d PM |
1385 | CONFIG_SPL_RAM_DEVICE |
1386 | Support for running image already present in ram, in SPL binary | |
6a11cf48 | 1387 | |
b527b9c6 | 1388 | CONFIG_SPL_FIT_PRINT |
87ebee39 SG |
1389 | Printing information about a FIT image adds quite a bit of |
1390 | code to SPL. So this is normally disabled in SPL. Use this | |
1391 | option to re-enable it. This will affect the output of the | |
1392 | bootm command when booting a FIT image. | |
1393 | ||
a8c7c708 WD |
1394 | - Interrupt support (PPC): |
1395 | ||
d4ca31c4 WD |
1396 | There are common interrupt_init() and timer_interrupt() |
1397 | for all PPC archs. interrupt_init() calls interrupt_init_cpu() | |
11ccc33f | 1398 | for CPU specific initialization. interrupt_init_cpu() |
d4ca31c4 | 1399 | should set decrementer_count to appropriate value. If |
11ccc33f | 1400 | CPU resets decrementer automatically after interrupt |
d4ca31c4 | 1401 | (ppc4xx) it should set decrementer_count to zero. |
11ccc33f | 1402 | timer_interrupt() calls timer_interrupt_cpu() for CPU |
d4ca31c4 WD |
1403 | specific handling. If board has watchdog / status_led |
1404 | / other_activity_monitor it works automatically from | |
1405 | general timer_interrupt(). | |
a8c7c708 | 1406 | |
c609719b | 1407 | |
9660e442 HR |
1408 | Board initialization settings: |
1409 | ------------------------------ | |
1410 | ||
1411 | During Initialization u-boot calls a number of board specific functions | |
1412 | to allow the preparation of board specific prerequisites, e.g. pin setup | |
1413 | before drivers are initialized. To enable these callbacks the | |
1414 | following configuration macros have to be defined. Currently this is | |
1415 | architecture specific, so please check arch/your_architecture/lib/board.c | |
1416 | typically in board_init_f() and board_init_r(). | |
1417 | ||
1418 | - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() | |
1419 | - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() | |
1420 | - CONFIG_BOARD_LATE_INIT: Call board_late_init() | |
c609719b | 1421 | |
c609719b WD |
1422 | Configuration Settings: |
1423 | ----------------------- | |
1424 | ||
4d979bfd | 1425 | - MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. |
4d1fd7f1 YS |
1426 | Optionally it can be defined to support 64-bit memory commands. |
1427 | ||
6d0f6bcf | 1428 | - CONFIG_SYS_LONGHELP: Defined when you want long help messages included; |
c609719b WD |
1429 | undefine this when you're short of memory. |
1430 | ||
2fb2604d PT |
1431 | - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default |
1432 | width of the commands listed in the 'help' command output. | |
1433 | ||
6d0f6bcf | 1434 | - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to |
c609719b WD |
1435 | prompt for user input. |
1436 | ||
6d0f6bcf | 1437 | - CONFIG_SYS_BAUDRATE_TABLE: |
c609719b WD |
1438 | List of legal baudrate settings for this board. |
1439 | ||
e8149522 | 1440 | - CONFIG_SYS_MEM_RESERVE_SECURE |
e61a7534 | 1441 | Only implemented for ARMv8 for now. |
e8149522 YS |
1442 | If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory |
1443 | is substracted from total RAM and won't be reported to OS. | |
1444 | This memory can be used as secure memory. A variable | |
e61a7534 | 1445 | gd->arch.secure_ram is used to track the location. In systems |
e8149522 YS |
1446 | the RAM base is not zero, or RAM is divided into banks, |
1447 | this variable needs to be recalcuated to get the address. | |
1448 | ||
6d0f6bcf | 1449 | - CONFIG_SYS_SDRAM_BASE: |
c609719b WD |
1450 | Physical start address of SDRAM. _Must_ be 0 here. |
1451 | ||
6d0f6bcf | 1452 | - CONFIG_SYS_FLASH_BASE: |
c609719b WD |
1453 | Physical start address of Flash memory. |
1454 | ||
6d0f6bcf | 1455 | - CONFIG_SYS_MALLOC_LEN: |
c609719b WD |
1456 | Size of DRAM reserved for malloc() use. |
1457 | ||
d59476b6 SG |
1458 | - CONFIG_SYS_MALLOC_F_LEN |
1459 | Size of the malloc() pool for use before relocation. If | |
1460 | this is defined, then a very simple malloc() implementation | |
1461 | will become available before relocation. The address is just | |
1462 | below the global data, and the stack is moved down to make | |
1463 | space. | |
1464 | ||
1465 | This feature allocates regions with increasing addresses | |
1466 | within the region. calloc() is supported, but realloc() | |
1467 | is not available. free() is supported but does nothing. | |
b445bbb4 | 1468 | The memory will be freed (or in fact just forgotten) when |
d59476b6 SG |
1469 | U-Boot relocates itself. |
1470 | ||
38687ae6 SG |
1471 | - CONFIG_SYS_MALLOC_SIMPLE |
1472 | Provides a simple and small malloc() and calloc() for those | |
1473 | boards which do not use the full malloc in SPL (which is | |
10f6e4dc | 1474 | enabled with CONFIG_SYS_SPL_MALLOC). |
38687ae6 | 1475 | |
6d0f6bcf | 1476 | - CONFIG_SYS_BOOTMAPSZ: |
c609719b WD |
1477 | Maximum size of memory mapped by the startup code of |
1478 | the Linux kernel; all data that must be processed by | |
7d721e34 BS |
1479 | the Linux kernel (bd_info, boot arguments, FDT blob if |
1480 | used) must be put below this limit, unless "bootm_low" | |
1bce2aeb | 1481 | environment variable is defined and non-zero. In such case |
7d721e34 | 1482 | all data for the Linux kernel must be between "bootm_low" |
c0f40859 | 1483 | and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment |
c3624e6e GL |
1484 | variable "bootm_mapsize" will override the value of |
1485 | CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, | |
1486 | then the value in "bootm_size" will be used instead. | |
c609719b | 1487 | |
fca43cc8 JR |
1488 | - CONFIG_SYS_BOOT_GET_CMDLINE: |
1489 | Enables allocating and saving kernel cmdline in space between | |
1490 | "bootm_low" and "bootm_low" + BOOTMAPSZ. | |
1491 | ||
1492 | - CONFIG_SYS_BOOT_GET_KBD: | |
1493 | Enables allocating and saving a kernel copy of the bd_info in | |
1494 | space between "bootm_low" and "bootm_low" + BOOTMAPSZ. | |
1495 | ||
6d0f6bcf | 1496 | - CONFIG_SYS_FLASH_PROTECTION |
8564acf9 WD |
1497 | If defined, hardware flash sectors protection is used |
1498 | instead of U-Boot software protection. | |
1499 | ||
6d0f6bcf | 1500 | - CONFIG_SYS_FLASH_CFI: |
43d9616c | 1501 | Define if the flash driver uses extra elements in the |
5653fc33 WD |
1502 | common flash structure for storing flash geometry. |
1503 | ||
00b1883a | 1504 | - CONFIG_FLASH_CFI_DRIVER |
5653fc33 WD |
1505 | This option also enables the building of the cfi_flash driver |
1506 | in the drivers directory | |
c609719b | 1507 | |
91809ed5 PZ |
1508 | - CONFIG_FLASH_CFI_MTD |
1509 | This option enables the building of the cfi_mtd driver | |
1510 | in the drivers directory. The driver exports CFI flash | |
1511 | to the MTD layer. | |
1512 | ||
6d0f6bcf | 1513 | - CONFIG_SYS_FLASH_USE_BUFFER_WRITE |
96ef831f GL |
1514 | Use buffered writes to flash. |
1515 | ||
1516 | - CONFIG_FLASH_SPANSION_S29WS_N | |
1517 | s29ws-n MirrorBit flash has non-standard addresses for buffered | |
1518 | write commands. | |
1519 | ||
9a042e9c JVB |
1520 | - CONFIG_FLASH_SHOW_PROGRESS |
1521 | If defined (must be an integer), print out countdown | |
1522 | digits and dots. Recommended value: 45 (9..1) for 80 | |
1523 | column displays, 15 (3..1) for 40 column displays. | |
1524 | ||
352ef3f1 SR |
1525 | - CONFIG_FLASH_VERIFY |
1526 | If defined, the content of the flash (destination) is compared | |
1527 | against the source after the write operation. An error message | |
1528 | will be printed when the contents are not identical. | |
1529 | Please note that this option is useless in nearly all cases, | |
1530 | since such flash programming errors usually are detected earlier | |
1531 | while unprotecting/erasing/programming. Please only enable | |
1532 | this option if you really know what you are doing. | |
1533 | ||
2598090b JH |
1534 | - CONFIG_ENV_FLAGS_LIST_DEFAULT |
1535 | - CONFIG_ENV_FLAGS_LIST_STATIC | |
1bce2aeb | 1536 | Enable validation of the values given to environment variables when |
2598090b JH |
1537 | calling env set. Variables can be restricted to only decimal, |
1538 | hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, | |
1539 | the variables can also be restricted to IP address or MAC address. | |
1540 | ||
1541 | The format of the list is: | |
1542 | type_attribute = [s|d|x|b|i|m] | |
b445bbb4 JM |
1543 | access_attribute = [a|r|o|c] |
1544 | attributes = type_attribute[access_attribute] | |
2598090b JH |
1545 | entry = variable_name[:attributes] |
1546 | list = entry[,list] | |
1547 | ||
1548 | The type attributes are: | |
1549 | s - String (default) | |
1550 | d - Decimal | |
1551 | x - Hexadecimal | |
1552 | b - Boolean ([1yYtT|0nNfF]) | |
1553 | i - IP address | |
1554 | m - MAC address | |
1555 | ||
267541f7 JH |
1556 | The access attributes are: |
1557 | a - Any (default) | |
1558 | r - Read-only | |
1559 | o - Write-once | |
1560 | c - Change-default | |
1561 | ||
2598090b JH |
1562 | - CONFIG_ENV_FLAGS_LIST_DEFAULT |
1563 | Define this to a list (string) to define the ".flags" | |
b445bbb4 | 1564 | environment variable in the default or embedded environment. |
2598090b JH |
1565 | |
1566 | - CONFIG_ENV_FLAGS_LIST_STATIC | |
1567 | Define this to a list (string) to define validation that | |
1568 | should be done if an entry is not found in the ".flags" | |
1569 | environment variable. To override a setting in the static | |
1570 | list, simply add an entry for the same variable name to the | |
1571 | ".flags" variable. | |
1572 | ||
bdf1fe4e JH |
1573 | If CONFIG_REGEX is defined, the variable_name above is evaluated as a |
1574 | regular expression. This allows multiple variables to define the same | |
1575 | flags without explicitly listing them for each variable. | |
1576 | ||
c609719b WD |
1577 | The following definitions that deal with the placement and management |
1578 | of environment data (variable area); in general, we support the | |
1579 | following configurations: | |
1580 | ||
c3eb3fe4 MF |
1581 | - CONFIG_BUILD_ENVCRC: |
1582 | ||
1583 | Builds up envcrc with the target environment so that external utils | |
1584 | may easily extract it and embed it in final U-Boot images. | |
1585 | ||
c609719b | 1586 | BE CAREFUL! The first access to the environment happens quite early |
b445bbb4 | 1587 | in U-Boot initialization (when we try to get the setting of for the |
11ccc33f | 1588 | console baudrate). You *MUST* have mapped your NVRAM area then, or |
c609719b WD |
1589 | U-Boot will hang. |
1590 | ||
1591 | Please note that even with NVRAM we still use a copy of the | |
1592 | environment in RAM: we could work on NVRAM directly, but we want to | |
1593 | keep settings there always unmodified except somebody uses "saveenv" | |
1594 | to save the current settings. | |
1595 | ||
0a85a9e7 LG |
1596 | BE CAREFUL! For some special cases, the local device can not use |
1597 | "saveenv" command. For example, the local device will get the | |
fc54c7fa LG |
1598 | environment stored in a remote NOR flash by SRIO or PCIE link, |
1599 | but it can not erase, write this NOR flash by SRIO or PCIE interface. | |
0a85a9e7 | 1600 | |
b74ab737 GL |
1601 | - CONFIG_NAND_ENV_DST |
1602 | ||
1603 | Defines address in RAM to which the nand_spl code should copy the | |
1604 | environment. If redundant environment is used, it will be copied to | |
1605 | CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. | |
1606 | ||
e881cb56 | 1607 | Please note that the environment is read-only until the monitor |
c609719b | 1608 | has been relocated to RAM and a RAM copy of the environment has been |
00caae6d | 1609 | created; also, when using EEPROM you will have to use env_get_f() |
c609719b WD |
1610 | until then to read environment variables. |
1611 | ||
85ec0bcc WD |
1612 | The environment is protected by a CRC32 checksum. Before the monitor |
1613 | is relocated into RAM, as a result of a bad CRC you will be working | |
1614 | with the compiled-in default environment - *silently*!!! [This is | |
1615 | necessary, because the first environment variable we need is the | |
1616 | "baudrate" setting for the console - if we have a bad CRC, we don't | |
1617 | have any device yet where we could complain.] | |
c609719b WD |
1618 | |
1619 | Note: once the monitor has been relocated, then it will complain if | |
1620 | the default environment is used; a new CRC is computed as soon as you | |
85ec0bcc | 1621 | use the "saveenv" command to store a valid environment. |
c609719b | 1622 | |
6d0f6bcf | 1623 | - CONFIG_SYS_FAULT_MII_ADDR: |
42d1f039 | 1624 | MII address of the PHY to check for the Ethernet link state. |
c609719b | 1625 | |
f5675aa5 RM |
1626 | - CONFIG_NS16550_MIN_FUNCTIONS: |
1627 | Define this if you desire to only have use of the NS16550_init | |
1628 | and NS16550_putc functions for the serial driver located at | |
1629 | drivers/serial/ns16550.c. This option is useful for saving | |
1630 | space for already greatly restricted images, including but not | |
1631 | limited to NAND_SPL configurations. | |
1632 | ||
b2b92f53 SG |
1633 | - CONFIG_DISPLAY_BOARDINFO |
1634 | Display information about the board that U-Boot is running on | |
1635 | when U-Boot starts up. The board function checkboard() is called | |
1636 | to do this. | |
1637 | ||
e2e3e2b1 SG |
1638 | - CONFIG_DISPLAY_BOARDINFO_LATE |
1639 | Similar to the previous option, but display this information | |
1640 | later, once stdio is running and output goes to the LCD, if | |
1641 | present. | |
1642 | ||
c609719b | 1643 | Low Level (hardware related) configuration options: |
dc7c9a1a | 1644 | --------------------------------------------------- |
c609719b | 1645 | |
6d0f6bcf | 1646 | - CONFIG_SYS_CACHELINE_SIZE: |
c609719b WD |
1647 | Cache Line Size of the CPU. |
1648 | ||
e46fedfe TT |
1649 | - CONFIG_SYS_CCSRBAR_DEFAULT: |
1650 | Default (power-on reset) physical address of CCSR on Freescale | |
1651 | PowerPC SOCs. | |
1652 | ||
1653 | - CONFIG_SYS_CCSRBAR: | |
1654 | Virtual address of CCSR. On a 32-bit build, this is typically | |
1655 | the same value as CONFIG_SYS_CCSRBAR_DEFAULT. | |
1656 | ||
e46fedfe TT |
1657 | - CONFIG_SYS_CCSRBAR_PHYS: |
1658 | Physical address of CCSR. CCSR can be relocated to a new | |
1659 | physical address, if desired. In this case, this macro should | |
c0f40859 | 1660 | be set to that address. Otherwise, it should be set to the |
e46fedfe TT |
1661 | same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR |
1662 | is typically relocated on 36-bit builds. It is recommended | |
1663 | that this macro be defined via the _HIGH and _LOW macros: | |
1664 | ||
1665 | #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH | |
1666 | * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) | |
1667 | ||
1668 | - CONFIG_SYS_CCSRBAR_PHYS_HIGH: | |
4cf2609b WD |
1669 | Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically |
1670 | either 0 (32-bit build) or 0xF (36-bit build). This macro is | |
e46fedfe TT |
1671 | used in assembly code, so it must not contain typecasts or |
1672 | integer size suffixes (e.g. "ULL"). | |
1673 | ||
1674 | - CONFIG_SYS_CCSRBAR_PHYS_LOW: | |
1675 | Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is | |
1676 | used in assembly code, so it must not contain typecasts or | |
1677 | integer size suffixes (e.g. "ULL"). | |
1678 | ||
6d0f6bcf | 1679 | - CONFIG_SYS_IMMR: Physical address of the Internal Memory. |
efe2a4d5 | 1680 | DO NOT CHANGE unless you know exactly what you're |
907208c4 | 1681 | doing! (11-4) [MPC8xx systems only] |
c609719b | 1682 | |
6d0f6bcf | 1683 | - CONFIG_SYS_INIT_RAM_ADDR: |
c609719b | 1684 | |
7152b1d0 | 1685 | Start address of memory area that can be used for |
c609719b WD |
1686 | initial data and stack; please note that this must be |
1687 | writable memory that is working WITHOUT special | |
1688 | initialization, i. e. you CANNOT use normal RAM which | |
1689 | will become available only after programming the | |
1690 | memory controller and running certain initialization | |
1691 | sequences. | |
1692 | ||
1693 | U-Boot uses the following memory types: | |
907208c4 | 1694 | - MPC8xx: IMMR (internal memory of the CPU) |
c609719b | 1695 | |
6d0f6bcf | 1696 | - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) |
c609719b | 1697 | |
6d0f6bcf | 1698 | - CONFIG_SYS_OR_TIMING_SDRAM: |
c609719b WD |
1699 | SDRAM timing |
1700 | ||
a09b9b68 KG |
1701 | - CONFIG_SYS_SRIO: |
1702 | Chip has SRIO or not | |
1703 | ||
1704 | - CONFIG_SRIO1: | |
1705 | Board has SRIO 1 port available | |
1706 | ||
1707 | - CONFIG_SRIO2: | |
1708 | Board has SRIO 2 port available | |
1709 | ||
c8b28152 LG |
1710 | - CONFIG_SRIO_PCIE_BOOT_MASTER |
1711 | Board can support master function for Boot from SRIO and PCIE | |
1712 | ||
a09b9b68 KG |
1713 | - CONFIG_SYS_SRIOn_MEM_VIRT: |
1714 | Virtual Address of SRIO port 'n' memory region | |
1715 | ||
62f9b654 | 1716 | - CONFIG_SYS_SRIOn_MEM_PHYxS: |
a09b9b68 KG |
1717 | Physical Address of SRIO port 'n' memory region |
1718 | ||
1719 | - CONFIG_SYS_SRIOn_MEM_SIZE: | |
1720 | Size of SRIO port 'n' memory region | |
1721 | ||
66bd1846 FE |
1722 | - CONFIG_SYS_NAND_BUSWIDTH_16BIT |
1723 | Defined to tell the NAND controller that the NAND chip is using | |
1724 | a 16 bit bus. | |
1725 | Not all NAND drivers use this symbol. | |
a430e916 | 1726 | Example of drivers that use it: |
a430fa06 MR |
1727 | - drivers/mtd/nand/raw/ndfc.c |
1728 | - drivers/mtd/nand/raw/mxc_nand.c | |
eced4626 AW |
1729 | |
1730 | - CONFIG_SYS_NDFC_EBC0_CFG | |
1731 | Sets the EBC0_CFG register for the NDFC. If not defined | |
1732 | a default value will be used. | |
1733 | ||
bb99ad6d | 1734 | - CONFIG_SPD_EEPROM |
218ca724 WD |
1735 | Get DDR timing information from an I2C EEPROM. Common |
1736 | with pluggable memory modules such as SODIMMs | |
1737 | ||
bb99ad6d BW |
1738 | SPD_EEPROM_ADDRESS |
1739 | I2C address of the SPD EEPROM | |
1740 | ||
6d0f6bcf | 1741 | - CONFIG_SYS_SPD_BUS_NUM |
218ca724 WD |
1742 | If SPD EEPROM is on an I2C bus other than the first |
1743 | one, specify here. Note that the value must resolve | |
1744 | to something your driver can deal with. | |
bb99ad6d | 1745 | |
6f5e1dc5 YS |
1746 | - CONFIG_FSL_DDR_INTERACTIVE |
1747 | Enable interactive DDR debugging. See doc/README.fsl-ddr. | |
1748 | ||
e32d59a2 YS |
1749 | - CONFIG_FSL_DDR_SYNC_REFRESH |
1750 | Enable sync of refresh for multiple controllers. | |
1751 | ||
4516ff81 YS |
1752 | - CONFIG_FSL_DDR_BIST |
1753 | Enable built-in memory test for Freescale DDR controllers. | |
1754 | ||
c26e454d WD |
1755 | - CONFIG_RMII |
1756 | Enable RMII mode for all FECs. | |
1757 | Note that this is a global option, we can't | |
1758 | have one FEC in standard MII mode and another in RMII mode. | |
1759 | ||
5cf91d6b WD |
1760 | - CONFIG_CRC32_VERIFY |
1761 | Add a verify option to the crc32 command. | |
1762 | The syntax is: | |
1763 | ||
1764 | => crc32 -v <address> <count> <crc32> | |
1765 | ||
1766 | Where address/count indicate a memory area | |
1767 | and crc32 is the correct crc32 which the | |
1768 | area should have. | |
1769 | ||
56523f12 WD |
1770 | - CONFIG_LOOPW |
1771 | Add the "loopw" memory command. This only takes effect if | |
493f420e | 1772 | the memory commands are activated globally (CONFIG_CMD_MEMORY). |
56523f12 | 1773 | |
72732318 | 1774 | - CONFIG_CMD_MX_CYCLIC |
7b466641 SR |
1775 | Add the "mdc" and "mwc" memory commands. These are cyclic |
1776 | "md/mw" commands. | |
1777 | Examples: | |
1778 | ||
efe2a4d5 | 1779 | => mdc.b 10 4 500 |
7b466641 SR |
1780 | This command will print 4 bytes (10,11,12,13) each 500 ms. |
1781 | ||
efe2a4d5 | 1782 | => mwc.l 100 12345678 10 |
7b466641 SR |
1783 | This command will write 12345678 to address 100 all 10 ms. |
1784 | ||
efe2a4d5 | 1785 | This only takes effect if the memory commands are activated |
493f420e | 1786 | globally (CONFIG_CMD_MEMORY). |
7b466641 | 1787 | |
401bb30b | 1788 | - CONFIG_SPL_BUILD |
32f2ca2a TH |
1789 | Set when the currently-running compilation is for an artifact |
1790 | that will end up in the SPL (as opposed to the TPL or U-Boot | |
1791 | proper). Code that needs stage-specific behavior should check | |
1792 | this. | |
400558b5 | 1793 | |
3aa29de0 | 1794 | - CONFIG_TPL_BUILD |
32f2ca2a TH |
1795 | Set when the currently-running compilation is for an artifact |
1796 | that will end up in the TPL (as opposed to the SPL or U-Boot | |
1797 | proper). Code that needs stage-specific behavior should check | |
1798 | this. | |
3aa29de0 | 1799 | |
4213fc29 SG |
1800 | - CONFIG_ARCH_MAP_SYSMEM |
1801 | Generally U-Boot (and in particular the md command) uses | |
1802 | effective address. It is therefore not necessary to regard | |
1803 | U-Boot address as virtual addresses that need to be translated | |
1804 | to physical addresses. However, sandbox requires this, since | |
1805 | it maintains its own little RAM buffer which contains all | |
1806 | addressable memory. This option causes some memory accesses | |
1807 | to be mapped through map_sysmem() / unmap_sysmem(). | |
1808 | ||
588a13f7 SG |
1809 | - CONFIG_X86_RESET_VECTOR |
1810 | If defined, the x86 reset vector code is included. This is not | |
1811 | needed when U-Boot is running from Coreboot. | |
b16f521a | 1812 | |
999d7d32 KM |
1813 | - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE |
1814 | Option to disable subpage write in NAND driver | |
1815 | driver that uses this: | |
a430fa06 | 1816 | drivers/mtd/nand/raw/davinci_nand.c |
999d7d32 | 1817 | |
f2717b47 TT |
1818 | Freescale QE/FMAN Firmware Support: |
1819 | ----------------------------------- | |
1820 | ||
1821 | The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the | |
1822 | loading of "firmware", which is encoded in the QE firmware binary format. | |
1823 | This firmware often needs to be loaded during U-Boot booting, so macros | |
1824 | are used to identify the storage device (NOR flash, SPI, etc) and the address | |
1825 | within that device. | |
1826 | ||
dcf1d774 ZQ |
1827 | - CONFIG_SYS_FMAN_FW_ADDR |
1828 | The address in the storage device where the FMAN microcode is located. The | |
cc1e98b5 | 1829 | meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro |
dcf1d774 ZQ |
1830 | is also specified. |
1831 | ||
1832 | - CONFIG_SYS_QE_FW_ADDR | |
1833 | The address in the storage device where the QE microcode is located. The | |
cc1e98b5 | 1834 | meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro |
f2717b47 TT |
1835 | is also specified. |
1836 | ||
1837 | - CONFIG_SYS_QE_FMAN_FW_LENGTH | |
1838 | The maximum possible size of the firmware. The firmware binary format | |
1839 | has a field that specifies the actual size of the firmware, but it | |
1840 | might not be possible to read any part of the firmware unless some | |
1841 | local storage is allocated to hold the entire firmware first. | |
1842 | ||
1843 | - CONFIG_SYS_QE_FMAN_FW_IN_NOR | |
1844 | Specifies that QE/FMAN firmware is located in NOR flash, mapped as | |
1845 | normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the | |
1846 | virtual address in NOR flash. | |
1847 | ||
1848 | - CONFIG_SYS_QE_FMAN_FW_IN_NAND | |
1849 | Specifies that QE/FMAN firmware is located in NAND flash. | |
1850 | CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. | |
1851 | ||
1852 | - CONFIG_SYS_QE_FMAN_FW_IN_MMC | |
1853 | Specifies that QE/FMAN firmware is located on the primary SD/MMC | |
1854 | device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. | |
1855 | ||
292dc6c5 LG |
1856 | - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE |
1857 | Specifies that QE/FMAN firmware is located in the remote (master) | |
1858 | memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which | |
fc54c7fa LG |
1859 | can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound |
1860 | window->master inbound window->master LAW->the ucode address in | |
1861 | master's memory space. | |
f2717b47 | 1862 | |
b940ca64 GR |
1863 | Freescale Layerscape Management Complex Firmware Support: |
1864 | --------------------------------------------------------- | |
1865 | The Freescale Layerscape Management Complex (MC) supports the loading of | |
1866 | "firmware". | |
1867 | This firmware often needs to be loaded during U-Boot booting, so macros | |
1868 | are used to identify the storage device (NOR flash, SPI, etc) and the address | |
1869 | within that device. | |
1870 | ||
1871 | - CONFIG_FSL_MC_ENET | |
1872 | Enable the MC driver for Layerscape SoCs. | |
1873 | ||
5c055089 PK |
1874 | Freescale Layerscape Debug Server Support: |
1875 | ------------------------------------------- | |
1876 | The Freescale Layerscape Debug Server Support supports the loading of | |
1877 | "Debug Server firmware" and triggering SP boot-rom. | |
1878 | This firmware often needs to be loaded during U-Boot booting. | |
1879 | ||
c0492141 YS |
1880 | - CONFIG_SYS_MC_RSV_MEM_ALIGN |
1881 | Define alignment of reserved memory MC requires | |
5c055089 | 1882 | |
f3f431a7 PK |
1883 | Reproducible builds |
1884 | ------------------- | |
1885 | ||
1886 | In order to achieve reproducible builds, timestamps used in the U-Boot build | |
1887 | process have to be set to a fixed value. | |
1888 | ||
1889 | This is done using the SOURCE_DATE_EPOCH environment variable. | |
1890 | SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration | |
1891 | option for U-Boot or an environment variable in U-Boot. | |
1892 | ||
1893 | SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. | |
1894 | ||
c609719b WD |
1895 | Building the Software: |
1896 | ====================== | |
1897 | ||
218ca724 WD |
1898 | Building U-Boot has been tested in several native build environments |
1899 | and in many different cross environments. Of course we cannot support | |
1900 | all possibly existing versions of cross development tools in all | |
1901 | (potentially obsolete) versions. In case of tool chain problems we | |
047f6ec0 | 1902 | recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK) |
218ca724 | 1903 | which is extensively used to build and test U-Boot. |
c609719b | 1904 | |
218ca724 WD |
1905 | If you are not using a native environment, it is assumed that you |
1906 | have GNU cross compiling tools available in your path. In this case, | |
1907 | you must set the environment variable CROSS_COMPILE in your shell. | |
1908 | Note that no changes to the Makefile or any other source files are | |
1909 | necessary. For example using the ELDK on a 4xx CPU, please enter: | |
c609719b | 1910 | |
218ca724 WD |
1911 | $ CROSS_COMPILE=ppc_4xx- |
1912 | $ export CROSS_COMPILE | |
c609719b | 1913 | |
218ca724 WD |
1914 | U-Boot is intended to be simple to build. After installing the |
1915 | sources you must configure U-Boot for one specific board type. This | |
c609719b WD |
1916 | is done by typing: |
1917 | ||
ab584d67 | 1918 | make NAME_defconfig |
c609719b | 1919 | |
ab584d67 | 1920 | where "NAME_defconfig" is the name of one of the existing configu- |
ecb3a0a1 | 1921 | rations; see configs/*_defconfig for supported names. |
db01a2ea | 1922 | |
ecb3a0a1 | 1923 | Note: for some boards special configuration names may exist; check if |
2729af9d WD |
1924 | additional information is available from the board vendor; for |
1925 | instance, the TQM823L systems are available without (standard) | |
1926 | or with LCD support. You can select such additional "features" | |
11ccc33f | 1927 | when choosing the configuration, i. e. |
2729af9d | 1928 | |
ab584d67 | 1929 | make TQM823L_defconfig |
2729af9d WD |
1930 | - will configure for a plain TQM823L, i. e. no LCD support |
1931 | ||
ab584d67 | 1932 | make TQM823L_LCD_defconfig |
2729af9d WD |
1933 | - will configure for a TQM823L with U-Boot console on LCD |
1934 | ||
1935 | etc. | |
1936 | ||
1937 | ||
1938 | Finally, type "make all", and you should get some working U-Boot | |
1939 | images ready for download to / installation on your system: | |
1940 | ||
1941 | - "u-boot.bin" is a raw binary image | |
1942 | - "u-boot" is an image in ELF binary format | |
1943 | - "u-boot.srec" is in Motorola S-Record format | |
1944 | ||
baf31249 MB |
1945 | By default the build is performed locally and the objects are saved |
1946 | in the source directory. One of the two methods can be used to change | |
1947 | this behavior and build U-Boot to some external directory: | |
1948 | ||
1949 | 1. Add O= to the make command line invocations: | |
1950 | ||
1951 | make O=/tmp/build distclean | |
ab584d67 | 1952 | make O=/tmp/build NAME_defconfig |
baf31249 MB |
1953 | make O=/tmp/build all |
1954 | ||
adbba996 | 1955 | 2. Set environment variable KBUILD_OUTPUT to point to the desired location: |
baf31249 | 1956 | |
adbba996 | 1957 | export KBUILD_OUTPUT=/tmp/build |
baf31249 | 1958 | make distclean |
ab584d67 | 1959 | make NAME_defconfig |
baf31249 MB |
1960 | make all |
1961 | ||
adbba996 | 1962 | Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment |
baf31249 MB |
1963 | variable. |
1964 | ||
215bb1c1 DS |
1965 | User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by |
1966 | setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS. | |
1967 | For example to treat all compiler warnings as errors: | |
1968 | ||
1969 | make KCFLAGS=-Werror | |
2729af9d WD |
1970 | |
1971 | Please be aware that the Makefiles assume you are using GNU make, so | |
1972 | for instance on NetBSD you might need to use "gmake" instead of | |
1973 | native "make". | |
1974 | ||
1975 | ||
1976 | If the system board that you have is not listed, then you will need | |
1977 | to port U-Boot to your hardware platform. To do this, follow these | |
1978 | steps: | |
1979 | ||
3c1496cd | 1980 | 1. Create a new directory to hold your board specific code. Add any |
2729af9d | 1981 | files you need. In your board directory, you will need at least |
3c1496cd PS |
1982 | the "Makefile" and a "<board>.c". |
1983 | 2. Create a new configuration file "include/configs/<board>.h" for | |
1984 | your board. | |
2729af9d WD |
1985 | 3. If you're porting U-Boot to a new CPU, then also create a new |
1986 | directory to hold your CPU specific code. Add any files you need. | |
ab584d67 | 1987 | 4. Run "make <board>_defconfig" with your new name. |
2729af9d WD |
1988 | 5. Type "make", and you should get a working "u-boot.srec" file |
1989 | to be installed on your target system. | |
1990 | 6. Debug and solve any problems that might arise. | |
1991 | [Of course, this last step is much harder than it sounds.] | |
1992 | ||
1993 | ||
1994 | Testing of U-Boot Modifications, Ports to New Hardware, etc.: | |
1995 | ============================================================== | |
1996 | ||
218ca724 WD |
1997 | If you have modified U-Boot sources (for instance added a new board |
1998 | or support for new devices, a new CPU, etc.) you are expected to | |
2729af9d | 1999 | provide feedback to the other developers. The feedback normally takes |
32f2ca2a | 2000 | the form of a "patch", i.e. a context diff against a certain (latest |
218ca724 | 2001 | official or latest in the git repository) version of U-Boot sources. |
2729af9d | 2002 | |
218ca724 WD |
2003 | But before you submit such a patch, please verify that your modifi- |
2004 | cation did not break existing code. At least make sure that *ALL* of | |
2729af9d | 2005 | the supported boards compile WITHOUT ANY compiler warnings. To do so, |
6de80f21 SG |
2006 | just run the buildman script (tools/buildman/buildman), which will |
2007 | configure and build U-Boot for ALL supported system. Be warned, this | |
2008 | will take a while. Please see the buildman README, or run 'buildman -H' | |
2009 | for documentation. | |
baf31249 MB |
2010 | |
2011 | ||
2729af9d WD |
2012 | See also "U-Boot Porting Guide" below. |
2013 | ||
2014 | ||
2015 | Monitor Commands - Overview: | |
2016 | ============================ | |
2017 | ||
2018 | go - start application at address 'addr' | |
2019 | run - run commands in an environment variable | |
2020 | bootm - boot application image from memory | |
2021 | bootp - boot image via network using BootP/TFTP protocol | |
44f074c7 | 2022 | bootz - boot zImage from memory |
2729af9d WD |
2023 | tftpboot- boot image via network using TFTP protocol |
2024 | and env variables "ipaddr" and "serverip" | |
2025 | (and eventually "gatewayip") | |
1fb7cd49 | 2026 | tftpput - upload a file via network using TFTP protocol |
2729af9d WD |
2027 | rarpboot- boot image via network using RARP/TFTP protocol |
2028 | diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' | |
2029 | loads - load S-Record file over serial line | |
2030 | loadb - load binary file over serial line (kermit mode) | |
bfef72e4 | 2031 | loadm - load binary blob from source address to destination address |
2729af9d WD |
2032 | md - memory display |
2033 | mm - memory modify (auto-incrementing) | |
2034 | nm - memory modify (constant address) | |
2035 | mw - memory write (fill) | |
bdded201 | 2036 | ms - memory search |
2729af9d WD |
2037 | cp - memory copy |
2038 | cmp - memory compare | |
2039 | crc32 - checksum calculation | |
0f89c54b | 2040 | i2c - I2C sub-system |
2729af9d WD |
2041 | sspi - SPI utility commands |
2042 | base - print or set address offset | |
2043 | printenv- print environment variables | |
9e9a530a | 2044 | pwm - control pwm channels |
2729af9d WD |
2045 | setenv - set environment variables |
2046 | saveenv - save environment variables to persistent storage | |
2047 | protect - enable or disable FLASH write protection | |
2048 | erase - erase FLASH memory | |
2049 | flinfo - print FLASH memory information | |
10635afa | 2050 | nand - NAND memory operations (see doc/README.nand) |
2729af9d WD |
2051 | bdinfo - print Board Info structure |
2052 | iminfo - print header information for application image | |
2053 | coninfo - print console devices and informations | |
2054 | ide - IDE sub-system | |
2055 | loop - infinite loop on address range | |
56523f12 | 2056 | loopw - infinite write loop on address range |
2729af9d WD |
2057 | mtest - simple RAM test |
2058 | icache - enable or disable instruction cache | |
2059 | dcache - enable or disable data cache | |
2060 | reset - Perform RESET of the CPU | |
2061 | echo - echo args to console | |
2062 | version - print monitor version | |
2063 | help - print online help | |
2064 | ? - alias for 'help' | |
2065 | ||
2066 | ||
2067 | Monitor Commands - Detailed Description: | |
2068 | ======================================== | |
2069 | ||
2070 | TODO. | |
2071 | ||
2072 | For now: just type "help <command>". | |
2073 | ||
2074 | ||
2729af9d WD |
2075 | Note for Redundant Ethernet Interfaces: |
2076 | ======================================= | |
c609719b | 2077 | |
11ccc33f | 2078 | Some boards come with redundant Ethernet interfaces; U-Boot supports |
2729af9d WD |
2079 | such configurations and is capable of automatic selection of a |
2080 | "working" interface when needed. MAC assignment works as follows: | |
c609719b | 2081 | |
2729af9d WD |
2082 | Network interfaces are numbered eth0, eth1, eth2, ... Corresponding |
2083 | MAC addresses can be stored in the environment as "ethaddr" (=>eth0), | |
2084 | "eth1addr" (=>eth1), "eth2addr", ... | |
c609719b | 2085 | |
2729af9d WD |
2086 | If the network interface stores some valid MAC address (for instance |
2087 | in SROM), this is used as default address if there is NO correspon- | |
2088 | ding setting in the environment; if the corresponding environment | |
2089 | variable is set, this overrides the settings in the card; that means: | |
c609719b | 2090 | |
2729af9d WD |
2091 | o If the SROM has a valid MAC address, and there is no address in the |
2092 | environment, the SROM's address is used. | |
c609719b | 2093 | |
2729af9d WD |
2094 | o If there is no valid address in the SROM, and a definition in the |
2095 | environment exists, then the value from the environment variable is | |
2096 | used. | |
c609719b | 2097 | |
2729af9d WD |
2098 | o If both the SROM and the environment contain a MAC address, and |
2099 | both addresses are the same, this MAC address is used. | |
c609719b | 2100 | |
2729af9d WD |
2101 | o If both the SROM and the environment contain a MAC address, and the |
2102 | addresses differ, the value from the environment is used and a | |
2103 | warning is printed. | |
c609719b | 2104 | |
2729af9d | 2105 | o If neither SROM nor the environment contain a MAC address, an error |
bef1014b JH |
2106 | is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case |
2107 | a random, locally-assigned MAC is used. | |
c609719b | 2108 | |
ecee9324 | 2109 | If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses |
c0f40859 | 2110 | will be programmed into hardware as part of the initialization process. This |
ecee9324 BW |
2111 | may be skipped by setting the appropriate 'ethmacskip' environment variable. |
2112 | The naming convention is as follows: | |
2113 | "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. | |
c609719b | 2114 | |
2729af9d WD |
2115 | Image Formats: |
2116 | ============== | |
c609719b | 2117 | |
3310c549 MB |
2118 | U-Boot is capable of booting (and performing other auxiliary operations on) |
2119 | images in two formats: | |
2120 | ||
2121 | New uImage format (FIT) | |
2122 | ----------------------- | |
2123 | ||
2124 | Flexible and powerful format based on Flattened Image Tree -- FIT (similar | |
2125 | to Flattened Device Tree). It allows the use of images with multiple | |
2126 | components (several kernels, ramdisks, etc.), with contents protected by | |
2127 | SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. | |
2128 | ||
2129 | ||
2130 | Old uImage format | |
2131 | ----------------- | |
2132 | ||
2133 | Old image format is based on binary files which can be basically anything, | |
2134 | preceded by a special header; see the definitions in include/image.h for | |
2135 | details; basically, the header defines the following image properties: | |
c609719b | 2136 | |
2729af9d WD |
2137 | * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, |
2138 | 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, | |
f5ed9e39 | 2139 | LynxOS, pSOS, QNX, RTEMS, INTEGRITY; |
0797e736 | 2140 | Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY). |
daab59ac | 2141 | * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86, |
11232139 TR |
2142 | IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; |
2143 | Currently supported: ARM, Intel x86, MIPS, Nios II, PowerPC). | |
2729af9d WD |
2144 | * Compression Type (uncompressed, gzip, bzip2) |
2145 | * Load Address | |
2146 | * Entry Point | |
2147 | * Image Name | |
2148 | * Image Timestamp | |
c609719b | 2149 | |
2729af9d WD |
2150 | The header is marked by a special Magic Number, and both the header |
2151 | and the data portions of the image are secured against corruption by | |
2152 | CRC32 checksums. | |
c609719b WD |
2153 | |
2154 | ||
2729af9d WD |
2155 | Linux Support: |
2156 | ============== | |
c609719b | 2157 | |
2729af9d WD |
2158 | Although U-Boot should support any OS or standalone application |
2159 | easily, the main focus has always been on Linux during the design of | |
2160 | U-Boot. | |
c609719b | 2161 | |
2729af9d WD |
2162 | U-Boot includes many features that so far have been part of some |
2163 | special "boot loader" code within the Linux kernel. Also, any | |
2164 | "initrd" images to be used are no longer part of one big Linux image; | |
2165 | instead, kernel and "initrd" are separate images. This implementation | |
2166 | serves several purposes: | |
c609719b | 2167 | |
2729af9d WD |
2168 | - the same features can be used for other OS or standalone |
2169 | applications (for instance: using compressed images to reduce the | |
2170 | Flash memory footprint) | |
c609719b | 2171 | |
2729af9d WD |
2172 | - it becomes much easier to port new Linux kernel versions because |
2173 | lots of low-level, hardware dependent stuff are done by U-Boot | |
c609719b | 2174 | |
2729af9d WD |
2175 | - the same Linux kernel image can now be used with different "initrd" |
2176 | images; of course this also means that different kernel images can | |
2177 | be run with the same "initrd". This makes testing easier (you don't | |
2178 | have to build a new "zImage.initrd" Linux image when you just | |
2179 | change a file in your "initrd"). Also, a field-upgrade of the | |
2180 | software is easier now. | |
c609719b | 2181 | |
c609719b | 2182 | |
2729af9d WD |
2183 | Linux HOWTO: |
2184 | ============ | |
c609719b | 2185 | |
2729af9d WD |
2186 | Porting Linux to U-Boot based systems: |
2187 | --------------------------------------- | |
c609719b | 2188 | |
2729af9d WD |
2189 | U-Boot cannot save you from doing all the necessary modifications to |
2190 | configure the Linux device drivers for use with your target hardware | |
2191 | (no, we don't intend to provide a full virtual machine interface to | |
2192 | Linux :-). | |
c609719b | 2193 | |
a47a12be | 2194 | But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). |
24ee89b9 | 2195 | |
2729af9d WD |
2196 | Just make sure your machine specific header file (for instance |
2197 | include/asm-ppc/tqm8xx.h) includes the same definition of the Board | |
1dc30693 MH |
2198 | Information structure as we define in include/asm-<arch>/u-boot.h, |
2199 | and make sure that your definition of IMAP_ADDR uses the same value | |
6d0f6bcf | 2200 | as your U-Boot configuration in CONFIG_SYS_IMMR. |
24ee89b9 | 2201 | |
2eb31b13 SG |
2202 | Note that U-Boot now has a driver model, a unified model for drivers. |
2203 | If you are adding a new driver, plumb it into driver model. If there | |
2204 | is no uclass available, you are encouraged to create one. See | |
2205 | doc/driver-model. | |
2206 | ||
c609719b | 2207 | |
2729af9d WD |
2208 | Configuring the Linux kernel: |
2209 | ----------------------------- | |
c609719b | 2210 | |
2729af9d WD |
2211 | No specific requirements for U-Boot. Make sure you have some root |
2212 | device (initial ramdisk, NFS) for your target system. | |
2213 | ||
2214 | ||
2215 | Building a Linux Image: | |
2216 | ----------------------- | |
c609719b | 2217 | |
2729af9d WD |
2218 | With U-Boot, "normal" build targets like "zImage" or "bzImage" are |
2219 | not used. If you use recent kernel source, a new build target | |
2220 | "uImage" will exist which automatically builds an image usable by | |
2221 | U-Boot. Most older kernels also have support for a "pImage" target, | |
2222 | which was introduced for our predecessor project PPCBoot and uses a | |
2223 | 100% compatible format. | |
2224 | ||
2225 | Example: | |
2226 | ||
ab584d67 | 2227 | make TQM850L_defconfig |
2729af9d WD |
2228 | make oldconfig |
2229 | make dep | |
2230 | make uImage | |
2231 | ||
2232 | The "uImage" build target uses a special tool (in 'tools/mkimage') to | |
2233 | encapsulate a compressed Linux kernel image with header information, | |
2234 | CRC32 checksum etc. for use with U-Boot. This is what we are doing: | |
2235 | ||
2236 | * build a standard "vmlinux" kernel image (in ELF binary format): | |
2237 | ||
2238 | * convert the kernel into a raw binary image: | |
2239 | ||
2240 | ${CROSS_COMPILE}-objcopy -O binary \ | |
2241 | -R .note -R .comment \ | |
2242 | -S vmlinux linux.bin | |
2243 | ||
2244 | * compress the binary image: | |
2245 | ||
2246 | gzip -9 linux.bin | |
2247 | ||
2248 | * package compressed binary image for U-Boot: | |
2249 | ||
2250 | mkimage -A ppc -O linux -T kernel -C gzip \ | |
2251 | -a 0 -e 0 -n "Linux Kernel Image" \ | |
2252 | -d linux.bin.gz uImage | |
c609719b | 2253 | |
c609719b | 2254 | |
2729af9d WD |
2255 | The "mkimage" tool can also be used to create ramdisk images for use |
2256 | with U-Boot, either separated from the Linux kernel image, or | |
2257 | combined into one file. "mkimage" encapsulates the images with a 64 | |
2258 | byte header containing information about target architecture, | |
2259 | operating system, image type, compression method, entry points, time | |
2260 | stamp, CRC32 checksums, etc. | |
2261 | ||
2262 | "mkimage" can be called in two ways: to verify existing images and | |
2263 | print the header information, or to build new images. | |
2264 | ||
2265 | In the first form (with "-l" option) mkimage lists the information | |
2266 | contained in the header of an existing U-Boot image; this includes | |
2267 | checksum verification: | |
c609719b | 2268 | |
2729af9d WD |
2269 | tools/mkimage -l image |
2270 | -l ==> list image header information | |
2271 | ||
2272 | The second form (with "-d" option) is used to build a U-Boot image | |
2273 | from a "data file" which is used as image payload: | |
2274 | ||
2275 | tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ | |
2276 | -n name -d data_file image | |
2277 | -A ==> set architecture to 'arch' | |
2278 | -O ==> set operating system to 'os' | |
2279 | -T ==> set image type to 'type' | |
2280 | -C ==> set compression type 'comp' | |
2281 | -a ==> set load address to 'addr' (hex) | |
2282 | -e ==> set entry point to 'ep' (hex) | |
2283 | -n ==> set image name to 'name' | |
2284 | -d ==> use image data from 'datafile' | |
2285 | ||
69459791 WD |
2286 | Right now, all Linux kernels for PowerPC systems use the same load |
2287 | address (0x00000000), but the entry point address depends on the | |
2288 | kernel version: | |
2729af9d WD |
2289 | |
2290 | - 2.2.x kernels have the entry point at 0x0000000C, | |
2291 | - 2.3.x and later kernels have the entry point at 0x00000000. | |
2292 | ||
2293 | So a typical call to build a U-Boot image would read: | |
2294 | ||
2295 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ | |
2296 | > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ | |
a47a12be | 2297 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ |
2729af9d WD |
2298 | > examples/uImage.TQM850L |
2299 | Image Name: 2.4.4 kernel for TQM850L | |
2300 | Created: Wed Jul 19 02:34:59 2000 | |
2301 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2302 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB | |
2303 | Load Address: 0x00000000 | |
2304 | Entry Point: 0x00000000 | |
2305 | ||
2306 | To verify the contents of the image (or check for corruption): | |
2307 | ||
2308 | -> tools/mkimage -l examples/uImage.TQM850L | |
2309 | Image Name: 2.4.4 kernel for TQM850L | |
2310 | Created: Wed Jul 19 02:34:59 2000 | |
2311 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2312 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB | |
2313 | Load Address: 0x00000000 | |
2314 | Entry Point: 0x00000000 | |
2315 | ||
2316 | NOTE: for embedded systems where boot time is critical you can trade | |
2317 | speed for memory and install an UNCOMPRESSED image instead: this | |
2318 | needs more space in Flash, but boots much faster since it does not | |
2319 | need to be uncompressed: | |
2320 | ||
a47a12be | 2321 | -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz |
2729af9d WD |
2322 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ |
2323 | > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ | |
a47a12be | 2324 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ |
2729af9d WD |
2325 | > examples/uImage.TQM850L-uncompressed |
2326 | Image Name: 2.4.4 kernel for TQM850L | |
2327 | Created: Wed Jul 19 02:34:59 2000 | |
2328 | Image Type: PowerPC Linux Kernel Image (uncompressed) | |
2329 | Data Size: 792160 Bytes = 773.59 kB = 0.76 MB | |
2330 | Load Address: 0x00000000 | |
2331 | Entry Point: 0x00000000 | |
2332 | ||
2333 | ||
2334 | Similar you can build U-Boot images from a 'ramdisk.image.gz' file | |
2335 | when your kernel is intended to use an initial ramdisk: | |
2336 | ||
2337 | -> tools/mkimage -n 'Simple Ramdisk Image' \ | |
2338 | > -A ppc -O linux -T ramdisk -C gzip \ | |
2339 | > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd | |
2340 | Image Name: Simple Ramdisk Image | |
2341 | Created: Wed Jan 12 14:01:50 2000 | |
2342 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) | |
2343 | Data Size: 566530 Bytes = 553.25 kB = 0.54 MB | |
2344 | Load Address: 0x00000000 | |
2345 | Entry Point: 0x00000000 | |
2346 | ||
e157a111 TH |
2347 | The "dumpimage" tool can be used to disassemble or list the contents of images |
2348 | built by mkimage. See dumpimage's help output (-h) for details. | |
2729af9d WD |
2349 | |
2350 | Installing a Linux Image: | |
2351 | ------------------------- | |
2352 | ||
2353 | To downloading a U-Boot image over the serial (console) interface, | |
2354 | you must convert the image to S-Record format: | |
2355 | ||
2356 | objcopy -I binary -O srec examples/image examples/image.srec | |
2357 | ||
2358 | The 'objcopy' does not understand the information in the U-Boot | |
2359 | image header, so the resulting S-Record file will be relative to | |
2360 | address 0x00000000. To load it to a given address, you need to | |
2361 | specify the target address as 'offset' parameter with the 'loads' | |
2362 | command. | |
2363 | ||
2364 | Example: install the image to address 0x40100000 (which on the | |
2365 | TQM8xxL is in the first Flash bank): | |
2366 | ||
2367 | => erase 40100000 401FFFFF | |
2368 | ||
2369 | .......... done | |
2370 | Erased 8 sectors | |
2371 | ||
2372 | => loads 40100000 | |
2373 | ## Ready for S-Record download ... | |
2374 | ~>examples/image.srec | |
2375 | 1 2 3 4 5 6 7 8 9 10 11 12 13 ... | |
2376 | ... | |
2377 | 15989 15990 15991 15992 | |
2378 | [file transfer complete] | |
2379 | [connected] | |
2380 | ## Start Addr = 0x00000000 | |
2381 | ||
2382 | ||
2383 | You can check the success of the download using the 'iminfo' command; | |
218ca724 | 2384 | this includes a checksum verification so you can be sure no data |
2729af9d WD |
2385 | corruption happened: |
2386 | ||
2387 | => imi 40100000 | |
2388 | ||
2389 | ## Checking Image at 40100000 ... | |
2390 | Image Name: 2.2.13 for initrd on TQM850L | |
2391 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2392 | Data Size: 335725 Bytes = 327 kB = 0 MB | |
2393 | Load Address: 00000000 | |
2394 | Entry Point: 0000000c | |
2395 | Verifying Checksum ... OK | |
2396 | ||
2397 | ||
2398 | Boot Linux: | |
2399 | ----------- | |
2400 | ||
2401 | The "bootm" command is used to boot an application that is stored in | |
2402 | memory (RAM or Flash). In case of a Linux kernel image, the contents | |
2403 | of the "bootargs" environment variable is passed to the kernel as | |
2404 | parameters. You can check and modify this variable using the | |
2405 | "printenv" and "setenv" commands: | |
2406 | ||
2407 | ||
2408 | => printenv bootargs | |
2409 | bootargs=root=/dev/ram | |
2410 | ||
2411 | => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 | |
2412 | ||
2413 | => printenv bootargs | |
2414 | bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 | |
2415 | ||
2416 | => bootm 40020000 | |
2417 | ## Booting Linux kernel at 40020000 ... | |
2418 | Image Name: 2.2.13 for NFS on TQM850L | |
2419 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2420 | Data Size: 381681 Bytes = 372 kB = 0 MB | |
2421 | Load Address: 00000000 | |
2422 | Entry Point: 0000000c | |
2423 | Verifying Checksum ... OK | |
2424 | Uncompressing Kernel Image ... OK | |
2425 | Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000 | |
2426 | Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 | |
2427 | time_init: decrementer frequency = 187500000/60 | |
2428 | Calibrating delay loop... 49.77 BogoMIPS | |
2429 | Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] | |
2430 | ... | |
2431 | ||
11ccc33f | 2432 | If you want to boot a Linux kernel with initial RAM disk, you pass |
2729af9d WD |
2433 | the memory addresses of both the kernel and the initrd image (PPBCOOT |
2434 | format!) to the "bootm" command: | |
2435 | ||
2436 | => imi 40100000 40200000 | |
2437 | ||
2438 | ## Checking Image at 40100000 ... | |
2439 | Image Name: 2.2.13 for initrd on TQM850L | |
2440 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2441 | Data Size: 335725 Bytes = 327 kB = 0 MB | |
2442 | Load Address: 00000000 | |
2443 | Entry Point: 0000000c | |
2444 | Verifying Checksum ... OK | |
2445 | ||
2446 | ## Checking Image at 40200000 ... | |
2447 | Image Name: Simple Ramdisk Image | |
2448 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) | |
2449 | Data Size: 566530 Bytes = 553 kB = 0 MB | |
2450 | Load Address: 00000000 | |
2451 | Entry Point: 00000000 | |
2452 | Verifying Checksum ... OK | |
2453 | ||
2454 | => bootm 40100000 40200000 | |
2455 | ## Booting Linux kernel at 40100000 ... | |
2456 | Image Name: 2.2.13 for initrd on TQM850L | |
2457 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2458 | Data Size: 335725 Bytes = 327 kB = 0 MB | |
2459 | Load Address: 00000000 | |
2460 | Entry Point: 0000000c | |
2461 | Verifying Checksum ... OK | |
2462 | Uncompressing Kernel Image ... OK | |
2463 | ## Loading RAMDisk Image at 40200000 ... | |
2464 | Image Name: Simple Ramdisk Image | |
2465 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) | |
2466 | Data Size: 566530 Bytes = 553 kB = 0 MB | |
2467 | Load Address: 00000000 | |
2468 | Entry Point: 00000000 | |
2469 | Verifying Checksum ... OK | |
2470 | Loading Ramdisk ... OK | |
2471 | Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000 | |
2472 | Boot arguments: root=/dev/ram | |
2473 | time_init: decrementer frequency = 187500000/60 | |
2474 | Calibrating delay loop... 49.77 BogoMIPS | |
2475 | ... | |
2476 | RAMDISK: Compressed image found at block 0 | |
2477 | VFS: Mounted root (ext2 filesystem). | |
2478 | ||
2479 | bash# | |
2480 | ||
0267768e MM |
2481 | Boot Linux and pass a flat device tree: |
2482 | ----------- | |
2483 | ||
2484 | First, U-Boot must be compiled with the appropriate defines. See the section | |
2485 | titled "Linux Kernel Interface" above for a more in depth explanation. The | |
2486 | following is an example of how to start a kernel and pass an updated | |
2487 | flat device tree: | |
2488 | ||
2489 | => print oftaddr | |
2490 | oftaddr=0x300000 | |
2491 | => print oft | |
2492 | oft=oftrees/mpc8540ads.dtb | |
2493 | => tftp $oftaddr $oft | |
2494 | Speed: 1000, full duplex | |
2495 | Using TSEC0 device | |
2496 | TFTP from server 192.168.1.1; our IP address is 192.168.1.101 | |
2497 | Filename 'oftrees/mpc8540ads.dtb'. | |
2498 | Load address: 0x300000 | |
2499 | Loading: # | |
2500 | done | |
2501 | Bytes transferred = 4106 (100a hex) | |
2502 | => tftp $loadaddr $bootfile | |
2503 | Speed: 1000, full duplex | |
2504 | Using TSEC0 device | |
2505 | TFTP from server 192.168.1.1; our IP address is 192.168.1.2 | |
2506 | Filename 'uImage'. | |
2507 | Load address: 0x200000 | |
2508 | Loading:############ | |
2509 | done | |
2510 | Bytes transferred = 1029407 (fb51f hex) | |
2511 | => print loadaddr | |
2512 | loadaddr=200000 | |
2513 | => print oftaddr | |
2514 | oftaddr=0x300000 | |
2515 | => bootm $loadaddr - $oftaddr | |
2516 | ## Booting image at 00200000 ... | |
a9398e01 WD |
2517 | Image Name: Linux-2.6.17-dirty |
2518 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2519 | Data Size: 1029343 Bytes = 1005.2 kB | |
0267768e | 2520 | Load Address: 00000000 |
a9398e01 | 2521 | Entry Point: 00000000 |
0267768e MM |
2522 | Verifying Checksum ... OK |
2523 | Uncompressing Kernel Image ... OK | |
2524 | Booting using flat device tree at 0x300000 | |
2525 | Using MPC85xx ADS machine description | |
2526 | Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb | |
2527 | [snip] | |
2528 | ||
2529 | ||
2729af9d WD |
2530 | More About U-Boot Image Types: |
2531 | ------------------------------ | |
2532 | ||
2533 | U-Boot supports the following image types: | |
2534 | ||
2535 | "Standalone Programs" are directly runnable in the environment | |
2536 | provided by U-Boot; it is expected that (if they behave | |
2537 | well) you can continue to work in U-Boot after return from | |
2538 | the Standalone Program. | |
2539 | "OS Kernel Images" are usually images of some Embedded OS which | |
2540 | will take over control completely. Usually these programs | |
2541 | will install their own set of exception handlers, device | |
2542 | drivers, set up the MMU, etc. - this means, that you cannot | |
2543 | expect to re-enter U-Boot except by resetting the CPU. | |
2544 | "RAMDisk Images" are more or less just data blocks, and their | |
2545 | parameters (address, size) are passed to an OS kernel that is | |
2546 | being started. | |
2547 | "Multi-File Images" contain several images, typically an OS | |
2548 | (Linux) kernel image and one or more data images like | |
2549 | RAMDisks. This construct is useful for instance when you want | |
2550 | to boot over the network using BOOTP etc., where the boot | |
2551 | server provides just a single image file, but you want to get | |
2552 | for instance an OS kernel and a RAMDisk image. | |
2553 | ||
2554 | "Multi-File Images" start with a list of image sizes, each | |
2555 | image size (in bytes) specified by an "uint32_t" in network | |
2556 | byte order. This list is terminated by an "(uint32_t)0". | |
2557 | Immediately after the terminating 0 follow the images, one by | |
2558 | one, all aligned on "uint32_t" boundaries (size rounded up to | |
2559 | a multiple of 4 bytes). | |
2560 | ||
2561 | "Firmware Images" are binary images containing firmware (like | |
2562 | U-Boot or FPGA images) which usually will be programmed to | |
2563 | flash memory. | |
2564 | ||
2565 | "Script files" are command sequences that will be executed by | |
2566 | U-Boot's command interpreter; this feature is especially | |
2567 | useful when you configure U-Boot to use a real shell (hush) | |
2568 | as command interpreter. | |
2569 | ||
44f074c7 MV |
2570 | Booting the Linux zImage: |
2571 | ------------------------- | |
2572 | ||
2573 | On some platforms, it's possible to boot Linux zImage. This is done | |
2574 | using the "bootz" command. The syntax of "bootz" command is the same | |
2575 | as the syntax of "bootm" command. | |
2576 | ||
8ac28563 | 2577 | Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply |
017e1f3f MV |
2578 | kernel with raw initrd images. The syntax is slightly different, the |
2579 | address of the initrd must be augmented by it's size, in the following | |
2580 | format: "<initrd addres>:<initrd size>". | |
2581 | ||
2729af9d WD |
2582 | |
2583 | Standalone HOWTO: | |
2584 | ================= | |
2585 | ||
2586 | One of the features of U-Boot is that you can dynamically load and | |
2587 | run "standalone" applications, which can use some resources of | |
2588 | U-Boot like console I/O functions or interrupt services. | |
2589 | ||
2590 | Two simple examples are included with the sources: | |
2591 | ||
2592 | "Hello World" Demo: | |
2593 | ------------------- | |
2594 | ||
2595 | 'examples/hello_world.c' contains a small "Hello World" Demo | |
2596 | application; it is automatically compiled when you build U-Boot. | |
2597 | It's configured to run at address 0x00040004, so you can play with it | |
2598 | like that: | |
2599 | ||
2600 | => loads | |
2601 | ## Ready for S-Record download ... | |
2602 | ~>examples/hello_world.srec | |
2603 | 1 2 3 4 5 6 7 8 9 10 11 ... | |
2604 | [file transfer complete] | |
2605 | [connected] | |
2606 | ## Start Addr = 0x00040004 | |
2607 | ||
2608 | => go 40004 Hello World! This is a test. | |
2609 | ## Starting application at 0x00040004 ... | |
2610 | Hello World | |
2611 | argc = 7 | |
2612 | argv[0] = "40004" | |
2613 | argv[1] = "Hello" | |
2614 | argv[2] = "World!" | |
2615 | argv[3] = "This" | |
2616 | argv[4] = "is" | |
2617 | argv[5] = "a" | |
2618 | argv[6] = "test." | |
2619 | argv[7] = "<NULL>" | |
2620 | Hit any key to exit ... | |
2621 | ||
2622 | ## Application terminated, rc = 0x0 | |
2623 | ||
2624 | Another example, which demonstrates how to register a CPM interrupt | |
2625 | handler with the U-Boot code, can be found in 'examples/timer.c'. | |
2626 | Here, a CPM timer is set up to generate an interrupt every second. | |
2627 | The interrupt service routine is trivial, just printing a '.' | |
2628 | character, but this is just a demo program. The application can be | |
2629 | controlled by the following keys: | |
2630 | ||
2631 | ? - print current values og the CPM Timer registers | |
2632 | b - enable interrupts and start timer | |
2633 | e - stop timer and disable interrupts | |
2634 | q - quit application | |
2635 | ||
2636 | => loads | |
2637 | ## Ready for S-Record download ... | |
2638 | ~>examples/timer.srec | |
2639 | 1 2 3 4 5 6 7 8 9 10 11 ... | |
2640 | [file transfer complete] | |
2641 | [connected] | |
2642 | ## Start Addr = 0x00040004 | |
2643 | ||
2644 | => go 40004 | |
2645 | ## Starting application at 0x00040004 ... | |
2646 | TIMERS=0xfff00980 | |
2647 | Using timer 1 | |
2648 | tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 | |
2649 | ||
2650 | Hit 'b': | |
2651 | [q, b, e, ?] Set interval 1000000 us | |
2652 | Enabling timer | |
2653 | Hit '?': | |
2654 | [q, b, e, ?] ........ | |
2655 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 | |
2656 | Hit '?': | |
2657 | [q, b, e, ?] . | |
2658 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 | |
2659 | Hit '?': | |
2660 | [q, b, e, ?] . | |
2661 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 | |
2662 | Hit '?': | |
2663 | [q, b, e, ?] . | |
2664 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 | |
2665 | Hit 'e': | |
2666 | [q, b, e, ?] ...Stopping timer | |
2667 | Hit 'q': | |
2668 | [q, b, e, ?] ## Application terminated, rc = 0x0 | |
2669 | ||
2670 | ||
2671 | Minicom warning: | |
2672 | ================ | |
2673 | ||
2674 | Over time, many people have reported problems when trying to use the | |
2675 | "minicom" terminal emulation program for serial download. I (wd) | |
2676 | consider minicom to be broken, and recommend not to use it. Under | |
2677 | Unix, I recommend to use C-Kermit for general purpose use (and | |
2678 | especially for kermit binary protocol download ("loadb" command), and | |
e53515a2 | 2679 | use "cu" for S-Record download ("loads" command). See |
047f6ec0 | 2680 | https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. |
e53515a2 KP |
2681 | for help with kermit. |
2682 | ||
2729af9d WD |
2683 | |
2684 | Nevertheless, if you absolutely want to use it try adding this | |
2685 | configuration to your "File transfer protocols" section: | |
2686 | ||
2687 | Name Program Name U/D FullScr IO-Red. Multi | |
2688 | X kermit /usr/bin/kermit -i -l %l -s Y U Y N N | |
2689 | Y kermit /usr/bin/kermit -i -l %l -r N D Y N N | |
2690 | ||
2691 | ||
2692 | NetBSD Notes: | |
2693 | ============= | |
2694 | ||
2695 | Starting at version 0.9.2, U-Boot supports NetBSD both as host | |
2696 | (build U-Boot) and target system (boots NetBSD/mpc8xx). | |
2697 | ||
2698 | Building requires a cross environment; it is known to work on | |
2699 | NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also | |
2700 | need gmake since the Makefiles are not compatible with BSD make). | |
2701 | Note that the cross-powerpc package does not install include files; | |
2702 | attempting to build U-Boot will fail because <machine/ansi.h> is | |
2703 | missing. This file has to be installed and patched manually: | |
2704 | ||
2705 | # cd /usr/pkg/cross/powerpc-netbsd/include | |
2706 | # mkdir powerpc | |
2707 | # ln -s powerpc machine | |
2708 | # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h | |
2709 | # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST | |
2710 | ||
2711 | Native builds *don't* work due to incompatibilities between native | |
2712 | and U-Boot include files. | |
2713 | ||
2714 | Booting assumes that (the first part of) the image booted is a | |
2715 | stage-2 loader which in turn loads and then invokes the kernel | |
2716 | proper. Loader sources will eventually appear in the NetBSD source | |
2717 | tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the | |
2a8af187 | 2718 | meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz |
2729af9d WD |
2719 | |
2720 | ||
2721 | Implementation Internals: | |
2722 | ========================= | |
2723 | ||
2724 | The following is not intended to be a complete description of every | |
2725 | implementation detail. However, it should help to understand the | |
2726 | inner workings of U-Boot and make it easier to port it to custom | |
2727 | hardware. | |
2728 | ||
2729 | ||
2730 | Initial Stack, Global Data: | |
2731 | --------------------------- | |
2732 | ||
2733 | The implementation of U-Boot is complicated by the fact that U-Boot | |
2734 | starts running out of ROM (flash memory), usually without access to | |
2735 | system RAM (because the memory controller is not initialized yet). | |
2736 | This means that we don't have writable Data or BSS segments, and BSS | |
2737 | is not initialized as zero. To be able to get a C environment working | |
2738 | at all, we have to allocate at least a minimal stack. Implementation | |
2739 | options for this are defined and restricted by the CPU used: Some CPU | |
2740 | models provide on-chip memory (like the IMMR area on MPC8xx and | |
2741 | MPC826x processors), on others (parts of) the data cache can be | |
2742 | locked as (mis-) used as memory, etc. | |
2743 | ||
218ca724 | 2744 | Chris Hallinan posted a good summary of these issues to the |
0668236b | 2745 | U-Boot mailing list: |
2729af9d WD |
2746 | |
2747 | Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? | |
2748 | From: "Chris Hallinan" <clh@net1plus.com> | |
2749 | Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) | |
2750 | ... | |
2751 | ||
2752 | Correct me if I'm wrong, folks, but the way I understand it | |
2753 | is this: Using DCACHE as initial RAM for Stack, etc, does not | |
2754 | require any physical RAM backing up the cache. The cleverness | |
2755 | is that the cache is being used as a temporary supply of | |
2756 | necessary storage before the SDRAM controller is setup. It's | |
11ccc33f | 2757 | beyond the scope of this list to explain the details, but you |
2729af9d WD |
2758 | can see how this works by studying the cache architecture and |
2759 | operation in the architecture and processor-specific manuals. | |
2760 | ||
2761 | OCM is On Chip Memory, which I believe the 405GP has 4K. It | |
2762 | is another option for the system designer to use as an | |
11ccc33f | 2763 | initial stack/RAM area prior to SDRAM being available. Either |
2729af9d WD |
2764 | option should work for you. Using CS 4 should be fine if your |
2765 | board designers haven't used it for something that would | |
2766 | cause you grief during the initial boot! It is frequently not | |
2767 | used. | |
2768 | ||
6d0f6bcf | 2769 | CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere |
2729af9d WD |
2770 | with your processor/board/system design. The default value |
2771 | you will find in any recent u-boot distribution in | |
8a316c9b | 2772 | walnut.h should work for you. I'd set it to a value larger |
2729af9d WD |
2773 | than your SDRAM module. If you have a 64MB SDRAM module, set |
2774 | it above 400_0000. Just make sure your board has no resources | |
2775 | that are supposed to respond to that address! That code in | |
2776 | start.S has been around a while and should work as is when | |
2777 | you get the config right. | |
2778 | ||
2779 | -Chris Hallinan | |
2780 | DS4.COM, Inc. | |
2781 | ||
2782 | It is essential to remember this, since it has some impact on the C | |
2783 | code for the initialization procedures: | |
2784 | ||
2785 | * Initialized global data (data segment) is read-only. Do not attempt | |
2786 | to write it. | |
2787 | ||
b445bbb4 | 2788 | * Do not use any uninitialized global data (or implicitly initialized |
2729af9d WD |
2789 | as zero data - BSS segment) at all - this is undefined, initiali- |
2790 | zation is performed later (when relocating to RAM). | |
2791 | ||
2792 | * Stack space is very limited. Avoid big data buffers or things like | |
2793 | that. | |
2794 | ||
2795 | Having only the stack as writable memory limits means we cannot use | |
b445bbb4 | 2796 | normal global data to share information between the code. But it |
2729af9d WD |
2797 | turned out that the implementation of U-Boot can be greatly |
2798 | simplified by making a global data structure (gd_t) available to all | |
2799 | functions. We could pass a pointer to this data as argument to _all_ | |
2800 | functions, but this would bloat the code. Instead we use a feature of | |
2801 | the GCC compiler (Global Register Variables) to share the data: we | |
2802 | place a pointer (gd) to the global data into a register which we | |
2803 | reserve for this purpose. | |
2804 | ||
2805 | When choosing a register for such a purpose we are restricted by the | |
2806 | relevant (E)ABI specifications for the current architecture, and by | |
2807 | GCC's implementation. | |
2808 | ||
2809 | For PowerPC, the following registers have specific use: | |
2810 | R1: stack pointer | |
e7670f6c | 2811 | R2: reserved for system use |
2729af9d WD |
2812 | R3-R4: parameter passing and return values |
2813 | R5-R10: parameter passing | |
2814 | R13: small data area pointer | |
2815 | R30: GOT pointer | |
2816 | R31: frame pointer | |
2817 | ||
e6bee808 JT |
2818 | (U-Boot also uses R12 as internal GOT pointer. r12 |
2819 | is a volatile register so r12 needs to be reset when | |
2820 | going back and forth between asm and C) | |
2729af9d | 2821 | |
e7670f6c | 2822 | ==> U-Boot will use R2 to hold a pointer to the global data |
2729af9d WD |
2823 | |
2824 | Note: on PPC, we could use a static initializer (since the | |
2825 | address of the global data structure is known at compile time), | |
2826 | but it turned out that reserving a register results in somewhat | |
2827 | smaller code - although the code savings are not that big (on | |
2828 | average for all boards 752 bytes for the whole U-Boot image, | |
2829 | 624 text + 127 data). | |
2830 | ||
2831 | On ARM, the following registers are used: | |
2832 | ||
2833 | R0: function argument word/integer result | |
2834 | R1-R3: function argument word | |
12eba1b4 JH |
2835 | R9: platform specific |
2836 | R10: stack limit (used only if stack checking is enabled) | |
2729af9d WD |
2837 | R11: argument (frame) pointer |
2838 | R12: temporary workspace | |
2839 | R13: stack pointer | |
2840 | R14: link register | |
2841 | R15: program counter | |
2842 | ||
12eba1b4 JH |
2843 | ==> U-Boot will use R9 to hold a pointer to the global data |
2844 | ||
2845 | Note: on ARM, only R_ARM_RELATIVE relocations are supported. | |
2729af9d | 2846 | |
0df01fd3 | 2847 | On Nios II, the ABI is documented here: |
047f6ec0 | 2848 | https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf |
0df01fd3 TC |
2849 | |
2850 | ==> U-Boot will use gp to hold a pointer to the global data | |
2851 | ||
2852 | Note: on Nios II, we give "-G0" option to gcc and don't use gp | |
2853 | to access small data sections, so gp is free. | |
2854 | ||
3fafced7 RC |
2855 | On RISC-V, the following registers are used: |
2856 | ||
2857 | x0: hard-wired zero (zero) | |
2858 | x1: return address (ra) | |
2859 | x2: stack pointer (sp) | |
2860 | x3: global pointer (gp) | |
2861 | x4: thread pointer (tp) | |
2862 | x5: link register (t0) | |
2863 | x8: frame pointer (fp) | |
2864 | x10-x11: arguments/return values (a0-1) | |
2865 | x12-x17: arguments (a2-7) | |
2866 | x28-31: temporaries (t3-6) | |
2867 | pc: program counter (pc) | |
2868 | ||
2869 | ==> U-Boot will use gp to hold a pointer to the global data | |
2870 | ||
2729af9d WD |
2871 | Memory Management: |
2872 | ------------------ | |
2873 | ||
2874 | U-Boot runs in system state and uses physical addresses, i.e. the | |
2875 | MMU is not used either for address mapping nor for memory protection. | |
2876 | ||
2877 | The available memory is mapped to fixed addresses using the memory | |
2878 | controller. In this process, a contiguous block is formed for each | |
2879 | memory type (Flash, SDRAM, SRAM), even when it consists of several | |
2880 | physical memory banks. | |
2881 | ||
2882 | U-Boot is installed in the first 128 kB of the first Flash bank (on | |
2883 | TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After | |
2884 | booting and sizing and initializing DRAM, the code relocates itself | |
2885 | to the upper end of DRAM. Immediately below the U-Boot code some | |
6d0f6bcf | 2886 | memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN |
2729af9d WD |
2887 | configuration setting]. Below that, a structure with global Board |
2888 | Info data is placed, followed by the stack (growing downward). | |
2889 | ||
2890 | Additionally, some exception handler code is copied to the low 8 kB | |
2891 | of DRAM (0x00000000 ... 0x00001FFF). | |
2892 | ||
2893 | So a typical memory configuration with 16 MB of DRAM could look like | |
2894 | this: | |
2895 | ||
2896 | 0x0000 0000 Exception Vector code | |
2897 | : | |
2898 | 0x0000 1FFF | |
2899 | 0x0000 2000 Free for Application Use | |
2900 | : | |
2901 | : | |
2902 | ||
2903 | : | |
2904 | : | |
2905 | 0x00FB FF20 Monitor Stack (Growing downward) | |
2906 | 0x00FB FFAC Board Info Data and permanent copy of global data | |
2907 | 0x00FC 0000 Malloc Arena | |
2908 | : | |
2909 | 0x00FD FFFF | |
2910 | 0x00FE 0000 RAM Copy of Monitor Code | |
2911 | ... eventually: LCD or video framebuffer | |
2912 | ... eventually: pRAM (Protected RAM - unchanged by reset) | |
2913 | 0x00FF FFFF [End of RAM] | |
2914 | ||
2915 | ||
2916 | System Initialization: | |
2917 | ---------------------- | |
c609719b | 2918 | |
2729af9d | 2919 | In the reset configuration, U-Boot starts at the reset entry point |
11ccc33f | 2920 | (on most PowerPC systems at address 0x00000100). Because of the reset |
b445bbb4 | 2921 | configuration for CS0# this is a mirror of the on board Flash memory. |
2729af9d WD |
2922 | To be able to re-map memory U-Boot then jumps to its link address. |
2923 | To be able to implement the initialization code in C, a (small!) | |
2924 | initial stack is set up in the internal Dual Ported RAM (in case CPUs | |
2eb48ff7 HS |
2925 | which provide such a feature like), or in a locked part of the data |
2926 | cache. After that, U-Boot initializes the CPU core, the caches and | |
2927 | the SIU. | |
2729af9d WD |
2928 | |
2929 | Next, all (potentially) available memory banks are mapped using a | |
2930 | preliminary mapping. For example, we put them on 512 MB boundaries | |
2931 | (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash | |
2932 | on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is | |
2933 | programmed for SDRAM access. Using the temporary configuration, a | |
2934 | simple memory test is run that determines the size of the SDRAM | |
2935 | banks. | |
2936 | ||
2937 | When there is more than one SDRAM bank, and the banks are of | |
2938 | different size, the largest is mapped first. For equal size, the first | |
2939 | bank (CS2#) is mapped first. The first mapping is always for address | |
2940 | 0x00000000, with any additional banks following immediately to create | |
2941 | contiguous memory starting from 0. | |
2942 | ||
2943 | Then, the monitor installs itself at the upper end of the SDRAM area | |
2944 | and allocates memory for use by malloc() and for the global Board | |
2945 | Info data; also, the exception vector code is copied to the low RAM | |
2946 | pages, and the final stack is set up. | |
2947 | ||
2948 | Only after this relocation will you have a "normal" C environment; | |
2949 | until that you are restricted in several ways, mostly because you are | |
2950 | running from ROM, and because the code will have to be relocated to a | |
2951 | new address in RAM. | |
2952 | ||
2953 | ||
2954 | U-Boot Porting Guide: | |
2955 | ---------------------- | |
c609719b | 2956 | |
2729af9d WD |
2957 | [Based on messages by Jerry Van Baren in the U-Boot-Users mailing |
2958 | list, October 2002] | |
c609719b WD |
2959 | |
2960 | ||
6c3fef28 | 2961 | int main(int argc, char *argv[]) |
2729af9d WD |
2962 | { |
2963 | sighandler_t no_more_time; | |
c609719b | 2964 | |
6c3fef28 JVB |
2965 | signal(SIGALRM, no_more_time); |
2966 | alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); | |
c609719b | 2967 | |
2729af9d | 2968 | if (available_money > available_manpower) { |
6c3fef28 | 2969 | Pay consultant to port U-Boot; |
c609719b WD |
2970 | return 0; |
2971 | } | |
2972 | ||
2729af9d WD |
2973 | Download latest U-Boot source; |
2974 | ||
0668236b | 2975 | Subscribe to u-boot mailing list; |
2729af9d | 2976 | |
6c3fef28 JVB |
2977 | if (clueless) |
2978 | email("Hi, I am new to U-Boot, how do I get started?"); | |
2729af9d WD |
2979 | |
2980 | while (learning) { | |
2981 | Read the README file in the top level directory; | |
047f6ec0 | 2982 | Read https://www.denx.de/wiki/bin/view/DULG/Manual; |
24bcaec7 | 2983 | Read applicable doc/README.*; |
2729af9d | 2984 | Read the source, Luke; |
6c3fef28 | 2985 | /* find . -name "*.[chS]" | xargs grep -i <keyword> */ |
2729af9d WD |
2986 | } |
2987 | ||
6c3fef28 JVB |
2988 | if (available_money > toLocalCurrency ($2500)) |
2989 | Buy a BDI3000; | |
2990 | else | |
2729af9d | 2991 | Add a lot of aggravation and time; |
2729af9d | 2992 | |
6c3fef28 JVB |
2993 | if (a similar board exists) { /* hopefully... */ |
2994 | cp -a board/<similar> board/<myboard> | |
2995 | cp include/configs/<similar>.h include/configs/<myboard>.h | |
2996 | } else { | |
2997 | Create your own board support subdirectory; | |
2998 | Create your own board include/configs/<myboard>.h file; | |
2999 | } | |
3000 | Edit new board/<myboard> files | |
3001 | Edit new include/configs/<myboard>.h | |
3002 | ||
3003 | while (!accepted) { | |
3004 | while (!running) { | |
3005 | do { | |
3006 | Add / modify source code; | |
3007 | } until (compiles); | |
3008 | Debug; | |
3009 | if (clueless) | |
3010 | email("Hi, I am having problems..."); | |
3011 | } | |
3012 | Send patch file to the U-Boot email list; | |
3013 | if (reasonable critiques) | |
3014 | Incorporate improvements from email list code review; | |
3015 | else | |
3016 | Defend code as written; | |
2729af9d | 3017 | } |
2729af9d WD |
3018 | |
3019 | return 0; | |
3020 | } | |
3021 | ||
3022 | void no_more_time (int sig) | |
3023 | { | |
3024 | hire_a_guru(); | |
3025 | } | |
3026 | ||
c609719b | 3027 | |
2729af9d WD |
3028 | Coding Standards: |
3029 | ----------------- | |
c609719b | 3030 | |
2729af9d | 3031 | All contributions to U-Boot should conform to the Linux kernel |
659208da BS |
3032 | coding style; see the kernel coding style guide at |
3033 | https://www.kernel.org/doc/html/latest/process/coding-style.html, and the | |
3034 | script "scripts/Lindent" in your Linux kernel source directory. | |
2c051651 DZ |
3035 | |
3036 | Source files originating from a different project (for example the | |
3037 | MTD subsystem) are generally exempt from these guidelines and are not | |
b445bbb4 | 3038 | reformatted to ease subsequent migration to newer versions of those |
2c051651 DZ |
3039 | sources. |
3040 | ||
3041 | Please note that U-Boot is implemented in C (and to some small parts in | |
3042 | Assembler); no C++ is used, so please do not use C++ style comments (//) | |
3043 | in your code. | |
c609719b | 3044 | |
2729af9d WD |
3045 | Please also stick to the following formatting rules: |
3046 | - remove any trailing white space | |
7ca9296e | 3047 | - use TAB characters for indentation and vertical alignment, not spaces |
2729af9d | 3048 | - make sure NOT to use DOS '\r\n' line feeds |
7ca9296e | 3049 | - do not add more than 2 consecutive empty lines to source files |
2729af9d | 3050 | - do not add trailing empty lines to source files |
180d3f74 | 3051 | |
2729af9d WD |
3052 | Submissions which do not conform to the standards may be returned |
3053 | with a request to reformat the changes. | |
c609719b WD |
3054 | |
3055 | ||
2729af9d WD |
3056 | Submitting Patches: |
3057 | ------------------- | |
c609719b | 3058 | |
2729af9d WD |
3059 | Since the number of patches for U-Boot is growing, we need to |
3060 | establish some rules. Submissions which do not conform to these rules | |
3061 | may be rejected, even when they contain important and valuable stuff. | |
c609719b | 3062 | |
047f6ec0 | 3063 | Please see https://www.denx.de/wiki/U-Boot/Patches for details. |
218ca724 | 3064 | |
0668236b | 3065 | Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; |
1dade18e | 3066 | see https://lists.denx.de/listinfo/u-boot |
0668236b | 3067 | |
2729af9d WD |
3068 | When you send a patch, please include the following information with |
3069 | it: | |
c609719b | 3070 | |
2729af9d WD |
3071 | * For bug fixes: a description of the bug and how your patch fixes |
3072 | this bug. Please try to include a way of demonstrating that the | |
3073 | patch actually fixes something. | |
c609719b | 3074 | |
2729af9d WD |
3075 | * For new features: a description of the feature and your |
3076 | implementation. | |
c609719b | 3077 | |
7207b366 RD |
3078 | * For major contributions, add a MAINTAINERS file with your |
3079 | information and associated file and directory references. | |
c609719b | 3080 | |
27af930e AA |
3081 | * When you add support for a new board, don't forget to add a |
3082 | maintainer e-mail address to the boards.cfg file, too. | |
c609719b | 3083 | |
2729af9d WD |
3084 | * If your patch adds new configuration options, don't forget to |
3085 | document these in the README file. | |
c609719b | 3086 | |
218ca724 WD |
3087 | * The patch itself. If you are using git (which is *strongly* |
3088 | recommended) you can easily generate the patch using the | |
7ca9296e | 3089 | "git format-patch". If you then use "git send-email" to send it to |
218ca724 WD |
3090 | the U-Boot mailing list, you will avoid most of the common problems |
3091 | with some other mail clients. | |
3092 | ||
3093 | If you cannot use git, use "diff -purN OLD NEW". If your version of | |
3094 | diff does not support these options, then get the latest version of | |
3095 | GNU diff. | |
c609719b | 3096 | |
218ca724 WD |
3097 | The current directory when running this command shall be the parent |
3098 | directory of the U-Boot source tree (i. e. please make sure that | |
3099 | your patch includes sufficient directory information for the | |
3100 | affected files). | |
6dff5529 | 3101 | |
218ca724 WD |
3102 | We prefer patches as plain text. MIME attachments are discouraged, |
3103 | and compressed attachments must not be used. | |
c609719b | 3104 | |
2729af9d WD |
3105 | * If one logical set of modifications affects or creates several |
3106 | files, all these changes shall be submitted in a SINGLE patch file. | |
52f52c14 | 3107 | |
2729af9d WD |
3108 | * Changesets that contain different, unrelated modifications shall be |
3109 | submitted as SEPARATE patches, one patch per changeset. | |
8bde7f77 | 3110 | |
52f52c14 | 3111 | |
2729af9d | 3112 | Notes: |
c609719b | 3113 | |
6de80f21 | 3114 | * Before sending the patch, run the buildman script on your patched |
2729af9d WD |
3115 | source tree and make sure that no errors or warnings are reported |
3116 | for any of the boards. | |
c609719b | 3117 | |
2729af9d WD |
3118 | * Keep your modifications to the necessary minimum: A patch |
3119 | containing several unrelated changes or arbitrary reformats will be | |
3120 | returned with a request to re-formatting / split it. | |
c609719b | 3121 | |
2729af9d WD |
3122 | * If you modify existing code, make sure that your new code does not |
3123 | add to the memory footprint of the code ;-) Small is beautiful! | |
3124 | When adding new features, these should compile conditionally only | |
3125 | (using #ifdef), and the resulting code with the new feature | |
3126 | disabled must not need more memory than the old code without your | |
3127 | modification. | |
90dc6704 | 3128 | |
0668236b WD |
3129 | * Remember that there is a size limit of 100 kB per message on the |
3130 | u-boot mailing list. Bigger patches will be moderated. If they are | |
3131 | reasonable and not too big, they will be acknowledged. But patches | |
3132 | bigger than the size limit should be avoided. |